Gitiles
Code Review Sign In
gerrit.omnirom.org / android_external_libncurses / refs/heads/android-16 / . / man / curs_beep.3x
blob: 9806f42b3ad8d598aa5cd42d9f6bb3d14e0bcd94 [file] [log] [blame]
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]1.\"***************************************************************************
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame]2.\" Copyright 2018-2023,2024 Thomas E. Dickey *
3.\" Copyright 1998-2005,2010 Free Software Foundation, Inc. *
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]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.\"
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame]30.\" $Id: curs_beep.3x,v 1.29 2024/04/20 21:20:07 tom Exp $
31.TH curs_beep 3X 2024-04-20 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls"
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]32.SH NAME
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame]33\fB\%beep\fP,
34\fB\%flash\fP \-
35ring the (visual) bell of the terminal with \fIcurses\fR
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]36.SH SYNOPSIS
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame]37.nf
38\fB#include <curses.h>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]39.PP
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame]40\fBint beep(void);
41\fBint flash(void);
42.fi
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]43.SH DESCRIPTION
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame]44The \fBbeep\fP and \fBflash\fP routines are used to alert the terminal user.
45The routine \fBbeep\fP sounds an audible alarm on the terminal, if possible;
46otherwise it flashes the screen (visible bell).
47The routine \fBflash\fP
48flashes the screen, and if that is not possible, sounds the alert.
49If neither
50alert is possible, nothing happens.
51Nearly all terminals have an audible alert
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]52(bell or beep), but only some can flash the screen.
53.SH RETURN VALUE
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame]54These routines return \fBOK\fP if they succeed in beeping or flashing,
55\fBERR\fP otherwise.
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]56.SH EXTENSIONS
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame]57SVr4's beep and flash routines always returned \fBOK\fP, so it was not
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]58possible to tell when the beep or flash failed.
59.SH PORTABILITY
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame]60These functions are described in X/Open Curses, Issue 4.
61Like SVr4, it specifies that they always return \fBOK\fP.
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]62.SH SEE ALSO
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame]63\fB\%curses\fP(3X)