s/CONFIG/CONFIGURATION/

12 files changed, 311 insertions, 37 deletions

diff --git a/man1/activate.1 b/man1/activate.1
index 7eb221f89..6779ead4a 100644
--- a/man1/activate.1
+++ b/man1/activate.1
@@ -16,5 +16,14 @@ npm activate <name>@<version> [<name>@<version> \.\.\.]
 .SH "DESCRIPTION"
 This "activates" a specific version of a package, so that you can just do \fBrequire("foo")\fR without having to specify the version\.
 .
+.SH "CONFIGURATION"
+.
+.SS "auto\-activate"
+Default: true
+.
+.P
+Automatically activate a package after installation, if there is not an active
+version already\.  Set to "always" to always activate when installing\.
+.
 .SH "SEE ALSO"
 npm\-deactivate(1)
diff --git a/man1/adduser.1 b/man1/adduser.1
index 511207fa6..9353ddbe7 100644
--- a/man1/adduser.1
+++ b/man1/adduser.1
@@ -30,3 +30,34 @@ or password\.
 .P
 You may use this command multiple times with the same user account to
 authorize on a new machine\.
+.
+.SH "CONFIGURATION"
+.
+.SS "_auth"
+A base\-64 encoded "user:pass" pair\.  This is created by npm\-adduser(1)\.
+.
+.P
+If your config file is ever corrupted, you can set this manually by doing:
+.
+.IP "" 4
+.
+.nf
+npm adduser
+.
+.fi
+.
+.IP "" 0
+.
+.SS "_authCrypt"
+If crypto\.Cipher is available, and you have some private keys in \fB$HOME/\.ssh\fR,
+then npm will encrypt your "\fIauth" config before saving to the \.npmrc file,
+and will decrypt the "\fRauthCrypt" config when it reads the \.npmrc file\.
+.
+.SS "registry"
+Default: https://registry\.npmjs\.org/
+.
+.P
+The base URL of the npm package registry\.
+.
+.SS "username, _password"
+Once the configuration is parsed, the \fB_auth\fR config is split into \fBusername\fR and \fB_password\fR\|\.  This is the part before the ":"
diff --git a/man1/build.1 b/man1/build.1
index 875e22f4b..78b3ae766 100644
--- a/man1/build.1
+++ b/man1/build.1
@@ -28,6 +28,8 @@ This command creates the various interwoven links that ensure a package\'s conte
 are available in the root appropriately, and that its dependencies are linked
 appropriately\.
 .
+.SH "CONFIGURATION"
+.
 .SH "SEE ALSO"
 .
 .IP "\(bu" 4
diff --git a/man1/cache.1 b/man1/cache.1
index 2b19fc019..8d3f9239f 100644
--- a/man1/cache.1
+++ b/man1/cache.1
@@ -66,5 +66,10 @@ The tarball for that version\.
 .
 .IP "" 0
 .
-.SH "HISTORY"
-Added in npm version 0\.1\.6
+.SH "CONFIGURATION"
+.
+.SS "root"
+Default: \fB$INSTALL_PREFIX/lib/node\fR
+.
+.P
+The root folder where packages are installed and npm keeps its data\.
diff --git a/man1/deprecate.1 b/man1/deprecate.1
index feb316edd..5dd6a5f89 100644
--- a/man1/deprecate.1
+++ b/man1/deprecate.1
@@ -31,4 +31,12 @@ npm deprecate my\-thing@"< 0\.2\.3" "critical bug fixed in v0\.2\.3"
 .IP "" 0
 .
 .P
-Note that you must be the package owner to deprecate something\.
+Note that you must be the package owner to deprecate something\.  See the \fBowner\fR and \fBadduser\fR help topics\.
+.
+.SH "CONFIGURATION"
+.
+.SS "registry"
+Default: https://registry\.npmjs\.org/
+.
+.P
+The base URL of the npm package registry\.
diff --git a/man1/edit.1 b/man1/edit.1
index bf736a653..cda31f694 100644
--- a/man1/edit.1
+++ b/man1/edit.1
@@ -30,3 +30,11 @@ conjunction with \fBnpm bundle\fR\|\.
 For instance, you can do \fBnpm bundle install connect\fR to install connect
 into your package, and then \fBnpm bundle edit connect\fR to make a few
 changes to your locally bundled copy\.
+.
+.SH "CONFIGURATION"
+.
+.SS "editor"
+Default: env\.EDITOR
+.
+.P
+The program to use to edit files\.
diff --git a/man1/folders.1 b/man1/folders.1
index 1b1b079f2..11a9b7d20 100644
--- a/man1/folders.1
+++ b/man1/folders.1
@@ -7,36 +7,40 @@
 \fBnpm-folders\fR \-\- Folder Structures Used by npm
 .
 .SH "DESCRIPTION"
-Everything lives in the \fBroot\fR setting\.  Check \fBnpm help config\fR for more
+Node modules and metadata live
+in the \fBroot\fR setting\.  Check \fBnpm help config\fR for more
 on configuration options\.
 .
 .P
-\fBroot/\.npm/foo\fR is where the stuff for package \fBfoo\fR would go\.
-.
-.P
-\fBroot/\.npm/foo/1\.0\.0/package\fR the contents of the tarball containing foo
-version 1\.0\.0
+\fBroot/foo\fR Symlink to the active version\'s module folder\.
 .
 .P
-\fBroot/\.npm/foo/1\.0\.0/main\.js\fR Generated file that exports the \fBmain\fR module in
-foo\.  This is a shim, not a symbolic link, so that relative paths will work
-appropriately\.
+\fBroot/foo@1\.0\.0/\fR Node modules for the foo package\.
 .
 .P
-\fBroot/foo\-1\.0\.0/{module\-name}\.js\fR Generated shim corresponding to a module
+\fBroot/foo@1\.0\.0/{module\-name}\.js\fR Generated shim corresponding to a module
 defined in the modules option\. The module shim requires \fBroot/\.npm/foo/1\.0\.0/package/{module\-path}\.js\fR
 .
 .P
 The \fBmain\fR script is implemented by creating an \fBindex\.js\fR file in this folder\.
 .
 .P
-\fBroot/foo/\fR Symlink to the active version\'s module folder\.
+\fBroot/\.npm/foo\fR is where the stuff for package \fBfoo\fR would go\.
+.
+.P
+\fBroot/\.npm/foo/1\.0\.0/package\fR the contents of the tarball containing foo
+version 1\.0\.0
+.
+.P
+\fBroot/\.npm/foo/1\.0\.0/main\.js\fR Generated file that exports the \fBmain\fR module in
+foo\.  This is a shim, not a symbolic link, so that relative paths will work
+appropriately\.
 .
 .P
 \fBroot/\.npm/foo/active\fR symlink to the active version\.
 .
 .P
-\fBroot/\.npm/foo/1\.0\.0/dependencies\fR links to the modules that foo depends upon\.
+\fBroot/\.npm/foo/1\.0\.0/node_modules\fR links to the modules that foo depends upon\.
 This is loaded into the require path first in the foo shims\.
 .
 .P
@@ -57,3 +61,59 @@ on\.  This is here so that npm can access those packages programmatically\.
 .
 .P
 \fBroot/\.npm/\.cache/foo/1\.0\.0/package\fR the untouched pristine copy of foo@1\.0\.0
