Commit | Line | Data |
---|---|---|
1efd67fd KM |
1 | .\" Copyright (c) 1980 Regents of the University of California. |
2 | .\" All rights reserved. The Berkeley software License Agreement | |
3 | .\" specifies the terms and conditions for redistribution. | |
4 | .\" | |
8510b0c0 | 5 | .\" @(#)me.7 6.3 (Berkeley) %G% |
1efd67fd KM |
6 | .\" |
7 | .hc % | |
4435f369 | 8 | .TH ME 7 "" |
1efd67fd KM |
9 | .UC 3 |
10 | .SH NAME | |
11 | me \- macros for formatting papers | |
12 | .SH SYNOPSIS | |
13 | .B "nroff \-me" | |
14 | [ options ] | |
15 | file ... | |
16 | .br | |
17 | .B "troff \-me" | |
18 | [ options ] | |
19 | file ... | |
20 | .SH DESCRIPTION | |
21 | This package of | |
22 | .I nroff | |
23 | and | |
24 | .I troff | |
25 | macro definitions provides a canned formatting | |
26 | facility for tech%nical papers in various formats. | |
27 | When producing 2-column output on a terminal, filter | |
28 | the output through | |
29 | .IR col (1). | |
30 | .PP | |
31 | The macro requests are defined below. | |
32 | Many | |
33 | .I nroff | |
34 | and | |
35 | .I troff | |
36 | requests are unsafe in conjunction with | |
8510b0c0 | 37 | this package, however, these requests may be used with |
1efd67fd KM |
38 | impunity after the first .pp: |
39 | .nf | |
40 | .IP | |
41 | .ta \w'.sz +n 'u | |
42 | \&.bp begin new page | |
43 | \&.br break output line here | |
44 | \&.sp n insert n spacing lines | |
45 | \&.ls n (line spacing) n=1 single, n=2 double space | |
46 | \&.na no alignment of right margin | |
47 | \&.ce n center next n lines | |
48 | \&.ul n underline next n lines | |
49 | \&.sz +n add n to point size | |
50 | .fi | |
51 | .PP | |
52 | Output of the | |
53 | .I eqn, | |
54 | .I neqn, | |
55 | .I refer, | |
56 | and | |
57 | .IR tbl (1) | |
58 | preprocessors | |
59 | for equations and tables is acceptable as input. | |
60 | .SH FILES | |
61 | /usr/lib/tmac/tmac.e | |
62 | .br | |
63 | /usr/lib/me/* | |
64 | .SH "SEE ALSO" | |
65 | eqn(1), troff(1), refer(1), tbl(1) | |
66 | .br | |
67 | \-me Reference Manual, Eric P. Allman | |
68 | .br | |
69 | Writing Papers with Nroff Using \-me | |
70 | .tr &. | |
71 | .SH REQUESTS | |
72 | In the following list, | |
73 | \*(lqinitialization\*(rq | |
74 | refers to the first .pp, .lp, .ip, .np, .sh, or .uh macro. | |
75 | This list is incomplete; | |
76 | see | |
77 | .I "The \-me Reference Manual" | |
78 | for interesting details. | |
79 | .PP | |
80 | .ta \w'.eh \'x\'y\'z\' 'u +\w'Initial 'u +\w'Cause 'u | |
81 | .br | |
82 | .di x | |
83 | \ka | |
84 | .br | |
85 | .di | |
86 | .in \nau | |
87 | .ti0 | |
88 | Request Initial Cause Explanation | |
89 | .ti0 | |
90 | Value Break | |
91 | .br | |
92 | .in \nau | |
93 | .ti0 | |
94 | \&.(c - yes Begin centered block | |
95 | .ti0 | |
96 | \&.(d - no Begin delayed text | |
97 | .ti0 | |
98 | \&.(f - no Begin footnote | |
99 | .ti0 | |
100 | \&.(l - yes Begin list | |
101 | .ti0 | |
102 | \&.(q - yes Begin major quote | |
103 | .ti0 | |
104 | \&.(x \fIx\fR - no Begin indexed item in index | |
105 | .I x | |
106 | .ti0 | |
107 | \&.(z - no Begin floating keep | |
108 | .ti0 | |
109 | \&.)c - yes End centered block | |
110 | .ti0 | |
111 | \&.)d - yes End delayed text | |
112 | .ti0 | |
113 | \&.)f - yes End footnote | |
114 | .ti0 | |
115 | \&.)l - yes End list | |
116 | .ti0 | |
117 | \&.)q - yes End major quote | |
118 | .ti0 | |
119 | \&.)x - yes End index item | |
120 | .ti0 | |
121 | \&.)z - yes End floating keep | |
122 | .ti 0 | |
123 | \&.++ \fIm H\fR - no Define paper section. | |
124 | .I m | |
125 | defines the part of the paper, and can be | |
126 | .B C | |
127 | (chapter), | |
128 | .B A | |
129 | (appendix), | |
130 | .B P | |
131 | (preliminary, e.g., abstract, table of contents, etc.), | |
132 | .B B | |
133 | (bibliography), | |
134 | .B RC | |
135 | (chapters renumbered from page one each chapter), | |
136 | or | |
137 | .B RA | |
138 | (appendix renumbered from page one). | |
139 | .ti 0 | |
140 | \&.+c \fIT\fR - yes Begin chapter (or appendix, etc., as | |
141 | set by .++). | |
142 | .I T | |
143 | is the chapter title. | |
144 | .ti0 | |
145 | \&.1c 1 yes One column format on a new page. | |
146 | .ti0 | |
147 | \&.2c 1 yes Two column format. | |
148 | .ti0 | |
149 | \&.EN - yes Space after equation | |
150 | produced by | |
151 | .I eqn | |
152 | or | |
153 | .IR neqn . | |
154 | .ti0 | |
155 | \&.EQ \fIx y\fR - yes Precede equation; break out and | |
156 | add space. | |
157 | Equation number is | |
158 | .IR y . | |
159 | The optional argument \fIx\fR | |
160 | may be | |
161 | .I I | |
162 | to indent equation (default), | |
163 | .I L | |
164 | to left-adjust the equation, or | |
165 | .I C | |
166 | to center the equation. | |
167 | .ti0 | |
8f758aca EA |
168 | \&.GE - yes End \fIgremlin\fP picture. |
169 | .ti0 | |
170 | \&.GS - yes Begin \fIgremlin\fP picture. | |
171 | .ti0 | |
172 | \&.PE - yes End \fIpic\fP picture. | |
173 | .ti0 | |
174 | \&.PS - yes Begin \fIpic\fP picture. | |
175 | .ti0 | |
1efd67fd KM |
176 | \&.TE - yes End table. |
177 | .ti0 | |
178 | \&.TH - yes End heading section of table. | |
179 | .ti0 | |
180 | \&.TS \fIx\fR - yes Begin table; if \fIx\fR is | |
181 | .I H | |
182 | table has repeated heading. | |
183 | .ti 0 | |
184 | \&.ac \fIA N\fR - no Set up for ACM style output. | |
185 | .I A | |
186 | is the Author's name(s), | |
187 | .I N | |
188 | is the total number of pages. | |
189 | Must be given before the first initialization. | |
190 | .ti0 | |
191 | \&.b \fIx\fR no no Print | |
192 | .I x | |
193 | in boldface; if no argument switch to boldface. | |
194 | .ti 0 | |
195 | \&.ba \fI+n\fR 0 yes Augments the base indent by | |
196 | .I n. | |
197 | This indent is used to set the indent on regular text | |
198 | (like paragraphs). | |
199 | .ti0 | |
200 | \&.bc no yes Begin new column | |
201 | .ti0 | |
202 | \&.bi \fIx\fR no no Print | |
203 | .I x | |
204 | in bold italics (nofill only) | |
205 | .ti0 | |
8f758aca EA |
206 | \&.bu - yes Begin bulleted paragraph |
207 | .ti0 | |
1efd67fd KM |
208 | \&.bx \fIx\fR no no Print \fIx\fR in a box (nofill only). |
209 | .ti 0 | |
210 | \&.ef \fI\'x\'y\'z\'\fR \'\'\'\' no Set even footer to x y z | |
211 | .ti 0 | |
212 | \&.eh \fI\'x\'y\'z\'\fR \'\'\'\' no Set even header to x y z | |
213 | .ti 0 | |
214 | \&.fo \fI\'x\'y\'z\'\fR \'\'\'\' no Set footer to x y z | |
215 | .ti 0 | |
483ef11a | 216 | \&.hx - no Suppress headers and footers on next page. |
1efd67fd KM |
217 | .ti0 |
218 | \&.he \fI\'x\'y\'z\'\fR \'\'\'\' no Set header to x y z | |
219 | .ti0 | |
220 | \&.hl - yes Draw a horizontal line | |
221 | .ti0 | |
222 | \&.i \fIx\fR no no Italicize | |
223 | .I x; | |
224 | if | |
225 | .I x | |
226 | missing, italic text follows. | |
227 | .ti0 | |
228 | \&.ip \fIx y\fR no yes Start indented paragraph, | |
229 | with hanging tag | |
230 | .IR x . | |
231 | Indentation is | |
232 | .I y | |
233 | ens (default 5). | |
234 | .ti0 | |
235 | \&.lp yes yes Start left-blocked paragraph. | |
236 | .ti 0 | |
237 | \&.lo - no Read in a file of local macros of the | |
238 | form | |
239 | .BI \&.* x. | |
240 | Must be given before initialization. | |
241 | .ti0 | |
242 | \&.np 1 yes Start numbered paragraph. | |
243 | .ti 0 | |
244 | \&.of \fI\'x\'y\'z\'\fR \'\'\'\' no Set odd footer to x y z | |
245 | .ti 0 | |
246 | \&.oh \fI\'x\'y\'z\'\fR \'\'\'\' no Set odd header to x y z | |
247 | .ti 0 | |
248 | \&.pd - yes Print delayed text. | |
249 | .ti0 | |
250 | \&.pp no yes Begin paragraph. | |
251 | First line indented. | |
252 | .ti0 | |
253 | \&.r yes no Roman text follows. | |
254 | .ti 0 | |
255 | \&.re - no Reset tabs to default values. | |
256 | .ti 0 | |
257 | \&.sc no no Read in a file of special characters | |
258 | and diacritical marks. | |
259 | Must be given before initialization. | |
260 | .ti0 | |
261 | \&.sh \fIn x\fR - yes Section head follows, | |
262 | font automatically bold. | |
263 | .I n | |
264 | is level of section, | |
265 | .I x | |
266 | is title of section. | |
267 | .ti 0 | |
268 | \&.sk no no Leave the next page blank. | |
269 | Only one page is remembered ahead. | |
8f758aca EA |
270 | .ti0 |
271 | \&.sm \fIx\fR - no Set | |
272 | .I x | |
273 | in a smaller pointsize. | |
1efd67fd KM |
274 | .ti 0 |
275 | \&.sz \fI+n\fR 10p no Augment the point size by | |
276 | .I n | |
277 | points. | |
278 | .ti 0 | |
279 | \&.th no no Produce the paper in thesis format. | |
280 | Must be given before initialization. | |
281 | .ti 0 | |
282 | \&.tp no yes Begin title page. | |
283 | .ti0 | |
284 | \&.u \fIx\fR - no Underline argument (even in \fItroff\fR). | |
285 | (Nofill only). | |
286 | .ti0 | |
287 | \&.uh - yes Like .sh but unnumbered. | |
288 | .ti0 | |
289 | \&.xp \fIx\fR - no Print index | |
290 | .I x. |