summaryrefslogtreecommitdiff
path: root/deps/npm/doc
diff options
context:
space:
mode:
authorisaacs <i@izs.me>2012-05-04 15:12:47 -0700
committerisaacs <i@izs.me>2012-05-04 15:12:47 -0700
commit01d146c29f318fb3dce485e49c2541f53dc4a952 (patch)
treec659dc29764875d840e8cf6d9c194fac513a91c5 /deps/npm/doc
parent1de43149bbb8c42b80cef4c25509390f3b4000cc (diff)
parent992e3464b8997210ea7f40f03f0386f8dd4f4f86 (diff)
downloadnode-01d146c29f318fb3dce485e49c2541f53dc4a952.tar.gz
Merge remote-tracking branch 'ry/v0.6' into v0.6-merge
Conflicts: ChangeLog Makefile deps/npm/AUTHORS deps/npm/html/api/bin.html deps/npm/html/api/bugs.html deps/npm/html/api/commands.html deps/npm/html/api/config.html deps/npm/html/api/deprecate.html deps/npm/html/api/docs.html deps/npm/html/api/edit.html deps/npm/html/api/explore.html deps/npm/html/api/help-search.html deps/npm/html/api/init.html deps/npm/html/api/install.html deps/npm/html/api/link.html deps/npm/html/api/load.html deps/npm/html/api/ls.html deps/npm/html/api/npm.html deps/npm/html/api/outdated.html deps/npm/html/api/owner.html deps/npm/html/api/pack.html deps/npm/html/api/prefix.html deps/npm/html/api/prune.html deps/npm/html/api/publish.html deps/npm/html/api/rebuild.html deps/npm/html/api/restart.html deps/npm/html/api/root.html deps/npm/html/api/run-script.html deps/npm/html/api/search.html deps/npm/html/api/shrinkwrap.html deps/npm/html/api/start.html deps/npm/html/api/stop.html deps/npm/html/api/submodule.html deps/npm/html/api/tag.html deps/npm/html/api/test.html deps/npm/html/api/uninstall.html deps/npm/html/api/unpublish.html deps/npm/html/api/update.html deps/npm/html/api/version.html deps/npm/html/api/view.html deps/npm/html/api/whoami.html deps/npm/html/doc/README.html deps/npm/html/doc/adduser.html deps/npm/html/doc/bin.html deps/npm/html/doc/bugs.html deps/npm/html/doc/build.html deps/npm/html/doc/bundle.html deps/npm/html/doc/cache.html deps/npm/html/doc/changelog.html deps/npm/html/doc/coding-style.html deps/npm/html/doc/completion.html deps/npm/html/doc/config.html deps/npm/html/doc/deprecate.html deps/npm/html/doc/developers.html deps/npm/html/doc/disputes.html deps/npm/html/doc/docs.html deps/npm/html/doc/edit.html deps/npm/html/doc/explore.html deps/npm/html/doc/faq.html deps/npm/html/doc/folders.html deps/npm/html/doc/help-search.html deps/npm/html/doc/help.html deps/npm/html/doc/index.html deps/npm/html/doc/init.html deps/npm/html/doc/install.html deps/npm/html/doc/json.html deps/npm/html/doc/link.html deps/npm/html/doc/list.html deps/npm/html/doc/npm.html deps/npm/html/doc/outdated.html deps/npm/html/doc/owner.html deps/npm/html/doc/pack.html deps/npm/html/doc/prefix.html deps/npm/html/doc/prune.html deps/npm/html/doc/publish.html deps/npm/html/doc/rebuild.html deps/npm/html/doc/registry.html deps/npm/html/doc/removing-npm.html deps/npm/html/doc/restart.html deps/npm/html/doc/root.html deps/npm/html/doc/run-script.html deps/npm/html/doc/scripts.html deps/npm/html/doc/search.html deps/npm/html/doc/semver.html deps/npm/html/doc/shrinkwrap.html deps/npm/html/doc/star.html deps/npm/html/doc/start.html deps/npm/html/doc/stop.html deps/npm/html/doc/submodule.html deps/npm/html/doc/tag.html deps/npm/html/doc/test.html deps/npm/html/doc/uninstall.html deps/npm/html/doc/unpublish.html deps/npm/html/doc/update.html deps/npm/html/doc/version.html deps/npm/html/doc/view.html deps/npm/html/doc/whoami.html deps/npm/man/man1/npm.1 deps/npm/man/man3/npm.3 deps/npm/package.json doc/api/url.markdown lib/http.js src/node_version.h test/simple/test-fs-sync-fd-leak.js
Diffstat (limited to 'deps/npm/doc')
-rw-r--r--deps/npm/doc/api/ls.md6
-rw-r--r--deps/npm/doc/cli/changelog.md44
-rw-r--r--deps/npm/doc/cli/coding-style.md4
-rw-r--r--deps/npm/doc/cli/config.md72
-rw-r--r--deps/npm/doc/cli/developers.md11
-rw-r--r--deps/npm/doc/cli/index.md8
-rw-r--r--deps/npm/doc/cli/install.md130
-rw-r--r--deps/npm/doc/cli/json.md47
-rw-r--r--deps/npm/doc/cli/list.md7
-rw-r--r--deps/npm/doc/cli/scripts.md14
10 files changed, 54 insertions, 289 deletions
diff --git a/deps/npm/doc/api/ls.md b/deps/npm/doc/api/ls.md
index ed890ff14..a6c0a1382 100644
--- a/deps/npm/doc/api/ls.md
+++ b/deps/npm/doc/api/ls.md
@@ -21,12 +21,6 @@ It will print out extraneous, missing, and invalid packages.
If the silent parameter is set to true, nothing will be output to the screen,
but the data will still be returned.
-Callback is provided an error if one occurred, the full data about which
-packages are installed and which dependencies they will receive, and a
-"lite" data object which just shows which versions are installed where.
-Note that the full data object is a circular structure, so care must be
-taken if it is serialized to JSON.
-
## CONFIGURATION
### long
diff --git a/deps/npm/doc/cli/changelog.md b/deps/npm/doc/cli/changelog.md
index 64feeacda..0115405ca 100644
--- a/deps/npm/doc/cli/changelog.md
+++ b/deps/npm/doc/cli/changelog.md
@@ -3,50 +3,6 @@ npm-changelog(1) -- Changes
## HISTORY
-### 1.1.3, 1.1.4
-
-* Update request to support HTTPS-over-HTTP proxy tunneling
-* Throw on undefined envs in config settings
-* Update which to 1.0.5
-* Fix windows UNC busyloop in findPrefix
-* Bundle nested bundleDependencies properly
-* Alias adduser to add-user
-* Doc updates (Christian Howe, Henrik Hodne, Andrew Lunny)
-* ignore logfd/outfd streams in makeEnv() (Rod Vagg)
-* shrinkwrap: Behave properly with url-installed deps
-* install: Support --save with url install targets
-* Support installing naked tars or single-file modules from urls etc.
-* init: Don't add engines section
-* Don't run make clean on rebuild
-* Added missing unicode replacement (atomizer)
-
-### 1.1.2
-
-Dave Pacheco (2):
- add "npm shrinkwrap"
-
-Martin Cooper (1):
- Fix #1753 Make a copy of the cached objects we'll modify.
-
-Tim Oxley (1):
- correctly remove readme from default npm view command.
-
-Tyler Green (1):
- fix #2187 set terminal columns to Infinity if 0
-
-isaacs (19):
- update minimatch
- update request
- Experimental: single-file modules
- Fix #2172 Don't remove global mans uninstalling local pkgs
- Add --versions flag to show the version of node as well
- Support --json flag for ls output
- update request to 2.9.151
-
-### 1.1
-* Replace system tar dependency with a JS tar
-* Continue to refine
-
### 1.0
* Greatly simplified folder structure
* Install locally (bundle by default)
diff --git a/deps/npm/doc/cli/coding-style.md b/deps/npm/doc/cli/coding-style.md
index 42ac1d785..5315c575c 100644
--- a/deps/npm/doc/cli/coding-style.md
+++ b/deps/npm/doc/cli/coding-style.md
@@ -59,8 +59,8 @@ Don't use them except in four situations:
* `for (;;)` loops. They're actually required.
* null loops like: `while (something) ;` (But you'd better have a good
reason for doing that.)
-* `case "foo": doSomething(); break`
-* In front of a leading `(` or `[` at the start of the line.
+* case "foo": doSomething(); break
+* In front of a leading ( or [ at the start of the line.
This prevents the expression from being interpreted
as a function call or property access, respectively.
diff --git a/deps/npm/doc/cli/config.md b/deps/npm/doc/cli/config.md
index 3fd9cb826..2c6ca26c0 100644
--- a/deps/npm/doc/cli/config.md
+++ b/deps/npm/doc/cli/config.md
@@ -115,8 +115,6 @@ The following shorthands are parsed on the command-line:
* `-l`: `--long`
* `-desc`: `--description`
* `-S`: `--save`
-* `-D`: `--save-dev`
-* `-O`: `--save-optional`
* `-y`: `--yes`
* `-n`: `--yes false`
* `ll` and `la` commands: `ls --long`
@@ -220,28 +218,6 @@ See also the `strict-ssl` config.
The location of npm's cache directory. See `npm-cache(1)`
-### cache-max
-
-* Default: Infinity
-* Type: Number
-
-The maximum time (in seconds) to keep items in the registry cache before
-re-checking against the registry.
-
-Note that no purging is done unless the `npm cache clean` command is
-explicitly used, and that only GET requests use the cache.
-
-### cache-min
-
-* Default: 0
-* Type: Number
-
-The minimum time (in seconds) to keep items in the registry cache before
-re-checking against the registry.
-
-Note that no purging is done unless the `npm cache clean` command is
-explicitly used, and that only GET requests use the cache.
-
### color
* Default: true on Posix, false on Windows
@@ -360,13 +336,6 @@ user.
A proxy to use for outgoing https requests.
-### user-agent
-
-* Default: npm/{npm.version} node/{process.version}
-* Type: String
-
-Sets a User-Agent to the request header
-
### ignore
* Default: ""
@@ -384,7 +353,7 @@ The value `npm init` should use by default for the package version.
### init.author.name
-* Default: ""
+* Default: "0.0.0"
* Type: String
The value `npm init` should use by default for the package author's name.
@@ -403,17 +372,6 @@ The value `npm init` should use by default for the package author's email.
The value `npm init` should use by default for the package author's homepage.
-### json
-
-* Default: false
-* Type: Boolean
-
-Whether or not to output JSON data, rather than the normal output.
-
-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 `npm ls --json` is currently valid.
-
### link
* Default: false
@@ -586,24 +544,6 @@ Save installed packages to a package.json file as dependencies.
Only works if there is already a package.json file present.
-### save-dev
-
-* Default: false
-* Type: Boolean
-
-Save installed packages to a package.json file as devDependencies.
-
-Only works if there is already a package.json file present.
-
-### save-optional
-
-* Default: false
-* Type: Boolean
-
-Save installed packages to a package.json file as optionalDependencies.
-
-Only works if there is already a package.json file present.
-
### searchopts
* Default: ""
@@ -742,16 +682,6 @@ If true, output the npm version and exit successfully.
Only relevant when specified explicitly on the command line.
-### versions
-
-* Default: false
-* Type: boolean
-
-If true, output the npm version as well as node's `process.versions`
-hash, and exit successfully.
-
-Only relevant when specified explicitly on the command line.
-
### viewer
* Default: "man" on Posix, "browser" on Windows
diff --git a/deps/npm/doc/cli/developers.md b/deps/npm/doc/cli/developers.md
index 7ab905bfa..9123f35a3 100644
--- a/deps/npm/doc/cli/developers.md
+++ b/deps/npm/doc/cli/developers.md
@@ -27,23 +27,12 @@ A package is:
* d) a `<name>@<version>` that is published on the registry with (c)
* e) a `<name>@<tag>` that points to (d)
* f) a `<name>` that has a "latest" tag satisfying (e)
-* g) a `git` url that, when cloned, results in (a).
Even if you never publish your package, you can still get a lot of
benefits of using npm if you just want to write a node program (a), and
perhaps if you also want to be able to easily install it elsewhere
after packing it up into a tarball (b).
-Git urls can be of the form:
-
- git://github.com/user/project.git#commit-ish
- git+ssh://user@hostname:project.git#commit-ish
- git+http://user@hostname/project/blah.git#commit-ish
- git+https://user@hostname/project/blah.git#commit-ish
-
-The `commit-ish` can be any tag, sha, or branch which can be supplied as
-an argument to `git checkout`. The default is `master`.
-
## The package.json File
You need to have a `package.json` file in the root of your project to do
diff --git a/deps/npm/doc/cli/index.md b/deps/npm/doc/cli/index.md
index ee88f3d8f..5a9b99be1 100644
--- a/deps/npm/doc/cli/index.md
+++ b/deps/npm/doc/cli/index.md
@@ -170,10 +170,6 @@ npm-index(1) -- Index of all npm documentation
The semantic versioner for npm
-## npm-shrinkwrap(1)
-
- Lock down dependency versions
-
## npm-star(1)
Mark your favorite packages
@@ -327,10 +323,6 @@ npm-index(1) -- Index of all npm documentation
Search for packages
-## npm-shrinkwrap(3)
-
- programmatically generate package shrinkwrap file
-
## npm-start(3)
Start a package
diff --git a/deps/npm/doc/cli/install.md b/deps/npm/doc/cli/install.md
index cfa95e722..22eb8234e 100644
--- a/deps/npm/doc/cli/install.md
+++ b/deps/npm/doc/cli/install.md
@@ -7,17 +7,14 @@ npm-install(1) -- Install a package
npm install <tarball file>
npm install <tarball url>
npm install <folder>
- npm install <name> [--save|--save-dev|--save-optional]
+ npm install <name>
npm install <name>@<tag>
npm install <name>@<version>
npm install <name>@<version range>
- npm install <name>@<version range>
## DESCRIPTION
-This command installs a package, and any packages that it depends on. If the
-package has a shrinkwrap file, the installation of dependencies will be driven
-by that. See npm-shrinkwrap(1).
+This command installs a package, and any packages that it depends on.
A `package` is:
@@ -36,116 +33,88 @@ after packing it up into a tarball (b).
* `npm install` (in package directory, no arguments):
+ Install the dependencies in the local node_modules folder.
- Install the dependencies in the local node_modules folder.
-
- In global mode (ie, with `-g` or `--global` appended to the command),
- it installs the current package context (ie, the current working
- directory) as a global package.
-
+ In global mode (ie, with `-g` or `--global` appended to the command),
+ it installs the current package context (ie, the current working
+ directory) as a global package.
* `npm install <folder>`:
-
- Install a package that is sitting in a folder on the filesystem.
+ Install a package that is sitting in a folder on the filesystem.
* `npm install <tarball file>`:
+ 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 `npm link`.
- 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 `npm link`.
-
- Example:
+ Example:
- npm install ./package.tgz
+ npm install ./package.tgz
* `npm install <tarball url>`:
+ Fetch the tarball url, and then install it. In order to distinguish between
+ this and other options, the argument must start with "http://" or "https://"
- Fetch the tarball url, and then install it. In order to distinguish between
- this and other options, the argument must start with "http://" or "https://"
-
- Example:
-
- npm install https://github.com/indexzero/forever/tarball/v0.5.6
-
-* `npm install <name> [--save|--save-dev|--save-optional]`:
-
- Do a `<name>@<tag>` install, where `<tag>` is the "tag" config. (See
- `npm-config(1)`.)
+ Example:
- In most cases, this will install the latest version
- of the module published on npm.
+ npm install https://github.com/indexzero/forever/tarball/v0.5.6
- Example:
+* `npm install <name>`:
+ Do a `<name>@<tag>` install, where `<tag>` is the "tag" config. (See
+ `npm-config(1)`)
- npm install sax
+ Example:
- `npm install` takes 3 exclusive, optional flags which save or update
- the package version in your main package.json:
+ npm install sax
- * `--save`: Package will appear in your `dependencies`.
-
- * `--save-dev`: Package will appear in your `devDependencies`.
-
- * `--save-optional`: Package will appear in your `optionalDependencies`.
-
- Examples:
-
- npm install sax --save
- npm install node-tap --save-dev
- npm install dtrace-provider --save-optional
-
-
- **Note**: If there is a file or folder named `<name>` in the current
- working directory, then it will try to install that, and only try to
- fetch the package by name if it is not valid.
+ **Note**: If there is a file or folder named `<name>` in the current
+ working directory, then it will try to install that, and only try to
+ fetch the package by name if it is not valid.
* `npm install <name>@<tag>`:
+ Install the version of the package that is referenced by the specified tag.
+ If the tag does not exist in the registry data for that package, then this
+ will fail.
- Install the version of the package that is referenced by the specified tag.
- If the tag does not exist in the registry data for that package, then this
- will fail.
-
- Example:
+ Example:
- npm install sax@latest
+ npm install sax@latest
* `npm install <name>@<version>`:
+ Install the specified version of the package. This will fail if the version
+ has not been published to the registry.
- Install the specified version of the package. This will fail if the version
- has not been published to the registry.
+ Example:
- Example:
-
- npm install sax@0.1.1
+ npm install sax@0.1.1
* `npm install <name>@<version range>`:
+ Install a version of the package matching the specified version range. This
+ will follow the same rules for resolving dependencies described in `npm-json(1)`.
- Install a version of the package matching the specified version range. This
- will follow the same rules for resolving dependencies described in `npm-json(1)`.
-
- Note that most version ranges must be put in quotes so that your shell will
- treat it as a single argument.
+ Note that most version ranges must be put in quotes so that your shell will
+ treat it as a single argument.
- Example:
+ Example:
- npm install sax@">=0.1.0 <0.2.0"
+ npm install sax@">=0.1.0 <0.2.0"
* `npm install <git remote url>`:
- Install a package by cloning a git remote url. The format of the git
- url is:
+ Install a package by cloning a git remote url. The format of the git
+ url is:
- <protocol>://[<user>@]<hostname><separator><path>[#<commit-ish>]
+ <protocol>://[<user>@]<hostname><separator><path>[#<commit-ish>]
- `<protocol>` is one of `git`, `git+ssh`, `git+http`, or
- `git+https`. If no `<commit-ish>` is specified, then `master` is
- used.
+ `<protocol>` is one of `git`, `git+ssh`, `git+http`, or
+ `git+https`. If no `<commit-ish>` is specified, then `master` is
+ used.
- Examples:
+ Examples:
- git+ssh://git@github.com:isaacs/npm.git#v1.0.27
- git+https://isaacs@github.com/isaacs/npm.git
- git://github.com/isaacs/npm.git#v1.0.27
+ git+ssh://git@github.com:isaacs/npm.git#v1.0.27
+ git+https://isaacs@github.com/isaacs/npm.git
+ git://github.com/isaacs/npm.git#v1.0.27
You may combine multiple arguments, and even multiple types of arguments.
For example:
@@ -230,4 +199,3 @@ affects a real use-case, it will be investigated.
* npm-folders(1)
* npm-tag(1)
* npm-rm(1)
-* npm-shrinkwrap(1)
diff --git a/deps/npm/doc/cli/json.md b/deps/npm/doc/cli/json.md
index ddd500e3b..5f6e7ef62 100644
--- a/deps/npm/doc/cli/json.md
+++ b/deps/npm/doc/cli/json.md
@@ -332,7 +332,6 @@ is a semver compatible version identifier.
* `""` (just an empty string) Same as `*`
* `version1 - version2` Same as `>=version1 <=version2`.
* `range1 || range2` Passes if either range1 or range2 are satisfied.
-* `git...` See 'Git URLs as Dependencies' below
For example, these are all valid:
@@ -388,18 +387,6 @@ of a version range.
This tarball will be downloaded and installed locally to your package at
install time.
-### Git URLs as Dependencies
-
-Git urls can be of the form:
-
- git://github.com/user/project.git#commit-ish
- git+ssh://user@hostname:project.git#commit-ish
- git+http://user@hostname/project/blah.git#commit-ish
- git+https://user@hostname/project/blah.git#commit-ish
-
-The `commit-ish` can be any tag, sha, or branch which can be supplied as
-an argument to `git checkout`. The default is `master`.
-
## devDependencies
If someone is planning on downloading and using your module in their
@@ -428,7 +415,7 @@ node that your stuff works on:
{ "engines" : { "node" : ">=0.1.27 <0.1.30" } }
And, like with dependencies, if you don't specify the version (or if you
-specify "\*" as the version), then any version of node will do.
+specify "*" as the version), then any version of node will do.
If you specify an "engines" field, then npm will require that "node" be
somewhere on that list. If "engines" is omitted, then npm will just assume
@@ -439,36 +426,6 @@ are capable of properly installing your program. For example:
{ "engines" : { "npm" : "~1.0.20" } }
-## os
-
-You can specify which operating systems your
-module will run on:
-
- "os" : [ "darwin", "linux" ]
-
-You can also blacklist instead of whitelist operating systems,
-just prepend the blacklisted os with a '!':
-
- "os" : [ "!win32" ]
-
-The host operating system is determined by `process.platform`
-
-It is allowed to both blacklist, and whitelist, although there isn't any
-good reason to do this.
-
-## cpu
-
-If your code only runs on certain cpu architectures,
-you can specify which ones.
-
- "cpu" : [ "x64", "ia32" ]
-
-Like the `os` option, you can also blacklist architectures:
-
- "cpu" : [ "!arm", "!mips" ]
-
-The host architecture is determined by `process.arch`
-
## preferGlobal
If your package is primarily a command-line application that should be
@@ -485,7 +442,7 @@ to publish it.
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),
+to a speciic registry (for example, an internal registry),
then use the `publishConfig` hash described below
to override the `registry` config param at publish-time.
diff --git a/deps/npm/doc/cli/list.md b/deps/npm/doc/cli/list.md
index 93d86cd83..596349a81 100644
--- a/deps/npm/doc/cli/list.md
+++ b/deps/npm/doc/cli/list.md
@@ -22,13 +22,6 @@ When run as `ll` or `la`, it shows extended information by default.
## CONFIGURATION
-### json
-
-* Default: false
-* Type: Boolean
-
-Show information in JSON format.
-
### long
* Default: false
diff --git a/deps/npm/doc/cli/scripts.md b/deps/npm/doc/cli/scripts.md
index 3d33a8391..64b3ec41a 100644
--- a/deps/npm/doc/cli/scripts.md
+++ b/deps/npm/doc/cli/scripts.md
@@ -62,20 +62,6 @@ Package scripts run in an environment where many pieces of information are
made available regarding the setup of npm and the current state of the
process.
-
-### path
-
-If you depend on modules that define executable scripts, like test suites,
-then those executables will be added to the `PATH` for executing the scripts.
-So, if your package.json has this:
-
- { "name" : "foo"
- , "dependencies" : { "bar" : "0.1.x" }
- , "scripts": { "start" : "bar ./test" } }
-
-then you could run `npm start` to execute the `bar` script, which is exported
-into the `node_modules/.bin` directory on `npm install`.
-
### package.json vars
The package.json fields are tacked onto the `npm_package_` prefix. So, for