Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/npm/cli.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
path: root/man1
diff options
context:
space:
mode:
authorisaacs <i@izs.me>2011-01-07 03:51:44 +0300
committerisaacs <i@izs.me>2011-01-07 03:51:44 +0300
commitd64bdba1e89f251fe8ce4617b02e389a7bcb2403 (patch)
treec769cdc206e3f1ee75febe61cd9051a0dfc7dfbb /man1
parent2be2aa6f3c1da0ebcbe998e8c329e88a4013e124 (diff)
make doc
Diffstat (limited to 'man1')
-rw-r--r--man1/bundle.124
-rw-r--r--man1/changelog.121
-rw-r--r--man1/json.176
3 files changed, 120 insertions, 1 deletions
diff --git a/man1/bundle.1 b/man1/bundle.1
index 50530599a..54268309d 100644
--- a/man1/bundle.1
+++ b/man1/bundle.1
@@ -56,3 +56,27 @@ 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/changelog.1 b/man1/changelog.1
index d58725e7e..d3fad3853 100644
--- a/man1/changelog.1
+++ b/man1/changelog.1
@@ -1,7 +1,7 @@
.\" Generated with Ronnjs/v0.1
.\" http://github.com/kapouer/ronnjs/
.
-.TH "NPM\-CHANGELOG" "1" "December 2010" "" ""
+.TH "NPM\-CHANGELOG" "1" "January 2011" "" ""
.
.SH "NAME"
\fBnpm-changelog\fR \-\- Changes
@@ -478,5 +478,24 @@ Portability and stability fixes\.
.br
Mostly sort of works with Homebrew\-installed nodejs\.
.
+.IP "\(bu" 4
+0\.2\.14:
+A little bit of documentation overhaul\.
+.
+.br
+Support for \fB"<name>":"<url>"\fR for dependencies\.
+.
+.br
+Fix for "unpublish" regression\.
+.
+.br
+Support for "files" array\.
+.
+.br
+Dependency info in lifecycle scripts\.
+.
+.br
+More data validation\.
+.
.IP "" 0
diff --git a/man1/json.1 b/man1/json.1
index 2142c2b57..38a897ec4 100644
--- a/man1/json.1
+++ b/man1/json.1
@@ -452,6 +452,15 @@ is a semver compatible version identifier\.
\fB<=version\fR
.
.IP "\(bu" 4
+\fB~version\fR See \'Tilde Version Ranges\' below
+.
+.IP "\(bu" 4
+\fB1\.2\.x\fR See \'X Version Ranges\' below
+.
+.IP "\(bu" 4
+\fBhttp://\.\.\.\fR See \'URLs as Dependencies\' below
+.
+.IP "\(bu" 4
\fB*\fR Matches any version
.
.IP "\(bu" 4
@@ -477,6 +486,11 @@ For example, these are all valid:
, "baz" : ">1\.0\.2 <=2\.3\.4"
, "boo" : "2\.0\.1"
, "qux" : "<1\.0\.0 || >=2\.3\.1 <2\.4\.5 || >=2\.5\.2 <3\.0\.0"
+ , "asd" : "http://asdf\.com/asdf\.tar\.gz"
+ , "til" : "~1\.2"
+ , "elf" : "~1\.2\.3"
+ , "two" : "2\.x"
+ , "thr" : "3\.3\.x"
}
}
.
@@ -484,6 +498,68 @@ For example, these are all valid:
.
.IP "" 0
.
+.SS "Tilde Version Ranges"
+A range specifier starting with a tilde \fB~\fR character is matched against
+a version in the following fashion\.
+.
+.IP "\(bu" 4
+The version must be at least as high as the range\.
+.
+.IP "\(bu" 4
+The version must be less than the next major revision above the range\.
+.
+.IP "" 0
+.
+.P
+For example, the following are equivalent:
+.
+.IP "\(bu" 4
+\fB"~1\.2\.3" = ">=1\.2\.3 <1\.3\.0"\fR
+.
+.IP "\(bu" 4
+\fB"~1\.2" = ">=1\.2\.0 <2\.0\.0"\fR
+.
+.IP "\(bu" 4
+\fB"~1" = ">=1\.0\.0 <2\.0\.0"\fR
+.
+.IP "" 0
+.
+.SS "X Version Ranges"
+An "x" in a version range specifies that the version number must start
+with the supplied digits, but any digit may be used in place of the x\.
+.
+.P
+The following are equivalent:
+.
+.IP "\(bu" 4
+\fB"1\.2\.x" = ">=1\.2\.0 <1\.3\.0"\fR
+.
+.IP "\(bu" 4
+\fB"1\.x\.x" = ">=1\.0\.0 <2\.0\.0"\fR
+.
+.IP "\(bu" 4
+\fB"1\.2" = "1\.2\.x"\fR
+.
+.IP "\(bu" 4
+\fB"1\.x" = "1\.x\.x"\fR
+.
+.IP "\(bu" 4
+\fB"1" = "1\.x\.x"\fR
+.
+.IP "" 0
+.
+.P
+You may not supply a comparator with a version containing an x\. Any
+digits after the first "x" are ignored\.
+.
+.SS "URLs as Dependencies"
+Starting with npm version 0\.2\.14, you may specify a tarball URL in place
+of a version range\.
+.
+.P
+This tarball will be downloaded and installed as a bundle at install
+time\. See \fBnpm help bundle\fR
+.
.SH "engines"
Packages/1\.0 says that you can have an "engines" field with an array of engine
names\. However, it has no provision for specifying which version of the engine