source: gnome/platform/gnome-desktop.xml@ 274ac683

<?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-desktop-download-http
           "&gnome-download-http;/gnome-desktop/&gnome-44;/gnome-desktop-&gnome-desktop-version;.tar.xz">
  <!ENTITY gnome-desktop-download-ftp
           "&gnome-download-ftp;/gnome-desktop/&gnome-44;/gnome-desktop-&gnome-desktop-version;.tar.xz">
  <!ENTITY gnome-desktop-md5sum        "1f0b7281e462d6dfc8d3888fdaafd2ba">
  <!ENTITY gnome-desktop-size          "748 KB">
  <!ENTITY gnome-desktop-buildsize     "22 MB">
  <!ENTITY gnome-desktop-time          "0.2 SBU">
]>

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


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

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

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

    <para>
      The <application>GNOME Desktop</application> package contains a library
      that provides an API shared by several applications on the
      <application>GNOME</application> Desktop.
    </para>

    &lfs113_checked;

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="gsettings-desktop-schemas"/>,
      <xref linkend="gtk3"/>,
      <xref linkend="gtk4"/>,
      <xref linkend="iso-codes"/>,
      <xref linkend="libseccomp"/>,
      <xref linkend="libxml2"/>, and
      <xref linkend="xkeyboard-config"/>
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="bubblewrap"/> (needed for thumbnailers in Nautilus) and
      <xref linkend="gobject-introspection"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="gtk-doc"/>
    </para>

  </sect2>

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

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

<screen><userinput>mkdir build &amp;&amp;
cd    build &amp;&amp;

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

    <!--<para>
      To test the results, run <command>ninja test</command> from a X Terminal
      or similar. One test, <filename>wallclock-reftest</filename>, is known to
      fail due to a difference in expecations in the he_IL.UTF-8 locale.
    </para>-->
    <!-- This failure is known upstream and seems to be due to a translation
         update for the Hebrew translation. See
         https://gitlab.gnome.org/GNOME/gnome-desktop/-/issues/149 and
         https://gitlab.gnome.org/GNOME/gnome-desktop/-/merge_requests/70/
    For some reason, I cannot replicate this on my gcc-10 system.-->
    <para>
      This package does not come with a test suite.
      <!-- "no tests defined." -->
    </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"/>

<!-- no longer valid with 43
    <para>
      <option>-Dgnome_distributor="Some Name"</option>: Use this
      parameter to supply a custom name in the <quote>Distributor:</quote>
      field of the <quote>GNOME About</quote> display window.
    </para>
-->

    <para>
      <option>-Dgtk_doc=true</option>: Use this
      parameter if you wish to build the API documentation.
    </para>

    <para>
      <option>-Dinstalled_tests=true</option>: Use this
      parameter you wish to enable the installed tests.
    </para>

  </sect2>

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

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

      <seglistitem>
        <seg>
          None
        </seg>
        <seg>
          libgnome-bg-4.so,
          libgnome-desktop-3.so,
          libgnome-desktop-4.so, and
          libgnome-rr-4.so
        </seg>
        <seg>
          /usr/include/gnome-desktop-3.0,
          /usr/include/gnome-desktop-4.0,
          /usr/libexec/gnome-desktop-debug,
          /usr/share/gtk-doc/html/gnome-desktop3 (optional), and
          /usr/share/help/*/{fdl,gpl,lgpl}
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="libgnome-desktop-3">
        <term><filename class="libraryfile">libgnome-desktop-3.so</filename></term>
        <listitem>
          <para>
            contains functions shared by several <application>GNOME</application>
            applications
          </para>
          <indexterm zone="gnome-desktop libgnome-desktop-3">
            <primary sortas="c-libgnome-desktop-3">libgnome-desktop-3.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>