source: x/lib/clutter.xml@ c8e80d51

<?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.26/clutter-&clutter-version;.tar.xz">
  <!ENTITY clutter-download-ftp  "&gnome-download-ftp;/clutter/1.26/clutter-&clutter-version;.tar.xz">
  <!ENTITY clutter-md5sum        "624dd776a5159de0267587b1df6b97b2">
  <!ENTITY clutter-size          "5.2 MB">
  <!ENTITY clutter-buildsize     "93 MB (with tests)">
  <!ENTITY clutter-time          "0.7 SBU (Using parallelism=4; with tests)">
]>

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


  <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>

    &lfs120_checked;

    <note>
      <para>
        Anything built with this toolkit needs hardware 3D acceleration from
        the graphics driver at runtime. This is provided by
        <application>Mesa</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="at-spi2-core"/>,
      <xref linkend="cogl"/>, and
      <xref linkend="json-glib"/>
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="gobject-introspection"/>,
      <xref linkend="gtk3"/>,
      <xref linkend="libgudev"/>,
      <xref linkend="libinput"/>,
      <xref linkend="libxkbcommon"/>, and
      <xref linkend="wayland"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="gtk-doc"/> and
      <ulink url="https://github.com/kergoth/tslib">Tslib</ulink>
    </para>

  </sect2>

  <sect2 role="installation">
    <title>Installation of Clutter</title>
<!--
    <para>
      If you wish to run the tests, the following commands disable two tests
      that fail.
    </para>

<screen><userinput>sed -i '/actor-offscreen-redirect/d' \
       tests/conform/Makefile.am tests/conform/Makefile.in &amp;&amp;
autoreconf -f -i</userinput></screen>
-->
    <para>
      Install <application>Clutter</application> by running the following
      commands:
    </para>

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

    <!-- https://gitlab.gnome.org/GNOME/clutter/-/issues/6 -->
    <para>
      The test suite is not recommended because some tests may
      hang forever. If you want to test the results anyway,
      issue: <command>make -j1 -k check</command>. You must be
      in an xterm or similar, because it launches some windows.
    </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>

    <para>
      <parameter>--enable-evdev-input</parameter>: This switch enables
      the experimental Evdev input backend which is required for
      <application>GNOME</application> Wayland support.
    </para>

    <para>
      <parameter>--enable-wayland-backend</parameter> and
      <parameter>--enable-wayland-compositor</parameter>: These
      switches enable the experimental <application>Wayland</application> API
      in <application>Clutter</application> which is required for
      <application>GNOME</application> Wayland support.
    </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>