Skip to content

doc: fixes default shell in child_process.md #14203

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
henryzxu wants to merge 7 commits into from
Closed

doc: fixes default shell in child_process.md #14203

Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
1a07c2a
doc: fixes default shell in child_process.md
henryzxu Jul 12, 2017
e9089d3
doc: fixes default shell in child_process.md
henryzxu Jul 12, 2017
a6a073c
doc: fixes default shell in child_process.md
henryzxu Jul 12, 2017
fd92d17
doc: fixes default shell in child_process.md
henryzxu Jul 17, 2017
33adbeb
doc: fixes default shell in child_process.md
henryzxu Jul 17, 2017
e4171c3
doc: fixes default shell in child_process.md
henryzxu Jul 18, 2017
46a8829
doc: fixes default shell in child_process.md
henryzxu Jul 18, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
doc: fixes default shell in child_process.md 
Rewrapped lines over 80 characters according to the Style Guide.
  • Loading branch information
@henryzxu
henryzxu committed Jul 12, 2017
commit a6a073ce3561ef657dad3fee23d196537879eb48
28 changes: 16 additions & 12 deletions doc/api/child_process.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,9 +134,10 @@ added: v0.1.90
* `encoding` {string} (Default: `'utf8'`)
* `shell` {string} Shell to execute the command with
(Default: `'/bin/sh'` on UNIX, `'process.env.ComSpec'` on Windows. If
`'process.env.ComSpec'` is unavailable, uses `'cmd.exe'` on Windows instead.
The shell should understand the `-c` switch on UNIX or `/d /s /c` on Windows.
On Windows, command line parsing should be compatible with `cmd.exe`.)
`'process.env.ComSpec'` is unavailable, uses `'cmd.exe'` on Windows
instead. The shell should understand the `-c` switch on UNIX or
`/d /s /c` on Windows. On Windows, command line parsing should be
compatible with `cmd.exe`.)
* `timeout` {number} (Default: `0`)
* `maxBuffer` {number} Largest amount of data in bytes allowed on stdout or
stderr. (Default: `200*1024`) If exceeded, the child process is terminated.
Expand Down Expand Up @@ -384,9 +385,10 @@ changes:
* `gid` {number} Sets the group identity of the process. (See setgid(2).)
* `shell` {boolean|string} If `true`, runs `command` inside of a shell. Uses
`'/bin/sh'` on UNIX, and `'process.env.ComSpec'` on Windows. If
`'process.env.ComSpec'` is unavailable, uses `'cmd.exe'` on Windows instead.
A different shell can be specified as a string. The shell should understand the
`-c` switch on UNIX, or `/d /s /c` on Windows. Defaults to `false` (no shell).
`'process.env.ComSpec'` is unavailable, uses `'cmd.exe'` on Windows
instead. A different shell can be specified as a string. The shell should
understand the `-c` switch on UNIX, or `/d /s /c` on Windows. Defaults
to `false` (no shell).
* Returns: {ChildProcess}

The `child_process.spawn()` method spawns a new process using the given
Expand Down Expand Up @@ -710,9 +712,10 @@ changes:
* `env` {Object} Environment key-value pairs
* `shell` {string} Shell to execute the command with
(Default: `'/bin/sh'` on UNIX, `'process.env.ComSpec'` on Windows.
If `'process.env.ComSpec'` is unavailable, uses `'cmd.exe'` on Windows instead.
The shell should understand the `-c` switch on UNIX or `/d /s /c` on Windows.
On Windows, command line parsing should be compatible with `cmd.exe`.)
If `'process.env.ComSpec'` is unavailable, uses `'cmd.exe'` on Windows
instead. The shell should understand the `-c` switch on UNIX or
`/d /s /c` on Windows. On Windows, command line parsing should be
compatible with `cmd.exe`.)
* `uid` {number} Sets the user identity of the process. (See setuid(2).)
* `gid` {number} Sets the group identity of the process. (See setgid(2).)
* `timeout` {number} In milliseconds the maximum amount of time the process
Expand Down Expand Up @@ -779,9 +782,10 @@ changes:
(Default: `'buffer'`)
* `shell` {boolean|string} If `true`, runs `command` inside of a shell. Uses
`'/bin/sh'` on UNIX, and `'process.env.ComSpec'` on Windows. If
`'process.env.ComSpec'` is unavailable, uses `'cmd.exe'` on Windows instead.
A different shell can be specified as a string. The shell should understand the
`-c` switch on UNIX, or `/d /s /c` on Windows. Defaults to `false` (no shell).
`'process.env.ComSpec'` is unavailable, uses `'cmd.exe'` on Windows
instead. A different shell can be specified as a string. The shell should
understand the `-c` switch on UNIX, or `/d /s /c` on Windows. Defaults
to `false` (no shell).
* Returns: {Object}
* `pid` {number} Pid of the child process
* `output` {Array} Array of results from stdio output
Expand Down