64 lines
3.3 KiB
Plaintext
64 lines
3.3 KiB
Plaintext
.\"***************************************************************************
|
|
.\" Copyright (c) 1998-2003,2005 Free Software Foundation, Inc. *
|
|
.\" *
|
|
.\" Permission is hereby granted, free of charge, to any person obtaining a *
|
|
.\" copy of this software and associated documentation files (the *
|
|
.\" "Software"), to deal in the Software without restriction, including *
|
|
.\" without limitation the rights to use, copy, modify, merge, publish, *
|
|
.\" distribute, distribute with modifications, sublicense, and/or sell *
|
|
.\" copies of the Software, and to permit persons to whom the Software is *
|
|
.\" furnished to do so, subject to the following conditions: *
|
|
.\" *
|
|
.\" The above copyright notice and this permission notice shall be included *
|
|
.\" in all copies or substantial portions of the Software. *
|
|
.\" *
|
|
.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
|
|
.\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
|
|
.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
|
|
.\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
|
|
.\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
|
|
.\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
|
|
.\" THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
|
|
.\" *
|
|
.\" Except as contained in this notice, the name(s) of the above copyright *
|
|
.\" holders shall not be used in advertising or otherwise to promote the *
|
|
.\" sale, use or other dealings in this Software without prior written *
|
|
.\" authorization. *
|
|
.\"***************************************************************************
|
|
.\"
|
|
.\" $Id: curs_beep.3x,v 1.10 2005/01/08 17:55:51 tom Exp $
|
|
.TH curs_beep 3X ""
|
|
.SH NAME
|
|
\fBbeep\fR, \fBflash\fR - \fBcurses\fR bell and screen flash routines
|
|
.SH SYNOPSIS
|
|
\fB#include <curses.h>\fR
|
|
.PP
|
|
\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 return \fBOK\fR if they succeed in beeping or flashing,
|
|
\fBERR\fR otherwise.
|
|
.SH EXTENSIONS
|
|
SVr4's beep and flash routines always returned \fBOK\fR, so it was not
|
|
possible to tell when the beep or flash failed.
|
|
.SH PORTABILITY
|
|
These functions are described in the XSI Curses standard, Issue 4.
|
|
Like SVr4, it specifies that they always return \fBOK\fR.
|
|
.SH SEE ALSO
|
|
\fBcurses\fR(3X)
|
|
.\"#
|
|
.\"# The following sets edit modes for GNU EMACS
|
|
.\"# Local Variables:
|
|
.\"# mode:nroff
|
|
.\"# fill-column:79
|
|
.\"# End:
|