nodejs/deps/npm/man/man1/npm-help.1

50 lines
1020 B
Groff
Raw Normal View History

.TH "NPM\-HELP" "1" "May 2021" "" ""
.SH "NAME"
\fBnpm-help\fR \- Get help on npm
.SS Synopsis
2014-09-24 14:41:07 -07:00
.P
.RS 2
2014-11-04 15:08:12 -08:00
.nf
npm help <term> [<terms\.\.>]
2014-11-04 15:08:12 -08:00
.fi
2014-09-24 14:41:07 -07:00
.RE
.P
Note: This command is unaware of workspaces\.
.SS Description
2014-09-24 14:41:07 -07:00
.P
If supplied a topic, then show the appropriate documentation page\.
.P
If the topic does not exist, or if multiple terms are provided, then npm
will run the \fBhelp\-search\fP command to find a match\. Note that, if
\fBhelp\-search\fP finds a single subject, then it will run \fBhelp\fP on that
topic, so unique matches are equivalent to specifying a topic name\.
.SS Configuration
2014-09-24 14:41:07 -07:00
.SS viewer
.RS 0
.IP \(bu 2
Default: "man" on Posix, "browser" on Windows
2014-09-24 14:41:07 -07:00
.IP \(bu 2
Type: path
2014-09-24 14:41:07 -07:00
.RE
.P
The program to use to view help content\.
.P
Set to \fB"browser"\fP to view html help content in the default web browser\.
.SS See Also
2014-09-24 14:41:07 -07:00
.RS 0
.IP \(bu 2
npm help npm
2014-09-24 14:41:07 -07:00
.IP \(bu 2
npm help folders
2014-09-24 14:41:07 -07:00
.IP \(bu 2
npm help config
2014-09-24 14:41:07 -07:00
.IP \(bu 2
npm help npmrc
2014-09-24 14:41:07 -07:00
.IP \(bu 2
npm help package\.json
2014-09-24 14:41:07 -07:00
.IP \(bu 2
npm help help\-search
2014-09-24 14:41:07 -07:00
.RE