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