updated FAQ
[xboard.git] / manual / html_node / Chess-engine-options.html
index eb60662..7b3bbbd 100644 (file)
@@ -3,7 +3,7 @@
 <title>Chess engine options - XBoard</title>
 <meta http-equiv="Content-Type" content="text/html">
 <meta name="description" content="XBoard">
-<meta name="generator" content="makeinfo 4.12">
+<meta name="generator" content="makeinfo 4.13">
 <link title="Top" rel="start" href="index.html#Top">
 <link rel="up" href="Options.html#Options" title="Options">
 <link rel="next" href="UCI-_002b-WB-Engine-Settings.html#UCI-_002b-WB-Engine-Settings" title="UCI + WB Engine Settings">
@@ -23,8 +23,8 @@
 </head>
 <body>
 <div class="node">
-<p>
 <a name="Chess-engine-options"></a>
+<p>
 Next:&nbsp;<a rel="next" accesskey="n" href="UCI-_002b-WB-Engine-Settings.html#UCI-_002b-WB-Engine-Settings">UCI + WB Engine Settings</a>,
 Up:&nbsp;<a rel="up" accesskey="u" href="Options.html#Options">Options</a>
 <hr>
@@ -82,7 +82,7 @@ If mode=1, the engine that gets the most time will always get the nominal time,
 as specified by the time-control options, and its opponent's time is renormalized accordingly. 
 If mode=0, both play with reduced time. Default: 0. 
 <br><dt>-hideThinkingFromHuman true/false<dd>Controls the Hide Thinking option. See <a href="Options-Menu.html#Options-Menu">Options Menu</a>. Default: true. 
-(Relaces the Show-Thinking option of older xboard versions.) 
+(Replaces the Show-Thinking option of older xboard versions.) 
 <br><dt>-thinking/-xthinking or -showThinking true/false<dd><a name="index-thinking_002c-option-132"></a><a name="index-showThinking_002c-option-133"></a>Forces the engine to send thinking output to xboard. 
 Used to be the only way to control if thinking output was displayed
 in older xboard versions,
@@ -92,8 +92,8 @@ by the new option Hide Thinking. See <a href="Options-Menu.html#Options-Menu">Op
 (But if xboard needs the thinking output for some purpose,
 it makes the engine send it despite the setting of this option.) 
 <br><dt>-ponder/-xponder or -ponderNextMove true/false<dd><a name="index-ponder_002c-option-134"></a><a name="index-ponderNextMove_002c-option-135"></a>Sets the Ponder Next Move menu option. See <a href="Options-Menu.html#Options-Menu">Options Menu</a>. Default: true. 
-<br><dt>-smpCores number<dd>Specifies the maxmum nmber of CPUs an SMP engine is allowed to use. 
-Only works for engines that support the WinBoard-protocol cores feature. 
+<br><dt>-smpCores number<dd>Specifies the maximum number of CPUs an SMP engine is allowed to use. 
+Only works for engines that support the XBoard/WinBoard-protocol cores feature. 
 <br><dt>-mg or -matchGames n<dd><a name="index-mg_002c-option-136"></a><a name="index-matchGames_002c-option-137"></a>Automatically runs an n-game match between two chess engines,
 with alternating colors. 
 If the <code>loadGameFile</code> or <code>loadPositionFile</code> option is set,
@@ -182,15 +182,25 @@ that in favor of white, even when the engine plays black.
 Important when XBoard uses the score for adjudications, or in PGN reporting. 
 <br><dt>-niceEngines priority<dd><a name="index-niceEngines_002c-option-167"></a>This option allows you to lower the priority of the engine processes,
 so that the generally insatiable hunger for CPU time of chess engines does not interfere so much
-with smooth operation of WinBoard (or the rest of your system). 
+with smooth operation of XBoard (or the rest of your system). 
 Negative values could increase the engine priority, which is not recommended. 
-<br><dt>-firstOptions string<dt>-secondOptions string<dd><a name="index-firstOptions-option-168"></a><a name="index-secondOptions_002c-option-169"></a>The given string is a comma-separated list of (option name, option value) pairs,
-like the following example: “style Karpov, blunder rate 0”. 
-If the options announced by the engine at startup through the feature commands of WinBoard protocol
-matches one of the option names (i.e. “style” or “blunder rate”),
-it would be set to the given value (i.e. “Karpov” or 0)
+<br><dt>-firstOptions string<dt>-secondOptions string<dd><a name="index-firstOptions_002c-option-168"></a><a name="index-secondOptions_002c-option-169"></a>The given string is a comma-separated list of (option name=option value) pairs,
+like the following example: "style=Karpov,blunder rate=0". 
+If an option announced by the engine at startup through the feature commands of the XBoard/WinBoard protocol
+matches one of the option names (i.e. "style" or "blunder rate"),
+it would be set to the given value (i.e. "Karpov" or 0)
 through a corresponding option command to the engine. 
 This provided that the type of the value (text or numeric) matches as well. 
+<br><dt>-firstNeedsNoncompliantFEN string<dt>-secondNeedsNoncompliantFEN string<dd><a name="index-firstNeedsNoncompliantFEN_002c-option-170"></a><a name="index-secondNeedsNoncompliantFEN_002c-option-171"></a>The castling rights and e.p. fields of the FEN sent to the mentioned engine
+with the setboard command will be replaced by the given string. This can for
+instance be used to run engines that do not understand Chess960 FENs in
+variant fischerandom, to make them at least understand the opening position,
+through setting the string to "KQkq -". (Note you also have to give the e.p. field!) 
+Other possible applications are to provide work-arounds for engines that want to see
+castling and e.p. fields in variants that do not have castling or e.p. 
+(shatranj, courier, xiangqi, shogi) so that XBoard would normally omit them
+(string = "- -"), or to add variant-specific fields that are not yet supported by XBoard
+(e.g. to indicate the number of checks in 3check). 
 </dl>
 
    </body></html>