X-Git-Url: http://winboard.nl/cgi-bin?a=blobdiff_plain;f=README;h=ab34601df20adc507a42309d97593dc9fc992f5b;hb=learn;hp=9ab6f15024a8d18bd02d3c94a42c118c57b5dd92;hpb=471c4c42e267be298ce20951d5a352acd6b55190;p=polyglot.git

diff --git a/README b/README
index 9ab6f15..ab34601 100644
--- a/README
+++ b/README
@@ -12,8 +12,8 @@ NAME
 
 SYNOPSIS
        polyglot [configfile] [-noini] [-ec engine] [-ed enginedirectory] [-en
-       enginename] [-log] [-lf logfile] [-hash value] [-bk book] [-pg
-       <name>=<value>]* [-uci <name>=<value>]*
+       enginename] [-log true/false] [-lf logfile] [-pg <name>=<value>]* [-uci
+       <name>=<value>]*
 
        polyglot make-book [-pgn inputfile] [-bin outputfile] [-max-ply ply]
        [-min-game games] [-min-score score] [-only-white] [-only-black]
@@ -68,7 +68,7 @@ DESCRIPTION
        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
@@ -346,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.
@@ -376,8 +394,10 @@ CONFIG FILE FORMAT
        UCI (default: false)
            If true PolyGlot will not understand xboard commands.
 
-       MateScore (default: 10000)
-           Mate score reported to GUI when in xboard mode.
+       MateScore (default: 0)
+           Mate score reported to GUI when in xboard mode.  When set to 0 it
+           uses the new CECP convention of reporting 100000 + N for mate in N
+           moves, and -(100000 + N) for mated in N.
 
        Book (default: false)
            Indicates whether a PolyGlot book should be used.  This has no
@@ -399,8 +419,15 @@ CONFIG FILE FORMAT
            move with the highest weight is selected.
 
        BookLearn (default: false)
-           Store learning information in the book (which must be writable).
-           Currently no engine actually uses this information.
+           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.
@@ -425,6 +452,12 @@ CONFIG FILE FORMAT
            This a bit vector in which each bit represents the processors that
            a process is allowed to run on. This option works only on Windows.
 
+       STFudge (default: 20)
+           PolyGlot will translate "st x" as "go movetime 1000*x-STFudge".
+           The rationale is that in the UCI specification the argument of
+           movetime is defined as the exact search time whereas the argument
+           of the st command is only an upperbound.
+
        OnlyWbOptions (default: true)
            If true then PolyGlot restricts the options it sends to those that
            are potentially useful for WinBoard.
@@ -487,6 +520,9 @@ CONFIG FILE FORMAT
            Hash
            NalimovPath
            NalimovCache
+           GaviotaPath
+           GaviotaCache
+           SyzygyPath
            OwnBook
 
        Hidden options like "Ponder" or "UCI_xxx" are automatic and should not
@@ -501,10 +537,10 @@ EXAMPLES
 
            xboard -fcp fruit -fUCI
 
-       An explicit command line for using the UCI engine "fruit" with 128M
-       hash in xboard with logging enabled (this also works on xboard 4.2.7).
+       An explicit command line for using the UCI engine "fruit" with logging
+       enabled (this works also with older versions of xboard).
 
-           xboard -fcp "polyglot -noini -log -ec fruit -hash 128"
+           xboard -fcp "polyglot -noini -log true -ec fruit"
 
        The equivalent config file would be:
 
@@ -512,7 +548,6 @@ EXAMPLES
            EngineCommand = fruit
            Log = true
            [Engine]
-           Hash=128
 
        Compile "games.pgn" into a book "book.bin" retaining all lines of at
        most 30 plies.
@@ -551,4 +586,4 @@ SEE ALSO
 
 
 
-                                  2009-11-30                       POLYGLOT(6)
+                                  2015-10-20                       POLYGLOT(6)