From 18b3df7550d2aa9fba5ac8de0aa3fc9f8bdf5a84 Mon Sep 17 00:00:00 2001 From: Mark Lentczner Date: Wed, 1 Sep 2010 04:29:35 +0000 Subject: sort options in doc to match --help output removed --html-help option, as it is no longer supported --- doc/haddock.xml | 290 ++++++++++++++++++++++---------------------------------- 1 file changed, 115 insertions(+), 175 deletions(-) (limited to 'doc') diff --git a/doc/haddock.xml b/doc/haddock.xml index 9b87e3d5..a7688e4e 100644 --- a/doc/haddock.xml +++ b/doc/haddock.xml @@ -252,27 +252,30 @@ - - =option + + dir + + + + =dir - Pass option to GHC. + Generate files into dir + instead of the current directory. - - - dir + + dir - - =dir + + =dir - Generate files into dir - instead of the current directory. + Use Haddock auxiliary files (themes, javascript, etc...) in dir. @@ -332,35 +335,6 @@ - - - - dir - - - - =dir - - - Use auxiliary files in dir. - - - - - - - - - - - - - - Reserved for future use (output documentation in DocBook XML - format). - - - @@ -422,61 +396,81 @@ - - - - - - - + + + - - (In HTML mode only) Produce extra contents and index - files for given HTML Help system. Currently supported Help - systems are Microsoft HTML Help 1.3 and 2.0 and GNOME DevHelp. - - Using the Microsoft HTML Help system provides two - advantages over plain HTML: the help viewer gives you a nice - hierarchical folding contents pane on the left, and the - documentation files are compressed and therefore much - smaller (roughly a factor of 10). The disadvantage is that - the help can't be viewed over the web. - - In order to create a compiled Microsoft help file, you - also need the Microsoft HTML Help compiler, which is - available free from - http://www.microsoft.com/ - (search for HTML Help compiler). - - Viewers + + Generate documentation in LaTeX format. Several files + will be generated into the current directory (or the + specified directory if the option is + given), including the following: + - - Microsoft HTML Help Viewer - Distributed with Microsoft Windows - - - xCHM - a CHM viewer for UNIX (Linux, *BSD, Solaris), written by Razvan Cojocaru + + package.tex + + The top-level LaTeX source file; to format the + documentation into PDF you might run something like + this: + +$ pdflatex package.tex + - JouleData Solutions' CHM Viewer - a comercial 100% native Cocoa .chm file viewer for the Mac OS X platform + haddock.sty + + 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. + - GnoCHM - a CHM file viewer. It is designed to integrate nicely with Gnome. + module.tex + + The LaTeX documentation for + each module. + - + + + - The GNOME DevHelp also provides help viewer which looks like - MSHelp viewer but the documentation files aren't compressed. - The documentation can be viewed with any HTML browser but - DevHelp gives you a nice hierarchical folding contents and - keyword index panes on the left. The DevHelp expects to see - *.devhelp file in the folder where the documentation is placed. - The file contains all required information - to build the contents and index panes. - + + + + + + + This option lets you override the default style used + by the LaTeX generated by the option. + Normally Haddock puts a + standard haddock.sty in the output + directory, and includes the + command \usepackage{haddock} in the + LaTeX source. If this option is given, + then haddock.sty is not generated, + and the command is + instead \usepackage{style}. + + + + + + + + + + + + + + + Reserved for future use (output documentation in DocBook XML + format). @@ -656,70 +650,6 @@ - - - - - - - Generate documentation in LaTeX format. Several files - will be generated into the current directory (or the - specified directory if the option is - given), including the following: - - - - package.tex - - The top-level LaTeX source file; to format the - documentation into PDF you might run something like - this: - -$ pdflatex package.tex - - - - haddock.sty - - 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. - - - - module.tex - - The LaTeX documentation for - each module. - - - - - - - - - - - - - This option lets you override the default style used - by the LaTeX generated by the option. - Normally Haddock puts a - standard haddock.sty in the output - directory, and includes the - command \usepackage{haddock} in the - LaTeX source. If this option is given, - then haddock.sty is not generated, - and the command is - instead \usepackage{style}. - - - - @@ -787,33 +717,33 @@ $ pdflatex package.tex - - + + - - + + - Increase verbosity. Currently this will cause Haddock - to emit some extra warnings, in particular about modules - which were imported but it had no information about (this is - often quite normal; for example when there is no information - about the Prelude). + Output version information and exit. - - + + - - + + - Output version information and exit. + Increase verbosity. Currently this will cause Haddock + to emit some extra warnings, in particular about modules + which were imported but it had no information about (this is + often quite normal; for example when there is no information + about the Prelude). @@ -875,19 +805,12 @@ $ pdflatex package.tex - - - + + + =option - If the input modules use Template Haskell, Haddock has to - perform compilation (using GHC). This results in .o, .hi, and stub files that - are written to a temporary directory by default. When this flag is specified, - however, the files are written to the present directory (or another path if you - tell GHC, for example like this: --optghc=-odir --optghc=path). - Note that not only will files be written to this directory, GHC will also look for - already existing files there, and use them in order to skip compilation. - + Pass option to GHC. @@ -904,6 +827,23 @@ $ pdflatex package.tex Turn off all warnings. + + + + + + + + If the input modules use Template Haskell, Haddock has to + perform compilation (using GHC). This results in .o, .hi, and stub files that + are written to a temporary directory by default. When this flag is specified, + however, the files are written to the present directory (or another path if you + tell GHC, for example like this: --optghc=-odir --optghc=path). + Note that not only will files be written to this directory, GHC will also look for + already existing files there, and use them in order to skip compilation. + + +
-- cgit v1.2.3