source: kde/add/kdemultimedia.xml@ a5e8571

<?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 kdemultimedia-download-http "&kde-download-http;/kdemultimedia-&kde-version;.tar.bz2">
  <!ENTITY kdemultimedia-download-ftp  "&kde-download-ftp;/kdemultimedia-&kde-version;.tar.bz2">
  <!ENTITY kdemultimedia-md5sum        "fdfafe38d2c7e3019dafc80c177add15">
  <!ENTITY kdemultimedia-size          "6.1 MB">
  <!ENTITY kdemultimedia-buildsize     "125 MB (additional 1 MB for API docs)">
  <!ENTITY kdemultimedia-time          "9.8 SBU (additional 0.2 SBU for API docs)">

  <!ENTITY akode-version       "2.0.2">
  <!ENTITY akode-download-http "http://www.kde-apps.org/content/download.php?content=30375">
  <!ENTITY akode-download-ftp  " ">
  <!ENTITY akode-md5sum        "659ced0c9c735cb3e55b9138ff02342c">
  <!ENTITY akode-size          "462 KB">
  <!ENTITY akode-buildsize     "6.5 MB">
  <!ENTITY akode-time          "0.2 SBU">
]>

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

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

  <title>Kdemultimedia-&kde-version;</title>

  <indexterm zone="kdemultimedia">
    <primary sortas="a-kdemultimedia">Kdemultimedia</primary>
  </indexterm>

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

    <para><application>Kdemultimedia</application> provides several
    <application>KDE</application> programs to work with sound.  Programs
    include applications for a Jukebox, a soundcard mixer, a midi and karaoke
    player, and a recording application for
    <application>aRts</application>.</para>

    <para>In this version of <application>Kdemultimedia</application>, some
    of the functionality provided by the package has been moved off into a
    separate project named <application>Akode</application>. In order for
    <application>Kdemultimedia</application> to provide the removed
    functionality, you must install the <application>Akode</application>
    package first. Instructions to install <application>Akode</application>
    follow. If you wish to skip the <application>Akode</application>
    installation, go straight to the
    <xref linkend="kdemultimedia-instructions"/>.</para>

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

  </sect2>

  <sect2 role="package" id="akode" xreflabel="Akode-&akode-version;">
    <title>Akode-&akode-version;</title>

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

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

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional"><xref linkend="pkgconfig"/>,
    <xref linkend="flac"/>,
    <xref linkend="speex"/>,
    <xref linkend="libmad"/>,
    <xref linkend="alsa"/>,
    <xref linkend="libvorbis"/>,
    <ulink url="http://www.mega-nerd.com/libsamplerate/">Secret Rabbit
    Code</ulink> (a.k.a. libsamplerate),
    <ulink url="http://pulseaudio.org/">PulseAudio</ulink>,
    <ulink url="http://jackit.sourceforge.net/">JACK</ulink>, and
    <xref linkend="ffmpeg"/> (support is experimental)</para>

    <bridgehead renderas="sect3">Installation of Akode</bridgehead>

    <para>Install <application>Akode</application> by issuing the following
    commands:</para>

<screen><userinput>./configure --prefix=&kde-dir; --without-ffmpeg \
    --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>--without-ffmpeg</parameter>: This option disables the
    experimental <application>FFmpeg</application> support in
    <application>Akode</application>, as the build fails if it is enabled.
    A patch that allows the build to complete with
    <application>FFmpeg</application> support can be found as an attachment at
    <ulink url="http://linuxfromscratch.org/pipermail/blfs-dev/2007-October/017837.html"/>.
    However, the functionality of <application>Akode</application> built with
    <application>FFmpeg</application> support has not been tested by the
    BLFS editors.</para>

  </sect2>

  <sect2 role="package" id="kdemultimedia-instructions"
         xreflabel="Kdemultimedia Instructions">
    <title>Resuming the Kdemultimedia Instructions</title>

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

<!--
    <bridgehead renderas="sect3">Additional Downloads</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>Required patch (if <application>libtunepimp</application>
        &gt;= 0.4.x is installed): <ulink
        url="&patch-root;/kdemultimedia-&kde-version;-libtunepimp_0.4.x-1.patch"/>
        </para>
      </listitem>
    </itemizedlist>
