X-Git-Url: https://gerrit.simantics.org/r/gitweb?a=blobdiff_plain;f=org.simantics.maps.server%2Fnode%2Fnode-v4.8.0-win-x64%2Fnode_modules%2Fnpm%2Fhtml%2Fdoc%2Fmisc%2Fnpm-config.html;fp=org.simantics.maps.server%2Fnode%2Fnode-v4.8.0-win-x64%2Fnode_modules%2Fnpm%2Fhtml%2Fdoc%2Fmisc%2Fnpm-config.html;h=2c3818bf1b7cc99aedfe5221b0c19ff7c3627bf3;hb=2529be6d456deeb07c128603ce4971f1dc29b695;hp=0000000000000000000000000000000000000000;hpb=2636fc31c16c23711cf2b06a4ae8537bba9c1d35;p=simantics%2Fdistrict.git diff --git a/org.simantics.maps.server/node/node-v4.8.0-win-x64/node_modules/npm/html/doc/misc/npm-config.html b/org.simantics.maps.server/node/node-v4.8.0-win-x64/node_modules/npm/html/doc/misc/npm-config.html new file mode 100644 index 00000000..2c3818bf --- /dev/null +++ b/org.simantics.maps.server/node/node-v4.8.0-win-x64/node_modules/npm/html/doc/misc/npm-config.html @@ -0,0 +1,818 @@ + + + npm-config + + + + + + +
+ +

npm-config

More than you probably want to know about npm configuration

+

DESCRIPTION

+

npm gets its configuration values from the following sources, sorted by priority:

+

Command Line Flags

+

Putting --foo bar on the command line sets the foo configuration +parameter to "bar". A -- argument tells the cli parser to stop +reading flags. A --flag parameter that is at the end of the +command will be given the value of true.

+

Environment Variables

+

Any environment variables that start with npm_config_ will be +interpreted as a configuration parameter. For example, putting +npm_config_foo=bar in your environment will set the foo +configuration parameter to bar. Any environment configurations that +are not given a value will be given the value of true. Config +values are case-insensitive, so NPM_CONFIG_FOO=bar will work the +same.

+

npmrc Files

+

The four relevant files are:

+ +

See npmrc(5) for more details.

+

Default Configs

+

A set of configuration parameters that are internal to npm, and are +defaults if nothing else is specified.

+

Shorthands and Other CLI Niceties

+

The following shorthands are parsed on the command-line:

+ +

If the specified configuration param resolves unambiguously to a known +configuration parameter, then it is expanded to that configuration +parameter. For example:

+
npm ls --par
+# same as:
+npm ls --parseable
+

If multiple single-character shorthands are strung together, and the +resulting combination is unambiguously not some other configuration +param, then it is expanded to its various component pieces. For +example:

+
npm ls -gpld
+# same as:
+npm ls --global --parseable --long --loglevel info
+

Per-Package Config Settings

+

When running scripts (see npm-scripts(7)) the package.json "config" +keys are overwritten in the environment if there is a config param of +<name>[@<version>]:<key>. For example, if the package.json has +this:

+
{ "name" : "foo"
+, "config" : { "port" : "8080" }
+, "scripts" : { "start" : "node server.js" } }
+

and the server.js is this:

+
http.createServer(...).listen(process.env.npm_package_config_port)
+

then the user could change the behavior by doing:

+
npm config set foo:port 80
+

See package.json(5) for more information.

+

Config Settings

+

access

+ +

When publishing scoped packages, the access level defaults to restricted. If +you want your scoped package to be publicly viewable (and installable) set +--access=public. The only valid values for access are public and +restricted. Unscoped packages always have an access level of public.

+

always-auth

+ +

Force npm to always require authentication when accessing the registry, +even for GET requests.

+ + +

Tells npm to create symlinks (or .cmd shims on Windows) for package +executables.

+

Set to false to have it not do this. This can be used to work around +the fact that some file systems don't support symlinks, even on +ostensibly Unix systems.

