share/me/orig_me.7

   1 .\" Copyright (c) 1980, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  16 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)me.7        8.1 (Berkeley) 6/5/93
  33 .\" $FreeBSD$
  34 .\"
  35 .hc %
  36 .TH ORIG_ME 7 "June 5, 1993"
  37 .UC 3
  38 .SH NAME
  39 orig_me \- macros for formatting papers
  40 .SH SYNOPSIS
  41 .B "nroff \-orig_me"
  42 [ options ]
  43 file ...
  44 .br
  45 .B "troff \-orig_me"
  46 [ options ]
  47 file ...
  48 .SH DESCRIPTION
  49 This package of
  50 .I nroff
  51 and
  52 .I troff
  53 macro definitions provides a canned formatting
  54 facility for tech%nical papers in various formats.
  55 When producing 2-column output on a terminal, filter
  56 the output through
  57 .IR  col (1).
  58 .PP
  59 The macro requests are defined below.
  60 Many
  61 .I nroff
  62 and
  63 .I troff
  64 requests are unsafe in conjunction with
  65 this package, however, these requests may be used with
  66 impunity after the first .pp:
  67 .nf
  68 .IP
  69 .ta \w'.sz +n  'u
  70 \&.bp   begin new page
  71 \&.br   break output line here
  72 \&.sp n insert n spacing lines
  73 \&.ls n (line spacing) n=1 single, n=2 double space
  74 \&.na   no alignment of right margin
  75 \&.ce n center next n lines
  76 \&.ul n underline next n lines
  77 \&.sz +n        add n to point size
  78 .fi
  79 .PP
  80 Output of the
  81 .I eqn,
  82 .I neqn,
  83 .I refer,
  84 and
  85 .IR  tbl (1)
  86 preprocessors
  87 for equations and tables is acceptable as input.
  88 .SH FILES
  89 /usr/share/tmac/tmac.e
  90 .br
  91 /usr/share/me/*
  92 .SH "SEE ALSO"
  93 eqn(1), troff(1), refer(1), tbl(1)
  94 .br
  95 \-me Reference Manual, Eric P. Allman
  96 .br
  97 Writing Papers with Nroff Using \-me
  98 .tr &.
  99 .SH REQUESTS
 100 In the following list,
 101 \*(lqinitialization\*(rq
 102 refers to the first .pp, .lp, .ip, .np, .sh, or .uh macro.
 103 This list is incomplete;
 104 see
 105 .I "The \-me Reference Manual"
 106 for interesting details.
 107 .PP
 108 .ta \w'.eh \'x\'y\'z\'  'u +\w'Initial 'u +\w'Cause 'u
 109 .br
 110 .di x
 111                         \ka
 112 .br
 113 .di
 114 .in \nau
 115 .ti 0
 116 Request Initial Cause   Explanation
 117 .ti 0
 118         Value   Break
 119 .br
 120 .in \nau
 121 .ti 0
 122 \&.(c   -       yes     Begin centered block
 123 .ti 0
 124 \&.(d   -       no      Begin delayed text
 125 .ti 0
 126 \&.(f   -       no      Begin footnote
 127 .ti 0
 128 \&.(l   -       yes     Begin list
 129 .ti 0
 130 \&.(q   -       yes     Begin major quote
 131 .ti 0
 132 \&.(x \fIx\fR   -       no      Begin indexed item in index
 133 .I x
 134 .ti 0
 135 \&.(z   -       no      Begin floating keep
 136 .ti 0
 137 \&.)c   -       yes     End centered block
 138 .ti 0
 139 \&.)d   -       yes     End delayed text
 140 .ti 0
 141 \&.)f   -       yes     End footnote
 142 .ti 0
 143 \&.)l   -       yes     End list
 144 .ti 0
 145 \&.)q   -       yes     End major quote
 146 .ti 0
 147 \&.)x   -       yes     End index item
 148 .ti 0
 149 \&.)z   -       yes     End floating keep
 150 .ti 0
 151 \&.++ \fIm H\fR -       no      Define paper section.
 152 .I m
 153 defines the part of the paper, and can be
 154 .B C
 155 (chapter),
 156 .B A
 157 (appendix),
 158 .B P
 159 (preliminary, e.g., abstract, table of contents, etc.),
 160 .B B
 161 (bibliography),
 162 .B RC
 163 (chapters renumbered from page one each chapter),
 164 or
 165 .B RA
 166 (appendix renumbered from page one).
 167 .ti 0
 168 \&.+c \fIT\fR   -       yes     Begin chapter (or appendix, etc., as
 169 set by .++).
 170 .I T
 171 is the chapter title.
 172 .ti 0
 173 \&.1c   1       yes     One column format on a new page.
 174 .ti 0
 175 \&.2c   1       yes     Two column format.
 176 .ti 0
 177 \&.EN   -       yes     Space after equation
 178 produced by
 179 .I eqn
 180 or
 181 .IR neqn .
 182 .ti 0
 183 \&.EQ \fIx y\fR -       yes     Precede equation; break out and
 184 add space.
 185 Equation number is
 186 .IR y .
 187 The optional argument \fIx\fR
 188 may be
 189 .I I
 190 to indent equation (default),
 191 .I L
 192 to left-adjust the equation, or
 193 .I C
 194 to center the equation.
 195 .ti 0
 196 \&.GE   -       yes     End \fIgremlin\fP picture.
 197 .ti 0
 198 \&.GS   -       yes     Begin \fIgremlin\fP picture.
 199 .ti 0
 200 \&.PE   -       yes     End \fIpic\fP picture.
 201 .ti 0
 202 \&.PS   -       yes     Begin \fIpic\fP picture.
 203 .ti 0
 204 \&.TE   -       yes     End table.
 205 .ti 0
 206 \&.TH   -       yes     End heading section of table.
 207 .ti 0
 208 \&.TS \fIx\fR   -       yes     Begin table; if \fIx\fR is
 209 .I H
 210 table has repeated heading.
 211 .ti 0
 212 \&.ac \fIA N\fR -       no      Set up for ACM style output.
 213 .I A
 214 is the Author's name(s),
 215 .I N
 216 is the total number of pages.
 217 Must be given before the first initialization.
 218 .ti 0
 219 \&.b \fIx\fR    no      no      Print
 220 .I x
 221 in boldface; if no argument switch to boldface.
 222 .ti 0
 223 \&.ba \fI+n\fR  0       yes     Augments the base indent by
 224 .I n.
 225 This indent is used to set the indent on regular text
 226 (like paragraphs).
 227 .ti 0
 228 \&.bc   no      yes     Begin new column
 229 .ti 0
 230 \&.bi \fIx\fR   no      no      Print
 231 .I x
 232 in bold italics (nofill only)
 233 .ti 0
 234 \&.bu   -       yes     Begin bulleted paragraph
 235 .ti 0
 236 \&.bx \fIx\fR   no      no      Print \fIx\fR in a box (nofill only).
 237 .ti 0
 238 \&.ef \fI\'x\'y\'z\'\fR \'\'\'\'        no      Set even footer to x  y  z
 239 .ti 0
 240 \&.eh \fI\'x\'y\'z\'\fR \'\'\'\'        no      Set even header to x  y  z
 241 .ti 0
 242 \&.fo \fI\'x\'y\'z\'\fR \'\'\'\'        no      Set footer to x  y  z
 243 .ti 0
 244 \&.hx   -       no      Suppress headers and footers on next page.
 245 .ti 0
 246 \&.he \fI\'x\'y\'z\'\fR \'\'\'\'        no      Set header to x  y  z
 247 .ti 0
 248 \&.hl   -       yes     Draw a horizontal line
 249 .ti 0
 250 \&.i \fIx\fR    no      no      Italicize
 251 .I x;
 252 if
 253 .I x
 254 missing, italic text follows.
 255 .ti 0
 256 \&.ip \fIx y\fR no      yes     Start indented paragraph,
 257 with hanging tag
 258 .IR x .
 259 Indentation is
 260 .I y
 261 ens (default 5).
 262 .ti 0
 263 \&.lp   yes     yes     Start left-blocked paragraph.
 264 .ti 0
 265 \&.lo   -       no      Read in a file of local macros of the
 266 form
 267 .BI \&.* x.
 268 Must be given before initialization.
 269 .ti 0
 270 \&.np   1       yes     Start numbered paragraph.
 271 .ti 0
 272 \&.of \fI\'x\'y\'z\'\fR \'\'\'\'        no      Set odd footer to x  y  z
 273 .ti 0
 274 \&.oh \fI\'x\'y\'z\'\fR \'\'\'\'        no      Set odd header to x  y  z
 275 .ti 0
 276 \&.pd   -       yes     Print delayed text.
 277 .ti 0
 278 \&.pp   no      yes     Begin paragraph.
 279 First line indented.
 280 .ti 0
 281 \&.r    yes     no      Roman text follows.
 282 .ti 0
 283 \&.re   -       no      Reset tabs to default values.
 284 .ti 0
 285 \&.sc   no      no      Read in a file of special characters
 286 and diacritical marks.
 287 Must be given before initialization.
 288 .ti 0
 289 \&.sh \fIn x\fR -       yes     Section head follows,
 290 font automatically bold.
 291 .I n
 292 is level of section,
 293 .I x
 294 is title of section.
 295 .ti 0
 296 \&.sk   no      no      Leave the next page blank.
 297 Only one page is remembered ahead.
 298 .ti 0
 299 \&.sm \fIx\fR   -       no      Set
 300 .I x
 301 in a smaller pointsize.
 302 .ti 0
 303 \&.sz \fI+n\fR  10p     no      Augment the point size by
 304 .I n
 305 points.
 306 .ti 0
 307 \&.th   no      no      Produce the paper in thesis format.
 308 Must be given before initialization.
 309 .ti 0
 310 \&.tp   no      yes     Begin title page.
 311 .ti 0
 312 \&.u \fIx\fR    -       no      Underline argument (even in \fItroff\fR).
 313 (Nofill only).
 314 .ti 0
 315 \&.uh   -       yes     Like .sh but unnumbered.
 316 .ti 0
 317 \&.xp \fIx\fR   -       no      Print index
 318 .I x.