man/tmac-me.7.in

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