2 .TH GROFF_MM @MAN7EXT@ "@MDATE@" "groff @VERSION@"
4 groff_mm \- memorandum macros for GNU roff
7 .\" Save and disable compatibility mode (for, e.g., Solaris 10/11).
8 .do nr groff_mm_C \n[.C]
12 .\" ====================================================================
14 .\" ====================================================================
16 .\" Copyright (C) 1989-2018 Free Software Foundation, Inc.
18 .\" Permission is granted to make and distribute verbatim copies of this
19 .\" manual provided the copyright notice and this permission notice are
20 .\" preserved on all copies.
22 .\" Permission is granted to copy and distribute modified versions of
23 .\" this manual under the conditions for verbatim copying, provided that
24 .\" the entire resulting derived work is distributed under the terms of
25 .\" a permission notice identical to this one.
27 .\" Permission is granted to copy and distribute translations of this
28 .\" manual into another language, under the above conditions for
29 .\" modified versions, except that this permission notice may be
30 .\" included in translations approved by the Free Software Foundation
31 .\" instead of in the original English.
34 .\" ====================================================================
36 .\" ====================================================================
38 .SY "groff \-m@TMAC_M_PREFIX@m"
43 .SY "groff \-m m@TMAC_M_PREFIX@m"
51 .\" ====================================================================
53 .\" ====================================================================
55 The groff mm macros are intended to be compatible with the DWB mm macros
56 with the following limitations:
60 No Bell Labs localisms are implemented.
64 The macros OK and PM are not implemented.
68 groff mm does not support cut marks.
73 is intended to support easy localization.
76 .B m@TMAC_M_PREFIX@mse
77 as an example how to adapt the output format to a national standard.
79 Localized strings are collected in the file
80 .IR @MACRODIR@/ xx .tmac ,
83 denotes the two-letter code for the
85 as defined in the ISO 639 standard.
87 For Swedish, this is \[oq]sv.tmac\[cq] \[en] not \[oq]se\[cq], which
88 is the ISO 3166 two-letter code for the
90 (as used for the output format localization).
93 .\"########################################################################
99 is read after the initialization of the global variables.
101 It is therefore possible to localize the macros with a different company
106 In this manual, square brackets are used to show optional arguments.
109 .\" ====================================================================
110 .SS "Number registers and strings"
111 .\" ====================================================================
113 Many macros can be controlled by number registers and strings.
115 A number register is assigned with the
121 .BI .nr\ "XXX \fR[\fP\fB\[+-]\fP\fR]\fPn \fR[\fPi\fR]\fP\""
127 is the name of the register,
129 the value to be assigned, and
131 the increment value for auto-increment.
134 have a plus or minus sign as a prefix if an increment
135 or decrement of the current value is wanted.
137 (Auto-increment or auto-decrement occurs if the number register is
138 used with a plus or minus sign,
141 .BI \[rs]n\-[ XXX ]\fR.)\fP
145 Strings are defined with
150 \fB\&.ds\fP \fIYYY string\fP
155 The string is assigned everything to the end of the line,
160 should be prefixed with a double-quote.
162 (Strings are used in the text as
163 .BI \[rs]*[ YYY ]\fR.)\fP
166 .\" ====================================================================
167 .SS "Special formatting of number registers"
168 .\" ====================================================================
170 A number register is printed with normal digits if no format has been
184 the name of the register,
195 1@0, 1, 2, 3, .\|.\|.
196 001@000, 001, 002, 003, .\|.\|.
197 i@0, i, ii, iii, iv, .\|.\|.
198 I@0, I, II, III, IV, .\|.\|.
199 a@0, a, b, c, .\|.\|., z, aa, ab, .\|.\|.
200 A@0, A, B, C, .\|.\|., Z, AA, AB, .\|.\|.
205 .\" ====================================================================
207 .\" ====================================================================
210 .BR m@TMAC_M_PREFIX@m ,
211 the fonts (or rather, font styles)
216 are hardwired to font positions
223 Internally, font positions are used for backwards compatibility.
225 From a practical point of view it doesn't make a big difference
226 \[en] a different font family can still be selected with a call to the
233 On the other hand, if you want to replace just, say, font
235 you have to replace the font at position\~2 (with a call to
236 \[oq].fp\~2\~.\|.\|.\[cq]).
239 .\" ====================================================================
241 .\" ====================================================================
247 to the table of contents with
249 which is either\~0 or in the range 1 to\~7.
254 This macro is used for customized tables of contents.
258 Begin one-column processing.
262 as an argument disables the page break.
264 Use wide footnotes, small footnotes may be overprinted.
268 Begin two-column processing.
270 Splits the page in two columns.
272 It is a special case of
283 .BI AF\ \fR[\fP name-of-firm \fR]\fP
284 Author's firm, should be called before
290 .BI AL\ \fR[\fPtype\ \fR[\fPtext-indent\ \fR[\fP1\fR]]]\fP
291 Start auto-increment list.
293 Items are numbered beginning with one.
297 argument controls the format of numbers.
306 1@Arabic (the default)
307 A@Upper-case letters (A\(enZ)
308 a@Lower-case letters (a\(enz)
316 sets the indentation and overrides
318 A third argument prohibits printing of a blank line before each item.
322 Begin an appendix with name
325 Automatic naming occurs if
330 The appendices start with\~\c
332 if automatic naming is used.
334 A new page is ejected, and a header is also produced if the number
341 The appendix always appears in the \[oq]List of contents\[cq] with
342 correct page numbers.
344 The name \[oq]APPENDIX\[cq] can be changed by setting the string
350 contains the current appendix text.
353 .BI APPSK\ "name pages text"
356 but the page number is incremented with
359 This is used when diagrams or other non-formatted documents are
360 included as appendices.
363 .BI AS\ "\fR[\fParg \fR[\fPindent\fR]]\fP"
366 Indentation is specified in \[oq]ens\[cq], but scaling is allowed.
370 controls where the abstract is printed.
379 Abstract is printed on page\~1 and on the cover sheet if used in the
380 released-paper style (\fBMT 4\fP),
381 otherwise it is printed on page\~1 without a cover sheet.
383 1@Abstract is only printed on the cover sheet (\fBMT 4\fP only).
385 Abstract is printed only on the cover sheet (other than \fBMT 4\fP only).
386 The cover sheet is printed without a need for \fBCS\fP.
392 An abstract is not printed at all in external letters (\fBMT 5\fP).
396 parameter controls the indentation of both margins, otherwise normal
397 text indentation is used.
400 .BI AST\ \fR[\fPtitle\fR]\fP
403 Default is \[oq]ABSTRACT\[cq].
405 Sets the text above the abstract text.
408 .BI AT\ "title1 \fR[\fPtitle2 \fR[.\|.\|.]]\fP"
412 must appear just after each
415 The title shows up after the name in the signature block.
418 .BI AU\ "\fR[\fPname \fR[\fPinitials \fR[\fPloc \fR[\fPdept \fR[\fPext \fR[\fProom \fR[\fParg \fR[\fParg \fR[\fParg\fR]]]]]]]]]\fP"
421 Specifies the author of the memo or paper, and is printed on the cover
422 sheet and on other similar places.
424 must not appear before
427 The author information can contain initials, location, department,
428 telephone extension, room number or name and up to three extra
432 .BI AV\ \fR[\fPname\ \fR[\fP1\fR]]\fP
435 Generates an approval line with place for signature and date.
437 The string \[oq]APPROVED:\[cq] can be changed with variable
439 it is replaced with an empty lin if there is a second argument.
441 The string \[oq]Date\[cq] can be changed with variable
445 .BI AVL\ \fR[\fPname\fR]\fP
448 Generates a line with place for signature.
451 .BI B\ "\fR[\fPbold-text \fR[\fPprev-font-text \fR[\fPbold \fR[.\|.\|.]]]]\fP"
454 No limit on the number of arguments.
456 All arguments are concatenated to one word; the first, third and so on
457 is printed in boldface.
461 Begin box (as the ms macro).
463 Draws a box around the text.
465 The text is indented one character, and the right margin is one
472 Finishes the box started with
477 End bottom block, see
481 .BI BI\ "\fR[\fPbold-text \fR[\fPitalic-text \fR[\fPbold-text \fR[.\|.\|.]]]]\fP"
484 No limit on the number of arguments,
489 .BI BL\ \fR[\fPtext-indent\ \fR[\fP1\fR]]\fP
492 Initializes a list with a bullet and a space in the beginning of each
497 overrides the default indentation of the list items set by number register
500 A third argument prohibits printing of a blank line before each item.
503 .BI BR\ "\fR[\fPbold-text \fR[\fProman-text \fR[\fPbold-text \fR[.\|.\|.]]]]\fP"
505 No limit on the number of arguments.
511 Begins the definition of a text block which is printed at the bottom
518 .BI BVL\ "text-indent \fR[\fPmark-indent\ " \fR[\fP1\fR]]\fP
519 Start of broken variable-item list.
521 Broken variable-item list has no fixed mark,
522 it assumes that every
526 The text always begins at the next line after the mark.
529 sets the indentation to the text, and
531 the distance from the current indentation to the mark.
533 A third argument prohibits printing of a blank line before each item.
536 .BI COVER\ \fR[\fParg\fR]\fP
537 Begin a coversheet definition.
541 appears before any normal text.
545 to build the filename
546 .IR @TMAC_MDIR@/ arg .cov .
548 Therefore it is possible to create unlimited types of cover sheets.
551 is supposed to look like the ms cover sheet.
556 at the end of the cover definition.
558 Always use this order of the cover macros:
583 Finish the cover description and print the cover page.
585 It is defined in the cover file.
591 Ends a block of text or display that begins with
597 .BI DF\ "\fR[\fPformat \fR[\fPfill \fR[\fPrindent\fR]]]\fP"
598 Begin floating display (no nesting allowed).
600 A floating display is saved in a queue and is printed in the order entered.
607 Floating displays are controlled by the two number registers
621 Nothing special, this is the default.
624 A page eject occurs after each printed display,
625 giving only one display per page and no text following it.
639 Displays are printed at the end of each section (when section-page
640 numbering is active) or at the end of the document.
643 A new display is printed on the current page if there is enough space,
644 otherwise it is printed at the end of the document.
647 One display is printed at the top of each page or column
648 (in multi-column mode).
651 Print one display if there is enough space for it,
652 otherwise it is printed at the top of the next page or column.
655 Print as many displays as possible in a new page or column.
656 A page break occurs between each display if
661 Fill the current page with displays and the rest beginning at a new page
663 (This is the default.)
664 A page break occurs between each display
665 if \fBDe\fP is not zero.
671 .BI DL\ \fR[\fPtext-indent\ "\fR[\fP\fB1\fP \fR[\fP\fB1\fP\fR]]]\fP"
674 Begins a list where each item is printed after a dash.
677 changes the default indentation of the list items set by number
681 A second argument prevents an empty line between each list item.
686 A third argument prohibits printing of a blank line before each item.
689 .BI DS\ "\fR[\fPformat \fR[\fPfill \fR[\fPrindent\fR]]]\fP"
690 Static display start.
692 Begins collection of text until
695 The text is printed together on the same page, unless it is longer
696 than the height of the page.
699 can be nested arbitrarily.
709 \[dq]\[dq]@No indentation.
713 Indent text with the value of number register
717 CB@Center the whole display as a block.
718 R@Right-adjust the lines.
719 RB@Right-adjust the whole display as a block.
724 The values \[oq]L\[cq], \[oq]I\[cq], \[oq]C\[cq], and \[oq]CB\[cq] can
725 also be specified as \[oq]0\[cq], \[oq]1\[cq], \[oq]2\[cq], and
726 \[oq]3\[cq], respectively, for compatibility reasons.
736 \[dq]\[dq]@Line-filling turned off.
737 none@Line-filling turned off.
738 N@Line-filling turned off.
739 F@Line-filling turned on.
744 \[oq]N\[cq] and \[oq]F\[cq] can also be specified as \[oq]0\[cq] and
745 \[oq]1\[cq], respectively.
748 By default, an empty line is printed before and after the display.
750 Setting number register
755 shortens the line length by that amount.
758 .BI EC\ "\fR[\fPtitle \fR[\fPoverride \fR[\fPflag \fR[\fPrefname\fR]]]]\fP"
761 Sets a title for an equation.
765 argument changes the numbering.
777 is a prefix to the number.
781 is a prefix to the number.
785 is a suffix to the number.
796 uses the number register
800 It is possible to use
802 to change the format of the number.
806 is\~1, the format of title uses a dash instead of a dot after the
812 controls the title of the List of Equations;
813 default is \[oq]LIST OF EQUATIONS\[cq].
815 The List of Equations is only printed if number register
823 contains the word \[oq]Equation\[cq], which is printed before the
829 then the equation number is saved with
831 and can be retrieved with \[oq]\fB.GETST\fP \fIrefname\fP\[cq].
834 Special handling of the title occurs if
838 it is not affected by the format of
842 .BI EF\ \fR[\fParg\fR]\fP
844 printed just above the normal page footer on even pages.
850 This macro defines string
854 .BI EH\ \fR[\fParg\fR]\fP
856 printed just below the normal page header on even pages.
862 This macro defines string
872 End-of-page user-defined macro.
874 This macro is called instead of the normal printing of the footer.
876 The macro is executed in a separate environment,
877 without any trap active.
883 .B Strings available to EOP
888 EOPf@argument of \fBPF\fP
889 EOPef@argument of \fBEF\fP
890 EOPof@argument of \fBOF\fP
895 .BI EPIC\ "\fR[\fP\fB\-L\fP\fR]\fP width height \fR[\fPname\fR]\fP"
896 Draw a box with the given
901 It also prints the text
903 or a default string if
907 This is used to include external pictures;
908 just give the size of the picture.
911 left-adjusts the picture;
912 the default is to center.
918 .BI EQ\ \fR[\fPlabel\fR]\fP
922 are the delimiters for equations written for
923 .BR @g@eqn (@MAN1EXT@).
930 is used to set options for
936 argument appears at the right margin of the equation,
937 centered vertically within the
940 unless number register
944 Then the label appears at the left margin.
947 If there are multiple
949 blocks within a single
952 only the last equation label (if any) is printed.
955 .BI EX\ "\fR[\fPtitle \fR[\fPoverride \fR[\fPflag \fR[\fPrefname\fR]]]]\fP"
958 The arguments are the same as for
962 uses the number register
968 controls the title of the List of Exhibits;
969 default is \[oq]LIST OF EXHIBITS\[cq].
971 The List of Exhibits is only printed if number register
974 which is the default.
978 contains the word \[oq]Exhibit\[cq], which is printed before the
983 is used, the exhibit number is saved with
985 and can be retrieved with \[oq]\fB.GETST\fP \fIrefname\fP\[cq].
988 Special handling of the title occurs if
992 it is not affected by the format of
996 .BI FC\ \fR[\fPclosing\fR]\fP
997 Print \[oq]Yours\~very\~truly,\[cq] as a formal closing of a letter or
1000 The argument replaces the default string.
1002 The default is stored in string variable
1006 .BI FD\ \fR[\fParg\ \fR[\fP1\fR]]\fP
1007 Footnote default format.
1009 Controls the hyphenation (hyphen),
1010 right margin justification (adjust),
1011 and indentation of footnote text (indent).
1013 It can also change the label justification (ljust).
1021 arg@hyphen@adjust@indent@ljust
1038 An argument greater than or equal to 11 is considered as value\~0.
1041 .B m@TMAC_M_PREFIX@m
1049 .BI FG\ "\fR[\fPtitle \fR[\fPoverride \fR[\fPflag \fR[\fPrefname\fR]]]]\fP"
1052 The arguments are the same as for
1055 uses the number register
1061 controls the title of the List of Figures;
1062 default is \[oq]LIST OF FIGURES\[cq].
1064 The List of Figures is only printed if number register
1066 is\~1, which is the default.
1070 contains the word \[oq]Figure\[cq], which is printed before the
1075 is used, then the figure number is saved with
1077 and can be retrieved with \[oq]\fB.GETST\fP \fIrefname\fP\[cq].
1080 Special handling of the title occurs if
1084 it is not affected by the format of
1088 .BI FS\ \fR[\fPlabel\fR]\fP
1091 The footnote is ended by
1094 By default, footnotes are automatically numbered;
1095 the number is available in string\~\c
1104 it is possible to have other number or names on the footnotes.
1106 Footnotes in displays are now possible.
1108 An empty line separates footnotes;
1109 the height of the line is controlled by number register
1111 default value is\~1.
1114 .BI GETHN\ "refname \fR[\fPvarname\fR]\fP"
1115 Include the header number where the corresponding \[oq]\fBSETR\fP
1116 \fIrefname\fP\[cq] was placed.
1118 This is displayed as \[oq]X.X.X.\[cq] in pass\~1.
1127 sets the string variable
1129 to the header number.
1132 .BI GETPN\ "refname \fR[\fPvarname\fR]\fP"
1133 Include the page number where the corresponding \[oq]\fBSETR\fP
1134 \fIrefname\fP\[cq] was placed.
1136 This is displayed as \[oq]9999\[cq] in pass\~1.
1145 sets the stringvariable
1155 with the text \[oq]chapter\[cq] and \[oq],\~page\[cq].
1159 contains the text for the cross reference:
1163 \&.ds Qrf See chapter \[rs]\[rs]*[Qrfh], page \[rs]\[rs]*[Qrfp].
1168 may be changed to support other languages.
1176 and contain the page and header number, respectively.
1179 .BI GETST\ "refname \fR[\fPvarname\fR]\fP"
1180 Include the string saved with the second argument to
1183 This is a dummy string in pass\~1.
1189 sets it to the saved string.
1195 .BI H\ "level \fR[\fPheading-text \fR[\fPheading-suffix\fR]]\fP"
1196 Numbered section heading.
1198 Section headers can have a level between 1 and 14;
1199 level\~1 is the top level.
1201 The text is given in
1203 and must be surrounded by double quotes if it contains spaces.
1206 is added to the header in the text but not in the table of contents.
1208 This is normally used for footnote marks and similar things.
1213 .IR heading-suffix ,
1216 A manual label must be used, see
1219 A call to the paragraph macro\~\c
1226 care of spacing and indentation.
1229 .B Page ejection before heading
1235 controls page ejection before the heading.
1237 By default, a level-one heading gets two blank lines before it;
1238 higher levels only get one.
1240 A new page is ejected before each first-level heading if number
1245 All levels below or equal the value of
1255 .B Heading break level
1259 A line break occurs after the heading if the heading level is less
1260 or equal to number register
1263 Default value is\~2.
1267 .B Heading space level
1271 A blank line is inserted after the heading if the heading level is
1272 less or equal to number register
1275 Default value is\~2.
1278 Text follows the heading on the same line if the level is greater than
1286 .B Post-heading indent
1290 Indentation of the text after the heading is controlled by number
1294 Default value is\~0.
1301 0@The text is left-justified.
1303 Indentation of the text follows the value of number
1310 The text is lined up with the first word of the heading.
1316 .B Centered section headings
1320 All headings whose level is equal or below number register
1322 and also less than or equal to
1330 .B Font control of the heading
1334 The font of each heading level is controlled by string
1337 It contains a font number or font name for each level.
1343 .B 2 2 2 2 2 2 2 2 2 2 2 2 2 2
1347 (all headings in italic).
1349 This could also be written as
1353 .B I I I I I I I I I I I I I I
1357 Note that some other implementations use
1358 .B 3\~3\~2\~2\~2\~2\~2
1359 as the default value.
1361 All omitted values are presumed to have value\~1.
1365 .B Point size control
1371 controls the point size of each heading,
1376 A value of\~0 selects the default point size.
1382 .B 0 0 0 0 0 0 0 0 0 0 0 0 0 0
1386 Beware that only the point size changes, not the vertical size.
1388 The latter can be controlled by the user-specified macros
1399 Fourteen number registers named
1403 contain the counter for each heading level.
1405 The values are printed using Arabic numerals;
1406 this can be changed with the macro
1410 All marks are concatenated before printing.
1417 This only prints the current heading counter at each heading.
1421 .B Automatic table of contents
1425 All headings whose level is equal or below number register
1427 are saved to be printed in the table of contents.
1429 Default value is\~2.
1433 .B Special control of the heading, user-defined macros
1437 The following macros can be defined by the user to get a finer control
1438 of vertical spacing, fonts, or other features.
1442 is the level-argument to\~\c
1444 but\~0 for unnumbered headings (see
1450 it is set to number register
1452 for unnumbered headings.
1456 is the text argument to
1463 .BI HX\ "level rlevel heading-text"
1464 This macro is called just before the printing of the heading.
1466 The following registers are available for
1480 Contains the heading mark plus two spaces if
1487 Contains the position of the text after the heading.
1489 0\~means that the text should follow the heading on the same line,
1490 1\~means that a line break should occur before the text,
1491 and 2\~means that a blank line should separate the heading and the text.
1495 Contains two spaces if register
1499 It is used to separate the heading from the text.
1501 The string is empty if
1507 Contains the needed space in units after the heading.
1511 Can be used to change things like numbering
1515 and the needed space after the heading.
1519 .BI HY\ "dlevel rlevel heading-text"
1520 This macro is called after size and font calculations and
1521 might be used to change indentation.
1524 .BI HZ\ "dlevel rlevel heading-text"
1525 This macro is called after the printing of the heading,
1532 Can be used to change the page header according to the section heading.
1537 .BI HC\ \fR[\fPhyphenation-character\fR]\fP
1538 Set hyphenation character.
1540 Default value is \[oq]\[rs]%\[cq].
1542 Resets to the default if called without argument.
1544 Hyphenation can be turned off by setting number register
1546 to\~0 at the beginning of the file.
1549 .BI HM\ "\fR[\fParg1 \fR[\fParg2 \fR[.\|.\|.\& [\fParg14\fR]]]]\fP"
1552 Controls the type of marking for printing of the heading counters.
1554 Default is\~1 for all levels.
1563 0001@Arabic numerals with leading zeroes, one or more.
1564 A@upper-case alphabetic
1565 a@lower-case alphabetic
1566 I@upper-case roman numerals
1567 i@lower-case roman numerals
1568 \[dq]\[dq]@Arabic numerals.
1572 .BI HU\ heading-text
1573 Unnumbered section header.
1578 at the level in number register
1585 .BI HX\ "dlevel rlevel heading-text"
1586 User-defined heading exit.
1588 Called just before printing the header.
1594 .BI HY\ "dlevel rlevel heading-text"
1595 User-defined heading exit.
1597 Called just before printing the header.
1603 .BI HZ\ "dlevel rlevel heading-text"
1604 User-defined heading exit.
1606 Called just after printing the header.
1612 .BI I\ "\fR[\fPitalic-text \fR[\fPprev-font-text \fR[\fPitalic-text \fR[.\|.\|.]]]]\fP"
1615 Changes the font to italic if called without arguments.
1617 With one argument it sets the word in italic.
1619 With two arguments it concatenates them and sets the first
1620 word in italic and the second in the previous font.
1622 There is no limit on the number of argument;
1623 all are concatenated.
1626 .BI IA\ "\fR[\fPaddressee-name \fR[\fPtitle\fR]]\fP"
1627 Begin specification of the addressee and addressee's address in
1630 Several names can be specified with empty
1632 but only one address.
1638 .BI IB\ "\fR[\fPitalic-text \fR[\fPbold-text \fR[\fPitalic-text \fR[.\|.\|.]]]]\fP"
1641 Even arguments are printed in italic, odd in boldface.
1648 End the address specification after
1652 .BI INITI\ "type filename \fR[\fPmacro\fR]\fP"
1653 Initialize the new index system and set the filename to collect index
1659 selects the type of index: page number, header marks or both.
1661 The default is page numbers.
1664 It is also possible to create a macro that is responsible
1665 for formatting each row;
1666 just add the name of the macro as a third argument.
1668 The macro is then called with the index as argument(s).
1680 Both page numbers and header marks,
1681 separated with a tab character.
1687 Initialize the cross reference macros.
1689 Cross references are written to stderr and are supposed to be
1690 redirected into file
1693 Requires two passes with groff;
1694 this is handled by a separate program called
1695 .BR mmroff (@MAN1EXT@).
1697 This program exists because
1698 .BR groff (@MAN1EXT@)
1699 by default deactivates the unsafe operations that are required by
1702 The first pass looks for cross references,
1703 and the second one includes them.
1706 can be used several times,
1707 but it is only the first occurrence of
1719 .BI IND\ "arg1 \fR[\fParg2 \fR[.\|.\|.]]\fP"
1720 Write a line in the index file selected by
1722 with all arguments and the page number or header mark separated by tabs.
1729 arg1\[rs]tpage number
1731 arg1\[rs]targ2\[rs]tpage number
1733 arg1\[rs]theader mark
1735 arg1\[rs]tpage number\[rs]theader mark
1740 Print the index by running the command specified by string variable
1742 which has \[oq]sort\ \-t\[rs]t\[cq] as the default value.
1745 reads the output from the command to form the index,
1746 by default in two columns (this can be changed by defining
1749 The index is printed with string variable
1752 default is \[oq]INDEX\[cq].
1754 One-column processing is reactivated after the list.
1757 calls the user-defined macros
1765 is called before printing the string \[oq]INDEX\[cq],
1767 is called instead of printing \[oq]INDEX\[cq], and
1769 is called after the printing and should take care of restoring to
1770 normal operation again.
1773 .B ISODATE \fR[\fP0\fR]\fP
1774 Change the predefined date string in
1776 to ISO-format, this is, \[oq]YYYY-MM-DD\[cq].
1778 This can also be done by adding
1780 on the command line.
1782 Reverts to old date format if argument is\~\c
1786 .BI IR\ "\fR[\fPitalic-text \fR[\fProman-text \fR[\fPitalic-text \fR[.\|.\|.]]]]\fP"
1789 Even arguments are printed in italic, odd in roman.
1795 .BI LB\ "text-indent mark-indent pad type \fR[\fPmark \fR[\fPLI-space \fR[\fPLB-space\fR]]]\fP"
1798 This is the common macro used for all lists.
1801 is the number of spaces to indent the text from the current indentation.
1807 control where to put the mark.
1809 The mark is placed within the mark area, and
1811 sets the number of spaces before this area.
1813 By default it is\~0.
1815 The mark area ends where the text begins.
1817 The start of the text is still controlled by
1821 The mark is left-justified within the mark area if
1830 and the mark is placed
1832 spaces before the text.
1834 This right-justifies the mark.
1839 is\~0 the list either has a hanging indentation or,
1850 is greater than\~0 automatic numbering occurs,
1851 using arabic numbers if
1856 can then be any of \[oq]1\[cq], \[oq]A\[cq], \[oq]a\[cq], \[oq]I\[cq],
1861 selects one of six possible ways to display the mark.
1882 Every item in the list gets
1884 number of blank lines before them.
1897 .BI LC\ \fR[\fPlist-level\fR]\fP
1900 Terminates all current active lists down to
1902 or\~0 if no argument is given.
1906 to clear any active list.
1909 .B LE \fR[\fP1\fR]\fP
1912 Terminates the current list.
1914 outputs a blank line if an argument is given.
1917 .BI LI\ \fR[\fPmark\ \fR[\fP1\fR|\fP2\fR]]\fP
1918 List item preceding every item in a list.
1922 prints the mark determined by the current list type.
1926 one argument, it uses that as the mark instead.
1932 a prefix to the current mark.
1934 There is no separating space between the prefix and the mark if the
1935 second argument is \[oq]2\[cq] instead of \[oq]1\[cq].
1937 This behaviour can also be achieved by setting number register
1943 makes a hanging indentation instead.
1946 A blank line is printed before the list item by default.
1948 This behaviour can be controlled by number register
1951 Pre-spacing occurs for each list level less than or equal to
1954 Default value is 99.
1956 There is no nesting limit.
1959 The indentation can be changed through number register
1964 All lists begin with a list initialization macro,
1967 There are, however, seven predefined list types to make lists easier
1972 with different default values.
1979 \fBAL\fP@Automatically Incremented List
1980 \fBML\fP@Marked List
1981 \fBVL\fP@Variable-Item List
1982 \fBBL\fP@Bullet List
1984 \fBRL\fP@Reference List
1985 \fBBVL\fP@Broken Variable List.
1990 These lists are described at other places in this manual.
1996 .BI LT\ \fR[\fIarg\/\fR]\fI
1997 Format a letter in one of four different styles depending
2000 Also see section \[lq]Internals\[rq] below.
2011 Date line, return address, writer's address and closing
2012 begins at the center of the line.
2014 All other lines begin at the left margin.
2019 except that the first line in every paragraph is indented five spaces.
2023 All lines begin at the left margin.
2027 Almost the same as the full-blocked style.
2028 Subject and the writer's identification are printed in all-capital.
2034 .BI LO\ "type \fR[\fParg\fR]\fP"
2035 Specify options in letter (see
2038 This is a list of the standard options:
2046 Confidential notation.
2047 Prints \[oq]CONFIDENTIAL\[cq] on the second line below the date line.
2049 Any argument replaces \[oq]CONFIDENTIAL\[cq].
2051 See also string variable
2056 Prints \[oq]In reference to:\[cq] and the argument two lines below the date line.
2057 See also string variable
2062 Prints \[oq]ATTENTION:\[cq] and the argument below the inside address.
2063 See also string variable
2068 Prints \[cq]To Whom It May Concern:\[cq] or the argument if it was present.
2069 The salutation is printed two lines below the inside address.
2070 See also string variable
2075 Prints the argument as subject prefixed with \[oq]SUBJECT:\[cq]
2076 two lines below the inside address,
2077 except in letter type \[oq]SP\[cq],
2078 where the subject is printed in all-capital without any prefix.
2079 See also string variable
2086 .BI MC\ "column-size \fR[\fPcolumn-separation\fR]\fP"
2087 Begin multiple columns.
2089 Return to normal with
2093 creates as many columns as the current line length permits.
2096 is the width of each column,
2098 .I column-separation
2099 is the space between two columns.
2101 Default separation is
2102 .IR column-size /15.
2108 .BI ML\ "mark \fR[\fPtext-indent\ " \fR[\fP1\fR]]\fP
2113 argument is printed before each list item.
2116 sets the indent and overrides
2119 A third argument prohibits printing of a blank line before each item.
2122 .BI MT\ "\fR[\fParg \fR[\fPaddressee\fR]]\fP"
2127 is part of a filename in
2128 .IR @TMAC_MDIR@/ * .MT .
2130 Memorandum types 0 to\~5 are supported, including type
2131 \[oq]string\[cq] (which gets internally mapped to type\~6).
2134 just sets a variable, used in the AT&T macros.
2144 0@Normal memorandum, no type printed.
2145 1@Memorandum with \[oq]MEMORANDUM FOR FILE\[cq] printed.
2146 2@Memorandum with \[oq]PROGRAMMER'S NOTES\[cq] printed.
2147 3@Memorandum with \[oq]ENGINEER'S NOTES\[cq] printed.
2148 4@Released paper style.
2149 5@External letter style.
2155 .BR COVER / COVEND ,
2156 a more flexible type of front page.
2159 .BI MOVE\ "y-pos \fR[\fPx-pos \fR[\fPline-length\fR]]\fP"
2160 Move to a position, setting page offset to
2165 is not given, the difference between current and new page offset is
2170 without arguments to return to normal.
2173 .BI MULB\ "cw1 space1 \fR[\fPcw2 space2 \fR[\fPcw3 \fR.\|.\|.]]\fP"
2174 Begin a special multi-column mode.
2176 All columns widths must be specified.
2178 The space between the columns must be specified also.
2180 The last column does not need any space definition.
2183 starts a diversion, and
2185 ends the diversion and prints the columns.
2187 The unit for the width and space arguments is \[oq]n\[cq], but
2189 accepts all normal unit specifications like \[oq]c\[cq] and \[oq]i\[cq].
2192 operates in a separate environment.
2196 Begin the next column.
2198 This is the only way to switch the column.
2202 End the multi-column mode and print the columns.
2205 .BI nP\ \fR[\fPtype\fR]\fP
2206 Print numbered paragraph with header level two.
2213 Force printing to the next column.
2215 Don't use this together with the
2221 .BI NS\ \fR[\fParg\ \fR[\fP1\fR]]\fP
2222 Print different types of notations.
2224 The argument selects between the predefined type of notations.
2226 If the second argument is available,
2227 then the argument becomes the entire notation.
2229 If the argument doesn't select a predefined type,
2230 it is printed as \[oq]Copy (\fIarg\/\fP) to\[cq].
2232 It is possible to add more standard notations,
2233 see the string variables
2244 \fInone\/\fP@Copy To
2246 1@Copy To (with att.\&) to
2247 2@Copy To (without att.\&) to
2252 7@Under separate cover
2255 10@Copy (with atts.\&) to
2256 11@Copy (without atts.\&) to
2258 13@Complete Memorandum to
2267 Overrides the current date.
2269 Date is not printed if
2274 .BI OF\ \fR[\fParg\fR]\fP
2275 Odd-page footer, a line printed just above the normal footer.
2283 This macro defines string
2287 .BI OH\ \fR[\fParg\fR]\fP
2288 Odd-page header, a line printed just below the normal header.
2296 This macro defines string
2301 Make sure that the following text is printed at the top of an
2304 Does not output an empty page if currently at the top of an odd page.
2307 .BI P\ \fR[\fPtype\fR]\fP
2308 Begin new paragraph.
2311 argument produces left\-justified text,
2312 even the first line of the paragraph.
2314 This is the same as setting
2318 If the argument is\~1,
2319 the first line of text following\~\c
2321 is indented by the number of spaces in number register
2326 Instead of giving an argument to\~\c
2328 it is possible to set the paragraph type in number register
2331 Using 0 and\~1 is the same as adding that value to
2334 A value of\~2 indents all paragraphs, except after headings, lists,
2335 and displays (this value can't be used as an argument to
2340 The space between two paragraphs is controlled by number register
2342 and is\~1 by default (one blank line).
2345 .BI PGFORM\ "\fR[\fPlinelength \fR[\fPpagelength \fR[\fPpageoffset\ " \fR[\fP1\fR]]]]\fP
2346 Set line length, page length, and/or page offset.
2348 This macro can be used for special formatting,
2349 like letter heads and other.
2351 It is normally the first command in a file,
2352 though it is not necessary.
2355 can be used without arguments to reset everything after a
2359 A line break is done unless the fourth argument is given.
2361 This can be used to avoid the page number on the first page
2362 while setting new width and length.
2364 (It seems as if this macro sometimes doesn't work too well.
2366 Use the command-line arguments to change
2367 line length, page length, and page offset instead.)
2371 No header is printed on the next page.
2373 Used to get rid of the header in letters or other special texts.
2375 This macro must be used before any text to inhibit the page header
2379 .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"
2380 Include a PostScript file in the document.
2382 The macro depends on
2383 .BR mmroff (@MAN1EXT@)
2393 adjust the picture or indent it.
2395 With no flag the picture is adjusted to the left.
2399 draws a box around the picture.
2405 can also be given to resize the picture.
2412 .BR @g@pic (@MAN1EXT@).
2415 .BI PF\ \fR[\fParg\fR]\fP
2418 sets the line to be printed at the bottom of each page.
2424 for the argument specification.
2427 This macro defines string
2431 .BI PH\ \fR[\fParg\fR]\fP
2432 Page header, a line printed at the top of each page.
2434 The argument should be specified as
2438 .RI \[dq]' left-part ' center-part ' right-part '\[dq]
2447 are printed left-justified, centered, and right justified, respectively.
2449 Within the argument to
2451 the character \[oq]%\[cq] is changed to the current page number.
2453 The default argument is
2461 which gives the page number between two dashes.
2464 This macro defines string
2469 Picture start (from pic).
2471 Begins a picture for
2472 .BR @g@pic (@MAN1EXT@).
2476 Page header user-defined exit.
2478 This macro is called just after the printing of the page header in
2486 Return to roman font, see also\~\c
2490 .BI RB\ "\fR[\fProman-text \fR[\fPbold-text \fR[\fProman-text \fR[.\|.\|.]]]]\fP"
2493 Even arguments are printed in roman, odd in boldface.
2499 .BI RD\ "\fR[\fPprompt \fR[\fPdiversion \fR[\fPstring\fR]]]\fP"
2500 Read from standard input to diversion and/or string.
2502 The text is saved in a diversion named
2505 Recall the text by writing the name of the diversion after a dot
2508 A string is also defined if
2515 can be empty (\[dq]\[dq]).
2521 Ends a reference definition and returns to normal processing.
2527 .BI RI\ "\fR[\fProman-text \fR[\fPitalic-text \fR[\fProman-text \fR[.\|.\|.]]]]\fP"
2528 Print even arguments in roman, odd in italic.
2534 .BI RL\ \fR[\fPtext-indent \fR[\fP1\fR]]\fP
2535 Reference list start.
2537 Begins a list where each item is preceded with an automatically
2538 incremented number between square brackets.
2541 changes the default indentation.
2544 .BI RP\ "\fR[\fParg1 \fR[\fParg2\fR]]\fP"
2545 Produce reference page.
2547 This macro can be used if a reference page is wanted somewhere in the
2552 is used to produce a table of contents.
2554 The reference page is then printed automatically.
2557 The reference counter is not reset if
2565 whether to eject a page or not.
2575 0@The reference page is printed on a separate page.
2576 1@Do not eject page after the list.
2577 2@Do not eject page before the list.
2578 3@Do not eject page before and after the list.
2583 The reference items are separated by a blank line.
2585 Setting number register
2587 to\~0 suppresses the line.
2592 contains the reference page title and is set to \[oq]REFERENCES\[cq]
2597 holds the default value for the second argument of
2599 it is initially set to\~0.
2602 .BI RS\ \fR[\fPstring-name\fR]\fP
2603 Begin an automatically numbered reference definition.
2607 where the reference mark should be and write the reference between
2609 at next new line after the reference mark.
2611 The reference number is stored in number register
2616 is given, a string with that name is defined and contains the current
2619 The string can be referenced as
2620 .BI \[rs]*[ string-name ]
2624 .BI S\ "\fR[\fPsize \fR[\fPspacing\fR]]\fP"
2625 Set point size and vertical spacing.
2627 If any argument is equal to \[oq]P\[cq], the previous value is used.
2629 A \[oq]C\[cq] means current value, and \[oq]D\[cq] the default value.
2631 If \[oq]+\[cq] or \[oq]\-\[cq] is used before the value,
2632 the current value is incremented or decremented, respectively.
2635 .BI SA\ \fR[\fParg\fR]\fP
2636 Set right-margin justification.
2638 Justification is turned on by default.
2640 No argument or value \[oq]0\[cq] turns off justification,
2641 and \[oq]1\[cq] turns on justification.
2644 .BI SETR\ "refname \fR[\fPstring\fR]\fP"
2645 Remember the current header and page number as
2662 .BI SG\ \fR[\fParg\ \fR[\fP1\fR]]\fP
2665 Prints the authors name(s) after the formal closing.
2667 The argument is appended to the reference data, printed at either the
2668 first or last author.
2670 The reference data is the location, department, and initials specified
2674 It is printed at the first author if the second argument is given,
2675 otherwise at the last.
2677 No reference data is printed if the author(s) is specified through
2680 See section \[lq]Internals\[rq] below.
2683 .BI SK\ \fR[\fPpages\fR]\fP
2688 is\~0 or omitted, a skip to the next page occurs unless it is already
2689 at the top of a page.
2696 .BI SM\ "string1 \fR[\fPstring2 \fR[\fPstring3\fR]]\fP"
2697 Make a string smaller.
2705 stays at normal size,
2709 With three arguments, everything is concatenated, but only
2714 .BI SP\ \fR[\fPlines\fR]\fP
2718 can have any scaling factor, like \[oq]3i\[cq] or \[oq]8v\[cq].
2722 calls in a line only produces the maximum number of lines, not the sum.
2725 is ignored also until the first text line in a page.
2735 Reset tabs to every\ 5n.
2737 Normally used to reset any previous tab positions.
2740 .BI TB\ "\fR[\fPtitle \fR[\fPoverride \fR[\fPflag \fR[\fPrefname\fR]]]]\fP"
2743 The arguments are the same as for
2747 uses the number register
2753 controls the title of the List of Tables;
2754 default value is \[oq]LIST OF TABLES\[cq].
2756 The List of Tables is only printed if number register
2758 is\~1, which is the default.
2762 contains the word \[oq]TABLE\[cq], which is printed before the number.
2765 Special handling of the title occurs if
2769 it is not affected by the format of
2773 .BI TC\ "\fR[\fPslevel \fR[\fPspacing \fR[\fPtlevel \fR[\fPtab \fR[\fPh1 \fR[\fPh2 \fR[\fPh3 \fR[\fPh4 \fR[\fPh5\fR]]]]]]]]]\fP"
2776 This macro is normally used as the last line of the document.
2778 It generates a table of contents with headings up to the level
2779 controlled by number register
2784 controls the saving of headings, it has nothing to do with
2787 Headings with a level less than or equal to
2791 number of lines before them.
2793 Headings with a level less than or equal to
2795 have their page numbers right\-justified with dots or spaces separating
2796 the text and the page number.
2800 is greater than zero, dots otherwise.
2802 Other headings have the page number directly at the end of the heading
2804 .RI ( ragged-right ).
2807 The rest of the arguments is printed, centered, before the table of
2811 The user-defined macros
2817 is called with at most four arguments.
2820 is called before the printing of the string \[oq]CONTENTS\[cq],
2823 is called instead of printing \[oq]CONTENTS\[cq].
2826 Equivalent macros can be defined for list of figures, tables, equations
2827 and exhibits by defining
2833 is \[oq]Fg\[cq], \[oq]TB\[cq], \[oq]EC\[cq], or \[oq]EX\[cq],
2839 can be set to control the indentations for each heading-level.
2841 It must be scaled, like
2845 \&.ds Ci .25i .5i .75i 1i 1i
2849 By default, the indentation is controlled by the maximum length of
2850 headings in each level.
2853 The string variables
2860 contain \[oq]Figure\[cq], \[oq]TABLE\[cq], \[oq]Exhibit\[cq],
2861 \[oq]Equation\[cq], and \[oq]CONTENTS\[cq], respectively.
2863 These can be redefined to other languages.
2873 .B TH \fR[\fPN\fR]\fP
2880 ends the header of the table.
2882 This header is printed again if a page break occurs.
2884 Argument \[oq]N\[cq] isn't implemented yet.
2887 .BI TL\ "\fR[\fPcharging-case-number \fR[\fPfiling-case-number\fR]]\fP"
2888 Begin title of memorandum.
2890 All text up to the next
2892 is included in the title.
2894 .I charging-case-number
2896 .I filing-case-number
2897 are saved for use in the front page processing.
2900 .BI TM\ "\fR[\fPnum1 \fR[\fPnum2 \fR[.\|.\|.]]]\fP"
2901 Technical memorandum numbers used in
2904 An unlimited number of arguments may be given.
2908 Top-of-page user-defined macro.
2910 This macro is called instead of the normal page header.
2912 It is possible to get complete control over the header.
2914 Note that the header and the footer are printed in a separate environment.
2916 Line length is preserved, though.
2922 .B strings available to TP
2927 TPh@argument of \fBPH\fP
2928 TPeh@argument of \fBEH\fP
2929 TPoh@argument of \fBOH\fP
2934 .B TS \fR[\fPH\fR]\fP
2937 This is the start of a table specification to
2938 .BR @g@tbl (@MAN1EXT@).
2944 Argument \[oq]H\[cq] tells
2945 .B m@TMAC_M_PREFIX@m
2946 that the table has a header.
2953 User-defined table of contents exit.
2955 This macro is called just before
2957 prints the word \[oq]CONTENTS\[cq].
2964 User-defined table of contents exit.
2966 This macro is called instead of printing \[oq]CONTENTS\[cq].
2972 .BI VERBON\ "\fR[\fPflag \fR[\fPpoint-size \fR[\fPfont\fR]]]\fP"
2973 Begin verbatim output using Courier font.
2975 Usually for printing programs.
2977 All characters have equal width.
2979 The point size can be changed with the second argument.
2981 By specifying a third argument it is possible to use another font
2985 controls several special features.
2987 Its value is the sum of all wanted features.
2997 Disable the escape character (\[rs]).
2998 This is normally turned on during verbose output.
3000 2@Add an empty line before the verbose text.
3001 4@Add an empty line after the verbose text.
3003 Print the verbose text with numbered lines.
3004 This adds four digit-sized spaces in the beginning of each line.
3005 Finer control is available with the string variable
3007 It contains all arguments to the
3008 .BR troff (@MAN1EXT@)
3011 normally \[oq]1\[cq].
3014 Indent the verbose text by \[oq]5n\[cq].
3016 This is controlled by the number-variable
3025 End verbatim output.
3028 .BI VL\ "text-indent \fR[\fPmark-indent\ " \fR[\fP1\fR]]\fP
3031 It has no fixed mark, it assumes that every
3036 sets the indent to the text, and
3038 the distance from the current indentation to the mark.
3040 A third argument prohibits printing of a blank line before each item.
3043 .BI "VM \fR[\fP\-T\fR] [\fP" "top \fR[\fPbottom\fR]]\fP"
3046 Increase the top and bottom margin by
3054 is specified, set those margins to
3059 If no argument is given, reset the margin to zero, or to the default
3060 (\[oq]7v 5v\[cq]) if
3064 It is highly recommended that macros
3068 are defined if using
3070 and setting top and/or bottom margin to less than the default.
3073 .BI WA\ "\fR[\fPwriter-name \fR[\fPtitle\fR]]\fP"
3074 Begin specification of the writer and writer's address.
3076 Several names can be specified with empty
3078 pairs, but only one address.
3082 End the address specification after
3086 .BI WC\ "\fR[\fPformat1\fR] [\fPformat2\fR] [.\|.\|.]\fP"
3087 Footnote and display width control.
3094 Set default mode which is equal to using the options
3102 Wide footnotes, wide also in two-column mode.
3104 -WF@Normal footnote width, follow column mode.
3106 All footnotes gets the same width as the first footnote encountered.
3109 Normal footnotes, width follows \fBWF\fP and \fB-WF\fP.
3112 Wide displays, wide also in two-column mode.
3115 Normal display width, follow column mode.
3118 Floating displays generates a line break when printed on the current
3122 Floating displays does not generate line break.
3128 .\" ====================================================================
3129 .SS "Strings used in m@TMAC_M_PREFIX@m"
3130 .\" ====================================================================
3134 A string containing the word \[oq]APPENDIX\[cq].
3138 The current appendix text.
3150 to the current heading text.
3152 Also updated in table of contents & friends.
3156 Font list for headings, \[oq]2 2 2 2 2 2 2\[cq] by default.
3158 Non-numeric font names may also be used.
3162 Point size list for headings.
3164 By default, this is \[cq]0 0 0 0 0 0 0\[cq] which is the same as \[oq]10
3165 10 10 10 10 10 10\[cq].
3169 Contains the string \[oq]INDEX\[cq].
3173 Contains the index command.
3175 Default value is \[oq]sort\ \-t\[rs]t\[cq].
3179 String containing \[oq]Figure\[cq].
3183 String containing \[oq]TABLE\[cq].
3187 String containing \[oq]Exhibit\[cq].
3191 String containing \[oq]Equation\[cq].
3195 String containing \[oq]CONTENTS\[cq].
3199 Contains the string \[oq]LIST OF FIGURES\[cq].
3203 Contains the string \[oq]LIST OF TABLES\[cq].
3207 Contains the string \[oq]LIST OF EXHIBITS\[cq].
3211 Contains the string \[oq]LIST OF EQUATIONS\[cq].
3215 Contains the string \[oq]Yours very truly,\[cq],
3221 Contains the string \[oq]APPROVED:\[cq],
3227 Contains the string \[oq]Date\[cq],
3233 Contains the string \[oq]CONFIDENTIAL\[cq],
3239 Contains the string \[oq]To Whom It May Concern:\[cq],
3245 Contains the string \[oq]ATTENTION:\[cq],
3251 Contains the string \[oq]SUBJECT:\[cq],
3257 Contains the string \[oq]In reference to:\[cq],
3263 is an array containing the different strings used in
3266 It is really a number of string variables prefixed with
3269 If the argument doesn't exist, it is included between
3277 Observe the space after \[oq]Copy\[cq] and before \[oq]to\[cq].
3287 Letns!1@Copy (with att.\&) to
3288 Letns!2@Copy (without att.\&) to
3293 Letns!7@Under separate cover
3295 Letns!9@Memorandum to
3296 Letns!10@Copy (with atts.\&) to
3297 Letns!11@Copy (without atts.\&) to
3298 Letns!12@Abstract Only to
3299 Letns!13@Complete Memorandum to
3301 Letns!copy@Copy \fI(with trailing space)\fP
3302 Letns!to@ to \fI(note leading space)\fP
3308 Define the standard notation used when no argument is given to
3315 Strings containing the month names \[oq]January\[cq] through
3320 String containing \[oq]See chapter \[rs]\[rs]*[Qrfh], page
3321 \[rs]\[rs]n[Qrfp].\[cq].
3325 Contains the string \[oq]REFERENCES\[cq].
3329 Contains the current status of the table of contents and list of
3335 Useful in user-defined macros like
3345 co@Table of contents
3348 ec@List of equations
3356 Contains the string \[oq]\[rs](tm\[cq], the trade mark symbol.
3369 .\" ====================================================================
3370 .SS "Number variables used in m@TMAC_M_PREFIX@m"
3371 .\" ====================================================================
3375 Print an appendix page for every new appendix if this number variable
3380 is zero, but there is always an appendix entry in the \[oq]List of
3385 Contents level (in the range 0 to 14).
3387 The contents is saved if a heading level is lower than or equal to the
3395 Eject page between list of table, list of figure, etc., if the value of
3405 Values greater than zero produce debug information of increasing
3408 A value of\~1 gives information about the progress of formatting.
3414 If set to\~1, eject after floating display is output.
3420 If defined, it controls the space output before and after static
3423 Otherwise the value of
3429 Control floating keep output.
3431 This is a number in the range 0 to 5, with a default value of\~5.
3438 If set to\~1, use the amount of space stored in register
3440 before and after display.
3446 If set to\~1, eject page before each first-level heading.
3452 Equation labels are left-adjusted if set to\~0 and right-adjusted if
3469 Append a dot after the level-one heading number if value is greater
3476 A copy of number register
3478 but it is incremented just before the page break.
3480 Useful in user-defined header macros.
3484 Heading break level.
3486 A number in the range 0 to 14, with a default value of\~2.
3493 Heading centering level.
3495 A number in the range 0 to 14, with a default value value of\~0.
3502 Heading temporary indent.
3504 A number in the range 0 to 2, with a default value of\~1.
3511 0@no indentation, left margin
3513 indent to the right, similar to
3514 .RB \[oq] ".P 1" \[cq]
3517 indent to line up with text part of preceding heading
3524 Heading pre-space level.
3526 If the heading level is less than or equal to
3528 two lines precede the section heading instead of one.
3530 Default is first level only.
3532 The real amount of lines is controlled by the variables
3539 Number of lines preceding
3541 if the heading level is greater than
3544 Value is in units, default is 0.5.
3548 Number of lines preceding
3550 if the heading level is less than or equal to
3553 Value is in units, default is\~1.
3557 Heading space level.
3559 A number in the range 0 to 14, with a default value of\~2.
3566 Number of lines following
3568 if the heading level is less than or equal to
3571 Value is in units, default is\~1.
3575 Heading numbering type.
3582 0@multiple levels (1.1.1, 1.1.2, etc.)
3591 Unnumbered heading level.
3597 Hyphenation status of text body.
3605 1@hyphenation on, set to value\~6
3614 Set this variable to\~1 on the command line to get an ISO-formatted
3615 date string (\fB\-rIso=1\fP).
3617 Useless inside of a document.
3621 Page length, only for command-line settings.
3625 Maximum lines in return-address, used in
3631 .BR Lf ,\ Lt ,\ Lx ,\ Le
3632 Enable (1) or disable (0) the printing of List of figures,
3634 List of tables, List of exhibits and List of equations, respectively.
3636 Default values are Lf=1, Lt=1, Lx=1, and Le=0.
3640 List indentation, used by
3647 A flag controlling the insertion of space between prefix and mark in
3663 List space threshold.
3665 If current list level is greater than
3667 no spacing occurs around lists.
3673 The vertical space used by an empty line.
3675 The default is 0.5v in troff mode and 1v in nroff mode.
3679 Page numbering style.
3686 0@normal header for all pages.
3688 header replaces footer on first page, header is empty.
3690 2@page header is removed on the first page.
3691 3@\[oq]section-page\[cq] numbering style enabled.
3692 4@page header is removed on the first page.
3694 \[oq]section-page\[cq] and \[oq]section-figure\[cq] numbering style enabled.
3702 See also the number registers
3709 A flag to control whether paragraphs are numbered.
3717 1@numbered in first-level headings.
3726 Page offset, only for command-line settings.
3730 Format of figure, table, exhibit, and equation titles.
3747 Current page-number, normally the same as \[oq]%\[cq] unless
3748 \[oq]section-page\[cq] numbering style is enabled.
3752 Paragraph indentation.
3758 A flag to control whether header and footer point size should follow
3759 the current settings or just change when the header and footer are
3768 Point size only changes to the current setting when
3779 Point size changes after every
3781 This is the default.
3801 1@indented paragraphs
3803 indented paragraphs except after
3817 Set default value for second argument of
3824 A flag controlling \[oq]section-figures\[cq] numbering style.
3826 A non-zero value enables this.
3828 See also register\~\c
3833 A flag controlling \[cq]section-page\[cq] numbering style.
3835 A non-zero value enables this.
3837 See also register\~\c
3842 Display indentation.
3855 Line length, only for command-line settings.
3862 .\" ====================================================================
3864 .\" ====================================================================
3866 The letter macros are using different submacros depending on the
3869 The name of the submacro has the letter type as suffix.
3871 It is therefore possible to define other letter types, either in the
3872 national macro-file, or as local additions.
3875 sets the number variables
3879 to 0 and\~5, respectively.
3881 The following strings and macros must be defined for a new letter type.
3885 This macro is called directly by
3888 It is supposed to initialize variables and other stuff.
3892 This macro prints the letter head,
3893 and is called instead of the normal page header.
3895 It is supposed to remove the alias
3897 otherwise it is called for all pages.
3900 .BI let@sg_ "type name title n flag \fR[\fParg1 \fR[\fParg2 \fR[.\|.\|.]]]\fP"
3902 is calling this macro only for letters;
3903 memorandums have its own processing.
3908 are specified through
3912 the counter, 1-max, and
3914 is true for the last name.
3916 Any other argument to
3921 .BI let@fc_ "type closing"
3922 This macro is called by
3924 and has the formal closing as the argument.
3929 is implemented as a general option-macro.
3931 It demands that a string named
3938 then assigns the argument to the string variable
3939 .BI let*lo- type\fR.\fP
3942 .\" ====================================================================
3944 .\" ====================================================================
3947 .\" ====================================================================
3949 .\" ====================================================================
3952 .I @MACRODIR@/@TMAC_M_PREFIX@m.tmac
3954 .IR @TMAC_MDIR@/ * .cov
3956 .IR @TMAC_MDIR@/ * .MT
3958 .I @TMAC_MDIR@/locale
3961 .\" ====================================================================
3963 .\" ====================================================================
3964 The GNU version of the
3966 macro package was written by
3974 .\" ====================================================================
3976 .\" ====================================================================
3978 .BR groff (@MAN1EXT@),
3979 .BR @g@troff (@MAN1EXT@),
3980 .BR @g@tbl (@MAN1EXT@),
3981 .BR @g@pic (@MAN1EXT@),
3982 .BR @g@eqn (@MAN1EXT@)
3984 .BR groff_mmse (@MAN7EXT@)
3987 .\" Restore compatibility mode (for, e.g., Solaris 10/11).
3991 .\" Local Variables:
3995 .\" vim:set filetype=groff: