diff options
| author | isaacs <i@izs.me> | 2010-12-23 23:17:43 +0300 |
|---|---|---|
| committer | isaacs <i@izs.me> | 2010-12-23 23:18:45 +0300 |
| commit | 0181973c9fe894840db8c058d7b56fb4dec687ec (patch) | |
| tree | 80578640d12a5caa74d4136a8929addd7666470b | |
| parent | 205296a804bee6519fa2273ac0ea722f7d104450 (diff) | |
Add docs for run-script command.
| -rw-r--r-- | doc/run-script.md | 23 | ||||
| -rw-r--r-- | man1/run-script.1 | 44 | ||||
| -rw-r--r-- | man1/test.1 | 2 |
3 files changed, 68 insertions, 1 deletions
diff --git a/doc/run-script.md b/doc/run-script.md new file mode 100644 index 000000000..75cce6992 --- /dev/null +++ b/doc/run-script.md @@ -0,0 +1,23 @@ +npm-run-script(1) -- Run arbitrary package scripts +================================================== + +## SYNOPSIS + + npm run-script <script> <name>[@<version>] [<name>[@<version] ...] + +## DESCRIPTION + +This runs an arbitrary command from a package's "scripts" object. + +If no version is provided then it uses the active version. + +It is used by the test, start, restart, and stop commands, but can be +called directly, as well. + +## SEE ALSO + +* npm-scripts(1) +* npm-test(1) +* npm-start(1) +* npm-restart(1) +* npm-stop(1) diff --git a/man1/run-script.1 b/man1/run-script.1 new file mode 100644 index 000000000..1ea355e7e --- /dev/null +++ b/man1/run-script.1 @@ -0,0 +1,44 @@ +.\" Generated with Ronnjs/v0.1 +.\" http://github.com/kapouer/ronnjs/ +. +.TH "NPM\-RUN\-SCRIPT" "1" "December 2010" "" "" +. +.SH "NAME" +\fBnpm-run-script\fR \-\- Run arbitrary package scripts +. +.SH "SYNOPSIS" +. +.nf +npm run\-script <script> <name>[@<version>] [<name>[@<version] \.\.\.] +. +.fi +. +.SH "DESCRIPTION" +This runs an arbitrary command from a package\'s "scripts" object\. +. +.P +If no version is provided then it uses the active version\. +. +.P +It is used by the test, start, restart, and stop commands, but can be +called directly, as well\. +. +.SH "SEE ALSO" +. +.IP "\(bu" 4 +npm\-scripts(1) +. +.IP "\(bu" 4 +npm\-test(1) +. +.IP "\(bu" 4 +npm\-start(1) +. +.IP "\(bu" 4 +npm\-restart(1) +. +.IP "\(bu" 4 +npm\-stop(1) +. +.IP "" 0 + diff --git a/man1/test.1 b/man1/test.1 index a376652cb..f18187831 100644 --- a/man1/test.1 +++ b/man1/test.1 @@ -1,7 +1,7 @@ .\" Generated with Ronnjs/v0.1 .\" http://github.com/kapouer/ronnjs/ . -.TH "NPM\-TEST" "1" "November 2010" "" "" +.TH "NPM\-TEST" "1" "December 2010" "" "" . .SH "NAME" \fBnpm-test\fR \-\- Test a package |