Skip to content
This repository has been archived by the owner on May 2, 2023. It is now read-only.

Commit

Permalink
Remove some contrived SYNOPSISes, and just use the heading
Browse files Browse the repository at this point in the history
  • Loading branch information
isaacs committed Sep 8, 2011
1 parent 4dc1095 commit 8e08f0d
Show file tree
Hide file tree
Showing 10 changed files with 155 additions and 295 deletions.
4 changes: 0 additions & 4 deletions doc/changelog.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,6 @@
npm-changelog(1) -- Changes
===========================

## SYNOPSIS

A brief history.

## HISTORY

### 1.0
Expand Down
4 changes: 0 additions & 4 deletions doc/faq.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,6 @@
npm-faq(1) -- Frequently Asked Questions
========================================

## SYNOPSIS

Questions asked frequently.

## Where can I find these docs in HTML?

<http://npmjs.org/doc/>, or run:
Expand Down
139 changes: 51 additions & 88 deletions doc/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,242 +3,205 @@ npm-index(1) -- Index of all npm documentation

## npm-README(1)

This is just enough info to get you up and running.
node package manager

## npm-adduser(1)

Create or verify a user named `<username>` in the npm registry, and
save the credentials to the `.npmrc` file.
Add a registry user account

## npm-bin(1)

Print the folder where npm will install executables.
Display npm bin folder

## npm-build(1)

This is the plumbing command called by `npm link` and `npm install`.
Build a package

## npm-bundle(1)

The `npm bundle` command has been removed in 1.0, for the simple reason
that it is no longer necessary, as the default behavior is now to
install packages into the local space.
REMOVED

## npm-cache(1)

Used to add, list, or clear the npm cache folder.
install a package

## npm-changelog(1)

A brief history.
Changes

## npm-coding-style(1)

npm's coding style is a bit unconventional. It is not different for
difference's sake, but rather a carefully crafted style that is
designed to reduce visual clutter and make bugs more apparent.
npm's "funny" coding style

## npm-completion(1)

Enables tab-completion in all npm commands.
Tab Completion for npm

## npm-config(1)

npm gets its configuration values from 5 sources, in this priority:
Manage the npm configuration file

## npm-deprecate(1)

This command will update the npm registry entry for a package, providing
a deprecation warning to all who attempt to install it.
Deprecate a version of a package

## npm-developers(1)

So, you've decided to use npm to develop (and maybe publish/deploy)
your project.
Developer Guide

## npm-docs(1)

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.
Docs for a package in a web browser maybe

## npm-edit(1)

Opens the package folder in the default editor (or whatever you've
configured as the npm `editor` config -- see `npm-config(1)`.)
Edit an installed package

## npm-explore(1)

Spawn a subshell in the directory of the installed package specified.
Browse an installed package

## npm-faq(1)

Questions asked frequently.
Frequently Asked Questions

## npm-folders(1)

npm puts various things on your computer. That's its job.
Folder Structures Used by npm

## npm-help-search(1)

This command will search the npm markdown documentation files for the
terms provided, and then list the results, sorted by relevance.
Search npm help documentation

## npm-help(1)

If supplied a topic, then show the appropriate documentation page.
Get help on npm

## npm-init(1)

This will ask you a bunch of questions, and then write a package.json for you.
Interactively create a package.json file

## npm-install(1)

This command installs a package, and any packages that it depends on.
install a package

## npm-json(1)

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.
Specifics of npm's package.json handling

## npm-link(1)

Package linking is a two-step process.
Symlink a package folder

## npm-list(1)

This command will print to stdout all the versions of packages that are
installed, as well as their dependencies, in a tree-structure.
List installed packages

## npm-npm(1)

npm is the package manager for the Node JavaScript platform. It puts
modules in place so that node can find them, and manages dependency
conflicts intelligently.
node package manager

## npm-outdated(1)

This command will check the registry to see if any (or, specific) installed
packages are currently outdated.
Check for outdated packages

## npm-owner(1)

