updated documentation

[xboard.git] / manual / xboard.txt

\r

   \r
INFO-DIR-SECTION Games\r
START-INFO-DIR-ENTRY\r
* xboard: (xboard).         An X Window System graphical chessboard.\r
END-INFO-DIR-ENTRY\r
   \r \r

Introduction
************

\r \r XBoard is a graphical chessboard that can serve as a\r user
interface to chess engines (such as GNU Chess), the\r Internet Chess
Servers,\r electronic mail correspondence chess, or your own collection
of saved games.\r \r This manual documents version 4.4.0j of XBoard.\r
\r \r

1 Major modes
*************

\r XBoard always runs in one of four major modes.  You select the\r
major mode from the command line when you start up XBoard.\r \r
xboard [options]
     As an interface to GNU Chess or another chess engine running on
     your\r machine, XBoard lets you play a game against the machine,\r
     set up arbitrary positions, force variations, watch a game between
     two\r chess engines, interactively analyze your stored games or
     set up and\r analyze arbitrary positions.  (Note: Not all chess
     engines support\r analysis.)\r

xboard -ics -icshost hostname [options]
     As Internet Chess Server (ICS) interface, XBoard\r lets you play
     against other ICS users, observe games\r they are playing, or
     review games that have recently finished.  Most\r of the ICS
     "wild" chess variants are supported, including bughouse.\r

xboard -ncp [options]
     XBoard can also be used simply\r as an electronic chessboard to
     play through games. It will read and\r write game files and allow
     you to play through variations\r manually. You can use it to
     browse games off the net or review games\r you have saved.  These
     features are also available in the other modes.\r

|pxboard
     If you want to pipe games into XBoard, use the supplied shell\r
     script `pxboard'.  For example, from the news reader `xrn',\r find
     a message with one or more games in it, click the Save button,\r
     and type `|pxboard' as the file name.\r

cmail [options]
     As an interface to electronic mail correspondence chess, XBoard\r
     works with the cmail program. See *note CMail:: below for\r
     instructions.\r
   \r

2 Menus, buttons, and keys
**************************

\r To move a piece, you can drag it with the left mouse button, or you\r
can click the left mouse button once on the piece, then once more on\r
the destination square.  To drop a new piece on a square (when\r
applicable), press the middle or the right mouse button over the\r
square and select from the popup menu.  In cases where you can drop\r
either a white or black piece, use the middle button (or shift+right)\r
for white and the right button (or shift+middle) for black.  When you\r
are playing a bughouse game on an Internet Chess Server, a list of the\r
offboard pieces that each player has available is shown in the window\r
title after the player's name; in addition, the piece menus show the\r
number of pieces available of each type. From version 4.3.14 on, it is\r
also possible in crazyhouse, bughouse or shogi to dag and drop pieces\r
to the board from the holdings squares displayed next to the board.\r \r
All other XBoard commands are available from the menu bar. The most\r
frequently used commands also have shortcut keys or on-screen buttons.\r
\r When XBoard is iconized, its graphical icon is a white knight if\r
it is White's turn to move, a black knight if it is Black's turn.  See\r
Iconize in *note Keys:: below if you have problems getting this\r
feature to work.\r \r \r

2.1 File Menu
=============

New Game
     Resets XBoard and the chess engine to the beginning of a new
     chess\r game. The `r' key is a keyboard equivalent. In Internet
     Chess\r Server mode, clears the current state of XBoard, then\r
     resynchronizes with the ICS by sending a refresh command. If you
     want to\r stop playing, observing, or examining an ICS game, use
     an\r appropriate command from the Action menu, not `New Game'.\r
     *Note Action Menu::.\r

New Shuffle Game
     Similar to `New Game', but allows you to specify a particular
     initial position \r (according to a standardized numbering
     system)\r in chess variants which use randomized opening positions
     (e.g. Chess960).\r The selected opening position will persistently
     be chosen on any following\r New Game command until you use this
     menu to select another. Selecting\r position number -1 will
     produce a newly randomized position on any new game.\r Using this
     menu item in variants that normally do not shuffle their opening
     position\r does cause these variants to become shuffle variants
     until you use the\r `New Shuffle Game' menu to explicitly switch
     the randomization off,\r or select a new variant.\r

New Variant
     Allows you to select a new chess variant in non-ICS mode. \r (In
     ICS play, the ICS is responsible for deciding which variant will
     be played,\r and XBoard adapts autmatically.) If you play with an
     engine, the engine must\r be able to play the selected variant, or
     the command will be ignored.\r XBoard supports all major variants,
     such as xiangqi, shogi, chess, chess960,\r Capablanca Chess,
     shatranj, crazyhous, bughouse.\r

Load Game
     Plays a game from a record file. The `g' key is a keyboard
     equivalent.\r A popup dialog prompts you for the file name. If the
     file contains more\r than one game, a second popup dialog\r
     displays a list of games (with information drawn from their PGN
     tags, if\r any), and you can select the one you want.
     Alternatively, you can load the\r Nth game in the file directly,
     by typing the number `N' after the\r file name, separated by a
     space.\r \r The game file parser will accept PGN (portable game
     notation),\r or in fact almost any file that contains moves in
     algebraic\r notation. \r Notation of the form `P@f7'\r is accepted
     for piece-drops in bughouse games;\r this is a nonstandard
     extension to PGN.\r If the file includes a PGN position (FEN tag),
     or an old-style\r XBoard position diagram bracketed by `[--' and
     `--]'\r before the first move, the game starts from that position.
     Text\r enclosed in parentheses, square brackets, or curly braces
     is assumed to\r be commentary and is displayed in a pop-up window.
     Any other\r text in the file is ignored. PGN variations (enclosed
     in\r parentheses) are treated as comments; XBoard is not able to
     walk\r variation trees.\r The nonstandard PGN tag [Variant
     "varname"] functions similarly to\r the -variant command-line
     option (see below), allowing games in certain chess\r variants to
     be loaded.  There is also a heuristic to \r recognize chess
     variants from the Event tag, by looking for the strings\r that the
     Internet Chess Servers put there when saving variant ("wild")
     games.\r

Load Next Game
     Loads the next game from the last game record file you loaded.\r
     The shifted `N' key is a keyboard equivalent.\r

Load Previous Game
     Loads the previous game from the last game record file you\r
     loaded.  The shifted `P' key is a keyboard equivalent.\r Not
     available if the last game was loaded from a pipe.\r

Reload Same Game
     Reloads the last game you loaded.\r Not available if the last game
     was loaded from a pipe.\r

Save Game
     Appends a record of the current game to a file.\r A popup dialog\r
     prompts you for the file name. If the game did not begin with\r
     the standard starting position, the game file includes the\r
     starting position used. Games are saved in the PGN (portable\r
     game notation) format, unless the oldSaveStyle option is true,\r
     in which case they are saved in an older format that is specific\r
     to XBoard. Both formats are human-readable, and both can be\r read
     back by the `Load Game' command.\r Notation of the form `P@f7'\r
     is accepted for piece-drops in bughouse games;\r this is a
     nonstandard extension to PGN.\r

Copy Game
     Copies a record of the current game to an internal clipboard in
     PGN\r format and sets the X selection to the game text.  The game
     can be\r pasted to another application (such as a text editor or
     another copy\r of XBoard) using that application's paste command.
     In many X\r applications, such as xterm and emacs, the middle
     mouse button can be\r used for pasting; in XBoard, you must use
     the Paste Game command.\r

Paste Game
     Interprets the current X selection as a game record and loads it,
     as\r with Load Game.\r

Load Position
     Sets up a position from a position file.  A popup dialog prompts\r
     you for the file name. If the file contains more than one saved\r
     position, and you want to load the Nth one, type the number N\r
     after the file name, separated by a space. Position files must\r
     be in FEN (Forsythe-Edwards notation), or in the format that the\r
     Save Position command writes when oldSaveStyle is turned on.\r

Load Next Position
     Loads the next position from the last position file you loaded.\r

Load Previous Position
     Loads the previous position from the last position file you\r
     loaded.  Not available if the last position was loaded from a
     pipe.\r

Reload Same Position
     Reloads the last position you loaded.\r Not available if the last
     position was loaded from a pipe.\r

Save Position
     Appends a diagram of the current position to a file.\r A popup
     dialog\r prompts you for the file name. Positions are saved in\r
     FEN (Forsythe-Edwards notation) format unless the `oldSaveStyle'\r
     option is true, in which case they are saved in an older,\r
     human-readable format that is specific to XBoard. Both formats\r
     can be read back by the `Load Position' command.\r

Copy Position
     Copies the current position to an internal clipboard in FEN format
     and\r sets the X selection to the position text.  The position can
     be pasted\r to another application (such as a text editor or
     another copy of\r XBoard) using that application's paste command.
     In many X\r applications, such as xterm and emacs, the middle
     mouse button can be\r used for pasting; in XBoard, you must use
     the Paste Position command.\r

Paste Position
     Interprets the current X selection as a FEN position and loads it,
     as\r with Load Position.\r

Mail Move
Reload CMail Message
     See *note CMail::.\r

Exit
     Exits from XBoard. The shifted `Q' key is a keyboard equivalent.\r
\r

2.2 Mode Menu
=============

Machine White
     Tells the chess engine to play White.\r

Machine Black
     Tells the chess engine to play Black.\r

Two Machines
     Plays a game between two chess engines.\r

Analysis Mode
     XBoard tells the chess engine to start analyzing the current
     game/position\r and shows you the analysis as you move pieces
     around.\r Note: Some chess engines do not support Analysis mode.\r
     \r To set up a position to analyze, you do the following:\r \r 1.
     Select Edit Position from the Mode Menu\r \r 2. Set up the
     position.  Use the middle and right buttons to\r bring up the
     white and black piece menus.\r \r 3. When you are finished, click
     on either the Black or White\r clock to tell XBoard which side
     moves first.\r \r 4. Select Analysis Mode from the Mode Menu to
     start the analysis.\r \r The analysis function can also be used
     when observing games on an ICS\r with an engine loaded (zippy
     mode); the engine then will analyse\r the positions as they occur
     in the observed game.\r

Analyze File
     This option lets you load a game from a file (PGN, XBoard format,
     etc.)\r and analyze it. When you select this menu item, a popup
     window appears\r and asks for a filename to load.\r If the file
     contains multiple games, another popup appears that lets\r you
     select which game you wish to analyze.\r After a game is loaded,
     use the XBoard arrow buttons to step\r forwards/backwards through
     the game and watch the analysis.\r Note: Some chess engines do not
     support Analysis mode.\r

ICS Client
     This is the normal mode when XBoard\r is connected to a chess
     server.  If you have moved into\r Edit Game or Edit Position mode,
     you can select this option to get out.\r \r To use xboard in ICS
     mode, run it in the foreground with the -ics\r option, and use the
     terminal you started it from to type commands and\r receive text
     responses from the chess server.  See\r *note Chess Servers::
     below for more information.\r \r XBoard activates some special
     position/game editing features when you\r use the `examine' or
     `bsetup' commands on ICS and you have\r `ICS Client' selected on
     the Mode menu.  First, you can issue the\r ICS position-editing
     commands with the mouse.  Move pieces by dragging\r with mouse
     button 1.  To drop a new piece on a square, press mouse\r button 2
     or 3 over the square.  This brings up a menu of white pieces\r
     (button 2) or black pieces (button 3).  Additional menu choices
     let\r you empty the square or clear the board.  Click on the White
     or Black\r clock to set the side to play.  You cannot set the side
     to play or\r drag pieces to arbitrary squares while examining on
     ICC, but you can\r do so in `bsetup' mode on FICS.  In addition,
     the menu commands\r `Forward', `Backward', `Pause', and `Stop
     Examining'\r have special functions in this mode; see below.\r

Edit Game
     Allows you to make moves for both Black and White, and to change\r
     moves after backing up with the `Backward' command. The clocks do\r
     not run.\r \r In chess engine mode, the chess engine continues to
     check moves for legality\r but does not participate in the game.
     You can bring the chess engine\r into the game by selecting
     `Machine White', `Machine Black',\r or `Two Machines'.\r \r In ICS
     mode, the moves are not sent to the ICS: `Edit Game' takes\r
     XBoard out of ICS Client mode and lets you edit games locally.\r
     If you want to edit games on ICS in a way that other ICS users\r
     can see, use the ICS `examine' command or start an ICS match\r
     against yourself.\r

Edit Position
     Lets you set up an arbitrary board position.\r Use mouse button 1
     to drag pieces to new squares, or to delete a piece\r by dragging
     it off the board or dragging an empty square on top of it.\r To
     drop a new piece on a square, press mouse button 2 or 3 over the\r
     square. This brings up a menu of white pieces (button 2) or\r
     black pieces (button 3). Additional menu choices let you empty
     the\r square or clear the board. You can set the side to play next
     by\r clicking on the word White or Black at the top of the
     screen.\r Selecting `Edit Position' causes XBoard to discard\r all
     remembered moves in the current game.\r \r In ICS mode, changes
     made to the position by `Edit Position' are\r not sent to the ICS:
     `Edit Position' takes XBoard out of\r `ICS Client' mode and lets
     you edit positions locally. If you want to\r edit positions on ICS
     in a way that other ICS users can see, use\r the ICS `examine'
     command, or start an ICS match against yourself.\r (See also the
     ICS Client topic above.)\r

Training
     Training mode lets you interactively guess the moves of a game for
     one\r of the players. You guess the next move of the game by
     playing the\r move on the board. If the move played matches the
     next move of the\r game, the move is accepted and the opponent's
     response is autoplayed.\r If the move played is incorrect, an
     error message is displayed.  You\r can select this mode only while
     loading a game (that is, after\r selecting `Load Game' from the
     File menu).  While XBoard is in \r `Training' mode, the navigation
     buttons are disabled.\r

Show Game List
     Shows or hides the list of games generated by the last `Load
     Game'\r command.\r

Show Move History
     Shows or hides a list of moves of the current game.\r This list
     allows you to move the display to any earlier position in the
     game\r by clicking on the corresponding move.\r

Show Engine Output
     Shows or hides a window in which the thinking output of any loaded
     engines\r is displayed.\r

Edit Tags
     Lets you edit the PGN (portable game notation)\r tags for the
     current game. After editing, the tags must still conform to\r the
     PGN tag syntax:\r \r
          <tag-section> ::= <tag-pair> <tag-section>\r
                                  <empty>\r
          <tag-pair> ::= [ <tag-name> <tag-value> ]\r
          <tag-name> ::= <identifier>\r
          <tag-value> ::= <string>\r
     See the PGN Standard for full details. Here is an example:\r \r
          [Event "Portoroz Interzonal"]\r
          [Site "Portoroz, Yugoslavia"]\r
          [Date "1958.08.16"]\r
          [Round "8"]\r
          [White "Robert J. Fischer"]\r
          [Black "Bent Larsen"]\r
          [Result "1-0"]\r
     Any characters that do not match this syntax are silently ignored.
     Note that\r the PGN standard requires all games to have at least
     the seven tags shown\r above. Any that you omit will be filled in
     by XBoard\r with `?' (unknown value), or `-' (inapplicable
     value).\r

Edit Comment
     Adds or modifies a comment on the current position. Comments are\r
     saved by `Save Game' and are displayed by `Load Game',\r
     `Forward', and `Backward'.\r

ICS Input Box
     If this option is set in ICS mode,\r XBoard\r creates an extra
     window that you can use for typing in ICS commands.\r The input
     box is especially useful if you want to type in something long or
     do\r some editing on your input, because output from ICS doesn't
     get mixed\r in with your typing as it would in the main terminal
     window.\r

Pause
     Pauses updates to the board, and if you are playing against a
     chess engine,\r also pauses your clock. To continue, select
     `Pause' again, and the\r display will automatically update to the
     latest position.\r The `P' button and keyboard `p' key are
     equivalents.\r \r If you select Pause when you are playing against
     a chess engine and\r it is not your move, the chess engine's
     clock\r will continue to run and it will eventually make a move,
     at which point\r both clocks will stop. Since board updates are
     paused, however,\r you will not see the move until you exit from
     Pause mode (or select Forward).\r This behavior is meant to
     simulate adjournment with a sealed move.\r \r If you select Pause
     while you are observing or examining a game on a\r chess server,
     you can step backward and forward in the current history\r of the
     examined game without affecting the other observers and\r
     examiners, and without having your display jump forward to the
     latest\r position each time a move is made. Select Pause again to
     reconnect\r yourself to the current state of the game on ICS.\r \r
     If you select `Pause' while you are loading a game, the game
     stops\r loading. You can load more moves manually by selecting
     `Forward', or\r resume automatic loading by selecting `Pause'
     again.\r
\r

2.3 Action Menu
===============

Accept
     Accepts a pending match offer. If there is more than one offer\r
     pending, you will have to type in a more specific command\r
     instead of using this menu choice.\r

Decline
     Declines a pending offer (match, draw, adjourn, etc.). If there\r
     is more than one offer pending, you will have to type in a more\r
     specific command instead of using this menu choice.\r

Call Flag
     Calls your opponent's flag, claiming a win on time, or claiming\r
     a draw if you are both out of time. You can also call your\r
     opponent's flag by clicking on his clock or by pressing the\r
     keyboard `t' key.\r

Draw
     Offers a draw to your opponent, accepts a pending draw offer\r
     from your opponent, or claims a draw by repetition or the 50-move\r
     rule, as appropriate. The `d' key is a keyboard equivalent.\r

Adjourn
     Asks your opponent to agree to adjourning the current game, or\r
     agrees to a pending adjournment offer from your opponent.\r

Abort
     Asks your opponent to agree to aborting the current game, or\r
     agrees to a pending abort offer from your opponent. An aborted\r
     game ends immediately without affecting either player's rating.\r

Resign
     Resigns the game to your opponent. The shifted `R' key is a\r
     keyboard equivalent.\r

Stop Observing
     Ends your participation in observing a game, by issuing the ICS\r
     observe command with no arguments. ICS mode only.\r

Stop Examining
     Ends your participation in examining a game, by issuing the ICS\r
     unexamine command. ICS mode only.\r
\r

2.4 Step Menu
=============

Backward
     Steps backward through a series of remembered moves.\r The `[<]'
     button and the `b' key are equivalents,\r as is turning the mouse
     wheel towards you.\r In addition, pressing the Control key steps
     back one move, and releasing\r it steps forward again.\r \r In
     most modes, `Backward' only lets you look back at old positions;\r
     it does not retract moves. This is the case if you are playing
     against\r a chess engine, playing or observing a game on an ICS,
     or loading a game.\r If you select `Backward' in any of these
     situations, you will not\r be allowed to make a different move.
     Use `Retract Move' or\r `Edit Game' if you want to change past
     moves.\r \r If you are examining an ICS game, the behavior of
     `Backward'\r depends on whether XBoard is in Pause mode. If Pause
     mode is\r off, `Backward' issues the ICS backward command, which
     backs up\r everyone's view of the game and allows you to make a
     different\r move. If Pause mode is on, `Backward' only backs up
     your local\r view.\r

Forward
     Steps forward through a series of remembered moves (undoing the\r
     effect of `Backward') or forward through a game file. The\r `[>]'
     button and the `f' key are equivalents,\r as is turning the mouse
     wheel away from you.\r \r If you are examining an ICS game, the
     behavior of Forward\r depends on whether XBoard is in Pause mode.
     If Pause mode is\r off, `Forward' issues the ICS forward command,
     which moves\r everyone's view of the game forward along the
     current line. If\r Pause mode is on, `Forward' only moves your
     local view forward,\r and it will not go past the position that
     the game was in when\r you paused.\r

Back to Start
     Jumps backward to the first remembered position in the game.\r The
     `[<<]' button and the shifted `B' key are equivalents.\r \r In
     most modes, Back to Start only lets you look back at old\r
     positions; it does not retract moves. This is the case if you\r
     are playing against a local chess engine, playing or observing a
     game on\r a chess server, or loading a game. If you select `Back
     to Start' in any\r of these situations, you will not be allowed to
     make different\r moves. Use `Retract Move' or `Edit Game' if you
     want to change past\r moves; or use Reset to start a new game.\r \r
     If you are examining an ICS game, the behavior of `Back to\r
     Start' depends on whether XBoard is in Pause mode. If Pause mode\r
     is off, `Back to Start' issues the ICS `backward 999999'\r
     command, which backs up everyone's view of the game to the start
     and\r allows you to make different moves. If Pause mode is on,
     `Back\r to Start' only backs up your local view.\r

Forward to End
     Jumps forward to the last remembered position in the game. The\r
     `[>>]' button and the shifted `F' key are equivalents.\r \r If you
     are examining an ICS game, the behavior of `Forward to\r End'
     depends on whether XBoard is in Pause mode. If Pause mode\r is
     off, `Forward to End' issues the ICS `forward 999999'\r command,
     which moves everyone's view of the game forward to the end of\r
     the current line. If Pause mode is on, `Forward to End' only
     moves\r your local view forward, and it will not go past the
     position\r that the game was in when you paused.\r

Revert
     If you are examining an ICS game and Pause mode is off, issues\r
     the ICS command `revert'.\r

