Add forgotten files 1.4.70b

[polyglot.git] / polyglot.pod

diff --git a/polyglot.pod b/polyglot.pod
index 7d3a15d..9ebf8bf 100644 (file)
--- a/polyglot.pod
+++ b/polyglot.pod
@@ -8,7 +8,7 @@ PolyGlot -  Winboard protocol to UCI protocol adapter
 
 =head1 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>]*
 
 polyglot make-book [-pgn inputfile] [-bin outputfile] [-max-ply ply] [-min-game games] [-min-score score] [-only-white] [-only-black] [-uniform]
 
@@ -351,10 +351,12 @@ The config file is in the traditional INI format.
 
 The characters "#" and ";" serve as comment characters. 
 
-By default initial and final white space is stripped from option
-values. If you want to avoid this, or if you want use one of
-the comment characters # or ; in option values (such as for NalimovPath), 
-enclose the value in quotes.
+Initial and final white space is stripped from option names and
+values. If you need to use characters which have a special meaning to
+PolyGlot (these are ';#[]=\') you should quote them by preceding them
+with '\'. "Quoting" other characters in this way has no effect. In
+particular the use of '\' as a path separator in windows should
+normally not affected.
 
 =head2 [PolyGlot] section
 
@@ -380,7 +382,10 @@ any data file.
 
 Put here the name of the engine executable file.  You can also add
 command-line arguments.  Path searching is used and the current
-directory will be "EngineDir".
+directory will be "EngineDir". On Linux the EngineCommand is passed
+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<SettingsDir> (default: $HOME/.polyglot on Linux; ".\_PG" on Windows)
 
@@ -488,8 +493,7 @@ 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. 
+This is a noop.
 
 =item B<BookDepth> (default: 256)
 
@@ -518,6 +522,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
@@ -608,9 +619,9 @@ Running the UCI engine "fruit" under xboard 4.3.15 and later (this invokes PolyG
 
     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:
 
@@ -618,7 +629,6 @@ The equivalent config file would be:
     EngineCommand = fruit
     Log = true
     [Engine]
-    Hash=128
 
 Compile "games.pgn" into a book "book.bin" retaining all lines of at
 most 30 plies.