ncurses 6.2 - patch 20201205
[ncurses.git] / man / define_key.3x
index 047d78f8b82a129cdbc2c891b638224c94609acd..d0dbe7fccaa9e4904074a0bb1a0839f37135ab5b 100644 (file)
@@ -1,5 +1,6 @@
 .\"***************************************************************************
-.\" Copyright (c) 1998 Free Software Foundation, Inc.                        *
+.\" Copyright 2018,2020 Thomas E. Dickey                                     *
+.\" Copyright 1998-2010,2017 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            *
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
-.\" Author: Thomas E. Dickey <dickey@clark.net> 1997
+.\" Author: Thomas E. Dickey 1997
 .\"
-.\" $Id: define_key.3x,v 1.6 1999/02/19 11:43:17 tom Exp $
+.\" $Id: define_key.3x,v 1.18 2020/10/24 09:52:54 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
-..
+.sp
+\fBint define_key(const char *\fP\fIdefinition\fP\fB, int \fP\fIkeycode\fP\fB);\fP
 .SH DESCRIPTION
 This is an extension to the curses library.
 It permits an application to define keycodes with their corresponding control
@@ -48,23 +47,20 @@ 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.
-..
+The keycode must be greater than zero, and the string non-null,
+otherwise \fBERR\fP is returned.
+\fBERR\fP may also be returned if there is insufficient memory to allocate the
+data to store the definition.
+If no error is detected, \fBOK\fP 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
+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).
-..
+\fBkeyok\fR(3X),
+\fBkey_defined\fR(3X).
 .SH AUTHOR
 Thomas Dickey.
-.\"#
-.\"# The following sets edit modes for GNU EMACS
-.\"# Local Variables:
-.\"# mode:nroff
-.\"# fill-column:79
-.\"# End: