| blob | 1d40edc2cd29c41f4efbf355f488b8b0df9737a3 |
1 .\" $NHDT-Branch: NetHack-3.6.2 $:$NHDT-Revision: 1.0 $ $NHDT-Date: 1541298619 2018/11/04 02:30:19 $
2 .TH MN 7 "News Version B2.11"
3 .SH NAME
4 mn \- text formatting macros for the news documentation
5 .SH SYNOPSIS
6 .B "nroff \-mn"
7 [ options ] file ...
8 .br
9 .B "troff \-mn"
10 [ options ] file ...
11 .SH DESCRIPTION
12 .PP
13 This package of
14 .IR nroff (1)
15 and
16 .IR troff (1)
17 macro definitions provides a formatting facility
18 which may be used to run off the formatted news documents.
19 When reverse line motions are needed,
20 filter the output through
21 .IR col (1).
22 .PP
23 All \-mn macros,
24 diversions,
25 string registers,
26 and number registers are defined below.
27 Many
28 .I nroff
29 and
30 .I troff
31 requests are unsafe in conjunction with this package.
32 However,
33 the requests below may be used with impunity:
34 .LP
35 .ta 5n 12n
36 .nf
37 .bp begin new page
38 .br break output line
39 .sp \f2n\fP insert \f2n\fP spacing lines
40 .ce \f2n\fP center next \f2n\fP lines
41 .ls \f2n\fP line spacing: \f2n\fP=1 single, \f2n\fP=2 double space
42 .na no alignment of right margin
43 .fi
44 .PP
45 Font and point size changes with \ef and \es are also allowed;
46 for example,
47 \&``\ef2word\efR'' will italicize \f2word.\fP
48 Output of the
49 .IR tbl (1),
50 .IR eqn (1),
51 and
52 .IR refer (1)
53 preprocessors for equations,
54 tables,
55 and references is acceptable as input.
56 .SH FILES
57 /usr/lib/tmac/tmac.n
58 .SH "SEE ALSO"
59 eqn(1), refer(1), tbl(1), troff(1)
60 .SH WARNINGS
61 .PP
62 If you do not set the string register ``.f'' to the file name,
63 you will only be told the line number on which any errors occur.
64 If you define this string to be the file name,
65 you will get the file name,
66 too.
67 This is useful when dealing with a document
68 split up into many files.
69 .PP
70 This package is not now intended for uses
71 other than with the news documentation.
72 .PP
73 Bug reports are always welcome;
74 please send them to the author.
75 (Include a sample of the input;
76 this helps track down the bug.)
77 .SH AUTHOR
78 Matt Bishop
79 .RI ( mab@riacs.arpa ,
80 .IR ihnp4!ames!riacs!mab ,
81 .IR decvax!decwrl!riacs!mab )
82 .br
83 Updated for versions 1.4-1.6 by The NetHack Development Team
84 .SH REQUESTS
85 .PP
86 In the
87 .I Note
88 column,
89 .I b
90 means the request causes a break,
91 and
92 .I i
93 means the macro,
94 number register,
95 string register,
96 or diversion is internal and should not be used for anything.
97 In the
98 .I "What It Is"
99 column,
100 .IR div " means " diversion ,
101 .IR mac " means " macro ,
102 .IR num " means " "number register" ,
103 and
104 .IR str " means " "string register" .
105 In the
106 .I "Initial Value"
107 column,
108 a hyphen means no initial value is used,
109 anything else is the initial value,
110 and if two values are given,
111 the first is for
112 .I nroff
113 and the second for
114 .IR troff .
115 .PP
116 .if n .in 0
117 .ds x \f2x\fP\|
118 .ds y \f2y\fP\|
119 .ds z \f2z\fP\|
120 .ds X "\*x
121 .ds Y "\*x \*y
122 .ds Z "\*x \*y \*z
123 .tr _.
124 .ta \w'MacroNames'u +\w'WhatItIs'u +\w'InitialVal'u +\w'Note 'u
125 .sp .3
126 .nf
127 Macro What Initial Note \0 Explanation
128 Name It Is Value
129 .sp .3
130 _f num \- \- file name, used in error messages if set
131 _ai mac \- \- author's institution
132 _au mac \- b author's name
133 _b \*Z mac \- \- print \*x in font 3, \*y after, \*z before;
134 if no arguments, switch to font 3
135 b num \- i used to embolden italics
136 _bi \*Z mac \- \- print \*x in emboldened font 2, \*y after,
137 \*z before
138 bm num 1i,1i+1v \- height of bottom margin
139 _bt mac \- \- print pottom title
140 bt num .5i+1v \- bottom of footer to bottom of page
141 _cf \*Z mac \- \- print contents of header line (double
142 quotes around \*x, \*y before, \*z after)
143 cm num 0 \- 0 if no cut marks, nonzero if cut marks
144 _cn \*Z mac \- \- print computer/site name; same as _i
145 _dd div \- i text of display
146 dg str \(**,\(dg \- footnote mark
147 dw str \f2current\fP \- name of current day of week
148 dy str \f2current\fP \- full date
149 _ed mac \- b end display
150 _ef mac \- b end footnote
151 _ei mac \- b move left margin to the right
152 _er mac \- \- print error message
153 _et mac \- b,i macro called at end of text
154 f0 str \- \- left bottom title
155 f1 num \- i current font number
156 f1 str \f2date\fP,\- \- center bottom title
157 f2 num \- i previous font number
158 f2 str \- \- right bottom title
159 fc num \- i per-page footnote count
160 _fd mac \- b,i drop footnotes
161 fg num \- i gets fudge factor for footnote
162 fl num 5.5i \- default footnote line length
163 _fn mac \- \- begin footnote
164 _fo mac \- \- bottom of page (footer) macro
165 fp num \- i current location of trap for _fo macro
166 _fs mac \- i print text/footnote separator
167 fs num \- i position where footnote printing should begin
168 _fx mac \- i collect overflow footnotes
169 _fy div \- i text of footnote overflow
170 _fz mac \- i move overflow footnotes from _fy to _tf
171 gs num \- i used to be sure footnotes fit
172 h0 num 0 i current level 1 section number
173 h0 str \- \- left header title
174 h1 num 0 i current level 2 section number
175 h1 str \f2\- page \-\fP \- center header title
176 h2 num 0 i current level 3 section number
177 h2 str \- \- right header title
178 h3 num 0 i current level 4 section number
179 _hd mac \- i top of page (header) macro
180 _hf mac \- \- print header field name; same as _cf
181 _hn \*x mac \- b numbered section; if present, \*x is level
182 hn num 0 i current level of numbering (temporary)
183 hs num 1v \- default intra-section spacing
184 _hu mac \- b unnumbered section header
185 _i \*Z mac \- \- print \*x in font 2, \*y after, \*z before;
186 if no arguments, switch to font 2
187 i1 num \- i current indent
188 i2 num \- i previous indent
189 id num 0 i 1 if in display, 0 otherwise
190 if num 0 i 1 if in footnote, 0 otherwise
191 _is \*Z mac \- \- print \*x 2p bigger, \*y after, \*z before;
192 if no arguments, increase point size by 2p
193 it num 0 i 0 before _bt called, 1 after
194 l0 num 0 i leftmost position for left margin
195 l1 num \- i first level of indent for left margin
196 l2 num \- i second level of indent for left margin
197 l3 num \- i third level of indent for left margin
198 l4 num \- i fourth level of indent for left margin
199 l5 num \- i fifth level of indent for left margin
200 l6 num \- i sixth level of indent for left margin
201 l7 num \- i seventh level of indent for left margin
202 l8 num \- i eighth level of indent for left margin
203 l9 num \- i ninth level of indent for left margin
204 li num 5n \- paragraph indent
205 ll num 6i \- default line length
206 lm num 0 i current level of indent for left margin
207 lo num \- i previous level for left margin
208 _lp \*Y mac \- b labelled paragraph; \*x is label, \*y indent
209 lq str ",`` \- left double quotation marks
210 mo str \f2current\fP \- name of current month
211 _mt mac \- b title
212 mt num 1.5i+1v \- distance of title from top of page
213 _ng \*Z mac \- \- newsgroup name; same as _b
214 _nl mac \- b reset point size to default
215 ns num 0 i if nonzero, _fn does not call _fs
216 _op \*Z mac \- \- command option; same as _b
217 p1 num 0 i 1 after PDP-11(tm) footnote printed,
218 0 before
219 _pa \*Z mac \- \- print protocol appellation; same as _i
220 _pd \*Y mac \- \- print PDP-11(tm), footnote; \*x after,
221 \*y before
222 pd num 1v,.3v \- intra-paragraph spacing
223 _pf mac \- \- print footer title
224 _pg \*x mac \- b paragraph; if \*x is l, left justify
225 pi num 5n \- default paragraph indent
226 po num 1.25i \- default page offset
227 ps num 12p \- default point size
228 _pt \*x mac \- \- print header; \*x is distance from top of
229 page
230 _qc \*Z mac \- \- print name of control char; \*x is name,
231 in font 3, between <>, \*y after, \*z before
232 _qp \*Z mac \- \- print char; same as _b
233 _r mac \- \- switch to font 1
234 rg str \- \- registered trademark symbol
235 rq str ",'' \- right double quotation marks
236 s1 num \- i current point size
237 s2 num \- i previous point size
238 _sd \*X mac \- \- start display; if \*x is c, center display
239 sf num \- i 1 if center display, 0 otherwise
240 _si \*x num \- \- indent left margin by \*x (5n default)
241 _sm \*Z mac \- \- print \*x 2p smaller, \*y after, \*z before;
242 if no arguments, decrease point size by 2p
243 _sn \*x mac \- b space by \*x (1v default), enter nospace mode
244 _sr \*x mac \- \- enter spacemode, space by \*x (1v default)
245 t2 num 0 i 0 if little/no space, nonzero otherwise
246 _tf div \- i text of footnotes
247 tm num 1i-.5v \- height of top margin
248 tt num .5i-.5v \- distance from top of page to header
249 _ux \*Y mac \- \- print UNIX(tm), footnote; \*x after,
250 \*y before
251 ux num 0 i 1 after UNIX(tm) footnote printed,
252 0 before
253 v1 num \- i current vertical spacing
254 v2 num \- i previous vertical spacing
255 vr str \- \- current version of news
256 vs num 16p \- default vertical spacing
257 vx num 0 i 1 after VAX(tm) footnote printed,
258 0 before
259 _vx \*Y mac \- \- print VAX(tm), footnote; \*x after,
260 \*y before
261 ws str \- \- used to construct error message
262 _ya mac \- \- same as calling _yf, _yi, _ys, _yv
263 _yf mac \- \- restore fonts saved by _zf
264 _yi mac \- \- restore indents saved by _zi
265 Yr str \- \- current year
266 _ys mac \- \- restore point sizes saved by _zs
267 _yv mac \- \- restore vertical spacings saved by _zv
268 _za mac \- \- same as calling _zf, _zi, _zs, _zv
269 _zf mac \- \- save previous, current fonts
270 _zi mac \- \- save previous, current indents
271 _zs mac \- \- save previous, current point sizes
272 _zv mac \- \- save previous, current vertical spacings
273 .fi