summaryrefslogtreecommitdiff
path: root/doc/api
diff options
context:
space:
mode:
authorTimothy J Fontaine <tjfontaine@gmail.com>2014-01-22 08:42:05 -0800
committerTimothy J Fontaine <tjfontaine@gmail.com>2014-01-22 08:42:05 -0800
commitfdc3cc9d7a2d1e12c74fc0c0939d22f40e58b52b (patch)
tree0e73ef7de9054f7d9b2fe90a5aec9ad072716865 /doc/api
parent6514a4128c3e7aa6c1bb1c6f3f018412fa76e5d9 (diff)
parent25f9e92813eda927c3d3eaa56dab3a397afadebe (diff)
downloadnode-merge-test.tar.gz
Merge remote-tracking branch 'upstream/v0.10'merge-test
Conflicts: node.gyp
Diffstat (limited to 'doc/api')
-rw-r--r--doc/api/child_process.markdown8
-rw-r--r--doc/api/process.markdown14
2 files changed, 15 insertions, 7 deletions
diff --git a/doc/api/child_process.markdown b/doc/api/child_process.markdown
index 6a11edebb..0f0e463b5 100644
--- a/doc/api/child_process.markdown
+++ b/doc/api/child_process.markdown
@@ -535,7 +535,7 @@ amount of data allowed on stdout or stderr - if this value is exceeded then
the child process is killed.
-## child_process.execFile(file, args, options, callback)
+## child_process.execFile(file, [args], [options], [callback])
* `file` {String} The filename of the program to run
* `args` {Array} List of string arguments
@@ -568,8 +568,10 @@ leaner than `child_process.exec`. It has the same options.
* `execPath` {String} Executable used to create the child process
* `execArgv` {Array} List of string arguments passed to the executable
(Default: `process.execArgv`)
- * `silent` {Boolean} If true, prevent stdout and stderr in the spawned node
- process from being associated with the parent's (default is false)
+ * `silent` {Boolean} If true, stdin, stdout, and stderr of the child will be
+ piped to the parent, otherwise they will be inherited from the parent, see
+ the "pipe" and "inherit" options for `spawn()`'s `stdio` for more details
+ (default is false)
* Return: ChildProcess object
This is a special case of the `spawn()` functionality for spawning Node
diff --git a/doc/api/process.markdown b/doc/api/process.markdown
index c68b5f9d5..18cdb5a8d 100644
--- a/doc/api/process.markdown
+++ b/doc/api/process.markdown
@@ -140,9 +140,9 @@ Note:
`SIGHUP` is to terminate node, but once a listener has been installed its
default behaviour will be removed.
- `SIGTERM` is not supported on Windows, it can be listened on.
-- `SIGINT` is supported on all platforms, and can usually be generated with
- `CTRL+C` (though this may be configurable). It is not generated when terminal
- raw mode is enabled.
+- `SIGINT` from the terminal is supported on all platforms, and can usually be
+ generated with `CTRL+C` (though this may be configurable). It is not generated
+ when terminal raw mode is enabled.
- `SIGBREAK` is delivered on Windows when `CTRL+BREAK` is pressed, on non-Windows
platforms it can be listened on, but there is no way to send or generate it.
- `SIGWINCH` is delivered when the console has been resized. On Windows, this will
@@ -152,6 +152,12 @@ Note:
node on all platforms.
- `SIGSTOP` cannot have a listener installed.
+Note that Windows does not support sending Signals, but node offers some
+emulation with `process.kill()`, and `child_process.kill()`:
+- Sending signal `0` can be used to search for the existence of a process
+- Sending `SIGINT`, `SIGTERM`, and `SIGKILL` cause the unconditional exit of the
+ target process.
+
## process.stdout
A `Writable Stream` to `stdout`.
@@ -483,7 +489,7 @@ An example of the possible output looks like:
Send a signal to a process. `pid` is the process id and `signal` is the
string describing the signal to send. Signal names are strings like
'SIGINT' or 'SIGHUP'. If omitted, the signal will be 'SIGTERM'.
-See kill(2) for more information.
+See [Signal Events](#process_signal_events) and kill(2) for more information.
Will throw an error if target does not exist, and as a special case, a signal of
`0` can be used to test for the existence of a process.