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