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