.\"
.\" $Id: groff_mm.man,v 2.22 2007/02/06 10:34:51 esr Exp $
.\"
.TH GROFF_MM @MAN7EXT@ "@MDATE@" "Groff Version @VERSION@"
.
.
.SH NAME
.
groff_mm \- groff mm macros
.
.
.SH SYNOPSIS
.
.B groff
.B address@hidden@m
[
.IR options .\|.\|.\&
]
[
.IR files .\|.\|.\&
]
.
.
.SH DESCRIPTION
.
.RS
.LP
.TS 
tab(@) experimental;
lb lb
l l.
address@hidden
address@hidden, 1, 2, 3, .\|.\|.
address@hidden, 001, 002, 003, .\|.\|.
address@hidden, i, ii, iii, iv, .\|.\|.
address@hidden, I, II, III, IV, .\|.\|.
address@hidden, a, b, c, .\|.\|., z, aa, ab, .\|.\|.
address@hidden, A, B, C, .\|.\|., Z, AA, AB, .\|.\|.
.TE
.RE
.
.TP
.BI AL\  \fR[\fPtype\ \fR[\fPtext-indent\  \fR[\fP1\fR]]]\fP
Start auto-increment list.
Items are numbered beginning with one.
The
.I type
argument controls the format of numbers.
.
.RS
.IP
.TS
tab(@) experimental;
lb lb
l l.
address@hidden
address@hidden (the default)
address@hidden letters (A-Z)
address@hidden letters (a-z)
address@hidden roman
address@hidden roman
.TE
.RE
.
.TP
.BI AS\  "\fR[\fParg \fR[\fPindent\fR]]\fP"
Abstract start.
Indentation is specified in `ens',
but scaling is allowed.
Argument
.I arg
controls where the abstract is printed.
.
.RS
.TS
tab(@) experimental;
lb lb
l l.
address@hidden
address@hidden
Abstract is printed on page\~1 and on the cover sheet if used in the
released-paper style (\fBMT 4\fP),
otherwise it is printed on page\~1 without a cover sheet.
T}
address@hidden is only printed on the cover sheet (\fBMT 4\fP only).
address@hidden
Abstract is printed only on the cover sheet (other than \fBMT 4\fP only).
The cover sheet is printed without a need for \fBCS\fP.
T}
.TE
.RE
.
.IP
.B De register
.
.RS
.IP
.TS
tab(@) experimental;
l l.
address@hidden special, this is the default.
address@hidden
A page eject occurs after each printed display,
giving only one display per page and no text following it.
T}
.TE
.RE
.
.IP
.B Df register
.
.RS
.IP
.TS
tab(@) experimental;
l l.
address@hidden
Displays are printed at the end of each section (when section-page
numbering is active) or at the end of the document.
T}
address@hidden
A new display is printed on the current page if there is enough space,
otherwise it is printed at the end of the document.
T}
address@hidden
One display is printed at the top of each page or column
(in multi-column mode).
T}
address@hidden
Print one display if there is enough space for it,
otherwise it is printed at the top of the next page or column.
T}
address@hidden
Print as many displays as possible in a new page or column.
A page break occurs between each display if
.B De
is not zero.
T}
address@hidden
Fill the current page with displays and the rest beginning at a new page
or column.
(This is the default.)
A page break occurs between each display
if \fBDe\fP is not zero.
T}
.TE
.RE
.RE
.
.IP
.B format
.
.RS
.IP
.TS
tab(@) experimental;
l l.
address@hidden indentation.
address@hidden indentation.
address@hidden indentation.
address@hidden
Indent text with the value of number register
.BR Si .
T}
address@hidden each line.
address@hidden the whole display as a block.
address@hidden the lines.
address@hidden the whole display as a block.
.TE
.RE
.
.IP
.B fill
.
.RS
.IP
.TS
tab(@) experimental;
l l.
address@hidden turned off.
address@hidden turned off.
address@hidden turned off.
address@hidden turned on.
.TE
.RE
.
.IP
.B flag
.
.RS
.IP
.TS
tab(@) experimental;
l l.
address@hidden
.I override
is a prefix to the number.
T}
address@hidden
.I override
is a prefix to the number.
T}
address@hidden
.I override
is a suffix to the number.
T}
address@hidden
.I override
replaces the number.
T}
.TE
.RE
.
.IP
.B strings available to EOP
.RS
.TS
tab(@) experimental;
l l.
address@hidden of \fBPF\fP
address@hidden of \fBEF\fP
address@hidden of \fBOF\fP
.TE
.RE
.
.TP
.BI FD\  \fR[\fParg\  \fR[\fP1\fR]]\fP
Footnote default format.
Controls the hyphenation (hyphen),
right margin justification (adjust),
and indentation of footnote text (indent).
It can also change the label justification (ljust).
.
.RS
.IP
.TS
tab(@) experimental;
lb lb lb lb lb
l l l l l.
address@hidden@address@hidden@ljust
address@hidden@address@hidden@left
address@hidden@address@hidden@left
address@hidden@address@hidden@left
address@hidden@address@hidden@left
address@hidden@address@hidden@left
address@hidden@address@hidden@left
address@hidden@address@hidden@left
address@hidden@address@hidden@left
address@hidden@address@hidden@right
address@hidden@address@hidden@right
address@hidden@address@hidden@right
address@hidden@address@hidden@right
.TE
.RE
.
.IP
.B Argument
.
.TS
tab(@) experimental;
l l.
address@hidden numerals.
address@hidden numerals with leading zeroes, one or more.
address@hidden alphabetic
address@hidden alphabetic
address@hidden roman numerals
address@hidden roman numerals
address@hidden numerals.
.TE
.
.IP
.TS
tab(@) experimental;
l l.
address@hidden numbers
address@hidden marks
address@hidden
Both page numbers and header marks, 
separated with a tab character.
T}
.TE
.
.IP
.B type
.
.RS
.IP
.br
.TS
tab(@) experimental;
l l.
address@hidden
address@hidden)
3@(x)
address@hidden
5@<x>
address@hidden
.TE
.RE
.
.IP
All lists begin with a list initialization macro,
.BR LB .
There are, however, seven predefined list types to make lists easier to use.
They all call
.B LB
with different default values.
.
.RS
.IP
.TS
tab(@) experimental;
l l.
address@hidden Incremented List
address@hidden List
address@hidden List
address@hidden List
address@hidden List
address@hidden List
address@hidden Variable List.
.TE
.RE
.
.IP
These lists are described at other places in this manual.
See also
.BR LB .
.
.TP
.BI LT\  \fR[\fIarg\fR]\fI
Format a letter in one of four different styles depending
on the argument.
See also section
.BR INTERNALS .
.
.RS
.IP
.TS
tab(@) experimental;
lb lb
l l.
address@hidden
address@hidden
Blocked.
Date line, return address, writer's address and closing
begins at the center of the line.
All other lines begin at the left margin.
T}
address@hidden
Semi-blocked.
Same as blocked,
except that the first line in every paragraph is indented five spaces.
T}
address@hidden
Full-blocked.
All lines begin at the left margin.
T}
address@hidden
Simplified.
Almost the same as the full-blocked style.
Subject and the writer's identification are printed in all-capital.
T}
.TE
.RE
.
.TP
.BI LO\  "type \fR[\fParg\fR]\fP"
Specify options in letter (see
.BR .LT ).
This is a list of the standard options:
.
.RS
.IP
.TS
tab(@) experimental;
l l.
address@hidden
Confidential notation.
Prints `CONFIDENTIAL' on the second line below the date line.
Any argument replaces `CONFIDENTIAL'.
See also string variable
.BR LetCN .
T}
address@hidden
Reference notation.
Prints `In reference to:' and the argument two lines below the date line.
See also string variable
.BR LetRN .
T}
address@hidden
Attention.
Prints `ATTENTION:' and the argument below the inside address.
See also string variable
.BR LetAT .
T}
address@hidden
Salutation.
Prints `To Whom It May Concern:' or the argument if it was present.
The salutation is printed two lines below the inside address.
See also string variable
.BR LetSA .
T}
address@hidden
Subject line.
Prints the argument as subject prefixed with `SUBJECT:'
two lines below the inside address,
except in letter type `SP',
where the subject is printed in all-capital without any prefix.
See also string variable
.BR LetSJ .
T}
.TE
.RE
.
.IP
.B arg
.
.RS
.IP
.TS
tab(@) experimental;
l l.
address@hidden memorandum, no type printed.
address@hidden with `MEMORANDUM FOR FILE' printed.
address@hidden with `PROGRAMMER'S NOTES' printed.
address@hidden with `ENGINEER'S NOTES' printed.
address@hidden paper style.
address@hidden letter style.
.TE
.RE
.
.TP
.BI NS\  \fR[\fParg\  \fR[\fP1\fR]]\fP
Print different types of notations.
The argument selects between the predefined type of notations.
If the second argument is available, 
then the argument becomes the entire notation.
If the argument doesn't select a predefined type,
it is printed as `Copy (\fIarg\fP) to'.
It is possible to add more standard notations,
see the string variables
.B Letns
and
.BR Letnsdef .
.
.RS
.IP
.TS
tab(@) experimental;
l l.
address@hidden
address@hidden To
address@hidden To
address@hidden To (with att.\&) to
address@hidden To (without att.\&) to
address@hidden
address@hidden
address@hidden
address@hidden
address@hidden separate cover
address@hidden to
address@hidden to
address@hidden (with atts.\&) to
address@hidden (without atts.\&) to
address@hidden Only to
address@hidden Memorandum to
address@hidden
.TE
.RE
.
.IP
.B arg2
.
.RS
.IP
.TS
tab(@) experimental;
l l.
address@hidden
The reference page is printed on a separate page.
This is the default.
T}
address@hidden not eject page after the list.
address@hidden not eject page before the list.
address@hidden not eject page before and after the list.
.TE
.RE
.
.IP
.B strings available to TP
.RS
.TS
tab(@) experimental;
l l.
address@hidden of \fBPH\fP
address@hidden of \fBEH\fP
address@hidden of \fBOH\fP
.TE
.RE
.
.TP
.BI VERBON\  "\fR[\fPflag \fR[\fPpoint-size \fR[\fPfont\fR]]]\fP"
Begin verbatim output using Courier font.
Usually for printing programs.
All characters have equal width.
The point size can be changed with the second argument.
By specifying a third argument it is possible to use another
font instead of Courier.
.I flag
controls several special features.
Its value is the sum of all wanted features.
.
.RS
.IP
.TS
tab(@) experimental;
lb lb
l l.
address@hidden
address@hidden
Disable the escape character (\[rs]).
This is normally turned on during verbose output.
T}
address@hidden an empty line before the verbose text.
address@hidden an empty line after the verbose text.
address@hidden
Print the verbose text with numbered lines.
This adds four digit-sized spaces in the beginning of each line.
Finer control is available with the string variable
.BR Verbnm .
It contains all arguments to the
.BR troff (@MAN1EXT@)
command
.BR .nm ,
normally `1'.
T}
address@hidden
Indent the verbose text by `5n'.
This is controlled by the number-variable
.B Verbin
(in units).
T}
.TE
.RE
.
.TP
.BI WC\  "\fR[\fPformat1\fR] [\fPformat2\fR] [.\|.\|.]\fP"
Footnote and display width control.
.
.RS
.TS
tab(@) experimental;
l l.
address@hidden
Set default mode which is equal to using the options
.BR \-WF ,
.BR \-FF ,
.BR \-WD ,
and
.BR FB .
T}
address@hidden
Wide footnotes, wide also in two-column mode.
T}
address@hidden footnote width, follow column mode.
address@hidden
All footnotes gets the same width as the first footnote encountered.
T}
address@hidden
Normal footnotes, width follows \fBWF\fP and \fB-WF\fP.
T}
address@hidden
Wide displays, wide also in two-column mode.
T}
address@hidden
Normal display width, follow column mode.
T}
address@hidden
Floating displays generates a line break when printed on the current
page.
T}
address@hidden
Floating displays does not generate line break.
T}
.TE
.RE
.
.TP
.B Letns
is an array containing the different strings used in
.BR .NS .
It is really a number of string variables prefixed with
.BR Letns! .
If the argument doesn't exist,
it is included between
.B ()
with
.B Letns!copy
as a prefix and
.B Letns!to
as a suffix.
Observe the space after `Copy' and before `to'.
.
.RS
.IP
.TS
tab(@) experimental;
lb lb
l l.
address@hidden
address@hidden to
address@hidden (with att.\&) to
address@hidden (without att.\&) to
address@hidden
address@hidden
address@hidden
address@hidden
address@hidden separate cover
address@hidden to
address@hidden to
address@hidden (with atts.\&) to
address@hidden (without atts.\&) to
address@hidden Only to
address@hidden Memorandum to
address@hidden
address@hidden \[rs]"
Letns!to@" to
.TE
.RE
.
.TP
.B Tcst
Contains the current status of the table of contents and list of figures,
etc.
Empty outside of
.BR .TC .
Useful in user-defined macros like
.BR .TP .
.
.RS
.IP
.TS
tab(@) experimental;
lb lb
l l.
address@hidden
address@hidden of contents
address@hidden of figures
address@hidden of tables
address@hidden of equations
address@hidden of exhibits
address@hidden
.TE
.RE
.
.TP
.B Hi
Heading temporary indent.
A number in the range 0 to 2,
with a default value of\~1.
.
.RS
.IP
.TS
tab(@) experimental;
l l.
address@hidden indentation, left margin
address@hidden
indent to the right, similar to
.RB ` ".P 1" '
T}
address@hidden to line up with text part of preceding heading
.TE
.RE
.
.TP
.B Ht
Heading numbering type.
.
.RS
.IP
.TS
tab(@) experimental;
l l.
address@hidden levels (1.1.1, 1.1.2, etc.)
address@hidden level
.TE
.RE

.TP
.B Hy
Hyphenation status of text body.
.
.RS
.IP
.TS
tab(@) experimental;
l l.
address@hidden hyphenation
address@hidden on, set to value\~14
.TE
.RE
.
.TP
.B Limsp
A flag controlling the insertion of space between prefix and mark in
automatic lists
.RB ( .AL ).
.
.RS
.IP
.TS
tab(@) experimental;
l l.
address@hidden space
address@hidden space
.TE
.RE
.
.TP
.B N
Page numbering style.
.
.RS
.IP
.TS
tab(@) experimental;
l l.
address@hidden header for all pages.
address@hidden replaces footer on first page, header is empty.
address@hidden header is removed on the first page.
address@hidden' numbering style enabled.
address@hidden header is removed on the first page.
address@hidden' and `section-figure' numbering style enabled.
.TE
.RE
.
.TP
.B Np
A flag to control whether paragraphs are numbered.
.
.RS
.IP
.TS
tab(@) experimental;
l l.
address@hidden numbered
address@hidden in first-level headings.
.TE
.RE
.
.TP
.B Of
Format of figure, table, exhibit, and equation titles.
.
.RS
.IP
.TS
tab(@) experimental;
l l.
address@hidden \[dq]
address@hidden - \[dq]
.TE
.RE
.
.TP
.B Pgps
A flag to control whether header and footer point size should follow
the current settings or just change when the header and footer are defined.
.
.RS
.IP
.TS
tab(@) experimental;
l l.
address@hidden
Point size only changes to the current setting when
.BR .PH ,
.BR .PF ,
.BR .OH ,
.BR .EH ,
.BR .OF ,
or
.B .OE
is executed.
T}
address@hidden
Point size changes after every
.BR .S .
This is the default.
T}
.TE
.RE
.
.TP
.B Pt
Paragraph type.
.
.RS
.IP
.TS
tab(@) experimental;
l l.
address@hidden
address@hidden paragraphs
address@hidden
indented paragraphs except after
.BR .H ,
.BR .DE ,
or
.BR .LE .
T}
.TE
.RE
.
.\" Local Variables:
.\" mode: nroff
.\" coding: latin-1
.\" End: