man/man5/me.5

	me.5 revision c10c16dec587a0662068f6e2991c29ed3a9db943
 te
 Copyright (c) 1980 Regents of the University of California. All rights reserved. The Berkeley software License Agreement Copyright (c) 1997, Sun Microsystems, Inc. All Rights Reserved
 me 5 "25 Feb 1992" "SunOS 5.11" "Standards, Environments, and Macros"
 NAME
me - macros for formatting papers
 SYNOPSIS

nroff -me [options] filename...


troff -me [options] filename...


 DESCRIPTION

This package of nroff and troff macro definitions provides a canned
formatting facility for technical papers in various formats. When producing
2-column output on a terminal, filter the output through col(1).

The macro requests are defined below. Many nroff and troff requests
are unsafe in conjunction with this package, however, these requests may be
used with impunity after the first .pp:

.bp

begin new page


.br

break output line here


.sp n

insert n spacing lines


.ls n

(line spacing) n=1 single, n=2 double space


.na

no alignment of right margin


.ce n

center next n lines


.ul n

underline next n lines


.sz +n

add n to point size


Output of the eqn(1), neqn(1), refer(1), and tbl(1)
preprocessors for equations and tables is acceptable as input.
 REQUESTS

In the following list, "initialization" refers to the first .pp,
.lp, .ip, .np, .sh, or .uh macro. This
list is incomplete.


RequestInitialCauseExplanation
ValueBreak
.(c-yesBegin centered block.
.(d-noBegin delayed text.
.(f-noBegin footnote.
.(l-yesBegin list.
.(q-yesBegin major quote.
.(xx -noBegin indexed item in index x.
.(z-noBegin floating keep.
.)c-yesEnd centered block.
.)d-yesEnd delayed text.
.)f-yesEnd footnote.
.)l-yesEnd list.
.)q-yesEnd major quote.
.)x-yesEnd index item.
.)z-yesEnd floating keep.
.++ m H -noDefine paper section.
m defines the part of the paper,
and can be C (chapter), A (appendix), P (preliminary, for instance,
abstract, table of contents, etc.),
B (bibliography), RC (chapters
renumbered from page one each
chapter), or RA (appendix renumbered
from page one).
.+c T -yesBegin chapter (or appendix, etc.,
as set by .++). T is
the chapter title.
.1c1yesOne column format on a new page.
.2c1yesTwo column format.
.EN-yesSpace after equation produced by eqn
or neqn.
.EQ x y -yesPrecede equation; break out and
add space. Equation number is y.
The optional argument x may be I
to indent equation (default),
L to left-adjust the equation, or
C to center the equation.
.GE-yesEnd gremlin picture.
.GS-yesBegin gremlin picture.
.PE-yesEnd pic picture.
.PS-yesBegin pic picture.
.TE-yesEnd table.
.TH-yesEnd heading section of table.
.TS x-yesBegin table; if x is H table
has repeated heading.
.ac A N -noSet up for ACM style output.
A is the Author's name(s), N is the
total number of pages. Must be given
before the first initialization.
.b x nonoPrint x in boldface; if no argument
switch to boldface.
.ba +n 0yesAugments the base indent by n.
This indent is used to set the indent
on regular text (like paragraphs).
.bcnoyesBegin new column.
.bi x nonoPrint x in bold italics
(nofill only).
.bu-yesBegin bulleted paragraph.
.bx xnonoPrint x in a box (nofill only).
.ef 'x'y'z'''''noSet even footer to x y z.
.eh 'x'y'z'''''noSet even header to x y z.
.fo 'x'y'z'''''noSet footer to x y z.
.hx-noSuppress headers and footers on
next page.
.he 'x'y'z'''''noSet header to x y z.
.hl-yesDraw a horizontal line.
.i x nonoItalicize x; if x missing, italic
text follows.
.ip x y noyesStart indented paragraph, with
hanging tag x. Indentation is
y ens (default 5).
.lpyesyesStart left-blocked paragraph.
.lo-noRead in a file of local macros
of the form .*x. Must be
given before initialization.
.np1yesStart numbered paragraph.
.of 'x'y'z'''''noSet odd footer to x y z.
.oh 'x'y'z'''''noSet odd header to x y z.
.pd-yesPrint delayed text.
.ppnoyesBegin paragraph. First line indented.
.ryesnoRoman text follows.
.re-noReset tabs to default values.
.scnonoRead in a file of special characters
and diacritical marks. Must be
given before initialization.
.sh n x -yesSection head follows, font
automatically bold. n is level
of section, x is title of section.
.sknonoLeave the next page blank.
Only one page is remembered ahead.
.sm x-noSet x in a smaller pointsize.
.sz +n 10pnoAugment the point size by n points.
.thnonoProduce the paper in thesis format.
Must be given before initialization.
.tpnoyesBegin title page.
.u x-noUnderline argument (even in troff).
(Nofill only).
.uh-yesLike .sh but unnumbered.
.xp x -noPrint index x.


 FILES

