1mm(5)                 Standards, Environments, and Macros                mm(5)
2
3
4

NAME

6       mm - text formatting (memorandum) macros
7

SYNOPSIS

9       nroff  -mm [options] filename...
10
11
12       troff  -mm [options] filename...
13
14

DESCRIPTION

16       This package of nroff(1) and troff(1) macro definitions provides a for‐
17       matting facility for various styles of  articles,  theses,  and  books.
18       When  producing  2-column  output on a terminal or lineprinter, or when
19       reverse line motions are needed, filter the output through col(1).  All
20       external -mm macros are defined below.
21
22
23       Note: this -mm macro package is an extended version written at Berkeley
24       and is a superset of the standard -mm macro  packages  as  supplied  by
25       Bell  Labs.   Some  of  the  Bell  Labs  macros  have been removed; for
26       instance, it is assumed that the user has little interest in  producing
27       headers stating that the memo was generated at Whippany Labs.
28
29
30       Many nroff and troff requests are unsafe in conjunction with this pack‐
31       age. However, the first four requests below may be used  with  impunity
32       after initialization, and the last two may be used even before initial‐
33       ization:
34
35       .bp        begin new page
36
37
38       .br        break output line
39
40
41       .spn       insert n spacing lines
42
43
44       .cen       center next n lines
45
46
47       .lsn       line spacing: n=1 single, n=2 double space
48
49
50       .na        no alignment of right margin
51
52
53
54       Font and point size changes with \f and \s are also allowed; for  exam‐
55       ple,  \fIword\fR  will italicize word. Output of the tbl(1), eqn(1) and
56       refer(1) preprocessors for equations, tables, and references is accept‐
57       able as input.
58

REQUESTS

