1 .\" Copyright (C) Caldera International Inc. 2001-2002. All rights reserved.
3 .\" Redistribution and use in source and binary forms, with or without
4 .\" modification, are permitted provided that the following conditions are
7 .\" Redistributions of source code and documentation must retain the above
8 .\" copyright notice, this list of conditions and the following
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.
15 .\" All advertising materials mentioning features or use of this software
16 .\" must display the following acknowledgement:
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
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.
37 .\" @(#)m0a 8.1 (Berkeley) 8/14/93
44 SUMMARY OF REQUESTS AND OUTLINE OF THIS MANUAL
60 *Values separated by "\fB;\fR" are for \*(NR and \*(TR respectively.
62 \s-1#\s+1Notes are explained at the end of this Summary and Index
67 Font and Character Size Control
69 \fB&ps\fI\|\(+-N\fR 10\|point previous E Point size; also \fB\es\fI\(+-N\fR.\(dg
71 \fB&fz\fI|F|\(+-N\fR off - E font \fIF\fR to point size \fI\(+-N\fR.
73 \fB&fz|S|\fIF|\(+-N\fR off - E Special Font characters to point size \fI\(+-N\fR.
75 \fB&ss\fI|N\fR 12\(sl36\|em ignored E Space-character size
76 set to \fIN\fR\(sl36\|em.\(dg
78 \fB&cs\fI|F\|N\|M\fR off - P Constant character
80 mode (font \fIF\^\fR\^).\(dg
82 \fB&bd\fI|F|N\fR off - P Embolden font \fIF\fR by \fIN\fR\(mi1 units.\(dg
84 \fB&bd|S|\fIF|N\fR off - P Embolden Special Font when current font is \fIF\fR.\(dg
87 \(dgNo effect in \*(NR.
90 \fB&ft\fI|F\fR Roman previous E Change to font
91 \fIF\fR|= \fIx\fR, \fIxx\fR, or 1-4.
92 Also \fB\ef\fIx\fR,\|\fB\ef(\fIxx\fR,\|\fB\ef\fIN\fR.
94 \fB&fp\fI|N|F\fR R,I,B,S ignored - Font named \fIF\fR mounted on physical position 1\(<=\fIN\fR\(<=4.
98 \fB&pl\fI|\(+-N\fR 11\|in 11\|in \fBv\fR Page length.
100 \fB&bp|\fI\(+-N\fR \fIN\(eq\fR1 - B\(dd,\fBv\fR \
101 Eject current page; next page number \fIN\fR.
104 \(ddThe use of "\ \fB\'\fR\ " as control character (instead of "\fB.\fR")
105 suppresses the break function.
108 \fB&pn\fI|\(+-N N\(eq\fR1 ignored - Next page number \fIN\fR.
110 \fB&po\fI|\(+-N\fR 0;|26\(sl27\|in previous \fBv\fR Page offset.
112 \fB&ne\fI|N\fR - \fIN\(eq\fR1\fIV\fR D,\fBv\fR Need \fIN\fR vertical space (\fIV\fR = vertical spacing).
114 \fB&mk|\fIR\fR none internal D Mark current vertical place in register \fIR\fR.
116 \fB&rt\fI|\(+-N\fR none internal D,\fBv\fR Return \fI(upward only)\fR to marked vertical place.
118 Text Filling, Adjusting, and Centering
120 \fB&br\fR - - B Break.
123 \fB&fi\fR \(fill - B,E Fill output lines.
126 \fB&nf\fR fill - B,E No filling or adjusting of output lines.
128 \fB&ad\fI|c\fR adj,both adjust E Adjust output lines with mode \fIc\fR.
130 \fB&na\fR adjust - E No output line adjusting.
132 \fB&ce\fI|N\fR off \fIN\(eq\fR1 B,E Center following \fIN\fR input text lines.
136 \fB&vs\fI|N\fR 1\(sl6in;12pts previous E,\fBp\fR Vertical base line spacing (\fIV\fR\^).
138 \fB&ls\fI|N N\(eq\fR1 previous E Output \fIN\(mi\fR1 \fIV\^\fRs after each text output line.
140 \fB&sp\fI|N\fR - \fIN\(eq\fR1\fIV\fR B,\fBv\fR Space \
141 vertical distance \fIN\fR \fIin either direction\fR.
143 \fB&sv\fI|N\fR - \fIN\(eq\fR1\fIV\fR \fBv\fR Save vertical distance \fIN\fR.
145 \fB&os\fR - - - Output saved vertical distance.
147 \fB&ns\fR space - D Turn no-space mode on.
149 \fB&rs\fR - - D Restore spacing; turn no-space mode off.
151 Line Length and Indenting
153 \fB&ll\fI|\(+-N\fR 6.5\|in previous E,\fBm\fR Line length.
155 \fB&in\fI|\(+-N\fR \fIN\(eq\fR\^0 previous B,E,\fBm\fR Indent.
157 \fB&ti\fI|\(+-N\fR - ignored B,E,\fBm\fR Temporary indent.
159 Macros, Strings, Diversion, and Position Traps
161 \fB&de\fI|xx|yy\fR - \fI.yy=\fB..\fR - Define or redefine macro \fIxx;\fR end at call of \fIyy\fR.
163 \fB&am\fI|xx|yy\fR - \fI.yy=\fB..\fR - Append to a macro.
165 \fB&ds\fI|xx|string\fR - ignored - Define a string \fIxx\fR containing \fIstring\fR.
167 \fB&as\fI|xx|string\fR - ignored - Append \fIstring\fR to string \fIxx\fR.
169 \fB&rm\fI|xx\fR - ignored - Remove request, macro, or string.
171 \fB&rn\fI|xx|yy\fR - ignored - Rename request, macro, or string \fIxx\fR to \fIyy\fR.
173 \fB&di\fI|xx\fR - end D Divert output to macro \fIxx\fR.
175 \fB&da\fI|xx\fR - end D Divert and append to \fIxx\fR.
177 \fB&wh\fI|N|xx\fR - - \fBv\fR Set location trap; negative is w.r.t. page bottom.
179 \fB&ch\fI|xx|N\fR - - \fBv\fR Change trap location.
181 \fB&dt\fI|N|xx\fR - off D,\fBv\fR Set a diversion trap.
183 \fB&it\fI|N|xx\fR - off E Set an input-line count trap.
185 \fB&em\fI|xx\fR none none - End macro is \fIxx\fI.
189 \fB&nr\fI|R|\(+-N|M\fR - - \fBu\fR Define and set number register \fIR\fR; auto-increment by \fIM\fR.
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).
193 \fB&rr\fI|R\fR - - - Remove register \fIR\fR.
195 Tabs, Leaders, and Fields
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).
199 \fB&tc\fI|c\fR none none E Tab repetition character.
201 \fB&lc\fI|c\fR \fB.\fR none E Leader repetition character.
203 \fB&fc\fI|a|b\fR off off - Set field delimiter \fIa\fR and pad character \fIb\fR.
205 Input and Output Conventions and Character Translations
207 \fB&ec\fI|c\fR \e \e - Set escape character.
209 \fB&eo\fR on - - Turn off escape character mechanism.
211 \fB&lg\fI|N\fR -;\|on on - Ligature mode
214 \fB&ul\fI|N\fR off \fIN\(eq\fR1 E Underline (italicize in \*(TR) \fIN\fR input lines.
216 \fB&cu\fI|N\fR off \fIN\(eq\fR1 E Continuous underline in \*(NR; like \fBul\fR in \*(TR.
218 \fB&uf\fI|F\fR Italic Italic - Underline font set to \fIF\fR (to be switched to by \fBul\fR).
220 \fB&cc\fI|c\fR \fB. .\fR E Set control character to \fIc\fR.
222 \fB&c2\fI|c\fR \fB\' \'\fR E Set nobreak control character to \fIc\fR.
224 \fB&tr\fI|abcd....\fR none - O Translate \fIa\fR to \fIb\fR, etc. on output.
226 Local Horizontal and Vertical Motions, and the Width Function
228 Overstrike, Bracket, Line-drawing, and Zero-width Functions
232 \fB&nh\fR hyphenate - E No hyphenation.
234 \fB&hy\fI|N\fR hyphenate hyphenate E Hyphenate; \fIN =\fR mode.
236 \fB&hc\fI|c\fR \fB\e% \e%\fR E Hyphenation indicator character \fIc\fR.
238 \fB&hw\fI|word1|...\fR ignored - Exception words.
242 \fB&tl\fI|\'left\|\'center\|\'right\|\'\fR - - Three part title.
244 \fB&pc\fI|c\fR \fB%\fR off - Page number character.
246 \fB<\fI|\(+-N\fR 6.5\|in previous E,\fBm\fR Length of title.
248 Output Line Numbering.
250 \fB&nm\fI|\(+-N|M|S|I\fR off E Number mode on or off, set parameters.
252 \fB&nn\fI|N\fR - \fIN\(eq\fR1 E Do not number next \fIN\fR lines.
254 Conditional Acceptance of Input
256 \fB&if\fI|c|anything\fR - - If condition \fIc\fR true, accept \fIanything\fR as input,
258 for multi-line use \fI\e{anything\|\e}\fR.
260 \fB&if|!\fIc|anything\fR - - If condition \fIc\fR false, accept \fIanything\fR.
262 \fB&if\fI|N|anything\fR - \fBu\fR If expression \fIN\fR > 0, accept \fIanything\fR.
264 \fB&if|!\fIN|anything\fR - \fBu\fR If expression \fIN\fR \(<= 0, accept \fIanything\fR.
266 \fB&if\fI|\|\'string1\|\'string2\|\'|anything\fR - If \fIstring1\fR identical to \fIstring2\fR,
267 accept \fIanything\fR.
269 \fB&if|!\fI\|\'string1\|\'string2\|\'|anything\fR - If \fIstring1\fR not identical to \fIstring2\fR,
270 accept \fIanything\fR.
272 \fB&ie\fI|c|anything\fR - \fBu\fR If portion of if-else; all above forms (like \fBif\fR).
274 \fB&el\fI|anything\fR - - Else portion of if-else.
276 Environment Switching.
278 \fB&ev\fI|N\fR \fIN\(eq\fR0 previous - Environment switched (\fIpush down\fR).
280 Insertions from the Standard Input
282 \fB&rd\fI|prompt\fR\fR - \fIprompt=\s-1\fRBEL\s+1 Read insertion.
285 Exit from \*(NR\(sl\*(TR.
287 Input\(slOutput File Switching
289 \fB&so\fI|filename\fR - - Switch source file \fI(push down)\fR.
291 \fB&nx\fI|filename\fR end-of-file - Next file.
293 \fB&pi\fI|program\fR - - Pipe output to \fIprogram\fR (\*(NR only).
297 \fB&mc\fI|c|N\fR - off E,\fBm\fR Set margin character \fIc\fR and separation \fIN\fR.
299 \fB&tm\fI|string\fR - newline - Print \fIstring\fR on terminal \
300 (\s-1UNIX\s+1 standard error output).
302 \fB&ig\fI|yy\fR - \fI.yy=\fB..\fR - Ignore till call of \fIyy\fR.
304 \fB&pm\fI|t\fR - all - Print macro names and sizes;
306 if \fIt\fR present, print only total of sizes.
308 \fB&ab\fI|string\fR - - - Print a message and abort.
311 \fB&fl\fR - - B Flush output buffer.
314 Output and Error Messages
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.
335 .ie \\n+(cl<\n(zz \{\
438 Alphabetical Request and Section Number Cross Reference
454 Escape Sequences for Characters, Indicators, and Functions
464 Reference Sequence Meaning
468 10.1 \fB\e\e\fR \e (to prevent or delay the interpretation of \e\|)
469 10.1 \fB\ee\fR Printable version of the \fIcurrent\fR escape character.
470 2.1 \fB\e\'\fR \' (acute accent); equivalent to \fB\e(aa\fR
471 2.1 \fB\e\`\fR \` (grave accent); equivalent to \fB\e(ga\fR
472 2.1 \fB\e\-\fR \- Minus sign in the \fIcurrent\fR font
473 7 \fB\e\^.\fR Period (dot) (see \fBde\fR)
474 11.1 \fB\e\fR(space) Unpaddable space-size space character
475 11.1 \fB\e0\fR Digit width space
477 11.1 \fB\e\||\fR 1\(sl6\|em narrow space character (zero width in \*(NR)
479 11.1 \fB\e^\fR 1\(sl12\|em half-narrow space character (zero width in \*(NR)
481 4.1 \fB\e&\fR Non-printing, zero width character
483 10.6 \fB\e!\fR Transparent line indicator
484 10.7 \fB\e"\fR Beginning of comment
485 7.3 \fB\e$\fIN\fR Interpolate argument 1\(<=\fIN\fR\(<=9
486 13 \fB\e%\fR Default optional hyphenation character
487 2.1 \fB\e(\fIxx\fR Character named \fIxx\fR
488 7.1 \fB\e\(**\fIx\fR,|\fB\e\(**(\fIxx\fR Interpolate string \fIx\fR or \fIxx\fR
489 9.1 \fB\ea\fR Non-interpreted leader character
490 12.3 \fB\eb\fI\'abc...\|\'\fR Bracket building function
491 4.2 \fB\ec\fR Interrupt text processing
492 11.1 \fB\ed\fR Forward (down) 1\(sl2\|em vertical motion (1\(sl2 line in \*(NR)
493 2.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
494 11.1 \fB\eh\fI\'N|\'\fR Local horizontal motion; move right \fIN\fR \fI(negative left)\fR
495 11.3 \fB\ek\fIx\fR Mark horizontal \fIinput\fR place in register \fIx\fR
496 12.4 \fB\el\fI\|\'Nc\|\'\fR Horizontal line drawing function (optionally with \fIc\fR\|)
497 12.4 \fB\eL\fI\'Nc\|\'\fR Vertical line drawing function (optionally with \fIc\fR\|)
498 8 \fB\en\fIx\fR,\fB\en(\fIxx\fR Interpolate number register \fIx\fR or \fIxx\fR
499 12.1 \fB\eo\fI\'abc...\|\'\fR Overstrike characters \fIa, b, c, ...\fR
500 4.1 \fB\ep\fR Break and spread output line
501 11.1 \fB\er\fR Reverse 1\|em vertical motion (reverse line in \*(NR)
502 2.3 \fB\es\fIN\fR,\|\fB\es\fI\(+-N\fR Point-size change function
503 9.1 \fB\et\fR Non-interpreted horizontal tab
504 11.1 \fB\eu\fR Reverse (up) 1\(sl2\|em vertical motion (1\(sl2 line in \*(NR)
505 11.1 \fB\ev\fI\'N\|\|\'\fR Local vertical motion; move down \fIN\fR \fI(negative up)\fR
506 11.2 \fB\ew\fI\'string\|\'\fR Interpolate width of \fIstring\fR
507 5.2 \fB\ex\fI\'N\|\|\'\fR Extra line-space function \fI(negative before, positive after)\fR
508 12.2 \fB\ez\fIc\fR Print \fIc\fR with zero width (without spacing)
509 16 \fB\e{\fR Begin conditional input
510 16 \fB\e}\fR End conditional input
511 10.7 \fB\e\fR(newline) Concealed (ignored) newline
512 - \fB\e\fIX\fR \fIX\fR, any character \fInot\fR listed above
526 \fB\e\fR(newline) are interpreted in \fIcopy mode\fR (\(sc7.2).
530 Predefined General Number Registers
539 Reference Name Description
543 3 \fB%\fR Current page number.
544 19 \fBc&\fR Number of \fIlines\fR read from current input file.
545 11.2 \fBct\fR Character type (set by \fIwidth\fR function).
546 7.4 \fBdl\fR Width (maximum) of last completed diversion.
547 7.4 \fBdn\fR Height (vertical size) of last completed diversion.
548 - \fBdw\fR Current day of the week (1-7).
549 - \fBdy\fR Current day of the month (1-31).
550 11.3 \fBhp\fR Current horizontal place on \fIinput\fR line (not in ditroff)
551 15 \fBln\fR Output line number.
552 - \fBmo\fR Current month (1-12).
553 4.1 \fBnl\fR Vertical position of last printed text base-line.
554 11.2 \fBsb\fR Depth of string below base line (generated by \fIwidth\fR function).
555 11.2 \fBst\fR Height of string above base line (generated by \fIwidth\fR function).
556 - \fByr\fR Last two digits of current year.
560 Predefined Read-Only Number Registers
569 Reference Name Description
573 7.3 \fB&$\fR Number of arguments available at the current macro level.
574 - \fB&A\fR Set to 1 in \*(TR, if \fB\-a\fR option used; always 1 in \*(NR.
575 11.1 \fB&H\fR Available horizontal resolution in basic units.
576 5.3 \fB&L\fR Set to current \fIline-spacing\fR (\fBls\fR) parameter
577 - \fB&P\fR Set to 1 if the current page is being printed; otherwise 0.
578 - \fB&T\fR Set to 1 in \*(NR, if \fB\-T\fR option used; always 0 in \*(TR.
579 11.1 \fB&V\fR Available vertical resolution in basic units.
580 5.2 \fB&a\fR Post-line extra line-space most recently utilized \
581 using \fB\ex\fI\'N\|\'\fR.
582 19 \fB&c\fR Number of \fIlines\fR read from current input file.
583 7.4 \fB&d\fR Current vertical place in current diversion; equal to \fBnl\fR, if no diversion.
584 2.2 \fB&f\fR Current font as physical quadrant (1-4).
585 4 \fB&h\fR Text base-line high-water mark on current page or diversion.
586 6 \fB&i\fR Current indent.
587 4.2 \fB&j\fR Current adjustment mode and type.
588 4.1 \fB&k\fR Length of text portion on current partial output line.
589 6 \fB&l\fR Current line length.
590 4 \fB&n\fR Length of text portion on previous output line.
591 3 \fB&o\fR Current page offset.
592 3 \fB&p\fR Current page length.
593 2.3 \fB&s\fR Current point size.
594 7.5 \fB&t\fR Distance to the next trap.
595 4.1 \fB&u\fR Equal to 1 in fill mode and 0 in nofill mode.
596 5.1 \fB&v\fR Current vertical line spacing.
597 11.2 \fB&w\fR Width of previous character.
598 - \fB&x\fR Reserved version-dependent register.
599 - \fB&y\fR Reserved version-dependent register.
600 7.4 \fB&z\fR Name of current diversion.