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