Merge commit 'v4.3.16'
[xboard.git] / README
1 \r
2 What is XBoard?\r
3 ===============\r
4 XBoard is a graphical chessboard for the X Window System.  It can\r
5 serve as a user interface for chess engines such as GNU Chess, for the\r
6 Internet Chess Server, or for electronic mail correspondence chess.\r
7 XBoard can also be used by itself.  See the manual page xboard.txt for\r
8 further details.\r
9 \r
10 XBoard is free software, copyrighted by the Free Software Foundation\r
11 and released under the GNU General Public License (GPL).  See the file\r
12 COPYING for details.\r
13 \r
14 You can build xboard on most systems with the following commands.\r
15 \r
16         ./configure\r
17         make\r
18 \r
19 See the file INSTALL for more detailed instructions.\r
20 \r
21 See the file FAQ.html for answers to frequently asked questions.\r
22 \r
23 \r
24 What is WinBoard?\r
25 =================\r
26 WinBoard is a port of XBoard to run natively on Windows.  It is part\r
27 of the XBoard project and is released under the same terms as XBoard.\r
28 \r
29 You can build WinBoard using the free Cygwin toolchain from\r
30 with the following commands.\r
31 \r
32         cd winboard\r
33         make -f cygwin.mak\r
34 \r
35 You can build WinBoard using Microsoft Visual C with the following\r
36 commands, or by opening the project in Visual Studio and clicking the\r
37 build button.\r
38 \r
39         cd winboard\r
40         nmake -f msvc.mak\r
41 \r
42 There is also a contributed .mak file for Borland C.  It's not\r
43 maintained and thus may need updating if you want to use it.\r
44 \r
45 \r
46 Reporting problems\r
47 ==================\r
48 \r
49 Report bugs and problems with XBoard and WinBoard to\r
50 <>.  With XBoard, please use the "script" program\r
51 to start a typescript, run XBoard with the -debug command line option,\r
52 and include the typescript output in your message.  With WinBoard,\r
53 please use the /debug command line option and include the contents of\r
54 the file WinBoard.debug.  Also tell us what kind of machine and what\r
55 operating system version you are using.  On Unix, the command "uname\r
56 -a" will tell you this.  On Windows, right-click on My Computer and\r
57 select Properties.\r
58 \r
59 Here is a sample of approximately what you should type (on Unix):\r
60 \r
61     script\r
62     uname -a\r
63     ./configure\r
64     make\r
65     ./xboard -debug\r
66     exit\r
67     mail\r
68     Subject: Your short description of the problem\r
69     Your detailed description of the problem\r
70     ~r typescript\r
71     .\r
72 \r
73 If you improve XBoard, please send a message about your changes, and\r
74 we will get in touch with you about merging them in to the main line\r
75 of development.\r
76 \r
77 Version 4.3.14\r
78 ==============\r
79 \r
80 This relaese was not made by the GNU xboard team, but by H.G.Muller.\r
81 It mainly contains developments on WinBoard. Nevertheless, an attempt\r
82 has been started to back-port the enormous number of improvements that\r
83 have been made to WinBoard since the Linux and Windows developments branched\r
84 to xboard. This is reflected by the source tree now having the same format\r
85 as that of xboard 4.2.7, including all the xboard sources. \r
86 \r
87 An enormous amount of work still has to be done to make the xboard version\r
88 fully equivalent to WinBoard, especially on user-interface side. As a modest\r
89 beginning, the xboard source files have been patched to allow their compilation\r
90 with the newer back-end files from WinBoard. To this end, the number of piece\r
91 types in xboard has been increased from 6 to 22, and the WinBoard bitmaps\r
92 have been converted to xboard source format (.bm) and are included in the\r
93 xboard bitmaps directory. Other quick patches include the coloring of the\r
94 board squares (for xiangqi and holdings), and some code in the user-move\r
95 handling to suppress all moves into or out of the area between board and\r
96 holdings in crazyhouse, and the treatment of king-captures-own-piece\r
97 as a possibly valid move (for FRC castling). This should make it possible \r
98 to run xboard with the new back-end files without too much inconvenience.\r
99 \r
100 New xboard command-line options have been added to make the added back-end \r
101 features available. The include the new variants (as argument of the old\r
102 -variant option), -boardWidth, -boardHeight and -holdingsSize. Be sure\r
103 to call xboard with "-boardSize middling" or "-boardSize bulky" if you\r
104 want to play with fairy pieces, or xboard might crash due to unavailability\r
105 of bitmaps. Other added xboard options are:\r
106 \r
108 -checkMates\r
109 -testClaims\r
110 -materialDraws\r
111 -trivialDraws\r
112 -ruleMoves\r
113 -repeatsToDraw\r
114 -adjudicateLossThreshold\r
115 -firstScoreAbsolute\r
116 -secondScoreAbsolute\r
117 \r
119 -firstTimeOdds\r
120 -secondTimeOdds\r
121 -timeOddsMode\r
122 -firstNPS\r
123 -secondNPS\r
124 \r
126 -matchPause\r
127 -engineDebugOutput\r
128 -userName\r
129 -pgnExtendedInfo\r
130 -pgnEventHeader\r
131 -hideThinkingFromHuman\r
132 \r
133 This is all completely untested, but as the options merely switch on well-tested\r
134 code in the back-end, there should not be too many problems with them.\r
135 Bugs can be reported in the WinBoard forum.