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