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.
main_repo / deps / npm / man / man1 / docs.1 @ d46ebffb
History | View | Annotate | Download (999 Bytes)
| 1 |
.\" Generated with Ronnjs 0.3.8 |
|---|---|
| 2 |
.\" http://github.com/kapouer/ronnjs/ |
| 3 |
. |
| 4 |
.TH "NPM\-DOCS" "1" "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 docs <pkgname> |
| 13 |
npm home <pkgname> |
| 14 |
. |
| 15 |
.fi |
| 16 |
. |
| 17 |
.SH "DESCRIPTION" |
| 18 |
This command tries to guess at the likely location of a package\'s |
| 19 |
documentation URL, and then tries to open it using the \fB\-\-browser\fR |
| 20 |
config param\. |
| 21 |
. |
| 22 |
.SH "CONFIGURATION" |
| 23 |
. |
| 24 |
.SS "browser" |
| 25 |
. |
| 26 |
.IP "\(bu" 4 |
| 27 |
Default: OS X: \fB"open"\fR, others: \fB"google\-chrome"\fR |
| 28 |
. |
| 29 |
.IP "\(bu" 4 |
| 30 |
Type: String |
| 31 |
. |
| 32 |
.IP "" 0 |
| 33 |
. |
| 34 |
.P |
| 35 |
The browser that is called by the \fBnpm docs\fR command to open websites\. |
| 36 |
. |
| 37 |
.SS "registry" |
| 38 |
. |
| 39 |
.IP "\(bu" 4 |
| 40 |
Default: https://registry\.npmjs\.org/ |
| 41 |
. |
| 42 |
.IP "\(bu" 4 |
| 43 |
Type: url |
| 44 |
. |
| 45 |
.IP "" 0 |
| 46 |
. |
| 47 |
.P |
| 48 |
The base URL of the npm package registry\. |
| 49 |
. |
| 50 |
.SH "SEE ALSO" |
| 51 |
. |
| 52 |
.IP "\(bu" 4 |
| 53 |
npm help view |
| 54 |
. |
| 55 |
.IP "\(bu" 4 |
| 56 |
npm help publish |
| 57 |
. |
| 58 |
.IP "\(bu" 4 |
| 59 |
npm help registry |
| 60 |
. |
| 61 |
.IP "\(bu" 4 |
| 62 |
npm help config |
| 63 |
. |
| 64 |
.IP "\(bu" 4 |
| 65 |
npm help json |
| 66 |
. |
| 67 |
.IP "" 0 |
| 68 |
|