2
<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.1-Based Variant V1.0//EN" "dtd/kdex.dtd" [
3
<!ENTITY kappname "&kmix;">
4
<!ENTITY % English "INCLUDE" > <!-- change language only here -->
5
<!ENTITY % addindex "IGNORE">
10
<book lang="&language;">
13
<title>The &kmix; Handbook</title>
17
<firstname>Matt</firstname>
18
<surname>Johnston</surname>
20
<address><email>mattj@flashmail.com</email></address>
24
<othercredit role="developer">
25
<firstname>Stefan</firstname>
26
<surname>Schimanski</surname>
27
<affiliation><address><email>1Stein@gmx.de</email></address></affiliation>
28
<contrib>Developer</contrib>
31
<othercredit role="reviewer">
32
<firstname>Lauri</firstname>
33
<surname>Watts</surname>
34
<affiliation><address><email>vampyr@atconnex.net</email></address></affiliation>
35
<contrib>Reviewer</contrib>
37
<!-- TRANS:ROLES_OF_TRANSLATORS -->
41
<year>1999</year><year>2000</year>
42
<holder>Matt Johnston & Christian Esken</holder>
44
<legalnotice>&FDLNotice;</legalnotice>
46
<date>2000-09-11</date>
47
<releaseinfo>1.03.00</releaseinfo>
49
<abstract><para>&kmix; is an application to allow you to change the volume of
50
your sound card.</para></abstract>
53
<keyword>KDE</keyword>
54
<keyword>KMix</keyword>
55
<keyword>kdemultimedia</keyword>
56
<keyword>sound</keyword>
57
<keyword>volume</keyword>
58
<keyword>mixer</keyword>
63
<chapter id="introduction">
64
<title>Introduction</title>
66
<para>&kmix; is KDE's soundcard mixer program. Though small, it is full-featured.
67
The program should give controls for each of your soundcards.</para>
69
<para>&kmix; supports several platforms and sound drivers. Version 1.9 works with:</para>
72
<listitem><para> All Open Sound System platforms. Explicitly tested are Linux,
73
FreeBSD, NetBSD and BSDI.</para></listitem>
74
<listitem><para> Solaris based machines.</para></listitem>
75
<listitem><para> IRIX based machines.</para></listitem>
76
<listitem><para> The ALSA soundcard driver.</para></listitem>
77
<listitem><para> HP-UX based machines.</para></listitem>
82
<chapter id="working-with-kmix">
83
<title>Working with &kmix;</title>
85
<para>&kmix; usage is straightforward. Every mixer device that your soundcard
86
provides is represented by a volume slider. Mono devices have a single slider,
87
stereo devices can have either one or two sliders, depending on your choice.
88
Additionaly there is a panning slider at the bottom of the &kmix; window. If you
89
have multiple soundcards, they will each have their own tab.</para>
91
<sect1 id="volume-sliders">
92
<title>Volume sliders</title>
94
<para>The volume sliders have a context menu, accessible by right clicking on
95
the slider or device icon (at the top). Three entries are possible, but only
96
those applicable are shown.</para>
100
<term><guilabel>Muted</guilabel></term>
101
<listitem><para>Mute or unmute the device</para></listitem>
104
<term><guilabel>Split Channels</guilabel></term>
105
<listitem><para>Show either one or two sliders. This is only applicable to
106
stereo devices. The right slider controls right side volume, and the left
107
controls left side volume.</para></listitem>
110
<term><guilabel>Set Record Source</guilabel></term>
111
<listitem><para>Set this device as record source. Only applicable to recordable
112
devices. This can also be done by clicking the red button below the slider (if
113
it is available).</para></listitem>
118
<sect1 id="panning-slider">
119
<title>Panning slider</title>
121
<para>With this slider you can control the volume distribution between left and
122
right speaker. This slider is an overall regulator, which affects all stereo
123
devices (Mono devices are ignored). The middle position is the default. Dragging
124
the slider to the left lowers the volume of the right speaker, dragging it to
125
the right vice versa. Of course, these might be swapped if your speakers aren't
126
positioned correctly.</para>
130
<sect1 id="configuration-options">
131
<title>Configuration options</title>
133
<para>If the &kmix; icon is docked into the system tray, you can right click it
134
to choose preferences. These items are:</para>
138
<term><guilabel>Dock into panel</guilabel></term>
139
<listitem><para>minimize to an icon in the system tray</para></listitem>
142
<term><guilabel>Only hide window with close button - don't close
143
KMix</guilabel></term>
144
<listitem><para>Just minimize &kmix; when closing the window, don't close
145
it.</para></listitem>
148
<term><guilabel>Show tickmarks</guilabel></term>
149
<listitem><para>Show lines to mark positions on the sliders.</para></listitem>
152
<term><guilabel>Show labels</guilabel></term>
153
<listitem><para>Display labels for each of the sound devices. Wether this item
154
is checked or not, by holding the mouse over the icon for each device, you can
155
see this information.</para></listitem>
164
<chapter id="control-panel">
165
<title><application>KControl</application> Settings</title>
167
<sect1 id="config-opt">
168
<title>Configuration options</title>
170
<para>In the <guimenuitem>Mixer</guimenuitem> item, under
171
<guimenu>Sound</guimenu> in <application>KControl</application>, you can set
172
various options for &kmix;:</para>
176
<term><guilabel>Save current volumes</guilabel></term>
177
<listitem><para>Save the current sound settings to load later.</para></listitem>
180
<term><guilabel>Load volumes</guilabel></term>
181
<listitem><para>Load sound settings which were previously
182
saved.</para></listitem>
185
<term><guilabel>Load volumes on login</guilabel></term>
186
<listitem><para>Automatically load the previous settings when you start
187
KDE.</para></listitem>
190
<term><guilabel>Maximum number of probed mixers</guilabel></term>
191
<listitem><para>How many different soundcards &kmix; should look for when
192
starting. Set this low to speed up &kmix;'s startup time.</para></listitem>
195
<term><guilabel>Maximum number of probed devices per mixer</guilabel></term>
196
<listitem><para>How many devices to look for per soundcard. Again, set this low
197
to speed up &kmix;.</para></listitem>
204
<chapter id="installation">
205
<title>Installation</title>
207
<sect1 id="getting-kmix">
208
<title>How to obtain &kmix;</title>
210
<para>&kmix; is part of the KDE project <ulink
211
url="http://www.kde.org">http://www.kde.org</ulink>. &kmix; can be found in the
212
kdemultimedia package on <ulink
213
url="ftp://ftp.kde.org/pub/kde/">ftp://ftp.kde.org/pub/kde/</ulink>, the main
214
ftp site of the KDE project. </para>
217
<sect1 id="requirements">
218
<title>Requirements</title>
220
<para>Obviously, &kmix; is only of use if you have a soundcard.
221
&kmix; supports several platforms and sound drivers:</para>
224
<listitem><para> All Open Sound System platforms. Explicitly tested are Linux,
225
FreeBSD, NetBSD and BSDI.</para></listitem>
226
<listitem><para> Solaris based machines.</para></listitem>
227
<listitem><para> IRIX based machines.</para></listitem>
228
<listitem><para> The ALSA soundcard driver.</para></listitem>
229
<listitem><para> HP-UX based machines.</para></listitem>
234
<sect1 id="compilation">
235
<title>Compilation and Installation</title>
237
<para>In order to compile and install &kmix; on your system, type the following
238
in the base directory of the kdemultimedia distribution:</para>
241
<prompt>%</prompt> <command>./configure</command>
242
<prompt>%</prompt> <command>make</command>
243
<prompt>%</prompt> <command>make <option>install</option></command>
246
<para>Since &kmix; uses <application>autoconf</application> and
247
<application>automake</application> you should have not trouble compiling
248
it. Should you run into problems please report them to the KDE mailing
255
<chapter id="credits">
256
<title>Credits and License</title>
260
<para>Program copyright 2000 Stefan Schimanski
261
<email>1Stein@gmx.de</email></para>
263
<para>Contributors:</para>
266
<listitem><para>Christian Esken <email>esken@kde.org</email></para></listitem>
267
<listitem><para>Stefan Schimanski <email>1Stein@gmx.de</email></para></listitem>
268
<listitem><para>Paul Kendall <email>paul@orion.co.nz</email> - SGI
269
Port</para></listitem>
270
<listitem><para>Sebestyen Zoltan <email>szoli@digo.inf.elte.hu</email> - FreeBSD
271
Fixes</para></listitem>
272
<listitem><para>Faraut Jean-Louis <email>jlf@essi.fr</email> - Solaris
273
Fixes</para></listitem>
274
<listitem><para>Nick Lopez <email>kimo_sabe@usa.net</email> - ALSA
275
Port</para></listitem>
276
<listitem><para>Helge Deller <email>deller@gmx.de</email> - HP-UX
277
Port</para></listitem>
278
<listitem><para>Lennart Augustsson <email>augustss@cs.chalmers.se</email> - *BSD
279
Fixes</para></listitem>
282
<para>Documentation copyright 2000 Matt Johnston
283
<email>mattj@flashmail.com</email></para>
285
<para>Based on documentation by Christian Esken
286
<email>esken@kde.org</email></para>
287
<!-- TRANS:CREDIT_FOR_TRANSLATORS -->
added
removed
doc/kmix/index.docbook
