Sophie: ghc-Cabal-devel-1.8.0.6-8.6.fc14 i686

ghc-Cabal-devel-1.8.0.6-8.6.fc14.i686.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--Rendered using the Haskell Html Library v0.2-->
<HTML
><HEAD
><META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=UTF-8"
><TITLE
>Distribution.Simple.Program.Types</TITLE
><LINK HREF="haddock.css" REL="stylesheet" TYPE="text/css"
><SCRIPT SRC="haddock-util.js" TYPE="text/javascript"
></SCRIPT
><SCRIPT TYPE="text/javascript"
>window.onload = function () {setSynopsis("mini_Distribution-Simple-Program-Types.html")};</SCRIPT
></HEAD
><BODY
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="topbar"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD
><IMG SRC="haskell_icon.gif" WIDTH="16" HEIGHT="16" ALT=" "
></TD
><TD CLASS="title"
>Cabal-1.8.0.6: A framework for packaging Haskell software</TD
><TD CLASS="topbut"
><A HREF="index.html"
>Contents</A
></TD
><TD CLASS="topbut"
><A HREF="doc-index.html"
>Index</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="modulebar"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD
><FONT SIZE="6"
>Distribution.Simple.Program.Types</FONT
></TD
><TD ALIGN="right"
><TABLE CLASS="narrow" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="infohead"
>Portability</TD
><TD CLASS="infoval"
>portable</TD
></TR
><TR
><TD CLASS="infohead"
>Maintainer</TD
><TD CLASS="infoval"
>cabal-devel@haskell.org</TD
></TR
></TABLE
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="section4"
><B
>Contents</B
></TD
></TR
><TR
><TD
><DL
><DT
><A HREF="#1"
>Program and functions for constructing them
</A
></DT
><DT
><A HREF="#2"
>Configured program and related functions
</A
></DT
></DL
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section1"
>Description</TD
></TR
><TR
><TD CLASS="doc"
>This provides an abstraction which deals with configuring and running
 programs. A <TT
><A HREF="Distribution-Simple-Program-Types.html#t%3AProgram"
>Program</A
></TT
> is a static notion of a known program. A
 <TT
