diff options
author | isaacs <i@izs.me> | 2013-07-12 08:55:57 -0700 |
---|---|---|
committer | isaacs <i@izs.me> | 2013-07-12 08:56:26 -0700 |
commit | ff8a4058bfac4f360992cfe7adf04f910282cedc (patch) | |
tree | b271ef198babbc9c46c33bcda9826fbcc6bf0a6d /deps/npm/doc/api/npm-help-search.md | |
parent | 6d91bd37075a53f42bab01915fa89ba4a4f0a075 (diff) | |
download | node-new-ff8a4058bfac4f360992cfe7adf04f910282cedc.tar.gz |
npm: Upgrade to 1.3.3
Diffstat (limited to 'deps/npm/doc/api/npm-help-search.md')
-rw-r--r-- | deps/npm/doc/api/npm-help-search.md | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/deps/npm/doc/api/npm-help-search.md b/deps/npm/doc/api/npm-help-search.md new file mode 100644 index 0000000000..5c00cfc177 --- /dev/null +++ b/deps/npm/doc/api/npm-help-search.md @@ -0,0 +1,30 @@ +npm-help-search(3) -- Search the help pages +=========================================== + +## SYNOPSIS + + npm.commands.helpSearch(args, [silent,] callback) + +## DESCRIPTION + +This command is rarely useful, but it exists in the rare case that it is. + +This command takes an array of search terms and returns the help pages that +match in order of best match. + +If there is only one match, then npm displays that help section. If there +are multiple results, the results are printed to the screen formatted and the +array of results is returned. Each result is an object with these properties: + +* hits: + A map of args to number of hits on that arg. For example, {"npm": 3} +* found: + Total number of unique args that matched. +* totalHits: + Total number of hits. +* lines: + An array of all matching lines (and some adjacent lines). +* file: + Name of the file that matched + +The silent parameter is not neccessary not used, but it may in the future. |