X-Git-Url: http://winboard.nl/cgi-bin?p=polyglot.git;a=blobdiff_plain;f=README;h=df31a94386870d8172da267e32f911c299e0572f;hp=0b313e9812733e21e6fe96041c9413995a636874;hb=acb140befabd8b0f1a8606470013b420d05b4fb7;hpb=e7a2abd9bd4fce9ebbd70793b00d9d5f99886348 diff --git a/README b/README index 0b313e9..df31a94 100644 --- a/README +++ b/README @@ -5,7 +5,8 @@ POLYGLOT(6) POLYGLOT(6) NAME PolyGlot - Winboard protocol to UCI protocol adapter - book engine for Polyglot books - - a collection of utilities for creating opening books + - a collection of utilities for creating and analyzing open- + ing books - a utility for analyzing epd files - a perft counter @@ -20,6 +21,10 @@ SYNOPSIS polyglot merge-book -in1 inputfile1 -in2 inputfile2 [-out outputfile] + polyglot info-book [-bin inputfile] [-exact] + + polyglot dump-book [-bin inputfile] -color color [-out outputfile] + polyglot [configfile] epd-test [-epd inputfile] [-min-depth depth] [-max-depth depth] [-max-time time] [-depth-delta delta] @@ -78,6 +83,33 @@ DESCRIPTION PolyGlot can compile a pgn file into a binary PolyGlot book and fur- thermore it can merge two such binary books into a third one. + PolyGlot can also extract some useful information from PolyGlot books. + The utility "dump-book" dumps the "lines" in a book for a given color. + By definition a line is a sequence of moves (from the starting posi- + tion) in which the given color makes only book moves and the other + color makes arbitrary moves (i.e. not necessarily book moves). + + Since a PolyGlot book is built up from positions and not lines there + may be (and there usually are) many positions in the book that are not + on a "line" as defined in the previous paragraph. It is convenient to + call such positions "isolated" positions. The utility "info-book" + counts such isolated positions. + + Some of the isolated positions are provably unreachable and they could + in principle be deleted from the book. For example if a book contains + only the move "e4" in the starting position but also the position after + "d4 d5" then this last position is provably unreachable since it + requires white to make a non-book move when a book move is available. + Such situations arise frequently from the priority rules in merging + books. + + Unfortunately not all isolated positions are provably unreachable and + it is difficult to identify the latter. If invoked with "-exact" the + utility info-book will attempt to count the isolated positions which + require a player to make a non-book move when a book move is available. + Due to the possibility of transpositions this is not a fool proof + method. + Epd test mode In epd test mode, PolyGlot will search positions in an epd file and @@ -158,6 +190,34 @@ OPTIONS When invoked as + polyglot dump-book + + PolyGlot supports the following options + + -bin (default: book.bin) + Input file in PolyGlot book format. + + -color + The color for whom to generate the lines. + + -out (default: book_.txt) + The name of the output file. + + When invoked as + + polyglot info-book + + PolyGlot supports the following options + + -bin (default: book.bin) + Input file in PolyGlot book format. + + -exact + Attempt to count the provably unreachable positions among the iso- + lated ones. Note that this takes a very long time. + + When invoked as + polyglot epd-test (possibly with a config file as first argument) PolyGlot supports the @@ -170,9 +230,9 @@ OPTIONS Unconditionally stop the seach after this amount of time. -depth-delta (default: 3) - Stop the search if the best move has been constant for this many - depths, on condition that the mininal depth and minimal time have - been reached. + Stop the search if the solution as been found and the best move has + been constant for this many depths, on condition that the mininal + depth and minimal time have been reached. -min-depth (default: 8) Minimal search depth when the search is stopped using @@ -206,7 +266,7 @@ CONFIG FILE FORMAT option = value ... - Lines starting with "#" are ignored. + The characters "#" and ";" serve as comment characters. NOTE: There can be spaces in option names or values. Do not use quotes. Boolean values are written as "true" or "false". @@ -264,6 +324,9 @@ CONFIG FILE FORMAT Show search information during engine pondering. Turning this off might be better for interactive use in some interfaces. + ScoreWhite (default: true) + Report score from white's point of view in xboard mode. + KibitzMove (default: false) Whether to kibitz when playing a move. @@ -280,6 +343,10 @@ CONFIG FILE FORMAT effect only if "KibitzPV" is selected, move kibitzes are always sent regardless of the delay. + KibitzInterval (default: 0) + This is another form of throttling. PolyGlot will usually wait this + many seconds before doing the next kibitz. + UCI (default: false) If true PolyGlot will not understand xboard commands. @@ -332,12 +399,11 @@ CONFIG FILE FORMAT Work arounds are identical to options except that they should be used only when necessary. Their purpose is to try to hide problems with - various software (not just engines). The default value is always cor- - rect for bug-free software. + various software (not just engines). - IMPORTANT: Any of these work arounds might be removed in future ver- - sions of PolyGlot. You are strongly recommended to contact the author - of faulty software and truly fix the problem. + IMPORTANT: Any of these work arounds might be removed in future + versions of PolyGlot. You are strongly recommended to contact the + author of faulty software and truly fix the problem. PolyGlot supports the following work arounds: @@ -367,9 +433,21 @@ CONFIG FILE FORMAT RepeatPV (default: true) When true, PolyGlot repeats the last pv string (which also contains score,depth and time usage) it got from the engine. Some engines - however do not send a new pv string just before sending the move - and the now old pv string might confuse debugtools that parse the - winboard debug files. + however do not send a new pv string just before sending the move. + In that case the output of PolyGlot would be inconsistent. When + RepeatPV is false PolyGlot does not repeat the last pv string. Due + to the way kibitzing is implemented, KibitzMove is disabled in that + case. + + WbWorkArounds (default: true) + The intention of this option is to provide work arounds for + xboard/winboard bugs should they arise. Currently it decapitalizes + the word Draw in options that contain this word. Some versions of + xboard/winboard contain a bug which causes such options to be + interpreted as draw claims by the engine. + + Engines that send options with "Draw" in their name are Rybka and + HIARCS. [Engine] section @@ -401,11 +479,25 @@ EXAMPLES polyglot make-book -pgn games.pgn -bin book.bin -max-ply 30 - Merge books "in1.bin" and "in2.bin" into a book "out.bin". + Merge books "w1.bin" and "w2.bin" into a book "w.bin". polyglot merge-book -in1 w1.bin -in2 w2.bin -out w.bin - Here is a minimal config file + Inspect lines for white in "w.bin" + + polyglot dump-book -bin w.bin -color white -out w_white.txt + + Test epd file "test.epd" with a (maximum) search time of 7 minutes per + position + + polyglot epd-test -epd test.epd -max-time 420 + + The command line for using the UCI engine "fruit" in a GUI which uses + the xboard protocol. + + polyglot -ec fruit + + The equivalent config file: [PolyGlot] EngineCommand = fruit @@ -429,4 +521,4 @@ SEE ALSO - 2009-01-13 POLYGLOT(6) + 2009-08-07 POLYGLOT(6)