home *** CD-ROM | disk | FTP | other *** search
/ minnie.tuhs.org / unixen.tar / unixen / PDP-11 / Trees / V6 / usr / man / man1 / roff.1 < prev    next >
Encoding:
Text File  |  1975-06-26  |  6.1 KB  |  291 lines
  1. .th ROFF I 11/4/74
  2. .sh NAME
  3. roff  \*-  format text
  4. .sh SYNOPSIS
  5. .bd roff
  6. [ \fB+\fIn\fR ] [ \fB\*-\fIn\fR ] [
  7. .bd \*-s
  8. ] [
  9. .bd \*-h
  10. ] file ...
  11. .sh DESCRIPTION
  12. .it Roff
  13. formats text according to control lines embedded
  14. in the text in the given files.
  15. Encountering a nonexistent file terminates printing.
  16. Incoming interconsole messages are turned off during printing.
  17. The optional flag arguments mean:
  18. .s3
  19. .lp +5 5
  20. \fB+\fIn\fR    Start printing at the first page with number \fIn\fR.
  21. .s3
  22. .lp +5 5
  23. \fB\*-\fIn\fR    Stop printing at the first page numbered higher
  24. than \fIn\fR.
  25. .s3
  26. .lp +5 5
  27. \fB\*-s\fR    Stop before each page (including the first)
  28. to allow paper manipulation;
  29. resume on receipt of an interrupt signal.
  30. .s3
  31. .lp +5 5
  32. \fB\*-h\fR    Insert tabs in the output stream to replace
  33. spaces whenever appropriate.
  34. .s3
  35. .i0
  36. .dt
  37. Input consists of intermixed
  38. .it "text lines,"
  39. which contain information to be formatted, and
  40. .it "request lines,"
  41. which contain instructions about how to format
  42. it.
  43. Request lines begin with a distinguished
  44. .it "control character,"
  45. normally a period.
  46. .s3
  47. Output lines may be
  48. .it filled
  49. as nearly as possible with words without regard to
  50. input lineation.
  51. Line
  52. .it breaks
  53. may be caused at specified places by
  54. certain commands, or by the appearance of an
  55. empty input line or an input line beginning with a space.
  56. .s3
  57. The capabilities of
  58. .it roff
  59. are specified in the attached Request Summary.
  60. Numerical values are denoted there by n or +n,
  61. titles by t, and single characters by c.
  62. Numbers denoted +n may be signed + or \*-,
  63. in which case they signify relative changes to
  64. a quantity, otherwise they signify
  65. an absolute resetting.
  66. Missing n fields are ordinarily taken to be 1,
  67. missing t fields to be empty, and c fields to shut off
  68. the appropriate special interpretation.
  69. .s3
  70. Running titles usually appear at top and bottom of every
  71. page.
  72. They are set by requests like
  73. .s3
  74. .in +10
  75. .if t \&.he \(fmpart1\(fmpart2\(fmpart3\(fm
  76. .if n \&.he 'part1'part2'part3'
  77. .in -10
  78. .s3
  79. Part1 is left justified, part2 is centered,
  80. and part3 is right justified on the page.
  81. Any % sign in a title is replaced by the current
  82. page number.
  83. Any nonblank may serve as a quote.
  84. .s3
  85. ASCII tab characters are replaced in the input by a
  86. .it "replacement character,"
  87. normally a space,
  88. according to the
  89. column settings given by a .ta command.
  90. (See .tr for how to convert this character on output.)
  91. .s3
  92. Automatic hyphenation of filled output is done
  93. under control of .hy.
  94. When a word contains a designated
  95. .it "hyphenation character,"
  96. that character disappears from the output and
  97. hyphens can be introduced into
  98. the word at the marked places only.
  99. .sh FILES
  100. /usr/lib/suftab    suffix hyphenation tables
  101. .br
  102. /tmp/rtm?    temporary
  103. .br
  104. .sh "SEE ALSO"
  105. nroff (I), troff (I)
  106. .sh BUGS
  107. .it Roff
  108. is the simplest of the runoff
  109. programs, but is utterly frozen.
  110. .bp
  111. .tc |
  112. .tr |
  113. .in 0
  114. .ce
  115. REQUEST SUMMARY
  116. .s3
  117. .ul
  118. .if t .ta .75i 1.5i 2.25i
  119. .if n .ta 9 17 25 33
  120. Request    Break    Initial    Meaning
  121. .if t .in2.25i
  122. .if n .in24
  123. .na
  124. .ti 0
  125. .li
  126. .ad    yes    yes    Begin adjusting right margins.
  127. .ti 0
  128. .li
  129. .ar    no    arabic    Arabic page numbers.
  130. .ti 0
  131. .li
  132. .br    yes    -    Causes a line break \*- the filling of
  133. the current line is stopped.
  134. .ti 0
  135. .li
  136. .bl|n    yes    -    Insert of n blank lines, on new page if necessary.
  137. .ti 0
  138. .li
  139. .bp|+n    yes    n=1    Begin new page and number it n; no n means `+1'.
  140. .ti 0
  141. .li
  142. .cc|c    no    c=.    Control character becomes `c'.
  143. .ti 0
  144. .li
  145. .ce|n    yes    -    Center the next n input lines,
  146. without filling.
  147. .ti 0
  148. .li
  149. .de|xx    no    -    Define parameterless macro 
  150. to be invoked by request `.xx'
  151. (definition ends on line beginning `\fB..\fR').
  152. .ti 0
  153. .li
  154. .ds    yes    no    Double space; same as `.ls 2'.
  155. .ti 0
  156. .li
  157. .ef|t    no    t=\*a\*a\*a\*a    Even foot title becomes t.
  158. .ti 0
  159. .li
  160. .eh|t    no    t=\*a\*a\*a\*a    Even head title becomes t.
  161. .ti 0
  162. .li
  163. .fi    yes    yes    Begin filling output lines.
  164. .ti 0
  165. .li
  166. .fo    no    t=\*a\*a\*a\*a    All foot titles are t.
  167. .ti 0
  168. .li
  169. .hc|c    no    none    Hyphenation character becomes `c'.
  170. .ti 0
  171. .li
  172. .he|t    no    t=\*a\*a\*a\*a    All head titles are t.
  173. .ti 0
  174. .li
  175. .hx    no    -    Title lines are suppressed.
  176. .ti 0
  177. .li
  178. .hy|n    no    n=1    Hyphenation is done, if n=1;
  179. and is not done, if n=0.
  180. .ti 0
  181. .li
  182. .ig    no    -    Ignore input lines through
  183. a line beginning with `\fB..\fR'.
  184. .ti 0
  185. .li
  186. .in|+n    yes    -    Indent n spaces from left margin.
  187. .ti 0
  188. .li
  189. .ix +n    no    -    Same as `.in' but without break.
  190. .ti 0
  191. .li
  192. .li|n    no    -    Literal, treat next n lines as text.
  193. .ti 0
  194. .li
  195. .ll|+n    no    n=65    Line length including indent is n characters.
  196. .ti 0
  197. .li
  198. .ls|+n    yes    n=1    Line spacing set to n lines per output line.
  199. .ti 0
  200. .li
  201. .m1|n    no    n=2    Put n blank lines between the top
  202. of page and head title.
  203. .ti 0
  204. .li
  205. .m2|n    no    n=2    n blank lines put between head title
  206. and beginning of text on page.
  207. .ti 0
  208. .li
  209. .m3|n    no    n=1    n blank lines put between end of
  210. text and foot title.
  211. .ti 0
  212. .li
  213. .m4|n    no    n=3    n blank lines put between the foot title
  214. and the bottom of page.
  215. .ti 0
  216. .li
  217. .na    yes    no    Stop adjusting the right margin.
  218. .ti 0
  219. .li
  220. .ne|n    no    -    Begin new page, if n output lines
  221. cannot fit on present page.
  222. .ti 0
  223. .li
  224. .nn|+n    no    -    The next n output lines are not numbered.
  225. .ti 0
  226. .li
  227. .n1    no    no    Add 5 to page offset;
  228. number lines in margin from 1 on each page.
  229. .ti 0
  230. .li
  231. .n2|n    no    no    Add 5 to page offset;
  232. number lines from n;
  233. stop if n=0.
  234. .ti 0
  235. .li
  236. .ni|+n    no    n=0    Line numbers are indented n.
  237. .ti 0
  238. .li
  239. .nf    yes    no    Stop filling output lines.
  240. .ti 0
  241. .li
  242. .nx|filename    -    Change to input file `filename'.
  243. .ti 0
  244. .li
  245. .of|t    no    t=\*a\*a\*a\*a    Odd foot title becomes t.
  246. .ti 0
  247. .li
  248. .oh|t    no    t=\*a\*a\*a\*a    Odd head title becomes t.
  249. .ti 0
  250. .li
  251. .pa|+n    yes    n=1    Same as `.bp'.
  252. .ti 0
  253. .li
  254. .pl|+n    no    n=66    Total paper length taken to be n lines.
  255. .ti 0
  256. .li
  257. .po|+n    no    n=0    Page offset.
  258. All lines are preceded by n spaces.
  259. .ti 0
  260. .li
  261. .ro    no    arabic    Roman page numbers.
  262. .ti 0
  263. .li
  264. .sk|n    no    -    Produce n blank pages starting next page.
  265. .ti 0
  266. .li
  267. .sp|n    yes    -    Insert block of n blank lines,
  268. except at top of page.
  269. .ti 0
  270. .li
  271. .ss    yes    yes    Single space output lines,
  272. equivalent to `.ls 1'.
  273. .ti 0
  274. .li
  275. .ta|n|n..        -    Pseudotab settings.
  276. Initial tab settings are columns 9 17 25 ...
  277. .ti 0
  278. .li
  279. .tc|c    no    space    Tab replacement character becomes `c'.
  280. .ti 0
  281. .li
  282. .ti|+n    yes    -    Temporarily indent next output
  283. line n spaces.
  284. .ti0
  285. .li
  286. .tr|cdef..    no    -    Translate c into d, e into f, etc.
  287. .ti0
  288. .li
  289. .ul|n    no    -    Underline the letters and numbers
  290. in the next n input lines.
  291.