Merge branch 'vendor/GCC50'
[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: head/usr.sbin/mixer/mixer.8 267668 2014-06-20 09:57:27Z bapt $
29 .\"
30 .Dd January 11, 2015
31 .Dt MIXER 8
32 .Os
33 .Sh NAME
34 .Nm mixer
35 .Nd set/display soundcard mixer values
36 .Sh SYNOPSIS
37 .Nm
38 .Op Fl f Ar device
39 .Op Fl s | S
40 .Oo
41 .Ar dev
42 .Sm off
43 .Oo
44 .Op Cm + | -
45 .Ar lvol
46 .Op : Oo Cm + | - Oc Ar rvol
47 .Oc
48 .Oc
49 .Sm on
50 .Ar ...
51 .Nm
52 .Op Fl f Ar device
53 .Op Fl s | S
54 .Cm recsrc
55 .Ar ...
56 .Nm
57 .Op Fl f Ar device
58 .Op Fl s | S
59 .Sm off
60 .Bro
61 .Cm ^ | + | - | =
62 .Brc
63 .Cm rec
64 .Sm on
65 .Ar rdev ...
66 .Sh DESCRIPTION
67 The
68 .Nm
69 utility is used to set and display soundcard mixer device levels.
70 It may
71 also be used to start and stop recording from the soundcard.
72 The list
73 of mixer devices that may be modified are:
74 .Bd -ragged -offset indent
75 vol, bass, treble, synth, pcm, speaker, line, mic, cd, mix,
76 pcm2, rec, igain, ogain, line1, line2, line3, dig1, dig2, dig3,
77 phin, phout, video, radio, and monitor.
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.
98 The
99 .Ar lvol
100 and
101 .Ar rvol
102 arguments may be from 0 - 100.
103 Omitting
104 .Ar dev
105 and including only the channel settings will change the main volume level.
106 .Pp
107 If the left or right channel settings are prefixed with
108 .Cm +
109 or
110 .Cm - ,
111 the value following will be used as a relative adjustment, modifying the
112 current settings by the amount specified.
113 .Pp
114 If the
115 .Fl s
116 flag is used, the current mixer values will be displayed in a format suitable
117 for use as the command-line arguments to a future invocation of
118 .Nm
119 (as above).
120 .Pp
121 The
122 .Fl S
123 flag provides the above output without mixing field separators.
124 .Pp
125 To change the recording device you use one of:
126 .Bl -tag -width =rec -offset indent
127 .It Cm ^rec
128 toggles
129 .Ar rdev
130 of possible recording devices
131 .It Cm +rec
132 adds
133 .Ar rdev
134 to possible recording devices
135 .It Cm -rec
136 removes
137 .Ar rdev
138 from possible recording devices
139 .It Cm =rec
140 sets the recording device to
141 .Ar rdev
142 .El
143 .Pp
144 The above commands work on an internal mask.
145 After all the options
146 have been parsed, it will set then read the mask from the sound card.
147 This will let you see EXACTLY what the soundcard is using for the
148 recording device(s).
149 .Pp
150 The option recsrc will display the current recording devices.
151 .Pp
152 The option
153 .Fl f
154 .Ar device
155 will open
156 .Ar device
157 as the mixer device.
158 .Sh FILES
159 .Bl -tag -width /dev/mixer -compact
160 .It Pa /dev/mixer
161 the default mixer device
162 .El
163 .Sh SEE ALSO
164 .Xr cdcontrol 1 ,
165 .Xr sound 4
166 .Sh HISTORY
167 The
168 .Nm
169 utility first appeared in
170 .Fx 2.0.5 .
171 .Sh AUTHORS
172 .An -nosplit
173 Original source by
174 .An Craig Metz Aq Mt cmetz@thor.tjhsst.edu
175 and
176 .An Hannu Savolainen .
177 Mostly rewritten by
178 .An John-Mark Gurney Aq Mt jmg@FreeBSD.org .
179 This
180 manual page was written by
181 .An Mike Pritchard Aq Mt mpp@FreeBSD.org .