Skip to content
This repository has been archived by the owner on Aug 11, 2022. It is now read-only.

Commit

Permalink
s/CONFIG/CONFIGURATION/
Browse files Browse the repository at this point in the history
  • Loading branch information
isaacs committed Jan 6, 2011
1 parent d61c3b4 commit 4005bd9
Show file tree
Hide file tree
Showing 22 changed files with 321 additions and 58 deletions.
2 changes: 1 addition & 1 deletion doc/activate.md
Expand Up @@ -10,7 +10,7 @@ npm activate(1) -- Activate an installed version of a package
This "activates" a specific version of a package, so that you can just do
`require("foo")` without having to specify the version.

## CONFIG
## CONFIGURATION

### auto-activate

Expand Down
2 changes: 1 addition & 1 deletion doc/adduser.md
Expand Up @@ -21,7 +21,7 @@ or password.
You may use this command multiple times with the same user account to
authorize on a new machine.

## CONFIG
## CONFIGURATION

### _auth

Expand Down
2 changes: 1 addition & 1 deletion doc/build.md
Expand Up @@ -17,7 +17,7 @@ This command creates the various interwoven links that ensure a package's conten
are available in the root appropriately, and that its dependencies are linked
appropriately.

## CONFIG
## CONFIGURATION


## SEE ALSO
Expand Down
2 changes: 1 addition & 1 deletion doc/cache.md
Expand Up @@ -48,7 +48,7 @@ in this folder:
* package.tgz:
The tarball for that version.

## CONFIG
## CONFIGURATION

### root

Expand Down
2 changes: 1 addition & 1 deletion doc/deprecate.md
Expand Up @@ -18,7 +18,7 @@ something like this:
Note that you must be the package owner to deprecate something. See the
`owner` and `adduser` help topics.

## CONFIG
## CONFIGURATION

### registry

Expand Down
2 changes: 1 addition & 1 deletion doc/edit.md
Expand Up @@ -21,7 +21,7 @@ For instance, you can do `npm bundle install connect` to install connect
into your package, and then `npm bundle edit connect` to make a few
changes to your locally bundled copy.

## CONFIG
## CONFIGURATION

### editor

Expand Down
2 changes: 1 addition & 1 deletion doc/folders.md
Expand Up @@ -66,7 +66,7 @@ version of foo.
`manroot/man8/foo-bar@1.0.0.8` A section 8 manpage for foo version
1.0.0.

## CONFIG
## CONFIGURATION

### root

Expand Down
2 changes: 1 addition & 1 deletion doc/install.md
Expand Up @@ -78,7 +78,7 @@ You may combine multiple arguments, and even multiple types of arguments. For e

The `--tag` argument will apply to all of the specified install targets.

## CONFIG
## CONFIGURATION

### root

Expand Down
2 changes: 1 addition & 1 deletion doc/link.md
Expand Up @@ -24,7 +24,7 @@ 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.

## CONFIG
## CONFIGURATION

See the config section of `npm help install`. The `dev` configuration
setting is always set to `true` when doing a link install.
13 changes: 1 addition & 12 deletions doc/list.md
Expand Up @@ -23,18 +23,7 @@ installed. This can be accomplished by doing this:

npm ls installed

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.

You can also provide default arguments that are appended to all npm ls
executions

npm config set listopts remote

This will append the remote argument each time `npm ls` is called.

## CONFIG
## CONFIGURATION

### registry

Expand Down
9 changes: 9 additions & 0 deletions man1/activate.1
Expand Up @@ -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)
31 changes: 31 additions & 0 deletions man1/adduser.1
Expand Up @@ -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 ":"
2 changes: 2 additions & 0 deletions man1/build.1
Expand Up @@ -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
Expand Down
9 changes: 7 additions & 2 deletions man1/cache.1
Expand Up @@ -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\.
10 changes: 9 additions & 1 deletion man1/deprecate.1
Expand Up @@ -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\.
8 changes: 8 additions & 0 deletions man1/edit.1
Expand Up @@ -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\.
84 changes: 72 additions & 12 deletions man1/folders.1
Expand Up @@ -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
Expand All @@ -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\.

0 comments on commit 4005bd9

Please sign in to comment.