Move "hide thinking" option into alphabetical order.
[xboard.git] / xboard.texi
1 \input texinfo  @c -*-texinfo-*-
2 @c %**start of header
3 @setfilename
4 @settitle XBoard
5 @c %**end of header
7 @include version.texi
9 @ifinfo
10 @format
13 * xboard: (xboard).         An X Window System graphical chessboard.
15 @end format
16 @end ifinfo
18 @titlepage
19 @title XBoard
21 @page
22 @vskip 0pt plus 1filll
23 @include copyright.texi
25 @end titlepage
26 @ifset man
27 .TH xboard 6 "$Date: " "GNU"
29 .PP
30 xboard @- X graphical user interface for chess
32 .PP
33 .B xboard [options]
34 .br
35 .B xboard -ics -icshost hostname [options]
36 .br
37 .B xboard -ncp [options]
38 .br
39 .B |pxboard
40 .br
41 .B cmail [options]
42 @end ifset
44 @node Top
45 @top Introduction
46 @cindex introduction
48 @ifset man
50 @end ifset
52 XBoard is a graphical chessboard that can serve as a
53 user interface to chess engines (such as GNU Chess), the
54 Internet Chess Servers,
55 electronic mail correspondence chess, or your own collection of saved games.
57 This manual documents version @value{VERSION} of XBoard.
59 @menu
60 * Major modes::     The main things XBoard can do.
61 * Basic operation:: Mouse and keyboard functions.
62 * Menus::           Menus, buttons, and keys.
63 * Options::         Command options supported by XBoard.
64 * Chess Servers::   Using XBoard with an Internet Chess Server (ICS).
65 * Firewalls::       Connecting to a chess server through a firewall.
66 * Environment::     Environment variables.
67 * Limitations::     Known limitations and/or bugs.
68 * Problems::        How and where to report any problems you run into.
69 * Contributors::    People who have helped developing XBoard.
70 * CMail::           Using XBoard for electronic correspondence chess.
71 * Other programs::  Other programs you can use with XBoard.
72 @ifnottex
73 * Copyright::       Copyright notice for this manual.
74 @end ifnottex
75 * Copying::         The GNU General Public License.
77 * Index::           Index of concepts and symbol names.
78 @end menu
80 @node Major modes
81 @chapter Major modes
82 @cindex Major modes
84 XBoard always runs in one of four major modes.  You select the
85 major mode from the command line when you start up XBoard.
87 @table @asis
88 @item xboard [options]
89 As an interface to GNU Chess or another chess engine running on your
90 machine, XBoard lets you play a game against the machine,
91 set up arbitrary positions, force variations, watch a game between two
92 chess engines, interactively analyze your stored games or set up and
93 analyze arbitrary positions.  (Note: Not all chess engines support
94 analysis.)
95 @item xboard -ics -icshost hostname [options]
96 As Internet Chess Server (ICS) interface, XBoard
97 lets you play against other ICS users, observe games
98 they are playing, or review games that have recently finished.  Most
99 of the ICS "wild" chess variants are supported, including bughouse.
100 @item xboard -ncp [options]
101 XBoard can also be used simply
102 as an electronic chessboard to play through games. It will read and
103 write game files and allow you to play through variations
104 manually. You can use it to browse games off the net or review games
105 you have saved.  These features are also available in the other modes.
106 @item |pxboard
107 If you want to pipe games into XBoard, use the supplied shell
108 script @file{pxboard}.  For example, from the news reader @file{xrn},
109 find a message with one or more games in it, click the Save button,
110 and type @samp{|pxboard} as the file name.
111 @item cmail [options]
112 As an interface to electronic mail correspondence chess, XBoard
113 works with the cmail program. See @ref{CMail} below for
114 instructions.
115 @end table
117 @node Basic operation
118 @chapter Basic operation
119 @cindex Basic operation
121 To move a piece, you can drag it with the left mouse button, or you
122 can click the left mouse button once on the piece, then once more on
123 the destination square. In crazyhouse, bughouse or shogi you can
124 drag and drop pieces to the board from the holdings squares 
125 displayed next to the board.
126 Old behavior, where right-clicking a square brings up a menu
127 where you can select what piece to drop on it can still be 
128 selected through a command-line option.
129 But only in Edit Position mode right clicking a square is still used to
130 put a piece on it, and the piece to drop is selected by sweeping
131 the mouse vertically with the button held down.
133 The default function of the right mouse button in other modes is 
134 to display the position the chess program thinks it will end up in.
135 While moving the mouse vertically with this button pressed 
136 XBoard will step through the principal variation to show how 
137 this position will be reached.
138 Lines of play displayed in the engine-output window,
139 or PGN variations in the comment window can similarly
140 be played out on the board, by right-clicking on them.
142 When connected to an ICS, it is possible to call up a graphical
143 representation of players seeking a game in stead of the chess board,
144 when the latter is not in use
145 (i.e. when you are not playing or observing).
146 Left-clicking the display area will switch between this 'seek graph'
147 and the chess board.
148 Hovering the mouse pointer over a dot will show the details of the
149 seek ad in the message field above the board.
150 Left-clicking the dot will challenge that player.
151 Right-clicking a dot will 'push it to the back',
152 to reveal any dots that were hidden behind it.
153 Right-clicking off dots will refresh the graph.
155 Most other XBoard commands are available from the menu bar. The most
156 frequently used commands also have shortcut keys or on-screen buttons.
157 These shortcut keystrokes are mostly non-printable characters.
158 Typing a letter or digit while the board window has focus
159 will bring up a type-in box with the typed letter already in it.
160 You can use that to type a move in siuations where it is your
161 turn to enter a move,
162 type a move number to call up the position after that move
163 in the display,
164 or, in Edit Position mode, type a FEN.
165 Some rarely used parameters can only be set through options on the
166 command line used to invoke XBoard.
168 XBoard uses a settings file, in which it can remember any changes to
169 the settings that are made through menus or command-line options,
170 so they will still apply when you restart XBoard for another session.
171 The settings can be saved into this file automatically when XBoard exits,
172 or on explicit request of the user.
173 The default name for the settings file is /etc/xboard/xboard.conf,
174 but in a standard install this file is only used as a master settings
175 file that determines the system-wide default settings,
176 and defers reading and writing of user settings to a user-specific
177 file like ~/.xboardrc in the user's home directory.
179 When XBoard is iconized, its graphical icon is a white knight if
180 it is White's turn to move, a black knight if it is Black's turn.  See
181 Iconize in @ref{Keys} below if you have problems getting this
182 feature to work.
184 @node Menus
185 @chapter Menus, buttons, and keys
186 @cindex Menus
188 @menu
189 * File Menu::       Accessing external games and positions.
190 * Edit Menu::       Altering games, positions, PGN tags or comments.
191 * View Menu::       Controlling XBoard's shape and looks.
192 * Mode Menu::       Selecting XBoard's mode.
193 * Action Menu::     Talking to the chess engine or ICS opponents.
194 * Engine Menu::     Controlling settings and actions of the engine(s).
195 * Options Menu::    User preferences.
196 * Help Menu::       Getting help.
197 * Keys::            Other shortcut keys.
198 @end menu
200 @node File Menu
201 @section File Menu
202 @cindex File Menu
203 @cindex Menu, File
204 @table @asis
205 @item New Game
206 @cindex New Game, Menu Item
207 Resets XBoard and the chess engine to the beginning of a new chess
208 game. The @kbd{Ctrl-N} key is a keyboard equivalent. In Internet Chess
209 Server mode, clears the current state of XBoard, then
210 resynchronizes with the ICS by sending a refresh command. If you want to
211 stop playing, observing, or examining an ICS game, use an
212 appropriate command from the Action menu, not @samp{New Game}.
213 @xref{Action Menu}.
214 @item New Shuffle Game
215 @cindex New Shuffle Game, Menu Item
216 Similar to @samp{New Game}, but allows you to specify a particular initial position 
217 (according to a standardized numbering system)
218 in chess variants which use randomized opening positions (e.g. Chess960).
219 The selected opening position will persistently be chosen on any following
220 New Game command until you use this menu to select another. Selecting
221 position number -1 will produce a newly randomized position on any new game.
222 Using this menu item in variants that normally do not shuffle their opening position
223 does cause these variants to become shuffle variants until you use the
224 @samp{New Shuffle Game} menu to explicitly switch the randomization off,
225 or select a new variant.
226 @item New Variant
227 @cindex New variant, Menu Item
228 Allows you to select a new chess variant in non-ICS mode. 
229 (In ICS play, the ICS is responsible for deciding which variant will be played,
230 and XBoard adapts automatically.)  The shifted @kbd{Alt+V} key is a 
231 keyboard equivalent. If you play with an engine, the engine must
232 be able to play the selected variant, or the command will be ignored.
233 XBoard supports all major variants, such as xiangqi, shogi, chess, chess960,
234 Capablanca Chess, shatranj, crazyhouse, bughouse.
235 But not every board size has built-in bitmaps for un-orthodox pieces!
236 Only sizes bulky (72) and middling (49) have all pieces,
237 while size petite (33) has most.
238 These sizes would have to be set at startup through the @code{size}
239 command-line option when you start up XBoard for such variants to be playable.
241 You can overrule the default board format of the selected variant,
242 (e.g. to play suicide chess on a 6 x 6 board),
243 in this dialog, but normally you would not do that, 
244 and leave them at '-1', which means 'default'.
245 @item Load Game
246 @cindex Load Game, Menu Item
247 Plays a game from a record file. The @kbd{Ctrl-O} key is a keyboard equivalent.
248 A pop-up dialog prompts you for the file name. If the file contains more
249 than one game, a second pop-up dialog
250 displays a list of games (with information drawn from their PGN tags, if
251 any), and you can select the one you want. Alternatively, you can load the
252 Nth game in the file directly, by typing the number @kbd{N} after the
253 file name, separated by a space.
255 The game file parser will accept PGN (portable game notation),
256 or in fact almost any file that contains moves in algebraic
257 notation. 
258 Notation of the form @samp{P@@f7}
259 is accepted for piece-drops in bughouse games;
260 this is a nonstandard extension to PGN.
261 If the file includes a PGN position (FEN tag), or an old-style
262 XBoard position diagram bracketed by @samp{[--} and @samp{--]}
263 before the first move, the game starts from that position. Text
264 enclosed in parentheses, square brackets, or curly braces is assumed to
265 be commentary and is displayed in a pop-up window. Any other
266 text in the file is ignored. PGN variations (enclosed in
267 parentheses) also are treated as comments;
268 however, if you rights-click them in the comment window,
269 XBoard will shelve the current line, and load the the selected variation,
270 so you can step through it.
271 You can later revert to the previous line with the @samp{Revert} command.
272 This way you can walk quite complex varation trees with XBoard.
273 The nonstandard PGN tag [Variant "varname"] functions similarly to
274 the -variant command-line option (see below), allowing games in certain chess
275 variants to be loaded.  
276 Note that it must appear before any FEN tag for XBoard to recognize
277 variant FENs appropriately.
278 There is also a heuristic to 
279 recognize chess variants from the Event tag, by looking for the strings
280 that the Internet Chess Servers put there when saving variant ("wild") games.
281 @item Load Position
282 @cindex Load Position, Menu Item
283 Sets up a position from a position file.  A pop-up dialog prompts
284 you for the file name.  The shifted @kbd{Ctrl-O} key is a keyboard 
285 equivalent. If the file contains more than one saved
286 position, and you want to load the Nth one, type the number N
287 after the file name, separated by a space. Position files must
288 be in FEN (Forsythe-Edwards notation), or in the format that the
289 Save Position command writes when oldSaveStyle is turned on.
290 @item Load Next Position
291 @cindex Load Next Position, Menu Item
292 Loads the next position from the last position file you loaded.
293 The shifted @kbd{PgDn} key is a keyboard equivalent.
294 @item Load Previous Position
295 @cindex Load Previous Position, Menu Item
296 Loads the previous position from the last position file you
297 loaded. The shifted @kbd{PgUp} key is a keyboard equivalent.
298 Not available if the last position was loaded from a pipe.
299 @item Save Game
300 @cindex Save Game, Menu Item
301 Appends a record of the current game to a file.
302 The @kbd{Ctrl-S} key is a keyboard equivalent.
303 A pop-up dialog
304 prompts you for the file name. If the game did not begin with
305 the standard starting position, the game file includes the
306 starting position used. Games are saved in the PGN (portable
307 game notation) format, unless the oldSaveStyle option is true,
308 in which case they are saved in an older format that is specific
309 to XBoard. Both formats are human-readable, and both can be
310 read back by the @samp{Load Game} command.
311 Notation of the form @samp{P@@f7}
312 is accepted for piece-drops in bughouse games;
313 this is a nonstandard extension to PGN.
314 @item Save Position
315 @cindex Save Position, Menu Item
316 Appends a diagram of the current position to a file.
317 The shifted @kbd{Ctrl+S} key is a keyboard equivalent. 
318 A pop-up dialog prompts you for the file name. Positions are saved in
319 FEN (Forsythe-Edwards notation) format unless the @code{oldSaveStyle}
320 option is true, in which case they are saved in an older,
321 human-readable format that is specific to XBoard. Both formats
322 can be read back by the @samp{Load Position} command.
323 @item Mail Move
324 @itemx Reload CMail Message
325 @cindex Mail Move, Menu Item
326 @cindex Reload CMail Message, Menu Item
327 See @ref{CMail}.
328 @item Exit
329 @cindex Exit, Menu Item
330 Exits from XBoard. The @kbd{Ctrl-Q} key is a keyboard equivalent.
331 @end table
333 @node Edit Menu
334 @section Edit Menu
335 @cindex Menu, Edit
336 @cindex Edit Menu
337 @table @asis
338 @item Copy Game
339 @cindex Copy Game, Menu Item
340 Copies a record of the current game to an internal clipboard in PGN
341 format and sets the X selection to the game text. The @kbd{Ctrl-C} 
342 key is a keyboard equivalent. The game can be
343 pasted to another application (such as a text editor or another copy
344 of XBoard) using that application's paste command.  In many X
345 applications, such as xterm and emacs, the middle mouse button can be
346 used for pasting; in XBoard, you must use the Paste Game command.
347 @item Copy Position
348 @cindex Copy Position, Menu Item
349 Copies the current position to an internal clipboard in FEN format and
350 sets the X selection to the position text. The shifted @kbd{Ctrl-C} key 
351 is a keyboard equivalent.  The position can be pasted
352 to another application (such as a text editor or another copy of
353 XBoard) using that application's paste command.  In many X
354 applications, such as xterm and emacs, the middle mouse button can be
355 used for pasting; in XBoard, you must use the Paste Position command.
356 @item Copy Game List
357 @cindex Copy Game List, Menu Item
358 Copies the current game list to the clipboard,
359 and sets the X selection to this text.
360 A format of comma-separated double-quoted strings is used,
361 including all tags,
362 so it can be easily imported into spread-sheet programs.
363 @item Paste Game
364 @cindex Paste Game, Menu Item
365 Interprets the current X selection as a game record and loads it, as
366 with Load Game. The @kbd{Ctrl-V} key is a keyboard equivalent.
367 @item Paste Position
368 @cindex Paste Position, Menu Item
369 Interprets the current X selection as a FEN position and loads it, as
370 with Load Position. The shifted @kbd{Ctrl-V} key is a keyboard equivalent.
371 @item Edit Game
372 @cindex Edit Game, Menu Item
373 Allows you to make moves for both Black and White, and to change
374 moves after backing up with the @samp{Backward} command. The clocks do
375 not run. The @kbd{Ctrl-E} key is a keyboard equivalent.
377 In chess engine mode, the chess engine continues to check moves for legality
378 but does not participate in the game. You can bring the chess engine
379 into the game by selecting @samp{Machine White}, @samp{Machine Black},
380 or @samp{Two Machines}.
382 In ICS mode, the moves are not sent to the ICS: @samp{Edit Game} takes
383 XBoard out of ICS Client mode and lets you edit games locally.
384 If you want to edit games on ICS in a way that other ICS users
385 can see, use the ICS @kbd{examine} command or start an ICS match
386 against yourself.
387 @item Edit Position
388 @cindex Edit Position, Menu Item
389 Lets you set up an arbitrary board position.
390 The shifted @kbd{Ctrl-E} key is a keyboard equivalent.
391 Use mouse button 1 to drag pieces to new squares, or to delete a piece
392 by dragging it off the board or dragging an empty square on top of it.
393 To drop a new piece on a square, press mouse button 2 or 3 over the
394 square.
395 This puts a white or black pawn in the square, respectively,
396 but you can change that to any other piece type by dragging the
397 mouse down before you release the button.
398 You will then see the piece on the originally clicked square
399 cycle through the available pieces
400 (including those of opposite color),
401 and can release the button when you see the piece you want.
402 To alter the side to move, you can click the clock 
403 (the words White and Black above the board)
404 of the side you want to give the move to.
405 To clear the board you can click the clock of the side that
406 alread has the move (which is highlighted in black).
407 The old behavior with a piece menu can still be configured
408 with the aid of the @code{pieceMenu} option.
409 Selecting @samp{Edit Position} causes XBoard to discard
410 all remembered moves in the current game.
412 In ICS mode, changes made to the position by @samp{Edit Position} are
413 not sent to the ICS: @samp{Edit Position} takes XBoard out of
414 @samp{ICS Client} mode and lets you edit positions locally. If you want to
415 edit positions on ICS in a way that other ICS users can see, use
416 the ICS @kbd{examine} command, or start an ICS match against yourself.
417 (See also the ICS Client topic above.)
418 @item Edit Tags
419 @cindex Edit Tags, Menu Item
420 Lets you edit the PGN (portable game notation)
421 tags for the current game. After editing, the tags must still conform to
422 the PGN tag syntax:
424 @example
425 <tag-section> ::= <tag-pair> <tag-section>
426                         <empty>
427 <tag-pair> ::= [ <tag-name> <tag-value> ]
428 <tag-name> ::= <identifier>
429 <tag-value> ::= <string>
430 @end example
431 @noindent
432 See the PGN Standard for full details. Here is an example:
434 @example
435 [Event "Portoroz Interzonal"]
436 [Site "Portoroz, Yugoslavia"]
437 [Date "1958.08.16"]
438 [Round "8"]
439 [White "Robert J. Fischer"]
440 [Black "Bent Larsen"]
441 [Result "1-0"]
442 @end example
443 @noindent
444 Any characters that do not match this syntax are silently ignored. Note that
445 the PGN standard requires all games to have at least the seven tags shown
446 above. Any that you omit will be filled in by XBoard
447 with @samp{?} (unknown value), or @samp{-} (inapplicable value).
448 @item Edit Comment
449 @cindex Edit Comment, Menu Item
450 Adds or modifies a comment on the current position. Comments are
451 saved by @samp{Save Game} and are displayed by @samp{Load Game},
452 @samp{Forward}, and @samp{Backward}.
453 @item Revert
454 @itemx Annotate
455 @cindex Revert, Menu Item
456 @cindex Annotate, Menu Item
457 If you are examining an ICS game and Pause mode is off,
458 Revert issues the ICS command @samp{revert}.
459 In local mode, when you were editing or analyzing a game, 
460 and the @code{-variations} command-line option is switched on,
461 you can start a new variation by holding the Shift key down while
462 entering a move not at the end of the game.
463 Variations can also become the currently displayed line by
464 clicking a PGN variation displayed in the Comment window.
465 This can be applied recursively, 
466 so that you can analyze variations on variations; 
467 each time you create a new variation by entering an alternative move
468 with Shift pressed, or select a new one from the Comment window,
469 the current variation will be shelved. 
470 @samp{Revert} allows you to return to the most recently shelved variation.
471 The difference between @samp{Revert} and @samp{Annotate}
472 is that with the latter,
473 the variation you are now abandoning will be added as a comment 
474 (in PGN variation syntax, i.e. between parentheses)
475 to the original move where you deviated, for later recalling.
476 The @kbd{Home} key is a keyboard equivalent to @samp{Revert}.
477 @item Truncate Game
478 @cindex Truncate Game, Menu Item
479 Discards all remembered moves of the game beyond the current
480 position. Puts XBoard into @samp{Edit Game} mode if it was not there
481 already.
482 The @kbd{End} key is a keyboard equivalent.
483 @item Backward
484 @cindex Backward, Menu Item
485 @cindex <, Button
486 Steps backward through a series of remembered moves.
487 The @samp{[<]} button and the @kbd{Alt+LeftArrow} key are equivalents,
488 as is turning the mouse wheel towards you.
489 In addition, pressing the Control key steps back one move, and releasing
490 it steps forward again.
492 In most modes, @samp{Backward} only lets you look back at old positions;
493 it does not retract moves. This is the case if you are playing against
494 a chess engine, playing or observing a game on an ICS, or loading a game.
495 If you select @samp{Backward} in any of these situations, you will not
496 be allowed to make a different move. Use @samp{Retract Move} or
497 @samp{Edit Game} if you want to change past moves.
499 If you are examining an ICS game, the behavior of @samp{Backward}
500 depends on whether XBoard is in Pause mode. If Pause mode is
501 off, @samp{Backward} issues the ICS backward command, which backs up
502 everyone's view of the game and allows you to make a different
503 move. If Pause mode is on, @samp{Backward} only backs up your local
504 view.
505 @item Forward
506 @cindex Forward, Menu Item
507 @cindex >, Button
508 Steps forward through a series of remembered moves (undoing the
509 effect of @samp{Backward}) or forward through a game file. The
510 @samp{[>]} button and the @kbd{Alt+RightArrow} key are equivalents,
511 as is turning the mouse wheel away from you.
513 If you are examining an ICS game, the behavior of Forward
514 depends on whether XBoard is in Pause mode. If Pause mode is
515 off, @samp{Forward} issues the ICS forward command, which moves
516 everyone's view of the game forward along the current line. If
517 Pause mode is on, @samp{Forward} only moves your local view forward,
518 and it will not go past the position that the game was in when
519 you paused.
520 @item Back to Start
521 @cindex Back to Start, Menu Item
522 @cindex <<, Button
523 Jumps backward to the first remembered position in the game.
524 The @samp{[<<]} button and the @kbd{Alt+Home} key are equivalents.
526 In most modes, Back to Start only lets you look back at old
527 positions; it does not retract moves. This is the case if you
528 are playing against a local chess engine, playing or observing a game on
529 a chess server, or loading a game. If you select @samp{Back to Start} in any
530 of these situations, you will not be allowed to make different
531 moves. Use @samp{Retract Move} or @samp{Edit Game} if you want to change past
532 moves; or use Reset to start a new game.
534 If you are examining an ICS game, the behavior of @samp{Back to
535 Start} depends on whether XBoard is in Pause mode. If Pause mode
536 is off, @samp{Back to Start} issues the ICS @samp{backward 999999}
537 command, which backs up everyone's view of the game to the start and
538 allows you to make different moves. If Pause mode is on, @samp{Back
539 to Start} only backs up your local view.
540 @item Forward to End
541 @cindex Forward to End, Menu Item
542 @cindex >>, Button
543 Jumps forward to the last remembered position in the game. The
544 @samp{[>>]} button and the @kbd{Alt+End} key are equivalents.
546 If you are examining an ICS game, the behavior of @samp{Forward to
547 End} depends on whether XBoard is in Pause mode. If Pause mode
548 is off, @samp{Forward to End} issues the ICS @samp{forward 999999}
549 command, which moves everyone's view of the game forward to the end of
550 the current line. If Pause mode is on, @samp{Forward to End} only moves
551 your local view forward, and it will not go past the position
552 that the game was in when you paused.
553 @end table
555 @node View Menu
556 @section View Menu
557 @cindex Menu, View
558 @cindex View Menu
559 @table @asis
560 @item Flip View
561 @cindex Flip View, Menu Item
562 Inverts your view of the chess board for the duration of the
563 current game. Starting a new game returns the board to normal.
564 The @kbd{F2} key is a keyboard equivalent.
565 @item Show Engine Output
566 @cindex Show Engine Output, Menu Item
567 Shows or hides a window in which the thinking output of any loaded engines
568 is displayed. The shifted @kbd{Alt+O} key is a keyboard equivalent.
569 XBoard will display lines of thinking output of the same depth ordered by score, 
570 (highest score on top), rather than in the order the engine produced them. 
571 Usually this amounts to the same, as a normal engine search will only find new PV 
572 (and emit it as thinking output) 
573 when it searches a move with a higher score than the previous variation. 
574 But when the engine is in multi-variation mode this needs not always be true, 
575 and it is more convenient for someone analyzing games to see the moves sorted by score. 
576 The order in which the engine found them is only of interest to the engine author, 
577 and can still be deduced from the time or node count printed with the line.
578 @item Show Move History
579 @cindex Show Move History, Menu Item
580 Shows or hides a list of moves of the current game.
581 The shifted @kbd{Alt+H} key is a keyboard equivalent.
582 This list allows you to move the display to any earlier position in the game
583 by clicking on the corresponding move.
584 @item Show Evaluation Graph
585 @cindex Show Evaluation Graph, Menu Item
586 Shows or hides a window which displays a graph of how the engine score(s)
587 evolved as a function of the move number. 
588 The shifted @kbd{Alt+E} key is a keyboard equivalent.
589 Clicking on the graph will bring
590 the corresponding position in the board display.
591 @item Show Game List
592 @cindex Show Game List, Menu Item
593 Shows or hides the list of games generated by the last @samp{Load Game}
594 command. The shifted @kbd{Alt+G} key is a keyboard equivalent.
595 @item Tags
596 @cindex Tags, Menu Item
597 Pops up a window which shows the PGN (portable game notation)
598 tags for the current game. 
599 For now this is a duplicate of the @samp{Edit Tags} item in the @samp{Edit} menu.
600 @item Comments
601 @cindex Comments, Menu Item
602 Pops up a window which shows any comments to or variations on the current move.
603 For now this is a duplicate of the @samp{Edit Comment} item in the @samp{Edit} menu.
604 @item ICS Input Box
605 @cindex ICS Input Box, Menu Item
606 If this option is set in ICS mode,
607 XBoard
608 creates an extra window that you can use for typing in ICS commands.
609 The input box is especially useful if you want to type in something long or do
610 some editing on your input, because output from ICS doesn't get mixed
611 in with your typing as it would in the main terminal window.
612 @item Board
613 @cindex Board, Menu Item
614 Summons a dialog where you can customaize the look of the chess board.
615 Here you can specify the directory from which piece images should be taken,
616 when you don't want to use the built-in piece images
617 (see @code{pixmapDirectory} and @code{bitmapDirectory} options),
618 an external pixmap to be used for the board squares
619 (@code{liteBackTextureFile} and @code{darkBackTextureFile} options),
620 and square and piece colors for the built-ins.
621 @item Game List Tags
622 @cindex Game List Tags, Menu Item
623 a duplicate of the Game List dialog in the Options menu.
624 @end table
626 @node Mode Menu
627 @section Mode Menu
628 @cindex Menu, Mode
629 @cindex Mode Menu
630 @table @asis
631 @item Machine White
632 @cindex Machine White, Menu Item
633 Tells the chess engine to play White. 
634 The @kbd{Ctrl-W} key is a keyboard equivalent.
635 @item Machine Black
636 @cindex Machine Black, Menu Item
637 Tells the chess engine to play Black.
638 The @kbd{Ctrl-B} key is a keyboard equivalent.
639 @item Two Machines
640 @cindex Two Machines, Menu Item
641 Plays a game between two chess engines.
642 The @kbd{Ctrl-T} key is a keyboard equivalent.
643 @item Analysis Mode
644 @cindex Analysis Mode, Menu Item
645 XBoard tells the chess engine to start analyzing the current game/position
646 and shows you the analysis as you move pieces around.
647 The @kbd{Ctrl-A} key is a keyboard equivalent.
648 Note: Some chess engines do not support Analysis mode.
650 To set up a position to analyze, you do the following:
652 1. Select Edit Position from the Mode Menu
654 2. Set up the position.  Use the middle and right buttons to
655 bring up the white and black piece menus.
657 3. When you are finished, click on either the Black or White
658 clock to tell XBoard which side moves first.
660 4. Select Analysis Mode from the Mode Menu to start the analysis.
662 The analysis function can also be used when observing games on an ICS
663 with an engine loaded (zippy mode); the engine then will analyse
664 the positions as they occur in the observed game.
665 @item Analyze File
666 @cindex Analyze File, Menu Item
667 This option lets you load a game from a file (PGN, XBoard format, etc.)
668 and analyze it. The @kbd{Ctrl-F} key is a keyboard equivalent.
669 When you select this menu item, a pop-up window appears
670 and asks for a file name to load.
671 If the file contains multiple games, another pop up appears that lets
672 you select which game you wish to analyze.
673 After a game is loaded, XBoard will start auto-playing the game,
674 while the engine is analyzing the current position.
675 The game will be annotated with the results of these analyses.
676 In particlar, the score and depth will be added as a comment,
677 and the PV will be added as a variation.
678 The time the engine spends on analyzing each move can be controlled
679 through the command-line option @samp{-timeDelay}.
680 Note: Some chess engines do not support Analysis mode.
681 @item Edit Game
682 Duplicate of the item in the Edit menu.
683 Note that @samp{Edit Game} is the idle mode of XBoard, and can be used
684 to get you out of other modes. E.g. to stop analyzing, stop a game
685 between two engines or stop editing a position.
686 @item Edit Position
687 Duplicate of the item in the Edit menu.
688 @item Training
689 @cindex Training, Menu Item
690 Training mode lets you interactively guess the moves of a game for one
691 of the players. You guess the next move of the game by playing the
692 move on the board. If the move played matches the next move of the
693 game, the move is accepted and the opponent's response is auto-played.
694 If the move played is incorrect, an error message is displayed.  You
695 can select this mode only while loading a game (that is, after
696 selecting @samp{Load Game} from the File menu).  While XBoard is in 
697 @samp{Training} mode, the navigation buttons are disabled.
698 @item ICS Client
699 @cindex ICS Client, Menu Item
700 This is the normal mode when XBoard
701 is connected to a chess server.  If you have moved into
702 Edit Game or Edit Position mode, you can select this option to get out.
704 To use xboard in ICS mode, run it in the foreground with the -ics
705 option, and use the terminal you started it from to type commands and
706 receive text responses from the chess server.  See
707 @ref{Chess Servers} below for more information.
709 XBoard activates some special position/game editing features when you
710 use the @kbd{examine} or @kbd{bsetup} commands on ICS and you have
711 @samp{ICS Client} selected on the Mode menu.  First, you can issue the
712 ICS position-editing commands with the mouse.  Move pieces by dragging
713 with mouse button 1.  To drop a new piece on a square, press mouse
714 button 2 or 3 over the square.  This brings up a menu of white pieces
715 (button 2) or black pieces (button 3).  Additional menu choices let
716 you empty the square or clear the board.  Click on the White or Black
717 clock to set the side to play.  You cannot set the side to play or
718 drag pieces to arbitrary squares while examining on ICC, but you can
719 do so in @kbd{bsetup} mode on FICS.  In addition, the menu commands
720 @samp{Forward}, @samp{Backward}, @samp{Pause}, and @samp{Stop Examining}
721 have special functions in this mode; see below.
722 @item Machine Match
723 @cindex Machine match, Menu Item
724 Starts a match between two chess programs,
725 with a number of games and other parameters set through
726 the @samp{Match Options} menu dialog.
727 @item Pause
728 @cindex Pause, Menu Item
729 Pauses updates to the board, and if you are playing against a chess engine,
730 also pauses your clock. To continue, select @samp{Pause} again, and the
731 display will automatically update to the latest position.
732 The @samp{P} button and keyboard @kbd{Pause} key are equivalents.
734 If you select Pause when you are playing against a chess engine and
735 it is not your move, the chess engine's clock
736 will continue to run and it will eventually make a move, at which point
737 both clocks will stop. Since board updates are paused, however,
738 you will not see the move until you exit from Pause mode (or select Forward).
739 This behavior is meant to simulate adjournment with a sealed move.
741 If you select Pause while you are observing or examining a game on a
742 chess server, you can step backward and forward in the current history
743 of the examined game without affecting the other observers and
744 examiners, and without having your display jump forward to the latest
745 position each time a move is made. Select Pause again to reconnect
746 yourself to the current state of the game on ICS.
748 If you select @samp{Pause} while you are loading a game, the game stops
749 loading. You can load more moves manually by selecting @samp{Forward}, or
750 resume automatic loading by selecting @samp{Pause} again.
751 @end table
753 @node Action Menu
754 @section Action Menu
755 @cindex Menu, Action
756 @cindex Action, Menu
757 @table @asis
758 @item Accept
759 @cindex Accept, Menu Item
760 Accepts a pending match offer. 
761 The @kbd{F3} key is a keyboard equivalent.
762 If there is more than one offer
763 pending, you will have to type in a more specific command
764 instead of using this menu choice.
765 @item Decline
766 @cindex Decline, Menu Item
767 Declines a pending offer (match, draw, adjourn, etc.).
768 The @kbd{F4} key is a keyboard equivalent. If there
769 is more than one offer pending, you will have to type in a more
770 specific command instead of using this menu choice.
771 @item Call Flag
772 @cindex Call Flag, Menu Item
773 Calls your opponent's flag, claiming a win on time, or claiming
774 a draw if you are both out of time. 
775 The @kbd{F5} key is a keyboard equivalent.
776 You can also call your
777 opponent's flag by clicking on his clock.
778 @item Draw
779 @cindex Draw, Menu Item
780 Offers a draw to your opponent, accepts a pending draw offer
781 from your opponent, or claims a draw by repetition or the 50-move
782 rule, as appropriate. The @kbd{F6} key is a keyboard equivalent.
783 @item Adjourn
784 @cindex Adjourn, Menu Item
785 Asks your opponent to agree to adjourning the current game, or
786 agrees to a pending adjournment offer from your opponent.
787 The @kbd{F7} key is a keyboard equivalent.
788 @item Abort
789 @cindex Abort, Menu Item
790 Asks your opponent to agree to aborting the current game, or
791 agrees to a pending abort offer from your opponent.
792 The @kbd{F8} key is a keyboard equivalent. An aborted
793 game ends immediately without affecting either player's rating.
794 @item Resign
795 @cindex Resign, Menu Item
796 Resigns the game to your opponent. The @kbd{F9} key is a
797 keyboard equivalent.
798 @item Stop Observing
799 @cindex Stop Observing, Menu Item
800 Ends your participation in observing a game, by issuing the ICS
801 observe command with no arguments. ICS mode only.
802 The @kbd{F10} key is a keyboard equivalent.
803 @item Stop Examining
804 @cindex Stop Examining, Menu Item
805 Ends your participation in examining a game, by issuing the ICS
806 unexamine command. ICS mode only.
807 The @kbd{F11} key is a keyboard equivalent.
808 @item Upload to Examine
809 @cindex Upload to Examine, Menu Item
810 Create an examined game of the proper variant on the ICS,
811 and send the game there that is currenty loaded in XBoard
812 (e.g. through pasting or loading from file).
813 You must be connected to an ICS for this to work.
814 @item Adjudicate to White
815 @itemx Adjudicate to Black
816 @itemx Adjudicate Draw
817 @cindex Adjudicate to White, Menu Item
818 @cindex Adjudicate to Black, Menu Item
819 @cindex Adjudicate Draw, Menu Item
820 Terminate an ongoing game in Two-Machines mode (including match mode),
821 with as result a win for white, for black, or a draw, respectively.
822 The PGN file of the game will accompany the result string
823 by the comment "user adjudication".
824 @end table
826 @node Engine Menu
827 @section Engine Menu
828 @cindex Engine Menu
829 @cindex Menu, Engine
830 @table @asis
831 @item Engine #N Settings
832 @cindex Engine Settings, Menu Item
833 @cindex Engine #1 Settings, Menu Item
834 @cindex Engine #2 Settings, Menu Item
835 Pop up a menu dialog to alter the settings specific to the applicable engine.
836 (The second engine is only accessible once it has been used in Two-Machines mode.)
837 For each parameter the engine allows to be set,
838 a control element will appear in this dialog that can be used to alter the value.
839 Depending on the type of parameter (text string, number, multiple choice,
840 on/off switch, instantaneous signal) the appropriate control will appear,
841 with a description next to it.
842 XBoard has no idea what these values mean; it just passes them on to the engine.
843 How this dialog looks is completely determined by the engine,
844 and XBoard just passes it on to the user.
845 Many engines do not have any parameters that can be set by the user,
846 and in that case the dialog will be empty (except for the OK and cancel buttons).
847 UCI engines usually have many parameters. (But these are only visible with
848 a sufficiently modern version of the Polyglot adapter needed to run UCI engines,
849 e.g. Polyglot 1.4.55b.) For native XBoard engines this is less common.
850 @item Hint
851 @cindex Hint, Menu Item
852 Displays a move hint from the chess engine.
853 @item Book
854 @cindex Book, Menu Item
855 Displays a list of possible moves from the chess engine's opening
856 book.  The exact format depends on what chess engine you are using.
857 With GNU Chess 4, the first column gives moves, the second column
858 gives one possible response for each move, and the third column shows
859 the number of lines in the book that include the move from the first
860 column. If you select this option and nothing happens, the chess
861 engine is out of its book or does not support this feature.
862 @item Move Now
863 @cindex Move Now, Menu Item
864 Forces the chess engine to move immediately. Chess engine mode only.
865 The @kbd{Ctrl-M} key is a keyboard equivalent.
866 @item Retract Move
867 @cindex Retract Move, Menu Item
868 Retracts your last move. In chess engine mode, you can do this only
869 after the chess engine has replied to your move; if the chess engine is still
870 thinking, use @samp{Move Now} first. In ICS mode, @samp{Retract Move}
871 issues the command @samp{takeback 1} or @samp{takeback 2}
872 depending on whether it is your opponent's move or yours.
873 The @kbd{Ctrl-X} key is a keyboard equivalent.
874 @end table
876 @node Options Menu
877 @section Options Menu
878 @cindex Menu, Options
879 @cindex Options Menu
880 @table @asis
881 @item Time Control
882 @cindex Time Control, Menu Item
883 Pops up a sub-menu where you can set the time-control parameters interactively.
884 Allows you to select classical or incremental time controls,
885 set the moves per session, session duration, and time increment.
886 Also allows specification of time-odds factors for one or both engines.
887 If an engine is given a time-odds factor N, all time quota it gets, 
888 be it at the beginning of a session or through the time increment or
889 fixed time per move, will be divided by N.
890 The shifted @kbd{Alt+T} key is a keyboard equivalent.
891 @item Common Engine
892 @cindex Common Engine, Menu Item
893 Pops up a sub-menu where you can set some engine parameters common to most engines,
894 such as hash-table size, tablebase cache size, maximum number of processors
895 that SMP engines can use, and where to find the Polyglot adapter needed
896 to run UCI engines under XBoard. The feature that allows setting of these parameters on
897 engines is new since XBoard 4.3.15, so not many XBoard/WinBoard engines respond
898 to it yet, but UCI engines should.
900 It is also possible to specify a GUI opening book here, i.e. an opening
901 book that XBoard consults for any position a playing engine gets in.
902 It then forces the engine to play the book move, rather than to think up its own,
903 if that position is found in the book.
904 The book can switched on and off independently for either engine.
905 The way book moves are chosen can be influenced through the settings of
906 book depth and variety.
907 After both sides have played more moves than the specified depth,
908 the book will no longer be consulted.
909 When the variety is set to 50, moves will be played with the probability
910 specified in the book.
911 When set to 0, only the move(s) with the highest probability will be played.
912 When set to 100, all listed moves will be played with equal pobability.
913 Other settings interpolate between that.
914 The shifted @kbd{Alt+U} key is a keyboard equivalent.
915 @item Adjudications
916 @cindex Adjudications, Menu Item
917 Pops up a sub-menu where you can enable or disable various adjudications
918 that XBoard can perform in engine-engine games.
919 The shifted @kbd{Alt+J} key is a keyboard equivalent.
920 You can instruct XBoard to detect and terminate the game on checkmate
921 or stalemate, even if the engines would not do so, to verify engine
922 result claims (forfeiting engines that make false claims), rather than
923 naively following the engine, to declare draw on positions
924 which can never be won for lack of mating material, (e.g. KBK),
925 or which are impossible to win unless the opponent seeks its own demise 
926 (e.g. KBKN).
927 For these adjudications to work, @samp{Test Legality} should be switched on.
928 It is also possible to instruct XBoard to enforce a 50-move or 3-fold-repeat
929 rule and automatically declare draw (after a user-adjustable number of moves
930 or repeats) even if the engines are prepared to go on.
931 It is also possible to have XBoard declare draw on games that seem to drag on 
932 forever, or adjudicate a loss if both engines agree (for 3 consecutive moves) that one
933 of them is behind more than a user-adjustable score threshold.
934 For the latter adjudication to work, XBoard should be able to properly understand
935 the engine's scores. To facilitate the latter, you can inform xboard here if
936 the engines report scores from the viewpoint of white, or from that of their own color.
937 @item Match Game Options
938 @cindex Match Game Options, Menu Item
939 Summons a dialog where you can set options important for playing automatic 
940 matches between two chess programs 
941 (e.g. by using the @samp{Machine Match} menu item in the @samp{Mode} menu).
942 You can specify the number of games such a match should last,
943 and the duration of the pause between games
944 (important for some older engines to not have the last move of a previous
945 game be given when the next game has already started).
946 You can also specify a file with opening lines, or a file with initial positions
947 (the @code{loadGameFile} and @code{loadPositionFile} options),
948 and the number of the game or position to use from these files.
949 Values -1 and -2 of this 'index' convey a special meaning,
950 namely that XBoard should automatically step through all lines or positions
951 in these files.
952 With -1 such stepping is done every game; with -2 every two games,
953 so that each line or position is played with both colors before stepping
954 to the next one.
955 You can have XBoard automatically rewind to the first line or position
956 in the file after the index reaches a certain vaue,
957 which you can also specify here.
958 @item Load Game Options
959 @cindex Load Game Options, Menu Item
960 Summons a dialog where you can set the @code{autoDisplayComment} and 
961 @code{autoDisplayTags} options, (which control popups when viewing loaded games),
962 and specify the rate at which loaded games are auto-played,
963 in seconds per move (which can be a fractional number, like 1.6).
964 @item Save Game Options
965 @cindex ave Game Options, Menu Item
966 Summons a dialog where you can specify the files on which XBoard should
967 automtically save any played or entered games, 
968 (the @code{saveGameFile} option), 
969 or the final position of such games (the @code{savePositionfile} option).
970 You can also select 'auto-save' without a file name,
971 in which case XBoard will prompt the user for a file name after each game.
972 You can also set the default value for the PGN Event tag that will
973 be used for each new game you start.
974 Various options for the format of the game can be specified as well,
975 such as whether scores and depths of engine games should be saved as comments,
976 and if a tag with info about the score with which the engine came out of book
977 should be included.
978 For Chess, always set the format to PGN, rather than "old save stye"!
979 @item Game List
980 @cindex Game List Tags, Menu Item
981 Pops up a dialog where you can select the PGN tags that should appear
982 on the lines in the game list, and their order.
983 @item Sound Options
984 @cindex Sound Options, Menu Item
985 Summons a dialog where you can specify the sounds that should accompany
986 various events that can occur XBoard.
987 Most events are only relevant to ICS play, 
988 but the move sound is an important exception.
989 For each event listed in the dialog, 
990 you can select a standard sound from a menu.
991 You can also select a user-supplied sound file,
992 by typing its name into the designated text-edit field first,
993 and then selecting "Above WAV File" from the menu for the event.
994 A dummy event has been provided for trying out the sounds with the
995 "play" button next to it.
996 The directory with standard sounds, and the external program for playing
997 the sounds can be specified too, but normally you would not touch these
998 once XBoard is properly installed.
999 @itemx Move Sound
1000 @cindex Move Sound, Menu Item
1001 When a move sound other than 'None' is selected, 
1002 XBoard alerts you by playing a sound
1003 after each of your opponent's moves (or after every
1004 move if you are observing a game on the Internet Chess Server).
1005 The sound is not played after moves you make or moves read from a
1006 saved game file.
1007 If you turn on this option when using XBoard with the Internet
1008 Chess Server, you will probably want to give the
1009 @kbd{set bell 0}
1010 command to the ICS, since otherwise the ICS will ring the terminal bell
1011 after every move (not just yours). (The @file{.icsrc} file
1012 is a good place for this; see @ref{ICS options}.)
1013 @item General Options
1014 @cindex General Options, Menu Item
1015 The following items to set option values appear in the dialog
1016 summoned by the general Options menu item.
1017 @itemx Almost Always Queen
1018 @cindex Almost Always Queen, Menu Item
1019 If this option is on, 7th-rank pawns automatically change into
1020 Queens when you pick them up,
1021 and when you drag them to the promotion square and release them there,
1022 they will promote to that.
1023 But when you drag such a pawn backwards first,
1024 its identity will start to cycle through the other available pieces.
1025 This will continue ntil you start to move it forward;
1026 this will then fix the identity of the piece,
1027 so that you can safely put it down on the promotion square.
1028 If this option is off, what happens depends on the
1029 option @code{alwaysPromoteToQueen},
1030 which would force promotion to Queen when true.
1031 Otherwise XBoard would bring up a dialog
1032 box whenever you move a pawn to the last rank, asking what piece
1033 you want to promote to.
1034 @itemx Animate Dragging
1035 @cindex Animate Dragging, Menu Item
1036 If Animate Dragging is on, while you are dragging a piece with the
1037 mouse, an image of the piece follows the mouse cursor.
1038 If Animate Dragging is off, there is no visual feedback while you are
1039 dragging a piece, but if Animate Moving is on, the move will be
1040 animated when it is complete. 
1041 @itemx Animate Moving
1042 @cindex Animate Moving, Menu Item
1043 If Animate Moving is on, all piece moves are animated.  An image of the
1044 piece is shown moving from the old square to the new square when the
1045 move is completed (unless the move was already animated by Animate Dragging).
1046 If Animate Moving is off, a moved piece instantly disappears from its
1047 old square and reappears on its new square when the move is complete.
1048 The shifted @kbd{Ctrl-A} key is a keyboard equivalent.
1049 @itemx Auto Flag
1050 @cindex Auto Flag, Menu Item
1051 If this option is on and one player runs out of time
1052 before the other,
1053 XBoard
1054 will automatically call his flag, claiming a win on time.
1055 The shifted @kbd{Ctrl-F} key is a keyboard equivalent.
1056 In ICS mode, Auto Flag will only call your opponent's flag, not yours,
1057 and the ICS may award you a draw instead of a win if you have
1058 insufficient mating material.  In local chess engine mode,
1059 XBoard
1060 may call either player's flag and will not take material into account (?).
1061 @itemx Auto Flip View
1062 @cindex Auto Flip View, Menu Item
1063 If the Auto Flip View option is on when you start a game, the board
1064 will be automatically oriented so that your pawns move from the bottom
1065 of the window towards the top.
1067 If you are playing a game on an ICS, the board is always
1068 oriented at the start of the game so that your pawns move from
1069 the bottom of the window towards the top. Otherwise, the starting
1070 orientation is determined by the @code{flipView} command line option;
1071 if it is false (the default), White's pawns move from bottom to top
1072 at the start of each game; if it is true, Black's pawns move from
1073 bottom to top. @xref{User interface options}.
1074 @itemx Blindfold
1075 @cindex Blindfold, Menu Item
1076 If this option is on, XBoard displays the board as usual but does
1077 not display pieces or move highlights.  You can still move in the
1078 usual way (with the mouse or by typing moves in ICS mode), even though
1079 the pieces are invisible.
1080 @itemx Drop Menu
1081 @cindex Drop Menu, Menu Item
1082 Controls if right-clicking the board in crazyhouse / bughouse
1083 will pop up a menu to drop a piece on the clicked square
1084 (old, deprecated behavior)
1085 or allow you to step through an engine PV
1086 (new, recommended behavior).
1087 @itemx Highlight Dragging
1088 @cindex Highlight Dragging, Menu Item
1089 If Highlight Dragging is on, and the option -showTargetSquares is also on
1090 in the settings file, all squares a piece that is 'picked up' with the mouse
1091 can legally move to are highighted with a fat colored dot in the
1092 highlightColor (non-captures) or premoveHighlightColor (captures).
1093 Legality testing must be on for XBoard to know how the piece moves.
1094 @itemx Highlight Last Move
1095 @cindex Highlight Last Move, Menu Item
1096 If Highlight Last Move is on, after a move is made, the starting and
1097 ending squares remain highlighted. In addition, after you use Backward
1098 or Back to Start, the starting and ending squares of the last move to
1099 be unmade are highlighted.
1100 @itemx Highlight with Arrow
1101 @cindex Highlight with Arrow, Menu Item
1102 Causes the highlighting described in Highlight Last Move to be done
1103 by drawing an arrow between the highlighted squares,
1104 so that it is visible even when the width of the grid lines is set to zero.
1105 @itemx One-Click Moving
1106 @cindex One-Click Moving, Menu Item
1107 If this option is on, XBoard does not wait for you to click both the
1108 from- and the to-square, or drag the piece, but performs a move as soon
1109 as it is uniqely specified.
1110 This applies to clicking an own piece that only has a single legal move,
1111 clicking an empty square or opponent piece where only one of your pieces
1112 can move (or capture) to.
1113 Furthermore, a double-click on a piece that can only make a single capture
1114 will cause that capture to be made.
1115 Promoting a Pawn by clicking its to-square will suppress the promotion
1116 popup or other methods for selecting an under-promotion, 
1117 and make it promote to Queen.
1118 @itemx Periodic Updates
1119 @cindex Periodic Updates, Menu Item
1120 If this option is off (or if
1121 you are using a chess engine that does not support periodic updates),
1122 the analysis window
1123 will only be updated when the analysis changes. If this option is
1124 on, the Analysis Window will be updated every two seconds.
1125 @itemx Ponder Next Move
1126 @cindex Ponder Next Move, Menu Item
1127 If this option is off, the chess engine will think only when it is on
1128 move.  If the option is on, the engine will also think while waiting
1129 for you to make your move.
1130 The shifted @kbd{Ctrl-P} key is a keyboard equivalent.
1131 @itemx Popup Exit Message
1132 @cindex Popup Exit Message, Menu Item
1133 If this option is on, when XBoard wants to display a message just
1134 before exiting, it brings up a modal dialog box and waits for you to
1135 click OK before exiting.  If the option is off, XBoard prints the
1136 message to standard error (the terminal) and exits immediately.
1137 @itemx Popup Move Errors
1138 @cindex Popup Move Errors, Menu Item
1139 If this option is off, when you make an error in moving (such as
1140 attempting an illegal move or moving the wrong color piece), the
1141 error message is displayed in the message area.  If the option is
1142 on, move errors are displayed in small pop-up windows like other errors.
1143 You can dismiss an error pop-up either by clicking its OK button or by
1144 clicking anywhere on the board, including down-clicking to start a move.
1145 @itemx Show Coords
1146 @cindex Show Coords, Menu Item
1147 If this option is on, XBoard displays algebraic coordinates
1148 along the board's left and bottom edges.
1149 @itemx Hide Thinking
1150 @cindex Hide Thinking, Menu Item
1151 If this option is off, the chess engine's notion of the score and best
1152 line of play from the current position is displayed as it is
1153 thinking. The score indicates how many pawns ahead (or if negative,
1154 behind) the chess engine thinks it is. In matches between two
1155 machines, the score is prefixed by @samp{W} or @samp{B} to indicate
1156 whether it is showing White's thinking or Black's, and only the thinking
1157 of the engine that is on move is shown.
1158 The shifted @kbd{Ctrl-H} key is a keyboard equivalent.
1159 @itemx Test Legality
1160 @cindex Test Legality, Menu Item
1161 If this option is on, XBoard tests whether the moves you try to make
1162 with the mouse are legal and refuses to let you make an illegal move.
1163 The shifted @kbd{Ctrl-L} key is a keyboard equivalent.
1164 Moves loaded from a file with @samp{Load Game} are also checked.  If
1165 the option is off, all moves are accepted, but if a local chess engine
1166 or the ICS is active, they will still reject illegal moves.  Turning
1167 off this option is useful if you are playing a chess variant with
1168 rules that XBoard does not understand.  (Bughouse, suicide, and wild
1169 variants where the king may castle after starting on the d file are
1170 generally supported with Test Legality on.)
1171 @itemx Flash Moves
1172 @itemx Flash Rate
1173 @cindex Flash Moves, Menu Item
1174 @cindex Flash Rate, Menu Item
1175 If this option is non-zero, whenever a move is completed, 
1176 the moved piece flashes the specified number of times.
1177 The flash-rate setting determines how rapidly this flashing occurs.
1178 @itemx Animation Speed
1179 @cindex Animation Speed, Menu Item
1180 Determines the duration (in msec) of an animation step,
1181 when @samp{Animate Moving} is swiched on.
1183 @item ICS Options
1184 @cindex ICS Options, Menu Item
1185 The following options occur in a dialog summoned by the 
1186 ICS Options menu item.
1187 @itemx Auto Kibitz
1188 @cindex Auto Kibitz, Menu Item
1189 Setting this option when playingwith or aginst a chess program on an ICS
1190 will cause the last line of thinking output of the engine before its move
1191 to be sent to the ICS in a kibitz command.
1192 In addition, any kibitz message received through the ICS from
1193 an opponent chess program will be diverted to the engine-output window,
1194 (and suppressed in the console),
1195 where you can play through its PV by right-clicking it.
1196 @itemx Auto Comment
1197 @cindex Auto Comment, Menu Item
1198 If this option is on, any remarks made on ICS while you are observing or
1199 playing a game are recorded as a comment on the current move.  This includes
1200 remarks made with the ICS commands @kbd{say}, @kbd{tell}, @kbd{whisper},
1201 and @kbd{kibitz}.
1202 Limitation: remarks that you type yourself are not recognized;
1203 XBoard scans only the output from ICS, not the input you type to it.
1204 @itemx Auto Observe
1205 @cindex Auto Observe, Menu Item
1206 If this option is on and you add a player to your @code{gnotify}
1207 list on ICS, XBoard will automatically observe all of that
1208 player's games, unless you are doing something else (such as
1209 observing or playing a game of your own) when one starts.
1210 The games are displayed 
1211 from the point of view of the player on your gnotify list; that is, his
1212 pawns move from the bottom of the window towards the top.
1213 Exceptions:  If both players in a game are on your gnotify list, if
1214 your ICS 
1215 @code{highlight}
1216 variable is set to 0, or if the ICS you are using does not 
1217 properly support observing from Black's point of view,
1218 you will see the game from White's point of view.
1219 @itemx Auto Raise Board
1220 @cindex Auto Raise Board, Menu Item
1221 If this option is on, whenever a new game begins, the chessboard window
1222 is deiconized (if necessary) and raised to the top of the stack of windows.
1223 @itemx Auto Save
1224 @cindex Auto Save, Menu Item
1225 If this option is true, at the end of every game XBoard prompts
1226 you for a file name and appends a record of the game to the file
1227 you specify. 
1228 Disabled if the @code{saveGameFile} command-line
1229 option is set, as in that case all games are saved to the specified file.
1230 @xref{Load and Save options}.
1231 @itemx Background Observe
1232 @cindex Background Observe, Menu Item
1233 Setting this option will make XBoard suppress display of any boards
1234 from observed games while you are playing.
1235 In stead the last such board will be remembered,
1236 and shown to you when you right-click the board.
1237 This allows you to peek at your bughouse partner's game when you want,
1238 without disturbing your own game too much.
1239 @itemx Dual Board
1240 @cindex Dual Board, Menu Item
1241 Setting this option in combination with @samp{Background Observe}
1242 will display boards of observed games while you are playing
1243 on a second board next to that of your own game.
1244 @itemx Get Move List
1245 @cindex Get Move List, Menu Item
1246 If this option is on, whenever XBoard
1247 receives the first board of a new ICS game (or a different game from
1248 the one it is currently displaying), it
1249 retrieves the list of past moves from the ICS.
1250 You can then review the moves with the @samp{Forward} and @samp{Backward}
1251 commands
1252 or save them with @samp{Save Game}.  You might want to
1253 turn off this option if you are observing several blitz games at once,
1254 to keep from wasting time and network bandwidth fetching the move lists over
1255 and over.
1256 When you turn this option on from the menu, XBoard
1257 immediately fetches the move list of the current game (if any).
1258 @itemx Quiet Play
1259 @cindex Quiet Play, Menu Item
1260 If this option is on, XBoard will automatically issue an ICS
1261 @kbd{set shout 0}
1262 command whenever you start a game and a
1263 @kbd{set shout 1}
1264 command whenever you finish one.  Thus, you will not be distracted
1265 by shouts from other ICS users while playing.
1266 @itemx Seek Graph
1267 @cindex Seek Graph, Menu Item
1268 Setting this option will cause XBoard to display an graph of
1269 currently active seek ads when you left-click the board
1270 while idle and logged on to an ICS.
1271 @itemx Auto-Refresh Seek Graph
1272 @cindex Auto-Refresh Seek Graph, Menu Item
1273 In combination with the @samp{Seek Graph} option this
1274 will cause automatic update of the seek graph while it is up.
1275 This only works on FICS and ICS,
1276 and requires a lot of bandwidth on a busy server.
1277 @itemx Premove
1278 @itemx Premove White
1279 @itemx Premove Black
1280 @itemx First White Move
1281 @itemx First Black Move
1282 @cindex Premove, Menu Item
1283 @cindex Premove White, Menu Item
1284 @cindex Premove Black, Menu Item
1285 @cindex First White Move, Menu Item
1286 @cindex First Black Move, Menu Item
1287 If this option is on while playing a game on an ICS, you can register
1288 your next planned move before it is your turn.  Move the piece with
1289 the mouse in the ordinary way, and the starting and ending squares
1290 will be highlighted with a special color (red by default).  When it is
1291 your turn, if your registered move is legal, XBoard will send it to
1292 ICS immediately; if not, it will be ignored and you can make a
1293 different move.  If you change your mind about your premove, either
1294 make a different move, or double-click on any piece to cancel the move
1295 entirely.
1297 You can also enter premoves for the first white and black moves
1298 of the game.
1299 @itemx ICS Alarm
1300 @itemx ICS Alarm Time
1301 @cindex ICS Alarm, Menu Item
1302 @cindex ICS Alarm Time, Menu Item
1303 When this option is on, an alarm sound is played when your clock
1304 counts down to the icsAlarmTime in an ICS game.
1305 (By default, the time is 5 seconds, but you can pecify other values
1306 with the Alarm Time spin control.) 
1307 For games with time controls that include an increment, the
1308 alarm will sound each time the clock counts down to the icsAlarmTime.
1309 By default, the alarm sound is the terminal bell, but on some systems
1310 you can change it to a sound file using the soundIcsAlarm option; see
1311 below.
1312 @itemx Colorize Messages
1313 @cindex Colorize Messages, Menu Item
1314 Ticking this options causes various types of ICS messages do be
1315 displayed with different foreground or background colors in the console.
1316 The colors can be individually selected for each type,
1317 through the accompanying text edits.
1319 @item Save Settings Now
1320 @cindex Save Settings Now, Menu Item
1321 Selecting this menu item causes the current XBoard settings to be
1322 written to the settings file, so they will also apply in future sessions.
1323 Note that some settings are 'volatile', and are not saved,
1324 because XBoard considers it too unlikely that you want those to apply
1325 next time.
1326 In particular this applies to the Chess program names, and all options
1327 giving information on those Chess programs (such as their directory,
1328 if they have their own opening book, if they are UCI or native XBoard),
1329 or the variant you are playing.
1330 Such options would still be understood when they appear in the settings
1331 file in case they were put there with the aid of a text editor, but they
1332 would disappear from the file as soon as you save the settings.
1333 @item Save Settings on Exit
1334 @cindex Save Settings on Exit, Menu Item
1335 Setting this option has no immediate effect, but causes the settings
1336 to be saved when you quit XBoard. What happens then is otherwise 
1337 identical to what happens when you use select "Save Settings Now",
1338 see there.
1339 @end table
1341 @node Help Menu
1342 @section Help Menu
1343 @cindex Menu, Help
1344 @cindex Help Menu
1345 @table @asis
1346 @item Info XBoard
1347 @cindex Info XBoard, Menu Item
1348 Displays the XBoard documentation in info format.  For this feature to
1349 work, you must have the GNU info program installed on your system, and
1350 the file @file{} must either be present in the current
1351 working directory, or have been installed by the @samp{make install}
1352 command when you built XBoard.
1353 @item Man XBoard
1354 @cindex Man XBoard, Menu Item
1355 Displays the XBoard documentation in man page format.
1356 The @kbd{F1} key is a keyboard equivalent.  For this
1357 feature to work, the file @file{xboard.6} must have been installed by
1358 the @samp{make install} command when you built XBoard, and the
1359 directory it was placed in must be on the search path for your
1360 system's @samp{man} command.
1361 @item About XBoard
1362 @cindex About XBoard, Menu Item
1363 Shows the current XBoard version number.
1364 @end table
1366 @node Keys
1367 @section Other Shortcut Keys
1368 @cindex Keys
1369 @cindex Shortcut keys
1370 @table @asis
1371 @item Iconize
1372 Pressing the @kbd{-} key iconizes XBoard. The graphical
1373 icon displays a white knight if it is White's move, or a black knight
1374 if it is Black's move. If your X window manager displays only text
1375 icons, not graphical ones, check its documentation; there is probably
1376 a way to enable graphical icons.  If you get black and white reversed,
1377 we would like to hear about it; see @ref{Problems} below for
1378 instructions on how to report this problem.
1379 @item Load Next Game
1380 @cindex Load Next Game, Menu Item
1381 Loads the next game from the last game record file you loaded.
1382 The @kbd{Alt+PgDn} key is a keyboard equivalent.
1383 @item Load Previous Game
1384 @cindex Load Previous Game, Menu Item
1385 Loads the previous game from the last game record file you
1386 loaded.  The @kbd{Alt+PgUp} key is a keyboard equivalent.
1387 Not available if the last game was loaded from a pipe.
1388 @item Reload Same Game
1389 @cindex Reload Same Game, Menu Item
1390 Reloads the last game you loaded.
1391 Not available if the last game was loaded from a pipe.
1392 @item Reload Same Position
1393 @cindex Reload Same Position, Menu Item
1394 Reloads the last position you loaded.
1395 Not available if the last position was loaded from a pipe.
1396 @end table
1398 You can add or remove shortcut keys using the X resources
1399 @code{form.translations}. Here is an example of what would go in your
1400 @file{.Xresources} file:
1402 @example
1403 XBoard*form.translations: \
1404   Shift<Key>?: AboutGameProc() \n\
1405   <Key>y: AcceptProc() \n\
1406   <Key>n: DeclineProc() \n\
1407   <Key>i: NothingProc()
1408 @end example
1409 @noindent
1410 Binding a key to @code{NothingProc} makes it do nothing, thus removing
1411 it as a shortcut key. The XBoard commands that can be bound to keys
1412 are:
1414 @example
1415 AbortProc, AboutGameProc, AboutProc, AcceptProc, AdjournProc,
1416 AlwaysQueenProc, AnalysisModeProc, AnalyzeFileProc,
1417 AnimateDraggingProc, AnimateMovingProc, AutobsProc, AutoflagProc,
1418 AutoflipProc, AutoraiseProc, AutosaveProc, BackwardProc,
1419 BlindfoldProc, BookProc, CallFlagProc, CopyGameProc, CopyPositionProc,
1420 DebugProc, DeclineProc, DrawProc, EditCommentProc, EditGameProc,
1421 EditPositionProc, EditTagsProc, EnterKeyProc, FlashMovesProc,
1422 FlipViewProc, ForwardProc, GetMoveListProc, HighlightLastMoveProc,
1423 HintProc, Iconify, IcsAlarmProc, IcsClientProc, IcsInputBoxProc,
1424 InfoProc, LoadGameProc, LoadNextGameProc, LoadNextPositionProc,
1425 LoadPositionProc, LoadPrevGameProc, LoadPrevPositionProc,
1426 LoadSelectedProc, MachineBlackProc, MachineWhiteProc, MailMoveProc,
1427 ManProc, MoveNowProc, MoveSoundProc, NothingProc, OldSaveStyleProc,
1428 PasteGameProc, PastePositionProc, PauseProc, PeriodicUpdatesProc,
1429 PonderNextMoveProc, PopupExitMessageProc, PopupMoveErrorsProc,
1430 PremoveProc, QuietPlayProc, QuitProc, ReloadCmailMsgProc,
1431 ReloadGameProc, ReloadPositionProc, RematchProc, ResetProc,
1432 ResignProc, RetractMoveProc, RevertProc, SaveGameProc,
1433 SavePositionProc, ShowCoordsProc, ShowGameListProc, ShowThinkingProc,
1434 StopExaminingProc, StopObservingProc, TestLegalityProc, ToEndProc,
1435 ToStartProc, TrainingProc, TruncateGameProc, and TwoMachinesProc.
1436 @end example
1438 @node Options
1439 @chapter Options
1440 @cindex Options
1441 @cindex Options
1443 This section documents the command-line options to XBoard.  You can
1444 set these options in two ways: by typing them on the shell command
1445 line you use to start XBoard, or by setting them as X resources
1446 (typically in your @file{.Xresources} file).  Many of the options
1447 cannot be changed while XBoard is running; others set the initial
1448 state of items that can be changed with the @ref{Options} menu.
1450 Most of the options have both a long name and a short name. To turn a
1451 boolean option on or off from the command line, either give its long
1452 name followed by the value true or false
1453 (@samp{-longOptionName true}), or give just the short name to turn the
1454 option on (@samp{-opt}), or the short name preceded by @samp{x} to
1455 turn the option off (@samp{-xopt}). For options that take strings or
1456 numbers as values, you can use the long or short option names
1457 interchangeably.
1459 Each option corresponds to an X resource with the same name, so
1460 if you like, you can set options in your @file{.Xresources} file
1461 or in a file named @file{XBoard} in your home directory.
1462 For options that have two names, the longer one is the name of
1463 the corresponding X resource; the short name is not recognized.
1464 To turn a boolean option on or off as an
1465 X resource, give its long name followed by the value
1466 true or false (@samp{XBoard*longOptionName: true}).
1468 @menu
1469 * Chess engine options::        Controlling the chess engine.
1470 * UCI + WB Engine Settings::    Setting some very common engine parameters
1471 * ICS options::                 Connecting to and using ICS.
1472 * Load and Save options::       Input/output options.
1473 * User interface options::      Look and feel options.
1474 * Adjudication Options::        Control adjudication of engine-engine games.
1475 * Other options::               Miscellaneous.
1476 @end menu
1478 @node Chess engine options
1479 @section Chess Engine Options
1480 @cindex options, Chess engine
1481 @cindex Chess engine options
1482 @table @asis
1483 @item -tc or -timeControl minutes[:seconds]
1484 @cindex tc, option
1485 @cindex timeControl, option
1486 Each player begins with his clock set to the @code{timeControl} period.
1487 Default: 5 minutes.
1488 The additional options @code{movesPerSession} and @code{timeIncrement}
1489 are mutually exclusive.  
1490 @item -mps or -movesPerSession moves
1491 @cindex mps, option
1492 @cindex movesPerSession, option
1493 When both players have made @code{movesPerSession} moves, a
1494 new @code{timeControl} period is added to both clocks.  Default: 40 moves.
1495 @item -inc or -timeIncrement seconds
1496 @cindex inc, option
1497 @cindex timeIncrement, option
1498 If this option is specified, @code{movesPerSession} is ignored.
1499 Instead, after each player's move, @code{timeIncrement} seconds are
1500 added to his clock.  
1501 Use @samp{-inc 0} if you want to require the entire
1502 game to be played in one @code{timeControl} period, with no increment.
1503 Default: -1, which specifies @code{movesPerSession} mode.
1504 @item -clock/-xclock or -clockMode true/false
1505 @cindex clock, option
1506 @cindex clockMode, option
1507 Determines whether or not to display the chess clocks. If clockMode is
1508 false, the clocks are not shown, but the side that is to play next
1509 is still highlighted. Also, unless @code{searchTime}
1510 is set, the chess engine still keeps track of the clock time and uses it to
1511 determine how fast to make its moves.
1512 @item -st or -searchTime minutes[:seconds]
1513 @cindex st, option
1514 @cindex searchTime, option
1515 Tells the chess engine to spend at most the given amount of time
1516 searching for each of its moves. Without this option, the chess engine
1517 chooses its search time based on the number of moves and amount
1518 of time remaining until the next time control.
1519 Setting this option also sets clockMode to false.
1520 @item -depth or -searchDepth number
1521 @cindex sd, option
1522 @cindex searchDepth, option
1523 Tells the chess engine to look ahead at most the given number of moves
1524 when searching for a move to make. Without this option, the chess
1525 engine chooses its search depth based on the number of moves and
1526 amount of time remaining until the next time control.  With the option,
1527 the engine will cut off its search early if it reaches the specified depth.
1528 @item -firstNPS number
1529 @itemx -secondNPS number
1530 @cindex firstNPS, option
1531 @cindex secondNPS, option
1532 Tells the chess engine to use an internal time standard based on its node count, 
1533 rather then wall-clock time, to make its timing decisions. 
1534 The time in virtual seconds should be obtained by dividing the node count 
1535 through the given number, like the number was a rate in nodes per second. 
1536 Xboard will manage the clocks in accordance with this, relying on the number 
1537 of nodes reported by the engine in its thinking output. If the given number equals zero, 
1538 it can obviously not be used to convert nodes to seconds, and the time reported 
1539 by the engine is used to decrement the XBoard clock in stead. The engine is supposed to 
1540 report in CPU time it uses, rather than wall-clock time, in this mode. This option 
1541 can provide fairer conditions for engine-engine matches on heavily loaded machines, 
1542 or with very fast games (where the wall clock is too inaccurate). 
1543 @code{showThinking} must be on for this option to work. Default: -1 (off).
1544 Not many engines might support this yet!
1545 @item -firstTimeOdds factor
1546 @itemx -secondTimeOdds factor
1547 @cindex firstTimeOdds, option
1548 @cindex secondTimeOdds, option
1549 Reduces the time given to the mentioned engine by the given factor. 
1550 If pondering is off, the effect is indistinguishable from what would happen 
1551 if the engine was running on an n-times slower machine. Default: 1.
1552 @item -timeOddsMode mode
1553 @cindex timeOddsMode, option
1554 This option determines how the case is handled where both engines have a time-odds handicap. 
1555 If mode=1, the engine that gets the most time will always get the nominal time, 
1556 as specified by the time-control options, and its opponent's time is renormalized accordingly. 
1557 If mode=0, both play with reduced time. Default: 0.
1558 @item -hideThinkingFromHuman true/false
1559 Controls the Hide Thinking option. @xref{Options Menu}. Default: true.
1560 (Replaces the Show-Thinking option of older xboard versions.)
1561 @item -thinking/-xthinking or -showThinking true/false
1562 @cindex thinking, option
1563 @cindex showThinking, option
1564 Forces the engine to send thinking output to xboard. 
1565 Used to be the only way to control if thinking output was displayed 
1566 in older xboard versions,
1567 but as the thinking output in xboard 4.3 is also used for several other
1568 purposes (adjudication, storing in PGN file) the display of it is now controlled
1569 by the new option Hide Thinking. @xref{Options Menu}. Default: false.
1570 (But if xboard needs the thinking output for some purpose,
1571 it makes the engine send it despite the setting of this option.)
1572 @item -ponder/-xponder or -ponderNextMove true/false
1573 @cindex ponder, option
1574 @cindex ponderNextMove, option
1575 Sets the Ponder Next Move menu option. @xref{Options Menu}. Default: true.
1576 @item -smpCores number
1577 Specifies the maximum number of CPUs an SMP engine is allowed to use.
1578 Only works for engines that support the XBoard/WinBoard-protocol cores feature.
1579 @item -mg or -matchGames n
1580 @cindex mg, option
1581 @cindex matchGames, option
1582 Automatically runs an n-game match between two chess engines,
1583 with alternating colors.
1584 If the @code{loadGameFile} or @code{loadPositionFile} option is set,
1585 XBoard
1586 starts each game with the given opening moves or the given position;
1587 otherwise, the games start with the standard initial chess position.
1588 If the @code{saveGameFile} option is set, a move record for the
1589 match is appended to the specified file. If the @code{savePositionFile}
1590 option is set, the final position reached in each game of the match is appended
1591 to the specified file. When the match is over, XBoard
1592 displays the match score and exits. Default: 0 (do not run a match).
1593 @item -mm/-xmm or -matchMode true/false
1594 @cindex mm, option
1595 @cindex matchMode, option
1596 Setting @code{matchMode} to true is equivalent to setting
1597 @code{matchGames} to 1.
1598 @item -sameColorGames n
1599 @cindex sameColorGames, option
1600 Automatically runs an n-game match between two chess engines,
1601 without alternating colors.
1602 Otherwise the same applies as for the @samp{-matchGames} option,
1603 over which it takes precedence if both are specified. (See there.)
1604 Default: 0 (do not run a match).
1605 @item -fcp or -firstChessProgram program
1606 @cindex fcp, option
1607 @cindex firstChessProgram, option
1608 Name of first chess engine.
1609 Default: @file{Fairy-Max}.
1610 @item -scp or -secondChessProgram program
1611 @cindex scp, option
1612 @cindex secondChessProgram, option
1613 Name of second chess engine, if needed.
1614 A second chess engine is started only in Two Machines (match) mode.
1615 Default: @file{Fairy-Max}.
1616 @item -fb/-xfb or -firstPlaysBlack true/false
1617 @cindex fb, option
1618 @cindex firstPlaysBlack, option
1619 In games between two chess engines, firstChessProgram normally plays
1620 white.  If this option is true, firstChessProgram plays black.  In a
1621 multi-game match, this option affects the colors only for the first
1622 game; they still alternate in subsequent games.
1623 @item -fh or -firstHost host
1624 @itemx -sh or -secondHost host
1625 @cindex fh, option
1626 @cindex firstHost, option
1627 @cindex sh, option
1628 @cindex secondHost, option
1629 Hosts on which the chess engines are to run. The default for
1630 each is @file{localhost}. If you specify another host, XBoard
1631 uses @file{rsh} to run the chess engine there. (You can substitute a
1632 different remote shell program for rsh using the @code{remoteShell}
1633 option described below.)
1634 @item -fd or -firstDirectory dir
1635 @itemx -sd or -secondDirectory dir
1636 @cindex fd, option
1637 @cindex firstDirectory, option
1638 @cindex sd, option
1639 @cindex secondDirectory, option
1640 Working directories in which the chess engines are to be run.
1641 The default is "", which means to run the chess engine
1642 in the same working directory as XBoard
1643 itself.  (See the CHESSDIR environment variable.)
1644 This option is effective only when the chess engine is being run
1645 on the local host; it does not work if the engine is run remotely
1646 using the -fh or -sh option.
1647 @item -initString string
1648 @itemx -secondInitString string
1649 @cindex initString, option
1650 @cindex secondInitString, option
1651 The string that is sent to initialize each chess engine for a new game.
1652 Default:
1654 @example
1655 new
1656 random
1657 @end example
1658 @noindent
1659 Setting this option from the command line is tricky, because you must
1660 type in real newline characters, including one at the very end.
1661 In most shells you can do this by
1662 entering a @samp{\} character followed by a newline. It is easier to set
1663 the option from your @file{.Xresources} file; in that case you can
1664 include the character sequence @samp{\n} in the string, and it will
1665 be converted to a newline.
1667 If you change this option, don't remove the @samp{new} 
1668 command; it is required by all chess engines to
1669 start a new game.
1671 You can remove the @samp{random} command if you like; including it
1672 causes GNU Chess 4 to randomize its move selection slightly so that it
1673 doesn't play the same moves in every game.  Even without
1674 @samp{random}, GNU Chess 4 randomizes its choice of moves from its
1675 opening book.  Many other chess engines ignore this command entirely
1676 and always (or never) randomize.
1678 You can also try adding other commands to the initString; see the
1679 documentation of the chess engine you are using for details.
1680 @item -firstComputerString string
1681 @itemx -secondComputerString string
1682 @cindex firstComputerString, option
1683 @cindex secondComputerString, option
1684 The string that is sent to the chess engine if its opponent is another
1685 computer chess engine.  The default is @samp{computer\n}.  Probably the
1686 only useful alternative is the empty string (@samp{}), which keeps the
1687 engine from knowing that it is playing another computer.
1688 @item -reuse/-xreuse or -reuseFirst true/false
1689 @itemx -reuse2/-xreuse2 or -reuseSecond true/false
1690 @cindex reuse, option
1691 @cindex reuseFirst, option
1692 @cindex reuse2, option
1693 @cindex reuseSecond, option
1694 If the option is false,
1695 XBoard kills off the chess engine after every game and starts
1696 it again for the next game.  
1697 If the option is true (the default), 
1698 XBoard starts the chess engine only once
1699 and uses it repeatedly to play multiple games.
1700 Some old chess engines may not work properly when
1701 reuse is turned on, but otherwise games will start faster if it is left on.
1702 @item -firstProtocolVersion version-number
1703 @itemx -secondProtocolVersion version-number
1704 @cindex firstProtocolVersion, option
1705 @cindex secondProtocolVersion, option
1706 This option specifies which version of the chess engine communication
1707 protocol to use.  By default, version-number is 2.  In version 1, the
1708 "protover" command is not sent to the engine; since version 1 is a
1709 subset of version 2, nothing else changes.  Other values for
1710 version-number are not supported.
1711 @item -firstScoreAbs true/false
1712 @itemx -secondScoreAbs true/false
1713 @cindex firstScoreAbs, option
1714 @cindex secondScoreAbs, option
1715 If this option is set, the score reported by the engine is taken to be 
1716 that in favor of white, even when the engine plays black. 
1717 Important when XBoard uses the score for adjudications, or in PGN reporting. 
1718 @item -niceEngines priority
1719 @cindex niceEngines, option
1720 This option allows you to lower the priority of the engine processes, 
1721 so that the generally insatiable hunger for CPU time of chess engines does not interfere so much 
1722 with smooth operation of XBoard (or the rest of your system). 
1723 Negative values could increase the engine priority, which is not recommended.
1724 @item -firstOptions string
1725 @itemx -secondOptions string
1726 @cindex firstOptions, option
1727 @cindex secondOptions, option
1728 The given string is a comma-separated list of (option name=option value) pairs, 
1729 like the following example: "style=Karpov,blunder rate=0". 
1730 If an option announced by the engine at startup through the feature commands of the XBoard/WinBoard protocol 
1731 matches one of the option names (i.e. "style" or "blunder rate"), 
1732 it would be set to the given value (i.e. "Karpov" or 0) 
1733 through a corresponding option command to the engine. 
1734 This provided that the type of the value (text or numeric) matches as well.
1735 @item -firstNeedsNoncompliantFEN string
1736 @itemx -secondNeedsNoncompliantFEN string
1737 @cindex firstNeedsNoncompliantFEN, option
1738 @cindex secondNeedsNoncompliantFEN, option
1739 The castling rights and e.p. fields of the FEN sent to the mentioned engine 
1740 with the setboard command will be replaced by the given string. This can for 
1741 instance be used to run engines that do not understand Chess960 FENs in 
1742 variant fischerandom, to make them at least understand the opening position, 
1743 through setting the string to "KQkq -". (Note you also have to give the e.p. field!) 
1744 Other possible applications are to provide work-arounds for engines that want to see 
1745 castling and e.p. fields in variants that do not have castling or e.p. 
1746 (shatranj, courier, xiangqi, shogi) so that XBoard would normally omit them 
1747 (string = "- -"), or to add variant-specific fields that are not yet supported by XBoard 
1748 (e.g. to indicate the number of checks in 3check).
1749 @item -shuffleOpenings
1750 @cindex shuffleOpenings, option
1751 Forces shuffling of the opening setup in variants that normally have a fixed initial position.
1752 Shufflings are symmetric for black and white, and exempt King and Rooks in variants
1753 with normal castling.
1754 Remains in force until a new variant is selected.
1755 @end table
1757 @node UCI + WB Engine Settings
1758 @section UCI + WB Engine Settings
1759 @cindex Engine Settings
1760 @cindex Settings, Engine
1761 @table @asis
1762 @item -fUCI or -firstIsUCI true/false
1763 @itemx -sUCI or -secondIsUCI true/false
1764 @cindex fUCI, option
1765 @cindex sUCI, option
1766 @cindex firstIsUCI, option
1767 @cindex secondIsUCI, option
1768 Indicates if the mentioned engine executable file is an UCI engine, 
1769 and should be run with the aid of the Polyglot adapter rather than directly. 
1770 Xboard will then pass the other UCI options and engine name to Polyglot 
1771 through a .ini temporary file created for the purpose.
1772 @item -polyglotDir filename
1773 @cindex polyglotDir, option
1774 Gives the name of the directory in which the Polyglot adapter for UCI engines resides.
1775 Default: "".
1776 @item -usePolyglotBook true/false
1777 @cindex usePolyglotBook, option
1778 Specifies if the Polyglot book should be used.
1779 @item -polyglotBook filename
1780 @cindex polyglotBook, option
1781 Gives the filename of the opening book that Polyglot should use. 
1782 From XBoard 4.3.15 on, native XBoard/WinBoard engines will also use the opening book specified here, 
1783 provided the @code{usePolyglotBook} option is set to true,
1784 and the option @code{firstHasOwnBookUCI} or @code{secondHasOwnBookUCI} applying to the engine
1785 is set to false.
1786 The engine will be kept in force mode as long as the current position is in book, 
1787 and XBoard will select the book moves for it. Default: "".
1788 @item -fNoOwnBookUCI or -firstXBook or -firstHasOwnBookUCI true/false
1789 @itemx -sNoOwnBookUCI or -secondXBook or -secondHasOwnBookUCI true/false
1790 @cindex fNoOwnBookUCI, option
1791 @cindex sNoOwnBookUCI, option
1792 @cindex firstHasOwnBookUCI, option
1793 @cindex secondHasOwnBookUCI, option
1794 @cindex firstXBook, option
1795 @cindex secondXBook, option
1796 Indicates if the mentioned engine has its own opening book it should play from,
1797 rather than using the external book through XBoard. Default: false.
1798 @item -defaultHashSize n
1799 @cindex defaultHashSize, option
1800 Sets the size of the hash table to n MegaBytes. Together with the EGTB cache size 
1801 this number is also used to calculate the memory setting of XBoard/WinBoard engines, 
1802 for those that support the memory feature of the XBoard/WinBoard protocol. Default: 64.
1803 @item -defaultCacheSizeEGTB n
1804 @cindex defaultCacheSizeEGTB, option
1805 Sets the size of the EGTB cache to n MegaBytes. Together with the hash-table size 
1806 this number is also used to calculate the memory setting of XBoard/WinBoard engines, 
1807 for those that support the memory feature of the XBoard/WinBoard protocol. Default: 4.
1808 @item -defaultPathEGTB filename
1809 @cindex defaultPathEGTB, option
1810 Gives the name of the directory where the end-game tablebases are installed, for UCI engines.
1811 Default: "/usr/local/share/egtb".
1812 @item -egtFormats string
1813 @cindex egtFormats, option
1814 Specifies which end-game tables are installed on the computer, and where. 
1815 The argument is a comma-separated list of format specifications, 
1816 each specification consisting of a format name, a colon, and a directory path name, 
1817 e.g. "nalimov:/usr/local/share/egtb". 
1818 If the name part matches that of a format that the engine requests through a feature command, 
1819 xboard will relay the path name for this format to the engine through an egtpath command. 
1820 One egtpath command for each matching format will be sent. 
1821 Popular formats are "nalimov" DTM tablebases and "scorpio" bitbases.
1822 Default: "".
1823 @end table
1825 @node ICS options
1826 @section ICS options
1827 @cindex ICS options
1828 @cindex Options, ICS
1829 @table @asis
1830 @item -ics/-xics or -internetChessServerMode true/false
1831 @cindex ics, option
1832 @cindex internetChessServerMode, option
1833 Connect with an Internet Chess Server to play chess against its
1834 other users, observe games they are playing, or review games
1835 that have recently finished. Default: false.
1836 @item -icshost or -internetChessServerHost host
1837 @cindex icshost, option
1838 @cindex internetChessServerHost, option
1839 The Internet host name or address of the chess server to connect
1840 to when in ICS mode. Default: @code{}.
1841 Another popular chess server to try is @code{}.
1842 If your site doesn't have a working Internet name server, try
1843 specifying the host address in numeric form. 
1844 You may also need
1845 to specify the numeric address when using the icshelper option
1846 with timestamp or timeseal (see below).
1847 @item -icsport or -internetChessServerPort port-number
1848 @cindex icsport, option
1849 @cindex internetChessServerPort, option
1850 The port number to use when connecting to a chess server in ICS
1851 mode. Default: 5000.
1852 @item -icshelper or -internetChessServerHelper prog-name
1853 @cindex icshelper, option
1854 @cindex internetChessServerHelper, option
1855 An external helper program used to communicate with the chess server.
1856 You would set it to "timestamp" for ICC ( or
1857 "timeseal" for FICS (, after
1858 obtaining the correct version of timestamp or timeseal for your
1859 computer.  See "help timestamp" on ICC and "help timeseal" on FICS.
1860 This option is shorthand for @code{-useTelnet -telnetProgram program}.
1861 @item -telnet/-xtelnet or -useTelnet true/false
1862 @cindex telnet, option
1863 @cindex useTelnet, option
1864 This option is poorly named; it should be called useHelper.
1865 If set to true, it instructs XBoard to run an external
1866 program to communicate with the Internet Chess Server. 
1867 The program to use is given by the telnetProgram option.
1868 If the option is
1869 false (the default), XBoard opens a TCP socket and uses its own
1870 internal implementation of the telnet protocol to communicate with the
1871 ICS. @xref{Firewalls}.
1872 @item -telnetProgram prog-name
1873 @cindex telnetProgram, option
1874 This option is poorly named; it should be called helperProgram.
1875 It gives the name of the telnet program to be used with
1876 the @code{gateway} and @code{useTelnet} options.  The default is
1877 @file{telnet}. The telnet program is invoked with the value of
1878 @code{internetChessServerHost} as its first argument and the value
1879 of @code{internetChessServerPort} as its second argument.
1880 @xref{Firewalls}.
1881 @item -gateway host-name
1882 @cindex gateway, option
1883 If this option is set to a host name, XBoard communicates with the
1884 Internet Chess Server by using @file{rsh} to run
1885 the @code{telnetProgram} on the given host,
1886 instead of using its own internal implementation
1887 of the telnet protocol. You can substitute a different remote shell
1888 program for @file{rsh} using the @code{remoteShell} option described below.
1889 @xref{Firewalls}.
1890 @item -internetChessServerCommPort or -icscomm dev-name
1891 @cindex internetChessServerCommPort, option
1892 @cindex icscomm, option
1893 If this option is set, XBoard communicates with the ICS through
1894 the given character I/O device instead of opening a TCP connection.
1895 Use this option if your system does not have any kind of
1896 Internet connection itself (not even a SLIP or PPP connection),
1897 but you do have dial-up access (or a hardwired terminal line) to
1898 an Internet service provider from which you can telnet to the ICS.
1900 The support for this option in XBoard is minimal. You need to
1901 set all communication parameters and tty modes before you enter
1902 XBoard.
1904 Use a script something like this:
1906 @example
1907 stty raw -echo 9600 > /dev/tty00
1908 xboard -ics -icscomm /dev/tty00
1909 @end example
1911 Here replace @samp{/dev/tty00} with the name of the device that your
1912 modem is connected to. You might have to add several more
1913 options to these stty commands. See the man pages for @file{stty}
1914 and @code{tty} if you run into problems. Also, on many systems stty
1915 works on its standard input instead of standard output, so you
1916 have to use @samp{<} instead of @samp{>}.
1918 If you are using linux, try starting with the script below.
1919 Change it as necessary for your installation.
1921 @example
1922 #!/bin/sh -f
1923 # configure modem and fire up XBoard
1925 # configure modem
1926 (
1927   stty 2400 ; stty raw ; stty hupcl ; stty -clocal
1928   stty ignbrk ; stty ignpar ; stty ixon ; stty ixoff
1929   stty -iexten ; stty -echo
1930 ) < /dev/modem
1931 xboard -ics -icscomm /dev/modem
1932 @end example
1933 @noindent
1934 After you start XBoard in this way, type whatever commands are
1935 necessary to dial out to your Internet provider and log in.
1936 Then telnet to ICS, using a command like
1937 @kbd{telnet 5000}.
1938 Important: See the paragraph below about extra echoes, 
1939 in @ref{Limitations}.
1940 @item -icslogon or -internetChessServerLogonScript file-name
1941 @cindex icslogon, option
1942 @cindex internetChessServerLogonScript, option
1943 @cindex .icsrc
1944 Whenever XBoard connects to the Internet Chess Server,
1945 if it finds a file with the name given in this option, it feeds the
1946 file's contents to the ICS as commands. The default file name
1947 is @file{.icsrc}.
1948 Usually the first two lines of the file should be
1949 your ICS user name and password.
1950 The file can be either in $CHESSDIR, in XBoard's working
1951 directory if CHESSDIR is not set, or in your home directory.
1952 @item -msLoginDelay delay
1953 @cindex msLoginDelay, option
1954 If you experience trouble logging on to an ICS when using the
1955 @code{-icslogon} option, inserting some delay between characters
1956 of the logon script may help. This option adds @code{delay}
1957 milliseconds of delay between characters. Good values to try
1958 are 100 and 250.
1959 @item -icsinput/-xicsinput or -internetChessServerInputBox true/false
1960 @cindex icsinput, option
1961 @cindex internetChessServerInputBox, option
1962 Sets the ICS Input Box menu option. @xref{Mode Menu}. Default: false.
1963 @item -autocomm/-xautocomm or -autoComment true/false
1964 @cindex autocomm, option
1965 @cindex autoComment, option
1966 Sets the Auto Comment menu option. @xref{Options Menu}. Default: false.
1967 @item -autoflag/-xautoflag or -autoCallFlag true/false
1968 @cindex autoflag, option
1969 @cindex autoCallFlag, option
1970 Sets the Auto Flag menu option.  @xref{Options Menu}. Default: false.
1971 @item -autobs/-xautobs or -autoObserve true/false
1972 @cindex autobs, option
1973 @cindex autoObserve, option
1974 Sets the Auto Observe menu option.  @xref{Options Menu}. Default: false.
1975 @item -autoKibitz
1976 @cindex autoKibitz, option
1977 Enables kibitzing of the engines last thinking output (depth, score, time, speed, PV) 
1978 before it moved
1979 to the ICS, in zippy mode. The option @code{showThinking} must be switched on for 
1980 this option to work.
1981 Also diverts similar kibitz information of an opponent engine that is playing you 
1982 through the ICS to the engine-output window, as if the engine was playing locally.
1983 @item -seekGraph true/false or -sg
1984 @cindex seekGraph, option
1985 @cindex sg, option
1986 Enables displaying of the seek graph by left-clicking the board when
1987 you are logged on to an ICS and currently idle.
1988 The seek graph show all players currently seeking games on the ICS,
1989 plotted according to their rating and the time control of the game they seek,
1990 in three different colors (for rated, unrated and wild games).
1991 Computer ads are displayed as squares, human ads are dots.
1992 Default: false.
1993 @item -autoRefresh true/false
1994 @cindex autoRefresh, option
1995 Enables automatic updating of the seek graph,
1996 by having the ICS send a running update of all newly placed
1997 and removed seek ads.
1998 This consumes a substantial amount of communication bandwidth,
1999 and is only supported for FICS and ICC.
2000 Default: false.
2001 @item -backgroundObserve true/false
2002 @cindex backgroundObserve, option
2003 When true, boards sent to you by the ICS from other games while you are playing
2004 (e.g. because you are observing them)
2005 will not be automatically displayed.
2006 Only a summary of time left and material of both players will appear
2007 in the message field above the board.
2008 XBoard will remember the last board it has received this way,
2009 and will display it in stead of the position in your own game
2010 when you press the right mouse button.
2011 No other information is stored on such games observed in the background;
2012 you cannot save such a game later, or step through its moves.
2013 This feature is provided solely for the benefit of bughouse players,
2014 to enable them to peek at their partner's game without the need
2015 to logon twice.
2016 Default: false.
2017 @item -dualBoard true/false
2018 @cindex dualBoard, option
2019 In combination with -backgroundObserve true, this option will display
2020 the board of the background game side by side with that of your own game,
2021 so you can have it in view permanently.
2022 Any board or holdings info coming in will be displayed on the secondary
2023 board immediately.
2024 This feature is still experimental and largely unfinished.
2025 There is no animation or highlighting of moves on the secondary board.
2026 Default: false.
2027 @item -oneClickMove true/false
2028 @cindex oneClickMove, option
2029 When set, this option allows you to enter moves by only clicking the to-
2030 or from-square, when only a single legal move to or from that square
2031 is possible.
2032 Double-clicking a piece (or clicking an already selected piece)
2033 will instruct that piece to make the only capture it can legally do.
2034 Default: false.
2035 @item -moves/-xmoves or -getMoveList true/false
2036 @cindex moves, option
2037 @cindex getMoveList, option
2038 Sets the Get Move List menu option.  @xref{Options Menu}.  Default: true.
2039 @item -alarm/-xalarm or -icsAlarm true/false
2040 @cindex alarm, option
2041 @cindex icsAlarm, option
2042 Sets the ICS Alarm menu option.  @xref{Options Menu}. Default: true.
2043 @item -icsAlarmTime ms
2044 @cindex icsAlarmTime, option
2045 Sets the time in milliseconds for the ICS Alarm menu option.
2046 @xref{Options Menu}. Default: 5000.
2047 @item lowTimeWarning true/false
2048 @cindex lowTimeWarning, option
2049 Controls a color change of the board as a warning your time is running out.
2050 @xref{Options Menu}. Default: false.
2051 @item -pre/-xpre \fRor\fB -premove true/false
2052 @cindex pre, option
2053 @cindex premove, option
2054 Sets the Premove menu option. @xref{Options Menu}. Default: true.
2055 @item -quiet/-xquiet or -quietPlay true/false
2056 @cindex quiet, option
2057 @cindex quietPlay, option
2058 Sets the Quiet Play menu option.  @xref{Options Menu}.  Default: false.
2059 @item -colorizeMessages or -colorize
2060 @cindex Colors
2061 @cindex colorize, option
2062 Setting colorizeMessages
2063 to true tells XBoard to colorize the messages received from
2064 the ICS.  Colorization works only if your xterm 
2065 supports ISO 6429 escape sequences for changing text colors.
2066 @item -colorShout foreground,background,bold
2067 @itemx -colorSShout foreground,background,bold
2068 @itemx -colorChannel1 foreground,background,bold
2069 @itemx -colorChannel foreground,background,bold
2070 @itemx -colorKibitz foreground,background,bold
2071 @itemx -colorTell foreground,background,bold
2072 @itemx -colorChallege foreground,background,bold
2073 @itemx -colorRequest foreground,background,bold
2074 @itemx -colorSeek foreground,background,bold
2075 @itemx -colorNormal foreground,background,bold
2076 @cindex Colors
2077 @cindex colorShout, option
2078 @cindex colorSShout, option
2079 @cindex colorChannel1, option
2080 @cindex colorChannel, option
2081 @cindex colorKibitz, option
2082 @cindex colorTell, option
2083 @cindex colorChallenge, option
2084 @cindex colorRequest, option
2085 @cindex colorSeek, option
2086 @cindex colorNormal, option
2087 These options set the colors used when colorizing ICS messages.
2088 All ICS messages are grouped into one of these categories:
2089 shout, sshout, channel 1, other channel, kibitz, tell, challenge, 
2090 request (including abort, adjourn, draw, pause, and takeback), or
2091 normal (all other messages).  
2093 Each foreground or background argument can be one of the following:
2094 black, red, green, yellow, blue, magenta, cyan, white, or default.
2095 Here ``default'' means the default foreground or background color of
2096 your xterm.  Bold can be 1 or 0.  If background is omitted, ``default''
2097 is assumed; if bold is omitted, 0 is assumed.
2099 Here is an example of how to set the colors in your @file{.Xresources} file.
2100 The colors shown here are the default values; you will get
2101 them if you turn @code{-colorize} on without specifying your own colors.
2103 @example
2104 xboard*colorizeMessages: true   
2105 xboard*colorShout: green
2106 xboard*colorSShout: green, black, 1
2107 xboard*colorChannel1: cyan
2108 xboard*colorChannel: cyan, black, 1
2109 xboard*colorKibitz: magenta, black, 1
2110 xboard*colorTell: yellow, black, 1
2111 xboard*colorChallenge: red, black, 1
2112 xboard*colorRequest: red
2113 xboard*colorSeek: blue
2114 xboard*colorNormal: default
2115 @end example
2116 @item -soundProgram progname
2117 @cindex soundProgram, option
2118 @cindex Sounds
2119 If this option is set to a sound-playing program that is installed and
2120 working on your system, XBoard can play sound files when certain
2121 events occur, listed below.  The default program name is "play".  If
2122 any of the sound options is set to "$", the event rings the terminal
2123 bell by sending a ^G character to standard output, instead of playing
2124 a sound file.  If an option is set to the empty string "", no sound is
2125 played for that event.
2126 @item -soundDirectory directoryname
2127 @cindex soundDirectory, option
2128 @cindex Sounds
2129 This option specifies where XBoard will look for sound files,
2130 when these are not given as an absolute path name.
2131 @item -soundShout filename
2132 @itemx -soundSShout filename
2133 @itemx -soundChannel filename
2134 @itemx -soundKibitz filename
2135 @itemx -soundTell filename
2136 @itemx -soundChallenge filename
2137 @itemx -soundRequest filename
2138 @itemx -soundSeek filename
2139 @cindex soundShout, option
2140 @cindex soundSShout, option
2141 @cindex soundChannel, option
2142 @cindex soundKibitz, option
2143 @cindex soundTell, option
2144 @cindex soundChallenge, option
2145 @cindex soundRequest, option
2146 @cindex soundSeek, option
2147 These sounds are triggered in the same way as the colorization events
2148 described above.  They all default to "", no sound.  They are played
2149 only if the colorizeMessages is on.
2150 @item -soundMove filename
2151 @cindex soundMove, option
2152 This sound is used by the Move Sound menu option.  Default: "$".
2153 @item -soundIcsAlarm filename
2154 @cindex soundIcsAlarm, option
2155 This sound is used by the ICS Alarm menu option.  Default: "$".
2156 @item -soundIcsWin filename
2157 @cindex soundIcsWin, option
2158 This sound is played when you win an ICS game.  Default: "" (no sound).
2159 @item -soundIcsLoss filename
2160 @cindex soundIcsLoss, option
2161 This sound is played when you lose an ICS game.  Default: "" (no sound).
2162 @item -soundIcsDraw filename
2163 @cindex soundIcsDraw, option
2164 This sound is played when you draw an ICS game.  Default: "" (no sound).
2165 @item -soundIcsUnfinished filename
2166 @cindex soundIcsUnfinished, option
2167 This sound is played when an ICS game that you are participating in is
2168 aborted, adjourned, or otherwise ends inconclusively.  Default: "" (no
2169 sound).
2171 Here is an example of how to set the sounds in your @file{.Xresources} file:
2173 @example
2174 xboard*soundShout: shout.wav
2175 xboard*soundSShout: sshout.wav
2176 xboard*soundChannel1: channel1.wav
2177 xboard*soundChannel: channel.wav
2178 xboard*soundKibitz: kibitz.wav
2179 xboard*soundTell: tell.wav
2180 xboard*soundChallenge: challenge.wav
2181 xboard*soundRequest: request.wav
2182 xboard*soundSeek: seek.wav
2183 xboard*soundMove: move.wav
2184 xboard*soundIcsWin: win.wav
2185 xboard*soundIcsLoss: lose.wav
2186 xboard*soundIcsDraw: draw.wav
2187 xboard*soundIcsUnfinished: unfinished.wav
2188 xboard*soundIcsAlarm: alarm.wav
2189 @end example
2190 @item -dropMenu true|false
2191 @cindex dropMenu, option
2192 This option allows you to emulate old behavior, 
2193 where the right mouse button brings up the (now deprecated) drop menu 
2194 rather than displaying the position at the end of the principal variation. 
2195 Default: False.
2196 @item -pieceMenu true|false
2197 @cindex pieceMenu, option
2198 This option allows you to emulate old behavior, 
2199 where the right mouse button brings up the (now deprecated) piece menu
2200 in Edit Position mode.
2201 From this menu you can select the piece to put on the square you
2202 clicked to bring up the menu,
2203 or select items such as @kbd{clear board}.
2204 You can also @kbd{promote} or @kbd{demote} a clicked piece to convert
2205 it into an unorthodox piece that is not directly in the menu,
2206 or give the move to @kbd{black} or @kbd{white}.
2207 @item -variations true|false
2208 @cindex variations, option
2209 When this option is on, you can start new variations in Edit Game or
2210 Analyze mode by holding the Shift key down while entering a move.
2211 When it is off, the Shift key will be ignored.
2212 Default: False.
2213 @end table
2215 @node Load and Save options
2216 @section Load and Save options
2217 @cindex Options, Load and Save
2218 @cindex Load and Save options
2219 @table @asis
2220 @item -lgf or -loadGameFile file
2221 @itemx -lgi or -loadGameIndex index
2222 @cindex lgf, option
2223 @cindex loadGameFile, option
2224 @cindex lgi, option
2225 @cindex loadGameIndex, option
2226 If the @code{loadGameFile} option is set, XBoard loads the specified
2227 game file at startup. The file name @file{-} specifies the standard
2228 input. If there is more than one game in the file, XBoard
2229 pops up a menu of the available games, with entries based on their PGN 
2230 (Portable Game Notation) tags.
2231 If the @code{loadGameIndex} option is set to @samp{N}, the menu is suppressed
2232 and the N th game found in the file is loaded immediately.
2233 The menu is also suppressed if @code{matchMode} is enabled or if the game file
2234 is a pipe; in these cases the first game in the file is loaded immediately.
2235 Use the @file{pxboard} shell script provided with XBoard if you
2236 want to pipe in files containing multiple games and still see the menu.
2237 If the loadGameIndex specifies an index -1, this triggers auto-increment
2238 of the index in @code{matchMode}, which means that after every game the
2239 index is incremented by one, causing each game of the match to be played
2240 from the next game in the file. Similarly, specifying an index value of -2
2241 causes the index to be incremented every two games, so that each game
2242 in the file is used twice (with reversed colors).
2243 The @code{rewindIndex} option causes the index to be reset to the
2244 first game of the file when it has reached a specified value.
2245 @item -rewindIndex n
2246 Causes a position file or game file to be rewound to its beginning after n
2247 positions or games in auto-increment @code{matchMode}. 
2248 See @code{loadPositionIndex} and @code{loadGameIndex}.
2249 default: 0 (no rewind).
2250 @item -td or -timeDelay seconds
2251 @cindex td, option
2252 @cindex timeDelay, option
2253 Time delay between moves during @samp{Load Game} or @samp{Analyze File}. 
2254 Fractional seconds are allowed; try @samp{-td 0.4}. 
2255 A time delay value of -1 tells
2256 XBoard not to step through game files automatically. Default: 1 second.
2257 @item -sgf or -saveGameFile file
2258 @cindex sgf, option
2259 @cindex saveGameFile, option
2260 If this option is set, XBoard appends a record of every game
2261 played to the specified file. The file name @file{-} specifies the
2262 standard output.
2263 @item -autosave/-xautosave or -autoSaveGames true/false
2264 @cindex autosave, option
2265 @cindex autoSaveGames, option
2266 Sets the Auto Save menu option.  @xref{Options Menu}.  Default: false.
2267 Ignored if @code{saveGameFile} is set.
2268 @item -lpf or -loadPositionFile file
2269 @itemx -lpi or -loadPositionIndex index
2270 @cindex lpf, option
2271 @cindex loadPositionFile, option
2272 @cindex lpi, option
2273 @cindex loadPositionIndex, option
2274 If the @code{loadPositionFile} option is set, XBoard loads the
2275 specified position file at startup. The file name @file{-} specifies the
2276 standard input. If the @code{loadPositionIndex} option is set to N,
2277 the Nth position found in the file is loaded; otherwise the
2278 first position is loaded.
2279 If the loadPositionIndex specifies an index -1, this triggers auto-increment
2280 of the index in @code{matchMode}, which means that after every game the
2281 index is incremented by one, causing each game of the match to be played
2282 from the next position in the file. Similarly, specifying an index value of -2
2283 causes the index to be incremented every two games, so that each position
2284 in the file is used twice (with the engines playing opposite colors).
2285 The @code{rewindIndex} option causes the index to be reset to the
2286 first position of the file when it has reached a specified value.
2287 @item -spf or -savePositionFile file
2288 @cindex spf, option
2289 @cindex savePositionFile, option
2290 If this option is set, XBoard appends the final position reached
2291 in every game played to the specified file. The file name @file{-}
2292 specifies the standard output.
2293 @item -pgnExtendedInfo true/false
2294 @cindex pgnExtendedInfo, option`
2295 If this option is set, XBoard saves depth, score and time used for each 
2296 move that the engine found as a comment in the PGN file.
2297 Default: false.
2298 @item -pgnEventHeader string
2299 @cindex pgnEventHeader, option`
2300 Sets the name used in the PGN event tag to string. 
2301 Default: "Computer Chess Game".
2302 @item -saveOutOfBookInfo true/false
2303 @cindex saveOutOfBookInfo, option`
2304 Include the information on how the engine(s) game out of its opening book 
2305 in a special 'annotator' tag with the PGN file.
2306 @item -oldsave/-xoldsave or -oldSaveStyle true/false
2307 @cindex oldsave, option
2308 @cindex oldSaveStyle, option
2309 Sets the Old Save Style menu option.  @xref{Options Menu}.  Default: false.
2310 @item -gameListTags string
2311 @cindex gameListTags, option
2312 The character string lists the PGN tags that should be printed in the
2313 Game List, and their order. The meaning of the codes is e=event,
2314 s=site, d=date, o=round, p=players, r=result, w=white Elo, b=black Elo,
2315 t=time control, v=variant, a=out-of-book info, c=result comment.
2316 Default: "eprd"
2317 @item -ini or -settingsFile filename
2318 @itemx -saveSettingsFile filename
2319 @itemx @@filename
2320 @cindex saveSettingsFile, option
2321 @cindex SettingsFile, option
2322 @cindex init, option
2323 @cindex at sign, option
2324 When XBoard encounters an option -settingsFile (or -ini for short),
2325 or @@filename, it tries to read the mentioned file,
2326 and substitutes the contents of it (presumaby more command-line options)
2327 in place of the option.
2328 In the case of -ini or -settingsFile, the name of a successfully read
2329 settings file is also remembered as the file to use for saving settings
2330 (automatically on exit, or on user command).
2331 An option of the form @@filename does not affect saving.
2332 The option -saveSettingsFile does specify a name of the file to use
2333 for saving, without reading any options from it, and is thus also effective
2334 when the file did not exist yet.
2335 So the settings will be saved to the file specified in the last
2336 -saveSettingsFile or succesfull -settingsFile / -ini command,
2337 if any, and in /etc/xboard/xboard.conf otherwise.
2338 Usualy the latter is only accessible for the system administrator, though, 
2339 and will be used to contain system-wide default setings, amongst which
2340 a -saveSettingsFile and -settingsFile options to specify a settings file
2341 accessible to the individual user, such as ~/.xboardrc in the user's
2342 home directory.
2343 @end table
2345 @node User interface options
2346 @section User interface options
2347 @cindex User interface options
2348 @cindex Options, User interface
2349 @table @asis
2350 @item -display
2351 @itemx -geometry
2352 @itemx -iconic
2353 @cindex display, option
2354 @cindex geometry, option
2355 @cindex iconic, option
2356 These and most other standard Xt options are accepted.
2357 @item -noGUI
2358 @cindex noGUI, option
2359 Suppresses all GUI functions of XBoard 
2360 (to speed up automated ultra-fast engine-engine games, which you don\92t want to watch). 
2361 There will be no board or clock updates, no printing of moves, 
2362 and no update of the icon on the task bar in this mode.
2363 @item -movesound/-xmovesound or -ringBellAfterMoves true/false
2364 @cindex movesound, option
2365 @cindex bell, option
2366 @cindex ringBellAfterMoves, option
2367 Sets the Move Sound menu option.  @xref{Options Menu}.  Default: false.
2368 For compatibility with old XBoard versions, -bell/-xbell are also 
2369 accepted as abbreviations for this option.
2370 @item -exit/-xexit or -popupExitMessage true/false
2371 @cindex exit, option
2372 @cindex popupExitMessage, option
2373 Sets the Popup Exit Message menu option.  @xref{Options Menu}. Default: true.
2374 @item -popup/-xpopup or -popupMoveErrors true/false
2375 @cindex popup, option
2376 @cindex popupMoveErrors, option
2377 Sets the Popup Move Errors menu option.  @xref{Options Menu}. Default: false.
2378 @item -queen/-xqueen or -alwaysPromoteToQueen true/false
2379 @cindex queen, option
2380 @cindex alwaysPromoteToQueen, option
2381 Sets the Always Queen menu option.  @xref{Options Menu}.  Default: false.
2382 @item -sweepPromotions true/false
2383 @cindex sweepPromotion, option
2384 Sets the Almost Always Promote to Queen menu option.  
2385 @xref{Options Menu}.  Default: false.
2386 @item -legal/-xlegal or -testLegality true/false
2387 @cindex legal, option
2388 @cindex testLegality, option
2389 Sets the Test Legality menu option.  @xref{Options Menu}.  Default: true.
2390 @item -size or -boardSize (sizeName | n1,n2,n3,n4,n5,n6,n7)
2391 @cindex size, option
2392 @cindex boardSize, option
2393 @cindex board size
2394 Determines how large the board will be, by selecting the pixel size
2395 of the pieces and setting a few related parameters.
2396 The sizeName can be one of: Titanic, giving 129x129 pixel pieces,
2397 Colossal 116x116, Giant 108x108, Huge 95x95, Big 87x87, Large 80x80, Bulky 72x72,
2398 Medium 64x64, Moderate 58x58, Average 54x54, Middling 49x49, Mediocre
2399 45x45, Small 40x40, Slim 37x37, Petite 33x33, Dinky 29x29, Teeny 25x25,
2400 or Tiny 21x21.
2401 Orthodox pieces of all these sizes are built into XBoard.
2402 Other sizes can
2403 be used if you have them; see the pixmapDirectory and bitmapDirectory
2404 options.
2405 Complete sets of un-orthodox pieces are only provided in sizes
2406 Bulky, Middling and (to a lesser extent) Petite;
2407 Archbishop, Marshall and Amazon are also available in all sizes between
2408 Bulky and Petite.
2409 When no bitmap is available, the piece will be displayed as Amazon or King.
2410 The default depends on the size of your screen; it is approximately the
2411 largest size that will fit without clipping.
2413 You can select other sizes or vary other layout parameters by providing
2414 a list of comma-separated values (with no spaces) as the argument.
2415 You do not need to provide all the values; for any you omit from the
2416 end of the list, defaults are taken from the nearest built-in size.
2417 The value @code{n1} gives the piece size, @code{n2} the width of the
2418 black border
2419 between squares, @code{n3} the desired size for the 
2420 clockFont, @code{n4} the desired size for the coordFont,
2421 @code{n5} the desired size for the default font,
2422 @code{n6} the smallLayout flag (0 or 1), 
2423 and @code{n7} the tinyLayout flag (0 or 1).  
2424 All dimensions are in pixels.
2425 If the border between squares is eliminated (0 width), the various
2426 highlight options will not work, as there is nowhere to draw the highlight.
2427 If smallLayout is 1 and @code{titleInWindow} is true, 
2428 the window layout is rearranged to make more room for the title.
2429 If tinyLayout is 1, the labels on the menu bar are abbreviated
2430 to one character each and the buttons in the button bar are made narrower.
2431 @item -coords/-xcoords or -showCoords true/false
2432 @cindex coords, option
2433 @cindex showCoords, option
2434 Sets the Show Coords menu option.  @xref{Options Menu}.  Default: false.
2435 The @code{coordFont} option specifies what font to use.
2436 @item -autoraise/-xautoraise or -autoRaiseBoard true/false
2437 @cindex autoraise, option
2438 @cindex autoRaiseBoard, option
2439 Sets the Auto Raise Board menu option.  @xref{Options Menu}.  Default: true.
2440 @item -autoflip/-xautoflip or -autoFlipView true/false
2441 @cindex autoflip, option
2442 @cindex autoFlipView, option
2443 Sets the Auto Flip View menu option.  @xref{Options Menu}.  Default: true.
2444 @item -flip/-xflip or -flipView true/false
2445 @cindex flip, option
2446 @cindex flipView, option
2447 If Auto Flip View is not set, or if you are observing but not participating
2448 in a game, then the positioning of the board at the start of each game
2449 depends on the flipView option.  If flipView is false (the default),
2450 the board is positioned so that the white pawns move from the bottom to the
2451 top; if true, the black pawns move from the bottom to the top.
2452 In any case, the Flip menu option (see @ref{Options Menu})
2453 can be used to flip the board after
2454 the game starts.
2455 @item -title/-xtitle or -titleInWindow true/false
2456 @cindex title, option
2457 @cindex titleInWindow, option
2458 If this option is true, XBoard displays player names (for ICS
2459 games) and game file names (for @samp{Load Game}) inside its main
2460 window. If the option is false (the default), this information is
2461 displayed only in the window banner. You probably won't want to
2462 set this option unless the information is not showing up in the
2463 banner, as happens with a few X window managers.
2464 @item -buttons/-xbuttons or -showButtonBar True/False
2465 @cindex buttons, option
2466 @cindex showButtonBar, option
2467 If this option is False, xboard omits the [<<] [<] [P] [>] [>>] button
2468 bar from the window, allowing the message line to be wider.  You can
2469 still get the functions of these buttons using the menus or their keyboard
2470 shortcuts.  Default: true.
2471 @item -mono/-xmono or -monoMode true/false
2472 @cindex mono, option
2473 @cindex monoMode, option
2474 Determines whether XBoard displays its pieces and squares with
2475 two colors (true) or four (false). You shouldn't have to
2476 specify @code{monoMode}; XBoard will determine if it is necessary.
2477 @item -showTargetSquares true/false
2478 @cindex showTargetSquares, option
2479 Determines whether XBoard can highlight the squares a piece has
2480 legal moves to, when you grab that piece with the mouse.
2481 If this option is set, this feature can be controlled through
2482 the Highlight Dragging menu item.
2483 @item -flashCount count
2484 @itemx -flashRate rate
2485 @itemx -flash/-xflash
2486 @cindex flashCount, option
2487 @cindex flashRate, option
2488 @cindex flash, option
2489 @cindex xflash, option
2490 These options enable flashing of pieces when they
2491 land on their destination square.
2492 @code{flashCount}
2493 tells XBoard how many times to flash a piece after it
2494 lands on its destination square.
2495 @code{flashRate}
2496 controls the rate of flashing (flashes/sec).
2497 Abbreviations:
2498 @code{flash}
2499 sets flashCount to 3.
2500 @code{xflash}
2501 sets flashCount to 0.
2502 Defaults:  flashCount=0 (no flashing), flashRate=5.
2503 @item -highlight/-xhighlight or -highlightLastMove true/false
2504 @cindex highlight, option
2505 @cindex highlightLastMove, option
2506 Sets the Highlight Last Move menu option. @xref{Options Menu}. Default: false.
2507 @item -highlightMoveWithArrow true/false
2508 @cindex highlight Arrow, option
2509 @cindex highlightMoveWithArrow, option
2510 Sets the Highlight with Arrow menu option. @xref{Options Menu}. Default: false.
2511 @item -blind/-xblind or -blindfold true/false
2512 @cindex blind, option
2513 @cindex blindfold, option
2514 Sets the Blindfold menu option.  @xref{Options Menu}.  Default: false.
2515 @item -clockFont font
2516 @cindex clockFont, option
2517 @cindex Font, clock
2518 The font used for the clocks. If the option value is a pattern
2519 that does not specify the font size, XBoard tries to choose an
2520 appropriate font for the board size being used.
2521 Default: -*-helvetica-bold-r-normal--*-*-*-*-*-*-*-*.
2522 @item -coordFont font
2523 @cindex coordFont, option
2524 @cindex Font, coordinates
2525 The font used for rank and file coordinate labels if @code{showCoords}
2526 is true. If the option value is a pattern that does not specify
2527 the font size, XBoard tries to choose an appropriate font for
2528 the board size being used.
2529 Default: -*-helvetica-bold-r-normal--*-*-*-*-*-*-*-*.
2530 @item -font font
2531 @cindex font, option
2532 @cindex Font
2533 The font used for popup dialogs, menus, comments, etc.
2534 If the option value is a pattern that does not specify
2535 the font size, XBoard tries to choose an appropriate font for
2536 the board size being used.
2537 Default: -*-helvetica-medium-r-normal--*-*-*-*-*-*-*-*.
2538 @item -fontSizeTolerance tol
2539 @cindex fontSizeTolerance, option
2540 In the font selection algorithm, a nonscalable font will be preferred
2541 over a scalable font if the nonscalable font's size differs
2542 by @code{tol} pixels
2543 or less from the desired size.  A value of -1 will force
2544 a scalable font to always be used if available; a value of 0 will
2545 use a nonscalable font only if it is exactly the right size; 
2546 a large value (say 1000) will force a nonscalable font to always be
2547 used if available.  Default: 4.
2548 @item -bm or -bitmapDirectory dir
2549 @itemx -pixmap or -pixmapDirectory dir
2550 @cindex bm, option
2551 @cindex bitmapDirectory, option
2552 @cindex pixmap, option
2553 @cindex pixmapDirectory, option
2554 These options control what piece images xboard uses.  The XBoard
2555 distribution includes one set of pixmap pieces in xpm format, in the
2556 directory @file{pixmaps}, and one set of bitmap pieces in xbm format,
2557 in the directory @file{bitmaps}.  Pixmap
2558 pieces give a better appearance on the screen: the white pieces have
2559 dark borders, and the black pieces have opaque internal details.  With
2560 bitmaps, neither piece color has a border, and the internal details
2561 are transparent; you see the square color or other background color
2562 through them.
2564 If XBoard is configured and compiled on a system that includes libXpm,
2565 the X pixmap library, the xpm pixmap pieces are compiled in as the
2566 default.  A different xpm piece set can be selected at runtime with
2567 the @code{pixmapDirectory} option, or a bitmap piece set can be selected
2568 with the @code{bitmapDirectory} option.
2570 If XBoard is configured and compiled on a system that does not include
2571 libXpm (or the @code{--disable-xpm} option is given to the configure
2572 program), the bitmap pieces are compiled in as the default.  It is not
2573 possible to use xpm pieces in this case, but pixmap pieces in another
2574 format called "xim" can be used by giving the @code{pixmapDirectory} option.
2575 Or again, a different bitmap piece set can be selected with the
2576 @code{bitmapDirectory} option.
2578 Files in the @code{bitmapDirectory} must be named as follows:
2579 The first character of a piece bitmap name gives the piece it 
2580 represents (@samp{p}, @samp{n}, @samp{b}, @samp{r}, @samp{q}, or @samp{k}),
2581 the next characters give the size in pixels, the
2582 following character indicates whether the piece is
2583 solid or outline (@samp{s} or @samp{o}),
2584 and the extension is @samp{.bm}.
2585 For example, a solid 80x80 knight would be named @file{}.
2586 The outline bitmaps are used only in monochrome mode.
2587 If bitmap pieces are compiled in and the bitmapDirectory is missing
2588 some files, the compiled in pieces are used instead.
2590 If the bitmapDirectory option is given,
2591 it is also possible to replace xboard's icons and menu checkmark,
2592 by supplying files named @file{}, @file{}, and
2593 @file{}.
2595 For more information about pixmap pieces and how to get additional
2596 sets, see @ref{zic2xpm} below.
2597 @item -whitePieceColor color
2598 @itemx -blackPieceColor color
2599 @itemx -lightSquareColor color
2600 @itemx -darkSquareColor color
2601 @itemx -highlightSquareColor color
2602 @itemx -lowTimeWarningColor color
2603 @cindex Colors
2604 @cindex whitePieceColor, option
2605 @cindex blackPieceColor, option
2606 @cindex lightSquareColor, option
2607 @cindex darkSquareColor, option
2608 @cindex highlightSquareColor, option
2609 @cindex lowTimeWarningColor, option
2610 Colors to use for the pieces, squares, and square highlights.
2611 Defaults:
2613 @example
2614 -whitePieceColor       #FFFFCC
2615 -blackPieceColor       #202020
2616 -lightSquareColor      #C8C365
2617 -darkSquareColor       #77A26D
2618 -highlightSquareColor  #FFFF00
2619 -premoveHighlightColor #FF0000
2620 -lowTimeWarningColor   #FF0000
2621 @end example
2623 On a grayscale monitor you might prefer:
2625 @example
2626 -whitePieceColor       gray100
2627 -blackPieceColor       gray0
2628 -lightSquareColor      gray80
2629 -darkSquareColor       gray60
2630 -highlightSquareColor  gray100
2631 -premoveHighlightColor gray70
2632 -lowTimeWarningColor   gray70
2633 @end example
2634 @item -drag/-xdrag or -animateDragging true/false
2635 @cindex drag, option
2636 @cindex animateDragging, option
2637 Sets the Animate Dragging menu option. @xref{Options Menu}.  Default: true.
2638 @item -animate/-xanimate or -animateMoving true/false
2639 @cindex animate, option
2640 @cindex animateMoving, option
2641 Sets the Animate Moving menu option. @xref{Options Menu}.  Default: true.
2642 @item -animateSpeed n
2643 @cindex -animateSpeed, option
2644 Number of milliseconds delay between each animation frame when Animate
2645 Moves is on.
2646 @item -autoDisplayComment true/false
2647 @itemx -autoDisplayTags true/false
2648 @cindex -autoDisplayComment, option
2649 @cindex -autoDisplayTags, option
2650 If set to true, these options cause the window with the move comments,
2651 and the window with PGN tags, respectively, to pop up automatically when
2652 such tags or comments are encountered during the replaying a stored or
2653 loaded game.  Default: true.
2654 @item -pasteSelection true/false
2655 @cindex -pasteSelection, option
2656 If this option is set to true, the Paste Position and Paste Game
2657 options paste from the currently selected text.  If false, they paste
2658 from the clipboard.  Default: false.
2659 @end table
2661 @node Adjudication Options
2662 @section Adjudication Options
2663 @cindex Options, adjudication
2664 @table @asis
2665 @item -adjudicateLossThreshold n
2666 @cindex adjudicateLossThreshold, option
2667 If the given value is non-zero, XBoard adjudicates the game as a loss 
2668 if both engines agree for a duration of 6 consecutive ply that the score 
2669 is below the given score threshold for that engine. Make sure the score 
2670 is interpreted properly by XBoard, 
2671 using @code{-firstScoreAbs} and @code{-secondScoreAbs} if needed. 
2672 Default: 0 (no adjudication)
2673 @item -adjudicateDrawMoves n
2674 @cindex adjudicateDrawMoves, option
2675 If the given value is non-zero, XBoard adjudicates the game as a draw 
2676 if after the given number of moves it was not yet decided. Default: 0 (no adjudication)
2677 @item -checkMates true/false
2678 @cindex checkMates, option
2679 If this option is set, XBoard detects all checkmates and stalemates, 
2680 and ends the game as soon as they occur. 
2681 Legality-testing must be switched on for this option to work.
2682 Default: true
2683 @item -testClaims true/false
2684 @cindex testClaims, option
2685 If this option is set, XBoard verifies all result claims made by engines, 
2686 and those who send false claims will forfeit the game because of it. 
2687 Legality-testing must be switched on for this option to work. Default: true
2688 @item -materialDraws true/false
2689 @cindex materialDraws, option
2690 If this option is set, XBoard adjudicates games as draws when there is 
2691 no sufficient material left to inflict a checkmate. 
2692 This applies to KBKB with like bishops (any number, actually), and to KBK, KNK and KK. 
2693 Legality-testing must be switched on for this option to work. Default: true
2694 @item -trivialDraws true/false
2695 @cindex trivialDraws, option
2696 If this option is set, XBoard adjudicates games as draws that cannot be 
2697 usually won without opponent cooperation. This applies to KBKB with unlike bishops, 
2698 and to KBKN, KNKN, KNNK, KRKR and KQKQ. The draw is called after 6 ply into these end-games, 
2699 to allow quick mates that can occur in some exceptional positions to be found by the engines. 
2700 KQKQ does not really belong in this category, and might be taken out in the future. 
2701 (When bitbase-based adjudications are implemented.) 
2702 Legality-testing must be on for this option to work. Default: false
2703 @item -ruleMoves n
2704 @cindex ruleMoves, option
2705 If the given value is non-zero, XBoard adjudicates the game as a draw after the given 
2706 number of consecutive reversible moves. Engine draw claims are always accepted after 50 moves, 
2707 irrespective of the given value of n.
2708 @item -repeatsToDraw n
2709 If the given value is non-zero, xboard adjudicates the game as a draw if a position 
2710 is repeated the given number of times. Engines draw claims are always accepted after 3 repeats, 
2711 (on the 3rd occurrence, actually), irrespective of the value of n. 
2712 Beware that positions that have different castling or en-passant rights do not count 
2713 as repeats, XBoard is fully e.p. and castling aware!
2714 @end table
2716 @node Other options
2717 @section Other options
2718 @cindex Options, miscellaneous
2719 @table @asis
2720 @item -ncp/-xncp or -noChessProgram true/false
2721 @cindex ncp, option
2722 @cindex noChessProgram, option
2723 If this option is true, XBoard acts as a passive chessboard; it
2724 does not start a chess engine at all. Turning on this option
2725 also turns off clockMode. Default: false.
2726 @item -mode or -initialMode modename
2727 @cindex mode, option
2728 @cindex initalMode, option
2729 If this option is given, XBoard selects the given modename
2730 from the Mode menu after starting and (if applicable) processing the
2731 loadGameFile or loadPositionFile option. Default: "" (no selection). 
2732 Other supported values are 
2733 MachineWhite, MachineBlack, TwoMachines, Analysis, 
2734 AnalyzeFile, EditGame, EditPosition, and Training.
2735 @item -variant varname
2736 @cindex variant, option
2737 Activates preliminary, partial support for playing chess variants
2738 against a local engine or editing variant games.  This flag is not
2739 needed in ICS mode.  Recognized variant names are:
2741 @example
2742 normal        Normal chess
2743 wildcastle    Shuffle chess, king can castle from d file
2744 nocastle      Shuffle chess, no castling allowed
2745 fischerandom  Fischer Random shuffle chess
2746 bughouse      Bughouse, ICC/FICS rules
2747 crazyhouse    Crazyhouse, ICC/FICS rules
2748 losers        Lose all pieces or get mated (ICC wild 17)
2749 suicide       Lose all pieces including king (FICS)
2750 giveaway      Try to have no legal moves (ICC wild 26)
2751 twokings      Weird ICC wild 9
2752 kriegspiel    Opponent's pieces are invisible
2753 atomic        Capturing piece explodes (ICC wild 27)
2754 3check        Win by giving check 3 times (ICC wild 25)
2755 shatranj      An ancient precursor of chess (ICC wild 28)
2756 xiangqi       Chinese Chess (on a 9x10 board)
2757 shogi         Japanese Chess (on a 9x9 board & piece drops) 
2758 capablanca    Capablanca Chess (10x8 board, with Archbishop 
2759               and Chancellor pieces)
2760 gothic        similar, with a better initial position
2761 caparandom    An FRC-like version of Capablanca Chess (10x8) 
2762 janus         A game with two Archbishops (10x8 board)
2763 courier       Medieval intermediate between shatranj and 
2764               modern Chess (on 12x8 board) 
2765 falcon        Patented 10x8 variant with two Falcon pieces
2766 berolina      Pawns capture straight ahead, and move diagonal 
2767 cylinder      Pieces wrap around the board edge
2768 knightmate    King moves as Knight, and vice versa 
2769 super         Superchess (shuffle variant with 4 exo-pieces)
2770 makruk        Thai Chess (shatranj-like, P promotes on 6th rank)
2771 spartan       Spartan Chess (black has unorthodox pieces)
2772 fairy         A catchall variant in which all piece types 
2773               known to XBoard can participate (8x8)
2774 unknown       Catchall for other unknown variants
2775 @end example
2778 UN-ORTHODOX PIECES, though. Only in @code{boardSize} middling and bulky
2779 all 22 piece types are provided, while -boardSize petite has most
2780 of them. Archbishop, Chancellor and Amazon are supported in every
2781 size from petite to bulky. Kings or Amazons are substituted for
2782 missing bitmaps. You can still play variants needing un-orthodox
2783 pieces in other board sizes providing your own bitmaps through the
2784 @code{bitmapDirectory} or @code{pixmapDirectory} options.
2786 In the shuffle variants, XBoard now does shuffle the pieces, although
2787 you can still do it by hand using Edit Position.  Some variants are
2788 supported only in ICS mode, including bughouse, and
2789 kriegspiel.  The winning/drawing conditions in crazyhouse (off-board
2790 interposition on mate) are not fully understood, but losers, suicide, 
2791 giveaway, atomic, and 3check should be OK.
2792 Berolina and cylinder chess can only be played with legality testing off.
2793 In crazyhouse, XBoard now does keep
2794 track of off-board pieces.  In shatranj it does implement the baring
2795 rule when mate detection is switched on.
2796 @item -boardHeight N
2797 @cindex boardHeight, option
2798 Allows you to set a non-standard number of board ranks in any variant. 
2799 If the height is given as -1, the default height for the variant is used.
2800 Default: -1
2801 @item -boardWidth N
2802 @cindex boardWidth, option
2803 Allows you to set a non-standard number of board files in any variant. 
2804 If the width is given as -1, the default width for the variant is used. 
2805 With a non-standard width, the initial position will always be an empty board, 
2806 as the usual opening array will not fit.
2807 Default: -1
2808 @item -holdingsSize N
2809 @cindex holdingsSize, option
2810 Allows you to set a non-standard size for the holdings in any variant. 
2811 If the size is given as -1, the default holdings size for the variant is used. 
2812 The first N piece types will go into the holdings on capture, and you will be 
2813 able to drop them on the board in stead of making a normal move. If size equals 0, 
2814 there will be no holdings.
2815 Default: -1
2816 @item -defaultFrcPosition N
2817 @cindex defaultFrcPosition, option
2818 Specifies the number of the opening position in shuffle games like Chess960. 
2819 A value of -1 means the position is randomly generated by XBoard
2820 at the beginning of every game.
2821 Default: -1
2822 @item -pieceToSquareTable string
2823 @cindex pieceToSquareTable, option
2824 The characters that are used to represent the piece types XBoard knows in FEN 
2825 diagrams and SAN moves. The string argument has to have an even length 
2826 (or it will be ignored), as white and black pieces have to be given separately 
2827 (in that order). The last letter for each color will be the King. 
2828 The letters before that will be PNBRQ and then a whole host of fairy pieces 
2829 in an order that has not fully crystallized yet (currently FEACWMOHIJGDVSLU, 
2830 F=Ferz, Elephant, A=Archbishop, C=Chancellor, W=Wazir, M=Commoner, O=Cannon, 
2831 H=Nightrider). You should list at least all pieces that occur in the variant 
2832 you are playing. If you have less than 44 characters in the string, the pieces 
2833 not mentioned will get assigned a period, and you will not be able to distinguish 
2834 them in FENs. You can also explicitly assign pieces a period, in which case they 
2835 will not be counted in deciding which captured pieces can go into the holdings.
2836 A tilde '~' as a piece name does mean this piece is used to represent a promoted 
2837 Pawn in crazyhouse-like games, i.e. on capture it turns back onto a Pawn. 
2838 A '+' similarly indicates the piece is a shogi-style promoted piece, that should 
2839 revert to its non-promoted version on capture (rather than to a Pawn).
2840 Note that promoted pieces are represented by pieces 11 further in the list.
2841 You should not have to use this option often: each variant has its own default 
2842 setting for the piece representation in FEN, which should be sufficient in normal use.
2843 Default: ""
2844 @item -debug/-xdebug or -debugMode true/false
2845 @cindex debug, option
2846 @cindex debugMode, option
2847 Turns on debugging printout.
2848 @item -debugFile filename or -nameOfDebugFile filename
2849 @cindex debugFile, option
2850 @cindex nameOfDebugFile, option
2851 Sets the name of the file to which XBoard saves debug information 
2852 (including all communication to and from the engines).
2853 @item -engineDebugOutput number
2854 @cindex engineDebugOutput, option
2855 Specifies how XBoard should handle unsolicited output from the engine, 
2856 with respect to saving it in the debug file. 
2857 The output is further (hopefully) ignored. 
2858 If number=0, XBoard refrains from writing such spurious output to the debug file. 
2859 If number=1, all engine output is written faithfully to the debug file. 
2860 If number=2, any protocol-violating line is prefixed with a '#' character, 
2861 as the engine itself should have done if it wanted to submit info for inclusion in the debug file.
2862 This option is provided for the benefit of applications that use the debug file 
2863 as a source of information, such as the broadcaster of live games TLCV / TLCS. 
2864 Such applications can be protected from spurious engine output that might otherwise confuse them.
2865 @item -rsh or -remoteShell shell-name
2866 @cindex rsh, option
2867 @cindex remoteShell, option
2868 Name of the command used to run programs remotely. The default
2869 is @file{rsh} or @file{remsh}, determined when XBoard is
2870 configured and compiled.
2871 @item -ruser or -remoteUser user-name
2872 @cindex ruser, option
2873 @cindex remoteUser, option
2874 User name on the remote system when running programs with the
2875 @code{remoteShell}. The default is your local user name.
2876 @item -userName username
2877 @cindex userName, option
2878 Name under which the Human player will be listed in the PGN file. 
2879 Default is the login name on your local computer.
2880 @item -delayBeforeQuit number
2881 @itemx -delayAfterQuit number
2882 @cindex delayBeforeQuit, option
2883 @cindex delayAfterQuit, option
2884 These options specify how long XBoard has to wait before sending a termination signal to rogue engine processes, that do not want to react to the 'quit' command. The second one determines the pause after killing the engine, to make sure it dies.
2886 @end table
2888 @node Chess Servers
2889 @chapter Chess Servers
2890 @cindex ICS
2891 @cindex ICS, addresses
2892 @cindex Internet Chess Server
2893 An @dfn{Internet Chess Server}, or @dfn{ICS}, is a place on the
2894 Internet where people can get together to play chess, watch other
2895 people's games, or just chat.  You can use either @code{telnet} or a
2896 client program like XBoard to connect to the server.  There are
2897 thousands of registered users on the different ICS hosts, and it is
2898 not unusual to meet 200 on both and
2900 Most people can just type @kbd{xboard -ics} to start XBoard as an ICS
2901 client.  Invoking XBoard in this way connects you to the Internet
2902 Chess Club (ICC), a commercial ICS.  You can log in there as a guest
2903 even if you do not have a paid account.  To connect to the largest
2904 Free ICS (FICS), use the command @kbd{xboard -ics -icshost}
2905 instead, or substitute a different host name to connect to your
2906 favorite ICS.
2907 For a full description of command-line options that control 
2908 the connection to ICS and change the default values of ICS options, see
2909 @ref{ICS options}.  
2911 While you are running XBoard as an ICS client,
2912 you use the terminal window that you started XBoard from
2913 as a place to type in commands and read information that is
2914 not available on the chessboard.
2916 The first time you need to use the terminal is to enter your login name
2917 and password, if you are a registered player. (You don't need to do
2918 this manually; the @code{icsLogon} option can do it for you.
2919 @pxref{ICS options}.)  If you are not registered, 
2920 enter @kbd{g} as your name, and the server will pick a
2921 unique guest name for you.
2923 Some useful ICS commands
2924 include
2925 @table @kbd
2926 @item help <topic>
2927 @cindex help, ICS command
2928 to get help on the given <topic>. To get a list of possible topics type
2929 @dfn{help} without topic.  Try the help command before you ask other
2930 people on the server for help.
2932 For example @kbd{help register} tells you how to become a registered
2933 ICS player.
2934 @item who <flags>
2935 @cindex who, ICS command
2936 to see a list of people who are logged on.  Administrators
2937 (people you should talk to if you have a problem) are marked
2938 with the character @samp{*}, an asterisk. The <flags> allow you to
2939 display only selected players: For example, @kbd{who of} shows a
2940 list of players who are interested in playing but do not have
2941 an opponent.
2942 @item games
2943 @cindex games, ICS command
2944 to see what games are being played
2945 @item match <player> [<mins>] [<inc>]
2946 to challenge another player to a game. Both opponents get <mins> minutes
2947 for the game, and <inc> seconds will be added after each move.
2948 If another player challenges you, the server asks if you want to
2949 accept the challenge; use the @kbd{accept} or @kbd{decline} commands
2950 to answer.
2951 @item accept
2952 @itemx decline
2953 @cindex accept, ICS command
2954 @cindex decline, ICS command
2955 to accept or decline another player's offer. 
2956 The offer may be to start a new game, or to agree to a 
2957 @kbd{draw}, @kbd{adjourn} or @kbd{abort} the current game. @xref{Action Menu}.
2959 If you have more than one pending offer (for example, if more than one player
2960 is challenging you, or if your opponent offers both a draw and to adjourn the
2961 game), you have to supply additional information, by typing something
2962 like @kbd{accept <player>}, @kbd{accept draw}, or @kbd{draw}.
2963 @item draw
2964 @itemx adjourn
2965 @itemx abort
2966 @cindex draw, ICS command
2967 @cindex adjourn, ICS command
2968 @cindex abort, ICS command
2969 asks your opponent to terminate a game by mutual agreement. Adjourned
2970 games can be continued later. 
2971 Your opponent can either @kbd{decline} your offer or accept it (by typing the
2972 same command or typing @kbd{accept}).  In some cases these commands work
2973 immediately, without asking your opponent to agree.  For example, you can
2974 abort the game unilaterally if your opponent is out of time, and you can claim
2975 a draw by repetition or the 50-move rule if available simply by typing 
2976 @kbd{draw}.
2977 @item finger <player>
2978 @cindex finger, ICS command
2979 to get information about the given <player>. (Default: yourself.)
2980 @item vars
2981 @cindex vars, ICS command
2982 to get a list of personal settings
2983 @item set <var> <value>
2984 @cindex set, ICS command
2985 to modify these settings
2986 @item observe <player>
2987 @cindex observe, ICS command
2988 to observe an ongoing game of the given <player>.
2989 @item examine
2990 @itemx oldmoves
2991 @cindex examine, ICS command
2992 @cindex oldmoves, ICS command
2993 to review a recently completed game
2994 @end table
2996 Some special XBoard features are activated when you are
2997 in examine mode on ICS.  See the descriptions of the menu commands
2998 @samp{Forward}, @samp{Backward}, @samp{Pause}, @samp{ICS Client}, 
2999 and @samp{Stop Examining} on the @ref{Edit Menu}, @ref{Mode Menu}, and
3000 @ref{Action Menu}.
3002 @node Firewalls
3003 @chapter Firewalls
3004 By default, XBoard communicates with an Internet Chess Server
3005 by opening a TCP socket directly from the machine it is running on
3006 to the ICS. If there is a firewall between your machine and the ICS,
3007 this won't work. Here are some recipes for getting around common
3008 kinds of firewalls using special options to XBoard.
3009 Important: See the paragraph in the below about extra echoes, in
3010 @ref{Limitations}.
3012 Suppose that you can't telnet directly to ICS, but you can telnet
3013 to a firewall host, log in, and then telnet from there to ICS.
3014 Let's say the firewall is called @samp{}. Set
3015 command-line options as follows:
3017 @example
3018 xboard -ics -icshost -icsport 23
3019 @end example
3020 @noindent
3021 Or in your @file{.Xresources} file:
3023 @example
3024 XBoard*internetChessServerHost:
3025 XBoard*internetChessServerPort: 23
3026 @end example
3027 @noindent
3028 Then when you run XBoard in ICS mode, you will be prompted
3029 to log in to the firewall host. This works because port 23 is the
3030 standard telnet login service. Do so, then telnet to ICS, using a
3031 command like @samp{telnet 5000}, or whatever command
3032 the firewall provides for telnetting to port 5000.
3034 If your firewall lets you telnet (or rlogin) to remote hosts but
3035 doesn't let you telnet to port 5000, you may be able to connect to the
3036 chess server on port 23 instead, which is the port the telnet program
3037 uses by default.  Some chess servers support this (including
3038 and, while some do not.
3040 If your chess server does not allow connections on port 23 and your
3041 firewall does not allow you to connect to other ports, you may be able
3042 to connect by hopping through another host outside the firewall that
3043 you have an account on.  For instance, suppose you have a shell
3044 account at @samp{}. Follow the recipe above, but instead of
3045 typing @samp{telnet 5000} to the firewall, type
3046 @samp{telnet} (or @samp{rlogin}), log in there, and
3047 then type @samp{telnet 5000}.
3049 Suppose that you can't telnet directly to ICS, but you can use rsh
3050 to run programs on a firewall host, and that host can telnet to ICS.
3051 Let's say the firewall is called @samp{}. Set
3052 command-line options as follows:
3054 @example
3055 xboard -ics -gateway -icshost
3056 @end example
3058 @noindent
3059 Or in your @file{.Xresources} file:
3061 @example
3062 XBoard*gateway:
3063 XBoard*internetChessServerHost:
3064 @end example
3066 Then when you run XBoard in ICS mode, it will connect to
3067 the ICS by using @file{rsh} to run the command
3068 @samp{telnet 5000} on host @samp{}.
3070 Suppose that you can telnet anywhere you want, but you have to
3071 run a special program called @file{ptelnet} to do so.
3073 First, we'll consider the easy case, in which
3074 @samp{ptelnet 5000} gets you to the chess server.
3075 In this case set command line options as follows:
3077 @example
3078 xboard -ics -telnet -telnetProgram ptelnet
3079 @end example
3081 @noindent
3082 Or in your @file{.Xresources} file:
3084 @example
3085 XBoard*useTelnet: true
3086 XBoard*telnetProgram: ptelnet
3087 @end example
3089 @noindent
3090 Then when you run XBoard in ICS mode, it will issue the
3091 command @samp{ptelnet 5000} to connect to the ICS.
3093 Next, suppose that @samp{ptelnet 5000} doesn't work;
3094 that is, your @file{ptelnet} program doesn't let you connect to
3095 alternative ports. As noted above, your chess server may allow you to
3096 connect on port 23 instead.  In that case, just add the option
3097 @samp{-icsport ""} to the above command, or add
3098 @samp{XBoard*internetChessServerPort:} to your @file{.Xresources} file.
3099 But if your chess server doesn't let you connect on port 23, you will have
3100 to find some other host outside the firewall and hop through it. For
3101 instance, suppose you have a shell account at @samp{}. Set
3102 command line options as follows:
3104 @example
3105 xboard -ics -telnet -telnetProgram ptelnet -icshost -icsport ""
3106 @end example
3108 @noindent
3109 Or in your @file{.Xresources} file:
3111 @example
3112 XBoard*useTelnet: true
3113 XBoard*telnetProgram: ptelnet
3114 XBoard*internetChessServerHost:
3115 XBoard*internetChessServerPort:
3116 @end example
3118 @noindent
3119 Then when you run XBoard in ICS mode, it will issue the
3120 command @samp{ptelnet} to connect to your account at
3121 @samp{}. Log in there, then type @samp{telnet 5000}.
3123 ICC timestamp and FICS timeseal do not work through some
3124 firewalls.  You can use them only if your firewall gives a clean TCP
3125 connection with a full 8-bit wide path.  If your firewall allows you
3126 to get out only by running a special telnet program, you can't use
3127 timestamp or timeseal across it.  But if you have access to a
3128 computer just outside your firewall, and you have much lower netlag
3129 when talking to that computer than to the ICS, it might be worthwhile
3130 running timestamp there.  Follow the instructions above for hopping
3131 through a host outside the firewall ( in the example),
3132 but run timestamp or timeseal on that host instead of telnet.
3134 Suppose that you have a SOCKS firewall that will give you a clean
3135 8-bit wide TCP connection to the chess server, but only after you
3136 authenticate yourself via the SOCKS protocol.  In that case, you could
3137 make a socksified version of XBoard and run that.  If you are using
3138 timestamp or timeseal, you will to socksify it, not XBoard; this may
3139 be difficult seeing that ICC and FICS do not provide source code for
3140 these programs.  Socksification is beyond the scope of this document,
3141 but see the SOCKS Web site at
3142 If you are missing SOCKS, try
3144 @node Environment
3145 @chapter Environment variables
3146 @cindex Environment variables
3147 @cindex CHESSDIR
3148 Game and position files are found in a directory named by the
3149 @code{CHESSDIR} environment variable. If this variable is not set, the
3150 current working directory is used. If @code{CHESSDIR} is set,
3151 XBoard actually changes its working directory to
3152 @code{$CHESSDIR}, so any files written by the chess engine
3153 will be placed there too.
3155 @node Limitations
3156 @chapter Limitations and known bugs
3157 @cindex Limitations
3158 @cindex Bugs
3159 There is no way for two people running copies of XBoard to play
3160 each other without going through an Internet Chess Server.
3162 Under some circumstances, your ICS password may be echoed when you log on.
3164 If you are connecting to the ICS by running telnet on an Internet
3165 provider or firewall host, you may find that each line you type is
3166 echoed back an extra time after you hit @key{Enter}. If your Internet
3167 provider is a Unix system, you can probably turn its echo off by
3168 typing @kbd{stty -echo} after you log in, and/or typing
3169 @key{^E}@key{Enter} (Ctrl+E followed by the Enter key) to the telnet
3170 program after you have logged into ICS.  It is a good idea to do this
3171 if you can, because the extra echo can occasionally confuse XBoard's
3172 parsing routines.
3174 The game parser recognizes only algebraic notation.
3176 Many of the following points used to be limitations in XBoard 4.2.7 and earlier, 
3177 but are now fixed:
3178 The internal move legality tester in XBoard 4.3.xx does look at the game history, 
3179 and is fully aware of castling or en-passant-capture rights. It permits castling with 
3180 the king on the d file because this is possible in some "wild 1" games on ICS. 
3181 The piece-drop menu does not check piece drops in bughouse to see if you actually hold 
3182 the piece you are trying to drop. But this way of dropping pieces should be considered 
3183 an obsolete feature, now that pieces can be dropped by dragging them from the holdings 
3184 to the board. Anyway, if you would attempt an illegal move when using a chess engine or the ICS, 
3185 XBoard will accept the error message that comes back, undo the move, and let you try another.
3186 FEN positions saved by XBoard do include correct information about whether castling or 
3187 en passant are legal, and also handle the 50-move counter.
3188 The mate detector does not understand that non-contact mate is not really mate in bughouse. 
3189 The only problem this causes while playing is minor: a "#" (mate indicator) character will 
3190 show up after a non-contact mating move in the move list. XBoard will not assume the game 
3191 is over at that point, not even when the option Detect Mates is on.
3192 Edit Game mode always uses the rules of the selected variant, 
3193 which can be a variant that uses piece drops.  
3194 You can load and edit games that contain piece drops. 
3195 The (obsolete) piece menus are not active, 
3196 but you can perform piece drops by dragging pieces from the holdings.
3197 Fischer Random castling is fully understood. 
3198 You can enter castlings by dragging the King on top of your Rook. 
3199 You can probably also play Fischer Random successfully on ICS by typing 
3200 castling moves into the ICS Interaction window.
3202 The menus may not work if your keyboard is in Caps Lock or Num Lock mode.
3203 This seems to be a problem with the Athena menu widget,
3204 not an XBoard bug.
3206 Also see the ToDo file included with the distribution for many other
3207 possible bugs, limitations, and ideas for improvement that have been
3208 suggested.
3209 @node Problems
3210 @chapter Reporting problems
3211 @cindex Bugs
3212 @cindex Bug reports
3213 @cindex Reporting bugs
3214 @cindex Problems
3215 @cindex Reporting problems
3217 You can report bugs and problems with XBoard using
3218 the bug tracker at @code{}
3219 or by sending mail to @code{<>}.  It can also
3220 be useful to report or discuss bugs in the WinBoard Forum at
3221 @code{}, 
3222 WinBoard development section.
3224 Please use the @file{script} program to start a typescript, run 
3225 XBoard with the @samp{-debug} option, and include the typescript
3226 output in your message.
3227 Also tell us what kind of machine and what operating system version
3228 you are using.  The command @samp{uname -a} will often tell you this.
3230 If you improve XBoard, please send a message about your changes,
3231 and we will get in touch with you about merging them in
3232 to the main line of development.
3234 @node Contributors
3235 @chapter Authors and contributors
3236 @cindex Authors
3237 @cindex Contributors
3239 Chris Sears and Dan Sears wrote the original XBoard.  They were
3240 responsible for versions 1.0 through 1.2.  The color scheme was taken
3241 from Wayne Christopher's @code{XChess} program.
3243 Tim Mann was primarily responsible for XBoard versions 1.3 through
3244 4.2.7, and for WinBoard (a port of XBoard to Microsoft Win32) from its
3245 inception through version 4.2.7.
3247 John Chanak contributed the initial implementation of ICS mode.  Evan
3248 Welsh wrote @code{CMail}, and Patrick Surry helped in designing,
3249 testing, and documenting it.  Elmar Bartel contributed the new piece
3250 bitmaps introduced in version 3.2.  Jochen Wiedmann converted the
3251 documentation to texinfo.  Frank McIngvale added click/click moving,
3252 the Analysis modes, piece flashing, ZIICS import, and ICS text
3253 colorization to XBoard.  Hugh Fisher added animated piece movement to
3254 XBoard, and Henrik Gram added it to WinBoard.  Mark Williams
3255 contributed the initial (WinBoard-only) implementation of many new
3256 features added to both XBoard and WinBoard in version 4.1.0, including
3257 copy/paste, premove, icsAlarm, autoFlipView, training mode, auto
3258 raise, and blindfold.  Ben Nye contributed X copy/paste code for
3259 XBoard.
3261 In a fork from version 4.2.7, Alessandro Scotti added many elements to
3262 the user interface of WinBoard, including the board textures and
3263 font-based rendering, the evaluation-graph, move-history and
3264 engine-output window.  He was also responsible for adding the UCI
3265 support.
3267 H. G. Muller continued this fork of the project, producing version
3268 4.3.  He made WinBoard castling- and e.p.-aware, added variant support
3269 with adjustable board sizes, the crazyhouse holdings, and the fairy
3270 pieces.  In addition he added most of the adjudication options, made
3271 WinBoard more robust in dealing with buggy and crashing engines, and
3272 extended time control with a time-odds and node-count-based modes.
3273 Most of the options that initially were WinBoard only have now been
3274 back-ported to XBoard.
3276 Michel van den Bergh provided the code for reading Polyglot opening books.
3278 Meanwhile, some work continued on the GNU XBoard project maintained at
3279, but version 4.2.8 was never released.  Daniel
3280 Mehrmann was responsible for much of this work.
3282 Most recently, Arun Persaud worked with H. G. Muller to merge all
3283 the features of the never-released XBoard/WinBoard 4.2.8 of the GNU
3284 XBoard project and the never-released 4.3.16 from H. G.'s fork into a
3285 unified XBoard/WinBoard 4.4, which is now available both from the
3286 web site and the WinBoard forum.
3288 @node CMail
3289 @chapter CMail
3290 @cindex cmail
3291 The @file{cmail} program can help you play chess by email with opponents of
3292 your choice using XBoard as an interface.
3294 You will usually run @file{cmail} without giving any options.
3296 @menu
3297 * CMail options::    Invoking CMail.
3298 * CMail game::       Starting a CMail game.
3299 * CMail answer::     Answering a move.
3300 * CMail multi::      Multiple games in one message.
3301 * CMail completion:: Completing a game.
3302 * CMail trouble::    Known CMail problems.
3303 @end menu
3305 @node CMail options
3306 @section CMail options
3307 @table @asis
3308 @item -h
3309 Displays @file{cmail} usage information.
3310 @item -c
3311 Shows the conditions of the GNU General Public License.
3312 @xref{Copying}.
3313 @item -w
3314 Shows the warranty notice of the GNU General Public License.
3315 @xref{Copying}.
3316 @item -v
3317 @itemx -xv
3318 Provides or inhibits verbose output from @file{cmail} and XBoard,
3319 useful for debugging. The
3320 @code{-xv}
3321 form also inhibits the cmail introduction message.
3322 @item -mail
3323 @itemx -xmail
3324 Invokes or inhibits the sending of a mail message containing the move.
3325 @item -xboard
3326 @itemx -xxboard
3327 Invokes or inhibits the running of XBoard on the game file.
3328 @item -reuse
3329 @itemx -xreuse
3330 Invokes or inhibits the reuse of an existing XBoard to display the
3331 current game.
3332 @item -remail
3333 Resends the last mail message for that game. This inhibits running
3334 XBoard.
3335 @item -game <name>
3336 The name of the game to be processed.
3337 @item -wgames <number>
3338 @itemx -bgames <number>
3339 @itemx -games <number>
3340 Number of games to start as White, as Black or in total. Default is 1 as
3341 white and none as black. If only one color is specified then none of the
3342 other color is assumed. If no color is specified then equal numbers of
3343 White and Black games are started, with the extra game being as White if an
3344 odd number of total games is specified.
3345 @item -me <short name>
3346 @itemx -opp <short name>
3347 A one-word alias for yourself or your opponent.
3348 @item -wname <full name>
3349 @itemx -bname <full name>
3350 @itemx -name <full name>
3351 @itemx -oppname <full name>
3352 The full name of White, Black, yourself or your opponent.
3353 @item -wna <net address>
3354 @itemx -bna <net address>
3355 @itemx -na <net address>
3356 @itemx -oppna <net address>
3357 The email address of White, Black, yourself or your opponent.
3358 @item -dir <directory>
3359 The directory in which @file{cmail} keeps its files. This defaults to the
3360 environment variable @code{$CMAIL_DIR} or failing that, @code{$CHESSDIR},
3361 @file{$HOME/Chess} or @file{~/Chess}. It will be created if it does not exist.
3362 @item -arcdir <directory>
3363 The directory in which @file{cmail} archives completed games. Defaults to
3364 the environment variable @code{$CMAIL_ARCDIR} or, in its absence, the same
3365 directory as cmail keeps its working files (above).
3366 @item -mailprog <mail program>
3367 The program used by cmail to send email messages. This defaults to the
3368 environment variable @code{$CMAIL_MAILPROG} or failing that
3369 @file{/usr/ucb/Mail}, @file{/usr/ucb/mail} or @file{Mail}. You will need
3370 to set this variable if none of the above paths fit your system.
3371 @item -logFile <file>
3372 A file in which to dump verbose debugging messages that are invoked with
3373 the @samp{-v}
3374 option.
3375 @item -event <event>
3376 The PGN Event tag (default @samp{Email correspondence game}).
3377 @item -site <site>
3378 The PGN Site tag (default @samp{NET}).
3379 @item -round <round>
3380 The PGN Round tag (default @samp{-}, not applicable).
3381 @item -mode <mode>
3382 The PGN Mode tag (default @samp{EM}, Electronic Mail).
3383 @item Other options
3384 Any option flags not listed above are passed through to XBoard.
3385 Invoking XBoard through CMail changes the default values of two XBoard
3386 options: The default value for @samp{-noChessProgram} is changed to
3387 true; that is, by default no chess engine is started.  The default
3388 value for @samp{-timeDelay} is changed to 0; that is, by default
3389 XBoard immediately goes to the end of the game as played so far,
3390 rather than stepping through the moves one by one.  You can still set
3391 these options to whatever values you prefer by supplying them on
3392 CMail's command line.  @xref{Options}.
3393 @end table
3395 @node CMail game
3396 @section Starting a CMail Game
3397 Type @file{cmail} from a shell to start a game as white. After an opening
3398 message, you will be prompted for a game name, which is optional---if you
3399 simply press @key{Enter}, the game name will take the form
3400 @samp{you-VS-opponent}. You will next be prompted for the short name
3401 of your opponent. If you haven't played this person before, you will also
3402 be prompted for his/her email address. @file{cmail} will then invoke
3403 XBoard in the background. Make your first move and select
3404 @samp{Mail Move} from the @samp{File} menu. @xref{File Menu}. If all is well,
3405 @file{cmail} will mail a copy of the move to your opponent. If you select
3406 @samp{Exit} without having selected @samp{Mail Move} then no move will be
3407 made.
3409 @node CMail answer
3410 @section Answering a Move
3411 When you receive a message from an opponent containing a move in one of
3412 your games, simply pipe the message through @file{cmail}. In some mailers
3413 this is as simple as typing @kbd{| cmail} when viewing the message, while in
3414 others you may have to save the message to a file and do @kbd{cmail < file}
3415 at the command line. In either case @file{cmail} will display the game using
3416 XBoard. If you didn't exit XBoard when you made your first move
3417 then @file{cmail} will do its best to use the existing XBoard instead
3418 of starting a new one. As before, simply make a move and select
3419 @samp{Mail Move} from the @samp{File} menu. @xref{File Menu}. @file{cmail}
3420 will try to use the
3421 XBoard that was most recently used to display the current game. This
3422 means that many games can be in progress simultaneously, each with its own
3423 active XBoard.
3425 If you want to look at the history or explore a variation, go ahead, but
3426 you must return to the current position before XBoard will allow you
3427 to mail a move. If you edit the game's history you must select
3428 @samp{Reload Same Game} from the @samp{File} menu to get back to the original
3429 position, then make the move you want and select @samp{Mail Move}.
3430 As before, if you decide you aren't ready to make a move just yet you can
3431 either select @samp{Exit} without sending a move or just leave
3432 XBoard running until you are ready.
3434 @node CMail multi
3435 @section Multi-Game Messages
3437 It is possible to have a @file{cmail} message carry more than one game.
3438 This feature was implemented to handle IECG (International Email Chess
3439 Group) matches, where a match consists of one game as white and one as black,
3440 with moves transmitted simultaneously. In case there are more general uses,
3441 @file{cmail} itself places no limit on the number of black/white games
3442 contained in a message; however, XBoard does.
3444 @node CMail completion
3445 @section Completing a Game
3446 Because XBoard can detect checkmate and stalemate, @file{cmail}
3447 handles game termination sensibly. As well as resignation, the
3448 @samp{Action} menu allows draws to be offered and accepted for
3449 @file{cmail} games.
3451 For multi-game messages, only unfinished and just-finished games will be
3452 included in email messages. When all the games are finished, they are
3453 archived in the user's archive directory, and similarly in the opponent's
3454 when he or she pipes the final message through @file{cmail}. The archive
3455 file name includes the date the game was started.
3457 @node CMail trouble
3458 @section Known CMail Problems
3459 It's possible that a strange conjunction of conditions may occasionally
3460 mean that @file{cmail} has trouble reactivating an existing
3461 XBoard. If this should happen, simply trying it again should work.
3462 If not, remove the file that stores the XBoard's PID
3463 (@file{}) or use the @samp{-xreuse} option to force
3464 @file{cmail} to start a new XBoard.
3466 Versions of @file{cmail} after 2.16 no longer understand the old file format
3467 that XBoard used to use and so cannot be used to correspond with
3468 anyone using an older version.
3470 Versions of @file{cmail} older than 2.11 do not handle multi-game messages,
3471 so multi-game correspondence is not possible with opponents using an older
3472 version.
3474 @node Other programs
3475 @chapter Other programs you can use with XBoard
3476 @cindex Other programs
3478 Here are some other programs you can use with XBoard
3480 @menu
3481 * GNU Chess::        The GNU Chess engine.
3482 * Fairy-Max::        The Fairy-Max chess engine.
3483 * HoiChess::         The HoiChess chess engine.
3484 * Crafty::           The Crafty chess engine.
3485 * zic2xpm::          The program used to import chess sets from ZIICS.
3486 @end menu
3488 @node GNU Chess
3489 @section GNU Chess
3491 The GNU Chess engine is available from:
3495 You can use XBoard to play a game against GNU Chess, or to
3496 interface GNU Chess to an ICS.
3498 @node Fairy-Max
3499 @section Fairy-Max
3501 Fairy-Max is a derivative from the once World's smallest Chess program micro-Max,
3502 which measures only about 100 lines of source code.
3503 The main difference with micro-Max is that Fairy-Max loads its move-generator
3504 tables from a file, so that the rules for piece movement can be easily configured
3505 to implement unorthodox pieces.
3506 Fairy-Max can therefore play a large number of variants, normal Chess being one of those.
3507 In addition it plays Knightmate, Capablanca and Gothic Chess, Shatranj, Courier Chess,
3508 Cylinder chess, Berolina Chess, while the user can easily define new variants.
3509 It can be obtained from:
3513 @node HoiChess
3514 @section HoiChess
3516 HoiChess is a not-so-very-strong Chess engine, which comes with a derivative HoiXiangqi,
3517 able to play Chinese Chess. It can be obtained from the standard Linux repositories
3518 through:
3520 sudo apt-get install hoichess
3522 @node Crafty
3523 @section Crafty
3525 Crafty is a chess engine written by Bob Hyatt.
3526 You can use XBoard to play a game against Crafty, hook Crafty up
3527 to an ICS, or use Crafty to interactively analyze games and positions
3528 for you.
3530 Crafty is a strong, rapidly evolving chess program. This rapid
3531 pace of development is good, because it means Crafty is always
3532 getting better.  This can sometimes cause problems with
3533 backwards compatibility, but usually the latest version of Crafty
3534 will work well with the latest version of XBoard.
3535 Crafty can be obtained from its author's FTP site:
3538 To use Crafty with XBoard, give the -fcp and -fd options as follows, where
3539 <crafty's directory> is the directory in which you installed Crafty
3540 and placed its book and other support files.
3542 @node zic2xpm
3543 @section zic2xpm
3545 The ``zic2xpm'' program is used to import chess sets from the ZIICS(*)
3546 program into XBoard. ``zic2xpm'' is part of the XBoard distribution.
3547 ZIICS is available from:
3551 To import ZIICS pieces, do this:
3552 @table @asis
3553 @item 1. Unzip ziics131.exe into a directory:
3555 @example
3556 unzip -L ziics131.exe -d ~/ziics
3557 @end example
3558 @item 2. Use zic2xpm to convert a set of pieces to XBoard format.
3560 For example, let's say you want to use the
3561 FRITZ4 set. These files are named ``fritz4.*'' in the ZIICS distribution.
3563 @example
3564 mkdir ~/fritz4
3565 cd ~/fritz4
3566 zic2xpm ~/ziics/fritz4.*
3567 @end example
3568 @item 3. Give XBoard the ``-pixmap'' option when starting up, e.g.:
3570 @example
3571 xboard -pixmap ~/fritz4
3572 @end example
3574 Alternatively, you can add this line to your @file{.Xresources} file:
3576 @example
3577 xboard*pixmapDirectory: ~/fritz4
3578 @end example
3579 @end table
3581 (*) ZIICS is a separate copyrighted work of Andy McFarland.
3582 The ``ZIICS&n