source: archive/ggz-client-libs.xml@ 54bd123

<?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 ggz-client-libs-download-http "http://mirrors.ibiblio.org/pub/mirrors/ggzgamingzone/ggz/&ggz-client-libs-version;/ggz-client-libs-&ggz-client-libs-version;.tar.gz">
  <!ENTITY ggz-client-libs-download-ftp  "ftp://ftp.belnet.be/packages/ggzgamingzone/ggz/&ggz-client-libs-version;/ggz-client-libs-&ggz-client-libs-version;.tar.gz">
  <!ENTITY ggz-client-libs-md5sum        "299eaa93721b1d867b5bf7dc6ac764b0">
  <!ENTITY ggz-client-libs-size          "600 KB">
  <!ENTITY ggz-client-libs-buildsize     "8 MB">
  <!ENTITY ggz-client-libs-time          "0.2 SBU">
]>

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

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

  <title>ggz-client-libs-&ggz-client-libs-version;</title>

  <indexterm zone="ggz-client-libs">
    <primary sortas="a-ggz-client-libs">ggz-client-libs</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to ggz-client-libs</title>

    <para>The <application>ggz-client-libs</application> package provides the
    common procedures and utilities required to run the GGZ client and games.
    The routines are shared by other modules in order to ease coding and promote
    compatibility and stability.</para>

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

    <bridgehead renderas="sect3">ggz-client-libs Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required"><xref linkend="expat"/> and
    <xref linkend="libggz"/></para>

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

  </sect2>

  <sect2 role="installation">
    <title>Installation of ggz-client-libs</title>

    <para>Install <application>ggz-client-libs</application> by running the following
    commands:</para>

<screen><userinput>./configure --prefix=/usr \
            --sysconfdir=/etc &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="content">
    <title>Contents</title>

    <segmentedlist>
      <segtitle>Installed Programs</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directory</segtitle>

      <seglistitem>
        <seg>ggz, ggz-config, ggz-wrapper, and ggzwrap</seg>
        <seg>libggzcore.{so,a} and libggzmod.{so,a}</seg>
        <seg>/usr/lib/ggz</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="ggz">
        <term><command>ggz</command></term>
        <listitem>
          <para>is the GGZ Gaming Zone core client selector.</para>
          <indexterm zone="ggz-client-libs ggz">
            <primary sortas="b-ggz">ggz</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="ggz-config">
        <term><command>ggz-config</command></term>
        <listitem>
          <para>is the GGZ Gaming Zone configuration manager.</para>
          <indexterm zone="ggz-client-libs ggz-config">
            <primary sortas="b-ggz-config">ggz-config</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="ggz-wrapper">
        <term><command>ggz-wrapper</command></term>
        <listitem>
          <para>is the GGZ Gaming Zone command line core client.</para>
          <indexterm zone="ggz-client-libs ggz-wrapper">
            <primary sortas="b-ggz-wrapper">ggz-wrapper</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="ggzwrap">
        <term><command>ggzwrap</command></term>
        <listitem>
          <para>is the GGZ Gaming Zone game client wrapper.</para>
          <indexterm zone="ggz-client-libs ggzwrap">
            <primary sortas="b-ggzwrap">ggzwrap</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libggzcore">
        <term><filename class='libraryfile'>libggzcore.{so,a}</filename></term>
        <listitem>
          <para>handles the connection of a client application to the GGZ
          server.</para>
          <indexterm zone="ggz-client-libs libggzcore">
            <primary sortas="c-libggzcore">libggzcore.{so,a}</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libggzmod">
        <term><filename class='libraryfile'>libggzmod.{so,a}</filename></term>
        <listitem>
          <para>facilitates the messaging from and to a GGZ core client in a
          game client.</para>
          <indexterm zone="ggz-client-libs libggzmod">
            <primary sortas="c-libggzmod">libggzmod.{so,a}</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>