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