[PATCH 05/11] man/key_defined.3x: Revise.

[G. Branden Robinson]

Content:
* Clarify synopsis: only the key codes of _function keys_ are affected.
* Add "EXTENSIONS" section, since this function is one.
* Expand cross references to cover the other ncurses key binding
  extension functions, and the main ncurses page.

Style:
* Put a space after pointer star in function synopsis.
* Use terminology more consistently, speaking of key "bindings" and of
  "function keys" (in the curses sense) rather than "keys" in general.
* Spell "key code" thus, as two words.  Hyphenate it when used as a
  formal argument name.
* Recast.
* Favor active voice over passive.

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) and terms in the "NAME" section (because the
  generated edit_man.sh script expects font selection escape sequences
  when scraping terms from there to gather names for man page aliases).
* Break input lines after commas.
* Use font selection escape sequences more idiomatically; employ `\fP`
  to return to the previous font in summary description, not `\fR` to
  select roman.
---
 man/key_defined.3x | 55 +++++++++++++++++++++++++++++++++-------------
 1 file changed, 40 insertions(+), 15 deletions(-)

diff --git a/man/key_defined.3x b/man/key_defined.3x
index f0184aa77..27f4a531b 100644
--- a/man/key_defined.3x
+++ b/man/key_defined.3x
@@ -33,29 +33,54 @@
 .TH key_defined 3X 2024-03-16 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" 
"Library calls"
 .SH NAME
 \fB\%key_defined\fP \-
-test whether a \fIcurses\fR keycode is defined
+test whether a \fIcurses\fP function key code is defined
 .SH SYNOPSIS
 .nf
 \fB#include <curses.h>
 .PP
-\fBint key_defined(const char *\fIdefinition\fP);
+\fBint key_defined(const char * \fIdefinition\fP);
 .fi
 .SH DESCRIPTION
-This is an extension to the \fIcurses\fP library.
-It permits an application to determine if a string is currently bound
-to any keycode.
+The
+.B \%key_defined
+.I \%ncurses
+extension permits a
+.I curses
+application to determine the function key code,
+if any,
+to which the string
+.I definition
+is bound.
 .SH RETURN VALUE
-If the string is bound to a keycode, its value (greater than zero) is returned.
-If no keycode is bound, zero is returned.
-If the string conflicts with longer strings
-which are bound to keys, \-1 is returned.
+.B \%key_defined
+returns the first key code to which
+.I definition
+is bound if any exists.
+If none does,
+it returns
+.BR 0 "."
+If
+.I definition
+is a prefix of another binding,
+.B \%key_defined
+returns
+.BR \-1 "."
+.SH EXTENSIONS
+.B \%define_key
+is an
+.I \%ncurses
+extension.
 .SH PORTABILITY
-This routine is specific to \fI\%ncurses\fP.
-It was not supported on
-Version 7, BSD or System V implementations.
-It is recommended that
-any code depending on them be conditioned using \fB\%NCURSES_VERSION\fP.
+Applications employing
+.I \%ncurses
+extensions should condition their use on the visibility of the
+.B \%NCURSES_VERSION
+preprocessor macro.
 .SH AUTHORS
 Thomas Dickey
 .SH SEE ALSO
-\fB\%define_key\fP(3X)
+\fB\%ncurses\fP(3X),
+\fB\%define_key\fP(3X),
+\fB\%keyok\fP(3X),
+\fB\%keybound\fP(3X),
+\fB\%keyok\fP(3X)
-- 
2.30.2

signature.asc
Description: PGP signature