freebsd-src/lib/libncurses/curs_beep.3
Mike Pritchard 3e6427f35f Correct man page section number references (e.g. don't use the
old 1M, 3X and 3S section numbers) and make some minor formatting
changes to silence manck.
1996-02-11 23:29:40 +00:00

30 lines
904 B
Groff

.TH curs_beep 3 ""
.SH NAME
\fBbeep\fR, \fBflash\fR - \fBncurses\fR bell and screen flash routines
.SH SYNOPSIS
\fB#include <ncurses.h>\fR
\fBint beep(void);\fR
.br
\fBint flash(void);\fR
.br
.SH DESCRIPTION
The \fBbeep\fR and \fBflash\fR routines are used to alert the terminal user.
The routine \fBbeep\fR sounds an audible alarm on the terminal, if possible;
otherwise it flashes the screen (visible bell). The routine \fBflash\fR
flashes the screen, and if that is not possible, sounds the alert. If neither
alert is possible, nothing happens. Nearly all terminals have an audible alert
(bell or beep), but only some can flash the screen.
.SH RETURN VALUE
These routines always return \fBOK\fR.
.SH CAPABILITIES
\fBbell\fR, \fBflash_screen\fR.
.SH SEE ALSO
\fBncurses\fR(3)
.\"#
.\"# The following sets edit modes for GNU EMACS
.\"# Local Variables:
.\"# mode:nroff
.\"# fill-column:79
.\"# End: