summaryrefslogtreecommitdiff
path: root/lib/libcurses/define_key.3
diff options
context:
space:
mode:
Diffstat (limited to 'lib/libcurses/define_key.3')
-rw-r--r--lib/libcurses/define_key.323
1 files changed, 9 insertions, 14 deletions
diff --git a/lib/libcurses/define_key.3 b/lib/libcurses/define_key.3
index c0e10afb70c..9104ca26fd7 100644
--- a/lib/libcurses/define_key.3
+++ b/lib/libcurses/define_key.3
@@ -1,7 +1,7 @@
-.\" $OpenBSD: define_key.3,v 1.4 1999/05/08 20:28:58 millert Exp $
+.\" $OpenBSD: define_key.3,v 1.5 2010/01/12 23:21:59 nicm Exp $
.\"
.\"***************************************************************************
-.\" Copyright (c) 1998 Free Software Foundation, Inc. *
+.\" Copyright (c) 1998-2004,2006 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 *
@@ -28,40 +28,35 @@
.\" authorization. *
.\"***************************************************************************
.\"
-.\" Author: Thomas E. Dickey <dickey@clark.net> 1997
+.\" Author: Thomas E. Dickey 1997
.\"
-.\" $From: define_key.3x,v 1.6 1999/02/19 11:43:17 tom Exp $
+.\" $Id: define_key.3,v 1.5 2010/01/12 23:21:59 nicm Exp $
.TH define_key 3 ""
.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 *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
-strings, so that the curses library will interpret them just as it would
+strings, so that the ncurses library will interpret them just as it would
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(3).
-..
+\fBkeyok\fR(3),
+\fBkey_defined\fR(3).
.SH AUTHOR
Thomas Dickey.
.\"#