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