summaryrefslogtreecommitdiffstats
path: root/upstream/debian-unstable/man5/terminfo.5
diff options
context:
space:
mode:
Diffstat (limited to 'upstream/debian-unstable/man5/terminfo.5')
-rw-r--r--upstream/debian-unstable/man5/terminfo.5173
1 files changed, 108 insertions, 65 deletions
diff --git a/upstream/debian-unstable/man5/terminfo.5 b/upstream/debian-unstable/man5/terminfo.5
index 5e6a8215..c4c24949 100644
--- a/upstream/debian-unstable/man5/terminfo.5
+++ b/upstream/debian-unstable/man5/terminfo.5
@@ -33,8 +33,8 @@
.\" authorization. *
.\"***************************************************************************
.\"
-.\" $Id: terminfo.head,v 1.63 2024/01/13 23:07:27 tom Exp $
-.TH terminfo 5 2024-01-13 "ncurses 6.4" "File formats"
+.\" $Id: terminfo.head,v 1.65 2024/04/20 21:14:00 tom Exp $
+.TH terminfo 5 2024-04-20 "ncurses 6.5" "File formats"
.ie \n(.g \{\
.ds `` \(lq
.ds '' \(rq
@@ -81,8 +81,10 @@ describes terminals by giving a set of capabilities which they
have, by specifying how to perform screen operations, and by
specifying padding requirements and initialization sequences.
.PP
-This manual describes \fI\%ncurses\fP
-version 6.4 (patch 20240113).
+This document describes
+.I \%ncurses
+version 6.5
+(patch 20240427).
.SS "\fIterminfo\fP Entry Syntax"
Entries in
.I terminfo
@@ -229,60 +231,79 @@ using terminal entry.
.SS "Predefined Capabilities"
.\" Head of terminfo man page ends here
.ps -1
-The following is a complete table of the capabilities included in a
-terminfo description block and available to terminfo-using code.
-In each line of the table,
+Tables of capabilities
+.I \%ncurses
+recognizes in a
+.I \%term\%info
+terminal type description and available to
+.IR \%term\%info -using
+code follow.
.bP
-The \fBvariable\fR is the name by which the programmer (at the terminfo level)
-accesses the capability.
+The capability name identifies the symbol by which the programmer
+using the
+.I \%term\%info
+API accesses the capability.
.bP
-The \fBcapname\fR (\fICap-name\fP)
-is the short name used in the text of the database,
-and is used by a person updating the database.
+The TI
+.RI ( \%term\%info )
+code is the short name used by a person composing or updating a
+terminal type entry.
.IP
-Whenever possible, capnames are chosen to be the same as or similar to
-the ANSI X3.64-1979 standard (now superseded by ECMA-48, which uses
-identical or very similar names).
+Whenever possible,
+these codes are the same as or similar to those of the ANSI X3.64-1979
+standard
+(now superseded by ECMA-48,
+which uses identical or very similar names).
Semantics are also intended to match those of the specification.
.IP
-Capability names have no hard length limit, but an informal limit of 5
-characters has been adopted to keep them short and to allow the tabs in
-the source file
-.B Caps
+.I \%term\%info
+codes have no hard length limit,
+but
+.I \%ncurses
+maintains an informal one of 5 characters to keep them short and to
+allow the tabs in the source file
+.I Caps
to line up nicely.
+(Some standard codes exceed this limit regardless.)
.bP
-The \fBtermcap\fP (\fITcap\fP) code is the old capability name
-(some capabilities are new, and have names which termcap did not originate).
+The TC
+.RI ( termcap )
+code is that used by the corresponding API of
+.IR \%ncurses .
+(Some capabilities are new,
+and have names that BSD
+.I termcap
+did not originate.)
.bP
-Finally, the \fBdescription\fP field attempts to convey the semantics of the
-capability.
+The description field attempts to convey the capability's semantics.
.PP
-You may find some codes in the description field:
+The description field employs a handful of notations.
.TP
-(P)
-indicates that padding may be specified
+.B (P)
+indicates that padding may be specified.
.TP
-#[1-9]
-in the description field indicates that the string is passed
-through \fB\%tparm\fP(3NCURSES) with parameters as given (#\fIi\fP).
-.IP
-If no parameters are listed in the description,
-passing the string through \fB\%tparm\fP(3NCURSES) may give unexpected results,
-e.g., if it contains percent (%%) signs.
-.TP
-(P*)
-indicates that padding may vary in proportion to the number of
-lines affected
+.B (P*)
+indicates that padding may vary in proportion to the number of output
+lines affected.
.TP
-(#\d\fIi\fP\u)
-indicates the \fIi\fP\uth\d parameter.
+.BI # i
+indicates the
+.IR i th
+parameter of a string capability;
+the programmer should pass the string to \fB\%tparm\fP(3NCURSES) with the
+parameters listed.
+.IP
+If the description lists no parameters,
+passing the string to \fB\%tparm\fP(3NCURSES) may produce unexpected
+behavior,
+for instance if the string contains percent signs.
.
.PP
.TS
center;
-Lb Cb S Lb
-Lb Lb Lb Lb
-Lb Lb Lb Lx.
+Lb Cb S Lb
+Lb Lb Lb Lb
+Lbw(25n)2 Lbw(8n)2 Lb2 Lx.
\& Code \&
Boolean Capability Name TI TC Description
_
@@ -439,9 +460,9 @@ T}
.
.TS
center;
-Lb Cb S Lb
-Lb Lb Lb Lb
-Lb Lb Lb Lx.
+Lb Cb S Lb
+Lb Lb Lb Lb
+Lbw(25n)2 Lbw(8n)2 Lb2 Lx.
\& Code \&
Numeric Capability Name TI TC Description
_
@@ -519,9 +540,9 @@ They came in with SVr4's printer support.
.PP
.TS
center;
-Lb Cb S Lb
-Lb Lb Lb Lb
-Lb Lb Lb Lx.
+Lb Cb S Lb
+Lb Lb Lb Lb
+Lbw(25n)2 Lbw(8n)2 Lb2 Lx.
\& Code \&
Numeric Capability Name TI TC Description
_
@@ -598,9 +619,9 @@ T}
.
.TS
center;
-Lb Cb S Lb
-Lb Lb Lb Lb
-Lb Lb Lb Lx.
+Lb Cb S Lb
+Lb Lb Lb Lb
+Lbw(25n)2 Lbw(8n)2 Lb2 Lx.
\& Code \&
String Capability Name TI TC Description
_
@@ -852,6 +873,10 @@ key_down kcud1 kd T{
.ad l
down-arrow key
T}
+.TE
+.TS
+center;
+Lbw(25n)2 Lbw(8n)2 Lb2 Lx.
key_eic krmir kM T{
.ad l
sent by rmir or smir in insert mode
@@ -1100,6 +1125,10 @@ reset_2string rs2 r2 T{
.ad l
reset string
T}
+.TE
+.TS
+center;
+Lbw(25n)2 Lbw(8n)2 Lb2 Lx.
reset_3string rs3 r3 T{
.ad l
reset string
@@ -1348,6 +1377,10 @@ key_undo kund &8 T{
.ad l
undo key
T}
+.TE
+.TS
+center;
+Lbw(25n)2 Lbw(8n)2 Lb2 Lx.
key_sbeg kBEG &9 T{
.ad l
shifted begin key
@@ -1596,6 +1629,10 @@ key_f42 kf42 FW T{
.ad l
F42 function key
T}
+.TE
+.TS
+center;
+Lbw(25n)2 Lbw(8n)2 Lb2 Lx.
key_f43 kf43 FX T{
.ad l
F43 function key
@@ -1690,7 +1727,7 @@ clear right and left soft margins
T}
set_left_margin smgl ML T{
.ad l
-set left soft margin at current column. (ML is not in BSD termcap).
+set left soft margin at current column (not in BSD \fItermcap\fP)
T}
set_right_margin smgr MR T{
.ad l
@@ -1844,6 +1881,10 @@ enter_doublewide_mode swidm ZF T{
.ad l
Enter double-wide mode
T}
+.TE
+.TS
+center;
+Lbw(25n)2 Lbw(8n)2 Lb2 Lx.
enter_draft_quality sdrfq ZG T{
.ad l
Enter draft-quality mode
@@ -2029,9 +2070,9 @@ but were originally not documented in the man page.
.PP
.TS
center;
-Lb Cb S Lb
-Lb Lb Lb Lb
-Lb Lb Lb Lx.
+Lb Cb S Lb
+Lb Lb Lb Lb
+Lbw(25n)2 Lbw(8n)2 Lb2 Lx.
\& Code \&
String Capability Name TI TC Description
_
@@ -2178,9 +2219,9 @@ entries after SVr4.1; beware!
.PP
.TS
center;
-Lb Cb S Lb
-Lb Lb Lb Lb
-Lb Lb Lb Lx.
+Lb Cb S Lb
+Lb Lb Lb Lb
+Lbw(25n)2 Lbw(8n)2 Lb2 Lx.
\& Code \&
String Capability Name TI TC Description
_
@@ -2246,7 +2287,7 @@ T}
.\" authorization. *
.\"***************************************************************************
.\"
-.\" $Id: terminfo.tail,v 1.143 2024/01/13 22:05:39 tom Exp $
+.\" $Id: terminfo.tail,v 1.148 2024/04/20 21:24:19 tom Exp $
.ps +1
.SS "User-Defined Capabilities"
.
@@ -3111,7 +3152,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
@@ -3133,7 +3174,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
@@ -3227,7 +3268,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
@@ -3914,6 +3955,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.,
@@ -4262,7 +4305,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
@@ -4281,7 +4324,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,
@@ -4327,7 +4370,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.
generated by cgit v1.2.3 (git 2.39.1) at 2025-02-05 01:13:13 +0000