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