Annotation of src/usr.bin/mixerctl/mixerctl.1, Revision 1.19
1.19 ! jmc 1: .\" $OpenBSD: mixerctl.1,v 1.18 2003/06/10 09:12:11 jmc 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
1.1 provos 55: .Fl w
1.19 ! jmc 56: .Xo
! 57: .Ar name Ns = Ns Ar value
! 58: .Op Ar ...
! 59: .Xc
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.19 ! jmc 74: .Bl -tag -width "-f file"
1.10 aaron 75: .It Fl a
76: Print all device variables and their current values.
1.15 pvalchev 77: .It Fl f Ar file
78: Specify an alternative audio mixing device.
79: .It Fl n
80: Suppress printing of the variable name.
1.17 jfb 81: .It Fl q
82: Suppress all printing when setting a variable.
1.10 aaron 83: .It Fl v
84: Show the possible values of enumeration and set valued variables.
85: Enumerated values are shown in
86: .Dq []
87: and set values are shown in
88: .Dq {} .
1.19 ! jmc 89: .It Fl w Ar name Ns = Ns Ar value
! 90: Attempt to set the specified variable
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.19 ! jmc 107: .D1 class.name=value
1.6 provos 108: .Pp
109: The
1.19 ! jmc 110: .Ar class
1.6 provos 111: can have values like
112: .Li inputs
113: or
114: .Li outputs
1.19 ! jmc 115: indicating that the control affects the input or output, respectively,
! 116: to the mixer.
1.10 aaron 117: The
1.19 ! jmc 118: .Ar name
1.6 provos 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.
1.19 ! jmc 122: If
! 123: .Ar value
! 124: can be set for each channel independently,
1.10 aaron 125: the values are printed separated by commas.
126: Discrete mixer values, e.g.,
127: the recording source, have symbolic names.
128: Depending on the mixer it
1.6 provos 129: may either be an enumeration or a set.
1.18 jmc 130: .Sh ENVIRONMENT
131: .Bl -tag -width MIXERDEVICE
132: .It Ev MIXERDEVICE
133: The audio mixer device to use.
134: .El
135: .Sh FILES
136: .Bl -tag -width /dev/mixer
137: .It Pa /dev/mixer
138: default mixer audio device
139: .El
1.6 provos 140: .Sh EXAMPLES
1.7 deraadt 141: The command
1.10 aaron 142: .Pp
1.14 deraadt 143: .Dl "$ mixerctl -a -v"
1.10 aaron 144: .Pp
1.6 provos 145: can produce
1.19 ! jmc 146: .Bd -literal -offset indent
1.6 provos 147: inputs.mic=0,0 volume
148: inputs.mic.mute=off [ off on ]
149: inputs.cd=220,220 volume
150: inputs.cd.mute=off [ off on ]
151: inputs.dac=220,220 volume
152: inputs.dac.mute=off [ off on ]
153: record.record=220,220 volume
154: record.record.source=mic [ mic cd dac ]
155: monitor.monitor=0 volume
156: .Ed
1.1 provos 157: .Sh SEE ALSO
158: .Xr audioctl 1 ,
159: .Xr audio 4 ,
160: .Xr sysctl 8
161: .Sh HISTORY
162: The
163: .Nm
164: command first appeared in
165: .Nx 1.3 .