Changeset View
Changeset View
Standalone View
Standalone View
usr.bin/beep/beep.1
- This file was added.
.\"- | |||||
.\" Copyright (c) 2021 Hans Petter Selasky <hselasky@FreeBSD.org> | |||||
.\" | |||||
.\" Redistribution and use in source and binary forms, with or without | |||||
.\" modification, are permitted provided that the following conditions | |||||
.\" are met: | |||||
.\" 1. Redistributions of source code must retain the above copyright | |||||
.\" notice, this list of conditions and the following disclaimer. | |||||
.\" 2. Redistributions in binary form must reproduce the above copyright | |||||
.\" notice, this list of conditions and the following disclaimer in the | |||||
.\" documentation and/or other materials provided with the distribution. | |||||
.\" | |||||
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR | |||||
.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES | |||||
.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. | |||||
.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, | |||||
.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT | |||||
.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, | |||||
.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY | |||||
.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT | |||||
.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF | |||||
.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | |||||
.\" | |||||
.\" $FreeBSD$ | |||||
.\" | |||||
.Dd October 26, 2021 | |||||
.Dt beep 1 | |||||
.Os | |||||
.Sh NAME | |||||
.Nm beep | |||||
.Nd send beep to soundcard | |||||
.Sh SYNOPSIS | |||||
emaste: play a beep (as you use in the text below) reads nicer to me -- "play beep on soundcard" or… | |||||
.Nm | |||||
.Op Fl F Ar frequency | |||||
.Op Fl D Ar duration_ms | |||||
.Op Fl r Ar sample_rate_hz | |||||
.Op Fl d Ar oss_device | |||||
.Op Fl g Ar gain | |||||
.Op Fl B | |||||
.Op Fl h | |||||
.Sh DESCRIPTION | |||||
The | |||||
.Nm | |||||
utility is used to playback a beep to the soundcard. | |||||
.Pp | |||||
Done Inline Actionss/to the/on the/ maybe emaste: s/to the/on the/ maybe
| |||||
The options are as follows: | |||||
.Bl -tag -width "-f device" | |||||
.It Fl F | |||||
Sets the center frequency of the beep in Hz. | |||||
The default is 440Hz . | |||||
.It Fl D | |||||
Done Inline ActionsI don't have the authority to say for sure, but I think we should use space to separate the numbers from the units here and below. pstef: I don't have the authority to say for sure, but I think we should use space to separate the… | |||||
Sets the duration of the beep in milliseconds. | |||||
The default is 150ms . | |||||
.It Fl D | |||||
Sets the soundcard to use. | |||||
The default is /dev/dsp . | |||||
.It Fl r | |||||
Sets the soundcard samplerate in Hz. | |||||
The default is 48000Hz. | |||||
.It Fl g | |||||
Sets the waveform gain, between 0 and 100 inclusivly. | |||||
The default is 75. | |||||
Done Inline ActionsTypo, inclusively. pstef: Typo, inclusively. | |||||
.It Fl B | |||||
Runs the | |||||
.Nm | |||||
utility in the background. | |||||
.It Fl h | |||||
Display summary of options. | |||||
.El | |||||
.Sh EXAMPLES | |||||
.Pp | |||||
Playback default beep sound using /dev/dsp . | |||||
.Bl -tag -width Ds -offset indent | |||||
.It $ beep | |||||
.El | |||||
.Sh SEE ALSO | |||||
.Xr mixer 3 , | |||||
.Xr sound 4 , | |||||
.Sh HISTORY | |||||
The | |||||
.Nm | |||||
utility first appeared in FreeBSD 14.0. | |||||
.Sh AUTHORS | |||||
.An Hans Petter Selasky Aq Mt hselasky@FreeBSD.org |
play a beep (as you use in the text below) reads nicer to me -- "play beep on soundcard" or even just "play a beep sound"?