updated documentation
[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.12">
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="File-Menu.html#File-Menu" title="File 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 <p>
28 <a name="Mode-Menu"></a>
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="File-Menu.html#File-Menu">File 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.2 Mode Menu</h3>
36
37 <p><a name="index-Menu_002c-Mode-26"></a><a name="index-Mode-Menu-27"></a>
38      <dl>
39 <dt>Machine White<dd><a name="index-Machine-White_002c-Menu-Item-28"></a>Tells the chess engine to play White.\r
40 <br><dt>Machine Black<dd><a name="index-Machine-Black_002c-Menu-Item-29"></a>Tells the chess engine to play Black.\r
41 <br><dt>Two Machines<dd><a name="index-Two-Machines_002c-Menu-Item-30"></a>Plays a game between two chess engines.\r
42 <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\r
43 and shows you the analysis as you move pieces around.\r
44 Note: Some chess engines do not support Analysis mode.\r
45 \r
46 To set up a position to analyze, you do the following:\r
47 \r
48 1. Select Edit Position from the Mode Menu\r
49 \r
50 2. Set up the position.  Use the middle and right buttons to\r
51 bring up the white and black piece menus.\r
52 \r
53 3. When you are finished, click on either the Black or White\r
54 clock to tell XBoard which side moves first.\r
55 \r
56 4. Select Analysis Mode from the Mode Menu to start the analysis.\r
57 \r
58 The analysis function can also be used when observing games on an ICS\r
59 with an engine loaded (zippy mode); the engine then will analyse\r
60 the positions as they occur in the observed game.\r
61 <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.)\r
62 and analyze it. When you select this menu item, a popup window appears\r
63 and asks for a filename to load.\r
64 If the file contains multiple games, another popup appears that lets\r
65 you select which game you wish to analyze.\r
66 After a game is loaded, use the XBoard arrow buttons to step\r
67 forwards/backwards through the game and watch the analysis.\r
68 Note: Some chess engines do not support Analysis mode.\r
69 <br><dt>ICS Client<dd><a name="index-ICS-Client_002c-Menu-Item-33"></a>This is the normal mode when XBoard\r
70 is connected to a chess server.  If you have moved into\r
71 Edit Game or Edit Position mode, you can select this option to get out.\r
72 \r
73 To use xboard in ICS mode, run it in the foreground with the -ics\r
74 option, and use the terminal you started it from to type commands and\r
75 receive text responses from the chess server.  See\r
76 <a href="Chess-Servers.html#Chess-Servers">Chess Servers</a> below for more information.\r
77 \r
78 XBoard activates some special position/game editing features when you\r
79 use the <kbd>examine</kbd> or <kbd>bsetup</kbd> commands on ICS and you have\r
80 &lsquo;<samp><span class="samp">ICS Client</span></samp>&rsquo; selected on the Mode menu.  First, you can issue the\r
81 ICS position-editing commands with the mouse.  Move pieces by dragging\r
82 with mouse button 1.  To drop a new piece on a square, press mouse\r
83 button 2 or 3 over the square.  This brings up a menu of white pieces\r
84 (button 2) or black pieces (button 3).  Additional menu choices let\r
85 you empty the square or clear the board.  Click on the White or Black\r
86 clock to set the side to play.  You cannot set the side to play or\r
87 drag pieces to arbitrary squares while examining on ICC, but you can\r
88 do so in <kbd>bsetup</kbd> mode on FICS.  In addition, the menu commands\r
89 &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;\r
90 have special functions in this mode; see below.\r
91 <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\r
92 moves after backing up with the &lsquo;<samp><span class="samp">Backward</span></samp>&rsquo; command. The clocks do\r
93 not run.\r
94 \r
95 In chess engine mode, the chess engine continues to check moves for legality\r
96 but does not participate in the game. You can bring the chess engine\r
97 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;,\r
98 or &lsquo;<samp><span class="samp">Two Machines</span></samp>&rsquo;.\r
99 \r
100 In ICS mode, the moves are not sent to the ICS: &lsquo;<samp><span class="samp">Edit Game</span></samp>&rsquo; takes\r
101 XBoard out of ICS Client mode and lets you edit games locally.\r
102 If you want to edit games on ICS in a way that other ICS users\r
103 can see, use the ICS <kbd>examine</kbd> command or start an ICS match\r
104 against yourself.\r
105 <br><dt>Edit Position<dd><a name="index-Edit-Position_002c-Menu-Item-35"></a>Lets you set up an arbitrary board position.\r
106 Use mouse button 1 to drag pieces to new squares, or to delete a piece\r
107 by dragging it off the board or dragging an empty square on top of it.\r
108 To drop a new piece on a square, press mouse button 2 or 3 over the\r
109 square. This brings up a menu of white pieces (button 2) or\r
110 black pieces (button 3). Additional menu choices let you empty the\r
111 square or clear the board. You can set the side to play next by\r
112 clicking on the word White or Black at the top of the screen.\r
113 Selecting &lsquo;<samp><span class="samp">Edit Position</span></samp>&rsquo; causes XBoard to discard\r
114 all remembered moves in the current game.\r
115 \r
116 In ICS mode, changes made to the position by &lsquo;<samp><span class="samp">Edit Position</span></samp>&rsquo; are\r
117 not sent to the ICS: &lsquo;<samp><span class="samp">Edit Position</span></samp>&rsquo; takes XBoard out of\r
118 &lsquo;<samp><span class="samp">ICS Client</span></samp>&rsquo; mode and lets you edit positions locally. If you want to\r
119 edit positions on ICS in a way that other ICS users can see, use\r
120 the ICS <kbd>examine</kbd> command, or start an ICS match against yourself.\r
121 (See also the ICS Client topic above.)\r
122 <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\r
123 of the players. You guess the next move of the game by playing the\r
124 move on the board. If the move played matches the next move of the\r
125 game, the move is accepted and the opponent's response is autoplayed.\r
126 If the move played is incorrect, an error message is displayed.  You\r
127 can select this mode only while loading a game (that is, after\r
128 selecting &lsquo;<samp><span class="samp">Load Game</span></samp>&rsquo; from the File menu).  While XBoard is in \r
129 &lsquo;<samp><span class="samp">Training</span></samp>&rsquo; mode, the navigation buttons are disabled.\r
130 <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;\r
131 command.\r
132 <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.\r
133 This list allows you to move the display to any earlier position in the game\r
134 by clicking on the corresponding move.\r
135 <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\r
136 is displayed.\r
137 <br><dt>Edit Tags<dd><a name="index-Edit-Tags_002c-Menu-Item-40"></a>Lets you edit the PGN (portable game notation)\r
138 tags for the current game. After editing, the tags must still conform to\r
139 the PGN tag syntax:\r
140 \r
141      <pre class="example">          &lt;tag-section&gt; ::= &lt;tag-pair&gt; &lt;tag-section&gt;\r
142                                   &lt;empty&gt;\r
143           &lt;tag-pair&gt; ::= [ &lt;tag-name&gt; &lt;tag-value&gt; ]\r
144           &lt;tag-name&gt; ::= &lt;identifier&gt;\r
145           &lt;tag-value&gt; ::= &lt;string&gt;\r
146 </pre>
147      <p class="noindent">See the PGN Standard for full details. Here is an example:\r
148 \r
149      <pre class="example">          [Event "Portoroz Interzonal"]\r
150           [Site "Portoroz, Yugoslavia"]\r
151           [Date "1958.08.16"]\r
152           [Round "8"]\r
153           [White "Robert J. Fischer"]\r
154           [Black "Bent Larsen"]\r
155           [Result "1-0"]\r
156 </pre>
157      <p class="noindent">Any characters that do not match this syntax are silently ignored. Note that\r
158 the PGN standard requires all games to have at least the seven tags shown\r
159 above. Any that you omit will be filled in by XBoard\r
160 with &lsquo;<samp><span class="samp">?</span></samp>&rsquo; (unknown value), or &lsquo;<samp><span class="samp">-</span></samp>&rsquo; (inapplicable value).\r
161 <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\r
162 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;,\r
163 &lsquo;<samp><span class="samp">Forward</span></samp>&rsquo;, and &lsquo;<samp><span class="samp">Backward</span></samp>&rsquo;.\r
164 <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,\r
165 XBoard\r
166 creates an extra window that you can use for typing in ICS commands.\r
167 The input box is especially useful if you want to type in something long or do\r
168 some editing on your input, because output from ICS doesn't get mixed\r
169 in with your typing as it would in the main terminal window.\r
170 <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,\r
171 also pauses your clock. To continue, select &lsquo;<samp><span class="samp">Pause</span></samp>&rsquo; again, and the\r
172 display will automatically update to the latest position.\r
173 The &lsquo;<samp><span class="samp">P</span></samp>&rsquo; button and keyboard <kbd>p</kbd> key are equivalents.\r
174 \r
175 If you select Pause when you are playing against a chess engine and\r
176 it is not your move, the chess engine's clock\r
177 will continue to run and it will eventually make a move, at which point\r
178 both clocks will stop. Since board updates are paused, however,\r
179 you will not see the move until you exit from Pause mode (or select Forward).\r
180 This behavior is meant to simulate adjournment with a sealed move.\r
181 \r
182 If you select Pause while you are observing or examining a game on a\r
183 chess server, you can step backward and forward in the current history\r
184 of the examined game without affecting the other observers and\r
185 examiners, and without having your display jump forward to the latest\r
186 position each time a move is made. Select Pause again to reconnect\r
187 yourself to the current state of the game on ICS.\r
188 \r
189 If you select &lsquo;<samp><span class="samp">Pause</span></samp>&rsquo; while you are loading a game, the game stops\r
190 loading. You can load more moves manually by selecting &lsquo;<samp><span class="samp">Forward</span></samp>&rsquo;, or\r
191 resume automatic loading by selecting &lsquo;<samp><span class="samp">Pause</span></samp>&rsquo; again.\r
192 </dl>
193    \r
194
195    </body></html>
196