Print this page
12287 errors in audio utility man pages
@@ -9,12 +9,13 @@
.\" source. A copy of the CDDL is also available via the Internet at
.\" http://www.illumos.org/license/CDDL.
.\"
.\"
.\" Copyright 2011 Nexenta Systems, Inc. All rights reserved.
+.\" Copyright 2020 Peter Tribble.
.\"
-.TH AUDIOCTL 1 "Mar 18, 2011"
+.TH AUDIOCTL 1 "Feb 8, 2020"
.SH NAME
audioctl - audio device control command line interface
.SH SYNOPSIS
.nf
\fBaudioctl\fR \fBlist-devices\fR
@@ -25,28 +26,33 @@
\fBaudioctl\fR \fBshow-device\fR [\fB-v\fR] [\fB-d\fR \fIdevice\fR]
.fi
.LP
.nf
-\fBaudioctl\fR \fBshow-control\fR [\fB-v\fR] [\fB-d\fR \fIdevice\fB] [\fIcontrol\fR ...]
+\fBaudioctl\fR \fBshow-control\fR [\fB-v\fR] [\fB-d\fR \fIdevice\fR] [\fIcontrol\fR ...]
.fi
.LP
.nf
-\fBaudioctl\fR \fBset-control\fR [\fB-v\fR] [\fB-d\fR \fIdevice\fB] \fIcontrol\fR \fIvalue\fR
+\fBaudioctl\fR \fBset-control\fR [\fB-v\fR] [\fB-d\fR \fIdevice\fR] \fIcontrol\fR \fIvalue\fR
.fi
.LP
.nf
-\fBaudioctl\fR \fBsave-controls\fR [\fB-d\fR \fIdevice\fB] [\fB-f\fR] \fIfile\fR
+\fBaudioctl\fR \fBsave-controls\fR [\fB-d\fR \fIdevice\fR] [\fB-f\fR] \fIfile\fR
.fi
.LP
.nf
-\fBaudioctl\fR \fBload-controls\fR [\fB-d\fR \fIdevice\fB] \fIfile\fR
+\fBaudioctl\fR \fBload-controls\fR [\fB-d\fR \fIdevice\fR] \fIfile\fR
.fi
+.LP
+.nf
+\fBaudioctl\fR \fBhelp\fR
+.fi
+
.SH DESCRIPTION
The \fBaudioctl\fP command is used to control various settings and features
of audio devices, including mixer settings such as playback volume and
record gain.
.SH SUBCOMMANDS
@@ -62,11 +68,11 @@
.RE
.sp
.ne 2
.na
-\fBshow-device\fR [\fB-v\fR] [\fB-d\fR \fIdevice\fR] [\fBcontrol\fR ... ]
+\fBshow-device\fR [\fB-v\fR] [\fB-d\fR \fIdevice\fR]
.ad
.sp .6
.RS 4n
Display an informational overview of \fIdevice\fR (or the default device if
not specified). If the \fB-v\fR option is specified, then more detail
@@ -74,11 +80,11 @@
.RE
.sp
.ne 2
.na
-\fBshow-control\fR [\fB-v\fR] [\fB-d\fR \fIdevice\fR]
+\fBshow-control\fR [\fB-v\fR] [\fB-d\fR \fIdevice\fR] [\fBcontrol\fR ... ]
.ad
.sp .6
.RS 4n
Display the control settings for one or more \fIcontrols\fR of a
\fIdevice\fR (or the default device if not specified). If no \fIcontrol\fR is
@@ -87,11 +93,11 @@
.RE
.sp
.ne 2
.na
-\fBset-control\fR [\fB-v\fR] [\fB-d\fR \fIdevice\fB] \fIcontrol\fR \fIvalue\fR
+\fBset-control\fR [\fB-v\fR] [\fB-d\fR \fIdevice\fR] \fIcontrol\fR \fIvalue\fR
.ad
.sp .6
.RS 4n
Set the control settings for a \fIcontrol\fR of a \fIdevice\fR (or the
default device if not specified) to \fIvalue\fR. If the \fB-v\fR
@@ -99,11 +105,11 @@
.RE
.sp
.ne 2
.na
-\fBsave-controls\fR [\fB-f\fR] [\fB-d\fR \fIdevice\fB] \fIfile\fR
+\fBsave-controls\fR [\fB-f\fR] [\fB-d\fR \fIdevice\fR] \fIfile\fR
.ad
.sp .6
.RS 4n
Save all control settings of the \fIdevice\fR (or the default device if not
specified) to the named \fIfile\fR. This subcommand will not replace
@@ -111,19 +117,29 @@
.RE
.sp
.ne 2
.na
-\fBload-controls\fR [\fB-d\fR \fIdevice\fB] \fIfile\fR
+\fBload-controls\fR [\fB-d\fR \fIdevice\fR] \fIfile\fR
.ad
.sp .6
.RS 4n
Load previously saved control settings from a \fIfile\fR
into a \fIdevice\fR (or all audio devices if not
specified).
.RE
+.sp
+.ne 2
+.na
+\fBhelp\fR
+.ad
+.sp .6
+.RS 4n
+Display the usage message.
+.RE
+
.SH ENVIRONMENT VARIABLES
.ne 2
.na
\fB\fBAUDIODEV\fR\fR
.ad
@@ -131,29 +147,15 @@
The full path name of the default audio device to use if one
is not specified on the command line. If this variable is not set,
\fB/dev/audio\fR is used.
.RE
-
.SH ATTRIBUTES
-See \fBattributes\fR(5) for descriptions of the following attributes:
-.sp
-
-.sp
-.TS
-box;
-c | c
-l | l .
-ATTRIBUTE TYPE ATTRIBUTE VALUE
-_
-Interface Stability See below.
-.TE
-.LP
The \fBaudioctl\fR command and its subcommands are Committed. The
names of controls, their values, and device names are Uncommitted.
The display output is intended for human consumption, and is Not An
Interface. The format of the state files used by the
\fBsave-controls\fR and \fBload-controls\fR subcommands is Committed
Private.
.SH SEE ALSO
\fBaudioplay\fR(1), \fBaudiorecord\fR(1), \fBdsp\fR(7I),
-\fBmixer\fR(7I), \fBattributes\fR(5)
+\fBmixer\fR(7I)