=head1 SYNOPSIS
-polyglot [configfile]
-
-polyglot -ec engine
+polyglot [configfile] [-noini] [-ec engine] [-ed enginedirectory] [-en enginename] [-log] [-lf logfile] [-hash value] [-bk book] [-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] [-uniform]
polyglot info-book [-bin inputfile] [-exact]
-polyglot dumb-book [-bin inputfile] -color color [-out outputfile]
+polyglot dump-book [-bin inputfile] -color color [-out outputfile]
-polyglot [configfile] epd-test [-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]
polyglot perft [-fen fen] [-max-depth depth]
=head1 OPTIONS
-When invoked without options or with a config file as argument PolyGlot
-acts as an adapter. The config file format is documented below. The
-default config file is "polyglot.ini".
+When PolyGlot is invoked as an adapter of in epd-test mode it gets its
+options from a config file and then from the command line. The
+default config file is "polyglot.ini" but an alternative one may be
+optionally included as first argument. The config file format is
+described below.
-When invoked as
+The following engine options may be specified on the command line.
+
+=over 4
+
+=item B<-noini>
+
+Do not use a config file, even if one was specified on the command line.
+
+=item B<-pg>
+
+The argument is a string of the form <name>=<value>. This option will
+set the Polyglot option <name> to <value>.
+
+=item B<-uci>
+
+The argument is a string of the form <name>=<value>. This option will
+set the engine option <name> to <value>.
+
+=item B<-ec>
+
+This sets the EngineCommand.
+
+=item B<-ed>
+
+This sets the EngineDir.
+
+=item B<-en>
+
+This sets the EngineName.
-=head2 polyglot -ec engine
+=item B<-hash>
-PolyGlot simply starts "engine" and acts as an adapter. No config file
-is used and thus it is expected that all properties will be set by the
-GUI.
+This is an alias for -uci "Hash=<value>".
+
+=item B<-log>
+
+This is an alias for -pg "Log=true".
+
+=item B<-lf> (default: "polyglot.log")
+
+This is an alias for -pg "LogFile=<value>".
+
+=item B<-bk>
+
+This is an alias for -pg "Book=true" -pg "BookFile=<value>".
+
+=back
When invoked as
=head2 polyglot epd-test
-(possibly with a config file as first argument) PolyGlot supports the following
-options
+(possibly with a config file as first argument) PolyGlot supports
+besides the generic options described above the following additional
+options.
=over 4
The characters "#" and ";" serve as comment characters.
-NOTE: There can be spaces in option names or values. Do not use
-quotes. Boolean values are written as "true" or "false".
+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.
=head2 [PolyGlot] section
Show search information during engine pondering. Turning this off
might be better for interactive use in some interfaces.
+=item B<ScoreWhite> (default: true)
+
+Report score from white's point of view in xboard mode.
+
=item B<KibitzMove> (default: false)
Whether to kibitz when playing a move.
xboard command to use for kibitzing, normally "tellall" for kibitzing
or "tellothers" for whispering.
-
=item B<KibitzDelay> (default: 5)
How many seconds to wait before starting kibitzing. This has an
effect only if "KibitzPV" is selected, move kibitzes are always sent
regardless of the delay.
-=item B<UCI> (default: false)
+=item B<KibitzInterval> (default: 0)
-If true PolyGlot will not understand xboard commands.
+This is another form of throttling. PolyGlot will usually wait this
+many seconds before doing the next kibitz.
-=item B<Chess960> (default: false)
+=item B<UCI> (default: false)
-Play Chess960 (also called Fischer Random Chess or FRC),
+If true PolyGlot will not understand xboard commands.
=item B<MateScore> (default: 10000)
-Mate score reported to GUI when in xboard mode.
+Mate score reported to GUI when in xboard mode.
=item B<Book> (default: false)
=item B<BookLearn> (default: false)
-Record learning information in the opening book. Naturally this requires
-the opening book to be writable.
+Store learning information in the book (which must be writable). Currently
+no engine actually uses this information.
+
+=item B<BookDepth> (default: 256)
+
+Stop using the book after this number of moves.
+
+=item B<BookTreshold> (default: 5)
+
+Do not play moves with a weight (probability) lower than this (in per mil).
=item B<UseNice> (default: false)
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.
+=item B<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.
+
+=item B<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.
+
+=item B<PersistDir> (default: $HOME/.polyglot on Linux; ".\Polyglot Settings" on Windows)
+
+The directory where the PersistFile is stored.
=back
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). The default value is always
-correct for bug-free software.
+various software (not just engines).
IMPORTANT: Any of these work arounds might be removed in future
versions of PolyGlot. You are strongly recommended to contact the
When true, PolyGlot repeats the last pv string (which also contains
score,depth and time usage) it got from the engine. Some engines
-however do not send a new pv string just before sending the move and
-the now old pv string might confuse debugtools that parse the winboard
-debug files.
+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.
+
+=item B<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.
+=item B<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.
=back
=head1 EXAMPLES
+Running the UCI engine "fruit" under xboard 4.3.15 and later (this invokes PolyGlot internally).
+
+ 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).
+
+ xboard -fcp "polyglot -noini -log -ec fruit -hash 128"
+
+The equivalent config file would be:
+
+ [PolyGlot]
+ EngineCommand = fruit
+ Log = true
+ [Engine]
+ Hash=128
+
Compile "games.pgn" into a book "book.bin" retaining all lines of at
most 30 plies.
polyglot epd-test -epd test.epd -max-time 420
-The command line for using the UCI engine "fruit" in a GUI which uses the
-xboard protocol.
-
- polyglot -ec fruit
-
-The equivalent config file:
-
- [PolyGlot]
- EngineCommand = fruit
- [Engine]
-
-
=head1 EXIT STATUS
PolyGlot always returns 0 on exit.
Various enhancements: Fonzy Bleumers<match(at)geenvis.net>
-UCI port: Michel Van den Bergh <michel.vandenbergh(at)uhasselt.be>
+UCI port, option persistence and new WB protocol: Michel Van den Bergh
+<michel.vandenbergh(at)uhasselt.be>
+
+
=head1 SEE ALSO
projects / polyglot.git / blobdiff