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