README

   1 TROFF TOOLS
   2 ===========
   3
   4 This is the port of Plan9 troff tools to Linux which probably works
   5 in other Unix variants with minor modifications.  The included
   6 programs are troff, tr2ps (dpost), eqn, tbl, pic, grap, and refer.
   7
   8 SETTING UP
   9 ==========
  10
  11 Change TBASE variable conf.mk to point the home folder in this
  12 package.  Then compile everything:
  13
  14   $ for t in troff tr2ps eqn tbl pic grap refer; do cd $t; make; cd ..; done
  15
  16 Next, you may want to copy the binaries to a directory in your $PATH.
  17
  18 Note that the included troff font description files are smaller than
  19 the ones included in Plan9 and are generated using mkdev tool
  20 (included in this package).  But you can use the ones from Plan9
  21 too.
  22
  23 TR2PS CHANGES
  24 =============
  25
  26 Each troff font is mapped to exactly one PS font, which is declared as
  27 fontname in the troff font description file.  As a result, tr2ps can
  28 find out the mapping of between troff characters and postscript glyphs
  29 by reading only the troff description files.  UTF8 entries in troff font
  30 files work as before and the first column can be any UTF8 character.
  31 The fifth column, however, denotes glyphs' postscript names if present.
  32 For glyphs not in the 256-entry PS font encoding table, tr2ps uses these
  33 glyph names to output those characters in the generated postscript file.
  34 This makes adding new fonts to troff much easier.
  35
  36 REFER
  37 =====
  38
  39 I included my small refer clone in this package.  It assumes each record
  40 in the database has an 'L' key which specifies the label of the record.
  41 When referencing, only this key is searched among the records in the
  42 database.  A new -m parameter has been added to allow multiple references
  43 in a single .[/.] macro, as white space separated list of labels; refer
  44 tries to use reference intervals if possible.
  45
  46 TODO
  47 ====
  48
  49 * Remove the use of lex and yacc in eqn and pic.  I hate lex and yacc
  50   as much as I like a well written recursive decent parser.
  51 * Some of the tools could be cleaned up considerably