<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<head>
<!-- Generated by HsColour, http://www.cs.york.ac.uk/fp/darcs/hscolour/ -->
<title>src/Haddock/Options.hs</title>
<link type='text/css' rel='stylesheet' href='hscolour.css' />
</head>
<body>
<pre><a name="line-1"></a><span class='hs-comment'>-----------------------------------------------------------------------------</span>
<a name="line-2"></a><span class='hs-comment'>-- |</span>
<a name="line-3"></a><span class='hs-comment'>-- Module : Haddock.Options</span>
<a name="line-4"></a><span class='hs-comment'>-- Copyright : (c) Simon Marlow 2003-2006,</span>
<a name="line-5"></a><span class='hs-comment'>-- David Waern 2006-2009</span>
<a name="line-6"></a><span class='hs-comment'>-- License : BSD-like</span>
<a name="line-7"></a><span class='hs-comment'>--</span>
<a name="line-8"></a><span class='hs-comment'>-- Maintainer : haddock@projects.haskell.org</span>
<a name="line-9"></a><span class='hs-comment'>-- Stability : experimental</span>
<a name="line-10"></a><span class='hs-comment'>-- Portability : portable</span>
<a name="line-11"></a><span class='hs-comment'>--</span>
<a name="line-12"></a><span class='hs-comment'>-- Definition of the command line interface of Haddock</span>
<a name="line-13"></a><span class='hs-comment'>-----------------------------------------------------------------------------</span>
<a name="line-14"></a>
<a name="line-15"></a>
<a name="line-16"></a><span class='hs-keyword'>module</span> <span class='hs-conid'>Haddock</span><span class='hs-varop'>.</span><span class='hs-conid'>Options</span> <span class='hs-layout'>(</span>
<a name="line-17"></a> <span class='hs-varid'>parseHaddockOpts</span><span class='hs-layout'>,</span>
<a name="line-18"></a> <span class='hs-conid'>Flag</span><span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span>
<a name="line-19"></a> <span class='hs-varid'>getUsage</span><span class='hs-layout'>,</span>
<a name="line-20"></a> <span class='hs-varid'>ghcFlags</span><span class='hs-layout'>,</span>
<a name="line-21"></a> <span class='hs-varid'>ifacePairs</span>
<a name="line-22"></a><span class='hs-layout'>)</span> <span class='hs-keyword'>where</span>
<a name="line-23"></a>
<a name="line-24"></a>
<a name="line-25"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Haddock</span><span class='hs-varop'>.</span><span class='hs-conid'>Utils</span>
<a name="line-26"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Haddock</span><span class='hs-varop'>.</span><span class='hs-conid'>Types</span>
<a name="line-27"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>System</span><span class='hs-varop'>.</span><span class='hs-conid'>Console</span><span class='hs-varop'>.</span><span class='hs-conid'>GetOpt</span>
<a name="line-28"></a>
<a name="line-29"></a>
<a name="line-30"></a><a name="getUsage"></a><span class='hs-definition'>getUsage</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>IO</span> <span class='hs-conid'>String</span>
<a name="line-31"></a><span class='hs-definition'>getUsage</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span>
<a name="line-32"></a> <span class='hs-varid'>prog</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>getProgramName</span>
<a name="line-33"></a> <span class='hs-varid'>return</span> <span class='hs-varop'>$</span> <span class='hs-varid'>usageInfo</span> <span class='hs-layout'>(</span><span class='hs-varid'>usageHeader</span> <span class='hs-varid'>prog</span><span class='hs-layout'>)</span> <span class='hs-layout'>(</span><span class='hs-varid'>options</span> <span class='hs-conid'>False</span><span class='hs-layout'>)</span>
<a name="line-34"></a> <span class='hs-keyword'>where</span>
<a name="line-35"></a> <span class='hs-varid'>usageHeader</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>String</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>String</span>
<a name="line-36"></a> <span class='hs-varid'>usageHeader</span> <span class='hs-varid'>prog</span> <span class='hs-keyglyph'>=</span> <span class='hs-str'>"Usage: "</span> <span class='hs-varop'>++</span> <span class='hs-varid'>prog</span> <span class='hs-varop'>++</span> <span class='hs-str'>" [OPTION...] file...\n"</span>
<a name="line-37"></a>
<a name="line-38"></a>
<a name="line-39"></a><a name="parseHaddockOpts"></a><span class='hs-definition'>parseHaddockOpts</span> <span class='hs-keyglyph'>::</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>String</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>[</span><span class='hs-conid'>Flag</span><span class='hs-keyglyph'>]</span><span class='hs-layout'>,</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>String</span><span class='hs-keyglyph'>]</span><span class='hs-layout'>)</span>
<a name="line-40"></a><span class='hs-definition'>parseHaddockOpts</span> <span class='hs-varid'>params</span> <span class='hs-keyglyph'>=</span>
<a name="line-41"></a> <span class='hs-keyword'>case</span> <span class='hs-varid'>getOpt</span> <span class='hs-conid'>Permute</span> <span class='hs-layout'>(</span><span class='hs-varid'>options</span> <span class='hs-conid'>True</span><span class='hs-layout'>)</span> <span class='hs-varid'>params</span> <span class='hs-keyword'>of</span>
<a name="line-42"></a> <span class='hs-layout'>(</span><span class='hs-varid'>flags</span><span class='hs-layout'>,</span> <span class='hs-varid'>args</span><span class='hs-layout'>,</span> <span class='hs-conid'>[]</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>return</span> <span class='hs-layout'>(</span><span class='hs-varid'>flags</span><span class='hs-layout'>,</span> <span class='hs-varid'>args</span><span class='hs-layout'>)</span>
<a name="line-43"></a> <span class='hs-layout'>(</span><span class='hs-keyword'>_</span><span class='hs-layout'>,</span> <span class='hs-keyword'>_</span><span class='hs-layout'>,</span> <span class='hs-varid'>errors</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyword'>do</span>
<a name="line-44"></a> <span class='hs-varid'>usage</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>getUsage</span>
<a name="line-45"></a> <span class='hs-varid'>throwE</span> <span class='hs-layout'>(</span><span class='hs-varid'>concat</span> <span class='hs-varid'>errors</span> <span class='hs-varop'>++</span> <span class='hs-varid'>usage</span><span class='hs-layout'>)</span>
<a name="line-46"></a>
<a name="line-47"></a>
<a name="line-48"></a><a name="ghcFlags"></a><span class='hs-definition'>ghcFlags</span> <span class='hs-keyglyph'>::</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>Flag</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>String</span><span class='hs-keyglyph'>]</span>
<a name="line-49"></a><span class='hs-definition'>ghcFlags</span> <span class='hs-varid'>flags</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyglyph'>[</span> <span class='hs-varid'>option</span> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>Flag_OptGhc</span> <span class='hs-varid'>option</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>flags</span> <span class='hs-keyglyph'>]</span>
<a name="line-50"></a>
<a name="line-51"></a>
<a name="line-52"></a><a name="ifacePairs"></a><span class='hs-definition'>ifacePairs</span> <span class='hs-keyglyph'>::</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>Flag</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyglyph'>[</span><span class='hs-layout'>(</span><span class='hs-conid'>FilePath</span><span class='hs-layout'>,</span> <span class='hs-conid'>FilePath</span><span class='hs-layout'>)</span><span class='hs-keyglyph'>]</span>
<a name="line-53"></a><span class='hs-definition'>ifacePairs</span> <span class='hs-varid'>flags</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyglyph'>[</span> <span class='hs-varid'>parseIfaceOption</span> <span class='hs-varid'>s</span> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>Flag_ReadInterface</span> <span class='hs-varid'>s</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>flags</span> <span class='hs-keyglyph'>]</span>
<a name="line-54"></a>
<a name="line-55"></a>
<a name="line-56"></a><a name="parseIfaceOption"></a><span class='hs-definition'>parseIfaceOption</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>String</span> <span class='hs-keyglyph'>-></span> <span class='hs-layout'>(</span><span class='hs-conid'>FilePath</span><span class='hs-layout'>,</span> <span class='hs-conid'>FilePath</span><span class='hs-layout'>)</span>
<a name="line-57"></a><span class='hs-definition'>parseIfaceOption</span> <span class='hs-varid'>s</span> <span class='hs-keyglyph'>=</span>
<a name="line-58"></a> <span class='hs-keyword'>case</span> <span class='hs-varid'>break</span> <span class='hs-layout'>(</span><span class='hs-varop'>==</span><span class='hs-chr'>','</span><span class='hs-layout'>)</span> <span class='hs-varid'>s</span> <span class='hs-keyword'>of</span>
<a name="line-59"></a> <span class='hs-layout'>(</span><span class='hs-varid'>fpath</span><span class='hs-layout'>,</span><span class='hs-chr'>','</span><span class='hs-conop'>:</span><span class='hs-varid'>file</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-layout'>(</span><span class='hs-varid'>fpath</span><span class='hs-layout'>,</span> <span class='hs-varid'>file</span><span class='hs-layout'>)</span>
<a name="line-60"></a> <span class='hs-layout'>(</span><span class='hs-varid'>file</span><span class='hs-layout'>,</span> <span class='hs-keyword'>_</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-layout'>(</span><span class='hs-str'>""</span><span class='hs-layout'>,</span> <span class='hs-varid'>file</span><span class='hs-layout'>)</span>
<a name="line-61"></a>
<a name="line-62"></a>
<a name="line-63"></a><a name="Flag"></a><span class='hs-keyword'>data</span> <span class='hs-conid'>Flag</span>
<a name="line-64"></a> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Flag_CSS</span> <span class='hs-conid'>String</span>
<a name="line-65"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>Flag_Debug</span>
<a name="line-66"></a><span class='hs-comment'>-- | Flag_DocBook</span>
<a name="line-67"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>Flag_ReadInterface</span> <span class='hs-conid'>String</span>
<a name="line-68"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>Flag_DumpInterface</span> <span class='hs-conid'>String</span>
<a name="line-69"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>Flag_Heading</span> <span class='hs-conid'>String</span>
<a name="line-70"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>Flag_Html</span>
<a name="line-71"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>Flag_Hoogle</span>
<a name="line-72"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>Flag_HtmlHelp</span> <span class='hs-conid'>String</span>
<a name="line-73"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>Flag_Lib</span> <span class='hs-conid'>String</span>
<a name="line-74"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>Flag_OutputDir</span> <span class='hs-conid'>FilePath</span>
<a name="line-75"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>Flag_Prologue</span> <span class='hs-conid'>FilePath</span>
<a name="line-76"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>Flag_SourceBaseURL</span> <span class='hs-conid'>String</span>
<a name="line-77"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>Flag_SourceModuleURL</span> <span class='hs-conid'>String</span>
<a name="line-78"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>Flag_SourceEntityURL</span> <span class='hs-conid'>String</span>
<a name="line-79"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>Flag_WikiBaseURL</span> <span class='hs-conid'>String</span>
<a name="line-80"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>Flag_WikiModuleURL</span> <span class='hs-conid'>String</span>
<a name="line-81"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>Flag_WikiEntityURL</span> <span class='hs-conid'>String</span>
<a name="line-82"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>Flag_Help</span>
<a name="line-83"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>Flag_Verbosity</span> <span class='hs-conid'>String</span>
<a name="line-84"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>Flag_Version</span>
<a name="line-85"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>Flag_UseContents</span> <span class='hs-conid'>String</span>
<a name="line-86"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>Flag_GenContents</span>
<a name="line-87"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>Flag_UseIndex</span> <span class='hs-conid'>String</span>
<a name="line-88"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>Flag_GenIndex</span>
<a name="line-89"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>Flag_IgnoreAllExports</span>
<a name="line-90"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>Flag_HideModule</span> <span class='hs-conid'>String</span>
<a name="line-91"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>Flag_OptGhc</span> <span class='hs-conid'>String</span>
<a name="line-92"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>Flag_GhcLibDir</span> <span class='hs-conid'>String</span>
<a name="line-93"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>Flag_GhcVersion</span>
<a name="line-94"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>Flag_PrintGhcLibDir</span>
<a name="line-95"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>Flag_NoWarnings</span>
<a name="line-96"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>Flag_UseUnicode</span>
<a name="line-97"></a> <span class='hs-keyword'>deriving</span> <span class='hs-layout'>(</span><span class='hs-conid'>Eq</span><span class='hs-layout'>)</span>
<a name="line-98"></a>
<a name="line-99"></a>
<a name="line-100"></a><a name="options"></a><span class='hs-definition'>options</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Bool</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>OptDescr</span> <span class='hs-conid'>Flag</span><span class='hs-keyglyph'>]</span>
<a name="line-101"></a><span class='hs-definition'>options</span> <span class='hs-varid'>backwardsCompat</span> <span class='hs-keyglyph'>=</span>
<a name="line-102"></a> <span class='hs-keyglyph'>[</span>
<a name="line-103"></a> <span class='hs-conid'>Option</span> <span class='hs-keyglyph'>[</span><span class='hs-chr'>'B'</span><span class='hs-keyglyph'>]</span> <span class='hs-conid'>[]</span> <span class='hs-layout'>(</span><span class='hs-conid'>ReqArg</span> <span class='hs-conid'>Flag_GhcLibDir</span> <span class='hs-str'>"DIR"</span><span class='hs-layout'>)</span>
<a name="line-104"></a> <span class='hs-str'>"path to a GHC lib dir, to override the default path"</span><span class='hs-layout'>,</span>
<a name="line-105"></a> <span class='hs-conid'>Option</span> <span class='hs-keyglyph'>[</span><span class='hs-chr'>'o'</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>[</span><span class='hs-str'>"odir"</span><span class='hs-keyglyph'>]</span> <span class='hs-layout'>(</span><span class='hs-conid'>ReqArg</span> <span class='hs-conid'>Flag_OutputDir</span> <span class='hs-str'>"DIR"</span><span class='hs-layout'>)</span>
<a name="line-106"></a> <span class='hs-str'>"directory in which to put the output files"</span><span class='hs-layout'>,</span>
<a name="line-107"></a> <span class='hs-conid'>Option</span> <span class='hs-keyglyph'>[</span><span class='hs-chr'>'l'</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>[</span><span class='hs-str'>"lib"</span><span class='hs-keyglyph'>]</span> <span class='hs-layout'>(</span><span class='hs-conid'>ReqArg</span> <span class='hs-conid'>Flag_Lib</span> <span class='hs-str'>"DIR"</span><span class='hs-layout'>)</span>
<a name="line-108"></a> <span class='hs-str'>"location of Haddock's auxiliary files"</span><span class='hs-layout'>,</span>
<a name="line-109"></a> <span class='hs-conid'>Option</span> <span class='hs-keyglyph'>[</span><span class='hs-chr'>'i'</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>[</span><span class='hs-str'>"read-interface"</span><span class='hs-keyglyph'>]</span> <span class='hs-layout'>(</span><span class='hs-conid'>ReqArg</span> <span class='hs-conid'>Flag_ReadInterface</span> <span class='hs-str'>"FILE"</span><span class='hs-layout'>)</span>
<a name="line-110"></a> <span class='hs-str'>"read an interface from FILE"</span><span class='hs-layout'>,</span>
<a name="line-111"></a> <span class='hs-conid'>Option</span> <span class='hs-keyglyph'>[</span><span class='hs-chr'>'D'</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>[</span><span class='hs-str'>"dump-interface"</span><span class='hs-keyglyph'>]</span> <span class='hs-layout'>(</span><span class='hs-conid'>ReqArg</span> <span class='hs-conid'>Flag_DumpInterface</span> <span class='hs-str'>"FILE"</span><span class='hs-layout'>)</span>
<a name="line-112"></a> <span class='hs-str'>"interface file name"</span><span class='hs-layout'>,</span>
<a name="line-113"></a><span class='hs-comment'>-- Option ['S'] ["docbook"] (NoArg Flag_DocBook)</span>
<a name="line-114"></a><span class='hs-comment'>-- "output in DocBook XML",</span>
<a name="line-115"></a> <span class='hs-conid'>Option</span> <span class='hs-keyglyph'>[</span><span class='hs-chr'>'h'</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>[</span><span class='hs-str'>"html"</span><span class='hs-keyglyph'>]</span> <span class='hs-layout'>(</span><span class='hs-conid'>NoArg</span> <span class='hs-conid'>Flag_Html</span><span class='hs-layout'>)</span>
<a name="line-116"></a> <span class='hs-str'>"output in HTML"</span><span class='hs-layout'>,</span>
<a name="line-117"></a> <span class='hs-conid'>Option</span> <span class='hs-keyglyph'>[</span><span class='hs-chr'>'U'</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>[</span><span class='hs-str'>"use-unicode"</span><span class='hs-keyglyph'>]</span> <span class='hs-layout'>(</span><span class='hs-conid'>NoArg</span> <span class='hs-conid'>Flag_UseUnicode</span><span class='hs-layout'>)</span> <span class='hs-str'>"use Unicode in HTML output"</span><span class='hs-layout'>,</span>
<a name="line-118"></a> <span class='hs-conid'>Option</span> <span class='hs-conid'>[]</span> <span class='hs-keyglyph'>[</span><span class='hs-str'>"hoogle"</span><span class='hs-keyglyph'>]</span> <span class='hs-layout'>(</span><span class='hs-conid'>NoArg</span> <span class='hs-conid'>Flag_Hoogle</span><span class='hs-layout'>)</span>
<a name="line-119"></a> <span class='hs-str'>"output for Hoogle"</span><span class='hs-layout'>,</span>
<a name="line-120"></a> <span class='hs-conid'>Option</span> <span class='hs-conid'>[]</span> <span class='hs-keyglyph'>[</span><span class='hs-str'>"html-help"</span><span class='hs-keyglyph'>]</span> <span class='hs-layout'>(</span><span class='hs-conid'>ReqArg</span> <span class='hs-conid'>Flag_HtmlHelp</span> <span class='hs-str'>"format"</span><span class='hs-layout'>)</span>
<a name="line-121"></a> <span class='hs-str'>"produce index and table of contents in\nmshelp, mshelp2 or devhelp format (with -h)"</span><span class='hs-layout'>,</span>
<a name="line-122"></a> <span class='hs-conid'>Option</span> <span class='hs-conid'>[]</span> <span class='hs-keyglyph'>[</span><span class='hs-str'>"source-base"</span><span class='hs-keyglyph'>]</span> <span class='hs-layout'>(</span><span class='hs-conid'>ReqArg</span> <span class='hs-conid'>Flag_SourceBaseURL</span> <span class='hs-str'>"URL"</span><span class='hs-layout'>)</span>
<a name="line-123"></a> <span class='hs-str'>"URL for a source code link on the contents\nand index pages"</span><span class='hs-layout'>,</span>
<a name="line-124"></a> <span class='hs-conid'>Option</span> <span class='hs-keyglyph'>[</span><span class='hs-chr'>'s'</span><span class='hs-keyglyph'>]</span> <span class='hs-layout'>(</span><span class='hs-keyword'>if</span> <span class='hs-varid'>backwardsCompat</span> <span class='hs-keyword'>then</span> <span class='hs-keyglyph'>[</span><span class='hs-str'>"source"</span><span class='hs-layout'>,</span> <span class='hs-str'>"source-module"</span><span class='hs-keyglyph'>]</span> <span class='hs-keyword'>else</span> <span class='hs-keyglyph'>[</span><span class='hs-str'>"source-module"</span><span class='hs-keyglyph'>]</span><span class='hs-layout'>)</span>
<a name="line-125"></a> <span class='hs-layout'>(</span><span class='hs-conid'>ReqArg</span> <span class='hs-conid'>Flag_SourceModuleURL</span> <span class='hs-str'>"URL"</span><span class='hs-layout'>)</span>
<a name="line-126"></a> <span class='hs-str'>"URL for a source code link for each module\n(using the %{FILE} or %{MODULE} vars)"</span><span class='hs-layout'>,</span>
<a name="line-127"></a> <span class='hs-conid'>Option</span> <span class='hs-conid'>[]</span> <span class='hs-keyglyph'>[</span><span class='hs-str'>"source-entity"</span><span class='hs-keyglyph'>]</span> <span class='hs-layout'>(</span><span class='hs-conid'>ReqArg</span> <span class='hs-conid'>Flag_SourceEntityURL</span> <span class='hs-str'>"URL"</span><span class='hs-layout'>)</span>
<a name="line-128"></a> <span class='hs-str'>"URL for a source code link for each entity\n(using the %{FILE}, %{MODULE}, %{NAME},\n%{KIND} or %{LINE} vars)"</span><span class='hs-layout'>,</span>
<a name="line-129"></a> <span class='hs-conid'>Option</span> <span class='hs-conid'>[]</span> <span class='hs-keyglyph'>[</span><span class='hs-str'>"comments-base"</span><span class='hs-keyglyph'>]</span> <span class='hs-layout'>(</span><span class='hs-conid'>ReqArg</span> <span class='hs-conid'>Flag_WikiBaseURL</span> <span class='hs-str'>"URL"</span><span class='hs-layout'>)</span>
<a name="line-130"></a> <span class='hs-str'>"URL for a comments link on the contents\nand index pages"</span><span class='hs-layout'>,</span>
<a name="line-131"></a> <span class='hs-conid'>Option</span> <span class='hs-conid'>[]</span> <span class='hs-keyglyph'>[</span><span class='hs-str'>"comments-module"</span><span class='hs-keyglyph'>]</span> <span class='hs-layout'>(</span><span class='hs-conid'>ReqArg</span> <span class='hs-conid'>Flag_WikiModuleURL</span> <span class='hs-str'>"URL"</span><span class='hs-layout'>)</span>
<a name="line-132"></a> <span class='hs-str'>"URL for a comments link for each module\n(using the %{MODULE} var)"</span><span class='hs-layout'>,</span>
<a name="line-133"></a> <span class='hs-conid'>Option</span> <span class='hs-conid'>[]</span> <span class='hs-keyglyph'>[</span><span class='hs-str'>"comments-entity"</span><span class='hs-keyglyph'>]</span> <span class='hs-layout'>(</span><span class='hs-conid'>ReqArg</span> <span class='hs-conid'>Flag_WikiEntityURL</span> <span class='hs-str'>"URL"</span><span class='hs-layout'>)</span>
<a name="line-134"></a> <span class='hs-str'>"URL for a comments link for each entity\n(using the %{FILE}, %{MODULE}, %{NAME},\n%{KIND} or %{LINE} vars)"</span><span class='hs-layout'>,</span>
<a name="line-135"></a> <span class='hs-conid'>Option</span> <span class='hs-keyglyph'>[</span><span class='hs-chr'>'c'</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>[</span><span class='hs-str'>"css"</span><span class='hs-keyglyph'>]</span> <span class='hs-layout'>(</span><span class='hs-conid'>ReqArg</span> <span class='hs-conid'>Flag_CSS</span> <span class='hs-str'>"FILE"</span><span class='hs-layout'>)</span>
<a name="line-136"></a> <span class='hs-str'>"the CSS file to use for HTML output"</span><span class='hs-layout'>,</span>
<a name="line-137"></a> <span class='hs-conid'>Option</span> <span class='hs-keyglyph'>[</span><span class='hs-chr'>'p'</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>[</span><span class='hs-str'>"prologue"</span><span class='hs-keyglyph'>]</span> <span class='hs-layout'>(</span><span class='hs-conid'>ReqArg</span> <span class='hs-conid'>Flag_Prologue</span> <span class='hs-str'>"FILE"</span><span class='hs-layout'>)</span>
<a name="line-138"></a> <span class='hs-str'>"file containing prologue text"</span><span class='hs-layout'>,</span>
<a name="line-139"></a> <span class='hs-conid'>Option</span> <span class='hs-keyglyph'>[</span><span class='hs-chr'>'t'</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>[</span><span class='hs-str'>"title"</span><span class='hs-keyglyph'>]</span> <span class='hs-layout'>(</span><span class='hs-conid'>ReqArg</span> <span class='hs-conid'>Flag_Heading</span> <span class='hs-str'>"TITLE"</span><span class='hs-layout'>)</span>
<a name="line-140"></a> <span class='hs-str'>"page heading"</span><span class='hs-layout'>,</span>
<a name="line-141"></a> <span class='hs-conid'>Option</span> <span class='hs-keyglyph'>[</span><span class='hs-chr'>'d'</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>[</span><span class='hs-str'>"debug"</span><span class='hs-keyglyph'>]</span> <span class='hs-layout'>(</span><span class='hs-conid'>NoArg</span> <span class='hs-conid'>Flag_Debug</span><span class='hs-layout'>)</span>
<a name="line-142"></a> <span class='hs-str'>"extra debugging output"</span><span class='hs-layout'>,</span>
<a name="line-143"></a> <span class='hs-conid'>Option</span> <span class='hs-keyglyph'>[</span><span class='hs-chr'>'?'</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>[</span><span class='hs-str'>"help"</span><span class='hs-keyglyph'>]</span> <span class='hs-layout'>(</span><span class='hs-conid'>NoArg</span> <span class='hs-conid'>Flag_Help</span><span class='hs-layout'>)</span>
<a name="line-144"></a> <span class='hs-str'>"display this help and exit"</span><span class='hs-layout'>,</span>
<a name="line-145"></a> <span class='hs-conid'>Option</span> <span class='hs-keyglyph'>[</span><span class='hs-chr'>'V'</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>[</span><span class='hs-str'>"version"</span><span class='hs-keyglyph'>]</span> <span class='hs-layout'>(</span><span class='hs-conid'>NoArg</span> <span class='hs-conid'>Flag_Version</span><span class='hs-layout'>)</span>
<a name="line-146"></a> <span class='hs-str'>"output version information and exit"</span><span class='hs-layout'>,</span>
<a name="line-147"></a> <span class='hs-conid'>Option</span> <span class='hs-keyglyph'>[</span><span class='hs-chr'>'v'</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>[</span><span class='hs-str'>"verbosity"</span><span class='hs-keyglyph'>]</span> <span class='hs-layout'>(</span><span class='hs-conid'>ReqArg</span> <span class='hs-conid'>Flag_Verbosity</span> <span class='hs-str'>"VERBOSITY"</span><span class='hs-layout'>)</span>
<a name="line-148"></a> <span class='hs-str'>"set verbosity level"</span><span class='hs-layout'>,</span>
<a name="line-149"></a> <span class='hs-conid'>Option</span> <span class='hs-conid'>[]</span> <span class='hs-keyglyph'>[</span><span class='hs-str'>"use-contents"</span><span class='hs-keyglyph'>]</span> <span class='hs-layout'>(</span><span class='hs-conid'>ReqArg</span> <span class='hs-conid'>Flag_UseContents</span> <span class='hs-str'>"URL"</span><span class='hs-layout'>)</span>
<a name="line-150"></a> <span class='hs-str'>"use a separately-generated HTML contents page"</span><span class='hs-layout'>,</span>
<a name="line-151"></a> <span class='hs-conid'>Option</span> <span class='hs-conid'>[]</span> <span class='hs-keyglyph'>[</span><span class='hs-str'>"gen-contents"</span><span class='hs-keyglyph'>]</span> <span class='hs-layout'>(</span><span class='hs-conid'>NoArg</span> <span class='hs-conid'>Flag_GenContents</span><span class='hs-layout'>)</span>
<a name="line-152"></a> <span class='hs-str'>"generate an HTML contents from specified\ninterfaces"</span><span class='hs-layout'>,</span>
<a name="line-153"></a> <span class='hs-conid'>Option</span> <span class='hs-conid'>[]</span> <span class='hs-keyglyph'>[</span><span class='hs-str'>"use-index"</span><span class='hs-keyglyph'>]</span> <span class='hs-layout'>(</span><span class='hs-conid'>ReqArg</span> <span class='hs-conid'>Flag_UseIndex</span> <span class='hs-str'>"URL"</span><span class='hs-layout'>)</span>
<a name="line-154"></a> <span class='hs-str'>"use a separately-generated HTML index"</span><span class='hs-layout'>,</span>
<a name="line-155"></a> <span class='hs-conid'>Option</span> <span class='hs-conid'>[]</span> <span class='hs-keyglyph'>[</span><span class='hs-str'>"gen-index"</span><span class='hs-keyglyph'>]</span> <span class='hs-layout'>(</span><span class='hs-conid'>NoArg</span> <span class='hs-conid'>Flag_GenIndex</span><span class='hs-layout'>)</span>
<a name="line-156"></a> <span class='hs-str'>"generate an HTML index from specified\ninterfaces"</span><span class='hs-layout'>,</span>
<a name="line-157"></a> <span class='hs-conid'>Option</span> <span class='hs-conid'>[]</span> <span class='hs-keyglyph'>[</span><span class='hs-str'>"ignore-all-exports"</span><span class='hs-keyglyph'>]</span> <span class='hs-layout'>(</span><span class='hs-conid'>NoArg</span> <span class='hs-conid'>Flag_IgnoreAllExports</span><span class='hs-layout'>)</span>
<a name="line-158"></a> <span class='hs-str'>"behave as if all modules have the\nignore-exports atribute"</span><span class='hs-layout'>,</span>
<a name="line-159"></a> <span class='hs-conid'>Option</span> <span class='hs-conid'>[]</span> <span class='hs-keyglyph'>[</span><span class='hs-str'>"hide"</span><span class='hs-keyglyph'>]</span> <span class='hs-layout'>(</span><span class='hs-conid'>ReqArg</span> <span class='hs-conid'>Flag_HideModule</span> <span class='hs-str'>"MODULE"</span><span class='hs-layout'>)</span>
<a name="line-160"></a> <span class='hs-str'>"behave as if MODULE has the hide attribute"</span><span class='hs-layout'>,</span>
<a name="line-161"></a> <span class='hs-conid'>Option</span> <span class='hs-conid'>[]</span> <span class='hs-keyglyph'>[</span><span class='hs-str'>"optghc"</span><span class='hs-keyglyph'>]</span> <span class='hs-layout'>(</span><span class='hs-conid'>ReqArg</span> <span class='hs-conid'>Flag_OptGhc</span> <span class='hs-str'>"OPTION"</span><span class='hs-layout'>)</span>
<a name="line-162"></a> <span class='hs-str'>"option to be forwarded to GHC"</span><span class='hs-layout'>,</span>
<a name="line-163"></a> <span class='hs-conid'>Option</span> <span class='hs-conid'>[]</span> <span class='hs-keyglyph'>[</span><span class='hs-str'>"ghc-version"</span><span class='hs-keyglyph'>]</span> <span class='hs-layout'>(</span><span class='hs-conid'>NoArg</span> <span class='hs-conid'>Flag_GhcVersion</span><span class='hs-layout'>)</span>
<a name="line-164"></a> <span class='hs-str'>"output GHC version in numeric format"</span><span class='hs-layout'>,</span>
<a name="line-165"></a> <span class='hs-conid'>Option</span> <span class='hs-conid'>[]</span> <span class='hs-keyglyph'>[</span><span class='hs-str'>"print-ghc-libdir"</span><span class='hs-keyglyph'>]</span> <span class='hs-layout'>(</span><span class='hs-conid'>NoArg</span> <span class='hs-conid'>Flag_PrintGhcLibDir</span><span class='hs-layout'>)</span>
<a name="line-166"></a> <span class='hs-str'>"output GHC lib dir"</span><span class='hs-layout'>,</span>
<a name="line-167"></a> <span class='hs-conid'>Option</span> <span class='hs-keyglyph'>[</span><span class='hs-chr'>'w'</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>[</span><span class='hs-str'>"no-warnings"</span><span class='hs-keyglyph'>]</span> <span class='hs-layout'>(</span><span class='hs-conid'>NoArg</span> <span class='hs-conid'>Flag_NoWarnings</span><span class='hs-layout'>)</span> <span class='hs-str'>"turn off all warnings"</span>
<a name="line-168"></a> <span class='hs-keyglyph'>]</span>
</pre></body>
</html>
distrib
>
Fedora
>
14
>
x86_64
>
media
>
updates
>
by-pkgid
>
33ad064c4b642ed30353356a1d094330
>
files
>
103
