version 1.4.35b
[polyglot.git] / polyglot.pod
index 0024cd1..285e9b1 100644 (file)
@@ -18,7 +18,7 @@ polyglot merge-book -in1 inputfile1 -in2 inputfile2 [-out outputfile]
 
 polyglot info-book [-bin inputfile] [-exact]
 
-polyglot dumb-book [-bin inputfile] -color color [-out outputfile]
+polyglot dump-book [-bin inputfile] -color color [-out outputfile]
 
 polyglot [configfile] epd-test [-epd inputfile] [-min-depth depth] [-max-depth depth] [-max-time time] [-depth-delta delta] 
 
@@ -265,8 +265,9 @@ Unconditionally stop the seach after this amount of time.
 
 =item B<-depth-delta> (default: 3)
 
-Stop the search if the best move has been constant for this many depths,
-on condition that the mininal depth and minimal time have been reached.
+Stop the search if the solution as been found and the best move has
+been constant for this many depths, on condition that the mininal
+depth and minimal time have been reached.
 
 =item B<-min-depth> (default: 8)
 
@@ -311,7 +312,7 @@ The config file is in the traditional INI format.
     option = value
     ...
 
-Lines starting with "#" are ignored.
+The characters "#" and ";" serve as comment characters. 
 
 NOTE: There can be spaces in option names or values.  Do not use
 quotes. Boolean values are written as "true" or "false". 
@@ -379,6 +380,10 @@ This is the score in centipawns that will trigger resign "counting".
 Show search information during engine pondering.  Turning this off
 might be better for interactive use in some interfaces.
 
+=item B<ScoreWhite> (default: true)
+
+Report score from white's point of view in xboard mode.
+
 =item B<KibitzMove> (default: false)
 
 Whether to kibitz when playing a move.
@@ -392,13 +397,17 @@ Whether to kibitz when the PV is changed (new iteration or new best move).
 xboard command to use for kibitzing, normally "tellall" for kibitzing
 or "tellothers" for whispering.
 
-
 =item B<KibitzDelay> (default: 5)
 
 How many seconds to wait before starting kibitzing.  This has an
 effect only if "KibitzPV" is selected, move kibitzes are always sent
 regardless of the delay.
 
+=item B<KibitzInterval> (default: 0)
+
+This is another form of throttling. PolyGlot will usually wait this
+many seconds before doing the next kibitz. 
+
 =item B<UCI> (default: false)
 
 If true PolyGlot will not understand xboard commands. 
@@ -464,8 +473,7 @@ process is allowed to run on. This option works only on Windows.
 
 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).  The default value is always
-correct for bug-free software.
+various software (not just engines).  
 
 IMPORTANT: Any of these work arounds might be removed in future
 versions of PolyGlot.  You are strongly recommended to contact the
@@ -505,10 +513,20 @@ incorrect form (and of course promotes into a queen).
 
 When true, PolyGlot repeats the last pv string (which also contains
 score,depth and time usage) it got from the engine. Some engines
-however do not send a new pv string just before sending the move and
-the now old pv string might confuse debugtools that parse the winboard
-debug files.
+however do not send a new pv string just before sending the move.
+In that case the output of PolyGlot would be inconsistent. 
+When RepeatPV is false PolyGlot does not repeat the last pv string.
+Due to the way kibitzing is implemented, KibitzMove is disabled in that case. 
+
+=item B<WbWorkArounds> (default: true)
 
+The intention of this option is to provide work arounds for
+xboard/winboard bugs should they arise.  Currently it decapitalizes
+the word Draw in options that contain this word. Some versions of
+xboard/winboard contain a bug which causes such options to be
+interpreted as draw claims by the engine.
+
+Engines that send options with "Draw" in their name are Rybka and HIARCS. 
 
 =back
 
@@ -545,10 +563,18 @@ most 30 plies.
 
     polyglot make-book -pgn games.pgn -bin book.bin -max-ply 30
 
-Merge books "in1.bin" and "in2.bin" into a book "out.bin".
+Merge books "w1.bin" and "w2.bin" into a book "w.bin".
 
     polyglot merge-book -in1 w1.bin -in2 w2.bin -out w.bin
 
+Inspect lines for white in "w.bin"
+
+    polyglot dump-book -bin w.bin -color white -out w_white.txt
+
+Test epd file "test.epd" with a (maximum) search time of 7 minutes per position
+
+    polyglot epd-test -epd test.epd -max-time 420
+
 The command line for using the UCI engine "fruit" in a GUI which uses the
 xboard protocol.