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