| 1 |
<!-- |
| 2 |
**************************************************************************** |
| 3 |
* Copyright 2018-2024,2025 Thomas E. Dickey * |
| 4 |
* Copyright 1998-2005,2010 Free Software Foundation, Inc. * |
| 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 |
* @Id: curs_beep.3x,v 1.42 2025/02/01 23:46:11 tom Exp @ |
| 31 |
--> |
| 32 |
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> |
| 33 |
<HTML> |
| 34 |
<HEAD> |
| 35 |
<meta http-equiv="Content-Type" content="text/html; charset=us-ascii"> |
| 36 |
<meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts"> |
| 37 |
<TITLE>curs_beep 3x 2025-02-01 ncurses 6.6 Library calls</TITLE> |
| 38 |
<link rel="author" href="mailto:[email protected]"> |
| 39 |
|
| 40 |
</HEAD> |
| 41 |
<BODY> |
| 42 |
<H1 class="no-header">curs_beep 3x 2025-02-01 ncurses 6.6 Library calls</H1> |
| 43 |
<PRE> |
| 44 |
<STRONG><A HREF="curs_beep.3x.html">curs_beep(3x)</A></STRONG> Library calls <STRONG><A HREF="curs_beep.3x.html">curs_beep(3x)</A></STRONG> |
| 45 |
|
| 46 |
|
| 47 |
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE> |
| 48 |
<STRONG>beep</STRONG>, <STRONG>flash</STRONG> - ring the (visual) bell of the terminal with <EM>curses</EM> |
| 49 |
|
| 50 |
|
| 51 |
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE> |
| 52 |
<STRONG>#include</STRONG> <STRONG><curses.h></STRONG> |
| 53 |
|
| 54 |
<STRONG>int</STRONG> <STRONG>beep(void);</STRONG> |
| 55 |
<STRONG>int</STRONG> <STRONG>flash(void);</STRONG> |
| 56 |
|
| 57 |
|
| 58 |
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE> |
| 59 |
<STRONG>beep</STRONG> and <STRONG>flash</STRONG> alert the terminal user: the former by sounding the |
| 60 |
terminal's audible alarm, and the latter by visibly attracting |
| 61 |
attention. Commonly, a terminal implements a visual bell by |
| 62 |
momentarily reversing the character foreground and background colors on |
| 63 |
the entire display; even a monochrome device can do this. These |
| 64 |
functions each attempt the other alert type if the one requested is |
| 65 |
unavailable. If neither is available, <EM>curses</EM> performs no action. |
| 66 |
Nearly all terminals have an audible alert mechanism such as a bell or |
| 67 |
piezoelectric buzzer, but only some can flash the screen. |
| 68 |
|
| 69 |
|
| 70 |
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE> |
| 71 |
These functions return <STRONG>OK</STRONG> on success and <STRONG>ERR</STRONG> on failure. |
| 72 |
|
| 73 |
In <EM>ncurses</EM>, <STRONG>beep</STRONG> and <STRONG>flash</STRONG> return <STRONG>OK</STRONG> if the terminal type supports the |
| 74 |
corresponding capability: <STRONG>bell</STRONG> (<STRONG>bel</STRONG>) for <STRONG>beep</STRONG> and <STRONG>flash_screen</STRONG> (<STRONG>flash</STRONG>) |
| 75 |
for <STRONG>flash</STRONG>. Otherwise they return <STRONG>ERR</STRONG>. |
| 76 |
|
| 77 |
|
| 78 |
</PRE><H2><a name="h2-EXTENSIONS">EXTENSIONS</a></H2><PRE> |
| 79 |
In <EM>ncurses</EM>, these functions can return <STRONG>ERR</STRONG>. |
| 80 |
|
| 81 |
|
| 82 |
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE> |
| 83 |
X/Open Curses Issue 4 describes these functions. It specifies no error |
| 84 |
conditions for them. |
| 85 |
|
| 86 |
On SVr4 <EM>curses</EM>, they always return <EM>OK</EM>, and X/Open Curses specifies them |
| 87 |
as doing so. |
| 88 |
|
| 89 |
|
| 90 |
</PRE><H2><a name="h2-HISTORY">HISTORY</a></H2><PRE> |
| 91 |
SVr2 (1984) introduced <EM>beep</EM> and <EM>flash</EM>. |
| 92 |
|
| 93 |
|
| 94 |
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE> |
| 95 |
<STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG> |
| 96 |
|
| 97 |
ncurses 6.6 2025-02-01 <STRONG><A HREF="curs_beep.3x.html">curs_beep(3x)</A></STRONG> |
| 98 |
</PRE> |
| 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-EXTENSIONS">EXTENSIONS</a></li> |
| 106 |
<li><a href="#h2-PORTABILITY">PORTABILITY</a></li> |
| 107 |
<li><a href="#h2-HISTORY">HISTORY</a></li> |
| 108 |
<li><a href="#h2-SEE-ALSO">SEE ALSO</a></li> |
| 109 |
</ul> |
| 110 |
</div> |
| 111 |
</BODY> |
| 112 |
</HTML> |