2
.\" $Id: groff_mm.man,v 2.2 2001/06/27 12:47:16 wlemb 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 is not implemented.
39
groff mm does not support cut marks
41
\fBm@TMAC_M_PREFIX@m\fP is intended to be international. Therefore it is
42
possible to write short national macrofiles which change all
43
english text to the preferred language. Use \fBm@TMAC_M_PREFIX@mse\fP as an example.
44
.\"########################################################################
46
A file called \fBlocale\fP or \fIlang\fP\fB_locale\fP is read
47
after the initiation of the global variables. It is therefore
48
possible to localize the macros with companyname and so on.
50
In this manual square brackets is used to show optional arguments.
52
\fBNumber registers and strings\fP
54
Many macros can be controlled by number registers and strings.
55
A number register is assigned with the \fBnr\fP command:
57
\fB\&.nr\fP \fIXXX\fP \fI[+-]n [i]\fP
59
\fBXXX\fP is the name of the register, \fBn\fP is the value to
60
be assigned, and \fBi\fP is increment value for auto-increment.
61
\fBn\fP can have a plus or minus sign as prefix if an increment
62
or decrement of the current value is wanted. (Auto-increment or decrement
63
occurs if the number register is used with a plus or minus sign,
64
\fB\en+[XXX]\fP or \fB\en-[XXX]\fP.)
66
Strings is defined with \fBds\fP.
68
\fB\&.ds\fP \fIYYY string\fP
70
The string is assigned everything to the end of the line, even blanks.
71
Initial blanks in \fIstring\fP should be prefixed with
72
a double-quote. (Strings are used in the text as \fB\e*[YYY]\fP.)
74
\fBSpecial formatting of number registers\fP
76
A number register is printed with normal digits if no format has been
78
Set the format with \fBaf\fP:
82
\fIR\fP is the name of the register, \fIc\fP is the format.
89
000, 001, 002, 003, ...
91
0, i, ii, iii, iv, ...
93
0, I, II, III, IV, ...
95
0, a, b, c, ..., z, aa, ab, ...
97
0, A, B, C, ..., Z, AA, AB, ...
104
Adds \fBtext\fP (heading-text) to the table of contents
105
with \fBlevel\fP either 0
106
or between 1-7. See also \fB.H\fP. This macro is used for customized
110
Begin one column processing. An \fB1\fP as argument disables the page-break.
111
Use wide footnotes, small footnotes may be overprinted.
114
Begin two column processing. Splits the page in two columns. It is
115
a special case of \fBMC\fP. See also \fB1C\fP.
118
Abstract end, see \fBAS\fP.
120
.B "AF [name of firm]"
121
Authors firm, should be called before \fBAU\fP, see also \fBCOVER\fP.
123
.B "AL [type [text-indent [1]]]"
124
Start autoincrement list. Items are numbered beginning on one.
125
The \fItype\fP argument controls the type of numbers.
132
Upper-case letters (A-Z)
134
Lower-case letters (a-z)
140
\fIText-indent\fP sets the indent and overrides \fBLi\fP.
141
A third argument will prohibit printing of a blank line before each
145
Begin an appendix with name \fIname\fP. Automatic naming occurs if
146
\fIname\fP is "". The appendixes starts with \fBA\fP if auto is used.
147
An new page is ejected, and a header is also produced if the number
148
variable \fBAph\fP is non-zero. This is the default.
149
The appendix always appear in the 'List of contents' with correct
150
pagenumber. The name \fIAPPENDIX\fP can be changed by setting
151
the string \fBApp\fP to the desired text.
152
The string \fBApptxt\fP contains the current appendix text.
154
.B "APPSK name pages text"
155
Same as \fB.APP\fP, but the pagenr is incremented with \fIpages\fP.
156
This is used when diagrams or other non-formatted documents are
157
included as appendixes.
159
.B "AS [arg [indent]]"
160
Abstract start. Indent is specified in 'ens', but scaling is allowed.
161
Argument \fIarg\fP controls where the abstract is printed.
166
Abstract will be printed on page 1 and on the cover sheet if
167
used in the released-paper style (\fBMT 4\fP), otherwise
168
it will be printed on page 1 without a cover sheet.
170
Abstract will only be printed on the cover sheet (\fBMT 4\fP only).
172
Abstract will be printed only on the cover sheet (other than \fBMT 4\fP only).
173
The cover sheet is printed without need for \fBCS\fP.
175
Abstract is not printed at all in external letters (\fBMT 5\fP).
176
The \fIindent\fP controls the indentation of both margins, otherwise
177
will normal text indent be used.
180
Abstract title. Default is \fBABSTRACT\fP.
181
Sets the text above the abstract text.
183
.B "AT title1 [title2 ...]"
184
Authors title. \fBAT\fP must appear just after each \fBAU\fP.
185
The title will show up after the name in the signature block.
187
.B "AU [name [initials [loc [dept [ext [room [arg [arg [arg]]]]]]]]]"
188
Author information, specifies the author of the memo or paper, and
189
will be printed on the cover sheet and on other similar places.
190
\fBAU\fP must not appear before \fBTL\fP. The author information
191
can contain initials, location, department, telephone extension,
192
room number or name and up to three extra arguments.
195
Approval signature, generates an approval line with place for
196
signature and date. The string \fBAPPROVED:\fP can be changed
197
with variable \fBLetapp\fP, and the string \fBDate\fP in \fBLetdate\fP.
200
Letter signature, generates a line with place for signature.
202
.B "B [bold-text [prev-font-text [bold...]]]"
204
No limit on the number of arguments.
205
All arguments will be concatenated to one word, the first, third and so
206
on will be printed in boldface.
209
Begin box (as the ms macro).
210
Draws a box around the text. The text will be indented one character,
211
and the right margin will be one character shorter.
214
End box. Finish the box started by \fBB1\fP.
217
End bottom block, see \fBBS\fP.
219
.B "BI [bold-text [italic-text [bold-text [...]]]]"
221
No limit on the number of arguments, see \fBB\fP.
223
.B "BL [text-indent [1]]"
224
Start bullet list, initialize a list with a bullet and a space
225
in the beginning of each list item (see \fBLI\fP).
227
overrides the default indentation of the list items set by
228
number register \fBPi\fP.
229
A third argument will prohibit printing of a blank line before each
232
.B "BR [bold-text [roman-text [bold-text [...]]]]"
234
No limit on the number of arguments.
237
Bottom block start. Begins the definition of a text block which is
238
printed at the bottom of each page. Block ends with \fBBE\fP.
240
.B "BVL text-indent [mark-indent [1]]"
242
broken variable-item list.
243
Broken variable-item list has no fixed mark, it assumes that
244
every \fBLI\fP has a mark instead.
245
The text will always begin at the next line after the mark.
246
\fIText-indent\fP sets the indent to the text, and \fImark-indent\fP
247
the distance from the current indent to the mark.
248
A third argument will prohibit printing of a blank line before each
252
\&\fBCOVER\fP begins a coversheet definition. It is important
253
that \fB.COVER\fP appears before any normal text.
254
\&\fB.COVER\fP uses \fIarg\fP to build the filename
255
@TMAC_MDIR@/\fIarg\fP.cov. Therefore it is possible to create unlimited
256
types of coversheets.
257
\fIms.cov\fP is supposed to look like the \fBms\fP coversheet.
258
\&\fB.COVER\fP requires a \fB.COVEND\fP at the end of the coverdefinition.
259
Always use this order of the covermacros:
270
However, only \fB.TL\fP and \fB.AU\fP are required.
273
This finish the cover description and prints the cover-page.
274
It is defined in the cover file.
277
Display end. Ends a block of text, display, that begins
278
with \fBDS\fP or \fBDF\fP.
280
.B "DF [format [fill [rindent]]]"
281
Begin floating display (no nesting allowed).
282
A floating display is saved in a queue and is printed in the
283
order entered. \fIFormat\fP, \fIfill\fP and \fIrindent\fP is the same
285
Floating displays are controlled by the two number registers \fBDe\fP
291
Nothing special, this is the default.
293
A page eject will occur after each printed display, giving only
294
one display per page and no text following it.
300
Displays are printed at the end of each section (when section-page
301
numbering is active) or at the end of the document.
303
A new display will be printed on the current page if there is enough
304
space, otherwise it will be printed at the end of the document.
306
One display will be printed at the top of each page or column
307
(in multi-column mode).
309
Print one display if there is enough space for it, otherwise it will
310
be printed at the top of the next page or column.
312
Print as many displays that will fit in a new page or column.
313
A page break will occur between each display if \fBDe\fP is not zero.
315
Fill the current page with displays and the rest beginning at a new page
316
or column. (This is the default.)
317
A page break will occur between each display
318
if \fBDe\fP is not zero.
321
.B "DL [text-indent [1 [1]]]"
322
Dash list start. Begins a list where each item is printed
323
after a dash. \fIText-indent\fP changes the default indentation
324
of the list items set by
325
number register \fBPi\fP.
326
A second argument prevents the empty line between each list item
327
to be printed. See \fBLI\fP.
328
A third argument will prohibit printing of a blank line before each
331
.B "DS [format [fill [rindent]]]"
332
Static display start.
333
Begins collection of text until \fBDE\fP.
334
The text is printed together on the same page, unless it is longer
335
than the height of the page.
336
\fBDS\fP can be nested to a unlimited depth (reasonably :-).
348
Indent text with the value of number register \fBSi\fP.
352
Center the whole display as a block.
354
Right adjust the lines.
356
Right adjust the whole display as a block
359
L, I, C and CB can also be specified as 0, 1, 2 or 3 for compatibility
360
reasons. (Don't use it. :-)
365
Line-filling turned off.
367
Line-filling turned off.
369
Line-filling turned off.
371
Line-filling turned on.
374
N and F can also be specified as 0 or 1.
375
An empty line will normally be printed before and after the
376
display. Setting number register \fBDs\fP to 0 will prevent this.
377
\fIRindent\fP shortens the line length by that amount.
379
.B "EC [title [override [flag [refname]]]]"
381
Sets a title for an equation. The \fIoverride\fP argument
382
change the numbering.
387
\fIoverride\fP is a prefix to the number.
389
\fIoverride\fP is a prefix to the number.
391
\fIoverride\fP is a suffix to the number.
393
\fIoverride\fP replaces the number.
395
\fBEC\fP uses the number register \fBEc\fP as counter.
396
It is possible to use \fB.af\fP to change the format of the number.
397
If number register \fBOf\fP is 1, then the format of title
398
will use a dash instead of a dot after the number.
400
The string \fBLe\fP controls the title of the
401
List of Equations, default is \fILIST OF EQUATIONS\fP.
402
The List of Equations will only be printed if number register \fBLe\fP
404
The string \fBLiec\fP contains the word \fIEquation\fP, wich
405
is printed before the number.
406
If \fIrefname\fP is used, then the equation number is saved with
407
\&\fB.SETR\fP, and can be retrieved with \fB.GETST\fP \fIrefname\fP.
409
Special handling of the title will occur if
410
\fBEC\fP is used inside \fBDS\fP/\fBDE\fP, it will not be
411
affected by the format of \fBDS\fP.
414
Even-page footer, printed just above the normal page footer
415
on even pages, see \fBPF\fP.
418
Even-page header, printed just below the normal page header
419
on even pages, see \fBPH\fP.
422
Equation end, see \fBEQ\fP.
425
End of page user-defined macro. This macro will be called
426
instead of the normal printing of the footer. The macro
427
will be executed in a separate environment, without any
428
trap active. See \fBTP\fP.
430
\fBStrings available to EOP\fP
433
Argument from \fBPF\fP.
435
Argument from \fBEF\fP.
437
Argument from \fBOF\fP.
440
.B "EPIC width height [name]"
441
\fBEPIC\fP draws a box with the given \fIwidth\fP and \fIheight\fP, it will
442
also print the text \fIname\fP or a default string if
443
\fIname\fP is not specified..
444
This is used to include external pictures, just give the size
450
\fBEQ\fP/\fBEN\fP are the delimiters for equations written for \fBeqn\fP.
451
\fBEQ\fP/\fBEN\fP must be inside a \fBDS\fP/\fBDE\fP-pair, except
452
when \fBEQ\fP is only used to set options in \fBeqn\fP.
453
The \fIlabel\fP will appear at the right margin of the equation, unless
454
number register \fBEq\fP is 1. Then the label will appear at the
457
.B "EX [title [override [flag [refname]]]]"
458
Exhibit title, arguments are the same as for \fBEC\fP.
459
\fBEX\fP uses the number register \fBEx\fP as counter.
460
The string \fBLx\fP controls the title of the
461
List of Exhibits, default is \fILIST OF EXHIBITS\fP.
462
The List of Exhibits will only be printed if number register \fBLx\fP
464
The string \fBLiex\fP contains the word \fIExhibit\fP, which
465
is printed before the number.
466
If \fIrefname\fP is used, then the exhibit number is saved with
467
\&\fB.SETR\fP, and can be retrieved with \fB.GETST\fP \fIrefname\fP.
469
Special handling of the title will occur if
470
\fBEX\fP is used inside \fBDS\fP/\fBDE\fP, it will not be
471
affected by the format of \fBDS\fP.
474
Prints \fIYours\ very\ truly,\fP as a formal closing of a letter or
475
memorandum. The argument replaces the defualt string.
476
The default is stored in string variable \fBLetfc\fP.
479
Footnote default format.
480
Controls the hyphenation (hyphen), right margin justification (adjust),
481
indentation of footnote text (indent). It can also change the label
482
justification (ljust).
486
.ta .5i +.8i +.8i +.8i +.8i
487
\fBarg hyphen adjust indent ljust\fP
503
Argument greater than or equal to 11 is considered as arg 0.
504
Default for m@TMAC_M_PREFIX@m is 10.
509
.B "FG [title [override [flag [refname]]]]"
510
Figure title, arguments are the same as for \fBEC\fP.
511
\fBFG\fP uses the number register \fBFg\fP as counter.
512
The string \fBLf\fP controls the title of the
513
List of Figures, default is \fILIST OF FIGURES\fP.
514
The List of Figures will only be printed if number register \fBLf\fP
516
The string \fBLifg\fP contains the word \fIFigure\fP, wich
517
is printed before the number.
518
If \fIrefname\fP is used, then the figure number is saved with
519
\&\fB.SETR\fP, and can be retrieved with \fB.GETST\fP \fIrefname\fP.
521
Special handling of the title will occur if
522
\fBFG\fP is used inside \fBDS\fP/\fBDE\fP, it will not be
523
affected by the format of \fBDS\fP.
527
The footnote is ended by \fBFE\fP. Footnotes is normally automatically
528
numbered, the number is available in string \fBF\fP.
529
Just add \fB\e*F\fP in the text. By adding \fIlabel\fP, it is possible
530
to have other number or names on the footnotes.
531
Footnotes in displays is now possible.
532
An empty line separates footnotes, the height of the line
533
is controlled by number register \fBFs\fP, default value is 1.
535
.B "GETHN refname [varname]"
536
Includes the headernumber where the corresponding \fBSETR\fP \fIrefname\fP
537
was placed. Will be X.X.X. in pass 1. See \fBINITR\fP.
538
If \fIvarname\fP is used, \fBGETHN\fP sets the stringvariable \fIvarname\fP to the
541
.B "GETPN refname [varname]"
542
Includes the pagenumber where the corresponding \fBSETR\fP \fIrefname\fP
543
was placed. Will be 9999 in pass 1. See \fBINITR\fP.
544
If \fIvarname\fP is used, \fBGETPN\fP sets the stringvariable \fIvarname\fP
548
Combines \fBGETHN\fP and \fBGETPN\fP with the text 'chapter' and ', page'.
549
The string \fIQrf\fP contains the text for reference:
551
\&.ds Qrf See chapter \e\e*[Qrfh], page \e\e*[Qrfp].
553
\fIQrf\fP may be changed to support other languages.
554
Strings \fIQrfh\fP and \fIQrfp\fP are set by \fBGETR\fP
555
and contains the page and headernumber.
557
.B "GETST refname [varname]"
558
Includes the string saved with the second argument to \fB.SETR\fP.
559
Will be dummystring in pass 1.
560
If varname is used, \fBGETST\fP sets the stringvariable \fIvarname\fP to the
561
saved string. See \fBINITR\fP.
563
.B "H level [heading-text [heading-suffix]]"
564
Numbered section heading.
565
Section headers can have a level between 1 and 7, level 1 is the
566
top level. The text is given in \fIheading-text\fP, and must be
567
surrounded by double quotes if it contains spaces.
568
\fBHeading-suffix\fP is added to the header in the text but not in
569
the table of contents. This is normally used for footnote marks
570
and similar things. Don't use \fB\e*F\fP in \fIheading-suffix\fP, it won't
571
work. A manual label must be used, see \fBFS\fP.
573
An eventual paragraph, \fBP\fP, directly after \fBH\fP will be
574
ignored, \fBH\fP is taking care of spacing and indentation.
576
\fBPage ejection before heading\fP
578
Number register \fBEj\fP controls page ejection before the heading.
579
Normally, a level one heading gets two blank lines before it, higher levels
580
gets only one. A new page is ejected before each
581
first-level heading if number register \fBEj\fP is 1.
582
All levels below or equal the value of \fBEj\fP gets a new page.
583
Default value for \fBEj\fP is 0.
585
\fBHeading break level\fP
587
A line break occurs after the heading if the heading level is less
588
or equal to number register \fBHb\fP.
591
\fBHeading space level\fP
593
A blank line is inserted after the heading if the heading level is less
594
or equal to number register \fBHs\fP.
597
Text will follow the heading on the same line if the level is greater
598
than both \fBHb\fP and \fBHs\fP.
600
\fBPost-heading indent\fP
602
Indentation of the text after the heading is controlled by number
603
register \fBHi\fP, default value 0.
608
The text will be left-justified.
610
Indentation of the text will follow the value of number register \fBPt\fP,
613
The text will be lined up with the first word of the heading.
616
\fBCentered section headings\fP
618
All headings whose level is equal or below number register \fBHc\fP
619
and also less than or equal to \fBHb\fP or \fBHs\fP
622
\fBFont control of the heading\fP
624
The font of each heading level is controlled by string \fBHF\fP.
625
It contains a fontnumber or fontname for each level. Default
626
is \fB2\ 2\ 2\ 2\ 2\ 2\ 2\fP (all headings in italic).
627
Could also be written as \fBI\ I\ I\ I\ I\ I\ I\fP.
628
All omitted values are presumed to be a 1.
630
\fBPoint size control\fP.
632
String \fBHP\fP controls the pointsize of each heading, in the
633
same way as \fBHF\fP controls the font.
634
A value of 0 selects the default point size.
635
Default value is \fB0\ 0\ 0\ 0\ 0\ 0\ 0\fP. Beware that only the
636
point size changes, not the vertical size.
637
That can be controlled by the user specified macro \fBHX\fP and/or
640
\fBHeading counters\fP
642
Seven number registers, named \fBH1\fP thru \fBH7\fP contains
643
the counter for each heading level.
644
The values are printed using arabic numerals, this can be changed
645
with the macro \fBHM\fP (see below).
646
All marks are concatenated before printing. To avoid this, set
647
number register \fBHt\fP to 1. That will only print the current
648
heading counter at each heading.
650
\fBAutomatic table of contents\fP
652
All headings whose level is equal or below number register \fBCl\fP
653
is saved to be printed in the table of contents. Default value is 2.
655
\fBSpecial control of the heading, user-defined macros\fP.
657
These macros can be defined by the user to get a finer control
658
of vertical spacing, fonts or other features.
659
Argument \fIlevel\fP is the level-argument to \fBH\fP, but
660
0 for unnumbered headings (see \fBHU\fP).
661
Argument \fIrlevel\fP is the real level, it is
662
set to number register \fBHu\fP for unnumbered headings.
663
Argument \fIheading-text\fP is the text argument to \fBH\fP and \fBHU\fP.
665
\fBHX\ \fP\fIlevel\ rlevel\ heading-text\fP
667
\fBHX\fP is called just before the printing of the heading.
668
The following register is available for \fBHX\fP.
669
\fBHX\fP may alter \fB}0\fP, \fB}2\fP and \fB;3\fP.
672
Contains the heading mark plus two spaces if \fIrlevel\fP is non-zero,
675
Contains the position of the text after the heading.
676
0 means that the text should follow the heading on the same line, 1
677
means that a line break should occur before the text and
678
2 means that a blank line should separate the heading and the text.
680
Contains two spaces if register \fB;0\fP is 0. It is used to
681
separate the heading from the text. The string
682
is empty if \fB;0\fP is non-zero.
684
Contains the needed space in units after the heading.
687
Can be used to change things like numbering (\fB}0\fP),
688
vertical spacing (\fB}2\fP)
689
and the needed space after the heading.
692
\fBHY\ \fP\fIdlevel\ rlevel\ heading-text\fP
694
\fBHY\fP is called after size and font calculations and
695
might be used to change indentation.
697
\fBHZ\ \fP\fIdlevel\ rlevel\ heading-text\fP
699
\fBHZ\fP is called after the printing of the heading, just before
700
\fBH\fP or \fBHU\fP exits.
701
Could be used to change the page header according to the section heading.
703
.B "HC [hyphenation-character]"
704
Set hyphenation character.
705
Default value is \e%.
706
Resets to the default if called without argument.
707
Hyphenation can be turned off by setting number
708
register \fBHy\fP to 0 in the beginning of the file.
710
.B "HM [arg1 [arg2 [... [arg7]]]]"
712
Controls the type of marking for printing of the heading counters.
713
Default is 1 for all levels.
720
Arabic numerals with leading zeroes, one or more.
722
Upper-case alphabetic
724
Lower-case alphabetic
726
Upper-case roman numerals
728
lower-case roman numerals
734
Unnumbered section header.
735
\fBHU\fP behavies like \fBH\fP at the level in number register \fBHu\fP.
738
.B "HX dlevel rlevel heading-text"
739
Userdefined heading exit.
740
Called just before printing the header.
743
.B "HY dlevel rlevel heading-text"
744
Userdefined heading exit.
745
Called just before printing the header.
748
.B "HZ dlevel rlevel heading-text"
749
Userdefined heading exit.
750
Called just after printing the header.
753
.B "I [italic-text [prev-font-text [italic-text [...]]]]"
755
Changes the font to italic if called without arguments.
756
With one argument it will set the word in italic.
757
With two argument it will concatenate them and set the first
758
word in italic and the second in the previous font.
759
There is no limit on the number of argument, all will be concatenated.
761
.B "IA [addressee-name [title]]"
762
Begins specification of the addressee and addressee's address in
764
Several names can be specified with empty \fBIA\fP/\fBIE\fP-pairs, but
768
.B "IB [italic-text [bold-text [italic-text [...]]]]"
770
Even arguments is printed in italic, odd in boldface.
774
Ends the address-specification after \fPIA\fP.
776
.B "INITI type filename [macro]"
777
Initialize the new index system, sets the filename to collect
778
index lines in with \fBIND\fP. Argument \fItype\fP selects
779
the type of index, page number, header marks or both.
780
The default is \fIN\fP.
782
It is also possible to create a macro that is responsible
783
for formatting each row. Add the name of the macro as argument 3.
784
The macro will be called with the index as argument(s).
793
Both page numbers and header marks, tab separated
797
Initialize the refencemacros. References will be written to
798
\fIfilename.tmp\fP and \fIfilename.qrf\fP. Requires two passes with groff.
799
The first looks for references and the second includes them.
800
\fBINITR\fP can be used several times, but it is only the first
801
occurrence of \fBINITR\fP that is active.
802
Option \fB-U\fP might be needed if \fBunsafe\fP-errors occur.
803
See also \fBSETR\fP, \fBGETPN\fP and \fBGETHN\fP.
805
.B "IND arg1 [arg2 [...]]"
806
\fBIND\fP writes a line in the index file selected by \fBINITI\fP
807
with all arguments and the page number or header mark separated by tabs.
813
arg1\etarg2\etpage number
817
arg1\etpage number\etheader mark
821
\fBINDP\fP prints the index by running the command specified
822
by string variable \fBIndcmd\fP, normally \fIsort\ -t\et\fP.
823
\fBINDP\fP reads the output from the command to form
824
the index, normally in two columns (can be changed by defining \fBTYIND\fP).
825
The index is printed with string variable \fBIndex\fP as header,
826
default is \fBINDEX\fP. One-column processing is
827
returned after the list. \fBINDP\fP will call the
828
user-defined macros \fBTXIND\fP, \fBTYIND\fP and \fBTZIND\fP if defined.
829
\fBTXIND\fP is called before printing \fBINDEX\fP, \fBTYIND\fP
830
is called instead of printing \fBINDEX\fP. \fBTZIND\fP is called
831
after the printing and should take care of restoring to normal
835
\fBISODATE\fP changes the predefined date string in \fBDT\fP to
836
ISO-format, ie YYYY-MM-DD. This can also be done by
837
adding \fB-rIso=1\fP on the command line.
838
Reverts to old date format if argument is \fB0\fP.
840
.B "IR [italic-text [roman-text [italic-text [...]]]]"
842
Even arguments is printed in italic, odd in roman.
845
.B "LB text-indent mark-indent pad type [mark [LI-space [LB-space]]]"
847
This is the common macro used for all lists.
848
\fIText-indent\fP is the number of spaces to indent the text from the
851
\fIPad\fP and \fImark-indent\fP controls where to put the mark.
852
The mark is placed within the mark area, and \fImark-indent\fP
853
sets the number of spaces before this area. It is normally 0.
854
The mark area ends where the text begins. The start of the text
855
is still controlled by \fItext-indent\fP.
857
The mark is left justified whitin the mark area if \fIpad\fP is 0.
858
If \fIpad\fP is greater than 0, then \fImark-indent\fP is ignored, and
859
the mark is placed \fIpad\fP spaces before the text.
860
This will right justify the mark.
862
If \fItype\fP is 0 the list will have either a hanging indent or, if
863
argument \fImark\fP is given, the string \fImark\fP as mark.
865
If \fItype\fP is greater than 0 automatic numbering will occur, arabic
866
if \fImark\fP is empty. \fIMark\fP can then be any of \fB1\fP, \fBA\fP,
867
\fBa\fP, \fBI\fP or \fBi\fP.
869
\fIType\fP selects one of six possible ways to display the mark.
887
Every item in the list will get \fILI-space\fP number of blank lines
888
before them. Default is 1.
890
\fBLB\fP itself will print \fILB-space\fP blank lines. Default is 0.
894
Terminates all current active lists down to \fIlist-level\fP, or 0
895
if no argmuent is given. This is used by \fBH\fP to clear any
900
Terminate the current list. \fBLE\fP outputs a blank line
901
if an argument is given.
904
List item precedes every item in a list. Without argument \fBLI\fP
905
will print the mark determined by the current list type. By giving
906
\fBLI\fP one argument, it will use that as the mark instead.
907
Two arguments to \fBLI\fP will make \fImark\fP a prefix to
909
There will be no separating space between the prefix
910
and the mark if the second argument is \fB2\fP instead of \fB1\fP.
911
This behaviour can also be achieved by setting number register
913
A zero length \fImark\fP will make a hanging
916
A blank line is normally printed before the list item. This behaviour
917
can be controlled by number register \fBLs\fP. Pre-spacing
918
will occur for each list-level less than or equal to \fBLs\fP.
919
Default value is 99. (Nesting of lists is unlimited. :-)
921
The indentation can be changed thru number register \fBLi\fP.
924
All lists begins with a list initialization macro, \fBLB\fP.
925
There are, however, seven predefined listtypes to
926
make lists easier to use. They all call \fBLB\fP with different
930
Automatically Incremented List
944
These lists are described at other places in this manual. See also \fBLB\fP.
947
Formats a letter in one of four different styles depending
949
See also \fBINTERNALS\fP.
954
Blocked. Date line, return address, writer's address and closing
955
begins at the center of the line. All other lines begin at the left margin.
957
Semi-blocked. Same as blocked, except that the first line in every
958
paragraph is indented five spaces.
960
Full-blocked. All lines begin at the left margin.
962
Simplified. Almost the same as the full-blocked style. Subject and
963
the writer's identification are printed in all-capital.
967
Specify options in letter (see \fB.LT\fP).
968
This is a list of the standard options:
971
Confidential notation. Prints \fBCONFIDENTIAL\fP on the second line
972
below the date line. Any argument replaces \fBCONFIDENTIAL\fP.
973
See also string variable \fBLetCN\fP.
975
Reference notation. Prints \fBIn reference to:\fP and the argument
976
two lines below the date line.
977
See also string variable \fBLetRN\fP.
979
Attention. Prints \fBATTENTION:\fP and the argument below the inside address.
980
See also string variable \fBLetAT\fP.
982
Salutation. Prints \fBTo Whom It May Concern:\fP or the argument if
983
it was present. The salutation is printed two lines below the inside address.
984
See also string variable \fBLetSA\fP.
986
Subject line. Prints the argument as subject prefixed with \fBSUBJECT:\fP
987
two lines below the inside address, except in letter type \fBSP\fP.
988
Then the subject is printed in all-captial without any prefix.
989
See also string variable \fBLetSJ\fP.
992
.B "MC column-size [column-separation] "
993
Begin multiple columns. Return to normal with \fB1C\fP.
994
\fBMC\fP will create as many columns as the current line length permits.
995
\fIColumn-size\fP is the width of each column, and \fIcolumn-separation\fP
996
is the space between two columns. Default separation is the
1000
.B "ML mark [text-indent [1]]"
1001
Marked list start. The \fImark\fP argument will be printed before
1003
\fIText-indent\fP sets the indent and overrides \fBLi\fP.
1004
A third argument will prohibit printing of a blank line before each
1007
.B "MT [arg [addressee]]"
1009
The \fIarg\fP is part of a filename in \fI@TMAC_MDIR@/*.MT\fP.
1010
Memorandum type 0 thru 5 are supported, including \fI"string"\fP.
1011
\fIAddressee\fP just sets a variable, used in the AT&T macros.
1016
Normal memorandum, no type printed
1018
Memorandum with \fIMEMORANDUM FOR FILE\fP printed
1020
Memorandum with \fIPROGRAMMER'S NOTES\fP printed
1022
Memorandum with \fIENGINEER'S NOTES\fP printed
1024
Released paper style
1026
External letter style
1028
See also \fBCOVER\fP/\fBCOVEND\fP, a more flexible type of front page.
1030
.B "MOVE y-pos [x-pos [line-length]]"
1031
Move to a position, pageoffset set to \fIx-pos\fP.
1032
If \fIline-length\fP is not given, the difference between
1033
current and new pageoffset is used.
1034
Use \fBPGFORM\fP without arguments to return to normal.
1036
.B "MULB cw1 space1 [cw2 space2 [cw3 ...]]"
1037
Begin a special multi-column mode. Every columns width must be specified.
1038
Also the space between the columns must be specified. The last column
1039
does not need any space-definition. \fBMULB\fP starts a diversion and \fBMULE\fP
1040
ends the diversion and prints the columns.
1041
The unit for width and space is 'n', but \fBMULB\fP accepts all
1042
normal unitspecifications like 'c' and 'i'.
1043
\fBMULB\fP operates in a separate environment.
1046
Begin the next column. This is the only way to switch column.
1049
End the multi-column mode and print the columns.
1052
Print numbered paragraph with header level two. See \fB.P\fP.
1055
Force printing to the next column, don't use this together with
1056
the \fBMUL*\fP macros, see \fB2C\fP.
1059
Prints different types of notations. The argument selects between
1060
the predefined type of notations. If the second argument is available,
1061
then the argument becomes the entire notation.
1062
If the argument doesn't exist in the predefined, it will be
1063
printed as \fBCopy (\fP\fIarg\fP\fB) to\fP.
1064
It is possible to add more standard notations, see the string variable
1065
\fBLetns\fP and \fBLetnsdef\fP.
1075
Copy To (with att.) to
1077
Copy To (without att.) to
1087
Under separate cover
1093
Copy (with atts.) to
1095
Copy (without atts.) to
1099
Complete Memorandum to
1106
New date. Override the current date. Date is not
1107
printed if \fInew-date\fP is an empty string.
1110
Odd-page footer, a line printed just above the normal footer.
1111
See \fBEF\fP and \fBPF\fP.
1114
Odd-page header, a line printed just below the normal header.
1115
See \fBEH\fP and \fBPH\fP.
1118
Make sure that the following text is printed at the top
1119
of an odd-numbered page. Will not output an empty page
1120
if currently at the top of an odd page.
1123
Begin new paragraph.
1124
\fBP\fP without argument will produce left justified text, even
1125
the first line of the paragraph. This is the same as setting
1126
\fItype\fP to 0. If the argument is 1, then the first line
1127
of text following \fBP\fP will be indented by the number of
1128
spaces in number register \fBPi\fP, normally 5.
1130
Instead of giving 1 as argument to \fBP\fP it is possible to set the
1131
paragraph type in number register \fBPt\fP. Using 0 and 1
1132
will be the same as adding that value to \fBP\fP.
1133
A value of 2 will indent all paragraphs, except after
1134
headings, lists and displays.
1136
The space between two paragraphs is controlled by number register \fBPs\fP,
1137
and is 1 by default (one blank line).
1139
.B "PGFORM [linelength [pagelength [pageoffset [1]]]]"
1140
Sets linelength, pagelength and/or pageoffset.
1141
This macro can be used for special formatting, like letterheads
1143
It is normally the first command in a file, though it's not necessary.
1144
\fBPGFORM\fP can be used without arguments
1145
to reset everything after a \fBMOVE\fP.
1146
A line-break is done unless the fourth argument is given.
1147
This can be used to avoid the pagenumber on the first page while setting
1148
new width and length.
1149
(It seems as if this macro sometimes doesn't work too well.
1150
Use the command line arguments
1151
to change linelength, pagelength and pageoffset instead. Sorry.)
1154
No header is printed on the next page. Used to get rid of
1155
the header in letters or other special texts.
1156
This macro must be used before any text to inhibit the pageheader
1159
.B PIC [-L] [-C] [-R] [-I n] filename [width [height]]
1160
\fBPIC\fP includes a Postscript file in the document.
1161
The macro depends on \fBmmroff\fP and \fBINITR\fP.
1162
\fB-L\fP, \fB-C\fP, \fB-R\fP and \fB-I n\fP adjusts the picture
1163
or indents it. The optionally \fIwidth\fP and \fIheight\fP
1164
can also be given to resize the picture.
1168
Ends a picture for \fB@TMAC_M_PREFIX@pic\fP, see the manual for \fB@TMAC_M_PREFIX@pic\fP.
1172
\fBPF\fP sets the line to be printed at the bottom of each page.
1173
Normally empty. See \fBPH\fP for the argument specification.
1176
Page header, a line printed at the top of each page.
1177
The argument should be specified as "'left-part'center-part'right-part'",
1178
where left-, center- and right-part is printed left-justified, centered
1179
and right justified. The character \fB%\fP is changed to the current
1180
page number. The default page-header is "''- % -''", the page
1181
number between two dashes.
1184
Picture start (from pic). Begins a picture for \fB@g@pic\fP, see
1188
Page-header user-defined exit.
1189
\fBPX\fP is called just after the printing of the page header
1190
in \fIno-space\fP mode.
1194
Return to roman font, see also \fBI\fP.
1196
.B "RB [roman-text [bold-text [roman-text [...]]]]"
1198
Even arguments is printed in roman, odd in boldface.
1201
.B "RD [prompt [diversion [string]]]"
1202
Read from standard input to diversion and/or string.
1203
The text will be saved in a diversion named \fIdiversion\fP.
1204
Recall the text by writing the name of the diversion after a dot
1205
on an empty line. A string will also be defined if
1206
\fIstring\fP is given. \fIDiversion\fP and/or \fIprompt\fP can
1210
Reference end. Ends a reference definition and returns to normal
1211
processing. See \fBRS\fP.
1213
.B "RI [roman-text [italic-text [roman-text [...]]]]"
1214
Even arguments are printed in roman, odd in italic.
1217
.B "RL [text-indent [1]]"
1218
Reference list start.
1219
Begins a list where each item is preceded with a automatically
1220
incremented number between
1222
\fIText-indent\fP changes the default indentation.
1224
.B "RP [arg1 [arg2]]"
1225
Produce reference page.
1226
\fBRP\fP can be used if a reference page is wanted somewhere in the
1227
document. It is not needed if \fBTC\fP is used to produce
1228
a table of content. The reference page will then be printed automatically.
1230
The reference counter will not be reset if \fIarg1\fP is 1.
1232
\fIArg2\fP tells \fBRP\fP whether to eject a page or not.
1237
The reference page will be printed on a separate page.
1241
Do not eject page after the list.
1243
Do not eject page before the list.
1245
Do not eject page before and after the list.
1247
The reference items will be separated by a blank line.
1248
Setting number register \fBLs\fP to 0 will suppress the line.
1250
The string \fBRp\fP contains the reference page title and
1251
is normally set to \fIREFERENCES\fP.
1253
.B "RS [string-name]"
1254
\fBRS\fP begins an automatically numbered reference definition.
1255
Put the string \fB\e*(Rf\fP where the reference mark
1256
should be and write the reference between \fBRS\fP/\fBRF\fP
1257
at next new line after the reference mark. The reference number
1258
is stored in number register \fB:R\fP.
1259
If \fIstring-name\fP is given, a string with that name
1260
will be defined and contain the current reference mark.
1261
The string can be referenced as \fB\e*[\fIstring-name\fP]\fP later in
1264
.B "S [size [spacing]]"
1265
Set point size and vertical spacing. If any argument is equal 'P', then
1266
the previous value is used. A 'C' means current value, and 'D' default value.
1267
If '+' or '-' is used before the value, then increment or decrement of
1268
the current value will be done.
1271
Set right-margin justification.
1272
Justification is normally turned on.
1273
No argumenent or \fB0\fP turns off justification, a \fB1\fP turns on
1276
.B "SETR refname [string]"
1277
Remember the current header and page-number as \fIrefname\fP.
1278
Saves \fIstring\fP if \fIstring\fP is defined. \fIstring\fP is retrieved
1283
Signature line. Prints the authors name(s) after the formal closing.
1284
The argument will be appended to the reference data, printed
1285
at either the first or last author. The reference data is the location,
1286
department and initials specified with \fB.AU\fP.
1287
It will be printed at the first author if the second argument is given,
1288
otherwise at the last.
1289
No reference data will be printed if the author(s) is specifed
1290
thru \fB.WA\fP/\fB.WE\fP.
1291
See \fBINTERNALS\fP.
1295
If \fIpages\fP is \fB0\fP or omitted, a skip to the next page
1296
will occur unless it is already at the top of a page.
1297
Otherwise it will skip \fIpages\fP pages.
1299
.B "SM string1 [string2 [string3]]"
1300
Make a string smaller.
1301
If \fIstring2\fP is given, \fIstring1\fP will be smaller and \fIstring2\fP
1302
normal, concatenated with \fIstring1\fP. With three argument, all is
1303
concatenated, but only \fIstring2\fP is made smaller.
1306
Space vertically. \fIlines\fP can have any scalingfactor, like \fI3i\fP or
1307
\fI8v\fP. Several \fBSP\fP in a line will only produce the
1308
maximum number of lines, not the sum. \fBSP\fP will also be ignored
1309
until the first textline in a page. Add a \fB\e&\fP before \fBSP\fP
1313
reset tabs to every 5n. Normally used to reset any previous tabpositions.
1315
.B "TB [title [override [flag [refname]]]]"
1316
Table title, arguments are the same as for \fBEC\fP.
1317
\fBTB\fP uses the number register \fBTb\fP as counter.
1318
The string \fBLt\fP controls the title of the
1319
List of Tables, default is \fILIST OF TABLES\fP.
1320
The List of Tables will only be printed if number register \fBLt\fP
1322
The string \fBLitb\fP contains the word \fITABLE\fP, wich
1323
is printed before the number.
1325
Special handling of the title will occur if
1326
\fBTB\fP is used inside \fBDS\fP/\fBDE\fP, it will not be
1327
affected by the format of \fBDS\fP.
1329
.B "TC [slevel [spacing [tlevel [tab [h1 [h2 [h3 [h4 [h5]]]]]]]]]"
1331
This macro is normally used at the last line of the document.
1332
It generates a table of contents with headings up to the level
1333
controlled by number register \fBCl\fP. Note that \fBCl\fP controls
1334
the saving of headings, it has nothing to do with \fBTC\fP.
1335
Headings with level less than or equal to \fIslevel\fP will get
1336
\fIspacing\fP number of lines before them.
1337
Headings with level less than or equal to \fItlevel\fP will have
1338
their page numbers right justified with dots or spaces separating
1339
the text and the page number. Spaces is used if \fItab\fP
1340
is greater than zero, otherwise dots.
1341
Other headings will have the
1342
page number directly at the end of the heading text (\fIragged right\fP).
1344
The rest of the arguments will be printed, centered, before the
1347
The user-defined macros \fBTX\fP and \fBTY\fP are used if \fBTC\fP is called
1348
with at most four arguments. \fBTX\fP is called before the printing
1349
of \fICONTENTS\fP, and \fBTY\fP is called instead of printing \fICONTENTS\fP.
1351
Equivalent macros can be defined for list of figures, tables, equations
1352
and excibits by defining \fBTXxx\fP or \fBTYxx\fP, where \fBxx\fP
1353
is \fBFg\fP, \fBTB\fP, \fBEC\fP or \fBEX\fP.
1355
String \fBCi\fP can be set to control the indentations for each heading-level.
1356
It must be scaled, like \fB.ds\ Ci\ .25i\ .5i\ .75i\ 1i\ 1i\fP.
1357
The indentation is normally controlled by the maxlength of headings
1360
All texts can be redefined, new stringvariables
1361
\fILifg\fP, \fILitb\fP, \fILiex\fP, \fILiec\fP and \fILicon\fP contain
1362
"Figure", "TABLE", "Exhibit", "Equation" and "CONTENTS".
1363
These can be redefined to other languages.
1366
Table end. See \fBTS\fP.
1369
Table header. See \fBTS\fP.
1370
\fBTH\fP ends the header of the table. This header will
1371
be printed again if a page-break occurs.
1372
Argument \fIN\fP isn't implemented yet.
1374
.B TL [charging-case number(s) [filing-case number(s)]]
1375
Begin title of memorandum.
1376
All text up to the next \fBAU\fP is included in the title.
1377
\fICharging-case number\fP and \fIfiling-case\fP are saved
1378
for use in the front page processing.
1380
.B TM [num1 [num2 [...]]]
1381
Technical memorandumnumbers used in \fB.MT\fP. Unlimited number
1382
of arguments may be given.
1385
Top of page user-defined macro.
1386
This macro is called instead of the normal page header. It is
1387
possible to get complete control over the header.
1388
Note that header and footer is printed in a separate environment.
1389
Linelength is preserved though.
1392
Table start. This is the start of a table specification
1393
to \fB@g@tbl\fP. See separate manual for \fB@g@tbl\fP.
1394
\fBTS\fP ends with \fBTE\fP.
1395
Argument \fIH\fP tells \fBm@TMAC_M_PREFIX@m\fP that the table
1396
has a header. See \fBTH\fP.
1399
Userdefined table of contents exit.
1400
This macro is called just before \fBTC\fP prints the word \fICONTENTS\fP.
1404
Userdefined table of contents exit (no "CONTENTS").
1405
This macro is called instead of printing \fICONTENTS\fP.
1408
.B VERBON [flag [pointsize [font]]]
1409
Begin verbatim output using courier font.
1410
Usually for printing programs.
1411
All character has equal width.
1412
The pointsize can be changed with
1413
the second argument. By specifying the font-argument
1414
it is possible to use another font instead of courier.
1415
\fIflag\fP controls several special features.
1416
It contains the sum of all wanted features.
1421
Disable the escape-character (\e). This is normally turned on during
1424
Add an empty line before the verbose text.
1426
Add an empty line after the verbose text.
1428
Print the verbose text with numbered lines. This adds four digitsized
1429
spaces in the beginning of each line. Finer control is available with
1430
the string-variable \fBVerbnm\fP. It contains all arguments to the
1431
\fBtroff\fP-command \fB.nm\fP, normally '1'.
1433
Indent the verbose text with five 'n':s. This is controlled by the
1434
number-variable \fBVerbin\fP (in units).
1438
End verbatim output.
1440
.B "VL text-indent [mark-indent [1]]"
1441
Variable-item list has no fixed mark, it assumes that
1442
every \fBLI\fP have a mark instead.
1443
\fIText-indent\fP sets the indent to the text, and \fImark-indent\fP
1444
the distance from the current indent to the mark.
1445
A third argument will prohibit printing of a blank line before each
1448
.B "VM [top [bottom]]"
1451
.B "WA [writer-name [title]]"
1452
Begins specification of the writer and writer's address.
1453
Several names can be specified with empty \fBWA\fP/\fBWE\fP-pairs, but
1457
Ends the address-specification after \fP.WA\fP.
1460
Footnote and display width control.
1463
Set default mode, \fB-WF\fP, \fB-FF\fP, \fB-WD\fP and \fBFB\fP.
1465
Wide footnotes, wide also in two-column mode.
1467
Normal footnote width, follow column mode.
1469
All footnotes gets the same width as the first footnote encountered.
1471
Normal footnotes, width follows \fBWF\fP and \fB-WF\fP.
1473
Wide displays, wide also in two-column mode.
1475
Normal display width, follow column mode.
1477
Floating displays generates a line break when printed on the current page.
1479
Floating displays does not generate line break.
1483
.\"########################################################################
1485
.B "Strings used in m@TMAC_M_PREFIX@m:"
1488
A string containing the word "APPENDIX".
1492
The current appendix text.
1497
Will be updated by \fB.H\fP and \fB.HU\fP to the current heading text.
1498
Also updated in table of contents & friends.
1501
Fontlist for headings, normally "2 2 2 2 2 2 2".
1502
Nonnumeric fontnames may also be used.
1505
Pointsize list for headings. Normally "0 0 0 0 0 0 0" which is the same as
1506
"10 10 10 10 10 10 10".
1510
Contains \fIINDEX\fP.
1513
Contains the index command, \fIsort\ -t\et\fP.
1515
String containing \fIFigure\fP.
1518
String containing \fITABLE\fP.
1521
String containing \fIExhibit\fP.
1524
String containing \fIEquation\fP.
1527
String containing \fICONTENTS\fP.
1530
Contains "LIST OF FIGURES".
1533
Contains "LIST OF TABLES".
1536
Contains "LIST OF EXHIBITS".
1539
Contains "LIST OF EQUATIONS".
1542
Contains "Yours very truly,", used in \fB.FC\fP.
1545
Contains "APPROVED:", used in \fB.AV\fP.
1548
Contains "Date", used in \fB.AV\fP.
1551
Contains "CONFIDENTIAL", used in \fB.LO CN\fP.
1554
Contains "To Whom It May Concern:", used in \fB.LO SA\fP.
1557
Contains "ATTENTION:", used in \fB.LO AT\fP.
1560
Contains "SUBJECT:", used in \fB.LO SJ\fP.
1563
Contains "In reference to:", used in \fB.LO RN\fP.
1566
is an array containing the different strings used in \fB.NS\fP.
1567
It is really a number of stringvariables prefixed with \fBLetns!\fP.
1568
If the argument doesn't exist, it will be included
1569
between \fB()\fP with \fBLetns!copy\fP as prefix and \fBLetns!to\fP as suffix.
1570
Observe the space after \fBcopy\fP and before \fBto\fP.
1575
Letns!1 Copy (with att.) to
1576
Letns!2 Copy (without att.) to
1581
Letns!7 Under separate cover
1583
Letns!9 Memorandum to
1584
Letns!10 Copy (with atts.) to
1585
Letns!11 Copy (without atts.) to
1586
Letns!12 Abstract Only to
1587
Letns!13 Complete Memorandum to
1594
Defines the standard-notation used when no argument is given
1595
to \fB.NS\fP. Default is \fB0\fP.
1598
Strings containing \fIJanuary\fP thru \fIDecember\fP.
1601
String containing "See chapter \e\e*[Qrfh], page \e\en[Qrfp].".
1604
Contains "REFERENCES".
1607
Contains current status of table of contents and list of XXXX.
1608
Empty outside \fB.TC\fP.
1609
Useful in user-defined macros like \fB.TP\fP.
1613
co Table of contents
1616
ec List of equations
1623
Contains \e(tm, trade mark.
1626
Argument to \fB.nm\fP in \fB.VERBON\fP, default: \fB1\fP.
1627
.\"-----------------------------------
1629
.B "Number variables used in m@TMAC_M_PREFIX@m:"
1632
Print an appendix-page for every new appendix
1633
if this numbervariable is non-zero.
1634
No output will occur if \fBAph\fP is zero, but there will always
1635
be an appendix-entry in the 'List of contents'.
1638
Contents level [0:7], contents saved if heading level <= Cl, default 2.
1641
Eject page between LIST OF XXXX if Cp == 0, default 0.
1644
Debugflag, values >0 produces varying degree of debug. A value of 1
1645
gives information about the progress of formatting, default 0.
1648
Eject after floating display is output [0:1], default 0.
1651
Controls the space output before and after static displays
1652
if defined. Otherwise is the value of Lsp used.
1655
Floating keep output [0:5], default 5.
1658
\fBLsp\fP space before and after display if == 1 [0:1], default 1.
1661
Eject page, default 0.
1664
Equation lable adjust 0=left, 1=right. Default 0.
1667
Footnote spacing, default 1.
1673
Append a dot after the level one heading number if > 0. Default is 1.
1677
Copy of number register \fBH1\fP, but it is incremented
1678
just before the page break. Useful in user defined header macros.
1680
Heading break level [0:7], default 2.
1683
Heading centering level, [0:7]. Default 0.
1686
Heading temporary indent [0:2], default 1.
1688
0\ ->\ 0 indent, left margin
1690
1\ ->\ indent to right , like .P 1
1692
2\ ->\ indent to line up with text part of preceding heading
1695
Numbervariable with the heading pre-space level. If the heading-level
1696
is less than or equal to \fBHps\fP, then two lines will precede the
1697
section heading instead of one. Default is first level only.
1698
The real amount of lines is controlled by the variables \fBHps1\fP and
1702
This is the number of lines preceding \fB.H\fP when the heading-level
1703
is greater than \fBHps\fP. Value is in units, normally 0.5.
1706
This is the number of lines preceding \fB.H\fP when the heading-level
1707
is less than or equal to \fBHps\fP. Value is in units, normally 1.
1710
Heading space level [0:7], default 2.
1713
This is the number of lines that follows \fB.H\fP when the heading-level
1714
is less than or equal to \fBHs\fP. Value is in units, normally 1.
1717
Heading numbering type, default 0.
1718
0 -> multiple (1.1.1 ...)
1723
Unnumbered heading level, default 2.
1726
Hyphenation in body, default 1.
1728
0\ ->\ no hyphenation
1730
1\ ->\ hyphenation 14 on
1733
Set this variable to 1 on the command line to get ISO-formatted date string.
1735
Useless inside a document.
1738
Max lines in return-address, used in \fB.WA\fP/\fB.WE\fP. Default 14.
1741
Enables (1) or disables (0) the printing of List of figures,
1742
List of tables, List of exhibits and List of equations.
1743
Default: Lf=1, Lt=1, Lx=1, Le=0.
1746
List indent, used by .AL, default 6.
1749
Flag for space between prefix and mark in automatic lists (.AL).
1756
List space, if current listlevel > Ls then no spacing will occur around lists.
1760
The size of an empty line. Normally 0.5v, but it is 1v
1761
if \fBn\fP is set (\fB.nroff\fP).
1764
Numbering style [0:5], default 0.
1766
0\ ==\ (default) normal header for all pages.
1768
1\ ==\ header replaces footer on first page, header is empty.
1770
2\ ==\ page header is removed on the first page.
1772
3\ ==\ "section-page" numbering enabled.
1774
4\ ==\ page header is removed on the first page.
1776
5\ ==\ "section-page" and "section-figure" numbering enabled.
1777
See also the number-register Sectf and Sectp.
1780
Numbered paragraphs, default 0.
1784
1\ ==\ numbered in first level headings.
1787
Format of figure,table,exhibit,equation titles, default 0.
1794
Current page-number, normally the same as % unless "section-page" numbering
1798
paragraph indent, default 5.
1801
Controls whether header and footer pointsize should follow the current
1802
setting or just change when the header and footer is defined.
1808
Pointsize will only change to the current setting when \fB.PH\fP, \fB.PF\fP,
1809
\&\fB.OH\fP, \fP.EH\fP, \fB.OF\fP or \fB.OE\fP is executed.
1811
Pointsize will change after every \fB.S\fP. This is the default.
1815
paragraph spacing, default 1.
1818
Paragraph type, default 0.
1820
0\ ==\ left-justified
1824
2\ ==\ indented .P except after .H, .DE or .LE.
1827
Flag controlling "section-figures". A non-zero value enables this.
1828
See also register N.
1831
Flag controlling "section-page-numbers". A non-zero value enables this.
1832
See also register N.
1835
Display indent, default 5.
1838
Indent for \fB.VERBON\fP, default 5n.
1844
The letter macros is using different submacros depending on
1845
the letter type. The name of the submacro has the letter type
1846
as suffix. It is therefore possible to define other letter types, either
1847
in the national macro-file, or as local additions.
1848
\&\fB.LT\fP will set the number variables \fBPt\fP and \fBPi\fP to 0 and 5.
1849
The following strings and macros must be defined for a new letter type:
1851
\fBlet@init_\fP\fItype\fP
1852
This macro is called directly by \fB.LT\fP. It is supposed to initialize
1853
variables and other stuff.
1855
\fBlet@head_\fP\fItype\fP
1856
This macro prints the letter head, and is called instead of the
1857
normal page header. It is supposed to remove the alias \fBlet@header\fP,
1858
otherwise it will be called for all pages.
1860
\fBlet@sg_\fP\fItype\ name\ title\ n\ flag\ [arg1\ [arg2\ [...]]]\fP
1861
\&\fB.SG\fP is calling this macro only for letters, memorandums has
1862
its own processing. \fIname\fP and \fItitle\fP is specified
1863
thru \fB.WA\fP/\fB.WB\fP. \fIn\fP is the counter, 1-max, and
1864
\fIflag\fP is true for the last name. Any other argument to \fB.SG\fP
1867
\fBlet@fc_\fP\fItype\ closing\fP
1868
This macro is called by \fB.FC\fP, and has the
1869
formal closing as argument.
1871
\&\fB.LO\fP is implemented as a general option-macro. \fB.LO\fP demands
1872
that a string named \fBLet\fP\fItype\fP is defined, where \fItype\fP
1874
\&\fB.LO\fP will then assign the argument to the string
1875
variable \fBlet*lo-\fP\fItype\fP.
1879
J�rgen H�gg, Lund, Sweden <jh@axis.se>.
1882
.B @MACRODIR@/tmac.@TMAC_M_PREFIX@m
1884
.B @TMAC_MDIR@/*.cov
1888
.B @TMAC_MDIR@/locale
1890
.BR groff (@MAN1EXT@),
1891
.BR @g@troff (@MAN1EXT@),
1892
.BR @g@tbl (@MAN1EXT@),
1893
.BR @g@pic (@MAN1EXT@),
1894
.BR @g@eqn (@MAN1EXT@)
1897
.BR m@TMAC_M_PREFIX@mse (@MAN7EXT@)
1899
.\" Local Variables:
added
removed
contrib/mm/groff_mm.man
