doc/mn.txt

   1 MN(7)                  Miscellaneous Information Manual                  MN(7)
   2
   3
   4
   5 NAME
   6        mn - text formatting macros for the news documentation
   7
   8 SYNOPSIS
   9        nroff  -mn [ options ]  file  ...
  10        troff  -mn [ options ]  file  ...
  11
  12 DESCRIPTION
  13        This package of nroff(1) and troff(1) macro definitions provides a for-
  14        matting facility which may be used to run off the formatted news  docu-
  15        ments.  When reverse line motions are needed, filter the output through
  16        col(1).
  17
  18        All -mn macros, diversions, string registers, and number registers  are
  19        defined below.  Many nroff and troff requests are unsafe in conjunction
  20        with this package.  However,  the  requests  below  may  be  used  with
  21        impunity:
  22
  23             .bp    begin new page
  24             .br    break output line
  25             .sp n  insert n spacing lines
  26             .ce n  center next n lines
  27             .ls n  line spacing: n=1 single, n=2 double space
  28             .na    no alignment of right margin
  29
  30        Font  and point size changes with \f and \s are also allowed; for exam-
  31        ple, ``\f2word\fR'' will italicize word.  Output of the tbl(1), eqn(1),
  32        and  refer(1)  preprocessors  for  equations, tables, and references is
  33        acceptable as input.
  34
  35 FILES
  36        /usr/lib/tmac/tmac.n
  37
  38 SEE ALSO
  39        eqn(1), refer(1), tbl(1), troff(1)
  40
  41 WARNINGS
  42        If you do not set the string register ``.f'' to the file name, you will
  43        only  be told the line number on which any errors occur.  If you define
  44        this string to be the file name, you will get the file name, too.  This
  45        is useful when dealing with a document split up into many files.
  46
  47        This package is not now intended for uses other than with the news doc-
  48        umentation.
  49
  50        Bug reports are  always  welcome;  please  send  them  to  the  author.
  51        (Include a sample of the input; this helps track down the bug.)
  52
  53 AUTHOR
  54        Matt     Bishop     (mab@riacs.arpa,     ihnp4!ames!riacs!mab,     dec-
  55        vax!decwrl!riacs!mab)
  56        Updated for versions 1.4-1.6 by The NetHack Development Team
  57
  58 REQUESTS
  59        In the Note column, b means the request causes a break, and i means the
  60        macro,  number  register, string register, or diversion is internal and
  61        should not be used for anything.  In the What It Is column,  div  means
  62        diversion,  mac  means  macro, num means number register, and str means
  63        string register.  In the Initial Value column, a hyphen means  no  ini-
  64        tial value is used, anything else is the initial value, and if two val-
  65        ues are given, the first is for nroff and the second for troff.
  66
  67 Macro     What    Initial   Note   Explanation
  68 Name      It Is   Value
  69 .f        num     -         -    file name, used in error messages if set
  70 .ai       mac     -         -    author's institution
  71 .au       mac     -         b    author's name
  72 .b x y z  mac     -         -    print x in font 3, y after, z before;
  73                                  if no arguments, switch to font 3
  74 b         num     -         i    used to embolden italics
  75 .bi x y z mac     -         -    print x in emboldened font 2, y after,
  76                                  z before
  77 bm        num     1i,1i+1v  -    height of bottom margin
  78 .bt       mac     -         -    print pottom title
  79 bt        num     .5i+1v    -    bottom of footer to bottom of page
  80 .cf x y z mac     -         -    print contents of header line (double
  81                                  quotes around x, y before, z after)
  82 cm        num     0         -    0 if no cut marks, nonzero if cut marks
  83 .cn x y z mac     -         -    print computer/site name; same as .i
  84 .dd       div     -         i    text of display
  85 dg        str     *,-       -    footnote mark
  86 dw        str     current   -    name of current day of week
  87 dy        str     current   -    full date
  88 .ed       mac     -         b    end display
  89 .ef       mac     -         b    end footnote
  90 .ei       mac     -         b    move left margin to the right
  91 .er       mac     -         -    print error message
  92 .et       mac     -         b,i  macro called at end of text
  93 f0        str     -         -    left bottom title
  94 f1        num     -         i    current font number
  95 f1        str     date,-    -    center bottom title
  96 f2        num     -         i    previous font number
  97 f2        str     -         -    right bottom title
  98 fc        num     -         i    per-page footnote count
  99 .fd       mac     -         b,i  drop footnotes
 100 fg        num     -         i    gets fudge factor for footnote
 101 fl        num     5.5i      -    default footnote line length
 102 .fn       mac     -         -    begin footnote
 103 .fo       mac     -         -    bottom of page (footer) macro
 104 fp        num     -         i    current location of trap for .fo macro
 105 .fs       mac     -         i    print text/footnote separator
 106 fs        num     -         i    position where footnote printing should begin
 107 .fx       mac     -         i    collect overflow footnotes
 108 .fy       div     -         i    text of footnote overflow
 109 .fz       mac     -         i    move overflow footnotes from .fy to .tf
 110 gs        num     -         i    used to be sure footnotes fit
 111 h0        num     0         i    current level 1 section number
 112 h0        str     -         -    left header title
 113 h1        num     0         i    current level 2 section number
 114 h1        str     - page -  -    center header title
 115 h2        num     0         i    current level 3 section number
 116 h2        str     -         -    right header title
 117 h3        num     0         i    current level 4 section number
 118 .hd       mac     -         i    top of page (header) macro
 119 .hf       mac     -         -    print header field name; same as .cf
 120 .hn x     mac     -         b    numbered section; if present, x is level
 121 hn        num     0         i    current level of numbering (temporary)
 122 hs        num     1v        -    default intra-section spacing
 123 .hu       mac     -         b    unnumbered section header
 124 .i x y z  mac     -         -    print x in font 2, y after, z before;
 125                                  if no arguments, switch to font 2
 126 i1        num     -         i    current indent
 127 i2        num     -         i    previous indent
 128 id        num     0         i    1 if in display, 0 otherwise
 129 if        num     0         i    1 if in footnote, 0 otherwise
 130 .is x y z mac     -         -    print x 2p bigger, y after, z before;
 131                                  if no arguments, increase point size by 2p
 132 it        num     0         i    0 before .bt called, 1 after
 133 l0        num     0         i    leftmost position for left margin
 134 l1        num     -         i    first level of indent for left margin
 135 l2        num     -         i    second level of indent for left margin
 136 l3        num     -         i    third level of indent for left margin
 137 l4        num     -         i    fourth level of indent for left margin
 138 l5        num     -         i    fifth level of indent for left margin
 139 l6        num     -         i    sixth level of indent for left margin
 140 l7        num     -         i    seventh level of indent for left margin
 141 l8        num     -         i    eighth level of indent for left margin
 142 l9        num     -         i    ninth level of indent for left margin
 143 li        num     5n        -    paragraph indent
 144 ll        num     6i        -    default line length
 145 lm        num     0         i    current level of indent for left margin
 146 lo        num     -         i    previous level for left margin
 147 .lp x y   mac     -         b    labelled paragraph; x is label, y indent
 148 lq        str     ",``      -    left double quotation marks
 149 mo        str     current   -    name of current month
 150 .mt       mac     -         b    title
 151 mt        num     1.5i+1v   -    distance of title from top of page
 152 .ng x y z mac     -         -    newsgroup name; same as .b
 153 .nl       mac     -         b    reset point size to default
 154 ns        num     0         i    if nonzero, .fn does not call .fs
 155 .op x y z mac     -         -    command option; same as .b
 156 p1        num     0         i    1 after PDP-11(tm) footnote printed,
 157                                  0 before
 158 .pa x y z mac     -         -    print protocol appellation; same as .i
 159 .pd x y   mac     -         -    print PDP-11(tm), footnote; x after,
 160                                  y before
 161 pd        num     1v,.3v    -    intra-paragraph spacing
 162 .pf       mac     -         -    print footer title
 163 .pg x     mac     -         b    paragraph; if x is l, left justify
 164 pi        num     5n        -    default paragraph indent
 165 po        num     1.25i     -    default page offset
 166 ps        num     12p       -    default point size
 167 .pt x     mac     -         -    print header; x is distance from top of
 168                                  page
 169 .qc x y z mac     -         -    print name of control char; x is name,
 170                                  in font 3, between <>, y after, z before
 171 .qp x y z mac     -         -    print char; same as .b
 172 .r        mac     -         -    switch to font 1
 173 rg        str     -         -    registered trademark symbol
 174 rq        str     ",''      -    right double quotation marks
 175 s1        num     -         i    current point size
 176 s2        num     -         i    previous point size
 177 .sd x     mac     -         -    start display; if x is c, center display
 178 sf        num     -         i    1 if center display, 0 otherwise
 179 .si x     num     -         -    indent left margin by x (5n default)
 180 .sm x y z mac     -         -    print x 2p smaller, y after, z before;
 181                                  if no arguments, decrease point size by 2p
 182 .sn x     mac     -         b    space by x (1v default), enter nospace mode
 183 .sr x     mac     -         -    enter spacemode, space by x (1v default)
 184 t2        num     0         i    0 if little/no space, nonzero otherwise
 185 .tf       div     -         i    text of footnotes
 186 tm        num     1i-.5v    -    height of top margin
 187 tt        num     .5i-.5v   -    distance from top of page to header
 188 .ux x y   mac     -         -    print UNIX(tm), footnote; x after,
 189                                  y before
 190 ux        num     0         i    1 after UNIX(tm) footnote printed,
 191                                  0 before
 192 v1        num     -         i    current vertical spacing
 193 v2        num     -         i    previous vertical spacing
 194 vr        str     -         -    current version of news
 195 vs        num     16p       -    default vertical spacing
 196 vx        num     0         i    1 after VAX(tm) footnote printed,
 197                                  0 before
 198 .vx x y   mac     -         -    print VAX(tm), footnote; x after,
 199                                  y before
 200 ws        str     -         -    used to construct error message
 201 .ya       mac     -         -    same as calling .yf, .yi, .ys, .yv
 202 .yf       mac     -         -    restore fonts saved by .zf
 203 .yi       mac     -         -    restore indents saved by .zi
 204 Yr        str     -         -    current year
 205 .ys       mac     -         -    restore point sizes saved by .zs
 206 .yv       mac     -         -    restore vertical spacings saved by .zv
 207 .za       mac     -         -    same as calling .zf, .zi, .zs, .zv
 208 .zf       mac     -         -    save previous, current fonts
 209 .zi       mac     -         -    save previous, current indents
 210 .zs       mac     -         -    save previous, current point sizes
 211 .zv       mac     -         -    save previous, current vertical spacings
 212
 213
 214
 215                               News Version B2.11                         MN(7)