<!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>Distribution.Simple.Program</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_Distribution-Simple-Program.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="index.html">Contents</a></li><li><a href="doc-index.html">Index</a></li></ul><p class="caption">Cabal-1.14.0: A framework for packaging Haskell software</p></div><div id="content"><div id="module-header"><table class="info"><tr><th>Portability</th><td>portable</td></tr><tr><th>Maintainer</th><td>cabal-devel@haskell.org</td></tr><tr><th>Safe Haskell</th><td>None</td></tr></table><p class="caption">Distribution.Simple.Program</p></div><div id="table-of-contents"><p class="caption">Contents</p><ul><li><a href="#g:1">Program and functions for constructing them
</a></li><li><a href="#g:2">Configured program and related functions
</a></li><li><a href="#g:3">Program invocations
</a></li><li><a href="#g:4">The collection of unconfigured and configured progams
</a></li><li><a href="#g:5">The collection of configured programs we can run
</a></li><li><a href="#g:6">Programs that Cabal knows about
</a></li><li><a href="#g:7">deprecated
</a></li></ul></div><div id="description"><p class="caption">Description</p><div class="doc"><p>This provides an abstraction which deals with configuring and running
programs. A <code><a href="Distribution-Simple-Program.html#t:Program">Program</a></code> is a static notion of a known program. A
<code><a href="Distribution-Simple-Program.html#t:ConfiguredProgram">ConfiguredProgram</a></code> is a <code><a href="Distribution-Simple-Program.html#t:Program">Program</a></code> that has been found on the current
machine and is ready to be run (possibly with some user-supplied default
args). Configuring a program involves finding its location and if necessary
finding its version. There is also a <code><a href="Distribution-Simple-Program.html#t:ProgramConfiguration">ProgramConfiguration</a></code> type which holds
configured and not-yet configured programs. It is the parameter to lots of
actions elsewhere in Cabal that need to look up and run programs. If we had
a Cabal monad, the <code><a href="Distribution-Simple-Program.html#t:ProgramConfiguration">ProgramConfiguration</a></code> would probably be a reader or
state component of it.
</p><p>The module also defines all the known built-in <code><a href="Distribution-Simple-Program.html#t:Program">Program</a></code>s and the
<code><a href="Distribution-Simple-Program.html#v:defaultProgramConfiguration">defaultProgramConfiguration</a></code> which contains them all.
</p><p>One nice thing about using it is that any program that is
registered with Cabal will get some "configure" and ".cabal"
helpers like --with-foo-args --foo-path= and extra-foo-args.
</p><p>There's also good default behavior for trying to find "foo" in
PATH, being able to override its location, etc.
</p><p>There's also a hook for adding programs in a Setup.lhs script. See
hookedPrograms in <code><a href="Distribution-Simple.html#t:UserHooks">UserHooks</a></code>. This gives a
hook user the ability to get the above flags and such so that they
don't have to write all the PATH logic inside Setup.lhs.
</p></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"><span class="keyword">data</span> <a href="#t:Program">Program</a> = <a href="#v:Program">Program</a> {<ul class="subs"><li><a href="#v:programName">programName</a> :: <a href="../base-4.5.1.0/Data-String.html#t:String">String</a></li><li><a href="#v:programFindLocation">programFindLocation</a> :: <a href="Distribution-Verbosity.html#t:Verbosity">Verbosity</a> -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> (<a href="../base-4.5.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="../base-4.5.1.0/System-IO.html#t:FilePath">FilePath</a>)</li><li><a href="#v:programFindVersion">programFindVersion</a> :: <a href="Distribution-Verbosity.html#t:Verbosity">Verbosity</a> -> <a href="../base-4.5.1.0/System-IO.html#t:FilePath">FilePath</a> -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> (<a href="../base-4.5.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Distribution-Version.html#t:Version">Version</a>)</li><li><a href="#v:programPostConf">programPostConf</a> :: <a href="Distribution-Verbosity.html#t:Verbosity">Verbosity</a> -> <a href="Distribution-Simple-Program.html#t:ConfiguredProgram">ConfiguredProgram</a> -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> [<a href="Distribution-Simple-Program.html#t:ProgArg">ProgArg</a>]</li></ul>}</li><li class="src short"><a href="#v:simpleProgram">simpleProgram</a> :: <a href="../base-4.5.1.0/Data-String.html#t:String">String</a> -> <a href="Distribution-Simple-Program.html#t:Program">Program</a></li><li class="src short"><a href="#v:findProgramLocation">findProgramLocation</a> :: <a href="Distribution-Verbosity.html#t:Verbosity">Verbosity</a> -> <a href="../base-4.5.1.0/System-IO.html#t:FilePath">FilePath</a> -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> (<a href="../base-4.5.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="../base-4.5.1.0/System-IO.html#t:FilePath">FilePath</a>)</li><li class="src short"><a href="#v:findProgramVersion">findProgramVersion</a> :: <a href="../base-4.5.1.0/Data-String.html#t:String">String</a> -> (<a href="../base-4.5.1.0/Data-String.html#t:String">String</a> -> <a href="../base-4.5.1.0/Data-String.html#t:String">String</a>) -> <a href="Distribution-Verbosity.html#t:Verbosity">Verbosity</a> -> <a href="../base-4.5.1.0/System-IO.html#t:FilePath">FilePath</a> -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> (<a href="../base-4.5.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Distribution-Version.html#t:Version">Version</a>)</li><li class="src short"><span class="keyword">data</span> <a href="#t:ConfiguredProgram">ConfiguredProgram</a> = <a href="#v:ConfiguredProgram">ConfiguredProgram</a> {<ul class="subs"><li><a href="#v:programId">programId</a> :: <a href="../base-4.5.1.0/Data-String.html#t:String">String</a></li><li><a href="#v:programVersion">programVersion</a> :: <a href="../base-4.5.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Distribution-Version.html#t:Version">Version</a></li><li><a href="#v:programDefaultArgs">programDefaultArgs</a> :: [<a href="../base-4.5.1.0/Data-String.html#t:String">String</a>]</li><li><a href="#v:programOverrideArgs">programOverrideArgs</a> :: [<a href="../base-4.5.1.0/Data-String.html#t:String">String</a>]</li><li><a href="#v:programLocation">programLocation</a> :: <a href="Distribution-Simple-Program.html#t:ProgramLocation">ProgramLocation</a></li></ul>}</li><li class="src short"><a href="#v:programPath">programPath</a> :: <a href="Distribution-Simple-Program.html#t:ConfiguredProgram">ConfiguredProgram</a> -> <a href="../base-4.5.1.0/System-IO.html#t:FilePath">FilePath</a></li><li class="src short"><span class="keyword">type</span> <a href="#t:ProgArg">ProgArg</a> = <a href="../base-4.5.1.0/Data-String.html#t:String">String</a></li><li class="src short"><span class="keyword">data</span> <a href="#t:ProgramLocation">ProgramLocation</a> <ul class="subs"><li>= <a href="#v:UserSpecified">UserSpecified</a> { <ul class="subs"><li><a href="#v:locationPath">locationPath</a> :: <a href="../base-4.5.1.0/System-IO.html#t:FilePath">FilePath</a></li></ul> }</li><li>| <a href="#v:FoundOnSystem">FoundOnSystem</a> { <ul class="subs"><li><a href="#v:locationPath">locationPath</a> :: <a href="../base-4.5.1.0/System-IO.html#t:FilePath">FilePath</a></li></ul> }</li></ul></li><li class="src short"><a href="#v:runProgram">runProgram</a> :: <a href="Distribution-Verbosity.html#t:Verbosity">Verbosity</a> -> <a href="Distribution-Simple-Program.html#t:ConfiguredProgram">ConfiguredProgram</a> -> [<a href="Distribution-Simple-Program.html#t:ProgArg">ProgArg</a>] -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> ()</li><li class="src short"><a href="#v:getProgramOutput">getProgramOutput</a> :: <a href="Distribution-Verbosity.html#t:Verbosity">Verbosity</a> -> <a href="Distribution-Simple-Program.html#t:ConfiguredProgram">ConfiguredProgram</a> -> [<a href="Distribution-Simple-Program.html#t:ProgArg">ProgArg</a>] -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> <a href="../base-4.5.1.0/Data-String.html#t:String">String</a></li><li class="src short"><span class="keyword">data</span> <a href="#t:ProgramInvocation">ProgramInvocation</a> = <a href="#v:ProgramInvocation">ProgramInvocation</a> {<ul class="subs"><li><a href="#v:progInvokePath">progInvokePath</a> :: <a href="../base-4.5.1.0/System-IO.html#t:FilePath">FilePath</a></li><li><a href="#v:progInvokeArgs">progInvokeArgs</a> :: [<a href="../base-4.5.1.0/Data-String.html#t:String">String</a>]</li><li><a href="#v:progInvokeEnv">progInvokeEnv</a> :: [(<a href="../base-4.5.1.0/Data-String.html#t:String">String</a>, <a href="../base-4.5.1.0/Data-String.html#t:String">String</a>)]</li><li><a href="#v:progInvokeCwd">progInvokeCwd</a> :: <a href="../base-4.5.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="../base-4.5.1.0/System-IO.html#t:FilePath">FilePath</a></li><li><a href="#v:progInvokeInput">progInvokeInput</a> :: <a href="../base-4.5.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="../base-4.5.1.0/Data-String.html#t:String">String</a></li><li><a href="#v:progInvokeInputEncoding">progInvokeInputEncoding</a> :: <a href="Distribution-Simple-Program-Run.html#t:IOEncoding">IOEncoding</a></li><li><a href="#v:progInvokeOutputEncoding">progInvokeOutputEncoding</a> :: <a href="Distribution-Simple-Program-Run.html#t:IOEncoding">IOEncoding</a></li></ul>}</li><li class="src short"><a href="#v:emptyProgramInvocation">emptyProgramInvocation</a> :: <a href="Distribution-Simple-Program.html#t:ProgramInvocation">ProgramInvocation</a></li><li class="src short"><a href="#v:simpleProgramInvocation">simpleProgramInvocation</a> :: <a href="../base-4.5.1.0/System-IO.html#t:FilePath">FilePath</a> -> [<a href="../base-4.5.1.0/Data-String.html#t:String">String</a>] -> <a href="Distribution-Simple-Program.html#t:ProgramInvocation">ProgramInvocation</a></li><li class="src short"><a href="#v:programInvocation">programInvocation</a> :: <a href="Distribution-Simple-Program.html#t:ConfiguredProgram">ConfiguredProgram</a> -> [<a href="../base-4.5.1.0/Data-String.html#t:String">String</a>] -> <a href="Distribution-Simple-Program.html#t:ProgramInvocation">ProgramInvocation</a></li><li class="src short"><a href="#v:runProgramInvocation">runProgramInvocation</a> :: <a href="Distribution-Verbosity.html#t:Verbosity">Verbosity</a> -> <a href="Distribution-Simple-Program.html#t:ProgramInvocation">ProgramInvocation</a> -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> ()</li><li class="src short"><a href="#v:getProgramInvocationOutput">getProgramInvocationOutput</a> :: <a href="Distribution-Verbosity.html#t:Verbosity">Verbosity</a> -> <a href="Distribution-Simple-Program.html#t:ProgramInvocation">ProgramInvocation</a> -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> <a href="../base-4.5.1.0/Data-String.html#t:String">String</a></li><li class="src short"><a href="#v:builtinPrograms">builtinPrograms</a> :: [<a href="Distribution-Simple-Program.html#t:Program">Program</a>]</li><li class="src short"><span class="keyword">type</span> <a href="#t:ProgramConfiguration">ProgramConfiguration</a> = <a href="Distribution-Simple-Program-Db.html#t:ProgramDb">ProgramDb</a></li><li class="src short"><a href="#v:emptyProgramConfiguration">emptyProgramConfiguration</a> :: <a href="Distribution-Simple-Program.html#t:ProgramConfiguration">ProgramConfiguration</a></li><li class="src short"><a href="#v:defaultProgramConfiguration">defaultProgramConfiguration</a> :: <a href="Distribution-Simple-Program.html#t:ProgramConfiguration">ProgramConfiguration</a></li><li class="src short"><a href="#v:restoreProgramConfiguration">restoreProgramConfiguration</a> :: [<a href="Distribution-Simple-Program.html#t:Program">Program</a>] -> <a href="Distribution-Simple-Program.html#t:ProgramConfiguration">ProgramConfiguration</a> -> <a href="Distribution-Simple-Program.html#t:ProgramConfiguration">ProgramConfiguration</a></li><li class="src short"><a href="#v:addKnownProgram">addKnownProgram</a> :: <a href="Distribution-Simple-Program.html#t:Program">Program</a> -> <a href="Distribution-Simple-Program-Db.html#t:ProgramDb">ProgramDb</a> -> <a href="Distribution-Simple-Program-Db.html#t:ProgramDb">ProgramDb</a></li><li class="src short"><a href="#v:addKnownPrograms">addKnownPrograms</a> :: [<a href="Distribution-Simple-Program.html#t:Program">Program</a>] -> <a href="Distribution-Simple-Program-Db.html#t:ProgramDb">ProgramDb</a> -> <a href="Distribution-Simple-Program-Db.html#t:ProgramDb">ProgramDb</a></li><li class="src short"><a href="#v:lookupKnownProgram">lookupKnownProgram</a> :: <a href="../base-4.5.1.0/Data-String.html#t:String">String</a> -> <a href="Distribution-Simple-Program-Db.html#t:ProgramDb">ProgramDb</a> -> <a href="../base-4.5.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Distribution-Simple-Program.html#t:Program">Program</a></li><li class="src short"><a href="#v:knownPrograms">knownPrograms</a> :: <a href="Distribution-Simple-Program-Db.html#t:ProgramDb">ProgramDb</a> -> [(<a href="Distribution-Simple-Program.html#t:Program">Program</a>, <a href="../base-4.5.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Distribution-Simple-Program.html#t:ConfiguredProgram">ConfiguredProgram</a>)]</li><li class="src short"><a href="#v:userSpecifyPath">userSpecifyPath</a> :: <a href="../base-4.5.1.0/Data-String.html#t:String">String</a> -> <a href="../base-4.5.1.0/System-IO.html#t:FilePath">FilePath</a> -> <a href="Distribution-Simple-Program-Db.html#t:ProgramDb">ProgramDb</a> -> <a href="Distribution-Simple-Program-Db.html#t:ProgramDb">ProgramDb</a></li><li class="src short"><a href="#v:userSpecifyPaths">userSpecifyPaths</a> :: [(<a href="../base-4.5.1.0/Data-String.html#t:String">String</a>, <a href="../base-4.5.1.0/System-IO.html#t:FilePath">FilePath</a>)] -> <a href="Distribution-Simple-Program-Db.html#t:ProgramDb">ProgramDb</a> -> <a href="Distribution-Simple-Program-Db.html#t:ProgramDb">ProgramDb</a></li><li class="src short"><a href="#v:userMaybeSpecifyPath">userMaybeSpecifyPath</a> :: <a href="../base-4.5.1.0/Data-String.html#t:String">String</a> -> <a href="../base-4.5.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="../base-4.5.1.0/System-IO.html#t:FilePath">FilePath</a> -> <a href="Distribution-Simple-Program-Db.html#t:ProgramDb">ProgramDb</a> -> <a href="Distribution-Simple-Program-Db.html#t:ProgramDb">ProgramDb</a></li><li class="src short"><a href="#v:userSpecifyArgs">userSpecifyArgs</a> :: <a href="../base-4.5.1.0/Data-String.html#t:String">String</a> -> [<a href="Distribution-Simple-Program.html#t:ProgArg">ProgArg</a>] -> <a href="Distribution-Simple-Program-Db.html#t:ProgramDb">ProgramDb</a> -> <a href="Distribution-Simple-Program-Db.html#t:ProgramDb">ProgramDb</a></li><li class="src short"><a href="#v:userSpecifyArgss">userSpecifyArgss</a> :: [(<a href="../base-4.5.1.0/Data-String.html#t:String">String</a>, [<a href="Distribution-Simple-Program.html#t:ProgArg">ProgArg</a>])] -> <a href="Distribution-Simple-Program-Db.html#t:ProgramDb">ProgramDb</a> -> <a href="Distribution-Simple-Program-Db.html#t:ProgramDb">ProgramDb</a></li><li class="src short"><a href="#v:userSpecifiedArgs">userSpecifiedArgs</a> :: <a href="Distribution-Simple-Program.html#t:Program">Program</a> -> <a href="Distribution-Simple-Program-Db.html#t:ProgramDb">ProgramDb</a> -> [<a href="Distribution-Simple-Program.html#t:ProgArg">ProgArg</a>]</li><li class="src short"><a href="#v:lookupProgram">lookupProgram</a> :: <a href="Distribution-Simple-Program.html#t:Program">Program</a> -> <a href="Distribution-Simple-Program-Db.html#t:ProgramDb">ProgramDb</a> -> <a href="../base-4.5.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Distribution-Simple-Program.html#t:ConfiguredProgram">ConfiguredProgram</a></li><li class="src short"><a href="#v:updateProgram">updateProgram</a> :: <a href="Distribution-Simple-Program.html#t:ConfiguredProgram">ConfiguredProgram</a> -> <a href="Distribution-Simple-Program-Db.html#t:ProgramDb">ProgramDb</a> -> <a href="Distribution-Simple-Program-Db.html#t:ProgramDb">ProgramDb</a></li><li class="src short"><a href="#v:configureProgram">configureProgram</a> :: <a href="Distribution-Verbosity.html#t:Verbosity">Verbosity</a> -> <a href="Distribution-Simple-Program.html#t:Program">Program</a> -> <a href="Distribution-Simple-Program-Db.html#t:ProgramDb">ProgramDb</a> -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> <a href="Distribution-Simple-Program-Db.html#t:ProgramDb">ProgramDb</a></li><li class="src short"><a href="#v:configureAllKnownPrograms">configureAllKnownPrograms</a> :: <a href="Distribution-Verbosity.html#t:Verbosity">Verbosity</a> -> <a href="Distribution-Simple-Program-Db.html#t:ProgramDb">ProgramDb</a> -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> <a href="Distribution-Simple-Program-Db.html#t:ProgramDb">ProgramDb</a></li><li class="src short"><a href="#v:reconfigurePrograms">reconfigurePrograms</a> :: <a href="Distribution-Verbosity.html#t:Verbosity">Verbosity</a> -> [(<a href="../base-4.5.1.0/Data-String.html#t:String">String</a>, <a href="../base-4.5.1.0/System-IO.html#t:FilePath">FilePath</a>)] -> [(<a href="../base-4.5.1.0/Data-String.html#t:String">String</a>, [<a href="Distribution-Simple-Program.html#t:ProgArg">ProgArg</a>])] -> <a href="Distribution-Simple-Program-Db.html#t:ProgramDb">ProgramDb</a> -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> <a href="Distribution-Simple-Program-Db.html#t:ProgramDb">ProgramDb</a></li><li class="src short"><a href="#v:requireProgram">requireProgram</a> :: <a href="Distribution-Verbosity.html#t:Verbosity">Verbosity</a> -> <a href="Distribution-Simple-Program.html#t:Program">Program</a> -> <a href="Distribution-Simple-Program-Db.html#t:ProgramDb">ProgramDb</a> -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> (<a href="Distribution-Simple-Program.html#t:ConfiguredProgram">ConfiguredProgram</a>, <a href="Distribution-Simple-Program-Db.html#t:ProgramDb">ProgramDb</a>)</li><li class="src short"><a href="#v:requireProgramVersion">requireProgramVersion</a> :: <a href="Distribution-Verbosity.html#t:Verbosity">Verbosity</a> -> <a href="Distribution-Simple-Program.html#t:Program">Program</a> -> <a href="Distribution-Version.html#t:VersionRange">VersionRange</a> -> <a href="Distribution-Simple-Program-Db.html#t:ProgramDb">ProgramDb</a> -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> (<a href="Distribution-Simple-Program.html#t:ConfiguredProgram">ConfiguredProgram</a>, <a href="Distribution-Version.html#t:Version">Version</a>, <a href="Distribution-Simple-Program-Db.html#t:ProgramDb">ProgramDb</a>)</li><li class="src short"><a href="#v:runDbProgram">runDbProgram</a> :: <a href="Distribution-Verbosity.html#t:Verbosity">Verbosity</a> -> <a href="Distribution-Simple-Program.html#t:Program">Program</a> -> <a href="Distribution-Simple-Program-Db.html#t:ProgramDb">ProgramDb</a> -> [<a href="Distribution-Simple-Program.html#t:ProgArg">ProgArg</a>] -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> ()</li><li class="src short"><a href="#v:getDbProgramOutput">getDbProgramOutput</a> :: <a href="Distribution-Verbosity.html#t:Verbosity">Verbosity</a> -> <a href="Distribution-Simple-Program.html#t:Program">Program</a> -> <a href="Distribution-Simple-Program-Db.html#t:ProgramDb">ProgramDb</a> -> [<a href="Distribution-Simple-Program.html#t:ProgArg">ProgArg</a>] -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> <a href="../base-4.5.1.0/Data-String.html#t:String">String</a></li><li class="src short"><a href="#v:ghcProgram">ghcProgram</a> :: <a href="Distribution-Simple-Program.html#t:Program">Program</a></li><li class="src short"><a href="#v:ghcPkgProgram">ghcPkgProgram</a> :: <a href="Distribution-Simple-Program.html#t:Program">Program</a></li><li class="src short"><a href="#v:lhcProgram">lhcProgram</a> :: <a href="Distribution-Simple-Program.html#t:Program">Program</a></li><li class="src short"><a href="#v:lhcPkgProgram">lhcPkgProgram</a> :: <a href="Distribution-Simple-Program.html#t:Program">Program</a></li><li class="src short"><a href="#v:nhcProgram">nhcProgram</a> :: <a href="Distribution-Simple-Program.html#t:Program">Program</a></li><li class="src short"><a href="#v:hmakeProgram">hmakeProgram</a> :: <a href="Distribution-Simple-Program.html#t:Program">Program</a></li><li class="src short"><a href="#v:jhcProgram">jhcProgram</a> :: <a href="Distribution-Simple-Program.html#t:Program">Program</a></li><li class="src short"><a href="#v:hugsProgram">hugsProgram</a> :: <a href="Distribution-Simple-Program.html#t:Program">Program</a></li><li class="src short"><a href="#v:ffihugsProgram">ffihugsProgram</a> :: <a href="Distribution-Simple-Program.html#t:Program">Program</a></li><li class="src short"><a href="#v:uhcProgram">uhcProgram</a> :: <a href="Distribution-Simple-Program.html#t:Program">Program</a></li><li class="src short"><a href="#v:gccProgram">gccProgram</a> :: <a href="Distribution-Simple-Program.html#t:Program">Program</a></li><li class="src short"><a href="#v:ranlibProgram">ranlibProgram</a> :: <a href="Distribution-Simple-Program.html#t:Program">Program</a></li><li class="src short"><a href="#v:arProgram">arProgram</a> :: <a href="Distribution-Simple-Program.html#t:Program">Program</a></li><li class="src short"><a href="#v:stripProgram">stripProgram</a> :: <a href="Distribution-Simple-Program.html#t:Program">Program</a></li><li class="src short"><a href="#v:happyProgram">happyProgram</a> :: <a href="Distribution-Simple-Program.html#t:Program">Program</a></li><li class="src short"><a href="#v:alexProgram">alexProgram</a> :: <a href="Distribution-Simple-Program.html#t:Program">Program</a></li><li class="src short"><a href="#v:hsc2hsProgram">hsc2hsProgram</a> :: <a href="Distribution-Simple-Program.html#t:Program">Program</a></li><li class="src short"><a href="#v:c2hsProgram">c2hsProgram</a> :: <a href="Distribution-Simple-Program.html#t:Program">Program</a></li><li class="src short"><a href="#v:cpphsProgram">cpphsProgram</a> :: <a href="Distribution-Simple-Program.html#t:Program">Program</a></li><li class="src short"><a href="#v:hscolourProgram">hscolourProgram</a> :: <a href="Distribution-Simple-Program.html#t:Program">Program</a></li><li class="src short"><a href="#v:haddockProgram">haddockProgram</a> :: <a href="Distribution-Simple-Program.html#t:Program">Program</a></li><li class="src short"><a href="#v:greencardProgram">greencardProgram</a> :: <a href="Distribution-Simple-Program.html#t:Program">Program</a></li><li class="src short"><a href="#v:ldProgram">ldProgram</a> :: <a href="Distribution-Simple-Program.html#t:Program">Program</a></li><li class="src short"><a href="#v:tarProgram">tarProgram</a> :: <a href="Distribution-Simple-Program.html#t:Program">Program</a></li><li class="src short"><a href="#v:cppProgram">cppProgram</a> :: <a href="Distribution-Simple-Program.html#t:Program">Program</a></li><li class="src short"><a href="#v:pkgConfigProgram">pkgConfigProgram</a> :: <a href="Distribution-Simple-Program.html#t:Program">Program</a></li><li class="src short"><a href="#v:hpcProgram">hpcProgram</a> :: <a href="Distribution-Simple-Program.html#t:Program">Program</a></li><li class="src short"><a href="#v:rawSystemProgram">rawSystemProgram</a> :: <a href="Distribution-Verbosity.html#t:Verbosity">Verbosity</a> -> <a href="Distribution-Simple-Program.html#t:ConfiguredProgram">ConfiguredProgram</a> -> [<a href="Distribution-Simple-Program.html#t:ProgArg">ProgArg</a>] -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> ()</li><li class="src short"><a href="#v:rawSystemProgramStdout">rawSystemProgramStdout</a> :: <a href="Distribution-Verbosity.html#t:Verbosity">Verbosity</a> -> <a href="Distribution-Simple-Program.html#t:ConfiguredProgram">ConfiguredProgram</a> -> [<a href="Distribution-Simple-Program.html#t:ProgArg">ProgArg</a>] -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> <a href="../base-4.5.1.0/Data-String.html#t:String">String</a></li><li class="src short"><a href="#v:rawSystemProgramConf">rawSystemProgramConf</a> :: <a href="Distribution-Verbosity.html#t:Verbosity">Verbosity</a> -> <a href="Distribution-Simple-Program.html#t:Program">Program</a> -> <a href="Distribution-Simple-Program.html#t:ProgramConfiguration">ProgramConfiguration</a> -> [<a href="Distribution-Simple-Program.html#t:ProgArg">ProgArg</a>] -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> ()</li><li class="src short"><a href="#v:rawSystemProgramStdoutConf">rawSystemProgramStdoutConf</a> :: <a href="Distribution-Verbosity.html#t:Verbosity">Verbosity</a> -> <a href="Distribution-Simple-Program.html#t:Program">Program</a> -> <a href="Distribution-Simple-Program.html#t:ProgramConfiguration">ProgramConfiguration</a> -> [<a href="Distribution-Simple-Program.html#t:ProgArg">ProgArg</a>] -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> <a href="../base-4.5.1.0/Data-String.html#t:String">String</a></li><li class="src short"><a href="#v:findProgramOnPath">findProgramOnPath</a> :: <a href="../base-4.5.1.0/Data-String.html#t:String">String</a> -> <a href="Distribution-Verbosity.html#t:Verbosity">Verbosity</a> -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> (<a href="../base-4.5.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="../base-4.5.1.0/System-IO.html#t:FilePath">FilePath</a>)</li></ul></div><div id="interface"><h1 id="g:1">Program and functions for constructing them
</h1><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:Program" class="def">Program</a> </p><div class="doc"><p>Represents a program which can be configured.
</p><p>Note: rather than constructing this directly, start with <code><a href="Distribution-Simple-Program.html#v:simpleProgram">simpleProgram</a></code> and
override any extra fields.
</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:Program" class="def">Program</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:programName" class="def">programName</a> :: <a href="../base-4.5.1.0/Data-String.html#t:String">String</a></dt><dd class="doc"><p>The simple name of the program, eg. ghc
</p></dd><dt class="src"><a name="v:programFindLocation" class="def">programFindLocation</a> :: <a href="Distribution-Verbosity.html#t:Verbosity">Verbosity</a> -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> (<a href="../base-4.5.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="../base-4.5.1.0/System-IO.html#t:FilePath">FilePath</a>)</dt><dd class="doc"><p>A function to search for the program if it's location was not
specified by the user. Usually this will just be a
</p></dd><dt class="src"><a name="v:programFindVersion" class="def">programFindVersion</a> :: <a href="Distribution-Verbosity.html#t:Verbosity">Verbosity</a> -> <a href="../base-4.5.1.0/System-IO.html#t:FilePath">FilePath</a> -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> (<a href="../base-4.5.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Distribution-Version.html#t:Version">Version</a>)</dt><dd class="doc"><p>Try to find the version of the program. For many programs this is
not possible or is not necessary so it's ok to return Nothing.
</p></dd><dt class="src"><a name="v:programPostConf" class="def">programPostConf</a> :: <a href="Distribution-Verbosity.html#t:Verbosity">Verbosity</a> -> <a href="Distribution-Simple-Program.html#t:ConfiguredProgram">ConfiguredProgram</a> -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> [<a href="Distribution-Simple-Program.html#t:ProgArg">ProgArg</a>]</dt><dd class="doc"><p>A function to do any additional configuration after we have
located the program (and perhaps identified its version). It is
allowed to return additional flags that will be passed to the
program on every invocation.
</p></dd></dl><div class="clear"></div></div></td></tr></table></div></div><div class="top"><p class="src"><a name="v:simpleProgram" class="def">simpleProgram</a> :: <a href="../base-4.5.1.0/Data-String.html#t:String">String</a> -> <a href="Distribution-Simple-Program.html#t:Program">Program</a></p><div class="doc"><p>Make a simple named program.
</p><p>By default we'll just search for it in the path and not try to find the
version name. You can override these behaviours if necessary, eg:
</p><pre> simpleProgram "foo" { programFindLocation = ... , programFindVersion ... }
</pre></div></div><div class="top"><p class="src"><a name="v:findProgramLocation" class="def">findProgramLocation</a> :: <a href="Distribution-Verbosity.html#t:Verbosity">Verbosity</a> -> <a href="../base-4.5.1.0/System-IO.html#t:FilePath">FilePath</a> -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> (<a href="../base-4.5.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="../base-4.5.1.0/System-IO.html#t:FilePath">FilePath</a>)</p><div class="doc"><p>Look for a program on the path.
</p></div></div><div class="top"><p class="src"><a name="v:findProgramVersion" class="def">findProgramVersion</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="../base-4.5.1.0/Data-String.html#t:String">String</a></td><td class="doc"><p>version args
</p></td></tr><tr><td class="src">-> (<a href="../base-4.5.1.0/Data-String.html#t:String">String</a> -> <a href="../base-4.5.1.0/Data-String.html#t:String">String</a>)</td><td class="doc"><p>function to select version
number from program output
</p></td></tr><tr><td class="src">-> <a href="Distribution-Verbosity.html#t:Verbosity">Verbosity</a></td><td class="doc empty"> </td></tr><tr><td class="src">-> <a href="../base-4.5.1.0/System-IO.html#t:FilePath">FilePath</a></td><td class="doc"><p>location
</p></td></tr><tr><td class="src">-> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> (<a href="../base-4.5.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Distribution-Version.html#t:Version">Version</a>)</td><td class="doc empty"> </td></tr></table></div><div class="doc"><p>Look for a program and try to find it's version number. It can accept
either an absolute path or the name of a program binary, in which case we
will look for the program on the path.
</p></div></div><h1 id="g:2">Configured program and related functions
</h1><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:ConfiguredProgram" class="def">ConfiguredProgram</a> </p><div class="doc"><p>Represents a program which has been configured and is thus ready to be run.
</p><p>These are usually made by configuring a <code><a href="Distribution-Simple-Program.html#t:Program">Program</a></code>, but if you have to
construct one directly then start with <code><a href="Distribution-Simple-Program-Types.html#v:simpleConfiguredProgram">simpleConfiguredProgram</a></code> and
override any extra fields.
</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:ConfiguredProgram" class="def">ConfiguredProgram</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:programId" class="def">programId</a> :: <a href="../base-4.5.1.0/Data-String.html#t:String">String</a></dt><dd class="doc"><p>Just the name again
</p></dd><dt class="src"><a name="v:programVersion" class="def">programVersion</a> :: <a href="../base-4.5.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Distribution-Version.html#t:Version">Version</a></dt><dd class="doc"><p>The version of this program, if it is known.
</p></dd><dt class="src"><a name="v:programDefaultArgs" class="def">programDefaultArgs</a> :: [<a href="../base-4.5.1.0/Data-String.html#t:String">String</a>]</dt><dd class="doc"><p>Default command-line args for this program.
These flags will appear first on the command line, so they can be
overridden by subsequent flags.
</p></dd><dt class="src"><a name="v:programOverrideArgs" class="def">programOverrideArgs</a> :: [<a href="../base-4.5.1.0/Data-String.html#t:String">String</a>]</dt><dd class="doc"><p>Override command-line args for this program.
These flags will appear last on the command line, so they override
all earlier flags.
</p></dd><dt class="src"><a name="v:programLocation" class="def">programLocation</a> :: <a href="Distribution-Simple-Program.html#t:ProgramLocation">ProgramLocation</a></dt><dd class="doc"><p>Location of the program. eg. <code>/usr/bin/ghc-6.4</code>
</p></dd></dl><div class="clear"></div></div></td></tr></table></div><div class="subs instances"><p id="control.i:ConfiguredProgram" class="caption collapser" onclick="toggleSection('i:ConfiguredProgram')">Instances</p><div id="section.i:ConfiguredProgram" class="show"><table><tr><td class="src"><a href="../base-4.5.1.0/Data-Eq.html#t:Eq">Eq</a> <a href="Distribution-Simple-Program.html#t:ConfiguredProgram">ConfiguredProgram</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="../base-4.5.1.0/Text-Read.html#t:Read">Read</a> <a href="Distribution-Simple-Program.html#t:ConfiguredProgram">ConfiguredProgram</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="../base-4.5.1.0/Text-Show.html#t:Show">Show</a> <a href="Distribution-Simple-Program.html#t:ConfiguredProgram">ConfiguredProgram</a></td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><a name="v:programPath" class="def">programPath</a> :: <a href="Distribution-Simple-Program.html#t:ConfiguredProgram">ConfiguredProgram</a> -> <a href="../base-4.5.1.0/System-IO.html#t:FilePath">FilePath</a></p><div class="doc"><p>The full path of a configured program.
</p></div></div><div class="top"><p class="src"><span class="keyword">type</span> <a name="t:ProgArg" class="def">ProgArg</a> = <a href="../base-4.5.1.0/Data-String.html#t:String">String</a></p></div><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:ProgramLocation" class="def">ProgramLocation</a> </p><div class="doc"><p>Where a program was found. Also tells us whether it's specifed by user or
not. This includes not just the path, but the program as well.
</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:UserSpecified" class="def">UserSpecified</a></td><td class="doc"><p>The user gave the path to this program,
eg. --ghc-path=/usr/bin/ghc-6.6
</p></td></tr><tr><td colspan="2"><div class="subs fields"><p class="caption">Fields</p><dl><dt class="src"><a name="v:locationPath" class="def">locationPath</a> :: <a href="../base-4.5.1.0/System-IO.html#t:FilePath">FilePath</a></dt><dd class="doc empty"> </dd></dl><div class="clear"></div></div></td></tr><tr><td class="src"><a name="v:FoundOnSystem" class="def">FoundOnSystem</a></td><td class="doc"><p>The program was found automatically.
</p></td></tr><tr><td colspan="2"><div class="subs fields"><p class="caption">Fields</p><dl><dt class="src"><a name="v:locationPath" class="def">locationPath</a> :: <a href="../base-4.5.1.0/System-IO.html#t:FilePath">FilePath</a></dt><dd class="doc empty"> </dd></dl><div class="clear"></div></div></td></tr></table></div><div class="subs instances"><p id="control.i:ProgramLocation" class="caption collapser" onclick="toggleSection('i:ProgramLocation')">Instances</p><div id="section.i:ProgramLocation" class="show"><table><tr><td class="src"><a href="../base-4.5.1.0/Data-Eq.html#t:Eq">Eq</a> <a href="Distribution-Simple-Program.html#t:ProgramLocation">ProgramLocation</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="../base-4.5.1.0/Text-Read.html#t:Read">Read</a> <a href="Distribution-Simple-Program.html#t:ProgramLocation">ProgramLocation</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="../base-4.5.1.0/Text-Show.html#t:Show">Show</a> <a href="Distribution-Simple-Program.html#t:ProgramLocation">ProgramLocation</a></td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><a name="v:runProgram" class="def">runProgram</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="Distribution-Verbosity.html#t:Verbosity">Verbosity</a></td><td class="doc"><p>Verbosity
</p></td></tr><tr><td class="src">-> <a href="Distribution-Simple-Program.html#t:ConfiguredProgram">ConfiguredProgram</a></td><td class="doc"><p>The program to run
</p></td></tr><tr><td class="src">-> [<a href="Distribution-Simple-Program.html#t:ProgArg">ProgArg</a>]</td><td class="doc"><p>Any <em>extra</em> arguments to add
</p></td></tr><tr><td class="src">-> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> ()</td><td class="doc empty"> </td></tr></table></div><div class="doc"><p>Runs the given configured program.
</p></div></div><div class="top"><p class="src"><a name="v:getProgramOutput" class="def">getProgramOutput</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="Distribution-Verbosity.html#t:Verbosity">Verbosity</a></td><td class="doc"><p>Verbosity
</p></td></tr><tr><td class="src">-> <a href="Distribution-Simple-Program.html#t:ConfiguredProgram">ConfiguredProgram</a></td><td class="doc"><p>The program to run
</p></td></tr><tr><td class="src">-> [<a href="Distribution-Simple-Program.html#t:ProgArg">ProgArg</a>]</td><td class="doc"><p>Any <em>extra</em> arguments to add
</p></td></tr><tr><td class="src">-> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> <a href="../base-4.5.1.0/Data-String.html#t:String">String</a></td><td class="doc empty"> </td></tr></table></div><div class="doc"><p>Runs the given configured program and gets the output.
</p></div></div><h1 id="g:3">Program invocations
</h1><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:ProgramInvocation" class="def">ProgramInvocation</a> </p><div class="doc"><p>Represents a specific invocation of a specific program.
</p><p>This is used as an intermediate type between deciding how to call a program
and actually doing it. This provides the opportunity to the caller to
adjust how the program will be called. These invocations can either be run
directly or turned into shell or batch scripts.
</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:ProgramInvocation" class="def">ProgramInvocation</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:progInvokePath" class="def">progInvokePath</a> :: <a href="../base-4.5.1.0/System-IO.html#t:FilePath">FilePath</a></dt><dd class="doc empty"> </dd><dt class="src"><a name="v:progInvokeArgs" class="def">progInvokeArgs</a> :: [<a href="../base-4.5.1.0/Data-String.html#t:String">String</a>]</dt><dd class="doc empty"> </dd><dt class="src"><a name="v:progInvokeEnv" class="def">progInvokeEnv</a> :: [(<a href="../base-4.5.1.0/Data-String.html#t:String">String</a>, <a href="../base-4.5.1.0/Data-String.html#t:String">String</a>)]</dt><dd class="doc empty"> </dd><dt class="src"><a name="v:progInvokeCwd" class="def">progInvokeCwd</a> :: <a href="../base-4.5.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="../base-4.5.1.0/System-IO.html#t:FilePath">FilePath</a></dt><dd class="doc empty"> </dd><dt class="src"><a name="v:progInvokeInput" class="def">progInvokeInput</a> :: <a href="../base-4.5.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="../base-4.5.1.0/Data-String.html#t:String">String</a></dt><dd class="doc empty"> </dd><dt class="src"><a name="v:progInvokeInputEncoding" class="def">progInvokeInputEncoding</a> :: <a href="Distribution-Simple-Program-Run.html#t:IOEncoding">IOEncoding</a></dt><dd class="doc empty"> </dd><dt class="src"><a name="v:progInvokeOutputEncoding" class="def">progInvokeOutputEncoding</a> :: <a href="Distribution-Simple-Program-Run.html#t:IOEncoding">IOEncoding</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:emptyProgramInvocation" class="def">emptyProgramInvocation</a> :: <a href="Distribution-Simple-Program.html#t:ProgramInvocation">ProgramInvocation</a></p></div><div class="top"><p class="src"><a name="v:simpleProgramInvocation" class="def">simpleProgramInvocation</a> :: <a href="../base-4.5.1.0/System-IO.html#t:FilePath">FilePath</a> -> [<a href="../base-4.5.1.0/Data-String.html#t:String">String</a>] -> <a href="Distribution-Simple-Program.html#t:ProgramInvocation">ProgramInvocation</a></p></div><div class="top"><p class="src"><a name="v:programInvocation" class="def">programInvocation</a> :: <a href="Distribution-Simple-Program.html#t:ConfiguredProgram">ConfiguredProgram</a> -> [<a href="../base-4.5.1.0/Data-String.html#t:String">String</a>] -> <a href="Distribution-Simple-Program.html#t:ProgramInvocation">ProgramInvocation</a></p></div><div class="top"><p class="src"><a name="v:runProgramInvocation" class="def">runProgramInvocation</a> :: <a href="Distribution-Verbosity.html#t:Verbosity">Verbosity</a> -> <a href="Distribution-Simple-Program.html#t:ProgramInvocation">ProgramInvocation</a> -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> ()</p></div><div class="top"><p class="src"><a name="v:getProgramInvocationOutput" class="def">getProgramInvocationOutput</a> :: <a href="Distribution-Verbosity.html#t:Verbosity">Verbosity</a> -> <a href="Distribution-Simple-Program.html#t:ProgramInvocation">ProgramInvocation</a> -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> <a href="../base-4.5.1.0/Data-String.html#t:String">String</a></p></div><h1 id="g:4">The collection of unconfigured and configured progams
</h1><div class="top"><p class="src"><a name="v:builtinPrograms" class="def">builtinPrograms</a> :: [<a href="Distribution-Simple-Program.html#t:Program">Program</a>]</p><div class="doc"><p>The default list of programs.
These programs are typically used internally to Cabal.
</p></div></div><h1 id="g:5">The collection of configured programs we can run
</h1><div class="top"><p class="src"><span class="keyword">type</span> <a name="t:ProgramConfiguration" class="def">ProgramConfiguration</a> = <a href="Distribution-Simple-Program-Db.html#t:ProgramDb">ProgramDb</a></p></div><div class="top"><p class="src"><a name="v:emptyProgramConfiguration" class="def">emptyProgramConfiguration</a> :: <a href="Distribution-Simple-Program.html#t:ProgramConfiguration">ProgramConfiguration</a></p></div><div class="top"><p class="src"><a name="v:defaultProgramConfiguration" class="def">defaultProgramConfiguration</a> :: <a href="Distribution-Simple-Program.html#t:ProgramConfiguration">ProgramConfiguration</a></p></div><div class="top"><p class="src"><a name="v:restoreProgramConfiguration" class="def">restoreProgramConfiguration</a> :: [<a href="Distribution-Simple-Program.html#t:Program">Program</a>] -> <a href="Distribution-Simple-Program.html#t:ProgramConfiguration">ProgramConfiguration</a> -> <a href="Distribution-Simple-Program.html#t:ProgramConfiguration">ProgramConfiguration</a></p></div><div class="top"><p class="src"><a name="v:addKnownProgram" class="def">addKnownProgram</a> :: <a href="Distribution-Simple-Program.html#t:Program">Program</a> -> <a href="Distribution-Simple-Program-Db.html#t:ProgramDb">ProgramDb</a> -> <a href="Distribution-Simple-Program-Db.html#t:ProgramDb">ProgramDb</a></p><div class="doc"><p>Add a known program that we may configure later
</p></div></div><div class="top"><p class="src"><a name="v:addKnownPrograms" class="def">addKnownPrograms</a> :: [<a href="Distribution-Simple-Program.html#t:Program">Program</a>] -> <a href="Distribution-Simple-Program-Db.html#t:ProgramDb">ProgramDb</a> -> <a href="Distribution-Simple-Program-Db.html#t:ProgramDb">ProgramDb</a></p></div><div class="top"><p class="src"><a name="v:lookupKnownProgram" class="def">lookupKnownProgram</a> :: <a href="../base-4.5.1.0/Data-String.html#t:String">String</a> -> <a href="Distribution-Simple-Program-Db.html#t:ProgramDb">ProgramDb</a> -> <a href="../base-4.5.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Distribution-Simple-Program.html#t:Program">Program</a></p></div><div class="top"><p class="src"><a name="v:knownPrograms" class="def">knownPrograms</a> :: <a href="Distribution-Simple-Program-Db.html#t:ProgramDb">ProgramDb</a> -> [(<a href="Distribution-Simple-Program.html#t:Program">Program</a>, <a href="../base-4.5.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Distribution-Simple-Program.html#t:ConfiguredProgram">ConfiguredProgram</a>)]</p></div><div class="top"><p class="src"><a name="v:userSpecifyPath" class="def">userSpecifyPath</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="../base-4.5.1.0/Data-String.html#t:String">String</a></td><td class="doc"><p>Program name
</p></td></tr><tr><td class="src">-> <a href="../base-4.5.1.0/System-IO.html#t:FilePath">FilePath</a></td><td class="doc"><p>user-specified path to the program
</p></td></tr><tr><td class="src">-> <a href="Distribution-Simple-Program-Db.html#t:ProgramDb">ProgramDb</a></td><td class="doc empty"> </td></tr><tr><td class="src">-> <a href="Distribution-Simple-Program-Db.html#t:ProgramDb">ProgramDb</a></td><td class="doc empty"> </td></tr></table></div><div class="doc"><p>User-specify this path. Basically override any path information
for this program in the configuration. If it's not a known
program ignore it.
</p></div></div><div class="top"><p class="src"><a name="v:userSpecifyPaths" class="def">userSpecifyPaths</a> :: [(<a href="../base-4.5.1.0/Data-String.html#t:String">String</a>, <a href="../base-4.5.1.0/System-IO.html#t:FilePath">FilePath</a>)] -> <a href="Distribution-Simple-Program-Db.html#t:ProgramDb">ProgramDb</a> -> <a href="Distribution-Simple-Program-Db.html#t:ProgramDb">ProgramDb</a></p><div class="doc"><p>Like <code><a href="Distribution-Simple-Program.html#v:userSpecifyPath">userSpecifyPath</a></code> but for a list of progs and their paths.
</p></div></div><div class="top"><p class="src"><a name="v:userMaybeSpecifyPath" class="def">userMaybeSpecifyPath</a> :: <a href="../base-4.5.1.0/Data-String.html#t:String">String</a> -> <a href="../base-4.5.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="../base-4.5.1.0/System-IO.html#t:FilePath">FilePath</a> -> <a href="Distribution-Simple-Program-Db.html#t:ProgramDb">ProgramDb</a> -> <a href="Distribution-Simple-Program-Db.html#t:ProgramDb">ProgramDb</a></p></div><div class="top"><p class="src"><a name="v:userSpecifyArgs" class="def">userSpecifyArgs</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="../base-4.5.1.0/Data-String.html#t:String">String</a></td><td class="doc"><p>Program name
</p></td></tr><tr><td class="src">-> [<a href="Distribution-Simple-Program.html#t:ProgArg">ProgArg</a>]</td><td class="doc"><p>user-specified args
</p></td></tr><tr><td class="src">-> <a href="Distribution-Simple-Program-Db.html#t:ProgramDb">ProgramDb</a></td><td class="doc empty"> </td></tr><tr><td class="src">-> <a href="Distribution-Simple-Program-Db.html#t:ProgramDb">ProgramDb</a></td><td class="doc empty"> </td></tr></table></div><div class="doc"><p>User-specify the arguments for this program. Basically override
any args information for this program in the configuration. If it's
not a known program, ignore it..
</p></div></div><div class="top"><p class="src"><a name="v:userSpecifyArgss" class="def">userSpecifyArgss</a> :: [(<a href="../base-4.5.1.0/Data-String.html#t:String">String</a>, [<a href="Distribution-Simple-Program.html#t:ProgArg">ProgArg</a>])] -> <a href="Distribution-Simple-Program-Db.html#t:ProgramDb">ProgramDb</a> -> <a href="Distribution-Simple-Program-Db.html#t:ProgramDb">ProgramDb</a></p><div class="doc"><p>Like <code><a href="Distribution-Simple-Program.html#v:userSpecifyPath">userSpecifyPath</a></code> but for a list of progs and their args.
</p></div></div><div class="top"><p class="src"><a name="v:userSpecifiedArgs" class="def">userSpecifiedArgs</a> :: <a href="Distribution-Simple-Program.html#t:Program">Program</a> -> <a href="Distribution-Simple-Program-Db.html#t:ProgramDb">ProgramDb</a> -> [<a href="Distribution-Simple-Program.html#t:ProgArg">ProgArg</a>]</p><div class="doc"><p>Get any extra args that have been previously specified for a program.
</p></div></div><div class="top"><p class="src"><a name="v:lookupProgram" class="def">lookupProgram</a> :: <a href="Distribution-Simple-Program.html#t:Program">Program</a> -> <a href="Distribution-Simple-Program-Db.html#t:ProgramDb">ProgramDb</a> -> <a href="../base-4.5.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Distribution-Simple-Program.html#t:ConfiguredProgram">ConfiguredProgram</a></p><div class="doc"><p>Try to find a configured program
</p></div></div><div class="top"><p class="src"><a name="v:updateProgram" class="def">updateProgram</a> :: <a href="Distribution-Simple-Program.html#t:ConfiguredProgram">ConfiguredProgram</a> -> <a href="Distribution-Simple-Program-Db.html#t:ProgramDb">ProgramDb</a> -> <a href="Distribution-Simple-Program-Db.html#t:ProgramDb">ProgramDb</a></p><div class="doc"><p>Update a configured program in the database.
</p></div></div><div class="top"><p class="src"><a name="v:configureProgram" class="def">configureProgram</a> :: <a href="Distribution-Verbosity.html#t:Verbosity">Verbosity</a> -> <a href="Distribution-Simple-Program.html#t:Program">Program</a> -> <a href="Distribution-Simple-Program-Db.html#t:ProgramDb">ProgramDb</a> -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> <a href="Distribution-Simple-Program-Db.html#t:ProgramDb">ProgramDb</a></p><div class="doc"><p>Try to configure a specific program. If the program is already included in
the colleciton of unconfigured programs then we use any user-supplied
location and arguments. If the program gets configured sucessfully it gets
added to the configured collection.
</p><p>Note that it is not a failure if the program cannot be configured. It's only
a failure if the user supplied a location and the program could not be found
at that location.
</p><p>The reason for it not being a failure at this stage is that we don't know up
front all the programs we will need, so we try to configure them all.
To verify that a program was actually sucessfully configured use
<code><a href="Distribution-Simple-Program.html#v:requireProgram">requireProgram</a></code>.
</p></div></div><div class="top"><p class="src"><a name="v:configureAllKnownPrograms" class="def">configureAllKnownPrograms</a> :: <a href="Distribution-Verbosity.html#t:Verbosity">Verbosity</a> -> <a href="Distribution-Simple-Program-Db.html#t:ProgramDb">ProgramDb</a> -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> <a href="Distribution-Simple-Program-Db.html#t:ProgramDb">ProgramDb</a></p><div class="doc"><p>Try to configure all the known programs that have not yet been configured.
</p></div></div><div class="top"><p class="src"><a name="v:reconfigurePrograms" class="def">reconfigurePrograms</a> :: <a href="Distribution-Verbosity.html#t:Verbosity">Verbosity</a> -> [(<a href="../base-4.5.1.0/Data-String.html#t:String">String</a>, <a href="../base-4.5.1.0/System-IO.html#t:FilePath">FilePath</a>)] -> [(<a href="../base-4.5.1.0/Data-String.html#t:String">String</a>, [<a href="Distribution-Simple-Program.html#t:ProgArg">ProgArg</a>])] -> <a href="Distribution-Simple-Program-Db.html#t:ProgramDb">ProgramDb</a> -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> <a href="Distribution-Simple-Program-Db.html#t:ProgramDb">ProgramDb</a></p><div class="doc"><p>reconfigure a bunch of programs given new user-specified args. It takes
the same inputs as <code><a href="Distribution-Simple-Program.html#v:userSpecifyPath">userSpecifyPath</a></code> and <code><a href="Distribution-Simple-Program.html#v:userSpecifyArgs">userSpecifyArgs</a></code> and for all progs
with a new path it calls <code><a href="Distribution-Simple-Program.html#v:configureProgram">configureProgram</a></code>.
</p></div></div><div class="top"><p class="src"><a name="v:requireProgram" class="def">requireProgram</a> :: <a href="Distribution-Verbosity.html#t:Verbosity">Verbosity</a> -> <a href="Distribution-Simple-Program.html#t:Program">Program</a> -> <a href="Distribution-Simple-Program-Db.html#t:ProgramDb">ProgramDb</a> -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> (<a href="Distribution-Simple-Program.html#t:ConfiguredProgram">ConfiguredProgram</a>, <a href="Distribution-Simple-Program-Db.html#t:ProgramDb">ProgramDb</a>)</p><div class="doc"><p>Check that a program is configured and available to be run.
</p><p>It raises an exception if the program could not be configured, otherwise
it returns the configured program.
</p></div></div><div class="top"><p class="src"><a name="v:requireProgramVersion" class="def">requireProgramVersion</a> :: <a href="Distribution-Verbosity.html#t:Verbosity">Verbosity</a> -> <a href="Distribution-Simple-Program.html#t:Program">Program</a> -> <a href="Distribution-Version.html#t:VersionRange">VersionRange</a> -> <a href="Distribution-Simple-Program-Db.html#t:ProgramDb">ProgramDb</a> -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> (<a href="Distribution-Simple-Program.html#t:ConfiguredProgram">ConfiguredProgram</a>, <a href="Distribution-Version.html#t:Version">Version</a>, <a href="Distribution-Simple-Program-Db.html#t:ProgramDb">ProgramDb</a>)</p><div class="doc"><p>Check that a program is configured and available to be run.
</p><p>Additionally check that the version of the program number is suitable and
return it. For example you could require <code>AnyVersion</code> or
<code><code>orLaterVersion</code> (<code><a href="Distribution-Version.html#t:Version">Version</a></code> [1,0] [])</code>
</p><p>It raises an exception if the program could not be configured or the version
is unsuitable, otherwise it returns the configured program and its version
number.
</p></div></div><div class="top"><p class="src"><a name="v:runDbProgram" class="def">runDbProgram</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="Distribution-Verbosity.html#t:Verbosity">Verbosity</a></td><td class="doc"><p>verbosity
</p></td></tr><tr><td class="src">-> <a href="Distribution-Simple-Program.html#t:Program">Program</a></td><td class="doc"><p>The program to run
</p></td></tr><tr><td class="src">-> <a href="Distribution-Simple-Program-Db.html#t:ProgramDb">ProgramDb</a></td><td class="doc"><p>look up the program here
</p></td></tr><tr><td class="src">-> [<a href="Distribution-Simple-Program.html#t:ProgArg">ProgArg</a>]</td><td class="doc"><p>Any <em>extra</em> arguments to add
</p></td></tr><tr><td class="src">-> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> ()</td><td class="doc empty"> </td></tr></table></div><div class="doc"><p>Looks up the given program in the program database and runs it.
</p></div></div><div class="top"><p class="src"><a name="v:getDbProgramOutput" class="def">getDbProgramOutput</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="Distribution-Verbosity.html#t:Verbosity">Verbosity</a></td><td class="doc"><p>verbosity
</p></td></tr><tr><td class="src">-> <a href="Distribution-Simple-Program.html#t:Program">Program</a></td><td class="doc"><p>The program to run
</p></td></tr><tr><td class="src">-> <a href="Distribution-Simple-Program-Db.html#t:ProgramDb">ProgramDb</a></td><td class="doc"><p>look up the program here
</p></td></tr><tr><td class="src">-> [<a href="Distribution-Simple-Program.html#t:ProgArg">ProgArg</a>]</td><td class="doc"><p>Any <em>extra</em> arguments to add
</p></td></tr><tr><td class="src">-> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> <a href="../base-4.5.1.0/Data-String.html#t:String">String</a></td><td class="doc empty"> </td></tr></table></div><div class="doc"><p>Looks up the given program in the program database and runs it.
</p></div></div><h1 id="g:6">Programs that Cabal knows about
</h1><div class="top"><p class="src"><a name="v:ghcProgram" class="def">ghcProgram</a> :: <a href="Distribution-Simple-Program.html#t:Program">Program</a></p></div><div class="top"><p class="src"><a name="v:ghcPkgProgram" class="def">ghcPkgProgram</a> :: <a href="Distribution-Simple-Program.html#t:Program">Program</a></p></div><div class="top"><p class="src"><a name="v:lhcProgram" class="def">lhcProgram</a> :: <a href="Distribution-Simple-Program.html#t:Program">Program</a></p></div><div class="top"><p class="src"><a name="v:lhcPkgProgram" class="def">lhcPkgProgram</a> :: <a href="Distribution-Simple-Program.html#t:Program">Program</a></p></div><div class="top"><p class="src"><a name="v:nhcProgram" class="def">nhcProgram</a> :: <a href="Distribution-Simple-Program.html#t:Program">Program</a></p></div><div class="top"><p class="src"><a name="v:hmakeProgram" class="def">hmakeProgram</a> :: <a href="Distribution-Simple-Program.html#t:Program">Program</a></p></div><div class="top"><p class="src"><a name="v:jhcProgram" class="def">jhcProgram</a> :: <a href="Distribution-Simple-Program.html#t:Program">Program</a></p></div><div class="top"><p class="src"><a name="v:hugsProgram" class="def">hugsProgram</a> :: <a href="Distribution-Simple-Program.html#t:Program">Program</a></p></div><div class="top"><p class="src"><a name="v:ffihugsProgram" class="def">ffihugsProgram</a> :: <a href="Distribution-Simple-Program.html#t:Program">Program</a></p></div><div class="top"><p class="src"><a name="v:uhcProgram" class="def">uhcProgram</a> :: <a href="Distribution-Simple-Program.html#t:Program">Program</a></p></div><div class="top"><p class="src"><a name="v:gccProgram" class="def">gccProgram</a> :: <a href="Distribution-Simple-Program.html#t:Program">Program</a></p></div><div class="top"><p class="src"><a name="v:ranlibProgram" class="def">ranlibProgram</a> :: <a href="Distribution-Simple-Program.html#t:Program">Program</a></p></div><div class="top"><p class="src"><a name="v:arProgram" class="def">arProgram</a> :: <a href="Distribution-Simple-Program.html#t:Program">Program</a></p></div><div class="top"><p class="src"><a name="v:stripProgram" class="def">stripProgram</a> :: <a href="Distribution-Simple-Program.html#t:Program">Program</a></p></div><div class="top"><p class="src"><a name="v:happyProgram" class="def">happyProgram</a> :: <a href="Distribution-Simple-Program.html#t:Program">Program</a></p></div><div class="top"><p class="src"><a name="v:alexProgram" class="def">alexProgram</a> :: <a href="Distribution-Simple-Program.html#t:Program">Program</a></p></div><div class="top"><p class="src"><a name="v:hsc2hsProgram" class="def">hsc2hsProgram</a> :: <a href="Distribution-Simple-Program.html#t:Program">Program</a></p></div><div class="top"><p class="src"><a name="v:c2hsProgram" class="def">c2hsProgram</a> :: <a href="Distribution-Simple-Program.html#t:Program">Program</a></p></div><div class="top"><p class="src"><a name="v:cpphsProgram" class="def">cpphsProgram</a> :: <a href="Distribution-Simple-Program.html#t:Program">Program</a></p></div><div class="top"><p class="src"><a name="v:hscolourProgram" class="def">hscolourProgram</a> :: <a href="Distribution-Simple-Program.html#t:Program">Program</a></p></div><div class="top"><p class="src"><a name="v:haddockProgram" class="def">haddockProgram</a> :: <a href="Distribution-Simple-Program.html#t:Program">Program</a></p></div><div class="top"><p class="src"><a name="v:greencardProgram" class="def">greencardProgram</a> :: <a href="Distribution-Simple-Program.html#t:Program">Program</a></p></div><div class="top"><p class="src"><a name="v:ldProgram" class="def">ldProgram</a> :: <a href="Distribution-Simple-Program.html#t:Program">Program</a></p></div><div class="top"><p class="src"><a name="v:tarProgram" class="def">tarProgram</a> :: <a href="Distribution-Simple-Program.html#t:Program">Program</a></p></div><div class="top"><p class="src"><a name="v:cppProgram" class="def">cppProgram</a> :: <a href="Distribution-Simple-Program.html#t:Program">Program</a></p></div><div class="top"><p class="src"><a name="v:pkgConfigProgram" class="def">pkgConfigProgram</a> :: <a href="Distribution-Simple-Program.html#t:Program">Program</a></p></div><div class="top"><p class="src"><a name="v:hpcProgram" class="def">hpcProgram</a> :: <a href="Distribution-Simple-Program.html#t:Program">Program</a></p></div><h1 id="g:7">deprecated
</h1><div class="top"><p class="src"><a name="v:rawSystemProgram" class="def">rawSystemProgram</a> :: <a href="Distribution-Verbosity.html#t:Verbosity">Verbosity</a> -> <a href="Distribution-Simple-Program.html#t:ConfiguredProgram">ConfiguredProgram</a> -> [<a href="Distribution-Simple-Program.html#t:ProgArg">ProgArg</a>] -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> ()</p></div><div class="top"><p class="src"><a name="v:rawSystemProgramStdout" class="def">rawSystemProgramStdout</a> :: <a href="Distribution-Verbosity.html#t:Verbosity">Verbosity</a> -> <a href="Distribution-Simple-Program.html#t:ConfiguredProgram">ConfiguredProgram</a> -> [<a href="Distribution-Simple-Program.html#t:ProgArg">ProgArg</a>] -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> <a href="../base-4.5.1.0/Data-String.html#t:String">String</a></p></div><div class="top"><p class="src"><a name="v:rawSystemProgramConf" class="def">rawSystemProgramConf</a> :: <a href="Distribution-Verbosity.html#t:Verbosity">Verbosity</a> -> <a href="Distribution-Simple-Program.html#t:Program">Program</a> -> <a href="Distribution-Simple-Program.html#t:ProgramConfiguration">ProgramConfiguration</a> -> [<a href="Distribution-Simple-Program.html#t:ProgArg">ProgArg</a>] -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> ()</p></div><div class="top"><p class="src"><a name="v:rawSystemProgramStdoutConf" class="def">rawSystemProgramStdoutConf</a> :: <a href="Distribution-Verbosity.html#t:Verbosity">Verbosity</a> -> <a href="Distribution-Simple-Program.html#t:Program">Program</a> -> <a href="Distribution-Simple-Program.html#t:ProgramConfiguration">ProgramConfiguration</a> -> [<a href="Distribution-Simple-Program.html#t:ProgArg">ProgArg</a>] -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> <a href="../base-4.5.1.0/Data-String.html#t:String">String</a></p></div><div class="top"><p class="src"><a name="v:findProgramOnPath" class="def">findProgramOnPath</a> :: <a href="../base-4.5.1.0/Data-String.html#t:String">String</a> -> <a href="Distribution-Verbosity.html#t:Verbosity">Verbosity</a> -> <a href="../base-4.5.1.0/System-IO.html#t:IO">IO</a> (<a href="../base-4.5.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="../base-4.5.1.0/System-IO.html#t:FilePath">FilePath</a>)</p><div class="doc"><div class="warning"><p>Deprecated: use findProgramLocation instead</p></div></div></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.11.0</p></div></body></html>
distrib
>
Mageia
>
5
>
i586
>
media
>
core-release
>
by-pkgid
>
6e204a966e8c42d976f99a1700ce5f20
>
files
>
2060
