From: Arun Persaud Date: Sat, 18 Oct 2014 05:19:31 +0000 (+0000) Subject: updated manual X-Git-Url: http://winboard.nl/cgi-bin?p=xboard.git;a=commitdiff_plain;h=a36b2aca1054f083cd50958eff7e347e8aa6bfc5 updated manual --- diff --git a/manual/html_node/Action-Menu.html b/manual/html_node/Action-Menu.html index 3c36455..8957677 100644 --- a/manual/html_node/Action-Menu.html +++ b/manual/html_node/Action-Menu.html @@ -34,45 +34,45 @@ Up: Menus

3.5 Action Menu

-

+

-
Accept
Accepts a pending match offer. +
Accept
Accepts a pending match offer. The F3 key is a keyboard equivalent. If there is more than one offer pending, you will have to type in a more specific command instead of using this menu choice. -
Decline
Declines a pending offer (match, draw, adjourn, etc.). +
Decline
Declines a pending offer (match, draw, adjourn, etc.). The F4 key is a keyboard equivalent. If there is more than one offer pending, you will have to type in a more specific command instead of using this menu choice. -
Call Flag
Calls your opponent's flag, claiming a win on time, or claiming +
Call Flag
Calls your opponent's flag, claiming a win on time, or claiming a draw if you are both out of time. The F5 key is a keyboard equivalent. You can also call your opponent's flag by clicking on his clock. -
Draw
Offers a draw to your opponent, accepts a pending draw offer +
Draw
Offers a draw to your opponent, accepts a pending draw offer from your opponent, or claims a draw by repetition or the 50-move rule, as appropriate. The F6 key is a keyboard equivalent. -
Adjourn
Asks your opponent to agree to adjourning the current game, or +
Adjourn
Asks your opponent to agree to adjourning the current game, or agrees to a pending adjournment offer from your opponent. The F7 key is a keyboard equivalent. -
Abort
Asks your opponent to agree to aborting the current game, or +
Abort
Asks your opponent to agree to aborting the current game, or agrees to a pending abort offer from your opponent. The F8 key is a keyboard equivalent. An aborted game ends immediately without affecting either player's rating. -
Resign
Resigns the game to your opponent. The F9 key is a +
Resign
Resigns the game to your opponent. The F9 key is a keyboard equivalent. -
Stop Observing
Ends your participation in observing a game, by issuing the ICS +
Stop Observing
Ends your participation in observing a game, by issuing the ICS observe command with no arguments. ICS mode only. The F10 key is a keyboard equivalent. -
Stop Examining
Ends your participation in examining a game, by issuing the ICS +
Stop Examining
Ends your participation in examining a game, by issuing the ICS unexamine command. ICS mode only. The F11 key is a keyboard equivalent. -
Upload to Examine
Create an examined game of the proper variant on the ICS, +
Upload to Examine
Create an examined game of the proper variant on the ICS, and send the game there that is currenty loaded in XBoard (e.g. through pasting or loading from file). You must be connected to an ICS for this to work. -
Adjudicate to White
Adjudicate to Black
Adjudicate Draw
Terminate an ongoing game in Two-Machines mode (including match mode), +
Adjudicate to White
Adjudicate to Black
Adjudicate Draw
Terminate an ongoing game in Two-Machines mode (including match mode), with as result a win for white, for black, or a draw, respectively. The PGN file of the game will accompany the result string by the comment "user adjudication". diff --git a/manual/html_node/Adjudication-Options.html b/manual/html_node/Adjudication-Options.html index 63570ca..ac9eb38 100644 --- a/manual/html_node/Adjudication-Options.html +++ b/manual/html_node/Adjudication-Options.html @@ -34,35 +34,35 @@ Up: Options

4.7 Adjudication Options

-

+

