X-Git-Url: http://winboard.nl/cgi-bin?p=polyglot.git;a=blobdiff_plain;f=README;h=c4b5d39908c70135db7ddb7f90d8129b116b1de3;hp=499acf1f7727529bdc6ae6a32caf2879c735f9b1;hb=HEAD;hpb=bb6c47f77f59067c358579a71cefa1ae65180a30 diff --git a/README b/README index 499acf1..c4b5d39 100644 --- a/README +++ b/README @@ -12,8 +12,8 @@ NAME SYNOPSIS polyglot [configfile] [-noini] [-ec engine] [-ed enginedirectory] [-en - enginename] [-log] [-lf logfile] [-hash value] [-bk book] [-pg - =]* [-uci =]* + enginename] [-log true/false] [-lf logfile] [-pg =]* [-uci + =]* polyglot make-book [-pgn inputfile] [-bin outputfile] [-max-ply ply] [-min-game games] [-min-score score] [-only-white] [-only-black] @@ -138,22 +138,20 @@ OPTIONS The argument is a string of the form =. This option will set the engine option to . - -ec This sets the EngineCommand. + -ec This is an alias for -pg "EngineCommand=" - -ed This sets the EngineDir. + -ed This is an alias for -pg "EngineDir=" - -en This sets the EngineName. + -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 @@ -283,10 +281,11 @@ CONFIG FILE FORMAT The characters "#" and ";" serve as comment characters. - 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. + Initial and final white space is stripped from option names and values. + If you need to use characters which have a special meaning to PolyGlot + (these are ';#[]=\') you should quote them by preceding them with '\'. + "Quoting" other characters in this way has no effect. In particular the + use of '\' as a path separator in windows should normally not affected. [PolyGlot] section This section is used by PolyGlot only. The engine is unaware of these @@ -306,7 +305,18 @@ CONFIG FILE FORMAT EngineCommand Put here the name of the engine executable file. You can also add command-line arguments. Path searching is used and the current - directory will be "EngineDir". + directory will be "EngineDir". On Linux the EngineCommand is passed + to wordexp so that shell quoting rules and expansions are applied. + On Windows the EngineCommand is simply passed to CreateProcess + which does its own shell like processing. + + 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 @@ -389,8 +399,7 @@ CONFIG FILE FORMAT 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. + This is a noop. BookDepth (default: 256) Stop using the book after this number of moves. @@ -415,20 +424,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. - Persist (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. - - PersistFile (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. + STFudge (default: 20) + PolyGlot will translate "st x" as "go movetime 1000*x-STFudge". + The rationale is that in the UCI specification the argument of + movetime is defined as the exact search time whereas the argument + of the st command is only an upperbound. - PersistDir (default: $HOME/.polyglot on Linux; ".\Polyglot Settings" on - Windows) - The directory where the PersistFile is stored. + 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 @@ -473,21 +477,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 them, but sends the information to the engine at startup (converted to @@ -517,10 +506,10 @@ EXAMPLES 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). + An explicit command line for using the UCI engine "fruit" with logging + enabled (this works also with older versions of xboard). - xboard -fcp "polyglot -noini -log -ec fruit -hash 128" + xboard -fcp "polyglot -noini -log true -ec fruit" The equivalent config file would be: @@ -528,7 +517,6 @@ EXAMPLES EngineCommand = fruit Log = true [Engine] - Hash=128 Compile "games.pgn" into a book "book.bin" retaining all lines of at most 30 plies. @@ -559,7 +547,7 @@ AUTHORS Various enhancements: Fonzy Bleumers - UCI port, option persistence and new WB protocol: Michel Van den Bergh + UCI port and implementation of new WB protocol: Michel Van den Bergh SEE ALSO @@ -567,4 +555,4 @@ SEE ALSO - 2009-09-05 POLYGLOT(6) + 2012-09-17 POLYGLOT(6)