polyglot.man

   1 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sh \" Subsection heading
   6 .br
   7 .if t .Sp
   8 .ne 5
   9 .PP
  10 \fB\\$1\fR
  11 .PP
  12 ..
  13 .de Sp \" Vertical space (when we can't use .PP)
  14 .if t .sp .5v
  15 .if n .sp
  16 ..
  17 .de Vb \" Begin verbatim text
  18 .ft CW
  19 .nf
  20 .ne \\$1
  21 ..
  22 .de Ve \" End verbatim text
  23 .ft R
  24 .fi
  25 ..
  26 .\" Set up some character translations and predefined strings.  \*(-- will
  27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  28 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
  29 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
  30 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
  31 .\" nothing in troff, for use with C<>.
  32 .tr \(*W-
  33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  34 .ie n \{\
  35 .    ds -- \(*W-
  36 .    ds PI pi
  37 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  38 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  39 .    ds L" ""
  40 .    ds R" ""
  41 .    ds C` ""
  42 .    ds C' ""
  43 'br\}
  44 .el\{\
  45 .    ds -- \|\(em\|
  46 .    ds PI \(*p
  47 .    ds L" ``
  48 .    ds R" ''
  49 'br\}
  50 .\"
  51 .\" If the F register is turned on, we'll generate index entries on stderr for
  52 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
  53 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  54 .\" output yourself in some meaningful fashion.
  55 .if \nF \{\
  56 .    de IX
  57 .    tm Index:\\$1\t\\n%\t"\\$2"
  58 ..
  59 .    nr % 0
  60 .    rr F
  61 .\}
  62 .\"
  63 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
  64 .\" way too many mistakes in technical documents.
  65 .hy 0
  66 .if n .na
  67 .\"
  68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  70 .    \" fudge factors for nroff and troff
  71 .if n \{\
  72 .    ds #H 0
  73 .    ds #V .8m
  74 .    ds #F .3m
  75 .    ds #[ \f1
  76 .    ds #] \fP
  77 .\}
  78 .if t \{\
  79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  80 .    ds #V .6m
  81 .    ds #F 0
  82 .    ds #[ \&
  83 .    ds #] \&
  84 .\}
  85 .    \" simple accents for nroff and troff
  86 .if n \{\
  87 .    ds ' \&
  88 .    ds ` \&
  89 .    ds ^ \&
  90 .    ds , \&
  91 .    ds ~ ~
  92 .    ds /
  93 .\}
  94 .if t \{\
  95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 101 .\}
 102 .    \" troff and (daisy-wheel) nroff accents
 103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 110 .ds ae a\h'-(\w'a'u*4/10)'e
 111 .ds Ae A\h'-(\w'A'u*4/10)'E
 112 .    \" corrections for vroff
 113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 115 .    \" for low resolution devices (crt and lpr)
 116 .if \n(.H>23 .if \n(.V>19 \
 117 \{\
 118 .    ds : e
 119 .    ds 8 ss
 120 .    ds o a
 121 .    ds d- d\h'-1'\(ga
 122 .    ds D- D\h'-1'\(hy
 123 .    ds th \o'bp'
 124 .    ds Th \o'LP'
 125 .    ds ae ae
 126 .    ds Ae AE
 127 .\}
 128 .rm #[ #] #H #V #F C
 129 .\" ========================================================================
 130 .\"
 131 .IX Title "POLYGLOT 6"
 132 .TH POLYGLOT 6 "2009-09-11" "" ""
 133 .SH "NAME"
 134 PolyGlot \-  Winboard protocol to UCI protocol adapter
 135          \-  book engine for Polyglot books
 136          \-  a collection of utilities for creating and analyzing opening books
 137          \-  a utility for analyzing epd files
 138          \-  a perft counter
 139 .SH "SYNOPSIS"
 140 .IX Header "SYNOPSIS"
 141 polyglot [configfile] [\-noini] [\-ec engine] [\-ed enginedirectory] [\-en enginename] [\-log] [\-lf logfile] [\-hash value] [\-bk book] [\-pg <name>=<value>]* [\-uci <name>=<value>]*
 142 .PP
 143 polyglot make-book [\-pgn inputfile] [\-bin outputfile] [\-max\-ply ply] [\-min\-game games] [\-min\-score score] [\-only\-white] [\-only\-black] [\-uniform]
 144 .PP
 145 polyglot merge-book \-in1 inputfile1 \-in2 inputfile2 [\-out outputfile]
 146 .PP
 147 polyglot info-book [\-bin inputfile] [\-exact]
 148 .PP
 149 polyglot dump-book [\-bin inputfile] \-color color [\-out outputfile]
 150 .PP
 151 polyglot [configfile] epd-test [engineoptions] [\-epd inputfile] [\-min\-depth depth] [\-max\-depth depth] [\-max\-time time] [\-depth\-delta delta]
 152 .PP
 153 polyglot perft [\-fen fen] [\-max\-depth depth]
 154 .SH "DESCRIPTION"
 155 .IX Header "DESCRIPTION"
 156 .Sh "PolyGlot as adapter and book engine"
 157 .IX Subsection "PolyGlot as adapter and book engine"
 158 PolyGlot is a \*(L"\s-1UCI\s0 adapter\*(R".  It connects a \s-1GUI\s0 interface (such as
 159 XBoard, Winboard, Arena or Chessbase) to a \s-1UCI\s0 chess engine.
 160 .PP
 161 By specifying an opening book (in PolyGlot book format) chess engines can
 162 transparently use such books.
 163 .PP
 164 PolyGlot understands the two main \s-1GUI\s0 protocols: \s-1UCI\s0 and
 165 xboard. Normally the protocol will be auto detected but this can be
 166 overridden in the configuration file.
 167 .PP
 168 In xboard mode PolyGlot fully translates between the xboard and \s-1UCI\s0 protocols.
 169 In addition it tries to solve known problems with other adapters.
 170 For instance, it detects and reports draws by fifty-move rule,
 171 repetition, etc ... It also supports Chess960.
 172 .PP
 173 When in \s-1UCI\s0 mode PolyGlot mostly passes commands from the \s-1GUI\s0
 174 to the engine and vice versa, except that it will play book moves on
 175 behalf of the engine when the occasion arises.
 176 .PP
 177 The engine options are exported as \s-1UCI\s0 options in \s-1UCI\s0
 178 mode and as \*(L"feature option=\*(R" commands in xboard mode. The latter form
 179 an extension of the xboard protocol as defined by H.G. Muller.
 180 .PP
 181 Options which normally appear in the [PolyGlot] section of the
 182 config file (see below) are exported as options with their name prefixed
 183 by \*(L"Polyglot\*(R". This makes it easy to filter them in the \s-1GUI\s0.
 184 .PP
 185 \&\s-1NOTE:\s0 Not all options are exported, only those that make sense in the
 186 given mode.
 187 .Sh "Book making utilities"
 188 .IX Subsection "Book making utilities"
 189 PolyGlot supports the \*(L"PolyGlot opening book format\*(R". This is the
 190 defacto standard non-proprietary opening book format. It is fully documented
 191 here
 192 .PP
 193 http://alpha.uhasselt.be/Research/Algebra/Toga/book_format.html
 194 .PP
 195 Roughly speaking a PolyGlot opening book is a collection of triples
 196 (position, move, weight). A \*(L"position\*(R" is represented by a 64\-bit
 197 Zobrist hash key. The weight is proportional to the probability the move should
 198 be played.
 199 .PP
 200 Other opening book formats such as ChessBase's .ctg format and Arena's
 201 \&.abk format are undocumented and proprietary. They can only be used
 202 by their own GUIs.
 203 .PP
 204 PolyGlot can compile a pgn file into a binary PolyGlot book and furthermore
 205 it can merge two such binary books into a third one.
 206 .PP
 207 PolyGlot can also extract some useful information from PolyGlot books. The utility
 208 \&\*(L"dump\-book\*(R" dumps the \*(L"lines\*(R" in a book for a given color. By definition
 209 a line is a sequence of moves (from the starting position) in which
 210 the given color makes only book moves and the other color makes
 211 arbitrary moves (i.e. not necessarily book moves).
 212 .PP
 213 Since a PolyGlot book is built up from positions and not lines there
 214 may be (and there usually are) many positions in the book that are not
 215 on a \*(L"line\*(R" as defined in the previous paragraph. It is convenient
 216 to call such positions \*(L"isolated\*(R" positions. The utility \*(L"info\-book\*(R"
 217 counts such isolated positions.
 218 .PP
 219 Some of the isolated positions are provably unreachable and they
 220 could in principle be deleted from the book. For example if a book
 221 contains only the move \*(L"e4\*(R" in the starting position but also the
 222 position after \*(L"d4 d5\*(R" then this last position is provably unreachable
 223 since it requires white to make a non-book move when a book move is
 224 available. Such situations arise frequently from the priority rules
 225 in merging books.
 226 .PP
 227 Unfortunately not all isolated positions are provably unreachable and
 228 it is difficult to identify the latter. If invoked with \*(L"\-exact\*(R" the
 229 utility info-book will attempt to count the isolated positions which
 230 require a player to make a non-book move when a book move is available.
 231 Due to the possibility of transpositions this is not a fool proof method.
 232 .Sh "Epd test mode"
 233 .IX Subsection "Epd test mode"
 234 In epd test mode, PolyGlot will search positions in an epd file and
 235 record the number of times the right best move was found.  The
 236 arguments specify when to stop the search in any given position.
 237 .Sh "Perft counts"
 238 .IX Subsection "Perft counts"
 239 A perft count is the number of legal move sequence in a given position
 240 up to a given depth. PolyGlot can perform such perft counts. It
 241 is however much slower than other more dedicated programs.
 242 .SH "OPTIONS"
 243 .IX Header "OPTIONS"
 244 When PolyGlot is invoked as an adapter of in epd-test mode it gets its
 245 options from a config file and then from the command line.  The
 246 default config file is \*(L"polyglot.ini\*(R" but an alternative one may be
 247 optionally included as first argument. The config file format is
 248 described below.
 249 .PP
 250 The following engine options may be specified on the command line.
 251 .IP "\fB\-noini\fR" 4
 252 .IX Item "-noini"
 253 Do not use a config file, even if one was specified on the command line.
 254 .IP "\fB\-pg\fR" 4
 255 .IX Item "-pg"
 256 The argument is a string of the form <name>=<value>. This option will
 257 set the Polyglot option <name> to <value>.
 258 .IP "\fB\-uci\fR" 4
 259 .IX Item "-uci"
 260 The argument is a string of the form <name>=<value>. This option will
 261 set the engine option <name> to <value>.
 262 .IP "\fB\-ec\fR" 4
 263 .IX Item "-ec"
 264 This is an alias for \-pg \*(L"EngineCommand=<value>\*(R"
 265 .IP "\fB\-ed\fR" 4
 266 .IX Item "-ed"
 267 This is an alias for \-pg \*(L"EngineDir=<value>\*(R"
 268 .IP "\fB\-en\fR" 4
 269 .IX Item "-en"
 270 This is an alias for \-pg \*(L"EngineName=<value>\*(R"
 271 .IP "\fB\-log\fR (default: false)" 4
 272 .IX Item "-log (default: false)"
 273 This is an alias for \-pg \*(L"Log=<value>\*(R"
 274 .ie n .IP "\fB\-lf\fR (default: ""polyglot.log"")" 4
 275 .el .IP "\fB\-lf\fR (default: ``polyglot.log'')" 4
 276 .IX Item "-lf (default: polyglot.log)"
 277 This is an alias for \-pg \*(L"LogFile=<value>\*(R".
 278 .ie n .IP "\fB\-wb\fR (default: ""true"")" 4
 279 .el .IP "\fB\-wb\fR (default: ``true'')" 4
 280 .IX Item "-wb (default: true)"
 281 This is an alias for \-pg \*(L"OnlyWbOptions=<value>\*(R".
 282 .PP
 283 When invoked as
 284 .Sh "polyglot make-book"
 285 .IX Subsection "polyglot make-book"
 286 PolyGlot supports the following options
 287 .ie n .IP "\fB\-pgn\fR (default: ""book.pgn"")" 4
 288 .el .IP "\fB\-pgn\fR (default: ``book.pgn'')" 4
 289 .IX Item "-pgn (default: book.pgn)"
 290 Input file in pgn format.
 291 .ie n .IP "\fB\-bin\fR (default: ""book.bin"")" 4
 292 .el .IP "\fB\-bin\fR (default: ``book.bin'')" 4
 293 .IX Item "-bin (default: book.bin)"
 294 Output file in PolyGlot format.
 295 .IP "\fB\-max\-ply\fR (default: 1024)" 4
 296 .IX Item "-max-ply (default: 1024)"
 297 Specifies the maximum ply-depth of lines included in the book.
 298 .IP "\fB\-min\-game\fR (default: 3)" 4
 299 .IX Item "-min-game (default: 3)"
 300 Specifies the minimum number of games that have to contain this move for it to be included in the book.
 301 .IP "\fB\-min\-score\fR (default: 0.0)" 4
 302 .IX Item "-min-score (default: 0.0)"
 303 Specifies the minimum score (or weight) this move should have received for
 304 it to  be included in the book. The score is 2*(wins)+(draws), globally scaled
 305 to fit into 16 bits.
 306 .IP "\fB\-only\-white\fR" 4
 307 .IX Item "-only-white"
 308 Include only moves for white in the book.
 309 .IP "\fB\-only\-black\fR" 4
 310 .IX Item "-only-black"
 311 Include only moves for black in the book.
 312 .IP "\fB\-uniform\fR" 4
 313 .IX Item "-uniform"
 314 Set all weights to 1. In other words, all moves will be selected with
 315 equal probability.
 316 .PP
 317 When invoked
 318 as
 319 .Sh "polyglot merge-book"
 320 .IX Subsection "polyglot merge-book"
 321 PolyGlot supports the following options
 322 .IP "\fB\-in1\fR" 4
 323 .IX Item "-in1"
 324 First input file (in PolyGlot book format).
 325 .IP "\fB\-in2\fR" 4
 326 .IX Item "-in2"
 327 Second input file (in PolyGlot book format).
 328 .IP "\fB\-out\fR (default: out.bin)" 4
 329 .IX Item "-out (default: out.bin)"
 330 Output file (in PolyGlot book format).
 331 .PP
 332 Input files are not symmetrical, \*(L"in1\*(R" has priority over \*(L"in2\*(R". In other
 333 words when a position occurs both in \*(L"in1\*(R" and \*(L"in2\*(R" only the
 334 moves and weights from \*(L"in1\*(R" will be retained in \*(L"out\*(R".
 335 .PP
 336 When invoked
 337 as
 338 .Sh "polyglot dump-book"
 339 .IX Subsection "polyglot dump-book"
 340 PolyGlot supports the following options
 341 .IP "\fB\-bin\fR (default: book.bin)" 4
 342 .IX Item "-bin (default: book.bin)"
 343 Input file in PolyGlot book format.
 344 .IP "\fB\-color\fR" 4
 345 .IX Item "-color"
 346 The color for whom to generate the lines.
 347 .IP "\fB\-out\fR (default: book_<color>.txt)" 4
 348 .IX Item "-out (default: book_<color>.txt)"
 349 The name of the output file.
 350 .PP
 351 When invoked
 352 as
 353 .Sh "polyglot info-book"
 354 .IX Subsection "polyglot info-book"
 355 PolyGlot supports the following options
 356 .IP "\fB\-bin\fR (default: book.bin)" 4
 357 .IX Item "-bin (default: book.bin)"
 358 Input file in PolyGlot book format.
 359 .IP "\fB\-exact\fR" 4
 360 .IX Item "-exact"
 361 Attempt to count the provably unreachable positions among the isolated ones.
 362 Note that this takes a very long time.
 363 .PP
 364 When invoked as
 365 .Sh "polyglot epd-test"
 366 .IX Subsection "polyglot epd-test"
 367 (possibly with a config file as first argument) PolyGlot supports
 368 besides the generic options described above the following additional
 369 options.
 370 .IP "\fB\-max\-depth\fR (default: 63)" 4
 371 .IX Item "-max-depth (default: 63)"
 372 Unconditionally stop the search when this depth has
 373 been reached.
 374 .IP "\fB\-max\-time\fR (default: 5.0)" 4
 375 .IX Item "-max-time (default: 5.0)"
 376 Unconditionally stop the seach after this amount of time.
 377 .IP "\fB\-depth\-delta\fR (default: 3)" 4
 378 .IX Item "-depth-delta (default: 3)"
 379 Stop the search if the solution as been found and the best move has
 380 been constant for this many depths, on condition that the mininal
 381 depth and minimal time have been reached.
 382 .IP "\fB\-min\-depth\fR (default: 8)" 4
 383 .IX Item "-min-depth (default: 8)"
 384 Minimal search depth when the search is stopped using \*(L"\-depth\-delta\*(R".
 385 .IP "\fB\-min\-time\fR (default: 1.0)" 4
 386 .IX Item "-min-time (default: 1.0)"
 387 Minimal search time when the search is stopped using \*(L"\-depth\-delta\*(R".
 388 .PP
 389 When invoked as
 390 .Sh "polyglot perft"
 391 .IX Subsection "polyglot perft"
 392 PolyGlot supports the following
 393 options
 394 .IP "\fB\-fen\fR (default: starting position)" 4
 395 .IX Item "-fen (default: starting position)"
 396 Fen at which to start searching.
 397 .IP "\fB\-max\-depth\fR (default: 1)" 4
 398 .IX Item "-max-depth (default: 1)"
 399 Maximum depth to search.
 400 .SH "CONFIG FILE FORMAT"
 401 .IX Header "CONFIG FILE FORMAT"
 402 There should be a different config file for each engine.
 403 .PP
 404 The config file is in the traditional \s-1INI\s0 format.
 405 .PP
 406 .Vb 6
 407 \&    [PolyGLot]
 408 \&    option = value
 409 \&    ...
 410 \&    [Engine]
 411 \&    option = value
 412 \&    ...
 413 .Ve
 414 .PP
 415 The characters \*(L"#\*(R" and \*(L";\*(R" serve as comment characters.
 416 .PP
 417 By default initial and final white space is stripped from option
 418 values. If you want to avoid this, or if you want use one of
 419 the comment characters # or ; in option values (such as for NalimovPath),
 420 enclose the value in quotes.
 421 .Sh "[PolyGlot] section"
 422 .IX Subsection "[PolyGlot] section"
 423 This section is used by PolyGlot only.  The engine is unaware of these
 424 options.  The list of available options is detailed below.
 425 .IP "\fBEngineName\fR (default: \s-1UCI\s0 name)" 4
 426 .IX Item "EngineName (default: UCI name)"
 427 This is the name that will appear in the \s-1GUI\s0.  It is
 428 cosmetic only.  You can use different names for tweaked versions of
 429 the same engine.
 430 .ie n .IP "\fBEngineDir\fR (default: ""."")" 4
 431 .el .IP "\fBEngineDir\fR (default: ``.'')" 4
 432 .IX Item "EngineDir (default: .)"
 433 Full path of the directory where the engine is installed.  You can use
 434 \&\*(L".\*(R" (without the quotes) if you know that PolyGlot will be launched in
 435 the engine directory or the engine is in the \*(L"path\*(R" and does not need
 436 any data file.
 437 .IP "\fBEngineCommand\fR" 4
 438 .IX Item "EngineCommand"
 439 Put here the name of the engine executable file.  You can also add
 440 command-line arguments.  Path searching is used and the current
 441 directory will be \*(L"EngineDir\*(R".
 442 .ie n .IP "\fBSettingsDir\fR (default: $HOME/.polyglot on Linux; "".\e_PG"" on Windows)" 4
 443 .el .IP "\fBSettingsDir\fR (default: \f(CW$HOME\fR/.polyglot on Linux; ``.\e_PG'' on Windows)" 4
 444 .IX Item "SettingsDir (default: $HOME/.polyglot on Linux; ._PG on Windows)"
 445 The directory where ini files are stored for engines that are started with
 446 \&\-noini. Such ini files may be created by pushing the \*(L"Save\*(R" button in the
 447 Engine settings dialog in \s-1WB/XB\s0 4.4.0 and higher. As a special exception
 448 (for \s-1WB/XB\s0 4.4.0 compatibility) this directory is also used in case
 449 PolyGlot is started with config files named \*(L"polyglot_1st.ini\*(R" or
 450 \&\*(L"polyglot_2nd.ini\*(R".
 451 .IP "\fBLog\fR (default: false)" 4
 452 .IX Item "Log (default: false)"
 453 Whether PolyGlot should log all transactions with the interface and
 454 the engine.  This should be necessary only to locate problems.
 455 .IP "\fBLogFile\fR (default: polyglot.log)" 4
 456 .IX Item "LogFile (default: polyglot.log)"
 457 The name of the log file.  Note that it is put where PolyGlot was
 458 launched from, not into the engine directory.
 459 .Sp
 460 \&\s-1WARNING:\s0 Log files are not cleared between sessions, and can become
 461 very large.  It is safe to remove them though.
 462 .IP "\fBResign\fR (default: false)" 4
 463 .IX Item "Resign (default: false)"
 464 Set this to \*(L"true\*(R" if you want PolyGlot to resign on behalf of the
 465 engine.
 466 .Sp
 467 \&\s-1NOTE:\s0 Some engines display buggy scores from time to time although the
 468 best move is correct.  Use this option only if you know what you are
 469 doing (e.g. you always check the final position of games).
 470 .IP "\fBResignMoves\fR (default: 3)" 4
 471 .IX Item "ResignMoves (default: 3)"
 472 Number of consecutive moves with \*(L"resign\*(R" score (see below) before
 473 PolyGlot resigns for the engine.  Positions with only one legal move
 474 are ignored.
 475 .IP "\fBResignScore\fR (default: 600)" 4
 476 .IX Item "ResignScore (default: 600)"
 477 This is the score in centipawns that will trigger resign \*(L"counting\*(R".
 478 .IP "\fBShowPonder\fR (default: true)" 4
 479 .IX Item "ShowPonder (default: true)"
 480 Show search information during engine pondering.  Turning this off
 481 might be better for interactive use in some interfaces.
 482 .IP "\fBScoreWhite\fR (default: true)" 4
 483 .IX Item "ScoreWhite (default: true)"
 484 Report score from white's point of view in xboard mode.
 485 .IP "\fBKibitzMove\fR (default: false)" 4
 486 .IX Item "KibitzMove (default: false)"
 487 Whether to kibitz when playing a move.
 488 .IP "\fBKibitzPV\fR (default: false)" 4
 489 .IX Item "KibitzPV (default: false)"
 490 Whether to kibitz when the \s-1PV\s0 is changed (new iteration or new best move).
 491 .ie n .IP "\fBKibitzCommand\fR (default: ""tellall"")" 4
 492 .el .IP "\fBKibitzCommand\fR (default: ``tellall'')" 4
 493 .IX Item "KibitzCommand (default: tellall)"
 494 xboard command to use for kibitzing, normally \*(L"tellall\*(R" for kibitzing
 495 or \*(L"tellothers\*(R" for whispering.
 496 .IP "\fBKibitzDelay\fR (default: 5)" 4
 497 .IX Item "KibitzDelay (default: 5)"
 498 How many seconds to wait before starting kibitzing.  This has an
 499 effect only if \*(L"KibitzPV\*(R" is selected, move kibitzes are always sent
 500 regardless of the delay.
 501 .IP "\fBKibitzInterval\fR (default: 0)" 4
 502 .IX Item "KibitzInterval (default: 0)"
 503 This is another form of throttling. PolyGlot will usually wait this
 504 many seconds before doing the next kibitz.
 505 .IP "\fB\s-1UCI\s0\fR (default: false)" 4
 506 .IX Item "UCI (default: false)"
 507 If true PolyGlot will not understand xboard commands.
 508 .IP "\fBMateScore\fR (default: 10000)" 4
 509 .IX Item "MateScore (default: 10000)"
 510 Mate score reported to \s-1GUI\s0 when in xboard mode.
 511 .IP "\fBBook\fR (default: false)" 4
 512 .IX Item "Book (default: false)"
 513 Indicates whether a PolyGlot book should be used.  This has no effect
 514 on the engine own book (which can be controlled with the \s-1UCI\s0 option
 515 \&\*(L"OwnBook\*(R" in the [Engine] section).  In particular, it is possible to
 516 use both a PolyGlot book and an engine book.  In that case, the engine
 517 book will be used whenever PolyGlot is out of book.  Remember that
 518 PolyGlot is unaware of whether the engine is itself using a book or
 519 not.
 520 .IP "\fBBookFile\fR (default: book.bin)" 4
 521 .IX Item "BookFile (default: book.bin)"
 522 The name of the (binary) book file.  Note that PolyGlot will look for
 523 it in the directory it was launched from, not in the engine directory.
 524 Of course, full path can be used in which case the current directory
 525 does not matter.
 526 .IP "\fBBookRandom\fR (default: true)" 4
 527 .IX Item "BookRandom (default: true)"
 528 Select moves according to their weights in the book. If false the move
 529 with the highest weight is selected.
 530 .IP "\fBBookLearn\fR (default: false)" 4
 531 .IX Item "BookLearn (default: false)"
 532 Store learning information in the book (which must be writable). Currently
 533 no engine actually uses this information.
 534 .IP "\fBBookDepth\fR (default: 256)" 4
 535 .IX Item "BookDepth (default: 256)"
 536 Stop using the book after this number of moves.
 537 .IP "\fBBookTreshold\fR (default: 5)" 4
 538 .IX Item "BookTreshold (default: 5)"
 539 Do not play moves with a weight (probability) lower than this (in per mil).
 540 .IP "\fBUseNice\fR (default: false)" 4
 541 .IX Item "UseNice (default: false)"
 542 Run the engine at nice level 5, or \*(L"NiceValue\*(R" if it set.  On some
 543 operating systems it may be necessary to run the engine at lower
 544 priority for it to be responsive to commands from PolyGlot while
 545 searching.
 546 .IP "\fBNiceValue\fR (default: 5)" 4
 547 .IX Item "NiceValue (default: 5)"
 548 Nice levels go from \-20 to 20 with 20 being the lowest priority.
 549 On Unix only root can set negative nice levels. On Windows the standard
 550 Win32 priority levels are mapped in a sensible way to Unix nice levels.
 551 .IP "\fBAffinity\fR (default: \-1)" 4
 552 .IX Item "Affinity (default: -1)"
 553 This a bit vector in which each bit represents the processors that a
 554 process is allowed to run on. This option works only on Windows.
 555 .IP "\fBOnlyWbOptions\fR (default: true)" 4
 556 .IX Item "OnlyWbOptions (default: true)"
 557 If true then PolyGlot restricts the options it sends to those that
 558 are potentially useful for WinBoard.
 559 .Sh "Work arounds"
 560 .IX Subsection "Work arounds"
 561 Work arounds are identical to options except that they should be used
 562 only when necessary.  Their purpose is to try to hide problems with
 563 various software (not just engines).
 564 .PP
 565 \&\s-1IMPORTANT:\s0 Any of these work arounds might be removed in future
 566 versions of PolyGlot.  You are strongly recommended to contact the
 567 author of faulty software and truly fix the problem.
 568 .PP
 569 PolyGlot supports the following work arounds:
 570 .IP "\fBUCIVersion\fR (default: 2)" 4
 571 .IX Item "UCIVersion (default: 2)"
 572 The default value of 2 corresponds to \s-1UCI+\s0.  Use 1 to select plain
 573 \&\s-1UCI\s0 for engines that have problems with \s-1UCI+\s0.
 574 .IP "\fBCanPonder\fR (default: false)" 4
 575 .IX Item "CanPonder (default: false)"
 576 PolyGlot now conforms to the documented \s-1UCI\s0 behaviour: the engine will
 577 be allowed to ponder only if it (the engine) declares the \*(L"Ponder\*(R" \s-1UCI\s0
 578 option.  However some engines which can actually ponder do not declare
 579 the option.  This work around lets PolyGlot know that they can ponder.
 580 .IP "\fBSyncStop\fR (default: false)" 4
 581 .IX Item "SyncStop (default: false)"
 582 When a ponder miss occurs, Polyglot interrupts the engine and
 583 \&\s-1IMMEDIATELY\s0 launches a new search.  While there should be no problem
 584 with this, some engines seem confused and corrupt their search board.
 585 \&\*(L"SyncStop\*(R" forces PolyGlot to wait for the (now useless) ponder search
 586 to finish before launching the new search.
 587 .IP "\fBPromoteWorkAround\fR (default: false)" 4
 588 .IX Item "PromoteWorkAround (default: false)"
 589 Some engines do not specify a promotion piece, e.g. they send \*(L"e7e8\*(R"
 590 instead of the correct \*(L"e7e8q\*(R".  This work around enables the
 591 incorrect form (and of course promotes into a queen).
 592 .IP "\fBRepeatPV\fR (default: true)" 4
 593 .IX Item "RepeatPV (default: true)"
 594 When true, PolyGlot repeats the last pv string (which also contains
 595 score,depth and time usage) it got from the engine. Some engines
 596 however do not send a new pv string just before sending the move.
 597 In that case the output of PolyGlot would be inconsistent.
 598 When RepeatPV is false PolyGlot does not repeat the last pv string.
 599 Due to the way kibitzing is implemented, KibitzMove is disabled in that case.
 600 .Sh "[Engine] section"
 601 .IX Subsection "[Engine] section"
 602 This section contains engine \s-1UCI\s0 options.  PolyGlot does not
 603 understand them, but sends the information to the engine at startup
 604 (converted to \s-1UCI\s0 form).  You can add any \s-1UCI\s0 option that makes sense
 605 to the engine (not just the common options about hash-table size and
 606 tablebases).
 607 .PP
 608 \&\s-1NOTE:\s0 use \s-1INI\s0 syntax, not \s-1UCI\s0.  For example \*(L"OwnBook = true\*(R" is
 609 correct.  It will be replaced by PolyGlot with \*(L"setoption name OwnBook
 610 value true\*(R" at engine startup.
 611 .PP
 612 Standard \s-1UCI\s0 options are
 613 .PP
 614 .Vb 4
 615 \&    Hash
 616 \&    NalimovPath
 617 \&    NalimovCache
 618 \&    OwnBook
 619 .Ve
 620 .PP
 621 Hidden options like \*(L"Ponder\*(R" or \*(L"UCI_xxx\*(R" are automatic
 622 and should not be put in an \s-1INI\s0 file.
 623 .PP
 624 The other options are engine\-specific.  Check their name using a \s-1UCI\s0
 625 \&\s-1GUI\s0 or launch the engine in a console and type \*(L"uci\*(R".
 626 .SH "EXAMPLES"
 627 .IX Header "EXAMPLES"
 628 Running the \s-1UCI\s0 engine \*(L"fruit\*(R" under xboard 4.3.15 and later (this invokes PolyGlot internally).
 629 .PP
 630 .Vb 1
 631 \&    xboard \-fcp fruit \-fUCI
 632 .Ve
 633 .PP
 634 An explicit command line for using the \s-1UCI\s0 engine \*(L"fruit\*(R" with 128M hash in xboard with logging enabled (this also works on xboard 4.2.7).
 635 .PP
 636 .Vb 1
 637 \&    xboard \-fcp "polyglot \-noini \-log \-ec fruit \-hash 128"
 638 .Ve
 639 .PP
 640 The equivalent config file would be:
 641 .PP
 642 .Vb 5
 643 \&    [PolyGlot]
 644 \&    EngineCommand = fruit
 645 \&    Log = true
 646 \&    [Engine]
 647 \&    Hash=128
 648 .Ve
 649 .PP
 650 Compile \*(L"games.pgn\*(R" into a book \*(L"book.bin\*(R" retaining all lines of at
 651 most 30 plies.
 652 .PP
 653 .Vb 1
 654 \&    polyglot make\-book \-pgn games.pgn \-bin book.bin \-max\-ply 30
 655 .Ve
 656 .PP
 657 Merge books \*(L"w1.bin\*(R" and \*(L"w2.bin\*(R" into a book \*(L"w.bin\*(R".
 658 .PP
 659 .Vb 1
 660 \&    polyglot merge\-book \-in1 w1.bin \-in2 w2.bin \-out w.bin
 661 .Ve
 662 .PP
 663 Inspect lines for white in \*(L"w.bin\*(R"
 664 .PP
 665 .Vb 1
 666 \&    polyglot dump\-book \-bin w.bin \-color white \-out w_white.txt
 667 .Ve
 668 .PP
 669 Test epd file \*(L"test.epd\*(R" with a (maximum) search time of 7 minutes per position
 670 .PP
 671 .Vb 1
 672 \&    polyglot epd\-test \-epd test.epd \-max\-time 420
 673 .Ve
 674 .SH "EXIT STATUS"
 675 .IX Header "EXIT STATUS"
 676 PolyGlot always returns 0 on exit.
 677 .SH "AUTHORS"
 678 .IX Header "AUTHORS"
 679 Main author: Fabien Letouzey<fabien_letouzey(at)hotmail.com>
 680 .PP
 681 Native Windows port:  Huang Chen<webmaster@elephantbase.net> (\*(L"Morning Yellow\*(R")
 682 .PP
 683 Various enhancements: Fonzy Bleumers<match(at)geenvis.net>
 684 .PP
 685 \&\s-1UCI\s0 port and implementation of new \s-1WB\s0 protocol: Michel Van den Bergh
 686 <michel.vandenbergh(at)uhasselt.be>
 687 .SH "SEE ALSO"
 688 .IX Header "SEE ALSO"
 689 \&\fIxboard\fR\|(6)