Add option -nice to lower engine priority
[uci2wb.git] / uci2wb.pod
index 2ceb94c..72117fe 100644 (file)
@@ -5,7 +5,7 @@ uci2wb - Protocol adapter for UCI dialects to XBoard
 
 =head1 SYNOPSIS
 
-B<uci2wb> [debug] [-var <variant>] [-c|-s|-x] engine [directory]
+B<uci2wb> [debug] [-var <variant>] [-nice <priority>] [-c|-s|-x] engine [directory]
 
 
 =head1 DESCRIPTION
@@ -44,11 +44,17 @@ 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,
+Although a UCI_Variant option has been proposed as a way for UxI engines to announce what they can play,
+(and is supported by uci2wb), not many engines implement this.
+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<-nice <priority>>
+
+Runs the engine processes at the requested priority;
+positive values lower the priority.
+
 =item B<debug>
 
 Makes uci2wb report to the GUI everything it receives from the engine,