source: x/lib/clutter.xml@ 0981c536

<?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 clutter-download-http "&gnome-download-http;/clutter/1.16/clutter-&clutter-version;.tar.xz">
  <!ENTITY clutter-download-ftp  "&gnome-download-ftp;/clutter/1.16/clutter-&clutter-version;.tar.xz">
  <!ENTITY clutter-md5sum        "29389588ce388bb64ec4d5c986a6afd3">
  <!ENTITY clutter-size          "5.0 MB">
  <!ENTITY clutter-buildsize     "85 MB (additional 7 MB for docs creation
                                  and 13 MB for tests)">
  <!ENTITY clutter-time          "0.7 SBU (additional 1.8 SBU for docs creation
                                  and 0.4 SBU for tests)">
]>

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

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

  <title>Clutter-&clutter-version;</title>

  <indexterm zone="clutter">
    <primary sortas="a-Clutter">Clutter</primary>
  </indexterm>

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

    <para>
      The <application>Clutter</application> package contains an open
      source software library used for creating fast, visually rich
      and animated graphical user interfaces.
    </para>

    &lfs74_checked;

    <note>
      <para>
        Anything built with this toolkit needs hardware 3D acceleration from
        the graphics driver at runtime. This is provided by
        <application>MesaLib</application> (or by proprietary graphics drivers),
        but is not available for every graphics card nor for all virtual
        machines. You may wish to review <xref linkend="checking-dri"/>.
      </para>
    </note>

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="atk"/>,
      <xref linkend="cogl"/>, and
      <xref linkend="json-glib"/>
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="gobject-introspection"/> and
      <xref linkend="gtk3"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="gtk-doc"/>,
      <ulink url="http://www.freedesktop.org/wiki/Software/libevdev/">
      libevdev</ulink>,
      <ulink url="http://xkbcommon.org/">libxkbcommon</ulink>,
      <ulink url="http://tslib.berlios.de/">Tslib</ulink>,
      <xref linkend="udev-extras"/> (for GUdev), and
      <ulink url="http://wayland.freedesktop.org/">Wayland</ulink>
    </para>

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

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

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

<screen><userinput>./configure --prefix=/usr --sysconfdir=/etc --enable-egl-backend &amp;&amp;
make</userinput></screen>

    <para>
      To test the results, issue: <command>make -k check</command> (you must be
      in an xterm or similar to do this, because it launches some windows). The
      abicheck.sh test fails, if experimental backends have been enabled by the
      use of the parameter <parameter>--enable-egl-backend</parameter>. Without
      that switch, the tests pass.
    </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>--enable-egl-backend</parameter>: This switch enables
      the experimental EGL windowing backend.
    </para>

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
      href="../../xincludes/gtk-doc-rebuild.xml"/>

  </sect2>

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

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

      <seglistitem>
        <seg>
          None
        </seg>
        <seg>
          libclutter-1.0.so and libclutter-glx-1.0.so
        </seg>
        <seg>
          /usr/include/clutter-1.0 and
          /usr/share/gtk-doc/html/{cally,clutter}
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="libclutter-1">
        <term><filename class="libraryfile">libclutter-1.0.so</filename></term>
        <listitem>
          <para>
            contains the <application>Clutter</application> API functions.
          </para>
          <indexterm zone="clutter libclutter-1">
            <primary sortas="c-libclutter-1">libclutter-1.0.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>