curs_beep(3x)

curs_beep3x

Curses bell and screen flash routines

Usage

#include <curses.h>

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

Overview

The beep and flash routines are used to alert the terminal user. The routine beep sounds an audible alarm on the terminal, if possible; otherwise it flashes the screen (visible bell). The routine flash 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.

Return value

These routines return OK if they succeed in beeping or flashing, ERR otherwise.

Extensions

SVr4's beep and flash routines always returned OK, so it was not possible to tell when the beep or flash failed.

Portability

These functions are described in the XSI Curses standard, Issue 4. Like SVr4, it specifies that they always return OK.

Releases

155 releases since Mac OS X 10.2; the text changed 2 times.

  1. 10.2–11.5
  2. 12.0.1–13.5
  3. 14.0–26.5

From ncurses 79 in macOS 26.5. Parsed by carta from the page's man source.