X-Git-Url: http://winboard.nl/cgi-bin?a=blobdiff_plain;f=README;h=4358d8ec1687683aa2e75b6231d463e1fe24e287;hb=5b56e51eeae04c352b95b1706b9d69b61feba3e9;hp=ed905e60132a232c0e9e3245889c82fe20083d0c;hpb=aaf072500213db1bed274a2dd8ebe711f21ab898;p=polyglot.git diff --git a/README b/README index ed905e6..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- @@ -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,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=" + + -log (default: false) + This is an alias for -pg "Log=" - 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. + -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. @@ -350,9 +383,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 +405,9 @@ CONFIG FILE FORMAT Select moves according to their weights in the book. If false the move with the highest weight is selected. - BookRandom (default: true) - Select moves according to their weights in the book. If false the - move with the highest weight is selected. + BookLearn (default: false) + 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. @@ -402,6 +432,10 @@ 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 @@ -446,21 +480,6 @@ CONFIG FILE FORMAT to the way kibitzing is implemented, KibitzMove is disabled in that case. - 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 @@ -486,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. @@ -504,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. @@ -526,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-08-13 POLYGLOT(6) + 2009-09-11 POLYGLOT(6)