util/src/TclTk/blt2.5/man/beep.mann

   1 '\"
   2 '\" Copyright 1991-1997 by Bell Labs Innovations for Lucent Technologies.
   3 '\"
   4 '\" Permission to use, copy, modify, and distribute this software and its
   5 '\" documentation for any purpose and without fee is hereby granted, provided
   6 '\" that the above copyright notice appear in all copies and that both that the
   7 '\" copyright notice and warranty disclaimer appear in supporting documentation,
   8 '\" and that the names of Lucent Technologies any of their entities not be used
   9 '\" in advertising or publicity pertaining to distribution of the software
  10 '\" without specific, written prior permission.
  11 '\"
  12 '\" Lucent Technologies disclaims all warranties with regard to this software,
  13 '\" including all implied warranties of merchantability and fitness.  In no event
  14 '\" shall Lucent Technologies be liable for any special, indirect or
  15 '\" consequential damages or any damages whatsoever resulting from loss of use,
  16 '\" data or profits, whether in an action of contract, negligence or other
  17 '\" tortuous action, arising out of or in connection with the use or performance
  18 '\" of this software.
  19 '\"
  20 .so man.macros
  21 .TH beep n BLT_VERSION BLT "BLT Built-In Commands"
  22 .BS
  23 '\" Note:  do not modify the .SH NAME line immediately below!
  24 .SH NAME
  25 beep \- ring the bell
  26 .SH SYNOPSIS
  27 \fBbeep\fR ?\fIpercent\fR?
  28 .BE
  29 .SH DESCRIPTION
  30 The \fBbeep\fR command rings the keyboard bell.  \fIPercent\fR is
  31 relative to the base volume of the keyboard bell and can range from
  32 -100 to 100 inclusive.
  33 .PP
  34 If \fIpercent\fR is nonnegative then the bell volume is:
  35 .CS
  36 base - [(base * \fIpercent\fR) / 100] + \fIpercent\fR
  37 .CE
  38 If \fIpercent\fR is negative then the bell volume is:
  39 .CS C
  40 base + [(base * \fIpercent\fR) / 100]
  41 .CE
  42 The default \fIpercent\fR is 50.
  43 .SH EXAMPLE
  44 .CS
  45 beep
  46 .CE
  47 .SH KEYWORDS
  48 bell, beep