Gitiles
Code Review Sign In
gerrit.omnirom.org / android_external_libncurses / refs/heads/android-16 / . / doc / html / man / keybound.3x.html
blob: e926e77c6acb9cc16187ac48bf1af45d9575d77a [file] [log] [blame]
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame]1<!--
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]2 ****************************************************************************
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame]3 * Copyright 2018-2023,2024 Thomas E. Dickey *
4 * Copyright 1999-2008,2010 Free Software Foundation, Inc. *
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]5 * *
6 * Permission is hereby granted, free of charge, to any person obtaining a *
7 * copy of this software and associated documentation files (the *
8 * "Software"), to deal in the Software without restriction, including *
9 * without limitation the rights to use, copy, modify, merge, publish, *
10 * distribute, distribute with modifications, sublicense, and/or sell *
11 * copies of the Software, and to permit persons to whom the Software is *
12 * furnished to do so, subject to the following conditions: *
13 * *
14 * The above copyright notice and this permission notice shall be included *
15 * in all copies or substantial portions of the Software. *
16 * *
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
18 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
19 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
20 * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
21 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
22 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
23 * THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
24 * *
25 * Except as contained in this notice, the name(s) of the above copyright *
26 * holders shall not be used in advertising or otherwise to promote the *
27 * sale, use or other dealings in this Software without prior written *
28 * authorization. *
29 ****************************************************************************
30 * Author: Thomas E. Dickey 1999
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame]31 * @Id: keybound.3x,v 1.36 2024/03/16 15:35:01 tom Exp @
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]32-->
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]33<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]34<HTML>
35<HEAD>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]36<meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame]37<meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
38<TITLE>keybound 3x 2024-03-16 ncurses 6.5 Library calls</TITLE>
39<link rel="author" href="mailto:bug-ncurses@gnu.org">
40
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]41</HEAD>
42<BODY>
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame]43<H1 class="no-header">keybound 3x 2024-03-16 ncurses 6.5 Library calls</H1>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]44<PRE>
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame]45<STRONG><A HREF="keybound.3x.html">keybound(3x)</A></STRONG> Library calls <STRONG><A HREF="keybound.3x.html">keybound(3x)</A></STRONG>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]46
47
48
49
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame]50</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
51 <STRONG>keybound</STRONG> - get definition of <EM>curses</EM> keycode
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]52
53
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame]54</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]55 <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
56
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame]57 <STRONG>char</STRONG> <STRONG>*</STRONG> <STRONG>keybound(int</STRONG> <EM>keycode</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>count</EM><STRONG>);</STRONG>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]58
59
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame]60</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
61 This is an extension to the <EM>curses</EM> library. It permits an application
62 to determine the string which is defined in the terminfo for specific
63 keycodes.
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]64
65
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame]66</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
67 The <EM>keycode</EM> parameter must be greater than zero, else <STRONG>NULL</STRONG> is returned.
68 If it does not correspond to a defined key, then <STRONG>NULL</STRONG> is returned. The
69 <EM>count</EM> parameter is used to allow the application to iterate through
70 multiple definitions, counting from zero. When successful, the
71 function returns a string which must be freed by the caller.
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]72
73
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame]74</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
75 This routine is specific to <EM>ncurses</EM>. It was not supported on Version
76 7, BSD or System V implementations. It is recommended that any code
77 depending on them be conditioned using <STRONG>NCURSES_VERSION</STRONG>.
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]78
79
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame]80</PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
81 Thomas Dickey
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]82
83
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame]84</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
85 <STRONG><A HREF="define_key.3x.html">define_key(3x)</A></STRONG>, <STRONG><A HREF="keyok.3x.html">keyok(3x)</A></STRONG>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]86
87
88
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame]89ncurses 6.5 2024-03-16 <STRONG><A HREF="keybound.3x.html">keybound(3x)</A></STRONG>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]90</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]91<div class="nav">
92<ul>
93<li><a href="#h2-NAME">NAME</a></li>
94<li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
95<li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
96<li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
97<li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame]98<li><a href="#h2-AUTHORS">AUTHORS</a></li>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]99<li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]100</ul>
101</div>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]102</BODY>
103</HTML>