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