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