Next Previous Contents

5. Invoking xindy

5.1 Command Line Options

The following command line options are accepted:

xindy  [-h] [-t] [-v] [-l logfile] [-o outfile]
       [-L n] [-f filterprog]
       indexstyle raw-index

The argument indexstyle names a file, containing the index style description. The argument raw-index names a file, containing the raw index. Both arguments are mandatory.

<tag/<tt/-h// Gives a short summary of all command line options.

<tag/<tt/-l// Writes helpful information into the specified
<tt/logfile/. For example, the keyword mappings are written into this
file, so one can check if the intended mappings were actually
performed this way.

<tag/<tt/-o// Explicitly defines the name of the <tt/output/ file. If
not given, the name of the <tt/raw-index/ is used with its extension
changed to `<tt/.ind/' (or added, if it had no extension at all).

<tag><tt/-t// Enters tracing mode of the symbolic markup tags. The
format of the emitted tags can be defined with the command

<tag/<tt/-L// Set the <sf/xindy/ logging-level to <em/n/.

<tag/<tt/-f// Run <tt/filterprog/ on <tt/raw-index/ before reading.
The program must act as a filter reading from stdin and writing to
stdout. The most obvious use of this option in conjunction with TeX
is to run <tt/-f tex2xindy/ on the index file prior to reading the
entries into <sf/xindy/.

<tag/<tt/-v// Shows the version number of <sf/xindy/.

Errors and warnings are reported to stdout and additionally to the logfile if -l was specified.

5.2 Search Path

The system uses the concept of a search path for finding the index style files and modules. The searchpath can be set with the environment variable XINDY_SEARCHPATH which must contain a list of colon-separated directories. If it ends with a colon, the built-in searchpath is added to the entire searchpath. See the command searchpath for further details.

Next Previous Contents