home *** CD-ROM | disk | FTP | other *** search
/ Zodiac Super OZ / MEDIADEPOT.ISO / FILES / 16 / FREEDOS.ZIP / FD_A4PRE.ZIP / SOURCE / DOCUMENT.ZIP / NRO.NRO < prev    next >
Text File  |  1995-04-18  |  11KB  |  359 lines

  1. .TH NRO
  2. .SH NAME
  3. nro - text processor
  4. .SH SYNOPSIS
  5. .bo
  6. nro [-n] [+n] [-pxx] [-v] [-u] [-b] [-mmfile] ifile ... [>ofile]
  7. .SH DESCRIPTION
  8. .ul
  9. NRO
  10. is a text processor and formatter based on the design
  11. provided in 
  12. .bo
  13. "Software Tools"
  14. by Kernighan and Plauger.
  15. The text and commands found in the
  16. .cu
  17. ifile(s)
  18. are processed to
  19. generate formatted text.
  20. The output may be directed into a file or to the printer,
  21. otherwise, the output will appear at
  22. the user console.
  23. .sp
  24. The
  25. .ul
  26. +n
  27. option causes the output to start with page
  28. .ul
  29. n.
  30. The
  31. .ul
  32. -n
  33. option causes the output to stop after page
  34. .ul
  35. n.
  36. .sp
  37. The
  38. .ul
  39. -v
  40. option prints the version number to the console.
  41. .sp
  42. The
  43. .ul
  44. -p
  45. option causes the output to be shifted to the right by
  46. .ul
  47. xx
  48. spaces.
  49. This has the same effect as the
  50. .cc +
  51. +bo
  52. .po
  53. command.
  54. +cc .
  55. .sp
  56. The
  57. .ul
  58. -u
  59. option enables underlining and bold to appear in the output text.
  60. .sp
  61. The
  62. .ul
  63. -b
  64. option allows backspaces to be used when
  65. underlining or overstriking.  Otherwise a carriage return without
  66. linefeed is used.  
  67. This has the same effect as the
  68. .cc +
  69. +bo
  70. .bs
  71. command with a non-zero argument.
  72. +cc .
  73. .sp
  74. The
  75. .ul
  76. -m
  77. option processes the file
  78. .ul
  79. mfile
  80. for macro definitions.
  81. Note that files processed in this way should contain only macro
  82. definitions, no immediate output should be generated from this file.
  83. .sp
  84. Commands typically are distinguished by a period in column one of the input
  85. followed by a two character abbreviation for the command funtion.
  86. The abbreviation may then be followed by an optional numeric or
  87. character argument.
  88. The numeric argument may be an absolute value such as setting
  89. the right margin to a particular column, or the argument may be
  90. preceded by a plus sign or a minus sign to indicate that the
  91. parameter should be modified relative to a previous setting.
  92. The following commands are recognized:
  93. .sp
  94. .nj
  95. .in +6
  96. .br
  97. .ti -6
  98. .cc !
  99. .bo - causes the following lines of text to appear in
  100. boldface.
  101. The optional argument specifies the number of lines to
  102. be typed in boldface.
  103. Boldface and underlining are mutually exclusive features.
  104. The appearance of a boldface command will cause any underlining
  105. to cease.
  106. !sp
  107. !ti -6
  108. .bp - causes succeeding text to appear at the top of
  109. a new page.
  110. The optional argument specifies the page number for the new page.
  111. The initial value is one and the default value is one more than
  112. the previous page number.
  113. !sp
  114. !ti -6
  115. .br - causes succeeding text to start on a new line at the
  116. current left margin.
  117. There is no numeric argument for this command.
  118. !sp
  119. !ti -6
  120. .bs - enables or disables the appearance of backspaces
  121. in the output text.
  122. Underlining and boldface options are implemented by inserting
  123. character - backspace - character combinations into the output
  124. buffer.
  125. This is fine for devices which properly recognize the backspace
  126. character.
  127. Some printers, however, do not recognize backspaces, so the option is
  128. provided to overprint one line buffer with another.
  129. The first line buffer is terminated with just a carriage return
  130. rather than the carriage return - linefeed combination.
  131. A zero argument or no argument to the backspace command removes
  132. backspaces from the output.
  133. A non-zero argument leaves them in the output.
  134. The default is to remove backspaces.
  135. !sp
  136. !ti -6
  137. .cc - changes the
  138. !ul
  139. NRO
  140. command character to that specified by the character argument.
  141. If no argument is provided, the default is a period.
  142. !sp
  143. !ti -6
  144. .ce - causes the next line of text to appear centered on the output.
  145. The optional argument specifies if more than one line is to be centered.
  146. !sp
  147. !ti -6
  148. .de - causes all text and commands following to be used to define
  149. a macro.
  150. The definition is terminated by a
  151. !bo
  152. .en
  153. command.
  154. The first two characters of the argument following the
  155. !bo
  156. .de
  157. command become the name of the new command.
  158. It should be noted that upper and lower case arguments are considered
  159. different.
  160. Thus, the commands
  161. !bo
  162. .PP
  163. and
  164. !bo
  165. .pp
  166. could define two different macros.
  167. Care should be exercised since existing commands may be redefined.
  168. !sp
  169. A macro may contain up to ten arguments.
  170. In the macro definition, the placement of arguments is designated by the
  171. two character sequences, $0, $1, ... $9.
  172. When the macro is invoked, each argument of the macro command line is
  173. substituted for its corresponding designator in the expansion.
  174. The first argument of the macro command is substituted for the $0
  175. in the expansion, the second argument for the $1, and so forth.
  176. Arguments are typically strings which do not contain blanks or tabs.
  177. If an argument is to contain blanks, then it should be surrounded by
  178. either single or double quotes. 
  179. !sp
  180. !ti -6
  181. .cu - causes the next line(s) of text to be continuously underlined.
  182. Unlike the underline command (see
  183. !bo
  184. .ul)
  185. which underlines only alphanumerics, continuous underlining underlines
  186. all printable characters.
  187. The optional argument specifies the number of lines of text to underlined.
  188. Any normal underlining or boldface commands currently in effect will be
  189. terminated.
  190. !sp
  191. !ti -6
  192. .ef - specifies the text for the footer on even numbered pages.
  193. The format is the same as for the footer command (see
  194. !bo
  195. .fo).
  196. !sp
  197. !ti -6
  198. .eh - specifies the text for the header on even numbered pages.
  199. The format is the same as for the footer command (see
  200. !bo
  201. .fo).
  202. !sp
  203. !ti -6
  204. .en - designates the end of a macro definition.
  205. !sp
  206. !ti -6
  207. .fi - causes the input text to be rearranged or filled to obtain the
  208. maximum word count possible between the previously set left and
  209. right margins.
  210. No argument is expected.
  211. !sp
  212. !ti -6
  213. .fo - specifies text to be used for a footer.
  214. The footer text contains three strings seperated by a delimiter
  215. character.
  216. The first non-blank character following the command is designated
  217. as the delimiter.
  218. The first text string is left justified to the current indentation
  219. value (specified by
  220. !bo
  221. .in).
  222. The second string is centered between the current indentation value
  223. and the current right margin value (specified by
  224. !bo
  225. .rm).
  226. The third string is right justified to the current right margin value.
  227. The absence of footer text will result in the footer being printed as
  228. one blank line.
  229. The presence of the page number character (set by
  230. !bo
  231. .pc)
  232. in the footer text results
  233. in the current page number being inserted at that position.
  234. Multiple occurrances of the page number character are allowed.
  235. !sp
  236. !ti -6
  237. .he - specifies text to be used for a header.
  238. The format is the same as for the footer (see
  239. !bo
  240. .fo).
  241. !sp
  242. !ti -6
  243. .in - indents the left margin to the column value specified by the argument.
  244. The default left margin is set to zero.
  245. !sp
  246. !ti -6
  247. .ju - causes blanks to be inserted between words in a line of
  248. output in order to align or justify the right margin.
  249. The default is to justify.
  250. !sp
  251. !ti -6
  252. .ls - sets the line spacing to the value specified by the argument.
  253. The default is for single spacing.
  254. !sp
  255. !ti -6
  256. .m1 - specifies the number of lines in the header margin.
  257. This is the space from the physical top of page to and including
  258. the header text.
  259. A value of zero causes the header to not be printed.
  260. A value of one causes the header to appear at the physical top of page.
  261. Larger argument values cause the appropriate number of blank
  262. lines to appear before the header is printed.
  263. !sp
  264. !ti -6
  265. .m2 - specifies the number of blank lines to be printed between
  266. the header line and the first line of the processed text.
  267. !sp
  268. !ti -6
  269. .m3 - specifies the number of blank lines to be printed between
  270. the last line of processed text and the footer line.
  271. !sp
  272. !ti -6
  273. .m4 - specifies the number of lines in the footer margin.
  274. This command affects the footer the same way the
  275. !bo
  276. .m1
  277. command
  278. affects the header.
  279. !sp
  280. !ti -6
  281. .ne - specifies a number of lines which should not be broken
  282. across a page boundary.
  283. If the number of lines remaining on a page is less than the
  284. value needed, then a new output page is started.
  285. !sp
  286. !ti -6
  287. .nf - specifies that succeeding text should be printed without
  288. rearrangement, or with no fill.
  289. No argument is expected.
  290. !sp
  291. !ti -6
  292. .nj - specifies that no attempt should be made to align or justify
  293. the right margin.
  294. No argument is expected.
  295. !sp
  296. !ti -6
  297. .nr - causes the value of a number register to be set or modified.
  298. A total of twenty-six number registers are available designated
  299. @@na through @@nz (either upper or lower case is allowed).
  300. When the sequence @@nc is imbedded in the text, the current value
  301. of number register c replaces the sequence, thus, such things as
  302. paragraph numbering can be accomplished with relative ease.
  303. !sp
  304. !ti -6
  305. .of - specifies the text for the footer on odd numbered pages.
  306. The format is the same as the footer command (see
  307. !bo
  308. .fo).
  309. !sp
  310. !ti -6
  311. .oh - specifies the text for the header on odd numbered pages.
  312. The format is the same as the footer command (see
  313. !bo
  314. .fo).
  315. !sp
  316. !ti -6
  317. .pc - specifies the page number character to be used in headers
  318. and footers.
  319. The occurrance of this character in the header or footer text
  320. results in the current page number being printed.
  321. The default for this character is the hash mark (#).
  322. !sp
  323. !ti -6
  324. .pl - specifies the page lenght or the number of lines per output page.
  325. The default is sixty-six.
  326. !sp
  327. !ti -6
  328. .po - specifies a page offset value.
  329. This allows the formatted text to be shifted to the right by
  330. the number of spaces specified.
  331. This feature may also be invoked by a switch on the command line.
  332. !sp
  333. !ti -6
  334. .rm - sets the column value for the right margin.
  335. The default is eighty.
  336. !sp
  337. !ti -6
  338. .so - causes input to be retrieved from the file specified
  339. by the command's character string argument.
  340. The contents of the new file are inserted into the output
  341. stream until an EOF is detected.
  342. Processing of the original file is then resumed.
  343. Command nesting is allowed.
  344. !sp
  345. !ti -6
  346. .sp - specifies a number of blank lines to be output before
  347. printing the next line of text.
  348. !sp
  349. !ti -6
  350. .ti - temporarily alters the indentation or left margin value for a single
  351. succeeding line of text.
  352. !sp
  353. !ti -6
  354. .ul - underlines the alphanumeric text in the following line(s).
  355. The optional argument specifies the number of lines to be underlined.
  356. Underlining and boldface are mutually exclusive features.
  357. The appearance of an underline command cancels any existing
  358. boldface operations.
  359.