Annotation of 43BSDReno/share/me/me.7, revision 1.1.1.1

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

unix.superglobalmegacorp.com

This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.