new developer release
[xboard.git] / manual / xboard.txt
index 493ced7..f4b8337 100644 (file)
@@ -11,7 +11,7 @@ chess engines (such as GNU Chess), the Internet Chess Servers,
 electronic mail correspondence chess, or your own collection of saved
 games.
 
-   This manual documents version 4.4.0j of XBoard.
+   This manual documents version 4.4.3 of XBoard.
 
 1 Major modes
 *************
@@ -1927,6 +1927,7 @@ lowTimeWarning true/false
           cylinder      Pieces wrap around the board edge
           knightmate    King moves as Knight, and vice versa
           super         Superchess (shuffle variant with 4 exo-pieces)
+          makruk        Thai Chess (shatranj-like, P promotes on 6th rank)
           fairy         A catchall variant in which all piece types
                         known to XBoard can participate (8x8)
           unknown       Catchall for other unknown variants
@@ -1976,7 +1977,7 @@ lowTimeWarning true/false
      Chess960.  A value of -1 means the position is randomly generated
      by XBoard at the beginning of every game.  Default: -1
 
--pieceToSquareTable string
+-pieceToCharTable string
      The characters that are used to represent the piece types XBoard
      knows in FEN diagrams and SAN moves. The string argument has to
      have an even length (or it will be ignored), as white and black
@@ -2714,8 +2715,8 @@ use, data or profits, whether in an action of contract, negligence or
 other tortious action, arising out of or in connection with the use or
 performance of this software.
 
-   Enhancements copyright (C) 1992-2003,2004,2005,2006,2007,2008,2009
-Free Software Foundation, Inc.
+   Enhancements copyright (C) 1992-2003, 2004, 2005, 2006, 2007, 2008,
+2009, 2010 Free Software Foundation, Inc.
 
 Published by the Free Software Foundation
 59 Temple Place - Suite 330
@@ -3470,13 +3471,13 @@ Index
 <<, Button:                                    See 2.4.      (line  501)
 >, Button:                                     See 2.4.      (line  488)
 >>, Button:                                    See 2.4.      (line  520)
-abort, ICS command:                            See 4.        (line 2118)
+abort, ICS command:                            See 4.        (line 2119)
 Abort, Menu Item:                              See 2.3.      (line  440)
 About XBoard, Menu Item:                       See 2.6.      (line  842)
-accept, ICS command:                           See 4.        (line 2105)
+accept, ICS command:                           See 4.        (line 2106)
 Accept, Menu Item:                             See 2.3.      (line  415)
 Action, Menu:                                  See 2.3.      (line  414)
-adjourn, ICS command:                          See 4.        (line 2118)
+adjourn, ICS command:                          See 4.        (line 2119)
 Adjourn, Menu Item:                            See 2.3.      (line  436)
 Adjudicate Draw, Menu Item:                    See 2.3.      (line  459)
 Adjudicate to Black, Menu Item:                See 2.3.      (line  459)
@@ -3494,7 +3495,7 @@ Animate Moving, Menu Item:                     See 2.5.      (line  619)
 animate, option:                               See 3.5.      (line 1802)
 animateDragging, option:                       See 3.5.      (line 1798)
 animateMoving, option:                         See 3.5.      (line 1802)
-Authors:                                       See 9.        (line 2355)
+Authors:                                       See 9.        (line 2356)
 Auto Comment, Menu Item:                       See 2.5.      (line  627)
 Auto Flag, Menu Item:                          See 2.5.      (line  635)
 Auto Flip View, Menu Item:                     See 2.5.      (line  644)
@@ -3524,22 +3525,22 @@ Blindfold, Menu Item:                          See 2.5.      (line  674)
 blindfold, option:                             See 3.5.      (line 1696)
 bm, option:                                    See 3.5.      (line 1729)
 board size:                                    See 3.5.      (line 1610)
-boardHeight, option:                           See 3.7.      (line 1955)
+boardHeight, option:                           See 3.7.      (line 1956)
 boardSize, option:                             See 3.5.      (line 1610)
-boardWidth, option:                            See 3.7.      (line 1960)
+boardWidth, option:                            See 3.7.      (line 1961)
 Book, Menu Item:                               See 2.6.      (line  832)
-Bug reports:                                   See 8.        (line 2337)
-Bugs <1>:                                      See 8.        (line 2337)
-Bugs:                                          See 7.        (line 2277)
+Bug reports:                                   See 8.        (line 2338)
+Bugs <1>:                                      See 8.        (line 2338)
+Bugs:                                          See 7.        (line 2278)
 buttons, option:                               See 3.5.      (line 1670)
 Call Flag, Menu Item:                          See 2.3.      (line  425)
 checkMates, option:                            See 3.6.      (line 1838)
 Chess engine options:                          See 3.1.      (line  919)
