| 1 |
.\"*************************************************************************** |
| 2 |
.\" Copyright 2018-2024,2025 Thomas E. Dickey * |
| 3 |
.\" Copyright 1998-2005,2010 Free Software Foundation, Inc. * |
| 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 |
.\" |
| 30 |
.\" $Id: curs_beep.3x,v 1.42 2025/02/01 23:46:11 tom Exp $ |
| 31 |
.TH beep 3NCURSES 2025-02-01 "ncurses 6.6" "Library calls" |
| 32 |
.SH NAME |
| 33 |
\fB\%beep\fP, |
| 34 |
\fB\%flash\fP \- |
| 35 |
ring the (visual) bell of the terminal with \fIcurses\fR |
| 36 |
.SH SYNOPSIS |
| 37 |
.nf |
| 38 |
\fB#include <curses.h> |
| 39 |
.PP |
| 40 |
\fBint beep(void); |
| 41 |
\fBint flash(void); |
| 42 |
.fi |
| 43 |
.SH DESCRIPTION |
| 44 |
.B beep |
| 45 |
and |
| 46 |
.B flash |
| 47 |
alert the terminal user: |
| 48 |
the former by sounding the terminal's audible alarm, |
| 49 |
and the latter by visibly attracting attention. |
| 50 |
Commonly, |
| 51 |
a terminal implements a visual bell by momentarily reversing the |
| 52 |
character foreground and background colors on the entire display; |
| 53 |
even a monochrome device can do this. |
| 54 |
These functions each attempt the other alert type if the one requested |
| 55 |
is unavailable. |
| 56 |
If neither is available, |
| 57 |
.I curses |
| 58 |
performs no action. |
| 59 |
Nearly all terminals have an audible alert mechanism such as a bell or |
| 60 |
piezoelectric buzzer, |
| 61 |
but only some can flash the screen. |
| 62 |
.SH RETURN VALUE |
| 63 |
These functions return |
| 64 |
.B OK |
| 65 |
on success and |
| 66 |
.B ERR |
| 67 |
on failure. |
| 68 |
.PP |
| 69 |
In |
| 70 |
.IR \%ncurses "," |
| 71 |
.B beep |
| 72 |
and |
| 73 |
.B flash |
| 74 |
return |
| 75 |
.B OK |
| 76 |
if the terminal type supports the corresponding capability: |
| 77 |
.B bell |
| 78 |
.RB ( bel ) |
| 79 |
for |
| 80 |
.B beep |
| 81 |
and |
| 82 |
.B \%flash_screen |
| 83 |
.RB ( flash ) |
| 84 |
for |
| 85 |
.BR flash "." |
| 86 |
Otherwise they return |
| 87 |
.BR ERR "." |
| 88 |
.SH EXTENSIONS |
| 89 |
In |
| 90 |
.IR \%ncurses "," |
| 91 |
these functions can return |
| 92 |
.BR ERR "." |
| 93 |
.SH PORTABILITY |
| 94 |
X/Open Curses Issue\ 4 describes these functions. |
| 95 |
It specifies no error conditions for them. |
| 96 |
.PP |
| 97 |
On SVr4 |
| 98 |
.IR curses "," |
| 99 |
they always return |
| 100 |
.IR OK "," |
| 101 |
and X/Open Curses specifies them as doing so. |
| 102 |
.SH HISTORY |
| 103 |
SVr2 (1984) |
| 104 |
introduced |
| 105 |
.I beep |
| 106 |
and |
| 107 |
.IR flash "." |
| 108 |
.SH SEE ALSO |
| 109 |
\fB\%ncurses\fP(3NCURSES), |
| 110 |
\fB\%terminfo\fP(5) |