groff_mm(7)

memorandum macros for GNU roff

Section 7 groff bookworm source

Description

'\" t

groff_mm - memorandum macros for GNU roff . .

. .

. .

.

.\|.\|.]

.\|.\|.]

.\|.\|.]

.\|.\|.]

. .

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

No Bell Labs localisms are implemented. .

The macros OK and PM are not implemented. .

groff mm does not support cut marks. . .

is intended to support easy localization. . Use

as an example how to adapt the output format to a national standard. . Localized strings are collected in the file

where

denotes the two-letter code for the

as defined in the ISO 639 standard. . For Swedish, this is \[oq]sv.tmac\[cq] \[en] not \[oq]se\[cq], which is the ISO 3166 two-letter code for the

(as used for the output format localization). . .

A file called

or

is read after the initialization of the global variables. . It is therefore possible to localize the macros with a different company name and so on. . .

In this manual, square brackets are used to show optional arguments. . .

. Many macros can be controlled by number registers and strings. . A number register is assigned with the

command: .

. .

is the name of the register,

the value to be assigned, and

the increment value for auto-increment. .

have a plus or minus sign as a prefix if an increment or decrement of the current value is wanted. . (Auto-increment or auto-decrement occurs if the number register is used with a plus or minus sign,

or

. .

Strings are defined with

.

.ds YYY string

. .

The string is assigned everything to the end of the line, even blanks. . Initial blanks in

should be prefixed with a double-quote. . (Strings are used in the text as

. .

. A number register is printed with normal digits if no format has been given. . Set the format with

.

. .

the name of the register,

the format. .

tab(@); lb lb l l. Form@Sequence 1@0, 1, 2, 3, .\|.\|. 001@000, 001, 002, 003, .\|.\|. i@0, i, ii, iii, iv, .\|.\|. I@0, I, II, III, IV, .\|.\|. a@0, a, b, c, .\|.\|., z, aa, ab, .\|.\|. A@0, A, B, C, .\|.\|., Z, AA, AB, .\|.\|.

. .

. In

the fonts (or rather, font styles)

and

are hardwired to font positions

and\~\c

respectively. . Internally, font positions are used for backwards compatibility. . From a practical point of view it doesn't make a big difference \[en] a different font family can still be selected with a call to the

request or using

command-line option. . On the other hand, if you want to replace just, say, font

you have to replace the font at position\~2 (with a call to \[oq].fp\~2\~.\|.\|.\[cq]). . .

.

Add heading text

to the table of contents with

which is either\~0 or in the range 1 to\~7. . See also

. This macro is used for customized tables of contents. .

Begin one-column processing. . A\~\c

as an argument disables the page break. . Use wide footnotes, small footnotes may be overprinted. .

Begin two-column processing. . Splits the page in two columns. . It is a special case of

See also

.

Abstract end, see

.

Author's firm, should be called before

see also

.

Start auto-increment list. . Items are numbered beginning with one. . The

argument controls the format of numbers. .

tab(@); lb lb l l. Arg@Description 1@Arabic (the default) A@Upper-case letters (A–Z) a@Lower-case letters (a–z) I@Upper-case roman i@Lower-case roman

.

sets the indentation and overrides

A third argument prohibits printing of a blank line before each item. .

Begin an appendix with name

. Automatic naming occurs if

is

. The appendices start with\~\c

if automatic naming is used. . A new page is ejected, and a header is also produced if the number variable

is non-zero. . This is the default. . The appendix always appears in the \[oq]List of contents\[cq] with correct page numbers. . The name \[oq]APPENDIX\[cq] can be changed by setting the string

to the desired text. . The string

contains the current appendix text. .

Same as

but the page number is incremented with

. This is used when diagrams or other non-formatted documents are included as appendices. .

Abstract start. . Indentation is specified in \[oq]ens\[cq], but scaling is allowed. . Argument

controls where the abstract is printed. .

tab(@); lb lb l lx. Arg@Placement 0@T{ Abstract is printed on page\~1 and on the cover sheet if used in the released-paper style (MT 4), otherwise it is printed on page\~1 without a cover sheet. T} 1@Abstract is only printed on the cover sheet (MT 4 only). 2@T{ Abstract is printed only on the cover sheet (other than MT 4 only). The cover sheet is printed without a need for CS. T}

.

An abstract is not printed at all in external letters (MT 5). . The

parameter controls the indentation of both margins, otherwise normal text indentation is used. .

Abstract title. . Default is \[oq]ABSTRACT\[cq]. . Sets the text above the abstract text. .

Author's title. .

must appear just after each

. The title shows up after the name in the signature block. .

Author information. . Specifies the author of the memo or paper, and is printed on the cover sheet and on other similar places.

must not appear before