Deleted Added
full compact
m0a (96895) m0a (96904)
1.\" This module is believed to contain source code proprietary to AT&T.
2.\" Use and redistribution is subject to the Berkeley Software License
3.\" Agreement and your Software Agreement with AT&T (Western Electric).
4.\"
1.\" Copyright (C) Caldera International Inc. 2001-2002. All rights reserved.
2.\"
3.\" Redistribution and use in source and binary forms, with or without
4.\" modification, are permitted provided that the following conditions are
5.\" met:
6.\"
7.\" Redistributions of source code and documentation must retain the above
8.\" copyright notice, this list of conditions and the following
9.\" disclaimer.
10.\"
11.\" Redistributions in binary form must reproduce the above copyright
12.\" notice, this list of conditions and the following disclaimer in the
13.\" documentation and/or other materials provided with the distribution.
14.\"
15.\" All advertising materials mentioning features or use of this software
16.\" must display the following acknowledgement:
17.\"
18.\" This product includes software developed or owned by Caldera
19.\" International, Inc. Neither the name of Caldera International, Inc.
20.\" nor the names of other contributors may be used to endorse or promote
21.\" products derived from this software without specific prior written
22.\" permission.
23.\"
24.\" USE OF THE SOFTWARE PROVIDED FOR UNDER THIS LICENSE BY CALDERA
25.\" INTERNATIONAL, INC. AND CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR
26.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
27.\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
28.\" DISCLAIMED. IN NO EVENT SHALL CALDERA INTERNATIONAL, INC. BE LIABLE
29.\" FOR ANY DIRECT, INDIRECT INCIDENTAL, SPECIAL, EXEMPLARY, OR
30.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
31.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
32.\" BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
33.\" WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
34.\" OR OTHERWISE) RISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
35.\" IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36.\"
5.\" @(#)m0a 8.1 (Berkeley) 8/14/93
6.\"
37.\" @(#)m0a 8.1 (Berkeley) 8/14/93
38.\"
7.\" $FreeBSD: head/share/doc/usd/21.troff/m0a 96895 2002-05-19 03:30:02Z grog $
39.\" $FreeBSD: head/share/doc/usd/21.troff/m0a 96904 2002-05-19 04:02:29Z grog $
8.br
9.tr |
10.ce
11.ft B
12SUMMARY OF REQUESTS AND OUTLINE OF THIS MANUAL
13.ft R
14.de mx
15.ev 2
16.nf
17.h1
18.in
19.sp
20.fi
21.ev
22.ns
23..
24.xx
25.h1 \s-1#\s+1 *
26.fn
27.sp .3
28*Values separated by "\fB;\fR" are for \*(NR and \*(TR respectively.
29.sp .2
30\s-1#\s+1Notes are explained at the end of this Summary and Index
31.ef
32.mh
33General Explanation
34.mh
35Font and Character Size Control
36.bt
37\fB&ps\fI\|\(+-N\fR 10\|point previous E Point size; also \fB\es\fI\(+-N\fR.\(dg
38.b1
39\fB&fz\fI|F|\(+-N\fR off - E font \fIF\fR to point size \fI\(+-N\fR.
40.b1
41\fB&fz|S|\fIF|\(+-N\fR off - E Special Font characters to point size \fI\(+-N\fR.
42.b1
43\fB&ss\fI|N\fR 12\(sl36\|em ignored E Space-character size
44set to \fIN\fR\(sl36\|em.\(dg
45.b1
46\fB&cs\fI|F\|N\|M\fR off - P Constant character
47space (width)
48mode (font \fIF\^\fR\^).\(dg
49.b1
50\fB&bd\fI|F|N\fR off - P Embolden font \fIF\fR by \fIN\fR\(mi1 units.\(dg
51.b1
52\fB&bd|S|\fIF|N\fR off - P Embolden Special Font when current font is \fIF\fR.\(dg
53.fn
54.sp .2
55\(dgNo effect in \*(NR.
56.ef
57.b1
58\fB&ft\fI|F\fR Roman previous E Change to font
59\fIF\fR|= \fIx\fR, \fIxx\fR, or 1-4.
60Also \fB\ef\fIx\fR,\|\fB\ef(\fIxx\fR,\|\fB\ef\fIN\fR.
61.b1
62\fB&fp\fI|N|F\fR R,I,B,S ignored - Font named \fIF\fR mounted on physical position 1\(<=\fIN\fR\(<=4.
63.mh
64Page Control
65.bt
66\fB&pl\fI|\(+-N\fR 11\|in 11\|in \fBv\fR Page length.
67.b1
68\fB&bp|\fI\(+-N\fR \fIN\(eq\fR1 - B\(dd,\fBv\fR \
69Eject current page; next page number \fIN\fR.
70.fn
71.sp .2
72\(ddThe use of "\ \fB\'\fR\ " as control character (instead of "\fB.\fR")
73suppresses the break function.
74.ef
75.b1
76\fB&pn\fI|\(+-N N\(eq\fR1 ignored - Next page number \fIN\fR.
77.b1
78\fB&po\fI|\(+-N\fR 0;|26\(sl27\|in previous \fBv\fR Page offset.
79.b1
80\fB&ne\fI|N\fR - \fIN\(eq\fR1\fIV\fR D,\fBv\fR Need \fIN\fR vertical space (\fIV\fR = vertical spacing).
81.b1
82\fB&mk|\fIR\fR none internal D Mark current vertical place in register \fIR\fR.
83.b1
84\fB&rt\fI|\(+-N\fR none internal D,\fBv\fR Return \fI(upward only)\fR to marked vertical place.
85.mh
86Text Filling, Adjusting, and Centering
87.bt
88\fB&br\fR - - B Break.
89.b1
90.lg 0
91\fB&fi\fR \(fill - B,E Fill output lines.
92.lg
93.b1
94\fB&nf\fR fill - B,E No filling or adjusting of output lines.
95.b1
96\fB&ad\fI|c\fR adj,both adjust E Adjust output lines with mode \fIc\fR.
97.b1
98\fB&na\fR adjust - E No output line adjusting.
99.b1
100\fB&ce\fI|N\fR off \fIN\(eq\fR1 B,E Center following \fIN\fR input text lines.
101.mh
102Vertical Spacing
103.bt
104\fB&vs\fI|N\fR 1\(sl6in;12pts previous E,\fBp\fR Vertical base line spacing (\fIV\fR\^).
105.b1
106\fB&ls\fI|N N\(eq\fR1 previous E Output \fIN\(mi\fR1 \fIV\^\fRs after each text output line.
107.b1
108\fB&sp\fI|N\fR - \fIN\(eq\fR1\fIV\fR B,\fBv\fR Space \
109vertical distance \fIN\fR \fIin either direction\fR.
110.b1
111\fB&sv\fI|N\fR - \fIN\(eq\fR1\fIV\fR \fBv\fR Save vertical distance \fIN\fR.
112.b1
113\fB&os\fR - - - Output saved vertical distance.
114.b1
115\fB&ns\fR space - D Turn no-space mode on.
116.b1
117\fB&rs\fR - - D Restore spacing; turn no-space mode off.
118.mh
119Line Length and Indenting
120.bt
121\fB&ll\fI|\(+-N\fR 6.5\|in previous E,\fBm\fR Line length.
122.b1
123\fB&in\fI|\(+-N\fR \fIN\(eq\fR\^0 previous B,E,\fBm\fR Indent.
124.b1
125\fB&ti\fI|\(+-N\fR - ignored B,E,\fBm\fR Temporary indent.
126.mh
127Macros, Strings, Diversion, and Position Traps
128.bt
129\fB&de\fI|xx|yy\fR - \fI.yy=\fB..\fR - Define or redefine macro \fIxx;\fR end at call of \fIyy\fR.
130.b1
131\fB&am\fI|xx|yy\fR - \fI.yy=\fB..\fR - Append to a macro.
132.b1
133\fB&ds\fI|xx|string\fR - ignored - Define a string \fIxx\fR containing \fIstring\fR.
134.b1
135\fB&as\fI|xx|string\fR - ignored - Append \fIstring\fR to string \fIxx\fR.
136.b1
137\fB&rm\fI|xx\fR - ignored - Remove request, macro, or string.
138.b1
139\fB&rn\fI|xx|yy\fR - ignored - Rename request, macro, or string \fIxx\fR to \fIyy\fR.
140.b1
141\fB&di\fI|xx\fR - end D Divert output to macro \fIxx\fR.
142.b1
143\fB&da\fI|xx\fR - end D Divert and append to \fIxx\fR.
144.b1
145\fB&wh\fI|N|xx\fR - - \fBv\fR Set location trap; negative is w.r.t. page bottom.
146.b1
147\fB&ch\fI|xx|N\fR - - \fBv\fR Change trap location.
148.b1
149\fB&dt\fI|N|xx\fR - off D,\fBv\fR Set a diversion trap.
150.b1
151\fB&it\fI|N|xx\fR - off E Set an input-line count trap.
152.b1
153\fB&em\fI|xx\fR none none - End macro is \fIxx\fI.
154.mh
155Number Registers
156.bt
157\fB&nr\fI|R|\(+-N|M\fR - - \fBu\fR Define and set number register \fIR\fR; auto-increment by \fIM\fR.
158.b1
159\fB&af\fI|R|c\fR arabic - - Assign format to register \fIR\fR (\fIc=\fB1\fR, \fBi\fR, \fBI\fR, \fBa\fR, \fBA\fR).
160.b1
161\fB&rr\fI|R\fR - - - Remove register \fIR\fR.
162.mh
163Tabs, Leaders, and Fields
164.bt
165\fB&ta\fI|Nt|...\fR 0.8;|0.5in none E,\fBm\fR Tab settings; \fIleft\fR type, unless \fIt=\fBR\fR(right), \fBC\fR(centered).
166.b1
167\fB&tc\fI|c\fR none none E Tab repetition character.
168.b1
169\fB&lc\fI|c\fR \fB.\fR none E Leader repetition character.
170.b1
171\fB&fc\fI|a|b\fR off off - Set field delimiter \fIa\fR and pad character \fIb\fR.
172.mh
173Input and Output Conventions and Character Translations
174.bt
175\fB&ec\fI|c\fR \e \e - Set escape character.
176.b1
177\fB&eo\fR on - - Turn off escape character mechanism.
178.b1
179\fB&lg\fI|N\fR -;\|on on - Ligature mode
180on if \fIN\fR>0.
181.b1
182\fB&ul\fI|N\fR off \fIN\(eq\fR1 E Underline (italicize in \*(TR) \fIN\fR input lines.
183.b1
184\fB&cu\fI|N\fR off \fIN\(eq\fR1 E Continuous underline in \*(NR; like \fBul\fR in \*(TR.
185.b1
186\fB&uf\fI|F\fR Italic Italic - Underline font set to \fIF\fR (to be switched to by \fBul\fR).
187.b1
188\fB&cc\fI|c\fR \fB. .\fR E Set control character to \fIc\fR.
189.b1
190\fB&c2\fI|c\fR \fB\' \'\fR E Set nobreak control character to \fIc\fR.
191.b1
192\fB&tr\fI|abcd....\fR none - O Translate \fIa\fR to \fIb\fR, etc. on output.
193.mh
194Local Horizontal and Vertical Motions, and the Width Function
195.mh
196Overstrike, Bracket, Line-drawing, and Zero-width Functions
197.mh
198Hyphenation.
199.bt
200\fB&nh\fR hyphenate - E No hyphenation.
201.b1
202\fB&hy\fI|N\fR hyphenate hyphenate E Hyphenate; \fIN =\fR mode.
203.b1
204\fB&hc\fI|c\fR \fB\e% \e%\fR E Hyphenation indicator character \fIc\fR.
205.b1
206\fB&hw\fI|word1|...\fR ignored - Exception words.
207.mh
208Three Part Titles.
209.bt
210\fB&tl\fI|\'left\|\'center\|\'right\|\'\fR - - Three part title.
211.b1
212\fB&pc\fI|c\fR \fB%\fR off - Page number character.
213.b1
214\fB&lt\fI|\(+-N\fR 6.5\|in previous E,\fBm\fR Length of title.
215.mh
216Output Line Numbering.
217.bt
218\fB&nm\fI|\(+-N|M|S|I\fR off E Number mode on or off, set parameters.
219.b1
220\fB&nn\fI|N\fR - \fIN\(eq\fR1 E Do not number next \fIN\fR lines.
221.mh
222Conditional Acceptance of Input
223.bt
224\fB&if\fI|c|anything\fR - - If condition \fIc\fR true, accept \fIanything\fR as input,
225.b1
226 for multi-line use \fI\e{anything\|\e}\fR.
227.b1
228\fB&if|!\fIc|anything\fR - - If condition \fIc\fR false, accept \fIanything\fR.
229.b1
230\fB&if\fI|N|anything\fR - \fBu\fR If expression \fIN\fR > 0, accept \fIanything\fR.
231.b1
232\fB&if|!\fIN|anything\fR - \fBu\fR If expression \fIN\fR \(<= 0, accept \fIanything\fR.
233.b1
234\fB&if\fI|\|\'string1\|\'string2\|\'|anything\fR - If \fIstring1\fR identical to \fIstring2\fR,
235accept \fIanything\fR.
236.b1
237\fB&if|!\fI\|\'string1\|\'string2\|\'|anything\fR - If \fIstring1\fR not identical to \fIstring2\fR,
238accept \fIanything\fR.
239.b1
240\fB&ie\fI|c|anything\fR - \fBu\fR If portion of if-else; all above forms (like \fBif\fR).
241.b1
242\fB&el\fI|anything\fR - - Else portion of if-else.
243.mh
244Environment Switching.
245.bt
246\fB&ev\fI|N\fR \fIN\(eq\fR0 previous - Environment switched (\fIpush down\fR).
247.mh
248Insertions from the Standard Input
249.bt
250\fB&rd\fI|prompt\fR\fR - \fIprompt=\s-1\fRBEL\s+1 Read insertion.
251.b1
252\fB&ex\fR - - - \
253Exit from \*(NR\(sl\*(TR.
254.mh
255Input\(slOutput File Switching
256.bt
257\fB&so\fI|filename\fR - - Switch source file \fI(push down)\fR.
258.b1
259\fB&nx\fI|filename\fR end-of-file - Next file.
260.b1
261\fB&pi\fI|program\fR - - Pipe output to \fIprogram\fR (\*(NR only).
262.mh
263Miscellaneous
264.bt
265\fB&mc\fI|c|N\fR - off E,\fBm\fR Set margin character \fIc\fR and separation \fIN\fR.
266.b1
267\fB&tm\fI|string\fR - newline - Print \fIstring\fR on terminal \
268(\s-1UNIX\s+1 standard error output).
269.b1
270\fB&ig\fI|yy\fR - \fI.yy=\fB..\fR - Ignore till call of \fIyy\fR.
271.b1
272\fB&pm\fI|t\fR - all - Print macro names and sizes;
273.b1
274 if \fIt\fR present, print only total of sizes.
275.b1
276\fB&ab\fI|string\fR - - - Print a message and abort.
277.b1
278.lg 0
279\fB&fl\fR - - B Flush output buffer.
280.lg
281.mh
282Output and Error Messages
283.xx
284.nf
285.rm mx
286.ft R
287\l'\n(.lu'
288.ft B
289.xx
290.ta .3iC .6i
291 Notes-
292.xx
293.ft R
294 B Request normally causes a break.
295 D Mode or relevant parameters associated with current diversion level.
296 E Relevant parameters are a part of the current environment.
297 O Must stay in effect until logical output.
298 P Mode must be still or again in effect at the time of physical output.
299 \fBv\fR,\fBp\fR,\fBm\fR,\fBu\fR Default scale indicator; if not specified, scale indicators are \fIignored\fR.
300.br
301.nr zz 11
302.de cl
303.ie \\n+(cl<\n(zz \{\
304. po +\\n(.lu/\n(zzu
305. rt\}
306.el \{.po 26i/27u\}
307..
308.nr cl 0 1
309.di zz
310.ta .3iR
311.nf
312.ps 8
313.vs 10
314ab 20
315ad 4
316af 8
317am 7
318as 7
319bd 2
320bp 3
321br 4
322c2 10
323cc 10
324ce 4
325ch 7
326cs 2
327cu 10
328da 7
329de 7
330di 7
331ds 7
332dt 7
333ec 10
334el 16
335em 7
336eo 10
337ev 17
338ex 18
339fc 9
340fi 4
341fl 20
342fp 2
343ft 2
344fz 2
345hc 13
346hw 13
347hy 13
348ie 16
349if 16
350ig 20
351in 6
352it 7
353lc 9
354lg 10
355li 10
356ll 6
357ls 5
358lt 14
359mc 20
360mk 3
361na 4
362ne 3
363nf 4
364nh 13
365nm 15
366nn 15
367nr 8
368ns 5
369nx 19
370os 5
371pc 14
372pi 19
373pl 3
374pm 20
375pn 3
376po 3
377ps 2
378rd 18
379rm 7
380rn 7
381rr 8
382rs 5
383rt 3
384so 19
385sp 5
386ss 2
387sv 5
388ta 9
389tc 9
390ti 6
391tl 14
392tm 20
393tr 10
394uf 10
395ul 10
396vs 5
397wh 7
398.di
399.nr aa \n(dn/\n(zz
400.ne \n(aau+10p
401.sp
402.ft B
403Alphabetical Request and Section Number Cross Reference
404.ft
405.sp .3
406.wh \n(nlu+\n(aau cl
407.nr qq \n(nlu+\n(aau
408.ps
409.vs
410.mk
411.zz
412.rt
413.sp \n(.tu
414.ch cl 12i
415.sp
416.bp
417.nf
418.ft B
419Escape Sequences for Characters, Indicators, and Functions
420.ft R
421.xx
422.TS
423c2l
424c2l2l
425n2l2l.
426.ft I
427.bd I 3
428Section Escape
429Reference Sequence Meaning
430.ft R
431.bd I
432.xx
43310.1 \fB\e\e\fR \e (to prevent or delay the interpretation of \e\|)
43410.1 \fB\ee\fR Printable version of the \fIcurrent\fR escape character.
4352.1 \fB\e\'\fR \' (acute accent); equivalent to \fB\e(aa\fR
4362.1 \fB\e\`\fR \` (grave accent); equivalent to \fB\e(ga\fR
4372.1 \fB\e\-\fR \- Minus sign in the \fIcurrent\fR font
4387 \fB\e\^.\fR Period (dot) (see \fBde\fR)
43911.1 \fB\e\fR(space) Unpaddable space-size space character
44011.1 \fB\e0\fR Digit width space
441.tr ||
44211.1 \fB\e\||\fR 1\(sl6\|em narrow space character (zero width in \*(NR)
443.tr |
44411.1 \fB\e^\fR 1\(sl12\|em half-narrow space character (zero width in \*(NR)
445.tr &&
4464.1 \fB\e&\fR Non-printing, zero width character
447.tr &.
44810.6 \fB\e!\fR Transparent line indicator
44910.7 \fB\e"\fR Beginning of comment
4507.3 \fB\e$\fIN\fR Interpolate argument 1\(<=\fIN\fR\(<=9
45113 \fB\e%\fR Default optional hyphenation character
4522.1 \fB\e(\fIxx\fR Character named \fIxx\fR
4537.1 \fB\e\(**\fIx\fR,|\fB\e\(**(\fIxx\fR Interpolate string \fIx\fR or \fIxx\fR
4549.1 \fB\ea\fR Non-interpreted leader character
45512.3 \fB\eb\fI\'abc...\|\'\fR Bracket building function
4564.2 \fB\ec\fR Interrupt text processing
45711.1 \fB\ed\fR Forward (down) 1\(sl2\|em vertical motion (1\(sl2 line in \*(NR)
4582.2 \fB\ef\fIx\fR,\fB\ef(\fIxx\fR,\fB\ef\fIN\fR Change to font named \fIx\fR or \fIxx\fR, or position \fIN\fR
45911.1 \fB\eh\fI\'N|\'\fR Local horizontal motion; move right \fIN\fR \fI(negative left)\fR
46011.3 \fB\ek\fIx\fR Mark horizontal \fIinput\fR place in register \fIx\fR
46112.4 \fB\el\fI\|\'Nc\|\'\fR Horizontal line drawing function (optionally with \fIc\fR\|)
46212.4 \fB\eL\fI\'Nc\|\'\fR Vertical line drawing function (optionally with \fIc\fR\|)
4638 \fB\en\fIx\fR,\fB\en(\fIxx\fR Interpolate number register \fIx\fR or \fIxx\fR
46412.1 \fB\eo\fI\'abc...\|\'\fR Overstrike characters \fIa, b, c, ...\fR
4654.1 \fB\ep\fR Break and spread output line
46611.1 \fB\er\fR Reverse 1\|em vertical motion (reverse line in \*(NR)
4672.3 \fB\es\fIN\fR,\|\fB\es\fI\(+-N\fR Point-size change function
4689.1 \fB\et\fR Non-interpreted horizontal tab
46911.1 \fB\eu\fR Reverse (up) 1\(sl2\|em vertical motion (1\(sl2 line in \*(NR)
47011.1 \fB\ev\fI\'N\|\|\'\fR Local vertical motion; move down \fIN\fR \fI(negative up)\fR
47111.2 \fB\ew\fI\'string\|\'\fR Interpolate width of \fIstring\fR
4725.2 \fB\ex\fI\'N\|\|\'\fR Extra line-space function \fI(negative before, positive after)\fR
47312.2 \fB\ez\fIc\fR Print \fIc\fR with zero width (without spacing)
47416 \fB\e{\fR Begin conditional input
47516 \fB\e}\fR End conditional input
47610.7 \fB\e\fR(newline) Concealed (ignored) newline
477- \fB\e\fIX\fR \fIX\fR, any character \fInot\fR listed above
478.TE
479.fi
480.sp
481The escape sequences
482\fB\e\e\fR,
483\fB\e\^.\fR,
484\fB\e"\fR,
485\fB\e$\fR,
486\fB\e\(**\fR,
487\fB\ea\fR,
488\fB\en\fR,
489\fB\et\fR,
490and
491\fB\e\fR(newline) are interpreted in \fIcopy mode\fR (\(sc7.2).
492.bp
493.ft B
494.nf
495Predefined General Number Registers
496.ft
497.TS
498c2l
499c2l2l
500n2l2l.
501.ft I
502.bd I 3
503Section Register
504Reference Name Description
505.ft R
506.bd I
507.xx
5083 \fB%\fR Current page number.
50919 \fBc&\fR Number of \fIlines\fR read from current input file.
51011.2 \fBct\fR Character type (set by \fIwidth\fR function).
5117.4 \fBdl\fR Width (maximum) of last completed diversion.
5127.4 \fBdn\fR Height (vertical size) of last completed diversion.
513- \fBdw\fR Current day of the week (1-7).
514- \fBdy\fR Current day of the month (1-31).
51511.3 \fBhp\fR Current horizontal place on \fIinput\fR line (not in ditroff)
51615 \fBln\fR Output line number.
517- \fBmo\fR Current month (1-12).
5184.1 \fBnl\fR Vertical position of last printed text base-line.
51911.2 \fBsb\fR Depth of string below base line (generated by \fIwidth\fR function).
52011.2 \fBst\fR Height of string above base line (generated by \fIwidth\fR function).
521- \fByr\fR Last two digits of current year.
522.TE
523.sp
524.ft B
525Predefined Read-Only Number Registers
526.ft R
527.TS
528c2l
529c2l2l
530n2l2l.
531.ft I
532.bd I 3
533Section Register
534Reference Name Description
535.ft R
536.bd I
537.xx
5387.3 \fB&$\fR Number of arguments available at the current macro level.
539- \fB&A\fR Set to 1 in \*(TR, if \fB\-a\fR option used; always 1 in \*(NR.
54011.1 \fB&H\fR Available horizontal resolution in basic units.
5415.3 \fB&L\fR Set to current \fIline-spacing\fR (\fBls\fR) parameter
542- \fB&P\fR Set to 1 if the current page is being printed; otherwise 0.
543- \fB&T\fR Set to 1 in \*(NR, if \fB\-T\fR option used; always 0 in \*(TR.
54411.1 \fB&V\fR Available vertical resolution in basic units.
5455.2 \fB&a\fR Post-line extra line-space most recently utilized \
546using \fB\ex\fI\'N\|\'\fR.
54719 \fB&c\fR Number of \fIlines\fR read from current input file.
5487.4 \fB&d\fR Current vertical place in current diversion; equal to \fBnl\fR, if no diversion.
5492.2 \fB&f\fR Current font as physical quadrant (1-4).
5504 \fB&h\fR Text base-line high-water mark on current page or diversion.
5516 \fB&i\fR Current indent.
5524.2 \fB&j\fR Current adjustment mode and type.
5534.1 \fB&k\fR Length of text portion on current partial output line.
5546 \fB&l\fR Current line length.
5554 \fB&n\fR Length of text portion on previous output line.
5563 \fB&o\fR Current page offset.
5573 \fB&p\fR Current page length.
5582.3 \fB&s\fR Current point size.
5597.5 \fB&t\fR Distance to the next trap.
5604.1 \fB&u\fR Equal to 1 in fill mode and 0 in nofill mode.
5615.1 \fB&v\fR Current vertical line spacing.
56211.2 \fB&w\fR Width of previous character.
563- \fB&x\fR Reserved version-dependent register.
564- \fB&y\fR Reserved version-dependent register.
5657.4 \fB&z\fR Name of current diversion.
566.TE
567.in 0
568.fi
569.ps 10
570.vs 12
571.ft R
572.bp
40.br
41.tr |
42.ce
43.ft B
44SUMMARY OF REQUESTS AND OUTLINE OF THIS MANUAL
45.ft R
46.de mx
47.ev 2
48.nf
49.h1
50.in
51.sp
52.fi
53.ev
54.ns
55..
56.xx
57.h1 \s-1#\s+1 *
58.fn
59.sp .3
60*Values separated by "\fB;\fR" are for \*(NR and \*(TR respectively.
61.sp .2
62\s-1#\s+1Notes are explained at the end of this Summary and Index
63.ef
64.mh
65General Explanation
66.mh
67Font and Character Size Control
68.bt
69\fB&ps\fI\|\(+-N\fR 10\|point previous E Point size; also \fB\es\fI\(+-N\fR.\(dg
70.b1
71\fB&fz\fI|F|\(+-N\fR off - E font \fIF\fR to point size \fI\(+-N\fR.
72.b1
73\fB&fz|S|\fIF|\(+-N\fR off - E Special Font characters to point size \fI\(+-N\fR.
74.b1
75\fB&ss\fI|N\fR 12\(sl36\|em ignored E Space-character size
76set to \fIN\fR\(sl36\|em.\(dg
77.b1
78\fB&cs\fI|F\|N\|M\fR off - P Constant character
79space (width)
80mode (font \fIF\^\fR\^).\(dg
81.b1
82\fB&bd\fI|F|N\fR off - P Embolden font \fIF\fR by \fIN\fR\(mi1 units.\(dg
83.b1
84\fB&bd|S|\fIF|N\fR off - P Embolden Special Font when current font is \fIF\fR.\(dg
85.fn
86.sp .2
87\(dgNo effect in \*(NR.
88.ef
89.b1
90\fB&ft\fI|F\fR Roman previous E Change to font
91\fIF\fR|= \fIx\fR, \fIxx\fR, or 1-4.
92Also \fB\ef\fIx\fR,\|\fB\ef(\fIxx\fR,\|\fB\ef\fIN\fR.
93.b1
94\fB&fp\fI|N|F\fR R,I,B,S ignored - Font named \fIF\fR mounted on physical position 1\(<=\fIN\fR\(<=4.
95.mh
96Page Control
97.bt
98\fB&pl\fI|\(+-N\fR 11\|in 11\|in \fBv\fR Page length.
99.b1
100\fB&bp|\fI\(+-N\fR \fIN\(eq\fR1 - B\(dd,\fBv\fR \
101Eject current page; next page number \fIN\fR.
102.fn
103.sp .2
104\(ddThe use of "\ \fB\'\fR\ " as control character (instead of "\fB.\fR")
105suppresses the break function.
106.ef
107.b1
108\fB&pn\fI|\(+-N N\(eq\fR1 ignored - Next page number \fIN\fR.
109.b1
110\fB&po\fI|\(+-N\fR 0;|26\(sl27\|in previous \fBv\fR Page offset.
111.b1
112\fB&ne\fI|N\fR - \fIN\(eq\fR1\fIV\fR D,\fBv\fR Need \fIN\fR vertical space (\fIV\fR = vertical spacing).
113.b1
114\fB&mk|\fIR\fR none internal D Mark current vertical place in register \fIR\fR.
115.b1
116\fB&rt\fI|\(+-N\fR none internal D,\fBv\fR Return \fI(upward only)\fR to marked vertical place.
117.mh
118Text Filling, Adjusting, and Centering
119.bt
120\fB&br\fR - - B Break.
121.b1
122.lg 0
123\fB&fi\fR \(fill - B,E Fill output lines.
124.lg
125.b1
126\fB&nf\fR fill - B,E No filling or adjusting of output lines.
127.b1
128\fB&ad\fI|c\fR adj,both adjust E Adjust output lines with mode \fIc\fR.
129.b1
130\fB&na\fR adjust - E No output line adjusting.
131.b1
132\fB&ce\fI|N\fR off \fIN\(eq\fR1 B,E Center following \fIN\fR input text lines.
133.mh
134Vertical Spacing
135.bt
136\fB&vs\fI|N\fR 1\(sl6in;12pts previous E,\fBp\fR Vertical base line spacing (\fIV\fR\^).
137.b1
138\fB&ls\fI|N N\(eq\fR1 previous E Output \fIN\(mi\fR1 \fIV\^\fRs after each text output line.
139.b1
140\fB&sp\fI|N\fR - \fIN\(eq\fR1\fIV\fR B,\fBv\fR Space \
141vertical distance \fIN\fR \fIin either direction\fR.
142.b1
143\fB&sv\fI|N\fR - \fIN\(eq\fR1\fIV\fR \fBv\fR Save vertical distance \fIN\fR.
144.b1
145\fB&os\fR - - - Output saved vertical distance.
146.b1
147\fB&ns\fR space - D Turn no-space mode on.
148.b1
149\fB&rs\fR - - D Restore spacing; turn no-space mode off.
150.mh
151Line Length and Indenting
152.bt
153\fB&ll\fI|\(+-N\fR 6.5\|in previous E,\fBm\fR Line length.
154.b1
155\fB&in\fI|\(+-N\fR \fIN\(eq\fR\^0 previous B,E,\fBm\fR Indent.
156.b1
157\fB&ti\fI|\(+-N\fR - ignored B,E,\fBm\fR Temporary indent.
158.mh
159Macros, Strings, Diversion, and Position Traps
160.bt
161\fB&de\fI|xx|yy\fR - \fI.yy=\fB..\fR - Define or redefine macro \fIxx;\fR end at call of \fIyy\fR.
162.b1
163\fB&am\fI|xx|yy\fR - \fI.yy=\fB..\fR - Append to a macro.
164.b1
165\fB&ds\fI|xx|string\fR - ignored - Define a string \fIxx\fR containing \fIstring\fR.
166.b1
167\fB&as\fI|xx|string\fR - ignored - Append \fIstring\fR to string \fIxx\fR.
168.b1
169\fB&rm\fI|xx\fR - ignored - Remove request, macro, or string.
170.b1
171\fB&rn\fI|xx|yy\fR - ignored - Rename request, macro, or string \fIxx\fR to \fIyy\fR.
172.b1
173\fB&di\fI|xx\fR - end D Divert output to macro \fIxx\fR.
174.b1
175\fB&da\fI|xx\fR - end D Divert and append to \fIxx\fR.
176.b1
177\fB&wh\fI|N|xx\fR - - \fBv\fR Set location trap; negative is w.r.t. page bottom.
178.b1
179\fB&ch\fI|xx|N\fR - - \fBv\fR Change trap location.
180.b1
181\fB&dt\fI|N|xx\fR - off D,\fBv\fR Set a diversion trap.
182.b1
183\fB&it\fI|N|xx\fR - off E Set an input-line count trap.
184.b1
185\fB&em\fI|xx\fR none none - End macro is \fIxx\fI.
186.mh
187Number Registers
188.bt
189\fB&nr\fI|R|\(+-N|M\fR - - \fBu\fR Define and set number register \fIR\fR; auto-increment by \fIM\fR.
190.b1
191\fB&af\fI|R|c\fR arabic - - Assign format to register \fIR\fR (\fIc=\fB1\fR, \fBi\fR, \fBI\fR, \fBa\fR, \fBA\fR).
192.b1
193\fB&rr\fI|R\fR - - - Remove register \fIR\fR.
194.mh
195Tabs, Leaders, and Fields
196.bt
197\fB&ta\fI|Nt|...\fR 0.8;|0.5in none E,\fBm\fR Tab settings; \fIleft\fR type, unless \fIt=\fBR\fR(right), \fBC\fR(centered).
198.b1
199\fB&tc\fI|c\fR none none E Tab repetition character.
200.b1
201\fB&lc\fI|c\fR \fB.\fR none E Leader repetition character.
202.b1
203\fB&fc\fI|a|b\fR off off - Set field delimiter \fIa\fR and pad character \fIb\fR.
204.mh
205Input and Output Conventions and Character Translations
206.bt
207\fB&ec\fI|c\fR \e \e - Set escape character.
208.b1
209\fB&eo\fR on - - Turn off escape character mechanism.
210.b1
211\fB&lg\fI|N\fR -;\|on on - Ligature mode
212on if \fIN\fR>0.
213.b1
214\fB&ul\fI|N\fR off \fIN\(eq\fR1 E Underline (italicize in \*(TR) \fIN\fR input lines.
215.b1
216\fB&cu\fI|N\fR off \fIN\(eq\fR1 E Continuous underline in \*(NR; like \fBul\fR in \*(TR.
217.b1
218\fB&uf\fI|F\fR Italic Italic - Underline font set to \fIF\fR (to be switched to by \fBul\fR).
219.b1
220\fB&cc\fI|c\fR \fB. .\fR E Set control character to \fIc\fR.
221.b1
222\fB&c2\fI|c\fR \fB\' \'\fR E Set nobreak control character to \fIc\fR.
223.b1
224\fB&tr\fI|abcd....\fR none - O Translate \fIa\fR to \fIb\fR, etc. on output.
225.mh
226Local Horizontal and Vertical Motions, and the Width Function
227.mh
228Overstrike, Bracket, Line-drawing, and Zero-width Functions
229.mh
230Hyphenation.
231.bt
232\fB&nh\fR hyphenate - E No hyphenation.
233.b1
234\fB&hy\fI|N\fR hyphenate hyphenate E Hyphenate; \fIN =\fR mode.
235.b1
236\fB&hc\fI|c\fR \fB\e% \e%\fR E Hyphenation indicator character \fIc\fR.
237.b1
238\fB&hw\fI|word1|...\fR ignored - Exception words.
239.mh
240Three Part Titles.
241.bt
242\fB&tl\fI|\'left\|\'center\|\'right\|\'\fR - - Three part title.
243.b1
244\fB&pc\fI|c\fR \fB%\fR off - Page number character.
245.b1
246\fB&lt\fI|\(+-N\fR 6.5\|in previous E,\fBm\fR Length of title.
247.mh
248Output Line Numbering.
249.bt
250\fB&nm\fI|\(+-N|M|S|I\fR off E Number mode on or off, set parameters.
251.b1
252\fB&nn\fI|N\fR - \fIN\(eq\fR1 E Do not number next \fIN\fR lines.
253.mh
254Conditional Acceptance of Input
255.bt
256\fB&if\fI|c|anything\fR - - If condition \fIc\fR true, accept \fIanything\fR as input,
257.b1
258 for multi-line use \fI\e{anything\|\e}\fR.
259.b1
260\fB&if|!\fIc|anything\fR - - If condition \fIc\fR false, accept \fIanything\fR.
261.b1
262\fB&if\fI|N|anything\fR - \fBu\fR If expression \fIN\fR > 0, accept \fIanything\fR.
263.b1
264\fB&if|!\fIN|anything\fR - \fBu\fR If expression \fIN\fR \(<= 0, accept \fIanything\fR.
265.b1
266\fB&if\fI|\|\'string1\|\'string2\|\'|anything\fR - If \fIstring1\fR identical to \fIstring2\fR,
267accept \fIanything\fR.
268.b1
269\fB&if|!\fI\|\'string1\|\'string2\|\'|anything\fR - If \fIstring1\fR not identical to \fIstring2\fR,
270accept \fIanything\fR.
271.b1
272\fB&ie\fI|c|anything\fR - \fBu\fR If portion of if-else; all above forms (like \fBif\fR).
273.b1
274\fB&el\fI|anything\fR - - Else portion of if-else.
275.mh
276Environment Switching.
277.bt
278\fB&ev\fI|N\fR \fIN\(eq\fR0 previous - Environment switched (\fIpush down\fR).
279.mh
280Insertions from the Standard Input
281.bt
282\fB&rd\fI|prompt\fR\fR - \fIprompt=\s-1\fRBEL\s+1 Read insertion.
283.b1
284\fB&ex\fR - - - \
285Exit from \*(NR\(sl\*(TR.
286.mh
287Input\(slOutput File Switching
288.bt
289\fB&so\fI|filename\fR - - Switch source file \fI(push down)\fR.
290.b1
291\fB&nx\fI|filename\fR end-of-file - Next file.
292.b1
293\fB&pi\fI|program\fR - - Pipe output to \fIprogram\fR (\*(NR only).
294.mh
295Miscellaneous
296.bt
297\fB&mc\fI|c|N\fR - off E,\fBm\fR Set margin character \fIc\fR and separation \fIN\fR.
298.b1
299\fB&tm\fI|string\fR - newline - Print \fIstring\fR on terminal \
300(\s-1UNIX\s+1 standard error output).
301.b1
302\fB&ig\fI|yy\fR - \fI.yy=\fB..\fR - Ignore till call of \fIyy\fR.
303.b1
304\fB&pm\fI|t\fR - all - Print macro names and sizes;
305.b1
306 if \fIt\fR present, print only total of sizes.
307.b1
308\fB&ab\fI|string\fR - - - Print a message and abort.
309.b1
310.lg 0
311\fB&fl\fR - - B Flush output buffer.
312.lg
313.mh
314Output and Error Messages
315.xx
316.nf
317.rm mx
318.ft R
319\l'\n(.lu'
320.ft B
321.xx
322.ta .3iC .6i
323 Notes-
324.xx
325.ft R
326 B Request normally causes a break.
327 D Mode or relevant parameters associated with current diversion level.
328 E Relevant parameters are a part of the current environment.
329 O Must stay in effect until logical output.
330 P Mode must be still or again in effect at the time of physical output.
331 \fBv\fR,\fBp\fR,\fBm\fR,\fBu\fR Default scale indicator; if not specified, scale indicators are \fIignored\fR.
332.br
333.nr zz 11
334.de cl
335.ie \\n+(cl<\n(zz \{\
336. po +\\n(.lu/\n(zzu
337. rt\}
338.el \{.po 26i/27u\}
339..
340.nr cl 0 1
341.di zz
342.ta .3iR
343.nf
344.ps 8
345.vs 10
346ab 20
347ad 4
348af 8
349am 7
350as 7
351bd 2
352bp 3
353br 4
354c2 10
355cc 10
356ce 4
357ch 7
358cs 2
359cu 10
360da 7
361de 7
362di 7
363ds 7
364dt 7
365ec 10
366el 16
367em 7
368eo 10
369ev 17
370ex 18
371fc 9
372fi 4
373fl 20
374fp 2
375ft 2
376fz 2
377hc 13
378hw 13
379hy 13
380ie 16
381if 16
382ig 20
383in 6
384it 7
385lc 9
386lg 10
387li 10
388ll 6
389ls 5
390lt 14
391mc 20
392mk 3
393na 4
394ne 3
395nf 4
396nh 13
397nm 15
398nn 15
399nr 8
400ns 5
401nx 19
402os 5
403pc 14
404pi 19
405pl 3
406pm 20
407pn 3
408po 3
409ps 2
410rd 18
411rm 7
412rn 7
413rr 8
414rs 5
415rt 3
416so 19
417sp 5
418ss 2
419sv 5
420ta 9
421tc 9
422ti 6
423tl 14
424tm 20
425tr 10
426uf 10
427ul 10
428vs 5
429wh 7
430.di
431.nr aa \n(dn/\n(zz
432.ne \n(aau+10p
433.sp
434.ft B
435Alphabetical Request and Section Number Cross Reference
436.ft
437.sp .3
438.wh \n(nlu+\n(aau cl
439.nr qq \n(nlu+\n(aau
440.ps
441.vs
442.mk
443.zz
444.rt
445.sp \n(.tu
446.ch cl 12i
447.sp
448.bp
449.nf
450.ft B
451Escape Sequences for Characters, Indicators, and Functions
452.ft R
453.xx
454.TS
455c2l
456c2l2l
457n2l2l.
458.ft I
459.bd I 3
460Section Escape
461Reference Sequence Meaning
462.ft R
463.bd I
464.xx
46510.1 \fB\e\e\fR \e (to prevent or delay the interpretation of \e\|)
46610.1 \fB\ee\fR Printable version of the \fIcurrent\fR escape character.
4672.1 \fB\e\'\fR \' (acute accent); equivalent to \fB\e(aa\fR
4682.1 \fB\e\`\fR \` (grave accent); equivalent to \fB\e(ga\fR
4692.1 \fB\e\-\fR \- Minus sign in the \fIcurrent\fR font
4707 \fB\e\^.\fR Period (dot) (see \fBde\fR)
47111.1 \fB\e\fR(space) Unpaddable space-size space character
47211.1 \fB\e0\fR Digit width space
473.tr ||
47411.1 \fB\e\||\fR 1\(sl6\|em narrow space character (zero width in \*(NR)
475.tr |
47611.1 \fB\e^\fR 1\(sl12\|em half-narrow space character (zero width in \*(NR)
477.tr &&
4784.1 \fB\e&\fR Non-printing, zero width character
479.tr &.
48010.6 \fB\e!\fR Transparent line indicator
48110.7 \fB\e"\fR Beginning of comment
4827.3 \fB\e$\fIN\fR Interpolate argument 1\(<=\fIN\fR\(<=9
48313 \fB\e%\fR Default optional hyphenation character
4842.1 \fB\e(\fIxx\fR Character named \fIxx\fR
4857.1 \fB\e\(**\fIx\fR,|\fB\e\(**(\fIxx\fR Interpolate string \fIx\fR or \fIxx\fR
4869.1 \fB\ea\fR Non-interpreted leader character
48712.3 \fB\eb\fI\'abc...\|\'\fR Bracket building function
4884.2 \fB\ec\fR Interrupt text processing
48911.1 \fB\ed\fR Forward (down) 1\(sl2\|em vertical motion (1\(sl2 line in \*(NR)
4902.2 \fB\ef\fIx\fR,\fB\ef(\fIxx\fR,\fB\ef\fIN\fR Change to font named \fIx\fR or \fIxx\fR, or position \fIN\fR
49111.1 \fB\eh\fI\'N|\'\fR Local horizontal motion; move right \fIN\fR \fI(negative left)\fR
49211.3 \fB\ek\fIx\fR Mark horizontal \fIinput\fR place in register \fIx\fR
49312.4 \fB\el\fI\|\'Nc\|\'\fR Horizontal line drawing function (optionally with \fIc\fR\|)
49412.4 \fB\eL\fI\'Nc\|\'\fR Vertical line drawing function (optionally with \fIc\fR\|)
4958 \fB\en\fIx\fR,\fB\en(\fIxx\fR Interpolate number register \fIx\fR or \fIxx\fR
49612.1 \fB\eo\fI\'abc...\|\'\fR Overstrike characters \fIa, b, c, ...\fR
4974.1 \fB\ep\fR Break and spread output line
49811.1 \fB\er\fR Reverse 1\|em vertical motion (reverse line in \*(NR)
4992.3 \fB\es\fIN\fR,\|\fB\es\fI\(+-N\fR Point-size change function
5009.1 \fB\et\fR Non-interpreted horizontal tab
50111.1 \fB\eu\fR Reverse (up) 1\(sl2\|em vertical motion (1\(sl2 line in \*(NR)
50211.1 \fB\ev\fI\'N\|\|\'\fR Local vertical motion; move down \fIN\fR \fI(negative up)\fR
50311.2 \fB\ew\fI\'string\|\'\fR Interpolate width of \fIstring\fR
5045.2 \fB\ex\fI\'N\|\|\'\fR Extra line-space function \fI(negative before, positive after)\fR
50512.2 \fB\ez\fIc\fR Print \fIc\fR with zero width (without spacing)
50616 \fB\e{\fR Begin conditional input
50716 \fB\e}\fR End conditional input
50810.7 \fB\e\fR(newline) Concealed (ignored) newline
509- \fB\e\fIX\fR \fIX\fR, any character \fInot\fR listed above
510.TE
511.fi
512.sp
513The escape sequences
514\fB\e\e\fR,
515\fB\e\^.\fR,
516\fB\e"\fR,
517\fB\e$\fR,
518\fB\e\(**\fR,
519\fB\ea\fR,
520\fB\en\fR,
521\fB\et\fR,
522and
523\fB\e\fR(newline) are interpreted in \fIcopy mode\fR (\(sc7.2).
524.bp
525.ft B
526.nf
527Predefined General Number Registers
528.ft
529.TS
530c2l
531c2l2l
532n2l2l.
533.ft I
534.bd I 3
535Section Register
536Reference Name Description
537.ft R
538.bd I
539.xx
5403 \fB%\fR Current page number.
54119 \fBc&\fR Number of \fIlines\fR read from current input file.
54211.2 \fBct\fR Character type (set by \fIwidth\fR function).
5437.4 \fBdl\fR Width (maximum) of last completed diversion.
5447.4 \fBdn\fR Height (vertical size) of last completed diversion.
545- \fBdw\fR Current day of the week (1-7).
546- \fBdy\fR Current day of the month (1-31).
54711.3 \fBhp\fR Current horizontal place on \fIinput\fR line (not in ditroff)
54815 \fBln\fR Output line number.
549- \fBmo\fR Current month (1-12).
5504.1 \fBnl\fR Vertical position of last printed text base-line.
55111.2 \fBsb\fR Depth of string below base line (generated by \fIwidth\fR function).
55211.2 \fBst\fR Height of string above base line (generated by \fIwidth\fR function).
553- \fByr\fR Last two digits of current year.
554.TE
555.sp
556.ft B
557Predefined Read-Only Number Registers
558.ft R
559.TS
560c2l
561c2l2l
562n2l2l.
563.ft I
564.bd I 3
565Section Register
566Reference Name Description
567.ft R
568.bd I
569.xx
5707.3 \fB&$\fR Number of arguments available at the current macro level.
571- \fB&A\fR Set to 1 in \*(TR, if \fB\-a\fR option used; always 1 in \*(NR.
57211.1 \fB&H\fR Available horizontal resolution in basic units.
5735.3 \fB&L\fR Set to current \fIline-spacing\fR (\fBls\fR) parameter
574- \fB&P\fR Set to 1 if the current page is being printed; otherwise 0.
575- \fB&T\fR Set to 1 in \*(NR, if \fB\-T\fR option used; always 0 in \*(TR.
57611.1 \fB&V\fR Available vertical resolution in basic units.
5775.2 \fB&a\fR Post-line extra line-space most recently utilized \
578using \fB\ex\fI\'N\|\'\fR.
57919 \fB&c\fR Number of \fIlines\fR read from current input file.
5807.4 \fB&d\fR Current vertical place in current diversion; equal to \fBnl\fR, if no diversion.
5812.2 \fB&f\fR Current font as physical quadrant (1-4).
5824 \fB&h\fR Text base-line high-water mark on current page or diversion.
5836 \fB&i\fR Current indent.
5844.2 \fB&j\fR Current adjustment mode and type.
5854.1 \fB&k\fR Length of text portion on current partial output line.
5866 \fB&l\fR Current line length.
5874 \fB&n\fR Length of text portion on previous output line.
5883 \fB&o\fR Current page offset.
5893 \fB&p\fR Current page length.
5902.3 \fB&s\fR Current point size.
5917.5 \fB&t\fR Distance to the next trap.
5924.1 \fB&u\fR Equal to 1 in fill mode and 0 in nofill mode.
5935.1 \fB&v\fR Current vertical line spacing.
59411.2 \fB&w\fR Width of previous character.
595- \fB&x\fR Reserved version-dependent register.
596- \fB&y\fR Reserved version-dependent register.
5977.4 \fB&z\fR Name of current diversion.
598.TE
599.in 0
600.fi
601.ps 10
602.vs 12
603.ft R
604.bp