<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN""http://www.w3.org/TR/html4/loose.dtd"> <HTML ><HEAD ><TITLE >collateindex.pl</TITLE ><META NAME="GENERATOR" CONTENT="Modular DocBook HTML Stylesheet Version 1.79"></HEAD ><BODY CLASS="REFENTRY" BGCOLOR="#FFFFFF" TEXT="#000000" LINK="#0000FF" VLINK="#840084" ALINK="#0000FF" ><H1 ><A NAME="AEN1" ></A >collateindex.pl</H1 ><DIV CLASS="REFNAMEDIV" ><A NAME="AEN2" ></A ><H2 >Name</H2 >collateindex.pl -- Create a DocBook index from raw index data</DIV ><DIV CLASS="REFSYNOPSISDIV" ><A NAME="AEN5" ></A ><H2 >Synopsis</H2 ><P ><B CLASS="COMMAND" >collateindex.pl</B > [-p] [-g] [-s <TT CLASS="REPLACEABLE" ><I >name</I ></TT >] [-t <TT CLASS="REPLACEABLE" ><I >name</I ></TT >] [-P <TT CLASS="REPLACEABLE" ><I >filename</I ></TT >] [-i <TT CLASS="REPLACEABLE" ><I >id</I ></TT >] [-o <TT CLASS="REPLACEABLE" ><I >file</I ></TT >] [-S <TT CLASS="REPLACEABLE" ><I >scope</I ></TT >] [-I <TT CLASS="REPLACEABLE" ><I >scope</I ></TT >] [-x] [-f] -N | file </P ><P ></P ><DIV CLASS="VARIABLELIST" ><DL ><DT ><CODE CLASS="OPTION" >-p</CODE ></DT ><DD ><P >Link to points in the document. The default is to link to the closest containing section.</P ></DD ><DT ><CODE CLASS="OPTION" >-g</CODE ></DT ><DD ><P >Group terms with IndexDiv based on the first letter of the term (or its sortas attribute). (This probably doesn't handle i10n particularly well)</P ></DD ><DT ><CODE CLASS="OPTION" >-s name</CODE ></DT ><DD ><P >Name the IndexDiv that contains symbols. The default is 'Symbols'. Meaningless if -g is not used.</P ></DD ><DT ><CODE CLASS="OPTION" >-t name</CODE ></DT ><DD ><P >Title for the index.</P ></DD ><DT ><CODE CLASS="OPTION" >-P file</CODE ></DT ><DD ><P >Read a preamble from file. The content of file will be inserted before the <index> tag.</P ></DD ><DT ><CODE CLASS="OPTION" >-i id</CODE ></DT ><DD ><P >The ID for the <index> tag.</P ></DD ><DT ><CODE CLASS="OPTION" >-o file</CODE ></DT ><DD ><P >Output to file. Defaults to stdout.</P ></DD ><DT ><CODE CLASS="OPTION" >-S scope</CODE ></DT ><DD ><P >Scope of the index, must be 'all', 'local', or 'global'. If unspecified, 'all' is assumed.</P ></DD ><DT ><CODE CLASS="OPTION" >-I scope</CODE ></DT ><DD ><P >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.</P ></DD ><DT ><CODE CLASS="OPTION" >-x</CODE ></DT ><DD ><P >Make a SetIndex.</P ></DD ><DT ><CODE CLASS="OPTION" >-f</CODE ></DT ><DD ><P >Force the output file to be written, even if it appears to have been edited by hand.</P ></DD ><DT ><CODE CLASS="OPTION" >-N</CODE ></DT ><DD ><P >New index (generates an empty index file).</P ></DD ><DT ><CODE CLASS="OPTION" >file</CODE ></DT ><DD ><P >The file containing index data generated by Jade with the DocBook HTML Stylesheet.</P ></DD ></DL ></DIV ></DIV ><DIV CLASS="REFSECT1" ><A NAME="DESC" ></A ><H2 >Description</H2 ><P >Generates an index.</P ></DIV ></BODY ></HTML >