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