diff options
| author | Sam Roberts <sam@strongloop.com> | 2014-01-15 14:40:58 -0800 |
|---|---|---|
| committer | Timothy J Fontaine <tjfontaine@gmail.com> | 2014-01-16 08:41:04 -0800 |
| commit | abe02553f22e80681b8c623c2b0dd20a9952aaae (patch) | |
| tree | 87666ea52377c75eba7913453c36391a445ada4e | |
| parent | 67e9298fb6509d5f6ad2f7e67620a2d82549a1e8 (diff) | |
| download | node-abe02553f22e80681b8c623c2b0dd20a9952aaae.tar.gz | |
doc: clarify Windows signal sending emulation
| -rw-r--r-- | doc/api/process.markdown | 14 |
1 files changed, 10 insertions, 4 deletions
diff --git a/doc/api/process.markdown b/doc/api/process.markdown index b2f43ded7..8cb613525 100644 --- a/doc/api/process.markdown +++ b/doc/api/process.markdown @@ -96,9 +96,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 @@ -108,6 +108,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`. @@ -422,7 +428,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. |