From: H.G. Muller <h.g.muller@hccnet.nl>
Date: Tue, 1 Sep 2009 03:25:17 +0000 (-0700)
Subject: updated documentation
X-Git-Tag: v4.4.0.beta2~2
X-Git-Url: http://winboard.nl/cgi-bin?a=commitdiff_plain;h=a0ac92896fbac8a6626efd7f60ff40a7c51dc709;hp=e5ff64959b67881dee0e86e0413901791463e09b;p=xboard.git

updated documentation
---

diff --git a/FAQ.html b/FAQ.html
index 8f5adee..1e37d79 100644
--- a/FAQ.html
+++ b/FAQ.html
@@ -83,7 +83,9 @@ to help update it.</i></p>
       <li><a href="#tag-B.23">[B.23] Can I get Zippy to automatically reconnect to ICS when its connection breaks?</a></li>
       <li><a href="#tag-B.24">[B.24] The chess engines are too strong and always beat me.  How can I adjust the difficulty level to make them weaker?</a></li>
       <li><a href="#tag-B.25">[B.25] May I use the piece bitmaps from XBoard/WinBoard in my own program?</a></li>
-  </ul></li>
+      <li><a href="#tag-B.26">[B.26] How can I get rid of these silly logos that this new WinBoard displays above the board?</a></li>
+      <li><a href="#tag-B.27">[B.27] How can I install logos for other engines, Internet Chess Servers or Human users?</a></li>
+  </ul></li> 
   
   <li><a name="tag-C0" href="#tag-C">[C] XBoard and WinBoard, bugs and problems</a>
     <ul>
@@ -1099,6 +1101,60 @@ you obtain special permission from Elmar.  See the file README.bitmaps
 that comes with the XBoard and WinBoard source code for more
 information and an email address you can write to.</p>
 
+<hr />
+<h3><a name="tag-B.26">[B.26]
+  How can I get rid of these silly logos that this new WinBoard displays above the board?</a></h3>
+
+<p>WinBoard 4.4.0 has an option /autoLogo, which makes is search for bitmap files to display as logo, 
+in the engine directory or in the folder "logos".
+If you see logos without having asked for them, the settings in your winboard.ini file probably contains the line</p>
+<pre>/autoLogo=true</pre>
+<p>Just change that to /autoLogo=false.
+You can also achieve that by starting WinBoard through the startup dialog (from the start menu),
+and then tick "additional options" at the bottom,
+and type /autoLogo=false in the edit field, before pressing OK.
+If you then later select "Save Settings Now" from the Option menu,
+or when "Save Settings on Exit" is on, and you close WinBoard,
+this will automatically end up in your settings field.
+</p><p>
+When /autoLogo=false, logos will only be displayed if you explicitly ask for them,
+by running WinBoard with the option /firstLogo=FILENAME.bmp or /secondLogo=FILENAME.bmp.
+(Which will not be stored in the winboard.ini,
+but might of course be hidden somewhere in a settings file mentioned on the command line as @SETTINGSFILE.ini.)
+</p>
+
+<hr />
+<h3><a name="tag-B.27">[B.27]
+  How can I install logos for other engines, Internet Chess Servers or Human users?</a></h3>
+
+<p>With the option /autoLogo=true, (which is remembered in your settings file),
+WinBoard automatically looks into the engine folder 
+(specified by the /fd="..." or /sd="..." option), for a file called "logo.bmp". 
+If it is found, it is used as a logo for the engine when it plays.
+So all you have to do is put a logo.bmp file there.
+Popular logo formats are 100x50 and 130x65; many engine logos are available from
+<a href="http://www.geocities.com/davedahlem/my_logos.html">David Dahlem</a> or
+<a href="http://kirill-kryukov.com/chess/discussion-board/viewtopic.php?t=545&f=7">Graham Banks</a>
+</p><p>
+It is possible to overrule the /autoLogo by explicitly using a /firstLogo="FILENAME.bmp" 
+or /secondLogo="FILENAME.bmp" with the engine on the engine line in the startup dialog.
+This is useful for engines that run with an adapter like Polyglot,
+when you have only one polyglot on your system, used by many engines.
+E.g. for Fruit the engine line to be typed in or selected from the combo box is
+<pre>
+"polyglot fruit.ini" /firstLogo="D:\Engines\Fruit\logo.bmp" /fd="D:\Engines\Polyglot"
+</pre>
+This prevents WinBoard looking for the logo in the Polyglot folder.
+</p>
+For Internet Chess Servers and Human users the logos should be in the "logos"
+sub-folder of the folder where WinBoard is installed.
+With /autoLogo=true, WinBoard would look for a logo file in that folder with
+the same name as the ICS, suffixed with .bmp (e.g. freechess.org.bmp)
+or the Human username 
+(specified by the /userName="..." option or taken from the system), 
+suffixed by .bmp, e.g. administrator.bmp)
+</p>
+
 <hr /><h2><a name="tag-C">[C] XBoard and WinBoard, bugs and problems</a></h2>
 
 <hr /><h3><a name="tag-C.1">[C.1] I can't build XBoard
