Sync our ieee80211*.9 manual pages with the recent upgrade.
[dragonfly.git] / share / me / orig_me.7
1 .\" Copyright (c) 1980, 1993
2 .\"     The Regents of the University of California.  All rights reserved.
3 .\"
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
6 .\" are met:
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\"    notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\"    notice, this list of conditions and the following disclaimer in the
11 .\"    documentation and/or other materials provided with the distribution.
12 .\" 3. All advertising materials mentioning features or use of this software
13 .\"    must display the following acknowledgement:
14 .\"     This product includes software developed by the University of
15 .\"     California, Berkeley and its contributors.
16 .\" 4. Neither the name of the University nor the names of its contributors
17 .\"    may be used to endorse or promote products derived from this software
18 .\"    without specific prior written permission.
19 .\"
20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 .\" SUCH DAMAGE.
31 .\"
32 .\"     @(#)me.7        8.1 (Berkeley) 6/5/93
33 .\" $FreeBSD: src/share/me/orig_me.7,v 1.6.2.1 2002/08/08 08:47:58 ru Exp $
34 .\" $DragonFly: src/share/me/orig_me.7,v 1.2 2003/06/17 04:37:01 dillon Exp $
35 .\"
36 .hc %
37 .TH ORIG_ME 7 "June 5, 1993"
38 .UC 3
39 .SH NAME
40 orig_me \- macros for formatting papers
41 .SH SYNOPSIS
42 .B "nroff \-orig_me"
43 [ options ]
44 file ...
45 .br
46 .B "troff \-orig_me"
47 [ options ]
48 file ...
49 .SH DESCRIPTION
50 This package of
51 .I nroff
52 and
53 .I troff
54 macro definitions provides a canned formatting
55 facility for tech%nical papers in various formats.
56 When producing 2-column output on a terminal, filter
57 the output through
58 .IR  col (1).
59 .PP
60 The macro requests are defined below.
61 Many
62 .I nroff
63 and
64 .I troff
65 requests are unsafe in conjunction with
66 this package, however, these requests may be used with
67 impunity after the first .pp:
68 .nf
69 .IP
70 .ta \w'.sz +n  'u
71 \&.bp   begin new page
72 \&.br   break output line here
73 \&.sp n insert n spacing lines
74 \&.ls n (line spacing) n=1 single, n=2 double space
75 \&.na   no alignment of right margin
76 \&.ce n center next n lines
77 \&.ul n underline next n lines
78 \&.sz +n        add n to point size
79 .fi
80 .PP
81 Output of the
82 .I eqn,
83 .I neqn,
84 .I refer,
85 and
86 .IR  tbl (1)
87 preprocessors
88 for equations and tables is acceptable as input.
89 .SH FILES
90 /usr/share/tmac/tmac.e
91 .br
92 /usr/share/me/*
93 .SH "SEE ALSO"
94 eqn(1), troff(1), refer(1), tbl(1)
95 .br
96 \-me Reference Manual, Eric P. Allman
97 .br
98 Writing Papers with Nroff Using \-me
99 .tr &.
100 .SH REQUESTS
101 In the following list,
102 \*(lqinitialization\*(rq
103 refers to the first .pp, .lp, .ip, .np, .sh, or .uh macro.
104 This list is incomplete;
105 see
106 .I "The \-me Reference Manual"
107 for interesting details.
108 .PP
109 .ta \w'.eh \'x\'y\'z\'  'u +\w'Initial 'u +\w'Cause 'u
110 .br
111 .di x
112                         \ka
113 .br
114 .di
115 .in \nau
116 .ti 0
117 Request Initial Cause   Explanation
118 .ti 0
119         Value   Break
120 .br
121 .in \nau
122 .ti 0
123 \&.(c   -       yes     Begin centered block
124 .ti 0
125 \&.(d   -       no      Begin delayed text
126 .ti 0
127 \&.(f   -       no      Begin footnote
128 .ti 0
129 \&.(l   -       yes     Begin list
130 .ti 0
131 \&.(q   -       yes     Begin major quote
132 .ti 0
133 \&.(x \fIx\fR   -       no      Begin indexed item in index
134 .I x
135 .ti 0
136 \&.(z   -       no      Begin floating keep
137 .ti 0
138 \&.)c   -       yes     End centered block
139 .ti 0
140 \&.)d   -       yes     End delayed text
141 .ti 0
142 \&.)f   -       yes     End footnote
143 .ti 0
144 \&.)l   -       yes     End list
145 .ti 0
146 \&.)q   -       yes     End major quote
147 .ti 0
148 \&.)x   -       yes     End index item
149 .ti 0
150 \&.)z   -       yes     End floating keep
151 .ti 0
152 \&.++ \fIm H\fR -       no      Define paper section.
153 .I m
154 defines the part of the paper, and can be
155 .B C
156 (chapter),
157 .B A
158 (appendix),
159 .B P
160 (preliminary, e.g., abstract, table of contents, etc.),
161 .B B
162 (bibliography),
163 .B RC
164 (chapters renumbered from page one each chapter),
165 or
166 .B RA
167 (appendix renumbered from page one).
168 .ti 0
169 \&.+c \fIT\fR   -       yes     Begin chapter (or appendix, etc., as
170 set by .++).
171 .I T
172 is the chapter title.
173 .ti 0
174 \&.1c   1       yes     One column format on a new page.
175 .ti 0
176 \&.2c   1       yes     Two column format.
177 .ti 0
178 \&.EN   -       yes     Space after equation
179 produced by
180 .I eqn
181 or
182 .IR neqn .
183 .ti 0
184 \&.EQ \fIx y\fR -       yes     Precede equation; break out and
185 add space.
186 Equation number is
187 .IR y .
188 The optional argument \fIx\fR
189 may be
190 .I I
191 to indent equation (default),
192 .I L
193 to left-adjust the equation, or
194 .I C
195 to center the equation.
196 .ti 0
197 \&.GE   -       yes     End \fIgremlin\fP picture.
198 .ti 0
199 \&.GS   -       yes     Begin \fIgremlin\fP picture.
200 .ti 0
201 \&.PE   -       yes     End \fIpic\fP picture.
202 .ti 0
203 \&.PS   -       yes     Begin \fIpic\fP picture.
204 .ti 0
205 \&.TE   -       yes     End table.
206 .ti 0
207 \&.TH   -       yes     End heading section of table.
208 .ti 0
209 \&.TS \fIx\fR   -       yes     Begin table; if \fIx\fR is
210 .I H
211 table has repeated heading.
212 .ti 0
213 \&.ac \fIA N\fR -       no      Set up for ACM style output.
214 .I A
215 is the Author's name(s),
216 .I N
217 is the total number of pages.
218 Must be given before the first initialization.
219 .ti 0
220 \&.b \fIx\fR    no      no      Print
221 .I x
222 in boldface; if no argument switch to boldface.
223 .ti 0
224 \&.ba \fI+n\fR  0       yes     Augments the base indent by
225 .I n.
226 This indent is used to set the indent on regular text
227 (like paragraphs).
228 .ti 0
229 \&.bc   no      yes     Begin new column
230 .ti 0
231 \&.bi \fIx\fR   no      no      Print
232 .I x
233 in bold italics (nofill only)
234 .ti 0
235 \&.bu   -       yes     Begin bulleted paragraph
236 .ti 0
237 \&.bx \fIx\fR   no      no      Print \fIx\fR in a box (nofill only).
238 .ti 0
239 \&.ef \fI\'x\'y\'z\'\fR \'\'\'\'        no      Set even footer to x  y  z
240 .ti 0
241 \&.eh \fI\'x\'y\'z\'\fR \'\'\'\'        no      Set even header to x  y  z
242 .ti 0
243 \&.fo \fI\'x\'y\'z\'\fR \'\'\'\'        no      Set footer to x  y  z
244 .ti 0
245 \&.hx   -       no      Suppress headers and footers on next page.
246 .ti 0
247 \&.he \fI\'x\'y\'z\'\fR \'\'\'\'        no      Set header to x  y  z
248 .ti 0
249 \&.hl   -       yes     Draw a horizontal line
250 .ti 0
251 \&.i \fIx\fR    no      no      Italicize
252 .I x;
253 if
254 .I x
255 missing, italic text follows.
256 .ti 0
257 \&.ip \fIx y\fR no      yes     Start indented paragraph,
258 with hanging tag
259 .IR x .
260 Indentation is
261 .I y
262 ens (default 5).
263 .ti 0
264 \&.lp   yes     yes     Start left-blocked paragraph.
265 .ti 0
266 \&.lo   -       no      Read in a file of local macros of the
267 form
268 .BI \&.* x.
269 Must be given before initialization.
270 .ti 0
271 \&.np   1       yes     Start numbered paragraph.
272 .ti 0
273 \&.of \fI\'x\'y\'z\'\fR \'\'\'\'        no      Set odd footer to x  y  z
274 .ti 0
275 \&.oh \fI\'x\'y\'z\'\fR \'\'\'\'        no      Set odd header to x  y  z
276 .ti 0
277 \&.pd   -       yes     Print delayed text.
278 .ti 0
279 \&.pp   no      yes     Begin paragraph.
280 First line indented.
281 .ti 0
282 \&.r    yes     no      Roman text follows.
283 .ti 0
284 \&.re   -       no      Reset tabs to default values.
285 .ti 0
286 \&.sc   no      no      Read in a file of special characters
287 and diacritical marks.
288 Must be given before initialization.
289 .ti 0
290 \&.sh \fIn x\fR -       yes     Section head follows,
291 font automatically bold.
292 .I n
293 is level of section,
294 .I x
295 is title of section.
296 .ti 0
297 \&.sk   no      no      Leave the next page blank.
298 Only one page is remembered ahead.
299 .ti 0
300 \&.sm \fIx\fR   -       no      Set
301 .I x
302 in a smaller pointsize.
303 .ti 0
304 \&.sz \fI+n\fR  10p     no      Augment the point size by
305 .I n
306 points.
307 .ti 0
308 \&.th   no      no      Produce the paper in thesis format.
309 Must be given before initialization.
310 .ti 0
311 \&.tp   no      yes     Begin title page.
312 .ti 0
313 \&.u \fIx\fR    -       no      Underline argument (even in \fItroff\fR).
314 (Nofill only).
315 .ti 0
316 \&.uh   -       yes     Like .sh but unnumbered.
317 .ti 0
318 \&.xp \fIx\fR   -       no      Print index
319 .I x.