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