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