ncurses 6.5 - patch 20240525

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

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

-.\" Copyright (c) 1999 Free Software Foundation, Inc.                        *
+.\" 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  *
 .\" 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 +27,78 @@
 .\" 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.38 2024/05/18 20:05:36 tom Exp $
+.TH keybound 3X 2024-05-18 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls"

 .SH NAME
 .SH NAME

-\fBkeybound\fP \- return definition of keycode
-..
+\fB\%keybound\fP \-
+get definition of a \fIcurses\fP function key code

 .SH SYNOPSIS
 .SH SYNOPSIS

-\fB#include <curses.h>\fP
-
-\fBint keybound(int keycode, int count);\fP
-..
+.nf
+\fB#include <curses.h>
+.PP
+\fBchar * keybound(int \fIkey-code\fP, int \fIcount\fP);
+.fi

 .SH DESCRIPTION
 .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.
-..
+The
+.B \%keybound
+.I \%ncurses
+extension permits a
+.I curses
+application to obtain the value of the string
+.I bound
+to the function key
+.IR key-code ";"
+see \fB\%wgetch\fP(3X)
+(wide-character API users: \fB\%wget_wch\fP(3X)).
+By default,
+such bindings are string capabilities from the
+.I \%term\%info
+database entry corresponding to the terminal type.
+The application can non-destructively and repeatedly
+override such definitions with
+\fB\%define_key\fP(3X),
+as if by pushing new definitions onto a stack.
+The
+.I count
+parameter accesses the
+.IR n th
+most recently defined binding;
+.B 0
+selects the binding that is used on input.

 .SH RETURN VALUE
 .SH RETURN VALUE

-The keycode 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.
-..
+If
+.I key-code
+corresponds to a function key defined
+by the application
+or the terminal type in use,
+.B \%keybound
+allocates and returns a string
+that must be freed by the application.
+.B \%keybound
+returns
+.B NULL
+if
+.I key-code
+is not positive
+or if it does not correspond to a key code definition.
+.SH EXTENSIONS
+.B \%keybound
+is an
+.I \%ncurses
+extension.

 .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
-any code depending on them be conditioned using NCURSES_VERSION.
-..
+Applications employing
+.I \%ncurses
+extensions should condition their use on the visibility of the
+.B \%NCURSES_VERSION
+preprocessor macro.
+.SH AUTHORS
+Thomas Dickey

 .SH SEE ALSO
 .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:
+\fB\%ncurses\fP(3X),
+\fB\%define_key\fP(3X),
+\fB\%key_defined\fP(3X),
+\fB\%keyok\fP(3X),
+\fB\%terminfo\fP(5)