ncurses 6.2 - patch 20210313

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

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

-.\" Copyright (c) 1999,2002 Free Software Foundation, Inc.                   *
+.\" Copyright 2018,2020 Thomas E. Dickey                                     *
+.\" Copyright 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,36 +27,35 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"

-.\" Author: Thomas E. Dickey <dickey@clark.net> 1999
+.\" Author: Thomas E. Dickey 1999

 .\"
 .\"

-.\" $Id: keybound.3x,v 1.3 2002/02/16 22:30:36 tom Exp $
-.TH keyok 3X ""
+.\" $Id: keybound.3x,v 1.11 2020/10/17 23:39:30 tom Exp $
+.TH keybound 3X ""

 .SH NAME
 \fBkeybound\fP \- return definition of keycode
 .SH SYNOPSIS
 \fB#include <curses.h>\fP
 .SH NAME
 \fBkeybound\fP \- return definition of keycode
 .SH SYNOPSIS
 \fB#include <curses.h>\fP

-
-\fBchar * keybound(int keycode, int count);\fP
+.sp
+\fBchar * keybound(int \fP\fIkeycode\fP\fB, int \fP\fIcount);\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
 .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.
 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
 .SH PORTABILITY

-These routines are specific to ncurses.  They were not supported on
-Version 7, BSD or System V implementations.  It is recommended that
+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.
 any code depending on them be conditioned using NCURSES_VERSION.
 .SH SEE ALSO
 \fBdefine_key\fR(3X),
 \fBkeyok\fR(3X).
 .SH AUTHOR
 Thomas Dickey.

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