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=df5fd13fcbfb5cabfe35ddd70fa46660e83aa7ab;hb=HEAD;hpb=6208c89f98f1cf9fe0980bd8e791846ce007a13d diff --git a/doc/html/man/define_key.3x.html b/doc/html/man/define_key.3x.html index df5fd13f..d135e310 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 2024-03-16 ncurses 6.5 Library calls + + -

define_key 3x

+

define_key 3x 2024-03-16 ncurses 6.5 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 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.

RETURN VALUE

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

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

SEE ALSO

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

AUTHORS

+       Thomas Dickey
 
 
-

AUTHOR

-       Thomas Dickey.
+

SEE ALSO

+       keyok(3x), key_defined(3x)
 
 
 
-                                                         define_key(3x)
+ncurses 6.5                       2024-03-16                    define_key(3x)