updated manual to 4.7.0
[xboard.git] / manual / html_node / Mode-Menu.html
index c57450f..00556a7 100644 (file)
@@ -3,10 +3,10 @@
 <title>Mode Menu - XBoard</title>
 <meta http-equiv="Content-Type" content="text/html">
 <meta name="description" content="XBoard">
-<meta name="generator" content="makeinfo 4.12">
+<meta name="generator" content="makeinfo 4.13">
 <link title="Top" rel="start" href="index.html#Top">
 <link rel="up" href="Menus.html#Menus" title="Menus">
-<link rel="prev" href="File-Menu.html#File-Menu" title="File Menu">
+<link rel="prev" href="View-Menu.html#View-Menu" title="View Menu">
 <link rel="next" href="Action-Menu.html#Action-Menu" title="Action Menu">
 <link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
 <meta http-equiv="Content-Style-Type" content="text/css">
 </head>
 <body>
 <div class="node">
-<p>
 <a name="Mode-Menu"></a>
+<p>
 Next:&nbsp;<a rel="next" accesskey="n" href="Action-Menu.html#Action-Menu">Action Menu</a>,
-Previous:&nbsp;<a rel="previous" accesskey="p" href="File-Menu.html#File-Menu">File Menu</a>,
+Previous:&nbsp;<a rel="previous" accesskey="p" href="View-Menu.html#View-Menu">View Menu</a>,
 Up:&nbsp;<a rel="up" accesskey="u" href="Menus.html#Menus">Menus</a>
 <hr>
 </div>
 
-<h3 class="section">2.2 Mode Menu</h3>
+<h3 class="section">3.4 Mode Menu</h3>
 
-<p><a name="index-Menu_002c-Mode-26"></a><a name="index-Mode-Menu-27"></a>
+<p><a name="index-Menu_002c-Mode-56"></a><a name="index-Mode-Menu-57"></a>
      <dl>
-<dt>Machine White<dd><a name="index-Machine-White_002c-Menu-Item-28"></a>Tells the chess engine to play White. 
-<br><dt>Machine Black<dd><a name="index-Machine-Black_002c-Menu-Item-29"></a>Tells the chess engine to play Black. 
-<br><dt>Two Machines<dd><a name="index-Two-Machines_002c-Menu-Item-30"></a>Plays a game between two chess engines. 
-<br><dt>Analysis Mode<dd><a name="index-Analysis-Mode_002c-Menu-Item-31"></a>XBoard tells the chess engine to start analyzing the current game/position
+<dt>Machine White<dd><a name="index-Machine-White_002c-Menu-Item-58"></a>Tells the chess engine to play White. 
+The <kbd>Ctrl-W</kbd> key is a keyboard equivalent. 
+<br><dt>Machine Black<dd><a name="index-Machine-Black_002c-Menu-Item-59"></a>Tells the chess engine to play Black. 
+The <kbd>Ctrl-B</kbd> key is a keyboard equivalent. 
+<br><dt>Two Machines<dd><a name="index-Two-Machines_002c-Menu-Item-60"></a>Plays a game between two chess engines. 
+The <kbd>Ctrl-T</kbd> key is a keyboard equivalent. 
+<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
 and shows you the analysis as you move pieces around. 
+The <kbd>Ctrl-A</kbd> key is a keyboard equivalent. 
 Note: Some chess engines do not support Analysis mode.
 
      <p>To set up a position to analyze, you do the following:
@@ -55,18 +59,71 @@ clock to tell XBoard which side moves first.
 
      <p>4. Select Analysis Mode from the Mode Menu to start the analysis.
 
