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