<?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"><!-- replace kapp here, do *not* replace kappname-->
  <!ENTITY kappname "&amarok;"><!-- replace kapp here, do *not* replace
kappname-->
  <!ENTITY package "kdeextragear-1"><!-- kdebase, kdeadmin, etc -->
  <!ENTITY % addindex "IGNORE">
  <!ENTITY % English "INCLUDE"><!-- change language only here -->
]>

<book lang="&language;">


<bookinfo>

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

<authorgroup>
<author>
<firstname>Mark</firstname>
<othername></othername>
<surname>Kretschmann</surname>
<affiliation>
<address><email>markey@web.de</email></address>
</affiliation>
</author>

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

<othercredit role="developer" >
<firstname> The amaroK Team</firstname> <surname></surname>
<contrib> Developers</contrib>
<affiliation> <address> <email></email> </address> </affiliation>
</othercredit>

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


<copyright>
<year>2003</year>
<year>2004</year>
<holder>Mark Kretschmann</holder>
<holder>Mike Diehl</holder>
</copyright>
<legalnotice>&FDLNotice;</legalnotice>

<date>2004-05-19</date>
<releaseinfo>1.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>
<textobject><phrase>Logo</phrase></textobject>
</mediaobject>
</screenshot>

<para>&amarok; is a multimedia player based on the soundserver-independent framework. There
are many media players around these days, true. What's missing from most
players is a user interface, that doesn't get in the way of the user.</para>

<para>How many buttons do you have to press for simply adding some new
tracks to the playlist?</para>

<para>&amarok; tries to be a little different, providing a simple drag and
drop interface, that really makes playlist handling easy.</para>

<itemizedlist>
<title>Features</title>
<listitem><para>innovative playlist concept, very fast to use, with drag and
drop</para></listitem>
<listitem><para>plays all formats supported by backend soundserver, including mp3, ogg, audio
CDs, streams</para></listitem>
<listitem><para>audio effects, like reverb and compressor</para></listitem>
<listitem><para>compatible with the .m3u and .pls formats for
playlists</para></listitem>
<listitem><para>nice GUI, integrates into the KDE look, but with a unique
touch</para></listitem>
<listitem><para>completely network transparent</para></listitem>
<listitem><para>soundserver independent with currently present support for &arts;, GStreamer, NMM</para></listitem>
</itemizedlist>

</chapter>


<chapter id="configuring-kapp">
<title>Configuring &amarok;</title>

<para>The &amarok; configuration window consists of a tabbed dialog containing five sections. The configuration dialog can be found by right clicking the player window and selecting <guimenuitem>Configure amaroK</guimenuitem>.</para>

<sect1 id="general_options">
<title>General Options</title>

<screenshot>
<screeninfo>General Options Screenshot</screeninfo>
<mediaobject>
<imageobject><imagedata fileref="config_general.png" format="PNG"/></imageobject>
<textobject><phrase>Screenshot</phrase></textobject>
</mediaobject>
</screenshot>

<para>The General Options tab is divided into two sections, <guimenuitem>General Options</guimenuitem> and <guimenuitem>Playlist Options</guimenuitem>.</para>

<variablelist>
<varlistentry>
<term><menuchoice><guimenu>General Options</guimenu></menuchoice></term>
<listitem>
<para>In the General Options section you can configure &amarok; to show the splash-screen on startup. You can also turn the tray icon on or off. There is also an option to Show Player Window. Checking this option turns on the player window along with the playlist window similar to XMMS. Un-checked this option enables only the playlist in a configuration similar to JUK.</para>
</listitem>
</varlistentry>



<varlistentry>
<term><menuchoice><guimenu>Playlist Options</guimenu></menuchoice></term>
<listitem>
<para>In the Playlist Options section you can configure the playlist's behavior.</para>

<para>The first option <guimenuitem>Remember current playlist on exit</guimenuitem> is for saving your playlist upon exiting &amarok;. Check this if you want to save your current playlist when you exit &amarok;.</para>

<para>The next option, <guimenuitem>Show metadata in playlist</guimenuitem> allows you to view the metadata in your media files from the playlist window.</para>

<para>The <guimenuitem>Hide playlist with main window</guimenuitem> option when checked hides the playlists window when you hide the player window. Unchecked this option allows you to hide the player alone so that you can control &amarok; completely from the playlist window.</para>

<para>The <guimenuitem>Playlist scrolls with active song</guimenuitem> option automatically scrolls the playlist to show the currently playing song.</para>

<para>The <guimenuitem>Add directories recursively</guimenuitem> option is handy when you would like to add media from a directory and all of it's sub-directories all at once.</para>

<para>The <guimenuitem>Show statusbar</guimenuitem> option is used to enable or disable the status bar in the Playlist window.</para>

<para>The <guimenuitem>Show Welcome-page tab</guimenuitem> is used to enable or disable the Welcome tab in the Playlist window. A restart of &amarok; is required to enable this feature if it is currently disabled.</para>

</listitem>
</varlistentry>
</variablelist>
</sect1>

<sect1 id="configure_fonts">
<title>Configure Fonts</title>

<screenshot>
<screeninfo>Configure Fonts Screenshot</screeninfo>
<mediaobject>
<imageobject><imagedata fileref="config_fonts.png" format="PNG"/></imageobject>
<textobject><phrase>Screenshot</phrase></textobject>
</mediaobject>
</screenshot>

<para>The Configure Fonts tab allows you to use the standard or custom fonts for &amarok;.</para>

<variablelist>
<varlistentry>
<term><menuchoice><guimenu>Custom Fonts</guimenu></menuchoice></term>
<listitem>
<para>Selecting the <guimenuitem>Use custom fonts</guimenuitem> check-box allows you to choose the Player, Marquees, and Playlist-window fonts.</para></listitem>
</varlistentry>
</variablelist>
</sect1>

<sect1 id="configure_colors">
<title>Configure Colors</title>

<screenshot>
<screeninfo>Configure Colors Screenshot</screeninfo>
<mediaobject>
<imageobject><imagedata fileref="config_colors.png" format="PNG"/></imageobject>
<textobject><phrase>Screenshot</phrase></textobject>
</mediaobject>
</screenshot>

<para>The Configure Colors tab allows you to choose a color scheme for the &amarok; playlist window.</para>

<variablelist>
<varlistentry>
<term><menuchoice><guimenu>Playlist colors</guimenu></menuchoice></term>
<listitem>
<para>You can choose from three different types of color schemes.</para>

<para>The <guimenuitem>amaroK default color scheme</guimenuitem> sets the playlist to a color scheme matching that of the player.</para>

<para>The <guimenuitem>Current KDE color scheme</guimenuitem> follows the color scheme that you select from the KDE Control Center.</para>

<para>The <guimenuitem>Custom color scheme</guimenuitem> allows you to set the playlist colors to any colors you wish. Selecting this scheme activates a section below it to choose both Foreground and Background colors.</para></listitem>
</varlistentry>
</variablelist>
</sect1>

<sect1 id="configure_playback">
<title>Configure Playback</title>


<screenshot>
<screeninfo>Configure Playback Screenshot</screeninfo>
<mediaobject>
<imageobject><imagedata fileref="config_playback.png" format="PNG"/></imageobject>
<textobject><phrase>Screenshot</phrase></textobject>
</mediaobject>
</screenshot>

<para>The Configure Playback tab provides an interface for configuring your audio playback characteristics.</para>

<variablelist>
<varlistentry>
<term><menuchoice><guimenu>Transition Behavior</guimenu></menuchoice></term>
<listitem>
<para>You can configure how &amarok; transitions from one song to the next. <guimenuitem>Normal</guimenuitem> provides a silent gap specified in milliseconds. <guimenuitem>Crossfade</guimenuitem> provides a nice fading effect, the crossfade period is also specified in milliseconds.</para></listitem>
</varlistentry>

<varlistentry>
<term><menuchoice><guimenu>Sound System:</guimenu></menuchoice></term>
<listitem>
<para>The <guimenuitem>Sound System:</guimenuitem> combo box allows you to choose from your available sound system engines.</para>
</listitem>
</varlistentry>

<varlistentry>
<term><menuchoice><guimenu>Output to:</guimenu></menuchoice></term>
<listitem>
<para>The <guimenuitem>Output to:</guimenuitem> combo box provides you with a way to choose what sound subsystem to use with your <guimenuitem>Sound system:</guimenuitem>.</para>
</listitem>
</varlistentry>

<varlistentry>
<term><menuchoice><guimenu>Device:</guimenu></menuchoice></term>
<listitem>
<para>The <guimenuitem>Device:</guimenuitem> line edit box provides you with a way to select a device other than the default device for the Gstreamer sound system.</para>
</listitem>
</varlistentry>

<varlistentry>
<term><menuchoice><guimenu>Remaining Options</guimenu></menuchoice></term>
<listitem>
<para>The remainder of the Playback tab contains several check boxes to configure the the following options:</para>

<para><guimenuitem>Resume playback on start</guimenuitem> allows you to resume upon startup the last song that was playing when &amarok; was last closed.  </para>

<para><guimenuitem>Use hardware volume mixer</guimenuitem> configures your &amarok; volume slider to adjust your sound card's mixer to control the volume level.</para>

<para><guimenuitem>Display Shoutcast metadata(title streaming)</guimenuitem> displays Shoutcast metadata in the player window.</para>

<para><guimenuitem>Remember effects</guimenuitem> saves your sound server effects, which are configured with the <guimenuitem>FX</guimenuitem> button on the player.</para>
</listitem>
</varlistentry>
</variablelist>
</sect1>



<sect1 id="configure_osd">
<title>Configure On-Screen-Display</title>

<screenshot>
<screeninfo>Configure OSD Screenshot</screeninfo>
<mediaobject>
<imageobject><imagedata fileref="config_osd.png" format="PNG"/></imageobject>
<textobject><phrase>Screenshot</phrase></textobject>
</mediaobject>
</screenshot>

<variablelist>
<varlistentry>
<term><menuchoice><guimenu>Configure On-Screen-Display</guimenu></menuchoice></term>
<listitem>
<para>The <guimenuitem>Configure On-Screen-Display</guimenuitem> tab allows you to turn on the On-Screen-Display. If the On-Screen-Display check box is selected an area is activated for configuring the look of the display. When the On-Screen-Display is activated a preview widget will be displayed allowing you to see the effects of your changes to the look of the On-Screen-Display</para>
</listitem>
</varlistentry>
</variablelist>

</sect1>
</chapter>

<chapter id="using-kapp">
<title>Using &amarok;</title>

<para>&amarok; consists of two different windows.</para>

<para>The application's central component is the Player window. It's usage
is somewhat similar to a CD-Player and a Hifi-Tuner. With it you can control all the important functions like playing tracks and adjusting the
volume. </para>

<para>Then there is the Playlist Window, which is used to select tracks from
your media collection and organize them.</para>

<sect1 id="player-window">
<title>The Player Window</title>

<screenshot>
<screeninfo>Player Window Screenshot</screeninfo>
<mediaobject>
<imageobject><imagedata fileref="player_window.png" format="PNG"/></imageobject>
<textobject><phrase>Screenshot</phrase></textobject>
</mediaobject>
</screenshot>

<para>Usage of the Player window is straightforward and works much like in
other media players. There are the usual buttons for Previous, Play, Pause,
Stop and Next, which allow you to control playback. The player window is not limited to just these buttons, below is a list of other controls made available by the player window</para>

<variablelist>
<varlistentry>
<term><menuchoice><guimenu>Right Mouse-Button Menu</guimenu></menuchoice></term>
<listitem>

<para>Press the &RMB; anywhere on the Player window to bring up a menu. Use
this menu to access important program functions, like <guimenuitem>Settings</guimenuitem> and <guimenuitem>Effects</guimenuitem> configuration.</para></listitem>
</varlistentry>

<varlistentry>
<term><menuchoice><guimenu>Analyzer</guimenu></menuchoice></term>
<listitem><para><action>On the right side there is a graphical analyzer,
which shows you a spectrum analyzation of the currently playing
audio. Clicking the analyzer area will change the analyzer type.
</action></para></listitem>
</varlistentry>

<varlistentry>
<term><menuchoice><guimenu>PL Button</guimenu></menuchoice></term>
<listitem><para><action>Click this button to hide or show the Playlist
window. See the Playlist manual section for more
information.</action></para></listitem>
</varlistentry>

<varlistentry>
<term><menuchoice><guimenu>FX Button</guimenu></menuchoice></term>
<listitem><para><action>Click this button to bring up a window which allows you to choose your available effects.</action></para></listitem>
</varlistentry>

<varlistentry>
<term><menuchoice><guimenu>Time Display</guimenu></menuchoice></term>
<listitem><para><action>The time Display on the left side of the player shows you the
elapsed track time by default. By clicking on it you can switch it to
showing the remaining time instead.</action></para></listitem>
</varlistentry>
</variablelist>
</sect1>

