diff options
Diffstat (limited to 'doc/help_en.docbook')
| -rw-r--r-- | doc/help_en.docbook | 795 |
1 files changed, 795 insertions, 0 deletions
diff --git a/doc/help_en.docbook b/doc/help_en.docbook new file mode 100644 index 0000000..7b899f8 --- /dev/null +++ b/doc/help_en.docbook @@ -0,0 +1,795 @@ +<?xml version="1.0" ?> +<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.1-Based Variant V1.0//EN" "dtd/kdex.dtd" [ + <!ENTITY kappname "Knights"> + <!ENTITY % addindex "IGNORE"> + <!ENTITY % English "INCLUDE" > <!-- change language only here --> +]> + +<book lang="&language;"> + <bookinfo> + <title> + The Knights Handbook + </title> + <authorgroup> + <author> + <firstname>Troy</firstname> + <surname>Corbin Jr.</surname> + <affiliation> + <address> + <email>[email protected]</email> + </address> + </affiliation> + </author> + <othercredit role="developer"> + <firstname>Troy</firstname> + <surname>Corbin Jr.</surname> + <affiliation> + <address> + <email>[email protected]</email> + </address> + </affiliation> + <contrib>Developer</contrib> + </othercredit> + </authorgroup> + <!-- TRANS:ROLES_OF_TRANSLATORS --> + <copyright> + <year>2001, 2002</year> + <holder>Troy Corbin Jr.</holder> + </copyright> + <legalnotice> + &FDLNotice; + </legalnotice> + <date> + 2003-05-17 + </date> + <releaseinfo> + 0.6 + </releaseinfo> + <abstract> + <para> + Knights is a graphical chess interface for &kde;. It supports chess matches against computer engines like GNUChess and Crafty, watching two computer engines play against each other, solitaire chess, matches played via Internet Chess Servers, and reviewing matches saved in Portable Game Notation. + </para> + </abstract> + <keywordset> + <keyword>knights</keyword> + <keyword>KDE</keyword> + <keyword>game</keyword> + <keyword>chess</keyword> + <keyword>gnuchess</keyword> + <keyword>crafty</keyword> + <keyword>ICS</keyword> + <keyword>SAN</keyword> + <keyword>PGN</keyword> + </keywordset> + </bookinfo> + + <chapter id="introduction"> + <title>Introduction</title> + <para> + Chess is a game of strategy with a long history and many variations, and Knights aims to be the ultimate chess resource on your computer. Knights provides a virtual chess board and pieces which you can use to play against a variety of opponents. Currently, those opponents include yourself ( Solitaire chess is a wonderful way to improve your skill at the game ), computer opponents ( sometimes called chess engines ) which you have installed on your computer, and people connected to an internet chess server. In the future, you will also be able to play against a friend using email. + </para> + <para> + If you like to review chess matches which other people have played, Knights can help. Using Portable Game Notation ( <acronym>PGN</acronym> ), Knights can exchange recorded chess matches with most other computer chess programs. You can also record your own matches with Knights, and share them with anyone. + </para> + <para> + Future versions of Knights will include comprehensive chess education in the form of interactive tutorials. These tutorials will help new players grasp the basics, and help them evolve into advanced players. + </para> + </chapter> + + <chapter id="getting-started"> + <title>Getting Started</title> + <para> + The following sections will help you become familiar with Knights quickly. + </para> + <sect1 id="interface-chessboard"> + <title>The Chessboard</title> + <para> + If you've ever played chess before, then Knights' chessboard should be easy to understand. It always displays one player at the top of the screen and the other at the bottom. By default, your pieces always start at the bottom while your opponent's start at the top. + </para> + <para> + Directly below the board are two clocks. The left clock has a white background and always shows the time for the white player. The right clock is always black and shows the time for the black player. + </para> + <sect2 id="interface-chessboard-move"> + <title>Making a Move</title> + <para> + To move a chessman, simply click the left mouse button while your pointer is over the chessman you wish to move. If it's your turn to move, the chessman will become highlighted. This lets you know that Knights is ready to move that chessman for you. Now, move your pointer to the position where you want your chessman to move to. Click the left mouse button. You've just moved your chessman! + </para> + <para> + You can also move your chessman using "Drag and Drop". Hold down the left mouse button over the chessman you wish to move and, while still holding down the mouse button, move your chessman to it's new position and release the button. + </para> + </sect2> + <sect2 id="interface-chessboard-preview"> + <title>Using Preview</title> + <para> + The Preview feature shows you where each chessman can move on a given turn. To use this feature, move your pointer so that it is over the chessman you wish to examine. Now, click the right mouse button. Any position which that chessman can move to will be highlighted. Moves which will result in a chessman being captured are colored differently. + </para> + <para> + If the chessman you are examining is yours, and it is your turn, you may go head and move him by left clicking on the desired square. + </para> + <tip> + <para> + You can tell Knights to automatically preview possible moves every time you left click on a chessman. See the <link linkend="configure-display-general">Display Settings</link> chapter to find out how. + </para> + </tip> + </sect2> + <sect2 id="interface-chessboard-notation"> + <title>SAN Notation</title> + <para> + You will notice that in the lower-right corner, there is a button which displays the last move using Standard Algebraic Notation ( <acronym>SAN</acronym> ). Clicking this button will display all the moves in this match. You can review a previous position by selecting it from this list. Another way to move through this list is to use the <keycombo action="simul"><keycap>Up</keycap></keycombo> and <keycombo action="simul"><keycap>Down</keycap></keycombo> arrow keys on your keyboard. This will step through each move one at a time. + </para> + <note> + <para> + You can not make your next move while you are reviewing the match. You must return to the most recent entry in the list before you can make your move. If someone else makes a move while you are reviewing a previous position, Knights will automatically return you to the current position. + </para> + </note> + </sect2> + </sect1> + <sect1 id="new-match"> + <title>Starting a New Match</title> + <para> + To start a new match, click on the <menuchoice><guimenu>File</guimenu></menuchoice> menu, then select <menuchoice><guimenu>New Match...</guimenu></menuchoice>. + </para> + <sect2 id="new-match-dialog"> + <title>The New Match Window</title> + <para> + The New Match Window lets you change the type of chess match you'd like to play. + </para> + <note> + <para> + Online games can not be started from here. If you'd like to play chess online, please see the section of this document titled <link linkend="online">Using Knights Online</link>. + </para> + </note> + <para> + Clicking <menuchoice><guimenu>Human</guimenu></menuchoice> will tell Knights that you want to control this color yourself. + </para> + <para> + The <menuchoice><guimenu>Computer</guimenu></menuchoice> option, if available, will tell Knights that a Computer Opponent ( also known as a Chess Engine ) should control this color. Another window will pop up with a list of opponents that you have installed. After selecting an opponent, you should use the <menuchoice><guimenu>Player Strength</guimenu></menuchoice> slider to customize your opponent's skill level. Due to the fact that each computer opponent is unique, some which are set to <menuchoice><guimenu>Weak</guimenu></menuchoice> may actually be better than opponents set to <menuchoice><guimenu>Strong</guimenu></menuchoice>. Also note that some may completely ignore your preference and play that same no matter what skill level you select. + </para> + <para> + The <menuchoice><guimenu>Email</guimenu></menuchoice> option is not yet supported by Knights. + </para> + <para> + Once you've selected the players, you'll want to select the time controls for this match. <menuchoice><guimenu>Base Time</guimenu></menuchoice> is the number of minutes that this player has at the beginning of the match. After you make a number of moves, you'll receive extra time on your clock. <menuchoice><guimenu>Moves Per Base Time</guimenu></menuchoice> controls the number of moves needed to receive that extra time. <menuchoice><guimenu>Increment Per Move</guimenu></menuchoice> is yet another time bonus that you receive after every move. + </para> + </sect2> + </sect1> + </chapter> + + <chapter id="online"> + <title>Using Knights Online</title> + <para> + Knights can connect you with thousands of other chess players around the globe. You can play games, observe others playing, attend live classes, or just relax and chat. + </para> + <para> + Although Knights tries to make it easy to use a chess server, there are many commands and functions for each server that are beyond the scope of this document. You should check with the chess server you intend to use for a full description of these. + </para> + <sect1 id="getting-started-online"> + <title>Getting Started</title> + <para> + If you used the Setup Wizard when you first installed Knights, then Knights will connect to the <ulink url="http://www.freechess.org">Free Internet Chess Server</ulink> by default. If you did not use the Setup Wizard, or you'd prefer to connect to another chess server, you'll need to change Knights' settings. See the section of this document titled <link linkend="configure-servers">Chess Servers</link> for instructions on doing this. + </para> + <para> + Your computer will need to be connected to the Internet before you attempt to connect to a chess server. Knights will display an error message if it can not access the Internet. + </para> + <para> + Some chess servers will require you to have a membership, which sometimes includes paying a membership fee. You will need to visit the website of your chosen chess server to sign up for membership. + </para> + <para> + If you are not interested in obtaining a membership, but you still want to play chess online, some chess servers will allow you to play as a free guest without signing up for anything. This is strongly suggested for those who have never played chess online before. + </para> + <sect2 id="getting-started-online-connecting"> + <title>Connecting to a Server</title> + <para> + To connect to a chess server, click on <menuchoice><guimenu>File</guimenu></menuchoice>, and then select <menuchoice><guimenuitem>Connect to Server</guimenuitem></menuchoice>. + </para> + <para> + A new window will pop up asking for your <menuchoice><guimenu>Login</guimenu></menuchoice> and <menuchoice><guimenu>Password</guimenu></menuchoice>. You should have recieved these when you signed up for membership with this chess server. If you do not have a membership yet, click on the <menuchoice><guimenu>Log in as guest</guimenu></menuchoice> option. + </para> + </sect2> + </sect1> + <sect1 id="online-tools"> + <title>Online Tools</title> + <para> + Once Knights has established a connection with your chosen chess server, several new tools will be displayed to help you make the most of your time online. + </para> + <sect2 id="online-tools-console"> + <title>The Console</title> + <para> + The Console is your primary communications tool while you're online. All of the messages that are sent to you are displayed here. + </para> + <para> + Messages can be colored differently depending on the type of message. For example, a message from a chat channel may be displayed in blue, while message sent specifically to you may be in green. These colors ( and fonts ) may be customized by going to <menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure Knights...</guimenuitem></menuchoice>. Then click on <menuchoice><guimenu>Display</guimenu></menuchoice>, and then the <menuchoice><guimenu>Console</guimenu></menuchoice> tab. + </para> + <para> + This is also where you send your messages out. Just start typing on your keyboard to write a message, and press <keycombo action="simul"><keycap>Enter</keycap></keycombo> to send it. Knights will remember the last 100 messages you sent out, which you can access by pressing <keycombo action="simul"><keycap>SHIFT + UP</keycap></keycombo> and <keycombo action="simul"><keycap>SHIFT + DOWN</keycap></keycombo>. + </para> + <para> + There are several shortcuts available for the most commonly used server commands. To see a list of these, your should read the section of this document titled <link linkend="key-bindings">Command Reference</link>. + </para> + </sect2> + <sect2 id="online-tools-sought-list"> + <title>The Sought Games List</title> + <para> + Ok, you've connected to a chess server. Now how do you play chess on it? + </para> + <para> + The Sought Games List will help. Right click on it, and select <menuchoice><guimenu>Seek Matches</guimenu></menuchoice>. A list of other players, who are also interested in playing a game of chess, will appear. When you find one you like, simply left click on it to start playing. + </para> + <para> + As you'll notice, there are a number of actions you can take when you right click on a match. They are: + </para> + <itemizedlist> + <listitem> + <para> + <menuchoice><guimenu>Tell...</guimenu></menuchoice> will begin a private message between you and the player offering this match. Simply select this and type your message. + </para> + </listitem> + <listitem> + <para> + <menuchoice><guimenu>Assess</guimenu></menuchoice> will display a graph that shows you how your rating will be effected if you play a match against this opponent. + </para> + </listitem> + <listitem> + <para> + <menuchoice><guimenu>Player Info</guimenu></menuchoice>, otherwise known as "Finger", will display a wealth of information about this player. This information can include how long the player has been online, his rating for different types of chess matches, win/loss statistics, etc. + </para> + </listitem> + <listitem> + <para> + <menuchoice><guimenu>Player History</guimenu></menuchoice> shows the results of the last 14 or so games played by this opponent. There are columns in the history display for the players and their ratings (as adjusted by the result of the match), the winner, the type of match (blitz/standard, rated/unrated) and the date. + </para> + </listitem> + <listitem> + <para> + <menuchoice><guimenu>Add to Friends</guimenu></menuchoice> tells your ICS that you want to be notified whenever this player logs on and off the server. In the future, Knights will display your friends list so you can easily send them messages, observe their matches, and more. + </para> + </listitem> + <listitem> + <para> + <menuchoice><guimenu>Ignore This Player</guimenu></menuchoice> keeps you from hearing anything this player says, including private messages. + </para> + </listitem> + </itemizedlist> + </sect2> + <sect2 id="online-tools-sought-graph"> + <title>The Sought Games Graph</title> + <para> + The Sought Games Graph performs the same function as the Sought Games List, but with one difference: Instead of displaying a list of players, it displays a graph. + </para> + <para> + Usually, when you're interested in playing a chess match, you already know how long you want the match to be, and you already know that you want to play against an opponent of a particular skill level. The graph is very useful for this, because it organizes the available games based on it's length, and on your opponent's strength. + </para> + <para> + Stronger opponents are listed at the top of the graph, while weaker opponents are listed at the bottom. Shorter games are listed at the left, while longer games are listed at the right. Rated games are displayed using a solid square, while unrated games use a hollow square. + </para> + <para> + Right clicking on a match will display the same menu used in the Sought Games List. That menu includes: + </para> + <itemizedlist> + <listitem> + <para> + <menuchoice><guimenu>Tell...</guimenu></menuchoice> will begin a private message between you and the player offering this match. Simply select this and type your message. + </para> + </listitem> + <listitem> + <para> + <menuchoice><guimenu>Assess</guimenu></menuchoice> will display a graph that shows you how your rating will be effected if you play a match against this opponent. + </para> + </listitem> + <listitem> + <para> + <menuchoice><guimenu>Player Info</guimenu></menuchoice>, otherwise known as "Finger", will display a wealth of information about this player. This information can include how long the player has been online, his rating for different types of chess matches, win/loss statistics, etc. + </para> + </listitem> + <listitem> + <para> + <menuchoice><guimenu>Player History</guimenu></menuchoice> shows the results of the last 14 or so games played by this opponent. There are columns in the history display for the players and their ratings (as adjusted by the result of the match), the winner, the type of match (blitz/standard, rated/unrated) and the date. + </para> + </listitem> + <listitem> + <para> + <menuchoice><guimenu>Add to Friends</guimenu></menuchoice> tells your ICS that you want to be notified whenever this player logs on and off the server. In the future, Knights will display your friends list so you can easily send them messages, observe their matches, and more. + </para> + </listitem> + <listitem> + <para> + <menuchoice><guimenu>Ignore This Player</guimenu></menuchoice> keeps you from hearing anything this player says, including private messages. + </para> + </listitem> + </itemizedlist> + </sect2> + </sect1> + </chapter> + + <chapter id="organizing-tabs"> + <title>Organizing Your Tabs</title> + <para> + Knights often must display more than just the chessboard. For example, when you play chess online, Knights must open up a new window containing several new tools. These tools are stacked on top of each other using tabs to help keep your desktop from getting too cluttered, but what if you want to see more than one of these tools at a time? + </para> + <para> + At the top of each tab, you'll find a Grip widget. It looks like three horizontal lines, and when you move your pointer over it, the pointer will change into four arrows. When this happens, you can click and drag that tab to a different position on the screen. If you drag it to another tab, then they will merge together into the same window. If you do not drag it onto another tab, it will create it's own window at the new location. + </para> + <para> + To the right of the Grip is a Close button. Clicking on this button will close out this Tab. If this was the only Tab in it's window, then the window will be closed as well. + </para> + <note> + <para> + Whenever a tab is closed, Knights will remember the size of that tab. + </para> + </note> + </chapter> + + <chapter id="configure"> + <title>Settings</title> + <para> + One of our primary goals is to make Knights easy to setup and customize. When you need to customize Knights, select <menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure Knights...</guimenuitem></menuchoice>. A new window will be displayed. The following sections describe the various options available from this new window. + </para> + <sect1 id="configure-general"> + <title>General</title> + <para> + <menuchoice><guimenu>Your Name</guimenu></menuchoice> is the name Knights records on saved games for you. + </para> + <para> + <menuchoice><guimenu>When Knights Begins It Should:</guimenu></menuchoice> This allows you to customize Knights' behavior when you run the program. + </para> + <para> + <menuchoice><guimenu>Save Match on Close?</guimenu></menuchoice> When you close a chess match, Knights can automatically save it for you. If this match doesn't yet have a file name, you will be prompted for one. + </para> + <para> + The <menuchoice><guimenu>Append to Save File</guimenu></menuchoice> option tells Knights that you wish to save all your games to a single pgn file. This is useful for players who wish to analyze their matches later in a chess database program like <ulink url="http://scid.sourceforge.net/">SCID</ulink>. + </para> + <para> + <menuchoice><guimenu>Pause on Minimize</guimenu></menuchoice> This will cause Knights to pause all your matches when you minimize the Knights window. + </para> + <note> + <para> + Some types of matches ( like matches on <acronym>ICS</acronym> ) can not be paused in this way. + </para> + </note> + <para> + <menuchoice><guimenu>Always Promote to Queen</guimenu></menuchoice> When checked, any of your pawns that get promoted will automatically become a queen. Otherwise Knights will prompt you each time a pawn is promoted. + </para> + <para> + <menuchoice><guimenu>Call Flag Automatically</guimenu></menuchoice> This option will automatically declare you the winner of the match if your opponent's clock runs out of time. + </para> + </sect1> + <sect1 id="configure-display"> + <title>Display</title> + <sect2 id="configure-display-general"> + <title>General</title> + <para> + Use the <menuchoice><guimenu>Install New Themes</guimenu></menuchoice> button to install themes that you've downloaded. + </para> + <para> + Use the <menuchoice><guimenu>Board Themes</guimenu></menuchoice> and <menuchoice><guimenu>Chessman Themes</guimenu></menuchoice> buttons to select the look of your board. Knights only includes one board theme and one chessman theme, but others are available for download.<ulink url="http://sourceforge.net/project/showfiles.php?group_id=31461">Click here</ulink> to download the Knights Themepack. + </para> + <para> + <menuchoice><guimenu>Theme Size</guimenu></menuchoice> can be adjusted to make the board larger or smaller. + </para> + <para> + Using the <menuchoice><guimenu>Reverse Board Orientation</guimenu></menuchoice> option is like turning the chessboard 180 degrees. Normally, the board is displayed with your army on the bottom and your opponent's army on top. Checking this option puts your army on the top and your opponent's army on the bottom. + </para> + <para> + <menuchoice><guimenu>Display Startup Logo</guimenu></menuchoice> toggles the welcome screen. + </para> + <para> + <menuchoice><guimenu>Automatic Preview</guimenu></menuchoice> will enable the Preview feature for the left mouse button. + </para> + <para> + <menuchoice><guimenu>Show Last Move</guimenu></menuchoice> will highlight the chessman that moved on the previous turn. + </para> + <para> + <menuchoice><guimenu>Show Coordinates</guimenu></menuchoice> will draw the Rank and File coordinates on the board. + </para> + </sect2> + <sect2 id="configure-display-console"> + <title>Console</title> + <para> + The Font buttons allow you to alter the font for each different kind of text displayed on the console. The Color buttons beside them let you change the color which that font will be displayed in. The seventh extra Color button changes the background color. + </para> + <para> + <menuchoice><guimenu>Restore Defaults</guimenu></menuchoice> will disregard any changes you've made to the font and color options, returning them to their original state. + </para> + </sect2> + </sect1> + <sect1 id="configure-audio"> + <title>Audio</title> + <para> + Knights uses sounds to keep you informed of important events both on and off the board. For example, Knights can play a sound when a chessman is moved, or play another sound when someone sends you a private message online. This section describes the different options you have when it comes to Knights' sounds. + </para> + <para> + The <menuchoice><guimenu>enable Audio</guimenu></menuchoice> checkbox is like the power button on your stereo. Uncheck this, and all of Knights' sounds are turned off. + </para> + <para> + <menuchoice><guimenu>Audio Themes</guimenu></menuchoice> allows you to choose between different audio themes, which are similar to the graphical themes. Knights only includes one sound theme, but others may be available for download from the internet. + </para> + <para> + The <menuchoice><guimenu>Volume</guimenu></menuchoice> slider allows you to adjust how loudly Knights will play it's sounds. + </para> + <note> + <para> + This is independent of the volume controls in your mixer and on your speakers. In other words, if the volume in Knights is at maximum, but your mixer's volume is at minimum, then you will not be able to hear Knights' sounds. + </para> + </note> + <para> + <menuchoice><guimenu>For Current Match Only</guimenu></menuchoice> is a checkbox that allows you to turn off all sounds from chess matches that you are not actively watching. So if you have a match vs. GNUChess running, but you're looking at your match vs. Crafty, only the Crafty match will make sounds. When you click on the GNUChess match again, then it will make sounds again and the Crafty match will fall silent. + </para> + </sect1> + <sect1 id="configure-engines"> + <title>Computer Opponents</title> + <para> + Here you'll be able to configure Knights to use various "Chess Engines", which are computer opponents you can play chess against. These engines are separate programs that do not come with Knights. To use them, you must first download a chess engine. Tim Mann's <ulink url="http://www.tim-mann.org/engines.html">Chess Engines</ulink> page has a great list of available engines for you to download. Knights should work with all of these. See the README and INSTALL instructions that come with each engine to install it. + </para> + <para> + Once you have a chess engine installed, click the <guimenu>Add...</guimenu> button on the right hand side of the window. A new window will be displayed. + </para> + <para> + The only things that you MUST enter to use the engine are the <guimenu>Protocol</guimenu> and the <guimenu>Engine Filename</guimenu>. + </para> + <para> + <guimenu>Engine Name</guimenu> is what Knights will call this engine when you select it as an opponent, or if there is an error. This is set for you if you leave it blank. + </para> + <para> + <guimenu>Protocol</guimenu> is a list of "languages" that computer opponents can speak. Knights acts like a translator by taking what the engine says and converting it into a move on the virtual chessboard. It is important to have the correct protocol or else the engine won't be able to play. + </para> + <note> + <para> + For most engines, you should select XBoard as the protocol. The Knights protocol is reserved for future engines to use. + </para> + </note> + <para> + <guimenu>Engine Filename</guimenu> should contain the actual location of the engine on your filesystem. Include the full path, unless the engine is in the search path. If you don't want to type this in, you can browse your filesystem with the folder icon on the right. Simply find the engine, left click on it, and left click Open. + </para> + <para> + <guimenu>Command Line Arguments</guimenu> is where you should add any special options for this engine. See the engine's documentation for a list of options and their useage. + </para> + <para> + <guimenu>Log File</guimenu> is a special text document which records the "conversation" between Knights and the engine. This is very useful for engine developers and for users who are having trouble getting Knights to work with a particular engine. Most users can leave this blank. + </para> + <para> + Click OK and Knights is now ready to use this engine! + </para> + <para> + You'll notice options which enable "Book Engines". Book engines are a kind of helper for the computer opponent. These types of engines are new and experimental. Therefore, you should not enable these unless you are a chess engine developer or unless you're sure that the engine supports "Bookengine" mode ( XBoard version 3 and Knights protocols ). + </para> + </sect1> + <sect1 id="configure-servers"> + <title>Chess Servers</title> + <para> + This section is where you'll configure all your options related to Internet Chess Servers. + </para> + <sect2 id="configure-servers-servers"> + <title>Servers</title> + <para> + If you'd like to configure Knights to use a new Chess Server, click the "Add..." button on the right hand side of the window. A new window will be displayed. + </para> + <para> + This window is used to tell Knights how it can connect to our chess server. <menuchoice><guimenu>Server Name</guimenu></menuchoice> is a descriptive title for the server. You can enter anything you want here. "My Chess Server", "FICS", etc. + </para> + <para> + <menuchoice><guimenu>Server URL</guimenu></menuchoice> is the address of the server. + </para> + <para> + <menuchoice><guimenu>Server Port</guimenu></menuchoice> tells Knights which port to communicate with the server on. If this is left blank, Knights will try to guess the port number. + </para> + <para> + <menuchoice><guimenu>Username</guimenu></menuchoice> and <menuchoice><guimenu>Password</guimenu></menuchoice> will store your login information. If you do not wish for Knights to remember your login information, just leave these blank and you will be prompted each time you connect. + </para> + <para> + A <menuchoice><guimenu>Timeseal</guimenu></menuchoice> is a program that helps to reduce the effect of Internet lag on your clock. It can be quite unpleasant to lose a match because your Internet connection is slow. If you have a Timeseal program that you'd like to use, enter the full path and filename for it here. + </para> + <para> + <menuchoice><guimenu>Log File</guimenu></menuchoice> can be used to keep a record of your session online. Be warned though: Knights does not maintain the size of your logfiles. + </para> + <para> + When all is done you can click <menuchoice><guimenuitem>OK</guimenuitem></menuchoice> to add this chess server to the list of those Knights will connect with. + </para> + </sect2> + <sect2 id="configure-servers-options"> + <title>Options</title> + <para> + The <menuchoice><guimenu>Profanity Filter</guimenu></menuchoice> can be used to garble undesirable words. It has six levels of filtration. + </para> + <para> + <menuchoice><guimenu>Automatically Close Previous ICS Match</guimenu></menuchoice> does was it says. If you just played a match and you're starting a new one, Knights will go ahead and close the last one for you. + </para> + <para> + <menuchoice><guimenu>Private Matches</guimenu></menuchoice> will tell your ICS that you don't want your match to be observable. + </para> + <para> + The <menuchoice><guimenu>enable Premove</guimenu></menuchoice> option allows you to move your next chessman while it's still your opponent's turn. Knights will remember your selection and move the piece for you as soon as it's your turn again. + </para> + <para> + The <menuchoice><guimenu>enable Kibitzes</guimenu></menuchoice> option will display Kibitz message on the console if enabled. + </para> + <para> + <menuchoice><guimenu>enable Unregistered Tells</guimenu></menuchoice> will allow you to hear messages from unregistered users. + </para> + <para> + <menuchoice><guimenu>enable Shouts</guimenu></menuchoice> will allow you to hear shouts. + </para> + <para> + The <menuchoice><guimenu>enable Seeks</guimenu></menuchoice> option will display Sought Match messages. + </para> + <para> + <menuchoice><guimenu>Seconds Between Seek Updates</guimenu></menuchoice> This tells Knights how often you want it to refresh it's Sought Games List. Valid numbers range between 3 seconds to 2 minutes ( 120 seconds ). + </para> + </sect2> + </sect1> + </chapter> + + <chapter id="key-bindings"> + <title>Command Reference</title> + <itemizedlist> + <listitem> + <para> + <keycombo action="simul"><keycap>UP</keycap></keycombo> - Pressing up will step backwards through the move list and show you the previous position. + </para> + </listitem> + <listitem> + <para> + <keycombo action="simul"><keycap>DOWN</keycap></keycombo> - Pressing down will step forward through the move list and show you the next board position. + </para> + </listitem> + <listitem> + <para> + <keycombo action="simul"><keycap>ENTER</keycap></keycombo> - Pressing Enter will always bring up the Console cursor so you can enter text. Pressing Enter again will remove it and send anything you typed in between. + </para> + </listitem> + <listitem> + <para> + <keycombo action="simul"><keycap>PAGE UP</keycap></keycombo> and <keycombo action="simul"><keycap>PAGE DOWN</keycap></keycombo> - Pressing these keys will scroll the Console up and down. + </para> + </listitem> + <listitem> + <para> + <keycombo action="simul"><keycap>SHIFT + UP</keycap></keycombo> and <keycombo action="simul"><keycap>SHIFT + DOWN</keycap></keycombo> - These will scroll through the history of what you've typed previously. Very handy for repeating commands. + </para> + </listitem> + <listitem> + <para> + <keycombo action="simul"><keycap>ALT + C</keycap></keycombo> - This will begin a reply to the last channel who sent you a tell. + </para> + </listitem> + <listitem> + <para> + <keycombo action="simul"><keycap>ALT + K</keycap></keycombo> - This will begin a kibitz, which can be heard by everyone observing a match, including the players. + </para> + </listitem> + <listitem> + <para> + <keycombo action="simul"><keycap>ALT + R</keycap></keycombo> - This will begin a reply to the last person who sent you a private tell. + </para> + </listitem> + <listitem> + <para> + <keycombo action="simul"><keycap>ALT + W</keycap></keycombo> - This will begin a whisper, which can be heard by everyone observing the current match, but not by the players of that match. + </para> + </listitem> + </itemizedlist> + </chapter> + + <chapter id="credits"> + <title>Credits and License</title> + <para> + Knights + </para> + <para> + Program copyright 2001, 2002 Troy Corbin Jr. <email>[email protected]</email> + </para> + <para> + Documentation copyright 2001, 2002 Troy Corbin Jr. <email>[email protected]</email> + </para> + <!-- TRANS:CREDIT_FOR_TRANSLATORS --> + &underFDL; + &underGPL; + </chapter> + + <appendix id="installation"> + <title>Installation</title> + <sect1 id="installation-obtain-knights"> + <title>How to obtain Knights</title> + <para> + The Knights Project is located at <ulink url="http://knights.sourceforge.net/">http://knights.sourceforge.net</ulink>. It will usually contain the most up-to-date information on Knights available. + </para> + <note> + <para> + If you're using the <ulink url="http://www.opennic.org/">OpenNIC</ulink> root service, then you can reach the Knights Project at <ulink url="http://www.knights.oss/">http://www.knights.oss</ulink>. + </para> + </note> + </sect1> + <sect1 id="installation-requirements"> + <title>Requirements</title> + <para> + Before you can install Knights, you must have the <ulink url="http://www.kde.org">K Desktop Environment</ulink> version 3.x or newer installed on your system. Knights also requires that you have <ulink url="http://www.gnu.org/directory/Software_development/Program_build_automation/autoconf.html">Autoconf</ulink> version 2.5 and <ulink url="http://www.gnu.org/directory/Software_development/Program_build_automation/automake.html">Automake</ulink> version 1.6. + </para> + </sect1> + <sect1 id="installation-compilation"> + <title>Compilation and Installation</title> + <para> + Knights uses <application>autoconf</application> and <application>automake</application> to ensure that compiling is easy. If for some reason Knights won't compile for you, help is available at the Knights Project website located at <ulink url="http://knights.sourceforge.net/">http://knights.sourceforge.net</ulink>. + </para> + <para> + You must have the KDEDIR environment variable defined before you begin the installation. Without this, Knights will not be able to access it's resources! To add the KDEDIR environment variable, you need to edit your /etc/profile ( or ~/.bash_profile ) and add the line: + </para> + <para> + <userinput><command>export KDEDIR="/usr"</command></userinput> + </para> + <para> + ...where /usr is your KDE's base directory. + </para> + <para> + Now, change the present working directory to the location where you unarchived Knights and type the following: + </para> +<informalexample> +<screen width="40"> +<prompt>%</prompt> <userinput><command>./configure</command></userinput> +<prompt>%</prompt> <userinput><command>make</command></userinput> +<prompt>%</prompt> <userinput><command>make</command> <option>install</option></userinput> +</screen> +</informalexample> + <para> + Knights should now be installed and ready to go. You can type <userinput><command>knights</command></userinput> in a terminal to start the game, or create an icon for it and select that. + </para> + </sect1> + </appendix> + + <appendix id="command-line"> + <title>Command Line Options</title> + <para> + Knights is a graphical chess interface and tries to make full use of it. Most every option you'd ever want should be available from Knights' Settings menu and Configure window. However, there are rare cases where a command line option is an absolute must. Here are descriptions for those options. + </para> +<screen width="40"> +<prompt>%</prompt> <userinput><command>knights</command> <option>-d <replaceable>path</replaceable></option></userinput> +</screen> + <para> + The use of this command line option is depreciated. If Knights displays garbage rather than a chessboard, then you did not set the KDEDIR environment variable correctly before compiling Knights. Please see the Installation instructions for the proper compiling procedures. + </para> +<screen width="40"> +<prompt>%</prompt> <userinput><command>knights</command> <option><replaceable>filename</replaceable></option></userinput> +</screen> + <para> + By appending a filename to the command line, you can start Knights with a chess match already loaded for you. + </para> + </appendix> + + <appendix id="kml"> + <title>Knights Markup Language</title> + <para> + The Knights Markup Language is a variation on HTML with the specific purpose of formatting and displaying PGN data. The formatting is actually done using Qt's default rich-text commands. Since these are already explained at length on Trolltech's <ulink url="http://doc.trolltech.com/3.1/qstylesheet.html#details">website</ulink>, they will not be covered here. + </para> + <para> + This appendix lists the macros used within KML to represent PGN data. These macros are case-sensitive. + </para> + <para> + <command>%whiteimage%</command> - This will be replaced with an image showing the white player's picture, or a generic image if Knights can't find it. + </para> + <para> + <command>%blackimage%</command> - This will be replaced with an image showing the black player's picture, or a generic image if Knights can't find it. + </para> + <para> + <command>%moves%</command> - This represents the move data. Recursive annotations appear in italics, while comments appear in bold type. + </para> + <para> + <command>%site%</command> - Represents the PGN tag: Site. + </para> + <para> + <command>%date%</command> - Represents the PGN tag: Date. + </para> + <para> + <command>%round%</command> - Represents the PGN tag: Round. + </para> + <para> + <command>%result%</command> - Represents the PGN tag: Result. + </para> + <para> + <command>%white%</command> - Represents the PGN tag: White. + </para> + <para> + <command>%whitetitle%</command> - Represents the PGN tag: White Title. + </para> + <para> + <command>%whiteelo%</command> - Represents the PGN tag: White ELO. + </para> + <para> + <command>%whiteuscf%</command> - Represents the PGN tag: White USCF. + </para> + <para> + <command>%whitena%</command> - Represents the PGN tag: White NA. + </para> + <para> + <command>%whitetype%</command> - Represents the PGN tag: White Type. + </para> + <para> + <command>%black%</command> - Represents the PGN tag: Black. + </para> + <para> + <command>%blacktitle%</command> - Represents the PGN tag: Black Title. + </para> + <para> + <command>%blackelo%</command> - Represents the PGN tag: Black ELO. + </para> + <para> + <command>%blackuscf%</command> - Represents the PGN tag: Black USCF. + </para> + <para> + <command>%blackna%</command> - Represents the PGN tag: Black NA. + </para> + <para> + <command>%blacktype%</command> - Represents the PGN tag: Black Type. + </para> + <para> + <command>%time%</command> - Represents the PGN tag: Time. + </para> + <para> + <command>%utctime%</command> - Represents the PGN tag: UTC Time. + </para> + <para> + <command>%utcdate%</command> - Represents the PGN tag: UTC Date. + </para> + <para> + <command>%event%</command> - Represents the PGN tag: Event. + </para> + <para> + <command>%eventdate%</command> - Represents the PGN tag: Event Date. + </para> + <para> + <command>%eventsponsor%</command> - Represents the PGN tag: Event Sponsor. + </para> + <para> + <command>%section%</command> - Represents the PGN tag: Section. + </para> + <para> + <command>%stage%</command> - Represents the PGN tag: Stage. + </para> + <para> + <command>%board%</command> - Represents the PGN tag: Board. + </para> + <para> + <command>%opening%</command> - Represents the PGN tag: Opening. + </para> + <para> + <command>%variation%</command> - Represents the PGN tag: Variation. + </para> + <para> + <command>%subvariation%</command> - Represents the PGN tag: Subvariation. + </para> + <para> + <command>%eco%</command> - Represents the PGN tag: ECO. + </para> + <para> + <command>%nic%</command> - Represents the PGN tag: NIC. + </para> + <para> + <command>%timecontrol%</command> - Represents the PGN tag: Time Control. + </para> + <para> + <command>%termination%</command> - Represents the PGN tag: Termination. + </para> + <para> + <command>%setup%</command> - Represents the PGN tag: Setup. + </para> + <para> + <command>%fen%</command> - Represents the PGN tag: FEN. + </para> + <para> + <command>%annotator%</command> - Represents the PGN tag: Annotator. + </para> + <para> + <command>%mode%</command> - Represents the PGN tag: Mode. + </para> + <para> + <command>%plycount%</command> - Represents the PGN tag: Plycount. + </para> + </appendix> +</book> +<!-- +Local Variables: +mode: sgml +sgml-omittag: nil +sgml-shorttag: t +End: +--> + + + |