source: archive/libggz.xml@ 22c6402

<?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 libggz-download-http "http://mirrors.ibiblio.org/pub/mirrors/ggzgamingzone/ggz/&libggz-version;/libggz-&libggz-version;.tar.gz">
  <!ENTITY libggz-download-ftp  "ftp://ftp.belnet.be/packages/ggzgamingzone/ggz/&libggz-version;/libggz-&libggz-version;.tar.gz">
  <!ENTITY libggz-md5sum        "603739504648833779aa13b0327a1c3d">
  <!ENTITY libggz-size          "466 KB">
  <!ENTITY libggz-buildsize     "5 MB">
  <!ENTITY libggz-time          "0.1 SBU">
]>

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

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

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

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

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

    <para>The <application>libggz</application> package is the GGZ base library,
    used by the GGZ Gaming Zone server (ggzd), the ggzcore library and other
    components.</para>

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

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

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional"><xref linkend="gnutls"/>,
    <xref linkend="libgcrypt"/>, and
    <xref linkend="openssl"/></para>

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

  </sect2>

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

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

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

    <para>To test the results, issue: <command>make check</command>.</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>

    <para><parameter>--with-tls</parameter>: This parameter will automatically
    select the use of either GnuTLS or OpenSSL if available.</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>libggz.{so,a}</seg>
        <seg>None</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="libggz-lib">
        <term><filename class='libraryfile'>libggz.{so,a}</filename></term>
        <listitem>
          <para>contains the libggz API functions.</para>
          <indexterm zone="libggz libggz-lib">
            <primary sortas="c-libggz">libggz.{so,a}</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>