X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fdefine_key.3x.html;h=73332600044b708a779634a0238575fca3bc83e9;hp=47aa7ac3a3aabe7737f5713fa96f142b6128ac1d;hb=HEAD;hpb=e5d1530ca229aef94a3c84ad33f8ae89f35c4045 diff --git a/doc/html/man/define_key.3x.html b/doc/html/man/define_key.3x.html index 47aa7ac3..d135e310 100644 --- a/doc/html/man/define_key.3x.html +++ b/doc/html/man/define_key.3x.html @@ -1,6 +1,6 @@ -
--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 + 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 + 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, other- - wise ERR is returned. ERR may also be returned if there is insuffi- - cient 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 + 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. + code depending on them be conditioned using NCURSES_VERSION. -
- keyok(3x), key_defined(3x). +
+ Thomas Dickey -
- Thomas Dickey. +
+ keyok(3x), key_defined(3x) - define_key(3x) +ncurses 6.5 2024-03-16 define_key(3x)