updated manual to 4.7.0
[xboard.git] / manual / html_node / Mode-Menu.html
1 <html lang="en">
2 <head>
3 <title>Mode 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="View-Menu.html#View-Menu" title="View Menu">
10 <link rel="next" href="Action-Menu.html#Action-Menu" title="Action 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="Mode-Menu"></a>
28 <p>
29 Next:&nbsp;<a rel="next" accesskey="n" href="Action-Menu.html#Action-Menu">Action Menu</a>,
30 Previous:&nbsp;<a rel="previous" accesskey="p" href="View-Menu.html#View-Menu">View 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.4 Mode Menu</h3>
36
37 <p><a name="index-Menu_002c-Mode-56"></a><a name="index-Mode-Menu-57"></a>
38      <dl>
39 <dt>Machine White<dd><a name="index-Machine-White_002c-Menu-Item-58"></a>Tells the chess engine to play White. 
40 The <kbd>Ctrl-W</kbd> key is a keyboard equivalent. 
41 <br><dt>Machine Black<dd><a name="index-Machine-Black_002c-Menu-Item-59"></a>Tells the chess engine to play Black. 
42 The <kbd>Ctrl-B</kbd> key is a keyboard equivalent. 
43 <br><dt>Two Machines<dd><a name="index-Two-Machines_002c-Menu-Item-60"></a>Plays a game between two chess engines. 
44 The <kbd>Ctrl-T</kbd> key is a keyboard equivalent. 
45 <br><dt>Analysis Mode<dd><a name="index-Analysis-Mode_002c-Menu-Item-61"></a><a name="index-null-move-62"></a>XBoard tells the chess engine to start analyzing the current game/position
46 and shows you the analysis as you move pieces around. 
47 The <kbd>Ctrl-A</kbd> key is a keyboard equivalent. 
48 Note: Some chess engines do not support Analysis mode.
49
50      <p>To set up a position to analyze, you do the following:
51
52      <p>1. Select Edit Position from the Mode Menu
53
54      <p>2. Set up the position.  Use the middle and right buttons to
55 bring up the white and black piece menus.
56
57      <p>3. When you are finished, click on either the Black or White
58 clock to tell XBoard which side moves first.
59
60      <p>4. Select Analysis Mode from the Mode Menu to start the analysis.
61
62      <p>You can now play legal moves to create follow-up positions for the
63 engine to analyze, while the moves will be remembered as a stored game,
64 and then step backward through this game to take the moves back. 
65 Note that you can also click on the clocks to set the opposite
66 side to move (adding a so-called &lsquo;<samp><span class="samp">null move</span></samp>&rsquo; to the game).
67
68      <p>You can also tell the engine to exclude some moves from analysis. 
69 (Engines that do not support the exclude-moves feature will
70 ignore this, however.) 
71 The general way to do this is to play the move you want to exclude
72 starting with a double click on the piece. 
73 When you use drag-drop moving, the piece you grab with a double click
74 will also remain on its square, to show you that you are not really
75 making the move, but just forbid it from the current position. 
76 Playing a thus excluded move a second time will include it again. 
77 Excluded moves will be listed as text in a header line in the
78 Engine Output window, and you can also re-include them by
79 right-clicking them there. 
80 This header line will also contain the words 'best' and 'tail';
81 right-clicking those will exclude the currently best move,
82 or all moves not explicitly listed in the header line. 
83 Once you leave the current position all memory of excluded
84 moves will be lost when you return there.
85
86      <p>Selecting this menu item while already in &lsquo;<samp><span class="samp">Analysis Mode</span></samp>&rsquo; will
87 toggle the participation of the second engine in the analysis. 
88 The output of this engine will then be shown in the lower pane
89 of the Engine Output window. 
90 The analysis function can also be used when observing games on an ICS
91 with an engine loaded (zippy mode); the engine then will analyse
92 the positions as they occur in the observed game.
93
94      <br><dt>Analyze Game<dd><a name="index-Analyze-Game_002c-Menu-Item-63"></a>This option subjects the currently loaded game to automatic
95 analysis by the loaded engine. 
96 The <kbd>Ctrl-G</kbd> key is a keyboard equivalent. 
97 XBoard will start auto-playing the game from the currently displayed position,
98 while the engine is analyzing the current position. 
99 The game will be annotated with the results of these analyses. 
100 In particlar, the score and depth will be added as a comment,
101 and the PV will be added as a variation.
102
103      <p>Normally the analysis would stop after reaching the end of the game. 
104 But when a game is loaded from a multi-game file
105 while &lsquo;<samp><span class="samp">Analyze Game</span></samp>&rsquo; was already switched on,
106 the analysis will continue with the next game in the file
107 until the end of the file is reached (or you switch to another mode).
108
109      <p>The time the engine spends on analyzing each move can be controlled
110 through the command-line option &lsquo;<samp><span class="samp">-timeDelay</span></samp>&rsquo;,
111 which can also be set from the &lsquo;<samp><span class="samp">Load Game Options</span></samp>&rsquo; menu dialog. 
112 Note: Some chess engines do not support Analysis mode. 
113 <br><dt>Edit Game<dd>Duplicate of the item in the Edit menu. 
114 Note that &lsquo;<samp><span class="samp">Edit Game</span></samp>&rsquo; is the idle mode of XBoard, and can be used
115 to get you out of other modes. E.g. to stop analyzing, stop a game
116 between two engines or stop editing a position. 
117 <br><dt>Edit Position<dd>Duplicate of the item in the Edit menu. 
118 <br><dt>Training<dd><a name="index-Training_002c-Menu-Item-64"></a>Training mode lets you interactively guess the moves of a game for one
119 of the players. You guess the next move of the game by playing the
120 move on the board. If the move played matches the next move of the
121 game, the move is accepted and the opponent's response is auto-played. 
122 If the move played is incorrect, an error message is displayed.  You
123 can select this mode only while loading a game (that is, after
124 selecting &lsquo;<samp><span class="samp">Load Game</span></samp>&rsquo; from the File menu).  While XBoard is in
125 &lsquo;<samp><span class="samp">Training</span></samp>&rsquo; mode, the navigation buttons are disabled. 
126 <br><dt>ICS Client<dd><a name="index-ICS-Client_002c-Menu-Item-65"></a>This is the normal mode when XBoard
127 is connected to a chess server.  If you have moved into
128 Edit Game or Edit Position mode, you can select this option to get out.
129
130      <p>To use xboard in ICS mode, run it in the foreground with the -ics
131 option, and use the terminal you started it from to type commands and
132 receive text responses from the chess server.  See
133 <a href="Chess-Servers.html#Chess-Servers">Chess Servers</a> below for more information.
134
135      <p>XBoard activates some special position/game editing features when you
136 use the <kbd>examine</kbd> or <kbd>bsetup</kbd> commands on ICS and you have
137 &lsquo;<samp><span class="samp">ICS Client</span></samp>&rsquo; selected on the Mode menu.  First, you can issue the
138 ICS position-editing commands with the mouse.  Move pieces by dragging
139 with mouse button 1.  To drop a new piece on a square, press mouse
140 button 2 or 3 over the square.  This brings up a menu of white pieces
141 (button 2) or black pieces (button 3).  Additional menu choices let
142 you empty the square or clear the board.  Click on the White or Black
143 clock to set the side to play.  You cannot set the side to play or
144 drag pieces to arbitrary squares while examining on ICC, but you can
145 do so in <kbd>bsetup</kbd> mode on FICS.  In addition, the menu commands
146 &lsquo;<samp><span class="samp">Forward</span></samp>&rsquo;, &lsquo;<samp><span class="samp">Backward</span></samp>&rsquo;, &lsquo;<samp><span class="samp">Pause</span></samp>&rsquo;, and &lsquo;<samp><span class="samp">Stop Examining</span></samp>&rsquo;
147 have special functions in this mode; see below. 
148 <br><dt>Machine Match<dd><a name="index-Machine-match_002c-Menu-Item-66"></a>Starts a match between two chess programs,
149 with a number of games and other parameters set through
150 the &lsquo;<samp><span class="samp">Match Options</span></samp>&rsquo; menu dialog. 
151 When a match is already running, selecting this item will make
152 XBoard drop out of match mode after the current game finishes. 
153 <br><dt>Pause<dd><a name="index-Pause_002c-Menu-Item-67"></a>Pauses updates to the board, and if you are playing against a chess engine,
154 also pauses your clock. To continue, select &lsquo;<samp><span class="samp">Pause</span></samp>&rsquo; again, and the
155 display will automatically update to the latest position. 
156 The &lsquo;<samp><span class="samp">P</span></samp>&rsquo; button and keyboard <kbd>Pause</kbd> key are equivalents.
157
158      <p>If you select Pause when you are playing against a chess engine and
159 it is not your move, the chess engine's clock
160 will continue to run and it will eventually make a move, at which point
161 both clocks will stop. Since board updates are paused, however,
162 you will not see the move until you exit from Pause mode (or select Forward). 
163 This behavior is meant to simulate adjournment with a sealed move.
164
165      <p>If you select Pause while you are observing or examining a game on a
166 chess server, you can step backward and forward in the current history
167 of the examined game without affecting the other observers and
168 examiners, and without having your display jump forward to the latest
169 position each time a move is made. Select Pause again to reconnect
170 yourself to the current state of the game on ICS.
171
172      <p>If you select &lsquo;<samp><span class="samp">Pause</span></samp>&rsquo; while you are loading a game, the game stops
173 loading. You can load more moves manually by selecting &lsquo;<samp><span class="samp">Forward</span></samp>&rsquo;, or
174 resume automatic loading by selecting &lsquo;<samp><span class="samp">Pause</span></samp>&rsquo; again. 
175 </dl>
176
177    </body></html>
178