PageRenderTime 63ms CodeModel.GetById 22ms RepoModel.GetById 0ms app.codeStats 0ms

/contrib/groff/contrib/mm/groff_mm.man

https://bitbucket.org/freebsd/freebsd-head/
Unknown | 2104 lines | 2100 code | 4 blank | 0 comment | 0 complexity | 9c8ff93217b5f40186c77e6b9ce0b975 MD5 | raw file
Possible License(s): MPL-2.0-no-copyleft-exception, BSD-3-Clause, LGPL-2.0, LGPL-2.1, BSD-2-Clause, 0BSD, JSON, AGPL-1.0, GPL-2.0
  1. .\"
  2. .\" $Id: groff_mm.man,v 2.13 2004/07/03 12:46:56 wlemb Exp $
  3. .\"
  4. .de T2
  5. .if t .ne 2v
  6. .ti -.5i
  7. \\$1
  8. .sp -1
  9. ..
  10. .
  11. .de T3
  12. .if t .ne 2v
  13. .ti -.5i
  14. \fB\\$1\fP
  15. .br
  16. ..
  17. .
  18. .TH GROFF_MM @MAN7EXT@ "@MDATE@" "Groff Version @VERSION@"
  19. .SH NAME
  20. groff_mm \- groff mm macros
  21. .SH SYNOPSIS
  22. .B groff
  23. .B \-m@TMAC_M_PREFIX@m
  24. [
  25. .IR options .\|.\|.
  26. ]
  27. [
  28. .IR files .\|.\|.
  29. ]
  30. .SH DESCRIPTION
  31. The groff mm macros are intended to be compatible with the DWB mm macros
  32. with the following limitations:
  33. .TP
  34. .B \(bu
  35. no Bell Labs localisms implemented.
  36. .TP
  37. .B \(bu
  38. the macros OK and PM are not implemented.
  39. .TP
  40. .B \(bu
  41. groff mm does not support cut marks
  42. .LP
  43. \fBm@TMAC_M_PREFIX@m\fP is intended to be international.
  44. Therefore it is
  45. possible to write short national macrofiles which change all
  46. english text to the preferred language.
  47. Use \fBm@TMAC_M_PREFIX@mse\fP as an example.
  48. .\"########################################################################
  49. .LP
  50. A file called \fBlocale\fP or \fIlang\fP\fB_locale\fP is read
  51. after the initiation of the global variables.
  52. It is therefore
  53. possible to localize the macros with companyname and so on.
  54. .sp
  55. In this manual square brackets is used to show optional arguments.
  56. .sp 3
  57. \fBNumber registers and strings\fP
  58. .br
  59. Many macros can be controlled by number registers and strings.
  60. A number register is assigned with the \fBnr\fP command:
  61. .br
  62. \fB\&.nr\fP \fIXXX\fP \fI[+-]n [i]\fP
  63. .br
  64. \fBXXX\fP is the name of the register, \fBn\fP is the value to
  65. be assigned, and \fBi\fP is increment value for auto-increment.
  66. \fBn\fP can have a plus or minus sign as prefix if an increment
  67. or decrement of the current value is wanted.
  68. (Auto-increment or decrement
  69. occurs if the number register is used with a plus or minus sign,
  70. \fB\en+[XXX]\fP or \fB\en-[XXX]\fP.)
  71. .sp
  72. Strings is defined with \fBds\fP.
  73. .br
  74. \fB\&.ds\fP \fIYYY string\fP
  75. .br
  76. The string is assigned everything to the end of the line, even blanks.
  77. Initial blanks in \fIstring\fP should be prefixed with
  78. a double-quote.
  79. (Strings are used in the text as \fB\e*[YYY]\fP.)
  80. .sp
  81. \fBSpecial formatting of number registers\fP
  82. .br
  83. A number register is printed with normal digits if no format has been
  84. given.
  85. Set the format with \fBaf\fP:
  86. .br
  87. \fB\&.af\fP \fIR c\fP
  88. .br
  89. \fIR\fP is the name of the register, \fIc\fP is the format.
  90. .in +.5i
  91. .T2 \fBForm\fP
  92. \fBSequence\fP
  93. .T2 1
  94. 0, 1, 2, 3, ...
  95. .T2 001
  96. 000, 001, 002, 003, ...
  97. .T2 i
  98. 0, i, ii, iii, iv, ...
  99. .T2 I
  100. 0, I, II, III, IV, ...
  101. .T2 a
  102. 0, a, b, c, ..., z, aa, ab, ...
  103. .T2 A
  104. 0, A, B, C, ..., Z, AA, AB, ...
  105. .in
  106. .LP
  107. \fBMacros:\fP
  108. .TP
  109. .B ")E level text"
  110. Adds \fBtext\fP (heading-text) to the table of contents
  111. with \fBlevel\fP either 0
  112. or between 1-7.
  113. See also \fB.H\fP.
  114. This macro is used for customized
  115. table of contents.
  116. .TP
  117. .B "1C [1]"
  118. Begin one column processing.
  119. An \fB1\fP as argument disables the page-break.
  120. Use wide footnotes, small footnotes may be overprinted.
  121. .TP
  122. .B 2C
  123. Begin two column processing.
  124. Splits the page in two columns.
  125. It is
  126. a special case of \fBMC\fP.
  127. See also \fB1C\fP.
  128. .TP
  129. .B AE
  130. Abstract end, see \fBAS\fP.
  131. .TP
  132. .B "AF [name of firm]"
  133. Authors firm, should be called before \fBAU\fP, see also \fBCOVER\fP.
  134. .TP
  135. .B "AL [type [text-indent [1]]]"
  136. Start autoincrement list.
  137. Items are numbered beginning on one.
  138. The \fItype\fP argument controls the type of numbers.
  139. .in +.5i
  140. .T2 Arg
  141. Description
  142. .T2 1
  143. Arabic (the default)
  144. .T2 A
  145. Upper-case letters (A-Z)
  146. .T2 a
  147. Lower-case letters (a-z)
  148. .T2 I
  149. Upper-case roman
  150. .T2 i
  151. Lower-case roman
  152. .in
  153. \fIText-indent\fP sets the indent and overrides \fBLi\fP.
  154. A third argument will prohibit printing of a blank line before each
  155. item.
  156. .TP
  157. .B "APP name text"
  158. Begin an appendix with name \fIname\fP.
  159. Automatic naming occurs if
  160. \fIname\fP is "".
  161. The appendixes starts with \fBA\fP if auto is used.
  162. An new page is ejected, and a header is also produced if the number
  163. variable \fBAph\fP is non-zero.
  164. This is the default.
  165. The appendix always appear in the 'List of contents' with correct
  166. pagenumber.
  167. The name \fIAPPENDIX\fP can be changed by setting
  168. the string \fBApp\fP to the desired text.
  169. The string \fBApptxt\fP contains the current appendix text.
  170. .TP
  171. .B "APPSK name pages text"
  172. Same as \fB.APP\fP, but the pagenr is incremented with \fIpages\fP.
  173. This is used when diagrams or other non-formatted documents are
  174. included as appendixes.
  175. .TP
  176. .B "AS [arg [indent]]"
  177. Abstract start.
  178. Indent is specified in 'ens', but scaling is allowed.
  179. Argument \fIarg\fP controls where the abstract is printed.
  180. .in +.5i
  181. .T2 Arg
  182. Placement
  183. .T2 0
  184. Abstract will be printed on page 1 and on the cover sheet if
  185. used in the released-paper style (\fBMT 4\fP), otherwise
  186. it will be printed on page 1 without a cover sheet.
  187. .T2 1
  188. Abstract will only be printed on the cover sheet (\fBMT 4\fP only).
  189. .T2 2
  190. Abstract will be printed only on the cover sheet (other than \fBMT 4\fP only).
  191. The cover sheet is printed without need for \fBCS\fP.
  192. .in
  193. Abstract is not printed at all in external letters (\fBMT 5\fP).
  194. The \fIindent\fP controls the indentation of both margins, otherwise
  195. will normal text indent be used.
  196. .TP
  197. .B "AST [title]"
  198. Abstract title.
  199. Default is \fBABSTRACT\fP.
  200. Sets the text above the abstract text.
  201. .TP
  202. .B "AT title1 [title2 ...]"
  203. Authors title.
  204. \fBAT\fP must appear just after each \fBAU\fP.
  205. The title will show up after the name in the signature block.
  206. .TP
  207. .B "AU [name [initials [loc [dept [ext [room [arg [arg [arg]]]]]]]]]"
  208. Author information, specifies the author of the memo or paper, and
  209. will be printed on the cover sheet and on other similar places.
  210. \fBAU\fP must not appear before \fBTL\fP.
  211. The author information
  212. can contain initials, location, department, telephone extension,
  213. room number or name and up to three extra arguments.
  214. .TP
  215. .B "AV [name [1]]"
  216. Approval signature, generates an approval line with place for
  217. signature and date.
  218. The string \fBAPPROVED:\fP can be changed
  219. with variable \fBLetapp\fP, and the string \fBDate\fP in \fBLetdate\fP.
  220. .TP
  221. .B "AVL [name]"
  222. Letter signature, generates a line with place for signature.
  223. .TP
  224. .B "B [bold-text [prev-font-text [bold...]]]"
  225. Begin boldface.
  226. No limit on the number of arguments.
  227. All arguments will be concatenated to one word, the first, third and so
  228. on will be printed in boldface.
  229. .TP
  230. .B B1
  231. Begin box (as the ms macro).
  232. Draws a box around the text.
  233. The text will be indented one character,
  234. and the right margin will be one character shorter.
  235. .TP
  236. .B B2
  237. End box.
  238. Finish the box started by \fBB1\fP.
  239. .TP
  240. .B BE
  241. End bottom block, see \fBBS\fP.
  242. .TP
  243. .B "BI [bold-text [italic-text [bold-text [...]]]]"
  244. Bold-italic.
  245. No limit on the number of arguments, see \fBB\fP.
  246. .TP
  247. .B "BL [text-indent [1]]"
  248. Start bullet list, initialize a list with a bullet and a space
  249. in the beginning of each list item (see \fBLI\fP).
  250. \fIText-indent\fP
  251. overrides the default indentation of the list items set by
  252. number register \fBPi\fP.
  253. A third argument will prohibit printing of a blank line before each
  254. item.
  255. .TP
  256. .B "BR [bold-text [roman-text [bold-text [...]]]]"
  257. Bold-roman.
  258. No limit on the number of arguments.
  259. .TP
  260. .B BS
  261. Bottom block start.
  262. Begins the definition of a text block which is
  263. printed at the bottom of each page.
  264. Block ends with \fBBE\fP.
  265. .TP
  266. .B "BVL text-indent [mark-indent [1]]"
  267. Start of
  268. broken variable-item list.
  269. Broken variable-item list has no fixed mark, it assumes that
  270. every \fBLI\fP has a mark instead.
  271. The text will always begin at the next line after the mark.
  272. \fIText-indent\fP sets the indent to the text, and \fImark-indent\fP
  273. the distance from the current indent to the mark.
  274. A third argument will prohibit printing of a blank line before each
  275. item.
  276. .TP
  277. .B "COVER [arg]"
  278. \&\fBCOVER\fP begins a coversheet definition.
  279. It is important
  280. that \fB.COVER\fP appears before any normal text.
  281. \&\fB.COVER\fP uses \fIarg\fP to build the filename
  282. @TMAC_MDIR@/\fIarg\fP.cov.
  283. Therefore it is possible to create unlimited
  284. types of coversheets.
  285. \fIms.cov\fP is supposed to look like the \fBms\fP coversheet.
  286. \&\fB.COVER\fP requires a \fB.COVEND\fP at the end of the coverdefinition.
  287. Always use this order of the covermacros:
  288. .nf
  289. \&.COVER
  290. \&.TL
  291. \&.AF
  292. \&.AU
  293. \&.AT
  294. \&.AS
  295. \&.AE
  296. \&.COVEND
  297. .fi
  298. However, only \fB.TL\fP and \fB.AU\fP are required.
  299. .TP
  300. .B COVEND
  301. This finish the cover description and prints the cover-page.
  302. It is defined in the cover file.
  303. .TP
  304. .B DE
  305. Display end.
  306. Ends a block of text, display, that begins
  307. with \fBDS\fP or \fBDF\fP.
  308. .TP
  309. .B "DF [format [fill [rindent]]]"
  310. Begin floating display (no nesting allowed).
  311. A floating display is saved in a queue and is printed in the
  312. order entered.
  313. \fIFormat\fP, \fIfill\fP and \fIrindent\fP is the same
  314. as in \fBDS\fP.
  315. Floating displays are controlled by the two number registers \fBDe\fP
  316. and \fBDf\fP.
  317. .sp
  318. \fBDe register\fP
  319. .in +.5i
  320. .T2 0
  321. Nothing special, this is the default.
  322. .T2 1
  323. A page eject will occur after each printed display, giving only
  324. one display per page and no text following it.
  325. .in
  326. .sp
  327. \fBDf register\fP
  328. .in +.5i
  329. .T2 0
  330. Displays are printed at the end of each section (when section-page
  331. numbering is active) or at the end of the document.
  332. .T2 1
  333. A new display will be printed on the current page if there is enough
  334. space, otherwise it will be printed at the end of the document.
  335. .T2 2
  336. One display will be printed at the top of each page or column
  337. (in multi-column mode).
  338. .T2 3
  339. Print one display if there is enough space for it, otherwise it will
  340. be printed at the top of the next page or column.
  341. .T2 4
  342. Print as many displays that will fit in a new page or column.
  343. A page break will occur between each display if \fBDe\fP is not zero.
  344. .T2 5
  345. Fill the current page with displays and the rest beginning at a new page
  346. or column.
  347. (This is the default.)
  348. A page break will occur between each display
  349. if \fBDe\fP is not zero.
  350. .in
  351. .TP
  352. .B "DL [text-indent [1 [1]]]"
  353. Dash list start.
  354. Begins a list where each item is printed
  355. after a dash.
  356. \fIText-indent\fP changes the default indentation
  357. of the list items set by
  358. number register \fBPi\fP.
  359. A second argument prevents the empty line between each list item
  360. to be printed.
  361. See \fBLI\fP.
  362. A third argument will prohibit printing of a blank line before each
  363. item.
  364. .TP
  365. .B "DS [format [fill [rindent]]]"
  366. Static display start.
  367. Begins collection of text until \fBDE\fP.
  368. The text is printed together on the same page, unless it is longer
  369. than the height of the page.
  370. \fBDS\fP can be nested to a unlimited depth (reasonably :-).
  371. .sp
  372. \fBformat\fP
  373. .in +.5i
  374. .ds x "
  375. .T2 """"""
  376. No indentation.
  377. .T2 none
  378. No indentation.
  379. .T2 L
  380. No indentation.
  381. .T2 I
  382. Indent text with the value of number register \fBSi\fP.
  383. .T2 C
  384. Center each line
  385. .T2 CB
  386. Center the whole display as a block.
  387. .T2 R
  388. Right adjust the lines.
  389. .T2 RB
  390. Right adjust the whole display as a block
  391. .in
  392. .sp
  393. L, I, C and CB can also be specified as 0, 1, 2 or 3 for compatibility
  394. reasons.
  395. (Don't use it.\ :-)
  396. .sp
  397. \fBfill\fP
  398. .in +.5i
  399. .T2 """"""
  400. Line-filling turned off.
  401. .T2 none
  402. Line-filling turned off.
  403. .T2 N
  404. Line-filling turned off.
  405. .T2 F
  406. Line-filling turned on.
  407. .in
  408. .sp
  409. N and F can also be specified as 0 or 1.
  410. An empty line will normally be printed before and after the
  411. display.
  412. Setting number register \fBDs\fP to 0 will prevent this.
  413. \fIRindent\fP shortens the line length by that amount.
  414. .TP
  415. .B "EC [title [override [flag [refname]]]]"
  416. Equation title.
  417. Sets a title for an equation.
  418. The \fIoverride\fP argument
  419. change the numbering.
  420. .sp
  421. \fBflag\fP
  422. .in +.5i
  423. .T2 none
  424. \fIoverride\fP is a prefix to the number.
  425. .T2 0
  426. \fIoverride\fP is a prefix to the number.
  427. .T2 1
  428. \fIoverride\fP is a suffix to the number.
  429. .T2 2
  430. \fIoverride\fP replaces the number.
  431. .in
  432. \fBEC\fP uses the number register \fBEc\fP as counter.
  433. It is possible to use \fB.af\fP to change the format of the number.
  434. If number register \fBOf\fP is 1, then the format of title
  435. will use a dash instead of a dot after the number.
  436. .br
  437. The string \fBLe\fP controls the title of the
  438. List of Equations, default is \fILIST OF EQUATIONS\fP.
  439. The List of Equations will only be printed if number register \fBLe\fP
  440. is 1, default 0.
  441. The string \fBLiec\fP contains the word \fIEquation\fP, wich
  442. is printed before the number.
  443. If \fIrefname\fP is used, then the equation number is saved with
  444. \&\fB.SETR\fP, and can be retrieved with \fB.GETST\fP \fIrefname\fP.
  445. .br
  446. Special handling of the title will occur if
  447. \fBEC\fP is used inside \fBDS\fP/\fBDE\fP, it will not be
  448. affected by the format of \fBDS\fP.
  449. .TP
  450. .B "EF [arg]"
  451. Even-page footer, printed just above the normal page footer
  452. on even pages, see \fBPF\fP.
  453. .TP
  454. .B "EH [arg]"
  455. Even-page header, printed just below the normal page header
  456. on even pages, see \fBPH\fP.
  457. .TP
  458. .B EN
  459. Equation end, see \fBEQ\fP.
  460. .TP
  461. .B EOP
  462. End of page user-defined macro.
  463. This macro will be called
  464. instead of the normal printing of the footer.
  465. The macro
  466. will be executed in a separate environment, without any
  467. trap active.
  468. See \fBTP\fP.
  469. .sp
  470. \fBStrings available to EOP\fP
  471. .in +.5i
  472. .T2 EOPf
  473. Argument from \fBPF\fP.
  474. .T2 EOPef
  475. Argument from \fBEF\fP.
  476. .T2 EOPof
  477. Argument from \fBOF\fP.
  478. .in
  479. .TP
  480. .B "EPIC [-L] width height [name]"
  481. \fBEPIC\fP draws a box with the given \fIwidth\fP and \fIheight\fP, it will
  482. also print the text \fIname\fP or a default string if
  483. \fIname\fP is not specified..
  484. This is used to include external pictures, just give the size
  485. of the picture.
  486. \fB-L\fP will leftadjust the picture, the default is to center adjust.
  487. See \fBPIC\fP
  488. .TP
  489. .B "EQ [label]"
  490. Equation start.
  491. \fBEQ\fP/\fBEN\fP are the delimiters for equations written for \fBeqn\fP.
  492. \fBEQ\fP/\fBEN\fP must be inside a \fBDS\fP/\fBDE\fP-pair, except
  493. when \fBEQ\fP is only used to set options in \fBeqn\fP.
  494. The \fIlabel\fP will appear at the right margin of the equation, unless
  495. number register \fBEq\fP is\ 1.
  496. Then the label will appear at the
  497. left margin.
  498. .TP
  499. .B "EX [title [override [flag [refname]]]]"
  500. Exhibit title, arguments are the same as for \fBEC\fP.
  501. \fBEX\fP uses the number register \fBEx\fP as counter.
  502. The string \fBLx\fP controls the title of the
  503. List of Exhibits, default is \fILIST OF EXHIBITS\fP.
  504. The List of Exhibits will only be printed if number register \fBLx\fP
  505. is 1, default 1.
  506. The string \fBLiex\fP contains the word \fIExhibit\fP, which
  507. is printed before the number.
  508. If \fIrefname\fP is used, then the exhibit number is saved with
  509. \&\fB.SETR\fP, and can be retrieved with \fB.GETST\fP \fIrefname\fP.
  510. .br
  511. Special handling of the title will occur if
  512. \fBEX\fP is used inside \fBDS\fP/\fBDE\fP, it will not be
  513. affected by the format of \fBDS\fP.
  514. .TP
  515. .B "FC [closing]"
  516. Prints \fIYours\ very\ truly,\fP as a formal closing of a letter or
  517. memorandum.
  518. The argument replaces the defualt string.
  519. The default is stored in string variable \fBLetfc\fP.
  520. .TP
  521. .B "FD [arg [1]]"
  522. Footnote default format.
  523. Controls the hyphenation (hyphen), right margin justification (adjust),
  524. indentation of footnote text (indent).
  525. It can also change the label
  526. justification (ljust).
  527. .sp
  528. .if t .ne 14v
  529. .nf
  530. .ta .5i +.8i +.8i +.8i +.8i
  531. \fBarg hyphen adjust indent ljust\fP
  532. 0 no yes yes left
  533. 1 yes yes yes left
  534. 2 no no yes left
  535. 3 yes no yes left
  536. 4 no yes no left
  537. 5 yes yes no left
  538. 6 no no no left
  539. 7 yes no no left
  540. 8 no yes yes right
  541. 9 yes yes yes right
  542. 10 no no yes right
  543. 11 yes no yes right
  544. .sp
  545. .fi
  546. .DT
  547. Argument greater than or equal to 11 is considered as arg 0.
  548. Default for m@TMAC_M_PREFIX@m is 10.
  549. .TP
  550. .B FE
  551. Footnote end.
  552. .TP
  553. .B "FG [title [override [flag [refname]]]]"
  554. Figure title, arguments are the same as for \fBEC\fP.
  555. \fBFG\fP uses the number register \fBFg\fP as counter.
  556. The string \fBLf\fP controls the title of the
  557. List of Figures, default is \fILIST OF FIGURES\fP.
  558. The List of Figures will only be printed if number register \fBLf\fP
  559. is 1, default 1.
  560. The string \fBLifg\fP contains the word \fIFigure\fP, wich
  561. is printed before the number.
  562. If \fIrefname\fP is used, then the figure number is saved with
  563. \&\fB.SETR\fP, and can be retrieved with \fB.GETST\fP \fIrefname\fP.
  564. .br
  565. Special handling of the title will occur if
  566. \fBFG\fP is used inside \fBDS\fP/\fBDE\fP, it will not be
  567. affected by the format of \fBDS\fP.
  568. .TP
  569. .B "FS [label]"
  570. Footnote start.
  571. The footnote is ended by \fBFE\fP.
  572. Footnotes is normally automatically
  573. numbered, the number is available in string \fBF\fP.
  574. Just add \fB\e*F\fP in the text.
  575. By adding \fIlabel\fP, it is possible
  576. to have other number or names on the footnotes.
  577. Footnotes in displays is now possible.
  578. An empty line separates footnotes, the height of the line
  579. is controlled by number register \fBFs\fP, default value is 1.
  580. .TP
  581. .B "GETHN refname [varname]"
  582. Includes the headernumber where the corresponding \fBSETR\fP \fIrefname\fP
  583. was placed.
  584. Will be X.X.X. in pass\ 1.
  585. See \fBINITR\fP.
  586. If \fIvarname\fP is used, \fBGETHN\fP sets the stringvariable \fIvarname\fP to the
  587. headernumber.
  588. .TP
  589. .B "GETPN refname [varname]"
  590. Includes the pagenumber where the corresponding \fBSETR\fP \fIrefname\fP
  591. was placed.
  592. Will be 9999 in pass\ 1.
  593. See \fBINITR\fP.
  594. If \fIvarname\fP is used, \fBGETPN\fP sets the stringvariable \fIvarname\fP
  595. to the pagenumber.
  596. .TP
  597. .B "GETR refname"
  598. Combines \fBGETHN\fP and \fBGETPN\fP with the text 'chapter' and ', page'.
  599. The string \fIQrf\fP contains the text for reference:
  600. .ti +.5i
  601. \&.ds Qrf See chapter \e\e*[Qrfh], page \e\e*[Qrfp].
  602. .br
  603. \fIQrf\fP may be changed to support other languages.
  604. Strings \fIQrfh\fP and \fIQrfp\fP are set by \fBGETR\fP
  605. and contains the page and headernumber.
  606. .TP
  607. .B "GETST refname [varname]"
  608. Includes the string saved with the second argument to \fB.SETR\fP.
  609. Will be dummystring in pass 1.
  610. If varname is used, \fBGETST\fP sets the stringvariable \fIvarname\fP to the
  611. saved string.
  612. See \fBINITR\fP.
  613. .TP
  614. .B "H level [heading-text [heading-suffix]]"
  615. Numbered section heading.
  616. Section headers can have a level between 1 and 14, level 1 is the
  617. top level.
  618. The text is given in \fIheading-text\fP, and must be
  619. surrounded by double quotes if it contains spaces.
  620. \fBHeading-suffix\fP is added to the header in the text but not in
  621. the table of contents.
  622. This is normally used for footnote marks
  623. and similar things.
  624. Don't use \fB\e*F\fP in \fIheading-suffix\fP, it won't
  625. work.
  626. A manual label must be used, see \fBFS\fP.
  627. .sp
  628. An eventual paragraph, \fBP\fP, directly after \fBH\fP will be
  629. ignored, \fBH\fP is taking care of spacing and indentation.
  630. .sp
  631. \fBPage ejection before heading\fP
  632. .br
  633. Number register \fBEj\fP controls page ejection before the heading.
  634. Normally, a level one heading gets two blank lines before it, higher levels
  635. gets only one.
  636. A new page is ejected before each
  637. first-level heading if number register \fBEj\fP is 1.
  638. All levels below or equal the value of \fBEj\fP gets a new page.
  639. Default value for \fBEj\fP is 0.
  640. .sp
  641. \fBHeading break level\fP
  642. .br
  643. A line break occurs after the heading if the heading level is less
  644. or equal to number register \fBHb\fP.
  645. Default value 2.
  646. .sp
  647. \fBHeading space level\fP
  648. .br
  649. A blank line is inserted after the heading if the heading level is less
  650. or equal to number register \fBHs\fP.
  651. Default value 2.
  652. .sp
  653. Text will follow the heading on the same line if the level is greater
  654. than both \fBHb\fP and \fBHs\fP.
  655. .sp
  656. \fBPost-heading indent\fP
  657. .br
  658. Indentation of the text after the heading is controlled by number
  659. register \fBHi\fP, default value 0.
  660. .sp
  661. \fBHi\fP
  662. .in +.5i
  663. .T2 0
  664. The text will be left-justified.
  665. .T2 1
  666. Indentation of the text will follow the value of number register \fBPt\fP,
  667. see \fBP\fP.
  668. .T2 2
  669. The text will be lined up with the first word of the heading.
  670. .in
  671. .sp
  672. \fBCentered section headings\fP
  673. .br
  674. All headings whose level is equal or below number register \fBHc\fP
  675. and also less than or equal to \fBHb\fP or \fBHs\fP
  676. is centerered.
  677. .sp
  678. \fBFont control of the heading\fP
  679. .br
  680. The font of each heading level is controlled by string \fBHF\fP.
  681. It contains a fontnumber or fontname for each level.
  682. Default
  683. is \fB2\ 2\ 2\ 2\ 2\ 2\ 2\ 2\ 2\ 2\ 2\ 2\ 2\ 2\fP (all headings in italic).
  684. Could also be written as \fBI\ I\ I\ I\ I\ I\ I\ I\ I\ I\ I\ I\ I\ I\fP.
  685. Note that some other implementations use \fB3\ 3\ 2\ 2\ 2\ 2\ 2\fP as the
  686. default value.
  687. All omitted values are presumed to be a 1.
  688. .sp
  689. \fBPoint size control\fP.
  690. .br
  691. String \fBHP\fP controls the pointsize of each heading, in the
  692. same way as \fBHF\fP controls the font.
  693. A value of 0 selects the default point size.
  694. Default value is \fB0\ 0\ 0\ 0\ 0\ 0\ 0\ 0\ 0\ 0\ 0\ 0\ 0\ 0\fP.
  695. Beware that only the
  696. point size changes, not the vertical size.
  697. That can be controlled by the user specified macro \fBHX\fP and/or
  698. \fBHZ\fP.
  699. .sp
  700. \fBHeading counters\fP
  701. .br
  702. Fourteen number registers, named \fBH1\fP thru \fBH14\fP contains
  703. the counter for each heading level.
  704. The values are printed using arabic numerals, this can be changed
  705. with the macro \fBHM\fP (see below).
  706. All marks are concatenated before printing.
  707. To avoid this, set
  708. number register \fBHt\fP to\ 1.
  709. That will only print the current
  710. heading counter at each heading.
  711. .sp
  712. \fBAutomatic table of contents\fP
  713. .br
  714. All headings whose level is equal or below number register \fBCl\fP
  715. is saved to be printed in the table of contents.
  716. Default value is\ 2.
  717. .sp
  718. \fBSpecial control of the heading, user-defined macros\fP.
  719. .br
  720. These macros can be defined by the user to get a finer control
  721. of vertical spacing, fonts or other features.
  722. Argument \fIlevel\fP is the level-argument to \fBH\fP, but
  723. 0 for unnumbered headings (see \fBHU\fP).
  724. Argument \fIrlevel\fP is the real level, it is
  725. set to number register \fBHu\fP for unnumbered headings.
  726. Argument \fIheading-text\fP is the text argument to \fBH\fP and \fBHU\fP.
  727. .sp
  728. \fBHX\ \fP\fIlevel\ rlevel\ heading-text\fP
  729. .br
  730. \fBHX\fP is called just before the printing of the heading.
  731. The following register is available for \fBHX\fP.
  732. \fBHX\fP may alter \fB}0\fP, \fB}2\fP and \fB;3\fP.
  733. .in +.5i
  734. .T3 "string }0"
  735. Contains the heading mark plus two spaces if \fIrlevel\fP is non-zero,
  736. otherwise empty.
  737. .T3 "register ;0"
  738. Contains the position of the text after the heading.
  739. 0 means that the text should follow the heading on the same line, 1
  740. means that a line break should occur before the text and
  741. 2 means that a blank line should separate the heading and the text.
  742. .T3 "string }2"
  743. Contains two spaces if register \fB;0\fP is\ 0.
  744. It is used to
  745. separate the heading from the text.
  746. The string
  747. is empty if \fB;0\fP is non-zero.
  748. .T3 "register ;3"
  749. Contains the needed space in units after the heading.
  750. Default is 2v.
  751. Can be used to change things like numbering (\fB}0\fP),
  752. vertical spacing (\fB}2\fP)
  753. and the needed space after the heading.
  754. .in
  755. .sp
  756. \fBHY\ \fP\fIdlevel\ rlevel\ heading-text\fP
  757. .br
  758. \fBHY\fP is called after size and font calculations and
  759. might be used to change indentation.
  760. .sp
  761. \fBHZ\ \fP\fIdlevel\ rlevel\ heading-text\fP
  762. .br
  763. \fBHZ\fP is called after the printing of the heading, just before
  764. \fBH\fP or \fBHU\fP exits.
  765. Could be used to change the page header according to the section heading.
  766. .TP
  767. .B "HC [hyphenation-character]"
  768. Set hyphenation character.
  769. Default value is \e%.
  770. Resets to the default if called without argument.
  771. Hyphenation can be turned off by setting number
  772. register \fBHy\fP to 0 in the beginning of the file.
  773. .TP
  774. .B "HM [arg1 [arg2 [... [arg14]]]]"
  775. Heading mark style.
  776. Controls the type of marking for printing of the heading counters.
  777. Default is 1 for all levels.
  778. .sp
  779. \fBArgument\fP
  780. .in +.5i
  781. .T2 1
  782. Arabic numerals.
  783. .T2 0001
  784. Arabic numerals with leading zeroes, one or more.
  785. .T2 A
  786. Upper-case alphabetic
  787. .T2 a
  788. Lower-case alphabetic
  789. .T2 I
  790. Upper-case roman numerals
  791. .T2 i
  792. lower-case roman numerals
  793. .T2 \fIempty\fP
  794. Arabic numerals.
  795. .in
  796. .TP
  797. .B "HU heading-text"
  798. Unnumbered section header.
  799. \fBHU\fP behavies like \fBH\fP at the level in number register \fBHu\fP.
  800. See \fBH\fP.
  801. .TP
  802. .B "HX dlevel rlevel heading-text"
  803. Userdefined heading exit.
  804. Called just before printing the header.
  805. See \fBH\fP.
  806. .TP
  807. .B "HY dlevel rlevel heading-text"
  808. Userdefined heading exit.
  809. Called just before printing the header.
  810. See \fBH\fP.
  811. .TP
  812. .B "HZ dlevel rlevel heading-text"
  813. Userdefined heading exit.
  814. Called just after printing the header.
  815. See \fBH\fP.
  816. .TP
  817. .B "I [italic-text [prev-font-text [italic-text [...]]]]"
  818. Italic.
  819. Changes the font to italic if called without arguments.
  820. With one argument it will set the word in italic.
  821. With two argument it will concatenate them and set the first
  822. word in italic and the second in the previous font.
  823. There is no limit on the number of argument, all will be concatenated.
  824. .TP
  825. .B "IA [addressee-name [title]]"
  826. Begins specification of the addressee and addressee's address in
  827. letter style.
  828. Several names can be specified with empty \fBIA\fP/\fBIE\fP-pairs, but
  829. only one address.
  830. See \fBLT\fP.
  831. .TP
  832. .B "IB [italic-text [bold-text [italic-text [...]]]]"
  833. Italic-bold.
  834. Even arguments is printed in italic, odd in boldface.
  835. See \fBI\fP.
  836. .TP
  837. .B IE
  838. Ends the address-specification after \fPIA\fP.
  839. .TP
  840. .B "INITI type filename [macro]"
  841. Initialize the new index system, sets the filename to collect
  842. index lines in with \fBIND\fP.
  843. Argument \fItype\fP selects
  844. the type of index, page number, header marks or both.
  845. The default is \fIN\fP.
  846. It is also possible to create a macro that is responsible
  847. for formatting each row.
  848. Add the name of the macro as argument\ 3.
  849. The macro will be called with the index as argument(s).
  850. .sp
  851. \fBtype\fP
  852. .in +.5i
  853. .T2 N
  854. Page numbers
  855. .T2 H
  856. Header marks
  857. .T2 B
  858. Both page numbers and header marks, tab separated
  859. .in
  860. .TP
  861. .B "INITR filename"
  862. Initialize the refencemacros.
  863. References will be written to stderr and is supposed to
  864. be written to \fIfilename.qrf\fP.
  865. Requires two passes with groff, this is handled by a
  866. separate program called \fBmmroff\fP, the reason is that
  867. groff is often installed without the unsafe operations that
  868. \fBINITR\fP requiered.
  869. The first pass looks for references and the second one includes them.
  870. \fBINITR\fP can be used several times, but it is only the first
  871. occurrence of \fBINITR\fP that is active.
  872. See also \fBSETR\fP, \fBGETPN\fP and \fBGETHN\fP.
  873. .TP
  874. .B "IND arg1 [arg2 [...]]"
  875. \fBIND\fP writes a line in the index file selected by \fBINITI\fP
  876. with all arguments and the page number or header mark separated by tabs.
  877. .in +.5i
  878. \fBExamples\fP
  879. .br
  880. arg1\etpage number
  881. .br
  882. arg1\etarg2\etpage number
  883. .br
  884. arg1\etheader mark
  885. .br
  886. arg1\etpage number\etheader mark
  887. .in
  888. .TP
  889. .B "INDP"
  890. \fBINDP\fP prints the index by running the command specified
  891. by string variable \fBIndcmd\fP, normally \fIsort\ -t\et\fP.
  892. \fBINDP\fP reads the output from the command to form
  893. the index, normally in two columns (can be changed by defining \fBTYIND\fP).
  894. The index is printed with string variable \fBIndex\fP as header,
  895. default is \fBINDEX\fP.
  896. One-column processing is
  897. returned after the list.
  898. \fBINDP\fP will call the
  899. user-defined macros \fBTXIND\fP, \fBTYIND\fP and \fBTZIND\fP if defined.
  900. \fBTXIND\fP is called before printing \fBINDEX\fP, \fBTYIND\fP
  901. is called instead of printing \fBINDEX\fP.
  902. \fBTZIND\fP is called
  903. after the printing and should take care of restoring to normal
  904. operation again.
  905. .TP
  906. .B "ISODATE [0]"
  907. \fBISODATE\fP changes the predefined date string in \fBDT\fP to
  908. ISO-format, ie YYYY-MM-DD.
  909. This can also be done by
  910. adding \fB-rIso=1\fP on the command line.
  911. Reverts to old date format if argument is \fB0\fP.
  912. .TP
  913. .B "IR [italic-text [roman-text [italic-text [...]]]]"
  914. Italic-roman.
  915. Even arguments is printed in italic, odd in roman.
  916. See \fBI\fP.
  917. .TP
  918. .B "LB text-indent mark-indent pad type [mark [LI-space [LB-space]]]"
  919. List begin macro.
  920. This is the common macro used for all lists.
  921. \fIText-indent\fP is the number of spaces to indent the text from the
  922. current indent.
  923. .sp
  924. \fIPad\fP and \fImark-indent\fP controls where to put the mark.
  925. The mark is placed within the mark area, and \fImark-indent\fP
  926. sets the number of spaces before this area.
  927. It is normally\ 0.
  928. The mark area ends where the text begins.
  929. The start of the text
  930. is still controlled by \fItext-indent\fP.
  931. .sp
  932. The mark is left justified whitin the mark area if \fIpad\fP is 0.
  933. If \fIpad\fP is greater than 0, then \fImark-indent\fP is ignored, and
  934. the mark is placed \fIpad\fP spaces before the text.
  935. This will right justify the mark.
  936. .sp
  937. If \fItype\fP is 0 the list will have either a hanging indent or, if
  938. argument \fImark\fP is given, the string \fImark\fP as mark.
  939. .sp
  940. If \fItype\fP is greater than 0 automatic numbering will occur, arabic
  941. if \fImark\fP is empty.
  942. \fIMark\fP can then be any of \fB1\fP, \fBA\fP,
  943. \fBa\fP, \fBI\fP or \fBi\fP.
  944. .sp
  945. \fIType\fP selects one of six possible ways to display the mark.
  946. .br
  947. \fBtype\fP
  948. .in +.6i
  949. .T2 1
  950. x.
  951. .T2 2
  952. x)
  953. .T2 3
  954. (x)
  955. .T2 4
  956. [x]
  957. .T2 5
  958. <x>
  959. .T2 6
  960. {x}
  961. .in
  962. .sp
  963. Every item in the list will get \fILI-space\fP number of blank lines
  964. before them.
  965. Default is\ 1.
  966. .sp
  967. \fBLB\fP itself will print \fILB-space\fP blank lines.
  968. Default is\ 0.
  969. .TP
  970. .B "LC [list-level]"
  971. List-status clear.
  972. Terminates all current active lists down to \fIlist-level\fP, or 0
  973. if no argmuent is given.
  974. This is used by \fBH\fP to clear any
  975. active list.
  976. .TP
  977. .B "LE [1]"
  978. List end.
  979. Terminate the current list.
  980. \fBLE\fP outputs a blank line
  981. if an argument is given.
  982. .TP
  983. .B "LI [mark [1]]"
  984. List item precedes every item in a list.
  985. Without argument \fBLI\fP
  986. will print the mark determined by the current list type.
  987. By giving
  988. \fBLI\fP one argument, it will use that as the mark instead.
  989. Two arguments to \fBLI\fP will make \fImark\fP a prefix to
  990. the current mark.
  991. There will be no separating space between the prefix
  992. and the mark if the second argument is \fB2\fP instead of \fB1\fP.
  993. This behaviour can also be achieved by setting number register
  994. \fBLimsp\fP to zero.
  995. A zero length \fImark\fP will make a hanging
  996. indent instead.
  997. .sp
  998. A blank line is normally printed before the list item.
  999. This behaviour
  1000. can be controlled by number register \fBLs\fP.
  1001. Pre-spacing
  1002. will occur for each list-level less than or equal to \fBLs\fP.
  1003. Default value is\ 99.
  1004. (Nesting of lists is unlimited.\ :-)
  1005. .sp
  1006. The indentation can be changed thru number register \fBLi\fP.
  1007. Default is 6.
  1008. .sp
  1009. All lists begins with a list initialization macro, \fBLB\fP.
  1010. There are, however, seven predefined listtypes to
  1011. make lists easier to use.
  1012. They all call \fBLB\fP with different
  1013. default values.
  1014. .in +.5i
  1015. .T2 \fBAL\fP
  1016. Automatically Incremented List
  1017. .T2 \fBML\fP
  1018. Marked List
  1019. .T2 \fBVL\fP
  1020. Variable-Item List
  1021. .T2 \fBBL\fP
  1022. Bullet List
  1023. .T2 \fBDL\fP
  1024. Dash List
  1025. .T2 \fBRL\fP
  1026. Reference List
  1027. .T2 \fBBVL\fP
  1028. Broken Varable List.
  1029. .in
  1030. These lists are described at other places in this manual.
  1031. See also \fBLB\fP.
  1032. .TP
  1033. .B "LT [arg]"
  1034. Formats a letter in one of four different styles depending
  1035. on the argument.
  1036. See also \fBINTERNALS\fP.
  1037. .in +.5i
  1038. .T2 \fBArg
  1039. Style\fP
  1040. .T2 BL
  1041. Blocked.
  1042. Date line, return address, writer's address and closing
  1043. begins at the center of the line.
  1044. All other lines begin at the left margin.
  1045. .T2 SB
  1046. Semi-blocked.
  1047. Same as blocked, except that the first line in every
  1048. paragraph is indented five spaces.
  1049. .T2 FB
  1050. Full-blocked.
  1051. All lines begin at the left margin.
  1052. .T2 SP
  1053. Simplified.
  1054. Almost the same as the full-blocked style.
  1055. Subject and
  1056. the writer's identification are printed in all-capital.
  1057. .in
  1058. .TP
  1059. .B "LO type [arg]"
  1060. Specify options in letter (see \fB.LT\fP).
  1061. This is a list of the standard options:
  1062. .in +.5i
  1063. .T2 CN
  1064. Confidential notation.
  1065. Prints \fBCONFIDENTIAL\fP on the second line
  1066. below the date line.
  1067. Any argument replaces \fBCONFIDENTIAL\fP.
  1068. See also string variable \fBLetCN\fP.
  1069. .T2 RN
  1070. Reference notation.
  1071. Prints \fBIn reference to:\fP and the argument
  1072. two lines below the date line.
  1073. See also string variable \fBLetRN\fP.
  1074. .T2 AT
  1075. Attention.
  1076. Prints \fBATTENTION:\fP and the argument below the inside address.
  1077. See also string variable \fBLetAT\fP.
  1078. .T2 SA
  1079. Salutation.
  1080. Prints \fBTo Whom It May Concern:\fP or the argument if
  1081. it was present.
  1082. The salutation is printed two lines below the inside address.
  1083. See also string variable \fBLetSA\fP.
  1084. .T2 SJ
  1085. Subject line.
  1086. Prints the argument as subject prefixed with \fBSUBJECT:\fP
  1087. two lines below the inside address, except in letter type \fBSP\fP.
  1088. Then the subject is printed in all-captial without any prefix.
  1089. See also string variable \fBLetSJ\fP.
  1090. .in
  1091. .TP
  1092. .B "MC column-size [column-separation] "
  1093. Begin multiple columns.
  1094. Return to normal with \fB1C\fP.
  1095. \fBMC\fP will create as many columns as the current line length permits.
  1096. \fIColumn-size\fP is the width of each column, and \fIcolumn-separation\fP
  1097. is the space between two columns.
  1098. Default separation is the
  1099. column-size/15.
  1100. See also \fB1C\fP.
  1101. .TP
  1102. .B "ML mark [text-indent [1]]"
  1103. Marked list start.
  1104. The \fImark\fP argument will be printed before
  1105. each list item.
  1106. \fIText-indent\fP sets the indent and overrides \fBLi\fP.
  1107. A third argument will prohibit printing of a blank line before each
  1108. item.
  1109. .TP
  1110. .B "MT [arg [addressee]]"
  1111. Memorandum type.
  1112. The \fIarg\fP is part of a filename in \fI@TMAC_MDIR@/*.MT\fP.
  1113. Memorandum type 0 thru 5 are supported, including \fI"string"\fP.
  1114. \fIAddressee\fP just sets a variable, used in the AT&T macros.
  1115. .br
  1116. \fBarg\fP
  1117. .in +.5i
  1118. .T2 0
  1119. Normal memorandum, no type printed
  1120. .T2 1
  1121. Memorandum with \fIMEMORANDUM FOR FILE\fP printed
  1122. .T2 2
  1123. Memorandum with \fIPROGRAMMER'S NOTES\fP printed
  1124. .T2 3
  1125. Memorandum with \fIENGINEER'S NOTES\fP printed
  1126. .T2 4
  1127. Released paper style
  1128. .T2 5
  1129. External letter style
  1130. .in
  1131. See also \fBCOVER\fP/\fBCOVEND\fP, a more flexible type of front page.
  1132. .TP
  1133. .B "MOVE y-pos [x-pos [line-length]]"
  1134. Move to a position, pageoffset set to \fIx-pos\fP.
  1135. If \fIline-length\fP is not given, the difference between
  1136. current and new pageoffset is used.
  1137. Use \fBPGFORM\fP without arguments to return to normal.
  1138. .TP
  1139. .B "MULB cw1 space1 [cw2 space2 [cw3 ...]]"
  1140. Begin a special multi-column mode.
  1141. Every columns width must be specified.
  1142. Also the space between the columns must be specified.
  1143. The last column
  1144. does not need any space-definition.
  1145. \fBMULB\fP starts a diversion and \fBMULE\fP
  1146. ends the diversion and prints the columns.
  1147. The unit for width and space is 'n', but \fBMULB\fP accepts all
  1148. normal unitspecifications like 'c' and 'i'.
  1149. \fBMULB\fP operates in a separate environment.
  1150. .TP
  1151. .B "MULN"
  1152. Begin the next column.
  1153. This is the only way to switch column.
  1154. .TP
  1155. .B "MULE"
  1156. End the multi-column mode and print the columns.
  1157. .TP
  1158. .B "nP [type]"
  1159. Print numbered paragraph with header level two.
  1160. See \fB.P\fP.
  1161. .TP
  1162. .B "NCOL"
  1163. Force printing to the next column, don't use this together with
  1164. the \fBMUL*\fP macros, see \fB2C\fP.
  1165. .TP
  1166. .B "NS [arg [1]]"
  1167. Prints different types of notations.
  1168. The argument selects between
  1169. the predefined type of notations.
  1170. If the second argument is available,
  1171. then the argument becomes the entire notation.
  1172. If the argument doesn't exist in the predefined, it will be
  1173. printed as \fBCopy (\fP\fIarg\fP\fB) to\fP.
  1174. It is possible to add more standard notations, see the string variable
  1175. \fBLetns\fP and \fBLetnsdef\fP.
  1176. .nf
  1177. .in +.5i
  1178. .T2 \fBArg
  1179. Notation\fP
  1180. .T2 \fInone\fP
  1181. Copy To
  1182. .T2 """""
  1183. Copy To
  1184. .T2 1
  1185. Copy To (with att.) to
  1186. .T2 2
  1187. Copy To (without att.) to
  1188. .T2 3
  1189. Att.
  1190. .T2 4
  1191. Atts.
  1192. .T2 5
  1193. Enc.
  1194. .T2 6
  1195. Encs.
  1196. .T2 7
  1197. Under separate cover
  1198. .T2 8
  1199. Letter to
  1200. .T2 9
  1201. Memorandum to
  1202. .T2 10
  1203. Copy (with atts.) to
  1204. .T2 11
  1205. Copy (without atts.) to
  1206. .T2 12
  1207. Abstract Only to
  1208. .T2 13
  1209. Complete Memorandum to
  1210. .T2 14
  1211. CC
  1212. .in
  1213. .fi
  1214. .TP
  1215. .B "ND new-date"
  1216. New date.
  1217. Override the current date.
  1218. Date is not
  1219. printed if \fInew-date\fP is an empty string.
  1220. .TP
  1221. .B "OF [arg]"
  1222. Odd-page footer, a line printed just above the normal footer.
  1223. See \fBEF\fP and \fBPF\fP.
  1224. .TP
  1225. .B "OH [arg]"
  1226. Odd-page header, a line printed just below the normal header.
  1227. See \fBEH\fP and \fBPH\fP.
  1228. .TP
  1229. .B OP
  1230. Make sure that the following text is printed at the top
  1231. of an odd-numbered page.
  1232. Will not output an empty page
  1233. if currently at the top of an odd page.
  1234. .TP
  1235. .B "P [type]"
  1236. Begin new paragraph.
  1237. \fBP\fP without argument will produce left justified text, even
  1238. the first line of the paragraph.
  1239. This is the same as setting
  1240. \fItype\fP to 0.
  1241. If the argument is\ 1, then the first line
  1242. of text following \fBP\fP will be indented by the number of
  1243. spaces in number register \fBPi\fP, normally 5.
  1244. .sp
  1245. Instead of giving 1 as argument to \fBP\fP it is possible to set the
  1246. paragraph type in number register \fBPt\fP.
  1247. Using 0 and\ 1
  1248. will be the same as adding that value to \fBP\fP.
  1249. A value of 2 will indent all paragraphs, except after
  1250. headings, lists and displays.
  1251. .sp
  1252. The space between two paragraphs is controlled by number register \fBPs\fP,
  1253. and is 1 by default (one blank line).
  1254. .TP
  1255. .B "PGFORM [linelength [pagelength [pageoffset [1]]]]"
  1256. Sets linelength, pagelength and/or pageoffset.
  1257. This macro can be used for special formatting, like letterheads
  1258. and other.
  1259. It is normally the first command in a file, though it's not necessary.
  1260. \fBPGFORM\fP can be used without arguments
  1261. to reset everything after a \fBMOVE\fP.
  1262. A line-break is done unless the fourth argument is given.
  1263. This can be used to avoid the pagenumber on the first page while setting
  1264. new width and length.
  1265. (It seems as if this macro sometimes doesn't work too well.
  1266. Use the command line arguments
  1267. to change linelength, pagelength and pageoffset instead.
  1268. Sorry.)
  1269. .TP
  1270. .B PGNH
  1271. No header is printed on the next page.
  1272. Used to get rid of
  1273. the header in letters or other special texts.
  1274. This macro must be used before any text to inhibit the pageheader
  1275. on the first page.
  1276. .TP
  1277. .B "PIC [-L] [-C] [-R] [-I n] filename [width [height]]"
  1278. \fBPIC\fP includes a Postscript file in the document.
  1279. The macro depends on \fBmmroff\fP and \fBINITR\fP.
  1280. \fB-L\fP, \fB-C\fP, \fB-R\fP and \fB-I n\fP adjusts the picture
  1281. or indents it.
  1282. The optionally \fIwidth\fP and \fIheight\fP
  1283. can also be given to resize the picture.
  1284. .TP
  1285. .B PE
  1286. Picture end.
  1287. Ends a picture for \fB@TMAC_M_PREFIX@pic\fP, see the manual for \fB@TMAC_M_PREFIX@pic\fP.
  1288. .TP
  1289. .B "PF [arg]"
  1290. Page footer.
  1291. \fBPF\fP sets the line to be printed at the bottom of each page.
  1292. Normally empty.
  1293. See \fBPH\fP for the argument specification.
  1294. .TP
  1295. .B "PH [arg]"
  1296. Page header, a line printed at the top of each page.
  1297. The argument should be specified as "'left-part'center-part'right-part'",
  1298. where left-, center- and right-part is printed left-justified, centered
  1299. and right justified.
  1300. The character \fB%\fP is changed to the current
  1301. page number.
  1302. The default page-header is "''- % -''", the page
  1303. number between two dashes.
  1304. .TP
  1305. .B PS
  1306. Picture start (from pic).
  1307. Begins a picture for \fB@g@pic\fP, see
  1308. the manual.
  1309. .TP
  1310. .B PX
  1311. Page-header user-defined exit.
  1312. \fBPX\fP is called just after the printing of the page header
  1313. in \fIno-space\fP mode.
  1314. .TP
  1315. .B R
  1316. Roman.
  1317. Return to roman font, see also \fBI\fP.
  1318. .TP
  1319. .B "RB [roman-text [bold-text [roman-text [...]]]]"
  1320. Roman-bold.
  1321. Even arguments is printed in roman, odd in boldface.
  1322. See \fBI\fP.
  1323. .TP
  1324. .B "RD [prompt [diversion [string]]]"
  1325. Read from standard input to diversion and/or string.
  1326. The text will be saved in a diversion named \fIdiversion\fP.
  1327. Recall the text by writing the name of the diversion after a dot
  1328. on an empty line.
  1329. A string will also be defined if
  1330. \fIstring\fP is given.
  1331. \fIDiversion\fP and/or \fIprompt\fP can
  1332. be empty ("").
  1333. .TP
  1334. .B RF
  1335. Reference end.
  1336. Ends a reference definition and returns to normal
  1337. processing.
  1338. See \fBRS\fP.
  1339. .TP
  1340. .B "RI [roman-text [italic-text [roman-text [...]]]]"
  1341. Even arguments are printed in roman, odd in italic.
  1342. See \fBI\fP.
  1343. .TP
  1344. .B "RL [text-indent [1]]"
  1345. Reference list start.
  1346. Begins a list where each item is preceded with a automatically
  1347. incremented number between
  1348. square brackets.
  1349. \fIText-indent\fP changes the default indentation.
  1350. .TP
  1351. .B "RP [arg1 [arg2]]"
  1352. Produce reference page.
  1353. \fBRP\fP can be used if a reference page is wanted somewhere in the
  1354. document.
  1355. It is not needed if \fBTC\fP is used to produce
  1356. a table of content.
  1357. The reference page will then be printed automatically.
  1358. .sp
  1359. The reference counter will not be reset if \fIarg1\fP is 1.
  1360. .sp
  1361. \fIArg2\fP tells \fBRP\fP whether to eject a page or not.
  1362. .br
  1363. \fBArg2\fP
  1364. .in +.5i
  1365. .T2 0
  1366. The reference page will be printed on a separate page.
  1367. This is
  1368. the default.
  1369. .T2 1
  1370. Do not eject page after the list.
  1371. .T2 2
  1372. Do not eject page before the list.
  1373. .T2 3
  1374. Do not eject page before and after the list.
  1375. .in
  1376. The reference items will be separated by a blank line.
  1377. Setting number register \fBLs\fP to 0 will suppress the line.
  1378. .sp
  1379. The string \fBRp\fP contains the reference page title and
  1380. is normally set to \fIREFERENCES\fP.
  1381. .TP
  1382. .B "RS [string-name]"
  1383. \fBRS\fP begins an automatically numbered reference definition.
  1384. Put the string \fB\e*(Rf\fP where the reference mark
  1385. should be and write the reference between \fBRS\fP/\fBRF\fP
  1386. at next new line after the reference mark.
  1387. The reference number
  1388. is stored in number register \fB:R\fP.
  1389. If \fIstring-name\fP is given, a string with that name
  1390. will be defined and contain the current reference mark.
  1391. The string can be referenced as \fB\e*[\fIstring-name\fP]\fP later in
  1392. the text.
  1393. .TP
  1394. .B "S [size [spacing]]"
  1395. Set point size and vertical spacing.
  1396. If any argument is equal 'P', then
  1397. the previous value is used.
  1398. A 'C' means current value, and 'D' default value.
  1399. If '+' or '-' is used before the value, then increment or decrement of
  1400. the current value will be done.
  1401. .TP
  1402. .B "SA [arg]"
  1403. Set right-margin justification.
  1404. Justification is normally turned on.
  1405. No argumenent or \fB0\fP turns off justification, a \fB1\fP turns on
  1406. justification.
  1407. .TP
  1408. .B "SETR refname [string]"
  1409. Remember the current header and page-number as \fIrefname\fP.
  1410. Saves \fIstring\fP if \fIstring\fP is defined.
  1411. \fIstring\fP is retrieved
  1412. with \fB.GETST\fP.
  1413. See \fBINITR\fP.
  1414. .TP
  1415. .B "SG [arg [1]]"
  1416. Signature line.
  1417. Prints the authors name(s) after the formal closing.
  1418. The argument will be appended to the reference data, printed
  1419. at either the first or last author.
  1420. The reference data is the location,
  1421. department and initials specified with \fB.AU\fP.
  1422. It will be printed at the first author if the second argument is given,
  1423. otherwise at the last.
  1424. No reference data will be printed if the author(s) is specifed
  1425. thru \fB.WA\fP/\fB.WE\fP.
  1426. See \fBINTERNALS\fP.
  1427. .TP
  1428. .B "SK [pages]"
  1429. Skip pages.
  1430. If \fIpages\fP is \fB0\fP or omitted, a skip to the next page
  1431. will occur unless it is already at the top of a page.
  1432. Otherwise it will skip \fIpages\fP pages.
  1433. .TP
  1434. .B "SM string1 [string2 [string3]]"
  1435. Make a string smaller.
  1436. If \fIstring2\fP is given, \fIstring1\fP will be smaller and \fIstring2\fP
  1437. normal, concatenated with \fIstring1\fP.
  1438. With three argument, all is
  1439. concatenated, but only \fIstring2\fP is made smaller.
  1440. .TP
  1441. .B "SP [lines]"
  1442. Space vertically.
  1443. \fIlines\fP can have any scalingfactor, like \fI3i\fP or
  1444. \fI8v\fP.
  1445. Several \fBSP\fP in a line will only produce the
  1446. maximum number of lines, not the sum.
  1447. \fBSP\fP will also be ignored
  1448. until the first textline in a page.
  1449. Add a \fB\e&\fP before \fBSP\fP
  1450. to avoid this.
  1451. .TP
  1452. .B TAB
  1453. reset tabs to every\ 5n.
  1454. Normally used to reset any previous tabpositions.
  1455. .TP
  1456. .B "TB [title [override [flag [refname]]]]"
  1457. Table title, arguments are the same as for \fBEC\fP.
  1458. \fBTB\fP uses the number register \fBTb\fP as counter.
  1459. The string \fBLt\fP controls the title of the
  1460. List of Tables, default is \fILIST OF TABLES\fP.
  1461. The List of Tables will only be printed if number register \fBLt\fP
  1462. is 1, default 1.
  1463. The string \fBLitb\fP contains the word \fITABLE\fP, wich
  1464. is printed before the number.
  1465. .br
  1466. Special handling of the title will occur if
  1467. \fBTB\fP is used inside \fBDS\fP/\fBDE\fP, it will not be
  1468. affected by the format of \fBDS\fP.
  1469. .TP
  1470. .B "TC [slevel [spacing [tlevel [tab [h1 [h2 [h3 [h4 [h5]]]]]]]]]"
  1471. Table of contents.
  1472. This macro is normally used at the last line of the document.
  1473. It generates a table of contents with headings up to the level
  1474. controlled by number register \fBCl\fP.
  1475. Note that \fBCl\fP controls
  1476. the saving of headings, it has nothing to do with \fBTC\fP.
  1477. Headings with level less than or equal to \fIslevel\fP will get
  1478. \fIspacing\fP number of lines before them.
  1479. Headings with level less than or equal to \fItlevel\fP will have
  1480. their page numbers right justified with dots or spaces separating
  1481. the text and the page number.
  1482. Spaces is used if \fItab\fP
  1483. is greater than zero, otherwise dots.
  1484. Other headings will have the
  1485. page number directly at the end of the heading text (\fIragged right\fP).
  1486. .sp
  1487. The rest of the arguments will be printed, centered, before the
  1488. table of contents.
  1489. .sp
  1490. The user-defined macros \fBTX\fP and \fBTY\fP are used if \fBTC\fP is called
  1491. with at most four arguments.
  1492. \fBTX\fP is called before the printing
  1493. of \fICONTENTS\fP, and \fBTY\fP is called instead of printing \fICONTENTS\fP.
  1494. .sp
  1495. Equivalent macros can be defined for list of figures, tables, equations
  1496. and excibits by defining \fBTXxx\fP or \fBTYxx\fP, where \fBxx\fP
  1497. is \fBFg\fP, \fBTB\fP, \fBEC\fP or \fBEX\fP.
  1498. .sp
  1499. String \fBCi\fP can be set to control the indentations for each heading-level.
  1500. It must be scaled, like \fB.ds\ Ci\ .25i\ .5i\ .75i\ 1i\ 1i\fP.
  1501. The indentation is normally controlled by the maxlength of headings
  1502. in each level.
  1503. .sp
  1504. All texts can be redefined, new stringvariables
  1505. \fILifg\fP, \fILitb\fP, \fILiex\fP, \fILiec\fP and \fILicon\fP contain
  1506. "Figure", "TABLE", "Exhibit", "Equation" and "CONTENTS".
  1507. These can be redefined to other languages.
  1508. .TP
  1509. .B TE
  1510. Table end.
  1511. See \fBTS\fP.
  1512. .TP
  1513. .B "TH [N]"
  1514. Table header.
  1515. See \fBTS\fP.
  1516. \fBTH\fP ends the header of the table.
  1517. This header will
  1518. be printed again if a page-break occurs.
  1519. Argument \fIN\fP isn't implemented yet.
  1520. .TP
  1521. .B TL [charging-case number(s) [filing-case number(s)]]
  1522. Begin title of memorandum.
  1523. All text up to the next \fBAU\fP is included in the title.
  1524. \fICharging-case number\fP and \fIfiling-case\fP are saved
  1525. for use in the front page processing.
  1526. .TP
  1527. .B TM [num1 [num2 [...]]]
  1528. Technical memorandumnumbers used in \fB.MT\fP.
  1529. Unlimited number
  1530. of arguments may be given.
  1531. .TP
  1532. .B TP
  1533. Top of page user-defined macro.
  1534. This macro is called instead of the normal page header.
  1535. It is
  1536. possible to get complete control over the header.
  1537. Note that header and footer is printed in a separate environment.
  1538. Linelength is preserved though.
  1539. .TP
  1540. .B "TS [H]"
  1541. Table start.
  1542. This is the start of a table specification
  1543. to \fB@g@tbl\fP.
  1544. See separate manual for \fB@g@tbl\fP.
  1545. \fBTS\fP ends with \fBTE\fP.
  1546. Argument \fIH\fP tells \fBm@TMAC_M_PREFIX@m\fP that the table
  1547. has a header.
  1548. See \fBTH\fP.
  1549. .TP
  1550. .B TX
  1551. Userdefined table of contents exit.
  1552. This macro is called just before \fBTC\fP prints the word \fICONTENTS\fP.
  1553. See \fBTC\fP.
  1554. .TP
  1555. .B TY
  1556. Userdefined table of contents exit (no "CONTENTS").
  1557. This macro is called instead of printing \fICONTENTS\fP.
  1558. See \fBTC\fP.
  1559. .TP
  1560. .B VERBON [flag [pointsize [font]]]
  1561. Begin verbatim output using courier font.
  1562. Usually for printing programs.
  1563. All character has equal width.
  1564. The pointsize can be changed with
  1565. the second argument.
  1566. By specifying the font-argument
  1567. it is possible to use another font instead of courier.
  1568. \fIflag\fP controls several special features.
  1569. It contains the sum of all wanted features.
  1570. .in +.5i
  1571. .T2 Value
  1572. Description
  1573. .T2 1
  1574. Disable the escape-character (\e).
  1575. This is normally turned on during
  1576. verbose output.
  1577. .T2 2
  1578. Add an empty line before the verbose text.
  1579. .T2 4
  1580. Add an empty line after the verbose text.
  1581. .T2 8
  1582. Print the verbose text with numbered lines.
  1583. This adds four digitsized
  1584. spaces in the beginning of each line.
  1585. Finer control is available with
  1586. the string-variable \fBVerbnm\fP.
  1587. It contains all arguments to the
  1588. \fBtroff\fP-command \fB.nm\fP, normally '1'.
  1589. .T2 16
  1590. Indent the verbose text with five 'n':s.
  1591. This is controlled by the
  1592. number-variable \fBVerbin\fP (in units).
  1593. .in
  1594. .TP
  1595. .B VERBOFF
  1596. End verbatim output.
  1597. .TP
  1598. .B "VL text-indent [mark-indent [1]]"
  1599. Variable-item list has no fixed mark, it assumes that
  1600. every \fBLI\fP have a mark instead.
  1601. \fIText-indent\fP sets the indent to the text, and \fImark-indent\fP
  1602. the distance from the current indent to the mark.
  1603. A third argument will prohibit printing of a blank line before each
  1604. item.
  1605. .TP
  1606. .B "VM [-T] [top [bottom]]"
  1607. Vertical margin. Adds extra vertical top and margin space.
  1608. Option \fB-T\fP set the total space instead.
  1609. No argument resets the margin to zero or the default
  1610. \fI(7v 5v)\fP if \fB-T\fP
  1611. was used. It is higly recommended that macro \fBTP\fP and/or
  1612. \fBEOP\fP are defined
  1613. if using \fB-T\fP and setting top and/or bottom margin to less than the default.
  1614. .TP
  1615. .B "WA [writer-name [title]]"
  1616. Begins specification of the writer and writer's address.
  1617. Several names can be specified with empty \fBWA\fP/\fBWE\fP-pairs, but
  1618. only one address.
  1619. .TP
  1620. .B WE
  1621. Ends the address-specification after \fP.WA\fP.
  1622. .TP
  1623. .B "WC [format]"
  1624. Footnote and display width control.
  1625. .in +.5i
  1626. .T2 N
  1627. Set default mode, \fB-WF\fP, \fB-FF\fP, \fB-WD\fP and \fBFB\fP.
  1628. .T2 WF
  1629. Wide footnotes, wide also in two-column mode.
  1630. .T2 -WF
  1631. Normal footnote width, follow column mode.
  1632. .T2 FF
  1633. All footnotes gets the same width as the first footnote encountered.
  1634. .T2 -FF
  1635. Normal footnotes, width follows \fBWF\fP and \fB-WF\fP.
  1636. .T2 WD
  1637. Wide displays, wide also in two-column mode.
  1638. .T2 -WD
  1639. Normal display width, follow column mode.
  1640. .T2 FB
  1641. Floating displays generates a line break when printed on the current page.
  1642. .T2 -FB
  1643. Floating displays does not generate line break.
  1644. .in
  1645. .sp 3
  1646. .LP
  1647. .\"########################################################################
  1648. .LP
  1649. .B "Strings used in m@TMAC_M_PREFIX@m:"
  1650. .TP
  1651. .B App
  1652. A string containing the word "APPENDIX".
  1653. .TP
  1654. .B Apptxt
  1655. The current appendix text.
  1656. .TP
  1657. .B "EM"
  1658. Em dash string
  1659. .TP
  1660. .B H1txt
  1661. Will be updated by \fB.H\fP and \fB.HU\fP to the current heading text.
  1662. Also updated in table of contents & friends.
  1663. .TP
  1664. .B HF
  1665. Fontlist for headings, normally "2 2 2 2 2 2 2".
  1666. Nonnumeric fontnames may also be used.
  1667. .TP
  1668. .B HP
  1669. Pointsize list for headings.
  1670. Normally "0 0 0 0 0 0 0" which is the same as
  1671. "10 10 10 10 10 10 10".
  1672. .TP
  1673. .B Index
  1674. Contains \fIINDEX\fP.
  1675. .TP
  1676. .B Indcmd
  1677. Contains the index command, \fIsort\ -t\et\fP.
  1678. .TP
  1679. .B Lifg
  1680. String containing \fIFigure\fP.
  1681. .TP
  1682. .B Litb
  1683. String containing \fITABLE\fP.
  1684. .TP
  1685. .B Liex
  1686. String containing \fIExhibit\fP.
  1687. .TP
  1688. .B Liec
  1689. String containing \fIEquation\fP.
  1690. .TP
  1691. .B Licon
  1692. String containing \fICONTENTS\fP.
  1693. .TP
  1694. .B Lf
  1695. Contains "LIST OF FIGURES".
  1696. .TP
  1697. .B Lt
  1698. Contains "LIST OF TABLES".
  1699. .TP
  1700. .B Lx
  1701. Contains "LIST OF EXHIBITS".
  1702. .TP
  1703. .B Le
  1704. Contains "LIST OF EQUATIONS".
  1705. .TP
  1706. .B Letfc
  1707. Contains "Yours very truly,", used in \fB.FC\fP.
  1708. .TP
  1709. .B Letapp
  1710. Contains "APPROVED:", used in \fB.AV\fP.
  1711. .TP
  1712. .B Letdate
  1713. Contains "Date", used in \fB.AV\fP.
  1714. .TP
  1715. .B LetCN
  1716. Contains "CONFIDENTIAL", used in \fB.LO CN\fP.
  1717. .TP
  1718. .B LetSA
  1719. Contains "To Whom It May Concern:", used in \fB.LO SA\fP.
  1720. .TP
  1721. .B LetAT
  1722. Contains "ATTENTION:", used in \fB.LO AT\fP.
  1723. .TP
  1724. .B LetSJ
  1725. Contains "SUBJECT:", used in \fB.LO SJ\fP.
  1726. .TP
  1727. .B LetRN
  1728. Contains "In reference to:", used in \fB.LO RN\fP.
  1729. .TP
  1730. .B Letns
  1731. is an array containing the different strings used in \fB.NS\fP.
  1732. It is really a number of stringvariables prefixed with \fBLetns!\fP.
  1733. If the argument doesn't exist, it will be included
  1734. between \fB()\fP with \fBLetns!copy\fP as prefix and \fBLetns!to\fP as suffix.
  1735. Observe the space after \fBcopy\fP and before \fBto\fP.
  1736. .nf
  1737. .ta 1.5i
  1738. \fBName Value\fP
  1739. Letns!0 Copy to
  1740. Letns!1 Copy (with att.) to
  1741. Letns!2 Copy (without att.) to
  1742. Letns!3 Att.
  1743. Letns!4 Atts.
  1744. Letns!5 Enc.
  1745. Letns!6 Encs.
  1746. Letns!7 Under separate cover
  1747. Letns!8 Letter to
  1748. Letns!9 Memorandum to
  1749. Letns!10 Copy (with atts.) to
  1750. Letns!11 Copy (without atts.) to
  1751. Letns!12 Abstract Only to
  1752. Letns!13 Complete Memorandum to
  1753. Letns!14 CC
  1754. Letns!copy Copy "
  1755. Letns!to " to
  1756. .fi
  1757. .TP
  1758. .B Letnsdef
  1759. Defines the standard-notation used when no argument is given
  1760. to \fB.NS\fP.
  1761. Default is \fB0\fP.
  1762. .TP
  1763. .B "MO1 - MO12"
  1764. Strings containing \fIJanuary\fP thru \fIDecember\fP.
  1765. .TP
  1766. .B Qrf
  1767. String containing "See chapter \e\e*[Qrfh], page \e\en[Qrfp].".
  1768. .TP
  1769. .B Rp
  1770. Contains "REFERENCES".
  1771. .TP
  1772. .B Tcst
  1773. Contains current status of table of contents and list of XXXX.
  1774. Empty outside \fB.TC\fP.
  1775. Useful in user-defined macros like \fB.TP\fP.
  1776. .nf
  1777. .ta 1.5i
  1778. \fBValue Meaning\fP
  1779. co Table of contents
  1780. fg List of figures
  1781. tb List of tables
  1782. ec List of equations
  1783. ex List of exhibits
  1784. ap Appendix
  1785. .fi
  1786. .ta
  1787. .TP
  1788. .B Tm
  1789. Contains \e(tm, trade mark.
  1790. .TP
  1791. .B Verbnm
  1792. Argument to \fB.nm\fP in \fB.VERBON\fP, default: \fB1\fP.
  1793. .\"-----------------------------------
  1794. .LP
  1795. .B "Number variables used in m@TMAC_M_PREFIX@m:"
  1796. .TP
  1797. .B Aph
  1798. Print an appendix-page for every new appendix
  1799. if this numbervariable is non-zero.
  1800. No output will occur if \fBAph\fP is zero, but there will always
  1801. be an appendix-entry in the 'List of contents'.
  1802. .TP
  1803. .B Cl
  1804. Contents level [0:14], contents saved if heading level <= Cl, default 2.
  1805. .TP
  1806. .B Cp
  1807. Eject page between LIST OF XXXX if Cp == 0, default 0.
  1808. .TP
  1809. .B D
  1810. Debugflag, values >0 produces varying degree of debug.
  1811. A value of\ 1
  1812. gives information about the progress of formatting, default\ 0.
  1813. .TP
  1814. .B De
  1815. Eject after floating display is output [0:1], default\ 0.
  1816. .TP
  1817. .B Dsp
  1818. Controls the space output before and after static displays
  1819. if defined.
  1820. Otherwise is the value of Lsp used.
  1821. .TP
  1822. .B Df
  1823. Floating keep output [0:5], default 5.
  1824. .TP
  1825. .B Ds
  1826. \fBLsp\fP space before and after display if == 1 [0:1], default 1.
  1827. .TP
  1828. .B Ej
  1829. Eject page, default 0.
  1830. .TP
  1831. .B Eq
  1832. Equation lable adjust 0=left, 1=right.
  1833. Default\ 0.
  1834. .TP
  1835. .B Fs
  1836. Footnote spacing, default 1.
  1837. .TP
  1838. .B "H1-H7"
  1839. Heading counters
  1840. .TP
  1841. .B H1dot
  1842. Append a dot after the level one heading number if >\ 0.
  1843. Default is\ 1.
  1844. .TP
  1845. .B H1h
  1846. Copy of number register \fBH1\fP, but it is incremented
  1847. just before the page break.
  1848. Useful in user defined header macros.
  1849. .TP
  1850. .B Hb
  1851. Heading break level [0:14], default\ 2.
  1852. .TP
  1853. .B Hc
  1854. Heading centering level, [0:14].
  1855. Default\ 0.
  1856. .TP
  1857. .B Hi
  1858. Heading temporary indent [0:2], default\ 1.
  1859. .br
  1860. 0\ ->\ 0 indent, left margin
  1861. .br
  1862. 1\ ->\ indent to right , like .P 1
  1863. .br
  1864. 2\ ->\ indent to line up with text part of preceding heading
  1865. .TP
  1866. .B Hps
  1867. Number variable with the heading pre-space level.
  1868. If the heading-level
  1869. is less than or equal to \fBHps\fP, then two lines will precede the
  1870. section heading instead of one.
  1871. Default is first level only.
  1872. The real amount of lines is controlled by the variables \fBHps1\fP and
  1873. \fBHps2\fP.
  1874. .TP
  1875. .B Hps1
  1876. This is the number of lines preceding \fB.H\fP when the heading-level
  1877. is greater than \fBHps\fP.
  1878. Value is in units, normally 0.5.
  1879. .TP
  1880. .B Hps2
  1881. This is the number of lines preceding \fB.H\fP when the heading-level
  1882. is less than or equal to \fBHps\fP.
  1883. Value is in units, normally\ 1.
  1884. .TP
  1885. .B Hs
  1886. Heading space level [0:14], default\ 2.
  1887. .TP
  1888. .B Hss
  1889. This is the number of lines that follows \fB.H\fP when the heading-level
  1890. is less than or equal to \fBHs\fP.
  1891. Value is in units, normally\ 1.
  1892. .TP
  1893. .B Ht
  1894. Heading numbering type, default 0.
  1895. 0 -> multiple (1.1.1 ...)
  1896. .br
  1897. 1 -> single
  1898. .TP
  1899. .B Hu
  1900. Unnumbered heading level, default 2.
  1901. .TP
  1902. .B Hy
  1903. Hyphenation in body, default 0.
  1904. .br
  1905. 0\ ->\ no hyphenation
  1906. .br
  1907. 1\ ->\ hyphenation 14 on
  1908. .TP
  1909. .B Iso
  1910. Set this variable to 1 on the command line to get ISO-formatted date string.
  1911. (\fB-rIso=1\fP)
  1912. Useless inside a document.
  1913. .TP
  1914. .B L
  1915. Page length, only for command line settings.
  1916. .TP
  1917. .B Letwam
  1918. Max lines in return-address, used in \fB.WA\fP/\fB.WE\fP.
  1919. Default\ 14.
  1920. .TP
  1921. .B "Lf, Lt, Lx, Le"
  1922. Enables (1) or disables (0) the printing of List of figures,
  1923. List of tables, List of exhibits and List of equations.
  1924. Default: Lf=1, Lt=1, Lx=1, Le=0.
  1925. .TP
  1926. .B Li
  1927. List indent, used by .AL, default 6.
  1928. .TP
  1929. .B Limsp
  1930. Flag for space between prefix and mark in automatic lists (.AL).
  1931. .br
  1932. 0\ ==\ no space
  1933. .br
  1934. 1\ ==\ space
  1935. .TP
  1936. .B Ls
  1937. List space, if current listlevel > Ls then no spacing will occur around lists.
  1938. Default 99.
  1939. .TP
  1940. .B Lsp
  1941. The size of an empty line.
  1942. Normally 0.5v, but it is 1v
  1943. if \fBn\fP is set (\fB.nroff\fP).
  1944. .TP
  1945. .B N
  1946. Numbering style [0:5], default 0.
  1947. .br
  1948. 0\ ==\ (default) normal header for all pages.
  1949. .br
  1950. 1\ ==\ header replaces footer on first page, header is empty.
  1951. .br
  1952. 2\ ==\ page header is removed on the first page.
  1953. .br
  1954. 3\ ==\ "section-page" numbering enabled.
  1955. .br
  1956. 4\ ==\ page header is removed on the first page.
  1957. .br
  1958. 5\ ==\ "section-page" and "section-figure" numbering enabled.
  1959. See also the number-register Sectf and Sectp.
  1960. .TP
  1961. .B Np
  1962. Numbered paragraphs, default 0.
  1963. .br
  1964. 0\ ==\ not numbered
  1965. .br
  1966. 1\ ==\ numbered in first level headings.
  1967. .TP
  1968. .B O
  1969. Page offset, only for command line settings.
  1970. .TP
  1971. .B Of
  1972. Format of figure,table,exhibit,equation titles, default 0.
  1973. .br
  1974. 0\ =\ ". "
  1975. .br
  1976. 1\ =\ " - "
  1977. .TP
  1978. .B P
  1979. Current page-number, normally the same as % unless "section-page" numbering
  1980. is enabled.
  1981. .TP
  1982. .B Pi
  1983. paragraph indent, default 5.
  1984. .TP
  1985. .B Pgps
  1986. Controls whether header and footer pointsize should follow the current
  1987. setting or just change when the header and footer is defined.
  1988. .in +.5i
  1989. .ti -.5i
  1990. .T2 Value
  1991. Description
  1992. .T2 0
  1993. Pointsize will only change to the current setting when \fB.PH\fP, \fB.PF\fP,
  1994. \&\fB.OH\fP, \fP.EH\fP, \fB.OF\fP or \fB.OE\fP is executed.
  1995. .T2 1
  1996. Pointsize will change after every \fB.S\fP.
  1997. This is the default.
  1998. .in
  1999. .TP
  2000. .B Ps
  2001. paragraph spacing, default 1.
  2002. .TP
  2003. .B Pt
  2004. Paragraph type, default 0.
  2005. .br
  2006. 0\ ==\ left-justified
  2007. .br
  2008. 1\ ==\ indented .P
  2009. .br
  2010. 2\ ==\ indented .P except after .H, .DE or .LE.
  2011. .TP
  2012. .B Sectf
  2013. Flag controlling "section-figures".
  2014. A non-zero value enables this.
  2015. See also register N.
  2016. .TP
  2017. .B Sectp
  2018. Flag controlling "section-page-numbers".
  2019. A non-zero value enables this.
  2020. See also register N.
  2021. .TP
  2022. .B Si
  2023. Display indent, default 5.
  2024. .TP
  2025. .B Verbin
  2026. Indent for \fB.VERBON\fP, default 5n.
  2027. .TP
  2028. .B W
  2029. Line length, only for command line settings.
  2030. .TP
  2031. .B .mgm
  2032. Always 1.
  2033. .LP
  2034. .SH INTERNALS
  2035. The letter macros is using different submacros depending on
  2036. the letter type.
  2037. The name of the submacro has the letter type
  2038. as suffix.
  2039. It is therefore possible to define other letter types, either
  2040. in the national macro-file, or as local additions.
  2041. \&\fB.LT\fP will set the number variables \fBPt\fP and \fBPi\fP to 0 and 5.
  2042. The following strings and macros must be defined for a new letter type:
  2043. .TP
  2044. \fBlet@init_\fP\fItype\fP
  2045. This macro is called directly by \fB.LT\fP.
  2046. It is supposed to initialize
  2047. variables and other stuff.
  2048. .TP
  2049. \fBlet@head_\fP\fItype\fP
  2050. This macro prints the letter head, and is called instead of the
  2051. normal page header.
  2052. It is supposed to remove the alias \fBlet@header\fP,
  2053. otherwise it will be called for all pages.
  2054. .TP
  2055. \fBlet@sg_\fP\fItype\ name\ title\ n\ flag\ [arg1\ [arg2\ [...]]]\fP
  2056. \&\fB.SG\fP is calling this macro only for letters, memorandums has
  2057. its own processing.
  2058. \fIname\fP and \fItitle\fP is specified
  2059. thru \fB.WA\fP/\fB.WB\fP.
  2060. \fIn\fP is the counter, 1-max, and
  2061. \fIflag\fP is true for the last name.
  2062. Any other argument to \fB.SG\fP
  2063. is appended.
  2064. .TP
  2065. \fBlet@fc_\fP\fItype\ closing\fP
  2066. This macro is called by \fB.FC\fP, and has the
  2067. formal closing as argument.
  2068. .LP
  2069. \&\fB.LO\fP is implemented as a general option-macro.
  2070. \fB.LO\fP demands
  2071. that a string named \fBLet\fP\fItype\fP is defined, where \fItype\fP
  2072. is the letter type.
  2073. \&\fB.LO\fP will then assign the argument to the string
  2074. variable \fBlet*lo-\fP\fItype\fP.
  2075. .LP
  2076. .\".SH BUGS
  2077. .SH AUTHOR
  2078. Jörgen Hägg, Lund, Sweden <jh@axis.se>.
  2079. .SH FILES
  2080. .TP
  2081. .B @MACRODIR@/tmac.@TMAC_M_PREFIX@m
  2082. .TP
  2083. .B @TMAC_MDIR@/*.cov
  2084. .TP
  2085. .B @TMAC_MDIR@/*.MT
  2086. .TP
  2087. .B @TMAC_MDIR@/locale
  2088. .SH "SEE ALSO"
  2089. .BR groff (@MAN1EXT@),
  2090. .BR @g@troff (@MAN1EXT@),
  2091. .BR @g@tbl (@MAN1EXT@),
  2092. .BR @g@pic (@MAN1EXT@),
  2093. .BR @g@eqn (@MAN1EXT@)
  2094. .br
  2095. .BR groff_mmse (@MAN7EXT@)
  2096. .
  2097. .\" Local Variables:
  2098. .\" mode: nroff
  2099. .\" coding: latin-1
  2100. .\" End: