source: gnome/platform/mutter.xml@ 790c36c

lazarus trunk
Last change on this file since 790c36c was 790c36c, checked in by Xi Ruoyao <xry111@…>, 3 months ago

mutter: Add libdisplay-info as optional dependency

  • Property mode set to 100644
File size: 12.4 KB
Line 
1<?xml version="1.0" encoding="UTF-8"?>
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 " ">
9 <!ENTITY mutter-md5sum "74e84722518707c0768f9753fc3492d7">
10 <!ENTITY mutter-size "2.8 MB">
11 <!ENTITY mutter-buildsize "70 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 &lfs121_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 &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 <!-- sorted as "d" instead of "p" -->
108 <xref linkend="python-dbusmock"/> (required for tests),
109 <xref linkend="libdisplay-info"/>,
110 <!--<xref linkend="sysprof"/>,-->
111 <xref linkend="xorg-server"/> (for X11 sessions), and
112 <ulink url="&sysprof-url;">sysprof</ulink>
113 </para>
114
115 <!-- NOTE: Mutter compiles shipped Cogl and Clutter for it's own
116 internal use. This is because upstream have decided that Cogl and
117 Clutter should be only used by Mutter in the future, so the development
118 of Cogl and Clutter is now performed in the Mutter repository. The
119 "standalone" Cogl and Clutter are considered obsolete now and we have
120 archived them. -->
121
122 </sect2>
123
124 <sect2 role="installation">
125 <title>Installation of Mutter</title>
126
127 <para>
128 Install <application>Mutter</application> by running the following
129 commands:
130 </para>
131
132<screen><userinput>mkdir build &amp;&amp;
133cd build &amp;&amp;
134
135meson setup --prefix=/usr \
136 --buildtype=release \
137 -Dtests=false \
138 -Dprofiler=false \
139 .. &amp;&amp;
140ninja</userinput></screen>
141
142<!--
143 <para>
144 To test the results, issue:
145 <command>dbus-run-session ninja test</command>. The tests
146 require an active X session to run correctly. It is not necessary to
147 run a separate D-bus session if not in a GNOME session, but it
148 provides a clean environment in any case. One test,
149 <filename>native-headless</filename>, is known to fail.
150 </para>
151 -->
152 <!-- there are no added problems in sysv, AFAICT. Running the tests is
153 not easy whatever the init system. But using the instructions below in
154 a gnome session on sysv works (no test failure)...
155 <para revision='sysv'>
156 This package does not come with a test suite that runs properly in the
157 SystemV environment.
158 </para>
159 -->
160
161 <para>
162 The test suite requires an
163 external program called <command>xvfb-run</command>. If you wish to run
164 the tests, you should download and install it before running
165 <command>meson</command>.
166
167 You can obtain it from <ulink
168 url="&sources-anduin-http;/mutter/xvfb-run">xvfb-run</ulink>, and install
169 it with executable permissions in <filename
170 class="directory">/usr/bin</filename>. <command>xvfb-run</command> needs
171 <command>Xvfb</command> at runtime, and <command>Xvfb</command> can be
172 installed from either <xref linkend='xorg-server'/> or <xref
173 linkend='xwayland'/>.
174
175 You should also replace <parameter>-Dtests=false</parameter> in the
176 <command>meson</command> command, with
177 <parameter>-Dtests=true -Dclutter_tests=false</parameter>. The test
178 suite requires the mutter schema to be installed on the system, so it is
179 better to run the tests after installing the package.
180 </para>
181
182 <para>
183 You can also test basic functions of <application>Mutter</application>
184 following <xref linkend='mutter-starting'/>, after installing it.
185 </para>
186
187 <para>
188 Now, as the <systemitem class="username">root</systemitem> user:
189 </para>
190
191<screen role="root"><userinput>ninja install</userinput></screen>
192
193 <para>
194 If you wish to run the tests, remove the reference to
195 <application>Zenity</application> which is not a part of BLFS
196 from one test:
197 </para>
198
199<screen role='test'><userinput>sed 's/zenity --[a-z]*/gtk4-demo/' -i ../src/tests/x11-test.sh</userinput></screen>
200
201 <para>
202 Now run the test suite:
203 </para>
204
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 <parameter>--buildtype=release</parameter>.
248 </para>
249
250 <para>
251 <option>-Dlibdisplay_info=true</option>: Use this switch for the
252 <command>meson setup</command> command if you've installed
253 <xref linkend='libdisplay-info'/> and you want to use it for mutter
254 to improve the monitor EDID parsing.
255 </para>
256
257 </sect2>
258
259 <sect2 role="starting" id="mutter-starting">
260 <title>Starting Mutter</title>
261
262 <!-- Mutter as a Wayland compositor works with recent mutter releases.
263 IIRC mutter can also be used as a X window manager: just replace
264 "twm" with "mutter &dash;&dash;x11" in xinitrc. But I've not tested
265 such a configuration recently (I don't build Xorg Server or xinit
266 these days. -->
267
268 <para>
269 <application>Mutter</application> is normally used as a component of
270 <application>gnome-shell</application>, but it can be used as a
271 standalone Wayland compositor too. To run
272 <application>Mutter</application> as a Wayland compositor, in a
273 virtual console, issue:
274 </para>
275
276 <screen role='nodump'><userinput>mutter --wayland -- vte-2.91</userinput></screen>
277
278 <para>
279 Replace <command>vte-2.91</command> with the command line for the
280 first application you want in the Wayland session. Note that once this
281 application exits, the Wayland session will be terminated.
282 </para>
283
284 <para>
285 <application>Mutter</application> can also function as a nested
286 compositor in another Wayland session. In a terminal emulator, issue:
287 </para>
288
289 <screen role='nodump'><userinput>MUTTER_DEBUG_DUMMY_MODE_SPECS=1920x1080 mutter --wayland --nested -- vte-2.91</userinput></screen>
290
291 <para>
292 Replace <replaceable>1920x1080</replaceable> with the size you want
293 for the nested Wayland session.
294 </para>
295 </sect2>
296
297 <sect2 role="content">
298 <title>Contents</title>
299
300 <segmentedlist>
301 <segtitle>Installed Programs</segtitle>
302 <segtitle>Installed Libraries</segtitle>
303 <segtitle>Installed Directories</segtitle>
304
305 <seglistitem>
306 <seg>
307 mutter
308 </seg>
309 <seg>
310 libmutter-13.so and libmutter-test-13.so (optional)
311 </seg>
312 <seg>
313 /usr/{lib,include,libexec/installed-tests,share/{,installed-tests}}/mutter-13
314 </seg>
315 </seglistitem>
316 </segmentedlist>
317
318 <variablelist>
319 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
320 <?dbfo list-presentation="list"?>
321 <?dbhtml list-presentation="table"?>
322
323 <varlistentry id="mutter-prog">
324 <term><command>mutter</command></term>
325 <listitem>
326 <para>
327 is a <application>Clutter</application> based compositing
328 <application>GTK+</application> Window Manager
329 </para>
330 <indexterm zone="mutter mutter-prog">
331 <primary sortas="b-mutter">mutter</primary>
332 </indexterm>
333 </listitem>
334 </varlistentry>
335
336 <varlistentry id="libmutter">
337 <term><filename class="libraryfile">libmutter-13.so</filename></term>
338 <listitem>
339 <para>
340 contains the <application>Mutter</application> API functions
341 </para>
342 <indexterm zone="mutter libmutter">
343 <primary sortas="c-libmutter">libmutter-13.so</primary>
344 </indexterm>
345 </listitem>
346 </varlistentry>
347
348 <varlistentry id="libmutter-test">
349 <term><filename class="libraryfile">libmutter-test-13.so</filename></term>
350 <listitem>
351 <para>
352 contains the <application>Mutter</application> test suite API
353 functions; this library is only installed if the test suite of
354 this package is enabled and it is needed by
355 <application>gnome-shell</application> test suite
356 </para>
357 <indexterm zone="mutter libmutter-test">
358 <primary sortas="c-libmutter-test">libmutter-test-13.so</primary>
359 </indexterm>
360 </listitem>
361 </varlistentry>
362
363 </variablelist>
364
365 </sect2>
366
367</sect1>
Note: See TracBrowser for help on using the repository browser.