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