X-Git-Url: http://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fdefine_key.3x.html;h=ad69c118524fb13340cda4b6752822cd158be6dc;hb=bd2d9c5734d2c66abe0b2ddd766695b200c154fe;hp=cbb11d0d678849fd68c4888f18c66d31dc25374b;hpb=ed646e3f683083e787c6ba773364401dc9fa9d40;p=ncurses.git diff --git a/doc/html/man/define_key.3x.html b/doc/html/man/define_key.3x.html index cbb11d0d..ad69c118 100644 --- a/doc/html/man/define_key.3x.html +++ b/doc/html/man/define_key.3x.html @@ -1,6 +1,7 @@ - - -define_key 3x - - + +define_key 3x 2023-12-16 ncurses 6.4 Library calls + + -

define_key 3x

define_key 3x 2023-12-16 ncurses 6.4 Library calls

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

NAME

-       define_key - define a keycode
+       define_key - define a curses keycode

SYNOPSIS

        #include <curses.h>
 
-       int define_key(const char *definition, int keycode);
+       int define_key(const char *definition, int keycode);

DESCRIPTION

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

RETURN VALUE

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

PORTABILITY

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

AUTHORS

+       Thomas Dickey
 
 
-

AUTHOR

-       Thomas Dickey.
+