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