home *** CD-ROM | disk | FTP | other *** search
/ Usenet 1994 October / usenetsourcesnewsgroupsinfomagicoctober1994disk2.iso / misc / volume8 / roff_bl / README < prev    next >
Text File  |  1989-09-23  |  1KB  |  38 lines
  1. roff is a script that allows you to encode the filters that a troff
  2. file must be passed through along with which macro packages to use
  3. in the document file.
  4.  
  5. To use roff you simply add a roff command line as the first line of
  6. your document file.  Then when you wish to print out the document
  7. you can simply enter
  8.  
  9.     roff filename
  10.  
  11. roff will generate the correct command stream to print the file.
  12.  
  13. the roff command line is basically a line of text that is passed to
  14. eval(1).  Its format is as follows:
  15.  
  16. \" exec tbl | pic | eroff -mm
  17.  
  18. the '\"' is a troff/nroff comment delimeter.  The 'exec' helps identify
  19. this line as a roff command line.
  20.  
  21. the rest of the line is the filters, packages, and macros that the
  22. document file should be passed through.  Other examples are:
  23.  
  24. \" exec eroff
  25.  
  26. \" exec tbl | eroff -mm -mapt
  27.  
  28. If you look at the roff script you will notice that we strip off the
  29. first line of the document file (the roff command line) before we
  30. pipe the document through the rest of the filters.  At first glance
  31. one might think this isn't necessary, but the mm macros are in my
  32. opinion broke, or at least the ones we have are.  If the very first
  33. physical line of the document isn't .PH "''''" you get the header.
  34. Even if the first line is simply a comment, like the roff command line.
  35.  
  36. You might also notice a reference to '$F'.  This is necessary for us
  37. to be compatible with an older roff command line format.
  38.