source: gnome/core/mutter.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 mutter-download-http "&gnome-download-http;/mutter/3.4/mutter-&mutter-version;.tar.xz">
  <!ENTITY mutter-download-ftp  "&gnome-download-ftp;/mutter/3.4/mutter-&mutter-version;.tar.xz">
  <!ENTITY mutter-md5sum        "3ca02d4ca270e8587643af405c10f57d">
  <!ENTITY mutter-size          "1.6 MB">
  <!ENTITY mutter-buildsize     "45 MB">
  <!ENTITY mutter-time          "0.9 SBU">
]>

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

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

  <title>Mutter-&mutter-version;</title>

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

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

    <para><application>Mutter</application> is the window manager for
    <application>GNOME</application>. It is not invoked directly, but from
    <application>gnome-session</application> (on a machine with a hardware
    accelerated video driver).</para>

    &lfs70_checked;

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="clutter"/>,
      <xref linkend="gnome-doc-utils"/>,
      <xref linkend="gobject-introspection"/>,
      <xref linkend="gtk3"/>,
      <xref linkend="libcanberra"/>,
      <xref linkend="startup-notification"/> and
      <xref linkend="zenity"/>
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="rarian"/>
    </para>

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

  </sect2>

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

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

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

    <para>This package's testsuite is only intended to be used by the
    maintainer to check i18n files.</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/static-libraries.xml"/>

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

  </sect2>

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

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

      <seglistitem>
        <seg>
          mutter, mutter-message, mutter-theme-viewer and mutter-window-demo
        </seg>
        <seg>
          libmutter.so
        </seg>
        <seg>
          /usr/include/mutter, /usr/lib/mutter and
          /usr/share/mutter
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="mutter-prog">
        <term><command>mutter</command></term>
        <listitem>
          <para>is a Clutter based compositing GTK+ Window Manager.</para>
          <indexterm zone="mutter mutter-prog">
            <primary sortas="b-mutter">mutter</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="mutter-message">
        <term><command>mutter-message</command></term>
        <listitem>
          <para>is a command used to send a message to Mutter.</para>
          <indexterm zone="mutter mutter-message">
            <primary sortas="b-mutter-message">mutter-message</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="mutter-theme-viewer">
        <term><command>mutter-theme-viewer</command></term>
        <listitem>
          <para>used to preview any installed Mutter theme.</para>
          <indexterm zone="mutter mutter-theme-viewer">
            <primary sortas="b-mutter-theme-viewer">mutter-theme-viewer</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="mutter-window-demo">
        <term><command>mutter-window-demo</command></term>
        <listitem>
          <para>is a Mutter demo program.</para>
          <indexterm zone="mutter mutter-window-demo">
            <primary sortas="b-mutter-window-demo">mutter-window-demo</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libmutter">
        <term><filename class='libraryfile'>libmutter.so</filename></term>
        <listitem>
          <para>contains the Mutter API functions.</para>
          <indexterm zone="mutter libmutter">
            <primary sortas="c-libmutter">libmutter.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>