source: gnome/core/gconf.xml@ 2999791

<?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 GConf-download-http
           "&gnome-download-http;/GConf/3.2/GConf-&GConf-version;.tar.xz">
  <!ENTITY GConf-download-ftp
           "&gnome-download-ftp;/GConf/3.2/GConf-&GConf-version;.tar.xz">
  <!ENTITY GConf-md5sum        "1b803eb4f8576c572d072692cf40c9d8">
  <!ENTITY GConf-size          "1.5 MB">
  <!ENTITY GConf-buildsize     "42 MB">
  <!ENTITY GConf-time          "0.3 SBU">
]>

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

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

  <title>GConf-&GConf-version;</title>

  <indexterm zone="GConf">
    <primary sortas="a-GConf">GConf</primary>
  </indexterm>

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

    <para>
      The <application>GConf</application> package contains a
      configuration database system used by many 
      <application>GNOME</application> applications.
    </para>

    &lfs70_checked;

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="dbus-glib"/>,
      <xref linkend="intltool"/> and
      <xref linkend="libxml2"/>
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="gobject-introspection"/>,
      <xref linkend="gtk3"/> and
      <xref linkend="polkit"/>
    </para>

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

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

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

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

<screen><userinput>./configure --prefix=/usr \
            --sysconfdir=/etc \
            --libexecdir=/usr/lib/GConf \
            --disable-orbit \
            --disable-static &amp;&amp;
make</userinput></screen>

    <para>
      This package does not come with a test suite.
    </para>

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

<screen role="root"><userinput>make install &amp;&amp;
install -v -m755 -d /etc/gconf/gconf.xml.system</userinput></screen>

  </sect2>

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

    <para>
      <parameter>--libexecdir=/usr/lib/GConf</parameter>:
      This parameter causes the libexec files to be installed in the preferred
      location of <filename class="directory">/usr/lib/GConf</filename>
      instead of <filename class="directory">/usr/libexec</filename>.
    </para>

    <para>
      <option>--disable-orbit</option>: This parameter is required if
      <application>ORBit2</application> is not installed.
      <application>ORBit2</application> is a deprecated package.
    </para>

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

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

    <para>
      <command>install -v -m755 -d /etc/gconf/gconf.xml.system</command>:
      Creates a missing directory. Without this directory, 
      <command>gconf-sanity-check-2</command> will fail during 
      <application>GDM</application> startup and login.
    </para>

  </sect2>

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

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

      <seglistitem>
        <seg>
          gconf-merge-tree, gconftool-2, gsettings-data-convert and
          gsettings-schema-convert
        </seg>
        <seg>
          libgconf-2.so
        </seg>
        <seg>
          /etc/gconf,
          /usr/include/gconf,
          /usr/lib/GConf,
          /usr/share/GConf,
          /usr/share/gtk-doc/html/gconf and
          /usr/share/sgml/gconf
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="gconf-merge-tree">
        <term><command>gconf-merge-tree</command></term>
        <listitem>
          <para>
            merges an XML filesystem hierarchy.
          </para>
          <indexterm zone="GConf gconf-merge-tree">
            <primary sortas="b-gconf-merge-tree">gconf-merge-tree</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="gconftool-2">
        <term><command>gconftool-2</command></term>
        <listitem>
          <para>
            is a command line tool used for manipulating the
            <application>GConf</application> database.
          </para>
          <indexterm zone="GConf gconftool-2">
            <primary sortas="b-gconftool-2">gconftool-2</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="gsettings-data-convert">
        <term><command>gsettings-data-convert</command></term>
        <listitem>
          <para>
            reads values out of the users <application>GConf</application>
            database and stores them in GSettings.
          </para>
          <indexterm zone="GConf gsettings-data-convert">
            <primary sortas="b-gsettings-data-convert">gsettings-data-convert</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="gsettings-schemas-convert">
        <term><command>gsettings-schemas-convert</command></term>
        <listitem>
          <para>
            converts between <application>GConf</application> and GSettings
            schema file formats.
          </para>
          <indexterm zone="GConf gsettings-schemas-convert">
            <primary sortas="b-gsettings-schemas-convert">gsettings-schemas-convert</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libgconf-2">
        <term><filename class='libraryfile'>libgconf-2.so</filename></term>
        <listitem>
          <para>
            provides the functions necessary to maintain the
            configuration database.
          </para>
          <indexterm zone="GConf libgconf-2">
            <primary sortas="c-libgconf-2">libgconf-2.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>