contrib/groff/tmac/groff_me.man

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