diff options
| -rw-r--r-- | doc/api/child_process.md | 13 |
1 files changed, 12 insertions, 1 deletions
diff --git a/doc/api/child_process.md b/doc/api/child_process.md index 8d6c787488..816b37b250 100644 --- a/doc/api/child_process.md +++ b/doc/api/child_process.md @@ -148,7 +148,18 @@ added: v0.1.90 * Returns: {ChildProcess} Spawns a shell then executes the `command` within that shell, buffering any -generated output. +generated output. The `command` string passed to the exec function is processed +directly by the shell and special characters (vary based on +[shell](https://en.wikipedia.org/wiki/List_of_command-line_interpreters)) +need to be dealt with accordingly: +```js +exec('"/path/to/test file/test.sh" arg1 arg2'); +//Double quotes are used so that the space in the path is not interpreted as +//multiple arguments + +exec('echo "The \\$HOME variable is $HOME"'); +//The $HOME variable is escaped in the first instance, but not in the second +``` **Note: Never pass unsanitised user input to this function. Any input containing shell metacharacters may be used to trigger arbitrary command |