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