X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fdefine_key.3x.html;h=2dd46c898052b9b3679fd57803e56ccc87b306ed;hp=7e914c7e0388dae045ffdae53624c0acc5c13279;hb=761e4f0825b330e970558e82a4bd638383914429;hpb=b1f61d9f3aa244512045a6b02e759825d7049d34 diff --git a/doc/html/man/define_key.3x.html b/doc/html/man/define_key.3x.html index 7e914c7e..2dd46c89 100644 --- a/doc/html/man/define_key.3x.html +++ b/doc/html/man/define_key.3x.html @@ -1,18 +1,61 @@ + + + +define_key 3x + + + +

define_key 3x

+
 
+define_key(3x)                                           define_key(3x)
+
+
+

NAME

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

SYNOPSIS

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

RETURN VALUE

-       The keycode  must  be  greater  than  zero,  else  ERR  is
+       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.

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

SEE ALSO

-       keyok(3x).
+       keyok(3x), key_defined(3x).
@@ -54,22 +100,7 @@ - - - - - - - - - - - - - - - - + define_key(3x)