source: gnome/add/gnome-games.xml@ 5254d12

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
   "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

  <!ENTITY gnome-games-download-http "http://ftp.gnome.org/pub/GNOME/sources/gnome-games/&gnome-version;/gnome-games-&gnome-games-version;.tar.bz2">
  <!ENTITY gnome-games-download-ftp  "ftp://ftp.gnome.org/pub/GNOME/sources/gnome-games/&gnome-version;/gnome-games-&gnome-games-version;.tar.bz2">
  <!ENTITY gnome-games-md5sum        "b4870504aa1a5a759c89a2b92f1a2c21">
  <!ENTITY gnome-games-size          "4.9 MB">
  <!ENTITY gnome-games-buildsize     "72.3 MB">
  <!ENTITY gnome-games-time          "1.0 SBU">
]>

<sect1 id="gnome-games" xreflabel="GNOME Games-&gnome-games-version;">
  <?dbhtml filename="gnome-games.html"?>

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
    <keywordset>
      <keyword role="package">gnome-games-&gnome-games-version;.tar</keyword>
      <keyword role="ftpdir">gnome-games</keyword>
    </keywordset>
  </sect1info>

  <title>GNOME Games-&gnome-games-version;</title>

  <indexterm zone="gnome-games">
    <primary sortas="a-GNOME Games">GNOME Games</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to GNOME Games</title>

    <para>The <application>GNOME Games</application> package contains games.
    Starting with <application>GNOME</application>-2.8, the background graphics,
    artwork and themes for the games are supplied in a separate package. You
    can download the <application>GNOME</application> Games Extra Data package
    from <ulink
    url="http://ftp.gnome.org/pub/GNOME/sources/gnome-games-extra-data/&gnome-version;/"/>.
    </para>

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

    <bridgehead renderas="sect3">GNOME Games Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required"><xref linkend="libgnomeui"/>,
    <xref linkend="scrollkeeper"/> and
    <xref linkend="librsvg"/></para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional"><xref linkend="guile"/>
    (required to build the AisleRiot solitaire games),
    <ulink url="http://www.porchdogsoft.com/products/howl/">Howl</ulink> and
    <ulink url="http://www.5z.com/jirka/gob.html">GOB2</ulink></para>

    <para>The <command>gnibbles</command> game will attempt to start the
    network game server daemon <command>games-server.py</command>, which
    requires <xref linkend="python"/>.</para>

  </sect2>

  <sect2 role="installation">
    <title>Installation of GNOME Games</title>

    <para>Some of the <application>GNOME Games</application> game binaries
    need to be setgid to track high scores. Create a separate user and group
    for games. See the <filename>README</filename> file in the source directory
    for more information:</para>

<screen role="root"><userinput>install -v -m755 -d /var/lib/games &amp;&amp;
groupadd -g 60 games &amp;&amp;
useradd -c 'Games High Score Owner' -d /var/lib/games \
        -g games -s /bin/false -u 60 games &amp;&amp;
chown -v games:games /var/lib/games</userinput></screen>

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

<screen><userinput>./configure --prefix=`pkg-config --variable=prefix ORBit-2.0` \
    --localstatedir=/var/lib --sysconfdir=/etc/gnome &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>

    <para><parameter>--localstatedir=/var/lib</parameter>: This switch
    puts <application>ScrollKeeper</application> files in
    <filename class="directory">/var/lib/scrollkeeper</filename> instead of
    <filename class="directory">$GNOME_PREFIX/var/scrollkeeper</filename> and
    also causes the programs to use
    <filename class='directory'>/var/lib/games</filename> as the directory
    holding the high score files.</para>

    <para><parameter>--sysconfdir=/etc/gnome</parameter>: This switch puts
    configuration files in <filename class="directory">/etc/gnome</filename>
    instead of <filename class="directory">$GNOME_PREFIX/etc</filename>.</para>

    <para><option>--disable-setgid</option>: This will prevent the setgid bit
    on the executables from being set. It provides system administrators
    with the option to disable setgid binaries, though it also means that the
    functionality to save high game scores will be disabled.</para>

  </sect2>

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

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

      <seglistitem>
        <seg>blackjack, games-server.py, gataxx, glines, gnect, gnibbles,
        gnobots2, gnome-stones, gnometris, gnomine, gnotravex, gnotski,
        gtali, iagno, mahjongg, same-gnome, and sol</seg>
        <seg><command>gnome-stones</command> objects libraries</seg>
        <seg>/etc/gnome/gconf/gconf.xml.defaults/apps/[game name],
        /etc/gnome/gconf/gconf.xml.defaults/schemas/apps/[game name],
        $GOME_PREFIX/lib/gnome-stones,
        $GOME_PREFIX/share/gnome-games,
        $GOME_PREFIX/share/[,help,pixmaps,sound]/[game name],
        $GOME_PREFIX/share/omf/gnome-games, and
        /var/lib/games</seg>
      </seglistitem>
    </segmentedlist>

    <bridgehead renderas="sect3">Short Descriptions</bridgehead>

    <para>See the <filename>README</filename> file in the source tree for a
    description of each game.</para>

  </sect2>

</sect1>