| blob | 10208d127b887166c6415c4a46938ce5aa6a69cd |
1 '\" te
2 .\" Copyright (c) 1997, Sun Microsystems, Inc.
3 .\" 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.
4 .\" 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.
5 .\" 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]
6 .TH MM 5 "Jan 1, 1997"
7 .SH NAME
8 mm \- text formatting (memorandum) macros
9 .SH SYNOPSIS
10 .LP
11 .nf
12 \fBnroff\fR \fB-mm\fR [\fIoptions\fR] \fIfilename\fR...
13 .fi
15 .LP
16 .nf
17 \fBtroff\fR \fB-mm\fR [\fIoptions\fR] \fIfilename\fR...
18 .fi
20 .SH DESCRIPTION
21 .sp
22 .LP
23 This package of \fBnroff\fR(1) and \fBtroff\fR(1) macro definitions provides a
24 formatting facility for various styles of articles, theses, and books. When
25 producing 2-column output on a terminal or lineprinter, or when reverse line
26 motions are needed, filter the output through \fBcol\fR(1). All external
27 \fB-mm\fR macros are defined below.
28 .sp
29 .LP
30 Note: this \fB-mm\fR macro package is an extended version written at Berkeley
31 and is a superset of the standard \fB-mm\fR macro packages as supplied by Bell
32 Labs. Some of the Bell Labs macros have been removed; for instance, it is
33 assumed that the user has little interest in producing headers stating that the
34 memo was generated at Whippany Labs.
35 .sp
36 .LP
37 Many \fBnroff\fR and \fBtroff\fR requests are unsafe in conjunction with this
38 package. However, the first four requests below may be used with impunity after
39 initialization, and the last two may be used even before initialization:
40 .sp
41 .ne 2
42 .na
43 \fB\fB\&.bp\fR\fR
44 .ad
45 .RS 11n
46 begin new page
47 .RE
49 .sp
50 .ne 2
51 .na
52 \fB\fB\&.br\fR \fR
53 .ad
54 .RS 11n
55 break output line
56 .RE
58 .sp
59 .ne 2
60 .na
61 \fB\fB\&.sp\fR\fIn\fR \fR
62 .ad
63 .RS 11n
64 insert n spacing lines
65 .RE
67 .sp
68 .ne 2
69 .na
70 \fB\fB\&.ce\fR\fIn\fR \fR
71 .ad
72 .RS 11n
73 center next n lines
74 .RE
76 .sp
77 .ne 2
78 .na
79 \fB\fB\&.ls\fR\fIn\fR \fR
80 .ad
81 .RS 11n
82 line spacing: \fIn\fR\fB=1\fR single, \fIn\fR\fB=2\fR double space
83 .RE
85 .sp
86 .ne 2
87 .na
88 \fB\fB\&.na\fR \fR
89 .ad
90 .RS 11n
91 no alignment of right margin
92 .RE
94 .sp
95 .LP
96 Font and point size changes with \fB\ef\fR and \fB\es\fR are also allowed; for
97 example, \fB\efIword\efR\fR will italicize \fIword\fR. Output of the
98 \fBtbl\fR(1), \fBeqn\fR(1) and \fBrefer\fR(1) preprocessors for equations,
99 tables, and references is acceptable as input.
100 .SH REQUESTS
101 .sp
102 .LP
103 Here is a table of macros.
104 .sp
106 .sp
107 .TS
108 c | c | c | c
109 l | l | l | l .
110 Macro Name Initial Value Break? Reset? Explanation
111 _
112 \fB\&.1C\fR on y,y one column format on a new page
113 _
114 \fB\&.2C\fR [ \fIl\fR ] - y,y two column format \fIl\fR=line length
115 _
116 \fB\&.AE\fR - y end abstract
117 _
118 \fB\&.AL\fR [ \fIt\fR ] [ \fIi\fR ] [ \fIs\fR ] \fIt\fR=\fB1\fR;\fIi\fR=\fB\&.Li\fR;\fIs\fR=\fB0\fR y T{
119 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
120 T}
121 _
122 \fB\&.AS\fR \fIm\fR [ \fIn\fR ] \fIn\fR=\fB0\fR y begin abstract
123 _
124 \fB\&.AU\fR - y author's name
125 _
126 \fB\&.AV\fR \fIx\fR - y signature and date line of verifier \fIx\fR
127 _
128 \fB\&.B\fR \fIx\fR - n embolden \fIx\fR; if no \fIx\fR, switch to boldface
129 _
130 \fB\&.BE\fR - y end block text
131 _
132 \fB\&.BI\fR \fIx\fR \fIy\fR - n embolden \fIx\fR and underline \fIy\fR
133 _
134 \fB\&.BL\fR - y bullet list
135 _
136 \fB\&.BR\fR \fIx\fR \fIy\fR - n embolden \fIx\fR and use Roman font for \fIy\fR
137 _
138 \fB\&.BS\fR - n start block text
139 _
140 \fB\&.CN\fR - y same as \fB\&.DE\fR (\fBnroff\fR)
141 _
142 \fB\&.CS\fR - y cover sheet
143 _
144 \fB\&.CW\fR - n same as \fB\&.DS I\fR (\fBnroff\fR)
145 _
146 \fB\&.DE\fR - y end display
147 _
148 \fB\&.DF\fR [ \fIp\fR ] [ \fIf\fR ] [ \fIrp\fR ] \fIp\fR=\fBL\fR;\fIf\fR=\fBN\fR y T{
149 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)
150 T}
151 _
152 \fB\&.DL\fR [ \fIi\fR ] [ \fIs\fR ] - y start dash list
153 _
154 \fB\&.DS\fR [ \fIp\fR ] [ \fIf\fR ] [ \fIrp\fR ] \fIp\fR=\fBL\fR;\fIf\fR=\fBN\fR y T{
155 begin static display (see \fB\&.DF\fR for argument descriptions)
156 T}
157 _
158 \fB\&.EC\fR \fIx\fR [ \fIn\fR ] \fIn\fR=\fB1\fR y equation title; equation \fIx\fR; number \fIn\fR
159 _
160 \fB\&.EF\fR \fIx\fR - n T{
161 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
162 T}
163 _
164 \fB\&.EH\fR \fIx\fR - n T{
165 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
166 T}
167 _
168 \fB\&.EN\fR - y end displayed equation produced by \fBeqn\fR
169 _
170 \fB\&.EQ\fR - y break out equation produced by \fBeqn\fR
171 _
172 \fB\&.EX\fR \fIx\fR [ \fIn\fR ] \fIn\fR=\fB1\fR y exhibit title; exhibit \fIx\fR
173 _
174 number \fIn\fR
175 _
176 \fB\&.FD\fR [ \fIf\fR ] [ \fIr\fR ] \fIf\fR=\fB10\fR;\fIr\fR=\fB1\fR n T{
177 set footnote style format \fIf\fR=[\fB0-11\fR]; renumber \fIr\fR=[\fB0\fR,\fB1\fR]
178 T}
179 _
180 \fB\&.FE\fR - y end footnote
181 _
182 \fB\&.FG\fR \fIx\fR [ \fIn\fR ] \fIn\fR=\fB1\fR y figure title; figure \fIx\fR; number \fIn\fR
183 _
184 \fB\&.FS\fR - n start footnote
185 _
186 \fB\&.H\fR \fIl\fR [ \fIt\fR ] - y T{
187 produce numbered heading level \fIl\fR=[\fB1-7\fR]; title \fIt\fR
188 T}
189 _
190 \fB\&.HU\fR \fIt\fR - y produce unnumbered heading; title \fIt\fR
191 _
192 \fB\&.I\fR \fIx\fR - n underline \fIx\fR
193 _
194 \fB\&.IB\fR \fIx\fR \fIy\fR - n underline \fIx\fR and embolden \fIy\fR
195 _
196 \fB\&.IR\fR \fIx\fR \fIy\fR - n underline \fIx\fR and use Roman font on \fIy\fR
197 _
198 \fB\&.LE\fR [ \fIs\fR ] \fIs\fR=\fB0\fR y end list; separation \fIs\fR
199 _
200 \fB\&.LI\fR [ \fIm\fR ] [ \fIp\fR ] - y start new list item; mark \fIm\fR
201 _
202 prefix \fIp\fR (mark only)
203 _
204 \fB\&.ML\fR \fIm\fR [ \fIi\fR ] [ \fIs\fR ] \fIs\fR=\fB0\fR y T{
205 start marked list; mark \fIm\fR indentation \fIi\fR; separation \fIs\fR=[\fB0\fR,\fB1\fR]
206 T}
207 _
208 \fB\&.MT\fR \fIx\fR y memo title; title \fIx\fR
209 _
210 \fB\&.ND\fR \fIx\fR n T{
211 no date in page footer; \fIx\fR is date on cover
212 T}
213 _
214 \fB\&.NE\fR - y end block text
215 _
216 \fB\&.NS\fR - y start block text
217 _
218 \fB\&.OF\fR \fIx\fR - n T{
219 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
220 T}
221 _
222 \fB\&.OF\fR \fIx\fR - n T{
223 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
224 T}
225 _
226 \fB\&.OP\fR - y skip to the top of an odd-number page
227 _
228 \fB\&.P\fR [ \fIt\fR ] \fIt\fR=\fB0\fR y,y T{
229 begin paragraph; \fIt\fR=[\fB0\fR,\fB1\fR] \fB0\fR=justified; \fB1\fR=indented
230 T}
231 _
232 \fB\&.PF\fR \fIx\fR - n T{
233 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
234 T}
235 _
236 \fB\&.PH\fR \fIx\fR - n T{
237 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
238 T}
239 _
240 \fB\&.R\fR on n return to Roman font
241 _
242 \fB\&.RB\fR \fIx\fR \fIy\fR - n use Roman on \fIx\fR and embolden \fIy\fR
243 _
244 \fB\&.RI\fR \fIx\fR \fIy\fR - n use Roman on \fIx\fR and underline \fIy\fR
245 _
246 \fB\&.RP\fR \fIx\fR - y,y T{
247 released paper format ? \fIx\fR=no stops title on first
248 T}
249 _
250 \fB\&.RS\fR 5n y,y T{
251 right shift: start level of relative indentation
252 T}
253 _
254 \fB\&.S\fR \fIm\fR \fIn\fR - n T{
255 set character point size & vertical space character point size \fIm\fR; vertical space \fIn\fR
256 T}
257 _
258 \fB\&.SA\fR \fIx\fR \fIx\fR=\fB1\fR n justification; \fIx\fR=[\fB0\fR,\fB1\fR]
259 _
260 \fB\&.SK\fR \fIx\fR - y skip \fIx\fR pages
261 _
262 \fB\&.SM\fR - n smaller; decrease point size by 2
263 _
264 \fB\&.SP\fR [ \fIx\fR ] - y leave \fIx\fR blank lines
265 _
266 \fB\&.TB\fR \fIx\fR [ \fIn\fR ] \fIn\fR=\fB1\fR y table title; table \fIx\fR; number \fIn\fR
267 _
268 \fB\&.TC\fR - y T{
269 print table of contents (put at end of input file)
270 T}
271 _
272 _
273 \fB\&.TH\fR - Y "multi-page end, header"
274 _
275 \fB\&.TL\fR - n title in boldface and two points larger
276 _
277 \fB\&.TM\fR - n UC Berkeley thesis mode
278 _
279 \fB\&.TP\fR \fIi\fR y y T{
280 \fIi\fR=p.i. Begin indented paragraph, with the tag given on the next text line. Set prevailing indent to \fIi\fR.
281 T}
282 _
283 \fB\&.TE\fR - y end of table processed by tbl
284 \fB\&.TS\fR \fIx\fR - y,y T{
285 begin table; if \fIx\fR=\fBH\fR table has multi-page header
286 T}
287 _
288 \fB\&.TY\fR - y display centered title \fBCONTENTS\fR
289 _
290 \fB\&.VL\fR \fIi\fR [ \fIm\fR ] [ \fIs\fR ] \fIm\fR=\fB0\fR;\fIs\fR=\fB0\fR y T{
291 start variable-item list; indentation \fIi\fR mark-indentation \fIm\fR; separation \fIs\fR
292 T}
293 .TE
295 .SH REGISTERS
296 .sp
297 .LP
298 Formatting distances can be controlled in \fB-mm\fR by means of built-in number
299 registers. For example, this sets the line length to 6.5 inches:
300 .sp
301 .in +2
302 .nf
303 \&.nr LL 6.5i
304 .fi
305 .in -2
307 .sp
308 .LP
309 Here is a table of number registers and their default values:
310 .sp
312 .sp
313 .TS
314 c | c | c | c
315 l | l | l | l .
316 Name Register Controls Takes Effect Default
317 _
318 \fBCl\fR contents level table of contents 2
319 _
320 \fBDe\fR display eject display 0
321 _
322 \fBDf\fR display floating display 5
323 _
324 \fBDs\fR display spacing display 1v
325 _
326 \fBHb\fR heading break heading 2
327 _
328 \fBHc\fR heading centering heading 0
329 _
330 \fBHi\fR heading indent heading 1
331 _
332 \fBHi\fR heading spacing heading 1
333 _
334 \fBHu\fR heading unnumbered heading 2
335 _
336 \fBLi\fR list indentation list \fB6 (\fR\fBnroff\fR\fB) 5 (\fR\fBtroff\fR\fB)\fR
337 _
338 \fBLs\fR list spacing list 6
339 _
340 \fBPi\fR paragraph indent paragraph 5
341 _
342 \fBPt\fR paragraph type paragraph 1
343 _
344 \fBSi\fR static indent display \fB5 (\fR\fBnroff\fR\fB) 3 (\fR\fBtroff\fR\fB)\fR
345 .TE
347 .sp
348 .LP
349 When resetting these values, make sure to specify the appropriate units.
350 Setting the line length to 7, for example, will result in output with one
351 character per line. Setting \fBPi\fR to 0 suppresses paragraph indentation
352 .sp
353 .LP
354 Here is a list of string registers available in \fB-mm\fR; they may be used
355 anywhere in the text:
356 .sp
358 .sp
359 .TS
360 c | c
361 l | l .
362 Name String's Function
363 _
364 \fB\e*Q\fR quote (\fB"\fR in \fBnroff,\fR\| \fB``\fR in \fBtroff\fR )
365 _
366 \fB\e*U\fR unquote (\fB"\fR in \fBnroff,\fR\| \fB\&''\fR in \fBtroff\fR )
367 _
368 \fB\e*-\fR dash (\fB--\fR in \fBnroff,\fR \(em in \fBtroff\fR )
369 _
370 \fB\e*(MO\fR month (month of the year)
371 _
372 \fB\e*(DY\fR day (current date)
373 _
374 \fB\e**\fR automatically numbered footnote
375 _
376 \fB\e*'\fR acute accent (before letter)
377 _
378 \fB\e*`\fR grave accent (before letter)
379 _
380 \fB\e*^\fR circumflex (before letter)
381 _
382 \fB\e*,\fR cedilla (before letter)
383 _
384 \fB\e*:\fR umlaut (before letter)
385 _
386 \fB\e*~\fR tilde (before letter)
387 _
388 \fB\e(BU\fR bullet item
389 _
390 \fB\e(DT\fR date (\fImonth day\fR, \fIyr\fR)
391 _
392 \fB\e(EM\fR em dash
393 _
394 \fB\e(Lf\fR \fBLIST OF FIGURES\fR title
395 _
396 \fB\e(Lt\fR \fBLIST OF TABLES\fR title
397 _
398 \fB\e(Lx\fR \fBLIST OF EXHIBITS\fR title
399 _
400 \fB\e(Le\fR \fBLIST OF EQUATIONS\fR title
401 _
402 \fB\e(Rp\fR \fBREFERENCES\fR title
403 _
404 \fB\e(Tm\fR trademark character (TM)
405 .TE
407 .sp
408 .LP
409 When using the extended accent mark definitions available with \fB\&.AM\fR,
410 these strings should come after, rather than before, the letter to be accented.
411 .SH FILES
412 .sp
413 .ne 2
414 .na
415 \fB\fB/usr/share/lib/tmac/m\fR\fR
416 .ad
417 .sp .6
418 .RS 4n
420 .RE
422 .sp
423 .ne 2
424 .na
425 \fB\fB/usr/share/lib/tmac/mm.[nt]\fR\fR
426 .ad
427 .sp .6
428 .RS 4n
429 \fBnroff\fR and \fBtroff\fR definitions of \fBmm\fR.
430 .RE
432 .SH SEE ALSO
433 .sp
434 .LP
435 \fBcol\fR(1), \fBeqn\fR(1), \fBnroff\fR(1), \fBrefer\fR(1), \fBtbl\fR(1),
436 \fBtroff\fR(1), \fBattributes\fR(5)
437 .SH BUGS
438 .sp
439 .LP
440 Floating keeps and regular keeps are diverted to the same space, so they cannot
441 be mixed together with predictable results.