X-Git-Url: http://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fkeybound.3x.html;h=551376227b24be690896f7085331fce483f86fbe;hb=HEAD;hp=8275428587c217f277a4ba21766287b9afaccdfe;hpb=761e4f0825b330e970558e82a4bd638383914429;p=ncurses.git diff --git a/doc/html/man/keybound.3x.html b/doc/html/man/keybound.3x.html index 82754285..cc3ae3a1 100644 --- a/doc/html/man/keybound.3x.html +++ b/doc/html/man/keybound.3x.html @@ -1,7 +1,7 @@ - - + -keybound 3x - - + + +keybound 3x 2024-06-08 ncurses 6.5 Library calls + + -

keybound 3x

-
+

keybound 3x 2024-06-08 ncurses 6.5 Library calls

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

NAME

-       keybound - return definition of keycode
+

NAME

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

SYNOPSIS

+

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.
+

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
+       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  defini-
-       tions,  counting from zero.  When successful, the function
-       returns a string which must be freed by the caller.
+

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.
 
 
-
-

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  con-
-       ditioned using NCURSES_VERSION.
+

EXTENSIONS

+       keybound is an ncurses extension.
 
 
-
-

SEE ALSO

-       define_key(3x), keyok(3x).
+

PORTABILITY

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

AUTHOR

-       Thomas Dickey.
+

AUTHORS

+       Thomas Dickey
+
+
+

SEE ALSO

+       curses(3x), define_key(3x), keyok(3x), key_defined(3x), terminfo(5)
 
 
 
-                                                           keybound(3x)
+ncurses 6.5                       2024-06-08                      keybound(3x)
-
-
-Man(1) output converted with -man2html -
+
+ +