-CHESSDIR:                                      See 6.        (line 2268)
+CHESSDIR:                                      See 6.        (line 2269)
 clock, option:                                 See 3.1.      (line  936)
 clockFont, option:                             See 3.5.      (line 1700)
 clockMode, option:                             See 3.1.      (line  936)
-cmail:                                         See 10.       (line 2407)
+cmail:                                         See 10.       (line 2408)
 colorChallenge, option:                        See 3.3.      (line 1394)
 colorChannel, option:                          See 3.3.      (line 1394)
 colorChannel1, option:                         See 3.3.      (line 1394)
@@ -3553,26 +3554,26 @@ colorSeek, option:                             See 3.3.      (line 1394)
 colorShout, option:                            See 3.3.      (line 1394)
 colorSShout, option:                           See 3.3.      (line 1394)
 colorTell, option:                             See 3.3.      (line 1394)
-Contributors:                                  See 9.        (line 2355)
+Contributors:                                  See 9.        (line 2356)
 coordFont, option:                             See 3.5.      (line 1706)
 coords, option:                                See 3.5.      (line 1640)
 Copy Game, Menu Item:                          See 2.1.      (line  167)
 Copy Position, Menu Item:                      See 2.1.      (line  207)
 darkSquareColor, option:                       See 3.5.      (line 1776)
-debug, option:                                 See 3.7.      (line 2006)
-debugFile, option:                             See 3.7.      (line 2009)
-debugMode, option:                             See 3.7.      (line 2006)
-decline, ICS command:                          See 4.        (line 2105)
+debug, option:                                 See 3.7.      (line 2007)
+debugFile, option:                             See 3.7.      (line 2010)
+debugMode, option:                             See 3.7.      (line 2007)
+decline, ICS command:                          See 4.        (line 2106)
 Decline, Menu Item:                            See 2.3.      (line  420)
 defaultCacheSizeEGTB, option:                  See 3.2.      (line 1199)
-defaultFrcPosition, option:                    See 3.7.      (line 1975)
+defaultFrcPosition, option:                    See 3.7.      (line 1976)
 defaultHashSize, option:                       See 3.2.      (line 1193)
 defaultPathEGTB, option:                       See 3.2.      (line 1205)
-delayAfterQuit, option:                        See 3.7.      (line 2041)
-delayBeforeQuit, option:                       See 3.7.      (line 2041)
+delayAfterQuit, option:                        See 3.7.      (line 2042)
+delayBeforeQuit, option:                       See 3.7.      (line 2042)
 display, option:                               See 3.5.      (line 1580)
 drag, option:                                  See 3.5.      (line 1798)
-draw, ICS command:                             See 4.        (line 2118)
+draw, ICS command:                             See 4.        (line 2119)
 Draw, Menu Item:                               See 2.3.      (line  431)
 Edit Comment, Menu Item:                       See 2.2.      (line  376)
 Edit Game, Menu Item:                          See 2.2.      (line  294)
@@ -3580,9 +3581,9 @@ Edit Position, Menu Item:                      See 2.2.      (line  310)
 Edit Tags, Menu Item:                          See 2.2.      (line  352)
 egtFormats, option:                            See 3.2.      (line 1209)
 Engine Settings:                               See 3.2.      (line 1160)
-engineDebugOutput, option:                     See 3.7.      (line 2013)
-Environment variables:                         See 6.        (line 2268)
-examine, ICS command:                          See 4.        (line 2141)
+engineDebugOutput, option:                     See 3.7.      (line 2014)
+Environment variables:                         See 6.        (line 2269)
+examine, ICS command:                          See 4.        (line 2142)
 Exit, Menu Item:                               See 2.1.      (line  224)
 exit, option:                                  See 3.5.      (line 1594)
 fb, option:                                    See 3.1.      (line 1043)
@@ -3590,7 +3591,7 @@ fcp, option:                                   See 3.1.      (line 1036)
 fd, option:                                    See 3.1.      (line 1058)
 fh, option:                                    See 3.1.      (line 1050)
 File Menu:                                     See 2.1.      (line   82)
-finger, ICS command:                           See 4.        (line 2128)
+finger, ICS command:                           See 4.        (line 2129)
 firstChessProgram, option:                     See 3.1.      (line 1036)
 firstComputerString, option:                   See 3.1.      (line 1094)
 firstDirectory, option:                        See 3.1.      (line 1058)
@@ -3622,27 +3623,27 @@ Forward to End, Menu Item:                     See 2.4.      (line  520)
 Forward, Menu Item:                            See 2.4.      (line  488)
 fUCI, option:                                  See 3.2.      (line 1162)
 gameListTags, option:                          See 3.4.      (line 1568)
-games, ICS command:                            See 4.        (line 2094)
+games, ICS command:                            See 4.        (line 2095)
 gateway, option:                               See 3.3.      (line 1268)
 geometry, option:                              See 3.5.      (line 1580)
 Get Move List, Menu Item:                      See 2.5.      (line  694)
 getMoveList, option:                           See 3.3.      (line 1357)
 Help Menu:                                     See 2.6.      (line  814)
-help, ICS command:                             See 4.        (line 2079)
+help, ICS command:                             See 4.        (line 2080)
 Hide Thinking, Menu Item:                      See 2.5.      (line  791)
 Highlight Last Move, Menu Item:                See 2.5.      (line  706)
 highlight, option:                             See 3.5.      (line 1692)
 highlightLastMove, option:                     See 3.5.      (line 1692)
 highlightSquareColor, option:                  See 3.5.      (line 1776)
 Hint, Menu Item:                               See 2.6.      (line  829)
-holdingsSize, option:                          See 3.7.      (line 1967)
+holdingsSize, option:                          See 3.7.      (line 1968)
 iconic, option:                                See 3.5.      (line 1580)
-ICS:                                           See 4.        (line 2050)
+ICS:                                           See 4.        (line 2051)
 ICS Alarm, Menu Item:                          See 2.5.      (line  727)
 ICS Client, Menu Item:                         See 2.2.      (line  270)
 ICS Input Box, Menu Item:                      See 2.2.      (line  381)
 ICS options:                                   See 3.3.      (line 1223)
-ICS, addresses:                                See 4.        (line 2050)
+ICS, addresses:                                See 4.        (line 2051)
 ics, option:                                   See 3.3.      (line 1224)
 icsAlarm, option:                              See 3.3.      (line 1361)
 icsAlarmTime, option:                          See 3.3.      (line 1365)
@@ -3656,7 +3657,7 @@ inc, option:                                   See 3.1.      (line  929)
 Info XBoard, Menu Item:                        See 2.6.      (line  815)
 initalMode, option:                            See 3.7.      (line 1890)
 initString, option:                            See 3.1.      (line 1067)
-Internet Chess Server:                         See 4.        (line 2050)
+Internet Chess Server:                         See 4.        (line 2051)
 internetChessServerCommPort, option:           See 3.3.      (line 1276)
 internetChessServerHelper, option:             See 3.3.      (line 1242)
 internetChessServerHost, option:               See 3.3.      (line 1229)
@@ -3671,7 +3672,7 @@ legal, option:                                 See 3.5.      (line 1606)
 lgf, option:                                   See 3.4.      (line 1490)
 lgi, option:                                   See 3.4.      (line 1490)
 lightSquareColor, option:                      See 3.5.      (line 1776)
-Limitations:                                   See 7.        (line 2277)
+Limitations:                                   See 7.        (line 2278)
 Load and Save options:                         See 3.4.      (line 1488)
 Load Game, Menu Item:                          See 2.1.      (line  115)
 Load Next Game, Menu Item:                     See 2.1.      (line  142)
@@ -3715,7 +3716,7 @@ movesound, option:                             See 3.5.      (line 1589)
 movesPerSession, option:                       See 3.1.      (line  925)
 mps, option:                                   See 3.1.      (line  925)
 msLoginDelay, option:                          See 3.3.      (line 1327)
-nameOfDebugFile, option:                       See 3.7.      (line 2009)
+nameOfDebugFile, option:                       See 3.7.      (line 2010)
 ncp, option:                                   See 3.7.      (line 1885)
 New Game, Menu Item:                           See 2.1.      (line   83)
 New Shuffle Game, Menu Item:                   See 2.1.      (line   92)
@@ -3723,9 +3724,9 @@ New variant, Menu Item:                        See 2.1.      (line  105)
 niceEngines, option:                           See 3.1.      (line 1125)
 noChessProgram, option:                        See 3.7.      (line 1885)
 noGUI, option:                                 See 3.5.      (line 1583)
-observe, ICS command:                          See 4.        (line 2137)
+observe, ICS command:                          See 4.        (line 2138)
 Old Save Style, Menu Item:                     See 2.5.      (line  736)
-oldmoves, ICS command:                         See 4.        (line 2141)
+oldmoves, ICS command:                         See 4.        (line 2142)
 oldsave, option:                               See 3.4.      (line 1564)
 oldSaveStyle, option:                          See 3.4.      (line 1564)
 Options:                                       See 3.        (line  893)
@@ -3736,14 +3737,14 @@ Options, ICS:                                  See 3.3.      (line 1223)
 Options, Load and Save:                        See 3.4.      (line 1488)
 Options, miscellaneous:                        See 3.7.      (line 1884)
 Options, User interface:                       See 3.5.      (line 1577)
