source: gnome/platform/wayland.xml@ 3cbd038

<?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     "8 MB">
  <!ENTITY wayland-time          "21.8 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 protocol between a 
      compositor and its clients.
    </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>

    <note>
    <para>
      The queue-test will fail if the test suite is run
      as an unprivileged user.
    </para>
    </note>

    <para>
      To test the results issue the following command:
    </para>

<screen><userinput>make check</userinput></screen>

    <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-scanner
        </seg>
        <seg>
          libwayland-client.so libwayland-cursor.so libwayland-server.so
        </seg>
        <seg>
          /usr/share/wayland
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="wayland-scanner">
        <term><command>wayland</command></term>
        <listitem>
          <para>
            Is a tool to generate proxy methods in wayland-client-protocol.h 
            and wayland-server-protocol.h
          </para>
          <indexterm zone="wayland wayland-scanner">
            <primary sortas="b-wayland">wayland</primary>
          </indexterm>
        </listitem>
      </varlistentry>

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

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

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

    </variablelist>

  </sect2>

</sect1>