source: general/genlib/wayland.xml@ fda29e4

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 fda29e4 was fda29e4, checked in by Xi Ruoyao <xry111@…>, 19 months ago

remove hardcoded $Date: $

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