<!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>Darcs.Commands</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_Darcs-Commands.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/Darcs-Commands.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">darcs-2.8.3: a distributed, interactive, smart revision control system</p></div><div id="content"><div id="module-header"><table class="info"><tr><th>Safe Haskell</th><td>Safe-Infered</td></tr></table><p class="caption">Darcs.Commands</p></div><div id="interface"><h1>Documentation</h1><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:CommandControl" class="def">CommandControl</a> <a href="src/Darcs-Commands.html#CommandControl" class="link">Source</a></p><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:CommandData" class="def">CommandData</a> <a href="Darcs-Commands.html#t:DarcsCommand">DarcsCommand</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:HiddenCommand" class="def">HiddenCommand</a> <a href="Darcs-Commands.html#t:DarcsCommand">DarcsCommand</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:GroupName" class="def">GroupName</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a></td><td class="doc empty"> </td></tr></table></div></div><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:DarcsCommand" class="def">DarcsCommand</a> <a href="src/Darcs-Commands.html#DarcsCommand" class="link">Source</a></p><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:DarcsCommand" class="def">DarcsCommand</a></td><td class="doc empty"> </td></tr><tr><td colspan="2"><div class="subs fields"><p class="caption">Fields</p><dl><dt class="src"><a name="v:commandProgramName" class="def">commandProgramName</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a></dt><dd class="doc empty"> </dd><dt class="src"><a name="v:commandName" class="def">commandName</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a></dt><dd class="doc empty"> </dd><dt class="src"><a name="v:commandHelp" class="def">commandHelp</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a></dt><dd class="doc empty"> </dd><dt class="src"><a name="v:commandDescription" class="def">commandDescription</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a></dt><dd class="doc empty"> </dd><dt class="src"><a name="v:commandExtraArgs" class="def">commandExtraArgs</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Int.html#t:Int">Int</a></dt><dd class="doc empty"> </dd><dt class="src"><a name="v:commandExtraArgHelp" class="def">commandExtraArgHelp</a> :: [<a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a>]</dt><dd class="doc empty"> </dd><dt class="src"><a name="v:commandCommand" class="def">commandCommand</a> :: [<a href="Darcs-Flags.html#t:DarcsFlag">DarcsFlag</a>] -> [<a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a>] -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Tuple.html#t:-40--41-">()</a></dt><dd class="doc empty"> </dd><dt class="src"><a name="v:commandPrereq" class="def">commandPrereq</a> :: [<a href="Darcs-Flags.html#t:DarcsFlag">DarcsFlag</a>] -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/System-IO.html#t:IO">IO</a> (<a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Either.html#t:Either">Either</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Tuple.html#t:-40--41-">()</a>)</dt><dd class="doc empty"> </dd><dt class="src"><a name="v:commandGetArgPossibilities" class="def">commandGetArgPossibilities</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/System-IO.html#t:IO">IO</a> [<a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a>]</dt><dd class="doc empty"> </dd><dt class="src"><a name="v:commandArgdefaults" class="def">commandArgdefaults</a> :: [<a href="Darcs-Flags.html#t:DarcsFlag">DarcsFlag</a>] -> <a href="Darcs-RepoPath.html#t:AbsolutePath">AbsolutePath</a> -> [<a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a>] -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/System-IO.html#t:IO">IO</a> [<a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a>]</dt><dd class="doc empty"> </dd><dt class="src"><a name="v:commandBasicOptions" class="def">commandBasicOptions</a> :: [<a href="Darcs-Arguments.html#t:DarcsOption">DarcsOption</a>]</dt><dd class="doc empty"> </dd><dt class="src"><a name="v:commandAdvancedOptions" class="def">commandAdvancedOptions</a> :: [<a href="Darcs-Arguments.html#t:DarcsOption">DarcsOption</a>]</dt><dd class="doc empty"> </dd></dl><div class="clear"></div></div></td></tr><tr><td class="src"><a name="v:SuperCommand" class="def">SuperCommand</a></td><td class="doc empty"> </td></tr><tr><td colspan="2"><div class="subs fields"><p class="caption">Fields</p><dl><dt class="src"><a name="v:commandProgramName" class="def">commandProgramName</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a></dt><dd class="doc empty"> </dd><dt class="src"><a name="v:commandName" class="def">commandName</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a></dt><dd class="doc empty"> </dd><dt class="src"><a name="v:commandHelp" class="def">commandHelp</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a></dt><dd class="doc empty"> </dd><dt class="src"><a name="v:commandDescription" class="def">commandDescription</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a></dt><dd class="doc empty"> </dd><dt class="src"><a name="v:commandPrereq" class="def">commandPrereq</a> :: [<a href="Darcs-Flags.html#t:DarcsFlag">DarcsFlag</a>] -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/System-IO.html#t:IO">IO</a> (<a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Either.html#t:Either">Either</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Tuple.html#t:-40--41-">()</a>)</dt><dd class="doc empty"> </dd><dt class="src"><a name="v:commandSubCommands" class="def">commandSubCommands</a> :: [<a href="Darcs-Commands.html#t:CommandControl">CommandControl</a>]</dt><dd class="doc empty"> </dd></dl><div class="clear"></div></div></td></tr></table></div></div><div class="top"><p class="src"><a name="v:commandAlias" class="def">commandAlias</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Darcs-Commands.html#t:DarcsCommand">DarcsCommand</a> -> <a href="Darcs-Commands.html#t:DarcsCommand">DarcsCommand</a> -> <a href="Darcs-Commands.html#t:DarcsCommand">DarcsCommand</a><a href="src/Darcs-Commands.html#commandAlias" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:commandStub" class="def">commandStub</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a> -> <a href="Darcs-Commands.html#t:DarcsCommand">DarcsCommand</a> -> <a href="Darcs-Commands.html#t:DarcsCommand">DarcsCommand</a><a href="src/Darcs-Commands.html#commandStub" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:commandOptions" class="def">commandOptions</a> :: <a href="Darcs-RepoPath.html#t:AbsolutePath">AbsolutePath</a> -> <a href="Darcs-Commands.html#t:DarcsCommand">DarcsCommand</a> -> ([<a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/System-Console-GetOpt.html#t:OptDescr">OptDescr</a> <a href="Darcs-Flags.html#t:DarcsFlag">DarcsFlag</a>], [<a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/System-Console-GetOpt.html#t:OptDescr">OptDescr</a> <a href="Darcs-Flags.html#t:DarcsFlag">DarcsFlag</a>])<a href="src/Darcs-Commands.html#commandOptions" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:commandAlloptions" class="def">commandAlloptions</a> :: <a href="Darcs-Commands.html#t:DarcsCommand">DarcsCommand</a> -> ([<a href="Darcs-Arguments.html#t:DarcsOption">DarcsOption</a>], [<a href="Darcs-Arguments.html#t:DarcsOption">DarcsOption</a>])<a href="src/Darcs-Commands.html#commandAlloptions" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:disambiguateCommands" class="def">disambiguateCommands</a> :: [<a href="Darcs-Commands.html#t:CommandControl">CommandControl</a>] -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a> -> [<a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a>] -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Either.html#t:Either">Either</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a> (<a href="Darcs-Commands.html#t:CommandArgs">CommandArgs</a>, [<a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a>])<a href="src/Darcs-Commands.html#disambiguateCommands" class="link">Source</a></p></div><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:CommandArgs" class="def">CommandArgs</a> <a href="src/Darcs-Commands.html#CommandArgs" class="link">Source</a></p><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:CommandOnly" class="def">CommandOnly</a> <a href="Darcs-Commands.html#t:DarcsCommand">DarcsCommand</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:SuperCommandOnly" class="def">SuperCommandOnly</a> <a href="Darcs-Commands.html#t:DarcsCommand">DarcsCommand</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:SuperCommandSub" class="def">SuperCommandSub</a> <a href="Darcs-Commands.html#t:DarcsCommand">DarcsCommand</a> <a href="Darcs-Commands.html#t:DarcsCommand">DarcsCommand</a></td><td class="doc empty"> </td></tr></table></div></div><div class="top"><p class="src"><a name="v:getCommandHelp" class="def">getCommandHelp</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Darcs-Commands.html#t:DarcsCommand">DarcsCommand</a> -> <a href="Darcs-Commands.html#t:DarcsCommand">DarcsCommand</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a><a href="src/Darcs-Commands.html#getCommandHelp" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:getCommandMiniHelp" class="def">getCommandMiniHelp</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Darcs-Commands.html#t:DarcsCommand">DarcsCommand</a> -> <a href="Darcs-Commands.html#t:DarcsCommand">DarcsCommand</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a><a href="src/Darcs-Commands.html#getCommandMiniHelp" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:getSubcommands" class="def">getSubcommands</a> :: <a href="Darcs-Commands.html#t:DarcsCommand">DarcsCommand</a> -> [<a href="Darcs-Commands.html#t:CommandControl">CommandControl</a>]<a href="src/Darcs-Commands.html#getSubcommands" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:usage" class="def">usage</a> :: [<a href="Darcs-Commands.html#t:CommandControl">CommandControl</a>] -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a><a href="src/Darcs-Commands.html#usage" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:usageHelper" class="def">usageHelper</a> :: [<a href="Darcs-Commands.html#t:CommandControl">CommandControl</a>] -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a><a href="src/Darcs-Commands.html#usageHelper" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:subusage" class="def">subusage</a> :: <a href="Darcs-Commands.html#t:DarcsCommand">DarcsCommand</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a><a href="src/Darcs-Commands.html#subusage" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:chompNewline" class="def">chompNewline</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a><a href="src/Darcs-Commands.html#chompNewline" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:extractCommands" class="def">extractCommands</a> :: [<a href="Darcs-Commands.html#t:CommandControl">CommandControl</a>] -> [<a href="Darcs-Commands.html#t:DarcsCommand">DarcsCommand</a>]<a href="src/Darcs-Commands.html#extractCommands" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:superName" class="def">superName</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Darcs-Commands.html#t:DarcsCommand">DarcsCommand</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a><a href="src/Darcs-Commands.html#superName" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:nodefaults" class="def">nodefaults</a> :: [<a href="Darcs-Flags.html#t:DarcsFlag">DarcsFlag</a>] -> <a href="Darcs-RepoPath.html#t:AbsolutePath">AbsolutePath</a> -> [<a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a>] -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/System-IO.html#t:IO">IO</a> [<a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a>]<a href="src/Darcs-Commands.html#nodefaults" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:putInfo" class="def">putInfo</a> :: [<a href="Darcs-Flags.html#t:DarcsFlag">DarcsFlag</a>] -> <a href="Printer.html#t:Doc">Doc</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Tuple.html#t:-40--41-">()</a><a href="src/Darcs-Commands.html#putInfo" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:putVerbose" class="def">putVerbose</a> :: [<a href="Darcs-Flags.html#t:DarcsFlag">DarcsFlag</a>] -> <a href="Printer.html#t:Doc">Doc</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Tuple.html#t:-40--41-">()</a><a href="src/Darcs-Commands.html#putVerbose" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:putWarning" class="def">putWarning</a> :: [<a href="Darcs-Flags.html#t:DarcsFlag">DarcsFlag</a>] -> <a href="Printer.html#t:Doc">Doc</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Tuple.html#t:-40--41-">()</a><a href="src/Darcs-Commands.html#putWarning" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:abortRun" class="def">abortRun</a> :: [<a href="Darcs-Flags.html#t:DarcsFlag">DarcsFlag</a>] -> <a href="Printer.html#t:Doc">Doc</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.5.0.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Tuple.html#t:-40--41-">()</a><a href="src/Darcs-Commands.html#abortRun" class="link">Source</a></p></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.10.0</p></div></body></html>
