ncurses 6.2 - patch 20210109
[ncurses.git] / man / define_key.3x
1 .\"***************************************************************************
2 .\" Copyright 2018,2020 Thomas E. Dickey                                     *
3 .\" Copyright 1998-2010,2017 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 1997
31 .\"
32 .\" $Id: define_key.3x,v 1.18 2020/10/24 09:52:54 tom Exp $
33 .TH define_key 3X ""
34 .SH NAME
35 \fBdefine_key\fP \- define a keycode
36 .SH SYNOPSIS
37 \fB#include <curses.h>\fP
38 .sp
39 \fBint define_key(const char *\fP\fIdefinition\fP\fB, int \fP\fIkeycode\fP\fB);\fP
40 .SH DESCRIPTION
41 This is an extension to the curses library.
42 It permits an application to define keycodes with their corresponding control
43 strings, so that the ncurses library will interpret them just as it would
44 the predefined codes in the terminfo database.
45 .PP
46 If the given string is null, any existing definition for the keycode is
47 removed.
48 Similarly, if the given keycode is negative or zero, any existing string
49 for the given definition is removed.
50 .SH RETURN VALUE
51 The keycode must be greater than zero, and the string non-null,
52 otherwise \fBERR\fP is returned.
53 \fBERR\fP may also be returned if there is insufficient memory to allocate the
54 data to store the definition.
55 If no error is detected, \fBOK\fP is returned.
56 .SH PORTABILITY
57 These routines are specific to ncurses.
58 They were not supported on
59 Version 7, BSD or System V implementations.
60 It is recommended that
61 any code depending on them be conditioned using NCURSES_VERSION.
62 .SH SEE ALSO
63 \fBkeyok\fR(3X),
64 \fBkey_defined\fR(3X).
65 .SH AUTHOR
66 Thomas Dickey.