Add description of -var option to man page
authorH.G.Muller <hgm@hgm-xboard.(none)>
Wed, 21 Sep 2016 21:20:02 +0000 (23:20 +0200)
committerH.G.Muller <hgm@hgm-xboard.(none)>
Wed, 21 Sep 2016 21:20:02 +0000 (23:20 +0200)
uci2wb.pod

index b38c0f4..2ceb94c 100644 (file)
@@ -5,7 +5,7 @@ uci2wb - Protocol adapter for UCI dialects to XBoard
 
 =head1 SYNOPSIS
 
-B<uci2wb> [debug] [-c|-s|-x] engine [directory]
+B<uci2wb> [debug] [-var <variant>] [-c|-s|-x] engine [directory]
 
 
 =head1 DESCRIPTION
@@ -41,6 +41,13 @@ it supports Chess960 even for UCI engines that don't have the standard UCI_Chess
 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<-var <variant>>
+
+Forces uci2wb to announce to the GUI it supports (only) the specified variant.
+There is no standardized way for UxI engines to announce what they can play,
+so if these are not the standard variants implied by the protocol choice,
+(but, f.e. seirawan or 6x6+6_shogi) it has to be configured on the
+uci2wb command line through this option.
 
 =item B<debug>
 
@@ -59,7 +66,7 @@ as additional engine option.
 If a directory is specified, the engine is started
 with that directory set as current directory.
 
-=item N<byoyomi work-arounds>
+=item B<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