-
-adjudicateLossThreshold n
If the given value is non-zero, XBoard adjudicates the game as a loss +
-adjudicateLossThreshold n
If the given value is non-zero, XBoard adjudicates the game as a loss if both engines agree for a duration of 6 consecutive ply that the score is below the given score threshold for that engine. Make sure the score is interpreted properly by XBoard, using -firstScoreAbs and -secondScoreAbs if needed. Default: 0 (no adjudication) -
-adjudicateDrawMoves n
If the given value is non-zero, XBoard adjudicates the game as a draw +
-adjudicateDrawMoves n
If the given value is non-zero, XBoard adjudicates the game as a draw if after the given number of moves it was not yet decided. Default: 0 (no adjudication) -
-checkMates true/false
If this option is set, XBoard detects all checkmates and stalemates, +
-checkMates true/false
If this option is set, XBoard detects all checkmates and stalemates, and ends the game as soon as they occur. Legality-testing must be switched on for this option to work. Default: true -
-testClaims true/false
If this option is set, XBoard verifies all result claims made by engines, +
-testClaims true/false
If this option is set, XBoard verifies all result claims made by engines, and those who send false claims will forfeit the game because of it. Legality-testing must be switched on for this option to work. Default: true -
-materialDraws true/false
If this option is set, XBoard adjudicates games as draws when there is +
-materialDraws true/false
If this option is set, XBoard adjudicates games as draws when there is no sufficient material left to inflict a checkmate. This applies to KBKB with like bishops (any number, actually), and to KBK, KNK and KK. Legality-testing must be switched on for this option to work. Default: true -
-trivialDraws true/false
If this option is set, XBoard adjudicates games as draws that cannot be +
-trivialDraws true/false
If this option is set, XBoard adjudicates games as draws that cannot be usually won without opponent cooperation. This applies to KBKB with unlike bishops, and to KBKN, KNKN, KNNK, KRKR and KQKQ. The draw is called after 6 ply into these end-games, to allow quick mates that can occur in some exceptional positions to be found by the engines. KQKQ does not really belong in this category, and might be taken out in the future. (When bitbase-based adjudications are implemented.) Legality-testing must be on for this option to work. Default: false -
-ruleMoves n
If the given value is non-zero, XBoard adjudicates the game as a draw after the given +
-ruleMoves n
If the given value is non-zero, XBoard adjudicates the game as a draw after the given number of consecutive reversible moves. Engine draw claims are always accepted after 50 moves, irrespective of the given value of n.
-repeatsToDraw n
If the given value is non-zero, xboard adjudicates the game as a draw if a position diff --git a/manual/html_node/CMail.html b/manual/html_node/CMail.html index 4362365..e0feae5 100644 --- a/manual/html_node/CMail.html +++ b/manual/html_node/CMail.html @@ -33,7 +33,7 @@ Up: Top

11 CMail

-

The cmail program can help you play chess by email with opponents of +

The cmail program can help you play chess by email with opponents of your choice using XBoard as an interface.

You will usually run cmail without giving any options. diff --git a/manual/html_node/Chess-Servers.html b/manual/html_node/Chess-Servers.html index 718f7a6..dccabf2 100644 --- a/manual/html_node/Chess-Servers.html +++ b/manual/html_node/Chess-Servers.html @@ -33,7 +33,7 @@ Up: Top

5 Chess Servers

-

An Internet Chess Server, or ICS, is a place on the +

An Internet Chess Server, or ICS, is a place on the Internet where people can get together to play chess, watch other people's games, or just chat. You can use either telnet or a client program like XBoard to connect to the server. There are @@ -66,25 +66,25 @@ unique guest name for you.

Some useful ICS commands include

-
help <topic>
to get help on the given <topic>. To get a list of possible topics type +
help <topic>
to get help on the given <topic>. To get a list of possible topics type help without topic. Try the help command before you ask other people on the server for help.

For example help register tells you how to become a registered ICS player. -

