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