Alter version number to 2.0.4
[polyglot.git] / polyglot.man
index d50dd54..6a83b53 100644 (file)
@@ -1,4 +1,4 @@
-.\" Automatically generated by Pod::Man 2.1801 (Pod::Simple 3.05)
+.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.07)
 .\"
 .\" Standard preamble:
 .\" ========================================================================
 .\" ========================================================================
 .\"
 .IX Title "POLYGLOT 6"
-.TH POLYGLOT 6 "2010-04-25" "" ""
+.TH POLYGLOT 6 "2015-10-20" "" ""
 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 .\" way too many mistakes in technical documents.
 .if n .ad l
@@ -189,7 +189,7 @@ PolyGlot supports the \*(L"PolyGlot opening book format\*(R". This is the
 defacto standard non-proprietary opening book format. It is fully documented
 here
 .PP
-http://alpha.uhasselt.be/Research/Algebra/Toga/book_format.html
+http://hgm.nubati.net/book_format.html
 .PP
 Roughly speaking a PolyGlot opening book is a collection of triples
 (position, move, weight). A \*(L"position\*(R" is represented by a 64\-bit
@@ -479,13 +479,30 @@ are ignored.
 .IP "\fBResignScore\fR (default: 600)" 4
 .IX Item "ResignScore (default: 600)"
 This is the score in centipawns that will trigger resign \*(L"counting\*(R".
+.IP "\fBQueenNeverResigns\fR (default: true)" 4
+.IX Item "QueenNeverResigns (default: true)"
+Suppresses resigning irrespective of the score,
+as long as the engine still has a Queen (hoping for a perpetual).
+.IP "\fBHandleDraws\fR (default: false)" 4
+.IX Item "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.
+.IP "\fBContemptScore\fR (default: 30)" 4
+.IX Item "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.
 .IP "\fBShowPonder\fR (default: true)" 4
 .IX Item "ShowPonder (default: true)"
 Show search information during engine pondering.  Turning this off
 might be better for interactive use in some interfaces.
+.IP "\fBShowTbHits\fR (default: false)" 4
+.IX Item "ShowTbHits (default: false)"
+Reports extra info on selective depth, search speed (knps) and
+tablebase hits at the beginning of the \s-1PV\s0 field in the thinking output
+of WinBoard protocol, just before the real \s-1PV\s0.
 .IP "\fBScoreWhite\fR (default: true)" 4
 .IX Item "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...).
 .IP "\fBKibitzMove\fR (default: false)" 4
 .IX Item "KibitzMove (default: false)"
 Whether to kibitz when playing a move.
@@ -509,9 +526,11 @@ many seconds before doing the next kibitz.
 .IP "\fB\s-1UCI\s0\fR (default: false)" 4
 .IX Item "UCI (default: false)"
 If true PolyGlot will not understand xboard commands.
-.IP "\fBMateScore\fR (default: 10000)" 4
-.IX Item "MateScore (default: 10000)"
+.IP "\fBMateScore\fR (default: 0)" 4
+.IX Item "MateScore (default: 0)"
 Mate score reported to \s-1GUI\s0 when in xboard mode.
+When set to 0 it uses the new \s-1CECP\s0 convention of reporting 100000 + N
+for mate in N moves, and \-(100000 + N) for mated in N.
 .IP "\fBBook\fR (default: false)" 4
 .IX Item "Book (default: false)"
 Indicates whether a PolyGlot book should be used.  This has no effect
@@ -533,8 +552,16 @@ Select moves according to their weights in the book. If false the move
 with the highest weight is selected.
 .IP "\fBBookLearn\fR (default: false)" 4
 .IX Item "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!
 .IP "\fBBookDepth\fR (default: 256)" 4
 .IX Item "BookDepth (default: 256)"
 Stop using the book after this number of moves.
@@ -556,6 +583,12 @@ Win32 priority levels are mapped in a sensible way to Unix nice levels.
 .IX Item "Affinity (default: -1)"
 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.
+.IP "\fBSTFudge\fR (default: 20)" 4
+.IX Item "STFudge (default: 20)"
+PolyGlot will translate \*(L"st x\*(R" as \*(L"go movetime 1000*x\-STFudge\*(R". 
+The rationale is that in the \s-1UCI\s0 specification the argument of movetime
+is defined as the exact search time whereas the argument of the
+st command is only an upperbound.
 .IP "\fBOnlyWbOptions\fR (default: true)" 4
 .IX Item "OnlyWbOptions (default: true)"
 If true then PolyGlot restricts the options it sends to those that
@@ -615,10 +648,13 @@ value true\*(R" at engine startup.
 .PP
 Standard \s-1UCI\s0 options are
 .PP
-.Vb 4
+.Vb 7
 \&    Hash 
 \&    NalimovPath
 \&    NalimovCache
+\&    GaviotaPath
+\&    GaviotaCache
+\&    SyzygyPath
 \&    OwnBook
 .Ve
 .PP