Update man page
authorH.G.Muller <hgm@hgm-xboard.(none)>
Wed, 21 Sep 2016 21:03:39 +0000 (23:03 +0200)
committerH.G.Muller <hgm@hgm-xboard.(none)>
Wed, 21 Sep 2016 21:03:39 +0000 (23:03 +0200)
The manual page is updated with
- mentioning of the Arena960 dialect and -f flag to trigger it
- discussion of byoyomi TC, and the options to force it
- replacing the defunct USI specs URL by a valid one on my own website

uci2wb.pod

index 18e0802..b38c0f4 100644 (file)
@@ -19,7 +19,7 @@ to the GUI as an engine using XBoard protocol
 
 The protocols for which it can mediate are UCI
 (both the official standard, as well as the 'Cyclone dialect' that is commonly used
-by Chinese-Chess engines),
+by Chinese-Chess engines, and the 'Arena960 dialect' used by pre-standard Chess960 engines),
 USI ('Universal Shogi Interface', used by some Shogi engines)
 and UCCI ('Universal Chinese-Chess Interface').
 When set to UCI, it automatically uses Cyclone dialect when playing xiangqi games.
@@ -29,13 +29,18 @@ When set to UCI, it automatically uses Cyclone dialect when playing xiangqi game
 
 =over 8
 
-=item B<-c -s -x>
+=item B<-c -s -x -f>
 
 The flag arguments B<-c> (default), B<-s> or B<-x> set uci2wb to use UCI, USI or UCCI, respectively.
 If there is more than one character in the flag argument,
 all characters but the first are ignored.
 This can be used by passing uci2wb the full variant name ('shogi' or 'xiangqi') as a flag,
 to make it automatically choose the appropriate protocol (USI or UCCI).
+Other values also select UCI, but the value B<-f> in addition implies uci2wb should announce
+it supports Chess960 even for UCI engines that don't have the standard UCI_Chess960 option,
+and in that case causes castlings to be sent to them as O-O or O-O-O
+instead of the standard KxR notation.
+
 
 =item B<debug>
 
@@ -45,13 +50,25 @@ This would make it appear in the GUI's log of the engine communication.
 Some critical commands it sends to the engine
 (such as the 'position-moves' and 'go' commands)
 will be reported as well.
-
+This option can also be switched interactively,
+through the 'UCI2WB debug output' checkbox option appearing
+as additional engine option.
 
 =item B<directory>
 
 If a directory is specified, the engine is started
 with that directory set as current directory.
 
+=item N<byoyomi work-arounds>
+
+Byoyomi is a mode of time control in USI not supported by CECP.
+Engines can be forced to run in this mode by letting the GUI use
+incremental or sudden-death TC,
+and ticking the interactive 'Floating Byoyomi' checkbox option
+that uci2wb pools with the engine options.
+An accompanying option 'Byoyomi (sec)' allows you to force a fixed
+value >= 0 for the byoyomi to be sent to the engine
+when 'Floating Byoyomi' is off.
 
 =back
 
@@ -69,7 +86,7 @@ WinBoard, B<xboard>(6) interface ("Chess Engine Communication Protocol")
 
 UCI specs: http://www.shredderchess.com/chess-info/features/uci-universal-chess-interface.html
 
-USI specs: http://www.glaurungchess.com/shogi/usi.html
+USI specs: http://hgm.nubati.net/usi.html
 
 UCCI specs: http://www.xqbase.com/protocol/cchess_ucci.htm