ncurses 4.1
[ncurses.git] / man / curs_beep.3x
1 .TH curs_beep 3X ""
2 .SH NAME
3 \fBbeep\fR, \fBflash\fR - \fBcurses\fR bell and screen flash routines
4 .SH SYNOPSIS
5 \fB#include <curses.h>\fR
6
7 \fBint beep(void);\fR
8 .br
9 \fBint flash(void);\fR
10 .br
11 .SH DESCRIPTION
12 The \fBbeep\fR and \fBflash\fR routines are used to alert the terminal user.
13 The routine \fBbeep\fR sounds an audible alarm on the terminal, if possible;
14 otherwise it flashes the screen (visible bell).  The routine \fBflash\fR
15 flashes the screen, and if that is not possible, sounds the alert.  If neither
16 alert is possible, nothing happens.  Nearly all terminals have an audible alert
17 (bell or beep), but only some can flash the screen.
18 .SH RETURN VALUE
19 These routines return \fBOK\fR if they succeed in beeping or flashing, 
20 \fBERR\fR otherwise.
21 .SH EXTENSIONS
22 SVr4's beep and flash routines always returned \fBOK\fR, so it was not
23 possible to tell when the beep or flash failed.
24 .SH PORTABILITY
25 These functions are defined in the XSI Curses standard, Issue 4.  Like SVr4, it
26 specifies that they always return \fBOK\fR.
27 .SH SEE ALSO
28 \fBcurses\fR(3X)
29 .\"#
30 .\"# The following sets edit modes for GNU EMACS
31 .\"# Local Variables:
32 .\"# mode:nroff
33 .\"# fill-column:79
34 .\"# End: