source: xfce/core/libxfce4util.xml@ 3441548

<?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 libxfce4util-download-http
           "http://archive.xfce.org/src/xfce/libxfce4util/&xfce4-version;/libxfce4util-&libxfce4util-version;.tar.bz2">
  <!ENTITY libxfce4util-download-ftp  " ">
  <!ENTITY libxfce4util-md5sum        "5a2a7b72c0357f410d8e0d4190beeae2">
  <!ENTITY libxfce4util-size          "500 KB">
  <!ENTITY libxfce4util-buildsize     "5.3 MB">
  <!ENTITY libxfce4util-time          "less than 0.1 SBU">
]>

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

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

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

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

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

    <para>
      The <application>libxfce4util</application> package is a basic utility
      library for the <application>Xfce</application> desktop environment.
    </para>

    &lfs10_checked;

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="glib2"/> and
      <xref linkend="gobject-introspection"/>
    </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;/libxfce4util"/>
    </para>
  </sect2>

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

    <para>
      Install <application>libxfce4util</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="content">
    <title>Contents</title>

    <segmentedlist>
      <segtitle>Installed Program</segtitle>
      <segtitle>Installed Library</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>
          xfce4-kiosk-query
        </seg>
        <seg>
          libxfce4util.so
        </seg>
        <seg>
          /usr/include/xfce4 and
          /usr/share/gtk-doc/html/libxfce4util
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="xfce4-kiosk-query">
        <term><command>xfce4-kiosk-query</command></term>
        <listitem>
          <para>
            Queries the given capabilities of &lt;module&gt; for the current
            user and reports whether the user has the capabilities or not. This
            tool is mainly meant for system administrators to test their Kiosk
            setup.
          </para>
          <indexterm zone="libxfce4util xfce4-kiosk-query">
            <primary sortas="b-xfce4-kiosk-query">xfce4-kiosk-query</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libxfce4util-lib">
        <term><filename class="libraryfile">libxfce4util.so</filename></term>
        <listitem>
          <para>
            contains basic utility functions for the
            <application>Xfce</application> desktop environment.
          </para>
          <indexterm zone="libxfce4util libxfce4util-lib">
            <primary sortas="c-libxfce4util">libxfce4util.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>