who <flags>
to see a list of people who are logged on. Administrators +
who <flags>
to see a list of people who are logged on. Administrators (people you should talk to if you have a problem) are marked with the character ‘*’, an asterisk. The <flags> allow you to display only selected players: For example, who of shows a list of players who are interested in playing but do not have an opponent. -
games
to see what games are being played +
games
to see what games are being played
match <player> [<mins>] [<inc>]
to challenge another player to a game. Both opponents get <mins> minutes for the game, and <inc> seconds will be added after each move. If another player challenges you, the server asks if you want to accept the challenge; use the accept or decline commands to answer. -
accept
decline
to accept or decline another player's offer. +
accept
decline
to accept or decline another player's offer. The offer may be to start a new game, or to agree to a draw, adjourn or abort the current game. See Action Menu. @@ -92,7 +92,7 @@ The offer may be to start a new game, or to agree to a is challenging you, or if your opponent offers both a draw and to adjourn the game), you have to supply additional information, by typing something like accept <player>, accept draw, or draw. -
draw
adjourn
abort
asks your opponent to terminate a game by mutual agreement. Adjourned +
draw
adjourn
abort
asks your opponent to terminate a game by mutual agreement. Adjourned games can be continued later. Your opponent can either decline your offer or accept it (by typing the same command or typing accept). In some cases these commands work @@ -100,11 +100,11 @@ immediately, without asking your opponent to agree. For example, you can abort the game unilaterally if your opponent is out of time, and you can claim a draw by repetition or the 50-move rule if available simply by typing draw. -
finger <player>
to get information about the given <player>. (Default: yourself.) -
vars
to get a list of personal settings -
set <var> <value>
to modify these settings -
observe <player>
to observe an ongoing game of the given <player>. -
examine
oldmoves
to review a recently completed game +
finger <player>
to get information about the given <player>. (Default: yourself.) +
vars
to get a list of personal settings +
set <var> <value>
to modify these settings +
observe <player>
to observe an ongoing game of the given <player>. +
examine
oldmoves
to review a recently completed game

Some special XBoard features are activated when you are diff --git a/manual/html_node/Chess-engine-options.html b/manual/html_node/Chess-engine-options.html index 1f27438..70d3ca4 100644 --- a/manual/html_node/Chess-engine-options.html +++ b/manual/html_node/Chess-engine-options.html @@ -32,36 +32,36 @@ Up: Options

4.1 Chess Engine Options

-

+

