diff options
Diffstat (limited to '')
| -rw-r--r-- | upstream/archlinux/man3/keyok.3x | 33 |
1 files changed, 18 insertions, 15 deletions
diff --git a/upstream/archlinux/man3/keyok.3x b/upstream/archlinux/man3/keyok.3x index d31d5b1f..5f3ecbde 100644 --- a/upstream/archlinux/man3/keyok.3x +++ b/upstream/archlinux/man3/keyok.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright 2018-2021,2022 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.19 2022/02/12 20:03:40 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 6.5" "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 \fIkeycode\fB, bool \fIenable\fB);\fR +.nf +\fB#include <curses.h> +.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 \fBkeypad\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\fP(3X). -.SH AUTHOR -Thomas Dickey. +\fB\%define_key\fP(3X) |