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