diff options
author | isaacs <i@izs.me> | 2011-09-04 22:21:43 +0400 |
---|---|---|
committer | isaacs <i@izs.me> | 2011-09-04 22:21:43 +0400 |
commit | b19d70344d6b37872f96761376b918a5036b1dbb (patch) | |
tree | 75838e594ba0d22a06e1e062a552a6a58b77eaf6 /html | |
parent | 32f2673e00ddf0714c4a43a4a31d9d8cab981ab8 (diff) |
Add SEE ALSO to all doc sections, and rebuild
Diffstat (limited to 'html')
52 files changed, 313 insertions, 37 deletions
diff --git a/html/doc/adduser.html b/html/doc/adduser.html index f6b44ecb4..8835a3e66 100644 --- a/html/doc/adduser.html +++ b/html/doc/adduser.html @@ -365,6 +365,10 @@ authorize on a new machine.</p> <p>Default: http://registry.npmjs.org/</p> <p>The base URL of the npm package registry.</p> + +<h2 id="SEE-ALSO">SEE ALSO</h2> + +<ul><li><a href="registry.html">npm registry</a></li><li><a href="config.html">npm config</a></li></ul> </div> <script> ;(function () { diff --git a/html/doc/bin.html b/html/doc/bin.html index 43fa59258..2389e5c79 100644 --- a/html/doc/bin.html +++ b/html/doc/bin.html @@ -346,6 +346,10 @@ input.submit, input#submit, input.button, button, input[type=submit] { <h2 id="DESCRIPTION">DESCRIPTION</h2> <p>Print the folder where npm will install executables.</p> + +<h2 id="SEE-ALSO">SEE ALSO</h2> + +<ul><li><a href="prefix.html">npm prefix</a></li><li><a href="root.html">npm root</a></li><li><a href="folders.html">npm folders</a></li><li><a href="config.html">npm config</a></li></ul> </div> <script> ;(function () { diff --git a/html/doc/bundle.html b/html/doc/bundle.html index c60e95e69..ac6e00ac8 100644 --- a/html/doc/bundle.html +++ b/html/doc/bundle.html @@ -346,6 +346,10 @@ that it is no longer necessary, as the default behavior is now to install packages into the local space.</p> <p>Just use <code>npm install</code> now to do what <code>npm bundle</code> used to do.</p> + +<h2 id="SEE-ALSO">SEE ALSO</h2> + +<ul><li><a href="install.html">npm install</a></li></ul> </div> <script> ;(function () { diff --git a/html/doc/cache.html b/html/doc/cache.html index 2c11671c7..11f812dbb 100644 --- a/html/doc/cache.html +++ b/html/doc/cache.html @@ -390,6 +390,10 @@ they do not make an HTTP request to the registry.</p> <p>Default: <code>$HOME/.npm</code> on Posix, or <code>$HOME/npm-cache</code> on Windows.</p> <p>The root cache folder.</p> + +<h2 id="SEE-ALSO">SEE ALSO</h2> + +<ul><li><a href="folders.html">npm folders</a></li><li><a href="config.html">npm config</a></li><li><a href="install.html">npm install</a></li><li><a href="publish.html">npm publish</a></li><li><a href="pack.html">npm pack</a></li></ul> </div> <script> ;(function () { diff --git a/html/doc/changelog.html b/html/doc/changelog.html index a3caad0d1..1a8c68ba9 100644 --- a/html/doc/changelog.html +++ b/html/doc/changelog.html @@ -360,6 +360,10 @@ input.submit, input#submit, input.button, button, input[type=submit] { <h3 id="0-0">0.0</h3> <ul><li>Lots of sketches and false starts; abandoned a few times</li><li>Core functionality established</li></ul> + +<h2 id="SEE-ALSO">SEE ALSO</h2> + +<ul><li><a href="npm.html">npm</a></li><li><a href="faq.html">npm faq</a></li></ul> </div> <script> ;(function () { diff --git a/html/doc/coding-style.html b/html/doc/coding-style.html index 639c72c7e..0350cc161 100644 --- a/html/doc/coding-style.html +++ b/html/doc/coding-style.html @@ -517,6 +517,10 @@ makes it clear that it's a "throwaway" function.</p> set to anything."</p> <p>Boolean objects are verboten.</p> + +<h2 id="SEE-ALSO">SEE ALSO</h2> + +<ul><li><a href="developers.html">npm developers</a></li><li><a href="faq.html">npm faq</a></li><li><a href="npm.html">npm</a></li></ul> </div> <script> ;(function () { diff --git a/html/doc/completion.html b/html/doc/completion.html index 579db674e..7f9152256 100644 --- a/html/doc/completion.html +++ b/html/doc/completion.html @@ -357,6 +357,10 @@ that will read that file for you.</p> <p>When <code>COMP_CWORD</code>, <code>COMP_LINE</code>, and <code>COMP_POINT</code> are defined in the environment, <code>npm completion</code> acts in "plumbing mode", and outputs completions based on the arguments.</p> + +<h2 id="SEE-ALSO">SEE ALSO</h2> + +<ul><li><a href="developers.html">npm developers</a></li><li><a href="faq.html">npm faq</a></li><li><a href="npm.html">npm</a></li></ul> </div> <script> ;(function () { diff --git a/html/doc/config.html b/html/doc/config.html index 3a35efdcd..e9ff005d9 100644 --- a/html/doc/config.html +++ b/html/doc/config.html @@ -491,7 +491,7 @@ have their <code>build</code> directories automatically ignored.</p> <ul><li>Default: Windows: <code>~/npm-cache</code>, Posix: <code>~/.npm</code></li><li>Type: path</li></ul> -<p>The location of <a href="'s cache directory. See <code>npm-cache.html">npm 's cache directory. See <code>npm-cache</a></code></p> +<p>The location of npm's cache directory. See <code><a href="cache.html">npm cache</a></code></p> <h3 id="color">color</h3> @@ -524,7 +524,8 @@ set.</p> <h3 id="editor">editor</h3> -<ul><li>Default: <code>EDITOR</code> environment variable if set, or <code>"vi"</code></li><li>Type: path</li></ul> +<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> @@ -755,7 +756,8 @@ local <code>npm install</code> without any arguments.</li><li>Set the NODE_ENV=" <h3 id="shell">shell</h3> -<ul><li>Default: SHELL environment variable, or "bash"</li><li>Type: path</li></ul> +<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> @@ -856,6 +858,10 @@ 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="folders.html">npm folders</a></li><li><a href="npm.html">npm</a></li></ul> </div> <script> ;(function () { diff --git a/html/doc/deprecate.html b/html/doc/deprecate.html index e858dc0e5..c5feada0d 100644 --- a/html/doc/deprecate.html +++ b/html/doc/deprecate.html @@ -355,6 +355,10 @@ something like this:</p> <p>Note that you must be the package owner to deprecate something. See the <code>owner</code> and <code>adduser</code> help topics.</p> + +<h2 id="SEE-ALSO">SEE ALSO</h2> + +<ul><li><a href="publish.html">npm publish</a></li><li><a href="registry.html">npm registry</a></li></ul> </div> <script> ;(function () { diff --git a/html/doc/developers.html b/html/doc/developers.html index dcb7dcb0a..67a5d3ef3 100644 --- a/html/doc/developers.html +++ b/html/doc/developers.html @@ -371,7 +371,7 @@ after packing it up into a tarball (b).</p> <p>You need to have a <code>package.json</code> file in the root of your project to do much of anything with npm. That is basically the whole interface.</p> -<p>See <a href="json.html">npm json</a> for details about what goes in that file. At the very +<p>See <code><a href="json.html">npm json</a></code> for details about what goes in that file. At the very least, you need:</p> <ul><li><p>name: @@ -476,6 +476,10 @@ from a fresh checkout.</p> <p>Send emails, write blogs, blab in IRC.</p> <p>Tell the world how easy it is to install your program!</p> + +<h2 id="SEE-ALSO">SEE ALSO</h2> + +<ul><li><a href="faq.html">npm faq</a></li><li><a href="npm.html">npm</a></li><li><a href="init.html">npm init</a></li><li><a href="json.html">npm json</a></li><li><a href="scripts.html">npm scripts</a></li><li><a href="publish.html">npm publish</a></li><li><a href="adduser.html">npm adduser</a></li><li><a href="registry.html">npm registry</a></li></ul> </div> <script> ;(function () { diff --git a/html/doc/docs.html b/html/doc/docs.html index 66313fe28..1cb492697 100644 --- a/html/doc/docs.html +++ b/html/doc/docs.html @@ -349,6 +349,24 @@ npm home <pkgname></code></pre> <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> + +<h2 id="CONFIGURATION">CONFIGURATION</h2> + +<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="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> + +<h2 id="SEE-ALSO">SEE ALSO</h2> + +<ul><li><a href="publish.html">npm publish</a></li><li><a href="registry.html">npm registry</a></li><li><a href="config.html">npm config</a></li><li><a href="json.html">npm json</a></li></ul> </div> <script> ;(function () { diff --git a/html/doc/edit.html b/html/doc/edit.html index 5eb81dd28..82872bb7e 100644 --- a/html/doc/edit.html +++ b/html/doc/edit.html @@ -346,7 +346,7 @@ input.submit, input#submit, input.button, button, input[type=submit] { <h2 id="DESCRIPTION">DESCRIPTION</h2> <p>Opens the package folder in the default editor (or whatever you've -configured as the <a href=" <code>editor</code> config -- see <code>npm-config.html">npm <code>editor</code> config -- see <code>npm-config</a></code>.)</p> +configured as the npm <code>editor</code> config -- see <code><a href="config.html">npm config</a></code>.)</p> <p>After it has been edited, the package is rebuilt so as to pick up any changes in compiled packages.</p> @@ -354,6 +354,19 @@ 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 edit connect</code> to make a few changes to your locally installed copy.</p> + +<h2 id="CONFIGURATION">CONFIGURATION</h2> + +<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> + +<h2 id="SEE-ALSO">SEE ALSO</h2> + +<ul><li><a href="folders.html">npm folders</a></li><li><a href="explore.html">npm explore</a></li><li><a href="install.html">npm install</a></li><li><a href="config.html">npm config</a></li></ul> </div> <script> ;(function () { diff --git a/html/doc/explore.html b/html/doc/explore.html index 3445b725a..ccf8d44a0 100644 --- a/html/doc/explore.html +++ b/html/doc/explore.html @@ -350,8 +350,26 @@ input.submit, input#submit, input.button, button, input[type=submit] { <p>If a command is specified, then it is run in the subshell, which then immediately terminates.</p> +<p>This is particularly handy in the case of git submodules in the +<code>node_modules</code> folder:</p> + +<pre><code>npm explore some-dependency -- git pull origin master</code></pre> + <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> + +<h2 id="CONFIGURATION">CONFIGURATION</h2> + +<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> + +<h2 id="SEE-ALSO">SEE ALSO</h2> + +<ul><li><a href="submodule.html">npm submodule</a></li><li><a href="folders.html">npm folders</a></li><li><a href="edit.html">npm edit</a></li><li><a href="rebuild.html">npm rebuild</a></li><li><a href="build.html">npm build</a></li><li><a href="install.html">npm install</a></li></ul> </div> <script> ;(function () { diff --git a/html/doc/faq.html b/html/doc/faq.html index 447c0bd8a..9d75545ff 100644 --- a/html/doc/faq.html +++ b/html/doc/faq.html @@ -530,6 +530,10 @@ We'll have someone kick it or something.</p> <h2 id="Why-does-npm-hate-me">Why does npm hate me?</h2> <p>npm is not capable of hatred. It loves everyone, especially you.</p> + +<h2 id="SEE-ALSO">SEE ALSO</h2> + +<ul><li><a href="npm.html">npm</a></li><li><a href="developers.html">npm developers</a></li><li><a href="json.html">npm json</a></li><li><a href="config.html">npm config</a></li><li><a href="folders.html">npm folders</a></li></ul> </div> <script> ;(function () { diff --git a/html/doc/folders.html b/html/doc/folders.html index 83245f12f..4a48ff3b8 100644 --- a/html/doc/folders.html +++ b/html/doc/folders.html @@ -517,6 +517,10 @@ not be included in the package tarball.</p> <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 <code><a href="json.html">npm json</a></code> for more information.</p> + +<h2 id="SEE-ALSO">SEE ALSO</h2> + +<ul><li><a href="faq.html">npm faq</a></li><li><a href="json.html">npm json</a></li><li><a href="install.html">npm install</a></li><li><a href="pack.html">npm pack</a></li><li><a href="cache.html">npm cache</a></li><li><a href="config.html">npm config</a></li><li><a href="publish.html">npm publish</a></li></ul> </div> <script> ;(function () { diff --git a/html/doc/get.html b/html/doc/get.html index b7cd907dd..280f0137a 100644 --- a/html/doc/get.html +++ b/html/doc/get.html @@ -491,7 +491,7 @@ have their <code>build</code> directories automatically ignored.</p> <ul><li>Default: Windows: <code>~/npm-cache</code>, Posix: <code>~/.npm</code></li><li>Type: path</li></ul> -<p>The location of <a href="'s cache directory. See <code>npm-cache.html">npm 's cache directory. See <code>npm-cache</a></code></p> +<p>The location of npm's cache directory. See <code><a href="cache.html">npm cache</a></code></p> <h3 id="color">color</h3> @@ -524,7 +524,8 @@ set.</p> <h3 id="editor">editor</h3> -<ul><li>Default: <code>EDITOR</code> environment variable if set, or <code>"vi"</code></li><li>Type: path</li></ul> +<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> @@ -755,7 +756,8 @@ local <code>npm install</code> without any arguments.</li><li>Set the NODE_ENV=" <h3 id="shell">shell</h3> -<ul><li>Default: SHELL environment variable, or "bash"</li><li>Type: path</li></ul> +<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> @@ -856,6 +858,10 @@ 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="folders.html">npm folders</a></li><li><a href="npm.html">npm</a></li></ul> </div> <script> ;(function () { diff --git a/html/doc/global.html b/html/doc/global.html index b2764ac73..1d13c05e2 100644 --- a/html/doc/global.html +++ b/html/doc/global.html @@ -517,6 +517,10 @@ not be included in the package tarball.</p> <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 <code><a href="json.html">npm json</a></code> for more information.</p> + +<h2 id="SEE-ALSO">SEE ALSO</h2> + +<ul><li><a href="faq.html">npm faq</a></li><li><a href="json.html">npm json</a></li><li><a href="install.html">npm install</a></li><li><a href="pack.html">npm pack</a></li><li><a href="cache.html">npm cache</a></li><li><a href="config.html">npm config</a></li><li><a href="publish.html">npm publish</a></li></ul> </div> <script> ;(function () { diff --git a/html/doc/help-search.html b/html/doc/help-search.html index fab2c5051..703343f24 100644 --- a/html/doc/help-search.html +++ b/html/doc/help-search.html @@ -364,6 +364,10 @@ command directly.</p> where the terms were found in the documentation.</p> <p>If false, then help-search will just list out the help topics found.</p> + +<h2 id="SEE-ALSO">SEE ALSO</h2> + +<ul><li><a href="npm.html">npm</a></li><li><a href="faq.html">npm faq</a></li></ul> </div> <script> ;(function () { diff --git a/html/doc/home.html b/html/doc/home.html index 4266cdb30..1920a078c 100644 --- a/html/doc/home.html +++ b/html/doc/home.html @@ -349,6 +349,24 @@ npm home <pkgname></code></pre> <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> + +<h2 id="CONFIGURATION">CONFIGURATION</h2> + +<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="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> + +<h2 id="SEE-ALSO">SEE ALSO</h2> + +<ul><li><a href="publish.html">npm publish</a></li><li><a href="registry.html">npm registry</a></li><li><a href="config.html">npm config</a></li><li><a href="json.html">npm json</a></li></ul> </div> <script> ;(function () { diff --git a/html/doc/init.html b/html/doc/init.html index deaad1386..15e71c3c1 100644 --- a/html/doc/init.html +++ b/html/doc/init.html @@ -337,7 +337,7 @@ input.submit, input#submit, input.button, button, input[type=submit] { <body> <div id="wrapper"> -<h1><a href=" init.html">npm init</a></h1> <p>Interactively create a package.json file</p> +<h1>npm init(1)</h1> <p>Interactively create a package.json file</p> <h2 id="SYNOPSIS">SYNOPSIS</h2> @@ -358,7 +358,7 @@ without a really good reason to do so.</p> <h2 id="SEE-ALSO">SEE ALSO</h2> -<p><a href="json.html">npm json</a></p> +<ul><li><a href="json.html">npm json</a></li><li><a href="version.html">npm version</a></li></ul> </div> <script> ;(function () { diff --git a/html/doc/install.html b/html/doc/install.html index d0f3aac7f..e2567c81d 100644 --- a/html/doc/install.html +++ b/html/doc/install.html @@ -408,7 +408,7 @@ effect on installation, since that's most of what npm does.</p> <h2 id="SEE-ALSO">SEE ALSO</h2> -<ul><li><a href="config.html">npm config</a></li><li><a href="build.html">npm build</a></li><li><a href="registry.html">npm registry</a></li><li><a href="build.html">npm build</a></li><li><a href="link.html">npm link</a></li><li><a href="folders.html">npm folders</a></li><li><a href="tag.html">npm tag</a></li></ul> +<ul><li><a href="update.html">npm update</a></li><li><a href="link.html">npm link</a></li><li><a href="rebuild.html">npm rebuild</a></li><li><a href="scripts.html">npm scripts</a></li><li><a href="build.html">npm build</a></li><li><a href="config.html">npm config</a></li><li><a href="registry.html">npm registry</a></li><li><a href="folders.html">npm folders</a></li><li><a href="tag.html">npm tag</a></li><li><a href="rm.html">npm rm</a></li></ul> </div> <script> ;(function () { diff --git a/html/doc/json.html b/html/doc/json.html index 8ca85e5d6..be6af576b 100644 --- a/html/doc/json.html +++ b/html/doc/json.html @@ -690,26 +690,20 @@ the external test or documentation framework that you use.</p> <p>These things will be installed whenever the <code>--dev</code> configuration flag is set. This flag is set automatically when doing <code>npm link</code>, and can -be managed like any other <a href=" configuration param. See <code>npm-config.html">npm configuration param. See <code>npm-config</a></code> +be managed like any other npm configuration param. See <code><a href="config.html">npm config</a></code> for more on the topic.</p> <h2 id="bundledDependencies">bundledDependencies</h2> <p>Array of package names that will be bundled when publishing the package.</p> -<h2 id="engines">engines</h2> +<p>If this is spelled <code>"bundleDependencies"</code>, then that is also honorable.</p> -<p>Packages/1.0 says that you can have an "engines" field with an array of engine -names. However, it has no provision for specifying which version of the engine -your stuff runs on.</p> +<h2 id="engines">engines</h2> -<p>With npm, you can use either of the following styles to specify the version of +<p>You can specify the version of node that your stuff works on:</p> -<pre><code>{ "engines" : [ "node >=0.1.27 <0.1.30" ] }</code></pre> - -<p>or:</p> - <pre><code>{ "engines" : { "node" : ">=0.1.27 <0.1.30" } }</code></pre> <p>And, like with dependencies, if you don't specify the version (or if you @@ -719,6 +713,11 @@ specify "*" as the version), then any version of node will do.</p> somewhere on that list. If "engines" is omitted, then npm will just assume that it works on node.</p> +<p>You can also use the "engines" field to specify which versions of npm +are capable of properly installing your program. For example:</p> + +<pre><code>{ "engines" : { "npm" : "~1.0.20" } }</code></pre> + <h2 id="preferGlobal">preferGlobal</h2> <p>If your package is primarily a command-line application that should be @@ -751,6 +750,10 @@ the global public registry by default.</p> <p>See <code><a href="config.html">npm config</a></code> to see the list of config options that can be overridden.</p> + +<h2 id="SEE-ALSO">SEE ALSO</h2> + +<ul><li><a href="semver.html">npm semver</a></li><li><a href="init.html">npm init</a></li><li><a href="version.html">npm version</a></li><li><a href="config.html">npm config</a></li><li><a href="help.html">npm help</a></li><li><a href="faq.html">npm faq</a></li><li><a href="install.html">npm install</a></li><li><a href="publish.html">npm publish</a></li><li><a href="rm.html">npm rm</a></li></ul> </div> <script> ;(function () { diff --git a/html/doc/link.html b/html/doc/link.html index bd8cffaa8..cc148b390 100644 --- a/html/doc/link.html +++ b/html/doc/link.html @@ -384,6 +384,10 @@ npm link redis</code></pre> <p>That is, it first creates a global link, and then links the global installation target into your project's <code>node_modules</code> folder.</p> + +<h2 id="SEE-ALSO">SEE ALSO</h2> + +<ul><li><a href="developers.html">npm developers</a></li><li><a href="faq.html">npm faq</a></li><li><a href="json.html">npm json</a></li><li><a href="install.html">npm install</a></li><li><a href="folders.html">npm folders</a></li><li><a href="config.html">npm config</a></li></ul> </div> <script> ;(function () { diff --git a/html/doc/list.html b/html/doc/list.html index 5336375b0..87555f899 100644 --- a/html/doc/list.html +++ b/html/doc/list.html @@ -378,6 +378,10 @@ like with any other command, such as <code>-g</code> to list global packages.</p <p>List packages in the global install prefix instead of in the current project.</p> + +<h2 id="SEE-ALSO">SEE ALSO</h2> + +<ul><li><a href="config.html">npm config</a></li><li><a href="folders.html">npm folders</a></li><li><a href="install.html">npm install</a></li><li><a href="link.html">npm link</a></li><li><a href="prune.html">npm prune</a></li><li><a href="outdated.html">npm outdated</a></li><li><a href="update.html">npm update</a></li></ul> </div> <script> ;(function () { diff --git a/html/doc/ln.html b/html/doc/ln.html index ed852fc95..abf82dc5b 100644 --- a/html/doc/ln.html +++ b/html/doc/ln.html @@ -384,6 +384,10 @@ npm link redis</code></pre> <p>That is, it first creates a global link, and then links the global installation target into your project's <code>node_modules</code> folder.</p> + +<h2 id="SEE-ALSO">SEE ALSO</h2> + +<ul><li><a href="developers.html">npm developers</a></li><li><a href="faq.html">npm faq</a></li><li><a href="json.html">npm json</a></li><li><a href="install.html">npm install</a></li><li><a href="folders.html">npm folders</a></li><li><a href="config.html">npm config</a></li></ul> </div> <script> ;(function () { diff --git a/html/doc/ls.html b/html/doc/ls.html index ff5cb976c..76608311b 100644 --- a/html/doc/ls.html +++ b/html/doc/ls.html @@ -378,6 +378,10 @@ like with any other command, such as <code>-g</code> to list global packages.</p <p>List packages in the global install prefix instead of in the current project.</p> + +<h2 id="SEE-ALSO">SEE ALSO</h2> + +<ul><li><a href="config.html">npm config</a></li><li><a href="folders.html">npm folders</a></li><li><a href="install.html">npm install</a></li><li><a href="link.html">npm link</a></li><li><a href="prune.html">npm prune</a></li><li><a href="outdated.html">npm outdated</a></li><li><a href="update.html">npm update</a></li></ul> </div> <script> ;(function () { diff --git a/html/doc/npm.html b/html/doc/npm.html index c7bd442da..1fa097c5e 100644 --- a/html/doc/npm.html +++ b/html/doc/npm.html @@ -337,12 +337,16 @@ input.submit, input#submit, input.button, button, input[type=submit] { <body> <div id="wrapper"> -<h1><a href=".html">npm </a></h1> <p>node package manager</p> +<h1><a href="npm.html">npm</a></h1> <p>node package manager</p> <h2 id="SYNOPSIS">SYNOPSIS</h2> <pre><code>npm <command> [args]</code></pre> +<h2 id="VERSION">VERSION</h2> + +<p>1.0.27</p> + <h2 id="DESCRIPTION">DESCRIPTION</h2> <p>npm is the package manager for the Node JavaScript platform. It puts @@ -457,6 +461,10 @@ will no doubt tell you to put the output in a gist or email.</p> <a href="https://github.com/isaacs/">isaacs</a> :: <a href="http://twitter.com/izs">@izs</a> :: <a href="mailto:i@izs.me">i@izs.me</a></p> + +<h2 id="SEE-ALSO">SEE ALSO</h2> + +<ul><li><a href="help.html">npm help</a></li><li><a href="faq.html">npm faq</a></li><li><a href="README.html">README</a></li><li><a href="json.html">npm json</a></li><li><a href="install.html">npm install</a></li><li><a href="config.html">npm config</a></li></ul> </div> <script> ;(function () { diff --git a/html/doc/outdated.html b/html/doc/outdated.html index de737c2f6..f13c59e3f 100644 --- a/html/doc/outdated.html +++ b/html/doc/outdated.html @@ -347,6 +347,10 @@ input.submit, input#submit, input.button, button, input[type=submit] { <p>This command will check the registry to see if any (or, specific) installed packages are currently outdated.</p> + +<h2 id="SEE-ALSO">SEE ALSO</h2> + +<ul><li><a href="update.html">npm update</a></li><li><a href="registry.html">npm registry</a></li><li><a href="folders.html">npm folders</a></li></ul> </div> <script> ;(function () { diff --git a/html/doc/pack.html b/html/doc/pack.html index 05ba90fbd..1107b84ee 100644 --- a/html/doc/pack.html +++ b/html/doc/pack.html @@ -355,6 +355,10 @@ stdout.</p> overwritten the second time.</p> <p>If no arguments are supplied, then npm packs the current package folder.</p> + +<h2 id="SEE-ALSO">SEE ALSO</h2> + +<ul><li><a href="cache.html">npm cache</a></li><li><a href="publish.html">npm publish</a></li><li><a href="config.html">npm config</a></li></ul> </div> <script> ;(function () { diff --git a/html/doc/prefix.html b/html/doc/prefix.html index 7db1b6483..435014fd0 100644 --- a/html/doc/prefix.html +++ b/html/doc/prefix.html @@ -346,6 +346,10 @@ input.submit, input#submit, input.button, button, input[type=submit] { <h2 id="DESCRIPTION">DESCRIPTION</h2> <p>Print the prefix to standard out.</p> + +<h2 id="SEE-ALSO">SEE ALSO</h2> + +<ul><li><a href="root.html">npm root</a></li><li><a href="bin.html">npm bin</a></li><li><a href="folders.html">npm folders</a></li><li><a href="config.html">npm config</a></li></ul> </div> <script> ;(function () { diff --git a/html/doc/prune.html b/html/doc/prune.html index 005fdd598..0548aa013 100644 --- a/html/doc/prune.html +++ b/html/doc/prune.html @@ -351,6 +351,10 @@ removed.</p> <p>Extraneous packages are packages that are not listed on the parent package's dependencies list.</p> + +<h2 id="SEE-ALSO">SEE ALSO</h2> + +<ul><li><a href="rm.html">npm rm</a></li><li><a href="folders.html">npm folders</a></li><li><a href="list.html">npm list</a></li></ul> </div> <script> ;(function () { diff --git a/html/doc/publish.html b/html/doc/publish.html index 80b2d989c..3bff17f35 100644 --- a/html/doc/publish.html +++ b/html/doc/publish.html @@ -358,7 +358,7 @@ the registry. Overwrites when the "--force" flag is set.</p> <h2 id="SEE-ALSO">SEE ALSO</h2> -<ul><li><a href="registry.html">npm registry</a></li><li><a href="adduser.html">npm adduser</a></li><li><a href="owner.html">npm owner</a></li></ul> +<ul><li><a href="registry.html">npm registry</a></li><li><a href="adduser.html">npm adduser</a></li><li><a href="owner.html">npm owner</a></li><li><a href="deprecate.html">npm deprecate</a></li><li><a href="tag.html">npm tag</a></li></ul> </div> <script> ;(function () { diff --git a/html/doc/rebuild.html b/html/doc/rebuild.html index 6842a3c2f..79bfda762 100644 --- a/html/doc/rebuild.html +++ b/html/doc/rebuild.html @@ -352,9 +352,9 @@ The package to rebuild</li></ul> when you install a new version of node, and must recompile all your C++ addons with the new binary.</p> -<h2 id="CONFIGURATION">CONFIGURATION</h2> +<h2 id="SEE-ALSO">SEE ALSO</h2> -<p>See <code><a href="build.html">npm build</a></code></p> +<ul><li><a href="build.html">npm build</a></li><li><a href="install.html">npm install</a></li></ul> </div> <script> ;(function () { diff --git a/html/doc/registry.html b/html/doc/registry.html index 7d03b5cf1..45ed01585 100644 --- a/html/doc/registry.html +++ b/html/doc/registry.html @@ -423,6 +423,10 @@ ask for help on the <a href="mailto:npm-@googlegroups.com">npm-@googlegroups.com <p>No, but such a thing is planned, and a tiny bit developed.</p> <p>Stay tuned!</p> + +<h2 id="SEE-ALSO">SEE ALSO</h2> + +<ul><li><a href="config.html">npm config</a></li><li><a href="developers.html">npm developers</a></li></ul> </div> <script> ;(function () { diff --git a/html/doc/removing-npm.html b/html/doc/removing-npm.html index e4c9166e4..aebd17188 100644 --- a/html/doc/removing-npm.html +++ b/html/doc/removing-npm.html @@ -384,6 +384,10 @@ modules. To track those down, you can do the following:</p> <pre><code>find /usr/local/{lib/node,bin} -exec grep -l npm \{\} \; ;</code></pre> <p>(This is also in the <a href="README.html">README</a> file.)</p> + +<h2 id="SEE-ALSO">SEE ALSO</h2> + +<ul><li><a href="README.html">README</a></li><li><a href="rm.html">npm rm</a></li><li><a href="prune.html">npm prune</a></li></ul> </div> <script> ;(function () { diff --git a/html/doc/restart.html b/html/doc/restart.html index fd960b1da..43665fd91 100644 --- a/html/doc/restart.html +++ b/html/doc/restart.html @@ -353,7 +353,7 @@ the "start" script.</p> <h2 id="SEE-ALSO">SEE ALSO</h2> -<ul><li><a href="start.html">npm start</a></li><li><a href="stop.html">npm stop</a></li></ul> +<ul><li><a href="run-script.html">npm run-script</a></li><li><a href="scripts.html">npm scripts</a></li><li><a href="test.html">npm test</a></li><li><a href="start.html">npm start</a></li><li><a href="stop.html">npm stop</a></li></ul> </div> <script> ;(function () { diff --git a/html/doc/rm.html b/html/doc/rm.html index ae6b69134..f5b1ed095 100644 --- a/html/doc/rm.html +++ b/html/doc/rm.html @@ -337,16 +337,21 @@ input.submit, input#submit, input.button, button, input[type=submit] { <body> <div id="wrapper"> -<h1><a href="uninstall.html">npm uninstall</a></h1> <p>Remove a package</p> +<h1><a href="rm.html">npm rm</a></h1> <p>Remove a package</p> <h2 id="SYNOPSIS">SYNOPSIS</h2> -<pre><code>npm uninstall <name> -npm rm <name></code></pre> +<pre><code>npm rm <name> +npm uninstall <name></code></pre> <h2 id="DESCRIPTION">DESCRIPTION</h2> -<p>This uninstalls a package, completely removing everything installed for it.</p> +<p>This uninstalls a package, completely removing everything npm installed +on its behalf.</p> + +<h2 id="SEE-ALSO">SEE ALSO</h2> + +<ul><li><a href="prune.html">npm prune</a></li><li><a href="install.html">npm install</a></li><li><a href="folders.html">npm folders</a></li><li><a href="config.html">npm config</a></li></ul> </div> <script> ;(function () { diff --git a/html/doc/root.html b/html/doc/root.html index 991284275..e03b646be 100644 --- a/html/doc/root.html +++ b/html/doc/root.html @@ -346,6 +346,10 @@ input.submit, input#submit, input.button, button, input[type=submit] { <h2 id="DESCRIPTION">DESCRIPTION</h2> <p>Print the effective <code>node_modules</code> folder to standard out.</p> + +<h2 id="SEE-ALSO">SEE ALSO</h2> + +<ul><li><a href="prefix.html">npm prefix</a></li><li><a href="bin.html">npm bin</a></li><li><a href="folders.html">npm folders</a></li><li><a href="config.html">npm config</a></li></ul> </div> <script> ;(function () { diff --git a/html/doc/scripts.html b/html/doc/scripts.html index c019c196b..fec4b7695 100644 --- a/html/doc/scripts.html +++ b/html/doc/scripts.html @@ -491,6 +491,10 @@ try to install executables into <code>/usr/local/bin</code>. The user probably set it up that way for a reason.</li><li>Don't prefix your script commands with "sudo". If root permissions are required for some reason, then it'll fail with that error, and the user will sudo the npm command in question.</li></ul> + +<h2 id="SEE-ALSO">SEE ALSO</h2> + +<ul><li><a href="run-script.html">npm run-script</a></li><li><a href="json.html">npm json</a></li><li><a href="developers.html">npm developers</a></li><li><a href="install.html">npm install</a></li></ul> </div> <script> ;(function () { diff --git a/html/doc/search.html b/html/doc/search.html index 956c27f77..a4970b744 100644 --- a/html/doc/search.html +++ b/html/doc/search.html @@ -346,6 +346,30 @@ input.submit, input#submit, input.button, button, input[type=submit] { <h2 id="DESCRIPTION">DESCRIPTION</h2> <p>Search the registry for packages matching the search terms.</p> + +<h2 id="CONFIGURATION">CONFIGURATION</h2> + +<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="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> + +<h2 id="SEE-ALSO">SEE ALSO</h2> + +<ul><li><a href="registry.html">npm registry</a></li><li><a href="config.html">npm config</a></li><li><a href="view.html">npm view</a></li></ul> </div> <script> ;(function () { diff --git a/html/doc/semver.html b/html/doc/semver.html index da32a07c9..362f9ef4f 100644 --- a/html/doc/semver.html +++ b/html/doc/semver.html @@ -426,6 +426,10 @@ in descending order when passed to Array.sort().</li></ul> <ul><li>validRange(range): Return the valid range or null if it's not valid</li><li>satisfies(version, range): Return true if the version satisfies the range.</li><li>maxSatisfying(versions, range): Return the highest version in the list that satisfies the range, or null if none of them do.</li></ul> + +<h2 id="SEE-ALSO">SEE ALSO</h2> + +<ul><li><a href="json.html">npm json</a></li></ul> </div> <script> ;(function () { diff --git a/html/doc/set.html b/html/doc/set.html index 9a9cd5c72..d6ebe4b64 100644 --- a/html/doc/set.html +++ b/html/doc/set.html @@ -491,7 +491,7 @@ have their <code>build</code> directories automatically ignored.</p> <ul><li>Default: Windows: <code>~/npm-cache</code>, Posix: <code>~/.npm</code></li><li>Type: path</li></ul> -<p>The location of <a href="'s cache directory. See <code>npm-cache.html">npm 's cache directory. See <code>npm-cache</a></code></p> +<p>The location of npm's cache directory. See <code><a href="cache.html">npm cache</a></code></p> <h3 id="color">color</h3> @@ -524,7 +524,8 @@ set.</p> <h3 id="editor">editor</h3> -<ul><li>Default: <code>EDITOR</code> environment variable if set, or <code>"vi"</code></li><li>Type: path</li></ul> +<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> @@ -755,7 +756,8 @@ local <code>npm install</code> without any arguments.</li><li>Set the NODE_ENV=" <h3 id="shell">shell</h3> -<ul><li>Default: SHELL environment variable, or "bash"</li><li>Type: path</li></ul> +<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> @@ -856,6 +858,10 @@ 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="folders.html">npm folders</a></li><li><a href="npm.html">npm</a></li></ul> </div> <script> ;(function () { diff --git a/html/doc/start.html b/html/doc/start.html index 315a08c74..98dc12620 100644 --- a/html/doc/start.html +++ b/html/doc/start.html @@ -346,6 +346,10 @@ input.submit, input#submit, input.button, button, input[type=submit] { <h2 id="DESCRIPTION">DESCRIPTION</h2> <p>This runs a package's "start" script, if one was provided.</p> + +<h2 id="SEE-ALSO">SEE ALSO</h2> + +<ul><li><a href="run-script.html">npm run-script</a></li><li><a href="scripts.html">npm scripts</a></li><li><a href="test.html">npm test</a></li><li><a href="restart.html">npm restart</a></li><li><a href="stop.html">npm stop</a></li></ul> </div> <script> ;(function () { diff --git a/html/doc/stop.html b/html/doc/stop.html index 06e05d73e..61eaa06d7 100644 --- a/html/doc/stop.html +++ b/html/doc/stop.html @@ -346,6 +346,10 @@ input.submit, input#submit, input.button, button, input[type=submit] { <h2 id="DESCRIPTION">DESCRIPTION</h2> <p>This runs a package's "stop" script, if one was provided.</p> + +<h2 id="SEE-ALSO">SEE ALSO</h2> + +<ul><li><a href="run-script.html">npm run-script</a></li><li><a href="scripts.html">npm scripts</a></li><li><a href="test.html">npm test</a></li><li><a href="start.html">npm start</a></li><li><a href="restart.html">npm restart</a></li></ul> </div> <script> ;(function () { diff --git a/html/doc/tag.html b/html/doc/tag.html index 78f651c49..52c083845 100644 --- a/html/doc/tag.html +++ b/html/doc/tag.html @@ -347,6 +347,10 @@ input.submit, input#submit, input.button, button, input[type=submit] { <p>Tags the specified version of the package with the specified tag, or the <code>--tag</code> config if not specified.</p> + +<h2 id="SEE-ALSO">SEE ALSO</h2> + +<ul><li><a href="publish.html">npm publish</a></li><li><a href="registry.html">npm registry</a></li><li><a href="config.html">npm config</a></li></ul> </div> <script> ;(function () { diff --git a/html/doc/test.html b/html/doc/test.html index 7f6aa1dd2..44d1678bc 100644 --- a/html/doc/test.html +++ b/html/doc/test.html @@ -349,6 +349,10 @@ input.submit, input#submit, input.button, button, input[type=submit] { <p>To run tests as a condition of installation, set the <code>npat</code> config to true.</p> + +<h2 id="SEE-ALSO">SEE ALSO</h2> + +<ul><li><a href="run-script.html">npm run-script</a></li><li><a href="scripts.html">npm scripts</a></li><li><a href="start.html">npm start</a></li><li><a href="restart.html">npm restart</a></li><li><a href="stop.html">npm stop</a></li></ul> </div> <script> ;(function () { diff --git a/html/doc/uninstall.html b/html/doc/uninstall.html index b3aff7aa7..408a8a9b1 100644 --- a/html/doc/uninstall.html +++ b/html/doc/uninstall.html @@ -337,16 +337,21 @@ input.submit, input#submit, input.button, button, input[type=submit] { <body> <div id="wrapper"> -<h1><a href="uninstall.html">npm uninstall</a></h1> <p>Remove a package</p> +<h1><a href="rm.html">npm rm</a></h1> <p>Remove a package</p> <h2 id="SYNOPSIS">SYNOPSIS</h2> -<pre><code>npm uninstall <name> -npm rm <name></code></pre> +<pre><code>npm rm <name> +npm uninstall <name></code></pre> <h2 id="DESCRIPTION">DESCRIPTION</h2> -<p>This uninstalls a package, completely removing everything installed for it.</p> +<p>This uninstalls a package, completely removing everything npm installed +on its behalf.</p> + +<h2 id="SEE-ALSO">SEE ALSO</h2> + +<ul><li><a href="prune.html">npm prune</a></li><li><a href="install.html">npm install</a></li><li><a href="folders.html">npm folders</a></li><li><a href="config.html">npm config</a></li></ul> </div> <script> ;(function () { diff --git a/html/doc/unpublish.html b/html/doc/unpublish.html index 64a6703d3..1adf7ef9c 100644 --- a/html/doc/unpublish.html +++ b/html/doc/unpublish.html @@ -350,6 +350,16 @@ entry and removing the tarball.</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> + +<h2 id="NOTE">NOTE</h2> + +<p>It is generally considered bad behavior to remove versions of a library +that others are depending on! Consider using the <code>deprecate</code> command +instead, if your intent is to encourage users to upgrade.</p> + +<h2 id="SEE-ALSO">SEE ALSO</h2> + +<ul><li><a href="deprecate.html">npm deprecate</a></li><li><a href="publish.html">npm publish</a></li><li><a href="registry.html">npm registry</a></li><li><a href="adduser.html">npm adduser</a></li><li><a href="owner.html">npm owner</a></li></ul> </div> <script> ;(function () { diff --git a/html/doc/update.html b/html/doc/update.html index 9daee2edd..a46fd291e 100644 --- a/html/doc/update.html +++ b/html/doc/update.html @@ -349,6 +349,10 @@ input.submit, input#submit, input.button, button, input[type=submit] { (specified by the <code>tag</code> config).</p> <p>It will also install missing packages.</p> + +<h2 id="SEE-ALSO">SEE ALSO</h2> + +<ul><li><a href="install.html">npm install</a></li><li><a href="outdated.html">npm outdated</a></li><li><a href="registry.html">npm registry</a></li><li><a href="folders.html">npm folders</a></li><li><a href="list.html">npm list</a></li></ul> </div> <script> ;(function () { diff --git a/html/doc/version.html b/html/doc/version.html index 1c794ac27..44425a265 100644 --- a/html/doc/version.html +++ b/html/doc/version.html @@ -350,6 +350,10 @@ data back to the package.json file.</p> <p>If run in a git repo, it will also create a version commit and tag, and fail if the repo is not clean.</p> + +<h2 id="SEE-ALSO">SEE ALSO</h2> + +<ul><li><a href="init.html">npm init</a></li><li><a href="json.html">npm json</a></li><li><a href="semver.html">npm semver</a></li></ul> </div> <script> ;(function () { diff --git a/html/doc/view.html b/html/doc/view.html index 05be07ae2..232a368af 100644 --- a/html/doc/view.html +++ b/html/doc/view.html @@ -414,6 +414,10 @@ 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> + +<h2 id="SEE-ALSO">SEE ALSO</h2> + +<ul><li><a href="search.html">npm search</a></li><li><a href="registry.html">npm registry</a></li><li><a href="config.html">npm config</a></li></ul> </div> <script> ;(function () { diff --git a/html/doc/whoami.html b/html/doc/whoami.html index 0d0780fed..e61906ca5 100644 --- a/html/doc/whoami.html +++ b/html/doc/whoami.html @@ -346,6 +346,10 @@ input.submit, input#submit, input.button, button, input[type=submit] { <h2 id="DESCRIPTION">DESCRIPTION</h2> <p>Print the <code>username</code> config to standard output.</p> + +<h2 id="SEE-ALSO">SEE ALSO</h2> + +<ul><li><a href="config.html">npm config</a></li><li><a href="adduser.html">npm adduser</a></li></ul> </div> <script> ;(function () { |