ncurses 6.2 - patch 20201219

[ncurses.git] / man / keyok.3x

diff --git a/man/keyok.3x b/man/keyok.3x
index 21befe83ca4bbbf46c73edfd8b96852be1ae7e91..937450e57cfb672634000b3f52a4f3c902b1875b 100644 (file)
--- a/man/keyok.3x
+++ b/man/keyok.3x
@@ -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            *
 .\"                                                                          *
 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
 .\" copy of this software and associated documentation files (the            *


@@ -26,44 +27,34 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"

-.\" Author: Thomas E. Dickey <dickey@clark.net> 1997
+.\" Author: Thomas E. Dickey 1997

 .\"
 .\"

-.\" $Id: keyok.3x,v 1.5 1998/03/14 23:43:07 tom Exp $
+.\" $Id: keyok.3x,v 1.15 2020/10/17 23:39:59 tom Exp $

 .TH keyok 3X ""
 .SH NAME
 \fBkeyok\fP \- enable or disable a keycode
 .TH keyok 3X ""
 .SH NAME
 \fBkeyok\fP \- enable or disable a keycode

-..

 .SH SYNOPSIS
 \fB#include <curses.h>\fP
 .SH SYNOPSIS
 \fB#include <curses.h>\fP

-
-\fBint keyok(int keycode, bool enable);\fP
-..
+.sp
+\fBint keyok(int \fP\fIkeycode\fP\fB, bool \fP\fIenable\fP\fB);\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.
 .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.
 any code depending on them be conditioned using NCURSES_VERSION.

-..

 .SH SEE ALSO
 \fBdefine_key\fR(3X).
 .SH SEE ALSO
 \fBdefine_key\fR(3X).

-..

 .SH AUTHOR
 Thomas Dickey.
 .SH AUTHOR
 Thomas Dickey.

-.\"#
-.\"# The following sets edit modes for GNU EMACS
-.\"# Local Variables:
-.\"# mode:nroff
-.\"# fill-column:79
-.\"# End: