From: Arun Persaud Date: Sun, 11 Mar 2012 20:04:18 +0000 (+0000) Subject: updated the manual to version 4.6.0 X-Git-Url: http://winboard.nl/cgi-bin?a=commitdiff_plain;h=f8e035410d7c94ad891763384096e500f91646b1;p=xboard.git updated the manual to version 4.6.0 --- diff --git a/manual/html_node/Action-Menu.html b/manual/html_node/Action-Menu.html index 68be0eb..d20d880 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 299a1ca..282afee 100644 --- a/manual/html_node/Adjudication-Options.html +++ b/manual/html_node/Adjudication-Options.html @@ -32,37 +32,37 @@ Up: Options
-

4.6 Adjudication 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-options.html b/manual/html_node/CMail-options.html index 4f75461..bc2d857 100644 --- a/manual/html_node/CMail-options.html +++ b/manual/html_node/CMail-options.html @@ -55,7 +55,7 @@ other color is assumed. If no color is specified then equal numbers of White and Black games are started, with the extra game being as White if an odd number of total games is specified.
-me <short name>
-opp <short name>
A one-word alias for yourself or your opponent. -
-wname <full name>
-bname <full name>
-name <full name>
-oppname <full name>
The full name of White, Black, yourself or your opponent. +
-wname <full name>
-bname <full name>
-myname <full name>
-oppname <full name>
The full name of White, Black, yourself or your opponent.
-wna <net address>
-bna <net address>
-na <net address>
-oppna <net address>
The email address of White, Black, yourself or your opponent.
-dir <directory>
The directory in which cmail keeps its files. This defaults to the environment variable $CMAIL_DIR or failing that, $CHESSDIR, diff --git a/manual/html_node/CMail.html b/manual/html_node/CMail.html index f9eef8d..5a41c85 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 53b8c99..dd4134f 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 5b70f78..bc468be 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,35 +105,35 @@ 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. -
-fb/-xfb or -firstPlaysBlack true/false
In games between two chess engines, firstChessProgram normally plays +
-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
-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
@@ -160,11 +160,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), @@ -172,26 +172,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, @@ -201,7 +201,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 004342f..e5b9f31 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 850c55a..4ec3ef3 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 Free Software Foundation, Inc. +2008, 2009, 2010, 2011, 2012 Free Software Foundation, Inc.

Published by the Free Software Foundation
 59 Temple Place - Suite 330
diff --git a/manual/html_node/Edit-Menu.html b/manual/html_node/Edit-Menu.html
index 4e850aa..c028690 100644
--- a/manual/html_node/Edit-Menu.html
+++ b/manual/html_node/Edit-Menu.html
@@ -50,11 +50,16 @@ to another application (such as a text editor or another copy of
 XBoard) using that application's paste command.  In many X
 applications, such as xterm and emacs, the middle mouse button can be
 used for pasting; in XBoard, you must use the Paste Position command. 
