source: gnome/core/gconf.xml@ 9408066

<?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.xz">
  <!ENTITY GConf-download-ftp
  "&gnome-download-ftp;/GConf/&gnome-version;/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.</para>

    &lfs71_built;

    <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"/><!--, and
    <xref linkend="ORBit2"/>--></para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended"><xref linkend="gtk3"/> (Required if building a
    <application>GNOME</application> desktop.
    <command>gconf-sanity-check-2</command> will not build otherwise.) and
    <xref linkend="polkit"/></para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional"><xref linkend="openldap"/>,
    <xref linkend="gobject-introspection"/> 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>

    <!-- with-gtk=3.0 is the default, and mandir goes to prefix/share/man -->

<screen><userinput>sed -i '/INTROSPECTION_SCANNER_ARGS/s#$# -lgmodule-2.0#' gconf/Makefile.in &amp;&amp;
./configure --prefix=$GNOME_PREFIX \
            --sysconfdir=$GNOME_SYSCONFDIR \
            --libexecdir=$GNOME_PREFIX/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 $GNOME_SYSCONFDIR/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
    <filename class='extension'>.conf</filename> files (This is assuming
    that <filename>/etc/dbus-1/system-local.conf</filename> does not exist yet.
    If it does, then you will need to merge in the changes). If
    <envar>$GNOME_PREFIX</envar> is not
    <filename class='directory'>/usr</filename>, you should uncomment the
    <quote>servicedir</quote> line:</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_SYSCONFDIR/dbus-1/system.d --&gt;
  &lt;includedir&gt;$GNOME_SYSCONFDIR/dbus-1/system.d&lt;/includedir&gt;

  &lt;!-- Search for .service files in $GNOME_PREFIX/share/dbus-1/system-services --&gt;
  &lt;!-- &lt;servicedir&gt;$GNOME_PREFIX/share/dbus-1/system-services&lt;/servicedir&gt; --&gt;

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

    <para>If <envar>$GNOME_PREFIX</envar> is not
    <filename class='directory'>/usr</filename>, you also need to configure
    <application>D-Bus</application> so that it can search for
    <application>GNOME</application> installed <quote>session</quote>
    <filename class='extension'>.service</filename> files (This is assuming
    that <filename>/etc/dbus-1/session-local.conf</filename> does not exist
    yet. If it does, then you will need to merge in the changes). Additionally,
    if <application>polkit</application> is installed, create a symbolic link
    in <filename class='directory'>/usr/share/polkit-1/actions</filename> to
    the <quote>action</quote> file installed by
    <application>GConf</application>. Issue the following commands as the
    <systemitem class="username">root</systemitem> user:</para>

<screen role="root"><userinput>cat &gt; /etc/dbus-1/session-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 .service files in $GNOME_PREFIX/share/dbus-1/session-services --&gt;
  &lt;servicedir&gt;$GNOME_PREFIX/share/dbus-1/session-services&lt;/servicedir&gt;

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

ln -s -v <envar>$GNOME_PREFIX</envar>/share/polkit-1/actions/org.gnome.gconf.defaults.policy \
         /usr/share/polkit-1/actions
</userinput></screen>

  </sect2>

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

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

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

    <para><command>sed -i '/INTROSPECTION_SCANNER_ARGS/s#$# -lgmodule-2.0#'
    gconf/Makefile.in</command>: This sed fixes compiling with both
    <application>Glib-2.32</application> and
    <xref linkend="gobject-introspection"/> installed.</para>

    <para><parameter>--libexecdir=<envar>$GNOME_PREFIX</envar>/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>

    <para><parameter>--disable-orbit</parameter>: 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/gnome-mandir.xml"/>-->

    <para><option>--disable-static</option>: This switch prevents the static
    libraries being installed.</para>

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

    <para><command>install -v -m755 -d
    $GNOME_SYSCONFDIR/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-defaults-mechanism, gconf-merge-tree, gconf-sanity-check-2,
        gconfd-2, gconftool-2, and gsettings-data-convert</seg>
        <seg>libgconf-2.{so,a}, libgconfbackend-oldxml.{so,a},
        libgconfbackend-xml.{so,a}, and libgsettingsgconfbackend.{so,a}</seg>
        <seg><envar>$GNOME_SYSCONFDIR</envar>/{gconf/{2,gconf.xml.defaults,
        gconf.xml.mandatory,gconf.xml.system},xdg/autostart}
        <envar>$GNOME_PREFIX</envar>/{include/gconf/2/gconf,lib/GConf/2,
        share/{gtk-doc/html/gconf,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 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 GConf 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="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>