/usr/share/lib/tmac/e


/usr/share/lib/tmac/*.me


 SEE ALSO

col(1), eqn(1), nroff(1), refer(1), tbl(1),
troff(1)

Request	Initial	Cause	Explanation
	Value	Break
.(c	-	yes	Begin centered block.
.(d	-	no	Begin delayed text.
.(f	-	no	Begin footnote.
.(l	-	yes	Begin list.
.(q	-	yes	Begin major quote.
.(xx	-	no	Begin indexed item in index x.
.(z	-	no	Begin floating keep.
.)c	-	yes	End centered block.
.)d	-	yes	End delayed text.
.)f	-	yes	End footnote.
.)l	-	yes	End list.
.)q	-	yes	End major quote.
.)x	-	yes	End index item.
.)z	-	yes	End floating keep.
.++ m H	-	no	Define paper section.
			m defines the part of the paper,

and can be C (chapter), A (appendix), P (preliminary, for instance,

			abstract, table of contents, etc.),
			B (bibliography), RC (chapters
			renumbered from page one each
			chapter), or RA (appendix renumbered
			from page one).
.+c T	-	yes	Begin chapter (or appendix, etc.,
			as set by .++). T is
			the chapter title.
.1c	1	yes	One column format on a new page.
.2c	1	yes	Two column format.
.EN	-	yes	Space after equation produced by eqn
			or neqn.
.EQ x y	-	yes	Precede equation; break out and
			add space. Equation number is y.
			The optional argument x may be I
			to indent equation (default),
			L to left-adjust the equation, or
			C to center the equation.
.GE	-	yes	End gremlin picture.
.GS	-	yes	Begin gremlin picture.
.PE	-	yes	End pic picture.
.PS	-	yes	Begin pic picture.
.TE	-	yes	End table.
.TH	-	yes	End heading section of table.
.TS x	-	yes	Begin table; if x is H table
			has repeated heading.
.ac A N	-	no	Set up for ACM style output.
			A is the Author's name(s), N is the
			total number of pages. Must be given
			before the first initialization.
.b x	no	no	Print x in boldface; if no argument
			switch to boldface.
.ba +n	0	yes	Augments the base indent by n.
			This indent is used to set the indent
			on regular text (like paragraphs).
.bc	no	yes	Begin new column.
.bi x	no	no	Print x in bold italics
			(nofill only).
.bu	-	yes	Begin bulleted paragraph.
.bx x	no	no	Print x in a box (nofill only).
.ef 'x'y'z	'''''	no	Set even footer to x y z.
.eh 'x'y'z	'''''	no	Set even header to x y z.
.fo 'x'y'z	'''''	no	Set footer to x y z.
.hx	-	no	Suppress headers and footers on
			next page.
.he 'x'y'z	'''''	no	Set header to x y z.
.hl	-	yes	Draw a horizontal line.
.i x	no	no	Italicize x; if x missing, italic
			text follows.
.ip x y	no	yes	Start indented paragraph, with
			hanging tag x. Indentation is
			y ens (default 5).
.lp	yes	yes	Start left-blocked paragraph.
.lo	-	no	Read in a file of local macros
			of the form .*x. Must be
			given before initialization.
.np	1	yes	Start numbered paragraph.
.of 'x'y'z	'''''	no	Set odd footer to x y z.
.oh 'x'y'z	'''''	no	Set odd header to x y z.
.pd	-	yes	Print delayed text.
.pp	no	yes	Begin paragraph. First line indented.
.r	yes	no	Roman text follows.
.re	-	no	Reset tabs to default values.
.sc	no	no	Read in a file of special characters
			and diacritical marks. Must be
			given before initialization.
.sh n x	-	yes	Section head follows, font
			automatically bold. n is level
			of section, x is title of section.
.sk	no	no	Leave the next page blank.
			Only one page is remembered ahead.
.sm x	-	no	Set x in a smaller pointsize.
.sz +n	10p	no	Augment the point size by n points.
.th	no	no	Produce the paper in thesis format.
			Must be given before initialization.
.tp	no	yes	Begin title page.
.u x	-	no	Underline argument (even in troff).
			(Nofill only).
.uh	-	yes	Like .sh but unnumbered.
.xp x	-	no	Print index x.