updated documentation
authorH.G. Muller <h.g.muller@hccnet.nl>
Tue, 1 Sep 2009 03:25:17 +0000 (20:25 -0700)
committerArun Persaud <arun@nubati.net>
Tue, 1 Sep 2009 03:25:17 +0000 (20:25 -0700)
FAQ.html
winboard/install/files/root/WinBoard/doc/manual.html

index 8f5adee..1e37d79 100644 (file)
--- 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
index 5627b4f..11af3cb 100644 (file)
@@ -2,31 +2,36 @@
 <html>\r
 \r
 <head>\r
-<title>WinBoard 4.3.15</title>\r
+<title>WinBoard 4.4.0</title>\r
 </head>\r
 \r
 <body>\r
 <table><tr><td halign="top">\r
-<h1>WinBoard 4.3.15</h1>\r
+<h1>WinBoard 4.4.0</h1>\r
 <h2>"For the ultimate WinBoard experience"</h2>\r
 <h3>Introduction</h3>\r
 <p>\r
-The WinBoard 4.3 series is a continuation of the WinBoard_x line by Allessandro Scotti.\r
-It is been further developed, and is maintained, by H.G. Muller.\r
+The WinBoard 4.3 series was a continuation of the WinBoard_x line by Allessandro Scotti.\r
+It has been further developed, and is maintained, by H.G. Muller.\r
 Most addtions and improvements that went into this since the last version produced\r
 by the GNU-Savannah xboard project team, WinBoard 4.2.7b,\r
-are unfortunately not parallelled in xboard.\r
-On the contrary, they have destroyed the compatibility of the back-end sources\r
-shared by WinBoard and xboard with the xboard front-end of version 4.2.7b.\r
-Since WinBoard 4.3.14, however, the releases again coms with a compatible xboard front-end.\r
+were unfortunately not parallelled in XBoard.\r
+On the contrary, they had destroyed the compatibility of the back-end sources\r
+shared by WinBoard and XBoard with the XBoard front-end of version 4.2.7b.\r
+Since WinBoard 4.3.14, however, the releases again comes with a compatible XBoard front-end.\r
 That does not mean that all the features added to WinBoard can already be used\r
-in this xboard version.\r
+in the latest XBoard version.\r
 But some can, an in 4.3.15 many more have been added.\r
 </p><p>\r
+WinBoard 4.4 is a merger of the WinBoard 4.3 line (WinBoard 4.3.pre16) \r
+and what was left in the GNU-Svannah XBoard repository (WinBoard 4.2.pre8).\r
+More WinBoard functionality has been ported to XBoard,\r
+but there still is a sizable gap to bridge.\r
+</p><p>\r
 The description below applies specifically to WinBoard, \r
 although we have tried to mark features that can also be used in xboard by (x) everywhere.\r
-This version of xboard does does have som new menus added to control such features.\r
-Other functionss, if they work at all, must be switched on from the command line.\r
+This version of XBoard now does have some new menus added to control such features.\r
+Other functions, if they work at all, must be switched on from the command line.\r
 </p>\r
 </td><td width="20">\r
 </td><td width="200" halign="center" cellpdding="20">\r
@@ -84,7 +89,7 @@ and handles the castling, e.p. and 50-move field in FENs on input and output as
     </td><td>\r
       Options -> Engine.. (x)\r
   </td></tr><tr><td>\r
-      -adjudicateDrawMoves 0 (*)\r
+      -adjudicateDrawMoves 0 (*x)\r
     </td><td>\r
       adjudicate draw when game lasts too long\r
     </td><td>\r
@@ -154,9 +159,9 @@ and handles the castling, e.p. and 50-move field in FENs on input and output as
     </td><td>\r
       -\r
   </td></tr><tr><td>\r
-      -delayBeforeQuit 0 (*)\r
+      -delayBeforeQuit 0 (*x)\r
       <br>\r
-      -delayAfterQuit 0 (*)\r
+      -delayAfterQuit 0 (*x)\r
     </td><td>\r
       timing parameter specifying how to terminate the engine processes\r
     </td><td>\r
@@ -168,6 +173,12 @@ and handles the castling, e.p. and 50-move field in FENs on input and output as
     </td><td>\r
       left- or right-cick on clock in edit-game mode\r
   </td></tr><tr><td>\r
+      -niceEngines 0 (*x)\r
+    </td><td>\r
+      lower the CPU priority of the engines\r
+    </td><td>\r
+      -\r
+  </td></tr><tr><td>\r
       \r
     </td><td bgcolor="lightblue">\r
       <strong>DISPLAY-LOOK OPTIONS</strong>\r
@@ -233,6 +244,16 @@ and handles the castling, e.p. and 50-move field in FENs on input and output as
       controls the color of the highlight arrow\r
     </td><td>\r
       -\r
+  </td></tr><tr><td>\r
+      -autoLogo false (*)\r
+      <br>\r
+      -firstLogo ""\r
+      <br>\r
+      -secondLogo ""\r
+    </td><td>\r
+      causes WinBoard to display player logos above the board, next to the clocks.\r
+    </td><td>\r
+      -\r
   </td></tr><tr><td>\r
       -\r
     </td><td>\r
