Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Add SEE ALSO to all doc sections, and rebuild

  • Loading branch information...
commit b19d70344d6b37872f96761376b918a5036b1dbb 1 parent 32f2673
@isaacs isaacs authored
Showing with 1,737 additions and 99 deletions.
  1. +5 −0 doc/adduser.md
  2. +7 −0 doc/bin.md
  3. +4 −0 doc/bundle.md
  4. +8 −0 doc/cache.md
  5. +6 −1 doc/changelog.md
  6. +6 −0 doc/coding-style.md
  7. +6 −0 doc/completion.md
  8. +9 −2 doc/config.md
  9. +5 −0 doc/deprecate.md
  10. +12 −1 doc/developers.md
  11. +23 −0 doc/docs.md
  12. +17 −0 doc/edit.md
  13. +24 −0 doc/explore.md
  14. +8 −0 doc/faq.md
  15. +10 −0 doc/folders.md
  16. +5 −0 doc/help-search.md
  17. +2 −1  doc/init.md
  18. +6 −3 doc/install.md
  19. +20 −9 doc/json.md
  20. +9 −0 doc/link.md
  21. +10 −0 doc/list.md
  22. +13 −0 doc/npm.md
  23. +6 −0 doc/outdated.md
  24. +6 −0 doc/pack.md
  25. +7 −0 doc/prefix.md
  26. +6 −0 doc/prune.md
  27. +2 −0  doc/publish.md
  28. +3 −2 doc/rebuild.md
  29. +5 −0 doc/registry.md
  30. +6 −0 doc/removing-npm.md
  31. +3 −0  doc/restart.md
  32. +7 −0 doc/root.md
  33. +7 −0 doc/scripts.md
  34. +29 −0 doc/search.md
  35. +4 −0 doc/semver.md
  36. +8 −0 doc/start.md
  37. +8 −0 doc/stop.md
  38. +6 −0 doc/tag.md
  39. +8 −0 doc/test.md
  40. +12 −4 doc/uninstall.md
  41. +14 −0 doc/unpublish.md
  42. +8 −0 doc/update.md
  43. +6 −0 doc/version.md
  44. +6 −0 doc/view.md
  45. +5 −0 doc/whoami.md
  46. +4 −0 html/doc/adduser.html
  47. +4 −0 html/doc/bin.html
  48. +4 −0 html/doc/bundle.html
  49. +4 −0 html/doc/cache.html
  50. +4 −0 html/doc/changelog.html
  51. +4 −0 html/doc/coding-style.html
  52. +4 −0 html/doc/completion.html
  53. +9 −3 html/doc/config.html
  54. +4 −0 html/doc/deprecate.html
  55. +5 −1 html/doc/developers.html
  56. +18 −0 html/doc/docs.html
  57. +14 −1 html/doc/edit.html
  58. +18 −0 html/doc/explore.html
  59. +4 −0 html/doc/faq.html
  60. +4 −0 html/doc/folders.html
  61. +9 −3 html/doc/get.html
  62. +4 −0 html/doc/global.html
  63. +4 −0 html/doc/help-search.html
  64. +18 −0 html/doc/home.html
  65. +2 −2 html/doc/init.html
  66. +1 −1  html/doc/install.html
  67. +13 −10 html/doc/json.html
  68. +4 −0 html/doc/link.html
  69. +4 −0 html/doc/list.html
  70. +4 −0 html/doc/ln.html
  71. +4 −0 html/doc/ls.html
  72. +9 −1 html/doc/npm.html
  73. +4 −0 html/doc/outdated.html
  74. +4 −0 html/doc/pack.html
  75. +4 −0 html/doc/prefix.html
  76. +4 −0 html/doc/prune.html
  77. +1 −1  html/doc/publish.html
  78. +2 −2 html/doc/rebuild.html
  79. +4 −0 html/doc/registry.html
  80. +4 −0 html/doc/removing-npm.html
  81. +1 −1  html/doc/restart.html
  82. +9 −4 html/doc/rm.html
  83. +4 −0 html/doc/root.html
  84. +4 −0 html/doc/scripts.html
  85. +24 −0 html/doc/search.html
  86. +4 −0 html/doc/semver.html
  87. +9 −3 html/doc/set.html
  88. +4 −0 html/doc/start.html
  89. +4 −0 html/doc/stop.html
  90. +4 −0 html/doc/tag.html
  91. +4 −0 html/doc/test.html
  92. +9 −4 html/doc/uninstall.html
  93. +10 −0 html/doc/unpublish.html
  94. +4 −0 html/doc/update.html
  95. +4 −0 html/doc/version.html
  96. +4 −0 html/doc/view.html
  97. +4 −0 html/doc/whoami.html
  98. +11 −0 man1/adduser.1
  99. +17 −0 man1/bin.1
  100. +8 −0 man1/bundle.1
  101. +20 −0 man1/cache.1
  102. +10 −0 man1/changelog.1
  103. +14 −0 man1/coding-style.1
  104. +14 −0 man1/completion.1
  105. +15 −2 man1/config.1
  106. +11 −0 man1/deprecate.1
  107. +30 −1 man1/developers.1
  108. +45 −0 man1/docs.1
  109. +33 −0 man1/edit.1
  110. +51 −0 man1/explore.1
  111. +20 −0 man1/faq.1
  112. +26 −0 man1/folders.1
  113. +15 −2 man1/get.1
  114. +26 −0 man1/global.1
  115. +11 −0 man1/help-search.1
  116. +45 −0 man1/home.1
  117. +8 −0 man1/init.1
  118. +13 −4 man1/install.1
  119. +49 −18 man1/json.1
  120. +23 −0 man1/link.1
  121. +26 −0 man1/list.1
  122. +23 −0 man1/ln.1
  123. +26 −0 man1/ls.1
  124. +26 −0 man1/npm.1
  125. +14 −0 man1/outdated.1
  126. +14 −0 man1/pack.1
  127. +17 −0 man1/prefix.1
  128. +14 −0 man1/prune.1
  129. +6 −0 man1/publish.1
  130. +10 −2 man1/rebuild.1
  131. +11 −0 man1/registry.1
  132. +14 −0 man1/removing-npm.1
  133. +9 −0 man1/restart.1
  134. +22 −4 man1/rm.1
  135. +17 −0 man1/root.1
  136. +16 −0 man1/scripts.1
  137. +55 −0 man1/search.1
  138. +7 −0 man1/semver.1
  139. +15 −2 man1/set.1
  140. +20 −0 man1/start.1
  141. +20 −0 man1/stop.1
  142. +14 −0 man1/tag.1
  143. +20 −0 man1/test.1
  144. +22 −4 man1/uninstall.1
  145. +25 −0 man1/unpublish.1
  146. +20 −0 man1/update.1
  147. +14 −0 man1/version.1
  148. +14 −0 man1/view.1
  149. +11 −0 man1/whoami.1
