Merge branch 'vendor/GCC47'
[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.6 2008/05/02 02:05:08 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 .Bd -ragged -offset indent
76 vol, bass, treble, synth, pcm, speaker, mic, cd, mix,
77 pcm2, rec, igain, ogain, line1, line2, and line3.
78 .Ed
79 .Pp
80 Not all mixer devices are available.
81 .Pp
82 Without any arguments,
83 .Nm
84 displays the current settings for all supported devices, followed by information
85 about the current recording input devices.
86 If the
87 .Ar dev
88 argument is specified,
89 .Nm
90 displays only the value for that
91 .Ar dev .
92 .Pp
93 To modify the mixer value
94 .Ar dev ,
95 the optional left and right channel settings of
96 .Ar lvol Ns Op : Ns Ar rvol
97 may be specified.  The
98 .Ar lvol
99 and
100 .Ar rvol
101 arguments may be from 0 - 100.  Omitting
102 .Ar dev
103 and including only the channel settings will change the main volume level.
104 .Pp
105 If the left or right channel settings are prefixed with
106 .Cm +
107 or
108 .Cm - ,
109 the value following will be used as a relative adjustment, modifying the
110 current settings by the amount specified.
111 .Pp
112 If the
113 .Fl s
114 flag is used, the current mixer values will be displayed in a format suitable
115 for use as the command-line arguments to a future invocation of
116 .Nm
117 (as above).
118 .Pp
119 To change the recording device you use one of:
120 .Bl -tag -width =rec -offset indent
121 .It Cm ^rec
122 toggles
123 .Ar rdev
124 of possible recording devices
125 .It Cm +rec
126 adds
127 .Ar rdev
128 to possible recording devices
129 .It Cm -rec
130 removes
131 .Ar rdev
132 from possible recording devices
133 .It Cm =rec
134 sets the recording device to
135 .Ar rdev
136 .El
137 .Pp
138 The above commands work on an internal mask.  After all the options
139 have been parsed, it will set then read the mask from the sound card.
140 This will let you see EXACTLY what the soundcard is using for the
141 recording device(s).
142 .Pp
143 The option recsrc will display the current recording devices.
144 .Pp
145 The option
146 .Fl f
147 .Ar device
148 will open
149 .Ar device
150 as the mixer device.
151 .Pp
152 The option
153 .Fl h
154 will print a help and exit
155 .Sh FILES
156 .Bl -tag -width /dev/mixer -compact
157 .It Pa /dev/mixer
158 the default mixer device
159 .El
160 .Sh SEE ALSO
161 .Xr cdcontrol 1
162 .Sh HISTORY
163 The
164 .Nm
165 utility first appeared in
166 .Fx 2.0.5 .
167 .Sh AUTHORS
168 .An -nosplit
169 Original source by
170 .An Craig Metz Aq cmetz@thor.tjhsst.edu
171 and
172 .An Hannu Savolainen .
173 Mostly rewritten by
174 .An John-Mark Gurney Aq jmg@FreeBSD.org .
175 This
176 manual page was written by
177 .An Mike Pritchard Aq mpp@FreeBSD.org .