54921125c38aa9691b59d7ad29889fd1c3d1fc76
[platform/upstream/nodejs.git] / deps / npm / html / doc / cli / npm-help.html
1 <!doctype html>
2 <html>
3   <title>npm-help</title>
4   <meta http-equiv="content-type" value="text/html;utf-8">
5   <link rel="stylesheet" type="text/css" href="../../static/style.css">
6
7   <body>
8     <div id="wrapper">
9 <h1><a href="../cli/npm-help.html">npm-help</a></h1> <p>Get help on npm</p>
10
11 <h2 id="SYNOPSIS">SYNOPSIS</h2>
12
13 <pre><code>npm help &lt;topic&gt;
14 npm help some search terms</code></pre>
15
16 <h2 id="DESCRIPTION">DESCRIPTION</h2>
17
18 <p>If supplied a topic, then show the appropriate documentation page.</p>
19
20 <p>If the topic does not exist, or if multiple terms are provided, then run
21 the <code>help-search</code> command to find a match.  Note that, if <code>help-search</code>
22 finds a single subject, then it will run <code>help</code> on that topic, so unique
23 matches are equivalent to specifying a topic name.</p>
24
25 <h2 id="CONFIGURATION">CONFIGURATION</h2>
26
27 <h3 id="viewer">viewer</h3>
28
29 <ul><li>Default: &quot;man&quot; on Posix, &quot;browser&quot; on Windows</li><li>Type: path</li></ul>
30
31 <p>The program to use to view help content.</p>
32
33 <p>Set to <code>&quot;browser&quot;</code> to view html help content in the default web browser.</p>
34
35 <h2 id="SEE-ALSO">SEE ALSO</h2>
36
37 <ul><li><a href="../cli/npm.html">npm(1)</a></li><li><a href="../../doc/README.html">README</a></li><li><a href="../misc/npm-faq.html">npm-faq(7)</a></li><li><a href="../files/npm-folders.html">npm-folders(5)</a></li><li><a href="../cli/npm-config.html">npm-config(1)</a></li><li><a href="../misc/npm-config.html">npm-config(7)</a></li><li><a href="../files/npmrc.html">npmrc(5)</a></li><li><a href="../files/package.json.html">package.json(5)</a></li><li><a href="../cli/npm-help-search.html">npm-help-search(1)</a></li><li><a href="../misc/npm-index.html">npm-index(7)</a></li></ul>
38 </div>
39 <p id="footer">npm-help &mdash; npm@1.3.15</p>
40 <script>
41 ;(function () {
42 var wrapper = document.getElementById("wrapper")
43 var els = Array.prototype.slice.call(wrapper.getElementsByTagName("*"), 0)
44   .filter(function (el) {
45     return el.parentNode === wrapper
46         && el.tagName.match(/H[1-6]/)
47         && el.id
48   })
49 var l = 2
50   , toc = document.createElement("ul")
51 toc.innerHTML = els.map(function (el) {
52   var i = el.tagName.charAt(1)
53     , out = ""
54   while (i > l) {
55     out += "<ul>"
56     l ++
57   }
58   while (i < l) {
59     out += "</ul>"
60     l --
61   }
62   out += "<li><a href='#" + el.id + "'>" +
63     ( el.innerText || el.text || el.innerHTML)
64     + "</a>"
65   return out
66 }).join("\n")
67 toc.id = "toc"
68 document.body.appendChild(toc)
69 })()
70 </script>