source: gnome/platform/libgee.xml@ b747635

<?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 libgee-download-http "&gnome-download-http;/libgee/0.20/libgee-&libgee-version;.tar.xz">
  <!ENTITY libgee-download-ftp  "&gnome-download-ftp;/libgee/0.20/libgee-&libgee-version;.tar.xz">
  <!ENTITY libgee-md5sum        "4d7d6f1f8054f1b3466c752ac2e50946">
  <!ENTITY libgee-size          "672 KB">
  <!ENTITY libgee-buildsize     "42 MB (add 3 MB for tests)">
  <!ENTITY libgee-time          "0.1 SBU (using parallelism=4; add 0.1 SBU for tests)">
]>

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

  <sect1info>
    <date>$Date$</date>
  </sect1info>

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

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

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

    <para>
      The <application>libgee</application> package is a collection library
      providing GObject based interfaces and classes for commonly used data
      structures.
    </para>

    &lfs101_checked;

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="glib2"/>
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="gobject-introspection"/> and
      <xref linkend="vala"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="vala"/> (with Valadoc) and
      <ulink url="http://ltp.sourceforge.net/coverage/lcov.php">LCOV</ulink>
    </para>

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

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

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

<screen><userinput>./configure --prefix=/usr &amp;&amp;
make</userinput></screen>

    <para>
      To test the results, issue: <command>make check</command>.
    </para>
    <!-- For some reason, the tests parallelize themselves and use all
    cores available, regardless of prior settings in the environment.-->

    <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 Programs</segtitle>
      <segtitle>Installed Library</segtitle>
      <segtitle>Installed Directory</segtitle>

      <seglistitem>
        <seg>
          None
        </seg>
        <seg>
          libgee-0.8.so
        </seg>
        <seg>
          /usr/include/gee-0.8
        </seg>
      </seglistitem>
    </segmentedlist>

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

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

    </variablelist>

  </sect2>

</sect1>