=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 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 is an alias for -pg "EngineCommand=<value>".
+
+=item B<-ed>
+
+This is an alias for -pg "EngineDir=<value>".
+
+=item B<-en>
+
+This is an alias for -pg "EngineName=<value>"
+
+=item B<-hash>
+
+This is an alias for -uci "Hash=<value>".
+
+=item B<-log>
+
+This is an alias for -pg "Log=true".
-=head2 polyglot -ec engine
+=item B<-lf> (default: "polyglot.log")
-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 -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
If true PolyGlot will not understand xboard commands.
-=item B<Chess960> (default: false)
-
-Play Chess960 (also called Fischer Random Chess or FRC),
-
=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)
Select moves according to their weights in the book. If false the move
with the highest weight is selected.
-=item B<BookLearn> (default: false)
+=item B<BookRandom> (default: true)
+
+Select moves according to their weights in the book. If false the move
+with the highest weight is selected.
+
+=item B<BookDepth> (default: 256)
+
+Stop using the book after this number of moves.
-Record learning information in the opening book. Naturally this requires
-the opening book to be writable.
+=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<SaveSettingsOnExit> (default: true)
+
+If true then PolyGlot will implement persistence by loading
+options from an additional INI file which is specified by the option
+"SaveFile". At exit PolyGlot will also save its options to this INI
+file.
+
+=item B<SaveFile> (default: PG_<EngineName>.ini)
+
+The name of the file from which to take the additional options.
+You can safely edit this file.
=back
=item B<WbWorkArounds> (default: true)
-The intention of this option is to provide work arounds for
-xboard/winboard bugs should they arise. Currently it decapitalizes
+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
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.
+The command line for using the UCI engine "fruit" with 128M hash in xboard with logging enabled.
- polyglot -ec fruit
+ xboard -fcp "polyglot -noini -log -ec fruit -hash 128"
-The equivalent config file:
+The equivalent config file would be:
[PolyGlot]
EngineCommand = fruit
+ Log = true
[Engine]
-
+ Hash=128
=head1 EXIT STATUS