<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>System.Console.CmdArgs.Helper</title><link href="ocean.css" rel="stylesheet" type="text/css" title="Ocean" /><script src="haddock-util.js" type="text/javascript"></script><script type="text/javascript">//<![CDATA[
window.onload = function () {pageLoad();setSynopsis("mini_System-Console-CmdArgs-Helper.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/System-Console-CmdArgs-Helper.html">Source</a></li><li><a href="index.html">Contents</a></li><li><a href="doc-index.html">Index</a></li></ul><p class="caption">cmdargs-0.9.3: Command line argument processing</p></div><div id="content"><div id="module-header"><p class="caption">System.Console.CmdArgs.Helper</p></div><div id="table-of-contents"><p class="caption">Contents</p><ul><li><a href="#g:1">Called by the main program
</a></li><li><a href="#g:2">Called by the helper program
</a></li></ul></div><div id="description"><p class="caption">Description</p><div class="doc"><p>Module for implementing CmdArgs helpers. A CmdArgs helper is an external program,
that helps a user construct the command line arguments. To use a helper set the
environment variable <code>$CMDARGS_HELPER</code> (or <code>$CMDARGS_HELPER_<em>YOURPROGRAM</em></code>) to
one of:
</p><ul><li> <code>echo <em>foo</em></code> will cause <code><em>foo</em></code> to be used as the command arguments.
</li><li> <code>cmdargs-browser</code> will cause a web browser to appear to help entering the arguments.
For this command to work, you will need to install the <code>cmdargs-browser</code> package:
<a href="http://hackage.haskell.org/package/cmdargs-browser">http://hackage.haskell.org/package/cmdargs-browser</a>
</li></ul></div></div><div id="synopsis"><p id="control.syn" class="caption expander" onclick="toggleSection('syn')">Synopsis</p><ul id="section.syn" class="hide" onclick="toggleSection('syn')"><li class="src short"><a href="#v:execute">execute</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a> -> <a href="System-Console-CmdArgs-Explicit.html#t:Mode">Mode</a> a -> [<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a>] -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Either.html#t:Either">Either</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a> [<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a>])</li><li class="src short"><span class="keyword">data</span> <a href="#t:Unknown">Unknown</a> </li><li class="src short"><a href="#v:receive">receive</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> (<a href="System-Console-CmdArgs-Explicit.html#t:Mode">Mode</a> <a href="System-Console-CmdArgs-Helper.html#t:Unknown">Unknown</a>)</li><li class="src short"><a href="#v:reply">reply</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Either.html#t:Either">Either</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a> [<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a>] -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a></li><li class="src short"><a href="#v:comment">comment</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a></li></ul></div><div id="interface"><h1 id="g:1">Called by the main program
</h1><div class="top"><p class="src"><a name="v:execute" class="def">execute</a><a href="src/System-Console-CmdArgs-Helper.html#execute" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></td><td class="doc"><p>Name of the command to run, e.g. <code>echo argument</code>, <code>cmdargs-browser</code>
</p></td></tr><tr><td class="src">-> <a href="System-Console-CmdArgs-Explicit.html#t:Mode">Mode</a> a</td><td class="doc"><p>Mode to run remotely
</p></td></tr><tr><td class="src">-> [<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a>]</td><td class="doc"><p>Initial set of command line flags (not supported by all helpers)
</p></td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Either.html#t:Either">Either</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a> [<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a>])</td><td class="doc"><p>Either an error message, or a list of flags to use
</p></td></tr></table></div><div class="doc"><p>Run a remote command line entry.
</p></div></div><h1 id="g:2">Called by the helper program
</h1><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:Unknown" class="def">Unknown</a> <a href="src/System-Console-CmdArgs-Helper.html#Unknown" class="link">Source</a></p><div class="doc"><p>Unknown value, representing the values stored within the <code><a href="System-Console-CmdArgs-Explicit.html#t:Mode">Mode</a></code> structure. While the values
are not observable, they behave identically to the original values.
</p></div></div><div class="top"><p class="src"><a name="v:receive" class="def">receive</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> (<a href="System-Console-CmdArgs-Explicit.html#t:Mode">Mode</a> <a href="System-Console-CmdArgs-Helper.html#t:Unknown">Unknown</a>)<a href="src/System-Console-CmdArgs-Helper.html#receive" class="link">Source</a></p><div class="doc"><p>Receive information about the mode to display.
</p></div></div><div class="top"><p class="src"><a name="v:reply" class="def">reply</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Either.html#t:Either">Either</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a> [<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a>] -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a><a href="src/System-Console-CmdArgs-Helper.html#reply" class="link">Source</a></p><div class="doc"><p>Send a reply with either an error, or a list of flags to use. This function exits the helper program.
</p></div></div><div class="top"><p class="src"><a name="v:comment" class="def">comment</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a><a href="src/System-Console-CmdArgs-Helper.html#comment" class="link">Source</a></p><div class="doc"><p>Send a comment which will be displayed on the calling console, mainly useful for debugging.
</p></div></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.9.2</p></div></body></html>
distrib
>
Fedora
>
17
>
i386
>
media
>
updates
>
by-pkgid
>
a754cb499dfee5e1f453d3b6cc13d4c8
>
files
>
91
