From 65373b8cfa15d86da1d7d2badd6a2f63075935d9 Mon Sep 17 00:00:00 2001 From: Tom Faulhaber Date: Tue, 28 Sep 2010 23:04:06 -0700 Subject: Autodoc commit for 1.2.x/f128af9d, 1.1.x/5293929c, master/167a7385 --- clojure.java.shell-api.html | 166 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 166 insertions(+) create mode 100644 clojure.java.shell-api.html (limited to 'clojure.java.shell-api.html') diff --git a/clojure.java.shell-api.html b/clojure.java.shell-api.html new file mode 100644 index 00000000..b374ce2d --- /dev/null +++ b/clojure.java.shell-api.html @@ -0,0 +1,166 @@ + + + clojure.java.shell - Clojure v1.2 API documentation + + + + + + + + + + + + + +
+ + +
+
+
+
+ +

API for clojure.java.shell + - Clojure v1.2 (stable) +

+by Chris Houser, Stuart Halloway
 +
Usage: +
+(ns your-namespace
+  (:require clojure.java.shell))
+
+

Overview

+
Conveniently launch a sub-process providing its stdin and
+collecting its stdout
+ + +
+

Public Variables and Functions

+
+
+
+

sh

+ function
+ 
Usage: (sh & args)
+
+ 
Passes the given strings to Runtime.exec() to launch a sub-process.
+
+Options are
+
+:in      may be given followed by a String or byte array specifying input
+         to be fed to the sub-process's stdin.
+:in-enc  option may be given followed by a String, used as a character
+         encoding name (for example "UTF-8" or "ISO-8859-1") to
+         convert the input string specified by the :in option to the
+         sub-process's stdin.  Defaults to UTF-8.
+         If the :in option provides a byte array, then the bytes are passed
+         unencoded, and this option is ignored.
+:out-enc option may be given followed by :bytes or a String. If a
+         String is given, it will be used as a character encoding
+         name (for 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.  Defaults to UTF-8.
+:env     override the process env with a map (or the underlying Java
+         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
+and with-sh-dir.
+
+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 (String via platform default encoding)
+ Added in Clojure version 1.2
 + + Source +
+
+
+

with-sh-dir

+ macro
+ 
Usage: (with-sh-dir dir & forms)
+
+ 
Sets the directory for use with sh, see sh for details.
+ Added in Clojure version 1.2
 + + Source +
+
+
+

with-sh-env

+ macro
+ 
Usage: (with-sh-env env & forms)
+
+ 
Sets the environment for use with sh, see sh for details.
+ Added in Clojure version 1.2
 + + Source +
+ + +
+
+
+
+
+ +
+
Logo & site design by Tom Hickey.
+ Clojure auto-documentation system by Tom Faulhaber.
+
+ + + + \ No newline at end of file -- cgit v1.2.3-70-g09d2