The data contained in this repository can be downloaded to your computer using one of several clients.
Please see the documentation of your version control software client for more information.

Please select the desired protocol below to get the URL.

This URL has Read-Only access.

Statistics
| Branch: | Revision:

main_repo / deps / npm / man / man3 / docs.3 @ d46ebffb

History | View | Annotate | Download (713 Bytes)

1 
.\" Generated with Ronnjs 0.3.8
2 
.\" http://github.com/kapouer/ronnjs/
3 
.
4 
.TH "NPM\-DOCS" "3" "April 2013" "" ""
5 
.
6 
.SH "NAME"
7 
\fBnpm-docs\fR \-\- Docs for a package in a web browser maybe
8 
.
9 
.SH "SYNOPSIS"
10 
.
11 
.nf
12 
npm\.commands\.docs(package, callback)
13 
.
14 
.fi
15 
.
16 
.SH "DESCRIPTION"
17 
This command tries to guess at the likely location of a package\'s
18 
documentation URL, and then tries to open it using the \fB\-\-browser\fR
19 
config param\.
20 
.
21 
.P
22 
Like other commands, the first parameter is an array\. This command only
23 
uses the first element, which is expected to be a package name with an
24 
optional version number\.
25 
.
26 
.P
27 
This command will launch a browser, so this command may not be the most
28 
friendly for programmatic use\.