blob: cf723d2f4171484de4ae6efa217f9d86cc38cebd (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
|
.\" 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
|
