| Current File : //usr/share/man/man5/me.5 |
'\" 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
.TH me 5 "25 Feb 1992" "SunOS 5.11" "Standards, Environments, and Macros"
.SH NAME
me \- macros for formatting papers
.SH SYNOPSIS
.LP
.nf
\fBnroff\fR \fB-me\fR [\fIoptions\fR] \fIfilename\fR...
.fi
.LP
.nf
\fBtroff\fR \fB-me\fR [\fIoptions\fR] \fIfilename\fR...
.fi
.SH DESCRIPTION
.sp
.LP
This package of \fBnroff\fR and \fBtroff\fR 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 \fBcol\fR(1).
.sp
.LP
The macro requests are defined below. Many \fBnroff\fR and \fBtroff\fR requests are unsafe in conjunction with this package, however, these requests may be used with impunity after the first \fB\&.pp\fR:
.sp
.ne 2
.mk
.na
\fB\&.bp\fR
.ad
.RS 12n
.rt
begin new page
.RE
.sp
.ne 2
.mk
.na
\fB\&.br\fR
.ad
.RS 12n
.rt
break output line here
.RE
.sp
.ne 2
.mk
.na
\fB\&.sp \fIn\fR\fR
.ad
.RS 12n
.rt
insert \fIn\fR spacing lines
.RE
.sp
.ne 2
.mk
.na
\fB\&.ls \fIn\fR\fR
.ad
.RS 12n
.rt
(line spacing) \fIn\fR=1 single, \fIn\fR=2 double space
.RE
.sp
.ne 2
.mk
.na
\fB\&.na\fR
.ad
.RS 12n
.rt
no alignment of right margin
.RE
.sp
.ne 2
.mk
.na
\fB\&.ce \fIn\fR\fR
.ad
.RS 12n
.rt
center next \fIn\fR lines
.RE
.sp
.ne 2
.mk
.na
\fB\&.ul \fIn\fR\fR
.ad
.RS 12n
.rt
underline next \fIn\fR lines
.RE
.sp
.ne 2
.mk
.na
\fB\&.sz \fI+n\fR\fR
.ad
.RS 12n
.rt
add \fIn\fR to point size
.RE
.sp
.LP
Output of the \fBeqn\fR(1), \fBneqn\fR(1), \fBrefer\fR(1), and \fBtbl\fR(1) preprocessors for equations and tables is acceptable as input.
.SH REQUESTS
.sp
.LP
In the following list, "initialization" refers to the first \fB\&.pp,\fR \fB\&.lp\fR, \fB\&.ip\fR, \fB\&.np\fR, \fB\&.sh\fR, or \fB\&.uh\fR macro. This list is incomplete.
.sp
.sp
.TS
tab();
cw(.83i) cw(.67i) cw(.67i) cw(3.33i)
cw(.83i) cw(.67i) cw(.67i) cw(3.33i)
.
\fIRequest\fR\fIInitial\fR\fICause\fR\fIExplanation\fR
\fIValue\fR\fIBreak\fR
\fB\&.(c\fR-yesBegin centered block.
\fB\&.(d\fR-noBegin delayed text.
\fB\&.(f\fR-noBegin footnote.
\fB\&.(l\fR-yesBegin list.
\fB\&.(q\fR-yesBegin major quote.
\fB\&.(x\fR\fIx\fR -noBegin indexed item in index \fIx\fR.
\fB\&.(z\fR-noBegin floating keep.
\fB\&.)c\fR-yesEnd centered block.
\fB\&.)d\fR-yesEnd delayed text.
\fB\&.)f\fR-yesEnd footnote.
\fB\&.)l\fR-yesEnd list.
\fB\&.)q\fR-yesEnd major quote.
\fB\&.)x\fR-yesEnd index item.
\fB\&.)z\fR-yesEnd floating keep.
\fB\&.++\fR \fIm H\fR -noDefine paper section.
\fIm\fR defines the part of the paper,
T{
and can be \fBC\fR (chapter), \fBA\fR (appendix), \fBP\fR (preliminary, for instance,
T}
abstract, table of contents, etc.),
\fBB\fR (bibliography), \fBRC\fR (chapters
renumbered from page one each
chapter), or \fBRA\fR (appendix renumbered
from page one).
\fB\&.+c \fR\fIT\fR -yesBegin chapter (or appendix, etc.,
as set by \fB\&.++\fR). \fIT\fR is
the chapter title.
\fB\&.1c\fR1yesOne column format on a new page.
\fB\&.2c\fR1yesTwo column format.
\fB\&.EN\fR-yesSpace after equation produced by \fBeqn\fR
or \fBneqn\fR.
\fB\&.EQ\fR \fIx y\fR -yesPrecede equation; break out and
add space. Equation number is \fIy\fR.
The optional argument \fIx\fR may be \fII\fR
to indent equation (default),
\fIL\fR to left-adjust the equation, or
\fIC\fR to center the equation.
\fB\&.GE\fR-yesEnd \fIgremlin\fR picture.
\fB\&.GS\fR-yesBegin \fIgremlin\fR picture.
\fB\&.PE\fR-yesEnd \fBpic\fR picture.
\fB\&.PS\fR-yesBegin \fBpic\fR picture.
\fB\&.TE\fR-yesEnd table.
\fB\&.TH\fR-yesEnd heading section of table.
\fB\&.TS\fR \fIx\fR-yesBegin table; if \fIx\fR is \fIH\fR table
has repeated heading.
\fB\&.ac\fR \fIA N\fR -noSet up for ACM style output.
\fIA\fR is the Author's name(s), \fIN\fR is the
total number of pages. Must be given
before the first initialization.
\fB\&.b\fR \fIx\fR nonoPrint \fIx\fR in boldface; if no argument
switch to boldface.
\fB\&.ba\fR \fI+n\fR 0yesAugments the base indent by \fIn\fR.
This indent is used to set the indent
on regular text (like paragraphs).
\fB\&.bc\fRnoyesBegin new column.
\fB\&.bi\fR \fIx\fR nonoPrint \fIx\fR in bold italics
(nofill only).
\fB\&.bu\fR-yesBegin bulleted paragraph.
\fB\&.bx\fR \fIx\fRnonoPrint \fIx\fR in a box (nofill only).
\fB\&.ef\fR \fI\&'x'y'z\fR\&'''''noSet even footer to \fIx y z\fR.
\fB\&.eh\fR \fI\&'x'y'z\fR\&'''''noSet even header to \fIx y z\fR.
\fB\&.fo\fR \fI\&'x'y'z\fR\&'''''noSet footer to \fIx y z\fR.
\fB\&.hx\fR-noSuppress headers and footers on
next page.
\fB\&.he\fR \fI\&'x'y'z\fR\&'''''noSet header to \fIx y z\fR.
\fB\&.hl\fR-yesDraw a horizontal line.
\fB\&.i\fR \fIx\fR nonoItalicize \fIx\fR; if \fIx\fR missing, italic
text follows.
\fB\&.ip\fR \fIx y\fR noyesStart indented paragraph, with
hanging tag \fIx\fR. Indentation is
\fIy\fR ens (default 5).
\fB\&.lp\fRyesyesStart left-blocked paragraph.
\fB\&.lo\fR-noRead in a file of local macros
of the form \fB\&.*\fR\fIx.\fR Must be
given before initialization.
\fB\&.np\fR1yesStart numbered paragraph.
\fB\&.of\fR \fI\&'x'y'z\fR\&'''''noSet odd footer to x y z.
\fB\&.oh\fR \fI\&'x'y'z\fR\&'''''noSet odd header to x y z.
\fB\&.pd\fR-yesPrint delayed text.
\fB\&.pp\fRnoyesBegin paragraph. First line indented.
\fB\&.r\fRyesnoRoman text follows.
\fB\&.re\fR-noReset tabs to default values.
\fB\&.sc\fRnonoRead in a file of special characters
and diacritical marks. Must be
given before initialization.
\fB\&.sh\fR \fIn x\fR -yesSection head follows, font
automatically bold. \fIn\fR is level
of section, \fIx\fR is title of section.
\fB\&.sk\fRnonoLeave the next page blank.
Only one page is remembered ahead.
\fB\&.sm\fR \fIx\fR-noSet \fIx\fR in a smaller pointsize.
\fB\&.sz\fR \fI+n\fR 10pnoAugment the point size by \fIn\fR points.
\fB\&.th\fRnonoProduce the paper in thesis format.
Must be given before initialization.
\fB\&.tp\fRnoyesBegin title page.
\fB\&.u\fR \fIx\fR-noUnderline argument (even in \fBtroff\fR).
(Nofill only).
\fB\&.uh\fR-yesLike \fB\&.sh\fR but unnumbered.
\fB\&.xp\fR \fIx\fR -noPrint index \fIx\fR.
.TE
.SH FILES
.sp
.ne 2
.mk
.na
\fB\fB/usr/share/lib/tmac/e\fR\fR
.ad
.RS 28n
.rt
.RE
.sp
.ne 2
.mk
.na
\fB\fB/usr/share/lib/tmac/*.me\fR\fR
.ad
.RS 28n
.rt
.RE
.SH SEE ALSO
.sp
.LP
\fBcol\fR(1), \fBeqn\fR(1), \fBnroff\fR(1), \fBrefer\fR(1), \fBtbl\fR(1), \fBtroff\fR(1)