ncurses 5.7 - patch 20100731
[ncurses.git] / man / define_key.3x
index 79a82052e3bf2b158569448099c92ee18d786a7d..d87b8f572f0bcb381f170f12f0b1070ead218d1f 100644 (file)
@@ -1,5 +1,5 @@
 .\"***************************************************************************
 .\"***************************************************************************
-.\" Copyright (c) 1998 Free Software Foundation, Inc.                        *
+.\" Copyright (c) 1998-2006,2009 Free Software Foundation, Inc.              *
 .\"                                                                          *
 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
 .\" copy of this software and associated documentation files (the            *
 .\"                                                                          *
 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
 .\" copy of this software and associated documentation files (the            *
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
-.\" Author: Thomas E. Dickey <dickey@clark.net> 1997
+.\" Author: Thomas E. Dickey 1997
 .\"
 .\"
-.\" $Id: define_key.3x,v 1.4 1998/02/11 12:13:48 tom Exp $
+.\" $Id: define_key.3x,v 1.13 2009/09/19 21:09:35 tom Exp $
 .TH define_key 3X ""
 .TH define_key 3X ""
-.
 .SH NAME
 \fBdefine_key\fP \- define a keycode
 .SH NAME
 \fBdefine_key\fP \- define a keycode
-.
 .SH SYNOPSIS
 \fB#include <curses.h>\fP
 .SH SYNOPSIS
 \fB#include <curses.h>\fP
-
-\fBint define_key(char *definition, int keycode);\fP
-.
+.sp
+\fBint define_key(const char *definition, int keycode);\fP
 .SH DESCRIPTION
 This is an extension to the curses library.
 It permits an application to define keycodes with their corresponding control
 .SH DESCRIPTION
 This is an extension to the curses library.
 It permits an application to define keycodes with their corresponding control
@@ -47,18 +44,21 @@ the predefined codes in the terminfo database.
 .PP
 If the given string is null, any existing definition for the keycode is
 removed.
 .PP
 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.
 .SH RETURN VALUE
 .SH RETURN VALUE
-The keycode must be greater than zero, else ERR is returned.
-.
+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.
 .SH 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 conditioned using NCURSES_VERSION.
 .SH 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 conditioned using NCURSES_VERSION.
-.
 .SH SEE ALSO
 .SH SEE ALSO
-\fBkeyok\fR(3X).
-.
+\fBkeyok\fR(3X),
+\fBkey_defined\fR(3X).
 .SH AUTHOR
 Thomas Dickey.
 .\"#
 .SH AUTHOR
 Thomas Dickey.
 .\"#