ncurses 6.2 - patch 20201017
[ncurses.git] / man / curs_beep.3x
1 .\"***************************************************************************
2 .\" Copyright 2018,2020 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.14 2020/02/02 23:34:34 tom Exp $
31 .TH curs_beep 3X ""
32 .SH NAME
33 \fBbeep\fR, \fBflash\fR \- \fBcurses\fR bell and screen flash routines
34 .SH SYNOPSIS
35 \fB#include <curses.h>\fR
36 .PP
37 \fBint beep(void);\fR
38 .br
39 \fBint flash(void);\fR
40 .br
41 .SH DESCRIPTION
42 The \fBbeep\fR and \fBflash\fR routines are used to alert the terminal user.
43 The routine \fBbeep\fR sounds an audible alarm on the terminal, if possible;
44 otherwise it flashes the screen (visible bell).
45 The routine \fBflash\fR
46 flashes the screen, and if that is not possible, sounds the alert.
47 If neither
48 alert is possible, nothing happens.
49 Nearly all terminals have an audible alert
50 (bell or beep), but only some can flash the screen.
51 .SH RETURN VALUE
52 These routines return \fBOK\fR if they succeed in beeping or flashing,
53 \fBERR\fR otherwise.
54 .SH EXTENSIONS
55 SVr4's beep and flash routines always returned \fBOK\fR, so it was not
56 possible to tell when the beep or flash failed.
57 .SH PORTABILITY
58 These functions are described in the XSI Curses standard, Issue 4.
59 Like SVr4, it specifies that they always return \fBOK\fR.
60 .SH SEE ALSO
61 \fBcurses\fR(3X)