2021-05-10 17:31:02 -04:00
|
|
|
.TH "NPM\-HELP\-SEARCH" "1" "May 2021" "" ""
|
2011-11-26 09:21:03 -08:00
|
|
|
.SH "NAME"
|
2019-11-18 21:01:39 +02:00
|
|
|
\fBnpm-help-search\fR \- Search npm help documentation
|
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\-search <text>
|
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
|
2020-11-01 07:54:36 +01:00
|
|
|
This command will search the npm markdown documentation files for the terms
|
|
|
|
provided, and then list the results, sorted by relevance\.
|
2011-11-26 09:21:03 -08:00
|
|
|
.P
|
|
|
|
If only one result is found, then it will show that help topic\.
|
|
|
|
.P
|
2020-11-01 07:54:36 +01:00
|
|
|
If the argument to \fBnpm help\fP is not a known help topic, then it will call
|
|
|
|
\fBhelp\-search\fP\|\. It is rarely if ever necessary to call this command
|
|
|
|
directly\.
|
2019-11-05 14:55:08 -05:00
|
|
|
.SS Configuration
|
2014-09-24 14:41:07 -07:00
|
|
|
.SS long
|
|
|
|
.RS 0
|
|
|
|
.IP \(bu 2
|
2011-11-26 09:21:03 -08:00
|
|
|
Type: Boolean
|
2014-09-24 14:41:07 -07:00
|
|
|
.IP \(bu 2
|
2016-03-29 23:30:51 -07:00
|
|
|
Default: false
|
2014-09-24 14:41:07 -07:00
|
|
|
|
|
|
|
.RE
|
2011-11-26 09:21:03 -08:00
|
|
|
.P
|
|
|
|
If true, the "long" flag will cause help\-search to output context around
|
|
|
|
where the terms were found in the documentation\.
|
|
|
|
.P
|
|
|
|
If false, then help\-search will just list out the help topics found\.
|
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-18 21:01:39 +02:00
|
|
|
npm help help
|
2014-09-24 14:41:07 -07:00
|
|
|
|
|
|
|
.RE
|