ncurses 6.0 - patch 20170304

[ncurses.git] / man / keybound.3x

diff --git a/man/keybound.3x b/man/keybound.3x
index e6bf5e4e731a45f62245ddc971991b7684bfad01..5dd083afe1abfd21ef459138cfcd470161da4098 100644 (file)
--- a/man/keybound.3x
+++ b/man/keybound.3x
@@ -1,5 +1,5 @@
 .\"***************************************************************************
 .\"***************************************************************************

-.\" Copyright (c) 1999 Free Software Foundation, Inc.                        *
+.\" Copyright (c) 1999-2008,2010 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            *
 .\"                                                                          *
 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
 .\" copy of this software and associated documentation files (the            *


@@ -26,42 +26,33 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
 .\" 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.8 2010/12/04 18:49:20 tom Exp $
+.TH keybound 3X ""

 .SH NAME
 \fBkeybound\fP \- return definition of keycode
 .SH NAME
 \fBkeybound\fP \- return definition of keycode

-..

 .SH SYNOPSIS
 \fB#include <curses.h>\fP
 .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 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
 .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.
 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 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 SEE ALSO
 \fBdefine_key\fR(3X),
 \fBkeyok\fR(3X).

-..

 .SH AUTHOR
 Thomas Dickey.
 .SH AUTHOR
 Thomas Dickey.

-.\"#
-.\"# The following sets edit modes for GNU EMACS
-.\"# Local Variables:
-.\"# mode:nroff
-.\"# fill-column:79
-.\"# End: