Simple email application for Android. Original source code: https://framagit.org/dystopia-project/simple-email
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

194 lines
5.7 KiB

  1. .TH "NPM" "1" "August 2018" "" ""
  2. .SH "NAME"
  3. \fBnpm\fR \- javascript package manager
  4. .SH SYNOPSIS
  5. .P
  6. .RS 2
  7. .nf
  8. npm <command> [args]
  9. .fi
  10. .RE
  11. .SH VERSION
  12. .P
  13. 6.4.1
  14. .SH DESCRIPTION
  15. .P
  16. npm is the package manager for the Node JavaScript platform\. It puts
  17. modules in place so that node can find them, and manages dependency
  18. conflicts intelligently\.
  19. .P
  20. It is extremely configurable to support a wide variety of use cases\.
  21. Most commonly, it is used to publish, discover, install, and develop node
  22. programs\.
  23. .P
  24. Run \fBnpm help\fP to get a list of available commands\.
  25. .SH IMPORTANT
  26. .P
  27. npm is configured to use npm, Inc\.'s public registry at
  28. https:// by default\. Use of the npm public registry is
  29. subject to terms of use available at https://
  30. .P
  31. You can configure npm to use any compatible registry you like, and even run
  32. your own registry\. Use of someone else's registry may be governed by their
  33. terms of use\.
  34. .SH INTRODUCTION
  35. .P
  36. You probably got npm because you want to install stuff\.
  37. .P
  38. Use \fBnpm install blerg\fP to install the latest version of "blerg"\. Check out
  39. npm help \fBnpm\-install\fP for more info\. It can do a lot of stuff\.
  40. .P
  41. Use the \fBnpm search\fP command to show everything that's available\.
  42. Use \fBnpm ls\fP to show everything you've installed\.
  43. .SH DEPENDENCIES
  44. .P
  45. If a package references to another package with a git URL, npm depends
  46. on a preinstalled git\.
  47. .P
  48. If one of the packages npm tries to install is a native node module and
  49. requires compiling of C++ Code, npm will use
  50. node\-gyp \fIhttps://github\.com/TooTallNate/node\-gyp\fR for that task\.
  51. For a Unix system, node\-gyp \fIhttps://github\.com/TooTallNate/node\-gyp\fR
  52. needs Python, make and a buildchain like GCC\. On Windows,
  53. Python and Microsoft Visual Studio C++ are needed\. Python 3 is
  54. not supported by node\-gyp \fIhttps://github\.com/TooTallNate/node\-gyp\fR\|\.
  55. For more information visit
  56. the node\-gyp repository \fIhttps://github\.com/TooTallNate/node\-gyp\fR and
  57. the node\-gyp Wiki \fIhttps://github\.com/TooTallNate/node\-gyp/wiki\fR\|\.
  58. .SH DIRECTORIES
  59. .P
  60. See npm help 5 \fBnpm\-folders\fP to learn about where npm puts stuff\.
  61. .P
  62. In particular, npm has two modes of operation:
  63. .RS 0
  64. .IP \(bu 2
  65. global mode:
  66. npm installs packages into the install prefix at
  67. \fBprefix/lib/node_modules\fP and bins are installed in \fBprefix/bin\fP\|\.
  68. .IP \(bu 2
  69. local mode:
  70. npm installs packages into the current project directory, which
  71. defaults to the current working directory\. Packages are installed to
  72. \fB\|\./node_modules\fP, and bins are installed to \fB\|\./node_modules/\.bin\fP\|\.
  73. .RE
  74. .P
  75. Local mode is the default\. Use \fB\-g\fP or \fB\-\-global\fP on any command to
  76. operate in global mode instead\.
  77. .SH DEVELOPER USAGE
  78. .P
  79. If you're using npm to develop and publish your code, check out the
  80. following help topics:
  81. .RS 0
  82. .IP \(bu 2
  83. json:
  84. Make a package\.json file\. See npm help 5 \fBpackage\.json\fP\|\.
  85. .IP \(bu 2
  86. link:
  87. For linking your current working code into Node's path, so that you
  88. don't have to reinstall every time you make a change\. Use
  89. \fBnpm link\fP to do this\.
  90. .IP \(bu 2
  91. install:
  92. It's a good idea to install things if you don't need the symbolic link\.
  93. Especially, installing other peoples code from the registry is done via
  94. \fBnpm install\fP
  95. .IP \(bu 2
  96. adduser:
  97. Create an account or log in\. Credentials are stored in the
  98. user config file\.
  99. .IP \(bu 2
  100. publish:
  101. Use the \fBnpm publish\fP command to upload your code to the registry\.
  102. .RE
  103. .SH CONFIGURATION
  104. .P
  105. npm is extremely configurable\. It reads its configuration options from
  106. 5 places\.
  107. .RS 0
  108. .IP \(bu 2
  109. Command line switches:
  110. Set a config with \fB\-\-key val\fP\|\. All keys take a value, even if they
  111. are booleans (the config parser doesn't know what the options are at
  112. the time of parsing)\. If no value is provided, then the option is set
  113. to boolean \fBtrue\fP\|\.
  114. .IP \(bu 2
  115. Environment Variables:
  116. Set any config by prefixing the name in an environment variable with
  117. \fBnpm_config_\fP\|\. For example, \fBexport npm_config_key=val\fP\|\.
  118. .IP \(bu 2
  119. User Configs:
  120. The file at $HOME/\.npmrc is an ini\-formatted list of configs\. If
  121. present, it is parsed\. If the \fBuserconfig\fP option is set in the cli
  122. or env, then that will be used instead\.
  123. .IP \(bu 2
  124. Global Configs:
  125. The file found at \.\./etc/npmrc (from the node executable, by default
  126. this resolves to /usr/local/etc/npmrc) will be parsed if it is found\.
  127. If the \fBglobalconfig\fP option is set in the cli, env, or user config,
  128. then that file is parsed instead\.
  129. .IP \(bu 2
  130. Defaults:
  131. npm's default configuration options are defined in
  132. lib/utils/config\-defs\.js\. These must not be changed\.
  133. .RE
  134. .P
  135. See npm help 7 \fBnpm\-config\fP for much much more information\.
  136. .SH CONTRIBUTIONS
  137. .P
  138. Patches welcome!
  139. .P
  140. If you would like to contribute, but don't know what to work on, read
  141. the contributing guidelines and check the issues list\.
  142. .RS 0
  143. .IP \(bu 2
  144. CONTRIBUTING\.md \fIhttps://github\.com/npm/cli/blob/latest/CONTRIBUTING\.md\fR
  145. .IP \(bu 2
  146. Bug tracker \fIhttps://npm\.community/c/bugs\fR
  147. .IP \(bu 2
  148. Support tracker \fIhttps://npm\.community/c/support\fR
  149. .RE
  150. .SH BUGS
  151. .P
  152. When you find issues, please report them:
  153. .RS 0
  154. .IP \(bu 2
  155. web:
  156. https://npm\.community/c/bugs
  157. .RE
  158. .P
  159. Be sure to follow the template and bug reporting guidelines\. You can also ask
  160. for help in the support forum \fIhttps://npm\.community/c/support\fR if you're
  161. unsure if it's actually a bug or are having trouble coming up with a detailed
  162. reproduction to report\.
  163. .SH AUTHOR
  164. .P
  165. Isaac Z\. Schlueter \fIhttp://blog\.izs\.me/\fR ::
  166. isaacs \fIhttps://github\.com/isaacs/\fR ::
  167. @izs \fIhttps://twitter\.com/izs\fR ::
  168. i@izs\.me
  169. .SH SEE ALSO
  170. .RS 0
  171. .IP \(bu 2
  172. npm help help
  173. .IP \(bu 2
  174. README
  175. .IP \(bu 2
  176. npm help 5 package\.json
  177. .IP \(bu 2
  178. npm help install
  179. .IP \(bu 2
  180. npm help config
  181. .IP \(bu 2
  182. npm help 7 config
  183. .IP \(bu 2
  184. npm help 5 npmrc
  185. .IP \(bu 2
  186. npm help 7 index
  187. .RE