><A HREF="Distribution-Simple-Program-Types.html#t%3AConfiguredProgram"
>ConfiguredProgram</A
></TT
> is a <TT
><A HREF="Distribution-Simple-Program-Types.html#t%3AProgram"
>Program</A
></TT
> 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's reasonable default behavior for trying to find
 &quot;foo&quot; in PATH, being able to override its location, etc.
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section1"
>Synopsis</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="decl"
><SPAN CLASS="keyword"
>data</SPAN
>  <A HREF="#t%3AProgram"
>Program</A
>  = <A HREF="#v%3AProgram"
>Program</A
> {<TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="recfield"
><A HREF="#v%3AprogramName"
>programName</A
> :: <A HREF="../base-4.2.0.2/Data-Char.html#t%3AString"
>String</A
></TD
></TR
><TR
><TD CLASS="recfield"
><A HREF="#v%3AprogramFindLocation"
>programFindLocation</A
> :: <A HREF="Distribution-Verbosity.html#t%3AVerbosity"
>Verbosity</A
> -&gt; <A HREF="../base-4.2.0.2/System-IO.html#t%3AIO"
>IO</A
> (<A HREF="../base-4.2.0.2/Data-Maybe.html#t%3AMaybe"
>Maybe</A
> <A HREF="../base-4.2.0.2/System-IO.html#t%3AFilePath"
>FilePath</A
>)</TD
></TR
><TR
><TD CLASS="recfield"
><A HREF="#v%3AprogramFindVersion"
>programFindVersion</A
> :: <A HREF="Distribution-Verbosity.html#t%3AVerbosity"
>Verbosity</A
> -&gt; <A HREF="../base-4.2.0.2/System-IO.html#t%3AFilePath"
>FilePath</A
> -&gt; <A HREF="../base-4.2.0.2/System-IO.html#t%3AIO"
>IO</A
> (<A HREF="../base-4.2.0.2/Data-Maybe.html#t%3AMaybe"
>Maybe</A
> <A HREF="Distribution-Version.html#t%3AVersion"
>Version</A
>)</TD
></TR
><TR
><TD CLASS="recfield"
><A HREF="#v%3AprogramPostConf"
>programPostConf</A
> :: <A HREF="Distribution-Verbosity.html#t%3AVerbosity"
>Verbosity</A
> -&gt; <A HREF="Distribution-Simple-Program-Types.html#t%3AConfiguredProgram"
>ConfiguredProgram</A
> -&gt; <A HREF="../base-4.2.0.2/System-IO.html#t%3AIO"
>IO</A
> [<A HREF="Distribution-Simple-Program-Types.html#t%3AProgArg"
>ProgArg</A
>]</TD
></TR
></TABLE
>}</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AsimpleProgram"
>simpleProgram</A
> :: <A HREF="../base-4.2.0.2/Data-Char.html#t%3AString"
>String</A
> -&gt; <A HREF="Distribution-Simple-Program-Types.html#t%3AProgram"
>Program</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><SPAN CLASS="keyword"
>data</SPAN
>  <A HREF="#t%3AConfiguredProgram"
>ConfiguredProgram</A
>  = <A HREF="#v%3AConfiguredProgram"
>ConfiguredProgram</A
> {<TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="recfield"
><A HREF="#v%3AprogramId"
>programId</A
> :: <A HREF="../base-4.2.0.2/Data-Char.html#t%3AString"
>String</A
></TD
></TR
><TR
><TD CLASS="recfield"
><A HREF="#v%3AprogramVersion"
>programVersion</A
> :: <A HREF="../base-4.2.0.2/Data-Maybe.html#t%3AMaybe"
>Maybe</A
> <A HREF="Distribution-Version.html#t%3AVersion"
>Version</A
></TD
></TR
><TR
><TD CLASS="recfield"
><A HREF="#v%3AprogramArgs"
>programArgs</A
> :: [<A HREF="../base-4.2.0.2/Data-Char.html#t%3AString"
>String</A
>]</TD
></TR
><TR
><TD CLASS="recfield"
><A HREF="#v%3AprogramLocation"
>programLocation</A
> :: <A HREF="Distribution-Simple-Program-Types.html#t%3AProgramLocation"
>ProgramLocation</A
></TD
></TR
></TABLE
>}</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AprogramPath"
>programPath</A
> :: <A HREF="Distribution-Simple-Program-Types.html#t%3AConfiguredProgram"
>ConfiguredProgram</A
> -&gt; <A HREF="../base-4.2.0.2/System-IO.html#t%3AFilePath"
>FilePath</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><SPAN CLASS="keyword"
>type</SPAN
> <A HREF="#t%3AProgArg"
>ProgArg</A
> = <A HREF="../base-4.2.0.2/Data-Char.html#t%3AString"
>String</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="decl"
><SPAN CLASS="keyword"
>data</SPAN
>  <A HREF="#t%3AProgramLocation"
>ProgramLocation</A
>  </TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="decl"
>= <A HREF="#v%3AUserSpecified"
>UserSpecified</A
> {<TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="recfield"
><A HREF="#v%3AlocationPath"
>locationPath</A
> :: <A HREF="../base-4.2.0.2/System-IO.html#t%3AFilePath"
>FilePath</A
></TD
></TR
></TABLE
>}</TD
></TR
><TR
><TD CLASS="decl"
>| <A HREF="#v%3AFoundOnSystem"
>FoundOnSystem</A
> {<TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="recfield"
><A HREF="#v%3AlocationPath"
>locationPath</A
> :: <A HREF="../base-4.2.0.2/System-IO.html#t%3AFilePath"
>FilePath</A
></TD
></TR
></TABLE
>}</TD
></TR
></TABLE
></TD
></TR
></TABLE
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section1"
><A NAME="1"
><A NAME="1"
>Program and functions for constructing them
</A
></A
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><SPAN CLASS="keyword"
>data</SPAN
>  <A NAME="t:Program"
><A NAME="t%3AProgram"
></A
></A
><B
>Program</B
>  </TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="ndoc"
>Represents a program which can be configured.
</TD
></TR
><TR
><TD CLASS="section4"
>Constructors</TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="5" CELLPADDING="0"
><TR
><TD CLASS="arg"
><A NAME="v:Program"
><A NAME="v%3AProgram"
></A
></A
><B
>Program</B
></TD
><TD CLASS="rdoc"
></TD
></TR
><TR
><TD CLASS="body" COLSPAN="2"
><TABLE CLASS="vanilla" CELLSPACING="1" CELLPADDING="0"
><TR
><TD CLASS="arg"
><A NAME="v:programName"
><A NAME="v%3AprogramName"
></A
></A
><B
>programName</B
> :: <A HREF="../base-4.2.0.2/Data-Char.html#t%3AString"
>String</A
></TD
><TD CLASS="rdoc"
>The simple name of the program, eg. ghc
</TD
></TR
><TR
><TD CLASS="arg"
><A NAME="v:programFindLocation"
><A NAME="v%3AprogramFindLocation"
></A
></A
><B
>programFindLocation</B
> :: <A HREF="Distribution-Verbosity.html#t%3AVerbosity"
>Verbosity</A
> -&gt; <A HREF="../base-4.2.0.2/System-IO.html#t%3AIO"
>IO</A
> (<A HREF="../base-4.2.0.2/Data-Maybe.html#t%3AMaybe"
>Maybe</A
> <A HREF="../base-4.2.0.2/System-IO.html#t%3AFilePath"
>FilePath</A
>)</TD
><TD CLASS="rdoc"
>A function to search for the program if it's location was not
 specified by the user. Usually this will just be a
