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