npm-help-search.1 1.2 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849
  1. .TH "NPM\-HELP\-SEARCH" "1" "October 2021" "" ""
  2. .SH "NAME"
  3. \fBnpm-help-search\fR \- Search npm help documentation
  4. .SS Synopsis
  5. .P
  6. .RS 2
  7. .nf
  8. npm help\-search <text>
  9. .fi
  10. .RE
  11. .P
  12. Note: This command is unaware of workspaces\.
  13. .SS Description
  14. .P
  15. This command will search the npm markdown documentation files for the terms
  16. provided, and then list the results, sorted by relevance\.
  17. .P
  18. If only one result is found, then it will show that help topic\.
  19. .P
  20. If the argument to \fBnpm help\fP is not a known help topic, then it will call
  21. \fBhelp\-search\fP\|\. It is rarely if ever necessary to call this command
  22. directly\.
  23. .SS Configuration
  24. <!\-\- AUTOGENERATED CONFIG DESCRIPTIONS START \-\->
  25. <!\-\- automatically generated, do not edit manually \-\->
  26. <!\-\- see lib/utils/config/definitions\.js \-\->
  27. .SS \fBlong\fP
  28. .RS 0
  29. .IP \(bu 2
  30. Default: false
  31. .IP \(bu 2
  32. Type: Boolean
  33. .RE
  34. .P
  35. Show extended information in \fBls\fP, \fBsearch\fP, and \fBhelp\-search\fP\|\.
  36. <!\-\- automatically generated, do not edit manually \-\->
  37. <!\-\- see lib/utils/config/definitions\.js \-\->
  38. <!\-\- AUTOGENERATED CONFIG DESCRIPTIONS END \-\->
  39. .SS See Also
  40. .RS 0
  41. .IP \(bu 2
  42. npm help npm
  43. .IP \(bu 2
  44. npm help help
  45. .RE