Add the DragonFly cvs id and perform general cleanups on cvs/rcs/sccs ids. Most
[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.2 2003/06/17 04:29:57 dillon 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 .Oo
42 .Oo Ar dev
43 .Op Ar lvol Ns Op : Ns Ar rvol
44 .Cm | recsrc |
45 .Sm off
46 .Eo \&{
47 .Cm ^ | + | - | =
48 .Sm on
49 .Ec \&} Ns Cm rec
50 .Ar rdev
51 .Oc
52 .Ar ...
53 .Oc
54 .Sh DESCRIPTION
55 The
56 .Nm
57 utility is used to set and display soundcard mixer device levels.
58 It may
59 also be used to start and stop recording from the soundcard.  The list
60 of mixer devices that may be modified are:
61 .Pp
62 .Bd -ragged -offset indent
63 vol, bass, treble, synth, pcm, speaker, mic, cd, mix,
64 pcm2, rec, igain, ogain, line1, line2, and line3.
65 .Ed
66 .Pp
67 Not all mixer devices are available.
68 .Pp
69 When
70 .Nm
71 is run without any arguments, all supported devices are displayed
72 along with current values.
73 If the
74 .Ar dev
75 argument is specified, the value for the
76 .Ar dev
77 device will be displayed.
78 .Pp
79 To modify the mixer value
80 .Ar dev ,
81 the optional left and right channel settings of
82 .Ar lvol Ns Op : Ns Ar rvol
83 may be specified.  The
84 .Ar lvol
85 and
86 .Ar rvol
87 arguments may be from 0 - 100.  Omitting
88 .Ar dev
89 and including only the channel settings will change the main volume level.
90 .Pp
91 If the
92 .Fl s
93 flag is used, the current mixer values will be displayed in a format suitable
94 for use as the command-line arguments to a future invocation of
95 .Nm
96 (as above).
97 .Pp
98 To change the recording device you use one of:
99 .Bl -tag -width =rec -offset indent
100 .It Cm ^rec
101 toggles
102 .Ar rdev
103 of possible recording devices
104 .It Cm +rec
105 adds
106 .Ar rdev
107 to possible recording devices
108 .It Cm -rec
109 removes
110 .Ar rdev
111 from possible recording devices
112 .It Cm =rec
113 sets the recording device to
114 .Ar rdev
115 .El
116 .Pp
117 The above commands work on an internal mask.  After all the options
118 have been parsed, it will set then read the mask from the sound card.
119 This will let you see EXACTLY what the soundcard is using for the
120 recording device(s).
121 .Pp
122 The option recsrc will display the current recording devices.
123 .Pp
124 The option
125 .Fl f
126 .Ar device
127 will open
128 .Ar device
129 as the mixer device.
130 .Sh FILES
131 .Bl -tag -width /dev/mixer -compact
132 .It Pa /dev/mixer
133 the default mixer device
134 .El
135 .Sh SEE ALSO
136 .Xr cdcontrol 1
137 .Sh HISTORY
138 The
139 .Nm
140 utility first appeared in
141 .Fx 2.0.5 .
142 .Sh AUTHORS
143 .An -nosplit
144 Original source by
145 .An Craig Metz Aq cmetz@thor.tjhsst.edu
146 and
147 .An Hannu Savolainen .
148 Mostly rewritten by
149 .An John-Mark Gurney Aq jmg@FreeBSD.org .
150 This
151 manual page was written by
152 .An Mike Pritchard Aq mpp@FreeBSD.org .