| 1 | .\"***************************************************************************
|
|---|
| 2 | .\" Copyright (c) 1998-2003,2004 Free Software Foundation, Inc. *
|
|---|
| 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 | .\"
|
|---|
| 31 | .\" $Id: define_key.3x,v 1.11 2004/06/05 19:20:03 tom Exp $
|
|---|
| 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 |
|
|---|
| 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
|
|---|
| 50 | The keycode must be greater than zero, else ERR is returned.
|
|---|
| 51 | .SH PORTABILITY
|
|---|
| 52 | These routines are specific to ncurses. They were not supported on
|
|---|
| 53 | Version 7, BSD or System V implementations. It is recommended that
|
|---|
| 54 | any code depending on them be conditioned using NCURSES_VERSION.
|
|---|
| 55 | .SH SEE ALSO
|
|---|
| 56 | \fBkeyok\fR(3X),
|
|---|
| 57 | \fBkey_defined\fR(3X).
|
|---|
| 58 | .SH AUTHOR
|
|---|
| 59 | Thomas Dickey.
|
|---|
| 60 | .\"#
|
|---|
| 61 | .\"# The following sets edit modes for GNU EMACS
|
|---|
| 62 | .\"# Local Variables:
|
|---|
| 63 | .\"# mode:nroff
|
|---|
| 64 | .\"# fill-column:79
|
|---|
| 65 | .\"# End:
|
|---|