<sect1 id="playlist-window">
<title>The Playlist Window</title>

<screenshot>
<screeninfo>Playlist Window Screenshot</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="playlist_window.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>Screenshot</phrase>
</textobject>
</mediaobject>
</screenshot>

<para>The Playlist Window is used for browsing your media collection and setting up your playlists. The Playlist Window can also be used to control the player. This window is divided into two main parts:</para>

<para>On the left side you see the <quote>Sidebar</quote>. The sidebar has several tabs for gathering files for your collection, it also has some tabs for information about your collection. </para>

<para>On the right is the playlist. The playlist is a listing of the files you have enqueued for playing.</para>

<para>Almost everything can be done with simple Drag and Drop operations between these two sections! To put tracks into the playlist, simply drag the desired files from the Filebrowser tab on the left side to the Playlist on the right, or drag files from Konqueror window into the right side of playlist to have them added. To remove tracks from the playlist, simply select them and press the <keycap>Del</keycap> key on your keyboard.</para>

<tip>
<screenshot>
<screeninfo>Playlist Tip</screeninfo>
<mediaobject>
<imageobject><imagedata fileref="pl_tip1.png" format="PNG"/></imageobject>
<textobject><phrase>Screenshot</phrase></textobject>
</mediaobject>
</screenshot>

<para>You can select items to be played in a specific order by holding <keycap>Control</keycap> and clicking the &RMB; on items in the order in which you wish them to be played. The items will be tagged with a number showing the order in which you selected them.</para>
</tip>

<sect2>
<title>The Side Bar Tabs</title>

<variablelist>
<varlistentry>
<term><menuchoice><guimenu>Filebrowser</guimenu></menuchoice></term>
<listitem>
<screenshot>
<screeninfo>File Browser Screenshot</screeninfo>
<mediaobject>
<imageobject><imagedata fileref="file_browser.png" format="PNG"/></imageobject>
<textobject><phrase>Screenshot</phrase></textobject>
</mediaobject>
</screenshot>

<para>The Filebrowser panel works similar like the Fileselector dialog from &kde;:
you can view your filesystem with it, navigating either by mouse or
keyboard. On the top of the browser there's a text input field where you
can enter an URL for a directory, for instance:
<quote>ftp://ftp.scene.org/pub</quote> or
maybe something like <filename class="directory">/home/mark/ogg</filename>,
for browsing your local filesystem. After pressing <keycap>Return</keycap> the
browser will
display the contents of the chosen directory.</para>

<para>Once you've reached the directory containing the media you would like to
play, simply Drag those files with the mouse into the Playlist on the right
side. After dropping, you'll see them getting added to the playlist
instantly.</para>

<tip><para>When playlist grows larger than one screenful, it becomes hard to
append files by simply dropping them. Holding <keycap>Shift</keycap> key on keyboard while dropping
may help in this case: the files will be appended at the end of playlist rather than
inserted at current drop position.</para></tip>
</listitem>
</varlistentry>

<varlistentry>
<term><menuchoice><guimenu>Search</guimenu></menuchoice></term>
<listitem>
<screenshot>
<screeninfo>Search Screenshot</screeninfo>
<mediaobject>
<imageobject><imagedata fileref="search.png" format="PNG"/></imageobject>
<textobject><phrase>Screenshot</phrase></textobject>
</mediaobject>
</screenshot>

<para>The search panel is used to search for files inside directories of your choice.</para>

<para>By filling in the <guimenuitem>Search for:</guimenuitem> field and selecting a directory in the <guimenuitem>In:</guimenuitem> drop box you can search directories recursively for files matching your search criteria. Pressing the <guibutton>Search</guibutton> button will begin your search. Your search status and results will be shown in the listings that make up the remainder of the panel. </para>

<tip><para>You never need to click the text input box to get focus. All key presses are automatically sent to the text input for easier, and faster  access to this excellent feature.</para></tip>

</listitem>
</varlistentry>

<varlistentry>
<term><menuchoice><guimenu>Collection</guimenu></menuchoice></term>
<listitem>
<screenshot>
<screeninfo>Collection Screenshot</screeninfo>
<mediaobject>
<imageobject><imagedata fileref="collection.png" format="PNG"/></imageobject>
<textobject><phrase>Screenshot</phrase></textobject>
</mediaobject>
</screenshot>

<para>The Collection panel allows you to view your collection in a tree view. To add files to directories to your collection, select <menuchoice><guimenu>Actions</guimenu><guimenuitem>Configure Folders</guimenuitem></menuchoice>.</para>

<para>The tree view can be organized by Primary and Secondary branches. The available branch types include Album, Artist, Genre, and Year. You can also search the view using the <guimenuitem>Search for:</guimenuitem> field.</para>

<note><para>If you use the <guimenuitem>Montor Changes</guimenuitem> option in <guimenuitem>Configure Folders</guimenuitem>you may notice that changes may not be updated instantly. This is because the normal behavior of the Collection browser is to update automatically every 30 seconds.</para></note>

</listitem>
</varlistentry>

<varlistentry>
<term><menuchoice><guimenu>Context</guimenu></menuchoice></term>
<listitem>
<screenshot>
<screeninfo>Context Screenshot</screeninfo>
<mediaobject>
<imageobject><imagedata fileref="context.png" format="PNG"/></imageobject>
<textobject><phrase>Screenshot</phrase></textobject>
</mediaobject>
</screenshot>

<para>The Context panel shows some useful information about your collection and the currently playing track's artist. At the top of the context browser you will find the <guimenu>Home</guimenu> and <guimenu>Current Track</guimenu> selections.</para>

<para>The <guimenu>Home</guimenu> selection contains two fields, they include:<guimenu>Your Favorite Tracks:</guimenu> and <guimenu>Newest Tracks:</guimenu>.</para>

<para>The <guimenu>Your Favorite Tracks:</guimenu> field displays the ten most played tracks in your playlist along with the number of times the track has been played. The <guimenu>Newest Tracks:</guimenu> field displays the ten newest additions to your playlist.</para>

<para>The <guimenu>Current Track</guimenu> selection contains  four fields, they include:<guimenu>Currently playing:</guimenu>, <guimenu>Favorite tracks by this artist:</guimenu>, <guimenu>Tracks on this album:</guimenu>, and <guimenu>Albums by this artist:</guimenu>.</para>

