diff options
| author | Kat Marchán <kzm@sykosomatic.org> | 2015-07-24 15:09:52 -0700 |
|---|---|---|
| committer | Jeremiah Senkpiel <fishrock123@rocketmail.com> | 2015-07-24 18:19:40 -0700 |
| commit | b73a7465c5b5aadaeb64de9ff4e56a06e98ab336 (patch) | |
| tree | 68aa5634729c6ec18379bfe1020d40299d228dc1 /deps/npm/man | |
| parent | 68b06e94e3e1de11c45b613aff9836310360a8e2 (diff) | |
| download | android-node-v8-b73a7465c5b5aadaeb64de9ff4e56a06e98ab336.tar.gz android-node-v8-b73a7465c5b5aadaeb64de9ff4e56a06e98ab336.tar.bz2 android-node-v8-b73a7465c5b5aadaeb64de9ff4e56a06e98ab336.zip | |
deps: upgrade to npm 2.13.2
PR-URL: https://github.com/nodejs/io.js/pull/2241
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Diffstat (limited to 'deps/npm/man')
84 files changed, 1232 insertions, 1229 deletions
diff --git a/deps/npm/man/man1/npm-README.1 b/deps/npm/man/man1/npm-README.1 index 8235f7ccfe..997fa50f29 100644 --- a/deps/npm/man/man1/npm-README.1 +++ b/deps/npm/man/man1/npm-README.1 @@ -7,7 +7,7 @@ Build Status \fIhttps://img\.shields\.io/travis/npm/npm/master\.svg\fR \fIhttps: .P This is just enough info to get you up and running\. .P -Much more info available via \fBnpm help\fR once it's installed\. +Much more info available via \fBnpm help\fP once it's installed\. .SH IMPORTANT .P \fBYou need node v0\.8 or higher to run this program\.\fR @@ -25,7 +25,7 @@ Get the MSI \fIhttp://nodejs\.org/download/\fR\|\. npm is in it\. Get the pkg \fIhttp://nodejs\.org/download/\fR\|\. npm is in it\. .SS Other Sorts of Unices .P -Run \fBmake install\fR\|\. npm will be installed with node\. +Run \fBmake install\fP\|\. npm will be installed with node\. .P If you want a more fancy pants install (a different version, customized paths, etc\.) then read on\. @@ -60,17 +60,17 @@ npm_debug=1 sh install\.sh .RE .SS Even Fancier .P -Get the code with git\. Use \fBmake\fR to build the docs and do other stuff\. -If you plan on hacking on npm, \fBmake link\fR is your friend\. +Get the code with git\. Use \fBmake\fP to build the docs and do other stuff\. +If you plan on hacking on npm, \fBmake link\fP is your friend\. .P If you've got the npm source code, you can also semi\-permanently set -arbitrary config keys using the \fB\|\./configure \-\-key=val \.\.\.\fR, and then -run npm commands by doing \fBnode cli\.js <cmd> <args>\fR\|\. (This is helpful +arbitrary config keys using the \fB\|\./configure \-\-key=val \.\.\.\fP, and then +run npm commands by doing \fBnode cli\.js <cmd> <args>\fP\|\. (This is helpful for testing, or running stuff without actually installing npm itself\.) .SH Windows Install or Upgrade .P You can download a zip file from https://github\.com/npm/npm/releases, and -unpack it in the \fBnode_modules\\npm\\\fR folder inside node's installation folder\. +unpack it in the \fBnode_modules\\npm\\\fP folder inside node's installation folder\. .P To upgrade to npm 2, follow the Windows upgrade instructions in the npm Troubleshooting Guide: @@ -105,11 +105,11 @@ Usually, the above instructions are sufficient\. That will remove npm, but leave behind anything you've installed\. .P If you would like to remove all the packages that you have installed, -then you can use the \fBnpm ls\fR command to find them, and then \fBnpm rm\fR to +then you can use the \fBnpm ls\fP command to find them, and then \fBnpm rm\fP to remove them\. .P To remove cruft left behind by npm 0\.x, you can use the included -\fBclean\-old\.sh\fR script file\. You can run it conveniently like this: +\fBclean\-old\.sh\fP script file\. You can run it conveniently like this: .P .RS 2 .nf @@ -136,7 +136,7 @@ you have chosen\. Although npm can be used programmatically, its API is meant for use by the CLI \fIonly\fR, and no guarantees are made regarding its fitness for any other purpose\. If you want to use npm to reliably perform some task, the safest thing to do is -to invoke the desired \fBnpm\fR command with appropriate arguments\. +to invoke the desired \fBnpm\fP command with appropriate arguments\. .P The semantic version of npm refers to the CLI itself, rather than the underlying API\. \fIThe internal API is not guaranteed to remain stable even when @@ -165,25 +165,25 @@ npm\.load(myConfigObject, function (er) { .fi .RE .P -The \fBload\fR function takes an object hash of the command\-line configs\. -The various \fBnpm\.commands\.<cmd>\fR functions take an \fBarray\fR of +The \fBload\fP function takes an object hash of the command\-line configs\. +The various \fBnpm\.commands\.<cmd>\fP functions take an \fBarray\fR of positional argument \fBstrings\fR\|\. The last argument to any -\fBnpm\.commands\.<cmd>\fR function is a callback\. Some commands take other +\fBnpm\.commands\.<cmd>\fP function is a callback\. Some commands take other optional arguments\. Read the source\. .P You cannot set configs individually for any single npm function at this -time\. Since \fBnpm\fR is a singleton, any call to \fBnpm\.config\.set\fR will +time\. Since \fBnpm\fP is a singleton, any call to \fBnpm\.config\.set\fP will change the value for \fIall\fR npm commands in that process\. .P -See \fB\|\./bin/npm\-cli\.js\fR for an example of pulling config values off of the +See \fB\|\./bin/npm\-cli\.js\fP for an example of pulling config values off of the command line arguments using nopt\. You may also want to check out \fBnpm -help config\fR to learn about all the options you can set there\. +help config\fP to learn about all the options you can set there\. .SH More Docs .P Check out the docs \fIhttps://docs\.npmjs\.com/\fR, especially the faq \fIhttps://docs\.npmjs\.com/misc/faq\fR\|\. .P -You can use the \fBnpm help\fR command to read any of them\. +You can use the \fBnpm help\fP command to read any of them\. .P If you're a developer, and you want to use npm to publish your program, you should read this \fIhttps://docs\.npmjs\.com/misc/developers\fR @@ -237,7 +237,7 @@ https://github\.com/npm/npm/issues .RE .P Be sure to include \fIall\fR of the output from the npm command that didn't work -as expected\. The \fBnpm\-debug\.log\fR file is also helpful to provide\. +as expected\. The \fBnpm\-debug\.log\fP file is also helpful to provide\. .P 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\. diff --git a/deps/npm/man/man1/npm-access.1 b/deps/npm/man/man1/npm-access.1 index e99a216d02..f1d7272469 100644 --- a/deps/npm/man/man1/npm-access.1 +++ b/deps/npm/man/man1/npm-access.1 @@ -19,7 +19,7 @@ npm access edit [<package>] .P Used to set access controls on private packages\. .P -For all of the subcommands, \fBnpm access\fR will perform actions on the packages +For all of the subcommands, \fBnpm access\fP will perform actions on the packages in the current working directory if no package name is passed to the subcommand\. .RS 0 @@ -36,19 +36,19 @@ Show all of the access privileges for a package\. Will only show permissions for packages to which you have at least read access\. .IP \(bu 2 edit: -Set the access privileges for a package at once using \fB$EDITOR\fR\|\. +Set the access privileges for a package at once using \fB$EDITOR\fP\|\. .RE .SH DETAILS .P -\fBnpm access\fR always operates directly on the current registry, configurable -from the command line using \fB\-\-registry=<registry url>\fR\|\. +\fBnpm access\fP always operates directly on the current registry, configurable +from the command line using \fB\-\-registry=<registry url>\fP\|\. .P Unscoped packages are \fIalways public\fR\|\. .P Scoped packages \fIdefault to restricted\fR, but you can either publish them as -public using \fBnpm publish \-\-access=public\fR, or set their access as public using -\fBnpm access public\fR after the initial publish\. +public using \fBnpm publish \-\-access=public\fP, or set their access as public using +\fBnpm access public\fP after the initial publish\. .P You must have privileges to set the access of a package: .RS 0 @@ -64,7 +64,7 @@ of a team or directly as an owner\. .P If your account is not paid, then attempts to publish scoped packages will fail with an HTTP 402 status code (logically enough), unless you use -\fB\-\-access=public\fR\|\. +\fB\-\-access=public\fP\|\. .SH SEE ALSO .RS 0 .IP \(bu 2 diff --git a/deps/npm/man/man1/npm-adduser.1 b/deps/npm/man/man1/npm-adduser.1 index 7d00b79527..ade506ef53 100644 --- a/deps/npm/man/man1/npm-adduser.1 +++ b/deps/npm/man/man1/npm-adduser.1 @@ -10,9 +10,9 @@ npm adduser [\-\-registry=url] [\-\-scope=@orgname] [\-\-always\-auth] .RE .SH DESCRIPTION .P -Create or verify a user named \fB<username>\fR in the specified registry, and -save the credentials to the \fB\|\.npmrc\fR file\. If no registry is specified, -the default registry will be used (see npm help 7 \fBnpm\-config\fR)\. +Create or verify a user named \fB<username>\fP in the specified registry, and +save the credentials to the \fB\|\.npmrc\fP file\. If no registry is specified, +the default registry will be used (see npm help 7 \fBnpm\-config\fP)\. .P The username, password, and email are read in from prompts\. .P @@ -25,20 +25,20 @@ authorize on a new machine\. When authenticating on a new machine, the username, password and email address must all match with your existing record\. .P -\fBnpm login\fR is an alias to \fBadduser\fR and behaves exactly the same way\. +\fBnpm login\fP is an alias to \fBadduser\fP and behaves exactly the same way\. .SH CONFIGURATION .SS registry .P Default: http://registry\.npmjs\.org/ .P -The base URL of the npm package registry\. If \fBscope\fR is also specified, -this registry will only be used for packages with that scope\. See npm help 7 \fBnpm\-scope\fR\|\. +The base URL of the npm package registry\. If \fBscope\fP is also specified, +this registry will only be used for packages with that scope\. See npm help 7 \fBnpm\-scope\fP\|\. .SS scope .P Default: none .P If specified, the user and login credentials given will be associated -with the specified scope\. See npm help 7 \fBnpm\-scope\fR\|\. You can use both at the same time, +with the specified scope\. See npm help 7 \fBnpm\-scope\fP\|\. You can use both at the same time, e\.g\. .P .RS 2 @@ -55,7 +55,7 @@ Default: false .P If specified, save configuration indicating that all requests to the given registry should include authorization information\. Useful for private -registries\. Can be used with \fB\-\-registry\fR and / or \fB\-\-scope\fR, e\.g\. +registries\. Can be used with \fB\-\-registry\fP and / or \fB\-\-scope\fP, e\.g\. .P .RS 2 .nf @@ -64,8 +64,8 @@ npm adduser \-\-registry=http://private\-registry\.example\.com \-\-always\-auth .RE .P This will ensure that all requests to that registry (including for tarballs) -include an authorization header\. See \fBalways\-auth\fR in npm help 7 \fBnpm\-config\fR for more -details on always\-auth\. Registry\-specific configuration of \fBalways\-auth\fR takes +include an authorization header\. See \fBalways\-auth\fP in npm help 7 \fBnpm\-config\fP for more +details on always\-auth\. Registry\-specific configuration of \fBalways\-auth\fP takes precedence over any global configuration\. .SH SEE ALSO .RS 0 diff --git a/deps/npm/man/man1/npm-bugs.1 b/deps/npm/man/man1/npm-bugs.1 index 126065fa5c..fde8d06191 100644 --- a/deps/npm/man/man1/npm-bugs.1 +++ b/deps/npm/man/man1/npm-bugs.1 @@ -12,20 +12,20 @@ npm bugs (with no args in a package dir) .SH DESCRIPTION .P This command tries to guess at the likely location of a package's -bug tracker URL, and then tries to open it using the \fB\-\-browser\fR +bug tracker URL, and then tries to open it using the \fB\-\-browser\fP config param\. If no package name is provided, it will search for -a \fBpackage\.json\fR in the current folder and use the \fBname\fR property\. +a \fBpackage\.json\fP in the current folder and use the \fBname\fP property\. .SH CONFIGURATION .SS browser .RS 0 .IP \(bu 2 -Default: OS X: \fB"open"\fR, Windows: \fB"start"\fR, Others: \fB"xdg\-open"\fR +Default: OS X: \fB"open"\fP, Windows: \fB"start"\fP, Others: \fB"xdg\-open"\fP .IP \(bu 2 Type: String .RE .P -The browser that is called by the \fBnpm bugs\fR command to open websites\. +The browser that is called by the \fBnpm bugs\fP command to open websites\. .SS registry .RS 0 .IP \(bu 2 diff --git a/deps/npm/man/man1/npm-build.1 b/deps/npm/man/man1/npm-build.1 index 7bfeb2b84a..d17fe158c8 100644 --- a/deps/npm/man/man1/npm-build.1 +++ b/deps/npm/man/man1/npm-build.1 @@ -10,13 +10,13 @@ npm build <package\-folder> .RE .RS 0 .IP \(bu 2 -\fB<package\-folder>\fR: -A folder containing a \fBpackage\.json\fR file in its root\. +\fB<package\-folder>\fP: +A folder containing a \fBpackage\.json\fP file in its root\. .RE .SH DESCRIPTION .P -This is the plumbing command called by \fBnpm link\fR and \fBnpm install\fR\|\. +This is the plumbing command called by \fBnpm link\fP and \fBnpm install\fP\|\. .P It should generally be called during installation, but if you need to run it directly, run: diff --git a/deps/npm/man/man1/npm-bundle.1 b/deps/npm/man/man1/npm-bundle.1 index 202a09079c..04bd969427 100644 --- a/deps/npm/man/man1/npm-bundle.1 +++ b/deps/npm/man/man1/npm-bundle.1 @@ -3,11 +3,11 @@ \fBnpm-bundle\fR \- REMOVED .SH DESCRIPTION .P -The \fBnpm bundle\fR command has been removed in 1\.0, for the simple reason +The \fBnpm bundle\fP command has been removed in 1\.0, for the simple reason that it is no longer necessary, as the default behavior is now to install packages into the local space\. .P -Just use \fBnpm install\fR now to do what \fBnpm bundle\fR used to do\. +Just use \fBnpm install\fP now to do what \fBnpm bundle\fP used to do\. .SH SEE ALSO .RS 0 .IP \(bu 2 diff --git a/deps/npm/man/man1/npm-cache.1 b/deps/npm/man/man1/npm-cache.1 index dd473fc216..5c84c222a6 100644 --- a/deps/npm/man/man1/npm-cache.1 +++ b/deps/npm/man/man1/npm-cache.1 @@ -27,8 +27,8 @@ add data to the local installation cache explicitly\. .IP \(bu 2 ls: Show the data in the cache\. Argument is a path to show in the cache -folder\. Works a bit like the \fBfind\fR program, but limited by the -\fBdepth\fR config\. +folder\. Works a bit like the \fBfind\fP program, but limited by the +\fBdepth\fP config\. .IP \(bu 2 clean: Delete data out of the cache folder\. If an argument is provided, then @@ -38,9 +38,9 @@ the entire cache is cleared\. .RE .SH DETAILS .P -npm stores cache data in the directory specified in \fBnpm config get cache\fR\|\. +npm stores cache data in the directory specified in \fBnpm config get cache\fP\|\. For each package that is added to the cache, three pieces of information are -stored in \fB{cache}/{name}/{version}\fR: +stored in \fB{cache}/{name}/{version}\fP: .RS 0 .IP \(bu 2 \|\.\.\./package/package\.json: @@ -51,18 +51,18 @@ The tarball for that version\. .RE .P -Additionally, whenever a registry request is made, a \fB\|\.cache\.json\fR file +Additionally, whenever a registry request is made, a \fB\|\.cache\.json\fP file is placed at the corresponding URI, to store the ETag and the requested -data\. This is stored in \fB{cache}/{hostname}/{path}/\.cache\.json\fR\|\. +data\. This is stored in \fB{cache}/{hostname}/{path}/\.cache\.json\fP\|\. .P -Commands that make non\-essential registry requests (such as \fBsearch\fR and -\fBview\fR, or the completion scripts) generally specify a minimum timeout\. -If the \fB\|\.cache\.json\fR file is younger than the specified timeout, then +Commands that make non\-essential registry requests (such as \fBsearch\fP and +\fBview\fP, or the completion scripts) generally specify a minimum timeout\. +If the \fB\|\.cache\.json\fP file is younger than the specified timeout, then they do not make an HTTP request to the registry\. .SH CONFIGURATION .SS cache .P -Default: \fB~/\.npm\fR on Posix, or \fB%AppData%/npm\-cache\fR on Windows\. +Default: \fB~/\.npm\fP on Posix, or \fB%AppData%/npm\-cache\fP on Windows\. .P The root cache folder\. .SH SEE ALSO diff --git a/deps/npm/man/man1/npm-completion.1 b/deps/npm/man/man1/npm-completion.1 index 13a7135e08..15a8a21a0d 100644 --- a/deps/npm/man/man1/npm-completion.1 +++ b/deps/npm/man/man1/npm-completion.1 @@ -18,11 +18,11 @@ your ~/\.bashrc or ~/\.zshrc will make the completions available everywhere\. .P You may of course also pipe the output of npm completion to a file -such as \fB/usr/local/etc/bash_completion\.d/npm\fR if you have a system +such as \fB/usr/local/etc/bash_completion\.d/npm\fP if you have a system that will read that file for you\. .P -When \fBCOMP_CWORD\fR, \fBCOMP_LINE\fR, and \fBCOMP_POINT\fR are defined in the -environment, \fBnpm completion\fR acts in "plumbing mode", and outputs +When \fBCOMP_CWORD\fP, \fBCOMP_LINE\fP, and \fBCOMP_POINT\fP are defined in the +environment, \fBnpm completion\fP acts in "plumbing mode", and outputs completions based on the arguments\. .SH SEE ALSO .RS 0 diff --git a/deps/npm/man/man1/npm-config.1 b/deps/npm/man/man1/npm-config.1 index fddf9dfa9e..75c458ddbd 100644 --- a/deps/npm/man/man1/npm-config.1 +++ b/deps/npm/man/man1/npm-config.1 @@ -18,14 +18,14 @@ npm set <key> <value> [\-\-global] .SH DESCRIPTION .P npm gets its config settings from the command line, environment -variables, \fBnpmrc\fR files, and in some cases, the \fBpackage\.json\fR file\. +variables, \fBnpmrc\fP files, and in some cases, the \fBpackage\.json\fP file\. .P See npm help 5 npmrc for more information about the npmrc files\. .P -See npm help 7 \fBnpm\-config\fR for a more thorough discussion of the mechanisms +See npm help 7 \fBnpm\-config\fP for a more thorough discussion of the mechanisms involved\. .P -The \fBnpm config\fR command can be used to update and edit the contents +The \fBnpm config\fP command can be used to update and edit the contents of the user and global npmrc files\. .SH Sub\-commands .P @@ -76,7 +76,7 @@ npm config edit .fi .RE .P -Opens the config file in an editor\. Use the \fB\-\-global\fR flag to edit the +Opens the config file in an editor\. Use the \fB\-\-global\fP flag to edit the global config\. .SH SEE ALSO .RS 0 diff --git a/deps/npm/man/man1/npm-dedupe.1 b/deps/npm/man/man1/npm-dedupe.1 index ac96395296..587cfb7ac5 100644 --- a/deps/npm/man/man1/npm-dedupe.1 +++ b/deps/npm/man/man1/npm-dedupe.1 @@ -27,7 +27,7 @@ a .fi .RE .P -In this case, npm help \fBnpm\-dedupe\fR will transform the tree to: +In this case, npm help \fBnpm\-dedupe\fP will transform the tree to: .P .RS 2 .nf @@ -58,7 +58,7 @@ registry\. .P This feature is experimental, and may change in future versions\. .P -The \fB\-\-tag\fR argument will apply to all of the affected dependencies\. If a +The \fB\-\-tag\fP argument will apply to all of the affected dependencies\. If a tag with the given name exists, the tagged version is preferred over newer versions\. .SH SEE ALSO diff --git a/deps/npm/man/man1/npm-deprecate.1 b/deps/npm/man/man1/npm-deprecate.1 index a379e6b133..ae01b145a4 100644 --- a/deps/npm/man/man1/npm-deprecate.1 +++ b/deps/npm/man/man1/npm-deprecate.1 @@ -23,9 +23,9 @@ npm deprecate my\-thing@"< 0\.2\.3" "critical bug fixed in v0\.2\.3" .RE .P Note that you must be the package owner to deprecate something\. See the -\fBowner\fR and \fBadduser\fR help topics\. +\fBowner\fP and \fBadduser\fP help topics\. .P -To un\-deprecate a package, specify an empty string (\fB""\fR) for the \fBmessage\fR argument\. +To un\-deprecate a package, specify an empty string (\fB""\fP) for the \fBmessage\fP argument\. .SH SEE ALSO .RS 0 .IP \(bu 2 diff --git a/deps/npm/man/man1/npm-dist-tag.1 b/deps/npm/man/man1/npm-dist-tag.1 index b821da4f9e..51444feee3 100644 --- a/deps/npm/man/man1/npm-dist-tag.1 +++ b/deps/npm/man/man1/npm-dist-tag.1 @@ -17,7 +17,7 @@ Add, remove, and enumerate distribution tags on a package: .IP \(bu 2 add: Tags the specified version of the package with the specified tag, or the -\fB\-\-tag\fR config if not specified\. +\fB\-\-tag\fP config if not specified\. .IP \(bu 2 rm: Clear a tag that is no longer in use from the package\. @@ -45,32 +45,32 @@ npm install \-\-tag <tag> .fi .RE .P -This also applies to \fBnpm dedupe\fR\|\. +This also applies to \fBnpm dedupe\fP\|\. .P Publishing a package sets the "latest" tag to the published version unless the -\fB\-\-tag\fR option is used\. For example, \fBnpm publish \-\-tag=beta\fR\|\. +\fB\-\-tag\fP option is used\. For example, \fBnpm publish \-\-tag=beta\fP\|\. .SH PURPOSE .P Tags can be used to provide an alias instead of version numbers\. For -example, \fBnpm\fR currently uses the tag "next" to identify the upcoming +example, \fBnpm\fP currently uses the tag "next" to identify the upcoming version, and the tag "latest" to identify the current version\. .P A project might choose to have multiple streams of development, e\.g\., "stable", "canary"\. .SH CAVEATS .P -This command used to be known as \fBnpm tag\fR, which only created new tags, and so +This command used to be known as \fBnpm tag\fP, which only created new tags, and so had a different syntax\. .P Tags must share a namespace with version numbers, because they are specified in -the same slot: \fBnpm install <pkg>@<version>\fR vs \fBnpm install <pkg>@<tag>\fR\|\. +the same slot: \fBnpm install <pkg>@<version>\fP vs \fBnpm install <pkg>@<tag>\fP\|\. .P Tags that can be interpreted as valid semver ranges will be rejected\. For -example, \fBv1\.4\fR cannot be used as a tag, because it is interpreted by semver as -\fB>=1\.4\.0 <1\.5\.0\fR\|\. See https://github\.com/npm/npm/issues/6082\|\. +example, \fBv1\.4\fP cannot be used as a tag, because it is interpreted by semver as +\fB>=1\.4\.0 <1\.5\.0\fP\|\. See https://github\.com/npm/npm/issues/6082\|\. .P The simplest way to avoid semver problems with tags is to use tags that do not -begin with a number or the letter \fBv\fR\|\. +begin with a number or the letter \fBv\fP\|\. .SH SEE ALSO .RS 0 .IP \(bu 2 diff --git a/deps/npm/man/man1/npm-docs.1 b/deps/npm/man/man1/npm-docs.1 index 36c6e042aa..fa164136c5 100644 --- a/deps/npm/man/man1/npm-docs.1 +++ b/deps/npm/man/man1/npm-docs.1 @@ -14,21 +14,21 @@ npm home (with no args in a package dir) .SH DESCRIPTION .P 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 +documentation URL, and then tries to open it using the \fB\-\-browser\fP config param\. You can pass multiple package names at once\. If no -package name is provided, it will search for a \fBpackage\.json\fR in -the current folder and use the \fBname\fR property\. +package name is provided, it will search for a \fBpackage\.json\fP in +the current folder and use the \fBname\fP property\. .SH CONFIGURATION .SS browser .RS 0 .IP \(bu 2 -Default: OS X: \fB"open"\fR, Windows: \fB"start"\fR, Others: \fB"xdg\-open"\fR +Default: OS X: \fB"open"\fP, Windows: \fB"start"\fP, Others: \fB"xdg\-open"\fP .IP \(bu 2 Type: String .RE .P -The browser that is called by the \fBnpm docs\fR command to open websites\. +The browser that is called by the \fBnpm docs\fP command to open websites\. .SS registry .RS 0 .IP \(bu 2 diff --git a/deps/npm/man/man1/npm-edit.1 b/deps/npm/man/man1/npm-edit.1 index 711e8576fb..ac1857bc3d 100644 --- a/deps/npm/man/man1/npm-edit.1 +++ b/deps/npm/man/man1/npm-edit.1 @@ -11,26 +11,26 @@ npm edit <name>[@<version>] .SH DESCRIPTION .P Opens the package folder in the default editor (or whatever you've -configured as the npm \fBeditor\fR config \-\- see npm help 7 \fBnpm\-config\fR\|\.) +configured as the npm \fBeditor\fP config \-\- see npm help 7 \fBnpm\-config\fP\|\.) .P After it has been edited, the package is rebuilt so as to pick up any changes in compiled packages\. .P -For instance, you can do \fBnpm install connect\fR to install connect -into your package, and then \fBnpm edit connect\fR to make a few +For instance, you can do \fBnpm install connect\fP to install connect +into your package, and then \fBnpm edit connect\fP to make a few changes to your locally installed copy\. .SH CONFIGURATION .SS editor .RS 0 .IP \(bu 2 -Default: \fBEDITOR\fR environment variable if set, or \fB"vi"\fR on Posix, -or \fB"notepad"\fR on Windows\. +Default: \fBEDITOR\fP environment variable if set, or \fB"vi"\fP on Posix, +or \fB"notepad"\fP on Windows\. .IP \(bu 2 Type: path .RE .P -The command to run for \fBnpm edit\fR or \fBnpm config edit\fR\|\. +The command to run for \fBnpm edit\fP or \fBnpm config edit\fP\|\. .SH SEE ALSO .RS 0 .IP \(bu 2 diff --git a/deps/npm/man/man1/npm-explore.1 b/deps/npm/man/man1/npm-explore.1 index 70786382a7..40d02a1c87 100644 --- a/deps/npm/man/man1/npm-explore.1 +++ b/deps/npm/man/man1/npm-explore.1 @@ -16,7 +16,7 @@ If a command is specified, then it is run in the subshell, which then immediately terminates\. .P This is particularly handy in the case of git submodules in the -\fBnode_modules\fR folder: +\fBnode_modules\fP folder: .P .RS 2 .nf @@ -25,7 +25,7 @@ npm explore some\-dependency \-\- git pull origin master .RE .P Note that the package is \fInot\fR automatically rebuilt afterwards, so be -sure to use \fBnpm rebuild <pkg>\fR if you make any changes\. +sure to use \fBnpm rebuild <pkg>\fP if you make any changes\. .SH CONFIGURATION .SS shell .RS 0 @@ -37,7 +37,7 @@ Type: path .RE .P -The shell to run for the \fBnpm explore\fR command\. +The shell to run for the \fBnpm explore\fP command\. .SH SEE ALSO .RS 0 .IP \(bu 2 diff --git a/deps/npm/man/man1/npm-help-search.1 b/deps/npm/man/man1/npm-help-search.1 index e9284f79d1..08d9443044 100644 --- a/deps/npm/man/man1/npm-help-search.1 +++ b/deps/npm/man/man1/npm-help-search.1 @@ -15,8 +15,8 @@ terms provided, and then list the results, sorted by relevance\. .P If only one result is found, then it will show that help topic\. .P -If the argument to \fBnpm help\fR is not a known help topic, then it will -call \fBhelp\-search\fR\|\. It is rarely if ever necessary to call this +If the argument to \fBnpm help\fP is not a known help topic, then it will +call \fBhelp\-search\fP\|\. It is rarely if ever necessary to call this command directly\. .SH CONFIGURATION .SS long diff --git a/deps/npm/man/man1/npm-help.1 b/deps/npm/man/man1/npm-help.1 index 69a3f9b515..2a529a5d7e 100644 --- a/deps/npm/man/man1/npm-help.1 +++ b/deps/npm/man/man1/npm-help.1 @@ -14,8 +14,8 @@ npm help some search terms If supplied a topic, then show the appropriate documentation page\. .P If the topic does not exist, or if multiple terms are provided, then run -the \fBhelp\-search\fR command to find a match\. Note that, if \fBhelp\-search\fR -finds a single subject, then it will run \fBhelp\fR on that topic, so unique +the \fBhelp\-search\fP command to find a match\. Note that, if \fBhelp\-search\fP +finds a single subject, then it will run \fBhelp\fP on that topic, so unique matches are equivalent to specifying a topic name\. .SH CONFIGURATION .SS viewer @@ -29,7 +29,7 @@ Type: path .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\. +Set to \fB"browser"\fP to view html help content in the default web browser\. .SH SEE ALSO .RS 0 .IP \(bu 2 diff --git a/deps/npm/man/man1/npm-init.1 b/deps/npm/man/man1/npm-init.1 index f40cd2ce62..d8886630f9 100644 --- a/deps/npm/man/man1/npm-init.1 +++ b/deps/npm/man/man1/npm-init.1 @@ -21,7 +21,7 @@ the options in there\. It is strictly additive, so it does not delete options from your package\.json without a really good reason to do so\. .P -If you invoke it with \fB\-f\fR, \fB\-\-force\fR, \fB\-y\fR, or \fB\-\-yes\fR, it will use only +If you invoke it with \fB\-f\fP, \fB\-\-force\fP, \fB\-y\fP, or \fB\-\-yes\fP, it will use only defaults and not prompt you for any options\. .SH CONFIGURATION .SS scope diff --git a/deps/npm/man/man1/npm-install.1 b/deps/npm/man/man1/npm-install.1 index 994000c8e0..6639b69926 100644 --- a/deps/npm/man/man1/npm-install.1 +++ b/deps/npm/man/man1/npm-install.1 @@ -22,7 +22,7 @@ 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\. .P -A \fBpackage\fR is: +A \fBpackage\fP is: .RS 0 .IP \(bu 2 a) a folder containing a program described by a package\.json file @@ -31,13 +31,13 @@ b) a gzipped tarball containing (a) .IP \(bu 2 c) a url that resolves to (b) .IP \(bu 2 -d) a \fB<name>@<version>\fR that is published on the registry (see npm help 7 \fBnpm\-registry\fR) with (c) +d) a \fB<name>@<version>\fP that is published on the registry (see npm help 7 \fBnpm\-registry\fP) with (c) .IP \(bu 2 -e) a \fB<name>@<tag>\fR that points to (d) +e) a \fB<name>@<tag>\fP that points to (d) .IP \(bu 2 -f) a \fB<name>\fR that has a "latest" tag satisfying (e) +f) a \fB<name>\fP that has a "latest" tag satisfying (e) .IP \(bu 2 -g) a \fB<git remote url>\fR that resolves to (b) +g) a \fB<git remote url>\fP that resolves to (b) .RE .P @@ -47,23 +47,23 @@ perhaps if you also want to be able to easily install it elsewhere after packing it up into a tarball (b)\. .RS 0 .IP \(bu 2 -\fBnpm install\fR (in package directory, no arguments): +\fBnpm install\fP (in package directory, no arguments): Install the dependencies in the local node_modules folder\. - In global mode (ie, with \fB\-g\fR or \fB\-\-global\fR appended to the command), + In global mode (ie, with \fB\-g\fP or \fB\-\-global\fP appended to the command), it installs the current package context (ie, the current working directory) as a global package\. - By default, \fBnpm install\fR will install all modules listed as dependencies\. - With the \fB\-\-production\fR flag (or when the \fBNODE_ENV\fR environment variable - is set to \fBproduction\fR), npm will not install modules listed in - \fBdevDependencies\fR\|\. + By default, \fBnpm install\fP will install all modules listed as dependencies\. + With the \fB\-\-production\fP flag (or when the \fBNODE_ENV\fP environment variable + is set to \fBproduction\fP), npm will not install modules listed in + \fBdevDependencies\fP\|\. .IP \(bu 2 -\fBnpm install <folder>\fR: +\fBnpm install <folder>\fP: Install a package that is sitting in a folder on the filesystem\. .IP \(bu 2 -\fBnpm install <tarball file>\fR: +\fBnpm install <tarball file>\fP: Install a package that is sitting on the filesystem\. Note: if you just want to link a dev directory into your npm root, you can do this more easily by - using \fBnpm link\fR\|\. + using \fBnpm link\fP\|\. Example: .P .RS 2 @@ -72,7 +72,7 @@ after packing it up into a tarball (b)\. .fi .RE .IP \(bu 2 -\fBnpm install <tarball url>\fR: +\fBnpm install <tarball url>\fP: Fetch the tarball url, and then install it\. In order to distinguish between this and other options, the argument must start with "http://" or "https://" Example: @@ -83,9 +83,9 @@ after packing it up into a tarball (b)\. .fi .RE .IP \(bu 2 -\fBnpm install [@<scope>/]<name> [\-\-save|\-\-save\-dev|\-\-save\-optional]\fR: - Do a \fB<name>@<tag>\fR install, where \fB<tag>\fR is the "tag" config\. (See - npm help 7 \fBnpm\-config\fR\|\.) +\fBnpm install [@<scope>/]<name> [\-\-save|\-\-save\-dev|\-\-save\-optional]\fP: + Do a \fB<name>@<tag>\fP install, where \fB<tag>\fP is the "tag" config\. (See + npm help 7 \fBnpm\-config\fP\|\.) In most cases, this will install the latest version of the module published on npm\. Example: @@ -95,24 +95,24 @@ after packing it up into a tarball (b)\. npm install sax .fi .RE - \fBnpm install\fR takes 3 exclusive, optional flags which save or update + \fBnpm install\fP takes 3 exclusive, optional flags which save or update the package version in your main package\.json: .RS 0 .IP \(bu 2 -\fB\-\-save\fR: Package will appear in your \fBdependencies\fR\|\. +\fB\-\-save\fP: Package will appear in your \fBdependencies\fP\|\. .IP \(bu 2 -\fB\-\-save\-dev\fR: Package will appear in your \fBdevDependencies\fR\|\. +\fB\-\-save\-dev\fP: Package will appear in your \fBdevDependencies\fP\|\. .IP \(bu 2 -\fB\-\-save\-optional\fR: Package will appear in your \fBoptionalDependencies\fR\|\. +\fB\-\-save\-optional\fP: Package will appear in your \fBoptionalDependencies\fP\|\. When using any of the above options to save dependencies to your package\.json, there is an additional, optional flag: .IP \(bu 2 -\fB\-\-save\-exact\fR: Saved dependencies will be configured with an +\fB\-\-save\-exact\fP: Saved dependencies will be configured with an exact version rather than using npm's default semver range operator\. -\fB<scope>\fR is optional\. The package will be downloaded from the registry +\fB<scope>\fP is optional\. The package will be downloaded from the registry associated with the specified scope\. If no registry is associated with -the given scope the default registry is assumed\. See npm help 7 \fBnpm\-scope\fR\|\. +the given scope the default registry is assumed\. See npm help 7 \fBnpm\-scope\fP\|\. Note: if you do not include the @\-symbol on your scope name, npm will interpret this as a GitHub repository instead, see below\. Scopes names must also be followed by a slash\. @@ -142,7 +142,7 @@ fetch the package by name if it is not valid\. .RE .RS 0 .IP \(bu 2 -\fBnpm install [@<scope>/]<name>@<tag>\fR: +\fBnpm install [@<scope>/]<name>@<tag>\fP: Install the version of the package that is referenced by the specified tag\. If the tag does not exist in the registry data for that package, then this will fail\. @@ -155,7 +155,7 @@ fetch the package by name if it is not valid\. .fi .RE .IP \(bu 2 -\fBnpm install [@<scope>/]<name>@<version>\fR: +\fBnpm install [@<scope>/]<name>@<version>\fP: Install the specified version of the package\. This will fail if the version has not been published to the registry\. Example: @@ -167,9 +167,9 @@ fetch the package by name if it is not valid\. .fi .RE .IP \(bu 2 -\fBnpm install [@<scope>/]<name>@<version range>\fR: +\fBnpm install [@<scope>/]<name>@<version range>\fP: Install a version of the package matching the specified version range\. This - will follow the same rules for resolving dependencies described in npm help 5 \fBpackage\.json\fR\|\. + will follow the same rules for resolving dependencies described in npm help 5 \fBpackage\.json\fP\|\. Note that most version ranges must be put in quotes so that your shell will treat it as a single argument\. Example: @@ -181,7 +181,7 @@ fetch the package by name if it is not valid\. .fi .RE .IP \(bu 2 -\fBnpm install <git remote url>\fR: +\fBnpm install <git remote url>\fP: Install a package by cloning a git remote url\. The format of the git url is: .P @@ -190,24 +190,24 @@ fetch the package by name if it is not valid\. <protocol>://[<user>[:<password>]@]<hostname>[:<port>][:/]<path>[#<commit\-ish>] .fi .RE - \fB<protocol>\fR is one of \fBgit\fR, \fBgit+ssh\fR, \fBgit+http\fR, or - \fBgit+https\fR\|\. If no \fB<commit\-ish>\fR is specified, then \fBmaster\fR is + \fB<protocol>\fP is one of \fBgit\fP, \fBgit+ssh\fP, \fBgit+http\fP, or + \fBgit+https\fP\|\. If no \fB<commit\-ish>\fP is specified, then \fBmaster\fP is used\. The following git environment variables are recognized by npm and will be added to the environment when running git: .RS 0 .IP \(bu 2 -\fBGIT_ASKPASS\fR +\fBGIT_ASKPASS\fP .IP \(bu 2 -\fBGIT_PROXY_COMMAND\fR +\fBGIT_PROXY_COMMAND\fP .IP \(bu 2 -\fBGIT_SSH\fR +\fBGIT_SSH\fP .IP \(bu 2 -\fBGIT_SSH_COMMAND\fR +\fBGIT_SSH_COMMAND\fP .IP \(bu 2 -\fBGIT_SSL_CAINFO\fR +\fBGIT_SSL_CAINFO\fP .IP \(bu 2 -\fBGIT_SSL_NO_VERIFY\fR +\fBGIT_SSL_NO_VERIFY\fP See the git man page for details\. Examples: .P @@ -222,12 +222,12 @@ GIT_SSH_COMMAND='ssh \-i ~/\.ssh/custom_ident' npm install git+ssh://git@github\ .RE .IP \(bu 2 -\fBnpm install <githubname>/<githubrepo>[#<commit\-ish>]\fR: +\fBnpm install <githubname>/<githubrepo>[#<commit\-ish>]\fP: .IP \(bu 2 -\fBnpm install github:<githubname>/<githubrepo>[#<commit\-ish>]\fR: - Install the package at \fBhttps://github\.com/githubname/githubrepo\fR by - attempting to clone it using \fBgit\fR\|\. - If you don't specify a \fIcommit\-ish\fR then \fBmaster\fR will be used\. +\fBnpm install github:<githubname>/<githubrepo>[#<commit\-ish>]\fP: + Install the package at \fBhttps://github\.com/githubname/githubrepo\fP by + attempting to clone it using \fBgit\fP\|\. + If you don't specify a \fIcommit\-ish\fR then \fBmaster\fP will be used\. Examples: .P .RS 2 @@ -237,11 +237,11 @@ GIT_SSH_COMMAND='ssh \-i ~/\.ssh/custom_ident' npm install git+ssh://git@github\ .fi .RE .IP \(bu 2 -\fBnpm install gist:[<githubname>/]<gistID>[#<commit\-ish>]\fR: - Install the package at \fBhttps://gist\.github\.com/gistID\fR by attempting to - clone it using \fBgit\fR\|\. The GitHub username associated with the gist is - optional and will not be saved in \fBpackage\.json\fR if \fB\-\-save\fR is used\. - If you don't specify a \fIcommit\-ish\fR then \fBmaster\fR will be used\. +\fBnpm install gist:[<githubname>/]<gistID>[#<commit\-ish>]\fP: + Install the package at \fBhttps://gist\.github\.com/gistID\fP by attempting to + clone it using \fBgit\fP\|\. The GitHub username associated with the gist is + optional and will not be saved in \fBpackage\.json\fP if \fB\-\-save\fP is used\. + If you don't specify a \fIcommit\-ish\fR then \fBmaster\fP will be used\. Example: .P .RS 2 @@ -250,10 +250,10 @@ GIT_SSH_COMMAND='ssh \-i ~/\.ssh/custom_ident' npm install git+ssh://git@github\ .fi .RE .IP \(bu 2 -\fBnpm install bitbucket:<bitbucketname>/<bitbucketrepo>[#<commit\-ish>]\fR: - Install the package at \fBhttps://bitbucket\.org/bitbucketname/bitbucketrepo\fR - by attempting to clone it using \fBgit\fR\|\. - If you don't specify a \fIcommit\-ish\fR then \fBmaster\fR will be used\. +\fBnpm install bitbucket:<bitbucketname>/<bitbucketrepo>[#<commit\-ish>]\fP: + Install the package at \fBhttps://bitbucket\.org/bitbucketname/bitbucketrepo\fP + by attempting to clone it using \fBgit\fP\|\. + If you don't specify a \fIcommit\-ish\fR then \fBmaster\fP will be used\. Example: .P .RS 2 @@ -262,10 +262,10 @@ GIT_SSH_COMMAND='ssh \-i ~/\.ssh/custom_ident' npm install git+ssh://git@github\ .fi .RE .IP \(bu 2 -\fBnpm install gitlab:<gitlabname>/<gitlabrepo>[#<commit\-ish>]\fR: - Install the package at \fBhttps://gitlab\.com/gitlabname/gitlabrepo\fR - by attempting to clone it using \fBgit\fR\|\. - If you don't specify a \fIcommit\-ish\fR then \fBmaster\fR will be used\. +\fBnpm install gitlab:<gitlabname>/<gitlabrepo>[#<commit\-ish>]\fP: + Install the package at \fBhttps://gitlab\.com/gitlabname/gitlabrepo\fP + by attempting to clone it using \fBgit\fP\|\. + If you don't specify a \fIcommit\-ish\fR then \fBmaster\fP will be used\. Example: .P .RS 2 @@ -285,11 +285,11 @@ npm install sax@">=0\.1\.0 <0\.2\.0" bench supervisor .fi .RE .P -The \fB\-\-tag\fR argument will apply to all of the specified install targets\. If a +The \fB\-\-tag\fP argument will apply to all of the specified install targets\. If a tag with the given name exists, the tagged version is preferred over newer versions\. .P -The \fB\-\-force\fR argument will force npm to fetch remote resources even if a +The \fB\-\-force\fP argument will force npm to fetch remote resources even if a local copy exists on disk\. .P .RS 2 @@ -298,25 +298,25 @@ npm install sax \-\-force .fi .RE .P -The \fB\-\-global\fR argument will cause npm to install the package globally -rather than locally\. See npm help 5 \fBnpm\-folders\fR\|\. +The \fB\-\-global\fP argument will cause npm to install the package globally +rather than locally\. See npm help 5 \fBnpm\-folders\fP\|\. .P -The \fB\-\-link\fR argument will cause npm to link global installs into the +The \fB\-\-link\fP argument will cause npm to link global installs into the local space in some cases\. .P -The \fB\-\-no\-bin\-links\fR argument will prevent npm from creating symlinks for +The \fB\-\-no\-bin\-links\fP argument will prevent npm from creating symlinks for any binaries the package might contain\. .P -The \fB\-\-no\-optional\fR argument will prevent optional dependencies from +The \fB\-\-no\-optional\fP argument will prevent optional dependencies from being installed\. .P -The \fB\-\-no\-shrinkwrap\fR argument, which will ignore an available +The \fB\-\-no\-shrinkwrap\fP argument, which will ignore an available shrinkwrap file and use the package\.json instead\. .P -The \fB\-\-nodedir=/path/to/node/source\fR argument will allow npm to find the +The \fB\-\-nodedir=/path/to/node/source\fP argument will allow npm to find the node source code so that npm can compile native modules\. .P -See npm help 7 \fBnpm\-config\fR\|\. Many of the configuration params have some +See npm help 7 \fBnpm\-config\fP\|\. Many of the configuration params have some effect on installation, since that's most of what npm does\. .SH ALGORITHM .P @@ -336,7 +336,7 @@ for each dep@version in what\.dependencies .fi .RE .P -For this \fBpackage{dep}\fR structure: \fBA{B,C}, B{C}, C{D}\fR, +For this \fBpackage{dep}\fP structure: \fBA{B,C}, B{C}, C{D}\fP, this algorithm produces: .P .RS 2 @@ -365,15 +365,15 @@ A \-> B \-> A' \-> B' \-> A \-> B \-> A' \-> B' \-> A \-> \.\.\. .fi .RE .P -where \fBA\fR is some version of a package, and \fBA'\fR is a different version -of the same package\. Because \fBB\fR depends on a different version of \fBA\fR +where \fBA\fP is some version of a package, and \fBA'\fP is a different version +of the same package\. Because \fBB\fP depends on a different version of \fBA\fP than the one that is already in the tree, it must install a separate -copy\. The same is true of \fBA'\fR, which must install \fBB'\fR\|\. Because \fBB'\fR -depends on the original version of \fBA\fR, which has been overridden, the +copy\. The same is true of \fBA'\fP, which must install \fBB'\fP\|\. Because \fBB'\fP +depends on the original version of \fBA\fP, which has been overridden, the cycle falls into infinite regress\. .P To avoid this situation, npm flat\-out refuses to install any -\fBname@version\fR that is already present anywhere in the tree of package +\fBname@version\fP that is already present anywhere in the tree of package folder ancestors\. A more correct, but more complex, solution would be to symlink the existing version into the new location\. If this ever affects a real use\-case, it will be investigated\. diff --git a/deps/npm/man/man1/npm-link.1 b/deps/npm/man/man1/npm-link.1 index e063986b17..8a0c843fa2 100644 --- a/deps/npm/man/man1/npm-link.1 +++ b/deps/npm/man/man1/npm-link.1 @@ -14,20 +14,20 @@ npm ln (with any of the previous argument usage) .P 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 (see -npm help 7 \fBnpm\-config\fR for the value of \fBprefix\fR)\. +First, \fBnpm link\fP in a package folder will create a globally\-installed +symbolic link from \fBprefix/package\-name\fP to the current folder (see +npm help 7 \fBnpm\-config\fP for the value of \fBprefix\fP)\. .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\. +Next, in some other location, \fBnpm link package\-name\fP will create a +symlink from the local \fBnode_modules\fP folder to the global symlink\. .P -Note that \fBpackage\-name\fR is taken from \fBpackage\.json\fR, +Note that \fBpackage\-name\fP is taken from \fBpackage\.json\fP, not from directory name\. .P -The package name can be optionally prefixed with a scope\. See npm help 7 \fBnpm\-scope\fR\|\. +The package name can be optionally prefixed with a scope\. See npm help 7 \fBnpm\-scope\fP\|\. The scope must be preceded by an @\-symbol and followed by a slash\. .P -When creating tarballs for \fBnpm publish\fR, the linked packages are +When creating tarballs for \fBnpm publish\fP, 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 @@ -68,9 +68,9 @@ npm link node\-redis .RE .P That is, it first creates a global link, and then links the global -installation target into your project's \fBnode_modules\fR folder\. +installation target into your project's \fBnode_modules\fP folder\. .P -If your linked package is scoped (see npm help 7 \fBnpm\-scope\fR) your link command must +If your linked package is scoped (see npm help 7 \fBnpm\-scope\fP) your link command must include that scope, e\.g\. .P .RS 2 diff --git a/deps/npm/man/man1/npm-logout.1 b/deps/npm/man/man1/npm-logout.1 index e5e0b99690..379b9b0306 100644 --- a/deps/npm/man/man1/npm-logout.1 +++ b/deps/npm/man/man1/npm-logout.1 @@ -18,21 +18,21 @@ When logged into a legacy registry that uses username and password authenticatio clear the credentials in your user configuration\. In this case, it will \fIonly\fR affect the current environment\. .P -If \fB\-\-scope\fR is provided, this will find the credentials for the registry +If \fB\-\-scope\fP is provided, this will find the credentials for the registry connected to that scope, if set\. .SH CONFIGURATION .SS registry .P Default: http://registry\.npmjs\.org/ .P -The base URL of the npm package registry\. If \fBscope\fR is also specified, +The base URL of the npm package registry\. If \fBscope\fP is also specified, it takes precedence\. .SS scope .P Default: none .P If specified, the user and login credentials given will be associated -with the specified scope\. See npm help 7 \fBnpm\-scope\fR\|\. You can use both at the same time, +with the specified scope\. See npm help 7 \fBnpm\-scope\fP\|\. You can use both at the same time, e\.g\. .P .RS 2 diff --git a/deps/npm/man/man1/npm-ls.1 b/deps/npm/man/man1/npm-ls.1 index 9220bef024..a052542697 100644 --- a/deps/npm/man/man1/npm-ls.1 +++ b/deps/npm/man/man1/npm-ls.1 @@ -16,14 +16,14 @@ npm ll [[@<scope>/]<pkg> \.\.\.] 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 +Positional arguments are \fBname@version\-range\fP 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: +For example, running \fBnpm ls promzard\fP in npm's source tree will show: .P .RS 2 .nf -npm@2.13.1 /path/to/npm +npm@2.13.2 /path/to/npm └─┬ init\-package\-json@0\.0\.4 └── promzard@0\.1\.5 .fi @@ -35,7 +35,7 @@ If a project specifies git urls for dependencies these are shown in parentheses after the name@version to make it easier for users to recognize potential forks of a project\. .P -When run as \fBll\fR or \fBla\fR, it shows extended information by default\. +When run as \fBll\fP or \fBla\fP, it shows extended information by default\. .SH CONFIGURATION .SS json .RS 0 @@ -95,7 +95,7 @@ Default: false .RE .P -Display only the dependency tree for packages in \fBdependencies\fR\|\. +Display only the dependency tree for packages in \fBdependencies\fP\|\. .SS dev .RS 0 .IP \(bu 2 @@ -105,7 +105,7 @@ Default: false .RE .P -Display only the dependency tree for packages in \fBdevDependencies\fR\|\. +Display only the dependency tree for packages in \fBdevDependencies\fP\|\. .SH SEE ALSO .RS 0 .IP \(bu 2 diff --git a/deps/npm/man/man1/npm-pack.1 b/deps/npm/man/man1/npm-pack.1 index 7781bbdbd1..a630def97a 100644 --- a/deps/npm/man/man1/npm-pack.1 +++ b/deps/npm/man/man1/npm-pack.1 @@ -13,7 +13,7 @@ npm pack [<pkg> [<pkg> \.\.\.]] For anything that's installable (that is, a package folder, tarball, tarball url, name@tag, name@version, or name), this command will fetch it to the cache, and then copy the tarball to the current working -directory as \fB<name>\-<version>\.tgz\fR, and then write the filenames out to +directory as \fB<name>\-<version>\.tgz\fP, and then write the filenames out to stdout\. .P If the same package is specified multiple times, then the file will be diff --git a/deps/npm/man/man1/npm-prefix.1 b/deps/npm/man/man1/npm-prefix.1 index 1f42ea7a75..1bc68d0c0d 100644 --- a/deps/npm/man/man1/npm-prefix.1 +++ b/deps/npm/man/man1/npm-prefix.1 @@ -11,10 +11,10 @@ npm prefix [\-g] .SH DESCRIPTION .P Print the local prefix to standard out\. This is the closest parent directory -to contain a package\.json file unless \fB\-g\fR is also specified\. +to contain a package\.json file unless \fB\-g\fP is also specified\. .P -If \fB\-g\fR is specified, this will be the value of the global prefix\. See -npm help 7 \fBnpm\-config\fR for more detail\. +If \fB\-g\fP is specified, this will be the value of the global prefix\. See +npm help 7 \fBnpm\-config\fP for more detail\. .SH SEE ALSO .RS 0 .IP \(bu 2 diff --git a/deps/npm/man/man1/npm-prune.1 b/deps/npm/man/man1/npm-prune.1 index 304dcece16..937fbb34f1 100644 --- a/deps/npm/man/man1/npm-prune.1 +++ b/deps/npm/man/man1/npm-prune.1 @@ -18,10 +18,10 @@ removed\. Extraneous packages are packages that are not listed on the parent package's dependencies list\. .P -If the \fB\-\-production\fR flag is specified or the \fBNODE_ENV\fR environment -variable is set to \fBproduction\fR, this command will remove the packages -specified in your \fBdevDependencies\fR\|\. Setting \fB\-\-production=false\fR will -negate \fBNODE_ENV\fR being set to \fBproduction\fR\|\. +If the \fB\-\-production\fP flag is specified or the \fBNODE_ENV\fP environment +variable is set to \fBproduction\fP, this command will remove the packages +specified in your \fBdevDependencies\fP\|\. Setting \fB\-\-production=false\fP will +negate \fBNODE_ENV\fP being set to \fBproduction\fP\|\. .SH SEE ALSO .RS 0 .IP \(bu 2 diff --git a/deps/npm/man/man1/npm-publish.1 b/deps/npm/man/man1/npm-publish.1 index 0daaae7d56..a6cab55193 100644 --- a/deps/npm/man/man1/npm-publish.1 +++ b/deps/npm/man/man1/npm-publish.1 @@ -12,30 +12,30 @@ npm publish <folder> [\-\-tag <tag>] [\-\-access <public|restricted>] .SH DESCRIPTION .P Publishes a package to the registry so that it can be installed by name\. See -npm help 7 \fBnpm\-developers\fR for details on what's included in the published package, as +npm help 7 \fBnpm\-developers\fP for details on what's included in the published package, as well as details on how the package is built\. .P By default npm will publish to the public registry\. This can be overridden by -specifying a different default registry or using a npm help 7 \fBnpm\-scope\fR in the name -(see npm help 5 \fBpackage\.json\fR)\. +specifying a different default registry or using a npm help 7 \fBnpm\-scope\fP in the name +(see npm help 5 \fBpackage\.json\fP)\. .RS 0 .IP \(bu 2 -\fB<folder>\fR: +\fB<folder>\fP: A folder containing a package\.json file .IP \(bu 2 -\fB<tarball>\fR: +\fB<tarball>\fP: A url or file path to a gzipped tar archive containing a single folder with a package\.json file inside\. .IP \(bu 2 -\fB[\-\-tag <tag>]\fR +\fB[\-\-tag <tag>]\fP Registers the published package with the given tag, such that \fBnpm install -<name>@<tag>\fR will install this version\. By default, \fBnpm publish\fR updates -and \fBnpm install\fR installs the \fBlatest\fR tag\. +<name>@<tag>\fP will install this version\. By default, \fBnpm publish\fP updates +and \fBnpm install\fP installs the \fBlatest\fP tag\. .IP \(bu 2 -\fB[\-\-access <public|restricted>]\fR +\fB[\-\-access <public|restricted>]\fP Tells the registry whether this package should be published as public or -restricted\. Only applies to scoped packages, which default to \fBrestricted\fR\|\. -If you don't have a paid account, you must publish with \fB\-\-access public\fR +restricted\. Only applies to scoped packages, which default to \fBrestricted\fP\|\. +If you don't have a paid account, you must publish with \fB\-\-access public\fP to publish scoped packages\. .RE diff --git a/deps/npm/man/man1/npm-rebuild.1 b/deps/npm/man/man1/npm-rebuild.1 index d3c1c615bb..7e890d50b5 100644 --- a/deps/npm/man/man1/npm-rebuild.1 +++ b/deps/npm/man/man1/npm-rebuild.1 @@ -11,13 +11,13 @@ npm rb [<name> [<name> \.\.\.]] .RE .RS 0 .IP \(bu 2 -\fB<name>\fR: +\fB<name>\fP: The package to rebuild .RE .SH DESCRIPTION .P -This command runs the \fBnpm build\fR command on the matched folders\. This is useful +This command runs the \fBnpm build\fP command on the matched folders\. This is useful when you install a new version of node, and must recompile all your C++ addons with the new binary\. .SH SEE ALSO diff --git a/deps/npm/man/man1/npm-repo.1 b/deps/npm/man/man1/npm-repo.1 index a6638b0078..477f87a3c5 100644 --- a/deps/npm/man/man1/npm-repo.1 +++ b/deps/npm/man/man1/npm-repo.1 @@ -12,20 +12,20 @@ npm repo (with no args in a package dir) .SH DESCRIPTION .P This command tries to guess at the likely location of a package's -repository URL, and then tries to open it using the \fB\-\-browser\fR +repository URL, and then tries to open it using the \fB\-\-browser\fP config param\. If no package name is provided, it will search for -a \fBpackage\.json\fR in the current folder and use the \fBname\fR property\. +a \fBpackage\.json\fP in the current folder and use the \fBname\fP property\. .SH CONFIGURATION .SS browser .RS 0 .IP \(bu 2 -Default: OS X: \fB"open"\fR, Windows: \fB"start"\fR, Others: \fB"xdg\-open"\fR +Default: OS X: \fB"open"\fP, Windows: \fB"start"\fP, Others: \fB"xdg\-open"\fP .IP \(bu 2 Type: String .RE .P -The browser that is called by the \fBnpm repo\fR command to open websites\. +The browser that is called by the \fBnpm repo\fP command to open websites\. .SH SEE ALSO .RS 0 .IP \(bu 2 diff --git a/deps/npm/man/man1/npm-restart.1 b/deps/npm/man/man1/npm-restart.1 index ec21ac709c..bbfd94f741 100644 --- a/deps/npm/man/man1/npm-restart.1 +++ b/deps/npm/man/man1/npm-restart.1 @@ -40,7 +40,7 @@ postrestart Note that the "restart" script is run \fBin addition to\fR the "stop" and "start" scripts, not instead of them\. .P -This is the behavior as of \fBnpm\fR major version 2\. A change in this +This is the behavior as of \fBnpm\fP major version 2\. A change in this behavior will be accompanied by an increase in major version number .SH SEE ALSO .RS 0 diff --git a/deps/npm/man/man1/npm-root.1 b/deps/npm/man/man1/npm-root.1 index 8c80364536..7f3c87b76e 100644 --- a/deps/npm/man/man1/npm-root.1 +++ b/deps/npm/man/man1/npm-root.1 @@ -10,7 +10,7 @@ npm root .RE .SH DESCRIPTION .P -Print the effective \fBnode_modules\fR folder to standard out\. +Print the effective \fBnode_modules\fP folder to standard out\. .SH SEE ALSO .RS 0 .IP \(bu 2 diff --git a/deps/npm/man/man1/npm-run-script.1 b/deps/npm/man/man1/npm-run-script.1 index c1d893beb5..51c94d9d41 100644 --- a/deps/npm/man/man1/npm-run-script.1 +++ b/deps/npm/man/man1/npm-run-script.1 @@ -11,16 +11,16 @@ npm run [command] [\-\- <args>] .RE .SH DESCRIPTION .P -This runs an arbitrary command from a package's \fB"scripts"\fR object\. If no -\fB"command"\fR is provided, it will list the available scripts\. \fBrun[\-script]\fR is +This runs an arbitrary command from a package's \fB"scripts"\fP object\. If no +\fB"command"\fP is provided, it will list the available scripts\. \fBrun[\-script]\fP is used by the test, start, restart, and stop commands, but can be called directly, as well\. When the scripts in the package are printed out, they're separated into lifecycle (test, start, restart) and directly\-run scripts\. .P -As of \fBnpm@2\.0\.0\fR \fIhttp://blog\.npmjs\.org/post/98131109725/npm\-2\-0\-0\fR, you can -use custom arguments when executing scripts\. The special option \fB\-\-\fR is used by +As of \fBnpm@2\.0\.0\fP \fIhttp://blog\.npmjs\.org/post/98131109725/npm\-2\-0\-0\fR, you can +use custom arguments when executing scripts\. The special option \fB\-\-\fP is used by getopt \fIhttp://goo\.gl/KxMmtG\fR to delimit the end of the options\. npm will pass -all the arguments after the \fB\-\-\fR directly to your script: +all the arguments after the \fB\-\-\fP directly to your script: .P .RS 2 .nf @@ -28,18 +28,18 @@ npm run test \-\- \-\-grep="pattern" .fi .RE .P -The arguments will only be passed to the script specified after \fBnpm run\fR +The arguments will only be passed to the script specified after \fBnpm run\fP and not to any pre or post script\. .P -The \fBenv\fR script is a special built\-in command that can be used to list +The \fBenv\fP script is a special built\-in command that can be used to list environment variables that will be available to the script at runtime\. If an "env" command is defined in your package it will take precedence over the built\-in\. .P -In addition to the shell's pre\-existing \fBPATH\fR, \fBnpm run\fR adds -\fBnode_modules/\.bin\fR to the \fBPATH\fR provided to scripts\. Any binaries provided by -locally\-installed dependencies can be used without the \fBnode_modules/\.bin\fR -prefix\. For example, if there is a \fBdevDependency\fR on \fBtap\fR in your package, +In addition to the shell's pre\-existing \fBPATH\fP, \fBnpm run\fP adds +\fBnode_modules/\.bin\fP to the \fBPATH\fP provided to scripts\. Any binaries provided by +locally\-installed dependencies can be used without the \fBnode_modules/\.bin\fP +prefix\. For example, if there is a \fBdevDependency\fP on \fBtap\fP in your package, you should write: .P .RS 2 @@ -48,7 +48,7 @@ you should write: .fi .RE .P -instead of \fB"scripts": {"test": "node_modules/\.bin/tap test/\\*\.js"}\fR to run your tests\. +instead of \fB"scripts": {"test": "node_modules/\.bin/tap test/\\*\.js"}\fP to run your tests\. .SH SEE ALSO .RS 0 .IP \(bu 2 diff --git a/deps/npm/man/man1/npm-search.1 b/deps/npm/man/man1/npm-search.1 index 5081cf32eb..d911055094 100644 --- a/deps/npm/man/man1/npm-search.1 +++ b/deps/npm/man/man1/npm-search.1 @@ -14,8 +14,8 @@ npm se [search terms \.\.\.] .P Search the registry for packages matching the search terms\. .P -If a term starts with \fB/\fR, then it's interpreted as a regular expression\. -A trailing \fB/\fR will be ignored in this case\. (Note that many regular +If a term starts with \fB/\fP, then it's interpreted as a regular expression\. +A trailing \fB/\fP will be ignored in this case\. (Note that many regular expression characters must be escaped or quoted in most shells\.) .SH CONFIGURATION .SS long diff --git a/deps/npm/man/man1/npm-shrinkwrap.1 b/deps/npm/man/man1/npm-shrinkwrap.1 index e0eb3ce1b4..7b3569a172 100644 --- a/deps/npm/man/man1/npm-shrinkwrap.1 +++ b/deps/npm/man/man1/npm-shrinkwrap.1 @@ -12,18 +12,18 @@ npm shrinkwrap .P This command locks down the versions of a package's dependencies so that you can control exactly which versions of each dependency will be -used when your package is installed\. The \fBpackage\.json\fR file is still -required if you want to use \fBnpm install\fR\|\. +used when your package is installed\. The \fBpackage\.json\fP file is still +required if you want to use \fBnpm install\fP\|\. .P -By default, \fBnpm install\fR recursively installs the target's -dependencies (as specified in \fBpackage\.json\fR), choosing the latest +By default, \fBnpm install\fP recursively installs the target's +dependencies (as specified in \fBpackage\.json\fP), choosing the latest available version that satisfies the dependency's semver pattern\. In some situations, particularly when shipping software where each change is tightly managed, it's desirable to fully specify each version of each dependency recursively so that subsequent builds and deploys do not inadvertently pick up newer versions of a dependency that satisfy the semver pattern\. Specifying specific semver patterns in each -dependency's \fBpackage\.json\fR would facilitate this, but that's not always +dependency's \fBpackage\.json\fP would facilitate this, but that's not always possible or desirable, as when another author owns the npm package\. It's also possible to check dependencies directly into source control, but that may be undesirable for other reasons\. @@ -68,7 +68,7 @@ and package C: .RE .P If these are the only versions of A, B, and C available in the -registry, then a normal \fBnpm install A\fR will install: +registry, then a normal \fBnpm install A\fP will install: .P .RS 2 .nf @@ -78,7 +78,7 @@ A@0\.1\.0 .fi .RE .P -However, if B@0\.0\.2 is published, then a fresh \fBnpm install A\fR will +However, if B@0\.0\.2 is published, then a fresh \fBnpm install A\fP will install: .P .RS 2 @@ -105,7 +105,7 @@ npm shrinkwrap .fi .RE .P -This generates \fBnpm\-shrinkwrap\.json\fR, which will look something like this: +This generates \fBnpm\-shrinkwrap\.json\fP, which will look something like this: .P .RS 2 .nf @@ -127,30 +127,30 @@ This generates \fBnpm\-shrinkwrap\.json\fR, which will look something like this: .RE .P The shrinkwrap command has locked down the dependencies based on -what's currently installed in node_modules\. When \fBnpm install\fR -installs a package with an \fBnpm\-shrinkwrap\.json\fR in the package -root, the shrinkwrap file (rather than \fBpackage\.json\fR files) completely +what's currently installed in node_modules\. When \fBnpm install\fP +installs a package with an \fBnpm\-shrinkwrap\.json\fP in the package +root, the shrinkwrap file (rather than \fBpackage\.json\fP files) completely drives the installation of that package and all of its dependencies (recursively)\. So now the author publishes A@0\.1\.0, and subsequent installs of this package will use B@0\.0\.1 and C@0\.0\.1, regardless the -dependencies and versions listed in A's, B's, and C's \fBpackage\.json\fR +dependencies and versions listed in A's, B's, and C's \fBpackage\.json\fP files\. .SS Using shrinkwrapped packages .P Using a shrinkwrapped package is no different than using any other -package: you can \fBnpm install\fR it by hand, or add a dependency to your -\fBpackage\.json\fR file and \fBnpm install\fR it\. +package: you can \fBnpm install\fP it by hand, or add a dependency to your +\fBpackage\.json\fP file and \fBnpm install\fP it\. .SS Building shrinkwrapped packages .P To shrinkwrap an existing package: .RS 0 .IP 1. 3 -Run \fBnpm install\fR in the package root to install the current +Run \fBnpm install\fP in the package root to install the current versions of all dependencies\. .IP 2. 3 Validate that the package works as expected with these versions\. .IP 3. 3 -Run \fBnpm shrinkwrap\fR, add \fBnpm\-shrinkwrap\.json\fR to git, and publish +Run \fBnpm shrinkwrap\fP, add \fBnpm\-shrinkwrap\.json\fP to git, and publish your package\. .RE @@ -158,19 +158,19 @@ your package\. To add or update a dependency in a shrinkwrapped package: .RS 0 .IP 1. 3 -Run \fBnpm install\fR in the package root to install the current +Run \fBnpm install\fP in the package root to install the current versions of all dependencies\. .IP 2. 3 -Add or update dependencies\. \fBnpm install\fR each new or updated -package individually and then update \fBpackage\.json\fR\|\. Note that they +Add or update dependencies\. \fBnpm install\fP each new or updated +package individually and then update \fBpackage\.json\fP\|\. Note that they must be explicitly named in order to be installed: running \fBnpm -install\fR with no arguments will merely reproduce the existing +install\fP with no arguments will merely reproduce the existing shrinkwrap\. .IP 3. 3 Validate that the package works as expected with the new dependencies\. .IP 4. 3 -Run \fBnpm shrinkwrap\fR, commit the new \fBnpm\-shrinkwrap\.json\fR, and +Run \fBnpm shrinkwrap\fP, commit the new \fBnpm\-shrinkwrap\.json\fP, and publish your package\. .RE @@ -179,19 +179,19 @@ You can use npm help outdated to view dependencies with newer versions available\. .SS Other Notes .P -A shrinkwrap file must be consistent with the package's \fBpackage\.json\fR -file\. \fBnpm shrinkwrap\fR will fail if required dependencies are not +A shrinkwrap file must be consistent with the package's \fBpackage\.json\fP +file\. \fBnpm shrinkwrap\fP will fail if required dependencies are not already installed, since that would result in a shrinkwrap that wouldn't actually work\. Similarly, the command will fail if there are -extraneous packages (not referenced by \fBpackage\.json\fR), since that would -indicate that \fBpackage\.json\fR is not correct\. +extraneous packages (not referenced by \fBpackage\.json\fP), since that would +indicate that \fBpackage\.json\fP is not correct\. .P -Since \fBnpm shrinkwrap\fR is intended to lock down your dependencies for -production use, \fBdevDependencies\fR will not be included unless you -explicitly set the \fB\-\-dev\fR flag when you run \fBnpm shrinkwrap\fR\|\. If -installed \fBdevDependencies\fR are excluded, then npm will print a +Since \fBnpm shrinkwrap\fP is intended to lock down your dependencies for +production use, \fBdevDependencies\fP will not be included unless you +explicitly set the \fB\-\-dev\fP flag when you run \fBnpm shrinkwrap\fP\|\. If +installed \fBdevDependencies\fP are excluded, then npm will print a warning\. If you want them to be installed with your module by -default, please consider adding them to \fBdependencies\fR instead\. +default, please consider adding them to \fBdependencies\fP instead\. .P If shrinkwrapped package A depends on shrinkwrapped package B, B's shrinkwrap will not be used as part of the installation of A\. However, diff --git a/deps/npm/man/man1/npm-tag.1 b/deps/npm/man/man1/npm-tag.1 index 6fb58d1d37..606270e9b4 100644 --- a/deps/npm/man/man1/npm-tag.1 +++ b/deps/npm/man/man1/npm-tag.1 @@ -13,7 +13,7 @@ npm tag <name>@<version> [<tag>] THIS COMMAND IS DEPRECATED\. See npm help dist\-tag for details\. .P Tags the specified version of the package with the specified tag, or the -\fB\-\-tag\fR config if not specified\. +\fB\-\-tag\fP config if not specified\. .P A tag can be used when installing packages as a reference to a version instead of using a specific version number: @@ -32,13 +32,13 @@ npm install \-\-tag <tag> .fi .RE .P -This also applies to \fBnpm dedupe\fR\|\. +This also applies to \fBnpm dedupe\fP\|\. .P Publishing a package always sets the "latest" tag to the published version\. .SH PURPOSE .P Tags can be used to provide an alias instead of version numbers\. For -example, \fBnpm\fR currently uses the tag "next" to identify the upcoming +example, \fBnpm\fP currently uses the tag "next" to identify the upcoming version, and the tag "latest" to identify the current version\. .P A project might choose to have multiple streams of development, e\.g\., @@ -46,16 +46,16 @@ A project might choose to have multiple streams of development, e\.g\., .SH CAVEATS .P Tags must share a namespace with version numbers, because they are -specified in the same slot: \fBnpm install <pkg>@<version>\fR vs \fBnpm -install <pkg>@<tag>\fR\|\. +specified in the same slot: \fBnpm install <pkg>@<version>\fP vs \fBnpm +install <pkg>@<tag>\fP\|\. .P Tags that can be interpreted as valid semver ranges will be -rejected\. For example, \fBv1\.4\fR cannot be used as a tag, because it is -interpreted by semver as \fB>=1\.4\.0 <1\.5\.0\fR\|\. See +rejected\. For example, \fBv1\.4\fP cannot be used as a tag, because it is +interpreted by semver as \fB>=1\.4\.0 <1\.5\.0\fP\|\. See https://github\.com/npm/npm/issues/6082\|\. .P The simplest way to avoid semver problems with tags is to use tags -that do not begin with a number or the letter \fBv\fR\|\. +that do not begin with a number or the letter \fBv\fP\|\. .SH SEE ALSO .RS 0 .IP \(bu 2 diff --git a/deps/npm/man/man1/npm-test.1 b/deps/npm/man/man1/npm-test.1 index 5a07a46553..658b8e9cce 100644 --- a/deps/npm/man/man1/npm-test.1 +++ b/deps/npm/man/man1/npm-test.1 @@ -13,7 +13,7 @@ .P This runs a package's "test" script, if one was provided\. .P -To run tests as a condition of installation, set the \fBnpat\fR config to +To run tests as a condition of installation, set the \fBnpat\fP config to true\. .SH SEE ALSO .RS 0 diff --git a/deps/npm/man/man1/npm-uninstall.1 b/deps/npm/man/man1/npm-uninstall.1 index aef162fab2..11bb0c235f 100644 --- a/deps/npm/man/man1/npm-uninstall.1 +++ b/deps/npm/man/man1/npm-uninstall.1 @@ -22,22 +22,22 @@ npm uninstall sax .fi .RE .P -In global mode (ie, with \fB\-g\fR or \fB\-\-global\fR appended to the command), +In global mode (ie, with \fB\-g\fP or \fB\-\-global\fP appended to the command), it uninstalls the current package context as a global package\. .P -\fBnpm uninstall\fR takes 3 exclusive, optional flags which save or update +\fBnpm uninstall\fP takes 3 exclusive, optional flags which save or update the package version in your main package\.json: .RS 0 .IP \(bu 2 -\fB\-\-save\fR: Package will be removed from your \fBdependencies\fR\|\. +\fB\-\-save\fP: Package will be removed from your \fBdependencies\fP\|\. .IP \(bu 2 -\fB\-\-save\-dev\fR: Package will be removed from your \fBdevDependencies\fR\|\. +\fB\-\-save\-dev\fP: Package will be removed from your \fBdevDependencies\fP\|\. .IP \(bu 2 -\fB\-\-save\-optional\fR: Package will be removed from your \fBoptionalDependencies\fR\|\. +\fB\-\-save\-optional\fP: Package will be removed from your \fBoptionalDependencies\fP\|\. .RE .P -Scope is optional and follows the usual rules for npm help 7 \fBnpm\-scope\fR\|\. +Scope is optional and follows the usual rules for npm help 7 \fBnpm\-scope\fP\|\. .P Examples: .P diff --git a/deps/npm/man/man1/npm-unpublish.1 b/deps/npm/man/man1/npm-unpublish.1 index c6be18c787..dbb4bf91e4 100644 --- a/deps/npm/man/man1/npm-unpublish.1 +++ b/deps/npm/man/man1/npm-unpublish.1 @@ -13,7 +13,7 @@ npm unpublish [@<scope>/]<name>[@<version>] \fBIt is generally considered bad behavior to remove versions of a library that others are depending on!\fR .P -Consider using the \fBdeprecate\fR command +Consider using the \fBdeprecate\fP command instead, if your intent is to encourage users to upgrade\. .P There is plenty of room on the registry\. @@ -29,7 +29,7 @@ Even if a package version is unpublished, that specific name and version combination can never be reused\. In order to publish the package again, a new version number must be used\. .P -The scope is optional and follows the usual rules for npm help 7 \fBnpm\-scope\fR\|\. +The scope is optional and follows the usual rules for npm help 7 \fBnpm\-scope\fP\|\. .SH SEE ALSO .RS 0 .IP \(bu 2 diff --git a/deps/npm/man/man1/npm-update.1 b/deps/npm/man/man1/npm-update.1 index 9945f4704a..d9afff56cd 100644 --- a/deps/npm/man/man1/npm-update.1 +++ b/deps/npm/man/man1/npm-update.1 @@ -11,26 +11,26 @@ npm update [\-g] [<name> [<name> \.\.\.]] .SH DESCRIPTION .P This command will update all the packages listed to the latest version -(specified by the \fBtag\fR config), respecting semver\. +(specified by the \fBtag\fP config), respecting semver\. .P It will also install missing packages\. As with all commands that install -packages, the \fB\-\-dev\fR flag will cause \fBdevDependencies\fR to be processed +packages, the \fB\-\-dev\fP flag will cause \fBdevDependencies\fP to be processed as well\. .P -If the \fB\-g\fR flag is specified, this command will update globally installed +If the \fB\-g\fP flag is specified, this command will update globally installed packages\. .P If no package name is specified, all packages in the specified location (global or local) will be updated\. .P -As of \fBnpm@2\.6\.1\fR, the \fBnpm update\fR will only inspect top\-level packages\. -Prior versions of \fBnpm\fR would also recursively inspect all dependencies\. -To get the old behavior, use \fBnpm \-\-depth 9999 update\fR, but be warned that -simultaneous asynchronous update of all packages, including \fBnpm\fR itself -and packages that \fBnpm\fR depends on, often causes problems up to and including -the uninstallation of \fBnpm\fR itself\. +As of \fBnpm@2\.6\.1\fP, the \fBnpm update\fP will only inspect top\-level packages\. +Prior versions of \fBnpm\fP would also recursively inspect all dependencies\. +To get the old behavior, use \fBnpm \-\-depth 9999 update\fP, but be warned that +simultaneous asynchronous update of all packages, including \fBnpm\fP itself +and packages that \fBnpm\fP depends on, often causes problems up to and including +the uninstallation of \fBnpm\fP itself\. .P -To restore a missing \fBnpm\fR, use the command: +To restore a missing \fBnpm\fP, use the command: .P .RS 2 .nf @@ -39,12 +39,12 @@ curl \-L https://npmjs\.com/install\.sh | sh .RE .SH EXAMPLES .P -IMPORTANT VERSION NOTE: these examples assume \fBnpm@2\.6\.1\fR or later\. For -older versions of \fBnpm\fR, you must specify \fB\-\-depth 0\fR to get the behavior +IMPORTANT VERSION NOTE: these examples assume \fBnpm@2\.6\.1\fP or later\. For +older versions of \fBnpm\fP, you must specify \fB\-\-depth 0\fP to get the behavior described below\. .P -For the examples below, assume that the current package is \fBapp\fR and it depends -on dependencies, \fBdep1\fR (\fBdep2\fR, \.\. etc\.)\. The published versions of \fBdep1\fR are: +For the examples below, assume that the current package is \fBapp\fP and it depends +on dependencies, \fBdep1\fP (\fBdep2\fP, \.\. etc\.)\. The published versions of \fBdep1\fP are: .P .RS 2 .nf @@ -65,7 +65,7 @@ on dependencies, \fBdep1\fR (\fBdep2\fR, \.\. etc\.)\. The published versions o .RE .SS Caret Dependencies .P -If \fBapp\fR\|'s \fBpackage\.json\fR contains: +If \fBapp\fP\|'s \fBpackage\.json\fP contains: .P .RS 2 .nf @@ -75,11 +75,11 @@ dependencies: { .fi .RE .P -Then \fBnpm update\fR will install \fBdep1@1\.2\.2\fR, because \fB1\.2\.2\fR is \fBlatest\fR and -\fB1\.2\.2\fR satisfies \fB^1\.1\.1\fR\|\. +Then \fBnpm update\fP will install \fBdep1@1\.2\.2\fP, because \fB1\.2\.2\fP is \fBlatest\fP and +\fB1\.2\.2\fP satisfies \fB^1\.1\.1\fP\|\. .SS Tilde Dependencies .P -However, if \fBapp\fR\|'s \fBpackage\.json\fR contains: +However, if \fBapp\fP\|'s \fBpackage\.json\fP contains: .P .RS 2 .nf @@ -89,13 +89,13 @@ dependencies: { .fi .RE .P -In this case, running \fBnpm update\fR will install \fBdep1@1\.1\.2\fR\|\. Even though the \fBlatest\fR -tag points to \fB1\.2\.2\fR, this version does not satisfy \fB~1\.1\.1\fR, which is equivalent -to \fB>=1\.1\.1 <1\.2\.0\fR\|\. So the highest\-sorting version that satisfies \fB~1\.1\.1\fR is used, -which is \fB1\.1\.2\fR\|\. +In this case, running \fBnpm update\fP will install \fBdep1@1\.1\.2\fP\|\. Even though the \fBlatest\fP +tag points to \fB1\.2\.2\fP, this version does not satisfy \fB~1\.1\.1\fP, which is equivalent +to \fB>=1\.1\.1 <1\.2\.0\fP\|\. So the highest\-sorting version that satisfies \fB~1\.1\.1\fP is used, +which is \fB1\.1\.2\fP\|\. .SS Caret Dependencies below 1\.0\.0 .P -Suppose \fBapp\fR has a caret dependency on a version below \fB1\.0\.0\fR, for example: +Suppose \fBapp\fP has a caret dependency on a version below \fB1\.0\.0\fP, for example: .P .RS 2 .nf @@ -105,10 +105,10 @@ dependencies: { .fi .RE .P -\fBnpm update\fR will install \fBdep1@0\.2\.0\fR, because there are no other -versions which satisfy \fB^0\.2\.0\fR\|\. +\fBnpm update\fP will install \fBdep1@0\.2\.0\fP, because there are no other +versions which satisfy \fB^0\.2\.0\fP\|\. .P -If the dependence were on \fB^0\.4\.0\fR: +If the dependence were on \fB^0\.4\.0\fP: .P .RS 2 .nf @@ -118,13 +118,13 @@ dependencies: { .fi .RE .P -Then \fBnpm update\fR will install \fBdep1@0\.4\.1\fR, because that is the highest\-sorting -version that satisfies \fB^0\.4\.0\fR (\fB>= 0\.4\.0 <0\.5\.0\fR) -.SS Recording Updates with \fB\-\-save\fR +Then \fBnpm update\fP will install \fBdep1@0\.4\.1\fP, because that is the highest\-sorting +version that satisfies \fB^0\.4\.0\fP (\fB>= 0\.4\.0 <0\.5\.0\fP) +.SS Recording Updates with \fB\-\-save\fP .P When you want to update a package and save the new version as -the minimum required dependency in \fBpackage\.json\fR, you can use -\fBnpm update \-\-save\fR\|\. For example if \fBpackage\.json\fR contains +the minimum required dependency in \fBpackage\.json\fP, you can use +\fBnpm update \-\-save\fP\|\. For example if \fBpackage\.json\fP contains .P .RS 2 .nf @@ -134,8 +134,8 @@ dependencies: { .fi .RE .P -Then \fBnpm update \-\-save\fR will install \fBdep1@1\.2\.2\fR (i\.e\., \fBlatest\fR), -and \fBpackage\.json\fR will be modified: +Then \fBnpm update \-\-save\fP will install \fBdep1@1\.2\.2\fP (i\.e\., \fBlatest\fP), +and \fBpackage\.json\fP will be modified: .P .RS 2 .nf @@ -145,15 +145,15 @@ dependencies: { .fi .RE .P -Note that \fBnpm\fR will only write an updated version to \fBpackage\.json\fR +Note that \fBnpm\fP will only write an updated version to \fBpackage\.json\fP if it installs a new package\. .SS Updating Globally\-Installed Packages .P -\fBnpm update \-g\fR will apply the \fBupdate\fR action to each globally\- installed -package that is \fBoutdated\fR \-\- that is, has a version that is different from -\fBlatest\fR\|\. +\fBnpm update \-g\fP will apply the \fBupdate\fP action to each globally\- installed +package that is \fBoutdated\fP \-\- that is, has a version that is different from +\fBlatest\fP\|\. .P -NOTE: If a package has been upgraded to a version newer than \fBlatest\fR, it will +NOTE: If a package has been upgraded to a version newer than \fBlatest\fP, it will be \fIdowngraded\fR\|\. .SH SEE ALSO .RS 0 diff --git a/deps/npm/man/man1/npm-version.1 b/deps/npm/man/man1/npm-version.1 index ee696570c8..1d72440fe1 100644 --- a/deps/npm/man/man1/npm-version.1 +++ b/deps/npm/man/man1/npm-version.1 @@ -11,22 +11,22 @@ npm version [<newversion> | major | minor | patch | premajor | preminor | prepat .SH DESCRIPTION .P Run this in a package directory to bump the version and write the new -data back to \fBpackage\.json\fR and, if present, \fBnpm\-shrinkwrap\.json\fR\|\. +data back to \fBpackage\.json\fP and, if present, \fBnpm\-shrinkwrap\.json\fP\|\. .P -The \fBnewversion\fR argument should be a valid semver string, \fIor\fR a -valid second argument to semver\.inc (one of \fBpatch\fR, \fBminor\fR, \fBmajor\fR, -\fBprepatch\fR, \fBpreminor\fR, \fBpremajor\fR, \fBprerelease\fR)\. In the second case, +The \fBnewversion\fP argument should be a valid semver string, \fIor\fR a +valid second argument to semver\.inc (one of \fBpatch\fP, \fBminor\fP, \fBmajor\fP, +\fBprepatch\fP, \fBpreminor\fP, \fBpremajor\fP, \fBprerelease\fP)\. In the second case, the existing version will be incremented by 1 in the specified field\. .P If run in a git repo, it will also create a version commit and tag\. -This behavior is controlled by \fBgit\-tag\-version\fR (see below), and can -be disabled on the command line by running \fBnpm \-\-no\-git\-tag\-version version\fR\|\. -It will fail if the working directory is not clean, unless the \fB\-\-force\fR +This behavior is controlled by \fBgit\-tag\-version\fP (see below), and can +be disabled on the command line by running \fBnpm \-\-no\-git\-tag\-version version\fP\|\. +It will fail if the working directory is not clean, unless the \fB\-\-force\fP flag is set\. .P -If supplied with \fB\-\-message\fR (shorthand: \fB\-m\fR) config option, npm will +If supplied with \fB\-\-message\fP (shorthand: \fB\-m\fP) config option, npm will use it as a commit message when creating a version commit\. If the -\fBmessage\fR config contains \fB%s\fR then that will be replaced with the +\fBmessage\fP config contains \fB%s\fP then that will be replaced with the resulting version number\. For example: .P .RS 2 @@ -35,8 +35,8 @@ npm version patch \-m "Upgrade to %s for reasons" .fi .RE .P -If the \fBsign\-git\-tag\fR config is set, then the tag will be signed using -the \fB\-s\fR flag to git\. Note that you must have a default GPG key set up +If the \fBsign\-git\-tag\fP config is set, then the tag will be signed using +the \fB\-s\fP flag to git\. Note that you must have a default GPG key set up in your git config for this to work properly\. For example: .P .RS 2 @@ -52,29 +52,29 @@ Enter passphrase: .fi .RE .P -If \fBpreversion\fR, \fBversion\fR, or \fBpostversion\fR are in the \fBscripts\fR property of -the package\.json, they will be executed as part of running \fBnpm version\fR\|\. +If \fBpreversion\fP, \fBversion\fP, or \fBpostversion\fP are in the \fBscripts\fP property of +the package\.json, they will be executed as part of running \fBnpm version\fP\|\. .P The exact order of execution is as follows: .RS 0 .IP 1. 3 Check to make sure the git working directory is clean before we get started\. Your scripts may add files to the commit in future steps\. -This step is skipped if the \fB\-\-force\fR flag is set\. +This step is skipped if the \fB\-\-force\fP flag is set\. .IP 2. 3 -Run the \fBpreversion\fR script\. These scripts have access to the old \fBversion\fR in package\.json\. +Run the \fBpreversion\fP script\. These scripts have access to the old \fBversion\fP in package\.json\. A typical use would be running your full test suite before deploying\. -Any files you want added to the commit should be explicitly added using \fBgit add\fR\|\. +Any files you want added to the commit should be explicitly added using \fBgit add\fP\|\. .IP 3. 3 -Bump \fBversion\fR in \fBpackage\.json\fR as requested (\fBpatch\fR, \fBminor\fR, \fBmajor\fR, etc)\. +Bump \fBversion\fP in \fBpackage\.json\fP as requested (\fBpatch\fP, \fBminor\fP, \fBmajor\fP, etc)\. .IP 4. 3 -Run the \fBversion\fR script\. These scripts have access to the new \fBversion\fR in package\.json +Run the \fBversion\fP script\. These scripts have access to the new \fBversion\fP in package\.json (so they can incorporate it into file headers in generated files for example)\. -Again, scripts should explicitly add generated files to the commit using \fBgit add\fR\|\. +Again, scripts should explicitly add generated files to the commit using \fBgit add\fP\|\. .IP 5. 3 Commit and tag\. .IP 6. 3 -Run the \fBpostversion\fR script\. Use it to clean up the file system or automatically push +Run the \fBpostversion\fP script\. Use it to clean up the file system or automatically push the commit and/or tag\. .RE @@ -91,9 +91,9 @@ Take the following example: .fi .RE .P -This runs all your tests, and proceeds only if they pass\. Then runs your \fBbuild\fR script, and -adds everything in the \fBdist\fR directory to the commit\. After the commit, it pushes the new commit -and tag up to the server, and deletes the \fBbuild/temp\fR directory\. +This runs all your tests, and proceeds only if they pass\. Then runs your \fBbuild\fP script, and +adds everything in the \fBdist\fP directory to the commit\. After the commit, it pushes the new commit +and tag up to the server, and deletes the \fBbuild/temp\fP directory\. .SH CONFIGURATION .SS git\-tag\-version .RS 0 diff --git a/deps/npm/man/man1/npm-view.1 b/deps/npm/man/man1/npm-view.1 index 9c2ca518ee..70f47dc979 100644 --- a/deps/npm/man/man1/npm-view.1 +++ b/deps/npm/man/man1/npm-view.1 @@ -12,9 +12,9 @@ npm v [@<scope>/]<name>[@<version>] [<field>[\.<subfield>]\.\.\.] .SH DESCRIPTION .P This command shows data about a package and prints it to the stream -referenced by the \fBoutfd\fR config, which defaults to stdout\. +referenced by the \fBoutfd\fP config, which defaults to stdout\. .P -To show the package registry entry for the \fBconnect\fR package, you can do +To show the package registry entry for the \fBconnect\fP package, you can do this: .P .RS 2 @@ -26,7 +26,7 @@ npm view connect The default version is "latest" if unspecified\. .P Field names can be specified after the package descriptor\. -For example, to show the dependencies of the \fBronn\fR package at version +For example, to show the dependencies of the \fBronn\fP package at version 0\.3\.5, you could do the following: .P .RS 2 @@ -87,7 +87,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 npm help 5 \fBpackage\.json\fR for more on this\.) +the shortened string format\. (See npm help 5 \fBpackage\.json\fP for more on this\.) .P .RS 2 .nf diff --git a/deps/npm/man/man1/npm-whoami.1 b/deps/npm/man/man1/npm-whoami.1 index 133290c726..d887b35dc0 100644 --- a/deps/npm/man/man1/npm-whoami.1 +++ b/deps/npm/man/man1/npm-whoami.1 @@ -10,7 +10,7 @@ npm whoami .RE .SH DESCRIPTION .P -Print the \fBusername\fR config to standard output\. +Print the \fBusername\fP config to standard output\. .SH SEE ALSO .RS 0 .IP \(bu 2 diff --git a/deps/npm/man/man1/npm.1 b/deps/npm/man/man1/npm.1 index d9ebab559c..5bf8c0954a 100644 --- a/deps/npm/man/man1/npm.1 +++ b/deps/npm/man/man1/npm.1 @@ -10,7 +10,7 @@ npm <command> [args] .RE .SH VERSION .P -2.13.1 +2.13.2 .SH DESCRIPTION .P npm is the package manager for the Node JavaScript platform\. It puts @@ -21,16 +21,16 @@ It is extremely configurable to support a wide variety of use cases\. Most commonly, it is used to publish, discover, install, and develop node programs\. .P -Run \fBnpm help\fR to get a list of available commands\. +Run \fBnpm help\fP to get a list of available commands\. .SH INTRODUCTION .P 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 -npm help \fBnpm\-install\fR for more info\. It can do a lot of stuff\. +Use \fBnpm install blerg\fP to install the latest version of "blerg"\. Check out +npm help \fBnpm\-install\fP 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\. +Use the \fBnpm search\fP command to show everything that's available\. +Use \fBnpm ls\fP to show everything you've installed\. .SH DEPENDENCIES .P If a package references to another package with a git URL, npm depends @@ -48,7 +48,7 @@ the node\-gyp repository \fIhttps://github\.com/TooTallNate/node\-gyp\fR and the node\-gyp Wiki \fIhttps://github\.com/TooTallNate/node\-gyp/wiki\fR\|\. .SH DIRECTORIES .P -See npm help 5 \fBnpm\-folders\fR to learn about where npm puts stuff\. +See npm help 5 \fBnpm\-folders\fP to learn about where npm puts stuff\. .P In particular, npm has two modes of operation: .RS 0 @@ -56,17 +56,17 @@ In particular, npm has two modes of operation: global mode: .br npm installs packages into the install prefix at -\fBprefix/lib/node_modules\fR and bins are installed in \fBprefix/bin\fR\|\. +\fBprefix/lib/node_modules\fP and bins are installed in \fBprefix/bin\fP\|\. .IP \(bu 2 local mode: .br npm installs packages into the current project directory, which defaults to the current working directory\. Packages are installed to -\fB\|\./node_modules\fR, and bins are installed to \fB\|\./node_modules/\.bin\fR\|\. +\fB\|\./node_modules\fP, and bins are installed to \fB\|\./node_modules/\.bin\fP\|\. .RE .P -Local mode is the default\. Use \fB\-\-global\fR or \fB\-g\fR on any command to +Local mode is the default\. Use \fB\-\-global\fP or \fB\-g\fP on any command to operate in global mode instead\. .SH DEVELOPER USAGE .P @@ -75,24 +75,24 @@ following help topics: .RS 0 .IP \(bu 2 json: -Make a package\.json file\. See npm help 5 \fBpackage\.json\fR\|\. +Make a package\.json file\. See npm help 5 \fBpackage\.json\fP\|\. .IP \(bu 2 link: For linking your current working code into Node's path, so that you don't have to reinstall every time you make a change\. Use -\fBnpm link\fR to do this\. +\fBnpm link\fP to do this\. .IP \(bu 2 install: It's a good idea to install things if you don't need the symbolic link\. Especially, installing other peoples code from the registry is done via -\fBnpm install\fR +\fBnpm install\fP .IP \(bu 2 adduser: Create an account or log in\. Credentials are stored in the user config file\. .IP \(bu 2 publish: -Use the \fBnpm publish\fR command to upload your code to the registry\. +Use the \fBnpm publish\fP command to upload your code to the registry\. .RE .SH CONFIGURATION @@ -103,27 +103,27 @@ npm is extremely configurable\. It reads its configuration options from .IP \(bu 2 Command line switches: .br -Set a config with \fB\-\-key val\fR\|\. All keys take a value, even if they +Set a config with \fB\-\-key val\fP\|\. All keys take a value, even if they are booleans (the config parser doesn't know what the options are at the time of parsing\.) If no value is provided, then the option is set -to boolean \fBtrue\fR\|\. +to boolean \fBtrue\fP\|\. .IP \(bu 2 Environment Variables: .br Set any config by prefixing the name in an environment variable with -\fBnpm_config_\fR\|\. For example, \fBexport npm_config_key=val\fR\|\. +\fBnpm_config_\fP\|\. For example, \fBexport npm_config_key=val\fP\|\. .IP \(bu 2 User Configs: .br The file at $HOME/\.npmrc is an ini\-formatted list of configs\. If -present, it is parsed\. If the \fBuserconfig\fR option is set in the cli +present, it is parsed\. If the \fBuserconfig\fP option is set in the cli or env, then that will be used instead\. .IP \(bu 2 Global Configs: .br The file found at \.\./etc/npmrc (from the node executable, by default this resolves to /usr/local/etc/npmrc) will be parsed if it is found\. -If the \fBglobalconfig\fR option is set in the cli, env, or user config, +If the \fBglobalconfig\fP option is set in the cli, env, or user config, then that file is parsed instead\. .IP \(bu 2 Defaults: @@ -133,14 +133,14 @@ lib/utils/config\-defs\.js\. These must not be changed\. .RE .P -See npm help 7 \fBnpm\-config\fR for much much more information\. +See npm help 7 \fBnpm\-config\fP for much much more information\. .SH CONTRIBUTIONS .P Patches welcome! .RS 0 .IP \(bu 2 code: -Read through npm help 7 \fBnpm\-coding\-style\fR if you plan to submit code\. +Read through npm help 7 \fBnpm\-coding\-style\fP if you plan to submit code\. You don't have to agree with it, but you do have to follow it\. .IP \(bu 2 docs: @@ -149,8 +149,8 @@ file in the "doc" folder\. (Don't worry about generating the man page\.) .RE .P -Contributors are listed in npm's \fBpackage\.json\fR file\. You can view them -easily by doing \fBnpm view npm contributors\fR\|\. +Contributors are listed in npm's \fBpackage\.json\fP file\. You can view them +easily by doing \fBnpm view npm contributors\fP\|\. .P If you would like to contribute, but don't know what to work on, check the issues list or ask on the mailing list\. @@ -175,7 +175,7 @@ npm\-@googlegroups\.com .RE .P Be sure to include \fIall\fR of the output from the npm command that didn't work -as expected\. The \fBnpm\-debug\.log\fR file is also helpful to provide\. +as expected\. The \fBnpm\-debug\.log\fP file is also helpful to provide\. .P 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\. diff --git a/deps/npm/man/man3/npm-bin.3 b/deps/npm/man/man3/npm-bin.3 index ece642c43f..3e67fc13f3 100644 --- a/deps/npm/man/man3/npm-bin.3 +++ b/deps/npm/man/man3/npm-bin.3 @@ -13,5 +13,5 @@ npm\.commands\.bin(args, cb) Print the folder where npm will install executables\. .P This function should not be used programmatically\. Instead, just refer -to the \fBnpm\.bin\fR property\. +to the \fBnpm\.bin\fP property\. diff --git a/deps/npm/man/man3/npm-bugs.3 b/deps/npm/man/man3/npm-bugs.3 index 8ba6507777..03f349ecec 100644 --- a/deps/npm/man/man3/npm-bugs.3 +++ b/deps/npm/man/man3/npm-bugs.3 @@ -11,7 +11,7 @@ npm\.commands\.bugs(package, callback) .SH DESCRIPTION .P This command tries to guess at the likely location of a package's -bug tracker URL, and then tries to open it using the \fB\-\-browser\fR +bug tracker URL, and then tries to open it using the \fB\-\-browser\fP config param\. .P Like other commands, the first parameter is an array\. This command only diff --git a/deps/npm/man/man3/npm-cache.3 b/deps/npm/man/man3/npm-cache.3 index 9416a1dc3e..0f3a376af4 100644 --- a/deps/npm/man/man3/npm-cache.3 +++ b/deps/npm/man/man3/npm-cache.3 @@ -21,8 +21,8 @@ functionality\. The callback is called with the package\.json data of the thing that is eventually added to or read from the cache\. .P -The top level \fBnpm\.commands\.cache(\.\.\.)\fR functionality is a public -interface, and like all commands on the \fBnpm\.commands\fR object, it will +The top level \fBnpm\.commands\.cache(\.\.\.)\fP functionality is a public +interface, and like all commands on the \fBnpm\.commands\fP object, it will match the command line behavior exactly\. .P However, the cache folder structure and the cache helper functions are diff --git a/deps/npm/man/man3/npm-commands.3 b/deps/npm/man/man3/npm-commands.3 index 429213c5d3..31112f8896 100644 --- a/deps/npm/man/man3/npm-commands.3 +++ b/deps/npm/man/man3/npm-commands.3 @@ -17,8 +17,8 @@ In general, all commands on the command object take an \fBarray\fR of positional argument \fBstrings\fR\|\. The last argument to any function is a callback\. Some commands are special and take other optional arguments\. .P -All commands have their own man page\. See \fBman npm\-<command>\fR for command\-line -usage, or \fBman 3 npm\-<command>\fR for programmatic usage\. +All commands have their own man page\. See \fBman npm\-<command>\fP for command\-line +usage, or \fBman 3 npm\-<command>\fP for programmatic usage\. .SH SEE ALSO .RS 0 .IP \(bu 2 diff --git a/deps/npm/man/man3/npm-config.3 b/deps/npm/man/man3/npm-config.3 index 1970f311f3..216d4d78df 100644 --- a/deps/npm/man/man3/npm-config.3 +++ b/deps/npm/man/man3/npm-config.3 @@ -16,29 +16,29 @@ This function acts much the same way as the command\-line version\. The first element in the array tells config what to do\. Possible values are: .RS 0 .IP \(bu 2 -\fBset\fR - Sets a config parameter\. The second element in \fBargs\fR is interpreted as the +\fBset\fP + Sets a config parameter\. The second element in \fBargs\fP is interpreted as the key, and the third element is interpreted as the value\. .IP \(bu 2 -\fBget\fR - Gets the value of a config parameter\. The second element in \fBargs\fR is the +\fBget\fP + Gets the value of a config parameter\. The second element in \fBargs\fP is the key to get the value of\. .IP \(bu 2 -\fBdelete\fR (\fBrm\fR or \fBdel\fR) - Deletes a parameter from the config\. The second element in \fBargs\fR is the +\fBdelete\fP (\fBrm\fP or \fBdel\fP) + Deletes a parameter from the config\. The second element in \fBargs\fP is the key to delete\. .IP \(bu 2 -\fBlist\fR (\fBls\fR) +\fBlist\fP (\fBls\fP) Show all configs that aren't secret\. No parameters necessary\. .IP \(bu 2 -\fBedit\fR: +\fBedit\fP: Opens the config file in the default editor\. This command isn't very useful programmatically, but it is made available\. .RE .P To programmatically access npm configuration settings, or set them for -the duration of a program, use the \fBnpm\.config\.set\fR and \fBnpm\.config\.get\fR +the duration of a program, use the \fBnpm\.config\.set\fP and \fBnpm\.config\.get\fP functions instead\. .SH SEE ALSO .RS 0 diff --git a/deps/npm/man/man3/npm-deprecate.3 b/deps/npm/man/man3/npm-deprecate.3 index ba6f31f817..7963db6ba9 100644 --- a/deps/npm/man/man3/npm-deprecate.3 +++ b/deps/npm/man/man3/npm-deprecate.3 @@ -16,20 +16,20 @@ a deprecation warning to all who attempt to install it\. The 'args' parameter must have exactly two elements: .RS 0 .IP \(bu 2 -\fBpackage[@version]\fR - The \fBversion\fR portion is optional, and may be either a range, or a +\fBpackage[@version]\fP + The \fBversion\fP portion is optional, and may be either a range, or a specific version, or a tag\. .IP \(bu 2 -\fBmessage\fR +\fBmessage\fP The warning message that will be printed whenever a user attempts to install the package\. .RE .P Note that you must be the package owner to deprecate something\. See the -\fBowner\fR and \fBadduser\fR help topics\. +\fBowner\fP and \fBadduser\fP help topics\. .P -To un\-deprecate a package, specify an empty string (\fB""\fR) for the \fBmessage\fR argument\. +To un\-deprecate a package, specify an empty string (\fB""\fP) for the \fBmessage\fP argument\. .SH SEE ALSO .RS 0 .IP \(bu 2 diff --git a/deps/npm/man/man3/npm-docs.3 b/deps/npm/man/man3/npm-docs.3 index 3c32506800..b99ea3fe94 100644 --- a/deps/npm/man/man3/npm-docs.3 +++ b/deps/npm/man/man3/npm-docs.3 @@ -11,7 +11,7 @@ npm\.commands\.docs(package, callback) .SH DESCRIPTION .P 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 +documentation URL, and then tries to open it using the \fB\-\-browser\fP config param\. .P Like other commands, the first parameter is an array\. This command only diff --git a/deps/npm/man/man3/npm-edit.3 b/deps/npm/man/man3/npm-edit.3 index 68c08b8b08..d76cea18a5 100644 --- a/deps/npm/man/man3/npm-edit.3 +++ b/deps/npm/man/man3/npm-edit.3 @@ -11,13 +11,13 @@ npm\.commands\.edit(package, callback) .SH DESCRIPTION .P Opens the package folder in the default editor (or whatever you've -configured as the npm \fBeditor\fR config \-\- see \fBnpm help config\fR\|\.) +configured as the npm \fBeditor\fP config \-\- see \fBnpm help config\fP\|\.) .P After it has been edited, the package is rebuilt so as to pick up any changes in compiled packages\. .P -For instance, you can do \fBnpm install connect\fR to install connect -into your package, and then \fBnpm\.commands\.edit(["connect"], callback)\fR +For instance, you can do \fBnpm install connect\fP to install connect +into your package, and then \fBnpm\.commands\.edit(["connect"], callback)\fP to make a few changes to your locally installed copy\. .P The first parameter is a string array with a single element, the package diff --git a/deps/npm/man/man3/npm-explore.3 b/deps/npm/man/man3/npm-explore.3 index 66c8adbb99..7f253524a1 100644 --- a/deps/npm/man/man3/npm-explore.3 +++ b/deps/npm/man/man3/npm-explore.3 @@ -16,7 +16,7 @@ If a command is specified, then it is run in the subshell, which then immediately terminates\. .P Note that the package is \fInot\fR automatically rebuilt afterwards, so be -sure to use \fBnpm rebuild <pkg>\fR if you make any changes\. +sure to use \fBnpm rebuild <pkg>\fP if you make any changes\. .P The first element in the 'args' parameter must be a package name\. After that is the optional command, which can be any number of strings\. All of the strings will be combined into one, space\-delimited command\. diff --git a/deps/npm/man/man3/npm-link.3 b/deps/npm/man/man3/npm-link.3 index 08d653057f..c8a35f631c 100644 --- a/deps/npm/man/man3/npm-link.3 +++ b/deps/npm/man/man3/npm-link.3 @@ -14,12 +14,12 @@ npm\.commands\.link(packages, callback) Package linking is a two\-step process\. .P Without parameters, link will create a globally\-installed -symbolic link from \fBprefix/package\-name\fR to the current folder\. +symbolic link from \fBprefix/package\-name\fP to the current folder\. .P -With a parameters, link will create a symlink from the local \fBnode_modules\fR +With a parameters, link will create a symlink from the local \fBnode_modules\fP folder to the global symlink\. .P -When creating tarballs for \fBnpm publish\fR, the linked packages are +When creating tarballs for \fBnpm publish\fP, the linked packages are "snapshotted" to their current state by resolving the symbolic links\. .P This is diff --git a/deps/npm/man/man3/npm-load.3 b/deps/npm/man/man3/npm-load.3 index 01e1d4107d..7268d01ad5 100644 --- a/deps/npm/man/man3/npm-load.3 +++ b/deps/npm/man/man3/npm-load.3 @@ -30,5 +30,5 @@ For example, to emulate the \-\-dev flag, pass an object that looks like this: .fi .RE .P -For a list of all the available command\-line configs, see \fBnpm help config\fR +For a list of all the available command\-line configs, see \fBnpm help config\fP diff --git a/deps/npm/man/man3/npm-ls.3 b/deps/npm/man/man3/npm-ls.3 index 9e4691380a..1e43327495 100644 --- a/deps/npm/man/man3/npm-ls.3 +++ b/deps/npm/man/man3/npm-ls.3 @@ -17,7 +17,7 @@ return that data using the callback\. This command does not take any arguments, but args must be defined\. Beyond that, if any arguments are passed in, npm will politely warn that it does not take positional arguments, though you may set config flags -like with any other command, such as \fBglobal\fR to list global packages\. +like with any other command, such as \fBglobal\fP to list global packages\. .P It will print out extraneous, missing, and invalid packages\. .P diff --git a/deps/npm/man/man3/npm-pack.3 b/deps/npm/man/man3/npm-pack.3 index 77d25321b6..de3d36c4f5 100644 --- a/deps/npm/man/man3/npm-pack.3 +++ b/deps/npm/man/man3/npm-pack.3 @@ -13,7 +13,7 @@ npm\.commands\.pack([packages,] callback) For anything that's installable (that is, a package folder, tarball, tarball url, name@tag, name@version, or name), this command will fetch it to the cache, and then copy the tarball to the current working -directory as \fB<name>\-<version>\.tgz\fR, and then write the filenames out to +directory as \fB<name>\-<version>\.tgz\fP, and then write the filenames out to stdout\. .P If the same package is specified multiple times, then the file will be diff --git a/deps/npm/man/man3/npm-ping.3 b/deps/npm/man/man3/npm-ping.3 index 9dc6a343b3..5fe65f4d23 100644 --- a/deps/npm/man/man3/npm-ping.3 +++ b/deps/npm/man/man3/npm-ping.3 @@ -10,7 +10,7 @@ npm\.registry\.ping(registry, options, function (er, pong)) .RE .SH DESCRIPTION .P -Attempts to connect to the given registry, returning a \fBpong\fR +Attempts to connect to the given registry, returning a \fBpong\fP object with various metadata if it succeeds\. .P This function is primarily useful for debugging connection issues diff --git a/deps/npm/man/man3/npm-publish.3 b/deps/npm/man/man3/npm-publish.3 index 5e25c4cbcb..650efc706c 100644 --- a/deps/npm/man/man3/npm-publish.3 +++ b/deps/npm/man/man3/npm-publish.3 @@ -14,10 +14,10 @@ Publishes a package to the registry so that it can be installed by name\. Possible values in the 'packages' array are: .RS 0 .IP \(bu 2 -\fB<folder>\fR: +\fB<folder>\fP: A folder containing a package\.json file .IP \(bu 2 -\fB<tarball>\fR: +\fB<tarball>\fP: A url or file path to a gzipped tar archive containing a single folder with a package\.json file inside\. diff --git a/deps/npm/man/man3/npm-rebuild.3 b/deps/npm/man/man3/npm-rebuild.3 index 5f09b05550..e1bdde2484 100644 --- a/deps/npm/man/man3/npm-rebuild.3 +++ b/deps/npm/man/man3/npm-rebuild.3 @@ -10,10 +10,10 @@ npm\.commands\.rebuild([packages,] callback) .RE .SH DESCRIPTION .P -This command runs the \fBnpm build\fR command on each of the matched packages\. This is useful +This command runs the \fBnpm build\fP command on each of the matched packages\. This is useful when you install a new version of node, and must recompile all your C++ addons with the new binary\. If no 'packages' parameter is specify, every package will be rebuilt\. .SH CONFIGURATION .P -See \fBnpm help build\fR +See \fBnpm help build\fP diff --git a/deps/npm/man/man3/npm-repo.3 b/deps/npm/man/man3/npm-repo.3 index ba421377a9..66558d6508 100644 --- a/deps/npm/man/man3/npm-repo.3 +++ b/deps/npm/man/man3/npm-repo.3 @@ -11,7 +11,7 @@ npm\.commands\.repo(package, callback) .SH DESCRIPTION .P This command tries to guess at the likely location of a package's -repository URL, and then tries to open it using the \fB\-\-browser\fR +repository URL, and then tries to open it using the \fB\-\-browser\fP config param\. .P Like other commands, the first parameter is an array\. This command only diff --git a/deps/npm/man/man3/npm-restart.3 b/deps/npm/man/man3/npm-restart.3 index fef30139eb..0d6b0c03be 100644 --- a/deps/npm/man/man3/npm-restart.3 +++ b/deps/npm/man/man3/npm-restart.3 @@ -39,13 +39,13 @@ postrestart If no version is specified, then it restarts the "active" version\. .P npm can restart multiple packages\. Just specify multiple packages in -the \fBpackages\fR parameter\. +the \fBpackages\fP parameter\. .SH NOTE .P Note that the "restart" script is run \fBin addition to\fR the "stop" and "start" scripts, not instead of them\. .P -This is the behavior as of \fBnpm\fR major version 2\. A change in this +This is the behavior as of \fBnpm\fP major version 2\. A change in this behavior will be accompanied by an increase in major version number .SH SEE ALSO .RS 0 diff --git a/deps/npm/man/man3/npm-root.3 b/deps/npm/man/man3/npm-root.3 index 7c208f41fc..d34c979024 100644 --- a/deps/npm/man/man3/npm-root.3 +++ b/deps/npm/man/man3/npm-root.3 @@ -10,7 +10,7 @@ npm\.commands\.root(args, callback) .RE .SH DESCRIPTION .P -Print the effective \fBnode_modules\fR folder to standard out\. +Print the effective \fBnode_modules\fP folder to standard out\. .P \|'args' is never used and callback is never called with data\. \|'args' must be present or things will break\. diff --git a/deps/npm/man/man3/npm-start.3 b/deps/npm/man/man3/npm-start.3 index 9200312fd2..d309d4264a 100644 --- a/deps/npm/man/man3/npm-start.3 +++ b/deps/npm/man/man3/npm-start.3 @@ -13,5 +13,5 @@ npm\.commands\.start(packages, callback) This runs a package's "start" script, if one was provided\. .P npm can start multiple packages\. Just specify multiple packages in the -\fBpackages\fR parameter\. +\fBpackages\fP parameter\. diff --git a/deps/npm/man/man3/npm-stop.3 b/deps/npm/man/man3/npm-stop.3 index f857069e6a..30e3444a9d 100644 --- a/deps/npm/man/man3/npm-stop.3 +++ b/deps/npm/man/man3/npm-stop.3 @@ -13,5 +13,5 @@ npm\.commands\.stop(packages, callback) This runs a package's "stop" script, if one was provided\. .P npm can run stop on multiple packages\. Just specify multiple packages -in the \fBpackages\fR parameter\. +in the \fBpackages\fP parameter\. diff --git a/deps/npm/man/man3/npm-tag.3 b/deps/npm/man/man3/npm-tag.3 index 4eae2c4b0a..2eecc98061 100644 --- a/deps/npm/man/man3/npm-tag.3 +++ b/deps/npm/man/man3/npm-tag.3 @@ -11,7 +11,7 @@ npm\.commands\.tag(package@version, tag, callback) .SH DESCRIPTION .P Tags the specified version of the package with the specified tag, or the -\fB\-\-tag\fR config if not specified\. +\fB\-\-tag\fP config if not specified\. .P The 'package@version' is an array of strings, but only the first two elements are currently used\. @@ -23,5 +23,5 @@ specific version)\. The second element is the name of the tag to tag this version with\. If this parameter is missing or falsey (empty), the default from the config will be used\. For more information about how to set this config, check -\fBman 3 npm\-config\fR for programmatic usage or \fBman npm\-config\fR for cli usage\. +\fBman 3 npm\-config\fP for programmatic usage or \fBman npm\-config\fP for cli usage\. diff --git a/deps/npm/man/man3/npm-test.3 b/deps/npm/man/man3/npm-test.3 index 67aa24ad9c..3c91fde980 100644 --- a/deps/npm/man/man3/npm-test.3 +++ b/deps/npm/man/man3/npm-test.3 @@ -12,9 +12,9 @@ .P This runs a package's "test" script, if one was provided\. .P -To run tests as a condition of installation, set the \fBnpat\fR config to +To run tests as a condition of installation, set the \fBnpat\fP config to true\. .P npm can run tests on multiple packages\. Just specify multiple packages -in the \fBpackages\fR parameter\. +in the \fBpackages\fP parameter\. diff --git a/deps/npm/man/man3/npm-update.3 b/deps/npm/man/man3/npm-update.3 index 60f2d065ef..51601179d9 100644 --- a/deps/npm/man/man3/npm-update.3 +++ b/deps/npm/man/man3/npm-update.3 @@ -15,7 +15,7 @@ npm\.commands\.update(packages, callback) Updates a package, upgrading it to the latest version\. It also installs any missing packages\. .P -The \fBpackages\fR argument is an array of packages to update\. The \fBcallback\fR +The \fBpackages\fP argument is an array of packages to update\. The \fBcallback\fP parameter will be called when done or when an error occurs\. .SH SEE ALSO .RS 0 diff --git a/deps/npm/man/man3/npm-view.3 b/deps/npm/man/man3/npm-view.3 index 8722bf1ce8..65a201f65b 100644 --- a/deps/npm/man/man3/npm-view.3 +++ b/deps/npm/man/man3/npm-view.3 @@ -11,7 +11,7 @@ npm\.commands\.view(args, [silent,] callback) .SH DESCRIPTION .P This command shows data about a package and prints it to the stream -referenced by the \fBoutfd\fR config, which defaults to stdout\. +referenced by the \fBoutfd\fP config, which defaults to stdout\. .P The "args" parameter is an ordered list that closely resembles the command\-line usage\. The elements should be ordered such that the first element is @@ -21,7 +21,7 @@ which can be used to get only the information desired from the registry\. .P The callback will be passed all of the data returned by the query\. .P -For example, to get the package registry entry for the \fBconnect\fR package, +For example, to get the package registry entry for the \fBconnect\fP package, you can do this: .P .RS 2 @@ -33,7 +33,7 @@ npm\.commands\.view(["connect"], callback) If no version is specified, "latest" is assumed\. .P Field names can be specified after the package descriptor\. -For example, to show the dependencies of the \fBronn\fR package at version +For example, to show the dependencies of the \fBronn\fP package at version 0\.3\.5, you could do the following: .P .RS 2 @@ -84,7 +84,7 @@ npm\.commands\.view(["express", "contributors\.name", "contributors\.email"], ca .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\. (See \fBnpm help json\fP for more on this\.) .P .RS 2 .nf diff --git a/deps/npm/man/man3/npm-whoami.3 b/deps/npm/man/man3/npm-whoami.3 index 474ac65236..c9e20c7895 100644 --- a/deps/npm/man/man3/npm-whoami.3 +++ b/deps/npm/man/man3/npm-whoami.3 @@ -10,7 +10,7 @@ npm\.commands\.whoami(args, callback) .RE .SH DESCRIPTION .P -Print the \fBusername\fR config to standard output\. +Print the \fBusername\fP config to standard output\. .P \|'args' is never used and callback is never called with data\. \|'args' must be present or things will break\. diff --git a/deps/npm/man/man3/npm.3 b/deps/npm/man/man3/npm.3 index 440d7d02c4..dd56636fc9 100644 --- a/deps/npm/man/man3/npm.3 +++ b/deps/npm/man/man3/npm.3 @@ -20,22 +20,22 @@ npm\.load([configObject, ]function (er, npm) { .RE .SH VERSION .P -2.13.1 +2.13.2 .SH DESCRIPTION .P This is the API documentation for npm\. To find documentation of the command line -client, see npm help \fBnpm\fR\|\. +client, see npm help \fBnpm\fP\|\. .P -Prior to using npm's commands, \fBnpm\.load()\fR must be called\. If you provide -\fBconfigObject\fR as an object map of top\-level configs, they override the values +Prior to using npm's commands, \fBnpm\.load()\fP must be called\. If you provide +\fBconfigObject\fP as an object map of top\-level configs, they override the values stored in the various config locations\. In the npm command line client, this set of configs is parsed from the command line options\. Additional configuration params are loaded from two configuration files\. See -npm help \fBnpm\-config\fR, npm help 7 \fBnpm\-config\fR, and npm help 5 \fBnpmrc\fR for more information\. +npm help \fBnpm\-config\fP, npm help 7 \fBnpm\-config\fP, and npm help 5 \fBnpmrc\fP for more information\. .P After that, each of the functions are accessible in the -commands object: \fBnpm\.commands\.<cmd>\fR\|\. See npm help 7 \fBnpm\-index\fR for a list of +commands object: \fBnpm\.commands\.<cmd>\fP\|\. See npm help 7 \fBnpm\-index\fP for a list of all possible commands\. .P All commands on the command object take an \fBarray\fR of positional argument @@ -45,50 +45,50 @@ commands take other optional arguments\. Configs cannot currently be set on a per function basis, as each call to npm\.config\.set will change the value for \fIall\fR npm commands in that process\. .P -To find API documentation for a specific command, run the \fBnpm apihelp\fR +To find API documentation for a specific command, run the \fBnpm apihelp\fP command\. .SH METHODS AND PROPERTIES .RS 0 .IP \(bu 2 -\fBnpm\.load(configs, cb)\fR - Load the configuration params, and call the \fBcb\fR function once the +\fBnpm\.load(configs, cb)\fP + Load the configuration params, and call the \fBcb\fP function once the globalconfig and userconfig files have been loaded as well, or on nextTick if they've already been loaded\. .IP \(bu 2 -\fBnpm\.config\fR +\fBnpm\.config\fP An object for accessing npm configuration parameters\. .RS 0 .IP \(bu 2 -\fBnpm\.config\.get(key)\fR +\fBnpm\.config\.get(key)\fP .IP \(bu 2 -\fBnpm\.config\.set(key, val)\fR +\fBnpm\.config\.set(key, val)\fP .IP \(bu 2 -\fBnpm\.config\.del(key)\fR +\fBnpm\.config\.del(key)\fP .RE .IP \(bu 2 -\fBnpm\.dir\fR or \fBnpm\.root\fR - The \fBnode_modules\fR directory where npm will operate\. +\fBnpm\.dir\fP or \fBnpm\.root\fP + The \fBnode_modules\fP directory where npm will operate\. .IP \(bu 2 -\fBnpm\.prefix\fR +\fBnpm\.prefix\fP The prefix where npm is operating\. (Most often the current working directory\.) .IP \(bu 2 -\fBnpm\.cache\fR +\fBnpm\.cache\fP The place where npm keeps JSON and tarballs it fetches from the registry (or uploads to the registry)\. .IP \(bu 2 -\fBnpm\.tmp\fR +\fBnpm\.tmp\fP npm's temporary working directory\. .IP \(bu 2 -\fBnpm\.deref\fR +\fBnpm\.deref\fP Get the "real" name for a command that has either an alias or abbreviation\. .RE .SH MAGIC .P -For each of the methods in the \fBnpm\.commands\fR object, a method is added to the +For each of the methods in the \fBnpm\.commands\fP object, a method is added to the npm object, which takes a set of positional string arguments rather than an array and a callback\. .P @@ -106,13 +106,13 @@ For example, this would work in a node repl: .fi .RE .P -Note that that \fIwon't\fR work in a node program, since the \fBinstall\fR +Note that that \fIwon't\fR work in a node program, since the \fBinstall\fP method will get called before the configuration load is completed\. .SH ABBREVS .P -In order to support \fBnpm ins foo\fR instead of \fBnpm install foo\fR, the -\fBnpm\.commands\fR object has a set of abbreviations as well as the full -method names\. Use the \fBnpm\.deref\fR method to find the real name\. +In order to support \fBnpm ins foo\fP instead of \fBnpm install foo\fP, the +\fBnpm\.commands\fP object has a set of abbreviations as well as the full +method names\. Use the \fBnpm\.deref\fP method to find the real name\. .P For example: .P diff --git a/deps/npm/man/man5/npm-folders.5 b/deps/npm/man/man5/npm-folders.5 index 321b079edb..f1b2a8d7f2 100644 --- a/deps/npm/man/man5/npm-folders.5 +++ b/deps/npm/man/man5/npm-folders.5 @@ -9,89 +9,89 @@ This document will tell you what it puts where\. .SS tl;dr .RS 0 .IP \(bu 2 -Local install (default): puts stuff in \fB\|\./node_modules\fR of the current +Local install (default): puts stuff in \fB\|\./node_modules\fP of the current package root\. .IP \(bu 2 -Global install (with \fB\-g\fR): puts stuff in /usr/local or wherever node +Global install (with \fB\-g\fP): puts stuff in /usr/local or wherever node is installed\. .IP \(bu 2 -Install it \fBlocally\fR if you're going to \fBrequire()\fR it\. +Install it \fBlocally\fR if you're going to \fBrequire()\fP it\. .IP \(bu 2 Install it \fBglobally\fR if you're going to run it on the command line\. .IP \(bu 2 -If you need both, then install it in both places, or use \fBnpm link\fR\|\. +If you need both, then install it in both places, or use \fBnpm link\fP\|\. .RE .SS prefix Configuration .P -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\|\. +The \fBprefix\fP config defaults to the location where node is installed\. +On most systems, this is \fB/usr/local\fP, and most of the time is the same +as node's \fBprocess\.installPrefix\fP\|\. .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\|\. +\fB{prefix}/bin/node\fP rather than \fB{prefix}/node\.exe\fP\|\. .P -When the \fBglobal\fR flag is set, npm installs things into this prefix\. +When the \fBglobal\fP 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 .P -Packages are dropped into the \fBnode_modules\fR folder under the \fBprefix\fR\|\. +Packages are dropped into the \fBnode_modules\fP folder under the \fBprefix\fP\|\. 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\. +\fBrequire("packagename")\fP to load its main module, or +\fBrequire("packagename/lib/path/to/sub/module")\fP 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\.) +Global installs on Unix systems go to \fB{prefix}/lib/node_modules\fP\|\. +Global installs on Windows go to \fB{prefix}/node_modules\fP (that is, no +\fBlib\fP folder\.) .P Scoped packages are installed the same way, except they are grouped together -in a sub\-folder of the relevant \fBnode_modules\fR folder with the name of that -scope prefix by the @ symbol, e\.g\. \fBnpm install @myorg/package\fR would place -the package in \fB{prefix}/node_modules/@myorg/package\fR\|\. See npm help 7 \fBscopes\fR for +in a sub\-folder of the relevant \fBnode_modules\fP folder with the name of that +scope prefix by the @ symbol, e\.g\. \fBnpm install @myorg/package\fP would place +the package in \fB{prefix}/node_modules/@myorg/package\fP\|\. See npm help 7 \fBscopes\fP for more details\. .P -If you wish to \fBrequire()\fR a package, then install it locally\. +If you wish to \fBrequire()\fP a package, then install it locally\. .SS Executables .P -When in global mode, executables are linked into \fB{prefix}/bin\fR on Unix, -or directly into \fB{prefix}\fR on Windows\. +When in global mode, executables are linked into \fB{prefix}/bin\fP on Unix, +or directly into \fB{prefix}\fP 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 +\fB\|\./node_modules/\.bin\fP 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\|\.) +when you run \fBnpm test\fP\|\.) .SS Man Pages .P -When in global mode, man pages are linked into \fB{prefix}/share/man\fR\|\. +When in global mode, man pages are linked into \fB{prefix}/share/man\fP\|\. .P When in local mode, man pages are not installed\. .P Man pages are not installed on Windows systems\. .SS Cache .P -See npm help \fBnpm\-cache\fR\|\. Cache files are stored in \fB~/\.npm\fR on Posix, or -\fB~/npm\-cache\fR on Windows\. +See npm help \fBnpm\-cache\fP\|\. Cache files are stored in \fB~/\.npm\fP on Posix, or +\fB~/npm\-cache\fP on Windows\. .P -This is controlled by the \fBcache\fR configuration param\. +This is controlled by the \fBcache\fP configuration param\. .SS Temp Files .P 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\. +\fBtmp\fP config, which defaults to the TMPDIR, TMP, or TEMP environment +variables, or \fB/tmp\fP on Unix and \fBc:\\windows\\temp\fP 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 .P 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 +\fBprefix\fP folder\. This is so that \fBnpm install foo@1\.2\.3\fP will install +to the sensible root of your package, even if you happen to have \fBcd\fPed 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 that contains either a \fBpackage\.json\fP file, or a \fBnode_modules\fP 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 @@ -99,16 +99,16 @@ 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 +When you run \fBnpm install foo@1\.2\.3\fP, then the package is loaded into +the cache, and then unpacked into \fB\|\./node_modules/foo\fP\|\. Then, any of foo's dependencies are similarly unpacked into -\fB\|\./node_modules/foo/node_modules/\.\.\.\fR\|\. +\fB\|\./node_modules/foo/node_modules/\.\.\.\fP\|\. .P -Any bin files are symlinked to \fB\|\./node_modules/\.bin/\fR, so that they may +Any bin files are symlinked to \fB\|\./node_modules/\.bin/\fP, so that they may be found by npm scripts when necessary\. .SS Global Installation .P -If the \fBglobal\fR configuration is set to true, then npm will +If the \fBglobal\fP configuration is set to true, then npm will install packages "globally"\. .P For global installation, packages are installed roughly the same way, @@ -116,21 +116,21 @@ but using the folders described above\. .SS Cycles, Conflicts, and Folder Parsimony .P 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 +walks up the directories looking for \fBnode_modules\fP folders\. So, at every +stage, if a package is already installed in an ancestor \fBnode_modules\fP folder, then it is not installed at the current location\. .P -Consider the case above, where \fBfoo \-> bar \-> baz\fR\|\. Imagine if, in +Consider the case above, where \fBfoo \-> bar \-> baz\fP\|\. 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 +\fBfoo \-> bar \-> baz \-> bar \-> baz \.\.\.\fP\|\. However, since the folder +structure is: \fBfoo/node_modules/bar/node_modules/baz\fP, there's no need to +put another copy of bar into \fB\|\.\.\./baz/node_modules\fP, since when it calls require("bar"), it will get the copy that is installed in -\fBfoo/node_modules/bar\fR\|\. +\fBfoo/node_modules/bar\fP\|\. .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 +version would be installed in multiple nested \fBnode_modules\fP folders\. It +is still possible to have \fBa/node_modules/b/node_modules/a\fP if the two "a" packages are different versions\. However, without repeating the exact same package multiple times, an infinite regress will always be prevented\. @@ -176,36 +176,36 @@ foo .fi .RE .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\. +Since foo depends directly on \fBbar@1\.2\.3\fP and \fBbaz@1\.2\.3\fP, those are +installed in foo's \fBnode_modules\fP 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, +parent installation of blerg satisfies bar's dependency on \fBblerg@1\.x\fP, 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], +bar's \fBnode_modules\fP folder\. Because it depends on \fBbaz@2\.x\fP, it cannot +re\-use the \fBbaz@1\.2\.3\fP installed in the parent \fBnode_modules\fP folder [D], and must install its own copy [C]\. .P -Underneath bar, the \fBbaz \-> quux \-> bar\fR dependency creates a cycle\. +Underneath bar, the \fBbaz \-> quux \-> bar\fP 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 +Underneath \fBfoo \-> baz\fP [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\|\. +For a graphical breakdown of what is installed where, use \fBnpm ls\fP\|\. .SS Publishing .P -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 +Upon publishing, npm will look in the \fBnode_modules\fP folder\. If any of +the items there are not in the \fBbundledDependencies\fP 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 npm help 5 \fBpackage\.json\fR for more information\. +cannot be found elsewhere\. See npm help 5 \fBpackage\.json\fP for more information\. .SH SEE ALSO .RS 0 .IP \(bu 2 diff --git a/deps/npm/man/man5/npm-global.5 b/deps/npm/man/man5/npm-global.5 index 321b079edb..f1b2a8d7f2 100644 --- a/deps/npm/man/man5/npm-global.5 +++ b/deps/npm/man/man5/npm-global.5 @@ -9,89 +9,89 @@ This document will tell you what it puts where\. .SS tl;dr .RS 0 .IP \(bu 2 -Local install (default): puts stuff in \fB\|\./node_modules\fR of the current +Local install (default): puts stuff in \fB\|\./node_modules\fP of the current package root\. .IP \(bu 2 -Global install (with \fB\-g\fR): puts stuff in /usr/local or wherever node +Global install (with \fB\-g\fP): puts stuff in /usr/local or wherever node is installed\. .IP \(bu 2 -Install it \fBlocally\fR if you're going to \fBrequire()\fR it\. +Install it \fBlocally\fR if you're going to \fBrequire()\fP it\. .IP \(bu 2 Install it \fBglobally\fR if you're going to run it on the command line\. .IP \(bu 2 -If you need both, then install it in both places, or use \fBnpm link\fR\|\. +If you need both, then install it in both places, or use \fBnpm link\fP\|\. .RE .SS prefix Configuration .P -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\|\. +The \fBprefix\fP config defaults to the location where node is installed\. +On most systems, this is \fB/usr/local\fP, and most of the time is the same +as node's \fBprocess\.installPrefix\fP\|\. .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\|\. +\fB{prefix}/bin/node\fP rather than \fB{prefix}/node\.exe\fP\|\. .P -When the \fBglobal\fR flag is set, npm installs things into this prefix\. +When the \fBglobal\fP 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 .P -Packages are dropped into the \fBnode_modules\fR folder under the \fBprefix\fR\|\. +Packages are dropped into the \fBnode_modules\fP folder under the \fBprefix\fP\|\. 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\. +\fBrequire("packagename")\fP to load its main module, or +\fBrequire("packagename/lib/path/to/sub/module")\fP 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\.) +Global installs on Unix systems go to \fB{prefix}/lib/node_modules\fP\|\. +Global installs on Windows go to \fB{prefix}/node_modules\fP (that is, no +\fBlib\fP folder\.) .P Scoped packages are installed the same way, except they are grouped together -in a sub\-folder of the relevant \fBnode_modules\fR folder with the name of that -scope prefix by the @ symbol, e\.g\. \fBnpm install @myorg/package\fR would place -the package in \fB{prefix}/node_modules/@myorg/package\fR\|\. See npm help 7 \fBscopes\fR for +in a sub\-folder of the relevant \fBnode_modules\fP folder with the name of that +scope prefix by the @ symbol, e\.g\. \fBnpm install @myorg/package\fP would place +the package in \fB{prefix}/node_modules/@myorg/package\fP\|\. See npm help 7 \fBscopes\fP for more details\. .P -If you wish to \fBrequire()\fR a package, then install it locally\. +If you wish to \fBrequire()\fP a package, then install it locally\. .SS Executables .P -When in global mode, executables are linked into \fB{prefix}/bin\fR on Unix, -or directly into \fB{prefix}\fR on Windows\. +When in global mode, executables are linked into \fB{prefix}/bin\fP on Unix, +or directly into \fB{prefix}\fP 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 +\fB\|\./node_modules/\.bin\fP 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\|\.) +when you run \fBnpm test\fP\|\.) .SS Man Pages .P -When in global mode, man pages are linked into \fB{prefix}/share/man\fR\|\. +When in global mode, man pages are linked into \fB{prefix}/share/man\fP\|\. .P When in local mode, man pages are not installed\. .P Man pages are not installed on Windows systems\. .SS Cache .P -See npm help \fBnpm\-cache\fR\|\. Cache files are stored in \fB~/\.npm\fR on Posix, or -\fB~/npm\-cache\fR on Windows\. +See npm help \fBnpm\-cache\fP\|\. Cache files are stored in \fB~/\.npm\fP on Posix, or +\fB~/npm\-cache\fP on Windows\. .P -This is controlled by the \fBcache\fR configuration param\. +This is controlled by the \fBcache\fP configuration param\. .SS Temp Files .P 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\. +\fBtmp\fP config, which defaults to the TMPDIR, TMP, or TEMP environment +variables, or \fB/tmp\fP on Unix and \fBc:\\windows\\temp\fP 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 .P 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 +\fBprefix\fP folder\. This is so that \fBnpm install foo@1\.2\.3\fP will install +to the sensible root of your package, even if you happen to have \fBcd\fPed 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 that contains either a \fBpackage\.json\fP file, or a \fBnode_modules\fP 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 @@ -99,16 +99,16 @@ 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 +When you run \fBnpm install foo@1\.2\.3\fP, then the package is loaded into +the cache, and then unpacked into \fB\|\./node_modules/foo\fP\|\. Then, any of foo's dependencies are similarly unpacked into -\fB\|\./node_modules/foo/node_modules/\.\.\.\fR\|\. +\fB\|\./node_modules/foo/node_modules/\.\.\.\fP\|\. .P -Any bin files are symlinked to \fB\|\./node_modules/\.bin/\fR, so that they may +Any bin files are symlinked to \fB\|\./node_modules/\.bin/\fP, so that they may be found by npm scripts when necessary\. .SS Global Installation .P -If the \fBglobal\fR configuration is set to true, then npm will +If the \fBglobal\fP configuration is set to true, then npm will install packages "globally"\. .P For global installation, packages are installed roughly the same way, @@ -116,21 +116,21 @@ but using the folders described above\. .SS Cycles, Conflicts, and Folder Parsimony .P 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 +walks up the directories looking for \fBnode_modules\fP folders\. So, at every +stage, if a package is already installed in an ancestor \fBnode_modules\fP folder, then it is not installed at the current location\. .P -Consider the case above, where \fBfoo \-> bar \-> baz\fR\|\. Imagine if, in +Consider the case above, where \fBfoo \-> bar \-> baz\fP\|\. 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 +\fBfoo \-> bar \-> baz \-> bar \-> baz \.\.\.\fP\|\. However, since the folder +structure is: \fBfoo/node_modules/bar/node_modules/baz\fP, there's no need to +put another copy of bar into \fB\|\.\.\./baz/node_modules\fP, since when it calls require("bar"), it will get the copy that is installed in -\fBfoo/node_modules/bar\fR\|\. +\fBfoo/node_modules/bar\fP\|\. .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 +version would be installed in multiple nested \fBnode_modules\fP folders\. It +is still possible to have \fBa/node_modules/b/node_modules/a\fP if the two "a" packages are different versions\. However, without repeating the exact same package multiple times, an infinite regress will always be prevented\. @@ -176,36 +176,36 @@ foo .fi .RE .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\. +Since foo depends directly on \fBbar@1\.2\.3\fP and \fBbaz@1\.2\.3\fP, those are +installed in foo's \fBnode_modules\fP 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, +parent installation of blerg satisfies bar's dependency on \fBblerg@1\.x\fP, 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], +bar's \fBnode_modules\fP folder\. Because it depends on \fBbaz@2\.x\fP, it cannot +re\-use the \fBbaz@1\.2\.3\fP installed in the parent \fBnode_modules\fP folder [D], and must install its own copy [C]\. .P -Underneath bar, the \fBbaz \-> quux \-> bar\fR dependency creates a cycle\. +Underneath bar, the \fBbaz \-> quux \-> bar\fP 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 +Underneath \fBfoo \-> baz\fP [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\|\. +For a graphical breakdown of what is installed where, use \fBnpm ls\fP\|\. .SS Publishing .P -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 +Upon publishing, npm will look in the \fBnode_modules\fP folder\. If any of +the items there are not in the \fBbundledDependencies\fP 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 npm help 5 \fBpackage\.json\fR for more information\. +cannot be found elsewhere\. See npm help 5 \fBpackage\.json\fP for more information\. .SH SEE ALSO .RS 0 .IP \(bu 2 diff --git a/deps/npm/man/man5/npm-json.5 b/deps/npm/man/man5/npm-json.5 index 23280ede2c..d2c741984a 100644 --- a/deps/npm/man/man5/npm-json.5 +++ b/deps/npm/man/man5/npm-json.5 @@ -7,7 +7,7 @@ This document is all you need to know about what's required in your package\.jso 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 npm help 7 \fBnpm\-config\fR\|\. +settings described in npm help 7 \fBnpm\-config\fP\|\. .SH name .P The \fImost\fR important things in your package\.json are the name and version fields\. @@ -50,8 +50,8 @@ already, before you get too attached to it\. https://www\.npmjs\.com/ .RE .P -A name can be optionally prefixed by a scope, e\.g\. \fB@myorg/mypackage\fR\|\. See -npm help 7 \fBnpm\-scope\fR for more detail\. +A name can be optionally prefixed by a scope, e\.g\. \fB@myorg/mypackage\fP\|\. See +npm help 7 \fBnpm\-scope\fP for more detail\. .SH version .P The \fImost\fR important things in your package\.json are the name and version fields\. @@ -62,17 +62,17 @@ 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\.) +with npm as a dependency\. (\fBnpm install semver\fP to use it yourself\.) .P More on version numbers and ranges at npm help 7 semver\. .SH description .P Put a description in it\. It's a string\. This helps people discover your -package, as it's listed in \fBnpm search\fR\|\. +package, as it's listed in \fBnpm search\fP\|\. .SH keywords .P Put keywords in it\. It's an array of strings\. This helps people -discover your package as it's listed in \fBnpm search\fR\|\. +discover your package as it's listed in \fBnpm search\fP\|\. .SH homepage .P The url to the project homepage\. @@ -101,7 +101,7 @@ It should look like this: 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\. +If a url is provided, it will be used by the \fBnpm bugs\fP command\. .SH license .P You should specify a license for your package so that people know how they are @@ -138,7 +138,7 @@ you are using a custom license, use the following valid SPDX expression: .fi .RE .P -Then include a file named \fB<filename>\fR at the top level of the package\. +Then include a file named \fB<filename>\fP at the top level of the package\. .P Some old packages used license objects or a "licenses" property containing an array of license objects: @@ -185,7 +185,7 @@ unpublished package under any terms: .fi .RE .P -Consider also setting \fB"private": true\fR to prevent accidental publication\. +Consider also setting \fB"private": true\fP to prevent accidental publication\. .SH people fields: author, contributors .P The "author" is one person\. "contributors" is an array of people\. A "person" @@ -224,8 +224,8 @@ up by the files array\. The "\.npmignore" file works just like a .SH main .P 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\. +That is, if your package is named \fBfoo\fP, and a user installs it, and then does +\fBrequire("foo")\fP, 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 @@ -237,9 +237,9 @@ 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 +To use this, supply a \fBbin\fP 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 +\fBprefix/bin\fP for global installs, or \fB\|\./node_modules/\.bin/\fP for local installs\. .P For example, myapp could have this: @@ -250,8 +250,8 @@ For example, myapp could have this: .fi .RE .P -So, when you install myapp, it'll create a symlink from the \fBcli\.js\fR script to -\fB/usr/local/bin/myapp\fR\|\. +So, when you install myapp, it'll create a symlink from the \fBcli\.js\fP script to +\fB/usr/local/bin/myapp\fP\|\. .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: @@ -276,10 +276,10 @@ would be the same as this: .SH man .P Specify either a single file or an array of filenames to put in place for the -\fBman\fR program to find\. +\fBman\fP 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: +result from \fBman <pkgname>\fP, regardless of its actual filename\. For example: .P .RS 2 .nf @@ -292,7 +292,7 @@ result from \fBman <pkgname>\fR, regardless of its actual filename\. For exampl .fi .RE .P -would link the \fB\|\./man/doc\.1\fR file in such that it is the target for \fBman foo\fR +would link the \fB\|\./man/doc\.1\fP file in such that it is the target for \fBman foo\fP .P If the filename doesn't start with the package name, then it's prefixed\. So, this: @@ -308,9 +308,9 @@ So, this: .fi .RE .P -will create files to do \fBman foo\fR and \fBman foo\-bar\fR\|\. +will create files to do \fBman foo\fP and \fBman foo\-bar\fP\|\. .P -Man files must end with a number, and optionally a \fB\|\.gz\fR suffix if they are +Man files must end with a number, and optionally a \fB\|\.gz\fP suffix if they are compressed\. The number dictates which man section the file is installed into\. .P .RS 2 @@ -324,11 +324,11 @@ compressed\. The number dictates which man section the file is installed into\. .fi .RE .P -will create entries for \fBman foo\fR and \fBman 2 foo\fR +will create entries for \fBman foo\fP and \fBman 2 foo\fP .SH directories .P 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 +few ways that you can indicate the structure of your package using a \fBdirectories\fP object\. If you look at npm's package\.json \fIhttps://registry\.npmjs\.org/npm/latest\fR, you'll see that it has directories for doc, lib, and man\. .P @@ -339,13 +339,13 @@ 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 .P -If you specify a \fBbin\fR directory in \fBdirectories\.bin\fR, all the files in +If you specify a \fBbin\fP directory in \fBdirectories\.bin\fP, all the files in that folder will be added\. .P -Because of the way the \fBbin\fR directive works, specifying both a -\fBbin\fR path and setting \fBdirectories\.bin\fR is an error\. If you want to -specify individual files, use \fBbin\fR, and for all the files in an -existing \fBbin\fR directory, use \fBdirectories\.bin\fR\|\. +Because of the way the \fBbin\fP directive works, specifying both a +\fBbin\fP path and setting \fBdirectories\.bin\fP is an error\. If you want to +specify individual files, use \fBbin\fP, and for all the files in an +existing \fBbin\fP directory, use \fBdirectories\.bin\fP\|\. .SS directories\.man .P A folder that is full of man pages\. Sugar to generate a "man" array by @@ -360,7 +360,7 @@ Put example scripts in here\. Someday, it might be exposed in some clever way\. .SH repository .P 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 +want to contribute\. If the git repo is on GitHub, then the \fBnpm docs\fP command will be able to find you\. .P Do it like this: @@ -384,7 +384,7 @@ directly to a VCS program without any modification\. It should not be a url to html project page that you put in your browser\. It's for computers\. .P For GitHub, GitHub gist, Bitbucket, or GitLab repositories you can use the same -shortcut syntax you use for \fBnpm install\fR: +shortcut syntax you use for \fBnpm install\fP: .P .RS 2 .nf @@ -403,7 +403,7 @@ The "scripts" property is a dictionary containing 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 npm help 7 \fBnpm\-scripts\fR to find out more about writing package scripts\. +See npm help 7 \fBnpm\-scripts\fP to find out more about writing package scripts\. .SH config .P A "config" object can be used to set configuration parameters used in package @@ -418,10 +418,10 @@ following: .RE .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\|\. +\fBnpm_package_config_port\fP environment variable, then the user could +override that by doing \fBnpm config set foo:port 8001\fP\|\. .P -See npm help 7 \fBnpm\-config\fR and npm help 7 \fBnpm\-scripts\fR for more on package +See npm help 7 \fBnpm\-config\fP and npm help 7 \fBnpm\-scripts\fP for more on package configs\. .SH dependencies .P @@ -431,44 +431,44 @@ space\-separated descriptors\. Dependencies can also be identified with a tarball or git URL\. .P \fBPlease do not put test harnesses or transpilers in your -\fBdependencies\fR object\.\fR See \fBdevDependencies\fR, below\. +\fBdependencies\fP object\.\fR See \fBdevDependencies\fP, below\. .P See npm help 7 semver for more details about specifying version ranges\. .RS 0 .IP \(bu 2 -\fBversion\fR Must match \fBversion\fR exactly +\fBversion\fP Must match \fBversion\fP exactly .IP \(bu 2 -\fB>version\fR Must be greater than \fBversion\fR +\fB>version\fP Must be greater than \fBversion\fP .IP \(bu 2 -\fB>=version\fR etc +\fB>=version\fP etc .IP \(bu 2 -\fB<version\fR +\fB<version\fP .IP \(bu 2 -\fB<=version\fR +\fB<=version\fP .IP \(bu 2 -\fB~version\fR "Approximately equivalent to version" See npm help 7 semver +\fB~version\fP "Approximately equivalent to version" See npm help 7 semver .IP \(bu 2 -\fB^version\fR "Compatible with version" See npm help 7 semver +\fB^version\fP "Compatible with version" See npm help 7 semver .IP \(bu 2 -\fB1\.2\.x\fR 1\.2\.0, 1\.2\.1, etc\., but not 1\.3\.0 +\fB1\.2\.x\fP 1\.2\.0, 1\.2\.1, etc\., but not 1\.3\.0 .IP \(bu 2 -\fBhttp://\.\.\.\fR See 'URLs as Dependencies' below +\fBhttp://\.\.\.\fP See 'URLs as Dependencies' below .IP \(bu 2 -\fB*\fR Matches any version +\fB*\fP Matches any version .IP \(bu 2 -\fB""\fR (just an empty string) Same as \fB*\fR +\fB""\fP (just an empty string) Same as \fB*\fP .IP \(bu 2 -\fBversion1 \- version2\fR Same as \fB>=version1 <=version2\fR\|\. +\fBversion1 \- version2\fP Same as \fB>=version1 <=version2\fP\|\. .IP \(bu 2 -\fBrange1 || range2\fR Passes if either range1 or range2 are satisfied\. +\fBrange1 || range2\fP Passes if either range1 or range2 are satisfied\. .IP \(bu 2 -\fBgit\.\.\.\fR See 'Git URLs as Dependencies' below +\fBgit\.\.\.\fP See 'Git URLs as Dependencies' below .IP \(bu 2 -\fBuser/repo\fR See 'GitHub URLs' below +\fBuser/repo\fP See 'GitHub URLs' below .IP \(bu 2 -\fBtag\fR A specific version tagged and published as \fBtag\fR See npm help \fBnpm\-tag\fR +\fBtag\fP A specific version tagged and published as \fBtag\fP See npm help \fBnpm\-tag\fP .IP \(bu 2 -\fBpath/path/path\fR See Local Paths below +\fBpath/path/path\fP See Local Paths below .RE .P @@ -513,12 +513,12 @@ git+https://user@hostname/project/blah\.git#commit\-ish .fi .RE .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\|\. +The \fBcommit\-ish\fP can be any tag, sha, or branch which can be supplied as +an argument to \fBgit checkout\fP\|\. The default is \fBmaster\fP\|\. .SH GitHub URLs .P As of version 1\.1\.65, you can refer to GitHub urls as just "foo": -"user/foo\-project"\. Just as with git URLs, a \fBcommit\-ish\fR suffix can be +"user/foo\-project"\. Just as with git URLs, a \fBcommit\-ish\fP suffix can be included\. For example: .P .RS 2 @@ -536,7 +536,7 @@ included\. For example: .SH Local Paths .P As of version 2\.0\.0 you can provide a path to a local directory that contains a -package\. Local paths can be saved using \fBnpm install \-\-save\fR, using any of +package\. Local paths can be saved using \fBnpm install \-\-save\fP, using any of these forms: .P .RS 2 @@ -549,7 +549,7 @@ these forms: .RE .P in which case they will be normalized to a relative path and added to your -\fBpackage\.json\fR\|\. For example: +\fBpackage\.json\fP\|\. For example: .P .RS 2 .nf @@ -572,15 +572,15 @@ 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 map these additional items in a \fBdevDependencies\fR +In this case, it's best to map these additional items in a \fBdevDependencies\fP object\. .P -These things will be installed when doing \fBnpm link\fR or \fBnpm install\fR +These things will be installed when doing \fBnpm link\fP or \fBnpm install\fP from the root of a package, and can be managed like any other npm -configuration param\. See npm help 7 \fBnpm\-config\fR for more on the topic\. +configuration param\. See npm help 7 \fBnpm\-config\fP for more on the topic\. .P For build steps that are not platform\-specific, such as compiling -CoffeeScript or other languages to JavaScript, use the \fBprepublish\fR +CoffeeScript or other languages to JavaScript, use the \fBprepublish\fP script to do this, and make the required package a devDependency\. .P For example: @@ -601,14 +601,14 @@ For example: .fi .RE .P -The \fBprepublish\fR script will be run before publishing, so that users +The \fBprepublish\fP script will be run before publishing, so that users can consume the functionality without requiring them to compile it -themselves\. In dev mode (ie, locally running \fBnpm install\fR), it'll +themselves\. In dev mode (ie, locally running \fBnpm install\fP), it'll run this script as well, so that you can test it easily\. .SH peerDependencies .P In some cases, you want to express the compatibility of your package with a -host tool or library, while not necessarily doing a \fBrequire\fR of this host\. +host tool or library, while not necessarily doing a \fBrequire\fP of this host\. This is usually referred to as a \fIplugin\fR\|\. Notably, your module may be exposing a specific interface, expected and specified by the host documentation\. .P @@ -626,8 +626,8 @@ For example: .fi .RE .P -This ensures your package \fBtea\-latte\fR can be installed \fIalong\fR with the second -major version of the host package \fBtea\fR only\. \fBnpm install tea\-latte\fR could +This ensures your package \fBtea\-latte\fP can be installed \fIalong\fR with the second +major version of the host package \fBtea\fP only\. \fBnpm install tea\-latte\fP could possibly yield the following dependency graph: .P .RS 2 @@ -637,7 +637,7 @@ possibly yield the following dependency graph: .fi .RE .P -\fBNOTE: npm versions 1 and 2 will automatically install \fBpeerDependencies\fR if +\fBNOTE: npm versions 1 and 2 will automatically install \fBpeerDependencies\fP if they are not explicitly depended upon higher in the dependency tree\. In the next major version of npm (npm@3), this will no longer be the case\. You will receive a warning that the peerDependency is not installed instead\.\fR The @@ -650,19 +650,19 @@ possible, and not to lock it down to specific patch versions\. .P Assuming the host complies with semver \fIhttp://semver\.org/\fR, only changes in the host package's major version will break your plugin\. Thus, if you've worked -with every 1\.x version of the host package, use \fB"^1\.0"\fR or \fB"1\.x"\fR to express -this\. If you depend on features introduced in 1\.5\.2, use \fB">= 1\.5\.2 < 2"\fR\|\. +with every 1\.x version of the host package, use \fB"^1\.0"\fP or \fB"1\.x"\fP to express +this\. If you depend on features introduced in 1\.5\.2, use \fB">= 1\.5\.2 < 2"\fP\|\. .SH bundledDependencies .P 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\. +If this is spelled \fB"bundleDependencies"\fP, then that is also honorable\. .SH optionalDependencies .P 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 +found or fails to install, then you may put it in the \fBoptionalDependencies\fP object\. This is a map of package name to version or url, just like the -\fBdependencies\fR object\. The difference is that build failures do not cause +\fBdependencies\fP object\. The difference is that build failures do not cause installation to fail\. .P It is still your program's responsibility to handle the lack of the @@ -688,8 +688,8 @@ if (foo) { .fi .RE .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\. +Entries in \fBoptionalDependencies\fP will override entries of the same name in +\fBdependencies\fP, so it's usually best to only put in one place\. .SH engines .P You can specify the version of node that your stuff works on: @@ -716,16 +716,16 @@ are capable of properly installing your program\. For example: .fi .RE .P -Note that, unless the user has set the \fBengine\-strict\fR config flag, this +Note that, unless the user has set the \fBengine\-strict\fP config flag, this field is advisory only\. .SH engineStrict .P \fBNOTE: This feature is deprecated and will be removed in npm 3\.0\.0\.\fR .P 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 object, -then you can set \fB"engineStrict": true\fR in your package\.json file\. -This will override the user's \fBengine\-strict\fR config setting\. +versions of Node/npm other than those specified in the \fBengines\fP object, +then you can set \fB"engineStrict": true\fP in your package\.json file\. +This will override the user's \fBengine\-strict\fP config setting\. .P Please do not do this unless you are really very very sure\. If your engines object is something overly restrictive, you can quite easily and @@ -751,7 +751,7 @@ just prepend the blacklisted os with a '!': .fi .RE .P -The host operating system is determined by \fBprocess\.platform\fR +The host operating system is determined by \fBprocess\.platform\fP .P It is allowed to both blacklist, and whitelist, although there isn't any good reason to do this\. @@ -766,7 +766,7 @@ you can specify which ones\. .fi .RE .P -Like the \fBos\fR option, you can also blacklist architectures: +Like the \fBos\fP option, you can also blacklist architectures: .P .RS 2 .nf @@ -774,24 +774,24 @@ Like the \fBos\fR option, you can also blacklist architectures: .fi .RE .P -The host architecture is determined by \fBprocess\.arch\fR +The host architecture is determined by \fBprocess\.arch\fP .SH preferGlobal .P 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 +installed globally, then set this value to \fBtrue\fP 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 .P -If you set \fB"private": true\fR in your package\.json, then npm will refuse +If you set \fB"private": true\fP 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 dictionary described below to override the \fBregistry\fR config +\fBpublishConfig\fP dictionary described below to override the \fBregistry\fP config param at publish\-time\. .SH publishConfig .P @@ -803,25 +803,25 @@ the global public registry by default\. Any config values can be overridden, but of course only "tag" and "registry" probably matter for the purposes of publishing\. .P -See npm help 7 \fBnpm\-config\fR to see the list of config options that can be +See npm help 7 \fBnpm\-config\fP to see the list of config options that can be overridden\. .SH DEFAULT VALUES .P npm will default some values based on package contents\. .RS 0 .IP \(bu 2 -\fB"scripts": {"start": "node server\.js"}\fR -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\|\. +\fB"scripts": {"start": "node server\.js"}\fP +If there is a \fBserver\.js\fP file in the root of your package, then npm +will default the \fBstart\fP command to \fBnode server\.js\fP\|\. .IP \(bu 2 -\fB"scripts":{"preinstall": "node\-gyp rebuild"}\fR -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\. +\fB"scripts":{"preinstall": "node\-gyp rebuild"}\fP +If there is a \fBbinding\.gyp\fP file in the root of your package, npm will +default the \fBpreinstall\fP command to compile using node\-gyp\. .IP \(bu 2 -\fB"contributors": [\.\.\.]\fR -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 +\fB"contributors": [\.\.\.]\fP +If there is an \fBAUTHORS\fP file in the root of your package, npm will +treat each line as a \fBName <email> (url)\fP format, where email and url +are optional\. Lines which start with a \fB#\fP or are blank, will be ignored\. .RE diff --git a/deps/npm/man/man5/npmrc.5 b/deps/npm/man/man5/npmrc.5 index e867f54e40..246c4a39c4 100644 --- a/deps/npm/man/man5/npmrc.5 +++ b/deps/npm/man/man5/npmrc.5 @@ -4,9 +4,9 @@ .SH DESCRIPTION .P npm gets its config settings from the command line, environment -variables, and \fBnpmrc\fR files\. +variables, and \fBnpmrc\fP files\. .P -The \fBnpm config\fR command can be used to update and edit the contents +The \fBnpm config\fP command can be used to update and edit the contents of the user and global npmrc files\. .P For a list of available configuration options, see npm help 7 config\. @@ -25,9 +25,9 @@ npm builtin config file (/path/to/npm/npmrc) .RE .P -All npm config files are an ini\-formatted list of \fBkey = value\fR +All npm config files are an ini\-formatted list of \fBkey = value\fP parameters\. Environment variables can be replaced using -\fB${VARIABLE_NAME}\fR\|\. For example: +\fB${VARIABLE_NAME}\fP\|\. For example: .P .RS 2 .nf @@ -49,35 +49,38 @@ key[] = "second value" .fi .RE .P -\fBNOTE:\fR Because local (per\-project or per\-user) \fB\|\.npmrc\fR files can contain +\fBNOTE:\fR Because local (per\-project or per\-user) \fB\|\.npmrc\fP files can contain sensitive credentials, they must be readable and writable \fIonly\fR by your user -account (i\.e\. must have a mode of \fB0600\fR), otherwise they \fIwill be ignored by +account (i\.e\. must have a mode of \fB0600\fP), otherwise they \fIwill be ignored by npm!\fR .SS Per\-project config file .P -When working locally in a project, a \fB\|\.npmrc\fR file in the root of the -project (ie, a sibling of \fBnode_modules\fR and \fBpackage\.json\fR) will set +When working locally in a project, a \fB\|\.npmrc\fP file in the root of the +project (ie, a sibling of \fBnode_modules\fP and \fBpackage\.json\fP) will set config values specific to this project\. .P Note that this only applies to the root of the project that you're running npm in\. It has no effect when your module is published\. For example, you can't publish a module that forces itself to install globally, or in a different location\. +.P +Additionally, this file is not read in global mode, such as when running +\fBnpm install \-g\fP\|\. .SS Per\-user config file .P -\fB$HOME/\.npmrc\fR (or the \fBuserconfig\fR param, if set in the environment +\fB$HOME/\.npmrc\fP (or the \fBuserconfig\fP param, if set in the environment or on the command line) .SS Global config file .P -\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\. +\fB$PREFIX/etc/npmrc\fP (or the \fBglobalconfig\fP param, if set above): +This file is an ini\-file formatted list of \fBkey = value\fP parameters\. Environment variables can be replaced as above\. .SS Built\-in config file .P -\fBpath/to/npm/itself/npmrc\fR +\fBpath/to/npm/itself/npmrc\fP .P This is an unchangeable "builtin" configuration file that npm keeps -consistent across updates\. Set fields in here using the \fB\|\./configure\fR +consistent across updates\. Set fields in here using the \fB\|\./configure\fP script that comes with npm\. This is primarily for distribution maintainers to override default configs in a standard and consistent manner\. diff --git a/deps/npm/man/man5/package.json.5 b/deps/npm/man/man5/package.json.5 index 23280ede2c..d2c741984a 100644 --- a/deps/npm/man/man5/package.json.5 +++ b/deps/npm/man/man5/package.json.5 @@ -7,7 +7,7 @@ This document is all you need to know about what's required in your package\.jso 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 npm help 7 \fBnpm\-config\fR\|\. +settings described in npm help 7 \fBnpm\-config\fP\|\. .SH name .P The \fImost\fR important things in your package\.json are the name and version fields\. @@ -50,8 +50,8 @@ already, before you get too attached to it\. https://www\.npmjs\.com/ .RE .P -A name can be optionally prefixed by a scope, e\.g\. \fB@myorg/mypackage\fR\|\. See -npm help 7 \fBnpm\-scope\fR for more detail\. +A name can be optionally prefixed by a scope, e\.g\. \fB@myorg/mypackage\fP\|\. See +npm help 7 \fBnpm\-scope\fP for more detail\. .SH version .P The \fImost\fR important things in your package\.json are the name and version fields\. @@ -62,17 +62,17 @@ 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\.) +with npm as a dependency\. (\fBnpm install semver\fP to use it yourself\.) .P More on version numbers and ranges at npm help 7 semver\. .SH description .P Put a description in it\. It's a string\. This helps people discover your -package, as it's listed in \fBnpm search\fR\|\. +package, as it's listed in \fBnpm search\fP\|\. .SH keywords .P Put keywords in it\. It's an array of strings\. This helps people -discover your package as it's listed in \fBnpm search\fR\|\. +discover your package as it's listed in \fBnpm search\fP\|\. .SH homepage .P The url to the project homepage\. @@ -101,7 +101,7 @@ It should look like this: 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\. +If a url is provided, it will be used by the \fBnpm bugs\fP command\. .SH license .P You should specify a license for your package so that people know how they are @@ -138,7 +138,7 @@ you are using a custom license, use the following valid SPDX expression: .fi .RE .P -Then include a file named \fB<filename>\fR at the top level of the package\. +Then include a file named \fB<filename>\fP at the top level of the package\. .P Some old packages used license objects or a "licenses" property containing an array of license objects: @@ -185,7 +185,7 @@ unpublished package under any terms: .fi .RE .P -Consider also setting \fB"private": true\fR to prevent accidental publication\. +Consider also setting \fB"private": true\fP to prevent accidental publication\. .SH people fields: author, contributors .P The "author" is one person\. "contributors" is an array of people\. A "person" @@ -224,8 +224,8 @@ up by the files array\. The "\.npmignore" file works just like a .SH main .P 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\. +That is, if your package is named \fBfoo\fP, and a user installs it, and then does +\fBrequire("foo")\fP, 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 @@ -237,9 +237,9 @@ 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 +To use this, supply a \fBbin\fP 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 +\fBprefix/bin\fP for global installs, or \fB\|\./node_modules/\.bin/\fP for local installs\. .P For example, myapp could have this: @@ -250,8 +250,8 @@ For example, myapp could have this: .fi .RE .P -So, when you install myapp, it'll create a symlink from the \fBcli\.js\fR script to -\fB/usr/local/bin/myapp\fR\|\. +So, when you install myapp, it'll create a symlink from the \fBcli\.js\fP script to +\fB/usr/local/bin/myapp\fP\|\. .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: @@ -276,10 +276,10 @@ would be the same as this: .SH man .P Specify either a single file or an array of filenames to put in place for the -\fBman\fR program to find\. +\fBman\fP 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: +result from \fBman <pkgname>\fP, regardless of its actual filename\. For example: .P .RS 2 .nf @@ -292,7 +292,7 @@ result from \fBman <pkgname>\fR, regardless of its actual filename\. For exampl .fi .RE .P -would link the \fB\|\./man/doc\.1\fR file in such that it is the target for \fBman foo\fR +would link the \fB\|\./man/doc\.1\fP file in such that it is the target for \fBman foo\fP .P If the filename doesn't start with the package name, then it's prefixed\. So, this: @@ -308,9 +308,9 @@ So, this: .fi .RE .P -will create files to do \fBman foo\fR and \fBman foo\-bar\fR\|\. +will create files to do \fBman foo\fP and \fBman foo\-bar\fP\|\. .P -Man files must end with a number, and optionally a \fB\|\.gz\fR suffix if they are +Man files must end with a number, and optionally a \fB\|\.gz\fP suffix if they are compressed\. The number dictates which man section the file is installed into\. .P .RS 2 @@ -324,11 +324,11 @@ compressed\. The number dictates which man section the file is installed into\. .fi .RE .P -will create entries for \fBman foo\fR and \fBman 2 foo\fR +will create entries for \fBman foo\fP and \fBman 2 foo\fP .SH directories .P 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 +few ways that you can indicate the structure of your package using a \fBdirectories\fP object\. If you look at npm's package\.json \fIhttps://registry\.npmjs\.org/npm/latest\fR, you'll see that it has directories for doc, lib, and man\. .P @@ -339,13 +339,13 @@ 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 .P -If you specify a \fBbin\fR directory in \fBdirectories\.bin\fR, all the files in +If you specify a \fBbin\fP directory in \fBdirectories\.bin\fP, all the files in that folder will be added\. .P -Because of the way the \fBbin\fR directive works, specifying both a -\fBbin\fR path and setting \fBdirectories\.bin\fR is an error\. If you want to -specify individual files, use \fBbin\fR, and for all the files in an -existing \fBbin\fR directory, use \fBdirectories\.bin\fR\|\. +Because of the way the \fBbin\fP directive works, specifying both a +\fBbin\fP path and setting \fBdirectories\.bin\fP is an error\. If you want to +specify individual files, use \fBbin\fP, and for all the files in an +existing \fBbin\fP directory, use \fBdirectories\.bin\fP\|\. .SS directories\.man .P A folder that is full of man pages\. Sugar to generate a "man" array by @@ -360,7 +360,7 @@ Put example scripts in here\. Someday, it might be exposed in some clever way\. .SH repository .P 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 +want to contribute\. If the git repo is on GitHub, then the \fBnpm docs\fP command will be able to find you\. .P Do it like this: @@ -384,7 +384,7 @@ directly to a VCS program without any modification\. It should not be a url to html project page that you put in your browser\. It's for computers\. .P For GitHub, GitHub gist, Bitbucket, or GitLab repositories you can use the same -shortcut syntax you use for \fBnpm install\fR: +shortcut syntax you use for \fBnpm install\fP: .P .RS 2 .nf @@ -403,7 +403,7 @@ The "scripts" property is a dictionary containing 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 npm help 7 \fBnpm\-scripts\fR to find out more about writing package scripts\. +See npm help 7 \fBnpm\-scripts\fP to find out more about writing package scripts\. .SH config .P A "config" object can be used to set configuration parameters used in package @@ -418,10 +418,10 @@ following: .RE .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\|\. +\fBnpm_package_config_port\fP environment variable, then the user could +override that by doing \fBnpm config set foo:port 8001\fP\|\. .P -See npm help 7 \fBnpm\-config\fR and npm help 7 \fBnpm\-scripts\fR for more on package +See npm help 7 \fBnpm\-config\fP and npm help 7 \fBnpm\-scripts\fP for more on package configs\. .SH dependencies .P @@ -431,44 +431,44 @@ space\-separated descriptors\. Dependencies can also be identified with a tarball or git URL\. .P \fBPlease do not put test harnesses or transpilers in your -\fBdependencies\fR object\.\fR See \fBdevDependencies\fR, below\. +\fBdependencies\fP object\.\fR See \fBdevDependencies\fP, below\. .P See npm help 7 semver for more details about specifying version ranges\. .RS 0 .IP \(bu 2 -\fBversion\fR Must match \fBversion\fR exactly +\fBversion\fP Must match \fBversion\fP exactly .IP \(bu 2 -\fB>version\fR Must be greater than \fBversion\fR +\fB>version\fP Must be greater than \fBversion\fP .IP \(bu 2 -\fB>=version\fR etc +\fB>=version\fP etc .IP \(bu 2 -\fB<version\fR +\fB<version\fP .IP \(bu 2 -\fB<=version\fR +\fB<=version\fP .IP \(bu 2 -\fB~version\fR "Approximately equivalent to version" See npm help 7 semver +\fB~version\fP "Approximately equivalent to version" See npm help 7 semver .IP \(bu 2 -\fB^version\fR "Compatible with version" See npm help 7 semver +\fB^version\fP "Compatible with version" See npm help 7 semver .IP \(bu 2 -\fB1\.2\.x\fR 1\.2\.0, 1\.2\.1, etc\., but not 1\.3\.0 +\fB1\.2\.x\fP 1\.2\.0, 1\.2\.1, etc\., but not 1\.3\.0 .IP \(bu 2 -\fBhttp://\.\.\.\fR See 'URLs as Dependencies' below +\fBhttp://\.\.\.\fP See 'URLs as Dependencies' below .IP \(bu 2 -\fB*\fR Matches any version +\fB*\fP Matches any version .IP \(bu 2 -\fB""\fR (just an empty string) Same as \fB*\fR +\fB""\fP (just an empty string) Same as \fB*\fP .IP \(bu 2 -\fBversion1 \- version2\fR Same as \fB>=version1 <=version2\fR\|\. +\fBversion1 \- version2\fP Same as \fB>=version1 <=version2\fP\|\. .IP \(bu 2 -\fBrange1 || range2\fR Passes if either range1 or range2 are satisfied\. +\fBrange1 || range2\fP Passes if either range1 or range2 are satisfied\. .IP \(bu 2 -\fBgit\.\.\.\fR See 'Git URLs as Dependencies' below +\fBgit\.\.\.\fP See 'Git URLs as Dependencies' below .IP \(bu 2 -\fBuser/repo\fR See 'GitHub URLs' below +\fBuser/repo\fP See 'GitHub URLs' below .IP \(bu 2 -\fBtag\fR A specific version tagged and published as \fBtag\fR See npm help \fBnpm\-tag\fR +\fBtag\fP A specific version tagged and published as \fBtag\fP See npm help \fBnpm\-tag\fP .IP \(bu 2 -\fBpath/path/path\fR See Local Paths below +\fBpath/path/path\fP See Local Paths below .RE .P @@ -513,12 +513,12 @@ git+https://user@hostname/project/blah\.git#commit\-ish .fi .RE .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\|\. +The \fBcommit\-ish\fP can be any tag, sha, or branch which can be supplied as +an argument to \fBgit checkout\fP\|\. The default is \fBmaster\fP\|\. .SH GitHub URLs .P As of version 1\.1\.65, you can refer to GitHub urls as just "foo": -"user/foo\-project"\. Just as with git URLs, a \fBcommit\-ish\fR suffix can be +"user/foo\-project"\. Just as with git URLs, a \fBcommit\-ish\fP suffix can be included\. For example: .P .RS 2 @@ -536,7 +536,7 @@ included\. For example: .SH Local Paths .P As of version 2\.0\.0 you can provide a path to a local directory that contains a -package\. Local paths can be saved using \fBnpm install \-\-save\fR, using any of +package\. Local paths can be saved using \fBnpm install \-\-save\fP, using any of these forms: .P .RS 2 @@ -549,7 +549,7 @@ these forms: .RE .P in which case they will be normalized to a relative path and added to your -\fBpackage\.json\fR\|\. For example: +\fBpackage\.json\fP\|\. For example: .P .RS 2 .nf @@ -572,15 +572,15 @@ 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 map these additional items in a \fBdevDependencies\fR +In this case, it's best to map these additional items in a \fBdevDependencies\fP object\. .P -These things will be installed when doing \fBnpm link\fR or \fBnpm install\fR +These things will be installed when doing \fBnpm link\fP or \fBnpm install\fP from the root of a package, and can be managed like any other npm -configuration param\. See npm help 7 \fBnpm\-config\fR for more on the topic\. +configuration param\. See npm help 7 \fBnpm\-config\fP for more on the topic\. .P For build steps that are not platform\-specific, such as compiling -CoffeeScript or other languages to JavaScript, use the \fBprepublish\fR +CoffeeScript or other languages to JavaScript, use the \fBprepublish\fP script to do this, and make the required package a devDependency\. .P For example: @@ -601,14 +601,14 @@ For example: .fi .RE .P -The \fBprepublish\fR script will be run before publishing, so that users +The \fBprepublish\fP script will be run before publishing, so that users can consume the functionality without requiring them to compile it -themselves\. In dev mode (ie, locally running \fBnpm install\fR), it'll +themselves\. In dev mode (ie, locally running \fBnpm install\fP), it'll run this script as well, so that you can test it easily\. .SH peerDependencies .P In some cases, you want to express the compatibility of your package with a -host tool or library, while not necessarily doing a \fBrequire\fR of this host\. +host tool or library, while not necessarily doing a \fBrequire\fP of this host\. This is usually referred to as a \fIplugin\fR\|\. Notably, your module may be exposing a specific interface, expected and specified by the host documentation\. .P @@ -626,8 +626,8 @@ For example: .fi .RE .P -This ensures your package \fBtea\-latte\fR can be installed \fIalong\fR with the second -major version of the host package \fBtea\fR only\. \fBnpm install tea\-latte\fR could +This ensures your package \fBtea\-latte\fP can be installed \fIalong\fR with the second +major version of the host package \fBtea\fP only\. \fBnpm install tea\-latte\fP could possibly yield the following dependency graph: .P .RS 2 @@ -637,7 +637,7 @@ possibly yield the following dependency graph: .fi .RE .P -\fBNOTE: npm versions 1 and 2 will automatically install \fBpeerDependencies\fR if +\fBNOTE: npm versions 1 and 2 will automatically install \fBpeerDependencies\fP if they are not explicitly depended upon higher in the dependency tree\. In the next major version of npm (npm@3), this will no longer be the case\. You will receive a warning that the peerDependency is not installed instead\.\fR The @@ -650,19 +650,19 @@ possible, and not to lock it down to specific patch versions\. .P Assuming the host complies with semver \fIhttp://semver\.org/\fR, only changes in the host package's major version will break your plugin\. Thus, if you've worked -with every 1\.x version of the host package, use \fB"^1\.0"\fR or \fB"1\.x"\fR to express -this\. If you depend on features introduced in 1\.5\.2, use \fB">= 1\.5\.2 < 2"\fR\|\. +with every 1\.x version of the host package, use \fB"^1\.0"\fP or \fB"1\.x"\fP to express +this\. If you depend on features introduced in 1\.5\.2, use \fB">= 1\.5\.2 < 2"\fP\|\. .SH bundledDependencies .P 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\. +If this is spelled \fB"bundleDependencies"\fP, then that is also honorable\. .SH optionalDependencies .P 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 +found or fails to install, then you may put it in the \fBoptionalDependencies\fP object\. This is a map of package name to version or url, just like the -\fBdependencies\fR object\. The difference is that build failures do not cause +\fBdependencies\fP object\. The difference is that build failures do not cause installation to fail\. .P It is still your program's responsibility to handle the lack of the @@ -688,8 +688,8 @@ if (foo) { .fi .RE .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\. +Entries in \fBoptionalDependencies\fP will override entries of the same name in +\fBdependencies\fP, so it's usually best to only put in one place\. .SH engines .P You can specify the version of node that your stuff works on: @@ -716,16 +716,16 @@ are capable of properly installing your program\. For example: .fi .RE .P -Note that, unless the user has set the \fBengine\-strict\fR config flag, this +Note that, unless the user has set the \fBengine\-strict\fP config flag, this field is advisory only\. .SH engineStrict .P \fBNOTE: This feature is deprecated and will be removed in npm 3\.0\.0\.\fR .P 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 object, -then you can set \fB"engineStrict": true\fR in your package\.json file\. -This will override the user's \fBengine\-strict\fR config setting\. +versions of Node/npm other than those specified in the \fBengines\fP object, +then you can set \fB"engineStrict": true\fP in your package\.json file\. +This will override the user's \fBengine\-strict\fP config setting\. .P Please do not do this unless you are really very very sure\. If your engines object is something overly restrictive, you can quite easily and @@ -751,7 +751,7 @@ just prepend the blacklisted os with a '!': .fi .RE .P -The host operating system is determined by \fBprocess\.platform\fR +The host operating system is determined by \fBprocess\.platform\fP .P It is allowed to both blacklist, and whitelist, although there isn't any good reason to do this\. @@ -766,7 +766,7 @@ you can specify which ones\. .fi .RE .P -Like the \fBos\fR option, you can also blacklist architectures: +Like the \fBos\fP option, you can also blacklist architectures: .P .RS 2 .nf @@ -774,24 +774,24 @@ Like the \fBos\fR option, you can also blacklist architectures: .fi .RE .P -The host architecture is determined by \fBprocess\.arch\fR +The host architecture is determined by \fBprocess\.arch\fP .SH preferGlobal .P 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 +installed globally, then set this value to \fBtrue\fP 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 .P -If you set \fB"private": true\fR in your package\.json, then npm will refuse +If you set \fB"private": true\fP 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 dictionary described below to override the \fBregistry\fR config +\fBpublishConfig\fP dictionary described below to override the \fBregistry\fP config param at publish\-time\. .SH publishConfig .P @@ -803,25 +803,25 @@ the global public registry by default\. Any config values can be overridden, but of course only "tag" and "registry" probably matter for the purposes of publishing\. .P -See npm help 7 \fBnpm\-config\fR to see the list of config options that can be +See npm help 7 \fBnpm\-config\fP to see the list of config options that can be overridden\. .SH DEFAULT VALUES .P npm will default some values based on package contents\. .RS 0 .IP \(bu 2 -\fB"scripts": {"start": "node server\.js"}\fR -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\|\. +\fB"scripts": {"start": "node server\.js"}\fP +If there is a \fBserver\.js\fP file in the root of your package, then npm +will default the \fBstart\fP command to \fBnode server\.js\fP\|\. .IP \(bu 2 -\fB"scripts":{"preinstall": "node\-gyp rebuild"}\fR -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\. +\fB"scripts":{"preinstall": "node\-gyp rebuild"}\fP +If there is a \fBbinding\.gyp\fP file in the root of your package, npm will +default the \fBpreinstall\fP command to compile using node\-gyp\. .IP \(bu 2 -\fB"contributors": [\.\.\.]\fR -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 +\fB"contributors": [\.\.\.]\fP +If there is an \fBAUTHORS\fP file in the root of your package, npm will +treat each line as a \fBName <email> (url)\fP format, where email and url +are optional\. Lines which start with a \fB#\fP or are blank, will be ignored\. .RE diff --git a/deps/npm/man/man7/npm-coding-style.7 b/deps/npm/man/man7/npm-coding-style.7 index d2ef01785a..b7c629c3fb 100644 --- a/deps/npm/man/man7/npm-coding-style.7 +++ b/deps/npm/man/man7/npm-coding-style.7 @@ -71,14 +71,14 @@ while (foo) { Don't use them except in four situations: .RS 0 .IP \(bu 2 -\fBfor (;;)\fR loops\. They're actually required\. +\fBfor (;;)\fP loops\. They're actually required\. .IP \(bu 2 -null loops like: \fBwhile (something) ;\fR (But you'd better have a good +null loops like: \fBwhile (something) ;\fP (But you'd better have a good reason for doing that\.) .IP \(bu 2 -\fBcase "foo": doSomething(); break\fR +\fBcase "foo": doSomething(); break\fP .IP \(bu 2 -In front of a leading \fB(\fR or \fB[\fR at the start of the line\. +In front of a leading \fB(\fP or \fB[\fP at the start of the line\. This prevents the expression from being interpreted as a function call or property access, respectively\. @@ -101,7 +101,7 @@ for (var i = 0; i < 10; i ++) { .fi .RE .P -Note that starting lines with \fB\-\fR and \fB+\fR also should be prefixed +Note that starting lines with \fB\-\fP and \fB+\fP also should be prefixed with a semicolon, but this is much less common\. .SH Comma First .P @@ -161,20 +161,20 @@ 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 npm help 7 \fBnpm\-config\fR and search for +Use appropriate log levels\. See npm help 7 \fBnpm\-config\fP and search for "loglevel"\. .SH Case, naming, etc\. .P -Use \fBlowerCamelCase\fR for multiword identifiers when they refer to objects, +Use \fBlowerCamelCase\fP for multiword identifiers when they refer to objects, functions, methods, properties, or anything not specified in this section\. .P -Use \fBUpperCamelCase\fR for class names (things that you'd pass to "new")\. +Use \fBUpperCamelCase\fP for class names (things that you'd pass to "new")\. .P -Use \fBall\-lower\-hyphen\-css\-case\fR for multiword filenames and config keys\. +Use \fBall\-lower\-hyphen\-css\-case\fP 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 +Use \fBCAPS_SNAKE_CASE\fP for constants, things that should never change and are rarely used\. .P Use a single uppercase letter for function names where the function @@ -182,12 +182,12 @@ 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 .P -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\. +Boolean variables and functions should always be either \fBtrue\fP or +\fBfalse\fP\|\. 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\|\. +When something is intentionally missing or removed, set it to \fBnull\fP\|\. .P -Don't set things to \fBundefined\fR\|\. Reserve that value to mean "not yet +Don't set things to \fBundefined\fP\|\. Reserve that value to mean "not yet set to anything\." .P Boolean objects are verboten\. diff --git a/deps/npm/man/man7/npm-config.7 b/deps/npm/man/man7/npm-config.7 index ce56bc6944..8a446f1d39 100644 --- a/deps/npm/man/man7/npm-config.7 +++ b/deps/npm/man/man7/npm-config.7 @@ -6,18 +6,18 @@ npm gets its configuration values from the following sources, sorted by priority: .SS Command Line Flags .P -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\|\. +Putting \fB\-\-foo bar\fP on the command line sets the \fBfoo\fP configuration +parameter to \fB"bar"\fP\|\. A \fB\-\-\fP argument tells the cli parser to stop +reading flags\. A \fB\-\-flag\fP parameter that is at the \fIend\fR of the +command will be given the value of \fBtrue\fP\|\. .SS Environment Variables .P -Any environment variables that start with \fBnpm_config_\fR will be +Any environment variables that start with \fBnpm_config_\fP 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 +\fBnpm_config_foo=bar\fP in your environment will set the \fBfoo\fP +configuration parameter to \fBbar\fP\|\. Any environment configurations that +are not given a value will be given the value of \fBtrue\fP\|\. Config +values are case\-insensitive, so \fBNPM_CONFIG_FOO=bar\fP will work the same\. .SS npmrc Files .P @@ -44,51 +44,51 @@ defaults if nothing else is specified\. The following shorthands are parsed on the command\-line: .RS 0 .IP \(bu 2 -\fB\-v\fR: \fB\-\-version\fR +\fB\-v\fP: \fB\-\-version\fP .IP \(bu 2 -\fB\-h\fR, \fB\-?\fR, \fB\-\-help\fR, \fB\-H\fR: \fB\-\-usage\fR +\fB\-h\fP, \fB\-?\fP, \fB\-\-help\fP, \fB\-H\fP: \fB\-\-usage\fP .IP \(bu 2 -\fB\-s\fR, \fB\-\-silent\fR: \fB\-\-loglevel silent\fR +\fB\-s\fP, \fB\-\-silent\fP: \fB\-\-loglevel silent\fP .IP \(bu 2 -\fB\-q\fR, \fB\-\-quiet\fR: \fB\-\-loglevel warn\fR +\fB\-q\fP, \fB\-\-quiet\fP: \fB\-\-loglevel warn\fP .IP \(bu 2 -\fB\-d\fR: \fB\-\-loglevel info\fR +\fB\-d\fP: \fB\-\-loglevel info\fP .IP \(bu 2 -\fB\-dd\fR, \fB\-\-verbose\fR: \fB\-\-loglevel verbose\fR +\fB\-dd\fP, \fB\-\-verbose\fP: \fB\-\-loglevel verbose\fP .IP \(bu 2 -\fB\-ddd\fR: \fB\-\-loglevel silly\fR +\fB\-ddd\fP: \fB\-\-loglevel silly\fP .IP \(bu 2 -\fB\-g\fR: \fB\-\-global\fR +\fB\-g\fP: \fB\-\-global\fP .IP \(bu 2 -\fB\-C\fR: \fB\-\-prefix\fR +\fB\-C\fP: \fB\-\-prefix\fP .IP \(bu 2 -\fB\-l\fR: \fB\-\-long\fR +\fB\-l\fP: \fB\-\-long\fP .IP \(bu 2 -\fB\-m\fR: \fB\-\-message\fR +\fB\-m\fP: \fB\-\-message\fP .IP \(bu 2 -\fB\-p\fR, \fB\-\-porcelain\fR: \fB\-\-parseable\fR +\fB\-p\fP, \fB\-\-porcelain\fP: \fB\-\-parseable\fP .IP \(bu 2 -\fB\-reg\fR: \fB\-\-registry\fR +\fB\-reg\fP: \fB\-\-registry\fP .IP \(bu 2 -\fB\-f\fR: \fB\-\-force\fR +\fB\-f\fP: \fB\-\-force\fP .IP \(bu 2 -\fB\-desc\fR: \fB\-\-description\fR +\fB\-desc\fP: \fB\-\-description\fP .IP \(bu 2 -\fB\-S\fR: \fB\-\-save\fR +\fB\-S\fP: \fB\-\-save\fP .IP \(bu 2 -\fB\-D\fR: \fB\-\-save\-dev\fR +\fB\-D\fP: \fB\-\-save\-dev\fP .IP \(bu 2 -\fB\-O\fR: \fB\-\-save\-optional\fR +\fB\-O\fP: \fB\-\-save\-optional\fP .IP \(bu 2 -\fB\-B\fR: \fB\-\-save\-bundle\fR +\fB\-B\fP: \fB\-\-save\-bundle\fP .IP \(bu 2 -\fB\-E\fR: \fB\-\-save\-exact\fR +\fB\-E\fP: \fB\-\-save\-exact\fP .IP \(bu 2 -\fB\-y\fR: \fB\-\-yes\fR +\fB\-y\fP: \fB\-\-yes\fP .IP \(bu 2 -\fB\-n\fR: \fB\-\-yes false\fR +\fB\-n\fP: \fB\-\-yes false\fP .IP \(bu 2 -\fBll\fR and \fBla\fR commands: \fBls \-\-long\fR +\fBll\fP and \fBla\fP commands: \fBls \-\-long\fP .RE .P @@ -118,9 +118,9 @@ npm ls \-\-global \-\-parseable \-\-long \-\-loglevel info .RE .SH Per\-Package Config Settings .P -When running scripts (see npm help 7 \fBnpm\-scripts\fR) the package\.json "config" +When running scripts (see npm help 7 \fBnpm\-scripts\fP) 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 +\fB<name>[@<version>]:<key>\fP\|\. For example, if the package\.json has this: .P .RS 2 @@ -152,16 +152,16 @@ See npm help 5 package\.json for more information\. .SS access .RS 0 .IP \(bu 2 -Default: \fBrestricted\fR +Default: \fBrestricted\fP .IP \(bu 2 Type: Access .RE .P -When publishing scoped packages, the access level defaults to \fBrestricted\fR\|\. If +When publishing scoped packages, the access level defaults to \fBrestricted\fP\|\. If you want your scoped package to be publicly viewable (and installable) set -\fB\-\-access=public\fR\|\. The only valid values for \fBaccess\fR are \fBpublic\fR and -\fBrestricted\fR\|\. Unscoped packages \fIalways\fR have an access level of \fBpublic\fR\|\. +\fB\-\-access=public\fP\|\. The only valid values for \fBaccess\fP are \fBpublic\fP and +\fBrestricted\fP\|\. Unscoped packages \fIalways\fR have an access level of \fBpublic\fP\|\. .SS always\-auth .RS 0 .IP \(bu 2 @@ -172,17 +172,17 @@ Type: Boolean .RE .P Force npm to always require authentication when accessing the registry, -even for \fBGET\fR requests\. +even for \fBGET\fP requests\. .SS bin\-links .RS 0 .IP \(bu 2 -Default: \fBtrue\fR +Default: \fBtrue\fP .IP \(bu 2 Type: Boolean .RE .P -Tells npm to create symlinks (or \fB\|\.cmd\fR shims on Windows) for package +Tells npm to create symlinks (or \fB\|\.cmd\fP shims on Windows) for package executables\. .P Set to false to have it not do this\. This can be used to work around @@ -191,13 +191,13 @@ ostensibly Unix systems\. .SS browser .RS 0 .IP \(bu 2 -Default: OS X: \fB"open"\fR, Windows: \fB"start"\fR, Others: \fB"xdg\-open"\fR +Default: OS X: \fB"open"\fP, Windows: \fB"start"\fP, Others: \fB"xdg\-open"\fP .IP \(bu 2 Type: String .RE .P -The browser that is called by the \fBnpm docs\fR command to open websites\. +The browser that is called by the \fBnpm docs\fP command to open websites\. .SS ca .RS 0 .IP \(bu 2 @@ -217,7 +217,7 @@ ca="\-\-\-\-\-BEGIN CERTIFICATE\-\-\-\-\-\\nXXXX\\nXXXX\\n\-\-\-\-\-END CERTIFIC .fi .RE .P -Set to \fBnull\fR to only allow "known" registrars, or to a specific CA cert +Set to \fBnull\fP to only allow "known" registrars, or to a specific CA cert to trust only that specific signing authority\. .P Multiple CAs can be trusted by specifying an array of certificates: @@ -229,29 +229,29 @@ ca[]="\.\.\." .fi .RE .P -See also the \fBstrict\-ssl\fR config\. +See also the \fBstrict\-ssl\fP config\. .SS cafile .RS 0 .IP \(bu 2 -Default: \fBnull\fR +Default: \fBnull\fP .IP \(bu 2 Type: path .RE .P A path to a file containing one or multiple Certificate Authority signing -certificates\. Similar to the \fBca\fR setting, but allows for multiple CA's, as +certificates\. Similar to the \fBca\fP setting, but allows for multiple CA's, as well as for the CA information to be stored in a file on disk\. .SS cache .RS 0 .IP \(bu 2 -Default: Windows: \fB%AppData%\\npm\-cache\fR, Posix: \fB~/\.npm\fR +Default: Windows: \fB%AppData%\\npm\-cache\fP, Posix: \fB~/\.npm\fP .IP \(bu 2 Type: path .RE .P -The location of npm's cache directory\. See npm help \fBnpm\-cache\fR +The location of npm's cache directory\. See npm help \fBnpm\-cache\fP .SS cache\-lock\-stale .RS 0 .IP \(bu 2 @@ -294,7 +294,7 @@ Type: Number 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 +Note that no purging is done unless the \fBnpm cache clean\fP command is explicitly used, and that only GET requests use the cache\. .SS cache\-min .RS 0 @@ -308,12 +308,12 @@ Type: Number 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 +Note that no purging is done unless the \fBnpm cache clean\fP command is explicitly used, and that only GET requests use the cache\. .SS cert .RS 0 .IP \(bu 2 -Default: \fBnull\fR +Default: \fBnull\fP .IP \(bu 2 Type: String @@ -325,11 +325,11 @@ A client certificate to pass when accessing the registry\. .IP \(bu 2 Default: true on Posix, false on Windows .IP \(bu 2 -Type: Boolean or \fB"always"\fR +Type: Boolean or \fB"always"\fP .RE .P -If false, never shows colors\. If \fB"always"\fR then always shows colors\. +If false, never shows colors\. If \fB"always"\fP then always shows colors\. If true, then only prints color codes for tty file descriptors\. .SS depth .RS 0 @@ -340,13 +340,13 @@ Type: Number .RE .P -The depth to go when recursing directories for \fBnpm ls\fR, -\fBnpm cache ls\fR, and \fBnpm outdated\fR\|\. +The depth to go when recursing directories for \fBnpm ls\fP, +\fBnpm cache ls\fP, and \fBnpm outdated\fP\|\. .P -For \fBnpm outdated\fR, a setting of \fBInfinity\fR will be treated as \fB0\fR +For \fBnpm outdated\fP, a setting of \fBInfinity\fP will be treated as \fB0\fP since that gives more useful information\. To show the outdated status of all packages and dependents, use a large integer value, -e\.g\., \fBnpm outdated \-\-depth 9999\fR +e\.g\., \fBnpm outdated \-\-depth 9999\fP .SS description .RS 0 .IP \(bu 2 @@ -356,7 +356,7 @@ Type: Boolean .RE .P -Show the description in \fBnpm search\fR +Show the description in \fBnpm search\fP .SS dev .RS 0 .IP \(bu 2 @@ -366,21 +366,21 @@ Type: Boolean .RE .P -Install \fBdev\-dependencies\fR along with packages\. +Install \fBdev\-dependencies\fP along with packages\. .P -Note that \fBdev\-dependencies\fR are also installed if the \fBnpat\fR flag is +Note that \fBdev\-dependencies\fP are also installed if the \fBnpat\fP flag is set\. .SS editor .RS 0 .IP \(bu 2 -Default: \fBEDITOR\fR environment variable if set, or \fB"vi"\fR on Posix, -or \fB"notepad"\fR on Windows\. +Default: \fBEDITOR\fP environment variable if set, or \fB"vi"\fP on Posix, +or \fB"notepad"\fP on Windows\. .IP \(bu 2 Type: path .RE .P -The command to run for \fBnpm edit\fR or \fBnpm config edit\fR\|\. +The command to run for \fBnpm edit\fP or \fBnpm config edit\fP\|\. .SS engine\-strict .RS 0 .IP \(bu 2 @@ -423,7 +423,7 @@ Type: Number .RE .P -The "retries" config for the \fBretry\fR module to use when fetching +The "retries" config for the \fBretry\fP module to use when fetching packages from the registry\. .SS fetch\-retry\-factor .RS 0 @@ -434,7 +434,7 @@ Type: Number .RE .P -The "factor" config for the \fBretry\fR module to use when fetching +The "factor" config for the \fBretry\fP module to use when fetching packages\. .SS fetch\-retry\-mintimeout .RS 0 @@ -445,7 +445,7 @@ Type: Number .RE .P -The "minTimeout" config for the \fBretry\fR module to use when fetching +The "minTimeout" config for the \fBretry\fP module to use when fetching packages\. .SS fetch\-retry\-maxtimeout .RS 0 @@ -456,30 +456,30 @@ Type: Number .RE .P -The "maxTimeout" config for the \fBretry\fR module to use when fetching +The "maxTimeout" config for the \fBretry\fP module to use when fetching packages\. .SS git .RS 0 .IP \(bu 2 -Default: \fB"git"\fR +Default: \fB"git"\fP .IP \(bu 2 Type: String .RE .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 +computer, but is not in the \fBPATH\fP, then set this to the full path to the git binary\. .SS git\-tag\-version .RS 0 .IP \(bu 2 -Default: \fBtrue\fR +Default: \fBtrue\fP .IP \(bu 2 Type: Boolean .RE .P -Tag the commit when using the \fBnpm version\fR command\. +Tag the commit when using the \fBnpm version\fP command\. .SS global .RS 0 .IP \(bu 2 @@ -490,16 +490,16 @@ Type: Boolean .RE .P Operates in "global" mode, so that packages are installed into the -\fBprefix\fR folder instead of the current working directory\. See -npm help 5 \fBnpm\-folders\fR for more on the differences in behavior\. +\fBprefix\fP folder instead of the current working directory\. See +npm help 5 \fBnpm\-folders\fP for more on the differences in behavior\. .RS 0 .IP \(bu 2 -packages are installed into the \fB{prefix}/lib/node_modules\fR folder, instead of the +packages are installed into the \fB{prefix}/lib/node_modules\fP folder, instead of the current working directory\. .IP \(bu 2 -bin files are linked to \fB{prefix}/bin\fR +bin files are linked to \fB{prefix}/bin\fP .IP \(bu 2 -man pages are linked to \fB{prefix}/share/man\fR +man pages are linked to \fB{prefix}/share/man\fP .RE .SS globalconfig @@ -526,7 +526,7 @@ user\. .SS heading .RS 0 .IP \(bu 2 -Default: \fB"npm"\fR +Default: \fB"npm"\fP .IP \(bu 2 Type: String @@ -542,9 +542,9 @@ Type: url .RE .P -A proxy to use for outgoing https requests\. If the \fBHTTPS_PROXY\fR or -\fBhttps_proxy\fR or \fBHTTP_PROXY\fR or \fBhttp_proxy\fR environment variables are set, -proxy settings will be honored by the underlying \fBrequest\fR library\. +A proxy to use for outgoing https requests\. If the \fBHTTPS_PROXY\fP or +\fBhttps_proxy\fP or \fBHTTP_PROXY\fP or \fBhttp_proxy\fP environment variables are set, +proxy settings will be honored by the underlying \fBrequest\fP library\. .SS if\-present .RS 0 .IP \(bu 2 @@ -554,8 +554,8 @@ Type: Boolean .RE .P -If true, npm will not exit with an error code when \fBrun\-script\fR is invoked for -a script that isn't defined in the \fBscripts\fR section of \fBpackage\.json\fR\|\. This +If true, npm will not exit with an error code when \fBrun\-script\fP is invoked for +a script that isn't defined in the \fBscripts\fP section of \fBpackage\.json\fP\|\. This option can be used when it's desirable to optionally run a script when it's present and fail if the script fails\. This is useful, for example, when running scripts that may only apply for some builds in an otherwise generic CI setup\. @@ -578,7 +578,7 @@ Type: path .RE .P -A module that will be loaded by the \fBnpm init\fR command\. See the +A module that will be loaded by the \fBnpm init\fP 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\. @@ -591,7 +591,7 @@ Type: String .RE .P -The value \fBnpm init\fR should use by default for the package author's name\. +The value \fBnpm init\fP should use by default for the package author's name\. .SS init\-author\-email .RS 0 .IP \(bu 2 @@ -601,7 +601,7 @@ Type: String .RE .P -The value \fBnpm init\fR should use by default for the package author's email\. +The value \fBnpm init\fP should use by default for the package author's email\. .SS init\-author\-url .RS 0 .IP \(bu 2 @@ -611,7 +611,7 @@ Type: String .RE .P -The value \fBnpm init\fR should use by default for the package author's homepage\. +The value \fBnpm init\fP should use by default for the package author's homepage\. .SS init\-license .RS 0 .IP \(bu 2 @@ -621,7 +621,7 @@ Type: String .RE .P -The value \fBnpm init\fR should use by default for the package license\. +The value \fBnpm init\fP should use by default for the package license\. .SS init\-version .RS 0 .IP \(bu 2 @@ -631,7 +631,7 @@ Type: semver .RE .P -The value that \fBnpm init\fR should use by default for the package +The value that \fBnpm init\fP should use by default for the package version number, if not already set in package\.json\. .SS json .RS 0 @@ -646,11 +646,11 @@ 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\. +change\. Only the output from \fBnpm ls \-\-json\fP is currently valid\. .SS key .RS 0 .IP \(bu 2 -Default: \fBnull\fR +Default: \fBnull\fP .IP \(bu 2 Type: String @@ -703,7 +703,7 @@ Values: "silent", "error", "warn", "http", "info", "verbose", "silly" .RE .P What level of logs to report\. On failure, \fIall\fR logs are written to -\fBnpm\-debug\.log\fR in the current working directory\. +\fBnpm\-debug\.log\fP in the current working directory\. .P Any logs of a higher level than the setting are shown\. The default is "warn", which shows warn and error output\. @@ -723,7 +723,7 @@ 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 +If the \fBcolor\fP config is set to true, then this stream will receive colored output if it is a TTY\. .SS long .RS 0 @@ -734,7 +734,7 @@ Type: Boolean .RE .P -Show extended information in \fBnpm ls\fR and \fBnpm search\fR\|\. +Show extended information in \fBnpm ls\fP and \fBnpm search\fP\|\. .SS message .RS 0 .IP \(bu 2 @@ -744,7 +744,7 @@ Type: String .RE .P -Commit message which is used by \fBnpm version\fR when creating version commit\. +Commit message which is used by \fBnpm version\fP when creating version commit\. .P Any "%s" in the message will be replaced with the version number\. .SS node\-version @@ -756,7 +756,7 @@ Type: semver or false .RE .P -The node version to use when checking a package's \fBengines\fR map\. +The node version to use when checking a package's \fBengines\fP map\. .SS npat .RS 0 .IP \(bu 2 @@ -776,7 +776,7 @@ Type: path .RE .P -A node module to \fBrequire()\fR when npm loads\. Useful for programmatic +A node module to \fBrequire()\fP when npm loads\. Useful for programmatic usage\. .SS optional .RS 0 @@ -787,7 +787,7 @@ Type: Boolean .RE .P -Attempt to install packages in the \fBoptionalDependencies\fR object\. Note +Attempt to install packages in the \fBoptionalDependencies\fP object\. Note that if these packages fail to install, the overall installation process is not aborted\. .SS parseable @@ -825,7 +825,7 @@ Set to true to run in "production" mode\. .RS 0 .IP 1. 3 devDependencies are not installed at the topmost level when running -local \fBnpm install\fR without any arguments\. +local \fBnpm install\fP without any arguments\. .IP 2. 3 Set the NODE_ENV="production" for lifecycle scripts\. @@ -854,9 +854,9 @@ Type: url .RE .P -A proxy to use for outgoing http requests\. If the \fBHTTP_PROXY\fR or -\fBhttp_proxy\fR environment variables are set, proxy settings will be -honored by the underlying \fBrequest\fR library\. +A proxy to use for outgoing http requests\. If the \fBHTTP_PROXY\fP or +\fBhttp_proxy\fP environment variables are set, proxy settings will be +honored by the underlying \fBrequest\fP library\. .SS rebuild\-bundle .RS 0 .IP \(bu 2 @@ -898,7 +898,7 @@ Type: Boolean .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 \fBdependencies\fR +When used with the \fBnpm rm\fP command, it removes it from the \fBdependencies\fP object\. .P Only works if there is already a package\.json file present\. @@ -911,11 +911,11 @@ Type: Boolean .RE .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\. +If a package would be saved at install time by the use of \fB\-\-save\fP, +\fB\-\-save\-dev\fP, or \fB\-\-save\-optional\fP, then also put it in the +\fBbundleDependencies\fP list\. .P -When used with the \fBnpm rm\fR command, it removes it from the +When used with the \fBnpm rm\fP command, it removes it from the bundledDependencies list\. .SS save\-dev .RS 0 @@ -926,10 +926,10 @@ Type: Boolean .RE .P -Save installed packages to a package\.json file as \fBdevDependencies\fR\|\. +Save installed packages to a package\.json file as \fBdevDependencies\fP\|\. .P -When used with the \fBnpm rm\fR command, it removes it from the -\fBdevDependencies\fR object\. +When used with the \fBnpm rm\fP command, it removes it from the +\fBdevDependencies\fP object\. .P Only works if there is already a package\.json file present\. .SS save\-exact @@ -941,8 +941,8 @@ Type: Boolean .RE .P -Dependencies saved to package\.json using \fB\-\-save\fR, \fB\-\-save\-dev\fR or -\fB\-\-save\-optional\fR will be configured with an exact version rather than +Dependencies saved to package\.json using \fB\-\-save\fP, \fB\-\-save\-dev\fP or +\fB\-\-save\-optional\fP will be configured with an exact version rather than using npm's default semver range operator\. .SS save\-optional .RS 0 @@ -956,8 +956,8 @@ Type: Boolean Save installed packages to a package\.json file as optionalDependencies\. .P -When used with the \fBnpm rm\fR command, it removes it from the -\fBdevDependencies\fR object\. +When used with the \fBnpm rm\fP command, it removes it from the +\fBdevDependencies\fP object\. .P Only works if there is already a package\.json file present\. .SS save\-prefix @@ -970,11 +970,11 @@ Type: String .RE .P Configure how versions of packages installed to a package\.json file via -\fB\-\-save\fR or \fB\-\-save\-dev\fR get prefixed\. +\fB\-\-save\fP or \fB\-\-save\-dev\fP get prefixed\. .P -For example if a package has version \fB1\.2\.3\fR, by default its version is -set to \fB^1\.2\.3\fR which allows minor upgrades for that package, but after -\fBnpm config set save\-prefix='~'\fR it would be set to \fB~1\.2\.3\fR which only allows +For example if a package has version \fB1\.2\.3\fP, by default its version is +set to \fB^1\.2\.3\fP which allows minor upgrades for that package, but after +\fBnpm config set save\-prefix='~'\fP it would be set to \fB~1\.2\.3\fP which only allows patch upgrades\. .SS scope .RS 0 @@ -987,9 +987,9 @@ Type: String .P Associate an operation with a scope for a scoped registry\. Useful when logging in to a private registry for the first time: -\fBnpm login \-\-scope=@organization \-\-registry=registry\.organization\.com\fR, which -will cause \fB@organization\fR to be mapped to the registry for future installation -of packages specified according to the pattern \fB@organization/package\fR\|\. +\fBnpm login \-\-scope=@organization \-\-registry=registry\.organization\.com\fP, which +will cause \fB@organization\fP to be mapped to the registry for future installation +of packages specified according to the pattern \fB@organization/package\fP\|\. .SS searchopts .RS 0 .IP \(bu 2 @@ -1022,7 +1022,7 @@ Values: "name", "\-name", "date", "\-date", "description", .RE .P -Indication of which field to sort search results by\. Prefix with a \fB\-\fR +Indication of which field to sort search results by\. Prefix with a \fB\-\fP character to indicate reverse sort\. .SS shell .RS 0 @@ -1034,7 +1034,7 @@ Type: path .RE .P -The shell to run for the \fBnpm explore\fR command\. +The shell to run for the \fBnpm explore\fP command\. .SS shrinkwrap .RS 0 .IP \(bu 2 @@ -1044,7 +1044,7 @@ Type: Boolean .RE .P -If set to false, then ignore \fBnpm\-shrinkwrap\.json\fR files when +If set to false, then ignore \fBnpm\-shrinkwrap\.json\fP files when installing\. .SS sign\-git\-tag .RS 0 @@ -1055,8 +1055,8 @@ Type: Boolean .RE .P -If set to true, then the \fBnpm version\fR command will tag the version -using \fB\-s\fR to add a signature\. +If set to true, then the \fBnpm version\fP command will tag the version +using \fB\-s\fP 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\. @@ -1065,14 +1065,14 @@ for this to work properly\. .IP \(bu 2 Default: true .IP \(bu 2 -Type: Boolean or \fB"always"\fR +Type: Boolean or \fB"always"\fP .RE .P -When set to \fBtrue\fR, npm will display an ascii spinner while it is doing -things, if \fBprocess\.stderr\fR is a TTY\. +When set to \fBtrue\fP, npm will display an ascii spinner while it is doing +things, if \fBprocess\.stderr\fP is a TTY\. .P -Set to \fBfalse\fR to suppress the spinner, or set to \fBalways\fR to output +Set to \fBfalse\fP to suppress the spinner, or set to \fBalways\fP to output the spinner even for non\-TTY outputs\. .SS strict\-ssl .RS 0 @@ -1086,7 +1086,7 @@ Type: Boolean Whether or not to do SSL key validation when making requests to the registry via https\. .P -See also the \fBca\fR config\. +See also the \fBca\fP config\. .SS tag .RS 0 .IP \(bu 2 @@ -1100,22 +1100,22 @@ 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\. +tag\fP command, if no explicit tag is given\. .SS tag\-version\-prefix .RS 0 .IP \(bu 2 -Default: \fB"v"\fR +Default: \fB"v"\fP .IP \(bu 2 Type: String .RE .P If set, alters the prefix used when tagging a new version when performing a -version increment using \fBnpm\-version\fR\|\. To remove the prefix altogether, set it -to the empty string: \fB""\fR\|\. +version increment using \fBnpm\-version\fP\|\. To remove the prefix altogether, set it +to the empty string: \fB""\fP\|\. .P Because other tools may rely on the convention that npm version tags look like -\fBv1\.0\.0\fR, \fIonly use this property if it is absolutely necessary\fR\|\. In +\fBv1\.0\.0\fP, \fIonly use this property if it is absolutely necessary\fR\|\. In particular, use care when overriding this setting for public packages\. .SS tmp .RS 0 @@ -1161,7 +1161,7 @@ Type: Boolean .RE .P Set to show short usage output (like the \-H output) -instead of complete help when doing npm help \fBnpm\-help\fR\|\. +instead of complete help when doing npm help \fBnpm\-help\fP\|\. .SS user .RS 0 .IP \(bu 2 @@ -1194,9 +1194,9 @@ Type: Octal numeric string in range 0000\.\.0777 (0\.\.511) 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\. +Folders and executables are given a mode which is \fB0777\fP masked against +this value\. Other files are given a mode which is \fB0666\fP masked against +this value\. Thus, the defaults are \fB0755\fP and \fB0644\fP respectively\. .SS user\-agent .RS 0 .IP \(bu 2 @@ -1228,7 +1228,7 @@ Type: boolean .RE .P -If true, output the npm version as well as node's \fBprocess\.versions\fR map, and +If true, output the npm version as well as node's \fBprocess\.versions\fP map, and exit successfully\. .P Only relevant when specified explicitly on the command line\. @@ -1243,7 +1243,7 @@ Type: path .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\. +Set to \fB"browser"\fP to view html help content in the default web browser\. .SH SEE ALSO .RS 0 .IP \(bu 2 diff --git a/deps/npm/man/man7/npm-developers.7 b/deps/npm/man/man7/npm-developers.7 index 560d17e756..90dff7ba16 100644 --- a/deps/npm/man/man7/npm-developers.7 +++ b/deps/npm/man/man7/npm-developers.7 @@ -13,9 +13,9 @@ that your users will do to install your program\. .SH About These Documents .P 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 \fBpackage\fR +then do \fBman npm\-thing\fP to get the documentation on a particular +topic, or \fBnpm help thing\fP to see the same information\. +.SH What is a \fBpackage\fP .P A package is: .RS 0 @@ -26,13 +26,13 @@ b) a gzipped tarball containing (a) .IP \(bu 2 c) a url that resolves to (b) .IP \(bu 2 -d) a \fB<name>@<version>\fR that is published on the registry with (c) +d) a \fB<name>@<version>\fP that is published on the registry with (c) .IP \(bu 2 -e) a \fB<name>@<tag>\fR that points to (d) +e) a \fB<name>@<tag>\fP that points to (d) .IP \(bu 2 -f) a \fB<name>\fR that has a "latest" tag satisfying (e) +f) a \fB<name>\fP that has a "latest" tag satisfying (e) .IP \(bu 2 -g) a \fBgit\fR url that, when cloned, results in (a)\. +g) a \fBgit\fP url that, when cloned, results in (a)\. .RE .P @@ -52,14 +52,14 @@ git+https://user@hostname/project/blah\.git#commit\-ish .fi .RE .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\|\. +The \fBcommit\-ish\fP can be any tag, sha, or branch which can be supplied as +an argument to \fBgit checkout\fP\|\. The default is \fBmaster\fP\|\. .SH The package\.json File .P -You need to have a \fBpackage\.json\fR file in the root of your project to do +You need to have a \fBpackage\.json\fP file in the root of your project to do much of anything with npm\. That is basically the whole interface\. .P -See npm help 5 \fBpackage\.json\fR for details about what goes in that file\. At the very +See npm help 5 \fBpackage\.json\fP for details about what goes in that file\. At the very least, you need: .RS 0 .IP \(bu 2 @@ -70,7 +70,7 @@ 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\. It does not necessarily need to match your github repository name\. -So, \fBnode\-foo\fR and \fBbar\-js\fR are bad names\. \fBfoo\fR or \fBbar\fR are better\. +So, \fBnode\-foo\fP and \fBbar\-js\fP are bad names\. \fBfoo\fP or \fBbar\fP are better\. .IP \(bu 2 version: A semver\-compatible version\. @@ -85,7 +85,7 @@ Take some credit\. .IP \(bu 2 scripts: If you have a special compilation or installation script, then you -should put it in the \fBscripts\fR object\. You should definitely have at +should put it in the \fBscripts\fP object\. You should definitely have at least a basic smoke\-test command as the "scripts\.test" field\. See npm help 7 scripts\. .IP \(bu 2 @@ -101,78 +101,78 @@ they'll get installed just like these ones\. .RE .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 npm help \fBnpm\-init\fR for +You can use \fBnpm init\fP in the root of your package in order to get you +started with a pretty basic package\.json file\. See npm help \fBnpm\-init\fP for more info\. .SH Keeping files \fIout\fR of your package .P -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\. +Use a \fB\|\.npmignore\fP file to keep stuff out of your package\. If there's +no \fB\|\.npmignore\fP file, but there \fIis\fR a \fB\|\.gitignore\fP file, then npm will +ignore the stuff matched by the \fB\|\.gitignore\fP file\. If you \fIwant\fR to +include something that is excluded by your \fB\|\.gitignore\fP file, you can +create an empty \fB\|\.npmignore\fP file to override it\. .P -\fB\|\.npmignore\fR files follow the same pattern rules \fIhttp://git\-scm\.com/book/en/v2/Git\-Basics\-Recording\-Changes\-to\-the\-Repository#Ignoring\-Files\fR -as \fB\|\.gitignore\fR files: +\fB\|\.npmignore\fP files follow the same pattern rules \fIhttp://git\-scm\.com/book/en/v2/Git\-Basics\-Recording\-Changes\-to\-the\-Repository#Ignoring\-Files\fR +as \fB\|\.gitignore\fP files: .RS 0 .IP \(bu 2 -Blank lines or lines starting with \fB#\fR are ignored\. +Blank lines or lines starting with \fB#\fP are ignored\. .IP \(bu 2 Standard glob patterns work\. .IP \(bu 2 -You can end patterns with a forward slash \fB/\fR to specify a directory\. +You can end patterns with a forward slash \fB/\fP to specify a directory\. .IP \(bu 2 -You can negate a pattern by starting it with an exclamation point \fB!\fR\|\. +You can negate a pattern by starting it with an exclamation point \fB!\fP\|\. .RE .P By default, the following paths and files are ignored, so there's no -need to add them to \fB\|\.npmignore\fR explicitly: +need to add them to \fB\|\.npmignore\fP explicitly: .RS 0 .IP \(bu 2 -\fB\|\.*\.swp\fR +\fB\|\.*\.swp\fP .IP \(bu 2 -\fB\|\._*\fR +\fB\|\._*\fP .IP \(bu 2 -\fB\|\.DS_Store\fR +\fB\|\.DS_Store\fP .IP \(bu 2 -\fB\|\.git\fR +\fB\|\.git\fP .IP \(bu 2 -\fB\|\.hg\fR +\fB\|\.hg\fP .IP \(bu 2 -\fB\|\.lock\-wscript\fR +\fB\|\.lock\-wscript\fP .IP \(bu 2 -\fB\|\.svn\fR +\fB\|\.svn\fP .IP \(bu 2 -\fB\|\.wafpickle\-*\fR +\fB\|\.wafpickle\-*\fP .IP \(bu 2 -\fBCVS\fR +\fBCVS\fP .IP \(bu 2 -\fBnpm\-debug\.log\fR +\fBnpm\-debug\.log\fP .RE .P -Additionally, everything in \fBnode_modules\fR is ignored, except for +Additionally, everything in \fBnode_modules\fP is ignored, except for bundled dependencies\. npm automatically handles this for you, so don't -bother adding \fBnode_modules\fR to \fB\|\.npmignore\fR\|\. +bother adding \fBnode_modules\fP to \fB\|\.npmignore\fP\|\. .P The following paths and files are never ignored, so adding them to -\fB\|\.npmignore\fR is pointless: +\fB\|\.npmignore\fP is pointless: .RS 0 .IP \(bu 2 -\fBpackage\.json\fR +\fBpackage\.json\fP .IP \(bu 2 -\fBREADME\.*\fR +\fBREADME\.*\fP .RE .SH Link Packages .P -\fBnpm link\fR is designed to install a development package and see the +\fBnpm link\fP 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, +need to either re\-link or \fBnpm rebuild \-g\fP to update compiled packages, of course\.) .P -More info at npm help \fBnpm\-link\fR\|\. +More info at npm help \fBnpm\-link\fP\|\. .SH Before Publishing: Make Sure Your Package Installs and Works .P \fBThis is important\.\fR @@ -199,7 +199,7 @@ npm link .fi .RE .P -Use \fBnpm ls \-g\fR to see if it's there\. +Use \fBnpm ls \-g\fP to see if it's there\. .P To test a local install, go into some other folder, and then do: .P @@ -242,7 +242,7 @@ 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 +\fB\|\.npmignore\fP file to list out the globs to ignore, or publish from a fresh checkout\. .SH Brag about it .P diff --git a/deps/npm/man/man7/npm-disputes.7 b/deps/npm/man/man7/npm-disputes.7 index fe98cec594..42f47cd24f 100644 --- a/deps/npm/man/man7/npm-disputes.7 +++ b/deps/npm/man/man7/npm-disputes.7 @@ -4,7 +4,7 @@ .SH SYNOPSIS .RS 0 .IP 1. 3 -Get the author email with \fBnpm owner ls <pkgname>\fR +Get the author email with \fBnpm owner ls <pkgname>\fP .IP 2. 3 Email the author, CC support@npmjs\.com .IP 3. 3 @@ -20,30 +20,30 @@ later, some other user wants to use that name\. Here are some common ways that happens (each of these is based on actual events\.) .RS 0 .IP 1. 3 -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 +Joe writes a JavaScript module \fBfoo\fP, which is not node\-specific\. +Joe doesn't use node at all\. Bob wants to use \fBfoo\fP 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. 3 -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 +Bob writes an npm module \fBfoo\fP, and publishes it\. Perhaps much +later, Joe finds a bug in \fBfoo\fP, 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 +would like to publish a new \fBfoo\fP, but can't, because the name is taken\. .IP 3. 3 -Bob writes a 10\-line flow\-control library, and calls it \fBfoo\fR, and +Bob writes a 10\-line flow\-control library, and calls it \fBfoo\fP, 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\. +of the critically acclaimed and widely\-marketed \fBfoo\fP JavaScript +toolkit framework\. They publish it to npm as \fBfoojs\fP, but people are +routinely confused when \fBnpm install foo\fP is some different thing\. .IP 4. 3 -Bob writes a parser for the widely\-known \fBfoo\fR file format, because +Bob writes a parser for the widely\-known \fBfoo\fP 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\. +prototype\. Later on, Joe writes a much more complete \fBfoo\fP parser, +but can't publish, because Bob's \fBfoo\fP is in the way\. .RE .P @@ -51,14 +51,14 @@ 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\. .RS 0 .IP 1. 3 -\fBnpm owner ls foo\fR\|\. This will tell Joe the email address of the +\fBnpm owner ls foo\fP\|\. This will tell Joe the email address of the owner (Bob)\. .IP 2. 3 Joe emails Bob, explaining the situation \fBas respectfully as possible\fR, and what he would like to do with the module name\. He adds the npm support staff support@npmjs\.com 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\. +joe foo\fP to add Joe as an owner of the \fBfoo\fP package\. .IP 3. 3 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 support diff --git a/deps/npm/man/man7/npm-faq.7 b/deps/npm/man/man7/npm-faq.7 index 8d0aee053d..907c2591bc 100644 --- a/deps/npm/man/man7/npm-faq.7 +++ b/deps/npm/man/man7/npm-faq.7 @@ -11,7 +11,7 @@ npm config set viewer browser .fi .RE .P -to open these documents in your default web browser rather than \fBman\fR\|\. +to open these documents in your default web browser rather than \fBman\fP\|\. .SH It didn't work\. .P That's not really a question\. @@ -23,32 +23,32 @@ 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? .P -See npm help 5 \fBnpm\-folders\fR +See npm help 5 \fBnpm\-folders\fP .P tl;dr: .RS 0 .IP \(bu 2 -Use the \fBnpm root\fR command to see where modules go, and the \fBnpm bin\fR +Use the \fBnpm root\fP command to see where modules go, and the \fBnpm bin\fP command to see where executables go .IP \(bu 2 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\|\. +something with the \fB\-g\fP flag, then its executables go in \fBnpm bin \-g\fP +and its modules go in \fBnpm root \-g\fP\|\. .RE .SH How do I install something on my computer in a central location? .P -Install it globally by tacking \fB\-g\fR or \fB\-\-global\fR to the command\. (This +Install it globally by tacking \fB\-g\fP or \fB\-\-global\fP 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 \fBrequire()\fR it +their bins to the global system \fBPATH\fP\|\.) +.SH I installed something globally, but I can't \fBrequire()\fP it .P 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\|\. +to put their bins in the system \fBPATH\fP\|\. It's not for use with \fBrequire()\fP\|\. .P -If you \fBrequire()\fR a module in your code, then that means it's a +If you \fBrequire()\fP 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? @@ -60,20 +60,20 @@ 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 npm help 5 \fBnpm\-folders\fR for +proven to be an extremely successful approach\. See npm help 5 \fBnpm\-folders\fP 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\. +programs reference the same copy of it, then use the \fBnpm link\fP 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\. .P -Write your own package manager\. You could probably even wrap up \fBnpm\fR +Write your own package manager\. You could probably even wrap up \fBnpm\fP in a shell script if you really wanted to\. .P npm will not help you do something that is known to be a bad idea\. -.SH Should I check my \fBnode_modules\fR folder into git? +.SH Should I check my \fBnode_modules\fP folder into git? .P Usually, no\. Allow npm to resolve dependencies for your packages\. .P @@ -111,23 +111,23 @@ about the (capitalized) NPM program at http://www\.cabiatl\.com/mricro/npm/\|\. 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\|\. +platforms, most often using Yahoo's \fByinst\fP\|\. If \fBnpm\fP was ever an +acronym for anything, it was \fBnode pm\fP or maybe \fBnew pm\fP\|\. .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 +right\-ring\-finger in a postition to type the \fB\-\fP 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? .P -\fBnpm ls\fR +\fBnpm ls\fP .SH How do I search for packages? .P -\fBnpm search\fR +\fBnpm search\fP .P -Arguments are greps\. \fBnpm search jsdom\fR shows jsdom packages\. +Arguments are greps\. \fBnpm search jsdom\fP shows jsdom packages\. .SH How do I update npm? .P .RS 2 @@ -136,12 +136,12 @@ npm install npm \-g .fi .RE .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\|\. +You can also update all outdated local packages by doing \fBnpm update\fP without +any arguments, or global packages by doing \fBnpm update \-g\fP\|\. .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 +installed already\. (Consider, if there is ever a bug in the \fBupdate\fP command\.) .P In those cases, you can do this: @@ -151,7 +151,7 @@ In those cases, you can do this: curl https://www\.npmjs\.com/install\.sh | sh .fi .RE -.SH What is a \fBpackage\fR? +.SH What is a \fBpackage\fP? .P A package is: .RS 0 @@ -162,13 +162,13 @@ b) a gzipped tarball containing (a) .IP \(bu 2 c) a url that resolves to (b) .IP \(bu 2 -d) a \fB<name>@<version>\fR that is published on the registry with (c) +d) a \fB<name>@<version>\fP that is published on the registry with (c) .IP \(bu 2 -e) a \fB<name>@<tag>\fR that points to (d) +e) a \fB<name>@<tag>\fP that points to (d) .IP \(bu 2 -f) a \fB<name>\fR that has a "latest" tag satisfying (e) +f) a \fB<name>\fP that has a "latest" tag satisfying (e) .IP \(bu 2 -g) a \fBgit\fR url that, when cloned, results in (a)\. +g) a \fBgit\fP url that, when cloned, results in (a)\. .RE .P @@ -188,33 +188,33 @@ git+https://user@hostname/project/blah\.git#commit\-ish .fi .RE .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 \fBmodule\fR? +The \fBcommit\-ish\fP can be any tag, sha, or branch which can be supplied as +an argument to \fBgit checkout\fP\|\. The default is \fBmaster\fP\|\. +.SH What is a \fBmodule\fP? .P -A module is anything that can be loaded with \fBrequire()\fR in a Node\.js +A module is anything that can be loaded with \fBrequire()\fP in a Node\.js program\. The following things are all examples of things that can be loaded as modules: .RS 0 .IP \(bu 2 -A folder with a \fBpackage\.json\fR file containing a \fBmain\fR field\. +A folder with a \fBpackage\.json\fP file containing a \fBmain\fP field\. .IP \(bu 2 -A folder with an \fBindex\.js\fR file in it\. +A folder with an \fBindex\.js\fP file in it\. .IP \(bu 2 A JavaScript file\. .RE .P Most npm packages are modules, because they are libraries that you -load with \fBrequire\fR\|\. However, there's no requirement that an npm +load with \fBrequire\fP\|\. 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\. +interface, and don't provide a \fBmain\fP 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)\. +\fBrequire()\fP is a module)\. .P -In the context of a Node program, the \fBmodule\fR is also the thing that +In the context of a Node program, the \fBmodule\fP is also the thing that was loaded \fIfrom\fR a file\. For example, in the following program: .P .RS 2 @@ -223,25 +223,25 @@ var req = require('request') .fi .RE .P -we might say that "The variable \fBreq\fR refers to the \fBrequest\fR module"\. -.SH So, why is it the "\fBnode_modules\fR" folder, but "\fBpackage\.json\fR" file? Why not \fBnode_packages\fR or \fBmodule\.json\fR? +we might say that "The variable \fBreq\fP refers to the \fBrequest\fP module"\. +.SH So, why is it the "\fBnode_modules\fP" folder, but "\fBpackage\.json\fP" file? Why not \fBnode_packages\fP or \fBmodule\.json\fP? .P -The \fBpackage\.json\fR file defines the package\. (See "What is a +The \fBpackage\.json\fP file defines the package\. (See "What is a package?" above\.) .P -The \fBnode_modules\fR folder is the place Node\.js looks for modules\. +The \fBnode_modules\fP 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, +For example, if you create a file at \fBnode_modules/foo\.js\fP and then +had a program that did \fBvar f = require('foo\.js')\fP then it would load +the module\. However, \fBfoo\.js\fP 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 \fB"node_modules"\fR is the name of my deity's arch\-rival, and a Forbidden Word in my religion\. Can I configure npm to use a different folder? +\fBindex\.js\fP or a \fB"main"\fP field in the \fBpackage\.json\fP file, then it is +not a module\. Even if it's installed in \fBnode_modules\fP, it can't be +an argument to \fBrequire()\fP\|\. +.SH \fB"node_modules"\fP is the name of my deity's arch\-rival, and a Forbidden Word in my religion\. Can I configure npm to use a different folder? .P No\. This will never happen\. This question comes up sometimes, because it seems silly from the outside that npm couldn't just be @@ -249,7 +249,7 @@ 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 +At the time of this writing, the string \fB\|'node_modules'\fP appears 151 times in 53 separate files in npm and node core (excluding tests and documentation)\. .P @@ -263,27 +263,27 @@ deference to your deity's delicate feelings regarding spelling\. 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 +configured to take the name of the \fBnode_modules\fP 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, +the dep names to the \fB"bundledDependencies"\fP 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 +different spelling for \fBnode_modules\fP? 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 +easy enough the first time, just rename the \fBnode_modules\fP folders to +\fB\|\./blergyblerp/\fP 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 #4\. .P -Never going to happen\. The folder is named \fBnode_modules\fR\|\. It is +Never going to happen\. The folder is named \fBnode_modules\fP\|\. 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? @@ -315,12 +315,12 @@ https://github\.com/nanjingboy/nvmw .RE .SH How can I use npm for development? .P -See npm help 7 \fBnpm\-developers\fR and npm help 5 \fBpackage\.json\fR\|\. +See npm help 7 \fBnpm\-developers\fP and npm help 5 \fBpackage\.json\fP\|\. .P -You'll most likely want to \fBnpm link\fR your development folder\. That's +You'll most likely want to \fBnpm link\fP your development folder\. That's awesomely handy\. .P -To set up your own private registry, check out npm help 7 \fBnpm\-registry\fR\|\. +To set up your own private registry, check out npm help 7 \fBnpm\-registry\fP\|\. .SH Can I list a url as a dependency? .P Yes\. It should be a url to a gzipped tarball containing a single folder @@ -328,10 +328,10 @@ 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? .P -See npm help \fBnpm\-link\fR +See npm help \fBnpm\-link\fP .SH The package registry website\. What is that exactly? .P -See npm help 7 \fBnpm\-registry\fR\|\. +See npm help 7 \fBnpm\-registry\fP\|\. .SH I forgot my password, and can't publish\. How do I reset it? .P Go to https://npmjs\.com/forgot\|\. @@ -353,7 +353,7 @@ on Freenode IRC\. .SH Why no namespaces? .P npm has only one global namespace\. If you want to namespace your own packages, -you may: simply use the \fB\-\fR character to separate the names or use scoped +you may: simply use the \fB\-\fP character to separate the names or use scoped packages\. npm is a mostly anarchic system\. There is not sufficient need to impose namespace rules on everyone\. .P @@ -361,9 +361,9 @@ As of 2\.0, npm supports scoped packages, which allow you to publish a group of related modules without worrying about name collisions\. .P Every npm user owns the scope associated with their username\. For example, the -user named \fBnpm\fR owns the scope \fB@npm\fR\|\. Scoped packages are published inside a +user named \fBnpm\fP owns the scope \fB@npm\fP\|\. Scoped packages are published inside a scope by naming them as if they were files under the scope directory, e\.g\., by -setting \fBname\fR in \fBpackage\.json\fR to \fB@npm/npm\fR\|\. +setting \fBname\fP in \fBpackage\.json\fP to \fB@npm/npm\fP\|\. .P Scoped packages are supported by the public npm registry\. The npm client is backwards\-compatible with un\-scoped registries, so it can be used to work with diff --git a/deps/npm/man/man7/npm-registry.7 b/deps/npm/man/man7/npm-registry.7 index 9f4914e9a0..a1cf07f1d8 100644 --- a/deps/npm/man/man7/npm-registry.7 +++ b/deps/npm/man/man7/npm-registry.7 @@ -17,9 +17,9 @@ http://skimdb\.npmjs\.com/registry\|\. The code for the couchapp is available at http://github\.com/npm/npm\-registry\-couchapp\|\. .P The registry URL used is determined by the scope of the package (see -npm help 7 \fBnpm\-scope\fR)\. If no scope is specified, the default registry is used, which is -supplied by the \fBregistry\fR config parameter\. See npm help \fBnpm\-config\fR, -npm help 5 \fBnpmrc\fR, and npm help 7 \fBnpm\-config\fR for more on managing npm's configuration\. +npm help 7 \fBnpm\-scope\fP)\. If no scope is specified, the default registry is used, which is +supplied by the \fBregistry\fP config parameter\. See npm help \fBnpm\-config\fP, +npm help 5 \fBnpmrc\fP, and npm help 7 \fBnpm\-config\fP for more on managing npm's configuration\. .SH Can I run my own private registry? .P Yes! @@ -33,15 +33,15 @@ to read any published packages, in addition to your private ones, and by default will only publish internally\. .P If you then want to publish a package for the whole world to see, you can -simply override the \fB\-\-registry\fR option for that \fBpublish\fR command\. +simply override the \fB\-\-registry\fP option for that \fBpublish\fP command\. .SH I don't want my package published in the official registry\. It's private\. .P -Set \fB"private": true\fR in your package\.json to prevent it from being +Set \fB"private": true\fP in your package\.json to prevent it from being published at all, or -\fB"publishConfig":{"registry":"http://my\-internal\-registry\.local"}\fR +\fB"publishConfig":{"registry":"http://my\-internal\-registry\.local"}\fP to force it to be published only to your internal registry\. .P -See npm help 5 \fBpackage\.json\fR for more info on what goes in the package\.json file\. +See npm help 5 \fBpackage\.json\fP for more info on what goes in the package\.json file\. .SH Will you replicate from my registry into the public one? .P No\. If you want things to be public, then publish them into the public diff --git a/deps/npm/man/man7/npm-scope.7 b/deps/npm/man/man7/npm-scope.7 index f79d7e51cb..5c1ffb2422 100644 --- a/deps/npm/man/man7/npm-scope.7 +++ b/deps/npm/man/man7/npm-scope.7 @@ -23,13 +23,13 @@ used to work with scoped and un\-scoped registries at the same time\. .SH Installing scoped packages .P Scoped packages are installed to a sub\-folder of the regular installation -folder, e\.g\. if your other packages are installed in \fBnode_modules/packagename\fR, -scoped modules will be in \fBnode_modules/@myorg/packagename\fR\|\. The scope folder -(\fB@myorg\fR) is simply the name of the scope preceded by an @\-symbol, and can +folder, e\.g\. if your other packages are installed in \fBnode_modules/packagename\fP, +scoped modules will be in \fBnode_modules/@myorg/packagename\fP\|\. The scope folder +(\fB@myorg\fP) is simply the name of the scope preceded by an @\-symbol, and can contain any number of scoped packages\. .P A scoped package is installed by referencing it by name, preceded by an -@\-symbol, in \fBnpm install\fR: +@\-symbol, in \fBnpm install\fP: .P .RS 2 .nf @@ -37,7 +37,7 @@ npm install @myorg/mypackage .fi .RE .P -Or in \fBpackage\.json\fR: +Or in \fBpackage\.json\fP: .P .RS 2 .nf @@ -48,7 +48,7 @@ Or in \fBpackage\.json\fR: .RE .P Note that if the @\-symbol is omitted in either case npm will instead attempt to -install from GitHub; see npm help \fBnpm\-install\fR\|\. +install from GitHub; see npm help \fBnpm\-install\fP\|\. .SH Requiring scoped packages .P Because scoped packages are installed into a scope folder, you have to @@ -61,7 +61,7 @@ require('@myorg/mypackage') .RE .P There is nothing special about the way Node treats scope folders, this is -just specifying to require the module \fBmypackage\fR in the folder called \fB@myorg\fR\|\. +just specifying to require the module \fBmypackage\fP in the folder called \fB@myorg\fP\|\. .SH Publishing scoped packages .P Scoped packages can be published to any registry that supports them, including @@ -72,19 +72,19 @@ the public npm registry\. If you wish, you may associate a scope with a registry; see below\. .SS Publishing public scoped packages to the public npm registry .P -To publish a public scoped package, you must specify \fB\-\-access public\fR with +To publish a public scoped package, you must specify \fB\-\-access public\fP with the initial publication\. This will publish the package and set access -to \fBpublic\fR as if you had run \fBnpm access public\fR after publishing\. +to \fBpublic\fP as if you had run \fBnpm access public\fP after publishing\. .SS Publishing private scoped packages to the npm registry .P To publish a private scoped package to the npm registry, you must have an npm Private Modules \fIhttps://www\.npmjs\.com/private\-modules\fR account\. .P -You can then publish the module with \fBnpm publish\fR or \fBnpm publish -\-\-access restricted\fR, and it will be present in the npm registry, with +You can then publish the module with \fBnpm publish\fP or \fBnpm publish +\-\-access restricted\fP, and it will be present in the npm registry, with restricted access\. You can then change the access permissions, if -desired, with \fBnpm access\fR or on the npmjs\.com website\. +desired, with \fBnpm access\fP or on the npmjs\.com website\. .SH Associating a scope with a registry .P Scopes can be associated with a separate registry\. This allows you to @@ -102,7 +102,7 @@ npm login \-\-registry=http://reg\.example\.com \-\-scope=@myco Scopes have a many\-to\-one relationship with registries: one registry can host multiple scopes, but a scope only ever points to one registry\. .P -You can also associate a scope with a registry using \fBnpm config\fR: +You can also associate a scope with a registry using \fBnpm config\fP: .P .RS 2 .nf @@ -110,9 +110,9 @@ npm config set @myco:registry http://reg\.example\.com .fi .RE .P -Once a scope is associated with a registry, any \fBnpm install\fR for a package +Once a scope is associated with a registry, any \fBnpm install\fP for a package with that scope will request packages from that registry instead\. Any -\fBnpm publish\fR for a package name that contains the scope will be published to +\fBnpm publish\fP for a package name that contains the scope will be published to that registry instead\. .SH SEE ALSO .RS 0 diff --git a/deps/npm/man/man7/npm-scripts.7 b/deps/npm/man/man7/npm-scripts.7 index bcd8af8395..1e1002dea7 100644 --- a/deps/npm/man/man7/npm-scripts.7 +++ b/deps/npm/man/man7/npm-scripts.7 @@ -9,7 +9,7 @@ following scripts: .IP \(bu 2 prepublish: Run BEFORE the package is published\. (Also run on local \fBnpm -install\fR without any arguments\.) +install\fP without any arguments\.) .IP \(bu 2 publish, postpublish: Run AFTER the package is published\. @@ -33,29 +33,29 @@ postversion: Run AFTER bump the package version\. .IP \(bu 2 pretest, test, posttest: -Run by the \fBnpm test\fR command\. +Run by the \fBnpm test\fP command\. .IP \(bu 2 prestop, stop, poststop: -Run by the \fBnpm stop\fR command\. +Run by the \fBnpm stop\fP command\. .IP \(bu 2 prestart, start, poststart: -Run by the \fBnpm start\fR command\. +Run by the \fBnpm start\fP command\. .IP \(bu 2 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\. +Run by the \fBnpm restart\fP command\. Note: \fBnpm restart\fP will run the +stop and start scripts if no \fBrestart\fP script is provided\. .RE .P Additionally, arbitrary scripts can be executed by running \fBnpm -run\-script <pkg> <stage>\fR\|\. \fIPre\fR and \fIpost\fR commands with matching -names will be run for those as well (e\.g\. \fBpremyscript\fR, \fBmyscript\fR, -\fBpostmyscript\fR)\. +run\-script <pkg> <stage>\fP\|\. \fIPre\fR and \fIpost\fR commands with matching +names will be run for those as well (e\.g\. \fBpremyscript\fP, \fBmyscript\fP, +\fBpostmyscript\fP)\. .SH COMMON USES .P If you need to perform operations on your package before it is used, in a way that is not dependent on the operating system or architecture of the -target system, use a \fBprepublish\fR script\. This includes +target system, use a \fBprepublish\fP script\. This includes tasks such as: .RS 0 .IP \(bu 2 @@ -67,18 +67,18 @@ Fetching remote resources that your package will use\. .RE .P -The advantage of doing these things at \fBprepublish\fR time is that they can be done once, in a +The advantage of doing these things at \fBprepublish\fP time is that they can be done once, in a single place, thus reducing complexity and variability\. Additionally, this means that: .RS 0 .IP \(bu 2 -You can depend on \fBcoffee\-script\fR as a \fBdevDependency\fR, and thus +You can depend on \fBcoffee\-script\fP as a \fBdevDependency\fP, and thus your users don't need to have it installed\. .IP \(bu 2 You don't need to include minifiers in your package, reducing the size for your users\. .IP \(bu 2 -You don't need to rely on your users having \fBcurl\fR or \fBwget\fR or +You don't need to rely on your users having \fBcurl\fP or \fBwget\fP or other system tools on the target machines\. .RE @@ -87,20 +87,20 @@ other system tools on the target machines\. npm will default some script values based on package contents\. .RS 0 .IP \(bu 2 -\fB"start": "node server\.js"\fR: -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\|\. +\fB"start": "node server\.js"\fP: +If there is a \fBserver\.js\fP file in the root of your package, then npm +will default the \fBstart\fP command to \fBnode server\.js\fP\|\. .IP \(bu 2 -\fB"preinstall": "node\-waf clean || true; node\-waf configure build"\fR: -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\. +\fB"preinstall": "node\-waf clean || true; node\-waf configure build"\fP: +If there is a \fBwscript\fP file in the root of your package, npm will +default the \fBpreinstall\fP command to compile using node\-waf\. .RE .SH USER .P 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 +to the user account or uid specified by the \fBuser\fP config, which +defaults to \fBnobody\fP\|\. Set the \fBunsafe\-perm\fP flag to run scripts with root privileges\. .SH ENVIRONMENT .P @@ -110,7 +110,7 @@ the process\. .SS path .P If you depend on modules that define executable scripts, like test -suites, then those executables will be added to the \fBPATH\fR for +suites, then those executables will be added to the \fBPATH\fP for executing the scripts\. So, if your package\.json has this: .P .RS 2 @@ -121,24 +121,24 @@ executing the scripts\. So, if your package\.json has this: .fi .RE .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\|\. +then you could run \fBnpm start\fP to execute the \fBbar\fP script, which is +exported into the \fBnode_modules/\.bin\fP directory on \fBnpm install\fP\|\. .SS package\.json vars .P -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 +The package\.json fields are tacked onto the \fBnpm_package_\fP prefix\. So, +for instance, if you had \fB{"name":"foo", "version":"1\.2\.5"}\fP 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" +\fBnpm_package_name\fP environment variable set to "foo", and the +\fBnpm_package_version\fP set to "1\.2\.5" .SS configuration .P 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\. +\fBnpm_config_\fP prefix\. For instance, you can view the effective \fBroot\fP +config by checking the \fBnpm_config_root\fP environment variable\. .SS Special: package\.json "config" object .P The package\.json "config" keys are overwritten in the environment if -there is a config param of \fB<name>[@<version>]:<key>\fR\|\. For example, +there is a config param of \fB<name>[@<version>]:<key>\fP\|\. For example, if the package\.json has this: .P .RS 2 @@ -166,13 +166,13 @@ npm config set foo:port 80 .RE .SS current lifecycle event .P -Lastly, the \fBnpm_lifecycle_event\fR environment variable is set to +Lastly, the \fBnpm_lifecycle_event\fP 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 +\fB{"scripts":{"install":"foo\.js"}}\fP in your package\.json, then you'd see this in the script: .P .RS 2 @@ -195,11 +195,11 @@ For example, if your package\.json contains this: .fi .RE .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 +then the \fBscripts/install\.js\fP will be called for the install, +post\-install, stages of the lifecycle, and the \fBscripts/uninstall\.js\fP 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 +\fBscripts/install\.js\fP is running for three different phases, it would +be wise in this case to look at the \fBnpm_lifecycle_event\fP environment variable\. .P If you want to run a make command, you can do so\. This works just @@ -217,7 +217,7 @@ fine: .RE .SH EXITING .P -Scripts are run by passing the line as a script argument to \fBsh\fR\|\. +Scripts are run by passing the line as a script argument to \fBsh\fP\|\. .P If the script exits with a code other than 0, then this will abort the process\. @@ -230,7 +230,7 @@ file\. 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 +Place an executable file at \fBnode_modules/\.hooks/{eventname}\fP, 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 @@ -247,23 +247,23 @@ only will prevent some optional features, then it's better to just print a warning and exit successfully\. .IP \(bu 2 Try not to use scripts to do what npm can do for you\. Read through -npm help 5 \fBpackage\.json\fR to see all the things that you can specify and enable +npm help 5 \fBpackage\.json\fP 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 2 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 +the \fBnpm_config_binroot\fP environ is set to \fB/home/user/bin\fP, then +don't try to install executables into \fB/usr/local/bin\fP\|\. The user probably set it up that way for a reason\. .IP \(bu 2 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 \(bu 2 -Don't use \fBinstall\fR\|\. Use a \fB\|\.gyp\fR file for compilation, and \fBprepublish\fR +Don't use \fBinstall\fP\|\. Use a \fB\|\.gyp\fP file for compilation, and \fBprepublish\fP for anything else\. You should almost never have to explicitly set a preinstall or install script\. If you are doing this, please consider if -there is another option\. The only valid use of \fBinstall\fR or \fBpreinstall\fR +there is another option\. The only valid use of \fBinstall\fP or \fBpreinstall\fP scripts is for compilation which must be done on the target architecture\. .RE diff --git a/deps/npm/man/man7/removing-npm.7 b/deps/npm/man/man7/removing-npm.7 index e3fa17eba8..bf1c9ca9f4 100644 --- a/deps/npm/man/man7/removing-npm.7 +++ b/deps/npm/man/man7/removing-npm.7 @@ -27,14 +27,14 @@ 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 +installs are completely contained within a project's \fBnode_modules\fP 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 +you configured node with a different \fB\-\-prefix\fP, or installed npm with a different prefix setting, then adjust the paths accordingly, replacing -\fB/usr/local\fR with your install prefix\. +\fB/usr/local\fP with your install prefix\. .P To remove everything npm\-related manually: .P diff --git a/deps/npm/man/man7/semver.7 b/deps/npm/man/man7/semver.7 index 78a1993a50..994615e4c9 100644 --- a/deps/npm/man/man7/semver.7 +++ b/deps/npm/man/man7/semver.7 @@ -41,64 +41,64 @@ multiple versions to the utility will just sort them\. .RE .SH Versions .P -A "version" is described by the \fBv2\.0\.0\fR specification found at +A "version" is described by the \fBv2\.0\.0\fP specification found at http://semver\.org/\|\. .P -A leading \fB"="\fR or \fB"v"\fR character is stripped off and ignored\. +A leading \fB"="\fP or \fB"v"\fP character is stripped off and ignored\. .SH Ranges .P -A \fBversion range\fR is a set of \fBcomparators\fR which specify versions +A \fBversion range\fP is a set of \fBcomparators\fP which specify versions that satisfy the range\. .P -A \fBcomparator\fR is composed of an \fBoperator\fR and a \fBversion\fR\|\. The set -of primitive \fBoperators\fR is: +A \fBcomparator\fP is composed of an \fBoperator\fP and a \fBversion\fP\|\. The set +of primitive \fBoperators\fP is: .RS 0 .IP \(bu 2 -\fB<\fR Less than +\fB<\fP Less than .IP \(bu 2 -\fB<=\fR Less than or equal to +\fB<=\fP Less than or equal to .IP \(bu 2 -\fB>\fR Greater than +\fB>\fP Greater than .IP \(bu 2 -\fB>=\fR Greater than or equal to +\fB>=\fP Greater than or equal to .IP \(bu 2 -\fB=\fR Equal\. If no operator is specified, then equality is assumed, +\fB=\fP Equal\. If no operator is specified, then equality is assumed, so this operator is optional, but MAY be included\. .RE .P -For example, the comparator \fB>=1\.2\.7\fR would match the versions -\fB1\.2\.7\fR, \fB1\.2\.8\fR, \fB2\.5\.3\fR, and \fB1\.3\.9\fR, but not the versions \fB1\.2\.6\fR -or \fB1\.1\.0\fR\|\. +For example, the comparator \fB>=1\.2\.7\fP would match the versions +\fB1\.2\.7\fP, \fB1\.2\.8\fP, \fB2\.5\.3\fP, and \fB1\.3\.9\fP, but not the versions \fB1\.2\.6\fP +or \fB1\.1\.0\fP\|\. .P -Comparators can be joined by whitespace to form a \fBcomparator set\fR, +Comparators can be joined by whitespace to form a \fBcomparator set\fP, which is satisfied by the \fBintersection\fR of all of the comparators it includes\. .P -A range is composed of one or more comparator sets, joined by \fB||\fR\|\. A +A range is composed of one or more comparator sets, joined by \fB||\fP\|\. A version matches a range if and only if every comparator in at least -one of the \fB||\fR\-separated comparator sets is satisfied by the version\. +one of the \fB||\fP\-separated comparator sets is satisfied by the version\. .P -For example, the range \fB>=1\.2\.7 <1\.3\.0\fR would match the versions -\fB1\.2\.7\fR, \fB1\.2\.8\fR, and \fB1\.2\.99\fR, but not the versions \fB1\.2\.6\fR, \fB1\.3\.0\fR, -or \fB1\.1\.0\fR\|\. +For example, the range \fB>=1\.2\.7 <1\.3\.0\fP would match the versions +\fB1\.2\.7\fP, \fB1\.2\.8\fP, and \fB1\.2\.99\fP, but not the versions \fB1\.2\.6\fP, \fB1\.3\.0\fP, +or \fB1\.1\.0\fP\|\. .P -The range \fB1\.2\.7 || >=1\.2\.9 <2\.0\.0\fR would match the versions \fB1\.2\.7\fR, -\fB1\.2\.9\fR, and \fB1\.4\.6\fR, but not the versions \fB1\.2\.8\fR or \fB2\.0\.0\fR\|\. +The range \fB1\.2\.7 || >=1\.2\.9 <2\.0\.0\fP would match the versions \fB1\.2\.7\fP, +\fB1\.2\.9\fP, and \fB1\.4\.6\fP, but not the versions \fB1\.2\.8\fP or \fB2\.0\.0\fP\|\. .SS Prerelease Tags .P -If a version has a prerelease tag (for example, \fB1\.2\.3\-alpha\.3\fR) then +If a version has a prerelease tag (for example, \fB1\.2\.3\-alpha\.3\fP) then it will only be allowed to satisfy comparator sets if at least one -comparator with the same \fB[major, minor, patch]\fR tuple also has a +comparator with the same \fB[major, minor, patch]\fP tuple also has a prerelease tag\. .P -For example, the range \fB>1\.2\.3\-alpha\.3\fR would be allowed to match the -version \fB1\.2\.3\-alpha\.7\fR, but it would \fInot\fR be satisfied by -\fB3\.4\.5\-alpha\.9\fR, even though \fB3\.4\.5\-alpha\.9\fR is technically "greater -than" \fB1\.2\.3\-alpha\.3\fR according to the SemVer sort rules\. The version -range only accepts prerelease tags on the \fB1\.2\.3\fR version\. The -version \fB3\.4\.5\fR \fIwould\fR satisfy the range, because it does not have a -prerelease flag, and \fB3\.4\.5\fR is greater than \fB1\.2\.3\-alpha\.7\fR\|\. +For example, the range \fB>1\.2\.3\-alpha\.3\fP would be allowed to match the +version \fB1\.2\.3\-alpha\.7\fP, but it would \fInot\fR be satisfied by +\fB3\.4\.5\-alpha\.9\fP, even though \fB3\.4\.5\-alpha\.9\fP is technically "greater +than" \fB1\.2\.3\-alpha\.3\fP according to the SemVer sort rules\. The version +range only accepts prerelease tags on the \fB1\.2\.3\fP version\. The +version \fB3\.4\.5\fP \fIwould\fR satisfy the range, because it does not have a +prerelease flag, and \fB3\.4\.5\fP is greater than \fB1\.2\.3\-alpha\.7\fP\|\. .P The purpose for this behavior is twofold\. First, prerelease versions frequently are updated very quickly, and contain many breaking changes @@ -114,7 +114,7 @@ is still not appropriate to assume that they have opted into taking a similar risk on the \fInext\fR set of prerelease versions\. .SS Prerelease Identifiers .P -The method \fB\|\.inc\fR takes an additional \fBidentifier\fR string argument that +The method \fB\|\.inc\fP takes an additional \fBidentifier\fP string argument that will append the value of the string as a prerelease identifier: .P .RS 2 @@ -147,13 +147,13 @@ Advanced range syntax desugars to primitive comparators in deterministic ways\. .P Advanced ranges may be combined in the same way as primitive -comparators using white space or \fB||\fR\|\. -.SS Hyphen Ranges \fBX\.Y\.Z \- A\.B\.C\fR +comparators using white space or \fB||\fP\|\. +.SS Hyphen Ranges \fBX\.Y\.Z \- A\.B\.C\fP .P Specifies an inclusive set\. .RS 0 .IP \(bu 2 -\fB1\.2\.3 \- 2\.3\.4\fR := \fB>=1\.2\.3 <=2\.3\.4\fR +\fB1\.2\.3 \- 2\.3\.4\fP := \fB>=1\.2\.3 <=2\.3\.4\fP .RE .P @@ -161,7 +161,7 @@ If a partial version is provided as the first version in the inclusive range, then the missing pieces are replaced with zeroes\. .RS 0 .IP \(bu 2 -\fB1\.2 \- 2\.3\.4\fR := \fB>=1\.2\.0 <=2\.3\.4\fR +\fB1\.2 \- 2\.3\.4\fP := \fB>=1\.2\.0 <=2\.3\.4\fP .RE .P @@ -171,22 +171,22 @@ of the tuple are accepted, but nothing that would be greater than the provided tuple parts\. .RS 0 .IP \(bu 2 -\fB1\.2\.3 \- 2\.3\fR := \fB>=1\.2\.3 <2\.4\.0\fR +\fB1\.2\.3 \- 2\.3\fP := \fB>=1\.2\.3 <2\.4\.0\fP .IP \(bu 2 -\fB1\.2\.3 \- 2\fR := \fB>=1\.2\.3 <3\.0\.0\fR +\fB1\.2\.3 \- 2\fP := \fB>=1\.2\.3 <3\.0\.0\fP .RE -.SS X\-Ranges \fB1\.2\.x\fR \fB1\.X\fR \fB1\.2\.*\fR \fB*\fR +.SS X\-Ranges \fB1\.2\.x\fP \fB1\.X\fP \fB1\.2\.*\fP \fB*\fP .P -Any of \fBX\fR, \fBx\fR, or \fB*\fR may be used to "stand in" for one of the -numeric values in the \fB[major, minor, patch]\fR tuple\. +Any of \fBX\fP, \fBx\fP, or \fB*\fP may be used to "stand in" for one of the +numeric values in the \fB[major, minor, patch]\fP tuple\. .RS 0 .IP \(bu 2 -\fB*\fR := \fB>=0\.0\.0\fR (Any version satisfies) +\fB*\fP := \fB>=0\.0\.0\fP (Any version satisfies) .IP \(bu 2 -\fB1\.x\fR := \fB>=1\.0\.0 <2\.0\.0\fR (Matching major version) +\fB1\.x\fP := \fB>=1\.0\.0 <2\.0\.0\fP (Matching major version) .IP \(bu 2 -\fB1\.2\.x\fR := \fB>=1\.2\.0 <1\.3\.0\fR (Matching major and minor versions) +\fB1\.2\.x\fP := \fB>=1\.2\.0 <1\.3\.0\fP (Matching major and minor versions) .RE .P @@ -194,99 +194,99 @@ A partial version range is treated as an X\-Range, so the special character is in fact optional\. .RS 0 .IP \(bu 2 -\fB""\fR (empty string) := \fB*\fR := \fB>=0\.0\.0\fR +\fB""\fP (empty string) := \fB*\fP := \fB>=0\.0\.0\fP .IP \(bu 2 -\fB1\fR := \fB1\.x\.x\fR := \fB>=1\.0\.0 <2\.0\.0\fR +\fB1\fP := \fB1\.x\.x\fP := \fB>=1\.0\.0 <2\.0\.0\fP .IP \(bu 2 -\fB1\.2\fR := \fB1\.2\.x\fR := \fB>=1\.2\.0 <1\.3\.0\fR +\fB1\.2\fP := \fB1\.2\.x\fP := \fB>=1\.2\.0 <1\.3\.0\fP .RE -.SS Tilde Ranges \fB~1\.2\.3\fR \fB~1\.2\fR \fB~1\fR +.SS Tilde Ranges \fB~1\.2\.3\fP \fB~1\.2\fP \fB~1\fP .P Allows patch\-level changes if a minor version is specified on the comparator\. Allows minor\-level changes if not\. .RS 0 .IP \(bu 2 -\fB~1\.2\.3\fR := \fB>=1\.2\.3 <1\.(2+1)\.0\fR := \fB>=1\.2\.3 <1\.3\.0\fR +\fB~1\.2\.3\fP := \fB>=1\.2\.3 <1\.(2+1)\.0\fP := \fB>=1\.2\.3 <1\.3\.0\fP .IP \(bu 2 -\fB~1\.2\fR := \fB>=1\.2\.0 <1\.(2+1)\.0\fR := \fB>=1\.2\.0 <1\.3\.0\fR (Same as \fB1\.2\.x\fR) +\fB~1\.2\fP := \fB>=1\.2\.0 <1\.(2+1)\.0\fP := \fB>=1\.2\.0 <1\.3\.0\fP (Same as \fB1\.2\.x\fP) .IP \(bu 2 -\fB~1\fR := \fB>=1\.0\.0 <(1+1)\.0\.0\fR := \fB>=1\.0\.0 <2\.0\.0\fR (Same as \fB1\.x\fR) +\fB~1\fP := \fB>=1\.0\.0 <(1+1)\.0\.0\fP := \fB>=1\.0\.0 <2\.0\.0\fP (Same as \fB1\.x\fP) .IP \(bu 2 -\fB~0\.2\.3\fR := \fB>=0\.2\.3 <0\.(2+1)\.0\fR := \fB>=0\.2\.3 <0\.3\.0\fR +\fB~0\.2\.3\fP := \fB>=0\.2\.3 <0\.(2+1)\.0\fP := \fB>=0\.2\.3 <0\.3\.0\fP .IP \(bu 2 -\fB~0\.2\fR := \fB>=0\.2\.0 <0\.(2+1)\.0\fR := \fB>=0\.2\.0 <0\.3\.0\fR (Same as \fB0\.2\.x\fR) +\fB~0\.2\fP := \fB>=0\.2\.0 <0\.(2+1)\.0\fP := \fB>=0\.2\.0 <0\.3\.0\fP (Same as \fB0\.2\.x\fP) .IP \(bu 2 -\fB~0\fR := \fB>=0\.0\.0 <(0+1)\.0\.0\fR := \fB>=0\.0\.0 <1\.0\.0\fR (Same as \fB0\.x\fR) +\fB~0\fP := \fB>=0\.0\.0 <(0+1)\.0\.0\fP := \fB>=0\.0\.0 <1\.0\.0\fP (Same as \fB0\.x\fP) .IP \(bu 2 -\fB~1\.2\.3\-beta\.2\fR := \fB>=1\.2\.3\-beta\.2 <1\.3\.0\fR Note that prereleases in -the \fB1\.2\.3\fR version will be allowed, if they are greater than or -equal to \fBbeta\.2\fR\|\. So, \fB1\.2\.3\-beta\.4\fR would be allowed, but -\fB1\.2\.4\-beta\.2\fR would not, because it is a prerelease of a -different \fB[major, minor, patch]\fR tuple\. +\fB~1\.2\.3\-beta\.2\fP := \fB>=1\.2\.3\-beta\.2 <1\.3\.0\fP Note that prereleases in +the \fB1\.2\.3\fP version will be allowed, if they are greater than or +equal to \fBbeta\.2\fP\|\. So, \fB1\.2\.3\-beta\.4\fP would be allowed, but +\fB1\.2\.4\-beta\.2\fP would not, because it is a prerelease of a +different \fB[major, minor, patch]\fP tuple\. .RE -.SS Caret Ranges \fB^1\.2\.3\fR \fB^0\.2\.5\fR \fB^0\.0\.4\fR +.SS Caret Ranges \fB^1\.2\.3\fP \fB^0\.2\.5\fP \fB^0\.0\.4\fP .P Allows changes that do not modify the left\-most non\-zero digit in the -\fB[major, minor, patch]\fR tuple\. In other words, this allows patch and -minor updates for versions \fB1\.0\.0\fR and above, patch updates for -versions \fB0\.X >=0\.1\.0\fR, and \fIno\fR updates for versions \fB0\.0\.X\fR\|\. +\fB[major, minor, patch]\fP tuple\. In other words, this allows patch and +minor updates for versions \fB1\.0\.0\fP and above, patch updates for +versions \fB0\.X >=0\.1\.0\fP, and \fIno\fR updates for versions \fB0\.0\.X\fP\|\. .P -Many authors treat a \fB0\.x\fR version as if the \fBx\fR were the major +Many authors treat a \fB0\.x\fP version as if the \fBx\fP were the major "breaking\-change" indicator\. .P Caret ranges are ideal when an author may make breaking changes -between \fB0\.2\.4\fR and \fB0\.3\.0\fR releases, which is a common practice\. +between \fB0\.2\.4\fP and \fB0\.3\.0\fP releases, which is a common practice\. However, it presumes that there will \fInot\fR be breaking changes between -\fB0\.2\.4\fR and \fB0\.2\.5\fR\|\. It allows for changes that are presumed to be +\fB0\.2\.4\fP and \fB0\.2\.5\fP\|\. It allows for changes that are presumed to be additive (but non\-breaking), according to commonly observed practices\. .RS 0 .IP \(bu 2 -\fB^1\.2\.3\fR := \fB>=1\.2\.3 <2\.0\.0\fR +\fB^1\.2\.3\fP := \fB>=1\.2\.3 <2\.0\.0\fP .IP \(bu 2 -\fB^0\.2\.3\fR := \fB>=0\.2\.3 <0\.3\.0\fR +\fB^0\.2\.3\fP := \fB>=0\.2\.3 <0\.3\.0\fP .IP \(bu 2 -\fB^0\.0\.3\fR := \fB>=0\.0\.3 <0\.0\.4\fR +\fB^0\.0\.3\fP := \fB>=0\.0\.3 <0\.0\.4\fP .IP \(bu 2 -\fB^1\.2\.3\-beta\.2\fR := \fB>=1\.2\.3\-beta\.2 <2\.0\.0\fR Note that prereleases in -the \fB1\.2\.3\fR version will be allowed, if they are greater than or -equal to \fBbeta\.2\fR\|\. So, \fB1\.2\.3\-beta\.4\fR would be allowed, but -\fB1\.2\.4\-beta\.2\fR would not, because it is a prerelease of a -different \fB[major, minor, patch]\fR tuple\. +\fB^1\.2\.3\-beta\.2\fP := \fB>=1\.2\.3\-beta\.2 <2\.0\.0\fP Note that prereleases in +the \fB1\.2\.3\fP version will be allowed, if they are greater than or +equal to \fBbeta\.2\fP\|\. So, \fB1\.2\.3\-beta\.4\fP would be allowed, but +\fB1\.2\.4\-beta\.2\fP would not, because it is a prerelease of a +different \fB[major, minor, patch]\fP tuple\. .IP \(bu 2 -\fB^0\.0\.3\-beta\fR := \fB>=0\.0\.3\-beta <0\.0\.4\fR Note that prereleases in the -\fB0\.0\.3\fR version \fIonly\fR will be allowed, if they are greater than or -equal to \fBbeta\fR\|\. So, \fB0\.0\.3\-pr\.2\fR would be allowed\. +\fB^0\.0\.3\-beta\fP := \fB>=0\.0\.3\-beta <0\.0\.4\fP Note that prereleases in the +\fB0\.0\.3\fP version \fIonly\fR will be allowed, if they are greater than or +equal to \fBbeta\fP\|\. So, \fB0\.0\.3\-pr\.2\fP would be allowed\. .RE .P -When parsing caret ranges, a missing \fBpatch\fR value desugars to the -number \fB0\fR, but will allow flexibility within that value, even if the -major and minor versions are both \fB0\fR\|\. +When parsing caret ranges, a missing \fBpatch\fP value desugars to the +number \fB0\fP, but will allow flexibility within that value, even if the +major and minor versions are both \fB0\fP\|\. .RS 0 .IP \(bu 2 -\fB^1\.2\.x\fR := \fB>=1\.2\.0 <2\.0\.0\fR +\fB^1\.2\.x\fP := \fB>=1\.2\.0 <2\.0\.0\fP .IP \(bu 2 -\fB^0\.0\.x\fR := \fB>=0\.0\.0 <0\.1\.0\fR +\fB^0\.0\.x\fP := \fB>=0\.0\.0 <0\.1\.0\fP .IP \(bu 2 -\fB^0\.0\fR := \fB>=0\.0\.0 <0\.1\.0\fR +\fB^0\.0\fP := \fB>=0\.0\.0 <0\.1\.0\fP .RE .P -A missing \fBminor\fR and \fBpatch\fR values will desugar to zero, but also +A missing \fBminor\fP and \fBpatch\fP values will desugar to zero, but also allow flexibility within those values, even if the major version is zero\. .RS 0 .IP \(bu 2 -\fB^1\.x\fR := \fB>=1\.0\.0 <2\.0\.0\fR +\fB^1\.x\fP := \fB>=1\.0\.0 <2\.0\.0\fP .IP \(bu 2 -\fB^0\.x\fR := \fB>=0\.0\.0 <1\.0\.0\fR +\fB^0\.x\fP := \fB>=0\.0\.0 <1\.0\.0\fP .RE .SH Functions .P -All methods and classes take a final \fBloose\fR boolean argument that, if +All methods and classes take a final \fBloose\fP boolean argument that, if true, will be more forgiving about not\-quite\-valid semver strings\. The resulting output will always be 100% strict, of course\. .P @@ -294,96 +294,96 @@ Strict\-mode Comparators and Ranges will be strict about the SemVer strings that they parse\. .RS 0 .IP \(bu 2 -\fBvalid(v)\fR: Return the parsed version, or null if it's not valid\. +\fBvalid(v)\fP: Return the parsed version, or null if it's not valid\. .IP \(bu 2 -\fBinc(v, release)\fR: Return the version incremented by the release -type (\fBmajor\fR, \fBpremajor\fR, \fBminor\fR, \fBpreminor\fR, \fBpatch\fR, -\fBprepatch\fR, or \fBprerelease\fR), or null if it's not valid +\fBinc(v, release)\fP: Return the version incremented by the release +type (\fBmajor\fP, \fBpremajor\fP, \fBminor\fP, \fBpreminor\fP, \fBpatch\fP, +\fBprepatch\fP, or \fBprerelease\fP), or null if it's not valid .RS 0 .IP \(bu 2 -\fBpremajor\fR in one call will bump the version up to the next major +\fBpremajor\fP in one call will bump the version up to the next major version and down to a prerelease of that major version\. -\fBpreminor\fR, and \fBprepatch\fR work the same way\. +\fBpreminor\fP, and \fBprepatch\fP work the same way\. .IP \(bu 2 -If called from a non\-prerelease version, the \fBprerelease\fR will work the -same as \fBprepatch\fR\|\. It increments the patch version, then makes a +If called from a non\-prerelease version, the \fBprerelease\fP will work the +same as \fBprepatch\fP\|\. It increments the patch version, then makes a prerelease\. If the input version is already a prerelease it simply increments it\. .RE .IP \(bu 2 -\fBmajor(v)\fR: Return the major version number\. +\fBmajor(v)\fP: Return the major version number\. .IP \(bu 2 -\fBminor(v)\fR: Return the minor version number\. +\fBminor(v)\fP: Return the minor version number\. .IP \(bu 2 -\fBpatch(v)\fR: Return the patch version number\. +\fBpatch(v)\fP: Return the patch version number\. .RE .SS Comparison .RS 0 .IP \(bu 2 -\fBgt(v1, v2)\fR: \fBv1 > v2\fR +\fBgt(v1, v2)\fP: \fBv1 > v2\fP .IP \(bu 2 -\fBgte(v1, v2)\fR: \fBv1 >= v2\fR +\fBgte(v1, v2)\fP: \fBv1 >= v2\fP .IP \(bu 2 -\fBlt(v1, v2)\fR: \fBv1 < v2\fR +\fBlt(v1, v2)\fP: \fBv1 < v2\fP .IP \(bu 2 -\fBlte(v1, v2)\fR: \fBv1 <= v2\fR +\fBlte(v1, v2)\fP: \fBv1 <= v2\fP .IP \(bu 2 -\fBeq(v1, v2)\fR: \fBv1 == v2\fR This is true if they're logically equivalent, +\fBeq(v1, v2)\fP: \fBv1 == v2\fP 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 2 -\fBneq(v1, v2)\fR: \fBv1 != v2\fR The opposite of \fBeq\fR\|\. +\fBneq(v1, v2)\fP: \fBv1 != v2\fP The opposite of \fBeq\fP\|\. .IP \(bu 2 -\fBcmp(v1, comparator, v2)\fR: Pass in a comparison string, and it'll call -the corresponding function above\. \fB"==="\fR and \fB"!=="\fR do simple +\fBcmp(v1, comparator, v2)\fP: Pass in a comparison string, and it'll call +the corresponding function above\. \fB"==="\fP and \fB"!=="\fP do simple string comparison, but are included for completeness\. Throws if an invalid comparison string is provided\. .IP \(bu 2 -\fBcompare(v1, v2)\fR: Return \fB0\fR if \fBv1 == v2\fR, or \fB1\fR if \fBv1\fR is greater, or \fB\-1\fR if -\fBv2\fR is greater\. Sorts in ascending order if passed to \fBArray\.sort()\fR\|\. +\fBcompare(v1, v2)\fP: Return \fB0\fP if \fBv1 == v2\fP, or \fB1\fP if \fBv1\fP is greater, or \fB\-1\fP if +\fBv2\fP is greater\. Sorts in ascending order if passed to \fBArray\.sort()\fP\|\. .IP \(bu 2 -\fBrcompare(v1, v2)\fR: The reverse of compare\. Sorts an array of versions -in descending order when passed to \fBArray\.sort()\fR\|\. +\fBrcompare(v1, v2)\fP: The reverse of compare\. Sorts an array of versions +in descending order when passed to \fBArray\.sort()\fP\|\. .IP \(bu 2 -\fBdiff(v1, v2)\fR: Returns difference between two versions by the release type -(\fBmajor\fR, \fBpremajor\fR, \fBminor\fR, \fBpreminor\fR, \fBpatch\fR, \fBprepatch\fR, or \fBprerelease\fR), +\fBdiff(v1, v2)\fP: Returns difference between two versions by the release type +(\fBmajor\fP, \fBpremajor\fP, \fBminor\fP, \fBpreminor\fP, \fBpatch\fP, \fBprepatch\fP, or \fBprerelease\fP), or null if the versions are the same\. .RE .SS Ranges .RS 0 .IP \(bu 2 -\fBvalidRange(range)\fR: Return the valid range or null if it's not valid +\fBvalidRange(range)\fP: Return the valid range or null if it's not valid .IP \(bu 2 -\fBsatisfies(version, range)\fR: Return true if the version satisfies the +\fBsatisfies(version, range)\fP: Return true if the version satisfies the range\. .IP \(bu 2 -\fBmaxSatisfying(versions, range)\fR: Return the highest version in the list -that satisfies the range, or \fBnull\fR if none of them do\. +\fBmaxSatisfying(versions, range)\fP: Return the highest version in the list +that satisfies the range, or \fBnull\fP if none of them do\. .IP \(bu 2 -\fBgtr(version, range)\fR: Return \fBtrue\fR if version is greater than all the +\fBgtr(version, range)\fP: Return \fBtrue\fP if version is greater than all the versions possible in the range\. .IP \(bu 2 -\fBltr(version, range)\fR: Return \fBtrue\fR if version is less than all the +\fBltr(version, range)\fP: Return \fBtrue\fP if version is less than all the versions possible in the range\. .IP \(bu 2 -\fBoutside(version, range, hilo)\fR: Return true if the version is outside +\fBoutside(version, range, hilo)\fP: Return true if the version is outside the bounds of the range in either the high or low direction\. The -\fBhilo\fR argument must be either the string \fB\|'>'\fR or \fB\|'<'\fR\|\. (This is -the function called by \fBgtr\fR and \fBltr\fR\|\.) +\fBhilo\fP argument must be either the string \fB\|'>'\fP or \fB\|'<'\fP\|\. (This is +the function called by \fBgtr\fP and \fBltr\fP\|\.) .RE .P Note that, since ranges may be non\-contiguous, a version might not be greater than a range, less than a range, \fIor\fR satisfy a range! For -example, the range \fB1\.2 <1\.2\.9 || >2\.0\.0\fR would have a hole from \fB1\.2\.9\fR -until \fB2\.0\.0\fR, so the version \fB1\.2\.10\fR would not be greater than the -range (because \fB2\.0\.1\fR satisfies, which is higher), nor less than the -range (since \fB1\.2\.8\fR satisfies, which is lower), and it also does not +example, the range \fB1\.2 <1\.2\.9 || >2\.0\.0\fP would have a hole from \fB1\.2\.9\fP +until \fB2\.0\.0\fP, so the version \fB1\.2\.10\fP would not be greater than the +range (because \fB2\.0\.1\fP satisfies, which is higher), nor less than the +range (since \fB1\.2\.8\fP satisfies, which is lower), and it also does not satisfy the range\. .P If you want to know if a version satisfies or does not satisfy a -range, use the \fBsatisfies(version, range)\fR function\. +range, use the \fBsatisfies(version, range)\fP function\. |