<?xml version="1.0" ?>
<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.1.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
 <!ENTITY amarok "amaroK">
 <!ENTITY amarok-quick SYSTEM "quick.docbook">
 <!ENTITY amarok-config SYSTEM "config.docbook">
 <!ENTITY amarok-using SYSTEM "using.docbook">
 <!ENTITY amarok-advanced SYSTEM "advanced.docbook">
 <!ENTITY amarok-req SYSTEM "requirements.docbook">
 <!ENTITY amarok-faq SYSTEM "faq.docbook">
 <!ENTITY kappname "&amarok;">
 <!ENTITY package "kdeextragear-1">
 <!ENTITY % addindex "IGNORE">
 <!ENTITY % English "INCLUDE">
]>

<book lang="&language;">
<bookinfo>

<title>The &amarok; Handbook</title>

<authorgroup>
 <author>
 <firstname>Mike</firstname>
 <surname>Diehl</surname>
 <affiliation>
 <address><email>madpenguin8@yahoo.com</email></address>
 </affiliation>
</author>

<othercredit role="developer" >
 <firstname>The amaroK Development Squad</firstname>
 <contrib> Developers</contrib>
</othercredit>

<!-- TRANS:ROLES_OF_TRANSLATORS -->
</authorgroup>

<copyright>
 <year>2005</year>
 <holder>The amaroK Development Squad</holder>
</copyright>

<legalnotice>&FDLNotice;</legalnotice>

<date>2005-01-02</date> <!--CHANGE ME-->
<releaseinfo>2.1</releaseinfo>

<abstract>
 <para>&amarok; is a media player for the K Desktop Environment.</para>
</abstract>

<keywordset>
 <keyword>KDE</keyword>
 <keyword>multimedia</keyword>
 <keyword>player</keyword>
 <keyword>audio</keyword>
 <keyword>ogg</keyword>
 <keyword>mp3</keyword>
 <keyword>wav</keyword>
 <keyword>music</keyword>
 <keyword>sound</keyword>
</keywordset>

</bookinfo>

<chapter id="introduction">
<title>Introduction</title>

<screenshot>
 <screeninfo>Logo</screeninfo>
 <mediaobject>
 <imageobject><imagedata fileref="logo.png" format="PNG"/></imageobject>
 </mediaobject>
</screenshot>

<para>&amarok; is the audio player for &kde;. &amarok; is a full featured audio player that is both powerful and easy to use. </para>

<para>Do you find yourself stuck searching through endless menus just to add music to your playlist? With &amarok; you can simply drag and drop music into the playlist. Maybe you are just looking for that one song from the thousands in your collection. &amarok;'s collection browser with its search bar will help you find that one song in a matter of seconds.</para>

<para>So it seems &amarok; has the same old features found in the average audio player, but we did not stop there. One look at the context browser and you will see why &amarok; is one step ahead of the rest. The context browser features a database that is compiled on the fly to provide you with constantly updated statistics about your playlist. The context browser can also display the album cover images you have making it not only informative but also fun to look at.</para>

<para>Do you already have many different playlists but can never decide on which one you want to use? Then the playlist browser is just for you. Loading your saved playlists in the playlist browser is as easy as a single keystroke.</para> 

<para>Along with aRts, &amarok; also supports the GStreamer, NMM, and xine sound servers making it the most advanced audio player available for &kde;. &amarok; is smart, it's sexy, it's clever. Try it out today!</para> 

</chapter>

&amarok-quick;

&amarok-config;

&amarok-using;

&amarok-advanced;

&amarok-faq;

<chapter id="credits">
<title>Credits and License</title>

<para>Program copyright 2003-2004 Mark Kretschmann <email>markey@web.de</email>
and The AmaroK Team.</para>

<itemizedlist>
<title>The AmaroK Team</title>
<listitem><para>Christian <quote>babe-magnet</quote> Muehlhaeuser <email>chris@chris.de</email></para></listitem>
<listitem><para>Frederik <quote>ich bin kein Deustcher!</quote> Holljen <email>fh@ez.no</email></para></listitem>
<listitem><para>Mark <quote>it's good, but it's not irssi</quote> Kretschmann <email>markey@web.de</email></para></listitem>
<listitem><para>Max <quote>Turtle-Power</quote> Howell <email>max.howell@methylblue.com</email></para></listitem>
<listitem><para>Mike <quote>purple is not girly!</quote> Diehl <email>madpenguin8@yahoo.com</email></para></listitem>
<listitem><para>Pierpaolo <quote>Spaghetti Coder</quote> Di Panfilo<email>pippo_dp@libero.it</email></para>
</listitem>
<listitem><para>Roman <quote>and God said, let there be Mac</quote> Becker <email>roman@formmorf.de</email></para></listitem>
<listitem><para>Stanislav <quote>did someone say DCOP?</quote> Karchebny <email>Stanislav.Karchebny@kdemail.net</email></para></listitem>
<listitem><para>Stefan <quote>MacroMolecularMooModeler</quote> Bogner <email>bochi@online.ms</email></para></listitem>
</itemizedlist>

<itemizedlist>
<title>Contributors:</title>

<listitem>
<para>Adam Pigg (analyzers, patches) <email>adam@piggz.fsnet.co.uk</email></para>
</listitem>

<listitem>
<para>Adeodato Simo (patches) <email>asp16@alu.ua.es</email></para>
</listitem>