+

browser

+ +

The browser that is called by the npm docs command to open websites.

+

ca

+ +

The Certificate Authority signing certificate that is trusted for SSL +connections to the registry. Values should be in PEM format with newlines +replaced by the string "\n". For example:

+
ca="-----BEGIN CERTIFICATE-----\nXXXX\nXXXX\n-----END CERTIFICATE-----"
+

Set to null to only allow "known" registrars, or to a specific CA cert +to trust only that specific signing authority.

+

Multiple CAs can be trusted by specifying an array of certificates:

+
ca[]="..."
+ca[]="..."
+

See also the strict-ssl config.

+

cafile

+ +

A path to a file containing one or multiple Certificate Authority signing +certificates. Similar to the ca setting, but allows for multiple CA's, as +well as for the CA information to be stored in a file on disk.

+

cache

+ +

The location of npm's cache directory. See npm-cache(1)

+

cache-lock-stale

+ +

The number of ms before cache folder lockfiles are considered stale.

+

cache-lock-retries

+ +

Number of times to retry to acquire a lock on cache folder lockfiles.

+

cache-lock-wait

+ +

Number of ms to wait for cache lock files to expire.

+

cache-max

+ +

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

+ +

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.

+

cert

+ +

A client certificate to pass when accessing the registry. Values should be in +PEM format with newlines replaced by the string "\n". For example:

+
cert="-----BEGIN CERTIFICATE-----\nXXXX\nXXXX\n-----END CERTIFICATE-----"
+

It is not the path to a certificate file (and there is no "certfile" option).

+

color

+ +

If false, never shows colors. If "always" then always shows colors. +If true, then only prints color codes for tty file descriptors.

+

depth

+ +

The depth to go when recursing directories for npm ls, +npm cache ls, and npm outdated.

+

For npm outdated, a setting of Infinity will be treated as 0 +since that gives more useful information. To show the outdated status +of all packages and dependents, use a large integer value, +e.g., npm outdated --depth 9999

+

description

+ +

Show the description in npm search

+

dev

+ +

Install dev-dependencies along with packages.

+

Note that dev-dependencies are also installed if the npat flag is +set.

+

editor

+ +

The command to run for npm edit or npm config edit.

+

engine-strict

+ +

If set to true, then npm will stubbornly refuse to install (or even +consider installing) any package that claims to not be compatible with +the current Node.js version.

+

force

+ +

Makes various commands more forceful.

+ +

fetch-retries

+ +

The "retries" config for the retry module to use when fetching +packages from the registry.

+

fetch-retry-factor

+ +

The "factor" config for the retry module to use when fetching +packages.

+

fetch-retry-mintimeout

+ +

The "minTimeout" config for the retry module to use when fetching +packages.

+

fetch-retry-maxtimeout

+ +

The "maxTimeout" config for the retry module to use when fetching +packages.

+

git

+ +

The command to use for git commands. If git is installed on the +computer, but is not in the PATH, then set this to the full path to +the git binary.

+

git-tag-version

+ +

Tag the commit when using the npm version command.

+

global

+ +

Operates in "global" mode, so that packages are installed into the +prefix folder instead of the current working directory. See +npm-folders(5) for more on the differences in behavior.

+ +

globalconfig

+ +

The config file to read for global config options.

+

group

+ +

The group to use when running package scripts in global mode as the root +user.

+

heading

+ +

The string that starts all the debugging log output.

+

https-proxy

+ +

A proxy to use for outgoing https requests. If the HTTPS_PROXY or +https_proxy or HTTP_PROXY or http_proxy environment variables are set, +proxy settings will be honored by the underlying request library.

+

if-present

+ +

If true, npm will not exit with an error code when run-script is invoked for +a script that isn't defined in the scripts section of package.json. This +option can be used when it's desirable to optionally run a script when it's +present and fail if the script fails. This is useful, for example, when running +scripts that may only apply for some builds in an otherwise generic CI setup.