<para>The <guimenu>Currently playing:</guimenu> field provides a description and cover image (if available) of the album to which the current track belongs. The <guimenu>Favorite tracks by this artist:</guimenu> field lists the five most played tracks from the artist of the current track. The <guimenu>Tracks on this album:</guimenu> field lists all the available tracks from the same album as the current track.The <guimenu>Albums by this artist:</guimenu> field shows all the other albums in your collection that are by the same artist.</para>

<tip><para>To display album cover images in the context browser you must have the album cover image in the same directory as the track you are listening to. Supported file formats are .jpg, .jpeg, .gif, and .png. The images can be named anything, but images with the word <quote>front</quote> in the filename will be used with preference.</para></tip>

</listitem>
</varlistentry>

<varlistentry>
<term><menuchoice><guimenu>Streams</guimenu></menuchoice></term>
<listitem>
<screenshot>
<screeninfo>Streams Screenshot</screeninfo>
<mediaobject>
<imageobject><imagedata fileref="streams.png" format="PNG"/></imageobject>
<textobject><phrase>Screenshot</phrase></textobject>
</mediaobject>
</screenshot>

<para>The Streams panel allows you to tune into the streaming audio server of your choice.</para>

</listitem>
</varlistentry>

<varlistentry>
<term><menuchoice><guimenu>Welcome</guimenu></menuchoice></term>
<listitem>
<screenshot>
<screeninfo>Welcome Screenshot</screeninfo>
<mediaobject>
<imageobject><imagedata fileref="welcome.png" format="PNG"/></imageobject>
<textobject><phrase>Screenshot</phrase></textobject>
</mediaobject>
</screenshot>

<para>The Welcome panel serves as a quick reference to &amarok;. This panel is intended to help first time users with some of the basic and most used features of &amarok;. The panel covers customizing and using &amarok;.</para>

<tip><para>For advanced &amarok; users this panel has a link at the bottom for removing the panel from the sidebar.</para></tip>
</listitem>
</varlistentry>

</variablelist>
</sect2>

<sect2>
<title>The Playlist</title>
<screenshot>
<screeninfo>Playlist Screenshot</screeninfo>
<mediaobject>
<imageobject><imagedata fileref="play_list.png" format="PNG"/></imageobject>
<textobject><phrase>Screenshot</phrase></textobject>
</mediaobject>
</screenshot>

<para>The Playlist holds all the tracks you've enqueued for playing. You can
change the sequence by dragging items around with the mouse, and dropping
them in the desired position. Above the Playlist you see a text input field,
where you can enter a filter string. As soon as you enter a letter there,
the Playlist will be redisplayed, showing only entries containing the
entered characters. To stop the filtering, simply press
<keycap>Backspace</keycap>, until the filter is empty.</para>
</sect2>

<sect2>
<title>The Buttons</title>
<screenshot>
<screeninfo>Buttons Screenshot</screeninfo>
<mediaobject>
<imageobject><imagedata fileref="buttons.png" format="PNG"/></imageobject>
<textobject><phrase>Screenshot</phrase></textobject>
</mediaobject>
</screenshot>

<para>At the bottom of the window you see multiple buttons for controlling the
playlist and player.</para>

<para>The first group of buttons are for controlling the playlist. These buttons allow you to <guibutton>Add Media</guibutton>, <guibutton>Save Playlist</guibutton>, <guibutton>Clear Playlist</guibutton>, <guibutton>Shuffle Playlist</guibutton>, and <guibutton>Goto Current</guibutton> track. The <guibutton>Goto Current</guibutton> button is hidden by default and can be added by using the &RMB; menu and selecting <guibutton>Configure Toolbars</guibutton>. The <guibutton>Goto Current</guibutton> button is handy for jumping to the current track in long playlists where it is easy to get lost.</para> 

<para>The second group of buttons allow you to <guibutton>Undo</guibutton> and <guibutton>Redo</guibutton> any changes made to the Playlist.</para>

<para>The third group of buttons allow you to control the Player. These buttons include <guibutton>Previous Track</guibutton>, <guibutton>Play</guibutton>, <guibutton>Pause</guibutton>, <guibutton>Stop</guibutton>, and <guibutton>Next Track</guibutton>. There is also a mini volume slider and a <guibutton>Menu</guibutton> button which brings up the same menu as the Right Mouse Button Menu in the player.</para>
</sect2>

<sect2>
<title>The Status Bar</title>
<screenshot>
<screeninfo>Status Bar Screenshot</screeninfo>
<mediaobject>
<imageobject><imagedata fileref="status_bar.png" format="PNG"/></imageobject>
<textobject><phrase>Screenshot</phrase></textobject>
</mediaobject>
</screenshot>

<para>The Status Bar gives you some useful information about the player. The Status Bar shows the currently playing track, number of tracks in the playlist, <guimenuitem>Random</guimenuitem> and <guimenuitem>Repeat Track</guimenuitem> status, and elapsed track time. You can enable <guimenuitem>Random</guimenuitem> and <guimenuitem>Repeat Track</guimenuitem> in the status bar by double clicking there respective areas in the Status bar. The Status bar also features a mini slider for the track position.</para>
</sect2>
</sect1>
</chapter>

<chapter id="visualizations">
<title>The Visualizations</title>

<para>&amarok; supports the xmms visualization plugins. You can activate your installed xmms plugins via the Player window &RMB; menu. Selecting <guimenuitem>Visualizations</guimenuitem> from the &RMB; menu opens a new window listing your installed xmms plugins.</para>

<sect1 id="visualizations_window">
<title>The Visualizations Window</title>

<screenshot>
<screeninfo>Visualizations Window Screenshot</screeninfo>
<mediaobject>
<imageobject><imagedata fileref="vis_window.png" format="PNG"/></imageobject>
<textobject><phrase>Screenshot</phrase></textobject>
</mediaobject>
</screenshot>

<para>The Visualizations window allows you to choose which plugins you want to use. Select the appropriate check box to enable the plugin you wish to use.</para>
</sect1>
</chapter>

<chapter id="advanced_features">
<title>Advanced amaroK features</title>

<sect1 id="keybd_shortcuts">
<title>Keyboard Shortcuts</title>

<para>&amarok; uses keyboard shortcuts like most other applications, below is a listing of those shortcuts and there respective actions. The global shortcuts can be configured by right clicking the Player window and selecting <guimenuitem>Configure Global Shortcuts...</guimenuitem></para>

<tip><para>You can assign you multimedia keys to work as &amarok; shortcuts making your keyboard an &amarok; control center.</para></tip>

