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, and pic.
   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; 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 DPOST CHANGES
  24 =============
  25
  26 tr2ps no longer reads TBASE/ps/troff/* files to find the mapping
  27 between troff fonts and PS fonts.  Each troff font is mapped to
  28 exactly one PS font which is declared as fontname in font
  29 description files.  So tr2ps reads only troff description files.
  30 UTF8 entries in troff font files work as before but the fifth column
  31 now denotes a glyph's postscript name if available.  For glyphs not
  32 in the 256-entry PS font encoding table, tr2ps uses these glyph
  33 names to draw these characters in the generated postscript file.
  34 This would make adding new fonts to troff much easier.
  35
  36 TODO
  37 ====
  38
  39 * Remove the use of lex and yacc in eqn and pic.  I hate lex and yacc
  40   as much as I like a well written recursive decent parser.
  41 * Some of the tools could be cleaned up considerably