usr.bin/beep/beep.1

   1 .\"-
   2 .\" Copyright (c) 2021 Hans Petter Selasky <hselasky@FreeBSD.org>
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  14 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  15 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  16 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  17 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  18 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  19 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  20 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  21 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  22 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  23 .\"
  24 .\" $FreeBSD$
  25 .\"
  26 .Dd November 4, 2021
  27 .Dt beep 1
  28 .Os
  29 .Sh NAME
  30 .Nm beep
  31 .Nd play a beep sound
  32 .Sh SYNOPSIS
  33 .Nm
  34 .Op Fl F Ar frequency
  35 .Op Fl D Ar duration_ms
  36 .Op Fl r Ar sample_rate_hz
  37 .Op Fl d Ar oss_device
  38 .Op Fl g Ar gain
  39 .Op Fl B
  40 .Op Fl h
  41 .Sh DESCRIPTION
  42 The
  43 .Nm
  44 utility is used to playback a beep on the soundcard.
  45 .Pp
  46 The options are as follows:
  47 .Bl -tag -width "-f device"
  48 .It Fl F
  49 Sets the center frequency of the beep in Hz.
  50 The default is 440 Hz .
  51 .It Fl D
  52 Sets the duration of the beep in milliseconds.
  53 The default is 150 ms .
  54 .It Fl d
  55 Sets the soundcard to use.
  56 The default is /dev/dsp .
  57 .It Fl r
  58 Sets the soundcard samplerate in Hz.
  59 The default is 48000 Hz.
  60 .It Fl g
  61 Sets the waveform gain, between 0 and 100 inclusively.
  62 The default is 75.
  63 .It Fl B
  64 Runs the
  65 .Nm
  66 utility in the background.
  67 .It Fl h
  68 Display summary of options.
  69 .El
  70 .Sh EXAMPLES
  71 .Pp
  72 Playback default beep sound using /dev/dsp .
  73 .Bl -tag -width Ds -offset indent
  74 .It $ beep
  75 .El
  76 .Sh SEE ALSO
  77 .Xr mixer 3 ,
  78 .Xr sound 4 ,
  79 .Sh HISTORY
  80 The
  81 .Nm
  82 utility first appeared in FreeBSD 14.0.
  83 .Sh AUTHORS
  84 .An Hans Petter Selasky Aq Mt hselasky@FreeBSD.org