[ab5ea1f1] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
| 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
| 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
| 7 | <!ENTITY xwayland-download-http "&xorg-download-http;/xserver/xwayland-&xwayland-version;.tar.xz">
|
---|
| 8 | <!ENTITY xwayland-download-ftp "&xorg-download-ftp;/xserver/xwayland-&xwayland-version;.tar.xz">
|
---|
[566ab83] | 9 | <!ENTITY xwayland-md5sum "6019af045e3a34ce303c677d3fe98c07">
|
---|
[ab5ea1f1] | 10 | <!ENTITY xwayland-size "1.2 MB">
|
---|
[566ab83] | 11 | <!ENTITY xwayland-buildsize "76 MB (add 355 MB for tests)">
|
---|
| 12 | <!ENTITY xwayland-time "0.2 SBU (with paralellism=4; add 1.0 SBU for tests, not including clone time)">
|
---|
[ab5ea1f1] | 13 | ]>
|
---|
| 14 |
|
---|
| 15 | <sect1 id="xwayland" xreflabel="Xwayland-&xwayland-version;">
|
---|
| 16 | <?dbhtml filename="xwayland.html"?>
|
---|
| 17 |
|
---|
| 18 | <sect1info>
|
---|
| 19 | <date>$Date$</date>
|
---|
| 20 | </sect1info>
|
---|
| 21 |
|
---|
| 22 | <title>Xwayland-&xwayland-version;</title>
|
---|
| 23 |
|
---|
| 24 | <indexterm zone="xwayland">
|
---|
| 25 | <primary sortas="a-xwayland">xwayland</primary>
|
---|
| 26 | </indexterm>
|
---|
| 27 |
|
---|
| 28 | <sect2 role="package">
|
---|
| 29 | <title>Introduction to Xwayland</title>
|
---|
| 30 |
|
---|
| 31 | <para>
|
---|
| 32 | The <application>Xwayland</application> package is an Xorg server
|
---|
[a43536ce] | 33 | running on top of the wayland server. It has been separated from the
|
---|
[ab5ea1f1] | 34 | main Xorg server package. It allows running X clients inside a
|
---|
| 35 | wayland session.
|
---|
| 36 | </para>
|
---|
| 37 |
|
---|
[f1a479c7] | 38 | &lfs111_checked;
|
---|
[ab5ea1f1] | 39 |
|
---|
| 40 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 41 | <itemizedlist spacing="compact">
|
---|
| 42 | <listitem>
|
---|
| 43 | <para>
|
---|
| 44 | Download (HTTP): <ulink url="&xwayland-download-http;"/>
|
---|
| 45 | </para>
|
---|
| 46 | </listitem>
|
---|
| 47 | <listitem>
|
---|
| 48 | <para>
|
---|
| 49 | Download (FTP): <ulink url="&xwayland-download-ftp;"/>
|
---|
| 50 | </para>
|
---|
| 51 | </listitem>
|
---|
| 52 | <listitem>
|
---|
| 53 | <para>
|
---|
| 54 | Download MD5 sum: &xwayland-md5sum;
|
---|
| 55 | </para>
|
---|
| 56 | </listitem>
|
---|
| 57 | <listitem>
|
---|
| 58 | <para>
|
---|
| 59 | Download size: &xwayland-size;
|
---|
| 60 | </para>
|
---|
| 61 | </listitem>
|
---|
| 62 | <listitem>
|
---|
| 63 | <para>
|
---|
| 64 | Estimated disk space required: &xwayland-buildsize;
|
---|
| 65 | </para>
|
---|
| 66 | </listitem>
|
---|
| 67 | <listitem>
|
---|
| 68 | <para>
|
---|
| 69 | Estimated build time: &xwayland-time;
|
---|
| 70 | </para>
|
---|
| 71 | </listitem>
|
---|
| 72 | </itemizedlist>
|
---|
| 73 |
|
---|
| 74 | <bridgehead renderas="sect3">Xwayland Dependencies</bridgehead>
|
---|
| 75 |
|
---|
| 76 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
| 77 | <para role="required">
|
---|
[f1a479c7] | 78 | <xref linkend="libxcvt"/>,
|
---|
[ab5ea1f1] | 79 | <xref linkend="pixman"/>,
|
---|
| 80 | <xref linkend="wayland-protocols"/>, and
|
---|
| 81 | <xref linkend="xorg7-font"/> (only font-util)
|
---|
| 82 | </para>
|
---|
| 83 |
|
---|
| 84 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
| 85 | <para role="recommended">
|
---|
| 86 | <xref linkend="libepoxy"/>,
|
---|
| 87 | <xref linkend="libtirpc"/>, and
|
---|
| 88 | <xref linkend="mesa"/>
|
---|
| 89 | </para>
|
---|
| 90 |
|
---|
| 91 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
| 92 | <para role="optional">
|
---|
[a4020bd] | 93 | <xref linkend="git"/> (to download packages needed for the tests),
|
---|
[ab5ea1f1] | 94 | <xref linkend="libgcrypt"/>,
|
---|
| 95 | <xref linkend="nettle"/>,
|
---|
[f1a479c7] | 96 | <xref linkend="xmlto"/>,
|
---|
[ab5ea1f1] | 97 | <xref linkend="xorg7-legacy"/>
|
---|
| 98 | (only bdftopcf, for building fonts required for the tests),
|
---|
| 99 | <ulink url="https://gitlab.freedesktop.org/xorg/test/rendercheck">rendercheck</ulink> (for tests), and
|
---|
| 100 | <ulink url="https://wayland.pages.freedesktop.org/weston/">weston</ulink> (for tests)
|
---|
| 101 | </para>
|
---|
| 102 |
|
---|
| 103 | <para condition="html" role="usernotes">
|
---|
| 104 | User Notes: <ulink url="&blfs-wiki;/xwayland"/>
|
---|
| 105 | </para>
|
---|
| 106 | </sect2>
|
---|
| 107 |
|
---|
| 108 | <sect2 role="installation">
|
---|
| 109 | <title>Installation of Xwayland</title>
|
---|
| 110 |
|
---|
| 111 | <para>
|
---|
| 112 | Install <application>xwayland</application> by running the following
|
---|
| 113 | commands:
|
---|
| 114 | </para>
|
---|
| 115 |
|
---|
[04af9db7] | 116 | <screen><userinput>sed -i '/install_man/,$d' meson.build &&
|
---|
[ab5ea1f1] | 117 |
|
---|
| 118 | mkdir build &&
|
---|
[04af9db7] | 119 | cd build &&
|
---|
[ab5ea1f1] | 120 |
|
---|
| 121 | meson --prefix=$XORG_PREFIX \
|
---|
| 122 | -Dxkb_output_dir=/var/lib/xkb \
|
---|
| 123 | .. &&
|
---|
| 124 | ninja</userinput></screen>
|
---|
| 125 |
|
---|
| 126 | <para>
|
---|
| 127 | Building the test framework needs some work. First,
|
---|
| 128 | <ulink url="https://wayland.pages.freedesktop.org/weston/">weston</ulink>
|
---|
| 129 | brings in several dependencies, but the number can be reduced by
|
---|
| 130 | disabling unneeded features. The <command>meson</command> command
|
---|
| 131 | for a stripped down build of <application>weston</application> is shown
|
---|
| 132 | in <ulink
|
---|
| 133 | url="https://gitlab.freedesktop.org/xorg/xserver/-/blob/xwayland-21.1/.gitlab-ci/debian-install.sh">
|
---|
| 134 | Upstream continuous integration build</ulink>.
|
---|
| 135 | </para>
|
---|
[e1130df] | 136 | <!--
|
---|
[ab5ea1f1] | 137 | <para>
|
---|
| 138 | Furthermore, an X server needs to be running during the build of
|
---|
| 139 | <application>xts</application>. If not running the tests in a
|
---|
| 140 | graphical environment, you'll need to enable <command>Xvfb</command>
|
---|
| 141 | by removing the <parameter>-Dxvfb=false</parameter> above. The
|
---|
[f1a479c7] | 142 | instructions below expect this has been done.
|
---|
[ab5ea1f1] | 143 | </para>
|
---|
[e1130df] | 144 | -->
|
---|
[ab5ea1f1] | 145 | <para>
|
---|
| 146 | Running the tests involves downloading two other frameworks, in addition
|
---|
| 147 | to the mentioned optional dependencies:
|
---|
| 148 | </para>
|
---|
| 149 |
|
---|
| 150 | <screen remap="test"><userinput>mkdir tools &&
|
---|
| 151 | pushd tools &&
|
---|
| 152 |
|
---|
| 153 | git clone https://gitlab.freedesktop.org/mesa/piglit.git --depth 1 &&
|
---|
| 154 | cat > piglit/piglit.conf << EOF &&
|
---|
| 155 | <literal>[xts]
|
---|
| 156 | path=$(pwd)/xts
|
---|
| 157 | EOF</literal>
|
---|
| 158 |
|
---|
| 159 | git clone https://gitlab.freedesktop.org/xorg/test/xts --depth 1 &&
|
---|
| 160 |
|
---|
| 161 | export DISPLAY=:22 &&
|
---|
[f1a479c7] | 162 | ../hw/vfb/Xvfb $DISPLAY &
|
---|
[ab5ea1f1] | 163 | VFB_PID=$! &&
|
---|
| 164 | cd xts &&
|
---|
| 165 | CFLAGS=-fcommon ./autogen.sh &&
|
---|
| 166 | make &&
|
---|
| 167 | kill $VFB_PID &&
|
---|
| 168 | unset DISPLAY VFB_PID &&
|
---|
| 169 | popd</userinput></screen>
|
---|
| 170 |
|
---|
| 171 | <para>
|
---|
| 172 | Then the tests can be run with:
|
---|
| 173 | </para>
|
---|
| 174 |
|
---|
| 175 | <screen remap="test"><userinput>XTEST_DIR=$(pwd)/tools/xts PIGLIT_DIR=$(pwd)/tools/piglit ninja test</userinput></screen>
|
---|
| 176 |
|
---|
[f1a479c7] | 177 | <!-- The xfontset tests fail on my system -renodr -->
|
---|
[ab5ea1f1] | 178 | <para>
|
---|
| 179 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 180 | </para>
|
---|
| 181 |
|
---|
[6c6b4190] | 182 | <screen role="root" revision="sysv"><userinput>ninja install &&
|
---|
| 183 | mkdir -pv /etc/X11/xorg.conf.d &&
|
---|
| 184 | cat >> /etc/sysconfig/createfiles << "EOF"
|
---|
| 185 | <literal>/tmp/.X11-unix dir 1777 root root</literal>
|
---|
| 186 | EOF</userinput></screen>
|
---|
| 187 |
|
---|
| 188 | <screen role="root" revision="systemd"><userinput>ninja install &&
|
---|
| 189 | mkdir -pv /etc/X11/xorg.conf.d</userinput></screen>
|
---|
| 190 |
|
---|
[e1130df] | 191 | <para>
|
---|
| 192 | If <xref linkend='xorg-server'/> is not installed and you do not plan
|
---|
| 193 | to install it later, you can install <command>Xvfb</command> from this
|
---|
| 194 | package. As the &root; user:
|
---|
| 195 | </para>
|
---|
| 196 |
|
---|
| 197 | <screen role="nodump"><userinput>install -vm755 hw/vfb/Xvfb /usr/bin</userinput></screen>
|
---|
| 198 |
|
---|
[ab5ea1f1] | 199 | </sect2>
|
---|
| 200 |
|
---|
| 201 | <sect2 role="commands">
|
---|
| 202 | <title>Command Explanations</title>
|
---|
| 203 |
|
---|
| 204 | <para>
|
---|
[04af9db7] | 205 | <command>sed -i '/install_man/,$d' meson.build</command>: Prevents
|
---|
[ab5ea1f1] | 206 | installing a manual page for <command>Xserver</command>,
|
---|
| 207 | which is not part of this package.
|
---|
| 208 | </para>
|
---|
[e1130df] | 209 | <!--
|
---|
[ab5ea1f1] | 210 | <para>
|
---|
| 211 | <parameter>-Dxvfb=false</parameter>: Prevents building the
|
---|
| 212 | <command>xvfb</command> program, which is also installed by
|
---|
[f1a479c7] | 213 | <xref linkend="xorg-server"/>. Remove this option if you do not plan to
|
---|
[ab5ea1f1] | 214 | install the X server.
|
---|
| 215 | </para>
|
---|
[e1130df] | 216 | -->
|
---|
[6c6b4190] | 217 | <para>
|
---|
| 218 | <command>mkdir -pv /etc/X11/xorg.conf.d</command>: This directory is
|
---|
| 219 | needed to put configuration files for Xwayland. This command ensures
|
---|
| 220 | that it exists, as some applications might use it without first
|
---|
| 221 | creating it.
|
---|
| 222 | </para>
|
---|
| 223 |
|
---|
| 224 | <para revision="sysv">
|
---|
| 225 | <command>cat >> /etc/sysconfig/createfiles...</command>: This
|
---|
| 226 | command creates the <filename class="directory">/tmp/.X11-unix</filename>
|
---|
| 227 | directory at startup, and ensures that the permissions and ownership
|
---|
| 228 | are correct as required by applications using Xwayland.
|
---|
| 229 | </para>
|
---|
| 230 |
|
---|
[ab5ea1f1] | 231 | </sect2>
|
---|
| 232 |
|
---|
| 233 | <sect2 role="content">
|
---|
| 234 | <title>Contents</title>
|
---|
| 235 |
|
---|
| 236 | <segmentedlist>
|
---|
| 237 | <segtitle>Installed Program</segtitle>
|
---|
| 238 | <segtitle>Installed Library</segtitle>
|
---|
| 239 | <segtitle>Installed Directory</segtitle>
|
---|
| 240 |
|
---|
| 241 | <seglistitem>
|
---|
| 242 | <seg>
|
---|
| 243 | Xwayland
|
---|
| 244 | </seg>
|
---|
| 245 | <seg>
|
---|
| 246 | None
|
---|
| 247 | </seg>
|
---|
| 248 | <seg>
|
---|
| 249 | None
|
---|
| 250 | </seg>
|
---|
| 251 | </seglistitem>
|
---|
| 252 | </segmentedlist>
|
---|
| 253 |
|
---|
| 254 | <variablelist>
|
---|
| 255 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 256 | <?dbfo list-presentation="list"?>
|
---|
| 257 | <?dbhtml list-presentation="table"?>
|
---|
| 258 |
|
---|
| 259 | <varlistentry id="Xwayland">
|
---|
| 260 | <term><command>Xwayland</command></term>
|
---|
| 261 | <listitem>
|
---|
| 262 | <para>
|
---|
[f1a479c7] | 263 | Allows X clients to run under wayland
|
---|
[ab5ea1f1] | 264 | </para>
|
---|
| 265 | <indexterm zone="xwayland Xwayland">
|
---|
| 266 | <primary sortas="b-Xwayland">Xwayland</primary>
|
---|
| 267 | </indexterm>
|
---|
| 268 | </listitem>
|
---|
| 269 | </varlistentry>
|
---|
| 270 | </variablelist>
|
---|
| 271 | </sect2>
|
---|
| 272 | </sect1>
|
---|