[PATCH 09/16] man/curs_inopts.3x: Improve description.

"G. Branden Robinson" <[email protected]>
Newsgroups gmane.comp.lib.ncurses.bugs
Message-ID <20260815122101.ebquz6fcqoddwmru@illithid>
The `ESC` character code is not actually special (the name of the
`ESCDELAY` extension notwithstanding).  What matters is whether the
first character read from the input stream is an ambiguous prefix to
multiple key-defining string capabilities.

Thanks to Antonio Niño Díaz for prompting a review of this material.
---
 man/curs_inopts.3x | 20 ++++++++++++++------
 1 file changed, 14 insertions(+), 6 deletions(-)

diff --git a/man/curs_inopts.3x b/man/curs_inopts.3x
index c0db26d6f..3262d98c4 100644
--- a/man/curs_inopts.3x
+++ b/man/curs_inopts.3x
@@ -261,7 +261,10 @@ .SS keypad
 .RI ( bf
 is
 .BR TRUE ")"
-then when an input character reading function reads ESC,
+then when an input character reading function reads
+a character that is a common prefix to multiple
+key-defining string capabilities
+(typically ESC),
 it waits for further input corresponding to an escape sequence
 defined by the terminal type description.
 If a valid sequence populates the input stream,
@@ -367,14 +370,18 @@ .SS notimeout
 When
 .B \%keypad
 has been called on a window
-and the input character reading function reads an ESC character from it,
+and the input character reading function reads
+an ambiguous prefix character
+(typically ESC)
+from it,
 .I curses
 sets a timer while waiting for the next character.
 If the timer elapses,
 .I curses
-interprets the ESC as an explicit press of the terminal's Escape key
-(or equivalent).
-.\" like Control+[
+interprets the prefix as an explicit press
+of the key corresponding thereto,
+such as Escape for ESC.
+.\" or some equivalent, like Control+[
 .BI \%notimeout( win ,
 .B TRUE)
 disables this timer.
@@ -625,7 +632,8 @@ .SH NOTES
 and for how long.
 .B \%keypad
 configures whether that function waits for further input
-if the first character it reads is ESC.
+if the first character it reads is an ambiguous prefix
+(like ESC).
 Calling
 .BR \%notimeout ","
 which has nothing to do with
-- 
2.30.2
signature.asc (application/pgp-signature, 833 B)
-----BEGIN PGP SIGNATURE-----

iQIzBAABCAAdFiEEh3PWHWjjDgcrENwa0Z6cfXEmbc4FAmqAWa0ACgkQ0Z6cfXEm
bc4KhhAAkqWCwEmEeyF9zbdQdC2uD9XceOJkArRE9mM6MSl+7g9JE3matNmrIn0j
26d/irZQqCIxpzXvn3We2OuU1FrCIwu32Wke4VgjTsG6CTCJDT1XX7aFlTTz5ekx
flbrMiHSURuGcuRF/j16q9bJ4og7seamw4SPiKFnxF2oxyFT9xdlJqs+R9DTjn4a
TzPzT8320X2BhRjOYFCeg+9M5wJPlXEZi5TOrZ4T6mOKXV3aFA3WGuW6Cpa1+yQR
0VR6mn4Tz7gpKq63sG1h8o6RWT4VdBXBW51Mcr4+Bqg9sH+z6Es24BBWD0FeUWoG
m0ME4JnQaKehwF2u/cgXAp0NxbI+4EJxWJfVANGDTaqmk2JuVoMiA/l+S5zpV2s7
GiESwRIV6cIA3qrviQavYXm0tD3BubCDLvuWpzAFtr0Yzs6ofqC/Ah36A2INlNJl
qBXA+xnP7wle1A6An+Z82j6j+upP0orcFRnmsRlTnuwLa16t3xyXrDdIvGU7C/0u
UMZ2cr8SpG0jiSaGUaEs3SZiTgtP4xEYPP+XHeZ9lLzmwTijMbbxlat5A65d6xCd
xB8FgApHXdVawS6z+dVhx3zYrUjE4GiuCnSqviLEe+NU7zv33TxQ0KD+CQF/W1Ch
ItIpB5MCksFFask3x4KdnwRBqO0bbvfdw8rJVyYxYfsiSREmFB8=
=j6/u
-----END PGP SIGNATURE-----
lmpx.com only provides a reader for public news (NNTP) servers. It is not affiliated with the servers or forums shown here and is not responsible for the content of articles, which is written by their respective authors.