manual/xboard.txt

   1 INFO-DIR-SECTION Games
   2 START-INFO-DIR-ENTRY
   3 * xboard: (xboard).         An X Window System graphical chessboard.
   4 END-INFO-DIR-ENTRY
   5
   6 Introduction
   7 ************
   8
   9 XBoard is a graphical chessboard that can serve as a user interface to
  10 chess engines (such as GNU Chess), the Internet Chess Servers,
  11 electronic mail correspondence chess, or your own collection of saved
  12 games.
  13
  14    This manual documents version 4.5.0 of XBoard.
  15
  16 1 Major modes
  17 *************
  18
  19 XBoard always runs in one of four major modes.  You select the major
  20 mode from the command line when you start up XBoard.
  21
  22 xboard [options]
  23      As an interface to GNU Chess or another chess engine running on
  24      your machine, XBoard lets you play a game against the machine, set
  25      up arbitrary positions, force variations, watch a game between two
  26      chess engines, interactively analyze your stored games or set up
  27      and analyze arbitrary positions.  (Note: Not all chess engines
  28      support analysis.)
  29
  30 xboard -ics -icshost hostname [options]
  31      As Internet Chess Server (ICS) interface, XBoard lets you play
  32      against other ICS users, observe games they are playing, or review
  33      games that have recently finished.  Most of the ICS "wild" chess
  34      variants are supported, including bughouse.
  35
  36 xboard -ncp [options]
  37      XBoard can also be used simply as an electronic chessboard to play
  38      through games. It will read and write game files and allow you to
  39      play through variations manually. You can use it to browse games
  40      off the net or review games you have saved.  These features are
  41      also available in the other modes.
  42
  43 |pxboard
  44      If you want to pipe games into XBoard, use the supplied shell
  45      script `pxboard'.  For example, from the news reader `xrn', find a
  46      message with one or more games in it, click the Save button, and
  47      type `|pxboard' as the file name.
  48
  49 cmail [options]
  50      As an interface to electronic mail correspondence chess, XBoard
  51      works with the cmail program. See *note CMail:: below for
  52      instructions.
  53
  54 2 Menus, buttons, and keys
  55 **************************
  56
  57 To move a piece, you can drag it with the left mouse button, or you can
  58 click the left mouse button once on the piece, then once more on the
  59 destination square.  To drop a new piece on a square (when applicable),
  60 press the middle or the right mouse button over the square and select
  61 from the pop-up menu.  In cases where you can drop either a white or
  62 black piece, use the middle button (or shift+right) for white and the
  63 right button (or shift+middle) for black.  When you are playing a
  64 bughouse game on an Internet Chess Server, a list of the off-board
  65 pieces that each player has available is shown in the window title
  66 after the player's name; in addition, the piece menus show the number
  67 of pieces available of each type. From version 4.3.14 on, it is also
  68 possible in crazyhouse, bughouse or shogi to drag and drop pieces to
  69 the board from the holdings squares displayed next to the board.  This
  70 latter method for dropping pieces during a game is preferred, and the
  71 piece-drop menu is now deprecated (except for editing a position).
  72 Although the old behavior can still be selected through a command-line
  73 option, the default function of the right mouse button is to display
  74 the position the chess program thinks it will end up in, while moving
  75 the mouse vertically with this button pressed will step through the
  76 principal variation to show how this position will be reached.  Lines
  77 of play displayed in the engine-output window an similarly be played
  78 out on the board, by right-clicking on them.
  79
  80    When connected to an ICS, it is possible to call up a graphical
  81 representation of players seeking a game in stead of the chess board,
  82 when the latter is not in use (i.e. when you are not playing or
  83 observing).  Left-clicking the display area will switch between this
  84 'seek graph' and the chess board.  Hovering the mouse pointer over a
  85 dot will show the details of the seek ad in the message field above the
  86 board.  Left-clicking the dot will challenge that player.
  87 Right-clicking a dot will 'push it to the back', to reveal any dots
  88 that were hidden behind it.  Right-clicking off dots will refresh the
  89 graph.
  90
  91    Most other XBoard commands are available from the menu bar. The most
  92 frequently used commands also have shortcut keys or on-screen buttons.
  93 Some rarely used parameters can only be set through options on the
  94 command line used to invoke XBoard.
  95
  96    XBoard uses a settings file, in which it can remember any changes to
  97 the settings that are made through menus or command-line options, so
  98 they will still apply when you restart XBoard for another session.  The
  99 settings can be saved into this file automatically when XBoard exits,
 100 or on explicit request of the user.  The default name for the settings
 101 file is /etc/xboard/xboard.conf, but in a standard install this file is
 102 only used as a master settings file that determines the system-wide
 103 default settings, and defers reading and writing of user settings to a
 104 user-specific file like ~/.xboardrc in the user's home directory.
 105
 106    When XBoard is iconized, its graphical icon is a white knight if it
 107 is White's turn to move, a black knight if it is Black's turn.  See
 108 Iconize in *note Keys:: below if you have problems getting this feature
 109 to work.
 110
 111 2.1 File Menu
 112 =============
 113
 114 New Game
 115      Resets XBoard and the chess engine to the beginning of a new chess
 116      game. The `Ctrl-N' key is a keyboard equivalent. In Internet Chess
 117      Server mode, clears the current state of XBoard, then
 118      resynchronizes with the ICS by sending a refresh command. If you
 119      want to stop playing, observing, or examining an ICS game, use an
 120      appropriate command from the Action menu, not `New Game'.  *Note
 121      Action Menu::.
 122
 123 New Shuffle Game
 124      Similar to `New Game', but allows you to specify a particular
 125      initial position (according to a standardized numbering system) in
 126      chess variants which use randomized opening positions (e.g.
 127      Chess960).  The selected opening position will persistently be
 128      chosen on any following New Game command until you use this menu
 129      to select another. Selecting position number -1 will produce a
 130      newly randomized position on any new game.  Using this menu item
 131      in variants that normally do not shuffle their opening position
 132      does cause these variants to become shuffle variants until you use
 133      the `New Shuffle Game' menu to explicitly switch the randomization
 134      off, or select a new variant.
 135
 136 New Variant
 137      Allows you to select a new chess variant in non-ICS mode.  (In ICS
 138      play, the ICS is responsible for deciding which variant will be
 139      played, and XBoard adapts automatically.)  The shifted `Alt+V' key
 140      is a keyboard equivalent. If you play with an engine, the engine
 141      must be able to play the selected variant, or the command will be
 142      ignored.  XBoard supports all major variants, such as xiangqi,
 143      shogi, chess, chess960, Capablanca Chess, shatranj, crazyhouse,
 144      bughouse.  (But not every board size has built-in bitmaps for
 145      un-orthodox pieces!)
 146
 147 Load Game
 148      Plays a game from a record file. The `Ctrl-O' key is a keyboard
 149      equivalent.  A pop-up dialog prompts you for the file name. If the
 150      file contains more than one game, a second pop-up dialog displays
 151      a list of games (with information drawn from their PGN tags, if
 152      any), and you can select the one you want. Alternatively, you can
 153      load the Nth game in the file directly, by typing the number `N'
 154      after the file name, separated by a space.
 155
 156      The game file parser will accept PGN (portable game notation), or
 157      in fact almost any file that contains moves in algebraic notation.
 158      Notation of the form `P@f7' is accepted for piece-drops in
 159      bughouse games; this is a nonstandard extension to PGN.  If the
 160      file includes a PGN position (FEN tag), or an old-style XBoard
 161      position diagram bracketed by `[--' and `--]' before the first
 162      move, the game starts from that position. Text enclosed in
 163      parentheses, square brackets, or curly braces is assumed to be
 164      commentary and is displayed in a pop-up window. Any other text in
 165      the file is ignored. PGN variations (enclosed in parentheses) also
 166      are treated as comments; however, if you rights-click them in the
 167      comment window, XBoard will shelve the current line, and load the
 168      the selected variation, so you can step through it.  You can later
 169      revert to the previous line with the `Revert' command.  This way
 170      you can walk quite complex varation trees with XBoard.  The
 171      nonstandard PGN tag [Variant "varname"] functions similarly to the
 172      -variant command-line option (see below), allowing games in
 173      certain chess variants to be loaded.  Note that it must appear
 174      before any FEN tag for XBoard to recognize variant FENs
 175      appropriately.  There is also a heuristic to recognize chess
 176      variants from the Event tag, by looking for the strings that the
 177      Internet Chess Servers put there when saving variant ("wild")
 178      games.
 179
 180 Load Position
 181      Sets up a position from a position file.  A pop-up dialog prompts
 182      you for the file name.  The shifted `Ctrl-O' key is a keyboard
 183      equivalent. If the file contains more than one saved position, and
 184      you want to load the Nth one, type the number N after the file
 185      name, separated by a space. Position files must be in FEN
 186      (Forsythe-Edwards notation), or in the format that the Save
 187      Position command writes when oldSaveStyle is turned on.
 188
 189 Load Next Position
 190      Loads the next position from the last position file you loaded.
 191      The shifted `PgDn' key is a keyboard equivalent.
 192
 193 Load Previous Position
 194      Loads the previous position from the last position file you
 195      loaded. The shifted `PgUp' key is a keyboard equivalent.  Not
 196      available if the last position was loaded from a pipe.
 197
 198 Save Game
 199      Appends a record of the current game to a file.  The `Ctrl-S' key
 200      is a keyboard equivalent.  A pop-up dialog prompts you for the
 201      file name. If the game did not begin with the standard starting
 202      position, the game file includes the starting position used. Games
 203      are saved in the PGN (portable game notation) format, unless the
 204      oldSaveStyle option is true, in which case they are saved in an
 205      older format that is specific to XBoard. Both formats are
 206      human-readable, and both can be read back by the `Load Game'
 207      command.  Notation of the form `P@f7' is accepted for piece-drops
 208      in bughouse games; this is a nonstandard extension to PGN.
 209
 210 Save Position
 211      Appends a diagram of the current position to a file.  The shifted
 212      `Ctrl+S' key is a keyboard equivalent.  A pop-up dialog prompts
 213      you for the file name. Positions are saved in FEN
 214      (Forsythe-Edwards notation) format unless the `oldSaveStyle'
 215      option is true, in which case they are saved in an older,
 216      human-readable format that is specific to XBoard. Both formats can
 217      be read back by the `Load Position' command.
 218
 219 Mail Move
 220 Reload CMail Message
 221      See *note CMail::.
 222
 223 Exit
 224      Exits from XBoard. The `Ctrl-Q' key is a keyboard equivalent.
 225
 226 2.2 Edit Menu
 227 =============
 228
 229 Copy Game
 230      Copies a record of the current game to an internal clipboard in PGN
 231      format and sets the X selection to the game text. The `Ctrl-C' key
 232      is a keyboard equivalent. The game can be pasted to another
 233      application (such as a text editor or another copy of XBoard)
 234      using that application's paste command.  In many X applications,
 235      such as xterm and emacs, the middle mouse button can be used for
 236      pasting; in XBoard, you must use the Paste Game command.
 237
 238 Copy Position
 239      Copies the current position to an internal clipboard in FEN format
 240      and sets the X selection to the position text. The shifted
 241      `Ctrl-C' key is a keyboard equivalent.  The position can be pasted
 242      to another application (such as a text editor or another copy of
 243      XBoard) using that application's paste command.  In many X
 244      applications, such as xterm and emacs, the middle mouse button can
 245      be used for pasting; in XBoard, you must use the Paste Position
 246      command.
 247
 248 Paste Game
 249      Interprets the current X selection as a game record and loads it,
 250      as with Load Game. The `Ctrl-V' key is a keyboard equivalent.
 251
 252 Paste Position
 253      Interprets the current X selection as a FEN position and loads it,
 254      as with Load Position. The shifted `Ctrl-V' key is a keyboard
 255      equivalent.
 256
 257 Edit Game
 258      Allows you to make moves for both Black and White, and to change
 259      moves after backing up with the `Backward' command. The clocks do
 260      not run. The `Ctrl-E' key is a keyboard equivalent.
 261
 262      In chess engine mode, the chess engine continues to check moves
 263      for legality but does not participate in the game. You can bring
 264      the chess engine into the game by selecting `Machine White',
 265      `Machine Black', or `Two Machines'.
 266
 267      In ICS mode, the moves are not sent to the ICS: `Edit Game' takes
 268      XBoard out of ICS Client mode and lets you edit games locally.  If
 269      you want to edit games on ICS in a way that other ICS users can
 270      see, use the ICS `examine' command or start an ICS match against
 271      yourself.
 272
 273 Edit Position
 274      Lets you set up an arbitrary board position.  The shifted `Ctrl-E'
 275      key is a keyboard equivalent.  Use mouse button 1 to drag pieces
 276      to new squares, or to delete a piece by dragging it off the board
 277      or dragging an empty square on top of it.  To drop a new piece on
 278      a square, press mouse button 2 or 3 over the square. This brings
 279      up a menu of white pieces (button 2) or black pieces (button 3).
 280      Additional menu choices let you empty the square or clear the
 281      board. You can set the side to play next by clicking on the word
 282      White or Black at the top of the screen.  Selecting `Edit
 283      Position' causes XBoard to discard all remembered moves in the
 284      current game.
 285
 286      In ICS mode, changes made to the position by `Edit Position' are
 287      not sent to the ICS: `Edit Position' takes XBoard out of `ICS
 288      Client' mode and lets you edit positions locally. If you want to
 289      edit positions on ICS in a way that other ICS users can see, use
 290      the ICS `examine' command, or start an ICS match against yourself.
 291      (See also the ICS Client topic above.)
 292
 293 Edit Tags
 294      Lets you edit the PGN (portable game notation) tags for the
 295      current game. After editing, the tags must still conform to the
 296      PGN tag syntax:
 297
 298           <tag-section> ::= <tag-pair> <tag-section>
 299                                   <empty>
 300           <tag-pair> ::= [ <tag-name> <tag-value> ]
 301           <tag-name> ::= <identifier>
 302           <tag-value> ::= <string>
 303      See the PGN Standard for full details. Here is an example:
 304
 305           [Event "Portoroz Interzonal"]
 306           [Site "Portoroz, Yugoslavia"]
 307           [Date "1958.08.16"]
 308           [Round "8"]
 309           [White "Robert J. Fischer"]
 310           [Black "Bent Larsen"]
 311           [Result "1-0"]
 312      Any characters that do not match this syntax are silently ignored.
 313      Note that the PGN standard requires all games to have at least the
 314      seven tags shown above. Any that you omit will be filled in by
 315      XBoard with `?' (unknown value), or `-' (inapplicable value).
 316
 317 Edit Comment
 318      Adds or modifies a comment on the current position. Comments are
 319      saved by `Save Game' and are displayed by `Load Game', `Forward',
 320      and `Backward'.
 321
 322 Revert
 323 Annotate
 324      If you are examining an ICS game and Pause mode is off, Revert
 325      issues the ICS command `revert'.  In local mode, when you were
 326      editing or analyzing a game, and the `-variations' command-line
 327      option is switched on, you can start a new variation by holding
 328      the Shift key down while entering a move not at the end of the
 329      game.  Variations can also become the currently displayed line by
 330      clicking a PGN variation displayed in the Comment window.  This
 331      can be applied recursively, so that you can analyze variations on
 332      variations; each time you create a new variation by entering an
 333      alternative move with Shift pressed, or select a new one from the
 334      Comment window, the current variation will be shelved.  `Revert'
 335      allows you to return to the most recently shelved variation.  The
 336      difference between `Revert' and `Annotate' is that with the latter,
 337      the variation you are now abandoning will be added as a comment
 338      (in PGN variation syntax, i.e. between parentheses) to the
 339      original move where you deviated, for later recalling.  The `Home'
 340      key is a keyboard equivalent to `Revert'.
 341
 342 Truncate Game
 343      Discards all remembered moves of the game beyond the current
 344      position. Puts XBoard into `Edit Game' mode if it was not there
 345      already.  The `End' key is a keyboard equivalent.
 346
 347 Backward
 348      Steps backward through a series of remembered moves.  The `[<]'
 349      button and the `Alt+LeftArrow' key are equivalents, as is turning
 350      the mouse wheel towards you.  In addition, pressing the Control
 351      key steps back one move, and releasing it steps forward again.
 352
 353      In most modes, `Backward' only lets you look back at old positions;
 354      it does not retract moves. This is the case if you are playing
 355      against a chess engine, playing or observing a game on an ICS, or
 356      loading a game.  If you select `Backward' in any of these
 357      situations, you will not be allowed to make a different move. Use
 358      `Retract Move' or `Edit Game' if you want to change past moves.
 359
 360      If you are examining an ICS game, the behavior of `Backward'
 361      depends on whether XBoard is in Pause mode. If Pause mode is off,
 362      `Backward' issues the ICS backward command, which backs up
 363      everyone's view of the game and allows you to make a different
 364      move. If Pause mode is on, `Backward' only backs up your local
 365      view.
 366
 367 Forward
 368      Steps forward through a series of remembered moves (undoing the
 369      effect of `Backward') or forward through a game file. The `[>]'
 370      button and the `Alt+RightArrow' key are equivalents, as is turning
 371      the mouse wheel away from you.
 372
 373      If you are examining an ICS game, the behavior of Forward depends
 374      on whether XBoard is in Pause mode. If Pause mode is off,
 375      `Forward' issues the ICS forward command, which moves everyone's
 376      view of the game forward along the current line. If Pause mode is
 377      on, `Forward' only moves your local view forward, and it will not
 378      go past the position that the game was in when you paused.
 379
 380 Back to Start
 381      Jumps backward to the first remembered position in the game.  The
 382      `[<<]' button and the `Alt+Home' key are equivalents.
 383
 384      In most modes, Back to Start only lets you look back at old
 385      positions; it does not retract moves. This is the case if you are
 386      playing against a local chess engine, playing or observing a game
 387      on a chess server, or loading a game. If you select `Back to
 388      Start' in any of these situations, you will not be allowed to make
 389      different moves. Use `Retract Move' or `Edit Game' if you want to
 390      change past moves; or use Reset to start a new game.
 391
 392      If you are examining an ICS game, the behavior of `Back to Start'
 393      depends on whether XBoard is in Pause mode. If Pause mode is off,
 394      `Back to Start' issues the ICS `backward 999999' command, which
 395      backs up everyone's view of the game to the start and allows you
 396      to make different moves. If Pause mode is on, `Back to Start' only
 397      backs up your local view.
 398
 399 Forward to End
 400      Jumps forward to the last remembered position in the game. The
 401      `[>>]' button and the `Alt+End' key are equivalents.
 402
 403      If you are examining an ICS game, the behavior of `Forward to End'
 404      depends on whether XBoard is in Pause mode. If Pause mode is off,
 405      `Forward to End' issues the ICS `forward 999999' command, which
 406      moves everyone's view of the game forward to the end of the
 407      current line. If Pause mode is on, `Forward to End' only moves
 408      your local view forward, and it will not go past the position that
 409      the game was in when you paused.
 410
 411 2.3 View Menu
 412 =============
 413
 414 Flip View
 415      Inverts your view of the chess board for the duration of the
 416      current game. Starting a new game returns the board to normal.
 417      The `F2' key is a keyboard equivalent.
 418
 419 Show Engine Output
 420      Shows or hides a window in which the thinking output of any loaded
 421      engines is displayed. The shifted `Alt+O' key is a keyboard
 422      equivalent.  XBoard will display lines of thinking output of the
 423      same depth ordered by score, (highest score on top), rather than
 424      in the order the engine produced them.  Usually this amounts to
 425      the same, as a normal engine search will only find new PV (and
 426      emit it as thinking output) when it searches a move with a higher
 427      score than the previous variation.  But when the engine is in
 428      multi-variation mode this needs not always be true, and it is more
 429      convenient for someone analyzing games to see the moves sorted by
 430      score.  The order in which the engine found them is only of
 431      interest to the engine author, and can still be deduced from the
 432      time or node count printed with the line.
 433
 434 Show Move History
 435      Shows or hides a list of moves of the current game.  The shifted
 436      `Alt+H' key is a keyboard equivalent.  This list allows you to
 437      move the display to any earlier position in the game by clicking
 438      on the corresponding move.
 439
 440 Show Evaluation Graph
 441      Shows or hides a window which displays a graph of how the engine
 442      score(s) evolved as a function of the move number.  The shifted
 443      `Alt+E' key is a keyboard equivalent.  Clicking on the graph will
 444      bring the corresponding position in the board display.
 445
 446 Show Game List
 447      Shows or hides the list of games generated by the last `Load Game'
 448      command. The shifted `Alt+G' key is a keyboard equivalent.
 449
 450 Tags
 451      Pops up a window which shows the PGN (portable game notation) tags
 452      for the current game.  For now this is a duplicate of the `Edit
 453      Tags' item in the `Edit' menu.
 454
 455 Comments
 456      Pops up a window which shows any comments to or variations on the
 457      current move.  For now this is a duplicate of the `Edit Comment'
 458      item in the `Edit' menu.
 459
 460 ICS Input Box
 461      If this option is set in ICS mode, XBoard creates an extra window
 462      that you can use for typing in ICS commands.  The input box is
 463      especially useful if you want to type in something long or do some
 464      editing on your input, because output from ICS doesn't get mixed
 465      in with your typing as it would in the main terminal window.
 466
 467 2.4 Mode Menu
 468 =============
 469
 470 Machine White
 471      Tells the chess engine to play White.  The `Ctrl-W' key is a
 472      keyboard equivalent.
 473
 474 Machine Black
 475      Tells the chess engine to play Black.  The `Ctrl-B' key is a
 476      keyboard equivalent.
 477
 478 Two Machines
 479      Plays a game between two chess engines.  The `Ctrl-T' key is a
 480      keyboard equivalent.
 481
 482 Analysis Mode
 483      XBoard tells the chess engine to start analyzing the current
 484      game/position and shows you the analysis as you move pieces around.
 485      The `Ctrl-A' key is a keyboard equivalent.  Note: Some chess
 486      engines do not support Analysis mode.
 487
 488      To set up a position to analyze, you do the following:
 489
 490      1. Select Edit Position from the Mode Menu
 491
 492      2. Set up the position.  Use the middle and right buttons to bring
 493      up the white and black piece menus.
 494
 495      3. When you are finished, click on either the Black or White clock
 496      to tell XBoard which side moves first.
 497
 498      4. Select Analysis Mode from the Mode Menu to start the analysis.
 499
 500      The analysis function can also be used when observing games on an
 501      ICS with an engine loaded (zippy mode); the engine then will
 502      analyse the positions as they occur in the observed game.
 503
 504 Analyze File
 505      This option lets you load a game from a file (PGN, XBoard format,
 506      etc.)  and analyze it. The `Ctrl-F' key is a keyboard equivalent.
 507      When you select this menu item, a pop-up window appears and asks
 508      for a file name to load.  If the file contains multiple games,
 509      another pop up appears that lets you select which game you wish to
 510      analyze.  After a game is loaded, XBoard will start auto-playing
 511      the game, while the engine is analyzing the current position.  The
 512      game will be annotated with the results of these analyses.  In
 513      particlar, the score and depth will be added as a comment, and the
 514      PV will be added as a variation.  The time the engine spends on
 515      analyzing each move can be controlled through the command-line
 516      option `-timeDelay'.  Note: Some chess engines do not support
 517      Analysis mode.
 518
 519 Edit Game
 520      Duplicate of the item in the Edit menu.  Note that `Edit Game' is
 521      the idle mode of XBoard, and can be used to get you out of other
 522      modes. E.g. to stop analyzing, stop a game between two engines or
 523      stop editing a position.
 524
 525 Edit Position
 526      Duplicate of the item in the Edit menu.
 527
 528 Training
 529      Training mode lets you interactively guess the moves of a game for
 530      one of the players. You guess the next move of the game by playing
 531      the move on the board. If the move played matches the next move of
 532      the game, the move is accepted and the opponent's response is
 533      auto-played.  If the move played is incorrect, an error message is
 534      displayed.  You can select this mode only while loading a game
 535      (that is, after selecting `Load Game' from the File menu).  While
 536      XBoard is in `Training' mode, the navigation buttons are disabled.
 537
 538 ICS Client
 539      This is the normal mode when XBoard is connected to a chess
 540      server.  If you have moved into Edit Game or Edit Position mode,
 541      you can select this option to get out.
 542
 543      To use xboard in ICS mode, run it in the foreground with the -ics
 544      option, and use the terminal you started it from to type commands
 545      and receive text responses from the chess server.  See *note Chess
 546      Servers:: below for more information.
 547
 548      XBoard activates some special position/game editing features when
 549      you use the `examine' or `bsetup' commands on ICS and you have
 550      `ICS Client' selected on the Mode menu.  First, you can issue the
 551      ICS position-editing commands with the mouse.  Move pieces by
 552      dragging with mouse button 1.  To drop a new piece on a square,
 553      press mouse button 2 or 3 over the square.  This brings up a menu
 554      of white pieces (button 2) or black pieces (button 3).  Additional
 555      menu choices let you empty the square or clear the board.  Click
 556      on the White or Black clock to set the side to play.  You cannot
 557      set the side to play or drag pieces to arbitrary squares while
 558      examining on ICC, but you can do so in `bsetup' mode on FICS.  In
 559      addition, the menu commands `Forward', `Backward', `Pause', and
 560      `Stop Examining' have special functions in this mode; see below.
 561
 562 Pause
 563      Pauses updates to the board, and if you are playing against a
 564      chess engine, also pauses your clock. To continue, select `Pause'
 565      again, and the display will automatically update to the latest
 566      position.  The `P' button and keyboard `Pause' key are equivalents.
 567
 568      If you select Pause when you are playing against a chess engine and
 569      it is not your move, the chess engine's clock will continue to run
 570      and it will eventually make a move, at which point both clocks
 571      will stop. Since board updates are paused, however, you will not
 572      see the move until you exit from Pause mode (or select Forward).
 573      This behavior is meant to simulate adjournment with a sealed move.
 574
 575      If you select Pause while you are observing or examining a game on
 576      a chess server, you can step backward and forward in the current
 577      history of the examined game without affecting the other observers
 578      and examiners, and without having your display jump forward to the
 579      latest position each time a move is made. Select Pause again to
 580      reconnect yourself to the current state of the game on ICS.
 581
 582      If you select `Pause' while you are loading a game, the game stops
 583      loading. You can load more moves manually by selecting `Forward',
 584      or resume automatic loading by selecting `Pause' again.
 585
 586 2.5 Action Menu
 587 ===============
 588
 589 Accept
 590      Accepts a pending match offer.  The `F3' key is a keyboard
 591      equivalent.  If there is more than one offer pending, you will
 592      have to type in a more specific command instead of using this menu
 593      choice.
 594
 595 Decline
 596      Declines a pending offer (match, draw, adjourn, etc.).  The `F4'
 597      key is a keyboard equivalent. If there is more than one offer
 598      pending, you will have to type in a more specific command instead
 599      of using this menu choice.
 600
 601 Call Flag
 602      Calls your opponent's flag, claiming a win on time, or claiming a
 603      draw if you are both out of time.  The `F5' key is a keyboard
 604      equivalent.  You can also call your opponent's flag by clicking on
 605      his clock.
 606
 607 Draw
 608      Offers a draw to your opponent, accepts a pending draw offer from
 609      your opponent, or claims a draw by repetition or the 50-move rule,
 610      as appropriate. The `F6' key is a keyboard equivalent.
 611
 612 Adjourn
 613      Asks your opponent to agree to adjourning the current game, or
 614      agrees to a pending adjournment offer from your opponent.  The
 615      `F7' key is a keyboard equivalent.
 616
 617 Abort
 618      Asks your opponent to agree to aborting the current game, or
 619      agrees to a pending abort offer from your opponent.  The `F8' key
 620      is a keyboard equivalent. An aborted game ends immediately without
 621      affecting either player's rating.
 622
 623 Resign
 624      Resigns the game to your opponent. The `F9' key is a keyboard
 625      equivalent.
 626
 627 Stop Observing
 628      Ends your participation in observing a game, by issuing the ICS
 629      observe command with no arguments. ICS mode only.  The `F10' key
 630      is a keyboard equivalent.
 631
 632 Stop Examining
 633      Ends your participation in examining a game, by issuing the ICS
 634      unexamine command. ICS mode only.  The `F11' key is a keyboard
 635      equivalent.
 636
 637 Upload to Examine
 638      Create an examined game of the proper variant on the ICS, and send
 639      the game there that is currenty loaded in XBoard (e.g. through
 640      pasting or loading from file).  You must be connected to an ICS
 641      for this to work.
 642
 643 Adjudicate to White
 644 Adjudicate to Black
 645 Adjudicate Draw
 646      Terminate an ongoing game in Two-Machines mode (including match
 647      mode), with as result a win for white, for black, or a draw,
 648      respectively.  The PGN file of the game will accompany the result
 649      string by the comment "user adjudication".
 650
 651 2.6 Engine Menu
 652 ===============
 653
 654 Engine #N Settings
 655      Pop up a menu dialog to alter the settings specific to the
 656      applicable engine.  (The second engine is only accessible once it
 657      has been used in Two-Machines mode.)  For each parameter the
 658      engine allows to be set, a control element will appear in this
 659      dialog that can be used to alter the value.  Depending on the type
 660      of parameter (text string, number, multiple choice, on/off switch,
 661      instantaneous signal) the appropriate control will appear, with a
 662      description next to it.  XBoard has no idea what these values
 663      mean; it just passes them on to the engine.  How this dialog looks
 664      is completely determined by the engine, and XBoard just passes it
 665      on to the user.  Many engines do not have any parameters that can
 666      be set by the user, and in that case the dialog will be empty
 667      (except for the OK and cancel buttons).  UCI engines usually have
 668      many parameters. (But these are only visible with a sufficiently
 669      modern version of the Polyglot adapter needed to run UCI engines,
 670      e.g. Polyglot 1.4.55b.) For native XBoard engines this is less
 671      common.
 672
 673 Hint
 674      Displays a move hint from the chess engine.
 675
 676 Book
 677      Displays a list of possible moves from the chess engine's opening
 678      book.  The exact format depends on what chess engine you are using.
 679      With GNU Chess 4, the first column gives moves, the second column
 680      gives one possible response for each move, and the third column
 681      shows the number of lines in the book that include the move from
 682      the first column. If you select this option and nothing happens,
 683      the chess engine is out of its book or does not support this
 684      feature.
 685
 686 Move Now
 687      Forces the chess engine to move immediately. Chess engine mode
 688      only.  The `Ctrl-M' key is a keyboard equivalent.
 689
 690 Retract Move
 691      Retracts your last move. In chess engine mode, you can do this only
 692      after the chess engine has replied to your move; if the chess
 693      engine is still thinking, use `Move Now' first. In ICS mode,
 694      `Retract Move' issues the command `takeback 1' or `takeback 2'
 695      depending on whether it is your opponent's move or yours.  The
 696      `Ctrl-X' key is a keyboard equivalent.
 697
 698 2.7 Options Menu
 699 ================
 700
 701 Time Control
 702      Pops up a sub-menu where you can set the time-control parameters
 703      interactively.  Allows you to select classical or incremental time
 704      controls, set the moves per session, session duration, and time
 705      increment.  Also allows specification of time-odds factors for one
 706      or both engines.  If an engine is given a time-odds factor N, all
 707      time quota it gets, be it at the beginning of a session or through
 708      the time increment or fixed time per move, will be divided by N.
 709      The shifted `Alt+T' key is a keyboard equivalent.
 710
 711 Common Engine
 712      Pops up a sub-menu where you can set some engine parameters common
 713      to most engines, such as hash-table size, tablebase cache size,
 714      maximum number of processors that SMP engines can use, and where
 715      to find the Polyglot adapter needed to run UCI engines under
 716      XBoard. The feature that allows setting of these parameters on
 717      engines is new since XBoard 4.3.15, so not many XBoard/WinBoard
 718      engines respond to it yet, but UCI engines should.  It is also
 719      possible to specify a GUI opening book here, i.e. an opening book
 720      that XBoard consults for any position a playing engine gets in.
 721      It then forces the engine to play the book move, rather than to
 722      think up its own, if that position is found in the book.  The book
 723      can switched on and off independently for either engine.  The
 724      shifted `Alt+U' key is a keyboard equivalent.
 725
 726 Adjudications
 727      Pops up a sub-menu where you can enable or disable various
 728      adjudications that XBoard can perform in engine-engine games.  The
 729      shifted `Alt+J' key is a keyboard equivalent.  You can instruct
 730      XBoard to detect and terminate the game on checkmate or stalemate,
 731      even if the engines would not do so, to verify engine result
 732      claims (forfeiting engines that make false claims), rather than
 733      naively following the engine, to declare draw on positions which
 734      can never be won for lack of mating material, (e.g. KBK), or which
 735      are impossible to win unless the opponent seeks its own demise
 736      (e.g. KBKN).  For these adjudications to work, `Test Legality'
 737      should be switched on.  It is also possible to instruct XBoard to
 738      enforce a 50-move or 3-fold-repeat rule and automatically declare
 739      draw (after a user-adjustable number of moves or repeats) even if
 740      the engines are prepared to go on.  It is also possible to have
 741      XBoard declare draw on games that seem to drag on forever, or
 742      adjudicate a loss if both engines agree (for 3 consecutive moves)
 743      that one of them is behind more than a user-adjustable score
 744      threshold.  For the latter adjudication to work, XBoard should be
 745      able to properly understand the engine's scores. To facilitate the
 746      latter, you can inform xboard here if the engines report scores
 747      from the viewpoint of white, or from that of their own color.
 748
 749 Game List
 750      Pops up a dialog where you can select the PGN tags that should
 751      appear on the lines in the game list, and their order.
 752
 753 Always Queen
 754      If this option is off, XBoard brings up a dialog box whenever you
 755      move a pawn to the last rank, asking what piece you want to
 756      promote it to. If the option is true, your pawns are always
 757      promoted to queens. Your opponent can still under-promote.  The
 758      shifted `Ctrl-Q' key is a keyboard equivalent.
 759
 760 Animate Dragging
 761      If Animate Dragging is on, while you are dragging a piece with the
 762      mouse, an image of the piece follows the mouse cursor.  If Animate
 763      Dragging is off, there is no visual feedback while you are
 764      dragging a piece, but if Animate Moving is on, the move will be
 765      animated when it is complete.
 766
 767 Animate Moving
 768      If Animate Moving is on, all piece moves are animated.  An image
 769      of the piece is shown moving from the old square to the new square
 770      when the move is completed (unless the move was already animated
 771      by Animate Dragging).  If Animate Moving is off, a moved piece
 772      instantly disappears from its old square and reappears on its new
 773      square when the move is complete.  The shifted `Ctrl-A' key is a
 774      keyboard equivalent.
 775
 776 Auto Comment
 777      If this option is on, any remarks made on ICS while you are
 778      observing or playing a game are recorded as a comment on the
 779      current move.  This includes remarks made with the ICS commands
 780      `say', `tell', `whisper', and `kibitz'.  Limitation: remarks that
 781      you type yourself are not recognized; XBoard scans only the output
 782      from ICS, not the input you type to it.
 783
 784 Auto Flag
 785      If this option is on and one player runs out of time before the
 786      other, XBoard will automatically call his flag, claiming a win on
 787      time.  The shifted `Ctrl-F' key is a keyboard equivalent.  In ICS
 788      mode, Auto Flag will only call your opponent's flag, not yours,
 789      and the ICS may award you a draw instead of a win if you have
 790      insufficient mating material.  In local chess engine mode, XBoard
 791      may call either player's flag and will not take material into
 792      account (?).
 793
 794 Auto Flip View
 795      If the Auto Flip View option is on when you start a game, the board
 796      will be automatically oriented so that your pawns move from the
 797      bottom of the window towards the top.
 798
 799 Auto Observe
 800      If this option is on and you add a player to your `gnotify' list
 801      on ICS, XBoard will automatically observe all of that player's
 802      games, unless you are doing something else (such as observing or
 803      playing a game of your own) when one starts.  The games are
 804      displayed from the point of view of the player on your gnotify
 805      list; that is, his pawns move from the bottom of the window
 806      towards the top.  Exceptions:  If both players in a game are on
 807      your gnotify list, if your ICS `highlight' variable is set to 0,
 808      or if the ICS you are using does not properly support observing
 809      from Black's point of view, you will see the game from White's
 810      point of view.
 811
 812 Auto Raise Board
 813      If this option is on, whenever a new game begins, the chessboard
 814      window is deiconized (if necessary) and raised to the top of the
 815      stack of windows.
 816
 817 Auto Save
 818      If this option is true, at the end of every game XBoard prompts
 819      you for a file name and appends a record of the game to the file
 820      you specify.  Disabled if the `saveGameFile' command-line option
 821      is set, as in that case all games are saved to the specified file.
 822      *Note Load and Save options::.
 823
 824 Blindfold
 825      If this option is on, XBoard displays the board as usual but does
 826      not display pieces or move highlights.  You can still move in the
 827      usual way (with the mouse or by typing moves in ICS mode), even
 828      though the pieces are invisible.
 829
 830 Flash Moves
 831      If this option is on, whenever a move is completed, the moved
 832      piece flashes.  The number of times to flash is set by the
 833      flashCount command-line option; it defaults to 3 if Flash Moves is
 834      first turned on from the menu.
 835
 836      If you are playing a game on an ICS, the board is always oriented
 837      at the start of the game so that your pawns move from the bottom
 838      of the window towards the top. Otherwise, the starting orientation
 839      is determined by the `flipView' command line option; if it is
 840      false (the default), White's pawns move from bottom to top at the
 841      start of each game; if it is true, Black's pawns move from bottom
 842      to top. *Note User interface options::.
 843
 844 Get Move List
 845      If this option is on, whenever XBoard receives the first board of
 846      a new ICS game (or a different game from the one it is currently
 847      displaying), it retrieves the list of past moves from the ICS.
 848      You can then review the moves with the `Forward' and `Backward'
 849      commands or save them with `Save Game'.  You might want to turn
 850      off this option if you are observing several blitz games at once,
 851      to keep from wasting time and network bandwidth fetching the move
 852      lists over and over.  When you turn this option on from the menu,
 853      XBoard immediately fetches the move list of the current game (if
 854      any).
 855
 856 Highlight Dragging
 857      If Highlight Dragging is on, and the option -showTargetSquares is
 858      also on in the settings file, all squares a piece that is 'picked
 859      up' with the mouse can legally move to are highighted with a fat
 860      colored dot in the highlightColor (non-captures) or
 861      premoveHighlightColor (captures).  Legality testing must be on for
 862      XBoard to know how the piece moves.
 863
 864 Highlight Last Move
 865      If Highlight Last Move is on, after a move is made, the starting
 866      and ending squares remain highlighted. In addition, after you use
 867      Backward or Back to Start, the starting and ending squares of the
 868      last move to be unmade are highlighted.
 869
 870 Highlight with Arrow
 871      Causes the highlighting described in Highlight Last Move to be done
 872      by drawing an arrow between the highlighted squares, so that it is
 873      visible even when the width of the grid lines is set to zero.
 874
 875 Move Sound
 876      If this option is on, XBoard alerts you by playing a sound after
 877      each of your opponent's moves (or after every move if you are
 878      observing a game on the Internet Chess Server).  The sound is not
 879      played after moves you make or moves read from a saved game file.
 880      By default, the sound is the terminal bell, but on some systems
 881      you can change it to a sound file using the soundMove option; see
 882      below.
 883
 884      If you turn on this option when using XBoard with the Internet
 885      Chess Server, you will probably want to give the `set bell 0'
 886      command to the ICS, since otherwise the ICS will ring the terminal
 887      bell after every move (not just yours). (The `.icsrc' file is a
 888      good place for this; see *note ICS options::.)
 889
 890 ICS Alarm
 891      When this option is on, an alarm sound is played when your clock
 892      counts down to the icsAlarmTime (by default, 5 seconds) in an ICS
 893      game.  For games with time controls that include an increment, the
 894      alarm will sound each time the clock counts down to the
 895      icsAlarmTime.  By default, the alarm sound is the terminal bell,
 896      but on some systems you can change it to a sound file using the
 897      soundIcsAlarm option; see below.
 898
 899 One-Click Moving
 900      If this option is on, XBoard does not wait for you to click both
 901      the from- and the to-square, or drag the piece, but performs a
 902      move as soon as it is uniqely specified.  This applies to clicking
 903      an own piece that only has a single legal move, clicking an empty
 904      square or opponent piece where only one of your pieces can move
 905      (or capture) to.  Furthermore, a double-click on a piece that can
 906      only make a single capture will cause that capture to be made.
 907      Promoting a Pawn by clicking its to-square will suppress the
 908      promotion popup, and make it promote to Queen.
 909
 910 Periodic Updates
 911      If this option is off (or if you are using a chess engine that
 912      does not support periodic updates), the analysis window will only
 913      be updated when the analysis changes. If this option is on, the
 914      Analysis Window will be updated every two seconds.
 915
 916 Ponder Next Move
 917      If this option is off, the chess engine will think only when it is
 918      on move.  If the option is on, the engine will also think while
 919      waiting for you to make your move.  The shifted `Ctrl-P' key is a
 920      keyboard equivalent.
 921
 922 Popup Exit Message
 923      If this option is on, when XBoard wants to display a message just
 924      before exiting, it brings up a modal dialog box and waits for you
 925      to click OK before exiting.  If the option is off, XBoard prints
 926      the message to standard error (the terminal) and exits immediately.
 927
 928 Popup Move Errors
 929      If this option is off, when you make an error in moving (such as
 930      attempting an illegal move or moving the wrong color piece), the
 931      error message is displayed in the message area.  If the option is
 932      on, move errors are displayed in small pop-up windows like other
 933      errors.  You can dismiss an error pop-up either by clicking its OK
 934      button or by clicking anywhere on the board, including
 935      down-clicking to start a move.
 936
 937 Premove
 938      If this option is on while playing a game on an ICS, you can
 939      register your next planned move before it is your turn.  Move the
 940      piece with the mouse in the ordinary way, and the starting and
 941      ending squares will be highlighted with a special color (red by
 942      default).  When it is your turn, if your registered move is legal,
 943      XBoard will send it to ICS immediately; if not, it will be ignored
 944      and you can make a different move.  If you change your mind about
 945      your premove, either make a different move, or double-click on any
 946      piece to cancel the move entirely.
 947
 948 Quiet Play
 949      If this option is on, XBoard will automatically issue an ICS `set
 950      shout 0' command whenever you start a game and a `set shout 1'
 951      command whenever you finish one.  Thus, you will not be distracted
 952      by shouts from other ICS users while playing.
 953
 954 Show Coords
 955      If this option is on, XBoard displays algebraic coordinates along
 956      the board's left and bottom edges.
 957
 958 Hide Thinking
 959      If this option is off, the chess engine's notion of the score and
 960      best line of play from the current position is displayed as it is
 961      thinking. The score indicates how many pawns ahead (or if negative,
 962      behind) the chess engine thinks it is. In matches between two
 963      machines, the score is prefixed by `W' or `B' to indicate whether
 964      it is showing White's thinking or Black's, and only the thinking
 965      of the engine that is on move is shown.  The shifted `Ctrl-H' key
 966      is a keyboard equivalent.
 967
 968 Test Legality
 969      If this option is on, XBoard tests whether the moves you try to
 970      make with the mouse are legal and refuses to let you make an
 971      illegal move.  The shifted `Ctrl-L' key is a keyboard equivalent.
 972      Moves loaded from a file with `Load Game' are also checked.  If
 973      the option is off, all moves are accepted, but if a local chess
 974      engine or the ICS is active, they will still reject illegal moves.
 975      Turning off this option is useful if you are playing a chess
 976      variant with rules that XBoard does not understand.  (Bughouse,
 977      suicide, and wild variants where the king may castle after
 978      starting on the d file are generally supported with Test Legality
 979      on.)
 980
 981 Save Settings Now
 982      Selecting this menu item causes the current XBoard settings to be
 983      written to the settings file, so they will also apply in future
 984      sessions.  Note that some settings are 'volatile', and are not
 985      saved, because XBoard considers it too unlikely that you want
 986      those to apply next time.  In particular this applies to the Chess
 987      program names, and all options giving information on those Chess
 988      programs (such as their directory, if they have their own opening
 989      book, if they are UCI or native XBoard), or the variant you are
 990      playing.  Such options would still be understood when they appear
 991      in the settings file in case they were put there with the aid of a
 992      text editor, but they would disappear from the file as soon as you
 993      save the settings.
 994
 995 Save Settings on Exit
 996      Setting this option has no immediate effect, but causes the
 997      settings to be saved when you quit XBoard. What happens then is
 998      otherwise identical to what happens when you use select "Save
 999      Settings Now", see there.
1000
1001 2.8 Help Menu
1002 =============
1003
1004 Info XBoard
1005      Displays the XBoard documentation in info format.  For this
1006      feature to work, you must have the GNU info program installed on
1007      your system, and the file `xboard.info' must either be present in
1008      the current working directory, or have been installed by the `make
1009      install' command when you built XBoard.
1010
1011 Man XBoard
1012      Displays the XBoard documentation in man page format.  The `F1'
1013      key is a keyboard equivalent.  For this feature to work, the file
1014      `xboard.6' must have been installed by the `make install' command
1015      when you built XBoard, and the directory it was placed in must be
1016      on the search path for your system's `man' command.
1017
1018 About XBoard
1019      Shows the current XBoard version number.
1020
1021 2.9 Other Shortcut Keys
1022 =======================
1023
1024 Iconize
1025      Pressing the `-' key iconizes XBoard. The graphical icon displays
1026      a white knight if it is White's move, or a black knight if it is
1027      Black's move. If your X window manager displays only text icons,
1028      not graphical ones, check its documentation; there is probably a
1029      way to enable graphical icons.  If you get black and white
1030      reversed, we would like to hear about it; see *note Problems::
1031      below for instructions on how to report this problem.
1032
1033 Load Next Game
1034      Loads the next game from the last game record file you loaded.
1035      The `Alt+PgDn' key is a keyboard equivalent.
1036
1037 Load Previous Game
1038      Loads the previous game from the last game record file you loaded.
1039      The `Alt+PgUp' key is a keyboard equivalent.  Not available if the
1040      last game was loaded from a pipe.
1041
1042 Reload Same Game
1043      Reloads the last game you loaded.  Not available if the last game
1044      was loaded from a pipe.
1045
1046 Reload Same Position
1047      Reloads the last position you loaded.  Not available if the last
1048      position was loaded from a pipe.
1049
1050    You can add or remove shortcut keys using the X resources
1051 `form.translations'. Here is an example of what would go in your
1052 `.Xresources' file:
1053
1054      XBoard*form.translations: \
1055        Shift<Key>?: AboutGameProc() \n\
1056        <Key>y: AcceptProc() \n\
1057        <Key>n: DeclineProc() \n\
1058        <Key>i: NothingProc()
1059    Binding a key to `NothingProc' makes it do nothing, thus removing it
1060 as a shortcut key. The XBoard commands that can be bound to keys are:
1061
1062      AbortProc, AboutGameProc, AboutProc, AcceptProc, AdjournProc,
1063      AlwaysQueenProc, AnalysisModeProc, AnalyzeFileProc,
1064      AnimateDraggingProc, AnimateMovingProc, AutobsProc, AutoflagProc,
1065      AutoflipProc, AutoraiseProc, AutosaveProc, BackwardProc,
1066      BlindfoldProc, BookProc, CallFlagProc, CopyGameProc, CopyPositionProc,
1067      DebugProc, DeclineProc, DrawProc, EditCommentProc, EditGameProc,
1068      EditPositionProc, EditTagsProc, EnterKeyProc, FlashMovesProc,
1069      FlipViewProc, ForwardProc, GetMoveListProc, HighlightLastMoveProc,
1070      HintProc, Iconify, IcsAlarmProc, IcsClientProc, IcsInputBoxProc,
1071      InfoProc, LoadGameProc, LoadNextGameProc, LoadNextPositionProc,
1072      LoadPositionProc, LoadPrevGameProc, LoadPrevPositionProc,
1073      LoadSelectedProc, MachineBlackProc, MachineWhiteProc, MailMoveProc,
1074      ManProc, MoveNowProc, MoveSoundProc, NothingProc, OldSaveStyleProc,
1075      PasteGameProc, PastePositionProc, PauseProc, PeriodicUpdatesProc,
1076      PonderNextMoveProc, PopupExitMessageProc, PopupMoveErrorsProc,
1077      PremoveProc, QuietPlayProc, QuitProc, ReloadCmailMsgProc,
1078      ReloadGameProc, ReloadPositionProc, RematchProc, ResetProc,
1079      ResignProc, RetractMoveProc, RevertProc, SaveGameProc,
1080      SavePositionProc, ShowCoordsProc, ShowGameListProc, ShowThinkingProc,
1081      StopExaminingProc, StopObservingProc, TestLegalityProc, ToEndProc,
1082      ToStartProc, TrainingProc, TruncateGameProc, and TwoMachinesProc.
1083
1084 3 Options
1085 *********
1086
1087 This section documents the command-line options to XBoard.  You can set
1088 these options in two ways: by typing them on the shell command line you
1089 use to start XBoard, or by setting them as X resources (typically in
1090 your `.Xresources' file).  Many of the options cannot be changed while
1091 XBoard is running; others set the initial state of items that can be
1092 changed with the *note Options:: menu.
1093
1094    Most of the options have both a long name and a short name. To turn a
1095 boolean option on or off from the command line, either give its long
1096 name followed by the value true or false (`-longOptionName true'), or
1097 give just the short name to turn the option on (`-opt'), or the short
1098 name preceded by `x' to turn the option off (`-xopt'). For options that
1099 take strings or numbers as values, you can use the long or short option
1100 names interchangeably.
1101
1102    Each option corresponds to an X resource with the same name, so if
1103 you like, you can set options in your `.Xresources' file or in a file
1104 named `XBoard' in your home directory.  For options that have two
1105 names, the longer one is the name of the corresponding X resource; the
1106 short name is not recognized.  To turn a boolean option on or off as an
1107 X resource, give its long name followed by the value true or false
1108 (`XBoard*longOptionName: true').
1109
1110 3.1 Chess Engine Options
1111 ========================
1112
1113 -tc or -timeControl minutes[:seconds]
1114      Each player begins with his clock set to the `timeControl' period.
1115      Default: 5 minutes.  The additional options `movesPerSession' and
1116      `timeIncrement' are mutually exclusive.
1117
1118 -mps or -movesPerSession moves
1119      When both players have made `movesPerSession' moves, a new
1120      `timeControl' period is added to both clocks.  Default: 40 moves.
1121
1122 -inc or -timeIncrement seconds
1123      If this option is specified, `movesPerSession' is ignored.
1124      Instead, after each player's move, `timeIncrement' seconds are
1125      added to his clock.  Use `-inc 0' if you want to require the entire
1126      game to be played in one `timeControl' period, with no increment.
1127      Default: -1, which specifies `movesPerSession' mode.
1128
1129 -clock/-xclock or -clockMode true/false
1130      Determines whether or not to display the chess clocks. If
1131      clockMode is false, the clocks are not shown, but the side that is
1132      to play next is still highlighted. Also, unless `searchTime' is
1133      set, the chess engine still keeps track of the clock time and uses
1134      it to determine how fast to make its moves.
1135
1136 -st or -searchTime minutes[:seconds]
1137      Tells the chess engine to spend at most the given amount of time
1138      searching for each of its moves. Without this option, the chess
1139      engine chooses its search time based on the number of moves and
1140      amount of time remaining until the next time control.  Setting
1141      this option also sets clockMode to false.
1142
1143 -depth or -searchDepth number
1144      Tells the chess engine to look ahead at most the given number of
1145      moves when searching for a move to make. Without this option, the
1146      chess engine chooses its search depth based on the number of moves
1147      and amount of time remaining until the next time control.  With
1148      the option, the engine will cut off its search early if it reaches
1149      the specified depth.
1150
1151 -firstNPS number
1152 -secondNPS number
1153      Tells the chess engine to use an internal time standard based on
1154      its node count, rather then wall-clock time, to make its timing
1155      decisions.  The time in virtual seconds should be obtained by
1156      dividing the node count through the given number, like the number
1157      was a rate in nodes per second.  Xboard will manage the clocks in
1158      accordance with this, relying on the number of nodes reported by
1159      the engine in its thinking output. If the given number equals zero,
1160      it can obviously not be used to convert nodes to seconds, and the
1161      time reported by the engine is used to decrement the XBoard clock
1162      in stead. The engine is supposed to report in CPU time it uses,
1163      rather than wall-clock time, in this mode. This option can provide
1164      fairer conditions for engine-engine matches on heavily loaded
1165      machines, or with very fast games (where the wall clock is too
1166      inaccurate).  `showThinking' must be on for this option to work.
1167      Default: -1 (off).  Not many engines might support this yet!
1168
1169 -firstTimeOdds factor
1170 -secondTimeOdds factor
1171      Reduces the time given to the mentioned engine by the given factor.
1172      If pondering is off, the effect is indistinguishable from what
1173      would happen if the engine was running on an n-times slower
1174      machine. Default: 1.
1175
1176 -timeOddsMode mode
1177      This option determines how the case is handled where both engines
1178      have a time-odds handicap.  If mode=1, the engine that gets the
1179      most time will always get the nominal time, as specified by the
1180      time-control options, and its opponent's time is renormalized
1181      accordingly.  If mode=0, both play with reduced time. Default: 0.
1182
1183 -hideThinkingFromHuman true/false
1184      Controls the Hide Thinking option. *Note Options Menu::. Default:
1185      true.  (Replaces the Show-Thinking option of older xboard
1186      versions.)
1187
1188 -thinking/-xthinking or -showThinking true/false
1189      Forces the engine to send thinking output to xboard.  Used to be
1190      the only way to control if thinking output was displayed in older
1191      xboard versions, but as the thinking output in xboard 4.3 is also
1192      used for several other purposes (adjudication, storing in PGN
1193      file) the display of it is now controlled by the new option Hide
1194      Thinking. *Note Options Menu::. Default: false.  (But if xboard
1195      needs the thinking output for some purpose, it makes the engine
1196      send it despite the setting of this option.)
1197
1198 -ponder/-xponder or -ponderNextMove true/false
1199      Sets the Ponder Next Move menu option. *Note Options Menu::.
1200      Default: true.
1201
1202 -smpCores number
1203      Specifies the maximum number of CPUs an SMP engine is allowed to
1204      use.  Only works for engines that support the
1205      XBoard/WinBoard-protocol cores feature.
1206
1207 -mg or -matchGames n
1208      Automatically runs an n-game match between two chess engines, with
1209      alternating colors.  If the `loadGameFile' or `loadPositionFile'
1210      option is set, XBoard starts each game with the given opening
1211      moves or the given position; otherwise, the games start with the
1212      standard initial chess position.  If the `saveGameFile' option is
1213      set, a move record for the match is appended to the specified
1214      file. If the `savePositionFile' option is set, the final position
1215      reached in each game of the match is appended to the specified
1216      file. When the match is over, XBoard displays the match score and
1217      exits. Default: 0 (do not run a match).
1218
1219 -mm/-xmm or -matchMode true/false
1220      Setting `matchMode' to true is equivalent to setting `matchGames'
1221      to 1.
1222
1223 -sameColorGames n
1224      Automatically runs an n-game match between two chess engines,
1225      without alternating colors.  Otherwise the same applies as for the
1226      `-matchGames' option, over which it takes precedence if both are
1227      specified. (See there.)  Default: 0 (do not run a match).
1228
1229 -fcp or -firstChessProgram program
1230      Name of first chess engine.  Default: `Fairy-Max'.
1231
1232 -scp or -secondChessProgram program
1233      Name of second chess engine, if needed.  A second chess engine is
1234      started only in Two Machines (match) mode.  Default: `Fairy-Max'.
1235
1236 -fb/-xfb or -firstPlaysBlack true/false
1237      In games between two chess engines, firstChessProgram normally
1238      plays white.  If this option is true, firstChessProgram plays
1239      black.  In a multi-game match, this option affects the colors only
1240      for the first game; they still alternate in subsequent games.
1241
1242 -fh or -firstHost host
1243 -sh or -secondHost host
1244      Hosts on which the chess engines are to run. The default for each
1245      is `localhost'. If you specify another host, XBoard uses `rsh' to
1246      run the chess engine there. (You can substitute a different remote
1247      shell program for rsh using the `remoteShell' option described
1248      below.)
1249
1250 -fd or -firstDirectory dir
1251 -sd or -secondDirectory dir
1252      Working directories in which the chess engines are to be run.  The
1253      default is "", which means to run the chess engine in the same
1254      working directory as XBoard itself.  (See the CHESSDIR environment
1255      variable.)  This option is effective only when the chess engine is
1256      being run on the local host; it does not work if the engine is run
1257      remotely using the -fh or -sh option.
1258
1259 -initString string
1260 -secondInitString string
1261      The string that is sent to initialize each chess engine for a new
1262      game.  Default:
1263
1264           new
1265           random
1266      Setting this option from the command line is tricky, because you
1267      must type in real newline characters, including one at the very
1268      end.  In most shells you can do this by entering a `\' character
1269      followed by a newline. It is easier to set the option from your
1270      `.Xresources' file; in that case you can include the character
1271      sequence `\n' in the string, and it will be converted to a newline.
1272
1273      If you change this option, don't remove the `new' command; it is
1274      required by all chess engines to start a new game.
1275
1276      You can remove the `random' command if you like; including it
1277      causes GNU Chess 4 to randomize its move selection slightly so
1278      that it doesn't play the same moves in every game.  Even without
1279      `random', GNU Chess 4 randomizes its choice of moves from its
1280      opening book.  Many other chess engines ignore this command
1281      entirely and always (or never) randomize.
1282
1283      You can also try adding other commands to the initString; see the
1284      documentation of the chess engine you are using for details.
1285
1286 -firstComputerString string
1287 -secondComputerString string
1288      The string that is sent to the chess engine if its opponent is
1289      another computer chess engine.  The default is `computer\n'.
1290      Probably the only useful alternative is the empty string (`'),
1291      which keeps the engine from knowing that it is playing another
1292      computer.
1293
1294 -reuse/-xreuse or -reuseFirst true/false
1295 -reuse2/-xreuse2 or -reuseSecond true/false
1296      If the option is false, XBoard kills off the chess engine after
1297      every game and starts it again for the next game.  If the option
1298      is true (the default), XBoard starts the chess engine only once
1299      and uses it repeatedly to play multiple games.  Some old chess
1300      engines may not work properly when reuse is turned on, but
1301      otherwise games will start faster if it is left on.
1302
1303 -firstProtocolVersion version-number
1304 -secondProtocolVersion version-number
1305      This option specifies which version of the chess engine
1306      communication protocol to use.  By default, version-number is 2.
1307      In version 1, the "protover" command is not sent to the engine;
1308      since version 1 is a subset of version 2, nothing else changes.
1309      Other values for version-number are not supported.
1310
1311 -firstScoreAbs true/false
1312 -secondScoreAbs true/false
1313      If this option is set, the score reported by the engine is taken
1314      to be that in favor of white, even when the engine plays black.
1315      Important when XBoard uses the score for adjudications, or in PGN
1316      reporting.
1317
1318 -niceEngines priority
1319      This option allows you to lower the priority of the engine
1320      processes, so that the generally insatiable hunger for CPU time of
1321      chess engines does not interfere so much with smooth operation of
1322      XBoard (or the rest of your system).  Negative values could
1323      increase the engine priority, which is not recommended.
1324
1325 -firstOptions string
1326 -secondOptions string
1327      The given string is a comma-separated list of (option name=option
1328      value) pairs, like the following example: "style=Karpov,blunder
1329      rate=0".  If an option announced by the engine at startup through
1330      the feature commands of the XBoard/WinBoard protocol matches one
1331      of the option names (i.e. "style" or "blunder rate"), it would be
1332      set to the given value (i.e. "Karpov" or 0) through a
1333      corresponding option command to the engine.  This provided that
1334      the type of the value (text or numeric) matches as well.
1335
1336 -firstNeedsNoncompliantFEN string
1337 -secondNeedsNoncompliantFEN string
1338      The castling rights and e.p. fields of the FEN sent to the
1339      mentioned engine with the setboard command will be replaced by the
1340      given string. This can for instance be used to run engines that do
1341      not understand Chess960 FENs in variant fischerandom, to make them
1342      at least understand the opening position, through setting the
1343      string to "KQkq -". (Note you also have to give the e.p. field!)
1344      Other possible applications are to provide work-arounds for
1345      engines that want to see castling and e.p. fields in variants that
1346      do not have castling or e.p.  (shatranj, courier, xiangqi, shogi)
1347      so that XBoard would normally omit them (string = "- -"), or to
1348      add variant-specific fields that are not yet supported by XBoard
1349      (e.g. to indicate the number of checks in 3check).
1350
1351 -shuffleOpenings
1352      Forces shuffling of the opening setup in variants that normally
1353      have a fixed initial position.  Shufflings are symmetric for black
1354      and white, and exempt King and Rooks in variants with normal
1355      castling.  Remains in force until a new variant is selected.
1356
1357 3.2 UCI + WB Engine Settings
1358 ============================
1359
1360 -fUCI or -firstIsUCI true/false
1361 -sUCI or -secondIsUCI true/false
1362      Indicates if the mentioned engine executable file is an UCI engine,
1363      and should be run with the aid of the Polyglot adapter rather than
1364      directly.  Xboard will then pass the other UCI options and engine
1365      name to Polyglot through a .ini temporary file created for the
1366      purpose.
1367
1368 -PolyglotDir filename
1369      Gives the name of the directory in which the Polyglot adapter for
1370      UCI engines expects its files.  Default:
1371      "/usr/local/share/polyglot".
1372
1373 -usePolyglotBook true/false
1374      Specifies if the Polyglot book should be used.
1375
1376 -PolyglotBook filename
1377      Gives the filename of the opening book that Polyglot should use.
1378      From XBoard 4.3.15 on, native XBoard/WinBoard engines will also
1379      use the opening book specified here, provided the
1380      `usePolyglotBook' option is set to true, and the option
1381      `firstHasOwnBookUCI' or `secondHasOwnBookUCI' applying to the
1382      engine is set to false.  The engine will be kept in force mode as
1383      long as the current position is in book, and XBoard will select
1384      the book moves for it. Default "".
1385
1386 -fNoOwnBookUCI or -firstXBook or -firstHasOwnBookUCI true/false
1387 -sNoOwnBookUCI or -secondXBook or -secondHasOwnBookUCI true/false
1388      Indicates if the mentioned engine has its own opening book it
1389      should play from, rather than using the external book through
1390      XBoard. Default: false.
1391
1392 -defaultHashSize n
1393      Sets the size of the hash table to n MegaBytes. Together with the
1394      EGTB cache size this number is also used to calculate the memory
1395      setting of XBoard/WinBoard engines, for those that support the
1396      memory feature of the XBoard/WinBoard protocol. Default: 64.
1397
1398 -defaultCacheSizeEGTB n
1399      Sets the size of the EGTB cache to n MegaBytes. Together with the
1400      hash-table size this number is also used to calculate the memory
1401      setting of XBoard/WinBoard engines, for those that support the
1402      memory feature of the XBoard/WinBoard protocol. Default: 4.
1403
1404 -defaultPathEGTB filename
1405      Gives the name of the directory where the end-game tablebases are
1406      installed, for UCI engines.  Default: "/usr/local/share/egtb".
1407
1408 -egtFormats string
1409      Specifies which end-game tables are installed on the computer, and
1410      where.  The argument is a comma-separated list of format
1411      specifications, each specification consisting of a format name, a
1412      colon, and a directory path name, e.g.
1413      "nalimov:/usr/local/share/egtb".  If the name part matches that of
1414      a format that the engine requests through a feature command,
1415      xboard will relay the path name for this format to the engine
1416      through an egtpath command.  One egtpath command for each matching
1417      format will be sent.  Popular formats are "nalimov" DTM tablebases
1418      and "scorpio" bitbases.  Default: "".
1419
1420 3.3 ICS options
1421 ===============
1422
1423 -ics/-xics or -internetChessServerMode true/false
1424      Connect with an Internet Chess Server to play chess against its
1425      other users, observe games they are playing, or review games that
1426      have recently finished. Default: false.
1427
1428 -icshost or -internetChessServerHost host
1429      The Internet host name or address of the chess server to connect
1430      to when in ICS mode. Default: `chessclub.com'.  Another popular
1431      chess server to try is `freechess.org'.  If your site doesn't have
1432      a working Internet name server, try specifying the host address in
1433      numeric form.  You may also need to specify the numeric address
1434      when using the icshelper option with timestamp or timeseal (see
1435      below).
1436
1437 -icsport or -internetChessServerPort port-number
1438      The port number to use when connecting to a chess server in ICS
1439      mode. Default: 5000.
1440
1441 -icshelper or -internetChessServerHelper prog-name
1442      An external helper program used to communicate with the chess
1443      server.  You would set it to "timestamp" for ICC (chessclub.com) or
1444      "timeseal" for FICS (freechess.org), after obtaining the correct
1445      version of timestamp or timeseal for your computer.  See "help
1446      timestamp" on ICC and "help timeseal" on FICS.  This option is
1447      shorthand for `-useTelnet -telnetProgram program'.
1448
1449 -telnet/-xtelnet or -useTelnet true/false
1450      This option is poorly named; it should be called useHelper.  If
1451      set to true, it instructs XBoard to run an external program to
1452      communicate with the Internet Chess Server.  The program to use is
1453      given by the telnetProgram option.  If the option is false (the
1454      default), XBoard opens a TCP socket and uses its own internal
1455      implementation of the telnet protocol to communicate with the ICS.
1456      *Note Firewalls::.
1457
1458 -telnetProgram prog-name
1459      This option is poorly named; it should be called helperProgram.
1460      It gives the name of the telnet program to be used with the
1461      `gateway' and `useTelnet' options.  The default is `telnet'. The
1462      telnet program is invoked with the value of
1463      `internetChessServerHost' as its first argument and the value of
1464      `internetChessServerPort' as its second argument.  *Note
1465      Firewalls::.
1466
1467 -gateway host-name
1468      If this option is set to a host name, XBoard communicates with the
1469      Internet Chess Server by using `rsh' to run the `telnetProgram' on
1470      the given host, instead of using its own internal implementation
1471      of the telnet protocol. You can substitute a different remote shell
1472      program for `rsh' using the `remoteShell' option described below.
1473      *Note Firewalls::.
1474
1475 -internetChessServerCommPort or -icscomm dev-name
1476      If this option is set, XBoard communicates with the ICS through
1477      the given character I/O device instead of opening a TCP connection.
1478      Use this option if your system does not have any kind of Internet
1479      connection itself (not even a SLIP or PPP connection), but you do
1480      have dial-up access (or a hardwired terminal line) to an Internet
1481      service provider from which you can telnet to the ICS.
1482
1483      The support for this option in XBoard is minimal. You need to set
1484      all communication parameters and tty modes before you enter XBoard.
1485
1486      Use a script something like this:
1487
1488           stty raw -echo 9600 > /dev/tty00
1489           xboard -ics -icscomm /dev/tty00
1490
1491      Here replace `/dev/tty00' with the name of the device that your
1492      modem is connected to. You might have to add several more options
1493      to these stty commands. See the man pages for `stty' and `tty' if
1494      you run into problems. Also, on many systems stty works on its
1495      standard input instead of standard output, so you have to use `<'
1496      instead of `>'.
1497
1498      If you are using linux, try starting with the script below.
1499      Change it as necessary for your installation.
1500
1501           #!/bin/sh -f
1502           # configure modem and fire up XBoard
1503
1504           # configure modem
1505           (
1506             stty 2400 ; stty raw ; stty hupcl ; stty -clocal
1507             stty ignbrk ; stty ignpar ; stty ixon ; stty ixoff
1508             stty -iexten ; stty -echo
1509           ) < /dev/modem
1510           xboard -ics -icscomm /dev/modem
1511      After you start XBoard in this way, type whatever commands are
1512      necessary to dial out to your Internet provider and log in.  Then
1513      telnet to ICS, using a command like `telnet chessclub.com 5000'.
1514      Important: See the paragraph below about extra echoes, in *note
1515      Limitations::.
1516
1517 -icslogon or -internetChessServerLogonScript file-name
1518      Whenever XBoard connects to the Internet Chess Server, if it finds
1519      a file with the name given in this option, it feeds the file's
1520      contents to the ICS as commands. The default file name is `.icsrc'.
1521      Usually the first two lines of the file should be your ICS user
1522      name and password.  The file can be either in $CHESSDIR, in
1523      XBoard's working directory if CHESSDIR is not set, or in your home
1524      directory.
1525
1526 -msLoginDelay delay
1527      If you experience trouble logging on to an ICS when using the
1528      `-icslogon' option, inserting some delay between characters of the
1529      logon script may help. This option adds `delay' milliseconds of
1530      delay between characters. Good values to try are 100 and 250.
1531
1532 -icsinput/-xicsinput or -internetChessServerInputBox true/false
1533      Sets the ICS Input Box menu option. *Note Mode Menu::. Default:
1534      false.
1535
1536 -autocomm/-xautocomm or -autoComment true/false
1537      Sets the Auto Comment menu option. *Note Options Menu::. Default:
1538      false.
1539
1540 -autoflag/-xautoflag or -autoCallFlag true/false
1541      Sets the Auto Flag menu option.  *Note Options Menu::. Default:
1542      false.
1543
1544 -autobs/-xautobs or -autoObserve true/false
1545      Sets the Auto Observe menu option.  *Note Options Menu::. Default:
1546      false.
1547
1548 -autoKibitz
1549      Enables kibitzing of the engines last thinking output (depth,
1550      score, time, speed, PV) before it moved to the ICS, in zippy mode.
1551      The option `showThinking' must be switched on for this option to
1552      work.  Also diverts similar kibitz information of an opponent
1553      engine that is playing you through the ICS to the engine-output
1554      window, as if the engine was playing locally.
1555
1556 -seekGraph true/false or -sg
1557      Enables displaying of the seek graph by left-clicking the board
1558      when you are logged on to an ICS and currently idle.  The seek
1559      graph show all players currently seeking games on the ICS, plotted
1560      according to their rating and the time control of the game they
1561      seek, in three different colors (for rated, unrated and wild
1562      games).  Computer ads are displayed as squares, human ads are dots.
1563      Default: false.
1564
1565 -autoRefresh true/false
1566      Enables automatic updating of the seek graph, by having the ICS
1567      send a running update of all newly placed and removed seek ads.
1568      This consumes a substantial amount of communication bandwidth, and
1569      is only supported for FICS and ICC.  Default: false.
1570
1571 -backgroundObserve true/false
1572      When true, boards sent to you by the ICS from other games while
1573      you are playing (e.g. because you are observing them) will not be
1574      automatically displayed.  Only a summary of time left and material
1575      of both players will appear in the message field above the board.
1576      XBoard will remember the last board it has received this way, and
1577      will display it in stead of the position in your own game when you
1578      press the right mouse button.  No other information is stored on
1579      such games observed in the background; you cannot save such a game
1580      later, or step through its moves.  This feature is provided solely
1581      for the benefit of bughouse players, to enable them to peek at
1582      their partner's game without the need to logon twice.  Default:
1583      false.
1584
1585 -dualBoard true/false
1586      In combination with -backgroundObserve true, this option will
1587      display the board of the background game side by side with that of
1588      your own game, so you can have it in view permanently.  Any board
1589      or holdings info coming in will be displayed on the secondary
1590      board immediately.  This feature is still experimental and largely
1591      unfinished.  There is no animation or highlighting of moves on the
1592      secondary board.  Default: false.
1593
1594 -oneClickMove true/false
1595      When set, this option allows you to enter moves by only clicking
1596      the to- or from-square, when only a single legal move to or from
1597      that square is possible.  Double-clicking a piece (or clicking an
1598      already selected piece) will instruct that piece to make the only
1599      capture it can legally do.  Default: false.
1600
1601 -moves/-xmoves or -getMoveList true/false
1602      Sets the Get Move List menu option.  *Note Options Menu::.
1603      Default: true.
1604
1605 -alarm/-xalarm or -icsAlarm true/false
1606      Sets the ICS Alarm menu option.  *Note Options Menu::. Default:
1607      true.
1608
1609 -icsAlarmTime ms
1610      Sets the time in milliseconds for the ICS Alarm menu option.
1611      *Note Options Menu::. Default: 5000.
1612
1613 lowTimeWarning true/false
1614      Controls a color change of the board as a warning your time is
1615      running out.  *Note Options Menu::. Default: false.
1616
1617 -pre/-xpre \fRor\fB -premove true/false
1618      Sets the Premove menu option. *Note Options Menu::. Default: true.
1619
1620 -quiet/-xquiet or -quietPlay true/false
1621      Sets the Quiet Play menu option.  *Note Options Menu::.  Default:
1622      false.
1623
1624 -colorizeMessages or -colorize
1625      Setting colorizeMessages to true tells XBoard to colorize the
1626      messages received from the ICS.  Colorization works only if your
1627      xterm supports ISO 6429 escape sequences for changing text colors.
1628
1629 -colorShout foreground,background,bold
1630 -colorSShout foreground,background,bold
1631 -colorChannel1 foreground,background,bold
1632 -colorChannel foreground,background,bold
1633 -colorKibitz foreground,background,bold
1634 -colorTell foreground,background,bold
1635 -colorChallege foreground,background,bold
1636 -colorRequest foreground,background,bold
1637 -colorSeek foreground,background,bold
1638 -colorNormal foreground,background,bold
1639      These options set the colors used when colorizing ICS messages.
1640      All ICS messages are grouped into one of these categories: shout,
1641      sshout, channel 1, other channel, kibitz, tell, challenge, request
1642      (including abort, adjourn, draw, pause, and takeback), or normal
1643      (all other messages).
1644
1645      Each foreground or background argument can be one of the following:
1646      black, red, green, yellow, blue, magenta, cyan, white, or default.
1647      Here "default" means the default foreground or background color of
1648      your xterm.  Bold can be 1 or 0.  If background is omitted,
1649      "default" is assumed; if bold is omitted, 0 is assumed.
1650
1651      Here is an example of how to set the colors in your `.Xresources'
1652      file.  The colors shown here are the default values; you will get
1653      them if you turn `-colorize' on without specifying your own colors.
1654
1655           xboard*colorizeMessages: true
1656           xboard*colorShout: green
1657           xboard*colorSShout: green, black, 1
1658           xboard*colorChannel1: cyan
1659           xboard*colorChannel: cyan, black, 1
1660           xboard*colorKibitz: magenta, black, 1
1661           xboard*colorTell: yellow, black, 1
1662           xboard*colorChallenge: red, black, 1
1663           xboard*colorRequest: red
1664           xboard*colorSeek: blue
1665           xboard*colorNormal: default
1666
1667 -soundProgram progname
1668      If this option is set to a sound-playing program that is installed
1669      and working on your system, XBoard can play sound files when
1670      certain events occur, listed below.  The default program name is
1671      "play".  If any of the sound options is set to "$", the event
1672      rings the terminal bell by sending a ^G character to standard
1673      output, instead of playing a sound file.  If an option is set to
1674      the empty string "", no sound is played for that event.
1675
1676 -soundShout filename
1677 -soundSShout filename
1678 -soundChannel filename
1679 -soundKibitz filename
1680 -soundTell filename
1681 -soundChallenge filename
1682 -soundRequest filename
1683 -soundSeek filename
1684      These sounds are triggered in the same way as the colorization
1685      events described above.  They all default to "", no sound.  They
1686      are played only if the colorizeMessages is on.
1687
1688 -soundMove filename
1689      This sound is used by the Move Sound menu option.  Default: "$".
1690
1691 -soundIcsAlarm filename
1692      This sound is used by the ICS Alarm menu option.  Default: "$".
1693
1694 -soundIcsWin filename
1695      This sound is played when you win an ICS game.  Default: "" (no
1696      sound).
1697
1698 -soundIcsLoss filename
1699      This sound is played when you lose an ICS game.  Default: "" (no
1700      sound).
1701
1702 -soundIcsDraw filename
1703      This sound is played when you draw an ICS game.  Default: "" (no
1704      sound).
1705
1706 -soundIcsUnfinished filename
1707      This sound is played when an ICS game that you are participating
1708      in is aborted, adjourned, or otherwise ends inconclusively.
1709      Default: "" (no sound).
1710
1711      Here is an example of how to set the sounds in your `.Xresources'
1712      file:
1713
1714           xboard*soundShout: shout.wav
1715           xboard*soundSShout: sshout.wav
1716           xboard*soundChannel1: channel1.wav
1717           xboard*soundChannel: channel.wav
1718           xboard*soundKibitz: kibitz.wav
1719           xboard*soundTell: tell.wav
1720           xboard*soundChallenge: challenge.wav
1721           xboard*soundRequest: request.wav
1722           xboard*soundSeek: seek.wav
1723           xboard*soundMove: move.wav
1724           xboard*soundIcsWin: win.wav
1725           xboard*soundIcsLoss: lose.wav
1726           xboard*soundIcsDraw: draw.wav
1727           xboard*soundIcsUnfinished: unfinished.wav
1728           xboard*soundIcsAlarm: alarm.wav
1729
1730 -dropMenu true|false
1731      This option allows you to emulate old behavior, where the right
1732      mouse button brings up the (now deprecated) drop menu rather than
1733      displaying the position at the end of the principal variation.
1734      Default: False.
1735
1736 -variations true|false
1737      When this option is on, you can start new variations in Edit Game
1738      or Analyze mode by holding the Shift key down while entering a
1739      move.  When it is off, the Shift key will be ignored.  Default:
1740      False.
1741
1742 3.4 Load and Save options
1743 =========================
1744
1745 -lgf or -loadGameFile file
1746 -lgi or -loadGameIndex index
1747      If the `loadGameFile' option is set, XBoard loads the specified
1748      game file at startup. The file name `-' specifies the standard
1749      input. If there is more than one game in the file, XBoard pops up
1750      a menu of the available games, with entries based on their PGN
1751      (Portable Game Notation) tags.  If the `loadGameIndex' option is
1752      set to `N', the menu is suppressed and the N th game found in the
1753      file is loaded immediately.  The menu is also suppressed if
1754      `matchMode' is enabled or if the game file is a pipe; in these
1755      cases the first game in the file is loaded immediately.  Use the
1756      `pxboard' shell script provided with XBoard if you want to pipe in
1757      files containing multiple games and still see the menu.  If the
1758      loadGameIndex specifies an index -1, this triggers auto-increment
1759      of the index in `matchMode', which means that after every game the
1760      index is incremented by one, causing each game of the match to be
1761      played from the next game in the file. Similarly, specifying an
1762      index value of -2 causes the index to be incremented every two
1763      games, so that each game in the file is used twice (with reversed
1764      colors).  The `rewindIndex' option causes the index to be reset to
1765      the first game of the file when it has reached a specified value.
1766
1767 -rewindIndex n
1768      Causes a position file or game file to be rewound to its beginning
1769      after n positions or games in auto-increment `matchMode'.  See
1770      `loadPositionIndex' and `loadGameIndex'.  default: 0 (no rewind).
1771
1772 -td or -timeDelay seconds
1773      Time delay between moves during `Load Game' or `Analyze File'.
1774      Fractional seconds are allowed; try `-td 0.4'.  A time delay value
1775      of -1 tells XBoard not to step through game files automatically.
1776      Default: 1 second.
1777
1778 -sgf or -saveGameFile file
1779      If this option is set, XBoard appends a record of every game
1780      played to the specified file. The file name `-' specifies the
1781      standard output.
1782
1783 -autosave/-xautosave or -autoSaveGames true/false
1784      Sets the Auto Save menu option.  *Note Options Menu::.  Default:
1785      false.  Ignored if `saveGameFile' is set.
1786
1787 -lpf or -loadPositionFile file
1788 -lpi or -loadPositionIndex index
1789      If the `loadPositionFile' option is set, XBoard loads the
1790      specified position file at startup. The file name `-' specifies the
1791      standard input. If the `loadPositionIndex' option is set to N, the
1792      Nth position found in the file is loaded; otherwise the first
1793      position is loaded.  If the loadPositionIndex specifies an index
1794      -1, this triggers auto-increment of the index in `matchMode',
1795      which means that after every game the index is incremented by one,
1796      causing each game of the match to be played from the next position
1797      in the file. Similarly, specifying an index value of -2 causes the
1798      index to be incremented every two games, so that each position in
1799      the file is used twice (with the engines playing opposite colors).
1800      The `rewindIndex' option causes the index to be reset to the first
1801      position of the file when it has reached a specified value.
1802
1803 -spf or -savePositionFile file
1804      If this option is set, XBoard appends the final position reached
1805      in every game played to the specified file. The file name `-'
1806      specifies the standard output.
1807
1808 -pgnExtendedInfo true/false
1809      If this option is set, XBoard saves depth, score and time used for
1810      each move that the engine found as a comment in the PGN file.
1811      Default: false.
1812
1813 -pgnEventHeader string
1814      Sets the name used in the PGN event tag to string.  Default:
1815      "Computer Chess Game".
1816
1817 -saveOutOfBookInfo true/false
1818      Include the information on how the engine(s) game out of its
1819      opening book in a special 'annotator' tag with the PGN file.
1820
1821 -oldsave/-xoldsave or -oldSaveStyle true/false
1822      Sets the Old Save Style menu option.  *Note Options Menu::.
1823      Default: false.
1824
1825 -gameListTags string
1826      The character string lists the PGN tags that should be printed in
1827      the Game List, and their order. The meaning of the codes is
1828      e=event, s=site, d=date, o=round, p=players, r=result, w=white
1829      Elo, b=black Elo, t=time control, v=variant, a=out-of-book info,
1830      c=result comment.  Default: "eprd"
1831
1832 -ini or -settingsFile filename
1833 -saveSettingsFile filename
1834 @filename
1835      When XBoard encounters an option -settingsFile (or -ini for short),
1836      or @filename, it tries to read the mentioned file, and substitutes
1837      the contents of it (presumaby more command-line options) in place
1838      of the option.  In the case of -ini or -settingsFile, the name of
1839      a successfully read settings file is also remembered as the file
1840      to use for saving settings (automatically on exit, or on user
1841      command).  An option of the form @filename does not affect saving.
1842      The option -saveSettingsFile does specify a name of the file to use
1843      for saving, without reading any options from it, and is thus also
1844      effective when the file did not exist yet.  So the settings will
1845      be saved to the file specified in the last -saveSettingsFile or
1846      succesfull -settingsFile / -ini command, if any, and in
1847      /etc/xboard/xboard.conf otherwise.  Usualy the latter is only
1848      accessible for the system administrator, though, and will be used
1849      to contain system-wide default setings, amongst which a
1850      -saveSettingsFile and -settingsFile options to specify a settings
1851      file accessible to the individual user, such as ~/.xboardrc in the
1852      user's home directory.
1853
1854 3.5 User interface options
1855 ==========================
1856
1857 -display
1858 -geometry
1859 -iconic
1860      These and most other standard Xt options are accepted.
1861
1862 -noGUI
1863      Suppresses all GUI functions of XBoard (to speed up automated
1864      ultra-fast engine-engine games, which you dont want to watch).
1865      There will be no board or clock updates, no printing of moves, and
1866      no update of the icon on the task bar in this mode.
1867
1868 -movesound/-xmovesound or -ringBellAfterMoves true/false
1869      Sets the Move Sound menu option.  *Note Options Menu::.  Default:
1870      false.  For compatibility with old XBoard versions, -bell/-xbell
1871      are also accepted as abbreviations for this option.
1872
1873 -exit/-xexit or -popupExitMessage true/false
1874      Sets the Popup Exit Message menu option.  *Note Options Menu::.
1875      Default: true.
1876
1877 -popup/-xpopup or -popupMoveErrors true/false
1878      Sets the Popup Move Errors menu option.  *Note Options Menu::.
1879      Default: false.
1880
1881 -queen/-xqueen or -alwaysPromoteToQueen true/false
1882      Sets the Always Queen menu option.  *Note Options Menu::.
1883      Default: false.
1884
1885 -legal/-xlegal or -testLegality true/false
1886      Sets the Test Legality menu option.  *Note Options Menu::.
1887      Default: true.
1888
1889 -size or -boardSize (sizeName | n1,n2,n3,n4,n5,n6,n7)
1890      Determines how large the board will be, by selecting the pixel size
1891      of the pieces and setting a few related parameters.  The sizeName
1892      can be one of: Titanic, giving 129x129 pixel pieces, Colossal
1893      116x116, Giant 108x108, Huge 95x95, Big 87x87, Large 80x80, Bulky
1894      72x72, Medium 64x64, Moderate 58x58, Average 54x54, Middling
1895      49x49, Mediocre 45x45, Small 40x40, Slim 37x37, Petite 33x33,
1896      Dinky 29x29, Teeny 25x25, or Tiny 21x21.  Orthodox pieces of all
1897      these sizes are built into XBoard.  Other sizes can be used if you
1898      have them; see the pixmapDirectory and bitmapDirectory options.
1899      Complete sets of un-orthodox pieces are only provided in sizes
1900      Bulky, Middling and (to a lesser extent) Petite; Archbishop,
1901      Marshall and Amazon are also available in all sizes between Bulky
1902      and Petite.  When no bitmap is available, the piece will be
1903      displayed as Amazon or King.  The default depends on the size of
1904      your screen; it is approximately the largest size that will fit
1905      without clipping.
1906
1907      You can select other sizes or vary other layout parameters by
1908      providing a list of comma-separated values (with no spaces) as the
1909      argument.  You do not need to provide all the values; for any you
1910      omit from the end of the list, defaults are taken from the nearest
1911      built-in size.  The value `n1' gives the piece size, `n2' the
1912      width of the black border between squares, `n3' the desired size
1913      for the clockFont, `n4' the desired size for the coordFont, `n5'
1914      the desired size for the default font, `n6' the smallLayout flag
1915      (0 or 1), and `n7' the tinyLayout flag (0 or 1).  All dimensions
1916      are in pixels.  If the border between squares is eliminated (0
1917      width), the various highlight options will not work, as there is
1918      nowhere to draw the highlight.  If smallLayout is 1 and
1919      `titleInWindow' is true, the window layout is rearranged to make
1920      more room for the title.  If tinyLayout is 1, the labels on the
1921      menu bar are abbreviated to one character each and the buttons in
1922      the button bar are made narrower.
1923
1924 -coords/-xcoords or -showCoords true/false
1925      Sets the Show Coords menu option.  *Note Options Menu::.  Default:
1926      false.  The `coordFont' option specifies what font to use.
1927
1928 -autoraise/-xautoraise or -autoRaiseBoard true/false
1929      Sets the Auto Raise Board menu option.  *Note Options Menu::.
1930      Default: true.
1931
1932 -autoflip/-xautoflip or -autoFlipView true/false
1933      Sets the Auto Flip View menu option.  *Note Options Menu::.
1934      Default: true.
1935
1936 -flip/-xflip or -flipView true/false
1937      If Auto Flip View is not set, or if you are observing but not
1938      participating in a game, then the positioning of the board at the
1939      start of each game depends on the flipView option.  If flipView is
1940      false (the default), the board is positioned so that the white
1941      pawns move from the bottom to the top; if true, the black pawns
1942      move from the bottom to the top.  In any case, the Flip menu
1943      option (see *note Options Menu::) can be used to flip the board
1944      after the game starts.
1945
1946 -title/-xtitle or -titleInWindow true/false
1947      If this option is true, XBoard displays player names (for ICS
1948      games) and game file names (for `Load Game') inside its main
1949      window. If the option is false (the default), this information is
1950      displayed only in the window banner. You probably won't want to
1951      set this option unless the information is not showing up in the
1952      banner, as happens with a few X window managers.
1953
1954 -buttons/-xbuttons or -showButtonBar True/False
1955      If this option is False, xboard omits the [<<] [<] [P] [>] [>>]
1956      button bar from the window, allowing the message line to be wider.
1957      You can still get the functions of these buttons using the menus
1958      or their keyboard shortcuts.  Default: true.
1959
1960 -mono/-xmono or -monoMode true/false
1961      Determines whether XBoard displays its pieces and squares with two
1962      colors (true) or four (false). You shouldn't have to specify
1963      `monoMode'; XBoard will determine if it is necessary.
1964
1965 -showTargetSquares true/false
1966      Determines whether XBoard can highlight the squares a piece has
1967      legal moves to, when you grab that piece with the mouse.  If this
1968      option is set, this feature can be controlled through the
1969      Highlight Dragging menu item.
1970
1971 -flashCount count
1972 -flashRate rate
1973 -flash/-xflash
1974      These options enable flashing of pieces when they land on their
1975      destination square.  `flashCount' tells XBoard how many times to
1976      flash a piece after it lands on its destination square.
1977      `flashRate' controls the rate of flashing (flashes/sec).
1978      Abbreviations: `flash' sets flashCount to 3.  `xflash' sets
1979      flashCount to 0.  Defaults:  flashCount=0 (no flashing),
1980      flashRate=5.
1981
1982 -highlight/-xhighlight or -highlightLastMove true/false
1983      Sets the Highlight Last Move menu option. *Note Options Menu::.
1984      Default: false.
1985
1986 -highlightMoveWithArrow true/false
1987      Sets the Highlight with Arrow menu option. *Note Options Menu::.
1988      Default: false.
1989
1990 -blind/-xblind or -blindfold true/false
1991      Sets the Blindfold menu option.  *Note Options Menu::.  Default:
1992      false.
1993
1994 -clockFont font
1995      The font used for the clocks. If the option value is a pattern
1996      that does not specify the font size, XBoard tries to choose an
1997      appropriate font for the board size being used.  Default:
1998      -*-helvetica-bold-r-normal-*-*-*-*-*-*-*-*.
1999
2000 -coordFont font
2001      The font used for rank and file coordinate labels if `showCoords'
2002      is true. If the option value is a pattern that does not specify
2003      the font size, XBoard tries to choose an appropriate font for the
2004      board size being used.  Default:
2005      -*-helvetica-bold-r-normal-*-*-*-*-*-*-*-*.
2006
2007 -font font
2008      The font used for popup dialogs, menus, comments, etc.  If the
2009      option value is a pattern that does not specify the font size,
2010      XBoard tries to choose an appropriate font for the board size
2011      being used.  Default: -*-helvetica-medium-r-normal-*-*-*-*-*-*-*-*.
2012
2013 -fontSizeTolerance tol
2014      In the font selection algorithm, a nonscalable font will be
2015      preferred over a scalable font if the nonscalable font's size
2016      differs by `tol' pixels or less from the desired size.  A value of
2017      -1 will force a scalable font to always be used if available; a
2018      value of 0 will use a nonscalable font only if it is exactly the
2019      right size; a large value (say 1000) will force a nonscalable font
2020      to always be used if available.  Default: 4.
2021
2022 -bm or -bitmapDirectory dir
2023 -pixmap or -pixmapDirectory dir
2024      These options control what piece images xboard uses.  The XBoard
2025      distribution includes one set of pixmap pieces in xpm format, in
2026      the directory `pixmaps', and one set of bitmap pieces in xbm
2027      format, in the directory `bitmaps'.  Pixmap pieces give a better
2028      appearance on the screen: the white pieces have dark borders, and
2029      the black pieces have opaque internal details.  With bitmaps,
2030      neither piece color has a border, and the internal details are
2031      transparent; you see the square color or other background color
2032      through them.
2033
2034      If XBoard is configured and compiled on a system that includes
2035      libXpm, the X pixmap library, the xpm pixmap pieces are compiled
2036      in as the default.  A different xpm piece set can be selected at
2037      runtime with the `pixmapDirectory' option, or a bitmap piece set
2038      can be selected with the `bitmapDirectory' option.
2039
2040      If XBoard is configured and compiled on a system that does not
2041      include libXpm (or the `--disable-xpm' option is given to the
2042      configure program), the bitmap pieces are compiled in as the
2043      default.  It is not possible to use xpm pieces in this case, but
2044      pixmap pieces in another format called "xim" can be used by giving
2045      the `pixmapDirectory' option.  Or again, a different bitmap piece
2046      set can be selected with the `bitmapDirectory' option.
2047
2048      Files in the `bitmapDirectory' must be named as follows: The first
2049      character of a piece bitmap name gives the piece it represents
2050      (`p', `n', `b', `r', `q', or `k'), the next characters give the
2051      size in pixels, the following character indicates whether the
2052      piece is solid or outline (`s' or `o'), and the extension is `.bm'.
2053      For example, a solid 80x80 knight would be named `n80s.bm'.  The
2054      outline bitmaps are used only in monochrome mode.  If bitmap
2055      pieces are compiled in and the bitmapDirectory is missing some
2056      files, the compiled in pieces are used instead.
2057
2058      If the bitmapDirectory option is given, it is also possible to
2059      replace xboard's icons and menu checkmark, by supplying files
2060      named `icon_white.bm', `icon_black.bm', and `checkmark.bm'.
2061
2062      For more information about pixmap pieces and how to get additional
2063      sets, see *note zic2xpm:: below.
2064
2065 -whitePieceColor color
2066 -blackPieceColor color
2067 -lightSquareColor color
2068 -darkSquareColor color
2069 -highlightSquareColor color
2070 -lowTimeWarningColor color
2071      Colors to use for the pieces, squares, and square highlights.
2072      Defaults:
2073
2074           -whitePieceColor       #FFFFCC
2075           -blackPieceColor       #202020
2076           -lightSquareColor      #C8C365
2077           -darkSquareColor       #77A26D
2078           -highlightSquareColor  #FFFF00
2079           -premoveHighlightColor #FF0000
2080           -lowTimeWarningColor   #FF0000
2081
2082      On a grayscale monitor you might prefer:
2083
2084           -whitePieceColor       gray100
2085           -blackPieceColor       gray0
2086           -lightSquareColor      gray80
2087           -darkSquareColor       gray60
2088           -highlightSquareColor  gray100
2089           -premoveHighlightColor gray70
2090           -lowTimeWarningColor   gray70
2091
2092 -drag/-xdrag or -animateDragging true/false
2093      Sets the Animate Dragging menu option. *Note Options Menu::.
2094      Default: true.
2095
2096 -animate/-xanimate or -animateMoving true/false
2097      Sets the Animate Moving menu option. *Note Options Menu::.
2098      Default: true.
2099
2100 -animateSpeed n
2101      Number of milliseconds delay between each animation frame when
2102      Animate Moves is on.
2103
2104 -autoDisplayComment true/false
2105 -autoDisplayTags true/false
2106      If set to true, these options cause the window with the move
2107      comments, and the window with PGN tags, respectively, to pop up
2108      automatically when such tags or comments are encountered during
2109      the replaying a stored or loaded game.  Default: true.
2110
2111 -pasteSelection true/false
2112      If this option is set to true, the Paste Position and Paste Game
2113      options paste from the currently selected text.  If false, they
2114      paste from the clipboard.  Default: false.
2115
2116 3.6 Adjudication Options
2117 ========================
2118
2119 -adjudicateLossThreshold n
2120      If the given value is non-zero, XBoard adjudicates the game as a
2121      loss if both engines agree for a duration of 6 consecutive ply
2122      that the score is below the given score threshold for that engine.
2123      Make sure the score is interpreted properly by XBoard, using
2124      `-firstScoreAbs' and `-secondScoreAbs' if needed.  Default: 0 (no
2125      adjudication)
2126
2127 -adjudicateDrawMoves n
2128      If the given value is non-zero, XBoard adjudicates the game as a
2129      draw if after the given number of moves it was not yet decided.
2130      Default: 0 (no adjudication)
2131
2132 -checkMates true/false
2133      If this option is set, XBoard detects all checkmates and
2134      stalemates, and ends the game as soon as they occur.
2135      Legality-testing must be switched on for this option to work.
2136      Default: true
2137
2138 -testClaims true/false
2139      If this option is set, XBoard verifies all result claims made by
2140      engines, and those who send false claims will forfeit the game
2141      because of it.  Legality-testing must be switched on for this
2142      option to work. Default: true
2143
2144 -materialDraws true/false
2145      If this option is set, XBoard adjudicates games as draws when
2146      there is no sufficient material left to inflict a checkmate.  This
2147      applies to KBKB with like bishops (any number, actually), and to
2148      KBK, KNK and KK.  Legality-testing must be switched on for this
2149      option to work. Default: true
2150
2151 -trivialDraws true/false
2152      If this option is set, XBoard adjudicates games as draws that
2153      cannot be usually won without opponent cooperation. This applies
2154      to KBKB with unlike bishops, and to KBKN, KNKN, KNNK, KRKR and
2155      KQKQ. The draw is called after 6 ply into these end-games, to
2156      allow quick mates that can occur in some exceptional positions to
2157      be found by the engines.  KQKQ does not really belong in this
2158      category, and might be taken out in the future.  (When
2159      bitbase-based adjudications are implemented.)  Legality-testing
2160      must be on for this option to work. Default: false
2161
2162 -ruleMoves n
2163      If the given value is non-zero, XBoard adjudicates the game as a
2164      draw after the given number of consecutive reversible moves.
2165      Engine draw claims are always accepted after 50 moves,
2166      irrespective of the given value of n.
2167
2168 -repeatsToDraw n
2169      If the given value is non-zero, xboard adjudicates the game as a
2170      draw if a position is repeated the given number of times. Engines
2171      draw claims are always accepted after 3 repeats, (on the 3rd
2172      occurrence, actually), irrespective of the value of n.  Beware
2173      that positions that have different castling or en-passant rights
2174      do not count as repeats, XBoard is fully e.p. and castling aware!
2175
2176 3.7 Other options
2177 =================
2178
2179 -ncp/-xncp or -noChessProgram true/false
2180      If this option is true, XBoard acts as a passive chessboard; it
2181      does not start a chess engine at all. Turning on this option also
2182      turns off clockMode. Default: false.
2183
2184 -mode or -initialMode modename
2185      If this option is given, XBoard selects the given modename from
2186      the Mode menu after starting and (if applicable) processing the
2187      loadGameFile or loadPositionFile option. Default: "" (no
2188      selection).  Other supported values are MachineWhite,
2189      MachineBlack, TwoMachines, Analysis, AnalyzeFile, EditGame,
2190      EditPosition, and Training.
2191
2192 -variant varname
2193      Activates preliminary, partial support for playing chess variants
2194      against a local engine or editing variant games.  This flag is not
2195      needed in ICS mode.  Recognized variant names are:
2196
2197           normal        Normal chess
2198           wildcastle    Shuffle chess, king can castle from d file
2199           nocastle      Shuffle chess, no castling allowed
2200           fischerandom  Fischer Random shuffle chess
2201           bughouse      Bughouse, ICC/FICS rules
2202           crazyhouse    Crazyhouse, ICC/FICS rules
2203           losers        Lose all pieces or get mated (ICC wild 17)
2204           suicide       Lose all pieces including king (FICS)
2205           giveaway      Try to have no legal moves (ICC wild 26)
2206           twokings      Weird ICC wild 9
2207           kriegspiel    Opponent's pieces are invisible
2208           atomic        Capturing piece explodes (ICC wild 27)
2209           3check        Win by giving check 3 times (ICC wild 25)
2210           shatranj      An ancient precursor of chess (ICC wild 28)
2211           xiangqi       Chinese Chess (on a 9x10 board)
2212           shogi         Japanese Chess (on a 9x9 board & piece drops)
2213           capablanca    Capablanca Chess (10x8 board, with Archbishop
2214                         and Chancellor pieces)
2215           gothic        similar, with a better initial position
2216           caparandom    An FRC-like version of Capablanca Chess (10x8)
2217           janus         A game with two Archbishops (10x8 board)
2218           courier       Medieval intermediate between shatranj and
2219                         modern Chess (on 12x8 board)
2220           falcon        Patented 10x8 variant with two Falcon pieces
2221           berolina      Pawns capture straight ahead, and move diagonal
2222           cylinder      Pieces wrap around the board edge
2223           knightmate    King moves as Knight, and vice versa
2224           super         Superchess (shuffle variant with 4 exo-pieces)
2225           makruk        Thai Chess (shatranj-like, P promotes on 6th rank)
2226           spartan       Spartan Chess (black has unorthodox pieces)
2227           fairy         A catchall variant in which all piece types
2228                         known to XBoard can participate (8x8)
2229           unknown       Catchall for other unknown variants
2230
2231      NOT ALL BOARDSIZES PROVIDE A COMPLETE SET OF BUILT-IN BITMAPS FOR
2232      ALL UN-ORTHODOX PIECES, though. Only in `boardSize' middling and
2233      bulky all 22 piece types are provided, while -boardSize petite has
2234      most of them. Archbishop, Chancellor and Amazon are supported in
2235      every size from petite to bulky. Kings or Amazons are substituted
2236      for missing bitmaps. You can still play variants needing
2237      un-orthodox pieces in other board sizes providing your own bitmaps
2238      through the `bitmapDirectory' or `pixmapDirectory' options.
2239
2240      In the shuffle variants, XBoard now does shuffle the pieces,
2241      although you can still do it by hand using Edit Position.  Some
2242      variants are supported only in ICS mode, including bughouse, and
2243      kriegspiel.  The winning/drawing conditions in crazyhouse
2244      (off-board interposition on mate) are not fully understood, but
2245      losers, suicide, giveaway, atomic, and 3check should be OK.
2246      Berolina and cylinder chess can only be played with legality
2247      testing off.  In crazyhouse, XBoard now does keep track of
2248      off-board pieces.  In shatranj it does implement the baring rule
2249      when mate detection is switched on.
2250
2251 -boardHeight N
2252      Allows you to set a non-standard number of board ranks in any
2253      variant.  If the height is given as -1, the default height for the
2254      variant is used.  Default: -1
2255
2256 -boardWidth N
2257      Allows you to set a non-standard number of board files in any
2258      variant.  If the width is given as -1, the default width for the
2259      variant is used.  With a non-standard width, the initial position
2260      will always be an empty board, as the usual opening array will not
2261      fit.  Default: -1
2262
2263 -holdingsSize N
2264      Allows you to set a non-standard size for the holdings in any
2265      variant.  If the size is given as -1, the default holdings size
2266      for the variant is used.  The first N piece types will go into the
2267      holdings on capture, and you will be able to drop them on the
2268      board in stead of making a normal move. If size equals 0, there
2269      will be no holdings.  Default: -1
2270
2271 -defaultFrcPosition N
2272      Specifies the number of the opening position in shuffle games like
2273      Chess960.  A value of -1 means the position is randomly generated
2274      by XBoard at the beginning of every game.  Default: -1
2275
2276 -pieceToSquareTable string
2277      The characters that are used to represent the piece types XBoard
2278      knows in FEN diagrams and SAN moves. The string argument has to
2279      have an even length (or it will be ignored), as white and black
2280      pieces have to be given separately (in that order). The last
2281      letter for each color will be the King.  The letters before that
2282      will be PNBRQ and then a whole host of fairy pieces in an order
2283      that has not fully crystallized yet (currently FEACWMOHIJGDVSLU,
2284      F=Ferz, Elephant, A=Archbishop, C=Chancellor, W=Wazir, M=Commoner,
2285      O=Cannon, H=Nightrider). You should list at least all pieces that
2286      occur in the variant you are playing. If you have less than 44
2287      characters in the string, the pieces not mentioned will get
2288      assigned a period, and you will not be able to distinguish them in
2289      FENs. You can also explicitly assign pieces a period, in which
2290      case they will not be counted in deciding which captured pieces
2291      can go into the holdings.  A tilde '~' as a piece name does mean
2292      this piece is used to represent a promoted Pawn in crazyhouse-like
2293      games, i.e. on capture it turns back onto a Pawn.  A '+' similarly
2294      indicates the piece is a shogi-style promoted piece, that should
2295      revert to its non-promoted version on capture (rather than to a
2296      Pawn).  Note that promoted pieces are represented by pieces 11
2297      further in the list.  You should not have to use this option
2298      often: each variant has its own default setting for the piece
2299      representation in FEN, which should be sufficient in normal use.
2300      Default: ""
2301
2302 -debug/-xdebug or -debugMode true/false
2303      Turns on debugging printout.
2304
2305 -debugFile filename or -nameOfDebugFile filename
2306      Sets the name of the file to which XBoard saves debug information
2307      (including all communication to and from the engines).
2308
2309 -engineDebugOutput number
2310      Specifies how XBoard should handle unsolicited output from the
2311      engine, with respect to saving it in the debug file.  The output
2312      is further (hopefully) ignored.  If number=0, XBoard refrains from
2313      writing such spurious output to the debug file.  If number=1, all
2314      engine output is written faithfully to the debug file.  If
2315      number=2, any protocol-violating line is prefixed with a '#'
2316      character, as the engine itself should have done if it wanted to
2317      submit info for inclusion in the debug file.  This option is
2318      provided for the benefit of applications that use the debug file
2319      as a source of information, such as the broadcaster of live games
2320      TLCV / TLCS.  Such applications can be protected from spurious
2321      engine output that might otherwise confuse them.
2322
2323 -rsh or -remoteShell shell-name
2324      Name of the command used to run programs remotely. The default is
2325      `rsh' or `remsh', determined when XBoard is configured and
2326      compiled.
2327
2328 -ruser or -remoteUser user-name
2329      User name on the remote system when running programs with the
2330      `remoteShell'. The default is your local user name.
2331
2332 -userName username
2333      Name under which the Human player will be listed in the PGN file.
2334      Default is the login name on your local computer.
2335
2336 -delayBeforeQuit number
2337 -delayAfterQuit number
2338      These options specify how long XBoard has to wait before sending a
2339      termination signal to rogue engine processes, that do not want to
2340      react to the 'quit' command. The second one determines the pause
2341      after killing the engine, to make sure it dies.
2342
2343
2344 4 Chess Servers
2345 ***************
2346
2347 An "Internet Chess Server", or "ICS", is a place on the Internet where
2348 people can get together to play chess, watch other people's games, or
2349 just chat.  You can use either `telnet' or a client program like XBoard
2350 to connect to the server.  There are thousands of registered users on
2351 the different ICS hosts, and it is not unusual to meet 200 on both
2352 chessclub.com and freechess.org.
2353
2354    Most people can just type `xboard -ics' to start XBoard as an ICS
2355 client.  Invoking XBoard in this way connects you to the Internet Chess
2356 Club (ICC), a commercial ICS.  You can log in there as a guest even if
2357 you do not have a paid account.  To connect to the largest Free ICS
2358 (FICS), use the command `xboard -ics -icshost freechess.org' instead,
2359 or substitute a different host name to connect to your favorite ICS.
2360 For a full description of command-line options that control the
2361 connection to ICS and change the default values of ICS options, see
2362 *note ICS options::.
2363
2364    While you are running XBoard as an ICS client, you use the terminal
2365 window that you started XBoard from as a place to type in commands and
2366 read information that is not available on the chessboard.
2367
2368    The first time you need to use the terminal is to enter your login
2369 name and password, if you are a registered player. (You don't need to do
2370 this manually; the `icsLogon' option can do it for you.  *note ICS
2371 options::.)  If you are not registered, enter `g' as your name, and the
2372 server will pick a unique guest name for you.
2373
2374    Some useful ICS commands include
2375 `help <topic>'
2376      to get help on the given <topic>. To get a list of possible topics
2377      type "help" without topic.  Try the help command before you ask
2378      other people on the server for help.
2379
2380      For example `help register' tells you how to become a registered
2381      ICS player.
2382
2383 `who <flags>'
2384      to see a list of people who are logged on.  Administrators (people
2385      you should talk to if you have a problem) are marked with the
2386      character `*', an asterisk. The <flags> allow you to display only
2387      selected players: For example, `who of' shows a list of players
2388      who are interested in playing but do not have an opponent.
2389
2390 `games'
2391      to see what games are being played
2392
2393 `match <player> [<mins>] [<inc>]'
2394      to challenge another player to a game. Both opponents get <mins>
2395      minutes for the game, and <inc> seconds will be added after each
2396      move.  If another player challenges you, the server asks if you
2397      want to accept the challenge; use the `accept' or `decline'
2398      commands to answer.
2399
2400 `accept'
2401 `decline'
2402      to accept or decline another player's offer.  The offer may be to
2403      start a new game, or to agree to a `draw', `adjourn' or `abort'
2404      the current game. *Note Action Menu::.
2405
2406      If you have more than one pending offer (for example, if more than
2407      one player is challenging you, or if your opponent offers both a
2408      draw and to adjourn the game), you have to supply additional
2409      information, by typing something like `accept <player>', `accept
2410      draw', or `draw'.
2411
2412 `draw'
2413 `adjourn'
2414 `abort'
2415      asks your opponent to terminate a game by mutual agreement.
2416      Adjourned games can be continued later.  Your opponent can either
2417      `decline' your offer or accept it (by typing the same command or
2418      typing `accept').  In some cases these commands work immediately,
2419      without asking your opponent to agree.  For example, you can abort
2420      the game unilaterally if your opponent is out of time, and you can
2421      claim a draw by repetition or the 50-move rule if available simply
2422      by typing `draw'.
2423
2424 `finger <player>'
2425      to get information about the given <player>. (Default: yourself.)
2426
2427 `vars'
2428      to get a list of personal settings
2429
2430 `set <var> <value>'
2431      to modify these settings
2432
2433 `observe <player>'
2434      to observe an ongoing game of the given <player>.
2435
2436 `examine'
2437 `oldmoves'
2438      to review a recently completed game
2439
2440    Some special XBoard features are activated when you are in examine
2441 mode on ICS.  See the descriptions of the menu commands `Forward',
2442 `Backward', `Pause', `ICS Client', and `Stop Examining' on the *note
2443 Edit Menu::, *note Mode Menu::, and *note Action Menu::.
2444
2445 5 Firewalls
2446 ***********
2447
2448 By default, XBoard communicates with an Internet Chess Server by
2449 opening a TCP socket directly from the machine it is running on to the
2450 ICS. If there is a firewall between your machine and the ICS, this
2451 won't work. Here are some recipes for getting around common kinds of
2452 firewalls using special options to XBoard.  Important: See the
2453 paragraph in the below about extra echoes, in *note Limitations::.
2454
2455    Suppose that you can't telnet directly to ICS, but you can telnet to
2456 a firewall host, log in, and then telnet from there to ICS.  Let's say
2457 the firewall is called `firewall.example.com'. Set command-line options
2458 as follows:
2459
2460      xboard -ics -icshost firewall.example.com -icsport 23
2461    Or in your `.Xresources' file:
2462
2463      XBoard*internetChessServerHost: firewall.example.com
2464      XBoard*internetChessServerPort: 23
2465    Then when you run XBoard in ICS mode, you will be prompted to log in
2466 to the firewall host. This works because port 23 is the standard telnet
2467 login service. Do so, then telnet to ICS, using a command like `telnet
2468 chessclub.com 5000', or whatever command the firewall provides for
2469 telnetting to port 5000.
2470
2471    If your firewall lets you telnet (or rlogin) to remote hosts but
2472 doesn't let you telnet to port 5000, you may be able to connect to the
2473 chess server on port 23 instead, which is the port the telnet program
2474 uses by default.  Some chess servers support this (including
2475 chessclub.com and freechess.org), while some do not.
2476
2477    If your chess server does not allow connections on port 23 and your
2478 firewall does not allow you to connect to other ports, you may be able
2479 to connect by hopping through another host outside the firewall that
2480 you have an account on.  For instance, suppose you have a shell account
2481 at `foo.edu'. Follow the recipe above, but instead of typing `telnet
2482 chessclub.com 5000' to the firewall, type `telnet foo.edu' (or `rlogin
2483 foo.edu'), log in there, and then type `telnet chessclub.com 5000'.
2484
2485    Suppose that you can't telnet directly to ICS, but you can use rsh
2486 to run programs on a firewall host, and that host can telnet to ICS.
2487 Let's say the firewall is called `rsh.example.com'. Set command-line
2488 options as follows:
2489
2490      xboard -ics -gateway rsh.example.com -icshost chessclub.com
2491
2492 Or in your `.Xresources' file:
2493
2494      XBoard*gateway: rsh.example.com
2495      XBoard*internetChessServerHost: chessclub.com
2496
2497    Then when you run XBoard in ICS mode, it will connect to the ICS by
2498 using `rsh' to run the command `telnet chessclub.com 5000' on host
2499 `rsh.example.com'.
2500
2501    Suppose that you can telnet anywhere you want, but you have to run a
2502 special program called `ptelnet' to do so.
2503
2504    First, we'll consider the easy case, in which `ptelnet chessclub.com
2505 5000' gets you to the chess server.  In this case set command line
2506 options as follows:
2507
2508      xboard -ics -telnet -telnetProgram ptelnet
2509
2510 Or in your `.Xresources' file:
2511
2512      XBoard*useTelnet: true
2513      XBoard*telnetProgram: ptelnet
2514
2515 Then when you run XBoard in ICS mode, it will issue the command
2516 `ptelnet chessclub.com 5000' to connect to the ICS.
2517
2518    Next, suppose that `ptelnet chessclub.com 5000' doesn't work; that
2519 is, your `ptelnet' program doesn't let you connect to alternative
2520 ports. As noted above, your chess server may allow you to connect on
2521 port 23 instead.  In that case, just add the option `-icsport ""' to
2522 the above command, or add `XBoard*internetChessServerPort:' to your
2523 `.Xresources' file.  But if your chess server doesn't let you connect
2524 on port 23, you will have to find some other host outside the firewall
2525 and hop through it. For instance, suppose you have a shell account at
2526 `foo.edu'. Set command line options as follows:
2527
2528      xboard -ics -telnet -telnetProgram ptelnet -icshost foo.edu -icsport ""
2529
2530 Or in your `.Xresources' file:
2531
2532      XBoard*useTelnet: true
2533      XBoard*telnetProgram: ptelnet
2534      XBoard*internetChessServerHost: foo.edu
2535      XBoard*internetChessServerPort:
2536
2537 Then when you run XBoard in ICS mode, it will issue the command
2538 `ptelnet foo.edu' to connect to your account at `foo.edu'. Log in
2539 there, then type `telnet chessclub.com 5000'.
2540
2541    ICC timestamp and FICS timeseal do not work through some firewalls.
2542 You can use them only if your firewall gives a clean TCP connection
2543 with a full 8-bit wide path.  If your firewall allows you to get out
2544 only by running a special telnet program, you can't use timestamp or
2545 timeseal across it.  But if you have access to a computer just outside
2546 your firewall, and you have much lower netlag when talking to that
2547 computer than to the ICS, it might be worthwhile running timestamp
2548 there.  Follow the instructions above for hopping through a host
2549 outside the firewall (foo.edu in the example), but run timestamp or
2550 timeseal on that host instead of telnet.
2551
2552    Suppose that you have a SOCKS firewall that will give you a clean
2553 8-bit wide TCP connection to the chess server, but only after you
2554 authenticate yourself via the SOCKS protocol.  In that case, you could
2555 make a socksified version of XBoard and run that.  If you are using
2556 timestamp or timeseal, you will to socksify it, not XBoard; this may be
2557 difficult seeing that ICC and FICS do not provide source code for these
2558 programs.  Socksification is beyond the scope of this document, but see
2559 the SOCKS Web site at http://www.socks.permeo.com/.  If you are missing
2560 SOCKS, try http://www.funbureau.com/.
2561
2562 6 Environment variables
2563 ***********************
2564
2565 Game and position files are found in a directory named by the
2566 `CHESSDIR' environment variable. If this variable is not set, the
2567 current working directory is used. If `CHESSDIR' is set, XBoard
2568 actually changes its working directory to `$CHESSDIR', so any files
2569 written by the chess engine will be placed there too.
2570
2571 7 Limitations and known bugs
2572 ****************************
2573
2574 There is no way for two people running copies of XBoard to play each
2575 other without going through an Internet Chess Server.
2576
2577    Under some circumstances, your ICS password may be echoed when you
2578 log on.
2579
2580    If you are connecting to the ICS by running telnet on an Internet
2581 provider or firewall host, you may find that each line you type is
2582 echoed back an extra time after you hit <Enter>. If your Internet
2583 provider is a Unix system, you can probably turn its echo off by typing
2584 `stty -echo' after you log in, and/or typing <^E><Enter> (Ctrl+E
2585 followed by the Enter key) to the telnet program after you have logged
2586 into ICS.  It is a good idea to do this if you can, because the extra
2587 echo can occasionally confuse XBoard's parsing routines.
2588
2589    The game parser recognizes only algebraic notation.
2590
2591    Many of the following points used to be limitations in XBoard 4.2.7
2592 and earlier, but are now fixed: The internal move legality tester in
2593 XBoard 4.3.xx does look at the game history, and is fully aware of
2594 castling or en-passant-capture rights. It permits castling with the
2595 king on the d file because this is possible in some "wild 1" games on
2596 ICS.  The piece-drop menu does not check piece drops in bughouse to see
2597 if you actually hold the piece you are trying to drop. But this way of
2598 dropping pieces should be considered an obsolete feature, now that
2599 pieces can be dropped by dragging them from the holdings to the board.
2600 Anyway, if you would attempt an illegal move when using a chess engine
2601 or the ICS, XBoard will accept the error message that comes back, undo
2602 the move, and let you try another.  FEN positions saved by XBoard do
2603 include correct information about whether castling or en passant are
2604 legal, and also handle the 50-move counter.  The mate detector does not
2605 understand that non-contact mate is not really mate in bughouse.  The
2606 only problem this causes while playing is minor: a "#" (mate indicator)
2607 character will show up after a non-contact mating move in the move
2608 list. XBoard will not assume the game is over at that point, not even
2609 when the option Detect Mates is on.  Edit Game mode always uses the
2610 rules of the selected variant, which can be a variant that uses piece
2611 drops.  You can load and edit games that contain piece drops.  The
2612 (obsolete) piece menus are not active, but you can perform piece drops
2613 by dragging pieces from the holdings.  Fischer Random castling is fully
2614 understood.  You can enter castlings by dragging the King on top of
2615 your Rook.  You can probably also play Fischer Random successfully on
2616 ICS by typing castling moves into the ICS Interaction window.
2617
2618    The menus may not work if your keyboard is in Caps Lock or Num Lock
2619 mode.  This seems to be a problem with the Athena menu widget, not an
2620 XBoard bug.
2621
2622    Also see the ToDo file included with the distribution for many other
2623 possible bugs, limitations, and ideas for improvement that have been
2624 suggested.
2625
2626 8 Reporting problems
2627 ********************
2628
2629 You can report bugs and problems with XBoard using the bug tracker at
2630 `https://savannah.gnu.org/projects/xboard/' or by sending mail to
2631 `<bug-xboard@gnu.org>'.  It can also be useful to report or discuss
2632 bugs in the WinBoard Forum at `http://www.open-aurec.com/wbforum/',
2633 WinBoard development section.
2634
2635    Please use the `script' program to start a typescript, run XBoard
2636 with the `-debug' option, and include the typescript output in your
2637 message.  Also tell us what kind of machine and what operating system
2638 version you are using.  The command `uname -a' will often tell you this.
2639
2640    If you improve XBoard, please send a message about your changes, and
2641 we will get in touch with you about merging them in to the main line of
2642 development.
2643
2644 9 Authors and contributors
2645 **************************
2646
2647 Chris Sears and Dan Sears wrote the original XBoard.  They were
2648 responsible for versions 1.0 through 1.2.  The color scheme was taken
2649 from Wayne Christopher's `XChess' program.
2650
2651    Tim Mann was primarily responsible for XBoard versions 1.3 through
2652 4.2.7, and for WinBoard (a port of XBoard to Microsoft Win32) from its
2653 inception through version 4.2.7.
2654
2655    John Chanak contributed the initial implementation of ICS mode.  Evan
2656 Welsh wrote `CMail', and Patrick Surry helped in designing, testing,
2657 and documenting it.  Elmar Bartel contributed the new piece bitmaps
2658 introduced in version 3.2.  Jochen Wiedmann converted the documentation
2659 to texinfo.  Frank McIngvale added click/click moving, the Analysis
2660 modes, piece flashing, ZIICS import, and ICS text colorization to
2661 XBoard.  Hugh Fisher added animated piece movement to XBoard, and
2662 Henrik Gram added it to WinBoard.  Mark Williams contributed the
2663 initial (WinBoard-only) implementation of many new features added to
2664 both XBoard and WinBoard in version 4.1.0, including copy/paste,
2665 premove, icsAlarm, autoFlipView, training mode, auto raise, and
2666 blindfold.  Ben Nye contributed X copy/paste code for XBoard.
2667
2668    In a fork from version 4.2.7, Alessandro Scotti added many elements
2669 to the user interface of WinBoard, including the board textures and
2670 font-based rendering, the evaluation-graph, move-history and
2671 engine-output window.  He was also responsible for adding the UCI
2672 support.
2673
2674    H. G. Muller continued this fork of the project, producing version
2675 4.3.  He made WinBoard castling- and e.p.-aware, added variant support
2676 with adjustable board sizes, the crazyhouse holdings, and the fairy
2677 pieces.  In addition he added most of the adjudication options, made
2678 WinBoard more robust in dealing with buggy and crashing engines, and
2679 extended time control with a time-odds and node-count-based modes.
2680 Most of the options that initially were WinBoard only have now been
2681 back-ported to XBoard.
2682
2683    Michel van den Bergh provided the code for reading Polyglot opening
2684 books.
2685
2686    Meanwhile, some work continued on the GNU XBoard project maintained
2687 at savannah.gnu.org, but version 4.2.8 was never released.  Daniel
2688 Mehrmann was responsible for much of this work.
2689
2690    Most recently, Arun Persaud worked with H. G. Muller to merge all
2691 the features of the never-released XBoard/WinBoard 4.2.8 of the GNU
2692 XBoard project and the never-released 4.3.16 from H. G.'s fork into a
2693 unified XBoard/WinBoard 4.4, which is now available both from the
2694 savannah.gnu.org web site and the WinBoard forum.
2695
2696 10 CMail
2697 ********
2698
2699 The `cmail' program can help you play chess by email with opponents of
2700 your choice using XBoard as an interface.
2701
2702    You will usually run `cmail' without giving any options.
2703
2704 10.1 CMail options
2705 ==================
2706
2707 -h
2708      Displays `cmail' usage information.
2709
2710 -c
2711      Shows the conditions of the GNU General Public License.  *Note
2712      Copying::.
2713
2714 -w
2715      Shows the warranty notice of the GNU General Public License.
2716      *Note Copying::.
2717
2718 -v
2719 -xv
2720      Provides or inhibits verbose output from `cmail' and XBoard,
2721      useful for debugging. The `-xv' form also inhibits the cmail
2722      introduction message.
2723
2724 -mail
2725 -xmail
2726      Invokes or inhibits the sending of a mail message containing the
2727      move.
2728
2729 -xboard
2730 -xxboard
2731      Invokes or inhibits the running of XBoard on the game file.
2732
2733 -reuse
2734 -xreuse
2735      Invokes or inhibits the reuse of an existing XBoard to display the
2736      current game.
2737
2738 -remail
2739      Resends the last mail message for that game. This inhibits running
2740      XBoard.
2741
2742 -game <name>
2743      The name of the game to be processed.
2744
2745 -wgames <number>
2746 -bgames <number>
2747 -games <number>
2748      Number of games to start as White, as Black or in total. Default
2749      is 1 as white and none as black. If only one color is specified
2750      then none of the other color is assumed. If no color is specified
2751      then equal numbers of White and Black games are started, with the
2752      extra game being as White if an odd number of total games is
2753      specified.
2754
2755 -me <short name>
2756 -opp <short name>
2757      A one-word alias for yourself or your opponent.
2758
2759 -wname <full name>
2760 -bname <full name>
2761 -name <full name>
2762 -oppname <full name>
2763      The full name of White, Black, yourself or your opponent.
2764
2765 -wna <net address>
2766 -bna <net address>
2767 -na <net address>
2768 -oppna <net address>
2769      The email address of White, Black, yourself or your opponent.
2770
2771 -dir <directory>
2772      The directory in which `cmail' keeps its files. This defaults to
2773      the environment variable `$CMAIL_DIR' or failing that, `$CHESSDIR',
2774      `$HOME/Chess' or `~/Chess'. It will be created if it does not
2775      exist.
2776
2777 -arcdir <directory>
2778      The directory in which `cmail' archives completed games. Defaults
2779      to the environment variable `$CMAIL_ARCDIR' or, in its absence,
2780      the same directory as cmail keeps its working files (above).
2781
2782 -mailprog <mail program>
2783      The program used by cmail to send email messages. This defaults to
2784      the environment variable `$CMAIL_MAILPROG' or failing that
2785      `/usr/ucb/Mail', `/usr/ucb/mail' or `Mail'. You will need to set
2786      this variable if none of the above paths fit your system.
2787
2788 -logFile <file>
2789      A file in which to dump verbose debugging messages that are
2790      invoked with the `-v' option.
2791
2792 -event <event>
2793      The PGN Event tag (default `Email correspondence game').
2794
2795 -site <site>
2796      The PGN Site tag (default `NET').
2797
2798 -round <round>
2799      The PGN Round tag (default `-', not applicable).
2800
2801 -mode <mode>
2802      The PGN Mode tag (default `EM', Electronic Mail).
2803
2804 Other options
2805      Any option flags not listed above are passed through to XBoard.
2806      Invoking XBoard through CMail changes the default values of two
2807      XBoard options: The default value for `-noChessProgram' is changed
2808      to true; that is, by default no chess engine is started.  The
2809      default value for `-timeDelay' is changed to 0; that is, by default
2810      XBoard immediately goes to the end of the game as played so far,
2811      rather than stepping through the moves one by one.  You can still
2812      set these options to whatever values you prefer by supplying them
2813      on CMail's command line.  *Note Options::.
2814
2815 10.2 Starting a CMail Game
2816 ==========================
2817
2818 Type `cmail' from a shell to start a game as white. After an opening
2819 message, you will be prompted for a game name, which is optional--if you
2820 simply press <Enter>, the game name will take the form
2821 `you-VS-opponent'. You will next be prompted for the short name of your
2822 opponent. If you haven't played this person before, you will also be
2823 prompted for his/her email address. `cmail' will then invoke XBoard in
2824 the background. Make your first move and select `Mail Move' from the
2825 `File' menu. *Note File Menu::. If all is well, `cmail' will mail a
2826 copy of the move to your opponent. If you select `Exit' without having
2827 selected `Mail Move' then no move will be made.
2828
2829 10.3 Answering a Move
2830 =====================
2831
2832 When you receive a message from an opponent containing a move in one of
2833 your games, simply pipe the message through `cmail'. In some mailers
2834 this is as simple as typing `| cmail' when viewing the message, while in
2835 others you may have to save the message to a file and do `cmail < file'
2836 at the command line. In either case `cmail' will display the game using
2837 XBoard. If you didn't exit XBoard when you made your first move then
2838 `cmail' will do its best to use the existing XBoard instead of starting
2839 a new one. As before, simply make a move and select `Mail Move' from
2840 the `File' menu. *Note File Menu::. `cmail' will try to use the XBoard
2841 that was most recently used to display the current game. This means
2842 that many games can be in progress simultaneously, each with its own
2843 active XBoard.
2844
2845    If you want to look at the history or explore a variation, go ahead,
2846 but you must return to the current position before XBoard will allow you
2847 to mail a move. If you edit the game's history you must select `Reload
2848 Same Game' from the `File' menu to get back to the original position,
2849 then make the move you want and select `Mail Move'.  As before, if you
2850 decide you aren't ready to make a move just yet you can either select
2851 `Exit' without sending a move or just leave XBoard running until you
2852 are ready.
2853
2854 10.4 Multi-Game Messages
2855 ========================
2856
2857 It is possible to have a `cmail' message carry more than one game.
2858 This feature was implemented to handle IECG (International Email Chess
2859 Group) matches, where a match consists of one game as white and one as
2860 black, with moves transmitted simultaneously. In case there are more
2861 general uses, `cmail' itself places no limit on the number of
2862 black/white games contained in a message; however, XBoard does.
2863
2864 10.5 Completing a Game
2865 ======================
2866
2867 Because XBoard can detect checkmate and stalemate, `cmail' handles game
2868 termination sensibly. As well as resignation, the `Action' menu allows
2869 draws to be offered and accepted for `cmail' games.
2870
2871    For multi-game messages, only unfinished and just-finished games
2872 will be included in email messages. When all the games are finished,
2873 they are archived in the user's archive directory, and similarly in the
2874 opponent's when he or she pipes the final message through `cmail'. The
2875 archive file name includes the date the game was started.
2876
2877 10.6 Known CMail Problems
2878 =========================
2879
2880 It's possible that a strange conjunction of conditions may occasionally
2881 mean that `cmail' has trouble reactivating an existing XBoard. If this
2882 should happen, simply trying it again should work.  If not, remove the
2883 file that stores the XBoard's PID (`game.pid') or use the `-xreuse'
2884 option to force `cmail' to start a new XBoard.
2885
2886    Versions of `cmail' after 2.16 no longer understand the old file
2887 format that XBoard used to use and so cannot be used to correspond with
2888 anyone using an older version.
2889
2890    Versions of `cmail' older than 2.11 do not handle multi-game
2891 messages, so multi-game correspondence is not possible with opponents
2892 using an older version.
2893
2894 11 Other programs you can use with XBoard
2895 *****************************************
2896
2897 Here are some other programs you can use with XBoard
2898
2899 11.1 GNU Chess
2900 ==============
2901
2902 The GNU Chess engine is available from:
2903
2904    ftp://ftp.gnu.org/gnu/gnuchess/
2905
2906    You can use XBoard to play a game against GNU Chess, or to interface
2907 GNU Chess to an ICS.
2908
2909 11.2 Fairy-Max
2910 ==============
2911
2912 Fairy-Max is a derivative from the once World's smallest Chess program
2913 micro-Max, which measures only about 100 lines of source code.  The
2914 main difference with micro-Max is that Fairy-Max loads its
2915 move-generator tables from a file, so that the rules for piece movement
2916 can be easily configured to implement unorthodox pieces.  Fairy-Max can
2917 therefore play a large number of variants, normal Chess being one of
2918 those.  In addition it plays Knightmate, Capablanca and Gothic Chess,
2919 Shatranj, Courier Chess, Cylinder chess, Berolina Chess, while the user
2920 can easily define new variants.  It can be obtained from:
2921
2922    http://home.hccnet.nl/h.g.muller/dwnldpage.html
2923
2924 11.3 HoiChess
2925 =============
2926
2927 HoiChess is a not-so-very-strong Chess engine, which comes with a
2928 derivative HoiXiangqi, able to play Chinese Chess. It can be obtained
2929 from the standard Linux repositories through:
2930
2931    sudo apt-get install hoichess
2932
2933 11.4 Crafty
2934 ===========
2935
2936 Crafty is a chess engine written by Bob Hyatt.  You can use XBoard to
2937 play a game against Crafty, hook Crafty up to an ICS, or use Crafty to
2938 interactively analyze games and positions for you.
2939
2940    Crafty is a strong, rapidly evolving chess program. This rapid pace
2941 of development is good, because it means Crafty is always getting
2942 better.  This can sometimes cause problems with backwards
2943 compatibility, but usually the latest version of Crafty will work well
2944 with the latest version of XBoard.  Crafty can be obtained from its
2945 author's FTP site: ftp://ftp.cis.uab.edu/hyatt/.
2946
2947    To use Crafty with XBoard, give the -fcp and -fd options as follows,
2948 where <crafty's directory> is the directory in which you installed
2949 Crafty and placed its book and other support files.
2950
2951 11.5 zic2xpm
2952 ============
2953
2954 The "zic2xpm" program is used to import chess sets from the ZIICS(*)
2955 program into XBoard. "zic2xpm" is part of the XBoard distribution.
2956 ZIICS is available from:
2957
2958    ftp://ftp.freechess.org/pub/chess/DOS/ziics131.exe
2959
2960    To import ZIICS pieces, do this:
2961 1. Unzip ziics131.exe into a directory:
2962           unzip -L ziics131.exe -d ~/ziics
2963
2964 2. Use zic2xpm to convert a set of pieces to XBoard format.
2965      For example, let's say you want to use the FRITZ4 set. These files
2966      are named "fritz4.*" in the ZIICS distribution.
2967
2968           mkdir ~/fritz4
2969           cd ~/fritz4
2970           zic2xpm ~/ziics/fritz4.*
2971
2972 3. Give XBoard the "-pixmap" option when starting up, e.g.:
2973           xboard -pixmap ~/fritz4
2974
2975      Alternatively, you can add this line to your `.Xresources' file:
2976
2977           xboard*pixmapDirectory: ~/fritz4
2978
2979    (*) ZIICS is a separate copyrighted work of Andy McFarland.  The
2980 "ZIICS pieces" are copyrighted works of their respective creators.
2981 Files produced by "zic2xpm" are for PERSONAL USE ONLY and may NOT be
2982 redistributed without explicit permission from the original creator(s)
2983 of the pieces.
2984
2985 Copyright
2986 *********
2987
2988 Copyright (C) 1991 Digital Equipment Corporation, Maynard,
2989 Massachusetts.
2990
2991    All Rights Reserved.
2992
2993    Permission to use, copy, modify, and distribute this software and its
2994 documentation for any purpose and without fee is hereby granted,
2995 provided that the above copyright notice appear in all copies and that
2996 both that copyright notice and this permission notice appear in
2997 supporting documentation, and that the name of Digital not be used in
2998 advertising or publicity pertaining to distribution of the software
2999 without specific, written prior permission.
3000
3001    Digital disclaims all warranties with regard to this software,
3002 including all implied warranties of merchantability and fitness.  In no
3003 event shall Digital be liable for any special, indirect or
3004 consequential damages or any damages whatsoever resulting from loss of
3005 use, data or profits, whether in an action of contract, negligence or
3006 other tortious action, arising out of or in connection with the use or
3007 performance of this software.
3008
3009    Enhancements copyright (C) 1992-2003, 2004, 2005, 2006, 2007, 2008,
3010 2009, 2010, 2011 Free Software Foundation, Inc.
3011
3012 Published by the Free Software Foundation
3013 59 Temple Place - Suite 330
3014 Boston, MA 02111-1307 USA
3015
3016    Permission is granted to make and distribute verbatim copies of this
3017 manual provided the copyright notice and this permission notice are
3018 preserved on all copies.
3019
3020    Permission is granted to copy and distribute modified versions of
3021 this manual under the conditions for verbatim copying, provided also
3022 that the section entitled "GNU General Public License," is included
3023 exactly as in the original, and provided that the entire resulting
3024 derived work is distributed under the terms of a permission notice
3025 identical to this one.
3026
3027    Permission is granted to copy and distribute translations of this
3028 manual into another language, under the above conditions for modified
3029 versions, except that the section entitled "GNU General Public License,"
3030 and this permission notice, may be included in translations approved by
3031 the Free Software Foundation instead of in the original English.
3032
3033 GNU GENERAL PUBLIC LICENSE
3034 **************************
3035
3036                         Version 3, 29 June 2007
3037
3038      Copyright (C) 2007 Free Software Foundation, Inc. `http://fsf.org/'
3039
3040      Everyone is permitted to copy and distribute verbatim copies of this
3041      license document, but changing it is not allowed.
3042
3043 Preamble
3044 ========
3045
3046 The GNU General Public License is a free, copyleft license for software
3047 and other kinds of works.
3048
3049    The licenses for most software and other practical works are designed
3050 to take away your freedom to share and change the works.  By contrast,
3051 the GNU General Public License is intended to guarantee your freedom to
3052 share and change all versions of a program--to make sure it remains
3053 free software for all its users.  We, the Free Software Foundation, use
3054 the GNU General Public License for most of our software; it applies
3055 also to any other work released this way by its authors.  You can apply
3056 it to your programs, too.
3057
3058    When we speak of free software, we are referring to freedom, not
3059 price.  Our General Public Licenses are designed to make sure that you
3060 have the freedom to distribute copies of free software (and charge for
3061 them if you wish), that you receive source code or can get it if you
3062 want it, that you can change the software or use pieces of it in new
3063 free programs, and that you know you can do these things.
3064
3065    To protect your rights, we need to prevent others from denying you
3066 these rights or asking you to surrender the rights.  Therefore, you
3067 have certain responsibilities if you distribute copies of the software,
3068 or if you modify it: responsibilities to respect the freedom of others.
3069
3070    For example, if you distribute copies of such a program, whether
3071 gratis or for a fee, you must pass on to the recipients the same
3072 freedoms that you received.  You must make sure that they, too, receive
3073 or can get the source code.  And you must show them these terms so they
3074 know their rights.
3075
3076    Developers that use the GNU GPL protect your rights with two steps:
3077 (1) assert copyright on the software, and (2) offer you this License
3078 giving you legal permission to copy, distribute and/or modify it.
3079
3080    For the developers' and authors' protection, the GPL clearly explains
3081 that there is no warranty for this free software.  For both users' and
3082 authors' sake, the GPL requires that modified versions be marked as
3083 changed, so that their problems will not be attributed erroneously to
3084 authors of previous versions.
3085
3086    Some devices are designed to deny users access to install or run
3087 modified versions of the software inside them, although the
3088 manufacturer can do so.  This is fundamentally incompatible with the
3089 aim of protecting users' freedom to change the software.  The
3090 systematic pattern of such abuse occurs in the area of products for
3091 individuals to use, which is precisely where it is most unacceptable.
3092 Therefore, we have designed this version of the GPL to prohibit the
3093 practice for those products.  If such problems arise substantially in
3094 other domains, we stand ready to extend this provision to those domains
3095 in future versions of the GPL, as needed to protect the freedom of
3096 users.
3097
3098    Finally, every program is threatened constantly by software patents.
3099 States should not allow patents to restrict development and use of
3100 software on general-purpose computers, but in those that do, we wish to
3101 avoid the special danger that patents applied to a free program could
3102 make it effectively proprietary.  To prevent this, the GPL assures that
3103 patents cannot be used to render the program non-free.
3104
3105    The precise terms and conditions for copying, distribution and
3106 modification follow.
3107
3108 TERMS AND CONDITIONS
3109 ====================
3110
3111   0. Definitions.
3112
3113      "This License" refers to version 3 of the GNU General Public
3114      License.
3115
3116      "Copyright" also means copyright-like laws that apply to other
3117      kinds of works, such as semiconductor masks.
3118
3119      "The Program" refers to any copyrightable work licensed under this
3120      License.  Each licensee is addressed as "you".  "Licensees" and
3121      "recipients" may be individuals or organizations.
3122
3123      To "modify" a work means to copy from or adapt all or part of the
3124      work in a fashion requiring copyright permission, other than the
3125      making of an exact copy.  The resulting work is called a "modified
3126      version" of the earlier work or a work "based on" the earlier work.
3127
3128      A "covered work" means either the unmodified Program or a work
3129      based on the Program.
3130
3131      To "propagate" a work means to do anything with it that, without
3132      permission, would make you directly or secondarily liable for
3133      infringement under applicable copyright law, except executing it
3134      on a computer or modifying a private copy.  Propagation includes
3135      copying, distribution (with or without modification), making
3136      available to the public, and in some countries other activities as
3137      well.
3138
3139      To "convey" a work means any kind of propagation that enables other
3140      parties to make or receive copies.  Mere interaction with a user
3141      through a computer network, with no transfer of a copy, is not
3142      conveying.
3143
3144      An interactive user interface displays "Appropriate Legal Notices"
3145      to the extent that it includes a convenient and prominently visible
3146      feature that (1) displays an appropriate copyright notice, and (2)
3147      tells the user that there is no warranty for the work (except to
3148      the extent that warranties are provided), that licensees may
3149      convey the work under this License, and how to view a copy of this
3150      License.  If the interface presents a list of user commands or
3151      options, such as a menu, a prominent item in the list meets this
3152      criterion.
3153
3154   1. Source Code.
3155
3156      The "source code" for a work means the preferred form of the work
3157      for making modifications to it.  "Object code" means any
3158      non-source form of a work.
3159
3160      A "Standard Interface" means an interface that either is an
3161      official standard defined by a recognized standards body, or, in
3162      the case of interfaces specified for a particular programming
3163      language, one that is widely used among developers working in that
3164      language.
3165
3166      The "System Libraries" of an executable work include anything,
3167      other than the work as a whole, that (a) is included in the normal
3168      form of packaging a Major Component, but which is not part of that
3169      Major Component, and (b) serves only to enable use of the work
3170      with that Major Component, or to implement a Standard Interface
3171      for which an implementation is available to the public in source
3172      code form.  A "Major Component", in this context, means a major
3173      essential component (kernel, window system, and so on) of the
3174      specific operating system (if any) on which the executable work
3175      runs, or a compiler used to produce the work, or an object code
3176      interpreter used to run it.
3177
3178      The "Corresponding Source" for a work in object code form means all
3179      the source code needed to generate, install, and (for an executable
3180      work) run the object code and to modify the work, including
3181      scripts to control those activities.  However, it does not include
3182      the work's System Libraries, or general-purpose tools or generally
3183      available free programs which are used unmodified in performing
3184      those activities but which are not part of the work.  For example,
3185      Corresponding Source includes interface definition files
3186      associated with source files for the work, and the source code for
3187      shared libraries and dynamically linked subprograms that the work
3188      is specifically designed to require, such as by intimate data
3189      communication or control flow between those subprograms and other
3190      parts of the work.
3191
3192      The Corresponding Source need not include anything that users can
3193      regenerate automatically from other parts of the Corresponding
3194      Source.
3195
3196      The Corresponding Source for a work in source code form is that
3197      same work.
3198
3199   2. Basic Permissions.
3200
3201      All rights granted under this License are granted for the term of
3202      copyright on the Program, and are irrevocable provided the stated
3203      conditions are met.  This License explicitly affirms your unlimited
3204      permission to run the unmodified Program.  The output from running
3205      a covered work is covered by this License only if the output,
3206      given its content, constitutes a covered work.  This License
3207      acknowledges your rights of fair use or other equivalent, as
3208      provided by copyright law.
3209
3210      You may make, run and propagate covered works that you do not
3211      convey, without conditions so long as your license otherwise
3212      remains in force.  You may convey covered works to others for the
3213      sole purpose of having them make modifications exclusively for
3214      you, or provide you with facilities for running those works,
3215      provided that you comply with the terms of this License in
3216      conveying all material for which you do not control copyright.
3217      Those thus making or running the covered works for you must do so
3218      exclusively on your behalf, under your direction and control, on
3219      terms that prohibit them from making any copies of your
3220      copyrighted material outside their relationship with you.
3221
3222      Conveying under any other circumstances is permitted solely under
3223      the conditions stated below.  Sublicensing is not allowed; section
3224      10 makes it unnecessary.
3225
3226   3. Protecting Users' Legal Rights From Anti-Circumvention Law.
3227
3228      No covered work shall be deemed part of an effective technological
3229      measure under any applicable law fulfilling obligations under
3230      article 11 of the WIPO copyright treaty adopted on 20 December
3231      1996, or similar laws prohibiting or restricting circumvention of
3232      such measures.
3233
3234      When you convey a covered work, you waive any legal power to forbid
3235      circumvention of technological measures to the extent such
3236      circumvention is effected by exercising rights under this License
3237      with respect to the covered work, and you disclaim any intention
3238      to limit operation or modification of the work as a means of
3239      enforcing, against the work's users, your or third parties' legal
3240      rights to forbid circumvention of technological measures.
3241
3242   4. Conveying Verbatim Copies.
3243
3244      You may convey verbatim copies of the Program's source code as you
3245      receive it, in any medium, provided that you conspicuously and
3246      appropriately publish on each copy an appropriate copyright notice;
3247      keep intact all notices stating that this License and any
3248      non-permissive terms added in accord with section 7 apply to the
3249      code; keep intact all notices of the absence of any warranty; and
3250      give all recipients a copy of this License along with the Program.
3251
3252      You may charge any price or no price for each copy that you convey,
3253      and you may offer support or warranty protection for a fee.
3254
3255   5. Conveying Modified Source Versions.
3256
3257      You may convey a work based on the Program, or the modifications to
3258      produce it from the Program, in the form of source code under the
3259      terms of section 4, provided that you also meet all of these
3260      conditions:
3261
3262        a. The work must carry prominent notices stating that you
3263           modified it, and giving a relevant date.
3264
3265        b. The work must carry prominent notices stating that it is
3266           released under this License and any conditions added under
3267           section 7.  This requirement modifies the requirement in
3268           section 4 to "keep intact all notices".
3269
3270        c. You must license the entire work, as a whole, under this
3271           License to anyone who comes into possession of a copy.  This
3272           License will therefore apply, along with any applicable
3273           section 7 additional terms, to the whole of the work, and all
3274           its parts, regardless of how they are packaged.  This License
3275           gives no permission to license the work in any other way, but
3276           it does not invalidate such permission if you have separately
3277           received it.
3278
3279        d. If the work has interactive user interfaces, each must display
3280           Appropriate Legal Notices; however, if the Program has
3281           interactive interfaces that do not display Appropriate Legal
3282           Notices, your work need not make them do so.
3283
3284      A compilation of a covered work with other separate and independent
3285      works, which are not by their nature extensions of the covered
3286      work, and which are not combined with it such as to form a larger
3287      program, in or on a volume of a storage or distribution medium, is
3288      called an "aggregate" if the compilation and its resulting
3289      copyright are not used to limit the access or legal rights of the
3290      compilation's users beyond what the individual works permit.
3291      Inclusion of a covered work in an aggregate does not cause this
3292      License to apply to the other parts of the aggregate.
3293
3294   6. Conveying Non-Source Forms.
3295
3296      You may convey a covered work in object code form under the terms
3297      of sections 4 and 5, provided that you also convey the
3298      machine-readable Corresponding Source under the terms of this
3299      License, in one of these ways:
3300
3301        a. Convey the object code in, or embodied in, a physical product
3302           (including a physical distribution medium), accompanied by the
3303           Corresponding Source fixed on a durable physical medium
3304           customarily used for software interchange.
3305
3306        b. Convey the object code in, or embodied in, a physical product
3307           (including a physical distribution medium), accompanied by a
3308           written offer, valid for at least three years and valid for
3309           as long as you offer spare parts or customer support for that
3310           product model, to give anyone who possesses the object code
3311           either (1) a copy of the Corresponding Source for all the
3312           software in the product that is covered by this License, on a
3313           durable physical medium customarily used for software
3314           interchange, for a price no more than your reasonable cost of
3315           physically performing this conveying of source, or (2) access
3316           to copy the Corresponding Source from a network server at no
3317           charge.
3318
3319        c. Convey individual copies of the object code with a copy of
3320           the written offer to provide the Corresponding Source.  This
3321           alternative is allowed only occasionally and noncommercially,
3322           and only if you received the object code with such an offer,
3323           in accord with subsection 6b.
3324
3325        d. Convey the object code by offering access from a designated
3326           place (gratis or for a charge), and offer equivalent access
3327           to the Corresponding Source in the same way through the same
3328           place at no further charge.  You need not require recipients
3329           to copy the Corresponding Source along with the object code.
3330           If the place to copy the object code is a network server, the
3331           Corresponding Source may be on a different server (operated
3332           by you or a third party) that supports equivalent copying
3333           facilities, provided you maintain clear directions next to
3334           the object code saying where to find the Corresponding Source.
3335           Regardless of what server hosts the Corresponding Source, you
3336           remain obligated to ensure that it is available for as long
3337           as needed to satisfy these requirements.
3338
3339        e. Convey the object code using peer-to-peer transmission,
3340           provided you inform other peers where the object code and
3341           Corresponding Source of the work are being offered to the
3342           general public at no charge under subsection 6d.
3343
3344
3345      A separable portion of the object code, whose source code is
3346      excluded from the Corresponding Source as a System Library, need
3347      not be included in conveying the object code work.
3348
3349      A "User Product" is either (1) a "consumer product", which means
3350      any tangible personal property which is normally used for personal,
3351      family, or household purposes, or (2) anything designed or sold for
3352      incorporation into a dwelling.  In determining whether a product
3353      is a consumer product, doubtful cases shall be resolved in favor of
3354      coverage.  For a particular product received by a particular user,
3355      "normally used" refers to a typical or common use of that class of
3356      product, regardless of the status of the particular user or of the
3357      way in which the particular user actually uses, or expects or is
3358      expected to use, the product.  A product is a consumer product
3359      regardless of whether the product has substantial commercial,
3360      industrial or non-consumer uses, unless such uses represent the
3361      only significant mode of use of the product.
3362
3363      "Installation Information" for a User Product means any methods,
3364      procedures, authorization keys, or other information required to
3365      install and execute modified versions of a covered work in that
3366      User Product from a modified version of its Corresponding Source.
3367      The information must suffice to ensure that the continued
3368      functioning of the modified object code is in no case prevented or
3369      interfered with solely because modification has been made.
3370
3371      If you convey an object code work under this section in, or with,
3372      or specifically for use in, a User Product, and the conveying
3373      occurs as part of a transaction in which the right of possession
3374      and use of the User Product is transferred to the recipient in
3375      perpetuity or for a fixed term (regardless of how the transaction
3376      is characterized), the Corresponding Source conveyed under this
3377      section must be accompanied by the Installation Information.  But
3378      this requirement does not apply if neither you nor any third party
3379      retains the ability to install modified object code on the User
3380      Product (for example, the work has been installed in ROM).
3381
3382      The requirement to provide Installation Information does not
3383      include a requirement to continue to provide support service,
3384      warranty, or updates for a work that has been modified or
3385      installed by the recipient, or for the User Product in which it
3386      has been modified or installed.  Access to a network may be denied
3387      when the modification itself materially and adversely affects the
3388      operation of the network or violates the rules and protocols for
3389      communication across the network.
3390
3391      Corresponding Source conveyed, and Installation Information
3392      provided, in accord with this section must be in a format that is
3393      publicly documented (and with an implementation available to the
3394      public in source code form), and must require no special password
3395      or key for unpacking, reading or copying.
3396
3397   7. Additional Terms.
3398
3399      "Additional permissions" are terms that supplement the terms of
3400      this License by making exceptions from one or more of its
3401      conditions.  Additional permissions that are applicable to the
3402      entire Program shall be treated as though they were included in
3403      this License, to the extent that they are valid under applicable
3404      law.  If additional permissions apply only to part of the Program,
3405      that part may be used separately under those permissions, but the
3406      entire Program remains governed by this License without regard to
3407      the additional permissions.
3408
3409      When you convey a copy of a covered work, you may at your option
3410      remove any additional permissions from that copy, or from any part
3411      of it.  (Additional permissions may be written to require their own
3412      removal in certain cases when you modify the work.)  You may place
3413      additional permissions on material, added by you to a covered work,
3414      for which you have or can give appropriate copyright permission.
3415
3416      Notwithstanding any other provision of this License, for material
3417      you add to a covered work, you may (if authorized by the copyright
3418      holders of that material) supplement the terms of this License
3419      with terms:
3420
3421        a. Disclaiming warranty or limiting liability differently from
3422           the terms of sections 15 and 16 of this License; or
3423
3424        b. Requiring preservation of specified reasonable legal notices
3425           or author attributions in that material or in the Appropriate
3426           Legal Notices displayed by works containing it; or
3427
3428        c. Prohibiting misrepresentation of the origin of that material,
3429           or requiring that modified versions of such material be
3430           marked in reasonable ways as different from the original
3431           version; or
3432
3433        d. Limiting the use for publicity purposes of names of licensors
3434           or authors of the material; or
3435
3436        e. Declining to grant rights under trademark law for use of some
3437           trade names, trademarks, or service marks; or
3438
3439        f. Requiring indemnification of licensors and authors of that
3440           material by anyone who conveys the material (or modified
3441           versions of it) with contractual assumptions of liability to
3442           the recipient, for any liability that these contractual
3443           assumptions directly impose on those licensors and authors.
3444
3445      All other non-permissive additional terms are considered "further
3446      restrictions" within the meaning of section 10.  If the Program as
3447      you received it, or any part of it, contains a notice stating that
3448      it is governed by this License along with a term that is a further
3449      restriction, you may remove that term.  If a license document
3450      contains a further restriction but permits relicensing or
3451      conveying under this License, you may add to a covered work
3452      material governed by the terms of that license document, provided
3453      that the further restriction does not survive such relicensing or
3454      conveying.
3455
3456      If you add terms to a covered work in accord with this section, you
3457      must place, in the relevant source files, a statement of the
3458      additional terms that apply to those files, or a notice indicating
3459      where to find the applicable terms.
3460
3461      Additional terms, permissive or non-permissive, may be stated in
3462      the form of a separately written license, or stated as exceptions;
3463      the above requirements apply either way.
3464
3465   8. Termination.
3466
3467      You may not propagate or modify a covered work except as expressly
3468      provided under this License.  Any attempt otherwise to propagate or
3469      modify it is void, and will automatically terminate your rights
3470      under this License (including any patent licenses granted under
3471      the third paragraph of section 11).
3472
3473      However, if you cease all violation of this License, then your
3474      license from a particular copyright holder is reinstated (a)
3475      provisionally, unless and until the copyright holder explicitly
3476      and finally terminates your license, and (b) permanently, if the
3477      copyright holder fails to notify you of the violation by some
3478      reasonable means prior to 60 days after the cessation.
3479
3480      Moreover, your license from a particular copyright holder is
3481      reinstated permanently if the copyright holder notifies you of the
3482      violation by some reasonable means, this is the first time you have
3483      received notice of violation of this License (for any work) from
3484      that copyright holder, and you cure the violation prior to 30 days
3485      after your receipt of the notice.
3486
3487      Termination of your rights under this section does not terminate
3488      the licenses of parties who have received copies or rights from
3489      you under this License.  If your rights have been terminated and
3490      not permanently reinstated, you do not qualify to receive new
3491      licenses for the same material under section 10.
3492
3493   9. Acceptance Not Required for Having Copies.
3494
3495      You are not required to accept this License in order to receive or
3496      run a copy of the Program.  Ancillary propagation of a covered work
3497      occurring solely as a consequence of using peer-to-peer
3498      transmission to receive a copy likewise does not require
3499      acceptance.  However, nothing other than this License grants you
3500      permission to propagate or modify any covered work.  These actions
3501      infringe copyright if you do not accept this License.  Therefore,
3502      by modifying or propagating a covered work, you indicate your
3503      acceptance of this License to do so.
3504
3505  10. Automatic Licensing of Downstream Recipients.
3506
3507      Each time you convey a covered work, the recipient automatically
3508      receives a license from the original licensors, to run, modify and
3509      propagate that work, subject to this License.  You are not
3510      responsible for enforcing compliance by third parties with this
3511      License.
3512
3513      An "entity transaction" is a transaction transferring control of an
3514      organization, or substantially all assets of one, or subdividing an
3515      organization, or merging organizations.  If propagation of a
3516      covered work results from an entity transaction, each party to that
3517      transaction who receives a copy of the work also receives whatever
3518      licenses to the work the party's predecessor in interest had or
3519      could give under the previous paragraph, plus a right to
3520      possession of the Corresponding Source of the work from the
3521      predecessor in interest, if the predecessor has it or can get it
3522      with reasonable efforts.
3523
3524      You may not impose any further restrictions on the exercise of the
3525      rights granted or affirmed under this License.  For example, you
3526      may not impose a license fee, royalty, or other charge for
3527      exercise of rights granted under this License, and you may not
3528      initiate litigation (including a cross-claim or counterclaim in a
3529      lawsuit) alleging that any patent claim is infringed by making,
3530      using, selling, offering for sale, or importing the Program or any
3531      portion of it.
3532
3533  11. Patents.
3534
3535      A "contributor" is a copyright holder who authorizes use under this
3536      License of the Program or a work on which the Program is based.
3537      The work thus licensed is called the contributor's "contributor
3538      version".
3539
3540      A contributor's "essential patent claims" are all patent claims
3541      owned or controlled by the contributor, whether already acquired or
3542      hereafter acquired, that would be infringed by some manner,
3543      permitted by this License, of making, using, or selling its
3544      contributor version, but do not include claims that would be
3545      infringed only as a consequence of further modification of the
3546      contributor version.  For purposes of this definition, "control"
3547      includes the right to grant patent sublicenses in a manner
3548      consistent with the requirements of this License.
3549
3550      Each contributor grants you a non-exclusive, worldwide,
3551      royalty-free patent license under the contributor's essential
3552      patent claims, to make, use, sell, offer for sale, import and
3553      otherwise run, modify and propagate the contents of its
3554      contributor version.
3555
3556      In the following three paragraphs, a "patent license" is any
3557      express agreement or commitment, however denominated, not to
3558      enforce a patent (such as an express permission to practice a
3559      patent or covenant not to sue for patent infringement).  To
3560      "grant" such a patent license to a party means to make such an
3561      agreement or commitment not to enforce a patent against the party.
3562
3563      If you convey a covered work, knowingly relying on a patent
3564      license, and the Corresponding Source of the work is not available
3565      for anyone to copy, free of charge and under the terms of this
3566      License, through a publicly available network server or other
3567      readily accessible means, then you must either (1) cause the
3568      Corresponding Source to be so available, or (2) arrange to deprive
3569      yourself of the benefit of the patent license for this particular
3570      work, or (3) arrange, in a manner consistent with the requirements
3571      of this License, to extend the patent license to downstream
3572      recipients.  "Knowingly relying" means you have actual knowledge
3573      that, but for the patent license, your conveying the covered work
3574      in a country, or your recipient's use of the covered work in a
3575      country, would infringe one or more identifiable patents in that
3576      country that you have reason to believe are valid.
3577
3578      If, pursuant to or in connection with a single transaction or
3579      arrangement, you convey, or propagate by procuring conveyance of, a
3580      covered work, and grant a patent license to some of the parties
3581      receiving the covered work authorizing them to use, propagate,
3582      modify or convey a specific copy of the covered work, then the
3583      patent license you grant is automatically extended to all
3584      recipients of the covered work and works based on it.
3585
3586      A patent license is "discriminatory" if it does not include within
3587      the scope of its coverage, prohibits the exercise of, or is
3588      conditioned on the non-exercise of one or more of the rights that
3589      are specifically granted under this License.  You may not convey a
3590      covered work if you are a party to an arrangement with a third
3591      party that is in the business of distributing software, under
3592      which you make payment to the third party based on the extent of
3593      your activity of conveying the work, and under which the third
3594      party grants, to any of the parties who would receive the covered
3595      work from you, a discriminatory patent license (a) in connection
3596      with copies of the covered work conveyed by you (or copies made
3597      from those copies), or (b) primarily for and in connection with
3598      specific products or compilations that contain the covered work,
3599      unless you entered into that arrangement, or that patent license
3600      was granted, prior to 28 March 2007.
3601
3602      Nothing in this License shall be construed as excluding or limiting
3603      any implied license or other defenses to infringement that may
3604      otherwise be available to you under applicable patent law.
3605
3606  12. No Surrender of Others' Freedom.
3607
3608      If conditions are imposed on you (whether by court order,
3609      agreement or otherwise) that contradict the conditions of this
3610      License, they do not excuse you from the conditions of this
3611      License.  If you cannot convey a covered work so as to satisfy
3612      simultaneously your obligations under this License and any other
3613      pertinent obligations, then as a consequence you may not convey it
3614      at all.  For example, if you agree to terms that obligate you to
3615      collect a royalty for further conveying from those to whom you
3616      convey the Program, the only way you could satisfy both those
3617      terms and this License would be to refrain entirely from conveying
3618      the Program.
3619
3620  13. Use with the GNU Affero General Public License.
3621
3622      Notwithstanding any other provision of this License, you have
3623      permission to link or combine any covered work with a work licensed
3624      under version 3 of the GNU Affero General Public License into a
3625      single combined work, and to convey the resulting work.  The terms
3626      of this License will continue to apply to the part which is the
3627      covered work, but the special requirements of the GNU Affero
3628      General Public License, section 13, concerning interaction through
3629      a network will apply to the combination as such.
3630
3631  14. Revised Versions of this License.
3632
3633      The Free Software Foundation may publish revised and/or new
3634      versions of the GNU General Public License from time to time.
3635      Such new versions will be similar in spirit to the present
3636      version, but may differ in detail to address new problems or
3637      concerns.
3638
3639      Each version is given a distinguishing version number.  If the
3640      Program specifies that a certain numbered version of the GNU
3641      General Public License "or any later version" applies to it, you
3642      have the option of following the terms and conditions either of
3643      that numbered version or of any later version published by the
3644      Free Software Foundation.  If the Program does not specify a
3645      version number of the GNU General Public License, you may choose
3646      any version ever published by the Free Software Foundation.
3647
3648      If the Program specifies that a proxy can decide which future
3649      versions of the GNU General Public License can be used, that
3650      proxy's public statement of acceptance of a version permanently
3651      authorizes you to choose that version for the Program.
3652
3653      Later license versions may give you additional or different
3654      permissions.  However, no additional obligations are imposed on any
3655      author or copyright holder as a result of your choosing to follow a
3656      later version.
3657
3658  15. Disclaimer of Warranty.
3659
3660      THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
3661      APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE
3662      COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS"
3663      WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED,
3664      INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
3665      MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE
3666      RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.
3667      SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL
3668      NECESSARY SERVICING, REPAIR OR CORRECTION.
3669
3670  16. Limitation of Liability.
3671
3672      IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
3673      WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES
3674      AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU
3675      FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR
3676      CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE
3677      THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA
3678      BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
3679      PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
3680      PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF
3681      THE POSSIBILITY OF SUCH DAMAGES.
3682
3683  17. Interpretation of Sections 15 and 16.
3684
3685      If the disclaimer of warranty and limitation of liability provided
3686      above cannot be given local legal effect according to their terms,
3687      reviewing courts shall apply local law that most closely
3688      approximates an absolute waiver of all civil liability in
3689      connection with the Program, unless a warranty or assumption of
3690      liability accompanies a copy of the Program in return for a fee.
3691
3692
3693 END OF TERMS AND CONDITIONS
3694 ===========================
3695
3696 How to Apply These Terms to Your New Programs
3697 =============================================
3698
3699 If you develop a new program, and you want it to be of the greatest
3700 possible use to the public, the best way to achieve this is to make it
3701 free software which everyone can redistribute and change under these
3702 terms.
3703
3704    To do so, attach the following notices to the program.  It is safest
3705 to attach them to the start of each source file to most effectively
3706 state the exclusion of warranty; and each file should have at least the
3707 "copyright" line and a pointer to where the full notice is found.
3708
3709      ONE LINE TO GIVE THE PROGRAM'S NAME AND A BRIEF IDEA OF WHAT IT DOES.
3710      Copyright (C) YEAR NAME OF AUTHOR
3711
3712      This program is free software: you can redistribute it and/or modify
3713      it under the terms of the GNU General Public License as published by
3714      the Free Software Foundation, either version 3 of the License, or (at
3715      your option) any later version.
3716
3717      This program is distributed in the hope that it will be useful, but
3718      WITHOUT ANY WARRANTY; without even the implied warranty of
3719      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
3720      General Public License for more details.
3721
3722      You should have received a copy of the GNU General Public License
3723      along with this program.  If not, see `http://www.gnu.org/licenses/'.
3724
3725    Also add information on how to contact you by electronic and paper
3726 mail.
3727
3728    If the program does terminal interaction, make it output a short
3729 notice like this when it starts in an interactive mode:
3730
3731      PROGRAM Copyright (C) YEAR NAME OF AUTHOR
3732      This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
3733      This is free software, and you are welcome to redistribute it
3734      under certain conditions; type `show c' for details.
3735
3736    The hypothetical commands `show w' and `show c' should show the
3737 appropriate parts of the General Public License.  Of course, your
3738 program's commands might be different; for a GUI interface, you would
3739 use an "about box".
3740
3741    You should also get your employer (if you work as a programmer) or
3742 school, if any, to sign a "copyright disclaimer" for the program, if
3743 necessary.  For more information on this, and how to apply and follow
3744 the GNU GPL, see `http://www.gnu.org/licenses/'.
3745
3746    The GNU General Public License does not permit incorporating your
3747 program into proprietary programs.  If your program is a subroutine
3748 library, you may consider it more useful to permit linking proprietary
3749 applications with the library.  If this is what you want to do, use the
3750 GNU Lesser General Public License instead of this License.  But first,
3751 please read `http://www.gnu.org/philosophy/why-not-lgpl.html'.
3752
3753 Index
3754 *****
3755
3756 -animateSpeed, option:                         See 3.5.      (line 2101)
3757 -autoDisplayComment, option:                   See 3.5.      (line 2106)
3758 -autoDisplayTags, option:                      See 3.5.      (line 2106)
3759 -pasteSelection, option:                       See 3.5.      (line 2112)
3760 .icsrc:                                        See 3.3.      (line 1518)
3761 <, Button:                                     See 2.2.      (line  348)
3762 <<, Button:                                    See 2.2.      (line  381)
3763 >, Button:                                     See 2.2.      (line  368)
3764 >>, Button:                                    See 2.2.      (line  400)
3765 abort, ICS command:                            See 4.        (line 2415)
3766 Abort, Menu Item:                              See 2.5.      (line  618)
3767 About XBoard, Menu Item:                       See 2.8.      (line 1019)
3768 accept, ICS command:                           See 4.        (line 2402)
3769 Accept, Menu Item:                             See 2.5.      (line  590)
3770 Action, Menu:                                  See 2.5.      (line  589)
3771 adjourn, ICS command:                          See 4.        (line 2415)
3772 Adjourn, Menu Item:                            See 2.5.      (line  613)
3773 Adjudicate Draw, Menu Item:                    See 2.5.      (line  646)
3774 Adjudicate to Black, Menu Item:                See 2.5.      (line  646)
3775 Adjudicate to White, Menu Item:                See 2.5.      (line  646)
3776 adjudicateDrawMoves, option:                   See 3.6.      (line 2128)
3777 adjudicateLossThreshold, option:               See 3.6.      (line 2120)
3778 Adjudications, Menu Item:                      See 2.7.      (line  727)
3779 alarm, option:                                 See 3.3.      (line 1606)
3780 Always Queen, Menu Item:                       See 2.7.      (line  754)
3781 alwaysPromoteToQueen, option:                  See 3.5.      (line 1882)
3782 Analysis Mode, Menu Item:                      See 2.4.      (line  483)
3783 Analyze File, Menu Item:                       See 2.4.      (line  505)
3784 Animate Dragging, Menu Item:                   See 2.7.      (line  761)
3785 Animate Moving, Menu Item:                     See 2.7.      (line  768)
3786 animate, option:                               See 3.5.      (line 2097)
3787 animateDragging, option:                       See 3.5.      (line 2093)
3788 animateMoving, option:                         See 3.5.      (line 2097)
3789 Annotate, Menu Item:                           See 2.2.      (line  324)
3790 at sign, option:                               See 3.4.      (line 1835)
3791 Authors:                                       See 9.        (line 2647)
3792 Auto Comment, Menu Item:                       See 2.7.      (line  777)
3793 Auto Flag, Menu Item:                          See 2.7.      (line  785)
3794 Auto Flip View, Menu Item:                     See 2.7.      (line  795)
3795 Auto Observe, Menu Item:                       See 2.7.      (line  800)
3796 Auto Raise Board, Menu Item:                   See 2.7.      (line  813)
3797 Auto Save, Menu Item:                          See 2.7.      (line  818)
3798 autobs, option:                                See 3.3.      (line 1545)
3799 autoCallFlag, option:                          See 3.3.      (line 1541)
3800 autocomm, option:                              See 3.3.      (line 1537)
3801 autoComment, option:                           See 3.3.      (line 1537)
3802 autoflag, option:                              See 3.3.      (line 1541)
3803 autoflip, option:                              See 3.5.      (line 1933)
3804 autoFlipView, option:                          See 3.5.      (line 1933)
3805 autoKibitz, option:                            See 3.3.      (line 1549)
3806 autoObserve, option:                           See 3.3.      (line 1545)
3807 autoraise, option:                             See 3.5.      (line 1929)
3808 autoRaiseBoard, option:                        See 3.5.      (line 1929)
3809 autoRefresh, option:                           See 3.3.      (line 1566)
3810 autosave, option:                              See 3.4.      (line 1784)
3811 autoSaveGames, option:                         See 3.4.      (line 1784)
3812 Back to Start, Menu Item:                      See 2.2.      (line  381)
3813 backgroundObserve, option:                     See 3.3.      (line 1572)
3814 Backward, Menu Item:                           See 2.2.      (line  348)
3815 bell, option:                                  See 3.5.      (line 1869)
3816 bitmapDirectory, option:                       See 3.5.      (line 2024)
3817 blackPieceColor, option:                       See 3.5.      (line 2071)
3818 blind, option:                                 See 3.5.      (line 1991)
3819 Blindfold, Menu Item:                          See 2.7.      (line  825)
3820 blindfold, option:                             See 3.5.      (line 1991)
3821 bm, option:                                    See 3.5.      (line 2024)
3822 board size:                                    See 3.5.      (line 1890)
3823 boardHeight, option:                           See 3.7.      (line 2252)
3824 boardSize, option:                             See 3.5.      (line 1890)
3825 boardWidth, option:                            See 3.7.      (line 2257)
3826 Book, Menu Item:                               See 2.6.      (line  677)
3827 Bug reports:                                   See 8.        (line 2629)
3828 Bugs <1>:                                      See 8.        (line 2629)
3829 Bugs:                                          See 7.        (line 2574)
3830 buttons, option:                               See 3.5.      (line 1955)
3831 Call Flag, Menu Item:                          See 2.5.      (line  602)
3832 checkMates, option:                            See 3.6.      (line 2133)
3833 Chess engine options:                          See 3.1.      (line 1113)
3834 CHESSDIR:                                      See 6.        (line 2565)
3835 clock, option:                                 See 3.1.      (line 1130)
3836 clockFont, option:                             See 3.5.      (line 1995)
3837 clockMode, option:                             See 3.1.      (line 1130)
3838 cmail:                                         See 10.       (line 2699)
3839 colorChallenge, option:                        See 3.3.      (line 1639)
3840 colorChannel, option:                          See 3.3.      (line 1639)
3841 colorChannel1, option:                         See 3.3.      (line 1639)
3842 colorize, option:                              See 3.3.      (line 1625)
3843 colorKibitz, option:                           See 3.3.      (line 1639)
3844 colorNormal, option:                           See 3.3.      (line 1639)
3845 colorRequest, option:                          See 3.3.      (line 1639)
3846 Colors <1>:                                    See 3.5.      (line 2071)
3847 Colors:                                        See 3.3.      (line 1625)
3848 colorSeek, option:                             See 3.3.      (line 1639)
3849 colorShout, option:                            See 3.3.      (line 1639)
3850 colorSShout, option:                           See 3.3.      (line 1639)
3851 colorTell, option:                             See 3.3.      (line 1639)
3852 Comments, Menu Item:                           See 2.3.      (line  456)
3853 Common Engine, Menu Item:                      See 2.7.      (line  712)
3854 Contributors:                                  See 9.        (line 2647)
3855 coordFont, option:                             See 3.5.      (line 2001)
3856 coords, option:                                See 3.5.      (line 1925)
3857 Copy Game, Menu Item:                          See 2.2.      (line  230)
3858 Copy Position, Menu Item:                      See 2.2.      (line  239)
3859 darkSquareColor, option:                       See 3.5.      (line 2071)
3860 debug, option:                                 See 3.7.      (line 2303)
3861 debugFile, option:                             See 3.7.      (line 2306)
3862 debugMode, option:                             See 3.7.      (line 2303)
3863 decline, ICS command:                          See 4.        (line 2402)
3864 Decline, Menu Item:                            See 2.5.      (line  596)
3865 defaultCacheSizeEGTB, option:                  See 3.2.      (line 1399)
3866 defaultFrcPosition, option:                    See 3.7.      (line 2272)
3867 defaultHashSize, option:                       See 3.2.      (line 1393)
3868 defaultPathEGTB, option:                       See 3.2.      (line 1405)
3869 delayAfterQuit, option:                        See 3.7.      (line 2338)
3870 delayBeforeQuit, option:                       See 3.7.      (line 2338)
3871 display, option:                               See 3.5.      (line 1860)
3872 drag, option:                                  See 3.5.      (line 2093)
3873 draw, ICS command:                             See 4.        (line 2415)
3874 Draw, Menu Item:                               See 2.5.      (line  608)
3875 dropMenu, option:                              See 3.3.      (line 1731)
3876 dualBoard, option:                             See 3.3.      (line 1586)
3877 Edit Comment, Menu Item:                       See 2.2.      (line  318)
3878 Edit Game, Menu Item:                          See 2.2.      (line  258)
3879 Edit Menu:                                     See 2.2.      (line  229)
3880 Edit Position, Menu Item:                      See 2.2.      (line  274)
3881 Edit Tags, Menu Item:                          See 2.2.      (line  294)
3882 egtFormats, option:                            See 3.2.      (line 1409)
3883 Engine #1 Settings, Menu Item:                 See 2.6.      (line  655)
3884 Engine #2 Settings, Menu Item:                 See 2.6.      (line  655)
3885 Engine Menu:                                   See 2.6.      (line  654)
3886 Engine Settings:                               See 3.2.      (line 1360)
3887 Engine Settings, Menu Item:                    See 2.6.      (line  655)
3888 engineDebugOutput, option:                     See 3.7.      (line 2310)
3889 Environment variables:                         See 6.        (line 2565)
3890 examine, ICS command:                          See 4.        (line 2438)
3891 Exit, Menu Item:                               See 2.1.      (line  224)
3892 exit, option:                                  See 3.5.      (line 1874)
3893 fb, option:                                    See 3.1.      (line 1237)
3894 fcp, option:                                   See 3.1.      (line 1230)
3895 fd, option:                                    See 3.1.      (line 1252)
3896 fh, option:                                    See 3.1.      (line 1244)
3897 File Menu:                                     See 2.1.      (line  114)
3898 finger, ICS command:                           See 4.        (line 2425)
3899 firstChessProgram, option:                     See 3.1.      (line 1230)
3900 firstComputerString, option:                   See 3.1.      (line 1288)
3901 firstDirectory, option:                        See 3.1.      (line 1252)
3902 firstHasOwnBookUCI, option:                    See 3.2.      (line 1388)
3903 firstHost, option:                             See 3.1.      (line 1244)
3904 firstIsUCI, option:                            See 3.2.      (line 1362)
3905 firstNeedsNoncompliantFEN, option:             See 3.1.      (line 1338)
3906 firstNPS, option:                              See 3.1.      (line 1153)
3907 firstOptions, option:                          See 3.1.      (line 1327)
3908 firstPlaysBlack, option:                       See 3.1.      (line 1237)
3909 firstProtocolVersion, option:                  See 3.1.      (line 1305)
3910 firstScoreAbs, option:                         See 3.1.      (line 1313)
3911 firstTimeOdds, option:                         See 3.1.      (line 1171)
3912 firstXBook, option:                            See 3.2.      (line 1388)
3913 Flash Moves, Menu Item:                        See 2.7.      (line  831)
3914 flash, option:                                 See 3.5.      (line 1974)
3915 flashCount, option:                            See 3.5.      (line 1974)
3916 flashRate, option:                             See 3.5.      (line 1974)
3917 Flip View, Menu Item:                          See 2.3.      (line  415)
3918 flip, option:                                  See 3.5.      (line 1937)
3919 flipView, option:                              See 3.5.      (line 1937)
3920 fNoOwnBookUCI, option:                         See 3.2.      (line 1388)
3921 Font:                                          See 3.5.      (line 2008)
3922 Font, clock:                                   See 3.5.      (line 1995)
3923 Font, coordinates:                             See 3.5.      (line 2001)
3924 font, option:                                  See 3.5.      (line 2008)
3925 fontSizeTolerance, option:                     See 3.5.      (line 2014)
3926 Forward to End, Menu Item:                     See 2.2.      (line  400)
3927 Forward, Menu Item:                            See 2.2.      (line  368)
3928 fUCI, option:                                  See 3.2.      (line 1362)
3929 Game List Tags, Menu Item:                     See 2.7.      (line  750)
3930 gameListTags, option:                          See 3.4.      (line 1826)
3931 games, ICS command:                            See 4.        (line 2391)
3932 gateway, option:                               See 3.3.      (line 1468)
3933 geometry, option:                              See 3.5.      (line 1860)
3934 Get Move List, Menu Item:                      See 2.7.      (line  845)
3935 getMoveList, option:                           See 3.3.      (line 1602)
3936 Help Menu:                                     See 2.8.      (line 1004)
3937 help, ICS command:                             See 4.        (line 2376)
3938 Hide Thinking, Menu Item:                      See 2.7.      (line  959)
3939 highlight Arrow, option:                       See 3.5.      (line 1987)
3940 Highlight Dragging, Menu Item:                 See 2.7.      (line  857)
3941 Highlight Last Move, Menu Item:                See 2.7.      (line  865)
3942 Highlight with Arrow, Menu Item:               See 2.7.      (line  871)
3943 highlight, option:                             See 3.5.      (line 1983)
3944 highlightLastMove, option:                     See 3.5.      (line 1983)
3945 highlightMoveWithArrow, option:                See 3.5.      (line 1987)
3946 highlightSquareColor, option:                  See 3.5.      (line 2071)
3947 Hint, Menu Item:                               See 2.6.      (line  674)
3948 holdingsSize, option:                          See 3.7.      (line 2264)
3949 iconic, option:                                See 3.5.      (line 1860)
3950 ICS:                                           See 4.        (line 2347)
3951 ICS Alarm, Menu Item:                          See 2.7.      (line  891)
3952 ICS Client, Menu Item:                         See 2.4.      (line  539)
3953 ICS Input Box, Menu Item:                      See 2.3.      (line  461)
3954 ICS options:                                   See 3.3.      (line 1423)
3955 ICS, addresses:                                See 4.        (line 2347)
3956 ics, option:                                   See 3.3.      (line 1424)
3957 icsAlarm, option:                              See 3.3.      (line 1606)
3958 icsAlarmTime, option:                          See 3.3.      (line 1610)
3959 icscomm, option:                               See 3.3.      (line 1476)
3960 icshelper, option:                             See 3.3.      (line 1442)
3961 icshost, option:                               See 3.3.      (line 1429)
3962 icsinput, option:                              See 3.3.      (line 1533)
3963 icslogon, option:                              See 3.3.      (line 1518)
3964 icsport, option:                               See 3.3.      (line 1438)
3965 inc, option:                                   See 3.1.      (line 1123)
3966 Info XBoard, Menu Item:                        See 2.8.      (line 1005)
3967 init, option:                                  See 3.4.      (line 1835)
3968 initalMode, option:                            See 3.7.      (line 2185)
3969 initString, option:                            See 3.1.      (line 1261)
3970 Internet Chess Server:                         See 4.        (line 2347)
3971 internetChessServerCommPort, option:           See 3.3.      (line 1476)
3972 internetChessServerHelper, option:             See 3.3.      (line 1442)
3973 internetChessServerHost, option:               See 3.3.      (line 1429)
3974 internetChessServerInputBox, option:           See 3.3.      (line 1533)
3975 internetChessServerLogonScript, option:        See 3.3.      (line 1518)
3976 internetChessServerMode, option:               See 3.3.      (line 1424)
3977 internetChessServerPort, option:               See 3.3.      (line 1438)
3978 introduction:
3979           See ``Introduction''.                              (line    9)
3980 Keys:                                          See 2.9.      (line 1024)
3981 legal, option:                                 See 3.5.      (line 1886)
3982 lgf, option:                                   See 3.4.      (line 1747)
3983 lgi, option:                                   See 3.4.      (line 1747)
3984 lightSquareColor, option:                      See 3.5.      (line 2071)
3985 Limitations:                                   See 7.        (line 2574)
3986 Load and Save options:                         See 3.4.      (line 1745)
3987 Load Game, Menu Item:                          See 2.1.      (line  148)
3988 Load Next Game, Menu Item:                     See 2.9.      (line 1034)
3989 Load Next Position, Menu Item:                 See 2.1.      (line  190)
3990 Load Position, Menu Item:                      See 2.1.      (line  181)
3991 Load Previous Game, Menu Item:                 See 2.9.      (line 1038)
3992 Load Previous Position, Menu Item:             See 2.1.      (line  194)
3993 loadGameFile, option:                          See 3.4.      (line 1747)
3994 loadGameIndex, option:                         See 3.4.      (line 1747)
3995 loadPositionFile, option:                      See 3.4.      (line 1789)
3996 loadPositionIndex, option:                     See 3.4.      (line 1789)
3997 lowTimeWarning, option:                        See 3.3.      (line 1614)
3998 lowTimeWarningColor, option:                   See 3.5.      (line 2071)
3999 lpf, option:                                   See 3.4.      (line 1789)
4000 lpi, option:                                   See 3.4.      (line 1789)
4001 Machine Black, Menu Item:                      See 2.4.      (line  475)
4002 Machine White, Menu Item:                      See 2.4.      (line  471)
4003 Mail Move, Menu Item:                          See 2.1.      (line  221)
4004 Major modes:                                   See 1.        (line   19)
4005 Man XBoard, Menu Item:                         See 2.8.      (line 1012)
4006 matchGames, option:                            See 3.1.      (line 1208)
4007 matchMode, option:                             See 3.1.      (line 1220)
4008 materialDraws, option:                         See 3.6.      (line 2145)
4009 Menu, Action:                                  See 2.5.      (line  589)
4010 Menu, Edit:                                    See 2.2.      (line  229)
4011 Menu, Engine:                                  See 2.6.      (line  654)
4012 Menu, File:                                    See 2.1.      (line  114)
4013 Menu, Help:                                    See 2.8.      (line 1004)
4014 Menu, Mode:                                    See 2.4.      (line  470)
4015 Menu, Options:                                 See 2.7.      (line  701)
4016 Menu, View:                                    See 2.3.      (line  414)
4017 Menus:                                         See 2.        (line   57)
4018 mg, option:                                    See 3.1.      (line 1208)
4019 mm, option:                                    See 3.1.      (line 1220)
4020 Mode Menu:                                     See 2.4.      (line  470)
4021 mode, option:                                  See 3.7.      (line 2185)
4022 mono, option:                                  See 3.5.      (line 1961)
4023 monoMode, option:                              See 3.5.      (line 1961)
4024 Move Now, Menu Item:                           See 2.6.      (line  687)
4025 Move Sound, Menu Item:                         See 2.7.      (line  876)
4026 moves, option:                                 See 3.3.      (line 1602)
4027 movesound, option:                             See 3.5.      (line 1869)
4028 movesPerSession, option:                       See 3.1.      (line 1119)
4029 mps, option:                                   See 3.1.      (line 1119)
4030 msLoginDelay, option:                          See 3.3.      (line 1527)
4031 nameOfDebugFile, option:                       See 3.7.      (line 2306)
4032 ncp, option:                                   See 3.7.      (line 2180)
4033 New Game, Menu Item:                           See 2.1.      (line  115)
4034 New Shuffle Game, Menu Item:                   See 2.1.      (line  124)
4035 New variant, Menu Item:                        See 2.1.      (line  137)
4036 niceEngines, option:                           See 3.1.      (line 1319)
4037 noChessProgram, option:                        See 3.7.      (line 2180)
4038 noGUI, option:                                 See 3.5.      (line 1863)
4039 observe, ICS command:                          See 4.        (line 2434)
4040 oldmoves, ICS command:                         See 4.        (line 2438)
4041 oldsave, option:                               See 3.4.      (line 1822)
4042 oldSaveStyle, option:                          See 3.4.      (line 1822)
4043 One-Click Moving, Menu Item:                   See 2.7.      (line  900)
4044 oneClickMove, option:                          See 3.3.      (line 1595)
4045 Options:                                       See 3.        (line 1087)
4046 Options Menu:                                  See 2.7.      (line  701)
4047 Options, adjudication:                         See 3.6.      (line 2119)
4048 options, Chess engine:                         See 3.1.      (line 1113)
4049 Options, ICS:                                  See 3.3.      (line 1423)
4050 Options, Load and Save:                        See 3.4.      (line 1745)
4051 Options, miscellaneous:                        See 3.7.      (line 2179)
4052 Options, User interface:                       See 3.5.      (line 1857)
4053 Other programs:                                See 11.       (line 2897)
4054 Paste Game, Menu Item:                         See 2.2.      (line  249)
4055 Paste Position, Menu Item:                     See 2.2.      (line  253)
4056 Pause, Menu Item:                              See 2.4.      (line  563)
4057 Periodic Updates, Menu Item:                   See 2.7.      (line  911)
4058 pgnEventHeader, option`:                       See 3.4.      (line 1814)
4059 pgnExtendedInfo, option`:                      See 3.4.      (line 1809)
4060 pieceToSquareTable, option:                    See 3.7.      (line 2277)
4061 pixmap, option:                                See 3.5.      (line 2024)
4062 pixmapDirectory, option:                       See 3.5.      (line 2024)
4063 PolyglotBook, option:                          See 3.2.      (line 1377)
4064 PolyglotDir, option:                           See 3.2.      (line 1369)
4065 Ponder Next Move, Menu Item:                   See 2.7.      (line  917)
4066 ponder, option:                                See 3.1.      (line 1199)
4067 ponderNextMove, option:                        See 3.1.      (line 1199)
4068 Popup Exit Message, Menu Item:                 See 2.7.      (line  923)
4069 Popup Move Errors, Menu Item:                  See 2.7.      (line  929)
4070 popup, option:                                 See 3.5.      (line 1878)
4071 popupExitMessage, option:                      See 3.5.      (line 1874)
4072 popupMoveErrors, option:                       See 3.5.      (line 1878)
4073 pre, option:                                   See 3.3.      (line 1618)
4074 Premove, Menu Item:                            See 2.7.      (line  938)
4075 premove, option:                               See 3.3.      (line 1618)
4076 Problems:                                      See 8.        (line 2629)
4077 queen, option:                                 See 3.5.      (line 1882)
4078 Quiet Play, Menu Item:                         See 2.7.      (line  949)
4079 quiet, option:                                 See 3.3.      (line 1621)
4080 quietPlay, option:                             See 3.3.      (line 1621)
4081 Reload CMail Message, Menu Item:               See 2.1.      (line  221)
4082 Reload Same Game, Menu Item:                   See 2.9.      (line 1043)
4083 Reload Same Position, Menu Item:               See 2.9.      (line 1047)
4084 remoteShell, option:                           See 3.7.      (line 2324)
4085 remoteUser, option:                            See 3.7.      (line 2329)
4086 Reporting bugs:                                See 8.        (line 2629)
4087 Reporting problems:                            See 8.        (line 2629)
4088 Resign, Menu Item:                             See 2.5.      (line  624)
4089 Retract Move, Menu Item:                       See 2.6.      (line  691)
4090 reuse, option:                                 See 3.1.      (line 1296)
4091 reuse2, option:                                See 3.1.      (line 1296)
4092 reuseFirst, option:                            See 3.1.      (line 1296)
4093 reuseSecond, option:                           See 3.1.      (line 1296)
4094 Revert, Menu Item:                             See 2.2.      (line  324)
4095 ringBellAfterMoves, option:                    See 3.5.      (line 1869)
4096 rsh, option:                                   See 3.7.      (line 2324)
4097 ruleMoves, option:                             See 3.6.      (line 2163)
4098 ruser, option:                                 See 3.7.      (line 2329)
4099 sameColorGames, option:                        See 3.1.      (line 1224)
4100 Save Game, Menu Item:                          See 2.1.      (line  199)
4101 Save Position, Menu Item:                      See 2.1.      (line  211)
4102 Save Settings Now, Menu Item:                  See 2.7.      (line  982)
4103 Save Settings on Exit, Menu Item:              See 2.7.      (line  996)
4104 saveGameFile, option:                          See 3.4.      (line 1779)
4105 saveOutOfBookInfo, option`:                    See 3.4.      (line 1818)
4106 savePositionFile, option:                      See 3.4.      (line 1804)
4107 saveSettingsFile, option:                      See 3.4.      (line 1835)
4108 scp, option:                                   See 3.1.      (line 1233)
4109 sd, option:                                    See 3.1.      (line 1144)
4110 searchDepth, option:                           See 3.1.      (line 1144)
4111 searchTime, option:                            See 3.1.      (line 1137)
4112 secondChessProgram, option:                    See 3.1.      (line 1233)
4113 secondComputerString, option:                  See 3.1.      (line 1288)
4114 secondDirectory, option:                       See 3.1.      (line 1252)
4115 secondHasOwnBookUCI, option:                   See 3.2.      (line 1388)
4116 secondHost, option:                            See 3.1.      (line 1244)
4117 secondInitString, option:                      See 3.1.      (line 1261)
4118 secondIsUCI, option:                           See 3.2.      (line 1362)
4119 secondNeedsNoncompliantFEN, option:            See 3.1.      (line 1338)
4120 secondNPS, option:                             See 3.1.      (line 1153)
4121 secondOptions, option:                         See 3.1.      (line 1327)
4122 secondProtocolVersion, option:                 See 3.1.      (line 1305)
4123 secondScoreAbs, option:                        See 3.1.      (line 1313)
4124 secondTimeOdds, option:                        See 3.1.      (line 1171)
4125 secondXBook, option:                           See 3.2.      (line 1388)
4126 seekGraph, option:                             See 3.3.      (line 1557)
4127 set, ICS command:                              See 4.        (line 2431)
4128 Settings, Engine:                              See 3.2.      (line 1360)
4129 SettingsFile, option:                          See 3.4.      (line 1835)
4130 sg, option:                                    See 3.3.      (line 1557)
4131 sgf, option:                                   See 3.4.      (line 1779)
4132 sh, option:                                    See 3.1.      (line 1244)
4133 Shortcut keys:                                 See 2.9.      (line 1024)
4134 Show Coords, Menu Item:                        See 2.7.      (line  955)
4135 Show Engine Output, Menu Item:                 See 2.3.      (line  420)
4136 Show Evaluation Graph, Menu Item:              See 2.3.      (line  441)
4137 Show Game List, Menu Item:                     See 2.3.      (line  447)
4138 Show Move History, Menu Item:                  See 2.3.      (line  435)
4139 showButtonBar, option:                         See 3.5.      (line 1955)
4140 showCoords, option:                            See 3.5.      (line 1925)
4141 showTargetSquares, option:                     See 3.5.      (line 1966)
4142 showThinking, option:                          See 3.1.      (line 1189)
4143 shuffleOpenings, option:                       See 3.1.      (line 1352)
4144 size, option:                                  See 3.5.      (line 1890)
4145 sNoOwnBookUCI, option:                         See 3.2.      (line 1388)
4146 soundChallenge, option:                        See 3.3.      (line 1684)
4147 soundChannel, option:                          See 3.3.      (line 1684)
4148 soundIcsAlarm, option:                         See 3.3.      (line 1692)
4149 soundIcsDraw, option:                          See 3.3.      (line 1703)
4150 soundIcsLoss, option:                          See 3.3.      (line 1699)
4151 soundIcsUnfinished, option:                    See 3.3.      (line 1707)
4152 soundIcsWin, option:                           See 3.3.      (line 1695)
4153 soundKibitz, option:                           See 3.3.      (line 1684)
4154 soundMove, option:                             See 3.3.      (line 1689)
4155 soundProgram, option:                          See 3.3.      (line 1668)
4156 soundRequest, option:                          See 3.3.      (line 1684)
4157 Sounds:                                        See 3.3.      (line 1668)
4158 soundSeek, option:                             See 3.3.      (line 1684)
4159 soundShout, option:                            See 3.3.      (line 1684)
4160 soundSShout, option:                           See 3.3.      (line 1684)
4161 soundTell, option:                             See 3.3.      (line 1684)
4162 spf, option:                                   See 3.4.      (line 1804)
4163 st, option:                                    See 3.1.      (line 1137)
4164 Stop Examining, Menu Item:                     See 2.5.      (line  633)
4165 Stop Observing, Menu Item:                     See 2.5.      (line  628)
4166 sUCI, option:                                  See 3.2.      (line 1362)
4167 Tags, Menu Item:                               See 2.3.      (line  451)
4168 tc, option:                                    See 3.1.      (line 1114)
4169 td, option:                                    See 3.4.      (line 1773)
4170 telnet, option:                                See 3.3.      (line 1450)
4171 telnetProgram, option:                         See 3.3.      (line 1459)
4172 Test Legality, Menu Item:                      See 2.7.      (line  969)
4173 testClaims, option:                            See 3.6.      (line 2139)
4174 testLegality, option:                          See 3.5.      (line 1886)
4175 thinking, option:                              See 3.1.      (line 1189)
4176 Time Control, Menu Item:                       See 2.7.      (line  702)
4177 timeControl, option:                           See 3.1.      (line 1114)
4178 timeDelay, option:                             See 3.4.      (line 1773)
4179 timeIncrement, option:                         See 3.1.      (line 1123)
4180 timeOddsMode, option:                          See 3.1.      (line 1177)
4181 title, option:                                 See 3.5.      (line 1947)
4182 titleInWindow, option:                         See 3.5.      (line 1947)
4183 Training, Menu Item:                           See 2.4.      (line  529)
4184 trivialDraws, option:                          See 3.6.      (line 2152)
4185 Truncate Game, Menu Item:                      See 2.2.      (line  343)
4186 Two Machines, Menu Item:                       See 2.4.      (line  479)
4187 Upload to Examine, Menu Item:                  See 2.5.      (line  638)
4188 usePolyglotBook, option:                       See 3.2.      (line 1374)
4189 User interface options:                        See 3.5.      (line 1857)
4190 userName, option:                              See 3.7.      (line 2333)
4191 useTelnet, option:                             See 3.3.      (line 1450)
4192 variant, option:                               See 3.7.      (line 2193)
4193 variations, option:                            See 3.3.      (line 1737)
4194 vars, ICS command:                             See 4.        (line 2428)
4195 View Menu:                                     See 2.3.      (line  414)
4196 whitePieceColor, option:                       See 3.5.      (line 2071)
4197 who, ICS command:                              See 4.        (line 2384)
4198 xflash, option:                                See 3.5.      (line 1974)
4199 Table of Contents
4200 *****************
4201
4202 Introduction
4203 1 Major modes
4204 2 Menus, buttons, and keys
4205   2.1 File Menu
4206   2.2 Edit Menu
4207   2.3 View Menu
4208   2.4 Mode Menu
4209   2.5 Action Menu
4210   2.6 Engine Menu
4211   2.7 Options Menu
4212   2.8 Help Menu
4213   2.9 Other Shortcut Keys
4214 3 Options
4215   3.1 Chess Engine Options
4216   3.2 UCI + WB Engine Settings
4217   3.3 ICS options
4218   3.4 Load and Save options
4219   3.5 User interface options
4220   3.6 Adjudication Options
4221   3.7 Other options
4222 4 Chess Servers
4223 5 Firewalls
4224 6 Environment variables
4225 7 Limitations and known bugs
4226 8 Reporting problems
4227 9 Authors and contributors
4228 10 CMail
4229   10.1 CMail options
4230   10.2 Starting a CMail Game
4231   10.3 Answering a Move
4232   10.4 Multi-Game Messages
4233   10.5 Completing a Game
4234   10.6 Known CMail Problems
4235 11 Other programs you can use with XBoard
4236   11.1 GNU Chess
4237   11.2 Fairy-Max
4238   11.3 HoiChess
4239   11.4 Crafty
4240   11.5 zic2xpm
4241 Copyright
4242 GNU GENERAL PUBLIC LICENSE
4243 Index
4244
4245