home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 4 / DATAFILE_PDCD4.iso / unix / riscbsd / 1_1_contri / usd / 24_troff / m0 < prev    next >
Encoding:
Text File  |  1986-04-17  |  6.6 KB  |  244 lines
  1. .\"    @(#)m0    6.1 (Berkeley) 4/17/86
  2. .\"
  3. .br
  4. .rs
  5. .sp |1.0i
  6. .ce1000
  7. .ps12
  8. .ftB
  9. \*(Nr\(sl\*(Tr User's Manual
  10. .sp .2i
  11. .ftI
  12. .ps10
  13. Joseph F. Ossanna
  14. (updated for 4.3BSD by Mark Seiden)
  15. .ftR
  16. .sp
  17. Bell Laboratories
  18. Murray Hill, New Jersey 07974
  19. .ce0
  20. .sp2
  21. .ps \n(PS
  22. .fi
  23. .ftB
  24. Introduction
  25. .pg
  26. \*(NR and \*(TR are text processors under
  27. the \s-1UNIX\s+1 Time-Sharing System
  28. that format text for typewriter-like terminals and
  29. for a \%Graphic Systems phototypesetter, respectively.
  30. (Device-independent \*(TR, part of the Documenter's Workbench,
  31. supports additional output devices.)
  32. They accept lines of text interspersed with lines of
  33. format control information and
  34. format the text into a printable, paginated document
  35. having a user-designed style.
  36. \*(NR and \*(TR offer
  37. unusual freedom in document styling,
  38. including:
  39. arbitrary style headers and footers;
  40. arbitrary style footnotes;
  41. multiple automatic sequence numbering for paragraphs, sections, etc;
  42. multiple column output;
  43. dynamic font and point-size control;
  44. arbitrary horizontal and vertical local motions at any point;
  45. and
  46. a family of automatic overstriking, bracket construction, and
  47. line drawing functions.
  48. .pg
  49. \*(NR and \*(TR are highly compatible with each other and it is almost always
  50. possible to prepare input acceptable to both.
  51. Conditional input is provided that enables
  52. the user to embed input expressly destined for either program.
  53. \*(NR can prepare output directly for a variety of terminal types and
  54. is capable of utilizing the full resolution of each terminal.
  55. .pg
  56. .ftB
  57. Usage
  58. .pg
  59. The general form of invoking \*(NR (or \*(TR) at \s-1UNIX\s+1 command level is
  60. .x1
  61. \fBnroff  \fIoptions  files\fR\
  62. \h'|2i'(or  \fBtroff  \fIoptions  files\fR)
  63. .x2
  64. where \fIoptions\fR represents any of a number of option arguments
  65. and \fIfiles\fR represents the list of files containing the document
  66. to be formatted.
  67. An argument consisting of a single minus (\fB\-\fR) is taken to be
  68. a file name corresponding to the standard input.
  69. If no file names are given input is taken from the standard input.
  70. The options, which may appear in any order so long as they appear
  71. before the files, are:
  72. .sp
  73. .ta .2i 1.0i
  74. .ftI
  75. .bd I 3
  76.     Option    Effect
  77. .br
  78. .bd I
  79. .ftR
  80. .ta .3i 1.0i
  81. .in 1.0i
  82. .ll-.3i
  83. .bt
  84.     \fB\-i\fP    Read standard input after the input files are exhausted.
  85. .bt
  86.     \fB\-m\fIname\fR    Prepends the macro file
  87. \fB\(slusr\(sllib\(sltmac.\fIname\fR
  88. to the input \fIfiles\fR.
  89. .bt
  90.     \fB\-n\fIN\fR    Number first generated page \fIN\fR.
  91. .bt
  92.     \fB\-o\fIlist\fR    \
  93. Print only pages whose page numbers appear in \fIlist\fR,
  94. which consists of comma-separated numbers and number ranges.
  95. A number range has the form \fIN\-M\fR
  96. and means pages \fIN\fR through \fIM;\fR
  97. a initial \fI\-N\fR means
  98. from the beginning to page \fIN;\fR and a final \fIN\-\fR means
  99. from \fIN\fR to the end.
  100. .bt
  101.     \fB\-q\fR    \
  102. Invoke the simultaneous input-output mode of the \fBrd\fR request.
  103. .bt
  104.     \fB\-r\fIaN\fR    Number register \fIa\fR (one-character) is set to \fIN\fR.
  105. .bt
  106.     \fB\-s\fIN\fR    Stop every \fIN\fR pages.
  107. \*(NR will halt prior to every \fIN\fR pages (default \fIN\fR=1)
  108. to allow paper loading or
  109. changing, and will resume upon receipt of a newline.
  110. \*(TR will stop the phototypesetter every \fIN\fR pages,
  111. produce a trailer to allow changing cassettes,
  112. and will resume after the phototypesetter \s-1START\s+1 button is pressed.
  113. .bt
  114.     \fB\-z\fR    Efficiently suppress formatted output.
  115. Only produce output to standard error (from \fBtm\fP requests or
  116. diagnostics).
  117. .sp
  118. .ne 3
  119. .ftI
  120. .bd I 3
  121.         \*(NR Only
  122. .br
  123. .bd I
  124. .ft
  125. .bt
  126.     \fB\-T\fIname\fR    Specifies
  127. the name of the output terminal type.
  128. Currently defined names are \fB37\fR for the (default) Model 37 Teletype\(rg,
  129. \fBtn300\fR for the GE TermiNet\ 300 (or any terminal without half-line
  130. capabilities),
  131. \fB300S\fR for the \s-1DASI\s+1-300S,
  132. \fB300\fR for the \s-1DASI\s+1-300,
  133. and
  134. \fB450\fR for the \s-1DASI\s+1-450 (Diablo Hyterm).
  135. .bt
  136.     \fB\-e\fR    \
  137. Produce equally-spaced words in adjusted
  138. lines, using full terminal resolution.
  139. .bt
  140.     \fB\-h\fR    \
  141. On output, use tabs during horizontal spacing to increase speed.
  142. Device tabs setting are assumed to be (and input tabs are initially 
  143. set to) every 8 character widths.
  144. .sp
  145. .ne 3
  146. .ftI
  147. .bd I 3
  148.         \*(TR Only
  149. .br
  150. .bd I
  151. .ft
  152. .bt
  153.     \fB\-a\fP    Send a printable \s-1(ASCII)\s+1 approximation
  154. of the results to the standard output.
  155. .bt
  156.     \fB\-b\fR    \*(TR will report whether the phototypesetter
  157. is busy or available.
  158. No text processing is done.
  159. .bt
  160.     \fB\-f\fP    Refrain from feeding out paper and stopping
  161. phototypesetter at the end of the run.
  162. .bt
  163.     \fB\-t\fP    Direct output to the standard output instead
  164. of the phototypesetter.
  165. .bt
  166.     \fB\-w\fP    Wait until phototypesetter is available, if
  167. currently busy.
  168. .ll
  169. .in0
  170. .xx
  171. .pg
  172. Each option is invoked as a separate argument;
  173. for example,
  174. .x1
  175. \fBnroff  \-o\fI4,8\-10  \fB\-T\fI300S  \fB\-m\fIabc  file1  file2\fR
  176. .x2
  177. requests formatting of pages 4, 8, 9, and 10 of a document contained in the files
  178. named \fIfile1\fR and \fIfile2\fR,
  179. specifies the output terminal as a \s-1DASI\s+1-300S,
  180. and invokes the macro package \fIabc\fR.
  181. .pg
  182. Various pre- and post-processors are available for use with \*(NR and \*(TR.
  183. These include the equation preprocessors \s-1NEQN\s+1 and \s-1EQN\s+1\*u1\*d
  184. (for \*(NR and \*(TR respectively),
  185. and the table-construction preprocessor \s-1TBL\s+1\*u2\*d.
  186. A reverse-line postprocessor \s-1COL\s+1\*u3\*d
  187. is available for multiple-column \*(NR output on terminals without reverse-line ability;
  188. \s-1COL\s+1 expects the Model 37 Teletype
  189. escape sequences that \*(NR produces by default.
  190. \s-1TK\s+1\*u3\*d
  191. is a 37 Teletype simulator postprocessor for printing \*(NR output on a Tektronix 4014.
  192. \s-1TC\s+1\*u5\*d
  193. is a phototypesetter-simulator postprocessor
  194. for \*(TR that produces an approximation of phototypesetter output
  195. on a Tektronix 4014.
  196. For example, in
  197. .x1
  198. \fBtbl  \fIfiles  \fB|  eqn  |  troff  \-t \fIoptions  \fB|  tc\fR
  199. .x2
  200. the first \|\fB|\fR\| indicates the piping of \s-1TBL\s+1's output to \s-1EQN\s+1's input;
  201. the second the piping of \s-1EQN\s+1's output to \*(TR's input;
  202. and the third indicates the piping of \*(TR's output to \s-1TC\s+1.
  203. .br
  204. .pg
  205. The remainder of this manual consists of:
  206. a Summary and outline;
  207. a Reference Manual keyed to the outline;
  208. and
  209. a set of Tutorial Examples.
  210. Another tutorial is [5].
  211. .sp.4
  212. .ps -1
  213. .vs -1p
  214. .pg
  215. .ftB
  216. References
  217. .pg
  218. .ta .3i
  219. .in .3i
  220. .ti0
  221. [1]    B. W. Kernighan, L. L. Cherry,
  222. .ul
  223. Typesetting Mathematics \(em User's Guide (Second Edition),
  224. Bell Laboratories.
  225. .sp.4
  226. .ti0
  227. [2]    M. E. Lesk,
  228. .ul
  229. Tbl \(em A Program to Format Tables,
  230. Bell Laboratories internal memorandum.
  231. .sp.4
  232. .ti0
  233. [3]    Internal on-line documentation (\fIman\fP pages) on \s-1UNIX\s+1.
  234. .sp.4
  235. .ti0
  236. [4]    B. W. Kernighan, \fIA TROFF Tutorial\fR,
  237. Bell Laboratories.
  238. .sp.4
  239. .ti0
  240. [5]    Your site may have similar programs for more modern displays.
  241. .in0
  242. .ps
  243. .vs
  244.