ncurses 6.3 - patch 20211120
[ncurses.git] / man / keybound.3x
1 .\"***************************************************************************
2 .\" Copyright 2018,2020 Thomas E. Dickey                                     *
3 .\" Copyright 1999-2008,2010 Free Software Foundation, Inc.                  *
4 .\"                                                                          *
5 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
6 .\" copy of this software and associated documentation files (the            *
7 .\" "Software"), to deal in the Software without restriction, including      *
8 .\" without limitation the rights to use, copy, modify, merge, publish,      *
9 .\" distribute, distribute with modifications, sublicense, and/or sell       *
10 .\" copies of the Software, and to permit persons to whom the Software is    *
11 .\" furnished to do so, subject to the following conditions:                 *
12 .\"                                                                          *
13 .\" The above copyright notice and this permission notice shall be included  *
14 .\" in all copies or substantial portions of the Software.                   *
15 .\"                                                                          *
16 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
17 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
18 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
19 .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
20 .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
21 .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
22 .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
23 .\"                                                                          *
24 .\" Except as contained in this notice, the name(s) of the above copyright   *
25 .\" holders shall not be used in advertising or otherwise to promote the     *
26 .\" sale, use or other dealings in this Software without prior written       *
27 .\" authorization.                                                           *
28 .\"***************************************************************************
29 .\"
30 .\" Author: Thomas E. Dickey 1999
31 .\"
32 .\" $Id: keybound.3x,v 1.11 2020/10/17 23:39:30 tom Exp $
33 .TH keybound 3X ""
34 .SH NAME
35 \fBkeybound\fP \- return definition of keycode
36 .SH SYNOPSIS
37 \fB#include <curses.h>\fP
38 .sp
39 \fBchar * keybound(int \fP\fIkeycode\fP\fB, int \fP\fIcount);\fP
40 .SH DESCRIPTION
41 This is an extension to the curses library.
42 It permits an application to determine the string which is defined
43 in the terminfo for specific keycodes.
44 .SH RETURN VALUE
45 The \fIkeycode\fP parameter must be greater than zero, else NULL is returned.
46 If it does not correspond to a defined key, then NULL is returned.
47 The \fIcount\fP parameter is used to allow the application to iterate
48 through multiple definitions, counting from zero.
49 When successful,
50 the function returns a string which must be freed by the caller.
51 .SH PORTABILITY
52 These routines are specific to ncurses.
53 They were not supported on
54 Version 7, BSD or System V implementations.
55 It is recommended that
56 any code depending on them be conditioned using NCURSES_VERSION.
57 .SH SEE ALSO
58 \fBdefine_key\fR(3X),
59 \fBkeyok\fR(3X).
60 .SH AUTHOR
61 Thomas Dickey.