source: x/lib/mx.xml@ 91b8b202

<?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 mx-download-http "http://source.clutter-project.org/sources/mx/1.4/mx-&mx-version;.tar.xz">
  <!ENTITY mx-download-ftp  " ">
  <!ENTITY mx-md5sum        "fda6be1b5818e5b04150ef4fde3b4762">
  <!ENTITY mx-size          "932 KB">
  <!ENTITY mx-buildsize     "33 MB">
  <!ENTITY mx-time          "0.8 SBU">
]>

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

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

  <title>mx-&mx-version;</title>

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

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

    <para><application>Mx</application> is a traditional GUI toolkit built upon
    Clutter technology. It enables smooth animations and special effects through
    hardware accelerated graphics (OpenGL).</para>

    &lfs70_checked;

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="clutter"/>,
      <xref linkend="dbus"/>,
      <xref linkend="gtk2"/>,
      <xref linkend="intltool"/> and
      <xref linkend="startup-notification"/>
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="gobject-introspection"/>
      (Required if building GNOME)
    </para>

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

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

  </sect2>

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

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

<screen><userinput>./configure --prefix=/usr &amp;&amp;
make</userinput></screen>

    <para>This package does not come with a test suite. </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>

    <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 Program</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>
          mx-create-image-cache
        </seg>
        <seg>
          libmx-1.0.so and libmx-gtk-1.0.so
        </seg>
        <seg>
          /usr/include/mx-1.0,
          /usr/share/gtk-doc/html/{mx,mx-gtk} and
          /usr/share/mx/style
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="libmx-1">
        <term><filename class='libraryfile'>libmx-1.0.so</filename></term>
        <listitem>
          <para>contains the MX API functions.</para>
          <indexterm zone="mx libmx-1">
            <primary sortas="c-libmx-1">libmx-1.0.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libmx-gtk-1">
        <term><filename class='libraryfile'>libmx-gtk-1.0.so</filename></term>
        <listitem>
          <para>contains the GTK+ Bindings to MX.</para>
          <indexterm zone="mx libmx-gtk-1">
            <primary sortas="c-libmx-gtk-1">libmx-gtk-1.0.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>