keybound(3x) — Linux manual page
keybound(3X) keybound(3X)
NAME
keybound - return definition of keycode
SYNOPSIS
#include <curses.h>
char * keybound(int keycode, int count);
DESCRIPTION
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
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 caller.
PORTABILITY
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
define_key(3X), keyok(3X).
AUTHOR
Thomas Dickey.
COLOPHON
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
⟨https://github.com/mirror/ncurses.git⟩ on 2024-06-14. (At that
time, the date of the most recent commit that was found in the
repository was 2023-03-12.) 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