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