<!DOCTYPE book PUBLIC  "-//KDE//DTD DocBook V3.1-Based Variant V1.0//EN" [
  <!ENTITY kappname "&ksame;">
  <!ENTITY % addindex "IGNORE">
  <!ENTITY % English "INCLUDE">
  <!ENTITY % ents PUBLIC "-//KDE//ENTITIES Documentation V1.0//EN">
  %ents;
]>

<book lang="&language;">

<bookinfo>
<title>The &ksame; Handbook</title>

<authorgroup>
<author>
<firstname>Nicholas</firstname>
<surname>Robbins</surname>
<affiliation>
<address><email>logik9000@home.com</email></address>
</affiliation>
</author>
</authorgroup>

<copyright>
<year>2000</year>
<holder>Nicholas Robbins</holder>
</copyright>
<legalnotice>&FDLNotice;</legalnotice>

<date>16/12/2000</date>
<releaseinfo>0.05.10</releaseinfo>

<abstract><para>&ksame; is a nice little program meant to amuse your for
anywhere from 3 minutes to 6 days(straight).</para></abstract>

<keywordset>
<keyword>KDE</keyword>
<keyword>kdegames</keyword>
<keyword>ksame</keyword>
</keywordset>

</bookinfo>

<chapter id="introduction">
<title>Introduction</title>

<para>&ksame; is a simple game. It is played by one player, so there is only one
winner :-) You play for fun and against the high score. It has been inspired by
SameGame, which is only really famous on the Macintosh. </para>

<para>In 1997 Stephan Kulow and Marcus Kreutzberger wrote <foreignphrase
lang="de">Probiere</foreignphrase> (a German pun). It was their first attempt to
write a X11 application. They decided that it would be a good idea to port it to
KDE, and here we are.</para>

</chapter>


<chapter id="using-ksame">
<title>Using &ksame</title>

<para>A very simple premise. There are a bunch of marbles. Get rid of them
all. ;-)</para> 

<para>You can erase same marbles when they are connected vertically or
horizontally when you click them.  If there are pieces over the erased ones,
they will drop down. If all of the pieces on the vertical line are erased, all
pieces on the right side will slide to the left.</para>

<para>The score is the amount of erased pieces -2. Therefore, get as many of the
same pieces as you can, and then erase them in one click. That way you will get
a higher score.  The game is over when there are no pieces that can be
erased.</para>

<para>The score will then be decreased according to the number of remaining
pieces. If you erase all pieces 1,000 bonus points will be added to the final
score.</para>


<sect1 id="kapp-features">
<title>More &ksame; features</title>

<para>&ksame; is wonderful in that it will allow you to kill 5 minutes while you
wait for that program to compile.</para>

<para> Or, if nothing else, it will allow you to kill 5 minutes.</para>

</sect1>
</chapter>

<chapter id="commands">
<title>Command Reference</title>

<sect1 id="ksame-mainwindow">
<title>The main &ksame; window</title>

<para>There is a large area with lots of marbles.  Underneath is the status
bar. Above is the menu bar.</para>

<sect2>
<title>The <guimenu>Game</guimenu> Menu</title>

<variablelist>
<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo action="simul"><keycap>Ctrl</keycap><keycap>N</keycap></keycombo>
</shortcut>
<guimenu><accel>G</accel>ame</guimenu>
<guimenuitem><accel>N</accel>ew</guimenuitem>
</menuchoice></term>
<listitem><para><action>Starts a new game.</action></para></listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo action="simul"><keycap>Ctrl</keycap><keycap>H</keycap></keycombo>
</shortcut>
<guimenu><accel>G</accel>ame</guimenu>
<guimenuitem>Show <accel>h</accel>ighscore</guimenuitem>
</menuchoice></term>
<listitem><para><action>Displays the high score table</action></para></listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo action="simul"><keycap>Ctrl</keycap><keycap>Q</keycap></keycombo>
</shortcut>
<guimenu><accel>G</accel>ame</guimenu>
<guimenuitem><accel>Q</accel>uit</guimenuitem>
</menuchoice></term>
<listitem><para><action>Quits</action> &ksame;</para></listitem>
</varlistentry>
</variablelist>

</sect2>

<sect2>
<title>The <guimenu>Edit</guimenu> Menu</title>

<variablelist>
<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo action="simul"><keycap>Ctrl</keycap><keycap>Z</keycap></keycombo>
</shortcut>
<guimenu><accel>E</accel>dit</guimenu>
<guimenuitem>Und<accel>o</accel></guimenuitem>
</menuchoice></term>
<listitem><para><action>This will undo the last move.</action></para></listitem>
</varlistentry>
</variablelist>

