util/X86LINUX64/man/mann/beep.n

   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 '\" The definitions below are for supplemental macros used in Tcl/Tk
  21 '\" manual entries.
  22 '\"
  23 '\" .AP type name in/out ?indent?
  24 '\"     Start paragraph describing an argument to a library procedure.
  25 '\"     type is type of argument (int, etc.), in/out is either "in", "out",
  26 '\"     or "in/out" to describe whether procedure reads or modifies arg,
  27 '\"     and indent is equivalent to second arg of .IP (shouldn't ever be
  28 '\"     needed;  use .AS below instead)
  29 '\"
  30 '\" .AS ?type? ?name?
  31 '\"     Give maximum sizes of arguments for setting tab stops.  Type and
  32 '\"     name are examples of largest possible arguments that will be passed
  33 '\"     to .AP later.  If args are omitted, default tab stops are used.
  34 '\"
  35 '\" .BS
  36 '\"     Start box enclosure.  From here until next .BE, everything will be
  37 '\"     enclosed in one large box.
  38 '\"
  39 '\" .BE
  40 '\"     End of box enclosure.
  41 '\"
  42 '\" .CS
  43 '\"     Begin code excerpt.
  44 '\"
  45 '\" .CE
  46 '\"     End code excerpt.
  47 '\"
  48 '\" .VS ?version? ?br?
  49 '\"     Begin vertical sidebar, for use in marking newly-changed parts
  50 '\"     of man pages.  The first argument is ignored and used for recording
  51 '\"     the version when the .VS was added, so that the sidebars can be
  52 '\"     found and removed when they reach a certain age.  If another argument
  53 '\"     is present, then a line break is forced before starting the sidebar.
  54 '\"
  55 '\" .VE
  56 '\"     End of vertical sidebar.
  57 '\"
  58 '\" .DS
  59 '\"     Begin an indented unfilled display.
  60 '\"
  61 '\" .DE
  62 '\"     End of indented unfilled display.
  63 '\"
  64 '\" .SO
  65 '\"     Start of list of standard options for a Tk widget.  The
  66 '\"     options follow on successive lines, in four columns separated
  67 '\"     by tabs.
  68 '\"
  69 '\" .SE
  70 '\"     End of list of standard options for a Tk widget.
  71 '\"
  72 '\" .OP cmdName dbName dbClass
  73 '\"     Start of description of a specific option.  cmdName gives the
  74 '\"     option's name as specified in the class command, dbName gives
  75 '\"     the option's name in the option database, and dbClass gives
  76 '\"     the option's class in the option database.
  77 '\"
  78 '\" .UL arg1 arg2
  79 '\"     Print arg1 underlined, then print arg2 normally.
  80 '\"
  81 '\" RCS: @(#) $Id: man.macros,v 1.3 2001/02/17 07:46:19 ghowlett Exp $
  82 '\"
  83 '\"     # Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
  84 .if t .wh -1.3i ^B
  85 .nr ^l \n(.l
  86 .ad b
  87 '\"     # Start an argument description
  88 .de AP
  89 .ie !"\\$4"" .TP \\$4
  90 .el \{\
  91 .   ie !"\\$2"" .TP \\n()Cu
  92 .   el          .TP 15
  93 .\}
  94 .ta \\n()Au \\n()Bu
  95 .ie !"\\$3"" \{\
  96 \&\\$1  \\fI\\$2\\fP    (\\$3)
  97 .\".b
  98 .\}
  99 .el \{\
 100 .br
 101 .ie !"\\$2"" \{\
 102 \&\\$1  \\fI\\$2\\fP
 103 .\}
 104 .el \{\
 105 \&\\fI\\$1\\fP
 106 .\}
 107 .\}
 108 ..
 109 '\"     # define tabbing values for .AP
 110 .de AS
 111 .nr )A 10n
 112 .if !"\\$1"" .nr )A \\w'\\$1'u+3n
 113 .nr )B \\n()Au+15n
 114 .\"
 115 .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
 116 .nr )C \\n()Bu+\\w'(in/out)'u+2n
 117 ..
 118 .AS Tcl_Interp Tcl_CreateInterp in/out
 119 '\"     # BS - start boxed text
 120 '\"     # ^y = starting y location
 121 '\"     # ^b = 1
 122 .de BS
 123 .br
 124 .mk ^y
 125 .nr ^b 1u
 126 .if n .nf
 127 .if n .ti 0
 128 .if n \l'\\n(.lu\(ul'
 129 .if n .fi
 130 ..
 131 '\"     # BE - end boxed text (draw box now)
 132 .de BE
 133 .nf
 134 .ti 0
 135 .mk ^t
 136 .ie n \l'\\n(^lu\(ul'
 137 .el \{\
 138 .\"     Draw four-sided box normally, but don't draw top of
 139 .\"     box if the box started on an earlier page.
 140 .ie !\\n(^b-1 \{\
 141 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
 142 .\}
 143 .el \}\
 144 \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
 145 .\}
 146 .\}
 147 .fi
 148 .br
 149 .nr ^b 0
 150 ..
 151 '\"     # VS - start vertical sidebar
 152 '\"     # ^Y = starting y location
 153 '\"     # ^v = 1 (for troff;  for nroff this doesn't matter)
 154 .de VS
 155 .if !"\\$2"" .br
 156 .mk ^Y
 157 .ie n 'mc \s12\(br\s0
 158 .el .nr ^v 1u
 159 ..
 160 '\"     # VE - end of vertical sidebar
 161 .de VE
 162 .ie n 'mc
 163 .el \{\
 164 .ev 2
 165 .nf
 166 .ti 0
 167 .mk ^t
 168 \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
 169 .sp -1
 170 .fi
 171 .ev
 172 .\}
 173 .nr ^v 0
 174 ..
 175 '\"     # Special macro to handle page bottom:  finish off current
 176 '\"     # box/sidebar if in box/sidebar mode, then invoked standard
 177 '\"     # page bottom macro.
 178 .de ^B
 179 .ev 2
 180 'ti 0
 181 'nf
 182 .mk ^t
 183 .if \\n(^b \{\
 184 .\"     Draw three-sided box if this is the box's first page,
 185 .\"     draw two sides but no top otherwise.
 186 .ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
 187 .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
 188 .\}
 189 .if \\n(^v \{\
 190 .nr ^x \\n(^tu+1v-\\n(^Yu
 191 \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
 192 .\}
 193 .bp
 194 'fi
 195 .ev
 196 .if \\n(^b \{\
 197 .mk ^y
 198 .nr ^b 2
 199 .\}
 200 .if \\n(^v \{\
 201 .mk ^Y
 202 .\}
 203 ..
 204 '\"     # DS - begin display
 205 .de DS
 206 .RS
 207 .nf
 208 .sp
 209 ..
 210 '\"     # DE - end display
 211 .de DE
 212 .fi
 213 .RE
 214 .sp
 215 ..
 216 '\"     # SO - start of list of standard options
 217 .de SO
 218 .SH "STANDARD OPTIONS"
 219 .LP
 220 .nf
 221 .ta 4c 8c 12c
 222 .ft B
 223 ..
 224 '\"     # SE - end of list of standard options
 225 .de SE
 226 .fi
 227 .ft R
 228 .LP
 229 See the \\fBoptions\\fR manual entry for details on the standard options.
 230 ..
 231 '\"     # OP - start of full description for a single option
 232 .de OP
 233 .LP
 234 .nf
 235 .ta 4c
 236 Command-Line Name:      \\fB\\$1\\fR
 237 Database Name:  \\fB\\$2\\fR
 238 Database Class: \\fB\\$3\\fR
 239 .fi
 240 .IP
 241 ..
 242 '\"     # CS - begin code excerpt
 243 .de CS
 244 .RS
 245 .nf
 246 .ta .25i .5i .75i 1i
 247 .ft CW
 248 .sp
 249 ..
 250 '\"     # CE - end code excerpt
 251 .de CE
 252 .fi
 253 .RE
 254 .ft R
 255 .sp
 256 ..
 257 .de UL
 258 \\$1\l'|0\(ul'\\$2
 259 ..
 260 .TH beep n 2.4 BLT "BLT Built-In Commands"
 261 .BS
 262 '\" Note:  do not modify the .SH NAME line immediately below!
 263 .SH NAME
 264 beep \- ring the bell
 265 .SH SYNOPSIS
 266 \fBbeep\fR ?\fIpercent\fR?
 267 .BE
 268 .SH DESCRIPTION
 269 The \fBbeep\fR command rings the keyboard bell.  \fIPercent\fR is
 270 relative to the base volume of the keyboard bell and can range from
 271 -100 to 100 inclusive.
 272 .PP
 273 If \fIpercent\fR is nonnegative then the bell volume is:
 274 .CS
 275 base - [(base * \fIpercent\fR) / 100] + \fIpercent\fR
 276 .CE
 277 If \fIpercent\fR is negative then the bell volume is:
 278 .CS C
 279 base + [(base * \fIpercent\fR) / 100]
 280 .CE
 281 The default \fIpercent\fR is 50.
 282 .SH EXAMPLE
 283 .CS
 284 beep
 285 .CE
 286 .SH KEYWORDS
 287 bell, beep