curs_beep.3x - Man Page

ring the (visual) bell of the terminal with curses

Synopsis

#include <curses.h>

int beep(void);
int flash(void);

Description

beep and flash alert the terminal user: the former by sounding the terminal's audible alarm, and the latter by visibly attracting user attention. Commonly, a terminal implements a visual bell by momentarily reversing the character foreground and background colors on the entire display; even a monochrome device can do this. These functions each attempt the other alert type if the one requested is unavailable. If neither is available, curses performs no action. Nearly all terminals have an audible alert mechanism such as a bell or piezoelectric buzzer, but only some can flash the screen.

Return Value

These functions return OK on success and ERR on failure.

In ncurses, beep and flash return OK if the terminal type supports the corresponding capability: bell (bel) for beep and flash_screen (flash) for flash. Otherwise they return ERR.

Extensions

In ncurses, these functions can return ERR.

Portability

X/Open Curses, Issue 4 describes these functions. It specifies no error conditions for them.

On SVr4 curses, they always return OK, and X/Open Curses specifies them as doing so.

History

beep and flash appeared in SVr2 (1984).

See Also

curses(3X), terminfo(5)

Referenced By

The man pages beep.3x(3) and flash.3x(3) are aliases of curs_beep.3x(3).

2024-06-22 ncurses 6.5 Library calls