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