source: gnome/platform/mutter.xml@ adf17153

trunk
Last change on this file since adf17153 was adf17153, checked in by Xi Ruoyao <xry111@…>, 8 weeks ago

more --buildtype=release addition

  • Property mode set to 100644
File size: 7.3 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 mutter-download-http "&gnome-download-http;/mutter/&gnome-40;/mutter-&mutter-version;.tar.xz">
8 <!ENTITY mutter-download-ftp "&gnome-download-ftp;/mutter/&gnome-40;/mutter-&mutter-version;.tar.xz">
9 <!ENTITY mutter-md5sum "84beb760caa91baad7838260593e488a">
10 <!ENTITY mutter-size "2.6 MB">
11 <!ENTITY mutter-buildsize "198 MB">
12 <!ENTITY mutter-time "1.0 SBU (Using parallelism=4)">
13]>
14
15<sect1 id="mutter" xreflabel="Mutter-&mutter-version;">
16 <?dbhtml filename="mutter.html"?>
17
18 <sect1info>
19 <date>$Date$</date>
20 </sect1info>
21
22 <title>Mutter-&mutter-version;</title>
23
24 <indexterm zone="mutter">
25 <primary sortas="a-Mutter">Mutter</primary>
26 </indexterm>
27
28 <sect2 role="package">
29 <title>Introduction to Mutter</title>
30
31 <para>
32 <application>Mutter</application> is the window manager for
33 <application>GNOME</application>. It is not invoked directly,
34 but from <application>GNOME Session</application> (on a
35 machine with a hardware accelerated video driver).
36 </para>
37
38 &lfs101_checked;
39
40 <bridgehead renderas="sect3">Package Information</bridgehead>
41 <itemizedlist spacing="compact">
42 <listitem>
43 <para>
44 Download (HTTP): <ulink url="&mutter-download-http;"/>
45 </para>
46 </listitem>
47 <listitem>
48 <para>
49 Download (FTP): <ulink url="&mutter-download-ftp;"/>
50 </para>
51 </listitem>
52 <listitem>
53 <para>
54 Download MD5 sum: &mutter-md5sum;
55 </para>
56 </listitem>
57 <listitem>
58 <para>
59 Download size: &mutter-size;
60 </para>
61 </listitem>
62 <listitem>
63 <para>
64 Estimated disk space required: &mutter-buildsize;
65 </para>
66 </listitem>
67 <listitem>
68 <para>
69 Estimated build time: &mutter-time;
70 </para>
71 </listitem>
72 </itemizedlist>
73<!--
74 <bridgehead renderas="sect3">Additional Downloads</bridgehead>
75 <itemizedlist spacing="compact">
76 <listitem>
77 <para>
78 Required patch:
79 <ulink url="&patch-root;/mutter-&mutter-version;-upstream_fixes-1.patch"/>
80 </para>
81 </listitem>
82 </itemizedlist>
83-->
84 <bridgehead renderas="sect3">Mutter Dependencies</bridgehead>
85
86 <bridgehead renderas="sect4">Required</bridgehead>
87 <para role="required">
88 <!-- now using internal shipped clutter and cogl copies -->
89 <!-- <xref linkend="clutter"/>, -->
90 <xref linkend="gnome-settings-daemon"/>,
91 <xref linkend="graphene"/>,
92 <xref linkend="libxkbcommon"/>,
93 <xref linkend="pipewire"/>, and
94 <xref linkend="zenity"/>
95 </para>
96
97 <bridgehead renderas="sect4">Recommended</bridgehead>
98 <para role="recommended">
99 <xref linkend="desktop-file-utils"/>,
100 <xref linkend="gobject-introspection"/>,
101 <xref linkend="startup-notification"/>, and
102 <xref linkend="sysprof"/>
103 </para>
104
105 <bridgehead renderas="sect4">Recommended (Required to
106 build the Wayland compositor)</bridgehead>
107 <para role="recommended">
108 <xref linkend="libinput"/>,
109 <xref linkend="wayland"/>,
110 <xref linkend="wayland-protocols"/>, and
111 <xref linkend="xorg-server"/> (with <command>Xwayland</command>).
112 Additionally, <xref linkend="gtk3"/> needs to be built with
113 <application>Wayland</application> support.
114 </para>
115
116 <bridgehead renderas="sect4"
117 revision="sysv">Recommended (Runtime)</bridgehead>
118 <para role="recommended" revision="sysv">
119 <xref linkend="blocaled" role="runtime"/>
120 </para>
121
122 <!-- NOTE: Mutter compiles git versions of COGL and Clutter for it's own
123 internal use. This is because the wayland support upstream isn't advanced
124 enough for the graphics stack used in Mutter. -->
125
126 <para condition="html" role="usernotes">User Notes:
127 <ulink url="&blfs-wiki;/mutter"/>
128 </para>
129
130 </sect2>
131
132 <sect2 role="installation">
133 <title>Installation of Mutter</title>
134
135<!--
136 <para>
137 First, fix a problem with the build system and bugs with wayland sessions:
138 </para>
139
140<screen><userinput remap="pre">patch -Np1 -i ../mutter-&mutter-version;-upstream_fixes-1.patch</userinput></screen>
141-->
142
143 <para>
144 First, fix a race condition that sometimes occurs due to meson dependency
145 ordering:
146 </para>
147
148<screen><userinput remap="pre">sed -i '/libmutter_dep = declare_dependency(/a sources: mutter_built_sources,' src/meson.build</userinput></screen>
149
150 <para>
151 Install <application>Mutter</application> by running the following
152 commands:
153 </para>
154
155<screen><userinput>mkdir build &amp;&amp;
156cd build &amp;&amp;
157
158meson --prefix=/usr --buildtype=debugoptimized .. &amp;&amp;
159ninja</userinput></screen>
160
161 <para>
162 To test the results, issue:
163 <command>dbus-run-session ninja test</command>. The tests
164 require an active X session to run correctly. It is not necessary to
165 run a separate D-bus session if not in a GNOME session, but it
166 provides a clean environment in any case. One test,
167 <filename>native-headless</filename>, is known to fail.
168 </para>
169
170 <para>
171 Now, as the <systemitem class="username">root</systemitem> user:
172 </para>
173
174<screen role="root"><userinput>ninja install</userinput></screen>
175
176 </sect2>
177
178 <sect2 role="commands">
179 <title>Command Explanations</title>
180
181 <para>
182 <parameter>--buildtype=debugoptimized</parameter>: Override the
183 default buildtype (<quote>debug</quote>), which would produce
184 unoptimized binaries. The test suite of this package needs debug
185 to be enabled.
186 </para>
187 </sect2>
188
189 <sect2 role="content">
190 <title>Contents</title>
191
192 <segmentedlist>
193 <segtitle>Installed Programs</segtitle>
194 <segtitle>Installed Libraries</segtitle>
195 <segtitle>Installed Directories</segtitle>
196
197 <seglistitem>
198 <seg>
199 mutter
200 </seg>
201 <seg>
202 libmutter-8.so
203 </seg>
204 <seg>
205 /usr/{lib,include,libexec/installed-tests,share/{installed-tests}}/mutter-8
206 </seg>
207 </seglistitem>
208 </segmentedlist>
209
210 <variablelist>
211 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
212 <?dbfo list-presentation="list"?>
213 <?dbhtml list-presentation="table"?>
214
215 <varlistentry id="mutter-prog">
216 <term><command>mutter</command></term>
217 <listitem>
218 <para>
219 is a <application>Clutter</application> based compositing
220 <application>GTK+</application> Window Manager
221 </para>
222 <indexterm zone="mutter mutter-prog">
223 <primary sortas="b-mutter">mutter</primary>
224 </indexterm>
225 </listitem>
226 </varlistentry>
227
228 <varlistentry id="libmutter">
229 <term><filename class="libraryfile">libmutter-8.so</filename></term>
230 <listitem>
231 <para>
232 contains the <application>Mutter</application> API functions
233 </para>
234 <indexterm zone="mutter libmutter">
235 <primary sortas="c-libmutter">libmutter-8.so</primary>
236 </indexterm>
237 </listitem>
238 </varlistentry>
239
240 </variablelist>
241
242 </sect2>
243
244</sect1>
Note: See TracBrowser for help on using the repository browser.