X-Git-Url: http://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=man%2Fkey_defined.3x;h=d190c7909931a7dc08b7adfef22cb1c318f8f3ef;hb=HEAD;hp=31131541883edbfc6f5269714c3068fb08a26d19;hpb=084e3b44fc1c904d5ab941da55f47a237cb15766;p=ncurses.git

diff --git a/man/key_defined.3x b/man/key_defined.3x
index 31131541..c1e401ae 100644
--- a/man/key_defined.3x
+++ b/man/key_defined.3x
@@ -1,5 +1,5 @@
 .\"***************************************************************************
-.\" Copyright 2018-2022,2023 Thomas E. Dickey                                *
+.\" Copyright 2018-2023,2024 Thomas E. Dickey                                *
 .\" Copyright 2003-2006,2010 Free Software Foundation, Inc.                  *
 .\"                                                                          *
 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
@@ -29,33 +29,57 @@
 .\"
 .\" Author: Thomas E. Dickey 2003
 .\"
-.\" $Id: key_defined.3x,v 1.31 2023/11/25 14:26:30 tom Exp $
-.TH key_defined 3X 2023-11-25 "ncurses 6.4" "Library calls"
+.\" $Id: key_defined.3x,v 1.38 2024/06/08 23:25:34 tom Exp $
+.TH key_defined 3X 2024-06-08 "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 \fIncurses\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\%curses\fP(3X),
+\fB\%define_key\fP(3X),
+\fB\%keybound\fP(3X),
+\fB\%keyok\fP(3X)