diff options
Diffstat (limited to 'deps/npm/man/man1/npm-install.1')
-rw-r--r-- | deps/npm/man/man1/npm-install.1 | 144 |
1 files changed, 72 insertions, 72 deletions
diff --git a/deps/npm/man/man1/npm-install.1 b/deps/npm/man/man1/npm-install.1 index 994000c8e06..6639b699264 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\. |