version 1.4.50b
[polyglot.git] / README
diff --git a/README b/README
index b523a6d..4358d8e 100644 (file)
--- 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
+       <name>=<value>]* [-uci <name>=<value>]*
 
        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 <name>=<value>. This option
+           will set the Polyglot option <name> to <value>.
+
+       -uci
+           The argument is a string of the form <name>=<value>. This option
+           will set the engine option <name> to <value>.
+
+       -ec This is an alias for -pg "EngineCommand=<value>"
+
+       -ed This is an alias for -pg "EngineDir=<value>"
+
+       -en This is an alias for -pg "EngineName=<value>"
+
+       -log (default: false)
+           This is an alias for -pg "Log=<value>"
 
-       polyglot -ec engine
+       -lf (default: "polyglot.log")
+           This is an alias for -pg "LogFile=<value>".
 
-       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=<value>".
 
        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.
 
@@ -376,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
@@ -395,15 +432,19 @@ 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).
 
-       IMPORTANT: Any of these work arounds might be removed in future
-       versions of PolyGlot.  You are strongly recommended to contact the
-       author of faulty software and truly fix the problem.
+       IMPORTANT: Any of these work arounds might be removed in future ver-
+       sions of PolyGlot.  You are strongly recommended to contact the author
+       of faulty software and truly fix the problem.
 
        PolyGlot supports the following work arounds:
 
@@ -439,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
@@ -479,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.
 
@@ -497,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.
 
@@ -519,11 +552,12 @@ AUTHORS
 
        Various enhancements: Fonzy Bleumers<match(at)geenvis.net>
 
-       UCI port: Michel Van den Bergh <michel.vandenbergh(at)uhasselt.be>
+       UCI port and implementation of new WB protocol: Michel Van den Bergh
+       <michel.vandenbergh(at)uhasselt.be>
 
 SEE ALSO
        xboard(6)
 
 
 
-                                  2009-08-11                       POLYGLOT(6)
+                                  2009-09-11                       POLYGLOT(6)