diff options
Diffstat (limited to 'deps/npm/man/man5/npmrc.5')
| -rw-r--r-- | deps/npm/man/man5/npmrc.5 | 31 |
1 files changed, 17 insertions, 14 deletions
diff --git a/deps/npm/man/man5/npmrc.5 b/deps/npm/man/man5/npmrc.5 index 172b909b8..5088566d8 100644 --- a/deps/npm/man/man5/npmrc.5 +++ b/deps/npm/man/man5/npmrc.5 @@ -1,12 +1,12 @@ -.TH "NPMRC" "5" "June 2015" "" "" +.TH "NPMRC" "5" "August 2015" "" "" .SH "NAME" \fBnpmrc\fR \- The npm config files .SH DESCRIPTION .P npm gets its config settings from the command line, environment -variables, and \fBnpmrc\fR files\. +variables, and \fBnpmrc\fP files\. .P -The \fBnpm config\fR command can be used to update and edit the contents +The \fBnpm config\fP command can be used to update and edit the contents of the user and global npmrc files\. .P For a list of available configuration options, see npm help 7 config\. @@ -25,9 +25,9 @@ npm builtin config file (/path/to/npm/npmrc) .RE .P -All npm config files are an ini\-formatted list of \fBkey = value\fR +All npm config files are an ini\-formatted list of \fBkey = value\fP parameters\. Environment variables can be replaced using -\fB${VARIABLE_NAME}\fR\|\. For example: +\fB${VARIABLE_NAME}\fP\|\. For example: .P .RS 2 .nf @@ -49,35 +49,38 @@ key[] = "second value" .fi .RE .P -\fBNOTE:\fR Because local (per\-project or per\-user) \fB\|\.npmrc\fR files can contain +\fBNOTE:\fR Because local (per\-project or per\-user) \fB\|\.npmrc\fP files can contain sensitive credentials, they must be readable and writable \fIonly\fR by your user -account (i\.e\. must have a mode of \fB0600\fR), otherwise they \fIwill be ignored by +account (i\.e\. must have a mode of \fB0600\fP), otherwise they \fIwill be ignored by npm!\fR .SS Per\-project config file .P -When working locally in a project, a \fB\|\.npmrc\fR file in the root of the -project (ie, a sibling of \fBnode_modules\fR and \fBpackage\.json\fR) will set +When working locally in a project, a \fB\|\.npmrc\fP file in the root of the +project (ie, a sibling of \fBnode_modules\fP and \fBpackage\.json\fP) will set config values specific to this project\. .P Note that this only applies to the root of the project that you're running npm in\. It has no effect when your module is published\. For example, you can't publish a module that forces itself to install globally, or in a different location\. +.P +Additionally, this file is not read in global mode, such as when running +\fBnpm install \-g\fP\|\. .SS Per\-user config file .P -\fB$HOME/\.npmrc\fR (or the \fBuserconfig\fR param, if set in the environment +\fB$HOME/\.npmrc\fP (or the \fBuserconfig\fP param, if set in the environment or on the command line) .SS Global config file .P -\fB$PREFIX/etc/npmrc\fR (or the \fBglobalconfig\fR param, if set above): -This file is an ini\-file formatted list of \fBkey = value\fR parameters\. +\fB$PREFIX/etc/npmrc\fP (or the \fBglobalconfig\fP param, if set above): +This file is an ini\-file formatted list of \fBkey = value\fP parameters\. Environment variables can be replaced as above\. .SS Built\-in config file .P -\fBpath/to/npm/itself/npmrc\fR +\fBpath/to/npm/itself/npmrc\fP .P This is an unchangeable "builtin" configuration file that npm keeps -consistent across updates\. Set fields in here using the \fB\|\./configure\fR +consistent across updates\. Set fields in here using the \fB\|\./configure\fP script that comes with npm\. This is primarily for distribution maintainers to override default configs in a standard and consistent manner\. |