-
Paste Game
Interprets the current X selection as a game record and loads it, as +
Copy Game List
Copies the current game list to the clipboard, +and sets the X selection to this text. +A format of comma-separated double-quoted strings is used, +including all tags, +so it can be easily imported into spread-sheet programs. +
Paste Game
Interprets the current X selection as a game record and loads it, as with Load Game. The Ctrl-V key is a keyboard equivalent. -
Paste Position
Interprets the current X selection as a FEN position and loads it, as +
Paste Position
Interprets the current X selection as a FEN position and loads it, as with Load Position. The shifted Ctrl-V key is a keyboard equivalent. -
Edit Game
Allows you to make moves for both Black and White, and to change +
Edit Game
Allows you to make moves for both Black and White, and to change moves after backing up with the ‘Backward’ command. The clocks do not run. The Ctrl-E key is a keyboard equivalent. @@ -68,15 +73,26 @@ XBoard out of ICS Client mode and lets you edit games locally. If you want to edit games on ICS in a way that other ICS users can see, use the ICS examine command or start an ICS match against yourself. -
Edit Position
Lets you set up an arbitrary board position. +
Edit Position
Lets you set up an arbitrary board position. The shifted Ctrl-E key is a keyboard equivalent. Use mouse button 1 to drag pieces to new squares, or to delete a piece by dragging it off the board or dragging an empty square on top of it. To drop a new piece on a square, press mouse button 2 or 3 over the -square. This brings up a menu of white pieces (button 2) or -black pieces (button 3). Additional menu choices let you empty the -square or clear the board. You can set the side to play next by -clicking on the word White or Black at the top of the screen. +square. +This puts a white or black pawn in the square, respectively, +but you can change that to any other piece type by dragging the +mouse down before you release the button. +You will then see the piece on the originally clicked square +cycle through the available pieces +(including those of opposite color), +and can release the button when you see the piece you want. +To alter the side to move, you can click the clock +(the words White and Black above the board) +of the side you want to give the move to. +To clear the board you can click the clock of the side that +alread has the move (which is highlighted in black). +The old behavior with a piece menu can still be configured +with the aid of the pieceMenu option. Selecting ‘Edit Position’ causes XBoard to discard all remembered moves in the current game. @@ -86,7 +102,7 @@ not sent to the ICS: ‘Edit Position edit positions on ICS in a way that other ICS users can see, use the ICS examine command, or start an ICS match against yourself. (See also the ICS Client topic above.) -
Edit Tags
Lets you edit the PGN (portable game notation) +
Edit Tags
Lets you edit the PGN (portable game notation) tags for the current game. After editing, the tags must still conform to the PGN tag syntax: @@ -110,10 +126,18 @@ the PGN tag syntax: the PGN standard requires all games to have at least the seven tags shown above. Any that you omit will be filled in by XBoard with ‘?’ (unknown value), or ‘-’ (inapplicable value). -
Edit Comment
Adds or modifies a comment on the current position. Comments are +
Edit Comment
Adds or modifies a comment on the current position. Comments are saved by ‘Save Game’ and are displayed by ‘Load Game’, ‘Forward’, and ‘Backward’. -
Revert
Annotate
If you are examining an ICS game and Pause mode is off, +
Edit Book
Pops up a window listing the moves available in the GUI book +(specified in the ‘Common Engine Settings’ dialog) +from the currently displayed position, +together with their weights and (optionally in braces) learn info. +You can then edit this list, and the new list will be stored +back into the book when you press OK. +Note that the listed percentages are neither used, nor updated when +you change the weights; they are just there as an optical aid. +
Revert
Annotate
If you are examining an ICS game and Pause mode is off, Revert issues the ICS command ‘revert’. In local mode, when you were editing or analyzing a game, and the -variations command-line option is switched on, @@ -133,11 +157,11 @@ the variation you are now abandoning will be added as a comment (in PGN variation syntax, i.e. between parentheses) to the original move where you deviated, for later recalling. The Home key is a keyboard equivalent to ‘Revert’. -
Truncate Game
Discards all remembered moves of the game beyond the current +
Truncate Game
Discards all remembered moves of the game beyond the current position. Puts XBoard into ‘Edit Game’ mode if it was not there already. The End key is a keyboard equivalent. -
Backward
Steps backward through a series of remembered moves. +
Backward
Steps backward through a series of remembered moves. The ‘[<]’ button and the Alt+LeftArrow key are equivalents, as is turning the mouse wheel towards you. In addition, pressing the Control key steps back one move, and releasing @@ -156,7 +180,7 @@ off, ‘Backward’ issues the IC everyone's view of the game and allows you to make a different move. If Pause mode is on, ‘Backward’ only backs up your local view. -
Forward
Steps forward through a series of remembered moves (undoing the +
Forward
Steps forward through a series of remembered moves (undoing the effect of ‘Backward’) or forward through a game file. The ‘[>]’ button and the Alt+RightArrow key are equivalents, as is turning the mouse wheel away from you. @@ -168,7 +192,7 @@ everyone's view of the game forward along the current line. If Pause mode is on, ‘Forward’ only moves your local view forward, and it will not go past the position that the game was in when you paused. -
Back to Start
Jumps backward to the first remembered position in the game. +
Back to Start
Jumps backward to the first remembered position in the game. The ‘[<<]’ button and the Alt+Home key are equivalents.

In most modes, Back to Start only lets you look back at old @@ -185,7 +209,7 @@ is off, ‘Back to Start’ issue command, which backs up everyone's view of the game to the start and allows you to make different moves. If Pause mode is on, ‘Back to Start’ only backs up your local view. -

Forward to End
Jumps forward to the last remembered position in the game. The +
Forward to End
Jumps forward to the last remembered position in the game. The ‘[>>]’ button and the Alt+End key are equivalents.

If you are examining an ICS game, the behavior of ‘Forward to diff --git a/manual/html_node/Engine-Menu.html b/manual/html_node/Engine-Menu.html index 1025506..e9c1e26 100644 --- a/manual/html_node/Engine-Menu.html +++ b/manual/html_node/Engine-Menu.html @@ -34,9 +34,38 @@ Up: Menus

3.6 Engine Menu

-

+

-
Engine #N Settings
Pop up a menu dialog to alter the settings specific to the applicable engine. +
Load Engine
Pops up a dialog where you can select or specify an engine to be loaded. +You will always have to indicate whether you want to load the engine +as first or second engine, through the ‘Load menitioned engine as’ +drop-down list at the bottom of the dialog. +You can even replace engines during a game, without disturbing that game. +(Beware that after loading an engine, XBoard will always be in Edit Game mode, +so you will have to tell the new engine what to do before it does anything!) +When you select an already installed engine from the ‘Select Engine from List’ +drop-down list, +all other fields of the dialog will be ignored. +In other cases, you have to specify the engine executable, +possible arguments on the engine command line +(if the engine docs say the engine needs any), +and the directory where the engine should look for its files +(if this cannot be deduced automatically from the specification of the engine executable). +You will also have to specify (with the aid of checkboxes) if the engine is UCI. +If ‘Add this engine to the list’ is ticked (which it is by default), +the engine will be added to the list of installed engines in your settings file, +(provided you save the settings!), +so that next time you can select it from the drop-down list. +You can also specify a ‘nickname’, +under which the engine will then appear in that drop-down list, +and even choose to use that nickname for it in PGN files for engine-engine games. +The info you supply with the checkboxes whether the engine should use GUI book, +or (for variant engines) automatically switch to the current variant when loaded, +will also be included in the list. +For obsolete XBoard engines, which would normally take a long delay to load +because XBoard is waiting for a response they will not give, +you can tick ‘WB protocol v1’ to speed up the loading process. +
Engine #N Settings
Pop up a menu dialog to alter the settings specific to the applicable engine. (The second engine is only accessible once it has been used in Two-Machines mode.) For each parameter the engine allows to be set, a control element will appear in this dialog that can be used to alter the value. @@ -51,22 +80,30 @@ and in that case the dialog will be empty (except for the OK and cancel buttons) UCI engines usually have many parameters. (But these are only visible with a sufficiently modern version of the Polyglot adapter needed to run UCI engines, e.g. Polyglot 1.4.55b.) For native XBoard engines this is less common. -
Hint
Displays a move hint from the chess engine. -
Book
Displays a list of possible moves from the chess engine's opening +
Hint
Displays a move hint from the chess engine. +
Book
Displays a list of possible moves from the chess engine's opening book. The exact format depends on what chess engine you are using. With GNU Chess 4, the first column gives moves, the second column gives one possible response for each move, and the third column shows the number of lines in the book that include the move from the first column. If you select this option and nothing happens, the chess engine is out of its book or does not support this feature. -
Move Now
Forces the chess engine to move immediately. Chess engine mode only. +
Move Now
Forces the chess engine to move immediately. Chess engine mode only. The Ctrl-M key is a keyboard equivalent. -
Retract Move
Retracts your last move. In chess engine mode, you can do this only +
Retract Move
Retracts your last move. In chess engine mode, you can do this only after the chess engine has replied to your move; if the chess engine is still thinking, use ‘Move Now’ first. In ICS mode, ‘Retract Move’ issues the command ‘takeback 1’ or ‘takeback 2’ depending on whether it is your opponent's move or yours. The Ctrl-X key is a keyboard equivalent. +
Recently Used Engines
At the bottom of the engine menu there can be a list of names +of engines that you recently loaded through the Load Engine menu dialog +in previous sessions. +Clicking on such a name will load that engine as first engine, +so you won't have to search for it in your list of installed engines, +if that is very long. +The maximum number of displayed engine names is set by the +recentEnginescommand-line option.
diff --git a/manual/html_node/Environment.html b/manual/html_node/Environment.html index 47356b7..a7df8e2 100644 --- a/manual/html_node/Environment.html +++ b/manual/html_node/Environment.html @@ -33,7 +33,7 @@ Up: Top

7 Environment variables

-

Game and position files are found in a directory named by the +

Game and position files are found in a directory named by the CHESSDIR environment variable. If this variable is not set, the current working directory is used. If CHESSDIR is set, XBoard actually changes its working directory to diff --git a/manual/html_node/File-Menu.html b/manual/html_node/File-Menu.html index f8d2a6b..9093a1f 100644 --- a/manual/html_node/File-Menu.html +++ b/manual/html_node/File-Menu.html @@ -44,9 +44,12 @@ See Action Menu.

New Shuffle Game
Similar to ‘New Game’, but allows you to specify a particular initial position (according to a standardized numbering system) in chess variants which use randomized opening positions (e.g. Chess960). -The selected opening position will persistently be chosen on any following -New Game command until you use this menu to select another. Selecting -position number -1 will produce a newly randomized position on any new game. +You can also press the ‘Pick Fixed’ button to let XBoard generate +a random number for you. +The thus selected opening position will then persistently be chosen on any following +New Game command until you use this menu to select another. +Selecting position number -1 (or pushing the ‘Randomize’ button) +will produce a newly randomized position on any new game. Using this menu item in variants that normally do not shuffle their opening position does cause these variants to become shuffle variants until you use the ‘New Shuffle Game’ menu to explicitly switch the randomization off, diff --git a/manual/html_node/Help-Menu.html b/manual/html_node/Help-Menu.html index 535e75a..be89a5a 100644 --- a/manual/html_node/Help-Menu.html +++ b/manual/html_node/Help-Menu.html @@ -34,20 +34,20 @@ Up: Menus

3.8 Help Menu

-

+

-
Info XBoard
Displays the XBoard documentation in info format. For this feature to +
Info XBoard
Displays the XBoard documentation in info format. For this feature to work, you must have the GNU info program installed on your system, and the file xboard.info must either be present in the current working directory, or have been installed by the ‘make install’ command when you built XBoard. -
Man XBoard
Displays the XBoard documentation in man page format. +
Man XBoard
Displays the XBoard documentation in man page format. The F1 key is a keyboard equivalent. For this feature to work, the file xboard.6 must have been installed by the ‘make install’ command when you built XBoard, and the directory it was placed in must be on the search path for your system's ‘man’ command. -
About XBoard
Shows the current XBoard version number. +
About XBoard
Shows the current XBoard version number.
diff --git a/manual/html_node/ICS-options.html b/manual/html_node/ICS-options.html index ecde0f5..fa8c5bb 100644 --- a/manual/html_node/ICS-options.html +++ b/manual/html_node/ICS-options.html @@ -6,7 +6,7 @@ - + @@ -27,19 +27,19 @@

Next: , -Previous: UCI + WB Engine Settings, +Previous: Tournament options, Up: Options


-

4.3 ICS options

+

4.4 ICS options

-

+

-
-ics/-xics or -internetChessServerMode true/false
Connect with an Internet Chess Server to play chess against its +
-ics/-xics or -internetChessServerMode true/false
Connect with an Internet Chess Server to play chess against its other users, observe games they are playing, or review games that have recently finished. Default: false. -
-icshost or -internetChessServerHost host
The Internet host name or address of the chess server to connect +
-icshost or -internetChessServerHost host
The Internet host name or address of the chess server to connect to when in ICS mode. Default: chessclub.com. Another popular chess server to try is freechess.org. If your site doesn't have a working Internet name server, try @@ -47,15 +47,15 @@ specifying the host address in numeric form. You may also need to specify the numeric address when using the icshelper option with timestamp or timeseal (see below). -
-icsport or -internetChessServerPort port-number
The port number to use when connecting to a chess server in ICS +
-icsport or -internetChessServerPort port-number
The port number to use when connecting to a chess server in ICS mode. Default: 5000. -
-icshelper or -internetChessServerHelper prog-name
An external helper program used to communicate with the chess server. +
-icshelper or -internetChessServerHelper prog-name
An external helper program used to communicate with the chess server. You would set it to "timestamp" for ICC (chessclub.com) or "timeseal" for FICS (freechess.org), after obtaining the correct version of timestamp or timeseal for your computer. See "help timestamp" on ICC and "help timeseal" on FICS. This option is shorthand for -useTelnet -telnetProgram program. -
-telnet/-xtelnet or -useTelnet true/false
This option is poorly named; it should be called useHelper. +
-telnet/-xtelnet or -useTelnet true/false
This option is poorly named; it should be called useHelper. If set to true, it instructs XBoard to run an external program to communicate with the Internet Chess Server. The program to use is given by the telnetProgram option. @@ -63,21 +63,21 @@ If the option is false (the default), XBoard opens a TCP socket and uses its own internal implementation of the telnet protocol to communicate with the ICS. See Firewalls. -
-telnetProgram prog-name
This option is poorly named; it should be called helperProgram. +
-telnetProgram prog-name
This option is poorly named; it should be called helperProgram. It gives the name of the telnet program to be used with the gateway and useTelnet options. The default is telnet. The telnet program is invoked with the value of internetChessServerHost as its first argument and the value of internetChessServerPort as its second argument. See Firewalls. -
-gateway host-name
If this option is set to a host name, XBoard communicates with the +
-gateway host-name
If this option is set to a host name, XBoard communicates with the Internet Chess Server by using rsh to run the telnetProgram on the given host, instead of using its own internal implementation of the telnet protocol. You can substitute a different remote shell program for rsh using the remoteShell option described below. See Firewalls. -
-internetChessServerCommPort or -icscomm dev-name
If this option is set, XBoard communicates with the ICS through +
-internetChessServerCommPort or -icscomm dev-name
If this option is set, XBoard communicates with the ICS through the given character I/O device instead of opening a TCP connection. Use this option if your system does not have any kind of Internet connection itself (not even a SLIP or PPP connection), @@ -120,7 +120,7 @@ Then telnet to ICS, using a command like telnet chessclub.com 5000. Important: See the paragraph below about extra echoes, in Limitations. -
-icslogon or -internetChessServerLogonScript file-name
Whenever XBoard connects to the Internet Chess Server, +
-icslogon or -internetChessServerLogonScript file-name
Whenever XBoard connects to the Internet Chess Server, if it finds a file with the name given in this option, it feeds the file's contents to the ICS as commands. The default file name is .icsrc. @@ -128,35 +128,35 @@ Usually the first two lines of the file should be your ICS user name and password. The file can be either in $CHESSDIR, in XBoard's working directory if CHESSDIR is not set, or in your home directory. -
-msLoginDelay delay
If you experience trouble logging on to an ICS when using the +
-msLoginDelay delay
If you experience trouble logging on to an ICS when using the -icslogon option, inserting some delay between characters of the logon script may help. This option adds delay milliseconds of delay between characters. Good values to try are 100 and 250. -
-icsinput/-xicsinput or -internetChessServerInputBox true/false
Sets the ICS Input Box menu option. See Mode Menu. Default: false. -
-autocomm/-xautocomm or -autoComment true/false
Sets the Auto Comment menu option. See Options Menu. Default: false. -
-autoflag/-xautoflag or -autoCallFlag true/false
Sets the Auto Flag menu option. See Options Menu. Default: false. -
-autobs/-xautobs or -autoObserve true/false
Sets the Auto Observe menu option. See Options Menu. Default: false. -
-autoKibitz
Enables kibitzing of the engines last thinking output (depth, score, time, speed, PV) +
-icsinput/-xicsinput or -internetChessServerInputBox true/false
Sets the ICS Input Box menu option. See Mode Menu. Default: false. +
-autocomm/-xautocomm or -autoComment true/false
Sets the Auto Comment menu option. See Options Menu. Default: false. +
-autoflag/-xautoflag or -autoCallFlag true/false
Sets the Auto Flag menu option. See Options Menu. Default: false. +
-autobs/-xautobs or -autoObserve true/false
Sets the Auto Observe menu option. See Options Menu. Default: false. +
-autoKibitz
Enables kibitzing of the engines last thinking output (depth, score, time, speed, PV) before it moved to the ICS, in zippy mode. The option showThinking must be switched on for this option to work. Also diverts similar kibitz information of an opponent engine that is playing you through the ICS to the engine-output window, as if the engine was playing locally. -
-seekGraph true/false or -sg
Enables displaying of the seek graph by left-clicking the board when +
-seekGraph true/false or -sg
Enables displaying of the seek graph by left-clicking the board when you are logged on to an ICS and currently idle. The seek graph show all players currently seeking games on the ICS, plotted according to their rating and the time control of the game they seek, in three different colors (for rated, unrated and wild games). Computer ads are displayed as squares, human ads are dots. Default: false. -
-autoRefresh true/false
Enables automatic updating of the seek graph, +
-autoRefresh true/false
Enables automatic updating of the seek graph, by having the ICS send a running update of all newly placed and removed seek ads. This consumes a substantial amount of communication bandwidth, and is only supported for FICS and ICC. Default: false. -
-backgroundObserve true/false
When true, boards sent to you by the ICS from other games while you are playing +
-backgroundObserve true/false
When true, boards sent to you by the ICS from other games while you are playing (e.g. because you are observing them) will not be automatically displayed. Only a summary of time left and material of both players will appear @@ -170,7 +170,7 @@ This feature is provided solely for the benefit of bughouse players, to enable them to peek at their partner's game without the need to logon twice. Default: false. -
-dualBoard true/false
In combination with -backgroundObserve true, this option will display +
-dualBoard true/false
In combination with -backgroundObserve true, this option will display the board of the background game side by side with that of your own game, so you can have it in view permanently. Any board or holdings info coming in will be displayed on the secondary @@ -178,25 +178,25 @@ board immediately. This feature is still experimental and largely unfinished. There is no animation or highlighting of moves on the secondary board. Default: false. -
-oneClickMove true/false
When set, this option allows you to enter moves by only clicking the to- -or from-square, when only a single legal move to or from that square -is possible. -Double-clicking a piece (or clicking an already selected piece) -will instruct that piece to make the only capture it can legally do. -Default: false. -
-moves/-xmoves or -getMoveList true/false
Sets the Get Move List menu option. See Options Menu. Default: true. -
-alarm/-xalarm or -icsAlarm true/false
Sets the ICS Alarm menu option. See Options Menu. Default: true. -
-icsAlarmTime ms
Sets the time in milliseconds for the ICS Alarm menu option. +
-disguisePromotedPieces true/false
When set promoted Pawns in crazyhouse/bughouse are displayed identical +to primordial pieces of the same type, rather than distinguishable. +Default: true. +
-moves/-xmoves or -getMoveList true/false
Sets the Get Move List menu option. See Options Menu. Default: true. +
-alarm/-xalarm or -icsAlarm true/false
Sets the ICS Alarm menu option. See Options Menu. Default: true. +
-icsAlarmTime ms
Sets the time in milliseconds for the ICS Alarm menu option. See Options Menu. Default: 5000. -
lowTimeWarning true/false
Controls a color change of the board as a warning your time is running out. +
lowTimeWarning true/false
Controls a color change of the board as a warning your time is running out. See Options Menu. Default: false. -
-pre/-xpre \fRor\fB -premove true/false
Sets the Premove menu option. See Options Menu. Default: true. -
-quiet/-xquiet or -quietPlay true/false
Sets the Quiet Play menu option. See Options Menu. Default: false. -
-colorizeMessages or -colorize
Setting colorizeMessages +
-pre/-xpre \fRor\fB -premove true/false
Sets the Premove menu option. See Options Menu. Default: true. +
-prewhite/-xprewhite or -premoveWhite
-preblack/-xpreblack or -premoveBlack
-premoveWhiteText string
-premoveBlackText string
Set the menu options for specifying the first move for either color. +See Options Menu. Defaults: false and empty strings, so no pre-moves. +
-quiet/-xquiet or -quietPlay true/false
Sets the Quiet Play menu option. See Options Menu. Default: false. +
-colorizeMessages or -colorize/-xcolorize
Setting colorizeMessages to true tells XBoard to colorize the messages received from the ICS. Colorization works only if your xterm supports ISO 6429 escape sequences for changing text colors. -
-colorShout foreground,background,bold
-colorSShout foreground,background,bold
-colorChannel1 foreground,background,bold
-colorChannel foreground,background,bold
-colorKibitz foreground,background,bold
-colorTell foreground,background,bold
-colorChallege foreground,background,bold
-colorRequest foreground,background,bold
-colorSeek foreground,background,bold
-colorNormal foreground,background,bold
These options set the colors used when colorizing ICS messages. +Default: true. +
-colorShout foreground,background,bold
-colorSShout foreground,background,bold
-colorCShout foreground,background,bold
-colorChannel1 foreground,background,bold
-colorChannel foreground,background,bold
-colorKibitz foreground,background,bold
-colorTell foreground,background,bold
-colorChallege foreground,background,bold
-colorRequest foreground,background,bold
-colorSeek foreground,background,bold
-colorNormal foreground,background,bold
These options set the colors used when colorizing ICS messages. All ICS messages are grouped into one of these categories: shout, sshout, channel 1, other channel, kibitz, tell, challenge, request (including abort, adjourn, draw, pause, and takeback), or @@ -210,7 +210,8 @@ is assumed; if bold is omitted, 0 is assumed.

Here is an example of how to set the colors in your .Xresources file. The colors shown here are the default values; you will get -them if you turn -colorize on without specifying your own colors. +them if you turn -colorize on without specifying your own colors. +CShout is synonymous with SShout.

          xboard*colorizeMessages: true
           xboard*colorShout: green
@@ -224,24 +225,25 @@ them if you turn -colorize on without specifying your own colors.
           xboard*colorSeek: blue
           xboard*colorNormal: default
 
-
-soundProgram progname
If this option is set to a sound-playing program that is installed and +
-soundProgram progname
If this option is set to a sound-playing program that is installed and working on your system, XBoard can play sound files when certain events occur, listed below. The default program name is "play". If any of the sound options is set to "$", the event rings the terminal bell by sending a ^G character to standard output, instead of playing a sound file. If an option is set to the empty string "", no sound is played for that event. -
-soundDirectory directoryname
This option specifies where XBoard will look for sound files, +
-soundDirectory directoryname
This option specifies where XBoard will look for sound files, when these are not given as an absolute path name. -
-soundShout filename
-soundSShout filename
-soundChannel filename
-soundKibitz filename
-soundTell filename
-soundChallenge filename
-soundRequest filename
-soundSeek filename
These sounds are triggered in the same way as the colorization events +
-soundShout filename
-soundSShout filename
-soundCShout filename
-soundChannel filename
-soundChannel1 filename
-soundKibitz filename
-soundTell filename
-soundChallenge filename
-soundRequest filename
-soundSeek filename
These sounds are triggered in the same way as the colorization events described above. They all default to "", no sound. They are played only if the colorizeMessages is on. -
-soundMove filename
This sound is used by the Move Sound menu option. Default: "$". -
-soundIcsAlarm filename
This sound is used by the ICS Alarm menu option. Default: "$". -
-soundIcsWin filename
This sound is played when you win an ICS game. Default: "" (no sound). -
-soundIcsLoss filename
This sound is played when you lose an ICS game. Default: "" (no sound). -
-soundIcsDraw filename
This sound is played when you draw an ICS game. Default: "" (no sound). -
-soundIcsUnfinished filename
This sound is played when an ICS game that you are participating in is +CShout is synonymous with SShout. +
-soundMove filename
This sound is used by the Move Sound menu option. Default: "$". +
-soundIcsAlarm filename
This sound is used by the ICS Alarm menu option. Default: "$". +
-soundIcsWin filename
This sound is played when you win an ICS game. Default: "" (no sound). +
-soundIcsLoss filename
This sound is played when you lose an ICS game. Default: "" (no sound). +
-soundIcsDraw filename
This sound is played when you draw an ICS game. Default: "" (no sound). +
-soundIcsUnfinished filename
This sound is played when an ICS game that you are participating in is aborted, adjourned, or otherwise ends inconclusively. Default: "" (no sound). @@ -263,15 +265,7 @@ sound). xboard*soundIcsUnfinished: unfinished.wav xboard*soundIcsAlarm: alarm.wav
-
-dropMenu true|false
This option allows you to emulate old behavior, -where the right mouse button brings up the (now deprecated) drop menu -rather than displaying the position at the end of the principal variation. -Default: False. -
-variations true|false
When this option is on, you can start new variations in Edit Game or -Analyze mode by holding the Shift key down while entering a move. -When it is off, the Shift key will be ignored. -Default: False. -
+
diff --git a/manual/html_node/Index.html b/manual/html_node/Index.html index e937ad5..4c173d3 100644 --- a/manual/html_node/Index.html +++ b/manual/html_node/Index.html @@ -32,473 +32,580 @@ Up: Top

