diff options
| author | isaacs <i@izs.me> | 2011-11-26 09:21:03 -0800 |
|---|---|---|
| committer | isaacs <i@izs.me> | 2011-11-27 13:09:04 -0800 |
| commit | e85a95dfa3469dd9cc6a3a15c8e686c14b3238a6 (patch) | |
| tree | 85a3a6e0f45f4b6540dcb75af2e9383db0f6e4c3 /deps/npm/html/doc/config.html | |
| parent | fc0a4c2781b4b579d247a24393dada7f92663abe (diff) | |
| download | node-e85a95dfa3469dd9cc6a3a15c8e686c14b3238a6.tar.gz | |
Remove npm's .gitignore, add generated docs
Diffstat (limited to 'deps/npm/html/doc/config.html')
| -rw-r--r-- | deps/npm/html/doc/config.html | 621 |
1 files changed, 621 insertions, 0 deletions
diff --git a/deps/npm/html/doc/config.html b/deps/npm/html/doc/config.html new file mode 100644 index 000000000..dfd27d5b1 --- /dev/null +++ b/deps/npm/html/doc/config.html @@ -0,0 +1,621 @@ +<!doctype html> +<html> + <title>config</title> + <meta http-equiv="content-type" value="text/html;utf-8"> + <link rel="stylesheet" type="text/css" href="./style.css"> + + <body> + <div id="wrapper"> +<h1><a href="../doc/config.html">config</a></h1> <p>Manage the npm configuration file</p> + +<h2 id="SYNOPSIS">SYNOPSIS</h2> + +<pre><code>npm config set <key> <value> [--global] +npm config get <key> +npm config delete <key> +npm config list +npm config edit +npm get <key> +npm set <key> <value> [--global]</code></pre> + +<h2 id="DESCRIPTION">DESCRIPTION</h2> + +<p>npm gets its configuration values from 6 sources, in this priority:</p> + +<h3 id="Command-Line-Flags">Command Line Flags</h3> + +<p>Putting <code>--foo bar</code> on the command line sets the +<code>foo</code> configuration parameter to <code>"bar"</code>. A <code>--</code> argument tells the cli +parser to stop reading flags. A <code>--flag</code> parameter that is at the <em>end</em> of +the command will be given the value of <code>true</code>.</p> + +<h3 id="Environment-Variables">Environment Variables</h3> + +<p>Any environment variables that start with <code>npm_config_</code> will be interpreted +as a configuration parameter. For example, putting <code>npm_config_foo=bar</code> in +your environment will set the <code>foo</code> configuration parameter to <code>bar</code>. Any +environment configurations that are not given a value will be given the value +of <code>true</code>. Config values are case-insensitive, so <code>NPM_CONFIG_FOO=bar</code> will +work the same.</p> + +<h3 id="Per-user-config-file">Per-user config file</h3> + +<p><code>$HOME/.npmrc</code> (or the <code>userconfig</code> param, if set above)</p> + +<p>This file is an ini-file formatted list of <code>key = value</code> parameters.</p> + +<h3 id="Global-config-file">Global config file</h3> + +<p><code>$PREFIX/etc/npmrc</code> (or the <code>globalconfig</code> param, if set above): +This file is an ini-file formatted list of <code>key = value</code> parameters</p> + +<h3 id="Built-in-config-file">Built-in config file</h3> + +<p><code>path/to/npm/itself/npmrc</code></p> + +<p>This is an unchangeable "builtin" +configuration file that npm keeps consistent across updates. Set +fields in here using the <code>./configure</code> script that comes with npm. +This is primarily for distribution maintainers to override default +configs in a standard and consistent manner.</p> + +<h3 id="Default-Configs">Default Configs</h3> + +<p>A set of configuration parameters that are internal to npm, and are +defaults if nothing else is specified.</p> + +<h2 id="Sub-commands">Sub-commands</h2> + +<p>Config supports the following sub-commands:</p> + +<h3 id="set">set</h3> + +<pre><code>npm config set key value</code></pre> + +<p>Sets the config key to the value.</p> + +<p>If value is omitted, then it sets it to "true".</p> + +<h3 id="get">get</h3> + +<pre><code>npm config get key</code></pre> + +<p>Echo the config value to stdout.</p> + +<h3 id="list">list</h3> + +<pre><code>npm config list</code></pre> + +<p>Show all the config settings.</p> + +<h3 id="delete">delete</h3> + +<pre><code>npm config delete key</code></pre> + +<p>Deletes the key from all configuration files.</p> + +<h3 id="edit">edit</h3> + +<pre><code>npm config edit</code></pre> + +<p>Opens the config file in an editor. Use the <code>--global</code> flag to edit the +global config.</p> + +<h2 id="Shorthands-and-Other-CLI-Niceties">Shorthands and Other CLI Niceties</h2> + +<p>The following shorthands are parsed on the command-line:</p> + +<ul><li><code>-v</code>: <code>--version</code></li><li><code>-h</code>, <code>-?</code>, <code>--help</code>, <code>-H</code>: <code>--usage</code></li><li><code>-s</code>, <code>--silent</code>: <code>--loglevel silent</code></li><li><code>-d</code>: <code>--loglevel info</code></li><li><code>-dd</code>, <code>--verbose</code>: <code>--loglevel verbose</code></li><li><code>-ddd</code>: <code>--loglevel silly</code></li><li><code>-g</code>: <code>--global</code></li><li><code>-l</code>: <code>--long</code></li><li><code>-m</code>: <code>--message</code></li><li><code>-p</code>, <code>--porcelain</code>: <code>--parseable</code></li><li><code>-reg</code>: <code>--registry</code></li><li><code>-v</code>: <code>--version</code></li><li><code>-f</code>: <code>--force</code></li><li><code>-l</code>: <code>--long</code></li><li><code>-desc</code>: <code>--description</code></li><li><code>-S</code>: <code>--save</code></li><li><code>-y</code>: <code>--yes</code></li><li><code>-n</code>: <code>--yes false</code></li><li><code>ll</code> and <code>la</code> commands: <code>ls --long</code></li></ul> + +<p>If the specified configuration param resolves unambiguously to a known +configuration parameter, then it is expanded to that configuration +parameter. For example:</p> + +<pre><code>npm ls --par +# same as: +npm ls --parseable</code></pre> + +<p>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:</p> + +<pre><code>npm ls -gpld +# same as: +npm ls --global --parseable --long --loglevel info</code></pre> + +<h2 id="Per-Package-Config-Settings">Per-Package Config Settings</h2> + +<p>When running scripts (see <code><a href="../doc/scripts.html">scripts(1)</a></code>) +the package.json "config" keys are overwritten in the environment if +there is a config param of <code><name>[@<version>]:<key></code>. For example, if +the package.json has this:</p> + +<pre><code>{ "name" : "foo" +, "config" : { "port" : "8080" } +, "scripts" : { "start" : "node server.js" } }</code></pre> + +<p>and the server.js is this:</p> + +<pre><code>http.createServer(...).listen(process.env.npm_package_config_port)</code></pre> + +<p>then the user could change the behavior by doing:</p> + +<pre><code>npm config set foo:port 80</code></pre> + +<h2 id="Config-Settings">Config Settings</h2> + +<h3 id="always-auth">always-auth</h3> + +<ul><li>Default: false</li><li>Type: Boolean</li></ul> + +<p>Force npm to always require authentication when accessing the registry, +even for <code>GET</code> requests.</p> + +<h3 id="bin-publish">bin-publish</h3> + +<ul><li>Default: false</li><li>Type: Boolean</li></ul> + +<p>If set to true, then binary packages will be created on publish.</p> + +<p>This is the way to opt into the "bindist" behavior described below.</p> + +<h3 id="bindist">bindist</h3> + +<ul><li>Default: Unstable node versions, <code>null</code>, otherwise +<code>"<node version>-<platform>-<os release>"</code></li><li>Type: String or <code>null</code></li></ul> + +<p>Experimental: on stable versions of node, binary distributions will be +created with this tag. If a user then installs that package, and their +<code>bindist</code> tag is found in the list of binary distributions, they will +get that prebuilt version.</p> + +<p>Pre-build node packages have their preinstall, install, and postinstall +scripts stripped (since they are run prior to publishing), and do not +have their <code>build</code> directories automatically ignored.</p> + +<p>It's yet to be seen if this is a good idea.</p> + +<h3 id="browser">browser</h3> + +<ul><li>Default: OS X: <code>"open"</code>, others: <code>"google-chrome"</code></li><li>Type: String</li></ul> + +<p>The browser that is called by the <code>npm docs</code> command to open websites.</p> + +<h3 id="ca">ca</h3> + +<ul><li>Default: The npm CA certificate</li><li>Type: String or null</li></ul> + +<p>The Certificate Authority signing certificate that is trusted for SSL +connections to the registry.</p> + +<p>Set to <code>null</code> to only allow "known" registrars, or to a specific CA cert +to trust only that specific signing authority.</p> + +<p>See also the <code>strict-ssl</code> config.</p> + +<h3 id="cache">cache</h3> + +<ul><li>Default: Windows: <code>~/npm-cache</code>, Posix: <code>~/.npm</code></li><li>Type: path</li></ul> + +<p>The location of npm's cache directory. See <code><a href="../doc/cache.html">cache(1)</a></code></p> + +<h3 id="color">color</h3> + +<ul><li>Default: true on Posix, false on Windows</li><li>Type: Boolean or <code>"always"</code></li></ul> + +<p>If false, never shows colors. If <code>"always"</code> then always shows colors. +If true, then only prints color codes for tty file descriptors.</p> + +<h3 id="depth">depth</h3> + +<ul><li>Default: Infinity</li><li>Type: Number</li></ul> + +<p>The depth to go when recursing directories for <code>npm ls</code> and +<code>npm cache ls</code>.</p> + +<h3 id="description">description</h3> + +<ul><li>Default: true</li><li>Type: Boolean</li></ul> + +<p>Show the description in <code>npm search</code></p> + +<h3 id="dev">dev</h3> + +<ul><li>Default: false</li><li>Type: Boolean</li></ul> + +<p>Install <code>dev-dependencies</code> along with packages.</p> + +<p>Note that <code>dev-dependencies</code> are also installed if the <code>npat</code> flag is +set.</p> + +<h3 id="editor">editor</h3> + +<ul><li>Default: <code>EDITOR</code> environment variable if set, or <code>"vi"</code> on Posix, +or <code>"notepad"</code> on Windows.</li><li>Type: path</li></ul> + +<p>The command to run for <code>npm edit</code> or <code>npm config edit</code>.</p> + +<h3 id="force">force</h3> + +<ul><li>Default: false</li><li>Type: Boolean</li></ul> + +<p>Makes various commands more forceful.</p> + +<ul><li>lifecycle script failure does not block progress.</li><li>publishing clobbers previously published versions.</li><li>skips cache when requesting from the registry.</li><li>prevents checks against clobbering non-npm files.</li></ul> + +<h3 id="global">global</h3> + +<ul><li>Default: false</li><li>Type: Boolean</li></ul> + +<p>Operates in "global" mode, so that packages are installed into the +<code>prefix</code> folder instead of the current working directory. See +<code><a href="../doc/folders.html">folders(1)</a></code> for more on the differences in behavior.</p> + +<ul><li>packages are installed into the <code>prefix/node_modules</code> folder, instead of the +current working directory.</li><li>bin files are linked to <code>prefix/bin</code></li><li>man pages are linked to <code>prefix/share/man</code></li></ul> + +<h3 id="globalconfig">globalconfig</h3> + +<ul><li>Default: {prefix}/etc/npmrc</li><li>Type: path</li></ul> + +<p>The config file to read for global config options.</p> + +<h3 id="globalignorefile">globalignorefile</h3> + +<ul><li>Default: {prefix}/etc/npmignore</li><li>Type: path</li></ul> + +<p>The config file to read for global ignore patterns to apply to all users +and all projects.</p> + +<p>If not found, but there is a "gitignore" file in the +same directory, then that will be used instead.</p> + +<h3 id="group">group</h3> + +<ul><li>Default: GID of the current process</li><li>Type: String or Number</li></ul> + +<p>The group to use when running package scripts in global mode as the root +user.</p> + +<h3 id="https-proxy">https-proxy</h3> + +<ul><li>Default: the <code>HTTPS_PROXY</code> or <code>https_proxy</code> or <code>HTTP_PROXY</code> or +<code>http_proxy</code> environment variables.</li><li>Type: url</li></ul> + +<p>A proxy to use for outgoing https requests.</p> + +<h3 id="ignore">ignore</h3> + +<ul><li>Default: ""</li><li>Type: string</li></ul> + +<p>A white-space separated list of glob patterns of files to always exclude +from packages when building tarballs.</p> + +<h3 id="init-version">init.version</h3> + +<ul><li>Default: "0.0.0"</li><li>Type: semver</li></ul> + +<p>The value <code>npm init</code> should use by default for the package version.</p> + +<h3 id="init-author-name">init.author.name</h3> + +<ul><li>Default: "0.0.0"</li><li>Type: String</li></ul> + +<p>The value <code>npm init</code> should use by default for the package author's name.</p> + +<h3 id="init-author-email">init.author.email</h3> + +<ul><li>Default: ""</li><li>Type: String</li></ul> + +<p>The value <code>npm init</code> should use by default for the package author's email.</p> + +<h3 id="init-author-url">init.author.url</h3> + +<ul><li>Default: ""</li><li>Type: String</li></ul> + +<p>The value <code>npm init</code> should use by default for the package author's homepage.</p> + +<h3 id="link">link</h3> + +<ul><li>Default: false</li><li>Type: Boolean</li></ul> + +<p>If true, then local installs will link if there is a suitable globally +installed package.</p> + +<p>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:</p> + +<ul><li>The package is not already installed globally, or</li><li>the globally installed version is identical to the version that is +being installed locally.</li></ul> + +<h3 id="logfd">logfd</h3> + +<ul><li>Default: stderr file descriptor</li><li>Type: Number or Stream</li></ul> + +<p>The location to write log output.</p> + +<h3 id="loglevel">loglevel</h3> + +<ul><li>Default: "warn"</li><li>Type: String</li><li>Values: "silent", "win", "error", "warn", "info", "verbose", "silly"</li></ul> + +<p>What level of logs to report. On failure, <em>all</em> logs are written to +<code>npm-debug.log</code> in the current working directory.</p> + +<h3 id="logprefix">logprefix</h3> + +<ul><li>Default: true on Posix, false on Windows</li><li>Type: Boolean</li></ul> + +<p>Whether or not to prefix log messages with "npm" and the log level. See +also "color" and "loglevel".</p> + +<h3 id="long">long</h3> + +<ul><li>Default: false</li><li>Type: Boolean</li></ul> + +<p>Show extended information in <code>npm ls</code></p> + +<h3 id="message">message</h3> + +<ul><li>Default: "%s"</li><li>Type: String</li></ul> + +<p>Commit message which is used by <code>npm version</code> when creating version commit.</p> + +<p>Any "%s" in the message will be replaced with the version number.</p> + +<h3 id="node-version">node-version</h3> + +<ul><li>Default: process.version</li><li>Type: semver or false</li></ul> + +<p>The node version to use when checking package's "engines" hash.</p> + +<h3 id="npat">npat</h3> + +<ul><li>Default: false</li><li>Type: Boolean</li></ul> + +<p>Run tests on installation and report results to the +<code>npaturl</code>.</p> + +<h3 id="npaturl">npaturl</h3> + +<ul><li>Default: Not yet implemented</li><li>Type: url</li></ul> + +<p>The url to report npat test results.</p> + +<h3 id="onload-script">onload-script</h3> + +<ul><li>Default: false</li><li>Type: path</li></ul> + +<p>A node module to <code>require()</code> when npm loads. Useful for programmatic +usage.</p> + +<h3 id="outfd">outfd</h3> + +<ul><li>Default: standard output file descriptor</li><li>Type: Number or Stream</li></ul> + +<p>Where to write "normal" output. This has no effect on log output.</p> + +<h3 id="parseable">parseable</h3> + +<ul><li>Default: false</li><li>Type: Boolean</li></ul> + +<p>Output parseable results from commands that write to +standard output.</p> + +<h3 id="prefix">prefix</h3> + +<ul><li>Default: node's process.installPrefix</li><li>Type: path</li></ul> + +<p>The location to install global items. If set on the command line, then +it forces non-global commands to run in the specified folder.</p> + +<h3 id="production">production</h3> + +<ul><li>Default: false</li><li>Type: Boolean</li></ul> + +<p>Set to true to run in "production" mode.</p> + +<ol><li>devDependencies are not installed at the topmost level when running +local <code>npm install</code> without any arguments.</li><li>Set the NODE_ENV="production" for lifecycle scripts.</li></ol> + +<h3 id="proxy">proxy</h3> + +<ul><li>Default: <code>HTTP_PROXY</code> or <code>http_proxy</code> environment variable, or null</li><li>Type: url</li></ul> + +<p>A proxy to use for outgoing http requests.</p> + +<h3 id="rebuild-bundle">rebuild-bundle</h3> + +<ul><li>Default: true</li><li>Type: Boolean</li></ul> + +<p>Rebuild bundled dependencies after installation.</p> + +<h3 id="registry">registry</h3> + +<ul><li>Default: https://registry.npmjs.org/</li><li>Type: url</li></ul> + +<p>The base URL of the npm package registry.</p> + +<h3 id="rollback">rollback</h3> + +<ul><li>Default: true</li><li>Type: Boolean</li></ul> + +<p>Remove failed installs.</p> + +<h3 id="save">save</h3> + +<ul><li>Default: false</li><li>Type: Boolean</li></ul> + +<p>Save installed packages to a package.json file as dependencies.</p> + +<p>Only works if there is already a package.json file present.</p> + +<h3 id="searchopts">searchopts</h3> + +<ul><li>Default: ""</li><li>Type: String</li></ul> + +<p>Space-separated options that are always passed to search.</p> + +<h3 id="searchexclude">searchexclude</h3> + +<ul><li>Default: ""</li><li>Type: String</li></ul> + +<p>Space-separated options that limit the results from search.</p> + +<h3 id="shell">shell</h3> + +<ul><li>Default: SHELL environment variable, or "bash" on Posix, or "cmd" on +Windows</li><li>Type: path</li></ul> + +<p>The shell to run for the <code>npm explore</code> command.</p> + +<h3 id="strict-ssl">strict-ssl</h3> + +<ul><li>Default: true</li><li>Type: Boolean</li></ul> + +<p>Whether or not to do SSL key validation when making requests to the +registry via https.</p> + +<p>See also the <code>ca</code> config.</p> + +<h3 id="tag">tag</h3> + +<ul><li>Default: latest</li><li>Type: String</li></ul> + +<p>If you ask npm to install a package and don't tell it a specific version, then +it will install the specified tag.</p> + +<p>Also the tag that is added to the package@version specified by the <code>npm +tag</code> command, if no explicit tag is given.</p> + +<h3 id="tmp">tmp</h3> + +<ul><li>Default: TMPDIR environment variable, or "/tmp"</li><li>Type: path</li></ul> + +<p>Where to store temporary files and folders. All temp files are deleted +on success, but left behind on failure for forensic purposes.</p> + +<h3 id="unicode">unicode</h3> + +<ul><li>Default: true</li><li>Type: Boolean</li></ul> + +<p>When set to true, npm uses unicode characters in the tree output. When +false, it uses ascii characters to draw trees.</p> + +<h3 id="unsafe-perm">unsafe-perm</h3> + +<ul><li>Default: false if running as root, true otherwise</li><li>Type: Boolean</li></ul> + +<p>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.</p> + +<h3 id="usage">usage</h3> + +<ul><li>Default: false</li><li>Type: Boolean</li></ul> + +<p>Set to show short usage output (like the -H output) +instead of complete help when doing <code><a href="../doc/help.html">help(1)</a></code>.</p> + +<h3 id="user">user</h3> + +<ul><li>Default: "nobody"</li><li>Type: String or Number</li></ul> + +<p>The UID to set to when running package scripts as root.</p> + +<h3 id="username">username</h3> + +<ul><li>Default: null</li><li>Type: String</li></ul> + +<p>The username on the npm registry. Set with <code>npm adduser</code></p> + +<h3 id="userconfig">userconfig</h3> + +<ul><li>Default: ~/.npmrc</li><li>Type: path</li></ul> + +<p>The location of user-level configuration settings.</p> + +<h3 id="userignorefile">userignorefile</h3> + +<ul><li>Default: ~/.npmignore</li><li>Type: path</li></ul> + +<p>The location of a user-level ignore file to apply to all packages.</p> + +<p>If not found, but there is a .gitignore file in the same directory, then +that will be used instead.</p> + +<h3 id="umask">umask</h3> + +<ul><li>Default: 022</li><li>Type: Octal numeric string</li></ul> + +<p>The "umask" value to use when setting the file creation mode on files +and folders.</p> + +<p>Folders and executables are given a mode which is <code>0777</code> masked against +this value. Other files are given a mode which is <code>0666</code> masked against +this value. Thus, the defaults are <code>0755</code> and <code>0644</code> respectively.</p> + +<h3 id="version">version</h3> + +<ul><li>Default: false</li><li>Type: boolean</li></ul> + +<p>If true, output the npm version and exit successfully.</p> + +<p>Only relevant when specified explicitly on the command line.</p> + +<h3 id="viewer">viewer</h3> + +<ul><li>Default: "man" on Posix, "browser" on Windows</li><li>Type: path</li></ul> + +<p>The program to use to view help content.</p> + +<p>Set to <code>"browser"</code> to view html help content in the default web browser.</p> + +<h3 id="yes">yes</h3> + +<ul><li>Default: null</li><li>Type: Boolean or null</li></ul> + +<p>If set to <code>null</code>, then prompt the user for responses in some +circumstances.</p> + +<p>If set to <code>true</code>, then answer "yes" to any prompt. If set to <code>false</code> +then answer "no" to any prompt.</p> + +<h2 id="SEE-ALSO">SEE ALSO</h2> + +<ul><li><a href="../doc/folders.html">folders(1)</a></li><li><a href="../doc/npm.html">npm(1)</a></li></ul> +</div> +<p id="footer">config — npm@1.1.0-alpha-2</p> +<script> +;(function () { +var wrapper = document.getElementById("wrapper") +var els = Array.prototype.slice.call(wrapper.getElementsByTagName("*"), 0) + .filter(function (el) { + return el.parentNode === wrapper + && el.tagName.match(/H[1-6]/) + && el.id + }) +var l = 2 + , toc = document.createElement("ul") +toc.innerHTML = els.map(function (el) { + var i = el.tagName.charAt(1) + , out = "" + while (i > l) { + out += "<ul>" + l ++ + } + while (i < l) { + out += "</ul>" + l -- + } + out += "<li><a href='#" + el.id + "'>" + + ( el.innerText || el.text || el.innerHTML) + + "</a>" + return out +}).join("\n") +toc.id = "toc" +document.body.appendChild(toc) +})() +</script> +</body></html> |