Truncate Game
     Discards all remembered moves of the game beyond the current\r
     position. Puts XBoard into `Edit Game' mode if it was not there\r
     already.\r

Move Now
     Forces the chess engine to move immediately. Chess engine mode
     only.\r

Retract Move
     Retracts your last move. In chess engine mode, you can do this
     only\r after the chess engine has replied to your move; if the
     chess engine is still\r thinking, use `Move Now' first. In ICS
     mode, `Retract Move'\r issues the command `takeback 1' or
     `takeback 2'\r depending on whether it is your opponent's move or
     yours.\r

Adjudicate to White
Adjudicate to Black
Adjudicate Draw
     Terminate an ongoing game in Two-Machines mode (including match
     mode),\r with as result a win for white, for black, or a draw,
     repsectively.\r The PGN file of the game will accompany the result
     string\r by the comment "user adjudication".\r
\r

2.5 Options Menu
================

Flip View
     Inverts your view of the chess board for the duration of the\r
     current game. Starting a new game returns the board to normal.\r
     The `v' key is a keyboard equivalent.\r

Adjudications
     Pops up a sub-menu where you can enable or disable various
     adjudications\r that XBoard can perform in engine-engine games.\r
     You can instruct XBoard to detect and terminate the game on
     checkmate\r or stalemate, even if the engines would not do so, to
     verify engine\r result claims (forfeiting engines that make false
     claims), rather than\r naively following the engine, to declare
     draw on posititions\r which can never be won for lack of mating
     material, (e.g. KBK),\r or which are impossble to win unless the
     opponent seeks its own demise \r (e.g. KBKN).\r For these
     adjudications to work, `Test Legality' should be switched on.\r It
     is also possible to insruct XBoard to enforce a 50-move or
     3-fold-repeat\r rule and automtically declare draw (after a
     user-adjustable number of moves\r or repeats) even if the engines
     are prepared to go on.\r It is also possible to have XBoard
     declare draw on games that seem to drag on \r forever, or
     adjudicate a loss if both engines agree (for 3 cosecutive moves)
     that one\r of them is behind more than a user-adjustable score
     threshold.\r For the latter adjudication to work, XBoard should be
     able to properly understand\r the engine's scores. To faclitate
     the latter, you can inform xboard here if\r the engines report
     scores from the viewpoint of white, or from that of their own
     color.\r

Engine Settings
     Pops up a sub-menu where you can set some engine parameters common
     to most engines,\r such as hash-table size, tablebase cache size,
     maximum number of processors\r that SMP engines can use, and where
     to find the Polyglot adapter needed\r to run UCI engines under
     XBoard. The feature tht allows setting of these parameters on\r
     engines is new since XBoard 4.3.15, so not many WinBoard engines
     respond\r to it yet, but UCI engines should.\r It is also possible
     to specify a GUI opening book here, i.e. an opening\r book that
     XBoard consults for any position a playing engine gets in.\r It
     then forces the engine to play the book move, rather than to think
     up its own,\r if that position is found in the book.\r The book
     can switched on and off independently for either engine.\r

Time Control
     Pops up a sub-menu where you can set the time-control parameters
     interactively.\r Allows you to select classical or incremental
     time controls,\r set the moves per session, session duration, and
     time increment.\r Also allows specification of time-odds factors
     for one or both engines.\r If an engine is given a time-odds
     factor N, all time quota it gets, \r be it at the beginning of a
     session or through the time increment or\r fixed time per move,
     will be divided by N.\r

Always Queen
     If this option is off, XBoard brings up a dialog\r box whenever
     you move a pawn to the last rank, asking what piece\r you want to
     promote it to. If the option is true, your pawns are\r always
     promoted to queens. Your opponent can still underpromote.\r

Animate Dragging
     If Animate Dragging is on, while you are dragging a piece with
     the\r mouse, an image of the piece follows the mouse cursor.\r If
     Animate Dragging is off, there is no visual feedback while you
     are\r dragging a piece, but if Animate Moving is on, the move will
     be\r animated when it is complete. \r

Animate Moving
     If Animate Moving is on, all piece moves are animated.  An image
     of the\r piece is shown moving from the old square to the new
     square when the\r move is completed (unless the move was already
     animated by Animate Dragging).\r If Animate Moving is off, a moved
     piece instantly disappears from its\r old square and reappears on
     its new square when the move is complete.\r

Auto Comment
     If this option is on, any remarks made on ICS while you are
     observing or\r playing a game are recorded as a comment on the
     current move.  This includes\r remarks made with the ICS commands
     `say', `tell', `whisper',\r and `kibitz'.\r Limitation: remarks
     that you type yourself are not recognized;\r XBoard scans only the
     output from ICS, not the input you type to it.\r

Auto Flag
     If this option is on and one player runs out of time\r before the
     other,\r XBoard\r will automatically call his flag, claiming a win
     on time.\r In ICS mode, Auto Flag will only call your opponent's
     flag, not yours,\r and the ICS may award you a draw instead of a
     win if you have\r insufficient mating material.  In local chess
     engine mode,\r XBoard\r may call either player's flag and will not
     take material into account.\r

Auto Flip View
     If the Auto Flip View option is on when you start a game, the
     board\r will be automatically oriented so that your pawns move
     from the bottom\r of the window towards the top.\r

Auto Observe
     If this option is on and you add a player to your `gnotify'\r list
     on ICS, XBoard will automatically observe all of that\r player's
     games, unless you are doing something else (such as\r observing or
     playing a game of your own) when one starts.\r The games are
     displayed \r from the point of view of the player on your gnotify
     list; that is, his\r pawns move from the bottom of the window
     towards the top.\r Exceptions:  If both players in a game are on
     your gnotify list, if\r your ICS \r `highlight'\r variable is set
     to 0, or if the ICS you are using does not \r properly support
     observing from Black's point of view,\r you will see the game from
     White's point of view.\r

Auto Raise Board
     If this option is on, whenever a new game begins, the chessboard
     window\r is deiconized (if necessary) and raised to the top of the
     stack of windows.\r

Auto Save
     If this option is true, at the end of every game XBoard prompts\r
     you for a file name and appends a record of the game to the file\r
     you specify. \r Disabled if the `saveGameFile' command-line\r
     option is set, as in that case all games are saved to the
     specified file.\r *Note Load and Save options::.\r

Blindfold
     If this option is on, XBoard displays the board as usual but does\r
     not display pieces or move highlights.  You can still move in the\r
     usual way (with the mouse or by typing moves in ICS mode), even
     though\r the pieces are invisible.\r

Flash Moves
     If this option is on, whenever a move is completed, the moved
     piece flashes.\r The number of times to flash is set by the
     flashCount command-line\r option; it defaults to 3 if Flash Moves
     is first turned on from the menu.\r \r If you are playing a game
     on an ICS, the board is always\r oriented at the start of the game
     so that your pawns move from\r the bottom of the window towards
     the top. Otherwise, the starting\r orientation is determined by
     the `flipView' command line option;\r if it is false (the
     default), White's pawns move from bottom to top\r at the start of
     each game; if it is true, Black's pawns move from\r bottom to top.
     *Note User interface options::.\r

Get Move List
     If this option is on, whenever XBoard\r receives the first board
     of a new ICS game (or a different game from\r the one it is
     currently displaying), it\r retrieves the list of past moves from
     the ICS.\r You can then review the moves with the `Forward' and
     `Backward'\r commands\r or save them with `Save Game'.  You might
     want to\r turn off this option if you are observing several blitz
     games at once,\r to keep from wasting time and network bandwidth
     fetching the move lists over\r and over.\r When you turn this
     option on from the menu, XBoard\r immediately fetches the move
     list of the current game (if any).\r

Highlight Last Move
     If Highlight Last Move is on, after a move is made, the starting
     and\r ending squares remain highlighted. In addition, after you
     use Backward\r or Back to Start, the starting and ending squares
     of the last move to\r be unmade are highlighted.\r

Move Sound
     If this option is on, XBoard alerts you by playing a sound\r after
     each of your opponent's moves (or after every\r move if you are
     observing a game on the Internet Chess Server).\r The sound is not
     played after moves you make or moves read from a\r saved game
     file. By default, the\r sound is the terminal bell, but on some
     systems you can change it\r to a sound file using the soundMove
     option; see below.\r \r If you turn on this option when using
     XBoard with the Internet\r Chess Server, you will probably want to
     give the\r `set bell 0'\r command to the ICS, since otherwise the
     ICS will ring the terminal bell\r after every move (not just
     yours). (The `.icsrc' file\r is a good place for this; see *note
     ICS options::.)\r

ICS Alarm
     When this option is on, an alarm sound is played when your clock\r
     counts down to the icsAlarmTime (by default, 5 seconds) in an ICS\r
     game.  For games with time controls that include an increment,
     the\r alarm will sound each time the clock counts down to the
     icsAlarmTime.\r By default, the alarm sound is the terminal bell,
     but on some systems\r you can change it to a sound file using the
     soundIcsAlarm option; see\r below.\r

Old Save Style
     If this option is off, XBoard saves games in PGN\r (portable game
     notation) and positions in FEN (Forsythe-Edwards\r notation).  If
     the option is on, a save style that is compatible\r with older
     versions of XBoard is used instead.\r The old position style is
     more human-readable\r than FEN; the old game style has no
     particular advantages.\r

Periodic Updates
     If this option is off (or if\r you are using a chess engine that
     does not support periodic updates),\r the analysis window\r will
     only be updated when the analysis changes. If this option is\r on,
     the Analysis Window will be updated every two seconds.\r

Ponder Next Move
     If this option is off, the chess engine will think only when it is
     on\r move.  If the option is on, the engine will also think while
     waiting\r for you to make your move.\r

Popup Exit Message
     If this option is on, when XBoard wants to display a message just\r
     before exiting, it brings up a modal dialog box and waits for you
     to\r click OK before exiting.  If the option is off, XBoard prints
     the\r message to standard error (the terminal) and exits
     immediately.\r

Popup Move Errors
     If this option is off, when you make an error in moving (such as\r
     attempting an illegal move or moving the wrong color piece), the\r
     error message is displayed in the message area.  If the option is\r
     on, move errors are displayed in small popup windows like other
     errors.\r You can dismiss an error popup either by clicking its OK
     button or by\r clicking anywhere on the board, including
     downclicking to start a move.\r

Premove
     If this option is on while playing a game on an ICS, you can
     register\r your next planned move before it is your turn.  Move
     the piece with\r the mouse in the ordinary way, and the starting
     and ending squares\r will be highlighted with a special color (red
     by default).  When it is\r your turn, if your registered move is
     legal, XBoard will send it to\r ICS immediately; if not, it will
     be ignored and you can make a\r different move.  If you change
     your mind about your premove, either\r make a different move, or
     double-click on any piece to cancel the move\r entirely.\r

Quiet Play
     If this option is on, XBoard will automatically issue an ICS\r
     `set shout 0'\r command whenever you start a game and a\r `set
     shout 1'\r command whenever you finish one.  Thus, you will not be
     distracted\r by shouts from other ICS users while playing.\r

Show Coords
     If this option is on, XBoard displays algebraic coordinates\r
     along the board's left and bottom edges.\r

Hide Thinking
     If this option is off, the chess engine's notion of the score and
     best\r line of play from the current position is displayed as it
     is\r thinking. The score indicates how many pawns ahead (or if
     negative,\r behind) the chess engine thinks it is. In matches
     between two\r machines, the score is prefixed by `W' or `B' to
     indicate\r whether it is showing White's thinking or Black's, and
     only the thinking\r of the engine that is on move is shown.\r

Test Legality
     If this option is on, XBoard tests whether the moves you try to
     make\r with the mouse are legal and refuses to let you make an
     illegal move.\r Moves loaded from a file with `Load Game' are also
     checked.  If\r the option is off, all moves are accepted, but if a
     local chess engine\r or the ICS is active, they will still reject
     illegal moves.  Turning\r off this option is useful if you are
     playing a chess variant with\r rules that XBoard does not
     understand.  (Bughouse, suicide, and wild\r variants where the
     king may castle after starting on the d file are\r generally
     supported with Test Legality on.)\r
\r

2.6 Help Menu
=============

Info XBoard
     Displays the XBoard documentation in info format.  For this
     feature to\r work, you must have the GNU info program installed on
     your system, and\r the file `xboard.info' must either be present
     in the current\r working directory, or have been installed by the
     `make install'\r command when you built XBoard.\r

Man XBoard
     Displays the XBoard documentation in man page format.  For this\r
     feature to work, the file `xboard.6' must have been installed by\r
     the `make install' command when you built XBoard, and the\r
     directory it was placed in must be on the search path for your\r
     system's `man' command.\r

Hint
     Displays a move hint from the chess engine.\r

Book
     Displays a list of possible moves from the chess engine's opening\r
     book.  The exact format depends on what chess engine you are
     using.\r With GNU Chess 4, the first column gives moves, the
     second column\r gives one possible response for each move, and the
     third column shows\r the number of lines in the book that include
     the move from the first\r column. If you select this option and
     nothing happens, the chess\r engine is out of its book or does not
     support this feature.\r

About XBoard
     Shows the current XBoard version number.\r
\r

2.7 Other Shortcut Keys
=======================

Iconize
     Pressing the `i' or `c' key iconizes XBoard. The graphical\r icon
     displays a white knight if it is White's move, or a black knight\r
     if it is Black's move. If your X window manager displays only
     text\r icons, not graphical ones, check its documentation; there
     is probably\r a way to enable graphical icons.  If you get black
     and white reversed,\r we would like to hear about it; see *note
     Problems:: below for\r instructions on how to report this
     problem.\r
