Update ChageLog and README
[polyglot.git] / README
diff --git a/README b/README
index 339c1f4..3ea6a20 100644 (file)
--- a/README
+++ b/README
@@ -32,8 +32,7 @@ SYNOPSIS
        polyglot perft [-fen fen] [-max-depth depth]
 
 DESCRIPTION
-       PolyGlot as adapter and book engine
-
+   PolyGlot as adapter and book engine
        PolyGlot is a "UCI adapter".  It connects a GUI interface (such as
        XBoard, Winboard, Arena or Chessbase) to a UCI chess engine.
 
@@ -64,13 +63,12 @@ DESCRIPTION
        NOTE: Not all options are exported, only those that make sense in the
        given mode.
 
-       Book making utilities
-
+   Book making utilities
        PolyGlot supports the "PolyGlot opening book format". This is the
        defacto standard non-proprietary opening book format. It is fully
        documented here
 
-       http://alpha.uhasselt.be/Research/Algebra/Toga/book_format.html
+       http://hgm.nubati.net/book_format.html
 
        Roughly speaking a PolyGlot opening book is a collection of triples
        (position, move, weight). A "position" is represented by a 64-bit
@@ -111,14 +109,12 @@ DESCRIPTION
        Due to the possibility of transpositions this is not a fool proof
        method.
 
-       Epd test mode
-
+   Epd test mode
        In epd test mode, PolyGlot will search positions in an epd file and
        record the number of times the right best move was found.  The
        arguments specify when to stop the search in any given position.
 
-       Perft counts
-
+   Perft counts
        A perft count is the number of legal move sequence in a given position
        up to a given depth. PolyGlot can perform such perft counts. It is
        however much slower than other more dedicated programs.
@@ -159,8 +155,7 @@ OPTIONS
 
        When invoked as
 
-       polyglot make-book
-
+   polyglot make-book
        PolyGlot supports the following options
 
        -pgn (default: "book.pgn")
@@ -193,8 +188,7 @@ OPTIONS
 
        When invoked as
 
-       polyglot merge-book
-
+   polyglot merge-book
        PolyGlot supports the following options
 
        -in1
@@ -212,8 +206,7 @@ OPTIONS
 
        When invoked as
 
-       polyglot dump-book
-
+   polyglot dump-book
        PolyGlot supports the following options
 
        -bin (default: book.bin)
@@ -227,8 +220,7 @@ OPTIONS
 
        When invoked as
 
-       polyglot info-book
-
+   polyglot info-book
        PolyGlot supports the following options
 
        -bin (default: book.bin)
@@ -240,8 +232,7 @@ OPTIONS
 
        When invoked as
 
-       polyglot epd-test
-
+   polyglot epd-test
        (possibly with a config file as first argument) PolyGlot supports
        besides the generic options described above the following additional
        options.
@@ -267,8 +258,7 @@ OPTIONS
 
        When invoked as
 
-       polyglot perft
-
+   polyglot perft
        PolyGlot supports the following options
 
        -fen (default: starting position)
@@ -297,8 +287,7 @@ CONFIG FILE FORMAT
        "Quoting" other characters in this way has no effect. In particular the
        use of '\' as a path separator in windows should normally not affected.
 
-       [PolyGlot] section
-
+   [PolyGlot] section
        This section is used by PolyGlot only.  The engine is unaware of these
        options.  The list of available options is detailed below.
 
@@ -357,12 +346,30 @@ CONFIG FILE FORMAT
            This is the score in centipawns that will trigger resign
            "counting".
 
+       QueenNeverResigns (default: true)
+           Suppresses resigning irrespective of the score, as long as the
+           engine still has a Queen (hoping for a perpetual).
+
+       HandleDraws (default: false)
+           When set Polyglot can accept draw offers on behalf of the engine,
+           when the last reported engine score is below Polyglot's contempt.
+
+       ContemptScore (default: 30)
+           This is the score in centipawns that the engine must minimally see
+           in its own disadvantage before Polyglot will accept a draw offer.
+
        ShowPonder (default: true)
            Show search information during engine pondering.  Turning this off
            might be better for interactive use in some interfaces.
 
+       ShowTbHits (default: false)
+           Reports extra info on selective depth, search speed (knps) and
+           tablebase hits at the beginning of the PV field in the thinking
+           output of WinBoard protocol, just before the real PV.
+
        ScoreWhite (default: true)
-           Report score from white's point of view in xboard mode.
+           Report score from white's point of view in xboard mode. (Wrecks
+           XBoard...).
 
        KibitzMove (default: false)
            Whether to kibitz when playing a move.
@@ -410,7 +417,15 @@ CONFIG FILE FORMAT
            move with the highest weight is selected.
 
        BookLearn (default: false)
-           This is a noop.
+           Switches on updating of the 'learn fields' of the opening book,
+           which for each move record the number of times the move was played,
+           and the number of half-points scored with it.  It also switches on
+           making use of this information already in the book, for altering
+           the move-selection probabilities from those specified by the book
+           weights.  (Rarely played moves will be favored, moves with a
+           significant poor performance will be shunned.)  This option must be
+           set before the book is specified, or the updating of the learn info
+           will not work!
 
        BookDepth (default: 256)
            Stop using the book after this number of moves.
@@ -445,8 +460,7 @@ CONFIG FILE FORMAT
            If true then PolyGlot restricts the options it sends to those that
            are potentially useful for WinBoard.
 
-       Work arounds
-
+   Work arounds
        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).
@@ -489,8 +503,7 @@ CONFIG FILE FORMAT
            to the way kibitzing is implemented, KibitzMove is disabled in that
            case.
 
-       [Engine] section
-
+   [Engine] section
        This section contains engine UCI options.  PolyGlot does not understand
        them, but sends the information to the engine at startup (converted to
        UCI form).  You can add any UCI option that makes sense to the engine
@@ -505,6 +518,9 @@ CONFIG FILE FORMAT
            Hash
            NalimovPath
            NalimovCache
+           GaviotaPath
+           GaviotaCache
+           SyzygyPath
            OwnBook
 
        Hidden options like "Ponder" or "UCI_xxx" are automatic and should not
@@ -568,4 +584,4 @@ SEE ALSO
 
 
 
-                                  2011-06-01                       POLYGLOT(6)
+                                  2014-09-08                       POLYGLOT(6)