version 1.4.68b
[polyglot.git] / polyglot.man
index 51c2dc7..073f19b 100644 (file)
 .\" ========================================================================
 .\"
 .IX Title "POLYGLOT 6"
-.TH POLYGLOT 6 "2009-11-30" "" ""
+.TH POLYGLOT 6 "2012-09-17" "" ""
 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 .\" way too many mistakes in technical documents.
 .if n .ad l
@@ -137,7 +137,7 @@ PolyGlot \-  Winboard protocol to UCI protocol adapter
          \-  a perft counter
 .SH "SYNOPSIS"
 .IX Header "SYNOPSIS"
-polyglot [configfile] [\-noini] [\-ec engine] [\-ed enginedirectory] [\-en enginename] [\-log] [\-lf logfile] [\-hash value] [\-bk book] [\-pg <name>=<value>]* [\-uci <name>=<value>]*
+polyglot [configfile] [\-noini] [\-ec engine] [\-ed enginedirectory] [\-en enginename] [\-log true/false] [\-lf logfile] [\-pg <name>=<value>]* [\-uci <name>=<value>]*
 .PP
 polyglot make-book [\-pgn inputfile] [\-bin outputfile] [\-max\-ply ply] [\-min\-game games] [\-min\-score score] [\-only\-white] [\-only\-black] [\-uniform]
 .PP
@@ -533,8 +533,7 @@ 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.
+This is a noop.
 .IP "\fBBookDepth\fR (default: 256)" 4
 .IX Item "BookDepth (default: 256)"
 Stop using the book after this number of moves.
@@ -556,6 +555,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
@@ -635,20 +640,19 @@ Running the \s-1UCI\s0 engine \*(L"fruit\*(R" under xboard 4.3.15 and later (thi
 \&    xboard \-fcp fruit \-fUCI
 .Ve
 .PP
-An explicit command line for using the \s-1UCI\s0 engine \*(L"fruit\*(R" with 128M hash in xboard with logging enabled (this also works on xboard 4.2.7).
+An explicit command line for using the \s-1UCI\s0 engine \*(L"fruit\*(R" with logging enabled (this works also with older versions of xboard).
 .PP
 .Vb 1
-\&    xboard \-fcp "polyglot \-noini \-log \-ec fruit \-hash 128"
+\&    xboard \-fcp "polyglot \-noini \-log true \-ec fruit"
 .Ve
 .PP
 The equivalent config file would be:
 .PP
-.Vb 5
+.Vb 4
 \&    [PolyGlot]
 \&    EngineCommand = fruit
 \&    Log = true
 \&    [Engine]
-\&    Hash=128
 .Ve
 .PP
 Compile \*(L"games.pgn\*(R" into a book \*(L"book.bin\*(R" retaining all lines of at