GROFF_MM

NAME

groff_mm - groff mm macros

SYNOPSIS

groff -mgm [ options... ] [ files... ]

DESCRIPTION

The groff mm macros are intended to be compatible with the DWB mm macros with the following limitations:

mgm is intended to be international. Therefore it is possible to write short national macrofiles which change all english text to the preferred language. Use mgmse as an example.

Groff mm has several extensions:
APP name text

Begin an appendix with name name. Automatic naming occurs if name is "". The appendixes starts with A if auto is used. An new page is ejected, and a header is also produced if the number variable Aph is non-zero. This is the default. The appendix always appear in the ’List of contents’ with correct pagenumber. The name APPENDIX can be changed by setting the string App to the desired text.

APPSK name pages text

Same as .APP, but the pagenr is incremented with pages. This is used when diagrams or other non-formatted documents are included as appendixes.

COVER [arg]

COVER begins a coversheet definition. It is important that .COVER appears before any normal text. .COVER uses arg to build the filename /usr/local/lib/groff/tmac/mm/arg.cov. Therefore it is possible to create unlimited types of coversheets. ms.cov is supposed to look like the ms coversheet. .COVER requires a .COVEND at the end of the coverdefinition. Always use this order of the covermacros:
.COVER
.TL
.AF
.AU
.AT
.AS
.AE
.COVEND
However, only .TL and .AU are required.

COVEND

This finish the cover description and prints the cover-page. It is defined in the cover file.

GETHN refname [varname]

Includes the headernumber where the corresponding SETR refname was placed. Will be X.X.X. in pass 1. See INITR. If varname is used, GETHN sets the stringvariable varname to the headernumber.

GETPN refname [varname]

Includes the pagenumber where the corresponding SETR refname was placed. Will be 9999 in pass 1. See INITR. If varname is used, GETPN sets the stringvariable varname to the pagenumber.

GETR refname

Combines GETHN and GETPN with the text ’chapter’ and ’, page’. The string Qrf contains the text for reference:
.ds Qrf See chapter \\*[Qrfh], page \\*[Qrfp].
Qrf may be changed to support other languages. Strings Qrfh and Qrfp are set by GETR and contains the page and headernumber.

GETST refname [varname]

Includes the string saved with the second argument to .SETR. Will be dummystring in pass 1. If varname is used, GETST sets the stringvariable varname to the saved string. See INITR.

INITR filename

Initialize the refencemacros. References will be written to filename.tmp and filename.qrf. Requires two passes with groff. The first looks for references and the second includes them. INITR can be used several times, but it is only the first occurence of INITR that is active. See also SETR, GETPN and GETHN.

MC column-size [column-separation]

Begin multiple columns. Return to normal with 1C.

MT [arg [addressee]]