+

ignore-scripts

+ +

If true, npm does not run scripts specified in package.json files.

+

init-module

+ +

A module that will be loaded by the npm init command. See the +documentation for the +init-package-json module +for more information, or npm-init(1).

+

init-author-name

+ +

The value npm init should use by default for the package author's name.

+

init-author-email

+ +

The value npm init should use by default for the package author's email.

+

init-author-url

+ +

The value npm init should use by default for the package author's homepage.

+

init-license

+ +

The value npm init should use by default for the package license.

+

init-version

+ +

The value that npm init should use by default for the package +version number, if not already set in package.json.

+

json

+ +

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.

+

key

+ +

A client key to pass when accessing the registry. Values should be in PEM +format with newlines replaced by the string "\n". For example:

+
key="-----BEGIN PRIVATE KEY-----\nXXXX\nXXXX\n-----END PRIVATE KEY-----"
+

It is not the path to a key file (and there is no "keyfile" option).

+ + +

If true, then local installs will link if there is a suitable globally +installed package.

+

Note that this means that local installs can cause things to be +installed into the global space at the same time. The link is only done +if one of the two conditions are met:

+ +

local-address

+ +

The IP address of the local interface to use when making connections +to the npm registry. Must be IPv4 in versions of Node prior to 0.12.

+

loglevel

+ +

What level of logs to report. On failure, all logs are written to +npm-debug.log in the current working directory.

+

Any logs of a higher level than the setting are shown. +The default is "warn", which shows warn and error output.

+

logstream

+ +

This is the stream that is passed to the +npmlog module at run time.

+

It cannot be set from the command line, but if you are using npm +programmatically, you may wish to send logs to somewhere other than +stderr.

+

If the color config is set to true, then this stream will receive +colored output if it is a TTY.

+

long

+ +

Show extended information in npm ls and npm search.

+

maxsockets

+ +

The maximum number of connections to use per origin (protocol/host/port +combination). Passed to the http Agent used to make the request.

+

message

+ +

Commit message which is used by npm version when creating version commit.

+

Any "%s" in the message will be replaced with the version number.

+

node-version

+ +

The node version to use when checking a package's engines map.

+

npat

+ +

Run tests on installation.

+

onload-script

+ +

A node module to require() when npm loads. Useful for programmatic +usage.

+

optional

+ +

Attempt to install packages in the optionalDependencies object. Note +that if these packages fail to install, the overall installation +process is not aborted.

+

parseable

+ +

Output parseable results from commands that write to +standard output.

+

prefix

+ +

The location to install global items. If set on the command line, then +it forces non-global commands to run in the specified folder.

+

production

+ +

Set to true to run in "production" mode.

+
    +
  1. devDependencies are not installed at the topmost level when running +local npm install without any arguments.
  2. +
  3. Set the NODE_ENV="production" for lifecycle scripts.
  4. +
+

proprietary-attribs

+ +

Whether or not to include proprietary extended attributes in the +tarballs created by npm.

+

Unless you are expecting to unpack package tarballs with something other +than npm -- particularly a very outdated tar implementation -- leave +this as true.

+

proxy

+ +

A proxy to use for outgoing http requests. If the HTTP_PROXY or +http_proxy environment variables are set, proxy settings will be +honored by the underlying request library.

+

rebuild-bundle

+ +

Rebuild bundled dependencies after installation.

+

registry

+ +

The base URL of the npm package registry.

+

rollback

+ +

Remove failed installs.

+

save

+ +

Save installed packages to a package.json file as dependencies.

+

When used with the npm rm command, it removes it from the dependencies +object.

+

Only works if there is already a package.json file present.

+

save-bundle

+ +

If a package would be saved at install time by the use of --save, +--save-dev, or --save-optional, then also put it in the +bundleDependencies list.

+

When used with the npm rm command, it removes it from the +bundledDependencies list.

+

save-dev

+ +

Save installed packages to a package.json file as devDependencies.

