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