ncurses 5.1
[ncurses.git] / doc / html / man / curs_beep.3x.html
1 <HTML>
2 <BODY>
3 <PRE>
4 <!-- Manpage converted by man2html 3.0.1 -->
5
6 </PRE>
7 <H2>NAME</H2><PRE>
8        <B>beep</B>, <B>flash</B> - <B>curses</B> bell and screen flash routines
9
10
11 </PRE>
12 <H2>SYNOPSIS</H2><PRE>
13        <B>#include</B> <B>&lt;curses.h&gt;</B>
14
15        <B>int</B> <B>beep(void);</B>
16        <B>int</B> <B>flash(void);</B>
17
18
19 </PRE>
20 <H2>DESCRIPTION</H2><PRE>
21        The <B>beep</B> and <B>flash</B> routines are used to alert the terminal
22        user.  The routine <B>beep</B> sounds an  audible  alarm  on  the
23        terminal,  if  possible;  otherwise  it flashes the screen
24        (visible bell).  The routine <B>flash</B> flashes the screen, and
25        if  that  is  not  possible, sounds the alert.  If neither
26        alert is possible, nothing happens.  Nearly all  terminals
27        have  an  audible  alert (bell or beep), but only some can
28        flash the screen.
29
30
31 </PRE>
32 <H2>RETURN VALUE</H2><PRE>
33        These routines return <B>OK</B> if they  succeed  in  beeping  or
34        flashing, <B>ERR</B> otherwise.
35
36
37 </PRE>
38 <H2>EXTENSIONS</H2><PRE>
39        SVr4's  beep  and flash routines always returned <B>OK</B>, so it
40        was not possible to tell when the beep or flash failed.
41
42
43 </PRE>
44 <H2>PORTABILITY</H2><PRE>
45        These functions are defined in the  XSI  Curses  standard,
46        Issue  4.  Like SVr4, it specifies that they always return
47        <B>OK</B>.
48
49
50 </PRE>
51 <H2>SEE ALSO</H2><PRE>
52        <B><A HREF="ncurses.3x.html">curses(3x)</A></B>
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73 </PRE>
74 <HR>
75 <ADDRESS>
76 Man(1) output converted with
77 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
78 </ADDRESS>
79 </BODY>
80 </HTML>