ncurses 6.1 - patch 20190216
[ncurses.git] / man / keyok.3x
index f9209089a7aa410af1eb57fd1ab95b2d4c2ca524..d181c1059bd2ea4d3df11e5b32135ae0fd92b329 100644 (file)
@@ -1,5 +1,5 @@
 .\"***************************************************************************
 .\"***************************************************************************
-.\" Copyright (c) 1998-2002,2003 Free Software Foundation, Inc.              *
+.\" Copyright (c) 1998-2017,2018 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            *
 .\"
 .\" Author: Thomas E. Dickey 1997
 .\"
 .\"
 .\" Author: Thomas E. Dickey 1997
 .\"
-.\" $Id: keyok.3x,v 1.8 2003/10/25 20:41:08 tom Exp $
+.\" $Id: keyok.3x,v 1.13 2018/07/28 21:34:56 tom Exp $
 .TH keyok 3X ""
 .SH NAME
 \fBkeyok\fP \- enable or disable a keycode
 .SH SYNOPSIS
 \fB#include <curses.h>\fP
 .TH keyok 3X ""
 .SH NAME
 \fBkeyok\fP \- enable or disable a keycode
 .SH SYNOPSIS
 \fB#include <curses.h>\fP
-
+.sp
 \fBint keyok(int keycode, bool enable);\fP
 .SH DESCRIPTION
 This is an extension to the curses library.
 It permits an application to disable specific keycodes, rather than
 use the \fIkeypad\fP function to disable all keycodes.
 \fBint keyok(int keycode, bool enable);\fP
 .SH DESCRIPTION
 This is an extension to the curses library.
 It permits an application to disable specific keycodes, rather than
 use the \fIkeypad\fP function to disable all keycodes.
-Keys that have been disabled can be reenabled.
+Keys that have been disabled can be re-enabled.
 .SH RETURN VALUE
 .SH RETURN VALUE
-The keycode must be greater than zero, else ERR is returned.
-If it does not correspond to a defined key, then ERR is returned.
+The keycode must be greater than zero, else \fBERR\fP is returned.
+If it does not correspond to a defined key, then \fBERR\fP is returned.
 If the \fIenable\fP parameter is true, then the key must have been disabled,
 and vice versa.
 If the \fIenable\fP parameter is true, then the key must have been disabled,
 and vice versa.
-Otherwise, the function returns OK.
+Otherwise, the function returns \fBOK\fP.
 .SH PORTABILITY
 .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
 \fBdefine_key\fR(3X).
 .SH AUTHOR
 Thomas Dickey.
 any code depending on them be conditioned using NCURSES_VERSION.
 .SH SEE ALSO
 \fBdefine_key\fR(3X).
 .SH AUTHOR
 Thomas Dickey.
-.\"#
-.\"# The following sets edit modes for GNU EMACS
-.\"# Local Variables:
-.\"# mode:nroff
-.\"# fill-column:79
-.\"# End: