'\" te
.\" Copyright (c) 1997, Sun Microsystems, Inc.
.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
.TH mm 5 "1 Jan 1997" "SunOS 5.11" "Standards, Environments, and Macros"
.SH NAME
mm \- text formatting (memorandum) macros
.SH SYNOPSIS
.LP
.nf
\fBnroff\fR  \fB-mm\fR [\fIoptions\fR] \fIfilename\fR...
.fi

.LP
.nf
\fBtroff\fR  \fB-mm\fR [\fIoptions\fR] \fIfilename\fR...
.fi

.SH DESCRIPTION
.sp
.LP
This package of \fBnroff\fR(1) and \fBtroff\fR(1) macro definitions provides a
formatting facility for various styles of articles, theses, and books. When
producing 2-column output on a terminal or lineprinter, or when reverse line
motions are needed, filter the output through \fBcol\fR(1). All external
\fB-mm\fR macros are defined below.
.sp
.LP
Note: this \fB-mm\fR macro package is an extended version written at Berkeley
and is a superset of the standard \fB-mm\fR macro packages as supplied by Bell
Labs.  Some of the Bell Labs macros have been removed; for instance, it is
assumed that the user has little interest in producing headers stating that the
memo was generated at Whippany Labs.
.sp
.LP
Many \fBnroff\fR and \fBtroff\fR requests are unsafe in conjunction with this
package. However, the first four requests below may be used with impunity after
initialization, and the last two may be used even before initialization:
.sp
.ne 2
.mk
.na
\fB\fB\&.bp\fR\fR
.ad
.RS 11n
.rt  
begin new page
.RE

.sp
.ne 2
.mk
.na
\fB\fB\&.br\fR \fR
.ad
.RS 11n
.rt  
break output line
.RE

.sp
.ne 2
.mk
.na
\fB\fB\&.sp\fR\fIn\fR \fR
.ad
.RS 11n
.rt  
insert n spacing lines
.RE

.sp
.ne 2
.mk
.na
\fB\fB\&.ce\fR\fIn\fR \fR
.ad
.RS 11n
.rt  
center next n lines
.RE

.sp
.ne 2
.mk
.na
\fB\fB\&.ls\fR\fIn\fR \fR
.ad
.RS 11n
.rt  
line spacing: \fIn\fR\fB=1\fR single, \fIn\fR\fB=2\fR double space
.RE

.sp
.ne 2
.mk
.na
\fB\fB\&.na\fR \fR
.ad
.RS 11n
.rt  
no alignment of right margin
.RE

.sp
.LP
Font and point size changes with \fB\ef\fR and \fB\es\fR are also allowed; for
example, \fB\efIword\efR\fR will italicize \fIword\fR. Output of the
\fBtbl\fR(1), \fBeqn\fR(1) and \fBrefer\fR(1) preprocessors for equations,
tables, and references is acceptable as input.
.SH REQUESTS
.sp
.LP
Here is a table of macros.
.sp

