diff options
| author | isaacs <i@izs.me> | 2011-09-04 22:19:01 +0400 |
|---|---|---|
| committer | isaacs <i@izs.me> | 2011-09-04 22:19:01 +0400 |
| commit | 023bb497fa410d900fdd8a68b9b759806db5aa42 (patch) | |
| tree | 81766f9c30d0fa825d3c6afe34e4ef8d6ca9c1b6 /man1 | |
| parent | bf4646091ab881b15a45d0f08358c6afd8317f59 (diff) | |
Provide proper help doc for help command
Diffstat (limited to 'man1')
| -rw-r--r-- | man1/help.1 | 65 |
1 files changed, 65 insertions, 0 deletions
diff --git a/man1/help.1 b/man1/help.1 new file mode 100644 index 000000000..5f6cd9f96 --- /dev/null +++ b/man1/help.1 @@ -0,0 +1,65 @@ +.\" Generated with Ronnjs/v0.1 +.\" http://github.com/kapouer/ronnjs/ +. +.TH "NPM\-HELP" "1" "September 2011" "" "" +. +.SH "NAME" +\fBnpm-help\fR \-\- Get help on npm +. +.SH "SYNOPSIS" +. +.nf +npm help <topic> +npm help some search terms +. +.fi +. +.SH "DESCRIPTION" +If supplied a topic, then show the appropriate documentation page\. +. +.P +If the topic does not exist, or if multiple terms are provided, then run +the \fBhelp\-search\fR command to find a match\. Note that, if \fBhelp\-search\fR +finds a single subject, then it will run \fBhelp\fR on that topic, so unique +matches are equivalent to specifying a topic name\. +. +.SH "CONFIGURATION" +. +.SS "viewer" +. +.IP "\(bu" 4 +Default: "man" on Posix, "browser" on Windows +. +.IP "\(bu" 4 +Type: path +. +.IP "" 0 +. +.P +The program to use to view help content\. +. +.P +Set to \fB"browser"\fR to view html help content in the default web browser\. +. +.SH "SEE ALSO" +. +.IP "\(bu" 4 +npm help npm +. +.IP "\(bu" 4 +README +. +.IP "\(bu" 4 +npm help faq +. +.IP "\(bu" 4 +npm help folders +. +.IP "\(bu" 4 +npm help config +. +.IP "\(bu" 4 +npm help json +. +.IP "" 0 + |