-
-tc or -timeControl minutes[:seconds]
Each player begins with his clock set to the timeControl period. +
-tc or -timeControl minutes[:seconds]
Each player begins with his clock set to the timeControl period. Default: 5 minutes. The additional options movesPerSession and timeIncrement are mutually exclusive. -
-mps or -movesPerSession moves
When both players have made movesPerSession moves, a +
-mps or -movesPerSession moves
When both players have made movesPerSession moves, a new timeControl period is added to both clocks. Default: 40 moves. -
-inc or -timeIncrement seconds
If this option is specified, movesPerSession is ignored. +
-inc or -timeIncrement seconds
If this option is specified, movesPerSession is ignored. Instead, after each player's move, timeIncrement seconds are added to his clock. Use ‘-inc 0’ if you want to require the entire game to be played in one timeControl period, with no increment. Default: -1, which specifies movesPerSession mode. -
-clock/-xclock or -clockMode true/false
Determines whether or not to display the chess clocks. If clockMode is +
-clock/-xclock or -clockMode true/false
Determines whether or not to display the chess clocks. If clockMode is false, the clocks are not shown, but the side that is to play next is still highlighted. Also, unless searchTime is set, the chess engine still keeps track of the clock time and uses it to determine how fast to make its moves. -
-st or -searchTime minutes[:seconds]
Tells the chess engine to spend at most the given amount of time +
-st or -searchTime minutes[:seconds]
Tells the chess engine to spend at most the given amount of time searching for each of its moves. Without this option, the chess engine chooses its search time based on the number of moves and amount of time remaining until the next time control. Setting this option also sets clockMode to false. -
-depth or -searchDepth number
Tells the chess engine to look ahead at most the given number of moves +
-depth or -searchDepth number
Tells the chess engine to look ahead at most the given number of moves when searching for a move to make. Without this option, the chess engine chooses its search depth based on the number of moves and amount of time remaining until the next time control. With the option, the engine will cut off its search early if it reaches the specified depth. -
-firstNPS number
-secondNPS number
Tells the chess engine to use an internal time standard based on its node count, +
-firstNPS number
-secondNPS number
Tells the chess engine to use an internal time standard based on its node count, rather then wall-clock time, to make its timing decisions. The time in virtual seconds should be obtained by dividing the node count through the given number, like the number was a rate in nodes per second. @@ -74,16 +74,16 @@ can provide fairer conditions for engine-engine matches on heavily loaded machin or with very fast games (where the wall clock is too inaccurate). showThinking must be on for this option to work. Default: -1 (off). Not many engines might support this yet! -
-firstTimeOdds factor
-secondTimeOdds factor
Reduces the time given to the mentioned engine by the given factor. +
-firstTimeOdds factor
-secondTimeOdds factor
Reduces the time given to the mentioned engine by the given factor. If pondering is off, the effect is indistinguishable from what would happen if the engine was running on an n-times slower machine. Default: 1. -
-timeOddsMode mode
This option determines how the case is handled where both engines have a time-odds handicap. +
-timeOddsMode mode
This option determines how the case is handled where both engines have a time-odds handicap. If mode=1, the engine that gets the most time will always get the nominal time, as specified by the time-control options, and its opponent's time is renormalized accordingly. If mode=0, both play with reduced time. Default: 0.
-hideThinkingFromHuman true/false
Controls the Hide Thinking option. See Options Menu. Default: true. (Replaces the Show-Thinking option of older xboard versions.) -
-thinking/-xthinking or -showThinking true/false
Forces the engine to send thinking output to xboard. +
-thinking/-xthinking or -showThinking true/false
Forces the engine to send thinking output to xboard. Used to be the only way to control if thinking output was displayed in older xboard versions, but as the thinking output in xboard 4.3 is also used for several other @@ -91,10 +91,10 @@ purposes (adjudication, storing in PGN file) the display of it is now controlled by the new option Hide Thinking. See Options Menu. Default: false. (But if xboard needs the thinking output for some purpose, it makes the engine send it despite the setting of this option.) -
-ponder/-xponder or -ponderNextMove true/false
Sets the Ponder Next Move menu option. See Options Menu. Default: true. +
-ponder/-xponder or -ponderNextMove true/false
Sets the Ponder Next Move menu option. See Options Menu. Default: true.
-smpCores number
Specifies the maximum number of CPUs an SMP engine is allowed to use. Only works for engines that support the XBoard/WinBoard-protocol cores feature. -
-mg or -matchGames n
Automatically runs an n-game match between two chess engines, +
-mg or -matchGames n
Automatically runs an n-game match between two chess engines, with alternating colors. If the loadGameFile or loadPositionFile option is set, XBoard @@ -105,42 +105,42 @@ match is appended to the specified file. If the savePositionFile option is set, the final position reached in each game of the match is appended to the specified file. When the match is over, XBoard displays the match score and exits. Default: 0 (do not run a match). -
-mm/-xmm or -matchMode true/false
Setting matchMode to true is equivalent to setting +
-mm/-xmm or -matchMode true/false
Setting matchMode to true is equivalent to setting matchGames to 1. -
-sameColorGames n
Automatically runs an n-game match between two chess engines, +
-sameColorGames n
Automatically runs an n-game match between two chess engines, without alternating colors. Otherwise the same applies as for the ‘-matchGames’ option, over which it takes precedence if both are specified. (See there.) Default: 0 (do not run a match). -
-fcp or -firstChessProgram program
Name of first chess engine. +
-fcp or -firstChessProgram program
Name of first chess engine. Default: Fairy-Max. -
-scp or -secondChessProgram program
Name of second chess engine, if needed. +
-scp or -secondChessProgram program
Name of second chess engine, if needed. A second chess engine is started only in Two Machines (match) mode. Default: Fairy-Max. -
-fe or -firstEngine nickname
This is an alternative to the fcp option for specifying the first engine, +
-fe or -firstEngine nickname
This is an alternative to the fcp option for specifying the first engine, for engines that were already configured (using the ‘Load Engine’ dialog) in XBoard's settings file. It will not only retrieve the real name of the engine, but also all options configured with it. (E.g. if it is UCI, whether it should use book.) -
-se or -secondEngine nickname
As fe, but for the second engine. -
-fb/-xfb or -firstPlaysBlack true/false
In games between two chess engines, firstChessProgram normally plays +
-se or -secondEngine nickname
As fe, but for the second engine. +
-fb/-xfb or -firstPlaysBlack true/false
In games between two chess engines, firstChessProgram normally plays white. If this option is true, firstChessProgram plays black. In a multi-game match, this option affects the colors only for the first game; they still alternate in subsequent games. -
-fh or -firstHost host
-sh or -secondHost host
Hosts on which the chess engines are to run. The default for +
-fh or -firstHost host
-sh or -secondHost host
Hosts on which the chess engines are to run. The default for each is localhost. If you specify another host, XBoard uses rsh to run the chess engine there. (You can substitute a different remote shell program for rsh using the remoteShell option described below.) -
-fd or -firstDirectory dir
-sd or -secondDirectory dir
Working directories in which the chess engines are to be run. +
-fd or -firstDirectory dir
-sd or -secondDirectory dir
Working directories in which the chess engines are to be run. The default is "", which means to run the chess engine in the same working directory as XBoard itself. (See the CHESSDIR environment variable.) This option is effective only when the chess engine is being run on the local host; it does not work if the engine is run remotely using the -fh or -sh option. -
-initString string or -firstInitString
-secondInitString string
The string that is sent to initialize each chess engine for a new game. +
-initString string or -firstInitString
-secondInitString string
The string that is sent to initialize each chess engine for a new game. Default: 
          new
