Put picture of GTK build on home page
[xboard.git] / index.html
1 <!--#include virtual="/server/html5-header.html" -->
2 <title>XBoard - GNU Project - Free Software Foundation</title>
3 <!--#include virtual="/server/banner.html" -->
4 <!--#set var="article_name" value="/server/standards/boilerplate" -->
5 <!--#include virtual="/server/gnun/initial-translations-list.html" -->
6 <h2>XBoard</h2>
7
8 <!-- This is the template document for GNU web pages.  We use -->
9 <!-- server side includes (#include) for common elements, for -->
10 <!-- instance, the very first line of the file.  If you're reading -->
11 <!-- this in its expanded form, you can retrieve the original source,  -->
12 <!-- with the SSI statements intact, from -->
13 <!-- http://web.cvs.savannah.gnu.org/viewvc/*checkout*/www/server/standards/boilerplate.html?root=www&content-type=text%2Fplain
14   -->
15
16 <p>XBoard is a graphical user interface for chess in all its major
17 forms, including international chess, xiangqi (Chinese chess),
18 shogi (Japanese chess) and Makruk, in addition to many minor variants such as
19 Losers Chess, Crazyhouse, Chess960 and Capablanca Chess. It displays a
20 chessboard on the screen, accepts moves made with the mouse, and loads
21 and saves games in Portable Game Notation (PGN). It serves as a
22 front-end for many different chess services, including:</p>
23 <ul>
24 <li>
25 Chess engines that will run on your machine and play a game against
26 you or help you analyze, such as GNU Chess, Crafty, or many
27 others.</li>
28
29 <li>Chess servers on the Internet, where you can connect to play chess
30 with people from all over the world, watch other users play, or just
31 hang out and chat.</li>
32
33 <li>Correspondence chess played by electronic mail. The CMail program
34 automates the tasks of parsing email from your opponent, playing his
35 moves out on your board, and mailing your reply move after you've
36 chosen it.</li>
37 </ul>
38 <p>XBoard runs on Unix and Unix-like systems that use the X Window
39 System. </p>
40
41 <table cellpadding="20"><tr><td valign="top">
42  <h4>More...</h4>
43  <ul>
44   <li><a href="#tag-A1">WinBoard</a> (MS Windows port)</li>
45   <li><a href="#download">Downloading</a></li>
46   <li><a href="#tag-A4">Documentation</a></li>
47   <li><a href="user_guide/UserGuide.html">On-line User Guide</a></li>
48   <li><a href="#tag-A5">More Screenshots</a></li>
49   <li><a href="whats_new/4.9.0/index.html">What's New in 4.9.0?</a>(stable)</li>
50   <li><a href="whats_new/4.8.0/index.html">What's New in 4.8.0?</a></li>
51   <li><a href="whats_new/4.7.3/index.html">What's New in 4.7.3?</a></li>
52   <li><a href="whats_new/4.7.2/index.html">What's New in 4.7.2?</a></li>
53   <li><a href="whats_new/4.7.1/index.html">What's New in 4.7.1?</a></li>
54   <li><a href="whats_new/4.7.0/index.html">What's New in 4.7.0?</a></li>
55   <li><a href="whats_new/4.6.2/index.html">What's New in 4.6.2?</a></li>
56   <li><a href="whats_new/4.6.1/index.html">What's New in 4.6.1?</a> (faulty)</li>
57   <li><a href="whats_new/4.6.0/index.html">What's New in 4.6.0?</a></li>
58   <li><a href="whats_new/4.5.3/index.html">What's New in 4.5.3?</a></li>
59   <li><a href="whats_new/4.5.2/index.html">What's New in 4.5.2?</a></li>
60   <li><a href="whats_new/4.5.1/index.html">What's New in 4.5.1?</a></li>
61   <li><a href="whats_new/4.5.0/index.html">What's New in 4.5.0?</a></li>
62   <li><a href="whats_new/4.4.0/index.html">What's New in 4.4.x?</a></li>
63   <li><a href="#tag-A3">How can you help us?</a></li>
64   <li><a href="FAQ.html">Frequently Asked Questions</a></li>
65  </ul>
66 </td><td>
67  <img src="whats_new/SpartanGTK.png">
68  <p><i>XBoard GTK build, playing some Chess variant</i></p>
69 </td><td valign="bottom">
70  <img src="whats_new/4.4.0/marble.png">
71  <p><i>WinBoard, configured with marble board</i></p>
72 </td></tr></table>
73
74 <h3><a name="tag-A1">Winboard</h3>
75
76 <p>The project also includes a port to MicroSoft-Windows systems called
77 WinBoard.</p>
78
79 <p>You can find the downloads for binaries and preconfigured installer packages of Winboard at
80 the <a href="http://www.open-aurec.com/wbforum/viewforum.php?f=19">Winboard Forum</a>,
81 where yo can also report problems, get help from other WinBoard users or discuss feature requests.
82 Windows builds of development versions or installers for special configuartions
83 can be found at <a href="http://hgm.nubati.net/ ">HGM's web page</a>.
84 </p>
85
86 <p>Development for Winboard, reporting bugs and any other requests can
87 also be done at the same places as for XBoard (see below).</p>
88
89 <h3><a name="download"></a>Downloading XBoard</h3>
90
91 <h4>stable version (4.8.0)</h4>
92
93 <p>Sources of current stable version can be found on the main GNU ftp server:
94 <a href="http://ftp.gnu.org/gnu/xboard/">http://ftp.gnu.org/gnu/xboard/</a> (via http) and
95
96 <a href="ftp://ftp.gnu.org/gnu/xboard/">ftp://ftp.gnu.org/gnu/xboard/</a> (via ftp).
97 It can also be found on one of the <a href="/prep/ftp.html">mirrors
98 of ftp.gnu.org</a>;
99 please <a href="http://ftpmirror.gnu.org/xboard">use a mirror</a> if
100 possible.</p>
101
102 <p>Precompiled versions are available
103 for <a href="http://download.opensuse.org/repositories/openSUSE:/Factory:/Contrib/">openSUSE</a>
104 and <a href="http://packages.debian.org/sid/xboard">debian-sid</a>
105
106 (if you know of other distribution that package it, please let us
107 know).</p>
108
109 <h4>Mac OSX Intel 10.7+ App</h4>
110 <p1>A preconfigured app bundle of Xboard for Mac OSX can also be found at the <a href="http://www.open-aurec.com/wbforum/viewtopic.php?f=19&t=53274">Winboard Forum</a>.</p>
111
112
113 <h4>development version</h4>
114
115 <p>We regularly do so called 'developer releases', which include the newest and the latest we are working on.
116 If you want to <a href="#tag-A3">help us</a> test, or just want to use the new features, you might prefer to use those over the stable version.
117 </p>
118
119 <p>At the <a href="http://download.opensuse.org/repositories/home:/apersaud:/xboard">Open Build Server</a> we provide packages that can be installed in parallel to the normal xboard version. To do this the programs are renamed to xboardnext (latest from the v4.7.x branch in git) and xboardgit (latest version from the master branch in git). Packages are available for: Debian 6.0, Fedora 17/18, RedHat RHEL 6, opensuse 12.1/12.2/12.3/Tumbleweed/Factory, Centos 6, Arch, Ubunutu 10.04/12.04/12.10. These packages are generated automatically and are for testing purposes only. Please let us know if you have any problems related to XBoard or package dependencies.</p>
120
121 <p> Windows builds of development version can often be found at <a href="http://hgm.nubati.net/ ">HGM's web page</a>.
122
123 <p>Furthermore we provide development versions (tagged commits in git):</p>
124
125 <ul>
126 <li>A snapshot of the master branch is available: <a href="ftp://alpha.gnu.org/gnu/xboard/"> master-20130828</a>.</li>
127 <li>A snapshot of the release branch is available: (no developer release available at the moment)</li>
128 </ul>
129
130 <h5>How to build the development version</h5>
131
132 <h6>git version</h6>
133
134 <p> The <a href="http://git.savannah.gnu.org/cgit/xboard.git">git repository</a> is available on Savannah. All branches can be viewed there. The web page also provides tar-balls of all tagged versions, these tar-balls are different from the ones that you can download from the <a href="ftp://ftp.gnu.org/gnu/xboard/"> ftp-server </a> and you will need to run <code>./autogen.sh</code> on them as described below.</p>
135
136 <p> If you want to get a copy of the repository you can clone it using the command <code>"git clone http://git.savannah.gnu.org/r/xboard.git"</code>. For more information on how to use git, please visit the git home page.</p>
137
138 <p> After cloning the git-repository or downloading and unpacking a snapshot tar-ball from the git repository,
139 run <code>./autogen.sh</code>, <code>./configure</code> and then <code>make</code> and <code>make install</code>.</p>
140
141 <h6>tar-balls (from the ftp-server)</h6>
142 <p> Unpack the tar ball and do <code>./configure</code> followed by <code>make</code> and <code>make install</code>.</p>
143
144 <p>For development sources and other information, please see
145 the <a href="http://savannah.gnu.org/projects/xboard/">XBoard project
146 page</a> at <a href="http://savannah.gnu.org">savannah.gnu.org</a>.</p>
147
148 <h4>archive</h4>
149
150 <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>
151
152 <h3><a name="tag-A4">Documentation</h3>
153
154 <p>The official <a href="manual/">manual page for XBoard</a> is available online,
155 as is <a href="/manual/">documentation for most GNU software</a>.
156 This discusses every feature XBoard has in detail.
157 You may also find this information on your local system by
158 running <em>info&nbsp;xboard</em> or <em>man&nbsp;xboard</em>, or by
159 looking at <em>/usr/doc/xboard/</em>,
160 <em>/usr/local/doc/xboard/</em>, or similar directories on your system.</p>
161
162 <p>There now also exists an <a href="user_guide/UserGuide.html">XBoard User Guide</a>, which only presents the main features in a more pedestrian way.
163 This would be an excellent starting point if you are a novice XBoard user.
164 If you have prior experience with XBoard, but just want to know what new features have been added since the version you were used to,
165 the pages in the <a href="whats_new/index.html">What's New</a> section would be the place to go.
166 </p>
167
168 <p>A description of the Chess Engine Communication Protocol used by XBoard to communicate with Chess Engines can be found <a href="engine-intf.html">here</a>.</p>
169
170 <h3><a name="tag-A5"Screenshots</h3>
171
172 <p>These are screenshots taken from version 4.4.0 (click to enlarge).</p>
173 <a href="graphics/xboard-4.4.0.png"><img src="graphics/xboard-4.4.0.png" alt=" [screenshot normal game] " height="200" /></a>
174 <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>
175 <a href="graphics/xboard-4.4.0-showgi.png"><img src="graphics/xboard-4.4.0-showgi.png" alt=" [screenshot shogi game] " height="200" /></a>
176 <a href="graphics/xboard-4.4.0-petite.png"><img src="graphics/xboard-4.4.0-petite.png" alt=" [screenshot auxiliary windows " height="200" /></a>
177 <a href="graphics/xboard-4.4.0-XQ.png"><img src="graphics/xboard-4.4.0-XQ.png" alt=" [screenshot xiangqi game] " height="200" /></a>
178
179 <h3><a name="tag-A3">Help needed</h3>
180
181 <p>It would be great if people would like to help in the developing process. We can use all kinds 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).
182 Have a look at the following list in case you are interested:</p>
183
184 <h4>Translators </h4>
185 <p>We added support for different languages to XBoard and need people to translate it. The translation is handled by <a href="http://translationproject.org/html/welcome.html">the translation project</a>. You can check on the <a href="http://translationproject.org/domain/xboard.html">current status</a> and how to <a href="http://translationproject.org/html/translators.html">join the translation project</a>. </p>
186
187 <h4>Testers </h4>
188 <p> We are always looking for people who are willing to test the latest new features and give us feedback or new ideas. If you are interested, please send an email to our list at <a href="mailto:xboard-devel@gnu.org">&lt;xboard-devel@gnu.org&gt;</a> or just try out the program and reports bugs either to the email list or to the bug-tracker (see <a href="#download">below</a> for links).</p>
189
190 <h4>GTK developer needed</h4>
191 <p> We are also working on merging Winboard and XBoard back into one version using a cross platform GTK-front end. This will help us clean up the code and make things like internationalization easier. We made some progress, if you know want to help out there are still lots of things waiting to be done. Email the <a href="mailto:xboard-devel@gnu.org">mailing list</a> for more information. </p>
192
193 <h4>EPD test-suite capability</h4>
194 <p>A sort of match mode where one engine automatically does a number of 'games',
195 (using a position file filled with EPDs as starting positions),
196 except that each 'game' lasts only for one move, and the 'result' is then computed
197 by XBoard depending on if this move was the correct solution specified in the EPD.</p>
198
199 <h4>Multi-board ICS mode</h4>
200 <p>Implement a slave mode where XBoard forks itself, connecting a pipe between
201 what normally would be the ICS socket of the child, and a new output channel
202 of the parent, so that the parent can forward board and move lists belonging to
203 a specific game to the slave dedicated to display it.</p>
204
205 <h4>Update the documentation</h4>
206 <p>The documentation could need some updates. In our effort to merge
207 Winboard and XBoard back together, we also want to merge the RTF file
208 back into the XBoard texinfo file.  This will take some effort though,
209 since the two versions still differ in several areas and this would
210 need to be highlighted. The benefit would be though that we could
211 prepare a much better and up to date Windows documentation.
212 </p>
213
214 <h4>Update the webpage</h4>
215
216 <p>The content of the webpage could be updated with screenshots from
217 the latest version. We also have a new tutorial that could be
218 integrated. The webpage should also be integrated with git, so that
219 all developers have access to it.</p>
220
221 <h3>Links</h3>
222
223 <ul>
224   <li> XBoard/Winboard
225     <ul>
226       <li> <a href="http://www.tim-mann.org/chess.html">Tim's original pages</a> are still available.</li>
227       <li> XBoard can also run engines that use the UCI protocol, with
228         the aid of the Polyglot protocol adapter.  A new Polyglot
229         version, (1.4.67b), especially adapted to support the new
230         features of XBoard 4.4.0 and later, can be
231         found <a href="http://alpha.uhasselt.be/Research/Algebra/Toga/polyglot-release/">here</a>.</li>
232
233     </ul>
234   </li>
235   <li> Incomplete list of computer engines that work with XBoard
236     <ul>
237       <li><a href="http://www.gnu.org/software/chess/">GNU chess</a></li>
238       <li><a href="http://home.hccnet.nl/h.g.muller/CVfairy.html">Fairy-Max</a></li>
239       <li><a href="http://wbec-ridderkerk.nl/html/lastupdates.htm">A list with lots of engines</a></li>
240
241       <li><a href="http://home.hccnet.nl/h.g.muller/XQ.html">List of Xiangqi engines</a></li>
242       <li> other popular engines are crafty, phalanx, fruit, toga2, glaurung, ... </li>
243     </ul>
244   </li>
245   <li> Chess server you can connect to using XBoard
246     <ul>
247       <li> <a href="http://www.freechess.org"> Free Internet Chess Server (FICS) </a></li>
248
249       <li> <a href="http://www.chessclub.com/"> The Internet Chess Club </a> </li>
250
251       <li> <a href="http://80.100.28.169/"> The Variant ICS </a> </li>
252     </ul>
253   </li>
254   <li> Other interfaces
255     <ul>
256       <li> <a href="http://www.bergo.eng.br/eboard/">eboard</a> </li>
257
258     </ul>
259   </li>
260 </ul>
261
262 <h3>Frequently Asked Question(FAQ)</h3>
263
264 <p>If you have any questions, please check out our <a href="FAQ.html">FAQ</a>.</p>
265
266
267 <h3>Mailing Lists and Discussion Forums</h3>
268
269 <h4>mailing lists</h4>
270
271 <p>XBoard has two mailing lists:
272 <a href="mailto:bug-xboard@gnu.org">&lt;bug-xboard@gnu.org&gt;</a> and
273 <a href="mailto:xboard-devel@gnu.org">&lt;xboard-devel@gnu.org&gt;</a>.</p>
274
275 <p>The main discussion list is
276 <a href="mailto:xboard-devel@gnu.org">&lt;xboard-devel@gnu.org&gt;</a>,
277 and is used to discuss most aspects of XBoard, including development
278 and enhancement requests. Please send bug reports
279 to <a href="mailto:bug-xboard@gnu.org">&lt;bug-xboard@gnu.org&gt;</a>.</p>
280
281 <p>Announcements about XBoard and most other GNU software are made on
282 <a href="mailto:info-gnu@gnu.org">&lt;info-gnu@gnu.org&gt;</a>.</p>
283
284 <p>To subscribe to these or any GNU mailing lists, please send an empty
285 mail with a Subject: header of just <tt>subscribe</tt> to the relevant
286 -request list.  For example, to subscribe yourself to the GNU
287 announcement list, you would send mail to <a
288 href="mailto:info-gnu-request@gnu.org?Subject=subscribe">&lt;info-gnu-request@gnu.org&gt;</a>.
289 Or you can use the <a
290 href="http://lists.gnu.org/mailman/listinfo/info-gnu">mailing list web
291 interface</a>.</p>
292
293 <h4>discussion forums</h4>
294
295 <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>
296
297 <h3>Reporting Bugs and Requesting New Features</h3>
298
299 <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>.
300
301
302 <p> For feature requests, please use our mailinglist: <a href="mailto:xboard-devel@gnu.org">&lt;xboard-devel@gnu.org&gt;</a>.</p>
303
304 <!-- will be in one of the next releases
305 -<h3>Translating XBoard</h3>
306
307 <p>To translate XBoard's messages into other languages, please see the <a
308 href="http://translationproject.org/domain/xboard.html">Translation Project
309 page for XBoard</a>.  If you have a new translation of the message strings,
310 or updates to the existing strings, please have the changes made in this
311 repository.  Only translations from this site will be incorporated into
312 XBoard.  For more information, see the <a
313 href="http://translationproject.org/html/welcome.html">Translation
314 Project welcome page</a>.
315 -->
316
317 <p>Please remember that development of XBoard, and GNU in general, is a
318 volunteer effort, and you also can contribute. For information, please
319 read <a href="/help/">How to help GNU</a>.</p>
320
321
322 <h3 id="license">Licensing</h3>
323
324 <p>XBoard
325 is free software; you can redistribute it and/or modify it under the
326 terms of the <a href="http://www.gnu.org/licenses/gpl.html"
327 rel="license">GNU General Public License</a> as published by the Free
328 Software Foundation; either version&nbsp;3 of the License, or (at your
329 option) any later version.</p>
330
331 </div><!-- for id="content", starts in the include above -->
332 <!--#include virtual="/server/footer.html" -->
333 <div id="footer">
334
335 <p>Please send general FSF &amp; GNU inquiries to
336 <a href="mailto:gnu@gnu.org">&lt;gnu@gnu.org&gt;</a>.
337 There are also <a href="/contact/">other ways to contact</a>
338 the FSF.<br />
339 Please send broken links and other corrections or suggestions to
340 <a href="mailto:bug-xboard@gnu.org">&lt;bug-xboard@gnu.org&gt;</a>.</p>
341
342 <p>Please see the <a
343 href="/server/standards/README.translations.html">Translations
344 README</a> for information on coordinating and submitting translations
345 of this article.</p>
346
347 <p>Copyright &copy; 2009, 2010, 2011, 2012, 2013 Free Software Foundation, Inc.</p>
348
349 <p>This page is licensed under a <a rel="license"
350 href="http://creativecommons.org/licenses/by-nd/3.0/us/">Creative
351 Commons Attribution-NoDerivs 3.0 United States License</a>.</p>
352
353 <p>Updated:
354 <!-- timestamp start -->
355 $Date: 2014/10/18 05:15:05 $
356 <!-- timestamp end -->
357 </p>
358 </div>
359 </div>
360 </body>
361 </html>