usr/src/man/man3xcurses/beep.3xcurses

   1 '\" te
   2 .\"  Copyright (c) 1990, 1995 by Mortice Kern Systems Inc.  All Rights Reserved  Portions Copyright (c) 1996, Sun Microsystems, Inc.  All Rights Reserved
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH BEEP 3XCURSES "Jun 5, 2002"
   7 .SH NAME
   8 beep, flash \- activate audio-visual alarm
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e
  13 \fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ]
  14
  15 \fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ]
  16
  17 #include <curses.h>
  18
  19 \fBint\fR \fBbeep\fR(\fBvoid\fR);
  20 .fi
  21
  22 .LP
  23 .nf
  24 \fBint\fR \fBflash\fR(\fBvoid\fR);
  25 .fi
  26
  27 .SH DESCRIPTION
  28 .sp
  29 .LP
  30 The \fBbeep()\fR and \fBflash()\fR functions produce an audio and visual alarm
  31 on the terminal, respectively.  If the terminal has the capability,
  32 \fBbeep()\fR sounds a bell or beep and  \fBflash()\fR flashes the screen.  One
  33 alarm is substituted for another if the terminal does not support the
  34 capability called (see  \fBterminfo\fR(4) \fBbel\fR and \fBflash\fR
  35 capabilities). For example, a call to \fBbeep()\fR for a terminal without that
  36 capability  results in a flash.
  37 .SH RETURN VALUES
  38 .sp
  39 .LP
  40 These functions always return \fBOK\fR.
  41 .SH ERRORS
  42 .sp
  43 .LP
  44 None.
  45 .SH ATTRIBUTES
  46 .sp
  47 .LP
  48 See \fBattributes\fR(5) for descriptions of the following attributes:
  49 .sp
  50
  51 .sp
  52 .TS
  53 box;
  54 c | c
  55 l | l .
  56 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  57 _
  58 Interface Stability     Standard
  59 _
  60 MT-Level        Unsafe
  61 .TE
  62
  63 .SH SEE ALSO
  64 .sp
  65 .LP
  66 \fBlibcurses\fR(3XCURSES), \fBterminfo\fR(4), \fBattributes\fR(5),
  67 \fBstandards\fR(5)