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