mirror of
https://github.com/nodejs/node.git
synced 2025-05-19 04:51:50 +00:00
41923c0c07
PR-URL: https://github.com/nodejs/node/pull/3310 Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
36 lines
819 B
Markdown
36 lines
819 B
Markdown
npm-help-search(1) -- Search npm help documentation
|
|
===================================================
|
|
|
|
## SYNOPSIS
|
|
|
|
npm help-search <text>
|
|
|
|
## DESCRIPTION
|
|
|
|
This command will search the npm markdown documentation files for the
|
|
terms provided, and then list the results, sorted by relevance.
|
|
|
|
If only one result is found, then it will show that help topic.
|
|
|
|
If the argument to `npm help` is not a known help topic, then it will
|
|
call `help-search`. It is rarely if ever necessary to call this
|
|
command directly.
|
|
|
|
## CONFIGURATION
|
|
|
|
### long
|
|
|
|
* Type: Boolean
|
|
* Default false
|
|
|
|
If true, the "long" flag will cause help-search to output context around
|
|
where the terms were found in the documentation.
|
|
|
|
If false, then help-search will just list out the help topics found.
|
|
|
|
## SEE ALSO
|
|
|
|
* npm(1)
|
|
* npm-faq(7)
|
|
* npm-help(1)
|