Standards, Environments, and Macros mm(5)
NAME
mm - text formatting (memorandum) macros
SYNOPSIS
nroff -mm [options] filename...
troff -mm [options] filename...
DESCRIPTION
This package of nroff(1) and troff(1) macro definitions pro-
vides a formatting facility for various styles of articles,theses, and books. When producing 2-column output on a ter-
minal or lineprinter, or when reverse line motions areneeded, filter the output through col(1). All external -mm
macros are defined below.Note: this -mm macro package is an extended version written
at Berkeley and is a superset of the standard -mm 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. Many nroff and troff 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: .bp begin new page .br break output line .spn insert n spacing lines .cen center next n lines .lsn line spacing: n=1 single, n=2 double space .na no alignment of right marginSunOS 5.11 Last change: 1 Jan 1997 1
Standards, Environments, and Macros mm(5)
Font and point size changes with \f and \s are also allowed; for example, \fIword\fR will italicize word. Output of the tbl(1), eqn(1) and refer(1) preprocessors for equations, tables, and references is acceptable as input. REQUESTS Here is a table of macros. Macro Name Initial Value Break? Reset? Explanation________________________________________________________________________________________________
.1C on y,y one column format on a new page________________________________________________________________________________________________
.2C [ l ] - y,y two column format l=line length
________________________________________________________________________________________________
.AE - y end abstract
________________________________________________________________________________________________
.AL [ t ] [ i ] [ s ] t=1;i=.Li;s=0 y Start automatic list type t=[1,A,a,I,i] 1=arabic numbers; A=uppercase letters a=lowercase letters; I=uppercase Roman numerals; i=lowercase Roman numerals indentation i; separation s________________________________________________________________________________________________
.AS m [ n ] n=0 y begin abstract________________________________________________________________________________________________
.AU - y author's name
________________________________________________________________________________________________
.AV x - y signature and date line of verifier x
________________________________________________________________________________________________
.B x - n embolden x; if no x, switch to boldface
________________________________________________________________________________________________
.BE - y end block text
________________________________________________________________________________________________
.BI x y - n embolden x and underline y
________________________________________________________________________________________________
.BL - y bullet list
________________________________________________________________________________________________
.BR x y - n embolden x and use Roman font for y
________________________________________________________________________________________________
.BS - n start block text
________________________________________________________________________________________________
.CN - y same as .DE (nroff)
________________________________________________________________________________________________
.CS - y cover sheet
________________________________________________________________________________________________
.CW - n same as .DS I (nroff)
________________________________________________________________________________________________
.DE - y end display
________________________________________________________________________________________________
SunOS 5.11 Last change: 1 Jan 1997 2
Standards, Environments, and Macros mm(5)
.DF [ p ] [ f ] [ rp ] p=L;f=N y start floating display; position p=[L,C,CB] L=left; I=indent; C=center; CB=center block fill f=[N,Y]; right position rp (fill only)________________________________________________________________________________________________
.DL [ i ] [ s ] - y start dash list
________________________________________________________________________________________________
.DS [ p ] [ f ] [ rp ] p=L;f=N y begin static display (see .DF for argu-
ment descriptions)________________________________________________________________________________________________
.EC x [ n ] n=1 y equation title; equation x; number n________________________________________________________________________________________________
.EF x - n even footer appears at the bottom of
even-numbered pages; x="l'c'r" l=left;
c=center; r=right________________________________________________________________________________________________
.EH x - n even header appears at the top of
even-numbered pages; x="l'c'r" l=left;
c=center; r=right________________________________________________________________________________________________
.EN - y end displayed equation produced by eqn
________________________________________________________________________________________________
.EQ - y break out equation produced by eqn
________________________________________________________________________________________________
.EX x [ n ] n=1 y exhibit title; exhibit x________________________________________________________________________________________________
number n________________________________________________________________________________________________
.FD [ f ] [ r ] f=10;r=1 n set footnote style format f=[0-11];
renumber r=[0,1]________________________________________________________________________________________________
.FE - y end footnote
________________________________________________________________________________________________
.FG x [ n ] n=1 y figure title; figure x; number n________________________________________________________________________________________________
.FS - n start footnote
________________________________________________________________________________________________
.H l [ t ] - y produce numbered heading level l=[1-7];
title t________________________________________________________________________________________________
.HU t - y produce unnumbered heading; title t
________________________________________________________________________________________________
.I x - n underline x
________________________________________________________________________________________________
.IB x y - n underline x and embolden y
________________________________________________________________________________________________
.IR x y - n underline x and use Roman font on y
________________________________________________________________________________________________
.LE [ s ] s=0 y end list; separation s________________________________________________________________________________________________
.LI [ m ] [ p ] - y start new list item; mark m
________________________________________________________________________________________________
SunOS 5.11 Last change: 1 Jan 1997 3
Standards, Environments, and Macros mm(5)
prefix p (mark only)________________________________________________________________________________________________
.ML m [ i ] [ s ] s=0 y start marked list; mark m indentation i; separation s=[0,1]________________________________________________________________________________________________
.MT x y memo title; title x________________________________________________________________________________________________
.ND x n no date in page footer; x is date on cover________________________________________________________________________________________________
.NE - y end block text
________________________________________________________________________________________________
.NS - y start block text
________________________________________________________________________________________________
.OF x - n odd footer appears at the bottom of
odd-numbered pages; x="l'c'r" l=left;
c=center; r=right________________________________________________________________________________________________
.OF x - n odd header appears at the top of odd-
numbered pages; x="l'c'r" l=left; c=center; r=right________________________________________________________________________________________________
.OP - y skip to the top of an odd-number page
________________________________________________________________________________________________
.P [ t ] t=0 y,y begin paragraph; t=[0,1] 0=justified; 1=indented________________________________________________________________________________________________
.PF x - n page footer appears at the bottom of
every page; x="l'c'r" l=left; c=center; r=right________________________________________________________________________________________________
.PH x - n page header appears at the top of every
page; x="l'c'r" l=left; c=center; r=right________________________________________________________________________________________________
.R on n return to Roman font________________________________________________________________________________________________
.RB x y - n use Roman on x and embolden y
________________________________________________________________________________________________
.RI x y - n use Roman on x and underline y
________________________________________________________________________________________________
.RP x - y,y released paper format ? x=no stops
title on first________________________________________________________________________________________________
.RS 5n y,y right shift: start level of relative indentation________________________________________________________________________________________________
.S m n - n set character point size & vertical
space character point size m; vertical space n________________________________________________________________________________________________
.SA x x=1 n justification; x=[0,1]SunOS 5.11 Last change: 1 Jan 1997 4
Standards, Environments, and Macros mm(5)
________________________________________________________________________________________________
.SK x - y skip x pages
________________________________________________________________________________________________
.SM - n smaller; decrease point size by 2
________________________________________________________________________________________________
.SP [ x ] - y leave x blank lines
________________________________________________________________________________________________
.TB x [ n ] n=1 y table title; table x; number n________________________________________________________________________________________________
.TC - y print table of contents (put at end of
| | | input file)______________________|_______________|_______________|_________________________________________
.TE | - | y | end of table processed by tbl
______________________|_______________|_______________|_________________________________________
.TH | - | y | end multi-page header of table
______________________|_______________|_______________|_________________________________________
.TL | - | n | title in boldface and two points larger
______________________|_______________|_______________|_________________________________________
.TM | - | n | UC Berkeley thesis mode
______________________|_______________|_______________|_________________________________________
.TP i | y | y | i=p.i. Begin indented paragraph, with | | | the tag given on the next text line. | | | Set prevailing indent to i.______________________|_______________|_______________|_________________________________________
.TS x | - | y,y | begin table; if x=H table has multi-
| | | page header______________________|_______________|_______________|_________________________________________
.TY | - | y | display centered title CONTENTS
______________________|_______________|_______________|_________________________________________
.VL i [ m ] [ s ] | m=0;s=0 | y | start variable-item list; indentation i
| | | mark-indentation m; separation s
REGISTERSFormatting distances can be controlled in -mm by means of
built-in number registers. For example, this sets the line
length to 6.5 inches: .nr LL 6.5i Here is a table of number registers and their default values: Name Register Controls Takes Effect Default______________________________________________________________________________
Cl contents level table of contents 2______________________________________________________________________________
De display eject display 0SunOS 5.11 Last change: 1 Jan 1997 5
Standards, Environments, and Macros mm(5)
______________________________________________________________________________
Df display floating display 5______________________________________________________________________________
Ds display spacing display 1v______________________________________________________________________________
Hb heading break heading 2______________________________________________________________________________
Hc heading centering heading 0______________________________________________________________________________
Hi heading indent heading 1______________________________________________________________________________
Hi heading spacing heading 1______________________________________________________________________________
Hu heading unnumbered heading 2______________________________________________________________________________
Li list indentation list 6 (nroff) 5 (troff)______________________________________________________________________________
Ls list spacing list 6______________________________________________________________________________
Pi paragraph indent paragraph 5______________________________________________________________________________
Pt paragraph type paragraph 1______________________________________________________________________________
Si static indent display 5 (nroff) 3 (troff) | | | | | | | | | When resett|ing these values, make| sure to specify |theappropriate| units. Setting the lin|e length to 7, for e|xam-
ple, will r|esult in output with one |character per line. |Set-
ting Pi to |0 suppresses paragraph in|dentation | | | | | | |Here is a l|ist of string registers a|vailable in -mm; |they
may be used|anywhere in the text: | | | | | | | | | | | Name| Strin|g's Function |___________|_________________________|____________________|__
\*Q | quote (" in nro|ff, `` in troff ) |___________|_________________________|____________________|__
\*U | unquote (" in n|roff, '' in troff ) |___________|_________________________|____________________|__
\*- | dash (-- in nro|ff, - in troff ) |
___________|_________________________|____________________|__
\*(MO | month (month of|the year) |__________________________________________________________
\*(DY day (current date)__________________________________________________________
\** automatically numbered footnote__________________________________________________________
SunOS 5.11 Last change: 1 Jan 1997 6
Standards, Environments, and Macros mm(5)
\*' acute accent (before letter)__________________________________________________________
\*` grave accent (before letter)__________________________________________________________
\*^ circumflex (before letter)__________________________________________________________
\*, cedilla (before letter)__________________________________________________________
\*: umlaut (before letter)__________________________________________________________
\*~ tilde (before letter)__________________________________________________________
\(BU bullet item__________________________________________________________
\(DT date (month day, yr)__________________________________________________________
\(EM em dash__________________________________________________________
\(Lf LIST OF FIGURES title__________________________________________________________
\(Lt LIST OF TABLES title__________________________________________________________
\(Lx LIST OF EXHIBITS title__________________________________________________________
\(Le LIST OF EQUATIONS title__________________________________________________________
\(Rp REFERENCES title__________________________________________________________
\(Tm trademark character (TM) | | | When using the exte|nded accent mark definitions available with .AM, these |strings should come after, rather than before, the letter |to be accented. | FILES | /usr/share/lib/tmac|/m/usr/share/lib/tmac/mm.[nt]
nroff and troff definitions of mm.
ATTRIBUTES
See attributes(5) for descriptions of the following attri-
butes:SunOS 5.11 Last change: 1 Jan 1997 7
Standards, Environments, and Macros mm(5)
____________________________________________________________
| ATTRIBUTE TYPE | ATTRIBUTE VALUE |
|_____________________________|_____________________________|
| Availability | text/doctools ||_____________________________|_____________________________|
SEE ALSO
col(1), eqn(1), nroff(1), refer(1), tbl(1), troff(1), attri-
butes(5)BUGS
Floating keeps and regular keeps are diverted to the same space, so they cannot be mixed together with predictable results.SunOS 5.11 Last change: 1 Jan 1997 8