bot/node_modules/npm/man/man1/npm-help-search.1

50 lines
1.2 KiB
Groff
Raw Normal View History

2022-02-16 11:32:42 +01:00
.TH "NPM\-HELP\-SEARCH" "1" "February 2022" "" ""
.SH "NAME"
\fBnpm-help-search\fR \- Search npm help documentation
.SS Synopsis
.P
.RS 2
.nf
npm help\-search <text>
.fi
.RE
.P
Note: This command is unaware of workspaces\.
.SS Description
.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
<!\-\- AUTOGENERATED CONFIG DESCRIPTIONS START \-\->
<!\-\- automatically generated, do not edit manually \-\->
<!\-\- see lib/utils/config/definitions\.js \-\->
.SS \fBlong\fP
.RS 0
.IP \(bu 2
Default: false
.IP \(bu 2
Type: Boolean
.RE
.P
Show extended information in \fBls\fP, \fBsearch\fP, and \fBhelp\-search\fP\|\.
<!\-\- automatically generated, do not edit manually \-\->
<!\-\- see lib/utils/config/definitions\.js \-\->
<!\-\- AUTOGENERATED CONFIG DESCRIPTIONS END \-\->
.SS See Also
.RS 0
.IP \(bu 2
npm help npm
.IP \(bu 2
npm help help
.RE