<listitem>
<para>Andreas Mair (MySql Support) <email>am_ml@linogate.com</email></para>
</listitem>

<listitem>
<para>Dan Leinir Turthra Jensen (first run wizard) <email>admin@removeleinir.dk</email></para>
</listitem>

<listitem>
<para>Enrico Ros (analyzers, king of openGL) <email>eros.kde@email.it</email></para>
</listitem>

<listitem>
<para>Jarkko Lehti (tester) <email>grue@iki.fi</email></para>
</listitem>

<listitem>
<para>Josef Spillner (KDE RadioStation code) <email>spillner@kde.org</email></para>
</listitem>

<listitem>
<para>Kenneth Wesley Wimer II (icons) <email>kwwii@bootsplash.org</email></para>
</listitem>

<listitem>
<para>Melchior Franz (new FFT routine, bugfixes) <email>mfranz@kde.org</email></para>
</listitem>

<listitem>
<para>Michael Pyne (K3B export code) <email>michael.pyne@kdemail.net</email></para>
</listitem>

<listitem>
<para>Nenad Grujicic (splash screen for 1.1) <email>mchitman@neobee.net</email></para>
</listitem>

<listitem>
<para>Olivier Bédard (website hosting) <email>paleo@pwsp.net</email></para>
</listitem>

<listitem>
<para>Roland Gigler (MAS engine) <email>michael.pyne@kdemail.net</email></para>
</listitem>

<listitem>
<para>Sami Nieminen (Audioscrobbler support) <email>sami.nieminen@iki.fi</email></para>
</listitem>

<listitem>
<para>Scott Wheeler (TagLib) <email>wheeler@kde.org</email></para>
</listitem>

<listitem>
<para>Seb Ruiz (OSD improvements, patches, testing) <email>seb100@optusnet.com.au</email></para>
</listitem>

<listitem>
<para>Whitehawk Stormchaser (tester, patches) <email>zerokode@gmx.net</email></para>
</listitem>

</itemizedlist>

<para>Documentation copyright 2004 Mike Diehl <email>madpenguin8@yahoo.com</email></para>

&underFDL;   <!-- FDL: do not remove -->

&underGPL;   <!-- GPL License -->

</chapter>

&amarok-req;

<appendix id="installation">
<title>Installation</title>

<sect1 id="getting-kapp">
<title>How to obtain &amarok;</title>

<para>&amarok; can be downloaded from <ulink
url="http://amarok.kde.org">The &amarok; home page</ulink></para>


<para>The latest development version can be obtained from &kde; CVS, module
kdeextragear-1.</para>

<sect2>
<title>How to compile &amarok;</title>

<para>In order to compile and install amaroK on your system, type the following in the
base directory of the amaroK distribution:</para>

<para><command>./configure --prefix=`kde-config --prefix`</command></para>
<para><command>make</command></para>
<para><command>su -c "make install"</command></para>

<note><para>The --enable-final configure flag is no longer supported.</para></note>

<para>Since &amarok; uses <keycap>autoconf</keycap> and <keycap>automake</keycap> you should have no trouble compiling it. Should you run into problems please report them to the &kde; mailing lists.</para>

</sect2>

<sect2>
<title>Configure Options</title>

<para>&amarok; is like most other apps in that it has several compile time options that can be enabled or disabled during configure. This is a list of the options that can be configured.</para>

<note><para>Some compile time options require specific dependencies to be used. See <link linkend="requirements">the requirements section</link> for more details.</para></note>

<informaltable>
<tgroup cols="3">
<thead>

<row>
<entry>Option</entry>
<entry>Default</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>

<row>
<entry>--enable-debug=</entry>
<entry>no</entry>
<entry>Enables debug symbols. Choose from <quote>yes</quote>, <quote>no</quote>, and <quote>full</quote>. Please use the <quote>full</quote> option if you intend to help with &amarok; development.</entry>
</row>

<row>
<entry>--enable-mysql</entry>
<entry>Disabled</entry>
<entry>Enables MySql database support for &amarok;</entry>
</row>

<row>
<entry>--disable-amazon</entry>
<entry>Enabled</entry>
<entry>Disables Amazon cover art downloading support in &amarok;</entry>
</row>

<row>
<entry>--without-arts</entry>
<entry>With</entry>
<entry>Disables aRts support for &amarok;</entry>
</row>

<row>
<entry>--without-gstreamer</entry>
<entry>With</entry>
<entry>Disables GStreamer support for &amarok;</entry>
</row>

<row>
<entry>--without-xine</entry>
<entry>With</entry>
<entry>Disables xine support for &amarok;</entry>
</row>

<row>
<entry>--with-nmm</entry>
<entry>Without</entry>
<entry>Enables NMM support for &amarok;</entry>
</row>

<row>
<entry>--with-mas</entry>
<entry>Without</entry>
<entry>Enables MAS support for &amarok;</entry>
</row>

<row>
<entry>--without-opengl</entry>
<entry>With</entry>
<entry>Disables OpenGL (analyzer) support for &amarok;</entry>
</row>

<row>
<entry>--without-included-sqlite</entry>
<entry>With</entry>
<entry>Do not use the included sqlite sources (requires sqlite to be installed)</entry>
</row>

</tbody>
</tgroup>
</informaltable>

</sect2>

</sect1>

</appendix>

&documentation.index;
</book>