@@ -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>\r
       \r
     </td><td bgcolor="lightblue">\r
-      <strong>UCI ENGINE OPTIONS</strong>\r
+      <strong>(UCI) ENGINE OPTIONS</strong>\r
     </td><td>\r
       \r
   </td></tr><tr><td>\r
-      -polyglotDir "" (*)\r
+      -polyglotDir "" (*x)\r
     </td><td>\r
       tells WinBoard where you installed Polyglot, for automatic invocation with UCI engines\r
     </td><td>\r
-      Options -> UCI... (x)\r
+      Options -> Global Settings... (x)\r
   </td></tr><tr><td>\r
-      -polyglotBook "" (*)\r
+      -polyglotBook "" (*x)\r
     </td><td>\r
       tells WinBoard which opening book it should use, or should make Polyglot use.\r
     </td><td>\r
-      Options -> UCI... (x)\r
+      Options -> Global Settings... (x)\r
   </td></tr><tr><td>\r
-      -usePolyglotBook false (*)\r
+      -usePolyglotBook false (*x)\r
     </td><td>\r
       turns the use of the Polygot book on or off\r
     </td><td>\r
-      Options -> UCI... (x)\r
+      Options -> Global Settings... (x)\r
   </td></tr><tr><td>\r
-      -defaultPathEGTB "c:\egtb" (*)\r
+      -defaultPathEGTB "c:\egtb" (*x)\r
     </td><td>\r
       folder where to find end-game tables\r
     </td><td>\r
-      Options -> UCI... (x)\r
+      Options -> Global Settings... (x)\r
   </td></tr><tr><td>\r
-      -defaultCacheSizeEGTB 4 (*)\r
+      -defaultCacheSizeEGTB 4 (*x)\r
     </td><td>\r
       specifies the cache size for UCI engines\r
     </td><td>\r
-      Options -> UCI... (x)\r
+      Options -> Global Settings... (x)\r
   </td></tr><tr><td>\r
-      -defaultHashSize 64 (*)\r
+      -defaultHashSize 64 (*x)\r
     </td><td>\r
-      Specifies the size of the main hash table for UCI engines\r
+      specifies the size of the main hash table for UCI engines and WinBoard engines implementing the memory command\r
     </td><td>\r
-      Options -> UCI... (x)\r
+      Options -> Global Settings... (x)\r
   </td></tr><tr><td>\r
-      -firstIsUCI false\r
+      -firstIsUCI false (x)\r
       <br>\r
-      -secondIsUCI false\r
+      -secondIsUCI false (x)\r
       <br>\r
-      -fUCI\r
+      -fUCI (x)\r
       <br>\r
-      -sUCI\r
+      -sUCI (x)\r
     </td><td>\r
       tells WinBoard the corresponding engine should be run through Polyglot\r
     </td><td>\r
       -\r
   </td></tr><tr><td>\r
-      -firstHasOwnBookUCI true\r
+      -firstHasOwnBookUCI true (x)\r
       <br>\r
-      -secondHasOwnBookUCI true\r
+      -secondHasOwnBookUCI true (x)\r
       <br>\r
-      -fNoOwnBookUCI true\r
+      -fNoOwnBookUCI true (x)\r
       <br>\r
-      -sNoOwnBookUCI true\r
+      -sNoOwnBookUCI true (x)\r
+      <br>\r
+      -firstXBook (x)\r
+      <br>\r
+      -secondXBook (x)\r
     </td><td>\r
-      tells Polyglot if the engine should use its own opening book\r
+      tells WinBoard (or Polyglot) if the engine should use its own opening book\r
     </td><td>\r
-      Options -> Engine Settings... (xboard only)\r
+      Options -> Global Settings... (x)\r
   </td></tr><tr><td>\r
       -smpCores 1 (*x)\r
     </td><td>\r
-      Sets the maximum number of CPUs an SMP engine can use.\r
+      sets the maximum number of CPUs an SMP engine can use.\r
       (only affects engines that support the <strong>cores</strong> command of WB protocol)\r
     </td><td>\r
-      Options -> Engine Settings... (xboard only)\r
+      Options -> Global Settings... (x)\r
   </td></tr><tr><td>\r
       -egtFormats "" (*x)\r
     </td><td>\r
-      Specifies which end-game tables are installed on the computer,\r
+      specifies which end-game tables are installed on the computer,\r
       and where they can be found\r
       (e.g. "nalimov:\chess\egtb,scorpio:\chess\bitbases")\r
     </td><td>\r
       -\r
   </td></tr><tr><td>\r
