3 * xboard: (xboard). An X Window System graphical chessboard.
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
14 This manual documents version 4.4.0j of XBoard.
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.
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
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.
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.
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.
50 As an interface to electronic mail correspondence chess, XBoard
51 works with the cmail program. See *note CMail:: below for
54 2 Menus, buttons, and keys
55 **************************
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 dag and drop pieces to the
69 board from the holdings squares displayed next to the board.
71 All other XBoard commands are available from the menu bar. The most
72 frequently used commands also have shortcut keys or on-screen buttons.
74 When XBoard is iconized, its graphical icon is a white knight if it
75 is White's turn to move, a black knight if it is Black's turn. See
76 Iconize in *note Keys:: below if you have problems getting this feature
83 Resets XBoard and the chess engine to the beginning of a new chess
84 game. The `r' key is a keyboard equivalent. In Internet Chess
85 Server mode, clears the current state of XBoard, then
86 resynchronizes with the ICS by sending a refresh command. If you
87 want to stop playing, observing, or examining an ICS game, use an
88 appropriate command from the Action menu, not `New Game'. *Note
92 Similar to `New Game', but allows you to specify a particular
93 initial position (according to a standardized numbering system) in
94 chess variants which use randomized opening positions (e.g.
95 Chess960). The selected opening position will persistently be
96 chosen on any following New Game command until you use this menu
97 to select another. Selecting position number -1 will produce a
98 newly randomized position on any new game. Using this menu item
99 in variants that normally do not shuffle their opening position
100 does cause these variants to become shuffle variants until you use
101 the `New Shuffle Game' menu to explicitly switch the randomization
102 off, or select a new variant.
105 Allows you to select a new chess variant in non-ICS mode. (In ICS
106 play, the ICS is responsible for deciding which variant will be
107 played, and XBoard adapts automatically.) If you play with an
108 engine, the engine must be able to play the selected variant, or
109 the command will be ignored. XBoard supports all major variants,
110 such as xiangqi, shogi, chess, chess960, Capablanca Chess,
111 shatranj, crazyhouse, bughouse.
114 Plays a game from a record file. The `g' key is a keyboard
115 equivalent. A pop-up dialog prompts you for the file name. If the
116 file contains more than one game, a second pop-up dialog displays
117 a list of games (with information drawn from their PGN tags, if
118 any), and you can select the one you want. Alternatively, you can
119 load the Nth game in the file directly, by typing the number `N'
120 after the file name, separated by a space.
122 The game file parser will accept PGN (portable game notation), or
123 in fact almost any file that contains moves in algebraic notation.
124 Notation of the form `P@f7' is accepted for piece-drops in
125 bughouse games; this is a nonstandard extension to PGN. If the
126 file includes a PGN position (FEN tag), or an old-style XBoard
127 position diagram bracketed by `[--' and `--]' before the first
128 move, the game starts from that position. Text enclosed in
129 parentheses, square brackets, or curly braces is assumed to be
130 commentary and is displayed in a pop-up window. Any other text in
131 the file is ignored. PGN variations (enclosed in parentheses) are
132 treated as comments; XBoard is not able to walk variation trees.
133 The nonstandard PGN tag [Variant "varname"] functions similarly to
134 the -variant command-line option (see below), allowing games in
135 certain chess variants to be loaded. There is also a heuristic to
136 recognize chess variants from the Event tag, by looking for the
137 strings that the Internet Chess Servers put there when saving
138 variant ("wild") games.
141 Loads the next game from the last game record file you loaded.
142 The shifted `N' key is a keyboard equivalent.
145 Loads the previous game from the last game record file you loaded.
146 The shifted `P' key is a keyboard equivalent. Not available if
147 the last game was loaded from a pipe.
150 Reloads the last game you loaded. Not available if the last game
151 was loaded from a pipe.
154 Appends a record of the current game to a file. A pop-up dialog
155 prompts you for the file name. If the game did not begin with the
156 standard starting position, the game file includes the starting
157 position used. Games are saved in the PGN (portable game notation)
158 format, unless the oldSaveStyle option is true, in which case they
159 are saved in an older format that is specific to XBoard. Both
160 formats are human-readable, and both can be read back by the `Load
161 Game' command. Notation of the form `P@f7' is accepted for
162 piece-drops in bughouse games; this is a nonstandard extension to
166 Copies a record of the current game to an internal clipboard in PGN
167 format and sets the X selection to the game text. The game can be
168 pasted to another application (such as a text editor or another
169 copy of XBoard) using that application's paste command. In many X
170 applications, such as xterm and emacs, the middle mouse button can
171 be used for pasting; in XBoard, you must use the Paste Game
175 Interprets the current X selection as a game record and loads it,
179 Sets up a position from a position file. A pop-up dialog prompts
180 you for the file name. If the file contains more than one saved
181 position, and you want to load the Nth one, type the number N
182 after the file name, separated by a space. Position files must be
183 in FEN (Forsythe-Edwards notation), or in the format that the Save
184 Position command writes when oldSaveStyle is turned on.
187 Loads the next position from the last position file you loaded.
189 Load Previous Position
190 Loads the previous position from the last position file you
191 loaded. Not available if the last position was loaded from a pipe.
194 Reloads the last position you loaded. Not available if the last
195 position was loaded from a pipe.
198 Appends a diagram of the current position to a file. A pop-up
199 dialog prompts you for the file name. Positions are saved in FEN
200 (Forsythe-Edwards notation) format unless the `oldSaveStyle'
201 option is true, in which case they are saved in an older,
202 human-readable format that is specific to XBoard. Both formats can
203 be read back by the `Load Position' command.
206 Copies the current position to an internal clipboard in FEN format
207 and sets the X selection to the position text. The position can
208 be pasted to another application (such as a text editor or another
209 copy of XBoard) using that application's paste command. In many X
210 applications, such as xterm and emacs, the middle mouse button can
211 be used for pasting; in XBoard, you must use the Paste Position
215 Interprets the current X selection as a FEN position and loads it,
216 as with Load Position.
223 Exits from XBoard. The shifted `Q' key is a keyboard equivalent.
229 Tells the chess engine to play White.
232 Tells the chess engine to play Black.
235 Plays a game between two chess engines.
238 XBoard tells the chess engine to start analyzing the current
239 game/position and shows you the analysis as you move pieces around.
240 Note: Some chess engines do not support Analysis mode.
242 To set up a position to analyze, you do the following:
244 1. Select Edit Position from the Mode Menu
246 2. Set up the position. Use the middle and right buttons to bring
247 up the white and black piece menus.
249 3. When you are finished, click on either the Black or White clock
250 to tell XBoard which side moves first.
252 4. Select Analysis Mode from the Mode Menu to start the analysis.
254 The analysis function can also be used when observing games on an
255 ICS with an engine loaded (zippy mode); the engine then will
256 analyse the positions as they occur in the observed game.
259 This option lets you load a game from a file (PGN, XBoard format,
260 etc.) and analyze it. When you select this menu item, a pop-up
261 window appears and asks for a file name to load. If the file
262 contains multiple games, another pop up appears that lets you
263 select which game you wish to analyze. After a game is loaded,
264 use the XBoard arrow buttons to step forwards/backwards through
265 the game and watch the analysis. Note: Some chess engines do not
266 support Analysis mode.
269 This is the normal mode when XBoard is connected to a chess
270 server. If you have moved into Edit Game or Edit Position mode,
271 you can select this option to get out.
273 To use xboard in ICS mode, run it in the foreground with the -ics
274 option, and use the terminal you started it from to type commands
275 and receive text responses from the chess server. See *note Chess
276 Servers:: below for more information.
278 XBoard activates some special position/game editing features when
279 you use the `examine' or `bsetup' commands on ICS and you have
280 `ICS Client' selected on the Mode menu. First, you can issue the
281 ICS position-editing commands with the mouse. Move pieces by
282 dragging with mouse button 1. To drop a new piece on a square,
283 press mouse button 2 or 3 over the square. This brings up a menu
284 of white pieces (button 2) or black pieces (button 3). Additional
285 menu choices let you empty the square or clear the board. Click
286 on the White or Black clock to set the side to play. You cannot
287 set the side to play or drag pieces to arbitrary squares while
288 examining on ICC, but you can do so in `bsetup' mode on FICS. In
289 addition, the menu commands `Forward', `Backward', `Pause', and
290 `Stop Examining' have special functions in this mode; see below.
293 Allows you to make moves for both Black and White, and to change
294 moves after backing up with the `Backward' command. The clocks do
297 In chess engine mode, the chess engine continues to check moves
298 for legality but does not participate in the game. You can bring
299 the chess engine into the game by selecting `Machine White',
300 `Machine Black', or `Two Machines'.
302 In ICS mode, the moves are not sent to the ICS: `Edit Game' takes
303 XBoard out of ICS Client mode and lets you edit games locally. If
304 you want to edit games on ICS in a way that other ICS users can
305 see, use the ICS `examine' command or start an ICS match against
309 Lets you set up an arbitrary board position. Use mouse button 1
310 to drag pieces to new squares, or to delete a piece by dragging it
311 off the board or dragging an empty square on top of it. To drop a
312 new piece on a square, press mouse button 2 or 3 over the square.
313 This brings up a menu of white pieces (button 2) or black pieces
314 (button 3). Additional menu choices let you empty the square or
315 clear the board. You can set the side to play next by clicking on
316 the word White or Black at the top of the screen. Selecting `Edit
317 Position' causes XBoard to discard all remembered moves in the
320 In ICS mode, changes made to the position by `Edit Position' are
321 not sent to the ICS: `Edit Position' takes XBoard out of `ICS
322 Client' mode and lets you edit positions locally. If you want to
323 edit positions on ICS in a way that other ICS users can see, use
324 the ICS `examine' command, or start an ICS match against yourself.
325 (See also the ICS Client topic above.)
328 Training mode lets you interactively guess the moves of a game for
329 one of the players. You guess the next move of the game by playing
330 the move on the board. If the move played matches the next move of
331 the game, the move is accepted and the opponent's response is
332 auto-played. If the move played is incorrect, an error message is
333 displayed. You can select this mode only while loading a game
334 (that is, after selecting `Load Game' from the File menu). While
335 XBoard is in `Training' mode, the navigation buttons are disabled.
338 Shows or hides the list of games generated by the last `Load Game'
342 Shows or hides a list of moves of the current game. This list
343 allows you to move the display to any earlier position in the game
344 by clicking on the corresponding move.
347 Shows or hides a window in which the thinking output of any loaded
348 engines is displayed.
351 Lets you edit the PGN (portable game notation) tags for the
352 current game. After editing, the tags must still conform to the
355 <tag-section> ::= <tag-pair> <tag-section>
357 <tag-pair> ::= [ <tag-name> <tag-value> ]
358 <tag-name> ::= <identifier>
359 <tag-value> ::= <string>
360 See the PGN Standard for full details. Here is an example:
362 [Event "Portoroz Interzonal"]
363 [Site "Portoroz, Yugoslavia"]
366 [White "Robert J. Fischer"]
367 [Black "Bent Larsen"]
369 Any characters that do not match this syntax are silently ignored.
370 Note that the PGN standard requires all games to have at least the
371 seven tags shown above. Any that you omit will be filled in by
372 XBoard with `?' (unknown value), or `-' (inapplicable value).
375 Adds or modifies a comment on the current position. Comments are
376 saved by `Save Game' and are displayed by `Load Game', `Forward',
380 If this option is set in ICS mode, XBoard creates an extra window
381 that you can use for typing in ICS commands. The input box is
382 especially useful if you want to type in something long or do some
383 editing on your input, because output from ICS doesn't get mixed
384 in with your typing as it would in the main terminal window.
387 Pauses updates to the board, and if you are playing against a
388 chess engine, also pauses your clock. To continue, select `Pause'
389 again, and the display will automatically update to the latest
390 position. The `P' button and keyboard `p' key are equivalents.
392 If you select Pause when you are playing against a chess engine and
393 it is not your move, the chess engine's clock will continue to run
394 and it will eventually make a move, at which point both clocks
395 will stop. Since board updates are paused, however, you will not
396 see the move until you exit from Pause mode (or select Forward).
397 This behavior is meant to simulate adjournment with a sealed move.
399 If you select Pause while you are observing or examining a game on
400 a chess server, you can step backward and forward in the current
401 history of the examined game without affecting the other observers
402 and examiners, and without having your display jump forward to the
403 latest position each time a move is made. Select Pause again to
404 reconnect yourself to the current state of the game on ICS.
406 If you select `Pause' while you are loading a game, the game stops
407 loading. You can load more moves manually by selecting `Forward',
408 or resume automatic loading by selecting `Pause' again.
414 Accepts a pending match offer. If there is more than one offer
415 pending, you will have to type in a more specific command instead
416 of using this menu choice.
419 Declines a pending offer (match, draw, adjourn, etc.). If there is
420 more than one offer pending, you will have to type in a more
421 specific command instead of using this menu choice.
424 Calls your opponent's flag, claiming a win on time, or claiming a
425 draw if you are both out of time. You can also call your
426 opponent's flag by clicking on his clock or by pressing the
430 Offers a draw to your opponent, accepts a pending draw offer from
431 your opponent, or claims a draw by repetition or the 50-move rule,
432 as appropriate. The `d' key is a keyboard equivalent.
435 Asks your opponent to agree to adjourning the current game, or
436 agrees to a pending adjournment offer from your opponent.
439 Asks your opponent to agree to aborting the current game, or
440 agrees to a pending abort offer from your opponent. An aborted
441 game ends immediately without affecting either player's rating.
444 Resigns the game to your opponent. The shifted `R' key is a
448 Ends your participation in observing a game, by issuing the ICS
449 observe command with no arguments. ICS mode only.
452 Ends your participation in examining a game, by issuing the ICS
453 unexamine command. ICS mode only.
458 Terminate an ongoing game in Two-Machines mode (including match
459 mode), with as result a win for white, for black, or a draw,
460 respectively. The PGN file of the game will accompany the result
461 string by the comment "user adjudication".
467 Steps backward through a series of remembered moves. The `[<]'
468 button and the `b' key are equivalents, as is turning the mouse
469 wheel towards you. In addition, pressing the Control key steps
470 back one move, and releasing it steps forward again.
472 In most modes, `Backward' only lets you look back at old positions;
473 it does not retract moves. This is the case if you are playing
474 against a chess engine, playing or observing a game on an ICS, or
475 loading a game. If you select `Backward' in any of these
476 situations, you will not be allowed to make a different move. Use
477 `Retract Move' or `Edit Game' if you want to change past moves.
479 If you are examining an ICS game, the behavior of `Backward'
480 depends on whether XBoard is in Pause mode. If Pause mode is off,
481 `Backward' issues the ICS backward command, which backs up
482 everyone's view of the game and allows you to make a different
483 move. If Pause mode is on, `Backward' only backs up your local
487 Steps forward through a series of remembered moves (undoing the
488 effect of `Backward') or forward through a game file. The `[>]'
489 button and the `f' key are equivalents, as is turning the mouse
492 If you are examining an ICS game, the behavior of Forward depends
493 on whether XBoard is in Pause mode. If Pause mode is off,
494 `Forward' issues the ICS forward command, which moves everyone's
495 view of the game forward along the current line. If Pause mode is
496 on, `Forward' only moves your local view forward, and it will not
497 go past the position that the game was in when you paused.
500 Jumps backward to the first remembered position in the game. The
501 `[<<]' button and the shifted `B' key are equivalents.
503 In most modes, Back to Start only lets you look back at old
504 positions; it does not retract moves. This is the case if you are
505 playing against a local chess engine, playing or observing a game
506 on a chess server, or loading a game. If you select `Back to
507 Start' in any of these situations, you will not be allowed to make
508 different moves. Use `Retract Move' or `Edit Game' if you want to
509 change past moves; or use Reset to start a new game.
511 If you are examining an ICS game, the behavior of `Back to Start'
512 depends on whether XBoard is in Pause mode. If Pause mode is off,
513 `Back to Start' issues the ICS `backward 999999' command, which
514 backs up everyone's view of the game to the start and allows you
515 to make different moves. If Pause mode is on, `Back to Start' only
516 backs up your local view.
519 Jumps forward to the last remembered position in the game. The
520 `[>>]' button and the shifted `F' key are equivalents.
522 If you are examining an ICS game, the behavior of `Forward to End'
523 depends on whether XBoard is in Pause mode. If Pause mode is off,
524 `Forward to End' issues the ICS `forward 999999' command, which
525 moves everyone's view of the game forward to the end of the
526 current line. If Pause mode is on, `Forward to End' only moves
527 your local view forward, and it will not go past the position that
528 the game was in when you paused.
531 If you are examining an ICS game and Pause mode is off, issues the
532 ICS command `revert'.
535 Discards all remembered moves of the game beyond the current
536 position. Puts XBoard into `Edit Game' mode if it was not there
540 Forces the chess engine to move immediately. Chess engine mode
544 Retracts your last move. In chess engine mode, you can do this only
545 after the chess engine has replied to your move; if the chess
546 engine is still thinking, use `Move Now' first. In ICS mode,
547 `Retract Move' issues the command `takeback 1' or `takeback 2'
548 depending on whether it is your opponent's move or yours.
554 Inverts your view of the chess board for the duration of the
555 current game. Starting a new game returns the board to normal.
556 The `v' key is a keyboard equivalent.
559 Pops up a sub-menu where you can enable or disable various
560 adjudications that XBoard can perform in engine-engine games. You
561 can instruct XBoard to detect and terminate the game on checkmate
562 or stalemate, even if the engines would not do so, to verify engine
563 result claims (forfeiting engines that make false claims), rather
564 than naively following the engine, to declare draw on positions
565 which can never be won for lack of mating material, (e.g. KBK), or
566 which are impossible to win unless the opponent seeks its own
567 demise (e.g. KBKN). For these adjudications to work, `Test
568 Legality' should be switched on. It is also possible to instruct
569 XBoard to enforce a 50-move or 3-fold-repeat rule and
570 automatically declare draw (after a user-adjustable number of moves
571 or repeats) even if the engines are prepared to go on. It is also
572 possible to have XBoard declare draw on games that seem to drag on
573 forever, or adjudicate a loss if both engines agree (for 3
574 consecutive moves) that one of them is behind more than a
575 user-adjustable score threshold. For the latter adjudication to
576 work, XBoard should be able to properly understand the engine's
577 scores. To facilitate the latter, you can inform xboard here if
578 the engines report scores from the viewpoint of white, or from
579 that of their own color.
582 Pops up a sub-menu where you can set some engine parameters common
583 to most engines, such as hash-table size, tablebase cache size,
584 maximum number of processors that SMP engines can use, and where
585 to find the Polyglot adapter needed to run UCI engines under
586 XBoard. The feature that allows setting of these parameters on
587 engines is new since XBoard 4.3.15, so not many WinBoard engines
588 respond to it yet, but UCI engines should. It is also possible to
589 specify a GUI opening book here, i.e. an opening book that XBoard
590 consults for any position a playing engine gets in. It then
591 forces the engine to play the book move, rather than to think up
592 its own, if that position is found in the book. The book can
593 switched on and off independently for either engine.
596 Pops up a sub-menu where you can set the time-control parameters
597 interactively. Allows you to select classical or incremental time
598 controls, set the moves per session, session duration, and time
599 increment. Also allows specification of time-odds factors for one
600 or both engines. If an engine is given a time-odds factor N, all
601 time quota it gets, be it at the beginning of a session or through
602 the time increment or fixed time per move, will be divided by N.
605 If this option is off, XBoard brings up a dialog box whenever you
606 move a pawn to the last rank, asking what piece you want to
607 promote it to. If the option is true, your pawns are always
608 promoted to queens. Your opponent can still under-promote.
611 If Animate Dragging is on, while you are dragging a piece with the
612 mouse, an image of the piece follows the mouse cursor. If Animate
613 Dragging is off, there is no visual feedback while you are
614 dragging a piece, but if Animate Moving is on, the move will be
615 animated when it is complete.
618 If Animate Moving is on, all piece moves are animated. An image
619 of the piece is shown moving from the old square to the new square
620 when the move is completed (unless the move was already animated
621 by Animate Dragging). If Animate Moving is off, a moved piece
622 instantly disappears from its old square and reappears on its new
623 square when the move is complete.
626 If this option is on, any remarks made on ICS while you are
627 observing or playing a game are recorded as a comment on the
628 current move. This includes remarks made with the ICS commands
629 `say', `tell', `whisper', and `kibitz'. Limitation: remarks that
630 you type yourself are not recognized; XBoard scans only the output
631 from ICS, not the input you type to it.
634 If this option is on and one player runs out of time before the
635 other, XBoard will automatically call his flag, claiming a win on
636 time. In ICS mode, Auto Flag will only call your opponent's flag,
637 not yours, and the ICS may award you a draw instead of a win if
638 you have insufficient mating material. In local chess engine mode,
639 XBoard may call either player's flag and will not take material
643 If the Auto Flip View option is on when you start a game, the board
644 will be automatically oriented so that your pawns move from the
645 bottom of the window towards the top.
648 If this option is on and you add a player to your `gnotify' list
649 on ICS, XBoard will automatically observe all of that player's
650 games, unless you are doing something else (such as observing or
651 playing a game of your own) when one starts. The games are
652 displayed from the point of view of the player on your gnotify
653 list; that is, his pawns move from the bottom of the window
654 towards the top. Exceptions: If both players in a game are on
655 your gnotify list, if your ICS `highlight' variable is set to 0,
656 or if the ICS you are using does not properly support observing
657 from Black's point of view, you will see the game from White's
661 If this option is on, whenever a new game begins, the chessboard
662 window is deiconized (if necessary) and raised to the top of the
666 If this option is true, at the end of every game XBoard prompts
667 you for a file name and appends a record of the game to the file
668 you specify. Disabled if the `saveGameFile' command-line option
669 is set, as in that case all games are saved to the specified file.
670 *Note Load and Save options::.
673 If this option is on, XBoard displays the board as usual but does
674 not display pieces or move highlights. You can still move in the
675 usual way (with the mouse or by typing moves in ICS mode), even
676 though the pieces are invisible.
679 If this option is on, whenever a move is completed, the moved
680 piece flashes. The number of times to flash is set by the
681 flashCount command-line option; it defaults to 3 if Flash Moves is
682 first turned on from the menu.
684 If you are playing a game on an ICS, the board is always oriented
685 at the start of the game so that your pawns move from the bottom
686 of the window towards the top. Otherwise, the starting orientation
687 is determined by the `flipView' command line option; if it is
688 false (the default), White's pawns move from bottom to top at the
689 start of each game; if it is true, Black's pawns move from bottom
690 to top. *Note User interface options::.
693 If this option is on, whenever XBoard receives the first board of
694 a new ICS game (or a different game from the one it is currently
695 displaying), it retrieves the list of past moves from the ICS.
696 You can then review the moves with the `Forward' and `Backward'
697 commands or save them with `Save Game'. You might want to turn
698 off this option if you are observing several blitz games at once,
699 to keep from wasting time and network bandwidth fetching the move
700 lists over and over. When you turn this option on from the menu,
701 XBoard immediately fetches the move list of the current game (if
705 If Highlight Last Move is on, after a move is made, the starting
706 and ending squares remain highlighted. In addition, after you use
707 Backward or Back to Start, the starting and ending squares of the
708 last move to be unmade are highlighted.
711 If this option is on, XBoard alerts you by playing a sound after
712 each of your opponent's moves (or after every move if you are
713 observing a game on the Internet Chess Server). The sound is not
714 played after moves you make or moves read from a saved game file.
715 By default, the sound is the terminal bell, but on some systems
716 you can change it to a sound file using the soundMove option; see
719 If you turn on this option when using XBoard with the Internet
720 Chess Server, you will probably want to give the `set bell 0'
721 command to the ICS, since otherwise the ICS will ring the terminal
722 bell after every move (not just yours). (The `.icsrc' file is a
723 good place for this; see *note ICS options::.)
726 When this option is on, an alarm sound is played when your clock
727 counts down to the icsAlarmTime (by default, 5 seconds) in an ICS
728 game. For games with time controls that include an increment, the
729 alarm will sound each time the clock counts down to the
730 icsAlarmTime. By default, the alarm sound is the terminal bell,
731 but on some systems you can change it to a sound file using the
732 soundIcsAlarm option; see below.
735 If this option is off, XBoard saves games in PGN (portable game
736 notation) and positions in FEN (Forsythe-Edwards notation). If
737 the option is on, a save style that is compatible with older
738 versions of XBoard is used instead. The old position style is
739 more human-readable than FEN; the old game style has no particular
743 If this option is off (or if you are using a chess engine that
744 does not support periodic updates), the analysis window will only
745 be updated when the analysis changes. If this option is on, the
746 Analysis Window will be updated every two seconds.
749 If this option is off, the chess engine will think only when it is
750 on move. If the option is on, the engine will also think while
751 waiting for you to make your move.
754 If this option is on, when XBoard wants to display a message just
755 before exiting, it brings up a modal dialog box and waits for you
756 to click OK before exiting. If the option is off, XBoard prints
757 the message to standard error (the terminal) and exits immediately.
760 If this option is off, when you make an error in moving (such as
761 attempting an illegal move or moving the wrong color piece), the
762 error message is displayed in the message area. If the option is
763 on, move errors are displayed in small pop-up windows like other
764 errors. You can dismiss an error pop-up either by clicking its OK
765 button or by clicking anywhere on the board, including
766 down-clicking to start a move.
769 If this option is on while playing a game on an ICS, you can
770 register your next planned move before it is your turn. Move the
771 piece with the mouse in the ordinary way, and the starting and
772 ending squares will be highlighted with a special color (red by
773 default). When it is your turn, if your registered move is legal,
774 XBoard will send it to ICS immediately; if not, it will be ignored
775 and you can make a different move. If you change your mind about
776 your premove, either make a different move, or double-click on any
777 piece to cancel the move entirely.
780 If this option is on, XBoard will automatically issue an ICS `set
781 shout 0' command whenever you start a game and a `set shout 1'
782 command whenever you finish one. Thus, you will not be distracted
783 by shouts from other ICS users while playing.
786 If this option is on, XBoard displays algebraic coordinates along
787 the board's left and bottom edges.
790 If this option is off, the chess engine's notion of the score and
791 best line of play from the current position is displayed as it is
792 thinking. The score indicates how many pawns ahead (or if negative,
793 behind) the chess engine thinks it is. In matches between two
794 machines, the score is prefixed by `W' or `B' to indicate whether
795 it is showing White's thinking or Black's, and only the thinking
796 of the engine that is on move is shown.
799 If this option is on, XBoard tests whether the moves you try to
800 make with the mouse are legal and refuses to let you make an
801 illegal move. Moves loaded from a file with `Load Game' are also
802 checked. If the option is off, all moves are accepted, but if a
803 local chess engine or the ICS is active, they will still reject
804 illegal moves. Turning off this option is useful if you are
805 playing a chess variant with rules that XBoard does not
806 understand. (Bughouse, suicide, and wild variants where the king
807 may castle after starting on the d file are generally supported
808 with Test Legality on.)
814 Displays the XBoard documentation in info format. For this
815 feature to work, you must have the GNU info program installed on
816 your system, and the file `xboard.info' must either be present in
817 the current working directory, or have been installed by the `make
818 install' command when you built XBoard.
821 Displays the XBoard documentation in man page format. For this
822 feature to work, the file `xboard.6' must have been installed by
823 the `make install' command when you built XBoard, and the
824 directory it was placed in must be on the search path for your
825 system's `man' command.
828 Displays a move hint from the chess engine.
831 Displays a list of possible moves from the chess engine's opening
832 book. The exact format depends on what chess engine you are using.
833 With GNU Chess 4, the first column gives moves, the second column
834 gives one possible response for each move, and the third column
835 shows the number of lines in the book that include the move from
836 the first column. If you select this option and nothing happens,
837 the chess engine is out of its book or does not support this
841 Shows the current XBoard version number.
843 2.7 Other Shortcut Keys
844 =======================
847 Pressing the `i' or `c' key iconizes XBoard. The graphical icon
848 displays a white knight if it is White's move, or a black knight
849 if it is Black's move. If your X window manager displays only text
850 icons, not graphical ones, check its documentation; there is
851 probably a way to enable graphical icons. If you get black and
852 white reversed, we would like to hear about it; see *note
853 Problems:: below for instructions on how to report this problem.
855 You can add or remove shortcut keys using the X resources
856 `form.translations'. Here is an example of what would go in your
859 XBoard*form.translations: \
860 Shift<Key>?: AboutGameProc() \n\
861 <Key>y: AcceptProc() \n\
862 <Key>n: DeclineProc() \n\
863 <Key>i: NothingProc()
864 Binding a key to `NothingProc' makes it do nothing, thus removing it
865 as a shortcut key. The XBoard commands that can be bound to keys are:
867 AbortProc, AboutGameProc, AboutProc, AcceptProc, AdjournProc,
868 AlwaysQueenProc, AnalysisModeProc, AnalyzeFileProc,
869 AnimateDraggingProc, AnimateMovingProc, AutobsProc, AutoflagProc,
870 AutoflipProc, AutoraiseProc, AutosaveProc, BackwardProc,
871 BlindfoldProc, BookProc, CallFlagProc, CopyGameProc, CopyPositionProc,
872 DebugProc, DeclineProc, DrawProc, EditCommentProc, EditGameProc,
873 EditPositionProc, EditTagsProc, EnterKeyProc, FlashMovesProc,
874 FlipViewProc, ForwardProc, GetMoveListProc, HighlightLastMoveProc,
875 HintProc, Iconify, IcsAlarmProc, IcsClientProc, IcsInputBoxProc,
876 InfoProc, LoadGameProc, LoadNextGameProc, LoadNextPositionProc,
877 LoadPositionProc, LoadPrevGameProc, LoadPrevPositionProc,
878 LoadSelectedProc, MachineBlackProc, MachineWhiteProc, MailMoveProc,
879 ManProc, MoveNowProc, MoveSoundProc, NothingProc, OldSaveStyleProc,
880 PasteGameProc, PastePositionProc, PauseProc, PeriodicUpdatesProc,
881 PonderNextMoveProc, PopupExitMessageProc, PopupMoveErrorsProc,
882 PremoveProc, QuietPlayProc, QuitProc, ReloadCmailMsgProc,
883 ReloadGameProc, ReloadPositionProc, RematchProc, ResetProc,
884 ResignProc, RetractMoveProc, RevertProc, SaveGameProc,
885 SavePositionProc, ShowCoordsProc, ShowGameListProc, ShowThinkingProc,
886 StopExaminingProc, StopObservingProc, TestLegalityProc, ToEndProc,
887 ToStartProc, TrainingProc, TruncateGameProc, and TwoMachinesProc.
892 This section documents the command-line options to XBoard. You can set
893 these options in two ways: by typing them on the shell command line you
894 use to start XBoard, or by setting them as X resources (typically in
895 your `.Xresources' file). Many of the options cannot be changed while
896 XBoard is running; others set the initial state of items that can be
897 changed with the *note Options:: menu.
899 Most of the options have both a long name and a short name. To turn a
900 boolean option on or off from the command line, either give its long
901 name followed by the value true or false (`-longOptionName true'), or
902 give just the short name to turn the option on (`-opt'), or the short
903 name preceded by `x' to turn the option off (`-xopt'). For options that
904 take strings or numbers as values, you can use the long or short option
905 names interchangeably.
907 Each option corresponds to an X resource with the same name, so if
908 you like, you can set options in your `.Xresources' file or in a file
909 named `XBoard' in your home directory. For options that have two
910 names, the longer one is the name of the corresponding X resource; the
911 short name is not recognized. To turn a boolean option on or off as an
912 X resource, give its long name followed by the value true or false
913 (`XBoard*longOptionName: true').
915 3.1 Chess Engine Options
916 ========================
918 -tc or -timeControl minutes[:seconds]
919 Each player begins with his clock set to the `timeControl' period.
920 Default: 5 minutes. The additional options `movesPerSession' and
921 `timeIncrement' are mutually exclusive.
923 -mps or -movesPerSession moves
924 When both players have made `movesPerSession' moves, a new
925 `timeControl' period is added to both clocks. Default: 40 moves.
927 -inc or -timeIncrement seconds
928 If this option is specified, `movesPerSession' is ignored.
929 Instead, after each player's move, `timeIncrement' seconds are
930 added to his clock. Use `-inc 0' if you want to require the entire
931 game to be played in one `timeControl' period, with no increment.
932 Default: -1, which specifies `movesPerSession' mode.
934 -clock/-xclock or -clockMode true/false
935 Determines whether or not to display the chess clocks. If
936 clockMode is false, the clocks are not shown, but the side that is
937 to play next is still highlighted. Also, unless `searchTime' is
938 set, the chess engine still keeps track of the clock time and uses
939 it to determine how fast to make its moves.
941 -st or -searchTime minutes[:seconds]
942 Tells the chess engine to spend at most the given amount of time
943 searching for each of its moves. Without this option, the chess
944 engine chooses its search time based on the number of moves and
945 amount of time remaining until the next time control. Setting
946 this option also sets clockMode to false.
948 -depth or -searchDepth number
949 Tells the chess engine to look ahead at most the given number of
950 moves when searching for a move to make. Without this option, the
951 chess engine chooses its search depth based on the number of moves
952 and amount of time remaining until the next time control. With
953 the option, the engine will cut off its search early if it reaches
958 Tells the chess engine to use an internal time standard based on
959 its node count, rather then wall-clock time, to make its timing
960 decisions. The time in virtual seconds should be obtained by
961 dividing the node count through the given number, like the number
962 was a rate in nodes per second. Xboard will manage the clocks in
963 accordance with this, relying on the number of nodes reported by
964 the engine in its thinking output. If the given number equals zero,
965 it can obviously not be used to convert nodes to seconds, and the
966 time reported by the engine is used to decrement the XBoard clock
967 in stead. The engine is supposed to report in CPU time it uses,
968 rather than wall-clock time, in this mode. This option can provide
969 fairer conditions for engine-engine matches on heavily loaded
970 machines, or with very fast games (where the wall clock is too
971 inaccurate). `showThinking' must be on for this option to work.
972 Default: -1 (off). Not many engines might support this yet!
974 -firstTimeOdds factor
975 -secondTimeOdds factor
976 Reduces the time given to the mentioned engine by the given factor.
977 If pondering is off, the effect is indistinguishable from what
978 would happen if the engine was running on an n-times slower
982 This option determines how the case is handled where both engines
983 have a time-odds handicap. If mode=1, the engine that gets the
984 most time will always get the nominal time, as specified by the
985 time-control options, and its opponent's time is renormalized
986 accordingly. If mode=0, both play with reduced time. Default: 0.
988 -hideThinkingFromHuman true/false
989 Controls the Hide Thinking option. *Note Options Menu::. Default:
990 true. (Replaces the Show-Thinking option of older xboard
993 -thinking/-xthinking or -showThinking true/false
994 Forces the engine to send thinking output to xboard. Used to be
995 the only way to control if thinking output was displayed in older
996 xboard versions, but as the thinking output in xboard 4.3 is also
997 used for several other purposes (adjudication, storing in PGN
998 file) the display of it is now controlled by the new option Hide
999 Thinking. *Note Options Menu::. Default: false. (But if xboard
1000 needs the thinking output for some purpose, it makes the engine
1001 send it despite the setting of this option.)
1003 -ponder/-xponder or -ponderNextMove true/false
1004 Sets the Ponder Next Move menu option. *Note Options Menu::.
1008 Specifies the maximum number of CPUs an SMP engine is allowed to
1009 use. Only works for engines that support the WinBoard-protocol
1012 -mg or -matchGames n
1013 Automatically runs an n-game match between two chess engines, with
1014 alternating colors. If the `loadGameFile' or `loadPositionFile'
1015 option is set, XBoard starts each game with the given opening
1016 moves or the given position; otherwise, the games start with the
1017 standard initial chess position. If the `saveGameFile' option is
1018 set, a move record for the match is appended to the specified
1019 file. If the `savePositionFile' option is set, the final position
1020 reached in each game of the match is appended to the specified
1021 file. When the match is over, XBoard displays the match score and
1022 exits. Default: 0 (do not run a match).
1024 -mm/-xmm or -matchMode true/false
1025 Setting `matchMode' to true is equivalent to setting `matchGames'
1029 Automatically runs an n-game match between two chess engines,
1030 without alternating colors. Otherwise the same applies as for the
1031 `-matchGames' option, over which it takes precedence if both are
1032 specified. (See there.) Default: 0 (do not run a match).
1034 -fcp or -firstChessProgram program
1035 Name of first chess engine. Default: `Fairy-Max'.
1037 -scp or -secondChessProgram program
1038 Name of second chess engine, if needed. A second chess engine is
1039 started only in Two Machines (match) mode. Default: `Fairy-Max'.
1041 -fb/-xfb or -firstPlaysBlack true/false
1042 In games between two chess engines, firstChessProgram normally
1043 plays white. If this option is true, firstChessProgram plays
1044 black. In a multi-game match, this option affects the colors only
1045 for the first game; they still alternate in subsequent games.
1047 -fh or -firstHost host
1048 -sh or -secondHost host
1049 Hosts on which the chess engines are to run. The default for each
1050 is `localhost'. If you specify another host, XBoard uses `rsh' to
1051 run the chess engine there. (You can substitute a different remote
1052 shell program for rsh using the `remoteShell' option described
1055 -fd or -firstDirectory dir
1056 -sd or -secondDirectory dir
1057 Working directories in which the chess engines are to be run. The
1058 default is "", which means to run the chess engine in the same
1059 working directory as XBoard itself. (See the CHESSDIR environment
1060 variable.) This option is effective only when the chess engine is
1061 being run on the local host; it does not work if the engine is run
1062 remotely using the -fh or -sh option.
1065 -secondInitString string
1066 The string that is sent to initialize each chess engine for a new
1071 Setting this option from the command line is tricky, because you
1072 must type in real newline characters, including one at the very
1073 end. In most shells you can do this by entering a `\' character
1074 followed by a newline. It is easier to set the option from your
1075 `.Xresources' file; in that case you can include the character
1076 sequence `\n' in the string, and it will be converted to a newline.
1078 If you change this option, don't remove the `new' command; it is
1079 required by all chess engines to start a new game.
1081 You can remove the `random' command if you like; including it
1082 causes GNU Chess 4 to randomize its move selection slightly so
1083 that it doesn't play the same moves in every game. Even without
1084 `random', GNU Chess 4 randomizes its choice of moves from its
1085 opening book. Many other chess engines ignore this command
1086 entirely and always (or never) randomize.
1088 You can also try adding other commands to the initString; see the
1089 documentation of the chess engine you are using for details.
1091 -firstComputerString string
1092 -secondComputerString string
1093 The string that is sent to the chess engine if its opponent is
1094 another computer chess engine. The default is `computer\n'.
1095 Probably the only useful alternative is the empty string (`'),
1096 which keeps the engine from knowing that it is playing another
1099 -reuse/-xreuse or -reuseFirst true/false
1100 -reuse2/-xreuse2 or -reuseSecond true/false
1101 If the option is false, XBoard kills off the chess engine after
1102 every game and starts it again for the next game. If the option
1103 is true (the default), XBoard starts the chess engine only once
1104 and uses it repeatedly to play multiple games. Some old chess
1105 engines may not work properly when reuse is turned on, but
1106 otherwise games will start faster if it is left on.
1108 -firstProtocolVersion version-number
1109 -secondProtocolVersion version-number
1110 This option specifies which version of the chess engine
1111 communication protocol to use. By default, version-number is 2.
1112 In version 1, the "protover" command is not sent to the engine;
1113 since version 1 is a subset of version 2, nothing else changes.
1114 Other values for version-number are not supported.
1116 -firstScoreAbs true/false
1117 -secondScoreAbs true/false
1118 If this option is set, the score reported by the engine is taken
1119 to be that in favor of white, even when the engine plays black.
1120 Important when XBoard uses the score for adjudications, or in PGN
1123 -niceEngines priority
1124 This option allows you to lower the priority of the engine
1125 processes, so that the generally insatiable hunger for CPU time of
1126 chess engines does not interfere so much with smooth operation of
1127 WinBoard (or the rest of your system). Negative values could
1128 increase the engine priority, which is not recommended.
1130 -firstOptions string
1131 -secondOptions string
1132 The given string is a comma-separated list of (option name=option
1133 value) pairs, like the following example: "style=Karpov,blunder
1134 rate=0". If the options announced by the engine at startup
1135 through the feature commands of WinBoard protocol matches one of
1136 the option names (i.e. "style" or "blunder rate"), it would be set
1137 to the given value (i.e. "Karpov" or 0) through a corresponding
1138 option command to the engine. This provided that the type of the
1139 value (text or numeric) matches as well.
1141 -firstNeedsNoncompliantFEN string
1142 -secondNeedsNoncompliantFEN string
1143 The castling rights and e.p. fields of the FEN sent to the
1144 mentioned engine with the setboard command will be replaced by the
1145 given string. This can for instance be used to run engines that do
1146 not understand Chess960 FENs in variant fischerandom, to make them
1147 at least understand the opening position, through setting the
1148 string to "KQkq -". (Note you also have to give the e.p. field!)
1149 Other possible applications are to provide work-arounds for
1150 engines that want to see castling and e.p. fields in variants that
1151 do not have castling or e.p. (shatranj, courier, xiangqi, shogi)
1152 so that WinBoard would normally omit them (string = "- -"), or to
1153 add variant-specific fields that are not yet supported by WinBoard
1154 (e.g. to indicate the number of checks in 3check).
1156 3.2 UCI + WB Engine Settings
1157 ============================
1159 -fUCI or -firstIsUCI true/false
1160 -sUCI or -secondIsUCI true/false
1161 Indicates if the mentioned engine executable file is an UCI engine,
1162 and should be run with the aid of the Polyglot adapter rather than
1163 directly. Xboard will then pass the other UCI options and engine
1164 name to Polyglot through a .ini temporary file created for the
1167 -PolyglotDir filename
1168 Gives the name of the directory in which the Polyglot adapter for
1169 UCI engines expects its files. Default:
1170 "/usr/local/share/polyglot".
1172 -usePolyglotBook true/false
1173 Specifies if the Polyglot book should be used.
1175 -PolyglotBook filename
1176 Gives the filename of the opening book that Polyglot should use.
1177 From XBoard 4.3.15 on, native WinBoard engines will also use the
1178 opening book specified here, provided the `usePolyglotBook' option
1179 is set to true, and the option `firstHasOwnBookUCI' or
1180 `secondHasOwnBookUCI' applying to the engine is set to false. The
1181 engine will be kept in force mode as long as the current position
1182 is in book, and XBoard will select the book moves for it. Default
1185 -fNoOwnBookUCI or -firstXBook or -firstHasOwnBookUCI true/false
1186 -sNoOwnBookUCI or -secondXBook or -secondHasOwnBookUCI true/false
1187 Indicates if the mentioned engine has its own opening book it
1188 should play from, rather than using the external book through
1189 XBoard. Default: false.
1192 Sets the size of the hash table to n MegaBytes. Together with the
1193 EGTB cache size this number is also used to calculate the memory
1194 setting of WinBoard engines, for those that support the memory
1195 feature of WinBoard protocol. Default: 64.
1197 -defaultCacheSizeEGTB n
1198 Sets the size of the EGTB cache to n MegaBytes. Together with the
1199 hash-table size this number is also used to calculate the memory
1200 setting of WinBoard engines, for those that support the memory
1201 feature of WinBoard protocol. Default: 4.
1203 -defaultPathEGTB filename
1204 Gives the name of the directory where the end-game tablebases are
1205 installed, for UCI engines. Default: "/usr/local/share/egtb".
1208 Specifies which end-game tables are installed on the computer, and
1209 where. The argument is a comma-separated list of format
1210 specifications, each specification consisting of a format name, a
1211 colon, and a directory path name, e.g.
1212 "nalimov:/usr/local/share/egtb". If the name part matches that of
1213 a format that the engine requests through a feature command,
1214 xboard will relay the path name for this format to the engine
1215 through an egtpath command. One egtpath command for each matching
1216 format will be sent. Popular formats are "nalimov" DTM tablebases
1217 and "scorpio" bitbases. Default: "".
1222 -ics/-xics or -internetChessServerMode true/false
1223 Connect with an Internet Chess Server to play chess against its
1224 other users, observe games they are playing, or review games that
1225 have recently finished. Default: false.
1227 -icshost or -internetChessServerHost host
1228 The Internet host name or address of the chess server to connect
1229 to when in ICS mode. Default: `chessclub.com'. Another popular
1230 chess server to try is `freechess.org'. If your site doesn't have
1231 a working Internet name server, try specifying the host address in
1232 numeric form. You may also need to specify the numeric address
1233 when using the icshelper option with timestamp or timeseal (see
1236 -icsport or -internetChessServerPort port-number
1237 The port number to use when connecting to a chess server in ICS
1238 mode. Default: 5000.
1240 -icshelper or -internetChessServerHelper prog-name
1241 An external helper program used to communicate with the chess
1242 server. You would set it to "timestamp" for ICC (chessclub.com) or
1243 "timeseal" for FICS (freechess.org), after obtaining the correct
1244 version of timestamp or timeseal for your computer. See "help
1245 timestamp" on ICC and "help timeseal" on FICS. This option is
1246 shorthand for `-useTelnet -telnetProgram program'.
1248 -telnet/-xtelnet or -useTelnet true/false
1249 This option is poorly named; it should be called useHelper. If
1250 set to true, it instructs XBoard to run an external program to
1251 communicate with the Internet Chess Server. The program to use is
1252 given by the telnetProgram option. If the option is false (the
1253 default), XBoard opens a TCP socket and uses its own internal
1254 implementation of the telnet protocol to communicate with the ICS.
1257 -telnetProgram prog-name
1258 This option is poorly named; it should be called helperProgram.
1259 It gives the name of the telnet program to be used with the
1260 `gateway' and `useTelnet' options. The default is `telnet'. The
1261 telnet program is invoked with the value of
1262 `internetChessServerHost' as its first argument and the value of
1263 `internetChessServerPort' as its second argument. *Note
1267 If this option is set to a host name, XBoard communicates with the
1268 Internet Chess Server by using `rsh' to run the `telnetProgram' on
1269 the given host, instead of using its own internal implementation
1270 of the telnet protocol. You can substitute a different remote shell
1271 program for `rsh' using the `remoteShell' option described below.
1274 -internetChessServerCommPort or -icscomm dev-name
1275 If this option is set, XBoard communicates with the ICS through
1276 the given character I/O device instead of opening a TCP connection.
1277 Use this option if your system does not have any kind of Internet
1278 connection itself (not even a SLIP or PPP connection), but you do
1279 have dial-up access (or a hardwired terminal line) to an Internet
1280 service provider from which you can telnet to the ICS.
1282 The support for this option in XBoard is minimal. You need to set
1283 all communication parameters and tty modes before you enter XBoard.
1285 Use a script something like this:
1287 stty raw -echo 9600 > /dev/tty00
1288 xboard -ics -icscomm /dev/tty00
1290 Here replace `/dev/tty00' with the name of the device that your
1291 modem is connected to. You might have to add several more options
1292 to these stty commands. See the man pages for `stty' and `tty' if
1293 you run into problems. Also, on many systems stty works on its
1294 standard input instead of standard output, so you have to use `<'
1297 If you are using linux, try starting with the script below.
1298 Change it as necessary for your installation.
1301 # configure modem and fire up XBoard
1305 stty 2400 ; stty raw ; stty hupcl ; stty -clocal
1306 stty ignbrk ; stty ignpar ; stty ixon ; stty ixoff
1307 stty -iexten ; stty -echo
1309 xboard -ics -icscomm /dev/modem
1310 After you start XBoard in this way, type whatever commands are
1311 necessary to dial out to your Internet provider and log in. Then
1312 telnet to ICS, using a command like `telnet chessclub.com 5000'.
1313 Important: See the paragraph below about extra echoes, in *note
1316 -icslogon or -internetChessServerLogonScript file-name
1317 Whenever XBoard connects to the Internet Chess Server, if it finds
1318 a file with the name given in this option, it feeds the file's
1319 contents to the ICS as commands. The default file name is `.icsrc'.
1320 Usually the first two lines of the file should be your ICS user
1321 name and password. The file can be either in $CHESSDIR, in
1322 XBoard's working directory if CHESSDIR is not set, or in your home
1326 If you experience trouble logging on to an ICS when using the
1327 `-icslogon' option, inserting some delay between characters of the
1328 logon script may help. This option adds `delay' milliseconds of
1329 delay between characters. Good values to try are 100 and 250.
1331 -icsinput/-xicsinput or -internetChessServerInputBox true/false
1332 Sets the ICS Input Box menu option. *Note Mode Menu::. Default:
1335 -autocomm/-xautocomm or -autoComment true/false
1336 Sets the Auto Comment menu option. *Note Options Menu::. Default:
1339 -autoflag/-xautoflag or -autoCallFlag true/false
1340 Sets the Auto Flag menu option. *Note Options Menu::. Default:
1343 -autobs/-xautobs or -autoObserve true/false
1344 Sets the Auto Observe menu option. *Note Options Menu::. Default:
1348 Enables kibitzing of the engines last thinking output (depth,
1349 score, time, speed, PV) before it moved to the ICS, in zippy mode.
1350 The option `showThinking' must be switched on for this option to
1351 work. Also diverts similar kibitz information of an opponent
1352 engine that is playing you through the ICS to the engine-output
1353 window, as if the engine was playing locally.
1355 -moves/-xmoves or -getMoveList true/false
1356 Sets the Get Move List menu option. *Note Options Menu::.
1359 -alarm/-xalarm or -icsAlarm true/false
1360 Sets the ICS Alarm menu option. *Note Options Menu::. Default:
1364 Sets the time in milliseconds for the ICS Alarm menu option.
1365 *Note Options Menu::. Default: 5000.
1367 lowTimeWarning true/false
1368 Controls a color change of the board as a warning your time is
1369 running out. *Note Options Menu::. Default: false.
1371 -pre/-xpre \fRor\fB -premove true/false
1372 Sets the Premove menu option. *Note Options Menu::. Default: true.
1374 -quiet/-xquiet or -quietPlay true/false
1375 Sets the Quiet Play menu option. *Note Options Menu::. Default:
1378 -colorizeMessages or -colorize
1379 Setting colorizeMessages to true tells XBoard to colorize the
1380 messages received from the ICS. Colorization works only if your
1381 xterm supports ISO 6429 escape sequences for changing text colors.
1383 -colorShout foreground,background,bold
1384 -colorSShout foreground,background,bold
1385 -colorChannel1 foreground,background,bold
1386 -colorChannel foreground,background,bold
1387 -colorKibitz foreground,background,bold
1388 -colorTell foreground,background,bold
1389 -colorChallege foreground,background,bold
1390 -colorRequest foreground,background,bold
1391 -colorSeek foreground,background,bold
1392 -colorNormal foreground,background,bold
1393 These options set the colors used when colorizing ICS messages.
1394 All ICS messages are grouped into one of these categories: shout,
1395 sshout, channel 1, other channel, kibitz, tell, challenge, request
1396 (including abort, adjourn, draw, pause, and takeback), or normal
1397 (all other messages).
1399 Each foreground or background argument can be one of the following:
1400 black, red, green, yellow, blue, magenta, cyan, white, or default.
1401 Here "default" means the default foreground or background color of
1402 your xterm. Bold can be 1 or 0. If background is omitted,
1403 "default" is assumed; if bold is omitted, 0 is assumed.
1405 Here is an example of how to set the colors in your `.Xresources'
1406 file. The colors shown here are the default values; you will get
1407 them if you turn `-colorize' on without specifying your own colors.
1409 xboard*colorizeMessages: true
1410 xboard*colorShout: green
1411 xboard*colorSShout: green, black, 1
1412 xboard*colorChannel1: cyan
1413 xboard*colorChannel: cyan, black, 1
1414 xboard*colorKibitz: magenta, black, 1
1415 xboard*colorTell: yellow, black, 1
1416 xboard*colorChallenge: red, black, 1
1417 xboard*colorRequest: red
1418 xboard*colorSeek: blue
1419 xboard*colorNormal: default
1421 -soundProgram progname
1422 If this option is set to a sound-playing program that is installed
1423 and working on your system, XBoard can play sound files when
1424 certain events occur, listed below. The default program name is
1425 "play". If any of the sound options is set to "$", the event
1426 rings the terminal bell by sending a ^G character to standard
1427 output, instead of playing a sound file. If an option is set to
1428 the empty string "", no sound is played for that event.
1430 -soundShout filename
1431 -soundSShout filename
1432 -soundChannel filename
1433 -soundKibitz filename
1435 -soundChallenge filename
1436 -soundRequest filename
1438 These sounds are triggered in the same way as the colorization
1439 events described above. They all default to "", no sound. They
1440 are played only if the colorizeMessages is on.
1443 This sound is used by the Move Sound menu option. Default: "$".
1445 -soundIcsAlarm filename
1446 This sound is used by the ICS Alarm menu option. Default: "$".
1448 -soundIcsWin filename
1449 This sound is played when you win an ICS game. Default: "" (no
1452 -soundIcsLoss filename
1453 This sound is played when you lose an ICS game. Default: "" (no
1456 -soundIcsDraw filename
1457 This sound is played when you draw an ICS game. Default: "" (no
1460 -soundIcsUnfinished filename
1461 This sound is played when an ICS game that you are participating
1462 in is aborted, adjourned, or otherwise ends inconclusively.
1463 Default: "" (no sound).
1465 Here is an example of how to set the sounds in your `.Xresources'
1468 xboard*soundShout: shout.wav
1469 xboard*soundSShout: sshout.wav
1470 xboard*soundChannel1: channel1.wav
1471 xboard*soundChannel: channel.wav
1472 xboard*soundKibitz: kibitz.wav
1473 xboard*soundTell: tell.wav
1474 xboard*soundChallenge: challenge.wav
1475 xboard*soundRequest: request.wav
1476 xboard*soundSeek: seek.wav
1477 xboard*soundMove: move.wav
1478 xboard*soundIcsWin: win.wav
1479 xboard*soundIcsLoss: lose.wav
1480 xboard*soundIcsDraw: draw.wav
1481 xboard*soundIcsUnfinished: unfinished.wav
1482 xboard*soundIcsAlarm: alarm.wav
1484 3.4 Load and Save options
1485 =========================
1487 -lgf or -loadGameFile file
1488 -lgi or -loadGameIndex index
1489 If the `loadGameFile' option is set, XBoard loads the specified
1490 game file at startup. The file name `-' specifies the standard
1491 input. If there is more than one game in the file, XBoard pops up
1492 a menu of the available games, with entries based on their PGN
1493 (Portable Game Notation) tags. If the `loadGameIndex' option is
1494 set to `N', the menu is suppressed and the N th game found in the
1495 file is loaded immediately. The menu is also suppressed if
1496 `matchMode' is enabled or if the game file is a pipe; in these
1497 cases the first game in the file is loaded immediately. Use the
1498 `pxboard' shell script provided with XBoard if you want to pipe in
1499 files containing multiple games and still see the menu. If the
1500 loadGameIndex specifies an index -1, this triggers auto-increment
1501 of the index in `matchMode', which means that after every game the
1502 index is incremented by one, causing each game of the match to be
1503 played from the next game in the file. Similarly, specifying an
1504 index value of -2 causes the index to be incremented every two
1505 games, so that each game in the file is used twice (with reversed
1506 colors). The `rewindIndex' option causes the index to be reset to
1507 the first game of the file when it has reached a specified value.
1510 Causes a position file or game file to be rewound to its beginning
1511 after n positions or games in auto-increment `matchMode'. See
1512 `loadPositionIndex' and `loadGameIndex'. default: 0 (no rewind).
1514 -td or -timeDelay seconds
1515 Time delay between moves during `Load Game'. Fractional seconds
1516 are allowed; try `-td 0.4'. A time delay value of -1 tells XBoard
1517 not to step through game files automatically. Default: 1 second.
1519 -sgf or -saveGameFile file
1520 If this option is set, XBoard appends a record of every game
1521 played to the specified file. The file name `-' specifies the
1524 -autosave/-xautosave or -autoSaveGames true/false
1525 Sets the Auto Save menu option. *Note Options Menu::. Default:
1526 false. Ignored if `saveGameFile' is set.
1528 -lpf or -loadPositionFile file
1529 -lpi or -loadPositionIndex index
1530 If the `loadPositionFile' option is set, XBoard loads the
1531 specified position file at startup. The file name `-' specifies the
1532 standard input. If the `loadPositionIndex' option is set to N, the
1533 Nth position found in the file is loaded; otherwise the first
1534 position is loaded. If the loadPositionIndex specifies an index
1535 -1, this triggers auto-increment of the index in `matchMode',
1536 which means that after every game the index is incremented by one,
1537 causing each game of the match to be played from the next position
1538 in the file. Similarly, specifying an index value of -2 causes the
1539 index to be incremented every two games, so that each position in
1540 the file is used twice (with the engines playing opposite colors).
1541 The `rewindIndex' option causes the index to be reset to the first
1542 position of the file when it has reached a specified value.
1544 -spf or -savePositionFile file
1545 If this option is set, XBoard appends the final position reached
1546 in every game played to the specified file. The file name `-'
1547 specifies the standard output.
1549 -pgnExtendedInfo true/false
1550 If this option is set, WinBoard saves depth, score and time used
1551 for each move that the engine found as a comment in the PGN file.
1554 -pgnEventHeader string
1555 Sets the name used in the PGN event tag to string. Default:
1556 "Computer Chess Game".
1558 -saveOutOfBookInfo true/false
1559 Include the information on how the engine(s) game out of its
1560 opening book in a special 'annotator' tag with the PGN file.
1562 -oldsave/-xoldsave or -oldSaveStyle true/false
1563 Sets the Old Save Style menu option. *Note Options Menu::.
1566 -gameListTags string
1567 The character string lists the PGN tags that should be printed in
1568 the Game List, and their order. The meaning of the codes is
1569 e=event, s=site, d=date, o=round, p=players, r=result, w=white
1570 Elo, b=black Elo, t=time control, v=variant, a=out-of-book info.
1573 3.5 User interface options
1574 ==========================
1579 These and most other standard Xt options are accepted.
1582 Suppresses all GUI functions of XBoard (to speed up automated
1583 ultra-fast engine-engine games, which you donÂ’t want to watch).
1584 There will be no board or clock updates, no printing of moves, and
1585 no update of the icon on the task bar in this mode.
1587 -movesound/-xmovesound or -ringBellAfterMoves true/false
1588 Sets the Move Sound menu option. *Note Options Menu::. Default:
1589 false. For compatibility with old XBoard versions, -bell/-xbell
1590 are also accepted as abbreviations for this option.
1592 -exit/-xexit or -popupExitMessage true/false
1593 Sets the Popup Exit Message menu option. *Note Options Menu::.
1596 -popup/-xpopup or -popupMoveErrors true/false
1597 Sets the Popup Move Errors menu option. *Note Options Menu::.
1600 -queen/-xqueen or -alwaysPromoteToQueen true/false
1601 Sets the Always Queen menu option. *Note Options Menu::.
1604 -legal/-xlegal or -testLegality true/false
1605 Sets the Test Legality menu option. *Note Options Menu::.
1608 -size or -boardSize (sizeName | n1,n2,n3,n4,n5,n6,n7)
1609 Determines how large the board will be, by selecting the pixel size
1610 of the pieces and setting a few related parameters. The sizeName
1611 can be one of: Titanic, giving 129x129 pixel pieces, Colossal
1612 116x116, Giant 108x108, Huge 95x95, Big 87x87, Large 80x80, Bulky
1613 72x72, Medium 64x64, Moderate 58x58, Average 54x54, Middling
1614 49x49, Mediocre 45x45, Small 40x40, Slim 37x37, Petite 33x33,
1615 Dinky 29x29, Teeny 25x25, or Tiny 21x21. Pieces of all these
1616 sizes are built into XBoard. Other sizes can be used if you have
1617 them; see the pixmapDirectory and bitmapDirectory options. The
1618 default depends on the size of your screen; it is approximately the
1619 largest size that will fit without clipping.
1621 You can select other sizes or vary other layout parameters by
1622 providing a list of comma-separated values (with no spaces) as the
1623 argument. You do not need to provide all the values; for any you
1624 omit from the end of the list, defaults are taken from the nearest
1625 built-in size. The value `n1' gives the piece size, `n2' the
1626 width of the black border between squares, `n3' the desired size
1627 for the clockFont, `n4' the desired size for the coordFont, `n5'
1628 the desired size for the default font, `n6' the smallLayout flag
1629 (0 or 1), and `n7' the tinyLayout flag (0 or 1). All dimensions
1630 are in pixels. If the border between squares is eliminated (0
1631 width), the various highlight options will not work, as there is
1632 nowhere to draw the highlight. If smallLayout is 1 and
1633 `titleInWindow' is true, the window layout is rearranged to make
1634 more room for the title. If tinyLayout is 1, the labels on the
1635 menu bar are abbreviated to one character each and the buttons in
1636 the button bar are made narrower.
1638 -coords/-xcoords or -showCoords true/false
1639 Sets the Show Coords menu option. *Note Options Menu::. Default:
1640 false. The `coordFont' option specifies what font to use.
1642 -autoraise/-xautoraise or -autoRaiseBoard true/false
1643 Sets the Auto Raise Board menu option. *Note Options Menu::.
1646 -autoflip/-xautoflip or -autoFlipView true/false
1647 Sets the Auto Flip View menu option. *Note Options Menu::.
1650 -flip/-xflip or -flipView true/false
1651 If Auto Flip View is not set, or if you are observing but not
1652 participating in a game, then the positioning of the board at the
1653 start of each game depends on the flipView option. If flipView is
1654 false (the default), the board is positioned so that the white
1655 pawns move from the bottom to the top; if true, the black pawns
1656 move from the bottom to the top. In any case, the Flip menu
1657 option (see *note Options Menu::) can be used to flip the board
1658 after the game starts.
1660 -title/-xtitle or -titleInWindow true/false
1661 If this option is true, XBoard displays player names (for ICS
1662 games) and game file names (for `Load Game') inside its main
1663 window. If the option is false (the default), this information is
1664 displayed only in the window banner. You probably won't want to
1665 set this option unless the information is not showing up in the
1666 banner, as happens with a few X window managers.
1668 -buttons/-xbuttons or -showButtonBar True/False
1669 If this option is False, xboard omits the [<<] [<] [P] [>] [>>]
1670 button bar from the window, allowing the message line to be wider.
1671 You can still get the functions of these buttons using the menus
1672 or their keyboard shortcuts. Default: true.
1674 -mono/-xmono or -monoMode true/false
1675 Determines whether XBoard displays its pieces and squares with two
1676 colors (true) or four (false). You shouldn't have to specify
1677 `monoMode'; XBoard will determine if it is necessary.
1682 These options enable flashing of pieces when they land on their
1683 destination square. `flashCount' tells XBoard how many times to
1684 flash a piece after it lands on its destination square.
1685 `flashRate' controls the rate of flashing (flashes/sec).
1686 Abbreviations: `flash' sets flashCount to 3. `xflash' sets
1687 flashCount to 0. Defaults: flashCount=0 (no flashing),
1690 -highlight/-xhighlight or -highlightLastMove true/false
1691 Sets the Highlight Last Move menu option. *Note Options Menu::.
1694 -blind/-xblind or -blindfold true/false
1695 Sets the Blindfold menu option. *Note Options Menu::. Default:
1699 The font used for the clocks. If the option value is a pattern
1700 that does not specify the font size, XBoard tries to choose an
1701 appropriate font for the board size being used. Default:
1702 -*-helvetica-bold-r-normal-*-*-*-*-*-*-*-*.
1705 The font used for rank and file coordinate labels if `showCoords'
1706 is true. If the option value is a pattern that does not specify
1707 the font size, XBoard tries to choose an appropriate font for the
1708 board size being used. Default:
1709 -*-helvetica-bold-r-normal-*-*-*-*-*-*-*-*.
1712 The font used for popup dialogs, menus, comments, etc. If the
1713 option value is a pattern that does not specify the font size,
1714 XBoard tries to choose an appropriate font for the board size
1715 being used. Default: -*-helvetica-medium-r-normal-*-*-*-*-*-*-*-*.
1717 -fontSizeTolerance tol
1718 In the font selection algorithm, a nonscalable font will be
1719 preferred over a scalable font if the nonscalable font's size
1720 differs by `tol' pixels or less from the desired size. A value of
1721 -1 will force a scalable font to always be used if available; a
1722 value of 0 will use a nonscalable font only if it is exactly the
1723 right size; a large value (say 1000) will force a nonscalable font
1724 to always be used if available. Default: 4.
1726 -bm or -bitmapDirectory dir
1727 -pixmap or -pixmapDirectory dir
1728 These options control what piece images xboard uses. The XBoard
1729 distribution includes one set of pixmap pieces in xpm format, in
1730 the directory `pixmaps', and one set of bitmap pieces in xbm
1731 format, in the directory `bitmaps'. Pixmap pieces give a better
1732 appearance on the screen: the white pieces have dark borders, and
1733 the black pieces have opaque internal details. With bitmaps,
1734 neither piece color has a border, and the internal details are
1735 transparent; you see the square color or other background color
1738 If XBoard is configured and compiled on a system that includes
1739 libXpm, the X pixmap library, the xpm pixmap pieces are compiled
1740 in as the default. A different xpm piece set can be selected at
1741 runtime with the `pixmapDirectory' option, or a bitmap piece set
1742 can be selected with the `bitmapDirectory' option.
1744 If XBoard is configured and compiled on a system that does not
1745 include libXpm (or the `--disable-xpm' option is given to the
1746 configure program), the bitmap pieces are compiled in as the
1747 default. It is not possible to use xpm pieces in this case, but
1748 pixmap pieces in another format called "xim" can be used by giving
1749 the `pixmapDirectory' option. Or again, a different bitmap piece
1750 set can be selected with the `bitmapDirectory' option.
1752 Files in the `bitmapDirectory' must be named as follows: The first
1753 character of a piece bitmap name gives the piece it represents
1754 (`p', `n', `b', `r', `q', or `k'), the next characters give the
1755 size in pixels, the following character indicates whether the
1756 piece is solid or outline (`s' or `o'), and the extension is `.bm'.
1757 For example, a solid 80x80 knight would be named `n80s.bm'. The
1758 outline bitmaps are used only in monochrome mode. If bitmap
1759 pieces are compiled in and the bitmapDirectory is missing some
1760 files, the compiled in pieces are used instead.
1762 If the bitmapDirectory option is given, it is also possible to
1763 replace xboard's icons and menu checkmark, by supplying files
1764 named `icon_white.bm', `icon_black.bm', and `checkmark.bm'.
1766 For more information about pixmap pieces and how to get additional
1767 sets, see *note zic2xpm:: below.
1769 -whitePieceColor color
1770 -blackPieceColor color
1771 -lightSquareColor color
1772 -darkSquareColor color
1773 -highlightSquareColor color
1774 -lowTimeWarningColor color
1775 Colors to use for the pieces, squares, and square highlights.
1778 -whitePieceColor #FFFFCC
1779 -blackPieceColor #202020
1780 -lightSquareColor #C8C365
1781 -darkSquareColor #77A26D
1782 -highlightSquareColor #FFFF00
1783 -premoveHighlightColor #FF0000
1784 -lowTimeWarningColor #FF0000
1786 On a grayscale monitor you might prefer:
1788 -whitePieceColor gray100
1789 -blackPieceColor gray0
1790 -lightSquareColor gray80
1791 -darkSquareColor gray60
1792 -highlightSquareColor gray100
1793 -premoveHighlightColor gray70
1794 -lowTimeWarningColor gray70
1796 -drag/-xdrag or -animateDragging true/false
1797 Sets the Animate Dragging menu option. *Note Options Menu::.
1800 -animate/-xanimate or -animateMoving true/false
1801 Sets the Animate Moving menu option. *Note Options Menu::.
1805 Number of milliseconds delay between each animation frame when
1806 Animate Moves is on.
1808 3.6 Adjudication Options
1809 ========================
1811 -adjudicateLossThreshold n
1812 If the given value is non-zero, XBoard adjudicates the game as a
1813 loss if both engines agree for a duration of 6 consecutive ply
1814 that the score is below the given score threshold for that engine.
1815 Make sure the score is interpreted properly by XBoard, using
1816 `-firstScoreAbs' and `-secondScoreAbs' if needed. Default: 0 (no
1819 -adjudicateDrawMoves n
1820 If the given value is non-zero, XBoard adjudicates the game as a
1821 draw if after the given number of moves it was not yet decided.
1822 Default: 0 (no adjudication)
1824 -checkMates true/false
1825 If this option is set, XBoard detects all checkmates and
1826 stalemates, and ends the game as soon as they occur.
1827 Legality-testing must be switched on for this option to work.
1830 -testClaims true/false
1831 If this option is set, XBoard verifies all result claims made by
1832 engines, and those who send false claims will forfeit the game
1833 because of it. Legality-testing must be switched on for this
1834 option to work. Default: true
1836 -materialDraws true/false
1837 If this option is set, XBoard adjudicates games as draws when
1838 there is no sufficient material left to inflict a checkmate. This
1839 applies to KBKB with like bishops (any number, actually), and to
1840 KBK, KNK and KK. Legality-testing must be switched on for this
1841 option to work. Default: true
1843 -trivialDraws true/false
1844 If this option is set, XBoard adjudicates games as draws that
1845 cannot be usually won without opponent cooperation. This applies
1846 to KBKB with unlike bishops, and to KBKN, KNKN, KNNK, KRKR and
1847 KQKQ. The draw is called after 6 ply into these end-games, to
1848 allow quick mates that can occur in some exceptional positions to
1849 be found by the engines. KQKQ does not really belong in this
1850 category, and might be taken out in the future. (When
1851 bitbase-based adjudications are implemented.) Legality-testing
1852 must be on for this option to work. Default: false
1855 If the given value is non-zero, XBoard adjudicates the game as a
1856 draw after the given number of consecutive reversible moves.
1857 Engine draw claims are always accepted after 50 moves,
1858 irrespective of the given value of n.
1861 If the given value is non-zero, xboard adjudicates the game as a
1862 draw if a position is repeated the given number of times. Engines
1863 draw claims are always accepted after 3 repeats, (on the 3rd
1864 occurrence, actually), irrespective of the value of n. Beware
1865 that positions that have different castling or en-passant rights
1866 do not count as repeats, XBoard is fully e.p. and castling aware!
1871 -ncp/-xncp or -noChessProgram true/false
1872 If this option is true, XBoard acts as a passive chessboard; it
1873 does not start a chess engine at all. Turning on this option also
1874 turns off clockMode. Default: false.
1876 -mode or -initialMode modename
1877 If this option is given, XBoard selects the given modename from
1878 the Mode menu after starting and (if applicable) processing the
1879 loadGameFile or loadPositionFile option. Default: "" (no
1880 selection). Other supported values are MachineWhite,
1881 MachineBlack, TwoMachines, Analysis, AnalyzeFile, EditGame,
1882 EditPosition, and Training.
1885 Activates preliminary, partial support for playing chess variants
1886 against a local engine or editing variant games. This flag is not
1887 needed in ICS mode. Recognized variant names are:
1890 wildcastle Shuffle chess, king can castle from d file
1891 nocastle Shuffle chess, no castling allowed
1892 fischerandom Fischer Random shuffle chess
1893 bughouse Bughouse, ICC/FICS rules
1894 crazyhouse Crazyhouse, ICC/FICS rules
1895 losers Lose all pieces or get mated (ICC wild 17)
1896 suicide Lose all pieces including king (FICS)
1897 giveaway Try to have no legal moves (ICC wild 26)
1898 twokings Weird ICC wild 9
1899 kriegspiel Opponent's pieces are invisible
1900 atomic Capturing piece explodes (ICC wild 27)
1901 3check Win by giving check 3 times (ICC wild 25)
1902 shatranj An ancient precursor of chess (ICC wild 28)
1903 xiangqi Chinese Chess (on a 9x10 board)
1904 shogi Japanese Chess (on a 9x9 board & piece drops)
1905 capablanca Capablanca Chess (10x8 board, with Archbishop
1906 and Chancellor pieces)
1907 gothic similar, with a better initial position
1908 caparandom An FRC-like version of Capablanca Chess (10x8)
1909 janus A game with two Archbishops (10x8 board)
1910 courier Medieval intermediate between shatranj and
1911 modern Chess (on 12x8 board)
1912 falcon Patented 10x8 variant with two Falcon pieces
1913 berolina Pawns capture straight ahead, and move diagonal
1914 cylinder Pieces wrap around the board edge
1915 knightmate King moves as Knight, and vice versa
1916 super Superchess (shuffle variant with 4 exo-pieces)
1917 fairy A catchall variant in which all piece types
1918 known to XBoard can participate (8x8)
1919 unknown Catchall for other unknown variants
1921 In the shuffle variants, XBoard now does shuffle the pieces,
1922 although you can still do it by hand using Edit Position. Some
1923 variants are supported only in ICS mode, including bughouse, and
1924 kriegspiel. The winning/drawing conditions in crazyhouse
1925 (off-board interposition on mate), losers, suicide, giveaway,
1926 atomic, and 3check are not fully understood. Berolina and
1927 cylinder chess can only be played with legality testing off. In
1928 crazyhouse, XBoard now does keep track of off-board pieces. In
1929 shatranj it does implement the baring rule when mate detection is
1933 Allows you to set a non-standard number of board ranks in any
1934 variant. If the height is given as -1, the default height for the
1935 variant is used. Default: -1
1938 Allows you to set a non-standard number of board files in any
1939 variant. If the width is given as -1, the default width for the
1940 variant is used. With a non-standard width, the initial position
1941 will always be an empty board, as the usual opening array will not
1945 Allows you to set a non-standard size for the holdings in any
1946 variant. If the size is given as -1, the default holdings size
1947 for the variant is used. The first N piece types will go into the
1948 holdings on capture, and you will be able to drop them on the
1949 board in stead of making a normal move. If size equals 0, there
1950 will be no holdings. Default: -1
1952 -defaultFrcPosition N
1953 Specifies the number of the opening position in shuffle games like
1954 Chess960. A value of -1 means the position is randomly generated
1955 by XBoard at the beginning of every game. Default: -1
1957 -pieceToSquareTable string
1958 The characters that are used to represent the piece types XBoard
1959 knows in FEN diagrams and SAN moves. The string argument has to
1960 have an even length (or it will be ignored), as white and black
1961 pieces have to be given separately (in that order). The last
1962 letter for each color will be the King. The letters before that
1963 will be PNBRQ and then a whole host of fairy pieces in an order
1964 that has not fully crystallized yet (currently FEACWMOHIJGDVSLU,
1965 F=Ferz, Elephant, A=Archbishop, C=Chancellor, W=Wazir, M=Commoner,
1966 O=Cannon, H=Nightrider). You should list at least all pieces that
1967 occur in the variant you are playing. If you have less than 44
1968 characters in the string, the pieces not mentioned will get
1969 assigned a period, and you will not be able to distinguish them in
1970 FENs. You can also explicitly assign pieces a period, in which
1971 case they will not be counted in deciding which captured pieces
1972 can go into the holdings. A tilde '~' as a piece name does mean
1973 this piece is used to represent a promoted Pawn in crazyhouse-like
1974 games, i.e. on capture it turns back onto a Pawn. A '+' similarly
1975 indicates the piece is a shogi-style promoted piece, that should
1976 revert to its non-promoted version on capture (rather than to a
1977 Pawn). Note that promoted pieces are represented by pieces 11
1978 further in the list. You should not have to use this option
1979 often: each variant has its own default setting for the piece
1980 representation in FEN, which should be sufficient in normal use.
1983 -debug/-xdebug or -debugMode true/false
1984 Turns on debugging printout.
1986 -debugFile filename or -nameOfDebugFile filename
1987 Sets the name of the file to which WinBoard saves debug information
1988 (including all communication to and from the engines).
1990 -engineDebugOutput number
1991 Specifies how WinBoard should handle unsolicited output from the
1992 engine, with respect to saving it in the debug file. The output
1993 is further (hopefully) ignored. If number=0, WinBoard refrains
1994 from writing such spurious output to the debug file. If number=1,
1995 all engine output is written faithfully to the debug file. If
1996 number=2, any protocol-violating line is prefixed with a '#'
1997 character, as the engine itself should have done if it wanted to
1998 submit info for inclusion in the debug file. This option is
1999 provided for the benefit of applications that use the debug file
2000 as a source of information, such as the broadcaster of live games
2001 TLCV / TLCS. Such applications can be protected from spurious
2002 engine output that might otherwise confuse them.
2004 -rsh or -remoteShell shell-name
2005 Name of the command used to run programs remotely. The default is
2006 `rsh' or `remsh', determined when XBoard is configured and
2009 -ruser or -remoteUser user-name
2010 User name on the remote system when running programs with the
2011 `remoteShell'. The default is your local user name.
2014 Name under which the Human player will be listed in the PGN file.
2015 Default is the login name on your local computer.
2017 -delayBeforeQuit number
2018 -delayAfterQuit number
2019 These options specify how long WinBoard has to wait before sending
2020 a termination signal to rogue engine processes, that do not want
2021 to react to the 'quit' command. The second one determines the
2022 pause after killing the engine, to make sure it dies.
2028 An "Internet Chess Server", or "ICS", is a place on the Internet where
2029 people can get together to play chess, watch other people's games, or
2030 just chat. You can use either `telnet' or a client program like XBoard
2031 to connect to the server. There are thousands of registered users on
2032 the different ICS hosts, and it is not unusual to meet 200 on both
2033 chessclub.com and freechess.org.
2035 Most people can just type `xboard -ics' to start XBoard as an ICS
2036 client. Invoking XBoard in this way connects you to the Internet Chess
2037 Club (ICC), a commercial ICS. You can log in there as a guest even if
2038 you do not have a paid account. To connect to the largest Free ICS
2039 (FICS), use the command `xboard -ics -icshost freechess.org' instead,
2040 or substitute a different host name to connect to your favorite ICS.
2041 For a full description of command-line options that control the
2042 connection to ICS and change the default values of ICS options, see
2043 *note ICS options::.
2045 While you are running XBoard as an ICS client, you use the terminal
2046 window that you started XBoard from as a place to type in commands and
2047 read information that is not available on the chessboard.
2049 The first time you need to use the terminal is to enter your login
2050 name and password, if you are a registered player. (You don't need to do
2051 this manually; the `icsLogon' option can do it for you. *note ICS
2052 options::.) If you are not registered, enter `g' as your name, and the
2053 server will pick a unique guest name for you.
2055 Some useful ICS commands include
2057 to get help on the given <topic>. To get a list of possible topics
2058 type "help" without topic. Try the help command before you ask
2059 other people on the server for help.
2061 For example `help register' tells you how to become a registered
2065 to see a list of people who are logged on. Administrators (people
2066 you should talk to if you have a problem) are marked with the
2067 character `*', an asterisk. The <flags> allow you to display only
2068 selected players: For example, `who of' shows a list of players
2069 who are interested in playing but do not have an opponent.
2072 to see what games are being played
2074 `match <player> [<mins>] [<inc>]'
2075 to challenge another player to a game. Both opponents get <mins>
2076 minutes for the game, and <inc> seconds will be added after each
2077 move. If another player challenges you, the server asks if you
2078 want to accept the challenge; use the `accept' or `decline'
2083 to accept or decline another player's offer. The offer may be to
2084 start a new game, or to agree to a `draw', `adjourn' or `abort'
2085 the current game. *Note Action Menu::.
2087 If you have more than one pending offer (for example, if more than
2088 one player is challenging you, or if your opponent offers both a
2089 draw and to adjourn the game), you have to supply additional
2090 information, by typing something like `accept <player>', `accept
2096 asks your opponent to terminate a game by mutual agreement.
2097 Adjourned games can be continued later. Your opponent can either
2098 `decline' your offer or accept it (by typing the same command or
2099 typing `accept'). In some cases these commands work immediately,
2100 without asking your opponent to agree. For example, you can abort
2101 the game unilaterally if your opponent is out of time, and you can
2102 claim a draw by repetition or the 50-move rule if available simply
2106 to get information about the given <player>. (Default: yourself.)
2109 to get a list of personal settings
2112 to modify these settings
2115 to observe an ongoing game of the given <player>.
2119 to review a recently completed game
2121 Some special XBoard features are activated when you are in examine
2122 mode on ICS. See the descriptions of the menu commands `Forward',
2123 `Backward', `Pause', `ICS Client', and `Stop Examining' on the *note
2124 Step Menu::, *note Mode Menu::, and *note Options Menu::.
2129 By default, XBoard communicates with an Internet Chess Server by
2130 opening a TCP socket directly from the machine it is running on to the
2131 ICS. If there is a firewall between your machine and the ICS, this
2132 won't work. Here are some recipes for getting around common kinds of
2133 firewalls using special options to XBoard. Important: See the
2134 paragraph in the below about extra echoes, in *note Limitations::.
2136 Suppose that you can't telnet directly to ICS, but you can telnet to
2137 a firewall host, log in, and then telnet from there to ICS. Let's say
2138 the firewall is called `firewall.example.com'. Set command-line options
2141 xboard -ics -icshost firewall.example.com -icsport 23
2142 Or in your `.Xresources' file:
2144 XBoard*internetChessServerHost: firewall.example.com
2145 XBoard*internetChessServerPort: 23
2146 Then when you run XBoard in ICS mode, you will be prompted to log in
2147 to the firewall host. This works because port 23 is the standard telnet
2148 login service. Do so, then telnet to ICS, using a command like `telnet
2149 chessclub.com 5000', or whatever command the firewall provides for
2150 telnetting to port 5000.
2152 If your firewall lets you telnet (or rlogin) to remote hosts but
2153 doesn't let you telnet to port 5000, you may be able to connect to the
2154 chess server on port 23 instead, which is the port the telnet program
2155 uses by default. Some chess servers support this (including
2156 chessclub.com and freechess.org), while some do not.
2158 If your chess server does not allow connections on port 23 and your
2159 firewall does not allow you to connect to other ports, you may be able
2160 to connect by hopping through another host outside the firewall that
2161 you have an account on. For instance, suppose you have a shell account
2162 at `foo.edu'. Follow the recipe above, but instead of typing `telnet
2163 chessclub.com 5000' to the firewall, type `telnet foo.edu' (or `rlogin
2164 foo.edu'), log in there, and then type `telnet chessclub.com 5000'.
2166 Suppose that you can't telnet directly to ICS, but you can use rsh
2167 to run programs on a firewall host, and that host can telnet to ICS.
2168 Let's say the firewall is called `rsh.example.com'. Set command-line
2171 xboard -ics -gateway rsh.example.com -icshost chessclub.com
2173 Or in your `.Xresources' file:
2175 XBoard*gateway: rsh.example.com
2176 XBoard*internetChessServerHost: chessclub.com
2178 Then when you run XBoard in ICS mode, it will connect to the ICS by
2179 using `rsh' to run the command `telnet chessclub.com 5000' on host
2182 Suppose that you can telnet anywhere you want, but you have to run a
2183 special program called `ptelnet' to do so.
2185 First, we'll consider the easy case, in which `ptelnet chessclub.com
2186 5000' gets you to the chess server. In this case set command line
2189 xboard -ics -telnet -telnetProgram ptelnet
2191 Or in your `.Xresources' file:
2193 XBoard*useTelnet: true
2194 XBoard*telnetProgram: ptelnet
2196 Then when you run XBoard in ICS mode, it will issue the command
2197 `ptelnet chessclub.com 5000' to connect to the ICS.
2199 Next, suppose that `ptelnet chessclub.com 5000' doesn't work; that
2200 is, your `ptelnet' program doesn't let you connect to alternative
2201 ports. As noted above, your chess server may allow you to connect on
2202 port 23 instead. In that case, just add the option `-icsport ""' to
2203 the above command, or add `XBoard*internetChessServerPort:' to your
2204 `.Xresources' file. But if your chess server doesn't let you connect
2205 on port 23, you will have to find some other host outside the firewall
2206 and hop through it. For instance, suppose you have a shell account at
2207 `foo.edu'. Set command line options as follows:
2209 xboard -ics -telnet -telnetProgram ptelnet -icshost foo.edu -icsport ""
2211 Or in your `.Xresources' file:
2213 XBoard*useTelnet: true
2214 XBoard*telnetProgram: ptelnet
2215 XBoard*internetChessServerHost: foo.edu
2216 XBoard*internetChessServerPort:
2218 Then when you run XBoard in ICS mode, it will issue the command
2219 `ptelnet foo.edu' to connect to your account at `foo.edu'. Log in
2220 there, then type `telnet chessclub.com 5000'.
2222 ICC timestamp and FICS timeseal do not work through some firewalls.
2223 You can use them only if your firewall gives a clean TCP connection
2224 with a full 8-bit wide path. If your firewall allows you to get out
2225 only by running a special telnet program, you can't use timestamp or
2226 timeseal across it. But if you have access to a computer just outside
2227 your firewall, and you have much lower netlag when talking to that
2228 computer than to the ICS, it might be worthwhile running timestamp
2229 there. Follow the instructions above for hopping through a host
2230 outside the firewall (foo.edu in the example), but run timestamp or
2231 timeseal on that host instead of telnet.
2233 Suppose that you have a SOCKS firewall that will give you a clean
2234 8-bit wide TCP connection to the chess server, but only after you
2235 authenticate yourself via the SOCKS protocol. In that case, you could
2236 make a socksified version of XBoard and run that. If you are using
2237 timestamp or timeseal, you will to socksify it, not XBoard; this may be
2238 difficult seeing that ICC and FICS do not provide source code for these
2239 programs. Socksification is beyond the scope of this document, but see
2240 the SOCKS Web site at http://www.socks.permeo.com/. If you are missing
2241 SOCKS, try http://www.funbureau.com/.
2243 6 Environment variables
2244 ***********************
2246 Game and position files are found in a directory named by the
2247 `CHESSDIR' environment variable. If this variable is not set, the
2248 current working directory is used. If `CHESSDIR' is set, XBoard
2249 actually changes its working directory to `$CHESSDIR', so any files
2250 written by the chess engine will be placed there too.
2252 7 Limitations and known bugs
2253 ****************************
2255 There is no way for two people running copies of XBoard to play each
2256 other without going through an Internet Chess Server.
2258 Under some circumstances, your ICS password may be echoed when you
2261 If you are connecting to the ICS by running telnet on an Internet
2262 provider or firewall host, you may find that each line you type is
2263 echoed back an extra time after you hit <Enter>. If your Internet
2264 provider is a Unix system, you can probably turn its echo off by typing
2265 `stty -echo' after you log in, and/or typing <^E><Enter> (Ctrl+E
2266 followed by the Enter key) to the telnet program after you have logged
2267 into ICS. It is a good idea to do this if you can, because the extra
2268 echo can occasionally confuse XBoard's parsing routines.
2270 The game parser recognizes only algebraic notation.
2272 Many of the following points used to be limitations in XBoard 4.2.7
2273 and earlier, but are now fixed: The internal move legality tester in
2274 XBoard 4.3.xx does look at the game history, and is fully aware of
2275 castling or en-passant-capture rights. It permits castling with the
2276 king on the d file because this is possible in some "wild 1" games on
2277 ICS. The piece-drop menu does not check piece drops in bughouse to see
2278 if you actually hold the piece you are trying to drop. But this way of
2279 dropping pieces should be considered an obsolete feature, now that
2280 pieces can be dropped by dragging them from the holdings to the board.
2281 Anyway, if you would attempt an illegal move when using a chess engine
2282 or the ICS, WinBoard will accept the error message that comes back,
2283 undo the move, and let you try another. FEN positions saved by XBoard
2284 do include correct information about whether castling or en passant are
2285 legal, and also handle the 50-move counter. The mate detector does not
2286 understand that non-contact mate is not really mate in bughouse. The
2287 only problem this causes while playing is minor: a "#" (mate indicator)
2288 character will show up after a non-contact mating move in the move
2289 list. XBoard will not assume the game is over at that point, not even
2290 when the option Detect Mates is on. Edit Game mode always uses the
2291 rules of the selected variant, which can be a variant that uses piece
2292 drops. You can load and edit games that contain piece drops. The
2293 (obsolete) piece menus are not active, but you can perform piece drops
2294 by dragging pieces from the holdings. Edit Position mode does not
2295 allow you to edit the crazyhouse holdings properly. You cannot drag
2296 pieces to the holding, and using the popup menu to put pieces there
2297 does not adapt the holding counts and leads to an inconsistent state.
2298 Set up crazyhouse positions by loading / pasting a bFEN, from there you
2299 can set the holdings. Fischer Random castling is fully understood.
2300 You can enter castlings by dragging the King on top of your Rook. You
2301 can probably also play Fischer Random successfully on ICS by typing
2302 castling moves into the ICS Interaction window.
2304 The menus may not work if your keyboard is in Caps Lock or Num Lock
2305 mode. This seems to be a problem with the Athena menu widget, not an
2308 Also see the ToDo file included with the distribution for many other
2309 possible bugs, limitations, and ideas for improvement that have been
2312 8 Reporting problems
2313 ********************
2315 Report bugs and problems with XBoard to `<bug-xboard@gnu.org>'.
2317 Please use the `script' program to start a typescript, run XBoard
2318 with the `-debug' option, and include the typescript output in your
2319 message. Also tell us what kind of machine and what operating system
2320 version you are using. The command `uname -a' will often tell you this.
2321 Here is a sample of approximately what you should type:
2329 mail bug-xboard@gnu.org
2330 Subject: Your short description of the problem
2331 Your detailed description of the problem
2335 The WinBoard / XBoard 4.3 line is being developed by H.G. Muller
2336 independently of the GNU Savannah xboard project. Bug reports on this
2337 version, and suggestions for improvements and additions, are best
2338 posted in the WinBoard forum, WinBoard-development section
2339 (http://www.open-aurec.com/wbforum).
2341 If you improve XBoard, please send a message about your changes, and
2342 we will get in touch with you about merging them in to the main line of
2343 development. Also see our Web site at
2344 http://savannah.gnu.org/projects/xboard/.
2346 9 Authors and contributors
2347 **************************
2349 Tim Mann has been responsible for XBoard versions 1.3 and beyond, and
2350 for WinBoard, a port of XBoard to Microsoft Win32 (Windows NT and
2351 Windows 95). H.G.Muller is responsible for version 4.3.
2353 Mark Williams contributed the initial (WinBoard-only) implementation
2354 of many new features added to both XBoard and WinBoard in version
2355 4.1.0, including copy/paste, premove, icsAlarm, autoFlipView, training
2356 mode, auto raise, and blindfold. Ben Nye contributed X copy/paste code
2359 Hugh Fisher added animated piece movement to XBoard, and Henrik Gram
2360 (henrikg@funcom.com) added it to WinBoard. Frank McIngvale added
2361 click/click moving, the Analysis modes, piece flashing, ZIICS import,
2362 and ICS text colorization to XBoard. Jochen Wiedmann ported XBoard to
2363 the Amiga, creating AmyBoard, and converted the documentation to
2364 texinfo. Elmar Bartel contributed the new piece bitmaps introduced in
2365 version 3.2. John Chanak contributed the initial implementation of ICS
2366 mode. The color scheme and the old 80x80 piece bitmaps were taken from
2367 Wayne Christopher's `XChess' program.
2369 Chris Sears and Dan Sears wrote the original XBoard. They were
2370 responsible for versions 1.0 through 1.2.
2372 Evan Welsh wrote `CMail'. Patrick Surry helped in designing,
2373 testing, and documenting CMail.
2375 Alessandro Scotti added many elements to the user interface of
2376 WinBoard, including the board textures and font-based rendering, the
2377 evaluation-graph, move-history and engine-output window. He was also
2378 responsible for adding the UCI support.
2380 H.G. Muller made WinBoard castling- and e.p.-aware, added variant
2381 support with adjustable board sizes, the crazyhouse holdings, and the
2382 fairy pieces. In addition he added most of the adjudication options,
2383 made WinBoard more robust in dealing with buggy and crashing engines,
2384 and extended time control with a time-odds and node-count-based modes.
2385 Most of the options that initially were WinBoard only have now been
2386 back-ported to XBoard.
2388 Michel van den Bergh provided the code for reading Polyglot opening
2391 Arun Persaud worked with H.G. Muller to combine all the features of
2392 the never-released WinBoard 4.2.8 of the Savannah project (mainly by
2393 Daniel Mehrmann), and the never-released 4.3.16 into a unified WinBoard
2394 4.4, which is now available both from the Savannah web site and the
2400 The `cmail' program can help you play chess by email with opponents of
2401 your choice using XBoard as an interface.
2403 You will usually run `cmail' without giving any options.
2409 Displays `cmail' usage information.
2412 Shows the conditions of the GNU General Public License. *Note
2416 Shows the warranty notice of the GNU General Public License.
2421 Provides or inhibits verbose output from `cmail' and XBoard,
2422 useful for debugging. The `-xv' form also inhibits the cmail
2423 introduction message.
2427 Invokes or inhibits the sending of a mail message containing the
2432 Invokes or inhibits the running of XBoard on the game file.
2436 Invokes or inhibits the reuse of an existing XBoard to display the
2440 Resends the last mail message for that game. This inhibits running
2444 The name of the game to be processed.
2449 Number of games to start as White, as Black or in total. Default
2450 is 1 as white and none as black. If only one color is specified
2451 then none of the other color is assumed. If no color is specified
2452 then equal numbers of White and Black games are started, with the
2453 extra game being as White if an odd number of total games is
2458 A one-word alias for yourself or your opponent.
2463 -oppname <full name>
2464 The full name of White, Black, yourself or your opponent.
2469 -oppna <net address>
2470 The email address of White, Black, yourself or your opponent.
2473 The directory in which `cmail' keeps its files. This defaults to
2474 the environment variable `$CMAIL_DIR' or failing that, `$CHESSDIR',
2475 `$HOME/Chess' or `~/Chess'. It will be created if it does not
2479 The directory in which `cmail' archives completed games. Defaults
2480 to the environment variable `$CMAIL_ARCDIR' or, in its absence,
2481 the same directory as cmail keeps its working files (above).
2483 -mailprog <mail program>
2484 The program used by cmail to send email messages. This defaults to
2485 the environment variable `$CMAIL_MAILPROG' or failing that
2486 `/usr/ucb/Mail', `/usr/ucb/mail' or `Mail'. You will need to set
2487 this variable if none of the above paths fit your system.
2490 A file containing a list of games with email addresses. This
2491 defaults to the environment variable `$CMAIL_GAMES' or failing that
2495 A file containing one or more aliases for a set of email
2496 addresses. This defaults to the environment variable
2497 `$CMAIL_ALIASES' or failing that `.cmailaliases'.
2500 A file in which to dump verbose debugging messages that are
2501 invoked with the `-v' option.
2504 The PGN Event tag (default `Email correspondence game').
2507 The PGN Site tag (default `NET').
2510 The PGN Round tag (default `-', not applicable).
2513 The PGN Mode tag (default `EM', Electronic Mail).
2516 Any option flags not listed above are passed through to XBoard.
2517 Invoking XBoard through CMail changes the default values of two
2518 XBoard options: The default value for `-noChessProgram' is changed
2519 to true; that is, by default no chess engine is started. The
2520 default value for `-timeDelay' is changed to 0; that is, by default
2521 XBoard immediately goes to the end of the game as played so far,
2522 rather than stepping through the moves one by one. You can still
2523 set these options to whatever values you prefer by supplying them
2524 on CMail's command line. *Note Options::.
2526 10.2 Starting a CMail Game
2527 ==========================
2529 Type `cmail' from a shell to start a game as white. After an opening
2530 message, you will be prompted for a game name, which is optional--if you
2531 simply press <Enter>, the game name will take the form
2532 `you-VS-opponent'. You will next be prompted for the short name of your
2533 opponent. If you haven't played this person before, you will also be
2534 prompted for his/her email address. `cmail' will then invoke XBoard in
2535 the background. Make your first move and select `Mail Move' from the
2536 `File' menu. *Note File Menu::. If all is well, `cmail' will mail a
2537 copy of the move to your opponent. If you select `Exit' without having
2538 selected `Mail Move' then no move will be made.
2540 10.3 Answering a Move
2541 =====================
2543 When you receive a message from an opponent containing a move in one of
2544 your games, simply pipe the message through `cmail'. In some mailers
2545 this is as simple as typing `| cmail' when viewing the message, while in
2546 others you may have to save the message to a file and do `cmail < file'
2547 at the command line. In either case `cmail' will display the game using
2548 XBoard. If you didn't exit XBoard when you made your first move then
2549 `cmail' will do its best to use the existing XBoard instead of starting
2550 a new one. As before, simply make a move and select `Mail Move' from
2551 the `File' menu. *Note File Menu::. `cmail' will try to use the XBoard
2552 that was most recently used to display the current game. This means
2553 that many games can be in progress simultaneously, each with its own
2556 If you want to look at the history or explore a variation, go ahead,
2557 but you must return to the current position before XBoard will allow you
2558 to mail a move. If you edit the game's history you must select `Reload
2559 Same Game' from the `File' menu to get back to the original position,
2560 then make the move you want and select `Mail Move'. As before, if you
2561 decide you aren't ready to make a move just yet you can either select
2562 `Exit' without sending a move or just leave XBoard running until you
2565 10.4 Multi-Game Messages
2566 ========================
2568 It is possible to have a `cmail' message carry more than one game.
2569 This feature was implemented to handle IECG (International Email Chess
2570 Group) matches, where a match consists of one game as white and one as
2571 black, with moves transmitted simultaneously. In case there are more
2572 general uses, `cmail' itself places no limit on the number of
2573 black/white games contained in a message; however, XBoard does.
2575 10.5 Completing a Game
2576 ======================
2578 Because XBoard can detect checkmate and stalemate, `cmail' handles game
2579 termination sensibly. As well as resignation, the `Action' menu allows
2580 draws to be offered and accepted for `cmail' games.
2582 For multi-game messages, only unfinished and just-finished games
2583 will be included in email messages. When all the games are finished,
2584 they are archived in the user's archive directory, and similarly in the
2585 opponent's when he or she pipes the final message through `cmail'. The
2586 archive file name includes the date the game was started.
2588 10.6 Known CMail Problems
2589 =========================
2591 It's possible that a strange conjunction of conditions may occasionally
2592 mean that `cmail' has trouble reactivating an existing XBoard. If this
2593 should happen, simply trying it again should work. If not, remove the
2594 file that stores the XBoard's PID (`game.pid') or use the `-xreuse'
2595 option to force `cmail' to start a new XBoard.
2597 Versions of `cmail' after 2.16 no longer understand the old file
2598 format that XBoard used to use and so cannot be used to correspond with
2599 anyone using an older version.
2601 Versions of `cmail' older than 2.11 do not handle multi-game
2602 messages, so multi-game correspondence is not possible with opponents
2603 using an older version.
2605 11 Other programs you can use with XBoard
2606 *****************************************
2608 Here are some other programs you can use with XBoard
2613 The GNU Chess engine is available from:
2615 ftp://ftp.gnu.org/gnu/gnuchess/
2617 You can use XBoard to play a game against GNU Chess, or to interface
2618 GNU Chess to an ICS.
2623 Fairy-Max is a derivative from the once World's smallest Chess program
2624 micro-Max, which measures only about 100 lines of source code. The
2625 main difference with micro-Max is that Fairy-Max loads its
2626 move-generator tables from a file, so that the rules for piece movement
2627 can be easily configured to implement unorthodox pieces. Fairy-Max can
2628 therefore play a large number of variants, normal Chess being one of
2629 those. In addition it plays Knightmate, Capablanca and Gothic Chess,
2630 Shatranj, Courier Chess, Cylinder chess, Berolina Chess, while the user
2631 can easily define new variants. It can be obtained from:
2633 http://home.hccnet.nl/h.g.muller/dwnldpage.html
2638 HoiChess is a not-so-very-strong Chess engine, which comes with a
2639 derivative HoiXiangqi, able to play Chinese Chess. It can be obtained
2640 from the standard Linux repositories through:
2642 sudo apt-get install hoichess
2647 Crafty is a chess engine written by Bob Hyatt. You can use XBoard to
2648 play a game against Crafty, hook Crafty up to an ICS, or use Crafty to
2649 interactively analyze games and positions for you.
2651 Crafty is a strong, rapidly evolving chess program. This rapid pace
2652 of development is good, because it means Crafty is always getting
2653 better. This can sometimes cause problems with backwards
2654 compatibility, but usually the latest version of Crafty will work well
2655 with the latest version of XBoard. Crafty can be obtained from its
2656 author's FTP site: ftp://ftp.cis.uab.edu/hyatt/.
2658 To use Crafty with XBoard, give the -fcp and -fd options as follows,
2659 where <crafty's directory> is the directory in which you installed
2660 Crafty and placed its book and other support files.
2665 The "zic2xpm" program is used to import chess sets from the ZIICS(*)
2666 program into XBoard. "zic2xpm" is part of the XBoard distribution.
2667 ZIICS is available from:
2669 ftp://ftp.freechess.org/pub/chess/DOS/ziics131.exe
2671 To import ZIICS pieces, do this:
2672 1. Unzip ziics131.exe into a directory:
2673 unzip -L ziics131.exe -d ~/ziics
2675 2. Use zic2xpm to convert a set of pieces to XBoard format.
2676 For example, let's say you want to use the FRITZ4 set. These files
2677 are named "fritz4.*" in the ZIICS distribution.
2681 zic2xpm ~/ziics/fritz4.*
2683 3. Give XBoard the "-pixmap" option when starting up, e.g.:
2684 xboard -pixmap ~/fritz4
2686 Alternatively, you can add this line to your `.Xresources' file:
2688 xboard*pixmapDirectory: ~/fritz4
2690 (*) ZIICS is a separate copyrighted work of Andy McFarland. The
2691 "ZIICS pieces" are copyrighted works of their respective creators.
2692 Files produced by "zic2xpm" are for PERSONAL USE ONLY and may NOT be
2693 redistributed without explicit permission from the original creator(s)
2699 Copyright (C) 1991 Digital Equipment Corporation, Maynard,
2702 All Rights Reserved.
2704 Permission to use, copy, modify, and distribute this software and its
2705 documentation for any purpose and without fee is hereby granted,
2706 provided that the above copyright notice appear in all copies and that
2707 both that copyright notice and this permission notice appear in
2708 supporting documentation, and that the name of Digital not be used in
2709 advertising or publicity pertaining to distribution of the software
2710 without specific, written prior permission.
2712 Digital disclaims all warranties with regard to this software,
2713 including all implied warranties of merchantability and fitness. In no
2714 event shall Digital be liable for any special, indirect or
2715 consequential damages or any damages whatsoever resulting from loss of
2716 use, data or profits, whether in an action of contract, negligence or
2717 other tortious action, arising out of or in connection with the use or
2718 performance of this software.
2720 Enhancements copyright (C) 1992-2003,2004,2005,2006,2007,2008,2009
2721 Free Software Foundation, Inc.
2723 Published by the Free Software Foundation
2724 59 Temple Place - Suite 330
2725 Boston, MA 02111-1307 USA
2727 Permission is granted to make and distribute verbatim copies of this
2728 manual provided the copyright notice and this permission notice are
2729 preserved on all copies.
2731 Permission is granted to copy and distribute modified versions of
2732 this manual under the conditions for verbatim copying, provided also
2733 that the section entitled "GNU General Public License," is included
2734 exactly as in the original, and provided that the entire resulting
2735 derived work is distributed under the terms of a permission notice
2736 identical to this one.
2738 Permission is granted to copy and distribute translations of this
2739 manual into another language, under the above conditions for modified
2740 versions, except that the section entitled "GNU General Public License,"
2741 and this permission notice, may be included in translations approved by
2742 the Free Software Foundation instead of in the original English.
2744 GNU GENERAL PUBLIC LICENSE
2745 **************************
2747 Version 3, 29 June 2007
2749 Copyright (C) 2007 Free Software Foundation, Inc. `http://fsf.org/'
2751 Everyone is permitted to copy and distribute verbatim copies of this
2752 license document, but changing it is not allowed.
2757 The GNU General Public License is a free, copyleft license for software
2758 and other kinds of works.
2760 The licenses for most software and other practical works are designed
2761 to take away your freedom to share and change the works. By contrast,
2762 the GNU General Public License is intended to guarantee your freedom to
2763 share and change all versions of a program--to make sure it remains
2764 free software for all its users. We, the Free Software Foundation, use
2765 the GNU General Public License for most of our software; it applies
2766 also to any other work released this way by its authors. You can apply
2767 it to your programs, too.
2769 When we speak of free software, we are referring to freedom, not
2770 price. Our General Public Licenses are designed to make sure that you
2771 have the freedom to distribute copies of free software (and charge for
2772 them if you wish), that you receive source code or can get it if you
2773 want it, that you can change the software or use pieces of it in new
2774 free programs, and that you know you can do these things.
2776 To protect your rights, we need to prevent others from denying you
2777 these rights or asking you to surrender the rights. Therefore, you
2778 have certain responsibilities if you distribute copies of the software,
2779 or if you modify it: responsibilities to respect the freedom of others.
2781 For example, if you distribute copies of such a program, whether
2782 gratis or for a fee, you must pass on to the recipients the same
2783 freedoms that you received. You must make sure that they, too, receive
2784 or can get the source code. And you must show them these terms so they
2787 Developers that use the GNU GPL protect your rights with two steps:
2788 (1) assert copyright on the software, and (2) offer you this License
2789 giving you legal permission to copy, distribute and/or modify it.
2791 For the developers' and authors' protection, the GPL clearly explains
2792 that there is no warranty for this free software. For both users' and
2793 authors' sake, the GPL requires that modified versions be marked as
2794 changed, so that their problems will not be attributed erroneously to
2795 authors of previous versions.
2797 Some devices are designed to deny users access to install or run
2798 modified versions of the software inside them, although the
2799 manufacturer can do so. This is fundamentally incompatible with the
2800 aim of protecting users' freedom to change the software. The
2801 systematic pattern of such abuse occurs in the area of products for
2802 individuals to use, which is precisely where it is most unacceptable.
2803 Therefore, we have designed this version of the GPL to prohibit the
2804 practice for those products. If such problems arise substantially in
2805 other domains, we stand ready to extend this provision to those domains
2806 in future versions of the GPL, as needed to protect the freedom of
2809 Finally, every program is threatened constantly by software patents.
2810 States should not allow patents to restrict development and use of
2811 software on general-purpose computers, but in those that do, we wish to
2812 avoid the special danger that patents applied to a free program could
2813 make it effectively proprietary. To prevent this, the GPL assures that
2814 patents cannot be used to render the program non-free.
2816 The precise terms and conditions for copying, distribution and
2817 modification follow.
2819 TERMS AND CONDITIONS
2820 ====================
2824 "This License" refers to version 3 of the GNU General Public
2827 "Copyright" also means copyright-like laws that apply to other
2828 kinds of works, such as semiconductor masks.
2830 "The Program" refers to any copyrightable work licensed under this
2831 License. Each licensee is addressed as "you". "Licensees" and
2832 "recipients" may be individuals or organizations.
2834 To "modify" a work means to copy from or adapt all or part of the
2835 work in a fashion requiring copyright permission, other than the
2836 making of an exact copy. The resulting work is called a "modified
2837 version" of the earlier work or a work "based on" the earlier work.
2839 A "covered work" means either the unmodified Program or a work
2840 based on the Program.
2842 To "propagate" a work means to do anything with it that, without
2843 permission, would make you directly or secondarily liable for
2844 infringement under applicable copyright law, except executing it
2845 on a computer or modifying a private copy. Propagation includes
2846 copying, distribution (with or without modification), making
2847 available to the public, and in some countries other activities as
2850 To "convey" a work means any kind of propagation that enables other
2851 parties to make or receive copies. Mere interaction with a user
2852 through a computer network, with no transfer of a copy, is not
2855 An interactive user interface displays "Appropriate Legal Notices"
2856 to the extent that it includes a convenient and prominently visible
2857 feature that (1) displays an appropriate copyright notice, and (2)
2858 tells the user that there is no warranty for the work (except to
2859 the extent that warranties are provided), that licensees may
2860 convey the work under this License, and how to view a copy of this
2861 License. If the interface presents a list of user commands or
2862 options, such as a menu, a prominent item in the list meets this
2867 The "source code" for a work means the preferred form of the work
2868 for making modifications to it. "Object code" means any
2869 non-source form of a work.
2871 A "Standard Interface" means an interface that either is an
2872 official standard defined by a recognized standards body, or, in
2873 the case of interfaces specified for a particular programming
2874 language, one that is widely used among developers working in that
2877 The "System Libraries" of an executable work include anything,
2878 other than the work as a whole, that (a) is included in the normal
2879 form of packaging a Major Component, but which is not part of that
2880 Major Component, and (b) serves only to enable use of the work
2881 with that Major Component, or to implement a Standard Interface
2882 for which an implementation is available to the public in source
2883 code form. A "Major Component", in this context, means a major
2884 essential component (kernel, window system, and so on) of the
2885 specific operating system (if any) on which the executable work
2886 runs, or a compiler used to produce the work, or an object code
2887 interpreter used to run it.
2889 The "Corresponding Source" for a work in object code form means all
2890 the source code needed to generate, install, and (for an executable
2891 work) run the object code and to modify the work, including
2892 scripts to control those activities. However, it does not include
2893 the work's System Libraries, or general-purpose tools or generally
2894 available free programs which are used unmodified in performing
2895 those activities but which are not part of the work. For example,
2896 Corresponding Source includes interface definition files
2897 associated with source files for the work, and the source code for
2898 shared libraries and dynamically linked subprograms that the work
2899 is specifically designed to require, such as by intimate data
2900 communication or control flow between those subprograms and other
2903 The Corresponding Source need not include anything that users can
2904 regenerate automatically from other parts of the Corresponding
2907 The Corresponding Source for a work in source code form is that
2910 2. Basic Permissions.
2912 All rights granted under this License are granted for the term of
2913 copyright on the Program, and are irrevocable provided the stated
2914 conditions are met. This License explicitly affirms your unlimited
2915 permission to run the unmodified Program. The output from running
2916 a covered work is covered by this License only if the output,
2917 given its content, constitutes a covered work. This License
2918 acknowledges your rights of fair use or other equivalent, as
2919 provided by copyright law.
2921 You may make, run and propagate covered works that you do not
2922 convey, without conditions so long as your license otherwise
2923 remains in force. You may convey covered works to others for the
2924 sole purpose of having them make modifications exclusively for
2925 you, or provide you with facilities for running those works,
2926 provided that you comply with the terms of this License in
2927 conveying all material for which you do not control copyright.
2928 Those thus making or running the covered works for you must do so
2929 exclusively on your behalf, under your direction and control, on
2930 terms that prohibit them from making any copies of your
2931 copyrighted material outside their relationship with you.
2933 Conveying under any other circumstances is permitted solely under
2934 the conditions stated below. Sublicensing is not allowed; section
2935 10 makes it unnecessary.
2937 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
2939 No covered work shall be deemed part of an effective technological
2940 measure under any applicable law fulfilling obligations under
2941 article 11 of the WIPO copyright treaty adopted on 20 December
2942 1996, or similar laws prohibiting or restricting circumvention of
2945 When you convey a covered work, you waive any legal power to forbid
2946 circumvention of technological measures to the extent such
2947 circumvention is effected by exercising rights under this License
2948 with respect to the covered work, and you disclaim any intention
2949 to limit operation or modification of the work as a means of
2950 enforcing, against the work's users, your or third parties' legal
2951 rights to forbid circumvention of technological measures.
2953 4. Conveying Verbatim Copies.
2955 You may convey verbatim copies of the Program's source code as you
2956 receive it, in any medium, provided that you conspicuously and
2957 appropriately publish on each copy an appropriate copyright notice;
2958 keep intact all notices stating that this License and any
2959 non-permissive terms added in accord with section 7 apply to the
2960 code; keep intact all notices of the absence of any warranty; and
2961 give all recipients a copy of this License along with the Program.
2963 You may charge any price or no price for each copy that you convey,
2964 and you may offer support or warranty protection for a fee.
2966 5. Conveying Modified Source Versions.
2968 You may convey a work based on the Program, or the modifications to
2969 produce it from the Program, in the form of source code under the
2970 terms of section 4, provided that you also meet all of these
2973 a. The work must carry prominent notices stating that you
2974 modified it, and giving a relevant date.
2976 b. The work must carry prominent notices stating that it is
2977 released under this License and any conditions added under
2978 section 7. This requirement modifies the requirement in
2979 section 4 to "keep intact all notices".
2981 c. You must license the entire work, as a whole, under this
2982 License to anyone who comes into possession of a copy. This
2983 License will therefore apply, along with any applicable
2984 section 7 additional terms, to the whole of the work, and all
2985 its parts, regardless of how they are packaged. This License
2986 gives no permission to license the work in any other way, but
2987 it does not invalidate such permission if you have separately
2990 d. If the work has interactive user interfaces, each must display
2991 Appropriate Legal Notices; however, if the Program has
2992 interactive interfaces that do not display Appropriate Legal
2993 Notices, your work need not make them do so.
2995 A compilation of a covered work with other separate and independent
2996 works, which are not by their nature extensions of the covered
2997 work, and which are not combined with it such as to form a larger
2998 program, in or on a volume of a storage or distribution medium, is
2999 called an "aggregate" if the compilation and its resulting
3000 copyright are not used to limit the access or legal rights of the
3001 compilation's users beyond what the individual works permit.
3002 Inclusion of a covered work in an aggregate does not cause this
3003 License to apply to the other parts of the aggregate.
3005 6. Conveying Non-Source Forms.
3007 You may convey a covered work in object code form under the terms
3008 of sections 4 and 5, provided that you also convey the
3009 machine-readable Corresponding Source under the terms of this
3010 License, in one of these ways:
3012 a. Convey the object code in, or embodied in, a physical product
3013 (including a physical distribution medium), accompanied by the
3014 Corresponding Source fixed on a durable physical medium
3015 customarily used for software interchange.
3017 b. Convey the object code in, or embodied in, a physical product
3018 (including a physical distribution medium), accompanied by a
3019 written offer, valid for at least three years and valid for
3020 as long as you offer spare parts or customer support for that
3021 product model, to give anyone who possesses the object code
3022 either (1) a copy of the Corresponding Source for all the
3023 software in the product that is covered by this License, on a
3024 durable physical medium customarily used for software
3025 interchange, for a price no more than your reasonable cost of
3026 physically performing this conveying of source, or (2) access
3027 to copy the Corresponding Source from a network server at no
3030 c. Convey individual copies of the object code with a copy of
3031 the written offer to provide the Corresponding Source. This
3032 alternative is allowed only occasionally and noncommercially,
3033 and only if you received the object code with such an offer,
3034 in accord with subsection 6b.
3036 d. Convey the object code by offering access from a designated
3037 place (gratis or for a charge), and offer equivalent access
3038 to the Corresponding Source in the same way through the same
3039 place at no further charge. You need not require recipients
3040 to copy the Corresponding Source along with the object code.
3041 If the place to copy the object code is a network server, the
3042 Corresponding Source may be on a different server (operated
3043 by you or a third party) that supports equivalent copying
3044 facilities, provided you maintain clear directions next to
3045 the object code saying where to find the Corresponding Source.
3046 Regardless of what server hosts the Corresponding Source, you
3047 remain obligated to ensure that it is available for as long
3048 as needed to satisfy these requirements.
3050 e. Convey the object code using peer-to-peer transmission,
3051 provided you inform other peers where the object code and
3052 Corresponding Source of the work are being offered to the
3053 general public at no charge under subsection 6d.
3056 A separable portion of the object code, whose source code is
3057 excluded from the Corresponding Source as a System Library, need
3058 not be included in conveying the object code work.
3060 A "User Product" is either (1) a "consumer product", which means
3061 any tangible personal property which is normally used for personal,
3062 family, or household purposes, or (2) anything designed or sold for
3063 incorporation into a dwelling. In determining whether a product
3064 is a consumer product, doubtful cases shall be resolved in favor of
3065 coverage. For a particular product received by a particular user,
3066 "normally used" refers to a typical or common use of that class of
3067 product, regardless of the status of the particular user or of the
3068 way in which the particular user actually uses, or expects or is
3069 expected to use, the product. A product is a consumer product
3070 regardless of whether the product has substantial commercial,
3071 industrial or non-consumer uses, unless such uses represent the
3072 only significant mode of use of the product.
3074 "Installation Information" for a User Product means any methods,
3075 procedures, authorization keys, or other information required to
3076 install and execute modified versions of a covered work in that
3077 User Product from a modified version of its Corresponding Source.
3078 The information must suffice to ensure that the continued
3079 functioning of the modified object code is in no case prevented or
3080 interfered with solely because modification has been made.
3082 If you convey an object code work under this section in, or with,
3083 or specifically for use in, a User Product, and the conveying
3084 occurs as part of a transaction in which the right of possession
3085 and use of the User Product is transferred to the recipient in
3086 perpetuity or for a fixed term (regardless of how the transaction
3087 is characterized), the Corresponding Source conveyed under this
3088 section must be accompanied by the Installation Information. But
3089 this requirement does not apply if neither you nor any third party
3090 retains the ability to install modified object code on the User
3091 Product (for example, the work has been installed in ROM).
3093 The requirement to provide Installation Information does not
3094 include a requirement to continue to provide support service,
3095 warranty, or updates for a work that has been modified or
3096 installed by the recipient, or for the User Product in which it
3097 has been modified or installed. Access to a network may be denied
3098 when the modification itself materially and adversely affects the
3099 operation of the network or violates the rules and protocols for
3100 communication across the network.
3102 Corresponding Source conveyed, and Installation Information
3103 provided, in accord with this section must be in a format that is
3104 publicly documented (and with an implementation available to the
3105 public in source code form), and must require no special password
3106 or key for unpacking, reading or copying.
3108 7. Additional Terms.
3110 "Additional permissions" are terms that supplement the terms of
3111 this License by making exceptions from one or more of its
3112 conditions. Additional permissions that are applicable to the
3113 entire Program shall be treated as though they were included in
3114 this License, to the extent that they are valid under applicable
3115 law. If additional permissions apply only to part of the Program,
3116 that part may be used separately under those permissions, but the
3117 entire Program remains governed by this License without regard to
3118 the additional permissions.
3120 When you convey a copy of a covered work, you may at your option
3121 remove any additional permissions from that copy, or from any part
3122 of it. (Additional permissions may be written to require their own
3123 removal in certain cases when you modify the work.) You may place
3124 additional permissions on material, added by you to a covered work,
3125 for which you have or can give appropriate copyright permission.
3127 Notwithstanding any other provision of this License, for material
3128 you add to a covered work, you may (if authorized by the copyright
3129 holders of that material) supplement the terms of this License
3132 a. Disclaiming warranty or limiting liability differently from
3133 the terms of sections 15 and 16 of this License; or
3135 b. Requiring preservation of specified reasonable legal notices
3136 or author attributions in that material or in the Appropriate
3137 Legal Notices displayed by works containing it; or
3139 c. Prohibiting misrepresentation of the origin of that material,
3140 or requiring that modified versions of such material be
3141 marked in reasonable ways as different from the original
3144 d. Limiting the use for publicity purposes of names of licensors
3145 or authors of the material; or
3147 e. Declining to grant rights under trademark law for use of some
3148 trade names, trademarks, or service marks; or
3150 f. Requiring indemnification of licensors and authors of that
3151 material by anyone who conveys the material (or modified
3152 versions of it) with contractual assumptions of liability to
3153 the recipient, for any liability that these contractual
3154 assumptions directly impose on those licensors and authors.
3156 All other non-permissive additional terms are considered "further
3157 restrictions" within the meaning of section 10. If the Program as
3158 you received it, or any part of it, contains a notice stating that
3159 it is governed by this License along with a term that is a further
3160 restriction, you may remove that term. If a license document
3161 contains a further restriction but permits relicensing or
3162 conveying under this License, you may add to a covered work
3163 material governed by the terms of that license document, provided
3164 that the further restriction does not survive such relicensing or
3167 If you add terms to a covered work in accord with this section, you
3168 must place, in the relevant source files, a statement of the
3169 additional terms that apply to those files, or a notice indicating
3170 where to find the applicable terms.
3172 Additional terms, permissive or non-permissive, may be stated in
3173 the form of a separately written license, or stated as exceptions;
3174 the above requirements apply either way.
3178 You may not propagate or modify a covered work except as expressly
3179 provided under this License. Any attempt otherwise to propagate or
3180 modify it is void, and will automatically terminate your rights
3181 under this License (including any patent licenses granted under
3182 the third paragraph of section 11).
3184 However, if you cease all violation of this License, then your
3185 license from a particular copyright holder is reinstated (a)
3186 provisionally, unless and until the copyright holder explicitly
3187 and finally terminates your license, and (b) permanently, if the
3188 copyright holder fails to notify you of the violation by some
3189 reasonable means prior to 60 days after the cessation.
3191 Moreover, your license from a particular copyright holder is
3192 reinstated permanently if the copyright holder notifies you of the
3193 violation by some reasonable means, this is the first time you have
3194 received notice of violation of this License (for any work) from
3195 that copyright holder, and you cure the violation prior to 30 days
3196 after your receipt of the notice.
3198 Termination of your rights under this section does not terminate
3199 the licenses of parties who have received copies or rights from
3200 you under this License. If your rights have been terminated and
3201 not permanently reinstated, you do not qualify to receive new
3202 licenses for the same material under section 10.
3204 9. Acceptance Not Required for Having Copies.
3206 You are not required to accept this License in order to receive or
3207 run a copy of the Program. Ancillary propagation of a covered work
3208 occurring solely as a consequence of using peer-to-peer
3209 transmission to receive a copy likewise does not require
3210 acceptance. However, nothing other than this License grants you
3211 permission to propagate or modify any covered work. These actions
3212 infringe copyright if you do not accept this License. Therefore,
3213 by modifying or propagating a covered work, you indicate your
3214 acceptance of this License to do so.
3216 10. Automatic Licensing of Downstream Recipients.
3218 Each time you convey a covered work, the recipient automatically
3219 receives a license from the original licensors, to run, modify and
3220 propagate that work, subject to this License. You are not
3221 responsible for enforcing compliance by third parties with this
3224 An "entity transaction" is a transaction transferring control of an
3225 organization, or substantially all assets of one, or subdividing an
3226 organization, or merging organizations. If propagation of a
3227 covered work results from an entity transaction, each party to that
3228 transaction who receives a copy of the work also receives whatever
3229 licenses to the work the party's predecessor in interest had or
3230 could give under the previous paragraph, plus a right to
3231 possession of the Corresponding Source of the work from the
3232 predecessor in interest, if the predecessor has it or can get it
3233 with reasonable efforts.
3235 You may not impose any further restrictions on the exercise of the
3236 rights granted or affirmed under this License. For example, you
3237 may not impose a license fee, royalty, or other charge for
3238 exercise of rights granted under this License, and you may not
3239 initiate litigation (including a cross-claim or counterclaim in a
3240 lawsuit) alleging that any patent claim is infringed by making,
3241 using, selling, offering for sale, or importing the Program or any
3246 A "contributor" is a copyright holder who authorizes use under this
3247 License of the Program or a work on which the Program is based.
3248 The work thus licensed is called the contributor's "contributor
3251 A contributor's "essential patent claims" are all patent claims
3252 owned or controlled by the contributor, whether already acquired or
3253 hereafter acquired, that would be infringed by some manner,
3254 permitted by this License, of making, using, or selling its
3255 contributor version, but do not include claims that would be
3256 infringed only as a consequence of further modification of the
3257 contributor version. For purposes of this definition, "control"
3258 includes the right to grant patent sublicenses in a manner
3259 consistent with the requirements of this License.
3261 Each contributor grants you a non-exclusive, worldwide,
3262 royalty-free patent license under the contributor's essential
3263 patent claims, to make, use, sell, offer for sale, import and
3264 otherwise run, modify and propagate the contents of its
3265 contributor version.
3267 In the following three paragraphs, a "patent license" is any
3268 express agreement or commitment, however denominated, not to
3269 enforce a patent (such as an express permission to practice a
3270 patent or covenant not to sue for patent infringement). To
3271 "grant" such a patent license to a party means to make such an
3272 agreement or commitment not to enforce a patent against the party.
3274 If you convey a covered work, knowingly relying on a patent
3275 license, and the Corresponding Source of the work is not available
3276 for anyone to copy, free of charge and under the terms of this
3277 License, through a publicly available network server or other
3278 readily accessible means, then you must either (1) cause the
3279 Corresponding Source to be so available, or (2) arrange to deprive
3280 yourself of the benefit of the patent license for this particular
3281 work, or (3) arrange, in a manner consistent with the requirements
3282 of this License, to extend the patent license to downstream
3283 recipients. "Knowingly relying" means you have actual knowledge
3284 that, but for the patent license, your conveying the covered work
3285 in a country, or your recipient's use of the covered work in a
3286 country, would infringe one or more identifiable patents in that
3287 country that you have reason to believe are valid.
3289 If, pursuant to or in connection with a single transaction or
3290 arrangement, you convey, or propagate by procuring conveyance of, a
3291 covered work, and grant a patent license to some of the parties
3292 receiving the covered work authorizing them to use, propagate,
3293 modify or convey a specific copy of the covered work, then the
3294 patent license you grant is automatically extended to all
3295 recipients of the covered work and works based on it.
3297 A patent license is "discriminatory" if it does not include within
3298 the scope of its coverage, prohibits the exercise of, or is
3299 conditioned on the non-exercise of one or more of the rights that
3300 are specifically granted under this License. You may not convey a
3301 covered work if you are a party to an arrangement with a third
3302 party that is in the business of distributing software, under
3303 which you make payment to the third party based on the extent of
3304 your activity of conveying the work, and under which the third
3305 party grants, to any of the parties who would receive the covered
3306 work from you, a discriminatory patent license (a) in connection
3307 with copies of the covered work conveyed by you (or copies made
3308 from those copies), or (b) primarily for and in connection with
3309 specific products or compilations that contain the covered work,
3310 unless you entered into that arrangement, or that patent license
3311 was granted, prior to 28 March 2007.
3313 Nothing in this License shall be construed as excluding or limiting
3314 any implied license or other defenses to infringement that may
3315 otherwise be available to you under applicable patent law.
3317 12. No Surrender of Others' Freedom.
3319 If conditions are imposed on you (whether by court order,
3320 agreement or otherwise) that contradict the conditions of this
3321 License, they do not excuse you from the conditions of this
3322 License. If you cannot convey a covered work so as to satisfy
3323 simultaneously your obligations under this License and any other
3324 pertinent obligations, then as a consequence you may not convey it
3325 at all. For example, if you agree to terms that obligate you to
3326 collect a royalty for further conveying from those to whom you
3327 convey the Program, the only way you could satisfy both those
3328 terms and this License would be to refrain entirely from conveying
3331 13. Use with the GNU Affero General Public License.
3333 Notwithstanding any other provision of this License, you have
3334 permission to link or combine any covered work with a work licensed
3335 under version 3 of the GNU Affero General Public License into a
3336 single combined work, and to convey the resulting work. The terms
3337 of this License will continue to apply to the part which is the
3338 covered work, but the special requirements of the GNU Affero
3339 General Public License, section 13, concerning interaction through
3340 a network will apply to the combination as such.
3342 14. Revised Versions of this License.
3344 The Free Software Foundation may publish revised and/or new
3345 versions of the GNU General Public License from time to time.
3346 Such new versions will be similar in spirit to the present
3347 version, but may differ in detail to address new problems or
3350 Each version is given a distinguishing version number. If the
3351 Program specifies that a certain numbered version of the GNU
3352 General Public License "or any later version" applies to it, you
3353 have the option of following the terms and conditions either of
3354 that numbered version or of any later version published by the
3355 Free Software Foundation. If the Program does not specify a
3356 version number of the GNU General Public License, you may choose
3357 any version ever published by the Free Software Foundation.
3359 If the Program specifies that a proxy can decide which future
3360 versions of the GNU General Public License can be used, that
3361 proxy's public statement of acceptance of a version permanently
3362 authorizes you to choose that version for the Program.
3364 Later license versions may give you additional or different
3365 permissions. However, no additional obligations are imposed on any
3366 author or copyright holder as a result of your choosing to follow a
3369 15. Disclaimer of Warranty.
3371 THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
3372 APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE
3373 COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS"
3374 WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED,
3375 INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
3376 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE
3377 RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.
3378 SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL
3379 NECESSARY SERVICING, REPAIR OR CORRECTION.
3381 16. Limitation of Liability.
3383 IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
3384 WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES
3385 AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU
3386 FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR
3387 CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE
3388 THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA
3389 BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
3390 PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
3391 PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF
3392 THE POSSIBILITY OF SUCH DAMAGES.
3394 17. Interpretation of Sections 15 and 16.
3396 If the disclaimer of warranty and limitation of liability provided
3397 above cannot be given local legal effect according to their terms,
3398 reviewing courts shall apply local law that most closely
3399 approximates an absolute waiver of all civil liability in
3400 connection with the Program, unless a warranty or assumption of
3401 liability accompanies a copy of the Program in return for a fee.
3404 END OF TERMS AND CONDITIONS
3405 ===========================
3407 How to Apply These Terms to Your New Programs
3408 =============================================
3410 If you develop a new program, and you want it to be of the greatest
3411 possible use to the public, the best way to achieve this is to make it
3412 free software which everyone can redistribute and change under these
3415 To do so, attach the following notices to the program. It is safest
3416 to attach them to the start of each source file to most effectively
3417 state the exclusion of warranty; and each file should have at least the
3418 "copyright" line and a pointer to where the full notice is found.
3420 ONE LINE TO GIVE THE PROGRAM'S NAME AND A BRIEF IDEA OF WHAT IT DOES.
3421 Copyright (C) YEAR NAME OF AUTHOR
3423 This program is free software: you can redistribute it and/or modify
3424 it under the terms of the GNU General Public License as published by
3425 the Free Software Foundation, either version 3 of the License, or (at
3426 your option) any later version.
3428 This program is distributed in the hope that it will be useful, but
3429 WITHOUT ANY WARRANTY; without even the implied warranty of
3430 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
3431 General Public License for more details.
3433 You should have received a copy of the GNU General Public License
3434 along with this program. If not, see `http://www.gnu.org/licenses/'.
3436 Also add information on how to contact you by electronic and paper
3439 If the program does terminal interaction, make it output a short
3440 notice like this when it starts in an interactive mode:
3442 PROGRAM Copyright (C) YEAR NAME OF AUTHOR
3443 This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
3444 This is free software, and you are welcome to redistribute it
3445 under certain conditions; type `show c' for details.
3447 The hypothetical commands `show w' and `show c' should show the
3448 appropriate parts of the General Public License. Of course, your
3449 program's commands might be different; for a GUI interface, you would
3452 You should also get your employer (if you work as a programmer) or
3453 school, if any, to sign a "copyright disclaimer" for the program, if
3454 necessary. For more information on this, and how to apply and follow
3455 the GNU GPL, see `http://www.gnu.org/licenses/'.
3457 The GNU General Public License does not permit incorporating your
3458 program into proprietary programs. If your program is a subroutine
3459 library, you may consider it more useful to permit linking proprietary
3460 applications with the library. If this is what you want to do, use the
3461 GNU Lesser General Public License instead of this License. But first,
3462 please read `http://www.gnu.org/philosophy/why-not-lgpl.html'.
3467 -animateSpeed, option: See 3.5. (line 1805)
3468 .cmailaliases: See 10.1. (line 2495)
3469 .cmailgames: See 10.1. (line 2490)
3470 .icsrc: See 3.3. (line 1317)
3471 <, Button: See 2.4. (line 467)
3472 <<, Button: See 2.4. (line 500)
3473 >, Button: See 2.4. (line 487)
3474 >>, Button: See 2.4. (line 519)
3475 abort, ICS command: See 4. (line 2096)
3476 Abort, Menu Item: See 2.3. (line 439)
3477 About XBoard, Menu Item: See 2.6. (line 841)
3478 accept, ICS command: See 4. (line 2083)
3479 Accept, Menu Item: See 2.3. (line 414)
3480 Action, Menu: See 2.3. (line 413)
3481 adjourn, ICS command: See 4. (line 2096)
3482 Adjourn, Menu Item: See 2.3. (line 435)
3483 Adjudicate Draw, Menu Item: See 2.3. (line 458)
3484 Adjudicate to Black, Menu Item: See 2.3. (line 458)
3485 Adjudicate to White, Menu Item: See 2.3. (line 458)
3486 adjudicateDrawMoves, option: See 3.6. (line 1820)
3487 adjudicateLossThreshold, option: See 3.6. (line 1812)
3488 Adjudications, Menu Item: See 2.5. (line 559)
3489 alarm, option: See 3.3. (line 1360)
3490 Always Queen, Menu Item: See 2.5. (line 605)
3491 alwaysPromoteToQueen, option: See 3.5. (line 1601)
3492 Analysis Mode, Menu Item: See 2.2. (line 238)
3493 Analyze File, Menu Item: See 2.2. (line 259)
3494 Animate Dragging, Menu Item: See 2.5. (line 611)
3495 Animate Moving, Menu Item: See 2.5. (line 618)
3496 animate, option: See 3.5. (line 1801)
3497 animateDragging, option: See 3.5. (line 1797)
3498 animateMoving, option: See 3.5. (line 1801)
3499 Authors: See 9. (line 2349)
3500 Auto Comment, Menu Item: See 2.5. (line 626)
3501 Auto Flag, Menu Item: See 2.5. (line 634)
3502 Auto Flip View, Menu Item: See 2.5. (line 643)
3503 Auto Observe, Menu Item: See 2.5. (line 648)
3504 Auto Raise Board, Menu Item: See 2.5. (line 661)
3505 Auto Save, Menu Item: See 2.5. (line 666)
3506 autobs, option: See 3.3. (line 1344)
3507 autoCallFlag, option: See 3.3. (line 1340)
3508 autocomm, option: See 3.3. (line 1336)
3509 autoComment, option: See 3.3. (line 1336)
3510 autoflag, option: See 3.3. (line 1340)
3511 autoflip, option: See 3.5. (line 1647)
3512 autoFlipView, option: See 3.5. (line 1647)
3513 autoKibitz, option: See 3.3. (line 1348)
3514 autoObserve, option: See 3.3. (line 1344)
3515 autoraise, option: See 3.5. (line 1643)
3516 autoRaiseBoard, option: See 3.5. (line 1643)
3517 autosave, option: See 3.4. (line 1525)
3518 autoSaveGames, option: See 3.4. (line 1525)
3519 Back to Start, Menu Item: See 2.4. (line 500)
3520 Backward, Menu Item: See 2.4. (line 467)
3521 bell, option: See 3.5. (line 1588)
3522 bitmapDirectory, option: See 3.5. (line 1728)
3523 blackPieceColor, option: See 3.5. (line 1775)
3524 blind, option: See 3.5. (line 1695)
3525 Blindfold, Menu Item: See 2.5. (line 673)
3526 blindfold, option: See 3.5. (line 1695)
3527 bm, option: See 3.5. (line 1728)
3528 board size: See 3.5. (line 1609)
3529 boardHeight, option: See 3.7. (line 1933)
3530 boardSize, option: See 3.5. (line 1609)
3531 boardWidth, option: See 3.7. (line 1938)
3532 Book, Menu Item: See 2.6. (line 831)
3533 Bug reports: See 8. (line 2315)
3534 Bugs <1>: See 8. (line 2315)
3535 Bugs: See 7. (line 2255)
3536 buttons, option: See 3.5. (line 1669)
3537 Call Flag, Menu Item: See 2.3. (line 424)
3538 checkMates, option: See 3.6. (line 1825)
3539 Chess engine options: See 3.1. (line 918)
3540 CHESSDIR: See 6. (line 2246)
3541 clock, option: See 3.1. (line 935)
3542 clockFont, option: See 3.5. (line 1699)
3543 clockMode, option: See 3.1. (line 935)
3544 cmail: See 10. (line 2400)
3545 colorChallenge, option: See 3.3. (line 1393)
3546 colorChannel, option: See 3.3. (line 1393)
3547 colorChannel1, option: See 3.3. (line 1393)
3548 colorize, option: See 3.3. (line 1379)
3549 colorKibitz, option: See 3.3. (line 1393)
3550 colorNormal, option: See 3.3. (line 1393)
3551 colorRequest, option: See 3.3. (line 1393)
3552 Colors <1>: See 3.5. (line 1775)
3553 Colors: See 3.3. (line 1379)
3554 colorSeek, option: See 3.3. (line 1393)
3555 colorShout, option: See 3.3. (line 1393)
3556 colorSShout, option: See 3.3. (line 1393)
3557 colorTell, option: See 3.3. (line 1393)
3558 Contributors: See 9. (line 2349)
3559 coordFont, option: See 3.5. (line 1705)
3560 coords, option: See 3.5. (line 1639)
3561 Copy Game, Menu Item: See 2.1. (line 166)
3562 Copy Position, Menu Item: See 2.1. (line 206)
3563 darkSquareColor, option: See 3.5. (line 1775)
3564 debug, option: See 3.7. (line 1984)
3565 debugFile, option: See 3.7. (line 1987)
3566 debugMode, option: See 3.7. (line 1984)
3567 decline, ICS command: See 4. (line 2083)
3568 Decline, Menu Item: See 2.3. (line 419)
3569 defaultCacheSizeEGTB, option: See 3.2. (line 1198)
3570 defaultFrcPosition, option: See 3.7. (line 1953)
3571 defaultHashSize, option: See 3.2. (line 1192)
3572 defaultPathEGTB, option: See 3.2. (line 1204)
3573 delayAfterQuit, option: See 3.7. (line 2019)
3574 delayBeforeQuit, option: See 3.7. (line 2019)
3575 display, option: See 3.5. (line 1579)
3576 drag, option: See 3.5. (line 1797)
3577 draw, ICS command: See 4. (line 2096)
3578 Draw, Menu Item: See 2.3. (line 430)
3579 Edit Comment, Menu Item: See 2.2. (line 375)
3580 Edit Game, Menu Item: See 2.2. (line 293)
3581 Edit Position, Menu Item: See 2.2. (line 309)
3582 Edit Tags, Menu Item: See 2.2. (line 351)
3583 egtFormats, option: See 3.2. (line 1208)
3584 Engine Settings: See 3.2. (line 1159)
3585 engineDebugOutput, option: See 3.7. (line 1991)
3586 Environment variables: See 6. (line 2246)
3587 examine, ICS command: See 4. (line 2119)
3588 Exit, Menu Item: See 2.1. (line 223)
3589 exit, option: See 3.5. (line 1593)
3590 fb, option: See 3.1. (line 1042)
3591 fcp, option: See 3.1. (line 1035)
3592 fd, option: See 3.1. (line 1057)
3593 fh, option: See 3.1. (line 1049)
3594 File Menu: See 2.1. (line 82)
3595 finger, ICS command: See 4. (line 2106)
3596 firstChessProgram, option: See 3.1. (line 1035)
3597 firstComputerString, option: See 3.1. (line 1093)
3598 firstDirectory, option: See 3.1. (line 1057)
3599 firstHasOwnBookUCI, option: See 3.2. (line 1187)
3600 firstHost, option: See 3.1. (line 1049)
3601 firstIsUCI, option: See 3.2. (line 1161)
3602 firstNeedsNoncompliantFEN, option: See 3.1. (line 1143)
3603 firstNPS, option: See 3.1. (line 958)
3604 firstOptions, option: See 3.1. (line 1132)
3605 firstPlaysBlack, option: See 3.1. (line 1042)
3606 firstProtocolVersion, option: See 3.1. (line 1110)
3607 firstScoreAbs, option: See 3.1. (line 1118)
3608 firstTimeOdds, option: See 3.1. (line 976)
3609 firstXBook, option: See 3.2. (line 1187)
3610 Flash Moves, Menu Item: See 2.5. (line 679)
3611 flash, option: See 3.5. (line 1682)
3612 flashCount, option: See 3.5. (line 1682)
3613 flashRate, option: See 3.5. (line 1682)
3614 Flip View, Menu Item: See 2.5. (line 554)
3615 flip, option: See 3.5. (line 1651)
3616 flipView, option: See 3.5. (line 1651)
3617 fNoOwnBookUCI, option: See 3.2. (line 1187)
3618 Font: See 3.5. (line 1712)
3619 Font, clock: See 3.5. (line 1699)
3620 Font, coordinates: See 3.5. (line 1705)
3621 font, option: See 3.5. (line 1712)
3622 fontSizeTolerance, option: See 3.5. (line 1718)
3623 Forward to End, Menu Item: See 2.4. (line 519)
3624 Forward, Menu Item: See 2.4. (line 487)
3625 fUCI, option: See 3.2. (line 1161)
3626 gameListTags, option: See 3.4. (line 1567)
3627 games, ICS command: See 4. (line 2072)
3628 gateway, option: See 3.3. (line 1267)
3629 geometry, option: See 3.5. (line 1579)
3630 Get Move List, Menu Item: See 2.5. (line 693)
3631 getMoveList, option: See 3.3. (line 1356)
3632 Help Menu: See 2.6. (line 813)
3633 help, ICS command: See 4. (line 2057)
3634 Hide Thinking, Menu Item: See 2.5. (line 790)
3635 Highlight Last Move, Menu Item: See 2.5. (line 705)
3636 highlight, option: See 3.5. (line 1691)
3637 highlightLastMove, option: See 3.5. (line 1691)
3638 highlightSquareColor, option: See 3.5. (line 1775)
3639 Hint, Menu Item: See 2.6. (line 828)
3640 holdingsSize, option: See 3.7. (line 1945)
3641 iconic, option: See 3.5. (line 1579)
3642 ICS: See 4. (line 2028)
3643 ICS Alarm, Menu Item: See 2.5. (line 726)
3644 ICS Client, Menu Item: See 2.2. (line 269)
3645 ICS Input Box, Menu Item: See 2.2. (line 380)
3646 ICS options: See 3.3. (line 1222)
3647 ICS, addresses: See 4. (line 2028)
3648 ics, option: See 3.3. (line 1223)
3649 icsAlarm, option: See 3.3. (line 1360)
3650 icsAlarmTime, option: See 3.3. (line 1364)
3651 icscomm, option: See 3.3. (line 1275)
3652 icshelper, option: See 3.3. (line 1241)
3653 icshost, option: See 3.3. (line 1228)
3654 icsinput, option: See 3.3. (line 1332)
3655 icslogon, option: See 3.3. (line 1317)
3656 icsport, option: See 3.3. (line 1237)
3657 inc, option: See 3.1. (line 928)
3658 Info XBoard, Menu Item: See 2.6. (line 814)
3659 initalMode, option: See 3.7. (line 1877)
3660 initString, option: See 3.1. (line 1066)
3661 Internet Chess Server: See 4. (line 2028)
3662 internetChessServerCommPort, option: See 3.3. (line 1275)
3663 internetChessServerHelper, option: See 3.3. (line 1241)
3664 internetChessServerHost, option: See 3.3. (line 1228)
3665 internetChessServerInputBox, option: See 3.3. (line 1332)
3666 internetChessServerLogonScript, option: See 3.3. (line 1317)
3667 internetChessServerMode, option: See 3.3. (line 1223)
3668 internetChessServerPort, option: See 3.3. (line 1237)
3670 See ``Introduction''. (line 9)
3671 Keys: See 2.7. (line 846)
3672 legal, option: See 3.5. (line 1605)
3673 lgf, option: See 3.4. (line 1489)
3674 lgi, option: See 3.4. (line 1489)
3675 lightSquareColor, option: See 3.5. (line 1775)
3676 Limitations: See 7. (line 2255)
3677 Load and Save options: See 3.4. (line 1487)
3678 Load Game, Menu Item: See 2.1. (line 114)
3679 Load Next Game, Menu Item: See 2.1. (line 141)
3680 Load Next Position, Menu Item: See 2.1. (line 187)
3681 Load Position, Menu Item: See 2.1. (line 179)
3682 Load Previous Game, Menu Item: See 2.1. (line 145)
3683 Load Previous Position, Menu Item: See 2.1. (line 190)
3684 loadGameFile, option: See 3.4. (line 1489)
3685 loadGameIndex, option: See 3.4. (line 1489)
3686 loadPositionFile, option: See 3.4. (line 1530)
3687 loadPositionIndex, option: See 3.4. (line 1530)
3688 lowTimeWarning, option: See 3.3. (line 1368)
3689 lowTimeWarningColor, option: See 3.5. (line 1775)
3690 lpf, option: See 3.4. (line 1530)
3691 lpi, option: See 3.4. (line 1530)
3692 Machine Black, Menu Item: See 2.2. (line 232)
3693 Machine White, Menu Item: See 2.2. (line 229)
3694 Mail Move, Menu Item: See 2.1. (line 220)
3695 Major modes: See 1. (line 19)
3696 Man XBoard, Menu Item: See 2.6. (line 821)
3697 matchGames, option: See 3.1. (line 1013)
3698 matchMode, option: See 3.1. (line 1025)
3699 materialDraws, option: See 3.6. (line 1837)
3700 Menu, Action: See 2.3. (line 413)
3701 Menu, File: See 2.1. (line 82)
3702 Menu, Help: See 2.6. (line 813)
3703 Menu, Mode: See 2.2. (line 228)
3704 Menu, Options: See 2.5. (line 553)
3705 Menu, Step: See 2.4. (line 466)
3706 Menus: See 2. (line 57)
3707 mg, option: See 3.1. (line 1013)
3708 mm, option: See 3.1. (line 1025)
3709 Mode Menu: See 2.2. (line 228)
3710 mode, option: See 3.7. (line 1877)
3711 mono, option: See 3.5. (line 1675)
3712 monoMode, option: See 3.5. (line 1675)
3713 Move Now, Menu Item: See 2.4. (line 540)
3714 Move Sound, Menu Item: See 2.5. (line 711)
3715 moves, option: See 3.3. (line 1356)
3716 movesound, option: See 3.5. (line 1588)
3717 movesPerSession, option: See 3.1. (line 924)
3718 mps, option: See 3.1. (line 924)
3719 msLoginDelay, option: See 3.3. (line 1326)
3720 nameOfDebugFile, option: See 3.7. (line 1987)
3721 ncp, option: See 3.7. (line 1872)
3722 New Game, Menu Item: See 2.1. (line 83)
3723 New Shuffle Game, Menu Item: See 2.1. (line 92)
3724 New variant, Menu Item: See 2.1. (line 105)
3725 niceEngines, option: See 3.1. (line 1124)
3726 noChessProgram, option: See 3.7. (line 1872)
3727 noGUI, option: See 3.5. (line 1582)
3728 observe, ICS command: See 4. (line 2115)
3729 Old Save Style, Menu Item: See 2.5. (line 735)
3730 oldmoves, ICS command: See 4. (line 2119)
3731 oldsave, option: See 3.4. (line 1563)
3732 oldSaveStyle, option: See 3.4. (line 1563)
3733 Options: See 3. (line 892)
3734 Options Menu: See 2.5. (line 553)
3735 Options, adjudication: See 3.6. (line 1811)
3736 options, Chess engine: See 3.1. (line 918)
3737 Options, ICS: See 3.3. (line 1222)
3738 Options, Load and Save: See 3.4. (line 1487)
3739 Options, miscellaneous: See 3.7. (line 1871)
3740 Options, User interface: See 3.5. (line 1576)
3741 Other programs: See 11. (line 2608)
3742 Paste Game, Menu Item: See 2.1. (line 175)
3743 Paste Position, Menu Item: See 2.1. (line 215)
3744 Pause, Menu Item: See 2.2. (line 387)
3745 Periodic Updates, Menu Item: See 2.5. (line 743)
3746 pgnEventHeader, option`: See 3.4. (line 1555)
3747 pgnExtendedInfo, option`: See 3.4. (line 1550)
3748 pieceToSquareTable, option: See 3.7. (line 1958)
3749 pixmap, option: See 3.5. (line 1728)
3750 pixmapDirectory, option: See 3.5. (line 1728)
3751 PolyglotBook, option: See 3.2. (line 1176)
3752 PolyglotDir, option: See 3.2. (line 1168)
3753 Ponder Next Move, Menu Item: See 2.5. (line 749)
3754 ponder, option: See 3.1. (line 1004)
3755 ponderNextMove, option: See 3.1. (line 1004)
3756 Popup Exit Message, Menu Item: See 2.5. (line 754)
3757 Popup Move Errors, Menu Item: See 2.5. (line 760)
3758 popup, option: See 3.5. (line 1597)
3759 popupExitMessage, option: See 3.5. (line 1593)
3760 popupMoveErrors, option: See 3.5. (line 1597)
3761 pre, option: See 3.3. (line 1372)
3762 Premove, Menu Item: See 2.5. (line 769)
3763 premove, option: See 3.3. (line 1372)
3764 Problems: See 8. (line 2315)
3765 queen, option: See 3.5. (line 1601)
3766 Quiet Play, Menu Item: See 2.5. (line 780)
3767 quiet, option: See 3.3. (line 1375)
3768 quietPlay, option: See 3.3. (line 1375)
3769 Reload CMail Message, Menu Item: See 2.1. (line 220)
3770 Reload Same Game, Menu Item: See 2.1. (line 150)
3771 Reload Same Position, Menu Item: See 2.1. (line 194)
3772 remoteShell, option: See 3.7. (line 2005)
3773 remoteUser, option: See 3.7. (line 2010)
3774 Reporting bugs: See 8. (line 2315)
3775 Reporting problems: See 8. (line 2315)
3776 Resign, Menu Item: See 2.3. (line 444)
3777 Retract Move, Menu Item: See 2.4. (line 544)
3778 reuse, option: See 3.1. (line 1101)
3779 reuse2, option: See 3.1. (line 1101)
3780 reuseFirst, option: See 3.1. (line 1101)
3781 reuseSecond, option: See 3.1. (line 1101)
3782 Revert, Menu Item: See 2.4. (line 531)
3783 ringBellAfterMoves, option: See 3.5. (line 1588)
3784 rsh, option: See 3.7. (line 2005)
3785 ruleMoves, option: See 3.6. (line 1855)
3786 ruser, option: See 3.7. (line 2010)
3787 sameColorGames, option: See 3.1. (line 1029)
3788 Save Game, Menu Item: See 2.1. (line 154)
3789 saveGameFile, option: See 3.4. (line 1520)
3790 saveOutOfBookInfo, option`: See 3.4. (line 1559)
3791 savePositionFile, option: See 3.4. (line 1545)
3792 scp, option: See 3.1. (line 1038)
3793 sd, option: See 3.1. (line 949)
3794 searchDepth, option: See 3.1. (line 949)
3795 searchTime, option: See 3.1. (line 942)
3796 secondChessProgram, option: See 3.1. (line 1038)
3797 secondComputerString, option: See 3.1. (line 1093)
3798 secondDirectory, option: See 3.1. (line 1057)
3799 secondHasOwnBookUCI, option: See 3.2. (line 1187)
3800 secondHost, option: See 3.1. (line 1049)
3801 secondInitString, option: See 3.1. (line 1066)
3802 secondIsUCI, option: See 3.2. (line 1161)
3803 secondNeedsNoncompliantFEN, option: See 3.1. (line 1143)
3804 secondNPS, option: See 3.1. (line 958)
3805 secondOptions, option: See 3.1. (line 1132)
3806 secondProtocolVersion, option: See 3.1. (line 1110)
3807 secondScoreAbs, option: See 3.1. (line 1118)
3808 secondTimeOdds, option: See 3.1. (line 976)
3809 secondXBook, option: See 3.2. (line 1187)
3810 set, ICS command: See 4. (line 2112)
3811 Settings, Engine: See 3.2. (line 1159)
3812 sgf, option: See 3.4. (line 1520)
3813 sh, option: See 3.1. (line 1049)
3814 Shortcut keys: See 2.7. (line 846)
3815 Show Coords, Menu Item: See 2.5. (line 786)
3816 Show Engine Output, Menu Item: See 2.2. (line 347)
3817 Show Game List, Menu Item: See 2.2. (line 338)
3818 Show Move History, Menu Item: See 2.2. (line 342)
3819 showButtonBar, option: See 3.5. (line 1669)
3820 showCoords, option: See 3.5. (line 1639)
3821 showThinking, option: See 3.1. (line 994)
3822 size, option: See 3.5. (line 1609)
3823 sNoOwnBookUCI, option: See 3.2. (line 1187)
3824 soundChallenge, option: See 3.3. (line 1438)
3825 soundChannel, option: See 3.3. (line 1438)
3826 soundIcsAlarm, option: See 3.3. (line 1446)
3827 soundIcsDraw, option: See 3.3. (line 1457)
3828 soundIcsLoss, option: See 3.3. (line 1453)
3829 soundIcsUnfinished, option: See 3.3. (line 1461)
3830 soundIcsWin, option: See 3.3. (line 1449)
3831 soundKibitz, option: See 3.3. (line 1438)
3832 soundMove, option: See 3.3. (line 1443)
3833 soundProgram, option: See 3.3. (line 1422)
3834 soundRequest, option: See 3.3. (line 1438)
3835 Sounds: See 3.3. (line 1422)
3836 soundSeek, option: See 3.3. (line 1438)
3837 soundShout, option: See 3.3. (line 1438)
3838 soundSShout, option: See 3.3. (line 1438)
3839 soundTell, option: See 3.3. (line 1438)
3840 spf, option: See 3.4. (line 1545)
3841 st, option: See 3.1. (line 942)
3842 Step Menu: See 2.4. (line 466)
3843 Stop Examining, Menu Item: See 2.3. (line 452)
3844 Stop Observing, Menu Item: See 2.3. (line 448)
3845 sUCI, option: See 3.2. (line 1161)
3846 tc, option: See 3.1. (line 919)
3847 td, option: See 3.4. (line 1515)
3848 telnet, option: See 3.3. (line 1249)
3849 telnetProgram, option: See 3.3. (line 1258)
3850 Test Legality, Menu Item: See 2.5. (line 799)
3851 testClaims, option: See 3.6. (line 1831)
3852 testLegality, option: See 3.5. (line 1605)
3853 thinking, option: See 3.1. (line 994)
3854 Time Control, Menu Item: See 2.5. (line 596)
3855 timeControl, option: See 3.1. (line 919)
3856 timeDelay, option: See 3.4. (line 1515)
3857 timeIncrement, option: See 3.1. (line 928)
3858 timeOddsMode, option: See 3.1. (line 982)
3859 title, option: See 3.5. (line 1661)
3860 titleInWindow, option: See 3.5. (line 1661)
3861 Training, Menu Item: See 2.2. (line 328)
3862 trivialDraws, option: See 3.6. (line 1844)
3863 Truncate Game, Menu Item: See 2.4. (line 535)
3864 Two Machines, Menu Item: See 2.2. (line 235)
3865 usePolyglotBook, option: See 3.2. (line 1173)
3866 User interface options: See 3.5. (line 1576)
3867 userName, option: See 3.7. (line 2014)
3868 useTelnet, option: See 3.3. (line 1249)
3869 variant, option: See 3.7. (line 1885)
3870 vars, ICS command: See 4. (line 2109)
3871 whitePieceColor, option: See 3.5. (line 1775)
3872 who, ICS command: See 4. (line 2065)
3873 xflash, option: See 3.5. (line 1682)
3879 2 Menus, buttons, and keys
3886 2.7 Other Shortcut Keys
3888 3.1 Chess Engine Options
3889 3.2 UCI + WB Engine Settings
3891 3.4 Load and Save options
3892 3.5 User interface options
3893 3.6 Adjudication Options
3897 6 Environment variables
3898 7 Limitations and known bugs
3899 8 Reporting problems
3900 9 Authors and contributors
3903 10.2 Starting a CMail Game
3904 10.3 Answering a Move
3905 10.4 Multi-Game Messages
3906 10.5 Completing a Game
3907 10.6 Known CMail Problems
3908 11 Other programs you can use with XBoard
3915 GNU GENERAL PUBLIC LICENSE