Memorandom type. The arg is part of a filename in /usr/local/lib/groff/tmac/mm/*.MT. Memorandum type 0 thru 5 are supported, including "string". Addresse just sets a variable, used in the AT&T macros.

MOVE y-pos [x-pos [line-length]]

Move to a position, pageoffset set to x-pos. If line-length is not given, the difference between current and new pageoffset is used. Use PGFORM without arguments to return to normal.

MULB cw1 space1 [cw2 space2 [cw3 ...]]

Begin a special multi-column mode. Every columns width must be specified. Also the space between the columns must be specified. The last column does not need any space-definition. MULB starts a diversion and MULE ends the diversion and prints the columns. The unit for width and space is ’n’, but MULB accepts all normal unitspecifications like ’c’ and ’i’. MULB operates in a separate environment.

PGFORM [linelength [pagelength [pageoffset]]]

Sets linelength, pagelength and/or pageoffset. This macro can be used for special formatting, like letterheads and other. PGFORM can be used without arguments to reset everything after a MOVE.

SETR refname [string]

Remember the current header and page-number as refname. Saves string if string is defined. string is retrieved with .GETST. See INITR.

VERBON [1/0 [pointsize [font]]]

Begin verbatim output using courier font. Usually for printing programs. All character has equal width. Escape-character (\) is normally turned off, but can be enabled by setting the first argument to 1. Th pointsize can also be changed with the second argument. By specifying the font-argument it is possible to use another font instead of courier.

VERBOFF

End verbatim output.

New variables in mgm:

The size of an empty line. Normally 0.5v, but it is 1v

if n is set (.nroff). MO1 - MO12 Strings containing January to December.

A file called locale or lang_locale is read after the initiation of the global variables. It is therefore possible to localize the macros with companyname and so on.

The following standard macros are implemented:

AF [name of firm]

Authors firm

AL [type [text-indent [1]]]]

Start autoincrement list

AS [arg [indent]]

Abstract start. Indent is specified in ’ens’, but scaling is allowed.

AST [title]

Abstract title. Default is ’ABSTRACT’.

AT title1 [title2 ...]

Authors title

AU name [initials [loc [dept [ext [room [arg [arg [arg]]]]]]]]

Author information

B [bold-text [prev-font-tex [...]]]

Begin boldface No limit on the number of arguments.

BI [bold-text [italic-text [bold-text [...]]]

Bold-italic. No limit on the number of arguments.

BL [text-indent [1]]

Start bullet list

BR [bold-text [roman-text [bold-text [...]]]

Bold-roman. No limit on the number of arguments.

DF [format [fill [rindent]]]

Begin floating display (no nesting allowed)

DL [text-indent [1]]

Dash list start

DS [format [fill [rindent]]]

Static display start. Can now have unlimited nesting. Also right adjusted text and block may be used (R or RB as format).

EC [title [override [flag [refname]]]]

Equation title. If refname is used, then the equationnumber is saved with .SETR, and can be retrieved with .GETST refname.

EF [arg]

Even-page footer.

EH [arg]

Even-page header.

EQ [label]

Equation start.

EX [title [override [flag [refname]]]]

Exhibit title. If refname is used, then the exhibitnumber is saved with .SETR, and can be retrieved with .GETST refname.

FD [arg [1]]

Footnote default format.

FG [title [override [flag [refname]]]]

Figure title. If refname is used, then the figurenumber is saved with .SETR, and can be retrieved with .GETST refname.

H level [heading-text [heading-suffix]]

Numbered heading.

HC [hypenation-character]

Set hypenation character.

HM [arg1 [arg2 [... [arg7]]]]

Heading mark style.

HU heading-text

Unnumbered header.

HX dlevel rlevel heading-text

Userdefined heading exit. Called just before printing the header.

HY dlevel rlevel heading-text

Userdefined heading exit. Called just before printing the header.

HZ dlevel rlevel heading-text

Userdefined heading exit. Called just after printing the header.

I [italic-text [prev-font-text [italic-text [...]]]

Italic.

IB [italic-text [bold-text [italic-text [...]]]

Italic-bold

IR [italic-text [roman-text [italic-text [...]]]

Italic-roman

LB text-indent mark-indent pad type [mark [LI-space [LB-space]]]

List begin macro.

LC [list level]

List-status clear

LI [mark [1]]

List item

ML mark [text-indent]

Marked list start

MT [arg [addressee]]

Memorandom type. See above note about MT.

ND new-date

New date.

OF [arg]

Odd-page footer

OH [arg]

Odd-page header

P [type]

Begin new paragraph.

PF [arg]

Page footer

PH [arg]

Page header

RB [roman-text [bold-text [roman-text [...]]]

Roman-bold.

RD [prompt [diversion [string]]]

Read to diversion and/or string.

RI [roman-text [italic-text [roman-text [...]]]

Roman-italic.

RL [text-indent [1]]

Reference list start

RP [arg [arg]]

Produce reference page.

RS [string-name]

Reference start.

S [size [spacing]]

Set point size and vertical spacing. If any argument is equal ’P’, then the previous value is used. A ’C’ means current value, and ’D’ default value. If ’+’ or ’-’ is used before the value, then increment or decrement of the current value will be done.

SA [arg]

Set adjustment.

SK [pages]

Skip pages.

SM string1 [string2 [string3]]

Make a string smaller.

SP [lines]

Space vertically. lines can have any scalingfactor, like 3i or 8v.

TB [title [override [flag [refname]]]]

Table title. If refname is used, then the tablenumber is saved with .SETR, and can be retrieved with .GETST refname.

TC [slevel [spacing [tlevel [tab [h1 [h2 [h3 [h4 [h5]]]]]]]]]

Table of contents. All texts can be redefined, new stringvariables Lifg, Litb, Liex, Liec and Licon contains "Figure", "TABLE", "Exhibit", "Equation" and "CONTENTS". These can be redefined to other languages.

TH [N]

Table header.

TM [num1 [num2 [...]]]

Technical memorandumnumbers used in .MT. Unlimited number of arguments may be given.

TS [H]

Table start

VL [text-indent [mark-indent [1]]]

Variable-item list start

VM [top [bottom]]

Vertical margin.

WC [format]

Footnote and display width control.

Strings used in mgm:

Number variables used in mgm:

1 -> indent to right , like .P 1
2 -> indent to line up with text part of preceding heading

1 -> single

1 -> hyphenation 14 on

Lf=1, Lt=1, Lx=1, Le=0

Enables (1) or disables (0) the printing of List of figures, List of tables, List of exhibits and List of equations.

1 == header replaces footer on first page, header is empty.
2 == page header is removed on the first page.
3 == "section-page" numbering enabled.
4 == page header is removed on the first page.
5 == "section-page" and "section-figure" numbering enabled. Se also the number-register Sectf and Sectp.

0 == not numbered
1 == numbered in first level headings.

0= ". "
1= " - "

0 == left-justified
1 == indented .P
2 == indented .P except after .H, .DE or .LE.

AUTHOR

Jörgen Hägg, Lund Institute of Technology, Sweden <jh@efd.lth.se>

FILES

/usr/local/lib/groff/tmac/tmac.gm
/usr/local/lib/groff/tmac/mm/*.cov
/usr/local/lib/groff/tmac/mm/*.MT
/usr/local/lib/groff/tmac/mm/locale

SEE ALSO

groff(1), gtroff(1), gtbl(1), gpic(1), geqn(1)
mm(7) mgmse(7)