From 549be1caa84b4746a3697943bf4b19acb6430cc2 Mon Sep 17 00:00:00 2001 From: Sam Roberts Date: Wed, 15 Jan 2014 17:12:20 -0800 Subject: doc: child_process.execFile arguments are optional --- doc/api/child_process.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'doc/api') diff --git a/doc/api/child_process.markdown b/doc/api/child_process.markdown index 7f5958f54..e15ac02ec 100644 --- a/doc/api/child_process.markdown +++ b/doc/api/child_process.markdown @@ -531,7 +531,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 -- cgit v1.2.1 From 198ed0bd0da9dee471bb8bfb7f6e97be506224ed Mon Sep 17 00:00:00 2001 From: Sam Roberts Date: Wed, 15 Jan 2014 17:13:32 -0800 Subject: doc: describe child_process.fork() silent option --- doc/api/child_process.markdown | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) (limited to 'doc/api') diff --git a/doc/api/child_process.markdown b/doc/api/child_process.markdown index e15ac02ec..9c7125c62 100644 --- a/doc/api/child_process.markdown +++ b/doc/api/child_process.markdown @@ -564,8 +564,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 -- cgit v1.2.1 From abe02553f22e80681b8c623c2b0dd20a9952aaae Mon Sep 17 00:00:00 2001 From: Sam Roberts Date: Wed, 15 Jan 2014 14:40:58 -0800 Subject: doc: clarify Windows signal sending emulation --- doc/api/process.markdown | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) (limited to 'doc/api') 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. -- cgit v1.2.1