doc/html/man/curs_beep.3x.html

   1 <!--
   2   ****************************************************************************
   3   * Copyright 2018-2023,2024 Thomas E. Dickey                                *
   4   * Copyright 1998-2005,2010 Free Software Foundation, Inc.                  *
   5   *                                                                          *
   6   * Permission is hereby granted, free of charge, to any person obtaining a  *
   7   * copy of this software and associated documentation files (the            *
   8   * "Software"), to deal in the Software without restriction, including      *
   9   * without limitation the rights to use, copy, modify, merge, publish,      *
  10   * distribute, distribute with modifications, sublicense, and/or sell       *
  11   * copies of the Software, and to permit persons to whom the Software is    *
  12   * furnished to do so, subject to the following conditions:                 *
  13   *                                                                          *
  14   * The above copyright notice and this permission notice shall be included  *
  15   * in all copies or substantial portions of the Software.                   *
  16   *                                                                          *
  17   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
  18   * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
  19   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
  20   * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
  21   * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
  22   * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
  23   * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
  24   *                                                                          *
  25   * Except as contained in this notice, the name(s) of the above copyright   *
  26   * holders shall not be used in advertising or otherwise to promote the     *
  27   * sale, use or other dealings in this Software without prior written       *
  28   * authorization.                                                           *
  29   ****************************************************************************
  30   * @Id: curs_beep.3x,v 1.31 2024/05/18 20:06:33 tom Exp @
  31 -->
  32 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
  33 <HTML>
  34 <HEAD>
  35 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
  36 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
  37 <TITLE>curs_beep 3x 2024-05-18 ncurses 6.5 Library calls</TITLE>
  38 <link rel="author" href="mailto:bug-ncurses@gnu.org">
  39
  40 </HEAD>
  41 <BODY>
  42 <H1 class="no-header">curs_beep 3x 2024-05-18 ncurses 6.5 Library calls</H1>
  43 <PRE>
  44 <STRONG><A HREF="curs_beep.3x.html">curs_beep(3x)</A></STRONG>                    Library calls                   <STRONG><A HREF="curs_beep.3x.html">curs_beep(3x)</A></STRONG>
  45
  46
  47
  48
  49 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
  50        <STRONG>beep</STRONG>, <STRONG>flash</STRONG> - ring the (visual) bell of the terminal with <EM>curses</EM>
  51
  52
  53 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
  54        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
  55
  56        <STRONG>int</STRONG> <STRONG>beep(void);</STRONG>
  57        <STRONG>int</STRONG> <STRONG>flash(void);</STRONG>
  58
  59
  60 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
  61        <STRONG>beep</STRONG>  and  <STRONG>flash</STRONG>  alert  the  terminal user: the former by sounding the
  62        terminal's audible alarm, and the latter  by  visibly  attracting  user
  63        attention.    Commonly,   a   terminal  implements  a  visual  bell  by
  64        momentarily reversing the character foreground and background colors on
  65        the  entire  display;  even  a  monochrome  device  can do this.  These
  66        functions each attempt the other alert type if  the  one  requested  is
  67        unavailable.   If  neither  is  available,  <EM>curses</EM>  performs no action.
  68        Nearly all terminals have an audible alert mechanism such as a bell  or
  69        piezoelectric buzzer, but only some can flash the screen.
  70
  71
  72 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
  73        These functions return <STRONG>OK</STRONG> on success and <STRONG>ERR</STRONG> on failure.
  74
  75        In  <EM>ncurses</EM>, <STRONG>beep</STRONG> and <STRONG>flash</STRONG> return <STRONG>OK</STRONG> if the terminal type supports the
  76        corresponding capability: <STRONG>bell</STRONG> (<STRONG>bel</STRONG>) for <STRONG>beep</STRONG> and <STRONG>flash_screen</STRONG>  (<STRONG>flash</STRONG>)
  77        for <STRONG>flash</STRONG>.  Otherwise they return <STRONG>ERR</STRONG>.
  78
  79
  80 </PRE><H2><a name="h2-EXTENSIONS">EXTENSIONS</a></H2><PRE>
  81        In <EM>ncurses</EM>, these functions can return <STRONG>ERR</STRONG>.
  82
  83
  84 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
  85        X/Open  Curses,  Issue  4  describes  these functions.  It specifies no
  86        error conditions for them.
  87
  88        On SVr4 <EM>curses</EM>, they always return <STRONG>OK</STRONG>, and X/Open Curses specifies them
  89        as doing so.
  90
  91
  92 </PRE><H2><a name="h2-HISTORY">HISTORY</a></H2><PRE>
  93        <STRONG>beep</STRONG> and <STRONG>flash</STRONG> appeared in SVr2 (1984).
  94
  95
  96 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
  97        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG>
  98
  99
 100
 101 ncurses 6.5                       2024-05-18                     <STRONG><A HREF="curs_beep.3x.html">curs_beep(3x)</A></STRONG>
 102 </PRE>
 103 <div class="nav">
 104 <ul>
 105 <li><a href="#h2-NAME">NAME</a></li>
 106 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
 107 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
 108 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
 109 <li><a href="#h2-EXTENSIONS">EXTENSIONS</a></li>
 110 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
 111 <li><a href="#h2-HISTORY">HISTORY</a></li>
 112 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
 113 </ul>
 114 </div>
 115 </BODY>
 116 </HTML>