xref: /386bsd/usr/share/man/cat7/me.0 (revision a2142627)
1
2
3
4ME(7)                          1991                         ME(7)
5
6
7NNAAMMEE
8       me - macros for formatting papers
9
10SSYYNNOOPPSSIISS
11       nnrrooffff --mmee [ options ] file ...
12       ttrrooffff --mmee [ options ] file ...
13
14DDEESSCCRRIIPPTTIIOONN
15       This package of _n_r_o_f_f and _t_r_o_f_f macro definitions provides
16       a canned formatting facility for technical papers in vari-
17       ous  formats.   When producing 2-column output on a termi-
18       nal, filter the output through _c_o_l(1).
19
20       The macro requests are  defined  below.   Many  _n_r_o_f_f  and
21       _t_r_o_f_f  requests  are unsafe in conjunction with this pack-
22       age, however, these requests may  be  used  with  impunity
23       after the first .pp:
24
25              .bp     begin new page
26              .br     break output line here
27              .sp n   insert n spacing lines
28              .ls n   (line spacing) n=1 single, n=2 double space
29              .na     no alignment of right margin
30              .ce n   center next n lines
31              .ul n   underline next n lines
32              .sz +n  add n to point size
33
34       Output  of  the _e_q_n, _n_e_q_n, _r_e_f_e_r, and _t_b_l(1) preprocessors
35       for equations and tables is acceptable as input.
36
37FFIILLEESS
38       /usr/lib/tmac/tmac.e
39       /usr/lib/me/*
40
41SSEEEE AALLSSOO
42       eqn(1), troff(1), refer(1), tbl(1)
43       -me Reference Manual, Eric P. Allman
44       Writing Papers with Nroff Using -me
45
46RREEQQUUEESSTTSS
47       In the following list, initialization refers to the  first
48       .pp,  .lp,  .ip,  .np,  .sh,  or  .uh macro.  This list is
49       incomplete; see _T_h_e -_m_e _R_e_f_e_r_e_n_c_e _M_a_n_u_a_l  for  interesting
50       details.
51
52                           Request      Initial Cause Explanation
53                                        Value   Break
54                           .(c          -       yes   Begin  cen-
55                           tered                            block
56                           .(d          -       no    Begin
57                           delayed                           text
58                           .(f          -       no    Begin foot-
59                           note  .(l          -       yes   Begin
60                           list  .(q          -       yes   Begin
61
62
63
6417,                           April                             1
65
66
67
68
69
70ME(7)                          1991                         ME(7)
71
72
73                           major             quote            .(x
74                           _x        -       no    Begin   indexed
75                           item         in         index        _x
76                           .(z          -       no    Begin
77                           floating                          keep
78                           .)c          -       yes   End    cen-
79                           tered                            block
80                           .)d          -       yes   End delayed
81                           text    .)f          -       yes   End
82                           footnote
83                           .)l          -       yes   End    list
84                           .)q          -       yes   End   major
85                           quote   .)x          -       yes   End
86                           index                             item
87                           .)z          -       yes   End  float-
88                           ing keep
89.++ _m _H      -       no    Define paper section.  _m  defines  the
90                           part of the paper, and can be CC (chap-
91                           ter), AA  (appendix),  PP  (preliminary,
92                           e.g.,  abstract,  table  of  contents,
93                           etc.), BB (bibliography), RRCC  (chapters
94                           renumbered  from  page  one each chap-
95                           ter), or RRAA (appendix renumbered  from
96                           page one).
97.+c  _T        -       yes   Begin  chapter (or appendix, etc., as
98                           set by .++).  _T is the chapter  title.
99                           .1c          1       yes   One  column
100                           format     on     a     new      page.
101                           .2c          1       yes   Two  column
102                           format.
103                           .EN          -       yes   Space after
104                           equation produced by _e_q_n or _n_e_q_n.  .EQ
105                           _x  _y       -       yes   Precede equa-
106                           tion; break out and add space.   Equa-
107                           tion  number is _y.  The optional argu-
108                           ment _x may be  _I  to  indent  equation
109                           (default),  _L to left-adjust the equa-
110                           tion, or _C  to  center  the  equation.
111                           .GE          -       yes   End _g_r_e_m_l_i_n
112                           picture.
113                           .GS          -       yes   Begin _g_r_e_m-
114                           _l_i_n                           picture.
115                           .PE          -       yes   End     _p_i_c
116                           picture.
117                           .PS          -       yes   Begin   _p_i_c
118                           picture.
119                           .TE          -       yes   End  table.
120                           .TH          -       yes   End heading
121                           section       of      table.       .TS
122                           _x        -       yes   Begin table; if
123                           _x is _H table has repeated heading.
124.ac _A _N      -       no    Set up for ACM style output.  _A is the
125                           Author's name(s), _N is the total  num-
126                           ber  of  pages.   Must be given before
127
128
129
13017,                           April                             2
131
132
133
134
135
136ME(7)                          1991                         ME(7)
137
138
139                           the    first    initialization.     .b
140                           _x         no      no    Print   _x   in
141                           boldface; if  no  argument  switch  to
142                           boldface.
143.ba  +_n       0       yes   Augments  the base indent by _n.  This
144                           indent is used to set  the  indent  on
145                           regular    text   (like   paragraphs).
146                           .bc          no      yes   Begin   new
147                           column                             .bi
148                           _x        no      no    Print _x in bold
149                           italics          (nofill         only)
150                           .bu          -       yes   Begin  bul-
151                           leted           paragraph          .bx
152                           _x        no      no    Print  _x  in  a
153                           box (nofill only).
154.ef '_x'_y'_z'  ''''    no    Set even footer to x  y  z
155.eh '_x'_y'_z'  ''''    no    Set even header to x  y  z
156.fo '_x'_y'_z'  ''''    no    Set footer to x  y  z
157.hx          -       no    Suppress  headers  and footers on next
158                           page.  .he  '_x'_y'_z'  ''''    no    Set
159                           header       to      x       y       z
160                           .hl          -       yes   Draw a hor-
161                           izontal             line            .i
162                           _x         no      no    Italicize   _x;
163                           if  _x  missing,  italic  text follows.
164                           .ip     _x     _y    no      yes   Start
165                           indented  paragraph,  with hanging tag
166                           _x.  Indentation is _y ens (default  5).
167                           .lp          yes     yes   Start left-
168                           blocked paragraph.
169.lo          -       no    Read in a file of local macros of  the
170                           form  ..**_x.   Must be given before ini-
171                           tialization.
172                           .np          1       yes   Start  num-
173                           bered paragraph.
174.of '_x'_y'_z'  ''''    no    Set odd footer to x  y  z
175.oh '_x'_y'_z'  ''''    no    Set odd header to x  y  z
176.pd          -       yes   Print          delayed           text.
177                           .pp          no      yes   Begin para-
178                           graph.     First    line     indented.
179                           .r           yes     no    Roman  text
180                           follows.
181.re          -       no    Reset tabs to default values.
182.sc          no      no    Read in a file of  special  characters
183                           and  diacritical marks.  Must be given
184                           before    initialization.     .sh    _n
185                           _x      -       yes   Section head fol-
186                           lows, font automatically bold.   _n  is
187                           level  of  section, _x is title of sec-
188                           tion.
189.sk          no      no    Leave the next page blank.   Only  one
190                           page   is   remembered   ahead.    .sm
191                           _x        -       no    Set  _x   in   a
192                           smaller pointsize.
193
194
195
19617,                           April                             3
197
198
199
200
201
202ME(7)                          1991                         ME(7)
203
204
205.sz +_n       10p     no    Augment the point size by _n points.
206.th          no      no    Produce  the  paper  in thesis format.
207                           Must be given before initialization.
208.tp          no      yes   Begin      title       page.        .u
209                           _x         -       no    Underline
210                           argument  (even  in  _t_r_o_f_f).   (Nofill
211                           only).
212                           .uh          -       yes   Like    .sh
213                           but          unnumbered.           .xp
214                           _x        -       no    Print index  _x.
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
26217,                           April                             4
263
264
265