diff options
| author | Tom Faulhaber <git_net@infolace.com> | 2010-02-19 11:26:52 -0800 |
|---|---|---|
| committer | Tom Faulhaber <git_net@infolace.com> | 2010-02-19 11:26:52 -0800 |
| commit | 78b132edfc56eff93162e9cd264396528dc6df2d (patch) | |
| tree | 6592815e8d5ef8b4d4ef76593f4b335ed23d734d /shell-out-api.html | |
| parent | cc1f8c119fbf973bc75bd25ba329a8b1c0d0ece7 (diff) | |
Document the latest branches, et al., in clojure-contrib. Supporting docs currently missing.
Diffstat (limited to 'shell-out-api.html')
| -rw-r--r-- | shell-out-api.html | 121 |
1 files changed, 0 insertions, 121 deletions
diff --git a/shell-out-api.html b/shell-out-api.html deleted file mode 100644 index 451b8702..00000000 --- a/shell-out-api.html +++ /dev/null @@ -1,121 +0,0 @@ -<html> - <head> - <title>shell-out API reference (clojure-contrib)</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-contrib API Reference</a></h1> - </div> - <div id="leftcolumn"><div style="text-align: center;"></div> -<div class="menu"> - <div class="WikiCustomNav WikiElement wiki"> - <a class="wiki_link" href="index.html">Overview</a><br /> - <a class="wiki_link" href="api-index.html">API Index</a><br /> - <a class="wiki_link" href="#">Namespaces:</a> - <ul id="left-sidebar-list"> - <li><a href="accumulators-api.html" class="wiki_link">accumulators</a></li><li><a href="agent-utils-api.html" class="wiki_link">agent-utils</a></li><li><a href="apply-macro-api.html" class="wiki_link">apply-macro</a></li><li><a href="base64-api.html" class="wiki_link">base64</a></li><li><a href="classpath-api.html" class="wiki_link">classpath</a></li><li><a href="combinatorics-api.html" class="wiki_link">combinatorics</a></li><li><a href="command-line-api.html" class="wiki_link">command-line</a></li><li><a href="complex-numbers-api.html" class="wiki_link">complex-numbers</a></li><li><a href="cond-api.html" class="wiki_link">cond</a></li><li><a href="condition-api.html" class="wiki_link">condition</a></li><li><a href="core-api.html" class="wiki_link">core</a></li><li><a href="dataflow-api.html" class="wiki_link">dataflow</a></li><li><a href="datalog-api.html" class="wiki_link">datalog</a></li><li><a href="def-api.html" class="wiki_link">def</a></li><li><a href="duck-streams-api.html" class="wiki_link">duck-streams</a></li><li><a href="error-kit-api.html" class="wiki_link">error-kit</a></li><li><a href="except-api.html" class="wiki_link">except</a></li><li><a href="fcase-api.html" class="wiki_link">fcase</a></li><li><a href="find-namespaces-api.html" class="wiki_link">find-namespaces</a></li><li><a href="fnmap-api.html" class="wiki_link">fnmap</a></li><li><a href="gen-html-docs-api.html" class="wiki_link">gen-html-docs</a></li><li><a href="generic.arithmetic-api.html" class="wiki_link">generic.arithmetic</a></li><li><a href="generic.collection-api.html" class="wiki_link">generic.collection</a></li><li><a href="generic.comparison-api.html" class="wiki_link">generic.comparison</a></li><li><a href="generic.functor-api.html" class="wiki_link">generic.functor</a></li><li><a href="generic.math-functions-api.html" class="wiki_link">generic.math-functions</a></li><li><a href="graph-api.html" class="wiki_link">graph</a></li><li><a href="greatest-least-api.html" class="wiki_link">greatest-least</a></li><li><a href="http.agent-api.html" class="wiki_link">http.agent</a></li><li><a href="http.connection-api.html" class="wiki_link">http.connection</a></li><li><a href="import-static-api.html" class="wiki_link">import-static</a></li><li><a href="jar-api.html" class="wiki_link">jar</a></li><li><a href="java-utils-api.html" class="wiki_link">java-utils</a></li><li><a href="javadoc.browse-api.html" class="wiki_link">javadoc.browse</a></li><li><a href="jmx-api.html" class="wiki_link">jmx</a></li><li><a href="json.read-api.html" class="wiki_link">json.read</a></li><li><a href="json.write-api.html" class="wiki_link">json.write</a></li><li><a href="lazy-seqs-api.html" class="wiki_link">lazy-seqs</a></li><li><a href="lazy-xml-api.html" class="wiki_link">lazy-xml</a></li><li><a href="logging-api.html" class="wiki_link">logging</a></li><li><a href="macro-utils-api.html" class="wiki_link">macro-utils</a></li><li><a href="macros-api.html" class="wiki_link">macros</a></li><li><a href="map-utils-api.html" class="wiki_link">map-utils</a></li><li><a href="math-api.html" class="wiki_link">math</a></li><li><a href="miglayout-api.html" class="wiki_link">miglayout</a></li><li><a href="mmap-api.html" class="wiki_link">mmap</a></li><li><a href="mock-api.html" class="wiki_link">mock</a></li><li><a href="monadic-io-streams-api.html" class="wiki_link">monadic-io-streams</a></li><li><a href="monads-api.html" class="wiki_link">monads</a></li><li><a href="ns-utils-api.html" class="wiki_link">ns-utils</a></li><li><a href="pprint-api.html" class="wiki_link">pprint</a></li><li><a href="probabilities.finite-distributions-api.html" class="wiki_link">probabilities.finite-distributions</a></li><li><a href="probabilities.monte-carlo-api.html" class="wiki_link">probabilities.monte-carlo</a></li><li><a href="probabilities.random-numbers-api.html" class="wiki_link">probabilities.random-numbers</a></li><li><a href="profile-api.html" class="wiki_link">profile</a></li><li><a href="prxml-api.html" class="wiki_link">prxml</a></li><li><a href="repl-ln-api.html" class="wiki_link">repl-ln</a></li><li><a href="repl-utils-api.html" class="wiki_link">repl-utils</a></li><li><a href="seq-utils-api.html" class="wiki_link">seq-utils</a></li><li><a href="server-socket-api.html" class="wiki_link">server-socket</a></li><li><a href="set-api.html" class="wiki_link">set</a></li><li><a href="shell-out-api.html" class="wiki_link">shell-out</a></li><li><a href="singleton-api.html" class="wiki_link">singleton</a></li><li><a href="sql-api.html" class="wiki_link">sql</a></li><li><a href="str-utils-api.html" class="wiki_link">str-utils</a></li><li><a href="str-utils2-api.html" class="wiki_link">str-utils2</a></li><li><a href="stream-utils-api.html" class="wiki_link">stream-utils</a></li><li><a href="swing-utils-api.html" class="wiki_link">swing-utils</a></li><li><a href="test-is-api.html" class="wiki_link">test-is</a></li><li><a href="trace-api.html" class="wiki_link">trace</a></li><li><a href="types-api.html" class="wiki_link">types</a></li><li><a href="with-ns-api.html" class="wiki_link">with-ns</a></li><li><a href="zip-filter-api.html" class="wiki_link">zip-filter</a></li> - </ul> - </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.contrib.shell-out/sh">sh</a> - </div> - <br /> - </div> -</div> -</div> - <div id="content-tag"><h1 id="overview">API for <span id="namespace-name">shell-out</span></h1> -by <span id="author">Chris Houser</span><br /> -<br />Usage: -<pre> -(ns your-namespace - (:require <span id="long-name">clojure.contrib.shell-out</span>)) -</pre><pre> -</pre><h2>Overview</h2> -<pre id="namespace-docstr">Conveniently launch a sub-process providing to its stdin and -collecting its stdout</pre> -<br /> -<h2>Public Variables and Functions</h2> -<div id="var-entry"> - <br /> - <hr /> - <h2 id="clojure.contrib.shell-out/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 specifying text to be fed to the - sub-process's stdin. -:out 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. -:return-map - 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 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.</pre> - <a href="http://github.com/richhickey/clojure-contrib/blob/cc4e2ec2bf558f059330ebc97a031d7806a1e364/src/clojure/contrib/shell_out.clj#L83" id="var-source">Source</a> -</div> - - -</div> - </div> - </div> - </div> - </div> - <div id="foot"> - <div style="text-align: center;" id="copyright">Copyright 2007-2009 by Rich Hickey and the various contributors</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 |