source: x/lib/clutter.xml@ 4c2be438

<?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.10/clutter-&clutter-version;.tar.xz">
  <!ENTITY clutter-download-ftp  "&gnome-download-ftp;/clutter/1.10/clutter-&clutter-version;.tar.xz">
  <!ENTITY clutter-md5sum        "7447512b4cb4e7b360a691ed2ceee1b1">
  <!ENTITY clutter-size          "4.6 MB">
  <!ENTITY clutter-buildsize     "90 MB">
  <!ENTITY clutter-time          "1.3 SBU">
]>

<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 is an open source
    software library for creating fast, visually rich and animated graphical
    user interfaces.</para>

  <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>
<!-- I don't quite understand this second paragraph, but I think first one covers
     clutter enough

    <para>If you use <application>GNOME-3</application> and it selects the
    <emphasis>fallback</emphasis> window manager
    (<application>metacity</application>) you should treat this package as a build
    dependency and expect unsatisfactory runtime performance from other
    <application>clutter</application> packages such as
    <application>totem</application>.</para> -->
  </note>

    &lfs70_checked;

    <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"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="gtk-doc"/>
    </para>

    <bridgehead renderas="sect4">Optional (to build the application developers
    manual)</bridgehead>
    <para role="optional">
      <xref linkend="docbook-utils"/>,
      <xref linkend="jadetex"/>,
      <xref linkend="xmlto"/> and either
      <xref linkend="Links"/>,
      <xref linkend="lynx"/> or
      <xref linkend="w3m"/>
     </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 &amp;&amp;
make</userinput></screen>

 <!-- I have assumed my test failures are because I don't have acclerated graphics. ken -->
    <para>To test the results, issue: <command>make check</command> (you must be
    in an xterm or similar to do this, 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><option>--enable-manual</option>: Use this parameter if
    <application>DocBook-utils</application>, <application>xmlto</application>,
    <application>JadeTeX</application>, and either
    <application>Links</application>, <application>Lynx</application>, or
    <application>W3m</application> are installed and you wish to build the
    application developers manual.</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 Library</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>
          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-glx-1.0">
        <term><filename class='libraryfile'>libclutter-glx-1.0.so</filename></term>
        <listitem>
          <para>contains the clutter API functions.</para>
          <indexterm zone="clutter libclutter-glx-1.0">
            <primary sortas="c-libclutter-glx-1.0">libclutter-glx-1.0.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>