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