Annotation of src/usr.bin/mixerctl/mixerctl.1, Revision 1.13
1.13 ! aaron 1: .\" $OpenBSD: mixerctl.1,v 1.12 2000/11/10 05:10:35 aaron 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.1 provos 45: .Op Fl f Ar file
46: .Op Fl n
47: .Op Fl v
48: .Fl a
1.9 aaron 49: .Nm mixerctl
1.1 provos 50: .Op Fl f Ar file
51: .Op Fl n
52: .Op Fl v
1.8 aaron 53: .Ar name Op Ar ...
1.9 aaron 54: .Nm mixerctl
1.1 provos 55: .Op Fl f Ar file
56: .Op Fl n
57: .Fl w
1.8 aaron 58: .Ar name=value Op Ar ...
1.1 provos 59: .Sh DESCRIPTION
1.6 provos 60: The
1.1 provos 61: .Nm
62: command displays or sets various audio system mixing variables.
1.10 aaron 63: If a list of variables is present on the command line,
1.1 provos 64: .Nm
65: prints the current value of those variables for the specified device.
1.10 aaron 66: By default,
1.1 provos 67: .Nm
1.10 aaron 68: operates on the
69: .Pa /dev/mixer
70: device.
71: .Pp
72: The options are as follows:
1.11 aaron 73: .Bl -tag -width Ds
1.10 aaron 74: .It Fl a
75: Print all device variables and their current values.
76: .It Fl w Ar name=value
77: Attempt to set the specified variable
78: .Ar name
79: to
80: .Ar value .
81: .It Fl v
82: Show the possible values of enumeration and set valued variables.
83: Enumerated values are shown in
84: .Dq []
85: and set values are shown in
86: .Dq {} .
87: .It Fl f Ar file
88: Specify an alternative audio mixing device.
89: .It Fl n
90: Suppress printing of the variable name.
91: .El
1.5 millert 92: .Pp
93: Values may be specified in either absolute or relative forms.
94: The relative form is indicated by a prefix of
1.10 aaron 95: .Ql +
1.5 millert 96: or
1.10 aaron 97: .Ql -
98: to denote an increase or decrease, respectively.
1.1 provos 99: .Pp
1.10 aaron 100: The exact set of controls that can be manipulated depends on
101: the mixer.
102: The general format (in both getting and setting a value) is
1.1 provos 103: .Pp
1.10 aaron 104: .Va class.name = value
1.6 provos 105: .Pp
106: The
107: .Va class
108: can have values like
109: .Li inputs
110: or
111: .Li outputs
112: indicating that the control affects the input resp. output to the
1.10 aaron 113: mixer.
114: The
1.6 provos 115: .Va name
116: indicates what part of the mixer the control affects.
1.8 aaron 117: Continuous mixer values, e.g., volume, have numeric values
1.10 aaron 118: in the range 0-255.
119: If value can be set for each channel independently
120: the values are printed separated by commas.
121: Discrete mixer values, e.g.,
122: the recording source, have symbolic names.
123: Depending on the mixer it
1.6 provos 124: may either be an enumeration or a set.
125: .Sh EXAMPLES
1.7 deraadt 126: The command
1.10 aaron 127: .Pp
1.6 provos 128: .Dl "mixerctl -a -v"
1.10 aaron 129: .Pp
1.6 provos 130: can produce
131: .Bd -literal
132: inputs.mic=0,0 volume
133: inputs.mic.mute=off [ off on ]
134: inputs.cd=220,220 volume
135: inputs.cd.mute=off [ off on ]
136: inputs.dac=220,220 volume
137: inputs.dac.mute=off [ off on ]
138: record.record=220,220 volume
139: record.record.source=mic [ mic cd dac ]
140: monitor.monitor=0 volume
141: .Ed
1.4 provos 142: .Sh ENVIRONMENT
143: .Bl -tag -width MIXERDEVICE
1.8 aaron 144: .It Ev MIXERDEVICE
1.10 aaron 145: The audio mixer device to use.
1.12 aaron 146: .El
147: .Sh FILES
148: .Bl -tag -width /dev/mixer
149: .It Pa /dev/mixer
150: mixer audio device
1.10 aaron 151: .El
1.1 provos 152: .Sh SEE ALSO
153: .Xr audioctl 1 ,
154: .Xr audio 4 ,
155: .Xr sysctl 8
156: .Sh HISTORY
157: The
158: .Nm
159: command first appeared in
160: .Nx 1.3 .