Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/npm/cli.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
authorisaacs <i@izs.me>2010-08-18 21:58:59 +0400
committerisaacs <i@izs.me>2010-08-18 21:58:59 +0400
commitf2ccd1783065d471c891c83082eab9c76361c4c3 (patch)
tree837221b349cfe68a41aaf61dcde15d197b2f9657 /man
parent9e87e148e145ac46797ad41d02f9d41c9f1dfea1 (diff)
Use ronnjs instead of the ronn rubygem to build docs
Diffstat (limited to 'man')
-rw-r--r--man/activate.122
-rw-r--r--man/adduser.123
-rw-r--r--man/build.122
-rw-r--r--man/cache.162
-rw-r--r--man/coding-style.177
-rw-r--r--man/config.1101
-rw-r--r--man/deactivate.112
-rw-r--r--man/developers.1111
-rw-r--r--man/folders.126
-rw-r--r--man/future-ideas/deploy.116
-rw-r--r--man/future-ideas/remote.113
-rw-r--r--man/future-ideas/site.166
-rw-r--r--man/help.1130
-rw-r--r--man/install.193
-rw-r--r--man/json.1123
-rw-r--r--man/link.114
-rw-r--r--man/list.124
-rw-r--r--man/ln.114
-rw-r--r--man/ls.124
-rw-r--r--man/npm.1169
-rw-r--r--man/owner.136
-rw-r--r--man/publish.125
-rw-r--r--man/restart.113
-rw-r--r--man/rm.133
-rw-r--r--man/scripts.1109
-rw-r--r--man/start.19
-rw-r--r--man/stop.19
-rw-r--r--man/tag.114
-rw-r--r--man/test.19
-rw-r--r--man/uninstall.133
-rw-r--r--man/unpublish.112
-rw-r--r--man/update.122
-rw-r--r--man/view.113
33 files changed, 862 insertions, 617 deletions
diff --git a/man/activate.1 b/man/activate.1
index f863d6444..10b59ed16 100644
--- a/man/activate.1
+++ b/man/activate.1
@@ -1,21 +1 @@
-.\" generated with Ronn/v0.7.3
-.\" http://github.com/rtomayko/ronn/tree/0.7.3
-.
-.TH "ACTIVATE" "1" "May 2010" "" ""
-.
-.SH "NAME"
-\fBactivate\fR \- Activate an installed version of a package
-.
-.SH "SYNOPSIS"
-.
-.nf
-
-npm activate <name> <version>
-.
-.fi
-.
-.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 "SEE ALSO"
-npm\-deactivate(1)
+Unknown option: --pipe
diff --git a/man/adduser.1 b/man/adduser.1
index cd002ebc4..e4bfb6b04 100644
--- a/man/adduser.1
+++ b/man/adduser.1
@@ -1,27 +1,32 @@
-.\" generated with Ronn/v0.7.3
-.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.\" Generated with Ronnjs/v0.1
+.\" http://github.com/kapouer/ronnjs/
.
-.TH "NPM\-ADDUSER" "1" "July 2010" "" ""
+.TH "NPM\-ADDUSER" "1" "August 2010" "" ""
.
.SH "NAME"
-\fBnpm\-adduser\fR \- Add a registry user account
+\fBnpm-adduser\fR \-\- Add a registry user account
.
.SH "SYNOPSIS"
.
.nf
-
npm adduser
.
.fi
.
.SH "DESCRIPTION"
-Create or verify a user named \fB<username>\fR in the npm registry, and save the credentials to the \fB\.npmrc\fR file\.
+Create or verify a user named \fB<username>\fR in the npm registry, and
+save the credentials to the \fB\|\.npmrc\fR file\.
.
.P
-The username, password, and email are read in from prompts\. This command cannot be scripted\. If you think you need to script the creation of new users, or the authorization of existing ones, without human intervention, please rethink your use case\. That\'s a very bad idea\.
+The username, password, and email are read in from prompts\. This command
+cannot be scripted\. If you think you need to script the creation of new
+users, or the authorization of existing ones, without human intervention,
+please rethink your use case\. That\'s a very bad idea\.
.
.P
-You may use this command to change your email address, but not username or password\.
+You may use this command to change your email address, but not username
+or password\.
.
.P
-You may use this command multiple times with the same user account to authorize on a new machine\.
+You may use this command multiple times with the same user account to
+authorize on a new machine\.
diff --git a/man/build.1 b/man/build.1
index cc8e1df5b..37eace7ad 100644
--- a/man/build.1
+++ b/man/build.1
@@ -1,28 +1,32 @@
-.\" generated with Ronn/v0.7.3
-.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.\" Generated with Ronnjs/v0.1
+.\" http://github.com/kapouer/ronnjs/
.
-.TH "NPM\-BUILD" "1" "May 2010" "" ""
+.TH "NPM\-BUILD" "1" "August 2010" "" ""
.
.SH "NAME"
-\fBnpm\-build\fR \- Build a package
+\fBnpm-build\fR \-\- Build a package
.
.SH "SYNOPSIS"
.
.nf
-
npm build <package\-folder>
.
.fi
.
-.TP
-\fB<package\-folder>\fR
+.IP "\(bu" 4
+\fB<package\-folder>\fR:
A folder containing a \fBpackage\.json\fR file in its root\.
.
+.IP "" 0
+.
.SH "DESCRIPTION"
-This command should almost never need to be run directly\. It is an abstraction of the functionality shared by both npm\-install(1) and npm\-link(1)\.
+This command should almost never need to be run directly\. It is an abstraction
+of the functionality shared by both npm\-install(1) and npm\-link(1)\.
.
.P
-This command creates the various interwoven links that ensure a package\'s contents are available in the root appropriately, and that its dependencies are linked appropriately\.
+This command creates the various interwoven links that ensure a package\'s contents
+are available in the root appropriately, and that its dependencies are linked
+appropriately\.
.
.SH "SEE ALSO"
.
diff --git a/man/cache.1 b/man/cache.1
index 5f2c49fa9..9446dd631 100644
--- a/man/cache.1
+++ b/man/cache.1
@@ -1,60 +1,70 @@
-.\" generated with Ronn/v0.7.3
-.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.\" Generated with Ronnjs/v0.1
+.\" http://github.com/kapouer/ronnjs/
.
-.TH "NPM\-CACHE" "1" "May 2010" "" ""
+.TH "NPM\-CACHE" "1" "August 2010" "" ""
.
.SH "NAME"
-\fBnpm\-cache\fR \- install a package
+\fBnpm-cache\fR \-\- install a package
.
.SH "SYNOPSIS"
.
.nf
-
npm cache add <tarball file>
npm cache add <folder>
npm cache add <tarball url>
npm cache add <name> <version>
-
npm cache ls [<path>]
-
npm cache clean [<pkg> [<version>]]
.
.fi
.
.SH "DESCRIPTION"
.
-.TP
-add
-Access the local cache of package data\. This command is primarily intended to be used internally by npm, but it can provide a way to add data to the local installation cache explicitly\.
+.IP "\(bu" 4
+add:
+Access the local cache of package data\. This command is primarily
+intended to be used internally by npm, but it can provide a way to
+add data to the local installation cache explicitly\.
.
.IP
-If two arguments are provided, then npm will fetch the data from the registry\. This allows npm to use the filesystem as a local proxy to the registry\.
-.
-.TP
-ls
-Show the data in the cache\. Additional arguments are joined together in a path\-like fashion, but something like \fBnpm cache ls npm/0\.1\.5\fR is acceptable as well\.
-.
-.TP
-clean
-Delete data out of the cache for a specific package and version, all versions of a package, or all data for all packages, depending on the arguments supplied\.
+If two arguments are provided, then npm will fetch the data from the
+registry\. This allows npm to use the filesystem as a local proxy to
+the registry\.
+.
+.IP "\(bu" 4
+ls:
+Show the data in the cache\. Additional arguments are joined together
+in a path\-like fashion, but something like \fBnpm cache ls npm/0\.1\.5\fR is
+acceptable as well\.
+.
+.IP "\(bu" 4
+clean:
+Delete data out of the cache for a specific package and version, all
+versions of a package, or all data for all packages, depending on the
+arguments supplied\.
.
.IP
This can be used if invalid data gets into the cache\.
.
+.IP "" 0
+.
.SH "DETAILS"
-npm stores data for a version of a package in \fB$ROOT/\.npm/\.cache/<name>/<version>\fR\. Three pieces of data are stored in this folder:
+npm stores data for a version of a package in \fB$ROOT/\.npm/\.cache/<name>/<version>\fR\|\. Three pieces of data are stored
+in this folder:
.
-.TP
-package/
+.IP "\(bu" 4
+package/:
A folder containing the package contents as they appear in the tarball\.
.
-.TP
-package\.json
+.IP "\(bu" 4
+package\.json:
The package\.json file, as npm sees it, with overlays applied and a _id attribute\.
.
-.TP
-package\.tgz
+.IP "\(bu" 4
+package\.tgz:
The tarball for that version\.
.
+.IP "" 0
+.
.SH "HISTORY"
Added in npm version 0\.1\.6
diff --git a/man/coding-style.1 b/man/coding-style.1
index 6cc9e238b..04f4c5458 100644
--- a/man/coding-style.1
+++ b/man/coding-style.1
@@ -1,22 +1,28 @@
-.\" generated with Ronn/v0.7.3
-.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.\" Generated with Ronnjs/v0.1
+.\" http://github.com/kapouer/ronnjs/
.
-.TH "NPM\-CODING\-STYLE" "1" "July 2010" "" ""
+.TH "NPM\-CODING\-STYLE" "1" "August 2010" "" ""
.
.SH "NAME"
-\fBnpm\-coding\-style\fR \- npm\'s "funny" coding style
+\fBnpm-coding-style\fR \-\- npm\'s "funny" coding style
.
.SH "DESCRIPTION"
-npm\'s coding style is a bit unconventional\. It is not different for difference\'s sake, but rather a carefully crafted style that is designed to reduce visual clutter and make bugs more apparent\.
+npm\'s coding style is a bit unconventional\. It is not different for
+difference\'s sake, but rather a carefully crafted style that is
+designed to reduce visual clutter and make bugs more apparent\.
.
.P
-If you want to contribute to npm (which is very encouraged), you should make your code conform to npm\'s style\.
+If you want to contribute to npm (which is very encouraged), you should
+make your code conform to npm\'s style\.
.
.SH "Line Length"
-Keep lines shorter than 80 characters\. It\'s better for lines to be too short than to be too long\. Break up long lists, objects, and other statements onto multiple lines\.
+Keep lines shorter than 80 characters\. It\'s better for lines to be
+too short than to be too long\. Break up long lists, objects, and other
+statements onto multiple lines\.
.
.SH "Indentation"
-Two\-spaces\. Tabs are better, but they look like hell in web browsers (and on github), and node uses 2 spaces, so that\'s that\.
+Two\-spaces\. Tabs are better, but they look like hell in web browsers
+(and on github), and node uses 2 spaces, so that\'s that\.
.
.P
Configure your editor appropriately\.
@@ -30,7 +36,6 @@ Bad:
.IP "" 4
.
.nf
-
function ()
{
.
@@ -44,7 +49,6 @@ Good:
.IP "" 4
.
.nf
-
function () {
.
.fi
@@ -52,7 +56,8 @@ function () {
.IP "" 0
.
.P
-If a block needs to wrap to the next line, use a curly brace\. Don\'t use it if it doesn\'t\.
+If a block needs to wrap to the next line, use a curly brace\. Don\'t
+use it if it doesn\'t\.
.
.P
Bad:
@@ -60,7 +65,6 @@ Bad:
.IP "" 4
.
.nf
-
if (foo) { bar() }
while (foo)
bar()
@@ -75,7 +79,6 @@ Good:
.IP "" 4
.
.nf
-
if (foo) bar()
while (foo) {
bar()
@@ -89,13 +92,15 @@ while (foo) {
Don\'t use them except in three situations:
.
.IP "\(bu" 4
-for (;;) loops\. They\'re actually required\.
+for (;;) loops\. They\'re actually required\.
.
.IP "\(bu" 4
case "foo": doSomething(); break
.
.IP "\(bu" 4
-In front of a leading ( or [ at the start of the line\. This prevents the expression from being interpreted as a function call or property access, respectively\.
+In front of a leading ( or [ at the start of the line\.
+This prevents the expression from being interpreted
+as a function call or property access, respectively\.
.
.IP "" 0
.
@@ -105,7 +110,6 @@ Some examples of good semicolon usage:
.IP "" 4
.
.nf
-
;(x || y)\.doSomething()
;[a, b, c]\.forEach(doSomething)
for (var i = 0; i < 10; i ++) {
@@ -122,15 +126,18 @@ for (var i = 0; i < 10; i ++) {
.IP "" 0
.
.P
-Note that starting lines with \fB\-\fR and \fB+\fR also should be prefixed with a semicolon, but this is much less common\.
+Note that starting lines with \fB\-\fR and \fB+\fR also should be prefixed
+with a semicolon, but this is much less common\.
.
.SH "Comma First"
-If there is a list of things separated by commas, and it wraps across multiple lines, put the comma at the start of the next line, directly below the token that starts the list\. Put the final token in the list on a line by itself\. For example:
+If there is a list of things separated by commas, and it wraps
+across multiple lines, put the comma at the start of the next
+line, directly below the token that starts the list\. Put the
+final token in the list on a line by itself\. For example:
.
.IP "" 4
.
.nf
-
var magicWords = [ "abracadabra"
, "gesundheit"
, "ventrilo"
@@ -148,33 +155,42 @@ var magicWords = [ "abracadabra"
.IP "" 0
.
.SH "Whitespace"
-Put a single space in front of ( for anything other than a function call\. Also use a single space wherever it makes things more readable\.
+Put a single space in front of ( for anything other than a function call\.
+Also use a single space wherever it makes things more readable\.
.
.P
-Don\'t leave trailing whitespace at the end of lines\. Don\'t indent empty lines\. Don\'t use more spaces than are helpful\.
+Don\'t leave trailing whitespace at the end of lines\. Don\'t indent empty
+lines\. Don\'t use more spaces than are helpful\.
.
.SH "Functions"
-Use named functions\. They make stack traces a lot easier to read\.
+Use named functions\. They make stack traces a lot easier to read\.
.
.SH "Callbacks, Sync/async Style"
-Use the asynchronous/non\-blocking versions of things as much as possible\. It might make more sense for npm to use the synchronous fs APIs, but this way, the fs and http and child process stuff all uses the same callback\-passing methodology\.
+Use the asynchronous/non\-blocking versions of things as much as possible\.
+It might make more sense for npm to use the synchronous fs APIs, but this
+way, the fs and http and child process stuff all uses the same callback\-passing
+methodology\.
.
.P
-The callback should always be the last argument in the list\. Its first argument is the Error or null\.
+The callback should always be the last argument in the list\. Its first
+argument is the Error or null\.
.
.P
-Be very careful never to ever ever throw anything\. It\'s worse than useless\. Just send the error message back as the first argument to the callback\.
+Be very careful never to ever ever throw anything\. It\'s worse than useless\.
+Just send the error message back as the first argument to the callback\.
.
.SH "Errors"
-Always create a new Error object with your message\. Don\'t just return a string message to the callback\. Stack traces are handy\.
+Always create a new Error object with your message\. Don\'t just return a
+string message to the callback\. Stack traces are handy\.
.
.P
-Use the \fBrequire("\./utils/log")\.er\fR function\. It takes a callback and an error message, and returns an object that will report the message in the event of a failure\. It\'s quite handy\.
+Use the \fBrequire("\./utils/log")\.er\fR function\. It takes a callback and an
+error message, and returns an object that will report the message in the
+event of a failure\. It\'s quite handy\.
.
.IP "" 4
.
.nf
-
function myThing (args, cb) {
getData(args, function (er, data) {
if (er) return log\.er(cb, "Couldn\'t get data")(er)
@@ -190,4 +206,7 @@ function justHasToWork (cb) {
.IP "" 0
.
.SH "Logging"
-Please clean up logs when they are no longer helpful\. In particular, logging the same object over and over again is not helpful\. Logs should report what\'s happening so that it\'s easier to track down where a fault occurs\.
+Please clean up logs when they are no longer helpful\. In particular,
+logging the same object over and over again is not helpful\. Logs should
+report what\'s happening so that it\'s easier to track down where a fault
+occurs\.
diff --git a/man/config.1 b/man/config.1
index b706718a1..b0cf267ac 100644
--- a/man/config.1
+++ b/man/config.1
@@ -1,15 +1,14 @@
-.\" generated with Ronn/v0.7.3
-.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.\" Generated with Ronnjs/v0.1
+.\" http://github.com/kapouer/ronnjs/
.
.TH "NPM\-CONFIG" "1" "August 2010" "" ""
.
.SH "NAME"
-\fBnpm\-config\fR \- Manage the npm configuration file
+\fBnpm-config\fR \-\- Manage the npm configuration file
.
.SH "SYNOPSIS"
.
.nf
-
npm config set <key> <value> [\-\-global]
npm config get <key>
npm config delete <key>
@@ -20,25 +19,35 @@ npm config list
.SH "DESCRIPTION"
npm gets its configuration values from 5 sources, in this priority:
.
-.TP
-cli
-The command line flags\. Putting \fB\-\-foo bar\fR on the command line sets the \fBfoo\fR configuration parameter to \fB"bar"\fR\. A \fB\-\-\fR argument tells the cli parser to stop reading flags\. A \fB\-\-flag\fR parameter that is at the \fIend\fR of the command will be given the value of \fBtrue\fR\.
-.
-.TP
-env
-Any environment variables that start with \fBnpm_config_\fR will be interpreted as a configuration parameter\. For example, putting \fBnpm_config_foo=bar\fR in your environment will set the \fBfoo\fR configuration parameter to \fBbar\fR\. Any environment configurations that are not given a value will be given the value of \fBtrue\fR\. Config values are case\-insensitive, so \fBNPM_CONFIG_FOO=bar\fR will work the same\.
-.
-.TP
-$HOME/\.npmrc (or the \fBuserconfig\fR param, if set above)
+.IP "\(bu" 4
+cli:
+The command line flags\. Putting \fB\-\-foo bar\fR on the command line sets the \fBfoo\fR configuration parameter to \fB"bar"\fR\|\. A \fB\-\-\fR argument tells the cli
+parser to stop reading flags\. A \fB\-\-flag\fR parameter that is at the \fIend\fR of
+the command will be given the value of \fBtrue\fR\|\.
+.
+.IP "\(bu" 4
+env:
+Any environment variables that start with \fBnpm_config_\fR will be interpreted
+as a configuration parameter\. For example, putting \fBnpm_config_foo=bar\fR in
+your environment will set the \fBfoo\fR configuration parameter to \fBbar\fR\|\. Any
+environment configurations that are not given a value will be given the value
+of \fBtrue\fR\|\. Config values are case\-insensitive, so \fBNPM_CONFIG_FOO=bar\fR will
+work the same\.
+.
+.IP "\(bu" 4
+$HOME/\.npmrc (or the \fBuserconfig\fR param, if set above):
This file is an ini\-file formatted list of \fBkey = value\fR parameters\.
.
-.TP
-$PREFIX/etc/npmrc (or the \fBglobalconfig\fR param, if set above)
+.IP "\(bu" 4
+$PREFIX/etc/npmrc (or the \fBglobalconfig\fR param, if set above):
This file is an ini\-file formatted list of \fBkey = value\fR parameters
.
-.TP
-default configs
-This is a set of configuration parameters that are internal to npm, and are defaults if nothing else is specified\.
+.IP "\(bu" 4
+default configs:
+This is a set of configuration parameters that are internal to npm, and are
+defaults if nothing else is specified\.
+.
+.IP "" 0
.
.SH "Sub\-commands"
Config supports the following sub\-commands:
@@ -46,7 +55,6 @@ Config supports the following sub\-commands:
.SS "set"
.
.nf
-
npm config set key value
.
.fi
@@ -57,18 +65,18 @@ Sets the config key to the value\.
.SS "get"
.
.nf
-
npm config get key
.
.fi
.
.P
-Echo the config value to stdout\. (NOTE: All the other npm logging is done to stderr, so pipes should work properly, and you can do \fBnpm get key 2>/dev/null\fR to print out JUST the config value\.)
+Echo the config value to stdout\. (NOTE: All the other npm logging is done to
+stderr, so pipes should work properly, and you can do \fBnpm get key 2>/dev/null\fR
+to print out JUST the config value\.)
.
.SS "list"
.
.nf
-
npm config list
.
.fi
@@ -79,7 +87,6 @@ Show all the config settings\.
.SS "delete"
.
.nf
-
npm config delete key
.
.fi
@@ -88,12 +95,13 @@ npm config delete key
Deletes the key from all configuration files\.
.
.SH "Config Settings"
-npm supports a very basic argument parser\. For any of the settings in npm\-config(1), you can set them explicitly for a single command by doing:
+npm supports a very basic argument parser\. For any of the settings
+in npm\-config(1), you can set them explicitly for a single command by
+doing:
.
.IP "" 4
.
.nf
-
npm \-\-key val <command>
.
.fi
@@ -107,13 +115,16 @@ Configurations defined on the command line are not saved to the \.npmrc file\.
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\.
+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\.
+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\.
.
.SS "root"
Default: \fB$INSTALL_PREFIX/lib/node\fR
@@ -134,7 +145,7 @@ Default: https://registry\.npmjs\.org/
The base URL of the npm package registry\.
.
.SS "_auth"
-A base\-64 encoded "user:pass" pair\. This is created by npm\-adduser(1)\.
+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:
@@ -142,7 +153,6 @@ If your config file is ever corrupted, you can set this manually by doing:
.IP "" 4
.
.nf
-
npm adduser
.
.fi
@@ -150,19 +160,23 @@ npm adduser
.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\.
+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 "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\.
+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 "proxy"
-If proxy is available, then npm will fetch the modules from the registry via the proxy server\.
+If proxy is available, then npm will fetch the modules from the registry via
+the proxy server\.
.
.P
Example:
@@ -170,7 +184,6 @@ Example:
.IP "" 4
.
.nf
-
proxy = http://proxy\-server:8080
.
.fi
@@ -181,19 +194,29 @@ proxy = http://proxy\-server:8080
The default user configuration file is process\.env\.HOME+"/\.npmrc"\.
.
.P
-Note that this must be provided either in the cli or env settings\. Once the userconfig is read, it is irrelevant\.
+Note that this must be provided either in the cli or env settings\. Once the
+userconfig is read, it is irrelevant\.
.
.SS "globalconfig"
-The default global configuration file is resolved based on the location of the node executable\. It is process\.execPath+"/\.\./\.\./etc/npmrc"\. In the canonical NodeJS installation with \fBmake install\fR, this is \fB/usr/local/etc/npmrc\fR\. If you put the node binary somewhere else (for instance, if you are using nvm or nave), then it would be resolved relative to that location\.
+The default global configuration file is resolved based on the location of the
+node executable\. It is process\.execPath+"/\.\./\.\./etc/npmrc"\. In the canonical
+NodeJS installation with \fBmake install\fR, this is \fB/usr/local/etc/npmrc\fR\|\. If you
+put the node binary somewhere else (for instance, if you are using nvm or
+nave), then it would be resolved relative to that location\.
.
.P
-Note that this must be provided in the cli, env, or userconfig settings\. Once the globalconfig is read, this parameter is irrelevant\.
+Note that this must be provided in the cli, env, or userconfig settings\. Once
+the globalconfig is read, this parameter is irrelevant\.
.
.SS "global"
-If set to some truish value (for instance, by being the last cli flag or being passed a literal \fBtrue\fR or \fB1\fR), and the \fBnpm config set\fR param is being called, then the new configuration paramater is written global config file\. Otherwise, they are saved to the user config file\.
+If set to some truish value (for instance, by being the last cli flag or being
+passed a literal \fBtrue\fR or \fB1\fR), and the \fBnpm config set\fR param is being
+called, then the new configuration paramater is written global config file\.
+Otherwise, they are saved to the user config file\.
.
.SS "dev"
-If set to a truish value, then it\'ll install the "devDependencies" as well as "dependencies" when installing a package\.
+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\.
diff --git a/man/deactivate.1 b/man/deactivate.1
index 5a8360c54..65b7fae27 100644
--- a/man/deactivate.1
+++ b/man/deactivate.1
@@ -1,21 +1,21 @@
-.\" generated with Ronn/v0.7.3
-.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.\" Generated with Ronnjs/v0.1
+.\" http://github.com/kapouer/ronnjs/
.
-.TH "NPM\-DEACTIVATE" "1" "May 2010" "" ""
+.TH "NPM\-DEACTIVATE" "1" "August 2010" "" ""
.
.SH "NAME"
-\fBnpm\-deactivate\fR \- Deactivate the active version of a package
+\fBnpm-deactivate\fR \-\- Deactivate the active version of a package
.
.SH "SYNOPSIS"
.
.nf
-
npm deactivate <name>
.
.fi
.
.SH "DESCRIPTION"
-If there\'s an active version of the package, this will unlink it from that preferential position\.
+If there\'s an active version of the package, this will unlink it from that
+preferential position\.
.
.SH "SEE ALSO"
npm\-activate(1)
diff --git a/man/developers.1 b/man/developers.1
index cc903fa33..90381d46a 100644
--- a/man/developers.1
+++ b/man/developers.1
@@ -1,10 +1,10 @@
-.\" generated with Ronn/v0.7.3
-.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.\" Generated with Ronnjs/v0.1
+.\" http://github.com/kapouer/ronnjs/
.
-.TH "NPM\-DEVELOPERS" "1" "May 2010" "" ""
+.TH "NPM\-DEVELOPERS" "1" "August 2010" "" ""
.
.SH "NAME"
-\fBnpm\-developers\fR \- Developer Guide
+\fBnpm-developers\fR \-\- Developer Guide
.
.SH "DESCRIPTION"
So, you\'ve decided to use npm to publish your project\.
@@ -13,55 +13,74 @@ So, you\'ve decided to use npm to publish your project\.
Fantastic!
.
.P
-There are a few things that you need to do above the simple steps that your users will do to install your program\.
+There are a few things that you need to do above the simple steps
+that your users will do to install your program\.
.
.SH "About These Documents"
-These are man pages\. If you install npm, you should be able to then do \fBman npm\-thing\fR to get the documentation on a particular topic\.
+These are man pages\. If you install npm, you should be able to
+then do \fBman npm\-thing\fR to get the documentation on a particular
+topic\.
.
.P
-Any time you see "see npm\-whatever(1)", you can do \fBman npm\-whatever\fR to get at the docs\.
+Any time you see "see npm\-whatever(1)", you can do \fBman npm\-whatever\fR
+to get at the docs\.
.
.SH "The package\.json File"
You need to have a \fBpackage\.json\fR file in the root of your project\.
.
.P
-See npm\-json(1) for details about what goes in that file\. At the very least, you need:
+See npm\-json(1) for details about what goes in that file\. At the very
+least, you need:
.
-.TP
-name
-This should be a string that identifies your project\. Please do not use the name to specify that it runs on node, or is in JavaScript\. You can use the "engines" field to explicitly state the versions of node (or whatever else) that your program requires, and it\'s pretty well assumed that it\'s javascript\.
+.IP "\(bu" 4
+name:
+This should be a string that identifies your project\. Please do not
+use the name to specify that it runs on node, or is in JavaScript\.
+You can use the "engines" field to explicitly state the versions of
+node (or whatever else) that your program requires, and it\'s pretty
+well assumed that it\'s javascript\.
.
.IP
It does not necessarily need to match your github repository name\.
.
-.P
-So, \fBnode\-foo\fR and \fBbar\-js\fR are bad names\. \fBfoo\fR or \fBbar\fR are better\.
+.IP
+So, \fBnode\-foo\fR and \fBbar\-js\fR are bad names\. \fBfoo\fR or \fBbar\fR are better\.
.
-.TP
-version
+.IP "\(bu" 4
+version:
A semver\-compatible version\.
.
-.TP
-engines
-Specify the versions of node (or whatever else) that your program runs on\. The node API changes a lot, and there may be bugs or new functionality that you depend on\. Be explicit\.
+.IP "\(bu" 4
+engines:
+Specify the versions of node (or whatever else) that your program
+runs on\. The node API changes a lot, and there may be bugs or new
+functionality that you depend on\. Be explicit\.
.
-.TP
-author
+.IP "\(bu" 4
+author:
Take some credit\.
.
-.TP
-scripts
-If you have a special compilation or installation script, then you should put it in the \fBscripts\fR hash\. See npm\-scripts(1)\.
+.IP "\(bu" 4
+scripts:
+If you have a special compilation or installation script, then you
+should put it in the \fBscripts\fR hash\. See npm\-scripts(1)\.
.
-.TP
-main
-If you have a single module that serves as the entry point to your program (like what the "foo" package gives you at require("foo")), then you need to specify that in the "main" field\.
+.IP "\(bu" 4
+main:
+If you have a single module that serves as the entry point to your
+program (like what the "foo" package gives you at require("foo")),
+then you need to specify that in the "main" field\.
+.
+.IP "" 0
.
.SH "Make Sure Your Package Installs and Works"
\fBThis is important\.\fR
.
.P
-If you can not install it locally, you\'ll have problems trying to publish it\. Or, worse yet, you\'ll be able to publish it, but you\'ll be publishing a broken or pointless package\. So don\'t do that\.
+If you can not install it locally, you\'ll have
+problems trying to publish it\. Or, worse yet, you\'ll be able to
+publish it, but you\'ll be publishing a broken or pointless package\.
+So don\'t do that\.
.
.P
In the root of your package, do this:
@@ -69,7 +88,6 @@ In the root of your package, do this:
.IP "" 4
.
.nf
-
npm install \.
.
.fi
@@ -77,12 +95,12 @@ npm install \.
.IP "" 0
.
.P
-That\'ll show you that it\'s working\. If you\'d rather just create a symlink package that points to your working directory, then do this:
+That\'ll show you that it\'s working\. If you\'d rather just create a symlink
+package that points to your working directory, then do this:
.
.IP "" 4
.
.nf
-
npm link \.
.
.fi
@@ -93,12 +111,12 @@ npm link \.
Use \fBnpm ls @installed\fR to see if it\'s there\.
.
.P
-Then go into the node\-repl, and try using require() to bring in your module\'s main and libs things\. Assuming that you have a package like this:
+Then go into the node\-repl, and try using require() to bring in your module\'s
+main and libs things\. Assuming that you have a package like this:
.
.IP "" 4
.
.nf
-
node_foo/
lib/
foo\.js
@@ -114,7 +132,6 @@ and you define your package\.json with this in it:
.IP "" 4
.
.nf
-
{ "name" : "foo"
, "directories" : { "lib" : "\./lib" }
, "main" : "\./lib/foo"
@@ -125,15 +142,17 @@ and you define your package\.json with this in it:
.IP "" 0
.
.P
-then you\'d want to make sure that require("foo") and require("foo/bar") both work and bring in the appropriate modules\.
+then you\'d want to make sure that require("foo") and require("foo/bar") both
+work and bring in the appropriate modules\.
.
.SH "Compile Node with OpenSSL"
-npm will stubbornly refuse to expose your password in the clear\. That means that you\'ll have to install whatever package provides openssl\.h on your system\. When you \fB\./configure\fR node, make sure that it says:
+npm will stubbornly refuse to expose your password in the clear\. That
+means that you\'ll have to install whatever package provides openssl\.h
+on your system\. When you \fB\|\./configure\fR node, make sure that it says:
.
.IP "" 4
.
.nf
-
Checking for openssl : yes
.
.fi
@@ -141,12 +160,11 @@ Checking for openssl : yes
.IP "" 0
.
.SH "Create a User Account"
-Create a user with the adduser command\. It works like this:
+Create a user with the adduser command\. It works like this:
.
.IP "" 4
.
.nf
-
npm adduser bob password bob@email\.com
.
.fi
@@ -154,12 +172,12 @@ npm adduser bob password bob@email\.com
.IP "" 0
.
.P
-This is documented better in npm\-adduser(1)\. So do this to get the details:
+This is documented better in npm\-adduser(1)\. So do this to get the
+details:
.
.IP "" 4
.
.nf
-
man npm\-adduser
.
.fi
@@ -172,7 +190,6 @@ This part\'s easy\.
.IP "" 4
.
.nf
-
npm publish /path/to/my\-package
.
.fi
@@ -180,15 +197,16 @@ npm publish /path/to/my\-package
.IP "" 0
.
.P
-You can give publish a url to a tarball, or a filename of a tarball, or a path to a folder\. (Paths have to either be "\." or contain a "/"\.)
+You can give publish a url to a tarball, or a filename of a tarball,
+or a path to a folder\. (Paths have to either be "\." or contain a "/"\.)
.
-.SH "Tag your package as \"stable\""
-This makes it easier to install without your users having to know the version ahead of time\.
+.SH "Tag your package as "stable""
+This makes it easier to install without your users having to know the
+version ahead of time\.
.
.IP "" 4
.
.nf
-
npm tag my\-package 1\.2\.3 stable
.
.fi
@@ -196,7 +214,8 @@ npm tag my\-package 1\.2\.3 stable
.IP "" 0
.
.P
-You can also use other tags, but "stable" and "latest" have reserved meanings\.
+You can also use other tags, but "stable" and "latest" have reserved
+meanings\.
.
.SH "Brag about it"
Send emails, write blogs, blab in IRC\.
diff --git a/man/folders.1 b/man/folders.1
index f0589903d..443d52f38 100644
--- a/man/folders.1
+++ b/man/folders.1
@@ -1,37 +1,43 @@
-.\" generated with Ronn/v0.7.3
-.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.\" Generated with Ronnjs/v0.1
+.\" http://github.com/kapouer/ronnjs/
.
.TH "NPM\-FOLDERS" "1" "August 2010" "" ""
.
.SH "NAME"
-\fBnpm\-folders\fR \- Folder Structures Used by npm
+\fBnpm-folders\fR \-\- Folder Structures Used by npm
.
.SH "DESCRIPTION"
-Everything lives in the \fBroot\fR setting\. Check \fBnpm help config\fR for more on configuration options\.
+Everything lives 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/\.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\.
+\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/foo\-1\.0\.0\.js\fR shim to \fB\.npm/foo/1\.0\.0/main\.js\fR
+\fBroot/foo\-1\.0\.0\.js\fR shim to \fB\|\.npm/foo/1\.0\.0/main\.js\fR
.
.P
-\fBroot/foo\.js\fR shim to \fB\.npm/foo/active/main\.js\fR
+\fBroot/foo\.js\fR shim to \fB\|\.npm/foo/active/main\.js\fR
.
.P
-\fBroot/\.npm/foo/1\.0\.0/dependencies\fR links to the modules that foo depends upon\. This is loaded into the require path first in the foo shims\.
+\fBroot/\.npm/foo/1\.0\.0/dependencies\fR links to the modules that foo depends upon\.
+This is loaded into the require path first in the foo shims\.
.
.P
-\fBroot/\.npm/foo/1\.0\.0/dependson\fR links to the package folders that foo depends on\. This is here so that npm can access those packages programmatically\.
+\fBroot/\.npm/foo/1\.0\.0/dependson\fR links to the package folders that foo depends
+on\. This is here so that npm can access those packages programmatically\.
.
.P
\fBroot/\.npm/foo/1\.0\.0/dependents\fR links to the packages that depend upon foo\.
diff --git a/man/future-ideas/deploy.1 b/man/future-ideas/deploy.1
index 39f79e0cf..6c0f36631 100644
--- a/man/future-ideas/deploy.1
+++ b/man/future-ideas/deploy.1
@@ -1,10 +1,10 @@
-.\" generated with Ronn/v0.7.3
-.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.\" Generated with Ronnjs/v0.1
+.\" http://github.com/kapouer/ronnjs/
.
-.TH "NPM\-DEPLOY" "1" "July 2010" "" ""
+.TH "NPM\-DEPLOY" "1" "August 2010" "" ""
.
.SH "NAME"
-\fBnpm\-deploy\fR \- Deploy a package to a remote host
+\fBnpm-deploy\fR \-\- Deploy a package to a remote host
.
.SH "FUTURE"
This functionality does not yet exist\.
@@ -12,18 +12,16 @@ This functionality does not yet exist\.
.SH "SUMMARY"
.
.nf
-
npm deploy <pkg> [\-\-host <hostname>]
.
.fi
.
.SH "DESCRIPTION"
-This is a porcelain command\. It is equivalent to doing:
+This is a porcelain command\. It is equivalent to doing:
.
.IP "" 4
.
.nf
-
npm publish \-\-registry $(npm config get host) <pkg>
npm remote install <pkg\-name>@<pkg\-version>
.
@@ -32,7 +30,9 @@ npm remote install <pkg\-name>@<pkg\-version>
.IP "" 0
.
.P
-That is, it first publishes the package to the server specified by the \fBhost\fR config, and then remotely installs that package on the host\.
+That is, it first publishes the package to the server specified
+by the \fBhost\fR config, and then remotely installs that package
+on the host\.
.
.SH "SEE ALSO"
.
diff --git a/man/future-ideas/remote.1 b/man/future-ideas/remote.1
index 52916ea51..9c1c50f98 100644
--- a/man/future-ideas/remote.1
+++ b/man/future-ideas/remote.1
@@ -1,10 +1,10 @@
-.\" generated with Ronn/v0.7.3
-.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.\" Generated with Ronnjs/v0.1
+.\" http://github.com/kapouer/ronnjs/
.
-.TH "NPM\-REMOTE" "1" "July 2010" "" ""
+.TH "NPM\-REMOTE" "1" "August 2010" "" ""
.
.SH "NAME"
-\fBnpm\-remote\fR \- Execute commands on a remote machine
+\fBnpm-remote\fR \-\- Execute commands on a remote machine
.
.SH "FUTURE"
This functionality does not yet exist\.
@@ -12,7 +12,6 @@ This functionality does not yet exist\.
.SH "SYNOPSIS"
.
.nf
-
npm remote <commands>
.
.fi
@@ -21,7 +20,9 @@ npm remote <commands>
Run a command on a remote npm site instance\.
.
.P
-In order to do this, the current authenticated user must be in the "admin" list on the server, and it must be running with https support\.
+In order to do this, the current authenticated user must be in
+the "admin" list on the server, and it must be running with https
+support\.
.
.P
It uses the \fBhost\fR config to know where to do things\.
diff --git a/man/future-ideas/site.1 b/man/future-ideas/site.1
index 537f1b0ab..18052c7db 100644
--- a/man/future-ideas/site.1
+++ b/man/future-ideas/site.1
@@ -1,10 +1,10 @@
-.\" generated with Ronn/v0.7.3
-.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.\" Generated with Ronnjs/v0.1
+.\" http://github.com/kapouer/ronnjs/
.
-.TH "NPM\-SITE" "1" "July 2010" "" ""
+.TH "NPM\-SITE" "1" "August 2010" "" ""
.
.SH "NAME"
-\fBnpm\-site\fR \- Run the npm web site
+\fBnpm-site\fR \-\- Run the npm web site
.
.SH "FUTURE"
This functionality does not yet exist\.
@@ -12,44 +12,60 @@ This functionality does not yet exist\.
.SH "SYNOPSIS"
.
.nf
-
npm site [ start | stop ]
.
.fi
.
.SH "DESCRIPTION"
-This starts up npm in "site" mode\. The following configs are relevant, and can either be specified in the \fB\.npmrc\fR file, or as command line options\.
-.
-.TP
-userfile
-A file containing the encrypted authorization info for all users\. If specified, then this is used for \fBnpm adduser\fR requests to this registry\.
+This starts up npm in "site" mode\. The following configs are relevant,
+and can either be specified in the \fB\|\.npmrc\fR file, or as command line
+options\.
.
-.br
-
+.IP "\(bu" 4
+userfile:
+A file containing the encrypted authorization info for all users\. If
+specified, then this is used for \fBnpm adduser\fR requests
+to this registry\.
.
-.TP
-admin
-A comma\-delimited list of admin users\. All of these must already be in the local adduser config\. If there is no admin, then the site will not allow remote management\. All admin usernames must already be in the userfile, and a userfile must be specified\.
+.IP "\(bu" 4
+admin:
+A comma\-delimited list of admin users\. All of these must already be
+in the local adduser config\. If there is no admin, then the site will
+not allow remote management\. All admin usernames must already be
+in the userfile, and a userfile must be specified\.
.
-.TP
-listen
-Ports to listen on for WS requests\. The first number is for http, the second for https, and the third for secure TCP\. Set any to "\-", or omit, to use the default\. Defaults to "80,443,15443"
+.IP "\(bu" 4
+listen:
+Ports to listen on for WS requests\. The first number is for http,
+the second for https, and the third for secure TCP\. Set any to "\-",
+or omit, to use the default\.
+Defaults to "80,443,15443"
.
-.TP
-registry
-If a package is not found, then its contents will be fetched from the upstream registry, and cached for future retrieval\.
+.IP "\(bu" 4
+registry:
+If a package is not found, then its contents will be fetched from the
+upstream registry, and cached for future retrieval\.
.
.IP
-isaacs: Make sure that this does loop\-detection, so that a "ring" of registries can work as a distributed network\. Also, once we have support for checking multiple registries, you could have a distribution ring that secondarily depends on some other upstream resource\.
+isaacs: Make sure that this does loop\-detection, so that a "ring" of
+registries can work as a distributed network\. Also, once we have
+support for checking multiple registries, you could have a distribution
+ring that secondarily depends on some other upstream resource\.
+.
+.IP "" 0
.
.P
-The content for the site is stored in the npm cache directory, which is inside the folder used for the \fBroot\fR setting, at \fB{root}/\.npm/\.cache\fR\. It is organized in a simple hierarchical folder structure corresponding to the web service URLs that npm uses\.
+The content for the site is stored in the npm cache directory, which is
+inside the folder used for the \fBroot\fR setting, at \fB{root}/\.npm/\.cache\fR\|\.
+It is organized in a simple hierarchical folder structure corresponding
+to the web service URLs that npm uses\.
.
.SH "TCP Server"
-The TCP server starts up to support the \fBnpm remote\fR command, if there is a valid admin userlist\.
+The TCP server starts up to support the \fBnpm remote\fR command, if there is
+a valid admin userlist\.
.
.SH "NOTE"
-This also is what happens when you do \fBnpm start npm\fR\.
+This also is what happens when you do \fBnpm start npm\fR\|\.
.
.SH "SEE ALSO"
.
diff --git a/man/help.1 b/man/help.1
index 9d01f6995..dbf8fd399 100644
--- a/man/help.1
+++ b/man/help.1
@@ -1,94 +1,142 @@
-.\" generated with Ronn/v0.7.3
-.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.\" Generated with Ronnjs/v0.1
+.\" http://github.com/kapouer/ronnjs/
.
.TH "NPM\-HELP" "1" "August 2010" "" ""
.
.SH "NAME"
-\fBnpm\-help\fR \- Get help about npm commands
+\fBnpm-help\fR \-\- Get help about npm commands
.
.SH "SYNOPSIS"
.
.nf
-
npm help <section>
.
.fi
.
.SH "DESCRIPTION"
-\fB<section>\fR is one of: activate adduser build cache coding\-style config deactivate developers folders help install json link list ln ls npm owner publish restart rm scripts start stop tag test uninstall unpublish update view
+\fB<section>\fR is one of:
+activate
+adduser
+build
+cache
+coding\-style
+config
+deactivate
+developers
+folders
+help
+install
+json
+link
+list
+ln
+ls
+npm
+owner
+publish
+restart
+rm
+scripts
+start
+stop
+tag
+test
+uninstall
+unpublish
+update
+view
.
.SH "12\-second Intro"
You probably got npm because you want to install stuff\.
.
.P
-Use \fBnpm install blerg\fR to install the latest version of "blerg"\. Check out \fBnpm help install\fR for more info\. It can do a lot of stuff\.
+Use \fBnpm install blerg\fR to install the latest version of "blerg"\. Check out \fBnpm help install\fR for more info\. It can do a lot of stuff\.
.
.P
-Use the \fBnpm ls\fR command to show everything that\'s available\. Looking for express\-related modules? \fBnpm ls express\fR\. Looking for the latest express? \fBnpm ls express latest\fR\. (The arguments are just simple greps\.) And of course, \fBnpm help ls\fR will tell you more\.
+Use the \fBnpm ls\fR command to show everything that\'s available\. Looking for
+express\-related modules? \fBnpm ls express\fR\|\. Looking for the latest express? \fBnpm ls express latest\fR\|\. (The arguments are just simple greps\.) And of course, \fBnpm help ls\fR will tell you more\.
.
.P
Use \fBnpm ls installed\fR to show everything you\'ve installed\.
.
.SH "Where to go for help"
-Come bug isaacs in irc://freenode\.net#node\.js\. He\'ll ask you to copy the npm output to a pastie or gist, and perhaps to post an issue if it\'s a new bug\.
+Come bug isaacs in irc://freenode\.net#node\.js\. He\'ll ask you to copy the npm
+output to a pastie or gist, and perhaps to post an issue if it\'s a new bug\.
.
.P
Failing that, report the issue:
.
-.TP
-web
-\fIhttp://github\.com/isaacs/npm/issues\fR
+.IP "\(bu" 4
+web: \fIhttp://github\.com/isaacs/npm/issues\fR
+.
+.IP "\(bu" 4
+email: \fInpm\-@googlegroups\.com\fR
.
-.TP
-email
-\fInpm\-@googlegroups\.com\fR
+.IP "" 0
.
.P
-If you ask something that\'s answered by this doc, you may be told to RTFM\. So, save yourself some time and read it now\.
+If you ask something that\'s answered by this doc, you may be told to RTFM\.
+So, save yourself some time and read it now\.
.
.SH "Configs"
-Use the \fBnpm config\fR command to manage how npm does stuff and where it puts things\. It stores your configs in the \fB~/\.npmrc\fR file\. Check \fBnpm help config\fR for more info on that, if you care\.
+Use the \fBnpm config\fR command to manage how npm does stuff and where it puts things\.
+It stores your configs in the \fB~/\.npmrc\fR file\. Check \fBnpm help config\fR for more
+info on that, if you care\.
.
.P
-You can override any config for just a single command by doing \fB\-\-configname value\fR on the command line\.
+You can override any config for just a single command by doing \fB\-\-configname value\fR
+on the command line\.
.
.SH "Developers"
If you\'re using npm to develop and publish your code, check out the following topics:
.
-.TP
-json
-Make a package\.json file\. The "json" help doc will tell you what to put in it\.
+.IP "\(bu" 4
+json:
+Make a package\.json file\. The "json" help doc will tell you what to put in it\.
.
-.TP
-link
-For linking your current working code into Node\'s path, so that you don\'t have to reinstall every time you make a change\. Use "npm link" to do this\.
+.IP "\(bu" 4
+link:
+For linking your current working code into Node\'s path, so that you don\'t have to
+reinstall every time you make a change\. Use "npm link" to do this\.
.
-.TP
-install
-It\'s a good idea to install things if you don\'t need the symbolic link\. Especially, installing other peoples code from the registry is done via "npm install"\.
+.IP "\(bu" 4
+install:
+It\'s a good idea to install things if you don\'t need the symbolic link\. Especially,
+installing other peoples code from the registry is done via "npm install"\.
.
-.TP
-adduser
-Use the \fBnpm adduser\fR command to add a user account for the npm registry, or to authorize yourself on a new machine\. If you forget your password, send an email to \fInpm\-@googlegroups\.com\fR and we\'ll delete your account so you can recreate it\.
+.IP "\(bu" 4
+adduser:
+Use the \fBnpm adduser\fR command to add a user account for the npm registry, or to
+authorize yourself on a new machine\. If you forget your password, send an email
+to \fInpm\-@googlegroups\.com\fR and we\'ll delete your account so you can recreate it\.
.
-.TP
-publish
-Use the \fBnpm publish\fR command to upload your code to the registry, so that other people can install it easily\.
+.IP "\(bu" 4
+publish:
+Use the \fBnpm publish\fR command to upload your code to the registry, so that other
+people can install it easily\.
+.
+.IP "" 0
.
.SH "Contributing"
Patches welcome!
.
-.TP
-code
-Read through \fBnpm help coding\-style\fR if you plan to submit code\. You don\'t have to agree with it, but you do have to follow it\.
+.IP "\(bu" 4
+code:
+Read through \fBnpm help coding\-style\fR if you plan to submit code\. You don\'t have to
+agree with it, but you do have to follow it\.
+.
+.IP "\(bu" 4
+docs:
+If you find an error in the documentation, edit the appropriate markdown file in the
+"doc" folder\. If you have the "ronn" gem installed, then you can \fBmake doc\fR to build
+the man page, but this is not necessary for your patch to be accepted\.
.
-.TP
-docs
-If you find an error in the documentation, edit the appropriate markdown file in the "doc" folder\. If you have the "ronn" gem installed, then you can \fBmake doc\fR to build the man page, but this is not necessary for your patch to be accepted\.
+.IP "\(bu" 4
+tests:
+The tests are pretty limited\. It would be great to perhaps use
+something like expresso or vows\.
.
-.TP
-tests
-The tests are pretty limited\. It would be great to perhaps use something like expresso or vows\.
+.IP "" 0
.
.P
Contributors are listed in npm\'s \fBpackage\.json\fR file\.
diff --git a/man/install.1 b/man/install.1
index adf2d90ba..bbcea67bf 100644
--- a/man/install.1
+++ b/man/install.1
@@ -1,15 +1,14 @@
-.\" generated with Ronn/v0.7.3
-.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.\" Generated with Ronnjs/v0.1
+.\" http://github.com/kapouer/ronnjs/
.
-.TH "NPM\-INSTALL" "1" "May 2010" "" ""
+.TH "NPM\-INSTALL" "1" "August 2010" "" ""
.
.SH "NAME"
-\fBnpm\-install\fR \- install a package
+\fBnpm-install\fR \-\- install a package
.
.SH "SYNOPSIS"
.
.nf
-
npm install <tarball file>
npm install <tarball url>
npm install <folder>
@@ -21,95 +20,93 @@ npm install <pkg>@<version range>
.fi
.
.SH "DESCRIPTION"
-This command installs a package, and any packages that it depends on\. It resolves circular dependencies by talking to the npm registry\.
+This command installs a package, and any packages that it depends on\. It
+resolves circular dependencies by talking to the npm registry\.
.
-.TP
-npm install \fB<tarball file>\fR
-Install a package that is sitting on the filesystem\. Note: if you just want to link a dev directory into your npm root, you can do this more easily by using \fBnpm link\fR\.
+.IP "\(bu" 4
+npm install \fB<tarball file>\fR:
+Install a package that is sitting on the filesystem\. Note: if you just want
+to link a dev directory into your npm root, you can do this more easily by
+using \fBnpm link\fR\|\.
.
.IP
-In order to distinguish between this and remote installs, the argument must either be "\." or contain a "/" in it\.
+In order to distinguish between this and remote installs, the argument
+must either be "\." or contain a "/" in it\.
.
-.P
+.IP
Example:
.
-.IP "" 4
-.
-.nf
-
+.IP
npm install \./package\.tgz
.
-.fi
-.
-.IP "" 0
-.
-.TP
-npm install \fB<tarball url>\fR
-Fetch the tarball url, and then install it\. In order to distinguish between this and other options, the argument must start with "http://" or "https://"
+.IP "\(bu" 4
+npm install \fB<tarball url>\fR:
+Fetch the tarball url, and then install it\. In order to distinguish between
+this and other options, the argument must start with "http://" or "https://"
.
.IP
Example:
.
.IP
-npm install http://github\.com/waveto/node\-crypto/tarball/v0\.0\.5
+ npm install http://github\.com/waveto/node\-crypto/tarball/v0\.0\.5
.
-.TP
-npm install \fB<pkg>\fR
-Do a \fB<pkg>@<tag>\fR install, where \fB<tag>\fR is the "tag" config from either your \.npmrc file, or the \-\-tag argument on the command line\.
+.IP "\(bu" 4
+npm install \fB<pkg>\fR:
+Do a \fB<pkg>@<tag>\fR install, where \fB<tag>\fR is the "tag" config from either your
+\|\.npmrc file, or the \-\-tag argument on the command line\.
.
.IP
Example:
.
.IP
-npm install sax
+ npm install sax
.
-.TP
-npm install \fB<pkg>@<tag>\fR
-Install the version of the package that is referenced by the specified tag\. If the tag does not exist in the registry data for that package, then this will fail\.
+.IP "\(bu" 4
+npm install \fB<pkg>@<tag>\fR:
+Install the version of the package that is referenced by the specified tag\.
+If the tag does not exist in the registry data for that package, then this
+will fail\.
.
.IP
Example:
.
.IP
-npm install sax@stable
+ npm install sax@stable
.
-.TP
-npm install \fB<pkg>@<version>\fR
-Install the specified version of the package\. This will fail if the version has not been published to the registry\.
+.IP "\(bu" 4
+npm install \fB<pkg>@<version>\fR:
+Install the specified version of the package\. This will fail if the version
+has not been published to the registry\.
.
.IP
Example:
.
.IP
-npm install sax@0\.1\.1
+ npm install sax@0\.1\.1
.
-.TP
-npm install \fB<pkg>@<version range>\fR
-Install a version of the package matching the specified version range\. This will follow the same rules for resolving dependencies described in \fBnpm help json\fR\.
+.IP "\(bu" 4
+npm install \fB<pkg>@<version range>\fR:
+Install a version of the package matching the specified version range\. This
+will follow the same rules for resolving dependencies described in \fBnpm help json\fR\|\.
.
.IP
-Note that most version ranges must be put in quotes so that your shell will treat it as a single argument\.
+Note that most version ranges must be put in quotes so that your shell will
+treat it as a single argument\.
.
-.P
+.IP
Example:
.
-.IP "" 4
-.
-.nf
-
+.IP
npm install sax@">=0\.1\.0 <0\.2\.0"
.
-.fi
-.
.IP "" 0
.
.P
-You may combine multiple arguments, and even multiple types of arguments\. For example:
+You may combine multiple arguments, and even multiple types of arguments\. For example:
.
.IP "" 4
.
.nf
-
npm install sax@">=0\.1\.0 <0\.2\.0" bench supervisor
.
.fi
diff --git a/man/json.1 b/man/json.1
index 924ab6aa9..b296f53f0 100644
--- a/man/json.1
+++ b/man/json.1
@@ -1,34 +1,43 @@
-.\" generated with Ronn/v0.7.3
-.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.\" Generated with Ronnjs/v0.1
+.\" http://github.com/kapouer/ronnjs/
.
-.TH "NPM\-JSON" "1" "July 2010" "" ""
+.TH "NPM\-JSON" "1" "August 2010" "" ""
.
.SH "NAME"
-\fBnpm\-json\fR \- Specifics of npm\'s package\.json handling
+\fBnpm-json\fR \-\- Specifics of npm\'s package\.json handling
.
.SH "DESCRIPTION"
-npm aims to implement the commonjs Packages \fIhttp://wiki\.commonjs\.org/wiki/Packages/1\.0\fR spec\. However, some adjustments have been made, which may eventually be unmade, but hopefully will be incorporated into the spec\.
+npm aims to implement the commonjs Packages \fIhttp://wiki\.commonjs\.org/wiki/Packages/1\.0\fR spec\. However, some
+adjustments have been made, which may eventually be unmade, but hopefully will
+be incorporated into the spec\.
.
.P
-This document is all you need to know about what\'s required in your package\.json file\.
+This document is all you need to know about what\'s required in your package\.json
+file\.
.
.SH "name"
The \fImost\fR important things in your package\.json are the name and version fields\.
.
.P
-The name is what your thing is called\. Some tips:
+The name is what your thing is called\. Some tips:
.
.IP "\(bu" 4
-Don\'t put "js" or "node" in the name\. It\'s assumed that it\'s js, since you\'re writing a package\.json file, and you can specify the engine using the "engines" field\. (See below\.)
+Don\'t put "js" or "node" in the name\. It\'s assumed that it\'s js, since you\'re
+writing a package\.json file, and you can specify the engine using the "engines"
+field\. (See below\.)
.
.IP "\(bu" 4
-The name ends up being part of a URL, an argument on the command line, and a folder name\. So, don\'t use characters that are annoying in those contexts, like funny UTF things or parentheses or slashes, or else it\'ll break\.
+The name ends up being part of a URL, an argument on the command line, and a
+folder name\. So, don\'t use characters that are annoying in those contexts, like
+funny UTF things or parentheses or slashes, or else it\'ll break\.
.
.IP "\(bu" 4
-The name will probably be passed as an argument to require(), so it should be something short, but also reasonably descriptive\.
+The name will probably be passed as an argument to require(), so it should
+be something short, but also reasonably descriptive\.
.
.IP "\(bu" 4
-You may want to check the npm registry to see if there\'s something by that name already, before you get too attached to it\. http://registry\.npmjs\.org/
+You may want to check the npm registry to see if there\'s something by that name
+already, before you get too attached to it\. http://registry\.npmjs\.org/
.
.IP "" 0
.
@@ -36,21 +45,31 @@ You may want to check the npm registry to see if there\'s something by that name
The \fImost\fR important things in your package\.json are the name and version fields\.
.
.P
-Version must be semver \fIhttp://semver\.org\fR\-compliant\. npm assumes that you\'ve read the semver page, and that you comply with it\. Here\'s how it deviates from what\'s on semver\.org:
+Version must be semver \fIhttp://semver\.org\fR\-compliant\. npm assumes that you\'ve
+read the semver page, and that you comply with it\. Here\'s how it deviates from
+what\'s on semver\.org:
.
.IP "\(bu" 4
Versions can start with "v"
.
.IP "\(bu" 4
-A numeric item separated from the main three\-number version by a hyphen will be interpreted as a "build" number, and will \fIincrease\fR the version\. But, if the tag is not a number separated by a hyphen, then it\'s treated as a pre\-release tag, and is \fIless than\fR the version without a tag\. So, 0\.1\.2\-7 > 0\.1\.2\-6 > 0\.1\.2 > 0\.1\.2beta
+A numeric item separated from the main three\-number version by a hyphen
+will be interpreted as a "build" number, and will \fIincrease\fR the version\.
+But, if the tag is not a number separated by a hyphen, then it\'s treated
+as a pre\-release tag, and is \fIless than\fR the version without a tag\.
+So, 0\.1\.2\-7 > 0\.1\.2\-6 > 0\.1\.2 > 0\.1\.2beta
.
.IP "" 0
.
.P
-This is a little bit confusing to explain, but matches what you see in practice when people create tags in git like "v1\.2\.3" and then do "git describe" to generate a patch version\. (This is how node\'s versions are generated, and has driven this design\.)
+This is a little bit confusing to explain, but matches what you see in practice
+when people create tags in git like "v1\.2\.3" and then do "git describe" to generate
+a patch version\. (This is how node\'s versions are generated, and has driven this
+design\.)
.
.SH "main"
-The main field is a module ID that is the primary entry point to your program\. That is, if your package is named \fBfoo\fR, and a user installs it, and then does \fBrequire("foo")\fR, then your main module\'s exports object will be returned\.
+The main field is a module ID that is the primary entry point to your program\.
+That is, if your package is named \fBfoo\fR, and a user installs it, and then does \fBrequire("foo")\fR, then your main module\'s exports object will be returned\.
.
.P
This should be a module ID relative to the root of your package folder\.
@@ -62,25 +81,35 @@ For most modules, it makes the most sense to have a main script\.
The "directories" member is an object hash of folders\.
.
.SS "directories\.lib"
-The only directory that npm cares about is the "lib" directory\. This is a folder that will be mapped to the package name\. So, if you had a package named \fBfoo\fR, and the package\.json contains \fB"directories":{"lib":"\./lib"}\fR, and there was a file called \fB\./lib/bar\.js\fR, then require("foo/bar") would include that module\.
+The only directory that npm cares about is the "lib" directory\. This is a folder
+that will be mapped to the package name\. So, if you had a package named \fBfoo\fR,
+and the package\.json contains \fB"directories":{"lib":"\./lib"}\fR, and there was
+a file called \fB\|\./lib/bar\.js\fR, then require("foo/bar") would include that module\.
.
.P
-This is handy if your package is a collection or library full of useful goodies\. However, dependency paths are not corrected for modules in the lib folder, so it\'s a bit more complicated\.
+This is handy if your package is a collection or library full of useful goodies\.
+However, dependency paths are not corrected for modules in the lib folder, so it\'s
+a bit more complicated\.
.
.P
Most of the time, delving into a package\'s folder is not as awesome\.
.
.SH "scripts"
-The "scripts" member is an object hash of script commands that are run at various times in the lifecycle of your package\. The key is the lifecycle event, and the value is the command to run at that point\.
+The "scripts" member is an object hash of script commands that are run
+at various times in the lifecycle of your package\. The key is the lifecycle
+event, and the value is the command to run at that point\.
.
.P
See \fBnpm help scripts\fR to find out more about writing package scripts\.
.
.SH "dependencies"
-Dependencies are specified with a simple hash of package name to version range\. The version range is EITHER a string with has one or more space\-separated descriptors, OR a range like "fromVersion \- toVersion"
+Dependencies are specified with a simple hash of package name to version
+range\. The version range is EITHER a string with has one or more
+space\-separated descriptors, OR a range like "fromVersion \- toVersion"
.
.P
-Version range descriptors may be any of the following styles, where "version" is a semver compatible version identifier\.
+Version range descriptors may be any of the following styles, where "version"
+is a semver compatible version identifier\.
.
.IP "\(bu" 4
\fBversion\fR Must match \fBversion\fR exactly
@@ -107,7 +136,7 @@ Version range descriptors may be any of the following styles, where "version" is
\fB""\fR (just an empty string) Same as \fB*\fR
.
.IP "\(bu" 4
-\fBversion1 \- version2\fR Same as \fB>=version1 <=version2\fR\.
+\fBversion1 \- version2\fR Same as \fB>=version1 <=version2\fR\|\.
.
.IP "" 0
.
@@ -117,7 +146,6 @@ For example, these are all valid:
.IP "" 4
.
.nf
-
{ "dependencies" :
{ "foo" : "1\.0\.0 \- 2\.9999\.9999"
, "bar" : ">=1\.0\.2 <2\.1\.2"
@@ -131,12 +159,12 @@ For example, these are all valid:
.IP "" 0
.
.SH "link"
-You may specify a \fBlink\fR member in your package\.json to have npm link dependencies in to a particular location inside your package dir\. For example:
+You may specify a \fBlink\fR member in your package\.json to have npm link
+dependencies in to a particular location inside your package dir\. For example:
.
.IP "" 4
.
.nf
-
{ "dependencies" :
{ "boo" : "2\.0\.1"
, "baz" : ">1\.0\.2 <=2\.3\.4"
@@ -156,21 +184,27 @@ You may specify a \fBlink\fR member in your package\.json to have npm link depen
.IP "" 0
.
.P
-This would link the dependencies into the specified locations, so that the package code could do \fBrequire("\./deps/foo")\fR to import whichever version of \fBfoo\fR was satisfying the requirement\.
+This would link the dependencies into the specified locations, so that the
+package code could do \fBrequire("\./deps/foo")\fR to import whichever version of \fBfoo\fR was satisfying the requirement\.
.
.P
-\fBWarning!\fR This is currently the \fIonly\fR way in which npm modifies the pristine nature of the package directory, and it may go away eventually\. It\'s just that it satisfies a use case that is pretty tricky to do otherwise\.
+<strong style="color:red">Warning!</strong> This is currently the \fIonly\fR way
+in which npm modifies the pristine nature of the package directory, and it may
+go away eventually\. It\'s just that it satisfies a use case that is pretty
+tricky to do otherwise\.
.
.SH "engines"
-Packages/1\.0 says that you can have an "engines" field with an array of engine names\. However, it has no provision for specifying which version of the engine your stuff runs on\.
+Packages/1\.0 says that you can have an "engines" field with an array of engine
+names\. However, it has no provision for specifying which version of the engine
+your stuff runs on\.
.
.P
-With npm, you can use either of the following styles to specify the version of node that your stuff works on:
+With npm, you can use either of the following styles to specify the version of
+node that your stuff works on:
.
.IP "" 4
.
.nf
-
{ "engines" : [ "node >=0\.1\.27 <0\.1\.30" ] }
.
.fi
@@ -183,7 +217,6 @@ or:
.IP "" 4
.
.nf
-
{ "engines" : { "node" : ">=0\.1\.27 <0\.1\.30" } }
.
.fi
@@ -191,16 +224,26 @@ or:
.IP "" 0
.
.P
-And, like with dependencies, if you don\'t specify the version (or if you specify "*" as the version), then any version of node will do\.
+And, like with dependencies, if you don\'t specify the version (or if you
+specify "*" as the version), then any version of node will do\.
.
.P
-If you specify an "engines" field, then npm will require that "node" be somewhere on that list\. If "engines" is omitted, then npm will just assume that it works on node\.
+If you specify an "engines" field, then npm will require that "node" be
+somewhere on that list\. If "engines" is omitted, then npm will just assume
+that it works on node\.
.
.SH "bin"
-A lot of packages have one or more executable files that they\'d like to install into the PATH\. npm makes this pretty easy (in fact, it uses this feature to install the "npm" executable\.)
+A lot of packages have one or more executable files that they\'d like to
+install into the PATH\. npm makes this pretty easy (in fact, it uses this
+feature to install the "npm" executable\.)
.
.P
-To use this, supply a \fBbin\fR field in your package\.json which is a map of command name to local file name\. On install, npm will link that file into place right next to wherever node is installed\. (Presumably, this is in your PATH, and defaults to \fB/usr/local/bin\fR\.) On activation, the versioned file will get linked to the main filename (just like how the main\.js stuff works, but with an executable in the PATH\.)
+To use this, supply a \fBbin\fR field in your package\.json which is a map of
+command name to local file name\. On install, npm will link that file into
+place right next to wherever node is installed\. (Presumably, this is in your
+PATH, and defaults to \fB/usr/local/bin\fR\|\.) On activation, the versioned file
+will get linked to the main filename (just like how the main\.js stuff works,
+but with an executable in the PATH\.)
.
.P
For example, npm has this:
@@ -208,7 +251,6 @@ For example, npm has this:
.IP "" 4
.
.nf
-
{ "bin" : { "npm" : "\./cli\.js" } }
.
.fi
@@ -216,10 +258,12 @@ For example, npm has this:
.IP "" 0
.
.P
-So, when you install npm, it\'ll create a symlink from the \fBcli\.js\fR script to \fB/usr/local/bin/npm\-version\fR\. Then, when you activate that version, it\'ll create a symlink from \fB/usr/local/bin/npm\-version\fR to \fB/usr/local/bin/npm\fR\.
+So, when you install npm, it\'ll create a symlink from the \fBcli\.js\fR script to \fB/usr/local/bin/npm\-version\fR\|\. Then, when you activate that version, it\'ll
+create a symlink from \fB/usr/local/bin/npm\-version\fR to \fB/usr/local/bin/npm\fR\|\.
.
.SH "overlay"
-npm responds to the \fBnode\fR and \fBnpm\fR env\-specific package\.json values, which you can hang on the "overlay" key\.
+npm responds to the \fBnode\fR and \fBnpm\fR env\-specific package\.json values, which
+you can hang on the "overlay" key\.
.
.P
For example:
@@ -227,7 +271,6 @@ For example:
.IP "" 4
.
.nf
-
{ "name" : "foo"
, "version" : 7
, "description" : "generic description"
@@ -255,7 +298,6 @@ In this case, this is what npm will treat it as:
.IP "" 4
.
.nf
-
{ "name" : "bar"
, "version" : "1\.0\.7"
, "description" : "description for npm"
@@ -266,4 +308,5 @@ In this case, this is what npm will treat it as:
.IP "" 0
.
.P
-This way, even if npm is not exactly the same as some other package management system, you can still use both, and it can be a happy planet\.
+This way, even if npm is not exactly the same as some other package management
+system, you can still use both, and it can be a happy planet\.
diff --git a/man/link.1 b/man/link.1
index d2a31457b..a2cb43a56 100644
--- a/man/link.1
+++ b/man/link.1
@@ -1,18 +1,20 @@
-.\" generated with Ronn/v0.7.3
-.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.\" Generated with Ronnjs/v0.1
+.\" http://github.com/kapouer/ronnjs/
.
-.TH "NPM\-LINK" "1" "May 2010" "" ""
+.TH "NPM\-LINK" "1" "August 2010" "" ""
.
.SH "NAME"
-\fBnpm\-link\fR \- Symlink a package folder
+\fBnpm-link\fR \-\- Symlink a package folder
.
.SH "SYNOPSIS"
.
.nf
-
npm link <folder>
.
.fi
.
.SH "DESCRIPTION"
-This will link a source folder into npm\'s registry using a symlink, and then build it according to the package\.json file in that folder\'s root\. This is handy for installing your own stuff, so that you can work on it and test it iteratively without having to continually rebuild\.
+This will link a source folder into npm\'s registry using a symlink, and then
+build it according to the package\.json file in that folder\'s root\. This is
+handy for installing your own stuff, so that you can work on it and test it
+iteratively without having to continually rebuild\.
diff --git a/man/list.1 b/man/list.1
index 236510380..f344b4fe5 100644
--- a/man/list.1
+++ b/man/list.1
@@ -1,30 +1,32 @@
-.\" generated with Ronn/v0.7.3
-.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.\" Generated with Ronnjs/v0.1
+.\" http://github.com/kapouer/ronnjs/
.
.TH "NPM\-LIST" "1" "August 2010" "" ""
.
.SH "NAME"
-\fBnpm\-list\fR \- List installed packages
+\fBnpm-list\fR \-\- List installed packages
.
.SH "SYNOPSIS"
.
.nf
-
npm list
npm ls
.
.fi
.
.SH "DESCRIPTION"
-This command will print to stdout all the versions of packages that are either installed or available in the registry, with their tags and whether or not they\'re active and/or stable\.
+This command will print to stdout all the versions of packages that are
+either installed or available in the registry, with their tags and whether
+or not they\'re active and/or stable\.
.
.P
-To filter a single package or state, you can provide words to filter on and highlight (if appropriate)\. For instance, to see all the stable packages, you could do this:
+To filter a single package or state, you can provide words to filter on
+and highlight (if appropriate)\. For instance, to see all the stable
+packages, you could do this:
.
.IP "" 4
.
.nf
-
npm ls stable
.
.fi
@@ -32,12 +34,12 @@ npm ls stable
.IP "" 0
.
.P
-Another common usage is to find the set of all packages that are installed\. This can be accomplished by doing this:
+Another common usage is to find the set of all packages that are
+installed\. This can be accomplished by doing this:
.
.IP "" 4
.
.nf
-
npm ls installed
.
.fi
@@ -45,4 +47,6 @@ npm ls installed
.IP "" 0
.
.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\.
+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\.
diff --git a/man/ln.1 b/man/ln.1
index d2a31457b..a2cb43a56 100644
--- a/man/ln.1
+++ b/man/ln.1
@@ -1,18 +1,20 @@
-.\" generated with Ronn/v0.7.3
-.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.\" Generated with Ronnjs/v0.1
+.\" http://github.com/kapouer/ronnjs/
.
-.TH "NPM\-LINK" "1" "May 2010" "" ""
+.TH "NPM\-LINK" "1" "August 2010" "" ""
.
.SH "NAME"
-\fBnpm\-link\fR \- Symlink a package folder
+\fBnpm-link\fR \-\- Symlink a package folder
.
.SH "SYNOPSIS"
.
.nf
-
npm link <folder>
.
.fi
.
.SH "DESCRIPTION"
-This will link a source folder into npm\'s registry using a symlink, and then build it according to the package\.json file in that folder\'s root\. This is handy for installing your own stuff, so that you can work on it and test it iteratively without having to continually rebuild\.
+This will link a source folder into npm\'s registry using a symlink, and then
+build it according to the package\.json file in that folder\'s root\. This is
+handy for installing your own stuff, so that you can work on it and test it
+iteratively without having to continually rebuild\.
diff --git a/man/ls.1 b/man/ls.1
index 236510380..f344b4fe5 100644
--- a/man/ls.1
+++ b/man/ls.1
@@ -1,30 +1,32 @@
-.\" generated with Ronn/v0.7.3
-.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.\" Generated with Ronnjs/v0.1
+.\" http://github.com/kapouer/ronnjs/
.
.TH "NPM\-LIST" "1" "August 2010" "" ""
.
.SH "NAME"
-\fBnpm\-list\fR \- List installed packages
+\fBnpm-list\fR \-\- List installed packages
.
.SH "SYNOPSIS"
.
.nf
-
npm list
npm ls
.
.fi
.
.SH "DESCRIPTION"
-This command will print to stdout all the versions of packages that are either installed or available in the registry, with their tags and whether or not they\'re active and/or stable\.
+This command will print to stdout all the versions of packages that are
+either installed or available in the registry, with their tags and whether
+or not they\'re active and/or stable\.
.
.P
-To filter a single package or state, you can provide words to filter on and highlight (if appropriate)\. For instance, to see all the stable packages, you could do this:
+To filter a single package or state, you can provide words to filter on
+and highlight (if appropriate)\. For instance, to see all the stable
+packages, you could do this:
.
.IP "" 4
.
.nf
-
npm ls stable
.
.fi
@@ -32,12 +34,12 @@ npm ls stable
.IP "" 0
.
.P
-Another common usage is to find the set of all packages that are installed\. This can be accomplished by doing this:
+Another common usage is to find the set of all packages that are
+installed\. This can be accomplished by doing this:
.
.IP "" 4
.
.nf
-
npm ls installed
.
.fi
@@ -45,4 +47,6 @@ npm ls installed
.IP "" 0
.
.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\.
+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\.
diff --git a/man/npm.1 b/man/npm.1
index a3ba111bd..b830a01c7 100644
--- a/man/npm.1
+++ b/man/npm.1
@@ -1,15 +1,14 @@
-.\" generated with Ronn/v0.7.3
-.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.\" Generated with Ronnjs/v0.1
+.\" http://github.com/kapouer/ronnjs/
.
.TH "NPM" "1" "August 2010" "" ""
.
.SH "NAME"
-\fBnpm\fR \- node package manager
+\fBnpm\fR \-\- node package manager
.
.SH "SYNOPSIS"
.
.nf
-
npm <command> [args]
.
.fi
@@ -18,19 +17,21 @@ npm <command> [args]
npm is a little package manager for the Node javascript library\.
.
.P
-Run \fBnpm help\fR for help\. That\'s probably what you meant to do\.
+Run \fBnpm help\fR for help\. That\'s probably what you meant to do\.
.
.SH "STATUS: Useful Beta"
-The core functionality is there\. It works\.
+The core functionality is there\. It works\.
.
.P
-Please use this software\. It will cut you occasionally\. Let me know when you find a rough edge, and I\'ll sand it down for you\.
+Please use this software\. It will cut you occasionally\. Let me know when
+you find a rough edge, and I\'ll sand it down for you\.
.
.P
I appreciate your sense of adventure\.
.
.SH "PRINCIPLES"
-Put the files where they need to be so that node can find them using the methods it already uses\.
+Put the files where they need to be so that node can find them using the
+methods it already uses\.
.
.P
Be lazy, not clever\.
@@ -42,47 +43,49 @@ The file system is the database\.
Sync with habits that are already in use\.
.
.P
-Packages should be maintained by their authors, not by the package manager author\.
+Packages should be maintained by their authors, not by the package manager
+author\.
.
.P
Steer clear of dependency hell\.
.
.SH "BUGS"
-Plenty\. Luckily, npm is actively maintained as of this writing\.
+Plenty\. Luckily, npm is actively maintained as of this writing\.
.
.P
When you find issues, please report them:
.
-.TP
-web
-\fIhttp://github\.com/isaacs/npm/issues\fR
+.IP "\(bu" 4
+web: \fIhttp://github\.com/isaacs/npm/issues\fR
+.
+.IP "\(bu" 4
+email: \fInpm\-@googlegroups\.com\fR
.
-.TP
-email
-\fInpm\-@googlegroups\.com\fR
+.IP "" 0
.
.P
-Be sure to include \fIall\fR of the output from the npm command that didn\'t work as expected\.
+Be sure to include \fIall\fR of the output from the npm command that didn\'t work
+as expected\.
.
.SH "HISTORY"
.
-.TP
-0\.0\.1
-Lots of sketches and false starts\. Abandoned a few times\.
+.IP "\(bu" 4
+0\.0\.1:
+Lots of sketches and false starts\. Abandoned a few times\.
.
-.TP
-0\.0\.2
-Install worked mostly\. Still promise\-based\.
+.IP "\(bu" 4
+0\.0\.2:
+Install worked mostly\. Still promise\-based\.
.
-.TP
-0\.0\.3
+.IP "\(bu" 4
+0\.0\.3:
Converted to callbacks\.
.
.br
Mikeal Rogers wrote a registry for it\.
.
-.TP
-0\.0\.4
+.IP "\(bu" 4
+0\.0\.4:
version dependencies
.
.br
@@ -100,8 +103,8 @@ bin linking
.br
uninstallation
.
-.TP
-0\.0\.5
+.IP "\(bu" 4
+0\.0\.5:
fix a few bugs in uninstall wrt dependent packages
.
.br
@@ -116,8 +119,8 @@ update to work with node 0\.1\.33 (aka net2)
.br
added publish and tag commands
.
-.TP
-0\.0\.6
+.IP "\(bu" 4
+0\.0\.6:
set up a public registry
.
.br
@@ -135,8 +138,8 @@ env\-specific package\.json
.br
added more info to npm\'s the package\.json (bugs, contributors, etc\.)
.
-.TP
-0\.0\.7
+.IP "\(bu" 4
+0\.0\.7:
fixed a few bugs in semver
.
.br
@@ -154,8 +157,8 @@ everything else core
.br
push to beta
.
-.TP
-0\.1\.0 \- 0\.1\.2
+.IP "\(bu" 4
+0\.1\.0 \- 0\.1\.2:
push to beta, and announce
.
.br
@@ -173,8 +176,8 @@ Fixed DOA bugs
.br
Removed dependence on ronn
.
-.TP
-0\.1\.3
+.IP "\(bu" 4
+0\.1\.3:
Changed a few details with configs (fix #5)
.
.br
@@ -183,12 +186,12 @@ Update adduser and publish to put author info in the data
.br
Use buffer api for file writes, hopefully fix #4
.
-.TP
-0\.1\.4 \- 0\.1\.5
+.IP "\(bu" 4
+0\.1\.4 \- 0\.1\.5:
Fixes for a few more bugs and fix some documentation\.
.
-.TP
-0\.1\.6 \- 0\.1\.7
+.IP "\(bu" 4
+0\.1\.6 \- 0\.1\.7:
Add cache functionality
.
.br
@@ -203,22 +206,22 @@ Don\'t break on install if the man path is missing
.br
Support publishing or installing a folder or local tarball
.
-.TP
-0\.1\.8
+.IP "\(bu" 4
+0\.1\.8:
Bugfixes
.
.br
Add start, stop, restart, and test commands
.
-.TP
-0\.1\.9
+.IP "\(bu" 4
+0\.1\.9:
npm list enhancements
.
.br
fix the install bug
.
-.TP
-0\.1\.10
+.IP "\(bu" 4
+0\.1\.10:
More errors found by Ryan Dahl and Kris Zyp
.
.br
@@ -230,74 +233,71 @@ Docs for new developers\.
.br
Better tracking of ownership on the registry\.
.
-.TP
-0\.1\.11
-Martyn Smith found a whole lot of bugs\.
+.IP "\(bu" 4
+0\.1\.11:
+ Martyn Smith found a whole lot of bugs\.
.
.br
-Make publish not die when the tarball is big\.
+ Make publish not die when the tarball is big\.
.
.br
-"make uninstall" support
+ "make uninstall" support
.
-.TP
-0\.1\.12 \- 0\.1\.13
-Fix the downloading bug that was breaking the tarballs
+.IP "\(bu" 4
+0\.1\.12 \- 0\.1\.13:
+ Fix the downloading bug that was breaking the tarballs
.
.br
-Update some docs
+ Update some docs
.
-.TP
-0\.1\.14 \- 0\.1\.16
-Fix to stay in sync with node changes
+.IP "\(bu" 4
+0\.1\.14 \- 0\.1\.16:
+ Fix to stay in sync with node changes
.
.br
-Put a special tag on link installs
+ Put a special tag on link installs
.
.br
-Modify semver comparison slightly
+ Modify semver comparison slightly
.
.br
-add unpublish command
+ add unpublish command
.
.br
-Use the "drain" event properly for uploads
+ Use the "drain" event properly for uploads
.
.br
-Handle thrown errors
+ Handle thrown errors
.
.br
-Handle \.npmignore
+ Handle \.npmignore
.
-.TP
-0\.1\.17
+.IP "\(bu" 4
+0\.1\.17:
Stabilization\.
.
-.TP
-0\.1\.18
+.IP "\(bu" 4
+0\.1\.18:
Change a few default configurations
.
.br
Add test harness
.
.br
-Default publish, install, and link to "\." if no arguments given
+Default publish, install, and link to "\." if no arguments given
.
-.br
-
-.
-.TP
-0\.1\.19 \- 0\.1\.20
+.IP "\(bu" 4
+0\.1\.19 \- 0\.1\.20:
Create a bunch of bugs
.
.br
Fix a bunch of bugs
.
.br
-Some minor speed improvements
+Some minor speed improvements
.
-.TP
-0\.1\.21 \- 0\.1\.22
+.IP "\(bu" 4
+0\.1\.21 \- 0\.1\.22:
Relative paths
.
.br
@@ -321,8 +321,8 @@ Support for http proxies
.br
Documentation updates
.
-.TP
-0\.1\.23
+.IP "\(bu" 4
+0\.1\.23:
update command \- This is huge\.
.
.br
@@ -340,16 +340,15 @@ Cascading configs: cli, env, user, global
.br
First pass at \fBnpm view\fR command
.
-.TP
-0\.1\.24
+.IP "\(bu" 4
+0\.1\.24:
Fix a bunch of things
.
.br
Cleanup, etc\.
.
.br
-help via \-\-help, \-h, or \-?
+help via \-\-help, \-h, or \-?
.
-.br
-
+.IP "" 0
diff --git a/man/owner.1 b/man/owner.1
index 2e80c6d0d..550f715a7 100644
--- a/man/owner.1
+++ b/man/owner.1
@@ -1,15 +1,14 @@
-.\" generated with Ronn/v0.7.3
-.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.\" Generated with Ronnjs/v0.1
+.\" http://github.com/kapouer/ronnjs/
.
-.TH "NPM\-OWNER" "1" "July 2010" "" ""
+.TH "NPM\-OWNER" "1" "August 2010" "" ""
.
.SH "NAME"
-\fBnpm\-owner\fR \- Manage package owners
+\fBnpm-owner\fR \-\- Manage package owners
.
.SH "SYNOPSIS"
.
.nf
-
npm owner ls <pkg>
npm owner add <user> <pkg>
npm owner rm <user> <pkg>
@@ -18,17 +17,24 @@ npm owner rm <user> <pkg>
.
.SH "DESCRIPTION"
.
-.TP
-ls
-List all the users who have access to modify a package and push new versions\. Handy when you need to know who to bug for help\.
+.IP "\(bu" 4
+ls:
+List all the users who have access to modify a package and push new versions\.
+Handy when you need to know who to bug for help\.
.
-.TP
-add
-Add a new user as a maintainer of a package\. This user is enabled to modify metadata, publish new versions, and add other owners\.
+.IP "\(bu" 4
+add:
+Add a new user as a maintainer of a package\. This user is enabled to modify
+metadata, publish new versions, and add other owners\.
.
-.TP
-rm
-Remove a user from the package owner list\. This immediately revokes their privileges\.
+.IP "\(bu" 4
+rm:
+Remove a user from the package owner list\. This immediately revokes their
+privileges\.
+.
+.IP "" 0
.
.P
-Note that there is only one level of access\. Either you can modify a package, or you can\'t\. Future versions may contain more fine\-grained access levels, but that is not implemented at this time\.
+Note that there is only one level of access\. Either you can modify a package,
+or you can\'t\. Future versions may contain more fine\-grained access levels, but
+that is not implemented at this time\.
diff --git a/man/publish.1 b/man/publish.1
index e0e29502b..59ae9c4d6 100644
--- a/man/publish.1
+++ b/man/publish.1
@@ -1,15 +1,14 @@
-.\" generated with Ronn/v0.7.3
-.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.\" Generated with Ronnjs/v0.1
+.\" http://github.com/kapouer/ronnjs/
.
-.TH "NPM\-PUBLISH" "1" "May 2010" "" ""
+.TH "NPM\-PUBLISH" "1" "August 2010" "" ""
.
.SH "NAME"
-\fBnpm\-publish\fR \- Publish a package
+\fBnpm-publish\fR \-\- Publish a package
.
.SH "SYNOPSIS"
.
.nf
-
npm publish <tarball>
npm publish <folder>
.
@@ -18,13 +17,17 @@ npm publish <folder>
.SH "DESCRIPTION"
Publishes a package to the registry so that it can be installed by name\.
.
-.TP
-\fB<folder>\fR
+.IP "\(bu" 4
+\fB<folder>\fR:
A folder containing a package\.json file
.
-.TP
-\fB<tarball>\fR
-A url or file path to a gzipped tar archive containing a single folder with a package\.json file inside\.
+.IP "\(bu" 4
+\fB<tarball>\fR:
+A url or file path to a gzipped tar archive containing a single folder
+with a package\.json file inside\.
+.
+.IP "" 0
.
.P
-Fails if the package name and version combination already exists in the registry\.
+Fails if the package name and version combination already exists in
+the registry\.
diff --git a/man/restart.1 b/man/restart.1
index 8b185ae86..1ecca09ec 100644
--- a/man/restart.1
+++ b/man/restart.1
@@ -1,21 +1,21 @@
-.\" generated with Ronn/v0.7.3
-.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.\" Generated with Ronnjs/v0.1
+.\" http://github.com/kapouer/ronnjs/
.
-.TH "NPM\-RESTART" "1" "May 2010" "" ""
+.TH "NPM\-RESTART" "1" "August 2010" "" ""
.
.SH "NAME"
-\fBnpm\-restart\fR \- Start a package
+\fBnpm-restart\fR \-\- Start a package
.
.SH "SYNOPSIS"
.
.nf
-
npm restart <name> [<version>]
.
.fi
.
.SH "DESCRIPTION"
-This runs a package\'s "stop" script, if one was provided, and then the "start" script\.
+This runs a package\'s "stop" script, if one was provided, and then
+the "start" script\.
.
.P
If no version is specified, then it restarts the "active" version\.
@@ -26,7 +26,6 @@ This is identical to doing:
.IP "" 4
.
.nf
-
npm stop <name>
npm start <name>
.
diff --git a/man/rm.1 b/man/rm.1
index 9080b0cfb..07eadc74b 100644
--- a/man/rm.1
+++ b/man/rm.1
@@ -1,22 +1,39 @@
-.\" generated with Ronn/v0.7.3
-.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.\" Generated with Ronnjs/v0.1
+.\" http://github.com/kapouer/ronnjs/
.
-.TH "NPM\-UNINSTALL" "1" "May 2010" "" ""
+.TH "NPM\-UNINSTALL" "1" "August 2010" "" ""
.
.SH "NAME"
-\fBnpm\-uninstall\fR \- Remove a package
+\fBnpm-uninstall\fR \-\- Remove a package
.
.SH "SYNOPSIS"
.
.nf
-
-npm uninstall <name> [<version>]
-npm rm <name> [<version>]
+npm uninstall <name>[@<version> [<name>[@<version>] \.\.\.]
+npm rm <name>[@<version> [<name>[@<version>] \.\.\.]
.
.fi
.
.SH "DESCRIPTION"
-This uninstalls a package, completely removing everything installed for it\. If it\'s currently active, then it will be deactivated first, unless the \fBauto\-deactivate\fR config setting is set to "false"\. If anything is depending on it, then those must be uninstalled first\.
+This uninstalls a package, completely removing everything installed for it\. If
+it\'s currently active, then it will be deactivated first, unless the \fBauto\-deactivate\fR config setting is set to "false"\. If anything is
+depending on it, then those must be uninstalled first\.
.
.P
If the version is omitted, then all versions of a package are removed\.
+.
+.P
+\fB<version>\fR may in fact be a version range, so these commands are
+acceptable:
+.
+.IP "" 4
+.
+.nf
+npm rm foo@\'1\.2\.3 \- 4\.8\.9\'
+npm rm foo@\'>=1\.0\.0\'
+npm rm foo@\'<2\.0\.3\'
+.
+.fi
+.
+.IP "" 0
+
diff --git a/man/scripts.1 b/man/scripts.1
index 321eb2a93..1966c9b28 100644
--- a/man/scripts.1
+++ b/man/scripts.1
@@ -1,84 +1,96 @@
-.\" generated with Ronn/v0.7.3
-.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.\" Generated with Ronnjs/v0.1
+.\" http://github.com/kapouer/ronnjs/
.
.TH "NPM\-SCRIPTS" "1" "August 2010" "" ""
.
.SH "NAME"
-\fBnpm\-scripts\fR \- How npm handles the "scripts" field
+\fBnpm-scripts\fR \-\- How npm handles the "scripts" field
.
.SH "DESCRIPTION"
-npm supports the "scripts" member of the package\.json script, for the following scripts:
+npm supports the "scripts" member of the package\.json script, for the
+following scripts:
.
-.TP
-preinstall
+.IP "\(bu" 4
+preinstall:
Run BEFORE the package is installed
.
-.TP
-install, postinstall
+.IP "\(bu" 4
+install, postinstall:
Run AFTER the package is installed\.
.
-.TP
-preactivate
+.IP "\(bu" 4
+preactivate:
Run BEFORE the package is activated\.
.
-.TP
-activate, postactivate
+.IP "\(bu" 4
+activate, postactivate:
Run AFTER the package has been activated\.
.
-.TP
-predeactivate, deactivate
+.IP "\(bu" 4
+predeactivate, deactivate:
Run BEFORE the package is deactivated\.
.
-.TP
-postdeactivate
+.IP "\(bu" 4
+postdeactivate:
Run AFTER the package is deactivated\.
.
-.TP
-preuninstall, uninstall
+.IP "\(bu" 4
+preuninstall, uninstall:
Run BEFORE the package is uninstalled\.
.
-.TP
-postuninstall
+.IP "\(bu" 4
+postuninstall:
Run AFTER the package is uninstalled\.
.
-.TP
-preupdate
+.IP "\(bu" 4
+preupdate:
Run BEFORE the package is updated with the update command\.
.
-.TP
-update, postupdate
+.IP "\(bu" 4
+update, postupdate:
Run AFTER the package is updated with the update command\.
.
-.TP
-preupdatedependencies
+.IP "\(bu" 4
+preupdatedependencies:
Run BEFORE the package dependencies are pointed to the new version\.
.
-.TP
-updatedependencies, postupdatedependencies
+.IP "\(bu" 4
+updatedependencies, postupdatedependencies:
Run AFTER the package dependencies are pointed to the new version\.
.
+.IP "" 0
+.
.SH "ENVIRONMENT"
Package scripts run in an environment where many pieces of information are made available regarding the setup of npm and the current state of the process\.
.
-.TP
-package\.json vars
-The package\.json fields are tacked onto the \fBnpm_package_\fR prefix\. So, for instance, if you had \fB{"name":"foo", "version":"1\.2\.5"}\fR in your package\.json file, then your package scripts would have the \fBnpm_package_name\fR environment variable set to "foo", and the \fBnpm_package_version\fR set to "1\.2\.5"
+.IP "\(bu" 4
+package\.json vars:
+The package\.json fields are tacked onto the \fBnpm_package_\fR prefix\. So, for
+instance, if you had \fB{"name":"foo", "version":"1\.2\.5"}\fR in your package\.json
+file, then your package scripts would have the \fBnpm_package_name\fR environment
+variable set to "foo", and the \fBnpm_package_version\fR set to "1\.2\.5"
+.
+.IP "\(bu" 4
+configuration vars:
+Configuration parameters are put in the environment with the \fBnpm_config_\fR
+prefix\. For instance, you can view the effective \fBroot\fR config by checking the \fBnpm_config_root\fR environment variable\.
+.
+.IP "\(bu" 4
+current lifecycle event:
+Lastly, the \fBnpm_lifecycle_event\fR environment variable is set to whichever
+stage of the cycle is being executed\. So, you could have a single script used
+for different parts of the process which switches based on what\'s currently
+happening\.
.
-.TP
-configuration vars
-Configuration parameters are put in the environment with the \fBnpm_config_\fR prefix\. For instance, you can view the effective \fBroot\fR config by checking the \fBnpm_config_root\fR environment variable\.
-.
-.TP
-current lifecycle event
-Lastly, the \fBnpm_lifecycle_event\fR environment variable is set to whichever stage of the cycle is being executed\. So, you could have a single script used for different parts of the process which switches based on what\'s currently happening\.
+.IP "" 0
.
.P
-Objects are flattened following this format, so if you had \fB{"scripts":{"install":"foo\.js"}}\fR in your package\.json, then you\'d see this in the script:
+Objects are flattened following this format, so if you had \fB{"scripts":{"install":"foo\.js"}}\fR in your package\.json, then you\'d see this
+in the script:
.
.IP "" 4
.
.nf
-
process\.env\.npm_package_scripts_install === "foo\.js"
.
.fi
@@ -91,7 +103,6 @@ For example, if your package\.json contains this:
.IP "" 4
.
.nf
-
{ "scripts" :
{ "install" : "scripts/install\.js"
, "postinstall" : "scripts/install\.js"
@@ -105,15 +116,17 @@ For example, if your package\.json contains this:
.IP "" 0
.
.P
-then the \fBscripts/install\.js\fR will be called for the install, post\-install, and activate stages of the lifecycle, and the \fBscripts/uninstall\.js\fR would be called when the package is uninstalled\. Since \fBscripts/install\.js\fR is running for three different phases, it would be wise in this case to look at the \fBnpm_lifecycle_event\fR environment variable\.
+then the \fBscripts/install\.js\fR will be called for the install, post\-install,
+and activate stages of the lifecycle, and the \fBscripts/uninstall\.js\fR would be
+called when the package is uninstalled\. Since \fBscripts/install\.js\fR is running
+for three different phases, it would be wise in this case to look at the \fBnpm_lifecycle_event\fR environment variable\.
.
.P
-If you want to run a make command, you can do so\. This works just fine:
+If you want to run a make command, you can do so\. This works just fine:
.
.IP "" 4
.
.nf
-
{ "scripts" :
{ "preinstall" : "\./configure"
, "install" : "make && make install"
@@ -126,10 +139,12 @@ If you want to run a make command, you can do so\. This works just fine:
.IP "" 0
.
.SH "EXITING"
-Scripts are run by passing the line as a script argument to \fBsh\fR\.
+Scripts are run by passing the line as a script argument to \fBsh\fR\|\.
.
.P
-If the script exits with a code other than 0, then this will abort the process\.
+If the script exits with a code other than 0, then this will abort the
+process\.
.
.P
-Note that these script files don\'t have to be nodejs or even javascript programs\. They just have to be some kind of executable file\.
+Note that these script files don\'t have to be nodejs or even javascript
+programs\. They just have to be some kind of executable file\.
diff --git a/man/start.1 b/man/start.1
index ad7487ba5..28794f9bb 100644
--- a/man/start.1
+++ b/man/start.1
@@ -1,15 +1,14 @@
-.\" generated with Ronn/v0.7.3
-.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.\" Generated with Ronnjs/v0.1
+.\" http://github.com/kapouer/ronnjs/
.
-.TH "NPM\-START" "1" "May 2010" "" ""
+.TH "NPM\-START" "1" "August 2010" "" ""
.
.SH "NAME"
-\fBnpm\-start\fR \- Start a package
+\fBnpm-start\fR \-\- Start a package
.
.SH "SYNOPSIS"
.
.nf
-
npm start <name> [<version>]
.
.fi
diff --git a/man/stop.1 b/man/stop.1
index 652908d02..257e5f3ad 100644
--- a/man/stop.1
+++ b/man/stop.1
@@ -1,15 +1,14 @@
-.\" generated with Ronn/v0.7.3
-.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.\" Generated with Ronnjs/v0.1
+.\" http://github.com/kapouer/ronnjs/
.
-.TH "NPM\-STOP" "1" "May 2010" "" ""
+.TH "NPM\-STOP" "1" "August 2010" "" ""
.
.SH "NAME"
-\fBnpm\-stop\fR \- Stop a package
+\fBnpm-stop\fR \-\- Stop a package
.
.SH "SYNOPSIS"
.
.nf
-
npm stop <name> [<version>]
.
.fi
diff --git a/man/tag.1 b/man/tag.1
index ba0bee2f4..8c3d4bce1 100644
--- a/man/tag.1
+++ b/man/tag.1
@@ -1,15 +1,14 @@
-.\" generated with Ronn/v0.7.3
-.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.\" Generated with Ronnjs/v0.1
+.\" http://github.com/kapouer/ronnjs/
.
-.TH "NPM\-TAG" "1" "July 2010" "" ""
+.TH "NPM\-TAG" "1" "August 2010" "" ""
.
.SH "NAME"
-\fBnpm\-tag\fR \- Tag a published version
+\fBnpm-tag\fR \-\- Tag a published version
.
.SH "SYNOPSIS"
.
.nf
-
npm tag packagename@1\.2\.3 tagname
.
.fi
@@ -18,4 +17,7 @@ npm tag packagename@1\.2\.3 tagname
Tags the specified version of "packagename" with the specified "tagname"\.
.
.P
-The only tags with special significance are "stable", which is the version that gets installed by default when no other tag or version number is specified, and "latest", which always points to the most recently uploaded version of a package\.
+The only tags with special significance are "stable", which is the version
+that gets installed by default when no other tag or version number is
+specified, and "latest", which always points to the most recently uploaded
+version of a package\.
diff --git a/man/test.1 b/man/test.1
index 6dccab4b8..7606c76ca 100644
--- a/man/test.1
+++ b/man/test.1
@@ -1,15 +1,14 @@
-.\" generated with Ronn/v0.7.3
-.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.\" Generated with Ronnjs/v0.1
+.\" http://github.com/kapouer/ronnjs/
.
-.TH "NPM\-TEST" "1" "May 2010" "" ""
+.TH "NPM\-TEST" "1" "August 2010" "" ""
.
.SH "NAME"
-\fBnpm\-test\fR \- Test a package
+\fBnpm-test\fR \-\- Test a package
.
.SH "SYNOPSIS"
.
.nf
-
npm test <name> [<version>]
.
.fi
diff --git a/man/uninstall.1 b/man/uninstall.1
index 9080b0cfb..07eadc74b 100644
--- a/man/uninstall.1
+++ b/man/uninstall.1
@@ -1,22 +1,39 @@
-.\" generated with Ronn/v0.7.3
-.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.\" Generated with Ronnjs/v0.1
+.\" http://github.com/kapouer/ronnjs/
.
-.TH "NPM\-UNINSTALL" "1" "May 2010" "" ""
+.TH "NPM\-UNINSTALL" "1" "August 2010" "" ""
.
.SH "NAME"
-\fBnpm\-uninstall\fR \- Remove a package
+\fBnpm-uninstall\fR \-\- Remove a package
.
.SH "SYNOPSIS"
.
.nf
-
-npm uninstall <name> [<version>]
-npm rm <name> [<version>]
+npm uninstall <name>[@<version> [<name>[@<version>] \.\.\.]
+npm rm <name>[@<version> [<name>[@<version>] \.\.\.]
.
.fi
.
.SH "DESCRIPTION"
-This uninstalls a package, completely removing everything installed for it\. If it\'s currently active, then it will be deactivated first, unless the \fBauto\-deactivate\fR config setting is set to "false"\. If anything is depending on it, then those must be uninstalled first\.
+This uninstalls a package, completely removing everything installed for it\. If
+it\'s currently active, then it will be deactivated first, unless the \fBauto\-deactivate\fR config setting is set to "false"\. If anything is
+depending on it, then those must be uninstalled first\.
.
.P
If the version is omitted, then all versions of a package are removed\.
+.
+.P
+\fB<version>\fR may in fact be a version range, so these commands are
+acceptable:
+.
+.IP "" 4
+.
+.nf
+npm rm foo@\'1\.2\.3 \- 4\.8\.9\'
+npm rm foo@\'>=1\.0\.0\'
+npm rm foo@\'<2\.0\.3\'
+.
+.fi
+.
+.IP "" 0
+
diff --git a/man/unpublish.1 b/man/unpublish.1
index f2a3f4203..06d12f55f 100644
--- a/man/unpublish.1
+++ b/man/unpublish.1
@@ -1,18 +1,18 @@
-.\" generated with Ronn/v0.7.3
-.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.\" Generated with Ronnjs/v0.1
+.\" http://github.com/kapouer/ronnjs/
.
-.TH "NPM\-UNPUBLISH" "1" "July 2010" "" ""
+.TH "NPM\-UNPUBLISH" "1" "August 2010" "" ""
.
.SH "NAME"
-\fBnpm\-unpublish\fR \- Remove a package from the registry
+\fBnpm-unpublish\fR \-\- Remove a package from the registry
.
.SH "SYNOPSIS"
.
.nf
-
npm unpublish <name>@<version>
.
.fi
.
.SH "DESCRIPTION"
-This removes a package version from the registry, deleting its entry and removing the tarball\.
+This removes a package version from the registry, deleting its
+entry and removing the tarball\.
diff --git a/man/update.1 b/man/update.1
index 80adf2f2a..4cf0f8d19 100644
--- a/man/update.1
+++ b/man/update.1
@@ -1,27 +1,33 @@
-.\" generated with Ronn/v0.7.3
-.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.\" Generated with Ronnjs/v0.1
+.\" http://github.com/kapouer/ronnjs/
.
.TH "NPM\-UPDATE" "1" "August 2010" "" ""
.
.SH "NAME"
-\fBnpm\-update\fR \- Update a package
+\fBnpm-update\fR \-\- Update a package
.
.SH "SYNOPSIS"
.
.nf
-
npm update [<pkg> [<pkg> \.\.\.]]
.
.fi
.
.SH "DESCRIPTION"
-This command will update all the packages listed to the latest version (specified by the \fBtag\fR config), as well as updating any dependent packages to use the new version, if possible\.
+This command will update all the packages listed to the latest version
+(specified by the \fBtag\fR config), as well as updating any dependent
+packages to use the new version, if possible\.
.
.P
-Additionally, it will activate the new version, and delete any old versions, if safe to do so
+Additionally, it will activate the new version, and delete any old versions, if
+safe to do so
.
.P
-If the \fBupdate\-dependents\fR configuration parameter is set to \fB"true"\fR, then packages will always be updated when they are installed, if they are the newest version\.
+If the \fBupdate\-dependents\fR configuration parameter is set to \fB"true"\fR, then
+packages will always be updated when they are installed, if they are the newest
+version\.
.
.P
-If the \fBupdate\-dependents\fR configuration parameter is set to \fB"always"\fR, then packages will be updated when they are installed, even if to do so would be a downgrade\.
+If the \fBupdate\-dependents\fR configuration parameter is set to \fB"always"\fR, then
+packages will be updated when they are installed, even if to do so would be a
+downgrade\.
diff --git a/man/view.1 b/man/view.1
index 9b91860bd..5d1fd4199 100644
--- a/man/view.1
+++ b/man/view.1
@@ -1,21 +1,22 @@
-.\" generated with Ronn/v0.7.3
-.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.\" Generated with Ronnjs/v0.1
+.\" http://github.com/kapouer/ronnjs/
.
.TH "NPM\-VIEW" "1" "August 2010" "" ""
.
.SH "NAME"
-\fBnpm\-view\fR \- View registry info
+\fBnpm-view\fR \-\- View registry info
.
.SH "SYNOPSIS"
.
.nf
-
npm view [<pkg> [<pkg> \.\.\.]]
.
.fi
.
.SH "DESCRIPTION"
-This command just spits out the data that is on the npm registry for a given package or packages\.
+This command just spits out the data that is on the npm registry for a given
+package or packages\.
.
.P
-You could also go to the registry url directly in your web browser to see the same information\.
+You could also go to the registry url directly in your web browser to see the
+same information\.