diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/haddock.xml | 79 |
1 files changed, 74 insertions, 5 deletions
diff --git a/doc/haddock.xml b/doc/haddock.xml index bfa02155..3d56b141 100644 --- a/doc/haddock.xml +++ b/doc/haddock.xml @@ -10,10 +10,15 @@ <firstname>Simon</firstname> <surname>Marlow</surname> </author> - <address><email>simonmar@microsoft.com</email></address> + <address><email>marlowsd@gmail.com</email></address> + <author> + <firstname>David</firstname> + <surname>Waern</surname> + </author> + <address><email>david.waern@gmail.com</email></address> <copyright> - <year>2004</year> - <holder>Simon Marlow</holder> + <year>2010</year> + <holder>Simon Marlow, David Waern</holder> </copyright> <abstract> <para>This document describes Haddock version 2.7.2, a Haskell @@ -93,7 +98,7 @@ </listitem> <listitem> <para>We might want documentation in multiple formats - online - and printed, for example. Haddock comes with HTML, DocBook + and printed, for example. Haddock comes with HTML, LaTeX, and Hoogle backends, and it is structured in such a way that adding new back-ends is straightforward.</para> </listitem> @@ -645,13 +650,77 @@ <option>--css</option>=<replaceable>file</replaceable> </term> <listitem> - <para>Specify a stylesheet to use instead of the default one + <para>Specify a CSS stylesheet to use instead of the default one that comes with Haddock. It should specify certain classes: see the default stylesheet for details.</para> </listitem> </varlistentry> <varlistentry> + <term> + <indexterm><primary><option>--latex</option></primary></indexterm> + <option>--latex</option> + </term> + <listitem> + <para>Generate documentation in LaTeX format. Several files + will be generated into the current directory (or the + specified directory if the <option>-o</option> option is + given), including the following:</para> + + <variablelist> + <varlistentry> + <term><filename><replaceable>package</replaceable>.tex</filename></term> + <listitem> + <para>The top-level LaTeX source file; to format the + documentation into PDF you might run something like + this:</para> +<screen> +$ pdflatex <replaceable>package</replaceable>.tex</screen> + </listitem> + </varlistentry> + <varlistentry> + <term><filename>haddock.sty</filename></term> + <listitem> + <para>The default style. The file contains + definitions for various macros used in the LaTeX + sources generated by Haddock; to change the way the + formatted output looks, you might want to override + these by specifying your own style with + the <option>--latex-style</option> option.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><filename><replaceable>module</replaceable>.tex</filename></term> + <listitem> + <para>The LaTeX documentation for + each <replaceable>module</replaceable>.</para> + </listitem> + </varlistentry> + </variablelist> + </listitem> + </varlistentry> + + <varlistentry> + <term> + <indexterm><primary><option>--latex-style</option></primary></indexterm> + <option>--latex-style=<replaceable>style</replaceable></option> + </term> + <listitem> + <para>This option lets you override the default style used + by the LaTeX generated by the <option>--latex</option> option. + Normally Haddock puts a + standard <filename>haddock.sty</filename> in the output + directory, and includes the + command <literal>\usepackage{haddock}</literal> in the + LaTeX source. If this option is given, + then <filename>haddock.sty</filename> is not generated, + and the command is + instead <literal>\usepackage{<replaceable>style</replaceable>}</literal>. + </para> + </listitem> + </varlistentry> + + <varlistentry> <term> <indexterm><primary><option>-p</option></primary></indexterm> <option>-p</option> <replaceable>file</replaceable> |