X-Git-Url: http://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_beep.3x.html;h=e486c8b4593a78f36b6c768233535c9524ae8958;hb=HEAD;hp=7abb652400a24e2f95ec21e85d8eff43b6cd7ab4;hpb=c6cfd97b8beaf0f6deafbf8aac7281cf6aa7f012;p=ncurses.git diff --git a/doc/html/man/curs_beep.3x.html b/doc/html/man/curs_beep.3x.html index 7abb6524..8dc4771f 100644 --- a/doc/html/man/curs_beep.3x.html +++ b/doc/html/man/curs_beep.3x.html @@ -1,6 +1,7 @@ - - -curs_beep 3x - - + +curs_beep 3x 2024-06-22 ncurses 6.5 Library calls + + -

curs_beep 3x

-
+

curs_beep 3x 2024-06-22 ncurses 6.5 Library calls

-curs_beep(3x)                                             curs_beep(3x)
+curs_beep(3x)                    Library calls                   curs_beep(3x)
 
 
 
 
-
-

NAME

-       beep, flash - curses bell and screen flash routines
+

NAME

+       beep, flash - ring the (visual) bell of the terminal with curses
 
 
-
-

SYNOPSIS

+

SYNOPSIS

        #include <curses.h>
 
        int beep(void);
        int flash(void);
 
 
-
-

DESCRIPTION

-       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.
+

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 routines return OK if they  succeed  in  beeping  or
-       flashing, ERR otherwise.
+

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

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

EXTENSIONS

+       In ncurses, these functions can return ERR.
 
-
-

PORTABILITY

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

PORTABILITY

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

SEE ALSO

-       curses(3x)
+       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)
 
 
 
-                                                          curs_beep(3x)
+ncurses 6.5                       2024-06-22                     curs_beep(3x)