@@ -165,11 +165,11 @@ and always (or never) randomize.
 
      
You can also try adding other commands to the initString; see the
 documentation of the chess engine you are using for details. 
-
-firstComputerString string
-secondComputerString string
The string that is sent to the chess engine if its opponent is another
+
-firstComputerString string
-secondComputerString string
The string that is sent to the chess engine if its opponent is another
 computer chess engine.  The default is ‘computer\n’.  Probably the
 only useful alternative is the empty string (‘’), which keeps the
 engine from knowing that it is playing another computer. 
-
-reuse/-xreuse or -reuseFirst true/false
-reuse2/-xreuse2 or -reuseSecond true/false
If the option is false,
+
-reuse/-xreuse or -reuseFirst true/false
-reuse2/-xreuse2 or -reuseSecond true/false
If the option is false,
 XBoard kills off the chess engine after every game and starts
 it again for the next game. 
 If the option is true (the default),
@@ -177,26 +177,26 @@ XBoard starts the chess engine only once
 and uses it repeatedly to play multiple games. 
 Some old chess engines may not work properly when
 reuse is turned on, but otherwise games will start faster if it is left on. 
-
-firstProtocolVersion version-number
-secondProtocolVersion version-number
This option specifies which version of the chess engine communication
+
-firstProtocolVersion version-number
-secondProtocolVersion version-number
This option specifies which version of the chess engine communication
 protocol to use.  By default, version-number is 2.  In version 1, the
 "protover" command is not sent to the engine; since version 1 is a
 subset of version 2, nothing else changes.  Other values for
 version-number are not supported. 
