ncurses 5.3
[ncurses.git] / man / define_key.3x
index 79a82052e3bf2b158569448099c92ee18d786a7d..1019c42fd770def5bcaff3425df63aef74fb598b 100644 (file)
@@ -1,5 +1,5 @@
 .\"***************************************************************************
-.\" Copyright (c) 1998 Free Software Foundation, Inc.                        *
+.\" Copyright (c) 1998,2002 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            *
 .\"
 .\" Author: Thomas E. Dickey <dickey@clark.net> 1997
 .\"
-.\" $Id: define_key.3x,v 1.4 1998/02/11 12:13:48 tom Exp $
+.\" $Id: define_key.3x,v 1.8 2002/02/16 22:39:52 tom Exp $
 .TH define_key 3X ""
-.
 .SH NAME
 \fBdefine_key\fP \- define a keycode
-.
 .SH SYNOPSIS
 \fB#include <curses.h>\fP
 
 \fBint define_key(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
@@ -47,18 +44,16 @@ the predefined codes in the terminfo database.
 .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
 The keycode must be greater than zero, else ERR 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 SEE ALSO
 \fBkeyok\fR(3X).
-.
 .SH AUTHOR
 Thomas Dickey.
 .\"#