View
5 doc/adduser.md
@@ -27,3 +27,8 @@ authorize on a new machine.
Default: http://registry.npmjs.org/
The base URL of the npm package registry.
+
+## SEE ALSO
+
+* npm-registry(1)
+* npm-config(1)
View
7 doc/bin.md
@@ -8,3 +8,10 @@ npm-bin(1) -- Display npm bin folder
## DESCRIPTION
Print the folder where npm will install executables.
+
+## SEE ALSO
+
+* npm-prefix(1)
+* npm-root(1)
+* npm-folders(1)
+* npm-config(1)
View
4 doc/bundle.md
@@ -8,3 +8,7 @@ that it is no longer necessary, as the default behavior is now to
install packages into the local space.
Just use `npm install` now to do what `npm bundle` used to do.
+
+## SEE ALSO
+
+* npm-install(1)
View
8 doc/cache.md
@@ -58,3 +58,11 @@ they do not make an HTTP request to the registry.
Default: `$HOME/.npm` on Posix, or `$HOME/npm-cache` on Windows.
The root cache folder.
+
+## SEE ALSO
+
+* npm-folders(1)
+* npm-config(1)
+* npm-install(1)
+* npm-publish(1)
+* npm-pack(1)
View
7 doc/changelog.md
@@ -28,4 +28,9 @@ npm-changelog(1) -- Changes
### 0.0
* Lots of sketches and false starts; abandoned a few times
-* Core functionality established
+* Core functionality established
+
+## SEE ALSO
+
+* npm(1)
+* npm-faq(1)
View
6 doc/coding-style.md
@@ -182,3 +182,9 @@ Don't set things to `undefined`. Reserve that value to mean "not yet
set to anything."
Boolean objects are verboten.
+
+## SEE ALSO
+
+* npm-developers(1)
+* npm-faq(1)
+* npm(1)
View
6 doc/completion.md
@@ -19,3 +19,9 @@ that will read that file for you.
When `COMP_CWORD`, `COMP_LINE`, and `COMP_POINT` are defined in the
environment, `npm completion` acts in "plumbing mode", and outputs
completions based on the arguments.
+
+## SEE ALSO
+
+* npm-developers(1)
+* npm-faq(1)
+* npm(1)
View
11 doc/config.md
@@ -216,7 +216,8 @@ set.
### editor
-* Default: `EDITOR` environment variable if set, or `"vi"`
+* Default: `EDITOR` environment variable if set, or `"vi"` on Posix,
+ or `"notepad"` on Windows.
* Type: path
The command to run for `npm edit` or `npm config edit`.
@@ -488,7 +489,8 @@ Space-separated options that limit the results from search.
### shell
-* Default: SHELL environment variable, or "bash"
+* Default: SHELL environment variable, or "bash" on Posix, or "cmd" on
+ Windows
* Type: path
The shell to run for the `npm explore` command.
@@ -603,3 +605,8 @@ circumstances.
If set to `true`, then answer "yes" to any prompt. If set to `false`
then answer "no" to any prompt.
+
+## SEE ALSO
+
+* npm-folders(1)
+* npm(1)
View
5 doc/deprecate.md
@@ -17,3 +17,8 @@ something like this:
Note that you must be the package owner to deprecate something. See the
`owner` and `adduser` help topics.
+
+## SEE ALSO
+
+* npm-publish(1)
+* npm-registry(1)
View
13 doc/developers.md
@@ -38,7 +38,7 @@ after packing it up into a tarball (b).
You need to have a `package.json` file in the root of your project to do
much of anything with npm. That is basically the whole interface.
-See npm-json(1) for details about what goes in that file. At the very
+See `npm-json(1)` for details about what goes in that file. At the very
least, you need:
* name:
@@ -159,3 +159,14 @@ from a fresh checkout.
Send emails, write blogs, blab in IRC.
Tell the world how easy it is to install your program!
+
+## SEE ALSO
+
+* npm-faq(1)
+* npm(1)
+* npm-init(1)
+* npm-json(1)
+* npm-scripts(1)
+* npm-publish(1)
+* npm-adduser(1)
+* npm-registry(1)
View
23 doc/docs.md
@@ -12,3 +12,26 @@ This command tries to guess at the likely location of a package's
documentation URL, and then tries to open it using the `--browser`
config param.
+## CONFIGURATION
+
+### browser
+
+* Default: OS X: `"open"`, others: `"google-chrome"`
+* Type: String
+
+The browser that is called by the `npm docs` command to open websites.
+
+### registry
+
+* Default: https://registry.npmjs.org/
+* Type: url
+
+The base URL of the npm package registry.
+
+
+## SEE ALSO
+
+* npm-publish(1)
+* npm-registry(1)
+* npm-config(1)
+* npm-json(1)
View
17 doc/edit.md
@@ -16,3 +16,20 @@ changes in compiled packages.
For instance, you can do `npm install connect` to install connect
into your package, and then `npm edit connect` to make a few
changes to your locally installed copy.
+
+## CONFIGURATION
+
+### editor
+
+* Default: `EDITOR` environment variable if set, or `"vi"` on Posix,
+ or `"notepad"` on Windows.
+* Type: path
+
+The command to run for `npm edit` or `npm config edit`.
+
+## SEE ALSO
+
+* npm-folders(1)
+* npm-explore(1)
+* npm-install(1)
+* npm-config(1)
View
24 doc/explore.md
@@ -12,5 +12,29 @@ Spawn a subshell in the directory of the installed package specified.
If a command is specified, then it is run in the subshell, which then
immediately terminates.
+This is particularly handy in the case of git submodules in the
+`node_modules` folder:
+
+ npm explore some-dependency -- git pull origin master
+
Note that the package is *not* automatically rebuilt afterwards, so be
sure to use `npm rebuild <pkg>` if you make any changes.
+
+## CONFIGURATION
+
+### shell
+
+* Default: SHELL environment variable, or "bash" on Posix, or "cmd" on
+ Windows
+* Type: path
+
+The shell to run for the `npm explore` command.
+
+## SEE ALSO
+
+* npm-submodule(1)
+* npm-folders(1)
+* npm-edit(1)
+* npm-rebuild(1)
+* npm-build(1)
+* npm-install(1)
View
8 doc/faq.md
@@ -202,3 +202,11 @@ Discuss it on the mailing list, or post an issue.
## Why does npm hate me?
npm is not capable of hatred. It loves everyone, especially you.
+
+## SEE ALSO
+
+* npm(1)
+* npm-developers(1)
+* npm-json(1)
+* npm-config(1)
+* npm-folders(1)
View
10 doc/folders.md
@@ -183,3 +183,13 @@ not be included in the package tarball.
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 `npm-json(1)` for more information.
+
+## SEE ALSO
+
+* npm-faq(1)
+* npm-json(1)
+* npm-install(1)
+* npm-pack(1)
+* npm-cache(1)
+* npm-config(1)
+* npm-publish(1)
View
5 doc/help-search.md
@@ -27,3 +27,8 @@ If true, the "long" flag will cause help-search to output context around
where the terms were found in the documentation.
If false, then help-search will just list out the help topics found.
+
+## SEE ALSO
+
+* npm(1)
+* npm-faq(1)
View
3  doc/init.md
@@ -20,4 +20,5 @@ without a really good reason to do so.
## SEE ALSO
-npm-json(1)
+* npm-json(1)
+* npm-version(1)
View
9 doc/install.md
@@ -120,10 +120,13 @@ effect on installation, since that's most of what npm does.
## SEE ALSO
-* npm-config(1)
+* npm-update(1)
+* npm-link(1)
+* npm-rebuild(1)
+* npm-scripts(1)
* npm-build(1)
+* npm-config(1)
* npm-registry(1)
-* npm-build(1)
-* npm-link(1)
* npm-folders(1)
* npm-tag(1)
+* npm-rm(1)
View
29 doc/json.md
@@ -392,19 +392,13 @@ for more on the topic.
Array of package names that will be bundled when publishing the package.
-## engines
+If this is spelled `"bundleDependencies"`, then that is also honorable.
-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.
+## engines
-With npm, you can use either of the following styles to specify the version of
+You can specify the version of
node that your stuff works on:
- { "engines" : [ "node >=0.1.27 <0.1.30" ] }
-
-or:
-
{ "engines" : { "node" : ">=0.1.27 <0.1.30" } }
And, like with dependencies, if you don't specify the version (or if you
@@ -414,6 +408,11 @@ If you specify an "engines" field, then npm will require that "node" be
somewhere on that list. If "engines" is omitted, then npm will just assume
that it works on node.
+You can also use the "engines" field to specify which versions of npm
+are capable of properly installing your program. For example:
+
+ { "engines" : { "npm" : "~1.0.20" } }
+
## preferGlobal
If your package is primarily a command-line application that should be
@@ -446,3 +445,15 @@ Any config values can be overridden, but of course only "tag" and
See `npm-config(1)` to see the list of config options that can be
overridden.
+
+## SEE ALSO
+
+* npm-semver(1)
+* npm-init(1)
+* npm-version(1)
+* npm-config(1)
+* npm-help(1)
+* npm-faq(1)
+* npm-install(1)
+* npm-publish(1)
+* npm-rm(1)
View
9 doc/link.md
@@ -47,3 +47,12 @@ The second line is the equivalent of doing:
That is, it first creates a global link, and then links the global
installation target into your project's `node_modules` folder.
+
+## SEE ALSO
+
+* npm-developers(1)
+* npm-faq(1)
+* npm-json(1)
+* npm-install(1)
+* npm-folders(1)
+* npm-config(1)
View
10 doc/list.md
@@ -43,3 +43,13 @@ Show parseable output instead of tree view.
List packages in the global install prefix instead of in the current
project.
+
+## SEE ALSO
+
+* npm-config(1)
+* npm-folders(1)
+* npm-install(1)
+* npm-link(1)
+* npm-prune(1)
+* npm-outdated(1)
+* npm-update(1)
View
13 doc/npm.md
@@ -5,6 +5,10 @@ npm(1) -- node package manager
npm <command> [args]
+## VERSION
+
+@VERSION@
+
## DESCRIPTION
npm is the package manager for the Node JavaScript platform. It puts
@@ -138,3 +142,12 @@ See npm-changelog(1)
[isaacs](https://github.com/isaacs/) ::
[@izs](http://twitter.com/izs) ::
<i@izs.me>
+
+## SEE ALSO
+
+* npm-help(1)
+* npm-faq(1)
+* README
+* npm-json(1)
+* npm-install(1)
+* npm-config(1)
View
6 doc/outdated.md
@@ -9,3 +9,9 @@ npm-outdated(1) -- Check for outdated packages
This command will check the registry to see if any (or, specific) installed
packages are currently outdated.
+
+## SEE ALSO
+
+* npm-update(1)
+* npm-registry(1)
+* npm-folders(1)
View
6 doc/pack.md
@@ -17,3 +17,9 @@ If the same package is specified multiple times, then the file will be
overwritten the second time.
If no arguments are supplied, then npm packs the current package folder.
+
+## SEE ALSO
+
+* npm-cache(1)
+* npm-publish(1)
+* npm-config(1)
View
7 doc/prefix.md
@@ -8,3 +8,10 @@ npm-prefix(1) -- Display prefix
## DESCRIPTION
Print the prefix to standard out.
+
+## SEE ALSO
+
+* npm-root(1)
+* npm-bin(1)
+* npm-folders(1)
+* npm-config(1)
View
6 doc/prune.md
@@ -13,3 +13,9 @@ removed.
Extraneous packages are packages that are not listed on the parent
package's dependencies list.
+
+## SEE ALSO
+
+* npm-rm(1)
+* npm-folders(1)
+* npm-list(1)
View
2  doc/publish.md
@@ -26,3 +26,5 @@ the registry. Overwrites when the "--force" flag is set.
* npm-registry(1)
* npm-adduser(1)
* npm-owner(1)
+* npm-deprecate(1)
+* npm-tag(1)
View
5 doc/rebuild.md
@@ -14,6 +14,7 @@ This command runs the `npm build` command on the matched folders. This is usefu
when you install a new version of node, and must recompile all your C++ addons with
the new binary.
-## CONFIGURATION
+## SEE ALSO
-See `npm-build(1)`
+* npm-build(1)
+* npm-install(1)
View
5 doc/registry.md
@@ -85,3 +85,8 @@ ask for help on the <npm-@googlegroups.com> mailing list.
No, but such a thing is planned, and a tiny bit developed.
Stay tuned!
+
+## SEE ALSO
+
+* npm-config(1)
+* npm-developers(1)
View
6 doc/removing-npm.md
@@ -46,3 +46,9 @@ modules. To track those down, you can do the following:
find /usr/local/{lib/node,bin} -exec grep -l npm \{\} \; ;
(This is also in the README file.)
+
+## SEE ALSO
+
+* README
+* npm-rm(1)
+* npm-prune(1)
View
3  doc/restart.md
@@ -15,5 +15,8 @@ If no version is specified, then it restarts the "active" version.
## SEE ALSO
+* npm-run-script(1)
+* npm-scripts(1)
+* npm-test(1)
* npm-start(1)
* npm-stop(1)
View
7 doc/root.md
@@ -8,3 +8,10 @@ npm-root(1) -- Display npm root
## DESCRIPTION
Print the effective `node_modules` folder to standard out.
+
+## SEE ALSO
+
+* npm-prefix(1)
+* npm-bin(1)
+* npm-folders(1)
+* npm-config(1)
View
7 doc/scripts.md
@@ -174,3 +174,10 @@ they are in a separate child process, with the env described above.
* 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.
+
+## SEE ALSO
+
+* npm-run-script(1)
+* npm-json(1)
+* npm-developers(1)
+* npm-install(1)
View
29 doc/search.md
@@ -8,3 +8,32 @@ npm-search(1) -- Search for packages
## DESCRIPTION
Search the registry for packages matching the search terms.
+
+## CONFIGURATION
+
+### description
+
+* Default: true
+* Type: Boolean
+
+Show the description in `npm search`
+
+### searchopts
+
+* Default: ""
+* Type: String
+
+Space-separated options that are always passed to search.
+
+### searchexclude
+
+* Default: ""
+* Type: String
+
+Space-separated options that limit the results from search.
+
+## SEE ALSO
+
+* npm-registry(1)
+* npm-config(1)
+* npm-view(1)
View
4 doc/semver.md
@@ -120,3 +120,7 @@ Ranges can be joined with either a space (which implies "and") or a
range.
* maxSatisfying(versions, range): Return the highest version in the list
that satisfies the range, or null if none of them do.
+
+## SEE ALSO
+
+* npm-json(1)
View
8 doc/start.md
@@ -8,3 +8,11 @@ npm-start(1) -- Start a package
## DESCRIPTION
This runs a package's "start" script, if one was provided.
+
+## SEE ALSO
+
+* npm-run-script(1)
+* npm-scripts(1)
+* npm-test(1)
+* npm-restart(1)
+* npm-stop(1)
View
8 doc/stop.md
@@ -8,3 +8,11 @@ npm-stop(1) -- Stop a package
## DESCRIPTION
This runs a package's "stop" script, if one was provided.
+
+## SEE ALSO
+
+* npm-run-script(1)
+* npm-scripts(1)
+* npm-test(1)
+* npm-start(1)
+* npm-restart(1)
View
6 doc/tag.md
@@ -9,3 +9,9 @@ npm-tag(1) -- Tag a published version
Tags the specified version of the package with the specified tag, or the
`--tag` config if not specified.
+
+## SEE ALSO
+
+* npm-publish(1)
+* npm-registry(1)
+* npm-config(1)
View
8 doc/test.md
@@ -11,3 +11,11 @@ This runs a package's "test" script, if one was provided.
To run tests as a condition of installation, set the `npat` config to
true.
+
+## SEE ALSO
+
+* npm-run-script(1)
+* npm-scripts(1)
+* npm-start(1)
+* npm-restart(1)
+* npm-stop(1)
View
16 doc/uninstall.md
@@ -1,11 +1,19 @@
-npm-uninstall(1) -- Remove a package
-====================================
+npm-rm(1) -- Remove a package
+=============================
## SYNOPSIS
- npm uninstall <name>
npm rm <name>
+ npm uninstall <name>
## DESCRIPTION
-This uninstalls a package, completely removing everything installed for it.
+This uninstalls a package, completely removing everything npm installed
+on its behalf.
+
+## SEE ALSO
+
+* npm-prune(1)
+* npm-install(1)
+* npm-folders(1)
+* npm-config(1)
View
14 doc/unpublish.md
@@ -12,3 +12,17 @@ entry and removing the tarball.
If no version is specified, or if all versions are removed then
the root package entry is removed from the registry entirely.
+
+## NOTE
+
+It is generally considered bad behavior to remove versions of a library
+that others are depending on! Consider using the `deprecate` command
+instead, if your intent is to encourage users to upgrade.
+
+## SEE ALSO
+
+* npm-deprecate(1)
+* npm-publish(1)
+* npm-registry(1)
+* npm-adduser(1)
+* npm-owner(1)
View
8 doc/update.md
@@ -11,3 +11,11 @@ This command will update all the packages listed to the latest version
(specified by the `tag` config).
It will also install missing packages.
+
+## SEE ALSO
+
+* npm-install(1)
+* npm-outdated(1)
+* npm-registry(1)
+* npm-folders(1)
+* npm-list(1)
View
6 doc/version.md
@@ -12,3 +12,9 @@ data back to the package.json file.
If run in a git repo, it will also create a version commit and tag, and
fail if the repo is not clean.
+
+## SEE ALSO
+
+* npm-init(1)
+* npm-json(1)
+* npm-semver(1)
View
6 doc/view.md
@@ -76,3 +76,9 @@ will be prefixed with the version it applies to.
If multiple fields are requested, than each of them are prefixed with
the field name.
+
+## SEE ALSO
+
+* npm-search(1)
+* npm-registry(1)
+* npm-config(1)
View
5 doc/whoami.md
@@ -8,3 +8,8 @@ npm-whoami(1) -- Display npm username
## DESCRIPTION
Print the `username` config to standard output.
+
+## SEE ALSO
+
+* npm-config(1)
+* npm-adduser(1)
View
4 html/doc/adduser.html
@@ -365,6 +365,10 @@ <h3 id="registry">registry</h3>
<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 () {
View
4 html/doc/bin.html
@@ -346,6 +346,10 @@ <h2 id="SYNOPSIS">SYNOPSIS</h2>
<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 () {
View
4 html/doc/bundle.html
@@ -346,6 +346,10 @@ <h2 id="DESCRIPTION">DESCRIPTION</h2>
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 () {
View
4 html/doc/cache.html
@@ -390,6 +390,10 @@ <h3 id="cache">cache</h3>
<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 () {
View
4 html/doc/changelog.html
@@ -360,6 +360,10 @@ <h3 id="0-1">0.1</h3>
<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 () {
View
4 html/doc/coding-style.html
@@ -517,6 +517,10 @@ <h2 id="null-undefined-false-0">null, undefined, false, 0</h2>
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 () {
View
4 html/doc/completion.html
@@ -357,6 +357,10 @@ <h2 id="DESCRIPTION">DESCRIPTION</h2>
<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 () {
View
12 html/doc/config.html
@@ -491,7 +491,7 @@ <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 <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 @@ <h3 id="dev">dev</h3>
<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 @@ <h3 id="searchexclude">searchexclude</h3>
<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 @@ <h3 id="yes">yes</h3>
<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 () {
View
4 html/doc/deprecate.html
@@ -355,6 +355,10 @@ <h2 id="DESCRIPTION">DESCRIPTION</h2>
<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 () {
View
6 html/doc/developers.html
@@ -371,7 +371,7 @@ <h2 id="The-package-json-File">The package.json File</h2>
<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 @@ <h2 id="Brag-about-it">Brag about it</h2>
<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 () {
View
18 html/doc/docs.html
@@ -349,6 +349,24 @@ <h2 id="DESCRIPTION">DESCRIPTION</h2>
<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 () {
View
15 html/doc/edit.html
@@ -346,7 +346,7 @@ <h2 id="SYNOPSIS">SYNOPSIS</h2>
<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 @@ <h2 id="DESCRIPTION">DESCRIPTION</h2>
<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 () {
View
18 html/doc/explore.html
@@ -350,8 +350,26 @@ <h2 id="DESCRIPTION">DESCRIPTION</h2>
<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 &lt;pkg&gt;</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 () {
View
4 html/doc/faq.html
@@ -530,6 +530,10 @@ <h2 id="I-have-a-question-or-request-not-addressed-here-Where-should-I-put-it">I
<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 () {
View
4 html/doc/folders.html
@@ -517,6 +517,10 @@ <h3 id="Publishing">Publishing</h3>
<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 () {
View
12 html/doc/get.html
@@ -491,7 +491,7 @@ <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 <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 @@ <h3 id="dev">dev</h3>
<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 @@ <h3 id="searchexclude">searchexclude</h3>
<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 @@ <h3 id="yes">yes</h3>
<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 () {
View
4 html/doc/global.html
@@ -517,6 +517,10 @@ <h3 id="Publishing">Publishing</h3>
<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 () {
View
4 html/doc/help-search.html
@@ -364,6 +364,10 @@ <h3 id="long">long</h3>
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 () {
View
18 html/doc/home.html
@@ -349,6 +349,24 @@ <h2 id="DESCRIPTION">DESCRIPTION</h2>
<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 () {
View
4 html/doc/init.html
@@ -337,7 +337,7 @@
<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 @@ <h2 id="DESCRIPTION">DESCRIPTION</h2>
<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 () {
View
2  html/doc/install.html
@@ -408,7 +408,7 @@ <h2 id="DESCRIPTION">DESCRIPTION</h2>
<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 () {
View
23 html/doc/json.html
@@ -690,26 +690,20 @@ <h2 id="devDependencies">devDependencies</h2>
<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 &gt;=0.1.27 &lt;0.1.30" ] }</code></pre>
-
-<p>or:</p>
-
<pre><code>{ "engines" : { "node" : "&gt;=0.1.27 &lt;0.1.30" } }</code></pre>
<p>And, like with dependencies, if you don't specify the version (or if you
@@ -719,6 +713,11 @@ <h2 id="engines">engines</h2>
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 @@ <h2 id="publishConfig">publishConfig</h2>
<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 () {
View
4 html/doc/link.html
@@ -384,6 +384,10 @@ <h2 id="DESCRIPTION">DESCRIPTION</h2>
<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 () {
View
4 html/doc/list.html
@@ -378,6 +378,10 @@ <h3 id="global">global</h3>
<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 () {
View
4 html/doc/ln.html
@@ -384,6 +384,10 @@ <h2 id="DESCRIPTION">DESCRIPTION</h2>
<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 () {
View
4 html/doc/ls.html
@@ -378,6 +378,10 @@ <h3 id="global">global</h3>
<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 () {
View
10 html/doc/npm.html
@@ -337,12 +337,16 @@
<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 &lt;command&gt; [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 @@ <h2 id="AUTHOR">AUTHOR</h2>
<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 () {
View
4 html/doc/outdated.html
@@ -347,6 +347,10 @@ <h2 id="DESCRIPTION">DESCRIPTION</h2>
<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 () {
View
4 html/doc/pack.html
@@ -355,6 +355,10 @@ <h2 id="DESCRIPTION">DESCRIPTION</h2>
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 () {
View
4 html/doc/prefix.html
@@ -346,6 +346,10 @@ <h2 id="SYNOPSIS">SYNOPSIS</h2>
<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 () {
View
4 html/doc/prune.html
@@ -351,6 +351,10 @@ <h2 id="DESCRIPTION">DESCRIPTION</h2>
<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 () {
View
2  html/doc/publish.html
@@ -358,7 +358,7 @@ <h2 id="DESCRIPTION">DESCRIPTION</h2>
<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 () {
View
4 html/doc/rebuild.html
@@ -352,9 +352,9 @@ <h2 id="DESCRIPTION">DESCRIPTION</h2>
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 () {
View
4 html/doc/registry.html
@@ -423,6 +423,10 @@ <h2 id="Is-there-a-website-or-something-to-see-package-docs-and-such">Is there a
<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 () {
View
4 html/doc/removing-npm.html
@@ -384,6 +384,10 @@ <h2 id="More-Severe-Uninstalling">More Severe Uninstalling</h2>
<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 () {
View
2  html/doc/restart.html
@@ -353,7 +353,7 @@ <h2 id="DESCRIPTION">DESCRIPTION</h2>
<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 () {
View
13 html/doc/rm.html
@@ -337,16 +337,21 @@
<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 &lt;name&gt;
-npm rm &lt;name&gt;</code></pre>
+<pre><code>npm rm &lt;name&gt;
+npm uninstall &lt;name&gt;</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 () {
View
4 html/doc/root.html
@@ -346,6 +346,10 @@ <h2 id="SYNOPSIS">SYNOPSIS</h2>
<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 () {
View
4 html/doc/scripts.html
@@ -491,6 +491,10 @@ <h2 id="BEST-PRACTICES">BEST PRACTICES</h2>
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 () {
View
24 html/doc/search.html
@@ -346,6 +346,30 @@ <h2 id="SYNOPSIS">SYNOPSIS</h2>
<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 () {
View
4 html/doc/semver.html
@@ -426,6 +426,10 @@ <h3 id="Ranges">Ranges</h3>
<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 () {
View
12 html/doc/set.html
@@ -491,7 +491,7 @@ <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 <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 @@ <h3 id="dev">dev</h3>
<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 @@ <h3 id="searchexclude">searchexclude</h3>
<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 @@ <h3 id="yes">yes</h3>
<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 () {
View
4 html/doc/start.html
@@ -346,6 +346,10 @@ <h2 id="SYNOPSIS">SYNOPSIS</h2>
<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 () {
View
4 html/doc/stop.html
@@ -346,6 +346,10 @@ <h2 id="SYNOPSIS">SYNOPSIS</h2>
<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 () {
View
4 html/doc/tag.html
@@ -347,6 +347,10 @@ <h2 id="DESCRIPTION">DESCRIPTION</h2>
<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 () {
View
4 html/doc/test.html
@@ -349,6 +349,10 @@ <h2 id="DESCRIPTION">DESCRIPTION</h2>
<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 () {
View
13 html/doc/uninstall.html
@@ -337,16 +337,21 @@
<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 &lt;name&gt;
-npm rm &lt;name&gt;</code></pre>
+<pre><code>npm rm &lt;name&gt;
+npm uninstall &lt;name&gt;</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 () {
View
10 html/doc/unpublish.html
@@ -350,6 +350,16 @@ <h2 id="DESCRIPTION">DESCRIPTION</h2>
<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 () {
View
4 html/doc/update.html
@@ -349,6 +349,10 @@ <h2 id="DESCRIPTION">DESCRIPTION</h2>
(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 () {
View
4 html/doc/version.html
@@ -350,6 +350,10 @@ <h2 id="DESCRIPTION">DESCRIPTION</h2>
<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 () {
View
4 html/doc/view.html
@@ -414,6 +414,10 @@ <h2 id="OUTPUT">OUTPUT</h2>
<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 () {
View
4 html/doc/whoami.html
@@ -346,6 +346,10 @@ <h2 id="SYNOPSIS">SYNOPSIS</h2>
<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 () {
View
11 man1/adduser.1
@@ -38,3 +38,14 @@