+

When used with the npm rm command, it removes it from the +devDependencies object.

+

Only works if there is already a package.json file present.

+

save-exact

+ +

Dependencies saved to package.json using --save, --save-dev or +--save-optional will be configured with an exact version rather than +using npm's default semver range operator.

+

save-optional

+ +

Save installed packages to a package.json file as +optionalDependencies.

+

When used with the npm rm command, it removes it from the +devDependencies object.

+

Only works if there is already a package.json file present.

+

save-prefix

+ +

Configure how versions of packages installed to a package.json file via +--save or --save-dev get prefixed.

+

For example if a package has version 1.2.3, by default its version is +set to ^1.2.3 which allows minor upgrades for that package, but after +npm config set save-prefix='~' it would be set to ~1.2.3 which only allows +patch upgrades.

+

scope

+ +

Associate an operation with a scope for a scoped registry. Useful when logging +in to a private registry for the first time: +npm login --scope=@organization --registry=registry.organization.com, which +will cause @organization to be mapped to the registry for future installation +of packages specified according to the pattern @organization/package.

+

searchopts

+ +

Space-separated options that are always passed to search.

+

searchexclude

+ +

Space-separated options that limit the results from search.

+

searchsort

+ +

Indication of which field to sort search results by. Prefix with a - +character to indicate reverse sort.

+

shell

+ +

The shell to run for the npm explore command.

+

shrinkwrap

+ +

If set to false, then ignore npm-shrinkwrap.json files when +installing.

+

sign-git-tag

+ +

If set to true, then the npm version command will tag the version +using -s to add a signature.

+

Note that git requires you to have set up GPG keys in your git configs +for this to work properly.

+

spin

+ +

When set to true, npm will display an ascii spinner while it is doing +things, if process.stderr is a TTY.

+

Set to false to suppress the spinner, or set to always to output +the spinner even for non-TTY outputs.

+

strict-ssl

+ +

Whether or not to do SSL key validation when making requests to the +registry via https.

+

See also the ca config.

+

tag

+ +

If you ask npm to install a package and don't tell it a specific version, then +it will install the specified tag.

+

Also the tag that is added to the package@version specified by the npm +tag command, if no explicit tag is given.

+

tag-version-prefix

+ +

If set, alters the prefix used when tagging a new version when performing a +version increment using npm-version. To remove the prefix altogether, set it +to the empty string: "".

+

Because other tools may rely on the convention that npm version tags look like +v1.0.0, only use this property if it is absolutely necessary. In +particular, use care when overriding this setting for public packages.

+

tmp

+ +

Where to store temporary files and folders. All temp files are deleted +on success, but left behind on failure for forensic purposes.

+

unicode

+ +

When set to true, npm uses unicode characters in the tree output. When +false, it uses ascii characters to draw trees.

+

unsafe-perm

+ +

Set to true to suppress the UID/GID switching when running package +scripts. If set explicitly to false, then installing as a non-root user +will fail.

+

usage

+ +

Set to show short usage output (like the -H output) +instead of complete help when doing npm-help(1).

+

user

+ +

The UID to set to when running package scripts as root.

+

userconfig

+ +

The location of user-level configuration settings.

+

umask

+ +

The "umask" value to use when setting the file creation mode on files +and folders.

+

Folders and executables are given a mode which is 0777 masked against +this value. Other files are given a mode which is 0666 masked against +this value. Thus, the defaults are 0755 and 0644 respectively.

+

user-agent

+ +

Sets a User-Agent to the request header

+

version

+ +

If true, output the npm version and exit successfully.

+

Only relevant when specified explicitly on the command line.

+

versions

+ +

If true, output the npm version as well as node's process.versions map, and +exit successfully.

+

Only relevant when specified explicitly on the command line.

+

viewer

+ +

The program to use to view help content.

+

Set to "browser" to view html help content in the default web browser.

+

SEE ALSO

+ + +
+ + + + + + + + + + + +