keyok(3x) — Linux manual page

NAME | SYNOPSIS | DESCRIPTION | RETURN VALUE | PORTABILITY | SEE ALSO | AUTHOR | COLOPHON

keyok(3X)                                                      keyok(3X)

NAME         top

       keyok - enable or disable a keycode

SYNOPSIS         top

       #include <curses.h>

       int keyok(int keycode, bool enable);

DESCRIPTION         top

       This is an extension to the curses library.  It permits an
       application to disable specific keycodes, rather than use the
       keypad function to disable all keycodes.  Keys that have been
       disabled can be re-enabled.

RETURN VALUE         top

       The keycode must be greater than zero, else ERR is returned.  If
       it does not correspond to a defined key, then ERR is returned.
       If the enable parameter is true, then the key must have been
       disabled, and vice versa.  Otherwise, the function returns OK.

PORTABILITY         top

       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.

SEE ALSO         top

       define_key(3X).

AUTHOR         top

       Thomas Dickey.

COLOPHON         top

       This page is part of the ncurses (new curses) project.
       Information about the project can be found at 
       ⟨https://www.gnu.org/software/ncurses/ncurses.html⟩.  If you have
       a bug report for this manual page, send it to
       bug-ncurses-request@gnu.org.  This page was obtained from the
       project's upstream Git mirror of the CVS repository
       ⟨git://ncurses.scripts.mit.edu/ncurses.git⟩ on 2021-08-27.  (At
       that time, the date of the most recent commit that was found in
       the repository was 2021-05-23.)  If you discover any rendering
       problems in this HTML version of the page, or you believe there
       is a better or more up-to-date source for the page, or you have
       corrections or improvements to the information in this COLOPHON
       (which is not part of the original manual page), send a mail to
       man-pages@man7.org

                                                               keyok(3X)