This document is a Mac OS X manual page. Manual pages are a command-line technology for providing documentation. You can view these manual pages locally using the man(1) command. These manual pages come from many different sources, and thus, have a variety of writing styles.

For more information about the manual page format, see the manual page for manpages(5).

define_key(3X)                                                                                define_key(3X)



NAME
       define_key - define a keycode

SYNOPSIS
       #include <curses.h>

       int define_key(const char *definition, int keycode);

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.

       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.

RETURN VALUE
       The keycode must be greater than zero, else ERR is returned.

PORTABILITY
       These routines are specific to ncurses.  They were not supported on Version 7, BSD or System V imple-mentations. implementations.
       mentations.   It is recommended that any code depending on them be conditioned using NCURSES_VERSION.

SEE ALSO
       keyok(3X), key_defined(3X).

AUTHOR
       Thomas Dickey.



                                                                                              define_key(3X)