.\"***************************************************************************
-.\" Copyright (c) 2003 Free Software Foundation, Inc. *
+.\" Copyright 2018-2022,2023 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 *
.\"
.\" Author: Thomas E. Dickey 2003
.\"
-.\" $Id: key_defined.3x,v 1.2 2003/05/17 23:24:45 tom Exp $
-.TH key_defined 3X ""
+.\" $Id: key_defined.3x,v 1.20 2023/09/16 23:38:39 tom Exp $
+.TH key_defined 3X 2023-09-16 "ncurses 6.4" "Library calls"
.SH NAME
-\fBdefine_key\fP \- define a keycode
+\fB\%key_defined\fP \-
+test whether a \fIcurses\fR keycode is defined
.SH SYNOPSIS
\fB#include <curses.h>\fP
-
-\fBint key_defined(const char *definition);\fP
+.sp
+\fBint key_defined(const char *\fIdefinition\fB);\fR
.SH DESCRIPTION
This is an extension to the curses library.
It permits an application to determine if a string is currently 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.
+If the string conflicts with longer strings
+which are bound to keys, \-1 is returned.
.SH PORTABILITY
-These routines are specific to ncurses. They were not supported on
-Version 7, BSD or System V implementations. It is recommended that
+This routine is specific to ncurses.
+It was not supported on
+Version 7, BSD or System V implementations.
+It is recommended that
any code depending on them be conditioned using NCURSES_VERSION.
.SH SEE ALSO
-\fBdefine_key\fR(3X).
+\fBdefine_key\fP(3X).
.SH AUTHOR
Thomas Dickey.
-.\"#
-.\"# The following sets edit modes for GNU EMACS
-.\"# Local Variables:
-.\"# mode:nroff
-.\"# fill-column:79
-.\"# End:
projects / ncurses.git / blobdiff