+      -firstOptions "" (x)\r
+      <br>\r
+      -secondOptions "" (x)\r
+    </td><td>\r
+      sets engine-defined options of UCI engines and WinBoard engines that support the option feature.\r
+    </td><td>\r
+      Options -> Engine #1 Settings... (x)\r
+      <br>\r
+      Options -> Engine #2 Settings... (x)\r
+  </td></tr><tr><td>\r
+      -firstNeedsNoncompliantFEN "" (x)\r
+      <br>\r
+      -secondNeedsNoncompliantFEN "" (x)\r
+    </td><td>\r
+      directly specifies castling and e.p. field to be used in all FENs sent to mentioned engine\r
+    </td><td>\r
+      -\r
+  </td></tr><tr><td>\r
       \r
     </td><td bgcolor="lightblue">\r
       <strong>CHESS-VARIANT OPTIONS</strong>\r
@@ -341,7 +384,7 @@ and handles the castling, e.p. and 50-move field in FENs on input and output as
       -variant normal (x)\r
     </td><td>\r
       supports many new variants: xiangqi, shogi, fischerandom, capabanca, gothic, caparandom, janus,\r
-      shatranj, courier, knightmate, berolina, falcon, cylinder, fairy, super\r
+      shatranj, courier, knightmate, berolina, falcon, cylinder, fairy, super, great\r
     </td><td>\r
       File -> New Variant... (x)\r
   </td></tr><tr><td>\r
@@ -401,13 +444,19 @@ and handles the castling, e.p. and 50-move field in FENs on input and output as
     </td><td>\r
       Options -> General... (x)\r
   </td></tr><tr><td>\r
+      -userName "" (x)\r
+    </td><td>\r
+      sets the name of the human player\r
+    </td><td>\r
+      Mode -> Enter Username... (x)\r
+  </td></tr><tr><td>\r
       \r
     </td><td bgcolor="lightblue">\r
       <strong>USER-INTERFACE OPTIONS AND WINDOW CONTROL</strong>\r
     </td><td>\r
       \r
   </td></tr><tr><td>\r
-      -moveHistoryUP true (*)\r
+      -moveHistoryUp true (*)\r
       <br>\r
       -moveHistoryX 0 (*)\r
       <br>\r
@@ -418,6 +467,7 @@ and handles the castling, e.p. and 50-move field in FENs on input and output as
       -moveHistoryH 0 (*)\r
     </td><td>\r
       controls opening, placement and size of a window containing the moves of the current game\r
+      (new in 4.4 is that all X and Y coordinates of auxiliary windows are stored relative to the main window)\r
     </td><td>\r
       Mode -> Show Move History (x)\r
   </td></tr><tr><td>\r
@@ -488,19 +538,49 @@ and handles the castling, e.p. and 50-move field in FENs on input and output as
     </td><td>\r
       Options -> Game List...\r
   </td></tr><tr><td>\r
+      -noGUI (x)\r
+    </td><td>\r
+      suppress update of display on all machine and ICS moves (moves, clocks, icon)\r
+    </td><td>\r
+      -\r
+  </td></tr><tr><td>\r
+      \r
+    </td><td bgcolor="lightblue">\r
+      <strong>ICS OPTIONS</strong>\r
+    </td><td>\r
+      \r
+  </td></tr><tr><td>\r
+      -autoKibitz (x)\r
+    </td><td>\r
+      kibitz engine Thinking Output to ICS, and capture opponent kibitz for in PGN\r
+    </td><td>\r
+      -\r
+  </td></tr><tr><td>\r
+      -zippyShortGame 0 (x)\r
+    </td><td>\r
+      ban opponents on ICS that abort without playing\r
+    </td><td>\r
+      -\r
+  </td></tr><tr><td>\r
       \r
     </td><td bgcolor="lightblue">\r
       <strong>MISCELLANEOUS</strong>\r
     </td><td>\r
       \r
   </td></tr><tr><td>\r
-      -debugFile "winboard.debug"\r
+      -debugFile "winboard.debug" (x)\r
       <br>\r
-      -nameOfDebugFile "winboard.debug"\r
+      -nameOfDebugFile "winboard.debug" (x)\r
     </td><td>\r
       allows you to specify an alternative name for saving the debug information\r
     </td><td>\r
       -\r
+  </td></tr><tr><td>\r
+      -engineDebugOutput 0 (x)\r
+    </td><td>\r
+      tells WinBoard if and how to put protocol-violating output in the debug file\r
+    </td><td>\r
+      -\r
   </td></tr><tr><td>\r
       -\r
     </td><td>\r
@@ -508,6 +588,12 @@ and handles the castling, e.p. and 50-move field in FENs on input and output as
       (only works for the smaller board formats!)\r
     </td><td>\r
       File -> Save Diagram...\r
+  </td></tr><tr><td>\r
+      -defaultFrcPosition -1 (*x)\r
+    </td><td>\r
+      specify the number of the starting position in shuffle Chess variants\r
+    </td><td>\r
+      File -> New Shuffle Game... (x)\r
   </td></tr><tr><td>\r
       -\r
     </td><td>\r
@@ -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).\r
     </td><td>\r
       -\r
+  </td></tr><tr><td>\r
+      -sameColorGames 0 (x)\r
+    </td><td>\r
+      play a match, but without alternating the colors (overrules -matchGames)\r
+    </td><td>\r
+      -\r
 </td></tr></table>\r
 <p>\r
 The value with which the option is listed is the default value.\r