Manage ownership of published packages.
Manage package owners

## npm-pack(1)

For anything that's installable (that is, a package folder, tarball,
tarball url, name@tag, name@version, or name), this command will fetch
it to the cache, and then copy the tarball to the current working
directory as `<name>-<version>.tgz`, and then write the filenames out to
stdout.
Create a tarball from a package

## npm-prefix(1)

Print the prefix to standard out.
Display prefix

## npm-prune(1)

This command removes "extraneous" packages. If a package name is
provided, then only packages matching one of the supplied names are
removed.
Remove extraneous packages

## npm-publish(1)

Publishes a package to the registry so that it can be installed by name.
Publish a package

## npm-rebuild(1)

This command runs the `npm build` command on the matched folders. This is useful
when you install a new version of node, and must recompile all your C++ addons with
the new binary.
Rebuild a package

## npm-registry(1)

To resolve packages by name and version, npm talks to a registry website
that implements the CommonJS Package Registry specification for reading
package info.
The JavaScript Package Registry

## npm-removing-npm(1)

So sad to see you go.
Cleaning the Slate

## npm-restart(1)

This runs a package's "restart" script, if one was provided.
Otherwise it runs package's "stop" script, if one was provided, and then
the "start" script.
Start a package

## npm-root(1)

Print the effective `node_modules` folder to standard out.
Display npm root

## npm-run-script(1)

This runs an arbitrary command from a package's "scripts" object.
Run arbitrary package scripts

## npm-scripts(1)

npm supports the "scripts" member of the package.json script, for the
following scripts:
How npm handles the "scripts" field

## npm-search(1)

Search the registry for packages matching the search terms.
Search for packages

## npm-semver(1)

As a node module:
The semantic versioner for npm

## npm-start(1)

This runs a package's "start" script, if one was provided.
Start a package

## npm-stop(1)

This runs a package's "stop" script, if one was provided.
Stop a package

## npm-submodule(1)

If the specified package has a git repository url in its package.json
description, then this command will add it as a git submodule at
`node_modules/<pkg name>`.
Add a package as a git submodule

## npm-tag(1)

Tags the specified version of the package with the specified tag, or the
`--tag` config if not specified.
Tag a published version

## npm-test(1)

This runs a package's "test" script, if one was provided.
Test a package

## npm-uninstall(1)

This uninstalls a package, completely removing everything npm installed
on its behalf.
Remove a package

## npm-unpublish(1)

This removes a package version from the registry, deleting its
entry and removing the tarball.
Remove a package from the registry

## npm-update(1)

This command will update all the packages listed to the latest version
(specified by the `tag` config).
Update a package

## npm-version(1)

Run this in a package directory to bump the version and write the new
data back to the package.json file.
Bump a package version

## npm-view(1)

This command shows data about a package and prints it to the stream
referenced by the `outfd` config, which defaults to stdout.
View registry info

## npm-whoami(1)

Print the `username` config to standard output.
Display npm username

4 changes: 0 additions & 4 deletions html/doc/changelog.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,6 @@
<div id="wrapper">
<h1><a href="changelog.html">changelog</a></h1> <p>Changes</p>

<h2 id="SYNOPSIS">SYNOPSIS</h2>

<p>A brief history.</p>

<h2 id="HISTORY">HISTORY</h2>

<h3 id="1-0">1.0</h3>
Expand Down
4 changes: 0 additions & 4 deletions html/doc/faq.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,6 @@
<div id="wrapper">
<h1><a href="faq.html">faq</a></h1> <p>Frequently Asked Questions</p>

<h2 id="SYNOPSIS">SYNOPSIS</h2>

<p>Questions asked frequently.</p>

<h2 id="Where-can-I-find-these-docs-in-HTML">Where can I find these docs in HTML?</h2>

<p><a href="http://npmjs.org/doc/">http://npmjs.org/doc/</a>, or run:</p>
Expand Down
Loading

0 comments on commit 8e08f0d

Please sign in to comment.