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