summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorTim Smith <tsmith84@gmail.com>2016-02-17 14:48:12 -0800
committerTim Smith <tsmith84@gmail.com>2016-02-17 14:48:12 -0800
commitf47333b6969a744d64f01a3533fd9faff7e6b1bb (patch)
tree0e25a2cd276b0b769e83569b3358c6432e9c35da /README.md
parentba59f99026ce412b52ba18c83675710a50a7fd5b (diff)
downloadmixlib-shellout-f47333b6969a744d64f01a3533fd9faff7e6b1bb.tar.gz
Link to the code for the complete list
Technically I could type this all, but it's probably easier to just link direct to the options
Diffstat (limited to 'README.md')
-rw-r--r--README.md6
1 files changed, 1 insertions, 5 deletions
diff --git a/README.md b/README.md
index 4a9bf34..85146d8 100644
--- a/README.md
+++ b/README.md
@@ -34,11 +34,7 @@ Raise an exception if it didn't exit with 0
```
### Advanced Shellout
-In addition to the command to run there are other attributes that can be set to change the shellout behavior:
-- `env`: set environmental variables before shelling out
-- `user`: execute the shellout as this user
-- `cwd`: execute the shellout from this directory
-- `timeout`: set a command timeout (defaul 600s)
+In addition to the command to run there are other options that can be set to change the shellout behavior. The complete list of options can be found here: https://github.com/chef/mixlib-shellout/blob/master/lib/mixlib/shellout.rb
Run a command as the `www` user with no extra ENV settings from `/tmp` with a 1s timeout