source: gnome/platform/dconf.xml@ 6259734

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

<!-- DConf -->
  <!ENTITY dconf-download-http "&gnome-download-http;/dconf/0.32/dconf-&dconf-version;.tar.xz">
  <!ENTITY dconf-download-ftp  "&gnome-download-ftp;/dconf/0.32/dconf-&dconf-version;.tar.xz">
  <!ENTITY dconf-md5sum        "e1ac0b6285abefeed69ca9e380e44f5a">
  <!ENTITY dconf-size          "112 KB">
  <!ENTITY dconf-buildsize     "7.2 MB">
  <!ENTITY dconf-time          "0.1 SBU">

<!-- DConf-Editor -->
  <!ENTITY dconf-editor-download-http "&gnome-download-http;/dconf-editor/&gnome-minor-32;/dconf-editor-&dconf-editor-version;.tar.xz">
  <!ENTITY dconf-editor-download-ftp  "&gnome-download-ftp;/dconf-editor/&gnome-minor-32;/dconf-editor-&dconf-editor-version;.tar.xz">
  <!ENTITY dconf-editor-md5sum        "331a3603c0f8a9913e3a3c0f178b5310">
  <!ENTITY dconf-editor-size          "512 KB">
  <!ENTITY dconf-editor-buildsize     "34 MB">
  <!ENTITY dconf-editor-time          "0.2 SBU">
]>

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

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

  <title>DConf-&dconf-version; / DConf-Editor-&dconf-editor-version;</title>

  <indexterm zone="dconf">
    <primary sortas="a-DConf">DConf</primary>
  </indexterm>

<!-- DConf -->

  <sect2 role="package">
    <title>Introduction to DConf</title>

    <para>
      The <application>DConf</application> package contains a low-level
      configuration system. Its main purpose is to provide a backend to
      GSettings on platforms that don't already have configuration storage
      systems.
    </para>

    <para>
      The <application>DConf-Editor</application>, as the name suggests, is a
      graphical editor for the <application>DConf</application> database.
      Installation is optional, because <command>gsettings</command> from <xref
      linkend="glib2"/> provides similar functionality on the commandline.
    </para>

    &lfs84_checked;

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

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

    <bridgehead renderas="sect3">DConf Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="dbus"/>,
      <xref linkend="glib2"/>,
      <xref linkend="gtk3"/> (for the editor), and
      <xref linkend="libxml2"/> (for the editor)
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="libxslt"/> and
      <xref linkend="vala"/>
    </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;/dconf"/>
    </para>
  </sect2>

  <sect2 role="installation">
    <title>Installation of DConf</title>

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

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

meson --prefix=/usr --sysconfdir=/etc -Dbash_completion=false .. &amp;&amp;
ninja</userinput></screen>

    <para>
      To test the results, issue: <command>ninja test</command>
    </para>

    <para>
      As the <systemitem class="username">root</systemitem> user:
    </para>

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

    <para>Now, optionally install the editor:</para>

<screen><userinput>cd ..              &amp;&amp;
tar -xf ../dconf-editor-&dconf-editor-version;.tar.xz &amp;&amp;
cd dconf-editor-&dconf-editor-version;                &amp;&amp;

mkdir build &amp;&amp;
cd    build &amp;&amp;

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

    <para>
      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>-Denable-gtk-doc</option>: Use this parameter if
    <application>GTK-Doc</application> is installed and you wish to rebuild
    and install the API documentation.</para>

  </sect2>

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

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

      <seglistitem>
        <seg>
          dconf and dconf-editor
        </seg>
        <seg>
           <!--libdconf-dbus-1.so, -->
          libdconf.so,
          and libdconfsettings.so (GIO Module installed in
          <filename class="directory">/usr/lib/gio/modules</filename>)
        </seg>
        <seg>
          /usr/{include,share/gtk-doc/html}/dconf 
          <!-- and /usr/include/dconf-dbus-1 -->
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="dconf-prog">
        <term><command>dconf</command></term>
        <listitem>
          <para>
            is a simple tool for manipulating the
            <application>DConf</application> database.
          </para>
          <indexterm zone="dconf dconf-prog">
            <primary sortas="b-dconf">dconf</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="dconf-editor">
        <term><command>dconf-editor</command></term>
        <listitem>
          <para>
            is a graphical program for editing the
            <application>DConf</application> database.
          </para>
          <indexterm zone="dconf dconf-editor">
            <primary sortas="b-dconf-editor">dconf-editor</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libdconf">
        <term><filename class="libraryfile">libdconf.so</filename></term>
        <listitem>
          <para>
            contains the <application>DConf</application> client API functions.
          </para>
          <indexterm zone="dconf libdconf">
            <primary sortas="c-libdconf">libdconf.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>
      <!--
      <varlistentry id="libdconf-dbus-1">
        <term><filename class="libraryfile">libdconf-dbus-1.so</filename></term>
        <listitem>
          <para>
            contains the <application>DConf</application> client API functions
            for <application>D-Bus</application>.
          </para>
          <indexterm zone="dconf libdconf-dbus-1">
            <primary sortas="c-libdconf-dbus-1">libdconf-dbus-1.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>
      -->
    </variablelist>

  </sect2>

</sect1>