Annotation of src/usr.bin/mixerctl/mixerctl.1, Revision 1.21
1.21 ! jmc 1: .\" $OpenBSD: mixerctl.1,v 1.20 2004/01/22 08:06:18 tedu 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.17 jfb 53: .Op Fl q
1.19 jmc 54: .Pf \ \& Op Fl f Ar file
55: .Xo
56: .Ar name Ns = Ns Ar value
57: .Op Ar ...
58: .Xc
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.19 jmc 73: .Bl -tag -width "-f file"
1.10 aaron 74: .It Fl a
75: Print all device variables and their current values.
1.15 pvalchev 76: .It Fl f Ar file
77: Specify an alternative audio mixing device.
78: .It Fl n
79: Suppress printing of the variable name.
1.17 jfb 80: .It Fl q
81: Suppress all printing when setting a variable.
1.10 aaron 82: .It Fl v
83: Show the possible values of enumeration and set valued variables.
84: Enumerated values are shown in
85: .Dq []
86: and set values are shown in
87: .Dq {} .
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
95: Values may be specified in either absolute or relative forms.
96: The relative form is indicated by a prefix of
1.10 aaron 97: .Ql +
1.5 millert 98: or
1.10 aaron 99: .Ql -
100: to denote an increase or decrease, respectively.
1.1 provos 101: .Pp
1.10 aaron 102: The exact set of controls that can be manipulated depends on
103: the mixer.
104: The general format (in both getting and setting a value) is
1.1 provos 105: .Pp
1.19 jmc 106: .D1 class.name=value
1.6 provos 107: .Pp
108: The
1.19 jmc 109: .Ar class
1.6 provos 110: can have values like
111: .Li inputs
112: or
113: .Li outputs
1.19 jmc 114: indicating that the control affects the input or output, respectively,
115: to the mixer.
1.10 aaron 116: The
1.19 jmc 117: .Ar name
1.6 provos 118: indicates what part of the mixer the control affects.
1.8 aaron 119: Continuous mixer values, e.g., volume, have numeric values
1.10 aaron 120: in the range 0-255.
1.19 jmc 121: If
122: .Ar value
123: can be set for each channel independently,
1.10 aaron 124: the values are printed separated by commas.
125: Discrete mixer values, e.g.,
126: the recording source, have symbolic names.
127: Depending on the mixer it
1.6 provos 128: may either be an enumeration or a set.
1.18 jmc 129: .Sh ENVIRONMENT
130: .Bl -tag -width MIXERDEVICE
131: .It Ev MIXERDEVICE
132: The audio mixer device to use.
133: .El
134: .Sh FILES
135: .Bl -tag -width /dev/mixer
136: .It Pa /dev/mixer
137: default mixer audio device
138: .El
1.6 provos 139: .Sh EXAMPLES
1.7 deraadt 140: The command
1.10 aaron 141: .Pp
1.14 deraadt 142: .Dl "$ mixerctl -a -v"
1.10 aaron 143: .Pp
1.6 provos 144: can produce
1.19 jmc 145: .Bd -literal -offset indent
1.6 provos 146: inputs.mic=0,0 volume
147: inputs.mic.mute=off [ off on ]
148: inputs.cd=220,220 volume
149: inputs.cd.mute=off [ off on ]
150: inputs.dac=220,220 volume
151: inputs.dac.mute=off [ off on ]
152: record.record=220,220 volume
153: record.record.source=mic [ mic cd dac ]
154: monitor.monitor=0 volume
155: .Ed
1.1 provos 156: .Sh SEE ALSO
1.21 ! jmc 157: .Xr aucat 1 ,
1.1 provos 158: .Xr audioctl 1 ,
1.21 ! jmc 159: .Xr cdio 1 ,
1.1 provos 160: .Xr audio 4 ,
161: .Xr sysctl 8
162: .Sh HISTORY
163: The
164: .Nm
165: command first appeared in
166: .Nx 1.3 .