source: kde4/core/phonon.xml@ 8569196

<?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 phonon-download-http "http://mirrors.isc.org/pub/kde/stable/phonon/&phonon-version;/src/phonon-&phonon-version;.tar.xz">
  <!ENTITY phonon-download-ftp  "ftp://ftp.kde.org/pub/kde/stable/phonon/&phonon-version;/src/phonon-&phonon-version;.tar.xz">
  <!ENTITY phonon-md5sum        "bbe0c1c62ed14c31479c4c1a6cf1e173">
  <!ENTITY phonon-size          "275 KB">
  <!ENTITY phonon-buildsize     "7.4 MB">
  <!ENTITY phonon-time          "0.5 SBU">
]>

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

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

  <title>Phonon-&phonon-version;</title>

  <indexterm zone="phonon">
    <primary sortas="a-phonon">phonon</primary>
  </indexterm>

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

    <para><application>Phonon</application> is the multimedia API for KDE4.
    It replaces the old <application>aRts</application>, that is no longer
    supported by KDE. It supports backends like GStreamer and VLC.</para>

    &lfs70_checked;

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

<!--
    <bridgehead renderas="sect3">Additional Downloads</bridgehead>
    <itemizedlist spacing='compact'>
      <listitem>
        <para>Required patch: <ulink
        url="&patch-root;/phonon-&phonon-version;-fixes-1.patch"/></para>
      </listitem>
    </itemizedlist>
-->

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
    <xref linkend="qt4"/>,
    <xref linkend="pkgconfig"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend='pulseaudio'/>, 
      <ulink url="http://projects.kde.org/projects/kdesupport/libqzeitgeist/">QZeitgeist</ulink>
    </para>   
    
    <para condition="html" role="usernotes">User Notes:
    <ulink url="&blfs-wiki;/phonon"/></para>

  </sect2>

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

    <para>Make sure that <xref linkend="qt4"/> is compiled without the bundled
    <application>Phonon</application> library. This package provides
    a better implementation.</para>
    
    <para>Install <application>Phonon</application> by running the following
    commands:</para>

<screen><userinput>mkdir build &amp;&amp;
cd build &amp;&amp;
cmake -DCMAKE_INSTALL_PREFIX=$QT4DIR \
      -DPHONON_INSTALL_QT_EXTENSIONS_INTO_SYSTEM_QT=TRUE \
      .. &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><option>-DPHONON_INSTALL_QT_EXTENSIONS_INTO_SYSTEM_QT=TRUE</option>: This option ensures that the plugins and mkspecs files get installed in the correct location.</para>

  </sect2>

<!-- this is a patch slackware uses. Cannot see that we need it too
       <para>Execute a modification to enable <ulink url="http://www.riverbankcomputing.com/software/pyqt/">pyQT4</ulink>
       to find the headers:</para>
       
<screen><userinput>sed -i -e 's#{includedir}$#&amp; -I\${includedir}/phonon#' \
          $QT4DIR/lib/pkgconfig/phonon.pc</userinput></screen>
-->

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

    <para><option>- -xyz</option>: This option is set for ...</para>

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

    <segmentedlist>
      <segtitle>Installed Program</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directory</segtitle>

      <seglistitem>
        <seg>none</seg>
        <seg>libphonon.so, libphononexperimental.so</seg>
        <seg>none</seg>
      </seglistitem>
    </segmentedlist>
<!--
    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

      <varlistentry id="a-phonon">
        <term><command>phonon</command></term>
        <listitem>
          <para>is a testing utility for phonon-generated build trees.</para>
          <indexterm zone="a-phonon phonon">
            <primary sortas="b-phonon">phonon</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>
-->
  </sect2>

</sect1>