Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
keybound(3X)			 Library calls			  keybound(3X)

NAME
       keybound	- get definition of a curses function key code

SYNOPSIS
       #include	<curses.h>

       char * keybound(int key-code, int count);

DESCRIPTION
       The  keybound  ncurses extension	permits	a curses application to	obtain
       the value of the	 string	 bound	to  the	 function  key	key-code;  see
       wgetch(3X)  (wide-character API users: wget_wch(3X)).  By default, such
       bindings	are string capabilities	from the terminfo database entry  cor-
       responding to the terminal type.	 The application can non-destructively
       and  repeatedly override	such definitions with define_key(3X), as if by
       pushing new definitions onto a stack.  The count	parameter accesses the
       nth most	recently defined binding; 0 selects the	binding	that  is  used
       on input.

RETURN VALUE
       If key-code corresponds to a function key defined by the	application or
       the  terminal type in use, keybound allocates and returns a string that
       must be freed by	the application.  keybound returns NULL	if key-code is
       not positive or if it does not correspond to a key code definition.

EXTENSIONS
       keybound	is an ncurses extension.

PORTABILITY
       Applications employing ncurses extensions should	condition their	use on
       the visibility of the NCURSES_VERSION preprocessor macro.

AUTHORS
       Thomas Dickey

SEE ALSO
       curses(3X), define_key(3X), keyok(3X), key_defined(3X), terminfo(5)

ncurses	6.6			  2024-12-28			  keybound(3X)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=keybound&sektion=3&manpath=FreeBSD+15.1-RELEASE+and+Ports.quarterly>

home | help