2021-05-10 17:31:02 -04:00
|
|
|
.TH "NPM\-HELP" "1" "May 2021" "" ""
|
2011-11-26 09:21:03 -08:00
|
|
|
.SH "NAME"
|
2019-11-18 21:01:39 +02:00
|
|
|
\fBnpm-help\fR \- Get help on npm
|
2019-11-05 14:55:08 -05:00
|
|
|
.SS Synopsis
|
2014-09-24 14:41:07 -07:00
|
|
|
.P
|
|
|
|
.RS 2
|
2014-11-04 15:08:12 -08:00
|
|
|
.nf
|
2015-10-09 23:13:57 -07:00
|
|
|
npm help <term> [<terms\.\.>]
|
2014-11-04 15:08:12 -08:00
|
|
|
.fi
|
2014-09-24 14:41:07 -07:00
|
|
|
.RE
|
2021-03-23 14:58:11 -04:00
|
|
|
.P
|
|
|
|
Note: This command is unaware of workspaces\.
|
2019-11-05 14:55:08 -05:00
|
|
|
.SS Description
|
2014-09-24 14:41:07 -07:00
|
|
|
.P
|
2011-11-26 09:21:03 -08:00
|
|
|
If supplied a topic, then show the appropriate documentation page\.
|
|
|
|
.P
|
2020-11-01 07:54:36 +01:00
|
|
|
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\.
|
2019-11-05 14:55:08 -05:00
|
|
|
.SS Configuration
|
2014-09-24 14:41:07 -07:00
|
|
|
.SS viewer
|
|
|
|
.RS 0
|
|
|
|
.IP \(bu 2
|
2011-11-26 09:21:03 -08:00
|
|
|
Default: "man" on Posix, "browser" on Windows
|
2014-09-24 14:41:07 -07:00
|
|
|
.IP \(bu 2
|
2011-11-26 09:21:03 -08:00
|
|
|
Type: path
|
2014-09-24 14:41:07 -07:00
|
|
|
|
|
|
|
.RE
|
2011-11-26 09:21:03 -08:00
|
|
|
.P
|
|
|
|
The program to use to view help content\.
|
|
|
|
.P
|
2015-07-24 15:09:52 -07:00
|
|
|
Set to \fB"browser"\fP to view html help content in the default web browser\.
|
2019-11-05 14:55:08 -05:00
|
|
|
.SS See Also
|
2014-09-24 14:41:07 -07:00
|
|
|
.RS 0
|
|
|
|
.IP \(bu 2
|
2011-11-26 09:21:03 -08:00
|
|
|
npm help npm
|
2014-09-24 14:41:07 -07:00
|
|
|
.IP \(bu 2
|
2019-11-05 14:55:08 -05:00
|
|
|
npm help folders
|
2014-09-24 14:41:07 -07:00
|
|
|
.IP \(bu 2
|
2019-11-18 21:01:39 +02:00
|
|
|
npm help config
|
2014-09-24 14:41:07 -07:00
|
|
|
.IP \(bu 2
|
2019-11-05 14:55:08 -05:00
|
|
|
npm help npmrc
|
2014-09-24 14:41:07 -07:00
|
|
|
.IP \(bu 2
|
2019-11-18 21:01:39 +02:00
|
|
|
npm help package\.json
|
2014-09-24 14:41:07 -07:00
|
|
|
.IP \(bu 2
|
2019-11-18 21:01:39 +02:00
|
|
|
npm help help\-search
|
2014-09-24 14:41:07 -07:00
|
|
|
|
|
|
|
.RE
|