ncurses 6.4 - patch 20240420

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

diff --git a/man/keyok.3x b/man/keyok.3x
index 545934200a2b742c7da9c56c795f2f6598d552e2..b4c7de2b49489de1afccd3c932074a67ec072c6c 100644 (file)
--- a/man/keyok.3x
+++ b/man/keyok.3x
@@ -1,5 +1,6 @@
 .\"***************************************************************************
 .\"***************************************************************************

-.\" Copyright (c) 1998-2006,2010 Free Software Foundation, Inc.              *
+.\" Copyright 2018-2023,2024 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            *


@@ -28,36 +29,35 @@
 .\"
 .\" Author: Thomas E. Dickey 1997
 .\"
 .\"
 .\" Author: Thomas E. Dickey 1997
 .\"

-.\" $Id: keyok.3x,v 1.10 2010/07/31 16:08:48 tom Exp $
-.TH keyok 3X ""
+.\" $Id: keyok.3x,v 1.40 2024/03/16 15:35:01 tom Exp $
+.TH keyok 3X 2024-03-16 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls"

 .SH NAME
 .SH NAME

-\fBkeyok\fP \- enable or disable a keycode
+\fB\%keyok\fP \-
+enable or disable a \fIcurses\fR keycode

 .SH SYNOPSIS
 .SH SYNOPSIS

-\fB#include <curses.h>\fP
-.sp
-\fBint keyok(int keycode, bool enable);\fP
+.nf
+\fB#include <curses.h>
+.PP
+\fBint keyok(int \fIkeycode\fP, bool \fIenable\fP);
+.fi

 .SH DESCRIPTION
 .SH DESCRIPTION

-This is an extension to the curses library.
+This is an extension to the \fIcurses\fP library.

 It permits an application to disable specific keycodes, rather than
 It permits an application to disable specific keycodes, rather than

-use the \fIkeypad\fP function to disable all keycodes.
+use the \fB\%keypad\fP function to disable all keycodes.

 Keys that have been disabled can be re-enabled.
 .SH RETURN VALUE
 Keys that have been disabled can be re-enabled.
 .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
-any code depending on them be conditioned using NCURSES_VERSION.
+This routine is specific to \fI\%ncurses\fP.
+It was not supported on
+Version 7, BSD or System V implementations.
+It is recommended that
+any code depending on them be conditioned using \fB\%NCURSES_VERSION\fP.
+.SH AUTHORS
+Thomas Dickey

 .SH SEE ALSO
 .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:
+\fB\%define_key\fP(3X)