xref: /freebsd/usr.bin/beep/beep.1 (revision 9978553d0199e7ec0bdd1c44fc7f6c7b0c11e43b)
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.Dd November 19, 2025
25.Dt BEEP 1
26.Os
27.Sh NAME
28.Nm beep
29.Nd play a beep sound
30.Sh SYNOPSIS
31.Nm
32.Op Fl Bh
33.Op Fl D Ar duration_ms
34.Op Fl F Ar frequency_hz
35.Op Fl d Ar oss_device
36.Op Fl g Ar gain
37.Op Fl r Ar sample_rate_hz
38.Sh DESCRIPTION
39The
40.Nm
41utility is used to play a beep on the sound card.
42.Pp
43The options are as follows:
44.Bl -tag -width "-r sample_rate_hz"
45.It Fl B
46Runs the
47.Nm
48utility in the background.
49.It Fl D Ar duration_ms
50Sets the duration of the beep in milliseconds,
51between 50\~ms and 2000\~ms inclusively.
52The default is 150\~ms.
53.It Fl F Ar frequency_hz
54Sets the center frequency of the beep in Hz.
55The default is 440\~Hz.
56.It Fl d Ar oss_device
57Sets the OSS device to use.
58The default is
59.Pa /dev/dsp .
60.It Fl g Ar gain
61Sets the waveform gain, between 0 and 100 inclusively.
62The default is 75.
63.It Fl h
64Display summary of options.
65.It Fl r Ar sample_rate_hz
66Sets the sound card sample rate in Hz,
67between 8000\~Hz and 48000\~Hz inclusively.
68The default is 48000\~Hz.
69.El
70.Sh EXAMPLES
71Play default beep sound on
72.Pa /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
80The
81.Nm
82utility first appeared in
83.Fx 14.0 .
84.Sh AUTHORS
85.An Hans Petter Selasky Aq Mt hselasky@FreeBSD.org
86