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