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