From 5f91b73e40131b1a0f2a235ce9a37958a9be5201 Mon Sep 17 00:00:00 2001 From: isaacs Date: Thu, 3 Mar 2011 22:29:15 -0800 Subject: remove docs for removed things --- doc/activate.md | 24 ---------------- doc/bundle.md | 60 ---------------------------------------- doc/deactivate.md | 15 ---------- man1/activate.1 | 29 -------------------- man1/bundle.1 | 82 ------------------------------------------------------- man1/deactivate.1 | 21 -------------- 6 files changed, 231 deletions(-) delete mode 100644 doc/activate.md delete mode 100644 doc/bundle.md delete mode 100644 doc/deactivate.md delete mode 100644 man1/activate.1 delete mode 100644 man1/bundle.1 delete mode 100644 man1/deactivate.1 diff --git a/doc/activate.md b/doc/activate.md deleted file mode 100644 index cf964a8a4..000000000 --- a/doc/activate.md +++ /dev/null @@ -1,24 +0,0 @@ -npm activate(1) -- Activate an installed version of a package -============================================================= - -## SYNOPSIS - - npm activate @ [@ ...] - -## DESCRIPTION - -This "activates" a specific version of a package, so that you can just do -`require("foo")` without having to specify the version. - -## CONFIGURATION - -### auto-activate - -Default: true - -Automatically activate a package after installation, if there is not an active -version already. Set to "always" to always activate when installing. - -## SEE ALSO - -npm-deactivate(1) diff --git a/doc/bundle.md b/doc/bundle.md deleted file mode 100644 index 7e0d10fb0..000000000 --- a/doc/bundle.md +++ /dev/null @@ -1,60 +0,0 @@ -npm-bundle(1) -- Bundle package dependencies -============================================ - -## SYNOPSIS - - npm bundle - npm bundle destroy - npm bundle - -Run in a package folder. - -## DESCRIPTION - -When run in a package folder, this command can be used to install -package dependencies into the `node_modules` folder. - -When the package is installed, it will read dependencies from the local -bundle *before* reading any dependencies that are already installed. - -Furthermore, when installing, npm will not attempt to install -dependencies that already exist in the bundle. - -To bundle all the dependencies of a given package, run `npm bundle` -without any arguments. - -To completely remove the bundle folder, run `npm bundle destroy`. - -To operate on the bundle packages, any npm command and arguments may be -passed to the `npm bundle` command. For example, to install a package -into the bundle, you can do `npm bundle install express`. - -To list the packages in the bundle, do `npm bundle ls`. To remove bundled -packages, do `npm bundle remove `. Et cetera. - -In this way, a command like -`npm bundle install http://github.com/user/project/tarball/master` can be used -to have a dependency that is not published on the npm registry. (It still -must contain a package.json, though, of course.) - -## CAVEATS - -Man pages are not installed by bundle. - -Bins are installed, but not globally. - -When a dependency is specified as a URL rather than a version range, it -is bundled with the package depending upon it. - -## CONFIGURATION - -The bundle command itself is a proxy for `install`, or whichever command -is passed as the first argument. As such, it uses -the same configuration parameters as the commands it proxies, -but with the following temporary changes: - -* root: $PWD/node_modules/ -* binroot: $PWD/node_modules/.bin -* manroot: null - -See `npm help config` for more information on these. diff --git a/doc/deactivate.md b/doc/deactivate.md deleted file mode 100644 index 5bf5a17e9..000000000 --- a/doc/deactivate.md +++ /dev/null @@ -1,15 +0,0 @@ -npm-deactivate(1) -- Deactivate the active version of a package -=============================================================== - -## SYNOPSIS - - npm deactivate - -## DESCRIPTION - -If there's an active version of the package, this will unlink it from that -preferential position. - -## SEE ALSO - -npm-activate(1) diff --git a/man1/activate.1 b/man1/activate.1 deleted file mode 100644 index a7e9886fd..000000000 --- a/man1/activate.1 +++ /dev/null @@ -1,29 +0,0 @@ -.\" Generated with Ronnjs/v0.1 -.\" http://github.com/kapouer/ronnjs/ -. -.TH "ACTIVATE" "1" "March 2011" "" "" -. -.SH "NAME" -\fBactivate\fR \-\- Activate an installed version of a package -. -.SH "SYNOPSIS" -. -.nf -npm activate @ [@ \.\.\.] -. -.fi -. -.SH "DESCRIPTION" -This "activates" a specific version of a package, so that you can just do \fBrequire("foo")\fR without having to specify the version\. -. -.SH "CONFIGURATION" -. -.SS "auto\-activate" -Default: true -. -.P -Automatically activate a package after installation, if there is not an active -version already\. Set to "always" to always activate when installing\. -. -.SH "SEE ALSO" -npm\-deactivate(1) diff --git a/man1/bundle.1 b/man1/bundle.1 deleted file mode 100644 index aedd144f5..000000000 --- a/man1/bundle.1 +++ /dev/null @@ -1,82 +0,0 @@ -.\" Generated with Ronnjs/v0.1 -.\" http://github.com/kapouer/ronnjs/ -. -.TH "NPM\-BUNDLE" "1" "March 2011" "" "" -. -.SH "NAME" -\fBnpm-bundle\fR \-\- Bundle package dependencies -. -.SH "SYNOPSIS" -. -.nf -npm bundle -npm bundle destroy -npm bundle -. -.fi -. -.P -Run in a package folder\. -. -.SH "DESCRIPTION" -When run in a package folder, this command can be used to install -package dependencies into the \fBnode_modules\fR folder\. -. -.P -When the package is installed, it will read dependencies from the local -bundle \fIbefore\fR reading any dependencies that are already installed\. -. -.P -Furthermore, when installing, npm will not attempt to install -dependencies that already exist in the bundle\. -. -.P -To bundle all the dependencies of a given package, run \fBnpm bundle\fR -without any arguments\. -. -.P -To completely remove the bundle folder, run \fBnpm bundle destroy\fR\|\. -. -.P -To operate on the bundle packages, any npm command and arguments may be -passed to the \fBnpm bundle\fR command\. For example, to install a package -into the bundle, you can do \fBnpm bundle install express\fR\|\. -. -.P -To list the packages in the bundle, do \fBnpm bundle ls\fR\|\. To remove bundled -packages, do \fBnpm bundle remove \fR\|\. Et cetera\. -. -.P -In this way, a command like \fBnpm bundle install http://github\.com/user/project/tarball/master\fR can be used -to have a dependency that is not published on the npm registry\. (It still -must contain a package\.json, though, of course\.) -. -.SH "CAVEATS" -Man pages are not installed by bundle\. -. -.P -Bins are installed, but not globally\. -. -.P -When a dependency is specified as a URL rather than a version range, it -is bundled with the package depending upon it\. -. -.SH "CONFIGURATION" -The bundle command itself is a proxy for \fBinstall\fR, or whichever command -is passed as the first argument\. As such, it uses -the same configuration parameters as the commands it proxies, -but with the following temporary changes: -. -.IP "\(bu" 4 -root: $PWD/node_modules/ -. -.IP "\(bu" 4 -binroot: $PWD/node_modules/\.bin -. -.IP "\(bu" 4 -manroot: null -. -.IP "" 0 -. -.P -See \fBnpm help config\fR for more information on these\. diff --git a/man1/deactivate.1 b/man1/deactivate.1 deleted file mode 100644 index 2bbf6b4f0..000000000 --- a/man1/deactivate.1 +++ /dev/null @@ -1,21 +0,0 @@ -.\" Generated with Ronnjs/v0.1 -.\" http://github.com/kapouer/ronnjs/ -. -.TH "NPM\-DEACTIVATE" "1" "March 2011" "" "" -. -.SH "NAME" -\fBnpm-deactivate\fR \-\- Deactivate the active version of a package -. -.SH "SYNOPSIS" -. -.nf -npm deactivate -. -.fi -. -.SH "DESCRIPTION" -If there\'s an active version of the package, this will unlink it from that -preferential position\. -. -.SH "SEE ALSO" -npm\-activate(1) -- cgit v1.2.3