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