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