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