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