source: gnome/platform/weston.xml@ 1840044

<?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 weston-download-http "http://cgit.freedesktop.org/wayland/weston/snapshot/weston-&weston-version;.tar.gz">
  <!ENTITY weston-download-ftp  " ">
  <!ENTITY weston-md5sum        "92036a1655f821f2ad5bf661a0c88630">
  <!ENTITY weston-size          "640 KB">
  <!ENTITY weston-buildsize     "60 MB">
  <!ENTITY weston-time          "0.7 SBU">
]>

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

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

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

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

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

    <para>
      <application>weston</application> is the reference implementation of a Wayland compositor.
      Weston creates its unix socket file (for example, wayland-0) in the directory 
      specified by the required environment variable $XDG_RUNTIME_DIR. 
      Clients use the same variable to find that socket. This is provided using systemd.
    </para>

    &lfs75_checked;

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="wayland"/>,
      <xref linkend="cairo"/>, and
      <xref linkend="libxkbcommon"/>
    </para>

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

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="libunwind"/>
    </para>

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

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

    <para>
      Install <application>weston</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/without-scrollkeeper.xml"/>

    <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 Programs</segtitle>
      <segtitle>Installed Library</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>
          weston and weston-previewer
        </seg>
        <seg>
          libwestonui-2.so
        </seg>
        <seg>
          /usr/include/libwestonui-2.0,
          /usr/lib/weston,
          /usr/share/weston,
          /usr/share/gnome/help/weston,
          /usr/share/gtk-doc/html/westonui-2 and
          /usr/share/omf/weston
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="weston-prog">
        <term><command>weston</command></term>
        <listitem>
          <para>
            is used to create or edit user interface designs
            for <application>GTK+</application> or
            <application>GNOME</application> applications.
          </para>
          <indexterm zone="weston weston-prog">
            <primary sortas="b-weston">weston</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="weston-previewer">
        <term><command>weston-previewer</command></term>
        <listitem>
          <para>
            is used to preview a <application>weston</application> UI definition.
          </para>
          <indexterm zone="weston weston-previewer">
            <primary sortas="b-weston-previewer">weston-previewer</primary>
          </indexterm>
        </listitem>
      </varlistentry>

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

    </variablelist>

  </sect2>

</sect1>