X-Git-Url: http://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=man%2Fkeybound.3x;h=bd8bb80f3c449875fbb07be4a5341244b991e57b;hb=725169bda4d3b4c3fde0d4a94f76d017812c7ea6;hp=e852890296e68f430e9bdc29e9b9843fd17b785b;hpb=0eedaa5673ff8181abe51e3a6fadca3820f90c46;p=ncurses.git diff --git a/man/keybound.3x b/man/keybound.3x index e8528902..bd8bb80f 100644 --- a/man/keybound.3x +++ b/man/keybound.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright 2018-2022,2023 Thomas E. Dickey * +.\" Copyright 2018-2023,2024 Thomas E. Dickey * .\" Copyright 1999-2008,2010 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -29,34 +29,37 @@ .\" .\" Author: Thomas E. Dickey 1999 .\" -.\" $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" +.\" $Id: keybound.3x,v 1.36 2024/03/16 15:35:01 tom Exp $ +.TH keybound 3X 2024-03-16 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" .SH NAME \fB\%keybound\fP \- get definition of \fIcurses\fR keycode .SH SYNOPSIS -\fB#include \fP +.nf +\fB#include .PP -\fBchar * keybound(int \fIkeycode\fB, int \fIcount);\fR +\fBchar * keybound(int \fIkeycode\fP, int \fIcount\fP); +.fi .SH DESCRIPTION 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 \fBNULL\fP 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 \fIncurses\fP. +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 \fB\%NCURSES_VERSION\fP. +.SH AUTHORS +Thomas Dickey .SH SEE ALSO \fB\%define_key\fP(3X), \fB\%keyok\fP(3X) -.SH AUTHOR -Thomas Dickey