summaryrefslogtreecommitdiff
path: root/deps/npm/man
diff options
context:
space:
mode:
Diffstat (limited to 'deps/npm/man')
-rw-r--r--deps/npm/man/man1/npm-README.127
-rw-r--r--deps/npm/man/man1/npm-ls.12
-rw-r--r--deps/npm/man/man1/npm-shrinkwrap.128
-rw-r--r--deps/npm/man/man1/npm-submodule.141
-rw-r--r--deps/npm/man/man1/npm-version.116
-rw-r--r--deps/npm/man/man1/npm.12
-rw-r--r--deps/npm/man/man3/npm-submodule.341
-rw-r--r--deps/npm/man/man3/npm.32
-rw-r--r--deps/npm/man/man7/npm-faq.714
-rw-r--r--deps/npm/man/man7/npm-scripts.76
10 files changed, 145 insertions, 34 deletions
diff --git a/deps/npm/man/man1/npm-README.1 b/deps/npm/man/man1/npm-README.1
index 09ffc12b2f..c0aa54f86e 100644
--- a/deps/npm/man/man1/npm-README.1
+++ b/deps/npm/man/man1/npm-README.1
@@ -133,16 +133,23 @@ this means that future npm installs will not remember the settings that
you have chosen\.
.SH Using npm Programmatically
.P
-If you would like to use npm programmatically, you can do that\.
-It's not very well documented, but it \fIis\fR rather simple\.
-.P
-Most of the time, unless you actually want to do all the things that
-npm does, you should try using one of npm's dependencies rather than
-using npm itself, if possible\.
-.P
-Eventually, npm will be just a thin cli wrapper around the modules
-that it depends on, but for now, there are some things that you must
-use npm itself to do\.
+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\.
+.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
+npm's version indicates no breaking changes have been made according to
+semver\.\fR
+.P
+If you \fIstill\fR would like to use npm programmatically, it's \fIpossible\fR\|\. The API
+isn't very well documented, but it \fIis\fR rather simple\.
+.P
+Eventually, npm will be just a thin CLI wrapper around the modules that it
+depends on, but for now, there are some things that only the CLI can do\. You
+should try using one of npm's dependencies first, and only use the API if what
+you're trying to do is only supported by npm itself\.
.P
.RS 2
.nf
diff --git a/deps/npm/man/man1/npm-ls.1 b/deps/npm/man/man1/npm-ls.1
index 32f13d8ef5..8b6510cda4 100644
--- a/deps/npm/man/man1/npm-ls.1
+++ b/deps/npm/man/man1/npm-ls.1
@@ -23,7 +23,7 @@ For example, running \fBnpm ls promzard\fR in npm's source tree will show:
.P
.RS 2
.nf
-npm@2.10.1 /path/to/npm
+npm@2.11.0 /path/to/npm
└─┬ init\-package\-json@0\.0\.4
└── promzard@0\.1\.5
.fi
diff --git a/deps/npm/man/man1/npm-shrinkwrap.1 b/deps/npm/man/man1/npm-shrinkwrap.1
index 98440e0247..9124d2633b 100644
--- a/deps/npm/man/man1/npm-shrinkwrap.1
+++ b/deps/npm/man/man1/npm-shrinkwrap.1
@@ -16,14 +16,14 @@ used when your package is installed\. The \fBpackage\.json\fR file is still
required if you want to use \fBnpm install\fR\|\.
.P
By default, \fBnpm install\fR recursively installs the target's
-dependencies (as specified in package\.json), choosing the latest
+dependencies (as specified in \fBpackage\.json\fR), 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 package\.json would facilitate this, but that's not always
+dependency's \fBpackage\.json\fR 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\.
@@ -61,7 +61,7 @@ and package C:
.RS 2
.nf
{
- "name": "C,
+ "name": "C",
"version": "0\.0\.1"
}
.fi
@@ -105,7 +105,7 @@ npm shrinkwrap
.fi
.RE
.P
-This generates npm\-shrinkwrap\.json, which will look something like this:
+This generates \fBnpm\-shrinkwrap\.json\fR, which will look something like this:
.P
.RS 2
.nf
@@ -128,18 +128,18 @@ This generates npm\-shrinkwrap\.json, which will look something like this:
.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 a npm\-shrinkwrap\.json file in the package
-root, the shrinkwrap file (rather than package\.json files) completely
+installs a package with an \fBnpm\-shrinkwrap\.json\fR in the package
+root, the shrinkwrap file (rather than \fBpackage\.json\fR 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 package\.json
+dependencies and versions listed in A's, B's, and C's \fBpackage\.json\fR
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
-package\.json file and \fBnpm install\fR it\.
+\fBpackage\.json\fR file and \fBnpm install\fR it\.
.SS Building shrinkwrapped packages
.P
To shrinkwrap an existing package:
@@ -150,7 +150,7 @@ 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 npm\-shrinkwrap\.json to git, and publish
+Run \fBnpm shrinkwrap\fR, add \fBnpm\-shrinkwrap\.json\fR to git, and publish
your package\.
.RE
@@ -162,7 +162,7 @@ Run \fBnpm install\fR 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 package\.json\. Note that they
+package individually and then update \fBpackage\.json\fR\|\. Note that they
must be explicitly named in order to be installed: running \fBnpm
install\fR with no arguments will merely reproduce the existing
shrinkwrap\.
@@ -170,7 +170,7 @@ shrinkwrap\.
Validate that the package works as expected with the new
dependencies\.
.IP 4. 3
-Run \fBnpm shrinkwrap\fR, commit the new npm\-shrinkwrap\.json, and
+Run \fBnpm shrinkwrap\fR, commit the new \fBnpm\-shrinkwrap\.json\fR, and
publish your package\.
.RE
@@ -179,12 +179,12 @@ 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 package\.json
+A shrinkwrap file must be consistent with the package's \fBpackage\.json\fR
file\. \fBnpm shrinkwrap\fR 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 package\.json), since that would
-indicate that package\.json is not correct\.
+extraneous packages (not referenced by \fBpackage\.json\fR), since that would
+indicate that \fBpackage\.json\fR 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
diff --git a/deps/npm/man/man1/npm-submodule.1 b/deps/npm/man/man1/npm-submodule.1
new file mode 100644
index 0000000000..771f0c0a22
--- /dev/null
+++ b/deps/npm/man/man1/npm-submodule.1
@@ -0,0 +1,41 @@
+.\" Generated with Ronnjs 0.3.8
+.\" http://github.com/kapouer/ronnjs/
+.
+.TH "NPM\-SUBMODULE" "1" "September 2014" "" ""
+.
+.SH "NAME"
+\fBnpm-submodule\fR \-\- Add a package as a git submodule
+.
+.SH "SYNOPSIS"
+.
+.nf
+npm submodule <pkg>
+.
+.fi
+.
+.SH "DESCRIPTION"
+If the specified package has a git repository url in its package\.json
+description, then this command will add it as a git submodule at \fBnode_modules/<pkg name>\fR\|\.
+.
+.P
+This is a convenience only\. From then on, it\'s up to you to manage
+updates by using the appropriate git commands\. npm will stubbornly
+refuse to update, modify, or remove anything with a \fB\|\.git\fR subfolder
+in it\.
+.
+.P
+This command also does not install missing dependencies, if the package
+does not include them in its git repository\. If \fBnpm ls\fR reports that
+things are missing, you can either install, link, or submodule them yourself,
+or you can do \fBnpm explore <pkgname> \-\- npm install\fR to install the
+dependencies into the submodule folder\.
+.
+.SH "SEE ALSO"
+.
+.IP "\(bu" 4
+npm help 5 package\.json
+.
+.IP "\(bu" 4
+git help submodule
+.
+.IP "" 0
diff --git a/deps/npm/man/man1/npm-version.1 b/deps/npm/man/man1/npm-version.1
index 8fbfd4d071..914adfffeb 100644
--- a/deps/npm/man/man1/npm-version.1
+++ b/deps/npm/man/man1/npm-version.1
@@ -50,6 +50,18 @@ user: "isaacs (http://blog\.izs\.me/) <i@izs\.me>"
Enter passphrase:
.fi
.RE
+.P
+If "preversion", "version", "postversion" in the "scripts" property of
+the package\.json, it will execute by running \fBnpm version\fR\|\. preversion
+and version ware executed before bump the package version, postversion
+was executed after bump the package version\. For example to run \fBnpm version\fR
+after passed all test:
+.P
+.RS 2
+.nf
+"scripts": { "preversion": "npm test" }
+.fi
+.RE
.SH CONFIGURATION
.SS git\-tag\-version
.RS 0
@@ -66,6 +78,10 @@ Commit and tag the version change\.
.IP \(bu 2
npm help init
.IP \(bu 2
+npm help run\-script
+.IP \(bu 2
+npm help 7 scripts
+.IP \(bu 2
npm help 5 package\.json
.IP \(bu 2
npm help 7 semver
diff --git a/deps/npm/man/man1/npm.1 b/deps/npm/man/man1/npm.1
index 9305fef29d..27b0a03360 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.10.1
+2.11.0
.SH DESCRIPTION
.P
npm is the package manager for the Node JavaScript platform\. It puts
diff --git a/deps/npm/man/man3/npm-submodule.3 b/deps/npm/man/man3/npm-submodule.3
new file mode 100644
index 0000000000..d2e23d7e8f
--- /dev/null
+++ b/deps/npm/man/man3/npm-submodule.3
@@ -0,0 +1,41 @@
+.\" Generated with Ronnjs 0.3.8
+.\" http://github.com/kapouer/ronnjs/
+.
+.TH "NPM\-SUBMODULE" "3" "September 2014" "" ""
+.
+.SH "NAME"
+\fBnpm-submodule\fR \-\- Add a package as a git submodule
+.
+.SH "SYNOPSIS"
+.
+.nf
+npm\.commands\.submodule(packages, callback)
+.
+.fi
+.
+.SH "DESCRIPTION"
+For each package specified, npm will check if it has a git repository url
+in its package\.json description then add it as a git submodule at \fBnode_modules/<pkg name>\fR\|\.
+.
+.P
+This is a convenience only\. From then on, it\'s up to you to manage
+updates by using the appropriate git commands\. npm will stubbornly
+refuse to update, modify, or remove anything with a \fB\|\.git\fR subfolder
+in it\.
+.
+.P
+This command also does not install missing dependencies, if the package
+does not include them in its git repository\. If \fBnpm ls\fR reports that
+things are missing, you can either install, link, or submodule them yourself,
+or you can do \fBnpm explore <pkgname> \-\- npm install\fR to install the
+dependencies into the submodule folder\.
+.
+.SH "SEE ALSO"
+.
+.IP "\(bu" 4
+npm help json
+.
+.IP "\(bu" 4
+git help submodule
+.
+.IP "" 0
diff --git a/deps/npm/man/man3/npm.3 b/deps/npm/man/man3/npm.3
index 7fd9d79b9c..0c41d2ad53 100644
--- a/deps/npm/man/man3/npm.3
+++ b/deps/npm/man/man3/npm.3
@@ -20,7 +20,7 @@ npm\.load([configObject, ]function (er, npm) {
.RE
.SH VERSION
.P
-2.10.1
+2.11.0
.SH DESCRIPTION
.P
This is the API documentation for npm\.
diff --git a/deps/npm/man/man7/npm-faq.7 b/deps/npm/man/man7/npm-faq.7
index 30391e7f2d..6958109a28 100644
--- a/deps/npm/man/man7/npm-faq.7
+++ b/deps/npm/man/man7/npm-faq.7
@@ -351,9 +351,9 @@ 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\. npm is a mostly
-anarchic system\. There is not sufficient need to impose namespace rules on
-everyone\.
+you may: simply use the \fB\-\fR 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
As of 2\.0, npm supports scoped packages, which allow you to publish a group of
related modules without worrying about name collisions\.
@@ -363,11 +363,11 @@ user named \fBnpm\fR owns the scope \fB@npm\fR\|\. Scoped packages are publishe
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\|\.
.P
-Scoped packages can coexist with public npm packages in a private npm registry\.
-At present (2014\-11\-04) scoped packages may NOT be published to the public npm
-registry\.
+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
+scoped and un\-scoped registries at the same time\.
.P
-Unscoped packages can only depend on other unscoped packages\. Scoped packages
+Unscoped packages can only depend on other unscoped packages\. Scoped packages
can depend on packages from their own scope, a different scope, or the public
registry (unscoped)\.
.P
diff --git a/deps/npm/man/man7/npm-scripts.7 b/deps/npm/man/man7/npm-scripts.7
index 46ab09ed4c..055b5bfd7d 100644
--- a/deps/npm/man/man7/npm-scripts.7
+++ b/deps/npm/man/man7/npm-scripts.7
@@ -26,6 +26,12 @@ Run BEFORE the package is uninstalled\.
postuninstall:
Run AFTER the package is uninstalled\.
.IP \(bu 2
+preversion, version:
+Run BEFORE bump the package version\.
+.IP \(bu 2
+postversion:
+Run AFTER bump the package version\.
+.IP \(bu 2
pretest, test, posttest:
Run by the \fBnpm test\fR command\.
.IP \(bu 2