deps/npm/man/man5/npmrc.5

   1 .\" Generated with Ronnjs 0.3.8
   2 .\" http://github.com/kapouer/ronnjs/
   3 .
   4 .TH "NPMRC" "5" "November 2013" "" ""
   5 .
   6 .SH "NAME"
   7 \fBnpmrc\fR \-\- The npm config files
   8 .
   9 .SH "DESCRIPTION"
  10 npm gets its config settings from the command line, environment
  11 variables, and \fBnpmrc\fR files\.
  12 .
  13 .P
  14 The \fBnpm config\fR command can be used to update and edit the contents
  15 of the user and global npmrc files\.
  16 .
  17 .P
  18 npm help  For a list of available configuration options, see npm\-config\.
  19 .
  20 .SH "FILES"
  21 The three relevant files are:
  22 .
  23 .IP "\(bu" 4
  24 per\-user config file (~/\.npmrc)
  25 .
  26 .IP "\(bu" 4
  27 global config file ($PREFIX/npmrc)
  28 .
  29 .IP "\(bu" 4
  30 npm builtin config file (/path/to/npm/npmrc)
  31 .
  32 .IP "" 0
  33 .
  34 .P
  35 All npm config files are an ini\-formatted list of \fBkey = value\fR
  36 parameters\.  Environment variables can be replaced using \fB${VARIABLE_NAME}\fR\|\. For example:
  37 .
  38 .IP "" 4
  39 .
  40 .nf
  41 prefix = ${HOME}/\.npm\-packages
  42 .
  43 .fi
  44 .
  45 .IP "" 0
  46 .
  47 .P
  48 Each of these files is loaded, and config options are resolved in
  49 priority order\.  For example, a setting in the userconfig file would
  50 override the setting in the globalconfig file\.
  51 .
  52 .SS "Per\-user config file"
  53 \fB$HOME/\.npmrc\fR (or the \fBuserconfig\fR param, if set in the environment
  54 or on the command line)
  55 .
  56 .SS "Global config file"
  57 \fB$PREFIX/etc/npmrc\fR (or the \fBglobalconfig\fR param, if set above):
  58 This file is an ini\-file formatted list of \fBkey = value\fR parameters\.
  59 Environment variables can be replaced as above\.
  60 .
  61 .SS "Built\-in config file"
  62 \fBpath/to/npm/itself/npmrc\fR
  63 .
  64 .P
  65 This is an unchangeable "builtin" configuration file that npm keeps
  66 consistent across updates\.  Set fields in here using the \fB\|\./configure\fR
  67 script that comes with npm\.  This is primarily for distribution
  68 maintainers to override default configs in a standard and consistent
  69 manner\.
  70 .
  71 .SH "SEE ALSO"
  72 .
  73 .IP "\(bu" 4
  74 npm help  folders
  75 .
  76 .IP "\(bu" 4
  77 npm help config
  78 .
  79 .IP "\(bu" 4
  80 npm help  config
  81 .
  82 .IP "\(bu" 4
  83 npm help  package\.json
  84 .
  85 .IP "\(bu" 4
  86 npm help npm
  87 .
  88 .IP "" 0
  89