Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mikehaertl committed Aug 15, 2019
1 parent d66f8a1 commit d371f08
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 10 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,11 +93,11 @@ $command->setStdIn('string');
PHP working dir.
* `$procEnv`: An array with environment variables to pass to `proc_open()`. Default is `null` for none.
* `$procOptions`: An array of `other_options` for `proc_open()`. Default is `null` for none.
* `$nonBlockingMode`: Whether to set the stdout/stderr streams to non-blocking
mode when `proc_open()` is used. This can fix issues with long running
commands that hang indefinitely but can cause problems on Windows systems.
The default is `null` in which case non-blocking mode is only enabled on
non-Windows systems.
* `$nonBlockingMode`: Whether to set the stdin/stdout/stderr streams to non-blocking
mode when `proc_open()` is used. This allows to have huge inputs/outputs
without making the process hang. The default is `null` which will enable
the feature on Non-Windows systems. Set it to `true` or `false` to manually
enable/disable it. Note that it doesn't work on Windows.
* `$locale`: The locale to (temporarily) set with `setlocale()` before running the command.
This can be set to e.g. `en_US.UTF-8` if you have issues with UTF-8 encoded arguments.

Expand Down
10 changes: 5 additions & 5 deletions src/Command.php
Original file line number Diff line number Diff line change
Expand Up @@ -54,11 +54,11 @@ class Command
public $procOptions;

/**
* @var bool|null whether to set the stdout/stderr streams to non-blocking mode
* when `proc_open()` is used. This can fix issues with long running
* commands that hang indefinitely but can cause problems on Windows
* systems. The default is `null` in which case non-blocking mode is only
* enabled on non-Windows systems.
* @var bool|null whether to set the stdin/stdout/stderr streams to
* non-blocking mode when `proc_open()` is used. This allows to have huge
* inputs/outputs without making the process hang. The default is `null`
* which will enable the feature on Non-Windows systems. Set it to `true`
* or `false` to manually enable/disable it. It does not work on Windows.
*/
public $nonBlockingMode;

Expand Down

0 comments on commit d371f08

Please sign in to comment.