X-Git-Url: http://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fdefine_key.3x.html;h=ac1f581eadd0a45dd87c5435b59ff92c74bc77c8;hb=0eedaa5673ff8181abe51e3a6fadca3820f90c46;hp=350b0b93b00537d883240beb267635d23e4b4b8f;hpb=b0b1980be11bba618d84beb8b30ac94e2c820602;p=ncurses.git diff --git a/doc/html/man/define_key.3x.html b/doc/html/man/define_key.3x.html index 350b0b93..ac1f581e 100644 --- a/doc/html/man/define_key.3x.html +++ b/doc/html/man/define_key.3x.html @@ -1,7 +1,7 @@ - - +
-- -define_key(3x) define_key(3x) +define_key(3x) Library calls define_key(3x) --
- define_key - define a keycode +
+ define_key - define a curses keycode --
+
#include <curses.h> - int define_key(const char *definition, int keycode); + int define_key(const char *definition, int keycode); --
- This is an extension to the curses library. It permits an - application to define keycodes with their corresponding - control strings, so that the ncurses library will inter- - pret them just as it would the predefined codes in the - terminfo database. +
+ This is an extension to the curses library. It permits an application + to define keycodes with their corresponding control strings, so that + the ncurses library will interpret them just as it would the predefined + codes in the terminfo database. - If the given string is null, any existing definition for - the keycode is removed. Similarly, if the given keycode - is negative or zero, any existing string for the given - definition is removed. + If definition is NULL, any existing one for the keycode is removed. + Similarly, if the given keycode is negative or zero, any existing + string for the given definition is removed. --
- The keycode must be greater than zero, and the string non- - null, otherwise ERR is returned. ERR may also be returned - if there is insufficient memory to allocate the data to - store the definition. If no error is detected, OK is - returned. +
+ Either keycode must be greater than zero, or definition must be non- + NULL, otherwise ERR is returned. ERR may also be returned if there is + insufficient memory to allocate the data to store the definition. If + no error is detected, OK is returned. --
- 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. +
+ 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. --
- keyok(3x), key_defined(3x). +
+ keyok(3x), key_defined(3x) --
- Thomas Dickey. +
+ Thomas Dickey - define_key(3x) +ncurses 6.4 2023-09-23 define_key(3x)-