X-Git-Url: https://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=man%2Fkey_defined.3x;h=26bf537505c42e85041d4018407d8447bfe543b2;hb=bd2d9c5734d2c66abe0b2ddd766695b200c154fe;hp=d190c7909931a7dc08b7adfef22cb1c318f8f3ef;hpb=16fbf3f4f7d96b6ee6bf9159b22f26e05962aa3d;p=ncurses.git diff --git a/man/key_defined.3x b/man/key_defined.3x index d190c790..26bf5375 100644 --- a/man/key_defined.3x +++ b/man/key_defined.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright 2018-2021,2022 Thomas E. Dickey * +.\" 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 * @@ -29,16 +29,19 @@ .\" .\" Author: Thomas E. Dickey 2003 .\" -.\" $Id: key_defined.3x,v 1.13 2022/02/12 20:03:40 tom Exp $ -.TH key_defined 3X "" +.\" $Id: key_defined.3x,v 1.32 2023/12/16 20:32:22 tom Exp $ +.TH key_defined 3X 2023-12-16 "ncurses 6.4" "Library calls" .SH NAME -\fBkey_defined\fP \- check if a keycode is defined +\fB\%key_defined\fP \- +test whether a \fIcurses\fR keycode is defined .SH SYNOPSIS -\fB#include \fP -.sp -\fBint key_defined(const char *\fIdefinition\fB);\fR +.nf +\fB#include +.PP +\fBint key_defined(const char *\fIdefinition\fP); +.fi .SH DESCRIPTION -This is an extension to the curses library. +This is an extension to the \fIcurses\fP library. It permits an application to determine if a string is currently bound to any keycode. .SH RETURN VALUE @@ -47,12 +50,12 @@ If no keycode is bound, zero 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 +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 NCURSES_VERSION. +any code depending on them be conditioned using \fB\%NCURSES_VERSION\fP. +.SH AUTHORS +Thomas Dickey .SH SEE ALSO -\fBdefine_key\fP(3X). -.SH AUTHOR -Thomas Dickey. +\fB\%define_key\fP(3X)