e9c1e2610263402d50a577908b41a9f10fde82e0
[xboard.git] / manual / html_node / Engine-Menu.html
1 <html lang="en">
2 <head>
3 <title>Engine 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="Action-Menu.html#Action-Menu" title="Action Menu">
10 <link rel="next" href="Options-Menu.html#Options-Menu" title="Options 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="Engine-Menu"></a>
28 <p>
29 Next:&nbsp;<a rel="next" accesskey="n" href="Options-Menu.html#Options-Menu">Options Menu</a>,
30 Previous:&nbsp;<a rel="previous" accesskey="p" href="Action-Menu.html#Action-Menu">Action 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.6 Engine Menu</h3>
36
37 <p><a name="index-Engine-Menu-81"></a><a name="index-Menu_002c-Engine-82"></a>
38      <dl>
39 <dt>Load Engine<dd><a name="index-Load-Engine_002c-Menu-Item-83"></a>Pops up a dialog where you can select or specify an engine to be loaded. 
40 You will always have to indicate whether you want to load the engine
41 as first or second engine, through the ‘Load menitioned engine as’
42 drop-down list at the bottom of the dialog. 
43 You can even replace engines during a game, without disturbing that game. 
44 (Beware that after loading an engine, XBoard will always be in Edit Game mode,
45 so you will have to tell the new engine what to do before it does anything!) 
46 When you select an already installed engine from the ‘Select Engine from List’
47 drop-down list,
48 all other fields of the dialog will be ignored. 
49 In other cases, you have to specify the engine executable,
50 possible arguments on the engine command line
51 (if the engine docs say the engine needs any),
52 and the directory where the engine should look for its files
53 (if this cannot be deduced automatically from the specification of the engine executable). 
54 You will also have to specify (with the aid of checkboxes) if the engine is UCI. 
55 If ‘Add this engine to the list’ is ticked (which it is by default),
56 the engine will be added to the list of installed engines in your settings file,
57 (provided you save the settings!),
58 so that next time you can select it from the drop-down list. 
59 You can also specify a ‘nickname’,
60 under which the engine will then appear in that drop-down list,
61 and even choose to use that nickname for it in PGN files for engine-engine games. 
62 The info you supply with the checkboxes whether the engine should use GUI book,
63 or (for variant engines) automatically switch to the current variant when loaded,
64 will also be included in the list. 
65 For obsolete XBoard engines, which would normally take a long delay to load
66 because XBoard is waiting for a response they will not give,
67 you can tick ‘WB protocol v1’ to speed up the loading process. 
68 <br><dt>Engine #N Settings<dd><a name="index-Engine-Settings_002c-Menu-Item-84"></a><a name="index-Engine-_00231-Settings_002c-Menu-Item-85"></a><a name="index-Engine-_00232-Settings_002c-Menu-Item-86"></a>Pop up a menu dialog to alter the settings specific to the applicable engine. 
69 (The second engine is only accessible once it has been used in Two-Machines mode.) 
70 For each parameter the engine allows to be set,
71 a control element will appear in this dialog that can be used to alter the value. 
72 Depending on the type of parameter (text string, number, multiple choice,
73 on/off switch, instantaneous signal) the appropriate control will appear,
74 with a description next to it. 
75 XBoard has no idea what these values mean; it just passes them on to the engine. 
76 How this dialog looks is completely determined by the engine,
77 and XBoard just passes it on to the user. 
78 Many engines do not have any parameters that can be set by the user,
79 and in that case the dialog will be empty (except for the OK and cancel buttons). 
80 UCI engines usually have many parameters. (But these are only visible with
81 a sufficiently modern version of the Polyglot adapter needed to run UCI engines,
82 e.g. Polyglot 1.4.55b.) For native XBoard engines this is less common. 
83 <br><dt>Hint<dd><a name="index-Hint_002c-Menu-Item-87"></a>Displays a move hint from the chess engine. 
84 <br><dt>Book<dd><a name="index-Book_002c-Menu-Item-88"></a>Displays a list of possible moves from the chess engine's opening
85 book.  The exact format depends on what chess engine you are using. 
86 With GNU Chess 4, the first column gives moves, the second column
87 gives one possible response for each move, and the third column shows
88 the number of lines in the book that include the move from the first
89 column. If you select this option and nothing happens, the chess
90 engine is out of its book or does not support this feature. 
91 <br><dt>Move Now<dd><a name="index-Move-Now_002c-Menu-Item-89"></a>Forces the chess engine to move immediately. Chess engine mode only. 
92 The <kbd>Ctrl-M</kbd> key is a keyboard equivalent. 
93 <br><dt>Retract Move<dd><a name="index-Retract-Move_002c-Menu-Item-90"></a>Retracts your last move. In chess engine mode, you can do this only
94 after the chess engine has replied to your move; if the chess engine is still
95 thinking, use &lsquo;<samp><span class="samp">Move Now</span></samp>&rsquo; first. In ICS mode, &lsquo;<samp><span class="samp">Retract Move</span></samp>&rsquo;
96 issues the command &lsquo;<samp><span class="samp">takeback 1</span></samp>&rsquo; or &lsquo;<samp><span class="samp">takeback 2</span></samp>&rsquo;
97 depending on whether it is your opponent's move or yours. 
98 The <kbd>Ctrl-X</kbd> key is a keyboard equivalent. 
99 <br><dt>Recently Used Engines<dd><a name="index-Recently-Used-Engines_002c-In-Menu-91"></a>At the bottom of the engine menu there can be a list of names
100 of engines that you recently loaded through the Load Engine menu dialog
101 in previous sessions. 
102 Clicking on such a name will load that engine as first engine,
103 so you won't have to search for it in your list of installed engines,
104 if that is very long. 
105 The maximum number of displayed engine names is set by the
106 <code>recentEngines</code>command-line option. 
107 </dl>
108
109    </body></html>
110