X-Git-Url: http://winboard.nl/cgi-bin?p=polyglot.git;a=blobdiff_plain;f=README;h=b523a6d46d490dc1eb9b1f41cc9639dddc144695;hp=632227770cd8c7c3f1833b181b72fdc5d30e4da0;hb=1087eb7b2d8447adf9a7deb549d4004a87b46b10;hpb=ad2265d4fc54fc9ba99fc606e6174df34bfb4a0f

diff --git a/README b/README
index 6322277..b523a6d 100644
--- a/README
+++ b/README
@@ -23,7 +23,7 @@ SYNOPSIS
 
        polyglot info-book [-bin inputfile] [-exact]
 
-       polyglot dumb-book [-bin inputfile] -color color [-out outputfile]
+       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]
@@ -230,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
@@ -266,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".
@@ -324,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.
 
@@ -340,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.
 
@@ -392,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:
 
@@ -427,9 +433,26 @@ 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 these options is to provide work arounds for
+           xboard/winboard bugs should they arise.  This one 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.
+
+       WbWorkArounds2 (default: false)
+           Old version of Winboard clear the engine output window at depth 1.
+           With this work around PG will send info lines at depth >=2. This
+           may or may not improve the display.
 
        [Engine] section
 
@@ -461,10 +484,19 @@ 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
 
+       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.
 
@@ -494,4 +526,4 @@ SEE ALSO
 
 
 
-                                  2009-01-15                       POLYGLOT(6)
+                                  2009-08-11                       POLYGLOT(6)