X-Git-Url: http://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=man%2Fterminfo.tail;h=070319c42051afa4ba0c2864f90a15c84a19b5f6;hb=HEAD;hp=dc527831abb4b3b4b7a468fdbea04cd00903a9e9;hpb=159cd0555e0efc14be66c9c3a1548f58908b6a1d;p=ncurses.git diff --git a/man/terminfo.tail b/man/terminfo.tail index dc527831..74a27415 100644 --- a/man/terminfo.tail +++ b/man/terminfo.tail @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright 2018-2022,2023 Thomas E. Dickey * +.\" Copyright 2018-2023,2024 Thomas E. Dickey * .\" Copyright 1998-2016,2017 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -27,7 +27,7 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: terminfo.tail,v 1.140 2023/12/23 16:23:35 tom Exp $ +.\" $Id: terminfo.tail,v 1.150 2024/06/08 20:42:50 Branden.Robinson Exp $ .ps +1 .SS "User-Defined Capabilities" . @@ -46,7 +46,7 @@ When \fB\-x\fP is set, \fB@TIC@\fP treats unknown capabilities as user-defined. 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 +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(3X) function makes this information conditionally available to applications. @@ -56,7 +56,7 @@ behavior to applications: User-defined capability strings whose name begins with \*(``k\*('' are treated as function keys. .bP -The types (boolean, number, string) determined by \fB@TIC@\fP +The types (Boolean, number, string) determined by \fB@TIC@\fP can be inferred by successful calls on \fBtigetflag\fP, etc. .bP If the capability name happens to be two characters, @@ -68,7 +68,7 @@ in practice it has been limited to the capabilities defined by terminfo implementations. As a rule, user-defined capabilities intended for use by termcap applications should -be limited to booleans and numbers to avoid running past the 1023 byte +be limited to Booleans and numbers to avoid running past the 1023 byte limit assumed by termcap implementations and their applications. In particular, providing extended sets of function keys (past the 60 numbered keys and the handful of special named keys) is best done using @@ -277,14 +277,14 @@ as a list of colon-separated pathnames of terminal databases to be searched. .IP An empty pathname (i.e., if the variable begins or ends with a colon, or contains adjacent colons) -is interpreted as the system location \fI\*d\fP. +is interpreted as the system location \fI@TERMINFO@\fP. .bP Finally, \fI\%ncurses\fP searches these compiled-in locations: .RS .bP a list of directories (@TERMINFO_DIRS@), and .bP -the system terminfo directory, \fI\*d\fP +the system terminfo directory, \fI@TERMINFO@\fP .RE .PP The \fBTERMINFO\fP variable can contain a terminal description instead @@ -348,7 +348,7 @@ and applies to storage scope terminals, such as \s-1TEKTRONIX\s+1 4010 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 +line, give this as .BR cr . (Normally this will be carriage return, control/M.) If there is a code to produce an audible signal (bell, beep, etc) @@ -412,7 +412,7 @@ The only local motion which is defined from the left edge is if .B bw is given, then a .B cub1 -from the left edge will move to the right edge of the previous row. +from the left edge will move to the right edge of the previous line. If .B bw is not given, the effect is undefined. @@ -462,8 +462,8 @@ with \fIprintf\fP-like escapes such as \fI%x\fP in it. For example, to address the cursor, the .B cup capability is given, using two parameters: -the row and column to address to. -(Rows and columns are numbered from zero and refer to the +the line and column to address to. +(Lines and columns are numbered from zero and refer to the physical screen visible to the user, not to any unseen memory.) If the terminal has memory relative cursor addressing, that can be indicated by @@ -608,17 +608,17 @@ 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 +Consider the HP2645, which, to get to line 3 and column 12, needs to be sent \eE&a12c03Y padded for 6 milliseconds. -The order of the rows and columns is inverted here, -and the row and column are printed as two digits. +The order of the lines and columns is inverted here, +and the lines and column are printed as two digits. The corresponding terminal description is expressed thus: .RS cup=\eE&a%p2%dc%p1%dY$<6>, .RE .PP -The Microterm \s-1ACT-IV\s0 needs the current row and column sent -preceded by a \fB\*^T\fP, with the row and column simply encoded in binary, +The Microterm \s-1ACT-IV\s0 needs the current line and column sent +preceded by a \fB\*^T\fP, with the line and column simply encoded in binary, .RS cup=\*^T%p1%c%p2%c .RE @@ -632,7 +632,7 @@ This is necessary because it is not always safe to transmit \fB\en\fP 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 +A final example is the \s-1LSI ADM\s0-3a, which uses line and column offset by a blank character, thus .RS cup=\eE=%p1%\*' \*'%+%c%p2%\*' \*'%+%c @@ -656,7 +656,7 @@ to the top left corner of the screen, not of memory. (Thus, the \eEH sequence on HP terminals cannot be used for .BR home .) .PP -If the terminal has row or column absolute cursor addressing, +If the terminal has line or column absolute cursor addressing, these can be given as single parameter capabilities .B hpa (horizontal position absolute) @@ -713,7 +713,7 @@ 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. +given the number of lines or columns. .RE .PP In practice, the categorization into \*(``terminal\*('' and \*(``printer\*('' @@ -883,7 +883,7 @@ or on many terminals without a true insert/delete line, and is often faster even on terminals with those features. .PP -The boolean \fBnon_dest_scroll_region\fP should be set if each scrolling +The Boolean \fBnon_dest_scroll_region\fP should be set if each scrolling window is effectively a view port on a screen-sized canvas. To test for this capability, create a scrolling region in the middle of the screen, @@ -892,7 +892,7 @@ and do \fBri\fP followed by \fBdl1\fP or \fBind\fP. If the data scrolled off the bottom of the region by the \fBri\fP re-appears, then scrolling is non-destructive. -System V and XSI Curses expect that \fBind\fP, \fBri\fP, +System V and X/Open Curses expect that \fBind\fP, \fBri\fP, \fBindn\fP, and \fBrin\fP will simulate destructive scrolling; their documentation cautions you not to define \fBcsr\fP unless this is true. This \fBcurses\fP implementation is more liberal and will do explicit erases @@ -914,7 +914,7 @@ or that scrolling back with \fBri\fP may bring down non-blank lines. .SS "Insert/Delete Character" There are two basic kinds of intelligent terminals with respect to insert/delete character which can be described using -.I terminfo. +.IR terminfo . The most common insert/delete character operations affect only the characters on the current line and shift characters off the end of the line rigidly. Other terminals, such as the Concept 100 and the Perkin Elmer Owl, make @@ -1008,7 +1008,7 @@ to delete a single character, with one parameter, .IR n , to delete -.I n characters, +.IR n "characters," and delete mode by giving \fBsmdc\fP and \fBrmdc\fP to enter and exit delete mode (any mode the terminal needs to be placed in for @@ -1446,7 +1446,7 @@ If there are commands to set and clear tab stops, they can be given as (clear all tab stops) and .B hts -(set a tab stop in the current column of every row). +(set a tab stop in the current column of every line). If a more complex sequence is needed to set the tabs than can be described by this, the sequence can be placed in .B is2 @@ -1536,7 +1536,7 @@ capability \fBwsl\fP. .PP A command to erase or blank the status line may be specified as \fBdsl\fP. .PP -The boolean capability \fBeslok\fP specifies that escape sequences, tabs, +The Boolean capability \fBeslok\fP specifies that escape sequences, tabs, etc., work ordinarily in the status line. .PP The \fI\%ncurses\fP implementation does not yet use any of these @@ -1551,44 +1551,44 @@ This alternate character set may be specified by the \fBacsc\fP capability. .PP .TS center; -lb lb lb lb lb. -\& \& ASCII acsc acsc -Glyph Name ACS Name Fallback Symbol Value +Lb Cb S L Lb +Lb2 Lb2 Lb Lb1 S +Lb L C Lb Lx. +\& acsc \& \& +ACS Name Value Symbol ASCII Fallback / Glyph Name _ -.T& -l lb l l l . -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 + \(ga 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 +ACS_RARROW 0x2b + > arrow pointing right +ACS_LARROW 0x2c , < arrow pointing left +ACS_UARROW 0x2d \- \*^ arrow pointing up +ACS_DARROW 0x2e . v arrow pointing down +ACS_BLOCK 0x30 0 # solid square block +ACS_DIAMOND 0x60 \(ga + diamond +ACS_CKBOARD 0x61 a : checker board (stipple) +ACS_DEGREE 0x66 f \e degree symbol +ACS_PLMINUS 0x67 g # plus/minus +ACS_BOARD 0x68 h # board of squares +ACS_LANTERN 0x69 i # lantern symbol +ACS_LRCORNER 0x6a j + lower right corner +ACS_URCORNER 0x6b k + upper right corner +ACS_ULCORNER 0x6c l + upper left corner +ACS_LLCORNER 0x6d m + lower left corner +ACS_PLUS 0x6e n + large plus or crossover +ACS_S1 0x6f o \*~ scan line 1 +ACS_S3 0x70 p \- scan line 3 +ACS_HLINE 0x71 q \- horizontal line +ACS_S7 0x72 r \- scan line 7 +ACS_S9 0x73 s \&_ scan line 9 +ACS_LTEE 0x74 t + tee pointing right +ACS_RTEE 0x75 u + tee pointing left +ACS_BTEE 0x76 v + tee pointing up +ACS_TTEE 0x77 w + tee pointing down +ACS_VLINE 0x78 x | vertical line +ACS_LEQUAL 0x79 y < less-than-or-equal-to +ACS_GEQUAL 0x7a z > greater-than-or-equal-to +ACS_PI 0x7b { * greek pi +ACS_NEQUAL 0x7c | ! not-equal +ACS_STERLING 0x7d } f UK pound sign +ACS_BULLET 0x7e \*~ o bullet .TE .PP A few notes apply to the table itself: @@ -1648,7 +1648,7 @@ The \fBoc\fP string resets all colors or color pairs to their default values for the terminal. Some terminals (including many PC terminal emulators) erase screen areas with the current background color rather -than the power-up default background; these should have the boolean capability +than the power-up default background; these should have the Boolean capability \fBbce\fP. .PP While the curses library works with \fIcolor pairs\fP @@ -1695,6 +1695,8 @@ magenta COLOR_MAGENTA 5 max, 0, max cyan COLOR_CYAN 6 0, max, max white COLOR_WHITE 7 max, max, max .TE +.br +.if t .ne 6v .PP The argument values of \fBsetf\fP/\fBsetb\fP historically correspond to a different mapping, i.e., @@ -1730,7 +1732,7 @@ take a color number (0 to \fBcolors\fP \- 1)and three more parameters which describe the color. These three parameters default to being interpreted as RGB (Red, Green, Blue) values. -If the boolean capability \fBhls\fP is present, +If the Boolean capability \fBhls\fP is present, they are instead as HLS (Hue, Lightness, Saturation) indices. The ranges are terminal-dependent. @@ -2017,7 +2019,7 @@ The \-c (check) option also checks resolved (after tc expansion) lengths. .SH FILES .TP -.I \*d +.I @TERMINFO@ compiled terminal description database directory .SH EXTENSIONS Searching for terminal descriptions in @@ -2043,7 +2045,7 @@ See the \fBInsert/Delete Character\fP subsection above. .PP The parameter substitutions for \fBset_clock\fP and \fBdisplay_clock\fP are -not documented in SVr4 or the XSI Curses standard. +not documented in SVr4 or X/Open Curses. They are deduced from the documentation for the AT&T 505 terminal. .PP @@ -2062,7 +2064,7 @@ If italics should work with colors, then the \fBncv\fP value must be specified, even if it is zero. .PP Different commercial ports of \fI\%terminfo\fP and \fIcurses\fP support -different subsets of XSI Curses and +different subsets of X/Open Curses and (in some cases) different extensions. Here is a summary, @@ -2108,7 +2110,7 @@ At least two implementations of \fI\%terminfo\fP diverged from those of other System V Unices after SVr1, adding extension capabilities to the string table that (in the binary format) -collide with subsequent System V and XSI Curses extensions. +collide with subsequent System V and X/Open Curses extensions. .SH AUTHORS Zeyd M. Ben-Halim, Eric S. Raymond, Thomas E. Dickey. Based on \fIpcurses\fP by Pavel Curtis.