The Heirloom Documentation Tools
The Heirloom Documentation Tools package provides troff, nroff, and related utilities to format manual pages and other documents for output on terminals and printers. They are portable and enhanced versions of the utilities released by Sun as part of OpenSolaris, which are a variant of ditroff, which, in turn, descends from the historical Unix troff that generated output for the C/A/T phototypesetter.
nroff is most prominently used to format Unix manual pages for viewing them on a terminal. This implementation consumes relatively few system resources and is thus suitable for small system distributions. It has been enhanced to generate UTF-8 output.
troff generates PostScript or HTML output from the same document source code as nroff. Thus a special use of it is to prepare manual pages for printing. troff can add a table of contents with hyperlinks and PDF bookmarks to manual pages (see man.7 and mdoc.7).
troff is a general-purpose typesetting processor, though. Significant features that have been added in this implementation are:
Samples, introductory documents, manuals
View the Troff Demonstration Page to get an impression of what can be done with troff and PostScript fonts.
The Quickstart Guide is a short introduction for those who are already familiar with other versions of troff and want to explore Heirloom troff now.
Paragraph-at-once adjustment, microtypography, and other improvements to the adjustment mechanisms are presented in Justification in Heirloom Troff.
Font Handling in Troff with PostScript Devices explains how to install fonts and how to access their typographical features.
The Nroff/Troff User's Manual forms the reference documentation for nroff and troff.
(The documents above had been generated using special none-free fonts with an older version of the Heirloom doctools. The up-to-date source code for generating these files is located in the doc directory.)
Online manual pages for addbib, checknr, dhtml, dpost, eqn, grap, lookbib, man (PDF), mcolor, mdoc (PDF), mpictures, nroff, otfdump, pic, picpack, ptx, refer, roffbib, soelim, sortbib, tbl, troff, and vgrind are available.
For installation instructions, see the README.
The list of CHANGES made since the move from SourceForge to GitHub.
Browse the Git repository.
Download the source code
Download a release version of the source code or use
$ git clone https://github.com/n-t-roff/heirloom-doctools.gitto retrieve a snapshot of the repository.