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