2 .\" $Id: groff_mm.man,v 2.13 2004/07/03 12:46:56 wlemb Exp $
18 .TH GROFF_MM @MAN7EXT@ "@MDATE@" "Groff Version @VERSION@"
20 groff_mm \- groff mm macros
23 .B \-m@TMAC_M_PREFIX@m
31 The groff mm macros are intended to be compatible with the DWB mm macros
32 with the following limitations:
35 no Bell Labs localisms implemented.
38 the macros OK and PM are not implemented.
41 groff mm does not support cut marks
43 \fBm@TMAC_M_PREFIX@m\fP is intended to be international.
45 possible to write short national macrofiles which change all
46 english text to the preferred language.
47 Use \fBm@TMAC_M_PREFIX@mse\fP as an example.
48 .\"########################################################################
50 A file called \fBlocale\fP or \fIlang\fP\fB_locale\fP is read
51 after the initiation of the global variables.
53 possible to localize the macros with companyname and so on.
55 In this manual square brackets is used to show optional arguments.
57 \fBNumber registers and strings\fP
59 Many macros can be controlled by number registers and strings.
60 A number register is assigned with the \fBnr\fP command:
62 \fB\&.nr\fP \fIXXX\fP \fI[+-]n [i]\fP
64 \fBXXX\fP is the name of the register, \fBn\fP is the value to
65 be assigned, and \fBi\fP is increment value for auto-increment.
66 \fBn\fP can have a plus or minus sign as prefix if an increment
67 or decrement of the current value is wanted.
68 (Auto-increment or decrement
69 occurs if the number register is used with a plus or minus sign,
70 \fB\en+[XXX]\fP or \fB\en-[XXX]\fP.)
72 Strings is defined with \fBds\fP.
74 \fB\&.ds\fP \fIYYY string\fP
76 The string is assigned everything to the end of the line, even blanks.
77 Initial blanks in \fIstring\fP should be prefixed with
79 (Strings are used in the text as \fB\e*[YYY]\fP.)
81 \fBSpecial formatting of number registers\fP
83 A number register is printed with normal digits if no format has been
85 Set the format with \fBaf\fP:
89 \fIR\fP is the name of the register, \fIc\fP is the format.
96 000, 001, 002, 003, ...
98 0, i, ii, iii, iv, ...
100 0, I, II, III, IV, ...
102 0, a, b, c, ..., z, aa, ab, ...
104 0, A, B, C, ..., Z, AA, AB, ...
111 Adds \fBtext\fP (heading-text) to the table of contents
112 with \fBlevel\fP either 0
115 This macro is used for customized
119 Begin one column processing.
120 An \fB1\fP as argument disables the page-break.
121 Use wide footnotes, small footnotes may be overprinted.
124 Begin two column processing.
125 Splits the page in two columns.
127 a special case of \fBMC\fP.
131 Abstract end, see \fBAS\fP.
133 .B "AF [name of firm]"
134 Authors firm, should be called before \fBAU\fP, see also \fBCOVER\fP.
136 .B "AL [type [text-indent [1]]]"
137 Start autoincrement list.
138 Items are numbered beginning on one.
139 The \fItype\fP argument controls the type of numbers.
146 Upper-case letters (A-Z)
148 Lower-case letters (a-z)
154 \fIText-indent\fP sets the indent and overrides \fBLi\fP.
155 A third argument will prohibit printing of a blank line before each
159 Begin an appendix with name \fIname\fP.
160 Automatic naming occurs if
162 The appendixes starts with \fBA\fP if auto is used.
163 An new page is ejected, and a header is also produced if the number
164 variable \fBAph\fP is non-zero.
166 The appendix always appear in the 'List of contents' with correct
168 The name \fIAPPENDIX\fP can be changed by setting
169 the string \fBApp\fP to the desired text.
170 The string \fBApptxt\fP contains the current appendix text.
172 .B "APPSK name pages text"
173 Same as \fB.APP\fP, but the pagenr is incremented with \fIpages\fP.
174 This is used when diagrams or other non-formatted documents are
175 included as appendixes.
177 .B "AS [arg [indent]]"
179 Indent is specified in 'ens', but scaling is allowed.
180 Argument \fIarg\fP controls where the abstract is printed.
185 Abstract will be printed on page 1 and on the cover sheet if
186 used in the released-paper style (\fBMT 4\fP), otherwise
187 it will be printed on page 1 without a cover sheet.
189 Abstract will only be printed on the cover sheet (\fBMT 4\fP only).
191 Abstract will be printed only on the cover sheet (other than \fBMT 4\fP only).
192 The cover sheet is printed without need for \fBCS\fP.
194 Abstract is not printed at all in external letters (\fBMT 5\fP).
195 The \fIindent\fP controls the indentation of both margins, otherwise
196 will normal text indent be used.
200 Default is \fBABSTRACT\fP.
201 Sets the text above the abstract text.
203 .B "AT title1 [title2 ...]"
205 \fBAT\fP must appear just after each \fBAU\fP.
206 The title will show up after the name in the signature block.
208 .B "AU [name [initials [loc [dept [ext [room [arg [arg [arg]]]]]]]]]"
209 Author information, specifies the author of the memo or paper, and
210 will be printed on the cover sheet and on other similar places.
211 \fBAU\fP must not appear before \fBTL\fP.
212 The author information
213 can contain initials, location, department, telephone extension,
214 room number or name and up to three extra arguments.
217 Approval signature, generates an approval line with place for
219 The string \fBAPPROVED:\fP can be changed
220 with variable \fBLetapp\fP, and the string \fBDate\fP in \fBLetdate\fP.
223 Letter signature, generates a line with place for signature.
225 .B "B [bold-text [prev-font-text [bold...]]]"
227 No limit on the number of arguments.
228 All arguments will be concatenated to one word, the first, third and so
229 on will be printed in boldface.
232 Begin box (as the ms macro).
233 Draws a box around the text.
234 The text will be indented one character,
235 and the right margin will be one character shorter.
239 Finish the box started by \fBB1\fP.
242 End bottom block, see \fBBS\fP.
244 .B "BI [bold-text [italic-text [bold-text [...]]]]"
246 No limit on the number of arguments, see \fBB\fP.
248 .B "BL [text-indent [1]]"
249 Start bullet list, initialize a list with a bullet and a space
250 in the beginning of each list item (see \fBLI\fP).
252 overrides the default indentation of the list items set by
253 number register \fBPi\fP.
254 A third argument will prohibit printing of a blank line before each
257 .B "BR [bold-text [roman-text [bold-text [...]]]]"
259 No limit on the number of arguments.
263 Begins the definition of a text block which is
264 printed at the bottom of each page.
265 Block ends with \fBBE\fP.
267 .B "BVL text-indent [mark-indent [1]]"
269 broken variable-item list.
270 Broken variable-item list has no fixed mark, it assumes that
271 every \fBLI\fP has a mark instead.
272 The text will always begin at the next line after the mark.
273 \fIText-indent\fP sets the indent to the text, and \fImark-indent\fP
274 the distance from the current indent to the mark.
275 A third argument will prohibit printing of a blank line before each
279 \&\fBCOVER\fP begins a coversheet definition.
281 that \fB.COVER\fP appears before any normal text.
282 \&\fB.COVER\fP uses \fIarg\fP to build the filename
283 @TMAC_MDIR@/\fIarg\fP.cov.
284 Therefore it is possible to create unlimited
285 types of coversheets.
286 \fIms.cov\fP is supposed to look like the \fBms\fP coversheet.
287 \&\fB.COVER\fP requires a \fB.COVEND\fP at the end of the coverdefinition.
288 Always use this order of the covermacros:
299 However, only \fB.TL\fP and \fB.AU\fP are required.
302 This finish the cover description and prints the cover-page.
303 It is defined in the cover file.
307 Ends a block of text, display, that begins
308 with \fBDS\fP or \fBDF\fP.
310 .B "DF [format [fill [rindent]]]"
311 Begin floating display (no nesting allowed).
312 A floating display is saved in a queue and is printed in the
314 \fIFormat\fP, \fIfill\fP and \fIrindent\fP is the same
316 Floating displays are controlled by the two number registers \fBDe\fP
322 Nothing special, this is the default.
324 A page eject will occur after each printed display, giving only
325 one display per page and no text following it.
331 Displays are printed at the end of each section (when section-page
332 numbering is active) or at the end of the document.
334 A new display will be printed on the current page if there is enough
335 space, otherwise it will be printed at the end of the document.
337 One display will be printed at the top of each page or column
338 (in multi-column mode).
340 Print one display if there is enough space for it, otherwise it will
341 be printed at the top of the next page or column.
343 Print as many displays that will fit in a new page or column.
344 A page break will occur between each display if \fBDe\fP is not zero.
346 Fill the current page with displays and the rest beginning at a new page
348 (This is the default.)
349 A page break will occur between each display
350 if \fBDe\fP is not zero.
353 .B "DL [text-indent [1 [1]]]"
355 Begins a list where each item is printed
357 \fIText-indent\fP changes the default indentation
358 of the list items set by
359 number register \fBPi\fP.
360 A second argument prevents the empty line between each list item
363 A third argument will prohibit printing of a blank line before each
366 .B "DS [format [fill [rindent]]]"
367 Static display start.
368 Begins collection of text until \fBDE\fP.
369 The text is printed together on the same page, unless it is longer
370 than the height of the page.
371 \fBDS\fP can be nested to a unlimited depth (reasonably :-).
383 Indent text with the value of number register \fBSi\fP.
387 Center the whole display as a block.
389 Right adjust the lines.
391 Right adjust the whole display as a block
394 L, I, C and CB can also be specified as 0, 1, 2 or 3 for compatibility
401 Line-filling turned off.
403 Line-filling turned off.
405 Line-filling turned off.
407 Line-filling turned on.
410 N and F can also be specified as 0 or 1.
411 An empty line will normally be printed before and after the
413 Setting number register \fBDs\fP to 0 will prevent this.
414 \fIRindent\fP shortens the line length by that amount.
416 .B "EC [title [override [flag [refname]]]]"
418 Sets a title for an equation.
419 The \fIoverride\fP argument
420 change the numbering.
425 \fIoverride\fP is a prefix to the number.
427 \fIoverride\fP is a prefix to the number.
429 \fIoverride\fP is a suffix to the number.
431 \fIoverride\fP replaces the number.
433 \fBEC\fP uses the number register \fBEc\fP as counter.
434 It is possible to use \fB.af\fP to change the format of the number.
435 If number register \fBOf\fP is 1, then the format of title
436 will use a dash instead of a dot after the number.
438 The string \fBLe\fP controls the title of the
439 List of Equations, default is \fILIST OF EQUATIONS\fP.
440 The List of Equations will only be printed if number register \fBLe\fP
442 The string \fBLiec\fP contains the word \fIEquation\fP, wich
443 is printed before the number.
444 If \fIrefname\fP is used, then the equation number is saved with
445 \&\fB.SETR\fP, and can be retrieved with \fB.GETST\fP \fIrefname\fP.
447 Special handling of the title will occur if
448 \fBEC\fP is used inside \fBDS\fP/\fBDE\fP, it will not be
449 affected by the format of \fBDS\fP.
452 Even-page footer, printed just above the normal page footer
453 on even pages, see \fBPF\fP.
456 Even-page header, printed just below the normal page header
457 on even pages, see \fBPH\fP.
460 Equation end, see \fBEQ\fP.
463 End of page user-defined macro.
464 This macro will be called
465 instead of the normal printing of the footer.
467 will be executed in a separate environment, without any
471 \fBStrings available to EOP\fP
474 Argument from \fBPF\fP.
476 Argument from \fBEF\fP.
478 Argument from \fBOF\fP.
481 .B "EPIC [-L] width height [name]"
482 \fBEPIC\fP draws a box with the given \fIwidth\fP and \fIheight\fP, it will
483 also print the text \fIname\fP or a default string if
484 \fIname\fP is not specified..
485 This is used to include external pictures, just give the size
487 \fB-L\fP will leftadjust the picture, the default is to center adjust.
492 \fBEQ\fP/\fBEN\fP are the delimiters for equations written for \fBeqn\fP.
493 \fBEQ\fP/\fBEN\fP must be inside a \fBDS\fP/\fBDE\fP-pair, except
494 when \fBEQ\fP is only used to set options in \fBeqn\fP.
495 The \fIlabel\fP will appear at the right margin of the equation, unless
496 number register \fBEq\fP is\ 1.
497 Then the label will appear at the
500 .B "EX [title [override [flag [refname]]]]"
501 Exhibit title, arguments are the same as for \fBEC\fP.
502 \fBEX\fP uses the number register \fBEx\fP as counter.
503 The string \fBLx\fP controls the title of the
504 List of Exhibits, default is \fILIST OF EXHIBITS\fP.
505 The List of Exhibits will only be printed if number register \fBLx\fP
507 The string \fBLiex\fP contains the word \fIExhibit\fP, which
508 is printed before the number.
509 If \fIrefname\fP is used, then the exhibit number is saved with
510 \&\fB.SETR\fP, and can be retrieved with \fB.GETST\fP \fIrefname\fP.
512 Special handling of the title will occur if
513 \fBEX\fP is used inside \fBDS\fP/\fBDE\fP, it will not be
514 affected by the format of \fBDS\fP.
517 Prints \fIYours\ very\ truly,\fP as a formal closing of a letter or
519 The argument replaces the defualt string.
520 The default is stored in string variable \fBLetfc\fP.
523 Footnote default format.
524 Controls the hyphenation (hyphen), right margin justification (adjust),
525 indentation of footnote text (indent).
526 It can also change the label
527 justification (ljust).
531 .ta .5i +.8i +.8i +.8i +.8i
532 \fBarg hyphen adjust indent ljust\fP
548 Argument greater than or equal to 11 is considered as arg 0.
549 Default for m@TMAC_M_PREFIX@m is 10.
554 .B "FG [title [override [flag [refname]]]]"
555 Figure title, arguments are the same as for \fBEC\fP.
556 \fBFG\fP uses the number register \fBFg\fP as counter.
557 The string \fBLf\fP controls the title of the
558 List of Figures, default is \fILIST OF FIGURES\fP.
559 The List of Figures will only be printed if number register \fBLf\fP
561 The string \fBLifg\fP contains the word \fIFigure\fP, wich
562 is printed before the number.
563 If \fIrefname\fP is used, then the figure number is saved with
564 \&\fB.SETR\fP, and can be retrieved with \fB.GETST\fP \fIrefname\fP.
566 Special handling of the title will occur if
567 \fBFG\fP is used inside \fBDS\fP/\fBDE\fP, it will not be
568 affected by the format of \fBDS\fP.
572 The footnote is ended by \fBFE\fP.
573 Footnotes is normally automatically
574 numbered, the number is available in string \fBF\fP.
575 Just add \fB\e*F\fP in the text.
576 By adding \fIlabel\fP, it is possible
577 to have other number or names on the footnotes.
578 Footnotes in displays is now possible.
579 An empty line separates footnotes, the height of the line
580 is controlled by number register \fBFs\fP, default value is 1.
582 .B "GETHN refname [varname]"
583 Includes the headernumber where the corresponding \fBSETR\fP \fIrefname\fP
585 Will be X.X.X. in pass\ 1.
587 If \fIvarname\fP is used, \fBGETHN\fP sets the stringvariable \fIvarname\fP to the
590 .B "GETPN refname [varname]"
591 Includes the pagenumber where the corresponding \fBSETR\fP \fIrefname\fP
593 Will be 9999 in pass\ 1.
595 If \fIvarname\fP is used, \fBGETPN\fP sets the stringvariable \fIvarname\fP
599 Combines \fBGETHN\fP and \fBGETPN\fP with the text 'chapter' and ', page'.
600 The string \fIQrf\fP contains the text for reference:
602 \&.ds Qrf See chapter \e\e*[Qrfh], page \e\e*[Qrfp].
604 \fIQrf\fP may be changed to support other languages.
605 Strings \fIQrfh\fP and \fIQrfp\fP are set by \fBGETR\fP
606 and contains the page and headernumber.
608 .B "GETST refname [varname]"
609 Includes the string saved with the second argument to \fB.SETR\fP.
610 Will be dummystring in pass 1.
611 If varname is used, \fBGETST\fP sets the stringvariable \fIvarname\fP to the
615 .B "H level [heading-text [heading-suffix]]"
616 Numbered section heading.
617 Section headers can have a level between 1 and 14, level 1 is the
619 The text is given in \fIheading-text\fP, and must be
620 surrounded by double quotes if it contains spaces.
621 \fBHeading-suffix\fP is added to the header in the text but not in
622 the table of contents.
623 This is normally used for footnote marks
625 Don't use \fB\e*F\fP in \fIheading-suffix\fP, it won't
627 A manual label must be used, see \fBFS\fP.
629 An eventual paragraph, \fBP\fP, directly after \fBH\fP will be
630 ignored, \fBH\fP is taking care of spacing and indentation.
632 \fBPage ejection before heading\fP
634 Number register \fBEj\fP controls page ejection before the heading.
635 Normally, a level one heading gets two blank lines before it, higher levels
637 A new page is ejected before each
638 first-level heading if number register \fBEj\fP is 1.
639 All levels below or equal the value of \fBEj\fP gets a new page.
640 Default value for \fBEj\fP is 0.
642 \fBHeading break level\fP
644 A line break occurs after the heading if the heading level is less
645 or equal to number register \fBHb\fP.
648 \fBHeading space level\fP
650 A blank line is inserted after the heading if the heading level is less
651 or equal to number register \fBHs\fP.
654 Text will follow the heading on the same line if the level is greater
655 than both \fBHb\fP and \fBHs\fP.
657 \fBPost-heading indent\fP
659 Indentation of the text after the heading is controlled by number
660 register \fBHi\fP, default value 0.
665 The text will be left-justified.
667 Indentation of the text will follow the value of number register \fBPt\fP,
670 The text will be lined up with the first word of the heading.
673 \fBCentered section headings\fP
675 All headings whose level is equal or below number register \fBHc\fP
676 and also less than or equal to \fBHb\fP or \fBHs\fP
679 \fBFont control of the heading\fP
681 The font of each heading level is controlled by string \fBHF\fP.
682 It contains a fontnumber or fontname for each level.
684 is \fB2\ 2\ 2\ 2\ 2\ 2\ 2\ 2\ 2\ 2\ 2\ 2\ 2\ 2\fP (all headings in italic).
685 Could also be written as \fBI\ I\ I\ I\ I\ I\ I\ I\ I\ I\ I\ I\ I\ I\fP.
686 Note that some other implementations use \fB3\ 3\ 2\ 2\ 2\ 2\ 2\fP as the
688 All omitted values are presumed to be a 1.
690 \fBPoint size control\fP.
692 String \fBHP\fP controls the pointsize of each heading, in the
693 same way as \fBHF\fP controls the font.
694 A value of 0 selects the default point size.
695 Default value is \fB0\ 0\ 0\ 0\ 0\ 0\ 0\ 0\ 0\ 0\ 0\ 0\ 0\ 0\fP.
697 point size changes, not the vertical size.
698 That can be controlled by the user specified macro \fBHX\fP and/or
701 \fBHeading counters\fP
703 Fourteen number registers, named \fBH1\fP thru \fBH14\fP contains
704 the counter for each heading level.
705 The values are printed using arabic numerals, this can be changed
706 with the macro \fBHM\fP (see below).
707 All marks are concatenated before printing.
709 number register \fBHt\fP to\ 1.
710 That will only print the current
711 heading counter at each heading.
713 \fBAutomatic table of contents\fP
715 All headings whose level is equal or below number register \fBCl\fP
716 is saved to be printed in the table of contents.
719 \fBSpecial control of the heading, user-defined macros\fP.
721 These macros can be defined by the user to get a finer control
722 of vertical spacing, fonts or other features.
723 Argument \fIlevel\fP is the level-argument to \fBH\fP, but
724 0 for unnumbered headings (see \fBHU\fP).
725 Argument \fIrlevel\fP is the real level, it is
726 set to number register \fBHu\fP for unnumbered headings.
727 Argument \fIheading-text\fP is the text argument to \fBH\fP and \fBHU\fP.
729 \fBHX\ \fP\fIlevel\ rlevel\ heading-text\fP
731 \fBHX\fP is called just before the printing of the heading.
732 The following register is available for \fBHX\fP.
733 \fBHX\fP may alter \fB}0\fP, \fB}2\fP and \fB;3\fP.
736 Contains the heading mark plus two spaces if \fIrlevel\fP is non-zero,
739 Contains the position of the text after the heading.
740 0 means that the text should follow the heading on the same line, 1
741 means that a line break should occur before the text and
742 2 means that a blank line should separate the heading and the text.
744 Contains two spaces if register \fB;0\fP is\ 0.
746 separate the heading from the text.
748 is empty if \fB;0\fP is non-zero.
750 Contains the needed space in units after the heading.
753 Can be used to change things like numbering (\fB}0\fP),
754 vertical spacing (\fB}2\fP)
755 and the needed space after the heading.
758 \fBHY\ \fP\fIdlevel\ rlevel\ heading-text\fP
760 \fBHY\fP is called after size and font calculations and
761 might be used to change indentation.
763 \fBHZ\ \fP\fIdlevel\ rlevel\ heading-text\fP
765 \fBHZ\fP is called after the printing of the heading, just before
766 \fBH\fP or \fBHU\fP exits.
767 Could be used to change the page header according to the section heading.
769 .B "HC [hyphenation-character]"
770 Set hyphenation character.
771 Default value is \e%.
772 Resets to the default if called without argument.
773 Hyphenation can be turned off by setting number
774 register \fBHy\fP to 0 in the beginning of the file.
776 .B "HM [arg1 [arg2 [... [arg14]]]]"
778 Controls the type of marking for printing of the heading counters.
779 Default is 1 for all levels.
786 Arabic numerals with leading zeroes, one or more.
788 Upper-case alphabetic
790 Lower-case alphabetic
792 Upper-case roman numerals
794 lower-case roman numerals
800 Unnumbered section header.
801 \fBHU\fP behavies like \fBH\fP at the level in number register \fBHu\fP.
804 .B "HX dlevel rlevel heading-text"
805 Userdefined heading exit.
806 Called just before printing the header.
809 .B "HY dlevel rlevel heading-text"
810 Userdefined heading exit.
811 Called just before printing the header.
814 .B "HZ dlevel rlevel heading-text"
815 Userdefined heading exit.
816 Called just after printing the header.
819 .B "I [italic-text [prev-font-text [italic-text [...]]]]"
821 Changes the font to italic if called without arguments.
822 With one argument it will set the word in italic.
823 With two argument it will concatenate them and set the first
824 word in italic and the second in the previous font.
825 There is no limit on the number of argument, all will be concatenated.
827 .B "IA [addressee-name [title]]"
828 Begins specification of the addressee and addressee's address in
830 Several names can be specified with empty \fBIA\fP/\fBIE\fP-pairs, but
834 .B "IB [italic-text [bold-text [italic-text [...]]]]"
836 Even arguments is printed in italic, odd in boldface.
840 Ends the address-specification after \fPIA\fP.
842 .B "INITI type filename [macro]"
843 Initialize the new index system, sets the filename to collect
844 index lines in with \fBIND\fP.
845 Argument \fItype\fP selects
846 the type of index, page number, header marks or both.
847 The default is \fIN\fP.
849 It is also possible to create a macro that is responsible
850 for formatting each row.
851 Add the name of the macro as argument\ 3.
852 The macro will be called with the index as argument(s).
861 Both page numbers and header marks, tab separated
865 Initialize the refencemacros.
866 References will be written to stderr and is supposed to
867 be written to \fIfilename.qrf\fP.
868 Requires two passes with groff, this is handled by a
869 separate program called \fBmmroff\fP, the reason is that
870 groff is often installed without the unsafe operations that
871 \fBINITR\fP requiered.
872 The first pass looks for references and the second one includes them.
873 \fBINITR\fP can be used several times, but it is only the first
874 occurrence of \fBINITR\fP that is active.
876 See also \fBSETR\fP, \fBGETPN\fP and \fBGETHN\fP.
878 .B "IND arg1 [arg2 [...]]"
879 \fBIND\fP writes a line in the index file selected by \fBINITI\fP
880 with all arguments and the page number or header mark separated by tabs.
886 arg1\etarg2\etpage number
890 arg1\etpage number\etheader mark
894 \fBINDP\fP prints the index by running the command specified
895 by string variable \fBIndcmd\fP, normally \fIsort\ -t\et\fP.
896 \fBINDP\fP reads the output from the command to form
897 the index, normally in two columns (can be changed by defining \fBTYIND\fP).
898 The index is printed with string variable \fBIndex\fP as header,
899 default is \fBINDEX\fP.
900 One-column processing is
901 returned after the list.
902 \fBINDP\fP will call the
903 user-defined macros \fBTXIND\fP, \fBTYIND\fP and \fBTZIND\fP if defined.
904 \fBTXIND\fP is called before printing \fBINDEX\fP, \fBTYIND\fP
905 is called instead of printing \fBINDEX\fP.
906 \fBTZIND\fP is called
907 after the printing and should take care of restoring to normal
911 \fBISODATE\fP changes the predefined date string in \fBDT\fP to
912 ISO-format, ie YYYY-MM-DD.
913 This can also be done by
914 adding \fB-rIso=1\fP on the command line.
915 Reverts to old date format if argument is \fB0\fP.
917 .B "IR [italic-text [roman-text [italic-text [...]]]]"
919 Even arguments is printed in italic, odd in roman.
922 .B "LB text-indent mark-indent pad type [mark [LI-space [LB-space]]]"
924 This is the common macro used for all lists.
925 \fIText-indent\fP is the number of spaces to indent the text from the
928 \fIPad\fP and \fImark-indent\fP controls where to put the mark.
929 The mark is placed within the mark area, and \fImark-indent\fP
930 sets the number of spaces before this area.
932 The mark area ends where the text begins.
933 The start of the text
934 is still controlled by \fItext-indent\fP.
936 The mark is left justified whitin the mark area if \fIpad\fP is 0.
937 If \fIpad\fP is greater than 0, then \fImark-indent\fP is ignored, and
938 the mark is placed \fIpad\fP spaces before the text.
939 This will right justify the mark.
941 If \fItype\fP is 0 the list will have either a hanging indent or, if
942 argument \fImark\fP is given, the string \fImark\fP as mark.
944 If \fItype\fP is greater than 0 automatic numbering will occur, arabic
945 if \fImark\fP is empty.
946 \fIMark\fP can then be any of \fB1\fP, \fBA\fP,
947 \fBa\fP, \fBI\fP or \fBi\fP.
949 \fIType\fP selects one of six possible ways to display the mark.
967 Every item in the list will get \fILI-space\fP number of blank lines
971 \fBLB\fP itself will print \fILB-space\fP blank lines.
976 Terminates all current active lists down to \fIlist-level\fP, or 0
977 if no argmuent is given.
978 This is used by \fBH\fP to clear any
983 Terminate the current list.
984 \fBLE\fP outputs a blank line
985 if an argument is given.
988 List item precedes every item in a list.
989 Without argument \fBLI\fP
990 will print the mark determined by the current list type.
992 \fBLI\fP one argument, it will use that as the mark instead.
993 Two arguments to \fBLI\fP will make \fImark\fP a prefix to
995 There will be no separating space between the prefix
996 and the mark if the second argument is \fB2\fP instead of \fB1\fP.
997 This behaviour can also be achieved by setting number register
999 A zero length \fImark\fP will make a hanging
1002 A blank line is normally printed before the list item.
1004 can be controlled by number register \fBLs\fP.
1006 will occur for each list-level less than or equal to \fBLs\fP.
1007 Default value is\ 99.
1008 (Nesting of lists is unlimited.\ :-)
1010 The indentation can be changed thru number register \fBLi\fP.
1013 All lists begins with a list initialization macro, \fBLB\fP.
1014 There are, however, seven predefined listtypes to
1015 make lists easier to use.
1016 They all call \fBLB\fP with different
1020 Automatically Incremented List
1032 Broken Varable List.
1034 These lists are described at other places in this manual.
1038 Formats a letter in one of four different styles depending
1040 See also \fBINTERNALS\fP.
1046 Date line, return address, writer's address and closing
1047 begins at the center of the line.
1048 All other lines begin at the left margin.
1051 Same as blocked, except that the first line in every
1052 paragraph is indented five spaces.
1055 All lines begin at the left margin.
1058 Almost the same as the full-blocked style.
1060 the writer's identification are printed in all-capital.
1064 Specify options in letter (see \fB.LT\fP).
1065 This is a list of the standard options:
1068 Confidential notation.
1069 Prints \fBCONFIDENTIAL\fP on the second line
1070 below the date line.
1071 Any argument replaces \fBCONFIDENTIAL\fP.
1072 See also string variable \fBLetCN\fP.
1075 Prints \fBIn reference to:\fP and the argument
1076 two lines below the date line.
1077 See also string variable \fBLetRN\fP.
1080 Prints \fBATTENTION:\fP and the argument below the inside address.
1081 See also string variable \fBLetAT\fP.
1084 Prints \fBTo Whom It May Concern:\fP or the argument if
1086 The salutation is printed two lines below the inside address.
1087 See also string variable \fBLetSA\fP.
1090 Prints the argument as subject prefixed with \fBSUBJECT:\fP
1091 two lines below the inside address, except in letter type \fBSP\fP.
1092 Then the subject is printed in all-captial without any prefix.
1093 See also string variable \fBLetSJ\fP.
1096 .B "MC column-size [column-separation] "
1097 Begin multiple columns.
1098 Return to normal with \fB1C\fP.
1099 \fBMC\fP will create as many columns as the current line length permits.
1100 \fIColumn-size\fP is the width of each column, and \fIcolumn-separation\fP
1101 is the space between two columns.
1102 Default separation is the
1106 .B "ML mark [text-indent [1]]"
1108 The \fImark\fP argument will be printed before
1110 \fIText-indent\fP sets the indent and overrides \fBLi\fP.
1111 A third argument will prohibit printing of a blank line before each
1114 .B "MT [arg [addressee]]"
1116 The \fIarg\fP is part of a filename in \fI@TMAC_MDIR@/*.MT\fP.
1117 Memorandum type 0 thru 5 are supported, including \fI"string"\fP.
1118 \fIAddressee\fP just sets a variable, used in the AT&T macros.
1123 Normal memorandum, no type printed
1125 Memorandum with \fIMEMORANDUM FOR FILE\fP printed
1127 Memorandum with \fIPROGRAMMER'S NOTES\fP printed
1129 Memorandum with \fIENGINEER'S NOTES\fP printed
1131 Released paper style
1133 External letter style
1135 See also \fBCOVER\fP/\fBCOVEND\fP, a more flexible type of front page.
1137 .B "MOVE y-pos [x-pos [line-length]]"
1138 Move to a position, pageoffset set to \fIx-pos\fP.
1139 If \fIline-length\fP is not given, the difference between
1140 current and new pageoffset is used.
1141 Use \fBPGFORM\fP without arguments to return to normal.
1143 .B "MULB cw1 space1 [cw2 space2 [cw3 ...]]"
1144 Begin a special multi-column mode.
1145 Every columns width must be specified.
1146 Also the space between the columns must be specified.
1148 does not need any space-definition.
1149 \fBMULB\fP starts a diversion and \fBMULE\fP
1150 ends the diversion and prints the columns.
1151 The unit for width and space is 'n', but \fBMULB\fP accepts all
1152 normal unitspecifications like 'c' and 'i'.
1153 \fBMULB\fP operates in a separate environment.
1156 Begin the next column.
1157 This is the only way to switch column.
1160 End the multi-column mode and print the columns.
1163 Print numbered paragraph with header level two.
1167 Force printing to the next column, don't use this together with
1168 the \fBMUL*\fP macros, see \fB2C\fP.
1171 Prints different types of notations.
1172 The argument selects between
1173 the predefined type of notations.
1174 If the second argument is available,
1175 then the argument becomes the entire notation.
1176 If the argument doesn't exist in the predefined, it will be
1177 printed as \fBCopy (\fP\fIarg\fP\fB) to\fP.
1178 It is possible to add more standard notations, see the string variable
1179 \fBLetns\fP and \fBLetnsdef\fP.
1189 Copy To (with att.) to
1191 Copy To (without att.) to
1201 Under separate cover
1207 Copy (with atts.) to
1209 Copy (without atts.) to
1213 Complete Memorandum to
1221 Override the current date.
1223 printed if \fInew-date\fP is an empty string.
1226 Odd-page footer, a line printed just above the normal footer.
1227 See \fBEF\fP and \fBPF\fP.
1230 Odd-page header, a line printed just below the normal header.
1231 See \fBEH\fP and \fBPH\fP.
1234 Make sure that the following text is printed at the top
1235 of an odd-numbered page.
1236 Will not output an empty page
1237 if currently at the top of an odd page.
1240 Begin new paragraph.
1241 \fBP\fP without argument will produce left justified text, even
1242 the first line of the paragraph.
1243 This is the same as setting
1245 If the argument is\ 1, then the first line
1246 of text following \fBP\fP will be indented by the number of
1247 spaces in number register \fBPi\fP, normally 5.
1249 Instead of giving 1 as argument to \fBP\fP it is possible to set the
1250 paragraph type in number register \fBPt\fP.
1252 will be the same as adding that value to \fBP\fP.
1253 A value of 2 will indent all paragraphs, except after
1254 headings, lists and displays.
1256 The space between two paragraphs is controlled by number register \fBPs\fP,
1257 and is 1 by default (one blank line).
1259 .B "PGFORM [linelength [pagelength [pageoffset [1]]]]"
1260 Sets linelength, pagelength and/or pageoffset.
1261 This macro can be used for special formatting, like letterheads
1263 It is normally the first command in a file, though it's not necessary.
1264 \fBPGFORM\fP can be used without arguments
1265 to reset everything after a \fBMOVE\fP.
1266 A line-break is done unless the fourth argument is given.
1267 This can be used to avoid the pagenumber on the first page while setting
1268 new width and length.
1269 (It seems as if this macro sometimes doesn't work too well.
1270 Use the command line arguments
1271 to change linelength, pagelength and pageoffset instead.
1275 No header is printed on the next page.
1277 the header in letters or other special texts.
1278 This macro must be used before any text to inhibit the pageheader
1281 .B "PIC [-L] [-C] [-R] [-I n] filename [width [height]]"
1282 \fBPIC\fP includes a Postscript file in the document.
1283 The macro depends on \fBmmroff\fP and \fBINITR\fP.
1284 \fB-L\fP, \fB-C\fP, \fB-R\fP and \fB-I n\fP adjusts the picture
1286 The optionally \fIwidth\fP and \fIheight\fP
1287 can also be given to resize the picture.
1291 Ends a picture for \fB@TMAC_M_PREFIX@pic\fP, see the manual for \fB@TMAC_M_PREFIX@pic\fP.
1295 \fBPF\fP sets the line to be printed at the bottom of each page.
1297 See \fBPH\fP for the argument specification.
1300 Page header, a line printed at the top of each page.
1301 The argument should be specified as "'left-part'center-part'right-part'",
1302 where left-, center- and right-part is printed left-justified, centered
1303 and right justified.
1304 The character \fB%\fP is changed to the current
1306 The default page-header is "''- % -''", the page
1307 number between two dashes.
1310 Picture start (from pic).
1311 Begins a picture for \fB@g@pic\fP, see
1315 Page-header user-defined exit.
1316 \fBPX\fP is called just after the printing of the page header
1317 in \fIno-space\fP mode.
1321 Return to roman font, see also \fBI\fP.
1323 .B "RB [roman-text [bold-text [roman-text [...]]]]"
1325 Even arguments is printed in roman, odd in boldface.
1328 .B "RD [prompt [diversion [string]]]"
1329 Read from standard input to diversion and/or string.
1330 The text will be saved in a diversion named \fIdiversion\fP.
1331 Recall the text by writing the name of the diversion after a dot
1333 A string will also be defined if
1334 \fIstring\fP is given.
1335 \fIDiversion\fP and/or \fIprompt\fP can
1340 Ends a reference definition and returns to normal
1344 .B "RI [roman-text [italic-text [roman-text [...]]]]"
1345 Even arguments are printed in roman, odd in italic.
1348 .B "RL [text-indent [1]]"
1349 Reference list start.
1350 Begins a list where each item is preceded with a automatically
1351 incremented number between
1353 \fIText-indent\fP changes the default indentation.
1355 .B "RP [arg1 [arg2]]"
1356 Produce reference page.
1357 \fBRP\fP can be used if a reference page is wanted somewhere in the
1359 It is not needed if \fBTC\fP is used to produce
1361 The reference page will then be printed automatically.
1363 The reference counter will not be reset if \fIarg1\fP is 1.
1365 \fIArg2\fP tells \fBRP\fP whether to eject a page or not.
1370 The reference page will be printed on a separate page.
1374 Do not eject page after the list.
1376 Do not eject page before the list.
1378 Do not eject page before and after the list.
1380 The reference items will be separated by a blank line.
1381 Setting number register \fBLs\fP to 0 will suppress the line.
1383 The string \fBRp\fP contains the reference page title and
1384 is normally set to \fIREFERENCES\fP.
1386 .B "RS [string-name]"
1387 \fBRS\fP begins an automatically numbered reference definition.
1388 Put the string \fB\e*(Rf\fP where the reference mark
1389 should be and write the reference between \fBRS\fP/\fBRF\fP
1390 at next new line after the reference mark.
1391 The reference number
1392 is stored in number register \fB:R\fP.
1393 If \fIstring-name\fP is given, a string with that name
1394 will be defined and contain the current reference mark.
1395 The string can be referenced as \fB\e*[\fIstring-name\fP]\fP later in
1398 .B "S [size [spacing]]"
1399 Set point size and vertical spacing.
1400 If any argument is equal 'P', then
1401 the previous value is used.
1402 A 'C' means current value, and 'D' default value.
1403 If '+' or '-' is used before the value, then increment or decrement of
1404 the current value will be done.
1407 Set right-margin justification.
1408 Justification is normally turned on.
1409 No argumenent or \fB0\fP turns off justification, a \fB1\fP turns on
1412 .B "SETR refname [string]"
1413 Remember the current header and page-number as \fIrefname\fP.
1414 Saves \fIstring\fP if \fIstring\fP is defined.
1415 \fIstring\fP is retrieved
1421 Prints the authors name(s) after the formal closing.
1422 The argument will be appended to the reference data, printed
1423 at either the first or last author.
1424 The reference data is the location,
1425 department and initials specified with \fB.AU\fP.
1426 It will be printed at the first author if the second argument is given,
1427 otherwise at the last.
1428 No reference data will be printed if the author(s) is specifed
1429 thru \fB.WA\fP/\fB.WE\fP.
1430 See \fBINTERNALS\fP.
1434 If \fIpages\fP is \fB0\fP or omitted, a skip to the next page
1435 will occur unless it is already at the top of a page.
1436 Otherwise it will skip \fIpages\fP pages.
1438 .B "SM string1 [string2 [string3]]"
1439 Make a string smaller.
1440 If \fIstring2\fP is given, \fIstring1\fP will be smaller and \fIstring2\fP
1441 normal, concatenated with \fIstring1\fP.
1442 With three argument, all is
1443 concatenated, but only \fIstring2\fP is made smaller.
1447 \fIlines\fP can have any scalingfactor, like \fI3i\fP or
1449 Several \fBSP\fP in a line will only produce the
1450 maximum number of lines, not the sum.
1451 \fBSP\fP will also be ignored
1452 until the first textline in a page.
1453 Add a \fB\e&\fP before \fBSP\fP
1457 reset tabs to every\ 5n.
1458 Normally used to reset any previous tabpositions.
1460 .B "TB [title [override [flag [refname]]]]"
1461 Table title, arguments are the same as for \fBEC\fP.
1462 \fBTB\fP uses the number register \fBTb\fP as counter.
1463 The string \fBLt\fP controls the title of the
1464 List of Tables, default is \fILIST OF TABLES\fP.
1465 The List of Tables will only be printed if number register \fBLt\fP
1467 The string \fBLitb\fP contains the word \fITABLE\fP, wich
1468 is printed before the number.
1470 Special handling of the title will occur if
1471 \fBTB\fP is used inside \fBDS\fP/\fBDE\fP, it will not be
1472 affected by the format of \fBDS\fP.
1474 .B "TC [slevel [spacing [tlevel [tab [h1 [h2 [h3 [h4 [h5]]]]]]]]]"
1476 This macro is normally used at the last line of the document.
1477 It generates a table of contents with headings up to the level
1478 controlled by number register \fBCl\fP.
1479 Note that \fBCl\fP controls
1480 the saving of headings, it has nothing to do with \fBTC\fP.
1481 Headings with level less than or equal to \fIslevel\fP will get
1482 \fIspacing\fP number of lines before them.
1483 Headings with level less than or equal to \fItlevel\fP will have
1484 their page numbers right justified with dots or spaces separating
1485 the text and the page number.
1486 Spaces is used if \fItab\fP
1487 is greater than zero, otherwise dots.
1488 Other headings will have the
1489 page number directly at the end of the heading text (\fIragged right\fP).
1491 The rest of the arguments will be printed, centered, before the
1494 The user-defined macros \fBTX\fP and \fBTY\fP are used if \fBTC\fP is called
1495 with at most four arguments.
1496 \fBTX\fP is called before the printing
1497 of \fICONTENTS\fP, and \fBTY\fP is called instead of printing \fICONTENTS\fP.
1499 Equivalent macros can be defined for list of figures, tables, equations
1500 and excibits by defining \fBTXxx\fP or \fBTYxx\fP, where \fBxx\fP
1501 is \fBFg\fP, \fBTB\fP, \fBEC\fP or \fBEX\fP.
1503 String \fBCi\fP can be set to control the indentations for each heading-level.
1504 It must be scaled, like \fB.ds\ Ci\ .25i\ .5i\ .75i\ 1i\ 1i\fP.
1505 The indentation is normally controlled by the maxlength of headings
1508 All texts can be redefined, new stringvariables
1509 \fILifg\fP, \fILitb\fP, \fILiex\fP, \fILiec\fP and \fILicon\fP contain
1510 "Figure", "TABLE", "Exhibit", "Equation" and "CONTENTS".
1511 These can be redefined to other languages.
1520 \fBTH\fP ends the header of the table.
1522 be printed again if a page-break occurs.
1523 Argument \fIN\fP isn't implemented yet.
1525 .B TL [charging-case number(s) [filing-case number(s)]]
1526 Begin title of memorandum.
1527 All text up to the next \fBAU\fP is included in the title.
1528 \fICharging-case number\fP and \fIfiling-case\fP are saved
1529 for use in the front page processing.
1531 .B TM [num1 [num2 [...]]]
1532 Technical memorandumnumbers used in \fB.MT\fP.
1534 of arguments may be given.
1537 Top of page user-defined macro.
1538 This macro is called instead of the normal page header.
1540 possible to get complete control over the header.
1541 Note that header and footer is printed in a separate environment.
1542 Linelength is preserved though.
1546 This is the start of a table specification
1548 See separate manual for \fB@g@tbl\fP.
1549 \fBTS\fP ends with \fBTE\fP.
1550 Argument \fIH\fP tells \fBm@TMAC_M_PREFIX@m\fP that the table
1555 Userdefined table of contents exit.
1556 This macro is called just before \fBTC\fP prints the word \fICONTENTS\fP.
1560 Userdefined table of contents exit (no "CONTENTS").
1561 This macro is called instead of printing \fICONTENTS\fP.
1564 .B VERBON [flag [pointsize [font]]]
1565 Begin verbatim output using courier font.
1566 Usually for printing programs.
1567 All character has equal width.
1568 The pointsize can be changed with
1569 the second argument.
1570 By specifying the font-argument
1571 it is possible to use another font instead of courier.
1572 \fIflag\fP controls several special features.
1573 It contains the sum of all wanted features.
1578 Disable the escape-character (\e).
1579 This is normally turned on during
1582 Add an empty line before the verbose text.
1584 Add an empty line after the verbose text.
1586 Print the verbose text with numbered lines.
1587 This adds four digitsized
1588 spaces in the beginning of each line.
1589 Finer control is available with
1590 the string-variable \fBVerbnm\fP.
1591 It contains all arguments to the
1592 \fBtroff\fP-command \fB.nm\fP, normally '1'.
1594 Indent the verbose text with five 'n':s.
1595 This is controlled by the
1596 number-variable \fBVerbin\fP (in units).
1600 End verbatim output.
1602 .B "VL text-indent [mark-indent [1]]"
1603 Variable-item list has no fixed mark, it assumes that
1604 every \fBLI\fP have a mark instead.
1605 \fIText-indent\fP sets the indent to the text, and \fImark-indent\fP
1606 the distance from the current indent to the mark.
1607 A third argument will prohibit printing of a blank line before each
1610 .B "VM [-T] [top [bottom]]"
1611 Vertical margin. Adds extra vertical top and margin space.
1612 Option \fB-T\fP set the total space instead.
1613 No argument resets the margin to zero or the default
1614 \fI(7v 5v)\fP if \fB-T\fP
1615 was used. It is higly recommended that macro \fBTP\fP and/or
1616 \fBEOP\fP are defined
1617 if using \fB-T\fP and setting top and/or bottom margin to less than the default.
1619 .B "WA [writer-name [title]]"
1620 Begins specification of the writer and writer's address.
1621 Several names can be specified with empty \fBWA\fP/\fBWE\fP-pairs, but
1625 Ends the address-specification after \fP.WA\fP.
1628 Footnote and display width control.
1631 Set default mode, \fB-WF\fP, \fB-FF\fP, \fB-WD\fP and \fBFB\fP.
1633 Wide footnotes, wide also in two-column mode.
1635 Normal footnote width, follow column mode.
1637 All footnotes gets the same width as the first footnote encountered.
1639 Normal footnotes, width follows \fBWF\fP and \fB-WF\fP.
1641 Wide displays, wide also in two-column mode.
1643 Normal display width, follow column mode.
1645 Floating displays generates a line break when printed on the current page.
1647 Floating displays does not generate line break.
1651 .\"########################################################################
1653 .B "Strings used in m@TMAC_M_PREFIX@m:"
1656 A string containing the word "APPENDIX".
1659 The current appendix text.
1665 Will be updated by \fB.H\fP and \fB.HU\fP to the current heading text.
1666 Also updated in table of contents & friends.
1669 Fontlist for headings, normally "2 2 2 2 2 2 2".
1670 Nonnumeric fontnames may also be used.
1673 Pointsize list for headings.
1674 Normally "0 0 0 0 0 0 0" which is the same as
1675 "10 10 10 10 10 10 10".
1678 Contains \fIINDEX\fP.
1681 Contains the index command, \fIsort\ -t\et\fP.
1684 String containing \fIFigure\fP.
1687 String containing \fITABLE\fP.
1690 String containing \fIExhibit\fP.
1693 String containing \fIEquation\fP.
1696 String containing \fICONTENTS\fP.
1699 Contains "LIST OF FIGURES".
1702 Contains "LIST OF TABLES".
1705 Contains "LIST OF EXHIBITS".
1708 Contains "LIST OF EQUATIONS".
1711 Contains "Yours very truly,", used in \fB.FC\fP.
1714 Contains "APPROVED:", used in \fB.AV\fP.
1717 Contains "Date", used in \fB.AV\fP.
1720 Contains "CONFIDENTIAL", used in \fB.LO CN\fP.
1723 Contains "To Whom It May Concern:", used in \fB.LO SA\fP.
1726 Contains "ATTENTION:", used in \fB.LO AT\fP.
1729 Contains "SUBJECT:", used in \fB.LO SJ\fP.
1732 Contains "In reference to:", used in \fB.LO RN\fP.
1735 is an array containing the different strings used in \fB.NS\fP.
1736 It is really a number of stringvariables prefixed with \fBLetns!\fP.
1737 If the argument doesn't exist, it will be included
1738 between \fB()\fP with \fBLetns!copy\fP as prefix and \fBLetns!to\fP as suffix.
1739 Observe the space after \fBcopy\fP and before \fBto\fP.
1744 Letns!1 Copy (with att.) to
1745 Letns!2 Copy (without att.) to
1750 Letns!7 Under separate cover
1752 Letns!9 Memorandum to
1753 Letns!10 Copy (with atts.) to
1754 Letns!11 Copy (without atts.) to
1755 Letns!12 Abstract Only to
1756 Letns!13 Complete Memorandum to
1763 Defines the standard-notation used when no argument is given
1768 Strings containing \fIJanuary\fP thru \fIDecember\fP.
1771 String containing "See chapter \e\e*[Qrfh], page \e\en[Qrfp].".
1774 Contains "REFERENCES".
1777 Contains current status of table of contents and list of XXXX.
1778 Empty outside \fB.TC\fP.
1779 Useful in user-defined macros like \fB.TP\fP.
1783 co Table of contents
1786 ec List of equations
1793 Contains \e(tm, trade mark.
1796 Argument to \fB.nm\fP in \fB.VERBON\fP, default: \fB1\fP.
1797 .\"-----------------------------------
1799 .B "Number variables used in m@TMAC_M_PREFIX@m:"
1802 Print an appendix-page for every new appendix
1803 if this numbervariable is non-zero.
1804 No output will occur if \fBAph\fP is zero, but there will always
1805 be an appendix-entry in the 'List of contents'.
1808 Contents level [0:14], contents saved if heading level <= Cl, default 2.
1811 Eject page between LIST OF XXXX if Cp == 0, default 0.
1814 Debugflag, values >0 produces varying degree of debug.
1816 gives information about the progress of formatting, default\ 0.
1819 Eject after floating display is output [0:1], default\ 0.
1822 Controls the space output before and after static displays
1824 Otherwise is the value of Lsp used.
1827 Floating keep output [0:5], default 5.
1830 \fBLsp\fP space before and after display if == 1 [0:1], default 1.
1833 Eject page, default 0.
1836 Equation lable adjust 0=left, 1=right.
1840 Footnote spacing, default 1.
1846 Append a dot after the level one heading number if >\ 0.
1850 Copy of number register \fBH1\fP, but it is incremented
1851 just before the page break.
1852 Useful in user defined header macros.
1855 Heading break level [0:14], default\ 2.
1858 Heading centering level, [0:14].
1862 Heading temporary indent [0:2], default\ 1.
1864 0\ ->\ 0 indent, left margin
1866 1\ ->\ indent to right , like .P 1
1868 2\ ->\ indent to line up with text part of preceding heading
1871 Number variable with the heading pre-space level.
1872 If the heading-level
1873 is less than or equal to \fBHps\fP, then two lines will precede the
1874 section heading instead of one.
1875 Default is first level only.
1876 The real amount of lines is controlled by the variables \fBHps1\fP and
1880 This is the number of lines preceding \fB.H\fP when the heading-level
1881 is greater than \fBHps\fP.
1882 Value is in units, normally 0.5.
1885 This is the number of lines preceding \fB.H\fP when the heading-level
1886 is less than or equal to \fBHps\fP.
1887 Value is in units, normally\ 1.
1890 Heading space level [0:14], default\ 2.
1893 This is the number of lines that follows \fB.H\fP when the heading-level
1894 is less than or equal to \fBHs\fP.
1895 Value is in units, normally\ 1.
1898 Heading numbering type, default 0.
1899 0 -> multiple (1.1.1 ...)
1904 Unnumbered heading level, default 2.
1907 Hyphenation in body, default 0.
1909 0\ ->\ no hyphenation
1911 1\ ->\ hyphenation 14 on
1914 Set this variable to 1 on the command line to get ISO-formatted date string.
1916 Useless inside a document.
1919 Page length, only for command line settings.
1922 Max lines in return-address, used in \fB.WA\fP/\fB.WE\fP.
1926 Enables (1) or disables (0) the printing of List of figures,
1927 List of tables, List of exhibits and List of equations.
1928 Default: Lf=1, Lt=1, Lx=1, Le=0.
1931 List indent, used by .AL, default 6.
1934 Flag for space between prefix and mark in automatic lists (.AL).
1941 List space, if current listlevel > Ls then no spacing will occur around lists.
1945 The size of an empty line.
1946 Normally 0.5v, but it is 1v
1947 if \fBn\fP is set (\fB.nroff\fP).
1950 Numbering style [0:5], default 0.
1952 0\ ==\ (default) normal header for all pages.
1954 1\ ==\ header replaces footer on first page, header is empty.
1956 2\ ==\ page header is removed on the first page.
1958 3\ ==\ "section-page" numbering enabled.
1960 4\ ==\ page header is removed on the first page.
1962 5\ ==\ "section-page" and "section-figure" numbering enabled.
1963 See also the number-register Sectf and Sectp.
1966 Numbered paragraphs, default 0.
1970 1\ ==\ numbered in first level headings.
1973 Page offset, only for command line settings.
1976 Format of figure,table,exhibit,equation titles, default 0.
1983 Current page-number, normally the same as % unless "section-page" numbering
1987 paragraph indent, default 5.
1990 Controls whether header and footer pointsize should follow the current
1991 setting or just change when the header and footer is defined.
1997 Pointsize will only change to the current setting when \fB.PH\fP, \fB.PF\fP,
1998 \&\fB.OH\fP, \fP.EH\fP, \fB.OF\fP or \fB.OE\fP is executed.
2000 Pointsize will change after every \fB.S\fP.
2001 This is the default.
2005 paragraph spacing, default 1.
2008 Paragraph type, default 0.
2010 0\ ==\ left-justified
2014 2\ ==\ indented .P except after .H, .DE or .LE.
2017 Flag controlling "section-figures".
2018 A non-zero value enables this.
2019 See also register N.
2022 Flag controlling "section-page-numbers".
2023 A non-zero value enables this.
2024 See also register N.
2027 Display indent, default 5.
2030 Indent for \fB.VERBON\fP, default 5n.
2033 Line length, only for command line settings.
2039 The letter macros is using different submacros depending on
2041 The name of the submacro has the letter type
2043 It is therefore possible to define other letter types, either
2044 in the national macro-file, or as local additions.
2045 \&\fB.LT\fP will set the number variables \fBPt\fP and \fBPi\fP to 0 and 5.
2046 The following strings and macros must be defined for a new letter type:
2048 \fBlet@init_\fP\fItype\fP
2049 This macro is called directly by \fB.LT\fP.
2050 It is supposed to initialize
2051 variables and other stuff.
2053 \fBlet@head_\fP\fItype\fP
2054 This macro prints the letter head, and is called instead of the
2056 It is supposed to remove the alias \fBlet@header\fP,
2057 otherwise it will be called for all pages.
2059 \fBlet@sg_\fP\fItype\ name\ title\ n\ flag\ [arg1\ [arg2\ [...]]]\fP
2060 \&\fB.SG\fP is calling this macro only for letters, memorandums has
2062 \fIname\fP and \fItitle\fP is specified
2063 thru \fB.WA\fP/\fB.WB\fP.
2064 \fIn\fP is the counter, 1-max, and
2065 \fIflag\fP is true for the last name.
2066 Any other argument to \fB.SG\fP
2069 \fBlet@fc_\fP\fItype\ closing\fP
2070 This macro is called by \fB.FC\fP, and has the
2071 formal closing as argument.
2073 \&\fB.LO\fP is implemented as a general option-macro.
2075 that a string named \fBLet\fP\fItype\fP is defined, where \fItype\fP
2077 \&\fB.LO\fP will then assign the argument to the string
2078 variable \fBlet*lo-\fP\fItype\fP.
2082 Jörgen Hägg, Lund, Sweden <jh@axis.se>.
2085 .B @MACRODIR@/tmac.@TMAC_M_PREFIX@m
2087 .B @TMAC_MDIR@/*.cov
2091 .B @TMAC_MDIR@/locale
2093 .BR groff (@MAN1EXT@),
2094 .BR @g@troff (@MAN1EXT@),
2095 .BR @g@tbl (@MAN1EXT@),
2096 .BR @g@pic (@MAN1EXT@),
2097 .BR @g@eqn (@MAN1EXT@)
2099 .BR groff_mmse (@MAN7EXT@)
2101 .\" Local Variables:
projects / dragonfly.git / blob