diff options
Diffstat (limited to 'deps/npm/html/api')
38 files changed, 120 insertions, 120 deletions
diff --git a/deps/npm/html/api/bin.html b/deps/npm/html/api/bin.html index 95d225ad71..de99c6463a 100644 --- a/deps/npm/html/api/bin.html +++ b/deps/npm/html/api/bin.html @@ -19,7 +19,7 @@ <p>This function should not be used programmatically. Instead, just refer to the <code>npm.bin</code> member.</p> </div> -<p id="footer">bin — npm@1.1.46</p> +<p id="footer">bin — npm@1.1.47</p> <script> ;(function () { var wrapper = document.getElementById("wrapper") diff --git a/deps/npm/html/api/bugs.html b/deps/npm/html/api/bugs.html index 272deb7ab3..caebfc8d9f 100644 --- a/deps/npm/html/api/bugs.html +++ b/deps/npm/html/api/bugs.html @@ -14,7 +14,7 @@ <h2 id="DESCRIPTION">DESCRIPTION</h2> -<p>This command tries to guess at the likely location of a package's +<p>This command tries to guess at the likely location of a package's bug tracker URL, and then tries to open it using the <code>--browser</code> config param.</p> @@ -25,7 +25,7 @@ optional version number.</p> <p>This command will launch a browser, so this command may not be the most friendly for programmatic use.</p> </div> -<p id="footer">bugs — npm@1.1.46</p> +<p id="footer">bugs — npm@1.1.47</p> <script> ;(function () { var wrapper = document.getElementById("wrapper") diff --git a/deps/npm/html/api/commands.html b/deps/npm/html/api/commands.html index b058ca06fe..d7187462aa 100644 --- a/deps/npm/html/api/commands.html +++ b/deps/npm/html/api/commands.html @@ -28,7 +28,7 @@ usage, or <code>man 3 npm-<command></code> for programmatic usage.</p> <ul><li><a href="../doc/index.html">index(1)</a></li></ul> </div> -<p id="footer">commands — npm@1.1.46</p> +<p id="footer">commands — npm@1.1.47</p> <script> ;(function () { var wrapper = document.getElementById("wrapper") diff --git a/deps/npm/html/api/config.html b/deps/npm/html/api/config.html index d7e5300239..10eeb3a842 100644 --- a/deps/npm/html/api/config.html +++ b/deps/npm/html/api/config.html @@ -22,7 +22,7 @@ element in the array tells config what to do. Possible values are:</p> <ul><li><p><code>set</code></p><p>Sets a config parameter. The second element in <code>args</code> is interpreted as the key, and the third element is interpreted as the value.</p></li><li><p><code>get</code></p><p>Gets the value of a config parameter. The second element in <code>args</code> is the key to get the value of.</p></li><li><p><code>delete</code> (<code>rm</code> or <code>del</code>)</p><p>Deletes a parameter from the config. The second element in <code>args</code> is the -key to delete.</p></li><li><p><code>list</code> (<code>ls</code>)</p><p>Show all configs that aren't secret. No parameters necessary.</p></li><li><p><code>edit</code>:</p><p>Opens the config file in the default editor. This command isn't very useful +key to delete.</p></li><li><p><code>list</code> (<code>ls</code>)</p><p>Show all configs that aren't secret. No parameters necessary.</p></li><li><p><code>edit</code>:</p><p>Opens the config file in the default editor. This command isn't very useful programmatically, but it is made available.</p></li></ul> <p>To programmatically access npm configuration settings, or set them for @@ -33,7 +33,7 @@ functions instead.</p> <ul><li><a href="../api/npm.html">npm(3)</a></li></ul> </div> -<p id="footer">config — npm@1.1.46</p> +<p id="footer">config — npm@1.1.47</p> <script> ;(function () { var wrapper = document.getElementById("wrapper") diff --git a/deps/npm/html/api/deprecate.html b/deps/npm/html/api/deprecate.html index c9445b30f6..3d3eb7f2ea 100644 --- a/deps/npm/html/api/deprecate.html +++ b/deps/npm/html/api/deprecate.html @@ -17,7 +17,7 @@ <p>This command will update the npm registry entry for a package, providing a deprecation warning to all who attempt to install it.</p> -<p>The 'args' parameter must have exactly two elements:</p> +<p>The 'args' parameter must have exactly two elements:</p> <ul><li><p><code>package[@version]</code></p><p>The <code>version</code> portion is optional, and may be either a range, or a specific version, or a tag.</p></li><li><p><code>message</code></p><p>The warning message that will be printed whenever a user attempts to @@ -30,7 +30,7 @@ install the package.</p></li></ul> <ul><li><a href="../api/publish.html">publish(3)</a></li><li><a href="../api/unpublish.html">unpublish(3)</a></li><li><a href="../doc/registry.html">registry(1)</a></li></ul> </div> -<p id="footer">deprecate — npm@1.1.46</p> +<p id="footer">deprecate — npm@1.1.47</p> <script> ;(function () { var wrapper = document.getElementById("wrapper") diff --git a/deps/npm/html/api/docs.html b/deps/npm/html/api/docs.html index f16c063a64..f17d7f2ad2 100644 --- a/deps/npm/html/api/docs.html +++ b/deps/npm/html/api/docs.html @@ -14,7 +14,7 @@ <h2 id="DESCRIPTION">DESCRIPTION</h2> -<p>This command tries to guess at the likely location of a package's +<p>This command tries to guess at the likely location of a package's documentation URL, and then tries to open it using the <code>--browser</code> config param.</p> @@ -25,7 +25,7 @@ optional version number.</p> <p>This command will launch a browser, so this command may not be the most friendly for programmatic use.</p> </div> -<p id="footer">docs — npm@1.1.46</p> +<p id="footer">docs — npm@1.1.47</p> <script> ;(function () { var wrapper = document.getElementById("wrapper") diff --git a/deps/npm/html/api/edit.html b/deps/npm/html/api/edit.html index e0abe85922..edab113e70 100644 --- a/deps/npm/html/api/edit.html +++ b/deps/npm/html/api/edit.html @@ -14,14 +14,14 @@ <h2 id="DESCRIPTION">DESCRIPTION</h2> -<p>Opens the package folder in the default editor (or whatever you've +<p>Opens the package folder in the default editor (or whatever you've configured as the npm <code>editor</code> config -- see <code>npm help config</code>.)</p> <p>After it has been edited, the package is rebuilt so as to pick up any changes in compiled packages.</p> <p>For instance, you can do <code>npm install connect</code> to install connect -into your package, and then <code>npm.commands.edit(["connect"], callback)</code> +into your package, and then <code>npm.commands.edit(["connect"], callback)</code> to make a few changes to your locally installed copy.</p> <p>The first parameter is a string array with a single element, the package @@ -30,7 +30,7 @@ to open. The package can optionally have a version number attached.</p> <p>Since this command opens an editor in a new process, be careful about where and how this is used.</p> </div> -<p id="footer">edit — npm@1.1.46</p> +<p id="footer">edit — npm@1.1.47</p> <script> ;(function () { var wrapper = document.getElementById("wrapper") diff --git a/deps/npm/html/api/explore.html b/deps/npm/html/api/explore.html index 74ab5f65fd..749b44ebe5 100644 --- a/deps/npm/html/api/explore.html +++ b/deps/npm/html/api/explore.html @@ -22,9 +22,9 @@ immediately terminates.</p> <p>Note that the package is <em>not</em> automatically rebuilt afterwards, so be sure to use <code>npm rebuild <pkg></code> if you make any changes.</p> -<p>The first element in the 'args' parameter must be a package name. After that is the optional command, which can be any number of strings. All of the strings will be combined into one, space-delimited command.</p> +<p>The first element in the 'args' parameter must be a package name. After that is the optional command, which can be any number of strings. All of the strings will be combined into one, space-delimited command.</p> </div> -<p id="footer">explore — npm@1.1.46</p> +<p id="footer">explore — npm@1.1.47</p> <script> ;(function () { var wrapper = document.getElementById("wrapper") diff --git a/deps/npm/html/api/help-search.html b/deps/npm/html/api/help-search.html index ead170077d..e43f2d9db1 100644 --- a/deps/npm/html/api/help-search.html +++ b/deps/npm/html/api/help-search.html @@ -24,7 +24,7 @@ are multiple results, the results are printed to the screen formatted and the array of results is returned. Each result is an object with these properties:</p> <ul><li>hits: -A map of args to number of hits on that arg. For example, {"npm": 3}</li><li>found: +A map of args to number of hits on that arg. For example, {"npm": 3}</li><li>found: Total number of unique args that matched.</li><li>totalHits: Total number of hits.</li><li>lines: An array of all matching lines (and some adjacent lines).</li><li>file: @@ -32,7 +32,7 @@ Name of the file that matched</li></ul> <p>The silent parameter is not neccessary not used, but it may in the future.</p> </div> -<p id="footer">help-search — npm@1.1.46</p> +<p id="footer">help-search — npm@1.1.47</p> <script> ;(function () { var wrapper = document.getElementById("wrapper") diff --git a/deps/npm/html/api/init.html b/deps/npm/html/api/init.html index e751091115..3220ae6c30 100644 --- a/deps/npm/html/api/init.html +++ b/deps/npm/html/api/init.html @@ -17,25 +17,25 @@ <p>This will ask you a bunch of questions, and then write a package.json for you.</p> <p>It attempts to make reasonable guesses about what you want things to be set to, -and then writes a package.json file with the options you've selected.</p> +and then writes a package.json file with the options you've selected.</p> -<p>If you already have a package.json file, it'll read that first, and default to +<p>If you already have a package.json file, it'll read that first, and default to the options in there.</p> <p>It is strictly additive, so it does not delete options from your package.json without a really good reason to do so.</p> -<p>Since this function expects to be run on the command-line, it doesn't work very +<p>Since this function expects to be run on the command-line, it doesn't work very well as a programmatically. The best option is to roll your own, and since JavaScript makes it stupid simple to output formatted JSON, that is the -preferred method. If you're sure you want to handle command-line prompting, +preferred method. If you're sure you want to handle command-line prompting, then go ahead and use this programmatically.</p> <h2 id="SEE-ALSO">SEE ALSO</h2> <p><a href="../doc/json.html">json(1)</a></p> </div> -<p id="footer">init — npm@1.1.46</p> +<p id="footer">init — npm@1.1.47</p> <script> ;(function () { var wrapper = document.getElementById("wrapper") diff --git a/deps/npm/html/api/install.html b/deps/npm/html/api/install.html index 7d127ac008..1696bfb24b 100644 --- a/deps/npm/html/api/install.html +++ b/deps/npm/html/api/install.html @@ -16,16 +16,16 @@ <p>This acts much the same ways as installing on the command-line.</p> -<p>The 'where' parameter is optional and only used internally, and it specifies +<p>The 'where' parameter is optional and only used internally, and it specifies where the packages should be installed to.</p> -<p>The 'packages' parameter is an array of strings. Each element in the array is +<p>The 'packages' parameter is an array of strings. Each element in the array is the name of a package to be installed.</p> -<p>Finally, 'callback' is a function that will be called when all packages have been +<p>Finally, 'callback' is a function that will be called when all packages have been installed or when an error has been encountered.</p> </div> -<p id="footer">install — npm@1.1.46</p> +<p id="footer">install — npm@1.1.47</p> <script> ;(function () { var wrapper = document.getElementById("wrapper") diff --git a/deps/npm/html/api/link.html b/deps/npm/html/api/link.html index e4edfcab00..0933fa9a7c 100644 --- a/deps/npm/html/api/link.html +++ b/deps/npm/html/api/link.html @@ -24,7 +24,7 @@ symbolic link from <code>prefix/package-name</code> to the current folder.</p> folder to the global symlink.</p> <p>When creating tarballs for <code>npm publish</code>, the linked packages are -"snapshotted" to their current state by resolving the symbolic links.</p> +"snapshotted" to their current state by resolving the symbolic links.</p> <p>This is handy for installing your own stuff, so that you can work on it and test it @@ -34,12 +34,12 @@ iteratively without having to continually rebuild.</p> <pre><code>npm.commands.link(cb) # creates global link from the cwd # (say redis package) -npm.commands.link('redis', cb) # link-install the package</code></pre> +npm.commands.link('redis', cb) # link-install the package</code></pre> <p>Now, any changes to the redis package will be reflected in the package in the current working directory</p> </div> -<p id="footer">link — npm@1.1.46</p> +<p id="footer">link — npm@1.1.47</p> <script> ;(function () { var wrapper = document.getElementById("wrapper") diff --git a/deps/npm/html/api/load.html b/deps/npm/html/api/load.html index 4e29bc078e..44b55a107a 100644 --- a/deps/npm/html/api/load.html +++ b/deps/npm/html/api/load.html @@ -27,12 +27,12 @@ config object.</p> <p>For example, to emulate the --dev flag, pass an object that looks like this:</p> <pre><code>{ - "dev": true + "dev": true }</code></pre> <p>For a list of all the available command-line configs, see <code>npm help config</code></p> </div> -<p id="footer">load — npm@1.1.46</p> +<p id="footer">load — npm@1.1.47</p> <script> ;(function () { var wrapper = document.getElementById("wrapper") diff --git a/deps/npm/html/api/ls.html b/deps/npm/html/api/ls.html index 8f0bac74e6..a846f319d3 100644 --- a/deps/npm/html/api/ls.html +++ b/deps/npm/html/api/ls.html @@ -30,7 +30,7 @@ but the data will still be returned.</p> <p>Callback is provided an error if one occurred, the full data about which packages are installed and which dependencies they will receive, and a -"lite" data object which just shows which versions are installed where. +"lite" data object which just shows which versions are installed where. Note that the full data object is a circular structure, so care must be taken if it is serialized to JSON.</p> @@ -55,11 +55,11 @@ taken if it is serialized to JSON.</p> <p>List packages in the global install prefix instead of in the current project.</p> -<p>Note, if parseable is set or long isn't set, then duplicates will be trimmed. +<p>Note, if parseable is set or long isn't set, then duplicates will be trimmed. This means that if a submodule a same dependency as a parent module, then the dependency will only be output once.</p> </div> -<p id="footer">ls — npm@1.1.46</p> +<p id="footer">ls — npm@1.1.47</p> <script> ;(function () { var wrapper = document.getElementById("wrapper") diff --git a/deps/npm/html/api/npm.html b/deps/npm/html/api/npm.html index 647410f258..2bd6c59e1a 100644 --- a/deps/npm/html/api/npm.html +++ b/deps/npm/html/api/npm.html @@ -10,21 +10,21 @@ <h2 id="SYNOPSIS">SYNOPSIS</h2> -<pre><code>var npm = require("npm") +<pre><code>var npm = require("npm") npm.load(configObject, function (er, npm) { - // use the npm object, now that it's loaded. + // use the npm object, now that it's loaded. npm.config.set(key, val) val = npm.config.get(key) - console.log("prefix = %s", npm.prefix) + console.log("prefix = %s", npm.prefix) - npm.commands.install(["package"], cb) + npm.commands.install(["package"], cb) })</code></pre> <h2 id="VERSION">VERSION</h2> -<p>1.1.46</p> +<p>1.1.47</p> <h2 id="DESCRIPTION">DESCRIPTION</h2> @@ -32,7 +32,7 @@ npm.load(configObject, function (er, npm) { To find documentation of the command line client, see <code><a href="../doc/npm.html">npm(1)</a></code>.</p> -<p>Prior to using npm's commands, +<p>Prior to using npm's commands, <code>npm.load()</code> must be called with an object hash of top-level configs. In the npm command line client, this set of configs is parsed from the command line options. Additional @@ -57,9 +57,9 @@ command.</p> <ul><li><p><code>npm.load(configs, cb)</code></p><p>Load the configuration params, and call the <code>cb</code> function once the globalconfig and userconfig files have been loaded as well, or on -nextTick if they've already been loaded.</p></li><li><p><code>npm.config</code></p><p>An object for accessing npm configuration parameters.</p><ul><li><p><code>npm.config.get(key)</code></p></li><li><code>npm.config.set(key, val)</code></li><li><p><code>npm.config.del(key)</code></p></li></ul></li><li><p><code>npm.dir</code> or <code>npm.root</code></p><p>The <code>node_modules</code> directory where npm will operate.</p></li><li><p><code>npm.prefix</code></p><p>The prefix where npm is operating. (Most often the current working +nextTick if they've already been loaded.</p></li><li><p><code>npm.config</code></p><p>An object for accessing npm configuration parameters.</p><ul><li><p><code>npm.config.get(key)</code></p></li><li><code>npm.config.set(key, val)</code></li><li><p><code>npm.config.del(key)</code></p></li></ul></li><li><p><code>npm.dir</code> or <code>npm.root</code></p><p>The <code>node_modules</code> directory where npm will operate.</p></li><li><p><code>npm.prefix</code></p><p>The prefix where npm is operating. (Most often the current working directory.)</p></li><li><p><code>npm.cache</code></p><p>The place where npm keeps JSON and tarballs it fetches from the -registry (or uploads to the registry).</p></li><li><p><code>npm.tmp</code></p><p>npm's temporary working directory.</p></li><li><p><code>npm.deref</code></p><p>Get the "real" name for a command that has either an alias or +registry (or uploads to the registry).</p></li><li><p><code>npm.tmp</code></p><p>npm's temporary working directory.</p></li><li><p><code>npm.deref</code></p><p>Get the "real" name for a command that has either an alias or abbreviation.</p></li></ul> <h2 id="MAGIC">MAGIC</h2> @@ -74,11 +74,11 @@ the error or results.</p> <p>For example, this would work in a node repl:</p> -<pre><code>> npm = require("npm") +<pre><code>> npm = require("npm") > npm.load() // wait a sec... -> npm.install("dnode", "express")</code></pre> +> npm.install("dnode", "express")</code></pre> -<p>Note that that <em>won't</em> work in a node program, since the <code>install</code> +<p>Note that that <em>won't</em> work in a node program, since the <code>install</code> method will get called before the configuration load is completed.</p> <h2 id="ABBREVS">ABBREVS</h2> @@ -89,9 +89,9 @@ method names. Use the <code>npm.deref</code> method to find the real name.</p> <p>For example:</p> -<pre><code>var cmd = npm.deref("unp") // cmd === "unpublish"</code></pre> +<pre><code>var cmd = npm.deref("unp") // cmd === "unpublish"</code></pre> </div> -<p id="footer">npm — npm@1.1.46</p> +<p id="footer">npm — npm@1.1.47</p> <script> ;(function () { var wrapper = document.getElementById("wrapper") diff --git a/deps/npm/html/api/outdated.html b/deps/npm/html/api/outdated.html index 0d57e2e9d1..8cc578fc8d 100644 --- a/deps/npm/html/api/outdated.html +++ b/deps/npm/html/api/outdated.html @@ -17,9 +17,9 @@ <p>This command will check the registry to see if the specified packages are currently outdated.</p> -<p>If the 'packages' parameter is left out, npm will check all packages.</p> +<p>If the 'packages' parameter is left out, npm will check all packages.</p> </div> -<p id="footer">outdated — npm@1.1.46</p> +<p id="footer">outdated — npm@1.1.47</p> <script> ;(function () { var wrapper = document.getElementById("wrapper") diff --git a/deps/npm/html/api/owner.html b/deps/npm/html/api/owner.html index 084174cc26..e2b04b8018 100644 --- a/deps/npm/html/api/owner.html +++ b/deps/npm/html/api/owner.html @@ -14,7 +14,7 @@ <h2 id="DESCRIPTION">DESCRIPTION</h2> -<p>The first element of the 'args' parameter defines what to do, and the subsequent +<p>The first element of the 'args' parameter defines what to do, and the subsequent elements depend on the action. Possible values for the action are (order of parameters are given in parenthesis):</p> @@ -27,14 +27,14 @@ Remove a user from the package owner list. This immediately revokes their privileges.</li></ul> <p>Note that there is only one level of access. Either you can modify a package, -or you can't. Future versions may contain more fine-grained access levels, but +or you can't. Future versions may contain more fine-grained access levels, but that is not implemented at this time.</p> <h2 id="SEE-ALSO">SEE ALSO</h2> <ul><li><a href="../api/publish.html">publish(3)</a></li><li><a href="../doc/registry.html">registry(1)</a></li></ul> </div> -<p id="footer">owner — npm@1.1.46</p> +<p id="footer">owner — npm@1.1.47</p> <script> ;(function () { var wrapper = document.getElementById("wrapper") diff --git a/deps/npm/html/api/pack.html b/deps/npm/html/api/pack.html index 58e1730467..72fde9f2e0 100644 --- a/deps/npm/html/api/pack.html +++ b/deps/npm/html/api/pack.html @@ -14,7 +14,7 @@ <h2 id="DESCRIPTION">DESCRIPTION</h2> -<p>For anything that's installable (that is, a package folder, tarball, +<p>For anything that's installable (that is, a package folder, tarball, tarball url, name@tag, name@version, or name), this command will fetch it to the cache, and then copy the tarball to the current working directory as <code><name>-<version>.tgz</code>, and then write the filenames out to @@ -25,7 +25,7 @@ overwritten the second time.</p> <p>If no arguments are supplied, then npm packs the current package folder.</p> </div> -<p id="footer">pack — npm@1.1.46</p> +<p id="footer">pack — npm@1.1.47</p> <script> ;(function () { var wrapper = document.getElementById("wrapper") diff --git a/deps/npm/html/api/prefix.html b/deps/npm/html/api/prefix.html index a1606e7907..e20a8fecaf 100644 --- a/deps/npm/html/api/prefix.html +++ b/deps/npm/html/api/prefix.html @@ -16,12 +16,12 @@ <p>Print the prefix to standard out.</p> -<p>'args' is never used and callback is never called with data. -'args' must be present or things will break.</p> +<p>'args' is never used and callback is never called with data. +'args' must be present or things will break.</p> <p>This function is not useful programmatically</p> </div> -<p id="footer">prefix — npm@1.1.46</p> +<p id="footer">prefix — npm@1.1.47</p> <script> ;(function () { var wrapper = document.getElementById("wrapper") diff --git a/deps/npm/html/api/prune.html b/deps/npm/html/api/prune.html index b6acae2414..a075b3583a 100644 --- a/deps/npm/html/api/prune.html +++ b/deps/npm/html/api/prune.html @@ -14,16 +14,16 @@ <h2 id="DESCRIPTION">DESCRIPTION</h2> -<p>This command removes "extraneous" packages.</p> +<p>This command removes "extraneous" packages.</p> <p>The first parameter is optional, and it specifies packages to be removed.</p> <p>No packages are specified, then all packages will be checked.</p> <p>Extraneous packages are packages that are not listed on the parent -package's dependencies list.</p> +package's dependencies list.</p> </div> -<p id="footer">prune — npm@1.1.46</p> +<p id="footer">prune — npm@1.1.47</p> <script> ;(function () { var wrapper = document.getElementById("wrapper") diff --git a/deps/npm/html/api/publish.html b/deps/npm/html/api/publish.html index 188e68f57c..6d828ef78e 100644 --- a/deps/npm/html/api/publish.html +++ b/deps/npm/html/api/publish.html @@ -15,7 +15,7 @@ <h2 id="DESCRIPTION">DESCRIPTION</h2> <p>Publishes a package to the registry so that it can be installed by name. -Possible values in the 'packages' array are:</p> +Possible values in the 'packages' array are:</p> <ul><li><p><code><folder></code>: A folder containing a package.json file</p></li><li><p><code><tarball></code>: @@ -26,13 +26,13 @@ with a package.json file inside.</p></li></ul> current working directory.</p> <p>This command could fails if one of the packages specified already exists in -the registry. Overwrites when the "force" environment variable is set.</p> +the registry. Overwrites when the "force" environment variable is set.</p> <h2 id="SEE-ALSO">SEE ALSO</h2> <ul><li><a href="../doc/registry.html">registry(1)</a></li><li><a href="../doc/adduser.html">adduser(1)</a></li><li><a href="../api/owner.html">owner(3)</a></li></ul> </div> -<p id="footer">publish — npm@1.1.46</p> +<p id="footer">publish — npm@1.1.47</p> <script> ;(function () { var wrapper = document.getElementById("wrapper") diff --git a/deps/npm/html/api/rebuild.html b/deps/npm/html/api/rebuild.html index 543a1d37cb..bdb156fcff 100644 --- a/deps/npm/html/api/rebuild.html +++ b/deps/npm/html/api/rebuild.html @@ -16,13 +16,13 @@ <p>This command runs the <code>npm build</code> command on each of the matched packages. This is useful when you install a new version of node, and must recompile all your C++ addons with -the new binary. If no 'packages' parameter is specify, every package will be rebuilt.</p> +the new binary. If no 'packages' parameter is specify, every package will be rebuilt.</p> <h2 id="CONFIGURATION">CONFIGURATION</h2> <p>See <code>npm help build</code></p> </div> -<p id="footer">rebuild — npm@1.1.46</p> +<p id="footer">rebuild — npm@1.1.47</p> <script> ;(function () { var wrapper = document.getElementById("wrapper") diff --git a/deps/npm/html/api/restart.html b/deps/npm/html/api/restart.html index 6092be64f0..10b07fbdd7 100644 --- a/deps/npm/html/api/restart.html +++ b/deps/npm/html/api/restart.html @@ -14,11 +14,11 @@ <h2 id="DESCRIPTION">DESCRIPTION</h2> -<p>This runs a package's "restart" script, if one was provided. -Otherwise it runs package's "stop" script, if one was provided, and then -the "start" script.</p> +<p>This runs a package's "restart" script, if one was provided. +Otherwise it runs package's "stop" script, if one was provided, and then +the "start" script.</p> -<p>If no version is specified, then it restarts the "active" version.</p> +<p>If no version is specified, then it restarts the "active" version.</p> <p>npm can run tests on multiple packages. Just specify multiple packages in the <code>packages</code> parameter.</p> @@ -27,7 +27,7 @@ in the <code>packages</code> parameter.</p> <ul><li><a href="../api/start.html">start(3)</a></li><li><a href="../api/stop.html">stop(3)</a></li></ul> </div> -<p id="footer">restart — npm@1.1.46</p> +<p id="footer">restart — npm@1.1.47</p> <script> ;(function () { var wrapper = document.getElementById("wrapper") diff --git a/deps/npm/html/api/root.html b/deps/npm/html/api/root.html index 7a931107ca..bf6819bf45 100644 --- a/deps/npm/html/api/root.html +++ b/deps/npm/html/api/root.html @@ -16,12 +16,12 @@ <p>Print the effective <code>node_modules</code> folder to standard out.</p> -<p>'args' is never used and callback is never called with data. -'args' must be present or things will break.</p> +<p>'args' is never used and callback is never called with data. +'args' must be present or things will break.</p> <p>This function is not useful programmatically.</p> </div> -<p id="footer">root — npm@1.1.46</p> +<p id="footer">root — npm@1.1.47</p> <script> ;(function () { var wrapper = document.getElementById("wrapper") diff --git a/deps/npm/html/api/run-script.html b/deps/npm/html/api/run-script.html index 48839c576c..489bee5998 100644 --- a/deps/npm/html/api/run-script.html +++ b/deps/npm/html/api/run-script.html @@ -14,12 +14,12 @@ <h2 id="DESCRIPTION">DESCRIPTION</h2> -<p>This runs an arbitrary command from a package's "scripts" object.</p> +<p>This runs an arbitrary command from a package's "scripts" object.</p> <p>It is used by the test, start, restart, and stop commands, but can be called directly, as well.</p> -<p>The 'args' parameter is an array of strings. Behavior depends on the number +<p>The 'args' parameter is an array of strings. Behavior depends on the number of elements. If there is only one element, npm assumes that the element represents a command to be run on the local repository. If there is more than one element, then the first is assumed to be the package and the second is @@ -29,7 +29,7 @@ assumed to be the command to run. All other elements are ignored.</p> <ul><li><a href="../doc/scripts.html">scripts(1)</a></li><li><a href="../api/test.html">test(3)</a></li><li><a href="../api/start.html">start(3)</a></li><li><a href="../api/restart.html">restart(3)</a></li><li><a href="../api/stop.html">stop(3)</a></li></ul> </div> -<p id="footer">run-script — npm@1.1.46</p> +<p id="footer">run-script — npm@1.1.47</p> <script> ;(function () { var wrapper = document.getElementById("wrapper") diff --git a/deps/npm/html/api/search.html b/deps/npm/html/api/search.html index ea27de2796..daeb8f02e7 100644 --- a/deps/npm/html/api/search.html +++ b/deps/npm/html/api/search.html @@ -19,20 +19,20 @@ <ul><li>searchTerms: Array of search terms. These terms are case-insensitive.</li><li>silent: If true, npm will not log anything to the console.</li><li>staleness: -This is the threshold for stale packages. "Fresh" packages are not refreshed +This is the threshold for stale packages. "Fresh" packages are not refreshed from the registry. This value is measured in seconds.</li><li><p>callback: Returns an object where each key is the name of a package, and the value -is information about that package along with a 'words' property, which is +is information about that package along with a 'words' property, which is a space-delimited string of all of the interesting words in that package. The only properties included are those that are searched, which generally include:</p><ul><li>name</li><li>description</li><li>maintainers</li><li>url</li><li>keywords</li></ul></li></ul> <p>A search on the registry excludes any result that does not match all of the search terms. It also removes any items from the results that contain an -excluded term (the "searchexclude" config). The search is case insensitive -and doesn't try to read your mind (it doesn't do any verb tense matching or the +excluded term (the "searchexclude" config). The search is case insensitive +and doesn't try to read your mind (it doesn't do any verb tense matching or the like).</p> </div> -<p id="footer">search — npm@1.1.46</p> +<p id="footer">search — npm@1.1.47</p> <script> ;(function () { var wrapper = document.getElementById("wrapper") diff --git a/deps/npm/html/api/shrinkwrap.html b/deps/npm/html/api/shrinkwrap.html index ad3b59b94c..6550188225 100644 --- a/deps/npm/html/api/shrinkwrap.html +++ b/deps/npm/html/api/shrinkwrap.html @@ -16,17 +16,17 @@ <p>This acts much the same ways as shrinkwrapping on the command-line.</p> -<p>This command does not take any arguments, but 'args' must be defined. +<p>This command does not take any arguments, but 'args' must be defined. Beyond that, if any arguments are passed in, npm will politely warn that it does not take positional arguments.</p> -<p>If the 'silent' parameter is set to true, nothing will be output to the screen, +<p>If the 'silent' parameter is set to true, nothing will be output to the screen, but the shrinkwrap file will still be written.</p> -<p>Finally, 'callback' is a function that will be called when the shrinkwrap has +<p>Finally, 'callback' is a function that will be called when the shrinkwrap has been saved.</p> </div> -<p id="footer">shrinkwrap — npm@1.1.46</p> +<p id="footer">shrinkwrap — npm@1.1.47</p> <script> ;(function () { var wrapper = document.getElementById("wrapper") diff --git a/deps/npm/html/api/start.html b/deps/npm/html/api/start.html index 99d8a98c22..60b286f23d 100644 --- a/deps/npm/html/api/start.html +++ b/deps/npm/html/api/start.html @@ -14,12 +14,12 @@ <h2 id="DESCRIPTION">DESCRIPTION</h2> -<p>This runs a package's "start" script, if one was provided.</p> +<p>This runs a package's "start" script, if one was provided.</p> <p>npm can run tests on multiple packages. Just specify multiple packages in the <code>packages</code> parameter.</p> </div> -<p id="footer">start — npm@1.1.46</p> +<p id="footer">start — npm@1.1.47</p> <script> ;(function () { var wrapper = document.getElementById("wrapper") diff --git a/deps/npm/html/api/stop.html b/deps/npm/html/api/stop.html index 10a77c235b..40bcc97251 100644 --- a/deps/npm/html/api/stop.html +++ b/deps/npm/html/api/stop.html @@ -14,12 +14,12 @@ <h2 id="DESCRIPTION">DESCRIPTION</h2> -<p>This runs a package's "stop" script, if one was provided.</p> +<p>This runs a package's "stop" script, if one was provided.</p> <p>npm can run stop on multiple packages. Just specify multiple packages in the <code>packages</code> parameter.</p> </div> -<p id="footer">stop — npm@1.1.46</p> +<p id="footer">stop — npm@1.1.47</p> <script> ;(function () { var wrapper = document.getElementById("wrapper") diff --git a/deps/npm/html/api/submodule.html b/deps/npm/html/api/submodule.html index c221270094..397f35e015 100644 --- a/deps/npm/html/api/submodule.html +++ b/deps/npm/html/api/submodule.html @@ -18,7 +18,7 @@ in its package.json description then add it as a git submodule at <code>node_modules/<pkg name></code>.</p> -<p>This is a convenience only. From then on, it's up to you to manage +<p>This is a convenience only. From then on, it's up to you to manage updates by using the appropriate git commands. npm will stubbornly refuse to update, modify, or remove anything with a <code>.git</code> subfolder in it.</p> @@ -33,7 +33,7 @@ dependencies into the submodule folder.</p> <ul><li>npm help json</li><li>git help submodule</li></ul> </div> -<p id="footer">submodule — npm@1.1.46</p> +<p id="footer">submodule — npm@1.1.47</p> <script> ;(function () { var wrapper = document.getElementById("wrapper") diff --git a/deps/npm/html/api/tag.html b/deps/npm/html/api/tag.html index 08f5ed2d8b..1b684bc369 100644 --- a/deps/npm/html/api/tag.html +++ b/deps/npm/html/api/tag.html @@ -17,7 +17,7 @@ <p>Tags the specified version of the package with the specified tag, or the <code>--tag</code> config if not specified.</p> -<p>The 'package@version' is an array of strings, but only the first two elements are +<p>The 'package@version' is an array of strings, but only the first two elements are currently used.</p> <p>The first element must be in the form package@version, where package @@ -29,7 +29,7 @@ parameter is missing or falsey (empty), the default froom the config will be used. For more information about how to set this config, check <code>man 3 npm-config</code> for programmatic usage or <code>man npm-config</code> for cli usage.</p> </div> -<p id="footer">tag — npm@1.1.46</p> +<p id="footer">tag — npm@1.1.47</p> <script> ;(function () { var wrapper = document.getElementById("wrapper") diff --git a/deps/npm/html/api/test.html b/deps/npm/html/api/test.html index f6fa9903b5..19c6d135dc 100644 --- a/deps/npm/html/api/test.html +++ b/deps/npm/html/api/test.html @@ -14,7 +14,7 @@ <h2 id="DESCRIPTION">DESCRIPTION</h2> -<p>This runs a package's "test" script, if one was provided.</p> +<p>This runs a package's "test" script, if one was provided.</p> <p>To run tests as a condition of installation, set the <code>npat</code> config to true.</p> @@ -22,7 +22,7 @@ true.</p> <p>npm can run tests on multiple packages. Just specify multiple packages in the <code>packages</code> parameter.</p> </div> -<p id="footer">test — npm@1.1.46</p> +<p id="footer">test — npm@1.1.47</p> <script> ;(function () { var wrapper = document.getElementById("wrapper") diff --git a/deps/npm/html/api/uninstall.html b/deps/npm/html/api/uninstall.html index cd8585ff73..8f2fbef981 100644 --- a/deps/npm/html/api/uninstall.html +++ b/deps/npm/html/api/uninstall.html @@ -16,13 +16,13 @@ <p>This acts much the same ways as uninstalling on the command-line.</p> -<p>The 'packages' parameter is an array of strings. Each element in the array is +<p>The 'packages' parameter is an array of strings. Each element in the array is the name of a package to be uninstalled.</p> -<p>Finally, 'callback' is a function that will be called when all packages have been +<p>Finally, 'callback' is a function that will be called when all packages have been uninstalled or when an error has been encountered.</p> </div> -<p id="footer">uninstall — npm@1.1.46</p> +<p id="footer">uninstall — npm@1.1.47</p> <script> ;(function () { var wrapper = document.getElementById("wrapper") diff --git a/deps/npm/html/api/unpublish.html b/deps/npm/html/api/unpublish.html index 03411bd01a..2656c8a895 100644 --- a/deps/npm/html/api/unpublish.html +++ b/deps/npm/html/api/unpublish.html @@ -26,7 +26,7 @@ is what is meant.</p> <p>If no version is specified, or if all versions are removed then the root package entry is removed from the registry entirely.</p> </div> -<p id="footer">unpublish — npm@1.1.46</p> +<p id="footer">unpublish — npm@1.1.47</p> <script> ;(function () { var wrapper = document.getElementById("wrapper") diff --git a/deps/npm/html/api/update.html b/deps/npm/html/api/update.html index edf5272705..c0cf54f953 100644 --- a/deps/npm/html/api/update.html +++ b/deps/npm/html/api/update.html @@ -16,9 +16,9 @@ <p>Updates a package, upgrading it to the latest version. It also installs any missing packages.</p> -<p>The 'packages' argument is an array of packages to update. The 'callback' parameter will be called when done or when an error occurs.</p> +<p>The 'packages' argument is an array of packages to update. The 'callback' parameter will be called when done or when an error occurs.</p> </div> -<p id="footer">update — npm@1.1.46</p> +<p id="footer">update — npm@1.1.47</p> <script> ;(function () { var wrapper = document.getElementById("wrapper") diff --git a/deps/npm/html/api/version.html b/deps/npm/html/api/version.html index a3224d007f..d220815609 100644 --- a/deps/npm/html/api/version.html +++ b/deps/npm/html/api/version.html @@ -24,7 +24,7 @@ fail if the repo is not clean.</p> parameter. The difference, however, is this function will fail if it does not have exactly one element. The only element should be a version number.</p> </div> -<p id="footer">version — npm@1.1.46</p> +<p id="footer">version — npm@1.1.47</p> <script> ;(function () { var wrapper = document.getElementById("wrapper") diff --git a/deps/npm/html/api/view.html b/deps/npm/html/api/view.html index d6ba5e66a5..9d5401668f 100644 --- a/deps/npm/html/api/view.html +++ b/deps/npm/html/api/view.html @@ -17,10 +17,10 @@ <p>This command shows data about a package and prints it to the stream referenced by the <code>outfd</code> config, which defaults to stdout.</p> -<p>The "args" parameter is an ordered list that closely resembles the command-line +<p>The "args" parameter is an ordered list that closely resembles the command-line usage. The elements should be ordered such that the first element is the package and version (package@version). The version is optional. After that, -the rest of the parameters are fields with optional subfields ("field.subfield") +the rest of the parameters are fields with optional subfields ("field.subfield") which can be used to get only the information desired from the registry.</p> <p>The callback will be passed all of the data returned by the query.</p> @@ -28,51 +28,51 @@ which can be used to get only the information desired from the registry.</p> <p>For example, to get the package registry entry for the <code>connect</code> package, you can do this:</p> -<pre><code>npm.commands.view(["connect"], callback)</code></pre> +<pre><code>npm.commands.view(["connect"], callback)</code></pre> -<p>If no version is specified, "latest" is assumed.</p> +<p>If no version is specified, "latest" is assumed.</p> <p>Field names can be specified after the package descriptor. For example, to show the dependencies of the <code>ronn</code> package at version 0.3.5, you could do the following:</p> -<pre><code>npm.commands.view(["ronn@0.3.5", "dependencies"], callback)</code></pre> +<pre><code>npm.commands.view(["ronn@0.3.5", "dependencies"], callback)</code></pre> <p>You can view child field by separating them with a period. To view the git repository URL for the latest version of npm, you could do this:</p> -<pre><code>npm.commands.view(["npm", "repository.url"], callback)</code></pre> +<pre><code>npm.commands.view(["npm", "repository.url"], callback)</code></pre> <p>For fields that are arrays, requesting a non-numeric field will return all of the values from the objects in the list. For example, to get all -the contributor names for the "express" project, you can do this:</p> +the contributor names for the "express" project, you can do this:</p> -<pre><code>npm.commands.view(["express", "contributors.email"], callback)</code></pre> +<pre><code>npm.commands.view(["express", "contributors.email"], callback)</code></pre> <p>You may also use numeric indices in square braces to specifically select an item in an array field. To just get the email address of the first contributor in the list, you can do this:</p> -<pre><code>npm.commands.view(["express", "contributors[0].email"], callback)</code></pre> +<pre><code>npm.commands.view(["express", "contributors[0].email"], callback)</code></pre> <p>Multiple fields may be specified, and will be printed one after another. For exampls, to get all the contributor names and email addresses, you can do this:</p> -<pre><code>npm.commands.view(["express", "contributors.name", "contributors.email"], callback)</code></pre> +<pre><code>npm.commands.view(["express", "contributors.name", "contributors.email"], callback)</code></pre> -<p>"Person" fields are shown as a string if they would be shown as an +<p>"Person" fields are shown as a string if they would be shown as an object. So, for example, this will show the list of npm contributors in the shortened string format. (See <code>npm help json</code> for more on this.)</p> -<pre><code>npm.commands.view(["npm", "contributors"], callback)</code></pre> +<pre><code>npm.commands.view(["npm", "contributors"], callback)</code></pre> <p>If a version range is provided, then data will be printed for every matching version of the package. This will show which version of jsdom was required by each matching version of yui3:</p> -<pre><code>npm.commands.view(["yui3@'>0.5.4'", "dependencies.jsdom"], callback)</code></pre> +<pre><code>npm.commands.view(["yui3@'>0.5.4'", "dependencies.jsdom"], callback)</code></pre> <h2 id="OUTPUT">OUTPUT</h2> @@ -86,7 +86,7 @@ will be prefixed with the version it applies to.</p> <p>If multiple fields are requested, than each of them are prefixed with the field name.</p> -<p>Console output can be disabled by setting the 'silent' parameter to true.</p> +<p>Console output can be disabled by setting the 'silent' parameter to true.</p> <h2 id="RETURN-VALUE">RETURN VALUE</h2> @@ -99,7 +99,7 @@ the field name.</p> <p>corresponding to the list of fields selected.</p> </div> -<p id="footer">view — npm@1.1.46</p> +<p id="footer">view — npm@1.1.47</p> <script> ;(function () { var wrapper = document.getElementById("wrapper") diff --git a/deps/npm/html/api/whoami.html b/deps/npm/html/api/whoami.html index 99981f38a7..ead157fadd 100644 --- a/deps/npm/html/api/whoami.html +++ b/deps/npm/html/api/whoami.html @@ -16,12 +16,12 @@ <p>Print the <code>username</code> config to standard output.</p> -<p>'args' is never used and callback is never called with data. -'args' must be present or things will break.</p> +<p>'args' is never used and callback is never called with data. +'args' must be present or things will break.</p> <p>This function is not useful programmatically</p> </div> -<p id="footer">whoami — npm@1.1.46</p> +<p id="footer">whoami — npm@1.1.47</p> <script> ;(function () { var wrapper = document.getElementById("wrapper") |