ffd362e2e064ff94af9ab9015d77a73efe95c967
[xboard.git] / manual / xboard.html
1 <html lang="en">
2 <head>
3 <title>XBoard</title>
4 <meta http-equiv="Content-Type" content="text/html">
5 <meta name="description" content="XBoard">
6 <meta name="generator" content="makeinfo 4.12">
7 <link title="Top" rel="top" href="#Top">
8 <link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
9 <meta http-equiv="Content-Style-Type" content="text/css">
10 <style type="text/css"><!--
11   pre.display { font-family:inherit }
12   pre.format  { font-family:inherit }
13   pre.smalldisplay { font-family:inherit; font-size:smaller }
14   pre.smallformat  { font-family:inherit; font-size:smaller }
15   pre.smallexample { font-size:smaller }
16   pre.smalllisp    { font-size:smaller }
17   span.sc    { font-variant:small-caps }
18   span.roman { font-family:serif; font-weight:normal; } 
19   span.sansserif { font-family:sans-serif; font-weight:normal; } 
20 --></style>
21 </head>
22 <body>
23 \r
24
25    <p>\r
26 \r
27 \r
28 <div class="node">
29 <p><hr>
30 <a name="Top"></a>
31 Next:&nbsp;<a rel="next" accesskey="n" href="#Major-modes">Major modes</a>,
32 Up:&nbsp;<a rel="up" accesskey="u" href="#dir">(dir)</a>
33
34 </div>
35
36 <h2 class="unnumbered">Introduction</h2>
37
38 <p><a name="index-introduction-1"></a>\r
39 \r
40 XBoard is a graphical chessboard that can serve as a\r
41 user interface to chess engines (such as GNU Chess), the\r
42 Internet Chess Servers,\r
43 electronic mail correspondence chess, or your own collection of saved games.\r
44 \r
45 This manual documents version 4.4.0j of XBoard.\r
46 \r
47
48 <ul class="menu">
49 <li><a accesskey="1" href="#Major-modes">Major modes</a>:      The main things XBoard can do.\r
50 <li><a accesskey="2" href="#Menus">Menus</a>:            Menus, buttons, and keys.\r
51 <li><a accesskey="3" href="#Options">Options</a>:          Command options supported by XBoard.\r
52 <li><a accesskey="4" href="#Chess-Servers">Chess Servers</a>:    Using XBoard with an Internet Chess Server (ICS).\r
53 <li><a accesskey="5" href="#Firewalls">Firewalls</a>:        Connecting to a chess server through a firewall.\r
54 <li><a accesskey="6" href="#Environment">Environment</a>:      Environment variables.\r
55 <li><a accesskey="7" href="#Limitations">Limitations</a>:      Known limitations and/or bugs.\r
56 <li><a accesskey="8" href="#Problems">Problems</a>:         How and where to report any problems you run into.\r
57 <li><a accesskey="9" href="#Contributors">Contributors</a>:     People who have helped developing XBoard.\r
58 <li><a href="#CMail">CMail</a>:            Using XBoard for electronic correspondence chess.\r
59 <li><a href="#Other-programs">Other programs</a>:   Other programs you can use with XBoard.\r
60
61 <li><a href="#Copyright">Copyright</a>:        Copyright notice for this manual.\r
62 <li><a href="#Copying">Copying</a>:          The GNU General Public License.\r
63 \r
64 <li><a href="#Index">Index</a>:            Index of concepts and symbol names.\r
65 </ul>
66 \r
67 <div class="node">
68 <p><hr>
69 <a name="Major-modes"></a>
70 Next:&nbsp;<a rel="next" accesskey="n" href="#Menus">Menus</a>,
71 Previous:&nbsp;<a rel="previous" accesskey="p" href="#Top">Top</a>,
72 Up:&nbsp;<a rel="up" accesskey="u" href="#Top">Top</a>
73
74 </div>
75
76 <h2 class="chapter">1 Major modes</h2>
77
78 <p><a name="index-Major-modes-2"></a>\r
79 XBoard always runs in one of four major modes.  You select the\r
80 major mode from the command line when you start up XBoard.\r
81 \r
82      <dl>
83 <dt>xboard [options]<dd>As an interface to GNU Chess or another chess engine running on your\r
84 machine, XBoard lets you play a game against the machine,\r
85 set up arbitrary positions, force variations, watch a game between two\r
86 chess engines, interactively analyze your stored games or set up and\r
87 analyze arbitrary positions.  (Note: Not all chess engines support\r
88 analysis.)\r
89 <br><dt>xboard -ics -icshost hostname [options]<dd>As Internet Chess Server (ICS) interface, XBoard\r
90 lets you play against other ICS users, observe games\r
91 they are playing, or review games that have recently finished.  Most\r
92 of the ICS "wild" chess variants are supported, including bughouse.\r
93 <br><dt>xboard -ncp [options]<dd>XBoard can also be used simply\r
94 as an electronic chessboard to play through games. It will read and\r
95 write game files and allow you to play through variations\r
96 manually. You can use it to browse games off the net or review games\r
97 you have saved.  These features are also available in the other modes.\r
98 <br><dt>|pxboard<dd>If you want to pipe games into XBoard, use the supplied shell\r
99 script <samp><span class="file">pxboard</span></samp>.  For example, from the news reader <samp><span class="file">xrn</span></samp>,\r
100 find a message with one or more games in it, click the Save button,\r
101 and type &lsquo;<samp><span class="samp">|pxboard</span></samp>&rsquo; as the file name.\r
102 <br><dt>cmail [options]<dd>As an interface to electronic mail correspondence chess, XBoard\r
103 works with the cmail program. See <a href="#CMail">CMail</a> below for\r
104 instructions.\r
105 </dl>
106    \r
107 <div class="node">
108 <p><hr>
109 <a name="Menus"></a>
110 Next:&nbsp;<a rel="next" accesskey="n" href="#Options">Options</a>,
111 Previous:&nbsp;<a rel="previous" accesskey="p" href="#Major-modes">Major modes</a>,
112 Up:&nbsp;<a rel="up" accesskey="u" href="#Top">Top</a>
113
114 </div>
115
116 <h2 class="chapter">2 Menus, buttons, and keys</h2>
117
118 <p><a name="index-Menus-3"></a>\r
119 To move a piece, you can drag it with the left mouse button, or you\r
120 can click the left mouse button once on the piece, then once more on\r
121 the destination square.  To drop a new piece on a square (when\r
122 applicable), press the middle or the right mouse button over the\r
123 square and select from the popup menu.  In cases where you can drop\r
124 either a white or black piece, use the middle button (or shift+right)\r
125 for white and the right button (or shift+middle) for black.  When you\r
126 are playing a bughouse game on an Internet Chess Server, a list of the\r
127 offboard pieces that each player has available is shown in the window\r
128 title after the player's name; in addition, the piece menus show the\r
129 number of pieces available of each type. From version 4.3.14 on, it is\r
130 also possible in crazyhouse, bughouse or shogi to dag and drop pieces\r
131 to the board from the holdings squares displayed next to the board.\r
132 \r
133 All other XBoard commands are available from the menu bar. The most\r
134 frequently used commands also have shortcut keys or on-screen buttons.\r
135 \r
136 When XBoard is iconized, its graphical icon is a white knight if\r
137 it is White's turn to move, a black knight if it is Black's turn.  See\r
138 Iconize in <a href="#Keys">Keys</a> below if you have problems getting this\r
139 feature to work.\r
140 \r
141
142 <ul class="menu">
143 <li><a accesskey="1" href="#File-Menu">File Menu</a>:        Accessing external games and positions.\r
144 <li><a accesskey="2" href="#Mode-Menu">Mode Menu</a>:        Selecting XBoard's mode.\r
145 <li><a accesskey="3" href="#Action-Menu">Action Menu</a>:      Talking to the chess engine or ICS opponents.\r
146 <li><a accesskey="4" href="#Step-Menu">Step Menu</a>:        Controlling the game.\r
147 <li><a accesskey="5" href="#Options-Menu">Options Menu</a>:     User preferences.\r
148 <li><a accesskey="6" href="#Help-Menu">Help Menu</a>:        Getting help.\r
149 <li><a accesskey="7" href="#Keys">Keys</a>:             Other shortcut keys.\r
150 </ul>
151 \r
152 <div class="node">
153 <p><hr>
154 <a name="File-Menu"></a>
155 Next:&nbsp;<a rel="next" accesskey="n" href="#Mode-Menu">Mode Menu</a>,
156 Up:&nbsp;<a rel="up" accesskey="u" href="#Menus">Menus</a>
157
158 </div>
159
160 <h3 class="section">2.1 File Menu</h3>
161
162 <p><a name="index-File-Menu-4"></a><a name="index-Menu_002c-File-5"></a>
163      <dl>
164 <dt>New Game<dd><a name="index-New-Game_002c-Menu-Item-6"></a>Resets XBoard and the chess engine to the beginning of a new chess\r
165 game. The <kbd>r</kbd> key is a keyboard equivalent. In Internet Chess\r
166 Server mode, clears the current state of XBoard, then\r
167 resynchronizes with the ICS by sending a refresh command. If you want to\r
168 stop playing, observing, or examining an ICS game, use an\r
169 appropriate command from the Action menu, not &lsquo;<samp><span class="samp">New Game</span></samp>&rsquo;.\r
170 See <a href="#Action-Menu">Action Menu</a>.\r
171 <br><dt>New Shuffle Game<dd><a name="index-New-Shuffle-Game_002c-Menu-Item-7"></a>Similar to &lsquo;<samp><span class="samp">New Game</span></samp>&rsquo;, but allows you to specify a particular initial position \r
172 (according to a standardized numbering system)\r
173 in chess variants which use randomized opening positions (e.g. Chess960).\r
174 The selected opening position will persistently be chosen on any following\r
175 New Game command until you use this menu to select another. Selecting\r
176 position number -1 will produce a newly randomized position on any new game.\r
177 Using this menu item in variants that normally do not shuffle their opening position\r
178 does cause these variants to become shuffle variants until you use the\r
179 &lsquo;<samp><span class="samp">New Shuffle Game</span></samp>&rsquo; menu to explicitly switch the randomization off,\r
180 or select a new variant.\r
181 <br><dt>New Variant<dd><a name="index-New-variant_002c-Menu-Item-8"></a>Allows you to select a new chess variant in non-ICS mode. \r
182 (In ICS play, the ICS is responsible for deciding which variant will be played,\r
183 and XBoard adapts autmatically.) If you play with an engine, the engine must\r
184 be able to play the selected variant, or the command will be ignored.\r
185 XBoard supports all major variants, such as xiangqi, shogi, chess, chess960,\r
186 Capablanca Chess, shatranj, crazyhous, bughouse.\r
187 <br><dt>Load Game<dd><a name="index-Load-Game_002c-Menu-Item-9"></a>Plays a game from a record file. The <kbd>g</kbd> key is a keyboard equivalent.\r
188 A popup dialog prompts you for the file name. If the file contains more\r
189 than one game, a second popup dialog\r
190 displays a list of games (with information drawn from their PGN tags, if\r
191 any), and you can select the one you want. Alternatively, you can load the\r
192 Nth game in the file directly, by typing the number <kbd>N</kbd> after the\r
193 file name, separated by a space.\r
194 \r
195 The game file parser will accept PGN (portable game notation),\r
196 or in fact almost any file that contains moves in algebraic\r
197 notation. \r
198 Notation of the form &lsquo;<samp><span class="samp">P@f7</span></samp>&rsquo;\r
199 is accepted for piece-drops in bughouse games;\r
200 this is a nonstandard extension to PGN.\r
201 If the file includes a PGN position (FEN tag), or an old-style\r
202 XBoard position diagram bracketed by &lsquo;<samp><span class="samp">[--</span></samp>&rsquo; and &lsquo;<samp><span class="samp">--]</span></samp>&rsquo;\r
203 before the first move, the game starts from that position. Text\r
204 enclosed in parentheses, square brackets, or curly braces is assumed to\r
205 be commentary and is displayed in a pop-up window. Any other\r
206 text in the file is ignored. PGN variations (enclosed in\r
207 parentheses) are treated as comments; XBoard is not able to walk\r
208 variation trees.\r
209 The nonstandard PGN tag [Variant "varname"] functions similarly to\r
210 the -variant command-line option (see below), allowing games in certain chess\r
211 variants to be loaded.  There is also a heuristic to \r
212 recognize chess variants from the Event tag, by looking for the strings\r
213 that the Internet Chess Servers put there when saving variant ("wild") games.\r
214 <br><dt>Load Next Game<dd><a name="index-Load-Next-Game_002c-Menu-Item-10"></a>Loads the next game from the last game record file you loaded.\r
215 The shifted <kbd>N</kbd> key is a keyboard equivalent.\r
216 <br><dt>Load Previous Game<dd><a name="index-Load-Previous-Game_002c-Menu-Item-11"></a>Loads the previous game from the last game record file you\r
217 loaded.  The shifted <kbd>P</kbd> key is a keyboard equivalent.\r
218 Not available if the last game was loaded from a pipe.\r
219 <br><dt>Reload Same Game<dd><a name="index-Reload-Same-Game_002c-Menu-Item-12"></a>Reloads the last game you loaded.\r
220 Not available if the last game was loaded from a pipe.\r
221 <br><dt>Save Game<dd><a name="index-Save-Game_002c-Menu-Item-13"></a>Appends a record of the current game to a file.\r
222 A popup dialog\r
223 prompts you for the file name. If the game did not begin with\r
224 the standard starting position, the game file includes the\r
225 starting position used. Games are saved in the PGN (portable\r
226 game notation) format, unless the oldSaveStyle option is true,\r
227 in which case they are saved in an older format that is specific\r
228 to XBoard. Both formats are human-readable, and both can be\r
229 read back by the &lsquo;<samp><span class="samp">Load Game</span></samp>&rsquo; command.\r
230 Notation of the form &lsquo;<samp><span class="samp">P@f7</span></samp>&rsquo;\r
231 is accepted for piece-drops in bughouse games;\r
232 this is a nonstandard extension to PGN.\r
233 <br><dt>Copy Game<dd><a name="index-Copy-Game_002c-Menu-Item-14"></a>Copies a record of the current game to an internal clipboard in PGN\r
234 format and sets the X selection to the game text.  The game can be\r
235 pasted to another application (such as a text editor or another copy\r
236 of XBoard) using that application's paste command.  In many X\r
237 applications, such as xterm and emacs, the middle mouse button can be\r
238 used for pasting; in XBoard, you must use the Paste Game command.\r
239 <br><dt>Paste Game<dd><a name="index-Paste-Game_002c-Menu-Item-15"></a>Interprets the current X selection as a game record and loads it, as\r
240 with Load Game.\r
241 <br><dt>Load Position<dd><a name="index-Load-Position_002c-Menu-Item-16"></a>Sets up a position from a position file.  A popup dialog prompts\r
242 you for the file name. If the file contains more than one saved\r
243 position, and you want to load the Nth one, type the number N\r
244 after the file name, separated by a space. Position files must\r
245 be in FEN (Forsythe-Edwards notation), or in the format that the\r
246 Save Position command writes when oldSaveStyle is turned on.\r
247 <br><dt>Load Next Position<dd><a name="index-Load-Next-Position_002c-Menu-Item-17"></a>Loads the next position from the last position file you loaded.\r
248 <br><dt>Load Previous Position<dd><a name="index-Load-Previous-Position_002c-Menu-Item-18"></a>Loads the previous position from the last position file you\r
249 loaded.  Not available if the last position was loaded from a pipe.\r
250 <br><dt>Reload Same Position<dd><a name="index-Reload-Same-Position_002c-Menu-Item-19"></a>Reloads the last position you loaded.\r
251 Not available if the last position was loaded from a pipe.\r
252 <br><dt>Save Position<dd><a name="index-Save-Game_002c-Menu-Item-20"></a>Appends a diagram of the current position to a file.\r
253 A popup dialog\r
254 prompts you for the file name. Positions are saved in\r
255 FEN (Forsythe-Edwards notation) format unless the <code>oldSaveStyle</code>\r
256 option is true, in which case they are saved in an older,\r
257 human-readable format that is specific to XBoard. Both formats\r
258 can be read back by the &lsquo;<samp><span class="samp">Load Position</span></samp>&rsquo; command.\r
259 <br><dt>Copy Position<dd><a name="index-Copy-Position_002c-Menu-Item-21"></a>Copies the current position to an internal clipboard in FEN format and\r
260 sets the X selection to the position text.  The position can be pasted\r
261 to another application (such as a text editor or another copy of\r
262 XBoard) using that application's paste command.  In many X\r
263 applications, such as xterm and emacs, the middle mouse button can be\r
264 used for pasting; in XBoard, you must use the Paste Position command.\r
265 <br><dt>Paste Position<dd><a name="index-Paste-Position_002c-Menu-Item-22"></a>Interprets the current X selection as a FEN position and loads it, as\r
266 with Load Position.\r
267 <br><dt>Mail Move<dt>Reload CMail Message<dd><a name="index-Mail-Move_002c-Menu-Item-23"></a><a name="index-Reload-CMail-Message_002c-Menu-Item-24"></a>See <a href="#CMail">CMail</a>.\r
268 <br><dt>Exit<dd><a name="index-Exit_002c-Menu-Item-25"></a>Exits from XBoard. The shifted <kbd>Q</kbd> key is a keyboard equivalent.\r
269 </dl>
270    \r
271 <div class="node">
272 <p><hr>
273 <a name="Mode-Menu"></a>
274 Next:&nbsp;<a rel="next" accesskey="n" href="#Action-Menu">Action Menu</a>,
275 Previous:&nbsp;<a rel="previous" accesskey="p" href="#File-Menu">File Menu</a>,
276 Up:&nbsp;<a rel="up" accesskey="u" href="#Menus">Menus</a>
277
278 </div>
279
280 <h3 class="section">2.2 Mode Menu</h3>
281
282 <p><a name="index-Menu_002c-Mode-26"></a><a name="index-Mode-Menu-27"></a>
283      <dl>
284 <dt>Machine White<dd><a name="index-Machine-White_002c-Menu-Item-28"></a>Tells the chess engine to play White.\r
285 <br><dt>Machine Black<dd><a name="index-Machine-Black_002c-Menu-Item-29"></a>Tells the chess engine to play Black.\r
286 <br><dt>Two Machines<dd><a name="index-Two-Machines_002c-Menu-Item-30"></a>Plays a game between two chess engines.\r
287 <br><dt>Analysis Mode<dd><a name="index-Analysis-Mode_002c-Menu-Item-31"></a>XBoard tells the chess engine to start analyzing the current game/position\r
288 and shows you the analysis as you move pieces around.\r
289 Note: Some chess engines do not support Analysis mode.\r
290 \r
291 To set up a position to analyze, you do the following:\r
292 \r
293 1. Select Edit Position from the Mode Menu\r
294 \r
295 2. Set up the position.  Use the middle and right buttons to\r
296 bring up the white and black piece menus.\r
297 \r
298 3. When you are finished, click on either the Black or White\r
299 clock to tell XBoard which side moves first.\r
300 \r
301 4. Select Analysis Mode from the Mode Menu to start the analysis.\r
302 \r
303 The analysis function can also be used when observing games on an ICS\r
304 with an engine loaded (zippy mode); the engine then will analyse\r
305 the positions as they occur in the observed game.\r
306 <br><dt>Analyze File<dd><a name="index-Analyze-File_002c-Menu-Item-32"></a>This option lets you load a game from a file (PGN, XBoard format, etc.)\r
307 and analyze it. When you select this menu item, a popup window appears\r
308 and asks for a filename to load.\r
309 If the file contains multiple games, another popup appears that lets\r
310 you select which game you wish to analyze.\r
311 After a game is loaded, use the XBoard arrow buttons to step\r
312 forwards/backwards through the game and watch the analysis.\r
313 Note: Some chess engines do not support Analysis mode.\r
314 <br><dt>ICS Client<dd><a name="index-ICS-Client_002c-Menu-Item-33"></a>This is the normal mode when XBoard\r
315 is connected to a chess server.  If you have moved into\r
316 Edit Game or Edit Position mode, you can select this option to get out.\r
317 \r
318 To use xboard in ICS mode, run it in the foreground with the -ics\r
319 option, and use the terminal you started it from to type commands and\r
320 receive text responses from the chess server.  See\r
321 <a href="#Chess-Servers">Chess Servers</a> below for more information.\r
322 \r
323 XBoard activates some special position/game editing features when you\r
324 use the <kbd>examine</kbd> or <kbd>bsetup</kbd> commands on ICS and you have\r
325 &lsquo;<samp><span class="samp">ICS Client</span></samp>&rsquo; selected on the Mode menu.  First, you can issue the\r
326 ICS position-editing commands with the mouse.  Move pieces by dragging\r
327 with mouse button 1.  To drop a new piece on a square, press mouse\r
328 button 2 or 3 over the square.  This brings up a menu of white pieces\r
329 (button 2) or black pieces (button 3).  Additional menu choices let\r
330 you empty the square or clear the board.  Click on the White or Black\r
331 clock to set the side to play.  You cannot set the side to play or\r
332 drag pieces to arbitrary squares while examining on ICC, but you can\r
333 do so in <kbd>bsetup</kbd> mode on FICS.  In addition, the menu commands\r
334 &lsquo;<samp><span class="samp">Forward</span></samp>&rsquo;, &lsquo;<samp><span class="samp">Backward</span></samp>&rsquo;, &lsquo;<samp><span class="samp">Pause</span></samp>&rsquo;, and &lsquo;<samp><span class="samp">Stop Examining</span></samp>&rsquo;\r
335 have special functions in this mode; see below.\r
336 <br><dt>Edit Game<dd><a name="index-Edit-Game_002c-Menu-Item-34"></a>Allows you to make moves for both Black and White, and to change\r
337 moves after backing up with the &lsquo;<samp><span class="samp">Backward</span></samp>&rsquo; command. The clocks do\r
338 not run.\r
339 \r
340 In chess engine mode, the chess engine continues to check moves for legality\r
341 but does not participate in the game. You can bring the chess engine\r
342 into the game by selecting &lsquo;<samp><span class="samp">Machine White</span></samp>&rsquo;, &lsquo;<samp><span class="samp">Machine Black</span></samp>&rsquo;,\r
343 or &lsquo;<samp><span class="samp">Two Machines</span></samp>&rsquo;.\r
344 \r
345 In ICS mode, the moves are not sent to the ICS: &lsquo;<samp><span class="samp">Edit Game</span></samp>&rsquo; takes\r
346 XBoard out of ICS Client mode and lets you edit games locally.\r
347 If you want to edit games on ICS in a way that other ICS users\r
348 can see, use the ICS <kbd>examine</kbd> command or start an ICS match\r
349 against yourself.\r
350 <br><dt>Edit Position<dd><a name="index-Edit-Position_002c-Menu-Item-35"></a>Lets you set up an arbitrary board position.\r
351 Use mouse button 1 to drag pieces to new squares, or to delete a piece\r
352 by dragging it off the board or dragging an empty square on top of it.\r
353 To drop a new piece on a square, press mouse button 2 or 3 over the\r
354 square. This brings up a menu of white pieces (button 2) or\r
355 black pieces (button 3). Additional menu choices let you empty the\r
356 square or clear the board. You can set the side to play next by\r
357 clicking on the word White or Black at the top of the screen.\r
358 Selecting &lsquo;<samp><span class="samp">Edit Position</span></samp>&rsquo; causes XBoard to discard\r
359 all remembered moves in the current game.\r
360 \r
361 In ICS mode, changes made to the position by &lsquo;<samp><span class="samp">Edit Position</span></samp>&rsquo; are\r
362 not sent to the ICS: &lsquo;<samp><span class="samp">Edit Position</span></samp>&rsquo; takes XBoard out of\r
363 &lsquo;<samp><span class="samp">ICS Client</span></samp>&rsquo; mode and lets you edit positions locally. If you want to\r
364 edit positions on ICS in a way that other ICS users can see, use\r
365 the ICS <kbd>examine</kbd> command, or start an ICS match against yourself.\r
366 (See also the ICS Client topic above.)\r
367 <br><dt>Training<dd><a name="index-Training_002c-Menu-Item-36"></a>Training mode lets you interactively guess the moves of a game for one\r
368 of the players. You guess the next move of the game by playing the\r
369 move on the board. If the move played matches the next move of the\r
370 game, the move is accepted and the opponent's response is autoplayed.\r
371 If the move played is incorrect, an error message is displayed.  You\r
372 can select this mode only while loading a game (that is, after\r
373 selecting &lsquo;<samp><span class="samp">Load Game</span></samp>&rsquo; from the File menu).  While XBoard is in \r
374 &lsquo;<samp><span class="samp">Training</span></samp>&rsquo; mode, the navigation buttons are disabled.\r
375 <br><dt>Show Game List<dd><a name="index-Show-Game-List_002c-Menu-Item-37"></a>Shows or hides the list of games generated by the last &lsquo;<samp><span class="samp">Load Game</span></samp>&rsquo;\r
376 command.\r
377 <br><dt>Show Move History<dd><a name="index-Show-Move-History_002c-Menu-Item-38"></a>Shows or hides a list of moves of the current game.\r
378 This list allows you to move the display to any earlier position in the game\r
379 by clicking on the corresponding move.\r
380 <br><dt>Show Engine Output<dd><a name="index-Show-Engine-Output_002c-Menu-Item-39"></a>Shows or hides a window in which the thinking output of any loaded engines\r
381 is displayed.\r
382 <br><dt>Edit Tags<dd><a name="index-Edit-Tags_002c-Menu-Item-40"></a>Lets you edit the PGN (portable game notation)\r
383 tags for the current game. After editing, the tags must still conform to\r
384 the PGN tag syntax:\r
385 \r
386      <pre class="example">          &lt;tag-section&gt; ::= &lt;tag-pair&gt; &lt;tag-section&gt;\r
387                                   &lt;empty&gt;\r
388           &lt;tag-pair&gt; ::= [ &lt;tag-name&gt; &lt;tag-value&gt; ]\r
389           &lt;tag-name&gt; ::= &lt;identifier&gt;\r
390           &lt;tag-value&gt; ::= &lt;string&gt;\r
391 </pre>
392      <p class="noindent">See the PGN Standard for full details. Here is an example:\r
393 \r
394      <pre class="example">          [Event "Portoroz Interzonal"]\r
395           [Site "Portoroz, Yugoslavia"]\r
396           [Date "1958.08.16"]\r
397           [Round "8"]\r
398           [White "Robert J. Fischer"]\r
399           [Black "Bent Larsen"]\r
400           [Result "1-0"]\r
401 </pre>
402      <p class="noindent">Any characters that do not match this syntax are silently ignored. Note that\r
403 the PGN standard requires all games to have at least the seven tags shown\r
404 above. Any that you omit will be filled in by XBoard\r
405 with &lsquo;<samp><span class="samp">?</span></samp>&rsquo; (unknown value), or &lsquo;<samp><span class="samp">-</span></samp>&rsquo; (inapplicable value).\r
406 <br><dt>Edit Comment<dd><a name="index-Edit-Comment_002c-Menu-Item-41"></a>Adds or modifies a comment on the current position. Comments are\r
407 saved by &lsquo;<samp><span class="samp">Save Game</span></samp>&rsquo; and are displayed by &lsquo;<samp><span class="samp">Load Game</span></samp>&rsquo;,\r
408 &lsquo;<samp><span class="samp">Forward</span></samp>&rsquo;, and &lsquo;<samp><span class="samp">Backward</span></samp>&rsquo;.\r
409 <br><dt>ICS Input Box<dd><a name="index-ICS-Input-Box_002c-Menu-Item-42"></a>If this option is set in ICS mode,\r
410 XBoard\r
411 creates an extra window that you can use for typing in ICS commands.\r
412 The input box is especially useful if you want to type in something long or do\r
413 some editing on your input, because output from ICS doesn't get mixed\r
414 in with your typing as it would in the main terminal window.\r
415 <br><dt>Pause<dd><a name="index-Pause_002c-Menu-Item-43"></a>Pauses updates to the board, and if you are playing against a chess engine,\r
416 also pauses your clock. To continue, select &lsquo;<samp><span class="samp">Pause</span></samp>&rsquo; again, and the\r
417 display will automatically update to the latest position.\r
418 The &lsquo;<samp><span class="samp">P</span></samp>&rsquo; button and keyboard <kbd>p</kbd> key are equivalents.\r
419 \r
420 If you select Pause when you are playing against a chess engine and\r
421 it is not your move, the chess engine's clock\r
422 will continue to run and it will eventually make a move, at which point\r
423 both clocks will stop. Since board updates are paused, however,\r
424 you will not see the move until you exit from Pause mode (or select Forward).\r
425 This behavior is meant to simulate adjournment with a sealed move.\r
426 \r
427 If you select Pause while you are observing or examining a game on a\r
428 chess server, you can step backward and forward in the current history\r
429 of the examined game without affecting the other observers and\r
430 examiners, and without having your display jump forward to the latest\r
431 position each time a move is made. Select Pause again to reconnect\r
432 yourself to the current state of the game on ICS.\r
433 \r
434 If you select &lsquo;<samp><span class="samp">Pause</span></samp>&rsquo; while you are loading a game, the game stops\r
435 loading. You can load more moves manually by selecting &lsquo;<samp><span class="samp">Forward</span></samp>&rsquo;, or\r
436 resume automatic loading by selecting &lsquo;<samp><span class="samp">Pause</span></samp>&rsquo; again.\r
437 </dl>
438    \r
439 <div class="node">
440 <p><hr>
441 <a name="Action-Menu"></a>
442 Next:&nbsp;<a rel="next" accesskey="n" href="#Step-Menu">Step Menu</a>,
443 Previous:&nbsp;<a rel="previous" accesskey="p" href="#Mode-Menu">Mode Menu</a>,
444 Up:&nbsp;<a rel="up" accesskey="u" href="#Menus">Menus</a>
445
446 </div>
447
448 <h3 class="section">2.3 Action Menu</h3>
449
450 <p><a name="index-Menu_002c-Action-44"></a><a name="index-Action_002c-Menu-45"></a>
451      <dl>
452 <dt>Accept<dd><a name="index-Accept_002c-Menu-Item-46"></a>Accepts a pending match offer. If there is more than one offer\r
453 pending, you will have to type in a more specific command\r
454 instead of using this menu choice.\r
455 <br><dt>Decline<dd><a name="index-Decline_002c-Menu-Item-47"></a>Declines a pending offer (match, draw, adjourn, etc.). If there\r
456 is more than one offer pending, you will have to type in a more\r
457 specific command instead of using this menu choice.\r
458 <br><dt>Call Flag<dd><a name="index-Call-Flag_002c-Menu-Item-48"></a>Calls your opponent's flag, claiming a win on time, or claiming\r
459 a draw if you are both out of time. You can also call your\r
460 opponent's flag by clicking on his clock or by pressing the\r
461 keyboard <kbd>t</kbd> key.\r
462 <br><dt>Draw<dd><a name="index-Draw_002c-Menu-Item-49"></a>Offers a draw to your opponent, accepts a pending draw offer\r
463 from your opponent, or claims a draw by repetition or the 50-move\r
464 rule, as appropriate. The <kbd>d</kbd> key is a keyboard equivalent.\r
465 <br><dt>Adjourn<dd><a name="index-Adjourn_002c-Menu-Item-50"></a>Asks your opponent to agree to adjourning the current game, or\r
466 agrees to a pending adjournment offer from your opponent.\r
467 <br><dt>Abort<dd><a name="index-Abort_002c-Menu-Item-51"></a>Asks your opponent to agree to aborting the current game, or\r
468 agrees to a pending abort offer from your opponent. An aborted\r
469 game ends immediately without affecting either player's rating.\r
470 <br><dt>Resign<dd><a name="index-Resign_002c-Menu-Item-52"></a>Resigns the game to your opponent. The shifted <kbd>R</kbd> key is a\r
471 keyboard equivalent.\r
472 <br><dt>Stop Observing<dd><a name="index-Stop-Observing_002c-Menu-Item-53"></a>Ends your participation in observing a game, by issuing the ICS\r
473 observe command with no arguments. ICS mode only.\r
474 <br><dt>Stop Examining<dd><a name="index-Stop-Examining_002c-Menu-Item-54"></a>Ends your participation in examining a game, by issuing the ICS\r
475 unexamine command. ICS mode only.\r
476 </dl>
477    \r
478 <div class="node">
479 <p><hr>
480 <a name="Step-Menu"></a>
481 Next:&nbsp;<a rel="next" accesskey="n" href="#Options-Menu">Options Menu</a>,
482 Previous:&nbsp;<a rel="previous" accesskey="p" href="#Action-Menu">Action Menu</a>,
483 Up:&nbsp;<a rel="up" accesskey="u" href="#Menus">Menus</a>
484
485 </div>
486
487 <h3 class="section">2.4 Step Menu</h3>
488
489 <p><a name="index-Step-Menu-55"></a><a name="index-Menu_002c-Step-56"></a>
490      <dl>
491 <dt>Backward<dd><a name="index-Backward_002c-Menu-Item-57"></a><a name="index-g_t_003c_002c-Button-58"></a>Steps backward through a series of remembered moves.\r
492 The &lsquo;<samp><span class="samp">[&lt;]</span></samp>&rsquo; button and the <kbd>b</kbd> key are equivalents,\r
493 as is turning the mouse wheel towards you.\r
494 In addition, pressing the Control key steps back one move, and releasing\r
495 it steps forward again.\r
496 \r
497 In most modes, &lsquo;<samp><span class="samp">Backward</span></samp>&rsquo; only lets you look back at old positions;\r
498 it does not retract moves. This is the case if you are playing against\r
499 a chess engine, playing or observing a game on an ICS, or loading a game.\r
500 If you select &lsquo;<samp><span class="samp">Backward</span></samp>&rsquo; in any of these situations, you will not\r
501 be allowed to make a different move. Use &lsquo;<samp><span class="samp">Retract Move</span></samp>&rsquo; or\r
502 &lsquo;<samp><span class="samp">Edit Game</span></samp>&rsquo; if you want to change past moves.\r
503 \r
504 If you are examining an ICS game, the behavior of &lsquo;<samp><span class="samp">Backward</span></samp>&rsquo;\r
505 depends on whether XBoard is in Pause mode. If Pause mode is\r
506 off, &lsquo;<samp><span class="samp">Backward</span></samp>&rsquo; issues the ICS backward command, which backs up\r
507 everyone's view of the game and allows you to make a different\r
508 move. If Pause mode is on, &lsquo;<samp><span class="samp">Backward</span></samp>&rsquo; only backs up your local\r
509 view.\r
510 <br><dt>Forward<dd><a name="index-Forward_002c-Menu-Item-59"></a><a name="index-g_t_003e_002c-Button-60"></a>Steps forward through a series of remembered moves (undoing the\r
511 effect of &lsquo;<samp><span class="samp">Backward</span></samp>&rsquo;) or forward through a game file. The\r
512 &lsquo;<samp><span class="samp">[&gt;]</span></samp>&rsquo; button and the <kbd>f</kbd> key are equivalents,\r
513 as is turning the mouse wheel away from you.\r
514 \r
515 If you are examining an ICS game, the behavior of Forward\r
516 depends on whether XBoard is in Pause mode. If Pause mode is\r
517 off, &lsquo;<samp><span class="samp">Forward</span></samp>&rsquo; issues the ICS forward command, which moves\r
518 everyone's view of the game forward along the current line. If\r
519 Pause mode is on, &lsquo;<samp><span class="samp">Forward</span></samp>&rsquo; only moves your local view forward,\r
520 and it will not go past the position that the game was in when\r
521 you paused.\r
522 <br><dt>Back to Start<dd><a name="index-Back-to-Start_002c-Menu-Item-61"></a><a name="index-g_t_003c_003c_002c-Button-62"></a>Jumps backward to the first remembered position in the game.\r
523 The &lsquo;<samp><span class="samp">[&lt;&lt;]</span></samp>&rsquo; button and the shifted <kbd>B</kbd> key are equivalents.\r
524 \r
525 In most modes, Back to Start only lets you look back at old\r
526 positions; it does not retract moves. This is the case if you\r
527 are playing against a local chess engine, playing or observing a game on\r
528 a chess server, or loading a game. If you select &lsquo;<samp><span class="samp">Back to Start</span></samp>&rsquo; in any\r
529 of these situations, you will not be allowed to make different\r
530 moves. Use &lsquo;<samp><span class="samp">Retract Move</span></samp>&rsquo; or &lsquo;<samp><span class="samp">Edit Game</span></samp>&rsquo; if you want to change past\r
531 moves; or use Reset to start a new game.\r
532 \r
533 If you are examining an ICS game, the behavior of &lsquo;<samp><span class="samp">Back to\r
534 Start</span></samp>&rsquo; depends on whether XBoard is in Pause mode. If Pause mode\r
535 is off, &lsquo;<samp><span class="samp">Back to Start</span></samp>&rsquo; issues the ICS &lsquo;<samp><span class="samp">backward 999999</span></samp>&rsquo;\r
536 command, which backs up everyone's view of the game to the start and\r
537 allows you to make different moves. If Pause mode is on, &lsquo;<samp><span class="samp">Back\r
538 to Start</span></samp>&rsquo; only backs up your local view.\r
539 <br><dt>Forward to End<dd><a name="index-Forward-to-End_002c-Menu-Item-63"></a><a name="index-g_t_003e_003e_002c-Button-64"></a>Jumps forward to the last remembered position in the game. The\r
540 &lsquo;<samp><span class="samp">[&gt;&gt;]</span></samp>&rsquo; button and the shifted <kbd>F</kbd> key are equivalents.\r
541 \r
542 If you are examining an ICS game, the behavior of &lsquo;<samp><span class="samp">Forward to\r
543 End</span></samp>&rsquo; depends on whether XBoard is in Pause mode. If Pause mode\r
544 is off, &lsquo;<samp><span class="samp">Forward to End</span></samp>&rsquo; issues the ICS &lsquo;<samp><span class="samp">forward 999999</span></samp>&rsquo;\r
545 command, which moves everyone's view of the game forward to the end of\r
546 the current line. If Pause mode is on, &lsquo;<samp><span class="samp">Forward to End</span></samp>&rsquo; only moves\r
547 your local view forward, and it will not go past the position\r
548 that the game was in when you paused.\r
549 <br><dt>Revert<dd><a name="index-Revert_002c-Menu-Item-65"></a>If you are examining an ICS game and Pause mode is off, issues\r
550 the ICS command &lsquo;<samp><span class="samp">revert</span></samp>&rsquo;.\r
551 <br><dt>Truncate Game<dd><a name="index-Truncate-Game_002c-Menu-Item-66"></a>Discards all remembered moves of the game beyond the current\r
552 position. Puts XBoard into &lsquo;<samp><span class="samp">Edit Game</span></samp>&rsquo; mode if it was not there\r
553 already.\r
554 <br><dt>Move Now<dd><a name="index-Move-Now_002c-Menu-Item-67"></a>Forces the chess engine to move immediately. Chess engine mode only.\r
555 <br><dt>Retract Move<dd><a name="index-Retract-Move_002c-Menu-Item-68"></a>Retracts your last move. In chess engine mode, you can do this only\r
556 after the chess engine has replied to your move; if the chess engine is still\r
557 thinking, use &lsquo;<samp><span class="samp">Move Now</span></samp>&rsquo; first. In ICS mode, &lsquo;<samp><span class="samp">Retract Move</span></samp>&rsquo;\r
558 issues the command &lsquo;<samp><span class="samp">takeback 1</span></samp>&rsquo; or &lsquo;<samp><span class="samp">takeback 2</span></samp>&rsquo;\r
559 depending on whether it is your opponent's move or yours.\r
560 <br><dt>Adjudicate to White<dt>Adjudicate to Black<dt>Adjudicate Draw<dd><a name="index-Adjudicate-to-White_002c-Menu-Item-69"></a><a name="index-Adjudicate-to-Black_002c-Menu-Item-70"></a><a name="index-Adjudicate-Draw_002c-Menu-Item-71"></a>Terminate an ongoing game in Two-Machines mode (including match mode),\r
561 with as result a win for white, for black, or a draw, repsectively.\r
562 The PGN file of the game will accompany the result string\r
563 by the comment "user adjudication".\r
564 </dl>
565    \r
566 <div class="node">
567 <p><hr>
568 <a name="Options-Menu"></a>
569 Next:&nbsp;<a rel="next" accesskey="n" href="#Help-Menu">Help Menu</a>,
570 Previous:&nbsp;<a rel="previous" accesskey="p" href="#Step-Menu">Step Menu</a>,
571 Up:&nbsp;<a rel="up" accesskey="u" href="#Menus">Menus</a>
572
573 </div>
574
575 <h3 class="section">2.5 Options Menu</h3>
576
577 <p><a name="index-Menu_002c-Options-72"></a><a name="index-Options-Menu-73"></a>
578      <dl>
579 <dt>Flip View<dd><a name="index-Flip-View_002c-Menu-Item-74"></a>Inverts your view of the chess board for the duration of the\r
580 current game. Starting a new game returns the board to normal.\r
581 The <kbd>v</kbd> key is a keyboard equivalent.\r
582 <br><dt>Adjudications<dd><a name="index-Adjudications_002c-Menu-Item-75"></a>Pops up a sub-menu where you can enable or disable various adjudications\r
583 that XBoard can perform in engine-engine games.\r
584 You can instruct XBoard to detect and terminate the game on checkmate\r
585 or stalemate, even if the engines would not do so, to verify engine\r
586 result claims (forfeiting engines that make false claims), rather than\r
587 naively following the engine, to declare draw on posititions\r
588 which can never be won for lack of mating material, (e.g. KBK),\r
589 or which are impossble to win unless the opponent seeks its own demise \r
590 (e.g. KBKN).\r
591 For these adjudications to work, &lsquo;<samp><span class="samp">Test Legality</span></samp>&rsquo; should be switched on.\r
592 It is also possible to insruct XBoard to enforce a 50-move or 3-fold-repeat\r
593 rule and automtically declare draw (after a user-adjustable number of moves\r
594 or repeats) even if the engines are prepared to go on.\r
595 It is also possible to have XBoard declare draw on games that seem to drag on \r
596 forever, or adjudicate a loss if both engines agree (for 3 cosecutive moves) that one\r
597 of them is behind more than a user-adjustable score threshold.\r
598 For the latter adjudication to work, XBoard should be able to properly understand\r
599 the engine's scores. To faclitate the latter, you can inform xboard here if\r
600 the engines report scores from the viewpoint of white, or from that of their own color.\r
601 <br><dt>Engine Settings<dd>Pops up a sub-menu where you can set some engine parameters common to most engines,\r
602 such as hash-table size, tablebase cache size, maximum number of processors\r
603 that SMP engines can use, and where to find the Polyglot adapter needed\r
604 to run UCI engines under XBoard. The feature tht allows setting of these parameters on\r
605 engines is new since XBoard 4.3.15, so not many WinBoard engines respond\r
606 to it yet, but UCI engines should.\r
607 It is also possible to specify a GUI opening book here, i.e. an opening\r
608 book that XBoard consults for any position a playing engine gets in.\r
609 It then forces the engine to play the book move, rather than to think up its own,\r
610 if that position is found in the book.\r
611 The book can switched on and off independently for either engine.\r
612 <br><dt>Time Control<dd><a name="index-Time-Control_002c-Menu-Item-76"></a>Pops up a sub-menu where you can set the time-control parameters interactively.\r
613 Allows you to select classical or incremental time controls,\r
614 set the moves per session, session duration, and time increment.\r
615 Also allows specification of time-odds factors for one or both engines.\r
616 If an engine is given a time-odds factor N, all time quota it gets, \r
617 be it at the beginning of a session or through the time increment or\r
618 fixed time per move, will be divided by N.\r
619 <br><dt>Always Queen<dd><a name="index-Always-Queen_002c-Menu-Item-77"></a>If this option is off, XBoard brings up a dialog\r
620 box whenever you move a pawn to the last rank, asking what piece\r
621 you want to promote it to. If the option is true, your pawns are\r
622 always promoted to queens. Your opponent can still underpromote.\r
623 <br><dt>Animate Dragging<dd><a name="index-Animate-Dragging_002c-Menu-Item-78"></a>If Animate Dragging is on, while you are dragging a piece with the\r
624 mouse, an image of the piece follows the mouse cursor.\r
625 If Animate Dragging is off, there is no visual feedback while you are\r
626 dragging a piece, but if Animate Moving is on, the move will be\r
627 animated when it is complete. \r
628 <br><dt>Animate Moving<dd><a name="index-Animate-Moving_002c-Menu-Item-79"></a>If Animate Moving is on, all piece moves are animated.  An image of the\r
629 piece is shown moving from the old square to the new square when the\r
630 move is completed (unless the move was already animated by Animate Dragging).\r
631 If Animate Moving is off, a moved piece instantly disappears from its\r
632 old square and reappears on its new square when the move is complete.\r
633 <br><dt>Auto Comment<dd><a name="index-Auto-Comment_002c-Menu-Item-80"></a>If this option is on, any remarks made on ICS while you are observing or\r
634 playing a game are recorded as a comment on the current move.  This includes\r
635 remarks made with the ICS commands <kbd>say</kbd>, <kbd>tell</kbd>, <kbd>whisper</kbd>,\r
636 and <kbd>kibitz</kbd>.\r
637 Limitation: remarks that you type yourself are not recognized;\r
638 XBoard scans only the output from ICS, not the input you type to it.\r
639 <br><dt>Auto Flag<dd><a name="index-Auto-Flag_002c-Menu-Item-81"></a>If this option is on and one player runs out of time\r
640 before the other,\r
641 XBoard\r
642 will automatically call his flag, claiming a win on time.\r
643 In ICS mode, Auto Flag will only call your opponent's flag, not yours,\r
644 and the ICS may award you a draw instead of a win if you have\r
645 insufficient mating material.  In local chess engine mode,\r
646 XBoard\r
647 may call either player's flag and will not take material into account.\r
648 <br><dt>Auto Flip View<dd><a name="index-Auto-Flip-View_002c-Menu-Item-82"></a>If the Auto Flip View option is on when you start a game, the board\r
649 will be automatically oriented so that your pawns move from the bottom\r
650 of the window towards the top.\r
651 <br><dt>Auto Observe<dd><a name="index-Auto-Observe_002c-Menu-Item-83"></a>If this option is on and you add a player to your <code>gnotify</code>\r
652 list on ICS, XBoard will automatically observe all of that\r
653 player's games, unless you are doing something else (such as\r
654 observing or playing a game of your own) when one starts.\r
655 The games are displayed \r
656 from the point of view of the player on your gnotify list; that is, his\r
657 pawns move from the bottom of the window towards the top.\r
658 Exceptions:  If both players in a game are on your gnotify list, if\r
659 your ICS \r
660 <code>highlight</code>\r
661 variable is set to 0, or if the ICS you are using does not \r
662 properly support observing from Black's point of view,\r
663 you will see the game from White's point of view.\r
664 <br><dt>Auto Raise Board<dd><a name="index-Auto-Raise-Board_002c-Menu-Item-84"></a>If this option is on, whenever a new game begins, the chessboard window\r
665 is deiconized (if necessary) and raised to the top of the stack of windows.\r
666 <br><dt>Auto Save<dd><a name="index-Auto-Save_002c-Menu-Item-85"></a>If this option is true, at the end of every game XBoard prompts\r
667 you for a file name and appends a record of the game to the file\r
668 you specify. \r
669 Disabled if the <code>saveGameFile</code> command-line\r
670 option is set, as in that case all games are saved to the specified file.\r
671 See <a href="#Load-and-Save-options">Load and Save options</a>.\r
672 <br><dt>Blindfold<dd><a name="index-Blindfold_002c-Menu-Item-86"></a>If this option is on, XBoard displays the board as usual but does\r
673 not display pieces or move highlights.  You can still move in the\r
674 usual way (with the mouse or by typing moves in ICS mode), even though\r
675 the pieces are invisible.\r
676 <br><dt>Flash Moves<dd><a name="index-Flash-Moves_002c-Menu-Item-87"></a>If this option is on, whenever a move is completed, the moved piece flashes.\r
677 The number of times to flash is set by the flashCount command-line\r
678 option; it defaults to 3 if Flash Moves is first turned on from the menu.\r
679 \r
680 If you are playing a game on an ICS, the board is always\r
681 oriented at the start of the game so that your pawns move from\r
682 the bottom of the window towards the top. Otherwise, the starting\r
683 orientation is determined by the <code>flipView</code> command line option;\r
684 if it is false (the default), White's pawns move from bottom to top\r
685 at the start of each game; if it is true, Black's pawns move from\r
686 bottom to top. See <a href="#User-interface-options">User interface options</a>.\r
687 <br><dt>Get Move List<dd><a name="index-Get-Move-List_002c-Menu-Item-88"></a>If this option is on, whenever XBoard\r
688 receives the first board of a new ICS game (or a different game from\r
689 the one it is currently displaying), it\r
690 retrieves the list of past moves from the ICS.\r
691 You can then review the moves with the &lsquo;<samp><span class="samp">Forward</span></samp>&rsquo; and &lsquo;<samp><span class="samp">Backward</span></samp>&rsquo;\r
692 commands\r
693 or save them with &lsquo;<samp><span class="samp">Save Game</span></samp>&rsquo;.  You might want to\r
694 turn off this option if you are observing several blitz games at once,\r
695 to keep from wasting time and network bandwidth fetching the move lists over\r
696 and over.\r
697 When you turn this option on from the menu, XBoard\r
698 immediately fetches the move list of the current game (if any).\r
699 <br><dt>Highlight Last Move<dd><a name="index-Highlight-Last-Move_002c-Menu-Item-89"></a>If Highlight Last Move is on, after a move is made, the starting and\r
700 ending squares remain highlighted. In addition, after you use Backward\r
701 or Back to Start, the starting and ending squares of the last move to\r
702 be unmade are highlighted.\r
703 <br><dt>Move Sound<dd><a name="index-Move-Sound_002c-Menu-Item-90"></a>If this option is on, XBoard alerts you by playing a sound\r
704 after each of your opponent's moves (or after every\r
705 move if you are observing a game on the Internet Chess Server).\r
706 The sound is not played after moves you make or moves read from a\r
707 saved game file. By default, the\r
708 sound is the terminal bell, but on some systems you can change it\r
709 to a sound file using the soundMove option; see below.\r
710 \r
711 If you turn on this option when using XBoard with the Internet\r
712 Chess Server, you will probably want to give the\r
713 <kbd>set bell 0</kbd>\r
714 command to the ICS, since otherwise the ICS will ring the terminal bell\r
715 after every move (not just yours). (The <samp><span class="file">.icsrc</span></samp> file\r
716 is a good place for this; see <a href="#ICS-options">ICS options</a>.)\r
717 <br><dt>ICS Alarm<dd><a name="index-ICS-Alarm_002c-Menu-Item-91"></a>When this option is on, an alarm sound is played when your clock\r
718 counts down to the icsAlarmTime (by default, 5 seconds) in an ICS\r
719 game.  For games with time controls that include an increment, the\r
720 alarm will sound each time the clock counts down to the icsAlarmTime.\r
721 By default, the alarm sound is the terminal bell, but on some systems\r
722 you can change it to a sound file using the soundIcsAlarm option; see\r
723 below.\r
724 <br><dt>Old Save Style<dd><a name="index-Old-Save-Style_002c-Menu-Item-92"></a>If this option is off, XBoard saves games in PGN\r
725 (portable game notation) and positions in FEN (Forsythe-Edwards\r
726 notation).  If the option is on, a save style that is compatible\r
727 with older versions of XBoard is used instead.\r
728 The old position style is more human-readable\r
729 than FEN; the old game style has no particular advantages.\r
730 <br><dt>Periodic Updates<dd><a name="index-Periodic-Updates_002c-Menu-Item-93"></a>If this option is off (or if\r
731 you are using a chess engine that does not support periodic updates),\r
732 the analysis window\r
733 will only be updated when the analysis changes. If this option is\r
734 on, the Analysis Window will be updated every two seconds.\r
735 <br><dt>Ponder Next Move<dd><a name="index-Ponder-Next-Move_002c-Menu-Item-94"></a>If this option is off, the chess engine will think only when it is on\r
736 move.  If the option is on, the engine will also think while waiting\r
737 for you to make your move.\r
738 <br><dt>Popup Exit Message<dd><a name="index-Popup-Exit-Message_002c-Menu-Item-95"></a>If this option is on, when XBoard wants to display a message just\r
739 before exiting, it brings up a modal dialog box and waits for you to\r
740 click OK before exiting.  If the option is off, XBoard prints the\r
741 message to standard error (the terminal) and exits immediately.\r
742 <br><dt>Popup Move Errors<dd><a name="index-Popup-Move-Errors_002c-Menu-Item-96"></a>If this option is off, when you make an error in moving (such as\r
743 attempting an illegal move or moving the wrong color piece), the\r
744 error message is displayed in the message area.  If the option is\r
745 on, move errors are displayed in small popup windows like other errors.\r
746 You can dismiss an error popup either by clicking its OK button or by\r
747 clicking anywhere on the board, including downclicking to start a move.\r
748 <br><dt>Premove<dd><a name="index-Premove_002c-Menu-Item-97"></a>If this option is on while playing a game on an ICS, you can register\r
749 your next planned move before it is your turn.  Move the piece with\r
750 the mouse in the ordinary way, and the starting and ending squares\r
751 will be highlighted with a special color (red by default).  When it is\r
752 your turn, if your registered move is legal, XBoard will send it to\r
753 ICS immediately; if not, it will be ignored and you can make a\r
754 different move.  If you change your mind about your premove, either\r
755 make a different move, or double-click on any piece to cancel the move\r
756 entirely.\r
757 <br><dt>Quiet Play<dd><a name="index-Quiet-Play_002c-Menu-Item-98"></a>If this option is on, XBoard will automatically issue an ICS\r
758 <kbd>set shout 0</kbd>\r
759 command whenever you start a game and a\r
760 <kbd>set shout 1</kbd>\r
761 command whenever you finish one.  Thus, you will not be distracted\r
762 by shouts from other ICS users while playing.\r
763 <br><dt>Show Coords<dd><a name="index-Show-Coords_002c-Menu-Item-99"></a>If this option is on, XBoard displays algebraic coordinates\r
764 along the board's left and bottom edges.\r
765 <br><dt>Hide Thinking<dd><a name="index-Hide-Thinking_002c-Menu-Item-100"></a>If this option is off, the chess engine's notion of the score and best\r
766 line of play from the current position is displayed as it is\r
767 thinking. The score indicates how many pawns ahead (or if negative,\r
768 behind) the chess engine thinks it is. In matches between two\r
769 machines, the score is prefixed by &lsquo;<samp><span class="samp">W</span></samp>&rsquo; or &lsquo;<samp><span class="samp">B</span></samp>&rsquo; to indicate\r
770 whether it is showing White's thinking or Black's, and only the thinking\r
771 of the engine that is on move is shown.\r
772 <br><dt>Test Legality<dd><a name="index-Test-Legality_002c-Menu-Item-101"></a>If this option is on, XBoard tests whether the moves you try to make\r
773 with the mouse are legal and refuses to let you make an illegal move.\r
774 Moves loaded from a file with &lsquo;<samp><span class="samp">Load Game</span></samp>&rsquo; are also checked.  If\r
775 the option is off, all moves are accepted, but if a local chess engine\r
776 or the ICS is active, they will still reject illegal moves.  Turning\r
777 off this option is useful if you are playing a chess variant with\r
778 rules that XBoard does not understand.  (Bughouse, suicide, and wild\r
779 variants where the king may castle after starting on the d file are\r
780 generally supported with Test Legality on.)\r
781 </dl>
782    \r
783 <div class="node">
784 <p><hr>
785 <a name="Help-Menu"></a>
786 Next:&nbsp;<a rel="next" accesskey="n" href="#Keys">Keys</a>,
787 Previous:&nbsp;<a rel="previous" accesskey="p" href="#Options-Menu">Options Menu</a>,
788 Up:&nbsp;<a rel="up" accesskey="u" href="#Menus">Menus</a>
789
790 </div>
791
792 <h3 class="section">2.6 Help Menu</h3>
793
794 <p><a name="index-Menu_002c-Help-102"></a><a name="index-Help-Menu-103"></a>
795      <dl>
796 <dt>Info XBoard<dd><a name="index-Info-XBoard_002c-Menu-Item-104"></a>Displays the XBoard documentation in info format.  For this feature to\r
797 work, you must have the GNU info program installed on your system, and\r
798 the file <samp><span class="file">xboard.info</span></samp> must either be present in the current\r
799 working directory, or have been installed by the &lsquo;<samp><span class="samp">make install</span></samp>&rsquo;\r
800 command when you built XBoard.\r
801 <br><dt>Man XBoard<dd><a name="index-Man-XBoard_002c-Menu-Item-105"></a>Displays the XBoard documentation in man page format.  For this\r
802 feature to work, the file <samp><span class="file">xboard.6</span></samp> must have been installed by\r
803 the &lsquo;<samp><span class="samp">make install</span></samp>&rsquo; command when you built XBoard, and the\r
804 directory it was placed in must be on the search path for your\r
805 system's &lsquo;<samp><span class="samp">man</span></samp>&rsquo; command.\r
806 <br><dt>Hint<dd><a name="index-Hint_002c-Menu-Item-106"></a>Displays a move hint from the chess engine.\r
807 <br><dt>Book<dd><a name="index-Book_002c-Menu-Item-107"></a>Displays a list of possible moves from the chess engine's opening\r
808 book.  The exact format depends on what chess engine you are using.\r
809 With GNU Chess 4, the first column gives moves, the second column\r
810 gives one possible response for each move, and the third column shows\r
811 the number of lines in the book that include the move from the first\r
812 column. If you select this option and nothing happens, the chess\r
813 engine is out of its book or does not support this feature.\r
814 <br><dt>About XBoard<dd><a name="index-About-XBoard_002c-Menu-Item-108"></a>Shows the current XBoard version number.\r
815 </dl>
816    \r
817 <div class="node">
818 <p><hr>
819 <a name="Keys"></a>
820 Previous:&nbsp;<a rel="previous" accesskey="p" href="#Help-Menu">Help Menu</a>,
821 Up:&nbsp;<a rel="up" accesskey="u" href="#Menus">Menus</a>
822
823 </div>
824
825 <h3 class="section">2.7 Other Shortcut Keys</h3>
826
827 <p><a name="index-Keys-109"></a><a name="index-Shortcut-keys-110"></a>
828      <dl>
829 <dt>Iconize<dd>Pressing the <kbd>i</kbd> or <kbd>c</kbd> key iconizes XBoard. The graphical\r
830 icon displays a white knight if it is White's move, or a black knight\r
831 if it is Black's move. If your X window manager displays only text\r
832 icons, not graphical ones, check its documentation; there is probably\r
833 a way to enable graphical icons.  If you get black and white reversed,\r
834 we would like to hear about it; see <a href="#Problems">Problems</a> below for\r
835 instructions on how to report this problem.\r
836 </dl>
837    \r
838 You can add or remove shortcut keys using the X resources\r
839 <code>form.translations</code>. Here is an example of what would go in your\r
840 <samp><span class="file">.Xresources</span></samp> file:\r
841 \r
842 <pre class="example">     XBoard*form.translations: \\r
843        Shift&lt;Key&gt;?: AboutGameProc() \n\\r
844        &lt;Key&gt;y: AcceptProc() \n\\r
845        &lt;Key&gt;n: DeclineProc() \n\\r
846        &lt;Key&gt;i: NothingProc()\r
847 </pre>
848    <p class="noindent">Binding a key to <code>NothingProc</code> makes it do nothing, thus removing\r
849 it as a shortcut key. The XBoard commands that can be bound to keys\r
850 are:\r
851 \r
852 <pre class="example">     AbortProc, AboutGameProc, AboutProc, AcceptProc, AdjournProc,\r
853      AlwaysQueenProc, AnalysisModeProc, AnalyzeFileProc,\r
854      AnimateDraggingProc, AnimateMovingProc, AutobsProc, AutoflagProc,\r
855      AutoflipProc, AutoraiseProc, AutosaveProc, BackwardProc,\r
856      BlindfoldProc, BookProc, CallFlagProc, CopyGameProc, CopyPositionProc,\r
857      DebugProc, DeclineProc, DrawProc, EditCommentProc, EditGameProc,\r
858      EditPositionProc, EditTagsProc, EnterKeyProc, FlashMovesProc,\r
859      FlipViewProc, ForwardProc, GetMoveListProc, HighlightLastMoveProc,\r
860      HintProc, Iconify, IcsAlarmProc, IcsClientProc, IcsInputBoxProc,\r
861      InfoProc, LoadGameProc, LoadNextGameProc, LoadNextPositionProc,\r
862      LoadPositionProc, LoadPrevGameProc, LoadPrevPositionProc,\r
863      LoadSelectedProc, MachineBlackProc, MachineWhiteProc, MailMoveProc,\r
864      ManProc, MoveNowProc, MoveSoundProc, NothingProc, OldSaveStyleProc,\r
865      PasteGameProc, PastePositionProc, PauseProc, PeriodicUpdatesProc,\r
866      PonderNextMoveProc, PopupExitMessageProc, PopupMoveErrorsProc,\r
867      PremoveProc, QuietPlayProc, QuitProc, ReloadCmailMsgProc,\r
868      ReloadGameProc, ReloadPositionProc, RematchProc, ResetProc,\r
869      ResignProc, RetractMoveProc, RevertProc, SaveGameProc,\r
870      SavePositionProc, ShowCoordsProc, ShowGameListProc, ShowThinkingProc,\r
871      StopExaminingProc, StopObservingProc, TestLegalityProc, ToEndProc,\r
872      ToStartProc, TrainingProc, TruncateGameProc, and TwoMachinesProc.\r
873 </pre>
874    <p>\r
875 <div class="node">
876 <p><hr>
877 <a name="Options"></a>
878 Next:&nbsp;<a rel="next" accesskey="n" href="#Chess-Servers">Chess Servers</a>,
879 Previous:&nbsp;<a rel="previous" accesskey="p" href="#Menus">Menus</a>,
880 Up:&nbsp;<a rel="up" accesskey="u" href="#Top">Top</a>
881
882 </div>
883
884 <h2 class="chapter">3 Options</h2>
885
886 <p><a name="index-Options-111"></a><a name="index-Options-112"></a>\r
887 This section documents the command-line options to XBoard.  You can\r
888 set these options in two ways: by typing them on the shell command\r
889 line you use to start XBoard, or by setting them as X resources\r
890 (typically in your <samp><span class="file">.Xresources</span></samp> file).  Many of the options\r
891 cannot be changed while XBoard is running; others set the initial\r
892 state of items that can be changed with the <a href="#Options">Options</a> menu.\r
893 \r
894 Most of the options have both a long name and a short name. To turn a\r
895 boolean option on or off from the command line, either give its long\r
896 name followed by the value true or false\r
897 (&lsquo;<samp><span class="samp">-longOptionName true</span></samp>&rsquo;), or give just the short name to turn the\r
898 option on (&lsquo;<samp><span class="samp">-opt</span></samp>&rsquo;), or the short name preceded by &lsquo;<samp><span class="samp">x</span></samp>&rsquo; to\r
899 turn the option off (&lsquo;<samp><span class="samp">-xopt</span></samp>&rsquo;). For options that take strings or\r
900 numbers as values, you can use the long or short option names\r
901 interchangeably.\r
902 \r
903 Each option corresponds to an X resource with the same name, so\r
904 if you like, you can set options in your <samp><span class="file">.Xresources</span></samp> file\r
905 or in a file named <samp><span class="file">XBoard</span></samp> in your home directory.\r
906 For options that have two names, the longer one is the name of\r
907 the corresponding X resource; the short name is not recognized.\r
908 To turn a boolean option on or off as an\r
909 X resource, give its long name followed by the value\r
910 true or false (&lsquo;<samp><span class="samp">XBoard*longOptionName: true</span></samp>&rsquo;).\r
911 \r
912
913 <ul class="menu">
914 <li><a accesskey="1" href="#Chess-engine-options">Chess engine options</a>:         Controlling the chess engine.\r
915 <li><a accesskey="2" href="#UCI-_002b-WB-Engine-Settings">UCI + WB Engine Settings</a>:     Setting some very common engine parameters\r
916 <li><a accesskey="3" href="#ICS-options">ICS options</a>:                  Connecting to and using ICS.\r
917 <li><a accesskey="4" href="#Load-and-Save-options">Load and Save options</a>:        Input/output options.\r
918 <li><a accesskey="5" href="#User-interface-options">User interface options</a>:       Look and feel options.\r
919 <li><a accesskey="6" href="#Adjudication-Options">Adjudication Options</a>:         Control adjudcation of engine-engine games.\r
920 <li><a accesskey="7" href="#Other-options">Other options</a>:                Miscellaneous.\r
921 </ul>
922 \r
923 <div class="node">
924 <p><hr>
925 <a name="Chess-engine-options"></a>
926 Next:&nbsp;<a rel="next" accesskey="n" href="#UCI-_002b-WB-Engine-Settings">UCI + WB Engine Settings</a>,
927 Up:&nbsp;<a rel="up" accesskey="u" href="#Options">Options</a>
928
929 </div>
930
931 <h3 class="section">3.1 Chess Engine Options</h3>
932
933 <p><a name="index-options_002c-Chess-engine-113"></a><a name="index-Chess-engine-options-114"></a>
934      <dl>
935 <dt>-tc or -timeControl minutes[:seconds]<dd><a name="index-tc_002c-option-115"></a><a name="index-timeControl_002c-option-116"></a>Each player begins with his clock set to the <code>timeControl</code> period.\r
936 Default: 5 minutes.\r
937 The additional options <code>movesPerSession</code> and <code>timeIncrement</code>\r
938 are mutually exclusive.  \r
939 <br><dt>-mps or -movesPerSession moves<dd><a name="index-mps_002c-option-117"></a><a name="index-movesPerSession_002c-option-118"></a>When both players have made <code>movesPerSession</code> moves, a\r
940 new <code>timeControl</code> period is added to both clocks.  Default: 40 moves.\r
941 <br><dt>-inc or -timeIncrement seconds<dd><a name="index-inc_002c-option-119"></a><a name="index-timeIncrement_002c-option-120"></a>If this option is specified, <code>movesPerSession</code> is ignored.\r
942 Instead, after each player's move, <code>timeIncrement</code> seconds are\r
943 added to his clock.  \r
944 Use &lsquo;<samp><span class="samp">-inc 0</span></samp>&rsquo; if you want to require the entire\r
945 game to be played in one <code>timeControl</code> period, with no increment.\r
946 Default: -1, which specifies <code>movesPerSession</code> mode.\r
947 <br><dt>-clock/-xclock or -clockMode true/false<dd><a name="index-clock_002c-option-121"></a><a name="index-clockMode_002c-option-122"></a>Determines whether or not to display the chess clocks. If clockMode is\r
948 false, the clocks are not shown, but the side that is to play next\r
949 is still highlighted. Also, unless <code>searchTime</code>\r
950 is set, the chess engine still keeps track of the clock time and uses it to\r
951 determine how fast to make its moves.\r
952 <br><dt>-st or -searchTime minutes[:seconds]<dd><a name="index-st_002c-option-123"></a><a name="index-searchTime_002c-option-124"></a>Tells the chess engine to spend at most the given amount of time\r
953 searching for each of its moves. Without this option, the chess engine\r
954 chooses its search time based on the number of moves and amount\r
955 of time remaining until the next time control.\r
956 Setting this option also sets clockMode to false.\r
957 <br><dt>-depth or -searchDepth number<dd><a name="index-sd_002c-option-125"></a><a name="index-searchDepth_002c-option-126"></a>Tells the chess engine to look ahead at most the given number of moves\r
958 when searching for a move to make. Without this option, the chess\r
959 engine chooses its search depth based on the number of moves and\r
960 amount of time remaining until the next time control.  With the option,\r
961 the engine will cut off its search early if it reaches the specified depth.\r
962 <br><dt>-firstNPS number<dt>-secondNPS number<dd><a name="index-firstNPS_002c-option-127"></a><a name="index-secondNPS_002c-option-128"></a>Tells the chess engine to use an internal time standard based on its node count, \r
963 rather then wall-clock time, to make its timing decisions. \r
964 The time in virtual seconds should be obtained by dividing the node count \r
965 through the given number, like the number was a rate in nodes per second. \r
966 Xboard will manage the clocks in accordance with this, relying on the number \r
967 of nodes reported by the engine in its thinking output. If the given number equals zero, \r
968 it can obviously not be used to convert nodes to seconds, and the time reported \r
969 by the engine is used to decrement the XBoard clock in stead. The engine is supposed to \r
970 report in CPU time it uses, rather than wall-clock time, in this mode. This option \r
971 can provide fairer conditions for engine-engine matches on heavily loaded machines, \r
972 or with very fast games (where the wall clock is too inaccurate). \r
973 <code>showThinking</code> must be on for this option to work. Default: -1 (off).\r
974 Not many engines might support this yet!\r
975 <br><dt>-firstTimeOdds factor<dt>-secondTimeOdds factor<dd><a name="index-firstTimeOdds_002c-option-129"></a><a name="index-secondTimeOdds_002c-option-130"></a>Reduces the time given to the mentioned engine by the given factor. \r
976 If pondering is off, the effect is indistinguishable from what would happen \r
977 if the engine was running on an n-times slower machine. Default: 1.\r
978 <br><dt>-timeOddsMode mode<dd><a name="index-timeOddsMode_002c-option-131"></a>This option determines how the case is handled where both engines have a time-odds handicap. \r
979 If mode=1, the engine that gets the most time will always get the nominal time, \r
980 as specified by the time-control options, and its opponent's time is renormalized accordingly. \r
981 If mode=0, both play with reduced time. Default: 0.\r
982 <br><dt>-hideThinkingFromHuman true/false<dd>Controls the Hide Thinking option. See <a href="#Options-Menu">Options Menu</a>. Default: true.\r
983 (Relaces the Show-Thinking option of older xboard versions.)\r
984 <br><dt>-thinking/-xthinking or -showThinking true/false<dd><a name="index-thinking_002c-option-132"></a><a name="index-showThinking_002c-option-133"></a>Forces the engine to send thinking output to xboard. \r
985 Used to be the only way to control if thinking output was displayed \r
986 in older xboard versions,\r
987 but as the thinking output in xboard 4.3 is also used for several other\r
988 purposes (adjudication, storing in PGN file) the display of it is now controlled\r
989 by the new option Hide Thinking. See <a href="#Options-Menu">Options Menu</a>. Default: false.\r
990 (But if xboard needs the thinking output for some purpose,\r
991 it makes the engine send it despite the setting of this option.)\r
992 <br><dt>-ponder/-xponder or -ponderNextMove true/false<dd><a name="index-ponder_002c-option-134"></a><a name="index-ponderNextMove_002c-option-135"></a>Sets the Ponder Next Move menu option. See <a href="#Options-Menu">Options Menu</a>. Default: true.\r
993 <br><dt>-smpCores number<dd>Specifies the maxmum nmber of CPUs an SMP engine is allowed to use.\r
994 Only works for engines that support the WinBoard-protocol cores feature.\r
995 <br><dt>-mg or -matchGames n<dd><a name="index-mg_002c-option-136"></a><a name="index-matchGames_002c-option-137"></a>Automatically runs an n-game match between two chess engines,\r
996 with alternating colors.\r
997 If the <code>loadGameFile</code> or <code>loadPositionFile</code> option is set,\r
998 XBoard\r
999 starts each game with the given opening moves or the given position;\r
1000 otherwise, the games start with the standard initial chess position.\r
1001 If the <code>saveGameFile</code> option is set, a move record for the\r
1002 match is appended to the specified file. If the <code>savePositionFile</code>\r
1003 option is set, the final position reached in each game of the match is appended\r
1004 to the specified file. When the match is over, XBoard\r
1005 displays the match score and exits. Default: 0 (do not run a match).\r
1006 <br><dt>-mm/-xmm or -matchMode true/false<dd><a name="index-mm_002c-option-138"></a><a name="index-matchMode_002c-option-139"></a>Setting <code>matchMode</code> to true is equivalent to setting\r
1007 <code>matchGames</code> to 1.\r
1008 <br><dt>-sameColorGames n<dd><a name="index-sameColorGames_002c-option-140"></a>Automatically runs an n-game match between two chess engines,\r
1009 without alternating colors.\r
1010 Otherwise the same applies as for the &lsquo;<samp><span class="samp">-matchGames</span></samp>&rsquo; option,\r
1011 over which it takes precedence if both are specified. (See there.)\r
1012 Default: 0 (do not run a match).\r
1013 <br><dt>-fcp or -firstChessProgram program<dd><a name="index-fcp_002c-option-141"></a><a name="index-firstChessProgram_002c-option-142"></a>Name of first chess engine.\r
1014 Default: <samp><span class="file">Fairy-Max</span></samp>.\r
1015 <br><dt>-scp or -secondChessProgram program<dd><a name="index-scp_002c-option-143"></a><a name="index-secondChessProgram_002c-option-144"></a>Name of second chess engine, if needed.\r
1016 A second chess engine is started only in Two Machines (match) mode.\r
1017 Default: <samp><span class="file">Fairy-Max</span></samp>.\r
1018 <br><dt>-fb/-xfb or -firstPlaysBlack true/false<dd><a name="index-fb_002c-option-145"></a><a name="index-firstPlaysBlack_002c-option-146"></a>In games between two chess engines, firstChessProgram normally plays\r
1019 white.  If this option is true, firstChessProgram plays black.  In a\r
1020 multi-game match, this option affects the colors only for the first\r
1021 game; they still alternate in subsequent games.\r
1022 <br><dt>-fh or -firstHost host<dt>-sh or -secondHost host<dd><a name="index-fh_002c-option-147"></a><a name="index-firstHost_002c-option-148"></a><a name="index-sh_002c-option-149"></a><a name="index-secondHost_002c-option-150"></a>Hosts on which the chess engines are to run. The default for\r
1023 each is <samp><span class="file">localhost</span></samp>. If you specify another host, XBoard\r
1024 uses <samp><span class="file">rsh</span></samp> to run the chess engine there. (You can substitute a\r
1025 different remote shell program for rsh using the <code>remoteShell</code>\r
1026 option described below.)\r
1027 <br><dt>-fd or -firstDirectory dir<dt>-sd or -secondDirectory dir<dd><a name="index-fd_002c-option-151"></a><a name="index-firstDirectory_002c-option-152"></a><a name="index-sd_002c-option-153"></a><a name="index-secondDirectory_002c-option-154"></a>Working directories in which the chess engines are to be run.\r
1028 The default is "", which means to run the chess engine\r
1029 in the same working directory as XBoard\r
1030 itself.  (See the CHESSDIR environment variable.)\r
1031 This option is effective only when the chess engine is being run\r
1032 on the local host; it does not work if the engine is run remotely\r
1033 using the -fh or -sh option.\r
1034 <br><dt>-initString string<dt>-secondInitString string<dd><a name="index-initString_002c-option-155"></a><a name="index-secondInitString_002c-option-156"></a>The string that is sent to initialize each chess engine for a new game.\r
1035 Default:\r
1036 \r
1037      <pre class="example">          new\r
1038           random\r
1039 </pre>
1040      <p class="noindent">Setting this option from the command line is tricky, because you must\r
1041 type in real newline characters, including one at the very end.\r
1042 In most shells you can do this by\r
1043 entering a &lsquo;<samp><span class="samp">\</span></samp>&rsquo; character followed by a newline. It is easier to set\r
1044 the option from your <samp><span class="file">.Xresources</span></samp> file; in that case you can\r
1045 include the character sequence &lsquo;<samp><span class="samp">\n</span></samp>&rsquo; in the string, and it will\r
1046 be converted to a newline.\r
1047 \r
1048 If you change this option, don't remove the &lsquo;<samp><span class="samp">new</span></samp>&rsquo; \r
1049 command; it is required by all chess engines to\r
1050 start a new game.\r
1051 \r
1052 You can remove the &lsquo;<samp><span class="samp">random</span></samp>&rsquo; command if you like; including it\r
1053 causes GNU Chess 4 to randomize its move selection slightly so that it\r
1054 doesn't play the same moves in every game.  Even without\r
1055 &lsquo;<samp><span class="samp">random</span></samp>&rsquo;, GNU Chess 4 randomizes its choice of moves from its\r
1056 opening book.  Many other chess engines ignore this command entirely\r
1057 and always (or never) randomize.\r
1058 \r
1059 You can also try adding other commands to the initString; see the\r
1060 documentation of the chess engine you are using for details.\r
1061 <br><dt>-firstComputerString string<dt>-secondComputerString string<dd><a name="index-firstComputerString_002c-option-157"></a><a name="index-secondComputerString_002c-option-158"></a>The string that is sent to the chess engine if its opponent is another\r
1062 computer chess engine.  The default is &lsquo;<samp><span class="samp">computer\n</span></samp>&rsquo;.  Probably the\r
1063 only useful alternative is the empty string (&lsquo;<samp></samp>&rsquo;), which keeps the\r
1064 engine from knowing that it is playing another computer.\r
1065 <br><dt>-reuse/-xreuse or -reuseFirst true/false<dt>-reuse2/-xreuse2 or -reuseSecond true/false<dd><a name="index-reuse_002c-option-159"></a><a name="index-reuseFirst_002c-option-160"></a><a name="index-reuse2_002c-option-161"></a><a name="index-reuseSecond_002c-option-162"></a>If the option is false,\r
1066 XBoard kills off the chess engine after every game and starts\r
1067 it again for the next game.  \r
1068 If the option is true (the default), \r
1069 XBoard starts the chess engine only once\r
1070 and uses it repeatedly to play multiple games.\r
1071 Some old chess engines may not work properly when\r
1072 reuse is turned on, but otherwise games will start faster if it is left on.\r
1073 <br><dt>-firstProtocolVersion version-number<dt>-secondProtocolVersion version-number<dd><a name="index-firstProtocolVersion_002c-option-163"></a><a name="index-secondProtocolVersion_002c-option-164"></a>This option specifies which version of the chess engine communication\r
1074 protocol to use.  By default, version-number is 2.  In version 1, the\r
1075 "protover" command is not sent to the engine; since version 1 is a\r
1076 subset of version 2, nothing else changes.  Other values for\r
1077 version-number are not supported.\r
1078 <br><dt>-firstScoreAbs true/false<dt>-secondScoreAbs true/false<dd><a name="index-firstScoreAbs_002c-option-165"></a><a name="index-secondScoreAbs_002c-option-166"></a>If this option is set, the score reported by the engine is taken to be \r
1079 that in favor of white, even when the engine plays black. \r
1080 Important when XBoard uses the score for adjudications, or in PGN reporting. \r
1081 <br><dt>-niceEngines priority<dd><a name="index-niceEngines_002c-option-167"></a>This option allows you to lower the priority of the engine processes, \r
1082 so that the generally insatiable hunger for CPU time of chess engines does not interfere so much \r
1083 with smooth operation of WinBoard (or the rest of your system). \r
1084 Negative values could increase the engine priority, which is not recommended.\r
1085 <br><dt>-firstOptions string<dt>-secondOptions string<dd><a name="index-firstOptions-option-168"></a><a name="index-secondOptions_002c-option-169"></a>The given string is a comma-separated list of (option name, option value) pairs, \r
1086 like the following example: Â“style=Karpov,blunder rate=0”. \r
1087 If the options announced by the engine at startup through the feature commands of WinBoard protocol \r
1088 matches one of the option names (i.e. Â“style” or Â“blunder rate”), \r
1089 it would be set to the given value (i.e. Â“Karpov” or 0) \r
1090 through a corresponding option command to the engine. \r
1091 This provided that the type of the value (text or numeric) matches as well.\r
1092 </dl>
1093    \r
1094 <div class="node">
1095 <p><hr>
1096 <a name="UCI-+-WB-Engine-Settings"></a>
1097 <a name="UCI-_002b-WB-Engine-Settings"></a>
1098 Next:&nbsp;<a rel="next" accesskey="n" href="#ICS-options">ICS options</a>,
1099 Previous:&nbsp;<a rel="previous" accesskey="p" href="#Chess-engine-options">Chess engine options</a>,
1100 Up:&nbsp;<a rel="up" accesskey="u" href="#Options">Options</a>
1101
1102 </div>
1103
1104 <h3 class="section">3.2 UCI + WB Engine Settings</h3>
1105
1106 <p><a name="index-Engine-Settings-170"></a><a name="index-Settings_002c-Engine-171"></a>
1107      <dl>
1108 <dt>-fUCI or -firstIsUCI true/false<dt>-sUCI or -secondIsUCI true/false<dd><a name="index-fUCI_002c-option-172"></a><a name="index-sUCI_002c-option-173"></a><a name="index-firstIsUCI_002c-option-174"></a><a name="index-secondIsUCI_002c-option-175"></a>Indicates if the mentioned engine executable file is an UCI engine, \r
1109 and should be run with the aid of the Polyglot adapter rather than directly. \r
1110 Xboard will then pass the other UCI options and engine name to Polyglot \r
1111 through a .ini temporary file ceated for the purpose.\r
1112 <br><dt>-PolyglotDir filename<dd><a name="index-PolyglotDir_002c-option-176"></a>Gives the name of the directory in which the Polyglot adapter for UCI engines expects its files.\r
1113 Default: "/usr/local/share/polyglot".\r
1114 <br><dt>-usePolyglotBook true/false<dd><a name="index-usePolyglotBook_002c-option-177"></a>Specifies if the Polygot book should be used.\r
1115 <br><dt>-PolyglotBook filename<dd><a name="index-PolyglotBook_002c-option-178"></a>Gives the filename of the opening book that Polyglot should use. \r
1116 From XBoard 4.3.15 on, native WinBoard engines will also use the opening book specified here, \r
1117 provided the <code>usePolyglotBook</code> option is set to true,\r
1118 and the option <code>firstHasOwnBookUCI</code> or <code>secondHasOwnBookUCI</code> applying to the engine\r
1119 is set to false.\r
1120 The engine will be kept in force mode as long as the current position is in book, \r
1121 and XBoard will select the book moves for it. Default "".\r
1122 <br><dt>-fNoOwnBookUCI or -firstXBook or -firstHasOwnBookUCI true/false<dt>-sNoOwnBookUCI or -secondXBook or -secondHasOwnBookUCI true/false<dd><a name="index-fNoOwnBookUCI_002c-option-179"></a><a name="index-sNoOwnBookUCI_002c-option-180"></a><a name="index-firstHasOwnBookUCI_002c-option-181"></a><a name="index-secondHasOwnBookUCI_002c-option-182"></a><a name="index-firstXBook_002c-option-183"></a><a name="index-secondXBook_002c-option-184"></a>Indicates if the mentioned engine has its own opening book it should play from,\r
1123 rather than using the external book through XBoard. Default: false.\r
1124 <br><dt>-defaultHashSize n<dd><a name="index-defaultHashSize_002c-option-185"></a>Sets the size of the hash table to n MegaBytes. Together with the EGTB cache size \r
1125 this number is also used to calculate the memory setting of WinBoard engines, \r
1126 for those that support the memory feature of WinBoard protocol. Default: 64.\r
1127 <br><dt>-defaultCacheSizeEGTB n<dd><a name="index-defaultCacheSizeEGTB_002c-option-186"></a>Sets the size of the EGTB cache to n MegaBytes. Together with the hash-table size \r
1128 this number is also used to calculate the memory setting of WinBoard engines, \r
1129 for those that support the memory feature of WinBoard protocol. Default: 4.\r
1130 <br><dt>-defaultPathEGTB filename<dd><a name="index-defaultPathEGTB_002c-option-187"></a>Gives the name of the directory where the end-game tablebases are installed, for UCI engines.\r
1131 Default: "/usr/local/share/egtb".\r
1132 <br><dt>-egtFormats string<dd><a name="index-egtFormats_002c-option-188"></a>Specifies which end-game tables are installed on the computer, and where. \r
1133 The argument is a comma-separated list of format specifications, \r
1134 each specification consisting of a format name, a colon, and a directory path name, \r
1135 e.g. "nalimov:/usr/local/share/egtb". \r
1136 If the name part matches that of a format that the engine requests through a feature command, \r
1137 xboard will relay the path name for this format to the engine through an egtpath command. \r
1138 One egtpath command for each matching format will be sent. \r
1139 Popular formats are "nalimov" DTM tablebases and "scorpio" bitbases.\r
1140 Default: "".\r
1141 </dl>
1142    \r
1143 <div class="node">
1144 <p><hr>
1145 <a name="ICS-options"></a>
1146 Next:&nbsp;<a rel="next" accesskey="n" href="#Load-and-Save-options">Load and Save options</a>,
1147 Previous:&nbsp;<a rel="previous" accesskey="p" href="#UCI-_002b-WB-Engine-Settings">UCI + WB Engine Settings</a>,
1148 Up:&nbsp;<a rel="up" accesskey="u" href="#Options">Options</a>
1149
1150 </div>
1151
1152 <h3 class="section">3.3 ICS options</h3>
1153
1154 <p><a name="index-ICS-options-189"></a><a name="index-Options_002c-ICS-190"></a>
1155      <dl>
1156 <dt>-ics/-xics or -internetChessServerMode true/false<dd><a name="index-ics_002c-option-191"></a><a name="index-internetChessServerMode_002c-option-192"></a>Connect with an Internet Chess Server to play chess against its\r
1157 other users, observe games they are playing, or review games\r
1158 that have recently finished. Default: false.\r
1159 <br><dt>-icshost or -internetChessServerHost host<dd><a name="index-icshost_002c-option-193"></a><a name="index-internetChessServerHost_002c-option-194"></a>The Internet host name or address of the chess server to connect\r
1160 to when in ICS mode. Default: <code>chessclub.com</code>.\r
1161 Another popular chess server to try is <code>freechess.org</code>.\r
1162 If your site doesn't have a working Internet name server, try\r
1163 specifying the host address in numeric form. \r
1164 You may also need\r
1165 to specify the numeric address when using the icshelper option\r
1166 with timestamp or timeseal (see below).\r
1167 <br><dt>-icsport or -internetChessServerPort port-number<dd><a name="index-icsport_002c-option-195"></a><a name="index-internetChessServerPort_002c-option-196"></a>The port number to use when connecting to a chess server in ICS\r
1168 mode. Default: 5000.\r
1169 <br><dt>-icshelper or -internetChessServerHelper prog-name<dd><a name="index-icshelper_002c-option-197"></a><a name="index-internetChessServerHelper_002c-option-198"></a>An external helper program used to communicate with the chess server.\r
1170 You would set it to "timestamp" for ICC (chessclub.com) or\r
1171 "timeseal" for FICS (freechess.org), after\r
1172 obtaining the correct version of timestamp or timeseal for your\r
1173 computer.  See "help timestamp" on ICC and "help timeseal" on FICS.\r
1174 This option is shorthand for <code>-useTelnet -telnetProgram program</code>.\r
1175 <br><dt>-telnet/-xtelnet or -useTelnet true/false<dd><a name="index-telnet_002c-option-199"></a><a name="index-useTelnet_002c-option-200"></a>This option is poorly named; it should be called useHelper.\r
1176 If set to true, it instructs XBoard to run an external\r
1177 program to communicate with the Internet Chess Server. \r
1178 The program to use is given by the telnetProgram option.\r
1179 If the option is\r
1180 false (the default), XBoard opens a TCP socket and uses its own\r
1181 internal implementation of the telnet protocol to communicate with the\r
1182 ICS. See <a href="#Firewalls">Firewalls</a>.\r
1183 <br><dt>-telnetProgram prog-name<dd><a name="index-telnetProgram_002c-option-201"></a>This option is poorly named; it should be called helperProgram.\r
1184 It gives the name of the telnet program to be used with\r
1185 the <code>gateway</code> and <code>useTelnet</code> options.  The default is\r
1186 <samp><span class="file">telnet</span></samp>. The telnet program is invoked with the value of\r
1187 <code>internetChessServerHost</code> as its first argument and the value\r
1188 of <code>internetChessServerPort</code> as its second argument.\r
1189 See <a href="#Firewalls">Firewalls</a>.\r
1190 <br><dt>-gateway host-name<dd><a name="index-gateway_002c-option-202"></a>If this option is set to a host name, XBoard communicates with the\r
1191 Internet Chess Server by using <samp><span class="file">rsh</span></samp> to run\r
1192 the <code>telnetProgram</code> on the given host,\r
1193 instead of using its own internal implementation\r
1194 of the telnet protocol. You can substitute a different remote shell\r
1195 program for <samp><span class="file">rsh</span></samp> using the <code>remoteShell</code> option described below.\r
1196 See <a href="#Firewalls">Firewalls</a>.\r
1197 <br><dt>-internetChessServerCommPort or -icscomm dev-name<dd><a name="index-internetChessServerCommPort_002c-option-203"></a><a name="index-icscomm_002c-option-204"></a>If this option is set, XBoard communicates with the ICS through\r
1198 the given character I/O device instead of opening a TCP connection.\r
1199 Use this option if your system does not have any kind of\r
1200 Internet connection itself (not even a SLIP or PPP connection),\r
1201 but you do have dialup access (or a hardwired terminal line) to\r
1202 an Internet service provider from which you can telnet to the ICS.\r
1203 \r
1204 The support for this option in XBoard is minimal. You need to\r
1205 set all communication parameters and tty modes before you enter\r
1206 XBoard.\r
1207 \r
1208 Use a script something like this:\r
1209 \r
1210      <pre class="example">          stty raw -echo 9600 &gt; /dev/tty00\r
1211           xboard -ics -icscomm /dev/tty00\r
1212 </pre>
1213      <p>\r
1214 Here replace &lsquo;<samp><span class="samp">/dev/tty00</span></samp>&rsquo; with the name of the device that your\r
1215 modem is connected to. You might have to add several more\r
1216 options to these stty commands. See the man pages for <samp><span class="file">stty</span></samp>\r
1217 and <code>tty</code> if you run into problems. Also, on many systems stty\r
1218 works on its standard input instead of standard output, so you\r
1219 have to use &lsquo;<samp><span class="samp">&lt;</span></samp>&rsquo; instead of &lsquo;<samp><span class="samp">&gt;</span></samp>&rsquo;.\r
1220 \r
1221 If you are using linux, try starting with the script below.\r
1222 Change it as necessary for your installation.\r
1223 \r
1224      <pre class="example">          #!/bin/sh -f\r
1225           # configure modem and fire up XBoard\r
1226           \r
1227           # configure modem\r
1228           (\r
1229             stty 2400 ; stty raw ; stty hupcl ; stty -clocal\r
1230             stty ignbrk ; stty ignpar ; stty ixon ; stty ixoff\r
1231             stty -iexten ; stty -echo\r
1232           ) &lt; /dev/modem\r
1233           xboard -ics -icscomm /dev/modem\r
1234 </pre>
1235      <p class="noindent">After you start XBoard in this way, type whatever commands are\r
1236 necessary to dial out to your Internet provider and log in.\r
1237 Then telnet to ICS, using a command like\r
1238 <kbd>telnet chessclub.com 5000</kbd>.\r
1239 Important: See the paragraph below about extra echoes, \r
1240 in <a href="#Limitations">Limitations</a>.\r
1241 <br><dt>-icslogon or -internetChessServerLogonScript file-name<dd><a name="index-icslogon_002c-option-205"></a><a name="index-internetChessServerLogonScript_002c-option-206"></a><a name="index-g_t_002eicsrc-207"></a>Whenever XBoard connects to the Internet Chess Server,\r
1242 if it finds a file with the name given in this option, it feeds the\r
1243 file's contents to the ICS as commands. The default file name\r
1244 is <samp><span class="file">.icsrc</span></samp>.\r
1245 Usually the first two lines of the file should be\r
1246 your ICS user name and password.\r
1247 The file can be either in $CHESSDIR, in XBoard's working\r
1248 directory if CHESSDIR is not set, or in your home directory.\r
1249 <br><dt>-msLoginDelay delay<dd><a name="index-msLoginDelay_002c-option-208"></a>If you experience trouble logging on to an ICS when using the\r
1250 <code>-icslogon</code> option, inserting some delay between characters\r
1251 of the logon script may help. This option adds <code>delay</code>\r
1252 milliseconds of delay between characters. Good values to try\r
1253 are 100 and 250.\r
1254 <br><dt>-icsinput/-xicsinput or -internetChessServerInputBox true/false<dd><a name="index-icsinput_002c-option-209"></a><a name="index-internetChessServerInputBox_002c-option-210"></a>Sets the ICS Input Box menu option. See <a href="#Mode-Menu">Mode Menu</a>. Default: false.\r
1255 <br><dt>-autocomm/-xautocomm or -autoComment true/false<dd><a name="index-autocomm_002c-option-211"></a><a name="index-autoComment_002c-option-212"></a>Sets the Auto Comment menu option. See <a href="#Options-Menu">Options Menu</a>. Default: false.\r
1256 <br><dt>-autoflag/-xautoflag or -autoCallFlag true/false<dd><a name="index-autoflag_002c-option-213"></a><a name="index-autoCallFlag_002c-option-214"></a>Sets the Auto Flag menu option.  See <a href="#Options-Menu">Options Menu</a>. Default: false.\r
1257 <br><dt>-autobs/-xautobs or -autoObserve true/false<dd><a name="index-autobs_002c-option-215"></a><a name="index-autoObserve_002c-option-216"></a>Sets the Auto Observe menu option.  See <a href="#Options-Menu">Options Menu</a>. Default: false.\r
1258 <br><dt>-autoKibitz<dd><a name="index-autoKibitz_002c-option-217"></a>Enables kibitzing of the engines last thinking output (depth, score, time, speed, PV) \r
1259 before it moved\r
1260 to the ICS, in zippy mode. The option <code>showThinking</code> must be switched on for \r
1261 this option to work.\r
1262 Also diverts similar kibitz information of an opponent engine that is playing you \r
1263 through the ICS to the engine-output window, as if the engine was playing locally.\r
1264 <br><dt>-moves/-xmoves or -getMoveList true/false<dd><a name="index-moves_002c-option-218"></a><a name="index-getMoveList_002c-option-219"></a>Sets the Get Move List menu option.  See <a href="#Options-Menu">Options Menu</a>.  Default: true.\r
1265 <br><dt>-alarm/-xalarm or -icsAlarm true/false<dd><a name="index-alarm_002c-option-220"></a><a name="index-icsAlarm_002c-option-221"></a>Sets the ICS Alarm menu option.  See <a href="#Options-Menu">Options Menu</a>. Default: true.\r
1266 <br><dt>-icsAlarmTime ms<dd><a name="index-icsAlarmTime_002c-option-222"></a>Sets the time in milliseconds for the ICS Alarm menu option. \r
1267 See <a href="#Options-Menu">Options Menu</a>. Default: 5000.\r
1268 <br><dt>-pre/-xpre \fRor\fB -premove true/false<dd><a name="index-pre_002c-option-223"></a><a name="index-premove_002c-option-224"></a>Sets the Premove menu option. See <a href="#Options-Menu">Options Menu</a>. Default: true.\r
1269 <br><dt>-quiet/-xquiet or -quietPlay true/false<dd><a name="index-quiet_002c-option-225"></a><a name="index-quietPlay_002c-option-226"></a>Sets the Quiet Play menu option.  See <a href="#Options-Menu">Options Menu</a>.  Default: false.\r
1270 <br><dt>-colorizeMessages or -colorize<dd><a name="index-Colors-227"></a><a name="index-colorize_002c-option-228"></a>Setting colorizeMessages\r
1271 to true tells XBoard to colorize the messages received from\r
1272 the ICS.  Colorization works only if your xterm \r
1273 supports ISO 6429 escape sequences for changing text colors.\r
1274 <br><dt>-colorShout foreground,background,bold<dt>-colorSShout foreground,background,bold<dt>-colorChannel1 foreground,background,bold<dt>-colorChannel foreground,background,bold<dt>-colorKibitz foreground,background,bold<dt>-colorTell foreground,background,bold<dt>-colorChallege foreground,background,bold<dt>-colorRequest foreground,background,bold<dt>-colorSeek foreground,background,bold<dt>-colorNormal foreground,background,bold<dd><a name="index-Colors-229"></a><a name="index-colorShout_002c-option-230"></a><a name="index-colorSShout_002c-option-231"></a><a name="index-colorChannel1_002c-option-232"></a><a name="index-colorChannel_002c-option-233"></a><a name="index-colorKibitz_002c-option-234"></a><a name="index-colorTell_002c-option-235"></a><a name="index-colorChallenge_002c-option-236"></a><a name="index-colorRequest_002c-option-237"></a><a name="index-colorSeek_002c-option-238"></a><a name="index-colorNormal_002c-option-239"></a>These options set the colors used when colorizing ICS messages.\r
1275 All ICS messages are grouped into one of these categories:\r
1276 shout, sshout, channel 1, other channel, kibitz, tell, challenge, \r
1277 request (including abort, adjourn, draw, pause, and takeback), or\r
1278 normal (all other messages).  \r
1279 \r
1280 Each foreground or background argument can be one of the following:\r
1281 black, red, green, yellow, blue, magenta, cyan, white, or default.\r
1282 Here &ldquo;default&rdquo; means the default foreground or background color of\r
1283 your xterm.  Bold can be 1 or 0.  If background is omitted, &ldquo;default&rdquo;\r
1284 is assumed; if bold is omitted, 0 is assumed.\r
1285 \r
1286 Here is an example of how to set the colors in your <samp><span class="file">.Xresources</span></samp> file.\r
1287 The colors shown here are the default values; you will get\r
1288 them if you turn <code>-colorize</code> on without specifying your own colors.\r
1289 \r
1290      <pre class="example">          xboard*colorizeMessages: true       \r
1291           xboard*colorShout: green\r
1292           xboard*colorSShout: green, black, 1\r
1293           xboard*colorChannel1: cyan\r
1294           xboard*colorChannel: cyan, black, 1\r
1295           xboard*colorKibitz: magenta, black, 1\r
1296           xboard*colorTell: yellow, black, 1\r
1297           xboard*colorChallenge: red, black, 1\r
1298           xboard*colorRequest: red\r
1299           xboard*colorSeek: blue\r
1300           xboard*colorNormal: default\r
1301 </pre>
1302      <br><dt>-soundProgram progname<dd><a name="index-soundProgram_002c-option-240"></a><a name="index-Sounds-241"></a>If this option is set to a sound-playing program that is installed and\r
1303 working on your system, XBoard can play sound files when certain\r
1304 events occur, listed below.  The default program name is "play".  If\r
1305 any of the sound options is set to "$", the event rings the terminal\r
1306 bell by sending a ^G character to standard output, instead of playing\r
1307 a sound file.  If an option is set to the empty string "", no sound is\r
1308 played for that event.\r
1309 <br><dt>-soundShout filename<dt>-soundSShout filename<dt>-soundChannel filename<dt>-soundKibitz filename<dt>-soundTell filename<dt>-soundChallenge filename<dt>-soundRequest filename<dt>-soundSeek filename<dd><a name="index-soundShout_002c-option-242"></a><a name="index-soundSShout_002c-option-243"></a><a name="index-soundChannel_002c-option-244"></a><a name="index-soundKibitz_002c-option-245"></a><a name="index-soundTell_002c-option-246"></a><a name="index-soundChallenge_002c-option-247"></a><a name="index-soundRequest_002c-option-248"></a><a name="index-soundSeek_002c-option-249"></a>These sounds are triggered in the same way as the colorization events\r
1310 described above.  They all default to "", no sound.  They are played\r
1311 only if the colorizeMessages is on.\r
1312 <br><dt>-soundMove filename<dd><a name="index-soundMove_002c-option-250"></a>This sound is used by the Move Sound menu option.  Default: "$".\r
1313 <br><dt>-soundIcsAlarm filename<dd><a name="index-soundIcsAlarm_002c-option-251"></a>This sound is used by the ICS Alarm menu option.  Default: "$".\r
1314 <br><dt>-soundIcsWin filename<dd><a name="index-soundIcsWin_002c-option-252"></a>This sound is played when you win an ICS game.  Default: "" (no sound).\r
1315 <br><dt>-soundIcsLoss filename<dd><a name="index-soundIcsLoss_002c-option-253"></a>This sound is played when you lose an ICS game.  Default: "" (no sound).\r
1316 <br><dt>-soundIcsDraw filename<dd><a name="index-soundIcsDraw_002c-option-254"></a>This sound is played when you draw an ICS game.  Default: "" (no sound).\r
1317 <br><dt>-soundIcsUnfinished filename<dd><a name="index-soundIcsUnfinished_002c-option-255"></a>This sound is played when an ICS game that you are participating in is\r
1318 aborted, adjourned, or otherwise ends inconclusively.  Default: "" (no\r
1319 sound).\r
1320 \r
1321 Here is an example of how to set the sounds in your <samp><span class="file">.Xresources</span></samp> file:\r
1322 \r
1323      <pre class="example">          xboard*soundShout: shout.wav\r
1324           xboard*soundSShout: sshout.wav\r
1325           xboard*soundChannel1: channel1.wav\r
1326           xboard*soundChannel: channel.wav\r
1327           xboard*soundKibitz: kibitz.wav\r
1328           xboard*soundTell: tell.wav\r
1329           xboard*soundChallenge: challenge.wav\r
1330           xboard*soundRequest: request.wav\r
1331           xboard*soundSeek: seek.wav\r
1332           xboard*soundMove: move.wav\r
1333           xboard*soundIcsWin: win.wav\r
1334           xboard*soundIcsLoss: lose.wav\r
1335           xboard*soundIcsDraw: draw.wav\r
1336           xboard*soundIcsUnfinished: unfinished.wav\r
1337           xboard*soundIcsAlarm: alarm.wav\r
1338 </pre>
1339      </dl>
1340    \r
1341 <div class="node">
1342 <p><hr>
1343 <a name="Load-and-Save-options"></a>
1344 Next:&nbsp;<a rel="next" accesskey="n" href="#User-interface-options">User interface options</a>,
1345 Previous:&nbsp;<a rel="previous" accesskey="p" href="#ICS-options">ICS options</a>,
1346 Up:&nbsp;<a rel="up" accesskey="u" href="#Options">Options</a>
1347
1348 </div>
1349
1350 <h3 class="section">3.4 Load and Save options</h3>
1351
1352 <p><a name="index-Options_002c-Load-and-Save-256"></a><a name="index-Load-and-Save-options-257"></a>
1353      <dl>
1354 <dt>-lgf or -loadGameFile file<dt>-lgi or -loadGameIndex index<dd><a name="index-lgf_002c-option-258"></a><a name="index-loadGameFile_002c-option-259"></a><a name="index-lgi_002c-option-260"></a><a name="index-loadGameIndex_002c-option-261"></a>If the <code>loadGameFile</code> option is set, XBoard loads the specified\r
1355 game file at startup. The file name <samp><span class="file">-</span></samp> specifies the standard\r
1356 input. If there is more than one game in the file, XBoard\r
1357 pops up a menu of the available games, with entries based on their PGN \r
1358 (Portable Game Notation) tags.\r
1359 If the <code>loadGameIndex</code> option is set to &lsquo;<samp><span class="samp">N</span></samp>&rsquo;, the menu is suppressed\r
1360 and the N th game found in the file is loaded immediately.\r
1361 The menu is also suppressed if <code>matchMode</code> is enabled or if the game file\r
1362 is a pipe; in these cases the first game in the file is loaded immediately.\r
1363 Use the <samp><span class="file">pxboard</span></samp> shell script provided with XBoard if you\r
1364 want to pipe in files containing multiple games and still see the menu.\r
1365 If the loadGameIndex specifies an index -1, this triggers auto-increment\r
1366 of the index in <code>matchMode</code>, which means that after every game the\r
1367 index is incremented by one, causing each game of the match to be played\r
1368 from the next game in the file. Similarly, specifying an index value of -2\r
1369 causes the index to be incremented every two games, so that each game\r
1370 in the file is used twice (with reversed colors).\r
1371 The <code>rewindIndex</code> option causes the index to be reset to the\r
1372 first game of the file when it has reached a specified value.\r
1373 <br><dt>-rewindIndex n<dd>Causes a position file or game file to be rewound to its beginning after n\r
1374 positions or games in auto-increment <code>matchMode</code>. \r
1375 See <code>loadPositionIndex</code> and <code>loadGameIndex</code>.\r
1376 default: 0 (no rewind).\r
1377 <br><dt>-td or -timeDelay seconds<dd><a name="index-td_002c-option-262"></a><a name="index-timeDelay_002c-option-263"></a>Time delay between moves during &lsquo;<samp><span class="samp">Load Game</span></samp>&rsquo;. Fractional seconds\r
1378 are allowed; try &lsquo;<samp><span class="samp">-td 0.4</span></samp>&rsquo;. A time delay value of -1 tells\r
1379 XBoard not to step through game files automatically. Default: 1\r
1380 second.\r
1381 <br><dt>-sgf or -saveGameFile file<dd><a name="index-sgf_002c-option-264"></a><a name="index-saveGameFile_002c-option-265"></a>If this option is set, XBoard appends a record of every game\r
1382 played to the specified file. The file name <samp><span class="file">-</span></samp> specifies the\r
1383 standard output.\r
1384 <br><dt>-autosave/-xautosave or -autoSaveGames true/false<dd><a name="index-autosave_002c-option-266"></a><a name="index-autoSaveGames_002c-option-267"></a>Sets the Auto Save menu option.  See <a href="#Options-Menu">Options Menu</a>.  Default: false.\r
1385 Ignored if <code>saveGameFile</code> is set.\r
1386 <br><dt>-lpf or -loadPositionFile file<dt>-lpi or -loadPositionIndex index<dd><a name="index-lpf_002c-option-268"></a><a name="index-loadPositionFile_002c-option-269"></a><a name="index-lpi_002c-option-270"></a><a name="index-loadPositionIndex_002c-option-271"></a>If the <code>loadPositionFile</code> option is set, XBoard loads the\r
1387 specified position file at startup. The file name <samp><span class="file">-</span></samp> specifies the\r
1388 standard input. If the <code>loadPositionIndex</code> option is set to N,\r
1389 the Nth position found in the file is loaded; otherwise the\r
1390 first position is loaded.\r
1391 If the loadPositionIndex specifies an index -1, this triggers auto-increment\r
1392 of the index in <code>matchMode</code>, which means that after every game the\r
1393 index is incremented by one, causing each game of the match to be played\r
1394 from the next position in the file. Similarly, specifying an index value of -2\r
1395 causes the index to be incremented every two games, so that each position\r
1396 in the file is used twice (with the engines playing opposite colors).\r
1397 The <code>rewindIndex</code> option causes the index to be reset to the\r
1398 first position of the file when it has reached a specified value.\r
1399 <br><dt>-spf or -savePositionFile file<dd><a name="index-spf_002c-option-272"></a><a name="index-savePositionFile_002c-option-273"></a>If this option is set, XBoard appends the final position reached\r
1400 in every game played to the specified file. The file name <samp><span class="file">-</span></samp>\r
1401 specifies the standard output.\r
1402 <br><dt>-pgnExtendedInfo true/false<dd><a name="index-pgnExtendedInfo_002c-option_0060-274"></a>If this option is set, WinBoard saves depth, score and time used for each \r
1403 move that the engine found as a comment in the PGN file.\r
1404 Default: false.\r
1405 <br><dt>-pgnEventHeader string<dd><a name="index-pgnEventHeader_002c-option_0060-275"></a>Sets the name used in the PGN event tag to string. \r
1406 Default: "Computer Chess Game".\r
1407 <br><dt>-saveOutOfBookInfo true/false<dd><a name="index-saveOutOfBookInfo_002c-option_0060-276"></a>Include the information on how the engine(s) game out of its opening book in a special 'annotator' tag with the PGN file.\r
1408 <br><dt>-oldsave/-xoldsave or -oldSaveStyle true/false<dd><a name="index-oldsave_002c-option-277"></a><a name="index-oldSaveStyle_002c-option-278"></a>Sets the Old Save Style menu option.  See <a href="#Options-Menu">Options Menu</a>.  Default: false.\r
1409 <br><dt>-gameListTags string<dd><a name="index-gameListTags_002c-option-279"></a>The character string lists the PGN tags that should be printed in the\r
1410 Game List, and their order. The meaning of the codes is e=event,\r
1411 s=site, d=date, o=round, p=players, r=result, w=white Elo, b=black Elo,\r
1412 t=time control, v=variant, a=out-of-book info.\r
1413 Default: "eprd"\r
1414 </dl>
1415    \r
1416 <div class="node">
1417 <p><hr>
1418 <a name="User-interface-options"></a>
1419 Next:&nbsp;<a rel="next" accesskey="n" href="#Adjudication-Options">Adjudication Options</a>,
1420 Previous:&nbsp;<a rel="previous" accesskey="p" href="#Load-and-Save-options">Load and Save options</a>,
1421 Up:&nbsp;<a rel="up" accesskey="u" href="#Options">Options</a>
1422
1423 </div>
1424
1425 <h3 class="section">3.5 User interface options</h3>
1426
1427 <p><a name="index-User-interface-options-280"></a><a name="index-Options_002c-User-interface-281"></a>
1428      <dl>
1429 <dt>-display<dt>-geometry<dt>-iconic<dd><a name="index-display_002c-option-282"></a><a name="index-geometry_002c-option-283"></a><a name="index-iconic_002c-option-284"></a>These and most other standard Xt options are accepted.\r
1430 <br><dt>-noGUI<dd><a name="index-noGUI_002c-option-285"></a>Suppresses all GUI functions of XBoard \r
1431 (to speed up automated ultra-fast engine-engine games, which you donÂ’t want to watch). \r
1432 There will be no board or clock updates, no printing of moves, \r
1433 and no update of the icon on the task bar in this mode.\r
1434 <br><dt>-movesound/-xmovesound or -ringBellAfterMoves true/false<dd><a name="index-movesound_002c-option-286"></a><a name="index-bell_002c-option-287"></a><a name="index-ringBellAfterMoves_002c-option-288"></a>Sets the Move Sound menu option.  See <a href="#Options-Menu">Options Menu</a>.  Default: false.\r
1435 For compatibility with old XBoard versions, -bell/-xbell are also \r
1436 accepted as abbreviations for this option.\r
1437 <br><dt>-exit/-xexit or -popupExitMessage true/false<dd><a name="index-exit_002c-option-289"></a><a name="index-popupExitMessage_002c-option-290"></a>Sets the Popup Exit Message menu option.  See <a href="#Options-Menu">Options Menu</a>. Default: true.\r
1438 <br><dt>-popup/-xpopup or -popupMoveErrors true/false<dd><a name="index-popup_002c-option-291"></a><a name="index-popupMoveErrors_002c-option-292"></a>Sets the Popup Move Errors menu option.  See <a href="#Options-Menu">Options Menu</a>. Default: false.\r
1439 <br><dt>-queen/-xqueen or -alwaysPromoteToQueen true/false<dd><a name="index-queen_002c-option-293"></a><a name="index-alwaysPromoteToQueen_002c-option-294"></a>Sets the Always Queen menu option.  See <a href="#Options-Menu">Options Menu</a>.  Default: false.\r
1440 <br><dt>-legal/-xlegal or -testLegality true/false<dd><a name="index-legal_002c-option-295"></a><a name="index-testLegality_002c-option-296"></a>Sets the Test Legality menu option.  See <a href="#Options-Menu">Options Menu</a>.  Default: true.\r
1441 <br><dt>-size or -boardSize (sizeName | n1,n2,n3,n4,n5,n6,n7)<dd><a name="index-size_002c-option-297"></a><a name="index-boardSize_002c-option-298"></a><a name="index-board-size-299"></a>Determines how large the board will be, by selecting the pixel size\r
1442 of the pieces and setting a few related parameters.\r
1443 The sizeName can be one of: Titanic, giving 129x129 pixel pieces,\r
1444 Colossal 116x116, Giant 108x108, Huge 95x95, Big 87x87, Large 80x80, Bulky 72x72,\r
1445 Medium 64x64, Moderate 58x58, Average 54x54, Middling 49x49, Mediocre\r
1446 45x45, Small 40x40, Slim 37x37, Petite 33x33, Dinky 29x29, Teeny 25x25,\r
1447 or Tiny 21x21.\r
1448 Pieces of all these sizes are built into XBoard.\r
1449 Other sizes can\r
1450 be used if you have them; see the pixmapDirectory and bitmapDirectory\r
1451 options.\r
1452 The default depends on the size of your screen; it is approximately the\r
1453 largest size that will fit without clipping.\r
1454 \r
1455 You can select other sizes or vary other layout parameters by providing\r
1456 a list of comma-separated values (with no spaces) as the argument.\r
1457 You do not need to provide all the values; for any you omit from the\r
1458 end of the list, defaults are taken from the nearest built-in size.\r
1459 The value <code>n1</code> gives the piece size, <code>n2</code> the width of the\r
1460 black border\r
1461 between squares, <code>n3</code> the desired size for the \r
1462 clockFont, <code>n4</code> the desired size for the coordFont,\r
1463 <code>n5</code> the desired size for the default font,\r
1464 <code>n6</code> the smallLayout flag (0 or 1), \r
1465 and <code>n7</code> the tinyLayout flag (0 or 1).  \r
1466 All dimensions are in pixels.\r
1467 If the border between squares is eliminated (0 width), the various\r
1468 highlight options will not work, as there is nowhere to draw the highlight.\r
1469 If smallLayout is 1 and <code>titleInWindow</code> is true, \r
1470 the window layout is rearranged to make more room for the title.\r
1471 If tinyLayout is 1, the labels on the menu bar are abbreviated\r
1472 to one character each and the buttons in the button bar are made narrower.\r
1473 <br><dt>-coords/-xcoords or -showCoords true/false<dd><a name="index-coords_002c-option-300"></a><a name="index-showCoords_002c-option-301"></a>Sets the Show Coords menu option.  See <a href="#Options-Menu">Options Menu</a>.  Default: false.\r
1474 The <code>coordFont</code> option specifies what font to use.\r
1475 <br><dt>-autoraise/-xautoraise or -autoRaiseBoard true/false<dd><a name="index-autoraise_002c-option-302"></a><a name="index-autoRaiseBoard_002c-option-303"></a>Sets the Auto Raise Board menu option.  See <a href="#Options-Menu">Options Menu</a>.  Default: true.\r
1476 <br><dt>-autoflip/-xautoflip or -autoFlipView true/false<dd><a name="index-autoflip_002c-option-304"></a><a name="index-autoFlipView_002c-option-305"></a>Sets the Auto Flip View menu option.  See <a href="#Options-Menu">Options Menu</a>.  Default: true.\r
1477 <br><dt>-flip/-xflip or -flipView true/false<dd><a name="index-flip_002c-option-306"></a><a name="index-flipView_002c-option-307"></a>If Auto Flip View is not set, or if you are observing but not participating\r
1478 in a game, then the positioning of the board at the start of each game\r
1479 depends on the flipView option.  If flipView is false (the default),\r
1480 the board is positioned so that the white pawns move from the bottom to the\r
1481 top; if true, the black pawns move from the bottom to the top.\r
1482 In any case, the Flip menu option (see <a href="#Options-Menu">Options Menu</a>)\r
1483 can be used to flip the board after\r
1484 the game starts.\r
1485 <br><dt>-title/-xtitle or -titleInWindow true/false<dd><a name="index-title_002c-option-308"></a><a name="index-titleInWindow_002c-option-309"></a>If this option is true, XBoard displays player names (for ICS\r
1486 games) and game file names (for &lsquo;<samp><span class="samp">Load Game</span></samp>&rsquo;) inside its main\r
1487 window. If the option is false (the default), this information is\r
1488 displayed only in the window banner. You probably won't want to\r
1489 set this option unless the information is not showing up in the\r
1490 banner, as happens with a few X window managers.\r
1491 <br><dt>-buttons/-xbuttons or -showButtonBar True/False<dd><a name="index-buttons_002c-option-310"></a><a name="index-showButtonBar_002c-option-311"></a>If this option is False, xboard omits the [&lt;&lt;] [&lt;] [P] [&gt;] [&gt;&gt;] button\r
1492 bar from the window, allowing the message line to be wider.  You can\r
1493 still get the functions of these buttons using the menus or their keyboard\r
1494 shortcuts.  Default: true.\r
1495 <br><dt>-mono/-xmono or -monoMode true/false<dd><a name="index-mono_002c-option-312"></a><a name="index-monoMode_002c-option-313"></a>Determines whether XBoard displays its pieces and squares with\r
1496 two colors (true) or four (false). You shouldn't have to\r
1497 specify <code>monoMode</code>; XBoard will determine if it is necessary.\r
1498 <br><dt>-flashCount count<dt>-flashRate rate<dt>-flash/-xflash<dd><a name="index-flashCount_002c-option-314"></a><a name="index-flashRate_002c-option-315"></a><a name="index-flash_002c-option-316"></a><a name="index-xflash_002c-option-317"></a>These options enable flashing of pieces when they\r
1499 land on their destination square.\r
1500 <code>flashCount</code>\r
1501 tells XBoard how many times to flash a piece after it\r
1502 lands on its destination square.\r
1503 <code>flashRate</code>\r
1504 controls the rate of flashing (flashes/sec).\r
1505 Abbreviations:\r
1506 <code>flash</code>\r
1507 sets flashCount to 3.\r
1508 <code>xflash</code>\r
1509 sets flashCount to 0.\r
1510 Defaults:  flashCount=0 (no flashing), flashRate=5.\r
1511 <br><dt>-highlight/-xhighlight or -highlightLastMove true/false<dd><a name="index-highlight_002c-option-318"></a><a name="index-highlightLastMove_002c-option-319"></a>Sets the Highlight Last Move menu option. See <a href="#Options-Menu">Options Menu</a>. Default: false.\r
1512 <br><dt>-blind/-xblind or -blindfold true/false<dd><a name="index-blind_002c-option-320"></a><a name="index-blindfold_002c-option-321"></a>Sets the Blindfold menu option.  See <a href="#Options-Menu">Options Menu</a>.  Default: false.\r
1513 <br><dt>-clockFont font<dd><a name="index-clockFont_002c-option-322"></a><a name="index-Font_002c-clock-323"></a>The font used for the clocks. If the option value is a pattern\r
1514 that does not specify the font size, XBoard tries to choose an\r
1515 appropriate font for the board size being used.\r
1516 Default: -*-helvetica-bold-r-normal&ndash;*-*-*-*-*-*-*-*.\r
1517 <br><dt>-coordFont font<dd><a name="index-coordFont_002c-option-324"></a><a name="index-Font_002c-coordinates-325"></a>The font used for rank and file coordinate labels if <code>showCoords</code>\r
1518 is true. If the option value is a pattern that does not specify\r
1519 the font size, XBoard tries to choose an appropriate font for\r
1520 the board size being used.\r
1521 Default: -*-helvetica-bold-r-normal&ndash;*-*-*-*-*-*-*-*.\r
1522 <br><dt>-font font<dd><a name="index-font_002c-option-326"></a><a name="index-Font-327"></a>The font used for popup dialogs, menus, comments, etc.\r
1523 If the option value is a pattern that does not specify\r
1524 the font size, XBoard tries to choose an appropriate font for\r
1525 the board size being used.\r
1526 Default: -*-helvetica-medium-r-normal&ndash;*-*-*-*-*-*-*-*.\r
1527 <br><dt>-fontSizeTolerance tol<dd><a name="index-fontSizeTolerance_002c-option-328"></a>In the font selection algorithm, a nonscalable font will be preferred\r
1528 over a scalable font if the nonscalable font's size differs\r
1529 by <code>tol</code> pixels\r
1530 or less from the desired size.  A value of -1 will force\r
1531 a scalable font to always be used if available; a value of 0 will\r
1532 use a nonscalable font only if it is exactly the right size; \r
1533 a large value (say 1000) will force a nonscalable font to always be\r
1534 used if available.  Default: 4.\r
1535 <br><dt>-bm or -bitmapDirectory dir<dt>-pixmap or -pixmapDirectory dir<dd><a name="index-bm_002c-option-329"></a><a name="index-bitmapDirectory_002c-option-330"></a><a name="index-pixmap_002c-option-331"></a><a name="index-pixmapDirectory_002c-option-332"></a>These options control what piece images xboard uses.  The XBoard\r
1536 distribution includes one set of pixmap pieces in xpm format, in the\r
1537 directory <samp><span class="file">pixmaps</span></samp>, and one set of bitmap pieces in xbm format,\r
1538 in the directory <samp><span class="file">bitmaps</span></samp>.  Pixmap\r
1539 pieces give a better appearance on the screen: the white pieces have\r
1540 dark borders, and the black pieces have opaque internal details.  With\r
1541 bitmaps, neither piece color has a border, and the internal details\r
1542 are transparent; you see the square color or other background color\r
1543 through them.\r
1544 \r
1545 If XBoard is configured and compiled on a system that includes libXpm,\r
1546 the X pixmap library, the xpm pixmap pieces are compiled in as the\r
1547 default.  A different xpm piece set can be selected at runtime with\r
1548 the <code>pixmapDirectory</code> option, or a bitmap piece set can be selected\r
1549 with the <code>bitmapDirectory</code> option.\r
1550 \r
1551 If XBoard is configured and compiled on a system that does not include\r
1552 libXpm (or the <code>--disable-xpm</code> option is given to the configure\r
1553 program), the bitmap pieces are compiled in as the default.  It is not\r
1554 possible to use xpm pieces in this case, but pixmap pieces in another\r
1555 format called "xim" can be used by giving the <code>pixmapDirectory</code> option.\r
1556 Or again, a different bitmap piece set can be selected with the\r
1557 <code>bitmapDirectory</code> option.\r
1558 \r
1559 Files in the <code>bitmapDirectory</code> must be named as follows:\r
1560 The first character of a piece bitmap name gives the piece it \r
1561 represents (&lsquo;<samp><span class="samp">p</span></samp>&rsquo;, &lsquo;<samp><span class="samp">n</span></samp>&rsquo;, &lsquo;<samp><span class="samp">b</span></samp>&rsquo;, &lsquo;<samp><span class="samp">r</span></samp>&rsquo;, &lsquo;<samp><span class="samp">q</span></samp>&rsquo;, or &lsquo;<samp><span class="samp">k</span></samp>&rsquo;),\r
1562 the next characters give the size in pixels, the\r
1563 following character indicates whether the piece is\r
1564 solid or outline (&lsquo;<samp><span class="samp">s</span></samp>&rsquo; or &lsquo;<samp><span class="samp">o</span></samp>&rsquo;),\r
1565 and the extension is &lsquo;<samp><span class="samp">.bm</span></samp>&rsquo;.\r
1566 For example, a solid 80x80 knight would be named <samp><span class="file">n80s.bm</span></samp>.\r
1567 The outline bitmaps are used only in monochrome mode.\r
1568 If bitmap pieces are compiled in and the bitmapDirectory is missing\r
1569 some files, the compiled in pieces are used instead.\r
1570 \r
1571 If the bitmapDirectory option is given,\r
1572 it is also possible to replace xboard's icons and menu checkmark,\r
1573 by supplying files named <samp><span class="file">icon_white.bm</span></samp>, <samp><span class="file">icon_black.bm</span></samp>, and\r
1574 <samp><span class="file">checkmark.bm</span></samp>.\r
1575 \r
1576 For more information about pixmap pieces and how to get additional\r
1577 sets, see <a href="#zic2xpm">zic2xpm</a> below.\r
1578 <br><dt>-whitePieceColor color<dt>-blackPieceColor color<dt>-lightSquareColor color<dt>-darkSquareColor color<dt>-highlightSquareColor color<dd><a name="index-Colors-333"></a><a name="index-whitePieceColor_002c-option-334"></a><a name="index-blackPieceColor_002c-option-335"></a><a name="index-lightSquareColor_002c-option-336"></a><a name="index-darkSquareColor_002c-option-337"></a><a name="index-highlightSquareColor_002c-option-338"></a>Colors to use for the pieces, squares, and square highlights.\r
1579 Defaults:\r
1580 \r
1581      <pre class="example">          -whitePieceColor       #FFFFCC\r
1582           -blackPieceColor       #202020\r
1583           -lightSquareColor      #C8C365\r
1584           -darkSquareColor       #77A26D\r
1585           -highlightSquareColor  #FFFF00\r
1586           -premoveHighlightColor #FF0000\r
1587 </pre>
1588      <p>\r
1589 On a grayscale monitor you might prefer:\r
1590 \r
1591      <pre class="example">          -whitePieceColor       gray100\r
1592           -blackPieceColor       gray0\r
1593           -lightSquareColor      gray80\r
1594           -darkSquareColor       gray60\r
1595           -highlightSquareColor  gray100\r
1596           -premoveHighlightColor gray70\r
1597 </pre>
1598      <br><dt>-drag/-xdrag or -animateDragging true/false<dd><a name="index-drag_002c-option-339"></a><a name="index-animateDragging_002c-option-340"></a>Sets the Animate Dragging menu option. See <a href="#Options-Menu">Options Menu</a>.  Default: true.\r
1599 <br><dt>-animate/-xanimate or -animateMoving true/false<dd><a name="index-animate_002c-option-341"></a><a name="index-animateMoving_002c-option-342"></a>Sets the Animate Moving menu option. See <a href="#Options-Menu">Options Menu</a>.  Default: true.\r
1600 <br><dt>-animateSpeed n<dd><a name="index-g_t_002danimateSpeed_002c-option-343"></a>Number of milliseconds delay between each animation frame when Animate\r
1601 Moves is on.\r
1602 </dl>
1603    \r
1604 <div class="node">
1605 <p><hr>
1606 <a name="Adjudication-Options"></a>
1607 Next:&nbsp;<a rel="next" accesskey="n" href="#Other-options">Other options</a>,
1608 Previous:&nbsp;<a rel="previous" accesskey="p" href="#User-interface-options">User interface options</a>,
1609 Up:&nbsp;<a rel="up" accesskey="u" href="#Options">Options</a>
1610
1611 </div>
1612
1613 <h3 class="section">3.6 Adjudication Options</h3>
1614
1615 <p><a name="index-Options_002c-adjudication-344"></a>
1616      <dl>
1617 <dt>-adjudicateLossThreshold n<dd><a name="index-adjudicateLossThreshold_002c-option-345"></a>If the given value is non-zero, XBoard adjudicates the game as a loss \r
1618 if both engines agree for a duration of 6 consecutive ply that the score \r
1619 is below the given score threshold for that engine. Make sure the score \r
1620 is interpreted properly by XBoard, \r
1621 using <code>-firstScoreAbs</code> and <code>-secondScoreAbs</code> if needed. \r
1622 Default: 0 (no adjudiction)\r
1623 <br><dt>-adjudicateDrawMoves n<dd><a name="index-adjudicateDrawMoves_002c-option-346"></a>If the given value is non-zero, XBoard adjudicates the game as a draw \r
1624 if after the given number of moves it was not yet decided. Defaut: 0 (no adjudication)\r
1625 <br><dt>-checkMates true/false<dd><a name="index-checkMates_002c-option-347"></a>If this option is set, XBoard detects all checkmates and stalemates, \r
1626 and ends the game as soon as they occur. \r
1627 Legality-testing must be switched on for this option to work.\r
1628 Default: true\r
1629 <br><dt>-testClaims true/false<dd><a name="index-testClaims_002c-option-348"></a>If this option is set, XBoard verifies all result claims made by engines, \r
1630 and those who send false claims will forfeit the game because of it. \r
1631 Legality-testing must be switched on for this option to work. Default: true\r
1632 <br><dt>-materialDraws true/false<dd><a name="index-materialDraws_002c-option-349"></a>If this option is set, XBoard adjudicates games as draws when there is \r
1633 no sufficient material left to inflict a checkmate. \r
1634 This applies to KBKB with like bishops (any number, actually), and to KBK, KNK and KK. \r
1635 Legality-testing must be switched on for this option to work. Default: true\r
1636 <br><dt>-trivialDraws true/false<dd><a name="index-trivialDraws_002c-option-350"></a>If this option is set, XBoard adjudicates games as draws that cannot be \r
1637 usually won without opponent cooperation. This applies to KBKB with unlike bishops, \r
1638 and to KBKN, KNKN, KNNK, KRKR and KQKQ. The draw is called after 6 ply into these end-games, \r
1639 to allow quick mates that can occur in some exceptional positions to be found by the engines. \r
1640 KQKQ does not really belong in this category, and might be taken out in the future. \r
1641 (When bitbase-based adjudications are implemented.) \r
1642 Legality-testing must be on for this option to work. Default: false\r
1643 <br><dt>-ruleMoves n<dd><a name="index-ruleMoves_002c-option-351"></a>If the given value is non-zero, XBoard adjudicates the game as a draw after the given \r
1644 number of consecutive reversible moves. Engine draw claims are always accepted after 50 moves, \r
1645 irrespective of the given value of n.\r
1646 <br><dt>-repeatsToDraw n<dd>If the given value is non-zero, xboard adjudicates the game as a draw if a position \r
1647 is repeated the given number of times. Engines draw claims are always accepted after 3 repeats, \r
1648 (on the 3rd occurrence, actually), irrespective of the value of n. \r
1649 Beware that positions that have different castling or en-passant rights do not count \r
1650 as repeats, XBoard is fully e.p. and castling aware!\r
1651 </dl>
1652    \r
1653 <div class="node">
1654 <p><hr>
1655 <a name="Other-options"></a>
1656 Previous:&nbsp;<a rel="previous" accesskey="p" href="#Adjudication-Options">Adjudication Options</a>,
1657 Up:&nbsp;<a rel="up" accesskey="u" href="#Options">Options</a>
1658
1659 </div>
1660
1661 <h3 class="section">3.7 Other options</h3>
1662
1663 <p><a name="index-Options_002c-miscellaneous-352"></a>
1664      <dl>
1665 <dt>-ncp/-xncp or -noChessProgram true/false<dd><a name="index-ncp_002c-option-353"></a><a name="index-noChessProgram_002c-option-354"></a>If this option is true, XBoard acts as a passive chessboard; it\r
1666 does not start a chess engine at all. Turning on this option\r
1667 also turns off clockMode. Default: false.\r
1668 <br><dt>-mode or -initialMode modename<dd><a name="index-mode_002c-option-355"></a><a name="index-initalMode_002c-option-356"></a>If this option is given, XBoard selects the given modename\r
1669 from the Mode menu after starting and (if applicable) processing the\r
1670 loadGameFile or loadPositionFile option. Default: "" (no selection). \r
1671 Other supported values are \r
1672 MachineWhite, MachineBlack, TwoMachines, Analysis, \r
1673 AnalyzeFile, EditGame, EditPosition, and Training.\r
1674 <br><dt>-variant varname<dd><a name="index-variant_002c-option-357"></a>Activates preliminary, partial support for playing chess variants\r
1675 against a local engine or editing variant games.  This flag is not\r
1676 needed in ICS mode.  Recognized variant names are:\r
1677 \r
1678      <pre class="example">          normal        Normal chess\r
1679           wildcastle    Shuffle chess, king can castle from d file\r
1680           nocastle      Shuffle chess, no castling allowed\r
1681           fischerandom  Fischer Random shuffle chess\r
1682           bughouse      Bughouse, ICC/FICS rules\r
1683           crazyhouse    Crazyhouse, ICC/FICS rules\r
1684           losers        Lose all pieces or get mated (ICC wild 17)\r
1685           suicide       Lose all pieces including king (FICS)\r
1686           giveaway      Try to have no legal moves (ICC wild 26)\r
1687           twokings      Weird ICC wild 9\r
1688           kriegspiel    Opponent's pieces are invisible\r
1689           atomic        Capturing piece explodes (ICC wild 27)\r
1690           3check        Win by giving check 3 times (ICC wild 25)\r
1691           shatranj      An ancient precursor of chess (ICC wild 28)\r
1692           xiangqi       Chinese Chess (on a 9x10 board)\r
1693           shogi         Japanese Chess (on a 9x9 board &amp; piece drops) \r
1694           capablanca    Capablanca Chess (10x8 board, with Archbishop \r
1695                         and Chancellor pieces)\r
1696           gothic        similar, with a better initial position\r
1697           caparandom    An FRC-like version of Capablanca Chess (10x8) \r
1698           janus         A game with two Archbishops (10x8 board)\r
1699           courier       Medieval intermedite between shatranj and \r
1700                         modern Chess (on 12x8 board) \r
1701           falcon        Patented 10x8 variant with two Falcon pieces\r
1702           berolina      Pawns capture straight ahead, and move diagonal \r
1703           cylinder      Pieces wrap around the board edge\r
1704           knightmate    King moves as Knight, and vice versa \r
1705           super         Superchess (shuffle variant with 4 exo-pieces)\r
1706           fairy         A catchall variant in which all piece types \r
1707                         known to XBoard can participate (8x8)\r
1708           unknown       Catchall for other unknown variants\r
1709 </pre>
1710      <p>\r
1711 In the shuffle variants, XBoard now does shuffle the pieces, although\r
1712 you can still do it by hand using Edit Position.  Some variants are\r
1713 supported only in ICS mode, including bughouse, and\r
1714 kriegspiel.  The winning/drawing conditions in crazyhouse (offboard\r
1715 interposition on mate), losers, suicide, giveaway, atomic, and 3check\r
1716 are not fully understood.  \r
1717 Berolina and cylinder chess can only be played with legality testing off.\r
1718 In crazyhouse, XBoard now does keep\r
1719 track of offboard pieces.  In shatranj it does implement the baring\r
1720 rule when mate detection is switched on.\r
1721 <br><dt>-boardHeight N<dd><a name="index-boardHeight_002c-option-358"></a>Allows you to set a non-standard number of board ranks in any variant. \r
1722 If the height is given as -1, the default height for the variant is used.\r
1723 Default: -1\r
1724 <br><dt>-boardWidth N<dd><a name="index-boardWidth_002c-option-359"></a>Allows you to set a non-standard number of board files in any variant. \r
1725 If the width is given as -1, the default width for the variant is used. \r
1726 With a non-standard width, the initial position will always be an empty board, \r
1727 as the usual opening array will not fit.\r
1728 Default: -1\r
1729 <br><dt>-holdingsSize N<dd><a name="index-holdingsSize_002c-option-360"></a>Allows you to set a non-standard size for the holdings in any variant. \r
1730 If the size is given as -1, the default holdings size for the variant is used. \r
1731 The first N piece types will go into the holdings on capture, and you will be \r
1732 able to drop them on the board in stead of making a normal move. If size equals 0, \r
1733 there will be no holdings.\r
1734 Default: -1\r
1735 <br><dt>-defaultFrcPosition N<dd><a name="index-defaultFrcPosition_002c-option-361"></a>Specifies the number of the opening position in shuffle games like Chess960. \r
1736 A value of -1 means the position is randomly generated by XBoard\r
1737 at the beginning of every game.\r
1738 Default: -1\r
1739 <br><dt>-pieceToSquareTable string<dd><a name="index-pieceToSquareTable_002c-option-362"></a>The characters that are used to represent the piece types XBoard knows in FEN \r
1740 diagrams and SAN moves. The string argument has to have an even length \r
1741 (or it will be ignored), as white and black pieces have to be given separately \r
1742 (in that order). The last letter for each color will be the King. \r
1743 The letters before that will be PNBRQ and then a whole host of fairy pieces \r
1744 in an order that has not fully crystallized yet (currently FEACWMOHIJGDVSLU, \r
1745 F=Ferz, Elephant, A=Archbishop, C=Chancellor, W=Wazir, M=Commoner, O=Cannon, \r
1746 H=Nightrider). You should list at least all pieces that occur in the variant \r
1747 you are playing. If you have less than 44 characters in the string, the pieces \r
1748 not mentioned will get assigned a period, and you will not be able to distinguish \r
1749 them in FENs. You can also explicitly assign pieces a period, in which case they \r
1750 will not be counted in deciding which captured pieces can go into the holdings.\r
1751 A tilde '~' as a piece name does mean this piece is used to represent a promoted \r
1752 Pawn in crazyhouse-like games, i.e. on capture it turns back onto a Pawn. \r
1753 A '+' similarly indicates the piece is a shogi-style promoted piece, that should \r
1754 revert to its non-promoted version on capture (rather than to a Pawn).\r
1755 Note that promoted pieces are represented by pieces 11 further in the list.\r
1756 You should not have to use this option often: each variant has its own default \r
1757 setting for the piece representation in FEN, which should be sufficient in normal use.\r
1758 Default: ""\r
1759 <br><dt>-debug/-xdebug or -debugMode true/false<dd><a name="index-debug_002c-option-363"></a><a name="index-debugMode_002c-option-364"></a>Turns on debugging printout.\r
1760 <br><dt>-debugFile filename or -nameOfDebugFile filename<dd><a name="index-debugFile_002c-option-365"></a><a name="index-nameOfDebugFile_002c-option-366"></a>Sets the name of the file to which WinBoard saves debug information \r
1761 (including all communication to and from the engines).\r
1762 <br><dt>-engineDebugOutput number<dd><a name="index-engineDebugOutput_002c-option-367"></a>Specifies how WinBoard should handle unsolicited output from the engine, \r
1763 with respect to saving it in the debug file. \r
1764 The output is further (hopefully) ignored. \r
1765 If number=0, WinBoard refrains from writing such spurious output to the debug file. \r
1766 If number=1, all engine output is written faithfully to the debug file. \r
1767 If number=2, any protocol-violating line is prefixed with a Â‘#Â’ character, \r
1768 as the engine itself should have done if it wanted to submit info for inclusion in the debug file.\r
1769 This option is provided for the benefit of applications that use the debug file \r
1770 as a source of information, such as the broadcaster of live games TLCV / TLCS. \r
1771 Such applications can be protected from spurious engine output that might otherwise confuse them.\r
1772 <br><dt>-rsh or -remoteShell shell-name<dd><a name="index-rsh_002c-option-368"></a><a name="index-remoteShell_002c-option-369"></a>Name of the command used to run programs remotely. The default\r
1773 is <samp><span class="file">rsh</span></samp> or <samp><span class="file">remsh</span></samp>, determined when XBoard is\r
1774 configured and compiled.\r
1775 <br><dt>-ruser or -remoteUser user-name<dd><a name="index-ruser_002c-option-370"></a><a name="index-remoteUser_002c-option-371"></a>User name on the remote system when running programs with the\r
1776 <code>remoteShell</code>. The default is your local user name.\r
1777 <br><dt>-userName username<dd><a name="index-userName_002c-option-372"></a>Name under which the Human player will be listed in the PGN file. \r
1778 Default is the login name on your local computer.\r
1779 <br><dt>-delayBeforeQuit number<dt>-delayAfterQuit number<dd><a name="index-delayBeforeQuit_002c-option-373"></a><a name="index-delayAfterQuit_002c-option-374"></a>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 Â‘quitÂ’ command. The second one determines the pause after killing the engine, to make sure it dies.\r
1780 \r
1781 </dl>
1782    \r
1783 <div class="node">
1784 <p><hr>
1785 <a name="Chess-Servers"></a>
1786 Next:&nbsp;<a rel="next" accesskey="n" href="#Firewalls">Firewalls</a>,
1787 Previous:&nbsp;<a rel="previous" accesskey="p" href="#Options">Options</a>,
1788 Up:&nbsp;<a rel="up" accesskey="u" href="#Top">Top</a>
1789
1790 </div>
1791
1792 <h2 class="chapter">4 Chess Servers</h2>
1793
1794 <p><a name="index-ICS-375"></a><a name="index-ICS_002c-addresses-376"></a><a name="index-Internet-Chess-Server-377"></a>An <dfn>Internet Chess Server</dfn>, or <dfn>ICS</dfn>, is a place on the\r
1795 Internet where people can get together to play chess, watch other\r
1796 people's games, or just chat.  You can use either <code>telnet</code> or a\r
1797 client program like XBoard to connect to the server.  There are\r
1798 thousands of registered users on the different ICS hosts, and it is\r
1799 not unusual to meet 200 on both chessclub.com and freechess.org.\r
1800 \r
1801 Most people can just type <kbd>xboard -ics</kbd> to start XBoard as an ICS\r
1802 client.  Invoking XBoard in this way connects you to the Internet\r
1803 Chess Club (ICC), a commercial ICS.  You can log in there as a guest\r
1804 even if you do not have a paid account.  To connect to the largest\r
1805 Free ICS (FICS), use the command <kbd>xboard -ics -icshost freechess.org</kbd>\r
1806 instead, or substitute a different host name to connect to your\r
1807 favorite ICS.\r
1808 For a full description of command-line options that control \r
1809 the connection to ICS and change the default values of ICS options, see\r
1810 <a href="#ICS-options">ICS options</a>.  \r
1811 \r
1812 While you are running XBoard as an ICS client,\r
1813 you use the terminal window that you started XBoard from\r
1814 as a place to type in commands and read information that is\r
1815 not available on the chessboard.\r
1816 \r
1817 The first time you need to use the terminal is to enter your login name\r
1818 and password, if you are a registered player. (You don't need to do\r
1819 this manually; the <code>icsLogon</code> option can do it for you.\r
1820 see <a href="#ICS-options">ICS options</a>.)  If you are not registered, \r
1821 enter <kbd>g</kbd> as your name, and the server will pick a\r
1822 unique guest name for you.\r
1823 \r
1824 Some useful ICS commands\r
1825 include\r
1826      <dl>
1827 <dt><kbd>help &lt;topic&gt;</kbd><dd><a name="index-help_002c-ICS-command-378"></a>to get help on the given &lt;topic&gt;. To get a list of possible topics type\r
1828 <dfn>help</dfn> without topic.  Try the help command before you ask other\r
1829 people on the server for help.\r
1830 \r
1831 For example <kbd>help register</kbd> tells you how to become a registered\r
1832 ICS player.\r
1833 <br><dt><kbd>who &lt;flags&gt;</kbd><dd><a name="index-who_002c-ICS-command-379"></a>to see a list of people who are logged on.  Administrators\r
1834 (people you should talk to if you have a problem) are marked\r
1835 with the character &lsquo;<samp><span class="samp">*</span></samp>&rsquo;, an asterisk. The &lt;flags&gt; allow you to\r
1836 display only selected players: For example, <kbd>who of</kbd> shows a\r
1837 list of players who are interested in playing but do not have\r
1838 an opponent.\r
1839 <br><dt><kbd>games</kbd><dd><a name="index-games_002c-ICS-command-380"></a>to see what games are being played\r
1840 <br><dt><kbd>match &lt;player&gt; [&lt;mins&gt;] [&lt;inc&gt;]</kbd><dd>to challenge another player to a game. Both opponents get &lt;mins&gt; minutes\r
1841 for the game, and &lt;inc&gt; seconds will be added after each move.\r
1842 If another player challenges you, the server asks if you want to\r
1843 accept the challenge; use the <kbd>accept</kbd> or <kbd>decline</kbd> commands\r
1844 to answer.\r
1845 <br><dt><kbd>accept</kbd><dt><kbd>decline</kbd><dd><a name="index-accept_002c-ICS-command-381"></a><a name="index-decline_002c-ICS-command-382"></a>to accept or decline another player's offer. \r
1846 The offer may be to start a new game, or to agree to a \r
1847 <kbd>draw</kbd>, <kbd>adjourn</kbd> or <kbd>abort</kbd> the current game. See <a href="#Action-Menu">Action Menu</a>.\r
1848 \r
1849 If you have more than one pending offer (for example, if more than one player\r
1850 is challenging you, or if your opponent offers both a draw and to adjourn the\r
1851 game), you have to supply additional information, by typing something\r
1852 like <kbd>accept &lt;player&gt;</kbd>, <kbd>accept draw</kbd>, or <kbd>draw</kbd>.\r
1853 <br><dt><kbd>draw</kbd><dt><kbd>adjourn</kbd><dt><kbd>abort</kbd><dd><a name="index-draw_002c-ICS-command-383"></a><a name="index-adjourn_002c-ICS-command-384"></a><a name="index-abort_002c-ICS-command-385"></a>asks your opponent to terminate a game by mutual agreement. Adjourned\r
1854 games can be continued later. \r
1855 Your opponent can either <kbd>decline</kbd> your offer or accept it (by typing the\r
1856 same command or typing <kbd>accept</kbd>).  In some cases these commands work\r
1857 immediately, without asking your opponent to agree.  For example, you can\r
1858 abort the game unilaterally if your opponent is out of time, and you can claim\r
1859 a draw by repetition or the 50-move rule if available simply by typing \r
1860 <kbd>draw</kbd>.\r
1861 <br><dt><kbd>finger &lt;player&gt;</kbd><dd><a name="index-finger_002c-ICS-command-386"></a>to get information about the given &lt;player&gt;. (Default: yourself.)\r
1862 <br><dt><kbd>vars</kbd><dd><a name="index-vars_002c-ICS-command-387"></a>to get a list of personal settings\r
1863 <br><dt><kbd>set &lt;var&gt; &lt;value&gt;</kbd><dd><a name="index-set_002c-ICS-command-388"></a>to modify these settings\r
1864 <br><dt><kbd>observe &lt;player&gt;</kbd><dd><a name="index-observe_002c-ICS-command-389"></a>to observe an ongoing game of the given &lt;player&gt;.\r
1865 <br><dt><kbd>examine</kbd><dt><kbd>oldmoves</kbd><dd><a name="index-examine_002c-ICS-command-390"></a><a name="index-oldmoves_002c-ICS-command-391"></a>to review a recently completed game\r
1866 </dl>
1867    \r
1868 Some special XBoard features are activated when you are\r
1869 in examine mode on ICS.  See the descriptions of the menu commands\r
1870 &lsquo;<samp><span class="samp">Forward</span></samp>&rsquo;, &lsquo;<samp><span class="samp">Backward</span></samp>&rsquo;, &lsquo;<samp><span class="samp">Pause</span></samp>&rsquo;, &lsquo;<samp><span class="samp">ICS Client</span></samp>&rsquo;, \r
1871 and &lsquo;<samp><span class="samp">Stop Examining</span></samp>&rsquo; on the <a href="#Step-Menu">Step Menu</a>, <a href="#Mode-Menu">Mode Menu</a>, and\r
1872 <a href="#Options-Menu">Options Menu</a>.\r
1873 \r
1874 <div class="node">
1875 <p><hr>
1876 <a name="Firewalls"></a>
1877 Next:&nbsp;<a rel="next" accesskey="n" href="#Environment">Environment</a>,
1878 Previous:&nbsp;<a rel="previous" accesskey="p" href="#Chess-Servers">Chess Servers</a>,
1879 Up:&nbsp;<a rel="up" accesskey="u" href="#Top">Top</a>
1880
1881 </div>
1882
1883 <h2 class="chapter">5 Firewalls</h2>
1884
1885 <p>By default, XBoard communicates with an Internet Chess Server\r
1886 by opening a TCP socket directly from the machine it is running on\r
1887 to the ICS. If there is a firewall between your machine and the ICS,\r
1888 this won't work. Here are some recipes for getting around common\r
1889 kinds of firewalls using special options to XBoard.\r
1890 Important: See the paragraph in the below about extra echoes, in\r
1891 <a href="#Limitations">Limitations</a>.\r
1892 \r
1893 Suppose that you can't telnet directly to ICS, but you can telnet\r
1894 to a firewall host, log in, and then telnet from there to ICS.\r
1895 Let's say the firewall is called &lsquo;<samp><span class="samp">firewall.example.com</span></samp>&rsquo;. Set\r
1896 command-line options as follows:\r
1897 \r
1898 <pre class="example">     xboard -ics -icshost firewall.example.com -icsport 23\r
1899 </pre>
1900    <p class="noindent">Or in your <samp><span class="file">.Xresources</span></samp> file:\r
1901 \r
1902 <pre class="example">     XBoard*internetChessServerHost: firewall.example.com\r
1903      XBoard*internetChessServerPort: 23\r
1904 </pre>
1905    <p class="noindent">Then when you run XBoard in ICS mode, you will be prompted\r
1906 to log in to the firewall host. This works because port 23 is the\r
1907 standard telnet login service. Do so, then telnet to ICS, using a\r
1908 command like &lsquo;<samp><span class="samp">telnet chessclub.com 5000</span></samp>&rsquo;, or whatever command\r
1909 the firewall provides for telnetting to port 5000.\r
1910 \r
1911 If your firewall lets you telnet (or rlogin) to remote hosts but\r
1912 doesn't let you telnet to port 5000, you may be able to connect to the\r
1913 chess server on port 23 instead, which is the port the telnet program\r
1914 uses by default.  Some chess servers support this (including\r
1915 chessclub.com and freechess.org), while some do not.\r
1916 \r
1917 If your chess server does not allow connections on port 23 and your\r
1918 firewall does not allow you to connect to other ports, you may be able\r
1919 to connect by hopping through another host outside the firewall that\r
1920 you have an account on.  For instance, suppose you have a shell\r
1921 account at &lsquo;<samp><span class="samp">foo.edu</span></samp>&rsquo;. Follow the recipe above, but instead of\r
1922 typing &lsquo;<samp><span class="samp">telnet chessclub.com 5000</span></samp>&rsquo; to the firewall, type\r
1923 &lsquo;<samp><span class="samp">telnet foo.edu</span></samp>&rsquo; (or &lsquo;<samp><span class="samp">rlogin foo.edu</span></samp>&rsquo;), log in there, and\r
1924 then type &lsquo;<samp><span class="samp">telnet chessclub.com 5000</span></samp>&rsquo;.\r
1925 \r
1926 Suppose that you can't telnet directly to ICS, but you can use rsh\r
1927 to run programs on a firewall host, and that host can telnet to ICS.\r
1928 Let's say the firewall is called &lsquo;<samp><span class="samp">rsh.example.com</span></samp>&rsquo;. Set\r
1929 command-line options as follows:\r
1930 \r
1931 <pre class="example">     xboard -ics -gateway rsh.example.com -icshost chessclub.com\r
1932 </pre>
1933    <p>\r
1934 Or in your <samp><span class="file">.Xresources</span></samp> file:\r
1935 \r
1936 <pre class="example">     XBoard*gateway: rsh.example.com\r
1937      XBoard*internetChessServerHost: chessclub.com\r
1938 </pre>
1939    <p>\r
1940 Then when you run XBoard in ICS mode, it will connect to\r
1941 the ICS by using <samp><span class="file">rsh</span></samp> to run the command\r
1942 &lsquo;<samp><span class="samp">telnet chessclub.com 5000</span></samp>&rsquo; on host &lsquo;<samp><span class="samp">rsh.example.com</span></samp>&rsquo;.\r
1943 \r
1944 Suppose that you can telnet anywhere you want, but you have to\r
1945 run a special program called <samp><span class="file">ptelnet</span></samp> to do so.\r
1946 \r
1947 First, we'll consider the easy case, in which\r
1948 &lsquo;<samp><span class="samp">ptelnet chessclub.com 5000</span></samp>&rsquo; gets you to the chess server.\r
1949 In this case set command line options as follows:\r
1950 \r
1951 <pre class="example">     xboard -ics -telnet -telnetProgram ptelnet\r
1952 </pre>
1953    <p>\r
1954 Or in your <samp><span class="file">.Xresources</span></samp> file:\r
1955 \r
1956 <pre class="example">     XBoard*useTelnet: true\r
1957      XBoard*telnetProgram: ptelnet\r
1958 </pre>
1959    <p>\r
1960 Then when you run XBoard in ICS mode, it will issue the\r
1961 command &lsquo;<samp><span class="samp">ptelnet chessclub.com 5000</span></samp>&rsquo; to connect to the ICS.\r
1962 \r
1963 Next, suppose that &lsquo;<samp><span class="samp">ptelnet chessclub.com 5000</span></samp>&rsquo; doesn't work;\r
1964 that is, your <samp><span class="file">ptelnet</span></samp> program doesn't let you connect to\r
1965 alternative ports. As noted above, your chess server may allow you to\r
1966 connect on port 23 instead.  In that case, just add the option\r
1967 &lsquo;<samp><span class="samp">-icsport ""</span></samp>&rsquo; to the above command, or add\r
1968 &lsquo;<samp><span class="samp">XBoard*internetChessServerPort:</span></samp>&rsquo; to your <samp><span class="file">.Xresources</span></samp> file.\r
1969 But if your chess server doesn't let you connect on port 23, you will have\r
1970 to find some other host outside the firewall and hop through it. For\r
1971 instance, suppose you have a shell account at &lsquo;<samp><span class="samp">foo.edu</span></samp>&rsquo;. Set\r
1972 command line options as follows:\r
1973 \r
1974 <pre class="example">     xboard -ics -telnet -telnetProgram ptelnet -icshost foo.edu -icsport ""\r
1975 </pre>
1976    <p>\r
1977 Or in your <samp><span class="file">.Xresources</span></samp> file:\r
1978 \r
1979 <pre class="example">     XBoard*useTelnet: true\r
1980      XBoard*telnetProgram: ptelnet\r
1981      XBoard*internetChessServerHost: foo.edu\r
1982      XBoard*internetChessServerPort:\r
1983 </pre>
1984    <p>\r
1985 Then when you run XBoard in ICS mode, it will issue the\r
1986 command &lsquo;<samp><span class="samp">ptelnet foo.edu</span></samp>&rsquo; to connect to your account at\r
1987 &lsquo;<samp><span class="samp">foo.edu</span></samp>&rsquo;. Log in there, then type &lsquo;<samp><span class="samp">telnet chessclub.com 5000</span></samp>&rsquo;.\r
1988 \r
1989 ICC timestamp and FICS timeseal do not work through some\r
1990 firewalls.  You can use them only if your firewall gives a clean TCP\r
1991 connection with a full 8-bit wide path.  If your firewall allows you\r
1992 to get out only by running a special telnet program, you can't use\r
1993 timestamp or timeseal across it.  But if you have access to a\r
1994 computer just outside your firewall, and you have much lower netlag\r
1995 when talking to that computer than to the ICS, it might be worthwhile\r
1996 running timestamp there.  Follow the instructions above for hopping\r
1997 through a host outside the firewall (foo.edu in the example),\r
1998 but run timestamp or timeseal on that host instead of telnet.\r
1999 \r
2000 Suppose that you have a SOCKS firewall that will give you a clean\r
2001 8-bit wide TCP connection to the chess server, but only after you\r
2002 authenticate yourself via the SOCKS protocol.  In that case, you could\r
2003 make a socksified version of XBoard and run that.  If you are using\r
2004 timestamp or timeseal, you will to socksify it, not XBoard; this may\r
2005 be difficult seeing that ICC and FICS do not provide source code for\r
2006 these programs.  Socksification is beyond the scope of this document,\r
2007 but see the SOCKS Web site at http://www.socks.permeo.com/.\r
2008 If you are missing SOCKS, try http://www.funbureau.com/.\r
2009 \r
2010 <div class="node">
2011 <p><hr>
2012 <a name="Environment"></a>
2013 Next:&nbsp;<a rel="next" accesskey="n" href="#Limitations">Limitations</a>,
2014 Previous:&nbsp;<a rel="previous" accesskey="p" href="#Firewalls">Firewalls</a>,
2015 Up:&nbsp;<a rel="up" accesskey="u" href="#Top">Top</a>
2016
2017 </div>
2018
2019 <h2 class="chapter">6 Environment variables</h2>
2020
2021 <p><a name="index-Environment-variables-392"></a><a name="index-CHESSDIR-393"></a>Game and position files are found in a directory named by the\r
2022 <code>CHESSDIR</code> environment variable. If this variable is not set, the\r
2023 current working directory is used. If <code>CHESSDIR</code> is set,\r
2024 XBoard actually changes its working directory to\r
2025 <code>$CHESSDIR</code>, so any files written by the chess engine\r
2026 will be placed there too.\r
2027 \r
2028 <div class="node">
2029 <p><hr>
2030 <a name="Limitations"></a>
2031 Next:&nbsp;<a rel="next" accesskey="n" href="#Problems">Problems</a>,
2032 Previous:&nbsp;<a rel="previous" accesskey="p" href="#Environment">Environment</a>,
2033 Up:&nbsp;<a rel="up" accesskey="u" href="#Top">Top</a>
2034
2035 </div>
2036
2037 <h2 class="chapter">7 Limitations and known bugs</h2>
2038
2039 <p><a name="index-Limitations-394"></a><a name="index-Bugs-395"></a>There is no way for two people running copies of XBoard to play\r
2040 each other without going through an Internet Chess Server.\r
2041 \r
2042 Under some circumstances, your ICS password may be echoed when you log on.\r
2043 \r
2044 If you are connecting to the ICS by running telnet on an Internet\r
2045 provider or firewall host, you may find that each line you type is\r
2046 echoed back an extra time after you hit &lt;Enter&gt;. If your Internet\r
2047 provider is a Unix system, you can probably turn its echo off by\r
2048 typing <kbd>stty -echo</kbd> after you log in, and/or typing\r
2049 &lt;^E&gt;&lt;Enter&gt; (Ctrl+E followed by the Enter key) to the telnet\r
2050 program after you have logged into ICS.  It is a good idea to do this\r
2051 if you can, because the extra echo can occasionally confuse XBoard's\r
2052 parsing routines.\r
2053 \r
2054 The game parser recognizes only algebraic notation.\r
2055 \r
2056 Many of the following points used to be limitations in XBoard 4.2.7 and earlier, \r
2057 but are now fixed:\r
2058 The internal move legality tester in XBoard 4.3.xx does look at the game history, \r
2059 and is fully aware of castling or en-passant-capture rights. It permits castling with \r
2060 the king on the d file because this is possible in some "wild 1" games on ICS. \r
2061 The piece-drop menu does not check piece drops in bughouse to see if you actually hold \r
2062 the piece you are trying to drop. But this way of dropping pieces should be considered \r
2063 an obsolete feature, now that pieces can be dropped by dragging them from the holdings \r
2064 to the board. Anyway, if you would attempt an illegal move when using a chess engine or the ICS, \r
2065 WinBoard will accept the error message that comes back, undo the move, and let you try another.\r
2066 FEN positions saved by XBoard do include correct information about whether castling or \r
2067 en passant are legal, and also handle the 50-move counter.\r
2068 The mate detector does not understand that non-contact mate is not really mate in bughouse. \r
2069 The only problem this causes while playing is minor: a "#" (mate indicator) character will \r
2070 show up after a non-contact mating move in the move list. XBoard will not assume the game \r
2071 is over at that point, not even when the option Detect Mates is on.\r
2072 Edit Game mode always uses the rules of the selected variant, \r
2073 which can be a variant that uses piece drops.  \r
2074 You can load and edit games that contain piece drops. \r
2075 The (obsolete) piece menus are not active, \r
2076 but you can perform piece drops by dragging pieces from the holdings.\r
2077 Edit Position mode does not allow you to edit the crazyhouse holdings properly. \r
2078 You cannot drag pieces to the holding, and using the popup menu to put pieces \r
2079 there does not adapt the holding counts and leads to an inconsistent state. \r
2080 Set up crazyhouse positions by loading / pasting a bFEN, from there you can set the holdings.\r
2081 Fischer Random castling is fully understood. \r
2082 You can enter castlings by dragging the King on top of your Rook. \r
2083 You can probably also play Fischer Random successfully on ICS by typing \r
2084 castling moves into the ICS Interaction window.\r
2085 \r
2086 The menus may not work if your keyboard is in Caps Lock or Num Lock mode.\r
2087 This seems to be a problem with the Athena menu widget,\r
2088 not an XBoard bug.\r
2089 \r
2090 Also see the ToDo file included with the distribution for many other\r
2091 possible bugs, limitations, and ideas for improvement that have been\r
2092 suggested.\r
2093 <div class="node">
2094 <p><hr>
2095 <a name="Problems"></a>
2096 Next:&nbsp;<a rel="next" accesskey="n" href="#Contributors">Contributors</a>,
2097 Previous:&nbsp;<a rel="previous" accesskey="p" href="#Limitations">Limitations</a>,
2098 Up:&nbsp;<a rel="up" accesskey="u" href="#Top">Top</a>
2099
2100 </div>
2101
2102 <h2 class="chapter">8 Reporting problems</h2>
2103
2104 <p><a name="index-Bugs-396"></a><a name="index-Bug-reports-397"></a><a name="index-Reporting-bugs-398"></a><a name="index-Problems-399"></a><a name="index-Reporting-problems-400"></a>\r
2105 Report bugs and problems with XBoard to <code>&lt;bug-xboard@gnu.org&gt;</code>.\r
2106 \r
2107 Please use the <samp><span class="file">script</span></samp> program to start a typescript, run \r
2108 XBoard with the &lsquo;<samp><span class="samp">-debug</span></samp>&rsquo; option, and include the typescript\r
2109 output in your message.\r
2110 Also tell us what kind of machine and what operating system version\r
2111 you are using.  The command &lsquo;<samp><span class="samp">uname -a</span></samp>&rsquo; will often tell you this.\r
2112 Here is a sample of approximately what you should type:\r
2113 \r
2114 <pre class="example">     script\r
2115      uname -a\r
2116      ./configure\r
2117      make\r
2118      ./xboard -debug\r
2119      exit\r
2120      mail bug-xboard@gnu.org\r
2121      Subject: Your short description of the problem\r
2122      Your detailed description of the problem\r
2123      ~r typescript\r
2124      .\r
2125 </pre>
2126    <p>\r
2127 The WinBoard / XBoard 4.3 line is being developed by H.G. Muller \r
2128 independently of the GNU Savannah xboard project. \r
2129 Bug reports on this version, and suggestions for improvements and additions, \r
2130 are best posted in the WinBoard forum, \r
2131 WinBoard-development section (http://www.open-aurec.com/wbforum). \r
2132 \r
2133 If you improve XBoard, please send a message about your changes,\r
2134 and we will get in touch with you about merging them in\r
2135 to the main line of development.\r
2136 Also see our Web site at http://savannah.gnu.org/projects/xboard/.\r
2137 \r
2138 <div class="node">
2139 <p><hr>
2140 <a name="Contributors"></a>
2141 Next:&nbsp;<a rel="next" accesskey="n" href="#CMail">CMail</a>,
2142 Previous:&nbsp;<a rel="previous" accesskey="p" href="#Problems">Problems</a>,
2143 Up:&nbsp;<a rel="up" accesskey="u" href="#Top">Top</a>
2144
2145 </div>
2146
2147 <h2 class="chapter">9 Authors and contributors</h2>
2148
2149 <p><a name="index-Authors-401"></a><a name="index-Contributors-402"></a>\r
2150 Tim Mann has been responsible for XBoard versions 1.3 and beyond, and\r
2151 for WinBoard, a port of XBoard to Microsoft Win32 (Windows NT and\r
2152 Windows 95). H.G.Muller is responsible for version 4.3.\r
2153 \r
2154 Mark Williams contributed the initial (WinBoard-only) implementation\r
2155 of many new features added to both XBoard and WinBoard in version\r
2156 4.1.0, including copy/paste, premove, icsAlarm, autoFlipView, training\r
2157 mode, auto raise, and blindfold.  Ben Nye contributed X copy/paste\r
2158 code for XBoard.\r
2159 \r
2160 Hugh Fisher added animated piece movement to XBoard, and Henrik Gram\r
2161 (henrikg@funcom.com) added it to WinBoard.  Frank McIngvale added\r
2162 click/click moving, the Analysis modes, piece flashing, ZIICS import,\r
2163 and ICS text colorization to XBoard.  Jochen Wiedmann ported XBoard to\r
2164 the Amiga, creating AmyBoard, and converted the documentation to\r
2165 texinfo.  Elmar Bartel contributed the new piece bitmaps introduced in\r
2166 version 3.2.  John Chanak contributed the initial implementation of\r
2167 ICS mode.  The color scheme and the old 80x80 piece bitmaps were taken\r
2168 from Wayne Christopher's <code>XChess</code> program.\r
2169 \r
2170 Chris Sears and Dan Sears wrote the original XBoard.  They were\r
2171 responsible for versions 1.0 through 1.2.\r
2172 \r
2173 Evan Welsh wrote <code>CMail</code>.  Patrick Surry helped in designing,\r
2174 testing, and documenting CMail.\r
2175 \r
2176 Allessandro Scotti added many elements to the user interface of WinBoard, \r
2177 including the board textures and font-based rendering, the evaluation-graph, \r
2178 move-history and engine-output window. \r
2179 He was also responsible for adding the UCI support. \r
2180 \r
2181 H.G. Muller made WinBoard castling- and e.p.-aware, \r
2182 added variant support with adjustable board sizes, \r
2183 the crazyhouse holdings, and the fairy pieces. \r
2184 In addition he added most of the adjudication options, \r
2185 made WinBoard more robust in dealing with buggy and crashing engines, \r
2186 and extended time control with a time-odds and node-count-based modes.\r
2187 Most of the options that initially wre WinBoard only have now been back-ported to XBoard.\r
2188 \r
2189 Michel van den Bergh provided the code for reading Polyglot opening books.\r
2190 \r
2191 Arun Persaud worked with H.G. Muller to combine all the features of the never-released WinBoard 4.2.8 \r
2192 of the Savannah project (mainly by Daniel Mehrmann), \r
2193 and the never-released 4.3.16 into a unified WinBoard 4.4, \r
2194 which is now available both from the Savannah web site and the WinBoard forum.\r
2195 <div class="node">
2196 <p><hr>
2197 <a name="CMail"></a>
2198 Next:&nbsp;<a rel="next" accesskey="n" href="#Other-programs">Other programs</a>,
2199 Previous:&nbsp;<a rel="previous" accesskey="p" href="#Contributors">Contributors</a>,
2200 Up:&nbsp;<a rel="up" accesskey="u" href="#Top">Top</a>
2201
2202 </div>
2203
2204 <h2 class="chapter">10 CMail</h2>
2205
2206 <p><a name="index-cmail-403"></a>The <samp><span class="file">cmail</span></samp> program can help you play chess by email with opponents of\r
2207 your choice using XBoard as an interface.\r
2208 \r
2209 You will usually run <samp><span class="file">cmail</span></samp> without giving any options.\r
2210 \r
2211
2212 <ul class="menu">
2213 <li><a accesskey="1" href="#CMail-options">CMail options</a>:     Invoking CMail.\r
2214 <li><a accesskey="2" href="#CMail-game">CMail game</a>:        Starting a CMail game.\r
2215 <li><a accesskey="3" href="#CMail-answer">CMail answer</a>:      Answering a move.\r
2216 <li><a accesskey="4" href="#CMail-multi">CMail multi</a>:       Multiple games in one message.\r
2217 <li><a accesskey="5" href="#CMail-completion">CMail completion</a>:  Completing a game.\r
2218 <li><a accesskey="6" href="#CMail-trouble">CMail trouble</a>:     Known CMail problems.\r
2219 </ul>
2220 \r
2221 <div class="node">
2222 <p><hr>
2223 <a name="CMail-options"></a>
2224 Next:&nbsp;<a rel="next" accesskey="n" href="#CMail-game">CMail game</a>,
2225 Up:&nbsp;<a rel="up" accesskey="u" href="#CMail">CMail</a>
2226
2227 </div>
2228
2229 <h3 class="section">10.1 CMail options</h3>
2230
2231      <dl>
2232 <dt>-h<dd>Displays <samp><span class="file">cmail</span></samp> usage information.\r
2233 <br><dt>-c<dd>Shows the conditions of the GNU General Public License.\r
2234 See <a href="#Copying">Copying</a>.\r
2235 <br><dt>-w<dd>Shows the warranty notice of the GNU General Public License.\r
2236 See <a href="#Copying">Copying</a>.\r
2237 <br><dt>-v<dt>-xv<dd>Provides or inhibits verbose output from <samp><span class="file">cmail</span></samp> and XBoard,\r
2238 useful for debugging. The\r
2239 <code>-xv</code>\r
2240 form also inhibits the cmail introduction message.\r
2241 <br><dt>-mail<dt>-xmail<dd>Invokes or inhibits the sending of a mail message containing the move.\r
2242 <br><dt>-xboard<dt>-xxboard<dd>Invokes or inhibits the running of XBoard on the game file.\r
2243 <br><dt>-reuse<dt>-xreuse<dd>Invokes or inhibits the reuse of an existing XBoard to display the\r
2244 current game.\r
2245 <br><dt>-remail<dd>Resends the last mail message for that game. This inhibits running\r
2246 XBoard.\r
2247 <br><dt>-game &lt;name&gt;<dd>The name of the game to be processed.\r
2248 <br><dt>-wgames &lt;number&gt;<dt>-bgames &lt;number&gt;<dt>-games &lt;number&gt;<dd>Number of games to start as White, as Black or in total. Default is 1 as\r
2249 white and none as black. If only one color is specified then none of the\r
2250 other color is assumed. If no color is specified then equal numbers of\r
2251 White and Black games are started, with the extra game being as White if an\r
2252 odd number of total games is specified.\r
2253 <br><dt>-me &lt;short name&gt;<dt>-opp &lt;short name&gt;<dd>A one-word alias for yourself or your opponent.\r
2254 <br><dt>-wname &lt;full name&gt;<dt>-bname &lt;full name&gt;<dt>-name &lt;full name&gt;<dt>-oppname &lt;full name&gt;<dd>The full name of White, Black, yourself or your opponent.\r
2255 <br><dt>-wna &lt;net address&gt;<dt>-bna &lt;net address&gt;<dt>-na &lt;net address&gt;<dt>-oppna &lt;net address&gt;<dd>The email address of White, Black, yourself or your opponent.\r
2256 <br><dt>-dir &lt;directory&gt;<dd>The directory in which <samp><span class="file">cmail</span></samp> keeps its files. This defaults to the\r
2257 environment variable <code>$CMAIL_DIR</code> or failing that, <code>$CHESSDIR</code>,\r
2258 <samp><span class="file">$HOME/Chess</span></samp> or <samp><span class="file">~/Chess</span></samp>. It will be created if it does not exist.\r
2259 <br><dt>-arcdir &lt;directory&gt;<dd>The directory in which <samp><span class="file">cmail</span></samp> archives completed games. Defaults to\r
2260 the environment variable <code>$CMAIL_ARCDIR</code> or, in its absence, the same\r
2261 directory as cmail keeps its working files (above).\r
2262 <br><dt>-mailprog &lt;mail program&gt;<dd>The program used by cmail to send email messages. This defaults to the\r
2263 environment variable <code>$CMAIL_MAILPROG</code> or failing that\r
2264 <samp><span class="file">/usr/ucb/Mail</span></samp>, <samp><span class="file">/usr/ucb/mail</span></samp> or <samp><span class="file">Mail</span></samp>. You will need\r
2265 to set this variable if none of the above paths fit your system.\r
2266 <br><dt>-gamesFile &lt;file&gt;<dd><a name="index-g_t_002ecmailgames-404"></a>A file containing a list of games with email addresses. This defaults to\r
2267 the environment variable <code>$CMAIL_GAMES</code> or failing that\r
2268 <samp><span class="file">.cmailgames</span></samp>.\r
2269 <br><dt>-aliasesFile &lt;file&gt;<dd><a name="index-g_t_002ecmailaliases-405"></a>A file containing one or more aliases for a set of email addresses. This\r
2270 defaults to the environment variable <code>$CMAIL_ALIASES</code> or failing\r
2271 that <samp><span class="file">.cmailaliases</span></samp>.\r
2272 <br><dt>-logFile &lt;file&gt;<dd>A file in which to dump verbose debugging messages that are invoked with\r
2273 the &lsquo;<samp><span class="samp">-v</span></samp>&rsquo;\r
2274 option.\r
2275 <br><dt>-event &lt;event&gt;<dd>The PGN Event tag (default &lsquo;<samp><span class="samp">Email correspondence game</span></samp>&rsquo;).\r
2276 <br><dt>-site &lt;site&gt;<dd>The PGN Site tag (default &lsquo;<samp><span class="samp">NET</span></samp>&rsquo;).\r
2277 <br><dt>-round &lt;round&gt;<dd>The PGN Round tag (default &lsquo;<samp><span class="samp">-</span></samp>&rsquo;, not applicable).\r
2278 <br><dt>-mode &lt;mode&gt;<dd>The PGN Mode tag (default &lsquo;<samp><span class="samp">EM</span></samp>&rsquo;, Electronic Mail).\r
2279 <br><dt>Other options<dd>Any option flags not listed above are passed through to XBoard.\r
2280 Invoking XBoard through CMail changes the default values of two XBoard\r
2281 options: The default value for &lsquo;<samp><span class="samp">-noChessProgram</span></samp>&rsquo; is changed to\r
2282 true; that is, by default no chess engine is started.  The default\r
2283 value for &lsquo;<samp><span class="samp">-timeDelay</span></samp>&rsquo; is changed to 0; that is, by default\r
2284 XBoard immediately goes to the end of the game as played so far,\r
2285 rather than stepping through the moves one by one.  You can still set\r
2286 these options to whatever values you prefer by supplying them on\r
2287 CMail's command line.  See <a href="#Options">Options</a>.\r
2288 </dl>
2289 \r
2290 <div class="node">
2291 <p><hr>
2292 <a name="CMail-game"></a>
2293 Next:&nbsp;<a rel="next" accesskey="n" href="#CMail-answer">CMail answer</a>,
2294 Previous:&nbsp;<a rel="previous" accesskey="p" href="#CMail-options">CMail options</a>,
2295 Up:&nbsp;<a rel="up" accesskey="u" href="#CMail">CMail</a>
2296
2297 </div>
2298
2299 <h3 class="section">10.2 Starting a CMail Game</h3>
2300
2301 <p>Type <samp><span class="file">cmail</span></samp> from a shell to start a game as white. After an opening\r
2302 message, you will be prompted for a game name, which is optional&mdash;if you\r
2303 simply press &lt;Enter&gt;, the game name will take the form\r
2304 &lsquo;<samp><span class="samp">you-VS-opponent</span></samp>&rsquo;. You will next be prompted for the short name\r
2305 of your opponent. If you haven't played this person before, you will also\r
2306 be prompted for his/her email address. <samp><span class="file">cmail</span></samp> will then invoke\r
2307 XBoard in the background. Make your first move and select\r
2308 &lsquo;<samp><span class="samp">Mail Move</span></samp>&rsquo; from the &lsquo;<samp><span class="samp">File</span></samp>&rsquo; menu. See <a href="#File-Menu">File Menu</a>. If all is well,\r
2309 <samp><span class="file">cmail</span></samp> will mail a copy of the move to your opponent. If you select\r
2310 &lsquo;<samp><span class="samp">Exit</span></samp>&rsquo; without having selected &lsquo;<samp><span class="samp">Mail Move</span></samp>&rsquo; then no move will be\r
2311 made.\r
2312 \r
2313 <div class="node">
2314 <p><hr>
2315 <a name="CMail-answer"></a>
2316 Next:&nbsp;<a rel="next" accesskey="n" href="#CMail-multi">CMail multi</a>,
2317 Previous:&nbsp;<a rel="previous" accesskey="p" href="#CMail-game">CMail game</a>,
2318 Up:&nbsp;<a rel="up" accesskey="u" href="#CMail">CMail</a>
2319
2320 </div>
2321
2322 <h3 class="section">10.3 Answering a Move</h3>
2323
2324 <p>When you receive a message from an opponent containing a move in one of\r
2325 your games, simply pipe the message through <samp><span class="file">cmail</span></samp>. In some mailers\r
2326 this is as simple as typing <kbd>| cmail</kbd> when viewing the message, while in\r
2327 others you may have to save the message to a file and do <kbd>cmail &lt; file</kbd>\r
2328 at the command line. In either case <samp><span class="file">cmail</span></samp> will display the game using\r
2329 XBoard. If you didn't exit XBoard when you made your first move\r
2330 then <samp><span class="file">cmail</span></samp> will do its best to use the existing XBoard instead\r
2331 of starting a new one. As before, simply make a move and select\r
2332 &lsquo;<samp><span class="samp">Mail Move</span></samp>&rsquo; from the &lsquo;<samp><span class="samp">File</span></samp>&rsquo; menu. See <a href="#File-Menu">File Menu</a>. <samp><span class="file">cmail</span></samp>\r
2333 will try to use the\r
2334 XBoard that was most recently used to display the current game. This\r
2335 means that many games can be in progress simultaneously, each with its own\r
2336 active XBoard.\r
2337 \r
2338 If you want to look at the history or explore a variation, go ahead, but\r
2339 you must return to the current position before XBoard will allow you\r
2340 to mail a move. If you edit the game's history you must select\r
2341 &lsquo;<samp><span class="samp">Reload Same Game</span></samp>&rsquo; from the &lsquo;<samp><span class="samp">File</span></samp>&rsquo; menu to get back to the original\r
2342 position, then make the move you want and select &lsquo;<samp><span class="samp">Mail Move</span></samp>&rsquo;.\r
2343 As before, if you decide you aren't ready to make a move just yet you can\r
2344 either select &lsquo;<samp><span class="samp">Exit</span></samp>&rsquo; without sending a move or just leave\r
2345 XBoard running until you are ready.\r
2346 \r
2347 <div class="node">
2348 <p><hr>
2349 <a name="CMail-multi"></a>
2350 Next:&nbsp;<a rel="next" accesskey="n" href="#CMail-completion">CMail completion</a>,
2351 Previous:&nbsp;<a rel="previous" accesskey="p" href="#CMail-answer">CMail answer</a>,
2352 Up:&nbsp;<a rel="up" accesskey="u" href="#CMail">CMail</a>
2353
2354 </div>
2355
2356 <h3 class="section">10.4 Multi-Game Messages</h3>
2357
2358 <p>\r
2359 It is possible to have a <samp><span class="file">cmail</span></samp> message carry more than one game.\r
2360 This feature was implemented to handle IECG (International Email Chess\r
2361 Group) matches, where a match consists of one game as white and one as black,\r
2362 with moves transmitted simultaneously. In case there are more general uses,\r
2363 <samp><span class="file">cmail</span></samp> itself places no limit on the number of black/white games\r
2364 contained in a message; however, XBoard does.\r
2365 \r
2366 <div class="node">
2367 <p><hr>
2368 <a name="CMail-completion"></a>
2369 Next:&nbsp;<a rel="next" accesskey="n" href="#CMail-trouble">CMail trouble</a>,
2370 Previous:&nbsp;<a rel="previous" accesskey="p" href="#CMail-multi">CMail multi</a>,
2371 Up:&nbsp;<a rel="up" accesskey="u" href="#CMail">CMail</a>
2372
2373 </div>
2374
2375 <h3 class="section">10.5 Completing a Game</h3>
2376
2377 <p>Because XBoard can detect checkmate and stalemate, <samp><span class="file">cmail</span></samp>\r
2378 handles game termination sensibly. As well as resignation, the\r
2379 &lsquo;<samp><span class="samp">Action</span></samp>&rsquo; menu allows draws to be offered and accepted for\r
2380 <samp><span class="file">cmail</span></samp> games.\r
2381 \r
2382 For multi-game messages, only unfinished and just-finished games will be\r
2383 included in email messages. When all the games are finished, they are\r
2384 archived in the user's archive directory, and similarly in the opponent's\r
2385 when he or she pipes the final message through <samp><span class="file">cmail</span></samp>. The archive\r
2386 file name includes the date the game was started.\r
2387 \r
2388 <div class="node">
2389 <p><hr>
2390 <a name="CMail-trouble"></a>
2391 Previous:&nbsp;<a rel="previous" accesskey="p" href="#CMail-completion">CMail completion</a>,
2392 Up:&nbsp;<a rel="up" accesskey="u" href="#CMail">CMail</a>
2393
2394 </div>
2395
2396 <h3 class="section">10.6 Known CMail Problems</h3>
2397
2398 <p>It's possible that a strange conjunction of conditions may occasionally\r
2399 mean that <samp><span class="file">cmail</span></samp> has trouble reactivating an existing\r
2400 XBoard. If this should happen, simply trying it again should work.\r
2401 If not, remove the file that stores the XBoard's PID\r
2402 (<samp><span class="file">game.pid</span></samp>) or use the &lsquo;<samp><span class="samp">-xreuse</span></samp>&rsquo; option to force\r
2403 <samp><span class="file">cmail</span></samp> to start a new XBoard.\r
2404 \r
2405 Versions of <samp><span class="file">cmail</span></samp> after 2.16 no longer understand the old file format\r
2406 that XBoard used to use and so cannot be used to correspond with\r
2407 anyone using an older version.\r
2408 \r
2409 Versions of <samp><span class="file">cmail</span></samp> older than 2.11 do not handle multi-game messages,\r
2410 so multi-game correspondence is not possible with opponents using an older\r
2411 version.\r
2412 \r
2413 <div class="node">
2414 <p><hr>
2415 <a name="Other-programs"></a>
2416 Next:&nbsp;<a rel="next" accesskey="n" href="#Copyright">Copyright</a>,
2417 Previous:&nbsp;<a rel="previous" accesskey="p" href="#CMail">CMail</a>,
2418 Up:&nbsp;<a rel="up" accesskey="u" href="#Top">Top</a>
2419
2420 </div>
2421
2422 <h2 class="chapter">11 Other programs you can use with XBoard</h2>
2423
2424 <p><a name="index-Other-programs-406"></a>\r
2425 Here are some other programs you can use with XBoard\r
2426 \r
2427
2428 <ul class="menu">
2429 <li><a accesskey="1" href="#GNU-Chess">GNU Chess</a>:         The GNU Chess engine.\r
2430 <li><a accesskey="2" href="#Fairy_002dMax">Fairy-Max</a>:         The Fairy-Max chess engine.\r
2431 <li><a accesskey="3" href="#HoiChess">HoiChess</a>:          The HoiChess chess engine.\r
2432 <li><a accesskey="4" href="#Crafty">Crafty</a>:            The Crafty chess engine.\r
2433 <li><a accesskey="5" href="#zic2xpm">zic2xpm</a>:           The program used to import chess sets from ZIICS.\r
2434 </ul>
2435 \r
2436 <div class="node">
2437 <p><hr>
2438 <a name="GNU-Chess"></a>
2439 Next:&nbsp;<a rel="next" accesskey="n" href="#Fairy_002dMax">Fairy-Max</a>,
2440 Up:&nbsp;<a rel="up" accesskey="u" href="#Other-programs">Other programs</a>
2441
2442 </div>
2443
2444 <h3 class="section">11.1 GNU Chess</h3>
2445
2446 <p>\r
2447 The GNU Chess engine is available from:\r
2448 \r
2449 ftp://ftp.gnu.org/gnu/gnuchess/\r
2450 \r
2451 You can use XBoard to play a game against GNU Chess, or to\r
2452 interface GNU Chess to an ICS.\r
2453 \r
2454 <div class="node">
2455 <p><hr>
2456 <a name="Fairy-Max"></a>
2457 <a name="Fairy_002dMax"></a>
2458 Next:&nbsp;<a rel="next" accesskey="n" href="#HoiChess">HoiChess</a>,
2459 Previous:&nbsp;<a rel="previous" accesskey="p" href="#GNU-Chess">GNU Chess</a>,
2460 Up:&nbsp;<a rel="up" accesskey="u" href="#Other-programs">Other programs</a>
2461
2462 </div>
2463
2464 <h3 class="section">11.2 Fairy-Max</h3>
2465
2466 <p>\r
2467 Fairy-Max is a derivative from the World's smallest Chess program micro-Max,\r
2468 which measures only about 100 lines of source code.\r
2469 The main difference with micro-Max is that Fairy-Max loads its move-generator\r
2470 tables from a file, so that the rules for piece movement can be easily configured\r
2471 to implement unorthodox pieces.\r
2472 Fairy-Max can therefore play a lage number of variants, normal Chess being one of those.\r
2473 In addition it plas Knightmate, Capablanca and Gothic Chess, Shatranj, Courier Chess,\r
2474 Cylinder chess, Berolina Chess, while the user can easily define new variants.\r
2475 It can be obtained from:\r
2476 \r
2477 http://home.hccnet.nl/h.g.muller/dwnldpage.html\r
2478 \r
2479 <div class="node">
2480 <p><hr>
2481 <a name="HoiChess"></a>
2482 Next:&nbsp;<a rel="next" accesskey="n" href="#Crafty">Crafty</a>,
2483 Previous:&nbsp;<a rel="previous" accesskey="p" href="#Fairy_002dMax">Fairy-Max</a>,
2484 Up:&nbsp;<a rel="up" accesskey="u" href="#Other-programs">Other programs</a>
2485
2486 </div>
2487
2488 <h3 class="section">11.3 HoiChess</h3>
2489
2490 <p>\r
2491 HoiChess is a not-so-very-strong Chess engine, which comes with a derivative HoiXiangqi,\r
2492 able to play Chinese Chess. It can be obtained from the standard Linux repositories\r
2493 through:\r
2494 \r
2495 sudo apt-get install hoichess\r
2496 \r
2497 <div class="node">
2498 <p><hr>
2499 <a name="Crafty"></a>
2500 Next:&nbsp;<a rel="next" accesskey="n" href="#zic2xpm">zic2xpm</a>,
2501 Previous:&nbsp;<a rel="previous" accesskey="p" href="#HoiChess">HoiChess</a>,
2502 Up:&nbsp;<a rel="up" accesskey="u" href="#Other-programs">Other programs</a>
2503
2504 </div>
2505
2506 <h3 class="section">11.4 Crafty</h3>
2507
2508 <p>\r
2509 Crafty is a chess engine written by Bob Hyatt.\r
2510 You can use XBoard to play a game against Crafty, hook Crafty up\r
2511 to an ICS, or use Crafty to interactively analyze games and positions\r
2512 for you.\r
2513 \r
2514 Crafty is a strong, rapidly evolving chess program. This rapid\r
2515 pace of development is good, because it means Crafty is always\r
2516 getting better.  This can sometimes cause problems with\r
2517 backwards compatibility, but usually the latest version of Crafty\r
2518 will work well with the latest version of XBoard.\r
2519 Crafty can be obtained from its author's FTP site:\r
2520 ftp://ftp.cis.uab.edu/hyatt/.\r
2521 \r
2522 To use Crafty with XBoard, give the -fcp and -fd options as follows, where\r
2523 &lt;crafty's directory&gt; is the directory in which you installed Crafty\r
2524 and placed its book and other support files.\r
2525 \r
2526 <div class="node">
2527 <p><hr>
2528 <a name="zic2xpm"></a>
2529 Previous:&nbsp;<a rel="previous" accesskey="p" href="#Crafty">Crafty</a>,
2530 Up:&nbsp;<a rel="up" accesskey="u" href="#Other-programs">Other programs</a>
2531
2532 </div>
2533
2534 <h3 class="section">11.5 zic2xpm</h3>
2535
2536 <p>\r
2537 The &ldquo;zic2xpm&rdquo; program is used to import chess sets from the ZIICS(*)\r
2538 program into XBoard. &ldquo;zic2xpm&rdquo; is part of the XBoard distribution.\r
2539 ZIICS is available from:\r
2540 \r
2541 ftp://ftp.freechess.org/pub/chess/DOS/ziics131.exe\r
2542 \r
2543 To import ZIICS pieces, do this:\r
2544      <dl>
2545 <dt>1. Unzip ziics131.exe into a directory:<dd>\r
2546      <pre class="example">          unzip -L ziics131.exe -d ~/ziics\r
2547 </pre>
2548      <br><dt>2. Use zic2xpm to convert a set of pieces to XBoard format.<dd>\r
2549 For example, let's say you want to use the\r
2550 FRITZ4 set. These files are named &ldquo;fritz4.*&rdquo; in the ZIICS distribution.\r
2551 \r
2552      <pre class="example">          mkdir ~/fritz4\r
2553           cd ~/fritz4\r
2554           zic2xpm ~/ziics/fritz4.*\r
2555 </pre>
2556      <br><dt>3. Give XBoard the &ldquo;-pixmap&rdquo; option when starting up, e.g.:<dd>\r
2557      <pre class="example">          xboard -pixmap ~/fritz4\r
2558 </pre>
2559      <p>\r
2560 Alternatively, you can add this line to your <samp><span class="file">.Xresources</span></samp> file:\r
2561 \r
2562      <pre class="example">          xboard*pixmapDirectory: ~/fritz4\r
2563 </pre>
2564      </dl>
2565    \r
2566 (*) ZIICS is a separate copyrighted work of Andy McFarland.\r
2567 The &ldquo;ZIICS pieces&rdquo; are copyrighted works of their respective\r
2568 creators. Files produced by &ldquo;zic2xpm&rdquo; are for PERSONAL USE ONLY\r
2569 and may NOT be redistributed without explicit permission from\r
2570 the original creator(s) of the pieces.\r
2571 \r
2572 <div class="node">
2573 <p><hr>
2574 <a name="Copyright"></a>
2575 Next:&nbsp;<a rel="next" accesskey="n" href="#Copying">Copying</a>,
2576 Previous:&nbsp;<a rel="previous" accesskey="p" href="#Other-programs">Other programs</a>,
2577 Up:&nbsp;<a rel="up" accesskey="u" href="#Top">Top</a>
2578
2579 </div>
2580
2581 <h2 class="unnumbered">Copyright</h2>
2582
2583 <p>Copyright &copy; 1991 Digital Equipment Corporation, Maynard, Massachusetts.
2584
2585    <p>All Rights Reserved.
2586
2587    <p>Permission to use, copy, modify, and distribute this software and its
2588 documentation for any purpose and without fee is hereby granted,
2589 provided that the above copyright notice appear in all copies and that
2590 both that copyright notice and this permission notice appear in
2591 supporting documentation, and that the name of Digital not be
2592 used in advertising or publicity pertaining to distribution of the
2593 software without specific, written prior permission.
2594
2595    <p>Digital disclaims all warranties with regard to this software, including
2596 all implied warranties of merchantability and fitness.  In no event shall
2597 Digital be liable for any special, indirect or consequential damages or
2598 any damages whatsoever resulting from loss of use, data or profits,
2599 whether in an action of contract, negligence or other tortious action,
2600 arising out of or in connection with the use or performance of this
2601 software.
2602
2603    <p>Enhancements copyright &copy;
2604 1992-2003,2004,2005,2006,2007,2008,2009 Free Software Foundation, Inc.
2605
2606 <pre class="format">Published by the Free Software Foundation
2607 59 Temple Place - Suite 330
2608 Boston, MA 02111-1307 USA
2609 </pre>
2610    <p>Permission is granted to make and distribute verbatim copies of
2611 this manual provided the copyright notice and this permission notice
2612 are preserved on all copies.
2613
2614    <p>Permission is granted to copy and distribute modified versions of this
2615 manual under the conditions for verbatim copying, provided also that the
2616 section entitled &ldquo;GNU General Public License,&rdquo;
2617 is included exactly as in the original, and provided that the entire
2618 resulting derived work is distributed under the terms of a permission
2619 notice identical to this one.
2620
2621    <p>Permission is granted to copy and distribute translations of this manual
2622 into another language, under the above conditions for modified versions,
2623 except that the section entitled &ldquo;GNU General Public License,&rdquo;
2624 and this permission notice, may be included in translations approved by
2625 the Free Software Foundation instead of in the original English. 
2626 \r
2627 <div class="node">
2628 <p><hr>
2629 <a name="Copying"></a>
2630 Next:&nbsp;<a rel="next" accesskey="n" href="#Index">Index</a>,
2631 Previous:&nbsp;<a rel="previous" accesskey="p" href="#Copyright">Copyright</a>,
2632 Up:&nbsp;<a rel="up" accesskey="u" href="#Top">Top</a>
2633
2634 </div>
2635
2636 <h2 class="unnumbered">GNU GENERAL PUBLIC LICENSE</h2>
2637
2638 <!-- The GNU General Public License. -->
2639 <div align="center">Version 3, 29 June 2007</div>
2640
2641 <!-- This file is intended to be included within another document, -->
2642 <!-- hence no sectioning command or @node. -->
2643 <pre class="display">     Copyright &copy; 2007 Free Software Foundation, Inc. <a href="http://fsf.org/">http://fsf.org/</a>
2644      
2645      Everyone is permitted to copy and distribute verbatim copies of this
2646      license document, but changing it is not allowed.
2647 </pre>
2648    <h3 class="heading">Preamble</h3>
2649
2650 <p>The GNU General Public License is a free, copyleft license for
2651 software and other kinds of works.
2652
2653    <p>The licenses for most software and other practical works are designed
2654 to take away your freedom to share and change the works.  By contrast,
2655 the GNU General Public License is intended to guarantee your freedom
2656 to share and change all versions of a program&mdash;to make sure it remains
2657 free software for all its users.  We, the Free Software Foundation,
2658 use the GNU General Public License for most of our software; it
2659 applies also to any other work released this way by its authors.  You
2660 can apply it to your programs, too.
2661
2662    <p>When we speak of free software, we are referring to freedom, not
2663 price.  Our General Public Licenses are designed to make sure that you
2664 have the freedom to distribute copies of free software (and charge for
2665 them if you wish), that you receive source code or can get it if you
2666 want it, that you can change the software or use pieces of it in new
2667 free programs, and that you know you can do these things.
2668
2669    <p>To protect your rights, we need to prevent others from denying you
2670 these rights or asking you to surrender the rights.  Therefore, you
2671 have certain responsibilities if you distribute copies of the
2672 software, or if you modify it: responsibilities to respect the freedom
2673 of others.
2674
2675    <p>For example, if you distribute copies of such a program, whether
2676 gratis or for a fee, you must pass on to the recipients the same
2677 freedoms that you received.  You must make sure that they, too,
2678 receive or can get the source code.  And you must show them these
2679 terms so they know their rights.
2680
2681    <p>Developers that use the GNU GPL protect your rights with two steps:
2682 (1) assert copyright on the software, and (2) offer you this License
2683 giving you legal permission to copy, distribute and/or modify it.
2684
2685    <p>For the developers' and authors' protection, the GPL clearly explains
2686 that there is no warranty for this free software.  For both users' and
2687 authors' sake, the GPL requires that modified versions be marked as
2688 changed, so that their problems will not be attributed erroneously to
2689 authors of previous versions.
2690
2691    <p>Some devices are designed to deny users access to install or run
2692 modified versions of the software inside them, although the
2693 manufacturer can do so.  This is fundamentally incompatible with the
2694 aim of protecting users' freedom to change the software.  The
2695 systematic pattern of such abuse occurs in the area of products for
2696 individuals to use, which is precisely where it is most unacceptable. 
2697 Therefore, we have designed this version of the GPL to prohibit the
2698 practice for those products.  If such problems arise substantially in
2699 other domains, we stand ready to extend this provision to those
2700 domains in future versions of the GPL, as needed to protect the
2701 freedom of users.
2702
2703    <p>Finally, every program is threatened constantly by software patents. 
2704 States should not allow patents to restrict development and use of
2705 software on general-purpose computers, but in those that do, we wish
2706 to avoid the special danger that patents applied to a free program
2707 could make it effectively proprietary.  To prevent this, the GPL
2708 assures that patents cannot be used to render the program non-free.
2709
2710    <p>The precise terms and conditions for copying, distribution and
2711 modification follow.
2712
2713 <h3 class="heading">TERMS AND CONDITIONS</h3>
2714
2715      <ol type=1 start=0>
2716 <li>Definitions.
2717
2718      <p>&ldquo;This License&rdquo; refers to version 3 of the GNU General Public License.
2719
2720      <p>&ldquo;Copyright&rdquo; also means copyright-like laws that apply to other kinds
2721 of works, such as semiconductor masks.
2722
2723      <p>&ldquo;The Program&rdquo; refers to any copyrightable work licensed under this
2724 License.  Each licensee is addressed as &ldquo;you&rdquo;.  &ldquo;Licensees&rdquo; and
2725 &ldquo;recipients&rdquo; may be individuals or organizations.
2726
2727      <p>To &ldquo;modify&rdquo; a work means to copy from or adapt all or part of the work
2728 in a fashion requiring copyright permission, other than the making of
2729 an exact copy.  The resulting work is called a &ldquo;modified version&rdquo; of
2730 the earlier work or a work &ldquo;based on&rdquo; the earlier work.
2731
2732      <p>A &ldquo;covered work&rdquo; means either the unmodified Program or a work based
2733 on the Program.
2734
2735      <p>To &ldquo;propagate&rdquo; a work means to do anything with it that, without
2736 permission, would make you directly or secondarily liable for
2737 infringement under applicable copyright law, except executing it on a
2738 computer or modifying a private copy.  Propagation includes copying,
2739 distribution (with or without modification), making available to the
2740 public, and in some countries other activities as well.
2741
2742      <p>To &ldquo;convey&rdquo; a work means any kind of propagation that enables other
2743 parties to make or receive copies.  Mere interaction with a user
2744 through a computer network, with no transfer of a copy, is not
2745 conveying.
2746
2747      <p>An interactive user interface displays &ldquo;Appropriate Legal Notices&rdquo; to
2748 the extent that it includes a convenient and prominently visible
2749 feature that (1) displays an appropriate copyright notice, and (2)
2750 tells the user that there is no warranty for the work (except to the
2751 extent that warranties are provided), that licensees may convey the
2752 work under this License, and how to view a copy of this License.  If
2753 the interface presents a list of user commands or options, such as a
2754 menu, a prominent item in the list meets this criterion.
2755
2756      <li>Source Code.
2757
2758      <p>The &ldquo;source code&rdquo; for a work means the preferred form of the work for
2759 making modifications to it.  &ldquo;Object code&rdquo; means any non-source form
2760 of a work.
2761
2762      <p>A &ldquo;Standard Interface&rdquo; means an interface that either is an official
2763 standard defined by a recognized standards body, or, in the case of
2764 interfaces specified for a particular programming language, one that
2765 is widely used among developers working in that language.
2766
2767      <p>The &ldquo;System Libraries&rdquo; of an executable work include anything, other
2768 than the work as a whole, that (a) is included in the normal form of
2769 packaging a Major Component, but which is not part of that Major
2770 Component, and (b) serves only to enable use of the work with that
2771 Major Component, or to implement a Standard Interface for which an
2772 implementation is available to the public in source code form.  A
2773 &ldquo;Major Component&rdquo;, in this context, means a major essential component
2774 (kernel, window system, and so on) of the specific operating system
2775 (if any) on which the executable work runs, or a compiler used to
2776 produce the work, or an object code interpreter used to run it.
2777
2778      <p>The &ldquo;Corresponding Source&rdquo; for a work in object code form means all
2779 the source code needed to generate, install, and (for an executable
2780 work) run the object code and to modify the work, including scripts to
2781 control those activities.  However, it does not include the work's
2782 System Libraries, or general-purpose tools or generally available free
2783 programs which are used unmodified in performing those activities but
2784 which are not part of the work.  For example, Corresponding Source
2785 includes interface definition files associated with source files for
2786 the work, and the source code for shared libraries and dynamically
2787 linked subprograms that the work is specifically designed to require,
2788 such as by intimate data communication or control flow between those
2789 subprograms and other parts of the work.
2790
2791      <p>The Corresponding Source need not include anything that users can
2792 regenerate automatically from other parts of the Corresponding Source.
2793
2794      <p>The Corresponding Source for a work in source code form is that same
2795 work.
2796
2797      <li>Basic Permissions.
2798
2799      <p>All rights granted under this License are granted for the term of
2800 copyright on the Program, and are irrevocable provided the stated
2801 conditions are met.  This License explicitly affirms your unlimited
2802 permission to run the unmodified Program.  The output from running a
2803 covered work is covered by this License only if the output, given its
2804 content, constitutes a covered work.  This License acknowledges your
2805 rights of fair use or other equivalent, as provided by copyright law.
2806
2807      <p>You may make, run and propagate covered works that you do not convey,
2808 without conditions so long as your license otherwise remains in force. 
2809 You may convey covered works to others for the sole purpose of having
2810 them make modifications exclusively for you, or provide you with
2811 facilities for running those works, provided that you comply with the
2812 terms of this License in conveying all material for which you do not
2813 control copyright.  Those thus making or running the covered works for
2814 you must do so exclusively on your behalf, under your direction and
2815 control, on terms that prohibit them from making any copies of your
2816 copyrighted material outside their relationship with you.
2817
2818      <p>Conveying under any other circumstances is permitted solely under the
2819 conditions stated below.  Sublicensing is not allowed; section 10
2820 makes it unnecessary.
2821
2822      <li>Protecting Users' Legal Rights From Anti-Circumvention Law.
2823
2824      <p>No covered work shall be deemed part of an effective technological
2825 measure under any applicable law fulfilling obligations under article
2826 11 of the WIPO copyright treaty adopted on 20 December 1996, or
2827 similar laws prohibiting or restricting circumvention of such
2828 measures.
2829
2830      <p>When you convey a covered work, you waive any legal power to forbid
2831 circumvention of technological measures to the extent such
2832 circumvention is effected by exercising rights under this License with
2833 respect to the covered work, and you disclaim any intention to limit
2834 operation or modification of the work as a means of enforcing, against
2835 the work's users, your or third parties' legal rights to forbid
2836 circumvention of technological measures.
2837
2838      <li>Conveying Verbatim Copies.
2839
2840      <p>You may convey verbatim copies of the Program's source code as you
2841 receive it, in any medium, provided that you conspicuously and
2842 appropriately publish on each copy an appropriate copyright notice;
2843 keep intact all notices stating that this License and any
2844 non-permissive terms added in accord with section 7 apply to the code;
2845 keep intact all notices of the absence of any warranty; and give all
2846 recipients a copy of this License along with the Program.
2847
2848      <p>You may charge any price or no price for each copy that you convey,
2849 and you may offer support or warranty protection for a fee.
2850
2851      <li>Conveying Modified Source Versions.
2852
2853      <p>You may convey a work based on the Program, or the modifications to
2854 produce it from the Program, in the form of source code under the
2855 terms of section 4, provided that you also meet all of these
2856 conditions:
2857
2858           <ol type=a start=1>
2859 <li>The work must carry prominent notices stating that you modified it,
2860 and giving a relevant date.
2861
2862           <li>The work must carry prominent notices stating that it is released
2863 under this License and any conditions added under section 7.  This
2864 requirement modifies the requirement in section 4 to &ldquo;keep intact all
2865 notices&rdquo;.
2866
2867           <li>You must license the entire work, as a whole, under this License to
2868 anyone who comes into possession of a copy.  This License will
2869 therefore apply, along with any applicable section 7 additional terms,
2870 to the whole of the work, and all its parts, regardless of how they
2871 are packaged.  This License gives no permission to license the work in
2872 any other way, but it does not invalidate such permission if you have
2873 separately received it.
2874
2875           <li>If the work has interactive user interfaces, each must display
2876 Appropriate Legal Notices; however, if the Program has interactive
2877 interfaces that do not display Appropriate Legal Notices, your work
2878 need not make them do so.
2879           </ol>
2880
2881      <p>A compilation of a covered work with other separate and independent
2882 works, which are not by their nature extensions of the covered work,
2883 and which are not combined with it such as to form a larger program,
2884 in or on a volume of a storage or distribution medium, is called an
2885 &ldquo;aggregate&rdquo; if the compilation and its resulting copyright are not
2886 used to limit the access or legal rights of the compilation's users
2887 beyond what the individual works permit.  Inclusion of a covered work
2888 in an aggregate does not cause this License to apply to the other
2889 parts of the aggregate.
2890
2891      <li>Conveying Non-Source Forms.
2892
2893      <p>You may convey a covered work in object code form under the terms of
2894 sections 4 and 5, provided that you also convey the machine-readable
2895 Corresponding Source under the terms of this License, in one of these
2896 ways:
2897
2898           <ol type=a start=1>
2899 <li>Convey the object code in, or embodied in, a physical product
2900 (including a physical distribution medium), accompanied by the
2901 Corresponding Source fixed on a durable physical medium customarily
2902 used for software interchange.
2903
2904           <li>Convey the object code in, or embodied in, a physical product
2905 (including a physical distribution medium), accompanied by a written
2906 offer, valid for at least three years and valid for as long as you
2907 offer spare parts or customer support for that product model, to give
2908 anyone who possesses the object code either (1) a copy of the
2909 Corresponding Source for all the software in the product that is
2910 covered by this License, on a durable physical medium customarily used
2911 for software interchange, for a price no more than your reasonable
2912 cost of physically performing this conveying of source, or (2) access
2913 to copy the Corresponding Source from a network server at no charge.
2914
2915           <li>Convey individual copies of the object code with a copy of the written
2916 offer to provide the Corresponding Source.  This alternative is
2917 allowed only occasionally and noncommercially, and only if you
2918 received the object code with such an offer, in accord with subsection
2919 6b.
2920
2921           <li>Convey the object code by offering access from a designated place
2922 (gratis or for a charge), and offer equivalent access to the
2923 Corresponding Source in the same way through the same place at no
2924 further charge.  You need not require recipients to copy the
2925 Corresponding Source along with the object code.  If the place to copy
2926 the object code is a network server, the Corresponding Source may be
2927 on a different server (operated by you or a third party) that supports
2928 equivalent copying facilities, provided you maintain clear directions
2929 next to the object code saying where to find the Corresponding Source. 
2930 Regardless of what server hosts the Corresponding Source, you remain
2931 obligated to ensure that it is available for as long as needed to
2932 satisfy these requirements.
2933
2934           <li>Convey the object code using peer-to-peer transmission, provided you
2935 inform other peers where the object code and Corresponding Source of
2936 the work are being offered to the general public at no charge under
2937 subsection 6d.
2938
2939           </ol>
2940
2941      <p>A separable portion of the object code, whose source code is excluded
2942 from the Corresponding Source as a System Library, need not be
2943 included in conveying the object code work.
2944
2945      <p>A &ldquo;User Product&rdquo; is either (1) a &ldquo;consumer product&rdquo;, which means any
2946 tangible personal property which is normally used for personal,
2947 family, or household purposes, or (2) anything designed or sold for
2948 incorporation into a dwelling.  In determining whether a product is a
2949 consumer product, doubtful cases shall be resolved in favor of
2950 coverage.  For a particular product received by a particular user,
2951 &ldquo;normally used&rdquo; refers to a typical or common use of that class of
2952 product, regardless of the status of the particular user or of the way
2953 in which the particular user actually uses, or expects or is expected
2954 to use, the product.  A product is a consumer product regardless of
2955 whether the product has substantial commercial, industrial or
2956 non-consumer uses, unless such uses represent the only significant
2957 mode of use of the product.
2958
2959      <p>&ldquo;Installation Information&rdquo; for a User Product means any methods,
2960 procedures, authorization keys, or other information required to
2961 install and execute modified versions of a covered work in that User
2962 Product from a modified version of its Corresponding Source.  The
2963 information must suffice to ensure that the continued functioning of
2964 the modified object code is in no case prevented or interfered with
2965 solely because modification has been made.
2966
2967      <p>If you convey an object code work under this section in, or with, or
2968 specifically for use in, a User Product, and the conveying occurs as
2969 part of a transaction in which the right of possession and use of the
2970 User Product is transferred to the recipient in perpetuity or for a
2971 fixed term (regardless of how the transaction is characterized), the
2972 Corresponding Source conveyed under this section must be accompanied
2973 by the Installation Information.  But this requirement does not apply
2974 if neither you nor any third party retains the ability to install
2975 modified object code on the User Product (for example, the work has
2976 been installed in ROM).
2977
2978      <p>The requirement to provide Installation Information does not include a
2979 requirement to continue to provide support service, warranty, or
2980 updates for a work that has been modified or installed by the
2981 recipient, or for the User Product in which it has been modified or
2982 installed.  Access to a network may be denied when the modification
2983 itself materially and adversely affects the operation of the network
2984 or violates the rules and protocols for communication across the
2985 network.
2986
2987      <p>Corresponding Source conveyed, and Installation Information provided,
2988 in accord with this section must be in a format that is publicly
2989 documented (and with an implementation available to the public in
2990 source code form), and must require no special password or key for
2991 unpacking, reading or copying.
2992
2993      <li>Additional Terms.
2994
2995      <p>&ldquo;Additional permissions&rdquo; are terms that supplement the terms of this
2996 License by making exceptions from one or more of its conditions. 
2997 Additional permissions that are applicable to the entire Program shall
2998 be treated as though they were included in this License, to the extent
2999 that they are valid under applicable law.  If additional permissions
3000 apply only to part of the Program, that part may be used separately
3001 under those permissions, but the entire Program remains governed by
3002 this License without regard to the additional permissions.
3003
3004      <p>When you convey a copy of a covered work, you may at your option
3005 remove any additional permissions from that copy, or from any part of
3006 it.  (Additional permissions may be written to require their own
3007 removal in certain cases when you modify the work.)  You may place
3008 additional permissions on material, added by you to a covered work,
3009 for which you have or can give appropriate copyright permission.
3010
3011      <p>Notwithstanding any other provision of this License, for material you
3012 add to a covered work, you may (if authorized by the copyright holders
3013 of that material) supplement the terms of this License with terms:
3014
3015           <ol type=a start=1>
3016 <li>Disclaiming warranty or limiting liability differently from the terms
3017 of sections 15 and 16 of this License; or
3018
3019           <li>Requiring preservation of specified reasonable legal notices or author
3020 attributions in that material or in the Appropriate Legal Notices
3021 displayed by works containing it; or
3022
3023           <li>Prohibiting misrepresentation of the origin of that material, or
3024 requiring that modified versions of such material be marked in
3025 reasonable ways as different from the original version; or
3026
3027           <li>Limiting the use for publicity purposes of names of licensors or
3028 authors of the material; or
3029
3030           <li>Declining to grant rights under trademark law for use of some trade
3031 names, trademarks, or service marks; or
3032
3033           <li>Requiring indemnification of licensors and authors of that material by
3034 anyone who conveys the material (or modified versions of it) with
3035 contractual assumptions of liability to the recipient, for any
3036 liability that these contractual assumptions directly impose on those
3037 licensors and authors.
3038           </ol>
3039
3040      <p>All other non-permissive additional terms are considered &ldquo;further
3041 restrictions&rdquo; within the meaning of section 10.  If the Program as you
3042 received it, or any part of it, contains a notice stating that it is
3043 governed by this License along with a term that is a further
3044 restriction, you may remove that term.  If a license document contains
3045 a further restriction but permits relicensing or conveying under this
3046 License, you may add to a covered work material governed by the terms
3047 of that license document, provided that the further restriction does
3048 not survive such relicensing or conveying.
3049
3050      <p>If you add terms to a covered work in accord with this section, you
3051 must place, in the relevant source files, a statement of the
3052 additional terms that apply to those files, or a notice indicating
3053 where to find the applicable terms.
3054
3055      <p>Additional terms, permissive or non-permissive, may be stated in the
3056 form of a separately written license, or stated as exceptions; the
3057 above requirements apply either way.
3058
3059      <li>Termination.
3060
3061      <p>You may not propagate or modify a covered work except as expressly
3062 provided under this License.  Any attempt otherwise to propagate or
3063 modify it is void, and will automatically terminate your rights under
3064 this License (including any patent licenses granted under the third
3065 paragraph of section 11).
3066
3067      <p>However, if you cease all violation of this License, then your license
3068 from a particular copyright holder is reinstated (a) provisionally,
3069 unless and until the copyright holder explicitly and finally
3070 terminates your license, and (b) permanently, if the copyright holder
3071 fails to notify you of the violation by some reasonable means prior to
3072 60 days after the cessation.
3073
3074      <p>Moreover, your license from a particular copyright holder is
3075 reinstated permanently if the copyright holder notifies you of the
3076 violation by some reasonable means, this is the first time you have
3077 received notice of violation of this License (for any work) from that
3078 copyright holder, and you cure the violation prior to 30 days after
3079 your receipt of the notice.
3080
3081      <p>Termination of your rights under this section does not terminate the
3082 licenses of parties who have received copies or rights from you under
3083 this License.  If your rights have been terminated and not permanently
3084 reinstated, you do not qualify to receive new licenses for the same
3085 material under section 10.
3086
3087      <li>Acceptance Not Required for Having Copies.
3088
3089      <p>You are not required to accept this License in order to receive or run
3090 a copy of the Program.  Ancillary propagation of a covered work
3091 occurring solely as a consequence of using peer-to-peer transmission
3092 to receive a copy likewise does not require acceptance.  However,
3093 nothing other than this License grants you permission to propagate or
3094 modify any covered work.  These actions infringe copyright if you do
3095 not accept this License.  Therefore, by modifying or propagating a
3096 covered work, you indicate your acceptance of this License to do so.
3097
3098      <li>Automatic Licensing of Downstream Recipients.
3099
3100      <p>Each time you convey a covered work, the recipient automatically
3101 receives a license from the original licensors, to run, modify and
3102 propagate that work, subject to this License.  You are not responsible
3103 for enforcing compliance by third parties with this License.
3104
3105      <p>An &ldquo;entity transaction&rdquo; is a transaction transferring control of an
3106 organization, or substantially all assets of one, or subdividing an
3107 organization, or merging organizations.  If propagation of a covered
3108 work results from an entity transaction, each party to that
3109 transaction who receives a copy of the work also receives whatever
3110 licenses to the work the party's predecessor in interest had or could
3111 give under the previous paragraph, plus a right to possession of the
3112 Corresponding Source of the work from the predecessor in interest, if
3113 the predecessor has it or can get it with reasonable efforts.
3114
3115      <p>You may not impose any further restrictions on the exercise of the
3116 rights granted or affirmed under this License.  For example, you may
3117 not impose a license fee, royalty, or other charge for exercise of
3118 rights granted under this License, and you may not initiate litigation
3119 (including a cross-claim or counterclaim in a lawsuit) alleging that
3120 any patent claim is infringed by making, using, selling, offering for
3121 sale, or importing the Program or any portion of it.
3122
3123      <li>Patents.
3124
3125      <p>A &ldquo;contributor&rdquo; is a copyright holder who authorizes use under this
3126 License of the Program or a work on which the Program is based.  The
3127 work thus licensed is called the contributor's &ldquo;contributor version&rdquo;.
3128
3129      <p>A contributor's &ldquo;essential patent claims&rdquo; are all patent claims owned
3130 or controlled by the contributor, whether already acquired or
3131 hereafter acquired, that would be infringed by some manner, permitted
3132 by this License, of making, using, or selling its contributor version,
3133 but do not include claims that would be infringed only as a
3134 consequence of further modification of the contributor version.  For
3135 purposes of this definition, &ldquo;control&rdquo; includes the right to grant
3136 patent sublicenses in a manner consistent with the requirements of
3137 this License.
3138
3139      <p>Each contributor grants you a non-exclusive, worldwide, royalty-free
3140 patent license under the contributor's essential patent claims, to
3141 make, use, sell, offer for sale, import and otherwise run, modify and
3142 propagate the contents of its contributor version.
3143
3144      <p>In the following three paragraphs, a &ldquo;patent license&rdquo; is any express
3145 agreement or commitment, however denominated, not to enforce a patent
3146 (such as an express permission to practice a patent or covenant not to
3147 sue for patent infringement).  To &ldquo;grant&rdquo; such a patent license to a
3148 party means to make such an agreement or commitment not to enforce a
3149 patent against the party.
3150
3151      <p>If you convey a covered work, knowingly relying on a patent license,
3152 and the Corresponding Source of the work is not available for anyone
3153 to copy, free of charge and under the terms of this License, through a
3154 publicly available network server or other readily accessible means,
3155 then you must either (1) cause the Corresponding Source to be so
3156 available, or (2) arrange to deprive yourself of the benefit of the
3157 patent license for this particular work, or (3) arrange, in a manner
3158 consistent with the requirements of this License, to extend the patent
3159 license to downstream recipients.  &ldquo;Knowingly relying&rdquo; means you have
3160 actual knowledge that, but for the patent license, your conveying the
3161 covered work in a country, or your recipient's use of the covered work
3162 in a country, would infringe one or more identifiable patents in that
3163 country that you have reason to believe are valid.
3164
3165      <p>If, pursuant to or in connection with a single transaction or
3166 arrangement, you convey, or propagate by procuring conveyance of, a
3167 covered work, and grant a patent license to some of the parties
3168 receiving the covered work authorizing them to use, propagate, modify
3169 or convey a specific copy of the covered work, then the patent license
3170 you grant is automatically extended to all recipients of the covered
3171 work and works based on it.
3172
3173      <p>A patent license is &ldquo;discriminatory&rdquo; if it does not include within the
3174 scope of its coverage, prohibits the exercise of, or is conditioned on
3175 the non-exercise of one or more of the rights that are specifically
3176 granted under this License.  You may not convey a covered work if you
3177 are a party to an arrangement with a third party that is in the
3178 business of distributing software, under which you make payment to the
3179 third party based on the extent of your activity of conveying the
3180 work, and under which the third party grants, to any of the parties
3181 who would receive the covered work from you, a discriminatory patent
3182 license (a) in connection with copies of the covered work conveyed by
3183 you (or copies made from those copies), or (b) primarily for and in
3184 connection with specific products or compilations that contain the
3185 covered work, unless you entered into that arrangement, or that patent
3186 license was granted, prior to 28 March 2007.
3187
3188      <p>Nothing in this License shall be construed as excluding or limiting
3189 any implied license or other defenses to infringement that may
3190 otherwise be available to you under applicable patent law.
3191
3192      <li>No Surrender of Others' Freedom.
3193
3194      <p>If conditions are imposed on you (whether by court order, agreement or
3195 otherwise) that contradict the conditions of this License, they do not
3196 excuse you from the conditions of this License.  If you cannot convey
3197 a covered work so as to satisfy simultaneously your obligations under
3198 this License and any other pertinent obligations, then as a
3199 consequence you may not convey it at all.  For example, if you agree
3200 to terms that obligate you to collect a royalty for further conveying
3201 from those to whom you convey the Program, the only way you could
3202 satisfy both those terms and this License would be to refrain entirely
3203 from conveying the Program.
3204
3205      <li>Use with the GNU Affero General Public License.
3206
3207      <p>Notwithstanding any other provision of this License, you have
3208 permission to link or combine any covered work with a work licensed
3209 under version 3 of the GNU Affero General Public License into a single
3210 combined work, and to convey the resulting work.  The terms of this
3211 License will continue to apply to the part which is the covered work,
3212 but the special requirements of the GNU Affero General Public License,
3213 section 13, concerning interaction through a network will apply to the
3214 combination as such.
3215
3216      <li>Revised Versions of this License.
3217
3218      <p>The Free Software Foundation may publish revised and/or new versions
3219 of the GNU General Public License from time to time.  Such new
3220 versions will be similar in spirit to the present version, but may
3221 differ in detail to address new problems or concerns.
3222
3223      <p>Each version is given a distinguishing version number.  If the Program
3224 specifies that a certain numbered version of the GNU General Public
3225 License &ldquo;or any later version&rdquo; applies to it, you have the option of
3226 following the terms and conditions either of that numbered version or
3227 of any later version published by the Free Software Foundation.  If
3228 the Program does not specify a version number of the GNU General
3229 Public License, you may choose any version ever published by the Free
3230 Software Foundation.
3231
3232      <p>If the Program specifies that a proxy can decide which future versions
3233 of the GNU General Public License can be used, that proxy's public
3234 statement of acceptance of a version permanently authorizes you to
3235 choose that version for the Program.
3236
3237      <p>Later license versions may give you additional or different
3238 permissions.  However, no additional obligations are imposed on any
3239 author or copyright holder as a result of your choosing to follow a
3240 later version.
3241
3242      <li>Disclaimer of Warranty.
3243
3244      <p>THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
3245 APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
3246 HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM &ldquo;AS IS&rdquo; WITHOUT
3247 WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT
3248 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
3249 A PARTICULAR PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND
3250 PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE PROGRAM PROVE
3251 DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR
3252 CORRECTION.
3253
3254      <li>Limitation of Liability.
3255
3256      <p>IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
3257 WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR
3258 CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
3259 INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES
3260 ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT
3261 NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR
3262 LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM
3263 TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER
3264 PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
3265
3266      <li>Interpretation of Sections 15 and 16.
3267
3268      <p>If the disclaimer of warranty and limitation of liability provided
3269 above cannot be given local legal effect according to their terms,
3270 reviewing courts shall apply local law that most closely approximates
3271 an absolute waiver of all civil liability in connection with the
3272 Program, unless a warranty or assumption of liability accompanies a
3273 copy of the Program in return for a fee.
3274
3275      </ol>
3276
3277 <h3 class="heading">END OF TERMS AND CONDITIONS</h3>
3278
3279 <h3 class="heading">How to Apply These Terms to Your New Programs</h3>
3280
3281 <p>If you develop a new program, and you want it to be of the greatest
3282 possible use to the public, the best way to achieve this is to make it
3283 free software which everyone can redistribute and change under these
3284 terms.
3285
3286    <p>To do so, attach the following notices to the program.  It is safest
3287 to attach them to the start of each source file to most effectively
3288 state the exclusion of warranty; and each file should have at least
3289 the &ldquo;copyright&rdquo; line and a pointer to where the full notice is found.
3290
3291 <pre class="smallexample">     <var>one line to give the program's name and a brief idea of what it does.</var>
3292      Copyright (C) <var>year</var> <var>name of author</var>
3293      
3294      This program is free software: you can redistribute it and/or modify
3295      it under the terms of the GNU General Public License as published by
3296      the Free Software Foundation, either version 3 of the License, or (at
3297      your option) any later version.
3298      
3299      This program is distributed in the hope that it will be useful, but
3300      WITHOUT ANY WARRANTY; without even the implied warranty of
3301      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
3302      General Public License for more details.
3303      
3304      You should have received a copy of the GNU General Public License
3305      along with this program.  If not, see <a href="http://www.gnu.org/licenses/">http://www.gnu.org/licenses/</a>.
3306 </pre>
3307    <p>Also add information on how to contact you by electronic and paper mail.
3308
3309    <p>If the program does terminal interaction, make it output a short
3310 notice like this when it starts in an interactive mode:
3311
3312 <pre class="smallexample">     <var>program</var> Copyright (C) <var>year</var> <var>name of author</var>
3313      This program comes with ABSOLUTELY NO WARRANTY; for details type &lsquo;<samp><span class="samp">show w</span></samp>&rsquo;.
3314      This is free software, and you are welcome to redistribute it
3315      under certain conditions; type &lsquo;<samp><span class="samp">show c</span></samp>&rsquo; for details.
3316 </pre>
3317    <p>The hypothetical commands &lsquo;<samp><span class="samp">show w</span></samp>&rsquo; and &lsquo;<samp><span class="samp">show c</span></samp>&rsquo; should show
3318 the appropriate parts of the General Public License.  Of course, your
3319 program's commands might be different; for a GUI interface, you would
3320 use an &ldquo;about box&rdquo;.
3321
3322    <p>You should also get your employer (if you work as a programmer) or school,
3323 if any, to sign a &ldquo;copyright disclaimer&rdquo; for the program, if necessary. 
3324 For more information on this, and how to apply and follow the GNU GPL, see
3325 <a href="http://www.gnu.org/licenses/">http://www.gnu.org/licenses/</a>.
3326
3327    <p>The GNU General Public License does not permit incorporating your
3328 program into proprietary programs.  If your program is a subroutine
3329 library, you may consider it more useful to permit linking proprietary
3330 applications with the library.  If this is what you want to do, use
3331 the GNU Lesser General Public License instead of this License.  But
3332 first, please read <a href="http://www.gnu.org/philosophy/why-not-lgpl.html">http://www.gnu.org/philosophy/why-not-lgpl.html</a>. 
3333 \r
3334 <!-- noman -->
3335 <div class="node">
3336 <p><hr>
3337 <a name="Index"></a>
3338 Previous:&nbsp;<a rel="previous" accesskey="p" href="#Copying">Copying</a>,
3339 Up:&nbsp;<a rel="up" accesskey="u" href="#Top">Top</a>
3340
3341 </div>
3342
3343 <h2 class="unnumbered">Index</h2>
3344
3345 <p>\r
3346
3347 <ul class="index-cp" compact>
3348 <li><a href="#index-g_t_002danimateSpeed_002c-option-343">-animateSpeed, option</a>: <a href="#User-interface-options">User interface options</a></li>
3349 <li><a href="#index-g_t_002ecmailaliases-405">.cmailaliases</a>: <a href="#CMail-options">CMail options</a></li>
3350 <li><a href="#index-g_t_002ecmailgames-404">.cmailgames</a>: <a href="#CMail-options">CMail options</a></li>
3351 <li><a href="#index-g_t_002eicsrc-207">.icsrc</a>: <a href="#ICS-options">ICS options</a></li>
3352 <li><a href="#index-g_t_003c_002c-Button-58">&lt;, Button</a>: <a href="#Step-Menu">Step Menu</a></li>
3353 <li><a href="#index-g_t_003c_003c_002c-Button-62">&lt;&lt;, Button</a>: <a href="#Step-Menu">Step Menu</a></li>
3354 <li><a href="#index-g_t_003e_002c-Button-60">&gt;, Button</a>: <a href="#Step-Menu">Step Menu</a></li>
3355 <li><a href="#index-g_t_003e_003e_002c-Button-64">&gt;&gt;, Button</a>: <a href="#Step-Menu">Step Menu</a></li>
3356 <li><a href="#index-abort_002c-ICS-command-385">abort, ICS command</a>: <a href="#Chess-Servers">Chess Servers</a></li>
3357 <li><a href="#index-Abort_002c-Menu-Item-51">Abort, Menu Item</a>: <a href="#Action-Menu">Action Menu</a></li>
3358 <li><a href="#index-About-XBoard_002c-Menu-Item-108">About XBoard, Menu Item</a>: <a href="#Help-Menu">Help Menu</a></li>
3359 <li><a href="#index-accept_002c-ICS-command-381">accept, ICS command</a>: <a href="#Chess-Servers">Chess Servers</a></li>
3360 <li><a href="#index-Accept_002c-Menu-Item-46">Accept, Menu Item</a>: <a href="#Action-Menu">Action Menu</a></li>
3361 <li><a href="#index-Action_002c-Menu-45">Action, Menu</a>: <a href="#Action-Menu">Action Menu</a></li>
3362 <li><a href="#index-adjourn_002c-ICS-command-384">adjourn, ICS command</a>: <a href="#Chess-Servers">Chess Servers</a></li>
3363 <li><a href="#index-Adjourn_002c-Menu-Item-50">Adjourn, Menu Item</a>: <a href="#Action-Menu">Action Menu</a></li>
3364 <li><a href="#index-Adjudicate-Draw_002c-Menu-Item-71">Adjudicate Draw, Menu Item</a>: <a href="#Step-Menu">Step Menu</a></li>
3365 <li><a href="#index-Adjudicate-to-Black_002c-Menu-Item-70">Adjudicate to Black, Menu Item</a>: <a href="#Step-Menu">Step Menu</a></li>
3366 <li><a href="#index-Adjudicate-to-White_002c-Menu-Item-69">Adjudicate to White, Menu Item</a>: <a href="#Step-Menu">Step Menu</a></li>
3367 <li><a href="#index-adjudicateDrawMoves_002c-option-346">adjudicateDrawMoves, option</a>: <a href="#Adjudication-Options">Adjudication Options</a></li>
3368 <li><a href="#index-adjudicateLossThreshold_002c-option-345">adjudicateLossThreshold, option</a>: <a href="#Adjudication-Options">Adjudication Options</a></li>
3369 <li><a href="#index-Adjudications_002c-Menu-Item-75">Adjudications, Menu Item</a>: <a href="#Options-Menu">Options Menu</a></li>
3370 <li><a href="#index-alarm_002c-option-220">alarm, option</a>: <a href="#ICS-options">ICS options</a></li>
3371 <li><a href="#index-Always-Queen_002c-Menu-Item-77">Always Queen, Menu Item</a>: <a href="#Options-Menu">Options Menu</a></li>
3372 <li><a href="#index-alwaysPromoteToQueen_002c-option-294">alwaysPromoteToQueen, option</a>: <a href="#User-interface-options">User interface options</a></li>
3373 <li><a href="#index-Analysis-Mode_002c-Menu-Item-31">Analysis Mode, Menu Item</a>: <a href="#Mode-Menu">Mode Menu</a></li>
3374 <li><a href="#index-Analyze-File_002c-Menu-Item-32">Analyze File, Menu Item</a>: <a href="#Mode-Menu">Mode Menu</a></li>
3375 <li><a href="#index-Animate-Dragging_002c-Menu-Item-78">Animate Dragging, Menu Item</a>: <a href="#Options-Menu">Options Menu</a></li>
3376 <li><a href="#index-Animate-Moving_002c-Menu-Item-79">Animate Moving, Menu Item</a>: <a href="#Options-Menu">Options Menu</a></li>
3377 <li><a href="#index-animate_002c-option-341">animate, option</a>: <a href="#User-interface-options">User interface options</a></li>
3378 <li><a href="#index-animateDragging_002c-option-340">animateDragging, option</a>: <a href="#User-interface-options">User interface options</a></li>
3379 <li><a href="#index-animateMoving_002c-option-342">animateMoving, option</a>: <a href="#User-interface-options">User interface options</a></li>
3380 <li><a href="#index-Authors-401">Authors</a>: <a href="#Contributors">Contributors</a></li>
3381 <li><a href="#index-Auto-Comment_002c-Menu-Item-80">Auto Comment, Menu Item</a>: <a href="#Options-Menu">Options Menu</a></li>
3382 <li><a href="#index-Auto-Flag_002c-Menu-Item-81">Auto Flag, Menu Item</a>: <a href="#Options-Menu">Options Menu</a></li>
3383 <li><a href="#index-Auto-Flip-View_002c-Menu-Item-82">Auto Flip View, Menu Item</a>: <a href="#Options-Menu">Options Menu</a></li>
3384 <li><a href="#index-Auto-Observe_002c-Menu-Item-83">Auto Observe, Menu Item</a>: <a href="#Options-Menu">Options Menu</a></li>
3385 <li><a href="#index-Auto-Raise-Board_002c-Menu-Item-84">Auto Raise Board, Menu Item</a>: <a href="#Options-Menu">Options Menu</a></li>
3386 <li><a href="#index-Auto-Save_002c-Menu-Item-85">Auto Save, Menu Item</a>: <a href="#Options-Menu">Options Menu</a></li>
3387 <li><a href="#index-autobs_002c-option-215">autobs, option</a>: <a href="#ICS-options">ICS options</a></li>
3388 <li><a href="#index-autoCallFlag_002c-option-214">autoCallFlag, option</a>: <a href="#ICS-options">ICS options</a></li>
3389 <li><a href="#index-autocomm_002c-option-211">autocomm, option</a>: <a href="#ICS-options">ICS options</a></li>
3390 <li><a href="#index-autoComment_002c-option-212">autoComment, option</a>: <a href="#ICS-options">ICS options</a></li>
3391 <li><a href="#index-autoflag_002c-option-213">autoflag, option</a>: <a href="#ICS-options">ICS options</a></li>
3392 <li><a href="#index-autoflip_002c-option-304">autoflip, option</a>: <a href="#User-interface-options">User interface options</a></li>
3393 <li><a href="#index-autoFlipView_002c-option-305">autoFlipView, option</a>: <a href="#User-interface-options">User interface options</a></li>
3394 <li><a href="#index-autoKibitz_002c-option-217">autoKibitz, option</a>: <a href="#ICS-options">ICS options</a></li>
3395 <li><a href="#index-autoObserve_002c-option-216">autoObserve, option</a>: <a href="#ICS-options">ICS options</a></li>
3396 <li><a href="#index-autoraise_002c-option-302">autoraise, option</a>: <a href="#User-interface-options">User interface options</a></li>
3397 <li><a href="#index-autoRaiseBoard_002c-option-303">autoRaiseBoard, option</a>: <a href="#User-interface-options">User interface options</a></li>
3398 <li><a href="#index-autosave_002c-option-266">autosave, option</a>: <a href="#Load-and-Save-options">Load and Save options</a></li>
3399 <li><a href="#index-autoSaveGames_002c-option-267">autoSaveGames, option</a>: <a href="#Load-and-Save-options">Load and Save options</a></li>
3400 <li><a href="#index-Back-to-Start_002c-Menu-Item-61">Back to Start, Menu Item</a>: <a href="#Step-Menu">Step Menu</a></li>
3401 <li><a href="#index-Backward_002c-Menu-Item-57">Backward, Menu Item</a>: <a href="#Step-Menu">Step Menu</a></li>
3402 <li><a href="#index-bell_002c-option-287">bell, option</a>: <a href="#User-interface-options">User interface options</a></li>
3403 <li><a href="#index-bitmapDirectory_002c-option-330">bitmapDirectory, option</a>: <a href="#User-interface-options">User interface options</a></li>
3404 <li><a href="#index-blackPieceColor_002c-option-335">blackPieceColor, option</a>: <a href="#User-interface-options">User interface options</a></li>
3405 <li><a href="#index-blind_002c-option-320">blind, option</a>: <a href="#User-interface-options">User interface options</a></li>
3406 <li><a href="#index-Blindfold_002c-Menu-Item-86">Blindfold, Menu Item</a>: <a href="#Options-Menu">Options Menu</a></li>
3407 <li><a href="#index-blindfold_002c-option-321">blindfold, option</a>: <a href="#User-interface-options">User interface options</a></li>
3408 <li><a href="#index-bm_002c-option-329">bm, option</a>: <a href="#User-interface-options">User interface options</a></li>
3409 <li><a href="#index-board-size-299">board size</a>: <a href="#User-interface-options">User interface options</a></li>
3410 <li><a href="#index-boardHeight_002c-option-358">boardHeight, option</a>: <a href="#Other-options">Other options</a></li>
3411 <li><a href="#index-boardSize_002c-option-298">boardSize, option</a>: <a href="#User-interface-options">User interface options</a></li>
3412 <li><a href="#index-boardWidth_002c-option-359">boardWidth, option</a>: <a href="#Other-options">Other options</a></li>
3413 <li><a href="#index-Book_002c-Menu-Item-107">Book, Menu Item</a>: <a href="#Help-Menu">Help Menu</a></li>
3414 <li><a href="#index-Bug-reports-397">Bug reports</a>: <a href="#Problems">Problems</a></li>
3415 <li><a href="#index-Bugs-396">Bugs</a>: <a href="#Problems">Problems</a></li>
3416 <li><a href="#index-Bugs-395">Bugs</a>: <a href="#Limitations">Limitations</a></li>
3417 <li><a href="#index-buttons_002c-option-310">buttons, option</a>: <a href="#User-interface-options">User interface options</a></li>
3418 <li><a href="#index-Call-Flag_002c-Menu-Item-48">Call Flag, Menu Item</a>: <a href="#Action-Menu">Action Menu</a></li>
3419 <li><a href="#index-checkMates_002c-option-347">checkMates, option</a>: <a href="#Adjudication-Options">Adjudication Options</a></li>
3420 <li><a href="#index-Chess-engine-options-114">Chess engine options</a>: <a href="#Chess-engine-options">Chess engine options</a></li>
3421 <li><a href="#index-CHESSDIR-393">CHESSDIR</a>: <a href="#Environment">Environment</a></li>
3422 <li><a href="#index-clock_002c-option-121">clock, option</a>: <a href="#Chess-engine-options">Chess engine options</a></li>
3423 <li><a href="#index-clockFont_002c-option-322">clockFont, option</a>: <a href="#User-interface-options">User interface options</a></li>
3424 <li><a href="#index-clockMode_002c-option-122">clockMode, option</a>: <a href="#Chess-engine-options">Chess engine options</a></li>
3425 <li><a href="#index-cmail-403">cmail</a>: <a href="#CMail">CMail</a></li>
3426 <li><a href="#index-colorChallenge_002c-option-236">colorChallenge, option</a>: <a href="#ICS-options">ICS options</a></li>
3427 <li><a href="#index-colorChannel_002c-option-233">colorChannel, option</a>: <a href="#ICS-options">ICS options</a></li>
3428 <li><a href="#index-colorChannel1_002c-option-232">colorChannel1, option</a>: <a href="#ICS-options">ICS options</a></li>
3429 <li><a href="#index-colorize_002c-option-228">colorize, option</a>: <a href="#ICS-options">ICS options</a></li>
3430 <li><a href="#index-colorKibitz_002c-option-234">colorKibitz, option</a>: <a href="#ICS-options">ICS options</a></li>
3431 <li><a href="#index-colorNormal_002c-option-239">colorNormal, option</a>: <a href="#ICS-options">ICS options</a></li>
3432 <li><a href="#index-colorRequest_002c-option-237">colorRequest, option</a>: <a href="#ICS-options">ICS options</a></li>
3433 <li><a href="#index-Colors-333">Colors</a>: <a href="#User-interface-options">User interface options</a></li>
3434 <li><a href="#index-Colors-227">Colors</a>: <a href="#ICS-options">ICS options</a></li>
3435 <li><a href="#index-colorSeek_002c-option-238">colorSeek, option</a>: <a href="#ICS-options">ICS options</a></li>
3436 <li><a href="#index-colorShout_002c-option-230">colorShout, option</a>: <a href="#ICS-options">ICS options</a></li>
3437 <li><a href="#index-colorSShout_002c-option-231">colorSShout, option</a>: <a href="#ICS-options">ICS options</a></li>
3438 <li><a href="#index-colorTell_002c-option-235">colorTell, option</a>: <a href="#ICS-options">ICS options</a></li>
3439 <li><a href="#index-Contributors-402">Contributors</a>: <a href="#Contributors">Contributors</a></li>
3440 <li><a href="#index-coordFont_002c-option-324">coordFont, option</a>: <a href="#User-interface-options">User interface options</a></li>
3441 <li><a href="#index-coords_002c-option-300">coords, option</a>: <a href="#User-interface-options">User interface options</a></li>
3442 <li><a href="#index-Copy-Game_002c-Menu-Item-14">Copy Game, Menu Item</a>: <a href="#File-Menu">File Menu</a></li>
3443 <li><a href="#index-Copy-Position_002c-Menu-Item-21">Copy Position, Menu Item</a>: <a href="#File-Menu">File Menu</a></li>
3444 <li><a href="#index-darkSquareColor_002c-option-337">darkSquareColor, option</a>: <a href="#User-interface-options">User interface options</a></li>
3445 <li><a href="#index-debug_002c-option-363">debug, option</a>: <a href="#Other-options">Other options</a></li>
3446 <li><a href="#index-debugFile_002c-option-365">debugFile, option</a>: <a href="#Other-options">Other options</a></li>
3447 <li><a href="#index-debugMode_002c-option-364">debugMode, option</a>: <a href="#Other-options">Other options</a></li>
3448 <li><a href="#index-decline_002c-ICS-command-382">decline, ICS command</a>: <a href="#Chess-Servers">Chess Servers</a></li>
3449 <li><a href="#index-Decline_002c-Menu-Item-47">Decline, Menu Item</a>: <a href="#Action-Menu">Action Menu</a></li>
3450 <li><a href="#index-defaultCacheSizeEGTB_002c-option-186">defaultCacheSizeEGTB, option</a>: <a href="#UCI-_002b-WB-Engine-Settings">UCI + WB Engine Settings</a></li>
3451 <li><a href="#index-defaultFrcPosition_002c-option-361">defaultFrcPosition, option</a>: <a href="#Other-options">Other options</a></li>
3452 <li><a href="#index-defaultHashSize_002c-option-185">defaultHashSize, option</a>: <a href="#UCI-_002b-WB-Engine-Settings">UCI + WB Engine Settings</a></li>
3453 <li><a href="#index-defaultPathEGTB_002c-option-187">defaultPathEGTB, option</a>: <a href="#UCI-_002b-WB-Engine-Settings">UCI + WB Engine Settings</a></li>
3454 <li><a href="#index-delayAfterQuit_002c-option-374">delayAfterQuit, option</a>: <a href="#Other-options">Other options</a></li>
3455 <li><a href="#index-delayBeforeQuit_002c-option-373">delayBeforeQuit, option</a>: <a href="#Other-options">Other options</a></li>
3456 <li><a href="#index-display_002c-option-282">display, option</a>: <a href="#User-interface-options">User interface options</a></li>
3457 <li><a href="#index-drag_002c-option-339">drag, option</a>: <a href="#User-interface-options">User interface options</a></li>
3458 <li><a href="#index-draw_002c-ICS-command-383">draw, ICS command</a>: <a href="#Chess-Servers">Chess Servers</a></li>
3459 <li><a href="#index-Draw_002c-Menu-Item-49">Draw, Menu Item</a>: <a href="#Action-Menu">Action Menu</a></li>
3460 <li><a href="#index-Edit-Comment_002c-Menu-Item-41">Edit Comment, Menu Item</a>: <a href="#Mode-Menu">Mode Menu</a></li>
3461 <li><a href="#index-Edit-Game_002c-Menu-Item-34">Edit Game, Menu Item</a>: <a href="#Mode-Menu">Mode Menu</a></li>
3462 <li><a href="#index-Edit-Position_002c-Menu-Item-35">Edit Position, Menu Item</a>: <a href="#Mode-Menu">Mode Menu</a></li>
3463 <li><a href="#index-Edit-Tags_002c-Menu-Item-40">Edit Tags, Menu Item</a>: <a href="#Mode-Menu">Mode Menu</a></li>
3464 <li><a href="#index-egtFormats_002c-option-188">egtFormats, option</a>: <a href="#UCI-_002b-WB-Engine-Settings">UCI + WB Engine Settings</a></li>
3465 <li><a href="#index-Engine-Settings-170">Engine Settings</a>: <a href="#UCI-_002b-WB-Engine-Settings">UCI + WB Engine Settings</a></li>
3466 <li><a href="#index-engineDebugOutput_002c-option-367">engineDebugOutput, option</a>: <a href="#Other-options">Other options</a></li>
3467 <li><a href="#index-Environment-variables-392">Environment variables</a>: <a href="#Environment">Environment</a></li>
3468 <li><a href="#index-examine_002c-ICS-command-390">examine, ICS command</a>: <a href="#Chess-Servers">Chess Servers</a></li>
3469 <li><a href="#index-Exit_002c-Menu-Item-25">Exit, Menu Item</a>: <a href="#File-Menu">File Menu</a></li>
3470 <li><a href="#index-exit_002c-option-289">exit, option</a>: <a href="#User-interface-options">User interface options</a></li>
3471 <li><a href="#index-fb_002c-option-145">fb, option</a>: <a href="#Chess-engine-options">Chess engine options</a></li>
3472 <li><a href="#index-fcp_002c-option-141">fcp, option</a>: <a href="#Chess-engine-options">Chess engine options</a></li>
3473 <li><a href="#index-fd_002c-option-151">fd, option</a>: <a href="#Chess-engine-options">Chess engine options</a></li>
3474 <li><a href="#index-fh_002c-option-147">fh, option</a>: <a href="#Chess-engine-options">Chess engine options</a></li>
3475 <li><a href="#index-File-Menu-4">File Menu</a>: <a href="#File-Menu">File Menu</a></li>
3476 <li><a href="#index-finger_002c-ICS-command-386">finger, ICS command</a>: <a href="#Chess-Servers">Chess Servers</a></li>
3477 <li><a href="#index-firstChessProgram_002c-option-142">firstChessProgram, option</a>: <a href="#Chess-engine-options">Chess engine options</a></li>
3478 <li><a href="#index-firstComputerString_002c-option-157">firstComputerString, option</a>: <a href="#Chess-engine-options">Chess engine options</a></li>
3479 <li><a href="#index-firstDirectory_002c-option-152">firstDirectory, option</a>: <a href="#Chess-engine-options">Chess engine options</a></li>
3480 <li><a href="#index-firstHasOwnBookUCI_002c-option-181">firstHasOwnBookUCI, option</a>: <a href="#UCI-_002b-WB-Engine-Settings">UCI + WB Engine Settings</a></li>
3481 <li><a href="#index-firstHost_002c-option-148">firstHost, option</a>: <a href="#Chess-engine-options">Chess engine options</a></li>
3482 <li><a href="#index-firstIsUCI_002c-option-174">firstIsUCI, option</a>: <a href="#UCI-_002b-WB-Engine-Settings">UCI + WB Engine Settings</a></li>
3483 <li><a href="#index-firstNPS_002c-option-127">firstNPS, option</a>: <a href="#Chess-engine-options">Chess engine options</a></li>
3484 <li><a href="#index-firstOptions-option-168">firstOptions option</a>: <a href="#Chess-engine-options">Chess engine options</a></li>
3485 <li><a href="#index-firstPlaysBlack_002c-option-146">firstPlaysBlack, option</a>: <a href="#Chess-engine-options">Chess engine options</a></li>
3486 <li><a href="#index-firstProtocolVersion_002c-option-163">firstProtocolVersion, option</a>: <a href="#Chess-engine-options">Chess engine options</a></li>
3487 <li><a href="#index-firstScoreAbs_002c-option-165">firstScoreAbs, option</a>: <a href="#Chess-engine-options">Chess engine options</a></li>
3488 <li><a href="#index-firstTimeOdds_002c-option-129">firstTimeOdds, option</a>: <a href="#Chess-engine-options">Chess engine options</a></li>
3489 <li><a href="#index-firstXBook_002c-option-183">firstXBook, option</a>: <a href="#UCI-_002b-WB-Engine-Settings">UCI + WB Engine Settings</a></li>
3490 <li><a href="#index-Flash-Moves_002c-Menu-Item-87">Flash Moves, Menu Item</a>: <a href="#Options-Menu">Options Menu</a></li>
3491 <li><a href="#index-flash_002c-option-316">flash, option</a>: <a href="#User-interface-options">User interface options</a></li>
3492 <li><a href="#index-flashCount_002c-option-314">flashCount, option</a>: <a href="#User-interface-options">User interface options</a></li>
3493 <li><a href="#index-flashRate_002c-option-315">flashRate, option</a>: <a href="#User-interface-options">User interface options</a></li>
3494 <li><a href="#index-Flip-View_002c-Menu-Item-74">Flip View, Menu Item</a>: <a href="#Options-Menu">Options Menu</a></li>
3495 <li><a href="#index-flip_002c-option-306">flip, option</a>: <a href="#User-interface-options">User interface options</a></li>
3496 <li><a href="#index-flipView_002c-option-307">flipView, option</a>: <a href="#User-interface-options">User interface options</a></li>
3497 <li><a href="#index-fNoOwnBookUCI_002c-option-179">fNoOwnBookUCI, option</a>: <a href="#UCI-_002b-WB-Engine-Settings">UCI + WB Engine Settings</a></li>
3498 <li><a href="#index-Font-327">Font</a>: <a href="#User-interface-options">User interface options</a></li>
3499 <li><a href="#index-Font_002c-clock-323">Font, clock</a>: <a href="#User-interface-options">User interface options</a></li>
3500 <li><a href="#index-Font_002c-coordinates-325">Font, coordinates</a>: <a href="#User-interface-options">User interface options</a></li>
3501 <li><a href="#index-font_002c-option-326">font, option</a>: <a href="#User-interface-options">User interface options</a></li>
3502 <li><a href="#index-fontSizeTolerance_002c-option-328">fontSizeTolerance, option</a>: <a href="#User-interface-options">User interface options</a></li>
3503 <li><a href="#index-Forward-to-End_002c-Menu-Item-63">Forward to End, Menu Item</a>: <a href="#Step-Menu">Step Menu</a></li>
3504 <li><a href="#index-Forward_002c-Menu-Item-59">Forward, Menu Item</a>: <a href="#Step-Menu">Step Menu</a></li>
3505 <li><a href="#index-fUCI_002c-option-172">fUCI, option</a>: <a href="#UCI-_002b-WB-Engine-Settings">UCI + WB Engine Settings</a></li>
3506 <li><a href="#index-gameListTags_002c-option-279">gameListTags, option</a>: <a href="#Load-and-Save-options">Load and Save options</a></li>
3507 <li><a href="#index-games_002c-ICS-command-380">games, ICS command</a>: <a href="#Chess-Servers">Chess Servers</a></li>
3508 <li><a href="#index-gateway_002c-option-202">gateway, option</a>: <a href="#ICS-options">ICS options</a></li>
3509 <li><a href="#index-geometry_002c-option-283">geometry, option</a>: <a href="#User-interface-options">User interface options</a></li>
3510 <li><a href="#index-Get-Move-List_002c-Menu-Item-88">Get Move List, Menu Item</a>: <a href="#Options-Menu">Options Menu</a></li>
3511 <li><a href="#index-getMoveList_002c-option-219">getMoveList, option</a>: <a href="#ICS-options">ICS options</a></li>
3512 <li><a href="#index-Help-Menu-103">Help Menu</a>: <a href="#Help-Menu">Help Menu</a></li>
3513 <li><a href="#index-help_002c-ICS-command-378">help, ICS command</a>: <a href="#Chess-Servers">Chess Servers</a></li>
3514 <li><a href="#index-Hide-Thinking_002c-Menu-Item-100">Hide Thinking, Menu Item</a>: <a href="#Options-Menu">Options Menu</a></li>
3515 <li><a href="#index-Highlight-Last-Move_002c-Menu-Item-89">Highlight Last Move, Menu Item</a>: <a href="#Options-Menu">Options Menu</a></li>
3516 <li><a href="#index-highlight_002c-option-318">highlight, option</a>: <a href="#User-interface-options">User interface options</a></li>
3517 <li><a href="#index-highlightLastMove_002c-option-319">highlightLastMove, option</a>: <a href="#User-interface-options">User interface options</a></li>
3518 <li><a href="#index-highlightSquareColor_002c-option-338">highlightSquareColor, option</a>: <a href="#User-interface-options">User interface options</a></li>
3519 <li><a href="#index-Hint_002c-Menu-Item-106">Hint, Menu Item</a>: <a href="#Help-Menu">Help Menu</a></li>
3520 <li><a href="#index-holdingsSize_002c-option-360">holdingsSize, option</a>: <a href="#Other-options">Other options</a></li>
3521 <li><a href="#index-iconic_002c-option-284">iconic, option</a>: <a href="#User-interface-options">User interface options</a></li>
3522 <li><a href="#index-ICS-375">ICS</a>: <a href="#Chess-Servers">Chess Servers</a></li>
3523 <li><a href="#index-ICS-Alarm_002c-Menu-Item-91">ICS Alarm, Menu Item</a>: <a href="#Options-Menu">Options Menu</a></li>
3524 <li><a href="#index-ICS-Client_002c-Menu-Item-33">ICS Client, Menu Item</a>: <a href="#Mode-Menu">Mode Menu</a></li>
3525 <li><a href="#index-ICS-Input-Box_002c-Menu-Item-42">ICS Input Box, Menu Item</a>: <a href="#Mode-Menu">Mode Menu</a></li>
3526 <li><a href="#index-ICS-options-189">ICS options</a>: <a href="#ICS-options">ICS options</a></li>
3527 <li><a href="#index-ICS_002c-addresses-376">ICS, addresses</a>: <a href="#Chess-Servers">Chess Servers</a></li>
3528 <li><a href="#index-ics_002c-option-191">ics, option</a>: <a href="#ICS-options">ICS options</a></li>
3529 <li><a href="#index-icsAlarm_002c-option-221">icsAlarm, option</a>: <a href="#ICS-options">ICS options</a></li>
3530 <li><a href="#index-icsAlarmTime_002c-option-222">icsAlarmTime, option</a>: <a href="#ICS-options">ICS options</a></li>
3531 <li><a href="#index-icscomm_002c-option-204">icscomm, option</a>: <a href="#ICS-options">ICS options</a></li>
3532 <li><a href="#index-icshelper_002c-option-197">icshelper, option</a>: <a href="#ICS-options">ICS options</a></li>
3533 <li><a href="#index-icshost_002c-option-193">icshost, option</a>: <a href="#ICS-options">ICS options</a></li>
3534 <li><a href="#index-icsinput_002c-option-209">icsinput, option</a>: <a href="#ICS-options">ICS options</a></li>
3535 <li><a href="#index-icslogon_002c-option-205">icslogon, option</a>: <a href="#ICS-options">ICS options</a></li>
3536 <li><a href="#index-icsport_002c-option-195">icsport, option</a>: <a href="#ICS-options">ICS options</a></li>
3537 <li><a href="#index-inc_002c-option-119">inc, option</a>: <a href="#Chess-engine-options">Chess engine options</a></li>
3538 <li><a href="#index-Info-XBoard_002c-Menu-Item-104">Info XBoard, Menu Item</a>: <a href="#Help-Menu">Help Menu</a></li>
3539 <li><a href="#index-initalMode_002c-option-356">initalMode, option</a>: <a href="#Other-options">Other options</a></li>
3540 <li><a href="#index-initString_002c-option-155">initString, option</a>: <a href="#Chess-engine-options">Chess engine options</a></li>
3541 <li><a href="#index-Internet-Chess-Server-377">Internet Chess Server</a>: <a href="#Chess-Servers">Chess Servers</a></li>
3542 <li><a href="#index-internetChessServerCommPort_002c-option-203">internetChessServerCommPort, option</a>: <a href="#ICS-options">ICS options</a></li>
3543 <li><a href="#index-internetChessServerHelper_002c-option-198">internetChessServerHelper, option</a>: <a href="#ICS-options">ICS options</a></li>
3544 <li><a href="#index-internetChessServerHost_002c-option-194">internetChessServerHost, option</a>: <a href="#ICS-options">ICS options</a></li>
3545 <li><a href="#index-internetChessServerInputBox_002c-option-210">internetChessServerInputBox, option</a>: <a href="#ICS-options">ICS options</a></li>
3546 <li><a href="#index-internetChessServerLogonScript_002c-option-206">internetChessServerLogonScript, option</a>: <a href="#ICS-options">ICS options</a></li>
3547 <li><a href="#index-internetChessServerMode_002c-option-192">internetChessServerMode, option</a>: <a href="#ICS-options">ICS options</a></li>
3548 <li><a href="#index-internetChessServerPort_002c-option-196">internetChessServerPort, option</a>: <a href="#ICS-options">ICS options</a></li>
3549 <li><a href="#index-introduction-1">introduction</a>: <a href="#Top">Top</a></li>
3550 <li><a href="#index-Keys-109">Keys</a>: <a href="#Keys">Keys</a></li>
3551 <li><a href="#index-legal_002c-option-295">legal, option</a>: <a href="#User-interface-options">User interface options</a></li>
3552 <li><a href="#index-lgf_002c-option-258">lgf, option</a>: <a href="#Load-and-Save-options">Load and Save options</a></li>
3553 <li><a href="#index-lgi_002c-option-260">lgi, option</a>: <a href="#Load-and-Save-options">Load and Save options</a></li>
3554 <li><a href="#index-lightSquareColor_002c-option-336">lightSquareColor, option</a>: <a href="#User-interface-options">User interface options</a></li>
3555 <li><a href="#index-Limitations-394">Limitations</a>: <a href="#Limitations">Limitations</a></li>
3556 <li><a href="#index-Load-and-Save-options-257">Load and Save options</a>: <a href="#Load-and-Save-options">Load and Save options</a></li>
3557 <li><a href="#index-Load-Game_002c-Menu-Item-9">Load Game, Menu Item</a>: <a href="#File-Menu">File Menu</a></li>
3558 <li><a href="#index-Load-Next-Game_002c-Menu-Item-10">Load Next Game, Menu Item</a>: <a href="#File-Menu">File Menu</a></li>
3559 <li><a href="#index-Load-Next-Position_002c-Menu-Item-17">Load Next Position, Menu Item</a>: <a href="#File-Menu">File Menu</a></li>
3560 <li><a href="#index-Load-Position_002c-Menu-Item-16">Load Position, Menu Item</a>: <a href="#File-Menu">File Menu</a></li>
3561 <li><a href="#index-Load-Previous-Game_002c-Menu-Item-11">Load Previous Game, Menu Item</a>: <a href="#File-Menu">File Menu</a></li>
3562 <li><a href="#index-Load-Previous-Position_002c-Menu-Item-18">Load Previous Position, Menu Item</a>: <a href="#File-Menu">File Menu</a></li>
3563 <li><a href="#index-loadGameFile_002c-option-259">loadGameFile, option</a>: <a href="#Load-and-Save-options">Load and Save options</a></li>
3564 <li><a href="#index-loadGameIndex_002c-option-261">loadGameIndex, option</a>: <a href="#Load-and-Save-options">Load and Save options</a></li>
3565 <li><a href="#index-loadPositionFile_002c-option-269">loadPositionFile, option</a>: <a href="#Load-and-Save-options">Load and Save options</a></li>
3566 <li><a href="#index-loadPositionIndex_002c-option-271">loadPositionIndex, option</a>: <a href="#Load-and-Save-options">Load and Save options</a></li>
3567 <li><a href="#index-lpf_002c-option-268">lpf, option</a>: <a href="#Load-and-Save-options">Load and Save options</a></li>
3568 <li><a href="#index-lpi_002c-option-270">lpi, option</a>: <a href="#Load-and-Save-options">Load and Save options</a></li>
3569 <li><a href="#index-Machine-Black_002c-Menu-Item-29">Machine Black, Menu Item</a>: <a href="#Mode-Menu">Mode Menu</a></li>
3570 <li><a href="#index-Machine-White_002c-Menu-Item-28">Machine White, Menu Item</a>: <a href="#Mode-Menu">Mode Menu</a></li>
3571 <li><a href="#index-Mail-Move_002c-Menu-Item-23">Mail Move, Menu Item</a>: <a href="#File-Menu">File Menu</a></li>
3572 <li><a href="#index-Major-modes-2">Major modes</a>: <a href="#Major-modes">Major modes</a></li>
3573 <li><a href="#index-Man-XBoard_002c-Menu-Item-105">Man XBoard, Menu Item</a>: <a href="#Help-Menu">Help Menu</a></li>
3574 <li><a href="#index-matchGames_002c-option-137">matchGames, option</a>: <a href="#Chess-engine-options">Chess engine options</a></li>
3575 <li><a href="#index-matchMode_002c-option-139">matchMode, option</a>: <a href="#Chess-engine-options">Chess engine options</a></li>
3576 <li><a href="#index-materialDraws_002c-option-349">materialDraws, option</a>: <a href="#Adjudication-Options">Adjudication Options</a></li>
3577 <li><a href="#index-Menu_002c-Action-44">Menu, Action</a>: <a href="#Action-Menu">Action Menu</a></li>
3578 <li><a href="#index-Menu_002c-File-5">Menu, File</a>: <a href="#File-Menu">File Menu</a></li>
3579 <li><a href="#index-Menu_002c-Help-102">Menu, Help</a>: <a href="#Help-Menu">Help Menu</a></li>
3580 <li><a href="#index-Menu_002c-Mode-26">Menu, Mode</a>: <a href="#Mode-Menu">Mode Menu</a></li>
3581 <li><a href="#index-Menu_002c-Options-72">Menu, Options</a>: <a href="#Options-Menu">Options Menu</a></li>
3582 <li><a href="#index-Menu_002c-Step-56">Menu, Step</a>: <a href="#Step-Menu">Step Menu</a></li>
3583 <li><a href="#index-Menus-3">Menus</a>: <a href="#Menus">Menus</a></li>
3584 <li><a href="#index-mg_002c-option-136">mg, option</a>: <a href="#Chess-engine-options">Chess engine options</a></li>
3585 <li><a href="#index-mm_002c-option-138">mm, option</a>: <a href="#Chess-engine-options">Chess engine options</a></li>
3586 <li><a href="#index-Mode-Menu-27">Mode Menu</a>: <a href="#Mode-Menu">Mode Menu</a></li>
3587 <li><a href="#index-mode_002c-option-355">mode, option</a>: <a href="#Other-options">Other options</a></li>
3588 <li><a href="#index-mono_002c-option-312">mono, option</a>: <a href="#User-interface-options">User interface options</a></li>
3589 <li><a href="#index-monoMode_002c-option-313">monoMode, option</a>: <a href="#User-interface-options">User interface options</a></li>
3590 <li><a href="#index-Move-Now_002c-Menu-Item-67">Move Now, Menu Item</a>: <a href="#Step-Menu">Step Menu</a></li>
3591 <li><a href="#index-Move-Sound_002c-Menu-Item-90">Move Sound, Menu Item</a>: <a href="#Options-Menu">Options Menu</a></li>
3592 <li><a href="#index-moves_002c-option-218">moves, option</a>: <a href="#ICS-options">ICS options</a></li>
3593 <li><a href="#index-movesound_002c-option-286">movesound, option</a>: <a href="#User-interface-options">User interface options</a></li>
3594 <li><a href="#index-movesPerSession_002c-option-118">movesPerSession, option</a>: <a href="#Chess-engine-options">Chess engine options</a></li>
3595 <li><a href="#index-mps_002c-option-117">mps, option</a>: <a href="#Chess-engine-options">Chess engine options</a></li>
3596 <li><a href="#index-msLoginDelay_002c-option-208">msLoginDelay, option</a>: <a href="#ICS-options">ICS options</a></li>
3597 <li><a href="#index-nameOfDebugFile_002c-option-366">nameOfDebugFile, option</a>: <a href="#Other-options">Other options</a></li>
3598 <li><a href="#index-ncp_002c-option-353">ncp, option</a>: <a href="#Other-options">Other options</a></li>
3599 <li><a href="#index-New-Game_002c-Menu-Item-6">New Game, Menu Item</a>: <a href="#File-Menu">File Menu</a></li>
3600 <li><a href="#index-New-Shuffle-Game_002c-Menu-Item-7">New Shuffle Game, Menu Item</a>: <a href="#File-Menu">File Menu</a></li>
3601 <li><a href="#index-New-variant_002c-Menu-Item-8">New variant, Menu Item</a>: <a href="#File-Menu">File Menu</a></li>
3602 <li><a href="#index-niceEngines_002c-option-167">niceEngines, option</a>: <a href="#Chess-engine-options">Chess engine options</a></li>
3603 <li><a href="#index-noChessProgram_002c-option-354">noChessProgram, option</a>: <a href="#Other-options">Other options</a></li>
3604 <li><a href="#index-noGUI_002c-option-285">noGUI, option</a>: <a href="#User-interface-options">User interface options</a></li>
3605 <li><a href="#index-observe_002c-ICS-command-389">observe, ICS command</a>: <a href="#Chess-Servers">Chess Servers</a></li>
3606 <li><a href="#index-Old-Save-Style_002c-Menu-Item-92">Old Save Style, Menu Item</a>: <a href="#Options-Menu">Options Menu</a></li>
3607 <li><a href="#index-oldmoves_002c-ICS-command-391">oldmoves, ICS command</a>: <a href="#Chess-Servers">Chess Servers</a></li>
3608 <li><a href="#index-oldsave_002c-option-277">oldsave, option</a>: <a href="#Load-and-Save-options">Load and Save options</a></li>
3609 <li><a href="#index-oldSaveStyle_002c-option-278">oldSaveStyle, option</a>: <a href="#Load-and-Save-options">Load and Save options</a></li>
3610 <li><a href="#index-Options-111">Options</a>: <a href="#Options">Options</a></li>
3611 <li><a href="#index-Options-Menu-73">Options Menu</a>: <a href="#Options-Menu">Options Menu</a></li>
3612 <li><a href="#index-Options_002c-adjudication-344">Options, adjudication</a>: <a href="#Adjudication-Options">Adjudication Options</a></li>
3613 <li><a href="#index-options_002c-Chess-engine-113">options, Chess engine</a>: <a href="#Chess-engine-options">Chess engine options</a></li>
3614 <li><a href="#index-Options_002c-ICS-190">Options, ICS</a>: <a href="#ICS-options">ICS options</a></li>
3615 <li><a href="#index-Options_002c-Load-and-Save-256">Options, Load and Save</a>: <a href="#Load-and-Save-options">Load and Save options</a></li>
3616 <li><a href="#index-Options_002c-miscellaneous-352">Options, miscellaneous</a>: <a href="#Other-options">Other options</a></li>
3617 <li><a href="#index-Options_002c-User-interface-281">Options, User interface</a>: <a href="#User-interface-options">User interface options</a></li>
3618 <li><a href="#index-Other-programs-406">Other programs</a>: <a href="#Other-programs">Other programs</a></li>
3619 <li><a href="#index-Paste-Game_002c-Menu-Item-15">Paste Game, Menu Item</a>: <a href="#File-Menu">File Menu</a></li>
3620 <li><a href="#index-Paste-Position_002c-Menu-Item-22">Paste Position, Menu Item</a>: <a href="#File-Menu">File Menu</a></li>
3621 <li><a href="#index-Pause_002c-Menu-Item-43">Pause, Menu Item</a>: <a href="#Mode-Menu">Mode Menu</a></li>
3622 <li><a href="#index-Periodic-Updates_002c-Menu-Item-93">Periodic Updates, Menu Item</a>: <a href="#Options-Menu">Options Menu</a></li>
3623 <li><a href="#index-pgnEventHeader_002c-option_0060-275">pgnEventHeader, option`</a>: <a href="#Load-and-Save-options">Load and Save options</a></li>
3624 <li><a href="#index-pgnExtendedInfo_002c-option_0060-274">pgnExtendedInfo, option`</a>: <a href="#Load-and-Save-options">Load and Save options</a></li>
3625 <li><a href="#index-pieceToSquareTable_002c-option-362">pieceToSquareTable, option</a>: <a href="#Other-options">Other options</a></li>
3626 <li><a href="#index-pixmap_002c-option-331">pixmap, option</a>: <a href="#User-interface-options">User interface options</a></li>
3627 <li><a href="#index-pixmapDirectory_002c-option-332">pixmapDirectory, option</a>: <a href="#User-interface-options">User interface options</a></li>
3628 <li><a href="#index-PolyglotBook_002c-option-178">PolyglotBook, option</a>: <a href="#UCI-_002b-WB-Engine-Settings">UCI + WB Engine Settings</a></li>
3629 <li><a href="#index-PolyglotDir_002c-option-176">PolyglotDir, option</a>: <a href="#UCI-_002b-WB-Engine-Settings">UCI + WB Engine Settings</a></li>
3630 <li><a href="#index-Ponder-Next-Move_002c-Menu-Item-94">Ponder Next Move, Menu Item</a>: <a href="#Options-Menu">Options Menu</a></li>
3631 <li><a href="#index-ponder_002c-option-134">ponder, option</a>: <a href="#Chess-engine-options">Chess engine options</a></li>
3632 <li><a href="#index-ponderNextMove_002c-option-135">ponderNextMove, option</a>: <a href="#Chess-engine-options">Chess engine options</a></li>
3633 <li><a href="#index-Popup-Exit-Message_002c-Menu-Item-95">Popup Exit Message, Menu Item</a>: <a href="#Options-Menu">Options Menu</a></li>
3634 <li><a href="#index-Popup-Move-Errors_002c-Menu-Item-96">Popup Move Errors, Menu Item</a>: <a href="#Options-Menu">Options Menu</a></li>
3635 <li><a href="#index-popup_002c-option-291">popup, option</a>: <a href="#User-interface-options">User interface options</a></li>
3636 <li><a href="#index-popupExitMessage_002c-option-290">popupExitMessage, option</a>: <a href="#User-interface-options">User interface options</a></li>
3637 <li><a href="#index-popupMoveErrors_002c-option-292">popupMoveErrors, option</a>: <a href="#User-interface-options">User interface options</a></li>
3638 <li><a href="#index-pre_002c-option-223">pre, option</a>: <a href="#ICS-options">ICS options</a></li>
3639 <li><a href="#index-Premove_002c-Menu-Item-97">Premove, Menu Item</a>: <a href="#Options-Menu">Options Menu</a></li>
3640 <li><a href="#index-premove_002c-option-224">premove, option</a>: <a href="#ICS-options">ICS options</a></li>
3641 <li><a href="#index-Problems-399">Problems</a>: <a href="#Problems">Problems</a></li>
3642 <li><a href="#index-queen_002c-option-293">queen, option</a>: <a href="#User-interface-options">User interface options</a></li>
3643 <li><a href="#index-Quiet-Play_002c-Menu-Item-98">Quiet Play, Menu Item</a>: <a href="#Options-Menu">Options Menu</a></li>
3644 <li><a href="#index-quiet_002c-option-225">quiet, option</a>: <a href="#ICS-options">ICS options</a></li>
3645 <li><a href="#index-quietPlay_002c-option-226">quietPlay, option</a>: <a href="#ICS-options">ICS options</a></li>
3646 <li><a href="#index-Reload-CMail-Message_002c-Menu-Item-24">Reload CMail Message, Menu Item</a>: <a href="#File-Menu">File Menu</a></li>
3647 <li><a href="#index-Reload-Same-Game_002c-Menu-Item-12">Reload Same Game, Menu Item</a>: <a href="#File-Menu">File Menu</a></li>
3648 <li><a href="#index-Reload-Same-Position_002c-Menu-Item-19">Reload Same Position, Menu Item</a>: <a href="#File-Menu">File Menu</a></li>
3649 <li><a href="#index-remoteShell_002c-option-369">remoteShell, option</a>: <a href="#Other-options">Other options</a></li>
3650 <li><a href="#index-remoteUser_002c-option-371">remoteUser, option</a>: <a href="#Other-options">Other options</a></li>
3651 <li><a href="#index-Reporting-bugs-398">Reporting bugs</a>: <a href="#Problems">Problems</a></li>
3652 <li><a href="#index-Reporting-problems-400">Reporting problems</a>: <a href="#Problems">Problems</a></li>
3653 <li><a href="#index-Resign_002c-Menu-Item-52">Resign, Menu Item</a>: <a href="#Action-Menu">Action Menu</a></li>
3654 <li><a href="#index-Retract-Move_002c-Menu-Item-68">Retract Move, Menu Item</a>: <a href="#Step-Menu">Step Menu</a></li>
3655 <li><a href="#index-reuse_002c-option-159">reuse, option</a>: <a href="#Chess-engine-options">Chess engine options</a></li>
3656 <li><a href="#index-reuse2_002c-option-161">reuse2, option</a>: <a href="#Chess-engine-options">Chess engine options</a></li>
3657 <li><a href="#index-reuseFirst_002c-option-160">reuseFirst, option</a>: <a href="#Chess-engine-options">Chess engine options</a></li>
3658 <li><a href="#index-reuseSecond_002c-option-162">reuseSecond, option</a>: <a href="#Chess-engine-options">Chess engine options</a></li>
3659 <li><a href="#index-Revert_002c-Menu-Item-65">Revert, Menu Item</a>: <a href="#Step-Menu">Step Menu</a></li>
3660 <li><a href="#index-ringBellAfterMoves_002c-option-288">ringBellAfterMoves, option</a>: <a href="#User-interface-options">User interface options</a></li>
3661 <li><a href="#index-rsh_002c-option-368">rsh, option</a>: <a href="#Other-options">Other options</a></li>
3662 <li><a href="#index-ruleMoves_002c-option-351">ruleMoves, option</a>: <a href="#Adjudication-Options">Adjudication Options</a></li>
3663 <li><a href="#index-ruser_002c-option-370">ruser, option</a>: <a href="#Other-options">Other options</a></li>
3664 <li><a href="#index-sameColorGames_002c-option-140">sameColorGames, option</a>: <a href="#Chess-engine-options">Chess engine options</a></li>
3665 <li><a href="#index-Save-Game_002c-Menu-Item-13">Save Game, Menu Item</a>: <a href="#File-Menu">File Menu</a></li>
3666 <li><a href="#index-saveGameFile_002c-option-265">saveGameFile, option</a>: <a href="#Load-and-Save-options">Load and Save options</a></li>
3667 <li><a href="#index-saveOutOfBookInfo_002c-option_0060-276">saveOutOfBookInfo, option`</a>: <a href="#Load-and-Save-options">Load and Save options</a></li>
3668 <li><a href="#index-savePositionFile_002c-option-273">savePositionFile, option</a>: <a href="#Load-and-Save-options">Load and Save options</a></li>
3669 <li><a href="#index-scp_002c-option-143">scp, option</a>: <a href="#Chess-engine-options">Chess engine options</a></li>
3670 <li><a href="#index-sd_002c-option-125">sd, option</a>: <a href="#Chess-engine-options">Chess engine options</a></li>
3671 <li><a href="#index-searchDepth_002c-option-126">searchDepth, option</a>: <a href="#Chess-engine-options">Chess engine options</a></li>
3672 <li><a href="#index-searchTime_002c-option-124">searchTime, option</a>: <a href="#Chess-engine-options">Chess engine options</a></li>
3673 <li><a href="#index-secondChessProgram_002c-option-144">secondChessProgram, option</a>: <a href="#Chess-engine-options">Chess engine options</a></li>
3674 <li><a href="#index-secondComputerString_002c-option-158">secondComputerString, option</a>: <a href="#Chess-engine-options">Chess engine options</a></li>
3675 <li><a href="#index-secondDirectory_002c-option-154">secondDirectory, option</a>: <a href="#Chess-engine-options">Chess engine options</a></li>
3676 <li><a href="#index-secondHasOwnBookUCI_002c-option-182">secondHasOwnBookUCI, option</a>: <a href="#UCI-_002b-WB-Engine-Settings">UCI + WB Engine Settings</a></li>
3677 <li><a href="#index-secondHost_002c-option-150">secondHost, option</a>: <a href="#Chess-engine-options">Chess engine options</a></li>
3678 <li><a href="#index-secondInitString_002c-option-156">secondInitString, option</a>: <a href="#Chess-engine-options">Chess engine options</a></li>
3679 <li><a href="#index-secondIsUCI_002c-option-175">secondIsUCI, option</a>: <a href="#UCI-_002b-WB-Engine-Settings">UCI + WB Engine Settings</a></li>
3680 <li><a href="#index-secondNPS_002c-option-128">secondNPS, option</a>: <a href="#Chess-engine-options">Chess engine options</a></li>
3681 <li><a href="#index-secondOptions_002c-option-169">secondOptions, option</a>: <a href="#Chess-engine-options">Chess engine options</a></li>
3682 <li><a href="#index-secondProtocolVersion_002c-option-164">secondProtocolVersion, option</a>: <a href="#Chess-engine-options">Chess engine options</a></li>
3683 <li><a href="#index-secondScoreAbs_002c-option-166">secondScoreAbs, option</a>: <a href="#Chess-engine-options">Chess engine options</a></li>
3684 <li><a href="#index-secondTimeOdds_002c-option-130">secondTimeOdds, option</a>: <a href="#Chess-engine-options">Chess engine options</a></li>
3685 <li><a href="#index-secondXBook_002c-option-184">secondXBook, option</a>: <a href="#UCI-_002b-WB-Engine-Settings">UCI + WB Engine Settings</a></li>
3686 <li><a href="#index-set_002c-ICS-command-388">set, ICS command</a>: <a href="#Chess-Servers">Chess Servers</a></li>
3687 <li><a href="#index-Settings_002c-Engine-171">Settings, Engine</a>: <a href="#UCI-_002b-WB-Engine-Settings">UCI + WB Engine Settings</a></li>
3688 <li><a href="#index-sgf_002c-option-264">sgf, option</a>: <a href="#Load-and-Save-options">Load and Save options</a></li>
3689 <li><a href="#index-sh_002c-option-149">sh, option</a>: <a href="#Chess-engine-options">Chess engine options</a></li>
3690 <li><a href="#index-Shortcut-keys-110">Shortcut keys</a>: <a href="#Keys">Keys</a></li>
3691 <li><a href="#index-Show-Coords_002c-Menu-Item-99">Show Coords, Menu Item</a>: <a href="#Options-Menu">Options Menu</a></li>
3692 <li><a href="#index-Show-Engine-Output_002c-Menu-Item-39">Show Engine Output, Menu Item</a>: <a href="#Mode-Menu">Mode Menu</a></li>
3693 <li><a href="#index-Show-Game-List_002c-Menu-Item-37">Show Game List, Menu Item</a>: <a href="#Mode-Menu">Mode Menu</a></li>
3694 <li><a href="#index-Show-Move-History_002c-Menu-Item-38">Show Move History, Menu Item</a>: <a href="#Mode-Menu">Mode Menu</a></li>
3695 <li><a href="#index-showButtonBar_002c-option-311">showButtonBar, option</a>: <a href="#User-interface-options">User interface options</a></li>
3696 <li><a href="#index-showCoords_002c-option-301">showCoords, option</a>: <a href="#User-interface-options">User interface options</a></li>
3697 <li><a href="#index-showThinking_002c-option-133">showThinking, option</a>: <a href="#Chess-engine-options">Chess engine options</a></li>
3698 <li><a href="#index-size_002c-option-297">size, option</a>: <a href="#User-interface-options">User interface options</a></li>
3699 <li><a href="#index-sNoOwnBookUCI_002c-option-180">sNoOwnBookUCI, option</a>: <a href="#UCI-_002b-WB-Engine-Settings">UCI + WB Engine Settings</a></li>
3700 <li><a href="#index-soundChallenge_002c-option-247">soundChallenge, option</a>: <a href="#ICS-options">ICS options</a></li>
3701 <li><a href="#index-soundChannel_002c-option-244">soundChannel, option</a>: <a href="#ICS-options">ICS options</a></li>
3702 <li><a href="#index-soundIcsAlarm_002c-option-251">soundIcsAlarm, option</a>: <a href="#ICS-options">ICS options</a></li>
3703 <li><a href="#index-soundIcsDraw_002c-option-254">soundIcsDraw, option</a>: <a href="#ICS-options">ICS options</a></li>
3704 <li><a href="#index-soundIcsLoss_002c-option-253">soundIcsLoss, option</a>: <a href="#ICS-options">ICS options</a></li>
3705 <li><a href="#index-soundIcsUnfinished_002c-option-255">soundIcsUnfinished, option</a>: <a href="#ICS-options">ICS options</a></li>
3706 <li><a href="#index-soundIcsWin_002c-option-252">soundIcsWin, option</a>: <a href="#ICS-options">ICS options</a></li>
3707 <li><a href="#index-soundKibitz_002c-option-245">soundKibitz, option</a>: <a href="#ICS-options">ICS options</a></li>
3708 <li><a href="#index-soundMove_002c-option-250">soundMove, option</a>: <a href="#ICS-options">ICS options</a></li>
3709 <li><a href="#index-soundProgram_002c-option-240">soundProgram, option</a>: <a href="#ICS-options">ICS options</a></li>
3710 <li><a href="#index-soundRequest_002c-option-248">soundRequest, option</a>: <a href="#ICS-options">ICS options</a></li>
3711 <li><a href="#index-Sounds-241">Sounds</a>: <a href="#ICS-options">ICS options</a></li>
3712 <li><a href="#index-soundSeek_002c-option-249">soundSeek, option</a>: <a href="#ICS-options">ICS options</a></li>
3713 <li><a href="#index-soundShout_002c-option-242">soundShout, option</a>: <a href="#ICS-options">ICS options</a></li>
3714 <li><a href="#index-soundSShout_002c-option-243">soundSShout, option</a>: <a href="#ICS-options">ICS options</a></li>
3715 <li><a href="#index-soundTell_002c-option-246">soundTell, option</a>: <a href="#ICS-options">ICS options</a></li>
3716 <li><a href="#index-spf_002c-option-272">spf, option</a>: <a href="#Load-and-Save-options">Load and Save options</a></li>
3717 <li><a href="#index-st_002c-option-123">st, option</a>: <a href="#Chess-engine-options">Chess engine options</a></li>
3718 <li><a href="#index-Step-Menu-55">Step Menu</a>: <a href="#Step-Menu">Step Menu</a></li>
3719 <li><a href="#index-Stop-Examining_002c-Menu-Item-54">Stop Examining, Menu Item</a>: <a href="#Action-Menu">Action Menu</a></li>
3720 <li><a href="#index-Stop-Observing_002c-Menu-Item-53">Stop Observing, Menu Item</a>: <a href="#Action-Menu">Action Menu</a></li>
3721 <li><a href="#index-sUCI_002c-option-173">sUCI, option</a>: <a href="#UCI-_002b-WB-Engine-Settings">UCI + WB Engine Settings</a></li>
3722 <li><a href="#index-tc_002c-option-115">tc, option</a>: <a href="#Chess-engine-options">Chess engine options</a></li>
3723 <li><a href="#index-td_002c-option-262">td, option</a>: <a href="#Load-and-Save-options">Load and Save options</a></li>
3724 <li><a href="#index-telnet_002c-option-199">telnet, option</a>: <a href="#ICS-options">ICS options</a></li>
3725 <li><a href="#index-telnetProgram_002c-option-201">telnetProgram, option</a>: <a href="#ICS-options">ICS options</a></li>
3726 <li><a href="#index-Test-Legality_002c-Menu-Item-101">Test Legality, Menu Item</a>: <a href="#Options-Menu">Options Menu</a></li>
3727 <li><a href="#index-testClaims_002c-option-348">testClaims, option</a>: <a href="#Adjudication-Options">Adjudication Options</a></li>
3728 <li><a href="#index-testLegality_002c-option-296">testLegality, option</a>: <a href="#User-interface-options">User interface options</a></li>
3729 <li><a href="#index-thinking_002c-option-132">thinking, option</a>: <a href="#Chess-engine-options">Chess engine options</a></li>
3730 <li><a href="#index-Time-Control_002c-Menu-Item-76">Time Control, Menu Item</a>: <a href="#Options-Menu">Options Menu</a></li>
3731 <li><a href="#index-timeControl_002c-option-116">timeControl, option</a>: <a href="#Chess-engine-options">Chess engine options</a></li>
3732 <li><a href="#index-timeDelay_002c-option-263">timeDelay, option</a>: <a href="#Load-and-Save-options">Load and Save options</a></li>
3733 <li><a href="#index-timeIncrement_002c-option-120">timeIncrement, option</a>: <a href="#Chess-engine-options">Chess engine options</a></li>
3734 <li><a href="#index-timeOddsMode_002c-option-131">timeOddsMode, option</a>: <a href="#Chess-engine-options">Chess engine options</a></li>
3735 <li><a href="#index-title_002c-option-308">title, option</a>: <a href="#User-interface-options">User interface options</a></li>
3736 <li><a href="#index-titleInWindow_002c-option-309">titleInWindow, option</a>: <a href="#User-interface-options">User interface options</a></li>
3737 <li><a href="#index-Training_002c-Menu-Item-36">Training, Menu Item</a>: <a href="#Mode-Menu">Mode Menu</a></li>
3738 <li><a href="#index-trivialDraws_002c-option-350">trivialDraws, option</a>: <a href="#Adjudication-Options">Adjudication Options</a></li>
3739 <li><a href="#index-Truncate-Game_002c-Menu-Item-66">Truncate Game, Menu Item</a>: <a href="#Step-Menu">Step Menu</a></li>
3740 <li><a href="#index-Two-Machines_002c-Menu-Item-30">Two Machines, Menu Item</a>: <a href="#Mode-Menu">Mode Menu</a></li>
3741 <li><a href="#index-usePolyglotBook_002c-option-177">usePolyglotBook, option</a>: <a href="#UCI-_002b-WB-Engine-Settings">UCI + WB Engine Settings</a></li>
3742 <li><a href="#index-User-interface-options-280">User interface options</a>: <a href="#User-interface-options">User interface options</a></li>
3743 <li><a href="#index-userName_002c-option-372">userName, option</a>: <a href="#Other-options">Other options</a></li>
3744 <li><a href="#index-useTelnet_002c-option-200">useTelnet, option</a>: <a href="#ICS-options">ICS options</a></li>
3745 <li><a href="#index-variant_002c-option-357">variant, option</a>: <a href="#Other-options">Other options</a></li>
3746 <li><a href="#index-vars_002c-ICS-command-387">vars, ICS command</a>: <a href="#Chess-Servers">Chess Servers</a></li>
3747 <li><a href="#index-whitePieceColor_002c-option-334">whitePieceColor, option</a>: <a href="#User-interface-options">User interface options</a></li>
3748 <li><a href="#index-who_002c-ICS-command-379">who, ICS command</a>: <a href="#Chess-Servers">Chess Servers</a></li>
3749 <li><a href="#index-xflash_002c-option-317">xflash, option</a>: <a href="#User-interface-options">User interface options</a></li>
3750    </ul>
3751 <div class="contents">
3752 <h2>Table of Contents</h2>
3753 <ul>
3754 <li><a name="toc_Top" href="#Top">Introduction</a>
3755 <li><a name="toc_Major-modes" href="#Major-modes">1 Major modes</a>
3756 <li><a name="toc_Menus" href="#Menus">2 Menus, buttons, and keys</a>
3757 <ul>
3758 <li><a href="#File-Menu">2.1 File Menu</a>
3759 <li><a href="#Mode-Menu">2.2 Mode Menu</a>
3760 <li><a href="#Action-Menu">2.3 Action Menu</a>
3761 <li><a href="#Step-Menu">2.4 Step Menu</a>
3762 <li><a href="#Options-Menu">2.5 Options Menu</a>
3763 <li><a href="#Help-Menu">2.6 Help Menu</a>
3764 <li><a href="#Keys">2.7 Other Shortcut Keys</a>
3765 </li></ul>
3766 <li><a name="toc_Options" href="#Options">3 Options</a>
3767 <ul>
3768 <li><a href="#Chess-engine-options">3.1 Chess Engine Options</a>
3769 <li><a href="#UCI-_002b-WB-Engine-Settings">3.2 UCI + WB Engine Settings</a>
3770 <li><a href="#ICS-options">3.3 ICS options</a>
3771 <li><a href="#Load-and-Save-options">3.4 Load and Save options</a>
3772 <li><a href="#User-interface-options">3.5 User interface options</a>
3773 <li><a href="#Adjudication-Options">3.6 Adjudication Options</a>
3774 <li><a href="#Other-options">3.7 Other options</a>
3775 </li></ul>
3776 <li><a name="toc_Chess-Servers" href="#Chess-Servers">4 Chess Servers</a>
3777 <li><a name="toc_Firewalls" href="#Firewalls">5 Firewalls</a>
3778 <li><a name="toc_Environment" href="#Environment">6 Environment variables</a>
3779 <li><a name="toc_Limitations" href="#Limitations">7 Limitations and known bugs</a>
3780 <li><a name="toc_Problems" href="#Problems">8 Reporting problems</a>
3781 <li><a name="toc_Contributors" href="#Contributors">9 Authors and contributors</a>
3782 <li><a name="toc_CMail" href="#CMail">10 CMail</a>
3783 <ul>
3784 <li><a href="#CMail-options">10.1 CMail options</a>
3785 <li><a href="#CMail-game">10.2 Starting a CMail Game</a>
3786 <li><a href="#CMail-answer">10.3 Answering a Move</a>
3787 <li><a href="#CMail-multi">10.4 Multi-Game Messages</a>
3788 <li><a href="#CMail-completion">10.5 Completing a Game</a>
3789 <li><a href="#CMail-trouble">10.6 Known CMail Problems</a>
3790 </li></ul>
3791 <li><a name="toc_Other-programs" href="#Other-programs">11 Other programs you can use with XBoard</a>
3792 <ul>
3793 <li><a href="#GNU-Chess">11.1 GNU Chess</a>
3794 <li><a href="#Fairy_002dMax">11.2 Fairy-Max</a>
3795 <li><a href="#HoiChess">11.3 HoiChess</a>
3796 <li><a href="#Crafty">11.4 Crafty</a>
3797 <li><a href="#zic2xpm">11.5 zic2xpm</a>
3798 </li></ul>
3799 <li><a name="toc_Copyright" href="#Copyright">Copyright</a>
3800 <li><a name="toc_Copying" href="#Copying">GNU GENERAL PUBLIC LICENSE</a>
3801 <li><a name="toc_Index" href="#Index">Index</a>
3802 </li></ul>
3803 </div>
3804
3805    <p>\r
3806 <!-- end noman -->
3807 \r
3808
3809 </body></html>
3810