| <!doctype html> |
| <html> |
| <title>npm-help-search</title> |
| <meta http-equiv="content-type" value="text/html;utf-8"> |
| <link rel="stylesheet" type="text/css" href="../../static/style.css"> |
| |
| <body> |
| <div id="wrapper"> |
| <h1><a href="../cli/npm-help-search.html">npm-help-search</a></h1> <p>Search npm help documentation</p> |
| |
| <h2 id="SYNOPSIS">SYNOPSIS</h2> |
| |
| <pre><code>npm help-search some search terms</code></pre> |
| |
| <h2 id="DESCRIPTION">DESCRIPTION</h2> |
| |
| <p>This command will search the npm markdown documentation files for the |
| terms provided, and then list the results, sorted by relevance.</p> |
| |
| <p>If only one result is found, then it will show that help topic.</p> |
| |
| <p>If the argument to <code>npm help</code> is not a known help topic, then it will |
| call <code>help-search</code>. It is rarely if ever necessary to call this |
| command directly.</p> |
| |
| <h2 id="CONFIGURATION">CONFIGURATION</h2> |
| |
| <h3 id="long">long</h3> |
| |
| <ul><li>Type: Boolean</li><li>Default false</li></ul> |
| |
| <p>If true, the "long" flag will cause help-search to output context around |
| where the terms were found in the documentation.</p> |
| |
| <p>If false, then help-search will just list out the help topics found.</p> |
| |
| <h2 id="SEE-ALSO">SEE ALSO</h2> |
| |
| <ul><li><a href="../cli/npm.html">npm(1)</a></li><li><a href="../misc/npm-faq.html">npm-faq(7)</a></li><li><a href="../cli/npm-help.html">npm-help(1)</a></li></ul> |
| </div> |
| <p id="footer">npm-help-search — npm@1.3.21</p> |
| <script> |
| ;(function () { |
| var wrapper = document.getElementById("wrapper") |
| var els = Array.prototype.slice.call(wrapper.getElementsByTagName("*"), 0) |
| .filter(function (el) { |
| return el.parentNode === wrapper |
| && el.tagName.match(/H[1-6]/) |
| && el.id |
| }) |
| var l = 2 |
| , toc = document.createElement("ul") |
| toc.innerHTML = els.map(function (el) { |
| var i = el.tagName.charAt(1) |
| , out = "" |
| while (i > l) { |
| out += "<ul>" |
| l ++ |
| } |
| while (i < l) { |
| out += "</ul>" |
| l -- |
| } |
| out += "<li><a href='#" + el.id + "'>" + |
| ( el.innerText || el.text || el.innerHTML) |
| + "</a>" |
| return out |
| }).join("\n") |
| toc.id = "toc" |
| document.body.appendChild(toc) |
| })() |
| </script> |
