1HADDOCK(1) Haddock documentation generator HADDOCK(1)
2
6 haddock - documentation tool for annotated Haskell source code
7
11 haddock [options] file...
12
16 This manual page documents briefly the haddock command. Extensive doc‐
17 umentation is available in various other formats including DVI, Post‐
18 Script and HTML; see below.
19 file is a filename containing a Haskell source module. All the modules
22 specified on the command line will be processed together. When one
23 module refers to an entity in another module being processed, the docu‐
24 mentation will link directly to that entity.
25 Entities that cannot be found, for example because they are in a module
27 that is not being processed as part of the current batch, simply will
28 not be hyperlinked in the generated documentation. haddock will emit
29 warnings listing all the identifiers it could not resolve.
30 The modules should not be mutually recursive, as haddock does not like
32 swimming in circles.
33
37 The programs follow the usual GNU command line syntax, with long
38 options starting with two dashes (`--'). A summary of options is
39 included below. For a complete description, see the other documenta‐
40 tion.
41 -o DIR, --odir=DIR
44 directory in which to put the output files
45 -i FILE, --read-interface=FILE
48 read an interface from FILE.
49 -D FILE, --dump-interface=FILE
52 dump an interface for these modules in FILE.
53 -l DIR, --lib=DIR
56 location of Haddock's auxiliary files
57 -h, --html
60 Generate documentation in HTML format. Several files will be
61 generated into the current directory (or the specified directory
62 if the -o option is given), including the following:
63 index.html
65 The top level page of the documentation: lists the mod‐
66 ules available, using indentation to represent the hier‐
67 archy if the modules are hierarchical.
68 haddock.css
70 The stylesheet used by the generated HTML. Feel free to
71 modify this to change the colors or layout, or even spec‐
72 ify your own stylesheet using the --css option.
73 module.html
75 An HTML page for each module.
76 doc-index.html, doc-index-XX.html
78 The index, split into two (functions/constructors and
79 types/classes, as per Haskell namespaces) and further
80 split alphabetically.
81 --hoogle
84 output for Hoogle
85 --html-help=format
88 produce index and table of contents in mshelp, mshelp2 or
89 devhelp format (with -h)
90 --source-base=URL
93 Include links to the source files in the generated documenta‐
94 tion, where URL is the base URL where the source files can be
95 found.
96 -s URL, --source-module=URL
99 Include links to the source files in the generated documenta‐
100 tion, where URL is a source code link for each module (using the
101 %{FILE} or %{MODULE} vars).
102 --source-entity=URL
105 Include links to the source files in the generated documenta‐
106 tion, where URL is a source code link for each entity (using the
107 %{FILE}, %{MODULE} or %{NAME} vars).
108 --comments-base=URL
111 URL for a comments link on the contents and index pages.
112 --comments-module=URL
114 URL for a comments link for each module (using the %{MODULE}
115 var).
116 --comments-entity=URL
118 URL for a comments link for each entity (using the %{FILE},
119 %{MODULE} or %{NAME} vars).
120 --css=FILE
122 Use the CSS FILE instead of the default stylesheet that comes
123 with haddock for HTML output. It should specify certain classes:
124 see the default stylesheet for details.
125 -p FILE, --prologue=FILE
128 Specify a file containing prologue text.
129 -t TITLE, --title=TITLE
132 Use TITLE as the page heading for each page in the documenta‐
133 tion. This will normally be the name of the library being docu‐
134 mented.
135 The title should be a plain string (no markup please!).
137 -k NAME, --package=NAME
140 Specify the package name (optional).
141 -n, --no-implicit-prelude
144 do not assume Prelude is imported
145 -d, --debug
148 Enable extra debugging output.
149 -?, --help
152 Display help.
153 -V, --version
156 Display version.
157 -v, --verbose
160 Verbose status reporting.
161 --use-contents=URL
164 Use a separately-generated HTML contents page.
165 --gen-contents
168 Generate an HTML contents from specified interfaces.
169 --use-index=URL
172 Use a separately-generated HTML index.
173 --gen-index
176 Generate an HTML index from specified interfaces.
177 --ignore-all-exports
180 Behave as if all modules have the ignore-exports atribute
181 --hide=MODULE
184 Behave as if MODULE has the hide attribute.
185 --use-package=PACKAGE
188 The modules being processed depend on PACKAGE.
189
192 /usr/bin/haddock
193 /usr/share/haddock-2.6.1/html/plus.gif
194 /usr/share/haddock-2.6.1/html/minus.gif
195 /usr/share/haddock-2.6.1/html/haskell_icon.gif
196 /usr/share/haddock-2.6.1/html/haddock.js
197 /usr/share/haddock-2.6.1/html/haddock.css
198 /usr/share/haddock-2.6.1/html/haddock-DEBUG.css
199
202 /usr/share/doc/haddock/,
203 the Haddock homepage (http://haskell.org/haddock/)
204 ⟨http://haskell.org/haddock/⟩
205
208 Haddock version 2.6.1
209 Copyright 2006-2010 Simon Marlow <simonmar@microsoft.com>, Dawid Waern
211 <david.waern@gmail.com>. All rights reserved.
212
216 This manual page was written by Michael Weber <michaelw@debian.org> for
217 the Debian GNU/Linux system (but may be used by others).
218Haddock, version 2.6.1 July 2010 HADDOCK(1)