tmac/groff_me.man

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