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