-->

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required"><xref linkend="kdebase"/></para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended"><xref linkend="libjpeg"/>,
    <xref linkend="libxml2"/>, and
    <xref linkend="alsa"/></para>
    <!-- <xref linkend="libmad"/> moved to Akode -->

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional"><xref linkend="akode"/>,
    <xref linkend="cdparanoia"/>,
    <xref linkend="lame"/>,
    <xref linkend="audiofile"/>,
    <xref linkend="libvorbis"/>,
    <xref linkend="xine-lib"/>,
    <xref linkend="flac"/> (built with <xref linkend="libogg"/> support),
    <xref linkend="gstreamer"/>,
    <ulink url="http://www.theora.org/">Theora</ulink>,
    <ulink url="http://developer.kde.org/~wheeler/taglib/">TagLib</ulink>,
    <ulink url="http://www.musicbrainz.org/products/tunepimp/download.html">TunePimp</ulink>
    (requires <xref linkend="libmusicbrainz"/>),
    <xref linkend="graphviz"/>, and
    <xref linkend="doxygen"/></para>
    <!-- moved to Akode
    <ulink url="http://0pointer.de/lennart/projects/polypaudio/">polypaudio</ulink>
    <ulink url="http://www.mega-nerd.com/libsamplerate/">Secret Rabbit Code</ulink>
    <ulink url="http://jackit.sourceforge.net/">JACK</ulink>
    <xref linkend="speex"/>, moved to Akode
    -->
    <!-- <xref linkend="sdl"/>, not used any longer -->
    <!-- <xref linkend="libogg"/>, no good without vorbis, so is redundant -->
    <!-- Uses internal copy now
    <ulink url="http://www.musicbrainz.org/products/trmgen/download.html">TRM Generator</ulink>
    -->

  </sect2>

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

    <para>Install <application>kdemultimedia</application> with:</para>

    <!-- <note>
      <para> The -\-sysconfdir parameter must be the same as command used in
      kdelibs.</para>
    </note> -->

<!--    <xi:include xmlns:xi="http://www.w3.org/2003/XInclude"
    href="../../xincludes/kde-sysconfdir.xml"/> -->

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

    <xi:include xmlns:xi="http://www.w3.org/2003/XInclude"
    href="../../xincludes/kde-apidocs.xml"/>

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

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

  </sect2>

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

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

      <seglistitem>
        <seg>artsbuilder, artscontrol, juk, kaboodle, kaudiocreator, kmid,
        kmix, kmixctrl, krec, kscd, midisend, mpeglibartsplay, noatun,
        workman2cddb.pl, yaf-cdda, yaf-mpgplay, yaf-splay, yaf-tplay,
        yaf-vorbis, and yaf-yuv</seg>
        <seg>Numerous kdemultimedia specific libraries</seg>
        <seg>The following subdirectories in $KDE_PREFIX: include/{libkcddb,
        mpeglib, noatun}, lib/mcop/Noatun, and
        share/apps/{too many to list}</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="artsbuilder">
        <term><command>artsbuilder</command></term>
        <listitem>
          <para>is a tool to create new structures of small connected
          <application>aRts</application> modules.</para>
          <indexterm zone="kdemultimedia artsbuilder">
            <primary sortas="b-artsbuilder">artsbuilder</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="juk">
        <term><command>juk</command></term>
        <listitem>
          <para>is a jukebox, tagger, and music collection manager.</para>
          <indexterm zone="kdemultimedia juk">
            <primary sortas="b-juk">juk</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="kaboodle">
        <term><command>kaboodle</command></term>
        <listitem>
          <para>is a multimedia player.</para>
          <indexterm zone="kdemultimedia kaboodle">
            <primary sortas="b-kaboodle">kaboodle</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="kaudiocreator">
        <term><command>kaudiocreator</command></term>
        <listitem>
          <para>is a front-end tool for ripping audio CDs and
          encoding the wav files.</para>
          <indexterm zone="kdemultimedia kaudiocreator">
            <primary sortas="b-kaudiocreator">kaudiocreator</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="kmid">
        <term><command>kmid</command></term>
        <listitem>
          <para>is a midi/karaoke player.</para>
          <indexterm zone="kdemultimedia kmid">
            <primary sortas="b-kmid">kmid</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="kmix">
        <term><command>kmix</command></term>
        <listitem>
          <para>is a sound mixer.</para>
          <indexterm zone="kdemultimedia kmix">
            <primary sortas="b-kmix">kmix</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="krec">
        <term><command>krec</command></term>
        <listitem>
          <para>is a recording frontend for <application>aRts</application>.</para>
          <indexterm zone="kdemultimedia krec">
            <primary sortas="b-krec">krec</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="kscd">
        <term><command>kscd</command></term>
        <listitem>
          <para>is a CD player.</para>
          <indexterm zone="kdemultimedia kscd">
            <primary sortas="b-kscd">kscd</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="noatun">
        <term><command>noatun</command></term>
        <listitem>
          <para>is another multimedia player.</para>
          <indexterm zone="kdemultimedia noatun">
            <primary sortas="b-noatun">noatun</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>