ncurses 6.3 - patch 20220724

[ncurses.git] / man / user_caps.5

diff --git a/man/user_caps.5 b/man/user_caps.5
index 43dd000cdc084d9887b1ea0bbe2e1cd018b011c4..b43e218f376d7921d799c632dccc85e87e0b46b4 100644 (file)
--- a/man/user_caps.5
+++ b/man/user_caps.5
@@ -1,5 +1,5 @@
 .\"***************************************************************************
 .\"***************************************************************************

-.\" Copyright 2018-2019,2020 Thomas E. Dickey                                *
+.\" Copyright 2018-2021,2022 Thomas E. Dickey                                *

 .\" Copyright 2017 Free Software Foundation, Inc.                            *
 .\"                                                                          *
 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
 .\" Copyright 2017 Free Software Foundation, Inc.                            *
 .\"                                                                          *
 .\" Permission is hereby granted, free of charge, to any person obtaining a  *


@@ -27,7 +27,7 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"

-.\" $Id: user_caps.5,v 1.16 2020/12/19 21:26:11 tom Exp $
+.\" $Id: user_caps.5,v 1.22 2022/07/03 20:01:04 tom Exp $

 .TH user_caps 5
 .ie \n(.g .ds `` \(lq
 .el       .ds `` ``
 .TH user_caps 5
 .ie \n(.g .ds `` \(lq
 .el       .ds `` ``


@@ -124,9 +124,9 @@ box characters primary set
 .RE
 .IP
 The memory lock/unlock capabilities were included because they were used
 .RE
 .IP
 The memory lock/unlock capabilities were included because they were used

-in the X11R6 terminal description for \fBxterm\fP.
+in the X11R6 terminal description for \fBxterm\fP(1).

 The \fIbox1\fP capability is used in @TIC@ to help with terminal descriptions
 The \fIbox1\fP capability is used in @TIC@ to help with terminal descriptions

-written for AIX. 
+written for AIX.

 .PP
 During the 1990s, some users were reluctant to use terminfo
 in spite of its performance advantages over termcap:
 .PP
 During the 1990s, some users were reluctant to use terminfo
 in spite of its performance advantages over termcap:


@@ -181,7 +181,7 @@ While terminfo and termcap have a set of 60 predefined function-key names,
 to which a series of keys can be assigned,
 that is insufficient for more than a dozen keys multiplied by more than
 a couple of modifier combinations.
 to which a series of keys can be assigned,
 that is insufficient for more than a dozen keys multiplied by more than
 a couple of modifier combinations.

-The ncurses database uses a convention based on \fBxterm\fP to
+The ncurses database uses a convention based on \fBxterm\fP(1) to

 provide extended special-key names.
 .IP
 Fitting that into termcap's limitation of 2-character names
 provide extended special-key names.
 .IP
 Fitting that into termcap's limitation of 2-character names


@@ -207,9 +207,15 @@ the terminal.
 .IP
 The command \*(``\fBtput clear\fP\*('' does the same thing.
 .TP 3
 .IP
 The command \*(``\fBtput clear\fP\*('' does the same thing.
 .TP 3

+NQ
+used to suppress a consistency check in @TIC@ for the ncurses capabilities
+in user6 through user9 (u6, u7, u8 and u9)
+which tell how to query the terminal's cursor position
+and its device attributes.
+.TP 3

 RGB
 \fIboolean\fP, \fInumber\fP \fBor\fP \fIstring\fP,
 RGB
 \fIboolean\fP, \fInumber\fP \fBor\fP \fIstring\fP,

-to assert that the
+used to assert that the

 \fBset_a_foreground\fP and
 \fBset_a_background\fP capabilities correspond to \fIdirect colors\fP,
 using an RGB (red/green/blue) convention.
 \fBset_a_foreground\fP and
 \fBset_a_background\fP capabilities correspond to \fIdirect colors\fP,
 using an RGB (red/green/blue) convention.


@@ -258,7 +264,7 @@ Set this capability to a nonzero value to enable it.
 XM
 \fIstring\fP,
 override ncurses's built-in string which
 XM
 \fIstring\fP,
 override ncurses's built-in string which

-enables/disables \fBxterm\fP mouse mode.
+enables/disables \fBxterm\fP(1) mouse mode.

 .IP
 ncurses sends a character sequence to the terminal to initialize mouse mode,
 and when the user clicks the mouse buttons or (in certain modes) moves the
 .IP
 ncurses sends a character sequence to the terminal to initialize mouse mode,
 and when the user clicks the mouse buttons or (in certain modes) moves the


@@ -344,7 +350,7 @@ Several terminals provide the ability to send distinct strings for
 combinations of modified special keys.
 There is no standard for what those keys can send.
 .PP
 combinations of modified special keys.
 There is no standard for what those keys can send.
 .PP

-Since 1999, \fBxterm\fP has supported
+Since 1999, \fBxterm\fP(1) has supported

 \fIshift\fP, \fIcontrol\fP, \fIalt\fP, and \fImeta\fP modifiers which produce
 distinct special-key strings.
 In a terminal description, ncurses has no special knowledge of the
 \fIshift\fP, \fIcontrol\fP, \fIalt\fP, and \fImeta\fP modifiers which produce
 distinct special-key strings.
 In a terminal description, ncurses has no special knowledge of the


@@ -359,7 +365,7 @@ ncurses' terminal database defines these names to which a suffix is added:
 .TS
 tab(/) ;
 l l .
 .TS
 tab(/) ;
 l l .

-\fIName\fR/\fIDescription\fR
+\fBName\fP/\fBDescription\fP

 _
 kDC/special form of kdch1 (delete character)
 kDN/special form of kcud1 (cursor down)
 _
 kDC/special form of kdch1 (delete character)
 kDN/special form of kcud1 (cursor down)


@@ -378,7 +384,7 @@ These are the suffixes used to denote the modifiers:
 .TS
 tab(/) ;
 l l .
 .TS
 tab(/) ;
 l l .

-\fIValue\fR/\fIDescription\fR
+\fBValue\fP/\fBDescription\fP

 _
 2/Shift
 3/Alt
 _
 2/Shift
 3/Alt


@@ -419,17 +425,17 @@ but makes no use of these capabilities itself.
 .\"
 .SH SEE ALSO
 .PP
 .\"
 .SH SEE ALSO
 .PP

-\fB@INFOCMP@\fR(1M),
-\fB@TIC@\fR(1M).
+\fB@INFOCMP@\fP(1M),
+\fB@TIC@\fP(1M).

 .PP
 The terminal database section
 .I "NCURSES USER-DEFINABLE CAPABILITIES"
 summarizes commonly-used user-defined capabilities
 which are used in the terminal descriptions.
 .PP
 The terminal database section
 .I "NCURSES USER-DEFINABLE CAPABILITIES"
 summarizes commonly-used user-defined capabilities
 which are used in the terminal descriptions.

-Some of those features are mentioned in \fBscreen\fR(1) or \fBtmux\fR(1).
+Some of those features are mentioned in \fBscreen\fP(1) or \fBtmux\fP(1).

 .PP
 .I "XTerm Control Sequences"
 .PP
 .I "XTerm Control Sequences"

-provides further information on the \fBxterm\fP features
+provides further information on the \fBxterm\fP(1) features

 which are used in these extended capabilities.
 .\"
 .SH AUTHORS
 which are used in these extended capabilities.
 .\"
 .SH AUTHORS