summaryrefslogtreecommitdiff
path: root/deps/npm/man/man3/npm-docs.3
blob: 0d2d98881c85d74895c7ace72c4c611f75112361 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
.\" Generated with Ronnjs 0.3.8
.\" http://github.com/kapouer/ronnjs/
.
.TH "NPM\-DOCS" "3" "April 2014" "" ""
.
.SH "NAME"
\fBnpm-docs\fR \-\- Docs for a package in a web browser maybe
.
.SH "SYNOPSIS"
.
.nf
npm\.commands\.docs(package, callback)
.
.fi
.
.SH "DESCRIPTION"
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\fR
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\.