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

45 lines
972 B
Groff
Raw Normal View History

.TH "NPM\-HELP\-SEARCH" "1" "May 2021" "" ""
.SH "NAME"
\fBnpm-help-search\fR \- Search npm help documentation
.SS Synopsis
2014-09-24 14:41:07 -07:00
.P
.RS 2
2014-11-04 15:08:12 -08:00
.nf
npm help\-search <text>
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
This command will search the npm markdown documentation files for the terms
provided, and then list the results, sorted by relevance\.
.P
If only one result is found, then it will show that help topic\.
.P
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\.
.SS Configuration
2014-09-24 14:41:07 -07:00
.SS long
.RS 0
.IP \(bu 2
Type: Boolean
2014-09-24 14:41:07 -07:00
.IP \(bu 2
Default: false
2014-09-24 14:41:07 -07:00
.RE
.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\.
.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 help
2014-09-24 14:41:07 -07:00
.RE