haddock - documentation tool for annotated Haskell source code

haddock [options] file...

This manual page documents briefly the haddock command. Extensive documentation is available in various other formats including DVI, PostScript and HTML; see below.

file is a filename containing a Haskell source module. All the modules specified on the command line will be processed together. When one module refers to an entity in another module being processed, the documentation will link directly to that entity.

Entities that cannot be found, for example because they are in a module that is not being processed as part of the current batch, simply will not be hyperlinked in the generated documentation. haddock will emit warnings listing all the identifiers it could not resolve.

The modules should not be mutually recursive, as haddock does not like swimming in circles.

The programs follow the usual GNU command line syntax, with long options starting with two dashes (`--'). A summary of options is included below. For a complete description, see the other documentation.

--css=FILE

Use FILE instead of the default stylesheet that comes with haddock. It should specify certain classes: see the default stylesheet for details.

-d, --docbook

Output documentation in SGML DocBook format. NOTE: at time of writing this is only partially implemented.

-D, --debug

Enable extra debugging output.

--dump-interface=FILE

Dump an interface for these modules in FILE.

-h, --html

Generate documentation in HTML format. Several files will be generated into the current directory (or the specified directory if the -o option is given), including the following:

index.html

The top level page of the documentation: lists the modules available, using indentation to represent the hierarchy if the modules are hierarchical.

haddock.css

The stylesheet used by the generated HTML. Feel free to modify this to change the colors or layout, or even specify your own stylesheet using the --css option.

module.html

An HTML page for each module.

doc-index.html, doc-index-XX.html

The index, split into two (functions/constructors and types/classes, as per Haskell namespaces) and further split alphabetically.

-i FILE, --read-interface=FILE

Read an interface from FILE.

--lib=DIR

Directory containing haddock's auxiliary files.

--no-implicit-prelude

Do not assume Prelude is imported.

-o DIR, --odir=DIR

Generate files into DIR instead of the current directory.

-p FILE, --prologue=FILE

Specify a file containing prologue text.

-s URL, --source=URL

Include links to the source files in the generated documentation, where URL is the base URL where the source files can be found.

-t TITLE, --title=TITLE

Use TITLE as the page heading for each page in the documentation. This will normally be the name of the library being documented.

The title should be a plain string (no markup please!).

-v, --verbose

Verbose status reporting.

/usr/lib/haddock/haddock.bin

/usr/share/haddock/haddock.css

/usr/share/haddock/haskell_icon.gif

/usr/share/doc/haddock/,

the Haddock homepage (http://haskell.org/haddock/)

Haddock version 0.3

Copyright 2002 Simon Marlow <simonmar@microsoft.com>. All rights reserved.

This manual page was written by Michael Weber <michaelw@debian.org> for the Debian GNU/Linux system (but may be used by others).