.sp
.TS
tab();
cw(1.47i) |cw(1.1i) |cw(.74i) |cw(2.19i) 
lw(1.47i) |lw(1.1i) |lw(.74i) |lw(2.19i) 
.
Macro NameInitial ValueBreak? Reset?Explanation
_
\fB\&.1C\fRony,yone column format on a new page
_
\fB\&.2C\fR [ \fIl\fR ]-y,ytwo column format \fIl\fR=line length
_
\fB\&.AE\fR-yend abstract
_
\fB\&.AL\fR [ \fIt\fR ] [ \fIi\fR ] [ \fIs\fR ]\fIt\fR=\fB1\fR;\fIi\fR=\fB\&.Li\fR;\fIs\fR=\fB0\fRyT{
Start automatic list type \fIt\fR=[\fB1\fR,\fBA\fR,\fBa\fR,\fBI\fR,\fBi\fR] \fB1\fR=arabic numbers; \fBA\fR=uppercase letters \fBa\fR=lowercase letters; \fBI\fR=uppercase Roman numerals; \fBi\fR=lowercase Roman numerals indentation \fIi\fR; separation \fIs\fR
T}
_
\fB\&.AS\fR \fIm\fR [ \fIn\fR ]\fIn\fR=\fB0\fRybegin abstract
_
\fB\&.AU\fR-yauthor's name
_
\fB\&.AV\fR \fIx\fR-ysignature and date line of verifier \fIx\fR
_
\fB\&.B\fR \fIx\fR-nembolden \fIx\fR; if no \fIx\fR, switch to boldface
_
\fB\&.BE\fR-yend block text
_
\fB\&.BI\fR \fIx\fR \fIy\fR-nembolden \fIx\fR and underline \fIy\fR
_
\fB\&.BL\fR-ybullet list
_
\fB\&.BR\fR \fIx\fR \fIy\fR-nembolden \fIx\fR and use Roman font for \fIy\fR
_
\fB\&.BS\fR-nstart block text
_
\fB\&.CN\fR-ysame as \fB\&.DE\fR (\fBnroff\fR)
_
\fB\&.CS\fR-ycover sheet
_
\fB\&.CW\fR-nsame as \fB\&.DS I\fR (\fBnroff\fR)
_
\fB\&.DE\fR-yend display
_
\fB\&.DF\fR [ \fIp\fR ] [ \fIf\fR ] [ \fIrp\fR ]\fIp\fR=\fBL\fR;\fIf\fR=\fBN\fRyT{
start floating display; position \fIp\fR=[\fBL\fR,\fBC\fR,\fBCB\fR] \fBL\fR=left; \fBI\fR=indent; \fBC\fR=center; \fBCB\fR=center block fill \fIf\fR=[\fBN\fR,\fBY\fR]; right position \fIrp\fR (fill only)
T}
_
\fB\&.DL\fR [ \fIi\fR ] [ \fIs\fR ]-ystart dash list
_
\fB\&.DS\fR [ \fIp\fR ] [ \fIf\fR ] [ \fIrp\fR ]\fIp\fR=\fBL\fR;\fIf\fR=\fBN\fRyT{
begin static display (see \fB\&.DF\fR for argument descriptions)
T}
_
\fB\&.EC\fR \fIx\fR [ \fIn\fR ]\fIn\fR=\fB1\fRyequation title; equation \fIx\fR; number \fIn\fR
_
\fB\&.EF\fR \fIx\fR-nT{
even footer appears at the bottom of even-numbered pages; \fIx\fR="\fIl\fR\fB\&'\fR\fIc\fR\fB\&'\fR\fIr\fR" \fIl\fR=left; \fIc\fR=center; \fIr\fR=right
T}
_
\fB\&.EH\fR \fIx\fR-nT{
even header appears at the top of even-numbered pages; \fIx\fR="\fIl\fR\fB\&'\fR\fIc\fR\fB\&'\fR\fIr\fR" \fIl\fR=left; \fIc\fR=center; \fIr\fR=right
T}
_
\fB\&.EN\fR-yend displayed equation produced by \fBeqn\fR
_
\fB\&.EQ\fR-ybreak out equation produced by \fBeqn\fR
_
\fB\&.EX\fR \fIx\fR [ \fIn\fR ]\fIn\fR=\fB1\fRyexhibit title; exhibit \fIx\fR
_
number \fIn\fR
_
\fB\&.FD\fR [ \fIf\fR ] [ \fIr\fR ]\fIf\fR=\fB10\fR;\fIr\fR=\fB1\fRnT{
set footnote style format \fIf\fR=[\fB0-11\fR]; renumber \fIr\fR=[\fB0\fR,\fB1\fR]
T}
_
\fB\&.FE\fR-yend footnote
_
\fB\&.FG\fR \fIx\fR [ \fIn\fR ]\fIn\fR=\fB1\fRyfigure title; figure \fIx\fR; number \fIn\fR
_
\fB\&.FS\fR-nstart footnote
_
\fB\&.H\fR \fIl\fR [ \fIt\fR ]-yT{
produce numbered heading level \fIl\fR=[\fB1-7\fR]; title \fIt\fR
T}
_
\fB\&.HU\fR \fIt\fR-yproduce unnumbered heading; title \fIt\fR
_
\fB\&.I\fR \fIx\fR-nunderline \fIx\fR
_
\fB\&.IB\fR \fIx\fR \fIy\fR-nunderline \fIx\fR and embolden \fIy\fR
_
\fB\&.IR\fR \fIx\fR \fIy\fR-nunderline \fIx\fR and use Roman font on \fIy\fR
_
\fB\&.LE\fR [ \fIs\fR ]\fIs\fR=\fB0\fRyend list; separation \fIs\fR
_
\fB\&.LI\fR [ \fIm\fR ] [ \fIp\fR ]-ystart new list item; mark \fIm\fR
_
prefix \fIp\fR (mark only)
_
\fB\&.ML\fR \fIm\fR [ \fIi\fR ] [ \fIs\fR ]\fIs\fR=\fB0\fRyT{
start marked list; mark \fIm\fR indentation \fIi\fR; separation \fIs\fR=[\fB0\fR,\fB1\fR]
T}
_
\fB\&.MT\fR \fIx\fRymemo title; title \fIx\fR
_
\fB\&.ND\fR \fIx\fRnT{
no date in page footer; \fIx\fR is date on cover
T}
_
\fB\&.NE\fR-yend block text
_
\fB\&.NS\fR-ystart block text
_
\fB\&.OF\fR \fIx\fR-nT{
odd footer appears at the bottom of odd-numbered pages; \fIx\fR="\fIl\fR\fB\&'\fR\fIc\fR\fB\&'\fR\fIr\fR" \fIl\fR=left; \fIc\fR=center; \fIr\fR=right
T}
_
\fB\&.OF\fR \fIx\fR-nT{
odd header appears at the top of odd-numbered pages; \fIx\fR="\fIl\fR\fB\&'\fR\fIc\fR\fB\&'\fR\fIr\fR" \fIl\fR=left; \fIc\fR=center; \fIr\fR=right
T}
_
\fB\&.OP\fR-yskip to the top of an odd-number page
_
\fB\&.P\fR [ \fIt\fR ]\fIt\fR=\fB0\fRy,yT{
begin paragraph; \fIt\fR=[\fB0\fR,\fB1\fR] \fB0\fR=justified; \fB1\fR=indented
T}
_
\fB\&.PF\fR \fIx\fR-nT{
page footer appears at the bottom of every page; \fIx\fR="\fIl\fR\fB\&'\fR\fIc\fR\fB\&'\fR\fIr\fR" \fIl\fR=left; \fIc\fR=center; \fIr\fR=right
T}
_
\fB\&.PH\fR \fIx\fR-nT{
page header appears at the top of every page; \fIx\fR="\fIl\fR\fB\&'\fR\fIc\fR\fB\&'\fR\fIr\fR" \fIl\fR=left; \fIc\fR=center; \fIr\fR=right
T}
_
\fB\&.R\fRonnreturn to Roman font
_
\fB\&.RB\fR \fIx\fR \fIy\fR-nuse Roman on \fIx\fR and embolden \fIy\fR
_
\fB\&.RI\fR \fIx\fR \fIy\fR-nuse Roman on \fIx\fR and underline \fIy\fR
_
\fB\&.RP\fR \fIx\fR-y,yT{
released paper format ? \fIx\fR=no stops title on first
T}
_
\fB\&.RS\fR5ny,yT{
right shift: start level of relative indentation
T}
_
\fB\&.S\fR \fIm\fR \fIn\fR-nT{
set character point size & vertical space character point size \fIm\fR; vertical space \fIn\fR
T}
_
\fB\&.SA\fR \fIx\fR\fIx\fR=\fB1\fRnjustification; \fIx\fR=[\fB0\fR,\fB1\fR]
_
\fB\&.SK\fR \fIx\fR-yskip \fIx\fR pages
_
\fB\&.SM\fR -nsmaller; decrease point size by 2
_
\fB\&.SP\fR [ \fIx\fR ]-yleave \fIx\fR blank lines
_
\fB\&.TB\fR \fIx\fR [ \fIn\fR ]\fIn\fR=\fB1\fRytable title; table \fIx\fR; number \fIn\fR
_
\fB\&.TC\fR-yT{
print table of contents (put at end of input file)
T}
_
\fB\&.TE\fR-yend of table processed by tbl
_
\fB\&.TH\fR-yend multi-page header of table
_
\fB\&.TL\fR-ntitle in boldface and two points larger
_
\fB\&.TM\fR-nUC Berkeley thesis mode
_
\fB\&.TP\fR \fIi\fRyyT{
\fIi\fR=p.i. Begin indented paragraph, with the tag given on the next text line. Set prevailing indent to \fIi\fR.
T}
_
\fB\&.TS\fR \fIx\fR-y,yT{
begin table; if \fIx\fR=\fBH\fR table has multi-page header
T}
_
\fB\&.TY\fR -ydisplay centered title \fBCONTENTS\fR
_
\fB\&.VL\fR \fIi\fR [ \fIm\fR ] [ \fIs\fR ]\fIm\fR=\fB0\fR;\fIs\fR=\fB0\fRyT{
start variable-item list; indentation \fIi\fR mark-indentation \fIm\fR; separation \fIs\fR
T}
.TE

