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