X-Git-Url: http://winboard.nl/cgi-bin?a=blobdiff_plain;f=polyglot.pod;h=a7c60d7173746912c2c75e716e2717ff248421a8;hb=bb6c47f77f59067c358579a71cefa1ae65180a30;hp=285e9b14f02a7c25945c5f34e66e616576eccaae;hpb=a0f731f21d6aa26dbf7246039a1c66c2ade0533f;p=polyglot.git diff --git a/polyglot.pod b/polyglot.pod index 285e9b1..a7c60d7 100644 --- a/polyglot.pod +++ b/polyglot.pod @@ -8,9 +8,7 @@ PolyGlot - Winboard protocol to UCI protocol adapter =head1 SYNOPSIS -polyglot [configfile] - -polyglot -ec engine +polyglot [configfile] [-noini] [-ec engine] [-ed enginedirectory] [-en enginename] [-log] [-lf logfile] [-hash value] [-bk book] [-pg =]* [-uci =]* polyglot make-book [-pgn inputfile] [-bin outputfile] [-max-ply ply] [-min-game games] [-min-score score] [-only-white] [-only-black] [-uniform] @@ -20,7 +18,7 @@ polyglot info-book [-bin inputfile] [-exact] 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] @@ -118,17 +116,59 @@ is however much slower than other more dedicated programs. =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 =. This option will +set the Polyglot option to . + +=item B<-uci> + +The argument is a string of the form =. This option will +set the engine option to . + +=item B<-ec> + +This sets the EngineCommand. + +=item B<-ed> + +This sets the EngineDir. + +=item B<-en> -=head2 polyglot -ec engine +This sets the EngineName. -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. +=item B<-hash> + +This is an alias for -uci "Hash=". + +=item B<-log> + +This is an alias for -pg "Log=true". + +=item B<-lf> (default: "polyglot.log") + +This is an alias for -pg "LogFile=". + +=item B<-bk> + +This is an alias for -pg "Book=true" -pg "BookFile=". + +=back When invoked as @@ -249,8 +289,9 @@ 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 @@ -314,8 +355,10 @@ The config file is in the traditional INI format. 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 @@ -412,13 +455,9 @@ many seconds before doing the next kibitz. If true PolyGlot will not understand xboard commands. -=item B (default: false) - -Play Chess960 (also called Fischer Random Chess or FRC), - =item B (default: 10000) -Mate score reported to GUI when in xboard mode. +Mate score reported to GUI when in xboard mode. =item B (default: false) @@ -444,8 +483,16 @@ with the highest weight is selected. =item B (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 (default: 256) + +Stop using the book after this number of moves. + +=item B (default: 5) + +Do not play moves with a weight (probability) lower than this (in per mil). =item B (default: false) @@ -466,6 +513,22 @@ Win32 priority levels are mapped in a sensible way to Unix nice levels. 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 (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 (default: .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 (default: $HOME/.polyglot on Linux; ".\Polyglot Settings" on Windows) + +The directory where the PersistFile is stored. =back @@ -520,14 +583,20 @@ Due to the way kibitzing is implemented, KibitzMove is disabled in that case. =item B (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 (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 @@ -558,6 +627,22 @@ GUI or launch the engine in a console and type "uci". =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. @@ -575,18 +660,6 @@ Test epd file "test.epd" with a (maximum) search time of 7 minutes per position 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. @@ -599,7 +672,10 @@ Native Windows port: Huang Chen ("Morning Yellow") Various enhancements: Fonzy Bleumers -UCI port: Michel Van den Bergh +UCI port, option persistence and new WB protocol: Michel Van den Bergh + + + =head1 SEE ALSO