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