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