summaryrefslogtreecommitdiff
path: root/deps/npm/man/man3/npm-docs.3
blob: 4305dae16399f2e6c42b3b0c3542bff6292fd19e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
.TH "NPM\-DOCS" "3" "August 2015" "" ""
.SH "NAME"
\fBnpm-docs\fR \- Docs for a package in a web browser maybe
.SH SYNOPSIS
.P
.RS 2
.nf
npm\.commands\.docs(package, callback)
.fi
.RE
.SH DESCRIPTION
.P
This command tries to guess at the likely location of a package's
documentation URL, and then tries to open it using the \fB\-\-browser\fP
config param\.
.P
Like other commands, the first parameter is an array\. This command only
uses the first element, which is expected to be a package name with an
optional version number\.
.P
This command will launch a browser, so this command may not be the most
friendly for programmatic use\.