Docs update for new features
[xboard.git] / winboard / help / html / 04.htm
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">\r
2 <HTML>\r
3 <HEAD>\r
4 <META HTTP-EQUIV="Content-Type" Content="text/html; charset=Windows-1252">\r
5 <TITLE>Mode Menu</TITLE>\r
6 </HEAD>\r
7 \r
8 <BODY BGCOLOR="#FFFFFF" TEXT="#000000">\r
9 \r
10 \r
11 \r
12 <P><B><A NAME="modemenu"></A>Mode Menu</B></P>\r
13 \r
14 \r
15 \r
16 <P><B><A NAME="machinewhite"></A>Machine White</B></P>\r
17 \r
18 <P>Forces the chess engine to play white.</P>\r
19 \r
20 \r
21 \r
22 <P><B><A NAME="machineblack"></A>Machine Black</B></P>\r
23 \r
24 <P>Forces the chess engine to play black.</P>\r
25 \r
26 \r
27 \r
28 <P><B><A NAME="twomachines"></A>Two Machines</B></P>\r
29 \r
30 <P>Starts a game between two chess engines.</P>\r
31 \r
32 \r
33 \r
34 <P><B><A NAME="machine both"></A><font color="#008000">Machine Both</font></B></P>\r
35 \r
36 <P><font color="#008000">A single chess engine plays itself. Mainly useful for pseudo-engines, that are in fact communication links to another machine, where you want to observe a game that is being played. (E.g. the gothic-chess.com server). This command is not implemented yet (version 4.3.14).</font></P>\r
37 \r
38 \r
39 \r
40 <P><B><A NAME="analysismode"></A>Analysis Mode</B></P>\r
41 \r
42 <P>In this mode, you can make moves for both sides on the board. After each move, the chess engine will think about possible replies and display its analysis in a separate window. Crafty was the first engine to support this feature, but by now there are many others that support it as well.</P>\r
43 \r
44 <P><font color="#3333ff">From WinBoard 4.4 on this function can also be invoked in ‘zippy mode’, i.e. when you are logged on to an ICS with an engine loaded. In that case it is not your own moves that the engine analyzes, but the moves that are played in a game on the ICS that you are observing. You must start observing before you start the analysis mode! See the file zippy.README for how to connect to an ICS and a chess engine running on your local computer at the same time. (Basically this amounts to adding the /zp command-line option in addition to all options you would need for connecting to the ICS, as well as those needed for running the chess engine.)</font></P>\r
45 \r
46 \r
47 \r
48 <P><B><A NAME="analyzefile"></A>Analyze File</B></P>\r
49 \r
50 <P>In this mode, you can load a game from a file, and the chess engine will analyze each move as in Analysis Mode. Crafty was the first engine to support this feature, but by now there are many others that support it as well.</P>\r
51 \r
52 \r
53 \r
54 <P><B><A NAME="icsclient"></A>ICS Client</B></P>\r
55 \r
56 <P>This is the normal mode when WinBoard 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.</P>\r
57 \r
58 <P>When you run WinBoard in ICS mode, it starts up a console window in which you can type commands and receive text responses from the chess server. You can use the standard Windows editing keys to edit your command line before pressing Enter. The console window keeps a history of the last few commands you typed. Press the up-arrow key to go back to a previous command; press the down-arrow key to go forward again to a later command. Press the right mouse button in the output area for a <A HREF="09.htm">context menu</A> of editing commands and ICS command shortcuts.</P>\r
59 \r
60 <P>Some useful ICS commands include <B>who</B> to see who is logged on, <B>games</B> to see what games are being played, <B>match</B> to challenge another player to a game, <B>observe</B> to observe an ongoing game, <B>examine</B> or <B>smoves</B> to review a recently completed game, and of course <B>help</B>. </P>\r
61 \r
62 <P>Whenever you ask to observe an ongoing game, review a completed game, or resume an adjourned game, WinBoard retrieves and parses the list of past moves from the ICS, so you can review them with <A HREF="06.htm#forward">Forward</A> and <A HREF="06.htm#backward">Backward</A> or save them with <A HREF="03.htm#savegame">Save Game</A>.</P>\r
63 \r
64 <P>Some special ICS Client features are activated when you are in <B>examine</B> or <B>bsetup </B>mode on ICS. See the descriptions of the menu commands <A HREF="06.htm#forward">Forward</A>, <A HREF="06.htm#backward">Backward</A>, <A HREF="#pause">Pause</A>, and <A HREF="05.htm#stopexamining">Stop Examining</A> below. You can also issue the ICS position-editing commands with the mouse. Move pieces by dragging with the left mouse button, or by left-clicking once on the starting square and once on the ending square. Press the right mouse button over a square for a context menu that lets you drop a new piece, empty the square, or clear the board. Click on the White or Black clock to set the side to play. You cannot set the side to play or drag pieces to arbitrary squares while examining on ICC, but you can do so in bsetup mode on FICS. You can also make moves by typing them into the ICS window; you may have to do this occasionally if you are playing a chess variant whose rules WinBoard does not understand, such as Fischer Random.</P>\r
65 \r
66 <P>If you are playing a bughouse game on the ICS, a list of the offboard pieces that each player holds is shown in the window title bar. To drop an offboard piece, press the right mouse button over an empty square to bring up a context menu. To observe your partner's games, start a second copy of WinBoard, log in as a guest, and use the ICS <B>follow</B> or <B>pfollow</B> command in the new window.</P>\r
67 \r
68 \r
69 \r
70 <P><B><A NAME="editgame"></A>Edit Game</B></P>\r
71 \r
72 <P>Allows you to make moves for both Black and White, and to change moves after backing up with the <A HREF="06.htm#backward">Backward</A> command. The clocks do not run, but you can adjust their reading by clicking on them. A left-click subtracts one minute, a right-click adds one minute.</P>\r
73 \r
74 <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 back into the game by selecting <A HREF="#machinewhite">Machine White</A>, <A HREF="#machineblack">Machine Black</A>, or <A HREF="#twomachines">Two Machines</A>.</P>\r
75 \r
76 <P>In ICS mode, the moves are not sent to the ICS: Edit Game takes WinBoard out of ICS Client mode and lets you edit games locally. If you want to edit a game on ICS in a way that other ICS users can see, use the ICS <B>examine</B> command or start an ICS match against yourself.</P>\r
77 \r
78 \r
79 \r
80 <P><B><A NAME="editposition"></A>Edit Position</B></P>\r
81 \r
82 <P>Lets you set up an arbitrary board position. Use the left mouse button 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 the right mouse button over the square. This brings up a menu of pieces. Additional menu choices let you empty the square or clear the board. You can set the side to play next by clicking on the White or Black indicator at the top of the screen. <font color="#008000">The pop-up menu also contains options to ‘promote’ or ‘demote’ the piece currently in the square. (In variants like Crazyhouse a piece has a different representation when it is a promoted Pawn rater than an original piece.) This allows you to create some of the not-so-common pieces (e.g. a Unicorn is a promoted King, a Commoner is a demoted King).</font></P>\r
83 \r
84 <P>Selecting Edit Position causes WinBoard<I> </I>to discard all remembered moves in the current game.</P>\r
85 \r
86 <P>In ICS mode, change made to the position by Edit Position are not sent to the ICS: Edit Position takes WinBoard out of ICS Client 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 <B>examine</B> command, or start an ICS match against yourself. (See also <A HREF="#icsclient">ICS Client</A> above.)</P>\r
87 \r
88 \r
89 \r
90 <P><B><A NAME="show engine output"></A><font color="#ff0000">Show Engine Output</font></B></P>\r
91 \r
92 <P><font color="#ff0000">Open a new window dedicated to showing the thinking output of the engine(s), as controlled by “Show Thinking”.</font></P>\r
93 \r
94 \r
95 \r
96 <P><B><A NAME="show evaluation graph"></A><font color="#ff0000">Show Evaluation Graph</font></B></P>\r
97 \r
98 <P><font color="#ff0000">Open a new window dedicated to displaying a graph, representing the development of the engine score(s) from the current game over time. (Needs “Show Thinking” to be enabled in order to work.</font> <font color="#3333FF">WinBoard will display lines of thinking output of the same depth ordered by score, (highest score on top), rather than in the order the engine produced them. Usually this amounts to the same, as a normal engine search will only find new PV (and emit it as thinking output) when it searches a move with a higher score than the previous variation. But when the engine is in multi-variation mode this needs not always be true, and it is more convenient for someone analyzing games to see the moves sorted by score. The order in which the engine found them is only of interest o the engine author, and can still be deduced from the time or node count printed with the line.</font></P>\r
99 \r
100 \r
101 \r
102 <P><B><A NAME="showgamelist"></A>Show Game List</B></P>\r
103 \r
104 <P>Shows or hides the list of games generated by the last <A HREF="03.htm#loadgame">Load Game</A> command.</P>\r
105 \r
106 \r
107 \r
108 <P><B><A NAME="show move history"></A><font color="#ff0000">Show Move History</font></B></P>\r
109 \r
110 <P><font color="#ff0000">Open a new window dedicated to showing the game currently in progress.</font></P>\r
111 \r
112 \r
113 \r
114 <P><B><A NAME="training"></A>Training</B></P>\r
115 \r
116 <P>Training mode lets you interactively guess the moves of a game for one of the players. While in Training mode, the navigation buttons are disabled. You guess the next move of the game by playing the move on the board (or using the <A HREF="06.htm#typeinmove">Type In Move</A> command). 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. </P>\r
117 \r
118 \r
119 \r
120 <P><B><A NAME="edittags"></A>Edit Tags</B></P>\r
121 \r
122 <P>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:</P>\r
123 \r
124 <PRE><CODE>\r
125 &lt;tag-section&gt; ::= &lt;tag-pair&gt; &lt;tag-section&gt;\r
126                   &lt;empty&gt;\r
127 &lt;tag-pair&gt;    ::= [ &lt;tag-name&gt; &lt;tag-value&gt; ]\r
128 &lt;tag-name&gt;    ::= &lt;identifier&gt;\r
129 &lt;tag-value&gt;   ::= &lt;string&gt;</CODE></PRE>\r
130 \r
131 <P>See the PGN Standard for full details. Here is an example:</P>\r
132 \r
133 <PRE><CODE>\r
134 [Event "Portoroz Interzonal"]\r
135 [Site "Portoroz, Yugoslavia"]\r
136 [Date "1958.08.16"]\r
137 [Round "8"]\r
138 [White "Robert J. Fischer"]\r
139 [Black "Bent Larsen"]\r
140 [Result "1-0"]</CODE></PRE>\r
141 \r
142 <P>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 WinBoard with <CODE>"?"</CODE> (unknown value) or <CODE>"-"</CODE> (inapplicable value).</P>\r
143 \r
144 \r
145 \r
146 <P><B><A NAME="editcomment"></A>Edit Comment</B></P>\r
147 \r
148 <P>Adds or modifies a comment on the current position. Comments are saved by <A HREF="03.htm#savegame">Save Game</A> and are displayed by <A HREF="03.htm#loadgame">Load Game</A>, <A HREF="06.htm#forward">Forward</A>, and <A HREF="06.htm#backward">Backward</A>.</P>\r
149 \r
150 \r
151 \r
152 <P><B><A NAME="enterusername"></A><font color="#008000">Enter Username</font></B></P>\r
153 \r
154 <P><font color="#008000">Allows you to type the name of the human player, which will appear in the PGN header and in the window title.</font></P>\r
155 \r
156 \r
157 \r
158 <P><B><A NAME="pause"></A>Pause</B></P>\r
159 \r
160 <P>Pauses updates to the board, and if you are playing against a local chess engine, also pauses your clock. To continue, select Pause again, and the display will automatically update to the latest position. The <B>P</B> (or <B>C</B>) button is equivalent to selecting Pause.</P>\r
161 \r
162 <P>If you select Pause when you are playing against a chess engine and it is not your move, the chess engine’s clock will continue to run and it will eventually make a move, at which point both clocks will stop. Since board updates are paused, however, you will not see the move until you exit from Pause mode (or select <A HREF="06.htm#forward">Forward</A>). This behavior is meant to simulate adjournment with a sealed move.</P>\r
163 \r
164 <P>If you select Pause while you are in <B>examine</B> mode on ICS, you can step backward and forward in the current history of the examined game without affecting the other examiners or observers. Select Pause again to reconnect yourself to the current state of the game on ICS.</P>\r
165 \r
166 <P>If you select Pause while you are loading a game, the game stops loading. You can load more moves one at a time by selecting <A HREF="06.htm#forward">Forward</A>, or resume automatic loading by selecting Pause again.</P>\r
167 \r
168 </BODY>\r
169 </HTML>\r