</TD
></TR
><TR
><TD CLASS="arg"
><A NAME="v:programFindVersion"
><A NAME="v%3AprogramFindVersion"
></A
></A
><B
>programFindVersion</B
> :: <A HREF="Distribution-Verbosity.html#t%3AVerbosity"
>Verbosity</A
> -&gt; <A HREF="../base-4.2.0.2/System-IO.html#t%3AFilePath"
>FilePath</A
> -&gt; <A HREF="../base-4.2.0.2/System-IO.html#t%3AIO"
>IO</A
> (<A HREF="../base-4.2.0.2/Data-Maybe.html#t%3AMaybe"
>Maybe</A
> <A HREF="Distribution-Version.html#t%3AVersion"
>Version</A
>)</TD
><TD CLASS="rdoc"
>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.
</TD
></TR
><TR
><TD CLASS="arg"
><A NAME="v:programPostConf"
><A NAME="v%3AprogramPostConf"
></A
></A
><B
>programPostConf</B
> :: <A HREF="Distribution-Verbosity.html#t%3AVerbosity"
>Verbosity</A
> -&gt; <A HREF="Distribution-Simple-Program-Types.html#t%3AConfiguredProgram"
>ConfiguredProgram</A
> -&gt; <A HREF="../base-4.2.0.2/System-IO.html#t%3AIO"
>IO</A
> [<A HREF="Distribution-Simple-Program-Types.html#t%3AProgArg"
>ProgArg</A
>]</TD
><TD CLASS="rdoc"
>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.
</TD
></TR
></TABLE
></TD
></TR
></TABLE
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:simpleProgram"
><A NAME="v%3AsimpleProgram"
></A
></A
><B
>simpleProgram</B
> :: <A HREF="../base-4.2.0.2/Data-Char.html#t%3AString"
>String</A
> -&gt; <A HREF="Distribution-Simple-Program-Types.html#t%3AProgram"
>Program</A
></TD
></TR
><TR
><TD 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 &quot;foo&quot; { programFindLocation = ... , programFindVersion ... }
</PRE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section1"
><A NAME="2"
><A NAME="2"
>Configured program and related functions
</A
></A
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><SPAN CLASS="keyword"
>data</SPAN
>  <A NAME="t:ConfiguredProgram"
><A NAME="t%3AConfiguredProgram"
></A
></A
><B
>ConfiguredProgram</B
>  </TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="section4"
>Constructors</TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="5" CELLPADDING="0"
><TR
><TD CLASS="arg"
><A NAME="v:ConfiguredProgram"
><A NAME="v%3AConfiguredProgram"
></A
></A
><B
>ConfiguredProgram</B
></TD
><TD CLASS="rdoc"
></TD
></TR
><TR
><TD CLASS="body" COLSPAN="2"
><TABLE CLASS="vanilla" CELLSPACING="1" CELLPADDING="0"
><TR
><TD CLASS="arg"
><A NAME="v:programId"
><A NAME="v%3AprogramId"
></A
></A
><B
>programId</B
> :: <A HREF="../base-4.2.0.2/Data-Char.html#t%3AString"
>String</A
></TD
><TD CLASS="rdoc"
>Just the name again
</TD
></TR
><TR
><TD CLASS="arg"
><A NAME="v:programVersion"
><A NAME="v%3AprogramVersion"
></A
></A
><B
>programVersion</B
> :: <A HREF="../base-4.2.0.2/Data-Maybe.html#t%3AMaybe"
>Maybe</A
> <A HREF="Distribution-Version.html#t%3AVersion"
>Version</A
></TD
><TD CLASS="rdoc"
>The version of this program, if it is known.
</TD
></TR
><TR
><TD CLASS="arg"
><A NAME="v:programArgs"
><A NAME="v%3AprogramArgs"
></A
></A
><B
>programArgs</B
> :: [<A HREF="../base-4.2.0.2/Data-Char.html#t%3AString"
>String</A
>]</TD
><TD CLASS="rdoc"
>Default command-line args for this program.
 These flags will appear first on the command line, so they can be
 overridden by subsequent flags.
