npm-help.1 1.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657
  1. .TH "NPM\-HELP" "1" "October 2021" "" ""
  2. .SH "NAME"
  3. \fBnpm-help\fR \- Get help on npm
  4. .SS Synopsis
  5. .P
  6. .RS 2
  7. .nf
  8. npm help <term> [<terms\.\.>]
  9. .fi
  10. .RE
  11. .P
  12. Note: This command is unaware of workspaces\.
  13. .SS Description
  14. .P
  15. If supplied a topic, then show the appropriate documentation page\.
  16. .P
  17. If the topic does not exist, or if multiple terms are provided, then npm
  18. will run the \fBhelp\-search\fP command to find a match\. Note that, if
  19. \fBhelp\-search\fP finds a single subject, then it will run \fBhelp\fP on that
  20. topic, so unique matches are equivalent to specifying a topic name\.
  21. .SS Configuration
  22. <!\-\- AUTOGENERATED CONFIG DESCRIPTIONS START \-\->
  23. <!\-\- automatically generated, do not edit manually \-\->
  24. <!\-\- see lib/utils/config/definitions\.js \-\->
  25. .SS \fBviewer\fP
  26. .RS 0
  27. .IP \(bu 2
  28. Default: "man" on Posix, "browser" on Windows
  29. .IP \(bu 2
  30. Type: String
  31. .RE
  32. .P
  33. The program to use to view help content\.
  34. .P
  35. Set to \fB"browser"\fP to view html help content in the default web browser\.
  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 folders
  45. .IP \(bu 2
  46. npm help config
  47. .IP \(bu 2
  48. npm help npmrc
  49. .IP \(bu 2
  50. npm help package\.json
  51. .IP \(bu 2
  52. npm help help\-search
  53. .RE