version 1.4.37b
[polyglot.git] / README
diff --git a/README b/README
index 58c4006..ed905e6 100644 (file)
--- 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]
@@ -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.
 
@@ -368,9 +375,16 @@ CONFIG FILE FORMAT
            Select moves according to their weights in the book. If false the
            move with the highest weight is selected.
 
-       BookLearn (default: false)
-           Record learning information in the opening book. Naturally this
-           requires the opening book to be writable.
+       BookRandom (default: true)
+           Select moves according to their weights in the book. If false the
+           move with the highest weight is selected.
+
+       BookDepth (default: 256)
+           Stop using the book after this number of moves.
+
+       BookTreshold (default: 5)
+           Do not play moves with a weight (probability) lower than this (in
+           per mil).
 
        UseNice (default: false)
            Run the engine at nice level 5, or "NiceValue" if it set.  On some
@@ -392,8 +406,7 @@ 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
@@ -427,9 +440,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
 
@@ -503,4 +533,4 @@ SEE ALSO
 
 
 
-                                  2009-01-16                       POLYGLOT(6)
+                                  2009-08-13                       POLYGLOT(6)