</TD
></TR
><TR
><TD CLASS="arg"
><A NAME="v:programLocation"
><A NAME="v%3AprogramLocation"
></A
></A
><B
>programLocation</B
> :: <A HREF="Distribution-Simple-Program-Types.html#t%3AProgramLocation"
>ProgramLocation</A
></TD
><TD CLASS="rdoc"
>Location of the program. eg. <TT
>/usr/bin/ghc-6.4</TT
>
</TD
></TR
></TABLE
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="section4"
><IMG SRC="minus.gif" CLASS="coll" ONCLICK="toggle(this,'i:ConfiguredProgram')" ALT="show/hide"
> Instances</TD
></TR
><TR
><TD CLASS="body"
><DIV ID="i:ConfiguredProgram" STYLE="display:block;"
><TABLE CLASS="vanilla" CELLSPACING="1" CELLPADDING="0"
><TR
><TD CLASS="decl"
><A HREF="../base-4.2.0.2/Data-Eq.html#t%3AEq"
>Eq</A
> <A HREF="Distribution-Simple-Program-Types.html#t%3AConfiguredProgram"
>ConfiguredProgram</A
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="../base-4.2.0.2/Text-Read.html#t%3ARead"
>Read</A
> <A HREF="Distribution-Simple-Program-Types.html#t%3AConfiguredProgram"
>ConfiguredProgram</A
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="../base-4.2.0.2/Text-Show.html#t%3AShow"
>Show</A
> <A HREF="Distribution-Simple-Program-Types.html#t%3AConfiguredProgram"
>ConfiguredProgram</A
></TD
></TR
></TABLE
></DIV
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:programPath"
><A NAME="v%3AprogramPath"
></A
></A
><B
>programPath</B
> :: <A HREF="Distribution-Simple-Program-Types.html#t%3AConfiguredProgram"
>ConfiguredProgram</A
> -&gt; <A HREF="../base-4.2.0.2/System-IO.html#t%3AFilePath"
>FilePath</A
></TD
></TR
><TR
><TD CLASS="doc"
>The full path of a configured program.
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><SPAN CLASS="keyword"
>type</SPAN
> <A NAME="t:ProgArg"
><A NAME="t%3AProgArg"
></A
></A
><B
>ProgArg</B
> = <A HREF="../base-4.2.0.2/Data-Char.html#t%3AString"
>String</A
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><SPAN CLASS="keyword"
>data</SPAN
>  <A NAME="t:ProgramLocation"
><A NAME="t%3AProgramLocation"
></A
></A
><B
>ProgramLocation</B
>  </TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="ndoc"
>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.
</TD
></TR
><TR
><TD CLASS="section4"
>Constructors</TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="5" CELLPADDING="0"
><TR
><TD CLASS="arg"
><A NAME="v:UserSpecified"
><A NAME="v%3AUserSpecified"
></A
></A
><B
>UserSpecified</B
></TD
><TD CLASS="rdoc"
>The user gave the path to this program,
 eg. --ghc-path=/usr/bin/ghc-6.6
