274 lines
8.7 KiB
Groff
274 lines
8.7 KiB
Groff
.\" $NHDT-Branch: NetHack-3.6.2 $:$NHDT-Revision: 1.0 $ $NHDT-Date: 1541298619 2018/11/04 02:30:19 $
|
|
.TH MN 7 "News Version B2.11"
|
|
.SH NAME
|
|
mn \- text formatting macros for the news documentation
|
|
.SH SYNOPSIS
|
|
.B "nroff \-mn"
|
|
[ options ] file ...
|
|
.br
|
|
.B "troff \-mn"
|
|
[ options ] file ...
|
|
.SH DESCRIPTION
|
|
.PP
|
|
This package of
|
|
.IR nroff (1)
|
|
and
|
|
.IR troff (1)
|
|
macro definitions provides a formatting facility
|
|
which may be used to run off the formatted news documents.
|
|
When reverse line motions are needed,
|
|
filter the output through
|
|
.IR col (1).
|
|
.PP
|
|
All \-mn macros,
|
|
diversions,
|
|
string registers,
|
|
and number registers are defined below.
|
|
Many
|
|
.I nroff
|
|
and
|
|
.I troff
|
|
requests are unsafe in conjunction with this package.
|
|
However,
|
|
the requests below may be used with impunity:
|
|
.LP
|
|
.ta 5n 12n
|
|
.nf
|
|
.bp begin new page
|
|
.br break output line
|
|
.sp \f2n\fP insert \f2n\fP spacing lines
|
|
.ce \f2n\fP center next \f2n\fP lines
|
|
.ls \f2n\fP line spacing: \f2n\fP=1 single, \f2n\fP=2 double space
|
|
.na no alignment of right margin
|
|
.fi
|
|
.PP
|
|
Font and point size changes with \ef and \es are also allowed;
|
|
for example,
|
|
\&``\ef2word\efR'' will italicize \f2word.\fP
|
|
Output of the
|
|
.IR tbl (1),
|
|
.IR eqn (1),
|
|
and
|
|
.IR refer (1)
|
|
preprocessors for equations,
|
|
tables,
|
|
and references is acceptable as input.
|
|
.SH FILES
|
|
/usr/lib/tmac/tmac.n
|
|
.SH "SEE ALSO"
|
|
eqn(1), refer(1), tbl(1), troff(1)
|
|
.SH WARNINGS
|
|
.PP
|
|
If you do not set the string register ``.f'' to the file name,
|
|
you will only be told the line number on which any errors occur.
|
|
If you define this string to be the file name,
|
|
you will get the file name,
|
|
too.
|
|
This is useful when dealing with a document
|
|
split up into many files.
|
|
.PP
|
|
This package is not now intended for uses
|
|
other than with the news documentation.
|
|
.PP
|
|
Bug reports are always welcome;
|
|
please send them to the author.
|
|
(Include a sample of the input;
|
|
this helps track down the bug.)
|
|
.SH AUTHOR
|
|
Matt Bishop
|
|
.RI ( mab@riacs.arpa ,
|
|
.IR ihnp4!ames!riacs!mab ,
|
|
.IR decvax!decwrl!riacs!mab )
|
|
.br
|
|
Updated for versions 1.4-1.6 by The NetHack Development Team
|
|
.SH REQUESTS
|
|
.PP
|
|
In the
|
|
.I Note
|
|
column,
|
|
.I b
|
|
means the request causes a break,
|
|
and
|
|
.I i
|
|
means the macro,
|
|
number register,
|
|
string register,
|
|
or diversion is internal and should not be used for anything.
|
|
In the
|
|
.I "What It Is"
|
|
column,
|
|
.IR div " means " diversion ,
|
|
.IR mac " means " macro ,
|
|
.IR num " means " "number register" ,
|
|
and
|
|
.IR str " means " "string register" .
|
|
In the
|
|
.I "Initial Value"
|
|
column,
|
|
a hyphen means no initial value is used,
|
|
anything else is the initial value,
|
|
and if two values are given,
|
|
the first is for
|
|
.I nroff
|
|
and the second for
|
|
.IR troff .
|
|
.PP
|
|
.if n .in 0
|
|
.ds x \f2x\fP\|
|
|
.ds y \f2y\fP\|
|
|
.ds z \f2z\fP\|
|
|
.ds X "\*x
|
|
.ds Y "\*x \*y
|
|
.ds Z "\*x \*y \*z
|
|
.tr _.
|
|
.ta \w'MacroNames'u +\w'WhatItIs'u +\w'InitialVal'u +\w'Note 'u
|
|
.sp .3
|
|
.nf
|
|
Macro What Initial Note \0 Explanation
|
|
Name It Is Value
|
|
.sp .3
|
|
_f num \- \- file name, used in error messages if set
|
|
_ai mac \- \- author's institution
|
|
_au mac \- b author's name
|
|
_b \*Z mac \- \- print \*x in font 3, \*y after, \*z before;
|
|
if no arguments, switch to font 3
|
|
b num \- i used to embolden italics
|
|
_bi \*Z mac \- \- print \*x in emboldened font 2, \*y after,
|
|
\*z before
|
|
bm num 1i,1i+1v \- height of bottom margin
|
|
_bt mac \- \- print pottom title
|
|
bt num .5i+1v \- bottom of footer to bottom of page
|
|
_cf \*Z mac \- \- print contents of header line (double
|
|
quotes around \*x, \*y before, \*z after)
|
|
cm num 0 \- 0 if no cut marks, nonzero if cut marks
|
|
_cn \*Z mac \- \- print computer/site name; same as _i
|
|
_dd div \- i text of display
|
|
dg str \(**,\(dg \- footnote mark
|
|
dw str \f2current\fP \- name of current day of week
|
|
dy str \f2current\fP \- full date
|
|
_ed mac \- b end display
|
|
_ef mac \- b end footnote
|
|
_ei mac \- b move left margin to the right
|
|
_er mac \- \- print error message
|
|
_et mac \- b,i macro called at end of text
|
|
f0 str \- \- left bottom title
|
|
f1 num \- i current font number
|
|
f1 str \f2date\fP,\- \- center bottom title
|
|
f2 num \- i previous font number
|
|
f2 str \- \- right bottom title
|
|
fc num \- i per-page footnote count
|
|
_fd mac \- b,i drop footnotes
|
|
fg num \- i gets fudge factor for footnote
|
|
fl num 5.5i \- default footnote line length
|
|
_fn mac \- \- begin footnote
|
|
_fo mac \- \- bottom of page (footer) macro
|
|
fp num \- i current location of trap for _fo macro
|
|
_fs mac \- i print text/footnote separator
|
|
fs num \- i position where footnote printing should begin
|
|
_fx mac \- i collect overflow footnotes
|
|
_fy div \- i text of footnote overflow
|
|
_fz mac \- i move overflow footnotes from _fy to _tf
|
|
gs num \- i used to be sure footnotes fit
|
|
h0 num 0 i current level 1 section number
|
|
h0 str \- \- left header title
|
|
h1 num 0 i current level 2 section number
|
|
h1 str \f2\- page \-\fP \- center header title
|
|
h2 num 0 i current level 3 section number
|
|
h2 str \- \- right header title
|
|
h3 num 0 i current level 4 section number
|
|
_hd mac \- i top of page (header) macro
|
|
_hf mac \- \- print header field name; same as _cf
|
|
_hn \*x mac \- b numbered section; if present, \*x is level
|
|
hn num 0 i current level of numbering (temporary)
|
|
hs num 1v \- default intra-section spacing
|
|
_hu mac \- b unnumbered section header
|
|
_i \*Z mac \- \- print \*x in font 2, \*y after, \*z before;
|
|
if no arguments, switch to font 2
|
|
i1 num \- i current indent
|
|
i2 num \- i previous indent
|
|
id num 0 i 1 if in display, 0 otherwise
|
|
if num 0 i 1 if in footnote, 0 otherwise
|
|
_is \*Z mac \- \- print \*x 2p bigger, \*y after, \*z before;
|
|
if no arguments, increase point size by 2p
|
|
it num 0 i 0 before _bt called, 1 after
|
|
l0 num 0 i leftmost position for left margin
|
|
l1 num \- i first level of indent for left margin
|
|
l2 num \- i second level of indent for left margin
|
|
l3 num \- i third level of indent for left margin
|
|
l4 num \- i fourth level of indent for left margin
|
|
l5 num \- i fifth level of indent for left margin
|
|
l6 num \- i sixth level of indent for left margin
|
|
l7 num \- i seventh level of indent for left margin
|
|
l8 num \- i eighth level of indent for left margin
|
|
l9 num \- i ninth level of indent for left margin
|
|
li num 5n \- paragraph indent
|
|
ll num 6i \- default line length
|
|
lm num 0 i current level of indent for left margin
|
|
lo num \- i previous level for left margin
|
|
_lp \*Y mac \- b labelled paragraph; \*x is label, \*y indent
|
|
lq str ",`` \- left double quotation marks
|
|
mo str \f2current\fP \- name of current month
|
|
_mt mac \- b title
|
|
mt num 1.5i+1v \- distance of title from top of page
|
|
_ng \*Z mac \- \- newsgroup name; same as _b
|
|
_nl mac \- b reset point size to default
|
|
ns num 0 i if nonzero, _fn does not call _fs
|
|
_op \*Z mac \- \- command option; same as _b
|
|
p1 num 0 i 1 after PDP-11(tm) footnote printed,
|
|
0 before
|
|
_pa \*Z mac \- \- print protocol appellation; same as _i
|
|
_pd \*Y mac \- \- print PDP-11(tm), footnote; \*x after,
|
|
\*y before
|
|
pd num 1v,.3v \- intra-paragraph spacing
|
|
_pf mac \- \- print footer title
|
|
_pg \*x mac \- b paragraph; if \*x is l, left justify
|
|
pi num 5n \- default paragraph indent
|
|
po num 1.25i \- default page offset
|
|
ps num 12p \- default point size
|
|
_pt \*x mac \- \- print header; \*x is distance from top of
|
|
page
|
|
_qc \*Z mac \- \- print name of control char; \*x is name,
|
|
in font 3, between <>, \*y after, \*z before
|
|
_qp \*Z mac \- \- print char; same as _b
|
|
_r mac \- \- switch to font 1
|
|
rg str \- \- registered trademark symbol
|
|
rq str ",'' \- right double quotation marks
|
|
s1 num \- i current point size
|
|
s2 num \- i previous point size
|
|
_sd \*X mac \- \- start display; if \*x is c, center display
|
|
sf num \- i 1 if center display, 0 otherwise
|
|
_si \*x num \- \- indent left margin by \*x (5n default)
|
|
_sm \*Z mac \- \- print \*x 2p smaller, \*y after, \*z before;
|
|
if no arguments, decrease point size by 2p
|
|
_sn \*x mac \- b space by \*x (1v default), enter nospace mode
|
|
_sr \*x mac \- \- enter spacemode, space by \*x (1v default)
|
|
t2 num 0 i 0 if little/no space, nonzero otherwise
|
|
_tf div \- i text of footnotes
|
|
tm num 1i-.5v \- height of top margin
|
|
tt num .5i-.5v \- distance from top of page to header
|
|
_ux \*Y mac \- \- print UNIX(tm), footnote; \*x after,
|
|
\*y before
|
|
ux num 0 i 1 after UNIX(tm) footnote printed,
|
|
0 before
|
|
v1 num \- i current vertical spacing
|
|
v2 num \- i previous vertical spacing
|
|
vr str \- \- current version of news
|
|
vs num 16p \- default vertical spacing
|
|
vx num 0 i 1 after VAX(tm) footnote printed,
|
|
0 before
|
|
_vx \*Y mac \- \- print VAX(tm), footnote; \*x after,
|
|
\*y before
|
|
ws str \- \- used to construct error message
|
|
_ya mac \- \- same as calling _yf, _yi, _ys, _yv
|
|
_yf mac \- \- restore fonts saved by _zf
|
|
_yi mac \- \- restore indents saved by _zi
|
|
Yr str \- \- current year
|
|
_ys mac \- \- restore point sizes saved by _zs
|
|
_yv mac \- \- restore vertical spacings saved by _zv
|
|
_za mac \- \- same as calling _zf, _zi, _zs, _zv
|
|
_zf mac \- \- save previous, current fonts
|
|
_zi mac \- \- save previous, current indents
|
|
_zs mac \- \- save previous, current point sizes
|
|
_zv mac \- \- save previous, current vertical spacings
|
|
.fi
|