diff options
author | isaacs <i@izs.me> | 2013-07-12 08:55:57 -0700 |
---|---|---|
committer | isaacs <i@izs.me> | 2013-07-12 08:56:26 -0700 |
commit | ff8a4058bfac4f360992cfe7adf04f910282cedc (patch) | |
tree | b271ef198babbc9c46c33bcda9826fbcc6bf0a6d /deps/npm/man/man1 | |
parent | 6d91bd37075a53f42bab01915fa89ba4a4f0a075 (diff) | |
download | node-new-ff8a4058bfac4f360992cfe7adf04f910282cedc.tar.gz |
npm: Upgrade to 1.3.3
Diffstat (limited to 'deps/npm/man/man1')
-rw-r--r-- | deps/npm/man/man1/author.1 | 55 | ||||
-rw-r--r-- | deps/npm/man/man1/changelog.1 | 173 | ||||
-rw-r--r-- | deps/npm/man/man1/coding-style.1 | 254 | ||||
-rw-r--r-- | deps/npm/man/man1/config.1 | 1523 | ||||
-rw-r--r-- | deps/npm/man/man1/developers.1 | 335 | ||||
-rw-r--r-- | deps/npm/man/man1/disputes.1 | 145 | ||||
-rw-r--r-- | deps/npm/man/man1/faq.1 | 459 | ||||
-rw-r--r-- | deps/npm/man/man1/find.1 | 72 | ||||
-rw-r--r-- | deps/npm/man/man1/folders.1 | 258 | ||||
-rw-r--r-- | deps/npm/man/man1/get.1 | 1154 | ||||
-rw-r--r-- | deps/npm/man/man1/global.1 | 258 | ||||
-rw-r--r-- | deps/npm/man/man1/home.1 | 68 | ||||
-rw-r--r-- | deps/npm/man/man1/index.1 | 298 | ||||
-rw-r--r-- | deps/npm/man/man1/json.1 | 853 | ||||
-rw-r--r-- | deps/npm/man/man1/list.1 | 125 | ||||
-rw-r--r-- | deps/npm/man/man1/ln.1 | 108 | ||||
-rw-r--r-- | deps/npm/man/man1/npm-README.1 (renamed from deps/npm/man/man1/README.1) | 0 | ||||
-rw-r--r-- | deps/npm/man/man1/npm-adduser.1 (renamed from deps/npm/man/man1/adduser.1) | 8 | ||||
-rw-r--r-- | deps/npm/man/man1/npm-bin.1 (renamed from deps/npm/man/man1/bin.1) | 8 | ||||
-rw-r--r-- | deps/npm/man/man1/npm-bugs.1 (renamed from deps/npm/man/man1/bugs.1) | 10 | ||||
-rw-r--r-- | deps/npm/man/man1/npm-build.1 (renamed from deps/npm/man/man1/build.1) | 4 | ||||
-rw-r--r-- | deps/npm/man/man1/npm-bundle.1 (renamed from deps/npm/man/man1/bundle.1) | 0 | ||||
-rw-r--r-- | deps/npm/man/man1/npm-cache.1 (renamed from deps/npm/man/man1/cache.1) | 8 | ||||
-rw-r--r-- | deps/npm/man/man1/npm-completion.1 (renamed from deps/npm/man/man1/completion.1) | 4 | ||||
-rw-r--r-- | deps/npm/man/man1/npm-config.1 | 112 | ||||
-rw-r--r-- | deps/npm/man/man1/npm-dedupe.1 (renamed from deps/npm/man/man1/dedupe.1) | 2 | ||||
-rw-r--r-- | deps/npm/man/man1/npm-deprecate.1 (renamed from deps/npm/man/man1/deprecate.1) | 2 | ||||
-rw-r--r-- | deps/npm/man/man1/npm-docs.1 (renamed from deps/npm/man/man1/docs.1) | 10 | ||||
-rw-r--r-- | deps/npm/man/man1/npm-edit.1 (renamed from deps/npm/man/man1/edit.1) | 10 | ||||
-rw-r--r-- | deps/npm/man/man1/npm-explore.1 (renamed from deps/npm/man/man1/explore.1) | 2 | ||||
-rw-r--r-- | deps/npm/man/man1/npm-help-search.1 (renamed from deps/npm/man/man1/help-search.1) | 2 | ||||
-rw-r--r-- | deps/npm/man/man1/npm-help.1 (renamed from deps/npm/man/man1/help.1) | 14 | ||||
-rw-r--r-- | deps/npm/man/man1/npm-init.1 (renamed from deps/npm/man/man1/init.1) | 2 | ||||
-rw-r--r-- | deps/npm/man/man1/npm-install.1 (renamed from deps/npm/man/man1/install.1) | 26 | ||||
-rw-r--r-- | deps/npm/man/man1/npm-link.1 (renamed from deps/npm/man/man1/link.1) | 14 | ||||
-rw-r--r-- | deps/npm/man/man1/npm-ls.1 (renamed from deps/npm/man/man1/ls.1) | 10 | ||||
-rw-r--r-- | deps/npm/man/man1/npm-outdated.1 (renamed from deps/npm/man/man1/outdated.1) | 4 | ||||
-rw-r--r-- | deps/npm/man/man1/npm-owner.1 (renamed from deps/npm/man/man1/owner.1) | 4 | ||||
-rw-r--r-- | deps/npm/man/man1/npm-pack.1 (renamed from deps/npm/man/man1/pack.1) | 6 | ||||
-rw-r--r-- | deps/npm/man/man1/npm-prefix.1 (renamed from deps/npm/man/man1/prefix.1) | 8 | ||||
-rw-r--r-- | deps/npm/man/man1/npm-prune.1 (renamed from deps/npm/man/man1/prune.1) | 2 | ||||
-rw-r--r-- | deps/npm/man/man1/npm-publish.1 (renamed from deps/npm/man/man1/publish.1) | 2 | ||||
-rw-r--r-- | deps/npm/man/man1/npm-rebuild.1 (renamed from deps/npm/man/man1/rebuild.1) | 0 | ||||
-rw-r--r-- | deps/npm/man/man1/npm-restart.1 (renamed from deps/npm/man/man1/restart.1) | 2 | ||||
-rw-r--r-- | deps/npm/man/man1/npm-rm.1 (renamed from deps/npm/man/man1/rm.1) | 8 | ||||
-rw-r--r-- | deps/npm/man/man1/npm-root.1 (renamed from deps/npm/man/man1/root.1) | 8 | ||||
-rw-r--r-- | deps/npm/man/man1/npm-run-script.1 (renamed from deps/npm/man/man1/run-script.1) | 2 | ||||
-rw-r--r-- | deps/npm/man/man1/npm-search.1 (renamed from deps/npm/man/man1/search.1) | 8 | ||||
-rw-r--r-- | deps/npm/man/man1/npm-shrinkwrap.1 (renamed from deps/npm/man/man1/shrinkwrap.1) | 4 | ||||
-rw-r--r-- | deps/npm/man/man1/npm-star.1 (renamed from deps/npm/man/man1/star.1) | 0 | ||||
-rw-r--r-- | deps/npm/man/man1/npm-stars.1 (renamed from deps/npm/man/man1/stars.1) | 0 | ||||
-rw-r--r-- | deps/npm/man/man1/npm-start.1 (renamed from deps/npm/man/man1/start.1) | 2 | ||||
-rw-r--r-- | deps/npm/man/man1/npm-stop.1 (renamed from deps/npm/man/man1/stop.1) | 2 | ||||
-rw-r--r-- | deps/npm/man/man1/npm-submodule.1 (renamed from deps/npm/man/man1/submodule.1) | 2 | ||||
-rw-r--r-- | deps/npm/man/man1/npm-tag.1 (renamed from deps/npm/man/man1/tag.1) | 8 | ||||
-rw-r--r-- | deps/npm/man/man1/npm-test.1 (renamed from deps/npm/man/man1/test.1) | 2 | ||||
-rw-r--r-- | deps/npm/man/man1/npm-uninstall.1 (renamed from deps/npm/man/man1/uninstall.1) | 8 | ||||
-rw-r--r-- | deps/npm/man/man1/npm-unpublish.1 (renamed from deps/npm/man/man1/unpublish.1) | 2 | ||||
-rw-r--r-- | deps/npm/man/man1/npm-update.1 (renamed from deps/npm/man/man1/update.1) | 4 | ||||
-rw-r--r-- | deps/npm/man/man1/npm-version.1 (renamed from deps/npm/man/man1/version.1) | 4 | ||||
-rw-r--r-- | deps/npm/man/man1/npm-view.1 (renamed from deps/npm/man/man1/view.1) | 10 | ||||
-rw-r--r-- | deps/npm/man/man1/npm-whoami.1 (renamed from deps/npm/man/man1/whoami.1) | 6 | ||||
-rw-r--r-- | deps/npm/man/man1/npm.1 | 26 | ||||
-rw-r--r-- | deps/npm/man/man1/registry.1 | 107 | ||||
-rw-r--r-- | deps/npm/man/man1/removing-npm.1 | 107 | ||||
-rw-r--r-- | deps/npm/man/man1/scripts.1 | 351 | ||||
-rw-r--r-- | deps/npm/man/man1/semver.1 | 221 | ||||
-rw-r--r-- | deps/npm/man/man1/set.1 | 1154 |
68 files changed, 307 insertions, 8153 deletions
diff --git a/deps/npm/man/man1/author.1 b/deps/npm/man/man1/author.1 deleted file mode 100644 index 6373c3ee4d..0000000000 --- a/deps/npm/man/man1/author.1 +++ /dev/null @@ -1,55 +0,0 @@ -.\" Generated with Ronnjs/v0.1 -.\" http://github.com/kapouer/ronnjs/ -. -.TH "NPM\-OWNER" "1" "November 2011" "" "" -. -.SH "NAME" -\fBnpm-owner\fR \-\- Manage package owners -. -.SH "SYNOPSIS" -. -.nf -npm owner ls <package name> -npm owner add <user> <package name> -npm owner rm <user> <package name> -. -.fi -. -.SH "DESCRIPTION" -Manage ownership of published packages\. -. -.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\. -. -.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\. -. -.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\. -. -.SH "SEE ALSO" -. -.IP "\(bu" 4 -npm help publish -. -.IP "\(bu" 4 -npm help registry -. -.IP "\(bu" 4 -npm help adduser -. -.IP "" 0 - diff --git a/deps/npm/man/man1/changelog.1 b/deps/npm/man/man1/changelog.1 deleted file mode 100644 index 5c623301d4..0000000000 --- a/deps/npm/man/man1/changelog.1 +++ /dev/null @@ -1,173 +0,0 @@ -.\" Generated with Ronnjs 0.3.8 -.\" http://github.com/kapouer/ronnjs/ -. -.TH "NPM\-CHANGELOG" "1" "July 2013" "" "" -. -.SH "NAME" -\fBnpm-changelog\fR \-\- Changes -. -.SH "HISTORY" -. -.SS "1\.1\.3, 1\.1\.4" -. -.IP "\(bu" 4 -Update request to support HTTPS\-over\-HTTP proxy tunneling -. -.IP "\(bu" 4 -Throw on undefined envs in config settings -. -.IP "\(bu" 4 -Update which to 1\.0\.5 -. -.IP "\(bu" 4 -Fix windows UNC busyloop in findPrefix -. -.IP "\(bu" 4 -Bundle nested bundleDependencies properly -. -.IP "\(bu" 4 -Alias adduser to add\-user -. -.IP "\(bu" 4 -Doc updates (Christian Howe, Henrik Hodne, Andrew Lunny) -. -.IP "\(bu" 4 -ignore logfd/outfd streams in makeEnv() (Rod Vagg) -. -.IP "\(bu" 4 -shrinkwrap: Behave properly with url\-installed deps -. -.IP "\(bu" 4 -install: Support \-\-save with url install targets -. -.IP "\(bu" 4 -Support installing naked tars or single\-file modules from urls etc\. -. -.IP "\(bu" 4 -init: Don\'t add engines section -. -.IP "\(bu" 4 -Don\'t run make clean on rebuild -. -.IP "\(bu" 4 -Added missing unicode replacement (atomizer) -. -.IP "" 0 -. -.SS "1\.1\.2" -Dave Pacheco (2): - add "npm shrinkwrap" -. -.P -Martin Cooper (1): - Fix #1753 Make a copy of the cached objects we\'ll modify\. -. -.P -Tim Oxley (1): - correctly remove readme from default npm view command\. -. -.P -Tyler Green (1): - fix #2187 set terminal columns to Infinity if 0 -. -.P -isaacs (19): - update minimatch - update request - Experimental: single\-file modules - Fix #2172 Don\'t remove global mans uninstalling local pkgs - Add \-\-versions flag to show the version of node as well - Support \-\-json flag for ls output - update request to 2\.9\.151 -. -.SS "1\.1" -. -.IP "\(bu" 4 -Replace system tar dependency with a JS tar -. -.IP "\(bu" 4 -Continue to refine -. -.IP "" 0 -. -.SS "1\.0" -. -.IP "\(bu" 4 -Greatly simplified folder structure -. -.IP "\(bu" 4 -Install locally (bundle by default) -. -.IP "\(bu" 4 -Drastic rearchitecture -. -.IP "" 0 -. -.SS "0\.3" -. -.IP "\(bu" 4 -More correct permission/uid handling when running as root -. -.IP "\(bu" 4 -Require node 0\.4\.0 -. -.IP "\(bu" 4 -Reduce featureset -. -.IP "\(bu" 4 -Packages without "main" modules don\'t export modules -. -.IP "\(bu" 4 -Remove support for invalid JSON (since node doesn\'t support it) -. -.IP "" 0 -. -.SS "0\.2" -. -.IP "\(bu" 4 -First allegedly "stable" release -. -.IP "\(bu" 4 -Most functionality implemented -. -.IP "\(bu" 4 -Used shim files and \fBname@version\fR symlinks -. -.IP "\(bu" 4 -Feature explosion -. -.IP "\(bu" 4 -Kind of a mess -. -.IP "" 0 -. -.SS "0\.1" -. -.IP "\(bu" 4 -push to beta, and announce -. -.IP "\(bu" 4 -Solaris and Cygwin support -. -.IP "" 0 -. -.SS "0\.0" -. -.IP "\(bu" 4 -Lots of sketches and false starts; abandoned a few times -. -.IP "\(bu" 4 -Core functionality established -. -.IP "" 0 -. -.SH "SEE ALSO" -. -.IP "\(bu" 4 -npm help npm -. -.IP "\(bu" 4 -npm help faq -. -.IP "" 0 - diff --git a/deps/npm/man/man1/coding-style.1 b/deps/npm/man/man1/coding-style.1 deleted file mode 100644 index 79b1cae143..0000000000 --- a/deps/npm/man/man1/coding-style.1 +++ /dev/null @@ -1,254 +0,0 @@ -.\" Generated with Ronnjs 0.3.8 -.\" http://github.com/kapouer/ronnjs/ -. -.TH "NPM\-CODING\-STYLE" "1" "July 2013" "" "" -. -.SH "NAME" -\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\. -. -.P -If you want to contribute to npm (which is very encouraged), you should -make your code conform to npm\'s style\. -. -.P -Note: this concerns npm\'s code not the specific packages at npmjs\.org -. -.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\. -. -.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\. -. -.P -Configure your editor appropriately\. -. -.SH "Curly braces" -Curly braces belong on the same line as the thing that necessitates them\. -. -.P -Bad: -. -.IP "" 4 -. -.nf -function () -{ -. -.fi -. -.IP "" 0 -. -.P -Good: -. -.IP "" 4 -. -.nf -function () { -. -.fi -. -.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\. -. -.P -Bad: -. -.IP "" 4 -. -.nf -if (foo) { bar() } -while (foo) - bar() -. -.fi -. -.IP "" 0 -. -.P -Good: -. -.IP "" 4 -. -.nf -if (foo) bar() -while (foo) { - bar() -} -. -.fi -. -.IP "" 0 -. -.SH "Semicolons" -Don\'t use them except in four situations: -. -.IP "\(bu" 4 -\fBfor (;;)\fR loops\. They\'re actually required\. -. -.IP "\(bu" 4 -null loops like: \fBwhile (something) ;\fR (But you\'d better have a good -reason for doing that\.) -. -.IP "\(bu" 4 -\fBcase "foo": doSomething(); break\fR -. -.IP "\(bu" 4 -In front of a leading \fB(\fR or \fB[\fR at the start of the line\. -This prevents the expression from being interpreted -as a function call or property access, respectively\. -. -.IP "" 0 -. -.P -Some examples of good semicolon usage: -. -.IP "" 4 -. -.nf -;(x || y)\.doSomething() -;[a, b, c]\.forEach(doSomething) -for (var i = 0; i < 10; i ++) { - switch (state) { - case "begin": start(); continue - case "end": finish(); break - default: throw new Error("unknown state") - } - end() -} -. -.fi -. -.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\. -. -.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: -. -.IP "" 4 -. -.nf -var magicWords = [ "abracadabra" - , "gesundheit" - , "ventrilo" - ] - , spells = { "fireball" : function () { setOnFire() } - , "water" : function () { putOut() } - } - , a = 1 - , b = "abc" - , etc - , somethingElse -. -.fi -. -.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\. -. -.P -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\. -. -.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\. -. -.P -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\. -. -.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\. -. -.SH "Logging" -Logging is done using the npmlog \fIhttps://github\.com/isaacs/npmlog\fR -utility\. -. -.P -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\. -. -.P -Use appropriate log levels\. See \fBnpm help config\fR and search for -"loglevel"\. -. -.SH "Case, naming, etc\." -Use \fBlowerCamelCase\fR for multiword identifiers when they refer to objects, -functions, methods, members, or anything not specified in this section\. -. -.P -Use \fBUpperCamelCase\fR for class names (things that you\'d pass to "new")\. -. -.P -Use \fBall\-lower\-hyphen\-css\-case\fR for multiword filenames and config keys\. -. -.P -Use named functions\. They make stack traces easier to follow\. -. -.P -Use \fBCAPS_SNAKE_CASE\fR for constants, things that should never change -and are rarely used\. -. -.P -Use a single uppercase letter for function names where the function -would normally be anonymous, but needs to call itself recursively\. It -makes it clear that it\'s a "throwaway" function\. -. -.SH "null, undefined, false, 0" -Boolean variables and functions should always be either \fBtrue\fR or \fBfalse\fR\|\. Don\'t set it to 0 unless it\'s supposed to be a number\. -. -.P -When something is intentionally missing or removed, set it to \fBnull\fR\|\. -. -.P -Don\'t set things to \fBundefined\fR\|\. Reserve that value to mean "not yet -set to anything\." -. -.P -Boolean objects are verboten\. -. -.SH "SEE ALSO" -. -.IP "\(bu" 4 -npm help developers -. -.IP "\(bu" 4 -npm help faq -. -.IP "\(bu" 4 -npm help npm -. -.IP "" 0 - diff --git a/deps/npm/man/man1/config.1 b/deps/npm/man/man1/config.1 deleted file mode 100644 index 2e0e7a005f..0000000000 --- a/deps/npm/man/man1/config.1 +++ /dev/null @@ -1,1523 +0,0 @@ -.\" Generated with Ronnjs 0.3.8 -.\" http://github.com/kapouer/ronnjs/ -. -.TH "NPM\-CONFIG" "1" "July 2013" "" "" -. -.SH "NAME" -\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> -npm config list -npm config edit -npm get <key> -npm set <key> <value> [\-\-global] -. -.fi -. -.SH "DESCRIPTION" -npm gets its configuration values from 6 sources, in this priority: -. -.SS "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\|\. -. -.SS "Environment Variables" -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\. -. -.SS "Per\-user config file" -\fB$HOME/\.npmrc\fR (or the \fBuserconfig\fR param, if set above) -. -.P -This file is an ini\-file formatted list of \fBkey = value\fR parameters\. -Environment variables can be replaced using \fB${VARIABLE_NAME}\fR\|\. For example: -. -.IP "" 4 -. -.nf -prefix = ${HOME}/\.npm\-packages -. -.fi -. -.IP "" 0 -. -.SS "Global config file" -\fB$PREFIX/etc/npmrc\fR (or the \fBglobalconfig\fR param, if set above): -This file is an ini\-file formatted list of \fBkey = value\fR parameters\. -Environment variables can be replaced as above\. -. -.SS "Built\-in config file" -\fBpath/to/npm/itself/npmrc\fR -. -.P -This is an unchangeable "builtin" -configuration file that npm keeps consistent across updates\. Set -fields in here using the \fB\|\./configure\fR script that comes with npm\. -This is primarily for distribution maintainers to override default -configs in a standard and consistent manner\. -. -.SS "Default Configs" -A set of configuration parameters that are internal to npm, and are -defaults if nothing else is specified\. -. -.SH "Sub\-commands" -Config supports the following sub\-commands: -. -.SS "set" -. -.nf -npm config set key value -. -.fi -. -.P -Sets the config key to the value\. -. -.P -If value is omitted, then it sets it to "true"\. -. -.SS "get" -. -.nf -npm config get key -. -.fi -. -.P -Echo the config value to stdout\. -. -.SS "list" -. -.nf -npm config list -. -.fi -. -.P -Show all the config settings\. -. -.SS "delete" -. -.nf -npm config delete key -. -.fi -. -.P -Deletes the key from all configuration files\. -. -.SS "edit" -. -.nf -npm config edit -. -.fi -. -.P -Opens the config file in an editor\. Use the \fB\-\-global\fR flag to edit the -global config\. -. -.SH "Shorthands and Other CLI Niceties" -The following shorthands are parsed on the command\-line: -. -.IP "\(bu" 4 -\fB\-v\fR: \fB\-\-version\fR -. -.IP "\(bu" 4 -\fB\-h\fR, \fB\-?\fR, \fB\-\-help\fR, \fB\-H\fR: \fB\-\-usage\fR -. -.IP "\(bu" 4 -\fB\-s\fR, \fB\-\-silent\fR: \fB\-\-loglevel silent\fR -. -.IP "\(bu" 4 -\fB\-q\fR, \fB\-\-quiet\fR: \fB\-\-loglevel warn\fR -. -.IP "\(bu" 4 -\fB\-d\fR: \fB\-\-loglevel info\fR -. -.IP "\(bu" 4 -\fB\-dd\fR, \fB\-\-verbose\fR: \fB\-\-loglevel verbose\fR -. -.IP "\(bu" 4 -\fB\-ddd\fR: \fB\-\-loglevel silly\fR -. -.IP "\(bu" 4 -\fB\-g\fR: \fB\-\-global\fR -. -.IP "\(bu" 4 -\fB\-l\fR: \fB\-\-long\fR -. -.IP "\(bu" 4 -\fB\-m\fR: \fB\-\-message\fR -. -.IP "\(bu" 4 -\fB\-p\fR, \fB\-\-porcelain\fR: \fB\-\-parseable\fR -. -.IP "\(bu" 4 -\fB\-reg\fR: \fB\-\-registry\fR -. -.IP "\(bu" 4 -\fB\-v\fR: \fB\-\-version\fR -. -.IP "\(bu" 4 -\fB\-f\fR: \fB\-\-force\fR -. -.IP "\(bu" 4 -\fB\-desc\fR: \fB\-\-description\fR -. -.IP "\(bu" 4 -\fB\-S\fR: \fB\-\-save\fR -. -.IP "\(bu" 4 -\fB\-D\fR: \fB\-\-save\-dev\fR -. -.IP "\(bu" 4 -\fB\-O\fR: \fB\-\-save\-optional\fR -. -.IP "\(bu" 4 -\fB\-B\fR: \fB\-\-save\-bundle\fR -. -.IP "\(bu" 4 -\fB\-y\fR: \fB\-\-yes\fR -. -.IP "\(bu" 4 -\fB\-n\fR: \fB\-\-yes false\fR -. -.IP "\(bu" 4 -\fBll\fR and \fBla\fR commands: \fBls \-\-long\fR -. -.IP "" 0 -. -.P -If the specified configuration param resolves unambiguously to a known -configuration parameter, then it is expanded to that configuration -parameter\. For example: -. -.IP "" 4 -. -.nf -npm ls \-\-par -# same as: -npm ls \-\-parseable -. -.fi -. -.IP "" 0 -. -.P -If multiple single\-character shorthands are strung together, and the -resulting combination is unambiguously not some other configuration -param, then it is expanded to its various component pieces\. For -example: -. -.IP "" 4 -. -.nf -npm ls \-gpld -# same as: -npm ls \-\-global \-\-parseable \-\-long \-\-loglevel info -. -.fi -. -.IP "" 0 -. -.SH "Per\-Package Config Settings" -When running scripts (see \fBnpm help scripts\fR) -the package\.json "config" keys are overwritten in the environment if -there is a config param of \fB<name>[@<version>]:<key>\fR\|\. For example, if -the package\.json has this: -. -.IP "" 4 -. -.nf -{ "name" : "foo" -, "config" : { "port" : "8080" } -, "scripts" : { "start" : "node server\.js" } } -. -.fi -. -.IP "" 0 -. -.P -and the server\.js is this: -. -.IP "" 4 -. -.nf -http\.createServer(\.\.\.)\.listen(process\.env\.npm_package_config_port) -. -.fi -. -.IP "" 0 -. -.P -then the user could change the behavior by doing: -. -.IP "" 4 -. -.nf -npm config set foo:port 80 -. -.fi -. -.IP "" 0 -. -.SH "Config Settings" -. -.SS "always\-auth" -. -.IP "\(bu" 4 -Default: false -. -.IP "\(bu" 4 -Type: Boolean -. -.IP "" 0 -. -.P -Force npm to always require authentication when accessing the registry, -even for \fBGET\fR requests\. -. -.SS "bin\-links" -. -.IP "\(bu" 4 -Default: \fBtrue\fR -. -.IP "\(bu" 4 -Type: Boolean -. -.IP "" 0 -. -.P -Tells npm to create symlinks (or \fB\|\.cmd\fR shims on Windows) for package -executables\. -. -.P -Set to false to have it not do this\. This can be used to work around -the fact that some file systems don\'t support symlinks, even on -ostensibly Unix systems\. -. -.SS "browser" -. -.IP "\(bu" 4 -Default: OS X: \fB"open"\fR, Windows: \fB"start"\fR, Others: \fB"xdg\-open"\fR -. -.IP "\(bu" 4 -Type: String -. -.IP "" 0 -. -.P -The browser that is called by the \fBnpm docs\fR command to open websites\. -. -.SS "ca" -. -.IP "\(bu" 4 -Default: The npm CA certificate -. -.IP "\(bu" 4 -Type: String or null -. -.IP "" 0 -. -.P -The Certificate Authority signing certificate that is trusted for SSL -connections to the registry\. -. -.P -Set to \fBnull\fR to only allow "known" registrars, or to a specific CA cert -to trust only that specific signing authority\. -. -.P -See also the \fBstrict\-ssl\fR config\. -. -.SS "cache" -. -.IP "\(bu" 4 -Default: Windows: \fB%APPDATA%\\npm\-cache\fR, Posix: \fB~/\.npm\fR -. -.IP "\(bu" 4 -Type: path -. -.IP "" 0 -. -.P -The location of npm\'s cache directory\. See \fBnpm help cache\fR -. -.SS "cache\-lock\-stale" -. -.IP "\(bu" 4 -Default: 60000 (1 minute) -. -.IP "\(bu" 4 -Type: Number -. -.IP "" 0 -. -.P -The number of ms before cache folder lockfiles are considered stale\. -. -.SS "cache\-lock\-retries" -. -.IP "\(bu" 4 -Default: 10 -. -.IP "\(bu" 4 -Type: Number -. -.IP "" 0 -. -.P -Number of times to retry to acquire a lock on cache folder lockfiles\. -. -.SS "cache\-lock\-wait" -. -.IP "\(bu" 4 -Default: 10000 (10 seconds) -. -.IP "\(bu" 4 -Type: Number -. -.IP "" 0 -. -.P -Number of ms to wait for cache lock files to expire\. -. -.SS "cache\-max" -. -.IP "\(bu" 4 -Default: Infinity -. -.IP "\(bu" 4 -Type: Number -. -.IP "" 0 -. -.P -The maximum time (in seconds) to keep items in the registry cache before -re\-checking against the registry\. -. -.P -Note that no purging is done unless the \fBnpm cache clean\fR command is -explicitly used, and that only GET requests use the cache\. -. -.SS "cache\-min" -. -.IP "\(bu" 4 -Default: 10 -. -.IP "\(bu" 4 -Type: Number -. -.IP "" 0 -. -.P -The minimum time (in seconds) to keep items in the registry cache before -re\-checking against the registry\. -. -.P -Note that no purging is done unless the \fBnpm cache clean\fR command is -explicitly used, and that only GET requests use the cache\. -. -.SS "color" -. -.IP "\(bu" 4 -Default: true on Posix, false on Windows -. -.IP "\(bu" 4 -Type: Boolean or \fB"always"\fR -. -.IP "" 0 -. -.P -If false, never shows colors\. If \fB"always"\fR then always shows colors\. -If true, then only prints color codes for tty file descriptors\. -. -.SS "coverage" -. -.IP "\(bu" 4 -Default: false -. -.IP "\(bu" 4 -Type: Boolean -. -.IP "" 0 -. -.P -A flag to tell test\-harness to run with their coverage options enabled, -if they respond to the \fBnpm_config_coverage\fR environment variable\. -. -.SS "depth" -. -.IP "\(bu" 4 -Default: Infinity -. -.IP "\(bu" 4 -Type: Number -. -.IP "" 0 -. -.P -The depth to go when recursing directories for \fBnpm ls\fR and \fBnpm cache ls\fR\|\. -. -.SS "description" -. -.IP "\(bu" 4 -Default: true -. -.IP "\(bu" 4 -Type: Boolean -. -.IP "" 0 -. -.P -Show the description in \fBnpm search\fR -. -.SS "dev" -. -.IP "\(bu" 4 -Default: false -. -.IP "\(bu" 4 -Type: Boolean -. -.IP "" 0 -. -.P -Install \fBdev\-dependencies\fR along with packages\. -. -.P -Note that \fBdev\-dependencies\fR are also installed if the \fBnpat\fR flag is -set\. -. -.SS "editor" -. -.IP "\(bu" 4 -Default: \fBEDITOR\fR environment variable if set, or \fB"vi"\fR on Posix, -or \fB"notepad"\fR on Windows\. -. -.IP "\(bu" 4 -Type: path -. -.IP "" 0 -. -.P -The command to run for \fBnpm edit\fR or \fBnpm config edit\fR\|\. -. -.SS "engine\-strict" -. -.IP "\(bu" 4 -Default: false -. -.IP "\(bu" 4 -Type: Boolean -. -.IP "" 0 -. -.P -If set to true, then npm will stubbornly refuse to install (or even -consider installing) any package that claims to not be compatible with -the current Node\.js version\. -. -.SS "force" -. -.IP "\(bu" 4 -Default: false -. -.IP "\(bu" 4 -Type: Boolean -. -.IP "" 0 -. -.P -Makes various commands more forceful\. -. -.IP "\(bu" 4 -lifecycle script failure does not block progress\. -. -.IP "\(bu" 4 -publishing clobbers previously published versions\. -. -.IP "\(bu" 4 -skips cache when requesting from the registry\. -. -.IP "\(bu" 4 -prevents checks against clobbering non\-npm files\. -. -.IP "" 0 -. -.SS "fetch\-retries" -. -.IP "\(bu" 4 -Default: 2 -. -.IP "\(bu" 4 -Type: Number -. -.IP "" 0 -. -.P -The "retries" config for the \fBretry\fR module to use when fetching -packages from the registry\. -. -.SS "fetch\-retry\-factor" -. -.IP "\(bu" 4 -Default: 10 -. -.IP "\(bu" 4 -Type: Number -. -.IP "" 0 -. -.P -The "factor" config for the \fBretry\fR module to use when fetching -packages\. -. -.SS "fetch\-retry\-mintimeout" -. -.IP "\(bu" 4 -Default: 10000 (10 seconds) -. -.IP "\(bu" 4 -Type: Number -. -.IP "" 0 -. -.P -The "minTimeout" config for the \fBretry\fR module to use when fetching -packages\. -. -.SS "fetch\-retry\-maxtimeout" -. -.IP "\(bu" 4 -Default: 60000 (1 minute) -. -.IP "\(bu" 4 -Type: Number -. -.IP "" 0 -. -.P -The "maxTimeout" config for the \fBretry\fR module to use when fetching -packages\. -. -.SS "git" -. -.IP "\(bu" 4 -Default: \fB"git"\fR -. -.IP "\(bu" 4 -Type: String -. -.IP "" 0 -. -.P -The command to use for git commands\. If git is installed on the -computer, but is not in the \fBPATH\fR, then set this to the full path to -the git binary\. -. -.SS "global" -. -.IP "\(bu" 4 -Default: false -. -.IP "\(bu" 4 -Type: Boolean -. -.IP "" 0 -. -.P -Operates in "global" mode, so that packages are installed into the \fBprefix\fR folder instead of the current working directory\. See \fBnpm help folders\fR for more on the differences in behavior\. -. -.IP "\(bu" 4 -packages are installed into the \fB{prefix}/lib/node_modules\fR folder, instead of the -current working directory\. -. -.IP "\(bu" 4 -bin files are linked to \fB{prefix}/bin\fR -. -.IP "\(bu" 4 -man pages are linked to \fB{prefix}/share/man\fR -. -.IP "" 0 -. -.SS "globalconfig" -. -.IP "\(bu" 4 -Default: {prefix}/etc/npmrc -. -.IP "\(bu" 4 -Type: path -. -.IP "" 0 -. -.P -The config file to read for global config options\. -. -.SS "globalignorefile" -. -.IP "\(bu" 4 -Default: {prefix}/etc/npmignore -. -.IP "\(bu" 4 -Type: path -. -.IP "" 0 -. -.P -The config file to read for global ignore patterns to apply to all users -and all projects\. -. -.P -If not found, but there is a "gitignore" file in the -same directory, then that will be used instead\. -. -.SS "group" -. -.IP "\(bu" 4 -Default: GID of the current process -. -.IP "\(bu" 4 -Type: String or Number -. -.IP "" 0 -. -.P -The group to use when running package scripts in global mode as the root -user\. -. -.SS "https\-proxy" -. -.IP "\(bu" 4 -Default: the \fBHTTPS_PROXY\fR or \fBhttps_proxy\fR or \fBHTTP_PROXY\fR or \fBhttp_proxy\fR environment variables\. -. -.IP "\(bu" 4 -Type: url -. -.IP "" 0 -. -.P -A proxy to use for outgoing https requests\. -. -.SS "user\-agent" -. -.IP "\(bu" 4 -Default: node/{process\.version} {process\.platform} {process\.arch} -. -.IP "\(bu" 4 -Type: String -. -.IP "" 0 -. -.P -Sets a User\-Agent to the request header -. -.SS "ignore" -. -.IP "\(bu" 4 -Default: "" -. -.IP "\(bu" 4 -Type: string -. -.IP "" 0 -. -.P -A white\-space separated list of glob patterns of files to always exclude -from packages when building tarballs\. -. -.SS "init\-module" -. -.IP "\(bu" 4 -Default: ~/\.npm\-init\.js -. -.IP "\(bu" 4 -Type: path -. -.IP "" 0 -. -.P -A module that will be loaded by the \fBnpm init\fR command\. See the -documentation for the init\-package\-json \fIhttps://github\.com/isaacs/init\-package\-json\fR module -for more information, or npm help init\. -. -.SS "init\.version" -. -.IP "\(bu" 4 -Default: "0\.0\.0" -. -.IP "\(bu" 4 -Type: semver -. -.IP "" 0 -. -.P -The value \fBnpm init\fR should use by default for the package version\. -. -.SS "init\.author\.name" -. -.IP "\(bu" 4 -Default: "" -. -.IP "\(bu" 4 -Type: String -. -.IP "" 0 -. -.P -The value \fBnpm init\fR should use by default for the package author\'s name\. -. -.SS "init\.author\.email" -. -.IP "\(bu" 4 -Default: "" -. -.IP "\(bu" 4 -Type: String -. -.IP "" 0 -. -.P -The value \fBnpm init\fR should use by default for the package author\'s email\. -. -.SS "init\.author\.url" -. -.IP "\(bu" 4 -Default: "" -. -.IP "\(bu" 4 -Type: String -. -.IP "" 0 -. -.P -The value \fBnpm init\fR should use by default for the package author\'s homepage\. -. -.SS "json" -. -.IP "\(bu" 4 -Default: false -. -.IP "\(bu" 4 -Type: Boolean -. -.IP "" 0 -. -.P -Whether or not to output JSON data, rather than the normal output\. -. -.P -This feature is currently experimental, and the output data structures -for many commands is either not implemented in JSON yet, or subject to -change\. Only the output from \fBnpm ls \-\-json\fR is currently valid\. -. -.SS "link" -. -.IP "\(bu" 4 -Default: false -. -.IP "\(bu" 4 -Type: Boolean -. -.IP "" 0 -. -.P -If true, then local installs will link if there is a suitable globally -installed package\. -. -.P -Note that this means that local installs can cause things to be -installed into the global space at the same time\. The link is only done -if one of the two conditions are met: -. -.IP "\(bu" 4 -The package is not already installed globally, or -. -.IP "\(bu" 4 -the globally installed version is identical to the version that is -being installed locally\. -. -.IP "" 0 -. -.SS "loglevel" -. -.IP "\(bu" 4 -Default: "http" -. -.IP "\(bu" 4 -Type: String -. -.IP "\(bu" 4 -Values: "silent", "win", "error", "warn", "http", "info", "verbose", "silly" -. -.IP "" 0 -. -.P -What level of logs to report\. On failure, \fIall\fR logs are written to \fBnpm\-debug\.log\fR in the current working directory\. -. -.P -Any logs of a higher level than the setting are shown\. -The default is "http", which shows http, warn, and error output\. -. -.SS "logstream" -. -.IP "\(bu" 4 -Default: process\.stderr -. -.IP "\(bu" 4 -Type: Stream -. -.IP "" 0 -. -.P -This is the stream that is passed to the npmlog \fIhttps://github\.com/isaacs/npmlog\fR module at run time\. -. -.P -It cannot be set from the command line, but if you are using npm -programmatically, you may wish to send logs to somewhere other than -stderr\. -. -.P -If the \fBcolor\fR config is set to true, then this stream will receive -colored output if it is a TTY\. -. -.SS "long" -. -.IP "\(bu" 4 -Default: false -. -.IP "\(bu" 4 -Type: Boolean -. -.IP "" 0 -. -.P -Show extended information in \fBnpm ls\fR -. -.SS "message" -. -.IP "\(bu" 4 -Default: "%s" -. -.IP "\(bu" 4 -Type: String -. -.IP "" 0 -. -.P -Commit message which is used by \fBnpm version\fR when creating version commit\. -. -.P -Any "%s" in the message will be replaced with the version number\. -. -.SS "node\-version" -. -.IP "\(bu" 4 -Default: process\.version -. -.IP "\(bu" 4 -Type: semver or false -. -.IP "" 0 -. -.P -The node version to use when checking package\'s "engines" hash\. -. -.SS "npat" -. -.IP "\(bu" 4 -Default: false -. -.IP "\(bu" 4 -Type: Boolean -. -.IP "" 0 -. -.P -Run tests on installation and report results to the \fBnpaturl\fR\|\. -. -.SS "npaturl" -. -.IP "\(bu" 4 -Default: Not yet implemented -. -.IP "\(bu" 4 -Type: url -. -.IP "" 0 -. -.P -The url to report npat test results\. -. -.SS "onload\-script" -. -.IP "\(bu" 4 -Default: false -. -.IP "\(bu" 4 -Type: path -. -.IP "" 0 -. -.P -A node module to \fBrequire()\fR when npm loads\. Useful for programmatic -usage\. -. -.SS "optional" -. -.IP "\(bu" 4 -Default: true -. -.IP "\(bu" 4 -Type: Boolean -. -.IP "" 0 -. -.P -Attempt to install packages in the \fBoptionalDependencies\fR hash\. Note -that if these packages fail to install, the overall installation -process is not aborted\. -. -.SS "parseable" -. -.IP "\(bu" 4 -Default: false -. -.IP "\(bu" 4 -Type: Boolean -. -.IP "" 0 -. -.P -Output parseable results from commands that write to -standard output\. -. -.SS "prefix" -. -.IP "\(bu" 4 -Default: see npm help folders -. -.IP "\(bu" 4 -Type: path -. -.IP "" 0 -. -.P -The location to install global items\. If set on the command line, then -it forces non\-global commands to run in the specified folder\. -. -.SS "production" -. -.IP "\(bu" 4 -Default: false -. -.IP "\(bu" 4 -Type: Boolean -. -.IP "" 0 -. -.P -Set to true to run in "production" mode\. -. -.IP "1" 4 -devDependencies are not installed at the topmost level when running -local \fBnpm install\fR without any arguments\. -. -.IP "2" 4 -Set the NODE_ENV="production" for lifecycle scripts\. -. -.IP "" 0 -. -.SS "proprietary\-attribs" -. -.IP "\(bu" 4 -Default: true -. -.IP "\(bu" 4 -Type: Boolean -. -.IP "" 0 -. -.P -Whether or not to include proprietary extended attributes in the -tarballs created by npm\. -. -.P -Unless you are expecting to unpack package tarballs with something other -than npm \-\- particularly a very outdated tar implementation \-\- leave -this as true\. -. -.SS "proxy" -. -.IP "\(bu" 4 -Default: \fBHTTP_PROXY\fR or \fBhttp_proxy\fR environment variable, or null -. -.IP "\(bu" 4 -Type: url -. -.IP "" 0 -. -.P -A proxy to use for outgoing http requests\. -. -.SS "rebuild\-bundle" -. -.IP "\(bu" 4 -Default: true -. -.IP "\(bu" 4 -Type: Boolean -. -.IP "" 0 -. -.P -Rebuild bundled dependencies after installation\. -. -.SS "registry" -. -.IP "\(bu" 4 -Default: https://registry\.npmjs\.org/ -. -.IP "\(bu" 4 -Type: url -. -.IP "" 0 -. -.P -The base URL of the npm package registry\. -. -.SS "rollback" -. -.IP "\(bu" 4 -Default: true -. -.IP "\(bu" 4 -Type: Boolean -. -.IP "" 0 -. -.P -Remove failed installs\. -. -.SS "save" -. -.IP "\(bu" 4 -Default: false -. -.IP "\(bu" 4 -Type: Boolean -. -.IP "" 0 -. -.P -Save installed packages to a package\.json file as dependencies\. -. -.P -When used with the \fBnpm rm\fR command, it removes it from the dependencies -hash\. -. -.P -Only works if there is already a package\.json file present\. -. -.SS "save\-bundle" -. -.IP "\(bu" 4 -Default: false -. -.IP "\(bu" 4 -Type: Boolean -. -.IP "" 0 -. -.P -If a package would be saved at install time by the use of \fB\-\-save\fR, \fB\-\-save\-dev\fR, or \fB\-\-save\-optional\fR, then also put it in the \fBbundleDependencies\fR list\. -. -.P -When used with the \fBnpm rm\fR command, it removes it from the -bundledDependencies list\. -. -.SS "save\-dev" -. -.IP "\(bu" 4 -Default: false -. -.IP "\(bu" 4 -Type: Boolean -. -.IP "" 0 -. -.P -Save installed packages to a package\.json file as devDependencies\. -. -.P -When used with the \fBnpm rm\fR command, it removes it from the devDependencies -hash\. -. -.P -Only works if there is already a package\.json file present\. -. -.SS "save\-optional" -. -.IP "\(bu" 4 -Default: false -. -.IP "\(bu" 4 -Type: Boolean -. -.IP "" 0 -. -.P -Save installed packages to a package\.json file as optionalDependencies\. -. -.P -When used with the \fBnpm rm\fR command, it removes it from the devDependencies -hash\. -. -.P -Only works if there is already a package\.json file present\. -. -.SS "searchopts" -. -.IP "\(bu" 4 -Default: "" -. -.IP "\(bu" 4 -Type: String -. -.IP "" 0 -. -.P -Space\-separated options that are always passed to search\. -. -.SS "searchexclude" -. -.IP "\(bu" 4 -Default: "" -. -.IP "\(bu" 4 -Type: String -. -.IP "" 0 -. -.P -Space\-separated options that limit the results from search\. -. -.SS "searchsort" -. -.IP "\(bu" 4 -Default: "name" -. -.IP "\(bu" 4 -Type: String -. -.IP "\(bu" 4 -Values: "name", "\-name", "date", "\-date", "description", -"\-description", "keywords", "\-keywords" -. -.IP "" 0 -. -.P -Indication of which field to sort search results by\. Prefix with a \fB\-\fR -character to indicate reverse sort\. -. -.SS "shell" -. -.IP "\(bu" 4 -Default: SHELL environment variable, or "bash" on Posix, or "cmd" on -Windows -. -.IP "\(bu" 4 -Type: path -. -.IP "" 0 -. -.P -The shell to run for the \fBnpm explore\fR command\. -. -.SS "shrinkwrap" -. -.IP "\(bu" 4 -Default: true -. -.IP "\(bu" 4 -Type: Boolean -. -.IP "" 0 -. -.P -If set to false, then ignore \fBnpm\-shrinkwrap\.json\fR files when -installing\. -. -.SS "sign\-git\-tag" -. -.IP "\(bu" 4 -Default: false -. -.IP "\(bu" 4 -Type: Boolean -. -.IP "" 0 -. -.P -If set to true, then the \fBnpm version\fR command will tag the version -using \fB\-s\fR to add a signature\. -. -.P -Note that git requires you to have set up GPG keys in your git configs -for this to work properly\. -. -.SS "strict\-ssl" -. -.IP "\(bu" 4 -Default: true -. -.IP "\(bu" 4 -Type: Boolean -. -.IP "" 0 -. -.P -Whether or not to do SSL key validation when making requests to the -registry via https\. -. -.P -See also the \fBca\fR config\. -. -.SS "tag" -. -.IP "\(bu" 4 -Default: latest -. -.IP "\(bu" 4 -Type: String -. -.IP "" 0 -. -.P -If you ask npm to install a package and don\'t tell it a specific version, then -it will install the specified tag\. -. -.P -Also the tag that is added to the package@version specified by the \fBnpm -tag\fR command, if no explicit tag is given\. -. -.SS "tmp" -. -.IP "\(bu" 4 -Default: TMPDIR environment variable, or "/tmp" -. -.IP "\(bu" 4 -Type: path -. -.IP "" 0 -. -.P -Where to store temporary files and folders\. All temp files are deleted -on success, but left behind on failure for forensic purposes\. -. -.SS "unicode" -. -.IP "\(bu" 4 -Default: true -. -.IP "\(bu" 4 -Type: Boolean -. -.IP "" 0 -. -.P -When set to true, npm uses unicode characters in the tree output\. When -false, it uses ascii characters to draw trees\. -. -.SS "unsafe\-perm" -. -.IP "\(bu" 4 -Default: false if running as root, true otherwise -. -.IP "\(bu" 4 -Type: Boolean -. -.IP "" 0 -. -.P -Set to true to suppress the UID/GID switching when running package -scripts\. If set explicitly to false, then installing as a non\-root user -will fail\. -. -.SS "usage" -. -.IP "\(bu" 4 -Default: false -. -.IP "\(bu" 4 -Type: Boolean -. -.IP "" 0 -. -.P -Set to show short usage output (like the \-H output) -instead of complete help when doing \fBnpm help help\fR\|\. -. -.SS "user" -. -.IP "\(bu" 4 -Default: "nobody" -. -.IP "\(bu" 4 -Type: String or Number -. -.IP "" 0 -. -.P -The UID to set to when running package scripts as root\. -. -.SS "username" -. -.IP "\(bu" 4 -Default: null -. -.IP "\(bu" 4 -Type: String -. -.IP "" 0 -. -.P -The username on the npm registry\. Set with \fBnpm adduser\fR -. -.SS "userconfig" -. -.IP "\(bu" 4 -Default: ~/\.npmrc -. -.IP "\(bu" 4 -Type: path -. -.IP "" 0 -. -.P -The location of user\-level configuration settings\. -. -.SS "userignorefile" -. -.IP "\(bu" 4 -Default: ~/\.npmignore -. -.IP "\(bu" 4 -Type: path -. -.IP "" 0 -. -.P -The location of a user\-level ignore file to apply to all packages\. -. -.P -If not found, but there is a \.gitignore file in the same directory, then -that will be used instead\. -. -.SS "umask" -. -.IP "\(bu" 4 -Default: 022 -. -.IP "\(bu" 4 -Type: Octal numeric string -. -.IP "" 0 -. -.P -The "umask" value to use when setting the file creation mode on files -and folders\. -. -.P -Folders and executables are given a mode which is \fB0777\fR masked against -this value\. Other files are given a mode which is \fB0666\fR masked against -this value\. Thus, the defaults are \fB0755\fR and \fB0644\fR respectively\. -. -.SS "version" -. -.IP "\(bu" 4 -Default: false -. -.IP "\(bu" 4 -Type: boolean -. -.IP "" 0 -. -.P -If true, output the npm version and exit successfully\. -. -.P -Only relevant when specified explicitly on the command line\. -. -.SS "versions" -. -.IP "\(bu" 4 -Default: false -. -.IP "\(bu" 4 -Type: boolean -. -.IP "" 0 -. -.P -If true, output the npm version as well as node\'s \fBprocess\.versions\fR -hash, and exit successfully\. -. -.P -Only relevant when specified explicitly on the command line\. -. -.SS "viewer" -. -.IP "\(bu" 4 -Default: "man" on Posix, "browser" on Windows -. -.IP "\(bu" 4 -Type: path -. -.IP "" 0 -. -.P -The program to use to view help content\. -. -.P -Set to \fB"browser"\fR to view html help content in the default web browser\. -. -.SS "yes" -. -.IP "\(bu" 4 -Default: null -. -.IP "\(bu" 4 -Type: Boolean or null -. -.IP "" 0 -. -.P -If set to \fBnull\fR, then prompt the user for responses in some -circumstances\. -. -.P -If set to \fBtrue\fR, then answer "yes" to any prompt\. If set to \fBfalse\fR -then answer "no" to any prompt\. -. -.SH "SEE ALSO" -. -.IP "\(bu" 4 -npm help folders -. -.IP "\(bu" 4 -npm help npm -. -.IP "" 0 - diff --git a/deps/npm/man/man1/developers.1 b/deps/npm/man/man1/developers.1 deleted file mode 100644 index aa18ccd013..0000000000 --- a/deps/npm/man/man1/developers.1 +++ /dev/null @@ -1,335 +0,0 @@ -.\" Generated with Ronnjs 0.3.8 -.\" http://github.com/kapouer/ronnjs/ -. -.TH "NPM\-DEVELOPERS" "1" "July 2013" "" "" -. -.SH "NAME" -\fBnpm-developers\fR \-\- Developer Guide -. -.SH "DESCRIPTION" -So, you\'ve decided to use npm to develop (and maybe publish/deploy) -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\. -. -.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, or \fBnpm help thing\fR to see the same information\. -. -.SH "What is a " -A package is: -. -.IP "\(bu" 4 -a) a folder containing a program described by a package\.json file -. -.IP "\(bu" 4 -b) a gzipped tarball containing (a) -. -.IP "\(bu" 4 -c) a url that resolves to (b) -. -.IP "\(bu" 4 -d) a \fB<name>@<version>\fR that is published on the registry with (c) -. -.IP "\(bu" 4 -e) a \fB<name>@<tag>\fR that points to (d) -. -.IP "\(bu" 4 -f) a \fB<name>\fR that has a "latest" tag satisfying (e) -. -.IP "\(bu" 4 -g) a \fBgit\fR url that, when cloned, results in (a)\. -. -.IP "" 0 -. -.P -Even if you never publish your package, you can still get a lot of -benefits of using npm if you just want to write a node program (a), and -perhaps if you also want to be able to easily install it elsewhere -after packing it up into a tarball (b)\. -. -.P -Git urls can be of the form: -. -.IP "" 4 -. -.nf -git://github\.com/user/project\.git#commit\-ish -git+ssh://user@hostname:project\.git#commit\-ish -git+http://user@hostname/project/blah\.git#commit\-ish -git+https://user@hostname/project/blah\.git#commit\-ish -. -.fi -. -.IP "" 0 -. -.P -The \fBcommit\-ish\fR can be any tag, sha, or branch which can be supplied as -an argument to \fBgit checkout\fR\|\. The default is \fBmaster\fR\|\. -. -.SH "The package\.json File" -You need to have a \fBpackage\.json\fR file in the root of your project to do -much of anything with npm\. That is basically the whole interface\. -. -.P -See \fBnpm help json\fR for details about what goes in that file\. At the very -least, you need: -. -.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\. -. -.IP -So, \fBnode\-foo\fR and \fBbar\-js\fR are bad names\. \fBfoo\fR or \fBbar\fR are better\. -. -.IP "\(bu" 4 -version: -A semver\-compatible version\. -. -.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\. -. -.IP "\(bu" 4 -author: -Take some credit\. -. -.IP "\(bu" 4 -scripts: -If you have a special compilation or installation script, then you -should put it in the \fBscripts\fR hash\. You should definitely have at -least a basic smoke\-test command as the "scripts\.test" field\. -See npm help scripts\. -. -.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 "\(bu" 4 -directories: -This is a hash of folders\. The best ones to include are "lib" and -"doc", but if you specify a folder full of man pages in "man", then -they\'ll get installed just like these ones\. -. -.IP "" 0 -. -.P -You can use \fBnpm init\fR in the root of your package in order to get you -started with a pretty basic package\.json file\. See \fBnpm help init\fR for -more info\. -. -.SH "Keeping files " -Use a \fB\|\.npmignore\fR file to keep stuff out of your package\. If there\'s -no \fB\|\.npmignore\fR file, but there \fIis\fR a \fB\|\.gitignore\fR file, then npm will -ignore the stuff matched by the \fB\|\.gitignore\fR file\. If you \fIwant\fR to -include something that is excluded by your \fB\|\.gitignore\fR file, you can -create an empty \fB\|\.npmignore\fR file to override it\. -. -.P -By default, the following paths and files are ignored, so there\'s no -need to add them to \fB\|\.npmignore\fR explicitly: -. -.IP "\(bu" 4 -\fB\|\.*\.swp\fR -. -.IP "\(bu" 4 -\fB\|\._*\fR -. -.IP "\(bu" 4 -\fB\|\.DS_Store\fR -. -.IP "\(bu" 4 -\fB\|\.git\fR -. -.IP "\(bu" 4 -\fB\|\.hg\fR -. -.IP "\(bu" 4 -\fB\|\.lock\-wscript\fR -. -.IP "\(bu" 4 -\fB\|\.svn\fR -. -.IP "\(bu" 4 -\fB\|\.wafpickle\-*\fR -. -.IP "\(bu" 4 -\fBCVS\fR -. -.IP "\(bu" 4 -\fBnpm\-debug\.log\fR -. -.IP "" 0 -. -.P -Additionally, everything in \fBnode_modules\fR is ignored, except for -bundled dependencies\. npm automatically handles this for you, so don\'t -bother adding \fBnode_modules\fR to \fB\|\.npmignore\fR\|\. -. -.P -The following paths and files are never ignored, so adding them to \fB\|\.npmignore\fR is pointless: -. -.IP "\(bu" 4 -\fBpackage\.json\fR -. -.IP "\(bu" 4 -\fBREADME\.*\fR -. -.IP "" 0 -. -.SH "Link Packages" -\fBnpm link\fR is designed to install a development package and see the -changes in real time without having to keep re\-installing it\. (You do -need to either re\-link or \fBnpm rebuild \-g\fR to update compiled packages, -of course\.) -. -.P -More info at \fBnpm help link\fR\|\. -. -.SH "Before Publishing: 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\. -. -.P -In the root of your package, do this: -. -.IP "" 4 -. -.nf -npm install \. \-g -. -.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: -. -.IP "" 4 -. -.nf -npm link -. -.fi -. -.IP "" 0 -. -.P -Use \fBnpm ls \-g\fR to see if it\'s there\. -. -.P -To test a local install, go into some other folder, and then do: -. -.IP "" 4 -. -.nf -cd \.\./some\-other\-folder -npm install \.\./my\-package -. -.fi -. -.IP "" 0 -. -.P -to install it locally into the node_modules folder in that other place\. -. -.P -Then go into the node\-repl, and try using require("my\-thing") to -bring in your module\'s main module\. -. -.SH "Create a User Account" -Create a user with the adduser command\. It works like this: -. -.IP "" 4 -. -.nf -npm adduser -. -.fi -. -.IP "" 0 -. -.P -and then follow the prompts\. -. -.P -This is documented better in npm help adduser\. -. -.SH "Publish your package" -This part\'s easy\. IN the root of your folder, do this: -. -.IP "" 4 -. -.nf -npm publish -. -.fi -. -.IP "" 0 -. -.P -You can give publish a url to a tarball, or a filename of a tarball, -or a path to a folder\. -. -.P -Note that pretty much \fBeverything in that folder will be exposed\fR -by default\. So, if you have secret stuff in there, use a \fB\|\.npmignore\fR file to list out the globs to ignore, or publish -from a fresh checkout\. -. -.SH "Brag about it" -Send emails, write blogs, blab in IRC\. -. -.P -Tell the world how easy it is to install your program! -. -.SH "SEE ALSO" -. -.IP "\(bu" 4 -npm help faq -. -.IP "\(bu" 4 -npm help npm -. -.IP "\(bu" 4 -npm help init -. -.IP "\(bu" 4 -npm help json -. -.IP "\(bu" 4 -npm help scripts -. -.IP "\(bu" 4 -npm help publish -. -.IP "\(bu" 4 -npm help adduser -. -.IP "\(bu" 4 -npm help registry -. -.IP "" 0 - diff --git a/deps/npm/man/man1/disputes.1 b/deps/npm/man/man1/disputes.1 deleted file mode 100644 index 5a3c49bb75..0000000000 --- a/deps/npm/man/man1/disputes.1 +++ /dev/null @@ -1,145 +0,0 @@ -.\" Generated with Ronnjs 0.3.8 -.\" http://github.com/kapouer/ronnjs/ -. -.TH "NPM\-DISPUTES" "1" "July 2013" "" "" -. -.SH "NAME" -\fBnpm-disputes\fR \-\- Handling Module Name Disputes -. -.SH "SYNOPSIS" -. -.IP "1" 4 -Get the author email with \fBnpm owner ls <pkgname>\fR -. -.IP "2" 4 -Email the author, CC \fIi@izs\.me\fR\|\. -. -.IP "3" 4 -After a few weeks, if there\'s no resolution, we\'ll sort it out\. -. -.IP "" 0 -. -.P -Don\'t squat on package names\. Publish code or move out of the way\. -. -.SH "DESCRIPTION" -There sometimes arise cases where a user publishes a module, and then -later, some other user wants to use that name\. Here are some common -ways that happens (each of these is based on actual events\.) -. -.IP "1" 4 -Joe writes a JavaScript module \fBfoo\fR, which is not node\-specific\. -Joe doesn\'t use node at all\. Bob wants to use \fBfoo\fR in node, so he -wraps it in an npm module\. Some time later, Joe starts using node, -and wants to take over management of his program\. -. -.IP "2" 4 -Bob writes an npm module \fBfoo\fR, and publishes it\. Perhaps much -later, Joe finds a bug in \fBfoo\fR, and fixes it\. He sends a pull -request to Bob, but Bob doesn\'t have the time to deal with it, -because he has a new job and a new baby and is focused on his new -erlang project, and kind of not involved with node any more\. Joe -would like to publish a new \fBfoo\fR, but can\'t, because the name is -taken\. -. -.IP "3" 4 -Bob writes a 10\-line flow\-control library, and calls it \fBfoo\fR, and -publishes it to the npm registry\. Being a simple little thing, it -never really has to be updated\. Joe works for Foo Inc, the makers -of the critically acclaimed and widely\-marketed \fBfoo\fR JavaScript -toolkit framework\. They publish it to npm as \fBfoojs\fR, but people are -routinely confused when \fBnpm install foo\fR is some different thing\. -. -.IP "4" 4 -Bob writes a parser for the widely\-known \fBfoo\fR file format, because -he needs it for work\. Then, he gets a new job, and never updates the -prototype\. Later on, Joe writes a much more complete \fBfoo\fR parser, -but can\'t publish, because Bob\'s \fBfoo\fR is in the way\. -. -.IP "" 0 -. -.P -The validity of Joe\'s claim in each situation can be debated\. However, -Joe\'s appropriate course of action in each case is the same\. -. -.IP "1" 4 -\fBnpm owner ls foo\fR\|\. This will tell Joe the email address of the -owner (Bob)\. -. -.IP "2" 4 -Joe emails Bob, explaining the situation \fBas respectfully as possible\fR, -and what he would like to do with the module name\. He adds -isaacs \fIi@izs\.me\fR to the CC list of the email\. Mention in the email -that Bob can run \fBnpm owner add joe foo\fR to add Joe as an owner of -the \fBfoo\fR package\. -. -.IP "3" 4 -After a reasonable amount of time, if Bob has not responded, or if -Bob and Joe can\'t come to any sort of resolution, email isaacs \fIi@izs\.me\fR and we\'ll sort it out\. ("Reasonable" is usually about 4 -weeks, but extra time is allowed around common holidays\.) -. -.IP "" 0 -. -.SH "REASONING" -In almost every case so far, the parties involved have been able to reach -an amicable resolution without any major intervention\. Most people -really do want to be reasonable, and are probably not even aware that -they\'re in your way\. -. -.P -Module ecosystems are most vibrant and powerful when they are as -self\-directed as possible\. If an admin one day deletes something you -had worked on, then that is going to make most people quite upset, -regardless of the justification\. When humans solve their problems by -talking to other humans with respect, everyone has the chance to end up -feeling good about the interaction\. -. -.SH "EXCEPTIONS" -Some things are not allowed, and will be removed without discussion if -they are brought to the attention of the npm registry admins, including -but not limited to: -. -.IP "1" 4 -Malware (that is, a package designed to exploit or harm the machine on -which it is installed)\. -. -.IP "2" 4 -Violations of copyright or licenses (for example, cloning an -MIT\-licensed program, and then removing or changing the copyright and -license statement)\. -. -.IP "3" 4 -Illegal content\. -. -.IP "4" 4 -"Squatting" on a package name that you \fIplan\fR to use, but aren\'t -actually using\. Sorry, I don\'t care how great the name is, or how -perfect a fit it is for the thing that someday might happen\. If -someone wants to use it today, and you\'re just taking up space with -an empty tarball, you\'re going to be evicted\. -. -.IP "5" 4 -Putting empty packages in the registry\. Packages must have SOME -functionality\. It can be silly, but it can\'t be \fInothing\fR\|\. (See -also: squatting\.) -. -.IP "6" 4 -Doing weird things with the registry, like using it as your own -personal application database or otherwise putting non\-packagey -things into it\. -. -.IP "" 0 -. -.P -If you see bad behavior like this, please report it right away\. -. -.SH "SEE ALSO" -. -.IP "\(bu" 4 -npm help registry -. -.IP "\(bu" 4 -npm help owner -. -.IP "" 0 - diff --git a/deps/npm/man/man1/faq.1 b/deps/npm/man/man1/faq.1 deleted file mode 100644 index 04e0307f4f..0000000000 --- a/deps/npm/man/man1/faq.1 +++ /dev/null @@ -1,459 +0,0 @@ -.\" Generated with Ronnjs 0.3.8 -.\" http://github.com/kapouer/ronnjs/ -. -.TH "NPM\-FAQ" "1" "July 2013" "" "" -. -.SH "NAME" -\fBnpm-faq\fR \-\- Frequently Asked Questions -. -.SH "Where can I find these docs in HTML?" -\fIhttps://npmjs\.org/doc/\fR, or run: -. -.IP "" 4 -. -.nf -npm config set viewer browser -. -.fi -. -.IP "" 0 -. -.P -to open these documents in your default web browser rather than \fBman\fR\|\. -. -.SH "It didn't work\." -That\'s not really a question\. -. -.SH "Why didn't it work?" -I don\'t know yet\. -. -.P -Read the error output, and if you can\'t figure out what it means, -do what it says and post a bug with all the information it asks for\. -. -.SH "Where does npm put stuff?" -See \fBnpm help folders\fR -. -.P -tl;dr: -. -.IP "\(bu" 4 -Use the \fBnpm root\fR command to see where modules go, and the \fBnpm bin\fR -command to see where executables go -. -.IP "\(bu" 4 -Global installs are different from local installs\. If you install -something with the \fB\-g\fR flag, then its executables go in \fBnpm bin \-g\fR -and its modules go in \fBnpm root \-g\fR\|\. -. -.IP "" 0 -. -.SH "How do I install something on my computer in a central location?" -Install it globally by tacking \fB\-g\fR or \fB\-\-global\fR to the command\. (This -is especially important for command line utilities that need to add -their bins to the global system \fBPATH\fR\|\.) -. -.SH "I installed something globally, but I can't " -Install it locally\. -. -.P -The global install location is a place for command\-line utilities -to put their bins in the system \fBPATH\fR\|\. It\'s not for use with \fBrequire()\fR\|\. -. -.P -If you \fBrequire()\fR a module in your code, then that means it\'s a -dependency, and a part of your program\. You need to install it locally -in your program\. -. -.SH "Why can't npm just put everything in one place, like other package managers?" -Not every change is an improvement, but every improvement is a change\. -This would be like asking git to do network IO for every commit\. It\'s -not going to happen, because it\'s a terrible idea that causes more -problems than it solves\. -. -.P -It is much harder to avoid dependency conflicts without nesting -dependencies\. This is fundamental to the way that npm works, and has -proven to be an extremely successful approach\. See \fBnpm help folders\fR for -more details\. -. -.P -If you want a package to be installed in one place, and have all your -programs reference the same copy of it, then use the \fBnpm link\fR command\. -That\'s what it\'s for\. Install it globally, then link it into each -program that uses it\. -. -.SH "Whatever, I really want the old style 'everything global' style\." -Write your own package manager, then\. It\'s not that hard\. -. -.P -npm will not help you do something that is known to be a bad idea\. -. -.SH "Should I check my " -Mikeal Rogers answered this question very well: -. -.P -\fIhttp://www\.mikealrogers\.com/posts/nodemodules\-in\-git\.html\fR -. -.P -tl;dr -. -.IP "\(bu" 4 -Check \fBnode_modules\fR into git for things you \fBdeploy\fR, such as -websites and apps\. -. -.IP "\(bu" 4 -Do not check \fBnode_modules\fR into git for libraries and modules -intended to be reused\. -. -.IP "\(bu" 4 -Use npm to manage dependencies in your dev environment, but not in -your deployment scripts\. -. -.IP "" 0 -. -.SH "Is it 'npm' or 'NPM' or 'Npm'?" -npm should never be capitalized unless it is being displayed in a -location that is customarily all\-caps (such as the title of man pages\.) -. -.SH "If 'npm' is an acronym, why is it never capitalized?" -Contrary to the belief of many, "npm" is not in fact an abbreviation for -"Node Package Manager"\. It is a recursive bacronymic abbreviation for -"npm is not an acronym"\. (If it was "ninaa", then it would be an -acronym, and thus incorrectly named\.) -. -.P -"NPM", however, \fIis\fR an acronym (more precisely, a capitonym) for the -National Association of Pastoral Musicians\. You can learn more -about them at \fIhttp://npm\.org/\fR\|\. -. -.P -In software, "NPM" is a Non\-Parametric Mapping utility written by -Chris Rorden\. You can analyze pictures of brains with it\. Learn more -about the (capitalized) NPM program at \fIhttp://www\.cabiatl\.com/mricro/npm/\fR\|\. -. -.P -The first seed that eventually grew into this flower was a bash utility -named "pm", which was a shortened descendent of "pkgmakeinst", a -bash function that was used to install various different things on different -platforms, most often using Yahoo\'s \fByinst\fR\|\. If \fBnpm\fR was ever an -acronym for anything, it was \fBnode pm\fR or maybe \fBnew pm\fR\|\. -. -.P -So, in all seriousness, the "npm" project is named after its command\-line -utility, which was organically selected to be easily typed by a right\-handed -programmer using a US QWERTY keyboard layout, ending with the -right\-ring\-finger in a postition to type the \fB\-\fR key for flags and -other command\-line arguments\. That command\-line utility is always -lower\-case, though it starts most sentences it is a part of\. -. -.SH "How do I list installed packages?" -\fBnpm ls\fR -. -.SH "How do I search for packages?" -\fBnpm search\fR -. -.P -Arguments are greps\. \fBnpm search jsdom\fR shows jsdom packages\. -. -.SH "How do I update npm?" -. -.nf -npm update npm \-g -. -.fi -. -.P -You can also update all outdated local packages by doing \fBnpm update\fR without -any arguments, or global packages by doing \fBnpm update \-g\fR\|\. -. -.P -Occasionally, the version of npm will progress such that the current -version cannot be properly installed with the version that you have -installed already\. (Consider, if there is ever a bug in the \fBupdate\fR -command\.) -. -.P -In those cases, you can do this: -. -.IP "" 4 -. -.nf -curl https://npmjs\.org/install\.sh | sh -. -.fi -. -.IP "" 0 -. -.SH "What is a " -A package is: -. -.IP "\(bu" 4 -a) a folder containing a program described by a package\.json file -. -.IP "\(bu" 4 -b) a gzipped tarball containing (a) -. -.IP "\(bu" 4 -c) a url that resolves to (b) -. -.IP "\(bu" 4 -d) a \fB<name>@<version>\fR that is published on the registry with (c) -. -.IP "\(bu" 4 -e) a \fB<name>@<tag>\fR that points to (d) -. -.IP "\(bu" 4 -f) a \fB<name>\fR that has a "latest" tag satisfying (e) -. -.IP "\(bu" 4 -g) a \fBgit\fR url that, when cloned, results in (a)\. -. -.IP "" 0 -. -.P -Even if you never publish your package, you can still get a lot of -benefits of using npm if you just want to write a node program (a), and -perhaps if you also want to be able to easily install it elsewhere -after packing it up into a tarball (b)\. -. -.P -Git urls can be of the form: -. -.IP "" 4 -. -.nf -git://github\.com/user/project\.git#commit\-ish -git+ssh://user@hostname:project\.git#commit\-ish -git+http://user@hostname/project/blah\.git#commit\-ish -git+https://user@hostname/project/blah\.git#commit\-ish -. -.fi -. -.IP "" 0 -. -.P -The \fBcommit\-ish\fR can be any tag, sha, or branch which can be supplied as -an argument to \fBgit checkout\fR\|\. The default is \fBmaster\fR\|\. -. -.SH "What is a " -A module is anything that can be loaded with \fBrequire()\fR in a Node\.js -program\. The following things are all examples of things that can be -loaded as modules: -. -.IP "\(bu" 4 -A folder with a \fBpackage\.json\fR file containing a \fBmain\fR field\. -. -.IP "\(bu" 4 -A folder with an \fBindex\.js\fR file in it\. -. -.IP "\(bu" 4 -A JavaScript file\. -. -.IP "" 0 -. -.P -Most npm packages are modules, because they are libraries that you -load with \fBrequire\fR\|\. However, there\'s no requirement that an npm -package be a module! Some only contain an executable command\-line -interface, and don\'t provide a \fBmain\fR field for use in Node programs\. -. -.P -Almost all npm packages (at least, those that are Node programs) \fIcontain\fR many modules within them (because every file they load with \fBrequire()\fR is a module)\. -. -.P -In the context of a Node program, the \fBmodule\fR is also the thing that -was loaded \fIfrom\fR a file\. For example, in the following program: -. -.IP "" 4 -. -.nf -var req = require(\'request\') -. -.fi -. -.IP "" 0 -. -.P -we might say that "The variable \fBreq\fR refers to the \fBrequest\fR module"\. -. -.SH "So, why is it the "" -The \fBpackage\.json\fR file defines the package\. (See "What is a -package?" above\.) -. -.P -The \fBnode_modules\fR folder is the place Node\.js looks for modules\. -(See "What is a module?" above\.) -. -.P -For example, if you create a file at \fBnode_modules/foo\.js\fR and then -had a program that did \fBvar f = require(\'foo\.js\')\fR then it would load -the module\. However, \fBfoo\.js\fR is not a "package" in this case, -because it does not have a package\.json\. -. -.P -Alternatively, if you create a package which does not have an \fBindex\.js\fR or a \fB"main"\fR field in the \fBpackage\.json\fR file, then it is -not a module\. Even if it\'s installed in \fBnode_modules\fR, it can\'t be -an argument to \fBrequire()\fR\|\. -. -.SH "<code>"node_modules"</code>" -No\. This will never happen\. This question comes up sometimes, -because it seems silly from the outside that npm couldn\'t just be -configured to put stuff somewhere else, and then npm could load them -from there\. It\'s an arbitrary spelling choice, right? What\'s the big -deal? -. -.P -At the time of this writing, the string \fB\'node_modules\'\fR appears 151 -times in 53 separate files in npm and node core (excluding tests and -documentation)\. -. -.P -Some of these references are in node\'s built\-in module loader\. Since -npm is not involved \fBat all\fR at run\-time, node itself would have to -be configured to know where you\'ve decided to stick stuff\. Complexity -hurdle #1\. Since the Node module system is locked, this cannot be -changed, and is enough to kill this request\. But I\'ll continue, in -deference to your deity\'s delicate feelings regarding spelling\. -. -.P -Many of the others are in dependencies that npm uses, which are not -necessarily tightly coupled to npm (in the sense that they do not read -npm\'s configuration files, etc\.) Each of these would have to be -configured to take the name of the \fBnode_modules\fR folder as a -parameter\. Complexity hurdle #2\. -. -.P -Furthermore, npm has the ability to "bundle" dependencies by adding -the dep names to the \fB"bundledDependencies"\fR list in package\.json, -which causes the folder to be included in the package tarball\. What -if the author of a module bundles its dependencies, and they use a -different spelling for \fBnode_modules\fR? npm would have to rename the -folder at publish time, and then be smart enough to unpack it using -your locally configured name\. Complexity hurdle #3\. -. -.P -Furthermore, what happens when you \fIchange\fR this name? Fine, it\'s -easy enough the first time, just rename the \fBnode_modules\fR folders to \fB\|\./blergyblerp/\fR or whatever name you choose\. But what about when you -change it again? npm doesn\'t currently track any state about past -configuration settings, so this would be rather difficult to do -properly\. It would have to track every previous value for this -config, and always accept any of them, or else yesterday\'s install may -be broken tomorrow\. Complexity hurdle #5\. -. -.P -Never going to happen\. The folder is named \fBnode_modules\fR\|\. It is -written indelibly in the Node Way, handed down from the ancient times -of Node 0\.3\. -. -.SH "How do I install node with npm?" -You don\'t\. Try one of these node version managers: -. -.P -Unix: -. -.IP "\(bu" 4 -\fIhttp://github\.com/isaacs/nave\fR -. -.IP "\(bu" 4 -\fIhttp://github\.com/visionmedia/n\fR -. -.IP "\(bu" 4 -\fIhttp://github\.com/creationix/nvm\fR -. -.IP "" 0 -. -.P -Windows: -. -.IP "\(bu" 4 -\fIhttp://github\.com/marcelklehr/nodist\fR -. -.IP "\(bu" 4 -\fIhttps://github\.com/hakobera/nvmw\fR -. -.IP "" 0 -. -.SH "How can I use npm for development?" -See \fBnpm help developers\fR and \fBnpm help json\fR\|\. -. -.P -You\'ll most likely want to \fBnpm link\fR your development folder\. That\'s -awesomely handy\. -. -.P -To set up your own private registry, check out \fBnpm help registry\fR\|\. -. -.SH "Can I list a url as a dependency?" -Yes\. It should be a url to a gzipped tarball containing a single folder -that has a package\.json in its root, or a git url\. -(See "what is a package?" above\.) -. -.SH "How do I symlink to a dev folder so I don't have to keep re\-installing?" -See \fBnpm help link\fR -. -.SH "The package registry website\. What is that exactly?" -See \fBnpm help registry\fR\|\. -. -.SH "I forgot my password, and can't publish\. How do I reset it?" -Go to \fIhttps://npmjs\.org/forgot\fR\|\. -. -.SH "I get ECONNREFUSED a lot\. What's up?" -Either the registry is down, or node\'s DNS isn\'t able to reach out\. -. -.P -To check if the registry is down, open up \fIhttp://registry\.npmjs\.org/\fR -in a web browser\. This will also tell you if you are just unable to -access the internet for some reason\. -. -.P -If the registry IS down, let me know by emailing \fIi@izs\.me\fR or posting -an issue at \fIhttps://github\.com/isaacs/npm/issues\fR\|\. We\'ll have -someone kick it or something\. -. -.SH "Why no namespaces?" -Please see this discussion: \fIhttps://github\.com/isaacs/npm/issues/798\fR -. -.P -tl;dr \- It doesn\'t actually make things better, and can make them worse\. -. -.P -If you want to namespace your own packages, you may: simply use the \fB\-\fR character to separate the names\. npm is a mostly anarchic system\. -There is not sufficient need to impose namespace rules on everyone\. -. -.SH "Who does npm?" -\fBnpm view npm author\fR -. -.P -\fBnpm view npm contributors\fR -. -.SH "I have a question or request not addressed here\. Where should I put it?" -Post an issue on the github project: -. -.IP "\(bu" 4 -\fIhttps://github\.com/isaacs/npm/issues\fR -. -.IP "" 0 -. -.SH "Why does npm hate me?" -npm is not capable of hatred\. It loves everyone, especially you\. -. -.SH "SEE ALSO" -. -.IP "\(bu" 4 -npm help npm -. -.IP "\(bu" 4 -npm help developers -. -.IP "\(bu" 4 -npm help json -. -.IP "\(bu" 4 -npm help config -. -.IP "\(bu" 4 -npm help folders -. -.IP "" 0 - diff --git a/deps/npm/man/man1/find.1 b/deps/npm/man/man1/find.1 deleted file mode 100644 index 653597ffa8..0000000000 --- a/deps/npm/man/man1/find.1 +++ /dev/null @@ -1,72 +0,0 @@ -.\" Generated with Ronnjs/v0.1 -.\" http://github.com/kapouer/ronnjs/ -. -.TH "NPM\-SEARCH" "1" "November 2011" "" "" -. -.SH "NAME" -\fBnpm-search\fR \-\- Search for packages -. -.SH "SYNOPSIS" -. -.nf -npm search [search terms \.\.\.] -. -.fi -. -.SH "DESCRIPTION" -Search the registry for packages matching the search terms\. -. -.SH "CONFIGURATION" -. -.SS "description" -. -.IP "\(bu" 4 -Default: true -. -.IP "\(bu" 4 -Type: Boolean -. -.IP "" 0 -. -.P -Show the description in \fBnpm search\fR -. -.SS "searchopts" -. -.IP "\(bu" 4 -Default: "" -. -.IP "\(bu" 4 -Type: String -. -.IP "" 0 -. -.P -Space\-separated options that are always passed to search\. -. -.SS "searchexclude" -. -.IP "\(bu" 4 -Default: "" -. -.IP "\(bu" 4 -Type: String -. -.IP "" 0 -. -.P -Space\-separated options that limit the results from search\. -. -.SH "SEE ALSO" -. -.IP "\(bu" 4 -npm help registry -. -.IP "\(bu" 4 -npm help config -. -.IP "\(bu" 4 -npm help view -. -.IP "" 0 - diff --git a/deps/npm/man/man1/folders.1 b/deps/npm/man/man1/folders.1 deleted file mode 100644 index b213d52a65..0000000000 --- a/deps/npm/man/man1/folders.1 +++ /dev/null @@ -1,258 +0,0 @@ -.\" Generated with Ronnjs 0.3.8 -.\" http://github.com/kapouer/ronnjs/ -. -.TH "NPM\-FOLDERS" "1" "July 2013" "" "" -. -.SH "NAME" -\fBnpm-folders\fR \-\- Folder Structures Used by npm -. -.SH "DESCRIPTION" -npm puts various things on your computer\. That\'s its job\. -. -.P -This document will tell you what it puts where\. -. -.SS "tl;dr" -. -.IP "\(bu" 4 -Local install (default): puts stuff in \fB\|\./node_modules\fR of the current -package root\. -. -.IP "\(bu" 4 -Global install (with \fB\-g\fR): puts stuff in /usr/local or wherever node -is installed\. -. -.IP "\(bu" 4 -Install it \fBlocally\fR if you\'re going to \fBrequire()\fR it\. -. -.IP "\(bu" 4 -Install it \fBglobally\fR if you\'re going to run it on the command line\. -. -.IP "\(bu" 4 -If you need both, then install it in both places, or use \fBnpm link\fR\|\. -. -.IP "" 0 -. -.SS "prefix Configuration" -The \fBprefix\fR config defaults to the location where node is installed\. -On most systems, this is \fB/usr/local\fR, and most of the time is the same -as node\'s \fBprocess\.installPrefix\fR\|\. -. -.P -On windows, this is the exact location of the node\.exe binary\. On Unix -systems, it\'s one level up, since node is typically installed at \fB{prefix}/bin/node\fR rather than \fB{prefix}/node\.exe\fR\|\. -. -.P -When the \fBglobal\fR flag is set, npm installs things into this prefix\. -When it is not set, it uses the root of the current package, or the -current working directory if not in a package already\. -. -.SS "Node Modules" -Packages are dropped into the \fBnode_modules\fR folder under the \fBprefix\fR\|\. -When installing locally, this means that you can \fBrequire("packagename")\fR to load its main module, or \fBrequire("packagename/lib/path/to/sub/module")\fR to load other modules\. -. -.P -Global installs on Unix systems go to \fB{prefix}/lib/node_modules\fR\|\. -Global installs on Windows go to \fB{prefix}/node_modules\fR (that is, no \fBlib\fR folder\.) -. -.P -If you wish to \fBrequire()\fR a package, then install it locally\. -. -.SS "Executables" -When in global mode, executables are linked into \fB{prefix}/bin\fR on Unix, -or directly into \fB{prefix}\fR on Windows\. -. -.P -When in local mode, executables are linked into \fB\|\./node_modules/\.bin\fR so that they can be made available to scripts run -through npm\. (For example, so that a test runner will be in the path -when you run \fBnpm test\fR\|\.) -. -.SS "Man Pages" -When in global mode, man pages are linked into \fB{prefix}/share/man\fR\|\. -. -.P -When in local mode, man pages are not installed\. -. -.P -Man pages are not installed on Windows systems\. -. -.SS "Cache" -See \fBnpm help cache\fR\|\. Cache files are stored in \fB~/\.npm\fR on Posix, or \fB~/npm\-cache\fR on Windows\. -. -.P -This is controlled by the \fBcache\fR configuration param\. -. -.SS "Temp Files" -Temporary files are stored by default in the folder specified by the \fBtmp\fR config, which defaults to the TMPDIR, TMP, or TEMP environment -variables, or \fB/tmp\fR on Unix and \fBc:\\windows\\temp\fR on Windows\. -. -.P -Temp files are given a unique folder under this root for each run of the -program, and are deleted upon successful exit\. -. -.SH "More Information" -When installing locally, npm first tries to find an appropriate \fBprefix\fR folder\. This is so that \fBnpm install foo@1\.2\.3\fR will install -to the sensible root of your package, even if you happen to have \fBcd\fRed -into some other folder\. -. -.P -Starting at the $PWD, npm will walk up the folder tree checking for a -folder that contains either a \fBpackage\.json\fR file, or a \fBnode_modules\fR -folder\. If such a thing is found, then that is treated as the effective -"current directory" for the purpose of running npm commands\. (This -behavior is inspired by and similar to git\'s \.git\-folder seeking -logic when running git commands in a working dir\.) -. -.P -If no package root is found, then the current folder is used\. -. -.P -When you run \fBnpm install foo@1\.2\.3\fR, then the package is loaded into -the cache, and then unpacked into \fB\|\./node_modules/foo\fR\|\. Then, any of -foo\'s dependencies are similarly unpacked into \fB\|\./node_modules/foo/node_modules/\.\.\.\fR\|\. -. -.P -Any bin files are symlinked to \fB\|\./node_modules/\.bin/\fR, so that they may -be found by npm scripts when necessary\. -. -.SS "Global Installation" -If the \fBglobal\fR configuration is set to true, then npm will -install packages "globally"\. -. -.P -For global installation, packages are installed roughly the same way, -but using the folders described above\. -. -.SS "Cycles, Conflicts, and Folder Parsimony" -Cycles are handled using the property of node\'s module system that it -walks up the directories looking for \fBnode_modules\fR folders\. So, at every -stage, if a package is already installed in an ancestor \fBnode_modules\fR -folder, then it is not installed at the current location\. -. -.P -Consider the case above, where \fBfoo \-> bar \-> baz\fR\|\. Imagine if, in -addition to that, baz depended on bar, so you\'d have: \fBfoo \-> bar \-> baz \-> bar \-> baz \.\.\.\fR\|\. However, since the folder -structure is: \fBfoo/node_modules/bar/node_modules/baz\fR, there\'s no need to -put another copy of bar into \fB\|\.\.\./baz/node_modules\fR, since when it calls -require("bar"), it will get the copy that is installed in \fBfoo/node_modules/bar\fR\|\. -. -.P -This shortcut is only used if the exact same -version would be installed in multiple nested \fBnode_modules\fR folders\. It -is still possible to have \fBa/node_modules/b/node_modules/a\fR if the two -"a" packages are different versions\. However, without repeating the -exact same package multiple times, an infinite regress will always be -prevented\. -. -.P -Another optimization can be made by installing dependencies at the -highest level possible, below the localized "target" folder\. -. -.SS "\fIExample\fR" -Consider this dependency graph: -. -.IP "" 4 -. -.nf -foo -+\-\- blerg@1\.2\.5 -+\-\- bar@1\.2\.3 -| +\-\- blerg@1\.x (latest=1\.3\.7) -| +\-\- baz@2\.x -| | `\-\- quux@3\.x -| | `\-\- bar@1\.2\.3 (cycle) -| `\-\- asdf@* -`\-\- baz@1\.2\.3 - `\-\- quux@3\.x - `\-\- bar -. -.fi -. -.IP "" 0 -. -.P -In this case, we might expect a folder structure like this: -. -.IP "" 4 -. -.nf -foo -+\-\- node_modules - +\-\- blerg (1\.2\.5) <\-\-\-[A] - +\-\- bar (1\.2\.3) <\-\-\-[B] - | `\-\- node_modules - | +\-\- baz (2\.0\.2) <\-\-\-[C] - | | `\-\- node_modules - | | `\-\- quux (3\.2\.0) - | `\-\- asdf (2\.3\.4) - `\-\- baz (1\.2\.3) <\-\-\-[D] - `\-\- node_modules - `\-\- quux (3\.2\.0) <\-\-\-[E] -. -.fi -. -.IP "" 0 -. -.P -Since foo depends directly on \fBbar@1\.2\.3\fR and \fBbaz@1\.2\.3\fR, those are -installed in foo\'s \fBnode_modules\fR folder\. -. -.P -Even though the latest copy of blerg is 1\.3\.7, foo has a specific -dependency on version 1\.2\.5\. So, that gets installed at [A]\. Since the -parent installation of blerg satisfies bar\'s dependency on \fBblerg@1\.x\fR, -it does not install another copy under [B]\. -. -.P -Bar [B] also has dependencies on baz and asdf, so those are installed in -bar\'s \fBnode_modules\fR folder\. Because it depends on \fBbaz@2\.x\fR, it cannot -re\-use the \fBbaz@1\.2\.3\fR installed in the parent \fBnode_modules\fR folder [D], -and must install its own copy [C]\. -. -.P -Underneath bar, the \fBbaz \-> quux \-> bar\fR dependency creates a cycle\. -However, because bar is already in quux\'s ancestry [B], it does not -unpack another copy of bar into that folder\. -. -.P -Underneath \fBfoo \-> baz\fR [D], quux\'s [E] folder tree is empty, because its -dependency on bar is satisfied by the parent folder copy installed at [B]\. -. -.P -For a graphical breakdown of what is installed where, use \fBnpm ls\fR\|\. -. -.SS "Publishing" -Upon publishing, npm will look in the \fBnode_modules\fR folder\. If any of -the items there are not in the \fBbundledDependencies\fR array, then they will -not be included in the package tarball\. -. -.P -This allows a package maintainer to install all of their dependencies -(and dev dependencies) locally, but only re\-publish those items that -cannot be found elsewhere\. See \fBnpm help json\fR for more information\. -. -.SH "SEE ALSO" -. -.IP "\(bu" 4 -npm help faq -. -.IP "\(bu" 4 -npm help json -. -.IP "\(bu" 4 -npm help install -. -.IP "\(bu" 4 -npm help pack -. -.IP "\(bu" 4 -npm help cache -. -.IP "\(bu" 4 -npm help config -. -.IP "\(bu" 4 -npm help publish -. -.IP "" 0 - diff --git a/deps/npm/man/man1/get.1 b/deps/npm/man/man1/get.1 deleted file mode 100644 index 5075c9f0cc..0000000000 --- a/deps/npm/man/man1/get.1 +++ /dev/null @@ -1,1154 +0,0 @@ -.\" Generated with Ronnjs/v0.1 -.\" http://github.com/kapouer/ronnjs/ -. -.TH "NPM\-CONFIG" "1" "November 2011" "" "" -. -.SH "NAME" -\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> -npm config list -npm config edit -npm get <key> -npm set <key> <value> [\-\-global] -. -.fi -. -.SH "DESCRIPTION" -npm gets its configuration values from 6 sources, in this priority: -. -.SS "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\|\. -. -.SS "Environment Variables" -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\. -. -.SS "Per\-user config file" -\fB$HOME/\.npmrc\fR (or the \fBuserconfig\fR param, if set above) -. -.P -This file is an ini\-file formatted list of \fBkey = value\fR parameters\. -. -.SS "Global config file" -\fB$PREFIX/etc/npmrc\fR (or the \fBglobalconfig\fR param, if set above): -This file is an ini\-file formatted list of \fBkey = value\fR parameters -. -.SS "Built\-in config file" -\fBpath/to/npm/itself/npmrc\fR -. -.P -This is an unchangeable "builtin" -configuration file that npm keeps consistent across updates\. Set -fields in here using the \fB\|\./configure\fR script that comes with npm\. -This is primarily for distribution maintainers to override default -configs in a standard and consistent manner\. -. -.SS "Default Configs" -A set of configuration parameters that are internal to npm, and are -defaults if nothing else is specified\. -. -.SH "Sub\-commands" -Config supports the following sub\-commands: -. -.SS "set" -. -.nf -npm config set key value -. -.fi -. -.P -Sets the config key to the value\. -. -.P -If value is omitted, then it sets it to "true"\. -. -.SS "get" -. -.nf -npm config get key -. -.fi -. -.P -Echo the config value to stdout\. -. -.SS "list" -. -.nf -npm config list -. -.fi -. -.P -Show all the config settings\. -. -.SS "delete" -. -.nf -npm config delete key -. -.fi -. -.P -Deletes the key from all configuration files\. -. -.SS "edit" -. -.nf -npm config edit -. -.fi -. -.P -Opens the config file in an editor\. Use the \fB\-\-global\fR flag to edit the -global config\. -. -.SH "Shorthands and Other CLI Niceties" -The following shorthands are parsed on the command\-line: -. -.IP "\(bu" 4 -\fB\-v\fR: \fB\-\-version\fR -. -.IP "\(bu" 4 -\fB\-h\fR, \fB\-?\fR, \fB\-\-help\fR, \fB\-H\fR: \fB\-\-usage\fR -. -.IP "\(bu" 4 -\fB\-s\fR, \fB\-\-silent\fR: \fB\-\-loglevel silent\fR -. -.IP "\(bu" 4 -\fB\-d\fR: \fB\-\-loglevel info\fR -. -.IP "\(bu" 4 -\fB\-dd\fR, \fB\-\-verbose\fR: \fB\-\-loglevel verbose\fR -. -.IP "\(bu" 4 -\fB\-ddd\fR: \fB\-\-loglevel silly\fR -. -.IP "\(bu" 4 -\fB\-g\fR: \fB\-\-global\fR -. -.IP "\(bu" 4 -\fB\-l\fR: \fB\-\-long\fR -. -.IP "\(bu" 4 -\fB\-m\fR: \fB\-\-message\fR -. -.IP "\(bu" 4 -\fB\-p\fR, \fB\-\-porcelain\fR: \fB\-\-parseable\fR -. -.IP "\(bu" 4 -\fB\-reg\fR: \fB\-\-registry\fR -. -.IP "\(bu" 4 -\fB\-v\fR: \fB\-\-version\fR -. -.IP "\(bu" 4 -\fB\-f\fR: \fB\-\-force\fR -. -.IP "\(bu" 4 -\fB\-l\fR: \fB\-\-long\fR -. -.IP "\(bu" 4 -\fB\-desc\fR: \fB\-\-description\fR -. -.IP "\(bu" 4 -\fB\-S\fR: \fB\-\-save\fR -. -.IP "\(bu" 4 -\fB\-y\fR: \fB\-\-yes\fR -. -.IP "\(bu" 4 -\fB\-n\fR: \fB\-\-yes false\fR -. -.IP "\(bu" 4 -\fBll\fR and \fBla\fR commands: \fBls \-\-long\fR -. -.IP "" 0 -. -.P -If the specified configuration param resolves unambiguously to a known -configuration parameter, then it is expanded to that configuration -parameter\. For example: -. -.IP "" 4 -. -.nf -npm ls \-\-par -# same as: -npm ls \-\-parseable -. -.fi -. -.IP "" 0 -. -.P -If multiple single\-character shorthands are strung together, and the -resulting combination is unambiguously not some other configuration -param, then it is expanded to its various component pieces\. For -example: -. -.IP "" 4 -. -.nf -npm ls \-gpld -# same as: -npm ls \-\-global \-\-parseable \-\-long \-\-loglevel info -. -.fi -. -.IP "" 0 -. -.SH "Per\-Package Config Settings" -When running scripts (see \fBnpm help scripts\fR) -the package\.json "config" keys are overwritten in the environment if -there is a config param of \fB<name>[@<version>]:<key>\fR\|\. For example, if -the package\.json has this: -. -.IP "" 4 -. -.nf -{ "name" : "foo" -, "config" : { "port" : "8080" } -, "scripts" : { "start" : "node server\.js" } } -. -.fi -. -.IP "" 0 -. -.P -and the server\.js is this: -. -.IP "" 4 -. -.nf -http\.createServer(\.\.\.)\.listen(process\.env\.npm_package_config_port) -. -.fi -. -.IP "" 0 -. -.P -then the user could change the behavior by doing: -. -.IP "" 4 -. -.nf -npm config set foo:port 80 -. -.fi -. -.IP "" 0 -. -.SH "Config Settings" -. -.SS "always\-auth" -. -.IP "\(bu" 4 -Default: false -. -.IP "\(bu" 4 -Type: Boolean -. -.IP "" 0 -. -.P -Force npm to always require authentication when accessing the registry, -even for \fBGET\fR requests\. -. -.SS "bin\-publish" -. -.IP "\(bu" 4 -Default: false -. -.IP "\(bu" 4 -Type: Boolean -. -.IP "" 0 -. -.P -If set to true, then binary packages will be created on publish\. -. -.P -This is the way to opt into the "bindist" behavior described below\. -. -.SS "bindist" -. -.IP "\(bu" 4 -Default: Unstable node versions, \fBnull\fR, otherwise \fB"<node version>\-<platform>\-<os release>"\fR -. -.IP "\(bu" 4 -Type: String or \fBnull\fR -. -.IP "" 0 -. -.P -Experimental: on stable versions of node, binary distributions will be -created with this tag\. If a user then installs that package, and their \fBbindist\fR tag is found in the list of binary distributions, they will -get that prebuilt version\. -. -.P -Pre\-build node packages have their preinstall, install, and postinstall -scripts stripped (since they are run prior to publishing), and do not -have their \fBbuild\fR directories automatically ignored\. -. -.P -It\'s yet to be seen if this is a good idea\. -. -.SS "browser" -. -.IP "\(bu" 4 -Default: OS X: \fB"open"\fR, others: \fB"google\-chrome"\fR -. -.IP "\(bu" 4 -Type: String -. -.IP "" 0 -. -.P -The browser that is called by the \fBnpm docs\fR command to open websites\. -. -.SS "ca" -. -.IP "\(bu" 4 -Default: The npm CA certificate -. -.IP "\(bu" 4 -Type: String or null -. -.IP "" 0 -. -.P -The Certificate Authority signing certificate that is trusted for SSL -connections to the registry\. -. -.P -Set to \fBnull\fR to only allow "known" registrars, or to a specific CA cert -to trust only that specific signing authority\. -. -.P -See also the \fBstrict\-ssl\fR config\. -. -.SS "cache" -. -.IP "\(bu" 4 -Default: Windows: \fB~/npm\-cache\fR, Posix: \fB~/\.npm\fR -. -.IP "\(bu" 4 -Type: path -. -.IP "" 0 -. -.P -The location of npm\'s cache directory\. See \fBnpm help cache\fR -. -.SS "color" -. -.IP "\(bu" 4 -Default: true on Posix, false on Windows -. -.IP "\(bu" 4 -Type: Boolean or \fB"always"\fR -. -.IP "" 0 -. -.P -If false, never shows colors\. If \fB"always"\fR then always shows colors\. -If true, then only prints color codes for tty file descriptors\. -. -.SS "depth" -. -.IP "\(bu" 4 -Default: Infinity -. -.IP "\(bu" 4 -Type: Number -. -.IP "" 0 -. -.P -The depth to go when recursing directories for \fBnpm ls\fR and \fBnpm cache ls\fR\|\. -. -.SS "description" -. -.IP "\(bu" 4 -Default: true -. -.IP "\(bu" 4 -Type: Boolean -. -.IP "" 0 -. -.P -Show the description in \fBnpm search\fR -. -.SS "dev" -. -.IP "\(bu" 4 -Default: false -. -.IP "\(bu" 4 -Type: Boolean -. -.IP "" 0 -. -.P -Install \fBdev\-dependencies\fR along with packages\. -. -.P -Note that \fBdev\-dependencies\fR are also installed if the \fBnpat\fR flag is -set\. -. -.SS "editor" -. -.IP "\(bu" 4 -Default: \fBEDITOR\fR environment variable if set, or \fB"vi"\fR on Posix, -or \fB"notepad"\fR on Windows\. -. -.IP "\(bu" 4 -Type: path -. -.IP "" 0 -. -.P -The command to run for \fBnpm edit\fR or \fBnpm config edit\fR\|\. -. -.SS "force" -. -.IP "\(bu" 4 -Default: false -. -.IP "\(bu" 4 -Type: Boolean -. -.IP "" 0 -. -.P -Makes various commands more forceful\. -. -.IP "\(bu" 4 -lifecycle script failure does not block progress\. -. -.IP "\(bu" 4 -publishing clobbers previously published versions\. -. -.IP "\(bu" 4 -skips cache when requesting from the registry\. -. -.IP "\(bu" 4 -prevents checks against clobbering non\-npm files\. -. -.IP "" 0 -. -.SS "global" -. -.IP "\(bu" 4 -Default: false -. -.IP "\(bu" 4 -Type: Boolean -. -.IP "" 0 -. -.P -Operates in "global" mode, so that packages are installed into the \fBprefix\fR folder instead of the current working directory\. See \fBnpm help folders\fR for more on the differences in behavior\. -. -.IP "\(bu" 4 -packages are installed into the \fBprefix/node_modules\fR folder, instead of the -current working directory\. -. -.IP "\(bu" 4 -bin files are linked to \fBprefix/bin\fR -. -.IP "\(bu" 4 -man pages are linked to \fBprefix/share/man\fR -. -.IP "" 0 -. -.SS "globalconfig" -. -.IP "\(bu" 4 -Default: {prefix}/etc/npmrc -. -.IP "\(bu" 4 -Type: path -. -.IP "" 0 -. -.P -The config file to read for global config options\. -. -.SS "globalignorefile" -. -.IP "\(bu" 4 -Default: {prefix}/etc/npmignore -. -.IP "\(bu" 4 -Type: path -. -.IP "" 0 -. -.P -The config file to read for global ignore patterns to apply to all users -and all projects\. -. -.P -If not found, but there is a "gitignore" file in the -same directory, then that will be used instead\. -. -.SS "group" -. -.IP "\(bu" 4 -Default: GID of the current process -. -.IP "\(bu" 4 -Type: String or Number -. -.IP "" 0 -. -.P -The group to use when running package scripts in global mode as the root -user\. -. -.SS "https\-proxy" -. -.IP "\(bu" 4 -Default: the \fBHTTPS_PROXY\fR or \fBhttps_proxy\fR or \fBHTTP_PROXY\fR or \fBhttp_proxy\fR environment variables\. -. -.IP "\(bu" 4 -Type: url -. -.IP "" 0 -. -.P -A proxy to use for outgoing https requests\. -. -.SS "ignore" -. -.IP "\(bu" 4 -Default: "" -. -.IP "\(bu" 4 -Type: string -. -.IP "" 0 -. -.P -A white\-space separated list of glob patterns of files to always exclude -from packages when building tarballs\. -. -.SS "init\.version" -. -.IP "\(bu" 4 -Default: "0\.0\.0" -. -.IP "\(bu" 4 -Type: semver -. -.IP "" 0 -. -.P -The value \fBnpm init\fR should use by default for the package version\. -. -.SS "init\.author\.name" -. -.IP "\(bu" 4 -Default: "0\.0\.0" -. -.IP "\(bu" 4 -Type: String -. -.IP "" 0 -. -.P -The value \fBnpm init\fR should use by default for the package author\'s name\. -. -.SS "init\.author\.email" -. -.IP "\(bu" 4 -Default: "" -. -.IP "\(bu" 4 -Type: String -. -.IP "" 0 -. -.P -The value \fBnpm init\fR should use by default for the package author\'s email\. -. -.SS "init\.author\.url" -. -.IP "\(bu" 4 -Default: "" -. -.IP "\(bu" 4 -Type: String -. -.IP "" 0 -. -.P -The value \fBnpm init\fR should use by default for the package author\'s homepage\. -. -.SS "link" -. -.IP "\(bu" 4 -Default: false -. -.IP "\(bu" 4 -Type: Boolean -. -.IP "" 0 -. -.P -If true, then local installs will link if there is a suitable globally -installed package\. -. -.P -Note that this means that local installs can cause things to be -installed into the global space at the same time\. The link is only done -if one of the two conditions are met: -. -.IP "\(bu" 4 -The package is not already installed globally, or -. -.IP "\(bu" 4 -the globally installed version is identical to the version that is -being installed locally\. -. -.IP "" 0 -. -.SS "logfd" -. -.IP "\(bu" 4 -Default: stderr file descriptor -. -.IP "\(bu" 4 -Type: Number or Stream -. -.IP "" 0 -. -.P -The location to write log output\. -. -.SS "loglevel" -. -.IP "\(bu" 4 -Default: "warn" -. -.IP "\(bu" 4 -Type: String -. -.IP "\(bu" 4 -Values: "silent", "win", "error", "warn", "info", "verbose", "silly" -. -.IP "" 0 -. -.P -What level of logs to report\. On failure, \fIall\fR logs are written to \fBnpm\-debug\.log\fR in the current working directory\. -. -.SS "logprefix" -. -.IP "\(bu" 4 -Default: true on Posix, false on Windows -. -.IP "\(bu" 4 -Type: Boolean -. -.IP "" 0 -. -.P -Whether or not to prefix log messages with "npm" and the log level\. See -also "color" and "loglevel"\. -. -.SS "long" -. -.IP "\(bu" 4 -Default: false -. -.IP "\(bu" 4 -Type: Boolean -. -.IP "" 0 -. -.P -Show extended information in \fBnpm ls\fR -. -.SS "message" -. -.IP "\(bu" 4 -Default: "%s" -. -.IP "\(bu" 4 -Type: String -. -.IP "" 0 -. -.P -Commit message which is used by \fBnpm version\fR when creating version commit\. -. -.P -Any "%s" in the message will be replaced with the version number\. -. -.SS "node\-version" -. -.IP "\(bu" 4 -Default: process\.version -. -.IP "\(bu" 4 -Type: semver or false -. -.IP "" 0 -. -.P -The node version to use when checking package\'s "engines" hash\. -. -.SS "npat" -. -.IP "\(bu" 4 -Default: false -. -.IP "\(bu" 4 -Type: Boolean -. -.IP "" 0 -. -.P -Run tests on installation and report results to the \fBnpaturl\fR\|\. -. -.SS "npaturl" -. -.IP "\(bu" 4 -Default: Not yet implemented -. -.IP "\(bu" 4 -Type: url -. -.IP "" 0 -. -.P -The url to report npat test results\. -. -.SS "onload\-script" -. -.IP "\(bu" 4 -Default: false -. -.IP "\(bu" 4 -Type: path -. -.IP "" 0 -. -.P -A node module to \fBrequire()\fR when npm loads\. Useful for programmatic -usage\. -. -.SS "outfd" -. -.IP "\(bu" 4 -Default: standard output file descriptor -. -.IP "\(bu" 4 -Type: Number or Stream -. -.IP "" 0 -. -.P -Where to write "normal" output\. This has no effect on log output\. -. -.SS "parseable" -. -.IP "\(bu" 4 -Default: false -. -.IP "\(bu" 4 -Type: Boolean -. -.IP "" 0 -. -.P -Output parseable results from commands that write to -standard output\. -. -.SS "prefix" -. -.IP "\(bu" 4 -Default: node\'s process\.installPrefix -. -.IP "\(bu" 4 -Type: path -. -.IP "" 0 -. -.P -The location to install global items\. If set on the command line, then -it forces non\-global commands to run in the specified folder\. -. -.SS "production" -. -.IP "\(bu" 4 -Default: false -. -.IP "\(bu" 4 -Type: Boolean -. -.IP "" 0 -. -.P -Set to true to run in "production" mode\. -. -.IP "1" 4 -devDependencies are not installed at the topmost level when running -local \fBnpm install\fR without any arguments\. -. -.IP "2" 4 -Set the NODE_ENV="production" for lifecycle scripts\. -. -.IP "" 0 -. -.SS "proxy" -. -.IP "\(bu" 4 -Default: \fBHTTP_PROXY\fR or \fBhttp_proxy\fR environment variable, or null -. -.IP "\(bu" 4 -Type: url -. -.IP "" 0 -. -.P -A proxy to use for outgoing http requests\. -. -.SS "rebuild\-bundle" -. -.IP "\(bu" 4 -Default: true -. -.IP "\(bu" 4 -Type: Boolean -. -.IP "" 0 -. -.P -Rebuild bundled dependencies after installation\. -. -.SS "registry" -. -.IP "\(bu" 4 -Default: https://registry\.npmjs\.org/ -. -.IP "\(bu" 4 -Type: url -. -.IP "" 0 -. -.P -The base URL of the npm package registry\. -. -.SS "rollback" -. -.IP "\(bu" 4 -Default: true -. -.IP "\(bu" 4 -Type: Boolean -. -.IP "" 0 -. -.P -Remove failed installs\. -. -.SS "save" -. -.IP "\(bu" 4 -Default: false -. -.IP "\(bu" 4 -Type: Boolean -. -.IP "" 0 -. -.P -Save installed packages to a package\.json file as dependencies\. -. -.P -Only works if there is already a package\.json file present\. -. -.SS "searchopts" -. -.IP "\(bu" 4 -Default: "" -. -.IP "\(bu" 4 -Type: String -. -.IP "" 0 -. -.P -Space\-separated options that are always passed to search\. -. -.SS "searchexclude" -. -.IP "\(bu" 4 -Default: "" -. -.IP "\(bu" 4 -Type: String -. -.IP "" 0 -. -.P -Space\-separated options that limit the results from search\. -. -.SS "shell" -. -.IP "\(bu" 4 -Default: SHELL environment variable, or "bash" on Posix, or "cmd" on -Windows -. -.IP "\(bu" 4 -Type: path -. -.IP "" 0 -. -.P -The shell to run for the \fBnpm explore\fR command\. -. -.SS "strict\-ssl" -. -.IP "\(bu" 4 -Default: true -. -.IP "\(bu" 4 -Type: Boolean -. -.IP "" 0 -. -.P -Whether or not to do SSL key validation when making requests to the -registry via https\. -. -.P -See also the \fBca\fR config\. -. -.SS "tag" -. -.IP "\(bu" 4 -Default: latest -. -.IP "\(bu" 4 -Type: String -. -.IP "" 0 -. -.P -If you ask npm to install a package and don\'t tell it a specific version, then -it will install the specified tag\. -. -.P -Also the tag that is added to the package@version specified by the \fBnpm -tag\fR command, if no explicit tag is given\. -. -.SS "tmp" -. -.IP "\(bu" 4 -Default: TMPDIR environment variable, or "/tmp" -. -.IP "\(bu" 4 -Type: path -. -.IP "" 0 -. -.P -Where to store temporary files and folders\. All temp files are deleted -on success, but left behind on failure for forensic purposes\. -. -.SS "unicode" -. -.IP "\(bu" 4 -Default: true -. -.IP "\(bu" 4 -Type: Boolean -. -.IP "" 0 -. -.P -When set to true, npm uses unicode characters in the tree output\. When -false, it uses ascii characters to draw trees\. -. -.SS "unsafe\-perm" -. -.IP "\(bu" 4 -Default: false if running as root, true otherwise -. -.IP "\(bu" 4 -Type: Boolean -. -.IP "" 0 -. -.P -Set to true to suppress the UID/GID switching when running package -scripts\. If set explicitly to false, then installing as a non\-root user -will fail\. -. -.SS "usage" -. -.IP "\(bu" 4 -Default: false -. -.IP "\(bu" 4 -Type: Boolean -. -.IP "" 0 -. -.P -Set to show short usage output (like the \-H output) -instead of complete help when doing \fBnpm help help\fR\|\. -. -.SS "user" -. -.IP "\(bu" 4 -Default: "nobody" -. -.IP "\(bu" 4 -Type: String or Number -. -.IP "" 0 -. -.P -The UID to set to when running package scripts as root\. -. -.SS "username" -. -.IP "\(bu" 4 -Default: null -. -.IP "\(bu" 4 -Type: String -. -.IP "" 0 -. -.P -The username on the npm registry\. Set with \fBnpm adduser\fR -. -.SS "userconfig" -. -.IP "\(bu" 4 -Default: ~/\.npmrc -. -.IP "\(bu" 4 -Type: path -. -.IP "" 0 -. -.P -The location of user\-level configuration settings\. -. -.SS "userignorefile" -. -.IP "\(bu" 4 -Default: ~/\.npmignore -. -.IP "\(bu" 4 -Type: path -. -.IP "" 0 -. -.P -The location of a user\-level ignore file to apply to all packages\. -. -.P -If not found, but there is a \.gitignore file in the same directory, then -that will be used instead\. -. -.SS "umask" -. -.IP "\(bu" 4 -Default: 022 -. -.IP "\(bu" 4 -Type: Octal numeric string -. -.IP "" 0 -. -.P -The "umask" value to use when setting the file creation mode on files -and folders\. -. -.P -Folders and executables are given a mode which is \fB0777\fR masked against -this value\. Other files are given a mode which is \fB0666\fR masked against -this value\. Thus, the defaults are \fB0755\fR and \fB0644\fR respectively\. -. -.SS "version" -. -.IP "\(bu" 4 -Default: false -. -.IP "\(bu" 4 -Type: boolean -. -.IP "" 0 -. -.P -If true, output the npm version and exit successfully\. -. -.P -Only relevant when specified explicitly on the command line\. -. -.SS "viewer" -. -.IP "\(bu" 4 -Default: "man" on Posix, "browser" on Windows -. -.IP "\(bu" 4 -Type: path -. -.IP "" 0 -. -.P -The program to use to view help content\. -. -.P -Set to \fB"browser"\fR to view html help content in the default web browser\. -. -.SS "yes" -. -.IP "\(bu" 4 -Default: null -. -.IP "\(bu" 4 -Type: Boolean or null -. -.IP "" 0 -. -.P -If set to \fBnull\fR, then prompt the user for responses in some -circumstances\. -. -.P -If set to \fBtrue\fR, then answer "yes" to any prompt\. If set to \fBfalse\fR -then answer "no" to any prompt\. -. -.SH "SEE ALSO" -. -.IP "\(bu" 4 -npm help folders -. -.IP "\(bu" 4 -npm help npm -. -.IP "" 0 - diff --git a/deps/npm/man/man1/global.1 b/deps/npm/man/man1/global.1 deleted file mode 100644 index ddd14dd882..0000000000 --- a/deps/npm/man/man1/global.1 +++ /dev/null @@ -1,258 +0,0 @@ -.\" Generated with Ronnjs 0.3.8 -.\" http://github.com/kapouer/ronnjs/ -. -.TH "NPM\-FOLDERS" "1" "July 2013" "" "" -. -.SH "NAME" -\fBnpm-folders\fR \-\- Folder Structures Used by npm -. -.SH "DESCRIPTION" -npm puts various things on your computer\. That\'s its job\. -. -.P -This document will tell you what it puts where\. -. -.SS "tl;dr" -. -.IP "\(bu" 4 -Local install (default): puts stuff in \fB\|\./node_modules\fR of the current -package root\. -. -.IP "\(bu" 4 -Global install (with \fB\-g\fR): puts stuff in /usr/local or wherever node -is installed\. -. -.IP "\(bu" 4 -Install it \fBlocally\fR if you\'re going to \fBrequire()\fR it\. -. -.IP "\(bu" 4 -Install it \fBglobally\fR if you\'re going to run it on the command line\. -. -.IP "\(bu" 4 -If you need both, then install it in both places, or use \fBnpm link\fR\|\. -. -.IP "" 0 -. -.SS "prefix Configuration" -The \fBprefix\fR config defaults to the location where node is installed\. -On most systems, this is \fB/usr/local\fR, and most of the time is the same -as node\'s \fBprocess\.installPrefix\fR\|\. -. -.P -On windows, this is the exact location of the node\.exe binary\. On Unix -systems, it\'s one level up, since node is typically installed at \fB{prefix}/bin/node\fR rather than \fB{prefix}/node\.exe\fR\|\. -. -.P -When the \fBglobal\fR flag is set, npm installs things into this prefix\. -When it is not set, it uses the root of the current package, or the -current working directory if not in a package already\. -. -.SS "Node Modules" -Packages are dropped into the \fBnode_modules\fR folder under the \fBprefix\fR\|\. -When installing locally, this means that you can \fBrequire("packagename")\fR to load its main module, or \fBrequire("packagename/lib/path/to/sub/module")\fR to load other modules\. -. -.P -Global installs on Unix systems go to \fB{prefix}/lib/node_modules\fR\|\. -Global installs on Windows go to \fB{prefix}/node_modules\fR (that is, no \fBlib\fR folder\.) -. -.P -If you wish to \fBrequire()\fR a package, then install it locally\. -. -.SS "Executables" -When in global mode, executables are linked into \fB{prefix}/bin\fR on Unix, -or directly into \fB{prefix}\fR on Windows\. -. -.P -When in local mode, executables are linked into \fB\|\./node_modules/\.bin\fR so that they can be made available to scripts run -through npm\. (For example, so that a test runner will be in the path -when you run \fBnpm test\fR\|\.) -. -.SS "Man Pages" -When in global mode, man pages are linked into \fB{prefix}/share/man\fR\|\. -. -.P -When in local mode, man pages are not installed\. -. -.P -Man pages are not installed on Windows systems\. -. -.SS "Cache" -See \fBnpm help cache\fR\|\. Cache files are stored in \fB~/\.npm\fR on Posix, or \fB~/npm\-cache\fR on Windows\. -. -.P -This is controlled by the \fBcache\fR configuration param\. -. -.SS "Temp Files" -Temporary files are stored by default in the folder specified by the \fBtmp\fR config, which defaults to the TMPDIR, TMP, or TEMP environment -variables, or \fB/tmp\fR on Unix and \fBc:\\windows\\temp\fR on Windows\. -. -.P -Temp files are given a unique folder under this root for each run of the -program, and are deleted upon successful exit\. -. -.SH "More Information" -When installing locally, npm first tries to find an appropriate \fBprefix\fR folder\. This is so that \fBnpm install foo@1\.2\.3\fR will install -to the sensible root of your package, even if you happen to have \fBcd\fRed -into some other folder\. -. -.P -Starting at the $PWD, npm will walk up the folder tree checking for a -folder that contains either a \fBpackage\.json\fR file, or a \fBnode_modules\fR -folder\. If such a thing is found, then that is treated as the effective -"current directory" for the purpose of running npm commands\. (This -behavior is inspired by and similar to git\'s \.git\-folder seeking -logic when running git commands in a working dir\.) -. -.P -If no package root is found, then the current folder is used\. -. -.P -When you run \fBnpm install foo@1\.2\.3\fR, then the package is loaded into -the cache, and then unpacked into \fB\|\./node_modules/foo\fR\|\. Then, any of -foo\'s dependencies are similarly unpacked into \fB\|\./node_modules/foo/node_modules/\.\.\.\fR\|\. -. -.P -Any bin files are symlinked to \fB\|\./node_modules/\.bin/\fR, so that they may -be found by npm scripts when necessary\. -. -.SS "Global Installation" -If the \fBglobal\fR configuration is set to true, then npm will -install packages "globally"\. -. -.P -For global installation, packages are installed roughly the same way, -but using the folders described above\. -. -.SS "Cycles, Conflicts, and Folder Parsimony" -Cycles are handled using the property of node\'s module system that it -walks up the directories looking for \fBnode_modules\fR folders\. So, at every -stage, if a package is already installed in an ancestor \fBnode_modules\fR -folder, then it is not installed at the current location\. -. -.P -Consider the case above, where \fBfoo \-> bar \-> baz\fR\|\. Imagine if, in -addition to that, baz depended on bar, so you\'d have: \fBfoo \-> bar \-> baz \-> bar \-> baz \.\.\.\fR\|\. However, since the folder -structure is: \fBfoo/node_modules/bar/node_modules/baz\fR, there\'s no need to -put another copy of bar into \fB\|\.\.\./baz/node_modules\fR, since when it calls -require("bar"), it will get the copy that is installed in \fBfoo/node_modules/bar\fR\|\. -. -.P -This shortcut is only used if the exact same -version would be installed in multiple nested \fBnode_modules\fR folders\. It -is still possible to have \fBa/node_modules/b/node_modules/a\fR if the two -"a" packages are different versions\. However, without repeating the -exact same package multiple times, an infinite regress will always be -prevented\. -. -.P -Another optimization can be made by installing dependencies at the -highest level possible, below the localized "target" folder\. -. -.SS "\fIExample\fR" -Consider this dependency graph: -. -.IP "" 4 -. -.nf -foo -+\-\- blerg@1\.2\.5 -+\-\- bar@1\.2\.3 -| +\-\- blerg@1\.x (latest=1\.3\.7) -| +\-\- baz@2\.x -| | `\-\- quux@3\.x -| | `\-\- bar@1\.2\.3 (cycle) -| `\-\- asdf@* -`\-\- baz@1\.2\.3 - `\-\- quux@3\.x - `\-\- bar -. -.fi -. -.IP "" 0 -. -.P -In this case, we might expect a folder structure like this: -. -.IP "" 4 -. -.nf -foo -+\-\- node_modules - +\-\- blerg (1\.2\.5) <\-\-\-[A] - +\-\- bar (1\.2\.3) <\-\-\-[B] - | +\-\- node_modules - | | `\-\- baz (2\.0\.2) <\-\-\-[C] - | | `\-\- node_modules - | | `\-\- quux (3\.2\.0) - | `\-\- asdf (2\.3\.4) - `\-\- baz (1\.2\.3) <\-\-\-[D] - `\-\- node_modules - `\-\- quux (3\.2\.0) <\-\-\-[E] -. -.fi -. -.IP "" 0 -. -.P -Since foo depends directly on bar@1\.2\.3 and baz@1\.2\.3, those are -installed in foo\'s \fBnode_modules\fR folder\. -. -.P -Even though the latest copy of blerg is 1\.3\.7, foo has a specific -dependency on version 1\.2\.5\. So, that gets installed at [A]\. Since the -parent installation of blerg satisfie\'s bar\'s dependency on blerg@1\.x, -it does not install another copy under [B]\. -. -.P -Bar [B] also has dependencies on baz and asdf, so those are installed in -bar\'s \fBnode_modules\fR folder\. Because it depends on \fBbaz@2\.x\fR, it cannot -re\-use the \fBbaz@1\.2\.3\fR installed in the parent \fBnode_modules\fR folder [D], -and must install its own copy [C]\. -. -.P -Underneath bar, the \fBbaz\->quux\->bar\fR dependency creates a cycle\. -However, because \fBbar\fR is already in \fBquux\fR\'s ancestry [B], it does not -unpack another copy of bar into that folder\. -. -.P -Underneath \fBfoo\->baz\fR [D], quux\'s [E] folder tree is empty, because its -dependency on bar is satisfied by the parent folder copy installed at [B]\. -. -.P -For a graphical breakdown of what is installed where, use \fBnpm ls\fR\|\. -. -.SS "Publishing" -Upon publishing, npm will look in the \fBnode_modules\fR folder\. If any of -the items there are not in the \fBbundledDependencies\fR array, then they will -not be included in the package tarball\. -. -.P -This allows a package maintainer to install all of their dependencies -(and dev dependencies) locally, but only re\-publish those items that -cannot be found elsewhere\. See \fBnpm help json\fR for more information\. -. -.SH "SEE ALSO" -. -.IP "\(bu" 4 -npm help faq -. -.IP "\(bu" 4 -npm help json -. -.IP "\(bu" 4 -npm help install -. -.IP "\(bu" 4 -npm help pack -. -.IP "\(bu" 4 -npm help cache -. -.IP "\(bu" 4 -npm help config -. -.IP "\(bu" 4 -npm help publish -. -.IP "" 0 - diff --git a/deps/npm/man/man1/home.1 b/deps/npm/man/man1/home.1 deleted file mode 100644 index c63dd3cd9c..0000000000 --- a/deps/npm/man/man1/home.1 +++ /dev/null @@ -1,68 +0,0 @@ -.\" Generated with Ronnjs/v0.1 -.\" http://github.com/kapouer/ronnjs/ -. -.TH "NPM\-DOCS" "1" "November 2011" "" "" -. -.SH "NAME" -\fBnpm-docs\fR \-\- Docs for a package in a web browser maybe -. -.SH "SYNOPSIS" -. -.nf -npm docs <pkgname> -npm home <pkgname> -. -.fi -. -.SH "DESCRIPTION" -This command tries to guess at the likely location of a package\'s -documentation URL, and then tries to open it using the \fB\-\-browser\fR -config param\. -. -.SH "CONFIGURATION" -. -.SS "browser" -. -.IP "\(bu" 4 -Default: OS X: \fB"open"\fR, others: \fB"google\-chrome"\fR -. -.IP "\(bu" 4 -Type: String -. -.IP "" 0 -. -.P -The browser that is called by the \fBnpm docs\fR command to open websites\. -. -.SS "registry" -. -.IP "\(bu" 4 -Default: https://registry\.npmjs\.org/ -. -.IP "\(bu" 4 -Type: url -. -.IP "" 0 -. -.P -The base URL of the npm package registry\. -. -.SH "SEE ALSO" -. -.IP "\(bu" 4 -npm help view -. -.IP "\(bu" 4 -npm help publish -. -.IP "\(bu" 4 -npm help registry -. -.IP "\(bu" 4 -npm help config -. -.IP "\(bu" 4 -npm help json -. -.IP "" 0 - diff --git a/deps/npm/man/man1/index.1 b/deps/npm/man/man1/index.1 deleted file mode 100644 index daaca49ad5..0000000000 --- a/deps/npm/man/man1/index.1 +++ /dev/null @@ -1,298 +0,0 @@ -.\" Generated with Ronnjs 0.3.8 -.\" http://github.com/kapouer/ronnjs/ -. -.TH "NPM\-INDEX" "1" "July 2013" "" "" -. -.SH "NAME" -\fBnpm-index\fR \-\- Index of all npm documentation -. -.SH "npm help README" - node package manager -. -.SH "npm help adduser" - Add a registry user account -. -.SH "npm help bin" - Display npm bin folder -. -.SH "npm help bugs" - Bugs for a package in a web browser maybe -. -.SH "npm help build" - Build a package -. -.SH "npm help bundle" - REMOVED -. -.SH "npm help cache" - Manipulates packages cache -. -.SH "npm help changelog" - Changes -. -.SH "npm help coding\-style" - npm\'s "funny" coding style -. -.SH "npm help completion" - Tab Completion for npm -. -.SH "npm help config" - Manage the npm configuration file -. -.SH "npm help dedupe" - Reduce duplication -. -.SH "npm help deprecate" - Deprecate a version of a package -. -.SH "npm help developers" - Developer Guide -. -.SH "npm help disputes" - Handling Module Name Disputes -. -.SH "npm help docs" - Docs for a package in a web browser maybe -. -.SH "npm help edit" - Edit an installed package -. -.SH "npm help explore" - Browse an installed package -. -.SH "npm help faq" - Frequently Asked Questions -. -.SH "npm help folders" - Folder Structures Used by npm -. -.SH "npm help global" - Folder Structures Used by npm -. -.SH "npm help help\-search" - Search npm help documentation -. -.SH "npm help help" - Get help on npm -. -.SH "npm help init" - Interactively create a package\.json file -. -.SH "npm help install" - Install a package -. -.SH "npm help json" - Specifics of npm\'s package\.json handling -. -.SH "npm help link" - Symlink a package folder -. -.SH "npm help ls" - List installed packages -. -.SH "npm help npm" - node package manager -. -.SH "npm help outdated" - Check for outdated packages -. -.SH "npm help owner" - Manage package owners -. -.SH "npm help pack" - Create a tarball from a package -. -.SH "npm help prefix" - Display prefix -. -.SH "npm help prune" - Remove extraneous packages -. -.SH "npm help publish" - Publish a package -. -.SH "npm help rebuild" - Rebuild a package -. -.SH "npm help registry" - The JavaScript Package Registry -. -.SH "npm help removing\-npm" - Cleaning the Slate -. -.SH "npm help restart" - Start a package -. -.SH "npm help rm" - Remove a package -. -.SH "npm help root" - Display npm root -. -.SH "npm help run\-script" - Run arbitrary package scripts -. -.SH "npm help scripts" - How npm handles the "scripts" field -. -.SH "npm help search" - Search for packages -. -.SH "npm help semver" - The semantic versioner for npm -. -.SH "npm help shrinkwrap" - Lock down dependency versions -. -.SH "npm help star" - Mark your favorite packages -. -.SH "npm help stars" - View packages marked as favorites -. -.SH "npm help start" - Start a package -. -.SH "npm help stop" - Stop a package -. -.SH "npm help submodule" - Add a package as a git submodule -. -.SH "npm help tag" - Tag a published version -. -.SH "npm help test" - Test a package -. -.SH "npm help uninstall" - Remove a package -. -.SH "npm help unpublish" - Remove a package from the registry -. -.SH "npm help update" - Update a package -. -.SH "npm help version" - Bump a package version -. -.SH "npm help view" - View registry info -. -.SH "npm help whoami" - Display npm username -. -.SH "npm apihelp bin" - Display npm bin folder -. -.SH "npm apihelp bugs" - Bugs for a package in a web browser maybe -. -.SH "npm apihelp commands" - npm commands -. -.SH "npm apihelp config" - Manage the npm configuration files -. -.SH "npm apihelp deprecate" - Deprecate a version of a package -. -.SH "npm apihelp docs" - Docs for a package in a web browser maybe -. -.SH "npm apihelp edit" - Edit an installed package -. -.SH "npm apihelp explore" - Browse an installed package -. -.SH "npm apihelp help\-search" - Search the help pages -. -.SH "npm apihelp init" - Interactively create a package\.json file -. -.SH "npm apihelp install" - install a package programmatically -. -.SH "npm apihelp link" - Symlink a package folder -. -.SH "npm apihelp load" - Load config settings -. -.SH "npm apihelp ls" - List installed packages -. -.SH "npm apihelp npm" - node package manager -. -.SH "npm apihelp outdated" - Check for outdated packages -. -.SH "npm apihelp owner" - Manage package owners -. -.SH "npm apihelp pack" - Create a tarball from a package -. -.SH "npm apihelp prefix" - Display prefix -. -.SH "npm apihelp prune" - Remove extraneous packages -. -.SH "npm apihelp publish" - Publish a package -. -.SH "npm apihelp rebuild" - Rebuild a package -. -.SH "npm apihelp restart" - Start a package -. -.SH "npm apihelp root" - Display npm root -. -.SH "npm apihelp run\-script" - Run arbitrary package scripts -. -.SH "npm apihelp search" - Search for packages -. -.SH "npm apihelp shrinkwrap" - programmatically generate package shrinkwrap file -. -.SH "npm apihelp start" - Start a package -. -.SH "npm apihelp stop" - Stop a package -. -.SH "npm apihelp submodule" - Add a package as a git submodule -. -.SH "npm apihelp tag" - Tag a published version -. -.SH "npm apihelp test" - Test a package -. -.SH "npm apihelp uninstall" - uninstall a package programmatically -. -.SH "npm apihelp unpublish" - Remove a package from the registry -. -.SH "npm apihelp update" - Update a package -. -.SH "npm apihelp version" - Bump a package version -. -.SH "npm apihelp view" - View registry info -. -.SH "npm apihelp whoami" - Display npm username diff --git a/deps/npm/man/man1/json.1 b/deps/npm/man/man1/json.1 deleted file mode 100644 index c5558f8165..0000000000 --- a/deps/npm/man/man1/json.1 +++ /dev/null @@ -1,853 +0,0 @@ -.\" Generated with Ronnjs 0.3.8 -.\" http://github.com/kapouer/ronnjs/ -. -.TH "NPM\-JSON" "1" "July 2013" "" "" -. -.SH "NAME" -\fBnpm-json\fR \-\- Specifics of npm\'s package\.json handling -. -.SH "DESCRIPTION" -This document is all you need to know about what\'s required in your package\.json -file\. It must be actual JSON, not just a JavaScript object literal\. -. -.P -A lot of the behavior described in this document is affected by the config -settings described in \fBnpm help config\fR\|\. -. -.SH "DEFAULT VALUES" -npm will default some values based on package contents\. -. -.IP "\(bu" 4 -\fB"scripts": {"start": "node server\.js"}\fR -. -.IP -If there is a \fBserver\.js\fR file in the root of your package, then npm -will default the \fBstart\fR command to \fBnode server\.js\fR\|\. -. -.IP "\(bu" 4 -\fB"scripts":{"preinstall": "node\-waf clean || true; node\-waf configure build"}\fR -. -.IP -If there is a \fBwscript\fR file in the root of your package, npm will -default the \fBpreinstall\fR command to compile using node\-waf\. -. -.IP "\(bu" 4 -\fB"scripts":{"preinstall": "node\-gyp rebuild"}\fR -. -.IP -If there is a \fBbinding\.gyp\fR file in the root of your package, npm will -default the \fBpreinstall\fR command to compile using node\-gyp\. -. -.IP "\(bu" 4 -\fB"contributors": [\.\.\.]\fR -. -.IP -If there is an \fBAUTHORS\fR file in the root of your package, npm will -treat each line as a \fBName <email> (url)\fR format, where email and url -are optional\. Lines which start with a \fB#\fR or are blank, will be -ignored\. -. -.IP "" 0 -. -.SH "name" -The \fImost\fR important things in your package\.json are the name and version fields\. -Those are actually required, and your package won\'t install without -them\. The name and version together form an identifier that is assumed -to be completely unique\. Changes to the package should come along with -changes to the version\. -. -.P -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\.) -. -.IP "\(bu" 4 -The name ends up being part of a URL, an argument on the command line, and a -folder name\. Any name with non\-url\-safe characters will be rejected\. -Also, it can\'t start with a dot or an underscore\. -. -.IP "\(bu" 4 -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/ -. -.IP "" 0 -. -.SH "version" -The \fImost\fR important things in your package\.json are the name and version fields\. -Those are actually required, and your package won\'t install without -them\. The name and version together form an identifier that is assumed -to be completely unique\. Changes to the package should come along with -changes to the version\. -. -.P -Version must be parseable by node\-semver \fIhttps://github\.com/isaacs/node\-semver\fR, which is bundled -with npm as a dependency\. (\fBnpm install semver\fR to use it yourself\.) -. -.P -Here\'s how npm\'s semver implementation 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, \fB0\.1\.2\-7 > 0\.1\.2\-7\-beta > 0\.1\.2\-6 > 0\.1\.2 > 0\.1\.2beta\fR -. -.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\. -. -.SH "description" -Put a description in it\. It\'s a string\. This helps people discover your -package, as it\'s listed in \fBnpm search\fR\|\. -. -.SH "keywords" -Put keywords in it\. It\'s an array of strings\. This helps people -discover your package as it\'s listed in \fBnpm search\fR\|\. -. -.SH "homepage" -The url to the project homepage\. -. -.P -\fBNOTE\fR: This is \fInot\fR the same as "url"\. If you put a "url" field, -then the registry will think it\'s a redirection to your package that has -been published somewhere else, and spit at you\. -. -.P -Literally\. Spit\. I\'m so not kidding\. -. -.SH "bugs" -The url to your project\'s issue tracker and / or the email address to which -issues should be reported\. These are helpful for people who encounter issues -with your package\. -. -.P -It should look like this: -. -.IP "" 4 -. -.nf -{ "url" : "http://github\.com/owner/project/issues" -, "email" : "project@hostname\.com" -} -. -.fi -. -.IP "" 0 -. -.P -You can specify either one or both values\. If you want to provide only a url, -you can specify the value for "bugs" as a simple string instead of an object\. -. -.P -If a url is provided, it will be used by the \fBnpm bugs\fR command\. -. -.SH "license" -You should specify a license for your package so that people know how they are -permitted to use it, and any restrictions you\'re placing on it\. -. -.P -The simplest way, assuming you\'re using a common license such as BSD or MIT, is -to just specify the name of the license you\'re using, like this: -. -.IP "" 4 -. -.nf -{ "license" : "BSD" } -. -.fi -. -.IP "" 0 -. -.P -If you have more complex licensing terms, or you want to provide more detail -in your package\.json file, you can use the more verbose plural form, like this: -. -.IP "" 4 -. -.nf -"licenses" : [ - { "type" : "MyLicense" - , "url" : "http://github\.com/owner/project/path/to/license" - } -] -. -.fi -. -.IP "" 0 -. -.P -It\'s also a good idea to include a license file at the top level in your package\. -. -.SH "people fields: author, contributors" -The "author" is one person\. "contributors" is an array of people\. A "person" -is an object with a "name" field and optionally "url" and "email", like this: -. -.IP "" 4 -. -.nf -{ "name" : "Barney Rubble" -, "email" : "b@rubble\.com" -, "url" : "http://barnyrubble\.tumblr\.com/" -} -. -.fi -. -.IP "" 0 -. -.P -Or you can shorten that all into a single string, and npm will parse it for you: -. -.IP "" 4 -. -.nf -"Barney Rubble <b@rubble\.com> (http://barnyrubble\.tumblr\.com/) -. -.fi -. -.IP "" 0 -. -.P -Both email and url are optional either way\. -. -.P -npm also sets a top\-level "maintainers" field with your npm user info\. -. -.SH "files" -The "files" field is an array of files to include in your project\. If -you name a folder in the array, then it will also include the files -inside that folder\. (Unless they would be ignored by another rule\.) -. -.P -You can also provide a "\.npmignore" file in the root of your package, -which will keep files from being included, even if they would be picked -up by the files array\. The "\.npmignore" file works just like a -"\.gitignore"\. -. -.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\. -. -.P -This should be a module ID relative to the root of your package folder\. -. -.P -For most modules, it makes the most sense to have a main script and often not -much else\. -. -.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\.) -. -.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 symlink that file into \fBprefix/bin\fR for global installs, or \fB\|\./node_modules/\.bin/\fR for local -installs\. -. -.P -For example, npm has this: -. -.IP "" 4 -. -.nf -{ "bin" : { "npm" : "\./cli\.js" } } -. -.fi -. -.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\fR\|\. -. -.P -If you have a single executable, and its name should be the name -of the package, then you can just supply it as a string\. For example: -. -.IP "" 4 -. -.nf -{ "name": "my\-program" -, "version": "1\.2\.5" -, "bin": "\./path/to/program" } -. -.fi -. -.IP "" 0 -. -.P -would be the same as this: -. -.IP "" 4 -. -.nf -{ "name": "my\-program" -, "version": "1\.2\.5" -, "bin" : { "my\-program" : "\./path/to/program" } } -. -.fi -. -.IP "" 0 -. -.SH "man" -Specify either a single file or an array of filenames to put in place for the \fBman\fR program to find\. -. -.P -If only a single file is provided, then it\'s installed such that it is the -result from \fBman <pkgname>\fR, regardless of its actual filename\. For example: -. -.IP "" 4 -. -.nf -{ "name" : "foo" -, "version" : "1\.2\.3" -, "description" : "A packaged foo fooer for fooing foos" -, "main" : "foo\.js" -, "man" : "\./man/doc\.1" -} -. -.fi -. -.IP "" 0 -. -.P -would link the \fB\|\./man/doc\.1\fR file in such that it is the target for \fBman foo\fR -. -.P -If the filename doesn\'t start with the package name, then it\'s prefixed\. -So, this: -. -.IP "" 4 -. -.nf -{ "name" : "foo" -, "version" : "1\.2\.3" -, "description" : "A packaged foo fooer for fooing foos" -, "main" : "foo\.js" -, "man" : [ "\./man/foo\.1", "\./man/bar\.1" ] -} -. -.fi -. -.IP "" 0 -. -.P -will create files to do \fBman foo\fR and \fBman foo\-bar\fR\|\. -. -.P -Man files must end with a number, and optionally a \fB\|\.gz\fR suffix if they are -compressed\. The number dictates which man section the file is installed into\. -. -.IP "" 4 -. -.nf -{ "name" : "foo" -, "version" : "1\.2\.3" -, "description" : "A packaged foo fooer for fooing foos" -, "main" : "foo\.js" -, "man" : [ "\./man/foo\.1", "\./man/foo\.2" ] -} -. -.fi -. -.IP "" 0 -. -.P -will create entries for \fBman foo\fR and \fBman 2 foo\fR -. -.SH "directories" -The CommonJS Packages \fIhttp://wiki\.commonjs\.org/wiki/Packages/1\.0\fR spec details a -few ways that you can indicate the structure of your package using a \fBdirectories\fR -hash\. If you look at npm\'s package\.json \fIhttp://registry\.npmjs\.org/npm/latest\fR, -you\'ll see that it has directories for doc, lib, and man\. -. -.P -In the future, this information may be used in other creative ways\. -. -.SS "directories\.lib" -Tell people where the bulk of your library is\. Nothing special is done -with the lib folder in any way, but it\'s useful meta info\. -. -.SS "directories\.bin" -If you specify a "bin" directory, then all the files in that folder will -be used as the "bin" hash\. -. -.P -If you have a "bin" hash already, then this has no effect\. -. -.SS "directories\.man" -A folder that is full of man pages\. Sugar to generate a "man" array by -walking the folder\. -. -.SS "directories\.doc" -Put markdown files in here\. Eventually, these will be displayed nicely, -maybe, someday\. -. -.SS "directories\.example" -Put example scripts in here\. Someday, it might be exposed in some clever way\. -. -.SH "repository" -Specify the place where your code lives\. This is helpful for people who -want to contribute\. If the git repo is on github, then the \fBnpm docs\fR -command will be able to find you\. -. -.P -Do it like this: -. -.IP "" 4 -. -.nf -"repository" : - { "type" : "git" - , "url" : "http://github\.com/isaacs/npm\.git" - } -"repository" : - { "type" : "svn" - , "url" : "http://v8\.googlecode\.com/svn/trunk/" - } -. -.fi -. -.IP "" 0 -. -.P -The URL should be a publicly available (perhaps read\-only) url that can be handed -directly to a VCS program without any modification\. It should not be a url to an -html project page that you put in your browser\. It\'s for computers\. -. -.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\. -. -.P -See \fBnpm help scripts\fR to find out more about writing package scripts\. -. -.SH "config" -A "config" hash can be used to set configuration -parameters used in package scripts that persist across upgrades\. For -instance, if a package had the following: -. -.IP "" 4 -. -.nf -{ "name" : "foo" -, "config" : { "port" : "8080" } } -. -.fi -. -.IP "" 0 -. -.P -and then had a "start" command that then referenced the \fBnpm_package_config_port\fR environment variable, then the user could -override that by doing \fBnpm config set foo:port 8001\fR\|\. -. -.P -See \fBnpm help config\fR and \fBnpm help scripts\fR for more on package -configs\. -. -.SH "dependencies" -Dependencies are specified with a simple hash of package name to version -range\. The version range is EITHER a string which has one or more -space\-separated descriptors, OR a range like "fromVersion \- toVersion" -. -.P -\fBPlease do not put test harnesses in your \fBdependencies\fR hash\.\fR See \fBdevDependencies\fR, below\. -. -.P -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 -. -.IP "\(bu" 4 -\fB=version\fR Same as just \fBversion\fR -. -.IP "\(bu" 4 -\fB>version\fR Must be greater than \fBversion\fR -. -.IP "\(bu" 4 -\fB>=version\fR etc -. -.IP "\(bu" 4 -\fB<version\fR -. -.IP "\(bu" 4 -\fB<=version\fR -. -.IP "\(bu" 4 -\fB~version\fR See \'Tilde Version Ranges\' below -. -.IP "\(bu" 4 -\fB1\.2\.x\fR See \'X Version Ranges\' below -. -.IP "\(bu" 4 -\fBhttp://\.\.\.\fR See \'URLs as Dependencies\' below -. -.IP "\(bu" 4 -\fB*\fR Matches any version -. -.IP "\(bu" 4 -\fB""\fR (just an empty string) Same as \fB*\fR -. -.IP "\(bu" 4 -\fBversion1 \- version2\fR Same as \fB>=version1 <=version2\fR\|\. -. -.IP "\(bu" 4 -\fBrange1 || range2\fR Passes if either range1 or range2 are satisfied\. -. -.IP "\(bu" 4 -\fBgit\.\.\.\fR See \'Git URLs as Dependencies\' below -. -.IP "" 0 -. -.P -For example, these are all valid: -. -.IP "" 4 -. -.nf -{ "dependencies" : - { "foo" : "1\.0\.0 \- 2\.9999\.9999" - , "bar" : ">=1\.0\.2 <2\.1\.2" - , "baz" : ">1\.0\.2 <=2\.3\.4" - , "boo" : "2\.0\.1" - , "qux" : "<1\.0\.0 || >=2\.3\.1 <2\.4\.5 || >=2\.5\.2 <3\.0\.0" - , "asd" : "http://asdf\.com/asdf\.tar\.gz" - , "til" : "~1\.2" - , "elf" : "~1\.2\.3" - , "two" : "2\.x" - , "thr" : "3\.3\.x" - } -} -. -.fi -. -.IP "" 0 -. -.SS "Tilde Version Ranges" -A range specifier starting with a tilde \fB~\fR character is matched against -a version in the following fashion\. -. -.IP "\(bu" 4 -The version must be at least as high as the range\. -. -.IP "\(bu" 4 -The version must be less than the next major revision above the range\. -. -.IP "" 0 -. -.P -For example, the following are equivalent: -. -.IP "\(bu" 4 -\fB"~1\.2\.3" = ">=1\.2\.3 <1\.3\.0"\fR -. -.IP "\(bu" 4 -\fB"~1\.2" = ">=1\.2\.0 <1\.3\.0"\fR -. -.IP "\(bu" 4 -\fB"~1" = ">=1\.0\.0 <1\.1\.0"\fR -. -.IP "" 0 -. -.SS "X Version Ranges" -An "x" in a version range specifies that the version number must start -with the supplied digits, but any digit may be used in place of the x\. -. -.P -The following are equivalent: -. -.IP "\(bu" 4 -\fB"1\.2\.x" = ">=1\.2\.0 <1\.3\.0"\fR -. -.IP "\(bu" 4 -\fB"1\.x\.x" = ">=1\.0\.0 <2\.0\.0"\fR -. -.IP "\(bu" 4 -\fB"1\.2" = "1\.2\.x"\fR -. -.IP "\(bu" 4 -\fB"1\.x" = "1\.x\.x"\fR -. -.IP "\(bu" 4 -\fB"1" = "1\.x\.x"\fR -. -.IP "" 0 -. -.P -You may not supply a comparator with a version containing an x\. Any -digits after the first "x" are ignored\. -. -.SS "URLs as Dependencies" -Starting with npm version 0\.2\.14, you may specify a tarball URL in place -of a version range\. -. -.P -This tarball will be downloaded and installed locally to your package at -install time\. -. -.SS "Git URLs as Dependencies" -Git urls can be of the form: -. -.IP "" 4 -. -.nf -git://github\.com/user/project\.git#commit\-ish -git+ssh://user@hostname:project\.git#commit\-ish -git+ssh://user@hostname/project\.git#commit\-ish -git+http://user@hostname/project/blah\.git#commit\-ish -git+https://user@hostname/project/blah\.git#commit\-ish -. -.fi -. -.IP "" 0 -. -.P -The \fBcommit\-ish\fR can be any tag, sha, or branch which can be supplied as -an argument to \fBgit checkout\fR\|\. The default is \fBmaster\fR\|\. -. -.SH "devDependencies" -If someone is planning on downloading and using your module in their -program, then they probably don\'t want or need to download and build -the external test or documentation framework that you use\. -. -.P -In this case, it\'s best to list these additional items in a \fBdevDependencies\fR hash\. -. -.P -These things will be installed whenever the \fB\-\-dev\fR configuration flag -is set\. This flag is set automatically when doing \fBnpm link\fR or when doing \fBnpm install\fR from the root of a package, and can be managed like any other npm -configuration param\. See \fBnpm help config\fR for more on the topic\. -. -.SH "bundledDependencies" -Array of package names that will be bundled when publishing the package\. -. -.P -If this is spelled \fB"bundleDependencies"\fR, then that is also honorable\. -. -.SH "optionalDependencies" -If a dependency can be used, but you would like npm to proceed if it -cannot be found or fails to install, then you may put it in the \fBoptionalDependencies\fR hash\. This is a map of package name to version -or url, just like the \fBdependencies\fR hash\. The difference is that -failure is tolerated\. -. -.P -It is still your program\'s responsibility to handle the lack of the -dependency\. For example, something like this: -. -.IP "" 4 -. -.nf -try { - var foo = require(\'foo\') - var fooVersion = require(\'foo/package\.json\')\.version -} catch (er) { - foo = null -} -if ( notGoodFooVersion(fooVersion) ) { - foo = null -} -// \.\. then later in your program \.\. -if (foo) { - foo\.doFooThings() -} -. -.fi -. -.IP "" 0 -. -.P -Entries in \fBoptionalDependencies\fR will override entries of the same name in \fBdependencies\fR, so it\'s usually best to only put in one place\. -. -.SH "engines" -You can specify the version of node that your stuff works on: -. -.IP "" 4 -. -.nf -{ "engines" : { "node" : ">=0\.1\.27 <0\.1\.30" } } -. -.fi -. -.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\. -. -.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\. -. -.P -You can also use the "engines" field to specify which versions of npm -are capable of properly installing your program\. For example: -. -.IP "" 4 -. -.nf -{ "engines" : { "npm" : "~1\.0\.20" } } -. -.fi -. -.IP "" 0 -. -.P -Note that, unless the user has set the \fBengine\-strict\fR config flag, this -field is advisory only\. -. -.SH "engineStrict" -If you are sure that your module will \fIdefinitely not\fR run properly on -versions of Node/npm other than those specified in the \fBengines\fR hash, -then you can set \fB"engineStrict": true\fR in your package\.json file\. -This will override the user\'s \fBengine\-strict\fR config setting\. -. -.P -Please do not do this unless you are really very very sure\. If your -engines hash is something overly restrictive, you can quite easily and -inadvertently lock yourself into obscurity and prevent your users from -updating to new versions of Node\. Consider this choice carefully\. If -people abuse it, it will be removed in a future version of npm\. -. -.SH "os" -You can specify which operating systems your -module will run on: -. -.IP "" 4 -. -.nf -"os" : [ "darwin", "linux" ] -. -.fi -. -.IP "" 0 -. -.P -You can also blacklist instead of whitelist operating systems, -just prepend the blacklisted os with a \'!\': -. -.IP "" 4 -. -.nf -"os" : [ "!win32" ] -. -.fi -. -.IP "" 0 -. -.P -The host operating system is determined by \fBprocess\.platform\fR -. -.P -It is allowed to both blacklist, and whitelist, although there isn\'t any -good reason to do this\. -. -.SH "cpu" -If your code only runs on certain cpu architectures, -you can specify which ones\. -. -.IP "" 4 -. -.nf -"cpu" : [ "x64", "ia32" ] -. -.fi -. -.IP "" 0 -. -.P -Like the \fBos\fR option, you can also blacklist architectures: -. -.IP "" 4 -. -.nf -"cpu" : [ "!arm", "!mips" ] -. -.fi -. -.IP "" 0 -. -.P -The host architecture is determined by \fBprocess\.arch\fR -. -.SH "preferGlobal" -If your package is primarily a command\-line application that should be -installed globally, then set this value to \fBtrue\fR to provide a warning -if it is installed locally\. -. -.P -It doesn\'t actually prevent users from installing it locally, but it -does help prevent some confusion if it doesn\'t work as expected\. -. -.SH "private" -If you set \fB"private": true\fR in your package\.json, then npm will refuse -to publish it\. -. -.P -This is a way to prevent accidental publication of private repositories\. -If you would like to ensure that a given package is only ever published -to a specific registry (for example, an internal registry), -then use the \fBpublishConfig\fR hash described below -to override the \fBregistry\fR config param at publish\-time\. -. -.SH "publishConfig" -This is a set of config values that will be used at publish\-time\. It\'s -especially handy if you want to set the tag or registry, so that you can -ensure that a given package is not tagged with "latest" or published to -the global public registry by default\. -. -.P -Any config values can be overridden, but of course only "tag" and -"registry" probably matter for the purposes of publishing\. -. -.P -See \fBnpm help config\fR to see the list of config options that can be -overridden\. -. -.SH "SEE ALSO" -. -.IP "\(bu" 4 -npm help semver -. -.IP "\(bu" 4 -npm help init -. -.IP "\(bu" 4 -npm help version -. -.IP "\(bu" 4 -npm help config -. -.IP "\(bu" 4 -npm help help -. -.IP "\(bu" 4 -npm help faq -. -.IP "\(bu" 4 -npm help install -. -.IP "\(bu" 4 -npm help publish -. -.IP "\(bu" 4 -npm help rm -. -.IP "" 0 - diff --git a/deps/npm/man/man1/list.1 b/deps/npm/man/man1/list.1 deleted file mode 100644 index 00a743ae18..0000000000 --- a/deps/npm/man/man1/list.1 +++ /dev/null @@ -1,125 +0,0 @@ -.\" Generated with Ronnjs 0.3.8 -.\" http://github.com/kapouer/ronnjs/ -. -.TH "NPM\-LS" "1" "August 2012" "" "" -. -.SH "NAME" -\fBnpm-ls\fR \-\- List installed packages -. -.SH "SYNOPSIS" -. -.nf -npm list [<pkg> \.\.\.] -npm ls [<pkg> \.\.\.] -npm la [<pkg> \.\.\.] -npm ll [<pkg> \.\.\.] -. -.fi -. -.SH "DESCRIPTION" -This command will print to stdout all the versions of packages that are -installed, as well as their dependencies, in a tree\-structure\. -. -.P -Positional arguments are \fBname@version\-range\fR identifiers, which will -limit the results to only the paths to the packages named\. Note that -nested packages will \fIalso\fR show the paths to the specified packages\. -For example, running \fBnpm ls promzard\fR in npm\'s source tree will show: -. -.IP "" 4 -. -.nf -npm@1.1.59 /path/to/npm -└─┬ init\-package\-json@0\.0\.4 - └── promzard@0\.1\.5 -. -.fi -. -.IP "" 0 -. -.P -It will show print out extraneous, missing, and invalid packages\. -. -.P -When run as \fBll\fR or \fBla\fR, it shows extended information by default\. -. -.SH "CONFIGURATION" -. -.SS "json" -. -.IP "\(bu" 4 -Default: false -. -.IP "\(bu" 4 -Type: Boolean -. -.IP "" 0 -. -.P -Show information in JSON format\. -. -.SS "long" -. -.IP "\(bu" 4 -Default: false -. -.IP "\(bu" 4 -Type: Boolean -. -.IP "" 0 -. -.P -Show extended information\. -. -.SS "parseable" -. -.IP "\(bu" 4 -Default: false -. -.IP "\(bu" 4 -Type: Boolean -. -.IP "" 0 -. -.P -Show parseable output instead of tree view\. -. -.SS "global" -. -.IP "\(bu" 4 -Default: false -. -.IP "\(bu" 4 -Type: Boolean -. -.IP "" 0 -. -.P -List packages in the global install prefix instead of in the current -project\. -. -.SH "SEE ALSO" -. -.IP "\(bu" 4 -npm help config -. -.IP "\(bu" 4 -npm help folders -. -.IP "\(bu" 4 -npm help install -. -.IP "\(bu" 4 -npm help link -. -.IP "\(bu" 4 -npm help prune -. -.IP "\(bu" 4 -npm help outdated -. -.IP "\(bu" 4 -npm help update -. -.IP "" 0 - diff --git a/deps/npm/man/man1/ln.1 b/deps/npm/man/man1/ln.1 deleted file mode 100644 index 74bf729b50..0000000000 --- a/deps/npm/man/man1/ln.1 +++ /dev/null @@ -1,108 +0,0 @@ -.\" Generated with Ronnjs/v0.1 -.\" http://github.com/kapouer/ronnjs/ -. -.TH "NPM\-LINK" "1" "November 2011" "" "" -. -.SH "NAME" -\fBnpm-link\fR \-\- Symlink a package folder -. -.SH "SYNOPSIS" -. -.nf -npm link (in package folder) -npm link <pkgname> -. -.fi -. -.SH "DESCRIPTION" -Package linking is a two\-step process\. -. -.P -First, \fBnpm link\fR in a package folder will create a globally\-installed -symbolic link from \fBprefix/package\-name\fR to the current folder\. -. -.P -Next, in some other location, \fBnpm link package\-name\fR will create a -symlink from the local \fBnode_modules\fR folder to the global symlink\. -. -.P -When creating tarballs for \fBnpm publish\fR, the linked packages are -"snapshotted" to their current state by resolving the symbolic links\. -. -.P -This is -handy for installing your own stuff, so that you can work on it and test it -iteratively without having to continually rebuild\. -. -.P -For example: -. -.IP "" 4 -. -.nf -cd ~/projects/node\-redis # go into the package directory -npm link # creates global link -cd ~/projects/node\-bloggy # go into some other package directory\. -npm link redis # link\-install the package -. -.fi -. -.IP "" 0 -. -.P -Now, any changes to ~/projects/node\-redis will be reflected in -~/projects/node\-bloggy/node_modules/redis/ -. -.P -You may also shortcut the two steps in one\. For example, to do the -above use\-case in a shorter way: -. -.IP "" 4 -. -.nf -cd ~/projects/node\-bloggy # go into the dir of your main project -npm link \.\./node\-redis # link the dir of your dependency -. -.fi -. -.IP "" 0 -. -.P -The second line is the equivalent of doing: -. -.IP "" 4 -. -.nf -(cd \.\./node\-redis; npm link) -npm link redis -. -.fi -. -.IP "" 0 -. -.P -That is, it first creates a global link, and then links the global -installation target into your project\'s \fBnode_modules\fR folder\. -. -.SH "SEE ALSO" -. -.IP "\(bu" 4 -npm help developers -. -.IP "\(bu" 4 -npm help faq -. -.IP "\(bu" 4 -npm help json -. -.IP "\(bu" 4 -npm help install -. -.IP "\(bu" 4 -npm help folders -. -.IP "\(bu" 4 -npm help config -. -.IP "" 0 - diff --git a/deps/npm/man/man1/README.1 b/deps/npm/man/man1/npm-README.1 index 811acb2b11..811acb2b11 100644 --- a/deps/npm/man/man1/README.1 +++ b/deps/npm/man/man1/npm-README.1 diff --git a/deps/npm/man/man1/adduser.1 b/deps/npm/man/man1/npm-adduser.1 index 788d1031b6..8696248be7 100644 --- a/deps/npm/man/man1/adduser.1 +++ b/deps/npm/man/man1/npm-adduser.1 @@ -42,12 +42,18 @@ The base URL of the npm package registry\. .SH "SEE ALSO" . .IP "\(bu" 4 -npm help registry +npm help registry . .IP "\(bu" 4 npm help config . .IP "\(bu" 4 +npm help config +. +.IP "\(bu" 4 +npm help npmrc +. +.IP "\(bu" 4 npm help owner . .IP "\(bu" 4 diff --git a/deps/npm/man/man1/bin.1 b/deps/npm/man/man1/npm-bin.1 index 53aba3715d..fe6886053a 100644 --- a/deps/npm/man/man1/bin.1 +++ b/deps/npm/man/man1/npm-bin.1 @@ -25,10 +25,16 @@ npm help prefix npm help root . .IP "\(bu" 4 -npm help folders +npm help folders . .IP "\(bu" 4 npm help config . +.IP "\(bu" 4 +npm help config +. +.IP "\(bu" 4 +npm help npmrc +. .IP "" 0 diff --git a/deps/npm/man/man1/bugs.1 b/deps/npm/man/man1/npm-bugs.1 index 56898405c5..dc2a837529 100644 --- a/deps/npm/man/man1/bugs.1 +++ b/deps/npm/man/man1/npm-bugs.1 @@ -58,13 +58,19 @@ npm help view npm help publish . .IP "\(bu" 4 -npm help registry +npm help registry . .IP "\(bu" 4 npm help config . .IP "\(bu" 4 -npm help json +npm help config +. +.IP "\(bu" 4 +npm help npmrc +. +.IP "\(bu" 4 +npm help package\.json . .IP "" 0 diff --git a/deps/npm/man/man1/build.1 b/deps/npm/man/man1/npm-build.1 index 034850dcdd..1cb520911b 100644 --- a/deps/npm/man/man1/build.1 +++ b/deps/npm/man/man1/npm-build.1 @@ -34,10 +34,10 @@ npm help install npm help link . .IP "\(bu" 4 -npm help scripts +npm help scripts . .IP "\(bu" 4 -npm help json +npm help package\.json . .IP "" 0 diff --git a/deps/npm/man/man1/bundle.1 b/deps/npm/man/man1/npm-bundle.1 index 880d23f9de..880d23f9de 100644 --- a/deps/npm/man/man1/bundle.1 +++ b/deps/npm/man/man1/npm-bundle.1 diff --git a/deps/npm/man/man1/cache.1 b/deps/npm/man/man1/npm-cache.1 index 82ceb4a118..1aa5c62868 100644 --- a/deps/npm/man/man1/cache.1 +++ b/deps/npm/man/man1/npm-cache.1 @@ -79,12 +79,18 @@ The root cache folder\. .SH "SEE ALSO" . .IP "\(bu" 4 -npm help folders +npm help folders . .IP "\(bu" 4 npm help config . .IP "\(bu" 4 +npm help config +. +.IP "\(bu" 4 +npm help npmrc +. +.IP "\(bu" 4 npm help install . .IP "\(bu" 4 diff --git a/deps/npm/man/man1/completion.1 b/deps/npm/man/man1/npm-completion.1 index ea0d0cd8b8..25e7bf10c8 100644 --- a/deps/npm/man/man1/completion.1 +++ b/deps/npm/man/man1/npm-completion.1 @@ -35,10 +35,10 @@ completions based on the arguments\. .SH "SEE ALSO" . .IP "\(bu" 4 -npm help developers +npm help developers . .IP "\(bu" 4 -npm help faq +npm help faq . .IP "\(bu" 4 npm help npm diff --git a/deps/npm/man/man1/npm-config.1 b/deps/npm/man/man1/npm-config.1 new file mode 100644 index 0000000000..55a00995c1 --- /dev/null +++ b/deps/npm/man/man1/npm-config.1 @@ -0,0 +1,112 @@ +.\" Generated with Ronnjs 0.3.8 +.\" http://github.com/kapouer/ronnjs/ +. +.TH "NPM\-CONFIG" "1" "July 2013" "" "" +. +.SH "NAME" +\fBnpm-config\fR \-\- Manage the npm configuration files +. +.SH "SYNOPSIS" +. +.nf +npm config set <key> <value> [\-\-global] +npm config get <key> +npm config delete <key> +npm config list +npm config edit +npm get <key> +npm set <key> <value> [\-\-global] +. +.fi +. +.SH "DESCRIPTION" +npm gets its config settings from the command line, environment +variables, \fBnpmrc\fR files, and in some cases, the \fBpackage\.json\fR file\. +. +.P +npm help See npmrc for more information about the npmrc files\. +. +.P +npm help See \fBnpm\-config\fR for a more thorough discussion of the mechanisms +involved\. +. +.P +The \fBnpm config\fR command can be used to update and edit the contents +of the user and global npmrc files\. +. +.SH "Sub\-commands" +Config supports the following sub\-commands: +. +.SS "set" +. +.nf +npm config set key value +. +.fi +. +.P +Sets the config key to the value\. +. +.P +If value is omitted, then it sets it to "true"\. +. +.SS "get" +. +.nf +npm config get key +. +.fi +. +.P +Echo the config value to stdout\. +. +.SS "list" +. +.nf +npm config list +. +.fi +. +.P +Show all the config settings\. +. +.SS "delete" +. +.nf +npm config delete key +. +.fi +. +.P +Deletes the key from all configuration files\. +. +.SS "edit" +. +.nf +npm config edit +. +.fi +. +.P +Opens the config file in an editor\. Use the \fB\-\-global\fR flag to edit the +global config\. +. +.SH "SEE ALSO" +. +.IP "\(bu" 4 +npm help folders +. +.IP "\(bu" 4 +npm help config +. +.IP "\(bu" 4 +npm help package\.json +. +.IP "\(bu" 4 +npm help npmrc +. +.IP "\(bu" 4 +npm help npm +. +.IP "" 0 + diff --git a/deps/npm/man/man1/dedupe.1 b/deps/npm/man/man1/npm-dedupe.1 index 63b6fdaf82..5446cbdd8b 100644 --- a/deps/npm/man/man1/dedupe.1 +++ b/deps/npm/man/man1/npm-dedupe.1 @@ -35,7 +35,7 @@ a .IP "" 0 . .P -In this case, \fBnpm help dedupe\fR will transform the tree to: +npm help In this case, \fBnpm\-dedupe\fR will transform the tree to: . .IP "" 4 . diff --git a/deps/npm/man/man1/deprecate.1 b/deps/npm/man/man1/npm-deprecate.1 index f29f0ce6b5..265e437cbc 100644 --- a/deps/npm/man/man1/deprecate.1 +++ b/deps/npm/man/man1/npm-deprecate.1 @@ -42,7 +42,7 @@ To un\-deprecate a package, specify an empty string (\fB""\fR) for the \fBmessag npm help publish . .IP "\(bu" 4 -npm help registry +npm help registry . .IP "" 0 diff --git a/deps/npm/man/man1/docs.1 b/deps/npm/man/man1/npm-docs.1 index 2c9c4867eb..a3a9c47518 100644 --- a/deps/npm/man/man1/docs.1 +++ b/deps/npm/man/man1/npm-docs.1 @@ -56,13 +56,19 @@ npm help view npm help publish . .IP "\(bu" 4 -npm help registry +npm help registry . .IP "\(bu" 4 npm help config . .IP "\(bu" 4 -npm help json +npm help config +. +.IP "\(bu" 4 +npm help npmrc +. +.IP "\(bu" 4 +npm help package\.json . .IP "" 0 diff --git a/deps/npm/man/man1/edit.1 b/deps/npm/man/man1/npm-edit.1 index ad660f2070..48213a586b 100644 --- a/deps/npm/man/man1/edit.1 +++ b/deps/npm/man/man1/npm-edit.1 @@ -15,7 +15,7 @@ npm edit <name>[@<version>] . .SH "DESCRIPTION" Opens the package folder in the default editor (or whatever you\'ve -configured as the npm \fBeditor\fR config \-\- see \fBnpm help config\fR\|\.) +npm help configured as the npm \fBeditor\fR config \-\- see \fBnpm\-config\fR\|\.) . .P After it has been edited, the package is rebuilt so as to pick up any @@ -45,7 +45,7 @@ The command to run for \fBnpm edit\fR or \fBnpm config edit\fR\|\. .SH "SEE ALSO" . .IP "\(bu" 4 -npm help folders +npm help folders . .IP "\(bu" 4 npm help explore @@ -56,5 +56,11 @@ npm help install .IP "\(bu" 4 npm help config . +.IP "\(bu" 4 +npm help config +. +.IP "\(bu" 4 +npm help npmrc +. .IP "" 0 diff --git a/deps/npm/man/man1/explore.1 b/deps/npm/man/man1/npm-explore.1 index d4260fc838..c534f4ac69 100644 --- a/deps/npm/man/man1/explore.1 +++ b/deps/npm/man/man1/npm-explore.1 @@ -58,7 +58,7 @@ The shell to run for the \fBnpm explore\fR command\. npm help submodule . .IP "\(bu" 4 -npm help folders +npm help folders . .IP "\(bu" 4 npm help edit diff --git a/deps/npm/man/man1/help-search.1 b/deps/npm/man/man1/npm-help-search.1 index d3fc80a291..098bcedead 100644 --- a/deps/npm/man/man1/help-search.1 +++ b/deps/npm/man/man1/npm-help-search.1 @@ -50,7 +50,7 @@ If false, then help\-search will just list out the help topics found\. npm help npm . .IP "\(bu" 4 -npm help faq +npm help faq . .IP "\(bu" 4 npm help help diff --git a/deps/npm/man/man1/help.1 b/deps/npm/man/man1/npm-help.1 index 3e5dfcd1cb..ce5f772663 100644 --- a/deps/npm/man/man1/help.1 +++ b/deps/npm/man/man1/npm-help.1 @@ -50,22 +50,28 @@ npm help npm README . .IP "\(bu" 4 -npm help faq +npm help faq . .IP "\(bu" 4 -npm help folders +npm help folders . .IP "\(bu" 4 npm help config . .IP "\(bu" 4 -npm help json +npm help config +. +.IP "\(bu" 4 +npm help npmrc +. +.IP "\(bu" 4 +npm help package\.json . .IP "\(bu" 4 npm help help\-search . .IP "\(bu" 4 -npm help index +npm help index . .IP "" 0 diff --git a/deps/npm/man/man1/init.1 b/deps/npm/man/man1/npm-init.1 index 5ffe04399a..4e8b6b1a4e 100644 --- a/deps/npm/man/man1/init.1 +++ b/deps/npm/man/man1/npm-init.1 @@ -34,7 +34,7 @@ without a really good reason to do so\. \fIhttps://github\.com/isaacs/init\-package\-json\fR . .IP "\(bu" 4 -npm help json +npm help package\.json . .IP "\(bu" 4 npm help version diff --git a/deps/npm/man/man1/install.1 b/deps/npm/man/man1/npm-install.1 index 57f32acc83..d6ddfac946 100644 --- a/deps/npm/man/man1/install.1 +++ b/deps/npm/man/man1/npm-install.1 @@ -24,7 +24,7 @@ npm install <name>@<version range> .SH "DESCRIPTION" This command installs a package, and any packages that it depends on\. If the package has a shrinkwrap file, the installation of dependencies will be driven -by that\. See npm help shrinkwrap\. +npm help by that\. See npm\-shrinkwrap\. . .P A \fBpackage\fR is: @@ -120,7 +120,7 @@ Example: \fBnpm install <name> [\-\-save|\-\-save\-dev|\-\-save\-optional]\fR: . .IP -Do a \fB<name>@<tag>\fR install, where \fB<tag>\fR is the "tag" config\. (See \fBnpm help config\fR\|\.) +Do a \fB<name>@<tag>\fR install, where \fB<tag>\fR is the "tag" config\. (npm help See \fBnpm\-config\fR\|\.) . .IP In most cases, this will install the latest version @@ -207,7 +207,7 @@ Example: . .IP 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\|\. +npm help will follow the same rules for resolving dependencies described in \fBpackage\.json\fR\|\. . .IP Note that most version ranges must be put in quotes so that your shell will @@ -281,7 +281,7 @@ npm install sax \-\-force . .P The \fB\-\-global\fR argument will cause npm to install the package globally -rather than locally\. See \fBnpm help folders\fR\|\. +npm help rather than locally\. See \fBnpm\-folders\fR\|\. . .P The \fB\-\-link\fR argument will cause npm to link global installs into the @@ -300,7 +300,7 @@ The \fB\-\-nodedir=/path/to/node/source\fR argument will allow npm to find the node source code so that npm can compile native modules\. . .P -See \fBnpm help config\fR\|\. Many of the configuration params have some +npm help See \fBnpm\-config\fR\|\. Many of the configuration params have some effect on installation, since that\'s most of what npm does\. . .SH "ALGORITHM" @@ -344,7 +344,7 @@ That is, the dependency from B to C is satisfied by the fact that A already caused C to be installed at a higher level\. . .P -See npm help folders for a more detailed description of the specific +npm help See npm\-folders for a more detailed description of the specific folder structures that npm creates\. . .SS "Limitations of npm's Install Algorithm" @@ -378,7 +378,7 @@ affects a real use\-case, it will be investigated\. .SH "SEE ALSO" . .IP "\(bu" 4 -npm help folders +npm help folders . .IP "\(bu" 4 npm help update @@ -390,7 +390,7 @@ npm help link npm help rebuild . .IP "\(bu" 4 -npm help scripts +npm help scripts . .IP "\(bu" 4 npm help build @@ -399,10 +399,16 @@ npm help build npm help config . .IP "\(bu" 4 -npm help registry +npm help config . .IP "\(bu" 4 -npm help folders +npm help npmrc +. +.IP "\(bu" 4 +npm help registry +. +.IP "\(bu" 4 +npm help folders . .IP "\(bu" 4 npm help tag diff --git a/deps/npm/man/man1/link.1 b/deps/npm/man/man1/npm-link.1 index c5322b99cf..d972d85480 100644 --- a/deps/npm/man/man1/link.1 +++ b/deps/npm/man/man1/npm-link.1 @@ -91,22 +91,28 @@ installation target into your project\'s \fBnode_modules\fR folder\. .SH "SEE ALSO" . .IP "\(bu" 4 -npm help developers +npm help developers . .IP "\(bu" 4 -npm help faq +npm help faq . .IP "\(bu" 4 -npm help json +npm help package\.json . .IP "\(bu" 4 npm help install . .IP "\(bu" 4 -npm help folders +npm help folders . .IP "\(bu" 4 npm help config . +.IP "\(bu" 4 +npm help config +. +.IP "\(bu" 4 +npm help npmrc +. .IP "" 0 diff --git a/deps/npm/man/man1/ls.1 b/deps/npm/man/man1/npm-ls.1 index 4c0e793c45..39f525db5d 100644 --- a/deps/npm/man/man1/ls.1 +++ b/deps/npm/man/man1/npm-ls.1 @@ -29,7 +29,7 @@ For example, running \fBnpm ls promzard\fR in npm\'s source tree will show: .IP "" 4 . .nf -npm@1.3.2 /path/to/npm +npm@1.3.3 /path/to/npm └─┬ init\-package\-json@0\.0\.4 └── promzard@0\.1\.5 . @@ -109,7 +109,13 @@ project\. npm help config . .IP "\(bu" 4 -npm help folders +npm help config +. +.IP "\(bu" 4 +npm help npmrc +. +.IP "\(bu" 4 +npm help folders . .IP "\(bu" 4 npm help install diff --git a/deps/npm/man/man1/outdated.1 b/deps/npm/man/man1/npm-outdated.1 index dc5047f1bf..4ef2e8497a 100644 --- a/deps/npm/man/man1/outdated.1 +++ b/deps/npm/man/man1/npm-outdated.1 @@ -23,10 +23,10 @@ packages are currently outdated\. npm help update . .IP "\(bu" 4 -npm help registry +npm help registry . .IP "\(bu" 4 -npm help folders +npm help folders . .IP "" 0 diff --git a/deps/npm/man/man1/owner.1 b/deps/npm/man/man1/npm-owner.1 index cce6b266fb..b0ba9e809e 100644 --- a/deps/npm/man/man1/owner.1 +++ b/deps/npm/man/man1/npm-owner.1 @@ -46,13 +46,13 @@ that is not implemented at this time\. npm help publish . .IP "\(bu" 4 -npm help registry +npm help registry . .IP "\(bu" 4 npm help adduser . .IP "\(bu" 4 -npm help disputes +npm help disputes . .IP "" 0 diff --git a/deps/npm/man/man1/pack.1 b/deps/npm/man/man1/npm-pack.1 index 4479b87896..b591b9ebe3 100644 --- a/deps/npm/man/man1/pack.1 +++ b/deps/npm/man/man1/npm-pack.1 @@ -38,5 +38,11 @@ npm help publish .IP "\(bu" 4 npm help config . +.IP "\(bu" 4 +npm help config +. +.IP "\(bu" 4 +npm help npmrc +. .IP "" 0 diff --git a/deps/npm/man/man1/prefix.1 b/deps/npm/man/man1/npm-prefix.1 index 794f97443f..60897bc0b3 100644 --- a/deps/npm/man/man1/prefix.1 +++ b/deps/npm/man/man1/npm-prefix.1 @@ -25,10 +25,16 @@ npm help root npm help bin . .IP "\(bu" 4 -npm help folders +npm help folders . .IP "\(bu" 4 npm help config . +.IP "\(bu" 4 +npm help config +. +.IP "\(bu" 4 +npm help npmrc +. .IP "" 0 diff --git a/deps/npm/man/man1/prune.1 b/deps/npm/man/man1/npm-prune.1 index 4af9eb3594..283d6885cf 100644 --- a/deps/npm/man/man1/prune.1 +++ b/deps/npm/man/man1/npm-prune.1 @@ -28,7 +28,7 @@ package\'s dependencies list\. npm help rm . .IP "\(bu" 4 -npm help folders +npm help folders . .IP "\(bu" 4 npm help list diff --git a/deps/npm/man/man1/publish.1 b/deps/npm/man/man1/npm-publish.1 index 8ecacfbfd3..4b1d57c161 100644 --- a/deps/npm/man/man1/publish.1 +++ b/deps/npm/man/man1/npm-publish.1 @@ -35,7 +35,7 @@ the registry\. Overwrites when the "\-\-force" flag is set\. .SH "SEE ALSO" . .IP "\(bu" 4 -npm help registry +npm help registry . .IP "\(bu" 4 npm help adduser diff --git a/deps/npm/man/man1/rebuild.1 b/deps/npm/man/man1/npm-rebuild.1 index c0dc36a35d..c0dc36a35d 100644 --- a/deps/npm/man/man1/rebuild.1 +++ b/deps/npm/man/man1/npm-rebuild.1 diff --git a/deps/npm/man/man1/restart.1 b/deps/npm/man/man1/npm-restart.1 index 654e3a7c99..061c15774b 100644 --- a/deps/npm/man/man1/restart.1 +++ b/deps/npm/man/man1/npm-restart.1 @@ -27,7 +27,7 @@ If no version is specified, then it restarts the "active" version\. npm help run\-script . .IP "\(bu" 4 -npm help scripts +npm help scripts . .IP "\(bu" 4 npm help test diff --git a/deps/npm/man/man1/rm.1 b/deps/npm/man/man1/npm-rm.1 index a7abdbdac3..b19c51b1f2 100644 --- a/deps/npm/man/man1/rm.1 +++ b/deps/npm/man/man1/npm-rm.1 @@ -27,10 +27,16 @@ npm help prune npm help install . .IP "\(bu" 4 -npm help folders +npm help folders . .IP "\(bu" 4 npm help config . +.IP "\(bu" 4 +npm help config +. +.IP "\(bu" 4 +npm help npmrc +. .IP "" 0 diff --git a/deps/npm/man/man1/root.1 b/deps/npm/man/man1/npm-root.1 index 3acdfcdf5c..2fbbbd6c61 100644 --- a/deps/npm/man/man1/root.1 +++ b/deps/npm/man/man1/npm-root.1 @@ -25,10 +25,16 @@ npm help prefix npm help bin . .IP "\(bu" 4 -npm help folders +npm help folders . .IP "\(bu" 4 npm help config . +.IP "\(bu" 4 +npm help config +. +.IP "\(bu" 4 +npm help npmrc +. .IP "" 0 diff --git a/deps/npm/man/man1/run-script.1 b/deps/npm/man/man1/npm-run-script.1 index 58a74f9042..00de0d9679 100644 --- a/deps/npm/man/man1/run-script.1 +++ b/deps/npm/man/man1/npm-run-script.1 @@ -23,7 +23,7 @@ called directly, as well\. .SH "SEE ALSO" . .IP "\(bu" 4 -npm help scripts +npm help scripts . .IP "\(bu" 4 npm help test diff --git a/deps/npm/man/man1/search.1 b/deps/npm/man/man1/npm-search.1 index 503c553217..cf82b21a88 100644 --- a/deps/npm/man/man1/search.1 +++ b/deps/npm/man/man1/npm-search.1 @@ -24,12 +24,18 @@ expression characters must be escaped or quoted in most shells\.) .SH "SEE ALSO" . .IP "\(bu" 4 -npm help registry +npm help registry . .IP "\(bu" 4 npm help config . .IP "\(bu" 4 +npm help config +. +.IP "\(bu" 4 +npm help npmrc +. +.IP "\(bu" 4 npm help view . .IP "" 0 diff --git a/deps/npm/man/man1/shrinkwrap.1 b/deps/npm/man/man1/npm-shrinkwrap.1 index f84ed51629..1f81700d32 100644 --- a/deps/npm/man/man1/shrinkwrap.1 +++ b/deps/npm/man/man1/npm-shrinkwrap.1 @@ -217,7 +217,7 @@ publish your package\. .IP "" 0 . .P -You can use npm help outdated to view dependencies with newer versions +npm help You can use npm\-outdated to view dependencies with newer versions available\. . .SS "Other Notes" @@ -266,7 +266,7 @@ contents rather than versions\. npm help install . .IP "\(bu" 4 -npm help json +npm help package\.json . .IP "\(bu" 4 npm help list diff --git a/deps/npm/man/man1/star.1 b/deps/npm/man/man1/npm-star.1 index 9fbc3000b2..9fbc3000b2 100644 --- a/deps/npm/man/man1/star.1 +++ b/deps/npm/man/man1/npm-star.1 diff --git a/deps/npm/man/man1/stars.1 b/deps/npm/man/man1/npm-stars.1 index 0f23c80691..0f23c80691 100644 --- a/deps/npm/man/man1/stars.1 +++ b/deps/npm/man/man1/npm-stars.1 diff --git a/deps/npm/man/man1/start.1 b/deps/npm/man/man1/npm-start.1 index 0f02a79a9a..70146eccf3 100644 --- a/deps/npm/man/man1/start.1 +++ b/deps/npm/man/man1/npm-start.1 @@ -22,7 +22,7 @@ This runs a package\'s "start" script, if one was provided\. npm help run\-script . .IP "\(bu" 4 -npm help scripts +npm help scripts . .IP "\(bu" 4 npm help test diff --git a/deps/npm/man/man1/stop.1 b/deps/npm/man/man1/npm-stop.1 index c468de66dd..6886ba5d43 100644 --- a/deps/npm/man/man1/stop.1 +++ b/deps/npm/man/man1/npm-stop.1 @@ -22,7 +22,7 @@ This runs a package\'s "stop" script, if one was provided\. npm help run\-script . .IP "\(bu" 4 -npm help scripts +npm help scripts . .IP "\(bu" 4 npm help test diff --git a/deps/npm/man/man1/submodule.1 b/deps/npm/man/man1/npm-submodule.1 index 2063707b93..d5ad4dd476 100644 --- a/deps/npm/man/man1/submodule.1 +++ b/deps/npm/man/man1/npm-submodule.1 @@ -33,7 +33,7 @@ dependencies into the submodule folder\. .SH "SEE ALSO" . .IP "\(bu" 4 -npm help json +npm help package\.json . .IP "\(bu" 4 git help submodule diff --git a/deps/npm/man/man1/tag.1 b/deps/npm/man/man1/npm-tag.1 index 5dcba316e5..18d689f681 100644 --- a/deps/npm/man/man1/tag.1 +++ b/deps/npm/man/man1/npm-tag.1 @@ -22,10 +22,16 @@ Tags the specified version of the package with the specified tag, or the \fB\-\- npm help publish . .IP "\(bu" 4 -npm help registry +npm help registry . .IP "\(bu" 4 npm help config . +.IP "\(bu" 4 +npm help config +. +.IP "\(bu" 4 +npm help npmrc +. .IP "" 0 diff --git a/deps/npm/man/man1/test.1 b/deps/npm/man/man1/npm-test.1 index 137207273f..b8d01e6b91 100644 --- a/deps/npm/man/man1/test.1 +++ b/deps/npm/man/man1/npm-test.1 @@ -26,7 +26,7 @@ true\. npm help run\-script . .IP "\(bu" 4 -npm help scripts +npm help scripts . .IP "\(bu" 4 npm help start diff --git a/deps/npm/man/man1/uninstall.1 b/deps/npm/man/man1/npm-uninstall.1 index a7abdbdac3..b19c51b1f2 100644 --- a/deps/npm/man/man1/uninstall.1 +++ b/deps/npm/man/man1/npm-uninstall.1 @@ -27,10 +27,16 @@ npm help prune npm help install . .IP "\(bu" 4 -npm help folders +npm help folders . .IP "\(bu" 4 npm help config . +.IP "\(bu" 4 +npm help config +. +.IP "\(bu" 4 +npm help npmrc +. .IP "" 0 diff --git a/deps/npm/man/man1/unpublish.1 b/deps/npm/man/man1/npm-unpublish.1 index a4c46ec7d7..d7b64656ce 100644 --- a/deps/npm/man/man1/unpublish.1 +++ b/deps/npm/man/man1/npm-unpublish.1 @@ -41,7 +41,7 @@ npm help deprecate npm help publish . .IP "\(bu" 4 -npm help registry +npm help registry . .IP "\(bu" 4 npm help adduser diff --git a/deps/npm/man/man1/update.1 b/deps/npm/man/man1/npm-update.1 index 226df375bc..f66fe5d828 100644 --- a/deps/npm/man/man1/update.1 +++ b/deps/npm/man/man1/npm-update.1 @@ -33,10 +33,10 @@ npm help install npm help outdated . .IP "\(bu" 4 -npm help registry +npm help registry . .IP "\(bu" 4 -npm help folders +npm help folders . .IP "\(bu" 4 npm help list diff --git a/deps/npm/man/man1/version.1 b/deps/npm/man/man1/npm-version.1 index 6d0ac77c54..55c72ccb07 100644 --- a/deps/npm/man/man1/version.1 +++ b/deps/npm/man/man1/npm-version.1 @@ -66,10 +66,10 @@ Enter passphrase: npm help init . .IP "\(bu" 4 -npm help json +npm help package\.json . .IP "\(bu" 4 -npm help semver +npm help semver . .IP "" 0 diff --git a/deps/npm/man/man1/view.1 b/deps/npm/man/man1/npm-view.1 index e5b17e7f3a..39beb4bfe8 100644 --- a/deps/npm/man/man1/view.1 +++ b/deps/npm/man/man1/npm-view.1 @@ -120,7 +120,7 @@ npm view express contributors\.name contributors\.email .P "Person" fields are shown as a string if they would be shown as an object\. So, for example, this will show the list of npm contributors in -the shortened string format\. (See \fBnpm help json\fR for more on this\.) +the shortened string format\. (npm help See \fBpackage\.json\fR for more on this\.) . .IP "" 4 . @@ -167,12 +167,18 @@ the field name\. npm help search . .IP "\(bu" 4 -npm help registry +npm help registry . .IP "\(bu" 4 npm help config . .IP "\(bu" 4 +npm help config +. +.IP "\(bu" 4 +npm help npmrc +. +.IP "\(bu" 4 npm help docs . .IP "" 0 diff --git a/deps/npm/man/man1/whoami.1 b/deps/npm/man/man1/npm-whoami.1 index 319184060b..b840711b35 100644 --- a/deps/npm/man/man1/whoami.1 +++ b/deps/npm/man/man1/npm-whoami.1 @@ -22,6 +22,12 @@ Print the \fBusername\fR config to standard output\. npm help config . .IP "\(bu" 4 +npm help config +. +.IP "\(bu" 4 +npm help npmrc +. +.IP "\(bu" 4 npm help adduser . .IP "" 0 diff --git a/deps/npm/man/man1/npm.1 b/deps/npm/man/man1/npm.1 index ed27ab9c18..ef69a83f90 100644 --- a/deps/npm/man/man1/npm.1 +++ b/deps/npm/man/man1/npm.1 @@ -14,7 +14,7 @@ npm <command> [args] .fi . .SH "VERSION" -1.3.2 +1.3.3 . .SH "DESCRIPTION" npm is the package manager for the Node JavaScript platform\. It puts @@ -33,14 +33,14 @@ Run \fBnpm help\fR to get a list of available commands\. 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\. +npm help Use \fBnpm install blerg\fR to install the latest version of "blerg"\. Check out \fBnpm\-install\fR for more info\. It can do a lot of stuff\. . .P Use the \fBnpm search\fR command to show everything that\'s available\. Use \fBnpm ls\fR to show everything you\'ve installed\. . .SH "DIRECTORIES" -See \fBnpm help folders\fR to learn about where npm puts stuff\. +npm help See \fBnpm\-folders\fR to learn about where npm puts stuff\. . .P In particular, npm has two modes of operation: @@ -70,7 +70,7 @@ following help topics: . .IP "\(bu" 4 json: -Make a package\.json file\. See \fBnpm help json\fR\|\. +npm help Make a package\.json file\. See \fBpackage\.json\fR\|\. . .IP "\(bu" 4 link: @@ -139,14 +139,14 @@ lib/utils/config\-defs\.js\. These must not be changed\. .IP "" 0 . .P -See \fBnpm help config\fR for much much more information\. +npm help See \fBnpm\-config\fR for much much more information\. . .SH "CONTRIBUTIONS" Patches welcome! . .IP "\(bu" 4 code: -Read through \fBnpm help coding\-style\fR if you plan to submit code\. +npm help Read through \fBnpm\-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 @@ -192,7 +192,7 @@ You can also look for isaacs in #node\.js on irc://irc\.freenode\.net\. He will no doubt tell you to put the output in a gist or email\. . .SH "HISTORY" -See npm help changelog +npm help See npm\-changelog . .SH "AUTHOR" Isaac Z\. Schlueter \fIhttp://blog\.izs\.me/\fR :: isaacs \fIhttps://github\.com/isaacs/\fR :: @izs \fIhttp://twitter\.com/izs\fR :: \fIi@izs\.me\fR @@ -203,13 +203,13 @@ Isaac Z\. Schlueter \fIhttp://blog\.izs\.me/\fR :: isaacs \fIhttps://github\.com npm help help . .IP "\(bu" 4 -npm help faq +npm help faq . .IP "\(bu" 4 README . .IP "\(bu" 4 -npm help json +npm help package\.json . .IP "\(bu" 4 npm help install @@ -218,7 +218,13 @@ npm help install npm help config . .IP "\(bu" 4 -npm help index +npm help config +. +.IP "\(bu" 4 +npm help npmrc +. +.IP "\(bu" 4 +npm help index . .IP "\(bu" 4 npm apihelp npm diff --git a/deps/npm/man/man1/registry.1 b/deps/npm/man/man1/registry.1 deleted file mode 100644 index 66c14b95a6..0000000000 --- a/deps/npm/man/man1/registry.1 +++ /dev/null @@ -1,107 +0,0 @@ -.\" Generated with Ronnjs 0.3.8 -.\" http://github.com/kapouer/ronnjs/ -. -.TH "NPM\-REGISTRY" "1" "July 2013" "" "" -. -.SH "NAME" -\fBnpm-registry\fR \-\- The JavaScript Package Registry -. -.SH "DESCRIPTION" -To resolve packages by name and version, npm talks to a registry website -that implements the CommonJS Package Registry specification for reading -package info\. -. -.P -Additionally, npm\'s package registry implementation supports several -write APIs as well, to allow for publishing packages and managing user -account information\. -. -.P -The official public npm registry is at \fIhttp://registry\.npmjs\.org/\fR\|\. It -is powered by a CouchDB database at \fIhttp://isaacs\.iriscouch\.com/registry\fR\|\. The code for the couchapp is -available at \fIhttp://github\.com/isaacs/npmjs\.org\fR\|\. npm user accounts -are CouchDB users, stored in the \fIhttp://isaacs\.iriscouch\.com/_users\fR -database\. -. -.P -The registry URL is supplied by the \fBregistry\fR config parameter\. See \fBnpm help config\fR for more on managing npm\'s configuration\. -. -.SH "Can I run my own private registry?" -Yes! -. -.P -The easiest way is to replicate the couch database, and use the same (or -similar) design doc to implement the APIs\. -. -.P -If you set up continuous replication from the official CouchDB, and then -set your internal CouchDB as the registry config, then you\'ll be able -to read any published packages, in addition to your private ones, and by -default will only publish internally\. If you then want to publish a -package for the whole world to see, you can simply override the \fB\-\-registry\fR config for that command\. -. -.SH "I don't want my package published in the official registry\. It's private\." -Set \fB"private": true\fR in your package\.json to prevent it from being -published at all, or \fB"publishConfig":{"registry":"http://my\-internal\-registry\.local"}\fR -to force it to be published only to your internal registry\. -. -.P -See \fBnpm help json\fR for more info on what goes in the package\.json file\. -. -.SH "Will you replicate from my registry into the public one?" -No\. If you want things to be public, then publish them into the public -registry using npm\. What little security there is would be for nought -otherwise\. -. -.SH "Do I have to use couchdb to build a registry that npm can talk to?" -No, but it\'s way easier\. -. -.SH "I published something elsewhere, and want to tell the npm registry about it\." -That is supported, but not using the npm client\. You\'ll have to get -your hands dirty and do some HTTP\. The request looks something like -this: -. -.IP "" 4 -. -.nf -PUT /my\-foreign\-package -content\-type:application/json -accept:application/json -authorization:Basic $base_64_encoded -{ "name":"my\-foreign\-package" -, "maintainers":["owner","usernames"] -, "description":"A package that is hosted elsewhere" -, "keywords":["nih","my cheese smells the best"] -, "url":"http://my\-different\-registry\.com/blerg/my\-local\-package" -} -. -.fi -. -.IP "" 0 -. -.P -(Keywords and description are optional, but recommended\. Name, -maintainers, and url are required\.) -. -.P -Then, when a user tries to install "my\-foreign\-package", it\'ll redirect -to your registry\. If that doesn\'t resolve to a valid package entry, -then it\'ll fail, so please make sure that you understand the spec, and -ask for help on the \fInpm\-@googlegroups\.com\fR mailing list\. -. -.SH "Is there a website or something to see package docs and such?" -Yes, head over to \fIhttps://npmjs\.org/\fR -. -.SH "SEE ALSO" -. -.IP "\(bu" 4 -npm help config -. -.IP "\(bu" 4 -npm help developers -. -.IP "\(bu" 4 -npm help disputes -. -.IP "" 0 - diff --git a/deps/npm/man/man1/removing-npm.1 b/deps/npm/man/man1/removing-npm.1 deleted file mode 100644 index d741b60f5a..0000000000 --- a/deps/npm/man/man1/removing-npm.1 +++ /dev/null @@ -1,107 +0,0 @@ -.\" Generated with Ronnjs 0.3.8 -.\" http://github.com/kapouer/ronnjs/ -. -.TH "NPM\-REMOVAL" "1" "July 2013" "" "" -. -.SH "NAME" -\fBnpm-removal\fR \-\- Cleaning the Slate -. -.SH "SYNOPSIS" -So sad to see you go\. -. -.IP "" 4 -. -.nf -sudo npm uninstall npm \-g -. -.fi -. -.IP "" 0 -. -.P -Or, if that fails, get the npm source code, and do: -. -.IP "" 4 -. -.nf -sudo make uninstall -. -.fi -. -.IP "" 0 -. -.SH "More Severe Uninstalling" -Usually, the above instructions are sufficient\. That will remove -npm, but leave behind anything you\'ve installed\. -. -.P -If that doesn\'t work, or if you require more drastic measures, -continue reading\. -. -.P -Note that this is only necessary for globally\-installed packages\. Local -installs are completely contained within a project\'s \fBnode_modules\fR -folder\. Delete that folder, and everything is gone (unless a package\'s -install script is particularly ill\-behaved)\. -. -.P -This assumes that you installed node and npm in the default place\. If -you configured node with a different \fB\-\-prefix\fR, or installed npm with a -different prefix setting, then adjust the paths accordingly, replacing \fB/usr/local\fR with your install prefix\. -. -.P -To remove everything npm\-related manually: -. -.IP "" 4 -. -.nf -rm \-rf /usr/local/{lib/node{,/\.npm,_modules},bin,share/man}/npm* -. -.fi -. -.IP "" 0 -. -.P -If you installed things \fIwith\fR npm, then your best bet is to uninstall -them with npm first, and then install them again once you have a -proper install\. This can help find any symlinks that are lying -around: -. -.IP "" 4 -. -.nf -ls \-laF /usr/local/{lib/node{,/\.npm},bin,share/man} | grep npm -. -.fi -. -.IP "" 0 -. -.P -Prior to version 0\.3, npm used shim files for executables and node -modules\. To track those down, you can do the following: -. -.IP "" 4 -. -.nf -find /usr/local/{lib/node,bin} \-exec grep \-l npm \\{\\} \\; ; -. -.fi -. -.IP "" 0 -. -.P -(This is also in the README file\.) -. -.SH "SEE ALSO" -. -.IP "\(bu" 4 -README -. -.IP "\(bu" 4 -npm help rm -. -.IP "\(bu" 4 -npm help prune -. -.IP "" 0 - diff --git a/deps/npm/man/man1/scripts.1 b/deps/npm/man/man1/scripts.1 deleted file mode 100644 index b728194bf9..0000000000 --- a/deps/npm/man/man1/scripts.1 +++ /dev/null @@ -1,351 +0,0 @@ -.\" Generated with Ronnjs 0.3.8 -.\" http://github.com/kapouer/ronnjs/ -. -.TH "NPM\-SCRIPTS" "1" "July 2013" "" "" -. -.SH "NAME" -\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: -. -.IP "\(bu" 4 -prepublish: -Run BEFORE the package is published\. (Also run on local \fBnpm -install\fR without any arguments\.) -. -.IP "\(bu" 4 -publish, postpublish: -Run AFTER the package is published\. -. -.IP "\(bu" 4 -preinstall: -Run BEFORE the package is installed -. -.IP "\(bu" 4 -install, postinstall: -Run AFTER the package is installed\. -. -.IP "\(bu" 4 -preuninstall, uninstall: -Run BEFORE the package is uninstalled\. -. -.IP "\(bu" 4 -postuninstall: -Run AFTER the package is uninstalled\. -. -.IP "\(bu" 4 -preupdate: -Run BEFORE the package is updated with the update command\. -. -.IP "\(bu" 4 -update, postupdate: -Run AFTER the package is updated with the update command\. -. -.IP "\(bu" 4 -pretest, test, posttest: -Run by the \fBnpm test\fR command\. -. -.IP "\(bu" 4 -prestop, stop, poststop: -Run by the \fBnpm stop\fR command\. -. -.IP "\(bu" 4 -prestart, start, poststart: -Run by the \fBnpm start\fR command\. -. -.IP "\(bu" 4 -prerestart, restart, postrestart: -Run by the \fBnpm restart\fR command\. Note: \fBnpm restart\fR will run the -stop and start scripts if no \fBrestart\fR script is provided\. -. -.IP "" 0 -. -.P -Additionally, arbitrary scrips can be run by doing \fBnpm run\-script <stage> <pkg>\fR\|\. -. -.SH "NOTE: INSTALL SCRIPTS ARE AN ANTIPATTERN" -\fBtl;dr\fR Don\'t use \fBinstall\fR\|\. Use a \fB\|\.gyp\fR file for compilation, and \fBprepublish\fR for anything else\. -. -.P -You should almost never have to explicitly set a \fBpreinstall\fR or \fBinstall\fR script\. If you are doing this, please consider if there is -another option\. -. -.P -The only valid use of \fBinstall\fR or \fBpreinstall\fR scripts is for -compilation which must be done on the target architecture\. In early -versions of node, this was often done using the \fBnode\-waf\fR scripts, or -a standalone \fBMakefile\fR, and early versions of npm required that it be -explicitly set in package\.json\. This was not portable, and harder to -do properly\. -. -.P -In the current version of node, the standard way to do this is using a \fB\|\.gyp\fR file\. If you have a file with a \fB\|\.gyp\fR extension in the root -of your package, then npm will run the appropriate \fBnode\-gyp\fR commands -automatically at install time\. This is the only officially supported -method for compiling binary addons, and does not require that you add -anything to your package\.json file\. -. -.P -If you have to do other things before your package is used, in a way -that is not dependent on the operating system or architecture of the -target system, then use a \fBprepublish\fR script instead\. This includes -tasks such as: -. -.IP "\(bu" 4 -Compile CoffeeScript source code into JavaScript\. -. -.IP "\(bu" 4 -Create minified versions of JavaScript source code\. -. -.IP "\(bu" 4 -Fetching remote resources that your package will use\. -. -.IP "" 0 -. -.P -The advantage of doing these things at \fBprepublish\fR time instead of \fBpreinstall\fR or \fBinstall\fR time is that they can be done once, in a -single place, and thus greatly reduce complexity and variability\. -Additionally, this means that: -. -.IP "\(bu" 4 -You can depend on \fBcoffee\-script\fR as a \fBdevDependency\fR, and thus -your users don\'t need to have it installed\. -. -.IP "\(bu" 4 -You don\'t need to include the minifiers in your package, reducing -the size for your users\. -. -.IP "\(bu" 4 -You don\'t need to rely on your users having \fBcurl\fR or \fBwget\fR or -other system tools on the target machines\. -. -.IP "" 0 -. -.SH "DEFAULT VALUES" -npm will default some script values based on package contents\. -. -.IP "\(bu" 4 -\fB"start": "node server\.js"\fR: -. -.IP -If there is a \fBserver\.js\fR file in the root of your package, then npm -will default the \fBstart\fR command to \fBnode server\.js\fR\|\. -. -.IP "\(bu" 4 -\fB"preinstall": "node\-waf clean || true; node\-waf configure build"\fR: -. -.IP -If there is a \fBwscript\fR file in the root of your package, npm will -default the \fBpreinstall\fR command to compile using node\-waf\. -. -.IP "" 0 -. -.SH "USER" -If npm was invoked with root privileges, then it will change the uid to -the user account or uid specified by the \fBuser\fR config, which defaults -to \fBnobody\fR\|\. Set the \fBunsafe\-perm\fR flag to run scripts with root -privileges\. -. -.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\. -. -.SS "path" -If you depend on modules that define executable scripts, like test suites, -then those executables will be added to the \fBPATH\fR for executing the scripts\. -So, if your package\.json has this: -. -.IP "" 4 -. -.nf -{ "name" : "foo" -, "dependencies" : { "bar" : "0\.1\.x" } -, "scripts": { "start" : "bar \./test" } } -. -.fi -. -.IP "" 0 -. -.P -then you could run \fBnpm start\fR to execute the \fBbar\fR script, which is exported -into the \fBnode_modules/\.bin\fR directory on \fBnpm install\fR\|\. -. -.SS "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" -. -.SS "configuration" -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\. -. -.SS "Special: package\.json "config" hash" -The package\.json "config" keys are overwritten in the environment if -there is a config param of \fB<name>[@<version>]:<key>\fR\|\. For example, if -the package\.json has this: -. -.IP "" 4 -. -.nf -{ "name" : "foo" -, "config" : { "port" : "8080" } -, "scripts" : { "start" : "node server\.js" } } -. -.fi -. -.IP "" 0 -. -.P -and the server\.js is this: -. -.IP "" 4 -. -.nf -http\.createServer(\.\.\.)\.listen(process\.env\.npm_package_config_port) -. -.fi -. -.IP "" 0 -. -.P -then the user could change the behavior by doing: -. -.IP "" 4 -. -.nf -npm config set foo:port 80 -. -.fi -. -.IP "" 0 -. -.SS "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\. -. -.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: -. -.IP "" 4 -. -.nf -process\.env\.npm_package_scripts_install === "foo\.js" -. -.fi -. -.IP "" 0 -. -.SH "EXAMPLES" -For example, if your package\.json contains this: -. -.IP "" 4 -. -.nf -{ "scripts" : - { "install" : "scripts/install\.js" - , "postinstall" : "scripts/install\.js" - , "uninstall" : "scripts/uninstall\.js" - } -} -. -.fi -. -.IP "" 0 -. -.P -then the \fBscripts/install\.js\fR will be called for the install, post\-install, -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: -. -.IP "" 4 -. -.nf -{ "scripts" : - { "preinstall" : "\./configure" - , "install" : "make && make install" - , "test" : "make test" - } -} -. -.fi -. -.IP "" 0 -. -.SH "EXITING" -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\. -. -.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\. -. -.SH "HOOK SCRIPTS" -If you want to run a specific script at a specific lifecycle event for ALL -packages, then you can use a hook script\. -. -.P -Place an executable file at \fBnode_modules/\.hooks/{eventname}\fR, and it\'ll get -run for all packages when they are going through that point in the package -lifecycle for any packages installed in that root\. -. -.P -Hook scripts are run exactly the same way as package\.json scripts\. That is, -they are in a separate child process, with the env described above\. -. -.SH "BEST PRACTICES" -. -.IP "\(bu" 4 -Don\'t exit with a non\-zero error code unless you \fIreally\fR mean it\. -Except for uninstall scripts, this will cause the npm action -to fail, and potentially be rolled back\. If the failure is minor or -only will prevent some optional features, then it\'s better to just -print a warning and exit successfully\. -. -.IP "\(bu" 4 -Try not to use scripts to do what npm can do for you\. Read through \fBnpm help json\fR to see all the things that you can specify and enable -by simply describing your package appropriately\. In general, this will -lead to a more robust and consistent state\. -. -.IP "\(bu" 4 -Inspect the env to determine where to put things\. For instance, if -the \fBnpm_config_binroot\fR environ is set to \fB/home/user/bin\fR, then don\'t -try to install executables into \fB/usr/local/bin\fR\|\. The user probably -set it up that way for a reason\. -. -.IP "\(bu" 4 -Don\'t prefix your script commands with "sudo"\. If root permissions are -required for some reason, then it\'ll fail with that error, and the user -will sudo the npm command in question\. -. -.IP "" 0 -. -.SH "SEE ALSO" -. -.IP "\(bu" 4 -npm help run\-script -. -.IP "\(bu" 4 -npm help json -. -.IP "\(bu" 4 -npm help developers -. -.IP "\(bu" 4 -npm help install -. -.IP "" 0 - diff --git a/deps/npm/man/man1/semver.1 b/deps/npm/man/man1/semver.1 deleted file mode 100644 index 5145ed61ee..0000000000 --- a/deps/npm/man/man1/semver.1 +++ /dev/null @@ -1,221 +0,0 @@ -.\" Generated with Ronnjs 0.3.8 -.\" http://github.com/kapouer/ronnjs/ -. -.TH "NPM\-SEMVER" "1" "July 2013" "" "" -. -.SH "NAME" -\fBnpm-semver\fR \-\- The semantic versioner for npm -. -.SH "SYNOPSIS" -The npm semantic versioning utility\. -. -.SH "DESCRIPTION" -As a node module: -. -.IP "" 4 -. -.nf -$ npm install semver -semver\.valid(\'1\.2\.3\') // \'1\.2\.3\' -semver\.valid(\'a\.b\.c\') // null -semver\.clean(\' =v1\.2\.3 \') // \'1\.2\.3\' -semver\.satisfies(\'1\.2\.3\', \'1\.x || >=2\.5\.0 || 5\.0\.0 \- 7\.2\.3\') // true -semver\.gt(\'1\.2\.3\', \'9\.8\.7\') // false -semver\.lt(\'1\.2\.3\', \'9\.8\.7\') // true -. -.fi -. -.IP "" 0 -. -.P -As a command\-line utility: -. -.IP "" 4 -. -.nf -$ npm install semver \-g -$ semver \-h -Usage: semver \-v <version> [\-r <range>] -Test if version(s) satisfy the supplied range(s), -and sort them\. -Multiple versions or ranges may be supplied\. -Program exits successfully if any valid version satisfies -all supplied ranges, and prints all satisfying versions\. -If no versions are valid, or ranges are not satisfied, -then exits failure\. -Versions are printed in ascending order, so supplying -multiple versions to the utility will just sort them\. -. -.fi -. -.IP "" 0 -. -.SH "Versions" -A version is the following things, in this order: -. -.IP "\(bu" 4 -a number (Major) -. -.IP "\(bu" 4 -a period -. -.IP "\(bu" 4 -a number (minor) -. -.IP "\(bu" 4 -a period -. -.IP "\(bu" 4 -a number (patch) -. -.IP "\(bu" 4 -OPTIONAL: a hyphen, followed by a number (build) -. -.IP "\(bu" 4 -OPTIONAL: a collection of pretty much any non\-whitespace characters -(tag) -. -.IP "" 0 -. -.P -A leading \fB"="\fR or \fB"v"\fR character is stripped off and ignored\. -. -.SH "Comparisons" -The ordering of versions is done using the following algorithm, given -two versions and asked to find the greater of the two: -. -.IP "\(bu" 4 -If the majors are numerically different, then take the one -with a bigger major number\. \fB2\.3\.4 > 1\.3\.4\fR -. -.IP "\(bu" 4 -If the minors are numerically different, then take the one -with the bigger minor number\. \fB2\.3\.4 > 2\.2\.4\fR -. -.IP "\(bu" 4 -If the patches are numerically different, then take the one with the -bigger patch number\. \fB2\.3\.4 > 2\.3\.3\fR -. -.IP "\(bu" 4 -If only one of them has a build number, then take the one with the -build number\. \fB2\.3\.4\-0 > 2\.3\.4\fR -. -.IP "\(bu" 4 -If they both have build numbers, and the build numbers are numerically -different, then take the one with the bigger build number\. \fB2\.3\.4\-10 > 2\.3\.4\-9\fR -. -.IP "\(bu" 4 -If only one of them has a tag, then take the one without the tag\. \fB2\.3\.4 > 2\.3\.4\-beta\fR -. -.IP "\(bu" 4 -If they both have tags, then take the one with the lexicographically -larger tag\. \fB2\.3\.4\-beta > 2\.3\.4\-alpha\fR -. -.IP "\(bu" 4 -At this point, they\'re equal\. -. -.IP "" 0 -. -.SH "Ranges" -The following range styles are supported: -. -.IP "\(bu" 4 -\fB>1\.2\.3\fR Greater than a specific version\. -. -.IP "\(bu" 4 -\fB<1\.2\.3\fR Less than -. -.IP "\(bu" 4 -\fB1\.2\.3 \- 2\.3\.4\fR := \fB>=1\.2\.3 <=2\.3\.4\fR -. -.IP "\(bu" 4 -\fB~1\.2\.3\fR := \fB>=1\.2\.3 <1\.3\.0\fR -. -.IP "\(bu" 4 -\fB~1\.2\fR := \fB>=1\.2\.0 <1\.3\.0\fR -. -.IP "\(bu" 4 -\fB~1\fR := \fB>=1\.0\.0 <2\.0\.0\fR -. -.IP "\(bu" 4 -\fB1\.2\.x\fR := \fB>=1\.2\.0 <1\.3\.0\fR -. -.IP "\(bu" 4 -\fB1\.x\fR := \fB>=1\.0\.0 <2\.0\.0\fR -. -.IP "" 0 -. -.P -Ranges can be joined with either a space (which implies "and") or a \fB||\fR (which implies "or")\. -. -.SH "Functions" -. -.IP "\(bu" 4 -valid(v): Return the parsed version, or null if it\'s not valid\. -. -.IP "\(bu" 4 -inc(v, release): Return the version incremented by the release type -(major, minor, patch, or build), or null if it\'s not valid\. -. -.IP "" 0 -. -.SS "Comparison" -. -.IP "\(bu" 4 -gt(v1, v2): \fBv1 > v2\fR -. -.IP "\(bu" 4 -gte(v1, v2): \fBv1 >= v2\fR -. -.IP "\(bu" 4 -lt(v1, v2): \fBv1 < v2\fR -. -.IP "\(bu" 4 -lte(v1, v2): \fBv1 <= v2\fR -. -.IP "\(bu" 4 -eq(v1, v2): \fBv1 == v2\fR This is true if they\'re logically equivalent, -even if they\'re not the exact same string\. You already know how to -compare strings\. -. -.IP "\(bu" 4 -neq(v1, v2): \fBv1 != v2\fR The opposite of eq\. -. -.IP "\(bu" 4 -cmp(v1, comparator, v2): Pass in a comparison string, and it\'ll call -the corresponding function above\. \fB"==="\fR and \fB"!=="\fR do simple -string comparison, but are included for completeness\. Throws if an -invalid comparison string is provided\. -. -.IP "\(bu" 4 -compare(v1, v2): Return 0 if v1 == v2, or 1 if v1 is greater, or \-1 if -v2 is greater\. Sorts in ascending order if passed to Array\.sort()\. -. -.IP "\(bu" 4 -rcompare(v1, v2): The reverse of compare\. Sorts an array of versions -in descending order when passed to Array\.sort()\. -. -.IP "" 0 -. -.SS "Ranges" -. -.IP "\(bu" 4 -validRange(range): Return the valid range or null if it\'s not valid -. -.IP "\(bu" 4 -satisfies(version, range): Return true if the version satisfies the -range\. -. -.IP "\(bu" 4 -maxSatisfying(versions, range): Return the highest version in the list -that satisfies the range, or null if none of them do\. -. -.IP "" 0 -. -.SH "SEE ALSO" -. -.IP "\(bu" 4 -npm help json -. -.IP "" 0 - diff --git a/deps/npm/man/man1/set.1 b/deps/npm/man/man1/set.1 deleted file mode 100644 index 5075c9f0cc..0000000000 --- a/deps/npm/man/man1/set.1 +++ /dev/null @@ -1,1154 +0,0 @@ -.\" Generated with Ronnjs/v0.1 -.\" http://github.com/kapouer/ronnjs/ -. -.TH "NPM\-CONFIG" "1" "November 2011" "" "" -. -.SH "NAME" -\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> -npm config list -npm config edit -npm get <key> -npm set <key> <value> [\-\-global] -. -.fi -. -.SH "DESCRIPTION" -npm gets its configuration values from 6 sources, in this priority: -. -.SS "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\|\. -. -.SS "Environment Variables" -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\. -. -.SS "Per\-user config file" -\fB$HOME/\.npmrc\fR (or the \fBuserconfig\fR param, if set above) -. -.P -This file is an ini\-file formatted list of \fBkey = value\fR parameters\. -. -.SS "Global config file" -\fB$PREFIX/etc/npmrc\fR (or the \fBglobalconfig\fR param, if set above): -This file is an ini\-file formatted list of \fBkey = value\fR parameters -. -.SS "Built\-in config file" -\fBpath/to/npm/itself/npmrc\fR -. -.P -This is an unchangeable "builtin" -configuration file that npm keeps consistent across updates\. Set -fields in here using the \fB\|\./configure\fR script that comes with npm\. -This is primarily for distribution maintainers to override default -configs in a standard and consistent manner\. -. -.SS "Default Configs" -A set of configuration parameters that are internal to npm, and are -defaults if nothing else is specified\. -. -.SH "Sub\-commands" -Config supports the following sub\-commands: -. -.SS "set" -. -.nf -npm config set key value -. -.fi -. -.P -Sets the config key to the value\. -. -.P -If value is omitted, then it sets it to "true"\. -. -.SS "get" -. -.nf -npm config get key -. -.fi -. -.P -Echo the config value to stdout\. -. -.SS "list" -. -.nf -npm config list -. -.fi -. -.P -Show all the config settings\. -. -.SS "delete" -. -.nf -npm config delete key -. -.fi -. -.P -Deletes the key from all configuration files\. -. -.SS "edit" -. -.nf -npm config edit -. -.fi -. -.P -Opens the config file in an editor\. Use the \fB\-\-global\fR flag to edit the -global config\. -. -.SH "Shorthands and Other CLI Niceties" -The following shorthands are parsed on the command\-line: -. -.IP "\(bu" 4 -\fB\-v\fR: \fB\-\-version\fR -. -.IP "\(bu" 4 -\fB\-h\fR, \fB\-?\fR, \fB\-\-help\fR, \fB\-H\fR: \fB\-\-usage\fR -. -.IP "\(bu" 4 -\fB\-s\fR, \fB\-\-silent\fR: \fB\-\-loglevel silent\fR -. -.IP "\(bu" 4 -\fB\-d\fR: \fB\-\-loglevel info\fR -. -.IP "\(bu" 4 -\fB\-dd\fR, \fB\-\-verbose\fR: \fB\-\-loglevel verbose\fR -. -.IP "\(bu" 4 -\fB\-ddd\fR: \fB\-\-loglevel silly\fR -. -.IP "\(bu" 4 -\fB\-g\fR: \fB\-\-global\fR -. -.IP "\(bu" 4 -\fB\-l\fR: \fB\-\-long\fR -. -.IP "\(bu" 4 -\fB\-m\fR: \fB\-\-message\fR -. -.IP "\(bu" 4 -\fB\-p\fR, \fB\-\-porcelain\fR: \fB\-\-parseable\fR -. -.IP "\(bu" 4 -\fB\-reg\fR: \fB\-\-registry\fR -. -.IP "\(bu" 4 -\fB\-v\fR: \fB\-\-version\fR -. -.IP "\(bu" 4 -\fB\-f\fR: \fB\-\-force\fR -. -.IP "\(bu" 4 -\fB\-l\fR: \fB\-\-long\fR -. -.IP "\(bu" 4 -\fB\-desc\fR: \fB\-\-description\fR -. -.IP "\(bu" 4 -\fB\-S\fR: \fB\-\-save\fR -. -.IP "\(bu" 4 -\fB\-y\fR: \fB\-\-yes\fR -. -.IP "\(bu" 4 -\fB\-n\fR: \fB\-\-yes false\fR -. -.IP "\(bu" 4 -\fBll\fR and \fBla\fR commands: \fBls \-\-long\fR -. -.IP "" 0 -. -.P -If the specified configuration param resolves unambiguously to a known -configuration parameter, then it is expanded to that configuration -parameter\. For example: -. -.IP "" 4 -. -.nf -npm ls \-\-par -# same as: -npm ls \-\-parseable -. -.fi -. -.IP "" 0 -. -.P -If multiple single\-character shorthands are strung together, and the -resulting combination is unambiguously not some other configuration -param, then it is expanded to its various component pieces\. For -example: -. -.IP "" 4 -. -.nf -npm ls \-gpld -# same as: -npm ls \-\-global \-\-parseable \-\-long \-\-loglevel info -. -.fi -. -.IP "" 0 -. -.SH "Per\-Package Config Settings" -When running scripts (see \fBnpm help scripts\fR) -the package\.json "config" keys are overwritten in the environment if -there is a config param of \fB<name>[@<version>]:<key>\fR\|\. For example, if -the package\.json has this: -. -.IP "" 4 -. -.nf -{ "name" : "foo" -, "config" : { "port" : "8080" } -, "scripts" : { "start" : "node server\.js" } } -. -.fi -. -.IP "" 0 -. -.P -and the server\.js is this: -. -.IP "" 4 -. -.nf -http\.createServer(\.\.\.)\.listen(process\.env\.npm_package_config_port) -. -.fi -. -.IP "" 0 -. -.P -then the user could change the behavior by doing: -. -.IP "" 4 -. -.nf -npm config set foo:port 80 -. -.fi -. -.IP "" 0 -. -.SH "Config Settings" -. -.SS "always\-auth" -. -.IP "\(bu" 4 -Default: false -. -.IP "\(bu" 4 -Type: Boolean -. -.IP "" 0 -. -.P -Force npm to always require authentication when accessing the registry, -even for \fBGET\fR requests\. -. -.SS "bin\-publish" -. -.IP "\(bu" 4 -Default: false -. -.IP "\(bu" 4 -Type: Boolean -. -.IP "" 0 -. -.P -If set to true, then binary packages will be created on publish\. -. -.P -This is the way to opt into the "bindist" behavior described below\. -. -.SS "bindist" -. -.IP "\(bu" 4 -Default: Unstable node versions, \fBnull\fR, otherwise \fB"<node version>\-<platform>\-<os release>"\fR -. -.IP "\(bu" 4 -Type: String or \fBnull\fR -. -.IP "" 0 -. -.P -Experimental: on stable versions of node, binary distributions will be -created with this tag\. If a user then installs that package, and their \fBbindist\fR tag is found in the list of binary distributions, they will -get that prebuilt version\. -. -.P -Pre\-build node packages have their preinstall, install, and postinstall -scripts stripped (since they are run prior to publishing), and do not -have their \fBbuild\fR directories automatically ignored\. -. -.P -It\'s yet to be seen if this is a good idea\. -. -.SS "browser" -. -.IP "\(bu" 4 -Default: OS X: \fB"open"\fR, others: \fB"google\-chrome"\fR -. -.IP "\(bu" 4 -Type: String -. -.IP "" 0 -. -.P -The browser that is called by the \fBnpm docs\fR command to open websites\. -. -.SS "ca" -. -.IP "\(bu" 4 -Default: The npm CA certificate -. -.IP "\(bu" 4 -Type: String or null -. -.IP "" 0 -. -.P -The Certificate Authority signing certificate that is trusted for SSL -connections to the registry\. -. -.P -Set to \fBnull\fR to only allow "known" registrars, or to a specific CA cert -to trust only that specific signing authority\. -. -.P -See also the \fBstrict\-ssl\fR config\. -. -.SS "cache" -. -.IP "\(bu" 4 -Default: Windows: \fB~/npm\-cache\fR, Posix: \fB~/\.npm\fR -. -.IP "\(bu" 4 -Type: path -. -.IP "" 0 -. -.P -The location of npm\'s cache directory\. See \fBnpm help cache\fR -. -.SS "color" -. -.IP "\(bu" 4 -Default: true on Posix, false on Windows -. -.IP "\(bu" 4 -Type: Boolean or \fB"always"\fR -. -.IP "" 0 -. -.P -If false, never shows colors\. If \fB"always"\fR then always shows colors\. -If true, then only prints color codes for tty file descriptors\. -. -.SS "depth" -. -.IP "\(bu" 4 -Default: Infinity -. -.IP "\(bu" 4 -Type: Number -. -.IP "" 0 -. -.P -The depth to go when recursing directories for \fBnpm ls\fR and \fBnpm cache ls\fR\|\. -. -.SS "description" -. -.IP "\(bu" 4 -Default: true -. -.IP "\(bu" 4 -Type: Boolean -. -.IP "" 0 -. -.P -Show the description in \fBnpm search\fR -. -.SS "dev" -. -.IP "\(bu" 4 -Default: false -. -.IP "\(bu" 4 -Type: Boolean -. -.IP "" 0 -. -.P -Install \fBdev\-dependencies\fR along with packages\. -. -.P -Note that \fBdev\-dependencies\fR are also installed if the \fBnpat\fR flag is -set\. -. -.SS "editor" -. -.IP "\(bu" 4 -Default: \fBEDITOR\fR environment variable if set, or \fB"vi"\fR on Posix, -or \fB"notepad"\fR on Windows\. -. -.IP "\(bu" 4 -Type: path -. -.IP "" 0 -. -.P -The command to run for \fBnpm edit\fR or \fBnpm config edit\fR\|\. -. -.SS "force" -. -.IP "\(bu" 4 -Default: false -. -.IP "\(bu" 4 -Type: Boolean -. -.IP "" 0 -. -.P -Makes various commands more forceful\. -. -.IP "\(bu" 4 -lifecycle script failure does not block progress\. -. -.IP "\(bu" 4 -publishing clobbers previously published versions\. -. -.IP "\(bu" 4 -skips cache when requesting from the registry\. -. -.IP "\(bu" 4 -prevents checks against clobbering non\-npm files\. -. -.IP "" 0 -. -.SS "global" -. -.IP "\(bu" 4 -Default: false -. -.IP "\(bu" 4 -Type: Boolean -. -.IP "" 0 -. -.P -Operates in "global" mode, so that packages are installed into the \fBprefix\fR folder instead of the current working directory\. See \fBnpm help folders\fR for more on the differences in behavior\. -. -.IP "\(bu" 4 -packages are installed into the \fBprefix/node_modules\fR folder, instead of the -current working directory\. -. -.IP "\(bu" 4 -bin files are linked to \fBprefix/bin\fR -. -.IP "\(bu" 4 -man pages are linked to \fBprefix/share/man\fR -. -.IP "" 0 -. -.SS "globalconfig" -. -.IP "\(bu" 4 -Default: {prefix}/etc/npmrc -. -.IP "\(bu" 4 -Type: path -. -.IP "" 0 -. -.P -The config file to read for global config options\. -. -.SS "globalignorefile" -. -.IP "\(bu" 4 -Default: {prefix}/etc/npmignore -. -.IP "\(bu" 4 -Type: path -. -.IP "" 0 -. -.P -The config file to read for global ignore patterns to apply to all users -and all projects\. -. -.P -If not found, but there is a "gitignore" file in the -same directory, then that will be used instead\. -. -.SS "group" -. -.IP "\(bu" 4 -Default: GID of the current process -. -.IP "\(bu" 4 -Type: String or Number -. -.IP "" 0 -. -.P -The group to use when running package scripts in global mode as the root -user\. -. -.SS "https\-proxy" -. -.IP "\(bu" 4 -Default: the \fBHTTPS_PROXY\fR or \fBhttps_proxy\fR or \fBHTTP_PROXY\fR or \fBhttp_proxy\fR environment variables\. -. -.IP "\(bu" 4 -Type: url -. -.IP "" 0 -. -.P -A proxy to use for outgoing https requests\. -. -.SS "ignore" -. -.IP "\(bu" 4 -Default: "" -. -.IP "\(bu" 4 -Type: string -. -.IP "" 0 -. -.P -A white\-space separated list of glob patterns of files to always exclude -from packages when building tarballs\. -. -.SS "init\.version" -. -.IP "\(bu" 4 -Default: "0\.0\.0" -. -.IP "\(bu" 4 -Type: semver -. -.IP "" 0 -. -.P -The value \fBnpm init\fR should use by default for the package version\. -. -.SS "init\.author\.name" -. -.IP "\(bu" 4 -Default: "0\.0\.0" -. -.IP "\(bu" 4 -Type: String -. -.IP "" 0 -. -.P -The value \fBnpm init\fR should use by default for the package author\'s name\. -. -.SS "init\.author\.email" -. -.IP "\(bu" 4 -Default: "" -. -.IP "\(bu" 4 -Type: String -. -.IP "" 0 -. -.P -The value \fBnpm init\fR should use by default for the package author\'s email\. -. -.SS "init\.author\.url" -. -.IP "\(bu" 4 -Default: "" -. -.IP "\(bu" 4 -Type: String -. -.IP "" 0 -. -.P -The value \fBnpm init\fR should use by default for the package author\'s homepage\. -. -.SS "link" -. -.IP "\(bu" 4 -Default: false -. -.IP "\(bu" 4 -Type: Boolean -. -.IP "" 0 -. -.P -If true, then local installs will link if there is a suitable globally -installed package\. -. -.P -Note that this means that local installs can cause things to be -installed into the global space at the same time\. The link is only done -if one of the two conditions are met: -. -.IP "\(bu" 4 -The package is not already installed globally, or -. -.IP "\(bu" 4 -the globally installed version is identical to the version that is -being installed locally\. -. -.IP "" 0 -. -.SS "logfd" -. -.IP "\(bu" 4 -Default: stderr file descriptor -. -.IP "\(bu" 4 -Type: Number or Stream -. -.IP "" 0 -. -.P -The location to write log output\. -. -.SS "loglevel" -. -.IP "\(bu" 4 -Default: "warn" -. -.IP "\(bu" 4 -Type: String -. -.IP "\(bu" 4 -Values: "silent", "win", "error", "warn", "info", "verbose", "silly" -. -.IP "" 0 -. -.P -What level of logs to report\. On failure, \fIall\fR logs are written to \fBnpm\-debug\.log\fR in the current working directory\. -. -.SS "logprefix" -. -.IP "\(bu" 4 -Default: true on Posix, false on Windows -. -.IP "\(bu" 4 -Type: Boolean -. -.IP "" 0 -. -.P -Whether or not to prefix log messages with "npm" and the log level\. See -also "color" and "loglevel"\. -. -.SS "long" -. -.IP "\(bu" 4 -Default: false -. -.IP "\(bu" 4 -Type: Boolean -. -.IP "" 0 -. -.P -Show extended information in \fBnpm ls\fR -. -.SS "message" -. -.IP "\(bu" 4 -Default: "%s" -. -.IP "\(bu" 4 -Type: String -. -.IP "" 0 -. -.P -Commit message which is used by \fBnpm version\fR when creating version commit\. -. -.P -Any "%s" in the message will be replaced with the version number\. -. -.SS "node\-version" -. -.IP "\(bu" 4 -Default: process\.version -. -.IP "\(bu" 4 -Type: semver or false -. -.IP "" 0 -. -.P -The node version to use when checking package\'s "engines" hash\. -. -.SS "npat" -. -.IP "\(bu" 4 -Default: false -. -.IP "\(bu" 4 -Type: Boolean -. -.IP "" 0 -. -.P -Run tests on installation and report results to the \fBnpaturl\fR\|\. -. -.SS "npaturl" -. -.IP "\(bu" 4 -Default: Not yet implemented -. -.IP "\(bu" 4 -Type: url -. -.IP "" 0 -. -.P -The url to report npat test results\. -. -.SS "onload\-script" -. -.IP "\(bu" 4 -Default: false -. -.IP "\(bu" 4 -Type: path -. -.IP "" 0 -. -.P -A node module to \fBrequire()\fR when npm loads\. Useful for programmatic -usage\. -. -.SS "outfd" -. -.IP "\(bu" 4 -Default: standard output file descriptor -. -.IP "\(bu" 4 -Type: Number or Stream -. -.IP "" 0 -. -.P -Where to write "normal" output\. This has no effect on log output\. -. -.SS "parseable" -. -.IP "\(bu" 4 -Default: false -. -.IP "\(bu" 4 -Type: Boolean -. -.IP "" 0 -. -.P -Output parseable results from commands that write to -standard output\. -. -.SS "prefix" -. -.IP "\(bu" 4 -Default: node\'s process\.installPrefix -. -.IP "\(bu" 4 -Type: path -. -.IP "" 0 -. -.P -The location to install global items\. If set on the command line, then -it forces non\-global commands to run in the specified folder\. -. -.SS "production" -. -.IP "\(bu" 4 -Default: false -. -.IP "\(bu" 4 -Type: Boolean -. -.IP "" 0 -. -.P -Set to true to run in "production" mode\. -. -.IP "1" 4 -devDependencies are not installed at the topmost level when running -local \fBnpm install\fR without any arguments\. -. -.IP "2" 4 -Set the NODE_ENV="production" for lifecycle scripts\. -. -.IP "" 0 -. -.SS "proxy" -. -.IP "\(bu" 4 -Default: \fBHTTP_PROXY\fR or \fBhttp_proxy\fR environment variable, or null -. -.IP "\(bu" 4 -Type: url -. -.IP "" 0 -. -.P -A proxy to use for outgoing http requests\. -. -.SS "rebuild\-bundle" -. -.IP "\(bu" 4 -Default: true -. -.IP "\(bu" 4 -Type: Boolean -. -.IP "" 0 -. -.P -Rebuild bundled dependencies after installation\. -. -.SS "registry" -. -.IP "\(bu" 4 -Default: https://registry\.npmjs\.org/ -. -.IP "\(bu" 4 -Type: url -. -.IP "" 0 -. -.P -The base URL of the npm package registry\. -. -.SS "rollback" -. -.IP "\(bu" 4 -Default: true -. -.IP "\(bu" 4 -Type: Boolean -. -.IP "" 0 -. -.P -Remove failed installs\. -. -.SS "save" -. -.IP "\(bu" 4 -Default: false -. -.IP "\(bu" 4 -Type: Boolean -. -.IP "" 0 -. -.P -Save installed packages to a package\.json file as dependencies\. -. -.P -Only works if there is already a package\.json file present\. -. -.SS "searchopts" -. -.IP "\(bu" 4 -Default: "" -. -.IP "\(bu" 4 -Type: String -. -.IP "" 0 -. -.P -Space\-separated options that are always passed to search\. -. -.SS "searchexclude" -. -.IP "\(bu" 4 -Default: "" -. -.IP "\(bu" 4 -Type: String -. -.IP "" 0 -. -.P -Space\-separated options that limit the results from search\. -. -.SS "shell" -. -.IP "\(bu" 4 -Default: SHELL environment variable, or "bash" on Posix, or "cmd" on -Windows -. -.IP "\(bu" 4 -Type: path -. -.IP "" 0 -. -.P -The shell to run for the \fBnpm explore\fR command\. -. -.SS "strict\-ssl" -. -.IP "\(bu" 4 -Default: true -. -.IP "\(bu" 4 -Type: Boolean -. -.IP "" 0 -. -.P -Whether or not to do SSL key validation when making requests to the -registry via https\. -. -.P -See also the \fBca\fR config\. -. -.SS "tag" -. -.IP "\(bu" 4 -Default: latest -. -.IP "\(bu" 4 -Type: String -. -.IP "" 0 -. -.P -If you ask npm to install a package and don\'t tell it a specific version, then -it will install the specified tag\. -. -.P -Also the tag that is added to the package@version specified by the \fBnpm -tag\fR command, if no explicit tag is given\. -. -.SS "tmp" -. -.IP "\(bu" 4 -Default: TMPDIR environment variable, or "/tmp" -. -.IP "\(bu" 4 -Type: path -. -.IP "" 0 -. -.P -Where to store temporary files and folders\. All temp files are deleted -on success, but left behind on failure for forensic purposes\. -. -.SS "unicode" -. -.IP "\(bu" 4 -Default: true -. -.IP "\(bu" 4 -Type: Boolean -. -.IP "" 0 -. -.P -When set to true, npm uses unicode characters in the tree output\. When -false, it uses ascii characters to draw trees\. -. -.SS "unsafe\-perm" -. -.IP "\(bu" 4 -Default: false if running as root, true otherwise -. -.IP "\(bu" 4 -Type: Boolean -. -.IP "" 0 -. -.P -Set to true to suppress the UID/GID switching when running package -scripts\. If set explicitly to false, then installing as a non\-root user -will fail\. -. -.SS "usage" -. -.IP "\(bu" 4 -Default: false -. -.IP "\(bu" 4 -Type: Boolean -. -.IP "" 0 -. -.P -Set to show short usage output (like the \-H output) -instead of complete help when doing \fBnpm help help\fR\|\. -. -.SS "user" -. -.IP "\(bu" 4 -Default: "nobody" -. -.IP "\(bu" 4 -Type: String or Number -. -.IP "" 0 -. -.P -The UID to set to when running package scripts as root\. -. -.SS "username" -. -.IP "\(bu" 4 -Default: null -. -.IP "\(bu" 4 -Type: String -. -.IP "" 0 -. -.P -The username on the npm registry\. Set with \fBnpm adduser\fR -. -.SS "userconfig" -. -.IP "\(bu" 4 -Default: ~/\.npmrc -. -.IP "\(bu" 4 -Type: path -. -.IP "" 0 -. -.P -The location of user\-level configuration settings\. -. -.SS "userignorefile" -. -.IP "\(bu" 4 -Default: ~/\.npmignore -. -.IP "\(bu" 4 -Type: path -. -.IP "" 0 -. -.P -The location of a user\-level ignore file to apply to all packages\. -. -.P -If not found, but there is a \.gitignore file in the same directory, then -that will be used instead\. -. -.SS "umask" -. -.IP "\(bu" 4 -Default: 022 -. -.IP "\(bu" 4 -Type: Octal numeric string -. -.IP "" 0 -. -.P -The "umask" value to use when setting the file creation mode on files -and folders\. -. -.P -Folders and executables are given a mode which is \fB0777\fR masked against -this value\. Other files are given a mode which is \fB0666\fR masked against -this value\. Thus, the defaults are \fB0755\fR and \fB0644\fR respectively\. -. -.SS "version" -. -.IP "\(bu" 4 -Default: false -. -.IP "\(bu" 4 -Type: boolean -. -.IP "" 0 -. -.P -If true, output the npm version and exit successfully\. -. -.P -Only relevant when specified explicitly on the command line\. -. -.SS "viewer" -. -.IP "\(bu" 4 -Default: "man" on Posix, "browser" on Windows -. -.IP "\(bu" 4 -Type: path -. -.IP "" 0 -. -.P -The program to use to view help content\. -. -.P -Set to \fB"browser"\fR to view html help content in the default web browser\. -. -.SS "yes" -. -.IP "\(bu" 4 -Default: null -. -.IP "\(bu" 4 -Type: Boolean or null -. -.IP "" 0 -. -.P -If set to \fBnull\fR, then prompt the user for responses in some -circumstances\. -. -.P -If set to \fBtrue\fR, then answer "yes" to any prompt\. If set to \fBfalse\fR -then answer "no" to any prompt\. -. -.SH "SEE ALSO" -. -.IP "\(bu" 4 -npm help folders -. -.IP "\(bu" 4 -npm help npm -. -.IP "" 0 - |