diff options
author | isaacs <i@izs.me> | 2010-11-25 01:50:43 +0300 |
---|---|---|
committer | isaacs <i@izs.me> | 2010-11-25 01:50:43 +0300 |
commit | c1791f4e8fb5ec10c28a99c1094ac16e0ef49b0e (patch) | |
tree | 33408a0eb5546a53f704f9f8c44241c8ef9b27dc /man1 | |
parent | b1e014eaa6ddce148c810d4703192be051ad8351 (diff) |
make doc
Diffstat (limited to 'man1')
-rw-r--r-- | man1/bundle.1 | 3 | ||||
-rw-r--r-- | man1/config.1 | 15 | ||||
-rw-r--r-- | man1/list.1 | 16 | ||||
-rw-r--r-- | man1/ls.1 | 16 | ||||
-rw-r--r-- | man1/version.1 | 22 |
5 files changed, 71 insertions, 1 deletions
diff --git a/man1/bundle.1 b/man1/bundle.1 index c68f6be1c..eaa988365 100644 --- a/man1/bundle.1 +++ b/man1/bundle.1 @@ -38,7 +38,8 @@ 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 list the packages in the bundle, do \fBnpm bundle ls\fR\|\. To remove bundled +packages, do \fBnpm bundle remove <whatever>\fR\|\. Et cetera\. . .P In this way, a command like \fBnpm bundle install http://github\.com/user/project/tarball/master\fR can be used diff --git a/man1/config.1 b/man1/config.1 index 59b792d02..a65f96e61 100644 --- a/man1/config.1 +++ b/man1/config.1 @@ -394,3 +394,18 @@ Default: env\.EDITOR . .P The program to use to edit files\. +. +.SS "listopts" +Default: "" +. +.P +A whitespace\-separated list of extra args that are always passed to npm ls +. +.P +For example: \fBlistopts = remote\fR +. +.P +\fBnpm ls\fR +. +.P +The output here will always filter by remote diff --git a/man1/list.1 b/man1/list.1 index 4de8d6b50..25de4441e 100644 --- a/man1/list.1 +++ b/man1/list.1 @@ -50,3 +50,19 @@ npm ls installed Strings are matched using the JavaScript "split" function, so regular expression strings are ok\. However, the highlighting is a simple split/join, so regexps probably won\'t get the funky colors\. +. +.P +You can also provide default arguments that are appended to all npm ls +executions +. +.IP "" 4 +. +.nf +npm config set listopts remote +. +.fi +. +.IP "" 0 +. +.P +This will append the remote argument each time \fBnpm ls\fR is called\. @@ -50,3 +50,19 @@ npm ls installed Strings are matched using the JavaScript "split" function, so regular expression strings are ok\. However, the highlighting is a simple split/join, so regexps probably won\'t get the funky colors\. +. +.P +You can also provide default arguments that are appended to all npm ls +executions +. +.IP "" 4 +. +.nf +npm config set listopts remote +. +.fi +. +.IP "" 0 +. +.P +This will append the remote argument each time \fBnpm ls\fR is called\. diff --git a/man1/version.1 b/man1/version.1 new file mode 100644 index 000000000..f418800d2 --- /dev/null +++ b/man1/version.1 @@ -0,0 +1,22 @@ +.\" Generated with Ronnjs/v0.1 +.\" http://github.com/kapouer/ronnjs/ +. +.TH "NPM\-VERSION" "1" "November 2010" "" "" +. +.SH "NAME" +\fBnpm-version\fR \-\- Bump a package version +. +.SH "SYNOPSIS" +. +.nf +npm version <newversion> +. +.fi +. +.SH "DESCRIPTION" +Run this in a package directory to bump the version and write the new +data back to the package\.json file\. +. +.P +If run in a git repo, it will also create a version commit and tag, and +fail if the repo is not clean\. |