1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
3 ****************************************************************************
4 * Copyright (c) 1998,2002 Free Software Foundation, Inc. *
6 * Permission is hereby granted, free of charge, to any person obtaining a *
7 * copy of this software and associated documentation files (the *
8 * "Software"), to deal in the Software without restriction, including *
9 * without limitation the rights to use, copy, modify, merge, publish, *
10 * distribute, distribute with modifications, sublicense, and/or sell *
11 * copies of the Software, and to permit persons to whom the Software is *
12 * furnished to do so, subject to the following conditions: *
14 * The above copyright notice and this permission notice shall be included *
15 * in all copies or substantial portions of the Software. *
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
18 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
19 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
20 * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
21 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
22 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
23 * THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
25 * Except as contained in this notice, the name(s) of the above copyright *
26 * holders shall not be used in advertising or otherwise to promote the *
27 * sale, use or other dealings in this Software without prior written *
29 ****************************************************************************
30 * Author: Thomas E. Dickey <dickey@clark.net> 1997
31 * @Id: define_key.3x,v 1.8 2002/02/16 22:39:52 tom Exp @
35 <TITLE>define_key 3x</TITLE>
36 <link rev=made href="mailto:bug-ncurses@gnu.org">
37 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
40 <H1>define_key 3x</H1>
43 <!-- Manpage converted by man2html 3.0.1 -->
47 <STRONG>define_key</STRONG> - define a keycode
51 <H2>SYNOPSIS</H2><PRE>
52 <STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
54 <STRONG>int</STRONG> <STRONG>define_key(char</STRONG> <STRONG>*definition,</STRONG> <STRONG>int</STRONG> <STRONG>keycode);</STRONG>
58 <H2>DESCRIPTION</H2><PRE>
59 This is an extension to the curses library. It permits an
60 application to define keycodes with their corresponding
61 control strings, so that the ncurses library will inter-
62 pret them just as it would the predefined codes in the
65 If the given string is null, any existing definition for
66 the keycode is removed. Similarly, if the given keycode
67 is negative or zero, any existing string for the given
68 definition is removed.
72 <H2>RETURN VALUE</H2><PRE>
73 The keycode must be greater than zero, else ERR is
78 <H2>PORTABILITY</H2><PRE>
79 These routines are specific to ncurses. They were not
80 supported on Version 7, BSD or System V implementations.
81 It is recommended that any code depending on them be con-
82 ditioned using NCURSES_VERSION.
86 <H2>SEE ALSO</H2><PRE>
87 <STRONG><A HREF="keyok.3x.html">keyok(3x)</A></STRONG>.
115 Man(1) output converted with
116 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>