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