Amit Daniel Kachhap | e6a01f5 | 2011-07-20 11:45:59 +0530 | [diff] [blame] | 1 | .\"*************************************************************************** |
Steve Kondik | ae271bc | 2015-11-15 02:50:53 +0100 | [diff] [blame] | 2 | .\" Copyright (c) 1998-2005,2010 Free Software Foundation, Inc. * |
Amit Daniel Kachhap | e6a01f5 | 2011-07-20 11:45:59 +0530 | [diff] [blame] | 3 | .\" * |
| 4 | .\" Permission is hereby granted, free of charge, to any person obtaining a * |
| 5 | .\" copy of this software and associated documentation files (the * |
| 6 | .\" "Software"), to deal in the Software without restriction, including * |
| 7 | .\" without limitation the rights to use, copy, modify, merge, publish, * |
| 8 | .\" distribute, distribute with modifications, sublicense, and/or sell * |
| 9 | .\" copies of the Software, and to permit persons to whom the Software is * |
| 10 | .\" furnished to do so, subject to the following conditions: * |
| 11 | .\" * |
| 12 | .\" The above copyright notice and this permission notice shall be included * |
| 13 | .\" in all copies or substantial portions of the Software. * |
| 14 | .\" * |
| 15 | .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * |
| 16 | .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * |
| 17 | .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * |
| 18 | .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * |
| 19 | .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * |
| 20 | .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * |
| 21 | .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE. * |
| 22 | .\" * |
| 23 | .\" Except as contained in this notice, the name(s) of the above copyright * |
| 24 | .\" holders shall not be used in advertising or otherwise to promote the * |
| 25 | .\" sale, use or other dealings in this Software without prior written * |
| 26 | .\" authorization. * |
| 27 | .\"*************************************************************************** |
| 28 | .\" |
Steve Kondik | ae271bc | 2015-11-15 02:50:53 +0100 | [diff] [blame] | 29 | .\" $Id: curs_beep.3x,v 1.12 2010/12/04 18:36:44 tom Exp $ |
Amit Daniel Kachhap | e6a01f5 | 2011-07-20 11:45:59 +0530 | [diff] [blame] | 30 | .TH curs_beep 3X "" |
| 31 | .SH NAME |
Steve Kondik | ae271bc | 2015-11-15 02:50:53 +0100 | [diff] [blame] | 32 | \fBbeep\fR, \fBflash\fR \- \fBcurses\fR bell and screen flash routines |
Amit Daniel Kachhap | e6a01f5 | 2011-07-20 11:45:59 +0530 | [diff] [blame] | 33 | .SH SYNOPSIS |
| 34 | \fB#include <curses.h>\fR |
| 35 | .PP |
| 36 | \fBint beep(void);\fR |
| 37 | .br |
| 38 | \fBint flash(void);\fR |
| 39 | .br |
| 40 | .SH DESCRIPTION |
| 41 | The \fBbeep\fR and \fBflash\fR routines are used to alert the terminal user. |
| 42 | The routine \fBbeep\fR sounds an audible alarm on the terminal, if possible; |
| 43 | otherwise it flashes the screen (visible bell). The routine \fBflash\fR |
| 44 | flashes the screen, and if that is not possible, sounds the alert. If neither |
| 45 | alert is possible, nothing happens. Nearly all terminals have an audible alert |
| 46 | (bell or beep), but only some can flash the screen. |
| 47 | .SH RETURN VALUE |
| 48 | These routines return \fBOK\fR if they succeed in beeping or flashing, |
| 49 | \fBERR\fR otherwise. |
| 50 | .SH EXTENSIONS |
| 51 | SVr4's beep and flash routines always returned \fBOK\fR, so it was not |
| 52 | possible to tell when the beep or flash failed. |
| 53 | .SH PORTABILITY |
| 54 | These functions are described in the XSI Curses standard, Issue 4. |
| 55 | Like SVr4, it specifies that they always return \fBOK\fR. |
| 56 | .SH SEE ALSO |
| 57 | \fBcurses\fR(3X) |