diff options
author | isaacs <i@izs.me> | 2011-09-04 12:31:22 +0400 |
---|---|---|
committer | isaacs <i@izs.me> | 2011-09-04 12:31:22 +0400 |
commit | ad8bb009dc7a8a47276574c7672b4bab788cc901 (patch) | |
tree | f8f18a3db9c6bd40c82504c6e1f82941acf663b1 /doc | |
parent | 1149c8fda5be50428dd9ae62dd1caa6b1d6cf812 (diff) |
Always use npm-blah(1) in the md, convert appropriately
HTML gets a hyperlink, manpage gets 'npm help blah' text
Diffstat (limited to 'doc')
-rw-r--r-- | doc/coding-style.md | 2 | ||||
-rw-r--r-- | doc/config.md | 8 | ||||
-rw-r--r-- | doc/developers.md | 10 | ||||
-rw-r--r-- | doc/edit.md | 2 | ||||
-rw-r--r-- | doc/faq.md | 12 | ||||
-rw-r--r-- | doc/folders.md | 4 | ||||
-rw-r--r-- | doc/install.md | 8 | ||||
-rw-r--r-- | doc/json.md | 12 | ||||
-rw-r--r-- | doc/npm.md | 15 | ||||
-rw-r--r-- | doc/rebuild.md | 2 | ||||
-rw-r--r-- | doc/registry.md | 4 | ||||
-rw-r--r-- | doc/scripts.md | 2 | ||||
-rw-r--r-- | doc/submodule.md | 2 | ||||
-rw-r--r-- | doc/view.md | 2 |
14 files changed, 41 insertions, 44 deletions
diff --git a/doc/coding-style.md b/doc/coding-style.md index d09d4ea44..41d456917 100644 --- a/doc/coding-style.md +++ b/doc/coding-style.md @@ -151,7 +151,7 @@ report what's happening so that it's easier to track down where a fault occurs. Use appropriate log levels. The default log() function logs at the -"info" level. See `npm help config` and search for "loglevel". +"info" level. See `npm-config(1)` and search for "loglevel". ## Case, naming, etc. diff --git a/doc/config.md b/doc/config.md index d37b02757..82b15859b 100644 --- a/doc/config.md +++ b/doc/config.md @@ -114,7 +114,7 @@ example: ## Per-Package Config Settings -When running scripts (see `npm help scripts`) +When running scripts (see `npm-scripts(1)`) the package.json "config" keys are overwritten in the environment if there is a config param of `<name>[@<version>]:<key>`. For example, if the package.json has this: @@ -179,7 +179,7 @@ The browser that is called by the `npm docs` command to open websites. * Default: Windows: `~/npm-cache`, Posix: `~/.npm` * Type: path -The location of npm's cache directory. See `npm help cache` +The location of npm's cache directory. See `npm-cache(1)` ### color @@ -240,7 +240,7 @@ Makes various commands more forceful. Operates in "global" mode, so that packages are installed into the `prefix` folder instead of the current working directory. See -`npm help folders` for more on the differences in behavior. +`npm-folders(1)` for more on the differences in behavior. * packages are installed into the `prefix/node_modules` folder, instead of the current working directory. @@ -542,7 +542,7 @@ will fail. * Type: Boolean Set to show short usage output (like the -H output) -instead of complete help when doing `npm help`. +instead of complete help when doing `npm-help(1)`. ### user diff --git a/doc/developers.md b/doc/developers.md index eab9b8aa8..9b7d8a63e 100644 --- a/doc/developers.md +++ b/doc/developers.md @@ -15,10 +15,7 @@ that your users will do to install your program. These are man pages. If you install npm, you should be able to then do `man npm-thing` to get the documentation on a particular -topic. - -Any time you see "see npm-whatever(1)", you can do `man npm-whatever` -or `npm help whatever` to get at the docs. +topic, or `npm help thing` to see the same information. ## What is a `package` @@ -141,10 +138,7 @@ Create a user with the adduser command. It works like this: and then follow the prompts. -This is documented better in npm-adduser(1). So do this to get the -details: - - npm help adduser +This is documented better in npm-adduser(1). ## Publish your package diff --git a/doc/edit.md b/doc/edit.md index b5bd07947..a24d3214c 100644 --- a/doc/edit.md +++ b/doc/edit.md @@ -8,7 +8,7 @@ npm-edit(1) -- Edit an installed package ## DESCRIPTION Opens the package folder in the default editor (or whatever you've -configured as the npm `editor` config -- see `npm help config`.) +configured as the npm `editor` config -- see `npm-config(1)`.) After it has been edited, the package is rebuilt so as to pick up any changes in compiled packages. diff --git a/doc/faq.md b/doc/faq.md index 8e96cbe74..617a3799d 100644 --- a/doc/faq.md +++ b/doc/faq.md @@ -18,7 +18,7 @@ do what it says and post a bug with all the information it asks for. ## Where does npm put stuff? -See `npm help folders` +See `npm-folders(1)` tl;dr: @@ -51,7 +51,7 @@ Ok, fine. Do this: This is not recommended. Many things **will not work** if you do this. Make sure you read and -understand `npm help config` and `npm help global` before you complain +understand `npm-config(1)` and `npm-global(1)` before you complain about things being broken. When you realize what a mistake it was, do this to switch back: @@ -138,12 +138,12 @@ You don't. Try one of these: ## How can I use npm for development? -See `npm help developers` and `npm help json`. +See `npm-developers(1)` and `npm-json(1)`. You'll most likely want to `npm link` your development folder. That's awesomely handy. -To set up your own private registry, check out `npm help registry`. +To set up your own private registry, check out `npm-registry(1)`. ## Can I list a url as a dependency? @@ -153,11 +153,11 @@ that has a package.json in its root, or a git url. ## How do I symlink to a dev folder so I don't have to keep re-installing? -See `npm help link` +See `npm-link(1)` ## The package registry website. What is that exactly? -See `npm help registry`. +See `npm-registry(1)`. ## What's up with the insecure channel warnings? diff --git a/doc/folders.md b/doc/folders.md index 7c1327a00..5ac445190 100644 --- a/doc/folders.md +++ b/doc/folders.md @@ -49,7 +49,7 @@ When in local mode, man pages are not installed. ### Cache -See `npm help cache`. Cache files are stored in `~/.npm` on Posix, or +See `npm-cache(1)`. Cache files are stored in `~/.npm` on Posix, or `~/npm-cache` on Windows. This is controlled by the `cache` configuration param. @@ -182,4 +182,4 @@ 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 help json` for more information. +cannot be found elsewhere. See `npm-json(1)` for more information. diff --git a/doc/install.md b/doc/install.md index 91188ca21..7c983576a 100644 --- a/doc/install.md +++ b/doc/install.md @@ -63,7 +63,7 @@ after packing it up into a tarball (b). * npm install `<name>`: Do a `<name>@<tag>` install, where `<tag>` is the "tag" config. (See - `npm help config`) + `npm-config(1)`) Example: @@ -88,7 +88,7 @@ after packing it up into a tarball (b). * npm install `<name>@<version range>`: Install a version of the package matching the specified version range. This - will follow the same rules for resolving dependencies described in `npm help json`. + will follow the same rules for resolving dependencies described in `npm-json(1)`. Note that most version ranges must be put in quotes so that your shell will treat it as a single argument. @@ -110,12 +110,12 @@ local copy exists on disk. npm install sax --force The `--global` argument will cause npm to install the package globally -rather than locally. See `npm help global`. +rather than locally. See `npm-global(1)`. The `--link` argument will cause npm to link global installs into the local space in some cases. -See `npm help config`. Many of the configuration params have some +See `npm-config(1)`. Many of the configuration params have some effect on installation, since that's most of what npm does. ## SEE ALSO diff --git a/doc/json.md b/doc/json.md index 2a7b10eb7..e3be18ffe 100644 --- a/doc/json.md +++ b/doc/json.md @@ -7,7 +7,7 @@ This document is all you need to know about what's required in your package.json file. It must be actual JSON, not just a JavaScript object literal. A lot of the behavior described in this document is affected by the config -settings described in `npm help config`. +settings described in `npm-config(1)`. ## DEFAULT VALUES @@ -276,7 +276,7 @@ The "scripts" member is an object hash of script commands that are run at various times in the lifecycle of your package. The key is the lifecycle event, and the value is the command to run at that point. -See `npm help scripts` to find out more about writing package scripts. +See `npm-scripts(1)` to find out more about writing package scripts. ## config @@ -291,7 +291,7 @@ and then had a "start" command that then referenced the `npm_package_config_port` environment variable, then the user could override that by doing `npm config set foo:port 8001`. -See `npm help config` and `npm help scripts` for more on package +See `npm-config(1)` and `npm-scripts(1)` for more on package configs. ## dependencies @@ -385,8 +385,8 @@ In this case, it's best to list these additional items in a These things will be installed whenever the `--dev` configuration flag is set. This flag is set automatically when doing `npm link`, and can -be managed like any other npm configuration param. See `npm help -config` for more on the topic. +be managed like any other npm configuration param. See `npm-config(1)` +for more on the topic. ## bundledDependencies @@ -444,5 +444,5 @@ the global public registry by default. Any config values can be overridden, but of course only "tag" and "registry" probably matter for the purposes of publishing. -See `npm help config` to see the list of config options that can be +See `npm-config(1)` to see the list of config options that can be overridden. diff --git a/doc/npm.md b/doc/npm.md index 075730bf9..48fcf768a 100644 --- a/doc/npm.md +++ b/doc/npm.md @@ -22,14 +22,14 @@ Run `npm help` to get a list of available commands. You probably got npm because you want to install stuff. Use `npm install blerg` to install the latest version of "blerg". Check out -`npm help install` for more info. It can do a lot of stuff. +`npm-install(1)` for more info. It can do a lot of stuff. Use the `npm search` command to show everything that's available. Use `npm ls` to show everything you've installed. ## DIRECTORIES -See `npm help folders` to learn about where npm puts stuff. +See `npm-folders(1)` to learn about where npm puts stuff. In particular, npm has two modes of operation: @@ -50,7 +50,7 @@ If you're using npm to develop and publish your code, check out the following help topics: * json: - Make a package.json file. See `npm help json`. + Make a package.json file. See `npm-json(1)`. * link: For linking your current working code into Node's path, so that you don't have to reinstall every time you make a change. Use @@ -91,14 +91,14 @@ npm is extremely configurable. It reads its configuration options from npm's default configuration options are defined in lib/utils/config-defs.js. These must not be changed. -See `npm help config` for much much more information. +See `npm-config(1)` for much much more information. ## CONTRIBUTIONS Patches welcome! * code: - Read through `npm help coding-style` if you plan to submit code. + Read through `npm-coding(1)-style` if you plan to submit code. You don't have to agree with it, but you do have to follow it. * docs: If you find an error in the documentation, edit the appropriate markdown @@ -134,4 +134,7 @@ See npm-changelog(1) ## AUTHOR -Isaac Z. Schlueter :: isaacs :: [@izs](http://twitter.com/izs) :: <i@izs.me> +[Isaac Z. Schlueter](http://blog.izs.me/) :: +[isaacs](https://github.com/isaacs/) :: +[@izs](http://twitter.com/izs) :: +<i@izs.me> diff --git a/doc/rebuild.md b/doc/rebuild.md index f98485cd0..9a6bb81bb 100644 --- a/doc/rebuild.md +++ b/doc/rebuild.md @@ -16,4 +16,4 @@ the new binary. ## CONFIGURATION -See `npm help build` +See `npm-build(1)` diff --git a/doc/registry.md b/doc/registry.md index 6dc2702b2..3d1785d01 100644 --- a/doc/registry.md +++ b/doc/registry.md @@ -19,7 +19,7 @@ are CouchDB users, stored in the <http://isaacs.couchone.com/_users> database. The registry URL is supplied by the `registry` config parameter. See -`npm help config` for more on managing npm's configuration. +`npm-config(1)` for more on managing npm's configuration. ## Can I run my own private registry? @@ -42,7 +42,7 @@ published at all, or `"publishConfig":{"registry":"http://my-internal-registry.local"}` to force it to be published only to your internal registry. -See `npm help json` for more info on what goes in the package.json file. +See `npm-json(1)` for more info on what goes in the package.json file. ## Will you replicate from my registry into the public one? diff --git a/doc/scripts.md b/doc/scripts.md index 52246fdc5..7fc2a9321 100644 --- a/doc/scripts.md +++ b/doc/scripts.md @@ -164,7 +164,7 @@ they are in a separate child process, with the env described above. only will prevent some optional features, then it's better to just print a warning and exit successfully. * Try not to use scripts to do what npm can do for you. Read through - `npm help json` to see all the things that you can specify and enable + `npm-json(1)` to see all the things that you can specify and enable by simply describing your package appropriately. In general, this will lead to a more robust and consistent state. * Inspect the env to determine where to put things. For instance, if diff --git a/doc/submodule.md b/doc/submodule.md index ab2ffcdaf..13ab1edd9 100644 --- a/doc/submodule.md +++ b/doc/submodule.md @@ -24,5 +24,5 @@ dependencies into the submodule folder. ## SEE ALSO -* npm help json +* npm-json(1) * git help submodule diff --git a/doc/view.md b/doc/view.md index 01b10dd50..3bac5172d 100644 --- a/doc/view.md +++ b/doc/view.md @@ -55,7 +55,7 @@ can do this: "Person" fields are shown as a string if they would be shown as an object. So, for example, this will show the list of npm contributors in -the shortened string format. (See `npm help json` for more on this.) +the shortened string format. (See `npm-json(1)` for more on this.) npm view npm contributors |