summaryrefslogtreecommitdiff
path: root/deps/npm/man/man1/scripts.1
diff options
context:
space:
mode:
Diffstat (limited to 'deps/npm/man/man1/scripts.1')
-rw-r--r--deps/npm/man/man1/scripts.122
1 files changed, 21 insertions, 1 deletions
diff --git a/deps/npm/man/man1/scripts.1 b/deps/npm/man/man1/scripts.1
index ff949bade..5216862aa 100644
--- a/deps/npm/man/man1/scripts.1
+++ b/deps/npm/man/man1/scripts.1
@@ -1,7 +1,7 @@
.\" Generated with Ronnjs/v0.1
.\" http://github.com/kapouer/ronnjs/
.
-.TH "NPM\-SCRIPTS" "1" "January 2012" "" ""
+.TH "NPM\-SCRIPTS" "1" "May 2012" "" ""
.
.SH "NAME"
\fBnpm-scripts\fR \-\- How npm handles the "scripts" field
@@ -94,6 +94,26 @@ Package scripts run in an environment where many pieces of information are
made available regarding the setup of npm and the current state of the
process\.
.
+.SS "path"
+If you depend on modules that define executable scripts, like test suites,
+then those executables will be added to the \fBPATH\fR for executing the scripts\.
+So, if your package\.json has this:
+.
+.IP "" 4
+.
+.nf
+{ "name" : "foo"
+, "dependencies" : { "bar" : "0\.1\.x" }
+, "scripts": { "start" : "bar \./test" } }
+.
+.fi
+.
+.IP "" 0
+.
+.P
+then you could run \fBnpm start\fR to execute the \fBbar\fR script, which is exported
+into the \fBnode_modules/\.bin\fR directory on \fBnpm install\fR\|\.
+.
.SS "package\.json vars"
The package\.json fields are tacked onto the \fBnpm_package_\fR prefix\. So, for
instance, if you had \fB{"name":"foo", "version":"1\.2\.5"}\fR in your package\.json