hark-0.2: html/Parsers-CommandLine.html
<!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
>Parsers.CommandLine</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_Parsers-CommandLine.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"
></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"
>Parsers.CommandLine</FONT
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section1"
>Description</TD
></TR
><TR
><TD CLASS="doc"
>this module parses the command line options for the
word count utility
</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%3AdefaultOptions"
>defaultOptions</A
> :: <A HREF="Parsers-CommandLine.html#t%3AOptions"
>Options</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
>getArgs</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3Aoptions"
>options</A
> :: [OptDescr (<A HREF="Parsers-CommandLine.html#t%3AOptions"
>Options</A
> -> IO <A HREF="Parsers-CommandLine.html#t%3AOptions"
>Options</A
>)]</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><SPAN CLASS="keyword"
>data</SPAN
> <A HREF="#t%3AOptions"
>Options</A
> = <A HREF="#v%3AOptions"
>Options</A
> {<TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="recfield"
><A HREF="#v%3AtheQuery"
>theQuery</A
> :: <A HREF="Parsers-CommandLine.html#t%3AQuery"
>Query</A
></TD
></TR
><TR
><TD CLASS="recfield"
><A HREF="#v%3AqueryOpt"
>queryOpt</A
> :: String</TD
></TR
></TABLE
>}</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%3AQuery"
>Query</A
> </TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="decl"
>= <A HREF="#v%3ABinContents"
>BinContents</A
></TD
></TR
><TR
><TD CLASS="decl"
>| <A HREF="#v%3AContents"
>Contents</A
></TD
></TR
><TR
><TD CLASS="decl"
>| <A HREF="#v%3ADependAll"
>DependAll</A
></TD
></TR
><TR
><TD CLASS="decl"
>| <A HREF="#v%3ADependUsed"
>DependUsed</A
></TD
></TR
><TR
><TD CLASS="decl"
>| <A HREF="#v%3ADocContents"
>DocContents</A
></TD
></TR
><TR
><TD CLASS="decl"
>| <A HREF="#v%3AEtcContents"
>EtcContents</A
></TD
></TR
><TR
><TD CLASS="decl"
>| <A HREF="#v%3AIncludeContents"
>IncludeContents</A
></TD
></TR
><TR
><TD CLASS="decl"
>| <A HREF="#v%3ALibContents"
>LibContents</A
></TD
></TR
><TR
><TD CLASS="decl"
>| <A HREF="#v%3ANone"
>None</A
></TD
></TR
><TR
><TD CLASS="decl"
>| <A HREF="#v%3AOwner"
>Owner</A
></TD
></TR
><TR
><TD CLASS="decl"
>| <A HREF="#v%3ASearchShort"
>SearchShort</A
></TD
></TR
><TR
><TD CLASS="decl"
>| <A HREF="#v%3ASearchDetailed"
>SearchDetailed</A
></TD
></TR
><TR
><TD CLASS="decl"
>| <A HREF="#v%3AShareContents"
>ShareContents</A
></TD
></TR
><TR
><TD CLASS="decl"
>| <A HREF="#v%3AUseAll"
>UseAll</A
></TD
></TR
><TR
><TD CLASS="decl"
>| <A HREF="#v%3AUseUsed"
>UseUsed</A
></TD
></TR
><TR
><TD CLASS="decl"
>| <A HREF="#v%3AVersion"
>Version</A
></TD
></TR
></TABLE
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3Ashow_usage"
>show_usage</A
> :: <A HREF="Parsers-CommandLine.html#t%3AOptions"
>Options</A
> -> IO <A HREF="Parsers-CommandLine.html#t%3AOptions"
>Options</A
></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="decl"
><A NAME="v:defaultOptions"
><A NAME="v%3AdefaultOptions"
></A
></A
><B
>defaultOptions</B
> :: <A HREF="Parsers-CommandLine.html#t%3AOptions"
>Options</A
></TD
></TR
><TR
><TD CLASS="doc"
>default selections
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
>getArgs</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:options"
><A NAME="v%3Aoptions"
></A
></A
><B
>options</B
> :: [OptDescr (<A HREF="Parsers-CommandLine.html#t%3AOptions"
>Options</A
> -> IO <A HREF="Parsers-CommandLine.html#t%3AOptions"
>Options</A
>)]</TD
></TR
><TR
><TD CLASS="doc"
>available command line flags
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><SPAN CLASS="keyword"
>data</SPAN
> <A NAME="t:Options"
><A NAME="t%3AOptions"
></A
></A
><B
>Options</B
> </TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="ndoc"
>data structure for keeping track of selected command line options
</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:Options"
><A NAME="v%3AOptions"
></A
></A
><B
>Options</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:theQuery"
><A NAME="v%3AtheQuery"
></A
></A
><B
>theQuery</B
> :: <A HREF="Parsers-CommandLine.html#t%3AQuery"
>Query</A
></TD
><TD CLASS="rdoc"
></TD
></TR
><TR
><TD CLASS="arg"
><A NAME="v:queryOpt"
><A NAME="v%3AqueryOpt"
></A
></A
><B
>queryOpt</B
> :: String</TD
><TD CLASS="rdoc"
></TD
></TR
></TABLE
></TD
></TR
></TABLE
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><SPAN CLASS="keyword"
>data</SPAN
> <A NAME="t:Query"
><A NAME="t%3AQuery"
></A
></A
><B
>Query</B
> </TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="ndoc"
><P
>data structure for keeping track of command
line requests. If only a subset of a package's content
is requested we assume that
</P
><UL
><LI
>binaries are in /usr/bin, /usr/sbin
/bin/, /sbin,
</LI
><LI
>libraries are in /lib/, /lib64,
/usr/lib, /usr/lib64
</LI
><LI
>docs are in /usr/share/doc
</LI
><LI
>for the remainder we provide filters for /etc,
/usr/include, and all of /usr/share
</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:BinContents"
><A NAME="v%3ABinContents"
></A
></A
><B
>BinContents</B
></TD
><TD CLASS="rdoc"
></TD
></TR
><TR
><TD CLASS="arg"
><A NAME="v:Contents"
><A NAME="v%3AContents"
></A
></A
><B
>Contents</B
></TD
><TD CLASS="rdoc"
></TD
></TR
><TR
><TD CLASS="arg"
><A NAME="v:DependAll"
><A NAME="v%3ADependAll"
></A
></A
><B
>DependAll</B
></TD
><TD CLASS="rdoc"
></TD
></TR
><TR
><TD CLASS="arg"
><A NAME="v:DependUsed"
><A NAME="v%3ADependUsed"
></A
></A
><B
>DependUsed</B
></TD
><TD CLASS="rdoc"
></TD
></TR
><TR
><TD CLASS="arg"
><A NAME="v:DocContents"
><A NAME="v%3ADocContents"
></A
></A
><B
>DocContents</B
></TD
><TD CLASS="rdoc"
></TD
></TR
><TR
><TD CLASS="arg"
><A NAME="v:EtcContents"
><A NAME="v%3AEtcContents"
></A
></A
><B
>EtcContents</B
></TD
><TD CLASS="rdoc"
></TD
></TR
><TR
><TD CLASS="arg"
><A NAME="v:IncludeContents"
><A NAME="v%3AIncludeContents"
></A
></A
><B
>IncludeContents</B
></TD
><TD CLASS="rdoc"
></TD
></TR
><TR
><TD CLASS="arg"
><A NAME="v:LibContents"
><A NAME="v%3ALibContents"
></A
></A
><B
>LibContents</B
></TD
><TD CLASS="rdoc"
></TD
></TR
><TR
><TD CLASS="arg"
><A NAME="v:None"
><A NAME="v%3ANone"
></A
></A
><B
>None</B
></TD
><TD CLASS="rdoc"
></TD
></TR
><TR
><TD CLASS="arg"
><A NAME="v:Owner"
><A NAME="v%3AOwner"
></A
></A
><B
>Owner</B
></TD
><TD CLASS="rdoc"
></TD
></TR
><TR
><TD CLASS="arg"
><A NAME="v:SearchShort"
><A NAME="v%3ASearchShort"
></A
></A
><B
>SearchShort</B
></TD
><TD CLASS="rdoc"
></TD
></TR
><TR
><TD CLASS="arg"
><A NAME="v:SearchDetailed"
><A NAME="v%3ASearchDetailed"
></A
></A
><B
>SearchDetailed</B
></TD
><TD CLASS="rdoc"
></TD
></TR
><TR
><TD CLASS="arg"
><A NAME="v:ShareContents"
><A NAME="v%3AShareContents"
></A
></A
><B
>ShareContents</B
></TD
><TD CLASS="rdoc"
></TD
></TR
><TR
><TD CLASS="arg"
><A NAME="v:UseAll"
><A NAME="v%3AUseAll"
></A
></A
><B
>UseAll</B
></TD
><TD CLASS="rdoc"
></TD
></TR
><TR
><TD CLASS="arg"
><A NAME="v:UseUsed"
><A NAME="v%3AUseUsed"
></A
></A
><B
>UseUsed</B
></TD
><TD CLASS="rdoc"
></TD
></TR
><TR
><TD CLASS="arg"
><A NAME="v:Version"
><A NAME="v%3AVersion"
></A
></A
><B
>Version</B
></TD
><TD CLASS="rdoc"
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="section4"
><IMG SRC="minus.gif" CLASS="coll" ONCLICK="toggle(this,'i:Query')" ALT="show/hide"
> Instances</TD
></TR
><TR
><TD CLASS="body"
><DIV ID="i:Query" STYLE="display:block;"
><TABLE CLASS="vanilla" CELLSPACING="1" CELLPADDING="0"
><TR
><TD CLASS="decl"
>Eq <A HREF="Parsers-CommandLine.html#t%3AQuery"
>Query</A
></TD
></TR
></TABLE
></DIV
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:show_usage"
><A NAME="v%3Ashow_usage"
></A
></A
><B
>show_usage</B
> :: <A HREF="Parsers-CommandLine.html#t%3AOptions"
>Options</A
> -> IO <A HREF="Parsers-CommandLine.html#t%3AOptions"
>Options</A
></TD
></TR
><TR
><TD CLASS="doc"
>initiate query to show usage info
</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.4.2</TD
></TR
></TABLE
></BODY
></HTML
>