X-Git-Url: http://winboard.nl/cgi-bin?a=blobdiff_plain;f=README;h=4358d8ec1687683aa2e75b6231d463e1fe24e287;hb=5b56e51eeae04c352b95b1706b9d69b61feba3e9;hp=ac68f6658292fd3748a855fb5eff45f89a35ab4c;hpb=5eed4adb3552562329c0b0b460c8851efb1a38bb;p=polyglot.git diff --git a/README b/README index ac68f66..4358d8e 100644 --- a/README +++ b/README @@ -142,22 +142,20 @@ OPTIONS The argument is a string of the form =. This option will set the engine option to . - -ec This is an alias for -pg "EngineCommand=". + -ec This is an alias for -pg "EngineCommand=" - -ed This is an alias for -pg "EngineDir=". + -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". + -log (default: false) + This is an alias for -pg "Log=" -lf (default: "polyglot.log") This is an alias for -pg "LogFile=". - -bk This is an alias for -pg "Book=true" -pg "BookFile=". + -wb (default: "true") + This is an alias for -pg "OnlyWbOptions=". When invoked as @@ -319,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. @@ -399,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. @@ -426,14 +432,9 @@ 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. + OnlyWbOptions (default: true) + If true then PolyGlot restricts the options it sends to those that + are potentially useful for WinBoard. Work arounds @@ -479,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 @@ -519,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. @@ -537,19 +541,6 @@ EXAMPLES polyglot epd-test -epd test.epd -max-time 420 - The command line for using the UCI engine "fruit" with 128M hash in - xboard with logging enabled. - - xboard -fcp "polyglot -noini -log -ec fruit -hash 128" - - The equivalent config file would be: - - [PolyGlot] - EngineCommand = fruit - Log = true - [Engine] - Hash=128 - EXIT STATUS PolyGlot always returns 0 on exit. @@ -561,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-31 POLYGLOT(6) + 2009-09-11 POLYGLOT(6)