Git commit 3f3fc951eaa1ef3f95f5030a3d9fa7b2c70b9ada by Yuri Chornoivan. Committed on 21/12/2013 at 14:22. Pushed by yurchor into branch 'master'.
Update docs to version 4.5 M +102 -35 doc/index.docbook A +- -- doc/kmix-configure-general.png A +- -- doc/kmix-configure-sound-menu.png A +- -- doc/kmix-configure-start.png D +- -- doc/kmix-configure.png http://commits.kde.org/kmix/3f3fc951eaa1ef3f95f5030a3d9fa7b2c70b9ada diff --git a/doc/index.docbook b/doc/index.docbook index 498c53a..63b2832 100644 --- a/doc/index.docbook +++ b/doc/index.docbook @@ -50,8 +50,8 @@ <legalnotice>&FDLNotice;</legalnotice> -<date>2012-11-03</date> -<releaseinfo>4.3</releaseinfo> +<date>2013-12-21</date> +<releaseinfo>4.5</releaseinfo> <abstract> <para>&kmix; is an application that allows you to change the volume of your sound card.</para> @@ -213,39 +213,27 @@ soundcards.</para>--> <sect2 id='Configure'> <title>Configure &kmix;</title> -<screenshot> - <screeninfo>Configure &kmix;</screeninfo> +<sect3 id="configure-general"> + <title> + General configuration + </title> + <screenshot> + <screeninfo>General configuration of &kmix;</screeninfo> <mediaobject> <imageobject> - <imagedata fileref="kmix-configure.png" format="PNG"/> + <imagedata fileref="kmix-configure-general.png" format="PNG"/> </imageobject> <textobject> - <phrase>Configure &kmix;</phrase> + <phrase>General configuration of &kmix;</phrase> </textobject> </mediaobject> </screenshot> -<para>Configure various &kmix; parameters.</para> +<para>Configure general &kmix; parameters.</para> <variablelist> <varlistentry> <term><menuchoice> <guimenu>Behavior</guimenu> -<guimenuitem>Dock in system tray</guimenuitem> -</menuchoice></term> -<listitem><para><action>Check this box to dock &kmix; in system tray.</action></para></listitem> -</varlistentry> - -<varlistentry> -<term><menuchoice> -<guimenu>Behavior</guimenu> -<guimenuitem>Enable system tray volume control</guimenuitem> -</menuchoice></term> -<listitem><para><action>Check this box to enable the volume control from system tray.</action></para></listitem> -</varlistentry> - -<varlistentry> -<term><menuchoice> -<guimenu>Behavior</guimenu> <guimenuitem>Volume Feedback</guimenuitem> </menuchoice></term> <listitem><para><action>Check this box to enable audible feedback on volume change.</action></para></listitem> @@ -253,21 +241,18 @@ soundcards.</para>--> <varlistentry> <term><menuchoice> -<guimenu>Startup</guimenu> -<guimenuitem>Restore Volumes on login</guimenuitem> -</menuchoice></term> -<listitem><para><action>Check this box to enable volume restoration on login.</action></para></listitem> -</varlistentry> - -<varlistentry> -<term><menuchoice> -<guimenu>Startup</guimenu> -<guimenuitem>Autostart</guimenuitem> +<guimenu>Behavior</guimenu> +<guimenuitem>Volume Overdrive</guimenuitem> </menuchoice></term> -<listitem><para><action>Check this box to enable &kmix; autostart with desktop environment.</action></para></listitem> +<listitem><para>Check this box to allow volume to be more than recommended value (sometimes PulseAudio maximal volume exceeds the normal value). &kmix; restart is needed for this setting to take effect.</para> + <warning> + <para> + Uncheck this item if there are audible sound distortions at the maximal volume. + </para> + </warning> +</listitem> </varlistentry> - <varlistentry> <term><menuchoice> <guimenu>Visual</guimenu> @@ -308,7 +293,89 @@ soundcards.</para>--> <listitem><para><action>Check this radio button to orientate the control slider vertically.</action></para></listitem> </varlistentry> +<varlistentry> +<term><menuchoice> +<guimenu>Slider orientation (System tray volume control)</guimenu> +<guimenuitem>Horizontal/Vertical</guimenuitem> +</menuchoice></term> +<listitem><para>Same as the previous two radio buttons but for the system tray volume control (the panel that is shown after &LMB; click on &kmix; tray icon).</para></listitem> +</varlistentry> +</variablelist> + +</sect3> + +<sect3 id="configure-start"> + <title> + Start configuration + </title> + <screenshot> + <screeninfo>Start configuration of &kmix;</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="kmix-configure-start.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>Start configuration of &kmix;</phrase> + </textobject> + </mediaobject> +</screenshot> +<para>This page allows you to configure various &kmix; start parameters.</para> + +<variablelist> +<varlistentry> +<term><menuchoice> +<guimenu>Startup</guimenu> +<guimenuitem>Restore volumes on login</guimenuitem> +</menuchoice></term> +<listitem><para><action>Check this box to enable volume restoration on login.</action></para> + <warning> + <para> + Dynamic control from PulseAudio and MPRIS2 will not be restored. + </para> + </warning> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Startup</guimenu> +<guimenuitem>Autostart</guimenuitem> +</menuchoice></term> +<listitem><para><action>Check this box to enable &kmix; autostart with desktop environment.</action></para></listitem> +</varlistentry> +</variablelist> + +</sect3> + +<sect3 id="configure-sound-menu"> + <title> + Sound menu configuration + </title> + <screenshot> + <screeninfo>Sound menu configuration of &kmix;</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="kmix-configure-sound-menu.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>Sound menu configuration of &kmix;</phrase> + </textobject> + </mediaobject> +</screenshot> +<para>This page allows you to configure various &kmix; sound menu parameters.</para> + +<variablelist> +<varlistentry> +<term><guilabel>Dock in system tray</guilabel> +</term> +<listitem><para><action>Check this box to dock &kmix; in system tray.</action></para></listitem> +</varlistentry> </variablelist> + +<para> + It is possible to select mixers that will be shown in the sound menu using the corresponding list on this page. +</para> +</sect3> </sect2> </sect1> </chapter> diff --git a/doc/kmix-configure-general.png b/doc/kmix-configure-general.png new file mode 100644 index 0000000..8ac7854 Binary files /dev/null and b/doc/kmix-configure-general.png differ diff --git a/doc/kmix-configure-sound-menu.png b/doc/kmix-configure-sound-menu.png new file mode 100644 index 0000000..1b5574b Binary files /dev/null and b/doc/kmix-configure-sound-menu.png differ diff --git a/doc/kmix-configure-start.png b/doc/kmix-configure-start.png new file mode 100644 index 0000000..e07163e Binary files /dev/null and b/doc/kmix-configure-start.png differ diff --git a/doc/kmix-configure.png b/doc/kmix-configure.png deleted file mode 100644 index cf4b432..0000000 Binary files a/doc/kmix-configure.png and /dev/null differ
