[ec889cf3] | 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 |
|
---|
[7b638fea] | 7 | <!ENTITY clutter-download-http "&gnome-download-http;/clutter/1.26/clutter-&clutter-version;.tar.xz">
|
---|
[2bb4625] | 8 | <!ENTITY clutter-download-ftp "&gnome-download-ftp;/clutter/1.26/clutter-&clutter-version;.tar.xz">
|
---|
[716a45fb] | 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)">
|
---|
[ec889cf3] | 13 | ]>
|
---|
| 14 |
|
---|
[cd68ead6] | 15 | <sect1 id="clutter" xreflabel="Clutter-&clutter-version;">
|
---|
[ec889cf3] | 16 | <?dbhtml filename="clutter.html"?>
|
---|
| 17 |
|
---|
| 18 |
|
---|
[cd68ead6] | 19 | <title>Clutter-&clutter-version;</title>
|
---|
[ec889cf3] | 20 |
|
---|
| 21 | <indexterm zone="clutter">
|
---|
[983fc68] | 22 | <primary sortas="a-Clutter">Clutter</primary>
|
---|
[ec889cf3] | 23 | </indexterm>
|
---|
| 24 |
|
---|
| 25 | <sect2 role="package">
|
---|
[cd68ead6] | 26 | <title>Introduction to Clutter</title>
|
---|
[ec889cf3] | 27 |
|
---|
[3ee626e] | 28 | <para>
|
---|
[983fc68] | 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.
|
---|
[2001b3e] | 32 | </para>
|
---|
| 33 |
|
---|
[9d0d597f] | 34 | &lfs120_checked;
|
---|
[625d5fe5] | 35 |
|
---|
[3ee626e] | 36 | <note>
|
---|
| 37 | <para>
|
---|
[0d7900a] | 38 | Anything built with this toolkit needs hardware 3D acceleration from
|
---|
| 39 | the graphics driver at runtime. This is provided by
|
---|
[7a395d1] | 40 | <application>Mesa</application> (or by proprietary graphics drivers),
|
---|
[983fc68] | 41 | but is not available for every graphics card nor for all virtual
|
---|
| 42 | machines. You may wish to review <xref linkend="checking-dri"/>.
|
---|
[3ee626e] | 43 | </para>
|
---|
| 44 | </note>
|
---|
[a33e01ac] | 45 |
|
---|
[ec889cf3] | 46 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 47 | <itemizedlist spacing="compact">
|
---|
| 48 | <listitem>
|
---|
[3ee626e] | 49 | <para>
|
---|
| 50 | Download (HTTP): <ulink url="&clutter-download-http;"/>
|
---|
| 51 | </para>
|
---|
[ec889cf3] | 52 | </listitem>
|
---|
| 53 | <listitem>
|
---|
[3ee626e] | 54 | <para>
|
---|
| 55 | Download (FTP): <ulink url="&clutter-download-ftp;"/>
|
---|
| 56 | </para>
|
---|
[ec889cf3] | 57 | </listitem>
|
---|
| 58 | <listitem>
|
---|
[3ee626e] | 59 | <para>
|
---|
| 60 | Download MD5 sum: &clutter-md5sum;
|
---|
| 61 | </para>
|
---|
[ec889cf3] | 62 | </listitem>
|
---|
| 63 | <listitem>
|
---|
[3ee626e] | 64 | <para>
|
---|
| 65 | Download size: &clutter-size;
|
---|
| 66 | </para>
|
---|
[ec889cf3] | 67 | </listitem>
|
---|
| 68 | <listitem>
|
---|
[3ee626e] | 69 | <para>
|
---|
| 70 | Estimated disk space required: &clutter-buildsize;
|
---|
| 71 | </para>
|
---|
[ec889cf3] | 72 | </listitem>
|
---|
| 73 | <listitem>
|
---|
[3ee626e] | 74 | <para>
|
---|
| 75 | Estimated build time: &clutter-time;
|
---|
| 76 | </para>
|
---|
[ec889cf3] | 77 | </listitem>
|
---|
| 78 | </itemizedlist>
|
---|
| 79 |
|
---|
[cd68ead6] | 80 | <bridgehead renderas="sect3">Clutter Dependencies</bridgehead>
|
---|
[ec889cf3] | 81 |
|
---|
| 82 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
[cd68ead6] | 83 | <para role="required">
|
---|
[1ea1e02d] | 84 | <xref linkend="at-spi2-core"/>,
|
---|
[773db87] | 85 | <xref linkend="cogl"/>, and
|
---|
[cd68ead6] | 86 | <xref linkend="json-glib"/>
|
---|
| 87 | </para>
|
---|
| 88 |
|
---|
| 89 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
[51dfb3e] | 90 | <para role="recommended">
|
---|
[69a16457] | 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>
|
---|
[ec889cf3] | 98 |
|
---|
| 99 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
[51dfb3e] | 100 | <para role="optional">
|
---|
[69a16457] | 101 | <xref linkend="gtk-doc"/> and
|
---|
| 102 | <ulink url="https://github.com/kergoth/tslib">Tslib</ulink>
|
---|
| 103 | </para>
|
---|
[ec889cf3] | 104 |
|
---|
| 105 | </sect2>
|
---|
| 106 |
|
---|
| 107 | <sect2 role="installation">
|
---|
[983fc68] | 108 | <title>Installation of Clutter</title>
|
---|
[8e8cfd9b] | 109 | <!--
|
---|
[7c2cf8ef] | 110 | <para>
|
---|
[af21cbe2] | 111 | If you wish to run the tests, the following commands disable two tests
|
---|
[7c2cf8ef] | 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>
|
---|
[8e8cfd9b] | 118 | -->
|
---|
[3ee626e] | 119 | <para>
|
---|
[983fc68] | 120 | Install <application>Clutter</application> by running the following
|
---|
[3ee626e] | 121 | commands:
|
---|
| 122 | </para>
|
---|
[ec889cf3] | 123 |
|
---|
[51dfb3e] | 124 | <screen><userinput>./configure --prefix=/usr \
|
---|
[69a16457] | 125 | --sysconfdir=/etc \
|
---|
| 126 | --enable-egl-backend \
|
---|
| 127 | --enable-evdev-input \
|
---|
| 128 | --enable-wayland-backend \
|
---|
| 129 | --enable-wayland-compositor &&
|
---|
[ec889cf3] | 130 | make</userinput></screen>
|
---|
| 131 |
|
---|
[9d7421f] | 132 | <!-- https://gitlab.gnome.org/GNOME/clutter/-/issues/6 -->
|
---|
[3ee626e] | 133 | <para>
|
---|
[67b25ab] | 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
|
---|
[ce847a4] | 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.
|
---|
[3ee626e] | 141 | </para>
|
---|
[ec889cf3] | 142 |
|
---|
[3ee626e] | 143 | <para>
|
---|
| 144 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 145 | </para>
|
---|
[ec889cf3] | 146 |
|
---|
| 147 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
| 148 |
|
---|
| 149 | </sect2>
|
---|
| 150 |
|
---|
| 151 | <sect2 role="commands">
|
---|
| 152 | <title>Command Explanations</title>
|
---|
| 153 |
|
---|
[3ee626e] | 154 | <para>
|
---|
[7ea83d7] | 155 | <parameter>--enable-egl-backend</parameter>: This switch enables
|
---|
| 156 | the experimental EGL windowing backend.
|
---|
[3ee626e] | 157 | </para>
|
---|
[ec889cf3] | 158 |
|
---|
[bed608b0] | 159 | <para>
|
---|
[51dfb3e] | 160 | <parameter>--enable-evdev-input</parameter>: This switch enables
|
---|
[bed608b0] | 161 | the experimental Evdev input backend which is required for
|
---|
| 162 | <application>GNOME</application> Wayland support.
|
---|
| 163 | </para>
|
---|
| 164 |
|
---|
| 165 | <para>
|
---|
[7085261a] | 166 | <parameter>--enable-wayland-backend</parameter> and
|
---|
[51dfb3e] | 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
|
---|
[bed608b0] | 170 | <application>GNOME</application> Wayland support.
|
---|
| 171 | </para>
|
---|
| 172 |
|
---|
[e05cd03f] | 173 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
[3ee626e] | 174 | href="../../xincludes/gtk-doc-rebuild.xml"/>
|
---|
[ec889cf3] | 175 |
|
---|
| 176 | </sect2>
|
---|
| 177 |
|
---|
| 178 | <sect2 role="content">
|
---|
| 179 | <title>Contents</title>
|
---|
| 180 |
|
---|
| 181 | <segmentedlist>
|
---|
[7ea83d7] | 182 | <segtitle>Installed Programs</segtitle>
|
---|
[ec889cf3] | 183 | <segtitle>Installed Library</segtitle>
|
---|
| 184 | <segtitle>Installed Directories</segtitle>
|
---|
| 185 |
|
---|
| 186 | <seglistitem>
|
---|
[7ea83d7] | 187 | <seg>
|
---|
| 188 | None
|
---|
| 189 | </seg>
|
---|
[cd68ead6] | 190 | <seg>
|
---|
[0fed30eb] | 191 | libclutter-1.0.so and libclutter-glx-1.0.so
|
---|
[cd68ead6] | 192 | </seg>
|
---|
| 193 | <seg>
|
---|
[7ea83d7] | 194 | /usr/include/clutter-1.0 and
|
---|
| 195 | /usr/share/gtk-doc/html/{cally,clutter}
|
---|
[cd68ead6] | 196 | </seg>
|
---|
[ec889cf3] | 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 |
|
---|
[983fc68] | 205 | <varlistentry id="libclutter-1">
|
---|
| 206 | <term><filename class="libraryfile">libclutter-1.0.so</filename></term>
|
---|
[ec889cf3] | 207 | <listitem>
|
---|
[3ee626e] | 208 | <para>
|
---|
[4c24eb0a] | 209 | contains the <application>Clutter</application> API functions
|
---|
[3ee626e] | 210 | </para>
|
---|
[983fc68] | 211 | <indexterm zone="clutter libclutter-1">
|
---|
| 212 | <primary sortas="c-libclutter-1">libclutter-1.0.so</primary>
|
---|
[ec889cf3] | 213 | </indexterm>
|
---|
| 214 | </listitem>
|
---|
| 215 | </varlistentry>
|
---|
| 216 |
|
---|
| 217 | </variablelist>
|
---|
| 218 |
|
---|
| 219 | </sect2>
|
---|
| 220 |
|
---|
| 221 | </sect1>
|
---|