.SH REGISTERS
.sp
.LP
Formatting distances can be controlled in \fB-mm\fR by means of built-in number
registers. For example, this sets the line length to 6.5 inches:
.sp
.in +2
.nf
\&.nr  LL  6.5i
.fi
.in -2

.sp
.LP
Here is a table of number registers and their default values:
.sp

.sp
.TS
tab();
cw(1.1i) |cw(2.19i) |cw(1.1i) |cw(1.11i) 
lw(1.1i) |lw(2.19i) |lw(1.1i) |lw(1.11i) 
.
NameRegister ControlsTakes EffectDefault
_
\fBCl\fRcontents leveltable of contents2
_
\fBDe\fRdisplay ejectdisplay0
_
\fBDf\fRdisplay floatingdisplay5
_
\fBDs\fRdisplay spacingdisplay1v
_
\fBHb\fRheading breakheading2
_
\fBHc\fRheading centeringheading0
_
\fBHi\fRheading indentheading1
_
\fBHi\fRheading spacingheading1
_
\fBHu\fRheading unnumberedheading2
_
\fBLi\fRlist indentationlist\fB6 (\fR\fBnroff\fR\fB) 5 (\fR\fBtroff\fR\fB)\fR
_
\fBLs\fRlist spacinglist6
_
\fBPi\fRparagraph indentparagraph5
_
\fBPt\fRparagraph typeparagraph1
_
\fBSi\fRstatic indentdisplay\fB5 (\fR\fBnroff\fR\fB) 3 (\fR\fBtroff\fR\fB)\fR
.TE

