X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fkeyok.3x;h=937450e57cfb672634000b3f52a4f3c902b1875b;hp=d3c1c847aa8f93e589506590c2f595ae7093bcb1;hb=HEAD;hpb=47d2fb4537d9ad5bb14f4810561a327930ca4280 diff --git a/man/keyok.3x b/man/keyok.3x index d3c1c847..b4c7de2b 100644 --- a/man/keyok.3x +++ b/man/keyok.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright 2018,2020 Thomas E. Dickey * +.\" 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 * @@ -29,18 +29,21 @@ .\" .\" Author: Thomas E. Dickey 1997 .\" -.\" $Id: keyok.3x,v 1.14 2020/02/02 23:34:34 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 -\fBkeyok\fP \- enable or disable a keycode +\fB\%keyok\fP \- +enable or disable a \fIcurses\fR keycode .SH SYNOPSIS -\fB#include \fP -.sp -\fBint keyok(int keycode, bool enable);\fP +.nf +\fB#include +.PP +\fBint keyok(int \fIkeycode\fP, bool \fIenable\fP); +.fi .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 -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 The keycode must be greater than zero, else \fBERR\fP is returned. @@ -49,12 +52,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 +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 NCURSES_VERSION. +any code depending on them be conditioned using \fB\%NCURSES_VERSION\fP. +.SH AUTHORS +Thomas Dickey .SH SEE ALSO -\fBdefine_key\fR(3X). -.SH AUTHOR -Thomas Dickey. +\fB\%define_key\fP(3X)