Skip to content
This repository has been archived by the owner on Aug 11, 2022. It is now read-only.

Commit

Permalink
Add SEE ALSO to all doc sections, and rebuild
Browse files Browse the repository at this point in the history
  • Loading branch information
isaacs committed Sep 4, 2011
1 parent 32f2673 commit b19d703
Show file tree
Hide file tree
Showing 149 changed files with 1,737 additions and 99 deletions.
5 changes: 5 additions & 0 deletions doc/adduser.md
Expand Up @@ -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)
7 changes: 7 additions & 0 deletions doc/bin.md
Expand Up @@ -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)
4 changes: 4 additions & 0 deletions doc/bundle.md
Expand Up @@ -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)
8 changes: 8 additions & 0 deletions doc/cache.md
Expand Up @@ -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)
7 changes: 6 additions & 1 deletion doc/changelog.md
Expand Up @@ -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)
6 changes: 6 additions & 0 deletions doc/coding-style.md
Expand Up @@ -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)
6 changes: 6 additions & 0 deletions doc/completion.md
Expand Up @@ -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)
11 changes: 9 additions & 2 deletions doc/config.md
Expand Up @@ -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`.
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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)
5 changes: 5 additions & 0 deletions doc/deprecate.md
Expand Up @@ -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)
13 changes: 12 additions & 1 deletion doc/developers.md
Expand Up @@ -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:
Expand Down Expand Up @@ -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)
23 changes: 23 additions & 0 deletions doc/docs.md
Expand Up @@ -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)
17 changes: 17 additions & 0 deletions doc/edit.md
Expand Up @@ -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)
24 changes: 24 additions & 0 deletions doc/explore.md
Expand Up @@ -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)
8 changes: 8 additions & 0 deletions doc/faq.md
Expand Up @@ -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)
10 changes: 10 additions & 0 deletions doc/folders.md
Expand Up @@ -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)
5 changes: 5 additions & 0 deletions doc/help-search.md
Expand Up @@ -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)
3 changes: 2 additions & 1 deletion doc/init.md
Expand Up @@ -20,4 +20,5 @@ without a really good reason to do so.

## SEE ALSO

npm-json(1)
* npm-json(1)
* npm-version(1)
9 changes: 6 additions & 3 deletions doc/install.md
Expand Up @@ -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)
29 changes: 20 additions & 9 deletions doc/json.md
Expand Up @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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)
9 changes: 9 additions & 0 deletions doc/link.md
Expand Up @@ -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)
10 changes: 10 additions & 0 deletions doc/list.md
Expand Up @@ -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)
13 changes: 13 additions & 0 deletions doc/npm.md
Expand Up @@ -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
Expand Down Expand Up @@ -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)
6 changes: 6 additions & 0 deletions doc/outdated.md
Expand Up @@ -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)
6 changes: 6 additions & 0 deletions doc/pack.md
Expand Up @@ -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)

0 comments on commit b19d703

Please sign in to comment.