updated for release 4.4.3
[xboard.git] / manual / xboard.html
index 9e7c574..5a8eb51 100644 (file)
@@ -3,7 +3,7 @@
 <title>XBoard</title>
 <meta http-equiv="Content-Type" content="text/html">
 <meta name="description" content="XBoard">
-<meta name="generator" content="makeinfo 4.12">
+<meta name="generator" content="makeinfo 4.13">
 <link title="Top" rel="top" href="#Top">
 <link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
 <meta http-equiv="Content-Style-Type" content="text/css">
@@ -22,8 +22,8 @@
 <body>
 <h1 class="settitle">XBoard</h1>
 <div class="node">
-<p><hr>
 <a name="Top"></a>
+<p><hr>
 Next:&nbsp;<a rel="next" accesskey="n" href="#Major-modes">Major modes</a>,
 Up:&nbsp;<a rel="up" accesskey="u" href="#dir">(dir)</a>
 
@@ -38,7 +38,7 @@ user interface to chess engines (such as GNU Chess), the
 Internet Chess Servers,
 electronic mail correspondence chess, or your own collection of saved games.
 
-   <p>This manual documents version 4.4.0j of XBoard.
+   <p>This manual documents version 4.4.3 of XBoard.
 
 <ul class="menu">
 <li><a accesskey="1" href="#Major-modes">Major modes</a>:      The main things XBoard can do. 
@@ -60,8 +60,8 @@ electronic mail correspondence chess, or your own collection of saved games.
 </ul>
 
 <div class="node">
-<p><hr>
 <a name="Major-modes"></a>
+<p><hr>
 Next:&nbsp;<a rel="next" accesskey="n" href="#Menus">Menus</a>,
 Previous:&nbsp;<a rel="previous" accesskey="p" href="#Top">Top</a>,
 Up:&nbsp;<a rel="up" accesskey="u" href="#Top">Top</a>
@@ -100,8 +100,8 @@ instructions.
 </dl>
 
 <div class="node">
-<p><hr>
 <a name="Menus"></a>
+<p><hr>
 Next:&nbsp;<a rel="next" accesskey="n" href="#Options">Options</a>,
 Previous:&nbsp;<a rel="previous" accesskey="p" href="#Major-modes">Major modes</a>,
 Up:&nbsp;<a rel="up" accesskey="u" href="#Top">Top</a>
@@ -144,8 +144,8 @@ feature to work.
 </ul>
 
 <div class="node">
-<p><hr>
 <a name="File-Menu"></a>
+<p><hr>
 Next:&nbsp;<a rel="next" accesskey="n" href="#Mode-Menu">Mode Menu</a>,
 Up:&nbsp;<a rel="up" accesskey="u" href="#Menus">Menus</a>
 
@@ -264,8 +264,8 @@ with Load Position.
 </dl>
 
 <div class="node">
-<p><hr>
 <a name="Mode-Menu"></a>
+<p><hr>
 Next:&nbsp;<a rel="next" accesskey="n" href="#Action-Menu">Action Menu</a>,
 Previous:&nbsp;<a rel="previous" accesskey="p" href="#File-Menu">File Menu</a>,
 Up:&nbsp;<a rel="up" accesskey="u" href="#Menus">Menus</a>
@@ -432,8 +432,8 @@ resume automatic loading by selecting &lsquo;<samp><span class="samp">Pause</spa
 </dl>
 
 <div class="node">
-<p><hr>
 <a name="Action-Menu"></a>
+<p><hr>
 Next:&nbsp;<a rel="next" accesskey="n" href="#Step-Menu">Step Menu</a>,
 Previous:&nbsp;<a rel="previous" accesskey="p" href="#Mode-Menu">Mode Menu</a>,
 Up:&nbsp;<a rel="up" accesskey="u" href="#Menus">Menus</a>
@@ -475,8 +475,8 @@ by the comment "user adjudication".
 </dl>
 
 <div class="node">
-<p><hr>
 <a name="Step-Menu"></a>
+<p><hr>
 Next:&nbsp;<a rel="next" accesskey="n" href="#Options-Menu">Options Menu</a>,
 Previous:&nbsp;<a rel="previous" accesskey="p" href="#Action-Menu">Action Menu</a>,
 Up:&nbsp;<a rel="up" accesskey="u" href="#Menus">Menus</a>
@@ -559,8 +559,8 @@ depending on whether it is your opponent's move or yours.
 </dl>
 
 <div class="node">
-<p><hr>
 <a name="Options-Menu"></a>
+<p><hr>
 Next:&nbsp;<a rel="next" accesskey="n" href="#Help-Menu">Help Menu</a>,
 Previous:&nbsp;<a rel="previous" accesskey="p" href="#Step-Menu">Step Menu</a>,
 Up:&nbsp;<a rel="up" accesskey="u" href="#Menus">Menus</a>
@@ -776,8 +776,8 @@ generally supported with Test Legality on.)
 </dl>
 
 <div class="node">
-<p><hr>
 <a name="Help-Menu"></a>
+<p><hr>
 Next:&nbsp;<a rel="next" accesskey="n" href="#Keys">Keys</a>,
 Previous:&nbsp;<a rel="previous" accesskey="p" href="#Options-Menu">Options Menu</a>,
 Up:&nbsp;<a rel="up" accesskey="u" href="#Menus">Menus</a>
@@ -810,8 +810,8 @@ engine is out of its book or does not support this feature.
 </dl>
 
 <div class="node">
-<p><hr>
 <a name="Keys"></a>
+<p><hr>
 Previous:&nbsp;<a rel="previous" accesskey="p" href="#Help-Menu">Help Menu</a>,
 Up:&nbsp;<a rel="up" accesskey="u" href="#Menus">Menus</a>
 
@@ -867,8 +867,8 @@ are:
      ToStartProc, TrainingProc, TruncateGameProc, and TwoMachinesProc.
 </pre>
    <div class="node">
-<p><hr>
 <a name="Options"></a>
+<p><hr>
 Next:&nbsp;<a rel="next" accesskey="n" href="#Chess-Servers">Chess Servers</a>,
 Previous:&nbsp;<a rel="previous" accesskey="p" href="#Menus">Menus</a>,
 Up:&nbsp;<a rel="up" accesskey="u" href="#Top">Top</a>
@@ -914,8 +914,8 @@ true or false (&lsquo;<samp><span class="samp">XBoard*longOptionName: true</span
 </ul>
 
 <div class="node">
-<p><hr>
 <a name="Chess-engine-options"></a>
+<p><hr>
 Next:&nbsp;<a rel="next" accesskey="n" href="#UCI-_002b-WB-Engine-Settings">UCI + WB Engine Settings</a>,
 Up:&nbsp;<a rel="up" accesskey="u" href="#Options">Options</a>
 
@@ -1095,9 +1095,9 @@ castling and e.p. fields in variants that do not have castling or e.p.
 </dl>
 
 <div class="node">
-<p><hr>
 <a name="UCI-+-WB-Engine-Settings"></a>
 <a name="UCI-_002b-WB-Engine-Settings"></a>
+<p><hr>
 Next:&nbsp;<a rel="next" accesskey="n" href="#ICS-options">ICS options</a>,
 Previous:&nbsp;<a rel="previous" accesskey="p" href="#Chess-engine-options">Chess engine options</a>,
 Up:&nbsp;<a rel="up" accesskey="u" href="#Options">Options</a>
@@ -1144,8 +1144,8 @@ Default: "".
 </dl>
 
 <div class="node">
-<p><hr>
 <a name="ICS-options"></a>
+<p><hr>
 Next:&nbsp;<a rel="next" accesskey="n" href="#Load-and-Save-options">Load and Save options</a>,
 Previous:&nbsp;<a rel="previous" accesskey="p" href="#UCI-_002b-WB-Engine-Settings">UCI + WB Engine Settings</a>,
 Up:&nbsp;<a rel="up" accesskey="u" href="#Options">Options</a>
@@ -1343,8 +1343,8 @@ sound).
      </dl>
 
 <div class="node">
