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