source: lxde/desktop/menu-cache.xml@ e641675

<?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 menu-cache-download-http "&sourceforge-dl;/lxde/menu-cache-&menu-cache-version;.tar.xz">
  <!ENTITY menu-cache-download-ftp  " ">
  <!ENTITY menu-cache-md5sum        "99999a0bca48b980105208760c8fd893">
  <!ENTITY menu-cache-size          "260 KB">
  <!ENTITY menu-cache-buildsize     "3.3 MB">
  <!ENTITY menu-cache-time          "less than 0.1 SBU">
]>

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

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

  <title>menu-cache-&menu-cache-version;</title>

  <indexterm zone="menu-cache">
    <primary sortas="a-menu-cache">menu-cache</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to Menu Cache</title>

    <para>
      The <application>Menu Cache</application> package contains a
      library for creating and utilizing caches to speed up the
      manipulation for freedesktop.org defined application menus.
    </para>

    &lfs84_checked;

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

    <bridgehead renderas="sect3">Menu Cache Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="libfm-extra"/>
    </para>

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

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

  <sect2 role="installation">
    <title>Installation of Menu Cache</title>

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

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

  </sect2>

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

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

    <para>
      <option>--enable-gtk-doc</option>: Use this option if
      <application>GTK-Doc</application> is installed and you wish to build and
      install the API documentation.
    </para>

  </sect2>

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

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

      <seglistitem>
        <seg>
          None
        </seg>
        <seg>
          libmenu-cache.so
        </seg>
        <seg>
          /usr/{include,libexec,share/gtk-doc/html}/menu-cache
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="libmenu-cache">
        <term><filename class="libraryfile">libmenu-cache.so</filename></term>
        <listitem>
          <para>
            contains the <application>menu-cache</application> API functions.
          </para>
          <indexterm zone="menu-cache libmenu-cache">
            <primary sortas="c-libmenu-cache">libmenu-cache.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>