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