Fix erroneous use of @itemx
[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 @item 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 @item 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 @item 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 @itemx <
573 @cindex Backward, Menu Item
574 @cindex <, Button
575 Steps backward through a series of remembered moves.
576 The @samp{[<]} button and the @kbd{Alt+LeftArrow} key are equivalents,
577 as is turning the mouse wheel towards you.
578 In addition, pressing the ??? key steps back one move, and releasing
579 it steps forward again.
580
581 In most modes, @samp{Backward} only lets you look back at old positions;
582 it does not retract moves. This is the case if you are playing against
583 a chess engine, playing or observing a game on an ICS, or loading a game.
584 If you select @samp{Backward} in any of these situations, you will not
585 be allowed to make a different move. Use @samp{Retract Move} or
586 @samp{Edit Game} if you want to change past moves.
587
588 If you are examining an ICS game, the behavior of @samp{Backward}
589 depends on whether XBoard is in Pause mode. If Pause mode is
590 off, @samp{Backward} issues the ICS backward command, which backs up
591 everyone's view of the game and allows you to make a different
592 move. If Pause mode is on, @samp{Backward} only backs up your local
593 view.
594 @item Forward
595 @itemx >
596 @cindex Forward, Menu Item
597 @cindex >, Button
598 Steps forward through a series of remembered moves (undoing the
599 effect of @samp{Backward}) or forward through a game file. The
600 @samp{[>]} button and the @kbd{Alt+RightArrow} key are equivalents,
601 as is turning the mouse wheel away from you.
602
603 If you are examining an ICS game, the behavior of Forward
604 depends on whether XBoard is in Pause mode. If Pause mode is
605 off, @samp{Forward} issues the ICS forward command, which moves
606 everyone's view of the game forward along the current line. If
607 Pause mode is on, @samp{Forward} only moves your local view forward,
608 and it will not go past the position that the game was in when
609 you paused.
610 @item Back to Start
611 @itemx <<
612 @cindex Back to Start, Menu Item
613 @cindex <<, Button
614 Jumps backward to the first remembered position in the game.
615 The @samp{[<<]} button and the @kbd{Alt+Home} key are equivalents.
616
617 In most modes, Back to Start only lets you look back at old
618 positions; it does not retract moves. This is the case if you
619 are playing against a local chess engine, playing or observing a game on
620 a chess server, or loading a game. If you select @samp{Back to Start} in any
621 of these situations, you will not be allowed to make different
622 moves. Use @samp{Retract Move} or @samp{Edit Game} if you want to change past
623 moves; or use Reset to start a new game.
624
625 If you are examining an ICS game, the behavior of @samp{Back to
626 Start} depends on whether XBoard is in Pause mode. If Pause mode
627 is off, @samp{Back to Start} issues the ICS @samp{backward 999999}
628 command, which backs up everyone's view of the game to the start and
629 allows you to make different moves. If Pause mode is on, @samp{Back
630 to Start} only backs up your local view.
631 @item Forward to End
632 @itemx >>
633 @cindex Forward to End, Menu Item
634 @cindex >>, Button
635 Jumps forward to the last remembered position in the game. The
636 @samp{[>>]} button and the @kbd{Alt+End} key are equivalents.
637
638 If you are examining an ICS game, the behavior of @samp{Forward to
639 End} depends on whether XBoard is in Pause mode. If Pause mode
640 is off, @samp{Forward to End} issues the ICS @samp{forward 999999}
641 command, which moves everyone's view of the game forward to the end of
642 the current line. If Pause mode is on, @samp{Forward to End} only moves
643 your local view forward, and it will not go past the position
644 that the game was in when you paused.
645 @end table
646
647 @node View Menu
648 @section View Menu
649 @cindex Menu, View
650 @cindex View Menu
651 @table @asis
652 @item Flip View
653 @cindex Flip View, Menu Item
654 Inverts your view of the chess board for the duration of the
655 current game. Starting a new game returns the board to normal.
656 The @kbd{F2} key is a keyboard equivalent.
657 @item Show Engine Output
658 @cindex Show Engine Output, Menu Item
659 Shows or hides a window in which the thinking output of any loaded engines
660 is displayed. The shifted @kbd{Alt+O} key is a keyboard equivalent.
661 XBoard will display lines of thinking output of the same depth ordered by score, 
662 (highest score on top), rather than in the order the engine produced them. 
663 Usually this amounts to the same, as a normal engine search will only find new PV 
664 (and emit it as thinking output) 
665 when it searches a move with a higher score than the previous variation. 
666 But when the engine is in multi-variation mode this needs not always be true, 
667 and it is more convenient for someone analyzing games to see the moves sorted by score. 
668 The order in which the engine found them is only of interest to the engine author, 
669 and can still be deduced from the time or node count printed with the line.
670 Right-clicking a line in this window, and then moving the mouse vertically with the
671 right button kept down, will make XBoard play through the PV listed there.
672 The use of the board window as 'variation board' will normally end when
673 you release the right button,
674 or when the opponent plays a move.
675 But beware: in Analysis mode, moves thus played out might be added to the game,
676 depending on the setting of the option 'Play moves of clicked PV',
677 when you initiate the click left of the PV in the score area.
678 The Engine-Output pane for each engine will contain a header displaying the
679 multi-PV status and a list of excluded moves in Analysis mode,
680 which are also responsive to right-clicking:
681 Clicking the words 'fewer' or 'more' will alter the number of variations
682 shown at each depth, through the engine's MultiPV option,
683 while clicking in between those and moving the mouse horizontally adjust
684 the option 'Multi-PV Margin'. (In so far the engines support those.)
685 @item Show Move History
686 @cindex Show Move History, Menu Item
687 Shows or hides a list of moves of the current game.
688 The shifted @kbd{Alt+H} key is a keyboard equivalent.
689 This list allows you to move the display to any earlier position in the game
690 by clicking on the corresponding move.
691 @item Show Evaluation Graph
692 @cindex Show Evaluation Graph, Menu Item
693 Shows or hides a window which displays a graph of how the engine score(s)
694 evolved as a function of the move number. 
695 The shifted @kbd{Alt+E} key is a keyboard equivalent.
696 The title bar shows the score (and search depth at which it was obtained)
697 of the currently displayed position numerically.
698 Clicking on the graph will bring
699 the corresponding position in the board display.
700 A button 3 click will toggle the display mode between plain and differential
701 (showing the difference in score between successive half moves).
702 Using the mouse wheel over the window will change the scale of the
703 low-score region (from -1 to +1).
704 @item Show Game List
705 @cindex Show Game List, Menu Item
706 Shows or hides the list of games generated by the last @samp{Load Game}
707 command. The shifted @kbd{Alt+G} key is a keyboard equivalent.
708 The line describing each game is built from a selection of the PGN tags.
709 Which tags contribute, and in what order, can be changed by the @samp{Game list tags}
710 menu dialog, which can be popped up through the @samp{Tags} button below the Game List.
711 Display can be restricted to a sub-set of the games meeting certain criteria.
712 A text entry below the game list allows you to type a text that the game lines
713 must contain in order to be displayed.
714 Games can also be selected based on their Elo PGN tag,
715 as set in the @samp{Load Game Options} dialog, which can be popped up through the
716 @samp{Thresholds} button below the Game List.
717 Finally they can be selected based on containing a position similar to the one
718 currently displayed in the main window, by pressing the 'Position' button below
719 the Game List, (which searches the entire list for the position), or the 'Narrow'
720 button (which only searches the already-selected games).
721 What counts as similar enough to be selected can also be set in the
722 @samp{Load Game Options} dialog, and ranges from an exact match to just the
723 same material.
724 @item Tags
725 @cindex Tags, Menu Item
726 Pops up a window which shows the PGN (portable game notation)
727 tags for the current game. 
728 For now this is a duplicate of the @samp{Edit Tags} item in the @samp{Edit} menu.
729 @item Comments
730 @cindex Comments, Menu Item
731 Pops up a window which shows any comments to or variations on the current move.
732 For now this is a duplicate of the @samp{Edit Comment} item in the @samp{Edit} menu.
733 @item ICS Input Box
734 @cindex ICS Input Box, Menu Item
735 If this option is set in ICS mode,
736 XBoard
737 creates an extra window that you can use for typing in ICS commands.
738 The input box is especially useful if you want to type in something long or do
739 some editing on your input, because output from ICS doesn't get mixed
740 in with your typing as it would in the main terminal window.
741 @item ICS Chat/Console
742 @cindex ICS Chat/Console, Menu Item
743 This menu item opens a window in which you can interact with the ICS,
744 and conduct upto 5 chats with other ICS users (or channels),
745 so you don't have to use the messy xterm from which you launched XBoard
746 for that.
747 The window has a text entry at the bottom where you can type your
748 commands and messages unhindered by the stream of ICS output.
749 The latter will be displayed in a large pane above the input field,
750 the ICS Console.
751 This pane can be vertically split into two, however, where half of it
752 is then used to display selected ICS output, belonging to a chat with
753 another user, or output from an ICS channel.
754 Such output will then not appear in the Console pane.
755
756 To use the window, write the name of your chat partner, the channel number,
757 or the words 'shouts', 'whispers', 'cshouts' in the upper field
758 (ending with <Enter>).
759 Everything you type in the lowest field will then automatically be sent to
760 the mentioned party, while everything that party sends to you will
761 appear in the central text pane, rather than appear in the ICS console.
762 The row of buttons allow you to choose between chat;
763 to start a new chat, just select an empty button,
764 and complete the @samp{Chat partner} field.
765 There are several keyboard accelerators to control this window:
766 Ctrl-H will hide the private chat, and dedicates the input field to
767 giving ICS commands.
768 Ctrl-E will erase the current chat and chat partner.
769 Ctrl-N will open a new chat with a yet unspecified partner.
770 Ctrl-O will open a new chat with the last person from which you received
771 a tell in the ICS console pane.
772 <Esc> will transfer keyboard focus to the board window,
773 allowing you to invoke menu items through accelerator keys;
774 typing a printable character there transfers focus back to the input field
775 of the chat window.
776 <Tab> will switch to another busy chat,
777 giving priority to those with content you have not seen yet.
778 (The buttons for selecting such chats turn orange.)
779 Up and down arrow keys can be used to recall previous input lines.
780 @item ICS text menu
781 @cindex ICS text menu, Menu Item
782 Brings up a menu that is user-configurable through the @code{icsMenu} option.
783 Buttons in this menu can sent pre-configured commands directly to the ICS,
784 or can put partial commands in the input field of the @samp{ICS Chat/Console}
785 window, so that you can complete those with some text of your own before
786 sending them to the ICS by pressing Enter.
787 This menu item can also be popped up by right-clicking in the text memos
788 of the ICS Chat/Console window.
789 In that case the word that was clicked can be incorporated in the message
790 sent to the ICS. E.g. to challenge a player whose name you click for a game,
791 or prepare for sending him a message through a 'tell' commands.
792 @item Board
793 @cindex Board, Menu Item
794 Summons a dialog where you can customize the look of the chess board.
795 @item White Piece Color
796 @itemx Black Piece Color
797 @itemx Light Square Color
798 @itemx Dark Square Color
799 @itemx Highlight Color
800 @itemx Premove Highlight Color
801 @cindex Piece Color, Menu Item
802 @cindex Square Color, Menu Item
803 @cindex Highlight Color, Menu Item
804 These items set the color of pieces, board squares and move highlights
805 (borders or arrow).
806 Square colors are only used when the @samp{Use Board Textures} option is off,
807 the piece colors only when @samp{Use piece bitmaps with their own colors} is off.
808 You can type the color as hexadecimally encoded RGB value preceded by '#',
809 or adjust it through the R, G, B and D buttons to make it redder, greener, bluer
810 or darker.
811 A sample of the adjusted color will be displayed behind its text description;
812 pressing this colored button restores the default value for the color.
813 @item Flip Pieces Shogi Style
814 @cindex Flip Pieces Shogi Style, Menu Item
815 With this option on XBoard will swap white and black pieces,
816 when you flip the view of the board to make white play downward.
817 This should be used with piece themes that do not distinguish sides by color,
818 but by orientation.
819 @item Mono Mode
820 @cindex Mono Mode, Menu Item
821 This option sets XBoard to pure black-and-white display
822 (no grey scales, and thus no anti-aliasing).
823 @item Logo Size
824 @cindex Logo Size, Menu Item
825 Specifies the width of the engine logos displayed next to the clocks, in pixels.
826 Setting it to 0 suppresses the display of such logos.
827 The height of the logo will be half its width.
828 In the GTK build of XBoard any non-zero value is equivalent,
829 and the logos are always sized to 1/4 of the board width.
830 @item Line Gap
831 @cindex Line Gap, Menu Item
832 This option specifies the width of the grid lines that separate the squares,
833 which change color on highlighting the move.
834 Setting it to 0 suppresses these lines, which in general looks better,
835 but hides the square-border highlights,
836 so that you would have to rely on other forms of highlighting.
837 Setting the value to -1 makes XBoard choose a width by itself,
838 depending on the square size.
839 @item Use Board Textures
840 @itemx Light-Squares Texture File
841 @itemx Dark-Squares Texture File
842 @cindex Use Board Texture, Menu Item
843 @cindex Texture Files, Menu Item
844 When the option @samp{Use Board Textures} is set,
845 the squares will not be drawn as evenly colored surfaces,
846 but will be cut from a texture image, as specified by the
847 @samp{Texture Files}.
848 Separate images can be used for light and dark squares.
849 XBoard will try to cut the squares out of the texture image
850 with as little overlap as possible, so they all look different.
851 The name of the texture file can contain a size hint,
852 e.g. @code{xqboard-9x10.png}, alerting XBoard to the fact that
853 it contains a whole-board image, out of which squares have to
854 be cut in register with the nominal sub-division.
855 @item Use external piece bitmaps with their own color
856 @cindex Draw pieces with their own colors, Menu Item
857 When this option is on XBoard will ignore the piece-color settings,
858 and draw the piece images in their original colors.
859 The piece-color settings would only work well for evenly colored
860 pieces, such as the default theme.
861 @item Directory with Pieces Images
862 @cindex Piece-Image Directory, Menu Item
863 When a directory is specified here, XBoard will first look for
864 piece images (SVG or PNG files) in that directory,
865 and fall back on the image from the default theme only for
866 images it cannot find there.
867 An image file called White/BlackTile in the directory will be prefered
868 as fall-back for missing pieces over the default image, however.
869 @item Selectable themes
870 @itemx New name for current theme
871 @cindex Board Themes, Menu Item
872 @cindex Theme name, Menu Item
873 When a theme name is specified while pressing 'OK',
874 the combination of settings specified in the dialog
875 will be stored in XBoard's list of themes,
876 which will be saved with the other options in the settings file
877 (as the @code{themeNames} option).
878 This name will then appear in the selection listbox next time
879 you open the dialog,
880 so that you can recall the entire combination of settings
881 by double-clicking it.
882
883
884 Here you can specify the directory from which piece images should be taken,
885 when you don't want to use the built-in piece images
886 (see @code{pieceImageDirectory} option),
887 external images to be used for the board squares
888 (@code{liteBackTextureFile} and @code{darkBackTextureFile} options),
889 and square and piece colors for the default pieces.
890 The current combination of these settings can be assigned a 'theme' name
891 by typing one in the text entry in the lower-left of the dialog,
892 and closing the latter with OK.
893 It will then appear in the themes listbox next time you open the dialog,
894 where you can recall the complete settings combination with a double-click.
895 @item Fonts
896 @cindex Fonts, Menu Item
897 Pops up a dialog where you can set the fonts used in the main elements of various windows.
898 Pango font names can be typed for each window type,
899 and behind each text entry there are buttons to adjust the point size,
900 and toggle the 'bold' or 'italic' attributes of the font.
901 @item Game List Tags
902 @cindex Game List Tags, Menu Item
903 a duplicate of the Game List dialog in the Options menu.
904 @end table
905
906 @node Mode Menu
907 @section Mode Menu
908 @cindex Menu, Mode
909 @cindex Mode Menu
910 @table @asis
911 @item Machine White
912 @cindex Machine White, Menu Item
913 Tells the chess engine to play White. 
914 The @kbd{Ctrl-W} key is a keyboard equivalent.
915 @item Machine Black
916 @cindex Machine Black, Menu Item
917 Tells the chess engine to play Black.
918 The @kbd{Ctrl-B} key is a keyboard equivalent.
919 @item Two Machines
920 @cindex Two Machines, Menu Item
921 Plays a game between two chess engines.
922 The @kbd{Ctrl-T} key is a keyboard equivalent.
923 @item Analysis Mode
924 @cindex Analysis Mode, Menu Item
925 @cindex null move
926 @cindex move exclusion
927 XBoard tells the chess engine to start analyzing the current game/position
928 and shows you the analysis as you move pieces around.
929 The @kbd{Ctrl-A} key is a keyboard equivalent.
930 Note: Some chess engines do not support Analysis mode.
931
932 To set up a position to analyze, you do the following:
933
934 1. Set up the position by any means. (E.g. using @samp{Edit Position}
935 mode, pasing a FEN or loading a game and stepping to the position.)
936
937 2. Select Analysis Mode from the Mode Menu to start the analysis.
938
939 You can now play legal moves to create follow-up positions for the
940 engine to analyze, while the moves will be remembered as a stored game,
941 and then step backward through this game to take the moves back.
942 Note that you can also click on the clocks to set the opposite
943 side to move (adding a so-called @samp{null move} to the game).
944
945 You can also tell the engine to exclude some moves from analysis.
946 (Engines that do not support the exclude-moves feature will
947 ignore this, however.)
948 The general way to do this is to play the move you want to exclude
949 starting with a double click on the piece.
950 When you use drag-drop moving, the piece you grab with a double click
951 will also remain on its square, to show you that you are not really
952 making the move, but just forbid it from the current position.
953 Playing a thus excluded move a second time will include it again.
954 Excluded moves will be listed as text in a header line in the
955 Engine Output window, and you can also re-include them by
956 right-clicking them there.
957 This header line will also contain the words 'best' and 'tail';
958 right-clicking those will exclude the currently best move,
959 or all moves not explicitly listed in the header line.
960 Once you leave the current position all memory of excluded
961 moves will be lost when you return there.
962
963
964 Selecting this menu item while already in @samp{Analysis Mode} will
965 toggle the participation of the second engine in the analysis.
966 The output of this engine will then be shown in the lower pane
967 of the Engine Output window.
968 The analysis function can also be used when observing games on an ICS
969 with an engine loaded (zippy mode); the engine then will analyze
970 the positions as they occur in the observed game.
971
972 @item Analyze Game
973 @cindex Analyze Game, Menu Item
974 This option subjects the currently loaded game to automatic
975 analysis by the loaded engine.
976 The @kbd{Ctrl-G} key is a keyboard equivalent.
977 XBoard will start auto-playing the game from the currently displayed position,
978 while the engine is analyzing the current position.
979 The game will be annotated with the results of these analyses.
980 In particlar, the score and depth will be added as a comment,
981 and the PV will be added as a variation.
982
983 Normally the analysis would stop after reaching the end of the game.
984 But when a game is loaded from a multi-game file
985 while @samp{Analyze Game} was already switched on,
986 the analysis will continue with the next game in the file
987 until the end of the file is reached (or you switch to another mode).
988
989 The time the engine spends on analyzing each move can be controlled
990 through the command-line option @samp{-timeDelay},
991 which can also be set from the @samp{Load Game Options} menu dialog.
992 Note: Some chess engines do not support Analysis mode.
993 @item Edit Game
994 Duplicate of the item in the Edit menu.
995 Note that @samp{Edit Game} is the idle mode of XBoard, and can be used
996 to get you out of other modes. E.g. to stop analyzing, stop a game
997 between two engines or stop editing a position.
998 @item Edit Position
999 Duplicate of the item in the Edit menu.
1000 @item Training
1001 @cindex Training, Menu Item
1002 Training mode lets you interactively guess the moves of a game for one
1003 of the players. You guess the next move of the game by playing the
1004 move on the board. If the move played matches the next move of the
1005 game, the move is accepted and the opponent's response is auto-played.
1006 If the move played is incorrect, an error message is displayed.  You
1007 can select this mode only while loading a game (that is, after
1008 selecting @samp{Load Game} from the File menu).  While XBoard is in 
1009 @samp{Training} mode, the navigation buttons are disabled.
1010 @item ICS Client
1011 @cindex ICS Client, Menu Item
1012 This is the normal mode when XBoard
1013 is connected to a chess server.  If you have moved into
1014 Edit Game or Edit Position mode, you can select this option to get out.
1015
1016 To use xboard in ICS mode, run it in the foreground with the -ics
1017 option, and use the terminal you started it from to type commands and
1018 receive text responses from the chess server.  See
1019 @ref{Chess Servers} below for more information.
1020
1021 XBoard activates some special position/game editing features when you
1022 use the @kbd{examine} or @kbd{bsetup} commands on ICS and you have
1023 @samp{ICS Client} selected on the Mode menu.  First, you can issue the
1024 ICS position-editing commands with the mouse.  Move pieces by dragging
1025 with mouse button 1.  To drop a new piece on a square, press mouse
1026 button 2 or 3 over the square.  This brings up a menu of white pieces
1027 (button 2) or black pieces (button 3).  Additional menu choices let
1028 you empty the square or clear the board.  Click on the White or Black
1029 clock to set the side to play.  You cannot set the side to play or
1030 drag pieces to arbitrary squares while examining on ICC, but you can
1031 do so in @kbd{bsetup} mode on FICS.  In addition, the menu commands
1032 @samp{Forward}, @samp{Backward}, @samp{Pause}, and @samp{Stop Examining}
1033 have special functions in this mode; see below.
1034 @item Machine Match
1035 @cindex Machine match, Menu Item
1036 Starts a match between two chess programs,
1037 with a number of games and other parameters set through
1038 the @samp{Tournament Options} menu dialog.
1039 When a match is already running, selecting this item will make
1040 XBoard drop out of match mode after the current game finishes.
1041 @item Pause
1042 @cindex Pause, Menu Item
1043 Pauses updates to the board, and if you are playing against a chess engine,
1044 also pauses your clock. To continue, select @samp{Pause} again, and the
1045 display will automatically update to the latest position.
1046 The @samp{P} button and keyboard @kbd{Pause} key are equivalents.
1047
1048 If you select Pause when you are playing against a chess engine and
1049 it is not your move, the chess engine's clock
1050 will continue to run and it will eventually make a move, at which point
1051 both clocks will stop. Since board updates are paused, however,
1052 you will not see the move until you exit from Pause mode (or select Forward).
1053 This behavior is meant to simulate adjournment with a sealed move.
1054
1055 If you select Pause while you are observing or examining a game on a
1056 chess server, you can step backward and forward in the current history
1057 of the examined game without affecting the other observers and
1058 examiners, and without having your display jump forward to the latest
1059 position each time a move is made. Select Pause again to reconnect
1060 yourself to the current state of the game on ICS.
1061
1062 If you select @samp{Pause} while you are loading a game, the game stops
1063 loading. You can load more moves manually by selecting @samp{Forward}, or
1064 resume automatic loading by selecting @samp{Pause} again.
1065 @end table
1066
1067 @node Action Menu
1068 @section Action Menu
1069 @cindex Menu, Action
1070 @cindex Action, Menu
1071 @table @asis
1072 @item Accept
1073 @cindex Accept, Menu Item
1074 Accepts a pending match offer. 
1075 The @kbd{F3} key is a keyboard equivalent.
1076 If there is more than one offer
1077 pending, you will have to type in a more specific command
1078 instead of using this menu choice.
1079 @item Decline
1080 @cindex Decline, Menu Item
1081 Declines a pending offer (match, draw, adjourn, etc.).
1082 The @kbd{F4} key is a keyboard equivalent. If there
1083 is more than one offer pending, you will have to type in a more
1084 specific command instead of using this menu choice.
1085 @item Call Flag
1086 @cindex Call Flag, Menu Item
1087 Calls your opponent's flag, claiming a win on time, or claiming
1088 a draw if you are both out of time. 
1089 The @kbd{F5} key is a keyboard equivalent.
1090 You can also call your
1091 opponent's flag by clicking on his clock.
1092 @item Draw
1093 @cindex Draw, Menu Item
1094 Offers a draw to your opponent, accepts a pending draw offer
1095 from your opponent, or claims a draw by repetition or the 50-move
1096 rule, as appropriate. The @kbd{F6} key is a keyboard equivalent.
1097 @item Adjourn
1098 @cindex Adjourn, Menu Item
1099 Asks your opponent to agree to adjourning the current game, or
1100 agrees to a pending adjournment offer from your opponent.
1101 The @kbd{F7} key is a keyboard equivalent.
1102 @item Abort
1103 @cindex Abort, Menu Item
1104 Asks your opponent to agree to aborting the current game, or
1105 agrees to a pending abort offer from your opponent.
1106 The @kbd{F8} key is a keyboard equivalent. An aborted
1107 game ends immediately without affecting either player's rating.
1108 @item Resign
1109 @cindex Resign, Menu Item
1110 Resigns the game to your opponent. The @kbd{F9} key is a
1111 keyboard equivalent.
1112 @item Stop Observing
1113 @cindex Stop Observing, Menu Item
1114 Ends your participation in observing a game, by issuing the ICS
1115 observe command with no arguments. ICS mode only.
1116 The @kbd{F10} key is a keyboard equivalent.
1117 @item Stop Examining
1118 @cindex Stop Examining, Menu Item
1119 Ends your participation in examining a game, by issuing the ICS
1120 unexamine command. ICS mode only.
1121 The @kbd{F11} key is a keyboard equivalent.
1122 @item Upload to Examine
1123 @cindex Upload to Examine, Menu Item
1124 Create an examined game of the proper variant on the ICS,
1125 and send the game there that is currenty loaded in XBoard
1126 (e.g. through pasting or loading from file).
1127 You must be connected to an ICS for this to work.
1128 @item Adjudicate to White
1129 @itemx Adjudicate to Black
1130 @itemx Adjudicate Draw
1131 @cindex Adjudicate to White, Menu Item
1132 @cindex Adjudicate to Black, Menu Item
1133 @cindex Adjudicate Draw, Menu Item
1134 Terminate an ongoing game in Two-Machines mode (including match mode),
1135 with as result a win for white, for black, or a draw, respectively.
1136 The PGN file of the game will accompany the result string
1137 by the comment "user adjudication".
1138 @end table
1139
1140 @node Engine Menu
1141 @section Engine Menu
1142 @cindex Engine Menu
1143 @cindex Menu, Engine
1144 @table @asis
1145 @item Edit Engine List
1146 @cindex Edit Engine List, Menu Item
1147 Opens a window that shows the list of engines registered for use
1148 by XBoard, together with the options that would be used with them
1149 when you would select them from the @samp{Load Engine} dialogs.
1150 You can then edit this list, e.g. for re-ordering the engines,
1151 or adding uncommon options needed by this engine
1152 (e.g. to cure non-compliant behavior).
1153
1154 By editing you can also organize the engines into collapsible groups.
1155 By sandwiching a number of engine lines between lines "# NAME" and "# end",
1156 the thus enclosed engines will not initially appear in engine listboxes
1157 of other dialogs, but only the single line "# NAME"
1158 (where NAME can be an arbitrary text) will appear in their place.
1159 Selecting that line will then show the enclosed engines in the listbox,
1160 which recursively can contain other groups.
1161 The line with the group name will still present as a header,
1162 and selecting that line will collapse the group again,
1163 and makes the listbox go back to displaying the surrounding group.
1164 @item Load New 1st Engine
1165 @itemx Load New 2nd Engine
1166 @cindex Load New Engine, Menu Item
1167 Pops up a dialog where you can select or specify an engine to be loaded.
1168 You can even replace engines during a game, without disturbing that game.
1169 (Beware that after loading an engine, XBoard will always be in Edit Game mode, 
1170 so you will have to tell the new engine what to do before it does anything!)
1171 @table @asis
1172 @item Select engine from list
1173 @cindex Select engine, Menu Item
1174 The listbox shows the engines registered for use with XBoard before.
1175 (This means XBoard has information on the engine type, whether it plays book etc.
1176 in the engine list stored in its settings file.)
1177 Double-clicking an engine here will load it and close the dialog.
1178 The list can also contain groups, indicated by a starting '#' sign.
1179 Double-clicking such a group will 'open' it,
1180 and show the group contents in the listbox instead of the total list,
1181 with the group name as header.
1182 Double-clicking the header will 'close' the group again.
1183 @item Nickname
1184 @itemx Use nickname in PGN player tags of engine-engine games
1185 @cindex Nickname, Menu Item
1186 When a @samp{Nickname} is specified, the engine will appear under this name
1187 in the @samp{Select Engine} listbox.
1188 Otherwise the name there will be a tidied version of the engine command.
1189 The user can specify if the nickname is also to be used in PGN tags;
1190 normally the name engines report theselves would be used there.
1191 @item Engine Command
1192 @cindex Engine Command, Menu Item
1193 The command needed to start the engine from the command line.
1194 For compliantly installed engine this is usually just a single word,
1195 the name of the engine package (e.g. 'crafty' or 'stockfish').
1196 Some engines need additional parameters on the command line.
1197 For engines that are not in a place where the system would expect them
1198 a full pathname can be specified, and usually the browse button
1199 for this oprion is the easiest way to obtain that.
1200 @item Engine Directory
1201 @cindex Engine Directory, Menu Item
1202 Compliant engines could run from any directory,
1203 and by default this option is proposed as '.', the current directory.
1204 If a (path)name is specified here, XBoard will start the engine
1205 in that directory.
1206 If you make the field empty, it will try to derive the directory
1207 from the engine command (if that was a path name).
1208 @item UCI
1209 @cindex UCI, Menu Item
1210 When the @samp{UCI} checkbox is ticked XBoard will assume
1211 the engine is of UCI type, and will invoke the corresponding adapter
1212 (as specified in the @code{adapterCommand} option stored in its
1213 settings file)to use it.
1214 By default this adapter is Polyglot,
1215 which must be installed from a separate package!
1216 @item USI/UCCI
1217 @cindex USI/UCCI, Menu Item
1218 Ticking this checkbox informs XBoard that the engine is of USI or UCCI type
1219 (as Shogi or Xiangqi engines often are).
1220 This makes XBoard invoke an adapter to run the engines,
1221 as specified by the @code{uxiAdapter} option stored in its settings file.
1222 The UCI2WB program is an adapter that can handle both these engine types,
1223 as well as UCI.
1224 @item WB protocol v1
1225 @cindex WB protocol v1, Menu Item
1226 Ticking this checkbox informs XBoard the engine is using an old version (1)
1227 of the communication protocol, so that it won't respond to a request
1228 to interrogate its properties.
1229 XBoard then won't even try that, saving you a wait of several seconds
1230 each time the engine is started.
1231 Do not use this on state-of-the-art engines,
1232 as it would prevent XBoard from interrogating its capabilities,
1233 so that many of its features might not work!
1234 @item Must not use GUI book
1235 @cindex Use GUI book, Menu Item
1236 By default XBoard assumes engines are responsible for their own opening book,
1237 but unticking this option makes XBoard consult its own book
1238 (as per @samp{Opening-Book Filename}) on behalf of the engine.
1239 @item Add this engine to the list
1240 @cindex Add engine, Menu Item
1241 By default XBoard would add the engine you specified,
1242 with all the given options to its list of registered engines
1243 (kept in its settings file), when you press 'OK'.
1244 Next time you could then simply select it from the listbox,
1245 or use the command "xboard -fe NICKNAME" to start XBoard with the
1246 engine and accompanying options.
1247 New engines are always added at the end of the existing list,
1248 or, when you have opened a group in the @samp{Select Engine} listbox,
1249 at the end of that group.
1250 But can be re-ordered later with the aid
1251 of the @samp{Edit Engine List} menu item.
1252 When you untick this checkbox before pressing 'OK'
1253 the engine will be loaded, but will not be added to the engine list.
1254 @item Force current variant with this engine
1255 @cindex Force variant with engine, Menu Item
1256 Ticking this option will make XBoard automatically start the engine
1257 in the current variant, even when XBoard was set for a different
1258 variant when you loaded the engine.
1259 Useful when the engine plays multiple variants,
1260 and you specifically want to play one different from its primary one.
1261 @end table
1262
1263 @item Engine #1 Settings
1264 @itemx Engine #2 Settings
1265 @cindex Engine #N Settings, Menu Item
1266 Pop up a menu dialog to alter the settings specific to the applicable engine.
1267 For each parameter the engine allows to be set,
1268 a control element will appear in this dialog that can be used to alter the value.
1269 Depending on the type of parameter (text string, number, multiple choice,
1270 on/off switch, instantaneous signal) the appropriate control will appear,
1271 with a description next to it.
1272 XBoard has no idea what these values mean; it just passes them on to the engine.
1273 How this dialog looks is completely determined by the engine,
1274 and XBoard just passes it on to the user.
1275 Many engines do not have any parameters that can be set by the user,
1276 and in that case the dialog will be empty (except for the OK and cancel buttons).
1277 UCI engines usually have many parameters. (But these are only visible with
1278 a sufficiently modern version of the Polyglot adapter needed to run UCI engines,
1279 e.g. Polyglot 2.0.1.) For native XBoard engines this is less common.
1280
1281 @item Common Settings
1282 @cindex Common Settings, Menu Item
1283 Pops up a menu dialog where you can set some engine parameters common to most engines,
1284 such as hash-table size, tablebase cache size, maximum number of processors
1285 that SMP engines can use.
1286 The shifted @kbd{Alt+U} key is a keyboard equivalent.
1287 Older XBoard/WinBoard engines might not respond to these settings,
1288 but UCI engines always should.
1289 The @samp{EGT path} field corresponds to the setting of the
1290 @code{egtFormats} option to specify where to find tablebases
1291 of various flavors. See the description of this option for the required syntax.
1292
1293 It is also possible to specify a GUI opening book here, i.e. an opening
1294 book that XBoard consults for any position a playing engine gets in.
1295 It then forces the engine to play the book move, rather than to think up its own,
1296 if that position is found in the book.
1297 The book can switched on and off independently for either engine.
1298 The way book moves are chosen can be influenced through the settings of
1299 book depth and variety.
1300 After both sides have played more moves than the specified depth,
1301 the book will no longer be consulted.
1302 When the variety is set to 50, moves will be played with the probability
1303 specified in the book.
1304 When set to 0, only the move(s) with the highest probability will be played.
1305 When set to 100, all listed moves will be played with equal pobability.
1306 Other settings interpolate between that.
1307
1308 @item Hint
1309 @cindex Hint, Menu Item
1310 Displays a move hint from the chess engine.
1311 @item Book
1312 @cindex Book, Menu Item
1313 Displays a list of possible moves from the chess engine's opening
1314 book.  The exact format depends on what chess engine you are using.
1315 With GNU Chess 4, the first column gives moves, the second column
1316 gives one possible response for each move, and the third column shows
1317 the number of lines in the book that include the move from the first
1318 column. If you select this option and nothing happens, the chess
1319 engine is out of its book or does not support this feature.
1320 @item Move Now
1321 @cindex Move Now, Menu Item
1322 Forces the chess engine to move immediately. Chess engine mode only.
1323 The @kbd{Ctrl-M} key is a keyboard equivalent.
1324 Many engines won't respond to this.
1325 @item Retract Move
1326 @cindex Retract Move, Menu Item
1327 Retracts your last move. In chess engine mode, you can do this only
1328 after the chess engine has replied to your move; if the chess engine is still
1329 thinking, use @samp{Move Now} first. In ICS mode, @samp{Retract Move}
1330 issues the command @samp{takeback 1} or @samp{takeback 2}
1331 depending on whether it is your opponent's move or yours.
1332 The @kbd{Ctrl-X} key is a keyboard equivalent.
1333 @item Recently Used Engines
1334 @cindex Recently Used Engines, In Menu
1335 At the bottom of the engine menu there can be a list of names
1336 of engines that you recently loaded through the Load Engine menu dialog
1337 in previous sessions.
1338 Clicking on such a name will load that engine as first engine,
1339 so you won't have to search for it in your list of installed engines,
1340 if that is very long.
1341 The maximum number of displayed engine names is set by the
1342 @code{recentEngines} command-line option.
1343 @end table
1344
1345 @node Options Menu
1346 @section Options Menu
1347 @cindex Menu, Options
1348 @cindex Options Menu
1349 @section General Options
1350 @cindex General Options, Menu Item
1351 The following items to set option values appear in the dialog
1352 summoned by the general Options menu item.
1353 @table @asis
1354 @item Absolute Analysis Scores
1355 @cindex Absolute Analysis Scores, Menu Item
1356 Controls if scores on the Engine Output window during analysis
1357 will be printed from the white or the side-to-move point-of-view.
1358 @item Almost Always Queen
1359 @cindex Almost Always Queen, Menu Item
1360 If this option is on, 7th-rank pawns automatically change into
1361 Queens when you pick them up,
1362 and when you drag them to the promotion square and release them there,
1363 they will promote to that.
1364 But when you drag such a pawn backwards first,
1365 its identity will start to cycle through the other available pieces.
1366 This will continue until you start to move it forward;
1367 at which point the identity of the piece will be fixed,
1368 so that you can safely put it down on the promotion square.
1369 If this option is off, what happens depends on the
1370 option @code{alwaysPromoteToQueen},
1371 which would force promotion to Queen when true.
1372 Otherwise XBoard would bring up a dialog
1373 box whenever you move a pawn to the last rank, asking what piece
1374 you want to promote to.
1375 @item Animate Dragging
1376 @cindex Animate Dragging, Menu Item
1377 If Animate Dragging is on, while you are dragging a piece with the
1378 mouse, an image of the piece follows the mouse cursor.
1379 If Animate Dragging is off, there is no visual feedback while you are
1380 dragging a piece, but if Animate Moving is on, the move will be
1381 animated when it is complete. 
1382 @item Animate Moving
1383 @cindex Animate Moving, Menu Item
1384 If Animate Moving is on, all piece moves are animated.  An image of the
1385 piece is shown moving from the old square to the new square when the
1386 move is completed (unless the move was already animated by Animate Dragging).
1387 If Animate Moving is off, a moved piece instantly disappears from its
1388 old square and reappears on its new square when the move is complete.
1389 The shifted @kbd{Ctrl-A} key is a keyboard equivalent.
1390 @item Auto Flag
1391 @cindex Auto Flag, Menu Item
1392 If this option is on and one player runs out of time
1393 before the other,
1394 XBoard
1395 will automatically call his flag, claiming a win on time.
1396 The shifted @kbd{Ctrl-F} key is a keyboard equivalent.
1397 In ICS mode, Auto Flag will only call your opponent's flag, not yours,
1398 and the ICS may award you a draw instead of a win if you have
1399 insufficient mating material.  In local chess engine mode,
1400 XBoard
1401 may call either player's flag.
1402 @item Auto Flip View
1403 @cindex Auto Flip View, Menu Item
1404 If the Auto Flip View option is on when you start a game, the board
1405 will be automatically oriented so that your pawns move from the bottom
1406 of the window towards the top.
1407
1408 If you are playing a game on an ICS, the board is always
1409 oriented at the start of the game so that your pawns move from
1410 the bottom of the window towards the top. Otherwise, the starting
1411 orientation is determined by the @code{flipView} command line option;
1412 if it is false (the default), White's pawns move from bottom to top
1413 at the start of each game; if it is true, Black's pawns move from
1414 bottom to top. @xref{User interface options}.
1415 @item Blindfold
1416 @cindex Blindfold, Menu Item
1417 If this option is on, XBoard displays the board as usual but does
1418 not display pieces or move highlights.  You can still move in the
1419 usual way (with the mouse or by typing moves in ICS mode), even though
1420 the pieces are invisible.
1421 @item Drop Menu
1422 @cindex Drop Menu, Menu Item
1423 Controls if right-clicking the board in crazyhouse / bughouse
1424 will pop up a menu to drop a piece on the clicked square
1425 (old, deprecated behavior)
1426 or allow you to step through an engine PV
1427 (new, recommended behavior).
1428 @item Enable Variation Trees
1429 @cindex Enable Variation Trees, Menu Item
1430 If this option is on, playing a move in Edit Game or Analyze mode
1431 while keeping the Shift key pressed will start a new variation.
1432 You can then recall the previous line through the @samp{Revert} menu item.
1433 When off, playing a move will truncate the game and append the move
1434 irreversibly.
1435 @item Headers in Engine Output Window
1436 @cindex Headers in Engine Output Window, Menu Item
1437 Controls the presence of column headers above the variations and
1438 associated information printed by the engine, on which you can issue
1439 button 3 clicks to open or close the columns.
1440 Available columns are search depth, score, node count, time used,
1441 tablebase hits, search speed and selective search depth.
1442 @item Hide Thinking
1443 @cindex Hide Thinking, Menu Item
1444 If this option is off, the chess engine's notion of the score and best
1445 line of play from the current position is displayed as it is
1446 thinking. The score indicates how many pawns ahead (or if negative,
1447 behind) the chess engine thinks it is. In matches between two
1448 machines, the score is prefixed by @samp{W} or @samp{B} to indicate
1449 whether it is showing White's thinking or Black's, and only the thinking
1450 of the engine that is on move is shown.
1451 The shifted @kbd{Ctrl-H} key is a keyboard equivalent.
1452 @item Highlight Last Move
1453 @cindex Highlight Last Move, Menu Item
1454 If Highlight Last Move is on, after a move is made, the starting and
1455 ending squares remain highlighted. In addition, after you use Backward
1456 or Back to Start, the starting and ending squares of the last move to
1457 be unmade are highlighted.
1458 @item Highlight with Arrow
1459 @cindex Highlight with Arrow, Menu Item
1460 Causes the highlighting described in Highlight Last Move to be done
1461 by drawing an arrow between the highlighted squares,
1462 so that it is visible even when the width of the grid lines is set to zero.
1463 @item One-Click Moving
1464 @cindex One-Click Moving, Menu Item
1465 If this option is on, XBoard does not wait for you to click both the
1466 from- and the to-square, or drag the piece, but performs a move as soon
1467 as it is uniqely specified.
1468 This applies to clicking an own piece that only has a single legal move,
1469 clicking an empty square or opponent piece where only one of your pieces
1470 can move (or capture) to.
1471 Furthermore, a double-click on a piece that can only make a single capture
1472 will cause that capture to be made.
1473 Promoting a Pawn by clicking its to-square will suppress the promotion
1474 popup or other methods for selecting an under-promotion, 
1475 and make it promote to Queen.
1476 @item Periodic Updates
1477 @cindex Periodic Updates, Menu Item
1478 If this option is off (or if
1479 you are using a chess engine that does not support periodic updates),
1480 the analysis window
1481 will only be updated when the analysis changes. If this option is
1482 on, the Analysis Window will be updated every two seconds.
1483 @item Play Move(s) of Clicked PV
1484 @cindex Play Move(s) of Clicked PV, Menu Item
1485 If this option is on, right-clicking on the first move of a PV
1486 or on the data fields left of it in the Engine Output window
1487 during Analyze mode will cause the first move of that PV to be played.
1488 You could also play more than one (or no) PV move by moving the mouse
1489 to engage in the PV walk such a right-click will start,
1490 to seek out another position along the PV where you want to continue
1491 the analysis, before releasing the mouse button.
1492 Clicking on later moves of the PV only temporarily show the moves
1493 for as long you keep the mouse button down,
1494 without adding them to the game.
1495 @item Ponder Next Move
1496 @cindex Ponder Next Move, Menu Item
1497 If this option is off, the chess engine will think only when it is on
1498 move.  If the option is on, the engine will also think while waiting
1499 for you to make your move.
1500 The shifted @kbd{Ctrl-P} key is a keyboard equivalent.
1501 @item Popup Exit Message
1502 @cindex Popup Exit Message, Menu Item
1503 If this option is on, when XBoard wants to display a message just
1504 before exiting, it brings up a modal dialog box and waits for you to
1505 click OK before exiting.  If the option is off, XBoard prints the
1506 message to standard error (the terminal) and exits immediately.
1507 @item Popup Move Errors
1508 @cindex Popup Move Errors, Menu Item
1509 If this option is off, when you make an error in moving (such as
1510 attempting an illegal move or moving the wrong color piece), the
1511 error message is displayed in the message area.  If the option is
1512 on, move errors are displayed in small pop-up windows like other errors.
1513 You can dismiss an error pop-up either by clicking its OK button or by
1514 clicking anywhere on the board, including down-clicking to start a move.
1515 @item Scores in Move List
1516 @cindex Scores in Move List, Menu Item
1517 If this option is on, XBoard will display the depth and score
1518 of engine moves in the Move List, in the format of a PGN comment.
1519 @item Show Coords
1520 @cindex Show Coords, Menu Item
1521 If this option is on, XBoard displays algebraic coordinates
1522 along the board's left and bottom edges.
1523 @item Show Target Squares
1524 @cindex Show Target Squares, Menu Item
1525 If this option is on, all squares a piece that is 'picked up' with the mouse
1526 can legally move to are highighted with a fat colored dot in
1527 yellow (non-captures) or red (captures).
1528 Special moves might have other colors
1529 (e.g. magenta for promotion, cyan for a partial move).
1530 Legality testing must be on for XBoard to know how the piece moves,
1531 but with legality testing off some engines would offer this information.
1532 @item Sticky Windows
1533 @cindex Sticky Windows, Menu Item
1534 Controls whether the auxiliary windows such as Engine Output, Move History
1535 and Evaluation Graph should keep touching XBoard's main window when
1536 you move the latter.
1537 @item Test Legality
1538 @cindex Test Legality, Menu Item
1539 If this option is on, XBoard tests whether the moves you try to make
1540 with the mouse are legal and refuses to let you make an illegal move.
1541 The shifted @kbd{Ctrl-L} key is a keyboard equivalent.
1542 Moves loaded from a file with @samp{Load Game} are also checked.  If
1543 the option is off, all moves are accepted, but if a local chess engine
1544 or the ICS is active, they will still reject illegal moves.  Turning
1545 off this option is useful if you are playing a chess variant with
1546 rules that XBoard does not understand.  (Bughouse, suicide, and wild
1547 variants where the king may castle after starting on the d file are
1548 generally supported with Test Legality on.)
1549 @item Top-Level Dialogs
1550 @cindex Top-Level Dialogs, Menu Item
1551 Controls whether the auxiliary windows will appear as icons in the
1552 task bar and independently controllable, or whether they open and
1553 minimize all together with the main window.
1554 @item Flash Moves
1555 @itemx Flash Rate
1556 @cindex Flash Moves, Menu Item
1557 @cindex Flash Rate, Menu Item
1558 If this option is non-zero, whenever a move is completed, 
1559 the moved piece flashes the specified number of times.
1560 The flash-rate setting determines how rapidly this flashing occurs.
1561 @item Animation Speed
1562 @cindex Animation Speed, Menu Item
1563 Determines the duration (in msec) of an animation step,
1564 when @samp{Animate Moving} is swiched on.
1565 @item Zoom factor in Evaluation Graph
1566 @cindex Zoom factor in Evaluation Graph, Menu Item
1567 Sets the value of the @code{evalZoom} option,
1568 indicating the factor by which the score interval (-1,1) should be
1569 blown up on the vertical axis of the Evaluation Graph.
1570 @end table
1571 @section Time Control
1572 @cindex Time Control, Menu Item
1573 Pops up a sub-menu where you can set the time-control parameters interactively.
1574 The shifted @kbd{Alt+T} key is a keyboard equivalent.
1575 @table @asis
1576 @item classical
1577 @cindex classical, Menu Item
1578 Selects classical TC,
1579 where the game is devided into sessions of a certain number of moves,
1580 and after each session the start time is again added to the clocks.
1581 @item incremental
1582 @cindex incremental, Menu Item
1583 Selects a TC mode where the game will start with a base time on the clocks,
1584 and after every move an 'increment' will be added to it.
1585 @item fixed max
1586 @cindex fixed max, Menu Item
1587 Selects a TC mode where you have to make each move within a given time,
1588 and any left-over time is not carried over to the next move.
1589 @item Divide entered times by 60
1590 @cindex Divide entered times by 60, Menu Item
1591 To allow entering of sub-minute initial time or sub-second increment,
1592 you can tick this checkbox.
1593 The initial time can then be entered in seconds,
1594 and the increment in units of 1/60 second.
1595 @item Moves per session
1596 @cindex Moves per session, Menu Item
1597 Sets the duration of a session for classical time control.
1598 @item Initial time
1599 @cindex Initial time, Menu Item
1600 Time initially on the clock in classical or incremental time controls.
1601 In classical time controls this time will also be added to the clock
1602 at the start of ach new session.
1603 @item Increment or max
1604 @cindex Increment or max, Menu Item
1605 Time to be added to the clock after every move in incremental TC mode.
1606 Fore 'fixed maximum' TC mode, the clock will be set to this time
1607 before every move, irrespective of how much was left on that clock.
1608 @item Time-Odds factors
1609 @cindex Time-Odds factors, Menu Item
1610 When these options are set to 1 the clocks of the players will be set
1611 according to the other specified TC parameters.
1612 Players can be given unequal times by specifying a time-odds factor
1613 for one of them (or a different factor for both of them).
1614 Any time received by that player will then be divided by that factor.
1615 @end table
1616
1617 @section Adjudications
1618 @cindex Adjudications, Menu Item
1619 Pops up a sub-menu where you can enable or disable various adjudications
1620 that XBoard can perform in engine-engine games.
1621 The shifted @kbd{Alt+J} key is a keyboard equivalent.
1622 @table @asis
1623 @item Detect all Mates
1624 @cindex Detect all Mates, Menu Item
1625 When this option is set
1626 XBoard will terminate the game on checkmate or stalemate,
1627 even if the engines would not do so.
1628 Only works when @samp{Test Legality} is on.
1629 @item Verify Engine Result Claims
1630 @cindex Verify Engine Result Claims, Menu Item
1631 When this option is set
1632 XBoard will verify engine result claims,
1633 (forfeiting engines that make false claims),
1634 rather than naively beleiving the engine.
1635 Only works when @samp{Test Legality} is on.
1636 @item Draw if Insufficient Mating Material
1637 @cindex Draw if Insufficient Mating Material, Menu Item
1638 When this option is set
1639 XBoard will terminate games with a draw result
1640 when so little material is left
1641 that checkmate is not longer possible.
1642 In normal Chess this applies to KK, KNK, KBK
1643 and some positions with multiple Bishops all on the same
1644 square shade.
1645 Only works when @samp{Test Legality} is on.
1646 @item Adjudicate Trivial Draws
1647 @cindex Adjudicate Trivial Draws, Menu Item
1648 When this option is set
1649 XBoard will terminate games with a draw result
1650 in positions that could only be won against an idiot.
1651 In normal Chess this applies to KNNK, KRKR, KBKN, KNKN,
1652 and KBKB with Bishops on different square shades.
1653 KQKQ will also be adjudicated a draw (possibly unjustly so).
1654 Only works when @samp{Test Legality} is on.
1655 @item N-Move Rule
1656 @cindex N-Move Rule, Menu Item
1657 When this option is set to a value differnt from zero
1658 XBoard will terminate games with a draw result
1659 after the specified number of reversible moves
1660 (i.e. without captures or pawn pushes) is made.
1661 @item N-fold Repeats
1662 @cindex N-fold Repeats, Menu Item
1663 When this option is set to a value larger than 1,
1664 XBoard will terminate games with a draw result when
1665 the same position has occurred the specified number of times.
1666 @item Draw after N Moves Total
1667 @cindex Draw after N Moves Total, Menu Item
1668 When this option is set to a value different from zero,
1669 XBoard will terminate games with a draw result
1670 after that many moves have been played.
1671 Useful in automated engine-engine matches,
1672 to prevent one game between stubborn engines will soak up
1673 all your computer time.
1674 @item Win / Loss Threshold
1675 @cindex Win / Loss Threshold, Menu Item
1676 When this option is set to a value different from zero,
1677 XBoard will terminate games as a win when both engines
1678 agree the score is above the specified value
1679 (interpreted as centi-Pawn)
1680 for three successive moves.
1681 @item Negate Score of Engine #1
1682 @itemx Negate Score of Engine #2
1683 @cindex Negate Score of Engine, Menu Item
1684 These options should be used with engines
1685 that report scores from the white point of view,
1686 rather than the side-to-move POV as XBoard would otherwise
1687 assume when adjudicating games based on the engine score.
1688 When the engine is installed with the extra option
1689 @code{firstScoreIsAbs} true in the engine list
1690 the option would be automatically set when the engine is
1691 loaded throuhgh the Engine menu,
1692 or with the @code{fe} or @code{se} command-line option.
1693 @end table
1694
1695 @section ICS Options
1696 @cindex ICS Options, Menu Item
1697 Pops up a menu dialog where options can be set that affect
1698 playing against an Internet Chess Server.
1699 @table @asis
1700 @item Auto-Kibitz
1701 @cindex Auto-Kibitz, Menu Item
1702 Setting this option when playing with or aginst a chess program on an ICS
1703 will cause the last line of thinking output of the engine before its move
1704 to be sent to the ICS in a kibitz command.
1705 In addition, any kibitz message received through the ICS from
1706 an opponent chess program will be diverted to the engine-output window,
1707 (and suppressed in the console),
1708 where you can play through its PV by right-clicking it.
1709 @item Auto-Comment
1710 @cindex Auto-Comment, Menu Item
1711 If this option is on, any remarks made on ICS while you are observing or
1712 playing a game are recorded as a comment on the current move.  This includes
1713 remarks made with the ICS commands @kbd{say}, @kbd{tell}, @kbd{whisper},
1714 and @kbd{kibitz}.
1715 Limitation: remarks that you type yourself are not recognized;
1716 XBoard scans only the output from ICS, not the input you type to it.
1717 @item Auto-Observe
1718 @cindex Auto-Observe, Menu Item
1719 If this option is on and you add a player to your @code{gnotify}
1720 list on ICS, XBoard will automatically observe all of that
1721 player's games, unless you are doing something else (such as
1722 observing or playing a game of your own) when one starts.
1723 The games are displayed 
1724 from the point of view of the player on your gnotify list; that is, his
1725 pawns move from the bottom of the window towards the top.
1726 Exceptions:  If both players in a game are on your gnotify list, if
1727 your ICS 
1728 @code{highlight}
1729 variable is set to 0, or if the ICS you are using does not 
1730 properly support observing from Black's point of view,
1731 you will see the game from White's point of view.
1732 @item Auto-Raise Board
1733 @cindex Auto Raise Board, Menu Item
1734 If this option is on, whenever a new game begins, the chessboard window
1735 is deiconized (if necessary) and raised to the top of the stack of windows.
1736 @item Auto Save
1737 @cindex Auto Save, Menu Item
1738 If this option is true, at the end of every game XBoard prompts
1739 you for a file name and appends a record of the game to the file
1740 you specify. 
1741 Disabled if the @code{saveGameFile} command-line
1742 option is set, as in that case all games are saved to the specified file.
1743 @xref{Load and Save options}.
1744 @item Background Observe while Playing
1745 @cindex Background Observe while Playing, Menu Item
1746 Setting this option will make XBoard suppress display of any boards
1747 from observed games while you are playing.
1748 Instead the last such board will be remembered,
1749 and shown to you when you right-click the board.
1750 This allows you to peek at your bughouse partner's game when you want,
1751 without disturbing your own game too much.
1752 @item Dual Board for Background-Observed Game
1753 @cindex Dual Board for Background-Observed Game, Menu Item
1754 Setting this option in combination with @samp{Background Observe}
1755 will display boards of observed games while you are playing
1756 on a second board next to that of your own game.
1757 @item Get Move List
1758 @cindex Get Move List, Menu Item
1759 If this option is on, whenever XBoard
1760 receives the first board of a new ICS game (or a different game from
1761 the one it is currently displaying), it
1762 retrieves the list of past moves from the ICS.
1763 You can then review the moves with the @samp{Forward} and @samp{Backward}
1764 commands
1765 or save them with @samp{Save Game}.  You might want to
1766 turn off this option if you are observing several blitz games at once,
1767 to keep from wasting time and network bandwidth fetching the move lists over
1768 and over.
1769 When you turn this option on from the menu, XBoard
1770 immediately fetches the move list of the current game (if any).
1771 @item Quiet Play
1772 @cindex Quiet Play, Menu Item
1773 If this option is on, XBoard will automatically issue an ICS
1774 @kbd{set shout 0}
1775 command whenever you start a game and a
1776 @kbd{set shout 1}
1777 command whenever you finish one.  Thus, you will not be distracted
1778 by shouts from other ICS users while playing.
1779 @item Seek Graph
1780 @cindex Seek Graph, Menu Item
1781 Setting this option will cause XBoard to display an graph of
1782 currently active seek ads when you left-click the board
1783 while idle and logged on to an ICS.
1784 @item Auto-Refresh Seek Graph
1785 @cindex Auto-Refresh Seek Graph, Menu Item
1786 In combination with the @samp{Seek Graph} option this
1787 will cause automatic update of the seek graph while it is up.
1788 This only works on FICS and ICC,
1789 and requires a lot of bandwidth on a busy server.
1790 @item Auto-InputBox PopUp
1791 @cindex Auto-InputBox PopUp, Menu Item
1792 Controls whether the ICS Input Box will pop up automatically when
1793 you type a printable character to the board window in ICS mode.
1794 @item Quit After Game
1795 @cindex Quit After Game, Menu Item
1796 Controls whether XBoard will automatically disconnect from the ICS
1797 and close when the game currently in progress finishes.
1798 @item Premove
1799 @itemx Premove for White
1800 @itemx Premove for Black
1801 @itemx First White Move
1802 @itemx First Black Move
1803 @cindex Premove, Menu Item
1804 @cindex Premove for White, Menu Item
1805 @cindex Premove for Black, Menu Item
1806 @cindex First White Move, Menu Item
1807 @cindex First Black Move, Menu Item
1808 If the @samp{Premove} option is on while playing a game on an ICS,
1809 you can register your next planned move before it is your turn.
1810 Move the piece with
1811 the mouse in the ordinary way, and the starting and ending squares
1812 will be highlighted with a special color (red by default).  When it is
1813 your turn, if your registered move is legal, XBoard will send it to
1814 ICS immediately; if not, it will be ignored and you can make a
1815 different move.  If you change your mind about your premove, either
1816 make a different move, or double-click on any piece to cancel the move
1817 entirely.
1818
1819 You can also enter premoves for the first white and black moves
1820 of the game.
1821 @item Alarm
1822 @itemx Alarm Time
1823 @cindex Alarm, Menu Item
1824 @cindex Alarm Time, Menu Item
1825 When this option is on, an alarm sound is played when your clock
1826 counts down to the @samp{Alarm Time} in an ICS game.
1827 (By default, the time is 5 seconds, but you can specify other values
1828 with the Alarm Time spin control.) 
1829 For games with time controls that include an increment, the
1830 alarm will sound each time the clock counts down to the icsAlarmTime.
1831 By default, the alarm sound is the terminal bell, but on some systems
1832 you can change it to a sound file using the soundIcsAlarm option; see
1833 below.
1834 @item Colorize Messages
1835 @cindex Colorize Messages, Menu Item
1836 Ticking this options causes various types of ICS messages do be
1837 displayed with different foreground or background colors in the console.
1838 The colors can be individually selected for each type,
1839 through the accompanying text edits.
1840 @item -icsMenu string
1841 @cindex icsMenu, option
1842 The string defines buttons for the @samp{ICS text menu}.
1843 Each button definition consists of two semi-colon-terminated pieces of text,
1844 the first giving the label to be written on the button,
1845 the second the text that should be sent to the ICS when that button is pressed.
1846 This second part (the 'message') can contain linefeeds, so that you can send
1847 multiple ICS commands with one button.
1848 Some message in the text, all starting with a $-sign, are treated special.
1849 When the message contains '$input', it will not be sent directly to the ICS,
1850 but will be put in the input field of the @samp{ICS Chat/Console},
1851 with the text cursor at the indicated place, so you can addsome text to
1852 the message before sending it off.
1853 If such a message starts with '$add' it will be placed behind any text
1854 that is already present in the input field, otherwise this field will
1855 be cleared first.
1856 The word '$name' occurring in the message will be replaced by the word
1857 that was clicked (through button 3) in the ICS Chat/Console.
1858 There are two special messages: '$chat' will open a new chat with
1859 the clicked word in the chat-partner field,
1860 while '$copy' will copy the text that is currently-selected
1861 in the ICS Console to the clipboard.
1862 An example of a text menu as it might occur in your settings file
1863 (where you could edit it):
1864
1865 @example
1866 -icsMenu @{copy;$copy;
1867 list players;who;
1868 list games;games;
1869 finger (player);finger $name;
1870 bullet (player);match $name 1 1 r;
1871 blitz (player);match $name 5 1 r;
1872 rapid (player);match $name 30 0 r;
1873 open chat (player);$chat;
1874 tell (player);tell $name $input;
1875 ask pieces;ptell Please give me a $input;
1876 P;$add Pawn $input;
1877 N;$add Knight $input;
1878 B;$add Bishop $input;
1879 R;$add Rook $input;
1880 Q;$add Queen $input;
1881 @}
1882 @end example
1883 @end table
1884
1885 @section Tournament Options
1886 @cindex Tournament Options, Menu Item
1887 Summons a dialog where you can set options important for playing automatic 
1888 matches between two or more chess programs 
1889 (e.g. by using the @samp{Machine Match} menu item in the @samp{Mode} menu).
1890 @table @asis
1891 @item Tournament file
1892 @cindex Tournament file, Menu item
1893 To run a tournament, XBoard needs a file to record its progress, 
1894 so it can resume the tourney when it is interrupted.
1895 When you want to conduct anything more complex than a simple 
1896 two-player match with the currently loaded engines, 
1897 (i.e. when you select a list of participants), 
1898 you must not leave this field blank. 
1899 When you enter the name of an existing tournament file, 
1900 XBoard will ignore all other input specified in the dialog, 
1901 and will take the corresponding info from that tournament file.
1902 This resumes an interrupted tournament, or adds another XBoard
1903 agent playing games for it to those that are already doing so.
1904 Specifying a not-yet-existing file will cause XBoard to create it, 
1905 according to the tournament parameters specified in the rest of the dialog, 
1906 before it starts the tournament on ‘OK’. 
1907 Provided that you specify participants; 
1908 without participants no tournament file will be made, but other entered values 
1909 (e.g. for the file with opening positions) will take effect. 
1910 Default: configured by the @code{defaultTourneyName} option.
1911 @item Sync after round
1912 @itemx Sync after cycle
1913 @cindex Sync after round, Menu Item
1914 @cindex Sync after cycle, Menu Item
1915 The sync options, when on, will cause WinBoard to refrain from starting games 
1916 of the next round or cycle before all games of the previous round or cycle are finished.
1917 This guarantees correct ordering in the games file,
1918 even when multiple XBoard instances are concurrently playing games for the same tourney.
1919 Default: sync after cycle, but not after round.
1920 @item Select Engine
1921 @itemx Tourney participants
1922 @cindex Select Engine, Menu Item
1923 @cindex Tourney participants, Menu Item
1924 From the Select Engine listbox you can pick an engine from your list 
1925 of engines registered in the settings file, to be added to the tournament.
1926 The engines selected so far will be listed in the ‘Tourney participants’ memo. 
1927 The latter is a normal text edit, so you can use normal text-editing functions 
1928 to delete engines you selected accidentally, or change their order. 
1929 Typing names here yourself is not recommended, because names that do not exactly match 
1930 one of the names from the selection listbox will lead to undefined behavior.
1931 @item Tourney type
1932 @cindex Tourney type, Menu Item
1933 Here you can specify the type of tournament you want. 
1934 XBoard’s intrinsic tournament manager support round-robins (type = 0), 
1935 where each participant plays every other participant, and (multi-)gauntlets, 
1936 where one (or a few) so-called ‘gauntlet engines’ play an independent set of opponents. 
1937 In the latter case, you specify the number of gauntlet engines. 
1938 E.g. if you specified 10 engines, and tourney type = 2, 
1939 the first 2 engines each play the remaining 8. 
1940 A value of -1 instructs XBoard to play Swiss; for this to work an external
1941 pairing engine must be specified through the @code{pairingEngine} option.
1942 Each Swiss round will be considered a tourney cycle in that case.
1943 Default:0
1944 @item Number of tourney cycles
1945 @itemx Default number of Games
1946 @cindex Number of tourney cycles, Menu Item
1947 @cindex Default number of Games, Menu Item
1948 You can specify tourneys where every two opponents play each other multiple times. 
1949 Such multiple games can be played in a row, 
1950 as specified by the ‘number of games per pairing’, 
1951 or by repeating the entire tournament schedule a number of times 
1952 (specified by the ‘number of tourney cycles’). 
1953 The total number of times two engines meet will be the product of these two. 
1954 Default is 1 cycle;
1955 the number of games per pairing is the same as the default number of match games, 
1956 stored in your settings file through the @code{defaultMatchGames} option.
1957 @item Save Tourney Games
1958 @cindex Save Tourney Games, Menu Item
1959 File where the tournament games are saved
1960 (duplicate of the item in the @samp{Save Game Options}).
1961 @item Game File with Opening Lines
1962 @itemx File with Start Positions
1963 @itemx Game Number
1964 @itemx Position Number
1965 @itemx Rewind Index after
1966 @cindex Game File with Opening Lines, Menu Item
1967 @cindex File with Start Positions, Menu Item
1968 @cindex Game Number, Menu Item
1969 @cindex Position Number, Menu Item
1970 @cindex Rewind Index after, Menu Item
1971 These items optionally specify the file with move sequences or board positions the tourney 
1972 games should start from.
1973 The corresponding numbers specify the number of the game or position in the file.
1974 Here a value -1 means automatic stepping through all games on the file,
1975 -2 automatic stepping every two games.
1976 The Rewind-Index parameter causes a stepping index to reset to one after reaching
1977 a specified value.
1978 A setting of -2 for the game number will also be effective in a tournament without
1979 specifying a game file, but playing from the GUI book instead.
1980 In this case the first (odd) games will randomly select from the book,
1981 but the second (even) games will select the same moves from the book as the previous game.
1982 (Note this leads to the same opening only if both engines use the GUI book!)
1983 Default: No game or position file will be used. The default index if such a file is used is 1.
1984 @item Disable own engine books be default
1985 @cindex Disable own engine books be default, Menu Item
1986 Setting this option reverses the default situation for use of the GUI opening book
1987 in tournaments from what it normally is, namely not using it.
1988 So unless the engine is installed with an option to explicitly specify it should
1989 not use the GUI book (i.e. @code{-firstHasOwnBookUCI true}),
1990 it will be made to use the GUI book.
1991 @item Replace Engine
1992 @itemx Upgrade Engine
1993 @cindex Replace Engine, Menu Item
1994 @cindex Upgrade Engine, Menu Item
1995 With these two buttons you can alter the participants of an already running tournament.
1996 After opening the Match Options dialog on an XBoard that is playing for the tourney,
1997 you will see all the tourney parameters in the dialog fields.
1998 You can then replace the name of one engine by that of another
1999 by editing the @samp{participants} field.
2000 (But preserve the order of the others!)
2001 Pressing the button after that will cause the substitution.
2002 With the @samp{Upgrade Engine} button the substitution will only affect future games.
2003 With @samp{Replace Engine} all games the substituted engine has already played will
2004 be invalidated, and they will be replayed with the substitute engine.
2005 In this latter case the engine must not be playing when you do this,
2006 but otherwise there is no need to pause the tournament play
2007 for making a substitution.
2008 @item Clone Tourney
2009 @cindex CloneTourney, Menu Item
2010 Pressing this button after you have specified an existing tournament file
2011 will copy the contents of the latter to the dialog,
2012 and then puts the originally proposed name for the tourney file back.
2013 You can then run a tourney with the same parameters
2014 (possibly after changing the proposed name of the tourney file for the new tourney)
2015 by pressing 'OK'.
2016 @item Continue Later
2017 @cindex Continue Later, Menu Item
2018 Pressing the @samp{Continue Later} button confirms the current value of all
2019 items in the dialog and closes it,
2020 but will not automatically start the tournament.
2021 This allows you to return to the dialog later without losing the settings you
2022 already entered, to adjust paramenters through other menu dialogs.
2023 (The @samp{Common Engine Setting}, @samp{Time Control} and @samp{General Options}
2024 dialogs can be accessed without closing the @samp{Tournament Options} dialog
2025 through the respective buttons at the bottom of the latter.)
2026 @end table
2027
2028 @section Load Game Options
2029 @cindex Load Game Options, Menu Item
2030 Summons a dialog where you can set options that control loading of games.
2031 @table @asis
2032 @item Auto-Display Tags
2033 @cindex Auto-Display Tags, Menu Item
2034 Setting this option causes a window to pop up on loading a game,
2035 displaying the PGN Tags for that game.
2036 @item Auto-Display Comment
2037 @cindex Auto-Display Comment, Menu Item
2038 Setting this option causes a window to pop up whenever there
2039 is a comment to (or variation on) the currently displayed move.
2040 @item Auto-Play speed of loaded games
2041 @cindex Auto-Play speed, Menu Item
2042 This option sets the number of seconds between moves
2043 when a newly loaded game is auto-playing.
2044 A decimal fraction on the number is understood.
2045 Setting it to -1 disables auto-play, staying in the start position
2046 of the game after the loading completes.
2047 Setting it to 0 will instantly move to the final position of the game.
2048 The @samp{Auto-Play speed} is also used to determine the
2049 analysis time for each move during @samp{Analyze Game}.
2050 Note that auto-playing (including game analysis) can be stopped at any
2051 time through the @samp{P} button above the board.
2052 @item options to use in game-viewer mode
2053 @cindex Game-Viewer options, Menu Item
2054 Specifies the options automatically set when XBoard is invoked
2055 with the option @code{-viewer} on its command line,
2056 as will happen when it is started in response to clicking a PGN game file.
2057 The default setting would start XBoard without engine
2058 (due to the @code{-ncp} option),
2059 but if you want it to automatically start with your favorite engine,
2060 and automatically start analyzing, you could include the necessary
2061 options for that here (e.g. @code{-fe <engine> -initialMode analysis}).
2062 @item Thresholds for position filtering in game list
2063 @cindex Thresholds for game selection, Menu Item
2064 The following options can be set to limit the display of games
2065 in the @samp{Game List} window to a sub-set,
2066 meeting the specified criteria.
2067 @item Elo of strongest player at least
2068 @item Elo of weakest player at least
2069 @cindex Elo limits, Menu Item
2070 Games with an Elo tag specifying a lower rating for the mentioned player
2071 will not be diplayed in the @samp{Game List}. 
2072 @item No games before year
2073 @cindex Date limit, Menu item
2074 Games with a Date tag before the specified year
2075 will not be diplayed in the @samp{Game List}. 
2076 @item Final nr of pieces
2077 @cindex Final number of pieces, Menu Item
2078 A single number or a range (like 8-10) can be entered here,
2079 and will cause only games where the number of men in the final
2080 position is in the given range
2081 will be diplayed in the @samp{Game List}. 
2082 @item Minimum nr consecutive positions
2083 @cindex Consecutive positions, Menu Item
2084 Specifies for how many consecutive positions the more fuzzy
2085 position-matching criteria have to be satisfied
2086 in order to count as a match.
2087 @item Search mode
2088 @itemx find position
2089 @cindex Search mode, Menu Item
2090 @cindex find position, Menu Item
2091 XBoard can select games for display in the @samp{Game List}
2092 based on whether (in addition to the conditions on the PGN tags)
2093 they contain a position that matches the
2094 position currently displayed on the board,
2095 by pressing the @samp{find position}
2096 or @samp{narrow} buttons in the @samp{Game List} window.
2097 The @samp{Search mode} setting determines what counts as match.
2098 You can search for an exact match, 
2099 a position that has all shown material in the same place, 
2100 but might contain additional material,
2101 a position that has all Pawns in the same place,
2102 but can have the shown material anywhere,
2103 a position that can have all shown material anywhere,
2104 or a position that has material between certain limits anywhere.
2105 For the latter you have to place the material that must minimally be present
2106 in the four lowest ranks of the board,
2107 and optional additional material in the four highest ranks of the board.
2108 You can request the optional material to be balanced,
2109 i.e. equal for white and black.
2110 @item narrow
2111 @cindex narrow, Menu Item
2112 The @samp{narrow} button is similar in fuction to the @samp{find position} button,
2113 but only searches in the already selected games,
2114 rather than the complete game file,
2115 and can thus be used to refine a search based on multiple criteria.
2116 @item Also match reversed colors
2117 @itemx Also match left-right flipped position
2118 @cindex Match reversed colors, Menu Item
2119 @cindex Match left-right flipped position, Menu Item
2120 When looking for matching positions rather than by material,
2121 these settings determine whether mirror images 
2122 (in case of a vertical flip in combination with color reversal)
2123 will be also considered a match.
2124 The left-right flipping is only useful after all castling rights
2125 have expired (or in Xiangqi).
2126 @end table
2127
2128 @section Save Game Options
2129 @cindex Save Game Options, Menu Item
2130 Summons a dialog where you can specify whether XBoard should
2131 automatically save files of games when they finish,
2132 and where and how to do that.
2133 @table @asis
2134 @item Auto-Save Games
2135 @cindex Auto-Save Games, Menu Item
2136 When set XBoard will automatically save games on a file as they finish.
2137 (Not when you abort them by pressing @samp{New Game}, though!)
2138 It will either prompt you for a filename,
2139 or use the file specified  by the @code{saveGameFile} option.
2140 @item Own Games Only
2141 @cindex Own Games Only, Menu Item
2142 Setting this option will exclude games by others observed on an
2143 Internet Chess Server from automatic saving.
2144 @item Save Games on File
2145 @cindex Save Games on File, Menu Item
2146 Name of the file on which games should be saved automatically.
2147 Games are always appended to the file,
2148 and will never overwrite anything.
2149 @item Save Final Position on File
2150 @cindex Save Final Position on File, Menu Item
2151 When a name is defined, the final position of each game
2152 is appended to the mentioned file.
2153 @item PGN Event Header
2154 @cindex PGN Event Header, Menu Item
2155 Specifies the name of the event used in the PGN event tag
2156 of new games that you create.
2157 @item Old Save Style
2158 @cindex Old Save Style, Menu Item
2159 Saves games in an obsolete and now long forgotten format,
2160 rather than as PGN. Never use this for orthodox Chess!
2161 @item Include Number Tag in tourney PGN
2162 @cindex Include Number Tag in tourney PGN, Menu Item
2163 When on this option will cause the non-standard 'Number' tag
2164 to be written in any game saved in PGN format.
2165 It will contain the unique number of the game in the tourney.
2166 (As opposed to the 'Round' tag, which can be shared by many games.)
2167 @item Save Score/Depth Info in PGN
2168 @cindex Save Score/Depth in PGN, Menu Item
2169 When on this option will cause the score and depth at which it was
2170 calculated by an engine, and (when available) thinking time
2171 to be saved with the move as a comment to the move,
2172 in the format @{score/depth time@}.
2173 Here 'score'is in pawn units from the point of view of the player
2174 that made the move, with two digits behind the decimal Pawn.
2175 'Time' is in seconds, or min:sec.
2176 @item Save Out-of-Book Info in PGN
2177 @cindex Save Out-of-Book Info in PGN, Menu Item
2178 When on this option causes the score of the first move
2179 the engine made after coming out of book in an 'Annotator' PGN tag.
2180 @end table
2181
2182 @section Game List
2183 @cindex Game List Tags, Menu Item
2184 Pops up a dialog where you can select the PGN tags that should appear
2185 on the lines in the @samp{Game List}, and their order.
2186
2187 @section Sound Options
2188 @cindex Sound Options, Menu Item
2189 Summons a dialog where you can specify the sounds that should accompany
2190 various events that can occur in XBoard.
2191 Most events are only relevant to ICS play, 
2192 but the move sound is an important exception.
2193 For each event listed in the dialog, 
2194 you can select a standard sound from a menu.
2195 @table @asis
2196 @item Sound Program
2197 @cindex Sound Program, Menu Item
2198 Specifies the command XBoard should invoke to play sounds.
2199 The specified text will be suffixed by the name of the sound file,
2200 and then run as a command.
2201 @item Sounds Directory
2202 @cindex Sounds Directory, Menu Item
2203 Specifies the directory where XBoard will look for files with
2204 the names of the standard sounds.
2205 @item User WAV File
2206 @cindex User WAV File, Menu Item
2207 When we type a filename here, it can be assigned to the events
2208 by selecting @samp{Above WAV File} from the drop downs.
2209 @item Try-Out Sound
2210 @itemx Play
2211 @cindex Try-Out Sound, Menu Item
2212 The 'event' triggering the Try-Out sound is pressing
2213 of the @samp{Play} button behind it.
2214 This allows you to judge the sounds.
2215 @end table
2216
2217 @section Save Settings Now
2218 @cindex Save Settings Now, Menu Item
2219 Selecting this menu item causes the current XBoard settings to be
2220 written to the settings file, (.xboardrc in your home directory),
2221 so they will also apply in future sessions.
2222 Note that some settings are 'volatile', and are not saved,
2223 because XBoard considers it too unlikely that you want those to apply
2224 next time.
2225 In particular this applies to the Chess program, and all options
2226 giving information on those Chess programs (such as their directory,
2227 if they have their own opening book, if they are UCI or native XBoard),
2228 or the variant you are playing.
2229 Such options would still be understood when they appear in the settings
2230 file in case they were put there with the aid of a text editor, but they
2231 would disappear from the file as soon as you save the settings.
2232
2233 Note that XBoard no longer pays attention to options values specified
2234 in the .Xresources file.
2235 (Specifying key bindings there will still work, though.)
2236 To alter the default of volatile options, you can use the following method:
2237 Rename your ~/.xboardrc settings file (to ~/.yboardrc, say), and create
2238 a new file ~/.xboardrc, which only contains the options
2239
2240 @example
2241 -settingsFile  ~/.yboardrc
2242 -saveSettingsFile  ~/.yboardrc
2243 @end example
2244
2245 @noindent
2246 This will cause your settings to be saved on ~/.yboardrc in the future,
2247 so that ~/.xboardrc is no longer overwritten.
2248 You can then safely specify volatile options in ~/.xboardrc, either
2249 before or after the settingsFile options.
2250 Note that when you specify persistent options after the settingsFile options
2251 in this ~/.xboardrc, you will essentially turn them into volatile options
2252 with the specified value as default, because that value will overrule
2253 the value loaded from the settings file (being read later).
2254
2255 @section Save Settings on Exit
2256 @cindex Save Settings on Exit, Menu Item
2257 Setting this option has no immediate effect, but causes the settings
2258 to be saved when you quit XBoard. What happens then is otherwise 
2259 identical to what happens when you use select "Save Settings Now",
2260 see there.
2261
2262 @node Help Menu
2263 @section Help Menu
2264 @cindex Menu, Help
2265 @cindex Help Menu
2266 @table @asis
2267 @item Info XBoard
2268 @cindex Info XBoard, Menu Item
2269 Displays the XBoard documentation in info format.  For this feature to
2270 work, you must have the GNU info program installed on your system, and
2271 the file @file{xboard.info} must either be present in the current
2272 working directory, or have been installed by the @samp{make install}
2273 command when you built XBoard.
2274 @item Man XBoard
2275 @cindex Man XBoard, Menu Item
2276 Displays the XBoard documentation in man page format.
2277 The @kbd{F1} key is a keyboard equivalent.  For this
2278 feature to work, the file @file{xboard.6} must have been installed by
2279 the @samp{make install} command when you built XBoard, and the
2280 directory it was placed in must be on the search path for your
2281 system's @samp{man} command.
2282 @item About XBoard
2283 @cindex About XBoard, Menu Item
2284 Shows the current XBoard version number.
2285 @end table
2286
2287 @node Keys
2288 @section Other Shortcut Keys
2289 @cindex Keys
2290 @cindex Shortcut keys
2291 @table @asis
2292 @item Show Last Move
2293 @cindex Show Last Move, Shortcut Key
2294 By hitting @kbd{Enter} the last move will be re-animated.
2295 @item Load Next Game
2296 @cindex Load Next Game, Menu Item
2297 Loads the next game from the last game record file you loaded.
2298 The @kbd{Alt+PgDn} key triggers this action.
2299 @item Load Previous Game
2300 @cindex Load Previous Game, Menu Item
2301 Loads the previous game from the last game record file you
2302 loaded.  The @kbd{Alt+PgUp} key triggers this action.
2303 Not available if the last game was loaded from a pipe.
2304 @item Reload Same Game
2305 @cindex Reload Same Game, Menu Item
2306 Reloads the last game you loaded.
2307 Not available if the last game was loaded from a pipe.
2308 Currently no keystroke is assigned to this ReloadGameProc.
2309 @item Reload Same Position
2310 @cindex Reload Same Position, Menu Item
2311 Reloads the last position you loaded.
2312 Not available if the last position was loaded from a pipe.
2313 Currently no keystroke is assigned to this ReloadPositionProc.
2314 @end table
2315
2316 In the Xaw build of XBoard you can add or remove shortcut keys
2317 using the X resources @code{paneA.translations}.
2318 Here is an example of what could go into your
2319 @file{.Xdefaults} file:
2320
2321 @example
2322 XBoard*paneA.translations: \
2323   Shift<Key>?: MenuItem(Help.About) \n\
2324   Ctrl<Key>y: MenuItem(Action.Accept) \n\
2325   Ctrl<Key>n: MenuItem(Action.Decline) \n\
2326   Ctrl<Key>i: MenuItem(Nothing)
2327 @end example
2328 @noindent
2329 So the key should always be bound to the action 'MenuItem',
2330 with the (hierarchical) name of the menu item as argument.
2331 There are a few actions available for which no menu item exists:
2332 Binding a key to @code{Nothing} makes it do nothing, thus removing
2333 it as a shortcut key. Other such functions that can be bound to keys
2334 are:
2335
2336 @example
2337 AboutGame, DebugProc (switches the -debug option on or off),
2338 LoadNextGame, LoadPrevGame, ReloadGame, ReloadPosition.
2339 @end example
2340
2341 @node Options
2342 @chapter Options
2343 @cindex Options
2344 @cindex Options
2345
2346 This section documents the command-line options to XBoard.  You can
2347 set these options in two ways: by typing them on the shell command
2348 line you use to start XBoard, or by editing the settings file
2349 (usually ~/.xboardrc) to alter the value of the setting that was
2350 saved there.  Some of the options
2351 cannot be changed while XBoard is running; others set the initial
2352 state of items that can be changed with the @ref{Options} menu.
2353
2354 Most of the options have both a long name and a short name. To turn a
2355 boolean option on or off from the command line, either give its long
2356 name followed by the value true or false
2357 (@samp{-longOptionName true}), or give just the short name to turn the
2358 option on (@samp{-opt}), or the short name preceded by @samp{x} to
2359 turn the option off (@samp{-xopt}). For options that take strings or
2360 numbers as values, you can use the long or short option names
2361 interchangeably.
2362
2363 @menu
2364 * Chess engine options::        Controlling the chess engine.
2365 * UCI + WB Engine Settings::    Setting some very common engine parameters
2366 * Tournament options::          Running tournaments and matches between engines.
2367 * ICS options::                 Connecting to and using ICS.
2368 * Load and Save options::       Input/output options.
2369 * User interface options::      Look and feel options.
2370 * Adjudication Options::        Control adjudication of engine-engine games.
2371 * Install options::             Maintaining and extending the XBoard install.
2372 * Other options::               Miscellaneous.
2373 @end menu
2374
2375 @node Chess engine options
2376 @section Chess Engine Options
2377 @cindex options, Chess engine
2378 @cindex Chess engine options
2379 @table @asis
2380 @item -tc or -timeControl minutes[:seconds]
2381 @cindex tc, option
2382 @cindex timeControl, option
2383 Each player begins with his clock set to the @code{timeControl} period.
2384 Default: 5 minutes.
2385 The additional options @code{movesPerSession} and @code{timeIncrement}
2386 are mutually exclusive.  
2387 @item -mps or -movesPerSession moves
2388 @cindex mps, option
2389 @cindex movesPerSession, option
2390 When both players have made @code{movesPerSession} moves, a
2391 new @code{timeControl} period is added to both clocks.  Default: 40 moves.
2392 @item -inc or -timeIncrement seconds
2393 @cindex inc, option
2394 @cindex timeIncrement, option
2395 If this option is specified, @code{movesPerSession} is ignored.
2396 Instead, after each player's move, @code{timeIncrement} seconds are
2397 added to his clock.  
2398 Use @samp{-inc 0} if you want to require the entire
2399 game to be played in one @code{timeControl} period, with no increment.
2400 Default: -1, which specifies @code{movesPerSession} mode.
2401 @item -clock/-xclock or -clockMode true/false
2402 @cindex clock, option
2403 @cindex clockMode, option
2404 Determines whether or not to display the chess clocks. If clockMode is
2405 false, the clocks are not shown, but the side that is to play next
2406 is still highlighted. Also, unless @code{searchTime}
2407 is set, the chess engine still keeps track of the clock time and uses it to
2408 determine how fast to make its moves.
2409 @item -st or -searchTime minutes[:seconds]
2410 @cindex st, option
2411 @cindex searchTime, option
2412 Tells the chess engine to spend at most the given amount of time
2413 searching for each of its moves. Without this option, the chess engine
2414 chooses its search time based on the number of moves and amount
2415 of time remaining until the next time control.
2416 Setting this option also sets clockMode to false.
2417 @item -depth or -searchDepth number
2418 @cindex sd, option
2419 @cindex searchDepth, option
2420 Tells the chess engine to look ahead at most the given number of moves
2421 when searching for a move to make. Without this option, the chess
2422 engine chooses its search depth based on the number of moves and
2423 amount of time remaining until the next time control.  With the option,
2424 the engine will cut off its search early if it reaches the specified depth.
2425 @item -firstNPS number
2426 @itemx -secondNPS number
2427 @cindex firstNPS, option
2428 @cindex secondNPS, option
2429 Tells the chess engine to use an internal time standard based on its node count, 
2430 rather then wall-clock time, to make its timing decisions. 
2431 The time in virtual seconds should be obtained by dividing the node count 
2432 through the given number, like the number was a rate in nodes per second. 
2433 Xboard will manage the clocks in accordance with this, relying on the number 
2434 of nodes reported by the engine in its thinking output. If the given number equals zero, 
2435 it can obviously not be used to convert nodes to seconds, and the time reported 
2436 by the engine is used to decrement the XBoard clock in stead. The engine is supposed to 
2437 report in CPU time it uses, rather than wall-clock time, in this mode. This option 
2438 can provide fairer conditions for engine-engine matches on heavily loaded machines, 
2439 or with very fast games (where the wall clock is too inaccurate). 
2440 @code{showThinking} must be on for this option to work. Default: -1 (off).
2441 Not many engines might support this yet!
2442 @item -firstTimeOdds factor
2443 @itemx -secondTimeOdds factor
2444 @cindex firstTimeOdds, option
2445 @cindex secondTimeOdds, option
2446 Reduces the time given to the mentioned engine by the given factor. 
2447 If pondering is off, the effect is indistinguishable from what would happen 
2448 if the engine was running on an n-times slower machine. Default: 1.
2449 @item -timeOddsMode mode
2450 @cindex timeOddsMode, option
2451 This option determines how the case is handled where both engines have a time-odds handicap. 
2452 If mode=1, the engine that gets the most time will always get the nominal time, 
2453 as specified by the time-control options, and its opponent's time is renormalized accordingly. 
2454 If mode=0, both play with reduced time. Default: 0.
2455 @item -hideThinkingFromHuman true/false
2456 Controls the Hide Thinking option. @xref{Options Menu}. Default: true.
2457 (Replaces the Show-Thinking option of older xboard versions.)
2458 @item -thinking/-xthinking or -showThinking true/false
2459 @cindex thinking, option
2460 @cindex showThinking, option
2461 Forces the engine to send thinking output to xboard. 
2462 Used to be the only way to control if thinking output was displayed 
2463 in older xboard versions,
2464 but as the thinking output in xboard 4.3 is also used for several other
2465 purposes (adjudication, storing in PGN file) the display of it is now controlled
2466 by the new option Hide Thinking. @xref{Options Menu}. Default: false.
2467 (But if xboard needs the thinking output for some purpose,
2468 it makes the engine send it despite the setting of this option.)
2469 @item -ponder/-xponder or -ponderNextMove true/false
2470 @cindex ponder, option
2471 @cindex ponderNextMove, option
2472 Sets the Ponder Next Move menu option. @xref{Options Menu}. Default: true.
2473 @item -smpCores number
2474 Specifies the maximum number of CPUs an SMP engine is allowed to use.
2475 Only works for engines that support the XBoard/WinBoard-protocol cores feature.
2476 @item -mg or -matchGames n
2477 @cindex mg, option
2478 @cindex matchGames, option
2479 Automatically runs an n-game match between two chess engines,
2480 with alternating colors.
2481 If the @code{loadGameFile} or @code{loadPositionFile} option is set,
2482 XBoard
2483 starts each game with the given opening moves or the given position;
2484 otherwise, the games start with the standard initial chess position.
2485 If the @code{saveGameFile} option is set, a move record for the
2486 match is appended to the specified file. If the @code{savePositionFile}
2487 option is set, the final position reached in each game of the match is appended
2488 to the specified file. When the match is over, XBoard
2489 displays the match score and exits. Default: 0 (do not run a match).
2490 @item -mm/-xmm or -matchMode true/false
2491 @cindex mm, option
2492 @cindex matchMode, option
2493 Setting @code{matchMode} to true is equivalent to setting
2494 @code{matchGames} to 1.
2495 @item -sameColorGames n
2496 @cindex sameColorGames, option
2497 Automatically runs an n-game match between two chess engines,
2498 without alternating colors.
2499 Otherwise the same applies as for the @samp{-matchGames} option,
2500 over which it takes precedence if both are specified. (See there.)
2501 Default: 0 (do not run a match).
2502 @item -epd
2503 @cindex epd, option
2504 This option puts XBoard in a special mode for solving EPD test-suites,
2505 for the entire duration of the session.
2506 In this mode games are aborted after a single move,
2507 and that move will be compared with the best-move or avoid-move
2508 from the EPD position description from which the 'game' was started.
2509 Playing a best move counts as a win, playing an avoid move as a loss,
2510 and playing any other move counts as a draw.
2511 This option should be used in combination with match mode,
2512 and an EPD file of starting positions with an auto-incrementing index.
2513 Color assignment will be such that the first engine plays all moves,
2514 and the second engine will be never involved.
2515 The results for individual positions,
2516 as well as the time used for solving them,
2517 will be reported in the lower pane of the Engine Output window.
2518 @item -fcp or -firstChessProgram program
2519 @itemx -scp or -secondChessProgram program
2520 @cindex fcp, option
2521 @cindex firstChessProgram, option
2522 @cindex scp, option
2523 @cindex secondChessProgram, option
2524 Name of first and second chess engine, respectively.
2525 A second chess engine is started only in Two Machines (match) mode,
2526 or in Analyze mode with two engines.
2527 The second engine is by default the same as the first.
2528 Default for the first engine: @file{fairymax}.
2529 @item -fe or -firstEngine nickname
2530 @itemx -se or -secondEngine nickname
2531 @cindex se, option
2532 @cindex secondEngine, option
2533 @cindex fe, option
2534 @cindex firstEngine, option
2535 This is an alternative to the @code{fcp} and @code{scp} options
2536 for specifying the first and second engine,
2537 for engines that were already registered (using the @samp{Load Engine} dialog)
2538 in XBoard's settings file.
2539 It will not only retrieve the real name of the engine,
2540 but also all options configured with it.
2541 (E.g. if it is UCI, whether it should use book.)
2542 @item -fb/-xfb or -firstPlaysBlack true/false
2543 @cindex fb, option
2544 @cindex firstPlaysBlack, option
2545 In games between two chess engines, firstChessProgram normally plays
2546 white.  If this option is true, firstChessProgram plays black.  In a
2547 multi-game match, this option affects the colors only for the first
2548 game; they still alternate in subsequent games.
2549 @item -fh or -firstHost host
2550 @itemx -sh or -secondHost host
2551 @cindex fh, option
2552 @cindex firstHost, option
2553 @cindex sh, option
2554 @cindex secondHost, option
2555 Hosts on which the chess engines are to run. The default for
2556 each is @file{localhost}. If you specify another host, XBoard
2557 uses @file{rsh} to run the chess engine there. (You can substitute a
2558 different remote shell program for rsh using the @code{remoteShell}
2559 option described below.)
2560 @item -fd or -firstDirectory dir
2561 @itemx -sd or -secondDirectory dir
2562 @cindex fd, option
2563 @cindex firstDirectory, option
2564 @cindex sd, option
2565 @cindex secondDirectory, option
2566 Working directories in which the chess engines are to be run.
2567 The default is "", which means to run the chess engine
2568 in the same working directory as XBoard
2569 itself.  (See the CHESSDIR environment variable.)
2570 This option is effective only when the chess engine is being run
2571 on the local host; it does not work if the engine is run remotely
2572 using the -fh or -sh option.
2573 @item -initString string or -firstInitString
2574 @itemx -secondInitString string
2575 @cindex initString, option
2576 @cindex firstInitString, option
2577 @cindex secondInitString, option
2578 The string that is sent to initialize each chess engine for a new game.
2579 Default:
2580
2581 @example
2582 new
2583 random
2584 @end example
2585 @noindent
2586 Setting this option from the command line is tricky, because you must
2587 type in real newline characters, including one at the very end.
2588 In most shells you can do this by
2589 entering a @samp{\} character followed by a newline. 
2590 Using the character sequence @samp{\n} in the string should work too, though.
2591
2592 If you change this option, don't remove the @samp{new} 
2593 command; it is required by all chess engines to
2594 start a new game.
2595
2596 You can remove the @samp{random} command if you like; including it
2597 causes GNU Chess 4 to randomize its move selection slightly so that it
2598 doesn't play the same moves in every game.  Even without
2599 @samp{random}, GNU Chess 4 randomizes its choice of moves from its
2600 opening book.  Many other chess engines ignore this command entirely
2601 and always (or never) randomize.
2602
2603 You can also try adding other commands to the initString; see the
2604 documentation of the chess engine you are using for details.
2605 @item -firstComputerString string
2606 @itemx -secondComputerString string
2607 @cindex firstComputerString, option
2608 @cindex secondComputerString, option
2609 The string that is sent to the chess engine if its opponent is another
2610 computer chess engine.  The default is @samp{computer\n}.  Probably the
2611 only useful alternative is the empty string (@samp{}), which keeps the
2612 engine from knowing that it is playing another computer.
2613 @item -reuse/-xreuse or -reuseFirst true/false
2614 @itemx -reuse2/-xreuse2 or -reuseSecond true/false
2615 @cindex reuse, option
2616 @cindex reuseFirst, option
2617 @cindex reuse2, option
2618 @cindex reuseSecond, option
2619 If the option is false,
2620 XBoard kills off the chess engine after every game and starts
2621 it again for the next game.  
2622 If the option is true (the default), 
2623 XBoard starts the chess engine only once
2624 and uses it repeatedly to play multiple games.
2625 Some old chess engines may not work properly when
2626 reuse is turned on, but otherwise games will start faster if it is left on.
2627 @item -firstProtocolVersion version-number
2628 @itemx -secondProtocolVersion version-number
2629 @cindex firstProtocolVersion, option
2630 @cindex secondProtocolVersion, option
2631 This option specifies which version of the chess engine communication
2632 protocol to use.  By default, version-number is 2.  In version 1, the
2633 "protover" command is not sent to the engine; since version 1 is a
2634 subset of version 2, nothing else changes.  Other values for
2635 version-number are not supported.
2636 @item -firstScoreAbs true/false
2637 @itemx -secondScoreAbs true/false
2638 @cindex firstScoreAbs, option
2639 @cindex secondScoreAbs, option
2640 If this option is set, the score reported by the engine is taken to be 
2641 that in favor of white, even when the engine plays black. 
2642 Important when XBoard uses the score for adjudications, or in PGN reporting. 
2643 @item -niceEngines priority
2644 @cindex niceEngines, option
2645 This option allows you to lower the priority of the engine processes, 
2646 so that the generally insatiable hunger for CPU time of chess engines does not interfere so much 
2647 with smooth operation of XBoard (or the rest of your system). 
2648 Negative values could increase the engine priority, which is not recommended.
2649 @item -firstOptions string
2650 @itemx -secondOptions string
2651 @cindex firstOptions, option
2652 @cindex secondOptions, option
2653 The given string is a comma-separated list of (option name=option value) pairs, 
2654 like the following example: "style=Karpov,blunder rate=0". 
2655 If an option announced by the engine at startup through the feature commands of the XBoard/WinBoard protocol 
2656 matches one of the option names (i.e. "style" or "blunder rate"), 
2657 it would be set to the given value (i.e. "Karpov" or 0) 
2658 through a corresponding option command to the engine. 
2659 This provided that the type of the value (text or numeric) matches as well.
2660 @item -firstNeedsNoncompliantFEN string
2661 @itemx -secondNeedsNoncompliantFEN string
2662 @cindex firstNeedsNoncompliantFEN, option
2663 @cindex secondNeedsNoncompliantFEN, option
2664 The castling rights and e.p. fields of the FEN sent to the mentioned engine 
2665 with the setboard command will be replaced by the given string. This can for 
2666 instance be used to run engines that do not understand Chess960 FENs in 
2667 variant fischerandom, to make them at least understand the opening position, 
2668 through setting the string to "KQkq -". (Note you also have to give the e.p. field!) 
2669 Other possible applications are to provide work-arounds for engines that want to see 
2670 castling and e.p. fields in variants that do not have castling or e.p. 
2671 (shatranj, courier, xiangqi, shogi) so that XBoard would normally omit them 
2672 (string = "- -"), or to add variant-specific fields that are not yet supported by XBoard 
2673 (e.g. to indicate the number of checks in 3check).
2674 @item -shuffleOpenings
2675 @cindex shuffleOpenings, option
2676 Forces shuffling of the opening setup in variants that normally have a fixed initial position.
2677 Shufflings are symmetric for black and white, and exempt King and Rooks in variants
2678 with normal castling.
2679 Remains in force until a new variant is selected.
2680 @item -fischerCastling
2681 @cindex fischerCastling, option
2682 Specifies Fischer castling (as in Chess960) should be enabled in variants
2683 that normally would not have it.
2684 Remains in force until a new variant is selected.
2685 @end table
2686
2687 @node UCI + WB Engine Settings
2688 @section UCI + WB Engine Settings
2689 @cindex Engine Settings
2690 @cindex Settings, Engine
2691 @table @asis
2692 @item -fUCI or -firstIsUCI true/false
2693 @itemx -sUCI or -secondIsUCI true/false
2694 @cindex fUCI, option
2695 @cindex sUCI, option
2696 @cindex firstIsUCI, option
2697 @cindex secondIsUCI, option
2698 Indicates if the mentioned engine executable file is a UCI engine, 
2699 and should be run with the aid of the Polyglot adapter rather than directly. 
2700 Xboard will then pass the other UCI options and engine name to Polyglot 
2701 on its command line, according to the option @code{adapterCommand}.
2702 @item -fUCCI
2703 @itemx -sUCCI
2704 @itemx -fUSI
2705 @itemx -sUSI
2706 @cindex fUCCI, option
2707 @cindex sUCCI, option
2708 @cindex fUSI, option
2709 @cindex sUSI, option
2710 Options similar to @code{fUCI} and @code{sUCI}, except that they
2711 use the indicated engine with the protocol adapter specified in
2712 the @samp{uxiAdapter} option.
2713 This can then be configured for running a UCCI or USI adapter,
2714 as the need arises.
2715 @item -adapterCommand string
2716 @cindex adapterCommand, option
2717 The string contains the command that should be issued by XBoard
2718 to start an engine that is accompanied by the @code{fUCI} option.
2719 Any identifier following a percent sign in the command (e.g. %fcp)
2720 will be considered the name of an XBoard option, and be replaced
2721 by the value of that option at the time the engine is started.
2722 For starting the second engine, any leading "f" or "first" in
2723 the option name will first be replaced by "s" or "second",
2724 before finding its value.
2725 Default: 'polyglot -noini -ec "%fcp" -ed "%fd"'
2726 @item -uxiAdapter string
2727 @cindex uxiAdapter, option
2728 Similar to @code{adapterCommand}, but used for engines accompanied
2729 by the @code{fUCCI} or @code{fUSI} option, so you can configure
2730 XBoard to be ready to handle more than one flavor of non-native protocols.
2731 Default: ""
2732 @item -polyglotDir filename
2733 @cindex polyglotDir, option
2734 Gives the name of the directory in which the Polyglot adapter for UCI engines resides.
2735 Default: "".
2736 @item -usePolyglotBook true/false
2737 @cindex usePolyglotBook, option
2738 Specifies if the Polyglot book should be used as GUI book.
2739 @item -polyglotBook filename
2740 @cindex polyglotBook, option
2741 Gives the filename of the opening book.
2742 The book is only used when the @code{usePolyglotBook} option is set to true,
2743 and the option @code{firstHasOwnBookUCI} or @code{secondHasOwnBookUCI} 
2744 applying to the engine is set to false.
2745 The engine will be kept in force mode as long as the current position is in book, 
2746 and XBoard will select the book moves for it. Default: "".
2747 @item -fNoOwnBookUCI or -firstXBook or -firstHasOwnBookUCI true/false
2748 @itemx -sNoOwnBookUCI or -secondXBook or -secondHasOwnBookUCI true/false
2749 @cindex fNoOwnBookUCI, option
2750 @cindex sNoOwnBookUCI, option
2751 @cindex firstHasOwnBookUCI, option
2752 @cindex secondHasOwnBookUCI, option
2753 @cindex firstXBook, option
2754 @cindex secondXBook, option
2755 Indicates if the mentioned engine has its own opening book it should play from,
2756 rather than using the external book through XBoard. 
2757 Default: depends on setting of the option @code{discourageOwnBooks}.
2758 @item -discourageOwnBooks true/false
2759 @cindex discourageOwnBooks, option
2760 When set, newly loaded engines will be assumed to use the GUI book, 
2761 unless they explicitly specify differently.
2762 Otherwise they will be assumed to not use the GUI book,
2763 unless the specify differently (e.g. with @code{firstXBook}).
2764 Default: false.
2765 @item -bookDepth n
2766 @cindex bookDepth, option
2767 Limits the use of the GUI book to the first n moves of each side.
2768 Default: 12.
2769 @item -bookVariation n
2770 @cindex bookVariation, option
2771 A value n from 0 to 100 tunes the choice of moves from the GUI books
2772 from totally random to best-only. Default: 50
2773 @item -mcBookMode
2774 @cindex mcBookMode, option
2775 When this volatile option is specified, the probing algorithm of the
2776 GUI book is altered to always select the move that is most under-represented
2777 based on its performance.
2778 When all moves are played in approximately the right proportion,
2779 a book miss will be reported, to give the engine opportunity to
2780 explore a new move.
2781 In addition score of the moves will be kept track of during the session
2782 in a book buffer.
2783 By playing an match in this mode, a book will be built from scratch.
2784 The only output are the saved games, which can be converted to an
2785 actual book later, with the @samp{Save Games as Book} command.
2786 The latter command can also be used to pre-fill the book buffer
2787 before adding new games based on the probing algorithm.
2788 @item -fn string or -firstPgnName string
2789 @itemx -sn string or -secondPgnName string
2790 @cindex firstPgnName, option
2791 @cindex secondPgnName, option
2792 @cindex fn, option
2793 @cindex sn, option
2794 Indicates the name that should be used for the engine in PGN tags of
2795 engine-engine games.
2796 Intended to allow you to install versions of the same engine with different settings, 
2797 and still distinguish them.
2798 Default: "". 
2799 @item -defaultHashSize n
2800 @cindex defaultHashSize, option
2801 Sets the size of the hash table to n MegaBytes. Together with the EGTB cache size 
2802 this number is also used to calculate the memory setting of XBoard/WinBoard engines, 
2803 for those that support the memory feature of the XBoard/WinBoard protocol. Default: 64.
2804 @item -defaultCacheSizeEGTB n
2805 @cindex defaultCacheSizeEGTB, option
2806 Sets the size of the EGTB cache to n MegaBytes. Together with the hash-table size 
2807 this number is also used to calculate the memory setting of XBoard/WinBoard engines, 
2808 for those that support the memory feature of the XBoard/WinBoard protocol. Default: 4.
2809 @item -defaultPathEGTB filename
2810 @cindex defaultPathEGTB, option
2811 Gives the name of the directory where the end-game tablebases are installed, for UCI engines.
2812 Default: "/usr/local/share/egtb".
2813 @item -egtFormats string
2814 @cindex egtFormats, option
2815 Specifies which end-game tables are installed on the computer, and where. 
2816 The argument is a comma-separated list of format specifications, 
2817 each specification consisting of a format name, a colon, and a directory path name, 
2818 e.g. "nalimov:/usr/local/share/egtb". 
2819 If the name part matches that of a format that the engine requests through a feature command, 
2820 xboard will relay the path name for this format to the engine through an egtpath command. 
2821 One egtpath command for each matching format will be sent. 
2822 Popular formats are "nalimov" and "gaviota" DTM tablebases,
2823 syzygy DTZ tablebases and "scorpio" bitbases.
2824 Default: "".
2825 @item -firstChessProgramNames=@{names@}
2826 @cindex firstChessProgramNames, option
2827 This option lets you customize the listbox with chess-engine names 
2828 that appears in the @samp{Load Engine} and @samp{Tournament Options} dialog. 
2829 It consists of a list of strings, one per line. 
2830 When an engine is loaded, the corresponding line is prefixed with "-fcp ",
2831 and processed like it appeared on the command line.
2832 That means that apart from the engine command,
2833 it can contain any number of XBoard options you want to use with this engine.
2834 (Commonly used options here are -fd, -firstXBook, -fUCI, -variant.)
2835
2836 The value of this option is gradually built as you load new engines
2837 through the @samp{Load Engine} menu dialog, with @samp{Add to list} ticked. 
2838 To change it in other ways, (e.g. deleting engines),
2839 use the menu item @samp{Edit Engine List} in the @samp{Engine} menu.
2840 @end table
2841
2842 @node Tournament options
2843 @section Tournament options
2844 @cindex Tournament Options
2845 @cindex Options, Tournament
2846 @table @asis
2847 @item -defaultMatchGames n
2848 @cindex defaultMatchGames, option
2849 Sets the number of games that will be used for a match between two engines
2850 started from the menu to n. Also used as games per pairing in other tournament
2851 formats.  Default: 10.
2852 @item -matchPause n
2853 @cindex matchPause, option
2854 Specifies the duration of the pause between two games of a match or tournament
2855 between engines as n milliseconds.
2856 Especially engines that do not support ping need this option, 
2857 to prevent that the move they are thinking on when an opponent unexpectedly
2858 resigns will be counted for the next game, (leading to illegal moves there).
2859 Default: 10000.
2860 @item -tf filename or -tourneyFile filename
2861 @cindex tf, option
2862 @cindex tourneyFile, option
2863 Specifies the name of the tournament file used in match mode 
2864 to conduct a multi-player tournament. 
2865 This file is a special settings file, 
2866 which stores the description of the tournament (including progress info), 
2867 through normal options (e.g. for time control, load and save files), 
2868 and through some special-purpose options listed below.
2869 @item -tt number or -tourneyType number
2870 @cindex tt, option
2871 @cindex tourneyType, option
2872 Specifies the type of tourney: 0 = round-robin, 
2873 N>0 = (multi-)gauntlet with N gauntlet engines, 
2874 -1 = Swiss through external pairing engine. 
2875 Volatile option, but stored in tourney file.
2876 @item -cy number or -tourneyCycles number
2877 @cindex cy, option
2878 @cindex tourneyCycles, option
2879 Specifies the number of cycles in a tourney. 
2880 Volatile option, but stored in tourney file.
2881 @item -participants list
2882 @cindex participants, option
2883 The list is a multi-line text string that specifies engines 
2884 occurring in the @code{firstChesProgramNames} list 
2885 in the settings file by their (implied or explicitly given) nicknames, 
2886 one engine per line. 
2887 The mentioned engines will play in the tourney. 
2888 Volatile option, but stored in tourney file.
2889 @item -results string
2890 @cindex results, option
2891 The string of +=- characters lists the result of all played games in a tourney. 
2892 Games currently playing are listed as *, 
2893 while a space indicates a game that is not yet played. 
2894 Volatile option, but stored in tourney file.
2895 @item -defaultTourneyName string
2896 @cindex defaultTourneyName, option
2897 Specifies the name of the tournament file XBoard should propose 
2898 when the @samp{Match Options} dialog is opened. 
2899 Any %y, %M, %d, %h, %m, %s in the string are replaced by the current 
2900 year, month, day of the month, hours, minutes, seconds of the current time, 
2901 respectively, as two-digit number. 
2902 A %Y would be replaced by the year as 4-digit number. Default: empty string.
2903 @item -pairingEngine filename
2904 @cindex pairingEngine, option
2905 Specifies the external program to be used to pair the participants in Swiss tourneys. 
2906 XBoard communicates with this engine in the same way as it communicates with Chess engines. 
2907 The only commands sent to the pairing engine are “results N string”, 
2908 (where N is the number of participants, 
2909 and string the results so far in the format of the results option), 
2910 and “pairing N”, (where N is the number of the tourney game). 
2911 To the latter the pairing engine should answer with “A-B”, 
2912 where A and B are participant numbers (in the range 1-N). 
2913 (There should be no reply to the results command.) Default: empty string.
2914 @item -afterGame string
2915 @itemx -afterTourney string
2916 @cindex afterGame, option
2917 @cindex afterTourney, option
2918 When non-empty, the given string will be executed as a system command 
2919 after each tournament game, or after the tourney completes, respectively.
2920 This can be used, for example, to autmatically run a cross-table generator
2921 on the PGN file where games are saved, to update the tourney standings.
2922 Default: ""
2923 @item -syncAfterRound true/false
2924 @itemx -syncAfterCycle true/false
2925 @cindex syncAfterRound, option
2926 @cindex syncAfterCycle, option
2927 Controls whether different instances of XBoard concurrently running the 
2928 same tournament will wait for each other.
2929 Defaults: sync after cycle, but not after round.
2930 @item -seedBase number
2931 @cindex seedBase, option
2932 Used to store the seed of the pseudo-random-number generator in the
2933 tourneyFile, so that separate instances of XBoard working on the same
2934 tourney can take coherent 'random' decisions, such as picking an
2935 opening for a given game number.
2936 @end table
2937
2938 @node ICS options
2939 @section ICS options
2940 @cindex ICS options
2941 @cindex Options, ICS
2942 @table @asis
2943 @item -ics/-xics or -internetChessServerMode true/false
2944 @cindex ics, option
2945 @cindex internetChessServerMode, option
2946 Connect with an Internet Chess Server to play chess against its
2947 other users, observe games they are playing, or review games
2948 that have recently finished. Default: false.
2949 @item -icshost or -internetChessServerHost host
2950 @cindex icshost, option
2951 @cindex internetChessServerHost, option
2952 The Internet host name or address of the chess server to connect
2953 to when in ICS mode. Default: @code{chessclub.com}.
2954 Another popular chess server to try is @code{freechess.org}.
2955 If your site doesn't have a working Internet name server, try
2956 specifying the host address in numeric form. 
2957 You may also need
2958 to specify the numeric address when using the icshelper option
2959 with timestamp or timeseal (see below).
2960 @item -icsport or -internetChessServerPort port-number
2961 @cindex icsport, option
2962 @cindex internetChessServerPort, option
2963 The port number to use when connecting to a chess server in ICS
2964 mode. Default: 5000.
2965 @item -icshelper or -internetChessServerHelper prog-name
2966 @cindex icshelper, option
2967 @cindex internetChessServerHelper, option
2968 An external helper program used to communicate with the chess server.
2969 You would set it to "timestamp" for ICC (chessclub.com) or
2970 "timeseal" for FICS (freechess.org), after
2971 obtaining the correct version of timestamp or timeseal for your
2972 computer.  See "help timestamp" on ICC and "help timeseal" on FICS.
2973 This option is shorthand for @code{-useTelnet -telnetProgram program}.
2974 @item -telnet/-xtelnet or -useTelnet true/false
2975 @cindex telnet, option
2976 @cindex useTelnet, option
2977 This option is poorly named; it should be called useHelper.
2978 If set to true, it instructs XBoard to run an external
2979 program to communicate with the Internet Chess Server. 
2980 The program to use is given by the telnetProgram option.
2981 If the option is
2982 false (the default), XBoard opens a TCP socket and uses its own
2983 internal implementation of the telnet protocol to communicate with the
2984 ICS. @xref{Firewalls}.
2985 @item -telnetProgram prog-name
2986 @cindex telnetProgram, option
2987 This option is poorly named; it should be called helperProgram.
2988 It gives the name of the telnet program to be used with
2989 the @code{gateway} and @code{useTelnet} options.  The default is
2990 @file{telnet}. The telnet program is invoked with the value of
2991 @code{internetChessServerHost} as its first argument and the value
2992 of @code{internetChessServerPort} as its second argument.
2993 @xref{Firewalls}.
2994 @item -gateway host-name
2995 @cindex gateway, option
2996 If this option is set to a host name, XBoard communicates with the
2997 Internet Chess Server by using @file{rsh} to run
2998 the @code{telnetProgram} on the given host,
2999 instead of using its own internal implementation
3000 of the telnet protocol. You can substitute a different remote shell
3001 program for @file{rsh} using the @code{remoteShell} option described below.
3002 @xref{Firewalls}.
3003 @item -internetChessServerCommPort or -icscomm dev-name
3004 @cindex internetChessServerCommPort, option
3005 @cindex icscomm, option
3006 If this option is set, XBoard communicates with the ICS through
3007 the given character I/O device instead of opening a TCP connection.
3008 Use this option if your system does not have any kind of
3009 Internet connection itself (not even a SLIP or PPP connection),
3010 but you do have dial-up access (or a hardwired terminal line) to
3011 an Internet service provider from which you can telnet to the ICS.
3012
3013 The support for this option in XBoard is minimal. You need to
3014 set all communication parameters and tty modes before you enter
3015 XBoard.
3016
3017 Use a script something like this:
3018
3019 @example
3020 stty raw -echo 9600 > /dev/tty00
3021 xboard -ics -icscomm /dev/tty00
3022 @end example
3023
3024 Here replace @samp{/dev/tty00} with the name of the device that your
3025 modem is connected to. You might have to add several more
3026 options to these stty commands. See the man pages for @file{stty}
3027 and @code{tty} if you run into problems. Also, on many systems stty
3028 works on its standard input instead of standard output, so you
3029 have to use @samp{<} instead of @samp{>}.
3030
3031 If you are using linux, try starting with the script below.
3032 Change it as necessary for your installation.
3033
3034 @example
3035 #!/bin/sh -f
3036 # configure modem and fire up XBoard
3037
3038 # configure modem
3039 (
3040   stty 2400 ; stty raw ; stty hupcl ; stty -clocal
3041   stty ignbrk ; stty ignpar ; stty ixon ; stty ixoff
3042   stty -iexten ; stty -echo
3043 ) < /dev/modem
3044 xboard -ics -icscomm /dev/modem
3045 @end example
3046 @noindent
3047 After you start XBoard in this way, type whatever commands are
3048 necessary to dial out to your Internet provider and log in.
3049 Then telnet to ICS, using a command like
3050 @kbd{telnet chessclub.com 5000}.
3051 Important: See the paragraph below about extra echoes, 
3052 in @ref{Limitations}.
3053 @item -icslogon or -internetChessServerLogonScript file-name
3054 @cindex icslogon, option
3055 @cindex internetChessServerLogonScript, option
3056 @cindex .icsrc
3057 Whenever XBoard connects to the Internet Chess Server,
3058 if it finds a file with the name given in this option, it feeds the
3059 file's contents to the ICS as commands. The default file name
3060 is @file{.icsrc}.
3061 Usually the first two lines of the file should be
3062 your ICS user name and password.
3063 The file can be either in $CHESSDIR, in XBoard's working
3064 directory if CHESSDIR is not set, or in your home directory.
3065 @item -msLoginDelay delay
3066 @cindex msLoginDelay, option
3067 If you experience trouble logging on to an ICS when using the
3068 @code{-icslogon} option, inserting some delay between characters
3069 of the logon script may help. This option adds @code{delay}
3070 milliseconds of delay between characters. Good values to try
3071 are 100 and 250.
3072 @item -icsinput/-xicsinput or -internetChessServerInputBox true/false
3073 @cindex icsinput, option
3074 @cindex internetChessServerInputBox, option
3075 Sets the ICS Input Box menu option. @xref{Mode Menu}. Default: false.
3076 @item -autocomm/-xautocomm or -autoComment true/false
3077 @cindex autocomm, option
3078 @cindex autoComment, option
3079 Sets the Auto Comment menu option. @xref{Options Menu}. Default: false.
3080 @item -autoflag/-xautoflag or -autoCallFlag true/false
3081 @cindex autoflag, option
3082 @cindex autoCallFlag, option
3083 Sets the Auto Flag menu option.  @xref{Options Menu}. Default: false.
3084 @item -autobs/-xautobs or -autoObserve true/false
3085 @cindex autobs, option
3086 @cindex autoObserve, option
3087 Sets the Auto Observe menu option.  @xref{Options Menu}. Default: false.
3088 @item -autoKibitz
3089 @cindex autoKibitz, option
3090 Enables kibitzing of the engines last thinking output (depth, score, time, speed, PV) 
3091 before it moved
3092 to the ICS, in zippy mode. The option @code{showThinking} must be switched on for 
3093 this option to work.
3094 Also diverts similar kibitz information of an opponent engine that is playing you 
3095 through the ICS to the engine-output window, as if the engine was playing locally.
3096 @item -seekGraph true/false or -sg
3097 @cindex seekGraph, option
3098 @cindex sg, option
3099 Enables displaying of the seek graph by left-clicking the board when
3100 you are logged on to an ICS and currently idle.
3101 The seek graph show all players currently seeking games on the ICS,
3102 plotted according to their rating and the time control of the game they seek,
3103 in three different colors (for rated, unrated and wild games).
3104 Computer ads are displayed as squares, human ads are dots.
3105 Default: false.
3106 @item -autoRefresh true/false
3107 @cindex autoRefresh, option
3108 Enables automatic updating of the seek graph,
3109 by having the ICS send a running update of all newly placed
3110 and removed seek ads.
3111 This consumes a substantial amount of communication bandwidth,
3112 and is only supported for FICS and ICC.
3113 Default: false.
3114 @item -backgroundObserve true/false
3115 @cindex backgroundObserve, option
3116 When true, boards sent to you by the ICS from other games while you are playing
3117 (e.g. because you are observing them)
3118 will not be automatically displayed.
3119 Only a summary of time left and material of both players will appear
3120 in the message field above the board.
3121 XBoard will remember the last board it has received this way,
3122 and will display it instead of the position in your own game
3123 when you press the right mouse button.
3124 No other information is stored on such games observed in the background;
3125 you cannot save such a game later, or step through its moves.
3126 This feature is provided solely for the benefit of bughouse players,
3127 to enable them to peek at their partner's game without the need
3128 to logon twice.
3129 Default: false.
3130 @item -dualBoard true/false
3131 @cindex dualBoard, option
3132 In combination with -backgroundObserve true, this option will display
3133 the board of the background game side by side with that of your own game,
3134 so you can have it in view permanently.
3135 Any board or holdings info coming in will be displayed on the secondary
3136 board immediately.
3137 This feature is still experimental and largely unfinished.
3138 There is no animation or highlighting of moves on the secondary board.
3139 Default: false.
3140 @item -disguisePromotedPieces true/false
3141 @cindex disguisePromotedPieces, option
3142 When set promoted Pawns in crazyhouse/bughouse are displayed identical
3143 to primordial pieces of the same type, rather than distinguishable.
3144 Default: true.
3145 @item -moves/-xmoves or -getMoveList true/false
3146 @cindex moves, option
3147 @cindex getMoveList, option
3148 Sets the Get Move List menu option.  @xref{Options Menu}.  Default: true.
3149 @item -alarm/-xalarm or -icsAlarm true/false
3150 @cindex alarm, option
3151 @cindex icsAlarm, option
3152 Sets the ICS Alarm menu option.  @xref{Options Menu}. Default: true.
3153 @item -icsAlarmTime ms
3154 @cindex icsAlarmTime, option
3155 Sets the time in milliseconds for the ICS Alarm menu option.
3156 @xref{Options Menu}. Default: 5000.
3157 @item lowTimeWarning true/false
3158 @cindex lowTimeWarning, option
3159 Controls a color change of the board as a warning your time is running out.
3160 @xref{Options Menu}. Default: false.
3161 @item -pre/-xpre \fRor\fB -premove true/false
3162 @cindex pre, option
3163 @cindex premove, option
3164 Sets the Premove menu option. @xref{Options Menu}. Default: true.
3165 @item -prewhite/-xprewhite or -premoveWhite
3166 @itemx -preblack/-xpreblack or -premoveBlack
3167 @itemx -premoveWhiteText string
3168 @itemx -premoveBlackText string
3169 @cindex prewhite, option
3170 @cindex premoveWhite, option
3171 @cindex preblack, option
3172 @cindex premoveBlack, option
3173 @cindex premoveWhiteText, option
3174 @cindex premoveBlackText, option
3175 Set the menu options for specifying the first move for either color. 
3176 @xref{Options Menu}. Defaults: false and empty strings, so no pre-moves.
3177 @item -quiet/-xquiet or -quietPlay true/false
3178 @cindex quiet, option
3179 @cindex quietPlay, option
3180 Sets the Quiet Play menu option.  @xref{Options Menu}.  Default: false.
3181 @item -colorizeMessages or -colorize/-xcolorize
3182 @cindex Colors
3183 @cindex colorize, option
3184 @cindex colorizeMessages, option
3185 Setting colorizeMessages
3186 to true tells XBoard to colorize the messages received from
3187 the ICS.  Colorization works only if your xterm 
3188 supports ISO 6429 escape sequences for changing text colors.
3189 Default: true.
3190 @item -colorShout foreground,background,bold
3191 @itemx -colorSShout foreground,background,bold
3192 @itemx -colorCShout foreground,background,bold
3193 @itemx -colorChannel1 foreground,background,bold
3194 @itemx -colorChannel foreground,background,bold
3195 @itemx -colorKibitz foreground,background,bold
3196 @itemx -colorTell foreground,background,bold
3197 @itemx -colorChallege foreground,background,bold
3198 @itemx -colorRequest foreground,background,bold
3199 @itemx -colorSeek foreground,background,bold
3200 @itemx -colorNormal foreground,background,bold
3201 @cindex Colors
3202 @cindex colorShout, option
3203 @cindex colorSShout, option
3204 @cindex colorCShout, option
3205 @cindex colorChannel1, option
3206 @cindex colorChannel, option
3207 @cindex colorKibitz, option
3208 @cindex colorTell, option
3209 @cindex colorChallenge, option
3210 @cindex colorRequest, option
3211 @cindex colorSeek, option
3212 @cindex colorNormal, option
3213 These options set the colors used when colorizing ICS messages.
3214 All ICS messages are grouped into one of these categories:
3215 shout, sshout, channel 1, other channel, kibitz, tell, challenge, 
3216 request (including abort, adjourn, draw, pause, and takeback), or
3217 normal (all other messages).  
3218
3219 Each foreground or background argument can be one of the following:
3220 black, red, green, yellow, blue, magenta, cyan, white, or default.
3221 Here ``default'' means the default foreground or background color of
3222 your xterm.  Bold can be 1 or 0.  If background is omitted, ``default''
3223 is assumed; if bold is omitted, 0 is assumed.
3224
3225 @item -soundProgram progname
3226 @cindex soundProgram, option
3227 @cindex Sounds
3228 If this option is set to a sound-playing program that is installed and
3229 working on your system, XBoard can play sound files when certain
3230 events occur, listed below.  The default program name is "play".  If
3231 any of the sound options is set to "$", the event rings the terminal
3232 bell by sending a ^G character to standard output, instead of playing
3233 a sound file.  If an option is set to the empty string "", no sound is
3234 played for that event.
3235 @item -soundDirectory directoryname
3236 @cindex soundDirectory, option
3237 @cindex Sounds
3238 This option specifies where XBoard will look for sound files,
3239 when these are not given as an absolute path name.
3240 @item -soundShout filename
3241 @itemx -soundSShout filename
3242 @itemx -soundCShout filename
3243 @itemx -soundChannel filename
3244 @itemx -soundChannel1 filename
3245 @itemx -soundKibitz filename
3246 @itemx -soundTell filename
3247 @itemx -soundChallenge filename
3248 @itemx -soundRequest filename
3249 @itemx -soundSeek filename
3250 @cindex soundShout, option
3251 @cindex soundSShout, option
3252 @cindex soundCShout, option
3253 @cindex soundChannel, option
3254 @cindex soundChannel1, option
3255 @cindex soundKibitz, option
3256 @cindex soundTell, option
3257 @cindex soundChallenge, option
3258 @cindex soundRequest, option
3259 @cindex soundSeek, option
3260 These sounds are triggered in the same way as the colorization events
3261 described above.  They all default to "", no sound.  They are played
3262 only if the colorizeMessages is on.
3263 CShout is synonymous with SShout.
3264 @item -soundMove filename
3265 @cindex soundMove, option
3266 This sound is played when a player other than yourself makes a move.
3267 Default: "$".
3268 @item -soundRoar filename
3269 @cindex soundRoar, option
3270 This sound is played when a Lion makes a hit-and-run or double capture/
3271 Default: "" (no sound).
3272 @item -soundIcsAlarm filename
3273 @cindex soundIcsAlarm, option
3274 This sound is used by the ICS Alarm menu option.  Default: "$".
3275 @item -soundIcsWin filename
3276 @cindex soundIcsWin, option
3277 This sound is played when you win an ICS game.  Default: "" (no sound).
3278 @item -soundIcsLoss filename
3279 @cindex soundIcsLoss, option
3280 This sound is played when you lose an ICS game.  Default: "" (no sound).
3281 @item -soundIcsDraw filename
3282 @cindex soundIcsDraw, option
3283 This sound is played when you draw an ICS game.  Default: "" (no sound).
3284 @item -soundIcsUnfinished filename
3285 @cindex soundIcsUnfinished, option
3286 This sound is played when an ICS game that you are participating in is
3287 aborted, adjourned, or otherwise ends inconclusively.  Default: "" (no
3288 sound).
3289 @end table
3290
3291 @node Load and Save options
3292 @section Load and Save options
3293 @cindex Options, Load and Save
3294 @cindex Load and Save options
3295 @table @asis
3296 @item -lgf or -loadGameFile file
3297 @itemx -lgi or -loadGameIndex index
3298 @cindex lgf, option
3299 @cindex loadGameFile, option
3300 @cindex lgi, option
3301 @cindex loadGameIndex, option
3302 If the @code{loadGameFile} option is set, XBoard loads the specified
3303 game file at startup. The file name @file{-} specifies the standard
3304 input. If there is more than one game in the file, XBoard
3305 pops up a menu of the available games, with entries based on their PGN 
3306 (Portable Game Notation) tags.
3307 If the @code{loadGameIndex} option is set to @samp{N}, the menu is suppressed
3308 and the N th game found in the file is loaded immediately.
3309 The menu is also suppressed if @code{matchMode} is enabled or if the game file
3310 is a pipe; in these cases the first game in the file is loaded immediately.
3311 Use the @file{pxboard} shell script provided with XBoard if you
3312 want to pipe in files containing multiple games and still see the menu.
3313 If the loadGameIndex specifies an index -1, this triggers auto-increment
3314 of the index in @code{matchMode}, which means that after every game the
3315 index is incremented by one, causing each game of the match to be played
3316 from the next game in the file. Similarly, specifying an index value of -2
3317 causes the index to be incremented every two games, so that each game
3318 in the file is used twice (with reversed colors).
3319 The @code{rewindIndex} option causes the index to be reset to the
3320 first game of the file when it has reached a specified value.
3321 @item -rewindIndex n
3322 Causes a position file or game file to be rewound to its beginning after n
3323 positions or games in auto-increment @code{matchMode}. 
3324 See @code{loadPositionIndex} and @code{loadGameIndex}.
3325 default: 0 (no rewind).
3326 @item -td or -timeDelay seconds
3327 @cindex td, option
3328 @cindex timeDelay, option
3329 Time delay between moves during @samp{Load Game} or @samp{Analyze File}. 
3330 Fractional seconds are allowed; try @samp{-td 0.4}. 
3331 A time delay value of -1 tells
3332 XBoard not to step through game files automatically. Default: 1 second.
3333 @item -sgf or -saveGameFile file
3334 @cindex sgf, option
3335 @cindex saveGameFile, option
3336 If this option is set, XBoard appends a record of every game
3337 played to the specified file. The file name @file{-} specifies the
3338 standard output.
3339 @item -autosave/-xautosave or -autoSaveGames true/false
3340 @cindex autosave, option
3341 @cindex autoSaveGames, option
3342 Sets the Auto Save menu option.  @xref{Options Menu}.  Default: false.
3343 Ignored if @code{saveGameFile} is set.
3344 @item -onlyOwnGames true/false
3345 @cindex onlyOwnGames, option
3346 Suppresses auto-saving of ICS observed games. Default: false.
3347 @item -lpf or -loadPositionFile file
3348 @itemx -lpi or -loadPositionIndex index
3349 @cindex lpf, option
3350 @cindex loadPositionFile, option
3351 @cindex lpi, option
3352 @cindex loadPositionIndex, option
3353 If the @code{loadPositionFile} option is set, XBoard loads the
3354 specified position file at startup. The file name @file{-} specifies the
3355 standard input. If the @code{loadPositionIndex} option is set to N,
3356 the Nth position found in the file is loaded; otherwise the
3357 first position is loaded.
3358 If the loadPositionIndex specifies an index -1, this triggers auto-increment
3359 of the index in @code{matchMode}, which means that after every game the
3360 index is incremented by one, causing each game of the match to be played
3361 from the next position in the file. Similarly, specifying an index value of -2
3362 causes the index to be incremented every two games, so that each position
3363 in the file is used twice (with the engines playing opposite colors).
3364 The @code{rewindIndex} option causes the index to be reset to the
3365 first position of the file when it has reached a specified value.
3366 @item -spf or -savePositionFile file
3367 @cindex spf, option
3368 @cindex savePositionFile, option
3369 If this option is set, XBoard appends the final position reached
3370 in every game played to the specified file. The file name @file{-}
3371 specifies the standard output.
3372 @item -positionDir directory
3373 @cindex positionDir, option
3374 Specifies the directory where file browsing should start when using
3375 the @samp{Load Position} menu item.
3376 @item -pgnExtendedInfo true/false
3377 @cindex pgnExtendedInfo, option
3378 If this option is set, XBoard saves depth, score and time used for each 
3379 move that the engine found as a comment in the PGN file.
3380 Default: false.
3381 @item -pgnEventHeader string
3382 @cindex pgnEventHeader, option
3383 Sets the name used in the PGN event tag to string. 
3384 Default: "Computer Chess Game".
3385 @item -pgnNumberTag true/false
3386 @cindex pgnNumberTag, option
3387 Include the (unique) sequence number of a tournament game into the saved
3388 PGN file as a 'number' tag.
3389 Default: false.
3390 @item -saveOutOfBookInfo true/false
3391 @cindex saveOutOfBookInfo, option
3392 Include the information on how the engine(s) game out of its opening book 
3393 in a special 'annotator' tag with the PGN file.
3394 Default: true.
3395 @item -oldsave/-xoldsave or -oldSaveStyle true/false
3396 @cindex oldsave, option
3397 @cindex oldSaveStyle, option
3398 Sets the Old Save Style menu option.  @xref{Options Menu}.  Default: false.
3399 @item -gameListTags string
3400 @cindex gameListTags, option
3401 The character string lists the PGN tags that should be printed in the
3402 Game List, and their order. The meaning of the codes is e=event,
3403 s=site, d=date, o=round, p=players, r=result, w=white Elo, b=black Elo,
3404 t=time control, v=variant, a=out-of-book info, c=result comment.
3405 Default: "eprd"
3406 @item -ini or -settingsFile filename
3407 @itemx -saveSettingsFile filename
3408 @itemx @@filename
3409 @cindex saveSettingsFile, option
3410 @cindex SettingsFile, option
3411 @cindex init, option
3412 @cindex at sign, option
3413 When XBoard encounters an option -settingsFile (or -ini for short),
3414 or @@filename, it tries to read the mentioned file,
3415 and substitutes the contents of it (presumaby more command-line options)
3416 in place of the option.
3417 In the case of -ini or -settingsFile, the name of a successfully read
3418 settings file is also remembered as the file to use for saving settings
3419 (automatically on exit, or on user command).
3420 An option of the form @@filename does not affect saving.
3421 The option -saveSettingsFile does specify a name of the file to use
3422 for saving, without reading any options from it, and is thus also effective
3423 when the file did not exist yet.
3424 So the settings will be saved to the file specified in the last
3425 -saveSettingsFile or succesfull -settingsFile / -ini command,
3426 if any, and in /etc/xboard/xboard.conf otherwise.
3427 Usualy the latter is only accessible for the system administrator, though, 
3428 and will be used to contain system-wide default settings, amongst which
3429 a -saveSettingsFile and -settingsFile options to specify a settings file
3430 accessible to the individual user, such as ~/.xboardrc in the user's
3431 home directory.
3432 @item -saveSettingsOnExit true/false
3433 @cindex saveSettingsOnExit, option
3434 Controls saving of options on the settings file.  @xref{Options Menu}.
3435 Default: true.
3436 @end table
3437
3438 @node User interface options
3439 @section User interface options
3440 @cindex User interface options
3441 @cindex Options, User interface
3442 @table @asis
3443 @item -noGUI
3444 @cindex noGUI, option
3445 Suppresses all GUI functions of XBoard 
3446 (to speed up automated ultra-fast engine-engine games, which you don't want to watch). 
3447 There will be no board or clock updates, no printing of moves, 
3448 and no update of the icon on the task bar in this mode.
3449 @item -logoSize N
3450 @cindex logoSize, option
3451 This option controls the drawing of player logos next to the clocks.
3452 The integer N specifies the width of the logo in pixels;
3453 the logo height will always be half the width.
3454 When N = 0, no logos will be diplayed.
3455 Default: 0.
3456 @item -firstLogo imagefile
3457 @itemx -secondLogo imagefile
3458 @cindex firstLogo, option
3459 @cindex secondLogo, option
3460 Specify the images to be used as player logos when @code{logoSize}
3461 is non-zero, next to the white and black clocks, respectively.
3462 @item -autoLogo true/false
3463 @itemx -logoDir filename
3464 @cindex autoLogo, option
3465 @cindex logoDir, option
3466 When @code{autoLogo} is set, XBoard will search for a PNG image file
3467 with the name of the engine or ICS in the directory specified
3468 by @code{logoDir}.
3469 For a human player it will look for a file <username>.png in this
3470 directory, but only when ~/.logo.png does not provide one.
3471 @item -recentEngines number
3472 @itemx -recentEngineList list
3473 @cindex recentEngines, option
3474 @cindex recentEngineList, option
3475 When the number is larger than zero, it determines how many recently
3476 used engines will be appended at the bottom of the @samp{Engines} menu.
3477 The engines will be saved in your settings file as the option
3478 @code{recentEngineList}, by their nicknames,
3479 and the most recently used one will always be sorted to the top.
3480 If the list after that is longer than the specified number,
3481 the last one is discarded.
3482 Changes in the list will only become visible the next session,
3483 provided you saved the settings.
3484 Default: 6.
3485 @item -oneClickMove true/false
3486 @cindex oneClickMove, option
3487 When set, this option allows you to enter moves by only clicking the to-
3488 or from-square, when only a single legal move to or from that square
3489 is possible.
3490 Double-clicking a piece (or clicking an already selected piece)
3491 will instruct that piece to make the only capture it can legally do.
3492 Default: false.
3493 @item -monoMouse true/false
3494 @cindex monoMouse, option
3495 When set button 1 clicks on empty squares in Edit Position mode
3496 will be interpreted as button 3 clicks, so they place a piece.
3497 Default: false.
3498 @item -movesound/-xmovesound or -ringBellAfterMoves true/false
3499 @cindex movesound, option
3500 @cindex bell, option
3501 @cindex ringBellAfterMoves, option
3502 Sets the Move Sound menu option.  @xref{Options Menu}.  Default: false.
3503 For compatibility with old XBoard versions, -bell/-xbell are also 
3504 accepted as abbreviations for this option.
3505 @item -analysisBell N
3506 @cindex analysisBell, option
3507 When N is non-zero, the Move Sound will be played whenever a new
3508 PV arrives in analysis mode after more than N seconds of analysis.
3509 Default: 0.
3510 @item -exit/-xexit or -popupExitMessage true/false
3511 @cindex exit, option
3512 @cindex popupExitMessage, option
3513 Sets the Popup Exit Message menu option.  @xref{Options Menu}. Default: true.
3514 @item -popup/-xpopup or -popupMoveErrors true/false
3515 @cindex popup, option
3516 @cindex popupMoveErrors, option
3517 Sets the Popup Move Errors menu option.  @xref{Options Menu}. Default: false.
3518 @item -queen/-xqueen or -alwaysPromoteToQueen true/false
3519 @cindex queen, option
3520 @cindex alwaysPromoteToQueen, option
3521 Sets the Always Queen menu option.  @xref{Options Menu}.  Default: false.
3522 @item -sweepPromotions true/false
3523 @cindex sweepPromotion, option
3524 Sets the @samp{Almost Always Promote to Queen} menu option.  
3525 @xref{Options Menu}.  Default: false.
3526 @item -legal/-xlegal or -testLegality true/false
3527 @cindex legal, option
3528 @cindex testLegality, option
3529 Sets the Test Legality menu option.  @xref{Options Menu}.  Default: true.
3530 @item -size or -boardSize (sizeName | n1,n2,n3,n4,n5,n6,n7)
3531 @cindex size, option
3532 @cindex boardSize, option
3533 @cindex board size
3534 Determines how large the board will be, by selecting the pixel size
3535 of the pieces and setting a few related parameters.
3536 The sizeName can be one of: Titanic, giving 129x129 pixel pieces,
3537 Colossal 116x116, Giant 108x108, Huge 95x95, Big 87x87, Large 80x80, Bulky 72x72,
3538 Medium 64x64, Moderate 58x58, Average 54x54, Middling 49x49, Mediocre
3539 45x45, Small 40x40, Slim 37x37, Petite 33x33, Dinky 29x29, Teeny 25x25,
3540 or Tiny 21x21.
3541 Xboard installs with a set of scalable (svg) piece images,
3542 which it scales to any of the requested sizes.
3543 The square size can further be continuously scaled by sizing the board window,
3544 but this only adapts the size of the pieces,
3545 and has no effect on the width of the grid lines or the font choice
3546 (both of which would depend on he selected boardSize).
3547 The default depends on the size of your screen; it is approximately the
3548 largest size that will fit without clipping.
3549
3550 You can select other sizes or vary other layout parameters by providing
3551 a list of comma-separated values (with no spaces) as the argument.
3552 You do not need to provide all the values; for any you omit from the
3553 end of the list, defaults are taken from the n