source: archive/amarok.xml@ c339779

<?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 "&kde-download-http;amarok/&amarok-version;/src/amarok-&amarok-version;.tar.bz2">
  <!ENTITY amarok-download-ftp  "&kde-download-ftp;amarok/&amarok-version;/src/amarok-&amarok-version;.tar.bz2">
  <!ENTITY amarok-md5sum        "53cfcb4819668b10e13b061478c7b32a">
  <!ENTITY amarok-size          "38.1 MB">
  <!ENTITY amarok-buildsize     "223 MB">
  <!ENTITY amarok-time          "9.2 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 a powerful audio player for
      the KDE environment. Features include a context browser, integration
      with many online music  services and support for management of
      several digital music players including Apple's iPod.
    </para>

    &lfs79_checked;

    <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="mariadb"/> or <ulink url="http://www.mysql.com/">MySQL</ulink>, and
      <xref linkend="taglib"/>
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="libkcompactdisk"/> and
      <xref linkend="audiocd-kio"/> (for CD-ROM accesa and control) and
      <xref linkend="ffmpeg"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="curl"/> (for MP3tunes integration),
      <xref linkend="libxml2"/> (for MP3tunes integration),
      <xref linkend="openssl"/> (for MP3tunes integration),
      <xref linkend="qjson"/>,
      <ulink url="&kde-download-http;&kde-version;/src/">nepomuk-core</ulink>,
      <ulink url="http://kollide.net/~jefferai/">Taglib-extras</ulink>,
      <ulink url="http://code.google.com/p/clamz/">Clamz</ulink> (For Amazon integration),
      <ulink url="http://www.gtkpod.org/libgpod.html">libgpod</ulink> (for iPod support),
      <ulink url="https://github.com/lastfm/liblastfm">liblastfm</ulink> (for Last.fm integration),
      <ulink url="http://libmtp.sourceforge.net/">libmtp</ulink> (for MTP device support),
      <ulink url="http://wiki.gpodder.org/wiki/Libmygpo-qt">libmygpo-qt</ulink> (for gpodder.net podcast support),
      <ulink url="http://code.google.com/p/musicip-libofa">libofa</ulink> (for MusicDNS support),
      <ulink url="&gnome-download-http;/loudmouth">Loudmouth</ulink> (for MP3tunes integration),
      <ulink url="http://code.google.com/p/qtscriptgenerator/">qtscript-qt</ulink>, and
      <ulink url="http://code.google.com/p/googlemock/">Google Mock</ulink> (for tests)
    </para>

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

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

    <note><para>Amarok depends strongly on $KDE_PREFIX.  If a new version of
    KDE is installed in a different location (for instance installing kde in a
    versioned directory of /opt), then this package will need to be
    reinstalled.</para></note>

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

<screen><userinput>sed -i '/set.TAGLIB_MIN_VERSION/s/7/10/' CMakeLists.txt &amp;&amp;

mkdir build &amp;&amp;
cd    build &amp;&amp;

cmake -DCMAKE_INSTALL_PREFIX=&kde-dir; \
      -DCMAKE_BUILD_TYPE=Release         \
      -DKDE4_BUILD_TESTS=OFF             \
      -Wno-dev .. &amp;&amp;
make</userinput></screen>

    <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>
      <command>sed ... CMakeLists.txt</command>: Change the minimum
      requirement for taglib to allow it to be found.
    </para>

    <para>
      <option>-DKDE4_BUILD_TESTS=OFF</option>: This switch disables the
      integrated tests. The test suite requires Google Mock.
    </para>

  </sect2>

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

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

      <seglistitem>
        <seg>
          amarok, amarok_afttagger, amarokcollectionscanner,
          amarokpkg, and amzdownloader
        </seg>
        <seg>
          libamarokcore.so, libamaroklib.so, libamarokocsclient.so, libamarokpud.so,
          libamarok_service_lastfm_shared.so, libamarok-sqlcollection.so,
          libamarok-transcoding.so, libampache_account_login.so, and several
          libraries in &kde-dir;/lib/kde4
        </seg>
        <seg>
          several in &kde-dir;/share
        </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 powerful music player and organizer built on top of
            KDE development platform.
          </para>
          <indexterm zone="amarok amarok-prog">
            <primary sortas="b-amarok">amarok</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>