This manual page is for Mac OS X version 10.6

If you are running a different version of Mac OS X, view the documentation locally:

  • In Terminal, using the man(1) command

Reading manual pages

Manual pages are intended as a quick reference for people who already understand a technology.

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

  • For more information about this technology, look for other documentation in the Apple Reference Library.

  • For general information about writing shell scripts, read Shell Scripting Primer.


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)

Reporting Problems

The way to report a problem with this manual page depends on the type of problem:

Content errors
Report errors in the content of this documentation with the feedback links below.
Bug reports
Report bugs in the functionality of the described tool or API through Bug Reporter.
Formatting problems
Report formatting mistakes in the online version of these pages with the feedback links below.