X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_beep.3x.html;h=e486c8b4593a78f36b6c768233535c9524ae8958;hp=1f009d8c163c9710b628bac4afd9e60f26c47dad;hb=HEAD;hpb=00dd248b527ad47f0fc3b0776a0889da0ac926d0 diff --git a/doc/html/man/curs_beep.3x.html b/doc/html/man/curs_beep.3x.html index 1f009d8c..bb53a28e 100644 --- a/doc/html/man/curs_beep.3x.html +++ b/doc/html/man/curs_beep.3x.html @@ -27,19 +27,19 @@ * sale, use or other dealings in this Software without prior written * * authorization. * **************************************************************************** - * @Id: curs_beep.3x,v 1.29 2024/04/20 21:20:07 tom Exp @ + * @Id: curs_beep.3x,v 1.31 2024/05/18 20:06:33 tom Exp @ --> -curs_beep 3x 2024-04-20 ncurses 6.4 Library calls +curs_beep 3x 2024-05-18 ncurses 6.5 Library calls -

curs_beep 3x 2024-04-20 ncurses 6.4 Library calls

+

curs_beep 3x 2024-05-18 ncurses 6.5 Library calls

 curs_beep(3x)                    Library calls                   curs_beep(3x)
 
@@ -58,35 +58,47 @@
 
 
 

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.
+       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.
+       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.
+       In ncurses, these functions can return ERR.
 
 
 

PORTABILITY

-       These functions are described in X/Open Curses, 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.
+
+
+

HISTORY

+       beep and flash appeared in SVr2 (1984).
 
 
 

SEE ALSO

-       curses(3x)
+       curses(3x), terminfo(5)
 
 
 
-ncurses 6.4                       2024-04-20                     curs_beep(3x)
+ncurses 6.5                       2024-05-18                     curs_beep(3x)