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 "troff \-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@/tmac.e
  69 .SH "SEE ALSO"
  70 .BR groff (@MAN1EXT@),
  71 .BR @g@troff (@MAN1EXT@)
  72 .br
  73 \-me Reference Manual, Eric P. Allman
  74 .br
  75 Writing Papers with Groff Using \-me
  76 .tr &.
  77 .SH REQUESTS
  78 This list is incomplete;
  79 see
  80 .I "The \-me Reference Manual"
  81 for interesting details.
  82 .PP
  83 .ta \w'.eh \'x\'y\'z\'  'u +\w'Initial 'u +\w'Cause 'u
  84 .br
  85 .di x
  86                         \ka
  87 .br
  88 .di
  89 .in \nau
  90 .ti 0
  91 Request Initial Cause   Explanation
  92 .ti 0
  93         Value   Break
  94 .br
  95 .in \nau
  96 .ti 0
  97 \&.(c   -       yes     Begin centered block
  98 .ti 0
  99 \&.(d   -       no      Begin delayed text
 100 .ti 0
 101 \&.(f   -       no      Begin footnote
 102 .ti 0
 103 \&.(l   -       yes     Begin list
 104 .ti 0
 105 \&.(q   -       yes     Begin major quote
 106 .ti 0
 107 \&.(x \fIx\fR   -       no      Begin indexed item in index
 108 .I x
 109 .ti 0
 110 \&.(z   -       no      Begin floating keep
 111 .ti 0
 112 \&.)c   -       yes     End centered block
 113 .ti 0
 114 \&.)d   -       yes     End delayed text
 115 .ti 0
 116 \&.)f   -       yes     End footnote
 117 .ti 0
 118 \&.)l   -       yes     End list
 119 .ti 0
 120 \&.)q   -       yes     End major quote
 121 .ti 0
 122 \&.)x   -       yes     End index item
 123 .ti 0
 124 \&.)z   -       yes     End floating keep
 125 .ti 0
 126 \&.++ \fIm H\fR -       no      Define paper section.
 127 .I m
 128 defines the part of the paper, and can be
 129 .B C
 130 (chapter),
 131 .B A
 132 (appendix),
 133 .B P
 134 (preliminary, e.g., abstract, table of contents, etc.),
 135 .B B
 136 (bibliography),
 137 .B RC
 138 (chapters renumbered from page one each chapter),
 139 or
 140 .B RA
 141 (appendix renumbered from page one).
 142 .ti 0
 143 \&.+c \fIT\fR   -       yes     Begin chapter (or appendix, etc., as
 144 set by .++).
 145 .I T
 146 is the chapter title.
 147 .ti 0
 148 \&.1c   1       yes     One column format on a new page.
 149 .ti 0
 150 \&.2c   1       yes     Two column format.
 151 .ti 0
 152 \&.EN   -       yes     Space after equation
 153 produced by
 154 .I eqn
 155 or
 156 .IR neqn .
 157 .ti 0
 158 \&.EQ \fIx y\fR -       yes     Precede equation; break out and
 159 add space.
 160 Equation number is
 161 .IR y .
 162 The optional argument \fIx\fR
 163 may be
 164 .I I
 165 to indent equation (default),
 166 .I L
 167 to left-adjust the equation, or
 168 .I C
 169 to center the equation.
 170 .ti 0
 171 \&.GE   -       yes     End \fIgremlin\fP picture.
 172 .ti 0
 173 \&.GS   -       yes     Begin \fIgremlin\fP picture.
 174 .ti 0
 175 \&.PE   -       yes     End \fIpic\fP picture.
 176 .ti 0
 177 \&.PS   -       yes     Begin \fIpic\fP picture.
 178 .ti 0
 179 \&.TE   -       yes     End table.
 180 .ti 0
 181 \&.TH   -       yes     End heading section of table.
 182 .ti 0
 183 \&.TS \fIx\fR   -       yes     Begin table; if \fIx\fR is
 184 .I H
 185 table has repeated heading.
 186 .ti 0
 187 \&.b \fIx\fR    no      no      Print
 188 .I x
 189 in boldface; if no argument switch to boldface.
 190 .ti 0
 191 \&.ba \fI+n\fR  0       yes     Augments the base indent by
 192 .I n.
 193 This indent is used to set the indent on regular text
 194 (like paragraphs).
 195 .ti 0
 196 \&.bc   no      yes     Begin new column
 197 .ti 0
 198 \&.bi \fIx\fR   no      no      Print
 199 .I x
 200 in bold italics (nofill only)
 201 .ti 0
 202 \&.bu   -       yes     Begin bulleted paragraph
 203 .ti 0
 204 \&.bx \fIx\fR   no      no      Print \fIx\fR in a box (nofill only).
 205 .ti 0
 206 \&.ef \fI\'x\'y\'z\'\fR \'\'\'\'        no      Set even footer to x  y  z
 207 .ti 0
 208 \&.eh \fI\'x\'y\'z\'\fR \'\'\'\'        no      Set even header to x  y  z
 209 .ti 0
 210 \&.fo \fI\'x\'y\'z\'\fR \'\'\'\'        no      Set footer to x  y  z
 211 .ti 0
 212 \&.hx   -       no      Suppress headers and footers on next page.
 213 .ti 0
 214 \&.he \fI\'x\'y\'z\'\fR \'\'\'\'        no      Set header to x  y  z
 215 .ti 0
 216 \&.hl   -       yes     Draw a horizontal line
 217 .ti 0
 218 \&.i \fIx\fR    no      no      Italicize
 219 .I x;
 220 if
 221 .I x
 222 missing, italic text follows.
 223 .ti 0
 224 \&.ip \fIx y\fR no      yes     Start indented paragraph,
 225 with hanging tag
 226 .IR x .
 227 Indentation is
 228 .I y
 229 ens (default 5).
 230 .ti 0
 231 \&.lp   yes     yes     Start left-blocked paragraph.
 232 .ti 0
 233 \&.np   1       yes     Start numbered paragraph.
 234 .ti 0
 235 \&.of \fI\'x\'y\'z\'\fR \'\'\'\'        no      Set odd footer to x  y  z
 236 .ti 0
 237 \&.oh \fI\'x\'y\'z\'\fR \'\'\'\'        no      Set odd header to x  y  z
 238 .ti 0
 239 \&.pd   -       yes     Print delayed text.
 240 .ti 0
 241 \&.pp   no      yes     Begin paragraph.
 242 First line indented.
 243 .ti 0
 244 \&.r    yes     no      Roman text follows.
 245 .ti 0
 246 \&.re   -       no      Reset tabs to default values.
 247 .ti 0
 248 \&.sh \fIn x\fR -       yes     Section head follows,
 249 font automatically bold.
 250 .I n
 251 is level of section,
 252 .I x
 253 is title of section.
 254 .ti 0
 255 \&.sk   no      no      Leave the next page blank.
 256 Only one page is remembered ahead.
 257 .ti 0
 258 \&.sm \fIx\fR   -       no      Set
 259 .I x
 260 in a smaller pointsize.
 261 .ti 0
 262 \&.sz \fI+n\fR  10p     no      Augment the point size by
 263 .I n
 264 points.
 265 .ti 0
 266 \&.tp   no      yes     Begin title page.
 267 .ti 0
 268 \&.u \fIx\fR    -       no      Underline argument (even in \fItroff\fR).
 269 (Nofill only).
 270 .ti 0
 271 \&.uh   -       yes     Like .sh but unnumbered.
 272 .ti 0
 273 \&.xp \fIx\fR   -       no      Print index
 274 .I x.