</TD
></TR
><TR
><TD CLASS="body" COLSPAN="2"
><TABLE CLASS="vanilla" CELLSPACING="1" CELLPADDING="0"
><TR
><TD CLASS="arg"
><A NAME="v:locationPath"
><A NAME="v%3AlocationPath"
></A
></A
><B
>locationPath</B
> :: <A HREF="../base-4.2.0.2/System-IO.html#t%3AFilePath"
>FilePath</A
></TD
><TD CLASS="rdoc"
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="arg"
><A NAME="v:FoundOnSystem"
><A NAME="v%3AFoundOnSystem"
></A
></A
><B
>FoundOnSystem</B
></TD
><TD CLASS="rdoc"
>The location of the program, as located by searching PATH.
</TD
></TR
><TR
><TD CLASS="body" COLSPAN="2"
><TABLE CLASS="vanilla" CELLSPACING="1" CELLPADDING="0"
><TR
><TD CLASS="arg"
><A NAME="v:locationPath"
><A NAME="v%3AlocationPath"
></A
></A
><B
>locationPath</B
> :: <A HREF="../base-4.2.0.2/System-IO.html#t%3AFilePath"
>FilePath</A
></TD
><TD CLASS="rdoc"
></TD
></TR
></TABLE
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="section4"
><IMG SRC="minus.gif" CLASS="coll" ONCLICK="toggle(this,'i:ProgramLocation')" ALT="show/hide"
> Instances</TD
></TR
><TR
><TD CLASS="body"
><DIV ID="i:ProgramLocation" STYLE="display:block;"
><TABLE CLASS="vanilla" CELLSPACING="1" CELLPADDING="0"
><TR
><TD CLASS="decl"
><A HREF="../base-4.2.0.2/Data-Eq.html#t%3AEq"
>Eq</A
> <A HREF="Distribution-Simple-Program-Types.html#t%3AProgramLocation"
>ProgramLocation</A
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="../base-4.2.0.2/Text-Read.html#t%3ARead"
>Read</A
> <A HREF="Distribution-Simple-Program-Types.html#t%3AProgramLocation"
>ProgramLocation</A
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="../base-4.2.0.2/Text-Show.html#t%3AShow"
>Show</A
> <A HREF="Distribution-Simple-Program-Types.html#t%3AProgramLocation"
>ProgramLocation</A
></TD
></TR
></TABLE
></DIV
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="botbar"
>Produced by <A HREF="http://www.haskell.org/haddock/"
>Haddock</A
> version 2.6.1</TD
></TR
></TABLE
></BODY
></HTML
>