/deps/npm/html/doc/cli/npm-help-search.html

http://github.com/joyent/node · HTML · 50 lines · 45 code · 5 blank · 0 comment · 0 complexity · 470c184d343429c6a8af7fce7b5a26f0 MD5 · raw file 

    

  1. <!doctype html>
    2. 

  2. <html>
    3. 

  3.   <title>npm-help-search</title>
    4. 

  4.   <meta http-equiv="content-type" value="text/html;utf-8">
    5. 

  5.   <link rel="stylesheet" type="text/css" href="../../static/style.css">
    6. 

  6.   <link rel="canonical" href="https://www.npmjs.org/doc/cli/npm-help-search.html">
    7. 

  7.   <script async=true src="../../static/toc.js"></script>
    8. 

  8. 

  9.   <body>
    10. 

  10.     <div id="wrapper">
    11. 

  11. 

  12. <h1><a href="../cli/npm-help-search.html">npm-help-search</a></h1> <p>Search npm help documentation</p>
    13. 

  13. <h2 id="synopsis">SYNOPSIS</h2>
    14. 

  14. <pre><code>npm help-search some search terms
    15. 

  15. </code></pre><h2 id="description">DESCRIPTION</h2>
    16. 

  16. <p>This command will search the npm markdown documentation files for the
    17. 

  17. terms provided, and then list the results, sorted by relevance.</p>
    18. 

  18. <p>If only one result is found, then it will show that help topic.</p>
    19. 

  19. <p>If the argument to <code>npm help</code> is not a known help topic, then it will
    20. 

  20. call <code>help-search</code>.  It is rarely if ever necessary to call this
    21. 

  21. command directly.</p>
    22. 

  22. <h2 id="configuration">CONFIGURATION</h2>
    23. 

  23. <h3 id="long">long</h3>
    24. 

  24. <ul>
    25. 

  25. <li>Type: Boolean</li>
    26. 

  26. <li>Default false</li>
    27. 

  27. </ul>
    28. 

  28. <p>If true, the &quot;long&quot; flag will cause help-search to output context around
    29. 

  29. where the terms were found in the documentation.</p>
    30. 

  30. <p>If false, then help-search will just list out the help topics found.</p>
    31. 

  31. <h2 id="see-also">SEE ALSO</h2>
    32. 

  32. <ul>
    33. 

  33. <li><a href="../cli/npm.html">npm(1)</a></li>
    34. 

  34. <li><a href="../misc/npm-faq.html">npm-faq(7)</a></li>
    35. 

  35. <li><a href="../cli/npm-help.html">npm-help(1)</a></li>
    36. 

  36. </ul>
    37. 

  37. 

  38. </div>
    39. 

  39. 

  40. <table border=0 cellspacing=0 cellpadding=0 id=npmlogo>
    41. 

  41. <tr><td style="width:180px;height:10px;background:rgb(237,127,127)" colspan=18>&nbsp;</td></tr>
    42. 

  42. <tr><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)">&nbsp;</td><td style="width:40px;height:10px;background:#fff" colspan=4>&nbsp;</td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4>&nbsp;</td><td style="width:40px;height:10px;background:#fff" colspan=4>&nbsp;</td><td rowspan=4 style="width:10px;height:10px;background:rgb(237,127,127)">&nbsp;</td><td colspan=6 style="width:60px;height:10px;background:#fff">&nbsp;</td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=4>&nbsp;</td></tr>
    43. 

  43. <tr><td colspan=2 style="width:20px;height:30px;background:#fff" rowspan=3>&nbsp;</td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3>&nbsp;</td><td style="width:10px;height:10px;background:#fff" rowspan=3>&nbsp;</td><td style="width:20px;height:10px;background:#fff" rowspan=4 colspan=2>&nbsp;</td><td style="width:10px;height:20px;background:rgb(237,127,127)" rowspan=2>&nbsp;</td><td style="width:10px;height:10px;background:#fff" rowspan=3>&nbsp;</td><td style="width:20px;height:10px;background:#fff" rowspan=3 colspan=2>&nbsp;</td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3>&nbsp;</td><td style="width:10px;height:10px;background:#fff" rowspan=3>&nbsp;</td><td style="width:10px;height:10px;background:rgb(237,127,127)" rowspan=3>&nbsp;</td></tr>
    44. 

  44. <tr><td style="width:10px;height:10px;background:#fff" rowspan=2>&nbsp;</td></tr>
    45. 

  45. <tr><td style="width:10px;height:10px;background:#fff">&nbsp;</td></tr>
    46. 

  46. <tr><td style="width:60px;height:10px;background:rgb(237,127,127)" colspan=6>&nbsp;</td><td colspan=10 style="width:10px;height:10px;background:rgb(237,127,127)">&nbsp;</td></tr>
    47. 

  47. <tr><td colspan=5 style="width:50px;height:10px;background:#fff">&nbsp;</td><td style="width:40px;height:10px;background:rgb(237,127,127)" colspan=4>&nbsp;</td><td style="width:90px;height:10px;background:#fff" colspan=9>&nbsp;</td></tr>
    48. 

  48. </table>
    49. 

  49. <p id="footer">npm-help-search &mdash; npm@1.4.14</p>
    50.