Annotation of src/usr.bin/mixerctl/mixerctl.1, Revision 1.35
1.35 ! jmc 1: .\" $OpenBSD: mixerctl.1,v 1.34 2015/09/25 14:27:26 schwarze Exp $
1.6 provos 2: .\" $NetBSD: mixerctl.1,v 1.8 1998/05/09 12:41:16 augustss Exp $
1.5 millert 3: .\"
1.1 provos 4: .\" Copyright (c) 1997 The NetBSD Foundation, Inc.
5: .\" All rights reserved.
6: .\"
7: .\" Author: Lennart Augustsson
8: .\"
9: .\" Redistribution and use in source and binary forms, with or without
10: .\" modification, are permitted provided that the following conditions
11: .\" are met:
12: .\" 1. Redistributions of source code must retain the above copyright
13: .\" notice, this list of conditions and the following disclaimer.
14: .\" 2. Redistributions in binary form must reproduce the above copyright
15: .\" notice, this list of conditions and the following disclaimer in the
16: .\" documentation and/or other materials provided with the distribution.
17: .\"
18: .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
19: .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
20: .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
1.6 provos 21: .\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
1.1 provos 22: .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23: .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24: .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25: .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26: .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27: .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28: .\" POSSIBILITY OF SUCH DAMAGE.
29: .\"
1.35 ! jmc 30: .Dd $Mdocdate: September 25 2015 $
1.1 provos 31: .Dt MIXERCTL 1
32: .Os
33: .Sh NAME
34: .Nm mixerctl
35: .Nd control audio mixing
36: .Sh SYNOPSIS
1.9 aaron 37: .Nm mixerctl
1.30 sobrado 38: .Op Fl anv
1.1 provos 39: .Op Fl f Ar file
1.9 aaron 40: .Nm mixerctl
1.19 jmc 41: .Op Fl nv
1.1 provos 42: .Op Fl f Ar file
1.28 sobrado 43: .Ar name ...
1.9 aaron 44: .Nm mixerctl
1.23 deraadt 45: .Op Fl qt
46: .Op Fl f Ar file
1.28 sobrado 47: .Ar name ...
1.23 deraadt 48: .Nm mixerctl
1.17 jfb 49: .Op Fl q
1.29 sobrado 50: .Op Fl f Ar file
1.28 sobrado 51: .Ar name Ns = Ns Ar value ...
1.1 provos 52: .Sh DESCRIPTION
1.6 provos 53: The
1.1 provos 54: .Nm
55: command displays or sets various audio system mixing variables.
1.10 aaron 56: If a list of variables is present on the command line,
1.1 provos 57: .Nm
58: prints the current value of those variables for the specified device.
1.32 jmc 59: Variables can also be set at system startup using the configuration file
60: .Xr mixerctl.conf 5 .
1.10 aaron 61: .Pp
62: The options are as follows:
1.19 jmc 63: .Bl -tag -width "-f file"
1.10 aaron 64: .It Fl a
65: Print all device variables and their current values.
1.30 sobrado 66: This is the default, if no parameters are given to
67: .Nm .
1.15 pvalchev 68: .It Fl f Ar file
69: Specify an alternative audio mixing device.
1.32 jmc 70: The default is
1.35 ! jmc 71: .Pa /dev/mixer0 .
1.15 pvalchev 72: .It Fl n
73: Suppress printing of the variable name.
1.17 jfb 74: .It Fl q
75: Suppress all printing when setting a variable.
1.23 deraadt 76: .It Fl t
1.25 jmc 77: Toggle.
78: Attempt to select the next possible value
79: of an enum
80: (see below).
1.10 aaron 81: .It Fl v
1.25 jmc 82: Show all possible values of variables.
83: Enum values are shown in
84: .Sq []
85: and values belonging to a set are shown in
86: .Sq {}
87: (see below).
1.20 tedu 88: .It Ar name Ns = Ns Ar value
1.19 jmc 89: Attempt to set the specified variable
1.15 pvalchev 90: .Ar name
91: to
92: .Ar value .
1.10 aaron 93: .El
1.5 millert 94: .Pp
1.10 aaron 95: The exact set of controls that can be manipulated depends on
96: the mixer.
1.25 jmc 97: The general format (in both getting and setting a value) is:
1.1 provos 98: .Pp
1.19 jmc 99: .D1 class.name=value
1.6 provos 100: .Pp
101: The
1.19 jmc 102: .Ar class
1.6 provos 103: can have values like
1.25 jmc 104: .Dq inputs
1.6 provos 105: or
1.25 jmc 106: .Dq outputs ,
1.19 jmc 107: indicating that the control affects the input or output, respectively,
108: to the mixer.
1.10 aaron 109: The
1.19 jmc 110: .Ar name
1.6 provos 111: indicates what part of the mixer the control affects.
1.25 jmc 112: Continuous mixer values, e.g. volume,
113: have numeric values in the range 0\-255.
1.19 jmc 114: If
115: .Ar value
116: can be set for each channel independently,
1.10 aaron 117: the values are printed separated by commas.
1.25 jmc 118: Discrete mixer values, e.g. the recording source,
119: have symbolic names.
120: .Pp
121: Variables may take one of three types,
122: again dependent on the mixer:
123: .Bl -enum
124: .It
125: Enums.
1.26 jmc 126: These may take only one out of a possible list of symbolic values
127: or the literal string
128: .Dq toggle ,
129: which toggles the value,
1.25 jmc 130: e.g. inputs.mic.source=mic0.
131: .It
132: Sets.
133: These can take one or more of a possible list of symbolic values;
134: multiple values are specified as a comma-separated list,
135: e.g. record.source=mic,cd.
136: Additionally,
137: .Ar value
138: may be omitted to specify the empty set,
139: e.g. record.source=.
140: .It
141: Numbers.
142: Numerical values may be specified in either absolute or relative forms.
143: The relative form is indicated by a prefix of
144: .Ql +
145: or
146: .Ql -
147: to denote an increase or decrease, respectively.
148: .El
1.18 jmc 149: .Sh ENVIRONMENT
1.32 jmc 150: .Bl -tag -width "MIXERDEVICEXXX"
1.18 jmc 151: .It Ev MIXERDEVICE
152: The audio mixer device to use.
153: .El
154: .Sh FILES
1.32 jmc 155: .Bl -tag -width "/etc/mixerctl.confXXX" -compact
1.35 ! jmc 156: .It Pa /dev/mixer0
1.32 jmc 157: Default mixer audio device.
1.33 sobrado 158: .It Pa /etc/mixerctl.conf
1.32 jmc 159: .Nm
160: configuration file.
1.18 jmc 161: .El
1.6 provos 162: .Sh EXAMPLES
1.25 jmc 163: Show possible values for all mixer variables,
164: and their current settings:
1.19 jmc 165: .Bd -literal -offset indent
1.25 jmc 166: $ mixerctl -av
1.6 provos 167: inputs.mic=0,0 volume
168: inputs.mic.mute=off [ off on ]
169: inputs.cd=220,220 volume
170: inputs.cd.mute=off [ off on ]
171: inputs.dac=220,220 volume
172: inputs.dac.mute=off [ off on ]
173: record.record=220,220 volume
174: record.record.source=mic [ mic cd dac ]
175: monitor.monitor=0 volume
1.23 deraadt 176: .Ed
177: .Pp
1.25 jmc 178: Toggle inputs.dac.mute:
1.23 deraadt 179: .Bd -literal -offset indent
1.25 jmc 180: $ mixerctl -t inputs.dac.mute
181: inputs.dac.mute: off -\*(Gt on
1.26 jmc 182: $ mixerctl inputs.dac.mute=toggle
183: inputs.dac.mute: on -\*(Gt off
1.6 provos 184: .Ed
1.1 provos 185: .Sh SEE ALSO
1.21 jmc 186: .Xr aucat 1 ,
1.1 provos 187: .Xr audioctl 1 ,
1.21 jmc 188: .Xr cdio 1 ,
1.1 provos 189: .Xr audio 4 ,
1.22 jsg 190: .Xr mixerctl.conf 5 ,
1.1 provos 191: .Xr sysctl 8
192: .Sh HISTORY
193: The
194: .Nm
195: command first appeared in
1.25 jmc 196: .Ox 2.4 .
![[BACK]](/icons/back.gif){kind=icon}
Return to mixerctl.1 CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [local] / src / usr.bin / mixerctl