diff --git a/winboard/install/files/root/WinBoard/doc/manual.html b/winboard/install/files/root/WinBoard/doc/manual.html
index 5627b4f..11af3cb 100644
--- a/winboard/install/files/root/WinBoard/doc/manual.html
+++ b/winboard/install/files/root/WinBoard/doc/manual.html
@@ -2,31 +2,36 @@
 <html>
 
 <head>
-<title>WinBoard 4.3.15</title>
+<title>WinBoard 4.4.0</title>
 </head>
 
 <body>
 <table><tr><td halign="top">
-<h1>WinBoard 4.3.15</h1>
+<h1>WinBoard 4.4.0</h1>
 <h2>"For the ultimate WinBoard experience"</h2>
 <h3>Introduction</h3>
 <p>
-The WinBoard 4.3 series is a continuation of the WinBoard_x line by Allessandro Scotti.
-It is been further developed, and is maintained, by H.G. Muller.
+The WinBoard 4.3 series was a continuation of the WinBoard_x line by Allessandro Scotti.
+It has been further developed, and is maintained, by H.G. Muller.
 Most addtions and improvements that went into this since the last version produced
 by the GNU-Savannah xboard project team, WinBoard 4.2.7b,
-are unfortunately not parallelled in xboard.
-On the contrary, they have destroyed the compatibility of the back-end sources
-shared by WinBoard and xboard with the xboard front-end of version 4.2.7b.
-Since WinBoard 4.3.14, however, the releases again coms with a compatible xboard front-end.
+were unfortunately not parallelled in XBoard.
+On the contrary, they had destroyed the compatibility of the back-end sources
+shared by WinBoard and XBoard with the XBoard front-end of version 4.2.7b.
+Since WinBoard 4.3.14, however, the releases again comes with a compatible XBoard front-end.
 That does not mean that all the features added to WinBoard can already be used
-in this xboard version.
+in the latest XBoard version.
 But some can, an in 4.3.15 many more have been added.
 </p><p>
+WinBoard 4.4 is a merger of the WinBoard 4.3 line (WinBoard 4.3.pre16) 
+and what was left in the GNU-Svannah XBoard repository (WinBoard 4.2.pre8).
+More WinBoard functionality has been ported to XBoard,
+but there still is a sizable gap to bridge.
+</p><p>
 The description below applies specifically to WinBoard, 
 although we have tried to mark features that can also be used in xboard by (x) everywhere.
-This version of xboard does does have som new menus added to control such features.
-Other functionss, if they work at all, must be switched on from the command line.
+This version of XBoard now does have some new menus added to control such features.
+Other functions, if they work at all, must be switched on from the command line.
 </p>
 </td><td width="20">
 </td><td width="200" halign="center" cellpdding="20">
@@ -84,7 +89,7 @@ and handles the castling, e.p. and 50-move field in FENs on input and output as
     </td><td>
       Options -> Engine.. (x)
   </td></tr><tr><td>
-      -adjudicateDrawMoves 0 (*)
+      -adjudicateDrawMoves 0 (*x)
     </td><td>
       adjudicate draw when game lasts too long
     </td><td>
@@ -154,9 +159,9 @@ and handles the castling, e.p. and 50-move field in FENs on input and output as
     </td><td>
       -
   </td></tr><tr><td>
-      -delayBeforeQuit 0 (*)
+      -delayBeforeQuit 0 (*x)
       <br>
-      -delayAfterQuit 0 (*)
+      -delayAfterQuit 0 (*x)
     </td><td>
       timing parameter specifying how to terminate the engine processes
     </td><td>
@@ -168,6 +173,12 @@ and handles the castling, e.p. and 50-move field in FENs on input and output as
     </td><td>
       left- or right-cick on clock in edit-game mode
   </td></tr><tr><td>
+      -niceEngines 0 (*x)
+    </td><td>
+      lower the CPU priority of the engines
+    </td><td>
+      -
+  </td></tr><tr><td>
       
     </td><td bgcolor="lightblue">
       <strong>DISPLAY-LOOK OPTIONS</strong>
@@ -234,6 +245,16 @@ and handles the castling, e.p. and 50-move field in FENs on input and output as
     </td><td>
       -
   </td></tr><tr><td>
+      -autoLogo false (*)
+      <br>
+      -firstLogo ""
+      <br>
+      -secondLogo ""
+    </td><td>
+      causes WinBoard to display player logos above the board, next to the clocks.
+    </td><td>
+      -
+  </td></tr><tr><td>
       -
     </td><td>
       Swap white and black clock
@@ -242,85 +263,107 @@ and handles the castling, e.p. and 50-move field in FENs on input and output as
   </td></tr><tr><td>
       
     </td><td bgcolor="lightblue">
-      <strong>UCI ENGINE OPTIONS</strong>
+      <strong>(UCI) ENGINE OPTIONS</strong>
     </td><td>
       
   </td></tr><tr><td>
-      -polyglotDir "" (*)
+      -polyglotDir "" (*x)
     </td><td>
       tells WinBoard where you installed Polyglot, for automatic invocation with UCI engines
     </td><td>
-      Options -> UCI... (x)
+      Options -> Global Settings... (x)
   </td></tr><tr><td>
-      -polyglotBook "" (*)
+      -polyglotBook "" (*x)
     </td><td>
       tells WinBoard which opening book it should use, or should make Polyglot use.
     </td><td>
-      Options -> UCI... (x)
+      Options -> Global Settings... (x)
   </td></tr><tr><td>
-      -usePolyglotBook false (*)
+      -usePolyglotBook false (*x)
     </td><td>
       turns the use of the Polygot book on or off
     </td><td>
-      Options -> UCI... (x)
+      Options -> Global Settings... (x)
   </td></tr><tr><td>
-      -defaultPathEGTB "c:\egtb" (*)
+      -defaultPathEGTB "c:\egtb" (*x)
     </td><td>
       folder where to find end-game tables
     </td><td>
-      Options -> UCI... (x)
+      Options -> Global Settings... (x)
   </td></tr><tr><td>
-      -defaultCacheSizeEGTB 4 (*)
+      -defaultCacheSizeEGTB 4 (*x)
     </td><td>
       specifies the cache size for UCI engines
     </td><td>
-      Options -> UCI... (x)
+      Options -> Global Settings... (x)
   </td></tr><tr><td>
-      -defaultHashSize 64 (*)
+      -defaultHashSize 64 (*x)
     </td><td>
-      Specifies the size of the main hash table for UCI engines
+      specifies the size of the main hash table for UCI engines and WinBoard engines implementing the memory command
     </td><td>
-      Options -> UCI... (x)
+      Options -> Global Settings... (x)
   </td></tr><tr><td>
-      -firstIsUCI false
+      -firstIsUCI false (x)
       <br>
-      -secondIsUCI false
+      -secondIsUCI false (x)
       <br>
-      -fUCI
+      -fUCI (x)
       <br>
-      -sUCI
+      -sUCI (x)
     </td><td>
       tells WinBoard the corresponding engine should be run through Polyglot
     </td><td>
       -
   </td></tr><tr><td>
-      -firstHasOwnBookUCI true
+      -firstHasOwnBookUCI true (x)
       <br>
-      -secondHasOwnBookUCI true
+      -secondHasOwnBookUCI true (x)
       <br>
-      -fNoOwnBookUCI true
+      -fNoOwnBookUCI true (x)
       <br>
-      -sNoOwnBookUCI true
+      -sNoOwnBookUCI true (x)
+      <br>
+      -firstXBook (x)
+      <br>
+      -secondXBook (x)
     </td><td>
-      tells Polyglot if the engine should use its own opening book
+      tells WinBoard (or Polyglot) if the engine should use its own opening book
     </td><td>
-      Options -> Engine Settings... (xboard only)
+      Options -> Global Settings... (x)
   </td></tr><tr><td>
       -smpCores 1 (*x)
     </td><td>
-      Sets the maximum number of CPUs an SMP engine can use.
+      sets the maximum number of CPUs an SMP engine can use.
       (only affects engines that support the <strong>cores</strong> command of WB protocol)
     </td><td>
-      Options -> Engine Settings... (xboard only)
+      Options -> Global Settings... (x)
   </td></tr><tr><td>
       -egtFormats "" (*x)
     </td><td>
-      Specifies which end-game tables are installed on the computer,
+      specifies which end-game tables are installed on the computer,
       and where they can be found
       (e.g. "nalimov:\chess\egtb,scorpio:\chess\bitbases")
     </td><td>
       -
   </td></tr><tr><td>
