home *** CD-ROM | disk | FTP | other *** search
/ Usenet 1994 October / usenetsourcesnewsgroupsinfomagicoctober1994disk2.iso / unix / volume13 / nroff-driver / README < prev    next >
Encoding:
Text File  |  1988-01-31  |  4.3 KB  |  88 lines
  1.     Nroff Driver Table Compiler/De-compiler Utility
  2.     -----------------------------------------------
  3.  
  4.     There are two programs in this package.  Table compiles an
  5. nroff terminal driver table from source, and elbat, the inverse
  6. operator, de-compiles an existing formatted table to produce a
  7. source.  There is also a sample driver source, kindly provided by
  8. Bo Thide', for the HP LaserJet+ using a Math Elite font cartridge.
  9. A man page, a Makefile, and this README file are also provided.
  10.  
  11.     This is version 2.0 of the table utility, superceding versions
  12. 1.1 and 1.2.  New features of version 2.0 are:
  13. -  Support for Kanji characters.  There is a new element in the table
  14.    called Kchar.  This is a feature of HP's latest release for their
  15.    9000 series computers.
  16. -  A better Makefile.
  17. -  A -d debug option for elbat.
  18. -  The compiled table should now be bit-for-bit identical to that
  19.    supplied with your system, given the same source file.  To test this,
  20.    decompile a supplied tabfile with elbat, recompile the resultant
  21.    source, and cmp the result with the supplied tabfile.  This is true
  22.    at least for the files on my system (HP9000 series 520, HPUX 5.2)
  23. -  Several bugs fixed.
  24. -  A man page, table.5
  25.  
  26.     Sources for the tab files are in 'C', and consist simply of
  27. an initialized structure.  This structure is compiled and linked to
  28. the main program module, table.o (compiled from table.c), to
  29. produce an executable a.out file.  This file when executed produces
  30. the compiled tab file.
  31.     A Makefile is provided to formalize this procedure.  The
  32. sources for the various terminals (all files named tabXXXX.c, where
  33. XXXX is replaced by a short acronym for the terminal: e.g. tab450.c)
  34. are included the the SOURCES definition in the Makefile.  Typing
  35. "make" or "make all" compiles these sources, and runs the executable
  36. a.out files to produce the compiled tab files, calling them tabXXXX.tab.
  37. Typing "make install" renames the tabXXXX.tab files to tabXXXX, and
  38. copies them to the /usr/lib/term directory, where nroff will find
  39. them when the -TXXXX option is used.
  40.     Typing "make elbat" makes the elbat program, which can take
  41. a compiled tabXXXX file and produce a source tabXXXX.c file.  Using
  42. the -d (debug) option with elbat produces a dump of the actual
  43. character data in the file.
  44.     Be VERY CAREFUL with "make install" (try "make -n install
  45. first).  You don't likely want to delete system-supplied tab files!
  46.  
  47.     The table.5 man page contains more information.
  48.  
  49. IF YOU HAVE PROBLEMS...
  50.     It is quite possible that the tab file format on your machine
  51. differs in minor or major ways from that embodied by this utility.  Since
  52. the tabfile format was inferred from careful examination of a small number
  53. of supplied tab files on one system only, there is no guarantee that it
  54. will work on all systems.  One major potential problem is in the
  55. inclusion/exculsion of the Kchar (Kanji) element in the tabfile structure.
  56. Use elbat to decompile an existing tabfile; it should tell you if the
  57. tabfile size is inconsistent with the content.  If this is so, change
  58. the "#define KANJI" line in the Makefile, and try again.
  59.  
  60. Acknowledgements:
  61.     Ian Darwin tested out the first (very buggy) version of
  62. this utility, and suggested many useful changes, including the
  63. introduction of the Makefile.
  64.  
  65.     Matt Crawford wrote the elbat program originally for
  66. Berkeley systems.
  67.  
  68. Caveat:
  69.     This utility was written to permit the author to configure nroff
  70. on his machine for terminals/fonts unsupported by the supplied tabfiles.
  71. It was not intended as a universal utility applicable to all machines
  72. or versions of unix.  It has been released without any guarantee whatsoever.
  73. The author does not intend to support this software to any extent, and
  74. users should understand that future changes to their system software may
  75. break this utility.  This being so, it would be foolish to depend too
  76. heavily on the functionality that this utility provides.
  77.  
  78.     Copyright (c) 1987 by Bruce Townsend and Bell-Northern Research.
  79.     Permission is granted to use and distribute, except for profit,
  80.     providing this copyright notice and the author's name is included.
  81.     No warranty of any kind is expressed or implied, and no liability of
  82.     any kind is assumed by either the author or Bell-Northern Research.
  83.  
  84. ---
  85. Bruce Townsend (bnr-vpa!bruce)    Phone:    (613) 726-3008
  86. Bell-Northern Research        Usenet: {utzoo, utcs}!bnr-vpa!bruce
  87. P.O. Box 3511, Station C, Ottawa, Ontario, Canada, K1Y 4H7
  88.