source: xfce/core/xfconf.xml@ 4b1b99e8

<?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 xfconf-download-http
           "http://archive.xfce.org/src/xfce/xfconf/&xfce4-version;/xfconf-&xfconf-version;.tar.bz2">
  <!ENTITY xfconf-download-ftp  " ">
  <!ENTITY xfconf-md5sum        "20dc8d2bfd80ba136bf4964021b32757">
  <!ENTITY xfconf-size          "552 KB">
  <!ENTITY xfconf-buildsize     "7.4 MB">
  <!ENTITY xfconf-time          "less than 0.1 SBU">
]>

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

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

  <title>Xfconf-&xfconf-version;</title>

  <indexterm zone="xfconf">
    <primary sortas="a-Xfconf">Xfconf</primary>
  </indexterm>

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

    <para>
      <application>Xfconf</application> is the configuration storage system for
      <application>Xfce</application>.
    </para>

    &lfs84_checked;

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

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

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

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="gtk-doc"/> and
      Perl Module
      <ulink url="http://sourceforge.net/projects/gtk2-perl/files/Glib/">Glib</ulink>
      (this allows perl developers to store settings in xfconf for perl applications)
    </para>

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

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

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

<screen><userinput>./configure --prefix=/usr &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</userinput></screen>
  </sect2>

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

    <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 Program</segtitle>
      <segtitle>Installed Library</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>
          xfconf-query
        </seg>
        <seg>
          libxfconf.so
        </seg>
        <seg>
          /usr/include/xfconf-0,
          /usr/lib/xfce4/xfconf, and
          /usr/share/gtk-doc/html/xfconf
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="xfconf-query">
        <term><command>xfconf-query</command></term>
        <listitem>
          <para>
            is a commandline utility to view or change any setting stored in
            <application>Xfconf</application>.
          </para>
          <indexterm zone="xfconf xfconf-query">
            <primary sortas="b-xfconf-query">xfconf-query</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libxfconf">
        <term><filename class="libraryfile">libxfconf.so</filename></term>
        <listitem>
          <para>
            contains basic functions for <application>Xfce</application>
            configuration.
          </para>
          <indexterm zone="xfconf libxfconf">
            <primary sortas="c-libxfconf">libxfconf.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>