X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fkeyok.3x;h=08c2a27778eac3f4dbc9dd37d3b297fed0ef222d;hp=21befe83ca4bbbf46c73edfd8b96852be1ae7e91;hb=d736364fc09f481a38861dcb44b43d15b94af528;hpb=0eb88fc5281804773e2a0c7a488a4452463535ce diff --git a/man/keyok.3x b/man/keyok.3x index 21befe83..08c2a277 100644 --- a/man/keyok.3x +++ b/man/keyok.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1998 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2003,2006 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,39 +26,33 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" Author: Thomas E. Dickey 1997 +.\" Author: Thomas E. Dickey 1997 .\" -.\" $Id: keyok.3x,v 1.5 1998/03/14 23:43:07 tom Exp $ +.\" $Id: keyok.3x,v 1.9 2006/02/25 21:47:06 tom Exp $ .TH keyok 3X "" .SH NAME \fBkeyok\fP \- enable or disable a keycode -.. .SH SYNOPSIS \fB#include \fP - +.sp \fBint keyok(int keycode, bool enable);\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. -.. .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. If the \fIenable\fP parameter is true, then the key must have been disabled, and vice versa. Otherwise, the function returns OK. -.. .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. -.. .SH SEE ALSO \fBdefine_key\fR(3X). -.. .SH AUTHOR Thomas Dickey. .\"#