X-Git-Url: http://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fkeybound.3x.html;h=942e3a7b2f0c833d9aff238e6db4fa6fe38490cd;hb=HEAD;hp=bebbadd4405e6bbb391d03b72a65bf10c5f68fc7;hpb=cb4427a16794d98049b4d790b810d62217501f9f;p=ncurses.git diff --git a/doc/html/man/keybound.3x.html b/doc/html/man/keybound.3x.html index bebbadd4..c61af21a 100644 --- a/doc/html/man/keybound.3x.html +++ b/doc/html/man/keybound.3x.html @@ -1,6 +1,7 @@ - -keybound 3x +keybound 3x 2024-05-18 ncurses 6.5 Library calls - + -

keybound 3x

keybound 3x 2024-05-18 ncurses 6.5 Library calls

-keybound(3x)                                                      keybound(3x)
+keybound(3x)                     Library calls                    keybound(3x)

NAME

-       keybound - return definition of keycode
+       keybound - get definition of a curses function key code

SYNOPSIS

        #include <curses.h>
 
-       char * keybound(int keycode, int count);
+       char * keybound(int key-code, 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.
+       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
+       corresponding   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

-       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  func-
-       tion returns a string which must be freed by the caller.
+       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

-       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.
+       Applications employing ncurses extensions should condition their use on
+       the visibility of the NCURSES_VERSION preprocessor macro.
 
 
-

AUTHORS

+       Thomas Dickey
 
 
-

AUTHOR

-       Thomas Dickey.
+