version 1.4.46b
[polyglot.git] / polyglot.man
index 39f08b8..ded75ff 100644 (file)
@@ -1,15 +1,7 @@
-.\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05)
+.\" Automatically generated by Pod::Man 2.1801 (Pod::Simple 3.05)
 .\"
 .\" Standard preamble:
 .\" ========================================================================
-.de Sh \" Subsection heading
-.br
-.if t .Sp
-.ne 5
-.PP
-\fB\\$1\fR
-.PP
-..
 .de Sp \" Vertical space (when we can't use .PP)
 .if t .sp .5v
 .if n .sp
@@ -53,7 +45,7 @@
 .el       .ds Aq '
 .\"
 .\" If the F register is turned on, we'll generate index entries on stderr for
-.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
+.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
 .\" entries marked with X<> in POD.  Of course, you'll have to process the
 .\" output yourself in some meaningful fashion.
 .ie \nF \{\
 .\" ========================================================================
 .\"
 .IX Title "POLYGLOT 6"
-.TH POLYGLOT 6 "2009-09-04" "" ""
+.TH POLYGLOT 6 "2009-09-05" "" ""
 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 .\" way too many mistakes in technical documents.
 .if n .ad l
@@ -160,7 +152,7 @@ polyglot [configfile] epd-test [engineoptions] [\-epd inputfile] [\-min\-depth d
 polyglot perft [\-fen fen] [\-max\-depth depth]
 .SH "DESCRIPTION"
 .IX Header "DESCRIPTION"
-.Sh "PolyGlot as adapter and book engine"
+.SS "PolyGlot as adapter and book engine"
 .IX Subsection "PolyGlot as adapter and book engine"
 PolyGlot is a \*(L"\s-1UCI\s0 adapter\*(R".  It connects a \s-1GUI\s0 interface (such as
 XBoard, Winboard, Arena or Chessbase) to a \s-1UCI\s0 chess engine.
@@ -191,7 +183,7 @@ by \*(L"Polyglot\*(R". This makes it easy to filter them in the \s-1GUI\s0.
 .PP
 \&\s-1NOTE:\s0 Not all options are exported, only those that make sense in the
 given mode.
-.Sh "Book making utilities"
+.SS "Book making utilities"
 .IX Subsection "Book making utilities"
 PolyGlot supports the \*(L"PolyGlot opening book format\*(R". This is the
 defacto standard non-proprietary opening book format. It is fully documented
@@ -236,12 +228,12 @@ it is difficult to identify the latter. If invoked with \*(L"\-exact\*(R" the
 utility info-book will attempt to count the isolated positions which
 require a player to make a non-book move when a book move is available.
 Due to the possibility of transpositions this is not a fool proof method.
-.Sh "Epd test mode"
+.SS "Epd test mode"
 .IX Subsection "Epd test mode"
 In epd test mode, PolyGlot will search positions in an epd file and
 record the number of times the right best move was found.  The
 arguments specify when to stop the search in any given position.
-.Sh "Perft counts"
+.SS "Perft counts"
 .IX Subsection "Perft counts"
 A perft count is the number of legal move sequence in a given position
 up to a given depth. PolyGlot can perform such perft counts. It
@@ -290,7 +282,7 @@ This is an alias for \-pg \*(L"LogFile=<value>\*(R".
 This is an alias for \-pg \*(L"Book=true\*(R" \-pg \*(L"BookFile=<value>\*(R".
 .PP
 When invoked as
-.Sh "polyglot make-book"
+.SS "polyglot make-book"
 .IX Subsection "polyglot make-book"
 PolyGlot supports the following options
 .ie n .IP "\fB\-pgn\fR (default: ""book.pgn"")" 4
@@ -325,7 +317,7 @@ equal probability.
 .PP
 When invoked
 as
-.Sh "polyglot merge-book"
+.SS "polyglot merge-book"
 .IX Subsection "polyglot merge-book"
 PolyGlot supports the following options
 .IP "\fB\-in1\fR" 4
@@ -344,7 +336,7 @@ moves and weights from \*(L"in1\*(R" will be retained in \*(L"out\*(R".
 .PP
 When invoked
 as
-.Sh "polyglot dump-book"
+.SS "polyglot dump-book"
 .IX Subsection "polyglot dump-book"
 PolyGlot supports the following options
 .IP "\fB\-bin\fR (default: book.bin)" 4
@@ -359,7 +351,7 @@ The name of the output file.
 .PP
 When invoked
 as
-.Sh "polyglot info-book"
+.SS "polyglot info-book"
 .IX Subsection "polyglot info-book"
 PolyGlot supports the following options
 .IP "\fB\-bin\fR (default: book.bin)" 4
@@ -371,7 +363,7 @@ Attempt to count the provably unreachable positions among the isolated ones.
 Note that this takes a very long time.
 .PP
 When invoked as
-.Sh "polyglot epd-test"
+.SS "polyglot epd-test"
 .IX Subsection "polyglot epd-test"
 (possibly with a config file as first argument) PolyGlot supports
 besides the generic options described above the following additional
@@ -396,7 +388,7 @@ Minimal search depth when the search is stopped using \*(L"\-depth\-delta\*(R".
 Minimal search time when the search is stopped using \*(L"\-depth\-delta\*(R".
 .PP
 When invoked as
-.Sh "polyglot perft"
+.SS "polyglot perft"
 .IX Subsection "polyglot perft"
 PolyGlot supports the following
 options
@@ -427,7 +419,7 @@ 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.
-.Sh "[PolyGlot] section"
+.SS "[PolyGlot] section"
 .IX Subsection "[PolyGlot] section"
 This section is used by PolyGlot only.  The engine is unaware of these
 options.  The list of available options is detailed below.
@@ -527,10 +519,10 @@ does not matter.
 .IX Item "BookRandom (default: true)"
 Select moves according to their weights in the book. If false the move
 with the highest weight is selected.
-.IP "\fBBookRandom\fR (default: true)" 4
-.IX Item "BookRandom (default: true)"
-Select moves according to their weights in the book. If false the move
-with the highest weight is selected.
+.IP "\fBBookLearn\fR (default: false)" 4
+.IX Item "BookLearn (default: false)"
+Store learning information in the book (which must be writable). Currently
+no engine actually uses this information.
 .IP "\fBBookDepth\fR (default: 256)" 4
 .IX Item "BookDepth (default: 256)"
 Stop using the book after this number of moves.
@@ -567,7 +559,7 @@ file, or delete it to restore the default options.
 .el .IP "\fBPersistDir\fR (default: \f(CW$HOME\fR/.polyglot on Linux; ``.\ePolyglot Settings'' on Windows)" 4
 .IX Item "PersistDir (default: $HOME/.polyglot on Linux; .Polyglot Settings on Windows)"
 The directory where the PersistFile is stored.
-.Sh "Work arounds"
+.SS "Work arounds"
 .IX Subsection "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
@@ -622,7 +614,7 @@ Engines that send options with \*(L"Draw\*(R" in their name are Rybka and \s-1HI
 Old version of Winboard clear the engine output window at depth 1. With this
 work around \s-1PG\s0 will send info lines at depth >=2. This may or may not improve
 the display.
-.Sh "[Engine] section"
+.SS "[Engine] section"
 .IX Subsection "[Engine] section"
 This section contains engine \s-1UCI\s0 options.  PolyGlot does not
 understand them, but sends the information to the engine at startup