+      -firstOptions "" (x)
+      <br>
+      -secondOptions "" (x)
+    </td><td>
+      sets engine-defined options of UCI engines and WinBoard engines that support the option feature.
+    </td><td>
+      Options -> Engine #1 Settings... (x)
+      <br>
+      Options -> Engine #2 Settings... (x)
+  </td></tr><tr><td>
+      -firstNeedsNoncompliantFEN "" (x)
+      <br>
+      -secondNeedsNoncompliantFEN "" (x)
+    </td><td>
+      directly specifies castling and e.p. field to be used in all FENs sent to mentioned engine
+    </td><td>
+      -
+  </td></tr><tr><td>
       
     </td><td bgcolor="lightblue">
       <strong>CHESS-VARIANT OPTIONS</strong>
@@ -341,7 +384,7 @@ and handles the castling, e.p. and 50-move field in FENs on input and output as
       -variant normal (x)
     </td><td>
       supports many new variants: xiangqi, shogi, fischerandom, capabanca, gothic, caparandom, janus,
-      shatranj, courier, knightmate, berolina, falcon, cylinder, fairy, super
+      shatranj, courier, knightmate, berolina, falcon, cylinder, fairy, super, great
     </td><td>
       File -> New Variant... (x)
   </td></tr><tr><td>
@@ -401,13 +444,19 @@ and handles the castling, e.p. and 50-move field in FENs on input and output as
     </td><td>
       Options -> General... (x)
   </td></tr><tr><td>
+      -userName "" (x)
+    </td><td>
+      sets the name of the human player
+    </td><td>
+      Mode -> Enter Username... (x)
+  </td></tr><tr><td>
       
     </td><td bgcolor="lightblue">
       <strong>USER-INTERFACE OPTIONS AND WINDOW CONTROL</strong>
     </td><td>
       
   </td></tr><tr><td>
-      -moveHistoryUP true (*)
+      -moveHistoryUp true (*)
       <br>
       -moveHistoryX 0 (*)
       <br>
@@ -418,6 +467,7 @@ and handles the castling, e.p. and 50-move field in FENs on input and output as
       -moveHistoryH 0 (*)
     </td><td>
       controls opening, placement and size of a window containing the moves of the current game
+      (new in 4.4 is that all X and Y coordinates of auxiliary windows are stored relative to the main window)
     </td><td>
       Mode -> Show Move History (x)
   </td></tr><tr><td>
@@ -488,20 +538,50 @@ and handles the castling, e.p. and 50-move field in FENs on input and output as
     </td><td>
       Options -> Game List...
   </td></tr><tr><td>
+      -noGUI (x)
+    </td><td>
+      suppress update of display on all machine and ICS moves (moves, clocks, icon)
+    </td><td>
+      -
+  </td></tr><tr><td>
+      
+    </td><td bgcolor="lightblue">
+      <strong>ICS OPTIONS</strong>
+    </td><td>
+      
+  </td></tr><tr><td>
+      -autoKibitz (x)
+    </td><td>
+      kibitz engine Thinking Output to ICS, and capture opponent kibitz for in PGN
+    </td><td>
+      -
+  </td></tr><tr><td>
+      -zippyShortGame 0 (x)
+    </td><td>
+      ban opponents on ICS that abort without playing
+    </td><td>
+      -
+  </td></tr><tr><td>
       
     </td><td bgcolor="lightblue">
       <strong>MISCELLANEOUS</strong>
     </td><td>
       
   </td></tr><tr><td>
-      -debugFile "winboard.debug"
+      -debugFile "winboard.debug" (x)
       <br>
-      -nameOfDebugFile "winboard.debug"
+      -nameOfDebugFile "winboard.debug" (x)
     </td><td>
       allows you to specify an alternative name for saving the debug information
     </td><td>
       -
   </td></tr><tr><td>
+      -engineDebugOutput 0 (x)
+    </td><td>
+      tells WinBoard if and how to put protocol-violating output in the debug file
+    </td><td>
+      -
+  </td></tr><tr><td>
       -
     </td><td>
       save chess-board display as diagram in bitmap file
@@ -509,6 +589,12 @@ and handles the castling, e.p. and 50-move field in FENs on input and output as
     </td><td>
       File -> Save Diagram...
   </td></tr><tr><td>
+      -defaultFrcPosition -1 (*x)
+    </td><td>
+      specify the number of the starting position in shuffle Chess variants
+    </td><td>
+      File -> New Shuffle Game... (x)
+  </td></tr><tr><td>
       -
     </td><td>
       display only those lines in the game list that contain a given string
@@ -525,6 +611,12 @@ and handles the castling, e.p. and 50-move field in FENs on input and output as
       and -2 after every two games (so that each position is played with black and white).
     </td><td>
       -
+  </td></tr><tr><td>
+      -sameColorGames 0 (x)
+    </td><td>
+      play a match, but without alternating the colors (overrules -matchGames)
+    </td><td>
+      -
 </td></tr></table>
 <p>
 The value with which the option is listed is the default value.