aboutsummaryrefslogtreecommitdiff
path: root/node_modules/spawn-wrap/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/spawn-wrap/README.md')
-rw-r--r--node_modules/spawn-wrap/README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/node_modules/spawn-wrap/README.md b/node_modules/spawn-wrap/README.md
index 0cac17fa5..428df37e5 100644
--- a/node_modules/spawn-wrap/README.md
+++ b/node_modules/spawn-wrap/README.md
@@ -52,6 +52,20 @@ process.on('exit', function (code) {
require('spawn-wrap').runMain()
```
+## ENVIRONMENT VARIABLES
+
+Spawn-wrap responds to two environment variables, both of which are
+preserved through child processes.
+
+`SPAWN_WRAP_DEBUG=1` in the environment will make this module dump a
+lot of information to stderr.
+
+`SPAWN_WRAP_SHIM_ROOT` can be set to a path on the filesystem where
+the shim files are written in a `.node-spawn-wrap-<id>` folder. By
+default this is done in `$HOME`, but in some environments you may wish
+to point it at some other root. (For example, if `$HOME` is mounted
+as read-only in a virtual machine or container.)
+
## CONTRACTS and CAVEATS
The initial wrap call uses synchronous I/O. Probably you should not