-Other programs:                                See 11.       (line 2605)
+Other programs:                                See 11.       (line 2606)
 Paste Game, Menu Item:                         See 2.1.      (line  176)
 Paste Position, Menu Item:                     See 2.1.      (line  216)
 Pause, Menu Item:                              See 2.2.      (line  388)
 Periodic Updates, Menu Item:                   See 2.5.      (line  744)
 pgnEventHeader, option`:                       See 3.4.      (line 1556)
 pgnExtendedInfo, option`:                      See 3.4.      (line 1551)
-pieceToSquareTable, option:                    See 3.7.      (line 1980)
+pieceToCharTable, option:                      See 3.7.      (line 1981)
 pixmap, option:                                See 3.5.      (line 1729)
 pixmapDirectory, option:                       See 3.5.      (line 1729)
 PolyglotBook, option:                          See 3.2.      (line 1177)
@@ -3759,7 +3760,7 @@ popupMoveErrors, option:                       See 3.5.      (line 1598)
 pre, option:                                   See 3.3.      (line 1373)
 Premove, Menu Item:                            See 2.5.      (line  770)
 premove, option:                               See 3.3.      (line 1373)
-Problems:                                      See 8.        (line 2337)
+Problems:                                      See 8.        (line 2338)
 queen, option:                                 See 3.5.      (line 1602)
 Quiet Play, Menu Item:                         See 2.5.      (line  781)
 quiet, option:                                 See 3.3.      (line 1376)
@@ -3767,10 +3768,10 @@ quietPlay, option:                             See 3.3.      (line 1376)
 Reload CMail Message, Menu Item:               See 2.1.      (line  221)
 Reload Same Game, Menu Item:                   See 2.1.      (line  151)
 Reload Same Position, Menu Item:               See 2.1.      (line  195)
-remoteShell, option:                           See 3.7.      (line 2027)
-remoteUser, option:                            See 3.7.      (line 2032)
-Reporting bugs:                                See 8.        (line 2337)
-Reporting problems:                            See 8.        (line 2337)
+remoteShell, option:                           See 3.7.      (line 2028)
+remoteUser, option:                            See 3.7.      (line 2033)
+Reporting bugs:                                See 8.        (line 2338)
+Reporting problems:                            See 8.        (line 2338)
 Resign, Menu Item:                             See 2.3.      (line  445)
 Retract Move, Menu Item:                       See 2.4.      (line  545)
 reuse, option:                                 See 3.1.      (line 1102)
@@ -3779,9 +3780,9 @@ reuseFirst, option:                            See 3.1.      (line 1102)
 reuseSecond, option:                           See 3.1.      (line 1102)
 Revert, Menu Item:                             See 2.4.      (line  532)
 ringBellAfterMoves, option:                    See 3.5.      (line 1589)
-rsh, option:                                   See 3.7.      (line 2027)
+rsh, option:                                   See 3.7.      (line 2028)
 ruleMoves, option:                             See 3.6.      (line 1868)
-ruser, option:                                 See 3.7.      (line 2032)
+ruser, option:                                 See 3.7.      (line 2033)
 sameColorGames, option:                        See 3.1.      (line 1030)
 Save Game, Menu Item:                          See 2.1.      (line  155)
 saveGameFile, option:                          See 3.4.      (line 1521)
@@ -3805,7 +3806,7 @@ secondProtocolVersion, option:                 See 3.1.      (line 1111)
 secondScoreAbs, option:                        See 3.1.      (line 1119)
 secondTimeOdds, option:                        See 3.1.      (line  977)
 secondXBook, option:                           See 3.2.      (line 1188)
-set, ICS command:                              See 4.        (line 2134)
+set, ICS command:                              See 4.        (line 2135)
 Settings, Engine:                              See 3.2.      (line 1160)
 sgf, option:                                   See 3.4.      (line 1521)
 sh, option:                                    See 3.1.      (line 1050)
@@ -3862,12 +3863,12 @@ Truncate Game, Menu Item:                      See 2.4.      (line  536)
 Two Machines, Menu Item:                       See 2.2.      (line  236)
 usePolyglotBook, option:                       See 3.2.      (line 1174)
 User interface options:                        See 3.5.      (line 1577)
-userName, option:                              See 3.7.      (line 2036)
+userName, option:                              See 3.7.      (line 2037)
 useTelnet, option:                             See 3.3.      (line 1250)
 variant, option:                               See 3.7.      (line 1898)
-vars, ICS command:                             See 4.        (line 2131)
+vars, ICS command:                             See 4.        (line 2132)
 whitePieceColor, option:                       See 3.5.      (line 1776)
-who, ICS command:                              See 4.        (line 2087)
+who, ICS command:                              See 4.        (line 2088)
 xflash, option:                                See 3.5.      (line 1683)
 Table of Contents
 *****************