source: gnome/core/gconf.xml@ 1f88c302

<?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/&gnome-version;/GConf-&GConf-version;.tar.bz2">
  <!ENTITY GConf-download-ftp  "&gnome-download-ftp;/GConf/&gnome-version;/GConf-&GConf-version;.tar.bz2">
  <!ENTITY GConf-md5sum        "ad2aeb9c7d906b274954c51a615caeac">
  <!ENTITY GConf-size          "1.4 MB">
  <!ENTITY GConf-buildsize     "39 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.</para>

    <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">Additional Downloads</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>Required patch: <ulink
        url="&patch-root;/GConf-2.26.2-sysconfdir-1.patch"/></para>
      </listitem>
    </itemizedlist>

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required"><xref linkend="ORBit2"/> and
    <xref linkend="polkit"/></para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended"><xref linkend="gtk2"/> (Required if building
    <application>GNOME</application>. Without this,
    <command>gconf-sanity-check-2</command> will not be built.
    <command>gconf-sanity-check-2</command> is required for building
    <application>GNOME Session</application>.)</para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional"><xref linkend="openldap"/>,
    <xref linkend="intltool"/>, and
    <xref linkend="gtk-doc"/></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><!--patch -Np1 -i ../GConf-&GConf-version;-sysconfdir-1.patch &amp;&amp;-->
patch -Np1 -i ../GConf-2.26.2-sysconfdir-1.patch &amp;&amp;
./configure --prefix=$(pkg-config --variable=prefix ORBit-2.0) \
            --sysconfdir=&gnome-etc-dir; \
            --libexecdir=$(pkg-config \
                --variable=prefix ORBit-2.0)/lib/GConf \
            --mandir=$(pkg-config \
                --variable=prefix ORBit-2.0)/share/man &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 &gnome-etc-dir;/gconf/gconf.xml.system</userinput></screen>

    <para>Still as the <systemitem class="username">root</systemitem> user,
    configure <application>D-Bus</application> so that it can search for
    <application>GNOME</application> installed .conf files (This is assuming
    that system-local.conf does not exist yet. If it does, then you will need
    to merge in the changes):</para>

<screen role="root"><userinput>cat &gt; /etc/dbus-1/system-local.conf &lt;&lt; "EOF"
<literal>&lt;!DOCTYPE busconfig PUBLIC
 "-//freedesktop//DTD D-BUS Bus Configuration 1.0//EN"
 "http://www.freedesktop.org/standards/dbus/1.0/busconfig.dtd"&gt;
&lt;busconfig&gt;

  &lt;!-- Search for .conf files in &gnome-etc-dir;/dbus-1/system.d --&gt;
  &lt;includedir&gt;&gnome-etc-dir;/dbus-1/system.d&lt;/includedir&gt;

&lt;/busconfig&gt;
EOF</literal>
</userinput></screen>

  </sect2>

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

    <xi:include xmlns:xi="http://www.w3.org/2003/XInclude"
    href="../../xincludes/gnome-prefix.xml"/>

    <para><parameter>--sysconfdir=&gnome-etc-dir;</parameter>: This parameter
    causes the <application>GConf-2</application> configuration database to be
    built in <filename class="directory">&gnome-etc-dir;</filename> instead of
    <filename class="directory">$GNOME_PREFIX/etc</filename>. This installation
    controls all future installations of <application>GConf-2</application>
    schemas. If you change the location (which includes eliminating this
    parameter), it <emphasis role='strong'>must</emphasis> be consistent for
    every subsequent package installation that updates the
    <application>GConf-2</application> configuration database.</para>

    <para><parameter>--libexecdir=$(pkg-config --variable=prefix
    ORBit-2.0)/lib/GConf</parameter>: This parameter causes the libexec files
    to be installed in the preferred location of
    <filename class="directory">$GNOME_PREFIX/lib/GConf</filename> instead of
    <filename class="directory">$GNOME_PREFIX/libexec</filename>.</para>

    <xi:include xmlns:xi="http://www.w3.org/2003/XInclude"
    href="../../xincludes/gnome-mandir.xml"/>

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

  </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, gconf-defaults-mechanism,
        gconf-sanity-check-2, and gconfd-2</seg>
        <seg>libgconf-2.{so,a}, libgconfbackend-xml.{so,a}, and
        libgconfbackend-oldxml.{so,a}</seg>
        <seg>&gnome-etc-dir;/gconf{gconf.xml.defaults,2,gconf.xml.mandatory} and
        <envar>$GNOME_PREFIX</envar>/{lib/GConf/2,share/sgml/gconf,
        share/gtk-doc/html/gconf,include/gconf/2/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 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="libgconf-2">
        <term><filename class='libraryfile'>libgconf-2.{so,a}</filename></term>
        <listitem>
          <para>provide the functions necessary to maintain the
          configuration database.</para>
          <indexterm zone="GConf libgconf-2">
            <primary sortas="c-libgconf-2">libgconf-2.{so,a}</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>