mirror of
https://github.com/nodejs/node.git
synced 2025-05-19 16:31:13 +00:00
054127112c
* Update request to support HTTPS-over-HTTP proxy tunneling * Throw on undefined envs in config settings * Update which to 1.0.5 * Fix windows UNC busyloop in findPrefix * Bundle nested bundleDependencies properly * Alias adduser to add-user * Doc updates (Christian Howe, Henrik Hodne, Andrew Lunny) * ignore logfd/outfd streams in makeEnv() (Rod Vagg) * shrinkwrap: Behave properly with url-installed deps * install: Support --save with url install targets * Support installing naked tars or single-file modules from urls etc. * init: Don't add engines section * Don't run make clean on rebuild * Added missing unicode replacement (atomizer)
52 lines
1.1 KiB
Groff
52 lines
1.1 KiB
Groff
.\" Generated with Ronnjs/v0.1
|
|
.\" http://github.com/kapouer/ronnjs/
|
|
.
|
|
.TH "NPM\-HELP\-SEARCH" "3" "March 2012" "" ""
|
|
.
|
|
.SH "NAME"
|
|
\fBnpm-help-search\fR \-\- Search the help pages
|
|
.
|
|
.SH "SYNOPSIS"
|
|
.
|
|
.nf
|
|
npm\.commands\.helpSearch(args, [silent,] callback)
|
|
.
|
|
.fi
|
|
.
|
|
.SH "DESCRIPTION"
|
|
This command is rarely useful, but it exists in the rare case that it is\.
|
|
.
|
|
.P
|
|
This command takes an array of search terms and returns the help pages that
|
|
match in order of best match\.
|
|
.
|
|
.P
|
|
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:
|
|
.
|
|
.IP "\(bu" 4
|
|
hits:
|
|
A map of args to number of hits on that arg\. For example, {"npm": 3}
|
|
.
|
|
.IP "\(bu" 4
|
|
found:
|
|
Total number of unique args that matched\.
|
|
.
|
|
.IP "\(bu" 4
|
|
totalHits:
|
|
Total number of hits\.
|
|
.
|
|
.IP "\(bu" 4
|
|
lines:
|
|
An array of all matching lines (and some adjacent lines)\.
|
|
.
|
|
.IP "\(bu" 4
|
|
file:
|
|
Name of the file that matched
|
|
.
|
|
.IP "" 0
|
|
.
|
|
.P
|
|
The silent parameter is not neccessary not used, but it may in the future\.
|