diff options
author | Ben Noordhuis <info@bnoordhuis.nl> | 2013-09-19 12:27:06 +0200 |
---|---|---|
committer | Ben Noordhuis <info@bnoordhuis.nl> | 2013-09-19 12:31:52 +0200 |
commit | 7c554a5cd0f1420e5017ef57252b3d3c6496cea0 (patch) | |
tree | 8056bfbba73f2c5f659bbe24ea54b0e114897310 /doc/api | |
parent | 5bda2bed37526f5da9c27decd8968b0a2710dbeb (diff) | |
download | node-7c554a5cd0f1420e5017ef57252b3d3c6496cea0.tar.gz |
doc: document reserved status of SIGUSR1
Fixes #1212.
Diffstat (limited to 'doc/api')
-rw-r--r-- | doc/api/process.markdown | 10 |
1 files changed, 7 insertions, 3 deletions
diff --git a/doc/api/process.markdown b/doc/api/process.markdown index 802f24722..025b552ad 100644 --- a/doc/api/process.markdown +++ b/doc/api/process.markdown @@ -60,10 +60,10 @@ You have been warned. ## Signal Events <!--type=event--> -<!--name=SIGINT, SIGUSR1, etc.--> +<!--name=SIGINT, SIGHUP, etc.--> Emitted when the processes receives a signal. See sigaction(2) for a list of -standard POSIX signal names such as SIGINT, SIGUSR1, etc. +standard POSIX signal names such as SIGINT, SIGHUP, etc. Example of listening for `SIGINT`: @@ -77,6 +77,8 @@ Example of listening for `SIGINT`: An easy way to send the `SIGINT` signal is with `Control-C` in most terminal programs. +Note: SIGUSR1 is reserved by node.js to kickstart the debugger. It's possible +to install a listener but that won't stop the debugger from starting. ## process.stdout @@ -391,7 +393,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 'SIGUSR1'. If omitted, the signal will be 'SIGTERM'. +'SIGINT' or 'SIGHUP'. If omitted, the signal will be 'SIGTERM'. See kill(2) for more information. Note that just because the name of this function is `process.kill`, it is @@ -411,6 +413,8 @@ Example of sending a signal to yourself: process.kill(process.pid, 'SIGHUP'); +Note: SIGUSR1 is reserved by node.js. It can be used to kickstart the +debugger. ## process.pid |