-     <p>The analysis function can also be used when observing games on an ICS
+     <p>You can now play legal moves to create follow-up positions for the
+engine to analyze, while the moves will be remembered as a stored game,
+and then step backward through this game to take the moves back. 
+Note that you can also click on the clocks to set the opposite
+side to move (adding a so-called &lsquo;<samp><span class="samp">null move</span></samp>&rsquo; to the game).
+
+     <p>You can also tell the engine to exclude some moves from analysis. 
+(Engines that do not support the exclude-moves feature will
+ignore this, however.) 
+The general way to do this is to play the move you want to exclude
+starting with a double click on the piece. 
+When you use drag-drop moving, the piece you grab with a double click
+will also remain on its square, to show you that you are not really
+making the move, but just forbid it from the current position. 
+Playing a thus excluded move a second time will include it again. 
+Excluded moves will be listed as text in a header line in the
+Engine Output window, and you can also re-include them by
+right-clicking them there. 
+This header line will also contain the words 'best' and 'tail';
+right-clicking those will exclude the currently best move,
+or all moves not explicitly listed in the header line. 
+Once you leave the current position all memory of excluded
+moves will be lost when you return there.
+
+     <p>Selecting this menu item while already in &lsquo;<samp><span class="samp">Analysis Mode</span></samp>&rsquo; will
+toggle the participation of the second engine in the analysis. 
+The output of this engine will then be shown in the lower pane
+of the Engine Output window. 
+The analysis function can also be used when observing games on an ICS
 with an engine loaded (zippy mode); the engine then will analyse
-the positions as they occur in the observed game. 
-<br><dt>Analyze File<dd><a name="index-Analyze-File_002c-Menu-Item-32"></a>This option lets you load a game from a file (PGN, XBoard format, etc.) 
-and analyze it. When you select this menu item, a popup window appears
-and asks for a filename to load. 
-If the file contains multiple games, another popup appears that lets
-you select which game you wish to analyze. 
-After a game is loaded, use the XBoard arrow buttons to step
-forwards/backwards through the game and watch the analysis. 
+the positions as they occur in the observed game.
+
+     <br><dt>Analyze Game<dd><a name="index-Analyze-Game_002c-Menu-Item-63"></a>This option subjects the currently loaded game to automatic
+analysis by the loaded engine. 
+The <kbd>Ctrl-G</kbd> key is a keyboard equivalent. 
+XBoard will start auto-playing the game from the currently displayed position,
+while the engine is analyzing the current position. 
+The game will be annotated with the results of these analyses. 
+In particlar, the score and depth will be added as a comment,
+and the PV will be added as a variation.
+
+     <p>Normally the analysis would stop after reaching the end of the game. 
+But when a game is loaded from a multi-game file
+while &lsquo;<samp><span class="samp">Analyze Game</span></samp>&rsquo; was already switched on,
+the analysis will continue with the next game in the file
+until the end of the file is reached (or you switch to another mode).
+
+     <p>The time the engine spends on analyzing each move can be controlled
+through the command-line option &lsquo;<samp><span class="samp">-timeDelay</span></samp>&rsquo;,
+which can also be set from the &lsquo;<samp><span class="samp">Load Game Options</span></samp>&rsquo; menu dialog. 
 Note: Some chess engines do not support Analysis mode. 
-<br><dt>ICS Client<dd><a name="index-ICS-Client_002c-Menu-Item-33"></a>This is the normal mode when XBoard
+<br><dt>Edit Game<dd>Duplicate of the item in the Edit menu. 
+Note that &lsquo;<samp><span class="samp">Edit Game</span></samp>&rsquo; is the idle mode of XBoard, and can be used
+to get you out of other modes. E.g. to stop analyzing, stop a game
+between two engines or stop editing a position. 
+<br><dt>Edit Position<dd>Duplicate of the item in the Edit menu. 
+<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
+of the players. You guess the next move of the game by playing the
+move on the board. If the move played matches the next move of the
+game, the move is accepted and the opponent's response is auto-played. 
+If the move played is incorrect, an error message is displayed.  You
+can select this mode only while loading a game (that is, after
+selecting &lsquo;<samp><span class="samp">Load Game</span></samp>&rsquo; from the File menu).  While XBoard is in
+&lsquo;<samp><span class="samp">Training</span></samp>&rsquo; mode, the navigation buttons are disabled. 
+<br><dt>ICS Client<dd><a name="index-ICS-Client_002c-Menu-Item-65"></a>This is the normal mode when XBoard
 is connected to a chess server.  If you have moved into
 Edit Game or Edit Position mode, you can select this option to get out.
 
