node/deps/npm/man/man1/npm-help-search.1
isaacs f76c3938d0 npm: upgrade to v1.4.8
* Check SHA before using files from cache
* adduser: allow change of the saved password
* Make `npm install` respect `config.unicode`
* Fix lifecycle to pass `Infinity` for config env value
* Don't return 0 exit code on invalid command
* cache: Handle 404s and other HTTP errors as errors
* bump tap dep, make tests stderr a bit quieter
* Resolve ~ in path configs to env.HOME
* Include npm version in default user-agent conf
* npm init: Use ISC as default license, use save-prefix for deps
* Many test and doc fixes
2014-05-01 11:09:00 -07:00

60 lines
1.0 KiB
Groff

.\" Generated with Ronnjs 0.3.8
.\" http://github.com/kapouer/ronnjs/
.
.TH "NPM\-HELP\-SEARCH" "1" "May 2014" "" ""
.
.SH "NAME"
\fBnpm-help-search\fR \-\- Search npm help documentation
.
.SH "SYNOPSIS"
.
.nf
npm help\-search some search terms
.
.fi
.
.SH "DESCRIPTION"
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\fR is not a known help topic, then it will
call \fBhelp\-search\fR\|\. It is rarely if ever necessary to call this
command directly\.
.
.SH "CONFIGURATION"
.
.SS "long"
.
.IP "\(bu" 4
Type: Boolean
.
.IP "\(bu" 4
Default false
.
.IP "" 0
.
.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\.
.
.SH "SEE ALSO"
.
.IP "\(bu" 4
npm help npm
.
.IP "\(bu" 4
npm help faq
.
.IP "\(bu" 4
npm help help
.
.IP "" 0