updated manual to 4.7.0
[xboard.git] / manual / html_node / UCI-_002b-WB-Engine-Settings.html
index 3bc522b..b517927 100644 (file)
@@ -3,11 +3,11 @@
 <title>UCI + WB Engine Settings - 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="prev" href="Chess-engine-options.html#Chess-engine-options" title="Chess engine options">
-<link rel="next" href="ICS-options.html#ICS-options" title="ICS options">
+<link rel="next" href="Tournament-options.html#Tournament-options" title="Tournament options">
 <link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
 <meta http-equiv="Content-Style-Type" content="text/css">
 <style type="text/css"><!--
 </head>
 <body>
 <div class="node">
-<p>
 <a name="UCI-+-WB-Engine-Settings"></a>
 <a name="UCI-_002b-WB-Engine-Settings"></a>
-Next:&nbsp;<a rel="next" accesskey="n" href="ICS-options.html#ICS-options">ICS options</a>,
+<p>
+Next:&nbsp;<a rel="next" accesskey="n" href="Tournament-options.html#Tournament-options">Tournament options</a>,
 Previous:&nbsp;<a rel="previous" accesskey="p" href="Chess-engine-options.html#Chess-engine-options">Chess engine options</a>,
 Up:&nbsp;<a rel="up" accesskey="u" href="Options.html#Options">Options</a>
 <hr>
 </div>
 
-<h3 class="section">3.2 UCI + WB Engine Settings</h3>
+<h3 class="section">4.2 UCI + WB Engine Settings</h3>
 
-<p><a name="index-Engine-Settings-170"></a><a name="index-Settings_002c-Engine-171"></a>
+<p><a name="index-Engine-Settings-260"></a><a name="index-Settings_002c-Engine-261"></a>
      <dl>
