-.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
+.\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05)
.\"
.\" Standard preamble:
.\" ========================================================================
. ds R" ''
'br\}
.\"
+.\" Escape single quotes in literal strings from groff's Unicode transform.
+.ie \n(.g .ds Aq \(aq
+.el .ds Aq '
+.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" 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.
-.if \nF \{\
+.ie \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. nr % 0
. rr F
.\}
-.\"
-.\" For nroff, turn off justification. Always turn off hyphenation; it makes
-.\" way too many mistakes in technical documents.
-.hy 0
-.if n .na
+.el \{\
+. de IX
+..
+.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear. Run. Save yourself. No user-serviceable parts.
.\" ========================================================================
.\"
.IX Title "POLYGLOT 6"
-.TH POLYGLOT 6 "2009-09-01" "" ""
+.TH POLYGLOT 6 "2009-09-04" "" ""
+.\" For nroff, turn off justification. Always turn off hyphenation; it makes
+.\" way too many mistakes in technical documents.
+.if n .ad l
+.nh
.SH "NAME"
PolyGlot \- Winboard protocol to UCI protocol adapter
\- book engine for Polyglot books
.PP
polyglot dump-book [\-bin inputfile] \-color color [\-out outputfile]
.PP
-polyglot [configfile] epd-test [engineoptions] [\-epd inputfile] [\-min\-depth depth] [\-max\-depth depth] [\-max\-time time] [\-depth\-delta delta]
+polyglot [configfile] epd-test [engineoptions] [\-epd inputfile] [\-min\-depth depth] [\-max\-depth depth] [\-max\-time time] [\-depth\-delta delta]
.PP
polyglot perft [\-fen fen] [\-max\-depth depth]
.SH "DESCRIPTION"
Roughly speaking a PolyGlot opening book is a collection of triples
(position, move, weight). A \*(L"position\*(R" is represented by a 64\-bit
Zobrist hash key. The weight is proportional to the probability the move should
-be played.
+be played.
.PP
Other opening book formats such as ChessBase's .ctg format and Arena's
\&.abk format are undocumented and proprietary. They can only be used
-by their own GUIs.
+by their own GUIs.
.PP
PolyGlot can compile a pgn file into a binary PolyGlot book and furthermore
it can merge two such binary books into a third one.
.PP
PolyGlot can also extract some useful information from PolyGlot books. The utility
-\&\*(L"dump\-book\*(R" dumps the \*(L"lines\*(R" in a book for a given color. By definition
+\&\*(L"dump-book\*(R" dumps the \*(L"lines\*(R" in a book for a given color. By definition
a line is a sequence of moves (from the starting position) in which
the given color makes only book moves and the other color makes
arbitrary moves (i.e. not necessarily book moves).
Since a PolyGlot book is built up from positions and not lines there
may be (and there usually are) many positions in the book that are not
on a \*(L"line\*(R" as defined in the previous paragraph. It is convenient
-to call such positions \*(L"isolated\*(R" positions. The utility \*(L"info\-book\*(R"
+to call such positions \*(L"isolated\*(R" positions. The utility \*(L"info-book\*(R"
counts such isolated positions.
.PP
Some of the isolated positions are provably unreachable and they
.IP "\fB\-pg\fR" 4
.IX Item "-pg"
The argument is a string of the form <name>=<value>. This option will
-set the Polyglot option <name> to <value>.
+set the Polyglot option <name> to <value>.
.IP "\fB\-uci\fR" 4
.IX Item "-uci"
The argument is a string of the form <name>=<value>. This option will
-set the engine option <name> to <value>.
+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 sets the EngineCommand.
.IP "\fB\-ed\fR" 4
.IX Item "-ed"
-This is an alias for \-pg \*(L"EngineDir=<value>\*(R".
+This sets the EngineDir.
.IP "\fB\-en\fR" 4
.IX Item "-en"
-This is an alias for \-pg \*(L"EngineName=<value>\*(R"
+This sets the EngineName.
.IP "\fB\-hash\fR" 4
.IX Item "-hash"
This is an alias for \-uci \*(L"Hash=<value>\*(R".
.ie n .IP "\fB\-pgn\fR (default: ""book.pgn"")" 4
.el .IP "\fB\-pgn\fR (default: ``book.pgn'')" 4
.IX Item "-pgn (default: book.pgn)"
-Input file in pgn format.
+Input file in pgn format.
.ie n .IP "\fB\-bin\fR (default: ""book.bin"")" 4
.el .IP "\fB\-bin\fR (default: ``book.bin'')" 4
.IX Item "-bin (default: book.bin)"
-Output file in PolyGlot format.
+Output file in PolyGlot format.
.IP "\fB\-max\-ply\fR (default: 1024)" 4
.IX Item "-max-ply (default: 1024)"
Specifies the maximum ply-depth of lines included in the book.
.IX Item "-min-score (default: 0.0)"
Specifies the minimum score (or weight) this move should have received for
it to be included in the book. The score is 2*(wins)+(draws), globally scaled
-to fit into 16 bits.
+to fit into 16 bits.
.IP "\fB\-only\-white\fR" 4
.IX Item "-only-white"
Include only moves for white in the book.
.IP "\fB\-uniform\fR" 4
.IX Item "-uniform"
Set all weights to 1. In other words, all moves will be selected with
-equal probability.
+equal probability.
.PP
When invoked
as
.IP "\fB\-exact\fR" 4
.IX Item "-exact"
Attempt to count the provably unreachable positions among the isolated ones.
-Note that this takes a very long time.
+Note that this takes a very long time.
.PP
When invoked as
.Sh "polyglot epd-test"
Maximum depth to search.
.SH "CONFIG FILE FORMAT"
.IX Header "CONFIG FILE FORMAT"
-There should be a different config file for each engine.
+There should be a different config file for each engine.
.PP
-The config file is in the traditional \s-1INI\s0 format.
+The config file is in the traditional \s-1INI\s0 format.
.PP
.Vb 6
\& [PolyGLot]
\& ...
.Ve
.PP
-The characters \*(L"#\*(R" and \*(L";\*(R" serve as comment characters.
+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
.IP "\fBKibitzInterval\fR (default: 0)" 4
.IX Item "KibitzInterval (default: 0)"
This is another form of throttling. PolyGlot will usually wait this
-many seconds before doing the next kibitz.
+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.
+If true PolyGlot will not understand xboard commands.
.IP "\fBMateScore\fR (default: 10000)" 4
.IX Item "MateScore (default: 10000)"
Mate score reported to \s-1GUI\s0 when in xboard mode.
.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.
+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.
+with the highest weight is selected.
.IP "\fBBookDepth\fR (default: 256)" 4
.IX Item "BookDepth (default: 256)"
-Stop using the book after this number of moves.
+Stop using the book after this number of moves.
.IP "\fBBookTreshold\fR (default: 5)" 4
.IX Item "BookTreshold (default: 5)"
-Do not play moves with a weight (probability) lower than this (in per mil).
+Do not play moves with a weight (probability) lower than this (in per mil).
.IP "\fBUseNice\fR (default: false)" 4
.IX Item "UseNice (default: false)"
Run the engine at nice level 5, or \*(L"NiceValue\*(R" if it set. On some
.IP "\fBAffinity\fR (default: \-1)" 4
.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.
+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 which is specified by the option
-\&\*(L"PersistFile\*(R". At exit PolyGlot will also save its options to this \s-1INI\s0
-file.
-.IP "\fBPersistFile\fR (default: PG_<EngineName>.ini)" 4
-.IX Item "PersistFile (default: PG_<EngineName>.ini)"
-The name of the file from which to take the additional options.
-You can safely edit this file, or delete it to restore the default
-options.
+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.
.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
-various software (not just engines).
+various software (not just engines).
.PP
\&\s-1IMPORTANT:\s0 Any of these work arounds might be removed in future
versions of PolyGlot. You are strongly recommended to contact the
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.
+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 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.
+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.
+the display.
.Sh "[Engine] section"
.IX Subsection "[Engine] section"
This section contains engine \s-1UCI\s0 options. PolyGlot does not
correct. It will be replaced by PolyGlot with \*(L"setoption name OwnBook
value true\*(R" at engine startup.
.PP
-Standard \s-1UCI\s0 options are
+Standard \s-1UCI\s0 options are
.PP
.Vb 4
\& Hash
Hidden options like \*(L"Ponder\*(R" or \*(L"UCI_xxx\*(R" are automatic
and should not be put in an \s-1INI\s0 file.
.PP
-The other options are engine\-specific. Check their name using a \s-1UCI\s0
+The other options are engine-specific. Check their name using a \s-1UCI\s0
\&\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.
+PolyGlot always returns 0 on exit.
.SH "AUTHORS"
.IX Header "AUTHORS"
Main author: Fabien Letouzey<fabien_letouzey(at)hotmail.com>
.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, option persistence and 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