fix configure bug that showed up on OS X (couldn't find X11/Dialog.h)
[xboard.git] / engine-intf.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"\r
2           "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">\r
3 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">\r
4 <head>\r
5 <title>Chess Engine Communication Protocol</title>\r
6 <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />\r
7 <style type="text/css">\r
8   .header { \r
9   border-top:2px solid black;\r
10   border-bottom:2px solid black;\r
11   }\r
12   .version1 { color: red;}\r
13   .version43 { color: green;}\r
14   .version44 { color: blue; }\r
15   .version47 { color: purple; }\r
16 \r
17   table tr { text-align: left}\r
18   tr > td:first-child { font-weight:bold;}\r
19   dt { font-weight:bold;}\r
20 \r
21   </style>\r
22 \r
23 </head>\r
24 \r
25 <body>\r
26 <div class="header">\r
27 <h1>Chess Engine Communication Protocol</h1>\r
28 <h2><a href="http://www.tim-mann.org/">Tim Mann</a> &amp; <a href="http://home.hccnet.nl/h.g.muller/winboardF.html">H.G.Muller</a></h2>\r
29 <p>\r
30 Version 2; implemented in xboard/WinBoard 4.2.1 and later. (Sept 3, 2009)<br />\r
31 Changes since version 1 are indicated in <span class="version1">red</span>.<br />\r
32 Changes for WinBoard 4.3.xx are indicated in <span class="version43">green</span>.<br />\r
33 Changes for WinBoard 4.4.xx are indicated in <span class="version44">blue</span>.\r
34 </p>\r
35 </div>\r
36 \r
37 <ul>\r
38 <li><a href="#1">1. Introduction</a></li>\r
39 <li><a href="#2">2. Connection</a></li>\r
40 <li><a href="#3">3. Debugging</a></li>\r
41 <li><a href="#4">4. How it got this way</a></li>\r
42 <li><a href="#5">5. WinBoard requires Win32 engines</a></li>\r
43 <li><a href="#6">6. Hints on input/output</a></li>\r
44 <li><a href="#7">7. Signals</a></li>\r
45 <li><a href="#8">8. Commands from xboard to the engine</a></li>\r
46 <li><a href="#9">9. Commands from the engine to xboard</a></li>\r
47 <li><a href="#10">10. Thinking Output</a></li>\r
48 <li><a href="#11">11. Time control</a></li>\r
49 <li><a href="#12">12. Analyze Mode</a></li>\r
50 <li><a href="#13">13. Idioms and backward compatibility features</a></li>\r
51 </ul>\r
52 \r
53 <hr />\r
54 \r
55 <h2><a name="1">1. Introduction</a></h2>\r
56 \r
57 <p>\r
58 This document is a set of rough notes on the protocol that xboard and\r
59 WinBoard use to communicate with gnuchessx and other chess engines.\r
60 These notes may be useful if you want to connect a different chess\r
61 engine to xboard.  Throughout the notes, "xboard" means both xboard\r
62 and WinBoard except where they are specifically contrasted.\r
63 </p>\r
64 \r
65 <p>\r
66 There are two reasons I can imagine someone wanting to do this: \r
67 </p>\r
68 \r
69 <ol>\r
70 <li>You have, or are developing, a chess engine but you don't want to\r
71 write your own graphical interface. </li>\r
72 <li>You have, or are developing,a chess engine, and you want to\r
73 interface it to the Internet Chess Server.</li>\r
74 </ol>\r
75 \r
76 <p>\r
77 In case (2), if you are using xboard, you will need to configure the\r
78 "Zippy" code into it, but WinBoard includes this code already.  See\r
79 the file <a\r
80 href="http://www.tim-mann.org/xboard/zippy.README">zippy.README</a>\r
81 in the xboard or WinBoard distribution for more information.\r
82 </p>\r
83 \r
84 <p>\r
85 These notes are unpolished, but I've attempted to make them complete\r
86 in this release.  If you notice any errors, omissions, or misleading\r
87 statements, let me know.\r
88 </p>\r
89 \r
90 <p>\r
91 I'd like to hear from everyone who is trying to interface their own\r
92 chess engine to xboard/WinBoard. Please join the mailing list for \r
93 authors of xboard/WinBoard compatible chess engines and post a message \r
94 about what you're doing. The list is now hosted by Yahoo Groups; you \r
95 can join at <a href="http://groups.yahoo.com/group/chess-engines" \r
96 >http://groups.yahoo.com/group/chess-engines</a>, or you can read the\r
97 list there without joining.  The list is filtered to prevent spam.\r
98 </p>\r
99 \r
100 <p class="version43">\r
101 Note that the WinBoard 4.3.xx line was developed independently of the\r
102 original GNU project, by H.G.Muller.\r
103 If you have questions about WinBoard 4.3.xx, or want to report bugs in it,\r
104 report them in the appropriate section of the \r
105 <a href="http://www.open-aurec.com/wbforum/">WinBoard forum</a>.\r
106 </p>\r
107 \r
108 <h2><a name="2">2. Connection</a></h2>\r
109 \r
110 <p>\r
111 An xboard chess engine runs as a separate process from xboard itself,\r
112 connected to xboard through a pair of anonymous pipes.  The engine\r
113 does not have to do anything special to set up these pipes.  xboard\r
114 sets up the pipes itself and starts the engine with one pipe as its\r
115 standard input and the other as its standard output.  The engine then\r
116 reads commands from its standard input and writes responses to its\r
117 standard output.  This is, unfortunately, a little more complicated to\r
118 do right than it sounds; see <a href="#6">section 6</a> below.\r
119 </p>\r
120 \r
121 <p>\r
122 And yes, contrary to some people's expectations, exactly the same\r
123 thing is true for WinBoard.  Pipes and standard input/output are\r
124 implemented in Win32 and work fine.  You don't have to use DDE, COM,\r
125 DLLs, BSOD, or any of the other infinite complexity that\r
126 Microsoft has created just to talk between two programs.  A WinBoard\r
127 chess engine is a Win32 console program that simply reads from its\r
128 standard input and writes to its standard output.  See sections \r
129 <a href="#5">5</a> and <a href="#6">6</a> below for additional details.\r
130 </p>\r
131 \r
132 <h2><a name="3">3. Debugging</a></h2>\r
133 \r
134 <p>\r
135 To diagnose problems in your engine's interaction with xboard, use the\r
136 -debug flag on xboard's command line to see the messages that are\r
137 being exchanged.  In WinBoard, these messages are written to the file\r
138 WinBoard.debug instead of going to the screen.\r
139 </p>\r
140 \r
141 <p>\r
142 You can turn debug mode on or off while WinBoard is running by\r
143 pressing Ctrl+Alt+F12.  You can turn debug mode on or off while xboard\r
144 is running by binding DebugProc to a shortcut key (and pressing the\r
145 key!); see the instructions on shortcut keys in the xboard man page.\r
146 </p>\r
147 \r
148 <p>\r
149 While your engine is running under xboard/WinBoard, you can send a\r
150 command directly to the engine by pressing Shift+1 (xboard) or Alt+1\r
151 (WinBoard 4.0.3 and later).  This brings up a dialog that you can type\r
152 your command into.  Press Shift+2 (Alt+2) instead to send to the\r
153 second chess engine in Two Machines mode.  On WinBoard 4.0.2 and earlier,\r
154 Ctrl+Alt is used in place of Alt; this had to be changed due to a conflict\r
155 with typing the @-sign on some European keyboards.\r
156 </p>\r
157 \r
158 <h2><a name="4">4. How it got this way</a></h2>\r
159 \r
160 <p>\r
161 Originally, xboard was just trying to talk to the existing\r
162 command-line interface of GNU Chess 3.1+ and 4, which was designed\r
163 for people to type commands to.  So the communication protocol is very\r
164 ad-hoc.  It might have been good to redesign it early on, but because\r
165 xboard and GNU Chess are separate programs, I didn't want to force\r
166 people to upgrade them together to versions that matched.  I\r
167 particularly wanted to keep new versions of xboard working with old\r
168 versions of GNU Chess, to make it easier to compare the play of old\r
169 and new gnuchess versions.  I didn't foresee the need for a clean\r
170 protocol to be used with other chess engines in the future.\r
171 </p>\r
172 \r
173 <p>\r
174 Circumstances have changed over the years, and now there are many more\r
175 engines that work with xboard.  I've had to make the protocol\r
176 description more precise, I've added some features that GNU Chess\r
177 does not support, and I've specified the standard semantics of a few\r
178 features to be slightly different from what GNU Chess 4 does.\r
179 </p>\r
180 \r
181 <p class="version1">\r
182 This release of the protocol specification is the first to carry a\r
183 version number of its own -- version 2.  Previous releases simply\r
184 carried a last-modified date and were loosely tied to specific \r
185 releases of xboard and WinBoard.  The version number "1" applies\r
186 generally to all those older versions of the protocol.\r
187 </p>\r
188 \r
189 <p class="version1">\r
190 Protocol version 2 remains compatible with older engines but has\r
191 several new capabilities.  In particular, it adds the \r
192 "feature" command, a new mechanism for making backward-compatible\r
193 changes and extensions to the protocol.  Engines that do not support a\r
194 particular new feature do not have to use it; new features are not\r
195 enabled unless the engine specifically requests them using the feature\r
196 command.  If an engine does not send the feature command at all, the\r
197 protocol behavior is nearly identical to version 1.  Several new\r
198 features can be selected by the feature command in version 2,\r
199 including the "ping" command (recommended for all engines), the\r
200 "setboard" command, and many optional parameters.  Additional features\r
201 will probably be added in future versions.\r
202 </p>\r
203 \r
204 <p class="version43">\r
205 If it is necessary to have a separate name, \r
206 it would be best to refer to the protocol including the green additions as version 2f.\r
207 I really don't think it is a different protocol from version 2, though.\r
208 I just tried to clarify some ambiguities in the original definition,\r
209 now that the WinBoard 4.3.xx line has implemented them in a specific way.\r
210 The hand-shaking protocol for features as defined in protocol 2 perfectly\r
211 allows addition of an occasional new features without any need for stepping up the protocol version number,\r
212 and I think refraining from the latter would enormously lower the barrier for actual\r
213 implementation of these features in engines.\r
214 <br />\r
215 The two really new things are the engine debug comments, and the "nps" command.\r
216 The former merely tries to regulate an extremely common existing pactice \r
217 of having engines dump debug messages on WinBoard in an unprotected way, \r
218 as usually you get away with that.\r
219 </p>\r
220 \r
221 <h2><a name="5">5. WinBoard requires Win32 engines</a></h2>\r
222 \r
223 <p>\r
224 Due to some Microsoft brain damage that I don't understand, WinBoard\r
225 does not work with chess engines that were compiled to use a DOS\r
226 extender for 32-bit addressing.  (Probably not with 16-bit DOS or\r
227 Windows programs either.)  WinBoard works only with engines that are\r
228 compiled for the Win32 API.  You can get a free compiler that targets\r
229 the Win32 API from <a href="http://sources.redhat.com/cygwin/"\r
230 >http://sources.redhat.com/cygwin/</a>.  I think DJGPP 2.x should also\r
231 work if you use the RSXNTDJ extension, but I haven't tried it.  Of\r
232 course, Microsoft Visual C++ will work.  Most likely the other\r
233 commercial products that support Win32 will work too (Borland, etc.),\r
234 but I have not tried them.  Delphi has been successfully used to write\r
235 engines for WinBoard; if you want to do this, Tony Werten has donated\r
236 some <a href="http://www.tim-mann.org/winboard/delphi.txt" >sample\r
237 code</a> that should help you get started.\r
238 </p>\r
239 \r
240 <h2><a name="6">6. Hints on input/output</a></h2>\r
241 \r
242 <p>\r
243 Beware of using buffered I/O in your chess engine.  The C stdio\r
244 library, C++ streams, and the I/O packages in most other languages use\r
245 buffering both on input and output.  That means two things.  First,\r
246 when your engine tries to write some characters to xboard, the library\r
247 stashes them in an internal buffer and does not actually write them to\r
248 the pipe connected to xboard until either the buffer fills up or you\r
249 call a special library routine asking for it to be flushed.  (In C\r
250 stdio, this routine is named <tt>fflush</tt>.)  Second, when your engine tries\r
251 to read some characters from xboard, the library does not read just\r
252 the characters you asked for -- it reads all the characters that are\r
253 currently available (up to some limit) and stashes any characters you\r
254 are not yet ready for in an internal buffer.  The next time you ask to\r
255 read, you get the characters from the buffer (if any) before the\r
256 library tries to read more data from the actual pipe.\r
257 </p>\r
258 \r
259 <p>\r
260 Why does this cause problems?  First, on the output side, remember\r
261 that your engine produces output in small quantities (say, a few\r
262 characters for a move, or a line or two giving the current analysis),\r
263 and that data always needs to be delivered to xboard/WinBoard for\r
264 display immediately.  If you use buffered output, the data you print\r
265 will sit in a buffer in your own address space instead of being\r
266 delivered.\r
267 </p>\r
268 \r
269 <p>\r
270 You can usually fix the output buffering problem by asking for the\r
271 buffering to be turned off.  In C stdio, you do this by calling\r
272 <tt>setbuf(stdout, NULL)</tt>.  A more laborious and error-prone\r
273 method is to carefully call <tt>fflush(stdout)</tt> after every line\r
274 you output; I don't recommend this.  In C++, you can try\r
275 <tt>cout.setf(ios::unitbuf)</tt>, which is documented in current\r
276 editions of "The C++ Programming Language," but not older ones.\r
277 Another C++ method that might work is\r
278 <tt>cout.rdbuf()-&gt;setbuf(NULL, 0)</tt>.  Alternatively, you can\r
279 carefully call <tt>cout.flush()</tt> after every line you output;\r
280 again, I don't recommend this.\r
281 </p>\r
282 \r
283 <p>\r
284 Another way to fix the problem is to use unbuffered operating system\r
285 calls to write directly to the file descriptor for standard output.\r
286 On Unix, this means <tt>write(1, ...)</tt> -- see the man page for write(2).\r
287 On Win32, you can use either the Unix-like <tt>_write(1, ...)</tt> or Win32\r
288 native routines like <tt>WriteFile</tt>.\r
289 </p>\r
290 \r
291 <p>\r
292 Second, on the input side, you are likely to want to poll during your\r
293 search and stop it if new input has come in.  If you implement\r
294 pondering, you'll need this so that pondering stops when the user\r
295 makes a move.  You should also poll during normal thinking on your\r
296 move, so that you can implement the "?" (move now) command, and so\r
297 that you can respond promptly to a "result", "force", or "quit"\r
298 command if xboard wants to end the game or terminate your engine.\r
299 Buffered input makes polling more complicated -- when you poll, you\r
300 must stop your search if there are <em>either</em> characters in the buffer\r
301 <em>or</em> characters available from the underlying file descriptor.\r
302 </p>\r
303 \r
304 <p>\r
305 The most direct way to fix this problem is to use unbuffered operating\r
306 system calls to read (and poll) the underlying file descriptor\r
307 directly.  On Unix, use <tt>read(0, ...)</tt> to read from standard input, and\r
308 use <tt>select()</tt> to poll it.  See the man pages read(2) and select(2).\r
309 (Don't follow the example of GNU Chess 4 and use the FIONREAD ioctl to\r
310 poll for input.  It is not very portable; that is, it does not exist\r
311 on all versions of Unix, and is broken on some that do have it.)  On\r
312 Win32, you can use either the Unix-like <tt>_read(0, ...)</tt> or the native\r
313 Win32 <tt>ReadFile()</tt> to read.  Unfortunately, under Win32, the function to\r
314 use for polling is different depending on whether the input device is\r
315 a pipe, a console, or something else.  (More Microsoft brain damage\r
316 here -- did they never hear of device independence?)  For pipes, you\r
317 can use <tt>PeekNamedPipe</tt> to poll (even when the pipe is unnamed).\r
318 For consoles, \r
319 you can use <tt>GetNumberOfConsoleInputEvents</tt>.  For sockets only, you can\r
320 use <tt>select()</tt>.  It might be possible to use\r
321 <tt>WaitForSingleObject</tt> more \r
322 generally, but I have not tried it.  Some code to do these things can\r
323 be found in Crafty's utility.c, but I don't guarantee that it's all\r
324 correct or optimal.\r
325 </p>\r
326 \r
327 <p>\r
328 A second way to fix the problem might be to ask your I/O library not\r
329 to buffer on input.  It should then be safe to poll the underlying\r
330 file descriptor as described above.  With C, you can try calling\r
331 <tt>setbuf(stdin, NULL)</tt>.  However, I have never tried this.  Also, there\r
332 could be problems if you use <tt>scanf()</tt>, at least with certain patterns,\r
333 because <tt>scanf()</tt> sometimes needs to read one extra character and "push\r
334 it back" into the buffer; hence, there is a one-character pushback\r
335 buffer even if you asked for stdio to be unbuffered.  With C++, you\r
336 can try <tt>cin.rdbuf()-&gt;setbuf(NULL, 0)</tt>, but again, I have never tried\r
337 this.\r
338 </p>\r
339 \r
340 <p>\r
341 A third way to fix the problem is to check whether there are\r
342 characters in the buffer whenever you poll.  C I/O libraries generally\r
343 do not provide any portable way to do this.  Under C++, you can use\r
344 <tt>cin.rdbuf()-&gt;in_avail()</tt>.  This method has been reported to\r
345 work with \r
346 EXchess.  Remember that if there are no characters in the buffer, you\r
347 still have to poll the underlying file descriptor too, using the\r
348 method described above.\r
349 </p>\r
350 \r
351 <p>\r
352 A fourth way to fix the problem is to use a separate thread to read\r
353 from stdin.  This way works well if you are familiar with thread\r
354 programming.  This thread can be blocked waiting for input to come in\r
355 at all times, while the main thread of your engine does its thinking.\r
356 When input arrives, you have the thread put the input into a buffer\r
357 and set a flag in a global variable.  Your search routine then\r
358 periodically tests the global variable to see if there is input to\r
359 process, and stops if there is.  WinBoard and my Win32 ports of ICC\r
360 timestamp and FICS timeseal use threads to handle multiple input\r
361 sources.\r
362 </p>\r
363 \r
364 <h2><a name="7">7. Signals</a></h2>\r
365 \r
366 <p>Engines that run on Unix need to be concerned with two Unix\r
367 signals: <tt>SIGTERM</tt> and <tt>SIGINT</tt>.  This applies both to\r
368 engines that run under xboard and (the unusual case of) engines that\r
369 WinBoard remotely runs on a Unix host using the -firstHost or\r
370 -secondHost feature.  It does not apply to engines that run on\r
371 Windows, because Windows does not have Unix-style signals.\r
372 <span class="version1">\r
373 Beginning with version 2, you can now turn off the use of\r
374 either or both\r
375 signals.  See the "feature" command in <a href="#6">section 9</a> below.\r
376 </span>\r
377 </p>\r
378 \r
379 <p>First, when an engine is sent the "quit" command, it is also given\r
380 a <tt>SIGTERM</tt> signal shortly afterward to make sure it goes away.\r
381 If your engine reliably responds to "quit", and the signal causes\r
382 problems for you, you should either ignore it by calling\r
383 <tt>signal(SIGTERM, SIG_IGN)</tt> at the start of your program,\r
384 or disable it with the "feature" command.</p>\r
385 \r
386 <p>Second, xboard will send an interrupt signal (<tt>SIGINT</tt>) at\r
387 certain times when it believes the engine may not be listening to user\r
388 input (thinking or pondering).  WinBoard currently does this only when\r
389 the engine is running remotely using the -firstHost or -secondHost\r
390 feature, not when it is running locally.  You probably need to know\r
391 only enough about this grungy feature to keep it from getting in your\r
392 way.\r
393 </p>\r
394 \r
395 <p>\r
396 The <tt>SIGINT</tt>s are basically tailored to the needs of GNU Chess 4\r
397 on systems where its input polling code is broken or disabled.\r
398 Because they work in a rather peculiar way, it is recommended that you\r
399 either ignore <tt>SIGINT</tt> by having your engine call\r
400 <tt>signal(SIGINT, SIG_IGN)</tt>, or disable it with the "feature"\r
401 command.</p>\r
402 \r
403 <p>\r
404 Here are details for the curious.  If xboard needs to send a command\r
405 when it is the chess engine's move (such as before the "?" command), \r
406 it sends a <tt>SIGINT</tt> first.  If xboard needs to send commands when it is\r
407 not the chess engine's move, but the chess engine may be pondering\r
408 (thinking on its opponent's time) or analyzing (analysis or analyze\r
409 file mode), xboard sends a <tt>SIGINT</tt> before the first such command only.\r
410 Another <tt>SIGINT</tt> is not sent until another move is made, even if xboard\r
411 issues more commands.  This behavior is necessary for GNU Chess 4.  The\r
412 first <tt>SIGINT</tt> stops it from pondering until the next move, but on some\r
413 systems, GNU Chess 4 will die if it receives a <tt>SIGINT</tt> when not \r
414 actually thinking or pondering.\r
415 </p>\r
416 \r
417 <p>\r
418 There are two reasons why WinBoard does not send the Win32 equivalent\r
419 of <tt>SIGINT</tt> (which is called <tt>CTRL_C_EVENT</tt>) to local\r
420 engines.  First, the Win32 GNU Chess 4 port does not need it.  Second, I\r
421 could not find a way to get it to work.  Win32 seems to be designed\r
422 under the assumption that only console applications, not windowed\r
423 applications, would ever want to send a <tt>CTRL_C_EVENT</tt>.\r
424 </p>\r
425 \r
426 <h2><a name="8">8. Commands from xboard to the engine</a></h2>\r
427 \r
428 <p>\r
429 All commands from xboard to the engine end with a newline (\n), even\r
430 where that is not explicitly stated.  All your output to xboard must\r
431 be in complete lines; any form of prompt or partial line will cause\r
432 problems.\r
433 </p>\r
434 \r
435 <p>\r
436 At the beginning of each game, xboard sends an initialization string.\r
437 This is currently "new\nrandom\n" unless the user changes it with the\r
438 initString or secondInitString option.\r
439 </p>\r
440 \r
441 <p>\r
442 xboard normally reuses the same chess engine process for multiple\r
443 games.  At the end of a game, xboard will send the "force" command\r
444 (see below) to make sure your engine stops thinking about the current\r
445 position.  It will later send the initString again to start a new\r
446 game.  If your engine can't play multiple games, you can disable reuse\r
447 <span class="version1">\r
448 either with the "feature" command (beginning in protocol version\r
449 2; see below) or \r
450 </span>\r
451 with xboard's -xreuse (or -xreuse2) command line\r
452 option.  xboard will then ask the process to quit after each game and\r
453 start a new process for the next game.\r
454 </p>\r
455 \r
456 <dl>\r
457 <dt>xboard</dt>\r
458 <dd>This command will be sent once immediately after your engine\r
459 process is started.  You can use it to put your engine into "xboard\r
460 mode" if that is needed.  If your engine prints a prompt to ask for\r
461 user input, you must turn off the prompt and output a newline when the\r
462 "xboard" command comes in.\r
463 </dd>\r
464 \r
465 <dt class="version1">protover N</dt>\r
466 <dd class="version1">\r
467 <p>Beginning in protocol version 2 (in which N=2), this command will\r
468 be sent immediately after the "xboard" command.  If you receive some\r
469 other command immediately after "xboard" (such as "new"), you can\r
470 assume that protocol version 1 is in use.  The "protover" command is\r
471 the only new command that xboard always sends in version 2.  All other\r
472 new commands to the engine are sent only if the engine first enables\r
473 them with the "feature" command.  Protocol versions will always be\r
474 simple integers so that they can easily be compared.\r
475 </p>\r
476 \r
477 <p>Your engine should reply to the protover command by sending the\r
478 "feature" command (see below) with the list of non-default feature\r
479 settings that you require, if any.</p>\r
480 \r
481 <p>Your engine should never refuse to run due to receiving a higher\r
482 protocol version number than it is expecting!  New protocol versions\r
483 will always be compatible with older ones by default; the larger\r
484 version number is simply a hint that additional "feature" command\r
485 options added in later protocol versions may be accepted.\r
486 </p>\r
487 </dd>\r
488 \r
489 <dt class="version1">accepted</dt>\r
490 <dt class="version1">rejected</dt>\r
491 <dd class="version1">\r
492 These commands may be sent to your engine in reply to the "feature"\r
493 command; see its documentation below.\r
494 </dd>\r
495 \r
496 <dt>new</dt>\r
497 <dd>Reset the board to the standard chess starting position.  Set\r
498 White on move.  Leave force mode and set the engine to play Black.\r
499 Associate the engine's clock with Black and the opponent's clock with\r
500 White.  Reset clocks and time controls to the start of a new game.\r
501 Use wall clock for time measurement.\r
502 Stop clocks.  Do not ponder on this move, even if pondering is on.\r
503 Remove any search depth limit previously set by the sd command.\r
504 </dd>\r
505 \r
506 <dt>variant VARNAME</dt>\r
507 <dd>If the game is not standard chess, but a variant, this command is\r
508 sent after "new" and before the first move or "edit" command.  Currently\r
509 defined variant names are:\r
510 \r
511 <table>\r
512 <tr><td>wildcastle</td><td>Shuffle chess where king can castle from d file</td></tr>\r
513 <tr><td>nocastle</td><td>Shuffle chess with no castling at all</td></tr>\r
514 <tr><td>fischerandom</td><td>Fischer Random</td></tr>\r
515 <tr><td>bughouse</td><td>Bughouse, ICC/FICS rules</td></tr>\r
516 <tr><td>crazyhouse</td><td>Crazyhouse, ICC/FICS rules</td></tr>\r
517 <tr><td>losers</td><td>Win by losing all pieces or getting mated (ICC)</td></tr>\r
518 <tr><td>suicide</td><td>Win by losing all pieces including king,\r
519     or by having fewer pieces when one player has no legal moves (FICS)</td></tr>\r
520 <tr class="version1"><td>giveaway</td><td>Win by losing all pieces including king,\r
521     or by having no legal moves (ICC)</td></tr>\r
522 <tr><td>twokings</td><td>Weird ICC wild 9</td></tr>\r
523 <tr><td>kriegspiel</td><td>Kriegspiel (engines not supported)</td></tr>\r
524 <tr><td>atomic</td><td>Atomic</td></tr>\r
525 <tr><td>3check</td><td>Win by giving check 3 times</td></tr>\r
526 <tr class="version43"><td>xiangqi </td><td>Chinese Chess (9x10 board)</td></tr>\r
527 <tr class="version43"><td>shogi </td><td>Japanese Chess (9x9 bord)</td></tr>\r
528 <tr class="version43"><td>capablanca</td><td>Capablanca Chess (10x8 board, with Archbishop and Chancellor)</td></tr>\r
529 <tr class="version43"><td>gothic  </td><td>Gothic Chess (10x8 board, same with better opening setup)</td></tr>\r
530 <tr class="version43"><td>falcon  </td><td>Falcon Chess (10x8 board, with two Falcon pieces)</td></tr>\r
531 <tr class="version43"><td>shatranj  </td><td>ancient Arabic Chess, with Elephants and General in stead of B and Q</td></tr>\r
532 <tr class="version43"><td>courier  </td><td>Courier Chess (12x8 board, a medieval precursor of modern Chess</td></tr>\r
533 <tr class="version43"><td>knightmate  </td><td>King moves as Knight and vice versa</td></tr>\r
534 <tr class="version43"><td>berolina</td><td>    Pawns capture straight ahead, and move diagonally</td></tr>\r
535 <tr class="version43"><td>janus</td><td>    Janus Chess (10x8, with two Archbishops)</td></tr>\r
536 <tr class="version43"><td>caparandom  </td><td>shuffle variant like FRC (10x8 board)</td></tr>\r
537 <tr class="version43"><td>cylinder  </td><td>Pieces wrap around between side edges, like board is a cylinder</td></tr>\r
538 <tr class="version44"><td>super  </td><td>Superchess: a shuffle variant with 4 fairy pieces on 8x8 board</td></tr>\r
539 <tr class="version44"><td>great  </td><td>Great Shatranj: sliders are replaced by corresponding short-range pieces on a 10x8 board</td></tr>\r
540 <tr><td>unknown</td><td>Unknown variant (not supported)</td></tr>\r
541 </table>\r
542 \r
543 </dd>\r
544 \r
545 <dt>quit</dt>\r
546 <dd>The chess engine should immediately exit.  This command is used\r
547 when xboard is itself exiting, and also between games if the -xreuse\r
548 command line option is given (or -xreuse2 for the second engine).\r
549 See also <a href="#7">Signals</a> above.\r
550 </dd>\r
551 \r
552 <dt>random</dt>\r
553 <dd>This command is specific to GNU Chess 4.  You can either ignore it\r
554 completely (that is, treat it as a no-op) or implement it as GNU Chess\r
555 does.  The command toggles "random" mode (that is, it sets random =\r
556 !random).  In random mode, the engine adds a small random value to its\r
557 evaluation function to vary its play.  The "new" command sets random\r
558 mode off.\r
559 </dd>\r
560 \r
561 <dt>force</dt>\r
562 <dd>Set the engine to play neither color ("force mode").  Stop clocks.\r
563 The engine should check that moves received in force mode are legal\r
564 and made in the proper turn, but should not think, ponder, or make\r
565 moves of its own.\r
566 </dd>\r
567 \r
568 <dt>go</dt>\r
569 <dd>Leave force mode and set the engine to play the color that is on\r
570 move.  Associate the engine's clock with the color that is on move,\r
571 the opponent's clock with the color that is not on move.  Start the engine's\r
572 clock.  Start thinking and eventually make a move.\r
573 </dd>\r
574 \r
575 <dt class="version1">playother</dt>\r
576 <dd class="version1">\r
577 (This command is new in protocol version 2.  It is not\r
578 sent unless you enable it with the feature command.)\r
579 Leave force mode and set the engine to play the color that is <i>not</i> on\r
580 move.  Associate the opponent's clock with the color that is on move,\r
581 the engine's clock with the color that is not on move.  Start the opponent's\r
582 clock.  If pondering is enabled, the engine should begin pondering.\r
583 If the engine later receives a move, it should start thinking and eventually\r
584 reply.\r
585 </dd>\r
586 \r
587 <dt>white</dt>\r
588 <dd>\r
589 <p><span class="version1">\r
590 (This command is obsolete as of protocol version 2, but is still\r
591 sent in some situations to accommodate older engines unless you disable it \r
592 with the feature command.)\r
593 </span>\r
594 Set White on move.  Set the engine to play Black.  Stop clocks.\r
595 </p>\r
596 </dd>\r
597   \r
598 <dt>black </dt>\r
599 <dd>\r
600 <span class="version1">\r
601 (This command is obsolete as of protocol version 2, but is still\r
602 sent in some situations to accommodate older engines unless you disable it \r
603 with the feature command.)\r
604 </span>\r
605 Set Black on move.  Set the engine to play White.  Stop clocks.\r
606 </dd>\r
607 \r
608 <dt>level MPS BASE INC</dt>\r
609 <dd>Set time controls.  See the <a href="#11">Time Control</a> section below.\r
610 </dd>\r
611   \r
612 <dt>st TIME</dt>\r
613 <dd>Set time controls.  See the <a href="#11">Time Control</a> section\r
614 below. \r
615 </dd>\r
616 \r
617 <dt>sd DEPTH</dt>\r
618 <dd>\r
619 <p>The engine should limit its thinking to DEPTH ply.\r
620 <span class="version43">The commands "level" or "st" and "sd" can be used together in an orthogonal way.\r
621 If both are issued, the engine should observe both limitations:</span>\r
622 In the protocol, the "sd" command isn't a time control.  It doesn't\r
623 say that your engine has unlimited time but must search to exactly the\r
624 given depth.  It says that you should pay attention to the time\r
625 control as normal, but cut off the search at the specified depth even\r
626 if you have time to search deeper.  If you don't have time to search\r
627 to the specified depth, given your normal time management algorithm,\r
628 then you will want to stop sooner than the given depth.\r
629 </p><p>\r
630 The "new" command should set the search depth back to unlimited.  This\r
631 is already stated in the spec.  The "level" command should not affect\r
632 the search depth.  As it happens, xboard/WinBoard currently always\r
633 sends sd (if needed) right after level, but that isn't part of the\r
634 spec.</p>\r
635 </dd>\r
636 \r
637 <dt><span class="version43">nps NODE_RATE</span></dt>\r
638 <dd><span class="version43">The engine should not use wall-clock time to make its timing decisions,\r
639 but an own internal time measure based on the number of nodes it has searched\r
640 (and will report as "thinking output", see <a href="#10">section 10</a>),\r
641 converted to seconds through dividing by the given NODE_RATE.\r
642 Example: after receiving the commands "st 8" and "nps 10000",\r
643 the engine should never use more that 80,000 nodes in the search for any move.\r
644 In this mode, the engine should report user CPU time used (in its thinking output), \r
645 rather than wall-clock time.\r
646 This even holds if NODE_RATE is given as 0,\r
647 but in that case it should also use the user CPU time for its timing decisions.\r
648 The effect of an "nps" command should persist until the next "new" command.\r
649 </span>\r
650 </dd>\r
651 \r
652 <dt>time N</dt>\r
653 <dd>Set a clock that always belongs to the engine.  N is a number in\r
654   centiseconds (units of 1/100 second).  Even if the engine changes to\r
655   playing the opposite color, this clock remains with the engine.\r
656 </dd>\r
657 \r
658 <dt>otim N</dt>\r
659 \r
660 <dd><p>Set a clock that always belongs to the opponent.  N is a number in\r
661 centiseconds (units of 1/100 second).  Even if the opponent changes to\r
662 playing the opposite color, this clock remains with the opponent.\r
663 </p><p>\r
664 If needed for purposes of board display in force mode (where the\r
665 engine is not participating in the game) the time clock should be\r
666 associated with the last color that the engine was set to play, the\r
667 otim clock with the opposite color.\r
668 </p>\r
669 <p>\r
670 <span class="version43">This business of "clocks remaining with the engine" is apparently so ambiguous\r
671 that many engines implement it wrong.\r
672 The clocks in fact always remain with the color.\r
673 Which clock reading is relayed with "time", and which by "otim", is determined by which side the engine plays.\r
674 Note that the way the clocks operate and receive extra time (in accordance with the selected time control)\r
675 is not affected in any way by which moves are made by the engine, which by the opponent, and which were forced.\r
676 </span>\r
677 </p>\r
678 <p>\r
679 <span class="version1">\r
680 Beginning in protocol version 2, if you can't handle the time and\r
681 otim commands, you can use the "feature" command to disable them; see\r
682 below.  \r
683 </span>\r
684 The following techniques from older protocol versions also\r
685 work: You can ignore the time and otim commands (that is, treat them\r
686 as no-ops), or send back "Error (unknown command): time" the first\r
687 time you see "time".\r
688 </p></dd>\r
689 \r
690 <dt>MOVE</dt>\r
691 <dd>\r
692 <p>See below for the syntax of moves.  If the move is illegal, print\r
693 an error message; see the section "<a href="#9">Commands from the engine to\r
694 xboard</a>".  If the move is legal and in turn, make it.  If not in force\r
695 mode, stop the opponent's clock, start the engine's clock, start\r
696 thinking, and eventually make a move.\r
697 </p><p>\r
698 When xboard sends your engine a move, it normally sends coordinate\r
699 algebraic notation.  Examples:\r
700 </p>\r
701 <table>\r
702 <tr><td>Normal moves:</td><td>e2e4</td></tr>\r
703 <tr><td>Pawn promotion:</td><td>e7e8q</td></tr>\r
704 <tr><td>Castling:</td><td>e1g1, e1c1, e8g8, e8c8</td></tr>\r
705 <tr><td>Bughouse/crazyhouse drop:</td><td>P@h3</td></tr>\r
706 <tr><td>ICS Wild 0/1 castling:</td><td>d1f1, d1b1, d8f8, d8b8</td></tr>\r
707 <tr><td>FischerRandom castling:</td><td>O-O, O-O-O (oh, not zero)</td></tr>\r
708 </table>\r
709 \r
710 <p class="version43">\r
711 Note that on boards with more than 9 ranks, counting of the ranks starts at 0.\r
712 </p>\r
713 <p class="version1">\r
714 Beginning in protocol version 2, you can use the feature command\r
715 to select SAN (standard algebraic notation) instead; for example, e4,\r
716 Nf3, exd5, Bxf7+, Qxf7#, e8=Q, O-O, or P@h3.  Note that the last form,\r
717 P@h3, is a extension to the PGN standard's definition of SAN, which does\r
718 not support bughouse or crazyhouse.\r
719 </p>\r
720 \r
721 <p>\r
722 xboard doesn't reliably detect illegal moves, because it does not keep\r
723 track of castling unavailability due to king or rook moves, or en\r
724 passant availability.  If xboard sends an illegal move, send back an\r
725 error message so that xboard can retract it and inform the user; see\r
726 the section "<a href="#9">Commands from the engine to xboard</a>".\r
727 </p>\r
728 </dd>\r
729 <dt class="version1">usermove MOVE</dt>\r
730 <dd class="version1">\r
731 By default, moves are sent to the engine without a command name;\r
732 the notation is just sent as a line by itself.\r
733 Beginning in protocol version 2, you can use the feature command\r
734 to cause the command name "usermove" to be sent before the move.\r
735 Example: "usermove e2e4".\r
736 </dd>\r
737 \r
738 <dt>?</dt>\r
739 <dd><p>Move now.  If your engine is thinking, it should move immediately;\r
740   otherwise, the command should be ignored (treated as a no-op).  It\r
741   is permissible for your engine to always ignore the ? command.  The\r
742   only bad consequence is that xboard's Move Now menu command will do\r
743   nothing.\r
744 </p><p>\r
745 It is also permissible for your engine to move immediately if it gets\r
746 any command while thinking, as long as it processes the command right\r
747 after moving, but it's preferable if you don't do this.  For example,\r
748 xboard may send post, nopost, easy, hard, force, quit,\r
749 <span class="version1">\r
750 or other commands\r
751 </span>\r
752 while the engine is on move.\r
753 </p>\r
754 </dd>\r
755 \r
756 <dt class="version1">ping N</dt>\r
757 <dd class="version1">\r
758 <p>In this command, N is a decimal number.  When you receive the command,\r
759 reply by sending the string <strong>pong N</strong>, where N is the\r
760 same number you received.  Important: You must not reply to a "ping"\r
761 command until you have finished executing all commands that you\r
762 received before it.  Pondering does not count; if you receive a ping\r
763 while pondering, you should reply immediately and continue pondering.\r
764 Because of the way xboard uses the ping command, if you implement the\r
765 other commands in this protocol, you should never see a "ping" command\r
766 when it is your move; however, if you do, you must not send the "pong"\r
767 reply to xboard until after you send your move.  For example, xboard\r
768 may send "?" immediately followed by "ping".  If you implement the "?"\r
769 command, you will have moved by the time you see the subsequent ping\r
770 command.  Similarly, xboard may send a sequence like "force", "new",\r
771 "ping".  You must not send the pong response until after you have\r
772 finished executing the "new" command and are ready for the new game to\r
773 start.\r
774 </p>\r
775 <p>\r
776 The ping command is new in protocol version 2 and will not be sent\r
777 unless you enable it with the "feature" command.  Its purpose is to\r
778 allow several race conditions that could occur in previous versions of\r
779 the protocol to be fixed, so it is highly recommended that you\r
780 implement it.  It is especially important in simple engines that do\r
781 not ponder and do not poll for input while thinking, but it is needed in all\r
782 engines.  \r
783 </p>\r
784 </dd>\r
785 \r
786 <dt>draw</dt>\r
787 <dd>The engine's opponent offers the engine a draw.  To accept the\r
788 draw, send "offer draw".  To decline, ignore the offer (that is, send\r
789 nothing).  If you're playing on ICS, it's possible for the draw offer\r
790 to have been withdrawn by the time you accept it, so don't assume the\r
791 game is over because you accept a draw offer.  Continue playing until\r
792 xboard tells you the game is over.  See also "offer draw" below.\r
793 </dd>\r
794 \r
795 <dt>result RESULT {COMMENT}</dt>\r
796 <dd>After the end of each game, xboard will send you a result command.\r
797 You can use this command to trigger learning.  RESULT is either 1-0,\r
798 0-1, 1/2-1/2, or *, indicating whether white won, black won, the game\r
799 was a draw, or the game was unfinished.  The COMMENT string is purely\r
800 a human-readable comment; its content is unspecified and subject to\r
801 change.  In ICS mode, it is passed through from ICS uninterpreted.\r
802 Example: <pre>result 1-0 {White mates}</pre>\r
803 <p>\r
804 Here are some notes on interpreting the "result" command.  Some apply\r
805 only to playing on ICS ("Zippy" mode).\r
806 </p>\r
807 \r
808 <p>\r
809 If you won but did not just play a mate, your opponent must have\r
810 resigned or forfeited.  If you lost but were not just mated, you\r
811 probably forfeited on time, or perhaps the operator resigned manually.\r
812 If there was a draw for some nonobvious reason, perhaps your opponent\r
813 called your flag when he had insufficient mating material (or vice\r
814 versa), or perhaps the operator agreed to a draw manually.\r
815 </p>\r
816 \r
817 <p>\r
818 You will get a result command even if you already know the game ended\r
819 -- for example, after you just checkmated your opponent.  In fact, if\r
820 you send the "RESULT {COMMENT}" command (discussed below), you will\r
821 simply get the same thing fed back to you with "result" tacked in\r
822 front.  You might not always get a "result *" command, however.  In\r
823 particular, you won't get one in local chess engine mode when the user\r
824 stops playing by selecting Reset, Edit Game, Exit or the like.\r
825 </p>\r
826 </dd>\r
827 \r
828 <dt><span class="version1">setboard FEN</span></dt>\r
829 <dd>\r
830 <p><span class="version1">\r
831 The setboard command is the new way to set up positions, beginning\r
832 in protocol version 2.  It is not used unless it has been selected\r
833 with the feature command.  Here FEN is a position in Forsythe-Edwards\r
834 Notation, as defined in the PGN standard.</span>\r
835 <span class="version43">Note that this PGN standard referred to here\r
836 only applies to normal Chess;\r
837 Obviously in variants that cannot be described by a FEN for normal Chess,\r
838 e.g. because the board is not 8x8, other pieces then PNBRQK participate, \r
839 there are holdings that need to be specified, etc., \r
840 xboard will use a FEN format that is standard or suitable for that varant.\r
841 In particular, in FRC or CRC, WinBoard will use Shredder-FEN or X-FEN standard,\r
842 i.e. it can use the rook-file indicator letter to represent a castling right \r
843 (like HAha) whenever it wants, but if it uses KQkq, this will always refer \r
844 to the outermost rook on the given side.</span>\r
845 </p>\r
846 \r
847 <p class="version1">\r
848 <em>Illegal positions:</em> Note that either setboard or edit can\r
849 be used to send an illegal position to the engine.  The user can\r
850 create any position with xboard's Edit Position command (even, say,\r
851 an empty board, or a board with 64 white kings and no black ones).\r
852 If your engine receives a position that it considers illegal, \r
853 I suggest that you send the response "tellusererror Illegal position",\r
854 and then respond to any attempted move with "Illegal move" until\r
855 the next new, edit, or setboard command.\r
856 </p>\r
857 </dd>\r
858 \r
859 <dt>edit</dt>\r
860 <dd>\r
861 <p><span class="version1">\r
862 The edit command is the old way to set up positions.  For compatibility\r
863 with old engines, it is still used by default, but new engines may prefer\r
864 to use the feature command (see below) to cause xboard to use setboard instead.\r
865 </span>\r
866 The edit command puts the chess engine into a special mode, where\r
867 it accepts the following subcommands:</p>\r
868 <table>\r
869 <tr><td>c</td><td>change current piece color, initially white</td></tr>\r
870 <tr><td>Pa4 (for example)</td><td>place pawn of current color on a4</td></tr>\r
871 <tr><td>xa4 (for example)</td><td>empty the square a4 (not used by xboard)</td></tr>\r
872 <tr><td>#</td><td>clear board</td></tr>\r
873 <tr><td>.</td><td>leave edit mode</td></tr>\r
874 </table>\r
875 <p class="version1">\r
876 See the Idioms section below for additional subcommands used in\r
877 ChessBase's implementation of the protocol.\r
878 </p>\r
879 \r
880 <p>The edit command does not change the side to move.  To set up a\r
881 black-on-move position, xboard uses the following command sequence:\r
882 </p>\r
883 <pre>\r
884     new\r
885     force\r
886     a2a3\r
887     edit\r
888     &lt;edit commands&gt;\r
889     .\r
890 </pre>\r
891 \r
892 <p>\r
893 This sequence is used to avoid the "black" command, which is now\r
894 considered obsolete and which many engines never did implement as \r
895 specified in this document.\r
896 </p>\r
897 \r
898 <p>\r
899 After an edit command is complete, if a king and a rook are on their\r
900 home squares, castling is assumed to be available to them.  En passant\r
901 capture is assumed to be illegal on the current move regardless of the\r
902 positions of the pawns.  The clock for the 50 move rule starts at\r
903 zero, and for purposes of the draw by repetition rule, no prior\r
904 positions are deemed to have occurred.\r
905 <span class="version43">\r
906 In FRC or CRC, any rook and king put on the back rank should be considered to\r
907 have castling rights, even if it later becomes apparent that they cannot be both in the\r
908 initial position, because the position just set up is asymmetric.\r
909 It is upto WinBoard to find work-around in cases where this is not desired,\r
910 similar to the "black kludge" shown above, by setting up an earlier position,\r
911 and then do a move to destroy castling rights or create e.p. rights.\r
912 (Don't bet your life on it...)\r
913 </span>\r
914 </p>\r
915 </dd>\r
916 \r
917 <dt>hint</dt>\r
918 <dd>If the user asks for a hint, xboard sends your engine the command\r
919 "hint".  Your engine should respond with "Hint: xxx", where xxx is a\r
920 suggested move.  If there is no move to suggest, you can ignore the\r
921 hint command (that is, treat it as a no-op).\r
922 </dd>\r
923 \r
924 <dt>bk</dt>\r
925 <dd>If the user selects "Book" from the xboard menu, xboard will send\r
926 your engine the command "bk".  You can send any text you like as the\r
927 response, as long as each line begins with a blank space or tab (\t)\r
928 character, and you send an empty line at the end.  The text pops up in\r
929 a modal information dialog.\r
930 </dd>\r
931 \r
932 <dt>undo</dt>\r
933 <dd>If the user asks to back up one move, xboard will send you the\r
934 "undo" command.  xboard will not send this command without putting you\r
935 in "force" mode first, so you don't have to worry about what should\r
936 happen if the user asks to undo a move your engine made.  (GNU Chess 4\r
937 actually switches to playing the opposite color in this case.)\r
938 </dd>\r
939 \r
940 <dt>remove</dt>\r
941 <dd>If the user asks to retract a move, xboard will send you the\r
942 "remove" command.  It sends this command only when the user is on\r
943 move.  Your engine should undo the last two moves (one for each\r
944 player) and continue playing the same color.\r
945 </dd>\r
946 \r
947 <dt>hard</dt>\r
948 <dd>Turn on pondering (thinking on the opponent's time, also known as\r
949 "permanent brain").  xboard will not make any assumption about what\r
950 your default is for pondering or whether "new" affects this setting.\r
951 </dd>\r
952 \r
953 <dt>easy</dt>\r
954 <dd>Turn off pondering.</dd>\r
955   \r
956 <dt>post</dt>\r
957 <dd>Turn on thinking/pondering output.  \r
958 See <a href="#10">Thinking Output</a> section.</dd>\r
959 \r
960 <dt>nopost</dt>\r
961 <dd>Turn off thinking/pondering output.</dd>\r
962   \r
963 <dt>analyze</dt>\r
964 <dd>Enter analyze mode.  See <a href="#12">Analyze Mode</a> section.</dd>\r
965 \r
966 <dt>name X </dt>\r
967 <dd>This command informs the engine of its\r
968 opponent's name.  When the engine is playing on a chess server, xboard\r
969 obtains the opponent's name from the server. \r
970 <span class="version1">\r
971 When the engine is\r
972 playing locally against a human user, xboard obtains the user's login\r
973 name from the local operating system.  When the engine is playing\r
974 locally against another engine, xboard uses either the other engine's\r
975 filename or the name that the other engine supplied in the myname\r
976 option to the feature command.  By default, xboard uses the name\r
977 command only when the engine is playing on a chess server.  Beginning\r
978 in protocol version 2, you can change this with the name option to the\r
979 feature command; see below.\r
980 </span>\r
981 </dd>\r
982 \r
983 <dt>rating</dt>\r
984 <dd>In ICS mode, xboard obtains the ICS opponent's rating from the\r
985 "Creating:" message that appears before each game.  (This message may\r
986 not appear on servers using outdated versions of the FICS code.)  In\r
987 Zippy mode, it sends these ratings on to the chess engine using the\r
988 "rating" command.  The chess engine's own rating comes first, and if\r
989 either opponent is not rated, his rating is given as 0.  \r
990 <span class="version1">\r
991 In the future this command may also be used in other modes, if ratings\r
992 are known.\r
993 </span>\r
994 Example: <pre>rating 2600 1500</pre>\r
995 </dd>\r
996 \r
997 <dt><span class="version1">ics HOSTNAME</span></dt>\r
998 <dd class="version1">\r
999 If HOSTNAME is "-", the engine is playing against a local\r
1000 opponent; otherwise, the engine is playing on an Internet Chess Server\r
1001 (ICS) with the given hostname.  This command is new in protocol\r
1002 version 2 and is not sent unless the engine has enabled it with\r
1003 the "feature" command.  Example: "ics freechess.org"\r
1004 </dd>\r
1005 \r
1006 <dt>computer</dt>\r
1007 <dd>The opponent is also a computer chess engine.  Some engines alter\r
1008 their playing style when they receive this command.\r
1009 </dd>\r
1010 \r
1011 <dt class="version1">pause</dt>\r
1012 <dt class="version1">resume</dt>\r
1013 <dd class="version1">(These commands are new in protocol\r
1014 version 2 and will not be sent unless feature pause=1 is set.  At\r
1015 this writing, xboard actually does not use the commands at all, but it\r
1016 or other interfaces may use them in the future.)\r
1017 The "pause" command puts the engine into a special state where it\r
1018 does not think, ponder, or otherwise consume significant CPU time.\r
1019 The current thinking or pondering (if any) is suspended and both\r
1020 player's clocks are stopped.  The only command that the interface may\r
1021 send to the engine while it is in the paused state is "resume".  The\r
1022 paused thinking or pondering (if any) resumes from exactly where it\r
1023 left off, and the clock of the player on move resumes running from\r
1024 where it stopped.\r
1025 </dd>\r
1026 \r
1027 <dt class="version44">memory N</dt>\r
1028 <dd class="version44">\r
1029 This command informs the engine on how much memory it is allowed to use maximally, in MegaBytes.\r
1030 On receipt of this command, the engine should adapt the size of its hash tables accordingly.\r
1031 This command does only fix the total memory use,\r
1032 the engine has to decide for itself \r
1033 (or be configured by the user by other means) \r
1034 how to divide up the available memory between the various tables it wants to use \r
1035 (e.g. main hash, pawn hash, tablebase cache, bitbases).\r
1036 This command will only be sent to engines that have requested it through the memory feature,\r
1037 and only at the start of a game,\r
1038 as the first of the commands to relay engine option settings just before each "new" command.\r
1039 </dd>\r
1040 \r
1041 <dt class="version44">cores N</dt>\r
1042 <dd class="version44">\r
1043 This command informs the engine on how many CPU cores it is allowed to use maximally.\r
1044 This could be interpreted as the number of search threads for SMP engines. \r
1045 (Threads that do not consume significant amounts of CPU time, like I/O threads, need not be included in the count.)\r
1046 This command will only be sent to engines that have requested it through the smp feature.\r
1047 The engine should be able to respond to the "cores" command any time during a game,\r
1048 but it is allowed to finish a search in progress before procesing the command.\r
1049 (Obeying the command should take priority over finishing a ponder search, though.)\r
1050 In any case it will be sent at the start of every game\r
1051 as the last command to relay engine option settings before the "new" command.\r
1052 </dd>\r
1053 \r
1054 <dt class="version44">egtpath TYPE PATH</dt>\r
1055 <dd class="version44">\r
1056 This command informs the engine in which directory (given by the PATH argument)\r
1057 it can find end-game tables of the specified TYPE.\r
1058 The TYPE argument can be any character string which does not contain spaces.\r
1059 Currently <strong>nalimov</strong> and <strong>scorpio</strong> are defined types, \r
1060 for Nalimov tablebases and Scorpio bitbases, respectively,\r
1061 but future developers of other formats are free to define their own format names.\r
1062 The GUI simply matches the TYPE names the engine says it supports \r
1063 with those that the user supplied when configuring xboard.\r
1064 For every match, it sends a separate "y" command.\r
1065 The PATH argument would normally (for Nalimov) be the pathname of the directory the EGT files are in,\r
1066 but could also be the name of a file, or in fact anything the particular EGT type requires.\r
1067 It is upto the developer of the EGT format to specify the syntax of this parameter.\r
1068 This command will only be sent to engines that have told the GUI they support EGTs of the given TYPE\r
1069 through the egt feature.\r
1070 It will be sent at the start of each game, before the "new" command.\r
1071 </dd>\r
1072 \r
1073 <dt class="version44">option NAME[=VALUE]</dt>\r
1074 <dd class="version44">\r
1075 This command changes the setting of the option NAME defined by the engine \r
1076 (through an earlier feature command)\r
1077 to the given VALUE.\r
1078 XBoard will in general have no idea what the option means,\r
1079 and will send the command only when a user changes the value of this option through a menu,\r
1080 or at startup of the engine \r
1081 (before the first 'cores' command or, if that is not sent, the first 'new' command)\r
1082 in reaction to command-line options.\r
1083 The NAME echoes back to the engine the string that was identified as an option NAME\r
1084 in the feature command defining the option.\r
1085 The VALUE is of the type (numeric or text or absent) that was implied by the option type\r
1086 specified in this feature command,\r
1087 i.e. with 'spin' and 'check' options VALUE will be a decimal integer (in the latter case 0 or 1),\r
1088 with 'combo' and 'string' options VALUE will be a text string,\r
1089 and with 'button' and 'save' options no VALUE will be sent at all.\r
1090 </dd>\r
1091 \r
1092 <dt class="version47">exclude MOVE</dt>\r
1093 <dt class="version47">include MOVE</dt>\r
1094 <dt class="version47">exclude all</dt>\r
1095 <dt class="version47">include all</dt>\r
1096 <dd class="version47">\r
1097 These commands change the set of moves that the engine should consider in the root node of its search,\r
1098 by removing or adding the mentioned MOVE from this set.\r
1099 After reaching a new position, (e.g. through a usermove, undo, new or setboard command),\r
1100 or after receiving "include all",\r
1101 this set should always be reset to all legal moves from that position.\r
1102 If the set of moves changes during a search, \r
1103 the engine could start a new search from scratch, or it can try to be smart, \r
1104 and continue the current search with the new set of moves\r
1105 (e.g. after exclusion of a move that has not been searched yet in the current iteration).\r
1106 After "exclude all", the engine would have no legal moves in the root,\r
1107 which logically should make it behave as if it is (stale)mated,\r
1108 but it is allowed to defer any effects of this command on a search in progress\r
1109 to when the set gets non-empty again through addition of a move.\r
1110 These commands will only be sent to engines that have requested such through the exclude feature.\r
1111 </dd>\r
1112 \r
1113 <dt class="version47">setscore SCORE DEPTH</dt>\r
1114 <dd class="version47">\r
1115 This command instructs the engine to treat future search requests on the current position\r
1116 (also when it is encountered inside a larger search tree)\r
1117 upto the given DEPTH as if these result is SCORE centi-Pawn in favor of the side that has the move in this position.\r
1118 It is entirely up to the engine to decide when the effect of this option should expire.\r
1119 (E.g. it could last upto the next "new" or "quit" command,\r
1120 or even into future sessions until the user explicitly clears it through an engine-defined option.)\r
1121 This command will only be sent to engines that have requested it through the setscore feature.\r
1122 </dd>\r
1123 </dl>\r
1124 \r
1125 <h3>Bughouse commands:</h3>\r
1126 \r
1127 <p>\r
1128 xboard now supports bughouse engines when in Zippy mode.  See\r
1129 <a href="http://www.tim-mann.org/xboard/zippy.README"\r
1130 >zippy.README</a> for information on Zippy mode and how to turn on the\r
1131 bughouse support.  The bughouse move format is given above.  xboard\r
1132 sends the following additional commands to the engine when in bughouse\r
1133 mode.  \r
1134 Commands to inform your engine of the partner's game state may\r
1135 be added in the future.\r
1136 </p>\r
1137 \r
1138 <dl>\r
1139 <dt>partner &lt;player&gt;</dt>\r
1140 <dd>&lt;player&gt; is now your partner for future games.  Example: <pre>partner mann</pre>\r
1141 </dd>\r
1142 \r
1143 <dt>partner</dt>\r
1144 <dd>Meaning: You no longer have a partner.\r
1145 </dd>\r
1146 \r
1147 <dt>ptell &lt;text&gt;</dt>\r
1148 <dd>Your partner told you &lt;text&gt;, either with a ptell or an ordinary tell.  \r
1149 </dd>\r
1150 \r
1151 <dt>holding [&lt;white&gt;] [&lt;black&gt;]</dt>\r
1152 <dd>White currently holds &lt;white&gt;; black currently holds &lt;black&gt;.\r
1153   Example: <pre>holding [PPPRQ] []</pre></dd>\r
1154 \r
1155 <dt>holding [&lt;white&gt;] [&lt;black&gt;] &lt;color&gt;&lt;piece&gt;</dt>\r
1156 <dd>White currently holds &lt;white&gt;; black currently holds &lt;black&gt;, after\r
1157   &lt;color&gt; acquired &lt;piece&gt;.   Example: <pre>holding [PPPRQ] [R] BR</pre></dd>\r
1158 </dl>\r
1159 \r
1160 <h2><a name="9">9. Commands from the engine to xboard</a></h2>\r
1161 \r
1162 <p class="version1">\r
1163 In general, an engine should not send any output to xboard that is not\r
1164 described in this document.  As the protocol is extended, newer\r
1165 versions of xboard may recognize additional strings as commands that\r
1166 were previously not assigned a meaning.\r
1167 </p>\r
1168 \r
1169 <dl>\r
1170 \r
1171 <dt class="version1"> feature FEATURE1=VALUE1 FEATURE2=VALUE2 ... </dt>\r
1172 <dd class="version1">\r
1173 <p>Beginning with version 2, the protocol includes the "feature"\r
1174 command, which lets your engine control certain optional protocol\r
1175 features.  Feature settings are written as FEATURE=VALUE, where\r
1176 FEATURE is a name from the list below and VALUE is the value to be\r
1177 assigned.  Features can take string, integer, or boolean values; the\r
1178 type of value is listed for each feature.  String values are written\r
1179 in double quotes (for example, <tt>feature myname="Miracle Chess\r
1180 0.9"</tt>), integers are written in decimal, and boolean values are\r
1181 written as 0 for false, 1 for true.  Any number of features can be set\r
1182 in one feature command, or multiple feature commands can be given.</p>\r
1183 \r
1184 <p>\r
1185 Your engine should send one or more feature commands immediately after\r
1186 receiving the "protover" command, since xboard needs to know the\r
1187 values of some features before sending further commands to the engine.\r
1188 Because engines that predate protocol version 2 do not send "feature",\r
1189 xboard uses a timeout mechanism: when it first starts your engine, it\r
1190 sends "xboard" and "protover N", then listens for feature commands for\r
1191 two seconds before sending any other commands.  To end this timeout\r
1192 and avoid the wait, set the feature "done=1" at the end of your last\r
1193 feature command.  To increase the timeout, if needed, set the feature\r
1194 "done=0" before your first feature command and "done=1" at the end.\r
1195 If needed, it is okay for your engine to set done=0 soon as it starts,\r
1196 even before it receives the xboard and protover commands.  This can be\r
1197 useful if your engine takes a long time to initialize itself.  It\r
1198 should be harmless even if you are talking to a (version 1) user\r
1199 interface that does not understand the "feature" command, since such\r
1200 interfaces generally ignore commands from the engine that they do not\r
1201 understand.\r
1202 </p>\r
1203 \r
1204 <p>\r
1205 The feature command is designed to let the protocol change without\r
1206 breaking engines that were written for older protocol versions.  When\r
1207 a new feature is added to the protocol, its default value is always\r
1208 chosen to be compatible with older versions of the protocol that did\r
1209 not have the feature.  Any feature that your engine does not set in a\r
1210 "feature" command retains its default value, so as the protocol\r
1211 changes, you do not have to change your engine to keep up with it\r
1212 unless you want to take advantage of a new feature.  Because some\r
1213 features are improvements to the protocol, while others are meant to\r
1214 cater to engines that do not implement all the protocol features, the\r
1215 recommended setting for a feature is not always the same as the\r
1216 default setting.  The listing below gives both default and recommended\r
1217 settings for most features.\r
1218 </p>\r
1219 \r
1220 <p>\r
1221 You may want to code your engine so as to be able to work with\r
1222 multiple versions of the engine protocol.  Protocol version 1 does not\r
1223 send the protover command and does not implement the feature command;\r
1224 if you send a feature command in protocol version 1, it will have no\r
1225 effect and there will be no response.  In protocol version 2 or later,\r
1226 each feature F that you set generates the response "accepted F" if the\r
1227 feature is implemented, or "rejected F" if it is not.  Thus an engine\r
1228 author can request any feature without having to keep track of which\r
1229 protocol version it was introduced in; you need only check whether the\r
1230 feature is accepted or rejected.  This mechanism also makes it\r
1231 possible for a user interface author to implement a subset of a\r
1232 protocol version by rejecting some features that are defined in that\r
1233 version; however, you should realize that engine authors are likely to\r
1234 code for xboard and may not be prepared to have a feature that they\r
1235 depend on be rejected.\r
1236 <span class="version44">If the GUI rejects an option feature because of the\r
1237 syntax of the value, it should print the value string with the\r
1238 "rejected" command, e.g. "rejected option nonsense" in response\r
1239 to receiving feature option="nonsense".</span>\r
1240 </p>\r
1241 \r
1242 <p>\r
1243 Here are the features that are currently defined.\r
1244 </p>\r
1245 \r
1246 <dl>\r
1247 <dt class="version1">ping (boolean, default 0, recommended 1)</dt>\r
1248 <dd class="version1">\r
1249 If ping=1, xboard may use the protocol's new "ping" command;\r
1250 if ping=0, xboard will not use the command.\r
1251 </dd>\r
1252 \r
1253 <dt class="version1">setboard (boolean, default 0, recommended 1)</dt>\r
1254 <dd class="version1">\r
1255 If setboard=1, xboard will use the protocol's new "setboard" command\r
1256 to set up positions; if setboard=0, it will use the older "edit" command.\r
1257 </dd>\r
1258 \r
1259 <dt class="version1">playother (boolean, default 0, recommended 1)</dt>\r
1260 <dd class="version1">\r
1261 If playother=1, xboard will use the protocol's new "playother" command\r
1262 when appropriate; if playother=0, it will not use the command.\r
1263 </dd>\r
1264 \r
1265 <dt class="version1">san (boolean, default 0)</dt>\r
1266 <dd class="version1">\r
1267 If san=1, xboard will send moves to the engine in standard algebraic\r
1268 notation (SAN); for example, Nf3.  If san=0, xboard will send moves in\r
1269 coordinate notation; for example, g1f3.  See MOVE in \r
1270 <a href="#8">section 8</a> above for more details of both kinds of notation.\r
1271 </dd>\r
1272 \r
1273 <dt class="version1">usermove (boolean, default 0)</dt>\r
1274 <dd class="version1">\r
1275 If usermove=1, xboard will send moves to the engine with the\r
1276 command "usermove MOVE"; if usermove=0, xboard will send just the move,\r
1277 with no command name.\r
1278 </dd>\r
1279 \r
1280 <dt class="version1">time (boolean, default 1, recommended 1)</dt>\r
1281 <dd class="version1">\r
1282 If time=1, xboard will send the "time" and "otim" commands to\r
1283 update the engine's clocks; if time=0, it will not.\r
1284 </dd>\r
1285 \r
1286 <dt class="version1">draw (boolean, default 1, recommended 1)</dt>\r
1287 <dd class="version1">\r
1288 If draw=1, xboard will send the "draw" command if the engine's opponent\r
1289 offers a draw; if draw=0, xboard will not inform the engine about\r
1290 draw offers.  Note that if draw=1, you may receive a draw offer while you\r
1291 are on move; if this will cause you to move immediately, you should set\r
1292 draw=0.\r
1293 </dd>\r
1294 \r
1295 <dt class="version1">sigint (boolean, default 1)</dt>\r
1296 <dd class="version1">\r
1297 If sigint=1, xboard may send SIGINT (the interrupt signal) to\r
1298 the engine as <a href="#7">section 7</a> above; if sigint=0, it will\r
1299 not.\r
1300 </dd>\r
1301 \r
1302 <dt class="version1">sigterm (boolean, default 1)</dt>\r
1303 <dd class="version1">\r
1304 If sigterm=1, xboard may send SIGTERM (the termination signal) to\r
1305 the engine as <a href="#7">section 7</a> above; if sigterm=0, it will\r
1306 not.\r
1307 </dd>\r
1308 \r
1309 <dt class="version1">reuse (boolean, default 1, recommended 1) </dt>\r
1310 <dd class="version1">\r
1311 If reuse=1, xboard may reuse your engine for multiple games.  If\r
1312 reuse=0 (or if the user has set the -xreuse option on xboard's command\r
1313 line), xboard will kill the engine process after every game and start\r
1314 a fresh process for the next game.\r
1315 </dd>\r
1316 \r
1317 <dt class="version1">analyze (boolean, default 1, recommended 1)</dt>\r
1318 <dd class="version1">\r
1319 If analyze=0, xboard will not try to use the "analyze" command; it\r
1320 will pop up an error message if the user asks for analysis mode.  If\r
1321 analyze=1, xboard will try to use the command if the user asks for\r
1322 analysis mode.\r
1323 </dd>\r
1324 \r
1325 <dt class="version1">myname (string, default determined from engine filename)</dt>\r
1326 <dd class="version1">\r
1327 This feature lets you set the name that xboard will use for your\r
1328 engine in window banners, in the PGN tags of saved game files, and when\r
1329 sending the "name" command to another engine.\r
1330 </dd>\r
1331 \r
1332 <dt class="version1">variants (string, see text below)</dt>\r
1333 <dd><span class="version1">\r
1334 This feature indicates which chess variants your engine accepts.\r
1335 It should be a comma-separated list of variant names.  See the table\r
1336 under the "variant" command in <a href="#8">section 8</a> above.  If\r
1337 you do not set this feature, xboard will assume by default that your\r
1338 engine supports all variants.  (However, the -zippyVariants\r
1339 command-line option still limits which variants will be accepted in\r
1340 Zippy mode.)  It is recommended that you set this feature to the\r
1341 correct value for your engine (just "normal" in most cases) rather\r
1342 than leaving the default in place, so that the user will get an\r
1343 appropriate error message if he tries to play a variant that your\r
1344 engine does not support.</span>\r
1345 <br />\r
1346 <span class="version43">If your engine can play variants on a deviating board size,\r
1347 like capablanca on an 8x8 board, or capablanca crazyhouse,\r
1348 it can list them amongst the variants with a prefix spcifying board size plus\r
1349 holdings size, like 8x8+0_capablanca or 10x8+7_capablanca.\r
1350 If it is capable of playing any variant with an arbitrary board size,\r
1351 it should list "boardsize" as one of the variants.\r
1352 If there is a maximum to the board size, this can be prefixed,\r
1353 e.g. "12x10+0_boardsize".\r
1354 </span>\r
1355 </dd>\r
1356 \r
1357 <dt class="version1">colors (boolean, default 1, recommended 0) </dt>\r
1358 <dd><span class="version1">\r
1359 If colors=1, xboard uses the obsolete "white" and "black"\r
1360 commands in a stylized way that works with most older chess engines\r
1361 that require the commands.  See the "<a href="#13">Idioms</a>" section\r
1362 below for details.  If colors=0, xboard does not use the "white" and\r
1363 "black" commands at all.\r
1364 </span>\r
1365 </dd>\r
1366 \r
1367 <dt class="version1">ics (boolean, default 0)</dt>\r
1368 <dd class="version1">\r
1369 If ics=1, xboard will use the protocol's new "ics" command\r
1370 to inform the engine of whether or not it is playing on a chess server;\r
1371 if ics=0, it will not.\r
1372 </dd>\r
1373 \r
1374 <dt class="version1">name (boolean, see text below)</dt>\r
1375 <dd class="version1">\r
1376 If name=1, xboard will use the protocol's "name" command\r
1377 to inform the engine of the opponent's name; if name=0, it will not.\r
1378 By default, name=1 if the engine is playing on a chess server; name=0 if not.\r
1379 </dd>\r
1380 \r
1381 <dt class="version1">pause (boolean, default 0)</dt>\r
1382 <dd class="version1">\r
1383 If pause=1, xboard may use the protocol's new "pause" command;\r
1384 if pause=0, xboard assumes that the engine does not support this command.\r
1385 </dd>\r
1386 \r
1387 <dt class="version43">nps (boolean, default ?)</dt>\r
1388 <dd class="version43">\r
1389 If nps=1, it means the engine supports the nps command.\r
1390 If nps=0, it means the engine does not support it, and WinBoard should refrain from sending it.\r
1391 Default is that WinBoard sends it, in an attempt to try out if the engine understand it.\r
1392 The engine should properly respond with "Error (unkown command): nps" if it does not implement it,\r
1393 (as any protocol version pre-scribes),\r
1394 or WinBoard might assume that the engine did understand the command. \r
1395 In that case the use of different time standards that ensues could lead to time forfeits for the engine.\r
1396 </dd>\r
1397 \r
1398 <dt class="version43">debug (boolean, default 0)</dt>\r
1399 <dd class="version43">\r
1400 If debug=1, it means the engine wants to send debug output prefixed by '#',\r
1401 which WinBoard should ignore, except for including it in the winboard.debug file.\r
1402 As this feature is added to protocol 2 ony late,\r
1403 so that not all protocol-2 supporting versions of WinBoard might implement it,\r
1404 it is important that engines check if WinBoard accepts the feature.\r
1405 If the feature is rejected,\r
1406 engines must refrain from sending the debug output,\r
1407 or do so at their own risk.\r
1408 </dd>\r
1409 \r
1410 <dt class="version44">memory (boolean, default 0)</dt>\r
1411 <dd class="version44">\r
1412 If memory=1, the size of the total amount of memory available for the memory-consuming tables of the engine \r
1413 (e.g. hash, EGTB cache)\r
1414 will be set by the GUI through the "memory" command.\r
1415 </dd>\r
1416 \r
1417 <dt class="version44">smp (boolean, default 0)</dt>\r
1418 <dd class="version44">\r
1419 If smp=1, the GUI will send the "cores" command to the engine to inform it how many CPU cores it can use.\r
1420 Note that sending smp=1 does not imply the engine can use more than one CPU;\r
1421 just that it wants to receive the "cores" command.\r
1422 </dd>\r
1423 \r
1424 <dt class="version44">egt (string, see text below)</dt>\r
1425 <dd class="version44">\r
1426 This feature indicates which end-game table formats the engine supports.\r
1427 It should be a comma-separated list of format names.\r
1428 See under the "egtpath" command in <a href="#8">section 8</a> above.\r
1429 If you do not set this feature, xboard will assume the engine does not support end-game tables,\r
1430 and will not send any "egtpath" commands to inform the engine about their whereabouts.\r
1431 </dd>\r
1432 \r
1433 <dt class="version44">option (string, see text below)</dt>\r
1434 <dd><span class="version44">\r
1435 This feature is used by the engine to define an option command to appear in a GUI menu,\r
1436 so that the user can change the corresponding setting of the engine through the GUI interactively.\r
1437 The string describes the option by defining a name, type, current value and (sometimes) the acceptable value range.\r
1438 Unlike other features, option features are accumulated by the GUI, \r
1439 and the GUI must be able to add a new option to the list at any time,\r
1440 even after having received feature done=1.\r
1441 There are ten different options types, each requiring a slighly different syntax of the defining string:\r
1442 <br />\r
1443 feature option="NAME -button"\r
1444 <br />\r
1445 feature option="NAME -save"\r
1446 <br />\r
1447 feature option="NAME -reset"\r
1448 <br />\r
1449 feature option="NAME -check VALUE"\r
1450 <br />\r
1451 feature option="NAME -string VALUE"\r
1452 <br />\r
1453 feature option="NAME -spin VALUE MIN MAX"\r
1454 <br />\r
1455 feature option="NAME -combo CHOICE1 /// CHOICE2 ..."\r
1456 <br />\r
1457 feature option="NAME -slider VALUE MIN MAX"\r
1458 <br />\r
1459 feature option="NAME -file VALUE"\r
1460 <br />\r
1461 feature option="NAME -path VALUE"\r
1462 <br />\r
1463 NAME is an arbitrary alphanumeric string which can contain spaces; \r
1464 the other words in capitals would be replaced by the current (default) setting of the option,\r
1465 (a character string for -string options, a decimal number for -spin and -check options,\r
1466 were the latter uses 1=checked, 0=unchecked),\r
1467 the minimum or maximum value of numeric (-spin) options, \r
1468 or arbitrary text labels (for -combo option).\r
1469 In the latter case, the current value will be preceded by an asterisk.\r
1470 The -file and -path options are similar to -string, but can be used to inform the GUI that\r
1471 the text represents a file name or folder name respectively, \r
1472 so the GUI dialog could add the appropriate browse button to the text-edit field.\r
1473 Similarly, a -slider option is like a -spin, but the GUI might make a different\r
1474 graphical representation for it.\r
1475 A -save option is like a -button, and defines an immediate command to be sent by the engine.\r
1476 With -save the GUI will make sure all current option settings are flushed to the engine\r
1477 before it sends this command.\r
1478 A -reset option is like a -button, but use of it purges the list of options before sending \r
1479 the corresponding option command to the engine.\r
1480 This enables the engine to completely redefine its options or their current settings,\r
1481 by sending a new set of option feature commands to the GUI, \r
1482 terminated by feature done=1.\r
1483 (The effect of sending an option feature for an option with the same name as was defined before, \r
1484 without first receiving a -reset option command, is undefined.)\r
1485 </span>\r
1486 \r
1487 <dt class="version47">exclude (boolean, default 0)</dt>\r
1488 <dd class="version47">\r
1489 If exclude=1 the GUI can send "exclude" and "include" commands to control which moves\r
1490 from the root position should be searched.\r
1491 </dd>\r
1492 </dd>\r
1493 \r
1494 <dt class="version47">setscore (boolean, default 0)</dt>\r
1495 <dd class="version47">\r
1496 If setscore=1 the GUI can send "setscore" commands to define the score of the current position.\r
1497 </dd>\r
1498 </dd>\r
1499 \r
1500 <dt class="version1">done (integer, no default)</dt>\r
1501 <dd><span class="version1">\r
1502 If you set done=1 during the initial two-second timeout after\r
1503 xboard sends you the "xboard" command, the\r
1504 timeout will end and xboard will not look for any more feature\r
1505 commands before starting normal operation.\r
1506 If you set done=0, the initial timeout is increased to one hour;\r
1507 in this case, you must set done=1 before xboard will enter normal operation.\r
1508 </span>\r
1509 </dd>\r
1510 </dl>\r
1511 </dd>\r
1512 \r
1513 \r
1514 <dt>Illegal move: MOVE</dt>\r
1515 <dt>Illegal move (REASON): MOVE</dt>\r
1516 <dd>If your engine receives a MOVE command that is recognizably a move\r
1517 but is not legal in the current position, your engine must print an\r
1518 error message in one of the above formats so that xboard can pass the\r
1519 error on to the user and retract the move.  The (REASON) is entirely\r
1520 optional.  Examples:\r
1521 \r
1522 <pre>\r
1523   Illegal move: e2e4\r
1524   Illegal move (in check): Nf3\r
1525   Illegal move (moving into check): e1g1\r
1526 </pre>\r
1527 <p>\r
1528 Generally, xboard will never send an ambiguous move, so it does not \r
1529 matter whether you respond to such a move with an Illegal move message \r
1530 or an Error message.\r
1531 </p>\r
1532 </dd>\r
1533 \r
1534 <dt>Error (ERRORTYPE): COMMAND</dt>\r
1535 <dd>If your engine receives a command it does not understand or does\r
1536 not implement, it should print an error message in the above format so\r
1537 that xboard can parse it.  Examples:\r
1538 <pre>\r
1539   Error (ambiguous move): Nf3\r
1540   Error (unknown command): analyze\r
1541   Error (command not legal now): undo\r
1542   Error (too many parameters): level 1 2 3 4 5 6 7\r
1543 </pre>\r
1544 </dd>\r
1545 \r
1546 <dt>move MOVE</dt>\r
1547 <dd>Your engine is making the move MOVE.  Do not echo moves from\r
1548 xboard with this command; send only new moves made by the engine.\r
1549 \r
1550 <div class="version1">\r
1551 <p>For the actual move text from your chess engine (in place of MOVE\r
1552 above), your move should be either</p>\r
1553 <ul>\r
1554 <li>in coordinate notation (e.g.,\r
1555 e2e4, e7e8q) with castling indicated by the King's two-square move (e.g.,\r
1556 e1g1), or</li>\r
1557 <li>in Standard Algebraic Notation (SAN) as defined in the\r
1558 Portable Game Notation standard (e.g, e4, Nf3, O-O, cxb5, Nxe4, e8=Q),\r
1559 with the extension piece@square (e.g., P@f7) to handle piece placement\r
1560 in bughouse and crazyhouse.</li>\r
1561 </ul>\r
1562 <p>\r
1563 xboard itself also accepts some variants of SAN, but for compatibility\r
1564 with non-xboard interfaces, it is best not to rely on this behavior.\r
1565 </p>\r
1566 \r
1567 <p>Warning: Even though all versions of this protocol specification\r
1568 have indicated that xboard accepts SAN moves, some non-xboard\r
1569 interfaces are known to accept only coordinate notation.  See the\r
1570 Idioms section for more information on the known limitations of some\r
1571 non-xboard interfaces.  It should be safe to send SAN moves if you\r
1572 receive a "protover 2" (or later) command from the interface, but\r
1573 otherwise it is best to stick to coordinate notation for maximum\r
1574 compatibility.  An even more conservative approach would be for your\r
1575 engine to send SAN to the interface only if you have set feature san=1\r
1576 (which causes the interface to send SAN to you) and have received\r
1577 "accepted san" in reply.\r
1578 </p>\r
1579 </div>\r
1580 </dd>\r
1581 \r
1582 <dt>RESULT {COMMENT}</dt>\r
1583 <dd>When your engine detects\r
1584 that the game has ended by rule, your engine must output a line of the\r
1585 form "RESULT {comment}" (without the quotes), where RESULT is a PGN\r
1586 result code (1-0, 0-1, or 1/2-1/2), and comment is the reason.  Here\r
1587 "by rule" means that the game is definitely over because of what\r
1588 happened on the board.  In normal chess, this includes checkmate,\r
1589 stalemate, triple repetition, the 50 move rule, or insufficient\r
1590 material; it does not include loss on time or the like.\r
1591 Examples:\r
1592 <pre>\r
1593   0-1 {Black mates}\r
1594   1-0 {White mates}\r
1595   1/2-1/2 {Draw by repetition}\r
1596   1/2-1/2 {Stalemate}\r
1597 </pre>\r
1598 \r
1599 <p>\r
1600 xboard relays the result to the user, the ICS, the other engine in Two\r
1601 Machines mode, and the PGN save file as required.\r
1602 <span class="version43">Note that "definitey over" above means that sending this command \r
1603 will be taken by WinBoard as an unconditional refusal of the engine to play on,\r
1604 which might cause you to forfeit if the game was in fact not over.\r
1605 This command should thus not be used to offer draws, accept draws,\r
1606 or make draw-by-rule claims that are not yet valid in the current position\r
1607 (but will be after you move).\r
1608 For offering and claiming such draws, "offer draw" should be used.</span>\r
1609 </p>\r
1610 \r
1611 <p class="version44">\r
1612 Note that (in accordance with FIDE rules) only KK, KNK, KBK and KBKB with all bishops on the\r
1613 same color can be claimed as draws on the basis of insufficient mating material.\r
1614 The end-games KNNK, KBKN, KNKN and KBKB with unlike bishops do have mate positions,\r
1615 and cannot be claimed.\r
1616 Complex draws based on locked Pawn chains will not be recognized as draws by most interfaces,\r
1617 so do not claim in such positions, but just offer a draw or play on.\r
1618 </p>\r
1619 \r
1620 <p class="version44">\r
1621 Note to GUI programmers: RESULT commands that the engine sends immediately after its move\r
1622 might be detected by the GUI only after the opponent has moved, because of communication\r
1623 and scheduling delays, no matter how fast the engine sent it.\r
1624 Any judgement of the validity of RESULT claims based on te "current" board position\r
1625 will have to account for this uncertainty.\r
1626 </p>\r
1627 </dd>\r
1628 \r
1629 <dt>resign</dt>\r
1630 <dd>If your engine wants to resign, it can send the command "resign".\r
1631 Alternatively, it can use the "RESULT {comment}" command if the string\r
1632 "resign" is included in the comment; for example "0-1 {White\r
1633 resigns}".  xboard relays the resignation to the user, the ICS, the\r
1634 other engine in Two Machines mode, and the PGN save file as required.\r
1635 <span class="version44">Note that many interfaces work more smoothly if you resign <em>before</em>\r
1636 you move.</span>\r
1637 </dd>\r
1638 \r
1639 <dt>offer draw</dt>\r
1640 <dd>If your engine wants to offer a draw by agreement (as opposed to\r
1641 claiming a draw by rule), it can send the command "offer draw".\r
1642 xboard relays the offer to the user, the ICS, the other engine in Two\r
1643 Machines mode, and the PGN save file as required.  In Machine White,\r
1644 Machine Black, or Two Machines mode, the offer is considered valid\r
1645 until your engine has made two more moves.\r
1646 <span class="version43">This command must also be used to accept a draw offer.\r
1647 Do not use the 1/2-1/2 command for that, as the offer might be no longer valid,\r
1648 in which case a refusal to play on implied by the RESULT command might make you forfeit the game.\r
1649 "offer draw" should also be used to claim 50-move and 3-fold-repetition draws\r
1650 that will occur <em>after</em> your move, by sending it <em>before</em> making the move.\r
1651 WinBoard will grant draw offers without the opponent having any say in\r
1652 it in situations where draws can be claimed.\r
1653 Only if the draw cannot be claimed, the offer will be passed to your opponent after you make your next move,\r
1654 just before WinBoard relays this move to the opponent.\r
1655 </span>\r
1656 </dd>\r
1657 \r
1658 <dt class="version1">tellopponent MESSAGE</dt>\r
1659 <dd class="version1">\r
1660 This command lets the engine give a message to its opponent,\r
1661 independent of whether the opponent is a user on the local machine or\r
1662 a remote ICS user (Zippy mode).  MESSAGE consists of any characters,\r
1663 including whitespace, to the end of the line.  When the engine is\r
1664 playing against a user on the local machine, xboard pops up an\r
1665 information dialog containing the message.  When the engine is playing\r
1666 against an opponent on the ICS (Zippy mode), xboard sends "say\r
1667 MESSAGE\n" to the ICS.\r
1668 </dd>\r
1669 \r
1670 <dt class="version1">tellothers MESSAGE </dt>\r
1671 <dd class="version1">This command lets the engine give a message to people watching the\r
1672 game other than the engine's opponent.  MESSAGE consists of any\r
1673 characters, including whitespace, to the end of the line.  When the\r
1674 engine is playing against a user on the local machine, this command\r
1675 does nothing.  When the engine is playing against an opponent on the\r
1676 ICS (Zippy mode), xboard sends "whisper MESSAGE\n" to the ICS.\r
1677 </dd>\r
1678 \r
1679 <dt class="version1">tellall MESSAGE</dt>\r
1680 <dd class="version1">This command lets the engine give a message to its opponent and\r
1681 other people watching the game, \r
1682 independent of whether the opponent is a user on the local machine or\r
1683 a remote ICS user (Zippy mode).  MESSAGE consists of any characters,\r
1684 including whitespace, to the end of the line.  When the engine is\r
1685 playing against a user on the local machine, xboard pops up an\r
1686 information dialog containing the message.  When the engine is playing\r
1687 against an opponent on the ICS (Zippy mode), xboard sends "kibitz\r
1688 MESSAGE\n" to the ICS.\r
1689 </dd>\r
1690 \r
1691 <dt>telluser MESSAGE</dt>\r
1692 <dd>xboard pops up an information dialog containing the message.\r
1693 MESSAGE consists of any characters, including whitespace, to the end\r
1694 of the line.\r
1695 </dd>\r
1696 \r
1697 <dt>tellusererror MESSAGE</dt>\r
1698 <dd>xboard pops up an error dialog containing the message.\r
1699 MESSAGE consists of any characters, including whitespace, to the end\r
1700 of the line.\r
1701 </dd>\r
1702 \r
1703 <dt>askuser REPTAG MESSAGE</dt>\r
1704 <dd>Here REPTAG is a string containing no whitespace, and MESSAGE\r
1705 consists of any characters, including whitespace, to the end of the\r
1706 line.  xboard pops up a question dialog that says MESSAGE and\r
1707 has a typein box.  If the user types in "bar", xboard sends "REPTAG\r
1708 bar" to the engine.  The user can cancel the dialog and send nothing.\r
1709 </dd>\r
1710 \r
1711 <dt>tellics MESSAGE</dt>\r
1712 <dd>In Zippy mode, xboard sends "MESSAGE\n" to ICS.  MESSAGE consists\r
1713 of any characters, including whitespace, to the end of the line.\r
1714 </dd>\r
1715 \r
1716 <dt class="version1">tellicsnoalias MESSAGE</dt>\r
1717 <dd class="version1">\r
1718 In Zippy mode, xboard sends "xMESSAGE\n" to ICS, where "x" is a\r
1719 character that prevents the ICS from expanding command aliases, if\r
1720 xboard knows of such a character.  (On chessclub.com and chess.net,\r
1721 "/" is used; on freechess.org, "$" is used.)  MESSAGE consists of any\r
1722 characters, including whitespace, to the end of the line.\r
1723 </dd>\r
1724 \r
1725 <dt class="version43"># COMMENT</dt>\r
1726 <dd class="version43">\r
1727 The engine can send any string of printable characters, terminated by a newline,\r
1728 for inclusion in the winboard.debug file, provided the line starts with a '#' character.\r
1729 If the engine has set feature debug=1,\r
1730 it is guaranteed that WinBoard (and any future version of it) will completely ignore\r
1731 these lines in any other respect.\r
1732 </dd>\r
1733 </dl>\r
1734 \r
1735 <h2><a name="10">10. Thinking Output</a></h2>\r
1736 \r
1737 <p>\r
1738 If the user asks your engine to "show thinking", xboard sends your\r
1739 engine the "post" command.  It sends "nopost" to turn thinking off.\r
1740 In post mode, your engine sends output lines to show the progress of\r
1741 its thinking.  The engine can send as many or few of these lines as it\r
1742 wants to, whenever it wants to.  Typically they would be sent when the\r
1743 PV (principal variation) changes or the depth changes.  The thinking\r
1744 output should be in the following format:\r
1745 </p>\r
1746 \r
1747 <pre>ply score time nodes pv</pre>\r
1748 \r
1749 <p>Where:</p>\r
1750 <table>\r
1751 <tr><td>ply</td><td>Integer giving current search depth.</td></tr>\r
1752 <tr><td>score</td><td>Integer giving current evaluation in centipawns.</td></tr>\r
1753 <tr><td>time</td><td>Current search time in centiseconds (ex:1028 = 10.28 seconds).</td></tr>\r
1754 <tr><td>nodes</td><td>Nodes searched.</td></tr>\r
1755 <tr><td>pv</td><td>Freeform text giving current "best" line.\r
1756 You can continue the pv onto another line if you start each\r
1757 continuation line with at least four space characters.</td></tr>\r
1758 </table>\r
1759 \r
1760 <p>\r
1761 Example:\r
1762 </p>\r
1763 \r
1764 <pre>  9 156 1084 48000 Nf3 Nc6 Nc3 Nf6</pre>\r
1765 \r
1766 <p>\r
1767 Meaning:\r
1768 </p>\r
1769 \r
1770 <pre>\r
1771 9 ply, score=1.56, time = 10.84 seconds, nodes=48000, PV = "Nf3 Nc6 Nc3 Nf6"\r
1772 </pre>\r
1773 \r
1774 <p>\r
1775 Longer example from actual Crafty output:\r
1776 </p>\r
1777 \r
1778 <pre>\r
1779   4    109      14   1435  1. e4 d5 2. Qf3 dxe4 3. Qxe4 Nc6\r
1780   4    116      23   2252  1. Nf3 Nc6 2. e4 e6\r
1781   4    116      27   2589  1. Nf3 Nc6 2. e4 e6\r
1782   5    141      44   4539  1. Nf3 Nc6 2. O-O e5 3. e4\r
1783   5    141      54   5568  1. Nf3 Nc6 2. O-O e5 3. e4\r
1784 </pre>\r
1785 \r
1786 <p>\r
1787 You can use the PV to show other things; for instance, while in book,\r
1788 Crafty shows the observed frequency of different reply moves in its\r
1789 book.  In situations like this where your engine is not really\r
1790 searching, start the PV with a '(' character:\r
1791 </p>\r
1792 \r
1793 <pre>\r
1794   0      0       0      0  (e4 64%, d4 24%)\r
1795 </pre>\r
1796 \r
1797 <p>\r
1798 GNU Chess output is very slightly different.  The ply number is\r
1799 followed by an extra nonblank character, and the time is in seconds,\r
1800 not hundredths of seconds.  For compatibility, xboard accepts the\r
1801 extra character and takes it as a flag indicating the different time\r
1802 units.  Example:\r
1803 </p>\r
1804 \r
1805 <pre>\r
1806  2.     14    0       38   d1d2  e8e7 \r
1807  3+     78    0       65   d1d2  e8e7  d2d3 \r
1808  3&amp;     14    0       89   d1d2  e8e7  d2d3 \r
1809  3&amp;     76    0      191   d1e2  e8e7  e2e3 \r
1810  3.     76    0      215   d1e2  e8e7  e2e3 \r
1811  4&amp;     15    0      366   d1e2  e8e7  e2e3  e7e6 \r
1812  4.     15    0      515   d1e2  e8e7  e2e3  e7e6 \r
1813  5+     74    0      702   d1e2  f7f5  e2e3  e8e7  e3f4 \r
1814  5&amp;     71    0     1085   d1e2  e8e7  e2e3  e7e6  e3f4 \r
1815  5.     71    0     1669   d1e2  e8e7  e2e3  e7e6  e3f4 \r
1816  6&amp;     48    0     3035   d1e2  e8e7  e2e3  e7e6  e3e4  f7f5  e4d4 \r
1817  6.     48    0     3720   d1e2  e8e7  e2e3  e7e6  e3e4  f7f5  e4d4 \r
1818  7&amp;     48    0     6381   d1e2  e8e7  e2e3  e7e6  e3e4  f7f5  e4d4 \r
1819  7.     48    0    10056   d1e2  e8e7  e2e3  e7e6  e3e4  f7f5  e4d4 \r
1820  8&amp;     66    1    20536   d1e2  e8e7  e2e3  e7e6  e3d4  g7g5  a2a4  f7f5 \r
1821  8.     66    1    24387   d1e2  e8e7  e2e3  e7e6  e3d4  g7g5  a2a4  f7f5 \r
1822  9&amp;     62    2    38886   d1e2  e8e7  e2e3  e7e6  e3d4  h7h5  a2a4  h5h4 \r
1823                            d4e4 \r
1824  9.     62    4    72578   d1e2  e8e7  e2e3  e7e6  e3d4  h7h5  a2a4  h5h4 \r
1825                            d4e4 \r
1826 10&amp;     34    7   135944   d1e2  e8e7  e2e3  e7e6  e3d4  h7h5  c2c4  h5h4 \r
1827                            d4e4  f7f5  e4f4 \r
1828 10.     34    9   173474   d1e2  e8e7  e2e3  e7e6  e3d4  h7h5  c2c4  h5h4 \r
1829                            d4e4  f7f5  e4f4 \r
1830 </pre>\r
1831 \r
1832 <p>If your engine is pondering (thinking on its opponent's time) in post\r
1833 mode, it can show its thinking then too.  In this case your engine may\r
1834 omit the hint move (the move it is assuming its opponent will make)\r
1835 from the thinking lines <em>if and only if</em> it sends xboard the move in\r
1836 the usual "Hint: xxx" format before sending the first line.\r
1837 </p>\r
1838 \r
1839 <h2><a name="11">11. Time control</a></h2>\r
1840 \r
1841 <p>\r
1842 xboard supports three styles of time control: conventional chess clocks,\r
1843 the ICS-style incremental clock, and an exact number of seconds per move.\r
1844 </p>\r
1845 \r
1846 <p>In conventional clock mode, every time control period is the same.\r
1847 That is, if the time control is 40 moves in 5 minutes, then after each\r
1848 side has made 40 moves, they each get an additional 5 minutes, and so\r
1849 on, ad infinitum.  At some future time it would be nice to support a\r
1850 series of distinct time controls.  This is very low on my personal\r
1851 priority list, but code donations to the xboard project are accepted,\r
1852 so feel free to take a swing at it.  I suggest you talk to me first,\r
1853 though.\r
1854 </p>\r
1855 \r
1856 <p>\r
1857 The command to set a conventional time control looks like this:\r
1858 </p>\r
1859 \r
1860 <pre>\r
1861   level 40 5 0\r
1862   level 40 0:30 0\r
1863 </pre>\r
1864 \r
1865 <p>\r
1866 The 40 means that there are 40 moves per time control.  The 5 means\r
1867 there are 5 minutes in the control.  In the second example, the 0:30\r
1868 means there are 30 seconds.  The final 0 means that we are in\r
1869 conventional clock mode.\r
1870 </p>\r
1871 \r
1872 <p class="version43">\r
1873 Note that the time parameter in this command is not a pure numeric argument,\r
1874 but in general is a character string, in order to pass the number of seconds.\r
1875 Engines are encouraged to ignore any unexpected characters at the end of this string,\r
1876 i.e. following the MIN or MIN:SEC specification.\r
1877 Future protocol versions might (under control of an appropriate feature)\r
1878 append such extra characters to this argument,\r
1879 in order to inform the engine in advance of the time control it can expect after the current session completes.\r
1880 E.g. "level 40 25+5 0" could mean that the engine has to play 40 moves in 25 minutes,\r
1881 but should expect to get only 5 minutes for the entire remainder of the game after that,\r
1882 rather than another 25 minutes for the next 40 moves.\r
1883 When the time comes, (i.e. after the 40 moves), \r
1884 it will be informed of the time-control change by receiving a new "level 0 5 0" command,\r
1885 but engines with advanced time management might want to plan for this in advance.\r
1886 </p>\r
1887 \r
1888 <p>\r
1889 The command to set an incremental time control looks like this:\r
1890 </p>\r
1891 \r
1892 <pre>\r
1893   level 0 2 12\r
1894 </pre>\r
1895 \r
1896 <p>\r
1897 Here the 0 means "play the whole game in this time control period",\r
1898 the 2 means "base=2 minutes", and the 12 means "inc=12 seconds".  As\r
1899 in conventional clock mode, the second argument to level can be in\r
1900 minutes and seconds.\r
1901 </p>\r
1902 \r
1903 <p>\r
1904 At the start of the game, each player's clock is set to base minutes.\r
1905 Immediately after a player makes a move, inc seconds are added to his\r
1906 clock.  A player's clock counts down while it is his turn.  Your flag\r
1907 can be called whenever your clock is zero or negative.  (Your clock\r
1908 can go negative and then become positive again because of the\r
1909 increment.)\r
1910 </p>\r
1911 \r
1912 <p class="version44">\r
1913 The number of moves given in the level command (when non-zero) should \r
1914 be taken as the number of moves still to do before the specified time\r
1915 will be added to the clock, if the "level" command is received after\r
1916 some moves have already been played.\r
1917 The time given should be interpreted as the time left on its clock\r
1918 (including any time left over from the previous sessions),\r
1919 and not necessarily the time that will be added to the clock\r
1920 after the specified number of moves has been played.\r
1921 This is only relevant in WinBoard 4.3.xx, which might send the engine\r
1922 "level" commands during a game,\r
1923 just before the engine has to start thinking about the first move of \r
1924 a new time-control session.\r
1925 Example: if at the start of the game "level 40 60 0" was given \r
1926 (40 moves per hour),\r
1927 and the engine receives "level 20 22 0" just before move 41,\r
1928 it should understand that it should do the next 20 moves in 22 minutes\r
1929 (pehaps because the secondary session was 20 moves per 15 minutes,\r
1930 and it had 7 minutes left on its clock after the first 40 moves).\r
1931 </p>\r
1932 \r
1933 <p>\r
1934 A special rule on some ICS implementations: if you ask for a game with\r
1935 base=0, the clocks really start at 10 seconds instead of 0.  xboard\r
1936 itself does not know about this rule, so it passes the 0 on to the\r
1937 engine instead of changing it to 0:10.\r
1938 </p>\r
1939 \r
1940 <p>\r
1941 ICS also has time odds games.  With time odds, each player has his own\r
1942 (base, inc) pair, but otherwise things work the same as in normal\r
1943 games.  The Zippy xboard accepts time odds games but ignores the fact\r
1944 that the opponent's parameters are different; this is perhaps not\r
1945 quite the right thing to do, but gnuchess doesn't understand time\r
1946 odds.  Time odds games are always unrated.\r
1947 </p>\r
1948 \r
1949 <p>\r
1950 The command to set an exact number of seconds per move looks like this:\r
1951 </p>\r
1952 \r
1953 <pre>\r
1954   st 30\r
1955 </pre>\r
1956 \r
1957 <p>\r
1958 This means that each move must be made in at most 30 seconds.  Time not used\r
1959 on one move does not accumulate for use on later moves.\r
1960 </p>\r
1961 \r
1962 <h2><a name="12">12. Analyze Mode</a></h2>\r
1963 \r
1964 <p>xboard supports analyzing fresh games, edited positions, and games\r
1965 from files.  However, all of these look the same from the chess\r
1966 engine's perspective. Basically, the engine just has to respond to the\r
1967 "analyze" command.  \r
1968 <span class="version1">\r
1969 Beginning in protocol version 2,\r
1970 if your engine does not support analyze mode, it should use\r
1971 the feature command to set analyze=0.  \r
1972 </span>\r
1973 The older method of\r
1974 printing the error message "Error (unknown command): analyze" in\r
1975 response to the "analyze" command will also work, however.\r
1976 </p>\r
1977 \r
1978 <p>\r
1979 To enter analyze mode, xboard sends the command sequence "post", "analyze".  \r
1980 Analyze mode in your engine should be\r
1981 similar to force mode, except that your engine thinks about what move\r
1982 it would make next if it were on move.  Your engine should accept the\r
1983 following commands while in analyze mode:\r
1984 </p>\r
1985 \r
1986 <ul>\r
1987 <li>Any legal move, as in force mode</li>\r
1988 <li><strong>undo</strong>&nbsp;&nbsp; Back up one move and analyze previous position.</li>\r
1989 <li><strong>new</strong>&nbsp;&nbsp; Reset position to start of game but stay in analyze mode.</li>\r
1990 <li><span class="version1"><strong>setboard</strong> if you have set feature setboard=1; otherwise <strong>edit</strong>.  Exiting edit mode returns to analyze mode.</span></li>\r
1991 <li><strong>exit</strong>&nbsp;&nbsp; Leave analyze mode.</li>\r
1992 <li><strong>.</strong>&nbsp;&nbsp; Send a search status update (optional); see below.</li>\r
1993 <li><span class="version1">\r
1994 <strong>bk</strong>&nbsp;&nbsp; Show book moves from this position,\r
1995 if any; see above.</span></li>\r
1996 <li><span class="version1">\r
1997 <strong>hint</strong>&nbsp;&nbsp; Show the predicted move from this\r
1998 position, if any; see above.</span></li>\r
1999 </ul>\r
2000   \r
2001 <p>\r
2002 If the user selects "Periodic Updates", xboard will send the string\r
2003 ".\n" to the chess engine periodically during analyze mode, unless the\r
2004 last PV received began with a '(' character.\r
2005 </p>\r
2006 \r
2007 <p>\r
2008 The chess engine should respond to ".\n" with a line like this:\r
2009 </p>\r
2010 \r
2011 <pre>\r
2012 stat01: time nodes ply mvleft mvtot <span class="version1">mvname</span>\r
2013 </pre>\r
2014 \r
2015 <p>Where:</p>\r
2016 <table>\r
2017 <tr><td>time</td><td>Elapsed search time in centiseconds (ie: 567 = 5.67 seconds).</td></tr>\r
2018 <tr><td>nodes</td><td>Nodes searched so far.</td></tr>\r
2019 <tr><td>ply</td><td>Search depth so far.</td></tr>\r
2020 <tr><td>mvleft</td><td>Number of moves left to consider at this depth.</td></tr>\r
2021 <tr><td>mvtot</td><td>Total number of moves to consider.</td></tr>\r
2022 <tr class="version1"><td>mvname</td><td>Move currently being considered (SAN or coordinate notation).  Optional;\r
2023 added in protocol version 2.</td></tr>\r
2024 </table>\r
2025 \r
2026 <p>\r
2027 Examples:\r
2028 </p>\r
2029 <pre>\r
2030   stat01: 1234 30000 7 5 30\r
2031   stat01: 1234 30000 7 5 30 Nf3\r
2032 </pre>\r
2033 \r
2034 <p>\r
2035 Meaning:\r
2036 </p>\r
2037 \r
2038 <p>After 12.34 seconds, I've searched 7 ply/30000 nodes, there are a\r
2039   total of 30 legal moves, and I have 5 more moves to search\r
2040   before going to depth 8.  In the second example, of the 30 legal\r
2041   moves, the one I am currently searching is Nf3.</p>\r
2042 \r
2043 <p>\r
2044 Implementation of the "." command is optional. If the engine does not\r
2045 respond to the "." command with a "stat01..." line, xboard will stop\r
2046 sending "."  commands.  If the engine does not implement this command,\r
2047 the analysis window will use a shortened format to display the engine\r
2048 info.\r
2049 </p>\r
2050 \r
2051 <p>\r
2052 To give the user some extra information, the chess engine can output\r
2053 the strings "++\n" and "--\n", to indicate that the current search is\r
2054 failing high or low, respectively.  You don't have to send anything\r
2055 else to say "Okay, I'm not failing high/low anymore."  xboard will\r
2056 figure this out itself.\r
2057 </p>\r
2058 \r
2059 <h2><a name="13">13. Idioms and backward compatibility features</a></h2>\r
2060 \r
2061 <p>\r
2062 Some engines have variant interpretations of the force/go/white/black,\r
2063 time/otim, and hard/easy command sets.  \r
2064 In order to accommodate these older engines, xboard uses these commands\r
2065 only according to the stylized patterns ("idioms") given in this section.\r
2066 The obsolete white and black commands\r
2067 have historically been particularly troublesome, and it is recommended\r
2068 that new engines set the feature colors=0 and/or ignore the commands.\r
2069 </p>\r
2070 \r
2071 <dl>\r
2072 \r
2073 <dt>time N</dt>\r
2074 <dt>otim N</dt>\r
2075 <dt>MOVE</dt>\r
2076 <dd>Sent when the opponent makes a move and the engine is already\r
2077 playing the opposite color.\r
2078 </dd>\r
2079 <dt>white</dt>\r
2080 <dt>go</dt>\r
2081 <dd>Sent when the engine is in force mode or playing Black but should\r
2082 switch to playing White.  This sequence is sent only when White is\r
2083 already on move.  \r
2084 <span class="version1">\r
2085 If you set the feature colors=0, "white" is not sent.\r
2086 </span>\r
2087 </dd>\r
2088 \r
2089 <dt>black</dt>\r
2090 <dt>go</dt>\r
2091 <dd>Sent when the engine is in force mode or playing White but should\r
2092 switch to playing Black.  This sequence is sent only when Black is\r
2093 already on move.  \r
2094 <span class="version1">\r
2095 If you set the feature colors=0, "black" is not sent.\r
2096 </span>\r
2097 </dd>\r
2098 \r
2099 <dt>white</dt>\r
2100 <dt>time N</dt>\r
2101 <dt>otim N</dt>\r
2102 <dt>black</dt>\r
2103 <dt>go</dt>\r
2104 <dd>Sent when Black is on move, the engine is in force mode or playing\r
2105 White, and the engine's clock needs to be updated before it starts\r
2106 playing.  \r
2107 The initial "white" is a kludge to accommodate GNU Chess\r
2108 4's variant interpretation of these commands.  \r
2109 <span class="version1">\r
2110 If you set the feature colors=0, "white" and "black" are not sent.\r
2111 </span>\r
2112 </dd>\r
2113 \r
2114 <dt>black</dt>\r
2115 <dt>time N</dt>\r
2116 <dt>otim N</dt>\r
2117 <dt>white</dt>\r
2118 <dt>go</dt>\r
2119 <dd>Sent when White is on move, the engine is in force mode or playing\r
2120 Black, and the engine's clock needs to be updated before it starts\r
2121 playing.  See previous idiom.  \r
2122 The initial "black" is a kludge to accommodate GNU Chess\r
2123 4's variant interpretation of these commands.  \r
2124 <span class="version1">\r
2125 If you set the feature colors=0, "black" and "white" are not sent.\r
2126 </span>\r
2127 </dd>\r
2128 \r
2129 <dt>hard</dt>\r
2130 <dt>easy</dt>\r
2131 <dd>Sent in sequence to turn off pondering if xboard is not sure\r
2132 whether it is on.  When xboard is sure, it will send "hard" or "easy"\r
2133 alone.  xboard does this because "easy" is a toggle in GNU Chess 4 but\r
2134 "hard" is an absolute on.\r
2135 </dd>\r
2136 </dl>\r
2137 \r
2138 <p>\r
2139 To support older engines, certain additional commands from the engine\r
2140 to xboard are also recognized.  (These are commands by themselves, not\r
2141 values to be placed in the comment field of the PGN result code.)\r
2142 These forms are not recommended for new engines; use the PGN result\r
2143 code commands or the resign command instead.\r
2144 </p>\r
2145 \r
2146 <table>\r
2147 <tr><th>Command</th>              <th>Interpreted as</th></tr>\r
2148 <tr><td>White resigns        </td><td>0-1 {White resigns}</td></tr>\r
2149 <tr><td>Black resigns        </td><td>1-0 {Black resigns}</td></tr>\r
2150 <tr><td>White                </td><td>1-0 {White mates}</td></tr>\r
2151 <tr><td>Black                </td><td>0-1 {Black mates}</td></tr>\r
2152 <tr><td>Draw                 </td><td>1/2-1/2 {Draw}</td></tr>\r
2153 <tr><td>computer mates       </td><td>1-0 {White mates} or 0-1 {Black mates}</td></tr>\r
2154 <tr><td>opponent mates       </td><td>1-0 {White mates} or 0-1 {Black mates}</td></tr>\r
2155 <tr><td>computer resigns     </td><td>0-1 {White resigns} or 1-0 {Black resigns}</td></tr>\r
2156 <tr><td>game is a draw       </td><td>1/2-1/2 {Draw}</td></tr>\r
2157 <tr><td>checkmate            </td><td>1-0 {White mates} or 0-1 {Black mates}</td></tr>\r
2158 </table>\r
2159 \r
2160 <p>\r
2161 Commands in the above table are recognized if they begin a line and\r
2162 arbitrary characters follow, so (for example) "White mates" will be\r
2163 recognized as "White", and "game is a draw by the 50 move rule" will\r
2164 be recognized as "game is a draw".  All the commands are\r
2165 case-sensitive.\r
2166 </p>\r
2167 \r
2168 <p>\r
2169 An alternative move syntax is also recognized:\r
2170 </p>\r
2171 \r
2172 <table>\r
2173 <tr><th>Command              </th><th>Interpreted as</th></tr>\r
2174 <tr><td>NUMBER ... MOVE      </td><td>move MOVE</td></tr>\r
2175 </table>\r
2176 \r
2177 <p>\r
2178 Here NUMBER means any string of decimal digits, optionally ending in a\r
2179 period.  MOVE is any string containing no whitespace.  In this command\r
2180 format, xboard requires the "..." even if your engine is playing\r
2181 White.  A command of the form NUMBER MOVE will be ignored.  This odd\r
2182 treatment of the commands is needed for compatibility with gnuchessx.\r
2183 The original reasons for it are lost in the mists of time, but I\r
2184 suspect it was originally a bug in the earliest versions of xboard,\r
2185 before I started working on it, which someone "fixed" in the wrong\r
2186 way, by creating a special version of gnuchess (gnuchessx) instead of\r
2187 changing xboard.\r
2188 </p>\r
2189 \r
2190 <p>\r
2191 Any line that contains the words "offer" and "draw" is recognized as\r
2192 "offer draw".\r
2193 </p>\r
2194 \r
2195 <p>\r
2196 The "Illegal move" message is recognized even if spelled "illegal\r
2197 move" and even if the colon (":") is omitted.  This accommodates GNU\r
2198 Chess 4, which prints messages like "Illegal move (no matching\r
2199 move)e2e4", and old versions of Crafty, which print just "illegal move".\r
2200 </p>\r
2201 \r
2202 <p>\r
2203 In Zippy mode, for compatibility with older versions of Crafty,\r
2204 xboard passes through to ICS any line that begins "kibitz", "whisper",\r
2205 "tell", or "draw".  Do not use this feature in new code.  Instead, use the\r
2206 commands "tellall", "tellothers", "tellopponent", "tellics" (if needed),\r
2207 "1/2-1/2 {COMMENT}", or "offer draw", as appropriate.\r
2208 </p>\r
2209 \r
2210 <p class="version1">\r
2211 If the engine responds to the "sd DEPTH" command with an error message\r
2212 indicating the command is not supported (such as "Illegal move: sd"),\r
2213 xboard sets an internal flag and subsequently uses the command\r
2214 "depth\nDEPTH" instead, for the benefit of GNU Chess 4.  Note the\r
2215 newline in the middle of this command!  New engines should not rely on\r
2216 this feature.\r
2217 </p>\r
2218 \r
2219 <p class="version1">\r
2220 If the engine responds to the "st TIME" command with an error message\r
2221 indicating the command is not supported (such as "Illegal move: st"),\r
2222 xboard sets an internal flag and subsequently uses the command "level\r
2223 1 TIME" instead, for the benefit of GNU Chess 4.  Note that this is\r
2224 not a standard use of the level command, as TIME seconds are not added\r
2225 after each player makes 1 move; rather, each move is made in at most\r
2226 TIME seconds.  New engines should not implement or rely on this\r
2227 feature.\r
2228 </p>\r
2229 \r
2230 <div class="version1">\r
2231 <p>\r
2232 In support of the -firstHost/-secondHost features, which allow a chess\r
2233 engine to be run on another machine using the rsh protocol, xboard recognizes\r
2234 error messages that are likely to come from rsh as fatal errors.  The following\r
2235 messages are currently recognized:\r
2236 </p>\r
2237 \r
2238 <ul>\r
2239 <li>unknown host</li>\r
2240 <li>No remote directory</li>\r
2241 <li>not found</li>\r
2242 <li>No such file</li>\r
2243 <li>can't alloc</li>\r
2244 <li>Permission denied</li>\r
2245 </ul>\r
2246 </div>\r
2247 \r
2248 <p class="version1">\r
2249 ChessBase/Fritz now implements the xboard/winboard protocol and can use\r
2250 WinBoard-compatible engines in its GUI.  ChessBase's version of the\r
2251 protocol is generally the same as version 1, except that they have\r
2252 added the commands <strong>fritz</strong>, <strong>reset</strong>, and\r
2253 <strong>ponder</strong>, and the edit subcommands\r
2254 <strong>castle</strong> and <strong>ep</strong>.  If you want your\r
2255 engine to work well with the ChessBase/Fritz GUI, you may need to\r
2256 implement these additional commands, and you should also be aware of\r
2257 the peculiar way that ChessBase uses the protocol.  See their <a\r
2258 href="http://www.chessbase.com/Products/engines/winboard/tech.htm"\r
2259 >web page</a> for documentation.\r
2260 </p>\r
2261 \r
2262 <p class="version1">\r
2263 ChessMaster 8000 also implements version 1 of the xboard/winboard\r
2264 protocol and can use WinBoard-compatible engines.  The original\r
2265 release of CM8000 also has one additional restriction: only pure\r
2266 coordinate notation (e.g., e2e4) is accepted in the move command.  A\r
2267 patch to correct this should be available from The Learning Company\r
2268 (makers of CM8000) in February 2001.\r
2269 </p>\r
2270 \r
2271 </body>\r
2272 </html>\r