.sp
.LP
When resetting these values, make sure to specify the appropriate units.
Setting the line length to 7, for example, will result in output with one
character per line. Setting \fBPi\fR to 0 suppresses paragraph indentation
.sp
.LP
Here is a list of string registers available in \fB-mm\fR; they may be used
anywhere in the text:
.sp

.sp
.TS
tab();
cw(1.82i) |cw(3.68i) 
lw(1.82i) |lw(3.68i) 
.
NameString's Function
_
\fB\e*Q\fRquote (\fB"\fR in \fBnroff,\fR\| \fB``\fR in \fBtroff\fR )
_
\fB\e*U\fR unquote (\fB"\fR in \fBnroff,\fR\| \fB\&''\fR in \fBtroff\fR )
_
\fB\e*-\fRdash (\fB--\fR in \fBnroff,\fR \(em in \fBtroff\fR )
_
\fB\e*(MO\fRmonth (month of the year)
_
\fB\e*(DY\fRday (current date)
_
\fB\e**\fRautomatically numbered footnote
_
\fB\e*'\fRacute accent (before letter)
_
\fB\e*`\fRgrave accent (before letter)
_
\fB\e*^\fRcircumflex (before letter)
_
\fB\e*,\fRcedilla (before letter)
_
\fB\e*:\fRumlaut (before letter)
_
\fB\e*~\fRtilde (before letter)
_
\fB\e(BU\fRbullet item
_
\fB\e(DT\fRdate (\fImonth day\fR, \fIyr\fR)
_
\fB\e(EM\fRem dash
_
\fB\e(Lf\fR\fBLIST OF FIGURES\fR title
_
\fB\e(Lt\fR\fBLIST OF TABLES\fR title
_
\fB\e(Lx\fR\fBLIST OF EXHIBITS\fR title
_
\fB\e(Le\fR\fBLIST OF EQUATIONS\fR title
_
\fB\e(Rp\fR\fBREFERENCES\fR title
_
\fB\e(Tm\fRtrademark character (TM)
.TE

.sp
.LP
When using the extended accent mark definitions available with \fB\&.AM\fR,
these strings should come after, rather than before, the letter to be accented.
.SH FILES
.sp
.ne 2
.mk
.na
\fB\fB/usr/share/lib/tmac/m\fR\fR
.ad
.sp .6
.RS 4n
 
.RE

.sp
.ne 2
.mk
.na
\fB\fB/usr/share/lib/tmac/mm.[nt]\fR\fR
.ad
.sp .6
.RS 4n
\fBnroff\fR and \fBtroff\fR definitions of \fBmm\fR.
.RE

.SH SEE ALSO
.sp
.LP
\fBcol\fR(1), \fBeqn\fR(1), \fBnroff\fR(1), \fBrefer\fR(1), \fBtbl\fR(1),
\fBtroff\fR(1), \fBattributes\fR(5)
.SH BUGS
.sp
.LP
Floating keeps and regular keeps are diverted to the same space, so they cannot
be mixed together with predictable results.