Update and improve manual page
authorH.G. Muller <h.g.muller@hccnet.nl>
Sat, 8 Oct 2011 13:37:24 +0000 (15:37 +0200)
committerH.G. Muller <h.g.muller@hccnet.nl>
Sat, 8 Oct 2011 13:37:24 +0000 (15:37 +0200)
fairymax.pod

index 09808ae..380d0a8 100644 (file)
@@ -18,8 +18,9 @@ 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), courier chess,
-Seirawan Chess, Spartan chess and chess with Different Armies.
+berolina chess, superchess, makruk (Thai chess, also with Cambodian rules), 
+courier chess, Seirawan Chess, Spartan chess, falcon chess, great shatranj
+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
@@ -60,7 +61,7 @@ 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
+(This applies to cylinder chess, berolina chess, great shatranj,
 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'.
@@ -83,7 +84,7 @@ which the user can draw on to define his own variants.
 
 Amongst the move types supported by Fairy-Max are normal leaper and slider moves,
 (e.g. knight and rook),
-divergent moves (i.e. capture and non-capture moves can be different)
+divergent moves (i.e. capture and non-capture moves can be different),
 hoppers (which jump over other pieces, such as the Chinese cannon or the grasshopper),
 lame leapers (the move of which can be blocked on squares they cannot move to,
 such as the Chinese horse and elephant),
@@ -111,26 +112,45 @@ making this argument superfluous.
 =item B<iniFile>
 
 A second or non-numeric first argument is taken as a filename.
-Fairy-max will use the mentioned file in stead of its default fmax.ini file
+Fairy-Max will use the mentioned file in stead of its default fmax.ini file
 to define the movement of pieces and initial setup of the variants.
 This makes it easier to define your own variants.
 
+=item B<INTERACTIVE OPTIONS>
+
+Fairy-Max also supports some options that can only be set interactively,
+though XBoard's engine settings menu dialog.
+These include a setting to further define -variant fairy,
+(e.g. which armies to pit against each other in chess with different armies),
+and whether makruk is to be played with Thai or Cambodian rules
+(the latter requiring XBoard's legality testing to be switched off!).
+You can also enable resigning, and set a score threshold for 
+when Fairy-Max should do it,
+and define the already mentioned multi-PV margin there.
+
+
 =back
 
+=head1 AVAILABILITY
+
+At http://hgm.nubati.net/cgi-bin/gitweb.cgi the source code can be obtained.
 
 =head1 SEE ALSO
 
 xboard(6)
 
-http://www.chessvariants.org/index/msdisplay.php?itemid=MSfairy-max
+explanations: http://www.chessvariants.org/index/msdisplay.php?itemid=MSfairy-max
+
+micro-Max: http://home.hccnet.nl/h.g.muller/max-src2.html
 
-http://home.hccnet.nl/h.g.muller/max-src2.html
+XBoard: http://hgm.nubati.net
 
-http://www.open-aurec.com/wbforum/viewtopic.php?f=19&t=50387
+=head1 STANDARDS
 
+WinBoard, B<xboard>(6) interface ("Chess Engine Communication Protocol")
 
 =head1 AUTHOR
 
-B<Fairy-Max> was written by H.G.Muller <h.g.muller@hccnet.nl>.
+H.G.Muller <h.g.muller@hccnet.nl>.
 
 This manual page was generated with pod2man(1).