| .\"*************************************************************************** |
| .\" Copyright (c) 1998-2009,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 * |
| .\" "Software"), to deal in the Software without restriction, including * |
| .\" without limitation the rights to use, copy, modify, merge, publish, * |
| .\" distribute, distribute with modifications, sublicense, and/or sell * |
| .\" copies of the Software, and to permit persons to whom the Software is * |
| .\" furnished to do so, subject to the following conditions: * |
| .\" * |
| .\" The above copyright notice and this permission notice shall be included * |
| .\" in all copies or substantial portions of the Software. * |
| .\" * |
| .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * |
| .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * |
| .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * |
| .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * |
| .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * |
| .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * |
| .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE. * |
| .\" * |
| .\" Except as contained in this notice, the name(s) of the above copyright * |
| .\" holders shall not be used in advertising or otherwise to promote the * |
| .\" sale, use or other dealings in this Software without prior written * |
| .\" authorization. * |
| .\"*************************************************************************** |
| .\" |
| .\" Author: Thomas E. Dickey 1997 |
| .\" |
| .\" $Id: define_key.3x,v 1.14 2010/12/04 18:49:20 tom Exp $ |
| .TH define_key 3X "" |
| .SH NAME |
| \fBdefine_key\fP \- define a keycode |
| .SH SYNOPSIS |
| \fB#include <curses.h>\fP |
| .sp |
| \fBint define_key(const char *definition, int keycode);\fP |
| .SH DESCRIPTION |
| This is an extension to the curses library. |
| It permits an application to define keycodes with their corresponding control |
| strings, so that the ncurses library will interpret them just as it would |
| the predefined codes in the terminfo database. |
| .PP |
| If the given string is null, any existing definition for the keycode is |
| removed. |
| Similarly, if the given keycode is negative or zero, any existing string |
| for the given definition is removed. |
| .SH RETURN VALUE |
| The keycode must be greater than zero, and the string non-null, |
| otherwise ERR is returned. |
| ERR may also be returned if there is insufficient memory to allocate the |
| data to store the definition. |
| If no error is detected, OK 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. |
| .SH SEE ALSO |
| \fBkeyok\fR(3X), |
| \fBkey_defined\fR(3X). |
| .SH AUTHOR |
| Thomas Dickey. |
