diff options
author | isaacs <i@izs.me> | 2010-05-03 23:30:30 +0400 |
---|---|---|
committer | isaacs <i@izs.me> | 2010-05-03 23:30:30 +0400 |
commit | b70b2a09fa76f1cc3e3f9da7dd4f48ac073d6d0a (patch) | |
tree | a1e40a1473c3b5db3efea8ad338c966fac605400 /man/install.1 | |
parent | a3dec1abdf971e83377ff167382c56fe26f6c8d6 (diff) |
Add built documentation to project, so that the install doesn't require ronn
Diffstat (limited to 'man/install.1')
-rw-r--r-- | man/install.1 | 148 |
1 files changed, 148 insertions, 0 deletions
diff --git a/man/install.1 b/man/install.1 new file mode 100644 index 000000000..4455c2734 --- /dev/null +++ b/man/install.1 @@ -0,0 +1,148 @@ +.\" generated with Ronn/v0.4.1 +.\" http://github.com/rtomayko/ronn/ +. +.TH "NPM\-INSTALL" "1" "May 2010" "" "" +. +.SH "NAME" +\fBnpm\-install\fR \-\- install a package +. +.SH "SYNOPSIS" +. +.nf +npm install <tarball file> +npm install <tarball url> +npm install <pkg> +npm install <pkg>@<tag> +npm install <pkg>@<version> +npm install <pkg>@<version range> +. +.fi +. +.SH "DESCRIPTION" +This command installs a package, and any packages that it depends on. It +resolves circular dependencies by talking to the npm registry. +. +.TP +npm install \fItarball file\fR +Install a package that is sitting on the filesystem. Note: if you just want +to link a dev directory into your npm root, you can do this more easily by +using \fBnpm link\fR. +. +.IP +In order to distinguish between this and remote installs, the argument +must start with either "file:", ".", or "/" +. +.P + Example: +. +.IP "" 4 +. +.nf + npm install ./package.tgz +. +.fi +. +.IP "" 0 +. +.TP +npm install \fItarball url\fR +Fetch the tarball url, and then install it. In order to distinguish between +this and other options, the argument must start with "http://" or "https://" +. +.IP +Example: +. +.IP + npm install http://github.com/waveto/node\-crypto/tarball/v0.0.5 +. +.TP +npm install \fIpkg\fR +Do a \fIpkg\fR@\fItag\fR install, where \fItag\fR is the "tag" config from either your +.npmrc file, or the \-\-tag argument on the command line. +. +.IP +Example: +. +.IP + npm install sax +. +.TP +npm install \fIpkg\fR@\fItag\fR +Install the version of the package that is referenced by the specified tag. +If the tag does not exist in the registry data for that package, then this +will fail. +. +.IP +Example: +. +.IP + npm install sax@stable +. +.TP +npm install \fIpkg\fR@\fIversion\fR +Install the specified version of the package. This will fail if the version +has not been published to the registry. +. +.IP +Example: +. +.IP + npm install sax@0.1.1 +. +.TP +npm install \fIpkg\fR@\fIversion range\fR +Install a version of the package matching the specified version range. This +will follow the same rules for resolving dependencies described in \fBnpm help json\fR. +. +.IP +Note that most version ranges must be put in quotes so that your shell will +treat it as a single argument. +. +.P + Example: +. +.IP "" 4 +. +.nf + npm install sax@">=0.1.0 <0.2.0" +. +.fi +. +.IP "" 0 +. +.P +You may combine multiple arguments, and even multiple types of arguments. For example: +. +.IP "" 4 +. +.nf +npm install sax@">=0.1.0 <0.2.0" bench supervisor +. +.fi +. +.IP "" 0 +. +.P +The \fB\-\-tag\fR argument will apply to all of the specified install targets. +. +.SH "SEE ALSO" +. +.IP "\(bu" 4 +npm\-build(1) +. +.IP "\(bu" 4 +npm\-registry(1) +. +.IP "\(bu" 4 +npm\-build(1) +. +.IP "\(bu" 4 +npm\-link(1) +. +.IP "\(bu" 4 +npm\-folders(1) +. +.IP "\(bu" 4 +npm\-tag(1) +. +.IP "" 0 |