ncurses 6.5 - patch 20240615

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

diff --git a/man/key_defined.3x b/man/key_defined.3x
index d78b6ffc28a1ec5fd8c8b02d90ff32d1412ec630..c1e401ae8add7541d160af0ed5e38b075769d389 100644 (file)
--- a/man/key_defined.3x
+++ b/man/key_defined.3x
@@ -1,5 +1,6 @@
 .\"***************************************************************************
 .\"***************************************************************************

-.\" Copyright (c) 2003-2010,2018 Free Software Foundation, Inc.              *
+.\" 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  *
 .\" copy of this software and associated documentation files (the            *
 .\"                                                                          *
 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
 .\" copy of this software and associated documentation files (the            *


@@ -28,30 +29,57 @@
 .\"
 .\" Author: Thomas E. Dickey 2003
 .\"
 .\"
 .\" Author: Thomas E. Dickey 2003
 .\"

-.\" $Id: key_defined.3x,v 1.8 2018/07/28 22:08:59 tom Exp $
-.TH key_defined 3X ""
+.\" $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
 .SH NAME

-\fBkey_defined\fP \- check if a keycode is defined
+\fB\%key_defined\fP \-
+test whether a \fIcurses\fP function key code is defined

 .SH SYNOPSIS
 .SH SYNOPSIS

-\fB#include <curses.h>\fP
-.sp
-\fBint key_defined(const char *definition);\fP
+.nf
+\fB#include <curses.h>
+.PP
+\fBint key_defined(const char * \fIdefinition\fP);
+.fi

 .SH DESCRIPTION
 .SH DESCRIPTION

-This is an extension to the curses 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
 .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
 .SH PORTABILITY

-These routines are specific to ncurses.
-They were not supported on
-Version 7, BSD or System V implementations.
-It is recommended that
-any code depending on them be conditioned using NCURSES_VERSION.
+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
 .SH SEE ALSO

-\fBdefine_key\fR(3X).
-.SH AUTHOR
-Thomas Dickey.
+\fB\%curses\fP(3X),
+\fB\%define_key\fP(3X),
+\fB\%keybound\fP(3X),
+\fB\%keyok\fP(3X)