60       Here is a table of macros.
61
62
63
64
65
66
67             Macro Name       │ Initial Value │ Break? Reset? │               Explanation
68       ───────────────────────┼───────────────┼───────────────┼─────────────────────────────────────────
69       .1C                    │ on            │ y,y           │ one column format on a new page
70       ───────────────────────┼───────────────┼───────────────┼─────────────────────────────────────────
71       .2C [ l ]              │ -             │ y,y           │ two column format l=line length
72       ───────────────────────┼───────────────┼───────────────┼─────────────────────────────────────────
73       .AE                    │ -             │ y             │ end abstract
74       ───────────────────────┼───────────────┼───────────────┼─────────────────────────────────────────
75       .AL [ t ] [ i ] [ s ]  │ t=1;i=.Li;s=0 │ y             │ Start automatic list type t=[1,A,a,I,i]
76                              │               │               │ 1=arabic numbers;  A=uppercase  letters
77                              │               │               │ a=lowercase  letters; I=uppercase Roman
78                              │               │               │ numerals;  i=lowercase  Roman  numerals
79                              │               │               │ indentation i; separation s
80       ───────────────────────┼───────────────┼───────────────┼─────────────────────────────────────────
81       .AS m [ n ]            │ n=0           │ y             │ begin abstract
82       ───────────────────────┼───────────────┼───────────────┼─────────────────────────────────────────
83       .AU                    │ -             │ y             │ author's name
84       ───────────────────────┼───────────────┼───────────────┼─────────────────────────────────────────
85       .AV x                  │ -             │ y             │ signature and date line of verifier x
86       ───────────────────────┼───────────────┼───────────────┼─────────────────────────────────────────
87       .B x                   │ -             │ n             │ embolden x; if no x, switch to boldface
88       ───────────────────────┼───────────────┼───────────────┼─────────────────────────────────────────
89       .BE                    │ -             │ y             │ end block text
90       ───────────────────────┼───────────────┼───────────────┼─────────────────────────────────────────
91       .BI x y                │ -             │ n             │ embolden x and underline y
92       ───────────────────────┼───────────────┼───────────────┼─────────────────────────────────────────
93       .BL                    │ -             │ y             │ bullet list
94       ───────────────────────┼───────────────┼───────────────┼─────────────────────────────────────────
95       .BR x y                │ -             │ n             │ embolden x and use Roman font for y
96       ───────────────────────┼───────────────┼───────────────┼─────────────────────────────────────────
97       .BS                    │ -             │ n             │ start block text
98       ───────────────────────┼───────────────┼───────────────┼─────────────────────────────────────────
99       .CN                    │ -             │ y             │ same as .DE (nroff)
100       ───────────────────────┼───────────────┼───────────────┼─────────────────────────────────────────
101       .CS                    │ -             │ y             │ cover sheet
102       ───────────────────────┼───────────────┼───────────────┼─────────────────────────────────────────
103       .CW                    │ -             │ n             │ same as .DS I (nroff)
104       ───────────────────────┼───────────────┼───────────────┼─────────────────────────────────────────
105       .DE                    │ -             │ y             │ end display
106       ───────────────────────┼───────────────┼───────────────┼─────────────────────────────────────────
107       .DF [ p ] [ f ] [ rp ] │ p=L;f=N       │ y             │ start    floating   display;   position
108                              │               │               │ p=[L,C,CB] L=left; I=indent;  C=center;
109                              │               │               │ CB=center  block  fill  f=[N,Y];  right
110                              │               │               │ position rp (fill only)
111       ───────────────────────┼───────────────┼───────────────┼─────────────────────────────────────────
112       .DL [ i ] [ s ]        │ -             │ y             │ start dash list
113       ───────────────────────┼───────────────┼───────────────┼─────────────────────────────────────────
114       .DS [ p ] [ f ] [ rp ] │ p=L;f=N       │ y             │ begin static display (see .DF for argu‐
115                              │               │               │ ment descriptions)
116       ───────────────────────┼───────────────┼───────────────┼─────────────────────────────────────────
117       .EC x [ n ]            │ n=1           │ y             │ equation title; equation x; number n
118       ───────────────────────┼───────────────┼───────────────┼─────────────────────────────────────────
119       .EF x                  │ -             │ n             │ even  footer  appears  at the bottom of
120                              │               │               │ even-numbered pages; x="l'c'r"  l=left;
121                              │               │               │ c=center; r=right
122       ───────────────────────┼───────────────┼───────────────┼─────────────────────────────────────────
123       .EH x                  │ -             │ n             │ even header appears at the top of even-
124                              │               │               │ numbered   pages;   x="l'c'r"   l=left;
125                              │               │               │ c=center; r=right
126       ───────────────────────┼───────────────┼───────────────┼─────────────────────────────────────────
127       .EN                    │ -             │ y             │ end displayed equation produced by eqn
128       ───────────────────────┼───────────────┼───────────────┼─────────────────────────────────────────
129       .EQ                    │ -             │ y             │ break out equation produced by eqn
130       ───────────────────────┴───────────────┴───────────────┴─────────────────────────────────────────
131
132
133       .EX x [ n ]            │ n=1           │ y             │ exhibit title; exhibit x
134       ───────────────────────┼───────────────┼───────────────┼─────────────────────────────────────────
135                              │               │               │ number n
136       ───────────────────────┼───────────────┼───────────────┼─────────────────────────────────────────
137       .FD [ f ] [ r ]        │ f=10;r=1      │ n             │ set  footnote  style  format  f=[0-11];
138                              │               │               │ renumber r=[0,1]
139       ───────────────────────┼───────────────┼───────────────┼─────────────────────────────────────────
140       .FE                    │ -             │ y             │ end footnote
141       ───────────────────────┼───────────────┼───────────────┼─────────────────────────────────────────
142       .FG x [ n ]            │ n=1           │ y             │ figure title; figure x; number n
143       ───────────────────────┼───────────────┼───────────────┼─────────────────────────────────────────
144       .FS                    │ -             │ n             │ start footnote
145       ───────────────────────┼───────────────┼───────────────┼─────────────────────────────────────────
146       .H l [ t ]             │ -             │ y             │ produce numbered heading level l=[1-7];
147                              │               │               │ title t
148       ───────────────────────┼───────────────┼───────────────┼─────────────────────────────────────────
149       .HU t                  │ -             │ y             │ produce unnumbered heading; title t
150       ───────────────────────┼───────────────┼───────────────┼─────────────────────────────────────────
151       .I x                   │ -             │ n             │ underline x
152       ───────────────────────┼───────────────┼───────────────┼─────────────────────────────────────────
153       .IB x y                │ -             │ n             │ underline x and embolden y
154       ───────────────────────┼───────────────┼───────────────┼─────────────────────────────────────────
155       .IR x y                │ -             │ n             │ underline x and use Roman font on y
156       ───────────────────────┼───────────────┼───────────────┼─────────────────────────────────────────
157       .LE [ s ]              │ s=0           │ y             │ end list; separation s
158       ───────────────────────┼───────────────┼───────────────┼─────────────────────────────────────────
159       .LI [ m ] [ p ]        │ -             │ y             │ start new list item; mark m
160       ───────────────────────┼───────────────┼───────────────┼─────────────────────────────────────────
161                              │               │               │ prefix p (mark only)
162       ───────────────────────┼───────────────┼───────────────┼─────────────────────────────────────────
163       .ML m [ i ] [ s ]      │ s=0           │ y             │ start  marked  list; mark m indentation
164                              │               │               │ i; separation s=[0,1]
165       ───────────────────────┼───────────────┼───────────────┼─────────────────────────────────────────
166       .MT x                  │               │ y             │ memo title; title x
167       ───────────────────────┼───────────────┼───────────────┼─────────────────────────────────────────
168       .ND x                  │               │ n             │ no date in page footer; x  is  date  on
169                              │               │               │ cover
170       ───────────────────────┼───────────────┼───────────────┼─────────────────────────────────────────
171       .NE                    │ -             │ y             │ end block text
172       ───────────────────────┼───────────────┼───────────────┼─────────────────────────────────────────
173       .NS                    │ -             │ y             │ start block text
174       ───────────────────────┼───────────────┼───────────────┼─────────────────────────────────────────
175       .OF x                  │ -             │ n             │ odd  footer  appears  at  the bottom of
176                              │               │               │ odd-numbered pages;  x="l'c'r"  l=left;
177                              │               │               │ c=center; r=right
178       ───────────────────────┼───────────────┼───────────────┼─────────────────────────────────────────
179       .OF x                  │ -             │ n             │ odd  header  appears at the top of odd-
180                              │               │               │ numbered   pages;   x="l'c'r"   l=left;
181                              │               │               │ c=center; r=right
182       ───────────────────────┼───────────────┼───────────────┼─────────────────────────────────────────
183       .OP                    │ -             │ y             │ skip to the top of an odd-number page
184       ───────────────────────┼───────────────┼───────────────┼─────────────────────────────────────────
185       .P [ t ]               │ t=0           │ y,y           │ begin  paragraph;  t=[0,1] 0=justified;
186                              │               │               │ 1=indented
187       ───────────────────────┼───────────────┼───────────────┼─────────────────────────────────────────
188       .PF x                  │ -             │ n             │ page footer appears at  the  bottom  of
189                              │               │               │ every page; x="l'c'r" l=left; c=center;
190                              │               │               │ r=right
191       ───────────────────────┼───────────────┼───────────────┼─────────────────────────────────────────
192       .PH x                  │ -             │ n             │ page header appears at the top of every
193                              │               │               │ page;   x="l'c'r"   l=left;   c=center;
194                              │               │               │ r=right
195       ───────────────────────┼───────────────┼───────────────┼─────────────────────────────────────────
196       .R                     │ on            │ n             │ return to Roman font
197       ───────────────────────┴───────────────┴───────────────┴─────────────────────────────────────────
198
199       .RB x y                │ -             │ n             │ use Roman on x and embolden y
200       ───────────────────────┼───────────────┼───────────────┼─────────────────────────────────────────
201       .RI x y                │ -             │ n             │ use Roman on x and underline y
202       ───────────────────────┼───────────────┼───────────────┼─────────────────────────────────────────
203       .RP x                  │ -             │ y,y           │ released  paper  format  ?  x=no  stops
204                              │               │               │ title on first
205       ───────────────────────┼───────────────┼───────────────┼─────────────────────────────────────────
206       .RS                    │ 5n            │ y,y           │ right  shift:  start  level of relative
207                              │               │               │ indentation
208       ───────────────────────┼───────────────┼───────────────┼─────────────────────────────────────────
209       .S m n                 │ -             │ n             │ set character  point  size  &  vertical
210                              │               │               │ space  character point size m; vertical
211                              │               │               │ space n
212       ───────────────────────┼───────────────┼───────────────┼─────────────────────────────────────────
213       .SA x                  │ x=1           │ n             │ justification; x=[0,1]
214       ───────────────────────┼───────────────┼───────────────┼─────────────────────────────────────────
215       .SK x                  │ -             │ y             │ skip x pages
216       ───────────────────────┼───────────────┼───────────────┼─────────────────────────────────────────
217       .SM                    │ -             │ n             │ smaller; decrease point size by 2
218       ───────────────────────┼───────────────┼───────────────┼─────────────────────────────────────────
219       .SP [ x ]              │ -             │ y             │ leave x blank lines
220       ───────────────────────┼───────────────┼───────────────┼─────────────────────────────────────────
221       .TB x [ n ]            │ n=1           │ y             │ table title; table x; number n
222       ───────────────────────┼───────────────┼───────────────┼─────────────────────────────────────────
223       .TC                    │ -             │ y             │ print table of contents (put at end  of
224                              │               │               │ input file)
225       ───────────────────────┼───────────────┼───────────────┼─────────────────────────────────────────
226       .TE                    │ -             │ y             │ end of table processed by tbl
227       ───────────────────────┼───────────────┼───────────────┼─────────────────────────────────────────
228       .TH                    │ -             │ y             │ end multi-page header of table
229       ───────────────────────┼───────────────┼───────────────┼─────────────────────────────────────────
230       .TL                    │ -             │ n             │ title in boldface and two points larger
231       ───────────────────────┼───────────────┼───────────────┼─────────────────────────────────────────
232       .TM                    │ -             │ n             │ UC Berkeley thesis mode
233       ───────────────────────┼───────────────┼───────────────┼─────────────────────────────────────────
234       .TP i                  │ y             │ y             │ i=p.i.  Begin  indented paragraph, with
235                              │               │               │ the tag given on the  next  text  line.
236                              │               │               │ Set prevailing indent to i.
237       ───────────────────────┼───────────────┼───────────────┼─────────────────────────────────────────
238       .TS x                  │ -             │ y,y           │ begin  table;  if  x=H table has multi-
239                              │               │               │ page header
240       ───────────────────────┼───────────────┼───────────────┼─────────────────────────────────────────
241       .TY                    │ -             │ y             │ display centered title CONTENTS
242       ───────────────────────┼───────────────┼───────────────┼─────────────────────────────────────────
243       .VL i [ m ] [ s ]      │ m=0;s=0       │ y             │ start variable-item list; indentation i
244                              │               │               │ mark-indentation m; separation s
245
246

