~ubuntu-branches/debian/sid/gnome-chess/sid

« back to all changes in this revision

Viewing changes to doc/C/gnome-chess-manual.sgml

  • Committer: Bazaar Package Importer
  • Author(s): Sebastian Rittau
  • Date: 2005-09-04 18:16:43 UTC
  • mfrom: (2.1.1 warty)
  • Revision ID: james.westby@ubuntu.com-20050904181643-qfph33u3pa4azz5h
Tags: 0.3.3-6
* Fix problems with gcc 4.0:
  + debian/patches/021-gcc-4.0-fixes.diff: New patch.
  + Closes: #258798 "FTBFS with gcc-3.4: label at end of compound statement"
* Fix wrong Debian patch:
  + debian/patch/019-assertions.diff: Fixed.
  + Partly addresses bug #247846 "Crashes after a few moves (assertion
    failed)". This fix is not perfect. As Göran Weinholt notes in the
    bug report, assertions are not the way to go, but are a temporary
    stop-gap measure. (Better assertions than unpredicable results.)

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<!DOCTYPE article PUBLIC "-//GNOME//DTD DocBook PNG Variant V1.1//EN"[
 
2
        <!-- if not using PNG graphic, replace reference above with
 
3
             .....PUBLIC "-//OASIS//DTD DocBook V3.1//EN"[
 
4
         -->
 
5
<!ENTITY version "1.4.0"> <!-- replace with application version -->
 
6
<!ENTITY date "4/20/2001"> <!-- date the manual was last updated -->
 
7
]>
 
8
 
 
9
<!-- 
 
10
      (Do not remove this comment block.)
 
11
  Maintained by the GNOME Documentation Project
 
12
  http://developer.gnome.org/projects/gdp
 
13
  Template version: 1.0.4
 
14
  Template last modified April 20, 2001
 
15
-->
 
16
 
 
17
 
 
18
<!-- =============Document Header ============================= -->
 
19
 
 
20
<article id="index" lang="en"> 
 
21
<!-- please do not change the id; for translations, change lang to -->
 
22
<!-- appropriate code -->
 
23
 
 
24
  <artheader>
 
25
    <title>Gnome Chess Manual</title>
 
26
    <copyright>
 
27
      <year>2001</year>
 
28
      <holder>JP Rosevear</holder>
 
29
    </copyright>
 
30
 
 
31
  <!-- translators: uncomment this:
 
32
 
 
33
  <copyright>
 
34
   <year>2000</year>
 
35
   <holder>ME-THE-TRANSLATOR (Latin translation)</holder>
 
36
  </copyright>
 
37
 
 
38
   -->
 
39
 
 
40
  <legalnotice id="legalnotice">
 
41
   <para>
 
42
    Permission is granted to copy, distribute and/or modify this document
 
43
    under the terms of the <link linkend="fdl"><citetitle>GNU
 
44
    Free Documentation License</citetitle></link>, Version 1.1 or any later
 
45
    version published by the Free Software Foundation with no Invariant
 
46
    Sections, no Front-Cover Texts, and no Back-Cover Texts.  A copy of the
 
47
    license can be found in <xref linkend="fdl">.
 
48
   </para>
 
49
   <para>
 
50
    Many of the names used by companies to distinguish their products and
 
51
    services are claimed as trademarks. Where those names appear in any
 
52
    GNOME documentation, and those trademarks are made aware to the members
 
53
    of the GNOME Documentation Project, the names have been printed in caps
 
54
    or initial caps.
 
55
   </para>
 
56
  </legalnotice>
 
57
  -->
 
58
 
 
59
    <releaseinfo>
 
60
       This manual describes version &version; of Gnome Chess. It was
 
61
       last updated on &date;.
 
62
    </releaseinfo>
 
63
 
 
64
  </artheader>
 
65
 
 
66
 <!-- ============= Document Body ============================= -->
 
67
 
 
68
 <!-- ============= Introduction ============================== -->
 
69
  <sect1 id="intro">
 
70
    <title>Introduction</title>
 
71
 
 
72
    <para>
 
73
     <application>Gnome Chess</application> is an application which
 
74
     allows the user to do a variety of chess related things.
 
75
     Currently you can play the Crafty or GNU Chess engines, play on
 
76
     internet chess servers such as FICS and view games in PGN files.
 
77
    </para>
 
78
 
 
79
    <para>
 
80
      To run <application>Gnome Chess</application>, select
 
81
      <menuchoice>
 
82
        <guisubmenu>Games</guisubmenu>
 
83
        <guimenuitem>Gnome Chess</guimenuitem>
 
84
      </menuchoice>
 
85
      from the <guimenu>Main Menu</guimenu>, or type
 
86
      <command>gnome-chess</command> on the command line.
 
87
  </para>
 
88
 
 
89
    <para>
 
90
      <application>Gnome Chess</application> is included in the
 
91
      <filename>gnome-chess</filename> package.  This document
 
92
      describes version &version; of <application>Gnome
 
93
      Chess</application>.
 
94
    </para>
 
95
  </sect1>
 
96
 
 
97
 
 
98
 <!-- ================ Usage ================================ -->
 
99
 
 
100
  <sect1 id="usage">
 
101
    <title>Using Gnome Chess</title>
 
102
    <para>
 
103
      <application>Gnome Chess</application> can be used to play against
 
104
      the GNU Chess or Crafty chess engines, view files in PGN format or
 
105
      play on chess servers like FICS.  It provides an easy to easy-to-use 
 
106
      graphical interface for this. This section describes basic usage of
 
107
      <application>Gnome Chess</application>.
 
108
    </para>
 
109
 
 
110
    <!-- ========= Basic Usage =========================== -->
 
111
    <sect2 id="mainwin">
 
112
      <title>Basic usage</title>
 
113
      <para>
 
114
        Starting <application>Gnome Chess</application> opens the
 
115
        <interface>Main window</interface>, shown in <xref
 
116
        linkend="mainwindow-fig">. The window at first contains a chess 
 
117
        board at the starting usual starting position.
 
118
 
 
119
        <!-- ==== Figure ==== -->
 
120
        <figure id="mainwindow-fig">
 
121
          <title>Gnome Chess Main Window</title>
 
122
          <screenshot>
 
123
            <screeninfo>Gnome Chess Main Window</screeninfo>
 
124
            <graphic fileref="./figures/main.png" format="png" srccredit="JP Rosevear">
 
125
            </graphic>
 
126
          </screenshot>
 
127
        </figure>
 
128
    <!-- ==== End of Figure ==== -->
 
129
      </para> 
 
130
 
 
131
      <sect3 id="playing-program">
 
132
        <title>Playing Against A Program</title>
 
133
        <para>
 
134
          To play against a program, once you have added some via the
 
135
          Preferences dialog, select
 
136
          <menuchoice>
 
137
            <guisubmenu>File</guisubmenu>
 
138
            <guimenuitem>Open</guimenuitem>
 
139
          </menuchoice>,
 
140
            which will bring up a new game view in its own tab.
 
141
            By default you are white, simply begin moving the pieces and
 
142
            the program will respond.
 
143
        </para>
 
144
      </sect3>
 
145
 
 
146
      <sect3 id="playing-server">
 
147
        <title>Playing On A Server</title>
 
148
        <para>
 
149
          To play on a server, once you have added some via the
 
150
          Preferences dialog, select
 
151
          <menuchoice>
 
152
            <guisubmenu>File</guisubmenu>
 
153
            <guimenuitem>Programs</guimenuitem>
 
154
          </menuchoice>,
 
155
            which will bring up a new game view in its own tab.  It will 
 
156
            also bring up an information area which is a terminal view of the
 
157
            chess server with an area to enter commands.
 
158
        </para>
 
159
      </sect3>
 
160
 
 
161
      <sect3 id="pgn">
 
162
        <title>Playing On A Server</title>
 
163
        <para>
 
164
          To open PGN formatted files, select
 
165
          <menuchoice>
 
166
            <guisubmenu>File</guisubmenu>
 
167
            <guimenuitem>Open</guimenuitem>
 
168
          </menuchoice>,
 
169
            which will bring up a new game view in its own tab.  It will 
 
170
            also bring up an information area which is a list of all the games
 
171
            in the file.
 
172
        </para>
 
173
        <para>
 
174
          Clicking on any game will display it in the game view.  You can then
 
175
          use the buttons under the list of moves to move forward and backward
 
176
          through the game.
 
177
        </para>
 
178
      </sect3>
 
179
 
 
180
    <!-- ========= Menus =========================== --> 
 
181
 
 
182
    <sect2 id="menubar">
 
183
 
 
184
      <title>Menus</title>
 
185
      <para>
 
186
        The menu bar, located at the top of the <interface>Main
 
187
        Window</interface>, contains the following menus:
 
188
       </para>
 
189
      <variablelist>
 
190
        <varlistentry>
 
191
          <term><guimenu>File</guimenu></term>
 
192
          <listitem>
 
193
            <para>
 
194
               This menu contains:
 
195
               <itemizedlist>
 
196
                <listitem>
 
197
                  <para>
 
198
                    <menuchoice>
 
199
                      <shortcut>
 
200
                        <keycap>F3</keycap>
 
201
                      </shortcut>
 
202
                      <guimenuitem>Open</guimenuitem>
 
203
                     </menuchoice>
 
204
                     &mdash; This opens a PGN file which is saved on your computer.
 
205
                   </para>
 
206
                </listitem>
 
207
                <listitem>
 
208
                  <para>
 
209
                     <menuchoice>
 
210
                      <shortcut>
 
211
                        <keycombo><keycap>Ctrl</keycap><keycap>S</keycap></keycombo>
 
212
                      </shortcut>
 
213
                      <guimenuitem>Save</guimenuitem>
 
214
                    </menuchoice>
 
215
                    &mdash; This saves the moves of the current game in PGN format.
 
216
                  </para>
 
217
                </listitem>
 
218
                <listitem>
 
219
                  <para>
 
220
                     <menuchoice>
 
221
                      <guimenuitem>Programs</guimenuitem>
 
222
                    </menuchoice>
 
223
                    &mdash; A list of programs to play against.  Selecting one opens
 
224
                    a new game view.
 
225
                  </para>
 
226
                </listitem>
 
227
                <listitem>
 
228
                  <para>
 
229
                     <menuchoice>
 
230
                      <guimenuitem>Server</guimenuitem>
 
231
                    </menuchoice>
 
232
                    &mdash; A list of servers to play against.  Selecting one opens
 
233
                    a new game view and a info window displaying a terminal view of
 
234
                    the chess server.
 
235
                  </para>
 
236
                </listitem>
 
237
                <listitem>
 
238
                  <para>
 
239
                     <menuchoice>
 
240
                      <shortcut>
 
241
                        <keycombo><keycap>Ctrl</keycap><keycap>W</keycap></keycombo>
 
242
                      </shortcut>
 
243
                      <guimenuitem>Close</guimenuitem>
 
244
                    </menuchoice>
 
245
                    &mdash; This closes the current game view.
 
246
                  </para>
 
247
                </listitem>
 
248
                <listitem>
 
249
                  <para>
 
250
                    <menuchoice>
 
251
                      <shortcut>
 
252
                        <keycombo><keycap>Ctrl</keycap><keycap>Q</keycap></keycombo>
 
253
                      </shortcut>
 
254
                      <guimenuitem>Exit</guimenuitem>
 
255
                    </menuchoice>
 
256
                    &mdash; This quits the application.
 
257
                  </para>
 
258
                </listitem>
 
259
              </itemizedlist>
 
260
          </para>
 
261
          </listitem>
 
262
        </varlistentry>
 
263
        
 
264
        <varlistentry>
 
265
          <term><guimenu>Game</guimenu></term>
 
266
        </varlistentry>
 
267
 
 
268
        <varlistentry>
 
269
          <term><guimenu>Settings</guimenu></term>
 
270
          <listitem>
 
271
            <para>
 
272
           This menu contains:
 
273
           <itemizedlist>
 
274
                <listitem>
 
275
                  <para>
 
276
              <guimenuitem>Preferences&hellip;</guimenuitem>
 
277
               &mdash; This opens the <link
 
278
               linkend="prefs"><interface>Preferences
 
279
               Dialog</interface></link>, which allows you to configure
 
280
               many settings.
 
281
             </para>
 
282
                </listitem>
 
283
              </itemizedlist>
 
284
            </para>
 
285
          </listitem>
 
286
        </varlistentry>
 
287
        
 
288
        <varlistentry>
 
289
          <term><guimenu>Help</guimenu></term>
 
290
          <listitem>
 
291
            <para>
 
292
              This menu contains:
 
293
               <itemizedlist>
 
294
                <listitem>
 
295
                  <para>
 
296
                     <guimenuitem>Manual</guimenuitem> &mdash; This
 
297
                      opens the <application>GNOME Help
 
298
                      Browser</application> and displays this manual.
 
299
                  </para>
 
300
                </listitem>
 
301
                
 
302
                <listitem>
 
303
                  <para>
 
304
                    <guimenuitem>About</guimenuitem> &mdash; This
 
305
                    opens the <interface>About</interface> dialog
 
306
                    which shows basic information about
 
307
                    <application>Gnome Chess</application>, such as
 
308
                    the author's name, the application version number,
 
309
                    and the URL for the application's Web page if one
 
310
                    exists.
 
311
                  </para>
 
312
                </listitem>
 
313
              </itemizedlist>
 
314
            </para>
 
315
          </listitem>
 
316
        </varlistentry>
 
317
      </variablelist>
 
318
    </sect2>
 
319
  </sect1>
 
320
 
 
321
 
 
322
 
 
323
 <!-- ============= Customization ============================= -->
 
324
 
 
325
 <sect1 id="prefs">
 
326
  <title>Customization</title>
 
327
  <para>
 
328
   To change the application settings, select
 
329
   <menuchoice>
 
330
    <guimenu>Settings</guimenu>
 
331
    <guimenuitem>Preferences...</guimenuitem>
 
332
   </menuchoice>.  This opens the
 
333
   <interface>Preferences</interface> dialog, shown in <xref
 
334
   linkend="preferences-fig">.
 
335
  </para>
 
336
 
 
337
  <figure id="preferences-fig">
 
338
   <title>Preferences Dialog</title>
 
339
   <screenshot>
 
340
    <screeninfo>Preferences Dialog</screeninfo>
 
341
    <graphic fileref="./figures/prefs.png" format="png" srccredit="JP Rosevear">
 
342
    </graphic>
 
343
   </screenshot>
 
344
  </figure>
 
345
 
 
346
  <para>
 
347
   The properties in the <guilabel>Board &amp; Pieces</guilabel> tab are:
 
348
 
 
349
      <variablelist>
 
350
        <varlistentry>
 
351
          <term> <guilabel>Light Colored Squares</guilabel></term>
 
352
          <listitem>
 
353
            <para>
 
354
              Select the color that light (white) board squares will be.
 
355
            </para>
 
356
          </listitem>
 
357
        </varlistentry>
 
358
        <varlistentry>
 
359
          <term> <guilabel>Dark Colored Squares</guilabel></term>
 
360
          <listitem>
 
361
            <para>
 
362
              Select the color that dark (black) board squares will be.
 
363
            </para>
 
364
          </listitem>
 
365
        </varlistentry>
 
366
        <varlistentry>
 
367
          <term>Pieces</term>
 
368
          <listitem>
 
369
            <para>
 
370
             Select the directory in which the piece set you want to use
 
371
             is located.  Defaults to the set that comes with Gnome Chess.
 
372
             </para>
 
373
          </listitem>
 
374
        </varlistentry>
 
375
      </variablelist>
 
376
    </para>
 
377
 
 
378
    <para>
 
379
     The properties in the <guilabel>Playing</guilabel> tab are:
 
380
       <variablelist>
 
381
        <varlistentry>
 
382
          <term>Beep when a move is made</term>
 
383
          <listitem>
 
384
            <para>
 
385
             If checked, a beep will be emitted whenever a move is made.
 
386
             </para>
 
387
          </listitem>
 
388
        </varlistentry>
 
389
        <varlistentry>
 
390
          <term>Always promote to queen</term>
 
391
          <listitem>
 
392
            <para>
 
393
             Automatically promotes a pawn to a queen, rather than any 
 
394
             other piece.
 
395
             </para>
 
396
          </listitem>
 
397
        </varlistentry>
 
398
        <varlistentry>
 
399
          <term>Autoflag</term>
 
400
          <listitem>
 
401
            <para>
 
402
             Automatically call your opponents flag.  Currently works
 
403
             only on chess servers.
 
404
             </para>
 
405
          </listitem>
 
406
        </varlistentry>
 
407
        <varlistentry>
 
408
          <term>Move list in Standard Algebraic Notation</term>
 
409
          <listitem>
 
410
            <para>
 
411
             Check this to have the move list display Standard Algebraic 
 
412
             Notation
 
413
             </para>
 
414
          </listitem>
 
415
        </varlistentry>
 
416
        <varlistentry>
 
417
          <term>Move list in Coordinate Notation</term>
 
418
          <listitem>
 
419
            <para>
 
420
             Check this to have the move list display Coordinate Notation
 
421
             </para>
 
422
          </listitem>
 
423
        </varlistentry>
 
424
      </variablelist>
 
425
    </para>
 
426
 
 
427
    <para>
 
428
     The properties in the <guilabel>Servers</guilabel> tab are:
 
429
       <variablelist>
 
430
        <varlistentry>
 
431
          <term>Server List</term>
 
432
          <listitem>
 
433
            <para>
 
434
             This is a list of servers available to connect to.  Click
 
435
             the Add button to add one.  Highlight a server in the list
 
436
             and click the Modify button to change it or the Delete button
 
437
             to remove it from the list.  The list of servers for connecting
 
438
             will be available under the File menu.  
 
439
             </para>
 
440
          </listitem>
 
441
        </varlistentry>
 
442
        <varlistentry>
 
443
          <term>Telnet Program</term>
 
444
          <listitem>
 
445
            <para>
 
446
             Use this to set the program to use when connecting to a
 
447
             chess server.  You may, for instance, wish to use timeseal
 
448
             rather than the default telnet.
 
449
             </para>
 
450
          </listitem>
 
451
        </varlistentry>
 
452
      </variablelist>
 
453
    </para>
 
454
 
 
455
    <para>
 
456
     The properties in the <guilabel>Programs</guilabel> tab are:
 
457
       <variablelist>
 
458
        <varlistentry>
 
459
          <term>Program List</term>
 
460
          <listitem>
 
461
            <para>
 
462
             This is a list of chess program available to play.  Click
 
463
             the Add button to add one.  Highlight a program in the list
 
464
             and click the Modify button to change it or the Delete button
 
465
             to remove it from the list.  The list of programs for playing
 
466
             will be available under the File menu.  Note that play GNU Chess
 
467
             you should use the gnuchessx executable program.
 
468
             </para>
 
469
          </listitem>
 
470
        </varlistentry>
 
471
        <varlistentry>
 
472
          <term>Telnet Program</term>
 
473
          <listitem>
 
474
            <para>
 
475
             Use this to set the program to use when connecting to a
 
476
             chess server.  You may, for instance, wish to use timeseal
 
477
             rather than the default telnet.
 
478
             </para>
 
479
          </listitem>
 
480
        </varlistentry>
 
481
      </variablelist>
 
482
    </para>
 
483
 
 
484
  <para>
 
485
    After you have made all the changes you want, click on
 
486
    <guibutton>OK</guibutton> to apply the changes and close the
 
487
    <interface>Properties</interface> dialog. To cancel the changes
 
488
    and return to previous values, click the
 
489
    <guibutton>Close</guibutton> button.
 
490
  </para>
 
491
 
 
492
 </sect1>
 
493
 
 
494
 
 
495
 <!-- ============= Various Sections ============================= -->
 
496
 
 
497
 <!-- Here you should add, if necessary, several more sect1's,
 
498
 describing other windows (besides the main one), file formats,
 
499
 preferences dialogs,  etc. as appropriate. Try not to make any of
 
500
 these sections too long. -->
 
501
 
 
502
 
 
503
 <!-- ============= Bugs ================================== -->
 
504
 
 
505
 <sect1 id="bugs">
 
506
  <title>Known Bugs and Limitations</title>
 
507
  <para>
 
508
   All known bugs are listed on <ulink url="http://bugzilla.gnome.org" 
 
509
   type="http">Gnome Bugzilla</ulink>.
 
510
  </para>
 
511
 </sect1>
 
512
 
 
513
 
 
514
<!-- ============= Authors ================================ -->
 
515
 
 
516
 <sect1 id="authors">
 
517
  <title>Authors</title>
 
518
  <para>
 
519
   <application>Gnome Chess</application> was written by Robert Wilhelm
 
520
   (<email>robert.wilhelm@gmx.net</email>) and JP Rosevear 
 
521
   (<email>jpr@ximian.com</email>). To find more information about
 
522
   <application>Gnome Chess</application>, please visit the <ulink
 
523
   url="http://primates.ximian.com/~jpr/gnome-chess" type="http">Gnome Chess 
 
524
   Web page</ulink>.  This manual was written by JP Rosevear
 
525
   (<email>jpr@ximian.com</email>).
 
526
  </para>
 
527
  <para>
 
528
    If you have some comments or suggestions regarding this
 
529
   application, need help, or want to report a bug, plese contact us!
 
530
   Instructions for doing so are given in <ulink type="help"
 
531
   url="gnome-help:gnome-feedback"><citetitle>Reporting GNOME bugs and other
 
532
   feedback</citetitle></ulink> document, which you can find in the
 
533
   <guilabel>Help</guilabel> tab of
 
534
   <application>Nautilus</application> file manager.
 
535
  </para>
 
536
 
 
537
  <!-- For translations: uncomment this:
 
538
 
 
539
  <para>
 
540
   Latin translation was done by ME
 
541
   (<email>MYNAME@MYADDRESS</email>). Please send all  comments  and
 
542
   suggestions regarding this translation to SOMEWHERE.
 
543
  </para>
 
544
 
 
545
  -->
 
546
 
 
547
 </sect1>
 
548
 
 
549
 
 
550
 <!-- ============= Application License ============================= -->
 
551
 
 
552
 <sect1 id="license">
 
553
  <title>License</title>
 
554
  <para>
 
555
   This program is free software; you can redistribute it and/or
 
556
   modify it under the terms of the  <ulink type="help" url="gnome-help:gpl">
 
557
    <citetitle>GNU General Public License</citetitle></ulink> as
 
558
   published by the Free Software Foundation; 
 
559
   either version 2 of the License, or (at your option) any later
 
560
   version.
 
561
  </para>
 
562
  <para>
 
563
   This program is distributed in the hope that it will be useful, but
 
564
   WITHOUT ANY WARRANTY; without even the implied warranty of
 
565
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
566
   <citetitle>GNU General Public License</citetitle> for more details.
 
567
  </para>
 
568
  <para>
 
569
   A copy of the <citetitle>GNU General Public License</citetitle> is
 
570
   included as an appendix to the <citetitle>GNOME Users
 
571
   Guide</citetitle>.  You may also obtain a copy of the
 
572
   <citetitle>GNU General Public License</citetitle> from the Free
 
573
   Software Foundation by visiting <ulink type="http"
 
574
   url="http://www.fsf.org">their Web site</ulink> or by writing to
 
575
   <address>
 
576
    Free Software Foundation, Inc.
 
577
    <street>59 Temple Place</street> - Suite 330
 
578
    <city>Boston</city>, <state>MA</state> <postcode>02111-1307</postcode>
 
579
    <country>USA</country>
 
580
   </address>
 
581
  </para>
 
582
 </sect1>
 
583
</article>
 
584
 
 
585
 
 
586
 
 
587