| Amit Daniel Kachhap | e6a01f5 | 2011-07-20 11:45:59 +0530 | [diff] [blame] | 1 | .\"*************************************************************************** |
| Steve Kondik | ae271bc | 2015-11-15 02:50:53 +0100 | [diff] [blame] | 2 | .\" Copyright (c) 1998-2009,2010 Free Software Foundation, Inc. * |
| Amit Daniel Kachhap | e6a01f5 | 2011-07-20 11:45:59 +0530 | [diff] [blame] | 3 | .\" * |
| 4 | .\" Permission is hereby granted, free of charge, to any person obtaining a * |
| 5 | .\" copy of this software and associated documentation files (the * |
| 6 | .\" "Software"), to deal in the Software without restriction, including * |
| 7 | .\" without limitation the rights to use, copy, modify, merge, publish, * |
| 8 | .\" distribute, distribute with modifications, sublicense, and/or sell * |
| 9 | .\" copies of the Software, and to permit persons to whom the Software is * |
| 10 | .\" furnished to do so, subject to the following conditions: * |
| 11 | .\" * |
| 12 | .\" The above copyright notice and this permission notice shall be included * |
| 13 | .\" in all copies or substantial portions of the Software. * |
| 14 | .\" * |
| 15 | .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * |
| 16 | .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * |
| 17 | .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * |
| 18 | .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * |
| 19 | .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * |
| 20 | .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * |
| 21 | .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE. * |
| 22 | .\" * |
| 23 | .\" Except as contained in this notice, the name(s) of the above copyright * |
| 24 | .\" holders shall not be used in advertising or otherwise to promote the * |
| 25 | .\" sale, use or other dealings in this Software without prior written * |
| 26 | .\" authorization. * |
| 27 | .\"*************************************************************************** |
| 28 | .\" |
| 29 | .\" Author: Thomas E. Dickey 1997 |
| 30 | .\" |
| Steve Kondik | ae271bc | 2015-11-15 02:50:53 +0100 | [diff] [blame] | 31 | .\" $Id: define_key.3x,v 1.14 2010/12/04 18:49:20 tom Exp $ |
| Amit Daniel Kachhap | e6a01f5 | 2011-07-20 11:45:59 +0530 | [diff] [blame] | 32 | .TH define_key 3X "" |
| 33 | .SH NAME |
| 34 | \fBdefine_key\fP \- define a keycode |
| 35 | .SH SYNOPSIS |
| 36 | \fB#include <curses.h>\fP |
| 37 | .sp |
| 38 | \fBint define_key(const char *definition, int keycode);\fP |
| 39 | .SH DESCRIPTION |
| 40 | This is an extension to the curses library. |
| 41 | It permits an application to define keycodes with their corresponding control |
| 42 | strings, so that the ncurses library will interpret them just as it would |
| 43 | the predefined codes in the terminfo database. |
| 44 | .PP |
| 45 | If the given string is null, any existing definition for the keycode is |
| 46 | removed. |
| 47 | Similarly, if the given keycode is negative or zero, any existing string |
| 48 | for the given definition is removed. |
| 49 | .SH RETURN VALUE |
| Steve Kondik | ae271bc | 2015-11-15 02:50:53 +0100 | [diff] [blame] | 50 | The keycode must be greater than zero, and the string non-null, |
| 51 | otherwise ERR is returned. |
| 52 | ERR may also be returned if there is insufficient memory to allocate the |
| 53 | data to store the definition. |
| 54 | If no error is detected, OK is returned. |
| Amit Daniel Kachhap | e6a01f5 | 2011-07-20 11:45:59 +0530 | [diff] [blame] | 55 | .SH PORTABILITY |
| 56 | These routines are specific to ncurses. They were not supported on |
| 57 | Version 7, BSD or System V implementations. It is recommended that |
| 58 | any code depending on them be conditioned using NCURSES_VERSION. |
| 59 | .SH SEE ALSO |
| 60 | \fBkeyok\fR(3X), |
| 61 | \fBkey_defined\fR(3X). |
| 62 | .SH AUTHOR |
| 63 | Thomas Dickey. |