-<dt>-fUCI or -firstIsUCI true/false<dt>-sUCI or -secondIsUCI true/false<dd><a name="index-fUCI_002c-option-172"></a><a name="index-sUCI_002c-option-173"></a><a name="index-firstIsUCI_002c-option-174"></a><a name="index-secondIsUCI_002c-option-175"></a>Indicates if the mentioned engine executable file is an UCI engine, \r
-and should be run with the aid of the Polyglot adapter rather than directly. \r
-Xboard will then pass the other UCI options and engine name to Polyglot \r
-through a .ini temporary file ceated for the purpose.\r
-<br><dt>-PolyglotDir filename<dd><a name="index-PolyglotDir_002c-option-176"></a>Gives the name of the directory in which the Polyglot adapter for UCI engines expects its files.\r
-Default: "/usr/local/share/polyglot".\r
-<br><dt>-usePolyglotBook true/false<dd><a name="index-usePolyglotBook_002c-option-177"></a>Specifies if the Polygot book should be used.\r
-<br><dt>-PolyglotBook filename<dd><a name="index-PolyglotBook_002c-option-178"></a>Gives the filename of the opening book that Polyglot should use. \r
-From XBoard 4.3.15 on, native WinBoard engines will also use the opening book specified here, \r
-provided the <code>usePolyglotBook</code> option is set to true,\r
-and the option <code>firstHasOwnBookUCI</code> or <code>secondHasOwnBookUCI</code> applying to the engine\r
-is set to false.\r
-The engine will be kept in force mode as long as the current position is in book, \r
-and XBoard will select the book moves for it. Default "".\r
-<br><dt>-fNoOwnBookUCI or -firstXBook or -firstHasOwnBookUCI true/false<dt>-sNoOwnBookUCI or -secondXBook or -secondHasOwnBookUCI true/false<dd><a name="index-fNoOwnBookUCI_002c-option-179"></a><a name="index-sNoOwnBookUCI_002c-option-180"></a><a name="index-firstHasOwnBookUCI_002c-option-181"></a><a name="index-secondHasOwnBookUCI_002c-option-182"></a><a name="index-firstXBook_002c-option-183"></a><a name="index-secondXBook_002c-option-184"></a>Indicates if the mentioned engine has its own opening book it should play from,\r
-rather than using the external book through XBoard. Default: false.\r
-<br><dt>-defaultHashSize n<dd><a name="index-defaultHashSize_002c-option-185"></a>Sets the size of the hash table to n MegaBytes. Together with the EGTB cache size \r
-this number is also used to calculate the memory setting of WinBoard engines, \r
-for those that support the memory feature of WinBoard protocol. Default: 64.\r
-<br><dt>-defaultCacheSizeEGTB n<dd><a name="index-defaultCacheSizeEGTB_002c-option-186"></a>Sets the size of the EGTB cache to n MegaBytes. Together with the hash-table size \r
-this number is also used to calculate the memory setting of WinBoard engines, \r
-for those that support the memory feature of WinBoard protocol. Default: 4.\r
-<br><dt>-defaultPathEGTB filename<dd><a name="index-defaultPathEGTB_002c-option-187"></a>Gives the name of the directory where the end-game tablebases are installed, for UCI engines.\r
-Default: "/usr/local/share/egtb".\r
-<br><dt>-egtFormats string<dd><a name="index-egtFormats_002c-option-188"></a>Specifies which end-game tables are installed on the computer, and where. \r
-The argument is a comma-separated list of format specifications, \r
-each specification consisting of a format name, a colon, and a directory path name, \r
-e.g. "nalimov:/usr/local/share/egtb". \r
-If the name part matches that of a format that the engine requests through a feature command, \r
-xboard will relay the path name for this format to the engine through an egtpath command. \r
-One egtpath command for each matching format will be sent. \r
-Popular formats are "nalimov" DTM tablebases and "scorpio" bitbases.\r
-Default: "".\r
+<dt>-fUCI or -firstIsUCI true/false<dt>-sUCI or -secondIsUCI true/false<dd><a name="index-fUCI_002c-option-262"></a><a name="index-sUCI_002c-option-263"></a><a name="index-firstIsUCI_002c-option-264"></a><a name="index-secondIsUCI_002c-option-265"></a>Indicates if the mentioned engine executable file is an UCI engine,
+and should be run with the aid of the Polyglot adapter rather than directly. 
+Xboard will then pass the other UCI options and engine name to Polyglot
+on its command line, according to the option <code>adapterCommand</code>. 
+<br><dt>-fUCCI<dt>-sUCCI<dt>-fUSI<dt>-sUSI<dd><a name="index-fUCCI_002c-option-266"></a><a name="index-sUCCI_002c-option-267"></a><a name="index-fUSI_002c-option-268"></a><a name="index-sUSI_002c-option-269"></a>Options similar to <code>fUCI</code> and <code>sUCI</code>, except that they
+use the indicated engine with the protocol adapter specified in
+the &lsquo;<samp><span class="samp">uxiAdapter</span></samp>&rsquo; option. 
+This can then be configured for running an UCCI or USI adapter,
+as the need arises. 
+<br><dt>-adapterCommand string<dd><a name="index-adapterCommand_002c-option-270"></a>The string conatins the command that should be issued by XBoard
+to start an engine that is accompanied by the <code>fUCI</code> option. 
+Any identifier following a percent sign in the command (e.g. %fcp)
+will be considered the name of an XBoard option, and be replaced
+by the value of that option at the time the engine is started. 
+For starting the second engine, any leading "f" or "first" in
+the option name will first be replaced by "s" or "second",
+before finding its value. 
+Default: 'polyglot -noini -ec "%fcp" -ed "%fd"'
+<br><dt>-uxiAdapter string<dd><a name="index-uxiAdapter_002c-option-271"></a>Similar to <code>adapterCommand</code>, but used for engines accompanied
+by the <code>fUCCI</code> or <code>fUSI</code> option, so you can configure
+XBoard to be ready to handle more than one flavor of non-native protocols. 
+Default: ""
+<br><dt>-polyglotDir filename<dd><a name="index-polyglotDir_002c-option-272"></a>Gives the name of the directory in which the Polyglot adapter for UCI engines resides. 
+Default: "". 
+<br><dt>-usePolyglotBook true/false<dd><a name="index-usePolyglotBook_002c-option-273"></a>Specifies if the Polyglot book should be used as GUI book. 
+<br><dt>-polyglotBook filename<dd><a name="index-polyglotBook_002c-option-274"></a>Gives the filename of the opening book. 
+The book is only used when the <code>usePolyglotBook</code> option is set to true,
+and the option <code>firstHasOwnBookUCI</code> or <code>secondHasOwnBookUCI</code>
+applying to the engine is set to false. 
+The engine will be kept in force mode as long as the current position is in book,
+and XBoard will select the book moves for it. Default: "". 
+<br><dt>-fNoOwnBookUCI or -firstXBook or -firstHasOwnBookUCI true/false<dt>-sNoOwnBookUCI or -secondXBook or -secondHasOwnBookUCI true/false<dd><a name="index-fNoOwnBookUCI_002c-option-275"></a><a name="index-sNoOwnBookUCI_002c-option-276"></a><a name="index-firstHasOwnBookUCI_002c-option-277"></a><a name="index-secondHasOwnBookUCI_002c-option-278"></a><a name="index-firstXBook_002c-option-279"></a><a name="index-secondXBook_002c-option-280"></a>Indicates if the mentioned engine has its own opening book it should play from,
+rather than using the external book through XBoard. 
+Default: depends on setting of the option <code>discourageOwnBooks</code>. 
+<br><dt>-discourageOwnBooks true/false<dd><a name="index-discourageOwnBooks_002c-option-281"></a>When set, newly loaded engines will be assumed to use the GUI book,
+unless they explicitly specify differently. 
+Otherwise they will be assumed to not use the GUI book,
+unless the specify differently (e.g. with <code>firstXBook</code>). 
+Default: false. 
+<br><dt>-bookDepth n<dd><a name="index-bookDepth_002c-option-282"></a>Limits the use of the GUI book to the first n moves of each side. 
+Default: 12. 
+<br><dt>-bookVariation n<dd><a name="index-bookVariation_002c-option-283"></a>A value n from 0 to 100 tunes the choice of moves from the GUI books
+from totally random to best-only. Default: 50
+<br><dt>-mcBookMode<dd><a name="index-mcBookMode_002c-option-284"></a>When this volatile option is specified, the probing algorithm of the
+GUI book is altered to always select the move that is most under-represented
+based on its performance. 
+When all moves are played in approximately the right proportion,
+a book miss will be reported, to give the engine opportunity to
+explore a new move. 
+In addition score of the moves will be kept track of during the session
+in a book buffer. 
+By playing an match in this mode, a book will be built from scratch. 
+The only output are the saved games, which can be converted to an
+actual book later, with the &lsquo;<samp><span class="samp">Save Games as Book</span></samp>&rsquo; command. 
+This command can also be used to pre-fill the book buffer
+before adding new games based on the probing algorithm. 
+<br><dt>-fn string or -firstPgnName string<dt>-sn string or -secondPgnName string<dd><a name="index-firstPgnName_002c-option-285"></a><a name="index-secondPgnName_002c-option-286"></a><a name="index-fn_002c-option-287"></a><a name="index-sn_002c-option-288"></a>Indicates the name that should be used for the engine in PGN tags of
+engine-engine games. 
+Intended to allow you to install verions of the same engine with different settings,
+and still distinguish them. 
+Default: "". 
+<br><dt>-defaultHashSize n<dd><a name="index-defaultHashSize_002c-option-289"></a>Sets the size of the hash table to n MegaBytes. Together with the EGTB cache size
+this number is also used to calculate the memory setting of XBoard/WinBoard engines,
+for those that support the memory feature of the XBoard/WinBoard protocol. Default: 64. 
+<br><dt>-defaultCacheSizeEGTB n<dd><a name="index-defaultCacheSizeEGTB_002c-option-290"></a>Sets the size of the EGTB cache to n MegaBytes. Together with the hash-table size
+this number is also used to calculate the memory setting of XBoard/WinBoard engines,
+for those that support the memory feature of the XBoard/WinBoard protocol. Default: 4. 
+<br><dt>-defaultPathEGTB filename<dd><a name="index-defaultPathEGTB_002c-option-291"></a>Gives the name of the directory where the end-game tablebases are installed, for UCI engines. 
+Default: "/usr/local/share/egtb". 
+<br><dt>-egtFormats string<dd><a name="index-egtFormats_002c-option-292"></a>Specifies which end-game tables are installed on the computer, and where. 
+The argument is a comma-separated list of format specifications,
+each specification consisting of a format name, a colon, and a directory path name,
+e.g. "nalimov:/usr/local/share/egtb". 
+If the name part matches that of a format that the engine requests through a feature command,
+xboard will relay the path name for this format to the engine through an egtpath command. 
+One egtpath command for each matching format will be sent. 
+Popular formats are "nalimov" DTM tablebases and "scorpio" bitbases. 
+Default: "". 
+<br><dt>-firstChessProgramNames={names}<dd>This option lets you customize the drop-down list of chess engine names
+that appears in the &lsquo;<samp><span class="samp">Load Engine</span></samp>&rsquo; and &lsquo;<samp><span class="samp">Match Options</span></samp>&rsquo; dialog. 
+It consists of a list of strings, one per line. 
+When an engine is loaded, the corresponding line is prefixed with "-fcp ",
+and processed like it appeared on the command line. 
+That means that apart from the engine command,
+it can contain any list of XBoard options you want to use with this engine. 
+(Commonly used options here are -fd, -firstXBook, -fUCI, -variant.)
+
+     <p>The value of this option is gradually built as you load new engines
+through the &lsquo;<samp><span class="samp">Load Engine</span></samp>&rsquo; menu dialog, with &lsquo;<samp><span class="samp">Add to list</span></samp>&rsquo; ticked. 
+To change it, edit your settings file with a plain text editor. 
 </dl>
-   \r
 
    </body></html>