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