1 .\" Copyright (c) 1980 The Regents of the University of California.
2 .\" All rights reserved.
4 .\" Redistribution and use in source and binary forms are permitted
5 .\" provided that the above copyright notice and this paragraph are
6 .\" duplicated in all such forms and that any documentation,
7 .\" advertising materials, and other materials related to such
8 .\" distribution and use acknowledge that the software was developed
9 .\" by the University of California, Berkeley. The name of the
10 .\" University may not be used to endorse or promote products derived
11 .\" from this software without specific prior written permission.
12 .\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
13 .\" IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
14 .\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
16 .\" @(#)me.7 6.4 (Berkeley) 4/13/90
18 .\" Modified for groff by jjc@jclark.com
20 .TH GROFF_ME @MAN7EXT@ "@MDATE@" "Groff Version @VERSION@"
23 groff_me \- troff macros for formatting papers
33 This manual page describes the GNU version of the \-me macros,
34 which is part of the groff document formatting system.
35 This version can be used with both GNU troff and Unix troff.
38 macro definitions provides a canned formatting
39 facility for tech%nical papers in various formats.
41 The macro requests are defined below.
44 requests are unsafe in conjunction with
45 this package, however, these requests may be used with
46 impunity after the first .pp:
51 \&.br break output line here
52 \&.sp n insert n spacing lines
53 \&.ls n (line spacing) n=1 single, n=2 double space
54 \&.na no alignment of right margin
55 \&.ce n center next n lines
56 \&.ul n underline next n lines
66 is acceptable as input.
68 @MACRODIR@/me.tmac (a wrapper file for e.tmac)
72 .BR groff (@MAN1EXT@),
73 .BR @g@troff (@MAN1EXT@)
75 \-me Reference Manual, Eric P. Allman
77 Writing Papers with Groff Using \-me
80 This list is incomplete;
82 .I "The \-me Reference Manual"
83 for interesting details.
85 .ta \w'.eh \'x\'y\'z\' 'u +\w'Initial 'u +\w'Cause 'u
94 Request Initial Cause Explanation
100 \&.(c - yes Begin centered block
102 \&.(d - no Begin delayed text
104 \&.(f - no Begin footnote
106 \&.(l - yes Begin list
108 \&.(q - yes Begin major quote
110 \&.(x \fIx\fR - no Begin indexed item in index
113 \&.(z - no Begin floating keep
115 \&.)c - yes End centered block
117 \&.)d - yes End delayed text
119 \&.)f - yes End footnote
123 \&.)q - yes End major quote
125 \&.)x - yes End index item
127 \&.)z - yes End floating keep
129 \&.++ \fIm H\fR - no Define paper section.
131 defines the part of the paper, and can be
137 (preliminary, e.g., abstract, table of contents, etc.),
141 (chapters renumbered from page one each chapter),
144 (appendix renumbered from page one).
146 \&.+c \fIT\fR - yes Begin chapter (or appendix, etc., as
149 is the chapter title.
151 \&.1c 1 yes One column format on a new page.
153 \&.2c 1 yes Two column format.
155 \&.EN - yes Space after equation
161 \&.EQ \fIx y\fR - yes Precede equation; break out and
165 The optional argument \fIx\fR
168 to indent equation (default),
170 to left-adjust the equation, or
172 to center the equation.
174 \&.GE - yes End \fIgremlin\fP picture.
176 \&.GS - yes Begin \fIgremlin\fP picture.
178 \&.PE - yes End \fIpic\fP picture.
180 \&.PS - yes Begin \fIpic\fP picture.
182 \&.TE - yes End table.
184 \&.TH - yes End heading section of table.
186 \&.TS \fIx\fR - yes Begin table; if \fIx\fR is
188 table has repeated heading.
190 \&.b \fIx\fR no no Print
192 in boldface; if no argument switch to boldface.
194 \&.ba \fI+n\fR 0 yes Augments the base indent by
196 This indent is used to set the indent on regular text
199 \&.bc no yes Begin new column
201 \&.bi \fIx\fR no no Print
203 in bold italics (nofill only)
205 \&.bu - yes Begin bulleted paragraph
207 \&.bx \fIx\fR no no Print \fIx\fR in a box (nofill only).
209 \&.ef \fI\'x\'y\'z\'\fR \'\'\'\' no Set even footer to x y z
211 \&.eh \fI\'x\'y\'z\'\fR \'\'\'\' no Set even header to x y z
213 \&.fo \fI\'x\'y\'z\'\fR \'\'\'\' no Set footer to x y z
215 \&.hx - no Suppress headers and footers on next page.
217 \&.he \fI\'x\'y\'z\'\fR \'\'\'\' no Set header to x y z
219 \&.hl - yes Draw a horizontal line
221 \&.i \fIx\fR no no Italicize
225 missing, italic text follows.
227 \&.ip \fIx y\fR no yes Start indented paragraph,
234 \&.lp yes yes Start left-blocked paragraph.
236 \&.np 1 yes Start numbered paragraph.
238 \&.of \fI\'x\'y\'z\'\fR \'\'\'\' no Set odd footer to x y z
240 \&.oh \fI\'x\'y\'z\'\fR \'\'\'\' no Set odd header to x y z
242 \&.pd - yes Print delayed text.
244 \&.pp no yes Begin paragraph.
247 \&.r yes no Roman text follows.
249 \&.re - no Reset tabs to default values.
251 \&.sh \fIn x\fR - yes Section head follows,
252 font automatically bold.
258 \&.sk no no Leave the next page blank.
259 Only one page is remembered ahead.
261 \&.sm \fIx\fR - no Set
263 in a smaller pointsize.
265 \&.sz \fI+n\fR 10p no Augment the point size by
269 \&.tp no yes Begin title page.
271 \&.u \fIx\fR - no Underline argument (even in \fItroff\fR).
274 \&.uh - yes Like .sh but unnumbered.
276 \&.xp \fIx\fR - no Print index