4 058b0118 2005-01-03 devnull ms \- macros for formatting manuscripts
5 058b0118 2005-01-03 devnull .SH SYNOPSIS
6 058b0118 2005-01-03 devnull .B "nroff -ms"
8 058b0118 2005-01-03 devnull .I options
10 058b0118 2005-01-03 devnull .I file ...
12 058b0118 2005-01-03 devnull .B "troff -ms"
14 058b0118 2005-01-03 devnull .I options
16 058b0118 2005-01-03 devnull .I file ...
17 058b0118 2005-01-03 devnull .SH DESCRIPTION
18 058b0118 2005-01-03 devnull This package of
21 058b0118 2005-01-03 devnull .IR troff (1)
22 058b0118 2005-01-03 devnull macro definitions provides a canned formatting
23 058b0118 2005-01-03 devnull facility for tech%nical papers in various formats.
25 058b0118 2005-01-03 devnull The macro requests are defined below.
30 058b0118 2005-01-03 devnull requests are unsafe in conjunction with
31 058b0118 2005-01-03 devnull this package, but the following requests may be used with
32 058b0118 2005-01-03 devnull impunity after the first
33 058b0118 2005-01-03 devnull .BR .PP :
34 058b0118 2005-01-03 devnull .LR .bp ,
35 058b0118 2005-01-03 devnull .LR .br ,
36 058b0118 2005-01-03 devnull .LR .sp ,
37 058b0118 2005-01-03 devnull .LR .ls ,
38 058b0118 2005-01-03 devnull .LR .na .
40 058b0118 2005-01-03 devnull Output of the
41 058b0118 2005-01-03 devnull .IR eqn (1),
42 058b0118 2005-01-03 devnull .IR tbl (1),
43 058b0118 2005-01-03 devnull .IR pic (1)
45 058b0118 2005-01-03 devnull .IR grap (1)
46 058b0118 2005-01-03 devnull preprocessors
47 058b0118 2005-01-03 devnull for equations, tables, pictures, and graphs is acceptable as input.
48 058b0118 2005-01-03 devnull .SH FILES
49 c8b6342d 2005-01-13 devnull .B \*9/tmac/tmac.s
50 058b0118 2005-01-03 devnull .SH "SEE ALSO"
52 058b0118 2005-01-03 devnull M. E. Lesk,
53 058b0118 2005-01-03 devnull ``Typing Documents on the UNIX System: Using the \-ms Macros with Troff and Nroff'',
55 058b0118 2005-01-03 devnull Unix Research System Programmer's Manual,
56 058b0118 2005-01-03 devnull Tenth Edition, Volume 2.
58 058b0118 2005-01-03 devnull .IR eqn (1),
59 058b0118 2005-01-03 devnull .IR troff (1),
60 058b0118 2005-01-03 devnull .IR tbl (1),
61 058b0118 2005-01-03 devnull .IR pic (1)
62 058b0118 2005-01-03 devnull .SH REQUESTS
63 058b0118 2005-01-03 devnull .ta \w'..ND \fIdate\fR 'u +\w'Initial 'u +\w'Cause 'u
71 058b0118 2005-01-03 devnull Request Initial Cause Explanation
73 058b0118 2005-01-03 devnull Value Break
77 058b0118 2005-01-03 devnull \fL\&.1C\fP yes yes One column format on a new page.
79 058b0118 2005-01-03 devnull \fL\&.2C\fP no yes Two column format.
81 058b0118 2005-01-03 devnull \fL\&.AB\fP no yes Begin abstract.
83 058b0118 2005-01-03 devnull \fL\&.AE\fP - yes End abstract.
85 058b0118 2005-01-03 devnull \fL\&.AI\fP no yes Author's institution follows.
86 058b0118 2005-01-03 devnull Suppressed in
87 058b0118 2005-01-03 devnull .BR .TM .
89 058b0118 2005-01-03 devnull \fL\&.AT\fP no yes Print `Attached' and turn off line filling.
91 058b0118 2005-01-03 devnull \fL\&.AU\fP\fP\fP \fIx y\fR no yes Author's name follows.
92 058b0118 2005-01-03 devnull .IR x " is location and " y " is"
93 058b0118 2005-01-03 devnull extension, ignored except in
96 058b0118 2005-01-03 devnull \fL\&.B\fP \fIx y\fR no no Print
98 058b0118 2005-01-03 devnull in boldface, append
100 058b0118 2005-01-03 devnull if no argument switch to boldface.
102 058b0118 2005-01-03 devnull \fL\&.B1\fP no yes Begin text to be enclosed in a box.
104 058b0118 2005-01-03 devnull \fL\&.B2\fP no yes End boxed text.
106 058b0118 2005-01-03 devnull \fL\&.BI\fP \fIx y\fR no no Print
108 058b0118 2005-01-03 devnull in bold italic and append
110 058b0118 2005-01-03 devnull if no argument switch to bold italic.
112 058b0118 2005-01-03 devnull \fL\&.BT\fP date no Bottom title, automatically invoked at
113 058b0118 2005-01-03 devnull foot of page.
114 058b0118 2005-01-03 devnull May be redefined.
116 058b0118 2005-01-03 devnull \fL\&.BX\fP \fIx\fR no no Print
118 058b0118 2005-01-03 devnull in a box.
120 058b0118 2005-01-03 devnull \fL\&.CW\fP \fIx y\fR no no Constant width font for
124 058b0118 2005-01-03 devnull if no argument switch to constant width.
126 058b0118 2005-01-03 devnull \fL\&.CT\fP no yes Print `Copies to' and turn off line filling.
128 058b0118 2005-01-03 devnull \fL\&.DA\fP \fIx\fR nroff no `Date line' at bottom of page
131 058b0118 2005-01-03 devnull Default is today.
133 058b0118 2005-01-03 devnull \fL\&.DE\fP - yes End displayed text.
135 058b0118 2005-01-03 devnull .BR .KE .
137 058b0118 2005-01-03 devnull \fL\&.DS\fP \fIx\fR no yes Start of displayed text,
138 058b0118 2005-01-03 devnull to appear verbatim line-by-line:
140 058b0118 2005-01-03 devnull indented (default),
142 058b0118 2005-01-03 devnull left-justified,
144 058b0118 2005-01-03 devnull centered,
146 058b0118 2005-01-03 devnull (block) centered with straight left margin.
148 058b0118 2005-01-03 devnull .BR .KS .
150 058b0118 2005-01-03 devnull \fL\&.EG\fP no - Print document in BTL format for `Engineer's Notes.' Must be first.
152 058b0118 2005-01-03 devnull \fL\&.EN\fP - yes Space after equation
153 058b0118 2005-01-03 devnull produced by
156 058b0118 2005-01-03 devnull .IR eqn (1).
158 058b0118 2005-01-03 devnull \fL\&.EQ\fP \fIx y\fR - yes Display equation.
159 058b0118 2005-01-03 devnull Equation number is
161 058b0118 2005-01-03 devnull Optional
164 058b0118 2005-01-03 devnull .BR I ", " L ", " C
166 058b0118 2005-01-03 devnull .BR .DS .
168 058b0118 2005-01-03 devnull \fL\&.FE\fP - yes End footnote.
170 058b0118 2005-01-03 devnull \fL\&.FP\fP \fIx\fR - no Set font positions for a family, e.g.,
171 058b0118 2005-01-03 devnull .L .FP lucidasans
173 058b0118 2005-01-03 devnull \fL\&.FS\fP no no Start footnote.
174 058b0118 2005-01-03 devnull The note will be moved to the bottom of the page.
176 058b0118 2005-01-03 devnull \fL\&.HO\fP - no `Bell Laboratories, Holmdel,
177 058b0118 2005-01-03 devnull New Jersey 07733'.
179 058b0118 2005-01-03 devnull \fL\&.I\fP \fIx y\fR no no Italicize
183 058b0118 2005-01-03 devnull if no argument switch to italic.
185 058b0118 2005-01-03 devnull \fL\&.IH\fP no no `Bell Laboratories, Naperville, Illinois 60540'
187 058b0118 2005-01-03 devnull \fL\&.IM\fP no no Print document in BTL format for an internal memorandum. Must be first.
189 058b0118 2005-01-03 devnull \fL\&.IP\fP \fIx y\fR no yes Start indented paragraph,
190 058b0118 2005-01-03 devnull with hanging tag
192 058b0118 2005-01-03 devnull Indentation is
194 058b0118 2005-01-03 devnull ens (default 5).
196 058b0118 2005-01-03 devnull \fL\&.KE\fP - yes End keep.
197 058b0118 2005-01-03 devnull Put kept text on next page if not enough room.
199 058b0118 2005-01-03 devnull \fL\&.KF\fP no yes Start floating keep.
200 058b0118 2005-01-03 devnull If the kept text must be moved to the next page,
201 058b0118 2005-01-03 devnull float later text back to this page.
203 058b0118 2005-01-03 devnull \fL\&.KS\fP no yes Start keeping following text.
205 058b0118 2005-01-03 devnull \fL\&.LG\fP no no Make letters larger.
207 058b0118 2005-01-03 devnull \fL\&.LP\fP yes yes Start left-blocked paragraph.
209 058b0118 2005-01-03 devnull \fL\&.LT\fP no yes Start a letter; a non-empty first argument
210 058b0118 2005-01-03 devnull produces a full Lucent letterhead, a second argument is a room number,
211 058b0118 2005-01-03 devnull a third argument is a telephone number.
213 058b0118 2005-01-03 devnull \fL\&.MF\fP - - Print document in BTL format for `Memorandum for File.' Must be first.
215 058b0118 2005-01-03 devnull \fL\&.MH\fP - no `Bell Laboratories, Murray Hill,
216 058b0118 2005-01-03 devnull New Jersey 07974'.
218 058b0118 2005-01-03 devnull \fL\&.MR\fP - - Print document in BTL format for `Memorandum for Record.' Must be first.
220 058b0118 2005-01-03 devnull \fL\&.ND\fP \fIdate\fR troff no Use date supplied (if any) only in
221 058b0118 2005-01-03 devnull special BTL format positions; omit from page footer.
223 058b0118 2005-01-03 devnull \fL\&.NH\fP \fIn\fR - yes Same as
224 058b0118 2005-01-03 devnull .BR .SH ,
225 058b0118 2005-01-03 devnull with automatic section
226 058b0118 2005-01-03 devnull numbers like `1.2.3';
228 058b0118 2005-01-03 devnull is subsection level (default 1).
230 058b0118 2005-01-03 devnull \fL\&.NL\fP yes no Make letters normal size.
232 058b0118 2005-01-03 devnull \fL\&.P1\fP - yes Begin program display in constant width font.
234 058b0118 2005-01-03 devnull \fL\&.P2\fP - yes End program display.
236 058b0118 2005-01-03 devnull \fL\&.PE\fP - yes End picture; see
237 058b0118 2005-01-03 devnull .IR pic (1).
239 058b0118 2005-01-03 devnull \fL\&.PF\fP - yes End picture; restore vertical
240 058b0118 2005-01-03 devnull position.
242 058b0118 2005-01-03 devnull \fL\&.PP\fP no yes Begin paragraph.
243 058b0118 2005-01-03 devnull First line indented.
245 058b0118 2005-01-03 devnull \fL\&.PS\fP \fIh w\fR - yes Start picture; height
246 058b0118 2005-01-03 devnull and width in inches.
248 058b0118 2005-01-03 devnull \fL\&.PY\fP - no `Bell Laboratories, Piscataway, New Jersey 08854'
250 058b0118 2005-01-03 devnull \fL\&.QE\fP - yes End quoted material.
252 058b0118 2005-01-03 devnull \fL\&.QP\fP - yes Begin quoted paragraph (indent both margins).
254 058b0118 2005-01-03 devnull \fL\&.QS\fP - yes Begin quoted material (indent both margins).
256 058b0118 2005-01-03 devnull \fL\&.R\fP yes no Roman text follows.
258 058b0118 2005-01-03 devnull \fL\&.RE\fP - yes End relative indent level.
260 058b0118 2005-01-03 devnull \fL\&.RP\fP no - Cover sheet and first page for released
262 058b0118 2005-01-03 devnull Must precede other requests.
264 058b0118 2005-01-03 devnull \fL\&.RS\fP - yes Start level of relative indentation
265 058b0118 2005-01-03 devnull from which subsequent indentation is measured.
267 058b0118 2005-01-03 devnull \fL\&.SG\fP \fIx\fR no yes Insert signature(s) of author(s),
268 058b0118 2005-01-03 devnull ignored except in
271 058b0118 2005-01-03 devnull .BR .LT .
272 058b0118 2005-01-03 devnull .IR x " is the reference line (initials of author and typist)."
274 058b0118 2005-01-03 devnull \fL\&.SH\fP - yes Section head follows,
275 058b0118 2005-01-03 devnull font automatically bold.
277 058b0118 2005-01-03 devnull \fL\&.SM\fP no no Make letters smaller.
279 058b0118 2005-01-03 devnull \fL\&.TA\fP\ \fIx\fR... 5... no Set tabs in ens.
280 058b0118 2005-01-03 devnull Default is 5 10 15 ...
282 058b0118 2005-01-03 devnull \fL\&.TE\fP - yes End table; see
283 058b0118 2005-01-03 devnull .IR tbl (1).
285 058b0118 2005-01-03 devnull \fL\&.TH\fP - yes End heading section of table.
287 058b0118 2005-01-03 devnull \fL\&.TL\fP no yes Title follows.
289 058b0118 2005-01-03 devnull \fL\&.TM\fP\ \fIx\fR... no - Print document in BTL technical memorandum format.
290 058b0118 2005-01-03 devnull Arguments are TM number, (quoted list of) case number(s), and file number.
291 058b0118 2005-01-03 devnull Must precede other requests.
293 058b0118 2005-01-03 devnull \fL\&.TR\fP \fIx\fR - - Print in BTL technical report format; report number is \fIx\fR. Must be first.
295 058b0118 2005-01-03 devnull \fL\&.TS\fP \fIx\fR - yes Begin table; if
299 058b0118 2005-01-03 devnull table heading is repeated on new pages.
301 058b0118 2005-01-03 devnull \fL\&.UL\fP \fIx\fR - no Underline argument (even in troff).
303 058b0118 2005-01-03 devnull \fL\&.UX\fP\ \fIy z\fP - no `\fIz\fRUNIX\fIy\fP';
304 058b0118 2005-01-03 devnull first use gives registered trademark notice.
306 058b0118 2005-01-03 devnull \fL\&.WH\fP - no `Bell Laboratories, Whippany,
307 058b0118 2005-01-03 devnull New Jersey 07981'.