summaryrefslogtreecommitdiff
path: root/deps/npm/man/man5
diff options
context:
space:
mode:
Diffstat (limited to 'deps/npm/man/man5')
-rw-r--r--deps/npm/man/man5/npm-folders.59
-rw-r--r--deps/npm/man/man5/npm-global.59
-rw-r--r--deps/npm/man/man5/npm-json.545
-rw-r--r--deps/npm/man/man5/npm-package-locks.52
-rw-r--r--deps/npm/man/man5/npm-shrinkwrap.json.56
-rw-r--r--deps/npm/man/man5/npmrc.52
-rw-r--r--deps/npm/man/man5/package-lock.json.54
-rw-r--r--deps/npm/man/man5/package.json.545
8 files changed, 73 insertions, 49 deletions
diff --git a/deps/npm/man/man5/npm-folders.5 b/deps/npm/man/man5/npm-folders.5
index 194e6bcc02..2442ef3056 100644
--- a/deps/npm/man/man5/npm-folders.5
+++ b/deps/npm/man/man5/npm-folders.5
@@ -1,4 +1,4 @@
-.TH "NPM\-FOLDERS" "5" "June 2017" "" ""
+.TH "NPM\-FOLDERS" "5" "July 2017" "" ""
.SH "NAME"
\fBnpm-folders\fR \- Folder Structures Used by npm
.SH DESCRIPTION
@@ -25,10 +25,9 @@ If you need both, then install it in both places, or use \fBnpm link\fP\|\.
.SS prefix Configuration
.P
The \fBprefix\fP config defaults to the location where node is installed\.
-On most systems, this is \fB/usr/local\fP\|\. 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\fP rather than
-\fB{prefix}/node\.exe\fP\|\.
+On most systems, this is \fB/usr/local\fP\|\. On Windows, it's \fB%AppData%\\npm\fP\|\.
+On Unix systems, it's one level up, since node is typically installed at
+\fB{prefix}/bin/node\fP rather than \fB{prefix}/node\.exe\fP\|\.
.P
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
diff --git a/deps/npm/man/man5/npm-global.5 b/deps/npm/man/man5/npm-global.5
index 194e6bcc02..2442ef3056 100644
--- a/deps/npm/man/man5/npm-global.5
+++ b/deps/npm/man/man5/npm-global.5
@@ -1,4 +1,4 @@
-.TH "NPM\-FOLDERS" "5" "June 2017" "" ""
+.TH "NPM\-FOLDERS" "5" "July 2017" "" ""
.SH "NAME"
\fBnpm-folders\fR \- Folder Structures Used by npm
.SH DESCRIPTION
@@ -25,10 +25,9 @@ If you need both, then install it in both places, or use \fBnpm link\fP\|\.
.SS prefix Configuration
.P
The \fBprefix\fP config defaults to the location where node is installed\.
-On most systems, this is \fB/usr/local\fP\|\. 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\fP rather than
-\fB{prefix}/node\.exe\fP\|\.
+On most systems, this is \fB/usr/local\fP\|\. On Windows, it's \fB%AppData%\\npm\fP\|\.
+On Unix systems, it's one level up, since node is typically installed at
+\fB{prefix}/bin/node\fP rather than \fB{prefix}/node\.exe\fP\|\.
.P
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
diff --git a/deps/npm/man/man5/npm-json.5 b/deps/npm/man/man5/npm-json.5
index 89eefefcf6..df570a7e1b 100644
--- a/deps/npm/man/man5/npm-json.5
+++ b/deps/npm/man/man5/npm-json.5
@@ -1,4 +1,4 @@
-.TH "PACKAGE\.JSON" "5" "June 2017" "" ""
+.TH "PACKAGE\.JSON" "5" "July 2017" "" ""
.SH "NAME"
\fBpackage.json\fR \- Specifics of npm's package\.json handling
.SH DESCRIPTION
@@ -557,21 +557,35 @@ This tarball will be downloaded and installed locally to your package at
install time\.
.SS Git URLs as Dependencies
.P
-Git urls can be of the form:
+Git urls are of the form:
.P
.RS 2
.nf
-git://github\.com/user/project\.git#commit\-ish
-git+ssh://user@hostname: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
+<protocol>://[<user>[:<password>]@]<hostname>[:<port>][:][/]<path>[#<commit\-ish> | #semver:<semver>]
.fi
.RE
.P
-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
+\fB<protocol>\fP is one of \fBgit\fP, \fBgit+ssh\fP, \fBgit+http\fP, \fBgit+https\fP, or
+\fBgit+file\fP\|\.
+.P
+If \fB#<commit\-ish>\fP is provided, it will be used to clone exactly that
+commit\. If the commit\-ish has the format \fB#semver:<semver>\fP, \fB<semver>\fP can
+be any valid semver range or exact version, and npm will look for any tags
+or refs matching that range in the remote repository, much as it would for a
+registry dependency\. If neither \fB#<commit\-ish>\fP or \fB#semver:<semver>\fP is
+specified, then \fBmaster\fP is used\.
+.P
+Examples:
+.P
+.RS 2
+.nf
+git+ssh://git@github\.com:npm/npm\.git#v1\.0\.27
+git+ssh://git@github\.com:npm/npm#semver:^5\.0
+git+https://isaacs@github\.com/npm/npm\.git
+git://github\.com/npm/npm\.git#v1\.0\.27
+.fi
+.RE
+.SS 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\fP suffix can be
@@ -590,7 +604,7 @@ included\. For example:
}
.fi
.RE
-.SH Local Paths
+.SS 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 \-S\fP or
@@ -854,12 +868,11 @@ Like the \fBos\fP option, you can also blacklist architectures:
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\fP to provide a warning
-if it is installed locally\.
+\fBDEPRECATED\fR
.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\.
+This option used to trigger an npm warning, but it will no longer warn\. It is
+purely there for informational purposes\. It is now recommended that you install
+any binaries as local devDependencies wherever possible\.
.SH private
.P
If you set \fB"private": true\fP in your package\.json, then npm will refuse
diff --git a/deps/npm/man/man5/npm-package-locks.5 b/deps/npm/man/man5/npm-package-locks.5
index 4d6a285192..df808f2e98 100644
--- a/deps/npm/man/man5/npm-package-locks.5
+++ b/deps/npm/man/man5/npm-package-locks.5
@@ -1,4 +1,4 @@
-.TH "NPM\-PACKAGE\-LOCKS" "5" "June 2017" "" ""
+.TH "NPM\-PACKAGE\-LOCKS" "5" "July 2017" "" ""
.SH "NAME"
\fBnpm-package-locks\fR \- An explanation of npm lockfiles
.SH DESCRIPTION
diff --git a/deps/npm/man/man5/npm-shrinkwrap.json.5 b/deps/npm/man/man5/npm-shrinkwrap.json.5
index 400e23b20a..9188009c10 100644
--- a/deps/npm/man/man5/npm-shrinkwrap.json.5
+++ b/deps/npm/man/man5/npm-shrinkwrap.json.5
@@ -1,11 +1,11 @@
-.TH "NPM\-SHRINKWRAP\.JSON" "5" "June 2017" "" ""
+.TH "NPM\-SHRINKWRAP\.JSON" "5" "July 2017" "" ""
.SH "NAME"
\fBnpm-shrinkwrap.json\fR \- A publishable lockfile
.SH DESCRIPTION
.P
\fBnpm\-shrinkwrap\.json\fP is a file created by npm help shrinkwrap\. It is identical to
\fBpackage\-lock\.json\fP, with one major caveat: Unlike \fBpackage\-lock\.json\fP,
-\fBnpm\-shrinwkrap\.json\fP may be included when publishing a package\.
+\fBnpm\-shrinkwrap\.json\fP may be included when publishing a package\.
.P
The recommended use\-case for \fBnpm\-shrinkwrap\.json\fP is applications deployed
through the publishing process on the registry: for example, daemons and
@@ -13,7 +13,7 @@ command\-line tools intended as global installs or \fBdevDependencies\fP\|\. It'
strongly discouraged for library authors to publish this file, since that would
prevent end users from having control over transitive dependency updates\.
.P
-Additionally, if both \fBpackage\-lock\.json\fP and \fBnpm\-shrinwkrap\.json\fP are present
+Additionally, if both \fBpackage\-lock\.json\fP and \fBnpm\-shrinkwrap\.json\fP are present
in a package root, \fBpackage\-lock\.json\fP will be ignored in favor of this file\.
.P
For full details and description of the \fBnpm\-shrinkwrap\.json\fP file format, refer
diff --git a/deps/npm/man/man5/npmrc.5 b/deps/npm/man/man5/npmrc.5
index a80fdca666..4a35447e23 100644
--- a/deps/npm/man/man5/npmrc.5
+++ b/deps/npm/man/man5/npmrc.5
@@ -1,4 +1,4 @@
-.TH "NPMRC" "5" "June 2017" "" ""
+.TH "NPMRC" "5" "July 2017" "" ""
.SH "NAME"
\fBnpmrc\fR \- The npm config files
.SH DESCRIPTION
diff --git a/deps/npm/man/man5/package-lock.json.5 b/deps/npm/man/man5/package-lock.json.5
index 09dc0d7600..4e1f7b880a 100644
--- a/deps/npm/man/man5/package-lock.json.5
+++ b/deps/npm/man/man5/package-lock.json.5
@@ -1,4 +1,4 @@
-.TH "PACKAGE\-LOCK\.JSON" "5" "June 2017" "" ""
+.TH "PACKAGE\-LOCK\.JSON" "5" "July 2017" "" ""
.SH "NAME"
\fBpackage-lock.json\fR \- A manifestation of the manifest
.SH DESCRIPTION
@@ -135,7 +135,7 @@ The dependencies of this dependency, exactly as at the top level\.
.IP \(bu 2
npm help shrinkwrap
.IP \(bu 2
-npm help 5 package\-lock\.json
+npm help 5 shrinkwrap\.json
.IP \(bu 2
npm help 5 package\.json
.IP \(bu 2
diff --git a/deps/npm/man/man5/package.json.5 b/deps/npm/man/man5/package.json.5
index 89eefefcf6..df570a7e1b 100644
--- a/deps/npm/man/man5/package.json.5
+++ b/deps/npm/man/man5/package.json.5
@@ -1,4 +1,4 @@
-.TH "PACKAGE\.JSON" "5" "June 2017" "" ""
+.TH "PACKAGE\.JSON" "5" "July 2017" "" ""
.SH "NAME"
\fBpackage.json\fR \- Specifics of npm's package\.json handling
.SH DESCRIPTION
@@ -557,21 +557,35 @@ This tarball will be downloaded and installed locally to your package at
install time\.
.SS Git URLs as Dependencies
.P
-Git urls can be of the form:
+Git urls are of the form:
.P
.RS 2
.nf
-git://github\.com/user/project\.git#commit\-ish
-git+ssh://user@hostname: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
+<protocol>://[<user>[:<password>]@]<hostname>[:<port>][:][/]<path>[#<commit\-ish> | #semver:<semver>]
.fi
.RE
.P
-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
+\fB<protocol>\fP is one of \fBgit\fP, \fBgit+ssh\fP, \fBgit+http\fP, \fBgit+https\fP, or
+\fBgit+file\fP\|\.
+.P
+If \fB#<commit\-ish>\fP is provided, it will be used to clone exactly that
+commit\. If the commit\-ish has the format \fB#semver:<semver>\fP, \fB<semver>\fP can
+be any valid semver range or exact version, and npm will look for any tags
+or refs matching that range in the remote repository, much as it would for a
+registry dependency\. If neither \fB#<commit\-ish>\fP or \fB#semver:<semver>\fP is
+specified, then \fBmaster\fP is used\.
+.P
+Examples:
+.P
+.RS 2
+.nf
+git+ssh://git@github\.com:npm/npm\.git#v1\.0\.27
+git+ssh://git@github\.com:npm/npm#semver:^5\.0
+git+https://isaacs@github\.com/npm/npm\.git
+git://github\.com/npm/npm\.git#v1\.0\.27
+.fi
+.RE
+.SS 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\fP suffix can be
@@ -590,7 +604,7 @@ included\. For example:
}
.fi
.RE
-.SH Local Paths
+.SS 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 \-S\fP or
@@ -854,12 +868,11 @@ Like the \fBos\fP option, you can also blacklist architectures:
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\fP to provide a warning
-if it is installed locally\.
+\fBDEPRECATED\fR
.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\.
+This option used to trigger an npm warning, but it will no longer warn\. It is
+purely there for informational purposes\. It is now recommended that you install
+any binaries as local devDependencies wherever possible\.
.SH private
.P
If you set \fB"private": true\fP in your package\.json, then npm will refuse