-
-firstScoreAbs true/false
-secondScoreAbs true/false
If this option is set, the score reported by the engine is taken to be
+
-firstScoreAbs true/false
-secondScoreAbs true/false
If this option is set, the score reported by the engine is taken to be
 that in favor of white, even when the engine plays black. 
 Important when XBoard uses the score for adjudications, or in PGN reporting. 
-
-niceEngines priority
This option allows you to lower the priority of the engine processes,
+
-niceEngines priority
This option allows you to lower the priority of the engine processes,
 so that the generally insatiable hunger for CPU time of chess engines does not interfere so much
 with smooth operation of XBoard (or the rest of your system). 
 Negative values could increase the engine priority, which is not recommended. 
-
-firstOptions string
-secondOptions string
The given string is a comma-separated list of (option name=option value) pairs,
+
-firstOptions string
-secondOptions string
The given string is a comma-separated list of (option name=option value) pairs,
 like the following example: "style=Karpov,blunder rate=0". 
 If an option announced by the engine at startup through the feature commands of the XBoard/WinBoard protocol
 matches one of the option names (i.e. "style" or "blunder rate"),
 it would be set to the given value (i.e. "Karpov" or 0)
 through a corresponding option command to the engine. 
 This provided that the type of the value (text or numeric) matches as well. 
-
-firstNeedsNoncompliantFEN string
-secondNeedsNoncompliantFEN string
The castling rights and e.p. fields of the FEN sent to the mentioned engine
+
-firstNeedsNoncompliantFEN string
-secondNeedsNoncompliantFEN string
The castling rights and e.p. fields of the FEN sent to the mentioned engine
 with the setboard command will be replaced by the given string. This can for
 instance be used to run engines that do not understand Chess960 FENs in
 variant fischerandom, to make them at least understand the opening position,
@@ -206,7 +206,7 @@ castling and e.p. fields in variants that do not have castling or e.p.
 (shatranj, courier, xiangqi, shogi) so that XBoard would normally omit them
 (string = "- -"), or to add variant-specific fields that are not yet supported by XBoard
 (e.g. to indicate the number of checks in 3check). 
-
-shuffleOpenings
Forces shuffling of the opening setup in variants that normally have a fixed initial position. 
+
-shuffleOpenings
Forces shuffling of the opening setup in variants that normally have a fixed initial position. 
 Shufflings are symmetric for black and white, and exempt King and Rooks in variants
 with normal castling. 
 Remains in force until a new variant is selected. 
diff --git a/manual/html_node/Contributors.html b/manual/html_node/Contributors.html
index 16fc06e..624c7a7 100644
--- a/manual/html_node/Contributors.html
+++ b/manual/html_node/Contributors.html
@@ -33,7 +33,7 @@ Up: Top
 
 
10 Authors and contributors

 
-

+

 Chris Sears and Dan Sears wrote the original XBoard.  They were
 responsible for versions 1.0 through 1.2.  The color scheme was taken
 from Wayne Christopher's XChess program.
diff --git a/manual/html_node/Copyright.html b/manual/html_node/Copyright.html
index c8400b6..cdf742f 100644
--- a/manual/html_node/Copyright.html
+++ b/manual/html_node/Copyright.html
@@ -54,7 +54,7 @@ arising out of or in connection with the use or performance of this
 software.
 
    
Enhancements copyright © 1992-2003, 2004, 2005, 2006, 2007,
-2008, 2009, 2010, 2011, 2012, 2013 Free Software Foundation, Inc.
+2008, 2009, 2010, 2011, 2012, 2013, 2014 Free Software Foundation, Inc.
 
 
Published by the Free Software Foundation
 59 Temple Place - Suite 330
diff --git a/manual/html_node/Crafty.html b/manual/html_node/Crafty.html
index 3c140e2..82cb858 100644
--- a/manual/html_node/Crafty.html
+++ b/manual/html_node/Crafty.html
@@ -7,7 +7,6 @@
 
 
 
-