diff options
author | isaacs <i@izs.me> | 2010-11-22 07:10:30 +0300 |
---|---|---|
committer | isaacs <i@izs.me> | 2010-11-22 07:10:30 +0300 |
commit | fb80e0d316885b44b61d5fe3591bd4ade241a61a (patch) | |
tree | 6ea024ff90aff843c6f6a79ce57d0184cf674a6a /man1 | |
parent | b87d5c4aff58140c00baf753bad857d35a10aacb (diff) |
Docs for bundle changes.
Diffstat (limited to 'man1')
-rw-r--r-- | man1/bundle.1 | 50 |
1 files changed, 10 insertions, 40 deletions
diff --git a/man1/bundle.1 b/man1/bundle.1 index 975af4e44..c68f6be1c 100644 --- a/man1/bundle.1 +++ b/man1/bundle.1 @@ -9,20 +9,13 @@ .SH "SYNOPSIS" . .nf -npm bundle [<pkg>] +npm bundle [<cmd> \.\.\.] . .fi . .P Run in a package folder\. . -.IP "\(bu" 4 -\fB<pkg>\fR: -The package whose dependencies are to be bundled\. Defaults to $PWD\. -See \fBnpm help install\fR for more on the ways to identify a package\. -. -.IP "" 0 -. .SH "DESCRIPTION" When run in a package folder, this command can be used to install package dependencies into the \fBnode_modules\fR folder\. @@ -36,44 +29,21 @@ Furthermore, when installing, npm will not attempt to install dependencies that already exist in the bundle\. . .P -In this way, a command like \fBnpm bundle 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\.) +To bundle all the dependencies of a given package, run \fBnpm bundle\fR +without any arguments\. . .P -If called without an argument, it bundles all the dependencies of the -package\. +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 -In all ways, \fBnpm bundle\fR is a shorthand for this: -. -.IP "" 4 -. -.nf -npm install (whatever) \\ - \-\-root \./node_modules \\ - \-\-binroot false \\ - \-\-manroot false -. -.fi -. -.IP "" 0 +To list the packages in the bundle, do \fBnpm bundle ls\fR\|\. . .P -Bundles all the dependencies +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" -There is no pretty to "remove" a package from a bundle at the moment\. -However, you can do this: -. -.IP "" 4 -. -.nf -npm \-\-root \./node_modules rm foo -. -.fi -. -.IP "" 0 -. -.P Bins and man pages are not installed by bundle\. |