diff options
| author | Tom Faulhaber <git_net@infolace.com> | 2010-09-23 08:28:12 -0700 |
|---|---|---|
| committer | Tom Faulhaber <git_net@infolace.com> | 2010-09-23 08:28:12 -0700 |
| commit | 0c94b0f228c537a974cf77bccdde5909c2447f29 (patch) | |
| tree | 3bc4eb310ae6c2379862f87cbff21b338a894981 /clojure.java.shell-api.html | |
| parent | a0acdf3c2955906f3beae49091466daac14d906a (diff) | |
Autodoc commit for 1.2.x/d7141f15, 1.1.x/5293929c, master/68837c0e
Diffstat (limited to 'clojure.java.shell-api.html')
| -rw-r--r-- | clojure.java.shell-api.html | 166 |
1 files changed, 0 insertions, 166 deletions
diff --git a/clojure.java.shell-api.html b/clojure.java.shell-api.html deleted file mode 100644 index b374ce2d..00000000 --- a/clojure.java.shell-api.html +++ /dev/null @@ -1,166 +0,0 @@ -<html> - <head> - <title>clojure.java.shell - Clojure v1.2 API documentation</title> - <link href="static/favicon.png" rel="icon" /> - <link href="static/favicon.png" rel="shortcut icon" /> - <link media="all" type="text/css" href="static/clojure.css" rel="stylesheet" /> - <link media="all" type="text/css" href="static/wiki.css" rel="stylesheet" /> - <link media="all" type="text/css" href="static/internal.css" rel="stylesheet" /> - <!-- TODO: are we using these (from clojure.org)? If so, add the files --> - <script src="file/view/code_highlighter.js" type="text/javascript"></script> - <script src="file/view/clojure.js" type="text/javascript"></script> - <style>.menuWrapper{height: 36px;}</style> - <!--[if lte IE 6]> - <link rel="stylesheet" href="http://www.wikispaces.com/_/2009051601/s/internal_ie.css" type="text/css" /> - <![endif]--> - </head> -<!-- -This document was auto-generated from the source by the clojure autodoc system. -To report errors or ask questions about the overall documentation structure, formatting, -etc., contact Tom Faulhaber (google mail name: tomfaulhaber). -For errors in the documentation of a particular namespace, contact the author of that -namespace. ---> - <body> - <div id="AllContentContainer"> - <div id="Header"> - <a id="Logo" href="index.html"><img alt="Clojure" height="100" width="100" src="static/clojure-icon.gif" /></a> - <h1><a title="page header title" id="page-header" href="index.html">Clojure Core API Reference</a></h1> - </div> - <div id="leftcolumn"><div style="text-align: center;"></div> -<div class="menu"> - <div class="WikiCustomNav WikiElement wiki"> - <span class="toc-header"><span id="project-name">Clojure</span> <span id="version">v1.2</span> API</span><br /> - <ul> - <li><a class="wiki_link" href="index.html">Overview</a></li> - <li><a class="wiki_link" href="api-index.html">API Index</a></li> - </ul> - <span class="toc-header">Namespaces</span> - <ul id="left-sidebar-list"> - <li><a href="clojure.core-api.html" class="wiki_link">clojure.core</a></li><li><a href="clojure.inspector-api.html" class="wiki_link">clojure.inspector</a></li><li><a href="clojure.java.browse-api.html" class="wiki_link">clojure.java.browse</a></li><li><a href="clojure.java.io-api.html" class="wiki_link">clojure.java.io</a></li><li><a href="clojure.java.javadoc-api.html" class="wiki_link">clojure.java.javadoc</a></li><li><a href="clojure.java.shell-api.html" class="wiki_link">clojure.java.shell</a></li><li><a href="clojure.main-api.html" class="wiki_link">clojure.main</a></li><li><a href="clojure.pprint-api.html" class="wiki_link">clojure.pprint</a></li><li><a href="clojure.repl-api.html" class="wiki_link">clojure.repl</a></li><li><a href="clojure.set-api.html" class="wiki_link">clojure.set</a></li><li><a href="clojure.stacktrace-api.html" class="wiki_link">clojure.stacktrace</a></li><li><a href="clojure.string-api.html" class="wiki_link">clojure.string</a></li><li><a href="clojure.template-api.html" class="wiki_link">clojure.template</a></li><li><a href="clojure.test-api.html" class="wiki_link">clojure.test</a></li><li><a href="clojure.walk-api.html" class="wiki_link">clojure.walk</a></li><li><a href="clojure.xml-api.html" class="wiki_link">clojure.xml</a></li><li><a href="clojure.zip-api.html" class="wiki_link">clojure.zip</a></li> - </ul> - <div class="BranchTOC"> - <span class="toc-header">Other Versions</span> - <ul id="left-sidebar-branch-list"> - <li><a href="branch-1.1.x/index.html" class="wiki_link">v1.1 (stable)</a></li><li><a href="branch-master/index.html" class="wiki_link">next (in development)</a></li> - </ul> - </div> - <a href="http://clojure.org" class="wiki_link">Clojure Home</a> - </div> -</div> -</div> - <div id="rightcolumn"> - <div id="Content"> - <div class="contentBox"><div class="innerContentBox"> - <div id="content_view" class="wiki wikiPage"> - <div id="right-sidebar"><div id="toc"> - <h1 class="nopad">Table of Contents</h1> - <div style="margin-left: 1em;" class="toc-section"> - <a href="#toc0">Overview</a> - <div style="margin-left: 1em;" class="toc-entry"> - <a href="#clojure.java.shell/sh">sh</a> - </div><div style="margin-left: 1em;" class="toc-entry"> - <a href="#clojure.java.shell/with-sh-dir">with-sh-dir</a> - </div><div style="margin-left: 1em;" class="toc-entry"> - <a href="#clojure.java.shell/with-sh-env">with-sh-env</a> - </div> - <br /> - </div> -</div> -</div> - <div id="content-tag"><h1 id="overview">API for <span id="namespace-name">clojure.java.shell</span> - - <span id="header-project">Clojure</span> <span id="header-version">v1.2</span> (<span id="header-status">stable</span>) - </h1> -<span id="author-line">by <span id="author-name">Chris Houser, Stuart Halloway</span><br /></span> -<br />Usage: -<pre> -(ns your-namespace - (:require <span id="long-name">clojure.java.shell</span>)) -</pre><pre> -</pre><h2>Overview</h2> -<pre id="namespace-docstr">Conveniently launch a sub-process providing its stdin and -collecting its stdout</pre> - - -<br /> -<h2>Public Variables and Functions</h2> -<div id="var-entry"> - <br /> - <hr /> - <h2 id="clojure.java.shell/sh">sh</h2> - <span id="var-type">function</span><br /> - <pre id="var-usage">Usage: (sh & args) -</pre> - <pre id="var-docstr">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)</pre> - <span class="var-added"><span id="content">Added in Clojure version 1.2</span><br /></span> - - <a href="http://github.com/clojure/clojure/blob/a2c95ef1bf6e34a455b469ac9ff18ddff7e9cef7/src/clj/clojure/java/shell.clj#L79" id="var-source">Source</a> -</div><div id="var-entry"> - <br /> - <hr /> - <h2 id="clojure.java.shell/with-sh-dir">with-sh-dir</h2> - <span id="var-type">macro</span><br /> - <pre id="var-usage">Usage: (with-sh-dir dir & forms) -</pre> - <pre id="var-docstr">Sets the directory for use with sh, see sh for details.</pre> - <span class="var-added"><span id="content">Added in Clojure version 1.2</span><br /></span> - - <a href="http://github.com/clojure/clojure/blob/a2c95ef1bf6e34a455b469ac9ff18ddff7e9cef7/src/clj/clojure/java/shell.clj#L21" id="var-source">Source</a> -</div><div id="var-entry"> - <br /> - <hr /> - <h2 id="clojure.java.shell/with-sh-env">with-sh-env</h2> - <span id="var-type">macro</span><br /> - <pre id="var-usage">Usage: (with-sh-env env & forms) -</pre> - <pre id="var-docstr">Sets the environment for use with sh, see sh for details.</pre> - <span class="var-added"><span id="content">Added in Clojure version 1.2</span><br /></span> - - <a href="http://github.com/clojure/clojure/blob/a2c95ef1bf6e34a455b469ac9ff18ddff7e9cef7/src/clj/clojure/java/shell.clj#L28" id="var-source">Source</a> -</div> - - -</div> - </div> - </div> - </div> - </div> - <div id="foot"> - <div style="text-align: center;" id="copyright">Copyright 2007-2010 by Rich Hickey</div> - </div> - </div> - <div id="DesignedBy">Logo & site design by <a title="Visit Tom Hickey's website." href="http://www.tomhickey.com">Tom Hickey</a>.<br /> - Clojure auto-documentation system by Tom Faulhaber.</div> - </div> - <!-- /AllContentContainer --> - </body> - -</html>
\ No newline at end of file |