2 .TH GROFF_MM @MAN7EXT@ "@MDATE@" "Groff Version @VERSION@"
4 groff_mm \- groff mm macros
8 Copyright \[co] 1989-2014 Free Software Foundation, Inc.
10 Permission is granted to make and distribute verbatim copies of
11 this manual provided the copyright notice and this permission notice
12 are preserved on all copies.
14 Permission is granted to copy and distribute modified versions of this
15 manual under the conditions for verbatim copying, provided that the
16 entire resulting derived work is distributed under the terms of a
17 permission notice identical to this one.
19 Permission is granted to copy and distribute translations of this
20 manual into another language, under the above conditions for modified
21 versions, except that this permission notice may be included in
22 translations approved by the Free Software Foundation instead of in
28 J\[:o]rgen H\[:a]gg, Lund, Sweden
32 .\" --------------------------------------------------------------------
34 .\" --------------------------------------------------------------------
37 .B \-m@TMAC_M_PREFIX@m
46 .\" --------------------------------------------------------------------
48 .\" --------------------------------------------------------------------
50 The groff mm macros are intended to be compatible with the DWB mm macros
51 with the following limitations:
55 No Bell Labs localisms are implemented.
59 The macros OK and PM are not implemented.
63 groff mm does not support cut marks.
68 is intended to support easy localization.
71 .B m@TMAC_M_PREFIX@mse
72 as an example how to adapt the output format to a national standard.
74 Localized strings are collected in the file
75 .RI \[oq]@MACRODIR@/ xx .tmac\[cq],
78 denotes the two-letter code for the
80 as defined in the ISO 639 standard.
82 For Swedish, this is \[oq]sv.tmac\[cq] \[en] not \[oq]se\[cq], which
83 is the ISO 3166 two-letter code for the
85 (as used for the output format localization).
88 .\"########################################################################
94 is read after the initialization of the global variables.
96 It is therefore possible to localize the macros with a different company
101 In this manual, square brackets are used to show optional arguments.
104 .\" --------------------------------------------------------------------
105 .SS "Number registers and strings"
106 .\" --------------------------------------------------------------------
108 Many macros can be controlled by number registers and strings.
110 A number register is assigned with the
116 .BI .nr\ "XXX \fR[\fP\fB\[+-]\fP\fR]\fPn \fR[\fPi\fR]\fP\""
122 is the name of the register,
124 \~is the value to be assigned, and
126 \~is the increment value for auto-increment.
129 \~can have a plus or minus sign as a prefix if an increment
130 or decrement of the current value is wanted.
132 (Auto-increment or auto-decrement occurs if the number register is
133 used with a plus or minus sign,
136 .BI \[rs]n\-[ XXX ]\fR.)\fP
140 Strings are defined with
145 \fB\&.ds\fP \fIYYY string\fP
150 The string is assigned everything to the end of the line,
155 should be prefixed with a double-quote.
157 (Strings are used in the text as
158 .BI \[rs]*[ YYY ]\fR.)\fP
161 .\" --------------------------------------------------------------------
162 .SS "Special formatting of number registers"
163 .\" --------------------------------------------------------------------
165 A number register is printed with normal digits if no format has been
179 \~is the name of the register,
190 1@0, 1, 2, 3, .\|.\|.
191 001@000, 001, 002, 003, .\|.\|.
192 i@0, i, ii, iii, iv, .\|.\|.
193 I@0, I, II, III, IV, .\|.\|.
194 a@0, a, b, c, .\|.\|., z, aa, ab, .\|.\|.
195 A@0, A, B, C, .\|.\|., Z, AA, AB, .\|.\|.
200 .\" --------------------------------------------------------------------
202 .\" --------------------------------------------------------------------
205 .BR m@TMAC_M_PREFIX@m ,
206 the fonts (or rather, font styles)
212 \~(bold) are hardwired to font positions
219 Internally, font positions are used for backwards compatibility.
221 From a practical point of view it doesn\[aq]t make a big difference
222 \[en] a different font family can still be selected with a call to the
229 On the other hand, if you want to replace just, say, font
231 you have to replace the font at position\~2 (with a call to
232 \[oq].fp\~2\~.\|.\|.\[cq]).
235 .\" --------------------------------------------------------------------
237 .\" --------------------------------------------------------------------
243 to the table of contents with
245 which is either\~0 or in the range 1 to\~7.
250 This macro is used for customized tables of contents.
254 Begin one-column processing.
258 as an argument disables the page break.
260 Use wide footnotes, small footnotes may be overprinted.
264 Begin two-column processing.
266 Splits the page in two columns.
268 It is a special case of
279 .BI AF\ \fR[\fP name-of-firm \fR]\fP
280 Author\[aq]s firm, should be called before
286 .BI AL\ \fR[\fPtype\ \fR[\fPtext-indent\ \fR[\fP1\fR]]]\fP
287 Start auto-increment list.
289 Items are numbered beginning with one.
293 argument controls the format of numbers.
302 1@Arabic (the default)
303 A@Upper-case letters (A\(enZ)
304 a@Lower-case letters (a\(enz)
312 sets the indentation and overrides
314 A third argument prohibits printing of a blank line before each item.
318 Begin an appendix with name
321 Automatic naming occurs if
326 The appendices start with\~\c
328 if automatic naming is used.
330 A new page is ejected, and a header is also produced if the number
337 The appendix always appears in the \[oq]List of contents\[cq] with
338 correct page numbers.
340 The name \[oq]APPENDIX\[cq] can be changed by setting the string
346 contains the current appendix text.
349 .BI APPSK\ "name pages text"
352 but the page number is incremented with
355 This is used when diagrams or other non-formatted documents are
356 included as appendices.
359 .BI AS\ "\fR[\fParg \fR[\fPindent\fR]]\fP"
362 Indentation is specified in \[oq]ens\[cq], but scaling is allowed.
366 controls where the abstract is printed.
375 Abstract is printed on page\~1 and on the cover sheet if used in the
376 released-paper style (\fBMT 4\fP),
377 otherwise it is printed on page\~1 without a cover sheet.
379 1@Abstract is only printed on the cover sheet (\fBMT 4\fP only).
381 Abstract is printed only on the cover sheet (other than \fBMT 4\fP only).
382 The cover sheet is printed without a need for \fBCS\fP.
388 An abstract is not printed at all in external letters (\fBMT 5\fP).
392 parameter controls the indentation of both margins, otherwise normal
393 text indentation is used.
396 .BI AST\ \fR[\fPtitle\fR]\fP
399 Default is \[oq]ABSTRACT\[cq].
401 Sets the text above the abstract text.
404 .BI AT\ "title1 \fR[\fPtitle2 \fR[.\|.\|.]]\fP"
408 must appear just after each
411 The title shows up after the name in the signature block.
414 .BI AU\ "\fR[\fPname \fR[\fPinitials \fR[\fPloc \fR[\fPdept \fR[\fPext \fR[\fProom \fR[\fParg \fR[\fParg \fR[\fParg\fR]]]]]]]]]\fP"
417 Specifies the author of the memo or paper, and is printed on the cover
418 sheet and on other similar places.
420 must not appear before
423 The author information can contain initials, location, department,
424 telephone extension, room number or name and up to three extra
428 .BI AV\ \fR[\fPname\ \fR[\fP1\fR]]\fP
431 Generates an approval line with place for signature and date.
433 The string \[oq]APPROVED:\[cq] can be changed with variable
435 it is replaced with an empty lin if there is a second argument.
437 The string \[oq]Date\[cq] can be changed with variable
441 .BI AVL\ \fR[\fPname\fR]\fP
444 Generates a line with place for signature.
447 .BI B\ "\fR[\fPbold-text \fR[\fPprev-font-text \fR[\fPbold \fR[.\|.\|.]]]]\fP"
450 No limit on the number of arguments.
452 All arguments are concatenated to one word; the first, third and so on
453 is printed in boldface.
457 Begin box (as the ms macro).
459 Draws a box around the text.
461 The text is indented one character, and the right margin is one
468 Finishes the box started with
473 End bottom block, see
477 .BI BI\ "\fR[\fPbold-text \fR[\fPitalic-text \fR[\fPbold-text \fR[.\|.\|.]]]]\fP"
480 No limit on the number of arguments,
485 .BI BL\ \fR[\fPtext-indent\ \fR[\fP1\fR]]\fP
488 Initializes a list with a bullet and a space in the beginning of each
493 overrides the default indentation of the list items set by number register
496 A third argument prohibits printing of a blank line before each item.
499 .BI BR\ "\fR[\fPbold-text \fR[\fProman-text \fR[\fPbold-text \fR[.\|.\|.]]]]\fP"
501 No limit on the number of arguments.
507 Begins the definition of a text block which is printed at the bottom
514 .BI BVL\ "text-indent \fR[\fPmark-indent\ " \fR[\fP1\fR]]\fP
515 Start of broken variable-item list.
517 Broken variable-item list has no fixed mark,
518 it assumes that every
522 The text always begins at the next line after the mark.
525 sets the indentation to the text, and
527 the distance from the current indentation to the mark.
529 A third argument prohibits printing of a blank line before each item.
532 .BI COVER\ \fR[\fParg\fR]\fP
533 Begin a coversheet definition.
537 appears before any normal text.
541 to build the filename
542 \[oq]@TMAC_MDIR@/\fIarg\fP.cov\[cq].
544 Therefore it is possible to create unlimited types of cover sheets.
546 \[oq]ms.cov\[cq] is supposed to look like the ms cover sheet.
551 at the end of the cover definition.
553 Always use this order of the cover macros:
578 Finish the cover description and print the cover page.
580 It is defined in the cover file.
586 Ends a block of text or display that begins with
592 .BI DF\ "\fR[\fPformat \fR[\fPfill \fR[\fPrindent\fR]]]\fP"
593 Begin floating display (no nesting allowed).
595 A floating display is saved in a queue and is printed in the order entered.
602 Floating displays are controlled by the two number registers
616 Nothing special, this is the default.
619 A page eject occurs after each printed display,
620 giving only one display per page and no text following it.
634 Displays are printed at the end of each section (when section-page
635 numbering is active) or at the end of the document.
638 A new display is printed on the current page if there is enough space,
639 otherwise it is printed at the end of the document.
642 One display is printed at the top of each page or column
643 (in multi-column mode).
646 Print one display if there is enough space for it,
647 otherwise it is printed at the top of the next page or column.
650 Print as many displays as possible in a new page or column.
651 A page break occurs between each display if
656 Fill the current page with displays and the rest beginning at a new page
658 (This is the default.)
659 A page break occurs between each display
660 if \fBDe\fP is not zero.
666 .BI DL\ \fR[\fPtext-indent\ "\fR[\fP\fB1\fP \fR[\fP\fB1\fP\fR]]]\fP"
669 Begins a list where each item is printed after a dash.
672 changes the default indentation of the list items set by number
676 A second argument prevents an empty line between each list item.
681 A third argument prohibits printing of a blank line before each item.
684 .BI DS\ "\fR[\fPformat \fR[\fPfill \fR[\fPrindent\fR]]]\fP"
685 Static display start.
687 Begins collection of text until
690 The text is printed together on the same page, unless it is longer
691 than the height of the page.
694 can be nested arbitrarily.
704 \[dq]\[dq]@No indentation.
708 Indent text with the value of number register
712 CB@Center the whole display as a block.
713 R@Right-adjust the lines.
714 RB@Right-adjust the whole display as a block.
719 The values \[oq]L\[cq], \[oq]I\[cq], \[oq]C\[cq], and \[oq]CB\[cq] can
720 also be specified as \[oq]0\[cq], \[oq]1\[cq], \[oq]2\[cq], and
721 \[oq]3\[cq], respectively, for compatibility reasons.
731 \[dq]\[dq]@Line-filling turned off.
732 none@Line-filling turned off.
733 N@Line-filling turned off.
734 F@Line-filling turned on.
739 \[oq]N\[cq] and \[oq]F\[cq] can also be specified as \[oq]0\[cq] and
740 \[oq]1\[cq], respectively.
743 By default, an empty line is printed before and after the display.
745 Setting number register
750 shortens the line length by that amount.
753 .BI EC\ "\fR[\fPtitle \fR[\fPoverride \fR[\fPflag \fR[\fPrefname\fR]]]]\fP"
756 Sets a title for an equation.
760 argument changes the numbering.
772 is a prefix to the number.
776 is a prefix to the number.
780 is a suffix to the number.
791 uses the number register
795 It is possible to use
797 to change the format of the number.
801 is\~1, the format of title uses a dash instead of a dot after the
807 controls the title of the List of Equations;
808 default is \[oq]LIST OF EQUATIONS\[cq].
810 The List of Equations is only printed if number register
818 contains the word \[oq]Equation\[cq], which is printed before the
824 then the equation number is saved with
826 and can be retrieved with \[oq]\fB.GETST\fP \fIrefname\fP\[cq].
829 Special handling of the title occurs if
833 it is not affected by the format of
837 .BI EF\ \fR[\fParg\fR]\fP
839 printed just above the normal page footer on even pages.
845 This macro defines string
849 .BI EH\ \fR[\fParg\fR]\fP
851 printed just below the normal page header on even pages.
857 This macro defines string
867 End-of-page user-defined macro.
869 This macro is called instead of the normal printing of the footer.
871 The macro is executed in a separate environment,
872 without any trap active.
878 .B Strings available to EOP
883 EOPf@argument of \fBPF\fP
884 EOPef@argument of \fBEF\fP
885 EOPof@argument of \fBOF\fP
890 .BI EPIC\ "\fR[\fP\fB\-L\fP\fR]\fP width height \fR[\fPname\fR]\fP"
891 Draw a box with the given
896 It also prints the text
898 or a default string if
902 This is used to include external pictures;
903 just give the size of the picture.
906 left-adjusts the picture;
907 the default is to center.
913 .BI EQ\ \fR[\fPlabel\fR]\fP
917 are the delimiters for equations written for
918 .BR @g@eqn (@MAN1EXT@).
925 is used to set options for
931 argument appears at the right margin of the equation,
932 centered vertically within the
935 unless number register
939 Then the label appears at the left margin.
942 If there are multiple
944 blocks within a single
947 only the last equation label (if any) is printed.
950 .BI EX\ "\fR[\fPtitle \fR[\fPoverride \fR[\fPflag \fR[\fPrefname\fR]]]]\fP"
953 The arguments are the same as for
957 uses the number register
963 controls the title of the List of Exhibits;
964 default is \[oq]LIST OF EXHIBITS\[cq].
966 The List of Exhibits is only printed if number register
969 which is the default.
973 contains the word \[oq]Exhibit\[cq], which is printed before the
978 is used, the exhibit number is saved with
980 and can be retrieved with \[oq]\fB.GETST\fP \fIrefname\fP\[cq].
983 Special handling of the title occurs if
987 it is not affected by the format of
991 .BI FC\ \fR[\fPclosing\fR]\fP
992 Print \[oq]Yours\~very\~truly,\[cq] as a formal closing of a letter or
995 The argument replaces the default string.
997 The default is stored in string variable
1001 .BI FD\ \fR[\fParg\ \fR[\fP1\fR]]\fP
1002 Footnote default format.
1004 Controls the hyphenation (hyphen),
1005 right margin justification (adjust),
1006 and indentation of footnote text (indent).
1008 It can also change the label justification (ljust).
1016 arg@hyphen@adjust@indent@ljust
1033 An argument greater than or equal to 11 is considered as value\~0.
1036 .B m@TMAC_M_PREFIX@m
1044 .BI FG\ "\fR[\fPtitle \fR[\fPoverride \fR[\fPflag \fR[\fPrefname\fR]]]]\fP"
1047 The arguments are the same as for
1050 uses the number register
1056 controls the title of the List of Figures;
1057 default is \[oq]LIST OF FIGURES\[cq].
1059 The List of Figures is only printed if number register
1061 is\~1, which is the default.
1065 contains the word \[oq]Figure\[cq], which is printed before the
1070 is used, then the figure number is saved with
1072 and can be retrieved with \[oq]\fB.GETST\fP \fIrefname\fP\[cq].
1075 Special handling of the title occurs if
1079 it is not affected by the format of
1083 .BI FS\ \fR[\fPlabel\fR]\fP
1086 The footnote is ended by
1089 By default, footnotes are automatically numbered;
1090 the number is available in string\~\c
1099 it is possible to have other number or names on the footnotes.
1101 Footnotes in displays are now possible.
1103 An empty line separates footnotes;
1104 the height of the line is controlled by number register
1106 default value is\~1.
1109 .BI GETHN\ "refname \fR[\fPvarname\fR]\fP"
1110 Include the header number where the corresponding \[oq]\fBSETR\fP
1111 \fIrefname\fP\[cq] was placed.
1113 This is displayed as \[oq]X.X.X.\[cq] in pass\~1.
1122 sets the string variable
1124 to the header number.
1127 .BI GETPN\ "refname \fR[\fPvarname\fR]\fP"
1128 Include the page number where the corresponding \[oq]\fBSETR\fP
1129 \fIrefname\fP\[cq] was placed.
1131 This is displayed as \[oq]9999\[cq] in pass\~1.
1140 sets the stringvariable
1150 with the text \[oq]chapter\[cq] and \[oq],\~page\[cq].
1154 contains the text for the cross reference:
1158 \&.ds Qrf See chapter \[rs]\[rs]*[Qrfh], page \[rs]\[rs]*[Qrfp].
1163 may be changed to support other languages.
1171 and contain the page and header number, respectively.
1174 .BI GETST\ "refname \fR[\fPvarname\fR]\fP"
1175 Include the string saved with the second argument to
1178 This is a dummy string in pass\~1.
1184 sets it to the saved string.
1190 .BI H\ "level \fR[\fPheading-text \fR[\fPheading-suffix\fR]]\fP"
1191 Numbered section heading.
1193 Section headers can have a level between 1 and 14;
1194 level\~1 is the top level.
1196 The text is given in
1198 and must be surrounded by double quotes if it contains spaces.
1201 is added to the header in the text but not in the table of contents.
1203 This is normally used for footnote marks and similar things.
1208 .IR heading-suffix ,
1209 it doesn\[aq]t work.
1211 A manual label must be used, see
1214 A call to the paragraph macro\~\c
1221 \~takes care of spacing and indentation.
1224 .B Page ejection before heading
1230 controls page ejection before the heading.
1232 By default, a level-one heading gets two blank lines before it;
1233 higher levels only get one.
1235 A new page is ejected before each first-level heading if number
1240 All levels below or equal the value of
1250 .B Heading break level
1254 A line break occurs after the heading if the heading level is less
1255 or equal to number register
1258 Default value is\~2.
1262 .B Heading space level
1266 A blank line is inserted after the heading if the heading level is
1267 less or equal to number register
1270 Default value is\~2.
1273 Text follows the heading on the same line if the level is greater than
1281 .B Post-heading indent
1285 Indentation of the text after the heading is controlled by number
1289 Default value is\~0.
1296 0@The text is left-justified.
1298 Indentation of the text follows the value of number
1305 The text is lined up with the first word of the heading.
1311 .B Centered section headings
1315 All headings whose level is equal or below number register
1317 and also less than or equal to
1325 .B Font control of the heading
1329 The font of each heading level is controlled by string
1332 It contains a font number or font name for each level.
1338 .B 2 2 2 2 2 2 2 2 2 2 2 2 2 2
1342 (all headings in italic).
1344 This could also be written as
1348 .B I I I I I I I I I I I I I I
1352 Note that some other implementations use
1353 .B 3\~3\~2\~2\~2\~2\~2
1354 as the default value.
1356 All omitted values are presumed to have value\~1.
1360 .B Point size control
1366 controls the point size of each heading,
1371 A value of\~0 selects the default point size.
1377 .B 0 0 0 0 0 0 0 0 0 0 0 0 0 0
1381 Beware that only the point size changes, not the vertical size.
1383 The latter can be controlled by the user-specified macros
1394 Fourteen number registers named
1398 contain the counter for each heading level.
1400 The values are printed using Arabic numerals;
1401 this can be changed with the macro
1405 All marks are concatenated before printing.
1412 This only prints the current heading counter at each heading.
1416 .B Automatic table of contents
1420 All headings whose level is equal or below number register
1422 are saved to be printed in the table of contents.
1424 Default value is\~2.
1428 .B Special control of the heading, user-defined macros
1432 The following macros can be defined by the user to get a finer control
1433 of vertical spacing, fonts, or other features.
1437 is the level-argument to\~\c
1439 but\~0 for unnumbered headings (see
1445 it is set to number register
1447 for unnumbered headings.
1451 is the text argument to
1458 .BI HX\ "level rlevel heading-text"
1459 This macro is called just before the printing of the heading.
1461 The following registers are available for
1475 Contains the heading mark plus two spaces if
1482 Contains the position of the text after the heading.
1484 0\~means that the text should follow the heading on the same line,
1485 1\~means that a line break should occur before the text,
1486 and 2\~means that a blank line should separate the heading and the text.
1490 Contains two spaces if register
1494 It is used to separate the heading from the text.
1496 The string is empty if
1502 Contains the needed space in units after the heading.
1506 Can be used to change things like numbering
1510 and the needed space after the heading.
1514 .BI HY\ "dlevel rlevel heading-text"
1515 This macro is called after size and font calculations and
1516 might be used to change indentation.
1519 .BI HZ\ "dlevel rlevel heading-text"
1520 This macro is called after the printing of the heading,
1527 Can be used to change the page header according to the section heading.
1532 .BI HC\ \fR[\fPhyphenation-character\fR]\fP
1533 Set hyphenation character.
1535 Default value is \[oq]\[rs]%\[cq].
1537 Resets to the default if called without argument.
1539 Hyphenation can be turned off by setting number register
1541 to\~0 at the beginning of the file.
1544 .BI HM\ "\fR[\fParg1 \fR[\fParg2 \fR[.\|.\|.\& [\fParg14\fR]]]]\fP"
1547 Controls the type of marking for printing of the heading counters.
1549 Default is\~1 for all levels.
1558 0001@Arabic numerals with leading zeroes, one or more.
1559 A@upper-case alphabetic
1560 a@lower-case alphabetic
1561 I@upper-case roman numerals
1562 i@lower-case roman numerals
1563 \[dq]\[dq]@Arabic numerals.
1567 .BI HU\ heading-text
1568 Unnumbered section header.
1573 at the level in number register
1580 .BI HX\ "dlevel rlevel heading-text"
1581 User-defined heading exit.
1583 Called just before printing the header.
1589 .BI HY\ "dlevel rlevel heading-text"
1590 User-defined heading exit.
1592 Called just before printing the header.
1598 .BI HZ\ "dlevel rlevel heading-text"
1599 User-defined heading exit.
1601 Called just after printing the header.
1607 .BI I\ "\fR[\fPitalic-text \fR[\fPprev-font-text \fR[\fPitalic-text \fR[.\|.\|.]]]]\fP"
1610 Changes the font to italic if called without arguments.
1612 With one argument it sets the word in italic.
1614 With two arguments it concatenates them and sets the first
1615 word in italic and the second in the previous font.
1617 There is no limit on the number of argument;
1618 all are concatenated.
1621 .BI IA\ "\fR[\fPaddressee-name \fR[\fPtitle\fR]]\fP"
1622 Begin specification of the addressee and addressee\[aq]s address in
1625 Several names can be specified with empty
1627 but only one address.
1633 .BI IB\ "\fR[\fPitalic-text \fR[\fPbold-text \fR[\fPitalic-text \fR[.\|.\|.]]]]\fP"
1636 Even arguments are printed in italic, odd in boldface.
1643 End the address specification after
1647 .BI INITI\ "type filename \fR[\fPmacro\fR]\fP"
1648 Initialize the new index system and set the filename to collect index
1654 selects the type of index: page number, header marks or both.
1656 The default is page numbers.
1659 It is also possible to create a macro that is responsible
1660 for formatting each row;
1661 just add the name of the macro as a third argument.
1663 The macro is then called with the index as argument(s).
1675 Both page numbers and header marks,
1676 separated with a tab character.
1682 Initialize the cross reference macros.
1684 Cross references are written to stderr and are supposed to be
1685 redirected into file \[oq]\fIfilename\fR.qrf\[cq].
1687 Requires two passes with groff;
1688 this is handled by a separate program called
1689 .BR mmroff (@MAN1EXT@).
1691 This program exists because
1692 .BR groff (@MAN1EXT@)
1693 by default deactivates the unsafe operations that are required by
1696 The first pass looks for cross references,
1697 and the second one includes them.
1700 can be used several times,
1701 but it is only the first occurrence of
1713 .BI IND\ "arg1 \fR[\fParg2 \fR[.\|.\|.]]\fP"
1714 Write a line in the index file selected by
1716 with all arguments and the page number or header mark separated by tabs.
1723 arg1\[rs]tpage number
1725 arg1\[rs]targ2\[rs]tpage number
1727 arg1\[rs]theader mark
1729 arg1\[rs]tpage number\[rs]theader mark
1734 Print the index by running the command specified by string variable
1736 which has \[oq]sort\ \-t\[rs]t\[cq] as the default value.
1739 reads the output from the command to form the index,
1740 by default in two columns (this can be changed by defining
1743 The index is printed with string variable
1746 default is \[oq]INDEX\[cq].
1748 One-column processing is reactivated after the list.
1751 calls the user-defined macros
1759 is called before printing the string \[oq]INDEX\[cq],
1761 is called instead of printing \[oq]INDEX\[cq], and
1763 is called after the printing and should take care of restoring to
1764 normal operation again.
1767 .B ISODATE \fR[\fP0\fR]\fP
1768 Change the predefined date string in
1770 to ISO-format, this is, \[oq]YYYY-MM-DD\[cq].
1772 This can also be done by adding
1774 on the command line.
1776 Reverts to old date format if argument is\~\c
1780 .BI IR\ "\fR[\fPitalic-text \fR[\fProman-text \fR[\fPitalic-text \fR[.\|.\|.]]]]\fP"
1783 Even arguments are printed in italic, odd in roman.
1789 .BI LB\ "text-indent mark-indent pad type \fR[\fPmark \fR[\fPLI-space \fR[\fPLB-space\fR]]]\fP"
1792 This is the common macro used for all lists.
1795 is the number of spaces to indent the text from the current indentation.
1801 control where to put the mark.
1803 The mark is placed within the mark area, and
1805 sets the number of spaces before this area.
1807 By default it is\~0.
1809 The mark area ends where the text begins.
1811 The start of the text is still controlled by
1815 The mark is left-justified within the mark area if
1824 and the mark is placed
1826 spaces before the text.
1828 This right-justifies the mark.
1833 is\~0 the list either has a hanging indentation or,
1844 is greater than\~0 automatic numbering occurs,
1845 using arabic numbers if
1850 can then be any of \[oq]1\[cq], \[oq]A\[cq], \[oq]a\[cq], \[oq]I\[cq],
1855 selects one of six possible ways to display the mark.
1876 Every item in the list gets
1878 number of blank lines before them.
1891 .BI LC\ \fR[\fPlist-level\fR]\fP
1894 Terminates all current active lists down to
1896 or\~0 if no argument is given.
1900 to clear any active list.
1903 .B LE \fR[\fP1\fR]\fP
1906 Terminates the current list.
1908 outputs a blank line if an argument is given.
1911 .BI LI\ \fR[\fPmark\ \fR[\fP1\fR|\fP2\fR]]\fP
1912 List item preceding every item in a list.
1916 prints the mark determined by the current list type.
1920 one argument, it uses that as the mark instead.
1926 a prefix to the current mark.
1928 There is no separating space between the prefix and the mark if the
1929 second argument is \[oq]2\[cq] instead of \[oq]1\[cq].
1931 This behaviour can also be achieved by setting number register
1937 makes a hanging indentation instead.
1940 A blank line is printed before the list item by default.
1942 This behaviour can be controlled by number register
1945 Pre-spacing occurs for each list level less than or equal to
1948 Default value is 99.
1950 There is no nesting limit.
1953 The indentation can be changed through number register
1958 All lists begin with a list initialization macro,
1961 There are, however, seven predefined list types to make lists easier
1966 with different default values.
1973 \fBAL\fP@Automatically Incremented List
1974 \fBML\fP@Marked List
1975 \fBVL\fP@Variable-Item List
1976 \fBBL\fP@Bullet List
1978 \fBRL\fP@Reference List
1979 \fBBVL\fP@Broken Variable List.
1984 These lists are described at other places in this manual.
1990 .BI LT\ \fR[\fIarg\/\fR]\fI
1991 Format a letter in one of four different styles depending
2006 Date line, return address, writer\[aq]s address and closing
2007 begins at the center of the line.
2009 All other lines begin at the left margin.
2014 except that the first line in every paragraph is indented five spaces.
2018 All lines begin at the left margin.
2022 Almost the same as the full-blocked style.
2023 Subject and the writer\[aq]s identification are printed in all-capital.
2029 .BI LO\ "type \fR[\fParg\fR]\fP"
2030 Specify options in letter (see
2033 This is a list of the standard options:
2041 Confidential notation.
2042 Prints \[oq]CONFIDENTIAL\[cq] on the second line below the date line.
2044 Any argument replaces \[oq]CONFIDENTIAL\[cq].
2046 See also string variable
2051 Prints \[oq]In reference to:\[cq] and the argument two lines below the date line.
2052 See also string variable
2057 Prints \[oq]ATTENTION:\[cq] and the argument below the inside address.
2058 See also string variable
2063 Prints \[cq]To Whom It May Concern:\[cq] or the argument if it was present.
2064 The salutation is printed two lines below the inside address.
2065 See also string variable
2070 Prints the argument as subject prefixed with \[oq]SUBJECT:\[cq]
2071 two lines below the inside address,
2072 except in letter type \[oq]SP\[cq],
2073 where the subject is printed in all-capital without any prefix.
2074 See also string variable
2081 .BI MC\ "column-size \fR[\fPcolumn-separation\fR]\fP"
2082 Begin multiple columns.
2084 Return to normal with
2088 creates as many columns as the current line length permits.
2091 is the width of each column,
2093 .I column-separation
2094 is the space between two columns.
2096 Default separation is
2097 .IR column-size /15.
2103 .BI ML\ "mark \fR[\fPtext-indent\ " \fR[\fP1\fR]]\fP
2108 argument is printed before each list item.
2111 sets the indent and overrides
2114 A third argument prohibits printing of a blank line before each item.
2117 .BI MT\ "\fR[\fParg \fR[\fPaddressee\fR]]\fP"
2122 is part of a filename in \[oq]@TMAC_MDIR@/*.MT\[cq].
2124 Memorandum types 0 to\~5 are supported, including type
2125 \[oq]string\[cq] (which gets internally mapped to type\~6).
2128 just sets a variable, used in the AT&T macros.
2138 0@Normal memorandum, no type printed.
2139 1@Memorandum with \[oq]MEMORANDUM FOR FILE\[cq] printed.
2140 2@Memorandum with \[oq]PROGRAMMER\[aq]S NOTES\[cq] printed.
2141 3@Memorandum with \[oq]ENGINEER\[aq]S NOTES\[cq] printed.
2142 4@Released paper style.
2143 5@External letter style.
2149 .BR COVER / COVEND ,
2150 a more flexible type of front page.
2153 .BI MOVE\ "y-pos \fR[\fPx-pos \fR[\fPline-length\fR]]\fP"
2154 Move to a position, setting page offset to
2159 is not given, the difference between current and new page offset is
2164 without arguments to return to normal.
2167 .BI MULB\ "cw1 space1 \fR[\fPcw2 space2 \fR[\fPcw3 \fR.\|.\|.]]\fP"
2168 Begin a special multi-column mode.
2170 All columns widths must be specified.
2172 The space between the columns must be specified also.
2174 The last column does not need any space definition.
2177 starts a diversion, and
2179 ends the diversion and prints the columns.
2181 The unit for the width and space arguments is \[oq]n\[cq], but
2183 accepts all normal unit specifications like \[oq]c\[cq] and \[oq]i\[cq].
2186 operates in a separate environment.
2190 Begin the next column.
2192 This is the only way to switch the column.
2196 End the multi-column mode and print the columns.
2199 .BI nP\ \fR[\fPtype\fR]\fP
2200 Print numbered paragraph with header level two.
2207 Force printing to the next column.
2209 Don\[aq]t use this together with the
2215 .BI NS\ \fR[\fParg\ \fR[\fP1\fR]]\fP
2216 Print different types of notations.
2218 The argument selects between the predefined type of notations.
2220 If the second argument is available,
2221 then the argument becomes the entire notation.
2223 If the argument doesn\[aq]t select a predefined type,
2224 it is printed as \[oq]Copy (\fIarg\/\fP) to\[cq].
2226 It is possible to add more standard notations,
2227 see the string variables
2238 \fInone\/\fP@Copy To
2240 1@Copy To (with att.\&) to
2241 2@Copy To (without att.\&) to
2246 7@Under separate cover
2249 10@Copy (with atts.\&) to
2250 11@Copy (without atts.\&) to
2252 13@Complete Memorandum to
2261 Overrides the current date.
2263 Date is not printed if
2268 .BI OF\ \fR[\fParg\fR]\fP
2269 Odd-page footer, a line printed just above the normal footer.
2277 This macro defines string
2281 .BI OH\ \fR[\fParg\fR]\fP
2282 Odd-page header, a line printed just below the normal header.
2290 This macro defines string
2295 Make sure that the following text is printed at the top of an
2298 Does not output an empty page if currently at the top of an odd page.
2301 .BI P\ \fR[\fPtype\fR]\fP
2302 Begin new paragraph.
2305 \~without argument produces left\-justified text,
2306 even the first line of the paragraph.
2308 This is the same as setting
2312 If the argument is\~1,
2313 the first line of text following\~\c
2315 is indented by the number of spaces in number register
2320 Instead of giving an argument to\~\c
2322 it is possible to set the paragraph type in number register
2325 Using 0 and\~1 is the same as adding that value to
2328 A value of\~2 indents all paragraphs, except after headings, lists,
2329 and displays (this value can\[aq]t be used as an argument to
2334 The space between two paragraphs is controlled by number register
2336 and is\~1 by default (one blank line).
2339 .BI PGFORM\ "\fR[\fPlinelength \fR[\fPpagelength \fR[\fPpageoffset\ " \fR[\fP1\fR]]]]\fP
2340 Set line length, page length, and/or page offset.
2342 This macro can be used for special formatting,
2343 like letter heads and other.
2345 It is normally the first command in a file,
2346 though it is not necessary.
2349 can be used without arguments to reset everything after a
2353 A line break is done unless the fourth argument is given.
2355 This can be used to avoid the page number on the first page
2356 while setting new width and length.
2358 (It seems as if this macro sometimes doesn\[aq]t work too well.
2360 Use the command line arguments to change
2361 line length, page length, and page offset instead.)
2365 No header is printed on the next page.
2367 Used to get rid of the header in letters or other special texts.
2369 This macro must be used before any text to inhibit the page header
2373 .BI "PIC \fR[\fP\-B\fR] [\fP\-L\fR] [\fP\-C\fR] [\fP\-R\fR] [\fP\-I\ " "n\fR]\fP filename \fR[\fPwidth \fR[\fPheight\fR]]\fP"
2374 Include a PostScript file in the document.
2376 The macro depends on
2377 .BR mmroff (@MAN1EXT@)
2387 adjust the picture or indent it.
2389 With no flag the picture is adjusted to the left.
2393 draws a box around the picture.
2399 can also be given to resize the picture.
2406 .BR @g@pic (@MAN1EXT).
2409 .BI PF\ \fR[\fParg\fR]\fP
2412 sets the line to be printed at the bottom of each page.
2418 for the argument specification.
2421 This macro defines string
2425 .BI PH\ \fR[\fParg\fR]\fP
2426 Page header, a line printed at the top of each page.
2428 The argument should be specified as
2432 .RI \[dq]' left-part ' center-part ' right-part '\[dq]
2441 are printed left-justified, centered, and right justified, respectively.
2443 Within the argument to
2445 the character \[oq]%\[cq] is changed to the current page number.
2447 The default argument is
2455 which gives the page number between two dashes.
2458 This macro defines string
2463 Picture start (from pic).
2465 Begins a picture for
2466 .BR @g@pic (@MAN1EXT@).
2470 Page header user-defined exit.
2472 This macro is called just after the printing of the page header in
2480 Return to roman font, see also\~\c
2484 .BI RB\ "\fR[\fProman-text \fR[\fPbold-text \fR[\fProman-text \fR[.\|.\|.]]]]\fP"
2487 Even arguments are printed in roman, odd in boldface.
2493 .BI RD\ "\fR[\fPprompt \fR[\fPdiversion \fR[\fPstring\fR]]]\fP"
2494 Read from standard input to diversion and/or string.
2496 The text is saved in a diversion named
2499 Recall the text by writing the name of the diversion after a dot
2502 A string is also defined if
2509 can be empty (\[dq]\[dq]).
2515 Ends a reference definition and returns to normal processing.
2521 .BI RI\ "\fR[\fProman-text \fR[\fPitalic-text \fR[\fProman-text \fR[.\|.\|.]]]]\fP"
2522 Print even arguments in roman, odd in italic.
2528 .BI RL\ \fR[\fPtext-indent \fR[\fP1\fR]]\fP
2529 Reference list start.
2531 Begins a list where each item is preceded with an automatically
2532 incremented number between square brackets.
2535 changes the default indentation.
2538 .BI RP\ "\fR[\fParg1 \fR[\fParg2\fR]]\fP"
2539 Produce reference page.
2541 This macro can be used if a reference page is wanted somewhere in the
2546 is used to produce a table of contents.
2548 The reference page is then printed automatically.
2551 The reference counter is not reset if
2559 whether to eject a page or not.
2569 0@The reference page is printed on a separate page.
2570 1@Do not eject page after the list.
2571 2@Do not eject page before the list.
2572 3@Do not eject page before and after the list.
2577 The reference items are separated by a blank line.
2579 Setting number register
2581 to\~0 suppresses the line.
2586 contains the reference page title and is set to \[oq]REFERENCES\[cq]
2591 holds the default value for the second argument of
2593 it is initially set to\~0.
2596 .BI RS\ \fR[\fPstring-name\fR]\fP
2597 Begin an automatically numbered reference definition.
2601 where the reference mark should be and write the reference between
2603 at next new line after the reference mark.
2605 The reference number is stored in number register
2610 is given, a string with that name is defined and contains the current
2613 The string can be referenced as
2614 .BI \[rs]*[ string-name ]
2618 .BI S\ "\fR[\fPsize \fR[\fPspacing\fR]]\fP"
2619 Set point size and vertical spacing.
2621 If any argument is equal to \[oq]P\[cq], the previous value is used.
2623 A \[oq]C\[cq] means current value, and \[oq]D\[cq] the default value.
2625 If \[oq]+\[cq] or \[oq]\-\[cq] is used before the value,
2626 the current value is incremented or decremented, respectively.
2629 .BI SA\ \fR[\fParg\fR]\fP
2630 Set right-margin justification.
2632 Justification is turned on by default.
2634 No argument or value \[oq]0\[cq] turns off justification,
2635 and \[oq]1\[cq] turns on justification.
2638 .BI SETR\ "refname \fR[\fPstring\fR]\fP"
2639 Remember the current header and page number as
2656 .BI SG\ \fR[\fParg\ \fR[\fP1\fR]]\fP
2659 Prints the authors name(s) after the formal closing.
2661 The argument is appended to the reference data, printed at either the
2662 first or last author.
2664 The reference data is the location, department, and initials specified
2668 It is printed at the first author if the second argument is given,
2669 otherwise at the last.
2671 No reference data is printed if the author(s) is specified through
2678 .BI SK\ \fR[\fPpages\fR]\fP
2683 is\~0 or omitted, a skip to the next page occurs unless it is already
2684 at the top of a page.
2691 .BI SM\ "string1 \fR[\fPstring2 \fR[\fPstring3\fR]]\fP"
2692 Make a string smaller.
2700 stays at normal size,
2704 With three arguments, everything is concatenated, but only
2709 .BI SP\ \fR[\fPlines\fR]\fP
2713 can have any scaling factor, like \[oq]3i\[cq] or \[oq]8v\[cq].
2717 calls in a line only produces the maximum number of lines, not the sum.
2720 is ignored also until the first text line in a page.
2730 Reset tabs to every\ 5n.
2732 Normally used to reset any previous tab positions.
2735 .BI TB\ "\fR[\fPtitle \fR[\fPoverride \fR[\fPflag \fR[\fPrefname\fR]]]]\fP"
2738 The arguments are the same as for
2742 uses the number register
2748 controls the title of the List of Tables;
2749 default value is \[oq]LIST OF TABLES\[cq].
2751 The List of Tables is only printed if number register
2753 is\~1, which is the default.
2757 contains the word \[oq]TABLE\[cq], which is printed before the number.
2760 Special handling of the title occurs if
2764 it is not affected by the format of
2768 .BI TC\ "\fR[\fPslevel \fR[\fPspacing \fR[\fPtlevel \fR[\fPtab \fR[\fPh1 \fR[\fPh2 \fR[\fPh3 \fR[\fPh4 \fR[\fPh5\fR]]]]]]]]]\fP"
2771 This macro is normally used as the last line of the document.
2773 It generates a table of contents with headings up to the level
2774 controlled by number register
2779 controls the saving of headings, it has nothing to do with
2782 Headings with a level less than or equal to
2786 number of lines before them.
2788 Headings with a level less than or equal to
2790 have their page numbers right\-justified with dots or spaces separating
2791 the text and the page number.
2795 is greater than zero, dots otherwise.
2797 Other headings have the page number directly at the end of the heading
2799 .RI ( ragged-right ).
2802 The rest of the arguments is printed, centered, before the table of
2806 The user-defined macros
2812 is called with at most four arguments.
2815 is called before the printing of the string \[oq]CONTENTS\[cq],
2818 is called instead of printing \[oq]CONTENTS\[cq].
2821 Equivalent macros can be defined for list of figures, tables, equations
2822 and exhibits by defining
2828 is \[oq]Fg\[cq], \[oq]TB\[cq], \[oq]EC\[cq], or \[oq]EX\[cq],
2834 can be set to control the indentations for each heading-level.
2836 It must be scaled, like
2840 \&.ds Ci .25i .5i .75i 1i 1i
2844 By default, the indentation is controlled by the maximum length of
2845 headings in each level.
2848 The string variables
2855 contain \[oq]Figure\[cq], \[oq]TABLE\[cq], \[oq]Exhibit\[cq],
2856 \[oq]Equation\[cq], and \[oq]CONTENTS\[cq], respectively.
2858 These can be redefined to other languages.
2868 .B TH \fR[\fPN\fR]\fP
2875 ends the header of the table.
2877 This header is printed again if a page break occurs.
2879 Argument \[oq]N\[cq] isn\[aq]t implemented yet.
2882 .BI TL\ "\fR[\fPcharging-case-number \fR[\fPfiling-case-number\fR]]\fP"
2883 Begin title of memorandum.
2885 All text up to the next
2887 is included in the title.
2889 .I charging-case-number
2891 .I filing-case-number
2892 are saved for use in the front page processing.
2895 .BI TM\ "\fR[\fPnum1 \fR[\fPnum2 \fR[.\|.\|.]]]\fP"
2896 Technical memorandum numbers used in
2899 An unlimited number of arguments may be given.
2903 Top-of-page user-defined macro.
2905 This macro is called instead of the normal page header.
2907 It is possible to get complete control over the header.
2909 Note that the header and the footer are printed in a separate environment.
2911 Line length is preserved, though.
2917 .B strings available to TP
2922 TPh@argument of \fBPH\fP
2923 TPeh@argument of \fBEH\fP
2924 TPoh@argument of \fBOH\fP
2929 .B TS \fR[\fPH\fR]\fP
2932 This is the start of a table specification to
2933 .BR @g@tbl (@MAN1EXT@).
2939 Argument \[oq]H\[cq] tells
2940 .B m@TMAC_M_PREFIX@m
2941 that the table has a header.
2948 User-defined table of contents exit.
2950 This macro is called just before
2952 prints the word \[oq]CONTENTS\[cq].
2959 User-defined table of contents exit.
2961 This macro is called instead of printing \[oq]CONTENTS\[cq].
2967 .BI VERBON\ "\fR[\fPflag \fR[\fPpoint-size \fR[\fPfont\fR]]]\fP"
2968 Begin verbatim output using Courier font.
2970 Usually for printing programs.
2972 All characters have equal width.
2974 The point size can be changed with the second argument.
2976 By specifying a third argument it is possible to use another font
2980 controls several special features.
2982 Its value is the sum of all wanted features.
2992 Disable the escape character (\[rs]).
2993 This is normally turned on during verbose output.
2995 2@Add an empty line before the verbose text.
2996 4@Add an empty line after the verbose text.
2998 Print the verbose text with numbered lines.
2999 This adds four digit-sized spaces in the beginning of each line.
3000 Finer control is available with the string variable
3002 It contains all arguments to the
3003 .BR troff (@MAN1EXT@)
3006 normally \[oq]1\[cq].
3009 Indent the verbose text by \[oq]5n\[cq].
3011 This is controlled by the number-variable
3020 End verbatim output.
3023 .BI VL\ "text-indent \fR[\fPmark-indent\ " \fR[\fP1\fR]]\fP
3026 It has no fixed mark, it assumes that every
3031 sets the indent to the text, and
3033 the distance from the current indentation to the mark.
3035 A third argument prohibits printing of a blank line before each item.
3038 .BI "VM \fR[\fP\-T\fR] [\fP" "top \fR[\fPbottom\fR]]\fP"
3041 Increase the top and bottom margin by
3049 is specified, set those margins to
3054 If no argument is given, reset the margin to zero, or to the default
3055 (\[oq]7v 5v\[cq]) if
3059 It is highly recommended that macros
3063 are defined if using
3065 and setting top and/or bottom margin to less than the default.
3068 .BI WA\ "\fR[\fPwriter-name \fR[\fPtitle\fR]]\fP"
3069 Begin specification of the writer and writer\[aq]s address.
3071 Several names can be specified with empty
3073 pairs, but only one address.
3077 End the address specification after
3081 .BI WC\ "\fR[\fPformat1\fR] [\fPformat2\fR] [.\|.\|.]\fP"
3082 Footnote and display width control.
3089 Set default mode which is equal to using the options
3097 Wide footnotes, wide also in two-column mode.
3099 -WF@Normal footnote width, follow column mode.
3101 All footnotes gets the same width as the first footnote encountered.
3104 Normal footnotes, width follows \fBWF\fP and \fB-WF\fP.
3107 Wide displays, wide also in two-column mode.
3110 Normal display width, follow column mode.
3113 Floating displays generates a line break when printed on the current
3117 Floating displays does not generate line break.
3123 .\" --------------------------------------------------------------------
3124 .SS "Strings used in m@TMAC_M_PREFIX@m"
3125 .\" --------------------------------------------------------------------
3129 A string containing the word \[oq]APPENDIX\[cq].
3133 The current appendix text.
3145 to the current heading text.
3147 Also updated in table of contents & friends.
3151 Font list for headings, \[oq]2 2 2 2 2 2 2\[cq] by default.
3153 Non-numeric font names may also be used.
3157 Point size list for headings.
3159 By default, this is \[cq]0 0 0 0 0 0 0\[cq] which is the same as \[oq]10
3160 10 10 10 10 10 10\[cq].
3164 Contains the string \[oq]INDEX\[cq].
3168 Contains the index command.
3170 Default value is \[oq]sort\ \-t\[rs]t\[cq].
3174 String containing \[oq]Figure\[cq].
3178 String containing \[oq]TABLE\[cq].
3182 String containing \[oq]Exhibit\[cq].
3186 String containing \[oq]Equation\[cq].
3190 String containing \[oq]CONTENTS\[cq].
3194 Contains the string \[oq]LIST OF FIGURES\[cq].
3198 Contains the string \[oq]LIST OF TABLES\[cq].
3202 Contains the string \[oq]LIST OF EXHIBITS\[cq].
3206 Contains the string \[oq]LIST OF EQUATIONS\[cq].
3210 Contains the string \[oq]Yours very truly,\[cq],
3216 Contains the string \[oq]APPROVED:\[cq],
3222 Contains the string \[oq]Date\[cq],
3228 Contains the string \[oq]CONFIDENTIAL\[cq],
3234 Contains the string \[oq]To Whom It May Concern:\[cq],
3240 Contains the string \[oq]ATTENTION:\[cq],
3246 Contains the string \[oq]SUBJECT:\[cq],
3252 Contains the string \[oq]In reference to:\[cq],
3258 is an array containing the different strings used in
3261 It is really a number of string variables prefixed with
3264 If the argument doesn\[aq]t exist, it is included between
3272 Observe the space after \[oq]Copy\[cq] and before \[oq]to\[cq].
3282 Letns!1@Copy (with att.\&) to
3283 Letns!2@Copy (without att.\&) to
3288 Letns!7@Under separate cover
3290 Letns!9@Memorandum to
3291 Letns!10@Copy (with atts.\&) to
3292 Letns!11@Copy (without atts.\&) to
3293 Letns!12@Abstract Only to
3294 Letns!13@Complete Memorandum to
3296 Letns!copy@Copy \[rs]"
3303 Define the standard notation used when no argument is given to
3310 Strings containing the month names \[oq]January\[cq] through
3315 String containing \[oq]See chapter \[rs]\[rs]*[Qrfh], page
3316 \[rs]\[rs]n[Qrfp].\[cq].
3320 Contains the string \[oq]REFERENCES\[cq].
3324 Contains the current status of the table of contents and list of
3330 Useful in user-defined macros like
3340 co@Table of contents
3343 ec@List of equations
3351 Contains the string \[oq]\[rs](tm\[cq], the trade mark symbol.
3364 .\" --------------------------------------------------------------------
3365 .SS "Number variables used in m@TMAC_M_PREFIX@m"
3366 .\" --------------------------------------------------------------------
3370 Print an appendix page for every new appendix if this number variable
3375 is zero, but there is always an appendix entry in the \[oq]List of
3380 Contents level (in the range 0 to 14).
3382 The contents is saved if a heading level is lower than or equal to the
3390 Eject page between list of table, list of figure, etc., if the value of
3400 Values greater than zero produce debug information of increasing
3403 A value of\~1 gives information about the progress of formatting.
3409 If set to\~1, eject after floating display is output.
3415 If defined, it controls the space output before and after static
3418 Otherwise the value of
3424 Control floating keep output.
3426 This is a number in the range 0 to 5, with a default value of\~5.
3433 If set to\~1, use the amount of space stored in register
3435 before and after display.
3441 If set to\~1, eject page before each first-level heading.
3447 Equation labels are left-adjusted if set to\~0 and right-adjusted if
3464 Append a dot after the level-one heading number if value is greater
3471 A copy of number register
3473 but it is incremented just before the page break.
3475 Useful in user-defined header macros.
3479 Heading break level.
3481 A number in the range 0 to 14, with a default value of\~2.
3488 Heading centering level.
3490 A number in the range 0 to 14, with a default value value of\~0.
3497 Heading temporary indent.
3499 A number in the range 0 to 2, with a default value of\~1.
3506 0@no indentation, left margin
3508 indent to the right, similar to
3509 .RB \[oq] ".P 1" \[cq]
3512 indent to line up with text part of preceding heading
3519 Heading pre-space level.
3521 If the heading level is less than or equal to
3523 two lines precede the section heading instead of one.
3525 Default is first level only.
3527 The real amount of lines is controlled by the variables
3534 Number of lines preceding
3536 if the heading level is greater than
3539 Value is in units, default is 0.5.
3543 Number of lines preceding
3545 if the heading level is less than or equal to
3548 Value is in units, default is\~1.
3552 Heading space level.
3554 A number in the range 0 to 14, with a default value of\~2.
3561 Number of lines following
3563 if the heading level is less than or equal to
3566 Value is in units, default is\~1.
3570 Heading numbering type.
3577 0@multiple levels (1.1.1, 1.1.2, etc.)
3586 Unnumbered heading level.
3592 Hyphenation status of text body.
3600 1@hyphenation on, set to value\~14
3609 Set this variable to\~1 on the command line to get an ISO-formatted
3610 date string (\fB\-rIso=1\fP).
3612 Useless inside of a document.
3616 Page length, only for command line settings.
3620 Maximum lines in return-address, used in
3626 .BR Lf ,\ Lt ,\ Lx ,\ Le
3627 Enable (1) or disable (0) the printing of List of figures,
3629 List of tables, List of exhibits and List of equations, respectively.
3631 Default values are Lf=1, Lt=1, Lx=1, and Le=0.
3635 List indentation, used by
3642 A flag controlling the insertion of space between prefix and mark in
3658 List space threshold.
3660 If current list level is greater than
3662 no spacing occurs around lists.
3668 The vertical space used by an empty line.
3670 The default is 0.5v in troff mode and 1v in nroff mode.
3674 Page numbering style.
3681 0@normal header for all pages.
3683 header replaces footer on first page, header is empty.
3685 2@page header is removed on the first page.
3686 3@\[oq]section-page\[cq] numbering style enabled.
3687 4@page header is removed on the first page.
3689 \[oq]section-page\[cq] and \[oq]section-figure\[cq] numbering style enabled.
3697 See also the number registers
3704 A flag to control whether paragraphs are numbered.
3712 1@numbered in first-level headings.
3721 Page offset, only for command line settings.
3725 Format of figure, table, exhibit, and equation titles.
3742 Current page-number, normally the same as \[oq]%\[cq] unless
3743 \[oq]section-page\[cq] numbering style is enabled.
3747 Paragraph indentation.
3753 A flag to control whether header and footer point size should follow
3754 the current settings or just change when the header and footer are
3763 Point size only changes to the current setting when
3774 Point size changes after every
3776 This is the default.
3796 1@indented paragraphs
3798 indented paragraphs except after
3812 Set default value for second argument of
3819 A flag controlling \[oq]section-figures\[cq] numbering style.
3821 A non-zero value enables this.
3823 See also register\~\c
3828 A flag controlling \[cq]section-page\[cq] numbering style.
3830 A non-zero value enables this.
3832 See also register\~\c
3837 Display indentation.
3850 Line length, only for command line settings.
3857 .\" --------------------------------------------------------------------
3859 .\" --------------------------------------------------------------------
3861 The letter macros are using different submacros depending on the
3864 The name of the submacro has the letter type as suffix.
3866 It is therefore possible to define other letter types, either in the
3867 national macro-file, or as local additions.
3870 sets the number variables
3874 to 0 and\~5, respectively.
3876 The following strings and macros must be defined for a new letter type.
3880 This macro is called directly by
3883 It is supposed to initialize variables and other stuff.
3887 This macro prints the letter head,
3888 and is called instead of the normal page header.
3890 It is supposed to remove the alias
3892 otherwise it is called for all pages.
3895 .BI let@sg_ "type name title n flag \fR[\fParg1 \fR[\fParg2 \fR[.\|.\|.]]]\fP"
3897 is calling this macro only for letters;
3898 memorandums have its own processing.
3903 are specified through
3907 \~is the counter, 1-max, and
3909 is true for the last name.
3911 Any other argument to
3916 .BI let@fc_ "type closing"
3917 This macro is called by
3919 and has the formal closing as the argument.
3924 is implemented as a general option-macro.
3926 It demands that a string named
3933 then assigns the argument to the string variable
3934 .BI let*lo- type\fR.\fP
3937 .\" --------------------------------------------------------------------
3939 .\" --------------------------------------------------------------------
3942 .\" --------------------------------------------------------------------
3944 .\" --------------------------------------------------------------------
3947 .B @MACRODIR@/@TMAC_M_PREFIX@m.tmac
3949 .B @TMAC_MDIR@/*.cov
3953 .B @TMAC_MDIR@/locale
3957 .\" --------------------------------------------------------------------
3959 .\" --------------------------------------------------------------------
3961 .BR groff (@MAN1EXT@),
3962 .BR @g@troff (@MAN1EXT@),
3963 .BR @g@tbl (@MAN1EXT@),
3964 .BR @g@pic (@MAN1EXT@),
3965 .BR @g@eqn (@MAN1EXT@)
3967 .BR groff_mmse (@MAN7EXT@)
3970 .\" --------------------------------------------------------------------
3972 .\" --------------------------------------------------------------------
3974 .\" --------------------------------------------------------------------
3976 .\" --------------------------------------------------------------------
3980 .\" Local Variables: