SYNOPSIS
polyglot [configfile] [-noini] [-ec engine] [-ed enginedirectory] [-en
- enginename] [-log] [-lf logfile] [-hash value] [-bk book] [-pg
- <name>=<value>]* [-uci <name>=<value>]*
+ 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]
polyglot perft [-fen fen] [-max-depth depth]
DESCRIPTION
- PolyGlot as adapter and book engine
-
+ PolyGlot as adapter and book engine
PolyGlot is a "UCI adapter". It connects a GUI interface (such as
XBoard, Winboard, Arena or Chessbase) to a UCI chess engine.
NOTE: Not all options are exported, only those that make sense in the
given mode.
- Book making utilities
-
+ Book making utilities
PolyGlot supports the "PolyGlot opening book format". This is the
defacto standard non-proprietary opening book format. It is fully
documented here
Due to the possibility of transpositions this is not a fool proof
method.
- Epd test mode
-
+ 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.
- Perft counts
-
+ 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 is
however much slower than other more dedicated programs.
The argument is a string of the form <name>=<value>. This option
will set the engine option <name> to <value>.
- -ec This sets the EngineCommand.
-
- -ed This sets the EngineDir.
+ -ec This is an alias for -pg "EngineCommand=<value>"
- -en This sets the EngineName.
+ -ed This is an alias for -pg "EngineDir=<value>"
- -hash
- This is an alias for -uci "Hash=<value>".
+ -en This is an alias for -pg "EngineName=<value>"
- -log
- This is an alias for -pg "Log=true".
+ -log (default: false)
+ This is an alias for -pg "Log=<value>"
-lf (default: "polyglot.log")
This is an alias for -pg "LogFile=<value>".
- -bk This is an alias for -pg "Book=true" -pg "BookFile=<value>".
+ -wb (default: "true")
+ This is an alias for -pg "OnlyWbOptions=<value>".
When invoked as
- polyglot make-book
-
+ polyglot make-book
PolyGlot supports the following options
-pgn (default: "book.pgn")
When invoked as
- polyglot merge-book
-
+ polyglot merge-book
PolyGlot supports the following options
-in1
When invoked as
- polyglot dump-book
-
+ polyglot dump-book
PolyGlot supports the following options
-bin (default: book.bin)
When invoked as
- polyglot info-book
-
+ polyglot info-book
PolyGlot supports the following options
-bin (default: book.bin)
When invoked as
- polyglot epd-test
-
+ polyglot epd-test
(possibly with a config file as first argument) PolyGlot supports
besides the generic options described above the following additional
options.
When invoked as
- polyglot perft
-
+ polyglot perft
PolyGlot supports the following options
-fen (default: starting position)
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.
-
- [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 ';#[]=\') 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.
+ [PolyGlot] section
This section is used by PolyGlot only. The engine is unaware of these
options. The list of available options is detailed below.
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 "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.
+
+ 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
+ "Save" button in the Engine settings dialog in WB/XB 4.4.0 and
+ higher. As a special exception (for WB/XB 4.4.0 compatibility) this
+ directory is also used in case PolyGlot is started with config
+ files named "polyglot_1st.ini" or "polyglot_2nd.ini".
Log (default: false)
Whether PolyGlot should log all transactions with the interface and
Select moves according to their weights in the book. If false the
move with the highest weight is selected.
- BookRandom (default: true)
- Select moves according to their weights in the book. If false the
- move with the highest weight is selected.
+ BookLearn (default: false)
+ This is a noop.
BookDepth (default: 256)
Stop using the book after this number of moves.
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.
- Persist (default: true)
- If true then PolyGlot will implement persistence by loading options
- from an additional INI file whose name is by default derived from
- the engine name. At exit PolyGlot will also save its options to
- this INI file.
-
- 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.
+ 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.
- PersistDir (default: $HOME/.polyglot on Linux; ".\Polyglot Settings" on
- Windows)
- The directory where the PersistFile is stored.
-
- Work arounds
+ OnlyWbOptions (default: true)
+ If true then PolyGlot restricts the options it sends to those that
+ are potentially useful for WinBoard.
+ 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).
to the way kibitzing is implemented, KibitzMove is disabled in that
case.
- 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.
-
- Engines that send options with "Draw" in their name are Rybka and
- HIARCS.
-
- WbWorkArounds2 (default: false)
- Old version of Winboard clear the engine output window at depth 1.
- With this work around PG will send info lines at depth >=2. This
- may or may not improve the display.
-
- [Engine] section
-
+ [Engine] section
This section contains engine UCI options. PolyGlot does not understand
them, but sends the information to the engine at startup (converted to
UCI form). You can add any UCI option that makes sense to the engine
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:
EngineCommand = fruit
Log = true
[Engine]
- Hash=128
Compile "games.pgn" into a book "book.bin" retaining all lines of at
most 30 plies.
Various enhancements: Fonzy Bleumers<match(at)geenvis.net>
- UCI port, option persistence and new WB protocol: Michel Van den Bergh
+ UCI port and implementation of new WB protocol: Michel Van den Bergh
<michel.vandenbergh(at)uhasselt.be>
SEE ALSO
- 2009-09-04 POLYGLOT(6)
+ 2012-09-17 POLYGLOT(6)
projects / polyglot.git / blobdiff