ncurses 6.5 - patch 20240518

[ncurses.git] / man / key_defined.3x

diff --git a/man/key_defined.3x b/man/key_defined.3x
index f0184aa77df170411e248dceacdcefd17b478bb2..f5d9b4474bb6d641019644d094d6584592cbcabf 100644 (file)
--- a/man/key_defined.3x
+++ b/man/key_defined.3x
@@ -29,33 +29,58 @@
 .\"
 .\" Author: Thomas E. Dickey 2003
 .\"
-.\" $Id: key_defined.3x,v 1.34 2024/03/16 15:35:01 tom Exp $
-.TH key_defined 3X 2024-03-16 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls"
+.\" $Id: key_defined.3x,v 1.36 2024/05/18 20:04:53 tom Exp $
+.TH key_defined 3X 2024-05-18 "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)