'\" t
.TH groff_mm 7 "2026-03-15" "groff 1.24.1"
.SH Name
groff_mm \- memorandum macros for GNU
.I roff
.
.
.\" ====================================================================
.\" Legal Terms
.\" ====================================================================
.\"
.\" Copyright 1989-2019 Free Software Foundation, Inc.
.\"           2020-2026 G. Branden Robinson
.\"
.\" This file is part of mm, a reimplementation of the Documenter's
.\" Workbench (DWB) troff memorandum macro package for use with GNU
.\" troff.
.\"
.\" mm is distributed with groff, the GNU roff typesetting system.
.\"
.\" Permission is granted to make and distribute verbatim copies of this
.\" manual provided the copyright notice and this permission notice are
.\" preserved on all copies.
.\"
.\" Permission is granted to copy and distribute modified versions of
.\" this manual under the conditions for verbatim copying, provided that
.\" the entire resulting derived work is distributed under the terms of
.\" a permission notice identical to this one.
.\"
.\" Permission is granted to copy and distribute translations of this
.\" manual into another language, under the above conditions for
.\" modified versions, except that this permission notice may be
.\" included in translations approved by the Free Software Foundation
.\" instead of in the original English.
.
.
.\" Save and disable compatibility mode (for, e.g., Solaris 10/11).
.do nr *groff_groff_mm_7_man_C \n[.cp]
.cp 0
.
.\" Define fallback for groff 1.23's MR macro if the system lacks it.
.nr do-fallback 0
.if !\n(.f           .nr do-fallback 1 \" mandoc
.if  \n(.g .if !d MR .nr do-fallback 1 \" older groff
.if !\n(.g           .nr do-fallback 1 \" non-groff *roff
.if \n[do-fallback]  \{\
.  de MR
.    ie \\n(.$=1 \
.      I \%\\$1
.    el \
.      IR \%\\$1 (\\$2)\\$3
.  .
.\}
.rr do-fallback
.
.
.\" ====================================================================
.SH Synopsis
.\" ====================================================================
.
.SY "groff \-m\%m"
.RI [ option\~ .\|.\|.\&]
.RI [ file\~ .\|.\|.]
.YS
.
.SY "groff \-m m\%m"
.RI [ option\~ .\|.\|.\&]
.RI [ file\~ .\|.\|.]
.YS
.
.
.\" ====================================================================
.SH Description
.\" ====================================================================
.
The
.I mm
macro package distributed with the
.I groff
document formatting system
is suitable for the composition of
letters,
memoranda,
reports,
and books.
.
.
.P
Call an
.I mm
macro at the beginning of a document to initialize the package.
.
A simple
.I mm
document might use only
.B P
for paragraphing.
.
Set numbered and unnumbered section headings with
.B H
and
.BR HU ,
respectively.
.
Change the style of the typeface with
.BR B ,
.BR I ,
and
.BR R ;
you can alternate styles within a word with
.BR BI ,
.BR BR ,
.BR IB ,
.BR IR ,
.BR RB ,
and
.BR RI .
.
Several nestable list types are available via
.BR AL ,
.BR BL ,
.BR BVL ,
.BR DL ,
.BR ML ,
.BR RL ,
and
.BR VL ;
each of these begins a list,
to which
.B LI
adds an item and
.B LE
ends the (nested) list.
.
.B LB
begins a list with customizable layout parameters.
.
.B DS
and
.B DF
start static and floating displays,
respectively;
.B DE
terminates either.
.
.
.P
.I groff mm
is intended to be compatible with the
.I mm
implementation found in the AT&T Documenter's Workbench 3.3
(\[lq]DWB\[rq]),
with the following limitations and changes.
.
.
.IP \[bu] 3n
Omitted features include
the logo and company name strings,
.B }Z
and
.BR ]S ,
respectively;
the encoded company site location addresses recognized as the third
argument to the
.B AU
macro;
the
.B Pv
(\[lq]private\[rq] heading)
register;
and the
.B OK
(other keywords)
and
.B PM
(proprietary markings)
macros.
.
.
.IP \[bu]
.I "groff mm"
implements the
.B CS
(output cover page or \[lq]sheet\[rq])
macro only for memorandum type 4.
.
.
.IP \[bu]
The
.I grap
preprocessor is not explicitly supported;
.I "groff mm"
defines no
.B G1
or
.B G2
macros.
.
.
.IP \[bu]
Registers
.BR A ,
.BR C ,
.BR T ,
and
.BR U ,
set from the
.I troff \" generic
or
.I nroff \" generic
command lines with DWB,
are not recognized.
.
.
.IP \[bu]
When setting the registers
.B L
or
.B W
from the command line,
use an explicit scaling unit to avoid surprises.
.
.
.IP \[bu]
The
.B Le
register defaults to
.BR 1 ,
consistently with
.BR Lf ,
.BR Lt ,
and
.B Lx
in DWB;
equations captioned with
.B EC
appear in tables of contents produced by
.BR TC .
.
.
.IP \[bu]
The
.B Li
register configures the text indentation of
.B RL
list items;
DWB used a hard-coded value of 6\~ens.
.
.
.IP \[bu]
.I "groff mm"
uses the same adjustment and font style defaults in
.I nroff
and
.I troff
modes.
.
.
.IP \[bu]
Cut marks are not supported.
.
.
.P
DWB supported only seven heading levels.
.
As a compatible extension,
.I groff mm
supports fourteen,
introducing new registers
.B H8
through
.BR H14 ,
and affecting the interpretation of the
.B HF
and
.B HP
strings.
.
.
.P
.I "groff mm"
features a citation
(or \[lq]bookmark\[rq])
system,
permitting the document to make (customizable) internal references like
\[lq]See chapter 5,
page 128.\[rq].
.
Forward references require two-pass formatting.
.
See the
.B INITR
macro description below
and
.MR mmroff 1 .
.
.
.P
Macro,
register,
and string descriptions in this page frequently mention each other;
most references are to macros.
.
Where a register or string is referenced,
its type is explicitly identified.
.
.IR mm 's
macro names are usually in full capitals;
registers and strings tend to have mixed-case names.
.
.
.P
Except where noted,
.I mm
assumes that horizontal measurements are reckoned in ens
(scaling unit
.BR n )
and vertical ones in vees
(scaling unit
.BR v ).
.
.I "groff mm"
permits use of non-integral
.I "typographical points"
(scaling unit
.BR z ).
.
Use explicit scaling units for clarity and predictable behavior.
.
.
.\" ====================================================================
.SS "Document styles"
.\" ====================================================================
.
.I groff mm
offers three frameworks for document organization.
.
.BR \%COVER /\: \%COVEND
is a flexible means of preparing any document requiring a cover page.
.
.BR LT / LO
aids preparation of typical Anglophone correspondence
(business letters,
for example).
.
The
.B MT
memorandum type mechanism implements a group of formal styles
historically used by AT&T Bell Laboratories.
.
Your document can select at most one of these approaches;
when used,
each disables the others.
.
.
.\" ====================================================================
.SS Localization
.\" ====================================================================
.
.I groff mm
is designed to be easily localized.
.
For languages other than English,
strings that can appear in output are collected in the file
.IR /usr/\:\%share/\:\%groff/\:\%1.24.1/\:\%tmac/\: xx \:.tmac ,
where
.I xx
is an ISO\~639 two-letter language identifier.
.
Localization packages should be loaded after
.IR mm ;
for example,
you might format a Swedish
.I mm
document with the command
.RB \[lq] "groff \-mm \-msv" \[rq].
.
.
.P
This package can also be localized by site or territory;
for example,
.I /usr/\:\%share/\:\%groff/\:\%1.24.1/\:\%tmac/\:\%mse\:.tmac
illustrates how to adapt the output to a national standard using its
ISO\~3166 territory code.
.
Such a package can define a string that causes a macro file
.IR /usr/\:\%share/\:\%groff/\:\%1.24.1/\:\%tmac/\:mm/\:\% territory _locale
to be loaded at package initialization.
.
If this mechanism is not used,
.I /usr/\:\%share/\:\%groff/\:\%1.24.1/\:\%tmac/\:mm/\:\%locale
is loaded instead.
.
No diagnostic is produced if these files do not exist.
.
.
.\" ====================================================================
.SS "Registers and strings"
.\" ====================================================================
.
Much
.I mm
behavior can be configured by registers and strings.
.
The
.B nr
request assigns a value to a register.
.
.
.RS
.P
.B .nr
.I ident
.RB [ \[+-] ]\c
.I n
.RI [ i ]
.RE
.
.
.P
.I ident
is the name of the register,
and
.IR n \~is
the value to be assigned.
.
Prefixing
.I n
with
a plus or minus sign increments or decrements (respectively) its
existing value.
.
If assignment of a (possibly) negative
.IR n \~is
required,
further prefix it with a zero or enclose it in parentheses.
.
If
.IR i \~is
specified,
the register's value automatically changes
.RI by \~i
prior to interpolation if a plus or minus sign is included in the escape
sequence as follows.
.
.
.RS
.P
.B \[rs]n\c
.RB [ \[+-] ]\c
.BI [ ident ]
.RE
.
.
.P
.IR i \~can
be negative;
it combines algebraically with the sign in the interpolation escape
sequence.
.
The brackets around
.I ident
are literal.
.
.
.P
Many of the registers
.I mm
provides are as Boolean-valued,
meaning that they are considered \[lq]true\[rq]
(on,
enabled)
when they have a positive value,
and \[lq]false\[rq]
(off,
disabled)
otherwise.
.
.
.P
Define strings with the
.B ds
request.
.
.
.RS
.P
.B .ds
.I ident contents
.RE
.
.
.P
.I contents
consumes everything up to the end of the line,
including trailing spaces.
.
It is a good practice to end
.I contents
with a comment escape sequence
.RB ( \[rs]\[dq] )
so that extraneous spaces do not intrude during document maintenance.
.
To include leading spaces in
.IR contents ,
prefix it with a double quote.
.
Interpolate strings with the
.B \[rs]*
escape sequence.
.
.
.RS
.P
.B \[rs]*\c
.BI [ ident ]
.RE
.
.
.P
Register and string name spaces are distinct,
but strings and macros share a name space.
.
Defining a string with the same name as an
.I mm
macro is not supported and may cause incorrect rendering,
the emission of diagnostic messages,
and an error exit status from
.IR \%troff .
.
.
.\" ====================================================================
.SS "Register format"
.\" ====================================================================
.
A register is interpolated using Arabic numerals if no other format has
been assigned to it.
.
Assign a format to a register with the
.B af
request.
.
.
.RS
.LP
.BI .af\~ "R c"
.RE
.
.
.LP
.IR R \~is
the name of the register,
and
.IR c \~is
the format.
.
If
.IR c \~is
a sequence of Arabic numerals,
their quantity defines a zero-padded minimum width for the interpolated
register value.
.
.
.RS
.LP
.TS
tab(@);
lb lb
l l.
Form@Sequence
1@0, 1, 2, 3, .\|.\|., 10, .\|.\|.
001@000, 001, 002, 003, .\|.\|., 1000, .\|.\|.
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, .\|.\|.
.TE
.RE
.
.
.\" ====================================================================
.SS Fonts
.\" ====================================================================
.
.I mm
assumes that the font styles
.BR R \~(roman),
.BR I \~(italic),
and
.BR B \~(bold)
are mounted at font positions
.BR 1 ,
.BR 2 ,
.RB and\~ 3 ,
respectively.
.
Use the
.B fp
request to mount substitute fonts at these positions as desired.
.
The default font family is
.RB \[lq] T \[rq]
(Times).
.
To select a different one,
invoke
.IR groff 's
.B fam
request or use its
.B \-f
command-line option.
.
.
.\" ====================================================================
.SH Macros
.\" ====================================================================
.
Double-quote macro arguments that contain space characters.
.
An explicitly empty argument may be specified
with an empty pair of double quotes;
for example,
the following macro call has three arguments.
.
.
.P
.RS
.EX
\&.XX \[dq]foo bar\[dq] \[dq]\[dq] baz
.EE
.RE
.
.
.P
Some macros are documented as causing a page break;
this does not occur if such a macro is called when the drawing position
is already at the top of a page
(after a page heading,
if any).
.
.
.P
.I Hook
macros are undefined by default;
.I mm
calls them to enable customization of its behavior.
.
(DWB termed these \[lq]exits\[rq].)
.
.
.P
Macro names longer than two characters are extensions;
some shorter names were not part of DWB's
published interface but are documented aspects of
.I groff mm.
.
.
.TP 8n \" "COVEND" + 2n
.BR 1C\~ [ 1 ]
Format page text in one column
(the default layout).
.
The page is broken.
.
.RB A\~ 1
argument suppresses this break;
its use may cause body text and a pending footnote to overprint.
.
See
.BR 2C ,
.BR MC ,
and
.BR NCOL .
.
.
.TP
.B 2C
Begin two-column formatting.
.
This is a special case of
.BR MC .
.
See
.B 1C
and
.BR NCOL .
.
.
.TP
.B AE
Abstract end;
stop collecting abstract text.
.
See
.BR AS .
.
.
.\" In DWB mm, the mnemonic for `AF` was "alternate first-page format",
.\" and was described in the context of the `A` register and `}Z` and
.\" `]S` strings, none of which we support.
.\"
.\" The "mm Reference" in _XENIX 286 Text Formatting Guide_ (1984) used
.\" "affiliation", which makes sense to GBR.
.TP
.BR AF \~[\c
.IR org-name ]
Specify a memorandum's organizational affiliation.
.
At most one can be declared;
.I org-name
is used by
.B MT
memoranda and available to cover pages.
.
See
.BR COVER .
.
.
.TP
.B AFX
Define this hook macro to assume responsibility for formatting the
affiliated firm name defined by
.B AF
in memorandum types 0 and 4 and documents using the
.I ms
cover page style.
.
If not defined
(the default),
internally defined macros handle this task;
see subsection \[lq]Internals\[rq] and section \[lq]Files\[rq] below.
.
Applications include setting the firm name in a different font family
or at a larger type size,
drawing a rule across the page,
and including a logo image using
.IR groff 's
.B PDFPIC
or
.B PSPIC
macros.
.
See
.BR MT ,
.BR COVER ,
and
.MR groff_tmac 5 .
.
.
.TP
.BR AL \~[\c
.IR number-format \~[ text-indent \~[\c
.BR 1 ]]]
Begin an auto-incrementing numbered list,
where item numbers start at one and are followed by a dot.
.
.I number-format
assigns the register format
(see above)
.I mm
uses for the list item enumerators.
.
The default
.RB is\~ 0 .
.
A
.I text-indent
argument overrides register
.BR Li .
.
A third argument suppresses the vertical space that normally precedes
each list item;
see register
.BR Lsp .
.
Vertical space in the amount of
.B Lsp
precedes the list itself,
but does not accumulate with pre-item space
when this list is nested in another.
.
.B AL
calls
.BR LB ;
use
.B LI
to declare list items,
and
.B LE
to end the list.
.
.
.TP
.BR APP \~\c
.RI [ sequence-number\~ [ title ]]
Begin an appendix.
.
If
.I sequence-number
is omitted,
it increments
(or is initialized
.RB to\~ 1 ,
.\" ...technically, initialized to zero but autoincremented.
if necessary).
.
The register format used for
.I sequence-number
is \[lq]A\[rq].
.
The page is broken.
.
The register
.B Aph
determines whether an appendix heading is then formatted.
.
This heading uses the string
.B App
followed by
.IR sequence-number .
.
Appendices appear in any table of contents
(see
.BR TC ).
.
The string
.B \%Apptxt
is set to
.I title
if the latter is present,
and made empty otherwise.
.
.
.TP
.BI APPSK\~ "sequence-number n" \~\c
.RI [ title ]
As
.BR APP ,
but increment the page number by
.IR n .
.
Use this macro to \[lq]skip pages\[rq] when diagrams or other materials
not formatted by
.I \%troff
are included in appendices.
.
.
.TP
.BR AS\~ [\c
.IR placement \~[ indentation ]]
Abstract start;
begin collecting abstract.
.
Input up to the next
.B AE
call is included in the abstract.
.
.I placement
influences the location of the abstract on the cover page of a
memorandum
(see
.BR MT ).
.
.BR \%COVER ,
by contrast,
ignores
.I placement
by default,
but can be customized to interpret it.
.
.
.br
.ne 4v
.IP
.TS
tab(@);
lf(BI) lb
l lx.
placement@Effect
0@T{
The abstract appears on page\~1 and cover page if the document is a
\[lq]released paper\[rq] memorandum
.RB (\[lq] ".MT 4" \[rq]);
otherwise,
it appears on page\~1 without a cover page.
T}
1@T{
The abstract appears only on the cover page
.RB (\[lq] ".MT 4" \[rq]
only).
T}
.\" XXX: This does not appear to be implemented.
.\"2@T{
.\"The abstract is printed only on the cover page (if not
.\".BR ".MT 4" )
.\".
.\"The cover page is printed without a need for \fBCS\fP.
.\"T}
.TE
.
.
.IP
An abstract does not appear at all in external letters
.RB (\[lq] ".MT 5" \[rq]).
.
.RI A\~ placement
of
.B 2
was supported by DWB,
but is not by
.IR "groff mm" .
.
.
.IP
A second argument increases the indentation by
.I indentation
and reduces the line length by twice this amount.
.
The default
.RB is\~ 0 .
.
.
.TP
.BI AT\~ title\c
\~.\|.\|.
Specify author's title(s).
.
If present,
.B AT
must appear just after the corresponding author's
.BR AU .
.
Each
.I title
occupies an output line beneath the author's name in the signature block
used by
.B LT
letters
(see
.BR SG )
and in
.B MT
memoranda.
.
The
.I ms
cover page style also formats these data.
.
.
.br
.ne 7v
.TP
.BR AU \~\c
.RI [ name\~\c
.RI [ initials\~\c
.RI [ loc\~\c
.RI [ dept\~\c
.RI [ ext\~\c
.RI [ room\~\c
.RI [ arg1\~\c
.RI [ arg2\~\c
.RI [ arg3 ]]]]]]]]]
Specify author.
.
.B AU
terminates a document title started with
.BR TL ,
and can be called without arguments for that purpose.
.
Author information is used by cover pages,
.B MT
memoranda,
and
.BR SG .
.
Further arguments comprise
initials,
location,
department,
telephone extension,
room number or name,
and up to three additional items.
.
Repeat
.B AU
to identify multiple authors.
.
.
.IP
Use
.BR WA / WE
instead to identify the author for documents employing
.BR LT .
.
.
.TP
.BR AV \~[\c
.IR name \~[\c
.BR 1 ]]
Format approval lines for a handwritten signature and date.
.
Two horizontal rules are drawn,
with the specified
.I name
and the text of the string
.BR Letdate ,
respectively,
beneath them.
.
Above these rules,
.I mm
formats the text in the string
.BR Letapp ;
a second argument replaces this text with one vee of vertical space.
.
See
.BR LT .
.
.
.\" XXX: AVL is misnamed; it should have been called SGL or similar.
.TP
.BR AVL \~[\c
.IR name ]
As
.BR AV ,
but omitting the approval notation
(the
.B Letapp
string),
the date rule,
and the label below the date rule
(the
.B Letdate
string).
.
.
.TP
.BR B \~\c \" space in roman; we must use 2-font macro with \c
.RI [ bold-text\~\c
.RI [ previous-font-text ]]\~.\|.\|.
Join
.I bold-text
in boldface with
.I previous-font-text
in the previous font,
without space between the arguments.
.
If no arguments,
switch font to bold style.
.
.
.TP
.B B1
Begin boxed static display.
.
The text is indented by
.BR 1n ,
and the line length reduced by
.BR 2n .
.
See
.BR DS .
.
This is a
.I groff mm
extension.
.
.
.TP
.B B2
End boxed static display.
.
See
.BR B1 .
.
This is a
.I groff mm
extension.
.
.
.TP
.B BE
End bottom block; see
.BR BS .
.
.
.TP
.BR BI \~\c \" space in roman; we must use 2-font macro with \c
.RI [ bold-text\~\c
.RI [ italic-text ]]\~.\|.\|.
Join
.I bold-text
in boldface with
.I italic-text
in italics,
without space between the arguments.
.
.
.TP
.BR BL \~[\c
.IR text-indent \~[\c
.BR 1 ]]
Begin bulleted list.
.
.I mm
marks each item with the string
.BR BU .
.
A
.I text-indent
argument overrides register
.BR Pi .
.
A second argument suppresses the vertical space that normally precedes
each list item;
see register
.BR Lsp .
.
Vertical space in the amount of
.B Lsp
precedes the list itself,
but does not accumulate with pre-item space
when this list is nested in another.
.
.B BL
calls
.BR LB ;
use
.B LI
to declare list items,
and
.B LE
to end the list.
.
.
.TP
.BR BR \~\c \" space in roman; we must use 2-font macro with \c
.RI [ bold-text\~\c
.RI [ roman-text ]]\~.\|.\|.
Join
.I bold-text
in boldface with
.I roman-text
in roman style,
without space between the arguments.
.
.
.TP
.B BS
Begin bottom block.
.
.I mm
collects input into the bottom block until the document calls
.BR BE ,
and outputs it between the footnote area and footer of each page.
.
.
.\" XXX: Couldn't this have been done with an extra parameter to `VL`?
.\" Or a register influencing VL behavior?
.TP
.BR BVL \~[\c
.IR text-indent \~[ mark-indent \~[\c
.BR 1 ]]]
Begin broken variable-item
(or \[lq]tagged\[rq])
list.
.
Each item should supply its own mark.
.
The line is always broken after the mark;
contrast
.BR VL .
.
A
.I text-indent
argument overrides register
.BR Pi ;
.I mark-indent
sets the distance from the indentation of the current list to the mark.
.
A third argument suppresses the vertical space that normally precedes
each list item;
see register
.BR Lsp .
.
Vertical space in the amount of
.B Lsp
precedes the list itself,
but does not accumulate with pre-item space
when this list is nested in another.
.
.B BVL
calls
.BR LB ;
use
.B LI
to declare list items,
and
.B LE
to end the list.
.
.
.TP
.BR \%COVER \~\c \" space in roman; we must use 2-font macro with \c
.RI [ style ]
Begin a cover page description.
.
.B \%COVER
must appear before the body text
(or main matter)
of a document.
.
The argument
.I style
is used to construct the file name
.IR /usr/\:\%share/\:\%groff/\:\%1.24.1/\:\%tmac/mm/\: style \:.cov
and load it with the
.B mso
request.
.
The default
.I style
is
.RB \[lq] ms \[rq];
the
.I ms.cov
file prepares a cover page resembling that of the
.I ms
package.
.
A
.I .cov
file must define a
.B \%COVEND
macro,
which a document must call at the end of the cover description.
.
Use cover description macros in the following order;
only
.B TL
and
.B AU
are required.
.
.
.IP
.EX
\&.COVER
\&.AF
\&.TL
\&.AU
\&.AT
\&.\[rs]" Add additional AU and AT calls as needed.
\&.AS
.ne 2v
\&.AE
\&.COVEND
.EE
.
.
.TP
.B COVEND
End the cover description.
.
.
.TP
.B DE
End static or floating display begun with
.B DS
or
.BR DF .
.
.
.TP
.BR DF\~ [\c
.IR format \~[ fill \~[ right-indentation ]]]
Begin floating display.
.
A floating display is saved in a queue and output in the order entered.
.
Arguments are handled as in
.BR DS .
.
Floating displays cannot be nested.
.
Placement of floating displays is controlled by the registers
.B De
and
.BR Df .
.
.
.TP
.BR DL \~[\c
.IR text-indent \~[\c
.BR 1 ]]
Begin dashed list.
.
.I mm
marks each item with the string
.BR EM .
.
A
.I text-indent
argument overrides register
.BR Pi .
.
A second argument suppresses the vertical space that normally precedes
each list item;
see register
.BR Lsp .
.
Vertical space in the amount of
.B Lsp
precedes the list itself,
but does not accumulate with pre-item space
when this list is nested in another.
.
.B DL
calls
.BR LB ;
use
.B LI
to declare list items,
and
.B LE
to end the list.
.
.
.TP
.BR DS \~[\c
.IR format \~[\c
.IR fill \~[\c
.IR right-indentation ]]]
Begin static display.
.
.I mm
collects input into a display until the document calls
.BR DE .
.
The display is output on a single page unless it is taller than the
height of the page.
.
.B DS
can be nested
(contrast with
.BR DF ).
.
.
.IP
.TS
tab(@);
Lf(BI) Lb
L Lx.
format@Effect
\f[I]none\f[]@Do not indent the display.
L@Do not indent the display.
I@T{
Indent text by
.BR \[rs]n[Si] .
T}
C@Center each line.
CB@Center the whole display as a block.
R@Right-align each line.
RB@Right-align the whole display as a block.
.TE
.
.
.IP
The values \[lq]L\[rq],
\[lq]I\[rq],
\[lq]C\[rq],
and \[lq]CB\[rq] can also be specified as \[lq]0\[rq],
\[lq]1\[rq],
\[lq]2\[rq],
and
\[lq]3\[rq],
respectively,
for compatibility with DWB.
.
.
.br
.ne 4v
.IP
.TS
tab(@);
Lf(BI) Lb
L Lx.
fill@Effect
\f[I]none\f[]@Disable filling.
N@Disable filling.
F@Enable filling.
.TE
.
.
.IP
\[lq]N\[rq] and \[lq]F\[rq] can also be specified as \[lq]0\[rq] and
\[lq]1\[rq],
respectively,
for compatibility with DWB.
.
.
.IP
A third argument
reduces the line length by
.I right-indentation.
.
.
.IP
.I mm
normally
places vertical space before and after the display.
.
Set register
.B Ds
to \[lq]0\[rq] to suppress it.
.
.
.TP
.BR EC \~\c
.RI [ title \~[ override \~[ flag \~[ ref-name ]]]]
Caption an equation.
.
A caption comprises the string
.B Capec
followed by an automatically incrementing counter stored in the register
.BR Ec ,
punctuation configured by the register
.BR Of ,
then
.I title
(if any).
.
Use the
.B af
request to configure
.BR Ec 's
number format.
.
.I override
and
.I flag
alter the equation number as follows.
.
Omitting
.I flag
and specifying
.B 0
in its place are equivalent.
.
.
.IP
.TS
tab(@);
Lf(BI) Lb
L Lx.
flag@Effect
0@T{
Prefix number with
.IR override .
T}
1@T{
Suffix number with
.IR override .
T}
2@T{
Replace number with
.IR override .
T}
.TE
.
.
.IP
.I mm
centers equation captions irrespective of the alignment of any enclosing
display.
.
.
.IP
Specifying
.I ref-name
stores the equation number as if by
.RB \[lq] .SETR
.I ref-name
.BR \[rs]n[Ec] \[rq].
.
Recognition of this argument is a
.I groff mm
extension.
.
.
.IP
The package lists captioned equations in a table of contents
(see
.BR TC )
if the Boolean register
.B Le
is true.
.
The string
.B Le
captions this list.
.
.
.TP
.BR EF\~ [ \[dq]\|\[aq]\c
.IB left \[aq] center \[aq] right \[aq]\|\[dq]\c
]
Define the even-page footer,
which is formatted just above the normal page footer on even-numbered
pages.
.
See
.BR PF .
.
.B EF
defines the string
.BR EOPef .
.
.
.TP
.BR EH\~ [ \[dq]\|\[aq]\c
.IB left \[aq] center \[aq] right \[aq]\|\[dq]\c
]
Define the even-page header,
which is formatted just below the normal page header on even-numbered
pages.
.
See
.BR PH .
.
.B EH
defines the string
.BR TPeh .
.
.
.TP
.B EN
End mathematical expression input preprocessed by
.MR \%eqn 1 ;
see
.BR EQ .
.
.
.TP
.B EOP
.I "groff mm"
calls this hook macro in lieu of normal page footer layout.
.
The package uses a separate environment to format headers and footers.
.
See
.BR TP .
.
.
.br
.ie t .ne 4v
.el   .ne 5v \" for horizontal rule
.IP
.TS
tab(@);
Cb S
Lb L.
Strings available to EOP
_
EOPf@argument to \fBPF\fP
EOPef@argument to \fBEF\fP
EOPof@argument to \fBOF\fP
.TE
.
.
.TP
.BR EPIC\~ [\c
.BR \-L ]\~\c
.IR "width height" \~[ name ]
Draw a box with the given
.I width
and
.IR height .
.
The text
.I name
(or default text)
is formatted inside the box;
no attempt is made to size the box to fit the text.
.
An application of this macro is to indicate the placement of an image to
be determined later,
or externally composited in postprocessing.
.
.B \-L
as the first argument
left-aligns the box;
the default is to center it.
.
See
.BR PIC .
.
.
.TP
.BR EQ \~[\c
.IR label ]
Start mathematical expression input preprocessed by
.MR \%eqn 1 .
.
.B EQ
and
.B EN
macro calls bracket an equation region.
.
Such regions must be contained in displays
.RB ( DS / DE ),
except when the region is used only to configure
.I \%eqn
and not to produce output.
.
If present,
.I label
appears aligned to the right and
centered vertically within the display;
see register
.BR Eq .
.
.
If multiple
.I eqn \" generic
regions occur within a display,
only the last
.I label
(if any)
is used.
.
.
.TP
.BR EX \~\c
.RI [ title \~[ override \~[ flag \~[ ref-name ]]]]
Caption an exhibit.
.
Arguments are handled analogously to
.BR EC .
.
The register
.B Ex
is the exhibit counter.
.
The string
.B Capex
precedes the exhibit number and any
.I title.
.
.I mm
centers exhibit captions irrespective of the alignment of any enclosing
display.
.
.
.IP
The package lists captioned exhibits in a table of contents
(see
.BR TC )
if the Boolean register
.B Lx
is true.
.
The string
.B Lx
captions this list.
.
.
.TP
.BR FC \~[\c
.IR closing-text ]
Output the string
.BR Letfc ,
or the specified
.I closing-text,
as the formal closing of a letter or memorandum.
.
See
.B LT
and
.BR MT .
.
.
.TP
.BR FD \~[\c
.IR arg \~[\c
.BR 1 ]]
Configure display of footnotes.
.
The first argument encodes enablement of
automatic hyphenation,
adjustment to both margins,
indentation of footnote text,
and left- vs.\& right-alignment of the footnote label within the space
allocated for it.
.
.
.br
.ne 5v
.IP
.\" XXX: We can fit one more row using "nokeep" vs. not using it.
.TS
tab(@) nokeep;
Lf(BI) Lb Lb Lb Lb
L L L L L.
arg@Hyphenate?@Adjust?@Indent?@Label alignment
0@no@yes@yes@left
1@yes@yes@yes@left
2@no@no@yes@left
3@yes@no@yes@left
4@no@yes@no@left
5@yes@yes@no@left
6@no@no@no@left
7@yes@no@no@left
8@no@yes@yes@right
9@yes@yes@yes@right
10@no@no@yes@right
11@yes@no@yes@right
.TE
.
.
.IP
An
.I arg
greater than 11 is treated
.RB as\~ 0 .
.
.IR mm 's
default
.RB is\~ 0 .
.
.
.IP
A second argument resets footnote numbering when a first-level heading
is encountered.
.
See
.BR FS .
.
.
.TP
.B FE
End footnote;
see
.BR FS .
.
.
.TP
.BR FG \~\c
.RI [ title \~[ override \~[ flag \~[ ref-name ]]]]
Caption a figure.
.
Arguments are handled analogously to
.BR EC .
.
The register
.B Fg
is the figure counter.
.
The string
.B Capfg
precedes the figure number and any
.I title.
.
.I mm
centers figure captions irrespective of the alignment of any enclosing
display.
.
.
.IP
The package lists captioned figures in a table of contents
(see
.BR TC )
if the Boolean register
.B Lf
is true.
.
The string
.B Lf
captions this list.
.
.
.TP
.BR FS \~[\c
.IR mark ]
Start footnote.
.
.I mm
collects input into a footnote until the document calls
.BR FE ,
outputting it when the vertical drawing position nears the page bottom.
.
By default,
.I mm
automatically numbers footnotes starting at 1;
the number is available in register
.B Ftnum
and,
with a trailing period,
in
.RB string\~ F .
.
If desired,
interpolate this string in the body text to format the footnote mark.
.
.I mm
interpolates
.RB string\~ F
prior to the footnote text.
.
Footnotes are vertically separated by the product of
.RB registers\~ Fs
and
.BR Lsp .
.
In
.IR "groff mm" ,
footnotes may be used in displays.
.
.
.IP
A
.I mark
argument,
which need not be numeric,
replaces the default footnote mark,
leaving the
.RB string\~ F
unchanged.
.
In that event,
you must explicitly write any footnote mark to appear
in the footnote itself.
.
.
.TP
.BI GETHN\~ ref-name\~\c
.RI [ string ]
Interpolate
.IR ref-name 's
heading mark,
or,
if
.I string
is specified,
store it there.
.
In neither case does
.B GETHN
suffix the interpolation with space.
.
See
.BR INITR .
.
.
.TP
.BI GETPN\~ ref-name\~\c
.RI [ string ]
Interpolate
.IR ref-name 's
page number,
or,
if
.I string
is specified,
store it there.
.
In neither case does
.B GETPN
suffix the interpolation with space.
.
See
.BR INITR .
.
.
.TP
.BI GETR\~ ref-name
Retrieve location data for reference
.IR ref-name ,
call
.B GETHN
and
.B GETPN
to populate strings
.B Qrfh
and
.BR Qrfn ,
respectively,
and interpolate string
.B Qrf
as an internal reference to it.
.
See
.BR INITR .
.
.
.TP
.BI GETST\~ ref-name\~\c
.RI [ string ]
Interpolate
.IR ref-name 's
auxiliary reference datum,
or,
if
.I string
is specified,
store it there.
.
In neither case does
.B GETST
suffix the interpolation with space.
.
See
.BR INITR .
.
.
.TP
.BI H\~ level\~\c
.RI [ title \~[ suffix ]]
Set a numbered section heading at
.IR level .
.
.I mm
calls
.B LC
to clear any lists,
then produces numbered
.I "heading marks"
of the form
.IR a . b . c .\|.\|.,
with up to fourteen levels of nesting.
.
Each level's number increments automatically with each
.B H
call and is reset to zero when a more significant
.I level
is specified.
.
.RB \[lq] 1 \[rq]\~is
the most significant or coarsest division of the document.
.
Text after an
.B H
call is formatted as a paragraph;
calling
.B P
is unnecessary.
.
.
.IP
The optional
.I title
must be double-quoted if it contains spaces.
.
.I mm
appends
.I suffix
to
.I title
in the body of the document,
but omits it from any table of contents
(see
.BR TC ).
.
This facility can be used to annotate the heading title with a footnote.
.
.I suffix
should not interpolate
.RB the\~ F
string;
specify a footnote mark explicitly.
.
See
.BR FS .
.
.
.IP
Heading behavior is configurable.
.
Several registers set
.I thresholds,
where heading levels at or below a threshold value are handled in one
way,
and those above it another.
.
For example,
.I mm
populates a table of contents
(see
.BR TC )
with the title of a heading if its level is within the
.B Cl
register threshold.
.
.
.IP
.I Heading layout.
.
Register
.B Ej
sets a threshold for page breaking (ejection) prior to a heading.
.
If not preceded by a page break,
a heading level within the threshold in register
.B Hps
is preceded by the amount of vertical space in register
.BR Hps1 ,
and by the amount in
.B Hps2
otherwise.
.
The
.B Hb
register sets a threshold at which a break occurs after the heading,
and register
.B Hs
sets a threshold within which vertical space follows it.
.
If the heading level is above both of these,
and the paragraph is not numbered,
.I mm
produces a
.IR "run-in heading" ;
paragraph text follows on the same output line.
.
Otherwise,
register
.B Hi
configures the indentation of text after headings.
.
Threshold register
.B Hc
permits centering;
.I mm
centers a heading with a level within both of the
.B Hb
and
.B Hc
thresholds.
.
.
.IP
.I Heading typeface and size.
.
The
.B HF
string configures the fonts used
for heading marks and titles at each level.
.
The string
.B HP
likewise assigns a type size to each heading level.
.
.\" XXX: Why not an "Hvs" string?
The hook macros
.B HX
and/or
.B HZ
can control the vertical spacing used by headings.
.
.
.IP
.I Heading number format.
.
Registers named
.B H1
through
.B H14
store counters for each heading level.
.
Their values are printed using Arabic numerals by default;
see
.BR HM .
.
The heading levels are catenated with dots for formatting;
to typeset only the deepest,
set the
.B Ht
register.
.
Heading numbers are not suffixed with a trailing dot except when only
the first level is output;
to omit a dot in this case as well,
clear the
.B H1dot
register.
.
.
.IP
.I Customizing heading behavior.
.
.B H
calls
.BR HX ,
.BR HY ,
and
.B HZ
hook macros to further customize headings.
.
These can change the heading's
.I mark
(the numbered portion before any heading title),
its vertical spacing,
and its vertical space requirements
(for instance,
to require a minimum quantity of subsequent output lines on the page,
breaking the page otherwise).
.
Define hook macros in expectation of the following parameters.
.
The argument
.I declared-level
is the
.I level
argument to
.BR H ,
.RB or\~ 0
for unnumbered headings
(see
.BR HU ).
.
.I actual-level
is the same as
.I declared-level
for numbered headings,
and the value of
.RB register\~ Hu
for unnumbered headings.
.
.I title-suffix
is the catenation of the corresponding arguments to
.B H
or
.BR HU .
.
.
.RS
.TP
.BI HX\~ "declared-level actual-level title-suffix"
.I mm
calls
.B HX
before setting the heading.
.
Your definition may alter
.BR }0 ,
.BR }2 ,
and
.BR ;3 .
.
.
.\" XXX: These names are ugly and of no obvious meaning.  Make
.\" documented aliases for them.
.RS
.TP
.BR }0\~ (string)
contains the heading mark plus two spaces if
.I declared-level
is non-zero,
and otherwise is empty.
.
.
.TP
.BR ;0\~ (register)
encodes a position for the text after the heading.
.
0\~means that the heading is to be run in,
1\~means that a break is to occur before the text,
and 2\~means that vertical space is to separate heading and text.
.
.
.TP
.BR }2\~ (string)
is the suffix that separates a run-in heading from the text.
.
It contains two spaces if register
.B ;0
is\~0,
and otherwise is empty.
.
.
.TP
.BR ;3\~ (register)
contains the vertical space required for the heading to be typeset.
.
If that amount is not available,
the page is broken prior to the heading.
.
The default is
.BR 2v .
.RE
.
.
.TP
.BI HY\~ "declared-level actual-level title-suffix"
.I mm
calls
.B HY
after determining the heading typeface and size.
.
It could be used to change indentation.
.
.
.TP
.BI HZ\~ "declared-level actual-level title-suffix"
.I mm
calls
.B HZ
after formatting the heading,
just before
.B H
or
.B HU
returns.
.
It could be used to change the page header to include a section heading.
.\" XXX: ...but only for the _next_ page, not the current one.  See
.\" Savannah #62825.
.RE
.
.
.TP
.BI HC\~ \fR[\fPhyphenation-character\fR]\fP
Set hyphenation character,
selecting the default,
\[lq]\[rs]%\[rq],
if called without argument.
.
.
.TP
.BI HM\  "\fR[\fParg1 \fR[\fParg2 \fR[.\|.\|.\& [\fParg14\fR]]]]\fP"
Set the heading mark style.
.
Each argument assigns the specified register format
(see above)
to the corresponding heading level.
.
The default
.RB is\~ 1
for all levels.
.
An explicitly empty argument also indicates the default.
.
.
.TP
.BI HU\~ title \~\c
.RI [ suffix ]
Set an unnumbered section heading with
.I title
and,
as a
.I groff mm
extension,
an optional
.I suffix.
.
The heading is treated as a numbered heading of the level stored in
.RB register\~ Hu ,
but no heading mark is output;
.RB see\~ H .
.
.
.TP
.BR I \~\c \" space in roman; we must use 2-font macro with \c
.RI [ italic-text\~\c
.RI [ previous-font-text ]]\~.\|.\|.
Join
.I italic-text
in italics with
.I previous-font-text
in the previous font,
without space between the arguments.
.
If no arguments,
switch font to italic style.
.
.
.TP
.BR IA \~[\c
.IR recipient-name \~[\c
.IR title ]]
Specify the inside address in a letter.
.
The arguments give each recipient a name and title.
.
.I mm
collects
input into the inside address until the document calls
.BR IE ,
then outputs it.
.
You can specify multiple recipients with empty
.BR IA / IE
pairs;
.I mm
uses only the last address.
.
See
.BR LT .
.
.
.TP
.BR IB \~\c \" space in roman; we must use 2-font macro with \c
.RI [ italic-text\~\c
.RI [ bold-text ]]\~.\|.\|.
Join
.I italic-text
in italics with
.I bold-text
in boldface,
without space between the arguments.
.
.
.TP
.B IE
End the inside address begun with
.BR IA .
.
.
.TP
.BI IND\~ argument\~\c
\&.\|.\|.
If the Boolean register
.B Ref
is true,
write an index entry as a specially prepared
.I roff
comment to the standard error stream,
with each
.I argument
separated from its predecessor by a tab character.
.
The entry's location information is arranged as configured by the most
recent
.B INITI
call.
.
.
.TP
.B INDP
Output the index set up by
.B INITI
and populated by
.B IND
calls.
.
By default,
.B INDP
calls
.B SK
and writes a centered caption interpolating the string
.BR Index .
.
It then disables filling and calls
.BR 2C ;
afterward,
it restores filling and calls
.BR 1C .
.
.
.IP
Define macros to customize this behavior.
.
.B INDP
calls
.B TXIND
before the caption,
.B TYIND
.I instead
of writing the caption,
and
.B TZIND
after formatting the index.
.
.
.TP
.BI INITI\~ "location-type file-name\~"\c
.RI [ macro ]
Initialize
.IR "groff mm" 's
indexing system.
.
Argument
.I location-type
selects how the location of each index entry is reported.
.
.I file-name
populates an internal string used later by
.BR INDP .
.
.
.IP
.TS
tab(@);
Lf(BI) Lb
L Lx.
location-type@Entry format
N@page number
H@heading mark
B@page number, tab character, heading mark
.TE
.
.
.IP
If
.I macro
is specified,
.I "groff mm"
calls it for each index entry
with the arguments given to
.BR IND .
.
.
.TP
.BI INITR\~ file-name-prefix
Initialize the internal reference macros.
.
Internal references are written to the standard error stream,
which should be redirected into a file named
.RI file-name-prefix .qrf .
.
.MR mmroff 1
handles this and the two formatting passes it requires.
.\".
.\"This program exists because
.\".MR groff 1
.\"by default deactivates the unsafe operations that are required by
.\".BR INITR .
.
The first pass identifies internal references;
the second includes them.
.\"
.\".B INITR
.\"can be used several times,
.\"but it is only the first occurrence of
.\".B INITR
.\"that is active.
.
See
.BR SETR ,
.BR GETHN ,
.BR GETPN ,
and
.BR GETST .
.
.
.TP
.BR IR \~\c \" space in roman; we must use 2-font macro with \c
.RI [ italic-text\~\c
.RI [ roman-text ]]\~.\|.\|.
Join
.I italic-text
in italics with
.I roman-text
in roman style,
without space between the arguments.
.
.
.TP
.BI LB\~ "text-indent mark-indent pad type"\~\c
.RI [ mark-or-format \~[ pre-item-space \~[ pre-list-space ]]]
Begin list.
.
The macros
.BR AL ,
.BR BL ,
.BR BVL ,
.BR DL ,
.BR ML ,
.BR RL ,
and
.B VL
call
.B LB
in various ways;
they are simpler to use and may be preferred if they suit the desired
purpose.
.
.
.br
.ne 3v
.IP
.I mm
tracks the nesting level of lists;
the outermost is\~0.
.
It indents
each list item
(text formatted after an
.B LI
call)
by
.I text-indent.
.
The mark is left-aligned at
.IR mark-indent ,
and padded on the left with
.I pad
ens of space.
.
.I type
determines the mark's format.
.
.
.IP
.TS
tab(@);
Lf(BI) Lb
L L.
type@Output for a mark \[lq]x\[rq]
0@x
1@x.
2@x)
3@(x)
4@[x]
5@<x>
6@{x}
.TE
.
.
.IP
If
.I type
.RB is\~ 0 ,
.I mark-or-format
specifies each item's mark
(which can be overridden by an argument to
.BR LI ).
.
If
.I mark-or-format
is empty
(or the dummy character
.RB \[lq] \[rs]& \[rq])
.I mm
sets items at
.I mark-indent
with a hanging indent at
.I text-indent.
.
.
.IP
If
.I type
is greater than zero,
.I mm
supplies an automatically incrementing numeric mark,
and interprets
.I mark-or-format
as a register format.
.
.
.IP
A
.I type
.RB of\~ \-1
causes
.I "groff mm"
to break the line after the mark
even if it fits within
.I text-indent;
this is a
.I groff mm
extension.
.
.
.IP
The last two arguments manage vertical space.
.
Unless a list's nesting level is greater than the value of register
.BR Ls ,
its items are preceded by
.I pre-item-space
multiplied by the register
.BR Lsp ;
the default
.RB is\~ 1 .
.
.B LB
precedes the list by
.I pre-list-space
multiplied by the register
.BR Lsp ;
the default
.RB is\~ 0 .
.
.
.TP
.BR LC \~[\c
.IR list-level ]
Clear list state.
.
Active lists are terminated as if with
.BR LE ,
either all
(the default)
or only those from the current level down to
.I list-level
if specified.
.
.
.TP
.BR LE \~[ 1 ]
End list.
.
The current list is terminated.
.
An argument
.RB of\~ 1
causes
vertical space in the amount of register
.B Lsp
to follow the list.
.
.
.TP
.BR LI \~[\c
.IR mark \~[ pad-prefix ]]
Begin a list item.
.
.I mm
collects input into a list item
until the document terminates the current list
or calls
.B LI
again.
.
By default,
the item's text is preceded by any mark configured by the current list.
.
If
.I mark
is the only argument,
it replaces the mark configured in the corresponding
.B LB
call.
.
If the width of the mark plus any
.I pad
specified in the
.B LB
call
exceeds the text indentation,
.I "groff mm"
warns and uses one en of padding between the mark and the text.
.
The presence of a second argument prefixes
.I mark
to the
.BR LB -configured
mark and,
as a
.I groff mm
extension,
conditionally puts an unbreakable space
between the prefix and mark per the argument's Boolean value.
.
.
.TP
.BI LO\~ option\~\c
.RI [ value ]
Specify letter options;
see
.BR LT .
.
By default,
.I mm
recognizes the following
.I option
values.
.
See
.B IA
regarding the inside address and string
.B DT
regarding the date.
.
.
.IP
.TS
tab(@);
Lf(BI) Lb
L Lx.
option@Meaning and Effect
AT@T{
Attention;
put contents of string
.B LetAT
and
.I value
left-aligned after the inside address.
T}
CN@T{
Confidential;
put
.I value,
or contents of string
.BR LetCN ,
left-aligned after the date.
T}
RN@T{
Reference;
put contents of string
.B LetRN
and
.I value
after the confidential notation
(if any)
and the date,
aligned with the latter.
T}
SA@T{
Salutation;
put
.I value,
or contents of string
.BR LetSA ,
left-aligned after the inside address
and the confidential notation
(if any).
T}
SJ@T{
Subject;
put contents of string
.B LetSJ
and
.I value
left-aligned after the inside address
and the attention and salutation notations
(if any).
.
In letter type \[lq]SP\[rq],
.B LetSJ
is ignored and
.I value
is set in full capitals.
T}
.TE
.
.
.br
.ne 5v
.TP
.BR LT \~[\c
.IR style ]
Format a letter in the designated
.I style,
defaulting to
.B BL
(see below).
.
A letter begins with the writer's address
.RB ( WA / WE ),
followed by the date
.RB ( ND ),
the inside address
.RB ( IA / IE ),
the body of the letter
.RB ( P
and other general-purpose
.I mm
macros),
the formal closing
.RB ( FC ),
the signature
.RB ( SG ),
and notations
.RB ( NS / NE ).
.
Any of these except the body text may be omitted.
.
Letter options specified with
.B LO
add further annotations,
which are extensible;
see subsection \[lq]Internals\[rq] below.
.
.
.br
.ne 6v
.IP
.TS
tab(@);
Lf(BI) Lb
L      Lx.
style@Description
BL@T{
Blocked:
the writer's address,
date,
formal closing,
and signature are indented to the center of the line.
.
Everything else is left-aligned.
T}
SB@T{
Semi-blocked:
as
.BR BL ,
but the first line of each paragraph is indented by
.B \[rs]n[Pi]
ens.
T}
FB@T{
Fully blocked:
everything is left-aligned.
T}
SP@T{
Simplified:
as
.BR FB ,
but a formal closing is omitted,
and the signature is set in full capitals.
T}
.TE
.
.
.TP
.BI MC\~ column-width\~\c
.RI [ gutter-width ]
Begin multi-column layout.
.
.I groff mm
creates as many columns of
.I column-width
as the line length will permit.
.
.I gutter-width
is the interior spacing between columns.
.
It defaults to
.IR column-width /15.
.
.B NCOL
moves to the next column,
and
.B 1C
returns to single-column layout.
.
.B MC
is a
.I groff mm
extension,
generalizing
.BR 2C .
.
See
.B MULB
for an alternative.
.
.
.TP
.BI ML\~ mark\c
.RI \~[ text-indent \~[\c
.BR 1 ]]
Start a
.I "marked list;"
the
.I mark
argument precedes each item.
.
.I text-indent
overrides the default indentation of the list items,
which is the width of
.I mark
plus one en.
.
A third argument suppresses the vertical space that normally precedes
each list item;
see register
.BR Lsp .
.
Vertical space in the amount of
.B Lsp
precedes the list itself,
but does not accumulate with pre-item space
when this list is nested in another.
.
.B ML
calls
.BR LB ;
use
.B LI
to declare list items,
and
.B LE
to end the list.
.
.
.TP
.BR MT \~\c \" we must use 2-font macro with \c
.RI [ type \~[ addressee ]]
Select memorandum type.
.
These correspond to formats used by AT&T Bell Laboratories,
where the
.I mm
package was initially developed,
affecting the document layout.
.
Some of these included a cover page with a caption categorizing the
document.
.
.I groff mm
uses
.I type
to construct the file name
.IR /usr/\:\%share/\:\%groff/\:\%1.24.1/\:\%tmac/mm/\:\% type \:.MT
and load it with the
.B mso
request.
.
Memorandum types 0 to\~5 are supported;
any other value of
.I type
is mapped to type\~6.
.
Omitting
.I type
implies
.BR 1 .
.
.I addressee
sets a string analogous to one used by AT&T cover page macros
not implemented in
.IR "groff mm" .
.
.
.IP
.TS
tab(@);
Lf(BI) Lb
L L.
type@Description
0@normal memorandum; no caption
1@captioned \[lq]TECHNICAL MEMORANDUM\[rq]
2@captioned \[lq]INTERNAL MEMORANDUM\[rq]
3@captioned \[lq]ADMINISTRATIVE MEMORANDUM\[rq]
4@released paper
5@external letter
.T&
LI L.
string@captioned \fIstring\fP
.TE
.
.
.IP
See
.B \%COVER
for a more flexible cover page mechanism.
.
.
.TP
.BI MOVE\  "y-pos \fR[\fPx-pos \fR[\fPline-length\fR]]\fP"
Move to a position, setting page offset to
.IR x-pos .
.
If
.I line-length
is not given, the difference between current and new page offset is
used.
.
Use
.B PGFORM
without arguments to return to normal.
.
.
.TP
.BR MULB \~\c \" space in roman; we must use 2-font macro with \c
.IR "cw1 sp1\~" [ "cw2 sp2" "] .\|.\|.\~" cwn
Begin alternative multi-column mode.
.
All column widths
.IR cw i
must be specified,
as must the amount of space
.IR sp i
between each column pair.
.
.B MULB
uses a diversion and operates in a separate environment.
.
.
.TP
.B MULE
End alternative multi-column mode and emit the columns.
.
.
.TP
.B MULN
Start next column in alternative column mode.
.
.
.TP
.B NCOL
Start next column
(only when using
.B 2C
or
.BR MC ).
.
Contrast with
.BR MULN .
.
.
.TP
.BR ND \~[\c
.IR arg ]
Set the document's date.
.
.I mm
does not interpret
.IR arg ;
it can be a revision identifier
(or empty).
.
.\" Explain debugging output at level 5 or higher.
.I mm
calls
.B ND
itself when initializing.
.
.
.TP
.B NE
End notation begun with
.BR NS ;
filling is enabled.
.
.
.\" XXX: Could we use a more general mechanism?  Call it `NP`?
.TP
.BR nP\~ [\c
.IR type ]
As
.BR P ,
but set a paragraph number in the form
.IR x . yy ,
where
.I x
is the number of the second heading level,
and
.I yy
increments with each
.B nP
call;
its value is not reset when the second-level heading number changes.
.
.I mm
uses a register format of \[lq]00\[rq] for
.I yy.
.
.
.br
.ne 6v
.TP
.BR NS \~[\c
.IR code \~[\c
.BR 1 ]]
Declare notations,
typically for letters or memoranda,
of the type specified by
.IR code .
.
The text corresponding to
.I code
is output,
and filling is disabled
until the document calls
.BR NE .
.
Typically,
a list of names or attachments lies within
.BR NS / NE .
.
If
.I code
is absent or does not match one of the values listed under the
.B \%Letns
string description below,
each line of notations is formatted as
.RI "\[lq]Copy (" line ") to\[rq]."
.
If a second argument,
conventionally
.BR 1 ,
is given,
.I code
becomes the entire notation and
.B NE
is not necessary.
.
In
.IR "groff mm" ,
you can set up further notations to be recognized by
.BR NS ;
see the strings
.B \%Letns
and
.B \%Letnsdef
below.
.
.
.TP
.BR OF\~ [ \[dq]\|\[aq]\c
.IB left \[aq] center \[aq] right \[aq]\|\[dq]\c
]
Define the odd-page footer,
which is formatted just above the normal page footer on odd-numbered
pages.
.
See
.BR PF .
.
.B OF
defines the string
.BR EOPof .
.
.
.TP
.BR OH\~ [ \[dq]\|\[aq]\c
.IB left \[aq] center \[aq] right \[aq]\|\[dq]\c
]
Define the odd-page header,
which is formatted just below the normal page header on odd-numbered
pages.
.
See
.BR PH .
.
.B OH
defines the string
.BR TPoh .
.
.
.TP
.B OP
Ensure that subsequent text is formatted at the top of an odd-numbered
page;
no page break is performed if the drawing position is already there.
.
.
.br
.ne 4v
.TP
.BR P \~[\c
.IR type ]
Begin new paragraph.
.
If
.I type
is missing
.RB or\~ 0 ,
.BR P \~sets
the paragraph fully left\-aligned.
.
A
.I type
.RB of\~ 1
indents the first line by
.B \[rs][Pi]
ens.
.
Set the register
.B Pt
to select a default paragraph indentation style.
.
The register
.B Ps
determines the amount of vertical space between paragraphs.
.
.
.IP
To set a paragraph with a hanging indent,
use
.B VL
with the desired indentation as the argument,
.B LI
(with no argument),
and
.BR LE .
.
.
.TP
.B PE
End picture input preprocessed by
.MR \%pic 1 ;
see
.BR PS .
.
.
.TP
.BR PF\~ [ \[dq]\|\[aq]\c
.IB left \[aq] center \[aq] right \[aq]\|\[dq]\c
]
Define the page footer.
.
The footer is formatted at the bottom of each page;
the argument is otherwise as described in
.BR PH .
.
.B PF
defines the string
.BR EOPf .
.
See
.BR EF ,
.BR OF ,
and
.BR EOP .
.
.TP
.BR PGFORM \~\c
.RI [ line-length \~\c
.RI [ page-length \~\c
.RI [ page-offset \~\c
.RB [ 1 ]]]]
Set line length, page length, and/or page offset.
.
This macro can be used for letterheads and similar.
.
It is normally the first macro call in a file,
though it is not necessary.
.
.B PGFORM
can be used without arguments to reset everything after a
.B MOVE
call.
.
A line break is done unless the fourth argument is given.
.
This can be used to avoid the page number on the first page
while setting new width and length.
.
(It seems as if this macro sometimes doesn't work too well.
.
Use the command-line arguments to change
line length, page length, and page offset instead.)
.
.TP
.B PGNH
Suppress header on the next page.
.
To suppress a header on the first page,
call this macro prior to formatting any text in the document.
.
Also see
.RB register\~ N .
.
.
.TP
.BR PH\~ [ \[dq]\|\[aq]\c
.IB left \[aq] center \[aq] right \[aq]\|\[dq]\c
]
.RS
Define the page header,
formatted at the top of each page,
as the argument,
where
.IR left ,
.IR center ,
and
.I right
are aligned to the respective locations on the line.
.
A
.RB \[lq] % \[rq]
character in
.I arg
is replaced by the page number.
.
If the argument is absent,
no page header is set.
.
The default page header is
.
.RS
.EX
\[dq]\[aq]\[aq]\- % \-\[aq]\[aq]\[dq]
.EE
.RE
.
which centers the page number between hyphens and formats nothing at the
upper left and right.
.
Header macros call
.B PX
(if defined)
after formatting the header.
.
.B PH
defines the string
.BR TPh .
.
See
.BR EH ,
.BR OH ,
and
.BR TP .
.RE
.
.
.TP
.BR PIC \~\c
.RB [ \-B ]\~\c
.RB [ \-C \||\|\c
.BI \-I\~ n\c
.RB \||\| \-L \c
.RB \||\| \-R ]\~\c
.IR file \~[ width \~[ height ]]
Include PostScript document
.IR file .
.
The optional
.B \-B
argument draws a box around the picture.
.
The optional
.BR \-L ,
.BR \-C ,
.BR \-R ,
and
.BI \-I\~ n
arguments align the picture or indent it by
.IR n .
.
By default,
the picture is left-aligned.
.
Optional
.I width
and
.I height
arguments resize the picture.
.
Use of this macro requires two-pass processing;
see
.B INITR
and
.MR mmroff 1 .
.
.
.TP
.B PS
Start picture input preprocessed by
.MR \%pic 1 .
.
.
.TP
.B PY
As
.BR PE ,
but with \[lq]flyback\[rq],
returning the drawing position to where it was prior to the picture.
.
This is a
.I groff mm
extension.
.
.
.TP
.BR R \~\c \" space in roman; we must use 2-font macro with \c
.RI [ roman-text\~\c
.RI [ previous-font-text ]]\~.\|.\|.
Join
.I roman-text
in roman style with
.I previous-font-text
in the previous font,
without space between the arguments.
.
If no arguments,
switch font to roman style.
.
.
.TP
.BR RB \~\c \" space in roman; we must use 2-font macro with \c
.RI [ roman-text\~\c
.RI [ bold-text ]]\~.\|.\|.
Join
.I roman-text
in roman style with
.I bold-text
in boldface,
without space between the arguments.
.
.
.TP
.BR RD \~\c
.RI [ prompt\~ [ div\~ [ str ]]]
Write
.I prompt
(if specified,
a tab and colon \[lq]:\[rq]
to the standard error stream
and read response from standard input stream,
optionally into a diversion
.I div
and/or string
.I str.
.
Interpolate the saved text by calling its name like a macro.
.
If
.I string
is present,
the input
.\" XXX: DWB 3.3 mm does this; Heirloom Doctools and groff mm do not.
.\" up to the first newline
is also stored in a string of that name.
.
.
.TP
.B RF
End a bibliographic reference citiation started with
.BR RS .
.
See
.BR RP .
.
.
.TP
.BR RI \~\c \" space in roman; we must use 2-font macro with \c
.RI [ roman-text\~\c
.RI [ italic-text ]]\~.\|.\|.
Join
.I roman-text
in roman style with
.I italic-text
in italics,
without space between the arguments.
.
.
.TP
.BR RL \~[\c
.IR text-indent \~[\c
.BR 1 ]]
Begin an auto-incrementing numbered list,
where item numbers start at one and set between square brackets.
.
A
.I text-indent
argument overrides register
.BR Li .
.
A second argument suppresses the vertical space that normally precedes
each list item;
see register
.BR Lsp .
.
Vertical space in the amount of
.B Lsp
precedes the list itself,
but does not accumulate with pre-item space
when this list is nested in another.
.
.B RL
calls
.BR LB ;
use
.B LI
to declare list items,
and
.B LE
to end the list.
.
\[lq]RL\[rq] is a mnemonic for \[lq]reference list\[rq],
but this macro has no relationship with
.IR mm 's
bibliographic reference list facilities.
.
.
.TP
.BR RP \~\c \" space in roman; we must use 2-font macro with \c
.RI [ suppress-counter-reset \~[ page-ejection-policy ]]
Format a reference list,
listing items accumulated within
.BR RS / RF
pairs.
.
The reference counter is reset unless the first argument
.RB is\~ 1 .
.
Normally,
page breaks occur before and after the references are output;
the register
.B Rpej
configures this behavior,
and a second argument overrides its value.
.
.B TC
calls
.B RP
automatically if references have accumulated.
.
.
.IP
.I "groff mm"
calls
.B LB
to format the reference list;
the
.B Rpfmt
string configures the list's appearance.
.
Setting register
.B Ls
.RB to\~ 0
suppresses spacing after the list.
.
The string
.B Rp
contains the reference list caption.
.
.
.TP
.B RPX
This hook macro assumes responsibility for formatting
the heading of the reference page that
.B RP
produces.
.
If not defined
(the default),
.I mm
sets the reference list caption in the string
.B Rp
after two vees of space,
centered in italics,
followed by another vee of space.
.
.
.br
.ne 5v
.TP
.BR RS \~[\c
.IR reference-string ]
Begin citation of an automatically numbered bibliographic reference
entry.
.
.I mm
collects input into a reference entry until the document calls
.BR RF .
.
A subsequent
.B RP
call emits the accumulated entries.
.
References are numbered starting at 1;
the register
.B :R
stores the most recently assigned number.
.
Interpolate the string
.B Rf
where the reference mark should be,
then place the entry between
.B RS
and
.B RF
calls on text lines after the reference mark.
.
The
.B \%Rfstyle
register determines whether the mark is bracketed,
superscripted,
or both.
.
If
.I reference-string
is specified,
.I mm
also stores the reference mark in a string of that name.
.
.
.TP
.BR S \~[\c
.IR type-size \~[ vertical-spacing ]]
Set type size and vertical spacing.
.
Each argument is a
.I groff
measurement,
using an appropriate scaling unit and an optional
.B +
or
.B \-
prefix to increment or decrement the current value.
.
An argument of
.B P
restores the previous value,
.B C
retains the current value,
and
.B D
requests the default.
.
.I mm
treats an empty or omitted argument as
.BR P .
.
.
.TP
.BR SA \~\c
.RI [ mode ]
Set or restore the default enablement of adjustment.
.
Specify
.B 0
or
.B 1
as
.I mode
to set a document's default explicitly;
.I "groff mm"
assumes
.BR 1 .
.\" DWB 3.3 mm assumed 1 for troff mode, 0 for nroff mode.
.
Invoke the
.B na
request as desired to temporarily suspend adjustment.
.
.B H
and
.BR HU ,
and
.B SA
when called without a
.I mode
argument,
restore the default adjustment.
.
.
.TP
.BI SETR\~ ref-name\~\c
.RI [ string ]
Create reference
.IR ref-name ,
storing its heading and page numbers.
.
If
.I string
is present,
.I "groff mm"
saves it as an auxiliary datum for retrieval by
.BR GETST .
.
See
.BR INITR .
.
.
.TP
.BR SG\~ [\c
.IR arg \~[\c
.BR 1 ]]
Output author signature block(s) in
.B LT
letters and
.B MT
memoranda.
.
The format of a signature block depends on the letter or memorandum
type.
.
See subsection \[lq]Internals\[rq] below.
.
.
.IP
.B LT
letters emit a signature for one author at most
(see
.BR WA ).
.
The author's title,
if any,
is set on the next line,
indented to align with the name,
except in letter type \[lq]SP\[rq],
where it is set in full capitals
(like the name)
after a comma and space.
.
.
.IP
Memorandum type\~4 uses no signature block.
.
In other memoranda,
each of an author's titles is set on a subsequent line,
indented to align with the name.
.
.\" DWB 3.3 mm's manual documented the following behavior, including
.\" examples, but it, Plan 9 mm, and Heirloom Doctools mm don't actually
.\" do it.  groff mm does.
They furthermore encode a secretarial annotation
including the location,
department,
and initials specified in each author's
.B AU
call,
followed by any
.IR arg ,
writing it at the left margin preceding the last author's name,
or preceding the first if a second
.B SG
argument is present.
.
.
.TP
.BR SK \~\c
.RI [ n ]
Skip
.I n
pages.
.
If
.I n
.RB is\~ 0
or omitted,
.I mm
breaks the page if necessary.
.
Otherwise,
.I mm
prints
.I n
pages,
blank except for any headers and footers.
.
.
.br
.ne 4v \" XXX: 3v should suffice
.TP
.BI SM\~ text\~\c
.RI [ post ]
.TQ
.BI SM\~ "pre text post"
Format
.I text
at a smaller type size,
joined with any specified
.I pre
and
.I post
at normal size,
without space between the arguments.
.
.
.TP
.BR SP \~\c
.RI [ distance ]
Space downward by
.I distance.
.
Multiple
.B SP
calls in sequence produce only the largest of the specified
.I distances.
.
.B SP
accepts boundary-relative motions specified with a prefixed
.B |
operator,
but not negative ones.
.
.
.IP
.B SP
has no effect when the drawing position is at the top of the page.
.
Put the dummy character escape sequence
.B \[rs]&
(followed by
.B \[rs]c
if desired to prevent a break)
on a text line prior to an
.B SP
call to overcome this restriction.
.
.
.TP
.B TAB
Reset tab stops to every 5\~ens.
.
The
.B ta
request customizes them.
.
.
.br
.ne 4v
.TP
.BR TB \~\c
.RI [ title \~[ override \~[ flag \~[ ref-name ]]]]
Caption a table.
.
Arguments are handled analogously to
.BR EC .
.
The register
.B Tb
is the table counter.
.
The string
.B Captb
precedes the table number and any
.I title.
.
.I mm
centers table captions irrespective of the alignment of any enclosing
display.
.
.
.IP
The package lists captioned tables in a table of contents
(see
.BR TC )
if the Boolean register
.B Lt
is true.
.
The string
.B Lt
captions this list.
.
.
.TP
.BR TC \~\c
.RI [ slevel\~\c
.RI [ spacing\~\c
.RI [ tlevel\~\c
.RI [ tab\~\c
.RI [ h1\~\c
.RI [ h2\~\c
.RI [ h3\~\c
.RI [ h4\~\c
.RI [ h5 ]]]]]]]]]
Output table of contents.
.
This macro is normally the last called in the document.
.
It flushes any pending displays and,
if any references are pending
(see
.BR RS ),
calls
.BR RP .
.
It then begins a new page with the contents caption,
stored in the string
.BR Captc ,
centered at the top.
.
The entries follow after three vees of space.
.
Each entry is a
saved section
(number and)
heading title
(see the
.B Cl
register),
along with its associated page number.
.
By default,
.I mm
indents an entry by an amount corresponding to its heading level
and the maximum heading length encountered at that heading level;
if defined,
the string
.B Ci
overrides these indentations.
.
Entries at heading levels up to and including
.I slevel
are preceded by
.I spacing
vees of space.
.
Entries at heading levels up to and including
.I tlevel
are followed by a leader and a right-aligned page number.
.
If the Boolean-valued
.I tab
argument is true,
the leader is replaced with horizontal motion in the same amount.
.
For entries above heading level
.IR tlevel ,
the page number follows the heading text after a word space.
.
Each argument
.IR h1 .\|.\|. h5
appears in order on its own line,
centered,
above the contents caption.
.
Page numbering restarts at 1,
in register format \[lq]i\[rq].
.
If the
.B Oc
register is true,
numbering of these pages is suppressed.
.
.
.IP
If the document calls
.B TC
with at most four arguments,
.I mm
calls the hook macro
.B TX
prior to formatting the contents caption,
and
.B TY
(if defined)
.I instead
of formatting the contents caption.
.
.
.IP
.I mm
then presents lists of
figures,
tables,
equations,
and exhibits,
in that order.
A list appears only if at least one such captioned item is present,
and if its corresponding register
.RB ( Le ,
.BR Lf ,
.BR Lt ,
or
.BR Lx )
is set.
.
.BI TX xx
and
.BI TY xx
macros,
where
.I xx
is \[lq]FG\[rq],
\[lq]TB\[rq],
\[lq]EC\[rq],
or \[lq]EX\[rq],
and strings
.BR Capfg ,
.BR Captb ,
.BR Capec ,
and
.B Capex
analogously configure the output of each captioned list.
.
.
.TP
.B TE
End
.MR \%tbl 1
table.
.
See
.BR TS .
.
.TP
.B TH
Mark the end of a
.BR TS / TE
table heading.
.
When a table spans multiple pages,
the heading repeats at the top of each page.
.
.I "groff mm"
does not implement the
.B N
argument supported by DWB.
.
.
.TP
.BR TL \~[\c
.IR charging-case-number \~[\c
.IR filing-case-number ]]
Begin document title.
.
.I mm
collects
input into the title until a subsequent
.B AU
call and formats it as directed by the
.B MT
memorandum type or cover page macros.
.
.I mm
saves
.I charging-case-number
and
.I filing-case-number
for use in all memorandum types except 4.
.
.
.TP
.BI TM\~ number\c
\~.\|.\|.
Declare technical memorandum number(s) used with
.B MT
memoranda.
.
.
.br
.ne 6v
.TP
.B TP
.I mm
calls this hook macro in lieu of normal page header layout.
.
The package uses a separate environment to format headers and footers.
.
See
.BR EOP .
.
.
.br
.ie t .ne 4v
.el   .ne 5v \" for horizontal rule
.IP
.TS
tab(@);
Cb S
Lb L.
Strings available to TP
_
TPh@argument to \fBPH\fP
TPeh@argument to \fBEH\fP
TPoh@argument to \fBOH\fP
.TE
.
.
.TP
.BR TS\~ [ H ]
Start
.MR \%tbl 1
table.
.
Argument \[lq]H\[rq] tells
.I mm
that the table's heading should repeat after page breaks.
.
See
.BR TE ,
.BR TH ,
and
.MR \%tbl 1 .
.
.
.TP
.BR VERBON \~\c \" space in roman; we must use 2-font macro with \c
.RI [ format \~[ type-size \~[ font ]]]
Begin display of verbatim content.
.
.I format
controls several parameters.
.
Add up the values of desired features;
the default
.RB is\~ 0 .
.
Further arguments configure the
.I type-size
in typographical points
(on typesetting devices),
and the face
.RI ( font ).
.
On typesetting devices,
the default face is
.B CR
(Courier roman),
a monospaced font:
all glyphs are equally wide.
.
.
.IP
.TS
tab(@);
lb lb
l lx.
Value@Effect
1@Disable the formatter's escape character (\[rs]).
2@Vertically space before the display.
4@Vertically space after the display.
8@T{
Number output lines; call formatter's
.B nm
request with arguments in string
.BR Verbnm .
T}
16@T{
Indent by the amount stored in register
.BR Verbin .
T}
.TE
.
.
.TP
.B VERBOFF
End verbatim display.
.
.
.TP
.BR VL \~[\c
.IR text-indent \~[ mark-indent \~[\c
.BR 1 ]]]
Begin variable-item
(or \[lq]tagged\[rq])
list.
.
Each item should supply its own mark,
or tag.
.
A
.I text-indent
argument overrides register
.BR Pi ;
.I mark-indent
sets the distance from the indentation of the current list to the mark.
.
A third argument suppresses the vertical space that normally precedes
each list item;
see register
.BR Lsp .
.
Vertical space in the amount of
.B Lsp
precedes the list itself,
but does not accumulate with pre-item space
when this list is nested in another.
.
.B RL
calls
.BR LB ;
use
.B LI
to declare list items,
and
.B LE
to end the list.
.
.
.TP
.BI "VM \fR[\fP\-T\fR] [\fP" "top \fR[\fPbottom\fR]]\fP"
Configure vertical margins.
.
.
.IP
Without a
.B \-T
argument,
increment the top and bottom margins by
.I top
and
.IR bottom ,
respectively.
.
If absent,
set the corresponding margin to zero.
.
.
.IP
With the
.B \-T
argument,
set the top and bottom margins to
.I top
and
.IR bottom ,
respectively.
.
If absent,
set the respective margin to the default
(top:
.BR 7v ,
bottom:
.BR 6v ).
.
.
.IP
We recommend defining the hook macros
.B TP
and/or
.B EOP
if using
.B \-T
and setting top and/or bottom margin to values less than the default.
.
.I groff mm
exposes this undocumented DWB macro
to enable greater user control of page layout.
.
.
.TP
.BR WA \~[\c
.IR writer's-name \~[\c
.IR title ]]
Specify the writer(s) of an
.B LT
letter.
.
.I mm
collects input into the writer's address until the document calls
.BR WE ,
then outputs it.
.
You can specify multiple writers with empty
.BR WA / WE
pairs;
only the last address is used.
.
The arguments give each writer a name and title.
.
.
.TP
.BR WC \~[\c
.IR format \~.\|.\|.]
Control width of footnotes and displays.
.
.
.IP
.RS
.TS
tab(@);
Lf(BI) Lb
Lb Lx.
format@Effect
N@T{
equivalent to
.RB \[lq] "\-WF \-FF \-WD" \[rq]
.\" FB \" XXX: see Savannah ticket reference below
(default)
T}
WF@T{
set footnotes at full line length,
even in two-column mode
.\" XXX: what about multi-column modes more generally?
T}
\-WF@T{
set footnotes using column line length
T}
FF@T{
apply width of first footnote to encountered to subsequent ones
T}
\-FF@T{
footnote width determined by
.B WF
and
.B \-WF
T}
WD@T{
set displays at full line length,
even in two-column mode
.\" XXX: what about multi-column modes more generally?
T}
\-WD@T{
set displays using column line length
T}
.TE
.RE
.\" XXX: See <https://savannah.gnu.org/bugs/?64316>.
.\"FB@T{
.\"Break when outputting floating displays.
.\"T}
.\"\-FB@T{
.\"Do not break when outputting floating displays.
.\"T}
.
.
.TP
.B WE
End the writer's address begun with
.BR WA .
.
.
.br
.ne 4v
.\" ====================================================================
.SH Strings
.\" ====================================================================
.
Many
.I mm
strings interpolate predefined,
localizable text.
.
We present their contents in quotation marks.
.
.
.TP 10n \" "Abstract" + 2n
.B Abstract
\[lq]ABSTRACT\[rq]
.
.
.TP
.B App
\[lq]APPENDIX\[rq]
.
.
.TP
.B Apptxt
stores the
.I title
argument to the most recent
.B APP
call.
.
.
.TP
.B Aumt
lists
space-separated indices of positional arguments to the
.B AU
macro that should be suppressed from appearance in the document heading
on the first page of
.B MT
memorandum types 0\[en]3 and 6.
.
By default,
it is undefined;
all arguments are formatted
except the second
(author initials).
.
.
.TP
.B BU
interpolates a bullet mark,
.BR \[rs][bu] .
.
.
.TP
.B Capec
\[lq]Equation\[rq]
.
.
.TP
.B Capex
\[lq]Exhibit\[rq]
.
.
.TP
.B Capfg
\[lq]Figure\[rq]
.
.
.TP
.B Captb
\[lq]Table\[rq]
.
.
.TP
.B Captc
\[lq]CONTENTS\[rq]
.
.
.TP
.B Ci
assigns indentation amounts used by each heading level listed
in a table of contents,
in one-to-one correspondence,
overriding those computed by
.BR TC .
.
Each word must be a horizontal measurement
(like
.RB \[lq] 1i \[rq]).
.
.
.TP
.B DT
stores the date or other identifier set by
.BR ND ,
if called,
and otherwise one constructed using
the formatter's date registers;
see
.MR groff 1 .
.
The
.I groff
locale determines its format,
but register
.B Isodate
may override it.
.
.
.TP
.B EM
interpolates an em dash,
.BR \[rs][em] .
.
.
.TP
.B F
interpolates an automatically numbered footnote mark;
the number is used by the next
.B FS
call without an argument.
.
In
.I troff
mode,
the mark is superscripted;
in
.I nroff
mode,
it is surrounded by square brackets.
.
.
.TP
.B H1txt
stores the text of the current first-level heading;
.B H
and
.B HU
update it,
as does
.B TC
when processing table of contents entries and captions of displayed
figures,
tables,
equations,
and exhibits.
.
.
.TP
.B HF
assigns font identifiers,
separated by spaces,
to heading levels in one-to-one correspondence.
.
Each identifier may be a font mounting position,
font name,
or style name.
.
Omitted values are assumed to be\~1.
.
The default is
.RB \[lq] "2 2 2 2 2 2 2 2 2 2 2 2 2 2" \[rq],
which places all headings in italics.
.
DWB's default was
.RB \[lq] "3 3 2 2 2 2 2" \[rq].
.
.
.TP
.B HP
assigns type sizes,
separated by spaces,
to heading levels in one-to-one correspondence.
.
.I "groff mm"
interprets each size in typographical points,
translating
zero values to
.BR 10 .
.
Omitted values are assumed to be\~0
(and are translated accordingly).
.
The default is
.RB \[lq] "0 0 0 0 0 0 0 0 0 0 0 0 0 0" \[rq].
.
.
.TP
.B Index
\[lq]INDEX\[rq]
.
.
.TP
.B Le
\[lq]LIST OF EQUATIONS\[rq]
.
.
.TP
.B Letfc
\[lq]Yours very truly,\[rq]
(see
.BR FC )
.
.
.TP
.B Letapp
\[lq]APPROVED:\[rq]
(see
.BR AV )
.
.
.TP
.B LetAT
\[lq]ATTENTION:\[rq]
(see
.BR LO )
.
.
.TP
.B LetCN
\[lq]CONFIDENTIAL\[rq]
(see
.BR LO )
.
.
.TP
.B Letdate
\[lq]Date\[rq]
(see
.BR AV )
.
.
.TP
.B Letns
is a group of strings structuring the notations produced by
.BR NS .
.
If the
.I code
argument to
.B NS
has no corresponding string,
the notation is included between parentheses,
prefixed with
.BR Letns!copy ,
and suffixed with
.BR Letns!to .
.
Observe the spaces after \[lq]Copy\[rq] and before \[lq]to\[rq].
.
.
.br
.ne 3v
.RS
.P
.TS
tab(@);
Lb Lb Lb
L L L.
NS code@String@Contents
0@Letns!0@Copy to
1@Letns!1@Copy (with att.\&) to
2@Letns!2@Copy (without att.\&) to
3@Letns!3@Att.
4@Letns!4@Atts.
5@Letns!5@Enc.
6@Letns!6@Encs.
7@Letns!7@Under separate cover
8@Letns!8@Letter to
9@Letns!9@Memorandum to
10@Letns!10@Copy (with atts.\&) to
11@Letns!11@Copy (without atts.\&) to
12@Letns!12@Abstract Only to
13@Letns!13@Complete Memorandum to
14@Letns!14@CC
\[em]@Letns!copy@Copy \fI(with trailing space)\fP
\[em]@Letns!to@ to \fI(note leading space)\fP
.TE
.RE
.
.
.TP
.B Letnsdef
selects the notation format when
.B NS
is given no argument.
.
The default
.RB is\~ 0 .
.
.
.TP
.B LetRN
\[lq]In reference to:\[rq]
(see
.BR LO )
.
.
.TP
.B LetSA
\[lq]To Whom It May Concern:\[rq]
(see
.BR LO )
.
.
.TP
.B LetSJ
\[lq]SUBJECT:\[rq]
(see
.BR LO )
.
.
.TP
.B Lf
\[lq]LIST OF FIGURES\[rq]
.
.
.TP
.B Lt
\[lq]LIST OF TABLES\[rq]
.
.
.TP
.B Lx
\[lq]LIST OF EXHIBITS\[rq]
.
.
.TP
.B MO1
.TQ
\&.\|.\|.
.TQ
.B MO12
\[lq]January\[rq] through \[lq]December\[rq]
.
.
.TP
.B Qrf
\[lq]See chapter \[rs]E*[Qrfh],
page \[rs]En[Qrfp].\[rq]
.
If your document uses multiple heading levels,
you might redefine this string to use the word \[lq]section\[rq]
instead of \[lq]chapter\[rq].
.
.
.TP
.B Qrfh
stores the heading mark corresponding to the most recent
.B \%GETR
call.
.
.
.TP
.B Qrfp
stores the page number corresponding to the most recent
.B \%GETR
call.
.
.
.TP
.B Rf
interpolates an automatically numbered reference mark;
the number is used by the next
.B RS
call.
.
.
.TP
.B Rp
\[lq]REFERENCES\[rq]
.
.
.TP
.B Rpfmt
specifies the
.B LB
arguments that
.I "groff mm"
uses to format the items in an
.B RP
reference list.
.
The default is
.RB \[lq] "\|\[rs]\[rs]n[Li] 0 1 0 \[rs]& 0\|" \[rq].
.
.
.TP
.B Rg
interpolates the registered (trade) mark sign.
.
.
.TP
.B Sm
interpolates the service mark sign.
.
.
.TP
.B Tcstatus
interpolates an indicator of the
.B TC
macro's processing status.
.
If
.B TC
is not operating,
it is empty.
.
User-defined
.B TP
or
.B EOP
macros might condition page headers or footers on its contents.
.
.
.IP
.TS
tab(@);
lb lb
l l.
Value@Meaning
co@Table of contents
fg@List of figures
tb@List of tables
ec@List of equations
ex@List of exhibits
ap@Appendix
.TE
.
.
.TP
.B Tm
interpolates
.if c \[tm] \[tm],
the trade mark sign.
.
.
.TP
.B Verbnm
supplies argument(s) to the
.B nm
request employed by the
.B VERBON
macro.
.
The default
.RB is\~ 1 .
.
.
.br
.ne 4v
.\" ====================================================================
.SH Registers
.\" ====================================================================
.
Default register values,
where meaningful,
are shown in parentheses.
.
.
.TP 9n \" "Letwam" + 2n + hand-tuned for PDF
.B .mgm
indicates that
.I groff mm
is in use
(Boolean-valued;
.BR 1 ).
.
.
.TP
.B Aph
formats an appendix heading
(and title,
if supplied);
see
.B APP
(Boolean-valued;
.BR 1 ).
.
.
.TP
.B Au
includes supplemental author information
(the third and subsequent arguments to
.BR AU )
in memorandum \[lq]from\[rq] information;
see
.B COVER
and
.BR MT ,
and the
.B Aumt
string
(Boolean-valued;
.BR 1 ).
.
.
.TP
.B Cl
sets the threshold for inclusion of headings in a table of contents.
.
Headings at levels above this value are excluded;
see
.B H
and
.BR TC .
.
The
.B Cl
register controls whether a heading is
.I saved
for output in the table of contents at the time
.B H
or
.B HU
is called;
if you change
.BR Cl 's
value immediately prior to calling
.BR TC ,
you are unlikely to get the result you want
.RB ( 2 ).
.
.
.TP
.B Cp
suppresses page breaks before lists of captioned
equations,
exhibits,
figures,
and tables,
and before an index;
see
.BR EC ,
.BR EX ,
.BR FG ,
.BR TB ,
and
.B INDP
(Boolean-valued;
.\" DWB 3.3's manual said this was 1, but the code said 0.
.BR 0 ).
.
.
.TP
.B D
produces debugging information for the
.I mm
package on the standard error stream.
.
A value of\~0 outputs nothing;
1\~reports formatting progress.
.
Higher values communicate internal state information of increasing
verbosity
.RB ( 0 ).
.
.
.TP
.B De
causes a page break after a floating display is output;
see
.B DF
(Boolean-valued;
.BR 0 ).
.
.
.TP
.B Df
configures the behavior of
.BR DF .
.
The following values are recognized;
4 and 5 do not override the
.B De
register
.RB ( 5 ).
.
.
.IP
.TS
tab(@);
Lb Lb
L Lx.
Value@Effect
0@T{
Flush pending displays
at the end of each section
when section-page numbering is active,
otherwise at the end of the document.
T}
1@T{
Flush a pending display
on the current page or column
if there is enough space,
otherwise at the end of the document.
T}
2@T{
Flush one pending display
at the top of each page or column.
T}
3@T{
Flush a pending display
on the current page or column
if there is enough space,
otherwise at the top of the next.
T}
4@T{
Flush as many pending displays
as possible in a new page or column.
T}
5@T{
Fill columns or pages with flushed displays
until none remain.
T}
.TE
.
.
.TP
.B Ds
puts vertical space in the amount of register
.B Dsp
(if defined) or
.B Lsp
before and after each static display;
see
.B DS
(Boolean-valued;
.BR 1 ).
.
.
.TP
.B Dsp
configures the amount of vertical space placed
before and after static displays;
see
.B DS
and register
.B Ds
.RI ( undefined ).
.
.
.TP
.B Ec
is an auto-incrementing equation counter;
see
.BR EC .
.
.
.TP
.B E
determines the font style used by
.B MT
memoranda,
.B LT
letters,
and the
.I ms.cov
cover page style to set the date and certain other document data;
.B 0
selects roman,
and
.B 1
bold
(Boolean-valued;
.BR 1 ).
.
.
.TP
.B Ej
sets the threshold for page breaks (ejection) prior to the format of
headings.
.
Headings at levels above this value are set on the same page and column
as any preceding text if possible;
see
.B H
.RB ( 0 ).
.
.
.TP
.B Eq
aligns an equation label to the left of a display instead of the right
(Boolean-valued;
.BR 0 ).
.
.
.TP
.B Ex
is an auto-incrementing exhibit counter;
see
.BR EX .
.
.
.TP
.B Fg
is an auto-incrementing figure counter;
see
.BR FG .
.
.
.TP
.B Fs
is multiplied by register
.B Lsp
to vertically separate footnotes;
see
.B FS
.RB ( 1 ).
.
.
.TP
.B Ftnum
is an auto-incrementing footnote counter;
see
.BR FS .
.
.I "groff mm"
recognizes
.B :p
as an alias of
.B Ftnum
for DWB compatibility.
.
.
.TP
.B H1
.TQ
\&.\|.\|.
.TQ
.B H14
are auto-incrementing counters corresponding to each heading level;
see
.BR H .
.
.
.\" XXX: This could be generalized to an "Hdot" threshold register with
.\" a default of 0.  ("Apply dots after heading marks beyond/above this
.\" threshold.")
.TP
.B H1dot
appends a period to the number of a level one heading;
see
.B H
(Boolean-valued;
.BR 1 ).
.
.
.\" XXX: This may be insufficiently general; see Savannah #62825.
.TP
.B H1h
is a copy of register
.BR H1 ,
but it is incremented just before a page break.
.
This can be useful in hook macros;
see
.B H
and
.BR HX .
.
.
.TP
.B Hb
sets the threshold for breaking the line after formatting a heading.
.
Text after headings at levels above this value is set on the same
output line if possible.
.
Paragraphs numbered via
.B nP
or the
.B Np
register cause a break regardless;
see
.B H
.RB ( 2 ).
.
.
.TP
.B Hc
sets the threshold for centering a heading.
.
Headings at levels above this value use the prevailing alignment
(that is,
they are not centered);
see
.B H
.RB ( 0 ).
.
.
.br
.ne 7v
.TP
.B Hi
selects an indentation policy for text formatted after headings.
.
It does not affect \[lq]run-in\[rq] headings.
.
The following values are recognized;
see
.B H
and
.B P
.RB ( 1 ).
.
.
.IP
.TS
tab(@);
Lb Lb
L Lx.
Value@Effect
0@no indentation
1@indent per the paragraph type
2@indent to align with heading title
.TE
.
.
.TP
.B Hps
sets the heading level threshold for application of preceding vertical
space;
see
.BR H .
.
Headings at levels above the value in register
.B Hps
use the amount of space in register
.BR Hps1 ;
otherwise that in
.BR Hps2 .
.
The value of
.B Hps
should be strictly greater than that of
.B Ej
.RB ( 1 ).
.
.
.TP
.B Hps1
configures the amount of vertical space preceding a heading above the
.B Hps
threshold;
see
.B H
.RI ( troff
devices:
.BR 0.5v ;
.I nroff
devices:
.BR 1v ).
.
.
.TP
.B Hps2
configures the amount of vertical space preceding a heading within the
.B Hps
threshold;
see
.B H
.RI ( troff
devices:
.BR 1v ;
.I nroff
devices:
.BR 2v ).
.
.
.TP
.B Hs
sets the heading level threshold for application of succeeding vertical
space.
.
If the heading level is greater than
.BR Hs ,
the heading is followed by vertical space in the amount of
.RB register\~ Hss ;
see
.B H
.RB ( 2 ).
.
.
.TP
.B Hss
is multiplied by register
.B Lsp
to produce vertical space after headings above the
threshold in
.RB register\~ Hs ;
see
.B H
.RB ( 1 ).
.
.
.TP
.B Ht
suppresses output of heading level counters above the deepest when a
heading mark is formatted;
see
.B H
(Boolean-valued;
.BR 0 ).
.
.
.
.TP
.B Hu
sets the heading level used by unnumbered headings;
see
.B HU
.RB ( 2 ).
.
.
.TP
.B Hy
enables automatic hyphenation of words
(Boolean-valued;
.BR 0 ).
.
.
.TP
.B Isodate
configures the use of ISO\~8601 date format;
that is,
.IR YYYY - MM - DD
instead of the format specified by the localization file.
.
Call
.B ND
without arguments after updating its value
(Boolean-valued;
.BR 0 ).
.
.
.TP
.B L
defines the page length for the document,
and must be set from the command line.
.
A scaling unit should be appended.
.
The default is that of the selected
.I groff
output device.
.
.
.br
.ne 5v
.TP
.B Le
.TQ
.B Lf
.TQ
.B Lt
.TQ
.B Lx
configure the report of lists of equation,
figure,
table,
and exhibit captions,
respectively,
after a table of contents;
see
.B TC
(all:
Boolean-valued;
.BR 1 ).
.
.
.\" XXX: What is the rationale for this feature?
.TP
.B Letwam
sets the maximum number of input lines permitted in a writer's address;
see
.B WA
and
.B WE
.RB ( 14 ).
.
.
.TP
.B Li
configures the text indentation
(in ens)
applied to enumerated list types;
that is,
to items in
.B AL
and
.B RL
lists,
and in
.B LB
lists whose
.I type
argument is greater than zero
.RB ( 5 ).
.
.
.TP
.B Ls
sets a threshold for placement of vertical space before list items.
.
If the list nesting level is greater than this value,
no such spacing occurs;
see
.B LI
.RB ( \[rs]n[.R] ).
.
.
.TP
.B Lsp
configures the base amount of vertical space used for separation
in the document.
.
.I mm
applies this spacing to many contexts,
sometimes with multipliers;
see
.BR DS ,
.BR FS ,
.BR H ,
.BR LI ,
and
.B P
.RI ( troff
devices:
.BR 0.5v ;
.I nroff
devices:
.BR 1v ).
.
.
.TP
.B N
configures the header and footer placements used by
.BR PH .
.
The default footer is empty.
.
If \[lq]section-page\[rq] numbering is selected,
the default header becomes empty
and the default footer becomes
.RI \[lq] x - y \[rq],
where
.IR x \~is
is the section number
(the number of the current first-level heading)
.RI and\~ y
the page number within the section.
.\" XXX: section-figure numbering needs more documentation.
.
The following values are recognized;
for finer control,
see
.BR PH ,
.BR PF ,
.BR EH ,
.BR EF ,
.BR OH ,
and
.BR OF ,
and registers
.B Sectf
and
.BR Sectp .
.
Value 5 is a
.I groff mm
extension
.RB ( 0 ).
.
.
.br
.ne 3v
.IP
.TS
tab(@);
Lb Lb
L Lx.
Value@Effect
0@Set header on all pages.
1@Move header to footer on page 1.
2@Omit header on page 1.
3@Use \[lq]section-page\[rq] numbering style on all pages.
4@Omit header on all pages.
5@T{
Use \[lq]section-page\[rq] and \[lq]section-figure\[rq] \
numbering style on all pages.
T}
.TE
.
.
.TP
.B Np
numbers paragraphs with a leading mark in the format
.IR s . p ,
where
.IR s \~is
is first-level heading number and
.IR p \~is
the paragraph number,
starting at 1;
see
.B H
and
.B P
(Boolean-valued;
.BR 0 ).
.
.
.TP
.B O
defines the page offset of the document,
and must be set from the command line.
.
A scaling unit should be appended.
.
The default
.RB is\~ \&.75i
on terminal devices.
.
On typesetters,
it is
.B \&.963i
or set to
.B 1i
by the
.I papersize.tmac
package;
see
.MR groff_tmac 5 .
.
.
.TP
.B Oc
suppresses the appearance of page numbers in the table of contents;
see
.B TC
(Boolean-valued;
.BR 0 ).
.
.
.br
.ne 7v
.\" XXX: This really should just be a string, shouldn't it?
.TP
.B Of
selects a separator format within equation,
exhibit,
figure,
and table captions;
see
.BR EC ,
.BR EX ,
.BR FG ,
and
.BR TB .
.
The punctuation in the separator is either a dot or the
.B EM
string.
.
The following values are recognized;
the spaces shown are unpaddable
.RB ( 0 ).
.
.
.IP
.TS
tab(@);
Lb Lb
L Lx.
Value@Effect
0@\[dq].  \[dq]
1@\[dq] \[em] \[dq]
.TE
.
.
.TP
.B P
interpolates the current page number;
it is the same as
.RB register\~ %
except when
\[lq]section-page\[rq] numbering is enabled.
.
.
.TP
.B Pi
configures the indentation
(in ens)
applied to the first line of an unnumbered paragraph that has such
(see
.BR P );
and the text indentation of non-enumerated list items;
that is,
to items in
.BR BL ,
.BR BVL ,
.BR DL ,
and
.B VL
lists
(but not
.BR ML ),
and in
.B LB
lists whose
.I type
argument is zero or less
.RB ( 5 ).
.
.
.TP
.B Pgps
causes the type size and vertical spacing set by
.B S
to apply to headers and footers,
overriding the
.B HP
string.
.
If not set,
.B S
calls affect headers and footers only when followed by
.BR PH ,
.BR PF ,
.BR OH ,
.BR EH ,
.BR OF ,
or
.B EF
calls
(Boolean-valued;
.BR 1 ).
.
.
.TP
.B Ps
is multiplied by register
.B Lsp
to vertically separate paragraphs;
see
.B P
.RB ( 1 ).
.
.
.TP
.B Pt
determines when a first-line indentation is applied to a paragraph;
see
.B P
.RB ( 0 ).
.
.
.br
.ne 4v
.IP
.TS
tab(@);
Lb Lb
L Lx.
Value@Effect
0@never
1@always
2@T{
always,
except immediately after
.BR H ,
.BR HU ,
.BR DE ,
or
.B LE
T}
.TE
.
.
.TP
.B Ref
is used internally to control
.MR mmroff 1 's
two-pass approach to index and reference management;
see
.BR IND ,
.BR INDP ,
.BR INITI ,
.BR INITR ,
and
.B PIC
(Boolean-valued;
.BR 0 ).
.
.
.TP
.B Rfnum
is an auto-incrementing reference counter;
see
.BR RS .
.
.I "groff mm"
recognizes
.B :R
as an alias of
.B Rfnum
for DWB compatibility.
.
.
.TP
.B Rfstyle
determines the format of the reference number in the
.B Rf
string.
.
.I "groff mm"
maps
.B 0
to
.B 1
in
.I nroff
mode
and
.B 2
in
.I troff
mode
.RB ( 0 ).
.
.
.IP
.TS
tab(@);
lb lb
l l.
Value@Meaning
0@automatic
1@bracketed
2@superscripted
3@bracketed and superscripted
.TE
.
.
.IP
Changes to
.BR Rfstyle 's
value
may not take effect until the next heading or paragraphing macro call.
.\" ...and in certain other cases we don't document.
.
.
.TP
.B Rpej
configures the default page ejection policy for reference pages;
see
.B RP
.RB ( 0 ).
.
.
.IP
.TS
tab(@);
Lb Lb
L Lx.
Value@Effect
0@T{
Break the page before and after the reference list.
T}
1@T{
Suppress page break after the list.
T}
2@T{
Suppress page break before the list.
T}
3@T{
Suppress page breaks before and after the list.
T}
.TE
.
.
.TP
.B S
defines the type size for the document,
and must be set from the command line.
.
A scaling unit should be appended;
.B p
is typical
.RB ( 10p ).
.
.
.TP
.B Sectf
selects the \[lq]section-figure\[rq] numbering style.
.
Its default
.RB is\~ 0
unless
.RB register\~ N
is set
.RB to\~ 5
at the command line
(Boolean-valued).
.
.
.TP
.B Sectp
selects the \[lq]section-page\[rq] numbering style.
.
Its default
.RB is\~ 0
unless
.RB register\~ N
is set
.RB to\~ 3
.RB or\~ 5
at the command line
(Boolean-valued).
.
.
.TP
.B Si
configures the amount of display indentation in ens;
see
.B DS
.RB ( 5 ).
.
.
.TP
.B Tb
is an auto-incrementing table counter;
see
.BR TB .
.
.
.TP
.B V
defines the vertical spacing for the document,
and must be set from the command line.
.
A scaling unit should be appended;
.B p
is typical.
.
The default vertical spacing is 120% of the type size.
.
This register is a
.I groff mm
extension.
.
.
.TP
.B Verbin
configures the amount of indentation for verbatim displays
when indentation is selected;
see
.B \%VERBON
.RB ( 5n ).
.
.
.TP
.B W
defines the \[lq]width\[rq]
of the document
(that is,
the length of an output line with no indentation);
it must be set from the command line.
.
A scaling unit should be appended.
.
The default
.RB is\~ 6i
or assigned by the
.I papersize.tmac
package;
see
.MR groff_tmac 5 .
.
.
.\" ====================================================================
.SS Internals
.\" ====================================================================
.
The argument
(if any)
to a
.B COVER
or
.B MT
call determines the file that
.I "groff mm"
loads to configure the document's layout;
see section \[lq]Files\[rq] below.
.
.
.P
.BR LT 's
behavior depends on the
.I style
argument given to it;
it calls macros with names suffixed accordingly.
.
It is therefore possible to define additional letter types,
either in the territory-specific macro file,
or as local additions.
.
.B LT
sets the registers
.B Pt
and
.B Pi
to 0 and\~5,
respectively.
.
(DWB used a value of 3 for
.BR Pi .)
.
It then calls an initialization macro corresponding to the type.
.
Define the following macros to support a new letter type.
.
.
.TP
.BI let@init_ type
initializes
any registers and other data needed by the letter type.
.
.
.TP
.BI let@head_ type
formats the letterhead;
it is called instead of the usual page header macro.
.
Its definition should remove the alias
.B let@header
unless the letterhead is desired on subsequent pages.
.
.
.TP
.BI let@sg_ type\~\c
.IR "name title n is-final\~" [ SG-arg\~ .\|.\|.]
is called by
.B SG
only for
.B LT
letters;
.B MT
memoranda implement their own signature processing.
.
.I name
and
.I title
are specified through
.BR WA / WE .
.
.IR n \~is
the index of the
.IR n th
writer,
and
.I is-final
is true for the last writer to be listed.
.
Further
.B SG
arguments are appended to the signature line.
.
.
.TP
.BI let@fc_ "type closing"
is called by
.BR FC ,
and takes the formal closing as its argument.
.
.
.P
.B LO
implements letter options.
.
It requires that a string named
.BI Let type
be defined,
where
.I type
is the letter type.
.
.B LO
then assigns its second argument
.RI ( value )
to the string
.BI let*lo\- type\c
\&.
.
.
.\" ====================================================================
.\".SH BUGS
.\" ====================================================================
.
.
.\" ====================================================================
.SH Files
.\" ====================================================================
.
.TP
.I /usr/\:\%share/\:\%groff/\:\%1.24.1/\:\%tmac/\%m.tmac
is the
.I groff
implementation of the memorandum macros.
.
.
.TP
.I /usr/\:\%share/\:\%groff/\:\%1.24.1/\:\%tmac/mm.tmac
is a wrapper enabling the package to be loaded with the option
.RB \[lq] "\-m mm" \[rq].
.
.
.TP
.I /usr/\:\%share/\:\%groff/\:\%1.24.1/\:\%tmac/refer\-mm.tmac
implements
.MR \%refer 1
support for
.IR mm .
.
.
.TP
.I /usr/\:\%share/\:\%groff/\:\%1.24.1/\:\%tmac/mm/ms.cov
implements an
.IR ms -like
cover page.
.
.
.TP
.I /usr/\:\%share/\:\%groff/\:\%1.24.1/\:\%tmac/mm/0.MT
implements memorandum types 0\[en]3 and 6.
.
.
.TP
.I /usr/\:\%share/\:\%groff/\:\%1.24.1/\:\%tmac/mm/4.MT
implements memorandum type 4.
.
.
.TP
.I /usr/\:\%share/\:\%groff/\:\%1.24.1/\:\%tmac/mm/5.MT
implements memorandum type 5.
.
.
.TP
.I /usr/\:\%share/\:\%groff/\:\%1.24.1/\:\%tmac/mm/locale
performs any (further) desired localization if present.
.
.
.TP
.I /usr/\:\%share/\:\%doc/\:\%groff\-1.24.1/examples/letter.mm
illustrates features of the
.B LT
letter formats.
.
.
.TP
.I /usr/\:\%share/\:\%doc/\:\%groff\-1.24.1/examples/memorandum.mm
illustrates features of the
.B MT
memorandum formats.
.
.
.TP
.I /usr/\:\%share/\:\%doc/\:\%groff\-1.24.1/examples/story.mm
illustrates use of
.I mm
for literary purposes.
.
.
.br
.ne 5v \" 4v plus bigger type size for heading
.\" ====================================================================
.SH Authors
.\" ====================================================================
.
.MT jh@\:axis\:.se
J\[:o]rgen H\[:a]gg
.ME
of Lund, Sweden,
wrote the version of the
.I mm
macro package distributed with
.I groff
based on an early version of
.I "groff ms"
by
.MT jjc@\:jclark\:.com
James Clark
.ME .
.
.MT wl@\:gnu\:.org
Werner Lemberg
.ME
and
.MT g.branden\:.robinson@\:gmail\:.com
G.\& Branden Robinson
.ME
revised and updated it.
.
.
.\" ====================================================================
.SH "See also"
.\" ====================================================================
.
.UR https://tkurtbond\:.github\:.io/\:troff/\:mm\-all\:.pdf
.I MM \- A Macro Package for Generating Documents
.UE ,
the DWB\~3.3
.I mm
manual,
introduces the package but does not document
.I groff mm
extensions.
.
.
.P
.IR "Groff: The GNU Implementation of troff" ,
by Trent A.\& Fisher and Werner Lemberg,
is the primary
.I groff
manual.
.
You can browse it interactively with \[lq]info groff\[rq].
.
.
.P
.MR groff 1 ,
.MR \%troff 1 ,
.MR \%tbl 1 ,
.MR \%pic 1 ,
.MR \%eqn 1 ,
.MR \%refer 1 ,
.MR groff_mmse 7
.
.
.\" Restore compatibility mode (for, e.g., Solaris 10/11).
.cp \n[*groff_groff_mm_7_man_C]
.do rr *groff_groff_mm_7_man_C
.
.
.\" Local Variables:
.\" fill-column: 72
.\" mode: nroff
.\" End:
.\" vim: set filetype=groff textwidth=72: