diff options
author | Chouser <chouser@n01se.net> | 2009-04-09 03:59:09 +0000 |
---|---|---|
committer | Chouser <chouser@n01se.net> | 2009-04-09 03:59:09 +0000 |
commit | 86ecadd04ca189e44b4cb68e5bd6e5488c8f6029 (patch) | |
tree | 26926e09f5ca32643b0c56f23fd2e8b4acdfaf0b /src | |
parent | 2840313f5286f2f5f30e82b0768f265128d31680 (diff) |
shell-out: fix up docstring
Diffstat (limited to 'src')
-rw-r--r-- | src/clojure/contrib/shell_out.clj | 9 |
1 files changed, 6 insertions, 3 deletions
diff --git a/src/clojure/contrib/shell_out.clj b/src/clojure/contrib/shell_out.clj index 79bebd4b..1ee7b230 100644 --- a/src/clojure/contrib/shell_out.clj +++ b/src/clojure/contrib/shell_out.clj @@ -87,14 +87,17 @@ example \"UTF-8\" or \"ISO-8859-1\") to convert the sub-process's stdout to a String which is returned. If :bytes is given, the sub-process's stdout will be stored in - a byte array and returned. + a byte array and returned. Defaults to UTF-8. :return-map - when followed by boolean true returns a map of + when followed by boolean true, sh returns a map of :exit => sub-process's exit code :out => sub-process's stdout (as byte[] or String) :err => sub-process's stderr (as byte[] or String) + when not given or followed by false, sh returns a single + array or String of the sub-process's stdout followed by its + stderr :env override the process env with a map (or the underlying Java - String[] if you are masochist). + String[] if you are a masochist). :dir override the process dir with a String or java.io.File. You can bind :env or :dir for multiple operations using with-sh-env |