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 /doc | |
parent | 32f2673e00ddf0714c4a43a4a31d9d8cab981ab8 (diff) |
Add SEE ALSO to all doc sections, and rebuild
Diffstat (limited to 'doc')
45 files changed, 387 insertions, 23 deletions
diff --git a/doc/adduser.md b/doc/adduser.md index c6136814d..3bf484b7b 100644 --- a/doc/adduser.md +++ b/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) diff --git a/doc/bin.md b/doc/bin.md index 5e260647c..2c2e7c477 100644 --- a/doc/bin.md +++ b/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) diff --git a/doc/bundle.md b/doc/bundle.md index b2fd0cf57..69b3d83e4 100644 --- a/doc/bundle.md +++ b/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) diff --git a/doc/cache.md b/doc/cache.md index 5c2680812..43d2380c6 100644 --- a/doc/cache.md +++ b/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) diff --git a/doc/changelog.md b/doc/changelog.md index 80062046a..0115405ca 100644 --- a/doc/changelog.md +++ b/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
\ No newline at end of file +* Core functionality established + +## SEE ALSO + +* npm(1) +* npm-faq(1) diff --git a/doc/coding-style.md b/doc/coding-style.md index 41d456917..f0640c85c 100644 --- a/doc/coding-style.md +++ b/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) diff --git a/doc/completion.md b/doc/completion.md index 89d69f2ad..f4841fe68 100644 --- a/doc/completion.md +++ b/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) diff --git a/doc/config.md b/doc/config.md index 82b15859b..71ea750ef 100644 --- a/doc/config.md +++ b/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) diff --git a/doc/deprecate.md b/doc/deprecate.md index a6d7c74e7..925337f21 100644 --- a/doc/deprecate.md +++ b/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) diff --git a/doc/developers.md b/doc/developers.md index 9b7d8a63e..0f0f94c58 100644 --- a/doc/developers.md +++ b/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) diff --git a/doc/docs.md b/doc/docs.md index 38e123c59..d9131b570 100644 --- a/doc/docs.md +++ b/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) diff --git a/doc/edit.md b/doc/edit.md index a24d3214c..9eaccfc54 100644 --- a/doc/edit.md +++ b/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) diff --git a/doc/explore.md b/doc/explore.md index 6a1b71e9c..00701b392 100644 --- a/doc/explore.md +++ b/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) diff --git a/doc/faq.md b/doc/faq.md index dbf70bb7e..339fb957c 100644 --- a/doc/faq.md +++ b/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) diff --git a/doc/folders.md b/doc/folders.md index 5ac445190..2f0cfd2e6 100644 --- a/doc/folders.md +++ b/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) diff --git a/doc/help-search.md b/doc/help-search.md index f5ec83e2b..baffc55b0 100644 --- a/doc/help-search.md +++ b/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) diff --git a/doc/init.md b/doc/init.md index 5f6d81c2a..f9c5b324e 100644 --- a/doc/init.md +++ b/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) diff --git a/doc/install.md b/doc/install.md index 7c983576a..ec7e50536 100644 --- a/doc/install.md +++ b/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) diff --git a/doc/json.md b/doc/json.md index e3be18ffe..74aaec810 100644 --- a/doc/json.md +++ b/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) diff --git a/doc/link.md b/doc/link.md index dc2e5136b..8701d2a1d 100644 --- a/doc/link.md +++ b/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) diff --git a/doc/list.md b/doc/list.md index 7d6e60acb..596349a81 100644 --- a/doc/list.md +++ b/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) diff --git a/doc/npm.md b/doc/npm.md index e76e58e20..8d14f6ff2 100644 --- a/doc/npm.md +++ b/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) diff --git a/doc/outdated.md b/doc/outdated.md index fd30478cc..78df4a8b3 100644 --- a/doc/outdated.md +++ b/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) diff --git a/doc/pack.md b/doc/pack.md index 1a5920b4d..98d8c81c5 100644 --- a/doc/pack.md +++ b/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) diff --git a/doc/prefix.md b/doc/prefix.md index 93da78b94..f6247cab1 100644 --- a/doc/prefix.md +++ b/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) diff --git a/doc/prune.md b/doc/prune.md index 7344753f2..8c4b957e6 100644 --- a/doc/prune.md +++ b/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) diff --git a/doc/publish.md b/doc/publish.md index c6defe778..621932f07 100644 --- a/doc/publish.md +++ b/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) diff --git a/doc/rebuild.md b/doc/rebuild.md index 9a6bb81bb..6985a7bdd 100644 --- a/doc/rebuild.md +++ b/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) diff --git a/doc/registry.md b/doc/registry.md index 3d1785d01..8073ea082 100644 --- a/doc/registry.md +++ b/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) diff --git a/doc/removing-npm.md b/doc/removing-npm.md index 29425eeb8..ac3780139 100644 --- a/doc/removing-npm.md +++ b/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) diff --git a/doc/restart.md b/doc/restart.md index f052098be..6139dbeef 100644 --- a/doc/restart.md +++ b/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) diff --git a/doc/root.md b/doc/root.md index ce4e04113..3e4199541 100644 --- a/doc/root.md +++ b/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) diff --git a/doc/scripts.md b/doc/scripts.md index 7fc2a9321..9a5a904ea 100644 --- a/doc/scripts.md +++ b/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) diff --git a/doc/search.md b/doc/search.md index 8a6267e5c..3b15e9b07 100644 --- a/doc/search.md +++ b/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) diff --git a/doc/semver.md b/doc/semver.md index 22d790e21..107f5e48f 100644 --- a/doc/semver.md +++ b/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) diff --git a/doc/start.md b/doc/start.md index 864429297..cc897bbc0 100644 --- a/doc/start.md +++ b/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) diff --git a/doc/stop.md b/doc/stop.md index 436e0f56b..1ab3e9975 100644 --- a/doc/stop.md +++ b/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) diff --git a/doc/tag.md b/doc/tag.md index a50b4ebcf..2f1ca4373 100644 --- a/doc/tag.md +++ b/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) diff --git a/doc/test.md b/doc/test.md index 963db70d8..bc634efbf 100644 --- a/doc/test.md +++ b/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) diff --git a/doc/uninstall.md b/doc/uninstall.md index ac2980d23..f7f743fae 100644 --- a/doc/uninstall.md +++ b/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) diff --git a/doc/unpublish.md b/doc/unpublish.md index 65e7ce6fc..7e347a95d 100644 --- a/doc/unpublish.md +++ b/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) diff --git a/doc/update.md b/doc/update.md index 4721a3c48..1de49f2e2 100644 --- a/doc/update.md +++ b/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) diff --git a/doc/version.md b/doc/version.md index 32b626ab5..2904a6ae2 100644 --- a/doc/version.md +++ b/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) diff --git a/doc/view.md b/doc/view.md index 3bac5172d..e3585f540 100644 --- a/doc/view.md +++ b/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) diff --git a/doc/whoami.md b/doc/whoami.md index 41f1c618f..7c39b1624 100644 --- a/doc/whoami.md +++ b/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) |