Update man file
authorH.G. Muller <h.g.muller@hccnet.nl>
Wed, 1 Dec 2010 23:39:28 +0000 (00:39 +0100)
committerH.G. Muller <h.g.muller@hccnet.nl>
Thu, 2 Dec 2010 19:24:03 +0000 (20:24 +0100)
fairymax.pod

index 8f122af..09808ae 100644 (file)
@@ -18,7 +18,8 @@ B<fairymax> is a program that plays chess and chess variants.
 It uses the xboard/winboard chess-engine protocol to communicate.
 Apart from 'regular' chess (also known as the Mad-Queen variant),
 it can play Capablanca chess, gothic chess, knightmate, cylinder chess, 
-berolina chess, superchess, makruk (Thai chess) and courier chess.
+berolina chess, superchess, makruk (Thai chess), courier chess,
+Seirawan Chess, Spartan chess and chess with Different Armies.
 Fairy-Max can be easily configured by the user to play other variants as well,
 by modifying the ini file.
 This ini file describes the rules of movement
@@ -31,7 +32,7 @@ A version of Fairy-Max adapted to implement the baring rule is
 available under the name B<shamax>.
 
 Similarly, a version of Fairy-Max adapted to play Xiang Qi (Chinese Chess)
-is included in the fmax package as well.
+is included in the fairymax package as well, under the name B<maxqi>.
 
 B<fairymax> is a derivative of the world's (once) smallest chess program 
 (source-code wise), micro-Max.
@@ -57,8 +58,17 @@ to get correct display of the elephant and general pieces in shatranj.
 Note that to be able to play the chess variants,
 you will need xboard 4.3.14 or later.
 
+Some of the variants Fairy-Max plays are only partially supported by XBoard,
+and can only be played whith the legality-testing function of the latter switched off.
+(This applies to cylinder chess, berolina chess, great shatranj, Spartan chess
+and chess with different armies.)
+For some variants even the name is unknown to XBoard,
+and they are all grouped under the catchall name 'fairy'.
+Which variant is played by Fairy-Max when XBoard is set to 'fairy',
+can be determined by a combobox control in the XBoard 'Engine Settings' menu dialog.
+
 Fairymax supports multi-PV mode: by specifying a non-zero multi-PV margin in the
-Options -> Engine-Settings dialog of XBoard, Fairy-Max will not only print the
+Engine-Settings dialog of XBoard, Fairy-Max will not only print the
 principal variation for the best move, but also for every move that approaches
 the score of this best move to within the set margin.
 (If it does not find the best move on the first try, this might lead to printing
@@ -116,7 +126,7 @@ http://www.chessvariants.org/index/msdisplay.php?itemid=MSfairy-max
 
 http://home.hccnet.nl/h.g.muller/max-src2.html
 
-http://www.open-aurec.com/wbforum/viewtopic.php?t=49439
+http://www.open-aurec.com/wbforum/viewtopic.php?f=19&t=50387
 
 
 =head1 AUTHOR