X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fkeyok.3x;h=937450e57cfb672634000b3f52a4f3c902b1875b;hp=370af42b1c4ca3b690ade953a3d4ff9cd839ae66;hb=42259b594b5dabd37fe2bc294051d2db82e873a2;hpb=661078ddbde3ce0f3b06e95642fbb9b5fef7dca1 diff --git a/man/keyok.3x b/man/keyok.3x index 370af42b..937450e5 100644 --- 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 * @@ -26,45 +27,34 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" Author: Thomas E. Dickey 1997 +.\" Author: Thomas E. Dickey 1997 .\" -.\" $Id: keyok.3x,v 1.4 1998/02/11 12:13:47 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 -. .SH SYNOPSIS \fB#include \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. -Keys that have been disabled can be reenabled. -. +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. -Otherwise, the function returns OK. -. +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 +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. -. .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: