X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_beep.3x.html;h=d9719d84b73ef90d810c5c9fcb6f0a623397b542;hp=f48c17421187b6383f88c472ab4e7d54ece1780c;hb=HEAD;hpb=81304798ee736c467839c779c9ca5dca48db7bea diff --git a/doc/html/man/curs_beep.3x.html b/doc/html/man/curs_beep.3x.html index f48c1742..bb53a28e 100644 --- a/doc/html/man/curs_beep.3x.html +++ b/doc/html/man/curs_beep.3x.html @@ -1,6 +1,6 @@
--curs_beep(3x) curs_beep(3x) +curs_beep(3x) Library calls curs_beep(3x)
- beep, flash - curses bell and screen flash routines + beep, flash - ring the (visual) bell of the terminal with curses
@@ -58,35 +58,47 @@
- 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. + 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.
- These routines return OK if they succeed in beeping or flashing, ERR - otherwise. + 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.
- SVr4's beep and flash routines always returned OK, so it was not - possible to tell when the beep or flash failed. + In ncurses, these functions can return ERR.
- These functions are described in the XSI Curses standard, Issue 4. - Like SVr4, it specifies that they always return OK. + 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. + + +
+ beep and flash appeared in SVr2 (1984).
- curses(3x) + curses(3x), terminfo(5) - curs_beep(3x) +ncurses 6.5 2024-05-18 curs_beep(3x)