3 * xboard: (xboard). An X Window System graphical chessboard.
9 XBoard is a graphical chessboard that can serve as a user interface to
10 chess engines (such as GNU Chess), the Internet Chess Servers,
11 electronic mail correspondence chess, or your own collection of saved
14 This manual documents version 4.6.0 of XBoard.
19 XBoard always runs in one of four major modes. You select the major
20 mode from the command line when you start up XBoard.
23 As an interface to GNU Chess or another chess engine running on
24 your machine, XBoard lets you play a game against the machine, set
25 up arbitrary positions, force variations, watch a game between two
26 chess engines, interactively analyze your stored games or set up
27 and analyze arbitrary positions. (Note: Not all chess engines
30 xboard -ics -icshost hostname [options]
31 As Internet Chess Server (ICS) interface, XBoard lets you play
32 against other ICS users, observe games they are playing, or review
33 games that have recently finished. Most of the ICS "wild" chess
34 variants are supported, including bughouse.
37 XBoard can also be used simply as an electronic chessboard to play
38 through games. It will read and write game files and allow you to
39 play through variations manually. You can use it to browse games
40 off the net or review games you have saved. These features are
41 also available in the other modes.
44 If you want to pipe games into XBoard, use the supplied shell
45 script `pxboard'. For example, from the news reader `xrn', find a
46 message with one or more games in it, click the Save button, and
47 type `|pxboard' as the file name.
50 As an interface to electronic mail correspondence chess, XBoard
51 works with the cmail program. See *note CMail:: below for
57 To move a piece, you can drag it with the left mouse button, or you can
58 click the left mouse button once on the piece, then once more on the
59 destination square. In crazyhouse, bughouse or shogi you can drag and
60 drop pieces to the board from the holdings squares displayed next to
63 Old behavior, where right-clicking a square brings up a menu where
64 you can select what piece to drop on it can still be selected through
65 the `Drop Menu' option. Only in Edit Position mode right and middle
66 clicking a square is still used to put a piece on it, and the piece to
67 drop is selected by sweeping the mouse vertically with the button held
70 The default function of the right mouse button in other modes is to
71 display the position the chess program thinks it will end up in. While
72 moving the mouse vertically with this button pressed XBoard will step
73 through the principal variation to show how this position will be
74 reached. Lines of play displayed in the engine-output window, or PGN
75 variations in the comment window can similarly be played out on the
76 board, by right-clicking on them. Only in Analysis mode, when you walk
77 along a PV, releasing the mouse button will forward the game upto that
78 point, like you entered all previous PV moves. As the display of the
79 PV in that case starts after the first move a simple right-click will
80 play the move the engine indicates.
82 When connected to an ICS, it is possible to call up a graphical
83 representation of players seeking a game in stead of the chess board,
84 when the latter is not in use (i.e. when you are not playing or
85 observing). Left-clicking the display area will switch between this
86 'seek graph' and the chess board. Hovering the mouse pointer over a
87 dot will show the details of the seek ad in the message field above the
88 board. Left-clicking the dot will challenge that player.
89 Right-clicking a dot will 'push it to the back', to reveal any dots
90 that were hidden behind it. Right-clicking off dots will refresh the
93 Most other XBoard commands are available from the menu bar. The most
94 frequently used commands also have shortcut keys or on-screen buttons.
95 These shortcut keystrokes are mostly non-printable characters. Typing
96 a letter or digit while the board window has focus will bring up a
97 type-in box with the typed letter already in it. You can use that to
98 type a move in siuations where it is your turn to enter a move, type a
99 move number to call up the position after that move in the display, or,
100 in Edit Position mode, type a FEN. Some rarely used parameters can
101 only be set through options on the command line used to invoke XBoard.
103 XBoard uses a settings file, in which it can remember any changes to
104 the settings that are made through menus or command-line options, so
105 they will still apply when you restart XBoard for another session. The
106 settings can be saved into this file automatically when XBoard exits,
107 or on explicit request of the user. The default name for the settings
108 file is /etc/xboard/xboard.conf, but in a standard install this file is
109 only used as a master settings file that determines the system-wide
110 default settings, and defers reading and writing of user settings to a
111 user-specific file like ~/.xboardrc in the user's home directory.
113 When XBoard is iconized, its graphical icon is a white knight if it
114 is White's turn to move, a black knight if it is Black's turn.
116 3 Menus, buttons, and keys
117 **************************
123 Resets XBoard and the chess engine to the beginning of a new chess
124 game. The `Ctrl-N' key is a keyboard equivalent. In Internet Chess
125 Server mode, clears the current state of XBoard, then
126 resynchronizes with the ICS by sending a refresh command. If you
127 want to stop playing, observing, or examining an ICS game, use an
128 appropriate command from the Action menu, not `New Game'. *Note
132 Similar to `New Game', but allows you to specify a particular
133 initial position (according to a standardized numbering system) in
134 chess variants which use randomized opening positions (e.g.
135 Chess960). You can also press the `Pick Fixed' button to let
136 XBoard generate a random number for you. The thus selected
137 opening position will then persistently be chosen on any following
138 New Game command until you use this menu to select another.
139 Selecting position number -1 (or pushing the `Randomize' button)
140 will produce a newly randomized position on any new game. Using
141 this menu item in variants that normally do not shuffle their
142 opening position does cause these variants to become shuffle
143 variants until you use the `New Shuffle Game' menu to explicitly
144 switch the randomization off, or select a new variant.
147 Allows you to select a new chess variant in non-ICS mode. (In ICS
148 play, the ICS is responsible for deciding which variant will be
149 played, and XBoard adapts automatically.) The shifted `Alt+V' key
150 is a keyboard equivalent. If you play with an engine, the engine
151 must be able to play the selected variant, or the command will be
152 ignored. XBoard supports all major variants, such as xiangqi,
153 shogi, chess, chess960, Capablanca Chess, shatranj, crazyhouse,
154 bughouse. But not every board size has built-in bitmaps for
155 un-orthodox pieces! Only sizes bulky (72) and middling (49) have
156 all pieces, while size petite (33) has most. These sizes would
157 have to be set at startup through the `size' command-line option
158 when you start up XBoard for such variants to be playable.
160 You can overrule the default board format of the selected variant,
161 (e.g. to play suicide chess on a 6 x 6 board), in this dialog, but
162 normally you would not do that, and leave them at '-1', which
166 Plays a game from a record file. The `Ctrl-O' key is a keyboard
167 equivalent. A pop-up dialog prompts you for the file name. If the
168 file contains more than one game, a second pop-up dialog displays
169 a list of games (with information drawn from their PGN tags, if
170 any), and you can select the one you want. Alternatively, you can
171 load the Nth game in the file directly, by typing the number `N'
172 after the file name, separated by a space.
174 The game file parser will accept PGN (portable game notation), or
175 in fact almost any file that contains moves in algebraic notation.
176 Notation of the form `P@f7' is accepted for piece-drops in
177 bughouse games; this is a nonstandard extension to PGN. If the
178 file includes a PGN position (FEN tag), or an old-style XBoard
179 position diagram bracketed by `[--' and `--]' before the first
180 move, the game starts from that position. Text enclosed in
181 parentheses, square brackets, or curly braces is assumed to be
182 commentary and is displayed in a pop-up window. Any other text in
183 the file is ignored. PGN variations (enclosed in parentheses) also
184 are treated as comments; however, if you rights-click them in the
185 comment window, XBoard will shelve the current line, and load the
186 the selected variation, so you can step through it. You can later
187 revert to the previous line with the `Revert' command. This way
188 you can walk quite complex varation trees with XBoard. The
189 nonstandard PGN tag [Variant "varname"] functions similarly to the
190 -variant command-line option (see below), allowing games in
191 certain chess variants to be loaded. Note that it must appear
192 before any FEN tag for XBoard to recognize variant FENs
193 appropriately. There is also a heuristic to recognize chess
194 variants from the Event tag, by looking for the strings that the
195 Internet Chess Servers put there when saving variant ("wild")
199 Sets up a position from a position file. A pop-up dialog prompts
200 you for the file name. The shifted `Ctrl-O' key is a keyboard
201 equivalent. If the file contains more than one saved position, and
202 you want to load the Nth one, type the number N after the file
203 name, separated by a space. Position files must be in FEN
204 (Forsythe-Edwards notation), or in the format that the Save
205 Position command writes when oldSaveStyle is turned on.
208 Loads the next position from the last position file you loaded.
209 The shifted `PgDn' key is a keyboard equivalent.
211 Load Previous Position
212 Loads the previous position from the last position file you
213 loaded. The shifted `PgUp' key is a keyboard equivalent. Not
214 available if the last position was loaded from a pipe.
217 Appends a record of the current game to a file. The `Ctrl-S' key
218 is a keyboard equivalent. A pop-up dialog prompts you for the
219 file name. If the game did not begin with the standard starting
220 position, the game file includes the starting position used. Games
221 are saved in the PGN (portable game notation) format, unless the
222 oldSaveStyle option is true, in which case they are saved in an
223 older format that is specific to XBoard. Both formats are
224 human-readable, and both can be read back by the `Load Game'
225 command. Notation of the form `P@f7' is accepted for piece-drops
226 in bughouse games; this is a nonstandard extension to PGN.
229 Appends a diagram of the current position to a file. The shifted
230 `Ctrl+S' key is a keyboard equivalent. A pop-up dialog prompts
231 you for the file name. Positions are saved in FEN
232 (Forsythe-Edwards notation) format unless the `oldSaveStyle'
233 option is true, in which case they are saved in an older,
234 human-readable format that is specific to XBoard. Both formats can
235 be read back by the `Load Position' command.
242 Exits from XBoard. The `Ctrl-Q' key is a keyboard equivalent.
248 Copies a record of the current game to an internal clipboard in PGN
249 format and sets the X selection to the game text. The `Ctrl-C' key
250 is a keyboard equivalent. The game can be pasted to another
251 application (such as a text editor or another copy of XBoard)
252 using that application's paste command. In many X applications,
253 such as xterm and emacs, the middle mouse button can be used for
254 pasting; in XBoard, you must use the Paste Game command.
257 Copies the current position to an internal clipboard in FEN format
258 and sets the X selection to the position text. The shifted
259 `Ctrl-C' key is a keyboard equivalent. The position can be pasted
260 to another application (such as a text editor or another copy of
261 XBoard) using that application's paste command. In many X
262 applications, such as xterm and emacs, the middle mouse button can
263 be used for pasting; in XBoard, you must use the Paste Position
267 Copies the current game list to the clipboard, and sets the X
268 selection to this text. A format of comma-separated double-quoted
269 strings is used, including all tags, so it can be easily imported
270 into spread-sheet programs.
273 Interprets the current X selection as a game record and loads it,
274 as with Load Game. The `Ctrl-V' key is a keyboard equivalent.
277 Interprets the current X selection as a FEN position and loads it,
278 as with Load Position. The shifted `Ctrl-V' key is a keyboard
282 Allows you to make moves for both Black and White, and to change
283 moves after backing up with the `Backward' command. The clocks do
284 not run. The `Ctrl-E' key is a keyboard equivalent.
286 In chess engine mode, the chess engine continues to check moves
287 for legality but does not participate in the game. You can bring
288 the chess engine into the game by selecting `Machine White',
289 `Machine Black', or `Two Machines'.
291 In ICS mode, the moves are not sent to the ICS: `Edit Game' takes
292 XBoard out of ICS Client mode and lets you edit games locally. If
293 you want to edit games on ICS in a way that other ICS users can
294 see, use the ICS `examine' command or start an ICS match against
298 Lets you set up an arbitrary board position. The shifted `Ctrl-E'
299 key is a keyboard equivalent. Use mouse button 1 to drag pieces
300 to new squares, or to delete a piece by dragging it off the board
301 or dragging an empty square on top of it. To drop a new piece on
302 a square, press mouse button 2 or 3 over the square. This puts a
303 white or black pawn in the square, respectively, but you can
304 change that to any other piece type by dragging the mouse down
305 before you release the button. You will then see the piece on the
306 originally clicked square cycle through the available pieces
307 (including those of opposite color), and can release the button
308 when you see the piece you want. To alter the side to move, you
309 can click the clock (the words White and Black above the board) of
310 the side you want to give the move to. To clear the board you can
311 click the clock of the side that alread has the move (which is
312 highlighted in black). The old behavior with a piece menu can
313 still be configured with the aid of the `pieceMenu' option.
314 Selecting `Edit Position' causes XBoard to discard all remembered
315 moves in the current game.
317 In ICS mode, changes made to the position by `Edit Position' are
318 not sent to the ICS: `Edit Position' takes XBoard out of `ICS
319 Client' mode and lets you edit positions locally. If you want to
320 edit positions on ICS in a way that other ICS users can see, use
321 the ICS `examine' command, or start an ICS match against yourself.
322 (See also the ICS Client topic above.)
325 Lets you edit the PGN (portable game notation) tags for the
326 current game. After editing, the tags must still conform to the
329 <tag-section> ::= <tag-pair> <tag-section>
331 <tag-pair> ::= [ <tag-name> <tag-value> ]
332 <tag-name> ::= <identifier>
333 <tag-value> ::= <string>
334 See the PGN Standard for full details. Here is an example:
336 [Event "Portoroz Interzonal"]
337 [Site "Portoroz, Yugoslavia"]
340 [White "Robert J. Fischer"]
341 [Black "Bent Larsen"]
343 Any characters that do not match this syntax are silently ignored.
344 Note that the PGN standard requires all games to have at least the
345 seven tags shown above. Any that you omit will be filled in by
346 XBoard with `?' (unknown value), or `-' (inapplicable value).
349 Adds or modifies a comment on the current position. Comments are
350 saved by `Save Game' and are displayed by `Load Game', `Forward',
354 Pops up a window listing the moves available in the GUI book
355 (specified in the `Common Engine Settings' dialog) from the
356 currently displayed position, together with their weights and
357 (optionally in braces) learn info. You can then edit this list,
358 and the new list will be stored back into the book when you press
359 OK. Note that the listed percentages are neither used, nor
360 updated when you change the weights; they are just there as an
365 If you are examining an ICS game and Pause mode is off, Revert
366 issues the ICS command `revert'. In local mode, when you were
367 editing or analyzing a game, and the `-variations' command-line
368 option is switched on, you can start a new variation by holding
369 the Shift key down while entering a move not at the end of the
370 game. Variations can also become the currently displayed line by
371 clicking a PGN variation displayed in the Comment window. This
372 can be applied recursively, so that you can analyze variations on
373 variations; each time you create a new variation by entering an
374 alternative move with Shift pressed, or select a new one from the
375 Comment window, the current variation will be shelved. `Revert'
376 allows you to return to the most recently shelved variation. The
377 difference between `Revert' and `Annotate' is that with the latter,
378 the variation you are now abandoning will be added as a comment
379 (in PGN variation syntax, i.e. between parentheses) to the
380 original move where you deviated, for later recalling. The `Home'
381 key is a keyboard equivalent to `Revert'.
384 Discards all remembered moves of the game beyond the current
385 position. Puts XBoard into `Edit Game' mode if it was not there
386 already. The `End' key is a keyboard equivalent.
389 Steps backward through a series of remembered moves. The `[<]'
390 button and the `Alt+LeftArrow' key are equivalents, as is turning
391 the mouse wheel towards you. In addition, pressing the Control
392 key steps back one move, and releasing it steps forward again.
394 In most modes, `Backward' only lets you look back at old positions;
395 it does not retract moves. This is the case if you are playing
396 against a chess engine, playing or observing a game on an ICS, or
397 loading a game. If you select `Backward' in any of these
398 situations, you will not be allowed to make a different move. Use
399 `Retract Move' or `Edit Game' if you want to change past moves.
401 If you are examining an ICS game, the behavior of `Backward'
402 depends on whether XBoard is in Pause mode. If Pause mode is off,
403 `Backward' issues the ICS backward command, which backs up
404 everyone's view of the game and allows you to make a different
405 move. If Pause mode is on, `Backward' only backs up your local
409 Steps forward through a series of remembered moves (undoing the
410 effect of `Backward') or forward through a game file. The `[>]'
411 button and the `Alt+RightArrow' key are equivalents, as is turning
412 the mouse wheel away from you.
414 If you are examining an ICS game, the behavior of Forward depends
415 on whether XBoard is in Pause mode. If Pause mode is off,
416 `Forward' issues the ICS forward command, which moves everyone's
417 view of the game forward along the current line. If Pause mode is
418 on, `Forward' only moves your local view forward, and it will not
419 go past the position that the game was in when you paused.
422 Jumps backward to the first remembered position in the game. The
423 `[<<]' button and the `Alt+Home' key are equivalents.
425 In most modes, Back to Start only lets you look back at old
426 positions; it does not retract moves. This is the case if you are
427 playing against a local chess engine, playing or observing a game
428 on a chess server, or loading a game. If you select `Back to
429 Start' in any of these situations, you will not be allowed to make
430 different moves. Use `Retract Move' or `Edit Game' if you want to
431 change past moves; or use Reset to start a new game.
433 If you are examining an ICS game, the behavior of `Back to Start'
434 depends on whether XBoard is in Pause mode. If Pause mode is off,
435 `Back to Start' issues the ICS `backward 999999' command, which
436 backs up everyone's view of the game to the start and allows you
437 to make different moves. If Pause mode is on, `Back to Start' only
438 backs up your local view.
441 Jumps forward to the last remembered position in the game. The
442 `[>>]' button and the `Alt+End' key are equivalents.
444 If you are examining an ICS game, the behavior of `Forward to End'
445 depends on whether XBoard is in Pause mode. If Pause mode is off,
446 `Forward to End' issues the ICS `forward 999999' command, which
447 moves everyone's view of the game forward to the end of the
448 current line. If Pause mode is on, `Forward to End' only moves
449 your local view forward, and it will not go past the position that
450 the game was in when you paused.
456 Inverts your view of the chess board for the duration of the
457 current game. Starting a new game returns the board to normal.
458 The `F2' key is a keyboard equivalent.
461 Shows or hides a window in which the thinking output of any loaded
462 engines is displayed. The shifted `Alt+O' key is a keyboard
463 equivalent. XBoard will display lines of thinking output of the
464 same depth ordered by score, (highest score on top), rather than
465 in the order the engine produced them. Usually this amounts to
466 the same, as a normal engine search will only find new PV (and
467 emit it as thinking output) when it searches a move with a higher
468 score than the previous variation. But when the engine is in
469 multi-variation mode this needs not always be true, and it is more
470 convenient for someone analyzing games to see the moves sorted by
471 score. The order in which the engine found them is only of
472 interest to the engine author, and can still be deduced from the
473 time or node count printed with the line.
476 Shows or hides a list of moves of the current game. The shifted
477 `Alt+H' key is a keyboard equivalent. This list allows you to
478 move the display to any earlier position in the game by clicking
479 on the corresponding move.
481 Show Evaluation Graph
482 Shows or hides a window which displays a graph of how the engine
483 score(s) evolved as a function of the move number. The shifted
484 `Alt+E' key is a keyboard equivalent. Clicking on the graph will
485 bring the corresponding position in the board display.
488 Shows or hides the list of games generated by the last `Load Game'
489 command. The shifted `Alt+G' key is a keyboard equivalent.
492 Pops up a window which shows the PGN (portable game notation) tags
493 for the current game. For now this is a duplicate of the `Edit
494 Tags' item in the `Edit' menu.
497 Pops up a window which shows any comments to or variations on the
498 current move. For now this is a duplicate of the `Edit Comment'
499 item in the `Edit' menu.
502 If this option is set in ICS mode, XBoard creates an extra window
503 that you can use for typing in ICS commands. The input box is
504 especially useful if you want to type in something long or do some
505 editing on your input, because output from ICS doesn't get mixed
506 in with your typing as it would in the main terminal window.
509 Summons a dialog where you can customaize the look of the chess
510 board. Here you can specify the directory from which piece images
511 should be taken, when you don't want to use the built-in piece
512 images (see `pixmapDirectory' and `bitmapDirectory' options), an
513 external pixmap to be used for the board squares
514 (`liteBackTextureFile' and `darkBackTextureFile' options), and
515 square and piece colors for the built-ins.
518 a duplicate of the Game List dialog in the Options menu.
524 Tells the chess engine to play White. The `Ctrl-W' key is a
528 Tells the chess engine to play Black. The `Ctrl-B' key is a
532 Plays a game between two chess engines. The `Ctrl-T' key is a
536 XBoard tells the chess engine to start analyzing the current
537 game/position and shows you the analysis as you move pieces around.
538 The `Ctrl-A' key is a keyboard equivalent. Note: Some chess
539 engines do not support Analysis mode.
541 To set up a position to analyze, you do the following:
543 1. Select Edit Position from the Mode Menu
545 2. Set up the position. Use the middle and right buttons to bring
546 up the white and black piece menus.
548 3. When you are finished, click on either the Black or White clock
549 to tell XBoard which side moves first.
551 4. Select Analysis Mode from the Mode Menu to start the analysis.
553 You can now play legal moves to create follow-up positions for the
554 engine to analyze, while the moves will be remembered as a stored
555 game, and then step backward through this game to take the moves
556 back. Note that you can also click on the clocks to set the
557 opposite side to move (adding a so-called `null move' to the game).
559 The analysis function can also be used when observing games on an
560 ICS with an engine loaded (zippy mode); the engine then will
561 analyse the positions as they occur in the observed game.
564 This option subjects the currently loaded game to automatic
565 analysis by the loaded engine. The `Ctrl-G' key is a keyboard
566 equivalent. XBoard will start auto-playing the game from the
567 currently displayed position, while the engine is analyzing the
568 current position. The game will be annotated with the results of
569 these analyses. In particlar, the score and depth will be added
570 as a comment, and the PV will be added as a variation. The time
571 the engine spends on analyzing each move can be controlled through
572 the command-line option `-timeDelay'. Note: Some chess engines do
573 not support Analysis mode.
576 Duplicate of the item in the Edit menu. Note that `Edit Game' is
577 the idle mode of XBoard, and can be used to get you out of other
578 modes. E.g. to stop analyzing, stop a game between two engines or
579 stop editing a position.
582 Duplicate of the item in the Edit menu.
585 Training mode lets you interactively guess the moves of a game for
586 one of the players. You guess the next move of the game by playing
587 the move on the board. If the move played matches the next move of
588 the game, the move is accepted and the opponent's response is
589 auto-played. If the move played is incorrect, an error message is
590 displayed. You can select this mode only while loading a game
591 (that is, after selecting `Load Game' from the File menu). While
592 XBoard is in `Training' mode, the navigation buttons are disabled.
595 This is the normal mode when XBoard is connected to a chess
596 server. If you have moved into Edit Game or Edit Position mode,
597 you can select this option to get out.
599 To use xboard in ICS mode, run it in the foreground with the -ics
600 option, and use the terminal you started it from to type commands
601 and receive text responses from the chess server. See *note Chess
602 Servers:: below for more information.
604 XBoard activates some special position/game editing features when
605 you use the `examine' or `bsetup' commands on ICS and you have
606 `ICS Client' selected on the Mode menu. First, you can issue the
607 ICS position-editing commands with the mouse. Move pieces by
608 dragging with mouse button 1. To drop a new piece on a square,
609 press mouse button 2 or 3 over the square. This brings up a menu
610 of white pieces (button 2) or black pieces (button 3). Additional
611 menu choices let you empty the square or clear the board. Click
612 on the White or Black clock to set the side to play. You cannot
613 set the side to play or drag pieces to arbitrary squares while
614 examining on ICC, but you can do so in `bsetup' mode on FICS. In
615 addition, the menu commands `Forward', `Backward', `Pause', and
616 `Stop Examining' have special functions in this mode; see below.
619 Starts a match between two chess programs, with a number of games
620 and other parameters set through the `Match Options' menu dialog.
621 When a match is already running, selecting this item will make
622 XBoard drop out of match mode after the current game finishes.
625 Pauses updates to the board, and if you are playing against a
626 chess engine, also pauses your clock. To continue, select `Pause'
627 again, and the display will automatically update to the latest
628 position. The `P' button and keyboard `Pause' key are equivalents.
630 If you select Pause when you are playing against a chess engine and
631 it is not your move, the chess engine's clock will continue to run
632 and it will eventually make a move, at which point both clocks
633 will stop. Since board updates are paused, however, you will not
634 see the move until you exit from Pause mode (or select Forward).
635 This behavior is meant to simulate adjournment with a sealed move.
637 If you select Pause while you are observing or examining a game on
638 a chess server, you can step backward and forward in the current
639 history of the examined game without affecting the other observers
640 and examiners, and without having your display jump forward to the
641 latest position each time a move is made. Select Pause again to
642 reconnect yourself to the current state of the game on ICS.
644 If you select `Pause' while you are loading a game, the game stops
645 loading. You can load more moves manually by selecting `Forward',
646 or resume automatic loading by selecting `Pause' again.
652 Accepts a pending match offer. The `F3' key is a keyboard
653 equivalent. If there is more than one offer pending, you will
654 have to type in a more specific command instead of using this menu
658 Declines a pending offer (match, draw, adjourn, etc.). The `F4'
659 key is a keyboard equivalent. If there is more than one offer
660 pending, you will have to type in a more specific command instead
661 of using this menu choice.
664 Calls your opponent's flag, claiming a win on time, or claiming a
665 draw if you are both out of time. The `F5' key is a keyboard
666 equivalent. You can also call your opponent's flag by clicking on
670 Offers a draw to your opponent, accepts a pending draw offer from
671 your opponent, or claims a draw by repetition or the 50-move rule,
672 as appropriate. The `F6' key is a keyboard equivalent.
675 Asks your opponent to agree to adjourning the current game, or
676 agrees to a pending adjournment offer from your opponent. The
677 `F7' key is a keyboard equivalent.
680 Asks your opponent to agree to aborting the current game, or
681 agrees to a pending abort offer from your opponent. The `F8' key
682 is a keyboard equivalent. An aborted game ends immediately without
683 affecting either player's rating.
686 Resigns the game to your opponent. The `F9' key is a keyboard
690 Ends your participation in observing a game, by issuing the ICS
691 observe command with no arguments. ICS mode only. The `F10' key
692 is a keyboard equivalent.
695 Ends your participation in examining a game, by issuing the ICS
696 unexamine command. ICS mode only. The `F11' key is a keyboard
700 Create an examined game of the proper variant on the ICS, and send
701 the game there that is currenty loaded in XBoard (e.g. through
702 pasting or loading from file). You must be connected to an ICS
708 Terminate an ongoing game in Two-Machines mode (including match
709 mode), with as result a win for white, for black, or a draw,
710 respectively. The PGN file of the game will accompany the result
711 string by the comment "user adjudication".
717 Pops up a dialog where you can select or specify an engine to be
718 loaded. You will always have to indicate whether you want to load
719 the engine as first or second engine, through the ‘Load
720 menitioned engine as’ drop-down list at the bottom of the dialog.
721 You can even replace engines during a game, without disturbing
722 that game. (Beware that after loading an engine, XBoard will
723 always be in Edit Game mode, so you will have to tell the new
724 engine what to do before it does anything!) When you select an
725 already installed engine from the ‘Select Engine from List’
726 drop-down list, all other fields of the dialog will be ignored.
727 In other cases, you have to specify the engine executable,
728 possible arguments on the engine command line (if the engine docs
729 say the engine needs any), and the directory where the engine
730 should look for its files (if this cannot be deduced automatically
731 from the specification of the engine executable). You will also
732 have to specify (with the aid of checkboxes) if the engine is UCI.
733 If ‘Add this engine to the list’ is ticked (which it is by
734 default), the engine will be added to the list of installed
735 engines in your settings file, (provided you save the settings!),
736 so that next time you can select it from the drop-down list. You
737 can also specify a ‘nickname’, under which the engine will
738 then appear in that drop-down list, and even choose to use that
739 nickname for it in PGN files for engine-engine games. The info
740 you supply with the checkboxes whether the engine should use GUI
741 book, or (for variant engines) automatically switch to the current
742 variant when loaded, will also be included in the list. For
743 obsolete XBoard engines, which would normally take a long delay to
744 load because XBoard is waiting for a response they will not give,
745 you can tick ‘WB protocol v1’ to speed up the loading process.
748 Pop up a menu dialog to alter the settings specific to the
749 applicable engine. (The second engine is only accessible once it
750 has been used in Two-Machines mode.) For each parameter the
751 engine allows to be set, a control element will appear in this
752 dialog that can be used to alter the value. Depending on the type
753 of parameter (text string, number, multiple choice, on/off switch,
754 instantaneous signal) the appropriate control will appear, with a
755 description next to it. XBoard has no idea what these values
756 mean; it just passes them on to the engine. How this dialog looks
757 is completely determined by the engine, and XBoard just passes it
758 on to the user. Many engines do not have any parameters that can
759 be set by the user, and in that case the dialog will be empty
760 (except for the OK and cancel buttons). UCI engines usually have
761 many parameters. (But these are only visible with a sufficiently
762 modern version of the Polyglot adapter needed to run UCI engines,
763 e.g. Polyglot 1.4.55b.) For native XBoard engines this is less
767 Displays a move hint from the chess engine.
770 Displays a list of possible moves from the chess engine's opening
771 book. The exact format depends on what chess engine you are using.
772 With GNU Chess 4, the first column gives moves, the second column
773 gives one possible response for each move, and the third column
774 shows the number of lines in the book that include the move from
775 the first column. If you select this option and nothing happens,
776 the chess engine is out of its book or does not support this
780 Forces the chess engine to move immediately. Chess engine mode
781 only. The `Ctrl-M' key is a keyboard equivalent.
784 Retracts your last move. In chess engine mode, you can do this only
785 after the chess engine has replied to your move; if the chess
786 engine is still thinking, use `Move Now' first. In ICS mode,
787 `Retract Move' issues the command `takeback 1' or `takeback 2'
788 depending on whether it is your opponent's move or yours. The
789 `Ctrl-X' key is a keyboard equivalent.
791 Recently Used Engines
792 At the bottom of the engine menu there can be a list of names of
793 engines that you recently loaded through the Load Engine menu
794 dialog in previous sessions. Clicking on such a name will load
795 that engine as first engine, so you won't have to search for it in
796 your list of installed engines, if that is very long. The maximum
797 number of displayed engine names is set by the
798 `recentEngines'command-line option.
804 The following items to set option values appear in the dialog
805 summoned by the general Options menu item.
807 Absolute Analysis Scores
808 Controls if scores on the Engine Output window during analysis
809 will be printed from the white or the side-to-move point-of-view.
812 If this option is on, 7th-rank pawns automatically change into
813 Queens when you pick them up, and when you drag them to the
814 promotion square and release them there, they will promote to that.
815 But when you drag such a pawn backwards first, its identity will
816 start to cycle through the other available pieces. This will
817 continue until you start to move it forward; at which point the
818 identity of the piece will be fixed, so that you can safely put it
819 down on the promotion square. If this option is off, what happens
820 depends on the option `alwaysPromoteToQueen', which would force
821 promotion to Queen when true. Otherwise XBoard would bring up a
822 dialog box whenever you move a pawn to the last rank, asking what
823 piece you want to promote to.
826 If Animate Dragging is on, while you are dragging a piece with the
827 mouse, an image of the piece follows the mouse cursor. If Animate
828 Dragging is off, there is no visual feedback while you are
829 dragging a piece, but if Animate Moving is on, the move will be
830 animated when it is complete.
833 If Animate Moving is on, all piece moves are animated. An image
834 of the piece is shown moving from the old square to the new square
835 when the move is completed (unless the move was already animated
836 by Animate Dragging). If Animate Moving is off, a moved piece
837 instantly disappears from its old square and reappears on its new
838 square when the move is complete. The shifted `Ctrl-A' key is a
842 If this option is on and one player runs out of time before the
843 other, XBoard will automatically call his flag, claiming a win on
844 time. The shifted `Ctrl-F' key is a keyboard equivalent. In ICS
845 mode, Auto Flag will only call your opponent's flag, not yours,
846 and the ICS may award you a draw instead of a win if you have
847 insufficient mating material. In local chess engine mode, XBoard
848 may call either player's flag and will not take material into
852 If the Auto Flip View option is on when you start a game, the board
853 will be automatically oriented so that your pawns move from the
854 bottom of the window towards the top.
856 If you are playing a game on an ICS, the board is always oriented
857 at the start of the game so that your pawns move from the bottom
858 of the window towards the top. Otherwise, the starting orientation
859 is determined by the `flipView' command line option; if it is
860 false (the default), White's pawns move from bottom to top at the
861 start of each game; if it is true, Black's pawns move from bottom
862 to top. *Note User interface options::.
865 If this option is on, XBoard displays the board as usual but does
866 not display pieces or move highlights. You can still move in the
867 usual way (with the mouse or by typing moves in ICS mode), even
868 though the pieces are invisible.
871 Controls if right-clicking the board in crazyhouse / bughouse will
872 pop up a menu to drop a piece on the clicked square (old,
873 deprecated behavior) or allow you to step through an engine PV
874 (new, recommended behavior).
877 If this option is off, the chess engine's notion of the score and
878 best line of play from the current position is displayed as it is
879 thinking. The score indicates how many pawns ahead (or if negative,
880 behind) the chess engine thinks it is. In matches between two
881 machines, the score is prefixed by `W' or `B' to indicate whether
882 it is showing White's thinking or Black's, and only the thinking
883 of the engine that is on move is shown. The shifted `Ctrl-H' key
884 is a keyboard equivalent.
887 If Highlight Last Move is on, after a move is made, the starting
888 and ending squares remain highlighted. In addition, after you use
889 Backward or Back to Start, the starting and ending squares of the
890 last move to be unmade are highlighted.
893 Causes the highlighting described in Highlight Last Move to be done
894 by drawing an arrow between the highlighted squares, so that it is
895 visible even when the width of the grid lines is set to zero.
898 Enables the sounding of an audible signal when the computer
899 performs a move. For the selection of the sound, see `Sound
900 Options'. If you turn on this option when using XBoard with the
901 Internet Chess Server, you will probably want to give the `set
902 bell 0' command to the ICS, since otherwise the ICS will ring the
903 terminal bell after every move (not just yours). (The `.icsrc' file
904 is a good place for this; see *note ICS options::.)
907 If this option is on, XBoard does not wait for you to click both
908 the from- and the to-square, or drag the piece, but performs a
909 move as soon as it is uniqely specified. This applies to clicking
910 an own piece that only has a single legal move, clicking an empty
911 square or opponent piece where only one of your pieces can move
912 (or capture) to. Furthermore, a double-click on a piece that can
913 only make a single capture will cause that capture to be made.
914 Promoting a Pawn by clicking its to-square will suppress the
915 promotion popup or other methods for selecting an under-promotion,
916 and make it promote to Queen.
919 If this option is off (or if you are using a chess engine that
920 does not support periodic updates), the analysis window will only
921 be updated when the analysis changes. If this option is on, the
922 Analysis Window will be updated every two seconds.
925 If this option is off, the chess engine will think only when it is
926 on move. If the option is on, the engine will also think while
927 waiting for you to make your move. The shifted `Ctrl-P' key is a
931 If this option is on, when XBoard wants to display a message just
932 before exiting, it brings up a modal dialog box and waits for you
933 to click OK before exiting. If the option is off, XBoard prints
934 the message to standard error (the terminal) and exits immediately.
937 If this option is off, when you make an error in moving (such as
938 attempting an illegal move or moving the wrong color piece), the
939 error message is displayed in the message area. If the option is
940 on, move errors are displayed in small pop-up windows like other
941 errors. You can dismiss an error pop-up either by clicking its OK
942 button or by clicking anywhere on the board, including
943 down-clicking to start a move.
946 If this option is on, XBoard will display the depth and score of
947 engine moves in the Move List, in the format of a PGN comment.
950 If this option is on, XBoard displays algebraic coordinates along
951 the board's left and bottom edges.
954 If this option is on, all squares a piece that is 'picked up' with
955 the mouse can legally move to are highighted with a fat colored
956 dot in the highlightColor (non-captures) or premoveHighlightColor
957 (captures). Legality testing must be on for XBoard to know how
961 If this option is on, XBoard tests whether the moves you try to
962 make with the mouse are legal and refuses to let you make an
963 illegal move. The shifted `Ctrl-L' key is a keyboard equivalent.
964 Moves loaded from a file with `Load Game' are also checked. If
965 the option is off, all moves are accepted, but if a local chess
966 engine or the ICS is active, they will still reject illegal moves.
967 Turning off this option is useful if you are playing a chess
968 variant with rules that XBoard does not understand. (Bughouse,
969 suicide, and wild variants where the king may castle after
970 starting on the d file are generally supported with Test Legality
975 If this option is non-zero, whenever a move is completed, the
976 moved piece flashes the specified number of times. The flash-rate
977 setting determines how rapidly this flashing occurs.
980 Determines the duration (in msec) of an animation step, when
981 `Animate Moving' is swiched on.
983 Zoom factor in Evaluation Graph
984 Sets the valueof the `evalZoom' option, indicating the factor by
985 which the score interval (-1,1) should be blown up on the vertical
986 axis of the Evaluation Graph.
989 Pops up a sub-menu where you can set the time-control parameters
990 interactively. Allows you to select classical or incremental time
991 controls, set the moves per session, session duration, and time
992 increment. Also allows specification of time-odds factors for one
993 or both engines. If an engine is given a time-odds factor N, all
994 time quota it gets, be it at the beginning of a session or through
995 the time increment or fixed time per move, will be divided by N.
996 The shifted `Alt+T' key is a keyboard equivalent.
999 Pops up a sub-menu where you can set some engine parameters common
1000 to most engines, such as hash-table size, tablebase cache size,
1001 maximum number of processors that SMP engines can use, and where
1002 to find the Polyglot adapter needed to run UCI engines under
1003 XBoard. The feature that allows setting of these parameters on
1004 engines is new since XBoard 4.3.15, so not many XBoard/WinBoard
1005 engines respond to it yet, but UCI engines should.
1007 It is also possible to specify a GUI opening book here, i.e. an
1008 opening book that XBoard consults for any position a playing
1009 engine gets in. It then forces the engine to play the book move,
1010 rather than to think up its own, if that position is found in the
1011 book. The book can switched on and off independently for either
1012 engine. The way book moves are chosen can be influenced through
1013 the settings of book depth and variety. After both sides have
1014 played more moves than the specified depth, the book will no
1015 longer be consulted. When the variety is set to 50, moves will be
1016 played with the probability specified in the book. When set to 0,
1017 only the move(s) with the highest probability will be played.
1018 When set to 100, all listed moves will be played with equal
1019 pobability. Other settings interpolate between that. The shifted
1020 `Alt+U' key is a keyboard equivalent.
1023 Pops up a sub-menu where you can enable or disable various
1024 adjudications that XBoard can perform in engine-engine games. The
1025 shifted `Alt+J' key is a keyboard equivalent. You can instruct
1026 XBoard to detect and terminate the game on checkmate or stalemate,
1027 even if the engines would not do so, to verify engine result
1028 claims (forfeiting engines that make false claims), rather than
1029 naively following the engine, to declare draw on positions which
1030 can never be won for lack of mating material, (e.g. KBK), or which
1031 are impossible to win unless the opponent seeks its own demise
1032 (e.g. KBKN). For these adjudications to work, `Test Legality'
1033 should be switched on. It is also possible to instruct XBoard to
1034 enforce a 50-move or 3-fold-repeat rule and automatically declare
1035 draw (after a user-adjustable number of moves or repeats) even if
1036 the engines are prepared to go on. It is also possible to have
1037 XBoard declare draw on games that seem to drag on forever, or
1038 adjudicate a loss if both engines agree (for 3 consecutive moves)
1039 that one of them is behind more than a user-adjustable score
1040 threshold. For the latter adjudication to work, XBoard should be
1041 able to properly understand the engine's scores. To facilitate the
1042 latter, you can inform xboard here if the engines report scores
1043 from the viewpoint of white, or from that of their own color.
1046 The following options occur in a dialog summoned by the ICS
1050 Setting this option when playing with or aginst a chess program on
1051 an ICS will cause the last line of thinking output of the engine
1052 before its move to be sent to the ICS in a kibitz command. In
1053 addition, any kibitz message received through the ICS from an
1054 opponent chess program will be diverted to the engine-output
1055 window, (and suppressed in the console), where you can play
1056 through its PV by right-clicking it.
1059 If this option is on, any remarks made on ICS while you are
1060 observing or playing a game are recorded as a comment on the
1061 current move. This includes remarks made with the ICS commands
1062 `say', `tell', `whisper', and `kibitz'. Limitation: remarks that
1063 you type yourself are not recognized; XBoard scans only the output
1064 from ICS, not the input you type to it.
1067 If this option is on and you add a player to your `gnotify' list
1068 on ICS, XBoard will automatically observe all of that player's
1069 games, unless you are doing something else (such as observing or
1070 playing a game of your own) when one starts. The games are
1071 displayed from the point of view of the player on your gnotify
1072 list; that is, his pawns move from the bottom of the window
1073 towards the top. Exceptions: If both players in a game are on
1074 your gnotify list, if your ICS `highlight' variable is set to 0,
1075 or if the ICS you are using does not properly support observing
1076 from Black's point of view, you will see the game from White's
1080 If this option is on, whenever a new game begins, the chessboard
1081 window is deiconized (if necessary) and raised to the top of the
1085 If this option is true, at the end of every game XBoard prompts
1086 you for a file name and appends a record of the game to the file
1087 you specify. Disabled if the `saveGameFile' command-line option
1088 is set, as in that case all games are saved to the specified file.
1089 *Note Load and Save options::.
1092 Setting this option will make XBoard suppress display of any boards
1093 from observed games while you are playing. In stead the last such
1094 board will be remembered, and shown to you when you right-click
1095 the board. This allows you to peek at your bughouse partner's
1096 game when you want, without disturbing your own game too much.
1099 Setting this option in combination with `Background Observe' will
1100 display boards of observed games while you are playing on a second
1101 board next to that of your own game.
1104 If this option is on, whenever XBoard receives the first board of
1105 a new ICS game (or a different game from the one it is currently
1106 displaying), it retrieves the list of past moves from the ICS.
1107 You can then review the moves with the `Forward' and `Backward'
1108 commands or save them with `Save Game'. You might want to turn
1109 off this option if you are observing several blitz games at once,
1110 to keep from wasting time and network bandwidth fetching the move
1111 lists over and over. When you turn this option on from the menu,
1112 XBoard immediately fetches the move list of the current game (if
1116 If this option is on, XBoard will automatically issue an ICS `set
1117 shout 0' command whenever you start a game and a `set shout 1'
1118 command whenever you finish one. Thus, you will not be distracted
1119 by shouts from other ICS users while playing.
1122 Setting this option will cause XBoard to display an graph of
1123 currently active seek ads when you left-click the board while idle
1124 and logged on to an ICS.
1126 Auto-Refresh Seek Graph
1127 In combination with the `Seek Graph' option this will cause
1128 automatic update of the seek graph while it is up. This only
1129 works on FICS and ICC, and requires a lot of bandwidth on a busy
1137 If this option is on while playing a game on an ICS, you can
1138 register your next planned move before it is your turn. Move the
1139 piece with the mouse in the ordinary way, and the starting and
1140 ending squares will be highlighted with a special color (red by
1141 default). When it is your turn, if your registered move is legal,
1142 XBoard will send it to ICS immediately; if not, it will be ignored
1143 and you can make a different move. If you change your mind about
1144 your premove, either make a different move, or double-click on any
1145 piece to cancel the move entirely.
1147 You can also enter premoves for the first white and black moves of
1152 When this option is on, an alarm sound is played when your clock
1153 counts down to the icsAlarmTime in an ICS game. (By default, the
1154 time is 5 seconds, but you can pecify other values with the Alarm
1155 Time spin control.) For games with time controls that include an
1156 increment, the alarm will sound each time the clock counts down to
1157 the icsAlarmTime. By default, the alarm sound is the terminal
1158 bell, but on some systems you can change it to a sound file using
1159 the soundIcsAlarm option; see below.
1162 Ticking this options causes various types of ICS messages do be
1163 displayed with different foreground or background colors in the
1164 console. The colors can be individually selected for each type,
1165 through the accompanying text edits.
1168 Summons a dialog where you can set options important for playing
1169 automatic matches between two chess programs (e.g. by using the
1170 `Machine Match' menu item in the `Mode' menu).
1173 To run a tournament, XBoard needs a file to record its progress,
1174 so it can resume the tourney when it is interrupted. When you
1175 want to conduct anything more complex than a simple two-player
1176 match with the currently loaded engines, (i.e. when you select a
1177 list of participants), you must not leave this field blank. When
1178 you enter the name of an existing tournament file, XBoard will
1179 ignore all other input specified in the dialog, and will take them
1180 from that tournament file. This resumes an interrupted
1181 tournament, or adds another XBoard agent playing games for it to
1182 those that are already doing so. Specifying a not-yet-existing
1183 file will cause XBoard to create it, according to the tournament
1184 parameters specified in the rest of the dialog, before it starts
1185 the tournament on ‘OK’. Provided that you specify
1186 participants; without participants no tournament file will be
1187 made, but other entered values (e.g. for the file with opening
1188 positions) will take effect. Default: configured by the
1189 `defaultTourneyName' option.
1193 The sync options, when on, will cause WinBoard to refrain from
1194 starting games of the next round or cycle before all games of the
1195 previous round or cycle are finished. This guarantees correct
1196 ordering in the games file, even when multiple XBoard instances
1197 are concurrently playing games for the same tourney. Default:
1198 sync after cycle, but not after round.
1201 Tourney participants
1202 With the Select Engine drop-down list you can pick an engine from
1203 your list of installed engines in the settings file, to be added
1204 to the tournament. The engines selected so far will be listed in
1205 the ‘Tourney participants’ memo. The latter is a normal text
1206 edit, so you can use normal text-editing functions to delete
1207 engines you selected by accident, or change their order. Do not
1208 type names yourself there, because names that do not exactly match
1209 one of the names from the drop-down list will lead to undefined
1213 Here you can specify the type of tournament you want. XBoard’s
1214 intrinsic tournament manager support round-robins (type = 0),
1215 where each participant plays every other participant, and
1216 (multi-)gauntlets, where one (or a few) so-called ‘gauntlet
1217 engines’ play an independent set of opponents. In the latter
1218 case, you specify the number of gauntlet engines. E.g. if you
1219 specified 10 engines, and tourney type = 2, the first 2 engines
1220 each play the remaining 8. A value of -1 instructs XBoard to play
1221 Swiss; for this to work an external pairing engine must be
1222 specified through the `pairingEngine' option. Each Swiss round
1223 will be considered a tourney cycle in that case. Default:0
1225 Number of tourney cycles
1226 Default number of Games
1227 You can specify tourneys where every two opponents play each other
1228 multiple times. Such multiple games can be played in a row, as
1229 specified by the ‘number of games per pairing’, or by
1230 repeating the entire tournament schedule a number of times
1231 (specified by the ‘number of tourney cycles’). The total
1232 number of times two engine meet will be the product of these two.
1233 Default is 1 cycle; the number of games per pairing is the same as
1234 the default number of match games, stored in your settings file
1235 through the `defaultMatchGames' option.
1238 File where the tournament games are saved (duplicate of the item
1239 in the `Save Game Options').
1241 Game File with Opening Lines
1242 File with Start Positions
1246 These items optionally specify the file with move sequences or
1247 board positions the tourney games should start from. The
1248 corresponding numbers specify the number of the game or position
1249 in the file. Here a value -1 means automatic stepping through all
1250 games on the file, -2 automatic stepping every two games. The
1251 Rewind-Index parameter causes a stepping index to reset to one
1252 after reaching a specified value. A setting of -2 for the game
1253 number will also be effective in a tournament without specifying a
1254 game file, but playing from the GUI book instead. In this case
1255 the first (odd) games will randomly select from the book, but the
1256 second (even) games will select the same moves from the book as
1257 the previous game. (Note this leads to the same opening only if
1258 both engines use the GUI book!) Default: No game or position file
1259 will be used. The default index if such a file is used is 1.
1261 Disable own engine bools be default
1262 Setting this option reverses the default situation for use of the
1263 GUI opening book in tournaments from what it normally is, namely
1264 not using it. So unless the engine is installed with an option to
1265 explicitly specify it should not use the GUI book (i.e.
1266 `-firstHasOwnBookUCI true'), it will be made to use the GUI book.
1270 With these two buttons you can alter the participants of an
1271 already running tournament. After opening the Match Options
1272 dialog on an XBoard that is playing for the tourney, you will see
1273 all the tourney parameters in the dialog fields. You can then
1274 replace the name of one engine by that of another by editing the
1275 `participants' field. (But preserve the order of the others!)
1276 Pressing the button after that will cause the substitution. With
1277 the `Upgrade Engine' button the substitution will only affect
1278 future games. With `Replace Engine' all games the substituted
1279 engine has already played will be invalidated, and they will be
1280 replayed with the substitute engine. In this latter case the
1281 engine must not be playing when you do this, but otherwise there
1282 is no need to pause the tournament play for making a substitution.
1285 Pressing this button after you have specified an existing
1286 tournament file will copy the contents of the latter to the dialog,
1287 and then puts the originally proposed name for the tourney file
1288 back. You can then run a tourney with the same parameters
1289 (possibly after changing the proposed name of the tourney file for
1290 the new tourney) by pressing 'OK'.
1293 Summons a dialog where you can set the `autoDisplayComment' and
1294 `autoDisplayTags' options, (which control popups when viewing
1295 loaded games), and specify the rate at which loaded games are
1296 auto-played, in seconds per move (which can be a fractional
1297 number, like 1.6). You can also set search criteria for
1298 determining which games will be displayed in the Game List for a
1299 multi-game file, and thus be eligible for loading:
1301 Elo of strongest player
1302 Elo of weakest player
1304 These numeric fields set thresholds (lower limits) on the Elo
1305 rating of the mentioned player, or the date the game was played.
1309 This setting determines which positions in a game will be
1310 considered a match to the position currently displayed in the
1311 board window when you press the `find position' button in the Game
1312 List. You can search for an exact match, a position that has all
1313 shown material in the same place, but might contain additional
1314 material, a position that has all Pawns in the same place, but can
1315 have the shown material anywhere, a position that can have all
1316 shown material anywhere, or a position that has material between
1317 certain limits anywhere. For the latter you have to place the
1318 material that must be present in the four lowest ranks of the
1319 board, and optional additional material in the four highest ranks
1320 of the board. You can request the optional material to be
1323 number of consecutive positions
1324 When you are searching by material, rather than for an exact match,
1325 this parameter indicates forhowmany consecutive game positions the
1326 same amount of material must be on the board before it is
1329 Also match reversed colors
1330 Also match left-right flipped position
1331 When looking for matching positions rather than by material, these
1332 settings determine whether mirror images (in case of a vertical
1333 flip in combination with color reversal) will be also considered a
1334 match. The left-right flipping is only useful after all castling
1335 rights have expired (or in Xiangqi).
1338 Summons a dialog where you can specify the files on which XBoard
1339 should automtically save any played or entered games, (the
1340 `saveGameFile' option), or the final position of such games (the
1341 `savePositionfile' option). You can also select 'auto-save'
1342 without a file name, in which case XBoard will prompt the user for
1343 a file name after each game. You can also set the default value
1344 for the PGN Event tag that will be used for each new game you
1345 start. Various options for the format of the game can be
1346 specified as well, such as whether scores and depths of engine
1347 games should be saved as comments, and if a tag with info about
1348 the score with which the engine came out of book should be
1349 included. For Chess, always set the format to PGN, rather than
1353 Pops up a dialog where you can select the PGN tags that should
1354 appear on the lines in the game list, and their order.
1357 Summons a dialog where you can specify the sounds that should
1358 accompany various events that can occur XBoard. Most events are
1359 only relevant to ICS play, but the move sound is an important
1360 exception. For each event listed in the dialog, you can select a
1361 standard sound from a menu. You can also select a user-supplied
1362 sound file, by typing its name into the designated text-edit field
1363 first, and then selecting "Above WAV File" from the menu for the
1364 event. A dummy event has been provided for trying out the sounds
1365 with the "play" button next to it. The directory with standard
1366 sounds, and the external program for playing the sounds can be
1367 specified too, but normally you would not touch these once XBoard
1368 is properly installed. When a move sound other than 'None' is
1369 selected, XBoard alerts you by playing that sound after each of
1370 your opponent's moves (or after every move if you are observing a
1371 game on the Internet Chess Server). The sound is not played after
1372 moves you make or moves read from a saved game file.
1375 Selecting this menu item causes the current XBoard settings to be
1376 written to the settings file, so they will also apply in future
1377 sessions. Note that some settings are 'volatile', and are not
1378 saved, because XBoard considers it too unlikely that you want
1379 those to apply next time. In particular this applies to the Chess
1380 program names, and all options giving information on those Chess
1381 programs (such as their directory, if they have their own opening
1382 book, if they are UCI or native XBoard), or the variant you are
1383 playing. Such options would still be understood when they appear
1384 in the settings file in case they were put there with the aid of a
1385 text editor, but they would disappear from the file as soon as you
1388 Save Settings on Exit
1389 Setting this option has no immediate effect, but causes the
1390 settings to be saved when you quit XBoard. What happens then is
1391 otherwise identical to what happens when you use select "Save
1392 Settings Now", see there.
1398 Displays the XBoard documentation in info format. For this
1399 feature to work, you must have the GNU info program installed on
1400 your system, and the file `xboard.info' must either be present in
1401 the current working directory, or have been installed by the `make
1402 install' command when you built XBoard.
1405 Displays the XBoard documentation in man page format. The `F1'
1406 key is a keyboard equivalent. For this feature to work, the file
1407 `xboard.6' must have been installed by the `make install' command
1408 when you built XBoard, and the directory it was placed in must be
1409 on the search path for your system's `man' command.
1412 Shows the current XBoard version number.
1414 3.9 Other Shortcut Keys
1415 =======================
1418 By hitting `Enter' the last move will be re-animated.
1421 Loads the next game from the last game record file you loaded.
1422 The `Alt+PgDn' key triggers this action.
1425 Loads the previous game from the last game record file you loaded.
1426 The `Alt+PgUp' key triggers this action. Not available if the
1427 last game was loaded from a pipe.
1430 Reloads the last game you loaded. Not available if the last game
1431 was loaded from a pipe. Currently no keystroke is assigned to
1432 this ReloadGameProc.
1434 Reload Same Position
1435 Reloads the last position you loaded. Not available if the last
1436 position was loaded from a pipe. Currently no keystroke is
1437 assigned to this ReloadPositionProc.
1439 You can add or remove shortcut keys using the X resources
1440 `form.translations'. Here is an example of what would go in your
1443 XBoard*form.translations: \
1444 Shift<Key>?: AboutGameProc() \n\
1445 <Key>y: AcceptProc() \n\
1446 <Key>n: DeclineProc() \n\
1447 <Key>i: NothingProc()
1448 Binding a key to `NothingProc' makes it do nothing, thus removing it
1449 as a shortcut key. The XBoard commands that can be bound to keys are:
1451 AbortProc, AboutGameProc, AboutProc, AcceptProc, AdjournProc,
1452 AlwaysQueenProc, AnalysisModeProc, AnalyzeFileProc,
1453 AnimateDraggingProc, AnimateMovingProc, AutobsProc, AutoflagProc,
1454 AutoflipProc, AutoraiseProc, AutosaveProc, BackwardProc,
1455 BlindfoldProc, BookProc, CallFlagProc, CopyGameProc, CopyPositionProc,
1456 DebugProc, DeclineProc, DrawProc, EditCommentProc, EditGameProc,
1457 EditPositionProc, EditTagsProc, EnterKeyProc, FlashMovesProc,
1458 FlipViewProc, ForwardProc, GetMoveListProc, HighlightLastMoveProc,
1459 HintProc, IcsAlarmProc, IcsClientProc, IcsInputBoxProc,
1460 InfoProc, LoadGameProc, LoadNextGameProc, LoadNextPositionProc,
1461 LoadPositionProc, LoadPrevGameProc, LoadPrevPositionProc,
1462 LoadSelectedProc, MachineBlackProc, MachineWhiteProc, MailMoveProc,
1463 ManProc, MoveNowProc, MoveSoundProc, NothingProc, OldSaveStyleProc,
1464 PasteGameProc, PastePositionProc, PauseProc, PeriodicUpdatesProc,
1465 PonderNextMoveProc, PopupExitMessageProc, PopupMoveErrorsProc,
1466 PremoveProc, QuietPlayProc, QuitProc, ReloadCmailMsgProc,
1467 ReloadGameProc, ReloadPositionProc, RematchProc, ResetProc,
1468 ResignProc, RetractMoveProc, RevertProc, SaveGameProc,
1469 SavePositionProc, ShowCoordsProc, ShowGameListProc, ShowThinkingProc,
1470 StopExaminingProc, StopObservingProc, TestLegalityProc, ToEndProc,
1471 ToStartProc, TrainingProc, TruncateGameProc, and TwoMachinesProc.
1476 This section documents the command-line options to XBoard. You can set
1477 these options in two ways: by typing them on the shell command line you
1478 use to start XBoard, or by editing the settings file (usually
1479 ~/.xboardrc) to alter the value of the setting that was saved there.
1480 Some of the options cannot be changed while XBoard is running; others
1481 set the initial state of items that can be changed with the *note
1484 Most of the options have both a long name and a short name. To turn a
1485 boolean option on or off from the command line, either give its long
1486 name followed by the value true or false (`-longOptionName true'), or
1487 give just the short name to turn the option on (`-opt'), or the short
1488 name preceded by `x' to turn the option off (`-xopt'). For options that
1489 take strings or numbers as values, you can use the long or short option
1490 names interchangeably.
1492 4.1 Chess Engine Options
1493 ========================
1495 -tc or -timeControl minutes[:seconds]
1496 Each player begins with his clock set to the `timeControl' period.
1497 Default: 5 minutes. The additional options `movesPerSession' and
1498 `timeIncrement' are mutually exclusive.
1500 -mps or -movesPerSession moves
1501 When both players have made `movesPerSession' moves, a new
1502 `timeControl' period is added to both clocks. Default: 40 moves.
1504 -inc or -timeIncrement seconds
1505 If this option is specified, `movesPerSession' is ignored.
1506 Instead, after each player's move, `timeIncrement' seconds are
1507 added to his clock. Use `-inc 0' if you want to require the entire
1508 game to be played in one `timeControl' period, with no increment.
1509 Default: -1, which specifies `movesPerSession' mode.
1511 -clock/-xclock or -clockMode true/false
1512 Determines whether or not to display the chess clocks. If
1513 clockMode is false, the clocks are not shown, but the side that is
1514 to play next is still highlighted. Also, unless `searchTime' is
1515 set, the chess engine still keeps track of the clock time and uses
1516 it to determine how fast to make its moves.
1518 -st or -searchTime minutes[:seconds]
1519 Tells the chess engine to spend at most the given amount of time
1520 searching for each of its moves. Without this option, the chess
1521 engine chooses its search time based on the number of moves and
1522 amount of time remaining until the next time control. Setting
1523 this option also sets clockMode to false.
1525 -depth or -searchDepth number
1526 Tells the chess engine to look ahead at most the given number of
1527 moves when searching for a move to make. Without this option, the
1528 chess engine chooses its search depth based on the number of moves
1529 and amount of time remaining until the next time control. With
1530 the option, the engine will cut off its search early if it reaches
1531 the specified depth.
1535 Tells the chess engine to use an internal time standard based on
1536 its node count, rather then wall-clock time, to make its timing
1537 decisions. The time in virtual seconds should be obtained by
1538 dividing the node count through the given number, like the number
1539 was a rate in nodes per second. Xboard will manage the clocks in
1540 accordance with this, relying on the number of nodes reported by
1541 the engine in its thinking output. If the given number equals zero,
1542 it can obviously not be used to convert nodes to seconds, and the
1543 time reported by the engine is used to decrement the XBoard clock
1544 in stead. The engine is supposed to report in CPU time it uses,
1545 rather than wall-clock time, in this mode. This option can provide
1546 fairer conditions for engine-engine matches on heavily loaded
1547 machines, or with very fast games (where the wall clock is too
1548 inaccurate). `showThinking' must be on for this option to work.
1549 Default: -1 (off). Not many engines might support this yet!
1551 -firstTimeOdds factor
1552 -secondTimeOdds factor
1553 Reduces the time given to the mentioned engine by the given factor.
1554 If pondering is off, the effect is indistinguishable from what
1555 would happen if the engine was running on an n-times slower
1556 machine. Default: 1.
1559 This option determines how the case is handled where both engines
1560 have a time-odds handicap. If mode=1, the engine that gets the
1561 most time will always get the nominal time, as specified by the
1562 time-control options, and its opponent's time is renormalized
1563 accordingly. If mode=0, both play with reduced time. Default: 0.
1565 -hideThinkingFromHuman true/false
1566 Controls the Hide Thinking option. *Note Options Menu::. Default:
1567 true. (Replaces the Show-Thinking option of older xboard
1570 -thinking/-xthinking or -showThinking true/false
1571 Forces the engine to send thinking output to xboard. Used to be
1572 the only way to control if thinking output was displayed in older
1573 xboard versions, but as the thinking output in xboard 4.3 is also
1574 used for several other purposes (adjudication, storing in PGN
1575 file) the display of it is now controlled by the new option Hide
1576 Thinking. *Note Options Menu::. Default: false. (But if xboard
1577 needs the thinking output for some purpose, it makes the engine
1578 send it despite the setting of this option.)
1580 -ponder/-xponder or -ponderNextMove true/false
1581 Sets the Ponder Next Move menu option. *Note Options Menu::.
1585 Specifies the maximum number of CPUs an SMP engine is allowed to
1586 use. Only works for engines that support the
1587 XBoard/WinBoard-protocol cores feature.
1589 -mg or -matchGames n
1590 Automatically runs an n-game match between two chess engines, with
1591 alternating colors. If the `loadGameFile' or `loadPositionFile'
1592 option is set, XBoard starts each game with the given opening
1593 moves or the given position; otherwise, the games start with the
1594 standard initial chess position. If the `saveGameFile' option is
1595 set, a move record for the match is appended to the specified
1596 file. If the `savePositionFile' option is set, the final position
1597 reached in each game of the match is appended to the specified
1598 file. When the match is over, XBoard displays the match score and
1599 exits. Default: 0 (do not run a match).
1601 -mm/-xmm or -matchMode true/false
1602 Setting `matchMode' to true is equivalent to setting `matchGames'
1606 Automatically runs an n-game match between two chess engines,
1607 without alternating colors. Otherwise the same applies as for the
1608 `-matchGames' option, over which it takes precedence if both are
1609 specified. (See there.) Default: 0 (do not run a match).
1611 -fcp or -firstChessProgram program
1612 Name of first chess engine. Default: `Fairy-Max'.
1614 -scp or -secondChessProgram program
1615 Name of second chess engine, if needed. A second chess engine is
1616 started only in Two Machines (match) mode. Default: `Fairy-Max'.
1618 -fb/-xfb or -firstPlaysBlack true/false
1619 In games between two chess engines, firstChessProgram normally
1620 plays white. If this option is true, firstChessProgram plays
1621 black. In a multi-game match, this option affects the colors only
1622 for the first game; they still alternate in subsequent games.
1624 -fh or -firstHost host
1625 -sh or -secondHost host
1626 Hosts on which the chess engines are to run. The default for each
1627 is `localhost'. If you specify another host, XBoard uses `rsh' to
1628 run the chess engine there. (You can substitute a different remote
1629 shell program for rsh using the `remoteShell' option described
1632 -fd or -firstDirectory dir
1633 -sd or -secondDirectory dir
1634 Working directories in which the chess engines are to be run. The
1635 default is "", which means to run the chess engine in the same
1636 working directory as XBoard itself. (See the CHESSDIR environment
1637 variable.) This option is effective only when the chess engine is
1638 being run on the local host; it does not work if the engine is run
1639 remotely using the -fh or -sh option.
1641 -initString string or -firstInitString
1642 -secondInitString string
1643 The string that is sent to initialize each chess engine for a new
1648 Setting this option from the command line is tricky, because you
1649 must type in real newline characters, including one at the very
1650 end. In most shells you can do this by entering a `\' character
1651 followed by a newline. It is easier to set the option from your
1652 `.Xresources' file; in that case you can include the character
1653 sequence `\n' in the string, and it will be converted to a newline.
1655 If you change this option, don't remove the `new' command; it is
1656 required by all chess engines to start a new game.
1658 You can remove the `random' command if you like; including it
1659 causes GNU Chess 4 to randomize its move selection slightly so
1660 that it doesn't play the same moves in every game. Even without
1661 `random', GNU Chess 4 randomizes its choice of moves from its
1662 opening book. Many other chess engines ignore this command
1663 entirely and always (or never) randomize.
1665 You can also try adding other commands to the initString; see the
1666 documentation of the chess engine you are using for details.
1668 -firstComputerString string
1669 -secondComputerString string
1670 The string that is sent to the chess engine if its opponent is
1671 another computer chess engine. The default is `computer\n'.
1672 Probably the only useful alternative is the empty string (`'),
1673 which keeps the engine from knowing that it is playing another
1676 -reuse/-xreuse or -reuseFirst true/false
1677 -reuse2/-xreuse2 or -reuseSecond true/false
1678 If the option is false, XBoard kills off the chess engine after
1679 every game and starts it again for the next game. If the option
1680 is true (the default), XBoard starts the chess engine only once
1681 and uses it repeatedly to play multiple games. Some old chess
1682 engines may not work properly when reuse is turned on, but
1683 otherwise games will start faster if it is left on.
1685 -firstProtocolVersion version-number
1686 -secondProtocolVersion version-number
1687 This option specifies which version of the chess engine
1688 communication protocol to use. By default, version-number is 2.
1689 In version 1, the "protover" command is not sent to the engine;
1690 since version 1 is a subset of version 2, nothing else changes.
1691 Other values for version-number are not supported.
1693 -firstScoreAbs true/false
1694 -secondScoreAbs true/false
1695 If this option is set, the score reported by the engine is taken
1696 to be that in favor of white, even when the engine plays black.
1697 Important when XBoard uses the score for adjudications, or in PGN
1700 -niceEngines priority
1701 This option allows you to lower the priority of the engine
1702 processes, so that the generally insatiable hunger for CPU time of
1703 chess engines does not interfere so much with smooth operation of
1704 XBoard (or the rest of your system). Negative values could
1705 increase the engine priority, which is not recommended.
1707 -firstOptions string
1708 -secondOptions string
1709 The given string is a comma-separated list of (option name=option
1710 value) pairs, like the following example: "style=Karpov,blunder
1711 rate=0". If an option announced by the engine at startup through
1712 the feature commands of the XBoard/WinBoard protocol matches one
1713 of the option names (i.e. "style" or "blunder rate"), it would be
1714 set to the given value (i.e. "Karpov" or 0) through a
1715 corresponding option command to the engine. This provided that
1716 the type of the value (text or numeric) matches as well.
1718 -firstNeedsNoncompliantFEN string
1719 -secondNeedsNoncompliantFEN string
1720 The castling rights and e.p. fields of the FEN sent to the
1721 mentioned engine with the setboard command will be replaced by the
1722 given string. This can for instance be used to run engines that do
1723 not understand Chess960 FENs in variant fischerandom, to make them
1724 at least understand the opening position, through setting the
1725 string to "KQkq -". (Note you also have to give the e.p. field!)
1726 Other possible applications are to provide work-arounds for
1727 engines that want to see castling and e.p. fields in variants that
1728 do not have castling or e.p. (shatranj, courier, xiangqi, shogi)
1729 so that XBoard would normally omit them (string = "- -"), or to
1730 add variant-specific fields that are not yet supported by XBoard
1731 (e.g. to indicate the number of checks in 3check).
1734 Forces shuffling of the opening setup in variants that normally
1735 have a fixed initial position. Shufflings are symmetric for black
1736 and white, and exempt King and Rooks in variants with normal
1737 castling. Remains in force until a new variant is selected.
1739 4.2 UCI + WB Engine Settings
1740 ============================
1742 -fUCI or -firstIsUCI true/false
1743 -sUCI or -secondIsUCI true/false
1744 Indicates if the mentioned engine executable file is an UCI engine,
1745 and should be run with the aid of the Polyglot adapter rather than
1746 directly. Xboard will then pass the other UCI options and engine
1747 name to Polyglot on its command line, according to the option
1754 Options similar to `fUCI' and `sUCI', except that they use the
1755 indicated engine with the protocol adapter specified in the
1756 `uxiAdapter' option. This can then be configured for running an
1757 UCCI or USI adapter, as the need arises.
1759 -adapterCommand string
1760 The string conatins the command that should be issued by XBoard to
1761 start an engine that is accompanied by the `fUCI' option. Any
1762 identifier following a percent sign in the command (e.g. %fcp)
1763 will be considered the name of an XBoard option, and be replaced
1764 by the value of that option at the time the engine is started.
1765 For starting the second engine, any leading "f" or "first" in the
1766 option name will first be replaced by "s" or "second", before
1767 finding its value. Default: 'polyglot -noini -ec "%fcp" -ed "%fd"'
1770 Similar to `adapterCommand', but used for engines accompanied by
1771 the `fUCCI' or `fUSI' option, so you can configure XBoard to be
1772 ready to handle more than one flavor of non-native protocols.
1775 -polyglotDir filename
1776 Gives the name of the directory in which the Polyglot adapter for
1777 UCI engines resides. Default: "".
1779 -usePolyglotBook true/false
1780 Specifies if the Polyglot book should be used as GUI book.
1782 -polyglotBook filename
1783 Gives the filename of the opening book. The book is only used
1784 when the `usePolyglotBook' option is set to true, and the option
1785 `firstHasOwnBookUCI' or `secondHasOwnBookUCI' applying to the
1786 engine is set to false. The engine will be kept in force mode as
1787 long as the current position is in book, and XBoard will select
1788 the book moves for it. Default: "".
1790 -fNoOwnBookUCI or -firstXBook or -firstHasOwnBookUCI true/false
1791 -sNoOwnBookUCI or -secondXBook or -secondHasOwnBookUCI true/false
1792 Indicates if the mentioned engine has its own opening book it
1793 should play from, rather than using the external book through
1794 XBoard. Default: depends on setting of the option
1795 `discourageOwnBooks'.
1797 -discourageOwnBooks true/false
1798 When set, newly loaded engines will be assumed to use the GUI book,
1799 unless they explicitly specify differently. Otherwise they will
1800 be assumed to not use the GUI book, unless the specify differently
1801 (e.g. with `firstXBook'). Default: false.
1804 Limits the use of the GUI book to the first n moves of each side.
1808 A value n from 0 to 100 tunes the choice of moves from the GUI
1809 books from totally random to best-only. Default: 50
1811 -fn string or -firstPgnName string
1812 -sn string or -secondPgnName string
1813 Indicates the name that should be used for the engine in PGN tags
1814 of engine-engine games. Intended to allow you to install verions
1815 of the same engine with different settings, and still distinguish
1819 Sets the size of the hash table to n MegaBytes. Together with the
1820 EGTB cache size this number is also used to calculate the memory
1821 setting of XBoard/WinBoard engines, for those that support the
1822 memory feature of the XBoard/WinBoard protocol. Default: 64.
1824 -defaultCacheSizeEGTB n
1825 Sets the size of the EGTB cache to n MegaBytes. Together with the
1826 hash-table size this number is also used to calculate the memory
1827 setting of XBoard/WinBoard engines, for those that support the
1828 memory feature of the XBoard/WinBoard protocol. Default: 4.
1830 -defaultPathEGTB filename
1831 Gives the name of the directory where the end-game tablebases are
1832 installed, for UCI engines. Default: "/usr/local/share/egtb".
1835 Specifies which end-game tables are installed on the computer, and
1836 where. The argument is a comma-separated list of format
1837 specifications, each specification consisting of a format name, a
1838 colon, and a directory path name, e.g.
1839 "nalimov:/usr/local/share/egtb". If the name part matches that of
1840 a format that the engine requests through a feature command,
1841 xboard will relay the path name for this format to the engine
1842 through an egtpath command. One egtpath command for each matching
1843 format will be sent. Popular formats are "nalimov" DTM tablebases
1844 and "scorpio" bitbases. Default: "".
1846 -firstChessProgramNames={names}
1847 This option lets you customize the drop-down list of chess engine
1848 names that appears in the `Load Engine' and `Match Options' dialog.
1849 It consists of a list of strings, one per line. When an engine is
1850 loaded, the corresponding line is prefixed with "-fcp ", and
1851 processed like it appeared on the command line. That means that
1852 apart from the engine command, it can contain any list of XBoard
1853 options you want to use with this engine. (Commonly used options
1854 here are -fd, -firstXBook, -fUCI, -variant.)
1856 The value of this option is gradually built as you load new engines
1857 through the `Load Engine' menu dialog, with `Add to list' ticked.
1858 To change it, edit your settings file with a plain text editor.
1860 4.3 Tournament options
1861 ======================
1863 -defaultMatchGames n
1864 Sets the number of games that will be used for a match between two
1865 engines started from the menu to n. Also used as games per pairing
1866 in other tournament formats. Default: 10.
1869 Specifies the duration of the pause between two games of a match
1870 or tournament between engines as n milliseconds. Especially
1871 engines that do not support ping need this option, to prevent that
1872 the move they are thinking on when an opponent unexpectedly
1873 resigns will be counted for the next game, (leading to illegal
1874 moves there). Default: 10000.
1876 -tf filename or -tourneyFile filename
1877 Specifies the name of the tournament file used in match mode to
1878 conduct a multi-player tournament. This file is a special
1879 settings file, which stores the description of the tournament
1880 (including progress info), through normal options (e.g. for time
1881 control, load and save files), and through some special-purpose
1882 options listed below.
1884 -tt number or -tourneyType number
1885 Specifies the type of tourney: 0 = round-robin, N>0 =
1886 (multi-)gauntlet with N gauntlet engines, -1 = Swiss through
1887 external pairing engine. Volatile option, but stored in tourney
1890 -cy number or -tourneyCycles number
1891 Specifies the number of cycles in a tourney. Volatile option, but
1892 stored in tourney file.
1895 The list is a multi-line text string that specifies engines
1896 occurring in the `firstChesProgramNames' list in the settings file
1897 by their (implied or explicitly given) nicknames, one engine per
1898 line. The mentioned engines will play in the tourney. Volatile
1899 option, but stored in tourney file.
1902 The string of +=- characters lists the result of all played games
1903 in a toruney. Games currently playing are listed as *, while a
1904 space indicates a game that is not yet played or playing .
1905 Volatile option, but stored in tourney file.
1907 -defaultTourneyName string
1908 Specifies the name of the tournament file XBoard should propose
1909 when the `Match Options' dialog is opened. Any %y, %M, %d, %h,
1910 %m, %s in the string are replaced by the current year, month, day
1911 of the month, hours, minutes, seconds of the current time,
1912 respectively, as two-digit number. A %Y would be replaced by the
1913 year as 4-digit number. Default: empty string.
1915 -pairingEngine filename
1916 Specifies the external program to be used to pair the participants
1917 in Swiss tourneys. XBoard communicates with this engine in the
1918 same way as it communicates with Chess engines. The only commands
1919 sent to the pairing engine are “results N string”, (where N is
1920 the number of participants, and string the results so far in the
1921 format of the results option), and “pairing N”, (where N is
1922 the number of the tourney game). To the latter the pairing engine
1923 should answer with “A-B”, where A and B are participant
1924 numbers (in the range 1-N). (There should be no reply to the
1925 results command.) Default: empty string.
1928 -afterTourney string
1929 When non-empty, the given string will be executed as a system
1930 command after each tournament game, orafterthe tourney completes,
1931 respectively. This can be used, for example, to autmatically run
1932 a cross-table generator on the PGN file where games are saved, to
1933 update the tourney standings. Default: ""
1935 -syncAfterRound true/false
1936 -syncAfterCycle true/false
1937 Controls whether different instances of XBoard concurrently
1938 running the same tournament will wait for each other. Defaults:
1939 sync after cycle, but not after round.
1942 Used to store the seed of the pseudo-random-number generator in the
1943 tourneyFile, so that separate instances of XBoard working on the
1944 same tourney can take coherent 'random' decisions, such as picking
1945 an opening for a given game number.
1950 -ics/-xics or -internetChessServerMode true/false
1951 Connect with an Internet Chess Server to play chess against its
1952 other users, observe games they are playing, or review games that
1953 have recently finished. Default: false.
1955 -icshost or -internetChessServerHost host
1956 The Internet host name or address of the chess server to connect
1957 to when in ICS mode. Default: `chessclub.com'. Another popular
1958 chess server to try is `freechess.org'. If your site doesn't have
1959 a working Internet name server, try specifying the host address in
1960 numeric form. You may also need to specify the numeric address
1961 when using the icshelper option with timestamp or timeseal (see
1964 -icsport or -internetChessServerPort port-number
1965 The port number to use when connecting to a chess server in ICS
1966 mode. Default: 5000.
1968 -icshelper or -internetChessServerHelper prog-name
1969 An external helper program used to communicate with the chess
1970 server. You would set it to "timestamp" for ICC (chessclub.com) or
1971 "timeseal" for FICS (freechess.org), after obtaining the correct
1972 version of timestamp or timeseal for your computer. See "help
1973 timestamp" on ICC and "help timeseal" on FICS. This option is
1974 shorthand for `-useTelnet -telnetProgram program'.
1976 -telnet/-xtelnet or -useTelnet true/false
1977 This option is poorly named; it should be called useHelper. If
1978 set to true, it instructs XBoard to run an external program to
1979 communicate with the Internet Chess Server. The program to use is
1980 given by the telnetProgram option. If the option is false (the
1981 default), XBoard opens a TCP socket and uses its own internal
1982 implementation of the telnet protocol to communicate with the ICS.
1985 -telnetProgram prog-name
1986 This option is poorly named; it should be called helperProgram.
1987 It gives the name of the telnet program to be used with the
1988 `gateway' and `useTelnet' options. The default is `telnet'. The
1989 telnet program is invoked with the value of
1990 `internetChessServerHost' as its first argument and the value of
1991 `internetChessServerPort' as its second argument. *Note
1995 If this option is set to a host name, XBoard communicates with the
1996 Internet Chess Server by using `rsh' to run the `telnetProgram' on
1997 the given host, instead of using its own internal implementation
1998 of the telnet protocol. You can substitute a different remote shell
1999 program for `rsh' using the `remoteShell' option described below.
2002 -internetChessServerCommPort or -icscomm dev-name
2003 If this option is set, XBoard communicates with the ICS through
2004 the given character I/O device instead of opening a TCP connection.
2005 Use this option if your system does not have any kind of Internet
2006 connection itself (not even a SLIP or PPP connection), but you do
2007 have dial-up access (or a hardwired terminal line) to an Internet
2008 service provider from which you can telnet to the ICS.
2010 The support for this option in XBoard is minimal. You need to set
2011 all communication parameters and tty modes before you enter XBoard.
2013 Use a script something like this:
2015 stty raw -echo 9600 > /dev/tty00
2016 xboard -ics -icscomm /dev/tty00
2018 Here replace `/dev/tty00' with the name of the device that your
2019 modem is connected to. You might have to add several more options
2020 to these stty commands. See the man pages for `stty' and `tty' if
2021 you run into problems. Also, on many systems stty works on its
2022 standard input instead of standard output, so you have to use `<'
2025 If you are using linux, try starting with the script below.
2026 Change it as necessary for your installation.
2029 # configure modem and fire up XBoard
2033 stty 2400 ; stty raw ; stty hupcl ; stty -clocal
2034 stty ignbrk ; stty ignpar ; stty ixon ; stty ixoff
2035 stty -iexten ; stty -echo
2037 xboard -ics -icscomm /dev/modem
2038 After you start XBoard in this way, type whatever commands are
2039 necessary to dial out to your Internet provider and log in. Then
2040 telnet to ICS, using a command like `telnet chessclub.com 5000'.
2041 Important: See the paragraph below about extra echoes, in *note
2044 -icslogon or -internetChessServerLogonScript file-name
2045 Whenever XBoard connects to the Internet Chess Server, if it finds
2046 a file with the name given in this option, it feeds the file's
2047 contents to the ICS as commands. The default file name is `.icsrc'.
2048 Usually the first two lines of the file should be your ICS user
2049 name and password. The file can be either in $CHESSDIR, in
2050 XBoard's working directory if CHESSDIR is not set, or in your home
2054 If you experience trouble logging on to an ICS when using the
2055 `-icslogon' option, inserting some delay between characters of the
2056 logon script may help. This option adds `delay' milliseconds of
2057 delay between characters. Good values to try are 100 and 250.
2059 -icsinput/-xicsinput or -internetChessServerInputBox true/false
2060 Sets the ICS Input Box menu option. *Note Mode Menu::. Default:
2063 -autocomm/-xautocomm or -autoComment true/false
2064 Sets the Auto Comment menu option. *Note Options Menu::. Default:
2067 -autoflag/-xautoflag or -autoCallFlag true/false
2068 Sets the Auto Flag menu option. *Note Options Menu::. Default:
2071 -autobs/-xautobs or -autoObserve true/false
2072 Sets the Auto Observe menu option. *Note Options Menu::. Default:
2076 Enables kibitzing of the engines last thinking output (depth,
2077 score, time, speed, PV) before it moved to the ICS, in zippy mode.
2078 The option `showThinking' must be switched on for this option to
2079 work. Also diverts similar kibitz information of an opponent
2080 engine that is playing you through the ICS to the engine-output
2081 window, as if the engine was playing locally.
2083 -seekGraph true/false or -sg
2084 Enables displaying of the seek graph by left-clicking the board
2085 when you are logged on to an ICS and currently idle. The seek
2086 graph show all players currently seeking games on the ICS, plotted
2087 according to their rating and the time control of the game they
2088 seek, in three different colors (for rated, unrated and wild
2089 games). Computer ads are displayed as squares, human ads are dots.
2092 -autoRefresh true/false
2093 Enables automatic updating of the seek graph, by having the ICS
2094 send a running update of all newly placed and removed seek ads.
2095 This consumes a substantial amount of communication bandwidth, and
2096 is only supported for FICS and ICC. Default: false.
2098 -backgroundObserve true/false
2099 When true, boards sent to you by the ICS from other games while
2100 you are playing (e.g. because you are observing them) will not be
2101 automatically displayed. Only a summary of time left and material
2102 of both players will appear in the message field above the board.
2103 XBoard will remember the last board it has received this way, and
2104 will display it in stead of the position in your own game when you
2105 press the right mouse button. No other information is stored on
2106 such games observed in the background; you cannot save such a game
2107 later, or step through its moves. This feature is provided solely
2108 for the benefit of bughouse players, to enable them to peek at
2109 their partner's game without the need to logon twice. Default:
2112 -dualBoard true/false
2113 In combination with -backgroundObserve true, this option will
2114 display the board of the background game side by side with that of
2115 your own game, so you can have it in view permanently. Any board
2116 or holdings info coming in will be displayed on the secondary
2117 board immediately. This feature is still experimental and largely
2118 unfinished. There is no animation or highlighting of moves on the
2119 secondary board. Default: false.
2121 -disguisePromotedPieces true/false
2122 When set promoted Pawns in crazyhouse/bughouse are displayed
2123 identical to primordial pieces of the same type, rather than
2124 distinguishable. Default: true.
2126 -moves/-xmoves or -getMoveList true/false
2127 Sets the Get Move List menu option. *Note Options Menu::.
2130 -alarm/-xalarm or -icsAlarm true/false
2131 Sets the ICS Alarm menu option. *Note Options Menu::. Default:
2135 Sets the time in milliseconds for the ICS Alarm menu option.
2136 *Note Options Menu::. Default: 5000.
2138 lowTimeWarning true/false
2139 Controls a color change of the board as a warning your time is
2140 running out. *Note Options Menu::. Default: false.
2142 -pre/-xpre \fRor\fB -premove true/false
2143 Sets the Premove menu option. *Note Options Menu::. Default: true.
2145 -prewhite/-xprewhite or -premoveWhite
2146 -preblack/-xpreblack or -premoveBlack
2147 -premoveWhiteText string
2148 -premoveBlackText string
2149 Set the menu options for specifying the first move for either
2150 color. *Note Options Menu::. Defaults: false and empty strings,
2153 -quiet/-xquiet or -quietPlay true/false
2154 Sets the Quiet Play menu option. *Note Options Menu::. Default:
2157 -colorizeMessages or -colorize/-xcolorize
2158 Setting colorizeMessages to true tells XBoard to colorize the
2159 messages received from the ICS. Colorization works only if your
2160 xterm supports ISO 6429 escape sequences for changing text colors.
2163 -colorShout foreground,background,bold
2164 -colorSShout foreground,background,bold
2165 -colorCShout foreground,background,bold
2166 -colorChannel1 foreground,background,bold
2167 -colorChannel foreground,background,bold
2168 -colorKibitz foreground,background,bold
2169 -colorTell foreground,background,bold
2170 -colorChallege foreground,background,bold
2171 -colorRequest foreground,background,bold
2172 -colorSeek foreground,background,bold
2173 -colorNormal foreground,background,bold
2174 These options set the colors used when colorizing ICS messages.
2175 All ICS messages are grouped into one of these categories: shout,
2176 sshout, channel 1, other channel, kibitz, tell, challenge, request
2177 (including abort, adjourn, draw, pause, and takeback), or normal
2178 (all other messages).
2180 Each foreground or background argument can be one of the following:
2181 black, red, green, yellow, blue, magenta, cyan, white, or default.
2182 Here "default" means the default foreground or background color of
2183 your xterm. Bold can be 1 or 0. If background is omitted,
2184 "default" is assumed; if bold is omitted, 0 is assumed.
2186 Here is an example of how to set the colors in your `.Xresources'
2187 file. The colors shown here are the default values; you will get
2188 them if you turn `-colorize' on without specifying your own colors.
2189 CShout is synonymous with SShout.
2191 xboard*colorizeMessages: true
2192 xboard*colorShout: green
2193 xboard*colorSShout: green, black, 1
2194 xboard*colorChannel1: cyan
2195 xboard*colorChannel: cyan, black, 1
2196 xboard*colorKibitz: magenta, black, 1
2197 xboard*colorTell: yellow, black, 1
2198 xboard*colorChallenge: red, black, 1
2199 xboard*colorRequest: red
2200 xboard*colorSeek: blue
2201 xboard*colorNormal: default
2203 -soundProgram progname
2204 If this option is set to a sound-playing program that is installed
2205 and working on your system, XBoard can play sound files when
2206 certain events occur, listed below. The default program name is
2207 "play". If any of the sound options is set to "$", the event
2208 rings the terminal bell by sending a ^G character to standard
2209 output, instead of playing a sound file. If an option is set to
2210 the empty string "", no sound is played for that event.
2212 -soundDirectory directoryname
2213 This option specifies where XBoard will look for sound files, when
2214 these are not given as an absolute path name.
2216 -soundShout filename
2217 -soundSShout filename
2218 -soundCShout filename
2219 -soundChannel filename
2220 -soundChannel1 filename
2221 -soundKibitz filename
2223 -soundChallenge filename
2224 -soundRequest filename
2226 These sounds are triggered in the same way as the colorization
2227 events described above. They all default to "", no sound. They
2228 are played only if the colorizeMessages is on. CShout is
2229 synonymous with SShout.
2232 This sound is used by the Move Sound menu option. Default: "$".
2234 -soundIcsAlarm filename
2235 This sound is used by the ICS Alarm menu option. Default: "$".
2237 -soundIcsWin filename
2238 This sound is played when you win an ICS game. Default: "" (no
2241 -soundIcsLoss filename
2242 This sound is played when you lose an ICS game. Default: "" (no
2245 -soundIcsDraw filename
2246 This sound is played when you draw an ICS game. Default: "" (no
2249 -soundIcsUnfinished filename
2250 This sound is played when an ICS game that you are participating
2251 in is aborted, adjourned, or otherwise ends inconclusively.
2252 Default: "" (no sound).
2254 Here is an example of how to set the sounds in your `.Xresources'
2257 xboard*soundShout: shout.wav
2258 xboard*soundSShout: sshout.wav
2259 xboard*soundChannel1: channel1.wav
2260 xboard*soundChannel: channel.wav
2261 xboard*soundKibitz: kibitz.wav
2262 xboard*soundTell: tell.wav
2263 xboard*soundChallenge: challenge.wav
2264 xboard*soundRequest: request.wav
2265 xboard*soundSeek: seek.wav
2266 xboard*soundMove: move.wav
2267 xboard*soundIcsWin: win.wav
2268 xboard*soundIcsLoss: lose.wav
2269 xboard*soundIcsDraw: draw.wav
2270 xboard*soundIcsUnfinished: unfinished.wav
2271 xboard*soundIcsAlarm: alarm.wav
2273 4.5 Load and Save options
2274 =========================
2276 -lgf or -loadGameFile file
2277 -lgi or -loadGameIndex index
2278 If the `loadGameFile' option is set, XBoard loads the specified
2279 game file at startup. The file name `-' specifies the standard
2280 input. If there is more than one game in the file, XBoard pops up
2281 a menu of the available games, with entries based on their PGN
2282 (Portable Game Notation) tags. If the `loadGameIndex' option is
2283 set to `N', the menu is suppressed and the N th game found in the
2284 file is loaded immediately. The menu is also suppressed if
2285 `matchMode' is enabled or if the game file is a pipe; in these
2286 cases the first game in the file is loaded immediately. Use the
2287 `pxboard' shell script provided with XBoard if you want to pipe in
2288 files containing multiple games and still see the menu. If the
2289 loadGameIndex specifies an index -1, this triggers auto-increment
2290 of the index in `matchMode', which means that after every game the
2291 index is incremented by one, causing each game of the match to be
2292 played from the next game in the file. Similarly, specifying an
2293 index value of -2 causes the index to be incremented every two
2294 games, so that each game in the file is used twice (with reversed
2295 colors). The `rewindIndex' option causes the index to be reset to
2296 the first game of the file when it has reached a specified value.
2299 Causes a position file or game file to be rewound to its beginning
2300 after n positions or games in auto-increment `matchMode'. See
2301 `loadPositionIndex' and `loadGameIndex'. default: 0 (no rewind).
2303 -td or -timeDelay seconds
2304 Time delay between moves during `Load Game' or `Analyze File'.
2305 Fractional seconds are allowed; try `-td 0.4'. A time delay value
2306 of -1 tells XBoard not to step through game files automatically.
2309 -sgf or -saveGameFile file
2310 If this option is set, XBoard appends a record of every game
2311 played to the specified file. The file name `-' specifies the
2314 -autosave/-xautosave or -autoSaveGames true/false
2315 Sets the Auto Save menu option. *Note Options Menu::. Default:
2316 false. Ignored if `saveGameFile' is set.
2318 -lpf or -loadPositionFile file
2319 -lpi or -loadPositionIndex index
2320 If the `loadPositionFile' option is set, XBoard loads the
2321 specified position file at startup. The file name `-' specifies the
2322 standard input. If the `loadPositionIndex' option is set to N, the
2323 Nth position found in the file is loaded; otherwise the first
2324 position is loaded. If the loadPositionIndex specifies an index
2325 -1, this triggers auto-increment of the index in `matchMode',
2326 which means that after every game the index is incremented by one,
2327 causing each game of the match to be played from the next position
2328 in the file. Similarly, specifying an index value of -2 causes the
2329 index to be incremented every two games, so that each position in
2330 the file is used twice (with the engines playing opposite colors).
2331 The `rewindIndex' option causes the index to be reset to the first
2332 position of the file when it has reached a specified value.
2334 -spf or -savePositionFile file
2335 If this option is set, XBoard appends the final position reached
2336 in every game played to the specified file. The file name `-'
2337 specifies the standard output.
2339 -pgnExtendedInfo true/false
2340 If this option is set, XBoard saves depth, score and time used for
2341 each move that the engine found as a comment in the PGN file.
2344 -pgnEventHeader string
2345 Sets the name used in the PGN event tag to string. Default:
2346 "Computer Chess Game".
2348 -pgnNumberTag true/false
2349 Include the (unique) sequence number of a tournament game into the
2350 saved PGN file as a 'number' tag. Default: false.
2352 -saveOutOfBookInfo true/false
2353 Include the information on how the engine(s) game out of its
2354 opening book in a special 'annotator' tag with the PGN file.
2357 -oldsave/-xoldsave or -oldSaveStyle true/false
2358 Sets the Old Save Style menu option. *Note Options Menu::.
2361 -gameListTags string
2362 The character string lists the PGN tags that should be printed in
2363 the Game List, and their order. The meaning of the codes is
2364 e=event, s=site, d=date, o=round, p=players, r=result, w=white
2365 Elo, b=black Elo, t=time control, v=variant, a=out-of-book info,
2366 c=result comment. Default: "eprd"
2368 -ini or -settingsFile filename
2369 -saveSettingsFile filename
2371 When XBoard encounters an option -settingsFile (or -ini for short),
2372 or @filename, it tries to read the mentioned file, and substitutes
2373 the contents of it (presumaby more command-line options) in place
2374 of the option. In the case of -ini or -settingsFile, the name of
2375 a successfully read settings file is also remembered as the file
2376 to use for saving settings (automatically on exit, or on user
2377 command). An option of the form @filename does not affect saving.
2378 The option -saveSettingsFile does specify a name of the file to use
2379 for saving, without reading any options from it, and is thus also
2380 effective when the file did not exist yet. So the settings will
2381 be saved to the file specified in the last -saveSettingsFile or
2382 succesfull -settingsFile / -ini command, if any, and in
2383 /etc/xboard/xboard.conf otherwise. Usualy the latter is only
2384 accessible for the system administrator, though, and will be used
2385 to contain system-wide default setings, amongst which a
2386 -saveSettingsFile and -settingsFile options to specify a settings
2387 file accessible to the individual user, such as ~/.xboardrc in the
2388 user's home directory.
2390 -saveSettingsOnExit true/false
2391 Controls saving of options on the settings file. *Note Options
2392 Menu::. Default: true.
2394 4.6 User interface options
2395 ==========================
2401 These and most other standard Xt options are accepted.
2404 Suppresses all GUI functions of XBoard (to speed up automated
2405 ultra-fast engine-engine games, which you don't want to watch).
2406 There will be no board or clock updates, no printing of moves, and
2407 no update of the icon on the task bar in this mode.
2409 -recentEngines number
2410 -recentEngineList list
2411 When the number is larger than zero, it determines how many
2412 recently used engines will be appended at the bottom of the
2413 `Engines' menu. The engines will be saved in your settings file
2414 as the option `recentEngineList', by their nicknames, and the most
2415 recently used one will always be sorted to the top. If the list
2416 after that is longer than the specified number, the last one is
2417 discarded. Changes in the list will only become visible the next
2418 session, provided you saved the settings. Default: 6.
2420 -oneClickMove true/false
2421 When set, this option allows you to enter moves by only clicking
2422 the to- or from-square, when only a single legal move to or from
2423 that square is possible. Double-clicking a piece (or clicking an
2424 already selected piece) will instruct that piece to make the only
2425 capture it can legally do. Default: false.
2427 -movesound/-xmovesound or -ringBellAfterMoves true/false
2428 Sets the Move Sound menu option. *Note Options Menu::. Default:
2429 false. For compatibility with old XBoard versions, -bell/-xbell
2430 are also accepted as abbreviations for this option.
2432 -exit/-xexit or -popupExitMessage true/false
2433 Sets the Popup Exit Message menu option. *Note Options Menu::.
2436 -popup/-xpopup or -popupMoveErrors true/false
2437 Sets the Popup Move Errors menu option. *Note Options Menu::.
2440 -queen/-xqueen or -alwaysPromoteToQueen true/false
2441 Sets the Always Queen menu option. *Note Options Menu::.
2444 -sweepPromotions true/false
2445 Sets the `Almost Always Promote to Queen' menu option. *Note
2446 Options Menu::. Default: false.
2448 -legal/-xlegal or -testLegality true/false
2449 Sets the Test Legality menu option. *Note Options Menu::.
2452 -size or -boardSize (sizeName | n1,n2,n3,n4,n5,n6,n7)
2453 Determines how large the board will be, by selecting the pixel size
2454 of the pieces and setting a few related parameters. The sizeName
2455 can be one of: Titanic, giving 129x129 pixel pieces, Colossal
2456 116x116, Giant 108x108, Huge 95x95, Big 87x87, Large 80x80, Bulky
2457 72x72, Medium 64x64, Moderate 58x58, Average 54x54, Middling
2458 49x49, Mediocre 45x45, Small 40x40, Slim 37x37, Petite 33x33,
2459 Dinky 29x29, Teeny 25x25, or Tiny 21x21. Orthodox pieces of all
2460 these sizes are built into XBoard. Other sizes can be used if you
2461 have them; see the pixmapDirectory and bitmapDirectory options.
2462 Complete sets of un-orthodox pieces are only provided in sizes
2463 Bulky, Middling and (to a lesser extent) Petite; Archbishop,
2464 Marshall and Amazon are also available in all sizes between Bulky
2465 and Petite. When no bitmap is available, the piece will be
2466 displayed as Amazon or King. The default depends on the size of
2467 your screen; it is approximately the largest size that will fit
2470 You can select other sizes or vary other layout parameters by
2471 providing a list of comma-separated values (with no spaces) as the
2472 argument. You do not need to provide all the values; for any you
2473 omit from the end of the list, defaults are taken from the nearest
2474 built-in size. The value `n1' gives the piece size, `n2' the
2475 width of the black border between squares, `n3' the desired size
2476 for the clockFont, `n4' the desired size for the coordFont, `n5'
2477 the desired size for the messageFont, `n6' the smallLayout flag (0
2478 or 1), and `n7' the tinyLayout flag (0 or 1). All dimensions are
2479 in pixels. If the border between squares is eliminated (0 width),
2480 the various highlight options will not work, as there is nowhere
2481 to draw the highlight. If smallLayout is 1 and `titleInWindow' is
2482 true, the window layout is rearranged to make more room for the
2483 title. If tinyLayout is 1, the labels on the menu bar are
2484 abbreviated to one character each and the buttons in the button
2485 bar are made narrower.
2488 When n >= 0, this forces the width of the black border between
2489 squares to n pixels for any board size. Mostly used to suppress
2490 the grid entirely by setting n = 0, e.g. in xiangqi or just
2491 getting a prettier picture. When n < 0 this the size-dependent
2492 width of the grid lines is used. Default: -1.
2494 -coords/-xcoords or -showCoords true/false
2495 Sets the Show Coords menu option. *Note Options Menu::. Default:
2496 false. The `coordFont' option specifies what font to use.
2498 -autoraise/-xautoraise or -autoRaiseBoard true/false
2499 Sets the Auto Raise Board menu option. *Note Options Menu::.
2502 -autoflip/-xautoflip or -autoFlipView true/false
2503 Sets the Auto Flip View menu option. *Note Options Menu::.
2506 -flip/-xflip or -flipView true/false
2507 If Auto Flip View is not set, or if you are observing but not
2508 participating in a game, then the positioning of the board at the
2509 start of each game depends on the flipView option. If flipView is
2510 false (the default), the board is positioned so that the white
2511 pawns move from the bottom to the top; if true, the black pawns
2512 move from the bottom to the top. In any case, the Flip menu
2513 option (see *note Options Menu::) can be used to flip the board
2514 after the game starts.
2516 -title/-xtitle or -titleInWindow true/false
2517 If this option is true, XBoard displays player names (for ICS
2518 games) and game file names (for `Load Game') inside its main
2519 window. If the option is false (the default), this information is
2520 displayed only in the window banner. You probably won't want to
2521 set this option unless the information is not showing up in the
2522 banner, as happens with a few X window managers.
2524 -buttons/-xbuttons or -showButtonBar True/False
2525 If this option is False, xboard omits the [<<] [<] [P] [>] [>>]
2526 button bar from the window, allowing the message line to be wider.
2527 You can still get the functions of these buttons using the menus
2528 or their keyboard shortcuts. Default: true.
2531 The score interval (-1,1) is blown up on the vertical axis of the
2532 Evaluation Graph by the given factor. Default: 1
2535 Score below n (centiPawn) are plotted as 0 in the Evaluation Graph.
2538 -mono/-xmono or -monoMode true/false
2539 Determines whether XBoard displays its pieces and squares with two
2540 colors (true) or four (false). You shouldn't have to specify
2541 `monoMode'; XBoard will determine if it is necessary.
2543 -showTargetSquares true/false
2544 Determines whether XBoard can highlight the squares a piece has
2545 legal moves to, when you grab that piece with the mouse. Default:
2551 These options enable flashing of pieces when they land on their
2552 destination square. `flashCount' tells XBoard how many times to
2553 flash a piece after it lands on its destination square.
2554 `flashRate' controls the rate of flashing (flashes/sec).
2555 Abbreviations: `flash' sets flashCount to 3. `xflash' sets
2556 flashCount to 0. Defaults: flashCount=0 (no flashing),
2559 -highlight/-xhighlight or -highlightLastMove true/false
2560 Sets the Highlight Last Move menu option. *Note Options Menu::.
2563 -highlightMoveWithArrow true/false
2564 Sets the Highlight with Arrow menu option. *Note Options Menu::.
2567 -blind/-xblind or -blindfold true/false
2568 Sets the Blindfold menu option. *Note Options Menu::. Default:
2571 -periodic/-xperiodic or -periodicUpdates true/false
2572 Controls updating of current move andnode counts in analysis mode.
2577 Causes the PV in thinking output of the mentioned engine to be
2578 converted to SAN before it is further processed. Warning: this
2579 might lose engine output not understood by the parser, and uses a
2580 lot of CPU power. Default: the PV is displayed exactly as the
2583 -showEvalInMoveHistory true/false
2584 Controls whether the evaluation scores and search depth of engine
2585 moves are displayed with the move in the move-history window.
2589 The font used for the clocks. If the option value is a pattern
2590 that does not specify the font size, XBoard tries to choose an
2591 appropriate font for the board size being used. Default:
2592 -*-helvetica-bold-r-normal-*-*-*-*-*-*-*-*.
2595 The font used for rank and file coordinate labels if `showCoords'
2596 is true. If the option value is a pattern that does not specify
2597 the font size, XBoard tries to choose an appropriate font for the
2598 board size being used. Default:
2599 -*-helvetica-bold-r-normal-*-*-*-*-*-*-*-*.
2602 The font used for popup dialogs, menus, comments, etc. If the
2603 option value is a pattern that does not specify the font size,
2604 XBoard tries to choose an appropriate font for the board size
2605 being used. Default: -*-helvetica-medium-r-normal-*-*-*-*-*-*-*-*.
2607 -fontSizeTolerance tol
2608 In the font selection algorithm, a nonscalable font will be
2609 preferred over a scalable font if the nonscalable font's size
2610 differs by `tol' pixels or less from the desired size. A value of
2611 -1 will force a scalable font to always be used if available; a
2612 value of 0 will use a nonscalable font only if it is exactly the
2613 right size; a large value (say 1000) will force a nonscalable font
2614 to always be used if available. Default: 4.
2616 -bm or -bitmapDirectory dir
2617 -pixmap or -pixmapDirectory dir
2618 These options control what piece images xboard uses. The XBoard
2619 distribution includes one set of pixmap pieces in xpm format, in
2620 the directory `pixmaps', and one set of bitmap pieces in xbm
2621 format, in the directory `bitmaps'. Pixmap pieces give a better
2622 appearance on the screen: the white pieces have dark borders, and
2623 the black pieces have opaque internal details. With bitmaps,
2624 neither piece color has a border, and the internal details are
2625 transparent; you see the square color or other background color
2628 If XBoard is configured and compiled on a system that includes
2629 libXpm, the X pixmap library, the xpm pixmap pieces are compiled
2630 in as the default. A different xpm piece set can be selected at
2631 runtime with the `pixmapDirectory' option, or a bitmap piece set
2632 can be selected with the `bitmapDirectory' option.
2634 If XBoard is configured and compiled on a system that does not
2635 include libXpm (or the `--disable-xpm' option is given to the
2636 configure program), the bitmap pieces are compiled in as the
2637 default. It is not possible to use xpm pieces in this case, but
2638 pixmap pieces in another format called "xim" can be used by giving
2639 the `pixmapDirectory' option. Or again, a different bitmap piece
2640 set can be selected with the `bitmapDirectory' option.
2642 Files in the `bitmapDirectory' must be named as follows: The first
2643 character of a piece bitmap name gives the piece it represents
2644 (`p', `n', `b', `r', `q', or `k'), the next characters give the
2645 size in pixels, the following character indicates whether the
2646 piece is solid or outline (`s' or `o'), and the extension is `.bm'.
2647 For example, a solid 80x80 knight would be named `n80s.bm'. The
2648 outline bitmaps are used only in monochrome mode. If bitmap
2649 pieces are compiled in and the bitmapDirectory is missing some
2650 files, the compiled in pieces are used instead.
2652 If the bitmapDirectory option is given, it is also possible to
2653 replace xboard's icons and menu checkmark, by supplying files
2654 named `icon_white.bm', `icon_black.bm', and `checkmark.bm'.
2656 For more information about pixmap pieces and how to get additional
2657 sets, see *note zic2xpm:: below.
2659 -whitePieceColor color
2660 -blackPieceColor color
2661 -lightSquareColor color
2662 -darkSquareColor color
2663 -highlightSquareColor color
2664 -preoveHighlightColor color
2665 -lowTimeWarningColor color
2666 Colors to use for the pieces, squares, and square highlights.
2669 -whitePieceColor #FFFFCC
2670 -blackPieceColor #202020
2671 -lightSquareColor #C8C365
2672 -darkSquareColor #77A26D
2673 -highlightSquareColor #FFFF00
2674 -premoveHighlightColor #FF0000
2675 -lowTimeWarningColor #FF0000
2677 On a grayscale monitor you might prefer:
2679 -whitePieceColor gray100
2680 -blackPieceColor gray0
2681 -lightSquareColor gray80
2682 -darkSquareColor gray60
2683 -highlightSquareColor gray100
2684 -premoveHighlightColor gray70
2685 -lowTimeWarningColor gray70
2687 -useBoardTexture true/false
2688 -liteBackTextureFile filename
2689 -darkBackTextureFile filename
2690 Indicate the pixmap files to be used for drawing the board squares,
2691 and if they should be used rather than using simple colors. The
2692 algorithm for cutting squares out of a given bitmap is such that
2693 the picture is perfectly reproduced when a bitmap the size of the
2694 complete board is given. Default: false and ""
2696 -drag/-xdrag or -animateDragging true/false
2697 Sets the Animate Dragging menu option. *Note Options Menu::.
2700 -animate/-xanimate or -animateMoving true/false
2701 Sets the Animate Moving menu option. *Note Options Menu::.
2705 Number of milliseconds delay between each animation frame when
2706 Animate Moves is on.
2708 -autoDisplayComment true/false
2709 -autoDisplayTags true/false
2710 If set to true, these options cause the window with the move
2711 comments, and the window with PGN tags, respectively, to pop up
2712 automatically when such tags or comments are encountered during
2713 the replaying a stored or loaded game. Default: true.
2715 -pasteSelection true/false
2716 If this option is set to true, the Paste Position and Paste Game
2717 options paste from the currently selected text. If false, they
2718 paste from the clipboard. Default: false.
2720 -autoCopyPV true|false
2721 When this option is set, the position displayed on the board when
2722 you terminate a PV walk (initiated by a right-click on board or
2723 engine-output window) will be automatically put on the clipboard
2724 as FEN. Default: false.
2726 -dropMenu true|false
2727 This option allows you to emulate old behavior, where the right
2728 mouse button brings up the (now deprecated) drop menu rather than
2729 displaying the position at the end of the principal variation.
2732 -pieceMenu true|false
2733 This option allows you to emulate old behavior, where the right
2734 mouse button brings up the (now deprecated) piece menu in Edit
2735 Position mode. From this menu you can select the piece to put on
2736 the square you clicked to bring up the menu, or select items such
2737 as `clear board'. You can also `promote' or `demote' a clicked
2738 piece to convert it into an unorthodox piece that is not directly
2739 in the menu, or give the move to `black' or `white'.
2741 -variations true|false
2742 When this option is on, you can start new variations in Edit Game
2743 or Analyze mode by holding the Shift key down while entering a
2744 move. When it is off, the Shift key will be ignored. Default:
2747 -absoluteAnalysisScores true|false
2748 When true, scores on the Engine Output window during analysis will
2749 be printed from the white point-of-view, rather than the
2750 side-to-move point-of-view. Default: False.
2752 -scoreWhite true|false
2753 When true, scores will always be printed from the white
2754 point-of-view, rather than the side-to-move point-of-view.
2757 4.7 Adjudication Options
2758 ========================
2760 -adjudicateLossThreshold n
2761 If the given value is non-zero, XBoard adjudicates the game as a
2762 loss if both engines agree for a duration of 6 consecutive ply
2763 that the score is below the given score threshold for that engine.
2764 Make sure the score is interpreted properly by XBoard, using
2765 `-firstScoreAbs' and `-secondScoreAbs' if needed. Default: 0 (no
2768 -adjudicateDrawMoves n
2769 If the given value is non-zero, XBoard adjudicates the game as a
2770 draw if after the given number of moves it was not yet decided.
2771 Default: 0 (no adjudication)
2773 -checkMates true/false
2774 If this option is set, XBoard detects all checkmates and
2775 stalemates, and ends the game as soon as they occur.
2776 Legality-testing must be switched on for this option to work.
2779 -testClaims true/false
2780 If this option is set, XBoard verifies all result claims made by
2781 engines, and those who send false claims will forfeit the game
2782 because of it. Legality-testing must be switched on for this
2783 option to work. Default: true
2785 -materialDraws true/false
2786 If this option is set, XBoard adjudicates games as draws when
2787 there is no sufficient material left to inflict a checkmate. This
2788 applies to KBKB with like bishops (any number, actually), and to
2789 KBK, KNK and KK. Legality-testing must be switched on for this
2790 option to work. Default: true
2792 -trivialDraws true/false
2793 If this option is set, XBoard adjudicates games as draws that
2794 cannot be usually won without opponent cooperation. This applies
2795 to KBKB with unlike bishops, and to KBKN, KNKN, KNNK, KRKR and
2796 KQKQ. The draw is called after 6 ply into these end-games, to
2797 allow quick mates that can occur in some exceptional positions to
2798 be found by the engines. KQKQ does not really belong in this
2799 category, and might be taken out in the future. (When
2800 bitbase-based adjudications are implemented.) Legality-testing
2801 must be on for this option to work. Default: false
2804 If the given value is non-zero, XBoard adjudicates the game as a
2805 draw after the given number of consecutive reversible moves.
2806 Engine draw claims are always accepted after 50 moves,
2807 irrespective of the given value of n.
2810 If the given value is non-zero, xboard adjudicates the game as a
2811 draw if a position is repeated the given number of times. Engines
2812 draw claims are always accepted after 3 repeats, (on the 3rd
2813 occurrence, actually), irrespective of the value of n. Beware
2814 that positions that have different castling or en-passant rights
2815 do not count as repeats, XBoard is fully e.p. and castling aware!
2820 -ncp/-xncp or -noChessProgram true/false
2821 If this option is true, XBoard acts as a passive chessboard; it
2822 does not start a chess engine at all. Turning on this option also
2823 turns off clockMode. Default: false.
2825 -mode or -initialMode modename
2826 If this option is given, XBoard selects the given modename from
2827 the Mode menu after starting and (if applicable) processing the
2828 loadGameFile or loadPositionFile option. Default: "" (no
2829 selection). Other supported values are MachineWhite,
2830 MachineBlack, TwoMachines, Analysis, AnalyzeFile, EditGame,
2831 EditPosition, and Training.
2834 Activates preliminary, partial support for playing chess variants
2835 against a local engine or editing variant games. This flag is not
2836 needed in ICS mode. Recognized variant names are:
2839 wildcastle Shuffle chess, king can castle from d file
2840 nocastle Shuffle chess, no castling allowed
2841 fischerandom Fischer Random shuffle chess
2842 bughouse Bughouse, ICC/FICS rules
2843 crazyhouse Crazyhouse, ICC/FICS rules
2844 losers Lose all pieces or get mated (ICC wild 17)
2845 suicide Lose all pieces including king (FICS)
2846 giveaway Try to have no legal moves (ICC wild 26)
2847 twokings Weird ICC wild 9
2848 kriegspiel Opponent's pieces are invisible
2849 atomic Capturing piece explodes (ICC wild 27)
2850 3check Win by giving check 3 times (ICC wild 25)
2851 shatranj An ancient precursor of chess (ICC wild 28)
2852 xiangqi Chinese Chess (on a 9x10 board)
2853 shogi Japanese Chess (on a 9x9 board & piece drops)
2854 capablanca Capablanca Chess (10x8 board, with Archbishop
2855 and Chancellor pieces)
2856 gothic similar, with a better initial position
2857 caparandom An FRC-like version of Capablanca Chess (10x8)
2858 janus A game with two Archbishops (10x8 board)
2859 courier Medieval intermediate between shatranj and
2860 modern Chess (on 12x8 board)
2861 falcon Patented 10x8 variant with two Falcon pieces
2862 berolina Pawns capture straight ahead, and move diagonal
2863 cylinder Pieces wrap around the board edge
2864 knightmate King moves as Knight, and vice versa
2865 super Superchess (shuffle variant with 4 exo-pieces)
2866 makruk Thai Chess (shatranj-like, P promotes on 6th rank)
2867 spartan Spartan Chess (black has unorthodox pieces)
2868 fairy A catchall variant in which all piece types
2869 known to XBoard can participate (8x8)
2870 unknown Catchall for other unknown variants
2872 NOT ALL BOARDSIZES PROVIDE A COMPLETE SET OF BUILT-IN BITMAPS FOR
2873 ALL UN-ORTHODOX PIECES, though. Only in `boardSize' middling and
2874 bulky all 22 piece types are provided, while -boardSize petite has
2875 most of them. Archbishop, Chancellor and Amazon are supported in
2876 every size from petite to bulky. Kings or Amazons are substituted
2877 for missing bitmaps. You can still play variants needing
2878 un-orthodox pieces in other board sizes providing your own bitmaps
2879 through the `bitmapDirectory' or `pixmapDirectory' options.
2881 In the shuffle variants, XBoard now does shuffle the pieces,
2882 although you can still do it by hand using Edit Position. Some
2883 variants are supported only in ICS mode, including bughouse, and
2884 kriegspiel. The winning/drawing conditions in crazyhouse
2885 (off-board interposition on mate) are not fully understood, but
2886 losers, suicide, giveaway, atomic, and 3check should be OK.
2887 Berolina and cylinder chess can only be played with legality
2888 testing off. In crazyhouse, XBoard now does keep track of
2889 off-board pieces. In shatranj it does implement the baring rule
2890 when mate detection is switched on.
2893 Allows you to set a non-standard number of board ranks in any
2894 variant. If the height is given as -1, the default height for the
2895 variant is used. Default: -1
2898 Allows you to set a non-standard number of board files in any
2899 variant. If the width is given as -1, the default width for the
2900 variant is used. With a non-standard width, the initial position
2901 will always be an empty board, as the usual opening array will not
2905 Allows you to set a non-standard size for the holdings in any
2906 variant. If the size is given as -1, the default holdings size
2907 for the variant is used. The first N piece types will go into the
2908 holdings on capture, and you will be able to drop them on the
2909 board in stead of making a normal move. If size equals 0, there
2910 will be no holdings. Default: -1
2912 -defaultFrcPosition N
2913 Specifies the number of the opening position in shuffle games like
2914 Chess960. A value of -1 means the position is randomly generated
2915 by XBoard at the beginning of every game. Default: -1
2917 -pieceToCharTable string
2918 The characters that are used to represent the piece types XBoard
2919 knows in FEN diagrams and SAN moves. The string argument has to
2920 have an even length (or it will be ignored), as white and black
2921 pieces have to be given separately (in that order). The last
2922 letter for each color will be the King. The letters before that
2923 will be PNBRQ and then a whole host of fairy pieces in an order
2924 that has not fully crystallized yet (currently FEACWMOHIJGDVSLU,
2925 F=Ferz, Elephant, A=Archbishop, C=Chancellor, W=Wazir, M=Commoner,
2926 O=Cannon, H=Nightrider). You should list at least all pieces that
2927 occur in the variant you are playing. If you have less than 44
2928 characters in the string, the pieces not mentioned will get
2929 assigned a period, and you will not be able to distinguish them in
2930 FENs. You can also explicitly assign pieces a period, in which
2931 case they will not be counted in deciding which captured pieces
2932 can go into the holdings. A tilde '~' as a piece name does mean
2933 this piece is used to represent a promoted Pawn in crazyhouse-like
2934 games, i.e. on capture it turns back onto a Pawn. A '+' similarly
2935 indicates the piece is a shogi-style promoted piece, that should
2936 revert to its non-promoted version on capture (rather than to a
2937 Pawn). Note that promoted pieces are represented by pieces 11
2938 further in the list. You should not have to use this option
2939 often: each variant has its own default setting for the piece
2940 representation in FEN, which should be sufficient in normal use.
2943 -pieceNickNames string
2944 The characters in the string are interpreted the same way as in the
2945 `pieceToCharTable' option. But on input, piece-ID letters are
2946 first looked up in the nicknames, and only if not defined there,
2947 in the normal pieceToCharTable. This allows you to have two letters
2948 designate the same piece, (e.g. N as an alternative to H for Horse
2949 in Xiangqi), to make reading of non-compliant notations easier.
2952 -colorNickNames string
2953 The side-to-move field in a FEN will be first matched against the
2954 letters in the string (first character for white, second for
2955 black), before it is matched to the regular 'w' and 'b'. This
2956 makes it easier to read non-compliant FENs, which, say, use 'r'
2957 for white. Default: ""
2959 -debug/-xdebug or -debugMode true/false
2960 Turns on debugging printout.
2962 -debugFile filename or -nameOfDebugFile filename
2963 Sets the name of the file to which XBoard saves debug information
2964 (including all communication to and from the engines). A `%d' in
2965 the given file name (e.g. game%d.debug) will be replaced by the
2966 unique sequence number of a tournament game, so that the debug
2967 output of each game will be written on a separate file.
2969 -engineDebugOutput number
2970 Specifies how XBoard should handle unsolicited output from the
2971 engine, with respect to saving it in the debug file. The output
2972 is further (hopefully) ignored. If number=0, XBoard refrains from
2973 writing such spurious output to the debug file. If number=1, all
2974 engine output is written faithfully to the debug file. If
2975 number=2, any protocol-violating line is prefixed with a '#'
2976 character, as the engine itself should have done if it wanted to
2977 submit info for inclusion in the debug file. This option is
2978 provided for the benefit of applications that use the debug file
2979 as a source of information, such as the broadcaster of live games
2980 TLCV / TLCS. Such applications can be protected from spurious
2981 engine output that might otherwise confuse them.
2983 -rsh or -remoteShell shell-name
2984 Name of the command used to run programs remotely. The default is
2985 `rsh' or `remsh', determined when XBoard is configured and
2988 -ruser or -remoteUser user-name
2989 User name on the remote system when running programs with the
2990 `remoteShell'. The default is your local user name.
2993 Name under which the Human player will be listed in the PGN file.
2994 Default is the login name on your local computer.
2996 -delayBeforeQuit number
2997 -delayAfterQuit number
2998 These options specify how long XBoard has to wait before sending a
2999 termination signal to rogue engine processes, that do not want to
3000 react to the 'quit' command. The second one determines the pause
3001 after killing the engine, to make sure it dies.
3004 The integer n encodes the mode for the `find position' function.
3005 Default: 1 (= Exact position match)
3007 -eloThresholdBoth elo
3008 -eloThresholdAny elo
3009 Defines a lower limit for the Elo rating, which has to be surpassed
3010 before a game will be considered when searching for a board
3011 position. Default: 0
3014 Only games not played before the given year will be considered when
3015 searching for a board position
3021 An "Internet Chess Server", or "ICS", is a place on the Internet where
3022 people can get together to play chess, watch other people's games, or
3023 just chat. You can use either `telnet' or a client program like XBoard
3024 to connect to the server. There are thousands of registered users on
3025 the different ICS hosts, and it is not unusual to meet 200 on both
3026 chessclub.com and freechess.org.
3028 Most people can just type `xboard -ics' to start XBoard as an ICS
3029 client. Invoking XBoard in this way connects you to the Internet Chess
3030 Club (ICC), a commercial ICS. You can log in there as a guest even if
3031 you do not have a paid account. To connect to the largest Free ICS
3032 (FICS), use the command `xboard -ics -icshost freechess.org' instead,
3033 or substitute a different host name to connect to your favorite ICS.
3034 For a full description of command-line options that control the
3035 connection to ICS and change the default values of ICS options, see
3036 *note ICS options::.
3038 While you are running XBoard as an ICS client, you use the terminal
3039 window that you started XBoard from as a place to type in commands and
3040 read information that is not available on the chessboard.
3042 The first time you need to use the terminal is to enter your login
3043 name and password, if you are a registered player. (You don't need to do
3044 this manually; the `icsLogon' option can do it for you. *note ICS
3045 options::.) If you are not registered, enter `g' as your name, and the
3046 server will pick a unique guest name for you.
3048 Some useful ICS commands include
3050 to get help on the given <topic>. To get a list of possible topics
3051 type "help" without topic. Try the help command before you ask
3052 other people on the server for help.
3054 For example `help register' tells you how to become a registered
3058 to see a list of people who are logged on. Administrators (people
3059 you should talk to if you have a problem) are marked with the
3060 character `*', an asterisk. The <flags> allow you to display only
3061 selected players: For example, `who of' shows a list of players
3062 who are interested in playing but do not have an opponent.
3065 to see what games are being played
3067 `match <player> [<mins>] [<inc>]'
3068 to challenge another player to a game. Both opponents get <mins>
3069 minutes for the game, and <inc> seconds will be added after each
3070 move. If another player challenges you, the server asks if you
3071 want to accept the challenge; use the `accept' or `decline'
3076 to accept or decline another player's offer. The offer may be to
3077 start a new game, or to agree to a `draw', `adjourn' or `abort'
3078 the current game. *Note Action Menu::.
3080 If you have more than one pending offer (for example, if more than
3081 one player is challenging you, or if your opponent offers both a
3082 draw and to adjourn the game), you have to supply additional
3083 information, by typing something like `accept <player>', `accept
3089 asks your opponent to terminate a game by mutual agreement.
3090 Adjourned games can be continued later. Your opponent can either
3091 `decline' your offer or accept it (by typing the same command or
3092 typing `accept'). In some cases these commands work immediately,
3093 without asking your opponent to agree. For example, you can abort
3094 the game unilaterally if your opponent is out of time, and you can
3095 claim a draw by repetition or the 50-move rule if available simply
3099 to get information about the given <player>. (Default: yourself.)
3102 to get a list of personal settings
3105 to modify these settings
3108 to observe an ongoing game of the given <player>.
3112 to review a recently completed game
3114 Some special XBoard features are activated when you are in examine
3115 mode on ICS. See the descriptions of the menu commands `Forward',
3116 `Backward', `Pause', `ICS Client', and `Stop Examining' on the *note
3117 Edit Menu::, *note Mode Menu::, and *note Action Menu::.
3122 By default, XBoard communicates with an Internet Chess Server by
3123 opening a TCP socket directly from the machine it is running on to the
3124 ICS. If there is a firewall between your machine and the ICS, this
3125 won't work. Here are some recipes for getting around common kinds of
3126 firewalls using special options to XBoard. Important: See the
3127 paragraph in the below about extra echoes, in *note Limitations::.
3129 Suppose that you can't telnet directly to ICS, but you can telnet to
3130 a firewall host, log in, and then telnet from there to ICS. Let's say
3131 the firewall is called `firewall.example.com'. Set command-line options
3134 xboard -ics -icshost firewall.example.com -icsport 23
3135 Or in your `.Xresources' file:
3137 XBoard*internetChessServerHost: firewall.example.com
3138 XBoard*internetChessServerPort: 23
3139 Then when you run XBoard in ICS mode, you will be prompted to log in
3140 to the firewall host. This works because port 23 is the standard telnet
3141 login service. Do so, then telnet to ICS, using a command like `telnet
3142 chessclub.com 5000', or whatever command the firewall provides for
3143 telnetting to port 5000.
3145 If your firewall lets you telnet (or rlogin) to remote hosts but
3146 doesn't let you telnet to port 5000, you may be able to connect to the
3147 chess server on port 23 instead, which is the port the telnet program
3148 uses by default. Some chess servers support this (including
3149 chessclub.com and freechess.org), while some do not.
3151 If your chess server does not allow connections on port 23 and your
3152 firewall does not allow you to connect to other ports, you may be able
3153 to connect by hopping through another host outside the firewall that
3154 you have an account on. For instance, suppose you have a shell account
3155 at `foo.edu'. Follow the recipe above, but instead of typing `telnet
3156 chessclub.com 5000' to the firewall, type `telnet foo.edu' (or `rlogin
3157 foo.edu'), log in there, and then type `telnet chessclub.com 5000'.
3159 Suppose that you can't telnet directly to ICS, but you can use rsh
3160 to run programs on a firewall host, and that host can telnet to ICS.
3161 Let's say the firewall is called `rsh.example.com'. Set command-line
3164 xboard -ics -gateway rsh.example.com -icshost chessclub.com
3166 Or in your `.Xresources' file:
3168 XBoard*gateway: rsh.example.com
3169 XBoard*internetChessServerHost: chessclub.com
3171 Then when you run XBoard in ICS mode, it will connect to the ICS by
3172 using `rsh' to run the command `telnet chessclub.com 5000' on host
3175 Suppose that you can telnet anywhere you want, but you have to run a
3176 special program called `ptelnet' to do so.
3178 First, we'll consider the easy case, in which `ptelnet chessclub.com
3179 5000' gets you to the chess server. In this case set command line
3182 xboard -ics -telnet -telnetProgram ptelnet
3184 Or in your `.Xresources' file:
3186 XBoard*useTelnet: true
3187 XBoard*telnetProgram: ptelnet
3189 Then when you run XBoard in ICS mode, it will issue the command
3190 `ptelnet chessclub.com 5000' to connect to the ICS.
3192 Next, suppose that `ptelnet chessclub.com 5000' doesn't work; that
3193 is, your `ptelnet' program doesn't let you connect to alternative
3194 ports. As noted above, your chess server may allow you to connect on
3195 port 23 instead. In that case, just add the option `-icsport ""' to
3196 the above command, or add `XBoard*internetChessServerPort:' to your
3197 `.Xresources' file. But if your chess server doesn't let you connect
3198 on port 23, you will have to find some other host outside the firewall
3199 and hop through it. For instance, suppose you have a shell account at
3200 `foo.edu'. Set command line options as follows:
3202 xboard -ics -telnet -telnetProgram ptelnet -icshost foo.edu -icsport ""
3204 Or in your `.Xresources' file:
3206 XBoard*useTelnet: true
3207 XBoard*telnetProgram: ptelnet
3208 XBoard*internetChessServerHost: foo.edu
3209 XBoard*internetChessServerPort:
3211 Then when you run XBoard in ICS mode, it will issue the command
3212 `ptelnet foo.edu' to connect to your account at `foo.edu'. Log in
3213 there, then type `telnet chessclub.com 5000'.
3215 ICC timestamp and FICS timeseal do not work through some firewalls.
3216 You can use them only if your firewall gives a clean TCP connection
3217 with a full 8-bit wide path. If your firewall allows you to get out
3218 only by running a special telnet program, you can't use timestamp or
3219 timeseal across it. But if you have access to a computer just outside
3220 your firewall, and you have much lower netlag when talking to that
3221 computer than to the ICS, it might be worthwhile running timestamp
3222 there. Follow the instructions above for hopping through a host
3223 outside the firewall (foo.edu in the example), but run timestamp or
3224 timeseal on that host instead of telnet.
3226 Suppose that you have a SOCKS firewall that will give you a clean
3227 8-bit wide TCP connection to the chess server, but only after you
3228 authenticate yourself via the SOCKS protocol. In that case, you could
3229 make a socksified version of XBoard and run that. If you are using
3230 timestamp or timeseal, you will to socksify it, not XBoard; this may be
3231 difficult seeing that ICC and FICS do not provide source code for these
3232 programs. Socksification is beyond the scope of this document, but see
3233 the SOCKS Web site at http://www.socks.permeo.com/. If you are missing
3234 SOCKS, try http://www.funbureau.com/.
3236 7 Environment variables
3237 ***********************
3239 Game and position files are found in a directory named by the
3240 `CHESSDIR' environment variable. If this variable is not set, the
3241 current working directory is used. If `CHESSDIR' is set, XBoard
3242 actually changes its working directory to `$CHESSDIR', so any files
3243 written by the chess engine will be placed there too.
3245 8 Limitations and known bugs
3246 ****************************
3248 There is no way for two people running copies of XBoard to play each
3249 other without going through an Internet Chess Server.
3251 Under some circumstances, your ICS password may be echoed when you
3254 If you are connecting to the ICS by running telnet on an Internet
3255 provider or firewall host, you may find that each line you type is
3256 echoed back an extra time after you hit <Enter>. If your Internet
3257 provider is a Unix system, you can probably turn its echo off by typing
3258 `stty -echo' after you log in, and/or typing <^E><Enter> (Ctrl+E
3259 followed by the Enter key) to the telnet program after you have logged
3260 into ICS. It is a good idea to do this if you can, because the extra
3261 echo can occasionally confuse XBoard's parsing routines.
3263 The game parser recognizes only algebraic notation.
3265 Many of the following points used to be limitations in XBoard 4.2.7
3266 and earlier, but are now fixed: The internal move legality tester in
3267 XBoard 4.3.xx does look at the game history, and is fully aware of
3268 castling or en-passant-capture rights. It permits castling with the
3269 king on the d file because this is possible in some "wild 1" games on
3270 ICS. The piece-drop menu does not check piece drops in bughouse to see
3271 if you actually hold the piece you are trying to drop. But this way of
3272 dropping pieces should be considered an obsolete feature, now that
3273 pieces can be dropped by dragging them from the holdings to the board.
3274 Anyway, if you would attempt an illegal move when using a chess engine
3275 or the ICS, XBoard will accept the error message that comes back, undo
3276 the move, and let you try another. FEN positions saved by XBoard do
3277 include correct information about whether castling or en passant are
3278 legal, and also handle the 50-move counter. The mate detector does not
3279 understand that non-contact mate is not really mate in bughouse. The
3280 only problem this causes while playing is minor: a "#" (mate indicator)
3281 character will show up after a non-contact mating move in the move
3282 list. XBoard will not assume the game is over at that point, not even
3283 when the option Detect Mates is on. Edit Game mode always uses the
3284 rules of the selected variant, which can be a variant that uses piece
3285 drops. You can load and edit games that contain piece drops. The
3286 (obsolete) piece menus are not active, but you can perform piece drops
3287 by dragging pieces from the holdings. Fischer Random castling is fully
3288 understood. You can enter castlings by dragging the King on top of
3289 your Rook. You can probably also play Fischer Random successfully on
3290 ICS by typing castling moves into the ICS Interaction window.
3292 The menus may not work if your keyboard is in Caps Lock or Num Lock
3293 mode. This seems to be a problem with the Athena menu widget, not an
3296 Also see the ToDo file included with the distribution for many other
3297 possible bugs, limitations, and ideas for improvement that have been
3300 9 Reporting problems
3301 ********************
3303 You can report bugs and problems with XBoard using the bug tracker at
3304 `https://savannah.gnu.org/projects/xboard/' or by sending mail to
3305 `<bug-xboard@gnu.org>'. It can also be useful to report or discuss
3306 bugs in the WinBoard Forum at `http://www.open-aurec.com/wbforum/',
3307 WinBoard development section.
3309 Please use the `script' program to start a typescript, run XBoard
3310 with the `-debug' option, and include the typescript output in your
3311 message. Also tell us what kind of machine and what operating system
3312 version you are using. The command `uname -a' will often tell you this.
3314 If you improve XBoard, please send a message about your changes, and
3315 we will get in touch with you about merging them in to the main line of
3318 10 Authors and contributors
3319 ***************************
3321 Chris Sears and Dan Sears wrote the original XBoard. They were
3322 responsible for versions 1.0 through 1.2. The color scheme was taken
3323 from Wayne Christopher's `XChess' program.
3325 Tim Mann was primarily responsible for XBoard versions 1.3 through
3326 4.2.7, and for WinBoard (a port of XBoard to Microsoft Win32) from its
3327 inception through version 4.2.7.
3329 John Chanak contributed the initial implementation of ICS mode. Evan
3330 Welsh wrote `CMail', and Patrick Surry helped in designing, testing,
3331 and documenting it. Elmar Bartel contributed the new piece bitmaps
3332 introduced in version 3.2. Jochen Wiedmann converted the documentation
3333 to texinfo. Frank McIngvale added click/click moving, the Analysis
3334 modes, piece flashing, ZIICS import, and ICS text colorization to
3335 XBoard. Hugh Fisher added animated piece movement to XBoard, and
3336 Henrik Gram added it to WinBoard. Mark Williams contributed the
3337 initial (WinBoard-only) implementation of many new features added to
3338 both XBoard and WinBoard in version 4.1.0, including copy/paste,
3339 premove, icsAlarm, autoFlipView, training mode, auto raise, and
3340 blindfold. Ben Nye contributed X copy/paste code for XBoard.
3342 In a fork from version 4.2.7, Alessandro Scotti added many elements
3343 to the user interface of WinBoard, including the board textures and
3344 font-based rendering, the evaluation-graph, move-history and
3345 engine-output window. He was also responsible for adding the UCI
3348 H. G. Muller continued this fork of the project, producing version
3349 4.3. He made WinBoard castling- and e.p.-aware, added variant support
3350 with adjustable board sizes, the crazyhouse holdings, and the fairy
3351 pieces. In addition he added most of the adjudication options, made
3352 WinBoard more robust in dealing with buggy and crashing engines, and
3353 extended time control with a time-odds and node-count-based modes.
3354 Most of the options that initially were WinBoard only have now been
3355 back-ported to XBoard.
3357 Michel van den Bergh provided the code for reading Polyglot opening
3360 Meanwhile, some work continued on the GNU XBoard project maintained
3361 at savannah.gnu.org, but version 4.2.8 was never released. Daniel
3362 Mehrmann was responsible for much of this work.
3364 Most recently, Arun Persaud worked with H. G. Muller to merge all
3365 the features of the never-released XBoard/WinBoard 4.2.8 of the GNU
3366 XBoard project and the never-released 4.3.16 from H. G.'s fork into a
3367 unified XBoard/WinBoard 4.4, which is now available both from the
3368 savannah.gnu.org web site and the WinBoard forum.
3373 The `cmail' program can help you play chess by email with opponents of
3374 your choice using XBoard as an interface.
3376 You will usually run `cmail' without giving any options.
3382 Displays `cmail' usage information.
3385 Shows the conditions of the GNU General Public License. *Note
3389 Shows the warranty notice of the GNU General Public License.
3394 Provides or inhibits verbose output from `cmail' and XBoard,
3395 useful for debugging. The `-xv' form also inhibits the cmail
3396 introduction message.
3400 Invokes or inhibits the sending of a mail message containing the
3405 Invokes or inhibits the running of XBoard on the game file.
3409 Invokes or inhibits the reuse of an existing XBoard to display the
3413 Resends the last mail message for that game. This inhibits running
3417 The name of the game to be processed.
3422 Number of games to start as White, as Black or in total. Default
3423 is 1 as white and none as black. If only one color is specified
3424 then none of the other color is assumed. If no color is specified
3425 then equal numbers of White and Black games are started, with the
3426 extra game being as White if an odd number of total games is
3431 A one-word alias for yourself or your opponent.
3436 -oppname <full name>
3437 The full name of White, Black, yourself or your opponent.
3442 -oppna <net address>
3443 The email address of White, Black, yourself or your opponent.
3446 The directory in which `cmail' keeps its files. This defaults to
3447 the environment variable `$CMAIL_DIR' or failing that, `$CHESSDIR',
3448 `$HOME/Chess' or `~/Chess'. It will be created if it does not
3452 The directory in which `cmail' archives completed games. Defaults
3453 to the environment variable `$CMAIL_ARCDIR' or, in its absence,
3454 the same directory as cmail keeps its working files (above).
3456 -mailprog <mail program>
3457 The program used by cmail to send email messages. This defaults to
3458 the environment variable `$CMAIL_MAILPROG' or failing that
3459 `/usr/ucb/Mail', `/usr/ucb/mail' or `Mail'. You will need to set
3460 this variable if none of the above paths fit your system.
3463 A file in which to dump verbose debugging messages that are
3464 invoked with the `-v' option.
3467 The PGN Event tag (default `Email correspondence game').
3470 The PGN Site tag (default `NET').
3473 The PGN Round tag (default `-', not applicable).
3476 The PGN Mode tag (default `EM', Electronic Mail).
3479 Any option flags not listed above are passed through to XBoard.
3480 Invoking XBoard through CMail changes the default values of two
3481 XBoard options: The default value for `-noChessProgram' is changed
3482 to true; that is, by default no chess engine is started. The
3483 default value for `-timeDelay' is changed to 0; that is, by default
3484 XBoard immediately goes to the end of the game as played so far,
3485 rather than stepping through the moves one by one. You can still
3486 set these options to whatever values you prefer by supplying them
3487 on CMail's command line. *Note Options::.
3489 11.2 Starting a CMail Game
3490 ==========================
3492 Type `cmail' from a shell to start a game as white. After an opening
3493 message, you will be prompted for a game name, which is optional--if you
3494 simply press <Enter>, the game name will take the form
3495 `you-VS-opponent'. You will next be prompted for the short name of your
3496 opponent. If you haven't played this person before, you will also be
3497 prompted for his/her email address. `cmail' will then invoke XBoard in
3498 the background. Make your first move and select `Mail Move' from the
3499 `File' menu. *Note File Menu::. If all is well, `cmail' will mail a
3500 copy of the move to your opponent. If you select `Exit' without having
3501 selected `Mail Move' then no move will be made.
3503 11.3 Answering a Move
3504 =====================
3506 When you receive a message from an opponent containing a move in one of
3507 your games, simply pipe the message through `cmail'. In some mailers
3508 this is as simple as typing `| cmail' when viewing the message, while in
3509 others you may have to save the message to a file and do `cmail < file'
3510 at the command line. In either case `cmail' will display the game using
3511 XBoard. If you didn't exit XBoard when you made your first move then
3512 `cmail' will do its best to use the existing XBoard instead of starting
3513 a new one. As before, simply make a move and select `Mail Move' from
3514 the `File' menu. *Note File Menu::. `cmail' will try to use the XBoard
3515 that was most recently used to display the current game. This means
3516 that many games can be in progress simultaneously, each with its own
3519 If you want to look at the history or explore a variation, go ahead,
3520 but you must return to the current position before XBoard will allow you
3521 to mail a move. If you edit the game's history you must select `Reload
3522 Same Game' from the `File' menu to get back to the original position,
3523 then make the move you want and select `Mail Move'. As before, if you
3524 decide you aren't ready to make a move just yet you can either select
3525 `Exit' without sending a move or just leave XBoard running until you
3528 11.4 Multi-Game Messages
3529 ========================
3531 It is possible to have a `cmail' message carry more than one game.
3532 This feature was implemented to handle IECG (International Email Chess
3533 Group) matches, where a match consists of one game as white and one as
3534 black, with moves transmitted simultaneously. In case there are more
3535 general uses, `cmail' itself places no limit on the number of
3536 black/white games contained in a message; however, XBoard does.
3538 11.5 Completing a Game
3539 ======================
3541 Because XBoard can detect checkmate and stalemate, `cmail' handles game
3542 termination sensibly. As well as resignation, the `Action' menu allows
3543 draws to be offered and accepted for `cmail' games.
3545 For multi-game messages, only unfinished and just-finished games
3546 will be included in email messages. When all the games are finished,
3547 they are archived in the user's archive directory, and similarly in the
3548 opponent's when he or she pipes the final message through `cmail'. The
3549 archive file name includes the date the game was started.
3551 11.6 Known CMail Problems
3552 =========================
3554 It's possible that a strange conjunction of conditions may occasionally
3555 mean that `cmail' has trouble reactivating an existing XBoard. If this
3556 should happen, simply trying it again should work. If not, remove the
3557 file that stores the XBoard's PID (`game.pid') or use the `-xreuse'
3558 option to force `cmail' to start a new XBoard.
3560 Versions of `cmail' after 2.16 no longer understand the old file
3561 format that XBoard used to use and so cannot be used to correspond with
3562 anyone using an older version.
3564 Versions of `cmail' older than 2.11 do not handle multi-game
3565 messages, so multi-game correspondence is not possible with opponents
3566 using an older version.
3568 12 Other programs you can use with XBoard
3569 *****************************************
3571 Here are some other programs you can use with XBoard
3576 The GNU Chess engine is available from:
3578 ftp://ftp.gnu.org/gnu/gnuchess/
3580 You can use XBoard to play a game against GNU Chess, or to interface
3581 GNU Chess to an ICS.
3586 Fairy-Max is a derivative from the once World's smallest Chess program
3587 micro-Max, which measures only about 100 lines of source code. The
3588 main difference with micro-Max is that Fairy-Max loads its
3589 move-generator tables from a file, so that the rules for piece movement
3590 can be easily configured to implement unorthodox pieces. Fairy-Max can
3591 therefore play a large number of variants, normal Chess being one of
3592 those. In addition it plays Knightmate, Capablanca and Gothic Chess,
3593 Shatranj, Courier Chess, Cylinder chess, Berolina Chess, while the user
3594 can easily define new variants. It can be obtained from:
3596 http://home.hccnet.nl/h.g.muller/dwnldpage.html
3601 HoiChess is a not-so-very-strong Chess engine, which comes with a
3602 derivative HoiXiangqi, able to play Chinese Chess. It can be obtained
3603 from the standard Linux repositories through:
3605 sudo apt-get install hoichess
3610 Crafty is a chess engine written by Bob Hyatt. You can use XBoard to
3611 play a game against Crafty, hook Crafty up to an ICS, or use Crafty to
3612 interactively analyze games and positions for you.
3614 Crafty is a strong, rapidly evolving chess program. This rapid pace
3615 of development is good, because it means Crafty is always getting
3616 better. This can sometimes cause problems with backwards
3617 compatibility, but usually the latest version of Crafty will work well
3618 with the latest version of XBoard. Crafty can be obtained from its
3619 author's FTP site: ftp://ftp.cis.uab.edu/hyatt/.
3621 To use Crafty with XBoard, give the -fcp and -fd options as follows,
3622 where <crafty's directory> is the directory in which you installed
3623 Crafty and placed its book and other support files.
3628 The "zic2xpm" program is used to import chess sets from the ZIICS(*)
3629 program into XBoard. "zic2xpm" is part of the XBoard distribution.
3630 ZIICS is available from:
3632 ftp://ftp.freechess.org/pub/chess/DOS/ziics131.exe
3634 To import ZIICS pieces, do this:
3635 1. Unzip ziics131.exe into a directory:
3636 unzip -L ziics131.exe -d ~/ziics
3638 2. Use zic2xpm to convert a set of pieces to XBoard format.
3639 For example, let's say you want to use the FRITZ4 set. These files
3640 are named "fritz4.*" in the ZIICS distribution.
3644 zic2xpm ~/ziics/fritz4.*
3646 3. Give XBoard the "-pixmap" option when starting up, e.g.:
3647 xboard -pixmap ~/fritz4
3649 Alternatively, you can add this line to your `.Xresources' file:
3651 xboard*pixmapDirectory: ~/fritz4
3653 (*) ZIICS is a separate copyrighted work of Andy McFarland. The
3654 "ZIICS pieces" are copyrighted works of their respective creators.
3655 Files produced by "zic2xpm" are for PERSONAL USE ONLY and may NOT be
3656 redistributed without explicit permission from the original creator(s)
3662 Copyright (C) 1991 Digital Equipment Corporation, Maynard,
3665 All Rights Reserved.
3667 Permission to use, copy, modify, and distribute this software and its
3668 documentation for any purpose and without fee is hereby granted,
3669 provided that the above copyright notice appear in all copies and that
3670 both that copyright notice and this permission notice appear in
3671 supporting documentation, and that the name of Digital not be used in
3672 advertising or publicity pertaining to distribution of the software
3673 without specific, written prior permission.
3675 Digital disclaims all warranties with regard to this software,
3676 including all implied warranties of merchantability and fitness. In no
3677 event shall Digital be liable for any special, indirect or
3678 consequential damages or any damages whatsoever resulting from loss of
3679 use, data or profits, whether in an action of contract, negligence or
3680 other tortious action, arising out of or in connection with the use or
3681 performance of this software.
3683 Enhancements copyright (C) 1992-2003, 2004, 2005, 2006, 2007, 2008,
3684 2009, 2010, 2011, 2012 Free Software Foundation, Inc.
3686 Published by the Free Software Foundation
3687 59 Temple Place - Suite 330
3688 Boston, MA 02111-1307 USA
3690 Permission is granted to make and distribute verbatim copies of this
3691 manual provided the copyright notice and this permission notice are
3692 preserved on all copies.
3694 Permission is granted to copy and distribute modified versions of
3695 this manual under the conditions for verbatim copying, provided also
3696 that the section entitled "GNU General Public License," is included
3697 exactly as in the original, and provided that the entire resulting
3698 derived work is distributed under the terms of a permission notice
3699 identical to this one.
3701 Permission is granted to copy and distribute translations of this
3702 manual into another language, under the above conditions for modified
3703 versions, except that the section entitled "GNU General Public License,"
3704 and this permission notice, may be included in translations approved by
3705 the Free Software Foundation instead of in the original English.
3707 GNU GENERAL PUBLIC LICENSE
3708 **************************
3710 Version 3, 29 June 2007
3712 Copyright (C) 2007 Free Software Foundation, Inc. `http://fsf.org/'
3714 Everyone is permitted to copy and distribute verbatim copies of this
3715 license document, but changing it is not allowed.
3720 The GNU General Public License is a free, copyleft license for software
3721 and other kinds of works.
3723 The licenses for most software and other practical works are designed
3724 to take away your freedom to share and change the works. By contrast,
3725 the GNU General Public License is intended to guarantee your freedom to
3726 share and change all versions of a program--to make sure it remains
3727 free software for all its users. We, the Free Software Foundation, use
3728 the GNU General Public License for most of our software; it applies
3729 also to any other work released this way by its authors. You can apply
3730 it to your programs, too.
3732 When we speak of free software, we are referring to freedom, not
3733 price. Our General Public Licenses are designed to make sure that you
3734 have the freedom to distribute copies of free software (and charge for
3735 them if you wish), that you receive source code or can get it if you
3736 want it, that you can change the software or use pieces of it in new
3737 free programs, and that you know you can do these things.
3739 To protect your rights, we need to prevent others from denying you
3740 these rights or asking you to surrender the rights. Therefore, you
3741 have certain responsibilities if you distribute copies of the software,
3742 or if you modify it: responsibilities to respect the freedom of others.
3744 For example, if you distribute copies of such a program, whether
3745 gratis or for a fee, you must pass on to the recipients the same
3746 freedoms that you received. You must make sure that they, too, receive
3747 or can get the source code. And you must show them these terms so they
3750 Developers that use the GNU GPL protect your rights with two steps:
3751 (1) assert copyright on the software, and (2) offer you this License
3752 giving you legal permission to copy, distribute and/or modify it.
3754 For the developers' and authors' protection, the GPL clearly explains
3755 that there is no warranty for this free software. For both users' and
3756 authors' sake, the GPL requires that modified versions be marked as
3757 changed, so that their problems will not be attributed erroneously to
3758 authors of previous versions.
3760 Some devices are designed to deny users access to install or run
3761 modified versions of the software inside them, although the
3762 manufacturer can do so. This is fundamentally incompatible with the
3763 aim of protecting users' freedom to change the software. The
3764 systematic pattern of such abuse occurs in the area of products for
3765 individuals to use, which is precisely where it is most unacceptable.
3766 Therefore, we have designed this version of the GPL to prohibit the
3767 practice for those products. If such problems arise substantially in
3768 other domains, we stand ready to extend this provision to those domains
3769 in future versions of the GPL, as needed to protect the freedom of
3772 Finally, every program is threatened constantly by software patents.
3773 States should not allow patents to restrict development and use of
3774 software on general-purpose computers, but in those that do, we wish to
3775 avoid the special danger that patents applied to a free program could
3776 make it effectively proprietary. To prevent this, the GPL assures that
3777 patents cannot be used to render the program non-free.
3779 The precise terms and conditions for copying, distribution and
3780 modification follow.
3782 TERMS AND CONDITIONS
3783 ====================
3787 "This License" refers to version 3 of the GNU General Public
3790 "Copyright" also means copyright-like laws that apply to other
3791 kinds of works, such as semiconductor masks.
3793 "The Program" refers to any copyrightable work licensed under this
3794 License. Each licensee is addressed as "you". "Licensees" and
3795 "recipients" may be individuals or organizations.
3797 To "modify" a work means to copy from or adapt all or part of the
3798 work in a fashion requiring copyright permission, other than the
3799 making of an exact copy. The resulting work is called a "modified
3800 version" of the earlier work or a work "based on" the earlier work.
3802 A "covered work" means either the unmodified Program or a work
3803 based on the Program.
3805 To "propagate" a work means to do anything with it that, without
3806 permission, would make you directly or secondarily liable for
3807 infringement under applicable copyright law, except executing it
3808 on a computer or modifying a private copy. Propagation includes
3809 copying, distribution (with or without modification), making
3810 available to the public, and in some countries other activities as
3813 To "convey" a work means any kind of propagation that enables other
3814 parties to make or receive copies. Mere interaction with a user
3815 through a computer network, with no transfer of a copy, is not
3818 An interactive user interface displays "Appropriate Legal Notices"
3819 to the extent that it includes a convenient and prominently visible
3820 feature that (1) displays an appropriate copyright notice, and (2)
3821 tells the user that there is no warranty for the work (except to
3822 the extent that warranties are provided), that licensees may
3823 convey the work under this License, and how to view a copy of this
3824 License. If the interface presents a list of user commands or
3825 options, such as a menu, a prominent item in the list meets this
3830 The "source code" for a work means the preferred form of the work
3831 for making modifications to it. "Object code" means any
3832 non-source form of a work.
3834 A "Standard Interface" means an interface that either is an
3835 official standard defined by a recognized standards body, or, in
3836 the case of interfaces specified for a particular programming
3837 language, one that is widely used among developers working in that
3840 The "System Libraries" of an executable work include anything,
3841 other than the work as a whole, that (a) is included in the normal
3842 form of packaging a Major Component, but which is not part of that
3843 Major Component, and (b) serves only to enable use of the work
3844 with that Major Component, or to implement a Standard Interface
3845 for which an implementation is available to the public in source
3846 code form. A "Major Component", in this context, means a major
3847 essential component (kernel, window system, and so on) of the
3848 specific operating system (if any) on which the executable work
3849 runs, or a compiler used to produce the work, or an object code
3850 interpreter used to run it.
3852 The "Corresponding Source" for a work in object code form means all
3853 the source code needed to generate, install, and (for an executable
3854 work) run the object code and to modify the work, including
3855 scripts to control those activities. However, it does not include
3856 the work's System Libraries, or general-purpose tools or generally
3857 available free programs which are used unmodified in performing
3858 those activities but which are not part of the work. For example,
3859 Corresponding Source includes interface definition files
3860 associated with source files for the work, and the source code for
3861 shared libraries and dynamically linked subprograms that the work
3862 is specifically designed to require, such as by intimate data
3863 communication or control flow between those subprograms and other
3866 The Corresponding Source need not include anything that users can
3867 regenerate automatically from other parts of the Corresponding
3870 The Corresponding Source for a work in source code form is that
3873 2. Basic Permissions.
3875 All rights granted under this License are granted for the term of
3876 copyright on the Program, and are irrevocable provided the stated
3877 conditions are met. This License explicitly affirms your unlimited
3878 permission to run the unmodified Program. The output from running
3879 a covered work is covered by this License only if the output,
3880 given its content, constitutes a covered work. This License
3881 acknowledges your rights of fair use or other equivalent, as
3882 provided by copyright law.
3884 You may make, run and propagate covered works that you do not
3885 convey, without conditions so long as your license otherwise
3886 remains in force. You may convey covered works to others for the
3887 sole purpose of having them make modifications exclusively for
3888 you, or provide you with facilities for running those works,
3889 provided that you comply with the terms of this License in
3890 conveying all material for which you do not control copyright.
3891 Those thus making or running the covered works for you must do so
3892 exclusively on your behalf, under your direction and control, on
3893 terms that prohibit them from making any copies of your
3894 copyrighted material outside their relationship with you.
3896 Conveying under any other circumstances is permitted solely under
3897 the conditions stated below. Sublicensing is not allowed; section
3898 10 makes it unnecessary.
3900 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
3902 No covered work shall be deemed part of an effective technological
3903 measure under any applicable law fulfilling obligations under
3904 article 11 of the WIPO copyright treaty adopted on 20 December
3905 1996, or similar laws prohibiting or restricting circumvention of
3908 When you convey a covered work, you waive any legal power to forbid
3909 circumvention of technological measures to the extent such
3910 circumvention is effected by exercising rights under this License
3911 with respect to the covered work, and you disclaim any intention
3912 to limit operation or modification of the work as a means of
3913 enforcing, against the work's users, your or third parties' legal
3914 rights to forbid circumvention of technological measures.
3916 4. Conveying Verbatim Copies.
3918 You may convey verbatim copies of the Program's source code as you
3919 receive it, in any medium, provided that you conspicuously and
3920 appropriately publish on each copy an appropriate copyright notice;
3921 keep intact all notices stating that this License and any
3922 non-permissive terms added in accord with section 7 apply to the
3923 code; keep intact all notices of the absence of any warranty; and
3924 give all recipients a copy of this License along with the Program.
3926 You may charge any price or no price for each copy that you convey,
3927 and you may offer support or warranty protection for a fee.
3929 5. Conveying Modified Source Versions.
3931 You may convey a work based on the Program, or the modifications to
3932 produce it from the Program, in the form of source code under the
3933 terms of section 4, provided that you also meet all of these
3936 a. The work must carry prominent notices stating that you
3937 modified it, and giving a relevant date.
3939 b. The work must carry prominent notices stating that it is
3940 released under this License and any conditions added under
3941 section 7. This requirement modifies the requirement in
3942 section 4 to "keep intact all notices".
3944 c. You must license the entire work, as a whole, under this
3945 License to anyone who comes into possession of a copy. This
3946 License will therefore apply, along with any applicable
3947 section 7 additional terms, to the whole of the work, and all
3948 its parts, regardless of how they are packaged. This License
3949 gives no permission to license the work in any other way, but
3950 it does not invalidate such permission if you have separately
3953 d. If the work has interactive user interfaces, each must display
3954 Appropriate Legal Notices; however, if the Program has
3955 interactive interfaces that do not display Appropriate Legal
3956 Notices, your work need not make them do so.
3958 A compilation of a covered work with other separate and independent
3959 works, which are not by their nature extensions of the covered
3960 work, and which are not combined with it such as to form a larger
3961 program, in or on a volume of a storage or distribution medium, is
3962 called an "aggregate" if the compilation and its resulting
3963 copyright are not used to limit the access or legal rights of the
3964 compilation's users beyond what the individual works permit.
3965 Inclusion of a covered work in an aggregate does not cause this
3966 License to apply to the other parts of the aggregate.
3968 6. Conveying Non-Source Forms.
3970 You may convey a covered work in object code form under the terms
3971 of sections 4 and 5, provided that you also convey the
3972 machine-readable Corresponding Source under the terms of this
3973 License, in one of these ways:
3975 a. Convey the object code in, or embodied in, a physical product
3976 (including a physical distribution medium), accompanied by the
3977 Corresponding Source fixed on a durable physical medium
3978 customarily used for software interchange.
3980 b. Convey the object code in, or embodied in, a physical product
3981 (including a physical distribution medium), accompanied by a
3982 written offer, valid for at least three years and valid for
3983 as long as you offer spare parts or customer support for that
3984 product model, to give anyone who possesses the object code
3985 either (1) a copy of the Corresponding Source for all the
3986 software in the product that is covered by this License, on a
3987 durable physical medium customarily used for software
3988 interchange, for a price no more than your reasonable cost of
3989 physically performing this conveying of source, or (2) access
3990 to copy the Corresponding Source from a network server at no
3993 c. Convey individual copies of the object code with a copy of
3994 the written offer to provide the Corresponding Source. This
3995 alternative is allowed only occasionally and noncommercially,
3996 and only if you received the object code with such an offer,
3997 in accord with subsection 6b.
3999 d. Convey the object code by offering access from a designated
4000 place (gratis or for a charge), and offer equivalent access
4001 to the Corresponding Source in the same way through the same
4002 place at no further charge. You need not require recipients
4003 to copy the Corresponding Source along with the object code.
4004 If the place to copy the object code is a network server, the
4005 Corresponding Source may be on a different server (operated
4006 by you or a third party) that supports equivalent copying
4007 facilities, provided you maintain clear directions next to
4008 the object code saying where to find the Corresponding Source.
4009 Regardless of what server hosts the Corresponding Source, you
4010 remain obligated to ensure that it is available for as long
4011 as needed to satisfy these requirements.
4013 e. Convey the object code using peer-to-peer transmission,
4014 provided you inform other peers where the object code and
4015 Corresponding Source of the work are being offered to the
4016 general public at no charge under subsection 6d.
4019 A separable portion of the object code, whose source code is
4020 excluded from the Corresponding Source as a System Library, need
4021 not be included in conveying the object code work.
4023 A "User Product" is either (1) a "consumer product", which means
4024 any tangible personal property which is normally used for personal,
4025 family, or household purposes, or (2) anything designed or sold for
4026 incorporation into a dwelling. In determining whether a product
4027 is a consumer product, doubtful cases shall be resolved in favor of
4028 coverage. For a particular product received by a particular user,
4029 "normally used" refers to a typical or common use of that class of
4030 product, regardless of the status of the particular user or of the
4031 way in which the particular user actually uses, or expects or is
4032 expected to use, the product. A product is a consumer product
4033 regardless of whether the product has substantial commercial,
4034 industrial or non-consumer uses, unless such uses represent the
4035 only significant mode of use of the product.
4037 "Installation Information" for a User Product means any methods,
4038 procedures, authorization keys, or other information required to
4039 install and execute modified versions of a covered work in that
4040 User Product from a modified version of its Corresponding Source.
4041 The information must suffice to ensure that the continued
4042 functioning of the modified object code is in no case prevented or
4043 interfered with solely because modification has been made.
4045 If you convey an object code work under this section in, or with,
4046 or specifically for use in, a User Product, and the conveying
4047 occurs as part of a transaction in which the right of possession
4048 and use of the User Product is transferred to the recipient in
4049 perpetuity or for a fixed term (regardless of how the transaction
4050 is characterized), the Corresponding Source conveyed under this
4051 section must be accompanied by the Installation Information. But
4052 this requirement does not apply if neither you nor any third party
4053 retains the ability to install modified object code on the User
4054 Product (for example, the work has been installed in ROM).
4056 The requirement to provide Installation Information does not
4057 include a requirement to continue to provide support service,
4058 warranty, or updates for a work that has been modified or
4059 installed by the recipient, or for the User Product in which it
4060 has been modified or installed. Access to a network may be denied
4061 when the modification itself materially and adversely affects the
4062 operation of the network or violates the rules and protocols for
4063 communication across the network.
4065 Corresponding Source conveyed, and Installation Information
4066 provided, in accord with this section must be in a format that is
4067 publicly documented (and with an implementation available to the
4068 public in source code form), and must require no special password
4069 or key for unpacking, reading or copying.
4071 7. Additional Terms.
4073 "Additional permissions" are terms that supplement the terms of
4074 this License by making exceptions from one or more of its
4075 conditions. Additional permissions that are applicable to the
4076 entire Program shall be treated as though they were included in
4077 this License, to the extent that they are valid under applicable
4078 law. If additional permissions apply only to part of the Program,
4079 that part may be used separately under those permissions, but the
4080 entire Program remains governed by this License without regard to
4081 the additional permissions.
4083 When you convey a copy of a covered work, you may at your option
4084 remove any additional permissions from that copy, or from any part
4085 of it. (Additional permissions may be written to require their own
4086 removal in certain cases when you modify the work.) You may place
4087 additional permissions on material, added by you to a covered work,
4088 for which you have or can give appropriate copyright permission.
4090 Notwithstanding any other provision of this License, for material
4091 you add to a covered work, you may (if authorized by the copyright
4092 holders of that material) supplement the terms of this License
4095 a. Disclaiming warranty or limiting liability differently from
4096 the terms of sections 15 and 16 of this License; or
4098 b. Requiring preservation of specified reasonable legal notices
4099 or author attributions in that material or in the Appropriate
4100 Legal Notices displayed by works containing it; or
4102 c. Prohibiting misrepresentation of the origin of that material,
4103 or requiring that modified versions of such material be
4104 marked in reasonable ways as different from the original
4107 d. Limiting the use for publicity purposes of names of licensors
4108 or authors of the material; or
4110 e. Declining to grant rights under trademark law for use of some
4111 trade names, trademarks, or service marks; or
4113 f. Requiring indemnification of licensors and authors of that
4114 material by anyone who conveys the material (or modified
4115 versions of it) with contractual assumptions of liability to
4116 the recipient, for any liability that these contractual
4117 assumptions directly impose on those licensors and authors.
4119 All other non-permissive additional terms are considered "further
4120 restrictions" within the meaning of section 10. If the Program as
4121 you received it, or any part of it, contains a notice stating that
4122 it is governed by this License along with a term that is a further
4123 restriction, you may remove that term. If a license document
4124 contains a further restriction but permits relicensing or
4125 conveying under this License, you may add to a covered work
4126 material governed by the terms of that license document, provided
4127 that the further restriction does not survive such relicensing or
4130 If you add terms to a covered work in accord with this section, you
4131 must place, in the relevant source files, a statement of the
4132 additional terms that apply to those files, or a notice indicating
4133 where to find the applicable terms.
4135 Additional terms, permissive or non-permissive, may be stated in
4136 the form of a separately written license, or stated as exceptions;
4137 the above requirements apply either way.
4141 You may not propagate or modify a covered work except as expressly
4142 provided under this License. Any attempt otherwise to propagate or
4143 modify it is void, and will automatically terminate your rights
4144 under this License (including any patent licenses granted under
4145 the third paragraph of section 11).
4147 However, if you cease all violation of this License, then your
4148 license from a particular copyright holder is reinstated (a)
4149 provisionally, unless and until the copyright holder explicitly
4150 and finally terminates your license, and (b) permanently, if the
4151 copyright holder fails to notify you of the violation by some
4152 reasonable means prior to 60 days after the cessation.
4154 Moreover, your license from a particular copyright holder is
4155 reinstated permanently if the copyright holder notifies you of the
4156 violation by some reasonable means, this is the first time you have
4157 received notice of violation of this License (for any work) from
4158 that copyright holder, and you cure the violation prior to 30 days
4159 after your receipt of the notice.
4161 Termination of your rights under this section does not terminate
4162 the licenses of parties who have received copies or rights from
4163 you under this License. If your rights have been terminated and
4164 not permanently reinstated, you do not qualify to receive new
4165 licenses for the same material under section 10.
4167 9. Acceptance Not Required for Having Copies.
4169 You are not required to accept this License in order to receive or
4170 run a copy of the Program. Ancillary propagation of a covered work
4171 occurring solely as a consequence of using peer-to-peer
4172 transmission to receive a copy likewise does not require
4173 acceptance. However, nothing other than this License grants you
4174 permission to propagate or modify any covered work. These actions
4175 infringe copyright if you do not accept this License. Therefore,
4176 by modifying or propagating a covered work, you indicate your
4177 acceptance of this License to do so.
4179 10. Automatic Licensing of Downstream Recipients.
4181 Each time you convey a covered work, the recipient automatically
4182 receives a license from the original licensors, to run, modify and
4183 propagate that work, subject to this License. You are not
4184 responsible for enforcing compliance by third parties with this
4187 An "entity transaction" is a transaction transferring control of an
4188 organization, or substantially all assets of one, or subdividing an
4189 organization, or merging organizations. If propagation of a
4190 covered work results from an entity transaction, each party to that
4191 transaction who receives a copy of the work also receives whatever
4192 licenses to the work the party's predecessor in interest had or
4193 could give under the previous paragraph, plus a right to
4194 possession of the Corresponding Source of the work from the
4195 predecessor in interest, if the predecessor has it or can get it
4196 with reasonable efforts.
4198 You may not impose any further restrictions on the exercise of the
4199 rights granted or affirmed under this License. For example, you
4200 may not impose a license fee, royalty, or other charge for
4201 exercise of rights granted under this License, and you may not
4202 initiate litigation (including a cross-claim or counterclaim in a
4203 lawsuit) alleging that any patent claim is infringed by making,
4204 using, selling, offering for sale, or importing the Program or any
4209 A "contributor" is a copyright holder who authorizes use under this
4210 License of the Program or a work on which the Program is based.
4211 The work thus licensed is called the contributor's "contributor
4214 A contributor's "essential patent claims" are all patent claims
4215 owned or controlled by the contributor, whether already acquired or
4216 hereafter acquired, that would be infringed by some manner,
4217 permitted by this License, of making, using, or selling its
4218 contributor version, but do not include claims that would be
4219 infringed only as a consequence of further modification of the
4220 contributor version. For purposes of this definition, "control"
4221 includes the right to grant patent sublicenses in a manner
4222 consistent with the requirements of this License.
4224 Each contributor grants you a non-exclusive, worldwide,
4225 royalty-free patent license under the contributor's essential
4226 patent claims, to make, use, sell, offer for sale, import and
4227 otherwise run, modify and propagate the contents of its
4228 contributor version.
4230 In the following three paragraphs, a "patent license" is any
4231 express agreement or commitment, however denominated, not to
4232 enforce a patent (such as an express permission to practice a
4233 patent or covenant not to sue for patent infringement). To
4234 "grant" such a patent license to a party means to make such an
4235 agreement or commitment not to enforce a patent against the party.
4237 If you convey a covered work, knowingly relying on a patent
4238 license, and the Corresponding Source of the work is not available
4239 for anyone to copy, free of charge and under the terms of this
4240 License, through a publicly available network server or other
4241 readily accessible means, then you must either (1) cause the
4242 Corresponding Source to be so available, or (2) arrange to deprive
4243 yourself of the benefit of the patent license for this particular
4244 work, or (3) arrange, in a manner consistent with the requirements
4245 of this License, to extend the patent license to downstream
4246 recipients. "Knowingly relying" means you have actual knowledge
4247 that, but for the patent license, your conveying the covered work
4248 in a country, or your recipient's use of the covered work in a
4249 country, would infringe one or more identifiable patents in that
4250 country that you have reason to believe are valid.
4252 If, pursuant to or in connection with a single transaction or
4253 arrangement, you convey, or propagate by procuring conveyance of, a
4254 covered work, and grant a patent license to some of the parties
4255 receiving the covered work authorizing them to use, propagate,
4256 modify or convey a specific copy of the covered work, then the
4257 patent license you grant is automatically extended to all
4258 recipients of the covered work and works based on it.
4260 A patent license is "discriminatory" if it does not include within
4261 the scope of its coverage, prohibits the exercise of, or is
4262 conditioned on the non-exercise of one or more of the rights that
4263 are specifically granted under this License. You may not convey a
4264 covered work if you are a party to an arrangement with a third
4265 party that is in the business of distributing software, under
4266 which you make payment to the third party based on the extent of
4267 your activity of conveying the work, and under which the third
4268 party grants, to any of the parties who would receive the covered
4269 work from you, a discriminatory patent license (a) in connection
4270 with copies of the covered work conveyed by you (or copies made
4271 from those copies), or (b) primarily for and in connection with
4272 specific products or compilations that contain the covered work,
4273 unless you entered into that arrangement, or that patent license
4274 was granted, prior to 28 March 2007.
4276 Nothing in this License shall be construed as excluding or limiting
4277 any implied license or other defenses to infringement that may
4278 otherwise be available to you under applicable patent law.
4280 12. No Surrender of Others' Freedom.
4282 If conditions are imposed on you (whether by court order,
4283 agreement or otherwise) that contradict the conditions of this
4284 License, they do not excuse you from the conditions of this
4285 License. If you cannot convey a covered work so as to satisfy
4286 simultaneously your obligations under this License and any other
4287 pertinent obligations, then as a consequence you may not convey it
4288 at all. For example, if you agree to terms that obligate you to
4289 collect a royalty for further conveying from those to whom you
4290 convey the Program, the only way you could satisfy both those
4291 terms and this License would be to refrain entirely from conveying
4294 13. Use with the GNU Affero General Public License.
4296 Notwithstanding any other provision of this License, you have
4297 permission to link or combine any covered work with a work licensed
4298 under version 3 of the GNU Affero General Public License into a
4299 single combined work, and to convey the resulting work. The terms
4300 of this License will continue to apply to the part which is the
4301 covered work, but the special requirements of the GNU Affero
4302 General Public License, section 13, concerning interaction through
4303 a network will apply to the combination as such.
4305 14. Revised Versions of this License.
4307 The Free Software Foundation may publish revised and/or new
4308 versions of the GNU General Public License from time to time.
4309 Such new versions will be similar in spirit to the present
4310 version, but may differ in detail to address new problems or
4313 Each version is given a distinguishing version number. If the
4314 Program specifies that a certain numbered version of the GNU
4315 General Public License "or any later version" applies to it, you
4316 have the option of following the terms and conditions either of
4317 that numbered version or of any later version published by the
4318 Free Software Foundation. If the Program does not specify a
4319 version number of the GNU General Public License, you may choose
4320 any version ever published by the Free Software Foundation.
4322 If the Program specifies that a proxy can decide which future
4323 versions of the GNU General Public License can be used, that
4324 proxy's public statement of acceptance of a version permanently
4325 authorizes you to choose that version for the Program.
4327 Later license versions may give you additional or different
4328 permissions. However, no additional obligations are imposed on any
4329 author or copyright holder as a result of your choosing to follow a
4332 15. Disclaimer of Warranty.
4334 THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
4335 APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE
4336 COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS"
4337 WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED,
4338 INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
4339 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE
4340 RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.
4341 SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL
4342 NECESSARY SERVICING, REPAIR OR CORRECTION.
4344 16. Limitation of Liability.
4346 IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
4347 WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES
4348 AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU
4349 FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR
4350 CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE
4351 THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA
4352 BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
4353 PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
4354 PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF
4355 THE POSSIBILITY OF SUCH DAMAGES.
4357 17. Interpretation of Sections 15 and 16.
4359 If the disclaimer of warranty and limitation of liability provided
4360 above cannot be given local legal effect according to their terms,
4361 reviewing courts shall apply local law that most closely
4362 approximates an absolute waiver of all civil liability in
4363 connection with the Program, unless a warranty or assumption of
4364 liability accompanies a copy of the Program in return for a fee.
4367 END OF TERMS AND CONDITIONS
4368 ===========================
4370 How to Apply These Terms to Your New Programs
4371 =============================================
4373 If you develop a new program, and you want it to be of the greatest
4374 possible use to the public, the best way to achieve this is to make it
4375 free software which everyone can redistribute and change under these
4378 To do so, attach the following notices to the program. It is safest
4379 to attach them to the start of each source file to most effectively
4380 state the exclusion of warranty; and each file should have at least the
4381 "copyright" line and a pointer to where the full notice is found.
4383 ONE LINE TO GIVE THE PROGRAM'S NAME AND A BRIEF IDEA OF WHAT IT DOES.
4384 Copyright (C) YEAR NAME OF AUTHOR
4386 This program is free software: you can redistribute it and/or modify
4387 it under the terms of the GNU General Public License as published by
4388 the Free Software Foundation, either version 3 of the License, or (at
4389 your option) any later version.
4391 This program is distributed in the hope that it will be useful, but
4392 WITHOUT ANY WARRANTY; without even the implied warranty of
4393 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
4394 General Public License for more details.
4396 You should have received a copy of the GNU General Public License
4397 along with this program. If not, see `http://www.gnu.org/licenses/'.
4399 Also add information on how to contact you by electronic and paper
4402 If the program does terminal interaction, make it output a short
4403 notice like this when it starts in an interactive mode:
4405 PROGRAM Copyright (C) YEAR NAME OF AUTHOR
4406 This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
4407 This is free software, and you are welcome to redistribute it
4408 under certain conditions; type `show c' for details.
4410 The hypothetical commands `show w' and `show c' should show the
4411 appropriate parts of the General Public License. Of course, your
4412 program's commands might be different; for a GUI interface, you would
4415 You should also get your employer (if you work as a programmer) or
4416 school, if any, to sign a "copyright disclaimer" for the program, if
4417 necessary. For more information on this, and how to apply and follow
4418 the GNU GPL, see `http://www.gnu.org/licenses/'.
4420 The GNU General Public License does not permit incorporating your
4421 program into proprietary programs. If your program is a subroutine
4422 library, you may consider it more useful to permit linking proprietary
4423 applications with the library. If this is what you want to do, use the
4424 GNU Lesser General Public License instead of this License. But first,
4425 please read `http://www.gnu.org/philosophy/why-not-lgpl.html'.
4430 -animateSpeed, option: See 4.6. (line 2705)
4431 -autoDisplayComment, option: See 4.6. (line 2710)
4432 -autoDisplayTags, option: See 4.6. (line 2710)
4433 -pasteSelection, option: See 4.6. (line 2716)
4434 .icsrc: See 4.4. (line 2045)
4435 <, Button: See 3.2. (line 389)
4436 <<, Button: See 3.2. (line 422)
4437 >, Button: See 3.2. (line 409)
4438 >>, Button: See 3.2. (line 441)
4439 abort, ICS command: See 5. (line 3089)
4440 Abort, Menu Item: See 3.5. (line 680)
4441 About XBoard, Menu Item: See 3.8. (line 1412)
4442 Absolute Analysis Scores, Menu Item: See 3.7. (line 808)
4443 absoluteAnalysisScores, option: See 4.6. (line 2748)
4444 accept, ICS command: See 5. (line 3076)
4445 Accept, Menu Item: See 3.5. (line 652)
4446 Action, Menu: See 3.5. (line 651)
4447 adapterCommand, option: See 4.2. (line 1760)
4448 adjourn, ICS command: See 5. (line 3089)
4449 Adjourn, Menu Item: See 3.5. (line 675)
4450 Adjudicate Draw, Menu Item: See 3.5. (line 708)
4451 Adjudicate to Black, Menu Item: See 3.5. (line 708)
4452 Adjudicate to White, Menu Item: See 3.5. (line 708)
4453 adjudicateDrawMoves, option: See 4.7. (line 2769)
4454 adjudicateLossThreshold, option: See 4.7. (line 2761)
4455 Adjudications, Menu Item: See 3.7. (line 1023)
4456 afterGame, option: See 4.3. (line 1929)
4457 afterTourney, option: See 4.3. (line 1929)
4458 alarm, option: See 4.4. (line 2131)
4459 Almost Always Queen, Menu Item: See 3.7. (line 812)
4460 Also match left-right flipped position, Menu Item:See 3.7. (line 1331)
4461 Also match reversed colors, Menu Item: See 3.7. (line 1331)
4462 alwaysPromoteToQueen, option: See 4.6. (line 2441)
4463 Analysis Mode, Menu Item: See 3.4. (line 536)
4464 Analyze Game, Menu Item: See 3.4. (line 564)
4465 Animate Dragging, Menu Item: See 3.7. (line 826)
4466 Animate Moving, Menu Item: See 3.7. (line 833)
4467 animate, option: See 4.6. (line 2701)
4468 animateDragging, option: See 4.6. (line 2697)
4469 animateMoving, option: See 4.6. (line 2701)
4470 Animation Speed, Menu Item: See 3.7. (line 980)
4471 Annotate, Menu Item: See 3.2. (line 365)
4472 at sign, option: See 4.5. (line 2371)
4473 Authors: See 10. (line 3321)
4474 Auto Comment, Menu Item: See 3.7. (line 1059)
4475 Auto Flag, Menu Item: See 3.7. (line 842)
4476 Auto Flip View, Menu Item: See 3.7. (line 852)
4477 Auto Kibitz, Menu Item: See 3.7. (line 1050)
4478 Auto Observe, Menu Item: See 3.7. (line 1067)
4479 Auto Raise Board, Menu Item: See 3.7. (line 1080)
4480 Auto Save, Menu Item: See 3.7. (line 1085)
4481 Auto-Refresh Seek Graph, Menu Item: See 3.7. (line 1127)
4482 autobs, option: See 4.4. (line 2072)
4483 autoCallFlag, option: See 4.4. (line 2068)
4484 autocomm, option: See 4.4. (line 2064)
4485 autoComment, option: See 4.4. (line 2064)
4486 autoCopyPV, option: See 4.6. (line 2721)
4487 autoflag, option: See 4.4. (line 2068)
4488 autoflip, option: See 4.6. (line 2503)
4489 autoFlipView, option: See 4.6. (line 2503)
4490 autoKibitz, option: See 4.4. (line 2076)
4491 autoObserve, option: See 4.4. (line 2072)
4492 autoraise, option: See 4.6. (line 2499)
4493 autoRaiseBoard, option: See 4.6. (line 2499)
4494 autoRefresh, option: See 4.4. (line 2093)
4495 autosave, option: See 4.5. (line 2315)
4496 autoSaveGames, option: See 4.5. (line 2315)
4497 Back to Start, Menu Item: See 3.2. (line 422)
4498 Background Observe, Menu Item: See 3.7. (line 1092)
4499 backgroundObserve, option: See 4.4. (line 2099)
4500 Backward, Menu Item: See 3.2. (line 389)
4501 Basic operation: See 2. (line 57)
4502 bell, option: See 4.6. (line 2428)
4503 bitmapDirectory, option: See 4.6. (line 2618)
4504 blackPieceColor, option: See 4.6. (line 2666)
4505 blind, option: See 4.6. (line 2568)
4506 Blindfold, Menu Item: See 3.7. (line 865)
4507 blindfold, option: See 4.6. (line 2568)
4508 bm, option: See 4.6. (line 2618)
4509 board size: See 4.6. (line 2453)
4510 Board, Menu Item: See 3.3. (line 509)
4511 boardHeight, option: See 4.8. (line 2893)
4512 boardSize, option: See 4.6. (line 2453)
4513 boardWidth, option: See 4.8. (line 2898)
4514 Book, Menu Item: See 3.6. (line 770)
4515 bookDepth, option: See 4.2. (line 1804)
4516 bookVariation, option: See 4.2. (line 1808)
4517 Bug reports: See 9. (line 3303)
4518 Bugs <1>: See 9. (line 3303)
4519 Bugs: See 8. (line 3248)
4520 buttons, option: See 4.6. (line 2525)
4521 Call Flag, Menu Item: See 3.5. (line 664)
4522 checkMates, option: See 4.7. (line 2774)
4523 Chess engine options: See 4.1. (line 1495)
4524 CHESSDIR: See 7. (line 3239)
4525 clock, option: See 4.1. (line 1512)
4526 clockFont, option: See 4.6. (line 2589)
4527 clockMode, option: See 4.1. (line 1512)
4528 CloneTourney, Menu Item: See 3.7. (line 1285)
4529 cmail: See 11. (line 3373)
4530 colorChallenge, option: See 4.4. (line 2174)
4531 colorChannel, option: See 4.4. (line 2174)
4532 colorChannel1, option: See 4.4. (line 2174)
4533 colorCShout, option: See 4.4. (line 2174)
4534 Colorize Messages, Menu Item: See 3.7. (line 1162)
4535 colorize, option: See 4.4. (line 2158)
4536 colorizeMessages, option: See 4.4. (line 2158)
4537 colorKibitz, option: See 4.4. (line 2174)
4538 colorNickNames, option: See 4.8. (line 2953)
4539 colorNormal, option: See 4.4. (line 2174)
4540 colorRequest, option: See 4.4. (line 2174)
4541 Colors <1>: See 4.6. (line 2666)
4542 Colors: See 4.4. (line 2158)
4543 colorSeek, option: See 4.4. (line 2174)
4544 colorShout, option: See 4.4. (line 2174)
4545 colorSShout, option: See 4.4. (line 2174)
4546 colorTell, option: See 4.4. (line 2174)
4547 Comments, Menu Item: See 3.3. (line 497)
4548 Common Engine, Menu Item: See 3.7. (line 999)
4549 Contributors: See 10. (line 3321)
4550 coordFont, option: See 4.6. (line 2595)
4551 coords, option: See 4.6. (line 2495)
4552 Copy Game List, Menu Item: See 3.2. (line 267)
4553 Copy Game, Menu Item: See 3.2. (line 248)
4554 Copy Position, Menu Item: See 3.2. (line 257)
4555 cy, option: See 4.3. (line 1891)
4556 darkBackTextureFile, option: See 4.6. (line 2690)
4557 darkSquareColor, option: See 4.6. (line 2666)
4558 dateThreshold, option: See 4.8. (line 3014)
4559 debug, option: See 4.8. (line 2960)
4560 debugFile, option: See 4.8. (line 2963)
4561 debugMode, option: See 4.8. (line 2960)
4562 decline, ICS command: See 5. (line 3076)
4563 Decline, Menu Item: See 3.5. (line 658)
4564 Default number of Games, Menu Item: See 3.7. (line 1227)
4565 defaultCacheSizeEGTB, option: See 4.2. (line 1825)
4566 defaultFrcPosition, option: See 4.8. (line 2913)
4567 defaultHashSize, option: See 4.2. (line 1819)
4568 defaultMatchGames, option: See 4.3. (line 1864)
4569 defaultPathEGTB, option: See 4.2. (line 1831)
4570 defaultTourneyName, option: See 4.3. (line 1908)
4571 delayAfterQuit, option: See 4.8. (line 2998)
4572 delayBeforeQuit, option: See 4.8. (line 2998)
4573 Disable own engine bools be default, Menu Item:See 3.7. (line 1262)
4574 discourageOwnBooks, option: See 4.2. (line 1798)
4575 disguisePromotedPieces, option: See 4.4. (line 2122)
4576 display, option: See 4.6. (line 2401)
4577 drag, option: See 4.6. (line 2697)
4578 draw, ICS command: See 5. (line 3089)
4579 Draw, Menu Item: See 3.5. (line 670)
4580 Drop Menu, Menu Item: See 3.7. (line 871)
4581 dropMenu, option: See 4.6. (line 2727)
4582 Dual Board, Menu Item: See 3.7. (line 1099)
4583 dualBoard, option: See 4.4. (line 2113)
4584 Edit Book, Menu Item: See 3.2. (line 354)
4585 Edit Comment, Menu Item: See 3.2. (line 349)
4586 Edit Game, Menu Item: See 3.2. (line 282)
4587 Edit Menu: See 3.2. (line 247)
4588 Edit Position, Menu Item: See 3.2. (line 298)
4589 Edit Tags, Menu Item: See 3.2. (line 325)
4590 egtFormats, option: See 4.2. (line 1835)
4591 Elo of strongest player, Menu Item: See 3.7. (line 1304)
4592 Elo of weakest player, Menu Item: See 3.7. (line 1304)
4593 eloThresholdAny, option: See 4.8. (line 3009)
4594 eloThresholdBoth, option: See 4.8. (line 3009)
4595 Engine #1 Settings, Menu Item: See 3.6. (line 748)
4596 Engine #2 Settings, Menu Item: See 3.6. (line 748)
4597 Engine Menu: See 3.6. (line 716)
4598 Engine Settings: See 4.2. (line 1742)
4599 Engine Settings, Menu Item: See 3.6. (line 748)
4600 engineDebugOutput, option: See 4.8. (line 2970)
4601 Environment variables: See 7. (line 3239)
4602 evalThreshold, option: See 4.6. (line 2535)
4603 evalZoom, option: See 4.6. (line 2531)
4604 examine, ICS command: See 5. (line 3112)
4605 Exit, Menu Item: See 3.1. (line 242)
4606 exit, option: See 4.6. (line 2433)
4607 fb, option: See 4.1. (line 1619)
4608 fcp, option: See 4.1. (line 1612)
4609 fd, option: See 4.1. (line 1634)
4610 fh, option: See 4.1. (line 1626)
4611 File Menu: See 3.1. (line 122)
4612 File with Start Positions, Menu Item: See 3.7. (line 1246)
4613 find position, Menu Item: See 3.7. (line 1309)
4614 finger, ICS command: See 5. (line 3099)
4615 First Black Move, Menu Item: See 3.7. (line 1137)
4616 First White Move, Menu Item: See 3.7. (line 1137)
4617 firstChessProgram, option: See 4.1. (line 1612)
4618 firstComputerString, option: See 4.1. (line 1670)
4619 firstDirectory, option: See 4.1. (line 1634)
4620 firstHasOwnBookUCI, option: See 4.2. (line 1792)
4621 firstHost, option: See 4.1. (line 1626)
4622 firstInitString, option: See 4.1. (line 1643)
4623 firstIsUCI, option: See 4.2. (line 1744)
4624 firstNeedsNoncompliantFEN, option: See 4.1. (line 1720)
4625 firstNPS, option: See 4.1. (line 1535)
4626 firstOptions, option: See 4.1. (line 1709)
4627 firstPgnName, option: See 4.2. (line 1813)
4628 firstPlaysBlack, option: See 4.1. (line 1619)
4629 firstProtocolVersion, option: See 4.1. (line 1687)
4630 firstScoreAbs, option: See 4.1. (line 1695)
4631 firstTimeOdds, option: See 4.1. (line 1553)
4632 firstXBook, option: See 4.2. (line 1792)
4633 Flash Moves, Menu Item: See 3.7. (line 975)
4634 Flash Rate, Menu Item: See 3.7. (line 975)
4635 flash, option: See 4.6. (line 2551)
4636 flashCount, option: See 4.6. (line 2551)
4637 flashRate, option: See 4.6. (line 2551)
4638 Flip View, Menu Item: See 3.3. (line 456)
4639 flip, option: See 4.6. (line 2507)
4640 flipView, option: See 4.6. (line 2507)
4641 fn, option: See 4.2. (line 1813)
4642 fNoOwnBookUCI, option: See 4.2. (line 1792)
4643 Font, clock: See 4.6. (line 2589)
4644 Font, coordinates: See 4.6. (line 2595)
4645 Font, message: See 4.6. (line 2602)
4646 fontSizeTolerance, option: See 4.6. (line 2608)
4647 Forward to End, Menu Item: See 3.2. (line 441)
4648 Forward, Menu Item: See 3.2. (line 409)
4649 fSAN, option: See 4.6. (line 2577)
4650 fUCCI, option: See 4.2. (line 1754)
4651 fUCI, option: See 4.2. (line 1744)
4652 fUSI, option: See 4.2. (line 1754)
4653 Game File with Opening Lines, Menu Item: See 3.7. (line 1246)
4654 Game List Tags, Menu Item <1>: See 3.7. (line 1353)
4655 Game List Tags, Menu Item: See 3.3. (line 518)
4656 Game Number, Menu Item: See 3.7. (line 1246)
4657 gameListTags, option: See 4.5. (line 2362)
4658 games, ICS command: See 5. (line 3065)
4659 gateway, option: See 4.4. (line 1995)
4660 General Options, Menu Item: See 3.7. (line 804)
4661 geometry, option: See 4.6. (line 2401)
4662 Get Move List, Menu Item: See 3.7. (line 1104)
4663 getMoveList, option: See 4.4. (line 2127)
4664 Help Menu: See 3.8. (line 1397)
4665 help, ICS command: See 5. (line 3050)
4666 Hide Thinking, Menu Item: See 3.7. (line 877)
4667 highlight Arrow, option: See 4.6. (line 2564)
4668 Highlight Last Move, Menu Item: See 3.7. (line 887)
4669 Highlight with Arrow, Menu Item: See 3.7. (line 893)
4670 highlight, option: See 4.6. (line 2560)
4671 highlightLastMove, option: See 4.6. (line 2560)
4672 highlightMoveWithArrow, option: See 4.6. (line 2564)
4673 highlightSquareColor, option: See 4.6. (line 2666)
4674 Hint, Menu Item: See 3.6. (line 767)
4675 holdingsSize, option: See 4.8. (line 2905)
4676 iconic, option: See 4.6. (line 2401)
4677 ICS: See 5. (line 3021)
4678 ICS Alarm Time, Menu Item: See 3.7. (line 1152)
4679 ICS Alarm, Menu Item: See 3.7. (line 1152)
4680 ICS Client, Menu Item: See 3.4. (line 595)
4681 ICS Input Box, Menu Item: See 3.3. (line 502)
4682 ICS options: See 4.4. (line 1950)
4683 ICS Options, Menu Item: See 3.7. (line 1046)
4684 ICS, addresses: See 5. (line 3021)
4685 ics, option: See 4.4. (line 1951)
4686 icsAlarm, option: See 4.4. (line 2131)
4687 icsAlarmTime, option: See 4.4. (line 2135)
4688 icscomm, option: See 4.4. (line 2003)
4689 icshelper, option: See 4.4. (line 1969)
4690 icshost, option: See 4.4. (line 1956)
4691 icsinput, option: See 4.4. (line 2060)
4692 icslogon, option: See 4.4. (line 2045)
4693 icsport, option: See 4.4. (line 1965)
4694 inc, option: See 4.1. (line 1505)
4695 Info XBoard, Menu Item: See 3.8. (line 1398)
4696 init, option: See 4.5. (line 2371)
4697 initalMode, option: See 4.8. (line 2826)
4698 initString, option: See 4.1. (line 1643)
4699 Internet Chess Server: See 5. (line 3021)
4700 internetChessServerCommPort, option: See 4.4. (line 2003)
4701 internetChessServerHelper, option: See 4.4. (line 1969)
4702 internetChessServerHost, option: See 4.4. (line 1956)
4703 internetChessServerInputBox, option: See 4.4. (line 2060)
4704 internetChessServerLogonScript, option: See 4.4. (line 2045)
4705 internetChessServerMode, option: See 4.4. (line 1951)
4706 internetChessServerPort, option: See 4.4. (line 1965)
4708 See ``Introduction''. (line 9)
4709 Keys: See 3.9. (line 1417)
4710 legal, option: See 4.6. (line 2449)
4711 lgf, option: See 4.5. (line 2278)
4712 lgi, option: See 4.5. (line 2278)
4713 lightSquareColor, option: See 4.6. (line 2666)
4714 Limitations: See 8. (line 3248)
4715 liteBackTextureFile, option: See 4.6. (line 2690)
4716 Load and Save options: See 4.5. (line 2276)
4717 Load Engine, Menu Item: See 3.6. (line 717)
4718 Load Game Options, Menu Item: See 3.7. (line 1293)
4719 Load Game, Menu Item: See 3.1. (line 166)
4720 Load Next Game, Menu Item: See 3.9. (line 1421)
4721 Load Next Position, Menu Item: See 3.1. (line 208)
4722 Load Position, Menu Item: See 3.1. (line 199)
4723 Load Previous Game, Menu Item: See 3.9. (line 1425)
4724 Load Previous Position, Menu Item: See 3.1. (line 212)
4725 loadGameFile, option: See 4.5. (line 2278)
4726 loadGameIndex, option: See 4.5. (line 2278)
4727 loadPositionFile, option: See 4.5. (line 2320)
4728 loadPositionIndex, option: See 4.5. (line 2320)
4729 lowTimeWarning, option: See 4.4. (line 2139)
4730 lowTimeWarningColor, option: See 4.6. (line 2666)
4731 lpf, option: See 4.5. (line 2320)
4732 lpi, option: See 4.5. (line 2320)
4733 Machine Black, Menu Item: See 3.4. (line 528)
4734 Machine match, Menu Item: See 3.4. (line 619)
4735 Machine White, Menu Item: See 3.4. (line 524)
4736 Mail Move, Menu Item: See 3.1. (line 239)
4737 Major modes: See 1. (line 19)
4738 Man XBoard, Menu Item: See 3.8. (line 1405)
4739 Match Options, Menu Item: See 3.7. (line 1168)
4740 matchGames, option: See 4.1. (line 1590)
4741 matchMode, option: See 4.1. (line 1602)
4742 matchPause, option: See 4.3. (line 1869)
4743 materialDraws, option: See 4.7. (line 2786)
4744 Menu, Action: See 3.5. (line 651)
4745 Menu, Edit: See 3.2. (line 247)
4746 Menu, Engine: See 3.6. (line 716)
4747 Menu, File: See 3.1. (line 122)
4748 Menu, Help: See 3.8. (line 1397)
4749 Menu, Mode: See 3.4. (line 523)
4750 Menu, Options: See 3.7. (line 803)
4751 Menu, View: See 3.3. (line 455)
4752 Menus: See 3. (line 119)
4753 messageFont, option: See 4.6. (line 2602)
4754 mg, option: See 4.1. (line 1590)
4755 mm, option: See 4.1. (line 1602)
4756 Mode Menu: See 3.4. (line 523)
4757 mode, option: See 4.8. (line 2826)
4758 mono, option: See 4.6. (line 2539)
4759 monoMode, option: See 4.6. (line 2539)
4760 Move Now, Menu Item: See 3.6. (line 780)
4761 Move Sound, Menu Item: See 3.7. (line 898)
4762 moves, option: See 4.4. (line 2127)
4763 movesound, option: See 4.6. (line 2428)
4764 movesPerSession, option: See 4.1. (line 1501)
4765 mps, option: See 4.1. (line 1501)
4766 msLoginDelay, option: See 4.4. (line 2054)
4767 nameOfDebugFile, option: See 4.8. (line 2963)
4768 ncp, option: See 4.8. (line 2821)
4769 New Game, Menu Item: See 3.1. (line 123)
4770 New Shuffle Game, Menu Item: See 3.1. (line 132)
4771 New variant, Menu Item: See 3.1. (line 147)
4772 niceEngines, option: See 4.1. (line 1701)
4773 noChessProgram, option: See 4.8. (line 2821)
4774 noGUI, option: See 4.6. (line 2404)
4775 null move: See 3.4. (line 536)
4776 number of consecutive positions, Menu Item: See 3.7. (line 1324)
4777 Number of tourney cycles, Menu Item: See 3.7. (line 1227)
4778 observe, ICS command: See 5. (line 3108)
4779 oldmoves, ICS command: See 5. (line 3112)
4780 oldsave, option: See 4.5. (line 2358)
4781 oldSaveStyle, option: See 4.5. (line 2358)
4782 One-Click Moving, Menu Item: See 3.7. (line 907)
4783 oneClickMove, option: See 4.6. (line 2421)
4784 Options: See 4. (line 1476)
4785 Options Menu: See 3.7. (line 803)
4786 Options, adjudication: See 4.7. (line 2760)
4787 options, Chess engine: See 4.1. (line 1495)
4788 Options, ICS: See 4.4. (line 1950)
4789 Options, Load and Save: See 4.5. (line 2276)
4790 Options, miscellaneous: See 4.8. (line 2820)
4791 Options, Tournament: See 4.3. (line 1863)
4792 Options, User interface: See 4.6. (line 2397)
4793 Other programs: See 12. (line 3571)
4794 overrideLineGap, option: See 4.6. (line 2488)
4795 pairingEngine, option: See 4.3. (line 1916)
4796 participants, option: See 4.3. (line 1895)
4797 Paste Game, Menu Item: See 3.2. (line 273)
4798 Paste Position, Menu Item: See 3.2. (line 277)
4799 Pause, Menu Item: See 3.4. (line 625)
4800 Periodic Updates, Menu Item: See 3.7. (line 919)
4801 periodic, option: See 4.6. (line 2572)
4802 periodicUpdates, option: See 4.6. (line 2572)
4803 pgnEventHeader, option: See 4.5. (line 2345)
4804 pgnExtendedInfo, option: See 4.5. (line 2340)
4805 pgnNumberTag, option: See 4.5. (line 2349)
4806 pieceMenu, option: See 4.6. (line 2733)
4807 pieceNickNames, option: See 4.8. (line 2944)
4808 pieceToCharTable, option: See 4.8. (line 2918)
4809 pixmap, option: See 4.6. (line 2618)
4810 pixmapDirectory, option: See 4.6. (line 2618)
4811 polyglotBook, option: See 4.2. (line 1783)
4812 polyglotDir, option: See 4.2. (line 1776)
4813 Ponder Next Move, Menu Item: See 3.7. (line 925)
4814 ponder, option: See 4.1. (line 1581)
4815 ponderNextMove, option: See 4.1. (line 1581)
4816 Popup Exit Message, Menu Item: See 3.7. (line 931)
4817 Popup Move Errors, Menu Item: See 3.7. (line 937)
4818 popup, option: See 4.6. (line 2437)
4819 popupExitMessage, option: See 4.6. (line 2433)
4820 popupMoveErrors, option: See 4.6. (line 2437)
4821 Position Number, Menu Item: See 3.7. (line 1246)
4822 pre, option: See 4.4. (line 2143)
4823 preblack, option: See 4.4. (line 2149)
4824 Premove Black, Menu Item: See 3.7. (line 1137)
4825 Premove White, Menu Item: See 3.7. (line 1137)
4826 Premove, Menu Item: See 3.7. (line 1137)
4827 premove, option: See 4.4. (line 2143)
4828 premoveBlack, option: See 4.4. (line 2149)
4829 premoveBlackText, option: See 4.4. (line 2149)
4830 premoveHighlightColor, option: See 4.6. (line 2666)
4831 premoveWhite, option: See 4.4. (line 2149)
4832 premoveWhiteText, option: See 4.4. (line 2149)
4833 prewhite, option: See 4.4. (line 2149)
4834 Problems: See 9. (line 3303)
4835 queen, option: See 4.6. (line 2441)
4836 Quiet Play, Menu Item: See 3.7. (line 1116)
4837 quiet, option: See 4.4. (line 2154)
4838 quietPlay, option: See 4.4. (line 2154)
4839 recentEngineList, option: See 4.6. (line 2411)
4840 recentEngines, option: See 4.6. (line 2411)
4841 Recently Used Engines, In Menu: See 3.6. (line 792)
4842 Reload CMail Message, Menu Item: See 3.1. (line 239)
4843 Reload Same Game, Menu Item: See 3.9. (line 1430)
4844 Reload Same Position, Menu Item: See 3.9. (line 1435)
4845 remoteShell, option: See 4.8. (line 2984)
4846 remoteUser, option: See 4.8. (line 2989)
4847 Replace Engine, Menu Item: See 3.7. (line 1270)
4848 Reporting bugs: See 9. (line 3303)
4849 Reporting problems: See 9. (line 3303)
4850 Resign, Menu Item: See 3.5. (line 686)
4851 resource name, option: See 4.6. (line 2401)
4852 results, option: See 4.3. (line 1902)
4853 Retract Move, Menu Item: See 3.6. (line 784)
4854 reuse, option: See 4.1. (line 1678)
4855 reuse2, option: See 4.1. (line 1678)
4856 reuseFirst, option: See 4.1. (line 1678)
4857 reuseSecond, option: See 4.1. (line 1678)
4858 Revert, Menu Item: See 3.2. (line 365)
4859 Rewind Index after, Menu Item: See 3.7. (line 1246)
4860 ringBellAfterMoves, option: See 4.6. (line 2428)
4861 rsh, option: See 4.8. (line 2984)
4862 ruleMoves, option: See 4.7. (line 2804)
4863 ruser, option: See 4.8. (line 2989)
4864 sameColorGames, option: See 4.1. (line 1606)
4865 Save Game Options, Menu Item: See 3.7. (line 1338)
4866 Save Game, Menu Item: See 3.1. (line 217)
4867 Save Position, Menu Item: See 3.1. (line 229)
4868 Save Settings Now, Menu Item: See 3.7. (line 1375)
4869 Save Settings on Exit, Menu Item: See 3.7. (line 1389)
4870 Save Tourney Games, Menu Item: See 3.7. (line 1238)
4871 saveGameFile, option: See 4.5. (line 2310)
4872 saveOutOfBookInfo, option: See 4.5. (line 2353)
4873 savePositionFile, option: See 4.5. (line 2335)
4874 saveSettingsFile, option: See 4.5. (line 2371)
4875 saveSettingsOnExit, option: See 4.5. (line 2391)
4876 Scores in Move List, Menu Item: See 3.7. (line 946)
4877 scoreWhite, option: See 4.6. (line 2753)
4878 scp, option: See 4.1. (line 1615)
4879 sd, option: See 4.1. (line 1526)
4880 Search mode, Menu Item: See 3.7. (line 1309)
4881 searchDepth, option: See 4.1. (line 1526)
4882 searchMode, option: See 4.8. (line 3004)
4883 searchTime, option: See 4.1. (line 1519)
4884 secondChessProgram, option: See 4.1. (line 1615)
4885 secondComputerString, option: See 4.1. (line 1670)
4886 secondDirectory, option: See 4.1. (line 1634)
4887 secondHasOwnBookUCI, option: See 4.2. (line 1792)
4888 secondHost, option: See 4.1. (line 1626)
4889 secondInitString, option: See 4.1. (line 1643)
4890 secondIsUCI, option: See 4.2. (line 1744)
4891 secondNeedsNoncompliantFEN, option: See 4.1. (line 1720)
4892 secondNPS, option: See 4.1. (line 1535)
4893 secondOptions, option: See 4.1. (line 1709)
4894 secondPgnName, option: See 4.2. (line 1813)
4895 secondProtocolVersion, option: See 4.1. (line 1687)
4896 secondScoreAbs, option: See 4.1. (line 1695)
4897 secondTimeOdds, option: See 4.1. (line 1553)
4898 secondXBook, option: See 4.2. (line 1792)
4899 seedBase, option: See 4.3. (line 1942)
4900 Seek Graph, Menu Item: See 3.7. (line 1122)
4901 seekGraph, option: See 4.4. (line 2084)
4902 Select Engine, Menu Item: See 3.7. (line 1202)
4903 set, ICS command: See 5. (line 3105)
4904 Settings, Engine: See 4.2. (line 1742)
4905 SettingsFile, option: See 4.5. (line 2371)
4906 sg, option: See 4.4. (line 2084)
4907 sgf, option: See 4.5. (line 2310)
4908 sh, option: See 4.1. (line 1626)
4909 Shortcut keys: See 3.9. (line 1417)
4910 Show Coords, Menu Item: See 3.7. (line 950)
4911 Show Engine Output, Menu Item: See 3.3. (line 461)
4912 Show Evaluation Graph, Menu Item: See 3.3. (line 482)
4913 Show Game List, Menu Item: See 3.3. (line 488)
4914 Show Last Move, Shortcut Key: See 3.9. (line 1418)
4915 Show Move History, Menu Item: See 3.3. (line 476)
4916 Show Target Squares, Menu Item: See 3.7. (line 954)
4917 showButtonBar, option: See 4.6. (line 2525)
4918 showCoords, option: See 4.6. (line 2495)
4919 showEvalInMoveHistory, option: See 4.6. (line 2584)
4920 showTargetSquares, option: See 4.6. (line 2544)
4921 showThinking, option: See 4.1. (line 1571)
4922 shuffleOpenings, option: See 4.1. (line 1734)
4923 size, option: See 4.6. (line 2453)
4924 sn, option: See 4.2. (line 1813)
4925 sNoOwnBookUCI, option: See 4.2. (line 1792)
4926 Sound Options, Menu Item: See 3.7. (line 1357)
4927 soundChallenge, option: See 4.4. (line 2226)
4928 soundChannel, option: See 4.4. (line 2226)
4929 soundChannel1, option: See 4.4. (line 2226)
4930 soundCShout, option: See 4.4. (line 2226)
4931 soundDirectory, option: See 4.4. (line 2213)
4932 soundIcsAlarm, option: See 4.4. (line 2235)
4933 soundIcsDraw, option: See 4.4. (line 2246)
4934 soundIcsLoss, option: See 4.4. (line 2242)
4935 soundIcsUnfinished, option: See 4.4. (line 2250)
4936 soundIcsWin, option: See 4.4. (line 2238)
4937 soundKibitz, option: See 4.4. (line 2226)
4938 soundMove, option: See 4.4. (line 2232)
4939 soundProgram, option: See 4.4. (line 2204)
4940 soundRequest, option: See 4.4. (line 2226)
4941 Sounds: See 4.4. (line 2204)
4942 soundSeek, option: See 4.4. (line 2226)
4943 soundShout, option: See 4.4. (line 2226)
4944 soundSShout, option: See 4.4. (line 2226)
4945 soundTell, option: See 4.4. (line 2226)
4946 spf, option: See 4.5. (line 2335)
4947 sSAN, option: See 4.6. (line 2577)
4948 st, option: See 4.1. (line 1519)
4949 Stop Examining, Menu Item: See 3.5. (line 695)
4950 Stop Observing, Menu Item: See 3.5. (line 690)
4951 sUCCI, option: See 4.2. (line 1754)
4952 sUCI, option: See 4.2. (line 1744)
4953 sUSI, option: See 4.2. (line 1754)
4954 sweepPromotion, option: See 4.6. (line 2445)
4955 Sync after cycle, Menu Item: See 3.7. (line 1193)
4956 Sync after round, Menu Item: See 3.7. (line 1193)
4957 syncAfterCycle, option: See 4.3. (line 1937)
4958 syncAfterRound, option: See 4.3. (line 1937)
4959 Tags, Menu Item: See 3.3. (line 492)
4960 tc, option: See 4.1. (line 1496)
4961 td, option: See 4.5. (line 2304)
4962 telnet, option: See 4.4. (line 1977)
4963 telnetProgram, option: See 4.4. (line 1986)
4964 Test Legality, Menu Item: See 3.7. (line 961)
4965 testClaims, option: See 4.7. (line 2780)
4966 testLegality, option: See 4.6. (line 2449)
4967 tf, option: See 4.3. (line 1877)
4968 thinking, option: See 4.1. (line 1571)
4969 Time Control, Menu Item: See 3.7. (line 989)
4970 timeControl, option: See 4.1. (line 1496)
4971 timeDelay, option: See 4.5. (line 2304)
4972 timeIncrement, option: See 4.1. (line 1505)
4973 timeOddsMode, option: See 4.1. (line 1559)
4974 title, option: See 4.6. (line 2517)
4975 titleInWindow, option: See 4.6. (line 2517)
4976 Tournament file, Menu item: See 3.7. (line 1173)
4977 Tournament Options: See 4.3. (line 1863)
4978 Tourney participants, Menu Item: See 3.7. (line 1202)
4979 Tourney type, Menu Item: See 3.7. (line 1213)
4980 tourneyCycles, option: See 4.3. (line 1891)
4981 tourneyFile, option: See 4.3. (line 1877)
4982 tourneyType, option: See 4.3. (line 1885)
4983 Training, Menu Item: See 3.4. (line 585)
4984 trivialDraws, option: See 4.7. (line 2793)
4985 Truncate Game, Menu Item: See 3.2. (line 384)
4986 tt, option: See 4.3. (line 1885)
4987 Two Machines, Menu Item: See 3.4. (line 532)
4988 Upgrade Engine, Menu Item: See 3.7. (line 1270)
4989 Upload to Examine, Menu Item: See 3.5. (line 700)
4990 useBoardTexture, option: See 4.6. (line 2690)
4991 usePolyglotBook, option: See 4.2. (line 1780)
4992 User interface options: See 4.6. (line 2397)
4993 userName, option: See 4.8. (line 2993)
4994 useTelnet, option: See 4.4. (line 1977)
4995 uxiAdapter, option: See 4.2. (line 1770)
4996 variant, option: See 4.8. (line 2834)
4997 variations, option: See 4.6. (line 2742)
4998 vars, ICS command: See 5. (line 3102)
4999 View Menu: See 3.3. (line 455)
5000 whitePieceColor, option: See 4.6. (line 2666)
5001 who, ICS command: See 5. (line 3058)
5002 xflash, option: See 4.6. (line 2551)
5003 year, Menu Item: See 3.7. (line 1304)
5004 Zoom factor in Evaluation Graph, Menu Item: See 3.7. (line 984)
5011 3 Menus, buttons, and keys
5020 3.9 Other Shortcut Keys
5022 4.1 Chess Engine Options
5023 4.2 UCI + WB Engine Settings
5024 4.3 Tournament options
5026 4.5 Load and Save options
5027 4.6 User interface options
5028 4.7 Adjudication Options
5032 7 Environment variables
5033 8 Limitations and known bugs
5034 9 Reporting problems
5035 10 Authors and contributors
5038 11.2 Starting a CMail Game
5039 11.3 Answering a Move
5040 11.4 Multi-Game Messages
5041 11.5 Completing a Game
5042 11.6 Known CMail Problems
5043 12 Other programs you can use with XBoard
5050 GNU GENERAL PUBLIC LICENSE
projects / xboard.git / blob