Gitiles
Code Review Sign In
gerrit.omnirom.org / android_external_libncurses / ae271bcd1ff942b3c4cb099f04bb5882f812da13 / . / doc / html / man / curs_beep.3x.html
blob: b2ce7d28ebc7feee749a38e42910ce98221d39a0 [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) 1998-2005,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 ****************************************************************************
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]29 * @Id: curs_beep.3x,v 1.12 2010/12/04 18:36:44 tom Exp @
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]30-->
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]31<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]32<HTML>
33<HEAD>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]34<meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
35<meta name="generator" content="Manpage converted by man2html - see http://invisible-island.net/scripts/readme.html#others_scripts">
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]36<TITLE>curs_beep 3x</TITLE>
37<link rev=made href="mailto:bug-ncurses@gnu.org">
38<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
39</HEAD>
40<BODY>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]41<H1 class="no-header">curs_beep 3x</H1>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]42<PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]43<STRONG><A HREF="curs_beep.3x.html">curs_beep(3x)</A></STRONG> <STRONG><A HREF="curs_beep.3x.html">curs_beep(3x)</A></STRONG>
44
45
46
47
48</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]49<H2><a name="h2-NAME">NAME</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]50 <STRONG>beep</STRONG>, <STRONG>flash</STRONG> - <STRONG>curses</STRONG> bell and screen flash routines
51
52
53</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]54<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
57 <STRONG>int</STRONG> <STRONG>beep(void);</STRONG>
58 <STRONG>int</STRONG> <STRONG>flash(void);</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 The <STRONG>beep</STRONG> and <STRONG>flash</STRONG> routines are used to alert the terminal
64 user. The routine <STRONG>beep</STRONG> sounds an audible alarm on the
65 terminal, if possible; otherwise it flashes the screen
66 (visible bell). The routine <STRONG>flash</STRONG> flashes the screen, and
67 if that is not possible, sounds the alert. If neither
68 alert is possible, nothing happens. Nearly all terminals
69 have an audible alert (bell or beep), but only some can
70 flash the screen.
71
72
73</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]74<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]75 These routines return <STRONG>OK</STRONG> if they succeed in beeping or
76 flashing, <STRONG>ERR</STRONG> otherwise.
77
78
79</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]80<H2><a name="h2-EXTENSIONS">EXTENSIONS</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]81 SVr4's beep and flash routines always returned <STRONG>OK</STRONG>, so it
82 was not possible to tell when the beep or flash failed.
83
84
85</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]86<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]87 These functions are described in the XSI Curses standard,
88 Issue 4. Like SVr4, it specifies that they always return
89 <STRONG>OK</STRONG>.
90
91
92</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]93<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]94 <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>
95
96
97
98 <STRONG><A HREF="curs_beep.3x.html">curs_beep(3x)</A></STRONG>
99</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]100<div class="nav">
101<ul>
102<li><a href="#h2-NAME">NAME</a></li>
103<li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
104<li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
105<li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
106<li><a href="#h2-EXTENSIONS">EXTENSIONS</a></li>
107<li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
108<li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
109</ul>
110</div>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]111</BODY>
112</HTML>