ncurses 6.4 - patch 20230923

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

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

-.\" Copyright (c) 1999-2010,2018 Free Software Foundation, Inc.              *
+.\" Copyright 2018-2022,2023 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            *


@@ -28,33 +29,34 @@
 .\"
 .\" Author: Thomas E. Dickey 1999
 .\"
 .\"
 .\" Author: Thomas E. Dickey 1999
 .\"

-.\" $Id: keybound.3x,v 1.9 2018/07/28 21:34:06 tom Exp $
-.TH keybound 3X ""
+.\" $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"

 .SH NAME
 .SH NAME

-\fBkeybound\fP \- return definition of keycode
+\fB\%keybound\fP \-
+get definition of \fIcurses\fR keycode

 .SH SYNOPSIS
 \fB#include <curses.h>\fP
 .SH SYNOPSIS
 \fB#include <curses.h>\fP

-.sp
-\fBchar * keybound(int keycode, int count);\fP
+.PP
+\fBchar * keybound(int \fIkeycode\fB, int \fIcount);\fR

 .SH DESCRIPTION
 .SH DESCRIPTION

-This is an extension to the curses library.
+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
 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 NULL is returned.
-If it does not correspond to a defined key, then NULL 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
 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
+This routine is specific to \fIncurses\fP.
+It was not supported on

 Version 7, BSD or System V implementations.
 It is recommended that
 Version 7, BSD or System V implementations.
 It is recommended that

-any code depending on them be conditioned using NCURSES_VERSION.
+any code depending on them be conditioned using \fB\%NCURSES_VERSION\fP.

 .SH SEE ALSO
 .SH SEE ALSO

-\fBdefine_key\fR(3X),
-\fBkeyok\fR(3X).
+\fB\%define_key\fP(3X),
+\fB\%keyok\fP(3X)

 .SH AUTHOR
 .SH AUTHOR

-Thomas Dickey.
+Thomas Dickey