-<p><hr>
 <a name="Load-and-Save-options"></a>
+<p><hr>
 Next:&nbsp;<a rel="next" accesskey="n" href="#User-interface-options">User interface options</a>,
 Previous:&nbsp;<a rel="previous" accesskey="p" href="#ICS-options">ICS options</a>,
 Up:&nbsp;<a rel="up" accesskey="u" href="#Options">Options</a>
@@ -1418,8 +1418,8 @@ Default: "eprd"
 </dl>
 
 <div class="node">
-<p><hr>
 <a name="User-interface-options"></a>
+<p><hr>
 Next:&nbsp;<a rel="next" accesskey="n" href="#Adjudication-Options">Adjudication Options</a>,
 Previous:&nbsp;<a rel="previous" accesskey="p" href="#Load-and-Save-options">Load and Save options</a>,
 Up:&nbsp;<a rel="up" accesskey="u" href="#Options">Options</a>
@@ -1614,8 +1614,8 @@ from the clipboard.  Default: false.
 </dl>
 
 <div class="node">
-<p><hr>
 <a name="Adjudication-Options"></a>
+<p><hr>
 Next:&nbsp;<a rel="next" accesskey="n" href="#Other-options">Other options</a>,
 Previous:&nbsp;<a rel="previous" accesskey="p" href="#User-interface-options">User interface options</a>,
 Up:&nbsp;<a rel="up" accesskey="u" href="#Options">Options</a>
@@ -1663,8 +1663,8 @@ as repeats, XBoard is fully e.p. and castling aware!
 </dl>
 
 <div class="node">
-<p><hr>
 <a name="Other-options"></a>
+<p><hr>
 Previous:&nbsp;<a rel="previous" accesskey="p" href="#Adjudication-Options">Adjudication Options</a>,
 Up:&nbsp;<a rel="up" accesskey="u" href="#Options">Options</a>
 
@@ -1715,6 +1715,7 @@ needed in ICS mode.  Recognized variant names are:
           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
@@ -1756,7 +1757,7 @@ Default: -1
 A value of -1 means the position is randomly generated by XBoard
 at the beginning of every game. 
 Default: -1
-<br><dt>-pieceToSquareTable string<dd><a name="index-pieceToSquareTable_002c-option-369"></a>The characters that are used to represent the piece types XBoard knows in FEN
+<br><dt>-pieceToCharTable string<dd><a name="index-pieceToCharTable_002c-option-369"></a>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 pieces have to be given separately
 (in that order). The last letter for each color will be the King. 
@@ -1801,8 +1802,8 @@ Default is the login name on your local computer.
    </dl>
 
 <div class="node">
-<p><hr>
 <a name="Chess-Servers"></a>
+<p><hr>
 Next:&nbsp;<a rel="next" accesskey="n" href="#Firewalls">Firewalls</a>,
 Previous:&nbsp;<a rel="previous" accesskey="p" href="#Options">Options</a>,
 Up:&nbsp;<a rel="up" accesskey="u" href="#Top">Top</a>
@@ -1892,8 +1893,8 @@ and &lsquo;<samp><span class="samp">Stop Examining</span></samp>&rsquo; on the <
 <a href="#Options-Menu">Options Menu</a>.
 
 <div class="node">
-<p><hr>
 <a name="Firewalls"></a>
+<p><hr>
 Next:&nbsp;<a rel="next" accesskey="n" href="#Environment">Environment</a>,
 Previous:&nbsp;<a rel="previous" accesskey="p" href="#Chess-Servers">Chess Servers</a>,
 Up:&nbsp;<a rel="up" accesskey="u" href="#Top">Top</a>
@@ -2022,8 +2023,8 @@ but see the SOCKS Web site at http://www.socks.permeo.com/.
 If you are missing SOCKS, try http://www.funbureau.com/.
 
 <div class="node">
-<p><hr>
 <a name="Environment"></a>
