X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fkeybound.3x;h=e852890296e68f430e9bdc29e9b9843fd17b785b;hp=b2dde39c38ab938506de3f91406940047d11327a;hb=0eedaa5673ff8181abe51e3a6fadca3820f90c46;hpb=bb55d9e3947102ec2554482d47d21402093f32e8 diff --git a/man/keybound.3x b/man/keybound.3x index b2dde39c..e8528902 100644 --- a/man/keybound.3x +++ b/man/keybound.3x @@ -29,34 +29,34 @@ .\" .\" Author: Thomas E. Dickey 1999 .\" -.\" $Id: keybound.3x,v 1.21 2023/09/16 23:38:39 tom Exp $ -.TH keybound 3X 2023-09-16 "ncurses 6.4" "Library calls" +.\" $Id: keybound.3x,v 1.27 2023/09/23 22:49:51 tom Exp $ +.TH keybound 3X 2023-09-23 "ncurses 6.4" "Library calls" .SH NAME \fB\%keybound\fP \- get definition of \fIcurses\fR keycode .SH SYNOPSIS \fB#include \fP -.sp +.PP \fBchar * keybound(int \fIkeycode\fB, int \fIcount);\fR .SH DESCRIPTION -This is an extension to the curses library. +This is an extension to the \fIcurses\fP library. It permits an application to determine the string which is defined in the terminfo for specific keycodes. .SH RETURN VALUE -The \fIkeycode\fP parameter must be greater than zero, else NULL is returned. -If it does not correspond to a defined key, then NULL is returned. +The \fIkeycode\fP parameter must be greater than zero, else \fBNULL\fP is returned. +If it does not correspond to a defined key, then \fBNULL\fP is returned. The \fIcount\fP parameter is used to allow the application to iterate through multiple definitions, counting from zero. When successful, the function returns a string which must be freed by the caller. .SH PORTABILITY -This routine is specific to ncurses. +This routine is specific to \fIncurses\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 SEE ALSO -\fBdefine_key\fP(3X), -\fBkeyok\fP(3X). +\fB\%define_key\fP(3X), +\fB\%keyok\fP(3X) .SH AUTHOR -Thomas Dickey. +Thomas Dickey