[ab4fdfc] | 1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
[f97d5f6] | 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 |
|
---|
[a151e731] | 7 | <!ENTITY wayland-download-http "https://gitlab.freedesktop.org/wayland/wayland/-/releases/&wayland-version;/downloads/wayland-&wayland-version;.tar.xz">
|
---|
[f97d5f6] | 8 | <!ENTITY wayland-download-ftp " ">
|
---|
[473f5696] | 9 | <!ENTITY wayland-md5sum "23ad991e776ec8cf7e58b34cbd2efa75">
|
---|
| 10 | <!ENTITY wayland-size "236 KB">
|
---|
| 11 | <!ENTITY wayland-buildsize "6.8 MB (with tests)">
|
---|
[9052373] | 12 | <!ENTITY wayland-time "0.1 SBU (with tests)">
|
---|
[f97d5f6] | 13 | ]>
|
---|
| 14 |
|
---|
| 15 | <sect1 id="wayland" xreflabel="Wayland-&wayland-version;">
|
---|
| 16 | <?dbhtml filename="wayland.html"?>
|
---|
| 17 |
|
---|
| 18 |
|
---|
| 19 | <title>Wayland-&wayland-version;</title>
|
---|
| 20 |
|
---|
| 21 | <indexterm zone="wayland">
|
---|
| 22 | <primary sortas="a-Wayland">Wayland</primary>
|
---|
| 23 | </indexterm>
|
---|
| 24 |
|
---|
| 25 | <sect2 role="package">
|
---|
| 26 | <title>Introduction to Wayland</title>
|
---|
| 27 |
|
---|
| 28 | <para>
|
---|
| 29 | <application>Wayland</application> is a project to define a protocol
|
---|
| 30 | for a compositor to talk to its clients as well as a library
|
---|
| 31 | implementation of the protocol.
|
---|
| 32 | </para>
|
---|
| 33 |
|
---|
[d4dc5bae] | 34 | &lfs122_checked;
|
---|
[f97d5f6] | 35 |
|
---|
| 36 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 37 | <itemizedlist spacing="compact">
|
---|
| 38 | <listitem>
|
---|
| 39 | <para>
|
---|
| 40 | Download (HTTP): <ulink url="&wayland-download-http;"/>
|
---|
| 41 | </para>
|
---|
| 42 | </listitem>
|
---|
| 43 | <listitem>
|
---|
| 44 | <para>
|
---|
| 45 | Download (FTP): <ulink url="&wayland-download-ftp;"/>
|
---|
| 46 | </para>
|
---|
| 47 | </listitem>
|
---|
| 48 | <listitem>
|
---|
| 49 | <para>
|
---|
| 50 | Download MD5 sum: &wayland-md5sum;
|
---|
| 51 | </para>
|
---|
| 52 | </listitem>
|
---|
| 53 | <listitem>
|
---|
| 54 | <para>
|
---|
| 55 | Download size: &wayland-size;
|
---|
| 56 | </para>
|
---|
| 57 | </listitem>
|
---|
| 58 | <listitem>
|
---|
| 59 | <para>
|
---|
| 60 | Estimated disk space required: &wayland-buildsize;
|
---|
| 61 | </para>
|
---|
| 62 | </listitem>
|
---|
| 63 | <listitem>
|
---|
| 64 | <para>
|
---|
| 65 | Estimated build time: &wayland-time;
|
---|
| 66 | </para>
|
---|
| 67 | </listitem>
|
---|
| 68 | </itemizedlist>
|
---|
| 69 |
|
---|
| 70 | <bridgehead renderas="sect3">Wayland Dependencies</bridgehead>
|
---|
| 71 |
|
---|
| 72 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
| 73 | <para role="required">
|
---|
[1ee5a6a] | 74 | <xref linkend="libxml2"/>
|
---|
[f97d5f6] | 75 | </para>
|
---|
| 76 |
|
---|
| 77 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
| 78 | <para role="optional">
|
---|
| 79 | <xref linkend="doxygen"/>,
|
---|
| 80 | <xref linkend="graphviz"/> and
|
---|
| 81 | <xref linkend="xmlto"/> (to build the API documentation) and
|
---|
| 82 | <xref linkend="DocBook"/>,
|
---|
| 83 | <xref linkend="docbook-xsl"/> and
|
---|
| 84 | <xref linkend="libxslt"/> (to build the manual pages)
|
---|
| 85 | </para>
|
---|
| 86 |
|
---|
| 87 | </sect2>
|
---|
| 88 |
|
---|
| 89 | <sect2 role="installation">
|
---|
| 90 | <title>Installation of Wayland</title>
|
---|
| 91 |
|
---|
| 92 | <para>
|
---|
| 93 | Install <application>Wayland</application> by running the following
|
---|
| 94 | commands:
|
---|
| 95 | </para>
|
---|
| 96 |
|
---|
[7f4758bb] | 97 | <screen><userinput>mkdir build &&
|
---|
| 98 | cd build &&
|
---|
| 99 |
|
---|
[91318eb] | 100 | meson setup .. \
|
---|
| 101 | --prefix=/usr \
|
---|
[7f4758bb] | 102 | --buildtype=release \
|
---|
[7c83169b] | 103 | -D documentation=false &&
|
---|
[7f4758bb] | 104 | ninja</userinput></screen>
|
---|
[f97d5f6] | 105 |
|
---|
| 106 | <para>
|
---|
[a1b0947] | 107 | <!-- If XDG_RUNTIME_DIR is set but the value is a non-exist path,
|
---|
| 108 | 19 tests will fail. Unfortunately BLFS /etc/profile sets
|
---|
| 109 | XDG_RUNTIME_DIR but does not create it. For now simply unset
|
---|
| 110 | the variable. -->
|
---|
| 111 | To test the results, issue:
|
---|
| 112 | <command>env -u XDG_RUNTIME_DIR ninja test</command>.
|
---|
[f97d5f6] | 113 | </para>
|
---|
| 114 |
|
---|
| 115 | <para>
|
---|
| 116 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 117 | </para>
|
---|
| 118 |
|
---|
[7f4758bb] | 119 | <screen role="root"><userinput>ninja install</userinput></screen>
|
---|
[f97d5f6] | 120 |
|
---|
| 121 | </sect2>
|
---|
| 122 |
|
---|
| 123 | <sect2 role="commands">
|
---|
| 124 | <title>Command Explanations</title>
|
---|
| 125 |
|
---|
| 126 | <para>
|
---|
[7c83169b] | 127 | <parameter>-D documentation=false</parameter>: This switch is used to
|
---|
[f97d5f6] | 128 | disable building of the API documentation. Remove it if you have
|
---|
| 129 | installed optional dependencies.
|
---|
| 130 | </para>
|
---|
| 131 |
|
---|
| 132 | </sect2>
|
---|
| 133 |
|
---|
| 134 | <sect2 role="content">
|
---|
| 135 | <title>Contents</title>
|
---|
| 136 |
|
---|
| 137 | <segmentedlist>
|
---|
| 138 | <segtitle>Installed Programs</segtitle>
|
---|
| 139 | <segtitle>Installed Libraries</segtitle>
|
---|
| 140 | <segtitle>Installed Directories</segtitle>
|
---|
| 141 |
|
---|
| 142 | <seglistitem>
|
---|
| 143 | <seg>
|
---|
| 144 | wayland-scanner
|
---|
| 145 | </seg>
|
---|
| 146 | <seg>
|
---|
[8558044] | 147 | libwayland-client.so,
|
---|
[0a5eabf6] | 148 | libwayland-cursor.so,
|
---|
[8558044] | 149 | libwayland-egl.so,
|
---|
[0a5eabf6] | 150 | and libwayland-server.so
|
---|
[f97d5f6] | 151 | </seg>
|
---|
| 152 | <seg>
|
---|
| 153 | /usr/share/wayland
|
---|
| 154 | </seg>
|
---|
| 155 | </seglistitem>
|
---|
| 156 | </segmentedlist>
|
---|
| 157 |
|
---|
| 158 | <variablelist>
|
---|
| 159 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 160 | <?dbfo list-presentation="list"?>
|
---|
| 161 | <?dbhtml list-presentation="table"?>
|
---|
| 162 |
|
---|
| 163 | <varlistentry id="wayland-scanner">
|
---|
| 164 | <term><command>wayland-scanner</command></term>
|
---|
| 165 | <listitem>
|
---|
| 166 | <para>
|
---|
[f3429309] | 167 | is a tool to generate proxy methods in wayland-client-protocol.h
|
---|
[f97d5f6] | 168 | and wayland-server-protocol.h
|
---|
| 169 | </para>
|
---|
| 170 | <indexterm zone="wayland wayland-scanner">
|
---|
| 171 | <primary sortas="b-wayland-scanner">wayland-scanner</primary>
|
---|
| 172 | </indexterm>
|
---|
| 173 | </listitem>
|
---|
| 174 | </varlistentry>
|
---|
| 175 |
|
---|
| 176 | <varlistentry id="libwayland-client">
|
---|
| 177 | <term><filename class="libraryfile">libwayland-client.so</filename></term>
|
---|
| 178 | <listitem>
|
---|
| 179 | <para>
|
---|
| 180 | contains API functions for writing <application>Wayland</application>
|
---|
[4c24eb0a] | 181 | applications
|
---|
[f97d5f6] | 182 | </para>
|
---|
| 183 | <indexterm zone="wayland libwayland-client">
|
---|
| 184 | <primary sortas="c-libwayland-client">libwayland-client.so</primary>
|
---|
| 185 | </indexterm>
|
---|
| 186 | </listitem>
|
---|
| 187 | </varlistentry>
|
---|
| 188 |
|
---|
| 189 | <varlistentry id="libwayland-cursor">
|
---|
| 190 | <term><filename class="libraryfile">libwayland-cursor.so</filename></term>
|
---|
| 191 | <listitem>
|
---|
| 192 | <para>
|
---|
| 193 | contains API functions for managing cursors in <application>Wayland</application>
|
---|
[4c24eb0a] | 194 | applications
|
---|
[f97d5f6] | 195 | </para>
|
---|
| 196 | <indexterm zone="wayland libwayland-cursor">
|
---|
| 197 | <primary sortas="c-libwayland-cursor">libwayland-cursor.so</primary>
|
---|
| 198 | </indexterm>
|
---|
| 199 | </listitem>
|
---|
| 200 | </varlistentry>
|
---|
| 201 |
|
---|
[0a5eabf6] | 202 | <varlistentry id="libwayland-egl">
|
---|
| 203 | <term><filename class="libraryfile">libwayland-egl.so</filename></term>
|
---|
| 204 | <listitem>
|
---|
| 205 | <para>
|
---|
| 206 | contains API functions for handling OpenGL calls in
|
---|
[4c24eb0a] | 207 | <application>Wayland</application> applications
|
---|
[0a5eabf6] | 208 | </para>
|
---|
| 209 | <indexterm zone="wayland libwayland-egl">
|
---|
| 210 | <primary sortas="c-libwayland-egl">libwayland-egl.so</primary>
|
---|
| 211 | </indexterm>
|
---|
| 212 | </listitem>
|
---|
| 213 | </varlistentry>
|
---|
| 214 |
|
---|
[f97d5f6] | 215 | <varlistentry id="libwayland-server">
|
---|
| 216 | <term><filename class="libraryfile">libwayland-server.so</filename></term>
|
---|
| 217 | <listitem>
|
---|
| 218 | <para>
|
---|
| 219 | contains API functions for writing <application>Wayland</application>
|
---|
[4c24eb0a] | 220 | compositors
|
---|
[f97d5f6] | 221 | </para>
|
---|
| 222 | <indexterm zone="wayland libwayland-server">
|
---|
| 223 | <primary sortas="c-libwayland-server">libwayland-server.so</primary>
|
---|
| 224 | </indexterm>
|
---|
| 225 | </listitem>
|
---|
| 226 | </varlistentry>
|
---|
| 227 |
|
---|
| 228 | </variablelist>
|
---|
| 229 |
|
---|
| 230 | </sect2>
|
---|
| 231 |
|
---|
| 232 | </sect1>
|
---|