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