[PATCH 10/16] man/curs_getch.3x: Fix content, style nits.
"G. Branden Robinson" <[email protected]>
| Newsgroups | gmane.comp.lib.ncurses.bugs |
|---|---|
| Message-ID | <20260815122112.6njmvrjptoulaymi@illithid> |
Content:
* More carefully distinguish escape sequences from the contents of a
function key's string capabilitiy. The latter is what the curses
library actually processes, and attempts to disambiguate when
a window's keypad mode is enabled.
* Add cross reference to terminfo(5) when mentioning string
capabilities.
Style:
* De-italicize a term that has already been introduced.
---
man/curs_getch.3x | 18 ++++++++++--------
1 file changed, 10 insertions(+), 8 deletions(-)
diff --git a/man/curs_getch.3x b/man/curs_getch.3x
index 64488858e..2204f3696 100644
--- a/man/curs_getch.3x
+++ b/man/curs_getch.3x
@@ -199,24 +199,24 @@ .SS "Keypad Mode"
symbols listed in subsection \*(``Key Codes\*('' below.
If the window is not in keypad mode,
the input queue populates with
-the characters of the function key's escape sequence,
+the characters of the function key's string capability
+(see \fB\%terminfo\fP(5)),
which the application must collect individually with multiple
.B \%wgetch
calls.
.bP
The
.I \%curses.h
-header file declares many
-.I "function keys"
-whose names begin with
+header file declares many function keys whose names begin with
.BR KEY_ ";"
these object-like macros
have integer values outside the range of eight-bit character codes.
.bP
In
.IR \%ncurses ","
-.I "user-defined function keys"
-are configured with \fB\%define_key\fP(3X);
+\fB\%define_key\fP(3X)
+configures
+.IR "user-defined function keys" ;
they have no names,
but are also expected to
have integer values outside the range of eight-bit character codes.
@@ -231,7 +231,7 @@ .SS "Keypad Mode"
This fact implies that
.I curses
cannot distinguish a user's press of the escape key
-(assuming it sends ESC)
+(or any prefix common to multiple function key definitions)
from the beginning of a function key's character sequence without
waiting to see if,
and how soon,
@@ -680,7 +680,9 @@ .SH EXTENSIONS
.B \%ESCDELAY
variable configures the duration of the timer used to disambiguate a
function key character sequence from a series of key strokes beginning
-with ESC typed by the user;
+with their common prefix
+(such as ESC)
+when typed by the user;
see
\fB\%curs_variables\fP(3X).
.PP
--
2.30.2
signature.asc
(application/pgp-signature, 833 B)
-----BEGIN PGP SIGNATURE----- iQIzBAABCAAdFiEEh3PWHWjjDgcrENwa0Z6cfXEmbc4FAmqAWbgACgkQ0Z6cfXEm bc4lXQ/6AsbmNLZjo0FlmC5knuEftVJo80vgNx4mUuiLHEbKdkBN+ozh1zE2uUB1 wYLS++64o/2XKsxs8cTIN9WWsq5T3CouCD7n26NBy9vV/XVgKqcGiBXQPbPsyEoA FfdFaT9Gy8Uvaw3Pk9IdLmzp7KWkVGMpP8A2yK6F1A2ejim0hOAJkWqCLYkmEZUX c0Zpkg/WmuknRUqL17m+Sc5zvU8FjPEtxbRRT8dt3Zlc3qgxIpJraVZmUvgkkVUv cfzUV73NUkNjuDuSdnVWONbVtObspX81nJzERp0gJSlIjJ5Ukwfuxgwc/KkUzZ27 1CRau4YJD8f6rzS6zedwpGc93CeCh3vIOetON4ZTeREzoHirYF8b7Lwccr9BvcUQ vYASWRsCgfi88yu+JcwZM1Hm15cmYK5qYOLi4jlK7WovRewmzr5G5aR84Q3UbrdT L00v56V1nwW8941CGvPmcI8ce4qmRWYWTmCWiS1Anldxiag/DRYxsJ76Qq7lLU66 /q7eGwrnzvf5AFY2beiDutdboADjmazQgbBfErqOTLNziFt+xkyUnGoTxsJ6u2Xj w7mlnVYtjMQlL4KJ5DbKunZvr1ywA+Cc0oLr7CBu3gC3hfBD6Zwio95PsyJN2D23 pq0QpEz4A1aMrJPu+ICVbdtEWe7dWBmBAWmxQp2ofkCIMJMN74U= =7VQd -----END PGP SIGNATURE-----