source: gnome/platform/wayland.xml@ 4270d9a

<?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 wayland-download-http "http://wayland.freedesktop.org/releases/wayland-&wayland-version;.tar.xz">
  <!ENTITY wayland-download-ftp  " ">
  <!ENTITY wayland-md5sum        "1d882776b27329b91d2d500b6d66dd1d">
  <!ENTITY wayland-size          "396 KB">
  <!ENTITY wayland-buildsize     "50 MB">
  <!ENTITY wayland-time          "0.4 SBU">
]>

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

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

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

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

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

    <para>
      <application>wayland</application> is a project to define a protocol 
      for a compositor to talk to its clients as well as a library 
      implementation of the protocol.  The compositor can be a standalone 
      display server running on Linux kernel modesetting and evdev input devices, 
      an X application, or a wayland client itself.  
      The clients can be traditional applications, X servers (rootless or fullscreen) 
      or other display servers.
    </para>

    &lfs75_checked;

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="libffi"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="doxygen"/>, (to build documentation)
      <xref linkend="libxslt"/>
    </para>

    <bridgehead renderas="sect4">Required (Runtime)</bridgehead>
    <para role="required">
      <xref linkend="weston"/>
    </para>

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

  </sect2>

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

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

<screen><userinput>./configure --prefix=/usr --disable-static &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/static-libraries.xml"/>

  </sect2>

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

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

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

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

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

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

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

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

      <varlistentry id="libwayland">
        <term><filename class="libraryfile">libwayland.so</filename></term>
        <listitem>
          <para>
            contains the <application>wayland</application> API functions.
          </para>
          <indexterm zone="wayland libwayland">
            <primary sortas="c-libwayland">libwayland.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>