X-Git-Url: https://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=man%2Fkey_defined.3x;h=26bf537505c42e85041d4018407d8447bfe543b2;hb=bd2d9c5734d2c66abe0b2ddd766695b200c154fe;hp=d7413da6fe35cbd42576afc98eb588b603862d97;hpb=027ae42953e3186daed8f3882da73de48291b606;p=ncurses.git diff --git a/man/key_defined.3x b/man/key_defined.3x index d7413da6..26bf5375 100644 --- a/man/key_defined.3x +++ b/man/key_defined.3x @@ -1,5 +1,6 @@ .\"*************************************************************************** -.\" Copyright (c) 2003-2004,2006 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 * @@ -28,33 +29,33 @@ .\" .\" Author: Thomas E. Dickey 2003 .\" -.\" $Id: key_defined.3x,v 1.4 2006/02/25 21:50:01 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 *definition);\fP +.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 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 -any code depending on them be conditioned using NCURSES_VERSION. +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. +.SH AUTHORS +Thomas Dickey .SH SEE ALSO -\fBdefine_key\fR(3X). -.SH AUTHOR -Thomas Dickey. -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: +\fB\%define_key\fP(3X)