home *** CD-ROM | disk | FTP | other *** search
/ Frozen Fish 1: Amiga / FrozenFish-Apr94.iso / bbs / alib / d6xx / d671 / tr2tex.lha / tr2tex / ReadMe < prev    next >
Text File  |  1992-06-13  |  3KB  |  67 lines
  1. Please read this file before you install the program.
  2.  
  3. Troff-to-TeX translator version .92, February 11, 1987.
  4. Copyright (C) by 1987 Kamal Al-Yahya.
  5.  
  6. This directory contains programs that were developed at the
  7. Stanford Exploration Project, Geophysics Department, by Kamal Al-Yahya.
  8. Copying them to any other machine is permitted without prior permission
  9. provided that copyright messages are kept, no profit is made by copying
  10. the files, and modifications are clearly documented.
  11.  
  12. I would very much appreciate any comments or suggestions. My e-net
  13. address is
  14.         kamal@hanauma.stanford.edu
  15. If it doesn't work try
  16.         kamal%hanauma@score.stanford.edu
  17.  
  18.             INSTALLATION INSTRUCTIONS
  19.  
  20. In short, type ``make'' and then run it on the document (try the testfile):
  21.         tr2tex testfile > testfile.tex
  22.  
  23. In details:
  24.  
  25. - Use makefile.msc if you're running MS-DOS.
  26. - In the makefile, define the destination of the executable (default is
  27.   current directory). Also, add the -O flag if you want to (and the
  28.   optimizer in your machine is not buggy). The -O flag causes long compilation
  29.   time but experience has shown that it is unnecessary for this package;
  30.   time saved in running time is extremely small in the computers I used.
  31. - If the limit on your unsigned int is not 65535, change MAXLEN in
  32.   setups.h accordingly.
  33. - In tr2tex.c, change the document type if you want. The default is article.
  34.   Also, change the style options to suit your taste. The default
  35.   is [troffms,11pt] if no flag is used and [troffman] if the -m flag is used.
  36. - Add appropriate CFLAGS (e.g. -Dtops20 and/or -DANSI) if you need them.
  37. - type ``make'' to produce the executable, called ``tr2tex''.
  38. - Modify troffms.sty and troffman.sty to suit your taste but keep the
  39.   necessary macro definitions as they will be needed when running latex.
  40.   Make sure the font names exist on your site. Change them if necessary.
  41. - Move troffms.sty and troffman.sty to your macros directory.
  42. - Install and read the manual page.
  43. - Run the translator on ``testfile'' and the manual page as follows
  44.         tr2tex testfile > testfile.tex
  45.         tr2tex -m tr2tex.1 > tr2tex.1.tex
  46.   
  47.   and compare ``testfile.tex'' with ``SAVEtestfile.tex'' and
  48.   ``tr2tex.1.tex'' with ``SAVEtr2tex.1.tex''.
  49.   If they are not identical, you have not installed it properly.
  50.  
  51.  
  52.             USING THE TRANSLATOR
  53.  
  54. You can run the program either by
  55.         tr2tex < file  > file.tex
  56. or
  57.         tr2tex file  > file.tex
  58. You are most likely to get messages on the standard error telling
  59. you about things it encounters and cannot do.
  60.  
  61. Now you have the translated document. Look at it and see if you
  62. can spot a major error. Run it through latex. If it runs and produces
  63. the dvi file, then print it. If you get latex error messages modify
  64. the translated document accordingly and repeat the latex run, and so on.
  65. I usually get away with one or two iterations.
  66.  
  67.