ncurses 6.4 - patch 20230918

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

diff --git a/man/keyok.3x b/man/keyok.3x
index 68d9f169f5bc729414f3ce1f3dff8dfaadd60917..7bc1d91143a36395d14a0572210be907e4a2761b 100644 (file)
--- a/man/keyok.3x
+++ b/man/keyok.3x
@@ -1,5 +1,6 @@
 .\"***************************************************************************
-.\" Copyright (c) 1998-2010,2017 Free Software Foundation, Inc.              *
+.\" Copyright 2018-2022,2023 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            *
@@ -28,18 +29,19 @@
 .\"
 .\" Author: Thomas E. Dickey 1997
 .\"
-.\" $Id: keyok.3x,v 1.12 2017/11/21 00:53:44 tom Exp $
-.TH keyok 3X ""
+.\" $Id: keyok.3x,v 1.26 2023/09/16 23:38:39 tom Exp $
+.TH keyok 3X 2023-09-16 "ncurses 6.4" "Library calls"
 .SH NAME
-\fBkeyok\fP \- enable or disable a keycode
+\fB\%keyok\fP \-
+enable or disable a \fIcurses\fR keycode
 .SH SYNOPSIS
 \fB#include <curses.h>\fP
 .sp
-\fBint keyok(int keycode, bool enable);\fP
+\fBint keyok(int \fIkeycode\fB, bool \fIenable\fB);\fR
 .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.
+use the \fBkeypad\fP function to disable all keycodes.
 Keys that have been disabled can be re-enabled.
 .SH RETURN VALUE
 The keycode must be greater than zero, else \fBERR\fP is returned.
@@ -48,10 +50,12 @@ If the \fIenable\fP parameter is true, then the key must have been disabled,
 and vice versa.
 Otherwise, the function returns \fBOK\fP.
 .SH PORTABILITY
-These routines are specific to ncurses.  They were not supported on
-Version 7, BSD or System V implementations.  It is recommended that
+This routine is specific to ncurses.
+It was 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).
+\fBdefine_key\fP(3X).
 .SH AUTHOR
 Thomas Dickey.