ncurses 5.7 - patch 20090221
[ncurses.git] / man / keybound.3x
index e6bf5e4e731a45f62245ddc971991b7684bfad01..53c941bd62a3aa03e7dff2f95e97e3068ce93451 100644 (file)
@@ -1,5 +1,5 @@
 .\"***************************************************************************
-.\" Copyright (c) 1999 Free Software Foundation, Inc.                        *
+.\" Copyright (c) 1999-2006,2008 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            *
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
-.\" Author: Thomas E. Dickey <dickey@clark.net> 1999
+.\" Author: Thomas E. Dickey 1999
 .\"
-.\" $Id: keybound.3x,v 1.1 1999/02/19 11:59:24 tom Exp $
-.TH keyok 3X ""
+.\" $Id: keybound.3x,v 1.7 2008/12/13 18:19:07 Frederic.Culot Exp $
+.TH keybound 3X ""
 .SH NAME
 \fBkeybound\fP \- return definition of keycode
-..
 .SH SYNOPSIS
 \fB#include <curses.h>\fP
-
-\fBint keybound(int keycode, int count);\fP
-..
+.sp
+\fBchar * keybound(int keycode, int count);\fP
 .SH DESCRIPTION
 This is an extension to the curses library.
 It permits an application to determine the string which is defined
 in the terminfo for specific keycodes.
-..
 .SH RETURN VALUE
-The keycode must be greater than zero, else NULL is returned.
+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.
-Otherwise, the function returns a string, which must be freed by the caller.
-..
+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
 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),
 \fBkeyok\fR(3X).
-..
 .SH AUTHOR
 Thomas Dickey.
 .\"#