X-Git-Url: http://winboard.nl/cgi-bin?a=blobdiff_plain;f=README;h=4358d8ec1687683aa2e75b6231d463e1fe24e287;hb=c6505b9bddf0ed2f461a473d4be40c98608d9866;hp=7af6caf00674531a61ee2d3a19e159d1db5b6cfa;hpb=07265afaa167049a447b4c5f43e5ef90c7451a49;p=polyglot.git diff --git a/README b/README index 7af6caf..4358d8e 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- @@ -23,10 +23,11 @@ SYNOPSIS 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] @@ -123,17 +124,38 @@ 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=" - polyglot -ec engine + -log (default: false) + This is an alias for -pg "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. + -lf (default: "polyglot.log") + This is an alias for -pg "LogFile=". + + -wb (default: "true") + This is an alias for -pg "OnlyWbOptions=". When invoked as @@ -220,8 +242,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 +291,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 @@ -292,6 +317,14 @@ CONFIG FILE FORMAT command-line arguments. Path searching is used and the current directory will be "EngineDir". + 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 the engine. This should be necessary only to locate problems. @@ -324,6 +357,9 @@ CONFIG FILE FORMAT Show search information during engine pondering. Turning this off might be better for interactive use in some interfaces. + ScoreWhite (default: true) + Report score from white's point of view in xboard mode. + KibitzMove (default: false) Whether to kibitz when playing a move. @@ -340,12 +376,13 @@ CONFIG FILE FORMAT effect only if "KibitzPV" is selected, move kibitzes are always sent regardless of the delay. + KibitzInterval (default: 0) + This is another form of throttling. PolyGlot will usually wait this + many seconds before doing the next kibitz. + 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. @@ -369,8 +406,15 @@ CONFIG FILE FORMAT 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. + Store learning information in the book (which must be writable). + Currently no engine actually uses this information. + + 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 @@ -388,12 +432,15 @@ 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. + 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). 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 @@ -458,6 +505,24 @@ CONFIG FILE FORMAT GUI or launch the engine in a console and type "uci". 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. @@ -476,17 +541,6 @@ 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. - - polyglot -ec fruit - - The equivalent config file: - - [PolyGlot] - EngineCommand = fruit - [Engine] - EXIT STATUS PolyGlot always returns 0 on exit. @@ -498,11 +552,12 @@ AUTHORS Various enhancements: Fonzy Bleumers - UCI port: Michel Van den Bergh + UCI port and implementation of new WB protocol: Michel Van den Bergh + SEE ALSO xboard(6) - 2009-07-20 POLYGLOT(6) + 2009-09-11 POLYGLOT(6)