X-Git-Url: https://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fkeybound.3x.html;h=cc3ae3a14888e93a971255e3d73493c0d6ee26c4;hb=e2153a14ebfb90265151d608778aaf9f403b3d24;hp=ed1e8d59ee48f2b2f77891c4b19a7a8035686f7f;hpb=725169bda4d3b4c3fde0d4a94f76d017812c7ea6;p=ncurses.git diff --git a/doc/html/man/keybound.3x.html b/doc/html/man/keybound.3x.html index ed1e8d59..cc3ae3a1 100644 --- a/doc/html/man/keybound.3x.html +++ b/doc/html/man/keybound.3x.html @@ -28,19 +28,19 @@ * authorization. * **************************************************************************** * Author: Thomas E. Dickey 1999 - * @Id: keybound.3x,v 1.36 2024/03/16 15:35:01 tom Exp @ + * @Id: keybound.3x,v 1.40 2024/06/08 23:25:57 tom Exp @ -->
-keybound(3x) Library calls keybound(3x) @@ -48,33 +48,41 @@
- keybound - get definition of curses keycode + keybound - get definition of a curses function key code
#include <curses.h> - char * keybound(int keycode, int count); + char * keybound(int key-code, int count);
- 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.
- 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. + 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. + + +
+ keybound is an ncurses extension.
- This routine is specific to ncurses. It was 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.
@@ -82,11 +90,11 @@
- define_key(3x), keyok(3x) + curses(3x), define_key(3x), keyok(3x), key_defined(3x), terminfo(5) -ncurses 6.4 2024-03-16 keybound(3x) +ncurses 6.5 2024-06-08 keybound(3x)