<para>The global shortcuts are:</para>

<variablelist>
<varlistentry>
<term><option>Play</option></term>
<listitem><para><keycombo><keycap>Win</keycap><keycap>x</keycap></keycombo></para></listitem>
</varlistentry>

<varlistentry>
<term><option>Pause</option></term>
<listitem><para><keycombo><keycap>Win</keycap><keycap>c</keycap></keycombo></para></listitem>
</varlistentry>

<varlistentry>
<term><option>Stop</option></term>
<listitem><para><keycombo><keycap>Win</keycap><keycap>v</keycap></keycombo></para></listitem>
</varlistentry>

<varlistentry>
<term><option>Next Track</option></term>
<listitem><para><keycombo><keycap>Win</keycap><keycap>b</keycap></keycombo></para></listitem>
</varlistentry>

<varlistentry>
<term><option>Previous Track</option></term>
<listitem><para><keycombo><keycap>Win</keycap><keycap>z</keycap></keycombo></para></listitem>
</varlistentry>

<varlistentry>
<term><option>Increase Volume</option></term>
<listitem><para><keycombo><keycap>Win</keycap><keycap>KP_Add</keycap></keycombo></para></listitem>
</varlistentry>

<varlistentry>
<term><option>Decrease Volume</option></term>
<listitem><para><keycombo><keycap>Win</keycap><keycap>KP_Subtract</keycap></keycombo></para></listitem>
</varlistentry>

<varlistentry>
<term><option>Add Media</option></term>
<listitem><para><keycombo><keycap>Win</keycap><keycap>a</keycap></keycombo></para></listitem>
</varlistentry>

<varlistentry>
<term><option>Toggle the Playlist Window</option></term>
<listitem><para><keycombo><keycap>Win</keycap><keycap>p</keycap></keycombo></para></listitem>
</varlistentry>

<varlistentry>
<term><option>Show the OSD</option></term>
<listitem><para><keycombo><keycap>Win</keycap><keycap>o</keycap></keycombo></para></listitem>
</varlistentry>
</variablelist>
</sect1>

<sect1 id="the_dcop_interface">
<title>The DCOP Interface</title>


<para>The amaroK DCOP interface provides you with an easy way to control amaroK with your own custom scripts.</para>

<para>The DCOP interface for amaroK has many generic functions that may be found in other KDE applications. This section is intended to describe the DCOP functions of the player. An example of the <quote>pause</quote> dcop function would look like:</para>

<para><prompt>&percnt;</prompt>dcop amarok player pause <command></command></para> 

<variablelist>

<varlistentry>
<term><option>isPlaying</option></term>
<listitem><para>The <quote>isPlaying</quote> function returns a value of true or false to indicate if the player is playing or not.</para></listitem> 
</varlistentry>

<varlistentry>
<term><option>trackCurrentTime</option></term>
<listitem><para>The <quote>trackCurrentTime</quote> function returns a value of the current elapsed track time in seconds.</para></listitem> 
</varlistentry>

<varlistentry>
<term><option>trackTotalTime</option></term>
<listitem><para>The <quote>trackTotalTime</quote> function returns a value of the current track's total time in seconds.</para></listitem> 
</varlistentry>

<varlistentry>
<term><option>addMedia</option></term>
<listitem><para>The <quote>addMedia</quote> function is used to add single files to the playlist.</para></listitem>  
</varlistentry>

<varlistentry>
<term><option>addMediaList</option></term>
<listitem><para>The <quote>addMediaList</quote> function is used to add multiple files to the playlist.</para></listitem>
</varlistentry>

<varlistentry>
<term><option>enableOSD</option></term>
<listitem><para>The <quote>enableOSD</quote> function allows you to toggle the On-Screen-Display with a true or false value.</para></listitem>
</varlistentry>

<varlistentry>
<term><option>next</option></term>
<listitem><para>The <quote>next</quote> function advances the player one track.</para></listitem>
</varlistentry>

<varlistentry>
<term><option>pause</option></term> 
<listitem><para>The <quote>pause</quote> function pauses the currently playing track.</para></listitem>
</varlistentry>

<varlistentry>
<term><option>play</option></term> 
<listitem><para>The <quote>play</quote> function starts the player from where it was last stopped.</para></listitem>
</varlistentry>

<varlistentry>
<term><option>playPause</option></term> 
<listitem><para>The <quote>playPause</quote> function starts the player if it is currently stopped or paused. This function also pauses the player if it is currently playing a track.</para></listitem>
</varlistentry>

<varlistentry>
<term><option>prev</option></term> 
<listitem><para>The <quote>prev</quote> function moves the player back one track.</para></listitem>
</varlistentry>

<varlistentry>
<term><option>seek</option></term>
<listitem><para>The <quote>seek</quote> function is used to seek through a track by a value specified in seconds.</para></listitem>
</varlistentry>

<varlistentry>
<term><option>setVolume</option></term>
<listitem><para>The <quote>setVolume</quote> function adjusts the volume to a level specified by a value of 0-100.</para></listitem>
</varlistentry>

<varlistentry>
<term><option>stop</option></term> 
<listitem><para>The <quote>stop</quote> function will stop the player if it is currently playing.</para></listitem>
</varlistentry>

<varlistentry>
<term><option>volumeDown</option></term> 
<listitem><para>The <quote>volumeDown</quote> function adjusts the volume down one step.</para></listitem>
</varlistentry>

<varlistentry>
<term><option>volumeUp</option></term> 
<listitem><para>The <quote>volumeUp</quote> function adjusts the volume up one step.</para></listitem>
</varlistentry>

<varlistentry>
<term><option>nowPlaying</option></term>
<listitem><para>The <quote>nowPlaying</quote> function shows "Artist - Title" of the currently playing track. If one of both id3 tags is empty, only "Artist" or "Title" is shown (without the "-").</para></listitem>
</varlistentry>

<varlistentry>
<term><option>artist</option></term>
<listitem><para>The <quote>Artist</quote> function shows the artist of the currently playing track. </para></listitem>
</varlistentry>

<varlistentry>
<term><option>album</option></term>
<listitem><para>The <quote>Album</quote> function shows the album of the currently playing track. </para></listitem>
</varlistentry>

<varlistentry>
<term><option>title</option></term>
<listitem><para>The <quote>Title</quote> function shows the title of the currently playing track. </para></listitem>
</varlistentry>

