rc: add tiny manual page for opnsense-beep

This commit is contained in:
Franco Fichtner 2021-02-01 11:21:49 +01:00
parent b029e67c21
commit 1250318dc2
3 changed files with 69 additions and 0 deletions

1
plist
View File

@ -1676,6 +1676,7 @@
/usr/local/sbin/opnsense-version
/usr/local/sbin/ping_hosts.sh
/usr/local/sbin/pluginctl
/usr/local/share/man/man8/opnsense-beep.8.gz
/usr/local/share/man/man8/opnsense-importer.8.gz
/usr/local/share/man/man8/opnsense-installer.8.gz
/usr/local/share/man/man8/opnsense-shell.8.gz

View File

@ -0,0 +1,57 @@
.\"
.\" Copyright (c) 2021 Franco Fichtner <franco@opnsense.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 AND CONTRIBUTORS ``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 OR CONTRIBUTORS 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.
.\"
.Dd February 1, 2021
.Dt OPNSENSE-BEEP 8
.Os
.Sh NAME
.Nm opnsense-beep
.Nd OPNsense beep utility
.Sh SYNOPSIS
.Nm
.Op Ar melody
.Sh DESCRIPTION
The
.Nm
will emit system beeps or melodies.
.Pp
Supported melody arguments are as follows:
.Pp
.Bl -bullet -compact
.It
.Ar high
.It
.Ar low
(default)
.It
.Ar start
.It
.Ar stop
.El
.Sh EXIT STATUS
.Ex -std
.Sh AUTHORS
.An Scott Ullrich Aq Mt sullrich@gmail.com

View File

@ -32,6 +32,17 @@ LOW="200"
START="500 400 600 800 800"
STOP="600 800 500 400 400"
while getopts "" OPT; do
case ${OPT} in
*)
echo "Usage: man ${0##*/}" >&2
exit 1
;;
esac
done
shift $((${OPTIND} - 1))
if [ ! -c "/dev/speaker" ]; then
exit
fi