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 mutter-download-http "&gnome-download-http;/mutter/&gnome-45;/mutter-&mutter-version;.tar.xz">
|
---|
8 | <!ENTITY mutter-download-ftp "&gnome-download-ftp;/mutter/&gnome-45;/mutter-&mutter-version;.tar.xz">
|
---|
9 | <!ENTITY mutter-md5sum "a3f9bde16ba16cfeec10f29e29be36d2">
|
---|
10 | <!ENTITY mutter-size "2.8 MB">
|
---|
11 | <!ENTITY mutter-buildsize "100 MB (with tests)">
|
---|
12 | <!ENTITY mutter-time "0.7 SBU (Using parallelism=4; add 1.4 SBU for tests)">
|
---|
13 | ]>
|
---|
14 |
|
---|
15 | <sect1 id="mutter" xreflabel="Mutter-&mutter-version;">
|
---|
16 | <?dbhtml filename="mutter.html"?>
|
---|
17 |
|
---|
18 |
|
---|
19 | <title>Mutter-&mutter-version;</title>
|
---|
20 |
|
---|
21 | <indexterm zone="mutter">
|
---|
22 | <primary sortas="a-Mutter">Mutter</primary>
|
---|
23 | </indexterm>
|
---|
24 |
|
---|
25 | <sect2 role="package">
|
---|
26 | <title>Introduction to Mutter</title>
|
---|
27 |
|
---|
28 | <para>
|
---|
29 | <application>Mutter</application> is the window manager for
|
---|
30 | <application>GNOME</application>. It is not invoked directly,
|
---|
31 | but from <application>GNOME Session</application> (on a
|
---|
32 | machine with a hardware accelerated video driver).
|
---|
33 | </para>
|
---|
34 |
|
---|
35 | &lfs120_checked;
|
---|
36 |
|
---|
37 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
38 | <itemizedlist spacing="compact">
|
---|
39 | <listitem>
|
---|
40 | <para>
|
---|
41 | Download (HTTP): <ulink url="&mutter-download-http;"/>
|
---|
42 | </para>
|
---|
43 | </listitem>
|
---|
44 | <listitem>
|
---|
45 | <para>
|
---|
46 | Download (FTP): <ulink url="&mutter-download-ftp;"/>
|
---|
47 | </para>
|
---|
48 | </listitem>
|
---|
49 | <listitem>
|
---|
50 | <para>
|
---|
51 | Download MD5 sum: &mutter-md5sum;
|
---|
52 | </para>
|
---|
53 | </listitem>
|
---|
54 | <listitem>
|
---|
55 | <para>
|
---|
56 | Download size: &mutter-size;
|
---|
57 | </para>
|
---|
58 | </listitem>
|
---|
59 | <listitem>
|
---|
60 | <para>
|
---|
61 | Estimated disk space required: &mutter-buildsize;
|
---|
62 | </para>
|
---|
63 | </listitem>
|
---|
64 | <listitem>
|
---|
65 | <para>
|
---|
66 | Estimated build time: &mutter-time;
|
---|
67 | </para>
|
---|
68 | </listitem>
|
---|
69 | </itemizedlist>
|
---|
70 |
|
---|
71 | <bridgehead renderas="sect3">Mutter Dependencies</bridgehead>
|
---|
72 |
|
---|
73 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
74 | <para role="required">
|
---|
75 | <xref linkend="gnome-settings-daemon"/>,
|
---|
76 | <xref linkend="graphene"/>,
|
---|
77 | <xref linkend="libei"/>,
|
---|
78 | <xref linkend="libxcvt"/>,
|
---|
79 | <xref linkend="libxkbcommon"/>, and
|
---|
80 | <xref linkend="pipewire"/>
|
---|
81 | </para>
|
---|
82 |
|
---|
83 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
84 | <para role="recommended">
|
---|
85 | <xref linkend="desktop-file-utils"/>,
|
---|
86 | <xref linkend="gobject-introspection"/>, and
|
---|
87 | <xref linkend="startup-notification"/>
|
---|
88 | </para>
|
---|
89 |
|
---|
90 | <bridgehead renderas="sect4">Recommended (Required to
|
---|
91 | build the Wayland compositor)</bridgehead>
|
---|
92 | <para role="recommended">
|
---|
93 | <xref linkend="libinput"/>,
|
---|
94 | <xref linkend="wayland"/>,
|
---|
95 | <xref linkend="wayland-protocols"/>, and
|
---|
96 | <xref linkend="xwayland"/>
|
---|
97 | </para>
|
---|
98 |
|
---|
99 | <bridgehead renderas="sect4"
|
---|
100 | revision="sysv">Recommended (Runtime)</bridgehead>
|
---|
101 | <para role="recommended" revision="sysv">
|
---|
102 | <xref linkend="blocaled" role="runtime"/>
|
---|
103 | </para>
|
---|
104 |
|
---|
105 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
106 | <para role="optional">
|
---|
107 | <xref linkend="python-dbusmock"/> (required for tests),
|
---|
108 | <!--<xref linkend="sysprof"/>,-->
|
---|
109 | <xref linkend="xorg-server"/> (for X11 sessions), and
|
---|
110 | <ulink url="&sysprof-url;">sysprof</ulink>
|
---|
111 | </para>
|
---|
112 |
|
---|
113 | <!-- NOTE: Mutter compiles shipped Cogl and Clutter for it's own
|
---|
114 | internal use. This is because upstream have decided that Cogl and
|
---|
115 | Clutter should be only used by Mutter in the future, so the development
|
---|
116 | of Cogl and Clutter is now performed in the Mutter repository. The
|
---|
117 | "standalone" Cogl and Clutter are considered obsolete now and we have
|
---|
118 | archived them. -->
|
---|
119 |
|
---|
120 | </sect2>
|
---|
121 |
|
---|
122 | <sect2 role="installation">
|
---|
123 | <title>Installation of Mutter</title>
|
---|
124 |
|
---|
125 | <para>
|
---|
126 | Install <application>Mutter</application> by running the following
|
---|
127 | commands:
|
---|
128 | </para>
|
---|
129 |
|
---|
130 | <screen><userinput>mkdir build &&
|
---|
131 | cd build &&
|
---|
132 |
|
---|
133 | meson setup --prefix=/usr \
|
---|
134 | --buildtype=release \
|
---|
135 | -Dtests=false \
|
---|
136 | -Dprofiler=false \
|
---|
137 | .. &&
|
---|
138 | ninja</userinput></screen>
|
---|
139 |
|
---|
140 | <!--
|
---|
141 | <para>
|
---|
142 | To test the results, issue:
|
---|
143 | <command>dbus-run-session ninja test</command>. The tests
|
---|
144 | require an active X session to run correctly. It is not necessary to
|
---|
145 | run a separate D-bus session if not in a GNOME session, but it
|
---|
146 | provides a clean environment in any case. One test,
|
---|
147 | <filename>native-headless</filename>, is known to fail.
|
---|
148 | </para>
|
---|
149 | -->
|
---|
150 | <!-- there are no added problems in sysv, AFAICT. Running the tests is
|
---|
151 | not easy whatever the init system. But using the instructions below in
|
---|
152 | a gnome session on sysv works (no test failure)...
|
---|
153 | <para revision='sysv'>
|
---|
154 | This package does not come with a test suite that runs properly in the
|
---|
155 | SystemV environment.
|
---|
156 | </para>
|
---|
157 | -->
|
---|
158 |
|
---|
159 | <para>
|
---|
160 | The test suite requires an
|
---|
161 | external program called <command>xvfb-run</command>. If you wish to run
|
---|
162 | the tests, you should download and install it before running
|
---|
163 | <command>meson</command>.
|
---|
164 |
|
---|
165 | You can obtain it from <ulink
|
---|
166 | url="&sources-anduin-http;/mutter/xvfb-run">xvfb-run</ulink>, and install
|
---|
167 | it with executable permissions in <filename
|
---|
168 | class="directory">/usr/bin</filename>. <command>xvfb-run</command> needs
|
---|
169 | <command>Xvfb</command> at runtime, and <command>Xvfb</command> can be
|
---|
170 | installed from either <xref linkend='xorg-server'/> or <xref
|
---|
171 | linkend='xwayland'/>.
|
---|
172 |
|
---|
173 | You should also replace <parameter>-Dtests=false</parameter> in the
|
---|
174 | <command>meson</command> command, with
|
---|
175 | <parameter>-Dtests=true -Dclutter_tests=false</parameter>. The test
|
---|
176 | suite requires the mutter schema to be installed on the system, so it is
|
---|
177 | better to run the tests after installing the package.
|
---|
178 | </para>
|
---|
179 |
|
---|
180 | <para>
|
---|
181 | You can also test basic functions of <application>Mutter</application>
|
---|
182 | following <xref linkend='mutter-starting'/>, after installing it.
|
---|
183 | </para>
|
---|
184 |
|
---|
185 | <para>
|
---|
186 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
187 | </para>
|
---|
188 |
|
---|
189 | <screen role="root"><userinput>ninja install</userinput></screen>
|
---|
190 |
|
---|
191 | <para>
|
---|
192 | If you wish to run the tests, remove the reference to
|
---|
193 | <application>Zenity</application> which is not a part of BLFS
|
---|
194 | from one test:
|
---|
195 | </para>
|
---|
196 |
|
---|
197 | <screen role='test'><userinput>sed 's/zenity --[a-z]*/gtk4-demo/' -i ../src/tests/x11-test.sh</userinput></screen>
|
---|
198 |
|
---|
199 | <para>
|
---|
200 | Now run the test suite:
|
---|
201 | </para>
|
---|
202 |
|
---|
203 | <!-- Without "HOME=" one test can fail with certain monitor
|
---|
204 | configuration in $HOME/.config/monitors.xml. -->
|
---|
205 | <screen role='test'><userinput>ninja test</userinput></screen>
|
---|
206 |
|
---|
207 | <para>
|
---|
208 | The tests require an active X or wayland session.
|
---|
209 | One test named
|
---|
210 | <!-- https://gitlab.gnome.org/GNOME/mutter/-/issues/2848 -->
|
---|
211 | <!--<filename>cogl-test-framebuffer-get-bits-gl3</filename> and-->
|
---|
212 | <!-- This needs a pipewire daemon running. As at Aug 2023
|
---|
213 | the method to run a pipewire daemon is not in BLFS
|
---|
214 | (but in editor notes), so claim this a known failure. -->
|
---|
215 | <filename>input-capture</filename> is known to fail.
|
---|
216 | <!-- As Xi noted in #18580, this test is flaky. -->
|
---|
217 | A few other tests may fail depending on the configuration.
|
---|
218 | Don't make any mouse or keyboard input while the test suite is
|
---|
219 | running or some tests may fail.
|
---|
220 | </para>
|
---|
221 |
|
---|
222 | </sect2>
|
---|
223 |
|
---|
224 | <sect2 role="commands">
|
---|
225 | <title>Command Explanations</title>
|
---|
226 |
|
---|
227 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
228 | href="../../xincludes/meson-buildtype-release.xml"/>
|
---|
229 |
|
---|
230 | <para>
|
---|
231 | <parameter>-Dtests=false</parameter>: Prevents building the tests,
|
---|
232 | and removes a hard requirement on <command>xvfb-run</command>.
|
---|
233 | </para>
|
---|
234 |
|
---|
235 | <para>
|
---|
236 | <parameter>-Dprofiler=false</parameter>: Allow building this package
|
---|
237 | without <application>Sysprof</application>. Remove this option if
|
---|
238 | you've installed <application>Sysprof</application> and want to
|
---|
239 | analysis the rendering performance of
|
---|
240 | <application>Mutter</application>.
|
---|
241 | </para>
|
---|
242 |
|
---|
243 | <para>
|
---|
244 | <option>-Dtests=true -Dclutter_tests=false</option>: Building all the
|
---|
245 | tests but the tests for the shipped <application>Clutter</application>
|
---|
246 | library. The <application>Clutter</application> tests are known to
|
---|
247 | fail with <option>--buildtype=release</option>.
|
---|
248 | </para>
|
---|
249 |
|
---|
250 | </sect2>
|
---|
251 |
|
---|
252 | <sect2 role="starting" id="mutter-starting">
|
---|
253 | <title>Starting Mutter</title>
|
---|
254 |
|
---|
255 | <!-- Mutter as a Wayland compositor works with recent mutter releases.
|
---|
256 | IIRC mutter can also be used as a X window manager: just replace
|
---|
257 | "twm" with "mutter ‐‐x11" in xinitrc. But I've not tested
|
---|
258 | such a configuration recently (I don't build Xorg Server or xinit
|
---|
259 | these days. -->
|
---|
260 |
|
---|
261 | <para>
|
---|
262 | <application>Mutter</application> is normally used as a component of
|
---|
263 | <application>gnome-shell</application>, but it can be used as a
|
---|
264 | standalone Wayland compositor too. To run
|
---|
265 | <application>Mutter</application> as a Wayland compositor, in a
|
---|
266 | virtual console, issue:
|
---|
267 | </para>
|
---|
268 |
|
---|
269 | <screen role='nodump'><userinput>mutter --wayland -- vte-2.91</userinput></screen>
|
---|
270 |
|
---|
271 | <para>
|
---|
272 | Replace <command>vte-2.91</command> with the command line for the
|
---|
273 | first application you want in the Wayland session. Note that once this
|
---|
274 | application exits, the Wayland session will be terminated.
|
---|
275 | </para>
|
---|
276 |
|
---|
277 | <para>
|
---|
278 | <application>Mutter</application> can also function as a nested
|
---|
279 | compositor in another Wayland session. In a terminal emulator, issue:
|
---|
280 | </para>
|
---|
281 |
|
---|
282 | <screen role='nodump'><userinput>MUTTER_DEBUG_DUMMY_MODE_SPECS=1920x1080 mutter --wayland --nested -- vte-2.91</userinput></screen>
|
---|
283 |
|
---|
284 | <para>
|
---|
285 | Replace <replaceable>1920x1080</replaceable> with the size you want
|
---|
286 | for the nested Wayland session.
|
---|
287 | </para>
|
---|
288 | </sect2>
|
---|
289 |
|
---|
290 | <sect2 role="content">
|
---|
291 | <title>Contents</title>
|
---|
292 |
|
---|
293 | <segmentedlist>
|
---|
294 | <segtitle>Installed Programs</segtitle>
|
---|
295 | <segtitle>Installed Libraries</segtitle>
|
---|
296 | <segtitle>Installed Directories</segtitle>
|
---|
297 |
|
---|
298 | <seglistitem>
|
---|
299 | <seg>
|
---|
300 | mutter
|
---|
301 | </seg>
|
---|
302 | <seg>
|
---|
303 | libmutter-13.so and libmutter-test-13.so (optional)
|
---|
304 | </seg>
|
---|
305 | <seg>
|
---|
306 | /usr/{lib,include,libexec/installed-tests,share/{,installed-tests}}/mutter-13
|
---|
307 | </seg>
|
---|
308 | </seglistitem>
|
---|
309 | </segmentedlist>
|
---|
310 |
|
---|
311 | <variablelist>
|
---|
312 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
313 | <?dbfo list-presentation="list"?>
|
---|
314 | <?dbhtml list-presentation="table"?>
|
---|
315 |
|
---|
316 | <varlistentry id="mutter-prog">
|
---|
317 | <term><command>mutter</command></term>
|
---|
318 | <listitem>
|
---|
319 | <para>
|
---|
320 | is a <application>Clutter</application> based compositing
|
---|
321 | <application>GTK+</application> Window Manager
|
---|
322 | </para>
|
---|
323 | <indexterm zone="mutter mutter-prog">
|
---|
324 | <primary sortas="b-mutter">mutter</primary>
|
---|
325 | </indexterm>
|
---|
326 | </listitem>
|
---|
327 | </varlistentry>
|
---|
328 |
|
---|
329 | <varlistentry id="libmutter">
|
---|
330 | <term><filename class="libraryfile">libmutter-13.so</filename></term>
|
---|
331 | <listitem>
|
---|
332 | <para>
|
---|
333 | contains the <application>Mutter</application> API functions
|
---|
334 | </para>
|
---|
335 | <indexterm zone="mutter libmutter">
|
---|
336 | <primary sortas="c-libmutter">libmutter-13.so</primary>
|
---|
337 | </indexterm>
|
---|
338 | </listitem>
|
---|
339 | </varlistentry>
|
---|
340 |
|
---|
341 | <varlistentry id="libmutter-test">
|
---|
342 | <term><filename class="libraryfile">libmutter-test-13.so</filename></term>
|
---|
343 | <listitem>
|
---|
344 | <para>
|
---|
345 | contains the <application>Mutter</application> test suite API
|
---|
346 | functions; this library is only installed if the test suite of
|
---|
347 | this package is enabled and it is needed by
|
---|
348 | <application>gnome-shell</application> test suite
|
---|
349 | </para>
|
---|
350 | <indexterm zone="mutter libmutter-test">
|
---|
351 | <primary sortas="c-libmutter-test">libmutter-test-13.so</primary>
|
---|
352 | </indexterm>
|
---|
353 | </listitem>
|
---|
354 | </varlistentry>
|
---|
355 |
|
---|
356 | </variablelist>
|
---|
357 |
|
---|
358 | </sect2>
|
---|
359 |
|
---|
360 | </sect1>
|
---|