new developer software and some simple instructions on how to build them
[xboard.git] / index.html
1 <!--#include virtual="/server/header.html" -->
2 <title>XBoard - GNU Project - Free Software Foundation</title>
3 <!--#include virtual="/server/banner.html" -->
4 <h2>XBoard</h2>
5
6 <!-- This is the template document for GNU web pages.  We use -->
7 <!-- server side includes (#include) for common elements, for -->
8 <!-- instance, the very first line of the file.  If you're reading -->
9 <!-- this in its expanded form, you can retrieve the original source,  -->
10 <!-- with the SSI statements intact, from -->
11 <!-- http://web.cvs.savannah.gnu.org/viewvc/*checkout*/www/server/standards/boilerplate.html?root=www&content-type=text%2Fplain
12   -->
13
14 <!-- This document uses XHTML 1.0 Strict, but may be served as -->
15 <!-- text/html.  Please ensure that markup style considers -->
16 <!-- appendix C of the XHTML 1.0 standard. See validator.w3.org. -->
17
18 <!-- Please ensure links are consistent with Apache's MultiView. -->
19 <!-- Change include statements to be consistent with the relevant -->
20 <!-- language, where necessary. -->
21
22
23 <p>XBoard is a graphical user interface for chess in all its major
24 forms, including international chess, xiangqi (Chinese chess) and
25 shogi (Japanese chess), in addition to many minor variants such as
26 Losers Chess, Crazyhouse, Chess960 and Capabanca Chess. It displays a
27 chessboard on the screen, accepts moves made with the mouse, and loads
28 and saves games in Portable Game Notation (PGN). It serves as a
29 front-end for many different chess services, including:</p>
30 <ul>
31 <li>
32 Chess engines that will run on your machine and play a game against
33 you or help you analyze, such as GNU Chess, Crafty, or many
34 others.</li>
35
36 <li>Chess servers on the Internet, where you can connect to play chess
37 with people from all over the world, watch other users play, or just
38 hang out and chat.</li>
39
40 <li>Correspondence chess played by electronic mail. The CMail program
41 automates the tasks of parsing email from your opponent, playing his
42 moves out on your board, and mailing your reply move after you've
43 chosen it.</li>
44 </ul>
45 <p>XBoard runs on Unix and Unix-like systems that use the X Window
46 System. </p>
47
48 <h3>Winboard</h3>
49
50 <p>The project also includes a port to 32-bit Windows systems called
51 WinBoard.</p>
52
53 <p>You can find the download section for Winboard at
54 the <a href="http://www.open-aurec.com/wbforum/viewforum.php?f=19">Winboard
55 Forum</a>.</p>
56
57 <p>Development for Winboard, reporting bugs and any other requests can
58 also be done at the same places as for XBoard (see below).</p>
59
60 <h3>Downloading XBoard</h3>
61
62 <h4>stable version</h4>
63
64 <p>The current stable version
65 is: <a href="ftp://ftp.gnu.org/gnu/xboard/">4.4.2</a></p>
66
67 <p>It can be found on the main GNU ftp server:
68 <a href="http://ftp.gnu.org/gnu/xboard/">http://ftp.gnu.org/gnu/xboard/</a> (via http) and
69 <a href="ftp://ftp.gnu.org/gnu/xboard/">ftp://ftp.gnu.org/gnu/xboard/</a> (via ftp).</p>
70
71 <p>It can also be found on one of the <a href="/prep/ftp.html">mirrors
72 of ftp.gnu.org</a>;
73 please <a href="http://ftpmirror.gnu.org/xboard">use a mirror</a> if
74 possible.</p>
75
76 <h4>development version</h4>
77
78 <p>It would be great if people would like help in the developing process. We can use all kind of help, from people who just use the software and have a feature request (send them to developer mailing list), to people who can update/check the documentation and especially people who test development versions (send problems to the developer mailing list). </p>
79
80 <p>At the moment we have three developer versions:</p>
81
82 <ul>
83 <li>A snapshot of the 4.4.3 branch: 
84    This will become the next stable version.  <a href="ftp://alpha.gnu.org/gnu/xboard/">4.4.3.20100118</a></li>
85 <li>A snapshot of the master branch: <a href="ftp://alpha.gnu.org/gnu/xboard/">master-20100118</a>. <br />
86    The master branch at this moment also includes changes that will go in future version, but not necessary in the next release. Since this includes lots of changes, chances for major bugs are higher.</li>
87 <li>A snapshot of the gtk branch: <a href="ftp://alpha.gnu.org/gnu/xboard/">gtk-20100118</a>. <br />
88    In the gtk branch we are working on merging Winboard and Xboard back together using a gtk-frontend. This code doesn't work 100% yet, it will crash quite often, but you can almost play normal games against a machine already.</li>
89 </ul>
90
91 <h5>How to build the development version</h5>
92
93 <h6>git version</h6>
94 <p> After cloning the git-repository, do ./autogen.sh, ./configure and then a make.</p>
95
96 <h6>tar-balls</h6>
97 <p> Unpack the tar ball and do ./configure followed by make.</p>
98
99
100 <p>For development sources and other information, please see
101 the <a href="http://savannah.gnu.org/projects/xboard/">XBoard project
102 page</a> at <a href="http://savannah.gnu.org">savannah.gnu.org</a>.</p>
103
104 <p>A snapshot of the latest source code for all branches is available at
105 the <a href="http://git.savannah.gnu.org/cgit/xboard.git">git
106 repository</a> on Savannah.</p>
107
108 <h4>archive</h4>
109
110 <p>You can also find an archive of old versions on <a href="ftp://ftp.gnu.org/old-gnu/xboard/">the ftp server</a>.</p>
111
112 <h3>Documentation</h3>
113
114 <p><a href="manual/">Documentation for XBoard</a> is available online,
115 as is <a href="/manual/">documentation for most GNU software</a>.  You
116 may also find more information about XBoard by
117 running <em>info&nbsp;xboard</em> or <em>man&nbsp;xboard</em>, or by
118 looking at <em>/usr/doc/xboard/</em>,
119 <em>/usr/local/doc/xboard/</em>, or similar directories on your system.</p>
120
121 <p>The Chess Engine Communication Protocol can be found <a href="engine-intf.html">here</a>.</p>
122
123 <h3>Screenshots</h3>
124
125 <p>These are screenshots taken from version 4.4.0 (click to enlarge).</p>
126 <a href="graphics/xboard-4.4.0.png"><img src="graphics/xboard-4.4.0.png" alt=" [screenshot normal game] " height="200" /></a>
127 <a href="graphics/xboard-4.4.0-variant.png"><img src="graphics/xboard-4.4.0-variant.png" alt=" [screenshot bughouse game] " height="200" /></a>
128 <a href="graphics/xboard-4.4.0-showgi.png"><img src="graphics/xboard-4.4.0-showgi.png" alt=" [screenshot bughouse game] " height="200" /></a>
129 <a href="graphics/xboard-4.4.0-petite.png"><img src="graphics/xboard-4.4.0-petite.png" alt=" [screenshot bughouse game] " height="200" /></a>
130 <a href="graphics/xboard-4.4.0-XQ.png"><img src="graphics/xboard-4.4.0-XQ.png" alt=" [screenshot bughouse game] " height="200" /></a>
131
132 <h3>Links</h3>
133
134 <ul>
135   <li> XBoard/Winboard 
136     <ul>
137       <li> <a href="http://www.tim-mann.org/chess.html">Tim's original pages</a> are still available.</li>
138       <li> XBoard can also run engines that use the UCI protocol, with
139         the aid of the Polyglot protocol adapter.  A new Polyglot
140         version, (1.4.30b), especially adapted to support the new
141         features of XBoard 4.4.0, can be
142         found <a href="http://alpha.uhasselt.be/Research/Algebra/Toga/polyglot-release/">here</a>.</li>
143     </ul>
144   </li>
145   <li> Incomplete list of computer engines that work with XBoard
146     <ul>
147       <li><a href="http://www.gnu.org/software/chess/">GNU chess</a></li>
148       <li><a href="http://home.hccnet.nl/h.g.muller/CVfairy.html">Fairy-Max</a></li>
149       <li><a href="http://wbec-ridderkerk.nl/html/lastupdates.htm">A list with lots of engines</a></li>
150       <li><a href="http://home.hccnet.nl/h.g.muller/XQ.html">List of Xiangqi engines</a></li>
151       <li> other popular engines are crafty, phalanx, fruit, toga2, glaurung, ... </li>
152     </ul>
153   </li>
154   <li> Chess server you can connect to using XBoard
155     <ul>
156       <li> <a href="http://www.freechess.org"> Free Internet Chess Server (FICS) </a></li>
157       <li> <a href="http://www.chessclub.com/"> The Internet Chess Club </a> </li>
158     </ul>
159   </li>
160   <li> Other interfaces
161     <ul>
162       <li> <a href="http://www.bergo.eng.br/eboard/">eboard</a> </li>
163     </ul>
164   </li>
165 </ul>
166
167 <h3>Frequently Asked Question(FAQ)</h3>
168
169 <p>If you have any questions, please check out our <a href="FAQ.html">FAQ</a>.</p>
170
171
172 <h3>Mailing Lists and Discussion Forums</h3>
173
174 <h4>mailing lists</h4>
175
176 <p>XBoard has two mailing lists:
177 <a href="mailto:bug-xboard@gnu.org">&lt;bug-xboard@gnu.org&gt;</a> and
178 <a href="mailto:xboard-devel@gnu.org">&lt;xboard-devel@gnu.org&gt;</a>.</p>
179
180 <p>The main discussion list is
181 <a href="mailto:xboard-devel@gnu.org">&lt;xboard-devel@gnu.org&gt;</a>,
182 and is used to discuss most aspects of XBoard, including development
183 and enhancement requests. Please send bug reports
184 to <a href="mailto:bug-xboard@gnu.org">&lt;bug-xboard@gnu.org&gt;</a>.</p>
185
186 <p>Announcements about XBoard and most other GNU software are made on
187 <a href="mailto:info-gnu@gnu.org">&lt;info-gnu@gnu.org&gt;</a>.</p>
188
189 <p>To subscribe to these or any GNU mailing lists, please send an empty
190 mail with a Subject: header of just <tt>subscribe</tt> to the relevant
191 -request list.  For example, to subscribe yourself to the GNU
192 announcement list, you would send mail to <a
193 href="mailto:info-gnu-request@gnu.org?Subject=subscribe">&lt;info-gnu-request@gnu.org&gt;</a>.
194 Or you can use the <a
195 href="http://lists.gnu.org/mailman/listinfo/info-gnu">mailing list web
196 interface</a>.</p>
197
198 <h4>discussion forums</h4>
199
200 <p>A very active forum is the <a href="http://www.open-aurec.com/wbforum/">WinBoard Forum</a> (where our current main developer HGM can be found).</p>
201
202 <h3>Reporting Bugs</h3>
203
204 <p> If you think you found a bug, please check the <a href="http://savannah.gnu.org/bugs/?group=xboard">bugtracker</a> for open and already closed bugs. If you found a new bug, please, file a bug-report either via our bug-related email list or in the <a href="http://savannah.gnu.org/bugs/?group=xboard">bugtracker</a>.
205
206 <!-- will be in the next release
207 -<h3>Translating XBoard</h3>
208
209 <p>To translate XBoard's messages into other languages, please see the <a
210 href="http://translationproject.org/domain/xboard.html">Translation Project
211 page for XBoard</a>.  If you have a new translation of the message strings,
212 or updates to the existing strings, please have the changes made in this
213 repository.  Only translations from this site will be incorporated into
214 XBoard.  For more information, see the <a
215 href="http://translationproject.org/html/welcome.html">Translation
216 Project welcome page</a>.
217 -->
218
219 <p>Please remember that development of XBoard, and GNU in general, is a
220 volunteer effort, and you also can contribute. For information, please
221 read <a href="/help/">How to help GNU</a>.</p>
222
223
224 <!-- If needed, change the copyright block at the bottom. In general, -->
225 <!-- all pages on the GNU web server should have the section about    -->
226 <!-- verbatim copying.  Please do NOT remove this without talking     -->
227 <!-- with the webmasters first. -->
228 <!-- Please make sure the copyright date is consistent with the document -->
229 <!-- and that it is like this "2001, 2002" not this "2001-2002." -->
230 </div><!-- for id="content", starts in the include above -->
231 <!--#include virtual="/server/footer.html" -->
232 <div id="footer">
233
234 <p>Please send FSF &amp; GNU inquiries to
235 <a href="mailto:gnu@gnu.org">&lt;gnu@gnu.org&gt;</a>.
236 There are also <a href="/contact/">other ways to contact</a>
237 the FSF.<br />
238 Please send broken links and other corrections or suggestions to
239 <!-- If you are a project maintainer or developer, please use your own -->
240 <!-- project email, as webmasters does not manage project web pages. -->
241 <!-- However, please report problems in this boilerplate file -->
242 <!-- itself to webmasters.  -->
243 <!-- And remove this whole comment when you copy the file to a new page. -->
244 <a href="mailto:bug-xboard@gnu.org">&lt;bug-xboard@gnu.org&gt;</a>.</p>
245
246 <p>Please see the <a
247 href="/server/standards/README.translations.html">Translations
248 README</a> for information on coordinating and submitting translations
249 of this article.</p>
250
251 <p>Copyright &copy; 2009 Free Software Foundation, Inc.</p>
252
253 <p>Verbatim copying and distribution of this entire article are
254 permitted worldwide, without royalty, in any medium, provided this
255 notice, and the copyright notice, are preserved.</p>
256
257 <p>Updated:
258 <!-- timestamp start -->
259 $Date$
260 <!-- timestamp end -->
261 </p>
262 </div>
263
264 <div id="translations">
265 <h4>Translations of this page</h4>
266
267 <!-- Please keep this list alphabetical by language code. -->
268 <!-- Comment what the language is for each type, i.e. de is German. -->
269 <!-- Write the language name in its own language (Deutsch) in the text. -->
270 <!-- If you add a new language here, please -->
271 <!-- advise web-translators@gnu.org and add it to -->
272 <!--  - /home/www/html/server/standards/README.translations.html -->
273 <!--  - one of the lists under the section "Translations Underway" -->
274 <!--  - if there is a translation team, you also have to add an alias -->
275 <!--  to mail.gnu.org:/com/mailer/aliases -->
276 <!-- Please also check you have the language code right; see: -->
277 <!-- http://www.loc.gov/standards/iso639-2/php/code_list.php -->
278 <!-- If the 2-letter ISO 639-1 code is not available, -->
279 <!-- use the 3-letter ISO 639-2. -->
280 <!-- Please use W3C normative character entities. -->
281
282 <ul class="translations-list">
283 <!-- English -->
284 <li><a href="/server/standards/boilerplate.html">English</a>&nbsp;[en]</li>
285 </ul>
286 </div>
287 </div>
288 </body>
289 </html>