<varlistentry>
<term><option>genre</option></term>
<listitem><para>The <quote>Genre</quote> function shows the genre of the currently playing track. </para></listitem>
</varlistentry>

<varlistentry>
<term><option>bitrate</option></term>
<listitem><para>The <quote>Bitrate</quote> function shows the bitrate of the currently playing track. </para></listitem>
</varlistentry>

<varlistentry>
<term><option>comment</option></term>
<listitem><para>The <quote>Comment</quote> function shows the comment of the currently playing track. </para></listitem>
</varlistentry>

<varlistentry>
<term><option>totalTime</option></term>
<listitem><para>The <quote>TotalTime</quote> function shows the total time (mm:ss) of the currently playing track. </para></listitem>
</varlistentry>

<varlistentry>
<term><option>trackTotalTime</option></term>
<listitem><para>The <quote>trackTotalTime</quote> function shows the total time (in seconds) of the currently playing
track. </para></listitem>
</varlistentry>

<varlistentry>
<term><option>currentTime</option></term>
<listitem><para>The <quote>CurrentTime</quote> function shows the position (mm:ss) of the currently playing track. </para></listitem>
</varlistentry>

<varlistentry>
<term><option>trackCurrentTime</option></term>
<listitem><para>The <quote>trackCurrentTime</quote> function shows the position (in seconds) of the currently playing track. </para></listitem>
</varlistentry>

<varlistentry>
<term><option>year</option></term>
<listitem><para>The <quote>Year</quote> function shows the year of the currently playing track. </para></listitem>
</varlistentry>
</variablelist>
</sect1>

<sect1 id="cmd_line_options">
<title>Command-line Options</title>

<para>amaroK supports the use of the standard Qt and kde command line options. amaroK also has it's own application specific options.</para>

<para>The Qt and kde options:</para>

<variablelist>
<varlistentry>
<term><option>--help</option></term>
<listitem><para>Show help about options</para></listitem>
</varlistentry>

<varlistentry>
<term><option>--help-qt</option></term>                 
<listitem><para>Show Qt specific options</para></listitem>
</varlistentry>

<varlistentry>
<term><option>--help-kde</option></term>                
<listitem><para>Show KDE specific options</para></listitem>
</varlistentry>

<varlistentry>
<term><option>--help-all</option></term>                
<listitem><para>Show all options</para></listitem>
</varlistentry>

<varlistentry>
<term><option>--author</option></term>                  
<listitem><para>Show author information</para></listitem>
</varlistentry>

<varlistentry>
<term><option>-v, --version</option></term>             
<listitem><para>Show version information</para></listitem>
</varlistentry>

<varlistentry>
<term><option>--license</option></term>                 
<listitem><para>Show license information</para></listitem>
</varlistentry>
</variablelist>


<para>The amaroK options:</para>

<note><para>The &amarok; options are designed to be used while &amarok; is running.</para></note>

<variablelist>
<varlistentry>
<term><option>-r, --previous</option></term>           
<listitem><para>Skip to the previous track in the playlist</para></listitem>
</varlistentry>

<varlistentry>
<term><option>-p, --play</option></term>                
<listitem><para>Start playing current playlist</para></listitem>
</varlistentry>

<varlistentry>
<term><option>-s, --stop</option></term>                
<listitem><para>Stop playback</para></listitem>
</varlistentry>

<varlistentry>
<term><option>--pause</option></term>                   
<listitem><para>Pause playback</para></listitem>
</varlistentry>

<varlistentry>
<term><option>-f, --next</option></term>                
<listitem><para>Skip to the next track in the playlist</para></listitem>
</varlistentry>

<varlistentry>
<term><option>-e, --enqueue</option></term>             
<listitem><para>Enqueue Files/URLs into the playlist</para></listitem>
</varlistentry>

</variablelist>
</sect1>
</chapter>

<chapter id="requirements">
<title>Requirements</title>

<para>&amarok; requires the installation of some software packages. The required packages are listed below along with several other packages to enhance your &amarok; experience.</para>

<itemizedlist>
<title>Required:</title>
<listitem><para>KDELIBS 3.2 <ulink url="http://www.kde.org"></ulink></para></listitem>
    
<listitem><para>TagLib 1.0 <ulink url="http://freshmeat.net/projects/taglib"></ulink></para></listitem>
</itemizedlist>

<itemizedlist>
<title>Recommended:</title>
<listitem><para>aRts 1.2 <ulink url="http://www.kde.org"></ulink></para></listitem>
<listitem><para>KDEMULTIMEDIA 3.2 <ulink url="http://www.kde.org"></ulink></para></listitem>

<listitem><para>OpenGL accelerated X-Server</para></listitem>
</itemizedlist>

<itemizedlist>     
<title>Optional:</title>
<listitem><para>GStreamer-0.8.1 and Gst-Plugins-0.8.1 <ulink url="http://gstreamer.net"></ulink></para></listitem>
    
<listitem><para>NMM 0.4.4 <ulink url="http://www.networkmultimedia.org"></ulink></para></listitem>

<listitem><para>XMMS 1.2 and XMMS visualization plugins <ulink url="http://xmms.org"></ulink></para></listitem>
</itemizedlist>

</chapter>



<chapter id="developers">
<title>Developer's Guide to &amarok;</title>

<para>If you are interested in helping with &amarok; development, by
contributing code, graphics, documentation or anything else, please don't
hesitate and write to <email>amarok-devel@lists.sourceforge.net</email>, or visit us on IRC,
channel: #amarok, network: irc.freenode.net.</para>

<para>You can also subscribe to our mailing list 
<ulink url="http://lists.sourceforge.net/lists/listinfo/amarok-devel"></ulink>
 and watch the progress while adding some worthy comments :)</para>

<para>Your contribution or feedback will be more than welcome. Looking
forward to talking to you :)</para>

<sect1 id="source_file_list">
<title>The &amarok; source files.</title>

<para>The files are listed in alphabetical order, which is not useful for priority ordering. The important files are app.cpp, playlist.cpp and playerwindow.cpp.</para>

<variablelist>

<varlistentry>
<term><option>actionclasses.cpp</option></term>
<listitem><para>Provides a QPopupMenu which lists &amarok; configuration options, quit and provides a KHelpMenu for &amarok; to save instantiating many helpmenus.</para></listitem> 
</varlistentry>

<varlistentry>
<term><option>amarokconfig.cpp</option></term>
<listitem><para>KConfig-XT</para></listitem> 
</varlistentry>

<varlistentry>
<term><option>amarokfilelist.cpp</option></term>
<listitem><para>Not currently used. Will sort KFileLists.</para></listitem> 
</varlistentry>

