man/tmac-me.7.in

   1 '\" t
   2 .\"@ @L_ROFF@_me.7
   3 .\"
   4 .\" Copyright (c) 1980 The Regents of the University of California.
   5 .\" All rights reserved.
   6 .\"
   7 .\" Redistribution and use in source and binary forms are permitted
   8 .\" provided that the above copyright notice and this paragraph are
   9 .\" duplicated in all such forms and that any documentation,
  10 .\" advertising materials, and other materials related to such
  11 .\" distribution and use acknowledge that the software was developed
  12 .\" by the University of California, Berkeley.  The name of the
  13 .\" University may not be used to endorse or promote products derived
  14 .\" from this software without specific prior written permission.
  15 .\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
  16 .\" IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
  17 .\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
  18 .\"
  19 .\"     @(#)me.7        6.4 (Berkeley) 4/13/90
  20 .\"
  21 .\" Modified for groff by jjc@jclark.com
  22 .\" Modified for S-roff by Steffen (Daode) Nurpmeso <steffen@sdaoden.eu>.
  23 .hc %
  24 .TH @U_ROFF@_ME @MAN7EXT@ "@MDATE@" "@T_ROFF@ v@VERSION@"
  25 .UC 3
  26 .
  27 .\"
  28 .SH NAME
  29 @L_ROFF@_me \- troff macros for formatting papers
  30 .
  31 .\"
  32 .SH SYNOPSIS
  33 .
  34 .B "@L_ROFF@ \-me"
  35 [ options ]
  36 file ...
  37 .br
  38 .B "@L_ROFF@ \-m\ me"
  39 [ options ]
  40 file ...
  41 .
  42 .\"
  43 .SH DESCRIPTION
  44 .
  45 This manual page describes the @T_ROFF@ version of the \-me macros.
  46 This version can be used with @T_ROFF@, GNU troff and Unix troff.
  47 This package of
  48 .I troff
  49 macro definitions provides a canned formatting
  50 facility for technical papers in various formats.
  51 .PP
  52 The macro requests are defined below.
  53 Many
  54 .I troff
  55 requests are unsafe in conjunction with this package, however, these
  56 requests may be used with impunity after the first \&.pp:
  57 .TS
  58 l l.
  59 \&.bp   begin new page
  60 \&.br   break output line here
  61 \&.sp n insert n spacing lines
  62 \&.ls n (line spacing) n=1 single, n=2 double space
  63 \&.na   no alignment of right margin
  64 \&.ce n center next n lines
  65 \&.ul n underline next n lines
  66 .TE
  67 .
  68 .PP
  69 Output of the
  70 .I @L_P_PIC@,
  71 .I @L_P_EQN@,
  72 .I @L_P_REFER@,
  73 and
  74 .I @L_P_TBL@
  75 preprocessors
  76 is acceptable as input.
  77 .
  78 .\"
  79 .SH FILES
  80 .
  81 @MACRODIR@/me.tmac (a wrapper file for e.tmac)
  82 .br
  83 @MACRODIR@/e.tmac
  84 .
  85 .\"
  86 .SH "SEE ALSO"
  87 .
  88 .BR @L_ROFF@ (@MAN1EXT@),
  89 .BR @L_TROFF@ (@MAN1EXT@)
  90 .br
  91 \-me Reference Manual, Eric P.\& Allman
  92 .br
  93 Writing Papers with Groff Using \-me
  94 .
  95 .\"
  96 .SH REQUESTS
  97 .
  98 This list is incomplete;
  99 see
 100 .I "The \-me Reference Manual"
 101 for interesting details.
 102 .
 103 .PP
 104 .na
 105 .TS
 106 l l l lx.
 107 Request Initial Causes  Explanation
 108         Value   Break
 109 _
 110 \&.(c   \-      yes     T{
 111 Begin centered block
 112 T}
 113 \&.(d   \-      no      T{
 114 Begin delayed text
 115 T}
 116 \&.(f   \-      no      Begin footnote
 117 \&.(l   \-      yes     Begin list
 118 \&.(q   \-      yes     T{
 119 Begin major quote
 120 T}
 121 \&.(x \fIx\fR   \-      no      T{
 122 Begin indexed item in index
 123 T}
 124 \&.(z   \-      no      T{
 125 Begin floating keep
 126 T}
 127 \&.)c   \-      yes     T{
 128 End centered block
 129 T}
 130 \&.)d   \-      yes     T{
 131 End delayed text
 132 T}
 133 \&.)f   \-      yes     End footnote
 134 \&.)l   \-      yes     End list
 135 \&.)q   \-      yes     T{
 136 End major quote
 137 T}
 138 \&.)x   \-      yes     T{
 139 End index item
 140 T}
 141 \&.)z   \-      yes     T{
 142 End floating keep
 143 T}
 144 \&.++ \fIm H\fR \-      no      T{
 145 Define paper section.
 146 .I m
 147 defines the part of the paper, and can be
 148 .B C
 149 (chapter),
 150 .B A
 151 (appendix),
 152 .B P
 153 (preliminary, e.g., abstract, table of contents, etc.),
 154 .B B
 155 (bibliography),
 156 .B RC
 157 (chapters renumbered from page one each chapter),
 158 or
 159 .B RA
 160 (appendix renumbered from page one).
 161 T}
 162 \&.+c \fIT\fR   \-      yes     T{
 163 Begin chapter (or appendix, etc., as
 164 set by \&.++).
 165 .I T
 166 is the chapter title.
 167 T}
 168 \&.1c   1       yes     T{
 169 One column format on a new page.
 170 T}
 171 \&.2c   1       yes     T{
 172 Two column format.
 173 T}
 174 \&.EN   \-      yes     T{
 175 Space after equation
 176 produced by
 177 .I eqn
 178 or
 179 .IR neqn .
 180 T}
 181 \&.EQ \fIx y\fR \-      yes     T{
 182 Precede equation; break out and
 183 add space.
 184 Equation number is
 185 .IR y .
 186 The optional argument \fIx\fR
 187 may be
 188 .I I
 189 to indent equation (default),
 190 .I L
 191 to left-adjust the equation, or
 192 .I C
 193 to center the equation.
 194 T}
 195 \&.GE   \-      yes     T{
 196 End \fIgremlin\fP picture.
 197 T}
 198 \&.GS   \-      yes     T{
 199 Begin \fIgremlin\fP picture.
 200 T}
 201 \&.PE   \-      yes     T{
 202 End \fIpic\fP picture.
 203 T}
 204 \&.PS   \-      yes     T{
 205 Begin \fIpic\fP picture.
 206 T}
 207 \&.TE   \-      yes     End table.
 208 \&.TH   \-      yes     T{
 209 End heading section of table.
 210 T}
 211 \&.TS \fIx\fR   \-      yes     T{
 212 Begin table; if \fIx\fR is
 213 .I H
 214 table has repeated heading.
 215 T}
 216 \&.b \fIx\fR    no      no      T{
 217 Print
 218 .I x
 219 in boldface; if no argument switch to boldface.
 220 T}
 221 \&.ba \fI+n\fR  0       yes     T{
 222 Augments the base indent by
 223 .I n.
 224 This indent is used to set the indent on regular text
 225 (like paragraphs).
 226 T}
 227 \&.bc   no      yes     T{
 228 Begin new column
 229 T}
 230 \&.bi \fIx\fR   no      no      T{
 231 Print
 232 .I x
 233 in bold italics (nofill only)
 234 T}
 235 \&.bu   \-      yes     T{
 236 Begin bulleted paragraph
 237 T}
 238 \&.bx \fIx\fR   no      no      T{
 239 Print \fIx\fR in a box (nofill only).
 240 T}
 241 \&.ef \fI\'x\'y\'z\'\fR \'\'\'\'        no      T{
 242 Set even footer to x  y  z
 243 T}
 244 \&.eh \fI\'x\'y\'z\'\fR \'\'\'\'        no      T{
 245 Set even header to x  y  z
 246 T}
 247 \&.fo \fI\'x\'y\'z\'\fR \'\'\'\'        no      T{
 248 Set footer to x  y  z
 249 T}
 250 \&.hx   \-      no      T{
 251 Suppress headers and footers on next page.
 252 T}
 253 \&.he \fI\'x\'y\'z\'\fR \'\'\'\'        no      T{
 254 Set header to x  y  z
 255 T}
 256 \&.hl   \-      yes     T{
 257 Draw a horizontal line
 258 T}
 259 \&.i \fIx\fR    no      no      T{
 260 Italicize
 261 .I x;
 262 if
 263 .I x
 264 missing, italic text follows.
 265 T}
 266 \&.ip \fIx y\fR no      yes     T{
 267 Start indented paragraph,
 268 with hanging tag
 269 .IR x .
 270 Indentation is
 271 .I y
 272 ens (default 5).
 273 T}
 274 \&.lp   yes     yes     T{
 275 Start left-blocked paragraph.
 276 T}
 277 \&.np   1       yes     T{
 278 Start numbered paragraph.
 279 T}
 280 \&.of \fI\'x\'y\'z\'\fR \'\'\'\'        no      T{
 281 Set odd footer to x  y  z
 282 T}
 283 \&.oh \fI\'x\'y\'z\'\fR \'\'\'\'        no      T{
 284 Set odd header to x  y  z
 285 T}
 286 \&.pd   \-      yes     T{
 287 Print delayed text.
 288 T}
 289 \&.pp   no      yes     T{
 290 Begin paragraph.
 291 First line indented.
 292 T}
 293 \&.r    yes     no      T{
 294 Roman text follows.
 295 T}
 296 \&.re   \-      no      T{
 297 Reset tabs to default values.
 298 T}
 299 \&.sh \fIn x\fR \-      yes     T{
 300 Section head follows,
 301 font automatically bold.
 302 .I n
 303 is level of section,
 304 .I x
 305 is title of section.
 306 T}
 307 \&.sk   no      no      T{
 308 Leave the next page blank.
 309 Only one page is remembered ahead.
 310 T}
 311 \&.sm \fIx\fR   \-      no      T{
 312 Set
 313 .I x
 314 in a smaller pointsize.
 315 T}
 316 \&.sz \fI+n\fR  10p     no      T{
 317 Augment the point size by
 318 .I n
 319 points.
 320 T}
 321 \&.tp   no      yes     T{
 322 Begin title page.
 323 T}
 324 \&.u \fIx\fR    \-      no      T{
 325 Underline argument (even in \fItroff\fR).
 326 (Nofill only).
 327 T}
 328 \&.uh   \-      yes     T{
 329 Like .sh but unnumbered.
 330 T}
 331 \&.xp \fIx\fR   \-      no      Print index.
 332 .TE
 333 .ad
 334 .
 335 .\" s-ts-mode