Update README and some config changes
[polyglot.git] / polyglot.man
index ded75ff..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 "2009-09-05" "" ""
+.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
@@ -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
@@ -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
@@ -260,26 +260,24 @@ The argument is a string of the form <name>=<value>. This option will
 set the engine option <name> to <value>.
 .IP "\fB\-ec\fR" 4
 .IX Item "-ec"
-This sets the EngineCommand.
+This is an alias for \-pg \*(L"EngineCommand=<value>\*(R"
 .IP "\fB\-ed\fR" 4
 .IX Item "-ed"
-This sets the EngineDir.
+This is an alias for \-pg \*(L"EngineDir=<value>\*(R"
 .IP "\fB\-en\fR" 4
 .IX Item "-en"
-This sets the EngineName.
-.IP "\fB\-hash\fR" 4
-.IX Item "-hash"
-This is an alias for \-uci \*(L"Hash=<value>\*(R".
-.IP "\fB\-log\fR" 4
-.IX Item "-log"
-This is an alias for \-pg \*(L"Log=true\*(R".
+This is an alias for \-pg \*(L"EngineName=<value>\*(R"
+.IP "\fB\-log\fR (default: false)" 4
+.IX Item "-log (default: false)"
+This is an alias for \-pg \*(L"Log=<value>\*(R"
 .ie n .IP "\fB\-lf\fR (default: ""polyglot.log"")" 4
 .el .IP "\fB\-lf\fR (default: ``polyglot.log'')" 4
 .IX Item "-lf (default: polyglot.log)"
 This is an alias for \-pg \*(L"LogFile=<value>\*(R".
-.IP "\fB\-bk\fR" 4
-.IX Item "-bk"
-This is an alias for \-pg \*(L"Book=true\*(R" \-pg \*(L"BookFile=<value>\*(R".
+.ie n .IP "\fB\-wb\fR (default: ""true"")" 4
+.el .IP "\fB\-wb\fR (default: ``true'')" 4
+.IX Item "-wb (default: true)"
+This is an alias for \-pg \*(L"OnlyWbOptions=<value>\*(R".
 .PP
 When invoked as
 .SS "polyglot make-book"
@@ -415,10 +413,12 @@ The config file is in the traditional \s-1INI\s0 format.
 .PP
 The characters \*(L"#\*(R" and \*(L";\*(R" serve as comment characters.
 .PP
-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 ';#[]=\e') you should quote them by preceding them
+with '\e'. \*(L"Quoting\*(R" other characters in this way has no effect. In
+particular the use of '\e' as a path separator in windows should
+normally not affected.
 .SS "[PolyGlot] section"
 .IX Subsection "[PolyGlot] section"
 This section is used by PolyGlot only.  The engine is unaware of these
@@ -439,7 +439,19 @@ any data file.
 .IX Item "EngineCommand"
 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 \*(L"EngineDir\*(R".
+directory will be \*(L"EngineDir\*(R". 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.
+.ie n .IP "\fBSettingsDir\fR (default: $HOME/.polyglot on Linux; "".\e_PG"" on Windows)" 4
+.el .IP "\fBSettingsDir\fR (default: \f(CW$HOME\fR/.polyglot on Linux; ``.\e_PG'' on Windows)" 4
+.IX Item "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 \*(L"Save\*(R" button in the
+Engine settings dialog in \s-1WB/XB\s0 4.4.0 and higher. As a special exception
+(for \s-1WB/XB\s0 4.4.0 compatibility) this directory is also used in case
+PolyGlot is started with config files named \*(L"polyglot_1st.ini\*(R" or
+\&\*(L"polyglot_2nd.ini\*(R".
 .IP "\fBLog\fR (default: false)" 4
 .IX Item "Log (default: false)"
 Whether PolyGlot should log all transactions with the interface and
@@ -467,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.
@@ -497,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
@@ -521,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.
@@ -544,21 +583,16 @@ 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 "\fBPersist\fR (default: true)" 4
-.IX Item "Persist (default: true)"
-If true then PolyGlot will implement persistence by loading options
-from an additional \s-1INI\s0 file whose name is by default derived from the
-engine name. At exit PolyGlot will also save its options to this \s-1INI\s0
-file.
-.IP "\fBPersistFile\fR (default: <EngineName>.ini)" 4
-.IX Item "PersistFile (default: <EngineName>.ini)"
-The name of the file from which to take the additional options.  It is
-probably best to stick with the default. You can safely edit this
-file, or delete it to restore the default options.
-.ie n .IP "\fBPersistDir\fR (default: $HOME/.polyglot on Linux; "".\ePolyglot Settings"" on Windows)" 4
-.el .IP "\fBPersistDir\fR (default: \f(CW$HOME\fR/.polyglot on Linux; ``.\ePolyglot Settings'' on Windows)" 4
-.IX Item "PersistDir (default: $HOME/.polyglot on Linux; .Polyglot Settings on Windows)"
-The directory where the PersistFile is stored.
+.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
+are potentially useful for WinBoard.
 .SS "Work arounds"
 .IX Subsection "Work arounds"
 Work arounds are identical to options except that they should be used
@@ -600,20 +634,6 @@ 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.
-.IP "\fBWbWorkArounds\fR (default: true)" 4
-.IX Item "WbWorkArounds (default: true)"
-The intention of these options is to provide work arounds for
-xboard/winboard bugs should they arise.  This one 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.
-.Sp
-Engines that send options with \*(L"Draw\*(R" in their name are Rybka and \s-1HIARCS\s0.
-.IP "\fBWbWorkArounds2\fR (default: false)" 4
-.IX Item "WbWorkArounds2 (default: false)"
-Old version of Winboard clear the engine output window at depth 1. With this
-work around \s-1PG\s0 will send info lines at depth >=2. This may or may not improve
-the display.
 .SS "[Engine] section"
 .IX Subsection "[Engine] section"
 This section contains engine \s-1UCI\s0 options.  PolyGlot does not
@@ -628,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
@@ -648,20 +671,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
@@ -699,7 +721,7 @@ Native Windows port:  Huang Chen<webmaster@elephantbase.net> (\*(L"Morning Yello
 .PP
 Various enhancements: Fonzy Bleumers<match(at)geenvis.net>
 .PP
-\&\s-1UCI\s0 port, option persistence and new \s-1WB\s0 protocol: Michel Van den Bergh
+\&\s-1UCI\s0 port and implementation of new \s-1WB\s0 protocol: Michel Van den Bergh
 <michel.vandenbergh(at)uhasselt.be>
 .SH "SEE ALSO"
 .IX Header "SEE ALSO"