source: general/genlib/wayland.xml@ 7f4758b

11.0 11.1 11.2 lazarus plabs/python-mods qt5new trunk upgradedb xry111/intltool xry111/soup3 xry111/test-20220226
Last change on this file since 7f4758b was 7f4758b, checked in by Xi Ruoyao <xry111@…>, 16 months ago

wayland: meson-ize

  • Property mode set to 100644
File size: 7.1 KB
Line 
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 wayland-download-http "https://wayland.freedesktop.org/releases/wayland-&wayland-version;.tar.xz">
8 <!ENTITY wayland-download-ftp " ">
9 <!ENTITY wayland-md5sum "5d59ac3d8a8f4e42de2ceb8bb19dfca9">
10 <!ENTITY wayland-size "448 KB">
11 <!ENTITY wayland-buildsize "15 MB (with tests)">
12 <!ENTITY wayland-time "0.2 SBU (with tests)">
13]>
14
15<sect1 id="wayland" xreflabel="Wayland-&wayland-version;">
16 <?dbhtml filename="wayland.html"?>
17
18 <sect1info>
19 <date>$Date$</date>
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
37 &lfs101_checked;
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">
77 <xref linkend="libxml2"/>
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
103<screen><userinput>mkdir build &amp;&amp;
104cd build &amp;&amp;
105
106meson --prefix=/usr \
107 --buildtype=release \
108 -Ddocumentation=false &amp;&amp;
109ninja</userinput></screen>
110
111 <para>
112 To test the results, issue: <command>ninja test</command>.
113 <!-- Seems to work without X installed
114
115 If a Desktop
116 Environment has not been started that uses XDG, it's possible that 90%
117 of the test suite will fail. To rectify this, create the directory listed
118 in $XDG_RUNTIME_DIR first, if required.-->
119 </para>
120
121 <para>
122 Now, as the <systemitem class="username">root</systemitem> user:
123 </para>
124
125<screen role="root"><userinput>ninja install</userinput></screen>
126
127 </sect2>
128
129 <sect2 role="commands">
130 <title>Command Explanations</title>
131
132 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
133 href="../../xincludes/static-libraries.xml"/>
134
135 <para>
136 <parameter>--disable-documentation</parameter>: This switch is used to
137 disable building of the API documentation. Remove it if you have
138 installed optional dependencies.
139 </para>
140
141 </sect2>
142
143 <sect2 role="content">
144 <title>Contents</title>
145
146 <segmentedlist>
147 <segtitle>Installed Programs</segtitle>
148 <segtitle>Installed Libraries</segtitle>
149 <segtitle>Installed Directories</segtitle>
150
151 <seglistitem>
152 <seg>
153 wayland-scanner
154 </seg>
155 <seg>
156 libwayland-client.so,
157 libwayland-cursor.so,
158 libwayland-egl.so,
159 and libwayland-server.so
160 </seg>
161 <seg>
162 /usr/share/wayland
163 </seg>
164 </seglistitem>
165 </segmentedlist>
166
167 <variablelist>
168 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
169 <?dbfo list-presentation="list"?>
170 <?dbhtml list-presentation="table"?>
171
172 <varlistentry id="wayland-scanner">
173 <term><command>wayland-scanner</command></term>
174 <listitem>
175 <para>
176 is a tool to generate proxy methods in wayland-client-protocol.h
177 and wayland-server-protocol.h
178 </para>
179 <indexterm zone="wayland wayland-scanner">
180 <primary sortas="b-wayland-scanner">wayland-scanner</primary>
181 </indexterm>
182 </listitem>
183 </varlistentry>
184
185 <varlistentry id="libwayland-client">
186 <term><filename class="libraryfile">libwayland-client.so</filename></term>
187 <listitem>
188 <para>
189 contains API functions for writing <application>Wayland</application>
190 applications
191 </para>
192 <indexterm zone="wayland libwayland-client">
193 <primary sortas="c-libwayland-client">libwayland-client.so</primary>
194 </indexterm>
195 </listitem>
196 </varlistentry>
197
198 <varlistentry id="libwayland-cursor">
199 <term><filename class="libraryfile">libwayland-cursor.so</filename></term>
200 <listitem>
201 <para>
202 contains API functions for managing cursors in <application>Wayland</application>
203 applications
204 </para>
205 <indexterm zone="wayland libwayland-cursor">
206 <primary sortas="c-libwayland-cursor">libwayland-cursor.so</primary>
207 </indexterm>
208 </listitem>
209 </varlistentry>
210
211 <varlistentry id="libwayland-egl">
212 <term><filename class="libraryfile">libwayland-egl.so</filename></term>
213 <listitem>
214 <para>
215 contains API functions for handling OpenGL calls in
216 <application>Wayland</application> applications
217 </para>
218 <indexterm zone="wayland libwayland-egl">
219 <primary sortas="c-libwayland-egl">libwayland-egl.so</primary>
220 </indexterm>
221 </listitem>
222 </varlistentry>
223
224 <varlistentry id="libwayland-server">
225 <term><filename class="libraryfile">libwayland-server.so</filename></term>
226 <listitem>
227 <para>
228 contains API functions for writing <application>Wayland</application>
229 compositors
230 </para>
231 <indexterm zone="wayland libwayland-server">
232 <primary sortas="c-libwayland-server">libwayland-server.so</primary>
233 </indexterm>
234 </listitem>
235 </varlistentry>
236
237 </variablelist>
238
239 </sect2>
240
241</sect1>
Note: See TracBrowser for help on using the repository browser.