bug-ncurses
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[PATCH 12/17] man/curs_getch.3x: Revise (4/8).


From: G. Branden Robinson
Subject: [PATCH 12/17] man/curs_getch.3x: Revise (4/8).
Date: Wed, 13 Mar 2024 13:11:24 -0500

Revise "Testing Key Codes" subsection.

Content:
* Stop explaining what `define_key()` and `key_defined()` do here.
  Cross reference their man pages instead.

Style:
* Announce `has_key()` as an ncurses feature straight out of the gate.

Markup:
* Favor man(7) font style macros over *roff font selection escape
  sequences, except for man page cross references (because
  man/make_sed.sh recognizes only certain patterns when rewriting such
  cross references).
---
 man/curs_getch.3x | 21 +++++++--------------
 1 file changed, 7 insertions(+), 14 deletions(-)

diff --git a/man/curs_getch.3x b/man/curs_getch.3x
index 54ab34ac6..b4ac8dd28 100644
--- a/man/curs_getch.3x
+++ b/man/curs_getch.3x
@@ -415,20 +415,13 @@ .SS "Predefined Key Codes"
 must read an escape sequence,
 as with a function key.
 .SS "Testing Key Codes"
-The \fBhas_key\fP routine takes a key-code value from the above list, and
-returns \fBTRUE\fP or \fBFALSE\fP according to whether
-the current terminal type recognizes a key with that value.
-.PP
-The library also supports these extensions:
-.RS 3
-.TP 5
-.B define_key
-defines a key-code for a given string (see \fBdefine_key\fP(3X)).
-.TP 5
-.B key_defined
-checks if there is a key-code defined for a given
-string (see \fBkey_defined\fP(3X)).
-.RE
+In
+.I \%ncurses,
+.B \%has_key
+takes a key code value from the above list,
+and returns a Boolean value indicating the terminal's recognition of it.
+See also
+\fBdefine_key\fP(3X) and \fBkey_defined\fP(3X).
 .SH RETURN VALUE
 All routines return the integer \fBERR\fP upon failure and an integer value
 other than \fBERR\fP (\fBOK\fP in the case of \fBungetch\fP) upon successful
-- 
2.30.2

Attachment: signature.asc
Description: PGP signature


reply via email to

[Prev in Thread] Current Thread [Next in Thread]