<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN">

<!--
	Created from the SGML Template for a man page
	For more Information, please see http://mama.sourceforge.net
-->

<refentry id="kbackgammon">
	<refmeta>
		<refentrytitle>KBACKGAMMON</refentrytitle>
		<manvolnum>6</manvolnum>
		<refmiscinfo class="date">September 3rd, 2001</refmiscinfo>
		<refmiscinfo class="source">kde-games</refmiscinfo>
		<refmiscinfo class="title">KDE User's Manual</refmiscinfo>
	</refmeta>

	<refnamediv>
		<refname>kbackgammon</refname>
		<refpurpose>the KDE Backgammon game</refpurpose>
	</refnamediv>

	<refsynopsisdiv>
		<cmdsynopsis>
			<command>kbackgammon</command>
				<arg choice="opt" rep="repeat">Qt-option</arg>
				<arg choice="opt" rep="repeat">KDE-option</arg>
		</cmdsynopsis>
	</refsynopsisdiv>

	<refsect1>
		<title>DESCRIPTION</title>
		<para>
			<command>kbackgammon</command> (aka <command>bacKgammon</command>)
			is a graphical backgammon program.  The objective of backgammon is
			to move your checkers off the board before your opponent does.
			While the rules of backgammon are moderately difficult (the most
			difficult part apparently being the initial positioning of the
			checkers), this document does not try to teach these rules: please
			refer to the web, a book, or (probably best) a friend for this.  
		</para>
	</refsect1>
	
	<refsect1>
		<title>USAGE</title>
		<para>
			<command>KBackgammon</command> offers you a graphical backgammon
			board that can be used almost entirely by using the mouse
			(although textual commands are also available). Therefore,
			<command>KBackgammon</command> is easy to use and allows you to
			concentrate on the important aspects of playing backgammon.  
		</para>
		<para>
			In order to play backgammon, you usually need an opponent.
			<command>KBackgammon</command> offers you to play against hundreds
			of different opponents of various strength on the First Internet
			Backgammon Server. If you prefer, you may also use the Offline
			Engine which allows you to play against yorself or friends that
			are with you at your computer. In the near future
			<command>KBackgammon</command> will also allow you to play against
			GNU Backgammon, which is a very powerful backgammon program . It
			plays on FIBS with a rating of about 2000 (which is quite high).
			Finally, the architecture of <command>KBackgammon</command> i
			squite open and it is possible to include support for other
			engines easily (if you are interested in this, please contact the
			author).  
		</para>
	</refsect1>

	
	<refsect1>
		<title>OPTIONS</title>
		<para>
			This program follows the usual GNU command line syntax,
            with long options starting with two dashes (`--'). A
            summary of the options supported by <command>kbackgammon</command>
            is included below.
		</para>
		<refsect2>
			<title>Generic Options</title>
			<variablelist>
				<varlistentry>
					<term>--author</term>
					<listitem>
						<para>Show author information</para>
					</listitem>
				</varlistentry>
				<varlistentry>
					<term>--help</term>
					<listitem>
						<para>Show help about options</para>
					</listitem>
				</varlistentry>
				<varlistentry>
					<term>--help-qt</term>
					<listitem>
						<para>Show Qt specific options</para>
					</listitem>
				</varlistentry>
				<varlistentry>
					<term>--help-kde</term>
					<listitem>
						<para>Show KDE specific options</para>
					</listitem>
				</varlistentry>
				<varlistentry>
					<term>--help-all</term>
					<listitem>
						<para>Show all options</para>
					</listitem>
				</varlistentry>
				<varlistentry>
					<term>--license</term>
					<listitem>
						<para>Show license information</para>
					</listitem>
				</varlistentry>
				<varlistentry>
					<term>-v, --version</term>
					<listitem>
						<para>Show version information and exit.</para>
					</listitem>
				</varlistentry>
			</variablelist>
		</refsect2>
		<refsect2>
			<title>Qt Options</title>
			<variablelist>
				<varlistentry>
					<term>--display <replaceable>displayname</replaceable></term>
					<listitem>
						<para>Use the X-server display <emphasis>displayname</emphasis>.</para>
					</listitem>
				</varlistentry>
				<varlistentry>
					<term>--session <replaceable>sessionId</replaceable>
					<listitem>
						<para>
							Restore the application for the given <emphasis>sessionId</emphasis>.
						</para>
					</listitem>
				</varlistentry>
				<varlistentry>
					<term>--cmap</term>
					<listitem>
						<para>
							Causes the application to install a private 
							color map on an 8-bit display.
						</para>
					</listitem>
				</varlistentry>
				<varlistentry>
					<term>--ncols <replaceable>count</replaceable></term>
					<listitem>
						<para>
							Limits the number of colors allocated in the 
							color cube on a 8-bit display, if the application
							is using the <emphasis>QApplication::ManyColor</emphasis>
							color specification.
						</para>
					</listitem>
				</varlistentry>
				<varlistentry>
					<term>--nograb</term>
					<listitem>
						<para>tells Qt to never grab the mouse or the keyboard.</para>
					</listitem>
				</varlistentry>
				<varlistentry>
					<term>--dograb</term>
					<listitem>
						<para>
							running under a debugger can cause an implicit
							<command>-nograb</command>, use <command>-dograb</command>
							to override.
						</para>
					</listitem>
				</varlistentry>
				<varlistentry>
					<term>--sync</term>
					<listitem>
						<para>switches to synchronous mode for debugging.</para>
					</listitem>
				</varlistentry>
				<varlistentry>
					<term>--fn, --font <replaceable>fontname</replaceable></term>
					<listitem>
						<para>defines the application font.</para>
					</listitem>
				</varlistentry>
				<varlistentry>
					<term>--bg, --background <replaceable>color</replaceable></term>
					<listitem>
						<para>
							sets the default background color and an
							application palette (light and dark shades 
							are calculated).
						</para>
					</listitem>
				</varlistentry>
				<varlistentry>
					<term>--fg,--foreground <replaceable>color</replaceable></term>
					<listitem>
						<para>sets the default foreground color.</para>
					</listitem>
				</varlistentry>
				<varlistentry>
					<term>--btn, --button <replaceable>color</replaceable></term>
					<listitem>
						<para>sets the default button color.</para>
					</listitem>
				</varlistentry>
				<varlistentry>
					<term>--name <replaceable>name</replaceable></term>
					<listitem>
						<para>sets the application name.</para>
					</listitem>
				</varlistentry>
				<varlistentry>
					<term>--title <replaceable>title</replaceable></term>
					<listitem>
						<para>sets the application title (caption).</para>
					</listitem>
				</varlistentry>
				<varlistentry>
					<term>--visual <replaceable>TrueColor</replaceable></term>
					<listitem>
						<para>
							forces the application to use a TrueColor
							visual on an 8-bit display.
						</para>
					</listitem>
				</varlistentry>
				<varlistentry>
					<term>--inputstyle</term>
					<listitem>
						<para>
							sets XIM (X Input Method) input style. Possible
							values are onthespot, overthespot, offthespot
							and root.
						</para>
					</listitem>
				</varlistentry>
				<varlistentry>
					<term>--im <replaceable>XIM server</replaceable>
					<listitem>
						<para>set XIM server.</para>
					</listitem>
				</varlistentry>
				<varlistentry>
					<term>--noxim</term>
					<listitem>
						<para>disable XIM.</para>
					</listitem>
				</varlistentry>
			</variablelist>
		</refsect2>
		<refsect2>
			<title>KDE Options</title>
			<variablelist>
				<varlistentry>
					<term>--caption <replaceable>caption</replaceable></term>
					<listitem>
						<para>Use <emphasis>caption</emphasis> as name in the titlebar.</para>
					</listitem>
				</varlistentry>
				<varlistentry>
					<term>--icon <replaceable>icon</replaceable></term>
					<listitem>
						<para>Use <emphasis>icon</emphasis> as the application icon.</para>
					</listitem>
				</varlistentry>
				<varlistentry>
					<term>--miniicon <replaceable>icon</replaceable>
					<listitem>
						<para>Use <emphasis>icon</emphasis> as the icon in the titlebar.</para>
					</listitem>
				</varlistentry>
				<varlistentry>
					<term>--dcopserver <replaceable>server</replaceable></term>
					<listitem>
						<para>
							Use the DCOP Server specified by <emphasis>server</emphasis>.
						</para>
					</listitem>
				</varlistentry>
				<varlistentry>
					<term>--nocrashhandler</term>
					<listitem>
						<para>Disable crash handler, to get core dumps.</para>
					</listitem>
				</varlistentry>
				<varlistentry>
					<term>--waitforwm</term>
					<listitem>
						<para>
							Waits for a WM_NET compatible windowmanager.
						</para>
					</listitem>
				</varlistentry>
				<varlistentry>
					<term>--style <replaceable>style</replaceable></term>
					<listitem>
						<para>sets the application GUI style.</para>
					</listitem>
				</varlistentry>
				<varlistentry>
					<term>--geometry <replaceable>geometry</replaceable></term>
					<listitem>
						<para>
							sets the client geometry of the main widget.
						</para>
					</listitem>
				</varlistentry>
			</variablelist>
		</refsect2>
	</refsect1>
	
	<refsect1>
		<title>FILES</title>
		<variablelist>
			<varlistentry>
				<term>
					<filename>~/.kde/share/apps/kbackgammon/</filename>
				</term>
				<listitem>
					<para></para>
				</listitem>
			</varlistentry>
			<varlistentry>
				<term><filename>~/.kde/share/config/kbackgammonrc</filename></term>
				<listitem>
					<para><command>kbackgammon</command> configuration</para>
				</listitem>
			</varlistentry>
		</variablelist>
	</refsect1>

	<refsect1>
		<title>SEE ALSO</title>
		<para>
			<command>kbackgammon</command> is documented in detail by <emphasis>The
			KBabel Handbook</emphasis>
			(<filename>/usr/local/kde/share/doc/HTML/default/kbackgammon/index.html</filename>).
		</para>
		<para>
			<ulink url="http://backgammon.sourceforge.net">KBackgammon
			Homepage</ulink>
		</para>
		<para>
			<ulink url="http://www.kde.org">KDE</ulink>
		</para>
	</refsect1>

	<refsect1>
		<title>AUTHOR</title>
		<para>
			Jens Hoefkens <email>jens@hoefkens.com</email>
		</para>
		<para>
			This man-page was written by Jan Schaumann <email>jschauma@netmeister.org</email>
			as part of "<ulink
			url="http://www.netmeister.org/misc/m2p2/index.html">The Missing Man Pages Project</ulink>".
		</para>
	</refsect1>
</refentry>
