1ms(5) Standards, Environments, and Macros ms(5)
2
6 ms - text formatting macros
7
9 nroff -ms [options] filename...
10 troff -ms [options] filename...
13
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 -ms macros are defined below.
21 Note: this -ms macro package is an extended version written at Berke‐
24 ley and is a superset of the standard -ms macro packages as supplied
25 by 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 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 .bp begin new page
36 .br break output line
39 .sp n insert n spacing lines
42 .ce n center next n lines
45 .ls n line spacing: n=1 single, n=2 double space
48 .na no alignment of right margin
51 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
60 Macro Name │ Initial Value │ Break? Reset? │ Explanation
61 ───────────┼───────────────┼───────────────┼──────────────────────────────────────────
62 .AB x │ - │ y │ begin abstract; if x=no do not label
63 │ │ │ abstract
64 ───────────┴───────────────┴───────────────┴──────────────────────────────────────────
65 .AE │ - │ y │ end abstract
68 ───────────┼───────────────┼───────────────┼──────────────────────────────────────────
69 .AI │ - │ y │ author's institution
70 ───────────┼───────────────┼───────────────┼──────────────────────────────────────────
71 .AM │ - │ n │ better accent mark definitions
72 ───────────┼───────────────┼───────────────┼──────────────────────────────────────────
73 .AU │ - │ y │ author's name
74 ───────────┼───────────────┼───────────────┼──────────────────────────────────────────
75 .B x │ - │ n │ embolden x; if no x, switch to boldface
76 ───────────┼───────────────┼───────────────┼──────────────────────────────────────────
77 .B1 │ - │ y │ begin text to be enclosed in a box
78 ───────────┼───────────────┼───────────────┼──────────────────────────────────────────
79 .B2 │ - │ y │ end boxed text and print it
80 ───────────┼───────────────┼───────────────┼──────────────────────────────────────────
81 .BT │ date │ n │ bottom title, printed at foot of page
82 ───────────┼───────────────┼───────────────┼──────────────────────────────────────────
83 .BX x │ - │ n │ print word x in a box
84 ───────────┼───────────────┼───────────────┼──────────────────────────────────────────
85 .CM │ if t │ n │ cut mark between pages
86 ───────────┼───────────────┼───────────────┼──────────────────────────────────────────
87 .CT │ - │ y,y │ chapter title: page number moved to CF
88 │ │ │ (TM only)
89 ───────────┼───────────────┼───────────────┼──────────────────────────────────────────
90 .DA x │ if n │ n │ force date x at bottom of page; today if
91 │ │ │ no x
92 ───────────┼───────────────┼───────────────┼──────────────────────────────────────────
93 .DE │ - │ y │ end display (unfilled text) of any kind
94 ───────────┼───────────────┼───────────────┼──────────────────────────────────────────
95 .DS x y │ I │ y │ begin display with keep; x=I,L,C,B;
96 │ │ │ y=indent
97 ───────────┼───────────────┼───────────────┼──────────────────────────────────────────
98 .ID y │ 8n,.5i │ y │ indented display with no keep; y=indent
99 ───────────┼───────────────┼───────────────┼──────────────────────────────────────────
100 .LD │ - │ y │ left display with no keep
101 ───────────┼───────────────┼───────────────┼──────────────────────────────────────────
102 .CD │ - │ y │ centered display with no keep
103 ───────────┼───────────────┼───────────────┼──────────────────────────────────────────
104 .BD │ - │ y │ block display; center entire block
105 ───────────┼───────────────┼───────────────┼──────────────────────────────────────────
106 .EF x │ - │ n │ even page footer x (3 part as for .tl)
107 ───────────┼───────────────┼───────────────┼──────────────────────────────────────────
108 .EH x │ - │ n │ even page header x (3 part as for .tl)
109 ───────────┼───────────────┼───────────────┼──────────────────────────────────────────
110 .EN │ - │ y │ end displayed equation produced by eqn
111 ───────────┼───────────────┼───────────────┼──────────────────────────────────────────
112 .EQ x y │ - │ y │ break out equation; x=L,I,C; y=equation
113 │ │ │ number
114 ───────────┼───────────────┼───────────────┼──────────────────────────────────────────
115 .FE │ - │ n │ end footnote to be placed at bottom of
116 │ │ │ page
117 ───────────┼───────────────┼───────────────┼──────────────────────────────────────────
118 .FP │ - │ n │ numbered footnote paragraph; may be
119 │ │ │ redefined
120 ───────────┼───────────────┼───────────────┼──────────────────────────────────────────
121 .FS x │ - │ n │ start footnote; x is optional footnote
122 │ │ │ label
123 ───────────┼───────────────┼───────────────┼──────────────────────────────────────────
124 .HD │ undef │ n │ optional page header below header margin
125 ───────────┼───────────────┼───────────────┼──────────────────────────────────────────
126 .I x │ - │ n │ italicize x; if no x, switch to italics
127 ───────────┼───────────────┼───────────────┼──────────────────────────────────────────
128 .IP x y │ - │ y,y │ indented paragraph, with hanging tag x;
129 │ │ │ y=indent
130 ───────────┴───────────────┴───────────────┴──────────────────────────────────────────
131 .IX x y │ - │ y │ index words x y and so on (up to 5 lev‐
134 │ │ │ els)
135 ───────────┼───────────────┼───────────────┼──────────────────────────────────────────
136 .KE │ - │ n │ end keep of any kind
137 ───────────┼───────────────┼───────────────┼──────────────────────────────────────────
138 .KF │ - │ n │ begin floating keep; text fills remain‐
139 │ │ │ der of page
140 ───────────┼───────────────┼───────────────┼──────────────────────────────────────────
141 .KS │ - │ y │ begin keep; unit kept together on a sin‐
142 │ │ │ gle page
143 ───────────┼───────────────┼───────────────┼──────────────────────────────────────────
144 .LG │ - │ n │ larger; increase point size by 2
145 ───────────┼───────────────┼───────────────┼──────────────────────────────────────────
146 .LP │ - │ y,y │ left (block) paragraph.
147 ───────────┼───────────────┼───────────────┼──────────────────────────────────────────
148 .MC x │ - │ y,y │ multiple columns; x=column width
149 ───────────┼───────────────┼───────────────┼──────────────────────────────────────────
150 .ND x │ if t │ n │ no date in page footer; x is date on
151 │ │ │ cover
152 ───────────┼───────────────┼───────────────┼──────────────────────────────────────────
153 .NH x y │ - │ y,y │ numbered header; x=level, x=0 resets,
154 │ │ │ x=S sets to y
155 ───────────┼───────────────┼───────────────┼──────────────────────────────────────────
156 .NL │ 10p │ n │ set point size back to normal
157 ───────────┼───────────────┼───────────────┼──────────────────────────────────────────
158 .OF x │ - │ n │ odd page footer x (3 part as for .tl)
159 ───────────┼───────────────┼───────────────┼──────────────────────────────────────────
160 .OH x │ - │ n │ odd page header x (3 part as for .tl)
161 ───────────┼───────────────┼───────────────┼──────────────────────────────────────────
162 .P1 │ if TM │ n │ print header on first page
163 ───────────┼───────────────┼───────────────┼──────────────────────────────────────────
164 .PP │ - │ y,y │ paragraph with first line indented
165 ───────────┼───────────────┼───────────────┼──────────────────────────────────────────
166 .PT │ - % - │ n │ page title, printed at head of page
167 ───────────┼───────────────┼───────────────┼──────────────────────────────────────────
168 .PX x │ - │ y │ print index (table of contents); x=no
169 │ │ │ suppresses title
170 ───────────┼───────────────┼───────────────┼──────────────────────────────────────────
171 .QP │ - │ y,y │ quote paragraph (indented and shorter)
172 ───────────┼───────────────┼───────────────┼──────────────────────────────────────────
173 .R │ on │ n │ return to Roman font
174 ───────────┼───────────────┼───────────────┼──────────────────────────────────────────
175 .RE │ 5n │ y,y │ retreat: end level of relative indenta‐
176 │ │ │ tion
177 ───────────┼───────────────┼───────────────┼──────────────────────────────────────────
178 .RP x │ - │ n │ released paper format; x=no stops title
179 │ │ │ on first page
180 ───────────┼───────────────┼───────────────┼──────────────────────────────────────────
181 .RS │ 5n │ y,y │ right shift: start level of relative
182 │ │ │ indentation
183 ───────────┼───────────────┼───────────────┼──────────────────────────────────────────
184 .SH │ - │ y,y │ section header, in boldface
185 ───────────┼───────────────┼───────────────┼──────────────────────────────────────────
186 .SM │ - │ n │ smaller; decrease point size by 2
187 ───────────┼───────────────┼───────────────┼──────────────────────────────────────────
188 .TA │ 8n,5n │ n │ set TAB characters to 8n 16n ... (nroff)
189 │ │ │ or 5n 10n ... (troff)
190 ───────────┼───────────────┼───────────────┼──────────────────────────────────────────
191 .TC x │ - │ y │ print table of contents at end; x=no
192 │ │ │ suppresses title
193 ───────────┼───────────────┼───────────────┼──────────────────────────────────────────
194 .TE │ - │ y │ end of table processed by tbl
195 ───────────┼───────────────┼───────────────┼──────────────────────────────────────────
196 .TH │ - │ y │ end multi-page header of table
197 ───────────┴───────────────┴───────────────┴──────────────────────────────────────────
198 .TL │ - │ y │ title in boldface and two points larger
200 ───────────┼───────────────┼───────────────┼──────────────────────────────────────────
201 .TM │ off │ n │ UC Berkeley thesis mode
202 ───────────┼───────────────┼───────────────┼──────────────────────────────────────────
203 .TS x │ - │ y,y │ begin table; if x=H table has multi-page
204 │ │ │ header
205 ───────────┼───────────────┼───────────────┼──────────────────────────────────────────
206 .UL x │ - │ n │ underline x, even in troff
207 ───────────┼───────────────┼───────────────┼──────────────────────────────────────────
208 .UX x │ - │ n │ UNIX; trademark message first time; x
209 │ │ │ appended
210 ───────────┼───────────────┼───────────────┼──────────────────────────────────────────
211 .XA x y │ - │ y │ another index entry; x=page or no for
212 │ │ │ none; y=indent
213 ───────────┼───────────────┼───────────────┼──────────────────────────────────────────
214 .XE │ - │ y │ end index entry (or series of .IX
215 │ │ │ entries)
216 ───────────┼───────────────┼───────────────┼──────────────────────────────────────────
217 .XP │ - │ y,y │ paragraph with first line indented, oth‐
218 │ │ │ ers indented
219 ───────────┼───────────────┼───────────────┼──────────────────────────────────────────
220 .XS x y │ - │ y │ begin index entry; x=page or no for
221 │ │ │ none; y=indent
222 ───────────┼───────────────┼───────────────┼──────────────────────────────────────────
223 .1C │ on │ y,y │ one column format, on a new page
224 ───────────┼───────────────┼───────────────┼──────────────────────────────────────────
225 .2C │ - │ y,y │ begin two column format
226 ───────────┼───────────────┼───────────────┼──────────────────────────────────────────
227 .]- │ - │ n │ beginning of refer reference
228 ───────────┼───────────────┼───────────────┼──────────────────────────────────────────
229 .[0 │ - │ n │ end of unclassifiable type of reference
230 ───────────┼───────────────┼───────────────┼──────────────────────────────────────────
231 .[N │ - │ n │ N= 1:journal-article, 2:book, 3:book-
232 │ │ │ article, 4:report
233
236 Formatting distances can be controlled in -ms by means of built-in num‐
237 ber registers. For example, this sets the line length to 6.5 inches:
238 .nr LL 6.5i
240 Here is a table of number registers and their default values:
244 │ │ │
248 Name │ Register Controls │ Takes Effect │ Default
249 ─────────┼────────────────────┼──────────────────┼───────────────────────
250 PS │ point size │ paragraph │ 10
251 ─────────┼────────────────────┼──────────────────┼───────────────────────
252 VS │ vertical spacing │ paragraph │ 12
253 ─────────┼────────────────────┼──────────────────┼───────────────────────
254 LL │ line length │ paragraph │ 6i
255 ─────────┼────────────────────┼──────────────────┼───────────────────────
256 LT │ title length │ next page │ same as LL
257 ─────────┼────────────────────┼──────────────────┼───────────────────────
258 FL │ footnote length │ next .FS │ 5.5i
259 ─────────┼────────────────────┼──────────────────┼───────────────────────
260 PD │ paragraph distance │ paragraph │ 1v (if n), .3v (if t)
261 ─────────┼────────────────────┼──────────────────┼───────────────────────
262 DD │ display distance │ displays │ 1v (if n), .5v (if t)
263 ─────────┴────────────────────┴──────────────────┴───────────────────────
264 PI │ paragraph indent │ paragraph │ 5n
266 ─────────┼────────────────────┼──────────────────┼───────────────────────
267 QI │ quote indent │ next .QP │ 5n
268 ─────────┼────────────────────┼──────────────────┼───────────────────────
269 FI │ footnote indent │ next .FS │ 2n
270 ─────────┼────────────────────┼──────────────────┼───────────────────────
271 PO │ page offset │ next page │ 0 (if n), ∼1i (if t)
272 ─────────┼────────────────────┼──────────────────┼───────────────────────
273 HM │ header margin │ next page │ 1i
274 ─────────┼────────────────────┼──────────────────┼───────────────────────
275 FM │ footer margin │ next page │ 1i
276 ─────────┼────────────────────┼──────────────────┼───────────────────────
277 FF │ footnote format │ next .FS │ 0 (1, 2, 3 available)
278 When resetting these values, make sure to specify the appropriate
282 units. Setting the line length to 7, for example, will result in output
283 with one character per line. Setting FF to 1 suppresses footnote super‐
284 scripting; setting it to 2 also suppresses indentation of the first
285 line; and setting it to 3 produces an .IP-like footnote paragraph.
286 Here is a list of string registers available in -ms; they may be used
289 anywhere in the text:
290 │
294 Name │ String's Function
295 ───────────────┼───────────────────────────────────────────
296 \*Q │ quote (" in nroff, " in troff )
297 ───────────────┼───────────────────────────────────────────
298 \*U │ unquote (" in nroff, " in troff )
299 ───────────────┼───────────────────────────────────────────
300 \*- │ dash (-- in nroff, — in troff )
301 ───────────────┼───────────────────────────────────────────
302 \*(MO │ month (month of the year)
303 ───────────────┼───────────────────────────────────────────
304 \*(DY │ day (current date)
305 ───────────────┼───────────────────────────────────────────
306 \** │ automatically numbered footnote
307 ───────────────┼───────────────────────────────────────────
308 \*' │ acute accent (before letter)
309 ───────────────┼───────────────────────────────────────────
310 \*` │ grave accent (before letter)
311 ───────────────┼───────────────────────────────────────────
312 \*^ │ circumflex (before letter)
313 ───────────────┼───────────────────────────────────────────
314 \*, │ cedilla (before letter)
315 ───────────────┼───────────────────────────────────────────
316 \*: │ umlaut (before letter)
317 ───────────────┼───────────────────────────────────────────
318 \*~ │ tilde (before letter)
319 When using the extended accent mark definitions available with .AM,
323 these strings should come after, rather than before, the letter to be
324 accented.
325
327 /usr/share/lib/tmac/s
328 /usr/share/lib/tmac/ms.???
331
334 col(1), eqn(1), nroff(1), refer(1), tbl(1), troff(1)
335
337 Floating keeps and regular keeps are diverted to the same space, so
338 they cannot be mixed together with predictable results.
339SunOS 5.11 25 Feb 1992 ms(5)