source: gnome/platform/gnome-desktop.xml@ 48a14791

<?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-minor-32;/gnome-desktop-&gnome-desktop-version;.tar.xz">
  <!ENTITY gnome-desktop-download-ftp
           "&gnome-download-ftp;/gnome-desktop/&gnome-minor-32;/gnome-desktop-&gnome-desktop-version;.tar.xz">
  <!ENTITY gnome-desktop-md5sum        "e9a32b755c20f1462f7c4321e32b30cb">
  <!ENTITY gnome-desktop-size          "696 KB">
  <!ENTITY gnome-desktop-buildsize     "14 MB (with tests)">
  <!ENTITY gnome-desktop-time          "0.1 SBU (using parallelism=4; with tests)">
]>

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

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
  </sect1info>

  <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>

    &lfs84_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="iso-codes"/>,
      <xref linkend="itstool"/>,
      <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>

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

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

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

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

meson --prefix=/usr .. &amp;&amp;
ninja</userinput></screen>

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

meson --prefix=/usr                 \
      -Dgnome_distributor="BLFS" .. &amp;&amp;
ninja</userinput></screen>

    <para revision="sysv">
      This package does not come with a functioning test suite.
      or similar.
    </para>

    <para revision="systemd">
      To test the results, run <command>ninja test</command> from a X Terminal
      or similar.
    </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>

    <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>

    <!--<xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
       href="../../xincludes/gtk-doc-rebuild.xml"/> -->

  </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-desktop-3.so
        </seg>
        <seg>
          /usr/include/gnome-desktop-3.0,
          /usr/share/gnome,
          /usr/share/gtk-doc/html/gnome-desktop3, 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>