Alter version number to 2.0.4

[polyglot.git] / polyglot.pod

diff --git a/polyglot.pod b/polyglot.pod
index c78fc6e..8ad01d2 100644 (file)
--- a/polyglot.pod
+++ b/polyglot.pod
@@ -62,7 +62,7 @@ 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
@@ -387,10 +387,19 @@ to wordexp so that shell quoting rules and expansions are applied.
 On Windows the EngineCommand is simply passed to CreateProcess which
 does its own shell like processing.
 
+=item B<Save>
+
+=item B<SettingsFile> (default: polyglot.ini)
+
+The SettingsFile option redefines the name of Polyglot's config file,
+so future use of the interactive "Polyglot Save" option can save
+interactively (i.e. through the GUI interface) changed settings
+to another file as from which the settings were originally read.
+
 =item B<SettingsDir> (default: $HOME/.polyglot on Linux; ".\_PG" on Windows)
 
 The directory where ini files are stored for engines that are started with
--noini. Such ini files may be created by pushing the "Save" button in the
+-noini. Such ini files may be created by pushing the "Polyglot Save" button in the
 Engine settings dialog in WB/XB 4.4.0 and higher. As a special exception
 (for WB/XB 4.4.0 compatibility) this directory is also used in case
 PolyGlot is started with config files named "polyglot_1st.ini" or
@@ -428,14 +437,35 @@ are ignored.
 
 This is the score in centipawns that will trigger resign "counting".
 
+=item B<QueenNeverResigns> (default: true)
+
+Suppresses resigning irrespective of the score,
+as long as the engine still has a Queen (hoping for a perpetual).
+
+=item B<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.
+
+=item B<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.
+
 =item B<ShowPonder> (default: true)
 
 Show search information during engine pondering.  Turning this off
 might be better for interactive use in some interfaces.
 
+=item B<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.
+
 =item B<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...).
 
 =item B<KibitzMove> (default: false)
 
@@ -465,9 +495,11 @@ many seconds before doing the next kibitz.
 
 If true PolyGlot will not understand xboard commands. 
 
-=item B<MateScore> (default: 10000)
+=item B<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.
 
 =item B<Book> (default: false)
 
@@ -493,8 +525,16 @@ with the highest weight is selected.
 
 =item B<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!
 
 =item B<BookDepth> (default: 256)
 
@@ -523,6 +563,13 @@ Win32 priority levels are mapped in a sensible way to Unix nice levels.
 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. 
 
+=item B<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. 
+
 =item B<OnlyWbOptions> (default: true)
 
 If true then PolyGlot restricts the options it sends to those that
@@ -599,6 +646,9 @@ Standard UCI options are
     Hash 
     NalimovPath
     NalimovCache
+    GaviotaPath
+    GaviotaCache
+    SyzygyPath
     OwnBook
 
 Hidden options like "Ponder" or "UCI_xxx" are automatic