2 .\" $Id: groff_mm.man,v 2.8 2002/05/30 05:39:54 jhaegg Exp $
16 .TH GROFF_MM @MAN7EXT@ "@MDATE@" "Groff Version @VERSION@"
18 groff_mm \- groff mm macros
21 .B \-m@TMAC_M_PREFIX@m
29 The groff mm macros are intended to be compatible with the DWB mm macros
30 with the following limitations:
33 no Bell Labs localisms implemented.
36 the macros OK and PM are not implemented.
39 groff mm does not support cut marks
41 \fBm@TMAC_M_PREFIX@m\fP is intended to be international.
43 possible to write short national macrofiles which change all
44 english text to the preferred language.
45 Use \fBm@TMAC_M_PREFIX@mse\fP as an example.
46 .\"########################################################################
48 A file called \fBlocale\fP or \fIlang\fP\fB_locale\fP is read
49 after the initiation of the global variables.
51 possible to localize the macros with companyname and so on.
53 In this manual square brackets is used to show optional arguments.
55 \fBNumber registers and strings\fP
57 Many macros can be controlled by number registers and strings.
58 A number register is assigned with the \fBnr\fP command:
60 \fB\&.nr\fP \fIXXX\fP \fI[+-]n [i]\fP
62 \fBXXX\fP is the name of the register, \fBn\fP is the value to
63 be assigned, and \fBi\fP is increment value for auto-increment.
64 \fBn\fP can have a plus or minus sign as prefix if an increment
65 or decrement of the current value is wanted.
66 (Auto-increment or decrement
67 occurs if the number register is used with a plus or minus sign,
68 \fB\en+[XXX]\fP or \fB\en-[XXX]\fP.)
70 Strings is defined with \fBds\fP.
72 \fB\&.ds\fP \fIYYY string\fP
74 The string is assigned everything to the end of the line, even blanks.
75 Initial blanks in \fIstring\fP should be prefixed with
77 (Strings are used in the text as \fB\e*[YYY]\fP.)
79 \fBSpecial formatting of number registers\fP
81 A number register is printed with normal digits if no format has been
83 Set the format with \fBaf\fP:
87 \fIR\fP is the name of the register, \fIc\fP is the format.
94 000, 001, 002, 003, ...
96 0, i, ii, iii, iv, ...
98 0, I, II, III, IV, ...
100 0, a, b, c, ..., z, aa, ab, ...
102 0, A, B, C, ..., Z, AA, AB, ...
109 Adds \fBtext\fP (heading-text) to the table of contents
110 with \fBlevel\fP either 0
113 This macro is used for customized
117 Begin one column processing.
118 An \fB1\fP as argument disables the page-break.
119 Use wide footnotes, small footnotes may be overprinted.
122 Begin two column processing.
123 Splits the page in two columns.
125 a special case of \fBMC\fP.
129 Abstract end, see \fBAS\fP.
131 .B "AF [name of firm]"
132 Authors firm, should be called before \fBAU\fP, see also \fBCOVER\fP.
134 .B "AL [type [text-indent [1]]]"
135 Start autoincrement list.
136 Items are numbered beginning on one.
137 The \fItype\fP argument controls the type of numbers.
144 Upper-case letters (A-Z)
146 Lower-case letters (a-z)
152 \fIText-indent\fP sets the indent and overrides \fBLi\fP.
153 A third argument will prohibit printing of a blank line before each
157 Begin an appendix with name \fIname\fP.
158 Automatic naming occurs if
160 The appendixes starts with \fBA\fP if auto is used.
161 An new page is ejected, and a header is also produced if the number
162 variable \fBAph\fP is non-zero.
164 The appendix always appear in the 'List of contents' with correct
166 The name \fIAPPENDIX\fP can be changed by setting
167 the string \fBApp\fP to the desired text.
168 The string \fBApptxt\fP contains the current appendix text.
170 .B "APPSK name pages text"
171 Same as \fB.APP\fP, but the pagenr is incremented with \fIpages\fP.
172 This is used when diagrams or other non-formatted documents are
173 included as appendixes.
175 .B "AS [arg [indent]]"
177 Indent is specified in 'ens', but scaling is allowed.
178 Argument \fIarg\fP controls where the abstract is printed.
183 Abstract will be printed on page 1 and on the cover sheet if
184 used in the released-paper style (\fBMT 4\fP), otherwise
185 it will be printed on page 1 without a cover sheet.
187 Abstract will only be printed on the cover sheet (\fBMT 4\fP only).
189 Abstract will be printed only on the cover sheet (other than \fBMT 4\fP only).
190 The cover sheet is printed without need for \fBCS\fP.
192 Abstract is not printed at all in external letters (\fBMT 5\fP).
193 The \fIindent\fP controls the indentation of both margins, otherwise
194 will normal text indent be used.
198 Default is \fBABSTRACT\fP.
199 Sets the text above the abstract text.
201 .B "AT title1 [title2 ...]"
203 \fBAT\fP must appear just after each \fBAU\fP.
204 The title will show up after the name in the signature block.
206 .B "AU [name [initials [loc [dept [ext [room [arg [arg [arg]]]]]]]]]"
207 Author information, specifies the author of the memo or paper, and
208 will be printed on the cover sheet and on other similar places.
209 \fBAU\fP must not appear before \fBTL\fP.
210 The author information
211 can contain initials, location, department, telephone extension,
212 room number or name and up to three extra arguments.
215 Approval signature, generates an approval line with place for
217 The string \fBAPPROVED:\fP can be changed
218 with variable \fBLetapp\fP, and the string \fBDate\fP in \fBLetdate\fP.
221 Letter signature, generates a line with place for signature.
223 .B "B [bold-text [prev-font-text [bold...]]]"
225 No limit on the number of arguments.
226 All arguments will be concatenated to one word, the first, third and so
227 on will be printed in boldface.
230 Begin box (as the ms macro).
231 Draws a box around the text.
232 The text will be indented one character,
233 and the right margin will be one character shorter.
237 Finish the box started by \fBB1\fP.
240 End bottom block, see \fBBS\fP.
242 .B "BI [bold-text [italic-text [bold-text [...]]]]"
244 No limit on the number of arguments, see \fBB\fP.
246 .B "BL [text-indent [1]]"
247 Start bullet list, initialize a list with a bullet and a space
248 in the beginning of each list item (see \fBLI\fP).
250 overrides the default indentation of the list items set by
251 number register \fBPi\fP.
252 A third argument will prohibit printing of a blank line before each
255 .B "BR [bold-text [roman-text [bold-text [...]]]]"
257 No limit on the number of arguments.
261 Begins the definition of a text block which is
262 printed at the bottom of each page.
263 Block ends with \fBBE\fP.
265 .B "BVL text-indent [mark-indent [1]]"
267 broken variable-item list.
268 Broken variable-item list has no fixed mark, it assumes that
269 every \fBLI\fP has a mark instead.
270 The text will always begin at the next line after the mark.
271 \fIText-indent\fP sets the indent to the text, and \fImark-indent\fP
272 the distance from the current indent to the mark.
273 A third argument will prohibit printing of a blank line before each
277 \&\fBCOVER\fP begins a coversheet definition.
279 that \fB.COVER\fP appears before any normal text.
280 \&\fB.COVER\fP uses \fIarg\fP to build the filename
281 @TMAC_MDIR@/\fIarg\fP.cov.
282 Therefore it is possible to create unlimited
283 types of coversheets.
284 \fIms.cov\fP is supposed to look like the \fBms\fP coversheet.
285 \&\fB.COVER\fP requires a \fB.COVEND\fP at the end of the coverdefinition.
286 Always use this order of the covermacros:
297 However, only \fB.TL\fP and \fB.AU\fP are required.
300 This finish the cover description and prints the cover-page.
301 It is defined in the cover file.
305 Ends a block of text, display, that begins
306 with \fBDS\fP or \fBDF\fP.
308 .B "DF [format [fill [rindent]]]"
309 Begin floating display (no nesting allowed).
310 A floating display is saved in a queue and is printed in the
312 \fIFormat\fP, \fIfill\fP and \fIrindent\fP is the same
314 Floating displays are controlled by the two number registers \fBDe\fP
320 Nothing special, this is the default.
322 A page eject will occur after each printed display, giving only
323 one display per page and no text following it.
329 Displays are printed at the end of each section (when section-page
330 numbering is active) or at the end of the document.
332 A new display will be printed on the current page if there is enough
333 space, otherwise it will be printed at the end of the document.
335 One display will be printed at the top of each page or column
336 (in multi-column mode).
338 Print one display if there is enough space for it, otherwise it will
339 be printed at the top of the next page or column.
341 Print as many displays that will fit in a new page or column.
342 A page break will occur between each display if \fBDe\fP is not zero.
344 Fill the current page with displays and the rest beginning at a new page
346 (This is the default.)
347 A page break will occur between each display
348 if \fBDe\fP is not zero.
351 .B "DL [text-indent [1 [1]]]"
353 Begins a list where each item is printed
355 \fIText-indent\fP changes the default indentation
356 of the list items set by
357 number register \fBPi\fP.
358 A second argument prevents the empty line between each list item
361 A third argument will prohibit printing of a blank line before each
364 .B "DS [format [fill [rindent]]]"
365 Static display start.
366 Begins collection of text until \fBDE\fP.
367 The text is printed together on the same page, unless it is longer
368 than the height of the page.
369 \fBDS\fP can be nested to a unlimited depth (reasonably :-).
381 Indent text with the value of number register \fBSi\fP.
385 Center the whole display as a block.
387 Right adjust the lines.
389 Right adjust the whole display as a block
392 L, I, C and CB can also be specified as 0, 1, 2 or 3 for compatibility
399 Line-filling turned off.
401 Line-filling turned off.
403 Line-filling turned off.
405 Line-filling turned on.
408 N and F can also be specified as 0 or 1.
409 An empty line will normally be printed before and after the
411 Setting number register \fBDs\fP to 0 will prevent this.
412 \fIRindent\fP shortens the line length by that amount.
414 .B "EC [title [override [flag [refname]]]]"
416 Sets a title for an equation.
417 The \fIoverride\fP argument
418 change the numbering.
423 \fIoverride\fP is a prefix to the number.
425 \fIoverride\fP is a prefix to the number.
427 \fIoverride\fP is a suffix to the number.
429 \fIoverride\fP replaces the number.
431 \fBEC\fP uses the number register \fBEc\fP as counter.
432 It is possible to use \fB.af\fP to change the format of the number.
433 If number register \fBOf\fP is 1, then the format of title
434 will use a dash instead of a dot after the number.
436 The string \fBLe\fP controls the title of the
437 List of Equations, default is \fILIST OF EQUATIONS\fP.
438 The List of Equations will only be printed if number register \fBLe\fP
440 The string \fBLiec\fP contains the word \fIEquation\fP, wich
441 is printed before the number.
442 If \fIrefname\fP is used, then the equation number is saved with
443 \&\fB.SETR\fP, and can be retrieved with \fB.GETST\fP \fIrefname\fP.
445 Special handling of the title will occur if
446 \fBEC\fP is used inside \fBDS\fP/\fBDE\fP, it will not be
447 affected by the format of \fBDS\fP.
450 Even-page footer, printed just above the normal page footer
451 on even pages, see \fBPF\fP.
454 Even-page header, printed just below the normal page header
455 on even pages, see \fBPH\fP.
458 Equation end, see \fBEQ\fP.
461 End of page user-defined macro.
462 This macro will be called
463 instead of the normal printing of the footer.
465 will be executed in a separate environment, without any
469 \fBStrings available to EOP\fP
472 Argument from \fBPF\fP.
474 Argument from \fBEF\fP.
476 Argument from \fBOF\fP.
479 .B "EPIC [-L] width height [name]"
480 \fBEPIC\fP draws a box with the given \fIwidth\fP and \fIheight\fP, it will
481 also print the text \fIname\fP or a default string if
482 \fIname\fP is not specified..
483 This is used to include external pictures, just give the size
485 \fB-L\fP will leftadjust the picture, the default is to center adjust.
490 \fBEQ\fP/\fBEN\fP are the delimiters for equations written for \fBeqn\fP.
491 \fBEQ\fP/\fBEN\fP must be inside a \fBDS\fP/\fBDE\fP-pair, except
492 when \fBEQ\fP is only used to set options in \fBeqn\fP.
493 The \fIlabel\fP will appear at the right margin of the equation, unless
494 number register \fBEq\fP is\ 1.
495 Then the label will appear at the
498 .B "EX [title [override [flag [refname]]]]"
499 Exhibit title, arguments are the same as for \fBEC\fP.
500 \fBEX\fP uses the number register \fBEx\fP as counter.
501 The string \fBLx\fP controls the title of the
502 List of Exhibits, default is \fILIST OF EXHIBITS\fP.
503 The List of Exhibits will only be printed if number register \fBLx\fP
505 The string \fBLiex\fP contains the word \fIExhibit\fP, which
506 is printed before the number.
507 If \fIrefname\fP is used, then the exhibit number is saved with
508 \&\fB.SETR\fP, and can be retrieved with \fB.GETST\fP \fIrefname\fP.
510 Special handling of the title will occur if
511 \fBEX\fP is used inside \fBDS\fP/\fBDE\fP, it will not be
512 affected by the format of \fBDS\fP.
515 Prints \fIYours\ very\ truly,\fP as a formal closing of a letter or
517 The argument replaces the defualt string.
518 The default is stored in string variable \fBLetfc\fP.
521 Footnote default format.
522 Controls the hyphenation (hyphen), right margin justification (adjust),
523 indentation of footnote text (indent).
524 It can also change the label
525 justification (ljust).
529 .ta .5i +.8i +.8i +.8i +.8i
530 \fBarg hyphen adjust indent ljust\fP
546 Argument greater than or equal to 11 is considered as arg 0.
547 Default for m@TMAC_M_PREFIX@m is 10.
552 .B "FG [title [override [flag [refname]]]]"
553 Figure title, arguments are the same as for \fBEC\fP.
554 \fBFG\fP uses the number register \fBFg\fP as counter.
555 The string \fBLf\fP controls the title of the
556 List of Figures, default is \fILIST OF FIGURES\fP.
557 The List of Figures will only be printed if number register \fBLf\fP
559 The string \fBLifg\fP contains the word \fIFigure\fP, wich
560 is printed before the number.
561 If \fIrefname\fP is used, then the figure number is saved with
562 \&\fB.SETR\fP, and can be retrieved with \fB.GETST\fP \fIrefname\fP.
564 Special handling of the title will occur if
565 \fBFG\fP is used inside \fBDS\fP/\fBDE\fP, it will not be
566 affected by the format of \fBDS\fP.
570 The footnote is ended by \fBFE\fP.
571 Footnotes is normally automatically
572 numbered, the number is available in string \fBF\fP.
573 Just add \fB\e*F\fP in the text.
574 By adding \fIlabel\fP, it is possible
575 to have other number or names on the footnotes.
576 Footnotes in displays is now possible.
577 An empty line separates footnotes, the height of the line
578 is controlled by number register \fBFs\fP, default value is 1.
580 .B "GETHN refname [varname]"
581 Includes the headernumber where the corresponding \fBSETR\fP \fIrefname\fP
583 Will be X.X.X. in pass\ 1.
585 If \fIvarname\fP is used, \fBGETHN\fP sets the stringvariable \fIvarname\fP to the
588 .B "GETPN refname [varname]"
589 Includes the pagenumber where the corresponding \fBSETR\fP \fIrefname\fP
591 Will be 9999 in pass\ 1.
593 If \fIvarname\fP is used, \fBGETPN\fP sets the stringvariable \fIvarname\fP
597 Combines \fBGETHN\fP and \fBGETPN\fP with the text 'chapter' and ', page'.
598 The string \fIQrf\fP contains the text for reference:
600 \&.ds Qrf See chapter \e\e*[Qrfh], page \e\e*[Qrfp].
602 \fIQrf\fP may be changed to support other languages.
603 Strings \fIQrfh\fP and \fIQrfp\fP are set by \fBGETR\fP
604 and contains the page and headernumber.
606 .B "GETST refname [varname]"
607 Includes the string saved with the second argument to \fB.SETR\fP.
608 Will be dummystring in pass 1.
609 If varname is used, \fBGETST\fP sets the stringvariable \fIvarname\fP to the
613 .B "H level [heading-text [heading-suffix]]"
614 Numbered section heading.
615 Section headers can have a level between 1 and 7, level 1 is the
617 The text is given in \fIheading-text\fP, and must be
618 surrounded by double quotes if it contains spaces.
619 \fBHeading-suffix\fP is added to the header in the text but not in
620 the table of contents.
621 This is normally used for footnote marks
623 Don't use \fB\e*F\fP in \fIheading-suffix\fP, it won't
625 A manual label must be used, see \fBFS\fP.
627 An eventual paragraph, \fBP\fP, directly after \fBH\fP will be
628 ignored, \fBH\fP is taking care of spacing and indentation.
630 \fBPage ejection before heading\fP
632 Number register \fBEj\fP controls page ejection before the heading.
633 Normally, a level one heading gets two blank lines before it, higher levels
635 A new page is ejected before each
636 first-level heading if number register \fBEj\fP is 1.
637 All levels below or equal the value of \fBEj\fP gets a new page.
638 Default value for \fBEj\fP is 0.
640 \fBHeading break level\fP
642 A line break occurs after the heading if the heading level is less
643 or equal to number register \fBHb\fP.
646 \fBHeading space level\fP
648 A blank line is inserted after the heading if the heading level is less
649 or equal to number register \fBHs\fP.
652 Text will follow the heading on the same line if the level is greater
653 than both \fBHb\fP and \fBHs\fP.
655 \fBPost-heading indent\fP
657 Indentation of the text after the heading is controlled by number
658 register \fBHi\fP, default value 0.
663 The text will be left-justified.
665 Indentation of the text will follow the value of number register \fBPt\fP,
668 The text will be lined up with the first word of the heading.
671 \fBCentered section headings\fP
673 All headings whose level is equal or below number register \fBHc\fP
674 and also less than or equal to \fBHb\fP or \fBHs\fP
677 \fBFont control of the heading\fP
679 The font of each heading level is controlled by string \fBHF\fP.
680 It contains a fontnumber or fontname for each level.
682 is \fB2\ 2\ 2\ 2\ 2\ 2\ 2\fP (all headings in italic).
683 Could also be written as \fBI\ I\ I\ I\ I\ I\ I\fP.
684 Note that some other implementations use \fB3\ 3\ 2\ 2\ 2\ 2\ 2\fP as the
686 All omitted values are presumed to be a 1.
688 \fBPoint size control\fP.
690 String \fBHP\fP controls the pointsize of each heading, in the
691 same way as \fBHF\fP controls the font.
692 A value of 0 selects the default point size.
693 Default value is \fB0\ 0\ 0\ 0\ 0\ 0\ 0\fP.
695 point size changes, not the vertical size.
696 That can be controlled by the user specified macro \fBHX\fP and/or
699 \fBHeading counters\fP
701 Seven number registers, named \fBH1\fP thru \fBH7\fP contains
702 the counter for each heading level.
703 The values are printed using arabic numerals, this can be changed
704 with the macro \fBHM\fP (see below).
705 All marks are concatenated before printing.
707 number register \fBHt\fP to\ 1.
708 That will only print the current
709 heading counter at each heading.
711 \fBAutomatic table of contents\fP
713 All headings whose level is equal or below number register \fBCl\fP
714 is saved to be printed in the table of contents.
717 \fBSpecial control of the heading, user-defined macros\fP.
719 These macros can be defined by the user to get a finer control
720 of vertical spacing, fonts or other features.
721 Argument \fIlevel\fP is the level-argument to \fBH\fP, but
722 0 for unnumbered headings (see \fBHU\fP).
723 Argument \fIrlevel\fP is the real level, it is
724 set to number register \fBHu\fP for unnumbered headings.
725 Argument \fIheading-text\fP is the text argument to \fBH\fP and \fBHU\fP.
727 \fBHX\ \fP\fIlevel\ rlevel\ heading-text\fP
729 \fBHX\fP is called just before the printing of the heading.
730 The following register is available for \fBHX\fP.
731 \fBHX\fP may alter \fB}0\fP, \fB}2\fP and \fB;3\fP.
734 Contains the heading mark plus two spaces if \fIrlevel\fP is non-zero,
737 Contains the position of the text after the heading.
738 0 means that the text should follow the heading on the same line, 1
739 means that a line break should occur before the text and
740 2 means that a blank line should separate the heading and the text.
742 Contains two spaces if register \fB;0\fP is\ 0.
744 separate the heading from the text.
746 is empty if \fB;0\fP is non-zero.
748 Contains the needed space in units after the heading.
751 Can be used to change things like numbering (\fB}0\fP),
752 vertical spacing (\fB}2\fP)
753 and the needed space after the heading.
756 \fBHY\ \fP\fIdlevel\ rlevel\ heading-text\fP
758 \fBHY\fP is called after size and font calculations and
759 might be used to change indentation.
761 \fBHZ\ \fP\fIdlevel\ rlevel\ heading-text\fP
763 \fBHZ\fP is called after the printing of the heading, just before
764 \fBH\fP or \fBHU\fP exits.
765 Could be used to change the page header according to the section heading.
767 .B "HC [hyphenation-character]"
768 Set hyphenation character.
769 Default value is \e%.
770 Resets to the default if called without argument.
771 Hyphenation can be turned off by setting number
772 register \fBHy\fP to 0 in the beginning of the file.
774 .B "HM [arg1 [arg2 [... [arg7]]]]"
776 Controls the type of marking for printing of the heading counters.
777 Default is 1 for all levels.
784 Arabic numerals with leading zeroes, one or more.
786 Upper-case alphabetic
788 Lower-case alphabetic
790 Upper-case roman numerals
792 lower-case roman numerals
798 Unnumbered section header.
799 \fBHU\fP behavies like \fBH\fP at the level in number register \fBHu\fP.
802 .B "HX dlevel rlevel heading-text"
803 Userdefined heading exit.
804 Called just before printing the header.
807 .B "HY dlevel rlevel heading-text"
808 Userdefined heading exit.
809 Called just before printing the header.
812 .B "HZ dlevel rlevel heading-text"
813 Userdefined heading exit.
814 Called just after printing the header.
817 .B "I [italic-text [prev-font-text [italic-text [...]]]]"
819 Changes the font to italic if called without arguments.
820 With one argument it will set the word in italic.
821 With two argument it will concatenate them and set the first
822 word in italic and the second in the previous font.
823 There is no limit on the number of argument, all will be concatenated.
825 .B "IA [addressee-name [title]]"
826 Begins specification of the addressee and addressee's address in
828 Several names can be specified with empty \fBIA\fP/\fBIE\fP-pairs, but
832 .B "IB [italic-text [bold-text [italic-text [...]]]]"
834 Even arguments is printed in italic, odd in boldface.
838 Ends the address-specification after \fPIA\fP.
840 .B "INITI type filename [macro]"
841 Initialize the new index system, sets the filename to collect
842 index lines in with \fBIND\fP.
843 Argument \fItype\fP selects
844 the type of index, page number, header marks or both.
845 The default is \fIN\fP.
847 It is also possible to create a macro that is responsible
848 for formatting each row.
849 Add the name of the macro as argument\ 3.
850 The macro will be called with the index as argument(s).
859 Both page numbers and header marks, tab separated
863 Initialize the refencemacros.
864 References will be written to stderr and is supposed to
865 be written to \fIfilename.qrf\fP.
866 Requires two passes with groff, this is handled by a
867 separate program called \fBmmroff\fP, the reason is that
868 groff is often installed without the unsafe operations that
869 \fBINITR\fP requiered.
870 The first pass looks for references and the second one includes them.
871 \fBINITR\fP can be used several times, but it is only the first
872 occurrence of \fBINITR\fP that is active.
874 See also \fBSETR\fP, \fBGETPN\fP and \fBGETHN\fP.
876 .B "IND arg1 [arg2 [...]]"
877 \fBIND\fP writes a line in the index file selected by \fBINITI\fP
878 with all arguments and the page number or header mark separated by tabs.
884 arg1\etarg2\etpage number
888 arg1\etpage number\etheader mark
892 \fBINDP\fP prints the index by running the command specified
893 by string variable \fBIndcmd\fP, normally \fIsort\ -t\et\fP.
894 \fBINDP\fP reads the output from the command to form
895 the index, normally in two columns (can be changed by defining \fBTYIND\fP).
896 The index is printed with string variable \fBIndex\fP as header,
897 default is \fBINDEX\fP.
898 One-column processing is
899 returned after the list.
900 \fBINDP\fP will call the
901 user-defined macros \fBTXIND\fP, \fBTYIND\fP and \fBTZIND\fP if defined.
902 \fBTXIND\fP is called before printing \fBINDEX\fP, \fBTYIND\fP
903 is called instead of printing \fBINDEX\fP.
904 \fBTZIND\fP is called
905 after the printing and should take care of restoring to normal
909 \fBISODATE\fP changes the predefined date string in \fBDT\fP to
910 ISO-format, ie YYYY-MM-DD.
911 This can also be done by
912 adding \fB-rIso=1\fP on the command line.
913 Reverts to old date format if argument is \fB0\fP.
915 .B "IR [italic-text [roman-text [italic-text [...]]]]"
917 Even arguments is printed in italic, odd in roman.
920 .B "LB text-indent mark-indent pad type [mark [LI-space [LB-space]]]"
922 This is the common macro used for all lists.
923 \fIText-indent\fP is the number of spaces to indent the text from the
926 \fIPad\fP and \fImark-indent\fP controls where to put the mark.
927 The mark is placed within the mark area, and \fImark-indent\fP
928 sets the number of spaces before this area.
930 The mark area ends where the text begins.
931 The start of the text
932 is still controlled by \fItext-indent\fP.
934 The mark is left justified whitin the mark area if \fIpad\fP is 0.
935 If \fIpad\fP is greater than 0, then \fImark-indent\fP is ignored, and
936 the mark is placed \fIpad\fP spaces before the text.
937 This will right justify the mark.
939 If \fItype\fP is 0 the list will have either a hanging indent or, if
940 argument \fImark\fP is given, the string \fImark\fP as mark.
942 If \fItype\fP is greater than 0 automatic numbering will occur, arabic
943 if \fImark\fP is empty.
944 \fIMark\fP can then be any of \fB1\fP, \fBA\fP,
945 \fBa\fP, \fBI\fP or \fBi\fP.
947 \fIType\fP selects one of six possible ways to display the mark.
965 Every item in the list will get \fILI-space\fP number of blank lines
969 \fBLB\fP itself will print \fILB-space\fP blank lines.
974 Terminates all current active lists down to \fIlist-level\fP, or 0
975 if no argmuent is given.
976 This is used by \fBH\fP to clear any
981 Terminate the current list.
982 \fBLE\fP outputs a blank line
983 if an argument is given.
986 List item precedes every item in a list.
987 Without argument \fBLI\fP
988 will print the mark determined by the current list type.
990 \fBLI\fP one argument, it will use that as the mark instead.
991 Two arguments to \fBLI\fP will make \fImark\fP a prefix to
993 There will be no separating space between the prefix
994 and the mark if the second argument is \fB2\fP instead of \fB1\fP.
995 This behaviour can also be achieved by setting number register
997 A zero length \fImark\fP will make a hanging
1000 A blank line is normally printed before the list item.
1002 can be controlled by number register \fBLs\fP.
1004 will occur for each list-level less than or equal to \fBLs\fP.
1005 Default value is\ 99.
1006 (Nesting of lists is unlimited.\ :-)
1008 The indentation can be changed thru number register \fBLi\fP.
1011 All lists begins with a list initialization macro, \fBLB\fP.
1012 There are, however, seven predefined listtypes to
1013 make lists easier to use.
1014 They all call \fBLB\fP with different
1018 Automatically Incremented List
1030 Broken Varable List.
1032 These lists are described at other places in this manual.
1036 Formats a letter in one of four different styles depending
1038 See also \fBINTERNALS\fP.
1044 Date line, return address, writer's address and closing
1045 begins at the center of the line.
1046 All other lines begin at the left margin.
1049 Same as blocked, except that the first line in every
1050 paragraph is indented five spaces.
1053 All lines begin at the left margin.
1056 Almost the same as the full-blocked style.
1058 the writer's identification are printed in all-capital.
1062 Specify options in letter (see \fB.LT\fP).
1063 This is a list of the standard options:
1066 Confidential notation.
1067 Prints \fBCONFIDENTIAL\fP on the second line
1068 below the date line.
1069 Any argument replaces \fBCONFIDENTIAL\fP.
1070 See also string variable \fBLetCN\fP.
1073 Prints \fBIn reference to:\fP and the argument
1074 two lines below the date line.
1075 See also string variable \fBLetRN\fP.
1078 Prints \fBATTENTION:\fP and the argument below the inside address.
1079 See also string variable \fBLetAT\fP.
1082 Prints \fBTo Whom It May Concern:\fP or the argument if
1084 The salutation is printed two lines below the inside address.
1085 See also string variable \fBLetSA\fP.
1088 Prints the argument as subject prefixed with \fBSUBJECT:\fP
1089 two lines below the inside address, except in letter type \fBSP\fP.
1090 Then the subject is printed in all-captial without any prefix.
1091 See also string variable \fBLetSJ\fP.
1094 .B "MC column-size [column-separation] "
1095 Begin multiple columns.
1096 Return to normal with \fB1C\fP.
1097 \fBMC\fP will create as many columns as the current line length permits.
1098 \fIColumn-size\fP is the width of each column, and \fIcolumn-separation\fP
1099 is the space between two columns.
1100 Default separation is the
1104 .B "ML mark [text-indent [1]]"
1106 The \fImark\fP argument will be printed before
1108 \fIText-indent\fP sets the indent and overrides \fBLi\fP.
1109 A third argument will prohibit printing of a blank line before each
1112 .B "MT [arg [addressee]]"
1114 The \fIarg\fP is part of a filename in \fI@TMAC_MDIR@/*.MT\fP.
1115 Memorandum type 0 thru 5 are supported, including \fI"string"\fP.
1116 \fIAddressee\fP just sets a variable, used in the AT&T macros.
1121 Normal memorandum, no type printed
1123 Memorandum with \fIMEMORANDUM FOR FILE\fP printed
1125 Memorandum with \fIPROGRAMMER'S NOTES\fP printed
1127 Memorandum with \fIENGINEER'S NOTES\fP printed
1129 Released paper style
1131 External letter style
1133 See also \fBCOVER\fP/\fBCOVEND\fP, a more flexible type of front page.
1135 .B "MOVE y-pos [x-pos [line-length]]"
1136 Move to a position, pageoffset set to \fIx-pos\fP.
1137 If \fIline-length\fP is not given, the difference between
1138 current and new pageoffset is used.
1139 Use \fBPGFORM\fP without arguments to return to normal.
1141 .B "MULB cw1 space1 [cw2 space2 [cw3 ...]]"
1142 Begin a special multi-column mode.
1143 Every columns width must be specified.
1144 Also the space between the columns must be specified.
1146 does not need any space-definition.
1147 \fBMULB\fP starts a diversion and \fBMULE\fP
1148 ends the diversion and prints the columns.
1149 The unit for width and space is 'n', but \fBMULB\fP accepts all
1150 normal unitspecifications like 'c' and 'i'.
1151 \fBMULB\fP operates in a separate environment.
1154 Begin the next column.
1155 This is the only way to switch column.
1158 End the multi-column mode and print the columns.
1161 Print numbered paragraph with header level two.
1165 Force printing to the next column, don't use this together with
1166 the \fBMUL*\fP macros, see \fB2C\fP.
1169 Prints different types of notations.
1170 The argument selects between
1171 the predefined type of notations.
1172 If the second argument is available,
1173 then the argument becomes the entire notation.
1174 If the argument doesn't exist in the predefined, it will be
1175 printed as \fBCopy (\fP\fIarg\fP\fB) to\fP.
1176 It is possible to add more standard notations, see the string variable
1177 \fBLetns\fP and \fBLetnsdef\fP.
1187 Copy To (with att.) to
1189 Copy To (without att.) to
1199 Under separate cover
1205 Copy (with atts.) to
1207 Copy (without atts.) to
1211 Complete Memorandum to
1219 Override the current date.
1221 printed if \fInew-date\fP is an empty string.
1224 Odd-page footer, a line printed just above the normal footer.
1225 See \fBEF\fP and \fBPF\fP.
1228 Odd-page header, a line printed just below the normal header.
1229 See \fBEH\fP and \fBPH\fP.
1232 Make sure that the following text is printed at the top
1233 of an odd-numbered page.
1234 Will not output an empty page
1235 if currently at the top of an odd page.
1238 Begin new paragraph.
1239 \fBP\fP without argument will produce left justified text, even
1240 the first line of the paragraph.
1241 This is the same as setting
1243 If the argument is\ 1, then the first line
1244 of text following \fBP\fP will be indented by the number of
1245 spaces in number register \fBPi\fP, normally 5.
1247 Instead of giving 1 as argument to \fBP\fP it is possible to set the
1248 paragraph type in number register \fBPt\fP.
1250 will be the same as adding that value to \fBP\fP.
1251 A value of 2 will indent all paragraphs, except after
1252 headings, lists and displays.
1254 The space between two paragraphs is controlled by number register \fBPs\fP,
1255 and is 1 by default (one blank line).
1257 .B "PGFORM [linelength [pagelength [pageoffset [1]]]]"
1258 Sets linelength, pagelength and/or pageoffset.
1259 This macro can be used for special formatting, like letterheads
1261 It is normally the first command in a file, though it's not necessary.
1262 \fBPGFORM\fP can be used without arguments
1263 to reset everything after a \fBMOVE\fP.
1264 A line-break is done unless the fourth argument is given.
1265 This can be used to avoid the pagenumber on the first page while setting
1266 new width and length.
1267 (It seems as if this macro sometimes doesn't work too well.
1268 Use the command line arguments
1269 to change linelength, pagelength and pageoffset instead.
1273 No header is printed on the next page.
1275 the header in letters or other special texts.
1276 This macro must be used before any text to inhibit the pageheader
1279 .B PIC [-L] [-C] [-R] [-I n] filename [width [height]]
1280 \fBPIC\fP includes a Postscript file in the document.
1281 The macro depends on \fBmmroff\fP and \fBINITR\fP.
1282 \fB-L\fP, \fB-C\fP, \fB-R\fP and \fB-I n\fP adjusts the picture
1284 The optionally \fIwidth\fP and \fIheight\fP
1285 can also be given to resize the picture.
1289 Ends a picture for \fB@TMAC_M_PREFIX@pic\fP, see the manual for \fB@TMAC_M_PREFIX@pic\fP.
1293 \fBPF\fP sets the line to be printed at the bottom of each page.
1295 See \fBPH\fP for the argument specification.
1298 Page header, a line printed at the top of each page.
1299 The argument should be specified as "'left-part'center-part'right-part'",
1300 where left-, center- and right-part is printed left-justified, centered
1301 and right justified.
1302 The character \fB%\fP is changed to the current
1304 The default page-header is "''- % -''", the page
1305 number between two dashes.
1308 Picture start (from pic).
1309 Begins a picture for \fB@g@pic\fP, see
1313 Page-header user-defined exit.
1314 \fBPX\fP is called just after the printing of the page header
1315 in \fIno-space\fP mode.
1319 Return to roman font, see also \fBI\fP.
1321 .B "RB [roman-text [bold-text [roman-text [...]]]]"
1323 Even arguments is printed in roman, odd in boldface.
1326 .B "RD [prompt [diversion [string]]]"
1327 Read from standard input to diversion and/or string.
1328 The text will be saved in a diversion named \fIdiversion\fP.
1329 Recall the text by writing the name of the diversion after a dot
1331 A string will also be defined if
1332 \fIstring\fP is given.
1333 \fIDiversion\fP and/or \fIprompt\fP can
1338 Ends a reference definition and returns to normal
1342 .B "RI [roman-text [italic-text [roman-text [...]]]]"
1343 Even arguments are printed in roman, odd in italic.
1346 .B "RL [text-indent [1]]"
1347 Reference list start.
1348 Begins a list where each item is preceded with a automatically
1349 incremented number between
1351 \fIText-indent\fP changes the default indentation.
1353 .B "RP [arg1 [arg2]]"
1354 Produce reference page.
1355 \fBRP\fP can be used if a reference page is wanted somewhere in the
1357 It is not needed if \fBTC\fP is used to produce
1359 The reference page will then be printed automatically.
1361 The reference counter will not be reset if \fIarg1\fP is 1.
1363 \fIArg2\fP tells \fBRP\fP whether to eject a page or not.
1368 The reference page will be printed on a separate page.
1372 Do not eject page after the list.
1374 Do not eject page before the list.
1376 Do not eject page before and after the list.
1378 The reference items will be separated by a blank line.
1379 Setting number register \fBLs\fP to 0 will suppress the line.
1381 The string \fBRp\fP contains the reference page title and
1382 is normally set to \fIREFERENCES\fP.
1384 .B "RS [string-name]"
1385 \fBRS\fP begins an automatically numbered reference definition.
1386 Put the string \fB\e*(Rf\fP where the reference mark
1387 should be and write the reference between \fBRS\fP/\fBRF\fP
1388 at next new line after the reference mark.
1389 The reference number
1390 is stored in number register \fB:R\fP.
1391 If \fIstring-name\fP is given, a string with that name
1392 will be defined and contain the current reference mark.
1393 The string can be referenced as \fB\e*[\fIstring-name\fP]\fP later in
1396 .B "S [size [spacing]]"
1397 Set point size and vertical spacing.
1398 If any argument is equal 'P', then
1399 the previous value is used.
1400 A 'C' means current value, and 'D' default value.
1401 If '+' or '-' is used before the value, then increment or decrement of
1402 the current value will be done.
1405 Set right-margin justification.
1406 Justification is normally turned on.
1407 No argumenent or \fB0\fP turns off justification, a \fB1\fP turns on
1410 .B "SETR refname [string]"
1411 Remember the current header and page-number as \fIrefname\fP.
1412 Saves \fIstring\fP if \fIstring\fP is defined.
1413 \fIstring\fP is retrieved
1419 Prints the authors name(s) after the formal closing.
1420 The argument will be appended to the reference data, printed
1421 at either the first or last author.
1422 The reference data is the location,
1423 department and initials specified with \fB.AU\fP.
1424 It will be printed at the first author if the second argument is given,
1425 otherwise at the last.
1426 No reference data will be printed if the author(s) is specifed
1427 thru \fB.WA\fP/\fB.WE\fP.
1428 See \fBINTERNALS\fP.
1432 If \fIpages\fP is \fB0\fP or omitted, a skip to the next page
1433 will occur unless it is already at the top of a page.
1434 Otherwise it will skip \fIpages\fP pages.
1436 .B "SM string1 [string2 [string3]]"
1437 Make a string smaller.
1438 If \fIstring2\fP is given, \fIstring1\fP will be smaller and \fIstring2\fP
1439 normal, concatenated with \fIstring1\fP.
1440 With three argument, all is
1441 concatenated, but only \fIstring2\fP is made smaller.
1445 \fIlines\fP can have any scalingfactor, like \fI3i\fP or
1447 Several \fBSP\fP in a line will only produce the
1448 maximum number of lines, not the sum.
1449 \fBSP\fP will also be ignored
1450 until the first textline in a page.
1451 Add a \fB\e&\fP before \fBSP\fP
1455 reset tabs to every\ 5n.
1456 Normally used to reset any previous tabpositions.
1458 .B "TB [title [override [flag [refname]]]]"
1459 Table title, arguments are the same as for \fBEC\fP.
1460 \fBTB\fP uses the number register \fBTb\fP as counter.
1461 The string \fBLt\fP controls the title of the
1462 List of Tables, default is \fILIST OF TABLES\fP.
1463 The List of Tables will only be printed if number register \fBLt\fP
1465 The string \fBLitb\fP contains the word \fITABLE\fP, wich
1466 is printed before the number.
1468 Special handling of the title will occur if
1469 \fBTB\fP is used inside \fBDS\fP/\fBDE\fP, it will not be
1470 affected by the format of \fBDS\fP.
1472 .B "TC [slevel [spacing [tlevel [tab [h1 [h2 [h3 [h4 [h5]]]]]]]]]"
1474 This macro is normally used at the last line of the document.
1475 It generates a table of contents with headings up to the level
1476 controlled by number register \fBCl\fP.
1477 Note that \fBCl\fP controls
1478 the saving of headings, it has nothing to do with \fBTC\fP.
1479 Headings with level less than or equal to \fIslevel\fP will get
1480 \fIspacing\fP number of lines before them.
1481 Headings with level less than or equal to \fItlevel\fP will have
1482 their page numbers right justified with dots or spaces separating
1483 the text and the page number.
1484 Spaces is used if \fItab\fP
1485 is greater than zero, otherwise dots.
1486 Other headings will have the
1487 page number directly at the end of the heading text (\fIragged right\fP).
1489 The rest of the arguments will be printed, centered, before the
1492 The user-defined macros \fBTX\fP and \fBTY\fP are used if \fBTC\fP is called
1493 with at most four arguments.
1494 \fBTX\fP is called before the printing
1495 of \fICONTENTS\fP, and \fBTY\fP is called instead of printing \fICONTENTS\fP.
1497 Equivalent macros can be defined for list of figures, tables, equations
1498 and excibits by defining \fBTXxx\fP or \fBTYxx\fP, where \fBxx\fP
1499 is \fBFg\fP, \fBTB\fP, \fBEC\fP or \fBEX\fP.
1501 String \fBCi\fP can be set to control the indentations for each heading-level.
1502 It must be scaled, like \fB.ds\ Ci\ .25i\ .5i\ .75i\ 1i\ 1i\fP.
1503 The indentation is normally controlled by the maxlength of headings
1506 All texts can be redefined, new stringvariables
1507 \fILifg\fP, \fILitb\fP, \fILiex\fP, \fILiec\fP and \fILicon\fP contain
1508 "Figure", "TABLE", "Exhibit", "Equation" and "CONTENTS".
1509 These can be redefined to other languages.
1518 \fBTH\fP ends the header of the table.
1520 be printed again if a page-break occurs.
1521 Argument \fIN\fP isn't implemented yet.
1523 .B TL [charging-case number(s) [filing-case number(s)]]
1524 Begin title of memorandum.
1525 All text up to the next \fBAU\fP is included in the title.
1526 \fICharging-case number\fP and \fIfiling-case\fP are saved
1527 for use in the front page processing.
1529 .B TM [num1 [num2 [...]]]
1530 Technical memorandumnumbers used in \fB.MT\fP.
1532 of arguments may be given.
1535 Top of page user-defined macro.
1536 This macro is called instead of the normal page header.
1538 possible to get complete control over the header.
1539 Note that header and footer is printed in a separate environment.
1540 Linelength is preserved though.
1544 This is the start of a table specification
1546 See separate manual for \fB@g@tbl\fP.
1547 \fBTS\fP ends with \fBTE\fP.
1548 Argument \fIH\fP tells \fBm@TMAC_M_PREFIX@m\fP that the table
1553 Userdefined table of contents exit.
1554 This macro is called just before \fBTC\fP prints the word \fICONTENTS\fP.
1558 Userdefined table of contents exit (no "CONTENTS").
1559 This macro is called instead of printing \fICONTENTS\fP.
1562 .B VERBON [flag [pointsize [font]]]
1563 Begin verbatim output using courier font.
1564 Usually for printing programs.
1565 All character has equal width.
1566 The pointsize can be changed with
1567 the second argument.
1568 By specifying the font-argument
1569 it is possible to use another font instead of courier.
1570 \fIflag\fP controls several special features.
1571 It contains the sum of all wanted features.
1576 Disable the escape-character (\e).
1577 This is normally turned on during
1580 Add an empty line before the verbose text.
1582 Add an empty line after the verbose text.
1584 Print the verbose text with numbered lines.
1585 This adds four digitsized
1586 spaces in the beginning of each line.
1587 Finer control is available with
1588 the string-variable \fBVerbnm\fP.
1589 It contains all arguments to the
1590 \fBtroff\fP-command \fB.nm\fP, normally '1'.
1592 Indent the verbose text with five 'n':s.
1593 This is controlled by the
1594 number-variable \fBVerbin\fP (in units).
1598 End verbatim output.
1600 .B "VL text-indent [mark-indent [1]]"
1601 Variable-item list has no fixed mark, it assumes that
1602 every \fBLI\fP have a mark instead.
1603 \fIText-indent\fP sets the indent to the text, and \fImark-indent\fP
1604 the distance from the current indent to the mark.
1605 A third argument will prohibit printing of a blank line before each
1608 .B "VM [-T] [top [bottom]]"
1609 Vertical margin. Adds extra vertical top and margin space.
1610 Option \fB-T\fP set the total space instead.
1611 No argument resets the margin to zero or the default
1612 \fI(7v 5v)\fP if \fB-T\fP
1613 was used. It is higly recommended that macro \fBTP\fP and/or
1614 \fBEOP\fP are defined
1615 if using \fB-T\fP and setting top and/or bottom margin to less than the default.
1617 .B "WA [writer-name [title]]"
1618 Begins specification of the writer and writer's address.
1619 Several names can be specified with empty \fBWA\fP/\fBWE\fP-pairs, but
1623 Ends the address-specification after \fP.WA\fP.
1626 Footnote and display width control.
1629 Set default mode, \fB-WF\fP, \fB-FF\fP, \fB-WD\fP and \fBFB\fP.
1631 Wide footnotes, wide also in two-column mode.
1633 Normal footnote width, follow column mode.
1635 All footnotes gets the same width as the first footnote encountered.
1637 Normal footnotes, width follows \fBWF\fP and \fB-WF\fP.
1639 Wide displays, wide also in two-column mode.
1641 Normal display width, follow column mode.
1643 Floating displays generates a line break when printed on the current page.
1645 Floating displays does not generate line break.
1649 .\"########################################################################
1651 .B "Strings used in m@TMAC_M_PREFIX@m:"
1654 A string containing the word "APPENDIX".
1658 The current appendix text.
1663 Will be updated by \fB.H\fP and \fB.HU\fP to the current heading text.
1664 Also updated in table of contents & friends.
1667 Fontlist for headings, normally "2 2 2 2 2 2 2".
1668 Nonnumeric fontnames may also be used.
1671 Pointsize list for headings.
1672 Normally "0 0 0 0 0 0 0" which is the same as
1673 "10 10 10 10 10 10 10".
1677 Contains \fIINDEX\fP.
1680 Contains the index command, \fIsort\ -t\et\fP.
1682 String containing \fIFigure\fP.
1685 String containing \fITABLE\fP.
1688 String containing \fIExhibit\fP.
1691 String containing \fIEquation\fP.
1694 String containing \fICONTENTS\fP.
1697 Contains "LIST OF FIGURES".
1700 Contains "LIST OF TABLES".
1703 Contains "LIST OF EXHIBITS".
1706 Contains "LIST OF EQUATIONS".
1709 Contains "Yours very truly,", used in \fB.FC\fP.
1712 Contains "APPROVED:", used in \fB.AV\fP.
1715 Contains "Date", used in \fB.AV\fP.
1718 Contains "CONFIDENTIAL", used in \fB.LO CN\fP.
1721 Contains "To Whom It May Concern:", used in \fB.LO SA\fP.
1724 Contains "ATTENTION:", used in \fB.LO AT\fP.
1727 Contains "SUBJECT:", used in \fB.LO SJ\fP.
1730 Contains "In reference to:", used in \fB.LO RN\fP.
1733 is an array containing the different strings used in \fB.NS\fP.
1734 It is really a number of stringvariables prefixed with \fBLetns!\fP.
1735 If the argument doesn't exist, it will be included
1736 between \fB()\fP with \fBLetns!copy\fP as prefix and \fBLetns!to\fP as suffix.
1737 Observe the space after \fBcopy\fP and before \fBto\fP.
1742 Letns!1 Copy (with att.) to
1743 Letns!2 Copy (without att.) to
1748 Letns!7 Under separate cover
1750 Letns!9 Memorandum to
1751 Letns!10 Copy (with atts.) to
1752 Letns!11 Copy (without atts.) to
1753 Letns!12 Abstract Only to
1754 Letns!13 Complete Memorandum to
1761 Defines the standard-notation used when no argument is given
1766 Strings containing \fIJanuary\fP thru \fIDecember\fP.
1769 String containing "See chapter \e\e*[Qrfh], page \e\en[Qrfp].".
1772 Contains "REFERENCES".
1775 Contains current status of table of contents and list of XXXX.
1776 Empty outside \fB.TC\fP.
1777 Useful in user-defined macros like \fB.TP\fP.
1781 co Table of contents
1784 ec List of equations
1791 Contains \e(tm, trade mark.
1794 Argument to \fB.nm\fP in \fB.VERBON\fP, default: \fB1\fP.
1795 .\"-----------------------------------
1797 .B "Number variables used in m@TMAC_M_PREFIX@m:"
1800 Print an appendix-page for every new appendix
1801 if this numbervariable is non-zero.
1802 No output will occur if \fBAph\fP is zero, but there will always
1803 be an appendix-entry in the 'List of contents'.
1806 Contents level [0:7], contents saved if heading level <= Cl, default 2.
1809 Eject page between LIST OF XXXX if Cp == 0, default 0.
1812 Debugflag, values >0 produces varying degree of debug.
1814 gives information about the progress of formatting, default\ 0.
1817 Eject after floating display is output [0:1], default\ 0.
1820 Controls the space output before and after static displays
1822 Otherwise is the value of Lsp used.
1825 Floating keep output [0:5], default 5.
1828 \fBLsp\fP space before and after display if == 1 [0:1], default 1.
1831 Eject page, default 0.
1834 Equation lable adjust 0=left, 1=right.
1838 Footnote spacing, default 1.
1844 Append a dot after the level one heading number if >\ 0.
1849 Copy of number register \fBH1\fP, but it is incremented
1850 just before the page break.
1851 Useful in user defined header macros.
1853 Heading break level [0:7], default\ 2.
1856 Heading centering level, [0:7].
1860 Heading temporary indent [0:2], default\ 1.
1862 0\ ->\ 0 indent, left margin
1864 1\ ->\ indent to right , like .P 1
1866 2\ ->\ indent to line up with text part of preceding heading
1869 Numbervariable with the heading pre-space level.
1870 If the heading-level
1871 is less than or equal to \fBHps\fP, then two lines will precede the
1872 section heading instead of one.
1873 Default is first level only.
1874 The real amount of lines is controlled by the variables \fBHps1\fP and
1878 This is the number of lines preceding \fB.H\fP when the heading-level
1879 is greater than \fBHps\fP.
1880 Value is in units, normally 0.5.
1883 This is the number of lines preceding \fB.H\fP when the heading-level
1884 is less than or equal to \fBHps\fP.
1885 Value is in units, normally\ 1.
1888 Heading space level [0:7], default\ 2.
1891 This is the number of lines that follows \fB.H\fP when the heading-level
1892 is less than or equal to \fBHs\fP.
1893 Value is in units, normally\ 1.
1896 Heading numbering type, default 0.
1897 0 -> multiple (1.1.1 ...)
1902 Unnumbered heading level, default 2.
1905 Hyphenation in body, default 1.
1907 0\ ->\ no hyphenation
1909 1\ ->\ hyphenation 14 on
1912 Set this variable to 1 on the command line to get ISO-formatted date string.
1914 Useless inside a document.
1917 Page length, only for command line settings.
1920 Max lines in return-address, used in \fB.WA\fP/\fB.WE\fP.
1924 Enables (1) or disables (0) the printing of List of figures,
1925 List of tables, List of exhibits and List of equations.
1926 Default: Lf=1, Lt=1, Lx=1, Le=0.
1929 List indent, used by .AL, default 6.
1932 Flag for space between prefix and mark in automatic lists (.AL).
1939 List space, if current listlevel > Ls then no spacing will occur around lists.
1943 The size of an empty line.
1944 Normally 0.5v, but it is 1v
1945 if \fBn\fP is set (\fB.nroff\fP).
1948 Numbering style [0:5], default 0.
1950 0\ ==\ (default) normal header for all pages.
1952 1\ ==\ header replaces footer on first page, header is empty.
1954 2\ ==\ page header is removed on the first page.
1956 3\ ==\ "section-page" numbering enabled.
1958 4\ ==\ page header is removed on the first page.
1960 5\ ==\ "section-page" and "section-figure" numbering enabled.
1961 See also the number-register Sectf and Sectp.
1964 Numbered paragraphs, default 0.
1968 1\ ==\ numbered in first level headings.
1971 Page offset, only for command line settings.
1974 Format of figure,table,exhibit,equation titles, default 0.
1981 Current page-number, normally the same as % unless "section-page" numbering
1985 paragraph indent, default 5.
1988 Controls whether header and footer pointsize should follow the current
1989 setting or just change when the header and footer is defined.
1995 Pointsize will only change to the current setting when \fB.PH\fP, \fB.PF\fP,
1996 \&\fB.OH\fP, \fP.EH\fP, \fB.OF\fP or \fB.OE\fP is executed.
1998 Pointsize will change after every \fB.S\fP.
1999 This is the default.
2003 paragraph spacing, default 1.
2006 Paragraph type, default 0.
2008 0\ ==\ left-justified
2012 2\ ==\ indented .P except after .H, .DE or .LE.
2015 Flag controlling "section-figures".
2016 A non-zero value enables this.
2017 See also register N.
2020 Flag controlling "section-page-numbers".
2021 A non-zero value enables this.
2022 See also register N.
2025 Display indent, default 5.
2028 Indent for \fB.VERBON\fP, default 5n.
2031 Line length, only for command line settings.
2037 The letter macros is using different submacros depending on
2039 The name of the submacro has the letter type
2041 It is therefore possible to define other letter types, either
2042 in the national macro-file, or as local additions.
2043 \&\fB.LT\fP will set the number variables \fBPt\fP and \fBPi\fP to 0 and 5.
2044 The following strings and macros must be defined for a new letter type:
2046 \fBlet@init_\fP\fItype\fP
2047 This macro is called directly by \fB.LT\fP.
2048 It is supposed to initialize
2049 variables and other stuff.
2051 \fBlet@head_\fP\fItype\fP
2052 This macro prints the letter head, and is called instead of the
2054 It is supposed to remove the alias \fBlet@header\fP,
2055 otherwise it will be called for all pages.
2057 \fBlet@sg_\fP\fItype\ name\ title\ n\ flag\ [arg1\ [arg2\ [...]]]\fP
2058 \&\fB.SG\fP is calling this macro only for letters, memorandums has
2060 \fIname\fP and \fItitle\fP is specified
2061 thru \fB.WA\fP/\fB.WB\fP.
2062 \fIn\fP is the counter, 1-max, and
2063 \fIflag\fP is true for the last name.
2064 Any other argument to \fB.SG\fP
2067 \fBlet@fc_\fP\fItype\ closing\fP
2068 This macro is called by \fB.FC\fP, and has the
2069 formal closing as argument.
2071 \&\fB.LO\fP is implemented as a general option-macro.
2073 that a string named \fBLet\fP\fItype\fP is defined, where \fItype\fP
2075 \&\fB.LO\fP will then assign the argument to the string
2076 variable \fBlet*lo-\fP\fItype\fP.
2080 Jörgen Hägg, Lund, Sweden <jh@axis.se>.
2083 .B @MACRODIR@/tmac.@TMAC_M_PREFIX@m
2085 .B @TMAC_MDIR@/*.cov
2089 .B @TMAC_MDIR@/locale
2091 .BR groff (@MAN1EXT@),
2092 .BR @g@troff (@MAN1EXT@),
2093 .BR @g@tbl (@MAN1EXT@),
2094 .BR @g@pic (@MAN1EXT@),
2095 .BR @g@eqn (@MAN1EXT@)
2097 .BR groff_mmse (@MAN7EXT@)
2099 .\" Local Variables:
projects / dragonfly.git / blob