aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorsimonmar <unknown>2003-11-05 17:16:05 +0000
committersimonmar <unknown>2003-11-05 17:16:05 +0000
commit1a7ccb86bb10ebc44e17c90ac5e27e7783958a22 (patch)
tree8b9758909202fbafd7d8ffa710b4b00200a8ec93 /doc
parent01a25ca67470a1066b9aa46a2fcc99a278c18937 (diff)
[haddock @ 2003-11-05 17:16:04 by simonmar]
Support for generating a single unified index for several packages. --use-index=URL turns off normal index generation, causes Index links to point to URL. --gen-index generates an combined index from the specified interfaces. Currently doesn't work exactly right, because the interfaces don't contain the iface_reexported info. I'll need to fix that up.
Diffstat (limited to 'doc')
-rw-r--r--doc/haddock.sgml26
1 files changed, 26 insertions, 0 deletions
diff --git a/doc/haddock.sgml b/doc/haddock.sgml
index a098fb6c..ed65801a 100644
--- a/doc/haddock.sgml
+++ b/doc/haddock.sgml
@@ -493,6 +493,32 @@
<para>Output version information and exit.</para>
</listitem>
</varlistentry>
+
+ <varlistentry>
+ <term><option>--use-index=<replaceable>URL</replaceable></option></term>
+ <indexterm><primary><option>--use-index</option></primary></indexterm>
+ <listitem>
+ <para>When generating HTML, do not generate an index.
+ Instead, redirect the Index link on each page to
+ <replaceable>URL</replaceable>. This option is intended for
+ use in conjuction with <option>--gen-index</option> for
+ generating a separate index covering multiple
+ libraries.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>--gen-index</option></term>
+ <indexterm><primary><option>--gen-index</option></primary></indexterm>
+ <listitem>
+ <para>Generate an HTML index containing entries pulled from
+ all the specified interfaces (interfaces are specified using
+ <option>-i</option> or <option>--read-interface). This is
+ used to generate a single index for multiple sets of Haddock
+ documentstation.</option>
+ </listitem>
+ </varlistentry>
+
</variablelist>
</chapter>