version 1.4.39b

[polyglot.git] / README

diff --git a/README b/README
index ed905e6..ac68f66 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,40 @@ 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>".
 
-       polyglot -ec engine
+       -en This is an alias for -pg "EngineName=<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.
+       -hash
+           This is an alias for -uci "Hash=<value>".
+
+       -log
+           This is an alias for -pg "Log=true".
+
+       -lf (default: "polyglot.log")
+           This is an alias for -pg "LogFile=<value>".
+
+       -bk This is an alias for -pg "Book=true" -pg "BookFile=<value>".
 
        When invoked as
 
@@ -220,8 +244,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 +293,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
 
@@ -350,9 +377,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.
 
@@ -402,6 +426,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.
 
+       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: <EngineName>.ini)
+           The name of the file from which to take the additional options.
+
        Work arounds
 
        Work arounds are identical to options except that they should be used
@@ -504,16 +537,18 @@ 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.
+       The command line for using the UCI engine "fruit" with 128M hash in
+       xboard with logging enabled.
 
-           polyglot -ec fruit
+           xboard -fcp "polyglot -noini -log -ec fruit -hash 128"
 
-       The equivalent config file:
+       The equivalent config file would be:
 
            [PolyGlot]
            EngineCommand = fruit
+           Log = true
            [Engine]
+           Hash=128
 
 EXIT STATUS
        PolyGlot always returns 0 on exit.
@@ -533,4 +568,4 @@ SEE ALSO
 
 
 
-                                  2009-08-13                       POLYGLOT(6)
+                                  2009-08-31                       POLYGLOT(6)