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