REGISTERS

248       Formatting distances can be controlled in -mm by means of built-in num‐
249       ber registers. For example, this sets the line length to 6.5 inches:
250
251         .nr  LL  6.5i
252
253
254
255       Here is a table of number registers and their default values:
256
257
258
259                   │                        │                   │
260          Name     │   Register Controls    │   Takes Effect    │       Default
261       ────────────┼────────────────────────┼───────────────────┼─────────────────────
262       Cl          │ contents level         │ table of contents │ 2
263       ────────────┴────────────────────────┴───────────────────┴─────────────────────
264
265       De          │ display eject          │ display           │ 0
266       ────────────┼────────────────────────┼───────────────────┼─────────────────────
267       Df          │ display floating       │ display           │ 5
268       ────────────┼────────────────────────┼───────────────────┼─────────────────────
269       Ds          │ display spacing        │ display           │ 1v
270       ────────────┼────────────────────────┼───────────────────┼─────────────────────
271       Hb          │ heading break          │ heading           │ 2
272       ────────────┼────────────────────────┼───────────────────┼─────────────────────
273       Hc          │ heading centering      │ heading           │ 0
274       ────────────┼────────────────────────┼───────────────────┼─────────────────────
275       Hi          │ heading indent         │ heading           │ 1
276       ────────────┼────────────────────────┼───────────────────┼─────────────────────
277       Hi          │ heading spacing        │ heading           │ 1
278       ────────────┼────────────────────────┼───────────────────┼─────────────────────
279       Hu          │ heading unnumbered     │ heading           │ 2
280       ────────────┼────────────────────────┼───────────────────┼─────────────────────
281       Li          │ list indentation       │ list              │ 6 (nroff) 5 (troff)
282       ────────────┼────────────────────────┼───────────────────┼─────────────────────
283       Ls          │ list spacing           │ list              │ 6
284       ────────────┼────────────────────────┼───────────────────┼─────────────────────
285       Pi          │ paragraph indent       │ paragraph         │ 5
286       ────────────┼────────────────────────┼───────────────────┼─────────────────────
287       Pt          │ paragraph type         │ paragraph         │ 1
288       ────────────┼────────────────────────┼───────────────────┼─────────────────────
289       Si          │ static indent          │ display           │ 5 (nroff) 3 (troff)
290
291
292
293       When resetting these values,  make  sure  to  specify  the  appropriate
294       units. Setting the line length to 7, for example, will result in output
295       with one character per line.  Setting  Pi  to  0  suppresses  paragraph
296       indentation
297
298
299       Here  is  a list of string registers available in -mm; they may be used
300       anywhere in the text:
301
302
303
304
305              Name         │          String's Function
306       ────────────────────┼──────────────────────────────────────
307       \*Q                 │quote (" in nroff, `` in troff )
308       ────────────────────┼──────────────────────────────────────
309       \*U                 │unquote (" in nroff, '' in troff )
310       ────────────────────┼──────────────────────────────────────
311       \*-                 │dash (-- in nroff, — in troff )
312       ────────────────────┼──────────────────────────────────────
313       \*(MO               │month (month of the year)
314       ────────────────────┼──────────────────────────────────────
315       \*(DY               │day (current date)
316       ────────────────────┼──────────────────────────────────────
317       \**                 │automatically numbered footnote
318       ────────────────────┼──────────────────────────────────────
319       \*'                 │acute accent (before letter)
320       ────────────────────┼──────────────────────────────────────
321       \*`                 │grave accent (before letter)
322       ────────────────────┼──────────────────────────────────────
323       \*^                 │circumflex (before letter)
324       ────────────────────┼──────────────────────────────────────
325       \*,                 │cedilla (before letter)
326       ────────────────────┼──────────────────────────────────────
327       \*:                 │umlaut (before letter)
328       ────────────────────┴──────────────────────────────────────
329
330
331       \*~                 │tilde (before letter)
332       ────────────────────┼──────────────────────────────────────
333       \(BU                │bullet item
334       ────────────────────┼──────────────────────────────────────
335       \(DT                │date (month day, yr)
336       ────────────────────┼──────────────────────────────────────
337       \(EM                │em dash
338       ────────────────────┼──────────────────────────────────────
339       \(Lf                LIST OF FIGURES title
340       ────────────────────┼──────────────────────────────────────
341       \(Lt                LIST OF TABLES title
342       ────────────────────┼──────────────────────────────────────
343       \(Lx                LIST OF EXHIBITS title
344       ────────────────────┼──────────────────────────────────────
345       \(Le                LIST OF EQUATIONS title
346       ────────────────────┼──────────────────────────────────────
347       \(Rp                REFERENCES title
348       ────────────────────┼──────────────────────────────────────
349       \(Tm                │trademark character (TM)
350
351
352
353       When using the extended accent mark  definitions  available  with  .AM,
354       these  strings  should come after, rather than before, the letter to be
355       accented.
356

FILES

358       /usr/share/lib/tmac/m
359
360
361
362
363       /usr/share/lib/tmac/mm.[nt]
364
365           nroff and troff definitions of mm.
366
367

ATTRIBUTES

369       See attributes(5) for descriptions of the following attributes:
370
371
372
373
374       ┌─────────────────────────────┬─────────────────────────────┐
375       │      ATTRIBUTE TYPE         │      ATTRIBUTE VALUE        │
376       ├─────────────────────────────┼─────────────────────────────┤
377       │Availability                 │SUNWdoc                      │
378       └─────────────────────────────┴─────────────────────────────┘
379

SEE ALSO

381       col(1), eqn(1), nroff(1), refer(1), tbl(1), troff(1), attributes(5)
382

BUGS

384       Floating keeps and regular keeps are diverted to  the  same  space,  so
385       they cannot be mixed together with predictable results.
386
387
388
389SunOS 5.11                        1 Jan 1997                             mm(5)
Impressum