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