xref: /netbsd-src/usr.bin/mixerctl/mixerctl.1 (revision bcc8ec9959e7b01e313d813067bfb43a3ad70551)
1.\" $NetBSD: mixerctl.1,v 1.11 2000/12/29 13:30:26 augustss Exp $
2.\" Copyright (c) 1997 The NetBSD Foundation, Inc.
3.\" All rights reserved.
4.\"
5.\" Author: Lennart Augustsson
6.\"
7.\" Redistribution and use in source and binary forms, with or without
8.\" modification, are permitted provided that the following conditions
9.\" are met:
10.\" 1. Redistributions of source code must retain the above copyright
11.\"    notice, this list of conditions and the following disclaimer.
12.\" 2. Redistributions in binary form must reproduce the above copyright
13.\"    notice, this list of conditions and the following disclaimer in the
14.\"    documentation and/or other materials provided with the distribution.
15.\" 3. All advertising materials mentioning features or use of this software
16.\"    must display the following acknowledgement:
17.\"        This product includes software developed by the NetBSD
18.\"        Foundation, Inc. and its contributors.
19.\" 4. Neither the name of The NetBSD Foundation nor the names of its
20.\"    contributors may be used to endorse or promote products derived
21.\"    from this software without specific prior written permission.
22.\"
23.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
24.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
25.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
26.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
27.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
28.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
29.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
30.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
31.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
32.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
33.\" POSSIBILITY OF SUCH DAMAGE.
34.\"
35.Dd May 4, 1997
36.Dt MIXERCTL 1
37.Os
38.Sh NAME
39.Nm mixerctl
40.Nd control audio mixing
41.Sh SYNOPSIS
42.Nm
43.Op Fl f Ar file
44.Op Fl n
45.Op Fl v
46.Fl a
47.Nm ""
48.Op Fl f Ar file
49.Op Fl n
50.Op Fl v
51.Ar name ...
52.Nm ""
53.Op Fl f Ar file
54.Op Fl n
55.Fl w
56.Ar name=value ...
57.Nm ""
58.Op Fl f Ar file
59.Op Fl n
60.Fl w
61.Ar name++ ...
62.Nm ""
63.Op Fl f Ar file
64.Op Fl n
65.Fl w
66.Ar name-- ...
67.Sh DESCRIPTION
68The
69.Nm
70command displays or sets various audio system mixing variables.
71If a list of variables is present on the command line, then
72.Nm
73prints the current value of those variables for the specified device.
74If the
75.Fl a
76flag is specified, all variables for the device are printed.
77If the
78.Fl w
79flag is specified
80.Nm
81attempts to set the specified variables to the given values.
82.Pp
83The
84.Fl f
85flag can be used to give an alternative mixer device, the default is
86.Pa /dev/mixer0 .
87.Pp
88The
89.Fl n
90flag suppresses printing of the variable name.
91.Pp
92The
93.Fl v
94flag shows the possible values of enumeration and set valued
95variables.  Enumerated values are shown in [] and set values
96are shown in {}.
97.Pp
98The exact set of controls that can be manipulated depends on
99the mixer.  The general format (in both getting and setting a value)
100is
101.br
102.Va "class.name" = value
103.br
104The
105.Va class
106can have values like
107.Li inputs
108or
109.Li outputs
110indicating that the control affects the input resp. output to the
111mixer.  The
112.Va name
113indicates what part of the mixer the control affects.
114Continous mixer values, e.g., volume, have numeric values
115in the range 0-255.  If value can be set for each channel independently
116the values are printed separated by commas.  Discrete mixer values, e.g.,
117the recording source, have symbolic names.  Depending on the mixer it
118may either be an enumeration or a set.
119.Pp
120The suffixes ++ and -- can be used to step through the values of a
121mixer control.  For numeric controls these operators may increase
122(resp. decrease) the value by an amount (the delta) suitable to make
123the control assume the next possible value.
124.Sh EXAMPLES
125The commmand
126.Dl "mixerctl -a -v"
127can produce
128.Bd -literal
129inputs.mic=0,0 volume
130inputs.mic.mute=off  [ off on ]
131inputs.cd=220,220 volume
132inputs.cd.mute=off  [ off on ]
133inputs.dac=220,220 volume
134inputs.dac.mute=off  [ off on ]
135record.record=220,220 volume
136record.record.source=mic  [ mic cd dac ]
137monitor.monitor=0 volume
138.Ed
139.Sh FILES
140.Bl -tag -width /dev/mixer0
141.It Pa /dev/mixer0
142mixer audio device
143.El
144.Sh ENVIRONMENT
145.Bl -tag -width MIXERDEVICE
146.It Pa MIXERDEVICE
147the mixer device to use.
148.El
149.Sh SEE ALSO
150.Xr audioctl 1 ,
151.Xr audio 4 ,
152.Xr sysctl 8
153.Sh HISTORY
154The
155.Nm
156command first appeared in
157.Nx 1.3 .
158
159