+<p><hr>
 Next:&nbsp;<a rel="next" accesskey="n" href="#Limitations">Limitations</a>,
 Previous:&nbsp;<a rel="previous" accesskey="p" href="#Firewalls">Firewalls</a>,
 Up:&nbsp;<a rel="up" accesskey="u" href="#Top">Top</a>
@@ -2040,8 +2041,8 @@ XBoard actually changes its working directory to
 will be placed there too.
 
 <div class="node">
-<p><hr>
 <a name="Limitations"></a>
+<p><hr>
 Next:&nbsp;<a rel="next" accesskey="n" href="#Problems">Problems</a>,
 Previous:&nbsp;<a rel="previous" accesskey="p" href="#Environment">Environment</a>,
 Up:&nbsp;<a rel="up" accesskey="u" href="#Top">Top</a>
@@ -2105,8 +2106,8 @@ not an XBoard bug.
 possible bugs, limitations, and ideas for improvement that have been
 suggested. 
 <div class="node">
-<p><hr>
 <a name="Problems"></a>
+<p><hr>
 Next:&nbsp;<a rel="next" accesskey="n" href="#Contributors">Contributors</a>,
 Previous:&nbsp;<a rel="previous" accesskey="p" href="#Limitations">Limitations</a>,
 Up:&nbsp;<a rel="up" accesskey="u" href="#Top">Top</a>
@@ -2134,8 +2135,8 @@ and we will get in touch with you about merging them in
 to the main line of development.
 
 <div class="node">
-<p><hr>
 <a name="Contributors"></a>
+<p><hr>
 Next:&nbsp;<a rel="next" accesskey="n" href="#CMail">CMail</a>,
 Previous:&nbsp;<a rel="previous" accesskey="p" href="#Problems">Problems</a>,
 Up:&nbsp;<a rel="up" accesskey="u" href="#Top">Top</a>
@@ -2195,8 +2196,8 @@ unified XBoard/WinBoard 4.4, which is now available both from the
 savannah.gnu.org web site and the WinBoard forum.
 
 <div class="node">
-<p><hr>
 <a name="CMail"></a>
+<p><hr>
 Next:&nbsp;<a rel="next" accesskey="n" href="#Other-programs">Other programs</a>,
 Previous:&nbsp;<a rel="previous" accesskey="p" href="#Contributors">Contributors</a>,
 Up:&nbsp;<a rel="up" accesskey="u" href="#Top">Top</a>
@@ -2220,8 +2221,8 @@ your choice using XBoard as an interface.
 </ul>
 
 <div class="node">
-<p><hr>
 <a name="CMail-options"></a>
+<p><hr>
 Next:&nbsp;<a rel="next" accesskey="n" href="#CMail-game">CMail game</a>,
 Up:&nbsp;<a rel="up" accesskey="u" href="#CMail">CMail</a>
 
@@ -2283,8 +2284,8 @@ CMail's command line.  See <a href="#Options">Options</a>.
 </dl>
 
 <div class="node">
-<p><hr>
 <a name="CMail-game"></a>
+<p><hr>
 Next:&nbsp;<a rel="next" accesskey="n" href="#CMail-answer">CMail answer</a>,
 Previous:&nbsp;<a rel="previous" accesskey="p" href="#CMail-options">CMail options</a>,
 Up:&nbsp;<a rel="up" accesskey="u" href="#CMail">CMail</a>
@@ -2306,8 +2307,8 @@ XBoard in the background. Make your first move and select
 made.
 
 <div class="node">
-<p><hr>
 <a name="CMail-answer"></a>
+<p><hr>
 Next:&nbsp;<a rel="next" accesskey="n" href="#CMail-multi">CMail multi</a>,
 Previous:&nbsp;<a rel="previous" accesskey="p" href="#CMail-game">CMail game</a>,
 Up:&nbsp;<a rel="up" accesskey="u" href="#CMail">CMail</a>
@@ -2340,8 +2341,8 @@ either select &lsquo;<samp><span class="samp">Exit</span></samp>&rsquo; without
 XBoard running until you are ready.
 
 <div class="node">
-<p><hr>
 <a name="CMail-multi"></a>
