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-01-13" "" ""
 133 .SH "NAME"
 134 PolyGlot \-  Winboard protocol to UCI protocol adapter
 135          \-  book engine for Polyglot books
 136          \-  a collection of utilities for creating opening books
 137          \-  a utility for analyzing epd files
 138          \-  a perft counter
 139 .SH "SYNOPSIS"
 140 .IX Header "SYNOPSIS"
 141 polyglot [configfile]
 142 .PP
 143 polyglot \-ec engine
 144 .PP
 145 polyglot make-book [\-pgn inputfile] [\-bin outputfile] [\-max\-ply ply] [\-min\-game games] [\-min\-score score] [\-only\-white] [\-only\-black] [\-uniform]
 146 .PP
 147 polyglot merge-book \-in1 inputfile1 \-in2 inputfile2 [\-out outputfile]
 148 .PP
 149 polyglot [configfile] epd-test [\-epd inputfile] [\-min\-depth depth] [\-max\-depth depth] [\-max\-time time] [\-depth\-delta delta]
 150 .PP
 151 polyglot perft [\-fen fen] [\-max\-depth depth]
 152 .SH "DESCRIPTION"
 153 .IX Header "DESCRIPTION"
 154 .Sh "PolyGlot as adapter and book engine"
 155 .IX Subsection "PolyGlot as adapter and book engine"
 156 PolyGlot is a \*(L"\s-1UCI\s0 adapter\*(R".  It connects a \s-1GUI\s0 interface (such as
 157 XBoard, Winboard, Arena or Chessbase) to a \s-1UCI\s0 chess engine.
 158 .PP
 159 By specifying an opening book (in PolyGlot book format) chess engines can
 160 transparently use such books.
 161 .PP
 162 PolyGlot understands the two main \s-1GUI\s0 protocols: \s-1UCI\s0 and
 163 xboard. Normally the protocol will be auto detected but this can be
 164 overridden in the configuration file.
 165 .PP
 166 In xboard mode PolyGlot fully translates between the xboard and \s-1UCI\s0 protocols.
 167 In addition it tries to solve known problems with other adapters.
 168 For instance, it detects and reports draws by fifty-move rule,
 169 repetition, etc ... It also supports Chess960.
 170 .PP
 171 When in \s-1UCI\s0 mode PolyGlot mostly passes commands from the \s-1GUI\s0
 172 to the engine and vice versa, except that it will play book moves on
 173 behalf of the engine when the occasion arises.
 174 .PP
 175 The engine options are exported as \s-1UCI\s0 options in \s-1UCI\s0
 176 mode and as \*(L"feature option=\*(R" commands in xboard mode. The latter form
 177 an extension of the xboard protocol as defined by H.G. Muller.
 178 .PP
 179 Options which normally appear in the [PolyGlot] section of the
 180 config file (see below) are exported as options with their name prefixed
 181 by \*(L"Polyglot\*(R". This makes it easy to filter them in the \s-1GUI\s0.
 182 .PP
 183 \&\s-1NOTE:\s0 Not all options are exported, only those that make sense in the
 184 given mode.
 185 .Sh "Book making utilities"
 186 .IX Subsection "Book making utilities"
 187 PolyGlot supports the \*(L"PolyGlot opening book format\*(R". This is the
 188 defacto standard non-proprietary opening book format. It is fully documented
 189 here
 190 .PP
 191 http://alpha.uhasselt.be/Research/Algebra/Toga/book_format.html
 192 .PP
 193 Roughly speaking a PolyGlot opening book is a collection of triples
 194 (position, move, weight). A \*(L"position\*(R" is represented by a 64\-bit
 195 Zobrist hash key. The weight is proportional to the probability the move should
 196 be played.
 197 .PP
 198 Other opening book formats such as ChessBase's .ctg format and Arena's
 199 \&.abk format are undocumented and proprietary. They can only be used
 200 by their own GUIs.
 201 .PP
 202 PolyGlot can compile a pgn file into a binary PolyGlot book and furthermore
 203 it can merge two such binary books into a third one.
 204 .Sh "Epd test mode"
 205 .IX Subsection "Epd test mode"
 206 In epd test mode, PolyGlot will search positions in an epd file and
 207 record the number of times the right best move was found.  The
 208 arguments specify when to stop the search in any given position.
 209 .Sh "Perft counts"
 210 .IX Subsection "Perft counts"
 211 A perft count is the number of legal move sequence in a given position
 212 up to a given depth. PolyGlot can perform such perft counts. It
 213 is however much slower than other more dedicated programs.
 214 .SH "OPTIONS"
 215 .IX Header "OPTIONS"
 216 When invoked without options or with a config file as argument PolyGlot
 217 acts as an adapter. The config file format is documented below.  The
 218 default config file is \*(L"polyglot.ini\*(R".
 219 .PP
 220 When invoked as
 221 .Sh "polyglot \-ec engine"
 222 .IX Subsection "polyglot -ec engine"
 223 PolyGlot simply starts \*(L"engine\*(R" and acts as an adapter. No config file
 224 is used and thus it is expected that all properties will be set by the
 225 \&\s-1GUI\s0.
 226 .PP
 227 When invoked as
 228 .Sh "polyglot make-book"
 229 .IX Subsection "polyglot make-book"
 230 PolyGlot supports the following options
 231 .ie n .IP "\fB\-pgn\fR (default: ""book.pgn"")" 4
 232 .el .IP "\fB\-pgn\fR (default: ``book.pgn'')" 4
 233 .IX Item "-pgn (default: book.pgn)"
 234 Input file in pgn format.
 235 .ie n .IP "\fB\-bin\fR (default: ""book.bin"")" 4
 236 .el .IP "\fB\-bin\fR (default: ``book.bin'')" 4
 237 .IX Item "-bin (default: book.bin)"
 238 Output file in PolyGlot format.
 239 .IP "\fB\-max\-ply\fR (default: 1024)" 4
 240 .IX Item "-max-ply (default: 1024)"
 241 Specifies the maximum ply-depth of lines included in the book.
 242 .IP "\fB\-min\-game\fR (default: 3)" 4
 243 .IX Item "-min-game (default: 3)"
 244 Specifies the minimum number of games that have to contain this move for it to be included in the book.
 245 .IP "\fB\-min\-score\fR (default: 0.0)" 4
 246 .IX Item "-min-score (default: 0.0)"
 247 Specifies the minimum score (or weight) this move should have received for
 248 it to  be included in the book. The score is 2*(wins)+(draws), globally scaled
 249 to fit into 16 bits.
 250 .IP "\fB\-only\-white\fR" 4
 251 .IX Item "-only-white"
 252 Include only moves for white in the book.
 253 .IP "\fB\-only\-black\fR" 4
 254 .IX Item "-only-black"
 255 Include only moves for black in the book.
 256 .IP "\fB\-uniform\fR" 4
 257 .IX Item "-uniform"
 258 Set all weights to 1. In other words, all moves will be selected with
 259 equal probability.
 260 .PP
 261 When invoked
 262 as
 263 .Sh "polyglot merge-book"
 264 .IX Subsection "polyglot merge-book"
 265 PolyGlot supports the following options
 266 .IP "\fB\-in1\fR" 4
 267 .IX Item "-in1"
 268 First input file (in PolyGlot book format).
 269 .IP "\fB\-in2\fR" 4
 270 .IX Item "-in2"
 271 Second input file (in PolyGlot book format).
 272 .IP "\fB\-out\fR (default: out.bin)" 4
 273 .IX Item "-out (default: out.bin)"
 274 Output file (in PolyGlot book format).
 275 .PP
 276 Input files are not symmetrical, \*(L"in1\*(R" has priority over \*(L"in2\*(R". In other
 277 words when a position occurs both in \*(L"in1\*(R" and \*(L"in2\*(R" only the
 278 moves and weights from \*(L"in1\*(R" will be retained in \*(L"out\*(R".
 279 .PP
 280 When invoked as
 281 .Sh "polyglot epd-test"
 282 .IX Subsection "polyglot epd-test"
 283 (possibly with a config file as first argument) PolyGlot supports the following
 284 options
 285 .IP "\fB\-max\-depth\fR (default: 63)" 4
 286 .IX Item "-max-depth (default: 63)"
 287 Unconditionally stop the search when this depth has
 288 been reached.
 289 .IP "\fB\-max\-time\fR (default: 5.0)" 4
 290 .IX Item "-max-time (default: 5.0)"
 291 Unconditionally stop the seach after this amount of time.
 292 .IP "\fB\-depth\-delta\fR (default: 3)" 4
 293 .IX Item "-depth-delta (default: 3)"
 294 Stop the search if the best move has been constant for this many depths,
 295 on condition that the mininal depth and minimal time have been reached.
 296 .IP "\fB\-min\-depth\fR (default: 8)" 4
 297 .IX Item "-min-depth (default: 8)"
 298 Minimal search depth when the search is stopped using \*(L"\-depth\-delta\*(R".
 299 .IP "\fB\-min\-time\fR (default: 1.0)" 4
 300 .IX Item "-min-time (default: 1.0)"
 301 Minimal search time when the search is stopped using \*(L"\-depth\-delta\*(R".
 302 .PP
 303 When invoked as
 304 .Sh "polyglot perft"
 305 .IX Subsection "polyglot perft"
 306 PolyGlot supports the following
 307 options
 308 .IP "\fB\-fen\fR (default: starting position)" 4
 309 .IX Item "-fen (default: starting position)"
 310 Fen at which to start searching.
 311 .IP "\fB\-max\-depth\fR (default: 1)" 4
 312 .IX Item "-max-depth (default: 1)"
 313 Maximum depth to search.
 314 .SH "CONFIG FILE FORMAT"
 315 .IX Header "CONFIG FILE FORMAT"
 316 There should be a different config file for each engine.
 317 .PP
 318 The config file is in the traditional \s-1INI\s0 format.
 319 .PP
 320 .Vb 6
 321 \&    [PolyGLot]
 322 \&    option = value
 323 \&    ...
 324 \&    [Engine]
 325 \&    option = value
 326 \&    ...
 327 .Ve
 328 .PP
 329 Lines starting with \*(L"#\*(R" are ignored.
 330 .PP
 331 \&\s-1NOTE:\s0 There can be spaces in option names or values.  Do not use
 332 quotes. Boolean values are written as \*(L"true\*(R" or \*(L"false\*(R".
 333 .Sh "[PolyGlot] section"
 334 .IX Subsection "[PolyGlot] section"
 335 This section is used by PolyGlot only.  The engine is unaware of these
 336 options.  The list of available options is detailed below.
 337 .IP "\fBEngineName\fR (default: \s-1UCI\s0 name)" 4
 338 .IX Item "EngineName (default: UCI name)"
 339 This is the name that will appear in the \s-1GUI\s0.  It is
 340 cosmetic only.  You can use different names for tweaked versions of
 341 the same engine.
 342 .ie n .IP "\fBEngineDir\fR (default: ""."")" 4
 343 .el .IP "\fBEngineDir\fR (default: ``.'')" 4
 344 .IX Item "EngineDir (default: .)"
 345 Full path of the directory where the engine is installed.  You can use
 346 \&\*(L".\*(R" (without the quotes) if you know that PolyGlot will be launched in
 347 the engine directory or the engine is in the \*(L"path\*(R" and does not need
 348 any data file.
 349 .IP "\fBEngineCommand\fR" 4
 350 .IX Item "EngineCommand"
 351 Put here the name of the engine executable file.  You can also add
 352 command-line arguments.  Path searching is used and the current
 353 directory will be \*(L"EngineDir\*(R".
 354 .IP "\fBLog\fR (default: false)" 4
 355 .IX Item "Log (default: false)"
 356 Whether PolyGlot should log all transactions with the interface and
 357 the engine.  This should be necessary only to locate problems.
 358 .IP "\fBLogFile\fR (default: polyglot.log)" 4
 359 .IX Item "LogFile (default: polyglot.log)"
 360 The name of the log file.  Note that it is put where PolyGlot was
 361 launched from, not into the engine directory.
 362 .Sp
 363 \&\s-1WARNING:\s0 Log files are not cleared between sessions, and can become
 364 very large.  It is safe to remove them though.
 365 .IP "\fBResign\fR (default: false)" 4
 366 .IX Item "Resign (default: false)"
 367 Set this to \*(L"true\*(R" if you want PolyGlot to resign on behalf of the
 368 engine.
 369 .Sp
 370 \&\s-1NOTE:\s0 Some engines display buggy scores from time to time although the
 371 best move is correct.  Use this option only if you know what you are
 372 doing (e.g. you always check the final position of games).
 373 .IP "\fBResignMoves\fR (default: 3)" 4
 374 .IX Item "ResignMoves (default: 3)"
 375 Number of consecutive moves with \*(L"resign\*(R" score (see below) before
 376 PolyGlot resigns for the engine.  Positions with only one legal move
 377 are ignored.
 378 .IP "\fBResignScore\fR (default: 600)" 4
 379 .IX Item "ResignScore (default: 600)"
 380 This is the score in centipawns that will trigger resign \*(L"counting\*(R".
 381 .IP "\fBShowPonder\fR (default: true)" 4
 382 .IX Item "ShowPonder (default: true)"
 383 Show search information during engine pondering.  Turning this off
 384 might be better for interactive use in some interfaces.
 385 .IP "\fBKibitzMove\fR (default: false)" 4
 386 .IX Item "KibitzMove (default: false)"
 387 Whether to kibitz when playing a move.
 388 .IP "\fBKibitzPV\fR (default: false)" 4
 389 .IX Item "KibitzPV (default: false)"
 390 Whether to kibitz when the \s-1PV\s0 is changed (new iteration or new best move).
 391 .ie n .IP "\fBKibitzCommand\fR (default: ""tellall"")" 4
 392 .el .IP "\fBKibitzCommand\fR (default: ``tellall'')" 4
 393 .IX Item "KibitzCommand (default: tellall)"
 394 xboard command to use for kibitzing, normally \*(L"tellall\*(R" for kibitzing
 395 or \*(L"tellothers\*(R" for whispering.
 396 .IP "\fBKibitzDelay\fR (default: 5)" 4
 397 .IX Item "KibitzDelay (default: 5)"
 398 How many seconds to wait before starting kibitzing.  This has an
 399 effect only if \*(L"KibitzPV\*(R" is selected, move kibitzes are always sent
 400 regardless of the delay.
 401 .IP "\fB\s-1UCI\s0\fR (default: false)" 4
 402 .IX Item "UCI (default: false)"
 403 If true PolyGlot will not understand xboard commands.
 404 .IP "\fBChess960\fR (default: false)" 4
 405 .IX Item "Chess960 (default: false)"
 406 Play Chess960 (also called Fischer Random Chess or \s-1FRC\s0),
 407 .IP "\fBMateScore\fR (default: 10000)" 4
 408 .IX Item "MateScore (default: 10000)"
 409 Mate score reported to \s-1GUI\s0 when in xboard mode.
 410 .IP "\fBBook\fR (default: false)" 4
 411 .IX Item "Book (default: false)"
 412 Indicates whether a PolyGlot book should be used.  This has no effect
 413 on the engine own book (which can be controlled with the \s-1UCI\s0 option
 414 \&\*(L"OwnBook\*(R" in the [Engine] section).  In particular, it is possible to
 415 use both a PolyGlot book and an engine book.  In that case, the engine
 416 book will be used whenever PolyGlot is out of book.  Remember that
 417 PolyGlot is unaware of whether the engine is itself using a book or
 418 not.
 419 .IP "\fBBookFile\fR (default: book.bin)" 4
 420 .IX Item "BookFile (default: book.bin)"
 421 The name of the (binary) book file.  Note that PolyGlot will look for
 422 it in the directory it was launched from, not in the engine directory.
 423 Of course, full path can be used in which case the current directory
 424 does not matter.
 425 .IP "\fBBookRandom\fR (default: true)" 4
 426 .IX Item "BookRandom (default: true)"
 427 Select moves according to their weights in the book. If false the move
 428 with the highest weight is selected.
 429 .IP "\fBBookLearn\fR (default: false)" 4
 430 .IX Item "BookLearn (default: false)"
 431 Record learning information in the opening book. Naturally this requires
 432 the opening book to be writable.
 433 .IP "\fBUseNice\fR (default: false)" 4
 434 .IX Item "UseNice (default: false)"
 435 Run the engine at nice level 5, or \*(L"NiceValue\*(R" if it set.  On some
 436 operating systems it may be necessary to run the engine at lower
 437 priority for it to be responsive to commands from PolyGlot while
 438 searching.
 439 .IP "\fBNiceValue\fR (default: 5)" 4
 440 .IX Item "NiceValue (default: 5)"
 441 Nice levels go from \-20 to 20 with 20 being the lowest priority.
 442 On Unix only root can set negative nice levels. On Windows the standard
 443 Win32 priority levels are mapped in a sensible way to Unix nice levels.
 444 .IP "\fBAffinity\fR (default: \-1)" 4
 445 .IX Item "Affinity (default: -1)"
 446 This a bit vector in which each bit represents the processors that a
 447 process is allowed to run on. This option works only on Windows.
 448 .Sh "Work arounds"
 449 .IX Subsection "Work arounds"
 450 Work arounds are identical to options except that they should be used
 451 only when necessary.  Their purpose is to try to hide problems with
 452 various software (not just engines).  The default value is always
 453 correct for bug-free software.
 454 .PP
 455 \&\s-1IMPORTANT:\s0 Any of these work arounds might be removed in future
 456 versions of PolyGlot.  You are strongly recommended to contact the
 457 author of faulty software and truly fix the problem.
 458 .PP
 459 PolyGlot supports the following work arounds:
 460 .IP "\fBUCIVersion\fR (default: 2)" 4
 461 .IX Item "UCIVersion (default: 2)"
 462 The default value of 2 corresponds to \s-1UCI+\s0.  Use 1 to select plain
 463 \&\s-1UCI\s0 for engines that have problems with \s-1UCI+\s0.
 464 .IP "\fBCanPonder\fR (default: false)" 4
 465 .IX Item "CanPonder (default: false)"
 466 PolyGlot now conforms to the documented \s-1UCI\s0 behaviour: the engine will
 467 be allowed to ponder only if it (the engine) declares the \*(L"Ponder\*(R" \s-1UCI\s0
 468 option.  However some engines which can actually ponder do not declare
 469 the option.  This work around lets PolyGlot know that they can ponder.
 470 .IP "\fBSyncStop\fR (default: false)" 4
 471 .IX Item "SyncStop (default: false)"
 472 When a ponder miss occurs, Polyglot interrupts the engine and
 473 \&\s-1IMMEDIATELY\s0 launches a new search.  While there should be no problem
 474 with this, some engines seem confused and corrupt their search board.
 475 \&\*(L"SyncStop\*(R" forces PolyGlot to wait for the (now useless) ponder search
 476 to finish before launching the new search.
 477 .IP "\fBPromoteWorkAround\fR (default: false)" 4
 478 .IX Item "PromoteWorkAround (default: false)"
 479 Some engines do not specify a promotion piece, e.g. they send \*(L"e7e8\*(R"
 480 instead of the correct \*(L"e7e8q\*(R".  This work around enables the
 481 incorrect form (and of course promotes into a queen).
 482 .IP "\fBRepeatPV\fR (default: true)" 4
 483 .IX Item "RepeatPV (default: true)"
 484 When true, PolyGlot repeats the last pv string (which also contains
 485 score,depth and time usage) it got from the engine. Some engines
 486 however do not send a new pv string just before sending the move and
 487 the now old pv string might confuse debugtools that parse the winboard
 488 debug files.
 489 .Sh "[Engine] section"
 490 .IX Subsection "[Engine] section"
 491 This section contains engine \s-1UCI\s0 options.  PolyGlot does not
 492 understand them, but sends the information to the engine at startup
 493 (converted to \s-1UCI\s0 form).  You can add any \s-1UCI\s0 option that makes sense
 494 to the engine (not just the common options about hash-table size and
 495 tablebases).
 496 .PP
 497 \&\s-1NOTE:\s0 use \s-1INI\s0 syntax, not \s-1UCI\s0.  For example \*(L"OwnBook = true\*(R" is
 498 correct.  It will be replaced by PolyGlot with \*(L"setoption name OwnBook
 499 value true\*(R" at engine startup.
 500 .PP
 501 Standard \s-1UCI\s0 options are
 502 .PP
 503 .Vb 4
 504 \&    Hash
 505 \&    NalimovPath
 506 \&    NalimovCache
 507 \&    OwnBook
 508 .Ve
 509 .PP
 510 Hidden options like \*(L"Ponder\*(R" or \*(L"UCI_xxx\*(R" are automatic
 511 and should not be put in an \s-1INI\s0 file.
 512 .PP
 513 The other options are engine\-specific.  Check their name using a \s-1UCI\s0
 514 \&\s-1GUI\s0 or launch the engine in a console and type \*(L"uci\*(R".
 515 .SH "EXAMPLES"
 516 .IX Header "EXAMPLES"
 517 Compile \*(L"games.pgn\*(R" into a book \*(L"book.bin\*(R" retaining all lines of at
 518 most 30 plies.
 519 .PP
 520 .Vb 1
 521 \&    polyglot make\-book \-pgn games.pgn \-bin book.bin \-max\-ply 30
 522 .Ve
 523 .PP
 524 Merge books \*(L"in1.bin\*(R" and \*(L"in2.bin\*(R" into a book \*(L"out.bin\*(R".
 525 .PP
 526 .Vb 1
 527 \&    polyglot merge\-book \-in1 w1.bin \-in2 w2.bin \-out w.bin
 528 .Ve
 529 .PP
 530 Here is a minimal config file
 531 .PP
 532 .Vb 3
 533 \&    [PolyGlot]
 534 \&    EngineCommand = fruit
 535 \&    [Engine]
 536 .Ve
 537 .SH "EXIT STATUS"
 538 .IX Header "EXIT STATUS"
 539 PolyGlot always returns 0 on exit.
 540 .SH "AUTHORS"
 541 .IX Header "AUTHORS"
 542 Main author: Fabien Letouzey<fabien_letouzey(at)hotmail.com>
 543 .PP
 544 Native Windows port:  Huang Chen<webmaster@elephantbase.net> (\*(L"Morning Yellow\*(R")
 545 .PP
 546 Various enhancements: Fonzy Bleumers<match(at)geenvis.net>
 547 .PP
 548 \&\s-1UCI\s0 port: Michel Van den Bergh <michel.vandenbergh(at)uhasselt.be>
 549 .SH "SEE ALSO"
 550 .IX Header "SEE ALSO"
 551 \&\fIxboard\fR\|(6)