diff options
author | isaacs <i@izs.me> | 2010-08-25 23:29:39 +0400 |
---|---|---|
committer | isaacs <i@izs.me> | 2010-08-26 05:01:23 +0400 |
commit | 61a328a5952fbcca420461d3978b020e4b2878de (patch) | |
tree | 59e634608a4047ef574d9883bc52e4be55e12a2d | |
parent | 7e9a81b51cc437d6199b51150abde48212bc497b (diff) |
Docs for rebuild.
-rw-r--r-- | doc/rebuild.md | 21 | ||||
-rw-r--r-- | man/rebuild.1 | 34 |
2 files changed, 55 insertions, 0 deletions
diff --git a/doc/rebuild.md b/doc/rebuild.md new file mode 100644 index 000000000..c017e7484 --- /dev/null +++ b/doc/rebuild.md @@ -0,0 +1,21 @@ +npm-rebuild(1) -- Rebuild a package +=================================== + +## SYNOPSIS + + npm rebuild [<name>[@<version>] [name[@<version>] ...]] + +* `<name>`: + The package to rebuild +* `<version>`: + The version range to rebuild. Any matching installed packages are rebuilt. + +## DESCRIPTION + +This command runs the `npm build` command on the matched folders. This is useful +when you install a new version of node, and must recompile all your C++ addons with +the new binary. + +Regardless of the configuration settings, rebuild always sets `update-dependents` +and `auto-activate` to false, to minimize unexpected side effects. It does not +change any state outside of the package's folder. diff --git a/man/rebuild.1 b/man/rebuild.1 new file mode 100644 index 000000000..244a31d78 --- /dev/null +++ b/man/rebuild.1 @@ -0,0 +1,34 @@ +.\" Generated with Ronnjs/v0.1 +.\" http://github.com/kapouer/ronnjs/ +. +.TH "NPM\-REBUILD" "1" "August 2010" "" "" +. +.SH "NAME" +\fBnpm-rebuild\fR \-\- Rebuild a package +. +.SH "SYNOPSIS" +. +.nf +npm rebuild [<name>[@<version>] [name[@<version>] \.\.\.]] +. +.fi +. +.IP "\(bu" 4 +\fB<name>\fR: +The package to rebuild +. +.IP "\(bu" 4 +\fB<version>\fR: +The version range to rebuild\. Any matching installed packages are rebuilt\. +. +.IP "" 0 +. +.SH "DESCRIPTION" +This command runs the \fBnpm build\fR command on the matched folders\. This is useful +when you install a new version of node, and must recompile all your C++ addons with +the new binary\. +. +.P +Regardless of the configuration settings, rebuild always sets \fBupdate\-dependents\fR +and \fBauto\-activate\fR to false, to minimize unexpected side effects\. It does not +change any state outside of the package\'s folder\. |