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/folders.514
-rw-r--r--deps/npm/man/man5/install.55
-rw-r--r--deps/npm/man/man5/npmrc.511
-rw-r--r--deps/npm/man/man5/package-json.543
-rw-r--r--deps/npm/man/man5/package-lock-json.515
-rw-r--r--deps/npm/man/man5/package-locks.520
-rw-r--r--deps/npm/man/man5/shrinkwrap-json.517
7 files changed, 60 insertions, 65 deletions
diff --git a/deps/npm/man/man5/folders.5 b/deps/npm/man/man5/folders.5
index 6654212195..a6d8027759 100644
--- a/deps/npm/man/man5/folders.5
+++ b/deps/npm/man/man5/folders.5
@@ -31,24 +31,24 @@ not be included in the package tarball\.
.P
This allows a package maintainer to install all of their dependencies
(and dev dependencies) locally, but only re\-publish those items that
-cannot be found elsewhere\. See \fBpackage\.json\fP \fI/docs/configuring\-npm/package\.json\fR for more information\.
+cannot be found elsewhere\. See npm help \fBpackage\.json\fP for more information\.
.SS See also
.RS 0
.IP \(bu 2
-npm help package\-json
+npm help package\.json
.IP \(bu 2
-npm help npm\-install
+npm help install
.IP \(bu 2
-npm help npm\-pack
+npm help pack
.IP \(bu 2
-npm help npm\-cache
+npm help cache
.IP \(bu 2
-npm help npm\-config
+npm help config
.IP \(bu 2
npm help npmrc
.IP \(bu 2
npm help config
.IP \(bu 2
-npm help npm\-publish
+npm help publish
.RE
diff --git a/deps/npm/man/man5/install.5 b/deps/npm/man/man5/install.5
index 6c74ccd297..d14b649fe7 100644
--- a/deps/npm/man/man5/install.5
+++ b/deps/npm/man/man5/install.5
@@ -1,6 +1,7 @@
-.TH "DOWNLOAD" "" "November 2019" "" ""
+.TH "INSTALL" "5" "November 2019" "" ""
.SH "NAME"
-\fBDownload\fR
+\fBinstall\fR \- Download and Install npm
+.SS Description
.P
To publish and install packages to and from the public npm registry, you must install Node\.js and the npm command line interface using either a Node version manager or a Node installer\. \fBWe strongly recommend using a Node version manager to install Node\.js and npm\.\fR We do not recommend using a Node installer, since the Node installation process installs npm in a directory with local permissions and can cause permissions errors when you run npm packages globally\.
.SS Overview
diff --git a/deps/npm/man/man5/npmrc.5 b/deps/npm/man/man5/npmrc.5
index 651a515697..d11cb449c0 100644
--- a/deps/npm/man/man5/npmrc.5
+++ b/deps/npm/man/man5/npmrc.5
@@ -1,7 +1,6 @@
-.TH "NPMRC" "" "November 2019" "" ""
+.TH "NPMRC" "5" "November 2019" "" ""
.SH "NAME"
-\fBnpmrc\fR
-.SH The npm config files
+\fBnpmrc\fR \- The npm config files
.SS Description
.P
npm gets its config settings from the command line, environment
@@ -10,7 +9,7 @@ variables, and \fBnpmrc\fP files\.
The \fBnpm config\fP command can be used to update and edit the contents
of the user and global npmrc files\.
.P
-For a list of available configuration options, see npm\-config \fI/docs/using\-npm/config\fR\|\.
+For a list of available configuration options, see npm help config\.
.SS Files
.P
The four relevant files are:
@@ -98,11 +97,11 @@ manner\.
.IP \(bu 2
npm help folders
.IP \(bu 2
-npm help npm\-config
+npm help config
.IP \(bu 2
npm help config
.IP \(bu 2
-npm help package\-json
+npm help package\.json
.IP \(bu 2
npm help npm
diff --git a/deps/npm/man/man5/package-json.5 b/deps/npm/man/man5/package-json.5
index 959b744fd7..01350c6410 100644
--- a/deps/npm/man/man5/package-json.5
+++ b/deps/npm/man/man5/package-json.5
@@ -1,14 +1,13 @@
-.TH "PACKAGE\.JSON" "" "November 2019" "" ""
+.TH "PACKAGE\.JSON" "5" "November 2019" "" ""
.SH "NAME"
-\fBpackage.json\fR
-.SH Specifics of npm's package\.json handling
+\fBpackage.json\fR \- Specifics of npm's package\.json handling
.SS Description
.P
This document is all you need to know about what's required in your package\.json
file\. It must be actual JSON, not just a JavaScript object literal\.
.P
A lot of the behavior described in this document is affected by the config
-settings described in \fBnpm\-config\fP \fI/docs/using\-npm/config\fR\|\.
+settings described in npm help \fBconfig\fP\|\.
.SS name
.P
If you plan to publish your package, the \fImost\fR important things in your
@@ -25,7 +24,7 @@ Some rules:
The name must be less than or equal to 214 characters\. This includes the scope for
scoped packages\.
.IP \(bu 2
-The name can't start with a dot or an underscore\.
+The names of scoped packages can begin with a dot or an underscore\. This is not permitted without a scope\.
.IP \(bu 2
New packages must not have uppercase letters in the name\.
.IP \(bu 2
@@ -52,7 +51,7 @@ already, before you get too attached to it\. https://www\.npmjs\.com/
.RE
.P
A name can be optionally prefixed by a scope, e\.g\. \fB@myorg/mypackage\fP\|\. See
-\fBnpm\-scope\fP \fI/docs/using\-npm/scope\fR for more detail\.
+npm help \fBscope\fP for more detail\.
.SS version
.P
If you plan to publish your package, the \fImost\fR important things in your
@@ -65,7 +64,7 @@ Version must be parseable by
node\-semver \fIhttps://github\.com/isaacs/node\-semver\fR, which is bundled
with npm as a dependency\. (\fBnpm install semver\fP to use it yourself\.)
.P
-More on version numbers and ranges at semver \fI/docs/using\-npm/semver\fR\|\.
+More on version numbers and ranges at npm help semver\.
.SS description
.P
Put a description in it\. It's a string\. This helps people discover your
@@ -522,7 +521,7 @@ The "scripts" property is a dictionary containing script commands that are run
at various times in the lifecycle of your package\. The key is the lifecycle
event, and the value is the command to run at that point\.
.P
-See \fBnpm\-scripts\fP \fI/docs/using\-npm/scripts\fR to find out more about writing package scripts\.
+See npm help \fBscripts\fP to find out more about writing package scripts\.
.SS config
.P
A "config" object can be used to set configuration parameters used in package
@@ -540,7 +539,7 @@ and then had a "start" command that then referenced the
\fBnpm_package_config_port\fP environment variable, then the user could
override that by doing \fBnpm config set foo:port 8001\fP\|\.
.P
-See \fBnpm\-config\fP \fI/docs/using\-npm/config\fR and \fBnpm\-scripts\fP \fI/docs/using\-npm/scripts\fR for more on package
+See npm help \fBconfig\fP and npm help \fBscripts\fP for more on package
configs\.
.SS dependencies
.P
@@ -552,7 +551,7 @@ tarball or git URL\.
\fBPlease do not put test harnesses or transpilers in your
\fBdependencies\fP object\.\fR See \fBdevDependencies\fP, below\.
.P
-See semver \fI/docs/using\-npm/semver\fR for more details about specifying version ranges\.
+See npm help semver for more details about specifying version ranges\.
.RS 0
.IP \(bu 2
\fBversion\fP Must match \fBversion\fP exactly
@@ -565,9 +564,9 @@ See semver \fI/docs/using\-npm/semver\fR for more details about specifying versi
.IP \(bu 2
\fB<=version\fP
.IP \(bu 2
-\fB~version\fP "Approximately equivalent to version" See semver \fI/docs/using\-npm/semver\fR
+\fB~version\fP "Approximately equivalent to version" See npm help semver
.IP \(bu 2
-\fB^version\fP "Compatible with version" See semver \fI/docs/using\-npm/semver\fR
+\fB^version\fP "Compatible with version" See npm help semver
.IP \(bu 2
\fB1\.2\.x\fP 1\.2\.0, 1\.2\.1, etc\., but not 1\.3\.0
.IP \(bu 2
@@ -585,7 +584,7 @@ See semver \fI/docs/using\-npm/semver\fR for more details about specifying versi
.IP \(bu 2
\fBuser/repo\fP See 'GitHub URLs' below
.IP \(bu 2
-\fBtag\fP A specific version tagged and published as \fBtag\fP See \fBnpm\-dist\-tag\fP \fI/docs/cli\-commands/npm\-dist\-tag\fR
+\fBtag\fP A specific version tagged and published as \fBtag\fP See npm help \fBdist\-tag\fP
.IP \(bu 2
\fBpath/path/path\fP See Local Paths \fI#local\-paths\fR below
@@ -711,7 +710,7 @@ object\.
.P
These things will be installed when doing \fBnpm link\fP or \fBnpm install\fP
from the root of a package, and can be managed like any other npm
-configuration param\. See \fBnpm\-config\fP \fI/docs/using\-npm/config\fR for more on the topic\.
+configuration param\. See npm help \fBconfig\fP for more on the topic\.
.P
For build steps that are not platform\-specific, such as compiling
CoffeeScript or other languages to JavaScript, use the \fBprepare\fP
@@ -957,7 +956,7 @@ to the global public registry or that a scoped module is private by default\.
Any config values can be overridden, but only "tag", "registry" and "access"
probably matter for the purposes of publishing\.
.P
-See \fBnpm\-config\fP \fI/docs/using\-npm/config\fR to see the list of config options that can be
+See npm help \fBconfig\fP to see the list of config options that can be
overridden\.
.SS DEFAULT VALUES
.P
@@ -984,18 +983,18 @@ ignored\.
.IP \(bu 2
npm help semver
.IP \(bu 2
-npm help npm\-init
+npm help init
.IP \(bu 2
-npm help npm\-version
+npm help version
.IP \(bu 2
-npm help npm\-config
+npm help config
.IP \(bu 2
-npm help npm\-help
+npm help help
.IP \(bu 2
-npm help npm\-install
+npm help install
.IP \(bu 2
-npm help npm\-publish
+npm help publish
.IP \(bu 2
-npm help npm\-uninstall
+npm help uninstall
.RE
diff --git a/deps/npm/man/man5/package-lock-json.5 b/deps/npm/man/man5/package-lock-json.5
index 075e07985a..36dbbc4023 100644
--- a/deps/npm/man/man5/package-lock-json.5
+++ b/deps/npm/man/man5/package-lock-json.5
@@ -1,7 +1,6 @@
-.TH "PACKAGE\-LOCK\.JSON" "" "November 2019" "" ""
+.TH "PACKAGE\-LOCK\.JSON" "5" "November 2019" "" ""
.SH "NAME"
-\fBpackage-lock.json\fR
-.SH A manifestation of the manifest
+\fBpackage-lock.json\fR \- A manifestation of the manifest
.SS Description
.P
\fBpackage\-lock\.json\fP is automatically generated for any operations where npm
@@ -25,7 +24,7 @@ And optimize the installation process by allowing npm to skip repeated metadata
.P
One key detail about \fBpackage\-lock\.json\fP is that it cannot be published, and it
will be ignored if found in any place other than the toplevel package\. It shares
-a format with npm\-shrinkwrap\.json \fIdocs/configuring\-npm/shrinkwrap\-json\fR, which is essentially the same file, but
+a format with npm help npm\-shrinkwrap\.json, which is essentially the same file, but
allows publication\. This is not recommended unless deploying a CLI tool or
otherwise using the publication process for producing production packages\.
.P
@@ -140,14 +139,14 @@ The dependencies of this dependency, exactly as at the top level\.
.SS See also
.RS 0
.IP \(bu 2
-npm help npm\-shrinkwrap
+npm help shrinkwrap
.IP \(bu 2
-npm help shrinkwrap\-json
+npm help shrinkwrap\.json
.IP \(bu 2
npm help package\-locks
.IP \(bu 2
-npm help package\-json
+npm help package\.json
.IP \(bu 2
-npm help npm\-install
+npm help install
.RE
diff --git a/deps/npm/man/man5/package-locks.5 b/deps/npm/man/man5/package-locks.5
index 1a3be5255b..ea2e51fc69 100644
--- a/deps/npm/man/man5/package-locks.5
+++ b/deps/npm/man/man5/package-locks.5
@@ -1,10 +1,9 @@
-.TH "PACKAGE\-LOCKS" "" "November 2019" "" ""
+.TH "PACKAGE\-LOCKS" "5" "November 2019" "" ""
.SH "NAME"
-\fBpackage-locks\fR
-.SH An explanation of npm lockfiles
+\fBpackage-locks\fR \- An explanation of npm lockfiles
.SS Description
.P
-Conceptually, the "input" to \fBnpm\-install\fP \fI/docs/cli\-commands/npm\-install\fR is a package\.json \fI/docs/configuring\-npm/package\-json\fR, while its
+Conceptually, the "input" to npm help \fBinstall\fP is a npm help package\.json, while its
"output" is a fully\-formed \fBnode_modules\fP tree: a representation of the
dependencies you declared\. In an ideal world, npm would work like a pure
function: the same \fBpackage\.json\fP should produce the exact same \fBnode_modules\fP
@@ -91,8 +90,7 @@ author are not the same person, there's no way for A's author to say
that he or she does not want to pull in newly published versions of C
when B hasn't changed at all\.
.P
-To prevent this potential issue, npm uses package\-lock\.json \fI/docs/configuring\-npm/package\-lock\-json\fR or, if present,
-npm\-shrinkwrap\.json \fIshrinkwrap\.json\fR\|\. These files are called package locks, or lockfiles\.
+To prevent this potential issue, npm uses npm help package\-lock\.json or, if present, npm help npm\-shrinkwrap\.json\. These files are called package locks, or lockfiles\.
.P
Whenever you run \fBnpm install\fP, npm generates or updates your package lock,
which will look something like this:
@@ -122,7 +120,7 @@ which will look something like this:
This file describes an \fIexact\fR, and more importantly \fIreproducible\fR
\fBnode_modules\fP tree\. Once it's present, any future installation will base its
work off this file, instead of recalculating dependency versions off
-package\.json \fI/docs/configuring\-npm/package\-json\fR\|\.
+npm help package\.json\.
.P
The presence of a package lock changes the installation behavior such that:
.RS 0
@@ -191,12 +189,12 @@ pre\-\fBnpm@5\.7\.0\fP versions of npm 5, albeit a bit more noisily\. Note that
.IP \(bu 2
https://medium\.com/@sdboyer/so\-you\-want\-to\-write\-a\-package\-manager\-4ae9c17d9527
.IP \(bu 2
-npm help package\-json
+npm help package\.json
.IP \(bu 2
-npm help package\-lock\-json
+npm help package\-lock\.json
.IP \(bu 2
-npm help shrinkwrap\-json
+npm help shrinkwrap\.json
.IP \(bu 2
-npm help npm\-shrinkwrap
+npm help shrinkwrap
.RE
diff --git a/deps/npm/man/man5/shrinkwrap-json.5 b/deps/npm/man/man5/shrinkwrap-json.5
index 8e8ba9244a..5c1e05f8b7 100644
--- a/deps/npm/man/man5/shrinkwrap-json.5
+++ b/deps/npm/man/man5/shrinkwrap-json.5
@@ -1,10 +1,9 @@
-.TH "NPM\-SHRINKWRAP\.JSON" "" "November 2019" "" ""
+.TH "NPM\-SHRINKWRAP\.JSON" "5" "November 2019" "" ""
.SH "NAME"
-\fBnpm-shrinkwrap.json\fR
-.SH A publishable lockfile
+\fBnpm-shrinkwrap.json\fR \- A publishable lockfile
.SS Description
.P
-\fBnpm\-shrinkwrap\.json\fP is a file created by \fBnpm\-shrinkwrap\fP \fI/docs/cli\-commands/npm\-shrinkwrap\fR\|\. It is identical to
+\fBnpm\-shrinkwrap\.json\fP is a file created by npm help \fBshrinkwrap\fP\|\. It is identical to
\fBpackage\-lock\.json\fP, with one major caveat: Unlike \fBpackage\-lock\.json\fP,
\fBnpm\-shrinkwrap\.json\fP may be included when publishing a package\.
.P
@@ -18,16 +17,16 @@ Additionally, if both \fBpackage\-lock\.json\fP and \fBnpm\-shrinkwrap\.json\fP
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
-to the manual page for package\-lock\.json \fI/docs/configuring\-npm/package\-lock\-json\fR\|\.
+to the manual page for npm help package\-lock\.json\.
.SS See also
.RS 0
.IP \(bu 2
-npm help npm\-shrinkwrap
+npm help shrinkwrap
.IP \(bu 2
-npm help package\-lock\-json
+npm help package\-lock\.json
.IP \(bu 2
-npm help package\-json
+npm help package\.json
.IP \(bu 2
-npm help npm\-install
+npm help install
.RE