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