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