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