source: gnome/platform/gnome-shell.xml@ 00bb36f7

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

  <!ENTITY gnome-shell-download-http
           "&gnome-download-http;/gnome-shell/&gnome-43;/gnome-shell-&gnome-shell-version;.tar.xz">
  <!ENTITY gnome-shell-download-ftp
           "&gnome-download-ftp;/gnome-shell/&gnome-43;/gnome-shell-&gnome-shell-version;.tar.xz">
  <!ENTITY gnome-shell-md5sum        "5d0117627359b93ed27814957d2b146b">
  <!ENTITY gnome-shell-size          "1.9 MB">
  <!ENTITY gnome-shell-buildsize     "60 MB">
  <!ENTITY gnome-shell-time          "0.2 SBU (Using parallelism=4)">
  <!ENTITY gnome-shell-buildsize-systemd "60 MB (with tests)">
  <!ENTITY gnome-shell-time-systemd      "0.2 SBU (Using parallelism=4; with tests)">
]>

<sect1 id="gnome-shell" xreflabel="gnome-shell-&gnome-shell-version;">
  <?dbhtml filename="gnome-shell.html"?>


  <title>gnome-shell-&gnome-shell-version;</title>

  <indexterm zone="gnome-shell">
    <primary sortas="a-gnome-shell">gnome-shell</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to GNOME Shell</title>

    <para>
      The <application>GNOME Shell</application> is the core user interface of
      the <application>GNOME</application> Desktop environment.
    </para>

    &lfs113_checked;

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>
          Download (HTTP): <ulink url="&gnome-shell-download-http;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download (FTP): <ulink url="&gnome-shell-download-ftp;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download MD5 sum: &gnome-shell-md5sum;
        </para>
      </listitem>
      <listitem>
        <para>
          Download size: &gnome-shell-size;
        </para>
      </listitem>
      <listitem revision='sysv'>
        <para>
          Estimated disk space required: &gnome-shell-buildsize;
        </para>
      </listitem>
      <listitem revision='sysv'>
        <para>
          Estimated build time: &gnome-shell-time;
        </para>
      </listitem>
      <listitem revision='systemd'>
        <para>
          Estimated disk space required: &gnome-shell-buildsize-systemd;
        </para>
      </listitem>
      <listitem revision='systemd'>
        <para>
          Estimated build time: &gnome-shell-time-systemd;
        </para>
      </listitem>
    </itemizedlist>

    <bridgehead renderas="sect3">GNOME Shell Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="evolution-data-server"/>,
      <xref linkend="gcr4"/>,
      <xref linkend="gjs"/>,
      <xref linkend="gnome-autoar"/>,
      <xref linkend="gnome-control-center"/>,
      <xref linkend="gtk4"/>,
      <xref role="runtime" linkend="libgweather"/> (runtime),
      <xref linkend="mutter"/>,
      <xref linkend="sassc"/>,
      <xref linkend="startup-notification"/>, and
      <phrase revision="sysv"><xref role='runtime' linkend="elogind"/>
      (runtime)</phrase>
      <phrase revision="systemd"><xref role='runtime' linkend="systemd"/>
      (runtime)</phrase>
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="desktop-file-utils"/>,
      <xref linkend="gnome-bluetooth"/>,
      <xref linkend="gst10-plugins-base"/>, and
      <xref linkend="NetworkManager"/>
    </para>

    <bridgehead renderas="sect4"
                revision="sysv">Recommended (Runtime)</bridgehead>
    <para role="recommended" revision="sysv">
      <xref linkend="blocaled" role="runtime"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="gtk-doc"/> and
      <ulink url="https://github.com/scop/bash-completion">bash-completion</ulink>
    </para>

    <bridgehead renderas="sect4">Runtime Dependencies</bridgehead>
    <para role="required">
      <xref role="runtime" linkend="adwaita-icon-theme"/>,
      <xref role="runtime" linkend="dconf"/>,
      <xref role="runtime" linkend="gdm"/>,
      <xref role="runtime" linkend="gnome-backgrounds"/>, and
      <xref role="runtime" linkend="telepathy-mission-control"/>
    </para>

    <para condition="html" role="usernotes">User Notes:
      <ulink url="&blfs-wiki;/gnome-shell"/>
    </para>
  </sect2>

  <sect2 role="installation">
    <title>Installation of GNOME Shell</title>

    <para>
      Install <application>GNOME Shell</application> by running the
      following commands:
    </para>

<screen revision="sysv"><userinput>mkdir build &amp;&amp;
cd    build &amp;&amp;

meson setup --prefix=/usr       \
            --buildtype=release \
            -Dsystemd=false     \
            -Dtests=false       \
            ..                  &amp;&amp;
ninja</userinput></screen>

<screen revision="systemd"><userinput>mkdir build &amp;&amp;
cd    build &amp;&amp;

meson setup --prefix=/usr       \
            --buildtype=release \
            -Dtests=false       \
            ..                  &amp;&amp;
ninja</userinput></screen>

    <para revision='sysv'>
      This package does not come with a working test suite in a
      SystemV environment.
    </para>

    <para revision='systemd'>
      To test the results, you need to remove the
      <parameter>-Dtests=false</parameter> switch, and to have <xref
      linkend="mutter"/> compiled and installed with tests also.

      To run the tests, issue: <command>ninja test</command>. You must be
      running an X session to run the tests. Some will fail if <xref
      linkend="gdm"/> is not installed.
    </para>

    <para>
      Now, as the <systemitem class="username">root</systemitem> user:
    </para>

<screen role="root"><userinput>ninja install</userinput></screen>

  </sect2>

  <sect2 role="commands">
    <title>Command Explanations</title>

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
      href="../../xincludes/meson-buildtype-release.xml"/>

    <para revision="sysv">
      <command>patch ...</command>: This patch fixes a bug when trying to
      start an xwayland application on non systemd.
    </para>

    <para revision="sysv">
      <parameter>-Dsystemd=false</parameter>: Prevents installing systemd
      files, which are not needed in this version of BLFS.
    </para>

    <para>
      <parameter>-Dtests=false</parameter>: Remove this switch if you want
      to build the tests. But then <command>meson</command> will fail if
      <xref linkend="mutter"/> tests are not installed.
    </para>

  </sect2>

  <sect2 role="content">
    <title>Contents</title>

    <segmentedlist>
      <segtitle>Installed Programs</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>
          gnome-extensions, gnome-extensions-app, gnome-shell,
          gnome-shell-extension-prefs, gnome-shell-extension-tool,
          and gnome-shell-perf-tool
        </seg>
        <seg>
          None
        </seg>
        <seg>
          /usr/lib/gnome-shell,
          /usr/share/gnome-shell,
          /usr/share/gtk-doc/html/{shell,st} (optional), and
          /usr/share/xdg-desktop-portal/
        </seg>
      </seglistitem>
    </segmentedlist>

    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

      <varlistentry id="gnome-shell-prog">
        <term><command>gnome-shell</command></term>
        <listitem>
          <para>
            provides the core user interface functions for the
            <application>GNOME</application> 3 Desktop
          </para>
          <indexterm zone="gnome-shell gnome-shell-prog">
            <primary sortas="b-gnome-shell">gnome-shell</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>