diff options
author | isaacs <i@izs.me> | 2010-05-11 22:39:51 +0400 |
---|---|---|
committer | isaacs <i@izs.me> | 2010-05-11 22:49:50 +0400 |
commit | 33727a19e3a155fdf18a3a557a4b17566188c82f (patch) | |
tree | 3d10c7bc6683cbea5615d53dec1c436132a75573 | |
parent | 539faf3fe40c2315bed8ab17bf816fe81255f22b (diff) |
Add docs for test, stop, start, and restart commands. Bump version.v0.1.8
-rw-r--r-- | doc/npm.md | 5 | ||||
-rw-r--r-- | doc/restart.md | 24 | ||||
-rw-r--r-- | doc/start.md | 12 | ||||
-rw-r--r-- | doc/stop.md | 12 | ||||
-rw-r--r-- | doc/test.md | 12 | ||||
-rw-r--r-- | man/npm.1 | 5 | ||||
-rw-r--r-- | man/restart.1 | 44 | ||||
-rw-r--r-- | man/start.1 | 20 | ||||
-rw-r--r-- | man/stop.1 | 20 | ||||
-rw-r--r-- | man/test.1 | 20 | ||||
-rw-r--r-- | package.json | 2 |
11 files changed, 175 insertions, 1 deletions
diff --git a/doc/npm.md b/doc/npm.md index 9bc2188b0..f9cfc18b3 100644 --- a/doc/npm.md +++ b/doc/npm.md @@ -139,6 +139,11 @@ See <http://github.com/isaacs/npm/issues> for current todo list. Don't break on install if the man path is missing Support publishing or installing a folder or local tarball +* 0.1.8: + Bugfixes + Add start, stop, restart, and test commands + + ## SEE ALSO npm-help(1) diff --git a/doc/restart.md b/doc/restart.md new file mode 100644 index 000000000..ca1ad45c1 --- /dev/null +++ b/doc/restart.md @@ -0,0 +1,24 @@ +npm-restart(1) -- Start a package +================================= + +## SYNOPSIS + + npm restart <name> [<version>] + +## DESCRIPTION + +This runs a package's "stop" script, if one was provided, and then +the "start" script. + +If no version is specified, then it restarts the "active" version. + +This is identical to doing: + + npm stop <name> + npm start <name> + +## SEE ALSO + +* npm-start(1) +* npm-stop + diff --git a/doc/start.md b/doc/start.md new file mode 100644 index 000000000..d803d5d73 --- /dev/null +++ b/doc/start.md @@ -0,0 +1,12 @@ +npm-start(1) -- Start a package +=============================== + +## SYNOPSIS + + npm start <name> [<version>] + +## DESCRIPTION + +This runs a package's "start" script, if one was provided. + +If no version is specified, then it starts the "active" version. diff --git a/doc/stop.md b/doc/stop.md new file mode 100644 index 000000000..4d1799a73 --- /dev/null +++ b/doc/stop.md @@ -0,0 +1,12 @@ +npm-stop(1) -- Stop a package +============================= + +## SYNOPSIS + + npm stop <name> [<version>] + +## DESCRIPTION + +This runs a package's "stop" script, if one was provided. + +If no version is specified, then it stops the "active" version. diff --git a/doc/test.md b/doc/test.md new file mode 100644 index 000000000..03c2d9400 --- /dev/null +++ b/doc/test.md @@ -0,0 +1,12 @@ +npm-test(1) -- Test a package +============================= + +## SYNOPSIS + + npm test <name> [<version>] + +## DESCRIPTION + +This runs a package's "test" script, if one was provided. + +If no version is specified, then it tests the "active" version. @@ -226,6 +226,11 @@ Handle odd require.paths more appropriately Don't break on install if the man path is missing Support publishing or installing a folder or local tarball . +.TP +0.1.8 +Bugfixes +Add start, stop, restart, and test commands +. .SH "SEE ALSO" npm\-help(1) . diff --git a/man/restart.1 b/man/restart.1 new file mode 100644 index 000000000..eaf3c018b --- /dev/null +++ b/man/restart.1 @@ -0,0 +1,44 @@ +.\" generated with Ronn/v0.4.1 +.\" http://github.com/rtomayko/ronn/ +. +.TH "NPM\-RESTART" "1" "May 2010" "" "" +. +.SH "NAME" +\fBnpm\-restart\fR \-\- Start a package +. +.SH "SYNOPSIS" +. +.nf +npm restart <name> [<version>] +. +.fi +. +.SH "DESCRIPTION" +This runs a package's "stop" script, if one was provided, and then +the "start" script. +. +.P +If no version is specified, then it restarts the "active" version. +. +.P +This is identical to doing: +. +.IP "" 4 +. +.nf +npm stop <name> +npm start <name> +. +.fi +. +.IP "" 0 +. +.SH "SEE ALSO" +. +.IP "\(bu" 4 +npm\-start(1) +. +.IP "\(bu" 4 +npm\-stop +. +.IP "" 0 diff --git a/man/start.1 b/man/start.1 new file mode 100644 index 000000000..3d42844f1 --- /dev/null +++ b/man/start.1 @@ -0,0 +1,20 @@ +.\" generated with Ronn/v0.4.1 +.\" http://github.com/rtomayko/ronn/ +. +.TH "NPM\-START" "1" "May 2010" "" "" +. +.SH "NAME" +\fBnpm\-start\fR \-\- Start a package +. +.SH "SYNOPSIS" +. +.nf +npm start <name> [<version>] +. +.fi +. +.SH "DESCRIPTION" +This runs a package's "start" script, if one was provided. +. +.P +If no version is specified, then it starts the "active" version. diff --git a/man/stop.1 b/man/stop.1 new file mode 100644 index 000000000..9a02773dd --- /dev/null +++ b/man/stop.1 @@ -0,0 +1,20 @@ +.\" generated with Ronn/v0.4.1 +.\" http://github.com/rtomayko/ronn/ +. +.TH "NPM\-STOP" "1" "May 2010" "" "" +. +.SH "NAME" +\fBnpm\-stop\fR \-\- Stop a package +. +.SH "SYNOPSIS" +. +.nf +npm stop <name> [<version>] +. +.fi +. +.SH "DESCRIPTION" +This runs a package's "stop" script, if one was provided. +. +.P +If no version is specified, then it stops the "active" version. diff --git a/man/test.1 b/man/test.1 new file mode 100644 index 000000000..46bb2f09d --- /dev/null +++ b/man/test.1 @@ -0,0 +1,20 @@ +.\" generated with Ronn/v0.4.1 +.\" http://github.com/rtomayko/ronn/ +. +.TH "NPM\-TEST" "1" "May 2010" "" "" +. +.SH "NAME" +\fBnpm\-test\fR \-\- Test a package +. +.SH "SYNOPSIS" +. +.nf +npm test <name> [<version>] +. +.fi +. +.SH "DESCRIPTION" +This runs a package's "test" script, if one was provided. +. +.P +If no version is specified, then it tests the "active" version. diff --git a/package.json b/package.json index 598465ebb..f270143c7 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name" : "npm" , "description" : "A package manager for node" -, "version" : "0.1.7" +, "version" : "0.1.8" , "author" : "Isaac Z. Schlueter <i@izs.me>" , "contributors" : [ "Mikeal Rogers <mikeal.rogers@gmail.com>" ] , "repository" : |