source: kde/phonon.xml@ 2a530932

<?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 "&kde-download-http;phonon/&phonon-version;/phonon-&phonon-version;.tar.xz">
  <!ENTITY phonon-download-ftp  " ">
  <!ENTITY phonon-md5sum        "d3df5ba646e4b3f11623d998caa40e74">
  <!ENTITY phonon-size          "308 KB">
  <!ENTITY phonon-buildsize     "12 MB">
  <!ENTITY phonon-time          "0.2 SBU (Using parallelism=4)">
]>

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


  <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 KDE.
      It replaces the old <application>aRts</application> package.
      Phonon needs either the GStreamer or VLC backend.
    </para>

    &lfs113_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">Phonon Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="cmake"/>,
      <xref linkend="extra-cmake-modules"/>,
      <xref linkend="glib2"/>, and
      <xref linkend="qt5"/>
    </para>

    <para role="required">
      At least one of <xref linkend="phonon-backend-gstreamer" role="runtime"/>
      or <xref linkend="phonon-backend-vlc" role="runtime"/> needs to be
      installed afterwards for multimedia operation in
      <application>KDE</application>.
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="pulseaudio"/>
    </para>


  </sect2>

  <sect2 role="installation">
    <title>Installation of Phonon</title>
    <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=/usr \
      -DCMAKE_BUILD_TYPE=Release  \
      .. &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>
      <parameter>-DCMAKE_BUILD_TYPE=Release</parameter>: This switch is used
      to apply higher level of the compiler optimizations.
    </para>
<!--
    <para>
      <parameter>-DPHONON_INSTALL_QT_EXTENSIONS_INTO_SYSTEM_QT=FALSE</parameter>:
      This switch ensures that the plugins and mkspecs files get installed in
      the correct location.
    </para>

    <para>
     <parameter>-DPHONON_BUILD_PHONON4QT5=ON</parameter>: This switch is used to
     ensure that Qt5 version of the library is built even if Qt4 is present.
    </para>
-->
  </sect2>

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

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

      <seglistitem>
        <seg>
          phononsettings
        </seg>
        <seg>
          libphonon4qt5.so and
          libphonon4qt5experimental.so
        </seg>
        <seg>
          /usr/include/phonon4qt5,
          /usr/lib/cmake/phonon4qt5,
          /usr/lib/plugins/designer, and
          /usr/share/phonon4qt5
        </seg>
      </seglistitem>
    </segmentedlist>

  </sect2>

</sect1>