xref: /freebsd/usr.bin/beep/beep.1 (revision 6e1fc0118033f42b7c0d3623c8f67a89ebecabb2)
18abfbe5aSHans Petter Selasky.\"-
28abfbe5aSHans Petter Selasky.\" Copyright (c) 2021 Hans Petter Selasky <hselasky@FreeBSD.org>
38abfbe5aSHans Petter Selasky.\"
48abfbe5aSHans Petter Selasky.\" Redistribution and use in source and binary forms, with or without
58abfbe5aSHans Petter Selasky.\" modification, are permitted provided that the following conditions
68abfbe5aSHans Petter Selasky.\" are met:
78abfbe5aSHans Petter Selasky.\" 1. Redistributions of source code must retain the above copyright
88abfbe5aSHans Petter Selasky.\"    notice, this list of conditions and the following disclaimer.
98abfbe5aSHans Petter Selasky.\" 2. Redistributions in binary form must reproduce the above copyright
108abfbe5aSHans Petter Selasky.\"    notice, this list of conditions and the following disclaimer in the
118abfbe5aSHans Petter Selasky.\"    documentation and/or other materials provided with the distribution.
128abfbe5aSHans Petter Selasky.\"
138abfbe5aSHans Petter Selasky.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
148abfbe5aSHans Petter Selasky.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
158abfbe5aSHans Petter Selasky.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
168abfbe5aSHans Petter Selasky.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
178abfbe5aSHans Petter Selasky.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
188abfbe5aSHans Petter Selasky.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
198abfbe5aSHans Petter Selasky.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
208abfbe5aSHans Petter Selasky.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
218abfbe5aSHans Petter Selasky.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
228abfbe5aSHans Petter Selasky.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
238abfbe5aSHans Petter Selasky.\"
248abfbe5aSHans Petter Selasky.Dd November 4, 2021
258abfbe5aSHans Petter Selasky.Dt beep 1
268abfbe5aSHans Petter Selasky.Os
278abfbe5aSHans Petter Selasky.Sh NAME
288abfbe5aSHans Petter Selasky.Nm beep
298abfbe5aSHans Petter Selasky.Nd play a beep sound
308abfbe5aSHans Petter Selasky.Sh SYNOPSIS
318abfbe5aSHans Petter Selasky.Nm
328abfbe5aSHans Petter Selasky.Op Fl F Ar frequency
338abfbe5aSHans Petter Selasky.Op Fl D Ar duration_ms
348abfbe5aSHans Petter Selasky.Op Fl r Ar sample_rate_hz
358abfbe5aSHans Petter Selasky.Op Fl d Ar oss_device
368abfbe5aSHans Petter Selasky.Op Fl g Ar gain
378abfbe5aSHans Petter Selasky.Op Fl B
388abfbe5aSHans Petter Selasky.Op Fl h
398abfbe5aSHans Petter Selasky.Sh DESCRIPTION
408abfbe5aSHans Petter SelaskyThe
418abfbe5aSHans Petter Selasky.Nm
428abfbe5aSHans Petter Selaskyutility is used to playback a beep on the soundcard.
438abfbe5aSHans Petter Selasky.Pp
448abfbe5aSHans Petter SelaskyThe options are as follows:
458abfbe5aSHans Petter Selasky.Bl -tag -width "-f device"
468abfbe5aSHans Petter Selasky.It Fl F
478abfbe5aSHans Petter SelaskySets the center frequency of the beep in Hz.
488abfbe5aSHans Petter SelaskyThe default is 440 Hz .
498abfbe5aSHans Petter Selasky.It Fl D
508abfbe5aSHans Petter SelaskySets the duration of the beep in milliseconds.
518abfbe5aSHans Petter SelaskyThe default is 150 ms .
528abfbe5aSHans Petter Selasky.It Fl d
538abfbe5aSHans Petter SelaskySets the soundcard to use.
548abfbe5aSHans Petter SelaskyThe default is /dev/dsp .
558abfbe5aSHans Petter Selasky.It Fl r
568abfbe5aSHans Petter SelaskySets the soundcard samplerate in Hz.
578abfbe5aSHans Petter SelaskyThe default is 48000 Hz.
588abfbe5aSHans Petter Selasky.It Fl g
598abfbe5aSHans Petter SelaskySets the waveform gain, between 0 and 100 inclusively.
608abfbe5aSHans Petter SelaskyThe default is 75.
618abfbe5aSHans Petter Selasky.It Fl B
628abfbe5aSHans Petter SelaskyRuns the
638abfbe5aSHans Petter Selasky.Nm
648abfbe5aSHans Petter Selaskyutility in the background.
658abfbe5aSHans Petter Selasky.It Fl h
668abfbe5aSHans Petter SelaskyDisplay summary of options.
678abfbe5aSHans Petter Selasky.El
688abfbe5aSHans Petter Selasky.Sh EXAMPLES
698abfbe5aSHans Petter Selasky.Pp
708abfbe5aSHans Petter SelaskyPlayback default beep sound using /dev/dsp .
718abfbe5aSHans Petter Selasky.Bl -tag -width Ds -offset indent
728abfbe5aSHans Petter Selasky.It $ beep
738abfbe5aSHans Petter Selasky.El
748abfbe5aSHans Petter Selasky.Sh SEE ALSO
758abfbe5aSHans Petter Selasky.Xr mixer 3 ,
76*6e1fc011SGraham Percival.Xr sound 4
778abfbe5aSHans Petter Selasky.Sh HISTORY
788abfbe5aSHans Petter SelaskyThe
798abfbe5aSHans Petter Selasky.Nm
808abfbe5aSHans Petter Selaskyutility first appeared in FreeBSD 14.0.
818abfbe5aSHans Petter Selasky.Sh AUTHORS
828abfbe5aSHans Petter Selasky.An Hans Petter Selasky Aq Mt hselasky@FreeBSD.org
83