-.\" Automatically generated by Pod::Man 2.1801 (Pod::Simple 3.05)
+.\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05)
.\"
.\" Standard preamble:
.\" ========================================================================
+.de Sh \" Subsection heading
+.br
+.if t .Sp
+.ne 5
+.PP
+\fB\\$1\fR
+.PP
+..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
.el .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
-.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
+.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD. Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.ie \nF \{\
.\" ========================================================================
.\"
.IX Title "POLYGLOT 6"
-.TH POLYGLOT 6 "2009-09-05" "" ""
+.TH POLYGLOT 6 "2011-06-01" "" ""
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
\- 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
polyglot perft [\-fen fen] [\-max\-depth depth]
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
-.SS "PolyGlot as adapter and book engine"
+.Sh "PolyGlot as adapter and book engine"
.IX Subsection "PolyGlot as adapter and book engine"
PolyGlot is a \*(L"\s-1UCI\s0 adapter\*(R". It connects a \s-1GUI\s0 interface (such as
XBoard, Winboard, Arena or Chessbase) to a \s-1UCI\s0 chess engine.
.PP
\&\s-1NOTE:\s0 Not all options are exported, only those that make sense in the
given mode.
-.SS "Book making utilities"
+.Sh "Book making utilities"
.IX Subsection "Book making utilities"
PolyGlot supports the \*(L"PolyGlot opening book format\*(R". This is the
defacto standard non-proprietary opening book format. It is fully documented
utility info-book will attempt to count the isolated positions which
require a player to make a non-book move when a book move is available.
Due to the possibility of transpositions this is not a fool proof method.
-.SS "Epd test mode"
+.Sh "Epd test mode"
.IX Subsection "Epd test mode"
In epd test mode, PolyGlot will search positions in an epd file and
record the number of times the right best move was found. The
arguments specify when to stop the search in any given position.
-.SS "Perft counts"
+.Sh "Perft counts"
.IX Subsection "Perft counts"
A perft count is the number of legal move sequence in a given position
up to a given depth. PolyGlot can perform such perft counts. It
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"
+.Sh "polyglot make-book"
.IX Subsection "polyglot make-book"
PolyGlot supports the following options
.ie n .IP "\fB\-pgn\fR (default: ""book.pgn"")" 4
.PP
When invoked
as
-.SS "polyglot merge-book"
+.Sh "polyglot merge-book"
.IX Subsection "polyglot merge-book"
PolyGlot supports the following options
.IP "\fB\-in1\fR" 4
.PP
When invoked
as
-.SS "polyglot dump-book"
+.Sh "polyglot dump-book"
.IX Subsection "polyglot dump-book"
PolyGlot supports the following options
.IP "\fB\-bin\fR (default: book.bin)" 4
.PP
When invoked
as
-.SS "polyglot info-book"
+.Sh "polyglot info-book"
.IX Subsection "polyglot info-book"
PolyGlot supports the following options
.IP "\fB\-bin\fR (default: book.bin)" 4
Note that this takes a very long time.
.PP
When invoked as
-.SS "polyglot epd-test"
+.Sh "polyglot epd-test"
.IX Subsection "polyglot epd-test"
(possibly with a config file as first argument) PolyGlot supports
besides the generic options described above the following additional
Minimal search time when the search is stopped using \*(L"\-depth\-delta\*(R".
.PP
When invoked as
-.SS "polyglot perft"
+.Sh "polyglot perft"
.IX Subsection "polyglot perft"
PolyGlot supports the following
options
.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.
-.SS "[PolyGlot] section"
+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.
+.Sh "[PolyGlot] section"
.IX Subsection "[PolyGlot] section"
This section is used by PolyGlot only. The engine is unaware of these
options. The list of available options is detailed below.
.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
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.
.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.
-.SS "Work arounds"
+.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.
+.Sh "Work arounds"
.IX Subsection "Work arounds"
Work arounds are identical to options except that they should be used
only when necessary. Their purpose is to try to hide problems with
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"
+.Sh "[Engine] section"
.IX Subsection "[Engine] section"
This section contains engine \s-1UCI\s0 options. PolyGlot does not
understand them, but sends the information to the engine at startup
\& 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
.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"
projects / polyglot.git / blobdiff