.\" ========================================================================
.\"
.IX Title "POLYGLOT 6"
-.TH POLYGLOT 6 "2009-08-31" "" ""
+.TH POLYGLOT 6 "2009-09-11" "" ""
.SH "NAME"
PolyGlot \- Winboard protocol to UCI protocol adapter
\- book engine for Polyglot books
set the engine option <name> to <value>.
.IP "\fB\-ec\fR" 4
.IX Item "-ec"
-This is an alias for \-pg \*(L"EngineCommand=<value>\*(R".
+This is an alias for \-pg \*(L"EngineCommand=<value>\*(R"
.IP "\fB\-ed\fR" 4
.IX Item "-ed"
-This is an alias for \-pg \*(L"EngineDir=<value>\*(R".
+This is an alias for \-pg \*(L"EngineDir=<value>\*(R"
.IP "\fB\-en\fR" 4
.IX Item "-en"
This is an alias for \-pg \*(L"EngineName=<value>\*(R"
-.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".
+.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
.Sh "polyglot make-book"
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".
+.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
.IX Item "BookRandom (default: true)"
Select moves according to their weights in the book. If false the move
with the highest weight is selected.
-.IP "\fBBookRandom\fR (default: true)" 4
-.IX Item "BookRandom (default: true)"
-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.
.IP "\fBBookDepth\fR (default: 256)" 4
.IX Item "BookDepth (default: 256)"
Stop using the book after this number of moves.
.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 "\fBSaveSettingsOnExit\fR (default: true)" 4
-.IX Item "SaveSettingsOnExit (default: true)"
-If true then PolyGlot will implement persistence by loading its
-options from an additional \s-1INI\s0 file which is specified by the option
-\&\*(L"SaveFile\*(R". At exit PolyGlot will also save its options to this \s-1INI\s0
-file.
-.IP "\fBSaveFile\fR (default: <EngineName>.ini)" 4
-.IX Item "SaveFile (default: <EngineName>.ini)"
-The name of the file from which to take the additional options.
+.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.
.Sh "Work arounds"
.IX Subsection "Work arounds"
Work arounds are identical to options except that they should be used
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.
.Sh "[Engine] section"
.IX Subsection "[Engine] section"
This section contains engine \s-1UCI\s0 options. PolyGlot does not
\&\s-1GUI\s0 or launch the engine in a console and type \*(L"uci\*(R".
.SH "EXAMPLES"
.IX Header "EXAMPLES"
+Running the \s-1UCI\s0 engine \*(L"fruit\*(R" under xboard 4.3.15 and later (this invokes PolyGlot internally).
+.PP
+.Vb 1
+\& 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).
+.PP
+.Vb 1
+\& xboard \-fcp "polyglot \-noini \-log \-ec fruit \-hash 128"
+.Ve
+.PP
+The equivalent config file would be:
+.PP
+.Vb 5
+\& [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
most 30 plies.
.PP
.Vb 1
\& polyglot epd\-test \-epd test.epd \-max\-time 420
.Ve
-.PP
-The command line for using the \s-1UCI\s0 engine \*(L"fruit\*(R" with 128M hash in xboard with logging enabled.
-.PP
-.Vb 1
-\& xboard \-fcp "polyglot \-noini \-log \-ec fruit \-hash 128"
-.Ve
-.PP
-The equivalent config file would be:
-.PP
-.Vb 5
-\& [PolyGlot]
-\& EngineCommand = fruit
-\& Log = true
-\& [Engine]
-\& Hash=128
-.Ve
.SH "EXIT STATUS"
.IX Header "EXIT STATUS"
PolyGlot always returns 0 on exit.
.PP
Various enhancements: Fonzy Bleumers<match(at)geenvis.net>
.PP
-\&\s-1UCI\s0 port: Michel Van den Bergh <michel.vandenbergh(at)uhasselt.be>
+\&\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"
\&\fIxboard\fR\|(6)
projects / polyglot.git / blobdiff