summaryrefslogtreecommitdiff
path: root/deps/npm/doc
diff options
context:
space:
mode:
Diffstat (limited to 'deps/npm/doc')
-rw-r--r--deps/npm/doc/cli/npm-adduser.md10
-rw-r--r--deps/npm/doc/cli/npm-bugs.md2
-rw-r--r--deps/npm/doc/cli/npm-config.md2
-rw-r--r--deps/npm/doc/cli/npm-dedupe.md2
-rw-r--r--deps/npm/doc/cli/npm-dist-tag.md2
-rw-r--r--deps/npm/doc/cli/npm-help-search.md2
-rw-r--r--deps/npm/doc/cli/npm-install.md9
-rw-r--r--deps/npm/doc/cli/npm-link.md11
-rw-r--r--deps/npm/doc/cli/npm-logout.md9
-rw-r--r--deps/npm/doc/cli/npm-owner.md2
-rw-r--r--deps/npm/doc/cli/npm-search.md11
-rw-r--r--deps/npm/doc/cli/npm-test.md3
-rw-r--r--deps/npm/doc/cli/npm-update.md8
-rw-r--r--deps/npm/doc/cli/npm.md8
-rw-r--r--deps/npm/doc/files/package.json.md31
-rw-r--r--deps/npm/doc/misc/npm-config.md8
-rw-r--r--deps/npm/doc/misc/npm-scope.md2
17 files changed, 91 insertions, 31 deletions
diff --git a/deps/npm/doc/cli/npm-adduser.md b/deps/npm/doc/cli/npm-adduser.md
index 24d3611e61..9afece598f 100644
--- a/deps/npm/doc/cli/npm-adduser.md
+++ b/deps/npm/doc/cli/npm-adduser.md
@@ -5,6 +5,8 @@ npm-adduser(1) -- Add a registry user account
npm adduser [--registry=url] [--scope=@orgname] [--always-auth]
+ aliases: login, add-user
+
## DESCRIPTION
Create or verify a user named `<username>` in the specified registry, and
@@ -57,9 +59,11 @@ registries. Can be used with `--registry` and / or `--scope`, e.g.
npm adduser --registry=http://private-registry.example.com --always-auth
This will ensure that all requests to that registry (including for tarballs)
-include an authorization header. See `always-auth` in `npm-config(7)` for more
-details on always-auth. Registry-specific configuration of `always-auth` takes
-precedence over any global configuration.
+include an authorization header. This setting may be necessary for use with
+private registries where metadata and package tarballs are stored on hosts with
+different hostnames. See `always-auth` in `npm-config(7)` for more details on
+always-auth. Registry-specific configuration of `always-auth` takes precedence
+over any global configuration.
## SEE ALSO
diff --git a/deps/npm/doc/cli/npm-bugs.md b/deps/npm/doc/cli/npm-bugs.md
index d2ad534fa3..55bce12f23 100644
--- a/deps/npm/doc/cli/npm-bugs.md
+++ b/deps/npm/doc/cli/npm-bugs.md
@@ -5,6 +5,8 @@ npm-bugs(1) -- Bugs for a package in a web browser maybe
npm bugs [<pkgname>]
+ aliases: issues
+
## DESCRIPTION
This command tries to guess at the likely location of a package's
diff --git a/deps/npm/doc/cli/npm-config.md b/deps/npm/doc/cli/npm-config.md
index ec5c4eb14b..5aecb2c3ac 100644
--- a/deps/npm/doc/cli/npm-config.md
+++ b/deps/npm/doc/cli/npm-config.md
@@ -11,6 +11,8 @@ npm-config(1) -- Manage the npm configuration files
npm get <key>
npm set <key> <value> [-g|--global]
+ aliases: c
+
## DESCRIPTION
npm gets its config settings from the command line, environment
diff --git a/deps/npm/doc/cli/npm-dedupe.md b/deps/npm/doc/cli/npm-dedupe.md
index ed8dca81f5..d68832145f 100644
--- a/deps/npm/doc/cli/npm-dedupe.md
+++ b/deps/npm/doc/cli/npm-dedupe.md
@@ -6,6 +6,8 @@ npm-dedupe(1) -- Reduce duplication
npm dedupe
npm ddp
+ aliases: find-dupes, ddp
+
## DESCRIPTION
Searches the local package tree and attempts to simplify the overall
diff --git a/deps/npm/doc/cli/npm-dist-tag.md b/deps/npm/doc/cli/npm-dist-tag.md
index 06721bbae6..a88fc35a5e 100644
--- a/deps/npm/doc/cli/npm-dist-tag.md
+++ b/deps/npm/doc/cli/npm-dist-tag.md
@@ -7,6 +7,8 @@ npm-dist-tag(1) -- Modify package distribution tags
npm dist-tag rm <pkg> <tag>
npm dist-tag ls [<pkg>]
+ aliases: dist-tags
+
## DESCRIPTION
Add, remove, and enumerate distribution tags on a package:
diff --git a/deps/npm/doc/cli/npm-help-search.md b/deps/npm/doc/cli/npm-help-search.md
index 0a40f1c43b..f1d883acd9 100644
--- a/deps/npm/doc/cli/npm-help-search.md
+++ b/deps/npm/doc/cli/npm-help-search.md
@@ -21,7 +21,7 @@ command directly.
### long
* Type: Boolean
-* Default false
+* Default: false
If true, the "long" flag will cause help-search to output context around
where the terms were found in the documentation.
diff --git a/deps/npm/doc/cli/npm-install.md b/deps/npm/doc/cli/npm-install.md
index eca4e2c3bf..f9c54c056a 100644
--- a/deps/npm/doc/cli/npm-install.md
+++ b/deps/npm/doc/cli/npm-install.md
@@ -13,7 +13,7 @@ npm-install(1) -- Install a package
npm install <folder>
alias: npm i
- common options: [-S|--save|-D|--save-dev|-O|--save-optional] [-E|--save-exact] [--dry-run]
+ common options: [-S|--save|-D|--save-dev|-O|--save-optional] [-E|--save-exact] [-B|--save-bundle] [--dry-run]
## DESCRIPTION
@@ -97,12 +97,14 @@ after packing it up into a tarball (b).
* `-O, --save-optional`: Package will appear in your `optionalDependencies`.
When using any of the above options to save dependencies to your
- package.json, there is an additional, optional flag:
+ package.json, there are two additional, optional flags:
* `-E, --save-exact`: Saved dependencies will be configured with an
exact version rather than using npm's default semver range
operator.
+ * `-B, --save-bundle`: Saved dependencies will also be added to your `bundleDependencies` list.
+
Further, if you have an `npm-shrinkwrap.json` then it will be updated as
well.
@@ -122,6 +124,7 @@ after packing it up into a tarball (b).
npm install node-tap --save-dev
npm install dtrace-provider --save-optional
npm install readable-stream --save --save-exact
+ npm install ansi-regex --save --save-bundle
**Note**: If there is a file or folder named `<name>` in the current
@@ -266,7 +269,7 @@ The `--global-style` argument will cause npm to install the package into
your local `node_modules` folder with the same layout it uses with the
global `node_modules` folder. Only your direct dependencies will show in
`node_modules` and everything they depend on will be flattened in their
-`node_modules` folders. This obviously will elminate some deduping.
+`node_modules` folders. This obviously will eliminate some deduping.
The `--legacy-bundling` argument will cause npm to install the package such
that versions of npm prior to 1.4, such as the one included with node 0.8,
diff --git a/deps/npm/doc/cli/npm-link.md b/deps/npm/doc/cli/npm-link.md
index 344fcbf1a7..b5749f889c 100644
--- a/deps/npm/doc/cli/npm-link.md
+++ b/deps/npm/doc/cli/npm-link.md
@@ -12,12 +12,13 @@ npm-link(1) -- Symlink a package folder
Package linking is a two-step process.
-First, `npm link` in a package folder will create a globally-installed
-symbolic link from `prefix/package-name` to the current folder (see
-`npm-config(7)` for the value of `prefix`).
+First, `npm link` in a package folder will create a symlink in the global folder
+`{prefix}/lib/node_modules/<package>` that links to the package where the `npm
+link` command was executed. (see `npm-config(7)` for the value of `prefix`).
Next, in some other location, `npm link package-name` will create a
-symlink from the local `node_modules` folder to the global symlink.
+symbolic link from globally-installed `package-name` to `node_modules/`
+of the current folder.
Note that `package-name` is taken from `package.json`,
not from directory name.
@@ -40,7 +41,7 @@ For example:
Now, any changes to ~/projects/node-redis will be reflected in
~/projects/node-bloggy/node_modules/node-redis/. Note that the link should
-be to the package name, not the directory name for that package.
+be to the package name, not the directory name for that package.
You may also shortcut the two steps in one. For example, to do the
above use-case in a shorter way:
diff --git a/deps/npm/doc/cli/npm-logout.md b/deps/npm/doc/cli/npm-logout.md
index 59f49cc25a..0841adfbf8 100644
--- a/deps/npm/doc/cli/npm-logout.md
+++ b/deps/npm/doc/cli/npm-logout.md
@@ -31,14 +31,9 @@ it takes precedence.
Default: none
-If specified, the user and login credentials given will be associated
-with the specified scope. See `npm-scope(7)`. You can use both at the same time,
-e.g.
+If specified, you will be logged out of the specified scope. See `npm-scope(7)`.
- npm adduser --registry=http://myregistry.example.com --scope=@myco
-
-This will set a registry for the given scope and login or create a user for
-that registry at the same time.
+ npm logout --scope=@myco
## SEE ALSO
diff --git a/deps/npm/doc/cli/npm-owner.md b/deps/npm/doc/cli/npm-owner.md
index 1047a09bb8..43929cb332 100644
--- a/deps/npm/doc/cli/npm-owner.md
+++ b/deps/npm/doc/cli/npm-owner.md
@@ -7,6 +7,8 @@ npm-owner(1) -- Manage package owners
npm owner rm <user> [<@scope>/]<pkg>
npm owner ls [<@scope>/]<pkg>
+ aliases: author
+
## DESCRIPTION
Manage ownership of published packages.
diff --git a/deps/npm/doc/cli/npm-search.md b/deps/npm/doc/cli/npm-search.md
index a14b9c353d..78967f14eb 100644
--- a/deps/npm/doc/cli/npm-search.md
+++ b/deps/npm/doc/cli/npm-search.md
@@ -5,7 +5,7 @@ npm-search(1) -- Search for packages
npm search [-l|--long] [search terms ...]
- aliases: s, se
+ aliases: s, se, find
## DESCRIPTION
@@ -27,6 +27,15 @@ lines. When disabled (default) search results are truncated to fit
neatly on a single line. Modules with extremely long names will
fall on multiple lines.
+### registry
+
+ * Default: https://registry.npmjs.org/
+ * Type : url
+
+Search the specified registry for modules. If you have configured npm to point to a different default registry,
+such as your internal private module repository, `npm search` will default to that registry when searching.
+Pass a different registry url such as the default above in order to override this setting.
+
## SEE ALSO
* npm-registry(7)
diff --git a/deps/npm/doc/cli/npm-test.md b/deps/npm/doc/cli/npm-test.md
index c2267082df..fe746cc73f 100644
--- a/deps/npm/doc/cli/npm-test.md
+++ b/deps/npm/doc/cli/npm-test.md
@@ -4,7 +4,8 @@ npm-test(1) -- Test a package
## SYNOPSIS
npm test [-- <args>]
- npm tst [-- <args>]
+
+ aliases: t, tst
## DESCRIPTION
diff --git a/deps/npm/doc/cli/npm-update.md b/deps/npm/doc/cli/npm-update.md
index 5271ac16d3..d6ec30d2ae 100644
--- a/deps/npm/doc/cli/npm-update.md
+++ b/deps/npm/doc/cli/npm-update.md
@@ -5,6 +5,8 @@ npm-update(1) -- Update a package
npm update [-g] [<pkg>...]
+ aliases: up, upgrade
+
## DESCRIPTION
This command will update all the packages listed to the latest version
@@ -22,7 +24,7 @@ or local) will be updated.
As of `npm@2.6.1`, the `npm update` will only inspect top-level packages.
Prior versions of `npm` would also recursively inspect all dependencies.
-To get the old behavior, use `npm --depth Infinity update`.
+To get the old behavior, use `npm --depth 9999 update`.
## EXAMPLES
@@ -36,7 +38,7 @@ on dependencies, `dep1` (`dep2`, .. etc.). The published versions of `dep1` are
```
{
"dist-tags": { "latest": "1.2.2" },
- "versions": {
+ "versions": [
"1.2.2",
"1.2.1",
"1.2.0",
@@ -46,7 +48,7 @@ on dependencies, `dep1` (`dep2`, .. etc.). The published versions of `dep1` are
"0.4.1",
"0.4.0",
"0.2.0"
- }
+ ]
}
```
diff --git a/deps/npm/doc/cli/npm.md b/deps/npm/doc/cli/npm.md
index 9746a15fc0..6c4cdd42bb 100644
--- a/deps/npm/doc/cli/npm.md
+++ b/deps/npm/doc/cli/npm.md
@@ -127,11 +127,11 @@ Patches welcome!
Contributors are listed in npm's `package.json` file. You can view them
easily by doing `npm view npm contributors`.
-If you would like to contribute, but don't know what to work on, check
-the issues list or ask on the mailing list.
+If you would like to contribute, but don't know what to work on, read
+the contributing guidelines and check the issues list.
+* https://github.com/npm/npm/wiki/Contributing-Guidelines
* <https://github.com/npm/npm/issues>
-* <npm-@googlegroups.com>
## BUGS
@@ -139,8 +139,6 @@ When you find issues, please report them:
* web:
<https://github.com/npm/npm/issues>
-* email:
- <npm-@googlegroups.com>
Be sure to include *all* of the output from the npm command that didn't work
as expected. The `npm-debug.log` file is also helpful to provide.
diff --git a/deps/npm/doc/files/package.json.md b/deps/npm/doc/files/package.json.md
index 50d268f32d..3c61d8b88e 100644
--- a/deps/npm/doc/files/package.json.md
+++ b/deps/npm/doc/files/package.json.md
@@ -329,6 +329,11 @@ maybe, someday.
Put example scripts in here. Someday, it might be exposed in some clever way.
+### directories.test
+
+Put your tests in here. It is currently not exposed, but it might be in the
+future.
+
## repository
Specify the place where your code lives. This is helpful for people who
@@ -573,7 +578,31 @@ this. If you depend on features introduced in 1.5.2, use `">= 1.5.2 < 2"`.
## bundledDependencies
-Array of package names that will be bundled when publishing the package.
+This defines an array of package names that will be bundled when publishing
+the package.
+
+In cases where you need to preserve npm packages locally or have them
+available through a single file download, you can bundle the packages in a
+tarball file by specifying the package names in the `bundledDependencies`
+array and executing `npm pack`.
+
+For example:
+
+If we define a package.json like this:
+
+```
+{
+ "name": "awesome-web-framework",
+ "version": "1.0.0",
+ "bundledDependencies": [
+ 'renderized', 'super-streams'
+ ]
+}
+```
+we can obtain `awesome-web-framework-1.0.0.tgz` file by running `npm pack`.
+This file contains the dependencies `renderized` and `super-streams` which
+can be installed in a new project by executing `npm install
+awesome-web-framework-1.0.0.tgz`.
If this is spelled `"bundleDependencies"`, then that is also honored.
diff --git a/deps/npm/doc/misc/npm-config.md b/deps/npm/doc/misc/npm-config.md
index 3d10ddf882..0642a3010a 100644
--- a/deps/npm/doc/misc/npm-config.md
+++ b/deps/npm/doc/misc/npm-config.md
@@ -571,6 +571,14 @@ colored output if it is a TTY.
Show extended information in `npm ls` and `npm search`.
+### maxsockets
+
+* Default: 50
+* Type: Number
+
+The maximum number of connections to use per origin (protocol/host/port
+combination). Passed to the `http` `Agent` used to make the request.
+
### message
* Default: "%s"
diff --git a/deps/npm/doc/misc/npm-scope.md b/deps/npm/doc/misc/npm-scope.md
index f1e4da1f1f..7431e62129 100644
--- a/deps/npm/doc/misc/npm-scope.md
+++ b/deps/npm/doc/misc/npm-scope.md
@@ -54,7 +54,7 @@ just specifying to require the module `mypackage` in the folder called `@myorg`.
Scoped packages can be published to any registry that supports them, including
the public npm registry.
-(As of 2015-04-19, the public npm registry **does** support scoped packages)
+(As of 2015-04-19, and with npm 2.0 or better, the public npm registry **does** support scoped packages)
If you wish, you may associate a scope with a registry; see below.