Utroff.org

Idx readme

Presentation

Idx is an helper tool to make and to manipulate index files. Idx has been made to automatically index troff document, but it can also be used manually, to make an index of a book.

Build and install

To build and install, edit the file config.mk from the root directory, and run :

make install

In some circumstances, you might need utroff tools themselves to build the manual pages. In that case, build and install binaries before manual pages like this :

make installbin
make installman

You can uninstall files and clean the working directory :

make uninstall
make clean

For a more complete description of the build process, look at the README in the root directory.

Compatibility with heirloom troff

Idx is needed by utroff-utmac to build indexes. In that case, if heirloom troff is used, and if heirloom tools are in the begining of the path, be sure that ’awk’ links to heirloom ’nawk’ and not heirloom ’oawk’.

License

Idx and its man page are distributed under a two clause BSD license.

Help and bugs

Don’t hesitate to ask questions at help at utroff dot org. Please, send bugs and patches at help at utroff dot org.