deps/npm/man/man1/npm-help-search.1

   1 .\" Generated with Ronnjs 0.3.8
   2 .\" http://github.com/kapouer/ronnjs/
   3 .
   4 .TH "NPM\-HELP\-SEARCH" "1" "December 2013" "" ""
   5 .
   6 .SH "NAME"
   7 \fBnpm-help-search\fR \-\- Search npm help documentation
   8 .
   9 .SH "SYNOPSIS"
  10 .
  11 .nf
  12 npm help\-search some search terms
  13 .
  14 .fi
  15 .
  16 .SH "DESCRIPTION"
  17 This command will search the npm markdown documentation files for the
  18 terms provided, and then list the results, sorted by relevance\.
  19 .
  20 .P
  21 If only one result is found, then it will show that help topic\.
  22 .
  23 .P
  24 If the argument to \fBnpm help\fR is not a known help topic, then it will
  25 call \fBhelp\-search\fR\|\.  It is rarely if ever necessary to call this
  26 command directly\.
  27 .
  28 .SH "CONFIGURATION"
  29 .
  30 .SS "long"
  31 .
  32 .IP "\(bu" 4
  33 Type: Boolean
  34 .
  35 .IP "\(bu" 4
  36 Default false
  37 .
  38 .IP "" 0
  39 .
  40 .P
  41 If true, the "long" flag will cause help\-search to output context around
  42 where the terms were found in the documentation\.
  43 .
  44 .P
  45 If false, then help\-search will just list out the help topics found\.
  46 .
  47 .SH "SEE ALSO"
  48 .
  49 .IP "\(bu" 4
  50 npm help npm
  51 .
  52 .IP "\(bu" 4
  53 npm help  faq
  54 .
  55 .IP "\(bu" 4
  56 npm help help
  57 .
  58 .IP "" 0
  59