+<p><hr>
 Next:&nbsp;<a rel="next" accesskey="n" href="#CMail-completion">CMail completion</a>,
 Previous:&nbsp;<a rel="previous" accesskey="p" href="#CMail-answer">CMail answer</a>,
 Up:&nbsp;<a rel="up" accesskey="u" href="#CMail">CMail</a>
@@ -2358,8 +2359,8 @@ with moves transmitted simultaneously. In case there are more general uses,
 contained in a message; however, XBoard does.
 
 <div class="node">
-<p><hr>
 <a name="CMail-completion"></a>
+<p><hr>
 Next:&nbsp;<a rel="next" accesskey="n" href="#CMail-trouble">CMail trouble</a>,
 Previous:&nbsp;<a rel="previous" accesskey="p" href="#CMail-multi">CMail multi</a>,
 Up:&nbsp;<a rel="up" accesskey="u" href="#CMail">CMail</a>
@@ -2380,8 +2381,8 @@ when he or she pipes the final message through <samp><span class="file">cmail</s
 file name includes the date the game was started.
 
 <div class="node">
-<p><hr>
 <a name="CMail-trouble"></a>
+<p><hr>
 Previous:&nbsp;<a rel="previous" accesskey="p" href="#CMail-completion">CMail completion</a>,
 Up:&nbsp;<a rel="up" accesskey="u" href="#CMail">CMail</a>
 
@@ -2405,8 +2406,8 @@ so multi-game correspondence is not possible with opponents using an older
 version.
 
 <div class="node">
-<p><hr>
 <a name="Other-programs"></a>
+<p><hr>
 Next:&nbsp;<a rel="next" accesskey="n" href="#Copyright">Copyright</a>,
 Previous:&nbsp;<a rel="previous" accesskey="p" href="#CMail">CMail</a>,
 Up:&nbsp;<a rel="up" accesskey="u" href="#Top">Top</a>
@@ -2427,8 +2428,8 @@ Here are some other programs you can use with XBoard
 </ul>
 
 <div class="node">
-<p><hr>
 <a name="GNU-Chess"></a>
+<p><hr>
 Next:&nbsp;<a rel="next" accesskey="n" href="#Fairy_002dMax">Fairy-Max</a>,
 Up:&nbsp;<a rel="up" accesskey="u" href="#Other-programs">Other programs</a>
 
@@ -2444,9 +2445,9 @@ Up:&nbsp;<a rel="up" accesskey="u" href="#Other-programs">Other programs</a>
 interface GNU Chess to an ICS.
 
 <div class="node">
-<p><hr>
 <a name="Fairy-Max"></a>
 <a name="Fairy_002dMax"></a>
+<p><hr>
 Next:&nbsp;<a rel="next" accesskey="n" href="#HoiChess">HoiChess</a>,
 Previous:&nbsp;<a rel="previous" accesskey="p" href="#GNU-Chess">GNU Chess</a>,
 Up:&nbsp;<a rel="up" accesskey="u" href="#Other-programs">Other programs</a>
@@ -2468,8 +2469,8 @@ It can be obtained from:
    <p>http://home.hccnet.nl/h.g.muller/dwnldpage.html
 
 <div class="node">
-<p><hr>
 <a name="HoiChess"></a>
+<p><hr>
 Next:&nbsp;<a rel="next" accesskey="n" href="#Crafty">Crafty</a>,
 Previous:&nbsp;<a rel="previous" accesskey="p" href="#Fairy_002dMax">Fairy-Max</a>,
 Up:&nbsp;<a rel="up" accesskey="u" href="#Other-programs">Other programs</a>
@@ -2485,8 +2486,8 @@ through:
    <p>sudo apt-get install hoichess
 
 <div class="node">
-<p><hr>
 <a name="Crafty"></a>
+<p><hr>
 Next:&nbsp;<a rel="next" accesskey="n" href="#zic2xpm">zic2xpm</a>,
 Previous:&nbsp;<a rel="previous" accesskey="p" href="#HoiChess">HoiChess</a>,
 Up:&nbsp;<a rel="up" accesskey="u" href="#Other-programs">Other programs</a>
