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