mirror of
https://github.com/nodejs/node.git
synced 2024-11-30 23:43:09 +01:00
29 lines
715 B
Groff
29 lines
715 B
Groff
.\" Generated with Ronnjs/v0.1
|
|
.\" http://github.com/kapouer/ronnjs/
|
|
.
|
|
.TH "NPM\-DOCS" "3" "November 2011" "" ""
|
|
.
|
|
.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\.
|