[2e704d1b] | 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 |
|
---|
[185b3090] | 7 | <!ENTITY mutter-download-http "&gnome-download-http;/mutter/&gnome-42;/mutter-&mutter-version;.tar.xz">
|
---|
| 8 | <!ENTITY mutter-download-ftp "&gnome-download-ftp;/mutter/&gnome-42;/mutter-&mutter-version;.tar.xz">
|
---|
[8b152256] | 9 | <!ENTITY mutter-md5sum "bc8f44439f4a524af590e3bff9f0a715">
|
---|
[1a8fb18] | 10 | <!ENTITY mutter-size "2.6 MB">
|
---|
[8b152256] | 11 | <!ENTITY mutter-buildsize "60 MB (without tests)">
|
---|
| 12 | <!ENTITY mutter-time "0.5 SBU (Using parallelism=4)">
|
---|
| 13 | <!ENTITY mutter-time-systemd "0.5 SBU (Using parallelism=4, add 1.0 SBU for tests)">
|
---|
[2e704d1b] | 14 | ]>
|
---|
| 15 |
|
---|
[51dfb3e] | 16 | <sect1 id="mutter" xreflabel="Mutter-&mutter-version;">
|
---|
[2e704d1b] | 17 | <?dbhtml filename="mutter.html"?>
|
---|
| 18 |
|
---|
| 19 | <sect1info>
|
---|
| 20 | <date>$Date$</date>
|
---|
| 21 | </sect1info>
|
---|
| 22 |
|
---|
| 23 | <title>Mutter-&mutter-version;</title>
|
---|
| 24 |
|
---|
| 25 | <indexterm zone="mutter">
|
---|
| 26 | <primary sortas="a-Mutter">Mutter</primary>
|
---|
| 27 | </indexterm>
|
---|
| 28 |
|
---|
| 29 | <sect2 role="package">
|
---|
| 30 | <title>Introduction to Mutter</title>
|
---|
| 31 |
|
---|
| 32 | <para>
|
---|
| 33 | <application>Mutter</application> is the window manager for
|
---|
| 34 | <application>GNOME</application>. It is not invoked directly,
|
---|
| 35 | but from <application>GNOME Session</application> (on a
|
---|
| 36 | machine with a hardware accelerated video driver).
|
---|
| 37 | </para>
|
---|
| 38 |
|
---|
[9499bbf] | 39 | &lfs111_checked;
|
---|
[2e704d1b] | 40 |
|
---|
| 41 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 42 | <itemizedlist spacing="compact">
|
---|
| 43 | <listitem>
|
---|
| 44 | <para>
|
---|
| 45 | Download (HTTP): <ulink url="&mutter-download-http;"/>
|
---|
| 46 | </para>
|
---|
| 47 | </listitem>
|
---|
| 48 | <listitem>
|
---|
| 49 | <para>
|
---|
| 50 | Download (FTP): <ulink url="&mutter-download-ftp;"/>
|
---|
| 51 | </para>
|
---|
| 52 | </listitem>
|
---|
| 53 | <listitem>
|
---|
| 54 | <para>
|
---|
| 55 | Download MD5 sum: &mutter-md5sum;
|
---|
| 56 | </para>
|
---|
| 57 | </listitem>
|
---|
| 58 | <listitem>
|
---|
| 59 | <para>
|
---|
| 60 | Download size: &mutter-size;
|
---|
| 61 | </para>
|
---|
| 62 | </listitem>
|
---|
| 63 | <listitem>
|
---|
| 64 | <para>
|
---|
| 65 | Estimated disk space required: &mutter-buildsize;
|
---|
| 66 | </para>
|
---|
| 67 | </listitem>
|
---|
[8b152256] | 68 | <listitem revision='sysv'>
|
---|
[2e704d1b] | 69 | <para>
|
---|
| 70 | Estimated build time: &mutter-time;
|
---|
| 71 | </para>
|
---|
| 72 | </listitem>
|
---|
[8b152256] | 73 | <listitem revision='systemd'>
|
---|
| 74 | <para>
|
---|
| 75 | Estimated build time: &mutter-time-systemd;
|
---|
| 76 | </para>
|
---|
| 77 | </listitem>
|
---|
[2e704d1b] | 78 | </itemizedlist>
|
---|
[a0ed916] | 79 | <!--
|
---|
[aa17ca8] | 80 | <bridgehead renderas="sect3">Additional Downloads</bridgehead>
|
---|
| 81 | <itemizedlist spacing="compact">
|
---|
| 82 | <listitem>
|
---|
| 83 | <para>
|
---|
[185b3090] | 84 | Recommended patch:
|
---|
| 85 | <ulink url="&patch-root;/mutter-&mutter-version;-consolidated_fixes-1.patch"/>
|
---|
[aa17ca8] | 86 | </para>
|
---|
| 87 | </listitem>
|
---|
| 88 | </itemizedlist>
|
---|
[a0ed916] | 89 | -->
|
---|
[2e704d1b] | 90 | <bridgehead renderas="sect3">Mutter Dependencies</bridgehead>
|
---|
| 91 |
|
---|
| 92 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
| 93 | <para role="required">
|
---|
[53134b6f] | 94 | <!-- now using internal shipped clutter and cogl copies -->
|
---|
| 95 | <!-- <xref linkend="clutter"/>, -->
|
---|
[5d1a066] | 96 | <xref linkend="gnome-settings-daemon"/>,
|
---|
[2c80efe] | 97 | <xref linkend="graphene"/>,
|
---|
[88e7954] | 98 | <xref linkend="libxcvt"/>,
|
---|
[2e704d1b] | 99 | <xref linkend="libxkbcommon"/>,
|
---|
[4cf64fb] | 100 | <xref linkend="pipewire"/>, and
|
---|
[2e704d1b] | 101 | <xref linkend="zenity"/>
|
---|
| 102 | </para>
|
---|
| 103 |
|
---|
| 104 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
| 105 | <para role="recommended">
|
---|
[078db5b6] | 106 | <xref linkend="desktop-file-utils"/>,
|
---|
[3d3560c5] | 107 | <xref linkend="gobject-introspection"/>,
|
---|
| 108 | <xref linkend="startup-notification"/>, and
|
---|
| 109 | <xref linkend="sysprof"/>
|
---|
[2e704d1b] | 110 | </para>
|
---|
| 111 |
|
---|
| 112 | <bridgehead renderas="sect4">Recommended (Required to
|
---|
| 113 | build the Wayland compositor)</bridgehead>
|
---|
| 114 | <para role="recommended">
|
---|
| 115 | <xref linkend="libinput"/>,
|
---|
[8558044] | 116 | <xref linkend="wayland"/>,
|
---|
[2e704d1b] | 117 | <xref linkend="wayland-protocols"/>, and
|
---|
[88e7954] | 118 | <xref linkend="xwayland"/>.
|
---|
[4f5369a] | 119 | Additionally, <xref linkend="gtk3"/> needs to be built with
|
---|
[2e704d1b] | 120 | <application>Wayland</application> support.
|
---|
| 121 | </para>
|
---|
| 122 |
|
---|
[2126b9e] | 123 | <bridgehead renderas="sect4"
|
---|
| 124 | revision="sysv">Recommended (Runtime)</bridgehead>
|
---|
| 125 | <para role="recommended" revision="sysv">
|
---|
| 126 | <xref linkend="blocaled" role="runtime"/>
|
---|
| 127 | </para>
|
---|
| 128 |
|
---|
[88e7954] | 129 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
| 130 | <para role="optional">
|
---|
| 131 | <xref linkend="xorg-server"/> (for X11 sessions)
|
---|
| 132 | </para>
|
---|
| 133 |
|
---|
[dcea4e3] | 134 | <!-- NOTE: Mutter compiles git versions of COGL and Clutter for it's own
|
---|
| 135 | internal use. This is because the wayland support upstream isn't advanced
|
---|
| 136 | enough for the graphics stack used in Mutter. -->
|
---|
[0129a2f5] | 137 |
|
---|
[2e704d1b] | 138 | <para condition="html" role="usernotes">User Notes:
|
---|
| 139 | <ulink url="&blfs-wiki;/mutter"/>
|
---|
| 140 | </para>
|
---|
| 141 |
|
---|
| 142 | </sect2>
|
---|
| 143 |
|
---|
| 144 | <sect2 role="installation">
|
---|
| 145 | <title>Installation of Mutter</title>
|
---|
[a0ed916] | 146 | <!--
|
---|
[1a8fb18] | 147 | <para>
|
---|
[185b3090] | 148 | First, apply a patch that fixes annoying bugs found after GNOME 42
|
---|
| 149 | release:
|
---|
[1a8fb18] | 150 | </para>
|
---|
| 151 |
|
---|
[185b3090] | 152 | <screen><userinput>patch -Np1 -i ../mutter-&mutter-version;-consolidated_fixes-1.patch</userinput></screen>
|
---|
[a0ed916] | 153 | -->
|
---|
[2e704d1b] | 154 | <para>
|
---|
| 155 | Install <application>Mutter</application> by running the following
|
---|
| 156 | commands:
|
---|
| 157 | </para>
|
---|
| 158 |
|
---|
[dcea4e3] | 159 | <screen><userinput>mkdir build &&
|
---|
[77fb6ffc] | 160 | cd build &&
|
---|
[dcea4e3] | 161 |
|
---|
[69f58f5e] | 162 | meson --prefix=/usr --buildtype=release -Dtests=false .. &&
|
---|
[dcea4e3] | 163 | ninja</userinput></screen>
|
---|
[2e704d1b] | 164 |
|
---|
[477bc4a] | 165 | <!--
|
---|
[2e704d1b] | 166 | <para>
|
---|
[74db4f4] | 167 | To test the results, issue:
|
---|
| 168 | <command>dbus-run-session ninja test</command>. The tests
|
---|
| 169 | require an active X session to run correctly. It is not necessary to
|
---|
| 170 | run a separate D-bus session if not in a GNOME session, but it
|
---|
[1a8fb18] | 171 | provides a clean environment in any case. One test,
|
---|
| 172 | <filename>native-headless</filename>, is known to fail.
|
---|
[2e704d1b] | 173 | </para>
|
---|
[477bc4a] | 174 | -->
|
---|
[8b152256] | 175 | <para revision='sysv'>
|
---|
| 176 | This package does not come ith a test suite that runs properly in the
|
---|
| 177 | SystemV environment.
|
---|
[477bc4a] | 178 | </para>
|
---|
[6344e46] | 179 |
|
---|
[8b152256] | 180 | <para revision='systemd'>
|
---|
| 181 |
|
---|
| 182 | The test suite requires debug functions to be enabled in the build, and an
|
---|
| 183 | external program called <command>xvfb-run</command>. If you wish to run
|
---|
| 184 | the tests, you should download and install it before running
|
---|
| 185 | <command>meson</command>.
|
---|
| 186 |
|
---|
| 187 | You can obtain it from <ulink
|
---|
| 188 | url="&sources-anduin-http;/mutter/xvfb-run">xvfb-run</ulink>, and install
|
---|
| 189 | it with executable permissions in <filename
|
---|
| 190 | class="directory">/usr/bin</filename>. <command>xvfb-run</command> needs
|
---|
| 191 | <command>Xvfb</command> at runtime, and <command>Xvfb</command> can be
|
---|
| 192 | installed from either <xref linkend='xorg-server'/> or <xref
|
---|
| 193 | linkend='xwayland'/>.
|
---|
| 194 |
|
---|
| 195 | You should also replace the <parameter>--buildtype=release
|
---|
| 196 | -Dtests=false</parameter> in the <command>meson</command> command, with
|
---|
| 197 | <parameter>--buildtype=debugoptimized -Dtests=true</parameter>. The test
|
---|
| 198 | suite requires the mutter schema to be installed on the system, so it is
|
---|
| 199 | better to run the tests after installing the package. </para>
|
---|
| 200 |
|
---|
[2e704d1b] | 201 | <para>
|
---|
| 202 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 203 | </para>
|
---|
| 204 |
|
---|
[dcea4e3] | 205 | <screen role="root"><userinput>ninja install</userinput></screen>
|
---|
[2e704d1b] | 206 |
|
---|
[8b152256] | 207 | <para revision='systemd'>
|
---|
[185b3090] | 208 | The tests can now be run: issue
|
---|
[8b152256] | 209 | <command>ninja test</command>. Note that the tests
|
---|
| 210 | require an active X session and run best in an existing
|
---|
| 211 | GNOME environment.
|
---|
| 212 | The <filename>native-unit</filename> is known to fail.
|
---|
[34726a0] | 213 | </para>
|
---|
[2e704d1b] | 214 | </sect2>
|
---|
| 215 |
|
---|
[adf17153] | 216 | <sect2 role="commands">
|
---|
| 217 | <title>Command Explanations</title>
|
---|
| 218 |
|
---|
[69f58f5e] | 219 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 220 | href="../../xincludes/meson-buildtype-release.xml"/>
|
---|
[1ff2d21] | 221 |
|
---|
[3592a6e] | 222 | <para>
|
---|
| 223 | <parameter>-Dtests=false</parameter>: Prevents building the tests,
|
---|
[185b3090] | 224 | and removes a hard requirement on <command>xvfb-run</command>.
|
---|
[3592a6e] | 225 | </para>
|
---|
| 226 |
|
---|
[1ff2d21] | 227 | <para>
|
---|
| 228 | <option>-Dprofiler=false</option>: Use this option if
|
---|
| 229 | <application>Sysprof</application> is not installed, and you don't
|
---|
| 230 | want meson to download <application>Sysprof</application> source
|
---|
| 231 | code.
|
---|
| 232 | </para>
|
---|
[477bc4a] | 233 |
|
---|
[adf17153] | 234 | </sect2>
|
---|
| 235 |
|
---|
[2e704d1b] | 236 | <sect2 role="content">
|
---|
| 237 | <title>Contents</title>
|
---|
| 238 |
|
---|
| 239 | <segmentedlist>
|
---|
| 240 | <segtitle>Installed Programs</segtitle>
|
---|
| 241 | <segtitle>Installed Libraries</segtitle>
|
---|
| 242 | <segtitle>Installed Directories</segtitle>
|
---|
| 243 |
|
---|
| 244 | <seglistitem>
|
---|
| 245 | <seg>
|
---|
| 246 | mutter
|
---|
| 247 | </seg>
|
---|
| 248 | <seg>
|
---|
[185b3090] | 249 | libmutter-10.so
|
---|
[2e704d1b] | 250 | </seg>
|
---|
| 251 | <seg>
|
---|
[185b3090] | 252 | /usr/{lib,include,libexec/installed-tests,share/{,installed-tests}}/mutter-10
|
---|
[2e704d1b] | 253 | </seg>
|
---|
| 254 | </seglistitem>
|
---|
| 255 | </segmentedlist>
|
---|
| 256 |
|
---|
| 257 | <variablelist>
|
---|
| 258 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 259 | <?dbfo list-presentation="list"?>
|
---|
| 260 | <?dbhtml list-presentation="table"?>
|
---|
| 261 |
|
---|
| 262 | <varlistentry id="mutter-prog">
|
---|
| 263 | <term><command>mutter</command></term>
|
---|
| 264 | <listitem>
|
---|
| 265 | <para>
|
---|
| 266 | is a <application>Clutter</application> based compositing
|
---|
[4c24eb0a] | 267 | <application>GTK+</application> Window Manager
|
---|
[2e704d1b] | 268 | </para>
|
---|
| 269 | <indexterm zone="mutter mutter-prog">
|
---|
| 270 | <primary sortas="b-mutter">mutter</primary>
|
---|
| 271 | </indexterm>
|
---|
| 272 | </listitem>
|
---|
| 273 | </varlistentry>
|
---|
| 274 |
|
---|
| 275 | <varlistentry id="libmutter">
|
---|
[f1cb793] | 276 | <term><filename class="libraryfile">libmutter-9.so</filename></term>
|
---|
[2e704d1b] | 277 | <listitem>
|
---|
| 278 | <para>
|
---|
[4c24eb0a] | 279 | contains the <application>Mutter</application> API functions
|
---|
[2e704d1b] | 280 | </para>
|
---|
| 281 | <indexterm zone="mutter libmutter">
|
---|
[f1cb793] | 282 | <primary sortas="c-libmutter">libmutter-9.so</primary>
|
---|
[2e704d1b] | 283 | </indexterm>
|
---|
| 284 | </listitem>
|
---|
| 285 | </varlistentry>
|
---|
| 286 |
|
---|
| 287 | </variablelist>
|
---|
| 288 |
|
---|
| 289 | </sect2>
|
---|
| 290 |
|
---|
| 291 | </sect1>
|
---|