@@ -2513,8 +2514,8 @@ ftp://ftp.cis.uab.edu/hyatt/.
 and placed its book and other support files.
 
 <div class="node">
-<p><hr>
 <a name="zic2xpm"></a>
+<p><hr>
 Previous:&nbsp;<a rel="previous" accesskey="p" href="#Crafty">Crafty</a>,
 Up:&nbsp;<a rel="up" accesskey="u" href="#Other-programs">Other programs</a>
 
@@ -2557,8 +2558,8 @@ and may NOT be redistributed without explicit permission from
 the original creator(s) of the pieces.
 
 <div class="node">
-<p><hr>
 <a name="Copyright"></a>
+<p><hr>
 Next:&nbsp;<a rel="next" accesskey="n" href="#Copying">Copying</a>,
 Previous:&nbsp;<a rel="previous" accesskey="p" href="#Other-programs">Other programs</a>,
 Up:&nbsp;<a rel="up" accesskey="u" href="#Top">Top</a>
@@ -2587,8 +2588,8 @@ 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.
 
-   <p>Enhancements copyright &copy;
-1992-2003,2004,2005,2006,2007,2008,2009 Free Software Foundation, Inc.
+   <p>Enhancements copyright &copy; 1992-2003, 2004, 2005, 2006, 2007,
+2008, 2009, 2010 Free Software Foundation, Inc.
 
 <pre class="format">Published by the Free Software Foundation
 59 Temple Place - Suite 330
@@ -2612,8 +2613,8 @@ and this permission notice, may be included in translations approved by
 the Free Software Foundation instead of in the original English.
 
 <div class="node">
-<p><hr>
 <a name="Copying"></a>
+<p><hr>
 Next:&nbsp;<a rel="next" accesskey="n" href="#Index">Index</a>,
 Previous:&nbsp;<a rel="previous" accesskey="p" href="#Copyright">Copyright</a>,
 Up:&nbsp;<a rel="up" accesskey="u" href="#Top">Top</a>
@@ -3320,8 +3321,8 @@ first, please read <a href="http://www.gnu.org/philosophy/why-not-lgpl.html">htt
 
 <!-- noman -->
 <div class="node">
-<p><hr>
 <a name="Index"></a>
+<p><hr>
 Previous:&nbsp;<a rel="previous" accesskey="p" href="#Copying">Copying</a>,
 Up:&nbsp;<a rel="up" accesskey="u" href="#Top">Top</a>
 
@@ -3611,7 +3612,7 @@ Up:&nbsp;<a rel="up" accesskey="u" href="#Top">Top</a>
 <li><a href="#index-Periodic-Updates_002c-Menu-Item-93">Periodic Updates, Menu Item</a>: <a href="#Options-Menu">Options Menu</a></li>
 <li><a href="#index-pgnEventHeader_002c-option_0060-278">pgnEventHeader, option`</a>: <a href="#Load-and-Save-options">Load and Save options</a></li>
 <li><a href="#index-pgnExtendedInfo_002c-option_0060-277">pgnExtendedInfo, option`</a>: <a href="#Load-and-Save-options">Load and Save options</a></li>
-<li><a href="#index-pieceToSquareTable_002c-option-369">pieceToSquareTable, option</a>: <a href="#Other-options">Other options</a></li>
+<li><a href="#index-pieceToCharTable_002c-option-369">pieceToCharTable, option</a>: <a href="#Other-options">Other options</a></li>
 <li><a href="#index-pixmap_002c-option-334">pixmap, option</a>: <a href="#User-interface-options">User interface options</a></li>
 <li><a href="#index-pixmapDirectory_002c-option-335">pixmapDirectory, option</a>: <a href="#User-interface-options">User interface options</a></li>
 <li><a href="#index-PolyglotBook_002c-option-180">PolyglotBook, option</a>: <a href="#UCI-_002b-WB-Engine-Settings">UCI + WB Engine Settings</a></li>