+.
+.P
+Executables are installed to the folder specified by the \fBbinroot\fR config\.
+.
+.P
+\fBbinroot/foo\fR Symlink to the active version of the "foo" executable\.
+.
+.P
+\fBbinroot/foo@1\.0\.0\fR An executable for foo at version 1\.0\.0\.  Either a
+symbolic link or a shim to a file in the foo package\.
+.
+.P
+Man pages are installed to the folder specified by the \fBmanroot\fR config\.
+Man pages named something other than the package name are prefixed with
+the package name\.
+.
+.P
+\fBmanroot/man1/foo\.1\fR Symlink to the section 1 manpage for the active
+version of foo\.
+.
+.P
+\fBmanroot/man1/foo@1\.0\.0\.1\fR Section 1 man page for foo version 1\.0\.0
+.
+.P
+\fBmanroot/man8/foo\-bar\.8\fR Symlink to a section 8 manpage for the active
+version of foo\.
+.
+.P
+\fBmanroot/man8/foo\-bar@1\.0\.0\.8\fR A section 8 manpage for foo version
+1\.0\.0\.
+.
+.SH "CONFIGURATION"
+.
+.SS "root"
+Default: \fB$INSTALL_PREFIX/lib/node\fR
+.
+.P
+The root folder where packages are installed and npm keeps its data\.
+.
+.SS "binroot"
+Default: \fB$INSTALL_PREFIX/bin\fR
+.
+.P
+The folder where executable programs are installed\.
+.
+.P
+Set to "false" to not install executables
+.
+.SS "manroot"
+Default: $INSTALL_PREFIX/share/man
+.
+.P
+The folder where man pages are installed\.
+.
+.P
+Set to "false" to not install man pages\.
diff --git a/man1/install.1 b/man1/install.1
index 2978ec193..9d7ecfd4f 100644
--- a/man1/install.1
+++ b/man1/install.1
@@ -116,6 +116,89 @@ npm install sax@">=0\.1\.0 <0\.2\.0" bench supervisor
 .P
 The \fB\-\-tag\fR argument will apply to all of the specified install targets\.
 .
+.SH "CONFIGURATION"
+.
+.SS "root"
+Default: \fB$INSTALL_PREFIX/lib/node\fR
+.
+.P
+The root folder where packages are installed and npm keeps its data\.
+.
+.SS "binroot"
+Default: \fB$INSTALL_PREFIX/bin\fR
+.
+.P
+The folder where executable programs are installed\.
+.
+.P
+Set to "false" to not install executables
+.
+.SS "manroot"
+Default: $INSTALL_PREFIX/share/man
+.
+.P
+The folder where man pages are installed\.
+.
+.P
+Set to "false" to not install man pages\.
+.
+.SS "registry"
+Default: https://registry\.npmjs\.org/
+.
+.P
+The base URL of the npm package registry\.
+.
+.SS "tag"
+Default: latest
+.
+.P
+If you ask npm to install a package and don\'t tell it a specific version, then
+it will install the specified tag\.
+.
+.P
+Note: this has no effect on the npm\-tag(1) command\.
+.
+.SS "dev"
+If set to a truish value, then it\'ll install the "devDependencies" as well as
+"dependencies" when installing a package\.
+.
+.P
+Note that devDependencies are \fIalways\fR installed when linking a package\.
+.
+.SS "tar"
+Default: env\.TAR or "tar"
+.
+.P
+The name of a GNU\-compatible tar program on your system\.
+.
+.SS "gzip"
+Default: env\.GZIPBIN or "gzip"
+.
+.P
+The name of a GNU\-compatible gzip program on your system\.
+.
+.SS "must\-install"
+Default: true
+.
+.P
+Set to false to not install over packages that already exist\.  By
+default, \fBnpm install foo\fR will fetch and install the latest version of \fBfoo\fR, even if it matches a version already installed\.
+.
+.SS "auto\-activate"
+Default: true
+.
+.P
+Automatically activate a package after installation, if there is not an active
+version already\.  Set to "always" to always activate when installing\.
+.
+.SS "update\-dependents"
+Default: true
+.
+.P
+Automatically update a package\'s dependencies after installation, if it is the
+newest version installed\. Set to "always" to update dependents when a new
+version is installed, even if it\'s not the newest\.
+.
 .SH "SEE ALSO"
 .
 .IP "\(bu" 4
diff --git a/man1/link.1 b/man1/link.1
index d592672ab..137e8a56d 100644
--- a/man1/link.1
+++ b/man1/link.1
@@ -37,3 +37,7 @@ This way, linking the same folder will always result in the same version
 number, even if you bump the version in the package\.json file\.  The
 extremely high major version ensures that it will always be considered
 the "highest" version, since it is a development bleeding\-edge thing\.
+.
+.SH "CONFIGURATION"
+See the config section of \fBnpm help install\fR\|\.  The \fBdev\fR configuration
+setting is always set to \fBtrue\fR when doing a link install\.
diff --git a/man1/list.1 b/man1/list.1
index 423cd9f3e..8ed0549e3 100644
--- a/man1/list.1
+++ b/man1/list.1
@@ -46,23 +46,53 @@ npm ls installed
 .
 .IP "" 0
 .
