ncurses 6.2 - patch 20210619
[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 .\"                                                                          *
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.101 2021/06/17 21:30:22 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 .TP
488 \fB%'\fP\fIc\fP\fB'\fP
489 char constant \fIc\fP
490 .TP
491 \fB%{\fP\fInn\fP\fB}\fP
492 integer constant \fInn\fP
493 .TP
494 \fB%l\fP
495 push strlen(pop)
496 .TP
497 \fB%+\fP, \fB%\-\fP, \fB%*\fP, \fB%/\fP, \fB%m\fP
498 arithmetic (%m is \fImod\fP): \fIpush(pop() op pop())\fP
499 .TP
500 \fB%&\fP, \fB%|\fP, \fB%^\fP
501 bit operations (AND, OR and exclusive-OR): \fIpush(pop() op pop())\fP
502 .TP
503 \fB%=\fP, \fB%>\fP, \fB%<\fP
504 logical operations: \fIpush(pop() op pop())\fP
505 .TP
506 \fB%A\fP, \fB%O\fP
507 logical AND and OR operations (for conditionals)
508 .TP
509 \fB%!\fP, \fB%~\fP
510 unary operations (logical and bit complement): \fIpush(op pop())\fP
511 .TP
512 \fB%i\fP
513 add 1 to first two parameters (for ANSI terminals)
514 .TP
515 \fB%?\fP \fIexpr\fP \fB%t\fP \fIthenpart\fP \fB%e\fP \fIelsepart\fP \fB%;\fP
516 This forms an if-then-else.
517 The \fB%e\fP \fIelsepart\fP is optional.
518 Usually the \fB%?\fP \fIexpr\fP part pushes a value onto the stack,
519 and \fB%t\fP pops it from the stack, testing if it is nonzero (true).
520 If it is zero (false), control passes to the \fB%e\fP (else) part.
521 .IP
522 It is possible to form else-if's a la Algol 68:
523 .RS
524 \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
525 .RE
526 .IP
527 where c\di\u are conditions, b\di\u are bodies.
528 .IP
529 Use the \fB\-f\fP option of \fB@TIC@\fP or \fB@INFOCMP@\fP to see
530 the structure of if-then-else's.
531 Some strings, e.g., \fBsgr\fP can be very complicated when written
532 on one line.
533 The \fB\-f\fP option splits the string into lines with the parts indented.
534 .PP
535 Binary operations are in postfix form with the operands in the usual order.
536 That is, to get x\-5 one would use "%gx%{5}%-".
537 \fB%P\fP and \fB%g\fP variables are
538 persistent across escape-string evaluations.
539 .PP
540 Consider the HP2645, which, to get to row 3 and column 12, needs
541 to be sent \eE&a12c03Y padded for 6 milliseconds.
542 Note that the order
543 of the rows and columns is inverted here, and that the row and column
544 are printed as two digits.
545 Thus its \fBcup\fR capability is \*(``cup=6\eE&%p2%2dc%p1%2dY\*(''.
546 .PP
547 The Microterm \s-1ACT-IV\s0 needs the current row and column sent
548 preceded by a \fB^T\fR, with the row and column simply encoded in binary,
549 \*(``cup=^T%p1%c%p2%c\*(''.
550 Terminals which use \*(``%c\*('' need to be able to
551 backspace the cursor (\fBcub1\fR),
552 and to move the cursor up one line on the screen (\fBcuu1\fR).
553 This is necessary because it is not always safe to transmit \fB\en\fR
554 \fB^D\fR and \fB\er\fR, as the system may change or discard them.
555 (The library routines dealing with terminfo set tty modes so that
556 tabs are never expanded, so \et is safe to send.
557 This turns out to be essential for the Ann Arbor 4080.)
558 .PP
559 A final example is the \s-1LSI ADM\s0-3a, which uses row and column
560 offset by a blank character, thus \*(``cup=\eE=%p1%' '%+%c%p2%' '%+%c\*(''.
561 After sending \*(``\eE=\*('', this pushes the first parameter, pushes the
562 ASCII value for a space (32), adds them (pushing the sum on the stack
563 in place of the two previous values) and outputs that value as a character.
564 Then the same is done for the second parameter.
565 More complex arithmetic is possible using the stack.
566 .PP
567 .SS Cursor Motions
568 .PP
569 If the terminal has a fast way to home the cursor
570 (to very upper left corner of screen) then this can be given as
571 \fBhome\fR; similarly a fast way of getting to the lower left-hand corner
572 can be given as \fBll\fR; this may involve going up with \fBcuu1\fR
573 from the home position,
574 but a program should never do this itself (unless \fBll\fR does) because it
575 can make no assumption about the effect of moving up from the home position.
576 Note that the home position is the same as addressing to (0,0):
577 to the top left corner of the screen, not of memory.
578 (Thus, the \eEH sequence on HP terminals cannot be used for
579 .BR home .)
580 .PP
581 If the terminal has row or column absolute cursor addressing,
582 these can be given as single parameter capabilities
583 .B hpa
584 (horizontal position absolute)
585 and
586 .B vpa
587 (vertical position absolute).
588 Sometimes these are shorter than the more general two parameter
589 sequence (as with the hp2645) and can be used in preference to
590 .BR cup .
591 If there are parameterized local motions (e.g., move
592 .I n
593 spaces to the right) these can be given as
594 .BR cud ,
595 .BR cub ,
596 .BR cuf ,
597 and
598 .B cuu
599 with a single parameter indicating how many spaces to move.
600 These are primarily useful if the terminal does not have
601 .BR cup ,
602 such as the \s-1TEKTRONIX\s+1 4025.
603 .PP
604 If the terminal needs to be in a special mode when running
605 a program that uses these capabilities,
606 the codes to enter and exit this mode can be given as \fBsmcup\fR and \fBrmcup\fR.
607 This arises, for example, from terminals like the Concept with more than
608 one page of memory.
609 If the terminal has only memory relative cursor addressing and not screen
610 relative cursor addressing, a one screen-sized window must be fixed into
611 the terminal for cursor addressing to work properly.
612 This is also used for the \s-1TEKTRONIX\s+1 4025,
613 where
614 .B smcup
615 sets the command character to be the one used by terminfo.
616 If the \fBsmcup\fP sequence will not restore the screen after an
617 \fBrmcup\fP sequence is output (to the state prior to outputting
618 \fBrmcup\fP), specify \fBnrrmc\fP.
619 .PP
620 .SS Area Clears
621 .PP
622 If the terminal can clear from the current position to the end of the
623 line, leaving the cursor where it is, this should be given as \fBel\fR.
624 If the terminal can clear from the beginning of the line to the current
625 position inclusive, leaving
626 the cursor where it is, this should be given as \fBel1\fP.
627 If the terminal can clear from the current position to the end of the
628 display, then this should be given as \fBed\fR.
629 \fBEd\fR is only defined from the first column of a line.
630 (Thus, it can be simulated by a request to delete a large number of lines,
631 if a true
632 .B ed
633 is not available.)
634 .PP
635 .SS Insert/delete line and vertical motions
636 .PP
637 If the terminal can open a new blank line before the line where the cursor
638 is, this should be given as \fBil1\fR; this is done only from the first
639 position of a line.
640 The cursor must then appear on the newly blank line.
641 If the terminal can delete the line which the cursor is on, then this
642 should be given as \fBdl1\fR; this is done only from the first position on
643 the line to be deleted.
644 Versions of
645 .B il1
646 and
647 .B dl1
648 which take a single parameter and insert or delete that many lines can
649 be given as
650 .B il
651 and
652 .BR dl .
653 .PP
654 If the terminal has a settable scrolling region (like the vt100)
655 the command to set this can be described with the
656 .B csr
657 capability, which takes two parameters:
658 the top and bottom lines of the scrolling region.
659 The cursor position is, alas, undefined after using this command.
660 .PP
661 It is possible to get the effect of insert or delete line using
662 .B csr
663 on a properly chosen region; the
664 .B sc
665 and
666 .B rc
667 (save and restore cursor) commands may be useful for ensuring that
668 your synthesized insert/delete string does not move the cursor.
669 (Note that the \fBncurses\fR(3X) library does this synthesis
670 automatically, so you need not compose insert/delete strings for
671 an entry with \fBcsr\fR).
672 .PP
673 Yet another way to construct insert and delete might be to use a combination of
674 index with the memory-lock feature found on some terminals (like the HP\-700/90
675 series, which however also has insert/delete).
676 .PP
677 Inserting lines at the top or bottom of the screen can also be
678 done using
679 .B ri
680 or
681 .B ind
682 on many terminals without a true insert/delete line,
683 and is often faster even on terminals with those features.
684 .PP
685 The boolean \fBnon_dest_scroll_region\fR should be set if each scrolling
686 window is effectively a view port on a screen-sized canvas.
687 To test for
688 this capability, create a scrolling region in the middle of the screen,
689 write something to the bottom line, move the cursor to the top of the region,
690 and do \fBri\fR followed by \fBdl1\fR or \fBind\fR.
691 If the data scrolled
692 off the bottom of the region by the \fBri\fR re-appears, then scrolling
693 is non-destructive.
694 System V and XSI Curses expect that \fBind\fR, \fBri\fR,
695 \fBindn\fR, and \fBrin\fR will simulate destructive scrolling; their
696 documentation cautions you not to define \fBcsr\fR unless this is true.
697 This \fBcurses\fR implementation is more liberal and will do explicit erases
698 after scrolling if \fBndsrc\fR is defined.
699 .PP
700 If the terminal has the ability to define a window as part of
701 memory, which all commands affect,
702 it should be given as the parameterized string
703 .BR wind .
704 The four parameters are the starting and ending lines in memory
705 and the starting and ending columns in memory, in that order.
706 .PP
707 If the terminal can retain display memory above, then the
708 \fBda\fR capability should be given; if display memory can be retained
709 below, then \fBdb\fR should be given.
710 These indicate
711 that deleting a line or scrolling may bring non-blank lines up from below
712 or that scrolling back with \fBri\fR may bring down non-blank lines.
713 .PP
714 .SS Insert/Delete Character
715 .PP
716 There are two basic kinds of intelligent terminals with respect to
717 insert/delete character which can be described using
718 .I terminfo.
719 The most common insert/delete character operations affect only the characters
720 on the current line and shift characters off the end of the line rigidly.
721 Other terminals, such as the Concept 100 and the Perkin Elmer Owl, make
722 a distinction between typed and untyped blanks on the screen, shifting
723 upon an insert or delete only to an untyped blank on the screen which is
724 either eliminated, or expanded to two untyped blanks.
725 .PP
726 You can determine the
727 kind of terminal you have by clearing the screen and then typing
728 text separated by cursor motions.
729 Type \*(``abc\ \ \ \ def\*('' using local
730 cursor motions (not spaces) between the \*(``abc\*('' and the \*(``def\*(''.
731 Then position the cursor before the \*(``abc\*('' and put the terminal in insert
732 mode.
733 If typing characters causes the rest of the line to shift
734 rigidly and characters to fall off the end, then your terminal does
735 not distinguish between blanks and untyped positions.
736 If the \*(``abc\*(''
737 shifts over to the \*(``def\*('' which then move together around the end of the
738 current line and onto the next as you insert, you have the second type of
739 terminal, and should give the capability \fBin\fR, which stands for
740 \*(``insert null\*(''.
741 .PP
742 While these are two logically separate attributes (one line versus multi-line
743 insert mode, and special treatment of untyped spaces) we have seen no
744 terminals whose insert mode cannot be described with the single attribute.
745 .PP
746 Terminfo can describe both terminals which have an insert mode, and terminals
747 which send a simple sequence to open a blank position on the current line.
748 Give as \fBsmir\fR the sequence to get into insert mode.
749 Give as \fBrmir\fR the sequence to leave insert mode.
750 Now give as \fBich1\fR any sequence needed to be sent just before sending
751 the character to be inserted.
752 Most terminals with a true insert mode
753 will not give \fBich1\fR; terminals which send a sequence to open a screen
754 position should give it here.
755 .PP
756 If your terminal has both, insert mode is usually preferable to \fBich1\fR.
757 Technically, you should not give both unless the terminal actually requires
758 both to be used in combination.
759 Accordingly, some non-curses applications get
760 confused if both are present; the symptom is doubled characters in an update
761 using insert.
762 This requirement is now rare; most \fBich\fR sequences do not
763 require previous smir, and most smir insert modes do not require \fBich1\fR
764 before each character.
765 Therefore, the new \fBcurses\fR actually assumes this
766 is the case and uses either \fBrmir\fR/\fBsmir\fR or \fBich\fR/\fBich1\fR as
767 appropriate (but not both).
768 If you have to write an entry to be used under
769 new curses for a terminal old enough to need both, include the
770 \fBrmir\fR/\fBsmir\fR sequences in \fBich1\fR.
771 .PP
772 If post insert padding is needed, give this as a number of milliseconds
773 in \fBip\fR (a string option).
774 Any other sequence which may need to be
775 sent after an insert of a single character may also be given in \fBip\fR.
776 If your terminal needs both to be placed into an \*(``insert mode\*('' and
777 a special code to precede each inserted character, then both
778 .BR smir / rmir
779 and
780 .B ich1
781 can be given, and both will be used.
782 The
783 .B ich
784 capability, with one parameter,
785 .IR n ,
786 will repeat the effects of
787 .B ich1
788 .I n
789 times.
790 .PP
791 If padding is necessary between characters typed while not
792 in insert mode, give this as a number of milliseconds padding in \fBrmp\fP.
793 .PP
794 It is occasionally necessary to move around while in insert mode
795 to delete characters on the same line (e.g., if there is a tab after
796 the insertion position).
797 If your terminal allows motion while in
798 insert mode you can give the capability \fBmir\fR to speed up inserting
799 in this case.
800 Omitting \fBmir\fR will affect only speed.
801 Some terminals
802 (notably Datamedia's) must not have \fBmir\fR because of the way their
803 insert mode works.
804 .PP
805 Finally, you can specify
806 .B dch1
807 to delete a single character,
808 .B dch
809 with one parameter,
810 .IR n ,
811 to delete
812 .I n characters,
813 and delete mode by giving \fBsmdc\fR and \fBrmdc\fR
814 to enter and exit delete mode (any mode the terminal needs to be placed
815 in for
816 .B dch1
817 to work).
818 .PP
819 A command to erase
820 .I n
821 characters (equivalent to outputting
822 .I n
823 blanks without moving the cursor)
824 can be given as
825 .B ech
826 with one parameter.
827 .PP
828 .SS "Highlighting, Underlining, and Visible Bells"
829 .PP
830 If your terminal has one or more kinds of display attributes,
831 these can be represented in a number of different ways.
832 You should choose one display form as
833 \f2standout mode\fR,
834 representing a good, high contrast, easy-on-the-eyes,
835 format for highlighting error messages and other attention getters.
836 (If you have a choice, reverse video plus half-bright is good,
837 or reverse video alone.)
838 The sequences to enter and exit standout mode
839 are given as \fBsmso\fR and \fBrmso\fR, respectively.
840 If the code to change into or out of standout
841 mode leaves one or even two blank spaces on the screen,
842 as the TVI 912 and Teleray 1061 do,
843 then \fBxmc\fR should be given to tell how many spaces are left.
844 .PP
845 Codes to begin underlining and end underlining can be given as \fBsmul\fR
846 and \fBrmul\fR respectively.
847 If the terminal has a code to underline the current character and move
848 the cursor one space to the right,
849 such as the Microterm Mime,
850 this can be given as \fBuc\fR.
851 .PP
852 Other capabilities to enter various highlighting modes include
853 .B blink
854 (blinking)
855 .B bold
856 (bold or extra bright)
857 .B dim
858 (dim or half-bright)
859 .B invis
860 (blanking or invisible text)
861 .B prot
862 (protected)
863 .B rev
864 (reverse video)
865 .B sgr0
866 (turn off
867 .I all
868 attribute modes)
869 .B smacs
870 (enter alternate character set mode)
871 and
872 .B rmacs
873 (exit alternate character set mode).
874 Turning on any of these modes singly may or may not turn off other modes.
875 .PP
876 If there is a sequence to set arbitrary combinations of modes,
877 this should be given as
878 .B sgr
879 (set attributes),
880 taking 9 parameters.
881 Each parameter is either 0 or nonzero, as the corresponding attribute is on or off.
882 The 9 parameters are, in order:
883 standout, underline, reverse, blink, dim, bold, blank, protect, alternate
884 character set.
885 Not all modes need be supported by
886 .BR sgr ,
887 only those for which corresponding separate attribute commands exist.
888 .PP
889 For example, the DEC vt220 supports most of the modes:
890 .PP
891 .TS
892 center;
893 l l l
894 l l l
895 lw18 lw14 lw18.
896 \fBtparm parameter      attribute       escape sequence\fP
898 none    none    \\E[0m
899 p1      standout        \\E[0;1;7m
900 p2      underline       \\E[0;4m
901 p3      reverse \\E[0;7m
902 p4      blink   \\E[0;5m
903 p5      dim     not available
904 p6      bold    \\E[0;1m
905 p7      invis   \\E[0;8m
906 p8      protect not used
907 p9      altcharset      ^O (off) ^N (on)
908 .TE
909 .PP
910 We begin each escape sequence by turning off any existing modes, since
911 there is no quick way to determine whether they are active.
912 Standout is set up to be the combination of reverse and bold.
913 The vt220 terminal has a protect mode,
914 though it is not commonly used in sgr
915 because it protects characters on the screen from the host's erasures.
916 The altcharset mode also is different in that it is either ^O or ^N,
917 depending on whether it is off or on.
918 If all modes are turned on, the resulting sequence is \\E[0;1;4;5;7;8m^N.
919 .PP
920 Some sequences are common to different modes.
921 For example, ;7 is output when either p1 or p3 is true, that is, if
922 either standout or reverse modes are turned on.
923 .PP
924 Writing out the above sequences, along with their dependencies yields
925 .PP
926 .ne 11
927 .TS
928 center;
929 l l l
930 l l l
931 lw18 lw14 lw18.
932 \fBsequence     when to output  terminfo translation\fP
934 .ft CW
935 \\E[0   always  \\E[0
936 ;1      if p1 or p6     %?%p1%p6%|%t;1%;
937 ;4      if p2   %?%p2%|%t;4%;
938 ;5      if p4   %?%p4%|%t;5%;
939 ;7      if p1 or p3     %?%p1%p3%|%t;7%;
940 ;8      if p7   %?%p7%|%t;8%;
941 m       always  m
942 ^N or ^O        if p9 ^N, else ^O       %?%p9%t^N%e^O%;
943 .ft R
944 .TE
945 .PP
946 Putting this all together into the sgr sequence gives:
947 .PP
948 .ft CW
949 .nf
950     sgr=\\E[0%?%p1%p6%|%t;1%;%?%p2%t;4%;%?%p4%t;5%;
951         %?%p1%p3%|%t;7%;%?%p7%t;8%;m%?%p9%t\\016%e\\017%;,
952 .fi
953 .ft R
954 .PP
955 Remember that if you specify sgr, you must also specify sgr0.
956 Also, some implementations rely on sgr being given if sgr0 is,
957 Not all terminfo entries necessarily have an sgr string, however.
958 Many terminfo entries are derived from termcap entries
959 which have no sgr string.
960 The only drawback to adding an sgr string is that termcap also
961 assumes that sgr0 does not exit alternate character set mode.
962 .PP
963 Terminals with the \*(``magic cookie\*('' glitch
964 .RB ( xmc )
965 deposit special \*(``cookies\*('' when they receive mode-setting sequences,
966 which affect the display algorithm rather than having extra bits for
967 each character.
968 Some terminals, such as the HP 2621, automatically leave standout
969 mode when they move to a new line or the cursor is addressed.
970 Programs using standout mode should exit standout mode before
971 moving the cursor or sending a newline,
972 unless the
973 .B msgr
974 capability, asserting that it is safe to move in standout mode, is present.
975 .PP
976 If the terminal has
977 a way of flashing the screen to indicate an error quietly (a bell replacement)
978 then this can be given as \fBflash\fR; it must not move the cursor.
979 .PP
980 If the cursor needs to be made more visible than normal when it is
981 not on the bottom line (to make, for example, a non-blinking underline into an
982 easier to find block or blinking underline)
983 give this sequence as
984 .BR cvvis .
985 If there is a way to make the cursor completely invisible, give that as
986 .BR civis .
987 The capability
988 .B cnorm
989 should be given which undoes the effects of both of these modes.
990 .PP
991 If your terminal correctly generates underlined characters
992 (with no special codes needed)
993 even though it does not overstrike,
994 then you should give the capability \fBul\fR.
995 If a character overstriking another leaves both characters on the screen,
996 specify the capability \fBos\fP.
997 If overstrikes are erasable with a blank,
998 then this should be indicated by giving \fBeo\fR.
999 .PP
1000 .SS Keypad and Function Keys
1001 .PP
1002 If the terminal has a keypad that transmits codes when the keys are pressed,
1003 this information can be given.
1004 Note that it is not possible to handle
1005 terminals where the keypad only works in local (this applies, for example,
1006 to the unshifted HP 2621 keys).
1007 If the keypad can be set to transmit or not transmit,
1008 give these codes as \fBsmkx\fR and \fBrmkx\fR.
1009 Otherwise the keypad is assumed to always transmit.
1010 .PP
1011 The codes sent by the left arrow, right arrow, up arrow, down arrow,
1012 and home keys can be given as
1013 \fBkcub1, kcuf1, kcuu1, kcud1, \fRand\fB khome\fR respectively.
1014 If there are function keys such as f0, f1, ..., f10, the codes they send
1015 can be given as \fBkf0, kf1, ..., kf10\fR.
1016 If these keys have labels other than the default f0 through f10, the labels
1017 can be given as \fBlf0, lf1, ..., lf10\fR.
1018 .PP
1019 The codes transmitted by certain other special keys can be given:
1020 .bP
1021 .B kll
1022 (home down),
1023 .bP
1024 .B kbs
1025 (backspace),
1026 .bP
1027 .B ktbc
1028 (clear all tabs),
1029 .bP
1030 .B kctab
1031 (clear the tab stop in this column),
1032 .bP
1033 .B kclr
1034 (clear screen or erase key),
1035 .bP
1036 .B kdch1
1037 (delete character),
1038 .bP
1039 .B kdl1
1040 (delete line),
1041 .bP
1042 .B krmir
1043 (exit insert mode),
1044 .bP
1045 .B kel
1046 (clear to end of line),
1047 .bP
1048 .B ked
1049 (clear to end of screen),
1050 .bP
1051 .B kich1
1052 (insert character or enter insert mode),
1053 .bP
1054 .B kil1
1055 (insert line),
1056 .bP
1057 .B knp
1058 (next page),
1059 .bP
1060 .B kpp
1061 (previous page),
1062 .bP
1063 .B kind
1064 (scroll forward/down),
1065 .bP
1066 .B kri
1067 (scroll backward/up),
1068 .bP
1069 .B khts
1070 (set a tab stop in this column).
1071 .PP
1072 In addition, if the keypad has a 3 by 3 array of keys including the four
1073 arrow keys, the other five keys can be given as
1074 .BR ka1 ,
1075 .BR ka3 ,
1076 .BR kb2 ,
1077 .BR kc1 ,
1078 and
1079 .BR kc3 .
1080 These keys are useful when the effects of a 3 by 3 directional pad are needed.
1081 .PP
1082 Strings to program function keys can be given as
1083 .BR pfkey ,
1084 .BR pfloc ,
1085 and
1086 .BR pfx .
1087 A string to program screen labels should be specified as \fBpln\fP.
1088 Each of these strings takes two parameters: the function key number to
1089 program (from 0 to 10) and the string to program it with.
1090 Function key numbers out of this range may program undefined keys in
1091 a terminal dependent manner.
1092 The difference between the capabilities is that
1093 .B pfkey
1094 causes pressing the given key to be the same as the user typing the
1095 given string;
1096 .B pfloc
1097 causes the string to be executed by the terminal in local; and
1098 .B pfx
1099 causes the string to be transmitted to the computer.
1100 .PP
1101 The capabilities \fBnlab\fP, \fBlw\fP and \fBlh\fP
1102 define the number of programmable
1103 screen labels and their width and height.
1104 If there are commands to turn the labels on and off,
1105 give them in \fBsmln\fP and \fBrmln\fP.
1106 \fBsmln\fP is normally output after one or more pln
1107 sequences to make sure that the change becomes visible.
1108 .PP
1109 .SS Tabs and Initialization
1110 .PP
1111 A few capabilities are used only for tabs:
1112 .bP
1113 If the terminal has hardware tabs, the command to advance to the next
1114 tab stop can be given as
1115 .B ht
1116 (usually control/I).
1117 .bP
1118 A \*(``back-tab\*('' command which moves leftward to the preceding tab stop can
1119 be given as
1120 .BR cbt .
1121 .IP
1122 By convention, if the teletype modes indicate that tabs are being
1123 expanded by the computer rather than being sent to the terminal,
1124 programs should not use
1125 .B ht
1126 or
1127 .B cbt
1128 even if they are present, since the user may not have the tab stops
1129 properly set.
1130 .bP
1131 If the terminal has hardware tabs which are initially set every
1132 .I n
1133 spaces when the terminal is powered up,
1134 the numeric parameter
1135 .B it
1136 is given, showing the number of spaces the tabs are set to.
1137 .IP
1138 The \fBit\fP capability is normally used by the \fB@TSET@\fP
1139 command to determine whether to set the mode for hardware tab expansion,
1140 and whether to set the tab stops.
1141 If the terminal has tab stops that can be saved in non-volatile memory,
1142 the terminfo description can assume that they are properly set.
1143 .PP
1144 Other capabilities
1145 include
1146 .bP
1147 .BR is1 ,
1148 .BR is2 ,
1149 and
1150 .BR is3 ,
1151 initialization strings for the terminal,
1152 .bP
1153 .BR iprog ,
1154 the path name of a program to be run to initialize the terminal,
1155 .bP
1156 and \fBif\fR, the name of a file containing long initialization strings.
1157 .PP
1158 These strings are expected to set the terminal into modes consistent
1159 with the rest of the terminfo description.
1160 They are normally sent to the terminal, by the
1161 .I init
1162 option of the \fB@TPUT@\fP program, each time the user logs in.
1163 They will be printed in the following order:
1164 .RS
1165 .TP
1166 run the program
1167 .B iprog
1168 .TP
1169 output
1170 .br
1171 \fBis1\fP and
1172 .br
1173 \fBis2\fP
1174 .TP
1175 set the margins using
1176 \fBmgc\fP or
1177 .br
1178 \fBsmglp\fP and \fBsmgrp\fP or
1179 .br
1180 \fBsmgl\fP and \fBsmgr\fP
1181 .TP
1182 set tabs using
1183 .B tbc
1184 and
1185 .B hts
1186 .TP
1187 print the file
1188 \fBif\fP
1189 .TP
1190 and finally output
1191 \fBis3\fP.
1192 .RE
1193 .PP
1194 Most initialization is done with
1195 .BR is2 .
1196 Special terminal modes can be set up without duplicating strings
1197 by putting the common sequences in
1198 .B is2
1199 and special cases in
1200 .B is1
1201 and
1202 .BR is3 .
1203 .PP
1204 A set of sequences that does a harder reset from a totally unknown state
1205 can be given as
1206 .BR rs1 ,
1207 .BR rs2 ,
1208 .B rf
1209 and
1210 .BR rs3 ,
1211 analogous to
1212 .B is1 ,
1213 .B is2 ,
1214 .B if
1215 and
1216 .B is3
1217 respectively.
1218 These strings are output
1219 by \fIreset\fP option of \fB@TPUT@\fP,
1220 or by the \fB@RESET@\fP program
1221 (an alias of \fB@TSET@\fP),
1222 which is used when the terminal gets into a wedged state.
1223 Commands are normally placed in
1224 .BR rs1 ,
1225 .B rs2
1226 .B rs3
1227 and
1228 .B rf
1229 only if they produce annoying effects on the screen and are not
1230 necessary when logging in.
1231 For example, the command to set the vt100 into 80-column mode would
1232 normally be part of
1233 .BR is2 ,
1234 but it causes an annoying glitch of the screen and is not normally
1235 needed since the terminal is usually already in 80-column mode.
1236 .PP
1237 The \fB@RESET@\fP program writes strings including
1238 .BR iprog ,
1239 etc., in the same order as the
1240 .I init
1241 program, using
1242 .BR rs1 ,
1243 etc., instead of
1244 .BR is1 ,
1245 etc.
1246 If any of
1247 .BR rs1 ,
1248 .BR rs2 ,
1249 .BR rs3 ,
1250 or
1251 .B rf
1252 reset capability strings are missing,
1253 the \fB@RESET@\fP program
1254 falls back upon the corresponding initialization capability string.
1255 .PP
1256 If there are commands to set and clear tab stops, they can be given as
1257 .B tbc
1258 (clear all tab stops)
1259 and
1260 .B hts
1261 (set a tab stop in the current column of every row).
1262 If a more complex sequence is needed to set the tabs than can be
1263 described by this, the sequence can be placed in
1264 .B is2
1265 or
1266 .BR if .
1267 .PP
1268 The \fB@TPUT@ reset\fP command uses the same capability strings
1269 as the \fB@RESET@\fP command,
1270 although the two programs (\fB@TPUT@\fP and \fB@RESET@\fP)
1271 provide different command-line options.
1272 .PP
1273 In practice, these terminfo capabilities are not often used in
1274 initialization of tabs
1275 (though they are required for the \fB@TABS@\fP program):
1276 .bP
1277 Almost all hardware terminals (at least those which supported tabs)
1278 initialized those to every \fIeight\fP columns:
1279 .IP
1280 The only exception was the AT&T 2300 series,
1281 which set tabs to every \fIfive\fP columns.
1282 .bP
1283 In particular, developers of the hardware terminals which are commonly used
1284 as models for modern terminal emulators provided documentation demonstrating
1285 that \fIeight\fP columns were the standard.
1286 .bP
1287 Because of this, the terminal initialization programs
1288 \fB@TPUT@\fP and \fB@TSET@\fP
1289 use the
1290 \fBtbc\fP (\fBclear_all_tabs\fP) and
1291 \fBhts\fP (\fBset_tab\fP) capabilities directly
1292 only when the \fBit\fP (\fBinit_tabs\fP) capability
1293 is set to a value other than \fIeight\fP.
1294 .SS Delays and Padding
1295 .PP
1296 Many older and slower terminals do not support either XON/XOFF or DTR
1297 handshaking, including hard copy terminals and some very archaic CRTs
1298 (including, for example, DEC VT100s).
1299 These may require padding characters
1300 after certain cursor motions and screen changes.
1301 .PP
1302 If the terminal uses xon/xoff handshaking for flow control (that is,
1303 it automatically emits ^S back to the host when its input buffers are
1304 close to full), set
1305 .BR xon .
1306 This capability suppresses the emission of padding.
1307 You can also set it
1308 for memory-mapped console devices effectively that do not have a speed limit.
1309 Padding information should still be included so that routines can
1310 make better decisions about relative costs, but actual pad characters will
1311 not be transmitted.
1312 .PP
1313 If \fBpb\fR (padding baud rate) is given, padding is suppressed at baud rates
1314 below the value of \fBpb\fR.
1315 If the entry has no padding baud rate, then
1316 whether padding is emitted or not is completely controlled by \fBxon\fR.
1317 .PP
1318 If the terminal requires other than a null (zero) character as a pad,
1319 then this can be given as \fBpad\fR.
1320 Only the first character of the
1321 .B pad
1322 string is used.
1323 .PP
1324 .SS Status Lines
1325 Some terminals have an extra \*(``status line\*('' which is not normally used by
1326 software (and thus not counted in the terminal's \fBlines\fR capability).
1327 .PP
1328 The simplest case is a status line which is cursor-addressable but not
1329 part of the main scrolling region on the screen; the Heathkit H19 has
1330 a status line of this kind, as would a 24-line VT100 with a 23-line
1331 scrolling region set up on initialization.
1332 This situation is indicated
1333 by the \fBhs\fR capability.
1334 .PP
1335 Some terminals with status lines need special sequences to access the
1336 status line.
1337 These may be expressed as a string with single parameter
1338 \fBtsl\fR which takes the cursor to a given zero-origin column on the
1339 status line.
1340 The capability \fBfsl\fR must return to the main-screen
1341 cursor positions before the last \fBtsl\fR.
1342 You may need to embed the
1343 string values of \fBsc\fR (save cursor) and \fBrc\fR (restore cursor)
1344 in \fBtsl\fR and \fBfsl\fR to accomplish this.
1345 .PP
1346 The status line is normally assumed to be the same width as the width
1347 of the terminal.
1348 If this is untrue, you can specify it with the numeric
1349 capability \fBwsl\fR.
1350 .PP
1351 A command to erase or blank the status line may be specified as \fBdsl\fR.
1352 .PP
1353 The boolean capability \fBeslok\fR specifies that escape sequences, tabs,
1354 etc., work ordinarily in the status line.
1355 .PP
1356 The \fBncurses\fR implementation does not yet use any of these capabilities.
1357 They are documented here in case they ever become important.
1358 .PP
1359 .SS Line Graphics
1360 .PP
1361 Many terminals have alternate character sets useful for forms-drawing.
1362 Terminfo and \fBcurses\fR have built-in support
1363 for most of the drawing characters
1364 supported by the VT100, with some characters from the AT&T 4410v1 added.
1365 This alternate character set may be specified by the \fBacsc\fR capability.
1366 .PP
1367 .TS H
1368 center expand;
1369 l l l l l
1370 l l l l l
1371 _ _ _ _ _
1372 lw25 lw10 lw6 lw6 lw6.
1373 .\".TH
1374 \fBGlyph        ACS     Ascii   acsc    acsc\fR
1375 \fBName Name    Default Char    Value\fR
1376 arrow pointing right    ACS_RARROW      >       +       0x2b
1377 arrow pointing left     ACS_LARROW      <       ,       0x2c
1378 arrow pointing up       ACS_UARROW      ^       \-      0x2d
1379 arrow pointing down     ACS_DARROW      v       .       0x2e
1380 solid square block      ACS_BLOCK       #       0       0x30
1381 diamond                 ACS_DIAMOND     +       `       0x60
1382 checker board (stipple) ACS_CKBOARD     :       a       0x61
1383 degree symbol           ACS_DEGREE      \e      f       0x66
1384 plus/minus              ACS_PLMINUS     #       g       0x67
1385 board of squares        ACS_BOARD       #       h       0x68
1386 lantern symbol          ACS_LANTERN     #       i       0x69
1387 lower right corner      ACS_LRCORNER    +       j       0x6a
1388 upper right corner      ACS_URCORNER    +       k       0x6b
1389 upper left corner       ACS_ULCORNER    +       l       0x6c
1390 lower left corner       ACS_LLCORNER    +       m       0x6d
1391 large plus or crossover ACS_PLUS        +       n       0x6e
1392 scan line 1             ACS_S1          ~       o       0x6f
1393 scan line 3             ACS_S3          \-      p       0x70
1394 horizontal line         ACS_HLINE       \-      q       0x71
1395 scan line 7             ACS_S7          \-      r       0x72
1396 scan line 9             ACS_S9          \&_     s       0x73
1397 tee pointing right      ACS_LTEE        +       t       0x74
1398 tee pointing left       ACS_RTEE        +       u       0x75
1399 tee pointing up         ACS_BTEE        +       v       0x76
1400 tee pointing down       ACS_TTEE        +       w       0x77
1401 vertical line           ACS_VLINE       |       x       0x78
1402 less-than-or-equal-to   ACS_LEQUAL      <       y       0x79
1403 greater-than-or-equal-to        ACS_GEQUAL      >       z       0x7a
1404 greek pi                ACS_PI  *       {       0x7b
1405 not-equal               ACS_NEQUAL      !       |       0x7c
1406 UK pound sign           ACS_STERLING    f       }       0x7d
1407 bullet                  ACS_BULLET      o       ~       0x7e
1408 .TE
1409 .PP
1410 A few notes apply to the table itself:
1411 .bP
1412 X/Open Curses incorrectly states that the mapping for \fIlantern\fP is
1413 uppercase \*(``I\*('' although Unix implementations use the
1414 lowercase \*(``i\*('' mapping.
1415 .bP
1416 The DEC VT100 implemented graphics using the alternate character set
1417 feature, temporarily switching \fImodes\fP and sending characters
1418 in the range 0x60 (96) to 0x7e (126)
1419 (the \fBacsc Value\fP column in the table).
1420 .bP
1421 The AT&T terminal added graphics characters outside that range.
1422 .IP
1423 Some of the characters within the range do not match the VT100;
1424 presumably they were used in the AT&T terminal:
1425 \fIboard of squares\fP replaces the VT100 \fInewline\fP symbol, while
1426 \fIlantern symbol\fP replaces the VT100 \fIvertical tab\fP symbol.
1427 The other VT100 symbols for control characters (\fIhorizontal tab\fP,
1428 \fIcarriage return\fP and \fIline-feed\fP) are not (re)used in curses.
1429 .PP
1430 The best way to define a new device's graphics set is to add a column
1431 to a copy of this table for your terminal, giving the character which
1432 (when emitted between \fBsmacs\fR/\fBrmacs\fR switches) will be rendered
1433 as the corresponding graphic.
1434 Then read off the VT100/your terminal
1435 character pairs right to left in sequence; these become the ACSC string.
1436 .PP
1437 .SS Color Handling
1438 .PP
1439 The curses library functions \fBinit_pair\fP and \fBinit_color\fP
1440 manipulate the \fIcolor pairs\fP and \fIcolor values\fP discussed in this
1441 section
1442 (see \fBcurs_color\fP(3X) for details on these and related functions).
1443 .PP
1444 Most color terminals are either \*(``Tektronix-like\*('' or \*(``HP-like\*('':
1445 .bP
1446 Tektronix-like
1447 terminals have a predefined set of \fIN\fP colors
1448 (where \fIN\fP is usually 8),
1449 and can set
1450 character-cell foreground and background characters independently, mixing them
1451 into \fIN\fP\ *\ \fIN\fP color-pairs.
1452 .bP
1453 On HP-like terminals, the user must set each color
1454 pair up separately (foreground and background are not independently settable).
1455 Up to \fIM\fP color-pairs may be set up from 2*\fIM\fP different colors.
1456 ANSI-compatible terminals are Tektronix-like.
1457 .PP
1458 Some basic color capabilities are independent of the color method.
1459 The numeric
1460 capabilities \fBcolors\fR and \fBpairs\fR specify the maximum numbers of colors
1461 and color-pairs that can be displayed simultaneously.
1462 The \fBop\fR (original
1463 pair) string resets foreground and background colors to their default values
1464 for the terminal.
1465 The \fBoc\fR string resets all colors or color-pairs to
1466 their default values for the terminal.
1467 Some terminals (including many PC
1468 terminal emulators) erase screen areas with the current background color rather
1469 than the power-up default background; these should have the boolean capability
1470 \fBbce\fR.
1471 .PP
1472 While the curses library works with \fIcolor pairs\fP
1473 (reflecting the inability of some devices to set foreground
1474 and background colors independently),
1475 there are separate capabilities for setting these features:
1476 .bP
1477 To change the current foreground or background color on a Tektronix-type
1478 terminal, use \fBsetaf\fR (set ANSI foreground) and \fBsetab\fR (set ANSI
1479 background) or \fBsetf\fR (set foreground) and \fBsetb\fR (set background).
1480 These take one parameter, the color number.
1481 The SVr4 documentation describes
1482 only \fBsetaf\fR/\fBsetab\fR; the XPG4 draft says that "If the terminal
1483 supports ANSI escape sequences to set background and foreground, they should
1484 be coded as \fBsetaf\fR and \fBsetab\fR, respectively.
1485 .bP
1486 If the terminal
1487 supports other escape sequences to set background and foreground, they should
1488 be coded as \fBsetf\fR and \fBsetb\fR, respectively.
1489 The \fBvidputs\fR and the \fBrefresh\fP(3X) functions
1490 use the \fBsetaf\fR and \fBsetab\fR capabilities if they are defined.
1491 .PP
1492 The \fBsetaf\fR/\fBsetab\fR and \fBsetf\fR/\fBsetb\fR capabilities take a
1493 single numeric argument each.
1494 Argument values 0-7 of \fBsetaf\fR/\fBsetab\fR are portably defined as
1495 follows (the middle column is the symbolic #define available in the header for
1496 the \fBcurses\fR or \fBncurses\fR libraries).
1497 The terminal hardware is free to
1498 map these as it likes, but the RGB values indicate normal locations in color
1499 space.
1500 .PP
1501 .TS H
1502 center;
1503 l c c c
1504 l l n l.
1505 \fBColor        #define         Value   RGB\fR
1506 black   \fBCOLOR_BLACK\fR       0       0, 0, 0
1507 red     \fBCOLOR_RED\ \fR       1       max,0,0
1508 green   \fBCOLOR_GREEN\fR       2       0,max,0
1509 yellow  \fBCOLOR_YELLOW\fR      3       max,max,0
1510 blue    \fBCOLOR_BLUE\fR        4       0,0,max
1511 magenta \fBCOLOR_MAGENTA\fR     5       max,0,max
1512 cyan    \fBCOLOR_CYAN\fR        6       0,max,max
1513 white   \fBCOLOR_WHITE\fR       7       max,max,max
1514 .TE
1515 .PP
1516 The argument values of \fBsetf\fR/\fBsetb\fR historically correspond to
1517 a different mapping, i.e.,
1518 .TS H
1519 center;
1520 l c c c
1521 l l n l.
1522 \fBColor        #define         Value   RGB\fR
1523 black   \fBCOLOR_BLACK\fR       0       0, 0, 0
1524 blue    \fBCOLOR_BLUE\fR        1       0,0,max
1525 green   \fBCOLOR_GREEN\fR       2       0,max,0
1526 cyan    \fBCOLOR_CYAN\fR        3       0,max,max
1527 red     \fBCOLOR_RED\ \fR       4       max,0,0
1528 magenta \fBCOLOR_MAGENTA\fR     5       max,0,max
1529 yellow  \fBCOLOR_YELLOW\fR      6       max,max,0
1530 white   \fBCOLOR_WHITE\fR       7       max,max,max
1531 .TE
1532 .PP
1533 It is important to not confuse the two sets of color capabilities;
1534 otherwise red/blue will be interchanged on the display.
1535 .PP
1536 On an HP-like terminal, use \fBscp\fR with a color-pair number parameter to set
1537 which color pair is current.
1538 .PP
1539 Some terminals allow the \fIcolor values\fP to be modified:
1540 .bP
1541 On a Tektronix-like terminal, the capability \fBccc\fR may be present to
1542 indicate that colors can be modified.
1543 If so, the \fBinitc\fR capability will
1544 take a color number (0 to \fBcolors\fR \- 1)and three more parameters which
1545 describe the color.
1546 These three parameters default to being interpreted as RGB
1547 (Red, Green, Blue) values.
1548 If the boolean capability \fBhls\fR is present,
1549 they are instead as HLS (Hue, Lightness, Saturation) indices.
1550 The ranges are
1551 terminal-dependent.
1552 .bP
1553 On an HP-like terminal, \fBinitp\fR may give a capability for changing a
1554 color-pair value.
1555 It will take seven parameters; a color-pair number (0 to
1556 \fBmax_pairs\fR \- 1), and two triples describing first background and then
1557 foreground colors.
1558 These parameters must be (Red, Green, Blue) or
1559 (Hue, Lightness, Saturation) depending on \fBhls\fR.
1560 .PP
1561 On some color terminals, colors collide with highlights.
1562 You can register
1563 these collisions with the \fBncv\fR capability.
1564 This is a bit-mask of
1565 attributes not to be used when colors are enabled.
1566 The correspondence with the
1567 attributes understood by \fBcurses\fR is as follows:
1568 .PP
1569 .TS
1570 center;
1571 l l l l
1572 lw20 lw2 lw10 lw10.
1573 \fBAttribute    Bit     Decimal Set by\fR
1574 A_STANDOUT      0       1       sgr
1575 A_UNDERLINE     1       2       sgr
1576 A_REVERSE       2       4       sgr
1577 A_BLINK         3       8       sgr
1578 A_DIM           4       16      sgr
1579 A_BOLD          5       32      sgr
1580 A_INVIS         6       64      sgr
1581 A_PROTECT       7       128     sgr
1582 A_ALTCHARSET    8       256     sgr
1583 A_HORIZONTAL    9       512     sgr1
1584 A_LEFT  10      1024    sgr1
1585 A_LOW   11      2048    sgr1
1586 A_RIGHT 12      4096    sgr1
1587 A_TOP   13      8192    sgr1
1588 A_VERTICAL      14      16384   sgr1
1589 A_ITALIC        15      32768   sitm
1590 .TE
1591 .PP
1592 For example, on many IBM PC consoles, the underline attribute collides with the
1593 foreground color blue and is not available in color mode.
1594 These should have
1595 an \fBncv\fR capability of 2.
1596 .PP
1597 SVr4 curses does nothing with \fBncv\fR, ncurses recognizes it and optimizes
1598 the output in favor of colors.
1599 .PP
1600 .SS Miscellaneous
1601 If the terminal requires other than a null (zero) character as a pad, then this
1602 can be given as pad.
1603 Only the first character of the pad string is used.
1604 If the terminal does not have a pad character, specify npc.
1605 Note that ncurses implements the termcap-compatible \fBPC\fR variable;
1606 though the application may set this value to something other than
1607 a null, ncurses will test \fBnpc\fR first and use napms if the terminal
1608 has no pad character.
1609 .PP
1610 If the terminal can move up or down half a line,
1611 this can be indicated with
1612 .B hu
1613 (half-line up)
1614 and
1615 .B hd
1616 (half-line down).
1617 This is primarily useful for superscripts and subscripts on hard-copy terminals.
1618 If a hard-copy terminal can eject to the next page (form feed), give this as
1619 .B ff
1620 (usually control/L).
1621 .PP
1622 If there is a command to repeat a given character a given number of
1623 times (to save time transmitting a large number of identical characters)
1624 this can be indicated with the parameterized string
1625 .BR rep .
1626 The first parameter is the character to be repeated and the second
1627 is the number of times to repeat it.
1628 Thus, tparm(repeat_char, 'x', 10) is the same as \*(``xxxxxxxxxx\*(''.
1629 .PP
1630 If the terminal has a settable command character, such as the \s-1TEKTRONIX\s+1 4025,
1631 this can be indicated with
1632 .BR cmdch .
1633 A prototype command character is chosen which is used in all capabilities.
1634 This character is given in the
1635 .B cmdch
1636 capability to identify it.
1637 The following convention is supported on some UNIX systems:
1638 The environment is to be searched for a
1639 .B CC
1640 variable, and if found, all
1641 occurrences of the prototype character are replaced with the character
1642 in the environment variable.
1643 .PP
1644 Terminal descriptions that do not represent a specific kind of known
1645 terminal, such as
1646 .IR switch ,
1647 .IR dialup ,
1648 .IR patch ,
1649 and
1650 .IR network ,
1651 should include the
1652 .B gn
1653 (generic) capability so that programs can complain that they do not know
1654 how to talk to the terminal.
1655 (This capability does not apply to
1656 .I virtual
1657 terminal descriptions for which the escape sequences are known.)
1658 .PP
1659 If the terminal has a \*(``meta key\*('' which acts as a shift key,
1660 setting the 8th bit of any character transmitted, this fact can
1661 be indicated with
1662 .BR km .
1663 Otherwise, software will assume that the 8th bit is parity and it
1664 will usually be cleared.
1665 If strings exist to turn this \*(``meta mode\*('' on and off, they
1666 can be given as
1667 .B smm
1668 and
1669 .BR rmm .
1670 .PP
1671 If the terminal has more lines of memory than will fit on the screen
1672 at once, the number of lines of memory can be indicated with
1673 .BR lm .
1674 A value of
1675 .BR lm #0
1676 indicates that the number of lines is not fixed,
1677 but that there is still more memory than fits on the screen.
1678 .PP
1679 If the terminal is one of those supported by the \s-1UNIX\s+1 virtual
1680 terminal protocol, the terminal number can be given as
1681 .BR vt .
1682 .PP
1683 Media copy
1684 strings which control an auxiliary printer connected to the terminal
1685 can be given as
1686 .BR mc0 :
1687 print the contents of the screen,
1688 .BR mc4 :
1689 turn off the printer, and
1690 .BR mc5 :
1691 turn on the printer.
1692 When the printer is on, all text sent to the terminal will be sent
1693 to the printer.
1694 It is undefined whether the text is also displayed on the terminal screen
1695 when the printer is on.
1696 A variation
1697 .B mc5p
1698 takes one parameter, and leaves the printer on for as many characters
1699 as the value of the parameter, then turns the printer off.
1700 The parameter should not exceed 255.
1701 All text, including
1702 .BR mc4 ,
1703 is transparently passed to the printer while an
1704 .B mc5p
1705 is in effect.
1706 .PP
1707 .SS Glitches and Braindamage
1708 .PP
1709 Hazeltine terminals, which do not allow \*(``~\*('' characters to be displayed should
1710 indicate \fBhz\fR.
1711 .PP
1712 Terminals which ignore a line-feed immediately after an \fBam\fR wrap,
1713 such as the Concept and vt100,
1714 should indicate \fBxenl\fR.
1715 .PP
1716 If
1717 .B el
1718 is required to get rid of standout
1719 (instead of merely writing normal text on top of it),
1720 \fBxhp\fP should be given.
1721 .PP
1722 Teleray terminals, where tabs turn all characters moved over to blanks,
1723 should indicate \fBxt\fR (destructive tabs).
1724 Note: the variable indicating this is now \*(``dest_tabs_magic_smso\*(''; in
1725 older versions, it was teleray_glitch.
1726 This glitch is also taken to mean that it is not possible to position
1727 the cursor on top of a \*(``magic cookie\*('',
1728 that to erase standout mode it is instead necessary to use
1729 delete and insert line.
1730 The ncurses implementation ignores this glitch.
1731 .PP
1732 The Beehive Superbee, which is unable to correctly transmit the escape
1733 or control/C characters, has
1734 .BR xsb ,
1735 indicating that the f1 key is used for escape and f2 for control/C.
1736 (Only certain Superbees have this problem, depending on the ROM.)
1737 Note that in older terminfo versions, this capability was called
1738 \*(``beehive_glitch\*(''; it is now \*(``no_esc_ctl_c\*(''.
1739 .PP
1740 Other specific terminal problems may be corrected by adding more
1741 capabilities of the form \fBx\fR\fIx\fR.
1742 .PP
1743 .SS Pitfalls of Long Entries
1744 .PP
1745 Long terminfo entries are unlikely to be a problem; to date, no entry has even
1746 approached terminfo's 4096-byte string-table maximum.
1747 Unfortunately, the termcap
1748 translations are much more strictly limited (to 1023 bytes), thus termcap translations
1749 of long terminfo entries can cause problems.
1750 .PP
1751 The man pages for 4.3BSD and older versions of \fBtgetent\fP instruct the user to
1752 allocate a 1024-byte buffer for the termcap entry.
1753 The entry gets null-terminated by
1754 the termcap library, so that makes the maximum safe length for a termcap entry
1755 1k\-1 (1023) bytes.
1756 Depending on what the application and the termcap library
1757 being used does, and where in the termcap file the terminal type that \fBtgetent\fP
1758 is searching for is, several bad things can happen.
1759 .PP
1760 Some termcap libraries print a warning message or exit if they find an
1761 entry that's longer than 1023 bytes; others do not; others truncate the
1762 entries to 1023 bytes.
1763 Some application programs allocate more than
1764 the recommended 1K for the termcap entry; others do not.
1765 .PP
1766 Each termcap entry has two important sizes associated with it: before
1767 \*(``tc\*('' expansion, and after \*(``tc\*('' expansion.
1768 \*(``tc\*('' is the capability that
1769 tacks on another termcap entry to the end of the current one, to add
1770 on its capabilities.
1771 If a termcap entry does not use the \*(``tc\*(''
1772 capability, then of course the two lengths are the same.
1773 .PP
1774 The \*(``before tc expansion\*('' length is the most important one, because it
1775 affects more than just users of that particular terminal.
1776 This is the
1777 length of the entry as it exists in /etc/termcap, minus the
1778 backslash-newline pairs, which \fBtgetent\fP strips out while reading it.
1779 Some termcap libraries strip off the final newline, too (GNU termcap does not).
1780 Now suppose:
1781 .bP
1782 a termcap entry before expansion is more than 1023 bytes long,
1783 .bP
1784 and the application has only allocated a 1k buffer,
1785 .bP
1786 and the termcap library (like the one in BSD/OS 1.1 and GNU) reads
1787 the whole entry into the buffer, no matter what its length, to see
1788 if it is the entry it wants,
1789 .bP
1790 and \fBtgetent\fP is searching for a terminal type that either is the
1791 long entry, appears in the termcap file after the long entry, or
1792 does not appear in the file at all (so that \fBtgetent\fP has to search
1793 the whole termcap file).
1794 .PP
1795 Then \fBtgetent\fP will overwrite memory, perhaps its stack, and probably core dump
1796 the program.
1797 Programs like telnet are particularly vulnerable; modern telnets
1798 pass along values like the terminal type automatically.
1799 The results are almost
1800 as undesirable with a termcap library, like SunOS 4.1.3 and Ultrix 4.4, that
1801 prints warning messages when it reads an overly long termcap entry.
1802 If a
1803 termcap library truncates long entries, like OSF/1 3.0, it is immune to dying
1804 here but will return incorrect data for the terminal.
1805 .PP
1806 The \*(``after tc expansion\*('' length will have a similar effect to the
1807 above, but only for people who actually set TERM to that terminal
1808 type, since \fBtgetent\fP only does \*(``tc\*('' expansion once it is found the
1809 terminal type it was looking for, not while searching.
1810 .PP
1811 In summary, a termcap entry that is longer than 1023 bytes can cause,
1812 on various combinations of termcap libraries and applications, a core
1813 dump, warnings, or incorrect operation.
1814 If it is too long even before
1815 \*(``tc\*('' expansion, it will have this effect even for users of some other
1816 terminal types and users whose TERM variable does not have a termcap
1817 entry.
1818 .PP
1819 When in \-C (translate to termcap) mode, the \fBncurses\fR implementation of
1820 \fB@TIC@\fR(1M) issues warning messages when the pre-tc length of a termcap
1821 translation is too long.
1822 The \-c (check) option also checks resolved (after tc
1823 expansion) lengths.
1824 .SS Binary Compatibility
1825 It is not wise to count on portability of binary terminfo entries between
1826 commercial UNIX versions.
1827 The problem is that there are at least two versions
1828 of terminfo (under HP\-UX and AIX) which diverged from System V terminfo after
1829 SVr1, and have added extension capabilities to the string table that (in the
1830 binary format) collide with System V and XSI Curses extensions.
1832 .PP
1833 Searching for terminal descriptions in
1834 \fB$HOME/.terminfo\fR and TERMINFO_DIRS
1835 is not supported by older implementations.
1836 .PP
1837 Some SVr4 \fBcurses\fR implementations, and all previous to SVr4, do not
1838 interpret the %A and %O operators in parameter strings.
1839 .PP
1840 SVr4/XPG4 do not specify whether \fBmsgr\fR licenses movement while in
1841 an alternate-character-set mode (such modes may, among other things, map
1842 CR and NL to characters that do not trigger local motions).
1843 The \fBncurses\fR implementation ignores \fBmsgr\fR in \fBALTCHARSET\fR
1844 mode.
1845 This raises the possibility that an XPG4
1846 implementation making the opposite interpretation may need terminfo
1847 entries made for \fBncurses\fR to have \fBmsgr\fR turned off.
1848 .PP
1849 The \fBncurses\fR library handles insert-character and insert-character modes
1850 in a slightly non-standard way to get better update efficiency.
1851 See
1852 the \fBInsert/Delete Character\fR subsection above.
1853 .PP
1854 The parameter substitutions for \fBset_clock\fR and \fBdisplay_clock\fR are
1855 not documented in SVr4 or the XSI Curses standard.
1856 They are deduced from the
1857 documentation for the AT&T 505 terminal.
1858 .PP
1859 Be careful assigning the \fBkmous\fR capability.
1860 The \fBncurses\fR library wants to interpret it as \fBKEY_MOUSE\fR,
1861 for use by terminals and emulators like xterm
1862 that can return mouse-tracking information in the keyboard-input stream.
1863 .PP
1864 X/Open Curses does not mention italics.
1865 Portable applications must assume that numeric capabilities are
1866 signed 16-bit values.
1867 This includes the \fIno_color_video\fP (ncv) capability.
1868 The 32768 mask value used for italics with ncv can be confused with
1869 an absent or cancelled ncv.
1870 If italics should work with colors,
1871 then the ncv value must be specified, even if it is zero.
1872 .PP
1873 Different commercial ports of terminfo and curses support different subsets of
1874 the XSI Curses standard and (in some cases) different extension sets.
1875 Here
1876 is a summary, accurate as of October 1995:
1877 .bP
1878 \fBSVR4, Solaris, ncurses\fR \-\-
1879 These support all SVr4 capabilities.
1880 .bP
1881 \fBSGI\fR \-\-
1882 Supports the SVr4 set, adds one undocumented extended string
1883 capability (\fBset_pglen\fR).
1884 .bP
1885 \fBSVr1, Ultrix\fR \-\-
1886 These support a restricted subset of terminfo capabilities.
1887 The booleans end with \fBxon_xoff\fR;
1888 the numerics with \fBwidth_status_line\fR;
1889 and the strings with \fBprtr_non\fR.
1890 .bP
1891 \fBHP/UX\fR \-\-
1892 Supports the SVr1 subset, plus the SVr[234] numerics \fBnum_labels\fR,
1893 \fBlabel_height\fR, \fBlabel_width\fR, plus function keys 11 through 63, plus
1894 \fBplab_norm\fR, \fBlabel_on\fR, and \fBlabel_off\fR, plus some incompatible
1895 extensions in the string table.
1896 .bP
1897 \fBAIX\fR \-\-
1898 Supports the SVr1 subset, plus function keys 11 through 63, plus a number
1899 of incompatible string table extensions.
1900 .bP
1901 \fBOSF\fR \-\-
1902 Supports both the SVr4 set and the AIX extensions.
1903 .SH FILES
1904 .TP 25
1905 \*d/?/*
1906 files containing terminal descriptions
1908 \fB@INFOCMP@\fR(1M),
1909 \fB@TABS@\fR(1),
1910 \fB@TIC@\fR(1M),
1911 \fBcurses\fR(3X),
1912 \fBcurs_color\fR(3X),
1913 \fBcurs_variables\fR(3X),
1914 \fBprintf\fR(3),
1915 \fBterm_variables\fR(3X).
1916 \fBterm\fR(\*n).
1917 \fBuser_caps\fR(5).
1919 Zeyd M. Ben-Halim, Eric S. Raymond, Thomas E. Dickey.
1920 Based on pcurses by Pavel Curtis.