usr/src/man/man5/me.5

   1 '\" te
   2 .\"  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
   3 .TH ME 5 "Feb 25, 1992"
   4 .SH NAME
   5 me \- macros for formatting papers
   6 .SH SYNOPSIS
   7 .LP
   8 .nf
   9 \fBnroff\fR  \fB-me\fR [\fIoptions\fR] \fIfilename\fR...
  10 .fi
  11
  12 .LP
  13 .nf
  14 \fBtroff\fR  \fB-me\fR [\fIoptions\fR] \fIfilename\fR...
  15 .fi
  16
  17 .SH DESCRIPTION
  18 .sp
  19 .LP
  20 This package of \fBnroff\fR and \fBtroff\fR macro definitions provides a canned
  21 formatting facility for technical papers in various formats. When producing
  22 2-column output on a terminal, filter the output through \fBcol\fR(1).
  23 .sp
  24 .LP
  25 The macro requests are defined below. Many \fBnroff\fR and \fBtroff\fR requests
  26 are unsafe in conjunction with this package, however, these requests may be
  27 used with impunity after the first \fB\&.pp\fR:
  28 .sp
  29 .ne 2
  30 .na
  31 \fB\&.bp\fR
  32 .ad
  33 .RS 12n
  34 begin new page
  35 .RE
  36
  37 .sp
  38 .ne 2
  39 .na
  40 \fB\&.br\fR
  41 .ad
  42 .RS 12n
  43 break output line here
  44 .RE
  45
  46 .sp
  47 .ne 2
  48 .na
  49 \fB\&.sp \fIn\fR\fR
  50 .ad
  51 .RS 12n
  52 insert \fIn\fR spacing lines
  53 .RE
  54
  55 .sp
  56 .ne 2
  57 .na
  58 \fB\&.ls \fIn\fR\fR
  59 .ad
  60 .RS 12n
  61 (line spacing) \fIn\fR=1 single, \fIn\fR=2 double space
  62 .RE
  63
  64 .sp
  65 .ne 2
  66 .na
  67 \fB\&.na\fR
  68 .ad
  69 .RS 12n
  70 no alignment of right margin
  71 .RE
  72
  73 .sp
  74 .ne 2
  75 .na
  76 \fB\&.ce \fIn\fR\fR
  77 .ad
  78 .RS 12n
  79 center next \fIn\fR lines
  80 .RE
  81
  82 .sp
  83 .ne 2
  84 .na
  85 \fB\&.ul \fIn\fR\fR
  86 .ad
  87 .RS 12n
  88 underline next \fIn\fR lines
  89 .RE
  90
  91 .sp
  92 .ne 2
  93 .na
  94 \fB\&.sz \fI+n\fR\fR
  95 .ad
  96 .RS 12n
  97 add \fIn\fR to point size
  98 .RE
  99
 100 .sp
 101 .LP
 102 Output of the \fBeqn\fR(1), \fBneqn\fR(1), \fBrefer\fR(1), and \fBtbl\fR(1)
 103 preprocessors for equations and tables is acceptable as input.
 104 .SH REQUESTS
 105 .sp
 106 .LP
 107 In the following list, "initialization" refers to the first \fB\&.pp,\fR
 108 \fB\&.lp\fR, \fB\&.ip\fR, \fB\&.np\fR, \fB\&.sh\fR, or \fB\&.uh\fR macro. This
 109 list is incomplete.
 110 .sp
 111
 112 .sp
 113 .TS
 114 c c c c
 115 c c c c .
 116 \fIRequest\fR   \fIInitial\fR   \fICause\fR     \fIExplanation\fR
 117         \fIValue\fR     \fIBreak\fR
 118 \fB\&.(c\fR     -       yes     Begin centered block.
 119 \fB\&.(d\fR     -       no      Begin delayed text.
 120 \fB\&.(f\fR     -       no      Begin footnote.
 121 \fB\&.(l\fR     -       yes     Begin list.
 122 \fB\&.(q\fR     -       yes     Begin major quote.
 123 \fB\&.(x\fR\fIx\fR      -       no      Begin indexed item in index \fIx\fR.
 124 \fB\&.(z\fR     -       no      Begin floating keep.
 125 \fB\&.)c\fR     -       yes     End centered block.
 126 \fB\&.)d\fR     -       yes     End delayed text.
 127 \fB\&.)f\fR     -       yes     End footnote.
 128 \fB\&.)l\fR     -       yes     End list.
 129 \fB\&.)q\fR     -       yes     End major quote.
 130 \fB\&.)x\fR     -       yes     End index item.
 131 \fB\&.)z\fR     -       yes     End floating keep.
 132 \fB\&.++\fR \fIm H\fR   -       no      Define paper section.
 133                         \fIm\fR defines the part of the paper,
 134                         T{
 135 and can be \fBC\fR (chapter), \fBA\fR (appendix), \fBP\fR (preliminary, for instance,
 136 T}
 137                         abstract, table of contents, etc.),
 138                         \fBB\fR (bibliography), \fBRC\fR (chapters
 139                         renumbered from page one each
 140                         chapter), or \fBRA\fR (appendix renumbered
 141                         from page one).
 142 \fB\&.+c \fR\fIT\fR     -       yes     Begin chapter (or appendix, etc.,
 143                         as set by \fB\&.++\fR).  \fIT\fR is
 144                         the chapter title.
 145 \fB\&.1c\fR     1       yes     One column format on a new page.
 146 \fB\&.2c\fR     1       yes     Two column format.
 147 \fB\&.EN\fR     -       yes     Space after equation produced by \fBeqn\fR
 148                         or \fBneqn\fR.
 149 \fB\&.EQ\fR \fIx y\fR   -       yes     Precede equation; break out and
 150                         add space.  Equation number is \fIy\fR.
 151                         The optional argument \fIx\fR may be \fII\fR
 152                         to indent equation (default),
 153                         \fIL\fR to left-adjust the equation, or
 154                         \fIC\fR to center the equation.
 155 \fB\&.GE\fR     -       yes     End \fIgremlin\fR picture.
 156 \fB\&.GS\fR     -       yes     Begin \fIgremlin\fR picture.
 157 \fB\&.PE\fR     -       yes     End \fBpic\fR picture.
 158 \fB\&.PS\fR     -       yes     Begin \fBpic\fR picture.
 159 \fB\&.TH\fR - YES "heading End, section"
 160 \fB\&.TE\fR     -       yes     End table.
 161 \fB\&.TS\fR \fIx\fR     -       yes     Begin table; if \fIx\fR is \fIH\fR table
 162                         has repeated heading.
 163 \fB\&.ac\fR \fIA N\fR   -       no      Set up for ACM style output.
 164                         \fIA\fR is the Author's name(s), \fIN\fR is the
 165                         total number of pages. Must be given
 166                         before the first initialization.
 167 \fB\&.b\fR \fIx\fR      no      no      Print \fIx\fR in boldface; if no argument
 168                         switch to boldface.
 169 \fB\&.ba\fR \fI+n\fR    0       yes     Augments the base indent by \fIn\fR.
 170                         This indent is used to set the indent
 171                         on regular text (like paragraphs).
 172 \fB\&.bc\fR     no      yes     Begin new column.
 173 \fB\&.bi\fR \fIx\fR     no      no      Print \fIx\fR in bold italics
 174                         (nofill only).
 175 \fB\&.bu\fR     -       yes     Begin bulleted paragraph.
 176 \fB\&.bx\fR \fIx\fR     no      no      Print \fIx\fR in a box (nofill only).
 177 \fB\&.ef\fR  \fI\&'x'y'z\fR     \&''''' no      Set even footer to \fIx y z\fR.
 178 \fB\&.eh\fR \fI\&'x'y'z\fR      \&''''' no      Set even header to \fIx y z\fR.
 179 \fB\&.fo\fR \fI\&'x'y'z\fR      \&''''' no      Set footer to \fIx y z\fR.
 180 \fB\&.hx\fR     -       no      Suppress headers and footers on
 181                         next page.
 182 \fB\&.he\fR \fI\&'x'y'z\fR      \&''''' no      Set header to \fIx  y  z\fR.
 183 \fB\&.hl\fR     -       yes     Draw a horizontal line.
 184 \fB\&.i\fR \fIx\fR      no      no      Italicize \fIx\fR; if \fIx\fR missing, italic
 185                         text follows.
 186 \fB\&.ip\fR \fIx y\fR   no      yes     Start indented paragraph, with
 187                         hanging tag \fIx\fR.  Indentation is
 188                         \fIy\fR ens (default 5).
 189 \fB\&.lp\fR     yes     yes     Start left-blocked paragraph.
 190 \fB\&.lo\fR     -       no      Read in a file of local macros
 191                         of the form \fB\&.*\fR\fIx.\fR Must be
 192                         given before initialization.
 193 \fB\&.np\fR     1       yes     Start numbered paragraph.
 194 \fB\&.of\fR \fI\&'x'y'z\fR      \&''''' no      Set odd footer to x  y  z.
 195 \fB\&.oh\fR \fI\&'x'y'z\fR      \&''''' no      Set odd header to x  y  z.
 196 \fB\&.pd\fR     -       yes     Print delayed text.
 197 \fB\&.pp\fR     no      yes     Begin paragraph. First line indented.
 198 \fB\&.r\fR      yes     no      Roman text follows.
 199 \fB\&.re\fR     -       no      Reset tabs to default values.
 200 \fB\&.sc\fR     no      no      Read in a file of special characters
 201                         and diacritical marks.  Must be
 202                         given before initialization.
 203 \fB\&.sh\fR \fIn x\fR   -       yes     Section head follows, font
 204                         automatically bold.  \fIn\fR is level
 205                         of section, \fIx\fR is title of section.
 206 \fB\&.sk\fR     no      no      Leave the next page blank.
 207                         Only one page is remembered ahead.
 208 \fB\&.sm\fR \fIx\fR     -       no      Set \fIx\fR in a smaller pointsize.
 209 \fB\&.sz\fR \fI+n\fR    10p     no      Augment the point size by \fIn\fR points.
 210 \fB\&.th\fR     no      no      Produce the paper in thesis format.
 211                         Must be given before initialization.
 212 \fB\&.tp\fR     no      yes     Begin title page.
 213 \fB\&.u\fR \fIx\fR      -       no      Underline argument (even in \fBtroff\fR).
 214                         (Nofill only).
 215 \fB\&.uh\fR     -       yes     Like \fB\&.sh\fR but unnumbered.
 216 \fB\&.xp\fR \fIx\fR     -       no      Print index \fIx\fR.
 217 .TE
 218
 219 .SH FILES
 220 .sp
 221 .ne 2
 222 .na
 223 \fB\fB/usr/share/lib/tmac/e\fR\fR
 224 .ad
 225 .RS 28n
 226
 227 .RE
 228
 229 .sp
 230 .ne 2
 231 .na
 232 \fB\fB/usr/share/lib/tmac/*.me\fR\fR
 233 .ad
 234 .RS 28n
 235
 236 .RE
 237
 238 .SH SEE ALSO
 239 .sp
 240 .LP
 241 \fBcol\fR(1), \fBeqn\fR(1), \fBnroff\fR(1), \fBrefer\fR(1), \fBtbl\fR(1),
 242 \fBtroff\fR(1)