X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fterminfo.tail;h=d3cbbf385fb9ef4caeccde729086a059cd303b71;hp=f7ac493b054940740a6274965270e17a88f102f2;hb=3d46d7e9d3e210417f34acf3b469378558398d07;hpb=952539d2f6aa5a3a29adc54488b0d3b66121c888 diff --git a/man/terminfo.tail b/man/terminfo.tail index f7ac493b..d3cbbf38 100644 --- a/man/terminfo.tail +++ b/man/terminfo.tail @@ -1,7 +1,33 @@ -.\" $Id: terminfo.tail,v 1.67 2013/08/31 12:11:03 tom Exp $ -.\" Beginning of terminfo.tail file -.\" This file is part of ncurses. -.\" See "terminfo.head" for copyright. +.\"*************************************************************************** +.\" Copyright 2018-2020,2021 Thomas E. Dickey * +.\" Copyright 1998-2016,2017 Free Software Foundation, Inc. * +.\" * +.\" Permission is hereby granted, free of charge, to any person obtaining a * +.\" copy of this software and associated documentation files (the * +.\" "Software"), to deal in the Software without restriction, including * +.\" without limitation the rights to use, copy, modify, merge, publish, * +.\" distribute, distribute with modifications, sublicense, and/or sell * +.\" copies of the Software, and to permit persons to whom the Software is * +.\" furnished to do so, subject to the following conditions: * +.\" * +.\" The above copyright notice and this permission notice shall be included * +.\" in all copies or substantial portions of the Software. * +.\" * +.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * +.\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * +.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * +.\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * +.\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * +.\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * +.\" THE USE OR OTHER DEALINGS IN THE SOFTWARE. * +.\" * +.\" Except as contained in this notice, the name(s) of the above copyright * +.\" holders shall not be used in advertising or otherwise to promote the * +.\" sale, use or other dealings in this Software without prior written * +.\" authorization. * +.\"*************************************************************************** +.\" +.\" $Id: terminfo.tail,v 1.108 2021/10/09 23:13:23 tom Exp $ .ps +1 .SS User-Defined Capabilities . @@ -21,7 +47,7 @@ That is, if \fB@TIC@\fP encounters a capability name which it does not recognize, it infers its type (boolean, number or string) from the syntax and makes an extended table entry for that capability. -The \fBuse_extended_names\fP function makes this information +The \fBuse_extended_names\fP(3X) function makes this information conditionally available to applications. The ncurses library provides the data leaving most of the behavior to applications: @@ -113,23 +139,44 @@ ANSI-standard terminals have (i.e., an automatic return and line-feed when the end of a line is reached) is indicated by the capability \fBam\fR. Hence the description of ansi includes \fBam\fR. -Numeric capabilities are followed by the character `#' and then a positive value. +Numeric capabilities are followed by the character \*(``#\*('' and then a positive value. Thus \fBcols\fR, which indicates the number of columns the terminal has, -gives the value `80' for ansi. +gives the value \*(``80\*('' for ansi. Values for numeric capabilities may be specified in decimal, octal or hexadecimal, using the C programming language conventions (e.g., 255, 0377 and 0xff or 0xFF). .PP Finally, string valued capabilities, such as \fBel\fR (clear to end of line -sequence) are given by the two-character code, an `=', and then a string -ending at the next following `,'. +sequence) are given by the two-character code, an \*(``=\*('', and then a string +ending at the next following \*(``,\*(''. .PP A number of escape sequences are provided in the string valued capabilities -for easy encoding of characters there. +for easy encoding of characters there: +.bP Both \fB\eE\fR and \fB\ee\fR map to an \s-1ESCAPE\s0 character, -\fB^x\fR maps to a control-x for any appropriate x, and the sequences -\fB\en \el \er \et \eb \ef \es\fR give -a newline, line-feed, return, tab, backspace, form-feed, and space. +.bP +\fB^x\fR maps to a control-x for any appropriate \fIx\fP, and +.bP +the sequences +.RS 6 +.PP +\fB\en\fP, \fB\el\fP, \fB\er\fP, \fB\et\fP, \fB\eb\fP, \fB\ef\fP, and \fB\es\fR +.RE +.IP +produce +.RS 6 +.PP +\fInewline\fP, \fIline-feed\fP, \fIreturn\fP, \fItab\fP, \fIbackspace\fP, \fIform-feed\fP, and \fIspace\fP, +.RE +.IP +respectively. +.PP +X/Open Curses does not say what \*(``appropriate \fIx\fP\*('' might be. +In practice, that is a printable ASCII graphic character. +The special case \*(``^?\*('' is interpreted as DEL (127). +In all other cases, the character value is AND'd with 0x1f, +mapping to ASCII control codes in the range 0 through 31. +.PP Other escapes include .bP \fB\e^\fR for \fB^\fR, @@ -144,33 +191,36 @@ and \fB\e0\fR for null. .IP \fB\e0\fR will produce \e200, which does not terminate a string but behaves as a null character on most terminals, providing CS7 is specified. -See stty(1). +See \fBstty\fP(1). .IP The reason for this quirk is to maintain binary compatibility of the compiled terminfo files with other implementations, e.g., the SVr4 systems, which document this. Compiled terminfo files use null-terminated strings, with no lengths. -Modifying this would require a new binary format, +Modifying this would require a new binary format, which would not work with other implementations. .PP Finally, characters may be given as three octal digits after a \fB\e\fR. .PP A delay in milliseconds may appear anywhere in a string capability, enclosed in -$<..> brackets, as in \fBel\fP=\eEK$<5>, and padding characters are supplied by -.I tputs +$<..> brackets, as in \fBel\fP=\eEK$<5>, +and padding characters are supplied by \fBtputs\fP(3X) to provide this delay. +.bP The delay must be a number with at most one decimal -place of precision; it may be followed by suffixes `*' or '/' or both. -A `*' +place of precision; it may be followed by suffixes \*(``*\*('' or \*(``/\*('' or both. +.bP +A \*(``*\*('' indicates that the padding required is proportional to the number of lines affected by the operation, and the amount given is the per-affected-unit padding required. (In the case of insert character, the factor is still the -number of -.IR lines -affected.) Normally, padding is advisory if the device has the \fBxon\fR +number of \fIlines\fP affected.) +.IP +Normally, padding is advisory if the device has the \fBxon\fR capability; it is used for cost computation but does not trigger delays. -A `/' +.bP +A \*(``/\*('' suffix indicates that the padding is mandatory and forces a delay of the given number of milliseconds even on devices for which \fBxon\fR is present to indicate flow control. @@ -205,7 +255,7 @@ Next, if the environment variable TERMINFO_DIRS is set, as a list of colon-separated directories (or database files) to be searched. .IP An empty directory name (i.e., if the variable begins or ends -with a colon, or contains adacent colons) +with a colon, or contains adjacent colons) is interpreted as the system location \fI\*d\fR. .bP Finally, \fBncurses\fP searches these compiled-in locations: @@ -233,7 +283,7 @@ or bugs in the screen-handling code of the test program. .PP To get the padding for insert line right (if the terminal manufacturer did not document it) a severe test is to edit a large file at 9600 baud, -delete 16 or so lines from the middle of the screen, then hit the `u' +delete 16 or so lines from the middle of the screen, then hit the \*(``u\*('' key several times quickly. If the terminal messes up, more padding is usually needed. A similar test can be used for insert character. @@ -262,7 +312,7 @@ series, as well as hard copy and APL terminals.) If there is a code to move the cursor to the left edge of the current row, give this as .BR cr . -(Normally this will be carriage return, control M.) +(Normally this will be carriage return, control/M.) If there is a code to produce an audible signal (bell, beep, etc) give this as .BR bel . @@ -277,7 +327,7 @@ given as and .BR cud1 . These local cursor motions should not alter the text they pass over, -for example, you would not normally use `\fBcuf1\fP=\ ' because the +for example, you would not normally use \*(``\fBcuf1\fP=\ \*('' because the space would erase the character moved over. .PP A very important point here is that the local cursor motions encoded @@ -346,7 +396,7 @@ it may still be possible to craft a working .B nel out of one or both of them. .PP -These capabilities suffice to describe hard-copy and \*(lqglass-tty\*(rq terminals. +These capabilities suffice to describe hard-copy and \*(``glass-tty\*('' terminals. Thus the model 33 teletype is described as .PP .DT @@ -376,9 +426,8 @@ while the Lear Siegler \s-1ADM-3\s0 is described as .PP Cursor addressing and other strings requiring parameters in the terminal are described by a -parameterized string capability, with -.IR printf (3) -like escapes \fB%x\fR in it. +parameterized string capability, +with \fIprintf\fP-like escapes such as \fI%x\fR in it. For example, to address the cursor, the .B cup capability is given, using two parameters: @@ -393,86 +442,116 @@ The parameter mechanism uses a stack and special \fB%\fP codes to manipulate it. Typically a sequence will push one of the parameters onto the stack and then print it in some format. -Print (e.g., "%d") is a special case. -Other operations, including "%t" pop their operand from the stack. +Print (e.g., \*(``%d\*('') is a special case. +Other operations, including \*(``%t\*('' pop their operand from the stack. It is noted that more complex operations are often necessary, e.g., in the \fBsgr\fP string. .PP The \fB%\fR encodings have the following meanings: .PP .TP 5 -\s-1%% -outputs `%' +\fB%%\fP +outputs \*(``%\*('' .TP -%\fI[[\fP:\fI]flags][width[.precision]][\fPdoxXs\fI]\fP -as in \fBprintf\fP, flags are [\-+#] and space. -Use a `:' to allow the next character to be a `\-' flag, -avoiding interpreting "%\-" as an operator. +\fB%\fP\fI[[\fP:\fI]flags][width[.precision]][\fP\fBdoxXs\fP\fI]\fP +as in \fBprintf\fP(3), flags are \fI[\-+#]\fP and \fIspace\fP. +Use a \*(``:\*('' to allow the next character to be a \*(``\-\*('' flag, +avoiding interpreting \*(``%\-\*('' as an operator. .TP -%c -print pop() like %c in \fBprintf\fP +\f(CW%c\fP +print \fIpop()\fP like %c in \fBprintf\fP .TP -%s -print pop() like %s in \fBprintf\fP +\fB%s\fP +print \fIpop()\fP like %s in \fBprintf\fP .TP -%p[1\-9] +\fB%p\fP\fI[1\-9]\fP push \fIi\fP'th parameter .TP -%P[a\-z] -set dynamic variable [a\-z] to pop() +\fB%P\fP\fI[a\-z]\fP +set dynamic variable \fI[a\-z]\fP to \fIpop()\fP .TP -%g[a\-z] -get dynamic variable [a\-z] and push it +\fB%g\fP\fI[a\-z]/\fP +get dynamic variable \fI[a\-z]\fP and push it .TP -%P[A\-Z] -set static variable [a\-z] to pop() +\fB%P\fP\fI[A\-Z]\fP +set static variable \fI[a\-z]\fP to \fIpop()\fP .TP -%g[A\-Z] -get static variable [a\-z] and push it +\fB%g\fP\fI[A\-Z]\fP +get static variable \fI[a\-z]\fP and push it .IP -The terms "static" and "dynamic" are misleading. +The terms \*(``static\*('' and \*(``dynamic\*('' are misleading. Historically, these are simply two different sets of variables, -whose values are not reset between calls to \fBtparm\fP. +whose values are not reset between calls to \fBtparm\fP(3X). However, that fact is not documented in other implementations. -Relying on it will adversely impact portability to other implementations. +Relying on it will adversely impact portability to other implementations: +.RS +.bP +SVr2 curses supported \fIdynamic\fP variables. +Those are set only by a \fB%P\fP operator. +A \fB%g\fP for a given variable without first setting it with \fB%P\fP +will give unpredictable results, because dynamic variables are +an uninitialized local array on the stack in the \fBtparm\fP function. +.bP +SVr3.2 curses supported \fIstatic\fP variables. +Those are an array in the \fBTERMINAL\fP +structure (declared in \fBterm.h\fP), +and are zeroed automatically when the \fBsetupterm\fP function +allocates the data. +.bP +SVr4 curses made no further improvements +to the \fIdynamic/static\fP variable feature. +.bP +Solaris XPG4 curses does not distinguish between \fIdynamic\fP and +\fIstatic\fP variables. +They are the same. +Like SVr4 curses, XPG4 curses does not initialize these explicitly. +.bP +Before version 6.3, ncurses stores both \fIdynamic\fP and \fIstatic\fP +variables in persistent storage, initialized to zeros. +.bP +Beginning with version 6.3, ncurses stores \fIstatic\fP and \fIdynamic\fP +variables in the same manner as SVr4. +Unlike other implementations, ncurses zeros dynamic variables +before the first \fB%g\fP or \fB%P\fP operator. +.RE .TP -%'\fIc\fP' +\fB%\(aq\fP\fIc\fP\fB\(aq\fP char constant \fIc\fP .TP -%{\fInn\fP} +\fB%{\fP\fInn\fP\fB}\fP integer constant \fInn\fP .TP -%l +\fB%l\fP push strlen(pop) .TP -%+ %\- %* %/ %m -arithmetic (%m is mod): push(pop() op pop()) +\fB%+\fP, \fB%\-\fP, \fB%*\fP, \fB%/\fP, \fB%m\fP +arithmetic (%m is \fImod\fP): \fIpush(pop() op pop())\fP .TP -%& %| %^ -bit operations (AND, OR and exclusive-OR): push(pop() op pop()) +\fB%&\fP, \fB%|\fP, \fB%^\fP +bit operations (AND, OR and exclusive-OR): \fIpush(pop() op pop())\fP .TP -%= %> %< -logical operations: push(pop() op pop()) +\fB%=\fP, \fB%>\fP, \fB%<\fP +logical operations: \fIpush(pop() op pop())\fP .TP -%A, %O +\fB%A\fP, \fB%O\fP logical AND and OR operations (for conditionals) .TP -%! %~ -unary operations (logical and bit complement): push(op pop()) +\fB%!\fP, \fB%~\fP +unary operations (logical and bit complement): \fIpush(op pop())\fP .TP -%i +\fB%i\fP add 1 to first two parameters (for ANSI terminals) .TP -%? \fIexpr\fP %t \fIthenpart\fP %e \fIelsepart\fP %; +\fB%?\fP \fIexpr\fP \fB%t\fP \fIthenpart\fP \fB%e\fP \fIelsepart\fP \fB%;\fP This forms an if-then-else. -The %e \fIelsepart\fP is optional. -Usually the %? \fIexpr\fP part pushes a value onto the stack, -and %t pops it from the stack, testing if it is nonzero (true). -If it is zero (false), control passes to the %e (else) part. +The \fB%e\fP \fIelsepart\fP is optional. +Usually the \fB%?\fP \fIexpr\fP part pushes a value onto the stack, +and \fB%t\fP pops it from the stack, testing if it is nonzero (true). +If it is zero (false), control passes to the \fB%e\fP (else) part. .IP It is possible to form else-if's a la Algol 68: .RS -%? c\d1\u %t b\d1\u %e c\d2\u %t b\d2\u %e c\d3\u %t b\d3\u %e c\d4\u %t b\d4\u %e %; +\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 .RE .IP where c\di\u are conditions, b\di\u are bodies. @@ -484,8 +563,8 @@ on one line. The \fB\-f\fP option splits the string into lines with the parts indented. .PP Binary operations are in postfix form with the operands in the usual order. -That is, to get x\-5 one would use "%gx%{5}%-". -%P and %g variables are +That is, to get x\-5 one would use \*(``%gx%{5}%\-\*(''. +\fB%P\fP and \fB%g\fP variables are persistent across escape-string evaluations. .PP Consider the HP2645, which, to get to row 3 and column 12, needs @@ -493,12 +572,12 @@ to be sent \eE&a12c03Y padded for 6 milliseconds. Note that the order of the rows and columns is inverted here, and that the row and column are printed as two digits. -Thus its \fBcup\fR capability is \*(lqcup=6\eE&%p2%2dc%p1%2dY\*(rq. +Thus its \fBcup\fR capability is \*(``cup=6\eE&%p2%2dc%p1%2dY\*(''. .PP The Microterm \s-1ACT-IV\s0 needs the current row and column sent preceded by a \fB^T\fR, with the row and column simply encoded in binary, -\*(lqcup=^T%p1%c%p2%c\*(rq. -Terminals which use \*(lq%c\*(rq need to be able to +\*(``cup=^T%p1%c%p2%c\*(''. +Terminals which use \*(``%c\*('' need to be able to backspace the cursor (\fBcub1\fR), and to move the cursor up one line on the screen (\fBcuu1\fR). This is necessary because it is not always safe to transmit \fB\en\fR @@ -508,8 +587,8 @@ tabs are never expanded, so \et is safe to send. This turns out to be essential for the Ann Arbor 4080.) .PP A final example is the \s-1LSI ADM\s0-3a, which uses row and column -offset by a blank character, thus \*(lqcup=\eE=%p1%' '%+%c%p2%' '%+%c\*(rq. -After sending `\eE=', this pushes the first parameter, pushes the +offset by a blank character, thus \*(``cup=\eE=%p1%\(aq \(aq%+%c%p2%\(aq \(aq%+%c\*(''. +After sending \*(``\eE=\*('', this pushes the first parameter, pushes the ASCII value for a space (32), adds them (pushing the sum on the stack in place of the two previous values) and outputs that value as a character. Then the same is done for the second parameter. @@ -546,7 +625,7 @@ spaces to the right) these can be given as .BR cub , .BR cuf , and -.BR cuu +.B cuu with a single parameter indicating how many spaces to move. These are primarily useful if the terminal does not have .BR cup , @@ -568,6 +647,131 @@ If the \fBsmcup\fP sequence will not restore the screen after an \fBrmcup\fP sequence is output (to the state prior to outputting \fBrmcup\fP), specify \fBnrrmc\fP. .PP +.SS Margins +SVr4 (and X/Open Curses) +list several string capabilities for setting margins. +Two were intended for use with terminals, +and another six were intended for use with printers. +.bP +The two terminal capabilities assume that the terminal may have +the capability of setting the left and/or right margin at the current +cursor column position. +.bP +The printer capabilities assume that the printer may have +two types of capability: +.RS +.bP +the ability to set a top and/or bottom margin using the current +line position, and +.bP +parameterized capabilities for setting the top, bottom, left, right margins +given the number of rows or columns. +.RE +.RE +.PP +In practice, the categorization into \*(``terminal\*('' and \*(``printer\*('' +is not suitable: +.bP +The AT&T SVr4 terminal database uses \fBsmgl\fP four times, +for AT&T hardware. +.IP +Three of the four are printers. +They lack the ability to set left/right margins by specifying the column. +.bP +Other (non-AT&T) terminals may support margins +but using different assumptions from AT&T. +.IP +For instance, the DEC VT420 supports left/right margins, +but only using a column parameter. +As an added complication, the VT420 uses two settings to fully enable +left/right margins (left/right margin mode, and origin mode). +The former enables the margins, which causes printed text +to wrap within margins, but the latter is needed to prevent +cursor-addressing outside those margins. +.bP +Both DEC VT420 left/right margins are set with a single control sequence. +If either is omitted, the corresponding margin is set to the left or +right edge of the display (rather than leaving the margin unmodified). +.PP +These are the margin-related capabilities: +.TS +center; +l l +_ _ +lw8 lw18. +\fBName Description\fP +smgl Set left margin at current column +smgr Set right margin at current column +smgb Set bottom margin at current line +smgt Set top margin at current line +smgbp Set bottom margin at line \fIN\fP +smglp Set left margin at column \fIN\fP +smgrp Set right margin at column \fIN\fP +smgtp Set top margin at line \fIN\fP +smglr Set both left and right margins to \fIL\fP and \fIR\fP +smgtb Set both top and bottom margins to \fIT\fP and \fIB\fP +.TE +.PP +When writing an application that +uses these string capabilities, +the pairs should be first checked to see +if each capability in the pair is set or only one is set: +.bP +If both \fBsmglp\fP and \fBsmgrp\fP are set, +each is used with a single argument, \fIN\fP, +that gives the column number of the left and right margin, respectively. +.bP +If both \fBsmgtp\fP and \fBsmgbp\fP are set, +each is used to set the top and bottom margin, +respectively: +.RS 4 +.bP +\fBsmgtp\fP is used with a single argument, \fIN\fP, +the line number of the top margin. +.bP +\fBsmgbp\fP is used with two arguments, \fIN\fP and \fIM\fP, +that give the line number of the bottom margin, +the first counting from the top of the +page and the second counting from the bottom. +This accommodates the two styles of specifying +the bottom margin in different manufacturers' printers. +.RE +.IP +When designing a terminfo entry for a +printer that has a settable bottom margin, +only the first or second argument should be used, depending on the printer. +When developing an application that uses \fBsmgbp\fP to set the bottom margin, +both arguments must be given. +.PP +Conversely, when only one capability in the pair is set: +.bP +If only one of \fBsmglp\fP and \fBsmgrp\fP is set, +then it is used with two arguments, +the column number of the left and right margins, in that order. +.bP +Likewise, if only one of \fBsmgtp\fP and \fBsmgbp\fP is set, then it +is used with two arguments that give the top and bottom margins, +in that order, counting from the top of the page. +.IP +When designing a terminfo entry for a printer that requires setting both +left and right or top and bottom margins simultaneously, +only one capability in the pairs +\fBsmglp\fP and \fBsmgrp\fP or +\fBsmgtp\fP and \fBsmgbp\fP should be defined, +leaving the other unset. +.PP +Except for very old terminal descriptions, e.g., those developed for SVr4, +the scheme just described should be considered obsolete. +An improved set of capabilities was added late in the SVr4 releases +(\fBsmglr\fP and \fBsmgtb\fP), +which explicitly use two parameters for setting the left/right or top/bottom +margins. +.PP +When setting margins, the line- and column-values are zero-based. +.PP +The \fBmgc\fP string capability should be defined. +Applications such as \fBtabs\fP(1) rely upon this to reset all margins. +.\" .SS Area Clears .PP If the terminal can clear from the current position to the end of the @@ -583,6 +787,7 @@ if a true .B ed is not available.) .PP +.\" .SS Insert/delete line and vertical motions .PP If the terminal can open a new blank line before the line where the cursor @@ -646,7 +851,7 @@ System V and XSI Curses expect that \fBind\fR, \fBri\fR, \fBindn\fR, and \fBrin\fR will simulate destructive scrolling; their documentation cautions you not to define \fBcsr\fR unless this is true. This \fBcurses\fR implementation is more liberal and will do explicit erases -after scrolling if \fBndstr\fR is defined. +after scrolling if \fBndsrc\fR is defined. .PP If the terminal has the ability to define a window as part of memory, which all commands affect, @@ -677,18 +882,18 @@ either eliminated, or expanded to two untyped blanks. You can determine the kind of terminal you have by clearing the screen and then typing text separated by cursor motions. -Type \*(lqabc\ \ \ \ def\*(rq using local -cursor motions (not spaces) between the \*(lqabc\*(rq and the \*(lqdef\*(rq. -Then position the cursor before the \*(lqabc\*(rq and put the terminal in insert +Type \*(``abc\ \ \ \ def\*('' using local +cursor motions (not spaces) between the \*(``abc\*('' and the \*(``def\*(''. +Then position the cursor before the \*(``abc\*('' and put the terminal in insert mode. If typing characters causes the rest of the line to shift rigidly and characters to fall off the end, then your terminal does not distinguish between blanks and untyped positions. -If the \*(lqabc\*(rq -shifts over to the \*(lqdef\*(rq which then move together around the end of the +If the \*(``abc\*('' +shifts over to the \*(``def\*('' which then move together around the end of the current line and onto the next as you insert, you have the second type of terminal, and should give the capability \fBin\fR, which stands for -\*(lqinsert null\*(rq. +\*(``insert null\*(''. .PP While these are two logically separate attributes (one line versus multi-line insert mode, and special treatment of untyped spaces) we have seen no @@ -724,7 +929,7 @@ If post insert padding is needed, give this as a number of milliseconds in \fBip\fR (a string option). Any other sequence which may need to be sent after an insert of a single character may also be given in \fBip\fR. -If your terminal needs both to be placed into an `insert mode' and +If your terminal needs both to be placed into an \*(``insert mode\*('' and a special code to precede each inserted character, then both .BR smir / rmir and @@ -936,7 +1141,7 @@ give this sequence as If there is a way to make the cursor completely invisible, give that as .BR civis . The capability -.BR cnorm +.B cnorm should be given which undoes the effects of both of these modes. .PP If your terminal correctly generates underlined characters @@ -1059,13 +1264,17 @@ sequences to make sure that the change becomes visible. .PP .SS Tabs and Initialization .PP +A few capabilities are used only for tabs: +.bP If the terminal has hardware tabs, the command to advance to the next tab stop can be given as .B ht -(usually control I). +(usually control/I). +.bP A \*(``back-tab\*('' command which moves leftward to the preceding tab stop can be given as .BR cbt . +.IP By convention, if the teletype modes indicate that tabs are being expanded by the computer rather than being sent to the terminal, programs should not use @@ -1074,14 +1283,15 @@ or .B cbt even if they are present, since the user may not have the tab stops properly set. +.bP If the terminal has hardware tabs which are initially set every .I n spaces when the terminal is powered up, the numeric parameter .B it is given, showing the number of spaces the tabs are set to. -This is normally used by the -.IR @TSET@ +.IP +The \fBit\fP capability is normally used by the \fB@TSET@\fP command to determine whether to set the mode for hardware tab expansion, and whether to set the tab stops. If the terminal has tab stops that can be saved in non-volatile memory, @@ -1089,48 +1299,52 @@ the terminfo description can assume that they are properly set. .PP Other capabilities include +.bP .BR is1 , .BR is2 , and .BR is3 , initialization strings for the terminal, +.bP .BR iprog , the path name of a program to be run to initialize the terminal, +.bP and \fBif\fR, the name of a file containing long initialization strings. +.PP These strings are expected to set the terminal into modes consistent with the rest of the terminfo description. They are normally sent to the terminal, by the .I init -option of the -.IR @TPUT@ -program, each time the user logs in. +option of the \fB@TPUT@\fP program, each time the user logs in. They will be printed in the following order: .RS .TP run the program -.BR iprog +.B iprog .TP output -.BR is1 -.BR is2 +.br +\fBis1\fP and +.br +\fBis2\fP .TP set the margins using -.BR mgc , -.BR smgl -and -.BR smgr +\fBmgc\fP or +.br +\fBsmglp\fP and \fBsmgrp\fP or +.br +\fBsmgl\fP and \fBsmgr\fP .TP set tabs using .B tbc and -.BR hts +.B hts .TP print the file -.BR if +\fBif\fP .TP -and finally -output -.BR is3 . +and finally output +\fBis3\fP. .RE .PP Most initialization is done with @@ -1147,7 +1361,7 @@ A set of sequences that does a harder reset from a totally unknown state can be given as .BR rs1 , .BR rs2 , -.BR rf +.B rf and .BR rs3 , analogous to @@ -1155,14 +1369,16 @@ analogous to .B is2 , .B if and -.BR is3 +.B is3 respectively. -These strings are output by the -.IR reset -program, which is used when the terminal gets into a wedged state. +These strings are output +by \fIreset\fP option of \fB@TPUT@\fP, +or by the \fB@RESET@\fP program +(an alias of \fB@TSET@\fP), +which is used when the terminal gets into a wedged state. Commands are normally placed in .BR rs1 , -.BR rs2 +.B rs2 .B rs3 and .B rf @@ -1172,16 +1388,13 @@ For example, the command to set the vt100 into 80-column mode would normally be part of .BR is2 , but it causes an annoying glitch of the screen and is not normally -needed since the terminal is usually already in 80 column mode. +needed since the terminal is usually already in 80-column mode. .PP -The -.IR reset -program writes strings -including +The \fB@RESET@\fP program writes strings including .BR iprog , etc., in the same order as the -.IR init -program, using +.I init +program, using .BR rs1 , etc., instead of .BR is1 , @@ -1191,10 +1404,10 @@ If any of .BR rs2 , .BR rs3 , or -.BR rf -reset capability strings are missing, the -.IR reset -program falls back upon the corresponding initialization capability string. +.B rf +reset capability strings are missing, +the \fB@RESET@\fP program +falls back upon the corresponding initialization capability string. .PP If there are commands to set and clear tab stops, they can be given as .B tbc @@ -1207,6 +1420,33 @@ described by this, the sequence can be placed in .B is2 or .BR if . +.PP +The \fB@TPUT@ reset\fP command uses the same capability strings +as the \fB@RESET@\fP command, +although the two programs (\fB@TPUT@\fP and \fB@RESET@\fP) +provide different command-line options. +.PP +In practice, these terminfo capabilities are not often used in +initialization of tabs +(though they are required for the \fB@TABS@\fP program): +.bP +Almost all hardware terminals (at least those which supported tabs) +initialized those to every \fIeight\fP columns: +.IP +The only exception was the AT&T 2300 series, +which set tabs to every \fIfive\fP columns. +.bP +In particular, developers of the hardware terminals which are commonly used +as models for modern terminal emulators provided documentation demonstrating +that \fIeight\fP columns were the standard. +.bP +Because of this, the terminal initialization programs +\fB@TPUT@\fP and \fB@TSET@\fP +use the +\fBtbc\fP (\fBclear_all_tabs\fP) and +\fBhts\fP (\fBset_tab\fP) capabilities directly +only when the \fBit\fP (\fBinit_tabs\fP) capability +is set to a value other than \fIeight\fP. .SS Delays and Padding .PP Many older and slower terminals do not support either XON/XOFF or DTR @@ -1238,7 +1478,7 @@ Only the first character of the string is used. .PP .SS Status Lines -Some terminals have an extra `status line' which is not normally used by +Some terminals have an extra \*(``status line\*('' which is not normally used by software (and thus not counted in the terminal's \fBlines\fR capability). .PP The simplest case is a status line which is cursor-addressable but not @@ -1275,52 +1515,74 @@ They are documented here in case they ever become important. .SS Line Graphics .PP Many terminals have alternate character sets useful for forms-drawing. -Terminfo and \fBcurses\fR build in support for the drawing characters +Terminfo and \fBcurses\fR have built-in support +for most of the drawing characters supported by the VT100, with some characters from the AT&T 4410v1 added. This alternate character set may be specified by the \fBacsc\fR capability. .PP .TS H center expand; -l l l l -l l l l -lw25 lw10 lw6 lw6. +l l l l l +l l l l l +_ _ _ _ _ +lw25 lw10 lw6 lw6 lw6. .\".TH -\fBGlyph ACS Ascii VT100\fR -\fBName Name Default Name\fR -UK pound sign ACS_STERLING f } -arrow pointing down ACS_DARROW v . -arrow pointing left ACS_LARROW < , -arrow pointing right ACS_RARROW > + -arrow pointing up ACS_UARROW ^ \- -board of squares ACS_BOARD # h -bullet ACS_BULLET o ~ -checker board (stipple) ACS_CKBOARD : a -degree symbol ACS_DEGREE \e f -diamond ACS_DIAMOND + ` -greater-than-or-equal-to ACS_GEQUAL > z -greek pi ACS_PI * { -horizontal line ACS_HLINE \- q -lantern symbol ACS_LANTERN # i -large plus or crossover ACS_PLUS + n -less-than-or-equal-to ACS_LEQUAL < y -lower left corner ACS_LLCORNER + m -lower right corner ACS_LRCORNER + j -not-equal ACS_NEQUAL ! | -plus/minus ACS_PLMINUS # g -scan line 1 ACS_S1 ~ o -scan line 3 ACS_S3 \- p -scan line 7 ACS_S7 \- r -scan line 9 ACS_S9 \&_ s -solid square block ACS_BLOCK # 0 -tee pointing down ACS_TTEE + w -tee pointing left ACS_RTEE + u -tee pointing right ACS_LTEE + t -tee pointing up ACS_BTEE + v -upper left corner ACS_ULCORNER + l -upper right corner ACS_URCORNER + k -vertical line ACS_VLINE | x +\fBGlyph ACS Ascii acsc acsc\fR +\fBName Name Default Char Value\fR +arrow pointing right ACS_RARROW > + 0x2b +arrow pointing left ACS_LARROW < , 0x2c +arrow pointing up ACS_UARROW ^ \- 0x2d +arrow pointing down ACS_DARROW v . 0x2e +solid square block ACS_BLOCK # 0 0x30 +diamond ACS_DIAMOND + ` 0x60 +checker board (stipple) ACS_CKBOARD : a 0x61 +degree symbol ACS_DEGREE \e f 0x66 +plus/minus ACS_PLMINUS # g 0x67 +board of squares ACS_BOARD # h 0x68 +lantern symbol ACS_LANTERN # i 0x69 +lower right corner ACS_LRCORNER + j 0x6a +upper right corner ACS_URCORNER + k 0x6b +upper left corner ACS_ULCORNER + l 0x6c +lower left corner ACS_LLCORNER + m 0x6d +large plus or crossover ACS_PLUS + n 0x6e +scan line 1 ACS_S1 ~ o 0x6f +scan line 3 ACS_S3 \- p 0x70 +horizontal line ACS_HLINE \- q 0x71 +scan line 7 ACS_S7 \- r 0x72 +scan line 9 ACS_S9 \&_ s 0x73 +tee pointing right ACS_LTEE + t 0x74 +tee pointing left ACS_RTEE + u 0x75 +tee pointing up ACS_BTEE + v 0x76 +tee pointing down ACS_TTEE + w 0x77 +vertical line ACS_VLINE | x 0x78 +less-than-or-equal-to ACS_LEQUAL < y 0x79 +greater-than-or-equal-to ACS_GEQUAL > z 0x7a +greek pi ACS_PI * { 0x7b +not-equal ACS_NEQUAL ! | 0x7c +UK pound sign ACS_STERLING f } 0x7d +bullet ACS_BULLET o ~ 0x7e .TE .PP +A few notes apply to the table itself: +.bP +X/Open Curses incorrectly states that the mapping for \fIlantern\fP is +uppercase \*(``I\*('' although Unix implementations use the +lowercase \*(``i\*('' mapping. +.bP +The DEC VT100 implemented graphics using the alternate character set +feature, temporarily switching \fImodes\fP and sending characters +in the range 0x60 (96) to 0x7e (126) +(the \fBacsc Value\fP column in the table). +.bP +The AT&T terminal added graphics characters outside that range. +.IP +Some of the characters within the range do not match the VT100; +presumably they were used in the AT&T terminal: +\fIboard of squares\fP replaces the VT100 \fInewline\fP symbol, while +\fIlantern symbol\fP replaces the VT100 \fIvertical tab\fP symbol. +The other VT100 symbols for control characters (\fIhorizontal tab\fP, +\fIcarriage return\fP and \fIline-feed\fP) are not (re)used in curses. +.PP The best way to define a new device's graphics set is to add a column to a copy of this table for your terminal, giving the character which (when emitted between \fBsmacs\fR/\fBrmacs\fR switches) will be rendered @@ -1330,16 +1592,24 @@ character pairs right to left in sequence; these become the ACSC string. .PP .SS Color Handling .PP -Most color terminals are either `Tektronix-like' or `HP-like'. +The curses library functions \fBinit_pair\fP and \fBinit_color\fP +manipulate the \fIcolor pairs\fP and \fIcolor values\fP discussed in this +section +(see \fBcurs_color\fP(3X) for details on these and related functions). +.PP +Most color terminals are either \*(``Tektronix-like\*('' or \*(``HP-like\*('': +.bP Tektronix-like -terminals have a predefined set of N colors (where N usually 8), and can set +terminals have a predefined set of \fIN\fP colors +(where \fIN\fP is usually 8), +and can set character-cell foreground and background characters independently, mixing them -into N\ *\ N color-pairs. -On HP-like terminals, the use must set each color +into \fIN\fP\ *\ \fIN\fP color-pairs. +.bP +On HP-like terminals, the user must set each color pair up separately (foreground and background are not independently settable). -Up to M color-pairs may be set up from 2*M different colors. -ANSI-compatible -terminals are Tektronix-like. +Up to \fIM\fP color-pairs may be set up from 2*\fIM\fP different colors. +ANSI-compatible terminals are Tektronix-like. .PP Some basic color capabilities are independent of the color method. The numeric @@ -1355,6 +1625,11 @@ terminal emulators) erase screen areas with the current background color rather than the power-up default background; these should have the boolean capability \fBbce\fR. .PP +While the curses library works with \fIcolor pairs\fP +(reflecting the inability of some devices to set foreground +and background colors independently), +there are separate capabilities for setting these features: +.bP To change the current foreground or background color on a Tektronix-type terminal, use \fBsetaf\fR (set ANSI foreground) and \fBsetab\fR (set ANSI background) or \fBsetf\fR (set foreground) and \fBsetb\fR (set background). @@ -1363,12 +1638,12 @@ The SVr4 documentation describes only \fBsetaf\fR/\fBsetab\fR; the XPG4 draft says that "If the terminal supports ANSI escape sequences to set background and foreground, they should be coded as \fBsetaf\fR and \fBsetab\fR, respectively. +.bP If the terminal supports other escape sequences to set background and foreground, they should be coded as \fBsetf\fR and \fBsetb\fR, respectively. -The \fIvidputs()\fR -function and the refresh functions use \fBsetaf\fR and \fBsetab\fR if they are -defined." +The \fBvidputs\fR and the \fBrefresh\fP(3X) functions +use the \fBsetaf\fR and \fBsetab\fR capabilities if they are defined. .PP The \fBsetaf\fR/\fBsetab\fR and \fBsetf\fR/\fBsetb\fR capabilities take a single numeric argument each. @@ -1417,6 +1692,8 @@ otherwise red/blue will be interchanged on the display. On an HP-like terminal, use \fBscp\fR with a color-pair number parameter to set which color pair is current. .PP +Some terminals allow the \fIcolor values\fP to be modified: +.bP On a Tektronix-like terminal, the capability \fBccc\fR may be present to indicate that colors can be modified. If so, the \fBinitc\fR capability will @@ -1428,7 +1705,7 @@ If the boolean capability \fBhls\fR is present, they are instead as HLS (Hue, Lightness, Saturation) indices. The ranges are terminal-dependent. -.PP +.bP On an HP-like terminal, \fBinitp\fR may give a capability for changing a color-pair value. It will take seven parameters; a color-pair number (0 to @@ -1496,7 +1773,7 @@ and This is primarily useful for superscripts and subscripts on hard-copy terminals. If a hard-copy terminal can eject to the next page (form feed), give this as .B ff -(usually control L). +(usually control/L). .PP If there is a command to repeat a given character a given number of times (to save time transmitting a large number of identical characters) @@ -1504,7 +1781,7 @@ this can be indicated with the parameterized string .BR rep . The first parameter is the character to be repeated and the second is the number of times to repeat it. -Thus, tparm(repeat_char, 'x', 10) is the same as `xxxxxxxxxx'. +Thus, tparm(repeat_char, \(aqx\(aq, 10) is the same as \*(``xxxxxxxxxx\*(''. .PP If the terminal has a settable command character, such as the \s-1TEKTRONIX\s+1 4025, this can be indicated with @@ -1585,7 +1862,7 @@ is in effect. .PP .SS Glitches and Braindamage .PP -Hazeltine terminals, which do not allow `~' characters to be displayed should +Hazeltine terminals, which do not allow \*(``~\*('' characters to be displayed should indicate \fBhz\fR. .PP Terminals which ignore a line-feed immediately after an \fBam\fR wrap, @@ -1600,7 +1877,7 @@ is required to get rid of standout .PP Teleray terminals, where tabs turn all characters moved over to blanks, should indicate \fBxt\fR (destructive tabs). -Note: the variable indicating this is now `dest_tabs_magic_smso'; in +Note: the variable indicating this is now \*(``dest_tabs_magic_smso\*(''; in older versions, it was teleray_glitch. This glitch is also taken to mean that it is not possible to position the cursor on top of a \*(``magic cookie\*('', @@ -1609,46 +1886,16 @@ delete and insert line. The ncurses implementation ignores this glitch. .PP The Beehive Superbee, which is unable to correctly transmit the escape -or control C characters, has +or control/C characters, has .BR xsb , -indicating that the f1 key is used for escape and f2 for control C. +indicating that the f1 key is used for escape and f2 for control/C. (Only certain Superbees have this problem, depending on the ROM.) Note that in older terminfo versions, this capability was called -`beehive_glitch'; it is now `no_esc_ctl_c'. +\*(``beehive_glitch\*(''; it is now \*(``no_esc_ctl_c\*(''. .PP Other specific terminal problems may be corrected by adding more capabilities of the form \fBx\fR\fIx\fR. .PP -.SS Similar Terminals -.PP -If there are two very similar terminals, one (the variant) can be defined as -being just like the other (the base) with certain exceptions. -In the -definition of the variant, the string capability \fBuse\fR can be given with -the name of the base terminal. -The capabilities given before -.B use -override those in the base type named by -.BR use . -If there are multiple \fBuse\fR capabilities, they are merged in reverse order. -That is, the rightmost \fBuse\fR reference is processed first, then the one to -its left, and so forth. -Capabilities given explicitly in the entry override -those brought in by \fBuse\fR references. -.PP -A capability can be canceled by placing \fBxx@\fR to the left of the -use reference that imports it, where \fIxx\fP is the capability. -For example, the entry -.RS -.PP -2621\-nl, smkx@, rmkx@, use=2621, -.RE -.PP -defines a 2621\-nl that does not have the \fBsmkx\fR or \fBrmkx\fR capabilities, -and hence does not turn on the function key labels when in visual mode. -This is useful for different modes for a terminal, or for different -user preferences. -.PP .SS Pitfalls of Long Entries .PP Long terminfo entries are unlikely to be a problem; to date, no entry has even @@ -1657,13 +1904,13 @@ Unfortunately, the termcap translations are much more strictly limited (to 1023 bytes), thus termcap translations of long terminfo entries can cause problems. .PP -The man pages for 4.3BSD and older versions of \fBtgetent()\fP instruct the user to +The man pages for 4.3BSD and older versions of \fBtgetent\fP instruct the user to allocate a 1024-byte buffer for the termcap entry. The entry gets null-terminated by the termcap library, so that makes the maximum safe length for a termcap entry 1k\-1 (1023) bytes. Depending on what the application and the termcap library -being used does, and where in the termcap file the terminal type that \fBtgetent()\fP +being used does, and where in the termcap file the terminal type that \fBtgetent\fP is searching for is, several bad things can happen. .PP Some termcap libraries print a warning message or exit if they find an @@ -1673,18 +1920,18 @@ Some application programs allocate more than the recommended 1K for the termcap entry; others do not. .PP Each termcap entry has two important sizes associated with it: before -"tc" expansion, and after "tc" expansion. -"tc" is the capability that +\*(``tc\*('' expansion, and after \*(``tc\*('' expansion. +\*(``tc\*('' is the capability that tacks on another termcap entry to the end of the current one, to add on its capabilities. -If a termcap entry does not use the "tc" +If a termcap entry does not use the \*(``tc\*('' capability, then of course the two lengths are the same. .PP -The "before tc expansion" length is the most important one, because it +The \*(``before tc expansion\*('' length is the most important one, because it affects more than just users of that particular terminal. This is the length of the entry as it exists in /etc/termcap, minus the -backslash-newline pairs, which \fBtgetent()\fP strips out while reading it. +backslash-newline pairs, which \fBtgetent\fP strips out while reading it. Some termcap libraries strip off the final newline, too (GNU termcap does not). Now suppose: .bP @@ -1696,12 +1943,12 @@ and the termcap library (like the one in BSD/OS 1.1 and GNU) reads the whole entry into the buffer, no matter what its length, to see if it is the entry it wants, .bP -and \fBtgetent()\fP is searching for a terminal type that either is the +and \fBtgetent\fP is searching for a terminal type that either is the long entry, appears in the termcap file after the long entry, or -does not appear in the file at all (so that \fBtgetent()\fP has to search +does not appear in the file at all (so that \fBtgetent\fP has to search the whole termcap file). .PP -Then \fBtgetent()\fP will overwrite memory, perhaps its stack, and probably core dump +Then \fBtgetent\fP will overwrite memory, perhaps its stack, and probably core dump the program. Programs like telnet are particularly vulnerable; modern telnets pass along values like the terminal type automatically. @@ -1712,16 +1959,16 @@ If a termcap library truncates long entries, like OSF/1 3.0, it is immune to dying here but will return incorrect data for the terminal. .PP -The "after tc expansion" length will have a similar effect to the +The \*(``after tc expansion\*('' length will have a similar effect to the above, but only for people who actually set TERM to that terminal -type, since \fBtgetent()\fP only does "tc" expansion once it is found the +type, since \fBtgetent\fP only does \*(``tc\*('' expansion once it is found the terminal type it was looking for, not while searching. .PP In summary, a termcap entry that is longer than 1023 bytes can cause, on various combinations of termcap libraries and applications, a core dump, warnings, or incorrect operation. If it is too long even before -"tc" expansion, it will have this effect even for users of some other +\*(``tc\*('' expansion, it will have this effect even for users of some other terminal types and users whose TERM variable does not have a termcap entry. .PP @@ -1740,7 +1987,7 @@ binary format) collide with System V and XSI Curses extensions. .SH EXTENSIONS .PP Searching for terminal descriptions in -\fB$HOME/.terminfo\fR and TERMINFO_DIRS +\fB$HOME/.terminfo\fR and TERMINFO_DIRS is not supported by older implementations. .PP Some SVr4 \fBcurses\fR implementations, and all previous to SVr4, do not @@ -1766,8 +2013,8 @@ They are deduced from the documentation for the AT&T 505 terminal. .PP Be careful assigning the \fBkmous\fR capability. -The \fBncurses\fR wants to -interpret it as \fBKEY_MOUSE\fR, for use by terminals and emulators like xterm +The \fBncurses\fR library wants to interpret it as \fBKEY_MOUSE\fR, +for use by terminals and emulators like xterm that can return mouse-tracking information in the keyboard-input stream. .PP X/Open Curses does not mention italics. @@ -1783,30 +2030,30 @@ Different commercial ports of terminfo and curses support different subsets of the XSI Curses standard and (in some cases) different extension sets. Here is a summary, accurate as of October 1995: -.PP +.bP \fBSVR4, Solaris, ncurses\fR \-\- These support all SVr4 capabilities. -.PP +.bP \fBSGI\fR \-\- Supports the SVr4 set, adds one undocumented extended string capability (\fBset_pglen\fR). -.PP +.bP \fBSVr1, Ultrix\fR \-\- These support a restricted subset of terminfo capabilities. The booleans end with \fBxon_xoff\fR; the numerics with \fBwidth_status_line\fR; and the strings with \fBprtr_non\fR. -.PP +.bP \fBHP/UX\fR \-\- Supports the SVr1 subset, plus the SVr[234] numerics \fBnum_labels\fR, \fBlabel_height\fR, \fBlabel_width\fR, plus function keys 11 through 63, plus \fBplab_norm\fR, \fBlabel_on\fR, and \fBlabel_off\fR, plus some incompatible extensions in the string table. -.PP +.bP \fBAIX\fR \-\- Supports the SVr1 subset, plus function keys 11 through 63, plus a number of incompatible string table extensions. -.PP +.bP \fBOSF\fR \-\- Supports both the SVr4 set and the AIX extensions. .SH FILES @@ -1814,12 +2061,16 @@ Supports both the SVr4 set and the AIX extensions. \*d/?/* files containing terminal descriptions .SH SEE ALSO -\fB@TIC@\fR(1M), \fB@INFOCMP@\fR(1M), +\fB@TABS@\fR(1), +\fB@TIC@\fR(1M), \fBcurses\fR(3X), +\fBcurs_color\fR(3X), +\fBcurs_variables\fR(3X), \fBprintf\fR(3), -\fBterm\fR(\*n). \fBterm_variables\fR(3X). +\fBterm\fR(\*n). +\fBuser_caps\fR(5). .SH AUTHORS Zeyd M. Ben-Halim, Eric S. Raymond, Thomas E. Dickey. Based on pcurses by Pavel Curtis.