source: multimedia/audioutils/amarok.xml@ b12cddd

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

  <!ENTITY amarok-download-http "http://mirrors.isc.org/pub/kde/stable/amarok/1.4.8/src/amarok-1.4.8.tar.bz2">
  <!ENTITY amarok-download-ftp  "ftp://ftp.kde.org/pub/kde/stable/amarok/1.4.8/src/amarok-1.4.8.tar.bz2">
  <!ENTITY amarok-md5sum        "7f65c4a8f3f0ff9042a5b5dd21b36cc8">
  <!ENTITY amarok-size          "13 MB">
  <!ENTITY amarok-buildsize     "129 MB">
  <!ENTITY amarok-time          "3.6 SBU">
]>

<sect1 id="amarok" xreflabel="amarok-&amarok-version;">
  <?dbhtml filename="amarok.html"?>

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
  </sect1info>

  <title>Amarok-&amarok-version;</title>

  <indexterm zone="amarok">
    <primary sortas="a-Amarok">Amarok</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to Amarok</title>

    <para><application>Amarok</application> is an audio player for KDE.
    Features include a context browser, Magnatunes and last.fm integration,
    support for multimedia devices, and scripting through Ruby.</para>

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>Download (HTTP): <ulink url="&amarok-download-http;"/></para>
      </listitem>
      <listitem>
        <para>Download (FTP): <ulink url="&amarok-download-ftp;"/></para>
      </listitem>
      <listitem>
        <para>Download MD5 sum: &amarok-md5sum;</para>
      </listitem>
      <listitem>
        <para>Download size: &amarok-size;</para>
      </listitem>
      <listitem>
        <para>Estimated disk space required: &amarok-buildsize;</para>
      </listitem>
      <listitem>
        <para>Estimated build time: &amarok-time;</para>
      </listitem>
    </itemizedlist>

    <bridgehead renderas="sect3">amarok Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required"><xref linkend="kdelibs"/>, 
    <xref linkend="ruby"/>, and
    <ulink url="http://developer.kde.org/~wheeler/taglib/">TagLib</ulink></para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended"><xref linkend="kdebase"/>, and
    <xref linkend="xine-lib"/></para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional"><xref linkend="kdemultimedia"/> (for cd-ripping support),
    <xref linkend="k3b"/> (for cd-burning support),
    <xref linkend="sdl"/>,
    <ulink url="http://sqlite.org/">SQLite</ulink>, 
    <xref linkend="postgresql"/>,
    <xref linkend="mysql"/>,
    <ulink url="https://helixcommunity.org/">Helix</ulink> (untested media backend, alternative to xine),
    <xref linkend="faad2"/> or <ulink url="http://mpeg4ip.sourceforge.net/">mpeg4ip</ulink>,
    <ulink url="http://sourceforge.net/projects/libvisual/">libvisual</ulink>,
    <ulink url="http://www.musicbrainz.org/products/tunepimp/download.html">TunePimp</ulink>,
    <ulink url="http://www.gtkpod.org/libgpod.html">libgpod</ulink>,
    <ulink url="http://ifp-driver.sourceforge.net/libifp/">libifp</ulink>,
    <ulink url="http://libnjb.sourceforge.net/">libnjp</ulink>,
    <ulink url="http://libmtp.sourceforge.net/">libmtp</ulink>,
    <ulink url="http://linux-karma.sourceforge.net/">libkarma</ulink> (requires
    <ulink url="http://linux-karma.sourceforge.net/">omfs</ulink>)</para>

    <para condition="html" role="usernotes">User Notes:
    <ulink url="&blfs-wiki;/amarok"/></para>

  </sect2>

  <sect2 role="installation">
    <title>Installation of amarok</title>

    <para>Install <application>Amarok</application> by running the following
    commands:</para>

<screen><userinput>./configure --prefix=$(kde-config --prefix) \
            --sysconfdir=/etc/kde \
            --disable-debug \
            --disable-dependency-tracking &amp;&amp;
make</userinput></screen>

    <para>This package does not come with a test suite.</para>

    <para>Now, as the <systemitem class="username">root</systemitem> user:</para>

<screen role="root"><userinput>make install</userinput></screen>

  </sect2>

  <sect2 role="commands">
    <title>Command Explanations</title>

    <para><parameter>--prefix=$(kde-config --prefix)</parameter>: This
    parameter uses <command>kde-config</command> to establish the prefix of
    the existing KDE installation and then sets the installation prefix for
    <application>Amarok</application> to the same value.</para>

    <para><parameter>--disable-debug</parameter>: This option causes the package
    to be compiled without debugging code.</para>

    <para><parameter>--disable-dependency-tracking</parameter>: This option
    speeds up one time builds.</para>

    <para><parameter>--without-included-sqlite</parameter>: This option forces
    the use of a system-installed copy of sqlite.</para>

    <para><parameter>--enable-mysql</parameter>: This option enables use of a 
    MySQL database for music collections.</para>

    <para><parameter>--enable-postresql</parameter>: This option enables use of a
    PostgreSQL database for music collections.</para>

    <para>Support for other optional dependencies may require passing options 
    to the <command>configure</command> script. Refer to the output from
    <command>./configure --help</command> for additional information.</para>

  </sect2>

  <sect2 role="content">
    <title>Contents</title>

    <segmentedlist>
      <segtitle>Installed Programs</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>amarok, amarokapp, amarokcollectionscanner, 
        amarok_daapserver.rb, and amarok_proxy.rb</seg>
        <seg>libamarok.so, and several modules 
        for installed dependencies</seg>
        <seg><envar>$KDE_PREFIX</envar>/share/apps/amarok and 
        <envar>$KDE_PREFIX</envar>/share/doc/HTML/*/amarok</seg>
      </seglistitem>
    </segmentedlist>

    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

      <varlistentry id="amarok-prog">
        <term><command>amarok</command></term>
        <listitem>
          <para>is a wrapper for amarokapp to speed up
          command line argument passing</para>
          <indexterm zone="amarok amarok-prog">
            <primary sortas="b-amarok">amarok</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="amarokapp">
        <term><command>amarokapp</command></term>
        <listitem>
          <para>is the amarok audio player</para>
          <indexterm zone="amarok amarokapp">
            <primary sortas="b-amarokapp">amarokapp</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="amarokcollectionscanner">
        <term><command>amarokcollectionscanner</command></term>
        <listitem>
          <para>is used to scan a directory structure and build a collection</para>
          <indexterm zone="amarokcollectionscanner">
            <primary sortas="b-amarokcollectionscanner">amarokcollectionscanner</primary>
          </indexterm>
        </listitem>
      </varlistentry>
      
      <varlistentry id="amarok_daapserver.rb">
        <term><command>amarok_daapserver.rb</command></term>
        <listitem>
          <para>is a DAAP server for Amarok</para>
          <indexterm zone="amarok amarok_daapserver.rb">
            <primary sortas="b-amarok_daapserver.rb">amarok_daapserver.rb</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="amarok_proxy.rb">
        <term><command>amarok_proxy.rb</command></term>
        <listitem>
          <para>is a proxy server for DAAP and Last.fm</para>
          <indexterm zone="amarok amarok_proxy.rb">
            <primary sortas="b-amarok_proxy.rb">amarok_proxy.rb</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>