656cc2e6e81158dfc4600ff7b66d605e70420cb6
[dragonfly.git] / usr.sbin / mixer / mixer.8
1 .\" Copyright (c) 1997
2 .\"     Mike Pritchard <mpp@FreeBSD.ORG>.  All rights reserved.
3 .\"
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
6 .\" are met:
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\"    notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\"    notice, this list of conditions and the following disclaimer in the
11 .\"    documentation and/or other materials provided with the distribution.
12 .\" 3. Neither the name of the author nor the names of its contributors
13 .\"    may be used to endorse or promote products derived from this software
14 .\"    without specific prior written permission.
15 .\"
16 .\" THIS SOFTWARE IS PROVIDED BY MIKE PRITCHARD AND CONTRIBUTORS ``AS IS'' AND
17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 .\" SUCH DAMAGE.
27 .\"
28 .\" $FreeBSD: src/usr.sbin/mixer/mixer.8,v 1.10.2.7 2003/03/11 21:13:51 trhodes Exp $
29 .\" $DragonFly: src/usr.sbin/mixer/mixer.8,v 1.5 2006/03/26 22:56:58 swildner Exp $
30 .\"
31 .Dd January 9, 1997
32 .Dt MIXER 8
33 .Os
34 .Sh NAME
35 .Nm mixer
36 .Nd set/display soundcard mixer values
37 .Sh SYNOPSIS
38 .Nm
39 .Op Fl f Ar device
40 .Op Fl s
41 .Op Fl h
42 .Oo
43 .Ar dev
44 .Sm off
45 .Oo
46 .Op Cm + | -
47 .Ar lvol
48 .Op : Oo Cm + | - Oc Ar rvol
49 .Oc
50 .Oc
51 .Sm on
52 .Ar ...
53 .Nm
54 .Op Fl f Ar device
55 .Op Fl s
56 .Cm recsrc
57 .Ar ...
58 .Nm
59 .Op Fl f Ar device
60 .Op Fl s
61 .Sm off
62 .Bro
63 .Cm ^ | + | - | =
64 .Brc
65 .Cm rec
66 .Sm on
67 .Ar rdev ...
68 .Sh DESCRIPTION
69 The
70 .Nm
71 utility is used to set and display soundcard mixer device levels.
72 It may
73 also be used to start and stop recording from the soundcard.  The list
74 of mixer devices that may be modified are:
75 .Pp
76 .Bd -ragged -offset indent
77 vol, bass, treble, synth, pcm, speaker, mic, cd, mix,
78 pcm2, rec, igain, ogain, line1, line2, and line3.
79 .Ed
80 .Pp
81 Not all mixer devices are available.
82 .Pp
83 Without any arguments,
84 .Nm
85 displays the current settings for all supported devices, followed by information
86 about the current recording input devices.
87 If the
88 .Ar dev
89 argument is specified,
90 .Nm
91 displays only the value for that
92 .Ar dev .
93 .Pp
94 To modify the mixer value
95 .Ar dev ,
96 the optional left and right channel settings of
97 .Ar lvol Ns Op : Ns Ar rvol
98 may be specified.  The
99 .Ar lvol
100 and
101 .Ar rvol
102 arguments may be from 0 - 100.  Omitting
103 .Ar dev
104 and including only the channel settings will change the main volume level.
105 .Pp
106 If the left or right channel settings are prefixed with
107 .Cm +
108 or
109 .Cm - ,
110 the value following will be used as a relative adjustment, modifying the
111 current settings by the amount specified.
112 .Pp
113 If the
114 .Fl s
115 flag is used, the current mixer values will be displayed in a format suitable
116 for use as the command-line arguments to a future invocation of
117 .Nm
118 (as above).
119 .Pp
120 To change the recording device you use one of:
121 .Bl -tag -width =rec -offset indent
122 .It Cm ^rec
123 toggles
124 .Ar rdev
125 of possible recording devices
126 .It Cm +rec
127 adds
128 .Ar rdev
129 to possible recording devices
130 .It Cm -rec
131 removes
132 .Ar rdev
133 from possible recording devices
134 .It Cm =rec
135 sets the recording device to
136 .Ar rdev
137 .El
138 .Pp
139 The above commands work on an internal mask.  After all the options
140 have been parsed, it will set then read the mask from the sound card.
141 This will let you see EXACTLY what the soundcard is using for the
142 recording device(s).
143 .Pp
144 The option recsrc will display the current recording devices.
145 .Pp
146 The option
147 .Fl f
148 .Ar device
149 will open
150 .Ar device
151 as the mixer device.
152 .Pp
153 The option
154 .Fl h
155 will print a help and exit
156 .Sh FILES
157 .Bl -tag -width /dev/mixer -compact
158 .It Pa /dev/mixer
159 the default mixer device
160 .El
161 .Sh SEE ALSO
162 .Xr cdcontrol 1
163 .Sh HISTORY
164 The
165 .Nm
166 utility first appeared in
167 .Fx 2.0.5 .
168 .Sh AUTHORS
169 .An -nosplit
170 Original source by
171 .An Craig Metz Aq cmetz@thor.tjhsst.edu
172 and
173 .An Hannu Savolainen .
174 Mostly rewritten by
175 .An John-Mark Gurney Aq jmg@FreeBSD.org .
176 This
177 manual page was written by
178 .An Mike Pritchard Aq mpp@FreeBSD.org .