@@ -88,89 +145,15 @@ drag pieces to arbitrary squares while examining on ICC, but you can
 do so in <kbd>bsetup</kbd> mode on FICS.  In addition, the menu commands
 &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;
 have special functions in this mode; see below. 
-<br><dt>Edit Game<dd><a name="index-Edit-Game_002c-Menu-Item-34"></a>Allows you to make moves for both Black and White, and to change
-moves after backing up with the &lsquo;<samp><span class="samp">Backward</span></samp>&rsquo; command. The clocks do
-not run.
-
-     <p>In chess engine mode, the chess engine continues to check moves for legality
-but does not participate in the game. You can bring the chess engine
-into the game by selecting &lsquo;<samp><span class="samp">Machine White</span></samp>&rsquo;, &lsquo;<samp><span class="samp">Machine Black</span></samp>&rsquo;,
-or &lsquo;<samp><span class="samp">Two Machines</span></samp>&rsquo;.
-
-     <p>In ICS mode, the moves are not sent to the ICS: &lsquo;<samp><span class="samp">Edit Game</span></samp>&rsquo; takes
-XBoard out of ICS Client mode and lets you edit games locally. 
-If you want to edit games on ICS in a way that other ICS users
-can see, use the ICS <kbd>examine</kbd> command or start an ICS match
-against yourself. 
-<br><dt>Edit Position<dd><a name="index-Edit-Position_002c-Menu-Item-35"></a>Lets you set up an arbitrary board position. 
-Use mouse button 1 to drag pieces to new squares, or to delete a piece
-by dragging it off the board or dragging an empty square on top of it. 
-To drop a new piece on a square, press mouse button 2 or 3 over the
-square. This brings up a menu of white pieces (button 2) or
-black pieces (button 3). Additional menu choices let you empty the
-square or clear the board. You can set the side to play next by
-clicking on the word White or Black at the top of the screen. 
-Selecting &lsquo;<samp><span class="samp">Edit Position</span></samp>&rsquo; causes XBoard to discard
-all remembered moves in the current game.
-
-     <p>In ICS mode, changes made to the position by &lsquo;<samp><span class="samp">Edit Position</span></samp>&rsquo; are
-not sent to the ICS: &lsquo;<samp><span class="samp">Edit Position</span></samp>&rsquo; takes XBoard out of
-&lsquo;<samp><span class="samp">ICS Client</span></samp>&rsquo; mode and lets you edit positions locally. If you want to
-edit positions on ICS in a way that other ICS users can see, use
-the ICS <kbd>examine</kbd> command, or start an ICS match against yourself. 
-(See also the ICS Client topic above.) 
-<br><dt>Training<dd><a name="index-Training_002c-Menu-Item-36"></a>Training mode lets you interactively guess the moves of a game for one
-of the players. You guess the next move of the game by playing the
-move on the board. If the move played matches the next move of the
-game, the move is accepted and the opponent's response is autoplayed. 
-If the move played is incorrect, an error message is displayed.  You
-can select this mode only while loading a game (that is, after
-selecting &lsquo;<samp><span class="samp">Load Game</span></samp>&rsquo; from the File menu).  While XBoard is in
-&lsquo;<samp><span class="samp">Training</span></samp>&rsquo; mode, the navigation buttons are disabled. 
-<br><dt>Show Game List<dd><a name="index-Show-Game-List_002c-Menu-Item-37"></a>Shows or hides the list of games generated by the last &lsquo;<samp><span class="samp">Load Game</span></samp>&rsquo;
-command. 
-<br><dt>Show Move History<dd><a name="index-Show-Move-History_002c-Menu-Item-38"></a>Shows or hides a list of moves of the current game. 
-This list allows you to move the display to any earlier position in the game
-by clicking on the corresponding move. 
-<br><dt>Show Engine Output<dd><a name="index-Show-Engine-Output_002c-Menu-Item-39"></a>Shows or hides a window in which the thinking output of any loaded engines
-is displayed. 
-<br><dt>Edit Tags<dd><a name="index-Edit-Tags_002c-Menu-Item-40"></a>Lets you edit the PGN (portable game notation)
-tags for the current game. After editing, the tags must still conform to
-the PGN tag syntax:
-
-     <pre class="example">          &lt;tag-section&gt; ::= &lt;tag-pair&gt; &lt;tag-section&gt;
-                                  &lt;empty&gt;
-          &lt;tag-pair&gt; ::= [ &lt;tag-name&gt; &lt;tag-value&gt; ]
-          &lt;tag-name&gt; ::= &lt;identifier&gt;
-          &lt;tag-value&gt; ::= &lt;string&gt;
-</pre>
-     <p class="noindent">See the PGN Standard for full details. Here is an example:
-
-     <pre class="example">          [Event "Portoroz Interzonal"]
-          [Site "Portoroz, Yugoslavia"]
-          [Date "1958.08.16"]
-          [Round "8"]
-          [White "Robert J. Fischer"]
-          [Black "Bent Larsen"]
-          [Result "1-0"]
-</pre>
-     <p class="noindent">Any characters that do not match this syntax are silently ignored. Note that
-the PGN standard requires all games to have at least the seven tags shown
-above. Any that you omit will be filled in by XBoard
-with &lsquo;<samp><span class="samp">?</span></samp>&rsquo; (unknown value), or &lsquo;<samp><span class="samp">-</span></samp>&rsquo; (inapplicable value). 
-<br><dt>Edit Comment<dd><a name="index-Edit-Comment_002c-Menu-Item-41"></a>Adds or modifies a comment on the current position. Comments are
-saved by &lsquo;<samp><span class="samp">Save Game</span></samp>&rsquo; and are displayed by &lsquo;<samp><span class="samp">Load Game</span></samp>&rsquo;,
-&lsquo;<samp><span class="samp">Forward</span></samp>&rsquo;, and &lsquo;<samp><span class="samp">Backward</span></samp>&rsquo;. 
-<br><dt>ICS Input Box<dd><a name="index-ICS-Input-Box_002c-Menu-Item-42"></a>If this option is set in ICS mode,
-XBoard
-creates an extra window that you can use for typing in ICS commands. 
-The input box is especially useful if you want to type in something long or do
-some editing on your input, because output from ICS doesn't get mixed
-in with your typing as it would in the main terminal window. 
-<br><dt>Pause<dd><a name="index-Pause_002c-Menu-Item-43"></a>Pauses updates to the board, and if you are playing against a chess engine,
+<br><dt>Machine Match<dd><a name="index-Machine-match_002c-Menu-Item-66"></a>Starts a match between two chess programs,
+with a number of games and other parameters set through
+the &lsquo;<samp><span class="samp">Match Options</span></samp>&rsquo; menu dialog. 
+When a match is already running, selecting this item will make
+XBoard drop out of match mode after the current game finishes. 
+<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,
 also pauses your clock. To continue, select &lsquo;<samp><span class="samp">Pause</span></samp>&rsquo; again, and the
 display will automatically update to the latest position. 
-The &lsquo;<samp><span class="samp">P</span></samp>&rsquo; button and keyboard <kbd>p</kbd> key are equivalents.
+The &lsquo;<samp><span class="samp">P</span></samp>&rsquo; button and keyboard <kbd>Pause</kbd> key are equivalents.
 
      <p>If you select Pause when you are playing against a chess engine and
 it is not your move, the chess engine's clock