idxconvert

Name

idxconvert -- Front end to the converters.

Synopsis

idxconvert [--help] [--version] [FILE]

Description

A command line utility to simplify the use of the converters.

The specified index file is converted to the format requested by the user.

You also have the option of adding alphabet headings with idxalphabetize

The input file is not affected by the conversion.

Options

--help

Output brief help information.

--version

Display version information.

Example

The following illustrates typical usage. (typed input is show like this.)

idxconvert example.idx

Convert `example.idx' with
    1. idx2html
    2. idx2rtf
    3. idx2txt
Enter choice or `q' to quit: 2
Add alphabet headings (yes/no)? y

The utility then add the alphabet headings to example.idx and converts the result to RTF and writes the result to `example.rtf'.

Notes

idxconvert cannot pass options to the actual converter. If they are required the actual converter must be run.