+.SH "CONFIGURATION"
+.
+.SS "registry"
+Default: https://registry\.npmjs\.org/
+.
 .P
-Strings are matched using the JavaScript "split" function, so regular
-expression strings are ok\.  However, the highlighting is a simple
-split/join, so regexps probably won\'t get the funky colors\.
+The base URL of the npm package registry\.
+.
+.SS "listopts"
+Default: ""
 .
 .P
-You can also provide default arguments that are appended to all npm ls
-executions
+A whitespace\-separated list of extra args that are always passed to npm ls
 .
-.IP "" 4
+.P
+For example: \fBlistopts = remote\fR
 .
-.nf
-npm config set listopts remote 
+.P
+\fBnpm ls\fR
 .
-.fi
+.P
+The output here will always filter by remote
 .
-.IP "" 0
+.SH "description"
+Default: true
+.
+.P
+Show the package description in npm ls\.
+.
+.SS "outfd"
+Default: Standard Output FD (1)
+.
+.P
+The file descriptor (integer) or stream object where npm will write
+"normal" output\.  For instance, the \fBls\fR and \fBview\fR commands write their
+output here\.
+.
+.P
+When using npm programmatically, you may want to provide a
+FileWriteStream, or some other form of WritableStream\.
+.
+.SS "color"
+Default: true
+.
+.P
+Set to false to disable colorized output\.
 .
 .P
-This will append the remote argument each time \fBnpm ls\fR is called\.
+In versions of node that expose the \fBisatty\fR function, npm will never
+write colorized output to a non\-terminal file descriptor\.
diff --git a/man1/ln.1 b/man1/ln.1
index d592672ab..137e8a56d 100644
--- a/man1/ln.1
+++ b/man1/ln.1
@@ -37,3 +37,7 @@ This way, linking the same folder will always result in the same version
 number, even if you bump the version in the package\.json file\.  The
 extremely high major version ensures that it will always be considered
 the "highest" version, since it is a development bleeding\-edge thing\.
+.
+.SH "CONFIGURATION"
+See the config section of \fBnpm help install\fR\|\.  The \fBdev\fR configuration
+setting is always set to \fBtrue\fR when doing a link install\.
diff --git a/man1/ls.1 b/man1/ls.1
index 423cd9f3e..8ed0549e3 100644
--- a/man1/ls.1
+++ b/man1/ls.1
@@ -46,23 +46,53 @@ npm ls installed
 .
 .IP "" 0
 .
+.SH "CONFIGURATION"
+.
+.SS "registry"
+Default: https://registry\.npmjs\.org/
+.
 .P
-Strings are matched using the JavaScript "split" function, so regular
-expression strings are ok\.  However, the highlighting is a simple
-split/join, so regexps probably won\'t get the funky colors\.
+The base URL of the npm package registry\.
+.
+.SS "listopts"
+Default: ""
 .
 .P
-You can also provide default arguments that are appended to all npm ls
-executions
+A whitespace\-separated list of extra args that are always passed to npm ls
 .
-.IP "" 4
+.P
+For example: \fBlistopts = remote\fR
 .
-.nf
-npm config set listopts remote 
+.P
+\fBnpm ls\fR
 .
-.fi
+.P
+The output here will always filter by remote
 .
-.IP "" 0
+.SH "description"
+Default: true
+.
+.P
+Show the package description in npm ls\.
+.
+.SS "outfd"
+Default: Standard Output FD (1)
+.
+.P
+The file descriptor (integer) or stream object where npm will write
+"normal" output\.  For instance, the \fBls\fR and \fBview\fR commands write their
+output here\.
+.
+.P
+When using npm programmatically, you may want to provide a
+FileWriteStream, or some other form of WritableStream\.
+.
+.SS "color"
+Default: true
+.
+.P
+Set to false to disable colorized output\.
 .
 .P
-This will append the remote argument each time \fBnpm ls\fR is called\.
+In versions of node that expose the \fBisatty\fR function, npm will never
+write colorized output to a non\-terminal file descriptor\.