Sophie

Sophie

distrib > Fedora > 14 > x86_64 > by-pkgid > d124509af43f859ea9fff074ae079c9c > files > 57

ghc-cmdargs-devel-0.7-2.fc14.x86_64.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
>System.Console.CmdArgs.GetOpt</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_System-Console-CmdArgs-GetOpt.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"
>cmdargs-0.7: Command line argument processing</TD
><TD CLASS="topbut"
><A HREF="src/System-Console-CmdArgs-GetOpt.html"
>Source code</A
></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"
>System.Console.CmdArgs.GetOpt</FONT
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section1"
>Description</TD
></TR
><TR
><TD CLASS="doc"
><P
>This provides a compatiblity wrapper to the <TT
>System.Console.GetOpt</TT
> module in <TT
>base</TT
>.
   That module is essentially a Haskell port of the GNU <TT
>getopt</TT
> library.
</P
><P
><EM
>Changes:</EM
> The changes from <TT
>GetOpt</TT
> are listed in the documentation for each function.
</P
></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"
><A HREF="#v%3Aconvert"
>convert</A
> ::  <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t%3AString"
>String</A
> -&gt; [<A HREF="System-Console-CmdArgs-GetOpt.html#t%3AOptDescr"
>OptDescr</A
> a] -&gt; <A HREF="System-Console-CmdArgs-Explicit.html#t%3AMode"
>Mode</A
> ([a], [<A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t%3AString"
>String</A
>])</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AgetOpt"
>getOpt</A
> ::  <A HREF="System-Console-CmdArgs-GetOpt.html#t%3AArgOrder"
>ArgOrder</A
> a -&gt; [<A HREF="System-Console-CmdArgs-GetOpt.html#t%3AOptDescr"
>OptDescr</A
> a] -&gt; [<A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t%3AString"
>String</A
>] -&gt; ([a], [<A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t%3AString"
>String</A
>], [<A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t%3AString"
>String</A
>])</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AgetOpt%27"
>getOpt'</A
> ::  <A HREF="System-Console-CmdArgs-GetOpt.html#t%3AArgOrder"
>ArgOrder</A
> a -&gt; [<A HREF="System-Console-CmdArgs-GetOpt.html#t%3AOptDescr"
>OptDescr</A
> a] -&gt; [<A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t%3AString"
>String</A
>] -&gt; ([a], [<A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t%3AString"
>String</A
>], [<A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t%3AString"
>String</A
>], [<A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t%3AString"
>String</A
>])</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AusageInfo"
>usageInfo</A
> ::  <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t%3AString"
>String</A
> -&gt; [<A HREF="System-Console-CmdArgs-GetOpt.html#t%3AOptDescr"
>OptDescr</A
> a] -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t%3AString"
>String</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><SPAN CLASS="keyword"
>data</SPAN
>  <A HREF="#t%3AArgOrder"
>ArgOrder</A
> a = <A HREF="#v%3APermute"
>Permute</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><SPAN CLASS="keyword"
>data</SPAN
>  <A HREF="#t%3AOptDescr"
>OptDescr</A
> a = <A HREF="#v%3AOption"
>Option</A
> [<A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t%3AChar"
>Char</A
>] [<A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t%3AString"
>String</A
>] (<A HREF="System-Console-CmdArgs-GetOpt.html#t%3AArgDescr"
>ArgDescr</A
> a) <A HREF="/usr/share/doc/ghc/html/libraries/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%3AArgDescr"
>ArgDescr</A
> a </TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="decl"
>= <A HREF="#v%3ANoArg"
>NoArg</A
> a</TD
></TR
><TR
><TD CLASS="decl"
>| <A HREF="#v%3AReqArg"
>ReqArg</A
> (<A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t%3AString"
>String</A
> -&gt; a) <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t%3AString"
>String</A
></TD
></TR
><TR
><TD CLASS="decl"
>| <A HREF="#v%3AOptArg"
>OptArg</A
> (<A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Maybe.html#t%3AMaybe"
>Maybe</A
> <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t%3AString"
>String</A
> -&gt; a) <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t%3AString"
>String</A
></TD
></TR
></TABLE
></TD
></TR
></TABLE
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section1"
>Documentation</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v:convert"
><A NAME="v%3Aconvert"
></A
></A
><B
>convert</B
> ::  <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t%3AString"
>String</A
> -&gt; [<A HREF="System-Console-CmdArgs-GetOpt.html#t%3AOptDescr"
>OptDescr</A
> a] -&gt; <A HREF="System-Console-CmdArgs-Explicit.html#t%3AMode"
>Mode</A
> ([a], [<A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t%3AString"
>String</A
>])</TD
><TD CLASS="declbut"
><A HREF="src/System-Console-CmdArgs-GetOpt.html#convert"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
>Given a help text and a list of option descriptions, generate a <TT
><A HREF="System-Console-CmdArgs-Explicit.html#t%3AMode"
>Mode</A
></TT
>.
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v:getOpt"
><A NAME="v%3AgetOpt"
></A
></A
><B
>getOpt</B
> ::  <A HREF="System-Console-CmdArgs-GetOpt.html#t%3AArgOrder"
>ArgOrder</A
> a -&gt; [<A HREF="System-Console-CmdArgs-GetOpt.html#t%3AOptDescr"
>OptDescr</A
> a] -&gt; [<A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t%3AString"
>String</A
>] -&gt; ([a], [<A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t%3AString"
>String</A
>], [<A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t%3AString"
>String</A
>])</TD
><TD CLASS="declbut"
><A HREF="src/System-Console-CmdArgs-GetOpt.html#getOpt"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
><P
>Process the command-line, and return the list of values that matched
   (and those that didn't). The arguments are:
</P
><UL
><LI
> The order requirements (see <TT
><A HREF="System-Console-CmdArgs-GetOpt.html#t%3AArgOrder"
>ArgOrder</A
></TT
>)
</LI
><LI
> The option descriptions (see <TT
><A HREF="System-Console-CmdArgs-GetOpt.html#t%3AOptDescr"
>OptDescr</A
></TT
>)
</LI
><LI
> The actual command line arguments (presumably got from 
     System.Environment.getArgs).
</LI
></UL
><P
><TT
><A HREF="System-Console-CmdArgs-GetOpt.html#v%3AgetOpt"
>getOpt</A
></TT
> returns a triple consisting of the option arguments, a list
   of non-options, and a list of error messages.
</P
><P
><EM
>Changes:</EM
> The list of errors will contain at most one entry, and if an
   error is present then the other two lists will be empty.
</P
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v:getOpt'"
><A NAME="v%3AgetOpt%27"
></A
></A
><B
>getOpt'</B
> ::  <A HREF="System-Console-CmdArgs-GetOpt.html#t%3AArgOrder"
>ArgOrder</A
> a -&gt; [<A HREF="System-Console-CmdArgs-GetOpt.html#t%3AOptDescr"
>OptDescr</A
> a] -&gt; [<A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t%3AString"
>String</A
>] -&gt; ([a], [<A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t%3AString"
>String</A
>], [<A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t%3AString"
>String</A
>], [<A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t%3AString"
>String</A
>])</TD
><TD CLASS="declbut"
><A HREF="src/System-Console-CmdArgs-GetOpt.html#getOpt%27"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
><EM
>Changes:</EM
> This is exactly the same as <TT
><A HREF="System-Console-CmdArgs-GetOpt.html#v%3AgetOpt"
>getOpt</A
></TT
>, but the 3rd element of the
   tuple (second last) will be an empty list.
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><A NAME="v:usageInfo"
><A NAME="v%3AusageInfo"
></A
></A
><B
>usageInfo</B
> ::  <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t%3AString"
>String</A
> -&gt; [<A HREF="System-Console-CmdArgs-GetOpt.html#t%3AOptDescr"
>OptDescr</A
> a] -&gt; <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t%3AString"
>String</A
></TD
><TD CLASS="declbut"
><A HREF="src/System-Console-CmdArgs-GetOpt.html#usageInfo"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="doc"
>Return a string describing the usage of a command, derived from
   the header (first argument) and the options described by the 
   second argument.
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><SPAN CLASS="keyword"
>data</SPAN
>  <A NAME="t:ArgOrder"
><A NAME="t%3AArgOrder"
></A
></A
><B
>ArgOrder</B
> a </TD
><TD CLASS="declbut"
><A HREF="src/System-Console-CmdArgs-GetOpt.html#ArgOrder"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="ndoc"
><P
>What to do with options following non-options.
</P
><P
><EM
>Changes:</EM
> Only <TT
><A HREF="System-Console-CmdArgs-GetOpt.html#v%3APermute"
>Permute</A
></TT
> is allowed, both <TT
>RequireOrder</TT
> and <TT
>ReturnInOrder</TT
>
   have been removed.
</P
></TD
></TR
><TR
><TD CLASS="section4"
>Constructors</TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="1" CELLPADDING="0"
><TR
><TD CLASS="arg"
><A NAME="v:Permute"
><A NAME="v%3APermute"
></A
></A
><B
>Permute</B
></TD
><TD CLASS="rdoc"
></TD
></TR
></TABLE
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><SPAN CLASS="keyword"
>data</SPAN
>  <A NAME="t:OptDescr"
><A NAME="t%3AOptDescr"
></A
></A
><B
>OptDescr</B
> a </TD
><TD CLASS="declbut"
><A HREF="src/System-Console-CmdArgs-GetOpt.html#OptDescr"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="ndoc"
><P
>Each <TT
><A HREF="System-Console-CmdArgs-GetOpt.html#t%3AOptDescr"
>OptDescr</A
></TT
> describes a single option/flag.
</P
><P
>The arguments to <TT
><A HREF="System-Console-CmdArgs-GetOpt.html#v%3AOption"
>Option</A
></TT
> are:
</P
><UL
><LI
> list of short option characters
</LI
><LI
> list of long option strings (without <A HREF="--.html"
>--</A
>, may not be 1 character long)
</LI
><LI
> argument descriptor
</LI
><LI
> explanation of option for userdata
</LI
></UL
></TD
></TR
><TR
><TD CLASS="section4"
>Constructors</TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="1" CELLPADDING="0"
><TR
><TD CLASS="arg"
><A NAME="v:Option"
><A NAME="v%3AOption"
></A
></A
><B
>Option</B
> [<A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t%3AChar"
>Char</A
>] [<A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t%3AString"
>String</A
>] (<A HREF="System-Console-CmdArgs-GetOpt.html#t%3AArgDescr"
>ArgDescr</A
> a) <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t%3AString"
>String</A
></TD
><TD CLASS="rdoc"
></TD
></TR
></TABLE
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="topdecl"
><TABLE CLASS="declbar"
><TR
><TD CLASS="declname"
><SPAN CLASS="keyword"
>data</SPAN
>  <A NAME="t:ArgDescr"
><A NAME="t%3AArgDescr"
></A
></A
><B
>ArgDescr</B
> a </TD
><TD CLASS="declbut"
><A HREF="src/System-Console-CmdArgs-GetOpt.html#ArgDescr"
>Source</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="ndoc"
>Describes whether an option takes an argument or not, and if so
   how the argument is injected into a value of type <TT
>a</TT
>.
</TD
></TR
><TR
><TD CLASS="section4"
>Constructors</TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="1" CELLPADDING="0"
><TR
><TD CLASS="arg"
><A NAME="v:NoArg"
><A NAME="v%3ANoArg"
></A
></A
><B
>NoArg</B
> a</TD
><TD CLASS="rdoc"
>no argument expected
</TD
></TR
><TR
><TD CLASS="arg"
><A NAME="v:ReqArg"
><A NAME="v%3AReqArg"
></A
></A
><B
>ReqArg</B
> (<A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t%3AString"
>String</A
> -&gt; a) <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t%3AString"
>String</A
></TD
><TD CLASS="rdoc"
>option requires argument
</TD
></TR
><TR
><TD CLASS="arg"
><A NAME="v:OptArg"
><A NAME="v%3AOptArg"
></A
></A
><B
>OptArg</B
> (<A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Maybe.html#t%3AMaybe"
>Maybe</A
> <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t%3AString"
>String</A
> -&gt; a) <A HREF="/usr/share/doc/ghc/html/libraries/base-4.2.0.2/Data-Char.html#t%3AString"
>String</A
></TD
><TD CLASS="rdoc"
>optional argument
</TD
></TR
></TABLE
></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
>

Perl :: Catalyst :: PostgreSQL :: RPM Valid HTML 4.01 Transitional