<varlistentry>
<term><option>amaroknavbutton.cpp</option></term>
<listitem><para>Not currently used. Candidate for removal.</para></listitem> 
</varlistentry>

<varlistentry>
<term><option>app.cpp</option></term>
<listitem><para>This is the kapplication derived class, it is parent to many objects that are fundamental to the running of &amarok;, eg engine, dcop, systray, top-level widgets, etc.</para></listitem> 
</varlistentry>

<varlistentry>
<term><option>browserbar.cpp</option></term>
<listitem><para>This handles the browsers, the KMultiTabBar widget and the custom splitter.</para></listitem> 
</varlistentry>

<varlistentry>
<term><option>browserwin.cpp</option></term>
<listitem><para>This is just a container widget for the playlist, toolbar and browserbar, eventually it may be even less.</para></listitem> 
</varlistentry>

<varlistentry>
<term><option>collectionbrowser.cpp</option></term>
<listitem><para>In construction, media library type thing.</para></listitem> 
</varlistentry>

<varlistentry>
<term><option>effectwidget.cpp</option></term>
<listitem><para>* insert description here *</para></listitem> 
</varlistentry>

<varlistentry>
<term><option>enginecontroller.cpp</option></term>
<listitem><para>Controls the current engine.</para></listitem> 
</varlistentry>

<varlistentry>
<term><option>fht.cpp</option></term>
<listitem><para>&amarok;'s sophisticated and flexible FHT (basically FFT) routine for spectrum analysis.</para></listitem> 
</varlistentry>

<varlistentry>
<term><option>filebrowser.cpp</option></term>
<listitem><para>The FileBrowser.</para></listitem> 
</varlistentry>

<varlistentry>
<term><option>kbookmarkhandler.cpp</option></term>
<listitem><para>Used by FileBrowser.</para></listitem> 
</varlistentry>

<varlistentry>
<term><option>osd.cpp</option></term>
<listitem><para>A very nice On-Screen Display class, not &amarok; specific, very flexible.</para></listitem> 
</varlistentry>

<varlistentry>
<term><option>playerwindow.cpp</option></term>
<listitem><para>This is the small widget with the scrolling text, analyzer and play/pause/etc. buttons.</para></listitem> 
</varlistentry>

<varlistentry>
<term><option>playlist.cpp</option></term>
<listitem><para>Big class that is the playlist widget.</para></listitem> 
</varlistentry>

<varlistentry>
<term><option>playlistbrowser.cpp</option></term>
<listitem><para>Likely to be superceded by CollectionBrowser.</para></listitem> 
</varlistentry>

<varlistentry>
<term><option>playlistitem.cpp</option></term>
<listitem><para>Derived from KListViewItem, playlist items.</para></listitem> 
</varlistentry>

<varlistentry>
<term><option>playlistloader.cpp</option></term>
<listitem><para>Will recursively load directories, KURLs and playlist files into the PlaylistWidget. Threaded to work in the background. Will ask engine to confirm whether it can play unknown filetypes.</para></listitem> 
</varlistentry>

<varlistentry>
<term><option>pluginmanager.cpp</option></term>
<listitem><para>Handles the &amarok; plugin system.</para></listitem> 
</varlistentry>

<varlistentry>
<term><option>sliderwidget.cpp</option></term>
<listitem><para>The custom Slider widget used by the PlayerWidget. Candidate for refactoring by deriving from QSlider.</para></listitem> 
</varlistentry>

<varlistentry>
<term><option>streambrowser.cpp</option></term>
<listitem><para>Widget that shows stream listings downloaded from metaservers.</para></listitem> 
</varlistentry>

<varlistentry>
<term><option>systray.cpp</option></term>
<listitem><para>&amarok;'s systray. Small, compact.</para></listitem> 
</varlistentry>

<varlistentry>
<term><option>threadweaver.cpp</option></term>
<listitem><para>flexible class that will queue, process, and dispatch results for <quote>Jobs</quote> in a separate thread. Used by a variety of &amarok; components.</para></listitem> 
</varlistentry>

<varlistentry>
<term><option>tracktooltip.cpp</option></term>
<listitem><para>Not actually related to the PlaylistWidget. Used by PlayerWidget to show some info on the currently playing track.</para></listitem> 
</varlistentry>

</variablelist>
</sect1>


</chapter>



<chapter id="faq">
<title>Questions and Answers</title>

<qandaset id="faqlist">

<qandaentry>
<question>
<para>Where can I get support for &amarok;?</para>
</question>
<answer>
<para>
You can talk to the developers and ask questions in our
<acronym>IRC</acronym> channel: #amarok. Network: irc.freenode.net. Looking
forward to meeting you there :)
</para>
</answer>
</qandaentry>

<qandaentry>
<question>
<para>When I start &amarok;, I see an empty playlist. How do I actually get
tracks in there?</para>
</question>
<answer>
<para>
Simple. Use the <quote>Filebrowser</quote> on the left side to navigate to
the desired directory.
Then drag the files into the <quote>Playlist</quote> part on the right.
</para>
</answer>
</qandaentry>

<qandaentry>
<question>
<para>How do I remove tracks from the Playlist?</para>
</question>
<answer>
<para>Select the files you want to remove, and press <keycap>Del</keycap> key on your keyboard. Or right-click
the selection and choose <guimenuitem>Remove Selected</guimenuitem> from pop up menu.</para>
</answer>
</qandaentry>

<qandaentry>
<question>
<para>How can I load a playlist?</para>
</question>
<answer>
<para>Just drag and drop the playlist file into the playlist, like you would do with any
other file. That simple!</para>
</answer>
</qandaentry>

<qandaentry>
<question>
<para>How can I save the current playlist?</para>
</question>
<answer>
<para>
The <guibutton>Save playlist</guibutton> button is next to <guibutton>Add Media</guibutton>
button in the playlist. Just click it!
</para>
</answer>
</qandaentry>

<qandaentry>
<question>
<para>Why can't amaroK play MP3s?</para>
</question>
<answer>
<para>
It can! Chances are you're using Fedora/RedHat linux, they don't ship with
MP3 decoders by default (due to patenting issues). Solution:
</para>
<para>
<keycombo>&Alt; <keycap>F2</keycap></keycombo>, gg:redhat mp3 kde, <keycap>ENTER</keycap>
</para>
</answer>
</qandaentry>

