mirror of
https://github.com/zebrajr/node.git
synced 2025-12-07 12:20:50 +01:00
b3fee8e6a6
PR-URL: https://github.com/nodejs/node/pull/2696 Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com> Reviewed-By: Rod Vagg <rod@vagg.org>
24 lines
641 B
Groff
24 lines
641 B
Groff
.TH "NPM\-DOCS" "3" "September 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\.
|
|
|