npm: Upgrade to 1.3.17
[platform/upstream/nodejs.git] / deps / npm / man / man3 / npm-run-script.3
1 .\" Generated with Ronnjs 0.3.8
2 .\" http://github.com/kapouer/ronnjs/
3 .
4 .TH "NPM\-RUN\-SCRIPT" "3" "December 2013" "" ""
5 .
6 .SH "NAME"
7 \fBnpm-run-script\fR \-\- Run arbitrary package scripts
8 .
9 .SH "SYNOPSIS"
10 .
11 .nf
12 npm\.commands\.run\-script(args, callback)
13 .
14 .fi
15 .
16 .SH "DESCRIPTION"
17 This runs an arbitrary command from a package\'s "scripts" object\.
18 .
19 .P
20 It is used by the test, start, restart, and stop commands, but can be
21 called directly, as well\.
22 .
23 .P
24 The \'args\' parameter is an array of strings\. Behavior depends on the number
25 of elements\.  If there is only one element, npm assumes that the element
26 represents a command to be run on the local repository\. If there is more than
27 one element, then the first is assumed to be the package and the second is
28 assumed to be the command to run\. All other elements are ignored\.
29 .
30 .SH "SEE ALSO"
31 .
32 .IP "\(bu" 4
33 npm help  scripts
34 .
35 .IP "\(bu" 4
36 npm apihelp test
37 .
38 .IP "\(bu" 4
39 npm apihelp start
40 .
41 .IP "\(bu" 4
42 npm apihelp restart
43 .
44 .IP "\(bu" 4
45 npm apihelp stop
46 .
47 .IP "" 0
48