release of 4.5.0
[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">2.7 Options Menu</h3>
36
37 <p><a name="index-Menu_002c-Options-83"></a><a name="index-Options-Menu-84"></a>
38      <dl>
39 <dt>Time Control<dd><a name="index-Time-Control_002c-Menu-Item-85"></a>Pops up a sub-menu where you can set the time-control parameters interactively. 
40 Allows you to select classical or incremental time controls,
41 set the moves per session, session duration, and time increment. 
42 Also allows specification of time-odds factors for one or both engines. 
43 If an engine is given a time-odds factor N, all time quota it gets,
44 be it at the beginning of a session or through the time increment or
45 fixed time per move, will be divided by N. 
46 The shifted <kbd>Alt+T</kbd> key is a keyboard equivalent. 
47 <br><dt>Common Engine<dd><a name="index-Common-Engine_002c-Menu-Item-86"></a>Pops up a sub-menu where you can set some engine parameters common to most engines,
48 such as hash-table size, tablebase cache size, maximum number of processors
49 that SMP engines can use, and where to find the Polyglot adapter needed
50 to run UCI engines under XBoard. The feature that allows setting of these parameters on
51 engines is new since XBoard 4.3.15, so not many XBoard/WinBoard engines respond
52 to it yet, but UCI engines should. 
53 It is also possible to specify a GUI opening book here, i.e. an opening
54 book that XBoard consults for any position a playing engine gets in. 
55 It then forces the engine to play the book move, rather than to think up its own,
56 if that position is found in the book. 
57 The book can switched on and off independently for either engine. 
58 The shifted <kbd>Alt+U</kbd> key is a keyboard equivalent. 
59 <br><dt>Adjudications<dd><a name="index-Adjudications_002c-Menu-Item-87"></a>Pops up a sub-menu where you can enable or disable various adjudications
60 that XBoard can perform in engine-engine games. 
61 The shifted <kbd>Alt+J</kbd> key is a keyboard equivalent. 
62 You can instruct XBoard to detect and terminate the game on checkmate
63 or stalemate, even if the engines would not do so, to verify engine
64 result claims (forfeiting engines that make false claims), rather than
65 naively following the engine, to declare draw on positions
66 which can never be won for lack of mating material, (e.g. KBK),
67 or which are impossible to win unless the opponent seeks its own demise
68 (e.g. KBKN). 
69 For these adjudications to work, &lsquo;<samp><span class="samp">Test Legality</span></samp>&rsquo; should be switched on. 
70 It is also possible to instruct XBoard to enforce a 50-move or 3-fold-repeat
71 rule and automatically declare draw (after a user-adjustable number of moves
72 or repeats) even if the engines are prepared to go on. 
73 It is also possible to have XBoard declare draw on games that seem to drag on
74 forever, or adjudicate a loss if both engines agree (for 3 consecutive moves) that one
75 of them is behind more than a user-adjustable score threshold. 
76 For the latter adjudication to work, XBoard should be able to properly understand
77 the engine's scores. To facilitate the latter, you can inform xboard here if
78 the engines report scores from the viewpoint of white, or from that of their own color. 
79 <br><dt>Game List<dd><a name="index-Game-List-Tags_002c-Menu-Item-88"></a>Pops up a dialog where you can select the PGN tags that should appear
80 on the lines in the game list, and their order. 
81 <br><dt>Always Queen<dd><a name="index-Always-Queen_002c-Menu-Item-89"></a>If this option is off, XBoard brings up a dialog
82 box whenever you move a pawn to the last rank, asking what piece
83 you want to promote it to. If the option is true, your pawns are
84 always promoted to queens. Your opponent can still under-promote. 
85 The shifted <kbd>Ctrl-Q</kbd> key is a keyboard equivalent. 
86 <br><dt>Animate Dragging<dd><a name="index-Animate-Dragging_002c-Menu-Item-90"></a>If Animate Dragging is on, while you are dragging a piece with the
87 mouse, an image of the piece follows the mouse cursor. 
88 If Animate Dragging is off, there is no visual feedback while you are
89 dragging a piece, but if Animate Moving is on, the move will be
90 animated when it is complete. 
91 <br><dt>Animate Moving<dd><a name="index-Animate-Moving_002c-Menu-Item-91"></a>If Animate Moving is on, all piece moves are animated.  An image of the
92 piece is shown moving from the old square to the new square when the
93 move is completed (unless the move was already animated by Animate Dragging). 
94 If Animate Moving is off, a moved piece instantly disappears from its
95 old square and reappears on its new square when the move is complete. 
96 The shifted <kbd>Ctrl-A</kbd> key is a keyboard equivalent. 
97 <br><dt>Auto Comment<dd><a name="index-Auto-Comment_002c-Menu-Item-92"></a>If this option is on, any remarks made on ICS while you are observing or
98 playing a game are recorded as a comment on the current move.  This includes
99 remarks made with the ICS commands <kbd>say</kbd>, <kbd>tell</kbd>, <kbd>whisper</kbd>,
100 and <kbd>kibitz</kbd>. 
101 Limitation: remarks that you type yourself are not recognized;
102 XBoard scans only the output from ICS, not the input you type to it. 
103 <br><dt>Auto Flag<dd><a name="index-Auto-Flag_002c-Menu-Item-93"></a>If this option is on and one player runs out of time
104 before the other,
105 XBoard
106 will automatically call his flag, claiming a win on time. 
107 The shifted <kbd>Ctrl-F</kbd> key is a keyboard equivalent. 
108 In ICS mode, Auto Flag will only call your opponent's flag, not yours,
109 and the ICS may award you a draw instead of a win if you have
110 insufficient mating material.  In local chess engine mode,
111 XBoard
112 may call either player's flag and will not take material into account (?). 
113 <br><dt>Auto Flip View<dd><a name="index-Auto-Flip-View_002c-Menu-Item-94"></a>If the Auto Flip View option is on when you start a game, the board
114 will be automatically oriented so that your pawns move from the bottom
115 of the window towards the top. 
116 <br><dt>Auto Observe<dd><a name="index-Auto-Observe_002c-Menu-Item-95"></a>If this option is on and you add a player to your <code>gnotify</code>
117 list on ICS, XBoard will automatically observe all of that
118 player's games, unless you are doing something else (such as
119 observing or playing a game of your own) when one starts. 
120 The games are displayed
121 from the point of view of the player on your gnotify list; that is, his
122 pawns move from the bottom of the window towards the top. 
123 Exceptions:  If both players in a game are on your gnotify list, if
124 your ICS
125 <code>highlight</code>
126 variable is set to 0, or if the ICS you are using does not
127 properly support observing from Black's point of view,
128 you will see the game from White's point of view. 
129 <br><dt>Auto Raise Board<dd><a name="index-Auto-Raise-Board_002c-Menu-Item-96"></a>If this option is on, whenever a new game begins, the chessboard window
130 is deiconized (if necessary) and raised to the top of the stack of windows. 
131 <br><dt>Auto Save<dd><a name="index-Auto-Save_002c-Menu-Item-97"></a>If this option is true, at the end of every game XBoard prompts
132 you for a file name and appends a record of the game to the file
133 you specify. 
134 Disabled if the <code>saveGameFile</code> command-line
135 option is set, as in that case all games are saved to the specified file. 
136 See <a href="Load-and-Save-options.html#Load-and-Save-options">Load and Save options</a>. 
137 <br><dt>Blindfold<dd><a name="index-Blindfold_002c-Menu-Item-98"></a>If this option is on, XBoard displays the board as usual but does
138 not display pieces or move highlights.  You can still move in the
139 usual way (with the mouse or by typing moves in ICS mode), even though
140 the pieces are invisible. 
141 <br><dt>Flash Moves<dd><a name="index-Flash-Moves_002c-Menu-Item-99"></a>If this option is on, whenever a move is completed, the moved piece flashes. 
142 The number of times to flash is set by the flashCount command-line
143 option; it defaults to 3 if Flash Moves is first turned on from the menu.
144
145      <p>If you are playing a game on an ICS, the board is always
146 oriented at the start of the game so that your pawns move from
147 the bottom of the window towards the top. Otherwise, the starting
148 orientation is determined by the <code>flipView</code> command line option;
149 if it is false (the default), White's pawns move from bottom to top
150 at the start of each game; if it is true, Black's pawns move from
151 bottom to top. See <a href="User-interface-options.html#User-interface-options">User interface options</a>. 
152 <br><dt>Get Move List<dd><a name="index-Get-Move-List_002c-Menu-Item-100"></a>If this option is on, whenever XBoard
153 receives the first board of a new ICS game (or a different game from
154 the one it is currently displaying), it
155 retrieves the list of past moves from the ICS. 
156 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;
157 commands
158 or save them with &lsquo;<samp><span class="samp">Save Game</span></samp>&rsquo;.  You might want to
159 turn off this option if you are observing several blitz games at once,
160 to keep from wasting time and network bandwidth fetching the move lists over
161 and over. 
162 When you turn this option on from the menu, XBoard
163 immediately fetches the move list of the current game (if any). 
164 <br><dt>Highlight Dragging<dd><a name="index-Highlight-Dragging_002c-Menu-Item-101"></a>If Highlight Dragging is on, and the option -showTargetSquares is also on
165 in the settings file, all squares a piece that is 'picked up' with the mouse
166 can legally move to are highighted with a fat colored dot in the
167 highlightColor (non-captures) or premoveHighlightColor (captures). 
168 Legality testing must be on for XBoard to know how the piece moves. 
169 <br><dt>Highlight Last Move<dd><a name="index-Highlight-Last-Move_002c-Menu-Item-102"></a>If Highlight Last Move is on, after a move is made, the starting and
170 ending squares remain highlighted. In addition, after you use Backward
171 or Back to Start, the starting and ending squares of the last move to
172 be unmade are highlighted. 
173 <br><dt>Highlight with Arrow<dd><a name="index-Highlight-with-Arrow_002c-Menu-Item-103"></a>Causes the highlighting described in Highlight Last Move to be done
174 by drawing an arrow between the highlighted squares,
175 so that it is visible even when the width of the grid lines is set to zero. 
176 <br><dt>Move Sound<dd><a name="index-Move-Sound_002c-Menu-Item-104"></a>If this option is on, XBoard alerts you by playing a sound
177 after each of your opponent's moves (or after every
178 move if you are observing a game on the Internet Chess Server). 
179 The sound is not played after moves you make or moves read from a
180 saved game file. By default, the
181 sound is the terminal bell, but on some systems you can change it
182 to a sound file using the soundMove option; see below.
183
184      <p>If you turn on this option when using XBoard with the Internet
185 Chess Server, you will probably want to give the
186 <kbd>set bell 0</kbd>
187 command to the ICS, since otherwise the ICS will ring the terminal bell
188 after every move (not just yours). (The <samp><span class="file">.icsrc</span></samp> file
189 is a good place for this; see <a href="ICS-options.html#ICS-options">ICS options</a>.) 
190 <br><dt>ICS Alarm<dd><a name="index-ICS-Alarm_002c-Menu-Item-105"></a>When this option is on, an alarm sound is played when your clock
191 counts down to the icsAlarmTime (by default, 5 seconds) in an ICS
192 game.  For games with time controls that include an increment, the
193 alarm will sound each time the clock counts down to the icsAlarmTime. 
194 By default, the alarm sound is the terminal bell, but on some systems
195 you can change it to a sound file using the soundIcsAlarm option; see
196 below. 
197 <br><dt>One-Click Moving<dd><a name="index-One_002dClick-Moving_002c-Menu-Item-106"></a>If this option is on, XBoard does not wait for you to click both the
198 from- and the to-square, or drag the piece, but performs a move as soon
199 as it is uniqely specified. 
200 This applies to clicking an own piece that only has a single legal move,
201 clicking an empty square or opponent piece where only one of your pieces
202 can move (or capture) to. 
203 Furthermore, a double-click on a piece that can only make a single capture
204 will cause that capture to be made. 
205 Promoting a Pawn by clicking its to-square will suppress the promotion
206 popup, and make it promote to Queen. 
207 <br><dt>Periodic Updates<dd><a name="index-Periodic-Updates_002c-Menu-Item-107"></a>If this option is off (or if
208 you are using a chess engine that does not support periodic updates),
209 the analysis window
210 will only be updated when the analysis changes. If this option is
211 on, the Analysis Window will be updated every two seconds. 
212 <br><dt>Ponder Next Move<dd><a name="index-Ponder-Next-Move_002c-Menu-Item-108"></a>If this option is off, the chess engine will think only when it is on
213 move.  If the option is on, the engine will also think while waiting
214 for you to make your move. 
215 The shifted <kbd>Ctrl-P</kbd> key is a keyboard equivalent. 
216 <br><dt>Popup Exit Message<dd><a name="index-Popup-Exit-Message_002c-Menu-Item-109"></a>If this option is on, when XBoard wants to display a message just
217 before exiting, it brings up a modal dialog box and waits for you to
218 click OK before exiting.  If the option is off, XBoard prints the
219 message to standard error (the terminal) and exits immediately. 
220 <br><dt>Popup Move Errors<dd><a name="index-Popup-Move-Errors_002c-Menu-Item-110"></a>If this option is off, when you make an error in moving (such as
221 attempting an illegal move or moving the wrong color piece), the
222 error message is displayed in the message area.  If the option is
223 on, move errors are displayed in small pop-up windows like other errors. 
224 You can dismiss an error pop-up either by clicking its OK button or by
225 clicking anywhere on the board, including down-clicking to start a move. 
226 <br><dt>Premove<dd><a name="index-Premove_002c-Menu-Item-111"></a>If this option is on while playing a game on an ICS, you can register
227 your next planned move before it is your turn.  Move the piece with
228 the mouse in the ordinary way, and the starting and ending squares
229 will be highlighted with a special color (red by default).  When it is
230 your turn, if your registered move is legal, XBoard will send it to
231 ICS immediately; if not, it will be ignored and you can make a
232 different move.  If you change your mind about your premove, either
233 make a different move, or double-click on any piece to cancel the move
234 entirely. 
235 <br><dt>Quiet Play<dd><a name="index-Quiet-Play_002c-Menu-Item-112"></a>If this option is on, XBoard will automatically issue an ICS
236 <kbd>set shout 0</kbd>
237 command whenever you start a game and a
238 <kbd>set shout 1</kbd>
239 command whenever you finish one.  Thus, you will not be distracted
240 by shouts from other ICS users while playing. 
241 <br><dt>Show Coords<dd><a name="index-Show-Coords_002c-Menu-Item-113"></a>If this option is on, XBoard displays algebraic coordinates
242 along the board's left and bottom edges. 
243 <br><dt>Hide Thinking<dd><a name="index-Hide-Thinking_002c-Menu-Item-114"></a>If this option is off, the chess engine's notion of the score and best
244 line of play from the current position is displayed as it is
245 thinking. The score indicates how many pawns ahead (or if negative,
246 behind) the chess engine thinks it is. In matches between two
247 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
248 whether it is showing White's thinking or Black's, and only the thinking
249 of the engine that is on move is shown. 
250 The shifted <kbd>Ctrl-H</kbd> key is a keyboard equivalent. 
251 <br><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
252 with the mouse are legal and refuses to let you make an illegal move. 
253 The shifted <kbd>Ctrl-L</kbd> key is a keyboard equivalent. 
254 Moves loaded from a file with &lsquo;<samp><span class="samp">Load Game</span></samp>&rsquo; are also checked.  If
255 the option is off, all moves are accepted, but if a local chess engine
256 or the ICS is active, they will still reject illegal moves.  Turning
257 off this option is useful if you are playing a chess variant with
258 rules that XBoard does not understand.  (Bughouse, suicide, and wild
259 variants where the king may castle after starting on the d file are
260 generally supported with Test Legality on.) 
261 <br><dt>Save Settings Now<dd><a name="index-Save-Settings-Now_002c-Menu-Item-116"></a>Selecting this menu item causes the current XBoard settings to be
262 written to the settings file, so they will also apply in future sessions. 
263 Note that some settings are 'volatile', and are not saved,
264 because XBoard considers it too unlikely that you want those to apply
265 next time. 
266 In particular this applies to the Chess program names, and all options
267 giving information on those Chess programs (such as their directory,
268 if they have their own opening book, if they are UCI or native XBoard),
269 or the variant you are playing. 
270 Such options would still be understood when they appear in the settings
271 file in case they were put there with the aid of a text editor, but they
272 would disappear from the file as soon as you save the settings. 
273 <br><dt>Save Settings on Exit<dd><a name="index-Save-Settings-on-Exit_002c-Menu-Item-117"></a>Setting this option has no immediate effect, but causes the settings
274 to be saved when you quit XBoard. What happens then is otherwise
275 identical to what happens when you use select "Save Settings Now",
276 see there. 
277 </dl>
278
279    </body></html>
280