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

FreeBSD Manual Pages

  
 
  

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

NAME
       keyok - enable or disable an ncurses function key code

SYNOPSIS
       #include	<curses.h>

       int keyok(int key-code, bool bf);

DESCRIPTION
       The  keyok  ncurses extension permits a curses application to disable a
       function	key key-code returned by wgetch(3X) (wide-character API	users:
       wget_wch(3X)).  Key codes that have been	disabled  can  be  re-enabled.
       bf selects the desired enablement status.  This operation is more fine-
       grained than calling keypad(3X),	which affects all function keys.

RETURN VALUE
       keyok returns ERR if

          key-code is nonpositive,

          key-code is not a recognized	value, or

          enablement of key-code is already in	the desired state.

       Otherwise, keyok	returns	OK.

EXTENSIONS
       keyok is	an ncurses extension.

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

       NetBSD curses since 2.0 (2004) supports keyok.

AUTHORS
       Thomas Dickey

SEE ALSO
       curses(3X), define_key(3X), keybound(3X), keyok(3X), key_defined(3X)

ncurses	6.6			  2025-10-04			     keyok(3X)

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

home | help