glfs/shareddeps/dps/wl/xwayland.xml

<?xml version="1.0" encoding="UTF-8"?>
<!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 xwayland-download-http "&xorg-download-http;/xserver/xwayland-&xwayland-version;.tar.xz">
  <!ENTITY xwayland-download-ftp  " ">
]>

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


  <title>Xwayland-&xwayland-version;</title>

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

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

    <para>
      The <application>Xwayland</application> package is an Xorg server
      running on top of the wayland server. It has been separated from the
      main Xorg server package. It allows running X clients inside a
      wayland session.
    </para>

    &lfs121_checked;

    <itemizedlist spacing="compact">
      <listitem>
        <para>
          Download (HTTP): <ulink url="&xwayland-download-http;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download (FTP): <ulink url="&xwayland-download-ftp;"/>
        </para>
      </listitem>
    </itemizedlist>

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="libxcvt"/>,
      <xref linkend="pixman"/>,
      <xref linkend="wayland-protocols"/>,
      <xref role='runtime' linkend="xorg7-app"/> (runtime), and
      <xref linkend="xorg7-font"/> (only font-util)
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="libepoxy"/> and
      <xref linkend="mesa"/>
    </para>

  </sect2>

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

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

<screen><userinput>sed -i '/install_man/,$d' meson.build &amp;&amp;

mkdir build &amp;&amp;
cd    build &amp;&amp;

meson setup --prefix=$XORG_PREFIX         \
            --buildtype=release           \
            -Dxkb_output_dir=/var/lib/xkb \
            ..                            &amp;&amp;
ninja</userinput></screen>

    <para>
      Now, as the <systemitem class="username">root</systemitem> user:
    </para>

<screen role="root" revision="sysv"><userinput>ninja install &amp;&amp;
cat &gt;&gt; /etc/sysconfig/createfiles &lt;&lt; "EOF"
<literal>/tmp/.X11-unix dir 1777 root root</literal>
EOF</userinput></screen>

<screen role="root" revision="systemd"><userinput>ninja install</userinput></screen>

    <para>
      If <xref linkend='xorg-server'/> is not installed and you do not plan
      to install it later, you can install <command>Xvfb</command> from this
      package.  As the &root; user:
    </para>

<screen role="nodump"><userinput>install -vm755 hw/vfb/Xvfb /usr/bin</userinput></screen>

  </sect2>

  <sect2 role="commands">
    <title>Command Explanations</title>

    <para>
      <command>sed -i '/install_man/,$d' meson.build</command>: Prevents
      installing a manual page for <command>Xserver</command>,
      which is also provided by <xref linkend='xorg-server'/>.  Remove this
      command if <xref linkend='xorg-server'/> is not installed and you
      don't plan to install it later.
    </para>

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
      href="../../../xincludes/meson-buildtype-release.xml"/>
<!--
    <para>
      <parameter>-Dxvfb=false</parameter>: Prevents building the
      <command>xvfb</command> program, which is also installed by
      <xref linkend="xorg-server"/>. Remove this option if you do not plan to
      install the X server.
    </para>

    <para>
      <command>mkdir -pv /etc/X11/xorg.conf.d</command>: This directory is
      needed to put configuration files for Xwayland. This command ensures
      that it exists, as some applications might use it without first
      creating it.
    </para>
-->
    <para revision="sysv">
      <command>cat &gt;&gt; /etc/sysconfig/createfiles...</command>: This
      command creates the <filename class="directory">/tmp/.X11-unix</filename>
      directory at startup, and ensures that the permissions and ownership
      are correct as required by applications using Xwayland.
    </para>

  </sect2>

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

    <segmentedlist>
      <segtitle>Installed Program</segtitle>
      <segtitle>Installed Library</segtitle>
      <segtitle>Installed Directory</segtitle>

      <seglistitem>
        <seg>
          Xwayland
        </seg>
        <seg>
          None
        </seg>
        <seg>
          None
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="Xwayland">
        <term><command>Xwayland</command></term>
        <listitem>
          <para>
            Allows X clients to run under wayland
          </para>
          <indexterm zone="xwayland Xwayland">
            <primary sortas="b-Xwayland">Xwayland</primary>
          </indexterm>
        </listitem>
      </varlistentry>
    </variablelist>
  </sect2>
</sect1>