</sect2>

<sect2>
<title>The <guimenu>Settings</guimenu> Menu</title>

<variablelist>
<varlistentry>
<term><menuchoice>
<guimenu><accel>S</accel>ettings</guimenu>
<guimenuitem><accel>R</accel>andom Board</guimenuitem>
</menuchoice></term>
<listitem><para><action>Nothing.</action>  Leave it on, otherwise it just brings
up a blank window.</para></listitem>
</varlistentry>
</variablelist>

</sect2>

<sect2>
<title>The <guimenu>Help</guimenu> Menu</title>
<variablelist>
<varlistentry>
<term><anchor id="contents"><menuchoice>
<shortcut><keycombo><keycap>F1</keycap></keycombo></shortcut>
<guimenu><accel>H</accel>elp</guimenu><guimenuitem><accel>C</accel>ontents</guimenuitem></menuchoice></term>
<listitem><para>This invokes the KDE help system starting at the the top of this
help file.</para></listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<shortcut><keycombo
action="simul"><keycap>Shift</keycap><keycap>F1</keycap></keycombo></shortcut>
<guimenu><accel>H</accel>elp</guimenu><guimenuitem>What's
<accel>T</accel>his?</guimenuitem></menuchoice></term>
<listitem>
<para>This changes the mouse cursor to a combination arrow and question mark.
Clicking on items within &ksame; with this arrow will open a help window (if
one exists for the particular item) explaining the item's function.</para>
</listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<guimenu><accel>H</accel>elp</guimenu><guimenuitem><accel>R</accel>eport
Bug.</guimenuitem></menuchoice></term>
<listitem><para>If you find an error in the program, or you have an idea on how
to improve the game, clicking this option will let you send an official bug
report to the KDE team.</para></listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<guimenu><accel>H</accel>elp</guimenu><guimenuitem><accel>A</accel>bout
Ksame</guimenuitem></menuchoice></term>
<listitem><para>This will <action>display version and author
information</action>.</para></listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<guimenu><accel>H</accel>elp</guimenu><guimenuitem>About
<accel>K</accel>DE</guimenuitem></menuchoice></term>
<listitem><para>This <action>displays the KDE version</action> and other basic
information.</para></listitem>
</varlistentry>
</variablelist>

</sect2>
</sect1>

</chapter>


<chapter id="credits">

<title>Credits and License</title>

<para>&ksame;</para>

<para>Program copyright 1997 Marcus Kreutzberger
<email>kreutzbe@informatik.mu-luebeck.de</email></para>
<para>Contributors:</para>
<itemizedlist>
<listitem><para>Stephen Kulow</para>
</listitem>
</itemizedlist>

<para>Documentation copyright 2000 Nicholas R. Robbins
<email>logik9000@home.com</email></para>

&underFDL;               <!-- FDL: do not remove -->


&underGPL;        	 <!-- GPL License -->

</chapter>

<appendix id="installation">
<title>Installation</title>

<sect1 id="getting-kapp">
<title>How to obtain &ksame;</title>

<para>&ksame; is part of the KDE project <ulink
url="http://www.kde.org">http://www.kde.org</ulink>.  &ksame; can be found in the
kdegames package on <ulink
url="ftp://ftp.kde.org/pub/kde/">ftp://ftp.kde.org/pub/kde/</ulink>, the main
ftp site of the KDE project. </para>

</sect1>

<sect1 id="requirements">
<title>Requirements</title>

<para>In order to successfully use &ksame;, you need KDE 2.0. Or at least the
kdelibs package. </para>

</sect1>

<sect1 id="compilation">
<title>Compilation and installation</title>

<para>In order to compile and install &ksame; on your system, type the following
in the base directory of the kdegames distribution:</para>

<screen width="40"><prompt>%</prompt> <userinput>./configure</userinput>
<prompt>%</prompt> <userinput><command>make</command></userinput>
<prompt>%</prompt> <userinput><command>make</command> install</userinput>
</screen>

<para>Since &ksame; uses <application>autoconf</application> and
<application>automake</application> you should have not trouble compiling
it. Should you run into problems please report them to the KDE mailing
lists.</para> 

</sect1>

</appendix>


&kdedocindex;
</book>
<!--
Local Variables:
sgml-minimize-attributes: nil
sgml-general-insert-case: lower
End:
-->
