source: x/lib/clutter.xml@ 57721d3

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 57721d3 was 57721d3, checked in by Douglas R. Reno <renodr@…>, 17 months ago

Clutter: tests will hang if not run at -j1.

  • Property mode set to 100644
File size: 6.8 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 clutter-download-http "&gnome-download-http;/clutter/1.26/clutter-&clutter-version;.tar.xz">
8 <!ENTITY clutter-download-ftp "&gnome-download-ftp;/clutter/1.26/clutter-&clutter-version;.tar.xz">
9 <!ENTITY clutter-md5sum "624dd776a5159de0267587b1df6b97b2">
10 <!ENTITY clutter-size "5.2 MB">
11 <!ENTITY clutter-buildsize "93 MB (with tests)">
12 <!ENTITY clutter-time "0.7 SBU (Using parallelism=4; with tests)">
13]>
14
15<sect1 id="clutter" xreflabel="Clutter-&clutter-version;">
16 <?dbhtml filename="clutter.html"?>
17
18 <sect1info>
19 <date>$Date$</date>
20 </sect1info>
21
22 <title>Clutter-&clutter-version;</title>
23
24 <indexterm zone="clutter">
25 <primary sortas="a-Clutter">Clutter</primary>
26 </indexterm>
27
28 <sect2 role="package">
29 <title>Introduction to Clutter</title>
30
31 <para>
32 The <application>Clutter</application> package contains an open
33 source software library used for creating fast, visually rich
34 and animated graphical user interfaces.
35 </para>
36
37 &lfs101_checked;
38
39 <note>
40 <para>
41 Anything built with this toolkit needs hardware 3D acceleration from
42 the graphics driver at runtime. This is provided by
43 <application>Mesa</application> (or by proprietary graphics drivers),
44 but is not available for every graphics card nor for all virtual
45 machines. You may wish to review <xref linkend="checking-dri"/>.
46 </para>
47 </note>
48
49 <bridgehead renderas="sect3">Package Information</bridgehead>
50 <itemizedlist spacing="compact">
51 <listitem>
52 <para>
53 Download (HTTP): <ulink url="&clutter-download-http;"/>
54 </para>
55 </listitem>
56 <listitem>
57 <para>
58 Download (FTP): <ulink url="&clutter-download-ftp;"/>
59 </para>
60 </listitem>
61 <listitem>
62 <para>
63 Download MD5 sum: &clutter-md5sum;
64 </para>
65 </listitem>
66 <listitem>
67 <para>
68 Download size: &clutter-size;
69 </para>
70 </listitem>
71 <listitem>
72 <para>
73 Estimated disk space required: &clutter-buildsize;
74 </para>
75 </listitem>
76 <listitem>
77 <para>
78 Estimated build time: &clutter-time;
79 </para>
80 </listitem>
81 </itemizedlist>
82
83 <bridgehead renderas="sect3">Clutter Dependencies</bridgehead>
84
85 <bridgehead renderas="sect4">Required</bridgehead>
86 <para role="required">
87 <xref linkend="atk"/>,
88 <xref linkend="cogl"/>, and
89 <xref linkend="json-glib"/>
90 </para>
91
92 <bridgehead renderas="sect4">Recommended</bridgehead>
93 <para role="recommended">
94 <xref linkend="gobject-introspection"/>,
95 <xref linkend="gtk3"/>,
96 <xref linkend="libgudev"/>,
97 <xref linkend="libinput"/>,
98 <xref linkend="libxkbcommon"/>, and
99 <xref linkend="wayland"/>
100 </para>
101
102 <bridgehead renderas="sect4">Optional</bridgehead>
103 <para role="optional">
104 <xref linkend="gtk-doc"/> and
105 <ulink url="https://github.com/kergoth/tslib">Tslib</ulink>
106 </para>
107
108 <para condition="html" role="usernotes">User Notes:
109 <ulink url="&blfs-wiki;/clutter"/>
110 </para>
111 </sect2>
112
113 <sect2 role="installation">
114 <title>Installation of Clutter</title>
115<!--
116 <para>
117 If you wish to run the tests, the following commands disable two tests
118 that fail.
119 </para>
120
121<screen><userinput>sed -i '/actor-offscreen-redirect/d' \
122 tests/conform/Makefile.am tests/conform/Makefile.in &amp;&amp;
123autoreconf -f -i</userinput></screen>
124-->
125 <para>
126 Install <application>Clutter</application> by running the following
127 commands:
128 </para>
129
130<screen><userinput>./configure --prefix=/usr \
131 --sysconfdir=/etc \
132 --enable-egl-backend \
133 --enable-evdev-input \
134 --enable-wayland-backend \
135 --enable-wayland-compositor &amp;&amp;
136make</userinput></screen>
137
138 <para>
139 To test the results, issue: <command>make -j1 -k check</command> (you must be
140 in an xterm or similar to do this, because it launches some windows).
141 <!-- The tests will hang if run at more than -j1.-->
142 <!-- The test named actor-offscreen-redirect may hang.-->
143 <!-- Two tests have been observed to indicate ERROR, but each is flagged twice.
144 For version 1.26.4 all tests pass. -->
145 </para>
146
147 <para>
148 Now, as the <systemitem class="username">root</systemitem> user:
149 </para>
150
151<screen role="root"><userinput>make install</userinput></screen>
152
153 </sect2>
154
155 <sect2 role="commands">
156 <title>Command Explanations</title>
157
158 <para>
159 <parameter>--enable-egl-backend</parameter>: This switch enables
160 the experimental EGL windowing backend.
161 </para>
162
163 <para>
164 <parameter>--enable-evdev-input</parameter>: This switch enables
165 the experimental Evdev input backend which is required for
166 <application>GNOME</application> Wayland support.
167 </para>
168
169 <para>
170 <parameter>--enable-wayland-backend</parameter> and
171 <parameter>--enable-wayland-compositor</parameter>: These
172 switches enable the experimental <application>Wayland</application> API
173 in <application>Clutter</application> which is required for
174 <application>GNOME</application> Wayland support.
175 </para>
176
177 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
178 href="../../xincludes/gtk-doc-rebuild.xml"/>
179
180 </sect2>
181
182 <sect2 role="content">
183 <title>Contents</title>
184
185 <segmentedlist>
186 <segtitle>Installed Programs</segtitle>
187 <segtitle>Installed Library</segtitle>
188 <segtitle>Installed Directories</segtitle>
189
190 <seglistitem>
191 <seg>
192 None
193 </seg>
194 <seg>
195 libclutter-1.0.so and libclutter-glx-1.0.so
196 </seg>
197 <seg>
198 /usr/include/clutter-1.0 and
199 /usr/share/gtk-doc/html/{cally,clutter}
200 </seg>
201 </seglistitem>
202 </segmentedlist>
203
204 <variablelist>
205 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
206 <?dbfo list-presentation="list"?>
207 <?dbhtml list-presentation="table"?>
208
209 <varlistentry id="libclutter-1">
210 <term><filename class="libraryfile">libclutter-1.0.so</filename></term>
211 <listitem>
212 <para>
213 contains the <application>Clutter</application> API functions
214 </para>
215 <indexterm zone="clutter libclutter-1">
216 <primary sortas="c-libclutter-1">libclutter-1.0.so</primary>
217 </indexterm>
218 </listitem>
219 </varlistentry>
220
221 </variablelist>
222
223 </sect2>
224
225</sect1>
Note: See TracBrowser for help on using the repository browser.