Prev | Chapter 6. Make-Index | Next

## Chapter 6. Make-Index

### Note

The contents of this section was taken from the HTML helppages for Make-Index of Norman Walsh (Version 1.0, 12 Apr 94).

Some obvious errors in this documentation have been corrected according to `makeindex(1L)`.

Additional information was taken from `makeindex(1L)` and the program source files as found in teTeX 2.0.2.

Make-Index is a general purpose index processor. It takes one or more raw index files (normally generated by a formatter), sorts the entries, and produces the actual index file. It is not dependent on any particular format of raw index file, although the `.idx` file generated by LaTeX is the default. Up to three levels (0, 1, and 2) of subitem nesting within the same entry is supported. The input format may be redefined in a style file so that raw index or glossary output from other formatters may be processed. The style file also defines the style of output index file. Unless specified otherwise, the file name base of the first input file (`idx0`) is used to determine other related input/output files. The default input file type is `.idx`.

## 6.1 Options

Make-Index is a Unix program, and therefore has a Unix-style command line. Instead of qualifiers delimited with a slash (`/`), Make-Index options are delimited with a hyphen (`-`).

### 6.1.1 `-c`

Enable blank compression. By default every blank counts in the index key. The `-c` option ignores leading and trailing blanks and tabs and compresses intermediate ones to a single space.

### 6.1.2 `-g`

Employ German word ordering in the index, in accord with rules set forth in DIN 5007. The quote character must be redefined in a style file (for example, redefine quote as `'+'`). If the quote character is not redefined, Make-Index will produce an error message and abort.

### 6.1.3 `-i`

Use `stdin` as the input file. When this option is specified and the `-o` is not, output is written to `stdout`.

### 6.1.4 `-l`

Use letter ordering. Default is word ordering (explained in the Ordering section).

### 6.1.5 `-q`

Quiet mode, send no messages to `stderr`. By default progress and error messages are sent to `stderr` as well as the transcript file. The `-q` option disables the `stderr` messages.

### 6.1.6 `-r`

Disable implicit page range formation. By default three or more successive pages will be automatically abbreviated as a range (e.g. 1--5). The `-r` option disables it, making the explicit range operators the only way to create page ranges (see the Special Effects section below).

### 6.1.7 `-s sty`

Take `sty` as the style file. There is no default for the style file name. The environment variable INDEXSTYLE defines the path where the style file should be found.

### 6.1.8 `-o ind`

Take `ind` as the output index file. By default the file name base of the first input file `idx0` concatenated with the extension `.ind` is used as the output file name.

### 6.1.9 `-t log`

Take `log` as the transcript file. By default the file name base of the first input file `idx0` concatenated with the extension `.ilg` is used as the transcript file name.

### 6.1.10 `-p no`

Set the starting page number of the output index file to be `no`. This is useful when the index file is to be formatted separately. Other than pure numbers, three special cases are allowed for no: `any`, `odd`, and `even`. In these special cases, the starting page number is determined by retrieving the last page number from the source log file. The source log file name is determined by concatenating the file name base of the first raw index file (`idx0`) with the extension `.log`. The last source page is obtained by searching backward in the log file for the first instance of a number included in `[...]`. If a page number is missing or the log file is not found, no attempt will be made to set the starting page number. The meaning of each of these cases follows:

any

  The starting page is the last source page number plus 1.

odd

  The starting page is the first odd page following the last source page number.

even

  The starting page is the first even page following the last source page number.

### 6.1.11 `-L`

Sort based on locale settings. String comparisons for sorting are done using strcoll(3), which compares strings according to the current locale category `LC_COLLATE`.

Not available on all systems (depends on compile time settings).

### 6.1.12 `-T`

Special support for Thai documents.

Not available on all systems (depends on compile time settings).

Prev | Up | Next
5.4 bst files | Home | 6.2 Style File