bf13fb3d4dc25f5810ebfb713d13de6bd16ba347
[platform/upstream/nodejs.git] / deps / npm / man / man1 / npm-help.1
1 .\" Generated with Ronnjs 0.3.8
2 .\" http://github.com/kapouer/ronnjs/
3 .
4 .TH "NPM\-HELP" "1" "November 2013" "" ""
5 .
6 .SH "NAME"
7 \fBnpm-help\fR \-\- Get help on npm
8 .
9 .SH "SYNOPSIS"
10 .
11 .nf
12 npm help <topic>
13 npm help some search terms
14 .
15 .fi
16 .
17 .SH "DESCRIPTION"
18 If supplied a topic, then show the appropriate documentation page\.
19 .
20 .P
21 If the topic does not exist, or if multiple terms are provided, then run
22 the \fBhelp\-search\fR command to find a match\.  Note that, if \fBhelp\-search\fR
23 finds a single subject, then it will run \fBhelp\fR on that topic, so unique
24 matches are equivalent to specifying a topic name\.
25 .
26 .SH "CONFIGURATION"
27 .
28 .SS "viewer"
29 .
30 .IP "\(bu" 4
31 Default: "man" on Posix, "browser" on Windows
32 .
33 .IP "\(bu" 4
34 Type: path
35 .
36 .IP "" 0
37 .
38 .P
39 The program to use to view help content\.
40 .
41 .P
42 Set to \fB"browser"\fR to view html help content in the default web browser\.
43 .
44 .SH "SEE ALSO"
45 .
46 .IP "\(bu" 4
47 npm help npm
48 .
49 .IP "\(bu" 4
50 README
51 .
52 .IP "\(bu" 4
53 npm help  faq
54 .
55 .IP "\(bu" 4
56 npm help  folders
57 .
58 .IP "\(bu" 4
59 npm help config
60 .
61 .IP "\(bu" 4
62 npm help  config
63 .
64 .IP "\(bu" 4
65 npm help  npmrc
66 .
67 .IP "\(bu" 4
68 npm help  package\.json
69 .
70 .IP "\(bu" 4
71 npm help help\-search
72 .
73 .IP "\(bu" 4
74 npm help  index
75 .
76 .IP "" 0
77