<!DOCTYPE REFENTRY PUBLIC "-//OASIS//DTD DocBook V3.1//EN"> <!--ArborText, Inc., 1988-1998, v.4002--> <?Pub Inc> <refentry> <?dbhtml filename="collateindex.html" output-dir="../doc" chunk='no'> <refnamediv><?Pub Caret1><refname>collateindex.pl</refname><refpurpose>Create a DocBook index from raw index data</refpurpose></refnamediv> <refsynopsisdiv> <cmdsynopsis><command>collateindex.pl</command><arg>-p</arg><arg>-g</arg> <arg>-s <replaceable>name</replaceable></arg><arg>-t <replaceable>name</replaceable></arg> <arg>-P <replaceable>filename</replaceable></arg><arg>-i <replaceable>id</replaceable></arg> <arg>-o <replaceable>file</replaceable></arg><arg>-S <replaceable>scope</replaceable></arg> <arg>-I <replaceable>scope</replaceable></arg><arg>-x</arg><arg>-f</arg><group choice="plain"> <arg choice="plain">-N</arg><arg choice="plain">file</arg></group> </cmdsynopsis> <variablelist> <varlistentry><term><option>-p</option></term> <listitem> <para>Link to points in the document. The default is to link to the closest containing section.</para> </listitem> </varlistentry> <varlistentry><term><option>-g</option></term> <listitem> <para>Group terms with IndexDiv based on the first letter of the term (or its sortas attribute). (This probably doesn't handle i10n particularly well) </para> </listitem> </varlistentry> <varlistentry><term><option>-s name</option></term> <listitem> <para>Name the IndexDiv that contains symbols. The default is 'Symbols'. Meaningless if -g is not used.</para> </listitem> </varlistentry> <varlistentry><term><option>-t name</option></term> <listitem> <para>Title for the index.</para> </listitem> </varlistentry> <varlistentry><term><option>-P file</option></term> <listitem> <para>Read a preamble from file. The content of file will be inserted before the <index> tag.</para> </listitem> </varlistentry> <varlistentry><term><option>-i id</option></term> <listitem> <para>The ID for the <index> tag.</para> </listitem> </varlistentry> <varlistentry><term><option>-o file</option></term> <listitem> <para>Output to file. Defaults to stdout.</para> </listitem> </varlistentry> <varlistentry><term><option>-S scope</option></term> <listitem> <para>Scope of the index, must be 'all', 'local', or 'global'. If unspecified, 'all' is assumed.</para> </listitem> </varlistentry> <varlistentry><term><option>-I scope</option></term> <listitem> <para>The implied scope, must be 'all', 'local', or 'global'. IndexTerms which do not specify a scope will have the implied scope. If unspecified, 'all' is assumed.</para> </listitem> </varlistentry> <varlistentry><term><option>-x</option></term> <listitem> <para>Make a SetIndex.</para> </listitem> </varlistentry> <varlistentry><term><option>-f</option></term> <listitem> <para>Force the output file to be written, even if it appears to have been edited by hand.</para> </listitem> </varlistentry> <varlistentry><term><option>-N</option></term> <listitem> <para>New index (generates an empty index file).</para> </listitem> </varlistentry> <varlistentry><term><option>file</option></term> <listitem> <para>The file containing index data generated by Jade with the DocBook HTML Stylesheet.</para> </listitem> </varlistentry> </variablelist> </refsynopsisdiv> <refsect1 id=desc> <title>Description</title> <para>Generates an index.</para> </refsect1> </refentry> <?Pub *0000003322 0>