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