X-Git-Url: http://winboard.nl/cgi-bin?a=blobdiff_plain;f=README;h=ac68f6658292fd3748a855fb5eff45f89a35ab4c;hb=5eed4adb3552562329c0b0b460c8851efb1a38bb;hp=f36abee5d016e8e073e31ec17fb2a93954a4b993;hpb=baab92d048b9ba06dada3a17ec51d9e9340d4730;p=polyglot.git diff --git a/README b/README index f36abee..ac68f66 100644 --- a/README +++ b/README @@ -11,9 +11,9 @@ NAME - a perft counter 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] [-uni- @@ -25,8 +25,9 @@ SYNOPSIS 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] @@ -123,17 +124,40 @@ DESCRIPTION ever much slower than other more dedicated programs. 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. + + -noini + Do not use a config file, even if one was specified on the command + line. + + -pg The argument is a string of the form =. This option + will set the Polyglot option to . + + -uci + The argument is a string of the form =. This option + will set the engine option to . + + -ec This is an alias for -pg "EngineCommand=". + + -ed This is an alias for -pg "EngineDir=". + + -en This is an alias for -pg "EngineName=" + + -hash + This is an alias for -uci "Hash=". + + -log + This is an alias for -pg "Log=true". - polyglot -ec engine + -lf (default: "polyglot.log") + This is an alias for -pg "LogFile=". - 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. + -bk This is an alias for -pg "Book=true" -pg "BookFile=". When invoked as @@ -220,8 +244,9 @@ OPTIONS 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. -max-depth (default: 63) Unconditionally stop the search when this depth has been reached. @@ -268,8 +293,10 @@ CONFIG FILE 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 val- + ues. 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 @@ -350,9 +377,6 @@ CONFIG FILE FORMAT UCI (default: false) If true PolyGlot will not understand xboard commands. - Chess960 (default: false) - Play Chess960 (also called Fischer Random Chess or FRC), - MateScore (default: 10000) Mate score reported to GUI when in xboard mode. @@ -375,9 +399,16 @@ CONFIG FILE FORMAT Select moves according to their weights in the book. If false the move with the highest weight is selected. - BookLearn (default: false) - Record learning information in the opening book. Naturally this - requires the opening book to be writable. + BookRandom (default: true) + Select moves according to their weights in the book. If false the + move with the highest weight is selected. + + BookDepth (default: 256) + Stop using the book after this number of moves. + + BookTreshold (default: 5) + Do not play moves with a weight (probability) lower than this (in + per mil). UseNice (default: false) Run the engine at nice level 5, or "NiceValue" if it set. On some @@ -395,12 +426,20 @@ CONFIG FILE FORMAT 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. + SaveSettingsOnExit (default: true) + If true then PolyGlot will implement persistence by loading its + 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. + + SaveFile (default: .ini) + The name of the file from which to take the additional options. + 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). The default value is always cor- - rect for bug-free software. + various software (not just engines). IMPORTANT: Any of these work arounds might be removed in future ver- sions of PolyGlot. You are strongly recommended to contact the author @@ -440,17 +479,21 @@ CONFIG FILE FORMAT to the way kibitzing is implemented, KibitzMove is disabled in that case. - WbWorkArounds (default: false) - The intention of this option is to provide work arounds for - xboard/winboard bugs should they arise. Currently it only prevents - "feature option=" commands which contain "Draw" in their name from - being sent to the GUI. Some versions of xboard/winboard contain a - bug which causes such options to be interpreted as draw claims by - the engine. + 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 This section contains engine UCI options. PolyGlot does not understand @@ -494,16 +537,18 @@ EXAMPLES 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 EXIT STATUS PolyGlot always returns 0 on exit. @@ -523,4 +568,4 @@ SEE ALSO - 2009-08-06 POLYGLOT(6) + 2009-08-31 POLYGLOT(6)