summaryrefslogtreecommitdiff
path: root/deps/npm/man/man3/npm-docs.3
diff options
context:
space:
mode:
Diffstat (limited to 'deps/npm/man/man3/npm-docs.3')
-rw-r--r--deps/npm/man/man3/npm-docs.328
1 files changed, 28 insertions, 0 deletions
diff --git a/deps/npm/man/man3/npm-docs.3 b/deps/npm/man/man3/npm-docs.3
new file mode 100644
index 000000000..7585e223e
--- /dev/null
+++ b/deps/npm/man/man3/npm-docs.3
@@ -0,0 +1,28 @@
+.\" Generated with Ronnjs 0.3.8
+.\" http://github.com/kapouer/ronnjs/
+.
+.TH "NPM\-DOCS" "3" "July 2013" "" ""
+.
+.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\.