<qandaentry>
<question>
<para>
Can amaroK output directly to OSS/ALSA?
</para>
</question>
<answer>
<para>
Yes, but not yet. One reason we use aRts/GStreamer and NMM is for codecs.
To output directly to ALSA, etc. someone needs to write an amaroK engine
plugin that uses libmad and libvorbis to decode directly to alsa. And then
call it amaroK_ALSA_engine. :-)
</para>
</answer>
</qandaentry>

<qandaentry>
<question>
<para>
The sound stutters when my CPU usage is high, is there anything I can do to improve it?
</para>
</question>
<answer>

<para>You can either use the GStreamer engine (it's great!), or tweak aRts. Open <menuchoice><guimenu>Control Center</guimenu><guisubmenu>Sound and Multimedia</guisubmenu><guimenuitem>Sound System</guimenuitem></menuchoice>. Enable <guimenuitem>Run with highest possible priority</guimenuitem>, and increase the size of the <guimenuitem>Sound buffer:</guimenuitem> (warning, see the next FAQ!) You should also ensure that your artswrapper is suid:</para>

<para><prompt>&percnt;</prompt><command>su</command></para>
<para><prompt>&percnt;</prompt><command>chmod a+rsx /path/to/kde/bin/artswrapper</command></para>

<para>Finally you will benefit from installing kdemultimedia in its entirety to get the faster aRts codecs (eg. libarts_mpeglib.so, etc.)</para>

</answer>
</qandaentry>


<qandaentry>
<question>
<para>
The amaroK analyzers are really unresponsive!
</para>
</question>
<answer>
<para>
You are probably using the aRts engine, either use the GST or NMM engines, or
reduce the size of your aRts buffer in kcontrol, sound system. The lower the
buffer the more responsive the visuals. Yes this is a bug! Please help us fix
it!
</para>
</answer>
</qandaentry>

<qandaentry>
<question>
<para>
There are no visualizations in the visualizations dialog.
</para>
</question>
<answer>
<para>
You probably don't have xmms-config installed, reconfigure and build after
installing the appropriate xmms-devel package.
</para>
</answer>
</qandaentry>

<qandaentry>
<question>
<para>
How do I get a cvs version of &amarok;?
</para>
</question>
<answer>
<para>Here is a little tutorial by Christian Muehlhaeuser.</para>

<para>Create some new dir on your hdd, like "kde-cvs":</para> 
<para><prompt>&percnt;</prompt><command>mkdir kde-cvs</command></para>
<para><prompt>&percnt;</prompt><command>cd kde-cvs </command></para>
 
<para>We put all the source-stuff in here, let's grab them:</para> 
<para><prompt>&percnt;</prompt><command>export CVSROOT=":pserver:anonymous@anoncvs.kde.org:/home/kde"</command> </para>
<para><prompt>&percnt;</prompt><command>cvs -z4 co kde-common/admin</command></para> 
<para><prompt>&percnt;</prompt><command>cvs -z4 co -l kdeextragear-1</command></para> 
<para><prompt>&percnt;</prompt><command>cvs -z4 co kdeextragear-1/amarok</command></para> 
<para><prompt>&percnt;</prompt><command>cd kdeextragear-1</command></para> 
<para><prompt>&percnt;</prompt><command>ln -s ../kde-common/admin</command></para> 
 
<para>Let's compile it!</para> 
<para><prompt>&percnt;</prompt><command>make -f Makefile.cvs</command></para> 
<para><prompt>&percnt;</prompt><command>./configure --prefix=`kde-config --prefix`</command></para> 
<para><prompt>&percnt;</prompt><command>make</command></para>
<para><prompt>&percnt;</prompt><command>su -c make install</command></para>
 
<para>Have fun!</para>
</answer>
</qandaentry>

<qandaentry>
<question>
<para>
I've found a bug / I've got a great idea for amaroK!
</para>
</question>
<answer>
<para>
Please report it at <ulink url="http://bugs.kde.org"></ulink>.
</para>
</answer>
</qandaentry>

<qandaentry>
<question>
<para>
Do you accept patches?
</para>
</question>
<answer>
<para>
Happily! Your best course of action is to let us know what you plan to do before
you do any work so we can discuss it, but don't fret we haven't turned down a
patch yet! Discussion is mostly to help you patch the correct bits of amaroK.
Then either submit a patch to the mailing list, or commit if you have cvs access.
However, please let us know before you commit new features to cvs! If you have a bug
fix then just go ahead, this is open source after all :)
</para>
</answer>
</qandaentry>
   
<qandaentry>
<question>
<para>Why did you choose  the name &amarok;? </para>
</question>
<answer>
<para>
&amarok; is an album by British composer Mike Oldfield. I happen to
like it a lot, and I think the name's got a nice sound. Plus, of course, it
contains the all important <quote>K</quote>.. :)
</para>
</answer>
</qandaentry>

<qandaentry>
<question>
<para>I have GStreamer installed but when I try to change to the GStreamer engine &amarok; crashes, what gives? </para>
</question>
<answer>
<para>
After installing GStreamer you have register it's components, running 'su -c gst-register' should take care of registering your GStreamer components. 
</para>
</answer>
</qandaentry>

</qandaset>
</chapter>

<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>sleep? there's no time!</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>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>
</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>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>Melchior Franz (new FFT routine, bugfixes)
<email>mfranz@kde.org</email></para>
</listitem>
<listitem><para>Scott Wheeler (TagLib)
<email>wheeler@kde.org</email></para>
</listitem>
<listitem><para>Stefan Bogner (tester, patches, translation)
<email>bochi@online.ms</email></para>
</listitem>
<listitem><para>Whitehawk Stormchaser (tester, patches)
<email>zerokode@gmx.net</email></para>
</listitem>
</itemizedlist>

<para>Documentation copyright 2003 Mark
Kretschmann<email>markey@web.de</email>	and 2004 Mike Diehl <email>madpenguin8@yahoo.com</email></para>

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

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

</chapter>

<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>

<para>For a much faster compile we recommend configuring with --enable-final:</para>

<para><command>./configure --enable-final --prefix=`kde-config --prefix`</command></para>


<para>However it is probably not advisable to compile --enable-final if your computer
resorts to swap easily.</para>

<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>
</sect1>

</appendix>

&documentation.index;
</book>

<!--
Local Variables:
mode: sgml
sgml-minimize-attributes:nil
sgml-general-insert-case:lower
sgml-indent-step:0
sgml-indent-data:nil
End:

vim:tabstop=2:shiftwidth=2:expandtab
-->

