Print this page
12287 errors in audio utility man pages
Split |
Close |
Expand all |
Collapse all |
--- old/usr/src/man/man1/audioctl.1
+++ new/usr/src/man/man1/audioctl.1
1 1 '\" t
2 2 .\"
3 3 .\" This file and its contents are supplied under the terms of the
↓ open down ↓ |
3 lines elided |
↑ open up ↑ |
4 4 .\" Common Development and Distribution License ("CDDL"), version 1.0.
5 5 .\" You may only use this file in accordance with the terms of version
6 6 .\" 1.0 of the CDDL.
7 7 .\"
8 8 .\" A full copy of the text of the CDDL should have accompanied this
9 9 .\" source. A copy of the CDDL is also available via the Internet at
10 10 .\" http://www.illumos.org/license/CDDL.
11 11 .\"
12 12 .\"
13 13 .\" Copyright 2011 Nexenta Systems, Inc. All rights reserved.
14 +.\" Copyright 2020 Peter Tribble.
14 15 .\"
15 -.TH AUDIOCTL 1 "Mar 18, 2011"
16 +.TH AUDIOCTL 1 "Feb 8, 2020"
16 17 .SH NAME
17 18 audioctl - audio device control command line interface
18 19 .SH SYNOPSIS
19 20 .nf
20 21 \fBaudioctl\fR \fBlist-devices\fR
21 22 .fi
22 23
23 24 .LP
24 25 .nf
25 26 \fBaudioctl\fR \fBshow-device\fR [\fB-v\fR] [\fB-d\fR \fIdevice\fR]
26 27 .fi
27 28
28 29 .LP
29 30 .nf
30 -\fBaudioctl\fR \fBshow-control\fR [\fB-v\fR] [\fB-d\fR \fIdevice\fB] [\fIcontrol\fR ...]
31 +\fBaudioctl\fR \fBshow-control\fR [\fB-v\fR] [\fB-d\fR \fIdevice\fR] [\fIcontrol\fR ...]
31 32 .fi
32 33
33 34 .LP
34 35 .nf
35 -\fBaudioctl\fR \fBset-control\fR [\fB-v\fR] [\fB-d\fR \fIdevice\fB] \fIcontrol\fR \fIvalue\fR
36 +\fBaudioctl\fR \fBset-control\fR [\fB-v\fR] [\fB-d\fR \fIdevice\fR] \fIcontrol\fR \fIvalue\fR
36 37 .fi
37 38
38 39 .LP
39 40 .nf
40 -\fBaudioctl\fR \fBsave-controls\fR [\fB-d\fR \fIdevice\fB] [\fB-f\fR] \fIfile\fR
41 +\fBaudioctl\fR \fBsave-controls\fR [\fB-d\fR \fIdevice\fR] [\fB-f\fR] \fIfile\fR
41 42 .fi
42 43
43 44 .LP
44 45 .nf
45 -\fBaudioctl\fR \fBload-controls\fR [\fB-d\fR \fIdevice\fB] \fIfile\fR
46 +\fBaudioctl\fR \fBload-controls\fR [\fB-d\fR \fIdevice\fR] \fIfile\fR
46 47 .fi
47 48
49 +.LP
50 +.nf
51 +\fBaudioctl\fR \fBhelp\fR
52 +.fi
53 +
48 54 .SH DESCRIPTION
49 55 The \fBaudioctl\fP command is used to control various settings and features
50 56 of audio devices, including mixer settings such as playback volume and
51 57 record gain.
52 58 .SH SUBCOMMANDS
53 59 The \fBaudioctl\fR command supports the following subcommands.
54 60 .sp
55 61 .ne 2
56 62 .na
57 63 \fBlist-devices\fR
58 64 .ad
59 65 .sp .6
60 66 .RS 4n
61 67 List all the audio devices on the system.
62 68 .RE
63 69
64 70 .sp
65 71 .ne 2
66 72 .na
67 -\fBshow-device\fR [\fB-v\fR] [\fB-d\fR \fIdevice\fR] [\fBcontrol\fR ... ]
73 +\fBshow-device\fR [\fB-v\fR] [\fB-d\fR \fIdevice\fR]
68 74 .ad
69 75 .sp .6
70 76 .RS 4n
71 77 Display an informational overview of \fIdevice\fR (or the default device if
72 78 not specified). If the \fB-v\fR option is specified, then more detail
73 79 will be displayed.
74 80 .RE
75 81
76 82 .sp
77 83 .ne 2
78 84 .na
79 -\fBshow-control\fR [\fB-v\fR] [\fB-d\fR \fIdevice\fR]
85 +\fBshow-control\fR [\fB-v\fR] [\fB-d\fR \fIdevice\fR] [\fBcontrol\fR ... ]
80 86 .ad
81 87 .sp .6
82 88 .RS 4n
83 89 Display the control settings for one or more \fIcontrols\fR of a
84 90 \fIdevice\fR (or the default device if not specified). If no \fIcontrol\fR is
85 91 specified, then the settings for all controls will be displayed. If
86 92 the \fB-v\fR option is specified, then more detail will be displayed.
87 93 .RE
88 94
89 95 .sp
90 96 .ne 2
91 97 .na
92 -\fBset-control\fR [\fB-v\fR] [\fB-d\fR \fIdevice\fB] \fIcontrol\fR \fIvalue\fR
98 +\fBset-control\fR [\fB-v\fR] [\fB-d\fR \fIdevice\fR] \fIcontrol\fR \fIvalue\fR
93 99 .ad
94 100 .sp .6
95 101 .RS 4n
96 102 Set the control settings for a \fIcontrol\fR of a \fIdevice\fR (or the
97 103 default device if not specified) to \fIvalue\fR. If the \fB-v\fR
98 104 option is specified, then more verbose output be displayed.
99 105 .RE
100 106
101 107 .sp
102 108 .ne 2
103 109 .na
104 -\fBsave-controls\fR [\fB-f\fR] [\fB-d\fR \fIdevice\fB] \fIfile\fR
110 +\fBsave-controls\fR [\fB-f\fR] [\fB-d\fR \fIdevice\fR] \fIfile\fR
105 111 .ad
106 112 .sp .6
107 113 .RS 4n
108 114 Save all control settings of the \fIdevice\fR (or the default device if not
109 115 specified) to the named \fIfile\fR. This subcommand will not replace
110 116 or modify an existing file unless \fB-f\fR (force) is specified.
111 117 .RE
112 118
113 119 .sp
114 120 .ne 2
115 121 .na
116 -\fBload-controls\fR [\fB-d\fR \fIdevice\fB] \fIfile\fR
122 +\fBload-controls\fR [\fB-d\fR \fIdevice\fR] \fIfile\fR
117 123 .ad
118 124 .sp .6
119 125 .RS 4n
120 126 Load previously saved control settings from a \fIfile\fR
121 127 into a \fIdevice\fR (or all audio devices if not
122 128 specified).
123 129 .RE
124 130
131 +.sp
132 +.ne 2
133 +.na
134 +\fBhelp\fR
135 +.ad
136 +.sp .6
137 +.RS 4n
138 +Display the usage message.
139 +.RE
140 +
125 141 .SH ENVIRONMENT VARIABLES
126 142 .ne 2
127 143 .na
128 144 \fB\fBAUDIODEV\fR\fR
129 145 .ad
130 146 .RS 12n
131 147 The full path name of the default audio device to use if one
132 148 is not specified on the command line. If this variable is not set,
133 149 \fB/dev/audio\fR is used.
134 150 .RE
135 151
136 -
137 152 .SH ATTRIBUTES
138 -See \fBattributes\fR(5) for descriptions of the following attributes:
139 -.sp
140 -
141 -.sp
142 -.TS
143 -box;
144 -c | c
145 -l | l .
146 -ATTRIBUTE TYPE ATTRIBUTE VALUE
147 -_
148 -Interface Stability See below.
149 -.TE
150 -.LP
151 153 The \fBaudioctl\fR command and its subcommands are Committed. The
152 154 names of controls, their values, and device names are Uncommitted.
153 155 The display output is intended for human consumption, and is Not An
154 156 Interface. The format of the state files used by the
155 157 \fBsave-controls\fR and \fBload-controls\fR subcommands is Committed
156 158 Private.
157 159 .SH SEE ALSO
158 160 \fBaudioplay\fR(1), \fBaudiorecord\fR(1), \fBdsp\fR(7I),
159 -\fBmixer\fR(7I), \fBattributes\fR(5)
161 +\fBmixer\fR(7I)
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX