xref: /freebsd/usr.bin/beep/beep.1 (revision a64729f5077d77e13b9497cb33ecb3c82e606ee8)
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 4, 2021
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 F Ar frequency
33.Op Fl D Ar duration_ms
34.Op Fl r Ar sample_rate_hz
35.Op Fl d Ar oss_device
36.Op Fl g Ar gain
37.Op Fl B
38.Op Fl h
39.Sh DESCRIPTION
40The
41.Nm
42utility is used to playback a beep on the soundcard.
43.Pp
44The options are as follows:
45.Bl -tag -width "-f device"
46.It Fl F
47Sets the center frequency of the beep in Hz.
48The default is 440 Hz .
49.It Fl D
50Sets the duration of the beep in milliseconds.
51The default is 150 ms .
52.It Fl d
53Sets the soundcard to use.
54The default is /dev/dsp .
55.It Fl r
56Sets the soundcard samplerate in Hz.
57The default is 48000 Hz.
58.It Fl g
59Sets the waveform gain, between 0 and 100 inclusively.
60The default is 75.
61.It Fl B
62Runs the
63.Nm
64utility in the background.
65.It Fl h
66Display summary of options.
67.El
68.Sh EXAMPLES
69.Pp
70Playback default beep sound using /dev/dsp .
71.Bl -tag -width Ds -offset indent
72.It $ beep
73.El
74.Sh SEE ALSO
75.Xr mixer 3 ,
76.Xr sound 4 ,
77.Sh HISTORY
78The
79.Nm
80utility first appeared in FreeBSD 14.0.
81.Sh AUTHORS
82.An Hans Petter Selasky Aq Mt hselasky@FreeBSD.org
83