From 1a7ccb86bb10ebc44e17c90ac5e27e7783958a22 Mon Sep 17 00:00:00 2001
From: simonmar <unknown>
Date: Wed, 5 Nov 2003 17:16:05 +0000
Subject: [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.
---
doc/haddock.sgml | 26 ++++++++++++++++++++++++++
1 file changed, 26 insertions(+)
(limited to 'doc')
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>
--
cgit v1.2.3