Index

Table of Contents

@@ -522,11 +629,12 @@ Up: Top
  • 5 Chess Servers
  • 6 Firewalls diff --git a/manual/html_node/Keys.html b/manual/html_node/Keys.html index f0fa5f3..ce12c7d 100644 --- a/manual/html_node/Keys.html +++ b/manual/html_node/Keys.html @@ -32,24 +32,20 @@ Up: Menus

    3.9 Other Shortcut Keys

    -

    +

    -
    Iconize
    Pressing the - key iconizes XBoard. The graphical -icon displays a white knight if it is White's move, or a black knight -if it is Black's move. If your X window manager displays only text -icons, not graphical ones, check its documentation; there is probably -a way to enable graphical icons. If you get black and white reversed, -we would like to hear about it; see Problems below for -instructions on how to report this problem. -
    Load Next Game
    Loads the next game from the last game record file you loaded. -The Alt+PgDn key is a keyboard equivalent. -
    Load Previous Game
    Loads the previous game from the last game record file you -loaded. The Alt+PgUp key is a keyboard equivalent. +
    Show Last Move
    By hitting Enter the last move will be re-animated. +
    Load Next Game
    Loads the next game from the last game record file you loaded. +The Alt+PgDn key triggers this action. +
    Load Previous Game
    Loads the previous game from the last game record file you +loaded. The Alt+PgUp key triggers this action. Not available if the last game was loaded from a pipe. -
    Reload Same Game
    Reloads the last game you loaded. +
    Reload Same Game
    Reloads the last game you loaded. Not available if the last game was loaded from a pipe. -
    Reload Same Position
    Reloads the last position you loaded. +Currently no keystroke is assigned to this ReloadGameProc. +
    Reload Same Position
    Reloads the last position you loaded. Not available if the last position was loaded from a pipe. +Currently no keystroke is assigned to this ReloadPositionProc.

    You can add or remove shortcut keys using the X resources @@ -74,7 +70,7 @@ are: DebugProc, DeclineProc, DrawProc, EditCommentProc, EditGameProc, EditPositionProc, EditTagsProc, EnterKeyProc, FlashMovesProc, FlipViewProc, ForwardProc, GetMoveListProc, HighlightLastMoveProc, - HintProc, Iconify, IcsAlarmProc, IcsClientProc, IcsInputBoxProc, + HintProc, IcsAlarmProc, IcsClientProc, IcsInputBoxProc, InfoProc, LoadGameProc, LoadNextGameProc, LoadNextPositionProc, LoadPositionProc, LoadPrevGameProc, LoadPrevPositionProc, LoadSelectedProc, MachineBlackProc, MachineWhiteProc, MailMoveProc, diff --git a/manual/html_node/Limitations.html b/manual/html_node/Limitations.html index 328ed00..373624f 100644 --- a/manual/html_node/Limitations.html +++ b/manual/html_node/Limitations.html @@ -33,7 +33,7 @@ Up: Top

    8 Limitations and known bugs

    -

    There is no way for two people running copies of XBoard to play +

    There is no way for two people running copies of XBoard to play each other without going through an Internet Chess Server.

    Under some circumstances, your ICS password may be echoed when you log on. diff --git a/manual/html_node/Load-and-Save-options.html b/manual/html_node/Load-and-Save-options.html index 59eb045..eb36128 100644 --- a/manual/html_node/Load-and-Save-options.html +++ b/manual/html_node/Load-and-Save-options.html @@ -32,11 +32,11 @@ Up: Options


  • -

    4.4 Load and Save options

    +

    4.5 Load and Save options

    -

    +

    -
    -lgf or -loadGameFile file
    -lgi or -loadGameIndex index
    If the loadGameFile option is set, XBoard loads the specified +
    -lgf or -loadGameFile file
    -lgi or -loadGameIndex index
    If the loadGameFile option is set, XBoard loads the specified game file at startup. The file name - specifies the standard input. If there is more than one game in the file, XBoard pops up a menu of the available games, with entries based on their PGN @@ -59,16 +59,16 @@ first game of the file when it has reached a specified value. positions or games in auto-increment matchMode. See loadPositionIndex and loadGameIndex. default: 0 (no rewind). -
    -td or -timeDelay seconds
    Time delay between moves during ‘Load Game’ or ‘Analyze File’. +
    -td or -timeDelay seconds
    Time delay between moves during ‘Load Game’ or ‘Analyze File’. Fractional seconds are allowed; try ‘-td 0.4’. A time delay value of -1 tells XBoard not to step through game files automatically. Default: 1 second. -
    -sgf or -saveGameFile file
    If this option is set, XBoard appends a record of every game +
    -sgf or -saveGameFile file
    If this option is set, XBoard appends a record of every game played to the specified file. The file name - specifies the standard output. -
    -autosave/-xautosave or -autoSaveGames true/false
    Sets the Auto Save menu option. See Options Menu. Default: false. +
    -autosave/-xautosave or -autoSaveGames true/false
    Sets the Auto Save menu option. See Options Menu. Default: false. Ignored if saveGameFile is set. -
    -lpf or -loadPositionFile file
    -lpi or -loadPositionIndex index
    If the loadPositionFile option is set, XBoard loads the +
    -lpf or -loadPositionFile file
    -lpi or -loadPositionIndex index
    If the loadPositionFile option is set, XBoard loads the specified position file at startup. The file name - specifies the standard input. If the loadPositionIndex option is set to N, the Nth position found in the file is loaded; otherwise the @@ -81,23 +81,27 @@ causes the index to be incremented every two games, so that each position in the file is used twice (with the engines playing opposite colors). The rewindIndex option causes the index to be reset to the first position of the file when it has reached a specified value. -
    -spf or -savePositionFile file
    If this option is set, XBoard appends the final position reached +
    -spf or -savePositionFile file
    If this option is set, XBoard appends the final position reached in every game played to the specified file. The file name - specifies the standard output. -
    -pgnExtendedInfo true/false
    If this option is set, XBoard saves depth, score and time used for each +
    -pgnExtendedInfo true/false
    If this option is set, XBoard saves depth, score and time used for each move that the engine found as a comment in the PGN file. Default: false. -
    -pgnEventHeader string
    Sets the name used in the PGN event tag to string. +
    -pgnEventHeader string
    Sets the name used in the PGN event tag to string. Default: "Computer Chess Game". -
    -saveOutOfBookInfo true/false
    Include the information on how the engine(s) game out of its opening book +
    -pgnNumberTag true/false
    Include the (unique) sequence number of a tournament game into the saved +PGN file as a 'number' tag. +Default: false. +
    -saveOutOfBookInfo true/false
    Include the information on how the engine(s) game out of its opening book in a special 'annotator' tag with the PGN file. -
    -oldsave/-xoldsave or -oldSaveStyle true/false
    Sets the Old Save Style menu option. See Options Menu. Default: false. -
    -gameListTags string
    The character string lists the PGN tags that should be printed in the +Default: true. +
    -oldsave/-xoldsave or -oldSaveStyle true/false
    Sets the Old Save Style menu option. See Options Menu. Default: false. +
    -gameListTags string
    The character string lists the PGN tags that should be printed in the Game List, and their order. The meaning of the codes is e=event, s=site, d=date, o=round, p=players, r=result, w=white Elo, b=black Elo, t=time control, v=variant, a=out-of-book info, c=result comment. Default: "eprd" -
    -ini or -settingsFile filename
    -saveSettingsFile filename
    @filename
    When XBoard encounters an option -settingsFile (or -ini for short), +
    -ini or -settingsFile filename
    -saveSettingsFile filename
    @filename
    When XBoard encounters an option -settingsFile (or -ini for short), or @filename, it tries to read the mentioned file, and substitutes the contents of it (presumaby more command-line options) in place of the option. @@ -116,6 +120,8 @@ and will be used to contain system-wide default setings, amongst which a -saveSettingsFile and -settingsFile options to specify a settings file accessible to the individual user, such as ~/.xboardrc in the user's home directory. +
    -saveSettingsOnExit true/false
    Controls saving of options on the settings file. See Options Menu. +Default: true.
    diff --git a/manual/html_node/Mode-Menu.html b/manual/html_node/Mode-Menu.html index 25723ea..2b3ac87 100644 --- a/manual/html_node/Mode-Menu.html +++ b/manual/html_node/Mode-Menu.html @@ -34,15 +34,15 @@ Up: Menus

    3.4 Mode Menu

    -

    +

    -
    Machine White
    Tells the chess engine to play White. +
    Machine White
    Tells the chess engine to play White. The Ctrl-W key is a keyboard equivalent. -
    Machine Black
    Tells the chess engine to play Black. +
    Machine Black
    Tells the chess engine to play Black. The Ctrl-B key is a keyboard equivalent. -
    Two Machines
    Plays a game between two chess engines. +
    Two Machines
    Plays a game between two chess engines. The Ctrl-T key is a keyboard equivalent. -
    Analysis Mode
    XBoard tells the chess engine to start analyzing the current game/position +
    Analysis Mode
    XBoard tells the chess engine to start analyzing the current game/position and shows you the analysis as you move pieces around. The Ctrl-A key is a keyboard equivalent. Note: Some chess engines do not support Analysis mode. @@ -59,16 +59,19 @@ clock to tell XBoard which side moves first.

    4. Select Analysis Mode from the Mode Menu to start the analysis. +

    You can now play legal moves to create follow-up positions for the +engine to analyze, while the moves will be remembered as a stored game, +and then step backward through this game to take the moves back. +Note that you can also click on the clocks to set the opposite +side to move (adding a so-called ‘null move’ to the game). +

    The analysis function can also be used when observing games on an ICS with an engine loaded (zippy mode); the engine then will analyse the positions as they occur in the observed game. -

    Analyze File
    This option lets you load a game from a file (PGN, XBoard format, etc.) -and analyze it. The Ctrl-F key is a keyboard equivalent. -When you select this menu item, a pop-up window appears -and asks for a file name to load. -If the file contains multiple games, another pop up appears that lets -you select which game you wish to analyze. -After a game is loaded, XBoard will start auto-playing the game, +
    Analyze Game
    This option subjects the currently loaded game to automatic +analysis by the loaded engine. +The Ctrl-G key is a keyboard equivalent. +XBoard will start auto-playing the game from the currently displayed position, while the engine is analyzing the current position. The game will be annotated with the results of these analyses. In particlar, the score and depth will be added as a comment, @@ -81,7 +84,7 @@ Note that ‘Edit Game’ is the to get you out of other modes. E.g. to stop analyzing, stop a game between two engines or stop editing a position.
    Edit Position
    Duplicate of the item in the Edit menu. -
    Training
    Training mode lets you interactively guess the moves of a game for one +
    Training
    Training mode lets you interactively guess the moves of a game for one of the players. You guess the next move of the game by playing the move on the board. If the move played matches the next move of the game, the move is accepted and the opponent's response is auto-played. @@ -89,7 +92,7 @@ If the move played is incorrect, an error message is displayed. You can select this mode only while loading a game (that is, after selecting ‘Load Game’ from the File menu). While XBoard is in ‘Training’ mode, the navigation buttons are disabled. -
    ICS Client
    This is the normal mode when XBoard +
    ICS Client
    This is the normal mode when XBoard is connected to a chess server. If you have moved into Edit Game or Edit Position mode, you can select this option to get out. @@ -111,10 +114,12 @@ drag pieces to arbitrary squares while examining on ICC, but you can do so in bsetup mode on FICS. In addition, the menu commands ‘Forward’, ‘Backward’, ‘Pause’, and ‘Stop Examining’ have special functions in this mode; see below. -
    Machine Match
    Starts a match between two chess programs, +
    Machine Match
    Starts a match between two chess programs, with a number of games and other parameters set through the ‘Match Options’ menu dialog. -
    Pause
    Pauses updates to the board, and if you are playing against a chess engine, +When a match is already running, selecting this item will make +XBoard drop out of match mode after the current game finishes. +
    Pause
    Pauses updates to the board, and if you are playing against a chess engine, also pauses your clock. To continue, select ‘Pause’ again, and the display will automatically update to the latest position. The ‘P’ button and keyboard Pause key are equivalents. diff --git a/manual/html_node/Options-Menu.html b/manual/html_node/Options-Menu.html index 8f984ac..1509689 100644 --- a/manual/html_node/Options-Menu.html +++ b/manual/html_node/Options-Menu.html @@ -34,141 +34,39 @@ Up: Menus

    3.7 Options Menu

    -

    +

    -
    Time Control
    Pops up a sub-menu where you can set the time-control parameters interactively. -Allows you to select classical or incremental time controls, -set the moves per session, session duration, and time increment. -Also allows specification of time-odds factors for one or both engines. -If an engine is given a time-odds factor N, all time quota it gets, -be it at the beginning of a session or through the time increment or -fixed time per move, will be divided by N. -The shifted Alt+T key is a keyboard equivalent. -
    Common Engine
    Pops up a sub-menu where you can set some engine parameters common to most engines, -such as hash-table size, tablebase cache size, maximum number of processors -that SMP engines can use, and where to find the Polyglot adapter needed -to run UCI engines under XBoard. The feature that allows setting of these parameters on -engines is new since XBoard 4.3.15, so not many XBoard/WinBoard engines respond -to it yet, but UCI engines should. - -

    It is also possible to specify a GUI opening book here, i.e. an opening -book that XBoard consults for any position a playing engine gets in. -It then forces the engine to play the book move, rather than to think up its own, -if that position is found in the book. -The book can switched on and off independently for either engine. -The way book moves are chosen can be influenced through the settings of -book depth and variety. -After both sides have played more moves than the specified depth, -the book will no longer be consulted. -When the variety is set to 50, moves will be played with the probability -specified in the book. -When set to 0, only the move(s) with the highest probability will be played. -When set to 100, all listed moves will be played with equal pobability. -Other settings interpolate between that. -The shifted Alt+U key is a keyboard equivalent. -

    Adjudications
    Pops up a sub-menu where you can enable or disable various adjudications -that XBoard can perform in engine-engine games. -The shifted Alt+J key is a keyboard equivalent. -You can instruct XBoard to detect and terminate the game on checkmate -or stalemate, even if the engines would not do so, to verify engine -result claims (forfeiting engines that make false claims), rather than -naively following the engine, to declare draw on positions -which can never be won for lack of mating material, (e.g. KBK), -or which are impossible to win unless the opponent seeks its own demise -(e.g. KBKN). -For these adjudications to work, ‘Test Legality’ should be switched on. -It is also possible to instruct XBoard to enforce a 50-move or 3-fold-repeat -rule and automatically declare draw (after a user-adjustable number of moves -or repeats) even if the engines are prepared to go on. -It is also possible to have XBoard declare draw on games that seem to drag on -forever, or adjudicate a loss if both engines agree (for 3 consecutive moves) that one -of them is behind more than a user-adjustable score threshold. -For the latter adjudication to work, XBoard should be able to properly understand -the engine's scores. To facilitate the latter, you can inform xboard here if -the engines report scores from the viewpoint of white, or from that of their own color. -
    Match Game Options
    Summons a dialog where you can set options important for playing automatic -matches between two chess programs -(e.g. by using the ‘Machine Match’ menu item in the ‘Mode’ menu). -You can specify the number of games such a match should last, -and the duration of the pause between games -(important for some older engines to not have the last move of a previous -game be given when the next game has already started). -You can also specify a file with opening lines, or a file with initial positions -(the loadGameFile and loadPositionFile options), -and the number of the game or position to use from these files. -Values -1 and -2 of this 'index' convey a special meaning, -namely that XBoard should automatically step through all lines or positions -in these files. -With -1 such stepping is done every game; with -2 every two games, -so that each line or position is played with both colors before stepping -to the next one. -You can have XBoard automatically rewind to the first line or position -in the file after the index reaches a certain vaue, -which you can also specify here. -
    Load Game Options
    Summons a dialog where you can set the autoDisplayComment and -autoDisplayTags options, (which control popups when viewing loaded games), -and specify the rate at which loaded games are auto-played, -in seconds per move (which can be a fractional number, like 1.6). -
    Save Game Options
    Summons a dialog where you can specify the files on which XBoard should -automtically save any played or entered games, -(the saveGameFile option), -or the final position of such games (the savePositionfile option). -You can also select 'auto-save' without a file name, -in which case XBoard will prompt the user for a file name after each game. -You can also set the default value for the PGN Event tag that will -be used for each new game you start. -Various options for the format of the game can be specified as well, -such as whether scores and depths of engine games should be saved as comments, -and if a tag with info about the score with which the engine came out of book -should be included. -For Chess, always set the format to PGN, rather than "old save stye"! -
    Game List
    Pops up a dialog where you can select the PGN tags that should appear -on the lines in the game list, and their order. -
    Sound Options
    Summons a dialog where you can specify the sounds that should accompany -various events that can occur XBoard. -Most events are only relevant to ICS play, -but the move sound is an important exception. -For each event listed in the dialog, -you can select a standard sound from a menu. -You can also select a user-supplied sound file, -by typing its name into the designated text-edit field first, -and then selecting "Above WAV File" from the menu for the event. -A dummy event has been provided for trying out the sounds with the -"play" button next to it. -The directory with standard sounds, and the external program for playing -the sounds can be specified too, but normally you would not touch these -once XBoard is properly installed. -
    Move Sound
    When a move sound other than 'None' is selected, -XBoard alerts you by playing a sound -after each of your opponent's moves (or after every -move if you are observing a game on the Internet Chess Server). -The sound is not played after moves you make or moves read from a -saved game file. -If you turn on this option when using XBoard with the Internet -Chess Server, you will probably want to give the -set bell 0 -command to the ICS, since otherwise the ICS will ring the terminal bell -after every move (not just yours). (The .icsrc file -is a good place for this; see ICS options.) -
    General Options
    The following items to set option values appear in the dialog +
    General Options
    The following items to set option values appear in the dialog summoned by the general Options menu item. -
    Always Queen
    If this option is off, XBoard brings up a dialog +
    Absolute Analysis Scores
    Controls if scores on the Engine Output window during analysis +will be printed from the white or the side-to-move point-of-view. +
    Almost Always Queen
    If this option is on, 7th-rank pawns automatically change into +Queens when you pick them up, +and when you drag them to the promotion square and release them there, +they will promote to that. +But when you drag such a pawn backwards first, +its identity will start to cycle through the other available pieces. +This will continue until you start to move it forward; +at which point the identity of the piece will be fixed, +so that you can safely put it down on the promotion square. +If this option is off, what happens depends on the +option alwaysPromoteToQueen, +which would force promotion to Queen when true. +Otherwise XBoard would bring up a dialog box whenever you move a pawn to the last rank, asking what piece -you want to promote it to. If the option is true, your pawns are -always promoted to queens. Your opponent can still under-promote. -The shifted Ctrl-Q key is a keyboard equivalent. -
    Animate Dragging
    If Animate Dragging is on, while you are dragging a piece with the +you want to promote to. +
    Animate Dragging
    If Animate Dragging is on, while you are dragging a piece with the mouse, an image of the piece follows the mouse cursor. If Animate Dragging is off, there is no visual feedback while you are dragging a piece, but if Animate Moving is on, the move will be animated when it is complete. -
    Animate Moving
    If Animate Moving is on, all piece moves are animated. An image of the +
    Animate Moving
    If Animate Moving is on, all piece moves are animated. An image of the piece is shown moving from the old square to the new square when the move is completed (unless the move was already animated by Animate Dragging). If Animate Moving is off, a moved piece instantly disappears from its old square and reappears on its new square when the move is complete. The shifted Ctrl-A key is a keyboard equivalent. -
    Auto Flag
    If this option is on and one player runs out of time +
    Auto Flag
    If this option is on and one player runs out of time before the other, XBoard will automatically call his flag, claiming a win on time. @@ -178,7 +76,7 @@ and the ICS may award you a draw instead of a win if you have insufficient mating material. In local chess engine mode, XBoard may call either player's flag and will not take material into account (?). -
    Auto Flip View
    If the Auto Flip View option is on when you start a game, the board +
    Auto Flip View
    If the Auto Flip View option is on when you start a game, the board will be automatically oriented so that your pawns move from the bottom of the window towards the top. @@ -189,28 +87,39 @@ orientation is determined by the flipView command line option; if it is false (the default), White's pawns move from bottom to top at the start of each game; if it is true, Black's pawns move from bottom to top. See User interface options. -
    Blindfold
    If this option is on, XBoard displays the board as usual but does +
    Blindfold
    If this option is on, XBoard displays the board as usual but does not display pieces or move highlights. You can still move in the usual way (with the mouse or by typing moves in ICS mode), even though the pieces are invisible. -
    Drop Menu
    Controls if right-clicking the board in crazyhouse / bughouse +
    Drop Menu
    Controls if right-clicking the board in crazyhouse / bughouse will pop up a menu to drop a piece on the clicked square (old, deprecated behavior) or allow you to step through an engine PV (new, recommended behavior). -
    Highlight Dragging
    If Highlight Dragging is on, and the option -showTargetSquares is also on -in the settings file, all squares a piece that is 'picked up' with the mouse -can legally move to are highighted with a fat colored dot in the -highlightColor (non-captures) or premoveHighlightColor (captures). -Legality testing must be on for XBoard to know how the piece moves. -
    Highlight Last Move
    If Highlight Last Move is on, after a move is made, the starting and +
    Hide Thinking
    If this option is off, the chess engine's notion of the score and best +line of play from the current position is displayed as it is +thinking. The score indicates how many pawns ahead (or if negative, +behind) the chess engine thinks it is. In matches between two +machines, the score is prefixed by ‘W’ or ‘B’ to indicate +whether it is showing White's thinking or Black's, and only the thinking +of the engine that is on move is shown. +The shifted Ctrl-H key is a keyboard equivalent. +
    Highlight Last Move
    If Highlight Last Move is on, after a move is made, the starting and ending squares remain highlighted. In addition, after you use Backward or Back to Start, the starting and ending squares of the last move to be unmade are highlighted. -
    Highlight with Arrow
    Causes the highlighting described in Highlight Last Move to be done +
    Highlight with Arrow
    Causes the highlighting described in Highlight Last Move to be done by drawing an arrow between the highlighted squares, so that it is visible even when the width of the grid lines is set to zero. -
    One-Click Moving
    If this option is on, XBoard does not wait for you to click both the +
    Move Sound
    Enables the sounding of an audible signal when the computer performs a move. +For the selection of the sound, see ‘Sound Options’. +If you turn on this option when using XBoard with the Internet +Chess Server, you will probably want to give the +set bell 0 +command to the ICS, since otherwise the ICS will ring the terminal bell +after every move (not just yours). (The .icsrc file +is a good place for this; see ICS options.) +
    One-Click Moving
    If this option is on, XBoard does not wait for you to click both the from- and the to-square, or drag the piece, but performs a move as soon as it is uniqely specified. This applies to clicking an own piece that only has a single legal move, @@ -219,37 +128,36 @@ can move (or capture) to. Furthermore, a double-click on a piece that can only make a single capture will cause that capture to be made. Promoting a Pawn by clicking its to-square will suppress the promotion -popup, and make it promote to Queen. -
    Periodic Updates
    If this option is off (or if +popup or other methods for selecting an under-promotion, +and make it promote to Queen. +
    Periodic Updates
    If this option is off (or if you are using a chess engine that does not support periodic updates), the analysis window will only be updated when the analysis changes. If this option is on, the Analysis Window will be updated every two seconds. -
    Ponder Next Move
    If this option is off, the chess engine will think only when it is on +
    Ponder Next Move
    If this option is off, the chess engine will think only when it is on move. If the option is on, the engine will also think while waiting for you to make your move. The shifted Ctrl-P key is a keyboard equivalent. -
    Popup Exit Message
    If this option is on, when XBoard wants to display a message just +
    Popup Exit Message
    If this option is on, when XBoard wants to display a message just before exiting, it brings up a modal dialog box and waits for you to click OK before exiting. If the option is off, XBoard prints the message to standard error (the terminal) and exits immediately. -
    Popup Move Errors
    If this option is off, when you make an error in moving (such as +
    Popup Move Errors
    If this option is off, when you make an error in moving (such as attempting an illegal move or moving the wrong color piece), the error message is displayed in the message area. If the option is on, move errors are displayed in small pop-up windows like other errors. You can dismiss an error pop-up either by clicking its OK button or by clicking anywhere on the board, including down-clicking to start a move. -
    Show Coords
    If this option is on, XBoard displays algebraic coordinates +
    Scores in Move List
    If this option is on, XBoard will display the depth and score +of engine moves in the Move List, in the format of a PGN comment. +
    Show Coords
    If this option is on, XBoard displays algebraic coordinates along the board's left and bottom edges. -
    Hide Thinking
    If this option is off, the chess engine's notion of the score and best -line of play from the current position is displayed as it is -thinking. The score indicates how many pawns ahead (or if negative, -behind) the chess engine thinks it is. In matches between two -machines, the score is prefixed by ‘W’ or ‘B’ to indicate -whether it is showing White's thinking or Black's, and only the thinking -of the engine that is on move is shown. -The shifted Ctrl-H key is a keyboard equivalent. -
    Test Legality
    If this option is on, XBoard tests whether the moves you try to make +
    Show Target Squares
    If this option is on, all squares a piece that is 'picked up' with the mouse +can legally move to are highighted with a fat colored dot in the +highlightColor (non-captures) or premoveHighlightColor (captures). +Legality testing must be on for XBoard to know how the piece moves. +
    Test Legality
    If this option is on, XBoard tests whether the moves you try to make with the mouse are legal and refuses to let you make an illegal move. The shifted Ctrl-L key is a keyboard equivalent. Moves loaded from a file with ‘Load Game’ are also checked. If @@ -259,28 +167,81 @@ off this option is useful if you are playing a chess variant with rules that XBoard does not understand. (Bughouse, suicide, and wild variants where the king may castle after starting on the d file are generally supported with Test Legality on.) -
    Flash Moves
    Flash Rate
    If this option is non-zero, whenever a move is completed, +
    Flash Moves
    Flash Rate
    If this option is non-zero, whenever a move is completed, the moved piece flashes the specified number of times. The flash-rate setting determines how rapidly this flashing occurs. -
    Animation Speed
    Determines the duration (in msec) of an animation step, -when ‘Animate Moving’ is swiched on. +
    Animation Speed
    Determines the duration (in msec) of an animation step, +when ‘Animate Moving’ is swiched on. +
    Zoom factor in Evaluation Graph
    Sets the valueof the evalZoom option, +indicating the factor by which the score interval (-1,1) should be +blown up on the vertical axis of the Evaluation Graph. +
    Time Control
    Pops up a sub-menu where you can set the time-control parameters interactively. +Allows you to select classical or incremental time controls, +set the moves per session, session duration, and time increment. +Also allows specification of time-odds factors for one or both engines. +If an engine is given a time-odds factor N, all time quota it gets, +be it at the beginning of a session or through the time increment or +fixed time per move, will be divided by N. +The shifted Alt+T key is a keyboard equivalent. +
    Common Engine
    Pops up a sub-menu where you can set some engine parameters common to most engines, +such as hash-table size, tablebase cache size, maximum number of processors +that SMP engines can use, and where to find the Polyglot adapter needed +to run UCI engines under XBoard. The feature that allows setting of these parameters on +engines is new since XBoard 4.3.15, so not many XBoard/WinBoard engines respond +to it yet, but UCI engines should. + +

    It is also possible to specify a GUI opening book here, i.e. an opening +book that XBoard consults for any position a playing engine gets in. +It then forces the engine to play the book move, rather than to think up its own, +if that position is found in the book. +The book can switched on and off independently for either engine. +The way book moves are chosen can be influenced through the settings of +book depth and variety. +After both sides have played more moves than the specified depth, +the book will no longer be consulted. +When the variety is set to 50, moves will be played with the probability +specified in the book. +When set to 0, only the move(s) with the highest probability will be played. +When set to 100, all listed moves will be played with equal pobability. +Other settings interpolate between that. +The shifted Alt+U key is a keyboard equivalent. +

    Adjudications
    Pops up a sub-menu where you can enable or disable various adjudications +that XBoard can perform in engine-engine games. +The shifted Alt+J key is a keyboard equivalent. +You can instruct XBoard to detect and terminate the game on checkmate +or stalemate, even if the engines would not do so, to verify engine +result claims (forfeiting engines that make false claims), rather than +naively following the engine, to declare draw on positions +which can never be won for lack of mating material, (e.g. KBK), +or which are impossible to win unless the opponent seeks its own demise +(e.g. KBKN). +For these adjudications to work, ‘Test Legality’ should be switched on. +It is also possible to instruct XBoard to enforce a 50-move or 3-fold-repeat +rule and automatically declare draw (after a user-adjustable number of moves +or repeats) even if the engines are prepared to go on. +It is also possible to have XBoard declare draw on games that seem to drag on +forever, or adjudicate a loss if both engines agree (for 3 consecutive moves) that one +of them is behind more than a user-adjustable score threshold. +For the latter adjudication to work, XBoard should be able to properly understand +the engine's scores. To facilitate the latter, you can inform xboard here if +the engines report scores from the viewpoint of white, or from that of their own color. -
    ICS Options
    The following options occur in a dialog summoned by the +
    ICS Options
    The following options occur in a dialog summoned by the ICS Options menu item. -
    Auto Kibitz
    Setting this option when playingwith or aginst a chess program on an ICS +
    Auto Kibitz
    Setting this option when playing with or aginst a chess program on an ICS will cause the last line of thinking output of the engine before its move to be sent to the ICS in a kibitz command. In addition, any kibitz message received through the ICS from an opponent chess program will be diverted to the engine-output window, (and suppressed in the console), where you can play through its PV by right-clicking it. -
    Auto Comment
    If this option is on, any remarks made on ICS while you are observing or +
    Auto Comment
    If this option is on, any remarks made on ICS while you are observing or playing a game are recorded as a comment on the current move. This includes remarks made with the ICS commands say, tell, whisper, and kibitz. Limitation: remarks that you type yourself are not recognized; XBoard scans only the output from ICS, not the input you type to it. -
    Auto Observe
    If this option is on and you add a player to your gnotify +
    Auto Observe
    If this option is on and you add a player to your gnotify list on ICS, XBoard will automatically observe all of that player's games, unless you are doing something else (such as observing or playing a game of your own) when one starts. @@ -293,24 +254,24 @@ your ICS variable is set to 0, or if the ICS you are using does not properly support observing from Black's point of view, you will see the game from White's point of view. -
    Auto Raise Board
    If this option is on, whenever a new game begins, the chessboard window +
    Auto Raise Board
    If this option is on, whenever a new game begins, the chessboard window is deiconized (if necessary) and raised to the top of the stack of windows. -
    Auto Save
    If this option is true, at the end of every game XBoard prompts +
    Auto Save
    If this option is true, at the end of every game XBoard prompts you for a file name and appends a record of the game to the file you specify. Disabled if the saveGameFile command-line option is set, as in that case all games are saved to the specified file. See Load and Save options. -
    Background Observe
    Setting this option will make XBoard suppress display of any boards +
    Background Observe
    Setting this option will make XBoard suppress display of any boards from observed games while you are playing. In stead the last such board will be remembered, and shown to you when you right-click the board. This allows you to peek at your bughouse partner's game when you want, without disturbing your own game too much. -
    Dual Board
    Setting this option in combination with ‘Background Observe’ +
    Dual Board
    Setting this option in combination with ‘Background Observe’ will display boards of observed games while you are playing on a second board next to that of your own game. -
    Get Move List
    If this option is on, whenever XBoard +
    Get Move List
    If this option is on, whenever XBoard receives the first board of a new ICS game (or a different game from the one it is currently displaying), it retrieves the list of past moves from the ICS. @@ -322,20 +283,20 @@ to keep from wasting time and network bandwidth fetching the move lists over and over. When you turn this option on from the menu, XBoard immediately fetches the move list of the current game (if any). -
    Quiet Play
    If this option is on, XBoard will automatically issue an ICS +
    Quiet Play
    If this option is on, XBoard will automatically issue an ICS set shout 0 command whenever you start a game and a set shout 1 command whenever you finish one. Thus, you will not be distracted by shouts from other ICS users while playing. -
    Seek Graph
    Setting this option will cause XBoard to display an graph of +
    Seek Graph
    Setting this option will cause XBoard to display an graph of currently active seek ads when you left-click the board while idle and logged on to an ICS. -
    Auto-Refresh Seek Graph
    In combination with the ‘Seek Graph’ option this +
    Auto-Refresh Seek Graph
    In combination with the ‘Seek Graph’ option this will cause automatic update of the seek graph while it is up. -This only works on FICS and ICS, +This only works on FICS and ICC, and requires a lot of bandwidth on a busy server. -
    Premove
    Premove White
    Premove Black
    First White Move
    First Black Move
    If this option is on while playing a game on an ICS, you can register +
    Premove
    Premove White
    Premove Black
    First White Move
    First Black Move
    If this option is on while playing a game on an ICS, you can register your next planned move before it is your turn. Move the piece with the mouse in the ordinary way, and the starting and ending squares will be highlighted with a special color (red by default). When it is @@ -347,7 +308,7 @@ entirely.

    You can also enter premoves for the first white and black moves of the game. -

    ICS Alarm
    ICS Alarm Time
    When this option is on, an alarm sound is played when your clock +
    ICS Alarm
    ICS Alarm Time
    When this option is on, an alarm sound is played when your clock counts down to the icsAlarmTime in an ICS game. (By default, the time is 5 seconds, but you can pecify other values with the Alarm Time spin control.) @@ -356,12 +317,178 @@ alarm will sound each time the clock counts down to the icsAlarmTime. By default, the alarm sound is the terminal bell, but on some systems you can change it to a sound file using the soundIcsAlarm option; see below. -
    Colorize Messages
    Ticking this options causes various types of ICS messages do be +
    Colorize Messages
    Ticking this options causes various types of ICS messages do be displayed with different foreground or background colors in the console. The colors can be individually selected for each type, through the accompanying text edits. -
    Save Settings Now
    Selecting this menu item causes the current XBoard settings to be +
    Match Options
    Summons a dialog where you can set options important for playing automatic +matches between two chess programs +(e.g. by using the ‘Machine Match’ menu item in the ‘Mode’ menu). +
    Tournament file
    To run a tournament, XBoard needs a file to record its progress, +so it can resume the tourney when it is interrupted. +When you want to conduct anything more complex than a simple +two-player match with the currently loaded engines, +(i.e. when you select a list of participants), +you must not leave this field blank. +When you enter the name of an existing tournament file, +XBoard will ignore all other input specified in the dialog, +and will take them from that tournament file. +This resumes an interrupted tournament, or adds another XBoard +agent playing games for it to those that are already doing so. +Specifying a not-yet-existing file will cause XBoard to create it, +according to the tournament parameters specified in the rest of the dialog, +before it starts the tournament on ‘OK’. +Provided that you specify participants; +without participants no tournament file will be made, but other entered values +(e.g. for the file with opening positions) will take effect. +Default: configured by the defaultTourneyName option. +
    Sync after round
    Sync after cycle
    The sync options, when on, will cause WinBoard to refrain from starting games +of the next round or cycle before all games of the previous round or cycle are finished. +This guarantees correct ordering in the games file, +even when multiple XBoard instances are concurrently playing games for the same tourney. +Default: sync after cycle, but not after round. +
    Select Engine
    Tourney participants
    With the Select Engine drop-down list you can pick an engine from your list +of installed engines in the settings file, to be added to the tournament. +The engines selected so far will be listed in the ‘Tourney participants’ memo. +The latter is a normal text edit, so you can use normal text-editing functions +to delete engines you selected by accident, or change their order. +Do not type names yourself there, because names that do not exactly match +one of the names from the drop-down list will lead to undefined behavior. +
    Tourney type
    Here you can specify the type of tournament you want. +XBoard’s intrinsic tournament manager support round-robins (type = 0), +where each participant plays every other participant, and (multi-)gauntlets, +where one (or a few) so-called ‘gauntlet engines’ play an independent set of opponents. +In the latter case, you specify the number of gauntlet engines. +E.g. if you specified 10 engines, and tourney type = 2, +the first 2 engines each play the remaining 8. +A value of -1 instructs XBoard to play Swiss; for this to work an external +pairing engine must be specified through the pairingEngine option. +Each Swiss round will be considered a tourney cycle in that case. +Default:0 +
    Number of tourney cycles
    Default number of Games
    You can specify tourneys where every two opponents play each other multiple times. +Such multiple games can be played in a row, +as specified by the ‘number of games per pairing’, +or by repeating the entire tournament schedule a number of times +(specified by the ‘number of tourney cycles’). +The total number of times two engine meet will be the product of these two. +Default is 1 cycle; +the number of games per pairing is the same as the default number of match games, +stored in your settings file through the defaultMatchGames option. +
    Save Tourney Games
    File where the tournament games are saved +(duplicate of the item in the ‘Save Game Options’). +
    Game File with Opening Lines
    File with Start Positions
    Game Number
    Position Number
    Rewind Index after
    These items optionally specify the file with move sequences or board positions the tourney +games should start from. +The corresponding numbers specify the number of the game or position in the file. +Here a value -1 means automatic stepping through all games on the file, +-2 automatic stepping every two games. +The Rewind-Index parameter causes a stepping index to reset to one after reaching +a specified value. +A setting of -2 for the game number will also be effective in a tournament without +specifying a game file, but playing from the GUI book instead. +In this case the first (odd) games will randomly select from the book, +but the second (even) games will select the same moves from the book as the previous game. +(Note this leads to the same opening only if both engines use the GUI book!) +Default: No game or position file will be used. The default index if such a file is used is 1. +
    Disable own engine bools be default
    Setting this option reverses the default situation for use of the GUI opening book +in tournaments from what it normally is, namely not using it. +So unless the engine is installed with an option to explicitly specify it should +not use the GUI book (i.e. -firstHasOwnBookUCI true), +it will be made to use the GUI book. +
    Replace Engine
    Upgrade Engine
    With these two buttons you can alter the participants of an already running tournament. +After opening the Match Options dialog on an XBoard that is playing for the tourney, +you will see all the tourney parameters in the dialog fields. +You can then replace the name of one engine by that of another +by editing the ‘participants’ field. +(But preserve the order of the others!) +Pressing the button after that will cause the substitution. +With the ‘Upgrade Engine’ button the substitution will only affect future games. +With ‘Replace Engine’ all games the substituted engine has already played will +be invalidated, and they will be replayed with the substitute engine. +In this latter case the engine must not be playing when you do this, +but otherwise there is no need to pause the tournament play +for making a substitution. +
    Clone Tourney
    Pressing this button after you have specified an existing tournament file +will copy the contents of the latter to the dialog, +and then puts the originally proposed name for the tourney file back. +You can then run a tourney with the same parameters +(possibly after changing the proposed name of the tourney file for the new tourney) +by pressing 'OK'. + +
    Load Game Options
    Summons a dialog where you can set the autoDisplayComment and +autoDisplayTags options, (which control popups when viewing loaded games), +and specify the rate at which loaded games are auto-played, +in seconds per move (which can be a fractional number, like 1.6). +You can also set search criteria for determining which games +will be displayed in the Game List for a multi-game file, +and thus be eligible for loading: +
    Elo of strongest player
    Elo of weakest player
    year
    These numeric fields set thresholds (lower limits) on the Elo rating of the mentioned player, +or the date the game was played. +Defaults: 0 +
    Search mode
    This setting determines which positions in a game will be considered a match +to the position currently displayed in the board window +when you press the ‘find position’ button in the Game List. +You can search for an exact match, +a position that has all shown material in the same place, +but might contain additional material, +a position that has all Pawns in the same place, +but can have the shown material anywhere, +a position that can have all shown material anywhere, +or a position that has material between certain limits anywhere. +For the latter you have to place the material that must be present +in the four lowest ranks of the board, +and optional additional material in the four highest ranks of the board. +You can request the optional material to be balanced. +
    number of consecutive positions
    When you are searching by material, rather than for an exact match, +this parameter indicates forhowmany consecutive game positions +the same amount of material must be on the board before it is +considered a match. +
    Also match reversed colors
    Also match left-right flipped position
    When looking for matching positions rather than by material, +these settings determine whether mirror images +(in case of a vertical flip in combination with color reversal) +will be also considered a match. +The left-right flipping is only useful after all castling rights +have expired (or in Xiangqi). + +
    Save Game Options
    Summons a dialog where you can specify the files on which XBoard should +automtically save any played or entered games, +(the saveGameFile option), +or the final position of such games (the savePositionfile option). +You can also select 'auto-save' without a file name, +in which case XBoard will prompt the user for a file name after each game. +You can also set the default value for the PGN Event tag that will +be used for each new game you start. +Various options for the format of the game can be specified as well, +such as whether scores and depths of engine games should be saved as comments, +and if a tag with info about the score with which the engine came out of book +should be included. +For Chess, always set the format to PGN, rather than "old save stye"! + +
    Game List
    Pops up a dialog where you can select the PGN tags that should appear +on the lines in the game list, and their order. + +
    Sound Options
    Summons a dialog where you can specify the sounds that should accompany +various events that can occur XBoard. +Most events are only relevant to ICS play, +but the move sound is an important exception. +For each event listed in the dialog, +you can select a standard sound from a menu. +You can also select a user-supplied sound file, +by typing its name into the designated text-edit field first, +and then selecting "Above WAV File" from the menu for the event. +A dummy event has been provided for trying out the sounds with the +"play" button next to it. +The directory with standard sounds, and the external program for playing +the sounds can be specified too, but normally you would not touch these +once XBoard is properly installed. +When a move sound other than 'None' is selected, +XBoard alerts you by playing that sound +after each of your opponent's moves (or after every +move if you are observing a game on the Internet Chess Server). +The sound is not played after moves you make or moves read from a +saved game file. + +
    Save Settings Now
    Selecting this menu item causes the current XBoard settings to be written to the settings file, so they will also apply in future sessions. Note that some settings are 'volatile', and are not saved, because XBoard considers it too unlikely that you want those to apply @@ -373,7 +500,7 @@ or the variant you are playing. Such options would still be understood when they appear in the settings file in case they were put there with the aid of a text editor, but they would disappear from the file as soon as you save the settings. -
    Save Settings on Exit
    Setting this option has no immediate effect, but causes the settings +
    Save Settings on Exit
    Setting this option has no immediate effect, but causes the settings to be saved when you quit XBoard. What happens then is otherwise identical to what happens when you use select "Save Settings Now", see there. diff --git a/manual/html_node/Options.html b/manual/html_node/Options.html index dd96d84..9d17c83 100644 --- a/manual/html_node/Options.html +++ b/manual/html_node/Options.html @@ -33,11 +33,12 @@ Up: Top

    4 Options

    -

    +

    This section documents the command-line options to XBoard. You can set these options in two ways: by typing them on the shell command -line you use to start XBoard, or by setting them as X resources -(typically in your .Xresources file). Many of the options +line you use to start XBoard, or by editing the settings file +(usually ~/.xboardrc) to alter the value of the setting that was +saved there. Some of the options cannot be changed while XBoard is running; others set the initial state of items that can be changed with the Options menu. @@ -50,23 +51,15 @@ turn the option off (‘-xopt’) numbers as values, you can use the long or short option names interchangeably. -

    Each option corresponds to an X resource with the same name, so -if you like, you can set options in your .Xresources file -or in a file named XBoard in your home directory. -For options that have two names, the longer one is the name of -the corresponding X resource; the short name is not recognized. -To turn a boolean option on or off as an -X resource, give its long name followed by the value -true or false (‘XBoard*longOptionName: true’). -

    diff --git a/manual/html_node/Other-options.html b/manual/html_node/Other-options.html index 1bc43d8..d384b26 100644 --- a/manual/html_node/Other-options.html +++ b/manual/html_node/Other-options.html @@ -30,20 +30,20 @@ Up: Options
    -

    4.7 Other options

    +

    4.8 Other options

    -

    +

    -
    -ncp/-xncp or -noChessProgram true/false
    If this option is true, XBoard acts as a passive chessboard; it +
    -ncp/-xncp or -noChessProgram true/false
    If this option is true, XBoard acts as a passive chessboard; it does not start a chess engine at all. Turning on this option also turns off clockMode. Default: false. -
    -mode or -initialMode modename
    If this option is given, XBoard selects the given modename +
    -mode or -initialMode modename
    If this option is given, XBoard selects the given modename from the Mode menu after starting and (if applicable) processing the loadGameFile or loadPositionFile option. Default: "" (no selection). Other supported values are MachineWhite, MachineBlack, TwoMachines, Analysis, AnalyzeFile, EditGame, EditPosition, and Training. -
    -variant varname
    Activates preliminary, partial support for playing chess variants +
    -variant varname
    Activates preliminary, partial support for playing chess variants against a local engine or editing variant games. This flag is not needed in ICS mode. Recognized variant names are: @@ -100,25 +100,25 @@ Berolina and cylinder chess can only be played with legality testing off. In crazyhouse, XBoard now does keep track of off-board pieces. In shatranj it does implement the baring rule when mate detection is switched on. -
    -boardHeight N
    Allows you to set a non-standard number of board ranks in any variant. +
    -boardHeight N
    Allows you to set a non-standard number of board ranks in any variant. If the height is given as -1, the default height for the variant is used. Default: -1 -
    -boardWidth N
    Allows you to set a non-standard number of board files in any variant. +
    -boardWidth N
    Allows you to set a non-standard number of board files in any variant. If the width is given as -1, the default width for the variant is used. With a non-standard width, the initial position will always be an empty board, as the usual opening array will not fit. Default: -1 -
    -holdingsSize N
    Allows you to set a non-standard size for the holdings in any variant. +
    -holdingsSize N
    Allows you to set a non-standard size for the holdings in any variant. If the size is given as -1, the default holdings size for the variant is used. The first N piece types will go into the holdings on capture, and you will be able to drop them on the board in stead of making a normal move. If size equals 0, there will be no holdings. Default: -1 -
    -defaultFrcPosition N
    Specifies the number of the opening position in shuffle games like Chess960. +
    -defaultFrcPosition N
    Specifies the number of the opening position in shuffle games like Chess960. A value of -1 means the position is randomly generated by XBoard at the beginning of every game. Default: -1 -
    -pieceToSquareTable string
    The characters that are used to represent the piece types XBoard knows in FEN +
    -pieceToCharTable string
    The characters that are used to represent the piece types XBoard knows in FEN diagrams and SAN moves. The string argument has to have an even length (or it will be ignored), as white and black pieces have to be given separately (in that order). The last letter for each color will be the King. @@ -138,10 +138,26 @@ Note that promoted pieces are represented by pieces 11 further in the list. You should not have to use this option often: each variant has its own default setting for the piece representation in FEN, which should be sufficient in normal use. Default: "" -
    -debug/-xdebug or -debugMode true/false
    Turns on debugging printout. -
    -debugFile filename or -nameOfDebugFile filename
    Sets the name of the file to which XBoard saves debug information +
    -pieceNickNames string
    The characters in the string are interpreted the same way as in the +pieceToCharTable option. But on input, piece-ID letters are +first looked up in the nicknames, and only if not defined there, +in the normal pieceToCharTable. This allows you to have two letters +designate the same piece, (e.g. N as an alternative to H for Horse +in Xiangqi), to make reading of non-compliant notations easier. +Default: "" +
    -colorNickNames string
    The side-to-move field in a FEN will be first matched against the letters +in the string (first character for white, second for black), +before it is matched to the regular 'w' and 'b'. +This makes it easier to read non-compliant FENs, +which, say, use 'r' for white. +Default: "" +
    -debug/-xdebug or -debugMode true/false
    Turns on debugging printout. +
    -debugFile filename or -nameOfDebugFile filename
    Sets the name of the file to which XBoard saves debug information (including all communication to and from the engines). -
    -engineDebugOutput number
    Specifies how XBoard should handle unsolicited output from the engine, +A %d in the given file name (e.g. game%d.debug) will be replaced +by the unique sequence number of a tournament game, +so that the debug output of each game will be written on a separate file. +
    -engineDebugOutput number
    Specifies how XBoard should handle unsolicited output from the engine, with respect to saving it in the debug file. The output is further (hopefully) ignored. If number=0, XBoard refrains from writing such spurious output to the debug file. @@ -151,14 +167,21 @@ as the engine itself should have done if it wanted to submit info for inclusion This option is provided for the benefit of applications that use the debug file as a source of information, such as the broadcaster of live games TLCV / TLCS. Such applications can be protected from spurious engine output that might otherwise confuse them. -
    -rsh or -remoteShell shell-name
    Name of the command used to run programs remotely. The default +
    -rsh or -remoteShell shell-name
    Name of the command used to run programs remotely. The default is rsh or remsh, determined when XBoard is configured and compiled. -
    -ruser or -remoteUser user-name
    User name on the remote system when running programs with the +
    -ruser or -remoteUser user-name
    User name on the remote system when running programs with the remoteShell. The default is your local user name. -
    -userName username
    Name under which the Human player will be listed in the PGN file. +
    -userName username
    Name under which the Human player will be listed in the PGN file. Default is the login name on your local computer. -
    -delayBeforeQuit number
    -delayAfterQuit number
    These options specify how long XBoard has to wait before sending a termination signal to rogue engine processes, that do not want to react to the 'quit' command. The second one determines the pause after killing the engine, to make sure it dies. +
    -delayBeforeQuit number
    -delayAfterQuit number
    These options specify how long XBoard has to wait before sending a termination signal to rogue engine processes, that do not want to react to the 'quit' command. The second one determines the pause after killing the engine, to make sure it dies. +
    -searchMode n
    The integer n encodes the mode for the ‘find position’ function. +Default: 1 (= Exact position match) +
    -eloThresholdBoth elo
    -eloThresholdAny elo
    Defines a lower limit for the Elo rating, which has to be surpassed +before a game will be considered when searching for a board position. +Default: 0 +
    -dateThreshold year
    Only games not played before the given year will be considered when +searching for a board position
    diff --git a/manual/html_node/Other-programs.html b/manual/html_node/Other-programs.html index 3c9297f..dfd17d1 100644 --- a/manual/html_node/Other-programs.html +++ b/manual/html_node/Other-programs.html @@ -33,7 +33,7 @@ Up: Top

    12 Other programs you can use with XBoard

    -

    +

    Here are some other programs you can use with XBoard