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