ncurses 6.2 - patch 20211018
[ncurses.git] / man / terminfo.tail
1 .\"***************************************************************************
2 .\" Copyright 2018-2020,2021 Thomas E. Dickey                                *
3 .\" Copyright 1998-2016,2017 Free Software Foundation, Inc.                  *
4 .\"                                                                          *
5 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
6 .\" copy of this software and associated documentation files (the            *
7 .\" "Software"), to deal in the Software without restriction, including      *
8 .\" without limitation the rights to use, copy, modify, merge, publish,      *
9 .\" distribute, distribute with modifications, sublicense, and/or sell       *
10 .\" copies of the Software, and to permit persons to whom the Software is    *
11 .\" furnished to do so, subject to the following conditions:                 *
12 .\"                                                                          *
13 .\" The above copyright notice and this permission notice shall be included  *
14 .\" in all copies or substantial portions of the Software.                   *
15 .\"                                                                          *
16 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
17 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
18 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
19 .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
20 .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
21 .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
22 .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
23 .\"                                                                          *
24 .\" Except as contained in this notice, the name(s) of the above copyright   *
25 .\" holders shall not be used in advertising or otherwise to promote the     *
26 .\" sale, use or other dealings in this Software without prior written       *
27 .\" authorization.                                                           *
28 .\"***************************************************************************
29 .\"
30 .\" $Id: terminfo.tail,v 1.108 2021/10/09 23:13:23 tom Exp $
31 .ps +1
32 .SS User-Defined Capabilities
33 .
34 The preceding section listed the \fIpredefined\fP capabilities.
35 They deal with some special features for terminals no longer
36 (or possibly never) produced.
37 Occasionally there are special features of newer terminals which
38 are awkward or impossible to represent by reusing the predefined
39 capabilities.
40 .PP
41 \fBncurses\fP addresses this limitation by allowing user-defined capabilities.
42 The \fB@TIC@\fP and \fB@INFOCMP@\fP programs provide
43 the \fB\-x\fP option for this purpose.
44 When \fB\-x\fP is set,
45 \fB@TIC@\fP treats unknown capabilities as user-defined.
46 That is, if \fB@TIC@\fP encounters a capability name
47 which it does not recognize,
48 it infers its type (boolean, number or string) from the syntax
49 and makes an extended table entry for that capability.
50 The \fBuse_extended_names\fP(3X) function makes this information
51 conditionally available to applications.
52 The ncurses library provides the data leaving most of the behavior
53 to applications:
54 .bP
55 User-defined capability strings whose name begins
56 with \*(``k\*('' are treated as function keys.
57 .bP
58 The types (boolean, number, string) determined by \fB@TIC@\fP
59 can be inferred by successful calls on \fBtigetflag\fP, etc.
60 .bP
61 If the capability name happens to be two characters,
62 the capability is also available through the termcap interface.
63 .PP
64 While termcap is said to be extensible because it does not use a predefined set
65 of capabilities,
66 in practice it has been limited to the capabilities defined by
67 terminfo implementations.
68 As a rule,
69 user-defined capabilities intended for use by termcap applications should
70 be limited to booleans and numbers to avoid running past the 1023 byte
71 limit assumed by termcap implementations and their applications.
72 In particular, providing extended sets of function keys (past the 60
73 numbered keys and the handful of special named keys) is best done using
74 the longer names available using terminfo.
75 .
76 .SS A Sample Entry
77 .
78 The following entry, describing an ANSI-standard terminal, is representative
79 of what a \fBterminfo\fR entry for a modern terminal typically looks like.
80 .PP
81 .nf
82 .ft CW
83 \s-2ansi|ansi/pc-term compatible with color,
84         am, mc5i, mir, msgr,
85         colors#8, cols#80, it#8, lines#24, ncv#3, pairs#64,
86         acsc=+\\020\\,\\021-\\030.^Y0\\333`\\004a\\261f\\370g\\361h\\260
87              j\\331k\\277l\\332m\\300n\\305o~p\\304q\\304r\\304s_t\\303
88              u\\264v\\301w\\302x\\263y\\363z\\362{\\343|\\330}\\234~\\376,
89         bel=^G, blink=\\E[5m, bold=\\E[1m, cbt=\\E[Z, clear=\\E[H\\E[J,
90         cr=^M, cub=\\E[%p1%dD, cub1=\\E[D, cud=\\E[%p1%dB, cud1=\\E[B,
91         cuf=\\E[%p1%dC, cuf1=\\E[C, cup=\\E[%i%p1%d;%p2%dH,
92         cuu=\\E[%p1%dA, cuu1=\\E[A, dch=\\E[%p1%dP, dch1=\\E[P,
93         dl=\\E[%p1%dM, dl1=\\E[M, ech=\\E[%p1%dX, ed=\\E[J, el=\\E[K,
94         el1=\\E[1K, home=\\E[H, hpa=\\E[%i%p1%dG, ht=\\E[I, hts=\\EH,
95         ich=\\E[%p1%d@, il=\\E[%p1%dL, il1=\\E[L, ind=^J,
96         indn=\\E[%p1%dS, invis=\\E[8m, kbs=^H, kcbt=\\E[Z, kcub1=\\E[D,
97         kcud1=\\E[B, kcuf1=\\E[C, kcuu1=\\E[A, khome=\\E[H, kich1=\\E[L,
98         mc4=\\E[4i, mc5=\\E[5i, nel=\\r\\E[S, op=\\E[39;49m,
99         rep=%p1%c\\E[%p2%{1}%-%db, rev=\\E[7m, rin=\\E[%p1%dT,
100         rmacs=\\E[10m, rmpch=\\E[10m, rmso=\\E[m, rmul=\\E[m,
101         s0ds=\\E(B, s1ds=\\E)B, s2ds=\\E*B, s3ds=\\E+B,
102         setab=\\E[4%p1%dm, setaf=\\E[3%p1%dm,
103         sgr=\\E[0;10%?%p1%t;7%;
104                    %?%p2%t;4%;
105                    %?%p3%t;7%;
106                    %?%p4%t;5%;
107                    %?%p6%t;1%;
108                    %?%p7%t;8%;
109                    %?%p9%t;11%;m,
110         sgr0=\\E[0;10m, smacs=\\E[11m, smpch=\\E[11m, smso=\\E[7m,
111         smul=\\E[4m, tbc=\\E[3g, u6=\\E[%i%d;%dR, u7=\\E[6n,
112         u8=\\E[?%[;0123456789]c, u9=\\E[c, vpa=\\E[%i%p1%dd,
113 .fi
114 .ft R
115 .PP
116 Entries may continue onto multiple lines by placing white space at
117 the beginning of each line except the first.
118 Comments may be included on lines beginning with \*(``#\*(''.
119 Capabilities in
120 .I terminfo
121 are of three types:
122 .bP
123 Boolean capabilities which indicate that the terminal has
124 some particular feature,
125 .bP
126 numeric capabilities giving the size of the terminal
127 or the size of particular delays, and
128 .bP
129 string
130 capabilities, which give a sequence which can be used to perform particular
131 terminal operations.
132 .PP
133 .SS Types of Capabilities
134 .PP
135 All capabilities have names.
136 For instance, the fact that
137 ANSI-standard terminals have
138 .I "automatic margins"
139 (i.e., an automatic return and line-feed
140 when the end of a line is reached) is indicated by the capability \fBam\fR.
141 Hence the description of ansi includes \fBam\fR.
142 Numeric capabilities are followed by the character \*(``#\*('' and then a positive value.
143 Thus \fBcols\fR, which indicates the number of columns the terminal has,
144 gives the value \*(``80\*('' for ansi.
145 Values for numeric capabilities may be specified in decimal, octal or hexadecimal,
146 using the C programming language conventions (e.g., 255, 0377 and 0xff or 0xFF).
147 .PP
148 Finally, string valued capabilities, such as \fBel\fR (clear to end of line
149 sequence) are given by the two-character code, an \*(``=\*('', and then a string
150 ending at the next following \*(``,\*(''.
151 .PP
152 A number of escape sequences are provided in the string valued capabilities
153 for easy encoding of characters there:
154 .bP
155 Both \fB\eE\fR and \fB\ee\fR
156 map to an \s-1ESCAPE\s0 character,
157 .bP
158 \fB^x\fR maps to a control-x for any appropriate \fIx\fP, and
159 .bP
160 the sequences
161 .RS 6
162 .PP
163 \fB\en\fP, \fB\el\fP, \fB\er\fP, \fB\et\fP, \fB\eb\fP, \fB\ef\fP, and \fB\es\fR
164 .RE
165 .IP
166 produce
167 .RS 6
168 .PP
169 \fInewline\fP, \fIline-feed\fP, \fIreturn\fP, \fItab\fP, \fIbackspace\fP, \fIform-feed\fP, and \fIspace\fP,
170 .RE
171 .IP
172 respectively.
173 .PP
174 X/Open Curses does not say what \*(``appropriate \fIx\fP\*('' might be.
175 In practice, that is a printable ASCII graphic character.
176 The special case \*(``^?\*('' is interpreted as DEL (127).
177 In all other cases, the character value is AND'd with 0x1f,
178 mapping to ASCII control codes in the range 0 through 31.
179 .PP
180 Other escapes include
181 .bP
182 \fB\e^\fR for \fB^\fR,
183 .bP
184 \fB\e\e\fR for \fB\e\fR,
185 .bP
186 \fB\e\fR, for comma,
187 .bP
188 \fB\e:\fR for \fB:\fR,
189 .bP
190 and \fB\e0\fR for null.
191 .IP
192 \fB\e0\fR will produce \e200, which does not terminate a string but behaves
193 as a null character on most terminals, providing CS7 is specified.
194 See \fBstty\fP(1).
195 .IP
196 The reason for this quirk is to maintain binary compatibility of the
197 compiled terminfo files with other implementations,
198 e.g., the SVr4 systems, which document this.
199 Compiled terminfo files use null-terminated strings, with no lengths.
200 Modifying this would require a new binary format,
201 which would not work with other implementations.
202 .PP
203 Finally, characters may be given as three octal digits after a \fB\e\fR.
204 .PP
205 A delay in milliseconds may appear anywhere in a string capability, enclosed in
206 $<..> brackets, as in \fBel\fP=\eEK$<5>,
207 and padding characters are supplied by \fBtputs\fP(3X)
208 to provide this delay.
209 .bP
210 The delay must be a number with at most one decimal
211 place of precision; it may be followed by suffixes \*(``*\*('' or \*(``/\*('' or both.
212 .bP
213 A \*(``*\*(''
214 indicates that the padding required is proportional to the number of lines
215 affected by the operation, and the amount given is the per-affected-unit
216 padding required.
217 (In the case of insert character, the factor is still the
218 number of \fIlines\fP affected.)
219 .IP
220 Normally, padding is advisory if the device has the \fBxon\fR
221 capability; it is used for cost computation but does not trigger delays.
222 .bP
223 A \*(``/\*(''
224 suffix indicates that the padding is mandatory and forces a delay of the given
225 number of milliseconds even on devices for which \fBxon\fR is present to
226 indicate flow control.
227 .PP
228 Sometimes individual capabilities must be commented out.
229 To do this, put a period before the capability name.
230 For example, see the second
231 .B ind
232 in the example above.
233 .br
234 .ne 5
235 .PP
236 .SS Fetching Compiled Descriptions
237 .PP
238 The \fBncurses\fP library searches for terminal descriptions in several places.
239 It uses only the first description found.
240 The library has a compiled-in list of places to search
241 which can be overridden by environment variables.
242 Before starting to search,
243 \fBncurses\fP eliminates duplicates in its search list.
244 .bP
245 If the environment variable TERMINFO is set, it is interpreted as the pathname
246 of a directory containing the compiled description you are working on.
247 Only that directory is searched.
248 .bP
249 If TERMINFO is not set,
250 \fBncurses\fR will instead look in the directory \fB$HOME/.terminfo\fR
251 for a compiled description.
252 .bP
253 Next, if the environment variable TERMINFO_DIRS is set,
254 \fBncurses\fR will interpret the contents of that variable
255 as a list of colon-separated directories (or database files) to be searched.
256 .IP
257 An empty directory name (i.e., if the variable begins or ends
258 with a colon, or contains adjacent colons)
259 is interpreted as the system location \fI\*d\fR.
260 .bP
261 Finally, \fBncurses\fP searches these compiled-in locations:
262 .RS
263 .bP
264 a list of directories (@TERMINFO_DIRS@), and
265 .bP
266 the system terminfo directory, \fI\*d\fR (the compiled-in default).
267 .RE
268 .SS Preparing Descriptions
269 .PP
270 We now outline how to prepare descriptions of terminals.
271 The most effective way to prepare a terminal description is by imitating
272 the description of a similar terminal in
273 .I terminfo
274 and to build up a description gradually, using partial descriptions
275 with
276 .I vi
277 or some other screen-oriented program to check that they are correct.
278 Be aware that a very unusual terminal may expose deficiencies in
279 the ability of the
280 .I terminfo
281 file to describe it
282 or bugs in the screen-handling code of the test program.
283 .PP
284 To get the padding for insert line right (if the terminal manufacturer
285 did not document it) a severe test is to edit a large file at 9600 baud,
286 delete 16 or so lines from the middle of the screen, then hit the \*(``u\*(''
287 key several times quickly.
288 If the terminal messes up, more padding is usually needed.
289 A similar test can be used for insert character.
290 .PP
291 .SS Basic Capabilities
292 .PP
293 The number of columns on each line for the terminal is given by the
294 \fBcols\fR numeric capability.
295 If the terminal is a \s-1CRT\s0, then the
296 number of lines on the screen is given by the \fBlines\fR capability.
297 If the terminal wraps around to the beginning of the next line when
298 it reaches the right margin, then it should have the \fBam\fR capability.
299 If the terminal can clear its screen, leaving the cursor in the home
300 position, then this is given by the \fBclear\fR string capability.
301 If the terminal overstrikes
302 (rather than clearing a position when a character is struck over)
303 then it should have the \fBos\fR capability.
304 If the terminal is a printing terminal, with no soft copy unit,
305 give it both
306 .B hc
307 and
308 .BR os .
309 .RB ( os
310 applies to storage scope terminals, such as \s-1TEKTRONIX\s+1 4010
311 series, as well as hard copy and APL terminals.)
312 If there is a code to move the cursor to the left edge of the current
313 row, give this as
314 .BR cr .
315 (Normally this will be carriage return, control/M.)
316 If there is a code to produce an audible signal (bell, beep, etc)
317 give this as
318 .BR bel .
319 .PP
320 If there is a code to move the cursor one position to the left
321 (such as backspace) that capability should be given as
322 .BR cub1 .
323 Similarly, codes to move to the right, up, and down should be
324 given as
325 .BR cuf1 ,
326 .BR cuu1 ,
327 and
328 .BR cud1 .
329 These local cursor motions should not alter the text they pass over,
330 for example, you would not normally use \*(``\fBcuf1\fP=\ \*('' because the
331 space would erase the character moved over.
332 .PP
333 A very important point here is that the local cursor motions encoded
334 in
335 .I terminfo
336 are undefined at the left and top edges of a \s-1CRT\s0 terminal.
337 Programs should never attempt to backspace around the left edge,
338 unless
339 .B bw
340 is given,
341 and never attempt to go up locally off the top.
342 In order to scroll text up, a program will go to the bottom left corner
343 of the screen and send the
344 .B ind
345 (index) string.
346 .PP
347 To scroll text down, a program goes to the top left corner
348 of the screen and sends the
349 .B ri
350 (reverse index) string.
351 The strings
352 .B ind
353 and
354 .B ri
355 are undefined when not on their respective corners of the screen.
356 .PP
357 Parameterized versions of the scrolling sequences are
358 .B indn
359 and
360 .B rin
361 which have the same semantics as
362 .B ind
363 and
364 .B ri
365 except that they take one parameter, and scroll that many lines.
366 They are also undefined except at the appropriate edge of the screen.
367 .PP
368 The \fBam\fR capability tells whether the cursor sticks at the right
369 edge of the screen when text is output, but this does not necessarily
370 apply to a
371 .B cuf1
372 from the last column.
373 The only local motion which is defined from the left edge is if
374 .B bw
375 is given, then a
376 .B cub1
377 from the left edge will move to the right edge of the previous row.
378 If
379 .B bw
380 is not given, the effect is undefined.
381 This is useful for drawing a box around the edge of the screen, for example.
382 If the terminal has switch selectable automatic margins,
383 the
384 .I terminfo
385 file usually assumes that this is on; i.e., \fBam\fR.
386 If the terminal has a command which moves to the first column of the next
387 line, that command can be given as
388 .B nel
389 (newline).
390 It does not matter if the command clears the remainder of the current line,
391 so if the terminal has no
392 .B cr
393 and
394 .B lf
395 it may still be possible to craft a working
396 .B nel
397 out of one or both of them.
398 .PP
399 These capabilities suffice to describe hard-copy and \*(``glass-tty\*('' terminals.
400 Thus the model 33 teletype is described as
401 .PP
402 .DT
403 .nf
404 .ft CW
405 .\".in -2
406 \s-133\||\|tty33\||\|tty\||\|model 33 teletype,
407         bel=^G, cols#72, cr=^M, cud1=^J, hc, ind=^J, os,\s+1
408 .\".in +2
409 .ft R
410 .fi
411 .PP
412 while the Lear Siegler \s-1ADM-3\s0 is described as
413 .PP
414 .DT
415 .nf
416 .ft CW
417 .\".in -2
418 \s-1adm3\||\|3\||\|lsi adm3,
419         am, bel=^G, clear=^Z, cols#80, cr=^M, cub1=^H, cud1=^J,
420         ind=^J, lines#24,\s+1
421 .\".in +2
422 .ft R
423 .fi
424 .PP
425 .SS Parameterized Strings
426 .PP
427 Cursor addressing and other strings requiring parameters
428 in the terminal are described by a
429 parameterized string capability,
430 with \fIprintf\fP-like escapes such as \fI%x\fR in it.
431 For example, to address the cursor, the
432 .B cup
433 capability is given, using two parameters:
434 the row and column to address to.
435 (Rows and columns are numbered from zero and refer to the
436 physical screen visible to the user, not to any unseen memory.)
437 If the terminal has memory relative cursor addressing,
438 that can be indicated by
439 .BR mrcup .
440 .PP
441 The parameter mechanism uses a stack and special \fB%\fP codes
442 to manipulate it.
443 Typically a sequence will push one of the
444 parameters onto the stack and then print it in some format.
445 Print (e.g., \*(``%d\*('') is a special case.
446 Other operations, including \*(``%t\*('' pop their operand from the stack.
447 It is noted that more complex operations are often necessary,
448 e.g., in the \fBsgr\fP string.
449 .PP
450 The \fB%\fR encodings have the following meanings:
451 .PP
452 .TP 5
453 \fB%%\fP
454 outputs \*(``%\*(''
455 .TP
456 \fB%\fP\fI[[\fP:\fI]flags][width[.precision]][\fP\fBdoxXs\fP\fI]\fP
457 as in \fBprintf\fP(3), flags are \fI[\-+#]\fP and \fIspace\fP.
458 Use a \*(``:\*('' to allow the next character to be a \*(``\-\*('' flag,
459 avoiding interpreting \*(``%\-\*('' as an operator.
460 .TP
461 \f(CW%c\fP
462 print \fIpop()\fP like %c in \fBprintf\fP
463 .TP
464 \fB%s\fP
465 print \fIpop()\fP like %s in \fBprintf\fP
466 .TP
467 \fB%p\fP\fI[1\-9]\fP
468 push \fIi\fP'th parameter
469 .TP
470 \fB%P\fP\fI[a\-z]\fP
471 set dynamic variable \fI[a\-z]\fP to \fIpop()\fP
472 .TP
473 \fB%g\fP\fI[a\-z]/\fP
474 get dynamic variable \fI[a\-z]\fP and push it
475 .TP
476 \fB%P\fP\fI[A\-Z]\fP
477 set static variable \fI[a\-z]\fP to \fIpop()\fP
478 .TP
479 \fB%g\fP\fI[A\-Z]\fP
480 get static variable \fI[a\-z]\fP and push it
481 .IP
482 The terms \*(``static\*('' and \*(``dynamic\*('' are misleading.
483 Historically, these are simply two different sets of variables,
484 whose values are not reset between calls to \fBtparm\fP(3X).
485 However, that fact is not documented in other implementations.
486 Relying on it will adversely impact portability to other implementations:
487 .RS
488 .bP
489 SVr2 curses supported \fIdynamic\fP variables.
490 Those are set only by a \fB%P\fP operator.
491 A \fB%g\fP for a given variable without first setting it with \fB%P\fP
492 will give unpredictable results, because dynamic variables are
493 an uninitialized local array on the stack in the \fBtparm\fP function.
494 .bP
495 SVr3.2 curses supported \fIstatic\fP variables.
496 Those are an array in the \fBTERMINAL\fP
497 structure (declared in \fBterm.h\fP),
498 and are zeroed automatically when the \fBsetupterm\fP function
499 allocates the data.
500 .bP
501 SVr4 curses made no further improvements
502 to the \fIdynamic/static\fP variable feature.
503 .bP
504 Solaris XPG4 curses does not distinguish between \fIdynamic\fP and
505 \fIstatic\fP variables.
506 They are the same.
507 Like SVr4 curses, XPG4 curses does not initialize these explicitly.
508 .bP
509 Before version 6.3, ncurses stores both \fIdynamic\fP and \fIstatic\fP
510 variables in persistent storage, initialized to zeros.
511 .bP
512 Beginning with version 6.3, ncurses stores \fIstatic\fP and \fIdynamic\fP
513 variables in the same manner as SVr4.
514 Unlike other implementations, ncurses zeros dynamic variables 
515 before the first \fB%g\fP or \fB%P\fP operator.
516 .RE
517 .TP
518 \fB%\(aq\fP\fIc\fP\fB\(aq\fP
519 char constant \fIc\fP
520 .TP
521 \fB%{\fP\fInn\fP\fB}\fP
522 integer constant \fInn\fP
523 .TP
524 \fB%l\fP
525 push strlen(pop)
526 .TP
527 \fB%+\fP, \fB%\-\fP, \fB%*\fP, \fB%/\fP, \fB%m\fP
528 arithmetic (%m is \fImod\fP): \fIpush(pop() op pop())\fP
529 .TP
530 \fB%&\fP, \fB%|\fP, \fB%^\fP
531 bit operations (AND, OR and exclusive-OR): \fIpush(pop() op pop())\fP
532 .TP
533 \fB%=\fP, \fB%>\fP, \fB%<\fP
534 logical operations: \fIpush(pop() op pop())\fP
535 .TP
536 \fB%A\fP, \fB%O\fP
537 logical AND and OR operations (for conditionals)
538 .TP
539 \fB%!\fP, \fB%~\fP
540 unary operations (logical and bit complement): \fIpush(op pop())\fP
541 .TP
542 \fB%i\fP
543 add 1 to first two parameters (for ANSI terminals)
544 .TP
545 \fB%?\fP \fIexpr\fP \fB%t\fP \fIthenpart\fP \fB%e\fP \fIelsepart\fP \fB%;\fP
546 This forms an if-then-else.
547 The \fB%e\fP \fIelsepart\fP is optional.
548 Usually the \fB%?\fP \fIexpr\fP part pushes a value onto the stack,
549 and \fB%t\fP pops it from the stack, testing if it is nonzero (true).
550 If it is zero (false), control passes to the \fB%e\fP (else) part.
551 .IP
552 It is possible to form else-if's a la Algol 68:
553 .RS
554 \fB%?\fP c\d1\u \fB%t\fP b\d1\u \fB%e\fP c\d2\u \fB%t\fP b\d2\u \fB%e\fP c\d3\u \fB%t\fP b\d3\u \fB%e\fP c\d4\u \fB%t\fP b\d4\u \fB%e\fP \fB%;\fP
555 .RE
556 .IP
557 where c\di\u are conditions, b\di\u are bodies.
558 .IP
559 Use the \fB\-f\fP option of \fB@TIC@\fP or \fB@INFOCMP@\fP to see
560 the structure of if-then-else's.
561 Some strings, e.g., \fBsgr\fP can be very complicated when written
562 on one line.
563 The \fB\-f\fP option splits the string into lines with the parts indented.
564 .PP
565 Binary operations are in postfix form with the operands in the usual order.
566 That is, to get x\-5 one would use \*(``%gx%{5}%\-\*(''.
567 \fB%P\fP and \fB%g\fP variables are
568 persistent across escape-string evaluations.
569 .PP
570 Consider the HP2645, which, to get to row 3 and column 12, needs
571 to be sent \eE&a12c03Y padded for 6 milliseconds.
572 Note that the order
573 of the rows and columns is inverted here, and that the row and column
574 are printed as two digits.
575 Thus its \fBcup\fR capability is \*(``cup=6\eE&%p2%2dc%p1%2dY\*(''.
576 .PP
577 The Microterm \s-1ACT-IV\s0 needs the current row and column sent
578 preceded by a \fB^T\fR, with the row and column simply encoded in binary,
579 \*(``cup=^T%p1%c%p2%c\*(''.
580 Terminals which use \*(``%c\*('' need to be able to
581 backspace the cursor (\fBcub1\fR),
582 and to move the cursor up one line on the screen (\fBcuu1\fR).
583 This is necessary because it is not always safe to transmit \fB\en\fR
584 \fB^D\fR and \fB\er\fR, as the system may change or discard them.
585 (The library routines dealing with terminfo set tty modes so that
586 tabs are never expanded, so \et is safe to send.
587 This turns out to be essential for the Ann Arbor 4080.)
588 .PP
589 A final example is the \s-1LSI ADM\s0-3a, which uses row and column
590 offset by a blank character, thus \*(``cup=\eE=%p1%\(aq \(aq%+%c%p2%\(aq \(aq%+%c\*(''.
591 After sending \*(``\eE=\*('', this pushes the first parameter, pushes the
592 ASCII value for a space (32), adds them (pushing the sum on the stack
593 in place of the two previous values) and outputs that value as a character.
594 Then the same is done for the second parameter.
595 More complex arithmetic is possible using the stack.
596 .PP
597 .SS Cursor Motions
598 .PP
599 If the terminal has a fast way to home the cursor
600 (to very upper left corner of screen) then this can be given as
601 \fBhome\fR; similarly a fast way of getting to the lower left-hand corner
602 can be given as \fBll\fR; this may involve going up with \fBcuu1\fR
603 from the home position,
604 but a program should never do this itself (unless \fBll\fR does) because it
605 can make no assumption about the effect of moving up from the home position.
606 Note that the home position is the same as addressing to (0,0):
607 to the top left corner of the screen, not of memory.
608 (Thus, the \eEH sequence on HP terminals cannot be used for
609 .BR home .)
610 .PP
611 If the terminal has row or column absolute cursor addressing,
612 these can be given as single parameter capabilities
613 .B hpa
614 (horizontal position absolute)
615 and
616 .B vpa
617 (vertical position absolute).
618 Sometimes these are shorter than the more general two parameter
619 sequence (as with the hp2645) and can be used in preference to
620 .BR cup .
621 If there are parameterized local motions (e.g., move
622 .I n
623 spaces to the right) these can be given as
624 .BR cud ,
625 .BR cub ,
626 .BR cuf ,
627 and
628 .B cuu
629 with a single parameter indicating how many spaces to move.
630 These are primarily useful if the terminal does not have
631 .BR cup ,
632 such as the \s-1TEKTRONIX\s+1 4025.
633 .PP
634 If the terminal needs to be in a special mode when running
635 a program that uses these capabilities,
636 the codes to enter and exit this mode can be given as \fBsmcup\fR and \fBrmcup\fR.
637 This arises, for example, from terminals like the Concept with more than
638 one page of memory.
639 If the terminal has only memory relative cursor addressing and not screen
640 relative cursor addressing, a one screen-sized window must be fixed into
641 the terminal for cursor addressing to work properly.
642 This is also used for the \s-1TEKTRONIX\s+1 4025,
643 where
644 .B smcup
645 sets the command character to be the one used by terminfo.
646 If the \fBsmcup\fP sequence will not restore the screen after an
647 \fBrmcup\fP sequence is output (to the state prior to outputting
648 \fBrmcup\fP), specify \fBnrrmc\fP.
649 .PP
650 .SS Margins
651 SVr4 (and X/Open Curses)
652 list several string capabilities for setting margins.
653 Two were intended for use with terminals,
654 and another six were intended for use with printers.
655 .bP
656 The two terminal capabilities assume that the terminal may have
657 the capability of setting the left and/or right margin at the current
658 cursor column position.
659 .bP
660 The printer capabilities assume that the printer may have
661 two types of capability:
662 .RS
663 .bP
664 the ability to set a top and/or bottom margin using the current
665 line position, and
666 .bP
667 parameterized capabilities for setting the top, bottom, left, right margins
668 given the number of rows or columns.
669 .RE
670 .RE
671 .PP
672 In practice, the categorization into \*(``terminal\*('' and \*(``printer\*(''
673 is not suitable:
674 .bP
675 The AT&T SVr4 terminal database uses \fBsmgl\fP four times,
676 for AT&T hardware.
677 .IP
678 Three of the four are printers.
679 They lack the ability to set left/right margins by specifying the column.
680 .bP
681 Other (non-AT&T) terminals may support margins
682 but using different assumptions from AT&T.
683 .IP
684 For instance, the DEC VT420 supports left/right margins,
685 but only using a column parameter.
686 As an added complication, the VT420 uses two settings to fully enable
687 left/right margins (left/right margin mode, and origin mode).
688 The former enables the margins, which causes printed text
689 to wrap within margins, but the latter is needed to prevent
690 cursor-addressing outside those margins.
691 .bP
692 Both DEC VT420 left/right margins are set with a single control sequence.
693 If either is omitted, the corresponding margin is set to the left or
694 right edge of the display (rather than leaving the margin unmodified).
695 .PP
696 These are the margin-related capabilities:
697 .TS
698 center;
699 l l
700 _ _
701 lw8 lw18.
702 \fBName Description\fP
703 smgl    Set left margin at current column
704 smgr    Set right margin at current column
705 smgb    Set bottom margin at current line
706 smgt    Set top margin at current line
707 smgbp   Set bottom margin at line \fIN\fP
708 smglp   Set left margin at column \fIN\fP
709 smgrp   Set right margin at column \fIN\fP
710 smgtp   Set top margin at line \fIN\fP
711 smglr   Set both left and right margins to \fIL\fP and \fIR\fP
712 smgtb   Set both top and bottom margins to \fIT\fP and \fIB\fP
713 .TE
714 .PP
715 When writing an application that
716 uses these string capabilities,
717 the pairs should be first checked to see
718 if each capability in the pair is set or only one is set:
719 .bP
720 If both \fBsmglp\fP and \fBsmgrp\fP are set,
721 each is used with a single argument, \fIN\fP,
722 that gives the column number of the left and right margin, respectively.
723 .bP
724 If both \fBsmgtp\fP and \fBsmgbp\fP are set,
725 each is used to set the top and bottom margin,
726 respectively:
727 .RS 4
728 .bP
729 \fBsmgtp\fP is used with a single argument, \fIN\fP,
730 the line number of the top margin.
731 .bP
732 \fBsmgbp\fP is used with two arguments, \fIN\fP and \fIM\fP,
733 that give the line number of the bottom margin,
734 the first counting from the top of the
735 page and the second counting from the bottom.
736 This accommodates the two styles of specifying
737 the bottom margin in different manufacturers' printers.
738 .RE
739 .IP
740 When designing a terminfo entry for a
741 printer that has a settable bottom margin,
742 only the first or second argument should be used, depending on the printer.
743 When developing an application that uses \fBsmgbp\fP to set the bottom margin,
744 both arguments must be given.
745 .PP
746 Conversely, when only one capability in the pair is set:
747 .bP 
748 If only one of \fBsmglp\fP and \fBsmgrp\fP is set,
749 then it is used with two arguments,
750 the column number of the left and right margins, in that order.
751 .bP
752 Likewise, if only one of \fBsmgtp\fP and \fBsmgbp\fP is set, then it
753 is used with two arguments that give the top and bottom margins,
754 in that order, counting from the top of the page.
755 .IP
756 When designing a terminfo entry for a printer that requires setting both
757 left and right or top and bottom margins simultaneously,
758 only one capability in the pairs
759 \fBsmglp\fP and \fBsmgrp\fP or
760 \fBsmgtp\fP and \fBsmgbp\fP should be defined,
761 leaving the other unset.
762 .PP
763 Except for very old terminal descriptions, e.g., those developed for SVr4,
764 the scheme just described should be considered obsolete.
765 An improved set of capabilities was added late in the SVr4 releases
766 (\fBsmglr\fP and \fBsmgtb\fP),
767 which explicitly use two parameters for setting the left/right or top/bottom
768 margins.
769 .PP
770 When setting margins, the line- and column-values are zero-based.
771 .PP
772 The \fBmgc\fP string capability should be defined.
773 Applications such as \fBtabs\fP(1) rely upon this to reset all margins.
774 .\"
775 .SS Area Clears
776 .PP
777 If the terminal can clear from the current position to the end of the
778 line, leaving the cursor where it is, this should be given as \fBel\fR.
779 If the terminal can clear from the beginning of the line to the current
780 position inclusive, leaving
781 the cursor where it is, this should be given as \fBel1\fP.
782 If the terminal can clear from the current position to the end of the
783 display, then this should be given as \fBed\fR.
784 \fBEd\fR is only defined from the first column of a line.
785 (Thus, it can be simulated by a request to delete a large number of lines,
786 if a true
787 .B ed
788 is not available.)
789 .PP
790 .\"
791 .SS Insert/delete line and vertical motions
792 .PP
793 If the terminal can open a new blank line before the line where the cursor
794 is, this should be given as \fBil1\fR; this is done only from the first
795 position of a line.
796 The cursor must then appear on the newly blank line.
797 If the terminal can delete the line which the cursor is on, then this
798 should be given as \fBdl1\fR; this is done only from the first position on
799 the line to be deleted.
800 Versions of
801 .B il1
802 and
803 .B dl1
804 which take a single parameter and insert or delete that many lines can
805 be given as
806 .B il
807 and
808 .BR dl .
809 .PP
810 If the terminal has a settable scrolling region (like the vt100)
811 the command to set this can be described with the
812 .B csr
813 capability, which takes two parameters:
814 the top and bottom lines of the scrolling region.
815 The cursor position is, alas, undefined after using this command.
816 .PP
817 It is possible to get the effect of insert or delete line using
818 .B csr
819 on a properly chosen region; the
820 .B sc
821 and
822 .B rc
823 (save and restore cursor) commands may be useful for ensuring that
824 your synthesized insert/delete string does not move the cursor.
825 (Note that the \fBncurses\fR(3X) library does this synthesis
826 automatically, so you need not compose insert/delete strings for
827 an entry with \fBcsr\fR).
828 .PP
829 Yet another way to construct insert and delete might be to use a combination of
830 index with the memory-lock feature found on some terminals (like the HP\-700/90
831 series, which however also has insert/delete).
832 .PP
833 Inserting lines at the top or bottom of the screen can also be
834 done using
835 .B ri
836 or
837 .B ind
838 on many terminals without a true insert/delete line,
839 and is often faster even on terminals with those features.
840 .PP
841 The boolean \fBnon_dest_scroll_region\fR should be set if each scrolling
842 window is effectively a view port on a screen-sized canvas.
843 To test for
844 this capability, create a scrolling region in the middle of the screen,
845 write something to the bottom line, move the cursor to the top of the region,
846 and do \fBri\fR followed by \fBdl1\fR or \fBind\fR.
847 If the data scrolled
848 off the bottom of the region by the \fBri\fR re-appears, then scrolling
849 is non-destructive.
850 System V and XSI Curses expect that \fBind\fR, \fBri\fR,
851 \fBindn\fR, and \fBrin\fR will simulate destructive scrolling; their
852 documentation cautions you not to define \fBcsr\fR unless this is true.
853 This \fBcurses\fR implementation is more liberal and will do explicit erases
854 after scrolling if \fBndsrc\fR is defined.
855 .PP
856 If the terminal has the ability to define a window as part of
857 memory, which all commands affect,
858 it should be given as the parameterized string
859 .BR wind .
860 The four parameters are the starting and ending lines in memory
861 and the starting and ending columns in memory, in that order.
862 .PP
863 If the terminal can retain display memory above, then the
864 \fBda\fR capability should be given; if display memory can be retained
865 below, then \fBdb\fR should be given.
866 These indicate
867 that deleting a line or scrolling may bring non-blank lines up from below
868 or that scrolling back with \fBri\fR may bring down non-blank lines.
869 .PP
870 .SS Insert/Delete Character
871 .PP
872 There are two basic kinds of intelligent terminals with respect to
873 insert/delete character which can be described using
874 .I terminfo.
875 The most common insert/delete character operations affect only the characters
876 on the current line and shift characters off the end of the line rigidly.
877 Other terminals, such as the Concept 100 and the Perkin Elmer Owl, make
878 a distinction between typed and untyped blanks on the screen, shifting
879 upon an insert or delete only to an untyped blank on the screen which is
880 either eliminated, or expanded to two untyped blanks.
881 .PP
882 You can determine the
883 kind of terminal you have by clearing the screen and then typing
884 text separated by cursor motions.
885 Type \*(``abc\ \ \ \ def\*('' using local
886 cursor motions (not spaces) between the \*(``abc\*('' and the \*(``def\*(''.
887 Then position the cursor before the \*(``abc\*('' and put the terminal in insert
888 mode.
889 If typing characters causes the rest of the line to shift
890 rigidly and characters to fall off the end, then your terminal does
891 not distinguish between blanks and untyped positions.
892 If the \*(``abc\*(''
893 shifts over to the \*(``def\*('' which then move together around the end of the
894 current line and onto the next as you insert, you have the second type of
895 terminal, and should give the capability \fBin\fR, which stands for
896 \*(``insert null\*(''.
897 .PP
898 While these are two logically separate attributes (one line versus multi-line
899 insert mode, and special treatment of untyped spaces) we have seen no
900 terminals whose insert mode cannot be described with the single attribute.
901 .PP
902 Terminfo can describe both terminals which have an insert mode, and terminals
903 which send a simple sequence to open a blank position on the current line.
904 Give as \fBsmir\fR the sequence to get into insert mode.
905 Give as \fBrmir\fR the sequence to leave insert mode.
906 Now give as \fBich1\fR any sequence needed to be sent just before sending
907 the character to be inserted.
908 Most terminals with a true insert mode
909 will not give \fBich1\fR; terminals which send a sequence to open a screen
910 position should give it here.
911 .PP
912 If your terminal has both, insert mode is usually preferable to \fBich1\fR.
913 Technically, you should not give both unless the terminal actually requires
914 both to be used in combination.
915 Accordingly, some non-curses applications get
916 confused if both are present; the symptom is doubled characters in an update
917 using insert.
918 This requirement is now rare; most \fBich\fR sequences do not
919 require previous smir, and most smir insert modes do not require \fBich1\fR
920 before each character.
921 Therefore, the new \fBcurses\fR actually assumes this
922 is the case and uses either \fBrmir\fR/\fBsmir\fR or \fBich\fR/\fBich1\fR as
923 appropriate (but not both).
924 If you have to write an entry to be used under
925 new curses for a terminal old enough to need both, include the
926 \fBrmir\fR/\fBsmir\fR sequences in \fBich1\fR.
927 .PP
928 If post insert padding is needed, give this as a number of milliseconds
929 in \fBip\fR (a string option).
930 Any other sequence which may need to be
931 sent after an insert of a single character may also be given in \fBip\fR.
932 If your terminal needs both to be placed into an \*(``insert mode\*('' and
933 a special code to precede each inserted character, then both
934 .BR smir / rmir
935 and
936 .B ich1
937 can be given, and both will be used.
938 The
939 .B ich
940 capability, with one parameter,
941 .IR n ,
942 will repeat the effects of
943 .B ich1
944 .I n
945 times.
946 .PP
947 If padding is necessary between characters typed while not
948 in insert mode, give this as a number of milliseconds padding in \fBrmp\fP.
949 .PP
950 It is occasionally necessary to move around while in insert mode
951 to delete characters on the same line (e.g., if there is a tab after
952 the insertion position).
953 If your terminal allows motion while in
954 insert mode you can give the capability \fBmir\fR to speed up inserting
955 in this case.
956 Omitting \fBmir\fR will affect only speed.
957 Some terminals
958 (notably Datamedia's) must not have \fBmir\fR because of the way their
959 insert mode works.
960 .PP
961 Finally, you can specify
962 .B dch1
963 to delete a single character,
964 .B dch
965 with one parameter,
966 .IR n ,
967 to delete
968 .I n characters,
969 and delete mode by giving \fBsmdc\fR and \fBrmdc\fR
970 to enter and exit delete mode (any mode the terminal needs to be placed
971 in for
972 .B dch1
973 to work).
974 .PP
975 A command to erase
976 .I n
977 characters (equivalent to outputting
978 .I n
979 blanks without moving the cursor)
980 can be given as
981 .B ech
982 with one parameter.
983 .PP
984 .SS "Highlighting, Underlining, and Visible Bells"
985 .PP
986 If your terminal has one or more kinds of display attributes,
987 these can be represented in a number of different ways.
988 You should choose one display form as
989 \f2standout mode\fR,
990 representing a good, high contrast, easy-on-the-eyes,
991 format for highlighting error messages and other attention getters.
992 (If you have a choice, reverse video plus half-bright is good,
993 or reverse video alone.)
994 The sequences to enter and exit standout mode
995 are given as \fBsmso\fR and \fBrmso\fR, respectively.
996 If the code to change into or out of standout
997 mode leaves one or even two blank spaces on the screen,
998 as the TVI 912 and Teleray 1061 do,
999 then \fBxmc\fR should be given to tell how many spaces are left.
1000 .PP
1001 Codes to begin underlining and end underlining can be given as \fBsmul\fR
1002 and \fBrmul\fR respectively.
1003 If the terminal has a code to underline the current character and move
1004 the cursor one space to the right,
1005 such as the Microterm Mime,
1006 this can be given as \fBuc\fR.
1007 .PP
1008 Other capabilities to enter various highlighting modes include
1009 .B blink
1010 (blinking)
1011 .B bold
1012 (bold or extra bright)
1013 .B dim
1014 (dim or half-bright)
1015 .B invis
1016 (blanking or invisible text)
1017 .B prot
1018 (protected)
1019 .B rev
1020 (reverse video)
1021 .B sgr0
1022 (turn off
1023 .I all
1024 attribute modes)
1025 .B smacs
1026 (enter alternate character set mode)
1027 and
1028 .B rmacs
1029 (exit alternate character set mode).
1030 Turning on any of these modes singly may or may not turn off other modes.
1031 .PP
1032 If there is a sequence to set arbitrary combinations of modes,
1033 this should be given as
1034 .B sgr
1035 (set attributes),
1036 taking 9 parameters.
1037 Each parameter is either 0 or nonzero, as the corresponding attribute is on or off.
1038 The 9 parameters are, in order:
1039 standout, underline, reverse, blink, dim, bold, blank, protect, alternate
1040 character set.
1041 Not all modes need be supported by
1042 .BR sgr ,
1043 only those for which corresponding separate attribute commands exist.
1044 .PP
1045 For example, the DEC vt220 supports most of the modes:
1046 .PP
1047 .TS
1048 center;
1049 l l l
1050 l l l
1051 lw18 lw14 lw18.
1052 \fBtparm parameter      attribute       escape sequence\fP
1053
1054 none    none    \\E[0m
1055 p1      standout        \\E[0;1;7m
1056 p2      underline       \\E[0;4m
1057 p3      reverse \\E[0;7m
1058 p4      blink   \\E[0;5m
1059 p5      dim     not available
1060 p6      bold    \\E[0;1m
1061 p7      invis   \\E[0;8m
1062 p8      protect not used
1063 p9      altcharset      ^O (off) ^N (on)
1064 .TE
1065 .PP
1066 We begin each escape sequence by turning off any existing modes, since
1067 there is no quick way to determine whether they are active.
1068 Standout is set up to be the combination of reverse and bold.
1069 The vt220 terminal has a protect mode,
1070 though it is not commonly used in sgr
1071 because it protects characters on the screen from the host's erasures.
1072 The altcharset mode also is different in that it is either ^O or ^N,
1073 depending on whether it is off or on.
1074 If all modes are turned on, the resulting sequence is \\E[0;1;4;5;7;8m^N.
1075 .PP
1076 Some sequences are common to different modes.
1077 For example, ;7 is output when either p1 or p3 is true, that is, if
1078 either standout or reverse modes are turned on.
1079 .PP
1080 Writing out the above sequences, along with their dependencies yields
1081 .PP
1082 .ne 11
1083 .TS
1084 center;
1085 l l l
1086 l l l
1087 lw18 lw14 lw18.
1088 \fBsequence     when to output  terminfo translation\fP
1089
1090 .ft CW
1091 \\E[0   always  \\E[0
1092 ;1      if p1 or p6     %?%p1%p6%|%t;1%;
1093 ;4      if p2   %?%p2%|%t;4%;
1094 ;5      if p4   %?%p4%|%t;5%;
1095 ;7      if p1 or p3     %?%p1%p3%|%t;7%;
1096 ;8      if p7   %?%p7%|%t;8%;
1097 m       always  m
1098 ^N or ^O        if p9 ^N, else ^O       %?%p9%t^N%e^O%;
1099 .ft R
1100 .TE
1101 .PP
1102 Putting this all together into the sgr sequence gives:
1103 .PP
1104 .ft CW
1105 .nf
1106     sgr=\\E[0%?%p1%p6%|%t;1%;%?%p2%t;4%;%?%p4%t;5%;
1107         %?%p1%p3%|%t;7%;%?%p7%t;8%;m%?%p9%t\\016%e\\017%;,
1108 .fi
1109 .ft R
1110 .PP
1111 Remember that if you specify sgr, you must also specify sgr0.
1112 Also, some implementations rely on sgr being given if sgr0 is,
1113 Not all terminfo entries necessarily have an sgr string, however.
1114 Many terminfo entries are derived from termcap entries
1115 which have no sgr string.
1116 The only drawback to adding an sgr string is that termcap also
1117 assumes that sgr0 does not exit alternate character set mode.
1118 .PP
1119 Terminals with the \*(``magic cookie\*('' glitch
1120 .RB ( xmc )
1121 deposit special \*(``cookies\*('' when they receive mode-setting sequences,
1122 which affect the display algorithm rather than having extra bits for
1123 each character.
1124 Some terminals, such as the HP 2621, automatically leave standout
1125 mode when they move to a new line or the cursor is addressed.
1126 Programs using standout mode should exit standout mode before
1127 moving the cursor or sending a newline,
1128 unless the
1129 .B msgr
1130 capability, asserting that it is safe to move in standout mode, is present.
1131 .PP
1132 If the terminal has
1133 a way of flashing the screen to indicate an error quietly (a bell replacement)
1134 then this can be given as \fBflash\fR; it must not move the cursor.
1135 .PP
1136 If the cursor needs to be made more visible than normal when it is
1137 not on the bottom line (to make, for example, a non-blinking underline into an
1138 easier to find block or blinking underline)
1139 give this sequence as
1140 .BR cvvis .
1141 If there is a way to make the cursor completely invisible, give that as
1142 .BR civis .
1143 The capability
1144 .B cnorm
1145 should be given which undoes the effects of both of these modes.
1146 .PP
1147 If your terminal correctly generates underlined characters
1148 (with no special codes needed)
1149 even though it does not overstrike,
1150 then you should give the capability \fBul\fR.
1151 If a character overstriking another leaves both characters on the screen,
1152 specify the capability \fBos\fP.
1153 If overstrikes are erasable with a blank,
1154 then this should be indicated by giving \fBeo\fR.
1155 .PP
1156 .SS Keypad and Function Keys
1157 .PP
1158 If the terminal has a keypad that transmits codes when the keys are pressed,
1159 this information can be given.
1160 Note that it is not possible to handle
1161 terminals where the keypad only works in local (this applies, for example,
1162 to the unshifted HP 2621 keys).
1163 If the keypad can be set to transmit or not transmit,
1164 give these codes as \fBsmkx\fR and \fBrmkx\fR.
1165 Otherwise the keypad is assumed to always transmit.
1166 .PP
1167 The codes sent by the left arrow, right arrow, up arrow, down arrow,
1168 and home keys can be given as
1169 \fBkcub1, kcuf1, kcuu1, kcud1, \fRand\fB khome\fR respectively.
1170 If there are function keys such as f0, f1, ..., f10, the codes they send
1171 can be given as \fBkf0, kf1, ..., kf10\fR.
1172 If these keys have labels other than the default f0 through f10, the labels
1173 can be given as \fBlf0, lf1, ..., lf10\fR.
1174 .PP
1175 The codes transmitted by certain other special keys can be given:
1176 .bP
1177 .B kll
1178 (home down),
1179 .bP
1180 .B kbs
1181 (backspace),
1182 .bP
1183 .B ktbc
1184 (clear all tabs),
1185 .bP
1186 .B kctab
1187 (clear the tab stop in this column),
1188 .bP
1189 .B kclr
1190 (clear screen or erase key),
1191 .bP
1192 .B kdch1
1193 (delete character),
1194 .bP
1195 .B kdl1
1196 (delete line),
1197 .bP
1198 .B krmir
1199 (exit insert mode),
1200 .bP
1201 .B kel
1202 (clear to end of line),
1203 .bP
1204 .B ked
1205 (clear to end of screen),
1206 .bP
1207 .B kich1
1208 (insert character or enter insert mode),
1209 .bP
1210 .B kil1
1211 (insert line),
1212 .bP
1213 .B knp
1214 (next page),
1215 .bP
1216 .B kpp
1217 (previous page),
1218 .bP
1219 .B kind
1220 (scroll forward/down),
1221 .bP
1222 .B kri
1223 (scroll backward/up),
1224 .bP
1225 .B khts
1226 (set a tab stop in this column).
1227 .PP
1228 In addition, if the keypad has a 3 by 3 array of keys including the four
1229 arrow keys, the other five keys can be given as
1230 .BR ka1 ,
1231 .BR ka3 ,
1232 .BR kb2 ,
1233 .BR kc1 ,
1234 and
1235 .BR kc3 .
1236 These keys are useful when the effects of a 3 by 3 directional pad are needed.
1237 .PP
1238 Strings to program function keys can be given as
1239 .BR pfkey ,
1240 .BR pfloc ,
1241 and
1242 .BR pfx .
1243 A string to program screen labels should be specified as \fBpln\fP.
1244 Each of these strings takes two parameters: the function key number to
1245 program (from 0 to 10) and the string to program it with.
1246 Function key numbers out of this range may program undefined keys in
1247 a terminal dependent manner.
1248 The difference between the capabilities is that
1249 .B pfkey
1250 causes pressing the given key to be the same as the user typing the
1251 given string;
1252 .B pfloc
1253 causes the string to be executed by the terminal in local; and
1254 .B pfx
1255 causes the string to be transmitted to the computer.
1256 .PP
1257 The capabilities \fBnlab\fP, \fBlw\fP and \fBlh\fP
1258 define the number of programmable
1259 screen labels and their width and height.
1260 If there are commands to turn the labels on and off,
1261 give them in \fBsmln\fP and \fBrmln\fP.
1262 \fBsmln\fP is normally output after one or more pln
1263 sequences to make sure that the change becomes visible.
1264 .PP
1265 .SS Tabs and Initialization
1266 .PP
1267 A few capabilities are used only for tabs:
1268 .bP
1269 If the terminal has hardware tabs, the command to advance to the next
1270 tab stop can be given as
1271 .B ht
1272 (usually control/I).
1273 .bP
1274 A \*(``back-tab\*('' command which moves leftward to the preceding tab stop can
1275 be given as
1276 .BR cbt .
1277 .IP
1278 By convention, if the teletype modes indicate that tabs are being
1279 expanded by the computer rather than being sent to the terminal,
1280 programs should not use
1281 .B ht
1282 or
1283 .B cbt
1284 even if they are present, since the user may not have the tab stops
1285 properly set.
1286 .bP
1287 If the terminal has hardware tabs which are initially set every
1288 .I n
1289 spaces when the terminal is powered up,
1290 the numeric parameter
1291 .B it
1292 is given, showing the number of spaces the tabs are set to.
1293 .IP
1294 The \fBit\fP capability is normally used by the \fB@TSET@\fP
1295 command to determine whether to set the mode for hardware tab expansion,
1296 and whether to set the tab stops.
1297 If the terminal has tab stops that can be saved in non-volatile memory,
1298 the terminfo description can assume that they are properly set.
1299 .PP
1300 Other capabilities
1301 include
1302 .bP
1303 .BR is1 ,
1304 .BR is2 ,
1305 and
1306 .BR is3 ,
1307 initialization strings for the terminal,
1308 .bP
1309 .BR iprog ,
1310 the path name of a program to be run to initialize the terminal,
1311 .bP
1312 and \fBif\fR, the name of a file containing long initialization strings.
1313 .PP
1314 These strings are expected to set the terminal into modes consistent
1315 with the rest of the terminfo description.
1316 They are normally sent to the terminal, by the
1317 .I init
1318 option of the \fB@TPUT@\fP program, each time the user logs in.
1319 They will be printed in the following order:
1320 .RS
1321 .TP
1322 run the program
1323 .B iprog
1324 .TP
1325 output
1326 .br
1327 \fBis1\fP and
1328 .br
1329 \fBis2\fP
1330 .TP
1331 set the margins using
1332 \fBmgc\fP or
1333 .br
1334 \fBsmglp\fP and \fBsmgrp\fP or
1335 .br
1336 \fBsmgl\fP and \fBsmgr\fP
1337 .TP
1338 set tabs using
1339 .B tbc
1340 and
1341 .B hts
1342 .TP
1343 print the file
1344 \fBif\fP
1345 .TP
1346 and finally output
1347 \fBis3\fP.
1348 .RE
1349 .PP
1350 Most initialization is done with
1351 .BR is2 .
1352 Special terminal modes can be set up without duplicating strings
1353 by putting the common sequences in
1354 .B is2
1355 and special cases in
1356 .B is1
1357 and
1358 .BR is3 .
1359 .PP
1360 A set of sequences that does a harder reset from a totally unknown state
1361 can be given as
1362 .BR rs1 ,
1363 .BR rs2 ,
1364 .B rf
1365 and
1366 .BR rs3 ,
1367 analogous to
1368 .B is1 ,
1369 .B is2 ,
1370 .B if
1371 and
1372 .B is3
1373 respectively.
1374 These strings are output
1375 by \fIreset\fP option of \fB@TPUT@\fP,
1376 or by the \fB@RESET@\fP program
1377 (an alias of \fB@TSET@\fP),
1378 which is used when the terminal gets into a wedged state.
1379 Commands are normally placed in
1380 .BR rs1 ,
1381 .B rs2
1382 .B rs3
1383 and
1384 .B rf
1385 only if they produce annoying effects on the screen and are not
1386 necessary when logging in.
1387 For example, the command to set the vt100 into 80-column mode would
1388 normally be part of
1389 .BR is2 ,
1390 but it causes an annoying glitch of the screen and is not normally
1391 needed since the terminal is usually already in 80-column mode.
1392 .PP
1393 The \fB@RESET@\fP program writes strings including
1394 .BR iprog ,
1395 etc., in the same order as the
1396 .I init
1397 program, using
1398 .BR rs1 ,
1399 etc., instead of
1400 .BR is1 ,
1401 etc.
1402 If any of
1403 .BR rs1 ,
1404 .BR rs2 ,
1405 .BR rs3 ,
1406 or
1407 .B rf
1408 reset capability strings are missing,
1409 the \fB@RESET@\fP program
1410 falls back upon the corresponding initialization capability string.
1411 .PP
1412 If there are commands to set and clear tab stops, they can be given as
1413 .B tbc
1414 (clear all tab stops)
1415 and
1416 .B hts
1417 (set a tab stop in the current column of every row).
1418 If a more complex sequence is needed to set the tabs than can be
1419 described by this, the sequence can be placed in
1420 .B is2
1421 or
1422 .BR if .
1423 .PP
1424 The \fB@TPUT@ reset\fP command uses the same capability strings
1425 as the \fB@RESET@\fP command,
1426 although the two programs (\fB@TPUT@\fP and \fB@RESET@\fP)
1427 provide different command-line options.
1428 .PP
1429 In practice, these terminfo capabilities are not often used in
1430 initialization of tabs
1431 (though they are required for the \fB@TABS@\fP program):
1432 .bP
1433 Almost all hardware terminals (at least those which supported tabs)
1434 initialized those to every \fIeight\fP columns:
1435 .IP
1436 The only exception was the AT&T 2300 series,
1437 which set tabs to every \fIfive\fP columns.
1438 .bP
1439 In particular, developers of the hardware terminals which are commonly used
1440 as models for modern terminal emulators provided documentation demonstrating
1441 that \fIeight\fP columns were the standard.
1442 .bP
1443 Because of this, the terminal initialization programs
1444 \fB@TPUT@\fP and \fB@TSET@\fP
1445 use the
1446 \fBtbc\fP (\fBclear_all_tabs\fP) and
1447 \fBhts\fP (\fBset_tab\fP) capabilities directly
1448 only when the \fBit\fP (\fBinit_tabs\fP) capability
1449 is set to a value other than \fIeight\fP.
1450 .SS Delays and Padding
1451 .PP
1452 Many older and slower terminals do not support either XON/XOFF or DTR
1453 handshaking, including hard copy terminals and some very archaic CRTs
1454 (including, for example, DEC VT100s).
1455 These may require padding characters
1456 after certain cursor motions and screen changes.
1457 .PP
1458 If the terminal uses xon/xoff handshaking for flow control (that is,
1459 it automatically emits ^S back to the host when its input buffers are
1460 close to full), set
1461 .BR xon .
1462 This capability suppresses the emission of padding.
1463 You can also set it
1464 for memory-mapped console devices effectively that do not have a speed limit.
1465 Padding information should still be included so that routines can
1466 make better decisions about relative costs, but actual pad characters will
1467 not be transmitted.
1468 .PP
1469 If \fBpb\fR (padding baud rate) is given, padding is suppressed at baud rates
1470 below the value of \fBpb\fR.
1471 If the entry has no padding baud rate, then
1472 whether padding is emitted or not is completely controlled by \fBxon\fR.
1473 .PP
1474 If the terminal requires other than a null (zero) character as a pad,
1475 then this can be given as \fBpad\fR.
1476 Only the first character of the
1477 .B pad
1478 string is used.
1479 .PP
1480 .SS Status Lines
1481 Some terminals have an extra \*(``status line\*('' which is not normally used by
1482 software (and thus not counted in the terminal's \fBlines\fR capability).
1483 .PP
1484 The simplest case is a status line which is cursor-addressable but not
1485 part of the main scrolling region on the screen; the Heathkit H19 has
1486 a status line of this kind, as would a 24-line VT100 with a 23-line
1487 scrolling region set up on initialization.
1488 This situation is indicated
1489 by the \fBhs\fR capability.
1490 .PP
1491 Some terminals with status lines need special sequences to access the
1492 status line.
1493 These may be expressed as a string with single parameter
1494 \fBtsl\fR which takes the cursor to a given zero-origin column on the
1495 status line.
1496 The capability \fBfsl\fR must return to the main-screen
1497 cursor positions before the last \fBtsl\fR.
1498 You may need to embed the
1499 string values of \fBsc\fR (save cursor) and \fBrc\fR (restore cursor)
1500 in \fBtsl\fR and \fBfsl\fR to accomplish this.
1501 .PP
1502 The status line is normally assumed to be the same width as the width
1503 of the terminal.
1504 If this is untrue, you can specify it with the numeric
1505 capability \fBwsl\fR.
1506 .PP
1507 A command to erase or blank the status line may be specified as \fBdsl\fR.
1508 .PP
1509 The boolean capability \fBeslok\fR specifies that escape sequences, tabs,
1510 etc., work ordinarily in the status line.
1511 .PP
1512 The \fBncurses\fR implementation does not yet use any of these capabilities.
1513 They are documented here in case they ever become important.
1514 .PP
1515 .SS Line Graphics
1516 .PP
1517 Many terminals have alternate character sets useful for forms-drawing.
1518 Terminfo and \fBcurses\fR have built-in support
1519 for most of the drawing characters
1520 supported by the VT100, with some characters from the AT&T 4410v1 added.
1521 This alternate character set may be specified by the \fBacsc\fR capability.
1522 .PP
1523 .TS H
1524 center expand;
1525 l l l l l
1526 l l l l l
1527 _ _ _ _ _
1528 lw25 lw10 lw6 lw6 lw6.
1529 .\".TH
1530 \fBGlyph        ACS     Ascii   acsc    acsc\fR
1531 \fBName Name    Default Char    Value\fR
1532 arrow pointing right    ACS_RARROW      >       +       0x2b
1533 arrow pointing left     ACS_LARROW      <       ,       0x2c
1534 arrow pointing up       ACS_UARROW      ^       \-      0x2d
1535 arrow pointing down     ACS_DARROW      v       .       0x2e
1536 solid square block      ACS_BLOCK       #       0       0x30
1537 diamond                 ACS_DIAMOND     +       `       0x60
1538 checker board (stipple) ACS_CKBOARD     :       a       0x61
1539 degree symbol           ACS_DEGREE      \e      f       0x66
1540 plus/minus              ACS_PLMINUS     #       g       0x67
1541 board of squares        ACS_BOARD       #       h       0x68
1542 lantern symbol          ACS_LANTERN     #       i       0x69
1543 lower right corner      ACS_LRCORNER    +       j       0x6a
1544 upper right corner      ACS_URCORNER    +       k       0x6b
1545 upper left corner       ACS_ULCORNER    +       l       0x6c
1546 lower left corner       ACS_LLCORNER    +       m       0x6d
1547 large plus or crossover ACS_PLUS        +       n       0x6e
1548 scan line 1             ACS_S1          ~       o       0x6f
1549 scan line 3             ACS_S3          \-      p       0x70
1550 horizontal line         ACS_HLINE       \-      q       0x71
1551 scan line 7             ACS_S7          \-      r       0x72
1552 scan line 9             ACS_S9          \&_     s       0x73
1553 tee pointing right      ACS_LTEE        +       t       0x74
1554 tee pointing left       ACS_RTEE        +       u       0x75
1555 tee pointing up         ACS_BTEE        +       v       0x76
1556 tee pointing down       ACS_TTEE        +       w       0x77
1557 vertical line           ACS_VLINE       |       x       0x78
1558 less-than-or-equal-to   ACS_LEQUAL      <       y       0x79
1559 greater-than-or-equal-to        ACS_GEQUAL      >       z       0x7a
1560 greek pi                ACS_PI  *       {       0x7b
1561 not-equal               ACS_NEQUAL      !       |       0x7c
1562 UK pound sign           ACS_STERLING    f       }       0x7d
1563 bullet                  ACS_BULLET      o       ~       0x7e
1564 .TE
1565 .PP
1566 A few notes apply to the table itself:
1567 .bP
1568 X/Open Curses incorrectly states that the mapping for \fIlantern\fP is
1569 uppercase \*(``I\*('' although Unix implementations use the
1570 lowercase \*(``i\*('' mapping.
1571 .bP
1572 The DEC VT100 implemented graphics using the alternate character set
1573 feature, temporarily switching \fImodes\fP and sending characters
1574 in the range 0x60 (96) to 0x7e (126)
1575 (the \fBacsc Value\fP column in the table).
1576 .bP
1577 The AT&T terminal added graphics characters outside that range.
1578 .IP
1579 Some of the characters within the range do not match the VT100;
1580 presumably they were used in the AT&T terminal:
1581 \fIboard of squares\fP replaces the VT100 \fInewline\fP symbol, while
1582 \fIlantern symbol\fP replaces the VT100 \fIvertical tab\fP symbol.
1583 The other VT100 symbols for control characters (\fIhorizontal tab\fP,
1584 \fIcarriage return\fP and \fIline-feed\fP) are not (re)used in curses.
1585 .PP
1586 The best way to define a new device's graphics set is to add a column
1587 to a copy of this table for your terminal, giving the character which
1588 (when emitted between \fBsmacs\fR/\fBrmacs\fR switches) will be rendered
1589 as the corresponding graphic.
1590 Then read off the VT100/your terminal
1591 character pairs right to left in sequence; these become the ACSC string.
1592 .PP
1593 .SS Color Handling
1594 .PP
1595 The curses library functions \fBinit_pair\fP and \fBinit_color\fP
1596 manipulate the \fIcolor pairs\fP and \fIcolor values\fP discussed in this
1597 section
1598 (see \fBcurs_color\fP(3X) for details on these and related functions).
1599 .PP
1600 Most color terminals are either \*(``Tektronix-like\*('' or \*(``HP-like\*('':
1601 .bP
1602 Tektronix-like
1603 terminals have a predefined set of \fIN\fP colors
1604 (where \fIN\fP is usually 8),
1605 and can set
1606 character-cell foreground and background characters independently, mixing them
1607 into \fIN\fP\ *\ \fIN\fP color-pairs.
1608 .bP
1609 On HP-like terminals, the user must set each color
1610 pair up separately (foreground and background are not independently settable).
1611 Up to \fIM\fP color-pairs may be set up from 2*\fIM\fP different colors.
1612 ANSI-compatible terminals are Tektronix-like.
1613 .PP
1614 Some basic color capabilities are independent of the color method.
1615 The numeric
1616 capabilities \fBcolors\fR and \fBpairs\fR specify the maximum numbers of colors
1617 and color-pairs that can be displayed simultaneously.
1618 The \fBop\fR (original
1619 pair) string resets foreground and background colors to their default values
1620 for the terminal.
1621 The \fBoc\fR string resets all colors or color-pairs to
1622 their default values for the terminal.
1623 Some terminals (including many PC
1624 terminal emulators) erase screen areas with the current background color rather
1625 than the power-up default background; these should have the boolean capability
1626 \fBbce\fR.
1627 .PP
1628 While the curses library works with \fIcolor pairs\fP
1629 (reflecting the inability of some devices to set foreground
1630 and background colors independently),
1631 there are separate capabilities for setting these features:
1632 .bP
1633 To change the current foreground or background color on a Tektronix-type
1634 terminal, use \fBsetaf\fR (set ANSI foreground) and \fBsetab\fR (set ANSI
1635 background) or \fBsetf\fR (set foreground) and \fBsetb\fR (set background).
1636 These take one parameter, the color number.
1637 The SVr4 documentation describes
1638 only \fBsetaf\fR/\fBsetab\fR; the XPG4 draft says that "If the terminal
1639 supports ANSI escape sequences to set background and foreground, they should
1640 be coded as \fBsetaf\fR and \fBsetab\fR, respectively.
1641 .bP
1642 If the terminal
1643 supports other escape sequences to set background and foreground, they should
1644 be coded as \fBsetf\fR and \fBsetb\fR, respectively.
1645 The \fBvidputs\fR and the \fBrefresh\fP(3X) functions
1646 use the \fBsetaf\fR and \fBsetab\fR capabilities if they are defined.
1647 .PP
1648 The \fBsetaf\fR/\fBsetab\fR and \fBsetf\fR/\fBsetb\fR capabilities take a
1649 single numeric argument each.
1650 Argument values 0-7 of \fBsetaf\fR/\fBsetab\fR are portably defined as
1651 follows (the middle column is the symbolic #define available in the header for
1652 the \fBcurses\fR or \fBncurses\fR libraries).
1653 The terminal hardware is free to
1654 map these as it likes, but the RGB values indicate normal locations in color
1655 space.
1656 .PP
1657 .TS H
1658 center;
1659 l c c c
1660 l l n l.
1661 \fBColor        #define         Value   RGB\fR
1662 black   \fBCOLOR_BLACK\fR       0       0, 0, 0
1663 red     \fBCOLOR_RED\ \fR       1       max,0,0
1664 green   \fBCOLOR_GREEN\fR       2       0,max,0
1665 yellow  \fBCOLOR_YELLOW\fR      3       max,max,0
1666 blue    \fBCOLOR_BLUE\fR        4       0,0,max
1667 magenta \fBCOLOR_MAGENTA\fR     5       max,0,max
1668 cyan    \fBCOLOR_CYAN\fR        6       0,max,max
1669 white   \fBCOLOR_WHITE\fR       7       max,max,max
1670 .TE
1671 .PP
1672 The argument values of \fBsetf\fR/\fBsetb\fR historically correspond to
1673 a different mapping, i.e.,
1674 .TS H
1675 center;
1676 l c c c
1677 l l n l.
1678 \fBColor        #define         Value   RGB\fR
1679 black   \fBCOLOR_BLACK\fR       0       0, 0, 0
1680 blue    \fBCOLOR_BLUE\fR        1       0,0,max
1681 green   \fBCOLOR_GREEN\fR       2       0,max,0
1682 cyan    \fBCOLOR_CYAN\fR        3       0,max,max
1683 red     \fBCOLOR_RED\ \fR       4       max,0,0
1684 magenta \fBCOLOR_MAGENTA\fR     5       max,0,max
1685 yellow  \fBCOLOR_YELLOW\fR      6       max,max,0
1686 white   \fBCOLOR_WHITE\fR       7       max,max,max
1687 .TE
1688 .PP
1689 It is important to not confuse the two sets of color capabilities;
1690 otherwise red/blue will be interchanged on the display.
1691 .PP
1692 On an HP-like terminal, use \fBscp\fR with a color-pair number parameter to set
1693 which color pair is current.
1694 .PP
1695 Some terminals allow the \fIcolor values\fP to be modified:
1696 .bP
1697 On a Tektronix-like terminal, the capability \fBccc\fR may be present to
1698 indicate that colors can be modified.
1699 If so, the \fBinitc\fR capability will
1700 take a color number (0 to \fBcolors\fR \- 1)and three more parameters which
1701 describe the color.
1702 These three parameters default to being interpreted as RGB
1703 (Red, Green, Blue) values.
1704 If the boolean capability \fBhls\fR is present,
1705 they are instead as HLS (Hue, Lightness, Saturation) indices.
1706 The ranges are
1707 terminal-dependent.
1708 .bP
1709 On an HP-like terminal, \fBinitp\fR may give a capability for changing a
1710 color-pair value.
1711 It will take seven parameters; a color-pair number (0 to
1712 \fBmax_pairs\fR \- 1), and two triples describing first background and then
1713 foreground colors.
1714 These parameters must be (Red, Green, Blue) or
1715 (Hue, Lightness, Saturation) depending on \fBhls\fR.
1716 .PP
1717 On some color terminals, colors collide with highlights.
1718 You can register
1719 these collisions with the \fBncv\fR capability.
1720 This is a bit-mask of
1721 attributes not to be used when colors are enabled.
1722 The correspondence with the
1723 attributes understood by \fBcurses\fR is as follows:
1724 .PP
1725 .TS
1726 center;
1727 l l l l
1728 lw20 lw2 lw10 lw10.
1729 \fBAttribute    Bit     Decimal Set by\fR
1730 A_STANDOUT      0       1       sgr
1731 A_UNDERLINE     1       2       sgr
1732 A_REVERSE       2       4       sgr
1733 A_BLINK         3       8       sgr
1734 A_DIM           4       16      sgr
1735 A_BOLD          5       32      sgr
1736 A_INVIS         6       64      sgr
1737 A_PROTECT       7       128     sgr
1738 A_ALTCHARSET    8       256     sgr
1739 A_HORIZONTAL    9       512     sgr1
1740 A_LEFT  10      1024    sgr1
1741 A_LOW   11      2048    sgr1
1742 A_RIGHT 12      4096    sgr1
1743 A_TOP   13      8192    sgr1
1744 A_VERTICAL      14      16384   sgr1
1745 A_ITALIC        15      32768   sitm
1746 .TE
1747 .PP
1748 For example, on many IBM PC consoles, the underline attribute collides with the
1749 foreground color blue and is not available in color mode.
1750 These should have
1751 an \fBncv\fR capability of 2.
1752 .PP
1753 SVr4 curses does nothing with \fBncv\fR, ncurses recognizes it and optimizes
1754 the output in favor of colors.
1755 .PP
1756 .SS Miscellaneous
1757 If the terminal requires other than a null (zero) character as a pad, then this
1758 can be given as pad.
1759 Only the first character of the pad string is used.
1760 If the terminal does not have a pad character, specify npc.
1761 Note that ncurses implements the termcap-compatible \fBPC\fR variable;
1762 though the application may set this value to something other than
1763 a null, ncurses will test \fBnpc\fR first and use napms if the terminal
1764 has no pad character.
1765 .PP
1766 If the terminal can move up or down half a line,
1767 this can be indicated with
1768 .B hu
1769 (half-line up)
1770 and
1771 .B hd
1772 (half-line down).
1773 This is primarily useful for superscripts and subscripts on hard-copy terminals.
1774 If a hard-copy terminal can eject to the next page (form feed), give this as
1775 .B ff
1776 (usually control/L).
1777 .PP
1778 If there is a command to repeat a given character a given number of
1779 times (to save time transmitting a large number of identical characters)
1780 this can be indicated with the parameterized string
1781 .BR rep .
1782 The first parameter is the character to be repeated and the second
1783 is the number of times to repeat it.
1784 Thus, tparm(repeat_char, \(aqx\(aq, 10) is the same as \*(``xxxxxxxxxx\*(''.
1785 .PP
1786 If the terminal has a settable command character, such as the \s-1TEKTRONIX\s+1 4025,
1787 this can be indicated with
1788 .BR cmdch .
1789 A prototype command character is chosen which is used in all capabilities.
1790 This character is given in the
1791 .B cmdch
1792 capability to identify it.
1793 The following convention is supported on some UNIX systems:
1794 The environment is to be searched for a
1795 .B CC
1796 variable, and if found, all
1797 occurrences of the prototype character are replaced with the character
1798 in the environment variable.
1799 .PP
1800 Terminal descriptions that do not represent a specific kind of known
1801 terminal, such as
1802 .IR switch ,
1803 .IR dialup ,
1804 .IR patch ,
1805 and
1806 .IR network ,
1807 should include the
1808 .B gn
1809 (generic) capability so that programs can complain that they do not know
1810 how to talk to the terminal.
1811 (This capability does not apply to
1812 .I virtual
1813 terminal descriptions for which the escape sequences are known.)
1814 .PP
1815 If the terminal has a \*(``meta key\*('' which acts as a shift key,
1816 setting the 8th bit of any character transmitted, this fact can
1817 be indicated with
1818 .BR km .
1819 Otherwise, software will assume that the 8th bit is parity and it
1820 will usually be cleared.
1821 If strings exist to turn this \*(``meta mode\*('' on and off, they
1822 can be given as
1823 .B smm
1824 and
1825 .BR rmm .
1826 .PP
1827 If the terminal has more lines of memory than will fit on the screen
1828 at once, the number of lines of memory can be indicated with
1829 .BR lm .
1830 A value of
1831 .BR lm #0
1832 indicates that the number of lines is not fixed,
1833 but that there is still more memory than fits on the screen.
1834 .PP
1835 If the terminal is one of those supported by the \s-1UNIX\s+1 virtual
1836 terminal protocol, the terminal number can be given as
1837 .BR vt .
1838 .PP
1839 Media copy
1840 strings which control an auxiliary printer connected to the terminal
1841 can be given as
1842 .BR mc0 :
1843 print the contents of the screen,
1844 .BR mc4 :
1845 turn off the printer, and
1846 .BR mc5 :
1847 turn on the printer.
1848 When the printer is on, all text sent to the terminal will be sent
1849 to the printer.
1850 It is undefined whether the text is also displayed on the terminal screen
1851 when the printer is on.
1852 A variation
1853 .B mc5p
1854 takes one parameter, and leaves the printer on for as many characters
1855 as the value of the parameter, then turns the printer off.
1856 The parameter should not exceed 255.
1857 All text, including
1858 .BR mc4 ,
1859 is transparently passed to the printer while an
1860 .B mc5p
1861 is in effect.
1862 .PP
1863 .SS Glitches and Braindamage
1864 .PP
1865 Hazeltine terminals, which do not allow \*(``~\*('' characters to be displayed should
1866 indicate \fBhz\fR.
1867 .PP
1868 Terminals which ignore a line-feed immediately after an \fBam\fR wrap,
1869 such as the Concept and vt100,
1870 should indicate \fBxenl\fR.
1871 .PP
1872 If
1873 .B el
1874 is required to get rid of standout
1875 (instead of merely writing normal text on top of it),
1876 \fBxhp\fP should be given.
1877 .PP
1878 Teleray terminals, where tabs turn all characters moved over to blanks,
1879 should indicate \fBxt\fR (destructive tabs).
1880 Note: the variable indicating this is now \*(``dest_tabs_magic_smso\*(''; in
1881 older versions, it was teleray_glitch.
1882 This glitch is also taken to mean that it is not possible to position
1883 the cursor on top of a \*(``magic cookie\*('',
1884 that to erase standout mode it is instead necessary to use
1885 delete and insert line.
1886 The ncurses implementation ignores this glitch.
1887 .PP
1888 The Beehive Superbee, which is unable to correctly transmit the escape
1889 or control/C characters, has
1890 .BR xsb ,
1891 indicating that the f1 key is used for escape and f2 for control/C.
1892 (Only certain Superbees have this problem, depending on the ROM.)
1893 Note that in older terminfo versions, this capability was called
1894 \*(``beehive_glitch\*(''; it is now \*(``no_esc_ctl_c\*(''.
1895 .PP
1896 Other specific terminal problems may be corrected by adding more
1897 capabilities of the form \fBx\fR\fIx\fR.
1898 .PP
1899 .SS Pitfalls of Long Entries
1900 .PP
1901 Long terminfo entries are unlikely to be a problem; to date, no entry has even
1902 approached terminfo's 4096-byte string-table maximum.
1903 Unfortunately, the termcap
1904 translations are much more strictly limited (to 1023 bytes), thus termcap translations
1905 of long terminfo entries can cause problems.
1906 .PP
1907 The man pages for 4.3BSD and older versions of \fBtgetent\fP instruct the user to
1908 allocate a 1024-byte buffer for the termcap entry.
1909 The entry gets null-terminated by
1910 the termcap library, so that makes the maximum safe length for a termcap entry
1911 1k\-1 (1023) bytes.
1912 Depending on what the application and the termcap library
1913 being used does, and where in the termcap file the terminal type that \fBtgetent\fP
1914 is searching for is, several bad things can happen.
1915 .PP
1916 Some termcap libraries print a warning message or exit if they find an
1917 entry that's longer than 1023 bytes; others do not; others truncate the
1918 entries to 1023 bytes.
1919 Some application programs allocate more than
1920 the recommended 1K for the termcap entry; others do not.
1921 .PP
1922 Each termcap entry has two important sizes associated with it: before
1923 \*(``tc\*('' expansion, and after \*(``tc\*('' expansion.
1924 \*(``tc\*('' is the capability that
1925 tacks on another termcap entry to the end of the current one, to add
1926 on its capabilities.
1927 If a termcap entry does not use the \*(``tc\*(''
1928 capability, then of course the two lengths are the same.
1929 .PP
1930 The \*(``before tc expansion\*('' length is the most important one, because it
1931 affects more than just users of that particular terminal.
1932 This is the
1933 length of the entry as it exists in /etc/termcap, minus the
1934 backslash-newline pairs, which \fBtgetent\fP strips out while reading it.
1935 Some termcap libraries strip off the final newline, too (GNU termcap does not).
1936 Now suppose:
1937 .bP
1938 a termcap entry before expansion is more than 1023 bytes long,
1939 .bP
1940 and the application has only allocated a 1k buffer,
1941 .bP
1942 and the termcap library (like the one in BSD/OS 1.1 and GNU) reads
1943 the whole entry into the buffer, no matter what its length, to see
1944 if it is the entry it wants,
1945 .bP
1946 and \fBtgetent\fP is searching for a terminal type that either is the
1947 long entry, appears in the termcap file after the long entry, or
1948 does not appear in the file at all (so that \fBtgetent\fP has to search
1949 the whole termcap file).
1950 .PP
1951 Then \fBtgetent\fP will overwrite memory, perhaps its stack, and probably core dump
1952 the program.
1953 Programs like telnet are particularly vulnerable; modern telnets
1954 pass along values like the terminal type automatically.
1955 The results are almost
1956 as undesirable with a termcap library, like SunOS 4.1.3 and Ultrix 4.4, that
1957 prints warning messages when it reads an overly long termcap entry.
1958 If a
1959 termcap library truncates long entries, like OSF/1 3.0, it is immune to dying
1960 here but will return incorrect data for the terminal.
1961 .PP
1962 The \*(``after tc expansion\*('' length will have a similar effect to the
1963 above, but only for people who actually set TERM to that terminal
1964 type, since \fBtgetent\fP only does \*(``tc\*('' expansion once it is found the
1965 terminal type it was looking for, not while searching.
1966 .PP
1967 In summary, a termcap entry that is longer than 1023 bytes can cause,
1968 on various combinations of termcap libraries and applications, a core
1969 dump, warnings, or incorrect operation.
1970 If it is too long even before
1971 \*(``tc\*('' expansion, it will have this effect even for users of some other
1972 terminal types and users whose TERM variable does not have a termcap
1973 entry.
1974 .PP
1975 When in \-C (translate to termcap) mode, the \fBncurses\fR implementation of
1976 \fB@TIC@\fR(1M) issues warning messages when the pre-tc length of a termcap
1977 translation is too long.
1978 The \-c (check) option also checks resolved (after tc
1979 expansion) lengths.
1980 .SS Binary Compatibility
1981 It is not wise to count on portability of binary terminfo entries between
1982 commercial UNIX versions.
1983 The problem is that there are at least two versions
1984 of terminfo (under HP\-UX and AIX) which diverged from System V terminfo after
1985 SVr1, and have added extension capabilities to the string table that (in the
1986 binary format) collide with System V and XSI Curses extensions.
1987 .SH EXTENSIONS
1988 .PP
1989 Searching for terminal descriptions in
1990 \fB$HOME/.terminfo\fR and TERMINFO_DIRS
1991 is not supported by older implementations.
1992 .PP
1993 Some SVr4 \fBcurses\fR implementations, and all previous to SVr4, do not
1994 interpret the %A and %O operators in parameter strings.
1995 .PP
1996 SVr4/XPG4 do not specify whether \fBmsgr\fR licenses movement while in
1997 an alternate-character-set mode (such modes may, among other things, map
1998 CR and NL to characters that do not trigger local motions).
1999 The \fBncurses\fR implementation ignores \fBmsgr\fR in \fBALTCHARSET\fR
2000 mode.
2001 This raises the possibility that an XPG4
2002 implementation making the opposite interpretation may need terminfo
2003 entries made for \fBncurses\fR to have \fBmsgr\fR turned off.
2004 .PP
2005 The \fBncurses\fR library handles insert-character and insert-character modes
2006 in a slightly non-standard way to get better update efficiency.
2007 See
2008 the \fBInsert/Delete Character\fR subsection above.
2009 .PP
2010 The parameter substitutions for \fBset_clock\fR and \fBdisplay_clock\fR are
2011 not documented in SVr4 or the XSI Curses standard.
2012 They are deduced from the
2013 documentation for the AT&T 505 terminal.
2014 .PP
2015 Be careful assigning the \fBkmous\fR capability.
2016 The \fBncurses\fR library wants to interpret it as \fBKEY_MOUSE\fR,
2017 for use by terminals and emulators like xterm
2018 that can return mouse-tracking information in the keyboard-input stream.
2019 .PP
2020 X/Open Curses does not mention italics.
2021 Portable applications must assume that numeric capabilities are
2022 signed 16-bit values.
2023 This includes the \fIno_color_video\fP (ncv) capability.
2024 The 32768 mask value used for italics with ncv can be confused with
2025 an absent or cancelled ncv.
2026 If italics should work with colors,
2027 then the ncv value must be specified, even if it is zero.
2028 .PP
2029 Different commercial ports of terminfo and curses support different subsets of
2030 the XSI Curses standard and (in some cases) different extension sets.
2031 Here
2032 is a summary, accurate as of October 1995:
2033 .bP
2034 \fBSVR4, Solaris, ncurses\fR \-\-
2035 These support all SVr4 capabilities.
2036 .bP
2037 \fBSGI\fR \-\-
2038 Supports the SVr4 set, adds one undocumented extended string
2039 capability (\fBset_pglen\fR).
2040 .bP
2041 \fBSVr1, Ultrix\fR \-\-
2042 These support a restricted subset of terminfo capabilities.
2043 The booleans end with \fBxon_xoff\fR;
2044 the numerics with \fBwidth_status_line\fR;
2045 and the strings with \fBprtr_non\fR.
2046 .bP
2047 \fBHP/UX\fR \-\-
2048 Supports the SVr1 subset, plus the SVr[234] numerics \fBnum_labels\fR,
2049 \fBlabel_height\fR, \fBlabel_width\fR, plus function keys 11 through 63, plus
2050 \fBplab_norm\fR, \fBlabel_on\fR, and \fBlabel_off\fR, plus some incompatible
2051 extensions in the string table.
2052 .bP
2053 \fBAIX\fR \-\-
2054 Supports the SVr1 subset, plus function keys 11 through 63, plus a number
2055 of incompatible string table extensions.
2056 .bP
2057 \fBOSF\fR \-\-
2058 Supports both the SVr4 set and the AIX extensions.
2059 .SH FILES
2060 .TP 25
2061 \*d/?/*
2062 files containing terminal descriptions
2063 .SH SEE ALSO
2064 \fB@INFOCMP@\fR(1M),
2065 \fB@TABS@\fR(1),
2066 \fB@TIC@\fR(1M),
2067 \fBcurses\fR(3X),
2068 \fBcurs_color\fR(3X),
2069 \fBcurs_variables\fR(3X),
2070 \fBprintf\fR(3),
2071 \fBterm_variables\fR(3X).
2072 \fBterm\fR(\*n).
2073 \fBuser_caps\fR(5).
2074 .SH AUTHORS
2075 Zeyd M. Ben-Halim, Eric S. Raymond, Thomas E. Dickey.
2076 Based on pcurses by Pavel Curtis.