keybound(3X)                                                    keybound(3X)

NAME         top

       keybound - return definition of keycode

SYNOPSIS         top

       #include <curses.h>

       char * keybound(int keycode, int count);

DESCRIPTION         top

       This is an extension to the curses library.  It permits an
       application to determine the string which is defined in the terminfo
       for specific keycodes.

RETURN VALUE         top

       The keycode parameter must be greater than zero, else NULL is
       returned.  If it does not correspond to a defined key, then NULL is
       returned.  The count parameter is used to allow the application to
       iterate through multiple definitions, counting from zero.  When
       successful, the function returns a string which must be freed by the

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), keyok(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 
       ⟨⟩.  If you have a
       bug report for this manual page, send it to  This page was obtained from the
       project's upstream Git mirror of the CVS repository 
       ⟨git://⟩ on 2017-03-13.  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