150968942d8f1ee67638dfa93197e93b37d7f9eb
[xboard.git] / manual / html_node / Options-Menu.html
1 <html lang="en">
2 <head>
3 <title>Options Menu - XBoard</title>
4 <meta http-equiv="Content-Type" content="text/html">
5 <meta name="description" content="XBoard">
6 <meta name="generator" content="makeinfo 4.13">
7 <link title="Top" rel="start" href="index.html#Top">
8 <link rel="up" href="Menus.html#Menus" title="Menus">
9 <link rel="prev" href="Engine-Menu.html#Engine-Menu" title="Engine Menu">
10 <link rel="next" href="Help-Menu.html#Help-Menu" title="Help Menu">
11 <link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
12 <meta http-equiv="Content-Style-Type" content="text/css">
13 <style type="text/css"><!--
14   pre.display { font-family:inherit }
15   pre.format  { font-family:inherit }
16   pre.smalldisplay { font-family:inherit; font-size:smaller }
17   pre.smallformat  { font-family:inherit; font-size:smaller }
18   pre.smallexample { font-size:smaller }
19   pre.smalllisp    { font-size:smaller }
20   span.sc    { font-variant:small-caps }
21   span.roman { font-family:serif; font-weight:normal; } 
22   span.sansserif { font-family:sans-serif; font-weight:normal; } 
23 --></style>
24 </head>
25 <body>
26 <div class="node">
27 <a name="Options-Menu"></a>
28 <p>
29 Next:&nbsp;<a rel="next" accesskey="n" href="Help-Menu.html#Help-Menu">Help Menu</a>,
30 Previous:&nbsp;<a rel="previous" accesskey="p" href="Engine-Menu.html#Engine-Menu">Engine Menu</a>,
31 Up:&nbsp;<a rel="up" accesskey="u" href="Menus.html#Menus">Menus</a>
32 <hr>
33 </div>
34
35 <h3 class="section">3.7 Options Menu</h3>
36
37 <p><a name="index-Menu_002c-Options-92"></a><a name="index-Options-Menu-93"></a>
38      <dl>
39 <dt>General Options<dd><a name="index-General-Options_002c-Menu-Item-94"></a>The following items to set option values appear in the dialog
40 summoned by the general Options menu item. 
41 <dt>Absolute Analysis Scores<dd><a name="index-Absolute-Analysis-Scores_002c-Menu-Item-95"></a>Controls if scores on the Engine Output window during analysis
42 will be printed from the white or the side-to-move point-of-view. 
43 <dt>Almost Always Queen<dd><a name="index-Almost-Always-Queen_002c-Menu-Item-96"></a>If this option is on, 7th-rank pawns automatically change into
44 Queens when you pick them up,
45 and when you drag them to the promotion square and release them there,
46 they will promote to that. 
47 But when you drag such a pawn backwards first,
48 its identity will start to cycle through the other available pieces. 
49 This will continue until you start to move it forward;
50 at which point the identity of the piece will be fixed,
51 so that you can safely put it down on the promotion square. 
52 If this option is off, what happens depends on the
53 option <code>alwaysPromoteToQueen</code>,
54 which would force promotion to Queen when true. 
55 Otherwise XBoard would bring up a dialog
56 box whenever you move a pawn to the last rank, asking what piece
57 you want to promote to. 
58 <dt>Animate Dragging<dd><a name="index-Animate-Dragging_002c-Menu-Item-97"></a>If Animate Dragging is on, while you are dragging a piece with the
59 mouse, an image of the piece follows the mouse cursor. 
60 If Animate Dragging is off, there is no visual feedback while you are
61 dragging a piece, but if Animate Moving is on, the move will be
62 animated when it is complete. 
63 <dt>Animate Moving<dd><a name="index-Animate-Moving_002c-Menu-Item-98"></a>If Animate Moving is on, all piece moves are animated.  An image of the
64 piece is shown moving from the old square to the new square when the
65 move is completed (unless the move was already animated by Animate Dragging). 
66 If Animate Moving is off, a moved piece instantly disappears from its
67 old square and reappears on its new square when the move is complete. 
68 The shifted <kbd>Ctrl-A</kbd> key is a keyboard equivalent. 
69 <dt>Auto Flag<dd><a name="index-Auto-Flag_002c-Menu-Item-99"></a>If this option is on and one player runs out of time
70 before the other,
71 XBoard
72 will automatically call his flag, claiming a win on time. 
73 The shifted <kbd>Ctrl-F</kbd> key is a keyboard equivalent. 
74 In ICS mode, Auto Flag will only call your opponent's flag, not yours,
75 and the ICS may award you a draw instead of a win if you have
76 insufficient mating material.  In local chess engine mode,
77 XBoard
78 may call either player's flag and will not take material into account (?). 
79 <dt>Auto Flip View<dd><a name="index-Auto-Flip-View_002c-Menu-Item-100"></a>If the Auto Flip View option is on when you start a game, the board
80 will be automatically oriented so that your pawns move from the bottom
81 of the window towards the top.
82
83      <p>If you are playing a game on an ICS, the board is always
84 oriented at the start of the game so that your pawns move from
85 the bottom of the window towards the top. Otherwise, the starting
86 orientation is determined by the <code>flipView</code> command line option;
87 if it is false (the default), White's pawns move from bottom to top
88 at the start of each game; if it is true, Black's pawns move from
89 bottom to top. See <a href="User-interface-options.html#User-interface-options">User interface options</a>. 
90 <dt>Blindfold<dd><a name="index-Blindfold_002c-Menu-Item-101"></a>If this option is on, XBoard displays the board as usual but does
91 not display pieces or move highlights.  You can still move in the
92 usual way (with the mouse or by typing moves in ICS mode), even though
93 the pieces are invisible. 
94 <dt>Drop Menu<dd><a name="index-Drop-Menu_002c-Menu-Item-102"></a>Controls if right-clicking the board in crazyhouse / bughouse
95 will pop up a menu to drop a piece on the clicked square
96 (old, deprecated behavior)
97 or allow you to step through an engine PV
98 (new, recommended behavior). 
99 <dt>Hide Thinking<dd><a name="index-Hide-Thinking_002c-Menu-Item-103"></a>If this option is off, the chess engine's notion of the score and best
100 line of play from the current position is displayed as it is
101 thinking. The score indicates how many pawns ahead (or if negative,
102 behind) the chess engine thinks it is. In matches between two
103 machines, the score is prefixed by &lsquo;<samp><span class="samp">W</span></samp>&rsquo; or &lsquo;<samp><span class="samp">B</span></samp>&rsquo; to indicate
104 whether it is showing White's thinking or Black's, and only the thinking
105 of the engine that is on move is shown. 
106 The shifted <kbd>Ctrl-H</kbd> key is a keyboard equivalent. 
107 <dt>Highlight Last Move<dd><a name="index-Highlight-Last-Move_002c-Menu-Item-104"></a>If Highlight Last Move is on, after a move is made, the starting and
108 ending squares remain highlighted. In addition, after you use Backward
109 or Back to Start, the starting and ending squares of the last move to
110 be unmade are highlighted. 
111 <dt>Highlight with Arrow<dd><a name="index-Highlight-with-Arrow_002c-Menu-Item-105"></a>Causes the highlighting described in Highlight Last Move to be done
112 by drawing an arrow between the highlighted squares,
113 so that it is visible even when the width of the grid lines is set to zero. 
114 <dt>Move Sound<dd><a name="index-Move-Sound_002c-Menu-Item-106"></a>Enables the sounding of an audible signal when the computer performs a move. 
115 For the selection of the sound, see &lsquo;<samp><span class="samp">Sound Options</span></samp>&rsquo;. 
116 If you turn on this option when using XBoard with the Internet
117 Chess Server, you will probably want to give the
118 <kbd>set bell 0</kbd>
119 command to the ICS, since otherwise the ICS will ring the terminal bell
120 after every move (not just yours). (The <samp><span class="file">.icsrc</span></samp> file
121 is a good place for this; see <a href="ICS-options.html#ICS-options">ICS options</a>.) 
122 <dt>One-Click Moving<dd><a name="index-One_002dClick-Moving_002c-Menu-Item-107"></a>If this option is on, XBoard does not wait for you to click both the
123 from- and the to-square, or drag the piece, but performs a move as soon
124 as it is uniqely specified. 
125 This applies to clicking an own piece that only has a single legal move,
126 clicking an empty square or opponent piece where only one of your pieces
127 can move (or capture) to. 
128 Furthermore, a double-click on a piece that can only make a single capture
129 will cause that capture to be made. 
130 Promoting a Pawn by clicking its to-square will suppress the promotion
131 popup or other methods for selecting an under-promotion,
132 and make it promote to Queen. 
133 <dt>Periodic Updates<dd><a name="index-Periodic-Updates_002c-Menu-Item-108"></a>If this option is off (or if
134 you are using a chess engine that does not support periodic updates),
135 the analysis window
136 will only be updated when the analysis changes. If this option is
137 on, the Analysis Window will be updated every two seconds. 
138 <dt>Ponder Next Move<dd><a name="index-Ponder-Next-Move_002c-Menu-Item-109"></a>If this option is off, the chess engine will think only when it is on
139 move.  If the option is on, the engine will also think while waiting
140 for you to make your move. 
141 The shifted <kbd>Ctrl-P</kbd> key is a keyboard equivalent. 
142 <dt>Popup Exit Message<dd><a name="index-Popup-Exit-Message_002c-Menu-Item-110"></a>If this option is on, when XBoard wants to display a message just
143 before exiting, it brings up a modal dialog box and waits for you to
144 click OK before exiting.  If the option is off, XBoard prints the
145 message to standard error (the terminal) and exits immediately. 
146 <dt>Popup Move Errors<dd><a name="index-Popup-Move-Errors_002c-Menu-Item-111"></a>If this option is off, when you make an error in moving (such as
147 attempting an illegal move or moving the wrong color piece), the
148 error message is displayed in the message area.  If the option is
149 on, move errors are displayed in small pop-up windows like other errors. 
150 You can dismiss an error pop-up either by clicking its OK button or by
151 clicking anywhere on the board, including down-clicking to start a move. 
152 <dt>Scores in Move List<dd><a name="index-Scores-in-Move-List_002c-Menu-Item-112"></a>If this option is on, XBoard will display the depth and score
153 of engine moves in the Move List, in the format of a PGN comment. 
154 <dt>Show Coords<dd><a name="index-Show-Coords_002c-Menu-Item-113"></a>If this option is on, XBoard displays algebraic coordinates
155 along the board's left and bottom edges. 
156 <dt>Show Target Squares<dd><a name="index-Show-Target-Squares_002c-Menu-Item-114"></a>If this option is on, all squares a piece that is 'picked up' with the mouse
157 can legally move to are highighted with a fat colored dot in the
158 highlightColor (non-captures) or premoveHighlightColor (captures). 
159 Legality testing must be on for XBoard to know how the piece moves. 
160 <dt>Test Legality<dd><a name="index-Test-Legality_002c-Menu-Item-115"></a>If this option is on, XBoard tests whether the moves you try to make
161 with the mouse are legal and refuses to let you make an illegal move. 
162 The shifted <kbd>Ctrl-L</kbd> key is a keyboard equivalent. 
163 Moves loaded from a file with &lsquo;<samp><span class="samp">Load Game</span></samp>&rsquo; are also checked.  If
164 the option is off, all moves are accepted, but if a local chess engine
165 or the ICS is active, they will still reject illegal moves.  Turning
166 off this option is useful if you are playing a chess variant with
167 rules that XBoard does not understand.  (Bughouse, suicide, and wild
168 variants where the king may castle after starting on the d file are
169 generally supported with Test Legality on.) 
170 <dt>Flash Moves<dt>Flash Rate<dd><a name="index-Flash-Moves_002c-Menu-Item-116"></a><a name="index-Flash-Rate_002c-Menu-Item-117"></a>If this option is non-zero, whenever a move is completed,
171 the moved piece flashes the specified number of times. 
172 The flash-rate setting determines how rapidly this flashing occurs. 
173 <dt>Animation Speed<dd><a name="index-Animation-Speed_002c-Menu-Item-118"></a>Determines the duration (in msec) of an animation step,
174 when &lsquo;<samp><span class="samp">Animate Moving</span></samp>&rsquo; is swiched on. 
175 <dt>Zoom factor in Evaluation Graph<dd><a name="index-Zoom-factor-in-Evaluation-Graph_002c-Menu-Item-119"></a>Sets the valueof the <code>evalZoom</code> option,
176 indicating the factor by which the score interval (-1,1) should be
177 blown up on the vertical axis of the Evaluation Graph. 
178 <br><dt>Time Control<dd><a name="index-Time-Control_002c-Menu-Item-120"></a>Pops up a sub-menu where you can set the time-control parameters interactively. 
179 Allows you to select classical or incremental time controls,
180 set the moves per session, session duration, and time increment. 
181 Also allows specification of time-odds factors for one or both engines. 
182 If an engine is given a time-odds factor N, all time quota it gets,
183 be it at the beginning of a session or through the time increment or
184 fixed time per move, will be divided by N. 
185 The shifted <kbd>Alt+T</kbd> key is a keyboard equivalent. 
186 <br><dt>Common Engine<dd><a name="index-Common-Engine_002c-Menu-Item-121"></a>Pops up a sub-menu where you can set some engine parameters common to most engines,
187 such as hash-table size, tablebase cache size, maximum number of processors
188 that SMP engines can use, and where to find the Polyglot adapter needed
189 to run UCI engines under XBoard. The feature that allows setting of these parameters on
190 engines is new since XBoard 4.3.15, so not many XBoard/WinBoard engines respond
191 to it yet, but UCI engines should.
192
193      <p>It is also possible to specify a GUI opening book here, i.e. an opening
194 book that XBoard consults for any position a playing engine gets in. 
195 It then forces the engine to play the book move, rather than to think up its own,
196 if that position is found in the book. 
197 The book can switched on and off independently for either engine. 
198 The way book moves are chosen can be influenced through the settings of
199 book depth and variety. 
200 After both sides have played more moves than the specified depth,
201 the book will no longer be consulted. 
202 When the variety is set to 50, moves will be played with the probability
203 specified in the book. 
204 When set to 0, only the move(s) with the highest probability will be played. 
205 When set to 100, all listed moves will be played with equal pobability. 
206 Other settings interpolate between that. 
207 The shifted <kbd>Alt+U</kbd> key is a keyboard equivalent. 
208 <br><dt>Adjudications<dd><a name="index-Adjudications_002c-Menu-Item-122"></a>Pops up a sub-menu where you can enable or disable various adjudications
209 that XBoard can perform in engine-engine games. 
210 The shifted <kbd>Alt+J</kbd> key is a keyboard equivalent. 
211 You can instruct XBoard to detect and terminate the game on checkmate
212 or stalemate, even if the engines would not do so, to verify engine
213 result claims (forfeiting engines that make false claims), rather than
214 naively following the engine, to declare draw on positions
215 which can never be won for lack of mating material, (e.g. KBK),
216 or which are impossible to win unless the opponent seeks its own demise
217 (e.g. KBKN). 
218 For these adjudications to work, &lsquo;<samp><span class="samp">Test Legality</span></samp>&rsquo; should be switched on. 
219 It is also possible to instruct XBoard to enforce a 50-move or 3-fold-repeat
220 rule and automatically declare draw (after a user-adjustable number of moves
221 or repeats) even if the engines are prepared to go on. 
222 It is also possible to have XBoard declare draw on games that seem to drag on
223 forever, or adjudicate a loss if both engines agree (for 3 consecutive moves) that one
224 of them is behind more than a user-adjustable score threshold. 
225 For the latter adjudication to work, XBoard should be able to properly understand
226 the engine's scores. To facilitate the latter, you can inform xboard here if
227 the engines report scores from the viewpoint of white, or from that of their own color.
228
229      <br><dt>ICS Options<dd><a name="index-ICS-Options_002c-Menu-Item-123"></a>The following options occur in a dialog summoned by the
230 ICS Options menu item. 
231 <dt>Auto Kibitz<dd><a name="index-Auto-Kibitz_002c-Menu-Item-124"></a>Setting this option when playing with or aginst a chess program on an ICS
232 will cause the last line of thinking output of the engine before its move
233 to be sent to the ICS in a kibitz command. 
234 In addition, any kibitz message received through the ICS from
235 an opponent chess program will be diverted to the engine-output window,
236 (and suppressed in the console),
237 where you can play through its PV by right-clicking it. 
238 <dt>Auto Comment<dd><a name="index-Auto-Comment_002c-Menu-Item-125"></a>If this option is on, any remarks made on ICS while you are observing or
239 playing a game are recorded as a comment on the current move.  This includes
240 remarks made with the ICS commands <kbd>say</kbd>, <kbd>tell</kbd>, <kbd>whisper</kbd>,
241 and <kbd>kibitz</kbd>. 
242 Limitation: remarks that you type yourself are not recognized;
243 XBoard scans only the output from ICS, not the input you type to it. 
244 <dt>Auto Observe<dd><a name="index-Auto-Observe_002c-Menu-Item-126"></a>If this option is on and you add a player to your <code>gnotify</code>
245 list on ICS, XBoard will automatically observe all of that
246 player's games, unless you are doing something else (such as
247 observing or playing a game of your own) when one starts. 
248 The games are displayed
249 from the point of view of the player on your gnotify list; that is, his
250 pawns move from the bottom of the window towards the top. 
251 Exceptions:  If both players in a game are on your gnotify list, if
252 your ICS
253 <code>highlight</code>
254 variable is set to 0, or if the ICS you are using does not
255 properly support observing from Black's point of view,
256 you will see the game from White's point of view. 
257 <dt>Auto Raise Board<dd><a name="index-Auto-Raise-Board_002c-Menu-Item-127"></a>If this option is on, whenever a new game begins, the chessboard window
258 is deiconized (if necessary) and raised to the top of the stack of windows. 
259 <dt>Auto Save<dd><a name="index-Auto-Save_002c-Menu-Item-128"></a>If this option is true, at the end of every game XBoard prompts
260 you for a file name and appends a record of the game to the file
261 you specify. 
262 Disabled if the <code>saveGameFile</code> command-line
263 option is set, as in that case all games are saved to the specified file. 
264 See <a href="Load-and-Save-options.html#Load-and-Save-options">Load and Save options</a>. 
265 <dt>Background Observe<dd><a name="index-Background-Observe_002c-Menu-Item-129"></a>Setting this option will make XBoard suppress display of any boards
266 from observed games while you are playing. 
267 In stead the last such board will be remembered,
268 and shown to you when you right-click the board. 
269 This allows you to peek at your bughouse partner's game when you want,
270 without disturbing your own game too much. 
271 <dt>Dual Board<dd><a name="index-Dual-Board_002c-Menu-Item-130"></a>Setting this option in combination with &lsquo;<samp><span class="samp">Background Observe</span></samp>&rsquo;
272 will display boards of observed games while you are playing
273 on a second board next to that of your own game. 
274 <dt>Get Move List<dd><a name="index-Get-Move-List_002c-Menu-Item-131"></a>If this option is on, whenever XBoard
275 receives the first board of a new ICS game (or a different game from
276 the one it is currently displaying), it
277 retrieves the list of past moves from the ICS. 
278 You can then review the moves with the &lsquo;<samp><span class="samp">Forward</span></samp>&rsquo; and &lsquo;<samp><span class="samp">Backward</span></samp>&rsquo;
279 commands
280 or save them with &lsquo;<samp><span class="samp">Save Game</span></samp>&rsquo;.  You might want to
281 turn off this option if you are observing several blitz games at once,
282 to keep from wasting time and network bandwidth fetching the move lists over
283 and over. 
284 When you turn this option on from the menu, XBoard
285 immediately fetches the move list of the current game (if any). 
286 <dt>Quiet Play<dd><a name="index-Quiet-Play_002c-Menu-Item-132"></a>If this option is on, XBoard will automatically issue an ICS
287 <kbd>set shout 0</kbd>
288 command whenever you start a game and a
289 <kbd>set shout 1</kbd>
290 command whenever you finish one.  Thus, you will not be distracted
291 by shouts from other ICS users while playing. 
292 <dt>Seek Graph<dd><a name="index-Seek-Graph_002c-Menu-Item-133"></a>Setting this option will cause XBoard to display an graph of
293 currently active seek ads when you left-click the board
294 while idle and logged on to an ICS. 
295 <dt>Auto-Refresh Seek Graph<dd><a name="index-Auto_002dRefresh-Seek-Graph_002c-Menu-Item-134"></a>In combination with the &lsquo;<samp><span class="samp">Seek Graph</span></samp>&rsquo; option this
296 will cause automatic update of the seek graph while it is up. 
297 This only works on FICS and ICC,
298 and requires a lot of bandwidth on a busy server. 
299 <dt>Premove<dt>Premove White<dt>Premove Black<dt>First White Move<dt>First Black Move<dd><a name="index-Premove_002c-Menu-Item-135"></a><a name="index-Premove-White_002c-Menu-Item-136"></a><a name="index-Premove-Black_002c-Menu-Item-137"></a><a name="index-First-White-Move_002c-Menu-Item-138"></a><a name="index-First-Black-Move_002c-Menu-Item-139"></a>If this option is on while playing a game on an ICS, you can register
300 your next planned move before it is your turn.  Move the piece with
301 the mouse in the ordinary way, and the starting and ending squares
302 will be highlighted with a special color (red by default).  When it is
303 your turn, if your registered move is legal, XBoard will send it to
304 ICS immediately; if not, it will be ignored and you can make a
305 different move.  If you change your mind about your premove, either
306 make a different move, or double-click on any piece to cancel the move
307 entirely.
308
309      <p>You can also enter premoves for the first white and black moves
310 of the game. 
311 <dt>ICS Alarm<dt>ICS Alarm Time<dd><a name="index-ICS-Alarm_002c-Menu-Item-140"></a><a name="index-ICS-Alarm-Time_002c-Menu-Item-141"></a>When this option is on, an alarm sound is played when your clock
312 counts down to the icsAlarmTime in an ICS game. 
313 (By default, the time is 5 seconds, but you can pecify other values
314 with the Alarm Time spin control.) 
315 For games with time controls that include an increment, the
316 alarm will sound each time the clock counts down to the icsAlarmTime. 
317 By default, the alarm sound is the terminal bell, but on some systems
318 you can change it to a sound file using the soundIcsAlarm option; see
319 below. 
320 <dt>Colorize Messages<dd><a name="index-Colorize-Messages_002c-Menu-Item-142"></a>Ticking this options causes various types of ICS messages do be
321 displayed with different foreground or background colors in the console. 
322 The colors can be individually selected for each type,
323 through the accompanying text edits.
324
325      <br><dt>Match Options<dd><a name="index-Match-Options_002c-Menu-Item-143"></a>Summons a dialog where you can set options important for playing automatic
326 matches between two chess programs
327 (e.g. by using the &lsquo;<samp><span class="samp">Machine Match</span></samp>&rsquo; menu item in the &lsquo;<samp><span class="samp">Mode</span></samp>&rsquo; menu). 
328 <dt>Tournament file<dd><a name="index-Tournament-file_002c-Menu-item-144"></a>To run a tournament, XBoard needs a file to record its progress,
329 so it can resume the tourney when it is interrupted. 
330 When you want to conduct anything more complex than a simple
331 two-player match with the currently loaded engines,
332 (i.e. when you select a list of participants),
333 you must not leave this field blank. 
334 When you enter the name of an existing tournament file,
335 XBoard will ignore all other input specified in the dialog,
336 and will take them from that tournament file. 
337 This resumes an interrupted tournament, or adds another XBoard
338 agent playing games for it to those that are already doing so. 
339 Specifying a not-yet-existing file will cause XBoard to create it,
340 according to the tournament parameters specified in the rest of the dialog,
341 before it starts the tournament on ‘OK’. 
342 Provided that you specify participants;
343 without participants no tournament file will be made, but other entered values
344 (e.g. for the file with opening positions) will take effect. 
345 Default: configured by the <code>defaultTourneyName</code> option. 
346 <dt>Sync after round<dt>Sync after cycle<dd><a name="index-Sync-after-round_002c-Menu-Item-145"></a><a name="index-Sync-after-cycle_002c-Menu-Item-146"></a>The sync options, when on, will cause WinBoard to refrain from starting games
347 of the next round or cycle before all games of the previous round or cycle are finished. 
348 This guarantees correct ordering in the games file,
349 even when multiple XBoard instances are concurrently playing games for the same tourney. 
350 Default: sync after cycle, but not after round. 
351 <dt>Select Engine<dt>Tourney participants<dd><a name="index-Select-Engine_002c-Menu-Item-147"></a><a name="index-Tourney-participants_002c-Menu-Item-148"></a>With the Select Engine drop-down list you can pick an engine from your list
352 of installed engines in the settings file, to be added to the tournament. 
353 The engines selected so far will be listed in the ‘Tourney participants’ memo. 
354 The latter is a normal text edit, so you can use normal text-editing functions
355 to delete engines you selected by accident, or change their order. 
356 Do not type names yourself there, because names that do not exactly match
357 one of the names from the drop-down list will lead to undefined behavior. 
358 <dt>Tourney type<dd><a name="index-Tourney-type_002c-Menu-Item-149"></a>Here you can specify the type of tournament you want. 
359 XBoard’s intrinsic tournament manager support round-robins (type = 0),
360 where each participant plays every other participant, and (multi-)gauntlets,
361 where one (or a few) so-called ‘gauntlet engines’ play an independent set of opponents. 
362 In the latter case, you specify the number of gauntlet engines. 
363 E.g. if you specified 10 engines, and tourney type = 2,
364 the first 2 engines each play the remaining 8. 
365 A value of -1 instructs XBoard to play Swiss; for this to work an external
366 pairing engine must be specified through the <code>pairingEngine</code> option. 
367 Each Swiss round will be considered a tourney cycle in that case. 
368 Default:0
369 <dt>Number of tourney cycles<dt>Default number of Games<dd><a name="index-Number-of-tourney-cycles_002c-Menu-Item-150"></a><a name="index-Default-number-of-Games_002c-Menu-Item-151"></a>You can specify tourneys where every two opponents play each other multiple times. 
370 Such multiple games can be played in a row,
371 as specified by the ‘number of games per pairing’,
372 or by repeating the entire tournament schedule a number of times
373 (specified by the ‘number of tourney cycles’). 
374 The total number of times two engine meet will be the product of these two. 
375 Default is 1 cycle;
376 the number of games per pairing is the same as the default number of match games,
377 stored in your settings file through the <code>defaultMatchGames</code> option. 
378 <dt>Save Tourney Games<dd><a name="index-Save-Tourney-Games_002c-Menu-Item-152"></a>File where the tournament games are saved
379 (duplicate of the item in the &lsquo;<samp><span class="samp">Save Game Options</span></samp>&rsquo;). 
380 <dt>Game File with Opening Lines<dt>File with Start Positions<dt>Game Number<dt>Position Number<dt>Rewind Index after<dd><a name="index-Game-File-with-Opening-Lines_002c-Menu-Item-153"></a><a name="index-File-with-Start-Positions_002c-Menu-Item-154"></a><a name="index-Game-Number_002c-Menu-Item-155"></a><a name="index-Position-Number_002c-Menu-Item-156"></a><a name="index-Rewind-Index-after_002c-Menu-Item-157"></a>These items optionally specify the file with move sequences or board positions the tourney
381 games should start from. 
382 The corresponding numbers specify the number of the game or position in the file. 
383 Here a value -1 means automatic stepping through all games on the file,
384 -2 automatic stepping every two games. 
385 The Rewind-Index parameter causes a stepping index to reset to one after reaching
386 a specified value. 
387 A setting of -2 for the game number will also be effective in a tournament without
388 specifying a game file, but playing from the GUI book instead. 
389 In this case the first (odd) games will randomly select from the book,
390 but the second (even) games will select the same moves from the book as the previous game. 
391 (Note this leads to the same opening only if both engines use the GUI book!) 
392 Default: No game or position file will be used. The default index if such a file is used is 1. 
393 <dt>Disable own engine bools be default<dd><a name="index-Disable-own-engine-bools-be-default_002c-Menu-Item-158"></a>Setting this option reverses the default situation for use of the GUI opening book
394 in tournaments from what it normally is, namely not using it. 
395 So unless the engine is installed with an option to explicitly specify it should
396 not use the GUI book (i.e. <code>-firstHasOwnBookUCI true</code>),
397 it will be made to use the GUI book. 
398 <dt>Replace Engine<dt>Upgrade Engine<dd><a name="index-Replace-Engine_002c-Menu-Item-159"></a><a name="index-Upgrade-Engine_002c-Menu-Item-160"></a>With these two buttons you can alter the participants of an already running tournament. 
399 After opening the Match Options dialog on an XBoard that is playing for the tourney,
400 you will see all the tourney parameters in the dialog fields. 
401 You can then replace the name of one engine by that of another
402 by editing the &lsquo;<samp><span class="samp">participants</span></samp>&rsquo; field. 
403 (But preserve the order of the others!) 
404 Pressing the button after that will cause the substitution. 
405 With the &lsquo;<samp><span class="samp">Upgrade Engine</span></samp>&rsquo; button the substitution will only affect future games. 
406 With &lsquo;<samp><span class="samp">Replace Engine</span></samp>&rsquo; all games the substituted engine has already played will
407 be invalidated, and they will be replayed with the substitute engine. 
408 In this latter case the engine must not be playing when you do this,
409 but otherwise there is no need to pause the tournament play
410 for making a substitution. 
411 <dt>Clone Tourney<dd><a name="index-CloneTourney_002c-Menu-Item-161"></a>Pressing this button after you have specified an existing tournament file
412 will copy the contents of the latter to the dialog,
413 and then puts the originally proposed name for the tourney file back. 
414 You can then run a tourney with the same parameters
415 (possibly after changing the proposed name of the tourney file for the new tourney)
416 by pressing 'OK'.
417
418      <br><dt>Load Game Options<dd><a name="index-Load-Game-Options_002c-Menu-Item-162"></a>Summons a dialog where you can set the <code>autoDisplayComment</code> and
419 <code>autoDisplayTags</code> options, (which control popups when viewing loaded games),
420 and specify the rate at which loaded games are auto-played,
421 in seconds per move (which can be a fractional number, like 1.6). 
422 You can also set search criteria for determining which games
423 will be displayed in the Game List for a multi-game file,
424 and thus be eligible for loading:
425 <dt>Elo of strongest player<dt>Elo of weakest player<dt>year<dd><a name="index-Elo-of-strongest-player_002c-Menu-Item-163"></a><a name="index-Elo-of-weakest-player_002c-Menu-Item-164"></a><a name="index-year_002c-Menu-Item-165"></a>These numeric fields set thresholds (lower limits) on the Elo rating of the mentioned player,
426 or the date the game was played. 
427 Defaults: 0
428 <dt>Search mode<dd><a name="index-Search-mode_002c-Menu-Item-166"></a><a name="index-find-position_002c-Menu-Item-167"></a>This setting determines which positions in a game will be considered a match
429 to the position currently displayed in the board window
430 when you press the &lsquo;<samp><span class="samp">find position</span></samp>&rsquo; button in the Game List. 
431 You can search for an exact match,
432 a position that has all shown material in the same place,
433 but might contain additional material,
434 a position that has all Pawns in the same place,
435 but can have the shown material anywhere,
436 a position that can have all shown material anywhere,
437 or a position that has material between certain limits anywhere. 
438 For the latter you have to place the material that must be present
439 in the four lowest ranks of the board,
440 and optional additional material in the four highest ranks of the board. 
441 You can request the optional material to be balanced. 
442 <dt>number of consecutive positions<dd><a name="index-number-of-consecutive-positions_002c-Menu-Item-168"></a>When you are searching by material, rather than for an exact match,
443 this parameter indicates forhowmany consecutive game positions
444 the same amount of material must be on the board before it is
445 considered a match. 
446 <dt>Also match reversed colors<dt>Also match left-right flipped position<dd><a name="index-Also-match-reversed-colors_002c-Menu-Item-169"></a><a name="index-Also-match-left_002dright-flipped-position_002c-Menu-Item-170"></a>When looking for matching positions rather than by material,
447 these settings determine whether mirror images
448 (in case of a vertical flip in combination with color reversal)
449 will be also considered a match. 
450 The left-right flipping is only useful after all castling rights
451 have expired (or in Xiangqi).
452
453      <br><dt>Save Game Options<dd><a name="index-Save-Game-Options_002c-Menu-Item-171"></a>Summons a dialog where you can specify the files on which XBoard should
454 automtically save any played or entered games,
455 (the <code>saveGameFile</code> option),
456 or the final position of such games (the <code>savePositionfile</code> option). 
457 You can also select 'auto-save' without a file name,
458 in which case XBoard will prompt the user for a file name after each game. 
459 You can also set the default value for the PGN Event tag that will
460 be used for each new game you start. 
461 Various options for the format of the game can be specified as well,
462 such as whether scores and depths of engine games should be saved as comments,
463 and if a tag with info about the score with which the engine came out of book
464 should be included. 
465 For Chess, always set the format to PGN, rather than "old save stye"!
466
467      <br><dt>Game List<dd><a name="index-Game-List-Tags_002c-Menu-Item-172"></a>Pops up a dialog where you can select the PGN tags that should appear
468 on the lines in the game list, and their order.
469
470      <br><dt>Sound Options<dd><a name="index-Sound-Options_002c-Menu-Item-173"></a>Summons a dialog where you can specify the sounds that should accompany
471 various events that can occur XBoard. 
472 Most events are only relevant to ICS play,
473 but the move sound is an important exception. 
474 For each event listed in the dialog,
475 you can select a standard sound from a menu. 
476 You can also select a user-supplied sound file,
477 by typing its name into the designated text-edit field first,
478 and then selecting "Above WAV File" from the menu for the event. 
479 A dummy event has been provided for trying out the sounds with the
480 "play" button next to it. 
481 The directory with standard sounds, and the external program for playing
482 the sounds can be specified too, but normally you would not touch these
483 once XBoard is properly installed. 
484 When a move sound other than 'None' is selected,
485 XBoard alerts you by playing that sound
486 after each of your opponent's moves (or after every
487 move if you are observing a game on the Internet Chess Server). 
488 The sound is not played after moves you make or moves read from a
489 saved game file.
490
491      <br><dt>Save Settings Now<dd><a name="index-Save-Settings-Now_002c-Menu-Item-174"></a>Selecting this menu item causes the current XBoard settings to be
492 written to the settings file, so they will also apply in future sessions. 
493 Note that some settings are 'volatile', and are not saved,
494 because XBoard considers it too unlikely that you want those to apply
495 next time. 
496 In particular this applies to the Chess program names, and all options
497 giving information on those Chess programs (such as their directory,
498 if they have their own opening book, if they are UCI or native XBoard),
499 or the variant you are playing. 
500 Such options would still be understood when they appear in the settings
501 file in case they were put there with the aid of a text editor, but they
502 would disappear from the file as soon as you save the settings. 
503 <br><dt>Save Settings on Exit<dd><a name="index-Save-Settings-on-Exit_002c-Menu-Item-175"></a>Setting this option has no immediate effect, but causes the settings
504 to be saved when you quit XBoard. What happens then is otherwise
505 identical to what happens when you use select "Save Settings Now",
506 see there. 
507 </dl>
508
509    </body></html>
510