\r You can add or remove shortcut keys using the X resources\r
`form.translations'. Here is an example of what would go in your\r
`.Xresources' file:\r \r
     XBoard*form.translations: \\r
       Shift<Key>?: AboutGameProc() \n\\r
       <Key>y: AcceptProc() \n\\r
       <Key>n: DeclineProc() \n\\r
       <Key>i: NothingProc()\r
   Binding a key to `NothingProc' makes it do nothing, thus removing\r
it as a shortcut key. The XBoard commands that can be bound to keys\r
are:\r \r
     AbortProc, AboutGameProc, AboutProc, AcceptProc, AdjournProc,\r
     AlwaysQueenProc, AnalysisModeProc, AnalyzeFileProc,\r
     AnimateDraggingProc, AnimateMovingProc, AutobsProc, AutoflagProc,\r
     AutoflipProc, AutoraiseProc, AutosaveProc, BackwardProc,\r
     BlindfoldProc, BookProc, CallFlagProc, CopyGameProc, CopyPositionProc,\r
     DebugProc, DeclineProc, DrawProc, EditCommentProc, EditGameProc,\r
     EditPositionProc, EditTagsProc, EnterKeyProc, FlashMovesProc,\r
     FlipViewProc, ForwardProc, GetMoveListProc, HighlightLastMoveProc,\r
     HintProc, Iconify, IcsAlarmProc, IcsClientProc, IcsInputBoxProc,\r
     InfoProc, LoadGameProc, LoadNextGameProc, LoadNextPositionProc,\r
     LoadPositionProc, LoadPrevGameProc, LoadPrevPositionProc,\r
     LoadSelectedProc, MachineBlackProc, MachineWhiteProc, MailMoveProc,\r
     ManProc, MoveNowProc, MoveSoundProc, NothingProc, OldSaveStyleProc,\r
     PasteGameProc, PastePositionProc, PauseProc, PeriodicUpdatesProc,\r
     PonderNextMoveProc, PopupExitMessageProc, PopupMoveErrorsProc,\r
     PremoveProc, QuietPlayProc, QuitProc, ReloadCmailMsgProc,\r
     ReloadGameProc, ReloadPositionProc, RematchProc, ResetProc,\r
     ResignProc, RetractMoveProc, RevertProc, SaveGameProc,\r
     SavePositionProc, ShowCoordsProc, ShowGameListProc, ShowThinkingProc,\r
     StopExaminingProc, StopObservingProc, TestLegalityProc, ToEndProc,\r
     ToStartProc, TrainingProc, TruncateGameProc, and TwoMachinesProc.\r
   \r

3 Options
*********

\r This section documents the command-line options to XBoard.  You can\r
set these options in two ways: by typing them on the shell command\r
line you use to start XBoard, or by setting them as X resources\r
(typically in your `.Xresources' file).  Many of the options\r cannot
be changed while XBoard is running; others set the initial\r state of
items that can be changed with the *note Options:: menu.\r \r Most of
the options have both a long name and a short name. To turn a\r boolean
option on or off from the command line, either give its long\r name
followed by the value true or false\r (`-longOptionName true'), or give
just the short name to turn the\r option on (`-opt'), or the short name
preceded by `x' to\r turn the option off (`-xopt'). For options that
take strings or\r numbers as values, you can use the long or short
option names\r interchangeably.\r \r Each option corresponds to an X
resource with the same name, so\r if you like, you can set options in
your `.Xresources' file\r or in a file named `XBoard' in your home
directory.\r For options that have two names, the longer one is the
name of\r the corresponding X resource; the short name is not
recognized.\r To turn a boolean option on or off as an\r X resource,
give its long name followed by the value\r true or false
(`XBoard*longOptionName: true').\r \r \r

3.1 Chess Engine Options
========================

-tc or -timeControl minutes[:seconds]
     Each player begins with his clock set to the `timeControl'
     period.\r Default: 5 minutes.\r The additional options
     `movesPerSession' and `timeIncrement'\r are mutually exclusive.  \r

-mps or -movesPerSession moves
     When both players have made `movesPerSession' moves, a\r new
     `timeControl' period is added to both clocks.  Default: 40 moves.\r

-inc or -timeIncrement seconds
     If this option is specified, `movesPerSession' is ignored.\r
     Instead, after each player's move, `timeIncrement' seconds are\r
     added to his clock.  \r Use `-inc 0' if you want to require the
     entire\r game to be played in one `timeControl' period, with no
     increment.\r Default: -1, which specifies `movesPerSession' mode.\r

-clock/-xclock or -clockMode true/false
     Determines whether or not to display the chess clocks. If
     clockMode is\r false, the clocks are not shown, but the side that
     is to play next\r is still highlighted. Also, unless `searchTime'\r
     is set, the chess engine still keeps track of the clock time and
     uses it to\r determine how fast to make its moves.\r

-st or -searchTime minutes[:seconds]
     Tells the chess engine to spend at most the given amount of time\r
     searching for each of its moves. Without this option, the chess
     engine\r chooses its search time based on the number of moves and
     amount\r of time remaining until the next time control.\r Setting
     this option also sets clockMode to false.\r

-depth or -searchDepth number
     Tells the chess engine to look ahead at most the given number of
     moves\r when searching for a move to make. Without this option,
     the chess\r engine chooses its search depth based on the number of
     moves and\r amount of time remaining until the next time control.
     With the option,\r the engine will cut off its search early if it
     reaches the specified depth.\r

-firstNPS number
-secondNPS number
     Tells the chess engine to use an internal time standard based on
     its node count, \r rather then wall-clock time, to make its timing
     decisions. \r The time in virtual seconds should be obtained by
     dividing the node count \r through the given number, like the
     number was a rate in nodes per second. \r Xboard will manage the
     clocks in accordance with this, relying on the number \r of nodes
     reported by the engine in its thinking output. If the given number
     equals zero, \r it can obviously not be used to convert nodes to
     seconds, and the time reported \r by the engine is used to
     decrement the XBoard clock in stead. The engine is supposed to \r
     report in CPU time it uses, rather than wall-clock time, in this
     mode. This option \r can provide fairer conditions for
     engine-engine matches on heavily loaded machines, \r or with very
     fast games (where the wall clock is too inaccurate). \r
     `showThinking' must be on for this option to work. Default: -1
     (off).\r Not many engines might support this yet!\r

-firstTimeOdds factor
-secondTimeOdds factor
     Reduces the time given to the mentioned engine by the given
     factor. \r If pondering is off, the effect is indistinguishable
     from what would happen \r if the engine was running on an n-times
     slower machine. Default: 1.\r

-timeOddsMode mode
     This option determines how the case is handled where both engines
     have a time-odds handicap. \r If mode=1, the engine that gets the
     most time will always get the nominal time, \r as specified by the
     time-control options, and its opponent's time is renormalized
     accordingly. \r If mode=0, both play with reduced time. Default:
     0.\r

-hideThinkingFromHuman true/false
     Controls the Hide Thinking option. *Note Options Menu::. Default:
     true.\r (Relaces the Show-Thinking option of older xboard
     versions.)\r

-thinking/-xthinking or -showThinking true/false
     Forces the engine to send thinking output to xboard. \r Used to be
     the only way to control if thinking output was displayed \r in
     older xboard versions,\r but as the thinking output in xboard 4.3
     is also used for several other\r purposes (adjudication, storing
     in PGN file) the display of it is now controlled\r by the new
     option Hide Thinking. *Note Options Menu::. Default: false.\r (But
     if xboard needs the thinking output for some purpose,\r it makes
     the engine send it despite the setting of this option.)\r

-ponder/-xponder or -ponderNextMove true/false
     Sets the Ponder Next Move menu option. *Note Options Menu::.
     Default: true.\r

-smpCores number
     Specifies the maxmum nmber of CPUs an SMP engine is allowed to
     use.\r Only works for engines that support the WinBoard-protocol
     cores feature.\r

-mg or -matchGames n
     Automatically runs an n-game match between two chess engines,\r
     with alternating colors.\r If the `loadGameFile' or
     `loadPositionFile' option is set,\r XBoard\r starts each game with
     the given opening moves or the given position;\r otherwise, the
     games start with the standard initial chess position.\r If the
     `saveGameFile' option is set, a move record for the\r match is
     appended to the specified file. If the `savePositionFile'\r option
     is set, the final position reached in each game of the match is
     appended\r to the specified file. When the match is over, XBoard\r
     displays the match score and exits. Default: 0 (do not run a
     match).\r

-mm/-xmm or -matchMode true/false
     Setting `matchMode' to true is equivalent to setting\r
     `matchGames' to 1.\r

-sameColorGames n
     Automatically runs an n-game match between two chess engines,\r
     without alternating colors.\r Otherwise the same applies as for
     the `-matchGames' option,\r over which it takes precedence if both
     are specified. (See there.)\r Default: 0 (do not run a match).\r

-fcp or -firstChessProgram program
     Name of first chess engine.\r Default: `Fairy-Max'.\r

-scp or -secondChessProgram program
     Name of second chess engine, if needed.\r A second chess engine is
     started only in Two Machines (match) mode.\r Default:
     `Fairy-Max'.\r

-fb/-xfb or -firstPlaysBlack true/false
     In games between two chess engines, firstChessProgram normally
     plays\r white.  If this option is true, firstChessProgram plays
     black.  In a\r multi-game match, this option affects the colors
     only for the first\r game; they still alternate in subsequent
     games.\r

-fh or -firstHost host
-sh or -secondHost host
     Hosts on which the chess engines are to run. The default for\r
     each is `localhost'. If you specify another host, XBoard\r uses
     `rsh' to run the chess engine there. (You can substitute a\r
     different remote shell program for rsh using the `remoteShell'\r
     option described below.)\r

-fd or -firstDirectory dir
-sd or -secondDirectory dir
     Working directories in which the chess engines are to be run.\r
     The default is "", which means to run the chess engine\r in the
     same working directory as XBoard\r itself.  (See the CHESSDIR
     environment variable.)\r This option is effective only when the
     chess engine is being run\r on the local host; it does not work if
     the engine is run remotely\r using the -fh or -sh option.\r

-initString string
-secondInitString string
     The string that is sent to initialize each chess engine for a new
     game.\r Default:\r \r
          new\r
          random\r
     Setting this option from the command line is tricky, because you
     must\r type in real newline characters, including one at the very
     end.\r In most shells you can do this by\r entering a `\'
     character followed by a newline. It is easier to set\r the option
     from your `.Xresources' file; in that case you can\r include the
     character sequence `\n' in the string, and it will\r be converted
     to a newline.\r \r If you change this option, don't remove the
     `new' \r command; it is required by all chess engines to\r start a
     new game.\r \r You can remove the `random' command if you like;
     including it\r causes GNU Chess 4 to randomize its move selection
     slightly so that it\r doesn't play the same moves in every game.
     Even without\r `random', GNU Chess 4 randomizes its choice of
     moves from its\r opening book.  Many other chess engines ignore
     this command entirely\r and always (or never) randomize.\r \r You
     can also try adding other commands to the initString; see the\r
     documentation of the chess engine you are using for details.\r

-firstComputerString string
-secondComputerString string
     The string that is sent to the chess engine if its opponent is
     another\r computer chess engine.  The default is `computer\n'.
     Probably the\r only useful alternative is the empty string (`'),
     which keeps the\r engine from knowing that it is playing another
     computer.\r

-reuse/-xreuse or -reuseFirst true/false
-reuse2/-xreuse2 or -reuseSecond true/false
     If the option is false,\r XBoard kills off the chess engine after
     every game and starts\r it again for the next game.  \r If the
     option is true (the default), \r XBoard starts the chess engine
     only once\r and uses it repeatedly to play multiple games.\r Some
     old chess engines may not work properly when\r reuse is turned on,
     but otherwise games will start faster if it is left on.\r

-firstProtocolVersion version-number
-secondProtocolVersion version-number
     This option specifies which version of the chess engine
     communication\r protocol to use.  By default, version-number is 2.
     In version 1, the\r "protover" command is not sent to the engine;
     since version 1 is a\r subset of version 2, nothing else changes.
     Other values for\r version-number are not supported.\r

-firstScoreAbs true/false
-secondScoreAbs true/false
     If this option is set, the score reported by the engine is taken
     to be \r that in favor of white, even when the engine plays black.
     \r Important when XBoard uses the score for adjudications, or in
     PGN reporting. \r

-niceEngines priority
     This option allows you to lower the priority of the engine
     processes, \r so that the generally insatiable hunger for CPU time
     of chess engines does not interfere so much \r with smooth
     operation of WinBoard (or the rest of your system). \r Negative
     values could increase the engine priority, which is not
     recommended.\r

-firstOptions string
-secondOptions string
     The given string is a comma-separated list of (option name, option
     value) pairs, \r like the following example: “style=Karpov,blunder
     rate=0”. \r If the options announced by the engine at startup
     through the feature commands of WinBoard protocol \r matches one
     of the option names (i.e. “style” or “blunder rate”), \r it would
     be set to the given value (i.e. “Karpov” or 0) \r through a
     corresponding option command to the engine. \r This provided that
     the type of the value (text or numeric) matches as well.\r
\r

3.2 UCI + WB Engine Settings
============================

-fUCI or -firstIsUCI true/false
-sUCI or -secondIsUCI true/false
     Indicates if the mentioned engine executable file is an UCI
     engine, \r and should be run with the aid of the Polyglot adapter
     rather than directly. \r Xboard will then pass the other UCI
     options and engine name to Polyglot \r through a .ini temporary
     file ceated for the purpose.\r

-PolyglotDir filename
     Gives the name of the directory in which the Polyglot adapter for
     UCI engines expects its files.\r Default:
     "/usr/local/share/polyglot".\r

-usePolyglotBook true/false
     Specifies if the Polygot book should be used.\r

-PolyglotBook filename
     Gives the filename of the opening book that Polyglot should use. \r
     From XBoard 4.3.15 on, native WinBoard engines will also use the
     opening book specified here, \r provided the `usePolyglotBook'
     option is set to true,\r and the option `firstHasOwnBookUCI' or
     `secondHasOwnBookUCI' applying to the engine\r is set to false.\r
     The engine will be kept in force mode as long as the current
     position is in book, \r and XBoard will select the book moves for
     it. Default "".\r

-fNoOwnBookUCI or -firstXBook or -firstHasOwnBookUCI true/false
-sNoOwnBookUCI or -secondXBook or -secondHasOwnBookUCI true/false
     Indicates if the mentioned engine has its own opening book it
     should play from,\r rather than using the external book through
     XBoard. Default: false.\r

-defaultHashSize n
     Sets the size of the hash table to n MegaBytes. Together with the
     EGTB cache size \r this number is also used to calculate the
     memory setting of WinBoard engines, \r for those that support the
     memory feature of WinBoard protocol. Default: 64.\r

-defaultCacheSizeEGTB n
     Sets the size of the EGTB cache to n MegaBytes. Together with the
     hash-table size \r this number is also used to calculate the
     memory setting of WinBoard engines, \r for those that support the
     memory feature of WinBoard protocol. Default: 4.\r

-defaultPathEGTB filename
     Gives the name of the directory where the end-game tablebases are
     installed, for UCI engines.\r Default: "/usr/local/share/egtb".\r

-egtFormats string
     Specifies which end-game tables are installed on the computer, and
     where. \r The argument is a comma-separated list of format
     specifications, \r each specification consisting of a format name,
     a colon, and a directory path name, \r e.g.
     "nalimov:/usr/local/share/egtb". \r If the name part matches that
     of a format that the engine requests through a feature command, \r
     xboard will relay the path name for this format to the engine
     through an egtpath command. \r One egtpath command for each
     matching format will be sent. \r Popular formats are "nalimov" DTM
     tablebases and "scorpio" bitbases.\r Default: "".\r
\r

3.3 ICS options
===============

-ics/-xics or -internetChessServerMode true/false
     Connect with an Internet Chess Server to play chess against its\r
     other users, observe games they are playing, or review games\r
     that have recently finished. Default: false.\r

-icshost or -internetChessServerHost host
     The Internet host name or address of the chess server to connect\r
     to when in ICS mode. Default: `chessclub.com'.\r Another popular
     chess server to try is `freechess.org'.\r If your site doesn't
     have a working Internet name server, try\r specifying the host
     address in numeric form. \r You may also need\r to specify the
     numeric address when using the icshelper option\r with timestamp
     or timeseal (see below).\r

-icsport or -internetChessServerPort port-number
     The port number to use when connecting to a chess server in ICS\r
     mode. Default: 5000.\r

-icshelper or -internetChessServerHelper prog-name
     An external helper program used to communicate with the chess
     server.\r You would set it to "timestamp" for ICC (chessclub.com)
     or\r "timeseal" for FICS (freechess.org), after\r obtaining the
     correct version of timestamp or timeseal for your\r computer.  See
     "help timestamp" on ICC and "help timeseal" on FICS.\r This option
     is shorthand for `-useTelnet -telnetProgram program'.\r

-telnet/-xtelnet or -useTelnet true/false
     This option is poorly named; it should be called useHelper.\r If
     set to true, it instructs XBoard to run an external\r program to
     communicate with the Internet Chess Server. \r The program to use
     is given by the telnetProgram option.\r If the option is\r false
     (the default), XBoard opens a TCP socket and uses its own\r
     internal implementation of the telnet protocol to communicate with
     the\r ICS. *Note Firewalls::.\r

-telnetProgram prog-name
     This option is poorly named; it should be called helperProgram.\r
     It gives the name of the telnet program to be used with\r the
     `gateway' and `useTelnet' options.  The default is\r `telnet'. The
     telnet program is invoked with the value of\r
     `internetChessServerHost' as its first argument and the value\r of
     `internetChessServerPort' as its second argument.\r *Note
     Firewalls::.\r

-gateway host-name
     If this option is set to a host name, XBoard communicates with
     the\r Internet Chess Server by using `rsh' to run\r the
     `telnetProgram' on the given host,\r instead of using its own
     internal implementation\r of the telnet protocol. You can
     substitute a different remote shell\r program for `rsh' using the
     `remoteShell' option described below.\r *Note Firewalls::.\r

-internetChessServerCommPort or -icscomm dev-name
     If this option is set, XBoard communicates with the ICS through\r
     the given character I/O device instead of opening a TCP
     connection.\r Use this option if your system does not have any
     kind of\r Internet connection itself (not even a SLIP or PPP
     connection),\r but you do have dialup access (or a hardwired
     terminal line) to\r an Internet service provider from which you
     can telnet to the ICS.\r \r The support for this option in XBoard
     is minimal. You need to\r set all communication parameters and tty
     modes before you enter\r XBoard.\r \r Use a script something like
     this:\r \r
          stty raw -echo 9600 > /dev/tty00\r
          xboard -ics -icscomm /dev/tty00\r
     \r Here replace `/dev/tty00' with the name of the device that
     your\r modem is connected to. You might have to add several more\r
     options to these stty commands. See the man pages for `stty'\r and
     `tty' if you run into problems. Also, on many systems stty\r works
     on its standard input instead of standard output, so you\r have to
     use `<' instead of `>'.\r \r If you are using linux, try starting
     with the script below.\r Change it as necessary for your
     installation.\r \r
          #!/bin/sh -f\r
          # configure modem and fire up XBoard\r
          \r
          # configure modem\r
          (\r
            stty 2400 ; stty raw ; stty hupcl ; stty -clocal\r
            stty ignbrk ; stty ignpar ; stty ixon ; stty ixoff\r
            stty -iexten ; stty -echo\r
          ) < /dev/modem\r
          xboard -ics -icscomm /dev/modem\r
     After you start XBoard in this way, type whatever commands are\r
     necessary to dial out to your Internet provider and log in.\r Then
     telnet to ICS, using a command like\r `telnet chessclub.com
     5000'.\r Important: See the paragraph below about extra echoes, \r
     in *note Limitations::.\r

-icslogon or -internetChessServerLogonScript file-name
     Whenever XBoard connects to the Internet Chess Server,\r if it
     finds a file with the name given in this option, it feeds the\r
     file's contents to the ICS as commands. The default file name\r is
     `.icsrc'.\r Usually the first two lines of the file should be\r
     your ICS user name and password.\r The file can be either in
     $CHESSDIR, in XBoard's working\r directory if CHESSDIR is not set,
     or in your home directory.\r

-msLoginDelay delay
     If you experience trouble logging on to an ICS when using the\r
     `-icslogon' option, inserting some delay between characters\r of
     the logon script may help. This option adds `delay'\r milliseconds
     of delay between characters. Good values to try\r are 100 and
     250.\r

-icsinput/-xicsinput or -internetChessServerInputBox true/false
     Sets the ICS Input Box menu option. *Note Mode Menu::. Default:
     false.\r

-autocomm/-xautocomm or -autoComment true/false
     Sets the Auto Comment menu option. *Note Options Menu::. Default:
     false.\r

-autoflag/-xautoflag or -autoCallFlag true/false
     Sets the Auto Flag menu option.  *Note Options Menu::. Default:
     false.\r

-autobs/-xautobs or -autoObserve true/false
     Sets the Auto Observe menu option.  *Note Options Menu::. Default:
     false.\r

-autoKibitz
     Enables kibitzing of the engines last thinking output (depth,
     score, time, speed, PV) \r before it moved\r to the ICS, in zippy
     mode. The option `showThinking' must be switched on for \r this
     option to work.\r Also diverts similar kibitz information of an
     opponent engine that is playing you \r through the ICS to the
     engine-output window, as if the engine was playing locally.\r

-moves/-xmoves or -getMoveList true/false
     Sets the Get Move List menu option.  *Note Options Menu::.
     Default: true.\r

-alarm/-xalarm or -icsAlarm true/false
     Sets the ICS Alarm menu option.  *Note Options Menu::. Default:
     true.\r

-icsAlarmTime ms
     Sets the time in milliseconds for the ICS Alarm menu option. \r
     *Note Options Menu::. Default: 5000.\r

-pre/-xpre \fRor\fB -premove true/false
     Sets the Premove menu option. *Note Options Menu::. Default:
     true.\r

-quiet/-xquiet or -quietPlay true/false
     Sets the Quiet Play menu option.  *Note Options Menu::.  Default:
     false.\r

-colorizeMessages or -colorize
     Setting colorizeMessages\r to true tells XBoard to colorize the
     messages received from\r the ICS.  Colorization works only if your
     xterm \r supports ISO 6429 escape sequences for changing text
     colors.\r

-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.\r
     All ICS messages are grouped into one of these categories:\r
     shout, sshout, channel 1, other channel, kibitz, tell, challenge,
     \r request (including abort, adjourn, draw, pause, and takeback),
     or\r normal (all other messages).  \r \r Each foreground or
     background argument can be one of the following:\r black, red,
     green, yellow, blue, magenta, cyan, white, or default.\r Here
     "default" means the default foreground or background color of\r
     your xterm.  Bold can be 1 or 0.  If background is omitted,
     "default"\r is assumed; if bold is omitted, 0 is assumed.\r \r
     Here is an example of how to set the colors in your `.Xresources'
     file.\r The colors shown here are the default values; you will
     get\r them if you turn `-colorize' on without specifying your own
     colors.\r \r
          xboard*colorizeMessages: true \r
          xboard*colorShout: green\r
          xboard*colorSShout: green, black, 1\r
          xboard*colorChannel1: cyan\r
          xboard*colorChannel: cyan, black, 1\r
          xboard*colorKibitz: magenta, black, 1\r
          xboard*colorTell: yellow, black, 1\r
          xboard*colorChallenge: red, black, 1\r
          xboard*colorRequest: red\r
          xboard*colorSeek: blue\r
          xboard*colorNormal: default\r

-soundProgram progname
     If this option is set to a sound-playing program that is installed
     and\r working on your system, XBoard can play sound files when
     certain\r events occur, listed below.  The default program name is
     "play".  If\r any of the sound options is set to "$", the event
     rings the terminal\r bell by sending a ^G character to standard
     output, instead of playing\r a sound file.  If an option is set to
     the empty string "", no sound is\r played for that event.\r

-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\r described above.  They all default to "", no sound.  They
     are played\r only if the colorizeMessages is on.\r

-soundMove filename
     This sound is used by the Move Sound menu option.  Default: "$".\r

-soundIcsAlarm filename
     This sound is used by the ICS Alarm menu option.  Default: "$".\r

-soundIcsWin filename
     This sound is played when you win an ICS game.  Default: "" (no
     sound).\r

-soundIcsLoss filename
     This sound is played when you lose an ICS game.  Default: "" (no
     sound).\r

-soundIcsDraw filename
     This sound is played when you draw an ICS game.  Default: "" (no
     sound).\r

-soundIcsUnfinished filename
     This sound is played when an ICS game that you are participating
     in is\r aborted, adjourned, or otherwise ends inconclusively.
     Default: "" (no\r sound).\r \r Here is an example of how to set
     the sounds in your `.Xresources' file:\r \r
          xboard*soundShout: shout.wav\r
          xboard*soundSShout: sshout.wav\r
          xboard*soundChannel1: channel1.wav\r
          xboard*soundChannel: channel.wav\r
          xboard*soundKibitz: kibitz.wav\r
          xboard*soundTell: tell.wav\r
          xboard*soundChallenge: challenge.wav\r
          xboard*soundRequest: request.wav\r
          xboard*soundSeek: seek.wav\r
          xboard*soundMove: move.wav\r
          xboard*soundIcsWin: win.wav\r
          xboard*soundIcsLoss: lose.wav\r
          xboard*soundIcsDraw: draw.wav\r
          xboard*soundIcsUnfinished: unfinished.wav\r
          xboard*soundIcsAlarm: alarm.wav\r
\r

3.4 Load and Save options
=========================

-lgf or -loadGameFile file
-lgi or -loadGameIndex index
     If the `loadGameFile' option is set, XBoard loads the specified\r
     game file at startup. The file name `-' specifies the standard\r
     input. If there is more than one game in the file, XBoard\r pops
     up a menu of the available games, with entries based on their PGN
     \r (Portable Game Notation) tags.\r If the `loadGameIndex' option
     is set to `N', the menu is suppressed\r and the N th game found in
     the file is loaded immediately.\r The menu is also suppressed if
     `matchMode' is enabled or if the game file\r is a pipe; in these
     cases the first game in the file is loaded immediately.\r Use the
     `pxboard' shell script provided with XBoard if you\r want to pipe
     in files containing multiple games and still see the menu.\r If
     the loadGameIndex specifies an index -1, this triggers
     auto-increment\r of the index in `matchMode', which means that
     after every game the\r index is incremented by one, causing each
     game of the match to be played\r from the next game in the file.
     Similarly, specifying an index value of -2\r causes the index to
     be incremented every two games, so that each game\r in the file is
     used twice (with reversed colors).\r The `rewindIndex' option
     causes the index to be reset to the\r first game of the file when
     it has reached a specified value.\r

-rewindIndex n
     Causes a position file or game file to be rewound to its beginning
     after n\r positions or games in auto-increment `matchMode'. \r See
     `loadPositionIndex' and `loadGameIndex'.\r default: 0 (no
     rewind).\r

-td or -timeDelay seconds
     Time delay between moves during `Load Game'. Fractional seconds\r
     are allowed; try `-td 0.4'. A time delay value of -1 tells\r
     XBoard not to step through game files automatically. Default: 1\r
     second.\r

-sgf or -saveGameFile file
     If this option is set, XBoard appends a record of every game\r
     played to the specified file. The file name `-' specifies the\r
     standard output.\r

-autosave/-xautosave or -autoSaveGames true/false
     Sets the Auto Save menu option.  *Note Options Menu::.  Default:
     false.\r Ignored if `saveGameFile' is set.\r

-lpf or -loadPositionFile file
-lpi or -loadPositionIndex index
     If the `loadPositionFile' option is set, XBoard loads the\r
     specified position file at startup. The file name `-' specifies
     the\r standard input. If the `loadPositionIndex' option is set to
     N,\r the Nth position found in the file is loaded; otherwise the\r
     first position is loaded.\r If the loadPositionIndex specifies an
     index -1, this triggers auto-increment\r of the index in
     `matchMode', which means that after every game the\r index is
     incremented by one, causing each game of the match to be played\r
     from the next position in the file. Similarly, specifying an index
     value of -2\r causes the index to be incremented every two games,
     so that each position\r in the file is used twice (with the
     engines playing opposite colors).\r The `rewindIndex' option
     causes the index to be reset to the\r first position of the file
     when it has reached a specified value.\r

-spf or -savePositionFile file
     If this option is set, XBoard appends the final position reached\r
     in every game played to the specified file. The file name `-'\r
     specifies the standard output.\r

-pgnExtendedInfo true/false
     If this option is set, WinBoard saves depth, score and time used
     for each \r move that the engine found as a comment in the PGN
     file.\r Default: false.\r

-pgnEventHeader string
     Sets the name used in the PGN event tag to string. \r Default:
     "Computer Chess Game".\r

-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.\r

-oldsave/-xoldsave or -oldSaveStyle true/false
     Sets the Old Save Style menu option.  *Note Options Menu::.
     Default: false.\r

-gameListTags string
     The character string lists the PGN tags that should be printed in
     the\r Game List, and their order. The meaning of the codes is
     e=event,\r s=site, d=date, o=round, p=players, r=result, w=white
     Elo, b=black Elo,\r t=time control, v=variant, a=out-of-book
     info.\r Default: "eprd"\r
\r

3.5 User interface options
==========================

-display
-geometry
-iconic
     These and most other standard Xt options are accepted.\r

-noGUI
     Suppresses all GUI functions of XBoard \r (to speed up automated
     ultra-fast engine-engine games, which you don’t want to watch). \r
     There will be no board or clock updates, no printing of moves, \r
     and no update of the icon on the task bar in this mode.\r

-movesound/-xmovesound or -ringBellAfterMoves true/false
     Sets the Move Sound menu option.  *Note Options Menu::.  Default:
     false.\r For compatibility with old XBoard versions, -bell/-xbell
     are also \r accepted as abbreviations for this option.\r

-exit/-xexit or -popupExitMessage true/false
     Sets the Popup Exit Message menu option.  *Note Options Menu::.
     Default: true.\r

-popup/-xpopup or -popupMoveErrors true/false
     Sets the Popup Move Errors menu option.  *Note Options Menu::.
     Default: false.\r

-queen/-xqueen or -alwaysPromoteToQueen true/false
     Sets the Always Queen menu option.  *Note Options Menu::.
     Default: false.\r

-legal/-xlegal or -testLegality true/false
     Sets the Test Legality menu option.  *Note Options Menu::.
     Default: true.\r

-size or -boardSize (sizeName | n1,n2,n3,n4,n5,n6,n7)
     Determines how large the board will be, by selecting the pixel
     size\r of the pieces and setting a few related parameters.\r The
     sizeName can be one of: Titanic, giving 129x129 pixel pieces,\r
     Colossal 116x116, Giant 108x108, Huge 95x95, Big 87x87, Large
     80x80, Bulky 72x72,\r Medium 64x64, Moderate 58x58, Average 54x54,
     Middling 49x49, Mediocre\r 45x45, Small 40x40, Slim 37x37, Petite
     33x33, Dinky 29x29, Teeny 25x25,\r or Tiny 21x21.\r Pieces of all
     these sizes are built into XBoard.\r Other sizes can\r be used if
     you have them; see the pixmapDirectory and bitmapDirectory\r
     options.\r The default depends on the size of your screen; it is
     approximately the\r largest size that will fit without clipping.\r
     \r You can select other sizes or vary other layout parameters by
     providing\r a list of comma-separated values (with no spaces) as
     the argument.\r You do not need to provide all the values; for any
     you omit from the\r end of the list, defaults are taken from the
     nearest built-in size.\r The value `n1' gives the piece size, `n2'
     the width of the\r black border\r between squares, `n3' the
     desired size for the \r clockFont, `n4' the desired size for the
     coordFont,\r `n5' the desired size for the default font,\r `n6'
     the smallLayout flag (0 or 1), \r and `n7' the tinyLayout flag (0
     or 1).  \r All dimensions are in pixels.\r If the border between
     squares is eliminated (0 width), the various\r highlight options
     will not work, as there is nowhere to draw the highlight.\r If
     smallLayout is 1 and `titleInWindow' is true, \r the window layout
     is rearranged to make more room for the title.\r If tinyLayout is
     1, the labels on the menu bar are abbreviated\r to one character
     each and the buttons in the button bar are made narrower.\r

-coords/-xcoords or -showCoords true/false
     Sets the Show Coords menu option.  *Note Options Menu::.  Default:
     false.\r The `coordFont' option specifies what font to use.\r

-autoraise/-xautoraise or -autoRaiseBoard true/false
     Sets the Auto Raise Board menu option.  *Note Options Menu::.
     Default: true.\r

-autoflip/-xautoflip or -autoFlipView true/false
     Sets the Auto Flip View menu option.  *Note Options Menu::.
     Default: true.\r

-flip/-xflip or -flipView true/false
     If Auto Flip View is not set, or if you are observing but not
     participating\r in a game, then the positioning of the board at
     the start of each game\r depends on the flipView option.  If
     flipView is false (the default),\r the board is positioned so that
     the white pawns move from the bottom to the\r top; if true, the
     black pawns move from the bottom to the top.\r In any case, the
     Flip menu option (see *note Options Menu::)\r can be used to flip
     the board after\r the game starts.\r

-title/-xtitle or -titleInWindow true/false
     If this option is true, XBoard displays player names (for ICS\r
     games) and game file names (for `Load Game') inside its main\r
     window. If the option is false (the default), this information is\r
     displayed only in the window banner. You probably won't want to\r
     set this option unless the information is not showing up in the\r
     banner, as happens with a few X window managers.\r

-buttons/-xbuttons or -showButtonBar True/False
     If this option is False, xboard omits the [<<] [<] [P] [>] [>>]
     button\r bar from the window, allowing the message line to be
     wider.  You can\r still get the functions of these buttons using
     the menus or their keyboard\r shortcuts.  Default: true.\r

-mono/-xmono or -monoMode true/false
     Determines whether XBoard displays its pieces and squares with\r
     two colors (true) or four (false). You shouldn't have to\r specify
     `monoMode'; XBoard will determine if it is necessary.\r

-flashCount count
-flashRate rate
-flash/-xflash
     These options enable flashing of pieces when they\r land on their
     destination square.\r `flashCount'\r tells XBoard how many times
     to flash a piece after it\r lands on its destination square.\r
     `flashRate'\r controls the rate of flashing (flashes/sec).\r
     Abbreviations:\r `flash'\r sets flashCount to 3.\r `xflash'\r sets
     flashCount to 0.\r Defaults:  flashCount=0 (no flashing),
     flashRate=5.\r

-highlight/-xhighlight or -highlightLastMove true/false
     Sets the Highlight Last Move menu option. *Note Options Menu::.
     Default: false.\r

-blind/-xblind or -blindfold true/false
     Sets the Blindfold menu option.  *Note Options Menu::.  Default:
     false.\r

-clockFont font
     The font used for the clocks. If the option value is a pattern\r
     that does not specify the font size, XBoard tries to choose an\r
     appropriate font for the board size being used.\r Default:
     -*-helvetica-bold-r-normal-*-*-*-*-*-*-*-*.\r

-coordFont font
     The font used for rank and file coordinate labels if `showCoords'\r
     is true. If the option value is a pattern that does not specify\r
     the font size, XBoard tries to choose an appropriate font for\r
     the board size being used.\r Default:
     -*-helvetica-bold-r-normal-*-*-*-*-*-*-*-*.\r

-font font
     The font used for popup dialogs, menus, comments, etc.\r If the
     option value is a pattern that does not specify\r the font size,
     XBoard tries to choose an appropriate font for\r the board size
     being used.\r Default:
     -*-helvetica-medium-r-normal-*-*-*-*-*-*-*-*.\r

-fontSizeTolerance tol
     In the font selection algorithm, a nonscalable font will be
     preferred\r over a scalable font if the nonscalable font's size
     differs\r by `tol' pixels\r or less from the desired size.  A
     value of -1 will force\r a scalable font to always be used if
     available; a value of 0 will\r use a nonscalable font only if it
     is exactly the right size; \r a large value (say 1000) will force
     a nonscalable font to always be\r used if available.  Default: 4.\r

-bm or -bitmapDirectory dir
-pixmap or -pixmapDirectory dir
     These options control what piece images xboard uses.  The XBoard\r
     distribution includes one set of pixmap pieces in xpm format, in
     the\r directory `pixmaps', and one set of bitmap pieces in xbm
     format,\r in the directory `bitmaps'.  Pixmap\r pieces give a
     better appearance on the screen: the white pieces have\r dark
     borders, and the black pieces have opaque internal details.  With\r
     bitmaps, neither piece color has a border, and the internal
     details\r are transparent; you see the square color or other
     background color\r through them.\r \r If XBoard is configured and
     compiled on a system that includes libXpm,\r the X pixmap library,
     the xpm pixmap pieces are compiled in as the\r default.  A
     different xpm piece set can be selected at runtime with\r the
     `pixmapDirectory' option, or a bitmap piece set can be selected\r
     with the `bitmapDirectory' option.\r \r If XBoard is configured
     and compiled on a system that does not include\r libXpm (or the
     `--disable-xpm' option is given to the configure\r program), the
     bitmap pieces are compiled in as the default.  It is not\r
     possible to use xpm pieces in this case, but pixmap pieces in
     another\r format called "xim" can be used by giving the
     `pixmapDirectory' option.\r Or again, a different bitmap piece set
     can be selected with the\r `bitmapDirectory' option.\r \r Files in
     the `bitmapDirectory' must be named as follows:\r The first
     character of a piece bitmap name gives the piece it \r represents
     (`p', `n', `b', `r', `q', or `k'),\r the next characters give the
     size in pixels, the\r following character indicates whether the
     piece is\r solid or outline (`s' or `o'),\r and the extension is
     `.bm'.\r For example, a solid 80x80 knight would be named
     `n80s.bm'.\r The outline bitmaps are used only in monochrome
     mode.\r If bitmap pieces are compiled in and the bitmapDirectory
     is missing\r some files, the compiled in pieces are used instead.\r
     \r If the bitmapDirectory option is given,\r it is also possible
     to replace xboard's icons and menu checkmark,\r by supplying files
     named `icon_white.bm', `icon_black.bm', and\r `checkmark.bm'.\r \r
     For more information about pixmap pieces and how to get
     additional\r sets, see *note zic2xpm:: below.\r

-whitePieceColor color
-blackPieceColor color
-lightSquareColor color
-darkSquareColor color
-highlightSquareColor color
     Colors to use for the pieces, squares, and square highlights.\r
     Defaults:\r \r
          -whitePieceColor       #FFFFCC\r
          -blackPieceColor       #202020\r
          -lightSquareColor      #C8C365\r
          -darkSquareColor       #77A26D\r
          -highlightSquareColor  #FFFF00\r
          -premoveHighlightColor #FF0000\r
     \r On a grayscale monitor you might prefer:\r \r
          -whitePieceColor       gray100\r
          -blackPieceColor       gray0\r
          -lightSquareColor      gray80\r
          -darkSquareColor       gray60\r
          -highlightSquareColor  gray100\r
          -premoveHighlightColor gray70\r

-drag/-xdrag or -animateDragging true/false
     Sets the Animate Dragging menu option. *Note Options Menu::.
     Default: true.\r

-animate/-xanimate or -animateMoving true/false
     Sets the Animate Moving menu option. *Note Options Menu::.
     Default: true.\r

-animateSpeed n
     Number of milliseconds delay between each animation frame when
     Animate\r Moves is on.\r
\r

3.6 Adjudication Options
========================

-adjudicateLossThreshold n
     If the given value is non-zero, XBoard adjudicates the game as a
     loss \r if both engines agree for a duration of 6 consecutive ply
     that the score \r is below the given score threshold for that
     engine. Make sure the score \r is interpreted properly by XBoard,
     \r using `-firstScoreAbs' and `-secondScoreAbs' if needed. \r
     Default: 0 (no adjudiction)\r

-adjudicateDrawMoves n
     If the given value is non-zero, XBoard adjudicates the game as a
     draw \r if after the given number of moves it was not yet decided.
     Defaut: 0 (no adjudication)\r

-checkMates true/false
     If this option is set, XBoard detects all checkmates and
     stalemates, \r and ends the game as soon as they occur. \r
     Legality-testing must be switched on for this option to work.\r
     Default: true\r

-testClaims true/false
     If this option is set, XBoard verifies all result claims made by
     engines, \r and those who send false claims will forfeit the game
     because of it. \r Legality-testing must be switched on for this
     option to work. Default: true\r

-materialDraws true/false
     If this option is set, XBoard adjudicates games as draws when
     there is \r no sufficient material left to inflict a checkmate. \r
     This applies to KBKB with like bishops (any number, actually), and
     to KBK, KNK and KK. \r Legality-testing must be switched on for
     this option to work. Default: true\r

-trivialDraws true/false
     If this option is set, XBoard adjudicates games as draws that
     cannot be \r usually won without opponent cooperation. This
     applies to KBKB with unlike bishops, \r and to KBKN, KNKN, KNNK,
     KRKR and KQKQ. The draw is called after 6 ply into these
     end-games, \r to allow quick mates that can occur in some
     exceptional positions to be found by the engines. \r KQKQ does not
     really belong in this category, and might be taken out in the
     future. \r (When bitbase-based adjudications are implemented.) \r
     Legality-testing must be on for this option to work. Default:
     false\r

-ruleMoves n
     If the given value is non-zero, XBoard adjudicates the game as a
     draw after the given \r number of consecutive reversible moves.
     Engine draw claims are always accepted after 50 moves, \r
     irrespective of the given value of n.\r

-repeatsToDraw n
     If the given value is non-zero, xboard adjudicates the game as a
     draw if a position \r is repeated the given number of times.
     Engines draw claims are always accepted after 3 repeats, \r (on
     the 3rd occurrence, actually), irrespective of the value of n. \r
     Beware that positions that have different castling or en-passant
     rights do not count \r as repeats, XBoard is fully e.p. and
     castling aware!\r
\r

3.7 Other options
=================

-ncp/-xncp or -noChessProgram true/false
     If this option is true, XBoard acts as a passive chessboard; it\r
     does not start a chess engine at all. Turning on this option\r
     also turns off clockMode. Default: false.\r

-mode or -initialMode modename
     If this option is given, XBoard selects the given modename\r from
     the Mode menu after starting and (if applicable) processing the\r
     loadGameFile or loadPositionFile option. Default: "" (no
     selection). \r Other supported values are \r MachineWhite,
     MachineBlack, TwoMachines, Analysis, \r AnalyzeFile, EditGame,
     EditPosition, and Training.\r

-variant varname
     Activates preliminary, partial support for playing chess variants\r
     against a local engine or editing variant games.  This flag is
     not\r needed in ICS mode.  Recognized variant names are:\r \r
          normal        Normal chess\r
          wildcastle    Shuffle chess, king can castle from d file\r
          nocastle      Shuffle chess, no castling allowed\r
          fischerandom  Fischer Random shuffle chess\r
          bughouse      Bughouse, ICC/FICS rules\r
          crazyhouse    Crazyhouse, ICC/FICS rules\r
          losers        Lose all pieces or get mated (ICC wild 17)\r
          suicide       Lose all pieces including king (FICS)\r
          giveaway      Try to have no legal moves (ICC wild 26)\r
          twokings      Weird ICC wild 9\r
          kriegspiel    Opponent's pieces are invisible\r
          atomic        Capturing piece explodes (ICC wild 27)\r
          3check        Win by giving check 3 times (ICC wild 25)\r
          shatranj      An ancient precursor of chess (ICC wild 28)\r
          xiangqi       Chinese Chess (on a 9x10 board)\r
          shogi         Japanese Chess (on a 9x9 board & piece drops) \r
          capablanca    Capablanca Chess (10x8 board, with Archbishop \r
                        and Chancellor pieces)\r
          gothic        similar, with a better initial position\r
          caparandom    An FRC-like version of Capablanca Chess (10x8) \r
          janus         A game with two Archbishops (10x8 board)\r
          courier       Medieval intermedite between shatranj and \r
                        modern Chess (on 12x8 board) \r
          falcon        Patented 10x8 variant with two Falcon pieces\r
          berolina      Pawns capture straight ahead, and move diagonal \r
          cylinder      Pieces wrap around the board edge\r
          knightmate    King moves as Knight, and vice versa \r
          super         Superchess (shuffle variant with 4 exo-pieces)\r
          fairy         A catchall variant in which all piece types \r
                        known to XBoard can participate (8x8)\r
          unknown       Catchall for other unknown variants\r
     \r In the shuffle variants, XBoard now does shuffle the pieces,
     although\r you can still do it by hand using Edit Position.  Some
     variants are\r supported only in ICS mode, including bughouse,
     and\r kriegspiel.  The winning/drawing conditions in crazyhouse
     (offboard\r interposition on mate), losers, suicide, giveaway,
     atomic, and 3check\r are not fully understood.  \r Berolina and
     cylinder chess can only be played with legality testing off.\r In
     crazyhouse, XBoard now does keep\r track of offboard pieces.  In
     shatranj it does implement the baring\r rule when mate detection
     is switched on.\r

-boardHeight N
     Allows you to set a non-standard number of board ranks in any
     variant. \r If the height is given as -1, the default height for
     the variant is used.\r Default: -1\r

-boardWidth N
     Allows you to set a non-standard number of board files in any
     variant. \r If the width is given as -1, the default width for the
     variant is used. \r With a non-standard width, the initial
     position will always be an empty board, \r as the usual opening
     array will not fit.\r Default: -1\r

-holdingsSize N
     Allows you to set a non-standard size for the holdings in any
     variant. \r If the size is given as -1, the default holdings size
     for the variant is used. \r The first N piece types will go into
     the holdings on capture, and you will be \r able to drop them on
     the board in stead of making a normal move. If size equals 0, \r
     there will be no holdings.\r Default: -1\r

-defaultFrcPosition N
     Specifies the number of the opening position in shuffle games like
     Chess960. \r A value of -1 means the position is randomly
     generated by XBoard\r at the beginning of every game.\r Default:
     -1\r

-pieceToSquareTable string
     The characters that are used to represent the piece types XBoard
     knows in FEN \r diagrams and SAN moves. The string argument has to
     have an even length \r (or it will be ignored), as white and black
     pieces have to be given separately \r (in that order). The last
     letter for each color will be the King. \r The letters before that
     will be PNBRQ and then a whole host of fairy pieces \r in an order
     that has not fully crystallized yet (currently FEACWMOHIJGDVSLU, \r
     F=Ferz, Elephant, A=Archbishop, C=Chancellor, W=Wazir, M=Commoner,
     O=Cannon, \r H=Nightrider). You should list at least all pieces
     that occur in the variant \r you are playing. If you have less
     than 44 characters in the string, the pieces \r not mentioned will
     get assigned a period, and you will not be able to distinguish \r
     them in FENs. You can also explicitly assign pieces a period, in
     which case they \r will not be counted in deciding which captured
     pieces can go into the holdings.\r A tilde '~' as a piece name
     does mean this piece is used to represent a promoted \r Pawn in
     crazyhouse-like games, i.e. on capture it turns back onto a Pawn.
     \r A '+' similarly indicates the piece is a shogi-style promoted
     piece, that should \r revert to its non-promoted version on
     capture (rather than to a Pawn).\r Note that promoted pieces are
     represented by pieces 11 further in the list.\r You should not
     have to use this option often: each variant has its own default \r
     setting for the piece representation in FEN, which should be
     sufficient in normal use.\r Default: ""\r

-debug/-xdebug or -debugMode true/false
     Turns on debugging printout.\r

-debugFile filename or -nameOfDebugFile filename
     Sets the name of the file to which WinBoard saves debug
     information \r (including all communication to and from the
     engines).\r

-engineDebugOutput number
     Specifies how WinBoard should handle unsolicited output from the
     engine, \r with respect to saving it in the debug file. \r The
     output is further (hopefully) ignored. \r If number=0, WinBoard
     refrains from writing such spurious output to the debug file. \r
     If number=1, all engine output is written faithfully to the debug
     file. \r If number=2, any protocol-violating line is prefixed with
     a ‘#’ character, \r as the engine itself should have done if it
     wanted to submit info for inclusion in the debug file.\r This
     option is provided for the benefit of applications that use the
     debug file \r as a source of information, such as the broadcaster
     of live games TLCV / TLCS. \r Such applications can be protected
     from spurious engine output that might otherwise confuse them.\r

-rsh or -remoteShell shell-name
     Name of the command used to run programs remotely. The default\r
     is `rsh' or `remsh', determined when XBoard is\r configured and
     compiled.\r

-ruser or -remoteUser user-name
     User name on the remote system when running programs with the\r
     `remoteShell'. The default is your local user name.\r

-userName username
     Name under which the Human player will be listed in the PGN file.
     \r Default is the login name on your local computer.\r

-delayBeforeQuit number
-delayAfterQuit number
     These options specify how long WinBoard 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.\r \r
\r

4 Chess Servers
***************

An "Internet Chess Server", or "ICS", is a place on the\r Internet
where people can get together to play chess, watch other\r people's
games, or just chat.  You can use either `telnet' or a\r client program
like XBoard to connect to the server.  There are\r thousands of
registered users on the different ICS hosts, and it is\r not unusual to
meet 200 on both chessclub.com and freechess.org.\r \r Most people can
just type `xboard -ics' to start XBoard as an ICS\r client.  Invoking
XBoard in this way connects you to the Internet\r Chess Club (ICC), a
commercial ICS.  You can log in there as a guest\r even if you do not
have a paid account.  To connect to the largest\r Free ICS (FICS), use
the command `xboard -ics -icshost freechess.org'\r instead, or
substitute a different host name to connect to your\r favorite ICS.\r
For a full description of command-line options that control \r the
connection to ICS and change the default values of ICS options, see\r
*note ICS options::.  \r \r While you are running XBoard as an ICS
client,\r you use the terminal window that you started XBoard from\r as
a place to type in commands and read information that is\r not
available on the chessboard.\r \r The first time you need to use the
terminal is to enter your login name\r and password, if you are a
registered player. (You don't need to do\r this manually; the
`icsLogon' option can do it for you.\r *note ICS options::.)  If you
are not registered, \r enter `g' as your name, and the server will pick
a\r unique guest name for you.\r \r Some useful ICS commands\r include\r
`help <topic>'
     to get help on the given <topic>. To get a list of possible topics
     type\r "help" without topic.  Try the help command before you ask
     other\r people on the server for help.\r \r For example `help
     register' tells you how to become a registered\r ICS player.\r

`who <flags>'
     to see a list of people who are logged on.  Administrators\r
     (people you should talk to if you have a problem) are marked\r
     with the character `*', an asterisk. The <flags> allow you to\r
     display only selected players: For example, `who of' shows a\r
     list of players who are interested in playing but do not have\r an
     opponent.\r

`games'
     to see what games are being played\r

`match <player> [<mins>] [<inc>]'
     to challenge another player to a game. Both opponents get <mins>
     minutes\r for the game, and <inc> seconds will be added after each
     move.\r If another player challenges you, the server asks if you
     want to\r accept the challenge; use the `accept' or `decline'
     commands\r to answer.\r

`accept'
`decline'
     to accept or decline another player's offer. \r The offer may be
     to start a new game, or to agree to a \r `draw', `adjourn' or
     `abort' the current game. *Note Action Menu::.\r \r If you have
     more than one pending offer (for example, if more than one player\r
     is challenging you, or if your opponent offers both a draw and to
     adjourn the\r game), you have to supply additional information, by
     typing something\r like `accept <player>', `accept draw', or
     `draw'.\r

`draw'
`adjourn'
`abort'
     asks your opponent to terminate a game by mutual agreement.
     Adjourned\r games can be continued later. \r Your opponent can
     either `decline' your offer or accept it (by typing the\r same
     command or typing `accept').  In some cases these commands work\r
     immediately, without asking your opponent to agree.  For example,
     you can\r abort the game unilaterally if your opponent is out of
     time, and you can claim\r a draw by repetition or the 50-move rule
     if available simply by typing \r `draw'.\r

`finger <player>'
     to get information about the given <player>. (Default: yourself.)\r

`vars'
     to get a list of personal settings\r

`set <var> <value>'
     to modify these settings\r

`observe <player>'
     to observe an ongoing game of the given <player>.\r

`examine'
`oldmoves'
     to review a recently completed game\r
   \r Some special XBoard features are activated when you are\r in
examine mode on ICS.  See the descriptions of the menu commands\r
`Forward', `Backward', `Pause', `ICS Client', \r and `Stop Examining'
on the *note Step Menu::, *note Mode Menu::, and\r *note Options
Menu::.\r \r

5 Firewalls
***********

By default, XBoard communicates with an Internet Chess Server\r by
opening a TCP socket directly from the machine it is running on\r to
the ICS. If there is a firewall between your machine and the ICS,\r
this won't work. Here are some recipes for getting around common\r
kinds of firewalls using special options to XBoard.\r Important: See
the paragraph in the below about extra echoes, in\r *note
Limitations::.\r \r Suppose that you can't telnet directly to ICS, but
you can telnet\r to a firewall host, log in, and then telnet from there
to ICS.\r Let's say the firewall is called `firewall.example.com'. Set\r
command-line options as follows:\r \r
     xboard -ics -icshost firewall.example.com -icsport 23\r
   Or in your `.Xresources' file:\r \r
     XBoard*internetChessServerHost: firewall.example.com\r
     XBoard*internetChessServerPort: 23\r
   Then when you run XBoard in ICS mode, you will be prompted\r to log
in to the firewall host. This works because port 23 is the\r standard
telnet login service. Do so, then telnet to ICS, using a\r command like
`telnet chessclub.com 5000', or whatever command\r the firewall
provides for telnetting to port 5000.\r \r If your firewall lets you
telnet (or rlogin) to remote hosts but\r doesn't let you telnet to port
5000, you may be able to connect to the\r chess server on port 23
instead, which is the port the telnet program\r uses by default.  Some
chess servers support this (including\r chessclub.com and
freechess.org), while some do not.\r \r If your chess server does not
allow connections on port 23 and your\r firewall does not allow you to
connect to other ports, you may be able\r to connect by hopping through
another host outside the firewall that\r you have an account on.  For
instance, suppose you have a shell\r account at `foo.edu'. Follow the
recipe above, but instead of\r typing `telnet chessclub.com 5000' to
the firewall, type\r `telnet foo.edu' (or `rlogin foo.edu'), log in
there, and\r then type `telnet chessclub.com 5000'.\r \r Suppose that
you can't telnet directly to ICS, but you can use rsh\r to run programs
on a firewall host, and that host can telnet to ICS.\r Let's say the
firewall is called `rsh.example.com'. Set\r command-line options as
follows:\r \r
     xboard -ics -gateway rsh.example.com -icshost chessclub.com\r
   \r Or in your `.Xresources' file:\r \r
     XBoard*gateway: rsh.example.com\r
     XBoard*internetChessServerHost: chessclub.com\r
   \r Then when you run XBoard in ICS mode, it will connect to\r the
ICS by using `rsh' to run the command\r `telnet chessclub.com 5000' on
host `rsh.example.com'.\r \r Suppose that you can telnet anywhere you
want, but you have to\r run a special program called `ptelnet' to do
so.\r \r First, we'll consider the easy case, in which\r `ptelnet
chessclub.com 5000' gets you to the chess server.\r In this case set
command line options as follows:\r \r
     xboard -ics -telnet -telnetProgram ptelnet\r
   \r Or in your `.Xresources' file:\r \r
     XBoard*useTelnet: true\r
     XBoard*telnetProgram: ptelnet\r
   \r Then when you run XBoard in ICS mode, it will issue the\r command
`ptelnet chessclub.com 5000' to connect to the ICS.\r \r Next, suppose
that `ptelnet chessclub.com 5000' doesn't work;\r that is, your
`ptelnet' program doesn't let you connect to\r alternative ports. As
noted above, your chess server may allow you to\r connect on port 23
instead.  In that case, just add the option\r `-icsport ""' to the
above command, or add\r `XBoard*internetChessServerPort:' to your
`.Xresources' file.\r But if your chess server doesn't let you connect
on port 23, you will have\r to find some other host outside the
firewall and hop through it. For\r instance, suppose you have a shell
account at `foo.edu'. Set\r command line options as follows:\r \r
     xboard -ics -telnet -telnetProgram ptelnet -icshost foo.edu -icsport ""\r
   \r Or in your `.Xresources' file:\r \r
     XBoard*useTelnet: true\r
     XBoard*telnetProgram: ptelnet\r
     XBoard*internetChessServerHost: foo.edu\r
     XBoard*internetChessServerPort:\r
   \r Then when you run XBoard in ICS mode, it will issue the\r command
`ptelnet foo.edu' to connect to your account at\r `foo.edu'. Log in
there, then type `telnet chessclub.com 5000'.\r \r ICC timestamp and
FICS timeseal do not work through some\r firewalls.  You can use them
only if your firewall gives a clean TCP\r connection with a full 8-bit
wide path.  If your firewall allows you\r to get out only by running a
special telnet program, you can't use\r timestamp or timeseal across
it.  But if you have access to a\r computer just outside your firewall,
and you have much lower netlag\r when talking to that computer than to
the ICS, it might be worthwhile\r running timestamp there.  Follow the
instructions above for hopping\r through a host outside the firewall
(foo.edu in the example),\r but run timestamp or timeseal on that host
instead of telnet.\r \r Suppose that you have a SOCKS firewall that
will give you a clean\r 8-bit wide TCP connection to the chess server,
but only after you\r authenticate yourself via the SOCKS protocol.  In
that case, you could\r make a socksified version of XBoard and run
that.  If you are using\r timestamp or timeseal, you will to socksify
it, not XBoard; this may\r be difficult seeing that ICC and FICS do not
provide source code for\r these programs.  Socksification is beyond the
scope of this document,\r but see the SOCKS Web site at
http://www.socks.permeo.com/.\r If you are missing SOCKS, try
http://www.funbureau.com/.\r \r

6 Environment variables
***********************

Game and position files are found in a directory named by the\r
`CHESSDIR' environment variable. If this variable is not set, the\r
current working directory is used. If `CHESSDIR' is set,\r XBoard
actually changes its working directory to\r `$CHESSDIR', so any files
written by the chess engine\r will be placed there too.\r \r

7 Limitations and known bugs
****************************

There is no way for two people running copies of XBoard to play\r each
other without going through an Internet Chess Server.\r \r Under some
circumstances, your ICS password may be echoed when you log on.\r \r If
you are connecting to the ICS by running telnet on an Internet\r
provider or firewall host, you may find that each line you type is\r
echoed back an extra time after you hit <Enter>. If your Internet\r
provider is a Unix system, you can probably turn its echo off by\r
typing `stty -echo' after you log in, and/or typing\r <^E><Enter>
(Ctrl+E followed by the Enter key) to the telnet\r program after you
have logged into ICS.  It is a good idea to do this\r if you can,
because the extra echo can occasionally confuse XBoard's\r parsing
routines.\r \r The game parser recognizes only algebraic notation.\r \r
Many of the following points used to be limitations in XBoard 4.2.7 and
earlier, \r but are now fixed:\r The internal move legality tester in
XBoard 4.3.xx does look at the game history, \r and is fully aware of
castling or en-passant-capture rights. It permits castling with \r the
king on the d file because this is possible in some "wild 1" games on
ICS. \r The piece-drop menu does not check piece drops in bughouse to
see if you actually hold \r the piece you are trying to drop. But this
way of dropping pieces should be considered \r an obsolete feature, now
that pieces can be dropped by dragging them from the holdings \r to the
board. Anyway, if you would attempt an illegal move when using a chess
engine or the ICS, \r WinBoard will accept the error message that comes
back, undo the move, and let you try another.\r FEN positions saved by
XBoard do include correct information about whether castling or \r en
passant are legal, and also handle the 50-move counter.\r The mate
detector does not understand that non-contact mate is not really mate
in bughouse. \r The only problem this causes while playing is minor: a
"#" (mate indicator) character will \r show up after a non-contact
mating move in the move list. XBoard will not assume the game \r is
over at that point, not even when the option Detect Mates is on.\r Edit
Game mode always uses the rules of the selected variant, \r which can
be a variant that uses piece drops.  \r You can load and edit games
that contain piece drops. \r The (obsolete) piece menus are not active,
\r but you can perform piece drops by dragging pieces from the
holdings.\r Edit Position mode does not allow you to edit the
crazyhouse holdings properly. \r You cannot drag pieces to the holding,
and using the popup menu to put pieces \r there does not adapt the
holding counts and leads to an inconsistent state. \r Set up crazyhouse
positions by loading / pasting a bFEN, from there you can set the
holdings.\r Fischer Random castling is fully understood. \r You can
enter castlings by dragging the King on top of your Rook. \r You can
probably also play Fischer Random successfully on ICS by typing \r
castling moves into the ICS Interaction window.\r \r The menus may not
work if your keyboard is in Caps Lock or Num Lock mode.\r This seems to
be a problem with the Athena menu widget,\r not an XBoard bug.\r \r
Also see the ToDo file included with the distribution for many other\r
possible bugs, limitations, and ideas for improvement that have been\r
suggested.\r

8 Reporting problems
********************

\r Report bugs and problems with XBoard to `<bug-xboard@gnu.org>'.\r \r
Please use the `script' program to start a typescript, run \r XBoard
with the `-debug' option, and include the typescript\r output in your
message.\r Also tell us what kind of machine and what operating system
version\r you are using.  The command `uname -a' will often tell you
this.\r Here is a sample of approximately what you should type:\r \r
     script\r
     uname -a\r
     ./configure\r
     make\r
     ./xboard -debug\r
     exit\r
     mail bug-xboard@gnu.org\r
     Subject: Your short description of the problem\r
     Your detailed description of the problem\r
     ~r typescript\r
     .\r
   \r The WinBoard / XBoard 4.3 line is being developed by H.G. Muller
\r independently of the GNU Savannah xboard project. \r Bug reports on
this version, and suggestions for improvements and additions, \r are
best posted in the WinBoard forum, \r WinBoard-development section
(http://www.open-aurec.com/wbforum). \r \r If you improve XBoard,
please send a message about your changes,\r and we will get in touch
with you about merging them in\r to the main line of development.\r
Also see our Web site at http://savannah.gnu.org/projects/xboard/.\r \r

9 Authors and contributors
**************************

\r Tim Mann has been responsible for XBoard versions 1.3 and beyond,
and\r for WinBoard, a port of XBoard to Microsoft Win32 (Windows NT
and\r Windows 95). H.G.Muller is responsible for version 4.3.\r \r Mark
Williams contributed the initial (WinBoard-only) implementation\r of
many new features added to both XBoard and WinBoard in version\r 4.1.0,
including copy/paste, premove, icsAlarm, autoFlipView, training\r mode,
auto raise, and blindfold.  Ben Nye contributed X copy/paste\r code for
XBoard.\r \r Hugh Fisher added animated piece movement to XBoard, and
Henrik Gram\r (henrikg@funcom.com) added it to WinBoard.  Frank
McIngvale added\r click/click moving, the Analysis modes, piece
flashing, ZIICS import,\r and ICS text colorization to XBoard.  Jochen
Wiedmann ported XBoard to\r the Amiga, creating AmyBoard, and converted
the documentation to\r texinfo.  Elmar Bartel contributed the new piece
bitmaps introduced in\r version 3.2.  John Chanak contributed the
initial implementation of\r ICS mode.  The color scheme and the old
80x80 piece bitmaps were taken\r from Wayne Christopher's `XChess'
program.\r \r Chris Sears and Dan Sears wrote the original XBoard.
They were\r responsible for versions 1.0 through 1.2.\r \r Evan Welsh
wrote `CMail'.  Patrick Surry helped in designing,\r testing, and
documenting CMail.\r \r Allessandro Scotti added many elements to the
user interface of WinBoard, \r including the board textures and
font-based rendering, the evaluation-graph, \r move-history and
engine-output window. \r He was also responsible for adding the UCI
support. \r \r H.G. Muller made WinBoard castling- and e.p.-aware, \r
added variant support with adjustable board sizes, \r the crazyhouse
holdings, and the fairy pieces. \r In addition he added most of the
adjudication options, \r made WinBoard more robust in dealing with
buggy and crashing engines, \r and extended time control with a
time-odds and node-count-based modes.\r Most of the options that
initially wre WinBoard only have now been back-ported to XBoard.\r \r
Michel van den Bergh provided the code for reading Polyglot opening
books.\r \r Arun Persaud worked with H.G. Muller to combine all the
features of the never-released WinBoard 4.2.8 \r of the Savannah
project (mainly by Daniel Mehrmann), \r and the never-released 4.3.16
into a unified WinBoard 4.4, \r which is now available both from the
Savannah web site and the WinBoard forum.\r

10 CMail
********

The `cmail' program can help you play chess by email with opponents of\r
your choice using XBoard as an interface.\r \r You will usually run
`cmail' without giving any options.\r \r \r

10.1 CMail options
==================

-h
     Displays `cmail' usage information.\r

-c
     Shows the conditions of the GNU General Public License.\r *Note
     Copying::.\r

-w
     Shows the warranty notice of the GNU General Public License.\r
     *Note Copying::.\r

-v
-xv
     Provides or inhibits verbose output from `cmail' and XBoard,\r
     useful for debugging. The\r `-xv'\r form also inhibits the cmail
     introduction message.\r

-mail
-xmail
     Invokes or inhibits the sending of a mail message containing the
     move.\r

-xboard
-xxboard
     Invokes or inhibits the running of XBoard on the game file.\r

-reuse
-xreuse
     Invokes or inhibits the reuse of an existing XBoard to display
     the\r current game.\r

-remail
     Resends the last mail message for that game. This inhibits
     running\r XBoard.\r

-game <name>
     The name of the game to be processed.\r

-wgames <number>
-bgames <number>
-games <number>
     Number of games to start as White, as Black or in total. Default
     is 1 as\r white and none as black. If only one color is specified
     then none of the\r other color is assumed. If no color is
     specified then equal numbers of\r White and Black games are
     started, with the extra game being as White if an\r odd number of
     total games is specified.\r

-me <short name>
-opp <short name>
     A one-word alias for yourself or your opponent.\r

-wname <full name>
-bname <full name>
-name <full name>
-oppname <full name>
     The full name of White, Black, yourself or your opponent.\r

-wna <net address>
-bna <net address>
-na <net address>
-oppna <net address>
     The email address of White, Black, yourself or your opponent.\r

-dir <directory>
     The directory in which `cmail' keeps its files. This defaults to
     the\r environment variable `$CMAIL_DIR' or failing that,
     `$CHESSDIR',\r `$HOME/Chess' or `~/Chess'. It will be created if
     it does not exist.\r

-arcdir <directory>
     The directory in which `cmail' archives completed games. Defaults
     to\r the environment variable `$CMAIL_ARCDIR' or, in its absence,
     the same\r directory as cmail keeps its working files (above).\r

-mailprog <mail program>
     The program used by cmail to send email messages. This defaults to
     the\r environment variable `$CMAIL_MAILPROG' or failing that\r
     `/usr/ucb/Mail', `/usr/ucb/mail' or `Mail'. You will need\r to set
     this variable if none of the above paths fit your system.\r

-gamesFile <file>
     A file containing a list of games with email addresses. This
     defaults to\r the environment variable `$CMAIL_GAMES' or failing
     that\r `.cmailgames'.\r

-aliasesFile <file>
     A file containing one or more aliases for a set of email
     addresses. This\r defaults to the environment variable
     `$CMAIL_ALIASES' or failing\r that `.cmailaliases'.\r

-logFile <file>
     A file in which to dump verbose debugging messages that are
     invoked with\r the `-v'\r option.\r

-event <event>
     The PGN Event tag (default `Email correspondence game').\r

-site <site>
     The PGN Site tag (default `NET').\r

-round <round>
     The PGN Round tag (default `-', not applicable).\r

-mode <mode>
     The PGN Mode tag (default `EM', Electronic Mail).\r

Other options
     Any option flags not listed above are passed through to XBoard.\r
     Invoking XBoard through CMail changes the default values of two
     XBoard\r options: The default value for `-noChessProgram' is
     changed to\r true; that is, by default no chess engine is started.
     The default\r value for `-timeDelay' is changed to 0; that is, by
     default\r XBoard immediately goes to the end of the game as played
     so far,\r rather than stepping through the moves one by one.  You
     can still set\r these options to whatever values you prefer by
     supplying them on\r CMail's command line.  *Note Options::.\r
\r

10.2 Starting a CMail Game
==========================

Type `cmail' from a shell to start a game as white. After an opening\r
message, you will be prompted for a game name, which is optional--if
you\r simply press <Enter>, the game name will take the form\r
`you-VS-opponent'. You will next be prompted for the short name\r of
your opponent. If you haven't played this person before, you will also\r
be prompted for his/her email address. `cmail' will then invoke\r
XBoard in the background. Make your first move and select\r `Mail Move'
from the `File' menu. *Note File Menu::. If all is well,\r `cmail' will
mail a copy of the move to your opponent. If you select\r `Exit'
without having selected `Mail Move' then no move will be\r made.\r \r

10.3 Answering a Move
=====================

When you receive a message from an opponent containing a move in one
of\r your games, simply pipe the message through `cmail'. In some
mailers\r this is as simple as typing `| cmail' when viewing the
message, while in\r others you may have to save the message to a file
and do `cmail < file'\r at the command line. In either case `cmail'
will display the game using\r XBoard. If you didn't exit XBoard when
you made your first move\r then `cmail' will do its best to use the
existing XBoard instead\r of starting a new one. As before, simply make
a move and select\r `Mail Move' from the `File' menu. *Note File
Menu::. `cmail'\r will try to use the\r XBoard that was most recently
used to display the current game. This\r means that many games can be
in progress simultaneously, each with its own\r active XBoard.\r \r If
you want to look at the history or explore a variation, go ahead, but\r
you must return to the current position before XBoard will allow you\r
to mail a move. If you edit the game's history you must select\r
`Reload Same Game' from the `File' menu to get back to the original\r
position, then make the move you want and select `Mail Move'.\r As
before, if you decide you aren't ready to make a move just yet you can\r
either select `Exit' without sending a move or just leave\r XBoard
running until you are ready.\r \r

10.4 Multi-Game Messages
========================

\r It is possible to have a `cmail' message carry more than one game.\r
This feature was implemented to handle IECG (International Email Chess\r
Group) matches, where a match consists of one game as white and one as
black,\r with moves transmitted simultaneously. In case there are more
general uses,\r `cmail' itself places no limit on the number of
black/white games\r contained in a message; however, XBoard does.\r \r

10.5 Completing a Game
======================

Because XBoard can detect checkmate and stalemate, `cmail'\r handles
game termination sensibly. As well as resignation, the\r `Action' menu
allows draws to be offered and accepted for\r `cmail' games.\r \r For
multi-game messages, only unfinished and just-finished games will be\r
included in email messages. When all the games are finished, they are\r
archived in the user's archive directory, and similarly in the
opponent's\r when he or she pipes the final message through `cmail'.
The archive\r file name includes the date the game was started.\r \r

10.6 Known CMail Problems
=========================

It's possible that a strange conjunction of conditions may
occasionally\r mean that `cmail' has trouble reactivating an existing\r
XBoard. If this should happen, simply trying it again should work.\r If
not, remove the file that stores the XBoard's PID\r (`game.pid') or use
the `-xreuse' option to force\r `cmail' to start a new XBoard.\r \r
Versions of `cmail' after 2.16 no longer understand the old file
format\r that XBoard used to use and so cannot be used to correspond
with\r anyone using an older version.\r \r Versions of `cmail' older
than 2.11 do not handle multi-game messages,\r so multi-game
correspondence is not possible with opponents using an older\r
version.\r \r

11 Other programs you can use with XBoard
*****************************************

\r Here are some other programs you can use with XBoard\r \r \r

11.1 GNU Chess
==============

\r The GNU Chess engine is available from:\r \r
ftp://ftp.gnu.org/gnu/gnuchess/\r \r You can use XBoard to play a game
against GNU Chess, or to\r interface GNU Chess to an ICS.\r \r

11.2 Fairy-Max
==============

\r Fairy-Max is a derivative from the World's smallest Chess program
micro-Max,\r which measures only about 100 lines of source code.\r The
main difference with micro-Max is that Fairy-Max loads its
move-generator\r tables from a file, so that the rules for piece
movement can be easily configured\r to implement unorthodox pieces.\r
Fairy-Max can therefore play a lage number of variants, normal Chess
being one of those.\r In addition it plas Knightmate, Capablanca and
Gothic Chess, Shatranj, Courier Chess,\r Cylinder chess, Berolina
Chess, while the user can easily define new variants.\r It can be
obtained from:\r \r http://home.hccnet.nl/h.g.muller/dwnldpage.html\r \r

11.3 HoiChess
=============

\r HoiChess is a not-so-very-strong Chess engine, which comes with a
derivative HoiXiangqi,\r able to play Chinese Chess. It can be obtained
from the standard Linux repositories\r through:\r \r sudo apt-get
install hoichess\r \r

11.4 Crafty
===========

\r Crafty is a chess engine written by Bob Hyatt.\r You can use XBoard
to play a game against Crafty, hook Crafty up\r to an ICS, or use
Crafty to interactively analyze games and positions\r for you.\r \r
Crafty is a strong, rapidly evolving chess program. This rapid\r pace
of development is good, because it means Crafty is always\r getting
better.  This can sometimes cause problems with\r backwards
compatibility, but usually the latest version of Crafty\r will work
well with the latest version of XBoard.\r Crafty can be obtained from
its author's FTP site:\r ftp://ftp.cis.uab.edu/hyatt/.\r \r To use
Crafty with XBoard, give the -fcp and -fd options as follows, where\r
<crafty's directory> is the directory in which you installed Crafty\r
and placed its book and other support files.\r \r

11.5 zic2xpm
============

\r The "zic2xpm" program is used to import chess sets from the
ZIICS(*)\r program into XBoard. "zic2xpm" is part of the XBoard
distribution.\r ZIICS is available from:\r \r
ftp://ftp.freechess.org/pub/chess/DOS/ziics131.exe\r \r To import ZIICS
pieces, do this:\r
1. Unzip ziics131.exe into a directory:
     \r
          unzip -L ziics131.exe -d ~/ziics\r

2. Use zic2xpm to convert a set of pieces to XBoard format.
     \r For example, let's say you want to use the\r FRITZ4 set. These
     files are named "fritz4.*" in the ZIICS distribution.\r \r
          mkdir ~/fritz4\r
          cd ~/fritz4\r
          zic2xpm ~/ziics/fritz4.*\r

3. Give XBoard the "-pixmap" option when starting up, e.g.:
     \r
          xboard -pixmap ~/fritz4\r
     \r Alternatively, you can add this line to your `.Xresources'
     file:\r \r
          xboard*pixmapDirectory: ~/fritz4\r
\r (*) ZIICS is a separate copyrighted work of Andy McFarland.\r The
"ZIICS pieces" are copyrighted works of their respective\r creators.
Files produced by "zic2xpm" are for PERSONAL USE ONLY\r and may NOT be
redistributed without explicit permission from\r the original
creator(s) of the pieces.\r \r

Copyright
*********

Copyright (C) 1991 Digital Equipment Corporation, Maynard,
Massachusetts.

   All Rights Reserved.

   Permission to use, copy, modify, and distribute this software and its
documentation for any purpose and without fee is hereby granted,
provided that the above copyright notice appear in all copies and that
both that copyright notice and this permission notice appear in
supporting documentation, and that the name of Digital not be used in
advertising or publicity pertaining to distribution of the software
without specific, written prior permission.

   Digital disclaims all warranties with regard to this software,
including all implied warranties of merchantability and fitness.  In no
event shall Digital be liable for any special, indirect or
consequential damages or any damages whatsoever resulting from loss of
use, data or profits, whether in an action of contract, negligence or
other tortious action, arising out of or in connection with the use or
performance of this software.

   Enhancements copyright (C) 1992-2003,2004,2005,2006,2007,2008,2009
Free Software Foundation, Inc.

Published by the Free Software Foundation
59 Temple Place - Suite 330
Boston, MA 02111-1307 USA

   Permission is granted to make and distribute verbatim copies of this
manual provided the copyright notice and this permission notice are
preserved on all copies.

   Permission is granted to copy and distribute modified versions of
this manual under the conditions for verbatim copying, provided also
that the section entitled "GNU General Public License," is included
exactly as in the original, and provided that the entire resulting
derived work is distributed under the terms of a permission notice
identical to this one.

   Permission is granted to copy and distribute translations of this
manual into another language, under the above conditions for modified
versions, except that the section entitled "GNU General Public License,"
and this permission notice, may be included in translations approved by
the Free Software Foundation instead of in the original English.  \r

GNU GENERAL PUBLIC LICENSE
**************************

                        Version 3, 29 June 2007

     Copyright (C) 2007 Free Software Foundation, Inc. `http://fsf.org/'

     Everyone is permitted to copy and distribute verbatim copies of this
     license document, but changing it is not allowed.

Preamble
========

The GNU General Public License is a free, copyleft license for software
and other kinds of works.

   The licenses for most software and other practical works are designed
to take away your freedom to share and change the works.  By contrast,
the GNU General Public License is intended to guarantee your freedom to
share and change all versions of a program--to make sure it remains
free software for all its users.  We, the Free Software Foundation, use
the GNU General Public License for most of our software; it applies
also to any other work released this way by its authors.  You can apply
it to your programs, too.

   When we speak of free software, we are referring to freedom, not
price.  Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.

   To protect your rights, we need to prevent others from denying you
these rights or asking you to surrender the rights.  Therefore, you
have certain responsibilities if you distribute copies of the software,
or if you modify it: responsibilities to respect the freedom of others.

   For example, if you distribute copies of such a program, whether
gratis or for a fee, you must pass on to the recipients the same
freedoms that you received.  You must make sure that they, too, receive
or can get the source code.  And you must show them these terms so they
know their rights.

   Developers that use the GNU GPL protect your rights with two steps:
(1) assert copyright on the software, and (2) offer you this License
giving you legal permission to copy, distribute and/or modify it.

   For the developers' and authors' protection, the GPL clearly explains
that there is no warranty for this free software.  For both users' and
authors' sake, the GPL requires that modified versions be marked as
changed, so that their problems will not be attributed erroneously to
authors of previous versions.

   Some devices are designed to deny users access to install or run
modified versions of the software inside them, although the
manufacturer can do so.  This is fundamentally incompatible with the
aim of protecting users' freedom to change the software.  The
systematic pattern of such abuse occurs in the area of products for
individuals to use, which is precisely where it is most unacceptable.
Therefore, we have designed this version of the GPL to prohibit the
practice for those products.  If such problems arise substantially in
other domains, we stand ready to extend this provision to those domains
in future versions of the GPL, as needed to protect the freedom of
users.

   Finally, every program is threatened constantly by software patents.
States should not allow patents to restrict development and use of
software on general-purpose computers, but in those that do, we wish to
avoid the special danger that patents applied to a free program could
make it effectively proprietary.  To prevent this, the GPL assures that
patents cannot be used to render the program non-free.

   The precise terms and conditions for copying, distribution and
modification follow.

TERMS AND CONDITIONS
====================

  0. Definitions.

     "This License" refers to version 3 of the GNU General Public
     License.

     "Copyright" also means copyright-like laws that apply to other
     kinds of works, such as semiconductor masks.

     "The Program" refers to any copyrightable work licensed under this
     License.  Each licensee is addressed as "you".  "Licensees" and
     "recipients" may be individuals or organizations.

     To "modify" a work means to copy from or adapt all or part of the
     work in a fashion requiring copyright permission, other than the
     making of an exact copy.  The resulting work is called a "modified
     version" of the earlier work or a work "based on" the earlier work.

     A "covered work" means either the unmodified Program or a work
     based on the Program.

     To "propagate" a work means to do anything with it that, without
     permission, would make you directly or secondarily liable for
     infringement under applicable copyright law, except executing it
     on a computer or modifying a private copy.  Propagation includes
     copying, distribution (with or without modification), making
     available to the public, and in some countries other activities as
     well.

     To "convey" a work means any kind of propagation that enables other
     parties to make or receive copies.  Mere interaction with a user
     through a computer network, with no transfer of a copy, is not
     conveying.

     An interactive user interface displays "Appropriate Legal Notices"
     to the extent that it includes a convenient and prominently visible
     feature that (1) displays an appropriate copyright notice, and (2)
     tells the user that there is no warranty for the work (except to
     the extent that warranties are provided), that licensees may
     convey the work under this License, and how to view a copy of this
     License.  If the interface presents a list of user commands or
     options, such as a menu, a prominent item in the list meets this
     criterion.

  1. Source Code.

     The "source code" for a work means the preferred form of the work
     for making modifications to it.  "Object code" means any
     non-source form of a work.

     A "Standard Interface" means an interface that either is an
     official standard defined by a recognized standards body, or, in
     the case of interfaces specified for a particular programming
     language, one that is widely used among developers working in that
     language.

     The "System Libraries" of an executable work include anything,
     other than the work as a whole, that (a) is included in the normal
     form of packaging a Major Component, but which is not part of that
     Major Component, and (b) serves only to enable use of the work
     with that Major Component, or to implement a Standard Interface
     for which an implementation is available to the public in source
     code form.  A "Major Component", in this context, means a major
     essential component (kernel, window system, and so on) of the
     specific operating system (if any) on which the executable work
     runs, or a compiler used to produce the work, or an object code
     interpreter used to run it.

     The "Corresponding Source" for a work in object code form means all
     the source code needed to generate, install, and (for an executable
     work) run the object code and to modify the work, including
     scripts to control those activities.  However, it does not include
     the work's System Libraries, or general-purpose tools or generally
     available free programs which are used unmodified in performing
     those activities but which are not part of the work.  For example,
     Corresponding Source includes interface definition files
     associated with source files for the work, and the source code for
     shared libraries and dynamically linked subprograms that the work
     is specifically designed to require, such as by intimate data
     communication or control flow between those subprograms and other
     parts of the work.

     The Corresponding Source need not include anything that users can
     regenerate automatically from other parts of the Corresponding
     Source.

     The Corresponding Source for a work in source code form is that
     same work.

  2. Basic Permissions.

     All rights granted under this License are granted for the term of
     copyright on the Program, and are irrevocable provided the stated
     conditions are met.  This License explicitly affirms your unlimited
     permission to run the unmodified Program.  The output from running
     a covered work is covered by this License only if the output,
     given its content, constitutes a covered work.  This License
     acknowledges your rights of fair use or other equivalent, as
     provided by copyright law.

     You may make, run and propagate covered works that you do not
     convey, without conditions so long as your license otherwise
     remains in force.  You may convey covered works to others for the
     sole purpose of having them make modifications exclusively for
     you, or provide you with facilities for running those works,
     provided that you comply with the terms of this License in
     conveying all material for which you do not control copyright.
     Those thus making or running the covered works for you must do so
     exclusively on your behalf, under your direction and control, on
     terms that prohibit them from making any copies of your
     copyrighted material outside their relationship with you.

     Conveying under any other circumstances is permitted solely under
     the conditions stated below.  Sublicensing is not allowed; section
     10 makes it unnecessary.

  3. Protecting Users' Legal Rights From Anti-Circumvention Law.

     No covered work shall be deemed part of an effective technological
     measure under any applicable law fulfilling obligations under
     article 11 of the WIPO copyright treaty adopted on 20 December
     1996, or similar laws prohibiting or restricting circumvention of
     such measures.

     When you convey a covered work, you waive any legal power to forbid
     circumvention of technological measures to the extent such
     circumvention is effected by exercising rights under this License
     with respect to the covered work, and you disclaim any intention
     to limit operation or modification of the work as a means of
     enforcing, against the work's users, your or third parties' legal
     rights to forbid circumvention of technological measures.

  4. Conveying Verbatim Copies.

     You may convey verbatim copies of the Program's source code as you
     receive it, in any medium, provided that you conspicuously and
     appropriately publish on each copy an appropriate copyright notice;
     keep intact all notices stating that this License and any
     non-permissive terms added in accord with section 7 apply to the
     code; keep intact all notices of the absence of any warranty; and
     give all recipients a copy of this License along with the Program.

     You may charge any price or no price for each copy that you convey,
     and you may offer support or warranty protection for a fee.

  5. Conveying Modified Source Versions.

     You may convey a work based on the Program, or the modifications to
     produce it from the Program, in the form of source code under the
     terms of section 4, provided that you also meet all of these
     conditions:

       a. The work must carry prominent notices stating that you
          modified it, and giving a relevant date.

       b. The work must carry prominent notices stating that it is
          released under this License and any conditions added under
          section 7.  This requirement modifies the requirement in
          section 4 to "keep intact all notices".

       c. You must license the entire work, as a whole, under this
          License to anyone who comes into possession of a copy.  This
          License will therefore apply, along with any applicable
          section 7 additional terms, to the whole of the work, and all
          its parts, regardless of how they are packaged.  This License
          gives no permission to license the work in any other way, but
          it does not invalidate such permission if you have separately
          received it.

       d. If the work has interactive user interfaces, each must display
          Appropriate Legal Notices; however, if the Program has
          interactive interfaces that do not display Appropriate Legal
          Notices, your work need not make them do so.

     A compilation of a covered work with other separate and independent
     works, which are not by their nature extensions of the covered
     work, and which are not combined with it such as to form a larger
     program, in or on a volume of a storage or distribution medium, is
     called an "aggregate" if the compilation and its resulting
     copyright are not used to limit the access or legal rights of the
     compilation's users beyond what the individual works permit.
     Inclusion of a covered work in an aggregate does not cause this
     License to apply to the other parts of the aggregate.

  6. Conveying Non-Source Forms.

     You may convey a covered work in object code form under the terms
     of sections 4 and 5, provided that you also convey the
     machine-readable Corresponding Source under the terms of this
     License, in one of these ways:

       a. Convey the object code in, or embodied in, a physical product
          (including a physical distribution medium), accompanied by the
          Corresponding Source fixed on a durable physical medium
          customarily used for software interchange.

       b. Convey the object code in, or embodied in, a physical product
          (including a physical distribution medium), accompanied by a
          written offer, valid for at least three years and valid for
          as long as you offer spare parts or customer support for that
          product model, to give anyone who possesses the object code
          either (1) a copy of the Corresponding Source for all the
          software in the product that is covered by this License, on a
          durable physical medium customarily used for software
          interchange, for a price no more than your reasonable cost of
          physically performing this conveying of source, or (2) access
          to copy the Corresponding Source from a network server at no
          charge.

       c. Convey individual copies of the object code with a copy of
          the written offer to provide the Corresponding Source.  This
          alternative is allowed only occasionally and noncommercially,
          and only if you received the object code with such an offer,
          in accord with subsection 6b.

       d. Convey the object code by offering access from a designated
          place (gratis or for a charge), and offer equivalent access
          to the Corresponding Source in the same way through the same
          place at no further charge.  You need not require recipients
          to copy the Corresponding Source along with the object code.
          If the place to copy the object code is a network server, the
          Corresponding Source may be on a different server (operated
          by you or a third party) that supports equivalent copying
          facilities, provided you maintain clear directions next to
          the object code saying where to find the Corresponding Source.
          Regardless of what server hosts the Corresponding Source, you
          remain obligated to ensure that it is available for as long
          as needed to satisfy these requirements.

       e. Convey the object code using peer-to-peer transmission,
          provided you inform other peers where the object code and
          Corresponding Source of the work are being offered to the
          general public at no charge under subsection 6d.


     A separable portion of the object code, whose source code is
     excluded from the Corresponding Source as a System Library, need
     not be included in conveying the object code work.

     A "User Product" is either (1) a "consumer product", which means
     any tangible personal property which is normally used for personal,
     family, or household purposes, or (2) anything designed or sold for
     incorporation into a dwelling.  In determining whether a product
     is a consumer product, doubtful cases shall be resolved in favor of
     coverage.  For a particular product received by a particular user,
     "normally used" refers to a typical or common use of that class of
     product, regardless of the status of the particular user or of the
     way in which the particular user actually uses, or expects or is
     expected to use, the product.  A product is a consumer product
     regardless of whether the product has substantial commercial,
     industrial or non-consumer uses, unless such uses represent the
     only significant mode of use of the product.

     "Installation Information" for a User Product means any methods,
     procedures, authorization keys, or other information required to
     install and execute modified versions of a covered work in that
     User Product from a modified version of its Corresponding Source.
     The information must suffice to ensure that the continued
     functioning of the modified object code is in no case prevented or
     interfered with solely because modification has been made.

     If you convey an object code work under this section in, or with,
     or specifically for use in, a User Product, and the conveying
     occurs as part of a transaction in which the right of possession
     and use of the User Product is transferred to the recipient in
     perpetuity or for a fixed term (regardless of how the transaction
     is characterized), the Corresponding Source conveyed under this
     section must be accompanied by the Installation Information.  But
     this requirement does not apply if neither you nor any third party
     retains the ability to install modified object code on the User
     Product (for example, the work has been installed in ROM).

     The requirement to provide Installation Information does not
     include a requirement to continue to provide support service,
     warranty, or updates for a work that has been modified or
     installed by the recipient, or for the User Product in which it
     has been modified or installed.  Access to a network may be denied
     when the modification itself materially and adversely affects the
     operation of the network or violates the rules and protocols for
     communication across the network.

     Corresponding Source conveyed, and Installation Information
     provided, in accord with this section must be in a format that is
     publicly documented (and with an implementation available to the
     public in source code form), and must require no special password
     or key for unpacking, reading or copying.

  7. Additional Terms.

     "Additional permissions" are terms that supplement the terms of
     this License by making exceptions from one or more of its
     conditions.  Additional permissions that are applicable to the
     entire Program shall be treated as though they were included in
     this License, to the extent that they are valid under applicable
     law.  If additional permissions apply only to part of the Program,
     that part may be used separately under those permissions, but the
     entire Program remains governed by this License without regard to
     the additional permissions.

     When you convey a copy of a covered work, you may at your option
     remove any additional permissions from that copy, or from any part
     of it.  (Additional permissions may be written to require their own
     removal in certain cases when you modify the work.)  You may place
     additional permissions on material, added by you to a covered work,
     for which you have or can give appropriate copyright permission.

     Notwithstanding any other provision of this License, for material
     you add to a covered work, you may (if authorized by the copyright
     holders of that material) supplement the terms of this License
     with terms:

       a. Disclaiming warranty or limiting liability differently from
          the terms of sections 15 and 16 of this License; or

       b. Requiring preservation of specified reasonable legal notices
          or author attributions in that material or in the Appropriate
          Legal Notices displayed by works containing it; or

       c. Prohibiting misrepresentation of the origin of that material,
          or requiring that modified versions of such material be
          marked in reasonable ways as different from the original
          version; or

       d. Limiting the use for publicity purposes of names of licensors
          or authors of the material; or

       e. Declining to grant rights under trademark law for use of some
          trade names, trademarks, or service marks; or

       f. Requiring indemnification of licensors and authors of that
          material by anyone who conveys the material (or modified
          versions of it) with contractual assumptions of liability to
          the recipient, for any liability that these contractual
          assumptions directly impose on those licensors and authors.

     All other non-permissive additional terms are considered "further
     restrictions" within the meaning of section 10.  If the Program as
     you received it, or any part of it, contains a notice stating that
     it is governed by this License along with a term that is a further
     restriction, you may remove that term.  If a license document
     contains a further restriction but permits relicensing or
     conveying under this License, you may add to a covered work
     material governed by the terms of that license document, provided
     that the further restriction does not survive such relicensing or
     conveying.

     If you add terms to a covered work in accord with this section, you
     must place, in the relevant source files, a statement of the
     additional terms that apply to those files, or a notice indicating
     where to find the applicable terms.

     Additional terms, permissive or non-permissive, may be stated in
     the form of a separately written license, or stated as exceptions;
     the above requirements apply either way.

  8. Termination.

     You may not propagate or modify a covered work except as expressly
     provided under this License.  Any attempt otherwise to propagate or
     modify it is void, and will automatically terminate your rights
     under this License (including any patent licenses granted under
     the third paragraph of section 11).

     However, if you cease all violation of this License, then your
     license from a particular copyright holder is reinstated (a)
     provisionally, unless and until the copyright holder explicitly
     and finally terminates your license, and (b) permanently, if the
     copyright holder fails to notify you of the violation by some
     reasonable means prior to 60 days after the cessation.

     Moreover, your license from a particular copyright holder is
     reinstated permanently if the copyright holder notifies you of the
     violation by some reasonable means, this is the first time you have
     received notice of violation of this License (for any work) from
     that copyright holder, and you cure the violation prior to 30 days
     after your receipt of the notice.

     Termination of your rights under this section does not terminate
     the licenses of parties who have received copies or rights from
     you under this License.  If your rights have been terminated and
     not permanently reinstated, you do not qualify to receive new
     licenses for the same material under section 10.

  9. Acceptance Not Required for Having Copies.

     You are not required to accept this License in order to receive or
     run a copy of the Program.  Ancillary propagation of a covered work
     occurring solely as a consequence of using peer-to-peer
     transmission to receive a copy likewise does not require
     acceptance.  However, nothing other than this License grants you
     permission to propagate or modify any covered work.  These actions
     infringe copyright if you do not accept this License.  Therefore,
     by modifying or propagating a covered work, you indicate your
     acceptance of this License to do so.

 10. Automatic Licensing of Downstream Recipients.

     Each time you convey a covered work, the recipient automatically
     receives a license from the original licensors, to run, modify and
     propagate that work, subject to this License.  You are not
     responsible for enforcing compliance by third parties with this
     License.

     An "entity transaction" is a transaction transferring control of an
     organization, or substantially all assets of one, or subdividing an
     organization, or merging organizations.  If propagation of a
     covered work results from an entity transaction, each party to that
     transaction who receives a copy of the work also receives whatever
     licenses to the work the party's predecessor in interest had or
     could give under the previous paragraph, plus a right to
     possession of the Corresponding Source of the work from the
     predecessor in interest, if the predecessor has it or can get it
     with reasonable efforts.

     You may not impose any further restrictions on the exercise of the
     rights granted or affirmed under this License.  For example, you
     may not impose a license fee, royalty, or other charge for
     exercise of rights granted under this License, and you may not
     initiate litigation (including a cross-claim or counterclaim in a
     lawsuit) alleging that any patent claim is infringed by making,
     using, selling, offering for sale, or importing the Program or any
     portion of it.

 11. Patents.

     A "contributor" is a copyright holder who authorizes use under this
     License of the Program or a work on which the Program is based.
     The work thus licensed is called the contributor's "contributor
     version".

     A contributor's "essential patent claims" are all patent claims
     owned or controlled by the contributor, whether already acquired or
     hereafter acquired, that would be infringed by some manner,
     permitted by this License, of making, using, or selling its
     contributor version, but do not include claims that would be
     infringed only as a consequence of further modification of the
     contributor version.  For purposes of this definition, "control"
     includes the right to grant patent sublicenses in a manner
     consistent with the requirements of this License.

     Each contributor grants you a non-exclusive, worldwide,
     royalty-free patent license under the contributor's essential
     patent claims, to make, use, sell, offer for sale, import and
     otherwise run, modify and propagate the contents of its
     contributor version.

     In the following three paragraphs, a "patent license" is any
     express agreement or commitment, however denominated, not to
     enforce a patent (such as an express permission to practice a
     patent or covenant not to sue for patent infringement).  To
     "grant" such a patent license to a party means to make such an
     agreement or commitment not to enforce a patent against the party.

     If you convey a covered work, knowingly relying on a patent
     license, and the Corresponding Source of the work is not available
     for anyone to copy, free of charge and under the terms of this
     License, through a publicly available network server or other
     readily accessible means, then you must either (1) cause the
     Corresponding Source to be so available, or (2) arrange to deprive
     yourself of the benefit of the patent license for this particular
     work, or (3) arrange, in a manner consistent with the requirements
     of this License, to extend the patent license to downstream
     recipients.  "Knowingly relying" means you have actual knowledge
     that, but for the patent license, your conveying the covered work
     in a country, or your recipient's use of the covered work in a
     country, would infringe one or more identifiable patents in that
     country that you have reason to believe are valid.

     If, pursuant to or in connection with a single transaction or
     arrangement, you convey, or propagate by procuring conveyance of, a
     covered work, and grant a patent license to some of the parties
     receiving the covered work authorizing them to use, propagate,
     modify or convey a specific copy of the covered work, then the
     patent license you grant is automatically extended to all
     recipients of the covered work and works based on it.

     A patent license is "discriminatory" if it does not include within
     the scope of its coverage, prohibits the exercise of, or is
     conditioned on the non-exercise of one or more of the rights that
     are specifically granted under this License.  You may not convey a
     covered work if you are a party to an arrangement with a third
     party that is in the business of distributing software, under
     which you make payment to the third party based on the extent of
     your activity of conveying the work, and under which the third
     party grants, to any of the parties who would receive the covered
     work from you, a discriminatory patent license (a) in connection
     with copies of the covered work conveyed by you (or copies made
     from those copies), or (b) primarily for and in connection with
     specific products or compilations that contain the covered work,
     unless you entered into that arrangement, or that patent license
     was granted, prior to 28 March 2007.

     Nothing in this License shall be construed as excluding or limiting
     any implied license or other defenses to infringement that may
     otherwise be available to you under applicable patent law.

 12. No Surrender of Others' Freedom.

     If conditions are imposed on you (whether by court order,
     agreement or otherwise) that contradict the conditions of this
     License, they do not excuse you from the conditions of this
     License.  If you cannot convey a covered work so as to satisfy
     simultaneously your obligations under this License and any other
     pertinent obligations, then as a consequence you may not convey it
     at all.  For example, if you agree to terms that obligate you to
     collect a royalty for further conveying from those to whom you
     convey the Program, the only way you could satisfy both those
     terms and this License would be to refrain entirely from conveying
     the Program.

 13. Use with the GNU Affero General Public License.

     Notwithstanding any other provision of this License, you have
     permission to link or combine any covered work with a work licensed
     under version 3 of the GNU Affero General Public License into a
     single combined work, and to convey the resulting work.  The terms
     of this License will continue to apply to the part which is the
     covered work, but the special requirements of the GNU Affero
     General Public License, section 13, concerning interaction through
     a network will apply to the combination as such.

 14. Revised Versions of this License.

     The Free Software Foundation may publish revised and/or new
     versions of the GNU General Public License from time to time.
     Such new versions will be similar in spirit to the present
     version, but may differ in detail to address new problems or
     concerns.

     Each version is given a distinguishing version number.  If the
     Program specifies that a certain numbered version of the GNU
     General Public License "or any later version" applies to it, you
     have the option of following the terms and conditions either of
     that numbered version or of any later version published by the
     Free Software Foundation.  If the Program does not specify a
     version number of the GNU General Public License, you may choose
     any version ever published by the Free Software Foundation.

     If the Program specifies that a proxy can decide which future
     versions of the GNU General Public License can be used, that
     proxy's public statement of acceptance of a version permanently
     authorizes you to choose that version for the Program.

     Later license versions may give you additional or different
     permissions.  However, no additional obligations are imposed on any
     author or copyright holder as a result of your choosing to follow a
     later version.

 15. Disclaimer of Warranty.

     THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
     APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE
     COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS"
     WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED,
     INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
     MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE
     RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.
     SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL
     NECESSARY SERVICING, REPAIR OR CORRECTION.

 16. Limitation of Liability.

     IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
     WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES
     AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU
     FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR
     CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE
     THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA
     BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
     PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
     PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF
     THE POSSIBILITY OF SUCH DAMAGES.

 17. Interpretation of Sections 15 and 16.

     If the disclaimer of warranty and limitation of liability provided
     above cannot be given local legal effect according to their terms,
     reviewing courts shall apply local law that most closely
     approximates an absolute waiver of all civil liability in
     connection with the Program, unless a warranty or assumption of
     liability accompanies a copy of the Program in return for a fee.


END OF TERMS AND CONDITIONS
===========================

How to Apply These Terms to Your New Programs
=============================================

If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these
terms.

   To do so, attach the following notices to the program.  It is safest
to attach them to the start of each source file to most effectively
state the exclusion of warranty; and each file should have at least the
"copyright" line and a pointer to where the full notice is found.

     ONE LINE TO GIVE THE PROGRAM'S NAME AND A BRIEF IDEA OF WHAT IT DOES.
     Copyright (C) YEAR NAME OF AUTHOR

     This program is free software: you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
     the Free Software Foundation, either version 3 of the License, or (at
     your option) any later version.

     This program is distributed in the hope that it will be useful, but
     WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
     General Public License for more details.

     You should have received a copy of the GNU General Public License
     along with this program.  If not, see `http://www.gnu.org/licenses/'.

   Also add information on how to contact you by electronic and paper
mail.

   If the program does terminal interaction, make it output a short
notice like this when it starts in an interactive mode:

     PROGRAM Copyright (C) YEAR NAME OF AUTHOR
     This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
     This is free software, and you are welcome to redistribute it
     under certain conditions; type `show c' for details.

   The hypothetical commands `show w' and `show c' should show the
appropriate parts of the General Public License.  Of course, your
program's commands might be different; for a GUI interface, you would
use an "about box".

   You should also get your employer (if you work as a programmer) or
school, if any, to sign a "copyright disclaimer" for the program, if
necessary.  For more information on this, and how to apply and follow
the GNU GPL, see `http://www.gnu.org/licenses/'.

   The GNU General Public License does not permit incorporating your
program into proprietary programs.  If your program is a subroutine
library, you may consider it more useful to permit linking proprietary
applications with the library.  If this is what you want to do, use the
GNU Lesser General Public License instead of this License.  But first,
please read `http://www.gnu.org/philosophy/why-not-lgpl.html'.  \r

Index
*****

\r

-animateSpeed, option:                         See 3.5.      (line 1768)
.cmailaliases:                                 See 10.1.     (line 2407)
.cmailgames:                                   See 10.1.     (line 2402)
.icsrc:                                        See 3.3.      (line 1291)
<, Button:                                     See 2.4.      (line  452)
<<, Button:                                    See 2.4.      (line  482)
>, Button:                                     See 2.4.      (line  470)
>>, Button:                                    See 2.4.      (line  499)
abort, ICS command:                            See 4.        (line 2056)
Abort, Menu Item:                              See 2.3.      (line  431)
About XBoard, Menu Item:                       See 2.6.      (line  832)
accept, ICS command:                           See 4.        (line 2044)
Accept, Menu Item:                             See 2.3.      (line  406)
Action, Menu:                                  See 2.3.      (line  405)
adjourn, ICS command:                          See 4.        (line 2056)
Adjourn, Menu Item:                            See 2.3.      (line  427)
Adjudicate Draw, Menu Item:                    See 2.4.      (line  533)
Adjudicate to Black, Menu Item:                See 2.4.      (line  533)
Adjudicate to White, Menu Item:                See 2.4.      (line  533)
adjudicateDrawMoves, option:                   See 3.6.      (line 1784)
adjudicateLossThreshold, option:               See 3.6.      (line 1776)
Adjudications, Menu Item:                      See 2.5.      (line  548)
alarm, option:                                 See 3.3.      (line 1335)
Always Queen, Menu Item:                       See 2.5.      (line  596)
alwaysPromoteToQueen, option:                  See 3.5.      (line 1575)
Analysis Mode, Menu Item:                      See 2.2.      (line  241)
Analyze File, Menu Item:                       See 2.2.      (line  256)
Animate Dragging, Menu Item:                   See 2.5.      (line  602)
Animate Moving, Menu Item:                     See 2.5.      (line  609)
animate, option:                               See 3.5.      (line 1764)
animateDragging, option:                       See 3.5.      (line 1760)
animateMoving, option:                         See 3.5.      (line 1764)
Authors:                                       See 9.        (line 2273)
Auto Comment, Menu Item:                       See 2.5.      (line  617)
Auto Flag, Menu Item:                          See 2.5.      (line  625)
Auto Flip View, Menu Item:                     See 2.5.      (line  634)
Auto Observe, Menu Item:                       See 2.5.      (line  639)
Auto Raise Board, Menu Item:                   See 2.5.      (line  652)
Auto Save, Menu Item:                          See 2.5.      (line  657)
autobs, option:                                See 3.3.      (line 1319)
autoCallFlag, option:                          See 3.3.      (line 1315)
autocomm, option:                              See 3.3.      (line 1311)
autoComment, option:                           See 3.3.      (line 1311)
autoflag, option:                              See 3.3.      (line 1315)
autoflip, option:                              See 3.5.      (line 1620)
autoFlipView, option:                          See 3.5.      (line 1620)
autoKibitz, option:                            See 3.3.      (line 1323)
autoObserve, option:                           See 3.3.      (line 1319)
autoraise, option:                             See 3.5.      (line 1616)
autoRaiseBoard, option:                        See 3.5.      (line 1616)
autosave, option:                              See 3.4.      (line 1497)
autoSaveGames, option:                         See 3.4.      (line 1497)
Back to Start, Menu Item:                      See 2.4.      (line  482)
Backward, Menu Item:                           See 2.4.      (line  452)
bell, option:                                  See 3.5.      (line 1562)
bitmapDirectory, option:                       See 3.5.      (line 1702)
blackPieceColor, option:                       See 3.5.      (line 1743)
blind, option:                                 See 3.5.      (line 1668)
Blindfold, Menu Item:                          See 2.5.      (line  664)
blindfold, option:                             See 3.5.      (line 1668)
bm, option:                                    See 3.5.      (line 1702)
board size:                                    See 3.5.      (line 1583)
boardHeight, option:                           See 3.7.      (line 1898)
boardSize, option:                             See 3.5.      (line 1583)
boardWidth, option:                            See 3.7.      (line 1903)
Book, Menu Item:                               See 2.6.      (line  822)
Bug reports:                                   See 8.        (line 2244)
Bugs <1>:                                      See 8.        (line 2244)
Bugs:                                          See 7.        (line 2191)
buttons, option:                               See 3.5.      (line 1642)
Call Flag, Menu Item:                          See 2.3.      (line  416)
checkMates, option:                            See 3.6.      (line 1789)
Chess engine options:                          See 3.1.      (line  908)
CHESSDIR:                                      See 6.        (line 2182)
clock, option:                                 See 3.1.      (line  925)
clockFont, option:                             See 3.5.      (line 1672)
clockMode, option:                             See 3.1.      (line  925)
cmail:                                         See 10.       (line 2313)
colorChallenge, option:                        See 3.3.      (line 1366)
colorChannel, option:                          See 3.3.      (line 1366)
colorChannel1, option:                         See 3.3.      (line 1366)
colorize, option:                              See 3.3.      (line 1351)
colorKibitz, option:                           See 3.3.      (line 1366)
colorNormal, option:                           See 3.3.      (line 1366)
colorRequest, option:                          See 3.3.      (line 1366)
Colors <1>:                                    See 3.5.      (line 1743)
Colors:                                        See 3.3.      (line 1351)
colorSeek, option:                             See 3.3.      (line 1366)
colorShout, option:                            See 3.3.      (line 1366)
colorSShout, option:                           See 3.3.      (line 1366)
colorTell, option:                             See 3.3.      (line 1366)
Contributors:                                  See 9.        (line 2273)
coordFont, option:                             See 3.5.      (line 1678)
coords, option:                                See 3.5.      (line 1612)
Copy Game, Menu Item:                          See 2.1.      (line  167)
Copy Position, Menu Item:                      See 2.1.      (line  208)
darkSquareColor, option:                       See 3.5.      (line 1743)
debug, option:                                 See 3.7.      (line 1950)
debugFile, option:                             See 3.7.      (line 1953)
debugMode, option:                             See 3.7.      (line 1950)
decline, ICS command:                          See 4.        (line 2044)
Decline, Menu Item:                            See 2.3.      (line  411)
defaultCacheSizeEGTB, option:                  See 3.2.      (line 1176)
defaultFrcPosition, option:                    See 3.7.      (line 1918)
defaultHashSize, option:                       See 3.2.      (line 1170)
defaultPathEGTB, option:                       See 3.2.      (line 1182)
delayAfterQuit, option:                        See 3.7.      (line 1986)
delayBeforeQuit, option:                       See 3.7.      (line 1986)
display, option:                               See 3.5.      (line 1553)
drag, option:                                  See 3.5.      (line 1760)
draw, ICS command:                             See 4.        (line 2056)
Draw, Menu Item:                               See 2.3.      (line  422)
Edit Comment, Menu Item:                       See 2.2.      (line  366)
Edit Game, Menu Item:                          See 2.2.      (line  288)
Edit Position, Menu Item:                      See 2.2.      (line  301)
Edit Tags, Menu Item:                          See 2.2.      (line  343)
egtFormats, option:                            See 3.2.      (line 1186)
Engine Settings:                               See 3.2.      (line 1137)
engineDebugOutput, option:                     See 3.7.      (line 1958)
Environment variables:                         See 6.        (line 2182)
examine, ICS command:                          See 4.        (line 2079)
Exit, Menu Item:                               See 2.1.      (line  225)
exit, option:                                  See 3.5.      (line 1567)
fb, option:                                    See 3.1.      (line 1036)
fcp, option:                                   See 3.1.      (line 1028)
fd, option:                                    See 3.1.      (line 1052)
fh, option:                                    See 3.1.      (line 1044)
File Menu:                                     See 2.1.      (line   83)
finger, ICS command:                           See 4.        (line 2066)
firstChessProgram, option:                     See 3.1.      (line 1028)
firstComputerString, option:                   See 3.1.      (line 1084)
firstDirectory, option:                        See 3.1.      (line 1052)
firstHasOwnBookUCI, option:                    See 3.2.      (line 1165)
firstHost, option:                             See 3.1.      (line 1044)
firstIsUCI, option:                            See 3.2.      (line 1139)
firstNPS, option:                              See 3.1.      (line  948)
firstOptions option:                           See 3.1.      (line 1124)
firstPlaysBlack, option:                       See 3.1.      (line 1036)
firstProtocolVersion, option:                  See 3.1.      (line 1101)
firstScoreAbs, option:                         See 3.1.      (line 1109)
firstTimeOdds, option:                         See 3.1.      (line  967)
firstXBook, option:                            See 3.2.      (line 1165)
Flash Moves, Menu Item:                        See 2.5.      (line  670)
flash, option:                                 See 3.5.      (line 1655)
flashCount, option:                            See 3.5.      (line 1655)
flashRate, option:                             See 3.5.      (line 1655)
Flip View, Menu Item:                          See 2.5.      (line  543)
flip, option:                                  See 3.5.      (line 1624)
flipView, option:                              See 3.5.      (line 1624)
fNoOwnBookUCI, option:                         See 3.2.      (line 1165)
Font:                                          See 3.5.      (line 1685)
Font, clock:                                   See 3.5.      (line 1672)
Font, coordinates:                             See 3.5.      (line 1678)
font, option:                                  See 3.5.      (line 1685)
fontSizeTolerance, option:                     See 3.5.      (line 1692)
Forward to End, Menu Item:                     See 2.4.      (line  499)
Forward, Menu Item:                            See 2.4.      (line  470)
fUCI, option:                                  See 3.2.      (line 1139)
gameListTags, option:                          See 3.4.      (line 1540)
games, ICS command:                            See 4.        (line 2033)
gateway, option:                               See 3.3.      (line 1246)
geometry, option:                              See 3.5.      (line 1553)
Get Move List, Menu Item:                      See 2.5.      (line  683)
getMoveList, option:                           See 3.3.      (line 1331)
Help Menu:                                     See 2.6.      (line  804)
help, ICS command:                             See 4.        (line 2019)
Hide Thinking, Menu Item:                      See 2.5.      (line  780)
Highlight Last Move, Menu Item:                See 2.5.      (line  695)
highlight, option:                             See 3.5.      (line 1664)
highlightLastMove, option:                     See 3.5.      (line 1664)
highlightSquareColor, option:                  See 3.5.      (line 1743)
Hint, Menu Item:                               See 2.6.      (line  819)
holdingsSize, option:                          See 3.7.      (line 1910)
iconic, option:                                See 3.5.      (line 1553)
ICS:                                           See 4.        (line 1995)
ICS Alarm, Menu Item:                          See 2.5.      (line  715)
ICS Client, Menu Item:                         See 2.2.      (line  266)
ICS Input Box, Menu Item:                      See 2.2.      (line  371)
ICS options:                                   See 3.3.      (line 1201)
ICS, addresses:                                See 4.        (line 1995)
ics, option:                                   See 3.3.      (line 1202)
icsAlarm, option:                              See 3.3.      (line 1335)
icsAlarmTime, option:                          See 3.3.      (line 1339)
icscomm, option:                               See 3.3.      (line 1254)
icshelper, option:                             See 3.3.      (line 1220)
icshost, option:                               See 3.3.      (line 1207)
icsinput, option:                              See 3.3.      (line 1307)
icslogon, option:                              See 3.3.      (line 1291)
icsport, option:                               See 3.3.      (line 1216)
inc, option:                                   See 3.1.      (line  918)
Info XBoard, Menu Item:                        See 2.6.      (line  805)
initalMode, option:                            See 3.7.      (line 1844)
initString, option:                            See 3.1.      (line 1061)
Internet Chess Server:                         See 4.        (line 1995)
internetChessServerCommPort, option:           See 3.3.      (line 1254)
internetChessServerHelper, option:             See 3.3.      (line 1220)
internetChessServerHost, option:               See 3.3.      (line 1207)
internetChessServerInputBox, option:           See 3.3.      (line 1307)
internetChessServerLogonScript, option:        See 3.3.      (line 1291)
internetChessServerMode, option:               See 3.3.      (line 1202)
internetChessServerPort, option:               See 3.3.      (line 1216)
introduction:
          See ``Introduction''.                              (line   13)
Keys:                                          See 2.7.      (line  838)
legal, option:                                 See 3.5.      (line 1579)
lgf, option:                                   See 3.4.      (line 1458)
lgi, option:                                   See 3.4.      (line 1458)
lightSquareColor, option:                      See 3.5.      (line 1743)
Limitations:                                   See 7.        (line 2191)
Load and Save options:                         See 3.4.      (line 1456)
Load Game, Menu Item:                          See 2.1.      (line  115)
Load Next Game, Menu Item:                     See 2.1.      (line  142)
Load Next Position, Menu Item:                 See 2.1.      (line  188)
Load Position, Menu Item:                      See 2.1.      (line  180)
Load Previous Game, Menu Item:                 See 2.1.      (line  146)
Load Previous Position, Menu Item:             See 2.1.      (line  191)
loadGameFile, option:                          See 3.4.      (line 1458)
loadGameIndex, option:                         See 3.4.      (line 1458)
loadPositionFile, option:                      See 3.4.      (line 1502)
loadPositionIndex, option:                     See 3.4.      (line 1502)
lpf, option:                                   See 3.4.      (line 1502)
lpi, option:                                   See 3.4.      (line 1502)
Machine Black, Menu Item:                      See 2.2.      (line  235)
Machine White, Menu Item:                      See 2.2.      (line  232)
Mail Move, Menu Item:                          See 2.1.      (line  222)
Major modes:                                   See 1.        (line   22)
Man XBoard, Menu Item:                         See 2.6.      (line  812)
matchGames, option:                            See 3.1.      (line 1005)
matchMode, option:                             See 3.1.      (line 1018)
materialDraws, option:                         See 3.6.      (line 1801)
Menu, Action:                                  See 2.3.      (line  405)
Menu, File:                                    See 2.1.      (line   83)
Menu, Help:                                    See 2.6.      (line  804)
Menu, Mode:                                    See 2.2.      (line  231)
Menu, Options:                                 See 2.5.      (line  542)
Menu, Step:                                    See 2.4.      (line  451)
Menus:                                         See 2.        (line   60)
mg, option:                                    See 3.1.      (line 1005)
mm, option:                                    See 3.1.      (line 1018)
Mode Menu:                                     See 2.2.      (line  231)
mode, option:                                  See 3.7.      (line 1844)
mono, option:                                  See 3.5.      (line 1648)
monoMode, option:                              See 3.5.      (line 1648)
Move Now, Menu Item:                           See 2.4.      (line  519)
Move Sound, Menu Item:                         See 2.5.      (line  701)
moves, option:                                 See 3.3.      (line 1331)
movesound, option:                             See 3.5.      (line 1562)
movesPerSession, option:                       See 3.1.      (line  914)
mps, option:                                   See 3.1.      (line  914)
msLoginDelay, option:                          See 3.3.      (line 1300)
nameOfDebugFile, option:                       See 3.7.      (line 1953)
ncp, option:                                   See 3.7.      (line 1839)
New Game, Menu Item:                           See 2.1.      (line   84)
New Shuffle Game, Menu Item:                   See 2.1.      (line   93)
New variant, Menu Item:                        See 2.1.      (line  106)
niceEngines, option:                           See 3.1.      (line 1115)
noChessProgram, option:                        See 3.7.      (line 1839)
noGUI, option:                                 See 3.5.      (line 1556)
observe, ICS command:                          See 4.        (line 2075)
Old Save Style, Menu Item:                     See 2.5.      (line  724)
oldmoves, ICS command:                         See 4.        (line 2079)
oldsave, option:                               See 3.4.      (line 1536)
oldSaveStyle, option:                          See 3.4.      (line 1536)
Options:                                       See 3.        (line  884)
Options Menu:                                  See 2.5.      (line  542)
Options, adjudication:                         See 3.6.      (line 1775)
options, Chess engine:                         See 3.1.      (line  908)
Options, ICS:                                  See 3.3.      (line 1201)
Options, Load and Save:                        See 3.4.      (line 1456)
Options, miscellaneous:                        See 3.7.      (line 1838)
Options, User interface:                       See 3.5.      (line 1550)
Other programs:                                See 11.       (line 2517)
Paste Game, Menu Item:                         See 2.1.      (line  176)
Paste Position, Menu Item:                     See 2.1.      (line  217)
Pause, Menu Item:                              See 2.2.      (line  379)
Periodic Updates, Menu Item:                   See 2.5.      (line  732)
pgnEventHeader, option`:                       See 3.4.      (line 1528)
pgnExtendedInfo, option`:                      See 3.4.      (line 1523)
pieceToSquareTable, option:                    See 3.7.      (line 1924)
pixmap, option:                                See 3.5.      (line 1702)
pixmapDirectory, option:                       See 3.5.      (line 1702)
PolyglotBook, option:                          See 3.2.      (line 1154)
PolyglotDir, option:                           See 3.2.      (line 1146)
Ponder Next Move, Menu Item:                   See 2.5.      (line  738)
ponder, option:                                See 3.1.      (line  996)
ponderNextMove, option:                        See 3.1.      (line  996)
Popup Exit Message, Menu Item:                 See 2.5.      (line  743)
Popup Move Errors, Menu Item:                  See 2.5.      (line  750)
popup, option:                                 See 3.5.      (line 1571)
popupExitMessage, option:                      See 3.5.      (line 1567)
popupMoveErrors, option:                       See 3.5.      (line 1571)
pre, option:                                   See 3.3.      (line 1343)
Premove, Menu Item:                            See 2.5.      (line  759)
premove, option:                               See 3.3.      (line 1343)
Problems:                                      See 8.        (line 2244)
queen, option:                                 See 3.5.      (line 1575)
Quiet Play, Menu Item:                         See 2.5.      (line  770)
quiet, option:                                 See 3.3.      (line 1347)
quietPlay, option:                             See 3.3.      (line 1347)
Reload CMail Message, Menu Item:               See 2.1.      (line  222)
Reload Same Game, Menu Item:                   See 2.1.      (line  151)
Reload Same Position, Menu Item:               See 2.1.      (line  196)
remoteShell, option:                           See 3.7.      (line 1972)
remoteUser, option:                            See 3.7.      (line 1977)
Reporting bugs:                                See 8.        (line 2244)
Reporting problems:                            See 8.        (line 2244)
Resign, Menu Item:                             See 2.3.      (line  436)
Retract Move, Menu Item:                       See 2.4.      (line  523)
reuse, option:                                 See 3.1.      (line 1092)
reuse2, option:                                See 3.1.      (line 1092)
reuseFirst, option:                            See 3.1.      (line 1092)
reuseSecond, option:                           See 3.1.      (line 1092)
Revert, Menu Item:                             See 2.4.      (line  510)
ringBellAfterMoves, option:                    See 3.5.      (line 1562)
rsh, option:                                   See 3.7.      (line 1972)
ruleMoves, option:                             See 3.6.      (line 1820)
ruser, option:                                 See 3.7.      (line 1977)
sameColorGames, option:                        See 3.1.      (line 1022)
Save Game, Menu Item:                          See 2.1.      (line  155)
saveGameFile, option:                          See 3.4.      (line 1492)
saveOutOfBookInfo, option`:                    See 3.4.      (line 1532)
savePositionFile, option:                      See 3.4.      (line 1518)
scp, option:                                   See 3.1.      (line 1031)
sd, option:                                    See 3.1.      (line  939)
searchDepth, option:                           See 3.1.      (line  939)
searchTime, option:                            See 3.1.      (line  932)
secondChessProgram, option:                    See 3.1.      (line 1031)
secondComputerString, option:                  See 3.1.      (line 1084)
secondDirectory, option:                       See 3.1.      (line 1052)
secondHasOwnBookUCI, option:                   See 3.2.      (line 1165)
secondHost, option:                            See 3.1.      (line 1044)
secondInitString, option:                      See 3.1.      (line 1061)
secondIsUCI, option:                           See 3.2.      (line 1139)
secondNPS, option:                             See 3.1.      (line  948)
secondOptions, option:                         See 3.1.      (line 1124)
secondProtocolVersion, option:                 See 3.1.      (line 1101)
secondScoreAbs, option:                        See 3.1.      (line 1109)
secondTimeOdds, option:                        See 3.1.      (line  967)
secondXBook, option:                           See 3.2.      (line 1165)
set, ICS command:                              See 4.        (line 2072)
Settings, Engine:                              See 3.2.      (line 1137)
sgf, option:                                   See 3.4.      (line 1492)
sh, option:                                    See 3.1.      (line 1044)
Shortcut keys:                                 See 2.7.      (line  838)
Show Coords, Menu Item:                        See 2.5.      (line  776)
Show Engine Output, Menu Item:                 See 2.2.      (line  339)
Show Game List, Menu Item:                     See 2.2.      (line  330)
Show Move History, Menu Item:                  See 2.2.      (line  334)
showButtonBar, option:                         See 3.5.      (line 1642)
showCoords, option:                            See 3.5.      (line 1612)
showThinking, option:                          See 3.1.      (line  986)
size, option:                                  See 3.5.      (line 1583)
sNoOwnBookUCI, option:                         See 3.2.      (line 1165)
soundChallenge, option:                        See 3.3.      (line 1409)
soundChannel, option:                          See 3.3.      (line 1409)
soundIcsAlarm, option:                         See 3.3.      (line 1417)
soundIcsDraw, option:                          See 3.3.      (line 1428)
soundIcsLoss, option:                          See 3.3.      (line 1424)
soundIcsUnfinished, option:                    See 3.3.      (line 1432)
soundIcsWin, option:                           See 3.3.      (line 1420)
soundKibitz, option:                           See 3.3.      (line 1409)
soundMove, option:                             See 3.3.      (line 1414)
soundProgram, option:                          See 3.3.      (line 1393)
soundRequest, option:                          See 3.3.      (line 1409)
Sounds:                                        See 3.3.      (line 1393)
soundSeek, option:                             See 3.3.      (line 1409)
soundShout, option:                            See 3.3.      (line 1409)
soundSShout, option:                           See 3.3.      (line 1409)
soundTell, option:                             See 3.3.      (line 1409)
spf, option:                                   See 3.4.      (line 1518)
st, option:                                    See 3.1.      (line  932)
Step Menu:                                     See 2.4.      (line  451)
Stop Examining, Menu Item:                     See 2.3.      (line  444)
Stop Observing, Menu Item:                     See 2.3.      (line  440)
sUCI, option:                                  See 3.2.      (line 1139)
tc, option:                                    See 3.1.      (line  909)
td, option:                                    See 3.4.      (line 1486)
telnet, option:                                See 3.3.      (line 1228)
telnetProgram, option:                         See 3.3.      (line 1237)
Test Legality, Menu Item:                      See 2.5.      (line  789)
testClaims, option:                            See 3.6.      (line 1795)
testLegality, option:                          See 3.5.      (line 1579)
thinking, option:                              See 3.1.      (line  986)
Time Control, Menu Item:                       See 2.5.      (line  586)
timeControl, option:                           See 3.1.      (line  909)
timeDelay, option:                             See 3.4.      (line 1486)
timeIncrement, option:                         See 3.1.      (line  918)
timeOddsMode, option:                          See 3.1.      (line  973)
title, option:                                 See 3.5.      (line 1634)
titleInWindow, option:                         See 3.5.      (line 1634)
Training, Menu Item:                           See 2.2.      (line  319)
trivialDraws, option:                          See 3.6.      (line 1808)
Truncate Game, Menu Item:                      See 2.4.      (line  514)
Two Machines, Menu Item:                       See 2.2.      (line  238)
usePolyglotBook, option:                       See 3.2.      (line 1151)
User interface options:                        See 3.5.      (line 1550)
userName, option:                              See 3.7.      (line 1981)
useTelnet, option:                             See 3.3.      (line 1228)
variant, option:                               See 3.7.      (line 1852)
vars, ICS command:                             See 4.        (line 2069)
whitePieceColor, option:                       See 3.5.      (line 1743)
who, ICS command:                              See 4.        (line 2025)
xflash, option:                                See 3.5.      (line 1655)
Table of Contents
*****************

Introduction
1 Major modes
2 Menus, buttons, and keys
  2.1 File Menu
  2.2 Mode Menu
  2.3 Action Menu
  2.4 Step Menu
  2.5 Options Menu
  2.6 Help Menu
  2.7 Other Shortcut Keys
3 Options
  3.1 Chess Engine Options
  3.2 UCI + WB Engine Settings
  3.3 ICS options
  3.4 Load and Save options
  3.5 User interface options
  3.6 Adjudication Options
  3.7 Other options
4 Chess Servers
5 Firewalls
6 Environment variables
7 Limitations and known bugs
8 Reporting problems
9 Authors and contributors
10 CMail
  10.1 CMail options
  10.2 Starting a CMail Game
  10.3 Answering a Move
  10.4 Multi-Game Messages
  10.5 Completing a Game
  10.6 Known CMail Problems
11 Other programs you can use with XBoard
  11.1 GNU Chess
  11.2 Fairy-Max
  11.3 HoiChess
  11.4 Crafty
  11.5 zic2xpm
Copyright
GNU GENERAL PUBLIC LICENSE
Index


   \r \r