home *** CD-ROM | disk | FTP | other *** search
/ CP/M / CPM_CDROM.iso / cpm / turbopas / rnf-pas.lbr / RNFDOC.DQC / RNFDOC.DOC
Text File  |  1986-07-16  |  5KB  |  106 lines
  1.  
  2.  
  3.  
  4.                                                                        1
  5.  
  6.  
  7.                        Quick Introduction to RNF
  8.  
  9.                             Willett Kempton
  10.                               7 June 1986
  11.  
  12.  
  13.  
  14.      RNF is a program for producing  documents  such  as  user  manuals,
  15. reports,  or  term  papers.   This  is a short introduction to RNF; more
  16. details can be found in the complete manual.
  17.  
  18.      RNF is a text formatter, like nroff or troff on UNIX or  RUNOFF  on
  19. the  DEC-10.  It expects an input file containing text and commands, and
  20. it produces a final-format document.  The input file is just a  standard
  21. ASCII  file,  and  can be prepared with any editor.  Most commands are a
  22. dot and a name, such as .BOLD to print  bold  letters.   The  output  is
  23. typically  sent directly to the printer, but it can be sent to a file or
  24. to the console (CON:) first for checking if desired.
  25.  
  26.      RNF is unlike most word processors  in  that  it  does  not  format
  27. on-screen and it has no built-in editor.  On the other hand, it has more
  28. powerful capabilities  than  most  commercial  word  processors,  it  is
  29. written  in  very  standard  Pascal,  and  it  is  in the public domain.
  30. Therefore, RNF is good for  people  who  are  in  one  or  more  of  the
  31. following categories, people who:
  32.  
  33.      1.  Want a good word processor but don't want to  spend  a  lot  of
  34.          money for it, or
  35.  
  36.      2.  Like the editor they are already using for  programming  better
  37.          than the editor embedded in their word processor, or
  38.  
  39.      3.  Want to use more of the  special  features  of  their  printer,
  40.          which their current word processor does not allow, or
  41.  
  42.      4.  Cannot stand relying on tools (such  as  word  processors)  for
  43.          which they do not have the source code, because they cannot fix
  44.          those annoying little bugs and limitations, or
  45.  
  46.      5.  Want  to  learn  about  programming  by examining well-written,
  47.          moderately large programs, or
  48.  
  49.      6.  Need  a word processor which can run on many different computer
  50.          systems, while using the same document files.  You  have  a  PC
  51.          and  the  coauthors  of  your  book have a VAX and a Cyber?  No
  52.          problem!
  53.  
  54.      To prepare text for RNF, user your favorite editor.  Paragraphs can
  55. be  separated by a blank line, or, if the .AP (autoparagraph) command is
  56. given, by leading spaces or a tab.  Thus, you can  start  using  RNF  by
  57. just  creating  a  file  which  starts  with  .AP and then typing normal
  58.  
  59.  
  60.  
  61.  
  62.                                                                        2
  63.  
  64.  
  65. text--RNF will fill lines, divide into paragraphs, and number pages  for
  66. you.
  67.  
  68.      Even though RNF is very powerful,  you  can  learn  only  a  useful
  69. subset if you want.  It works fine on normal text with just an .AP.  You
  70. will soon be using simple things like underlining, centering,  automatic
  71. list  numbering,  hanging paragraphs, and "ASIS" mode.  Some people will
  72. then  want  to  try  variables,  conditionals,  include  files,   saving
  73. environments, and macros.
  74.  
  75.      Notice that three characters are used for special purposes: "_" "#"
  76. "\"  (underline, sharp, and backslash).  In addition, two characters are
  77. special only when they have letters immediately after them: "." and  "$"
  78. (period  and  dollar sign), and two more are special only when flags are
  79. set: "<" "^" (less than and uparrow).  To make special  characters  show
  80. on  the  output,  proceed  them  with  an underline "_" which quotes the
  81. special character.  Finally, control characters will not  appear  except
  82. through the .FMT command.
  83.  
  84.  
  85.      TO COMPILE: First, check that PAGE is appropriate for your printer;
  86. as  distributed,  RNF  assumes  that control-L does a page eject.  Using
  87. Turbo Pascal version 3 on MS-DOS, PC-DOS and CP/M-86, just read  RNF.PAS
  88. as the Main file, set the option to compile to disk, and compile it.  It
  89. will include several RNF?.PAS files.  For CP/M-80, un-comment the  three
  90. overlays  as  marked  in  RNF.PAS  before  compiling.   On  Turbo Pascal
  91. versions before ver 3, and on Prospero ProPascal or  VAX/VMS  Pascal,  a
  92. few  changes  will  have  to  be made before compiling, as marked in the
  93. comments.
  94.  
  95.  
  96.      TO PRINT THE MANUAL: You  must  compile  RNF  before  printing  the
  97. manual.   Try  a test printing of this small document; print it with the
  98. command:  "RNF RNFDOC.RNF".   To   print   the   entire   manual,   type
  99. "RNF RNFMAN.RNF".  Ignore the 20 or so warning messages about ASIS lines
  100. extending past the right margin, and the two warnings of an empty token.
  101. The manual is about 50 pages.
  102.  
  103.  
  104.      Good luck!
  105.  
  106. tending p