manual/html_node/UCI-_002b-WB-Engine-Settings.html

   1 <html lang="en">
   2 <head>
   3 <title>UCI + WB Engine Settings - XBoard</title>
   4 <meta http-equiv="Content-Type" content="text/html">
   5 <meta name="description" content="XBoard">
   6 <meta name="generator" content="makeinfo 4.13">
   7 <link title="Top" rel="start" href="index.html#Top">
   8 <link rel="up" href="Options.html#Options" title="Options">
   9 <link rel="prev" href="Chess-engine-options.html#Chess-engine-options" title="Chess engine options">
  10 <link rel="next" href="Tournament-options.html#Tournament-options" title="Tournament options">
  11 <link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
  12 <meta http-equiv="Content-Style-Type" content="text/css">
  13 <style type="text/css"><!--
  14   pre.display { font-family:inherit }
  15   pre.format  { font-family:inherit }
  16   pre.smalldisplay { font-family:inherit; font-size:smaller }
  17   pre.smallformat  { font-family:inherit; font-size:smaller }
  18   pre.smallexample { font-size:smaller }
  19   pre.smalllisp    { font-size:smaller }
  20   span.sc    { font-variant:small-caps }
  21   span.roman { font-family:serif; font-weight:normal; }
  22   span.sansserif { font-family:sans-serif; font-weight:normal; }
  23 --></style>
  24 </head>
  25 <body>
  26 <div class="node">
  27 <a name="UCI-+-WB-Engine-Settings"></a>
  28 <a name="UCI-_002b-WB-Engine-Settings"></a>
  29 <p>
  30 Next:&nbsp;<a rel="next" accesskey="n" href="Tournament-options.html#Tournament-options">Tournament options</a>,
  31 Previous:&nbsp;<a rel="previous" accesskey="p" href="Chess-engine-options.html#Chess-engine-options">Chess engine options</a>,
  32 Up:&nbsp;<a rel="up" accesskey="u" href="Options.html#Options">Options</a>
  33 <hr>
  34 </div>
  35
  36 <h3 class="section">4.2 UCI + WB Engine Settings</h3>
  37
  38 <p><a name="index-Engine-Settings-260"></a><a name="index-Settings_002c-Engine-261"></a>
  39      <dl>
  40 <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,
  41 and should be run with the aid of the Polyglot adapter rather than directly.
  42 Xboard will then pass the other UCI options and engine name to Polyglot
  43 on its command line, according to the option <code>adapterCommand</code>.
  44 <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
  45 use the indicated engine with the protocol adapter specified in
  46 the &lsquo;<samp><span class="samp">uxiAdapter</span></samp>&rsquo; option.
  47 This can then be configured for running an UCCI or USI adapter,
  48 as the need arises.
  49 <br><dt>-adapterCommand string<dd><a name="index-adapterCommand_002c-option-270"></a>The string conatins the command that should be issued by XBoard
  50 to start an engine that is accompanied by the <code>fUCI</code> option.
  51 Any identifier following a percent sign in the command (e.g. %fcp)
  52 will be considered the name of an XBoard option, and be replaced
  53 by the value of that option at the time the engine is started.
  54 For starting the second engine, any leading "f" or "first" in
  55 the option name will first be replaced by "s" or "second",
  56 before finding its value.
  57 Default: 'polyglot -noini -ec "%fcp" -ed "%fd"'
  58 <br><dt>-uxiAdapter string<dd><a name="index-uxiAdapter_002c-option-271"></a>Similar to <code>adapterCommand</code>, but used for engines accompanied
  59 by the <code>fUCCI</code> or <code>fUSI</code> option, so you can configure
  60 XBoard to be ready to handle more than one flavor of non-native protocols.
  61 Default: ""
  62 <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.
  63 Default: "".
  64 <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.
  65 <br><dt>-polyglotBook filename<dd><a name="index-polyglotBook_002c-option-274"></a>Gives the filename of the opening book.
  66 The book is only used when the <code>usePolyglotBook</code> option is set to true,
  67 and the option <code>firstHasOwnBookUCI</code> or <code>secondHasOwnBookUCI</code>
  68 applying to the engine is set to false.
  69 The engine will be kept in force mode as long as the current position is in book,
  70 and XBoard will select the book moves for it. Default: "".
  71 <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,
  72 rather than using the external book through XBoard.
  73 Default: depends on setting of the option <code>discourageOwnBooks</code>.
  74 <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,
  75 unless they explicitly specify differently.
  76 Otherwise they will be assumed to not use the GUI book,
  77 unless the specify differently (e.g. with <code>firstXBook</code>).
  78 Default: false.
  79 <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.
  80 Default: 12.
  81 <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
  82 from totally random to best-only. Default: 50
  83 <br><dt>-mcBookMode<dd><a name="index-mcBookMode_002c-option-284"></a>When this volatile option is specified, the probing algorithm of the
  84 GUI book is altered to always select the move that is most under-represented
  85 based on its performance.
  86 When all moves are played in approximately the right proportion,
  87 a book miss will be reported, to give the engine opportunity to
  88 explore a new move.
  89 In addition score of the moves will be kept track of during the session
  90 in a book buffer.
  91 By playing an match in this mode, a book will be built from scratch.
  92 The only output are the saved games, which can be converted to an
  93 actual book later, with the &lsquo;<samp><span class="samp">Save Games as Book</span></samp>&rsquo; command.
  94 This command can also be used to pre-fill the book buffer
  95 before adding new games based on the probing algorithm.
  96 <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
  97 engine-engine games.
  98 Intended to allow you to install verions of the same engine with different settings,
  99 and still distinguish them.
 100 Default: "".
 101 <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
 102 this number is also used to calculate the memory setting of XBoard/WinBoard engines,
 103 for those that support the memory feature of the XBoard/WinBoard protocol. Default: 64.
 104 <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
 105 this number is also used to calculate the memory setting of XBoard/WinBoard engines,
 106 for those that support the memory feature of the XBoard/WinBoard protocol. Default: 4.
 107 <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.
 108 Default: "/usr/local/share/egtb".
 109 <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.
 110 The argument is a comma-separated list of format specifications,
 111 each specification consisting of a format name, a colon, and a directory path name,
 112 e.g. "nalimov:/usr/local/share/egtb".
 113 If the name part matches that of a format that the engine requests through a feature command,
 114 xboard will relay the path name for this format to the engine through an egtpath command.
 115 One egtpath command for each matching format will be sent.
 116 Popular formats are "nalimov" DTM tablebases and "scorpio" bitbases.
 117 Default: "".
 118 <br><dt>-firstChessProgramNames={names}<dd>This option lets you customize the drop-down list of chess engine names
 119 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.
 120 It consists of a list of strings, one per line.
 121 When an engine is loaded, the corresponding line is prefixed with "-fcp ",
 122 and processed like it appeared on the command line.
 123 That means that apart from the engine command,
 124 it can contain any list of XBoard options you want to use with this engine.
 125 (Commonly used options here are -fd, -firstXBook, -fUCI, -variant.)
 126
 127      <p>The value of this option is gradually built as you load new engines
 128 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.
 129 To change it, edit your settings file with a plain text editor.
 130 </dl>
 131
 132    </body></html>
 133