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-07-05 00:29:03 +0400
committerisaacs <i@izs.me>2010-07-25 05:51:07 +0400
commite937a72f38f359a47977d7e9ade1a2e3bf75fa4a (patch)
tree09b75265e56543ce10f5e371022f13e5becd6c7b /man
parentc4aea02bfa76b6cb5ac9afd0ecea08b4ff017cd2 (diff)
Update all man pages using new version of ronn
Diffstat (limited to 'man')
-rw-r--r--man/activate.19
-rw-r--r--man/adduser.130
-rw-r--r--man/build.117
-rw-r--r--man/cache.142
-rw-r--r--man/coding-style.186
-rw-r--r--man/config.171
-rw-r--r--man/deactivate.110
-rw-r--r--man/developers.1119
-rw-r--r--man/folders.131
-rw-r--r--man/help.113
-rw-r--r--man/install.162
-rw-r--r--man/link.114
-rw-r--r--man/ln.114
-rw-r--r--man/publish.117
-rw-r--r--man/registry.124
-rw-r--r--man/restart.114
-rw-r--r--man/rm.113
-rw-r--r--man/scripts.176
-rw-r--r--man/start.111
-rw-r--r--man/stop.111
-rw-r--r--man/tag.116
-rw-r--r--man/test.111
-rw-r--r--man/uninstall.113
-rw-r--r--man/unpublish.110
24 files changed, 325 insertions, 409 deletions
diff --git a/man/activate.1 b/man/activate.1
index b4f418812..f863d6444 100644
--- a/man/activate.1
+++ b/man/activate.1
@@ -1,20 +1,21 @@
-.\" generated with Ronn/v0.4.1
-.\" http://github.com/rtomayko/ronn/
+.\" 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
+\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.
+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)
diff --git a/man/adduser.1 b/man/adduser.1
index ee98d8362..6d045c4f0 100644
--- a/man/adduser.1
+++ b/man/adduser.1
@@ -1,46 +1,40 @@
-.\" generated with Ronn/v0.4.1
-.\" http://github.com/rtomayko/ronn/
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
-.TH "NPM\-ADDUSER" "1" "May 2010" "" ""
+.TH "NPM\-ADDUSER" "1" "July 2010" "" ""
.
.SH "NAME"
-\fBnpm\-adduser\fR \-\- Add a registry user account
+\fBnpm\-adduser\fR \- Add a registry user account
.
.SH "SYNOPSIS"
.
.nf
+
npm adduser <username> <password> <email>
.
.fi
.
.SH "DESCRIPTION"
-Create a user named \fB<username>\fR in the npm registry, and save the
-credentials to the \fB.npmrc\fR file. Note that this leaves the password
-in your \fB.bash_history\fR, and it is currently stored in the clear in
-the config file. So, don't use a password you care too much about.
+Create a user named \fB<username>\fR in the npm registry, and save the credentials to the \fB\.npmrc\fR file\. Note that this leaves the password in your \fB\.bash_history\fR, and it is currently stored in the clear in the config file\. So, don\'t use a password you care too much about\.
.
.P
-For now, if you somehow break your \fB.npmrc\fR file, and have forgotten your
-password, you're boned. Send an email to i@izs.me and I'll delete the
-record from the registry so that you can re\-add it.
+For now, if you somehow break your \fB\.npmrc\fR file, and have forgotten your password, you\'re boned\. Send an email to i@izs\.me and I\'ll delete the record from the registry so that you can re\-add it\.
.
.P
-If you break your \fB.npmrc\fR file, but you remember your password, you
-can put your user auth back by using the \fBbase64\fR program like so:
+If you break your \fB\.npmrc\fR file, but you remember your password, you can put your user auth back by using the \fBbase64\fR program like so:
.
.IP "" 4
.
.nf
-npm config set auth $( echo user:pass | base64 )
+
+npm config set auth $( echo \-n user:pass | base64 )
.
.fi
.
.IP "" 0
.
.P
-Install base64 using whichever method you normally use to put programs on
-your computer. (apt\-get, homebrew, macports, yum, or just download the
-code and build it yourself.)
+Install base64 using whichever method you normally use to put programs on your computer\. (apt\-get, homebrew, macports, yum, or just download the code and build it yourself\.)
.
.P
-Or bug me to to remove your account, and then recreate it.
+Or bug me to to remove your account, and then recreate it\.
diff --git a/man/build.1 b/man/build.1
index 47bd77542..cc8e1df5b 100644
--- a/man/build.1
+++ b/man/build.1
@@ -1,30 +1,28 @@
-.\" generated with Ronn/v0.4.1
-.\" http://github.com/rtomayko/ronn/
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "NPM\-BUILD" "1" "May 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
-A folder containing a \fBpackage.json\fR file in its root.
+A folder containing a \fBpackage\.json\fR file in its root\.
.
.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"
.
@@ -41,3 +39,4 @@ npm\-scripts(1)
npm\-json(1)
.
.IP "" 0
+
diff --git a/man/cache.1 b/man/cache.1
index 8623eb072..5f2c49fa9 100644
--- a/man/cache.1
+++ b/man/cache.1
@@ -1,19 +1,22 @@
-.\" generated with Ronn/v0.4.1
-.\" http://github.com/rtomayko/ronn/
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "NPM\-CACHE" "1" "May 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
@@ -22,45 +25,36 @@ npm cache clean [<pkg> [<version>]]
.
.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.
+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.
+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.
+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.
+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.
+This can be used if invalid data gets into the cache\.
.
.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/
-A folder containing the package contents as they appear in the tarball.
+A folder containing the package contents as they appear in the tarball\.
.
.TP
-package.json
-The package.json file, as npm sees it, with overlays applied and a _id attribute.
+package\.json
+The package\.json file, as npm sees it, with overlays applied and a _id attribute\.
.
.TP
-package.tgz
-The tarball for that version.
+package\.tgz
+The tarball for that version\.
.
.SH "HISTORY"
-Added in npm version 0.1.6
+Added in npm version 0\.1\.6
diff --git a/man/coding-style.1 b/man/coding-style.1
index a2116b248..19a72dda9 100644
--- a/man/coding-style.1
+++ b/man/coding-style.1
@@ -1,34 +1,28 @@
-.\" generated with Ronn/v0.4.1
-.\" http://github.com/rtomayko/ronn/
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "NPM\-CODING\-STYLE" "1" "May 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.
+Configure your editor appropriately\.
.
.SH "Curly braces"
-Curly braces belong on the same line as the thing that necessitates them.
+Curly braces belong on the same line as the thing that necessitates them\.
.
.P
Bad:
@@ -36,6 +30,7 @@ Bad:
.IP "" 4
.
.nf
+
function ()
{
.
@@ -49,6 +44,7 @@ Good:
.IP "" 4
.
.nf
+
function () {
.
.fi
@@ -56,8 +52,7 @@ 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:
@@ -65,6 +60,7 @@ Bad:
.IP "" 4
.
.nf
+
if (foo) { bar() }
while (foo)
bar()
@@ -79,6 +75,7 @@ Good:
.IP "" 4
.
.nf
+
if (foo) bar()
while (foo) {
bar()
@@ -89,18 +86,16 @@ while (foo) {
.IP "" 0
.
.SH "Semicolons"
-Don't use them except in three situations:
+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
.
@@ -110,8 +105,9 @@ Some examples of good semicolon usage:
.IP "" 4
.
.nf
-;(x || y).doSomething()
-;[a, b, c].forEach(doSomething)
+
+;(x || y)\.doSomething()
+;[a, b, c]\.forEach(doSomething)
for (var i = 0; i < 10; i ++) {
switch (state) {
case "begin": start(); continue
@@ -126,14 +122,12 @@ for (var i = 0; i < 10; i ++) {
.IP "" 0
.
.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"
@@ -151,50 +145,41 @@ 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)
+ if (er) return log\.er(cb, "Couldn\'t get data")(er)
doSomethingElse(data, cb)
})
}
function justHasToWork (cb) {
- doSomething(log.er(cb, "the doSomething failed."))
+ doSomething(log\.er(cb, "the doSomething failed\."))
}
.
.fi
@@ -202,7 +187,4 @@ 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 eb1ef37c8..e0fc6df4d 100644
--- a/man/config.1
+++ b/man/config.1
@@ -1,14 +1,15 @@
-.\" generated with Ronn/v0.4.1
-.\" http://github.com/rtomayko/ronn/
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "NPM\-CONFIG" "1" "May 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>
npm config get <key>
npm config delete <key>
@@ -17,14 +18,10 @@ npm config list
.fi
.
.SH "DESCRIPTION"
-The config command is a way to interact with the \fB.npmrc\fR file. This file is a
-JSON encoded list of values that npm is concerned with. The first time you run
-npm, it will create a conf file filled with default values.
+The config command is a way to interact with the \fB\.npmrc\fR file\. This file is a JSON encoded list of values that npm is concerned with\. The first time you run npm, it will create a conf file filled with default values\.
.
.P
-On exit, the current state of the config is always saved, so that any changes
-will be recorded. You may safely modify the file (as long as it's still
-parseable JSON), but it is safer to use the npm config commands.
+On exit, the current state of the config is always saved, so that any changes will be recorded\. You may safely modify the file (as long as it\'s still parseable JSON), but it is safer to use the npm config commands\.
.
.SH "Sub\-commands"
Config supports the following sub\-commands:
@@ -32,57 +29,57 @@ Config supports the following sub\-commands:
.SS "set"
.
.nf
+
npm config set key value
.
.fi
.
.P
-Sets the config key to the value.
+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
.
.P
-Show all the config settings.
+Show all the config settings\.
.
.P
-\fBFIXME\fR: Prints to stderr, but should really be stdout, since the log is what
-you're after.
+\fBFIXME\fR: Prints to stderr, but should really be stdout, since the log is what you\'re after\.
.
.SS "delete"
.
.nf
+
npm config delete key
.
.fi
.
.P
-Deletes the key from the configuration file.
+Deletes the key from the configuration file\.
.
.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
@@ -90,36 +87,34 @@ npm \-\-key val <command>
.IP "" 0
.
.P
-Configurations defined on the command line are not saved to the .npmrc file.
+Configurations defined on the command line are not saved to the \.npmrc file\.
.
.SS "auto\-activate"
Default: true
.
.P
-Automatically activate a package after installation, if there is not an active
-version already. Set to "always" to always activate when installing.
+Automatically activate a package after installation, if there is not an active version already\. Set to "always" to always activate when installing\.
.
.SS "root"
-Default: ~/.node_libraries in single\-user mode, or \fB$INSTALL_PREFIX/lib/node\fR
-in sudo\-mode.
+Default: ~/\.node_libraries in single\-user mode, or \fB$INSTALL_PREFIX/lib/node\fR in sudo\-mode\.
.
.P
-The root folder where packages are installed and npm keeps its data.
+The root folder where packages are installed and npm keeps its data\.
.
.SS "binroot"
Default: \fB$INSTALL_PREFIX/bin\fR
.
.P
-The folder where executable programs are installed.
+The folder where executable programs are installed\.
.
.SS "registry"
-Default: https://registry.npmjs.org/
+Default: https://registry\.npmjs\.org/
.
.P
-The base URL of the npm package registry.
+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:
@@ -127,30 +122,26 @@ If your config file is ever corrupted, you can set this manually by doing:
.IP "" 4
.
.nf
+
npm config set auth $(echo \-n "my\-user\-name:my\-password" | base64)
npm config set username my\-user\-name
- npm config set email me@email.com
+ npm config set email me@email\.com
.
.fi
.
.IP "" 0
.
.P
-\fBNOTE\fR: This is not encoded in any kind of security sense. It's just base\-64
-encoded strictly so that it can be sent along the wire with HTTP Basic
-authentication.
+\fBNOTE\fR: This is not encoded in any kind of security sense\. It\'s just base\-64 encoded strictly so that it can be sent along the wire with HTTP Basic authentication\.
.
.SS "authCrypt"
-If crypto.Cipher is available, and you have some private keys in \fB$HOME/.ssh\fR,
-then npm will encrypt your "auth" config before saving to the .npmrc file,
-and will decrypt the "authCrypt" 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 "auth" config before saving to the \.npmrc file, and will decrypt the "authCrypt" config when it reads the \.npmrc file\.
.
.SS "tag"
Default: stable
.
.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.
+Note: this has no effect on the npm\-tag(1) command\.
diff --git a/man/deactivate.1 b/man/deactivate.1
index 2ca478d63..5a8360c54 100644
--- a/man/deactivate.1
+++ b/man/deactivate.1
@@ -1,21 +1,21 @@
-.\" generated with Ronn/v0.4.1
-.\" http://github.com/rtomayko/ronn/
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "NPM\-DEACTIVATE" "1" "May 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 198792142..cc903fa33 100644
--- a/man/developers.1
+++ b/man/developers.1
@@ -1,84 +1,67 @@
-.\" generated with Ronn/v0.4.1
-.\" http://github.com/rtomayko/ronn/
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "NPM\-DEVELOPERS" "1" "May 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.
+So, you\'ve decided to use npm to publish your project\.
.
.P
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.
+.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.
+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.
+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.
+So, \fBnode\-foo\fR and \fBbar\-js\fR are bad names\. \fBfoo\fR or \fBbar\fR are better\.
.
.TP
version
-A semver\-compatible 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.
+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
-Take some credit.
+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).
+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.
+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\.
.
.SH "Make Sure Your Package Installs and Works"
-\fBThis is important.\fR
+\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:
@@ -86,53 +69,55 @@ In the root of your package, do this:
.IP "" 4
.
.nf
-npm install .
+
+npm install \.
.
.fi
.
.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 .
+
+npm link \.
.
.fi
.
.IP "" 0
.
.P
-Use \fBnpm ls @installed\fR to see if it's there.
+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
- bar.js
+ foo\.js
+ bar\.js
.
.fi
.
.IP "" 0
.
.P
-and you define your package.json with this in it:
+and you define your package\.json with this in it:
.
.IP "" 4
.
.nf
+
{ "name" : "foo"
-, "directories" : { "lib" : "./lib" }
-, "main" : "./lib/foo"
+, "directories" : { "lib" : "\./lib" }
+, "main" : "\./lib/foo"
}
.
.fi
@@ -140,17 +125,15 @@ 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
@@ -158,24 +141,25 @@ 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
+
+npm adduser bob password bob@email\.com
.
.fi
.
.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
@@ -183,11 +167,12 @@ man npm\-adduser
.IP "" 0
.
.SH "Publish your package"
-This part's easy.
+This part\'s easy\.
.
.IP "" 4
.
.nf
+
npm publish /path/to/my\-package
.
.fi
@@ -195,28 +180,26 @@ 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
+
+npm tag my\-package 1\.2\.3 stable
.
.fi
.
.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.
+Send emails, write blogs, blab in IRC\.
.
.P
Tell the world how easy it is to install your program!
diff --git a/man/folders.1 b/man/folders.1
index f5f61f93c..70a63f97b 100644
--- a/man/folders.1
+++ b/man/folders.1
@@ -1,40 +1,37 @@
-.\" generated with Ronn/v0.4.1
-.\" http://github.com/rtomayko/ronn/
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
-.TH "NPM\-FOLDERS" "1" "April 2010" "" ""
+.TH "NPM\-FOLDERS" "1" "May 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. This defaults to \fB$HOME/.node_libraries/\fR. I'd like to be able to override it, but that's not
-possible yet.
+Everything lives in the \fBroot\fR setting\. This defaults to \fB$HOME/\.node_libraries/\fR\. I\'d like to be able to override it, but that\'s not possible yet\.
.
.P
-\fBroot/.npm/foo\fR is where the stuff for package \fBfoo\fR would go.
+\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.
+\fBroot/\.npm/foo/1\.0\.0/main\.js\fR Generated file that exports the \fBmain\fR module in foo\.
.
.P
-\fBroot/.npm/foo/1.0.0/lib\fR symlink to the \fBlib\fR dir in foo.
+\fBroot/\.npm/foo/1\.0\.0/lib\fR symlink to the \fBlib\fR dir in foo\.
.
.P
-\fBroot/.npm/foo/active\fR symlink to the active version.
+\fBroot/\.npm/foo/active\fR symlink to the active version\.
.
.P
-\fBroot/foo\-1.0.0.js\fR symlink to \fB.npm/foo/1.0.0/main.js\fR
+\fBroot/foo\-1\.0\.0\.js\fR symlink to \fB\.npm/foo/1\.0\.0/main\.js\fR
.
.P
-\fBroot/foo.js\fR symlink to \fB.npm/foo/active/main.js\fR
+\fBroot/foo\.js\fR symlink to \fB\.npm/foo/active/main\.js\fR
.
.P
-\fBroot/foo\fR symlink to \fB.npm/foo/active/lib\fR
+\fBroot/foo\fR symlink to \fB\.npm/foo/active/lib\fR
.
.P
-\fBroot/foo\-1.0.0\fR symlink to \fB.npm/foo/1.0.0/lib\fR
+\fBroot/foo\-1\.0\.0\fR symlink to \fB\.npm/foo/1\.0\.0/lib\fR
diff --git a/man/help.1 b/man/help.1
index ab19a9a2c..4a5f4bb89 100644
--- a/man/help.1
+++ b/man/help.1
@@ -1,14 +1,15 @@
-.\" generated with Ronn/v0.4.1
-.\" http://github.com/rtomayko/ronn/
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "NPM\-HELP" "1" "May 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
@@ -17,8 +18,7 @@ npm help <section>
Where \fB<section>\fR is one of:
.
.br
-\fBactivate\fR, \fBadduser\fR, \fBbuild\fR, \fBconfig\fR, \fBdeactivate\fR, \fBfolders\fR, \fBhelp\fR
-(this page), \fBinstall\fR, \fBjson\fR, \fBlink\fR (or \fBln\fR), \fBlist\fR (or \fBls\fR), \fBnpm\fR, \fBpublish\fR, \fBregistry\fR, \fBscripts\fR, \fBtag\fR, \fBuninstall\fR (or \fBrm\fR), \fBdevelopers\fR, \fBcoding\-style\fR
+\fBactivate\fR, \fBadduser\fR, \fBbuild\fR, \fBconfig\fR, \fBdeactivate\fR, \fBfolders\fR, \fBhelp\fR (this page), \fBinstall\fR, \fBjson\fR, \fBlink\fR (or \fBln\fR), \fBlist\fR (or \fBls\fR), \fBnpm\fR, \fBpublish\fR, \fBregistry\fR, \fBscripts\fR, \fBtag\fR, \fBuninstall\fR (or \fBrm\fR), \fBdevelopers\fR, \fBcoding\-style\fR
.
.P
Note that you can get the exact same help content by doing:
@@ -26,6 +26,7 @@ Note that you can get the exact same help content by doing:
.IP "" 4
.
.nf
+
man npm\-<section>
.
.fi
@@ -33,4 +34,4 @@ man npm\-<section>
.IP "" 0
.
.SH "Todo"
-It'd be nice if this page was automatically generated.
+It\'d be nice if this page was automatically generated\.
diff --git a/man/install.1 b/man/install.1
index 71a279683..adf2d90ba 100644
--- a/man/install.1
+++ b/man/install.1
@@ -1,14 +1,15 @@
-.\" generated with Ronn/v0.4.1
-.\" http://github.com/rtomayko/ronn/
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "NPM\-INSTALL" "1" "May 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>
@@ -20,26 +21,23 @@ 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.
+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
- Example:
+Example:
.
.IP "" 4
.
.nf
- npm install ./package.tgz
+
+ npm install \./package\.tgz
.
.fi
.
@@ -47,84 +45,79 @@ must either be "." or contain a "/" in it.
.
.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://"
+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.
+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.
+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.
+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.
+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
- Example:
+Example:
.
.IP "" 4
.
.nf
- npm install sax@">=0.1.0 <0.2.0"
+
+ 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
+
+npm install sax@">=0\.1\.0 <0\.2\.0" bench supervisor
.
.fi
.
.IP "" 0
.
.P
-The \fB\-\-tag\fR argument will apply to all of the specified install targets.
+The \fB\-\-tag\fR argument will apply to all of the specified install targets\.
.
.SH "SEE ALSO"
.
@@ -147,3 +140,4 @@ npm\-folders(1)
npm\-tag(1)
.
.IP "" 0
+
diff --git a/man/link.1 b/man/link.1
index bfc364850..d2a31457b 100644
--- a/man/link.1
+++ b/man/link.1
@@ -1,20 +1,18 @@
-.\" generated with Ronn/v0.4.1
-.\" http://github.com/rtomayko/ronn/
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
-.TH "NPM\-LINK" "1" "April 2010" "" ""
+.TH "NPM\-LINK" "1" "May 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/ln.1 b/man/ln.1
index bfc364850..d2a31457b 100644
--- a/man/ln.1
+++ b/man/ln.1
@@ -1,20 +1,18 @@
-.\" generated with Ronn/v0.4.1
-.\" http://github.com/rtomayko/ronn/
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
-.TH "NPM\-LINK" "1" "April 2010" "" ""
+.TH "NPM\-LINK" "1" "May 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/publish.1 b/man/publish.1
index 9a8de8640..e0e29502b 100644
--- a/man/publish.1
+++ b/man/publish.1
@@ -1,31 +1,30 @@
-.\" generated with Ronn/v0.4.1
-.\" http://github.com/rtomayko/ronn/
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "NPM\-PUBLISH" "1" "May 2010" "" ""
.
.SH "NAME"
-\fBnpm\-publish\fR \-\- Publish a package
+\fBnpm\-publish\fR \- Publish a package
.
.SH "SYNOPSIS"
.
.nf
+
npm publish <tarball>
npm publish <folder>
.
.fi
.
.SH "DESCRIPTION"
-Publishes a package to the registry so that it can be installed by name.
+Publishes a package to the registry so that it can be installed by name\.
.
.TP
\fB<folder>\fR
-A folder containing a package.json file
+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.
+A url or file path to a gzipped tar archive containing a single folder with a package\.json file inside\.
.
.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/registry.1 b/man/registry.1
index 30bcfc02f..c3fdc0c7e 100644
--- a/man/registry.1
+++ b/man/registry.1
@@ -1,33 +1,27 @@
-.\" generated with Ronn/v0.4.1
-.\" http://github.com/rtomayko/ronn/
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "NPM\-REGISTRY" "1" "May 2010" "" ""
.
.SH "NAME"
-\fBnpm\-registry\fR \-\- Notes on the JavaScript package registry
+\fBnpm\-registry\fR \- Notes on the JavaScript package registry
.
.SH "MARKED FOR REMOVAL"
-This doc file will be removed once its contents have been implemented and its
-data moved to the relevant command documentation.
+This doc file will be removed once its contents have been implemented and its data moved to the relevant command documentation\.
.
.SH "npm registry"
-Notes on npm's use of the \fIjs\-registry\fR.
+Notes on npm\'s use of the js\-registry \fIhttp://github\.com/mikeal/js\-registry\fR\.
.
.SH "Changed commands"
.
.SS "list"
-npm list will now also show packages that are in the registry for
-installation, along with info about their tags and versions, etc. To limit to
-a particular tag, preface it with @, for instance: \fBnpm list foo @stable\fR to
-show the stable version of foo. \fBnpm list @stable\fR would so all packages with
-a tag of \fBstable\fR.
+npm list will now also show packages that are in the registry for installation, along with info about their tags and versions, etc\. To limit to a particular tag, preface it with @, for instance: \fBnpm list foo @stable\fR to show the stable version of foo\. \fBnpm list @stable\fR would so all packages with a tag of \fBstable\fR\.
.
.P
-The current behavior will be available via \fBnpm list @installed\fR.
+The current behavior will be available via \fBnpm list @installed\fR\.
.
.SH "Configuration"
-A registry base URL must be specified, either with the \fB\-\-registry <url>\fR in
-the command line, or by setting a registry url in the .npmrc file.
+A registry base URL must be specified, either with the \fB\-\-registry <url>\fR in the command line, or by setting a registry url in the \.npmrc file\.
.
.P
-Also, need something to keep track of the user who's logged in? That's dicey.
+Also, need something to keep track of the user who\'s logged in? That\'s dicey\.
diff --git a/man/restart.1 b/man/restart.1
index eaf3c018b..8b185ae86 100644
--- a/man/restart.1
+++ b/man/restart.1
@@ -1,24 +1,24 @@
-.\" generated with Ronn/v0.4.1
-.\" http://github.com/rtomayko/ronn/
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "NPM\-RESTART" "1" "May 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.
+If no version is specified, then it restarts the "active" version\.
.
.P
This is identical to doing:
@@ -26,6 +26,7 @@ This is identical to doing:
.IP "" 4
.
.nf
+
npm stop <name>
npm start <name>
.
@@ -42,3 +43,4 @@ npm\-start(1)
npm\-stop
.
.IP "" 0
+
diff --git a/man/rm.1 b/man/rm.1
index 057dc8458..9080b0cfb 100644
--- a/man/rm.1
+++ b/man/rm.1
@@ -1,23 +1,22 @@
-.\" generated with Ronn/v0.4.1
-.\" http://github.com/rtomayko/ronn/
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "NPM\-UNINSTALL" "1" "May 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>]
.
.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.
+If the version is omitted, then all versions of a package are removed\.
diff --git a/man/scripts.1 b/man/scripts.1
index 1c0626342..8c568a6fa 100644
--- a/man/scripts.1
+++ b/man/scripts.1
@@ -1,14 +1,13 @@
-.\" generated with Ronn/v0.4.1
-.\" http://github.com/rtomayko/ronn/
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
-.TH "NPM\-SCRIPTS" "1" "April 2010" "" ""
+.TH "NPM\-SCRIPTS" "1" "May 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
@@ -16,85 +15,80 @@ Run BEFORE the package is installed
.
.TP
install
-Run AFTER the package is installed.
+Run AFTER the package is installed\.
.
.TP
preactivate
-Run BEFORE the package is activated.
+Run BEFORE the package is activated\.
.
.TP
activate
-Run AFTER the package has been activated.
+Run AFTER the package has been activated\.
.
.TP
deactivate
-Run BEFORE the package is deactivated.
+Run BEFORE the package is deactivated\.
.
.TP
postdeactivate
-Run AFTER the package is deactivated.
+Run AFTER the package is deactivated\.
.
.TP
uninstall
-Run BEFORE the package is uninstalled.
+Run BEFORE the package is uninstalled\.
.
.TP
postuninstall
-Run AFTER the package is uninstalled.
+Run AFTER the package is uninstalled\.
.
.SH "Package Lifecycle Env Vars"
-Package scripts are run in an environment where the package.json fields have
-been 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 in your
-various lifecycle scripts, this would be true:
+Package scripts are run in an environment where the package\.json fields have been 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 in your various lifecycle scripts, this would be true:
.
.IP "" 4
.
.nf
-process.env.npm_package_name === "foo"
-process.env.npm_package_version === "1.2.5"
+
+process\.env\.npm_package_name === "foo"
+process\.env\.npm_package_version === "1\.2\.5"
.
.fi
.
.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"
+
+process\.env\.npm_package_scripts_install = "foo\.js"
.
.fi
.
.IP "" 0
.
.P
-Last but not least, 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.
+Last but not least, 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\.
.
.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\.
.
.P
-For example, if your package.json contains this:
+For example, if your package\.json contains this:
.
.IP "" 4
.
.nf
+
{ "scripts" :
- { "install" : "scripts/install.js"
- , "postinstall" : "scripts/install.js"
- , "activate" : "scripts/install.js"
- , "uninstall" : "scripts/uninstall.js"
+ { "install" : "scripts/install\.js"
+ , "postinstall" : "scripts/install\.js"
+ , "activate" : "scripts/install\.js"
+ , "uninstall" : "scripts/uninstall\.js"
}
}
.
@@ -103,19 +97,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"
+ { "preinstall" : "\./configure"
, "install" : "make"
, "test" : "make test"
}
@@ -126,6 +118,4 @@ If you want to run a make command, you can do so. This works just fine:
.IP "" 0
.
.P
-However, the script line is not simply a command line, so \fBmake && make install\fR
-would try to execute the \fBmake\fR command with the arguments \fB&&\fR, \fBmake\fR, and \fBinstall\fR. If you have a lot of stuff to run in a command, put it in a script
-file.
+However, the script line is not simply a command line, so \fBmake && make install\fR would try to execute the \fBmake\fR command with the arguments \fB&&\fR, \fBmake\fR, and \fBinstall\fR\. If you have a lot of stuff to run in a command, put it in a script file\.
diff --git a/man/start.1 b/man/start.1
index 3d42844f1..ad7487ba5 100644
--- a/man/start.1
+++ b/man/start.1
@@ -1,20 +1,21 @@
-.\" generated with Ronn/v0.4.1
-.\" http://github.com/rtomayko/ronn/
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "NPM\-START" "1" "May 2010" "" ""
.
.SH "NAME"
-\fBnpm\-start\fR \-\- Start a package
+\fBnpm\-start\fR \- Start a package
.
.SH "SYNOPSIS"
.
.nf
+
npm start <name> [<version>]
.
.fi
.
.SH "DESCRIPTION"
-This runs a package's "start" script, if one was provided.
+This runs a package\'s "start" script, if one was provided\.
.
.P
-If no version is specified, then it starts the "active" version.
+If no version is specified, then it starts the "active" version\.
diff --git a/man/stop.1 b/man/stop.1
index 9a02773dd..652908d02 100644
--- a/man/stop.1
+++ b/man/stop.1
@@ -1,20 +1,21 @@
-.\" generated with Ronn/v0.4.1
-.\" http://github.com/rtomayko/ronn/
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "NPM\-STOP" "1" "May 2010" "" ""
.
.SH "NAME"
-\fBnpm\-stop\fR \-\- Stop a package
+\fBnpm\-stop\fR \- Stop a package
.
.SH "SYNOPSIS"
.
.nf
+
npm stop <name> [<version>]
.
.fi
.
.SH "DESCRIPTION"
-This runs a package's "stop" script, if one was provided.
+This runs a package\'s "stop" script, if one was provided\.
.
.P
-If no version is specified, then it stops the "active" version.
+If no version is specified, then it stops the "active" version\.
diff --git a/man/tag.1 b/man/tag.1
index bacaa7083..72b7c75ab 100644
--- a/man/tag.1
+++ b/man/tag.1
@@ -1,23 +1,21 @@
-.\" generated with Ronn/v0.4.1
-.\" http://github.com/rtomayko/ronn/
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "NPM\-TAG" "1" "May 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
+
+npm tag packagename 1\.2\.3 tagname
.
.fi
.
.SH "DESCRIPTION"
-Tags the specified version of "packagename" with the specified "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 46bb2f09d..6dccab4b8 100644
--- a/man/test.1
+++ b/man/test.1
@@ -1,20 +1,21 @@
-.\" generated with Ronn/v0.4.1
-.\" http://github.com/rtomayko/ronn/
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "NPM\-TEST" "1" "May 2010" "" ""
.
.SH "NAME"
-\fBnpm\-test\fR \-\- Test a package
+\fBnpm\-test\fR \- Test a package
.
.SH "SYNOPSIS"
.
.nf
+
npm test <name> [<version>]
.
.fi
.
.SH "DESCRIPTION"
-This runs a package's "test" script, if one was provided.
+This runs a package\'s "test" script, if one was provided\.
.
.P
-If no version is specified, then it tests the "active" version.
+If no version is specified, then it tests the "active" version\.
diff --git a/man/uninstall.1 b/man/uninstall.1
index 057dc8458..9080b0cfb 100644
--- a/man/uninstall.1
+++ b/man/uninstall.1
@@ -1,23 +1,22 @@
-.\" generated with Ronn/v0.4.1
-.\" http://github.com/rtomayko/ronn/
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "NPM\-UNINSTALL" "1" "May 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>]
.
.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.
+If the version is omitted, then all versions of a package are removed\.
diff --git a/man/unpublish.1 b/man/unpublish.1
index f89c6db58..8c76c44e9 100644
--- a/man/unpublish.1
+++ b/man/unpublish.1
@@ -1,18 +1,18 @@
-.\" generated with Ronn/v0.4.1
-.\" http://github.com/rtomayko/ronn/
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "NPM\-UNPUBLISH" "1" "June 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\.