new alpha versions
[xboard.git] / manual / xboard.txt
1 INFO-DIR-SECTION Games
2 START-INFO-DIR-ENTRY
3 * xboard: (xboard).         An X Window System graphical chessboard.
4 END-INFO-DIR-ENTRY
5
6 Introduction
7 ************
8
9 XBoard is a graphical chessboard that can serve as a user interface to
10 chess engines (such as GNU Chess), the Internet Chess Servers,
11 electronic mail correspondence chess, or your own collection of saved
12 games.
13
14    This manual documents version 4.4.0j of XBoard.
15
16 1 Major modes
17 *************
18
19 XBoard always runs in one of four major modes.  You select the major
20 mode from the command line when you start up XBoard.
21
22 xboard [options]
23      As an interface to GNU Chess or another chess engine running on
24      your machine, XBoard lets you play a game against the machine, set
25      up arbitrary positions, force variations, watch a game between two
26      chess engines, interactively analyze your stored games or set up
27      and analyze arbitrary positions.  (Note: Not all chess engines
28      support analysis.)
29
30 xboard -ics -icshost hostname [options]
31      As Internet Chess Server (ICS) interface, XBoard lets you play
32      against other ICS users, observe games they are playing, or review
33      games that have recently finished.  Most of the ICS "wild" chess
34      variants are supported, including bughouse.
35
36 xboard -ncp [options]
37      XBoard can also be used simply as an electronic chessboard to play
38      through games. It will read and write game files and allow you to
39      play through variations manually. You can use it to browse games
40      off the net or review games you have saved.  These features are
41      also available in the other modes.
42
43 |pxboard
44      If you want to pipe games into XBoard, use the supplied shell
45      script `pxboard'.  For example, from the news reader `xrn', find a
46      message with one or more games in it, click the Save button, and
47      type `|pxboard' as the file name.
48
49 cmail [options]
50      As an interface to electronic mail correspondence chess, XBoard
51      works with the cmail program. See *note CMail:: below for
52      instructions.
53
54 2 Menus, buttons, and keys
55 **************************
56
57 To move a piece, you can drag it with the left mouse button, or you can
58 click the left mouse button once on the piece, then once more on the
59 destination square.  To drop a new piece on a square (when applicable),
60 press the middle or the right mouse button over the square and select
61 from the pop-up menu.  In cases where you can drop either a white or
62 black piece, use the middle button (or shift+right) for white and the
63 right button (or shift+middle) for black.  When you are playing a
64 bughouse game on an Internet Chess Server, a list of the off-board
65 pieces that each player has available is shown in the window title
66 after the player's name; in addition, the piece menus show the number
67 of pieces available of each type. From version 4.3.14 on, it is also
68 possible in crazyhouse, bughouse or shogi to dag and drop pieces to the
69 board from the holdings squares displayed next to the board.
70
71    All other XBoard commands are available from the menu bar. The most
72 frequently used commands also have shortcut keys or on-screen buttons.
73
74    When XBoard is iconized, its graphical icon is a white knight if it
75 is White's turn to move, a black knight if it is Black's turn.  See
76 Iconize in *note Keys:: below if you have problems getting this feature
77 to work.
78
79 2.1 File Menu
80 =============
81
82 New Game
83      Resets XBoard and the chess engine to the beginning of a new chess
84      game. The `r' key is a keyboard equivalent. In Internet Chess
85      Server mode, clears the current state of XBoard, then
86      resynchronizes with the ICS by sending a refresh command. If you
87      want to stop playing, observing, or examining an ICS game, use an
88      appropriate command from the Action menu, not `New Game'.  *Note
89      Action Menu::.
90
91 New Shuffle Game
92      Similar to `New Game', but allows you to specify a particular
93      initial position (according to a standardized numbering system) in
94      chess variants which use randomized opening positions (e.g.
95      Chess960).  The selected opening position will persistently be
96      chosen on any following New Game command until you use this menu
97      to select another. Selecting position number -1 will produce a
98      newly randomized position on any new game.  Using this menu item
99      in variants that normally do not shuffle their opening position
100      does cause these variants to become shuffle variants until you use
101      the `New Shuffle Game' menu to explicitly switch the randomization
102      off, or select a new variant.
103
104 New Variant
105      Allows you to select a new chess variant in non-ICS mode.  (In ICS
106      play, the ICS is responsible for deciding which variant will be
107      played, and XBoard adapts automatically.) If you play with an
108      engine, the engine must be able to play the selected variant, or
109      the command will be ignored.  XBoard supports all major variants,
110      such as xiangqi, shogi, chess, chess960, Capablanca Chess,
111      shatranj, crazyhouse, bughouse.  (But not every board size has
112      built-in bitmaps for un-orthodox pieces!)
113
114 Load Game
115      Plays a game from a record file. The `g' key is a keyboard
116      equivalent.  A pop-up dialog prompts you for the file name. If the
117      file contains more than one game, a second pop-up dialog displays
118      a list of games (with information drawn from their PGN tags, if
119      any), and you can select the one you want. Alternatively, you can
120      load the Nth game in the file directly, by typing the number `N'
121      after the file name, separated by a space.
122
123      The game file parser will accept PGN (portable game notation), or
124      in fact almost any file that contains moves in algebraic notation.
125      Notation of the form `P@f7' is accepted for piece-drops in
126      bughouse games; this is a nonstandard extension to PGN.  If the
127      file includes a PGN position (FEN tag), or an old-style XBoard
128      position diagram bracketed by `[--' and `--]' before the first
129      move, the game starts from that position. Text enclosed in
130      parentheses, square brackets, or curly braces is assumed to be
131      commentary and is displayed in a pop-up window. Any other text in
132      the file is ignored. PGN variations (enclosed in parentheses) are
133      treated as comments; XBoard is not able to walk variation trees.
134      The nonstandard PGN tag [Variant "varname"] functions similarly to
135      the -variant command-line option (see below), allowing games in
136      certain chess variants to be loaded.  There is also a heuristic to
137      recognize chess variants from the Event tag, by looking for the
138      strings that the Internet Chess Servers put there when saving
139      variant ("wild") games.
140
141 Load Next Game
142      Loads the next game from the last game record file you loaded.
143      The shifted `N' key is a keyboard equivalent.
144
145 Load Previous Game
146      Loads the previous game from the last game record file you loaded.
147      The shifted `P' key is a keyboard equivalent.  Not available if
148      the last game was loaded from a pipe.
149
150 Reload Same Game
151      Reloads the last game you loaded.  Not available if the last game
152      was loaded from a pipe.
153
154 Save Game
155      Appends a record of the current game to a file.  A pop-up dialog
156      prompts you for the file name. If the game did not begin with the
157      standard starting position, the game file includes the starting
158      position used. Games are saved in the PGN (portable game notation)
159      format, unless the oldSaveStyle option is true, in which case they
160      are saved in an older format that is specific to XBoard. Both
161      formats are human-readable, and both can be read back by the `Load
162      Game' command.  Notation of the form `P@f7' is accepted for
163      piece-drops in bughouse games; this is a nonstandard extension to
164      PGN.
165
166 Copy Game
167      Copies a record of the current game to an internal clipboard in PGN
168      format and sets the X selection to the game text.  The game can be
169      pasted to another application (such as a text editor or another
170      copy of XBoard) using that application's paste command.  In many X
171      applications, such as xterm and emacs, the middle mouse button can
172      be used for pasting; in XBoard, you must use the Paste Game
173      command.
174
175 Paste Game
176      Interprets the current X selection as a game record and loads it,
177      as with Load Game.
178
179 Load Position
180      Sets up a position from a position file.  A pop-up dialog prompts
181      you for the file name. If the file contains more than one saved
182      position, and you want to load the Nth one, type the number N
183      after the file name, separated by a space. Position files must be
184      in FEN (Forsythe-Edwards notation), or in the format that the Save
185      Position command writes when oldSaveStyle is turned on.
186
187 Load Next Position
188      Loads the next position from the last position file you loaded.
189
190 Load Previous Position
191      Loads the previous position from the last position file you
192      loaded.  Not available if the last position was loaded from a pipe.
193
194 Reload Same Position
195      Reloads the last position you loaded.  Not available if the last
196      position was loaded from a pipe.
197
198 Save Position
199      Appends a diagram of the current position to a file.  A pop-up
200      dialog prompts you for the file name. Positions are saved in FEN
201      (Forsythe-Edwards notation) format unless the `oldSaveStyle'
202      option is true, in which case they are saved in an older,
203      human-readable format that is specific to XBoard. Both formats can
204      be read back by the `Load Position' command.
205
206 Copy Position
207      Copies the current position to an internal clipboard in FEN format
208      and sets the X selection to the position text.  The position can
209      be pasted to another application (such as a text editor or another
210      copy of XBoard) using that application's paste command.  In many X
211      applications, such as xterm and emacs, the middle mouse button can
212      be used for pasting; in XBoard, you must use the Paste Position
213      command.
214
215 Paste Position
216      Interprets the current X selection as a FEN position and loads it,
217      as with Load Position.
218
219 Mail Move
220 Reload CMail Message
221      See *note CMail::.
222
223 Exit
224      Exits from XBoard. The shifted `Q' key is a keyboard equivalent.
225
226 2.2 Mode Menu
227 =============
228
229 Machine White
230      Tells the chess engine to play White.
231
232 Machine Black
233      Tells the chess engine to play Black.
234
235 Two Machines
236      Plays a game between two chess engines.
237
238 Analysis Mode
239      XBoard tells the chess engine to start analyzing the current
240      game/position and shows you the analysis as you move pieces around.
241      Note: Some chess engines do not support Analysis mode.
242
243      To set up a position to analyze, you do the following:
244
245      1. Select Edit Position from the Mode Menu
246
247      2. Set up the position.  Use the middle and right buttons to bring
248      up the white and black piece menus.
249
250      3. When you are finished, click on either the Black or White clock
251      to tell XBoard which side moves first.
252
253      4. Select Analysis Mode from the Mode Menu to start the analysis.
254
255      The analysis function can also be used when observing games on an
256      ICS with an engine loaded (zippy mode); the engine then will
257      analyse the positions as they occur in the observed game.
258
259 Analyze File
260      This option lets you load a game from a file (PGN, XBoard format,
261      etc.)  and analyze it. When you select this menu item, a pop-up
262      window appears and asks for a file name to load.  If the file
263      contains multiple games, another pop up appears that lets you
264      select which game you wish to analyze.  After a game is loaded,
265      use the XBoard arrow buttons to step forwards/backwards through
266      the game and watch the analysis.  Note: Some chess engines do not
267      support Analysis mode.
268
269 ICS Client
270      This is the normal mode when XBoard is connected to a chess
271      server.  If you have moved into Edit Game or Edit Position mode,
272      you can select this option to get out.
273
274      To use xboard in ICS mode, run it in the foreground with the -ics
275      option, and use the terminal you started it from to type commands
276      and receive text responses from the chess server.  See *note Chess
277      Servers:: below for more information.
278
279      XBoard activates some special position/game editing features when
280      you use the `examine' or `bsetup' commands on ICS and you have
281      `ICS Client' selected on the Mode menu.  First, you can issue the
282      ICS position-editing commands with the mouse.  Move pieces by
283      dragging with mouse button 1.  To drop a new piece on a square,
284      press mouse button 2 or 3 over the square.  This brings up a menu
285      of white pieces (button 2) or black pieces (button 3).  Additional
286      menu choices let you empty the square or clear the board.  Click
287      on the White or Black clock to set the side to play.  You cannot
288      set the side to play or drag pieces to arbitrary squares while
289      examining on ICC, but you can do so in `bsetup' mode on FICS.  In
290      addition, the menu commands `Forward', `Backward', `Pause', and
291      `Stop Examining' have special functions in this mode; see below.
292
293 Edit Game
294      Allows you to make moves for both Black and White, and to change
295      moves after backing up with the `Backward' command. The clocks do
296      not run.
297
298      In chess engine mode, the chess engine continues to check moves
299      for legality but does not participate in the game. You can bring
300      the chess engine into the game by selecting `Machine White',
301      `Machine Black', or `Two Machines'.
302
303      In ICS mode, the moves are not sent to the ICS: `Edit Game' takes
304      XBoard out of ICS Client mode and lets you edit games locally.  If
305      you want to edit games on ICS in a way that other ICS users can
306      see, use the ICS `examine' command or start an ICS match against
307      yourself.
308
309 Edit Position
310      Lets you set up an arbitrary board position.  Use mouse button 1
311      to drag pieces to new squares, or to delete a piece by dragging it
312      off the board or dragging an empty square on top of it.  To drop a
313      new piece on a square, press mouse button 2 or 3 over the square.
314      This brings up a menu of white pieces (button 2) or black pieces
315      (button 3). Additional menu choices let you empty the square or
316      clear the board. You can set the side to play next by clicking on
317      the word White or Black at the top of the screen.  Selecting `Edit
318      Position' causes XBoard to discard all remembered moves in the
319      current game.
320
321      In ICS mode, changes made to the position by `Edit Position' are
322      not sent to the ICS: `Edit Position' takes XBoard out of `ICS
323      Client' mode and lets you edit positions locally. If you want to
324      edit positions on ICS in a way that other ICS users can see, use
325      the ICS `examine' command, or start an ICS match against yourself.
326      (See also the ICS Client topic above.)
327
328 Training
329      Training mode lets you interactively guess the moves of a game for
330      one of the players. You guess the next move of the game by playing
331      the move on the board. If the move played matches the next move of
332      the game, the move is accepted and the opponent's response is
333      auto-played.  If the move played is incorrect, an error message is
334      displayed.  You can select this mode only while loading a game
335      (that is, after selecting `Load Game' from the File menu).  While
336      XBoard is in `Training' mode, the navigation buttons are disabled.
337
338 Show Game List
339      Shows or hides the list of games generated by the last `Load Game'
340      command.
341
342 Show Move History
343      Shows or hides a list of moves of the current game.  This list
344      allows you to move the display to any earlier position in the game
345      by clicking on the corresponding move.
346
347 Show Engine Output
348      Shows or hides a window in which the thinking output of any loaded
349      engines is displayed.
350
351 Edit Tags
352      Lets you edit the PGN (portable game notation) tags for the
353      current game. After editing, the tags must still conform to the
354      PGN tag syntax:
355
356           <tag-section> ::= <tag-pair> <tag-section>
357                                   <empty>
358           <tag-pair> ::= [ <tag-name> <tag-value> ]
359           <tag-name> ::= <identifier>
360           <tag-value> ::= <string>
361      See the PGN Standard for full details. Here is an example:
362
363           [Event "Portoroz Interzonal"]
364           [Site "Portoroz, Yugoslavia"]
365           [Date "1958.08.16"]
366           [Round "8"]
367           [White "Robert J. Fischer"]
368           [Black "Bent Larsen"]
369           [Result "1-0"]
370      Any characters that do not match this syntax are silently ignored.
371      Note that the PGN standard requires all games to have at least the
372      seven tags shown above. Any that you omit will be filled in by
373      XBoard with `?' (unknown value), or `-' (inapplicable value).
374
375 Edit Comment
376      Adds or modifies a comment on the current position. Comments are
377      saved by `Save Game' and are displayed by `Load Game', `Forward',
378      and `Backward'.
379
380 ICS Input Box
381      If this option is set in ICS mode, XBoard creates an extra window
382      that you can use for typing in ICS commands.  The input box is
383      especially useful if you want to type in something long or do some
384      editing on your input, because output from ICS doesn't get mixed
385      in with your typing as it would in the main terminal window.
386
387 Pause
388      Pauses updates to the board, and if you are playing against a
389      chess engine, also pauses your clock. To continue, select `Pause'
390      again, and the display will automatically update to the latest
391      position.  The `P' button and keyboard `p' key are equivalents.
392
393      If you select Pause when you are playing against a chess engine and
394      it is not your move, the chess engine's clock will continue to run
395      and it will eventually make a move, at which point both clocks
396      will stop. Since board updates are paused, however, you will not
397      see the move until you exit from Pause mode (or select Forward).
398      This behavior is meant to simulate adjournment with a sealed move.
399
400      If you select Pause while you are observing or examining a game on
401      a chess server, you can step backward and forward in the current
402      history of the examined game without affecting the other observers
403      and examiners, and without having your display jump forward to the
404      latest position each time a move is made. Select Pause again to
405      reconnect yourself to the current state of the game on ICS.
406
407      If you select `Pause' while you are loading a game, the game stops
408      loading. You can load more moves manually by selecting `Forward',
409      or resume automatic loading by selecting `Pause' again.
410
411 2.3 Action Menu
412 ===============
413
414 Accept
415      Accepts a pending match offer. If there is more than one offer
416      pending, you will have to type in a more specific command instead
417      of using this menu choice.
418
419 Decline
420      Declines a pending offer (match, draw, adjourn, etc.). If there is
421      more than one offer pending, you will have to type in a more
422      specific command instead of using this menu choice.
423
424 Call Flag
425      Calls your opponent's flag, claiming a win on time, or claiming a
426      draw if you are both out of time. You can also call your
427      opponent's flag by clicking on his clock or by pressing the
428      keyboard `t' key.
429
430 Draw
431      Offers a draw to your opponent, accepts a pending draw offer from
432      your opponent, or claims a draw by repetition or the 50-move rule,
433      as appropriate. The `d' key is a keyboard equivalent.
434
435 Adjourn
436      Asks your opponent to agree to adjourning the current game, or
437      agrees to a pending adjournment offer from your opponent.
438
439 Abort
440      Asks your opponent to agree to aborting the current game, or
441      agrees to a pending abort offer from your opponent. An aborted
442      game ends immediately without affecting either player's rating.
443
444 Resign
445      Resigns the game to your opponent. The shifted `R' key is a
446      keyboard equivalent.
447
448 Stop Observing
449      Ends your participation in observing a game, by issuing the ICS
450      observe command with no arguments. ICS mode only.
451
452 Stop Examining
453      Ends your participation in examining a game, by issuing the ICS
454      unexamine command. ICS mode only.
455
456 Adjudicate to White
457 Adjudicate to Black
458 Adjudicate Draw
459      Terminate an ongoing game in Two-Machines mode (including match
460      mode), with as result a win for white, for black, or a draw,
461      respectively.  The PGN file of the game will accompany the result
462      string by the comment "user adjudication".
463
464 2.4 Step Menu
465 =============
466
467 Backward
468      Steps backward through a series of remembered moves.  The `[<]'
469      button and the `b' key are equivalents, as is turning the mouse
470      wheel towards you.  In addition, pressing the Control key steps
471      back one move, and releasing it steps forward again.
472
473      In most modes, `Backward' only lets you look back at old positions;
474      it does not retract moves. This is the case if you are playing
475      against a chess engine, playing or observing a game on an ICS, or
476      loading a game.  If you select `Backward' in any of these
477      situations, you will not be allowed to make a different move. Use
478      `Retract Move' or `Edit Game' if you want to change past moves.
479
480      If you are examining an ICS game, the behavior of `Backward'
481      depends on whether XBoard is in Pause mode. If Pause mode is off,
482      `Backward' issues the ICS backward command, which backs up
483      everyone's view of the game and allows you to make a different
484      move. If Pause mode is on, `Backward' only backs up your local
485      view.
486
487 Forward
488      Steps forward through a series of remembered moves (undoing the
489      effect of `Backward') or forward through a game file. The `[>]'
490      button and the `f' key are equivalents, as is turning the mouse
491      wheel away from you.
492
493      If you are examining an ICS game, the behavior of Forward depends
494      on whether XBoard is in Pause mode. If Pause mode is off,
495      `Forward' issues the ICS forward command, which moves everyone's
496      view of the game forward along the current line. If Pause mode is
497      on, `Forward' only moves your local view forward, and it will not
498      go past the position that the game was in when you paused.
499
500 Back to Start
501      Jumps backward to the first remembered position in the game.  The
502      `[<<]' button and the shifted `B' key are equivalents.
503
504      In most modes, Back to Start only lets you look back at old
505      positions; it does not retract moves. This is the case if you are
506      playing against a local chess engine, playing or observing a game
507      on a chess server, or loading a game. If you select `Back to
508      Start' in any of these situations, you will not be allowed to make
509      different moves. Use `Retract Move' or `Edit Game' if you want to
510      change past moves; or use Reset to start a new game.
511
512      If you are examining an ICS game, the behavior of `Back to Start'
513      depends on whether XBoard is in Pause mode. If Pause mode is off,
514      `Back to Start' issues the ICS `backward 999999' command, which
515      backs up everyone's view of the game to the start and allows you
516      to make different moves. If Pause mode is on, `Back to Start' only
517      backs up your local view.
518
519 Forward to End
520      Jumps forward to the last remembered position in the game. The
521      `[>>]' button and the shifted `F' key are equivalents.
522
523      If you are examining an ICS game, the behavior of `Forward to End'
524      depends on whether XBoard is in Pause mode. If Pause mode is off,
525      `Forward to End' issues the ICS `forward 999999' command, which
526      moves everyone's view of the game forward to the end of the
527      current line. If Pause mode is on, `Forward to End' only moves
528      your local view forward, and it will not go past the position that
529      the game was in when you paused.
530
531 Revert
532      If you are examining an ICS game and Pause mode is off, issues the
533      ICS command `revert'.
534
535 Truncate Game
536      Discards all remembered moves of the game beyond the current
537      position. Puts XBoard into `Edit Game' mode if it was not there
538      already.
539
540 Move Now
541      Forces the chess engine to move immediately. Chess engine mode
542      only.
543
544 Retract Move
545      Retracts your last move. In chess engine mode, you can do this only
546      after the chess engine has replied to your move; if the chess
547      engine is still thinking, use `Move Now' first. In ICS mode,
548      `Retract Move' issues the command `takeback 1' or `takeback 2'
549      depending on whether it is your opponent's move or yours.
550
551 2.5 Options Menu
552 ================
553
554 Flip View
555      Inverts your view of the chess board for the duration of the
556      current game. Starting a new game returns the board to normal.
557      The `v' key is a keyboard equivalent.
558
559 Adjudications
560      Pops up a sub-menu where you can enable or disable various
561      adjudications that XBoard can perform in engine-engine games.  You
562      can instruct XBoard to detect and terminate the game on checkmate
563      or stalemate, even if the engines would not do so, to verify engine
564      result claims (forfeiting engines that make false claims), rather
565      than naively following the engine, to declare draw on positions
566      which can never be won for lack of mating material, (e.g. KBK), or
567      which are impossible to win unless the opponent seeks its own
568      demise (e.g. KBKN).  For these adjudications to work, `Test
569      Legality' should be switched on.  It is also possible to instruct
570      XBoard to enforce a 50-move or 3-fold-repeat rule and
571      automatically declare draw (after a user-adjustable number of moves
572      or repeats) even if the engines are prepared to go on.  It is also
573      possible to have XBoard declare draw on games that seem to drag on
574      forever, or adjudicate a loss if both engines agree (for 3
575      consecutive moves) that one of them is behind more than a
576      user-adjustable score threshold.  For the latter adjudication to
577      work, XBoard should be able to properly understand the engine's
578      scores. To facilitate the latter, you can inform xboard here if
579      the engines report scores from the viewpoint of white, or from
580      that of their own color.
581
582 Engine Settings
583      Pops up a sub-menu where you can set some engine parameters common
584      to most engines, such as hash-table size, tablebase cache size,
585      maximum number of processors that SMP engines can use, and where
586      to find the Polyglot adapter needed to run UCI engines under
587      XBoard. The feature that allows setting of these parameters on
588      engines is new since XBoard 4.3.15, so not many WinBoard engines
589      respond to it yet, but UCI engines should.  It is also possible to
590      specify a GUI opening book here, i.e. an opening book that XBoard
591      consults for any position a playing engine gets in.  It then
592      forces the engine to play the book move, rather than to think up
593      its own, if that position is found in the book.  The book can
594      switched on and off independently for either engine.
595
596 Time Control
597      Pops up a sub-menu where you can set the time-control parameters
598      interactively.  Allows you to select classical or incremental time
599      controls, set the moves per session, session duration, and time
600      increment.  Also allows specification of time-odds factors for one
601      or both engines.  If an engine is given a time-odds factor N, all
602      time quota it gets, be it at the beginning of a session or through
603      the time increment or fixed time per move, will be divided by N.
604
605 Always Queen
606      If this option is off, XBoard brings up a dialog box whenever you
607      move a pawn to the last rank, asking what piece you want to
608      promote it to. If the option is true, your pawns are always
609      promoted to queens. Your opponent can still under-promote.
610
611 Animate Dragging
612      If Animate Dragging is on, while you are dragging a piece with the
613      mouse, an image of the piece follows the mouse cursor.  If Animate
614      Dragging is off, there is no visual feedback while you are
615      dragging a piece, but if Animate Moving is on, the move will be
616      animated when it is complete.
617
618 Animate Moving
619      If Animate Moving is on, all piece moves are animated.  An image
620      of the piece is shown moving from the old square to the new square
621      when the move is completed (unless the move was already animated
622      by Animate Dragging).  If Animate Moving is off, a moved piece
623      instantly disappears from its old square and reappears on its new
624      square when the move is complete.
625
626 Auto Comment
627      If this option is on, any remarks made on ICS while you are
628      observing or playing a game are recorded as a comment on the
629      current move.  This includes remarks made with the ICS commands
630      `say', `tell', `whisper', and `kibitz'.  Limitation: remarks that
631      you type yourself are not recognized; XBoard scans only the output
632      from ICS, not the input you type to it.
633
634 Auto Flag
635      If this option is on and one player runs out of time before the
636      other, XBoard will automatically call his flag, claiming a win on
637      time.  In ICS mode, Auto Flag will only call your opponent's flag,
638      not yours, and the ICS may award you a draw instead of a win if
639      you have insufficient mating material.  In local chess engine mode,
640      XBoard may call either player's flag and will not take material
641      into account.
642
643 Auto Flip View
644      If the Auto Flip View option is on when you start a game, the board
645      will be automatically oriented so that your pawns move from the
646      bottom of the window towards the top.
647
648 Auto Observe
649      If this option is on and you add a player to your `gnotify' list
650      on ICS, XBoard will automatically observe all of that player's
651      games, unless you are doing something else (such as observing or
652      playing a game of your own) when one starts.  The games are
653      displayed from the point of view of the player on your gnotify
654      list; that is, his pawns move from the bottom of the window
655      towards the top.  Exceptions:  If both players in a game are on
656      your gnotify list, if your ICS `highlight' variable is set to 0,
657      or if the ICS you are using does not properly support observing
658      from Black's point of view, you will see the game from White's
659      point of view.
660
661 Auto Raise Board
662      If this option is on, whenever a new game begins, the chessboard
663      window is deiconized (if necessary) and raised to the top of the
664      stack of windows.
665
666 Auto Save
667      If this option is true, at the end of every game XBoard prompts
668      you for a file name and appends a record of the game to the file
669      you specify.  Disabled if the `saveGameFile' command-line option
670      is set, as in that case all games are saved to the specified file.
671      *Note Load and Save options::.
672
673 Blindfold
674      If this option is on, XBoard displays the board as usual but does
675      not display pieces or move highlights.  You can still move in the
676      usual way (with the mouse or by typing moves in ICS mode), even
677      though the pieces are invisible.
678
679 Flash Moves
680      If this option is on, whenever a move is completed, the moved
681      piece flashes.  The number of times to flash is set by the
682      flashCount command-line option; it defaults to 3 if Flash Moves is
683      first turned on from the menu.
684
685      If you are playing a game on an ICS, the board is always oriented
686      at the start of the game so that your pawns move from the bottom
687      of the window towards the top. Otherwise, the starting orientation
688      is determined by the `flipView' command line option; if it is
689      false (the default), White's pawns move from bottom to top at the
690      start of each game; if it is true, Black's pawns move from bottom
691      to top. *Note User interface options::.
692
693 Get Move List
694      If this option is on, whenever XBoard receives the first board of
695      a new ICS game (or a different game from the one it is currently
696      displaying), it retrieves the list of past moves from the ICS.
697      You can then review the moves with the `Forward' and `Backward'
698      commands or save them with `Save Game'.  You might want to turn
699      off this option if you are observing several blitz games at once,
700      to keep from wasting time and network bandwidth fetching the move
701      lists over and over.  When you turn this option on from the menu,
702      XBoard immediately fetches the move list of the current game (if
703      any).
704
705 Highlight Last Move
706      If Highlight Last Move is on, after a move is made, the starting
707      and ending squares remain highlighted. In addition, after you use
708      Backward or Back to Start, the starting and ending squares of the
709      last move to be unmade are highlighted.
710
711 Move Sound
712      If this option is on, XBoard alerts you by playing a sound after
713      each of your opponent's moves (or after every move if you are
714      observing a game on the Internet Chess Server).  The sound is not
715      played after moves you make or moves read from a saved game file.
716      By default, the sound is the terminal bell, but on some systems
717      you can change it to a sound file using the soundMove option; see
718      below.
719
720      If you turn on this option when using XBoard with the Internet
721      Chess Server, you will probably want to give the `set bell 0'
722      command to the ICS, since otherwise the ICS will ring the terminal
723      bell after every move (not just yours). (The `.icsrc' file is a
724      good place for this; see *note ICS options::.)
725
726 ICS Alarm
727      When this option is on, an alarm sound is played when your clock
728      counts down to the icsAlarmTime (by default, 5 seconds) in an ICS
729      game.  For games with time controls that include an increment, the
730      alarm will sound each time the clock counts down to the
731      icsAlarmTime.  By default, the alarm sound is the terminal bell,
732      but on some systems you can change it to a sound file using the
733      soundIcsAlarm option; see below.
734
735 Old Save Style
736      If this option is off, XBoard saves games in PGN (portable game
737      notation) and positions in FEN (Forsythe-Edwards notation).  If
738      the option is on, a save style that is compatible with older
739      versions of XBoard is used instead.  The old position style is
740      more human-readable than FEN; the old game style has no particular
741      advantages.
742
743 Periodic Updates
744      If this option is off (or if you are using a chess engine that
745      does not support periodic updates), the analysis window will only
746      be updated when the analysis changes. If this option is on, the
747      Analysis Window will be updated every two seconds.
748
749 Ponder Next Move
750      If this option is off, the chess engine will think only when it is
751      on move.  If the option is on, the engine will also think while
752      waiting for you to make your move.
753
754 Popup Exit Message
755      If this option is on, when XBoard wants to display a message just
756      before exiting, it brings up a modal dialog box and waits for you
757      to click OK before exiting.  If the option is off, XBoard prints
758      the message to standard error (the terminal) and exits immediately.
759
760 Popup Move Errors
761      If this option is off, when you make an error in moving (such as
762      attempting an illegal move or moving the wrong color piece), the
763      error message is displayed in the message area.  If the option is
764      on, move errors are displayed in small pop-up windows like other
765      errors.  You can dismiss an error pop-up either by clicking its OK
766      button or by clicking anywhere on the board, including
767      down-clicking to start a move.
768
769 Premove
770      If this option is on while playing a game on an ICS, you can
771      register your next planned move before it is your turn.  Move the
772      piece with the mouse in the ordinary way, and the starting and
773      ending squares will be highlighted with a special color (red by
774      default).  When it is your turn, if your registered move is legal,
775      XBoard will send it to ICS immediately; if not, it will be ignored
776      and you can make a different move.  If you change your mind about
777      your premove, either make a different move, or double-click on any
778      piece to cancel the move entirely.
779
780 Quiet Play
781      If this option is on, XBoard will automatically issue an ICS `set
782      shout 0' command whenever you start a game and a `set shout 1'
783      command whenever you finish one.  Thus, you will not be distracted
784      by shouts from other ICS users while playing.
785
786 Show Coords
787      If this option is on, XBoard displays algebraic coordinates along
788      the board's left and bottom edges.
789
790 Hide Thinking
791      If this option is off, the chess engine's notion of the score and
792      best line of play from the current position is displayed as it is
793      thinking. The score indicates how many pawns ahead (or if negative,
794      behind) the chess engine thinks it is. In matches between two
795      machines, the score is prefixed by `W' or `B' to indicate whether
796      it is showing White's thinking or Black's, and only the thinking
797      of the engine that is on move is shown.
798
799 Test Legality
800      If this option is on, XBoard tests whether the moves you try to
801      make with the mouse are legal and refuses to let you make an
802      illegal move.  Moves loaded from a file with `Load Game' are also
803      checked.  If the option is off, all moves are accepted, but if a
804      local chess engine or the ICS is active, they will still reject
805      illegal moves.  Turning off this option is useful if you are
806      playing a chess variant with rules that XBoard does not
807      understand.  (Bughouse, suicide, and wild variants where the king
808      may castle after starting on the d file are generally supported
809      with Test Legality on.)
810
811 2.6 Help Menu
812 =============
813
814 Info XBoard
815      Displays the XBoard documentation in info format.  For this
816      feature to work, you must have the GNU info program installed on
817      your system, and the file `xboard.info' must either be present in
818      the current working directory, or have been installed by the `make
819      install' command when you built XBoard.
820
821 Man XBoard
822      Displays the XBoard documentation in man page format.  For this
823      feature to work, the file `xboard.6' must have been installed by
824      the `make install' command when you built XBoard, and the
825      directory it was placed in must be on the search path for your
826      system's `man' command.
827
828 Hint
829      Displays a move hint from the chess engine.
830
831 Book
832      Displays a list of possible moves from the chess engine's opening
833      book.  The exact format depends on what chess engine you are using.
834      With GNU Chess 4, the first column gives moves, the second column
835      gives one possible response for each move, and the third column
836      shows the number of lines in the book that include the move from
837      the first column. If you select this option and nothing happens,
838      the chess engine is out of its book or does not support this
839      feature.
840
841 About XBoard
842      Shows the current XBoard version number.
843
844 2.7 Other Shortcut Keys
845 =======================
846
847 Iconize
848      Pressing the `i' or `c' key iconizes XBoard. The graphical icon
849      displays a white knight if it is White's move, or a black knight
850      if it is Black's move. If your X window manager displays only text
851      icons, not graphical ones, check its documentation; there is
852      probably a way to enable graphical icons.  If you get black and
853      white reversed, we would like to hear about it; see *note
854      Problems:: below for instructions on how to report this problem.
855
856    You can add or remove shortcut keys using the X resources
857 `form.translations'. Here is an example of what would go in your
858 `.Xresources' file:
859
860      XBoard*form.translations: \
861        Shift<Key>?: AboutGameProc() \n\
862        <Key>y: AcceptProc() \n\
863        <Key>n: DeclineProc() \n\
864        <Key>i: NothingProc()
865    Binding a key to `NothingProc' makes it do nothing, thus removing it
866 as a shortcut key. The XBoard commands that can be bound to keys are:
867
868      AbortProc, AboutGameProc, AboutProc, AcceptProc, AdjournProc,
869      AlwaysQueenProc, AnalysisModeProc, AnalyzeFileProc,
870      AnimateDraggingProc, AnimateMovingProc, AutobsProc, AutoflagProc,
871      AutoflipProc, AutoraiseProc, AutosaveProc, BackwardProc,
872      BlindfoldProc, BookProc, CallFlagProc, CopyGameProc, CopyPositionProc,
873      DebugProc, DeclineProc, DrawProc, EditCommentProc, EditGameProc,
874      EditPositionProc, EditTagsProc, EnterKeyProc, FlashMovesProc,
875      FlipViewProc, ForwardProc, GetMoveListProc, HighlightLastMoveProc,
876      HintProc, Iconify, IcsAlarmProc, IcsClientProc, IcsInputBoxProc,
877      InfoProc, LoadGameProc, LoadNextGameProc, LoadNextPositionProc,
878      LoadPositionProc, LoadPrevGameProc, LoadPrevPositionProc,
879      LoadSelectedProc, MachineBlackProc, MachineWhiteProc, MailMoveProc,
880      ManProc, MoveNowProc, MoveSoundProc, NothingProc, OldSaveStyleProc,
881      PasteGameProc, PastePositionProc, PauseProc, PeriodicUpdatesProc,
882      PonderNextMoveProc, PopupExitMessageProc, PopupMoveErrorsProc,
883      PremoveProc, QuietPlayProc, QuitProc, ReloadCmailMsgProc,
884      ReloadGameProc, ReloadPositionProc, RematchProc, ResetProc,
885      ResignProc, RetractMoveProc, RevertProc, SaveGameProc,
886      SavePositionProc, ShowCoordsProc, ShowGameListProc, ShowThinkingProc,
887      StopExaminingProc, StopObservingProc, TestLegalityProc, ToEndProc,
888      ToStartProc, TrainingProc, TruncateGameProc, and TwoMachinesProc.
889
890 3 Options
891 *********
892
893 This section documents the command-line options to XBoard.  You can set
894 these options in two ways: by typing them on the shell command line you
895 use to start XBoard, or by setting them as X resources (typically in
896 your `.Xresources' file).  Many of the options cannot be changed while
897 XBoard is running; others set the initial state of items that can be
898 changed with the *note Options:: menu.
899
900    Most of the options have both a long name and a short name. To turn a
901 boolean option on or off from the command line, either give its long
902 name followed by the value true or false (`-longOptionName true'), or
903 give just the short name to turn the option on (`-opt'), or the short
904 name preceded by `x' to turn the option off (`-xopt'). For options that
905 take strings or numbers as values, you can use the long or short option
906 names interchangeably.
907
908    Each option corresponds to an X resource with the same name, so if
909 you like, you can set options in your `.Xresources' file or in a file
910 named `XBoard' in your home directory.  For options that have two
911 names, the longer one is the name of the corresponding X resource; the
912 short name is not recognized.  To turn a boolean option on or off as an
913 X resource, give its long name followed by the value true or false
914 (`XBoard*longOptionName: true').
915
916 3.1 Chess Engine Options
917 ========================
918
919 -tc or -timeControl minutes[:seconds]
920      Each player begins with his clock set to the `timeControl' period.
921      Default: 5 minutes.  The additional options `movesPerSession' and
922      `timeIncrement' are mutually exclusive.
923
924 -mps or -movesPerSession moves
925      When both players have made `movesPerSession' moves, a new
926      `timeControl' period is added to both clocks.  Default: 40 moves.
927
928 -inc or -timeIncrement seconds
929      If this option is specified, `movesPerSession' is ignored.
930      Instead, after each player's move, `timeIncrement' seconds are
931      added to his clock.  Use `-inc 0' if you want to require the entire
932      game to be played in one `timeControl' period, with no increment.
933      Default: -1, which specifies `movesPerSession' mode.
934
935 -clock/-xclock or -clockMode true/false
936      Determines whether or not to display the chess clocks. If
937      clockMode is false, the clocks are not shown, but the side that is
938      to play next is still highlighted. Also, unless `searchTime' is
939      set, the chess engine still keeps track of the clock time and uses
940      it to determine how fast to make its moves.
941
942 -st or -searchTime minutes[:seconds]
943      Tells the chess engine to spend at most the given amount of time
944      searching for each of its moves. Without this option, the chess
945      engine chooses its search time based on the number of moves and
946      amount of time remaining until the next time control.  Setting
947      this option also sets clockMode to false.
948
949 -depth or -searchDepth number
950      Tells the chess engine to look ahead at most the given number of
951      moves when searching for a move to make. Without this option, the
952      chess engine chooses its search depth based on the number of moves
953      and amount of time remaining until the next time control.  With
954      the option, the engine will cut off its search early if it reaches
955      the specified depth.
956
957 -firstNPS number
958 -secondNPS number
959      Tells the chess engine to use an internal time standard based on
960      its node count, rather then wall-clock time, to make its timing
961      decisions.  The time in virtual seconds should be obtained by
962      dividing the node count through the given number, like the number
963      was a rate in nodes per second.  Xboard will manage the clocks in
964      accordance with this, relying on the number of nodes reported by
965      the engine in its thinking output. If the given number equals zero,
966      it can obviously not be used to convert nodes to seconds, and the
967      time reported by the engine is used to decrement the XBoard clock
968      in stead. The engine is supposed to report in CPU time it uses,
969      rather than wall-clock time, in this mode. This option can provide
970      fairer conditions for engine-engine matches on heavily loaded
971      machines, or with very fast games (where the wall clock is too
972      inaccurate).  `showThinking' must be on for this option to work.
973      Default: -1 (off).  Not many engines might support this yet!
974
975 -firstTimeOdds factor
976 -secondTimeOdds factor
977      Reduces the time given to the mentioned engine by the given factor.
978      If pondering is off, the effect is indistinguishable from what
979      would happen if the engine was running on an n-times slower
980      machine. Default: 1.
981
982 -timeOddsMode mode
983      This option determines how the case is handled where both engines
984      have a time-odds handicap.  If mode=1, the engine that gets the
985      most time will always get the nominal time, as specified by the
986      time-control options, and its opponent's time is renormalized
987      accordingly.  If mode=0, both play with reduced time. Default: 0.
988
989 -hideThinkingFromHuman true/false
990      Controls the Hide Thinking option. *Note Options Menu::. Default:
991      true.  (Replaces the Show-Thinking option of older xboard
992      versions.)
993
994 -thinking/-xthinking or -showThinking true/false
995      Forces the engine to send thinking output to xboard.  Used to be
996      the only way to control if thinking output was displayed in older
997      xboard versions, but as the thinking output in xboard 4.3 is also
998      used for several other purposes (adjudication, storing in PGN
999      file) the display of it is now controlled by the new option Hide
1000      Thinking. *Note Options Menu::. Default: false.  (But if xboard
1001      needs the thinking output for some purpose, it makes the engine
1002      send it despite the setting of this option.)
1003
1004 -ponder/-xponder or -ponderNextMove true/false
1005      Sets the Ponder Next Move menu option. *Note Options Menu::.
1006      Default: true.
1007
1008 -smpCores number
1009      Specifies the maximum number of CPUs an SMP engine is allowed to
1010      use.  Only works for engines that support the WinBoard-protocol
1011      cores feature.
1012
1013 -mg or -matchGames n
1014      Automatically runs an n-game match between two chess engines, with
1015      alternating colors.  If the `loadGameFile' or `loadPositionFile'
1016      option is set, XBoard starts each game with the given opening
1017      moves or the given position; otherwise, the games start with the
1018      standard initial chess position.  If the `saveGameFile' option is
1019      set, a move record for the match is appended to the specified
1020      file. If the `savePositionFile' option is set, the final position
1021      reached in each game of the match is appended to the specified
1022      file. When the match is over, XBoard displays the match score and
1023      exits. Default: 0 (do not run a match).
1024
1025 -mm/-xmm or -matchMode true/false
1026      Setting `matchMode' to true is equivalent to setting `matchGames'
1027      to 1.
1028
1029 -sameColorGames n
1030      Automatically runs an n-game match between two chess engines,
1031      without alternating colors.  Otherwise the same applies as for the
1032      `-matchGames' option, over which it takes precedence if both are
1033      specified. (See there.)  Default: 0 (do not run a match).
1034
1035 -fcp or -firstChessProgram program
1036      Name of first chess engine.  Default: `Fairy-Max'.
1037
1038 -scp or -secondChessProgram program
1039      Name of second chess engine, if needed.  A second chess engine is
1040      started only in Two Machines (match) mode.  Default: `Fairy-Max'.
1041
1042 -fb/-xfb or -firstPlaysBlack true/false
1043      In games between two chess engines, firstChessProgram normally
1044      plays white.  If this option is true, firstChessProgram plays
1045      black.  In a multi-game match, this option affects the colors only
1046      for the first game; they still alternate in subsequent games.
1047
1048 -fh or -firstHost host
1049 -sh or -secondHost host
1050      Hosts on which the chess engines are to run. The default for each
1051      is `localhost'. If you specify another host, XBoard uses `rsh' to
1052      run the chess engine there. (You can substitute a different remote
1053      shell program for rsh using the `remoteShell' option described
1054      below.)
1055
1056 -fd or -firstDirectory dir
1057 -sd or -secondDirectory dir
1058      Working directories in which the chess engines are to be run.  The
1059      default is "", which means to run the chess engine in the same
1060      working directory as XBoard itself.  (See the CHESSDIR environment
1061      variable.)  This option is effective only when the chess engine is
1062      being run on the local host; it does not work if the engine is run
1063      remotely using the -fh or -sh option.
1064
1065 -initString string
1066 -secondInitString string
1067      The string that is sent to initialize each chess engine for a new
1068      game.  Default:
1069
1070           new
1071           random
1072      Setting this option from the command line is tricky, because you
1073      must type in real newline characters, including one at the very
1074      end.  In most shells you can do this by entering a `\' character
1075      followed by a newline. It is easier to set the option from your
1076      `.Xresources' file; in that case you can include the character
1077      sequence `\n' in the string, and it will be converted to a newline.
1078
1079      If you change this option, don't remove the `new' command; it is
1080      required by all chess engines to start a new game.
1081
1082      You can remove the `random' command if you like; including it
1083      causes GNU Chess 4 to randomize its move selection slightly so
1084      that it doesn't play the same moves in every game.  Even without
1085      `random', GNU Chess 4 randomizes its choice of moves from its
1086      opening book.  Many other chess engines ignore this command
1087      entirely and always (or never) randomize.
1088
1089      You can also try adding other commands to the initString; see the
1090      documentation of the chess engine you are using for details.
1091
1092 -firstComputerString string
1093 -secondComputerString string
1094      The string that is sent to the chess engine if its opponent is
1095      another computer chess engine.  The default is `computer\n'.
1096      Probably the only useful alternative is the empty string (`'),
1097      which keeps the engine from knowing that it is playing another
1098      computer.
1099
1100 -reuse/-xreuse or -reuseFirst true/false
1101 -reuse2/-xreuse2 or -reuseSecond true/false
1102      If the option is false, XBoard kills off the chess engine after
1103      every game and starts it again for the next game.  If the option
1104      is true (the default), XBoard starts the chess engine only once
1105      and uses it repeatedly to play multiple games.  Some old chess
1106      engines may not work properly when reuse is turned on, but
1107      otherwise games will start faster if it is left on.
1108
1109 -firstProtocolVersion version-number
1110 -secondProtocolVersion version-number
1111      This option specifies which version of the chess engine
1112      communication protocol to use.  By default, version-number is 2.
1113      In version 1, the "protover" command is not sent to the engine;
1114      since version 1 is a subset of version 2, nothing else changes.
1115      Other values for version-number are not supported.
1116
1117 -firstScoreAbs true/false
1118 -secondScoreAbs true/false
1119      If this option is set, the score reported by the engine is taken
1120      to be that in favor of white, even when the engine plays black.
1121      Important when XBoard uses the score for adjudications, or in PGN
1122      reporting.
1123
1124 -niceEngines priority
1125      This option allows you to lower the priority of the engine
1126      processes, so that the generally insatiable hunger for CPU time of
1127      chess engines does not interfere so much with smooth operation of
1128      WinBoard (or the rest of your system).  Negative values could
1129      increase the engine priority, which is not recommended.
1130
1131 -firstOptions string
1132 -secondOptions string
1133      The given string is a comma-separated list of (option name=option
1134      value) pairs, like the following example: "style=Karpov,blunder
1135      rate=0".  If the options announced by the engine at startup
1136      through the feature commands of WinBoard protocol matches one of
1137      the option names (i.e. "style" or "blunder rate"), it would be set
1138      to the given value (i.e. "Karpov" or 0) through a corresponding
1139      option command to the engine.  This provided that the type of the
1140      value (text or numeric) matches as well.
1141
1142 -firstNeedsNoncompliantFEN string
1143 -secondNeedsNoncompliantFEN string
1144      The castling rights and e.p. fields of the FEN sent to the
1145      mentioned engine with the setboard command will be replaced by the
1146      given string. This can for instance be used to run engines that do
1147      not understand Chess960 FENs in variant fischerandom, to make them
1148      at least understand the opening position, through setting the
1149      string to "KQkq -". (Note you also have to give the e.p. field!)
1150      Other possible applications are to provide work-arounds for
1151      engines that want to see castling and e.p. fields in variants that
1152      do not have castling or e.p.  (shatranj, courier, xiangqi, shogi)
1153      so that WinBoard would normally omit them (string = "- -"), or to
1154      add variant-specific fields that are not yet supported by WinBoard
1155      (e.g. to indicate the number of checks in 3check).
1156
1157 3.2 UCI + WB Engine Settings
1158 ============================
1159
1160 -fUCI or -firstIsUCI true/false
1161 -sUCI or -secondIsUCI true/false
1162      Indicates if the mentioned engine executable file is an UCI engine,
1163      and should be run with the aid of the Polyglot adapter rather than
1164      directly.  Xboard will then pass the other UCI options and engine
1165      name to Polyglot through a .ini temporary file created for the
1166      purpose.
1167
1168 -PolyglotDir filename
1169      Gives the name of the directory in which the Polyglot adapter for
1170      UCI engines expects its files.  Default:
1171      "/usr/local/share/polyglot".
1172
1173 -usePolyglotBook true/false
1174      Specifies if the Polyglot book should be used.
1175
1176 -PolyglotBook filename
1177      Gives the filename of the opening book that Polyglot should use.
1178      From XBoard 4.3.15 on, native WinBoard engines will also use the
1179      opening book specified here, provided the `usePolyglotBook' option
1180      is set to true, and the option `firstHasOwnBookUCI' or
1181      `secondHasOwnBookUCI' applying to the engine is set to false.  The
1182      engine will be kept in force mode as long as the current position
1183      is in book, and XBoard will select the book moves for it. Default
1184      "".
1185
1186 -fNoOwnBookUCI or -firstXBook or -firstHasOwnBookUCI true/false
1187 -sNoOwnBookUCI or -secondXBook or -secondHasOwnBookUCI true/false
1188      Indicates if the mentioned engine has its own opening book it
1189      should play from, rather than using the external book through
1190      XBoard. Default: false.
1191
1192 -defaultHashSize n
1193      Sets the size of the hash table to n MegaBytes. Together with the
1194      EGTB cache size this number is also used to calculate the memory
1195      setting of WinBoard engines, for those that support the memory
1196      feature of WinBoard protocol. Default: 64.
1197
1198 -defaultCacheSizeEGTB n
1199      Sets the size of the EGTB cache to n MegaBytes. Together with the
1200      hash-table size this number is also used to calculate the memory
1201      setting of WinBoard engines, for those that support the memory
1202      feature of WinBoard protocol. Default: 4.
1203
1204 -defaultPathEGTB filename
1205      Gives the name of the directory where the end-game tablebases are
1206      installed, for UCI engines.  Default: "/usr/local/share/egtb".
1207
1208 -egtFormats string
1209      Specifies which end-game tables are installed on the computer, and
1210      where.  The argument is a comma-separated list of format
1211      specifications, each specification consisting of a format name, a
1212      colon, and a directory path name, e.g.
1213      "nalimov:/usr/local/share/egtb".  If the name part matches that of
1214      a format that the engine requests through a feature command,
1215      xboard will relay the path name for this format to the engine
1216      through an egtpath command.  One egtpath command for each matching
1217      format will be sent.  Popular formats are "nalimov" DTM tablebases
1218      and "scorpio" bitbases.  Default: "".
1219
1220 3.3 ICS options
1221 ===============
1222
1223 -ics/-xics or -internetChessServerMode true/false
1224      Connect with an Internet Chess Server to play chess against its
1225      other users, observe games they are playing, or review games that
1226      have recently finished. Default: false.
1227
1228 -icshost or -internetChessServerHost host
1229      The Internet host name or address of the chess server to connect
1230      to when in ICS mode. Default: `chessclub.com'.  Another popular
1231      chess server to try is `freechess.org'.  If your site doesn't have
1232      a working Internet name server, try specifying the host address in
1233      numeric form.  You may also need to specify the numeric address
1234      when using the icshelper option with timestamp or timeseal (see
1235      below).
1236
1237 -icsport or -internetChessServerPort port-number
1238      The port number to use when connecting to a chess server in ICS
1239      mode. Default: 5000.
1240
1241 -icshelper or -internetChessServerHelper prog-name
1242      An external helper program used to communicate with the chess
1243      server.  You would set it to "timestamp" for ICC (chessclub.com) or
1244      "timeseal" for FICS (freechess.org), after obtaining the correct
1245      version of timestamp or timeseal for your computer.  See "help
1246      timestamp" on ICC and "help timeseal" on FICS.  This option is
1247      shorthand for `-useTelnet -telnetProgram program'.
1248
1249 -telnet/-xtelnet or -useTelnet true/false
1250      This option is poorly named; it should be called useHelper.  If
1251      set to true, it instructs XBoard to run an external program to
1252      communicate with the Internet Chess Server.  The program to use is
1253      given by the telnetProgram option.  If the option is false (the
1254      default), XBoard opens a TCP socket and uses its own internal
1255      implementation of the telnet protocol to communicate with the ICS.
1256      *Note Firewalls::.
1257
1258 -telnetProgram prog-name
1259      This option is poorly named; it should be called helperProgram.
1260      It gives the name of the telnet program to be used with the
1261      `gateway' and `useTelnet' options.  The default is `telnet'. The
1262      telnet program is invoked with the value of
1263      `internetChessServerHost' as its first argument and the value of
1264      `internetChessServerPort' as its second argument.  *Note
1265      Firewalls::.
1266
1267 -gateway host-name
1268      If this option is set to a host name, XBoard communicates with the
1269      Internet Chess Server by using `rsh' to run the `telnetProgram' on
1270      the given host, instead of using its own internal implementation
1271      of the telnet protocol. You can substitute a different remote shell
1272      program for `rsh' using the `remoteShell' option described below.
1273      *Note Firewalls::.
1274
1275 -internetChessServerCommPort or -icscomm dev-name
1276      If this option is set, XBoard communicates with the ICS through
1277      the given character I/O device instead of opening a TCP connection.
1278      Use this option if your system does not have any kind of Internet
1279      connection itself (not even a SLIP or PPP connection), but you do
1280      have dial-up access (or a hardwired terminal line) to an Internet
1281      service provider from which you can telnet to the ICS.
1282
1283      The support for this option in XBoard is minimal. You need to set
1284      all communication parameters and tty modes before you enter XBoard.
1285
1286      Use a script something like this:
1287
1288           stty raw -echo 9600 > /dev/tty00
1289           xboard -ics -icscomm /dev/tty00
1290
1291      Here replace `/dev/tty00' with the name of the device that your
1292      modem is connected to. You might have to add several more options
1293      to these stty commands. See the man pages for `stty' and `tty' if
1294      you run into problems. Also, on many systems stty works on its
1295      standard input instead of standard output, so you have to use `<'
1296      instead of `>'.
1297
1298      If you are using linux, try starting with the script below.
1299      Change it as necessary for your installation.
1300
1301           #!/bin/sh -f
1302           # configure modem and fire up XBoard
1303
1304           # configure modem
1305           (
1306             stty 2400 ; stty raw ; stty hupcl ; stty -clocal
1307             stty ignbrk ; stty ignpar ; stty ixon ; stty ixoff
1308             stty -iexten ; stty -echo
1309           ) < /dev/modem
1310           xboard -ics -icscomm /dev/modem
1311      After you start XBoard in this way, type whatever commands are
1312      necessary to dial out to your Internet provider and log in.  Then
1313      telnet to ICS, using a command like `telnet chessclub.com 5000'.
1314      Important: See the paragraph below about extra echoes, in *note
1315      Limitations::.
1316
1317 -icslogon or -internetChessServerLogonScript file-name
1318      Whenever XBoard connects to the Internet Chess Server, if it finds
1319      a file with the name given in this option, it feeds the file's
1320      contents to the ICS as commands. The default file name is `.icsrc'.
1321      Usually the first two lines of the file should be your ICS user
1322      name and password.  The file can be either in $CHESSDIR, in
1323      XBoard's working directory if CHESSDIR is not set, or in your home
1324      directory.
1325
1326 -msLoginDelay delay
1327      If you experience trouble logging on to an ICS when using the
1328      `-icslogon' option, inserting some delay between characters of the
1329      logon script may help. This option adds `delay' milliseconds of
1330      delay between characters. Good values to try are 100 and 250.
1331
1332 -icsinput/-xicsinput or -internetChessServerInputBox true/false
1333      Sets the ICS Input Box menu option. *Note Mode Menu::. Default:
1334      false.
1335
1336 -autocomm/-xautocomm or -autoComment true/false
1337      Sets the Auto Comment menu option. *Note Options Menu::. Default:
1338      false.
1339
1340 -autoflag/-xautoflag or -autoCallFlag true/false
1341      Sets the Auto Flag menu option.  *Note Options Menu::. Default:
1342      false.
1343
1344 -autobs/-xautobs or -autoObserve true/false
1345      Sets the Auto Observe menu option.  *Note Options Menu::. Default:
1346      false.
1347
1348 -autoKibitz
1349      Enables kibitzing of the engines last thinking output (depth,
1350      score, time, speed, PV) before it moved to the ICS, in zippy mode.
1351      The option `showThinking' must be switched on for this option to
1352      work.  Also diverts similar kibitz information of an opponent
1353      engine that is playing you through the ICS to the engine-output
1354      window, as if the engine was playing locally.
1355
1356 -moves/-xmoves or -getMoveList true/false
1357      Sets the Get Move List menu option.  *Note Options Menu::.
1358      Default: true.
1359
1360 -alarm/-xalarm or -icsAlarm true/false
1361      Sets the ICS Alarm menu option.  *Note Options Menu::. Default:
1362      true.
1363
1364 -icsAlarmTime ms
1365      Sets the time in milliseconds for the ICS Alarm menu option.
1366      *Note Options Menu::. Default: 5000.
1367
1368 lowTimeWarning true/false
1369      Controls a color change of the board as a warning your time is
1370      running out.  *Note Options Menu::. Default: false.
1371
1372 -pre/-xpre \fRor\fB -premove true/false
1373      Sets the Premove menu option. *Note Options Menu::. Default: true.
1374
1375 -quiet/-xquiet or -quietPlay true/false
1376      Sets the Quiet Play menu option.  *Note Options Menu::.  Default:
1377      false.
1378
1379 -colorizeMessages or -colorize
1380      Setting colorizeMessages to true tells XBoard to colorize the
1381      messages received from the ICS.  Colorization works only if your
1382      xterm supports ISO 6429 escape sequences for changing text colors.
1383
1384 -colorShout foreground,background,bold
1385 -colorSShout foreground,background,bold
1386 -colorChannel1 foreground,background,bold
1387 -colorChannel foreground,background,bold
1388 -colorKibitz foreground,background,bold
1389 -colorTell foreground,background,bold
1390 -colorChallege foreground,background,bold
1391 -colorRequest foreground,background,bold
1392 -colorSeek foreground,background,bold
1393 -colorNormal foreground,background,bold
1394      These options set the colors used when colorizing ICS messages.
1395      All ICS messages are grouped into one of these categories: shout,
1396      sshout, channel 1, other channel, kibitz, tell, challenge, request
1397      (including abort, adjourn, draw, pause, and takeback), or normal
1398      (all other messages).
1399
1400      Each foreground or background argument can be one of the following:
1401      black, red, green, yellow, blue, magenta, cyan, white, or default.
1402      Here "default" means the default foreground or background color of
1403      your xterm.  Bold can be 1 or 0.  If background is omitted,
1404      "default" is assumed; if bold is omitted, 0 is assumed.
1405
1406      Here is an example of how to set the colors in your `.Xresources'
1407      file.  The colors shown here are the default values; you will get
1408      them if you turn `-colorize' on without specifying your own colors.
1409
1410           xboard*colorizeMessages: true
1411           xboard*colorShout: green
1412           xboard*colorSShout: green, black, 1
1413           xboard*colorChannel1: cyan
1414           xboard*colorChannel: cyan, black, 1
1415           xboard*colorKibitz: magenta, black, 1
1416           xboard*colorTell: yellow, black, 1
1417           xboard*colorChallenge: red, black, 1
1418           xboard*colorRequest: red
1419           xboard*colorSeek: blue
1420           xboard*colorNormal: default
1421
1422 -soundProgram progname
1423      If this option is set to a sound-playing program that is installed
1424      and working on your system, XBoard can play sound files when
1425      certain events occur, listed below.  The default program name is
1426      "play".  If any of the sound options is set to "$", the event
1427      rings the terminal bell by sending a ^G character to standard
1428      output, instead of playing a sound file.  If an option is set to
1429      the empty string "", no sound is played for that event.
1430
1431 -soundShout filename
1432 -soundSShout filename
1433 -soundChannel filename
1434 -soundKibitz filename
1435 -soundTell filename
1436 -soundChallenge filename
1437 -soundRequest filename
1438 -soundSeek filename
1439      These sounds are triggered in the same way as the colorization
1440      events described above.  They all default to "", no sound.  They
1441      are played only if the colorizeMessages is on.
1442
1443 -soundMove filename
1444      This sound is used by the Move Sound menu option.  Default: "$".
1445
1446 -soundIcsAlarm filename
1447      This sound is used by the ICS Alarm menu option.  Default: "$".
1448
1449 -soundIcsWin filename
1450      This sound is played when you win an ICS game.  Default: "" (no
1451      sound).
1452
1453 -soundIcsLoss filename
1454      This sound is played when you lose an ICS game.  Default: "" (no
1455      sound).
1456
1457 -soundIcsDraw filename
1458      This sound is played when you draw an ICS game.  Default: "" (no
1459      sound).
1460
1461 -soundIcsUnfinished filename
1462      This sound is played when an ICS game that you are participating
1463      in is aborted, adjourned, or otherwise ends inconclusively.
1464      Default: "" (no sound).
1465
1466      Here is an example of how to set the sounds in your `.Xresources'
1467      file:
1468
1469           xboard*soundShout: shout.wav
1470           xboard*soundSShout: sshout.wav
1471           xboard*soundChannel1: channel1.wav
1472           xboard*soundChannel: channel.wav
1473           xboard*soundKibitz: kibitz.wav
1474           xboard*soundTell: tell.wav
1475           xboard*soundChallenge: challenge.wav
1476           xboard*soundRequest: request.wav
1477           xboard*soundSeek: seek.wav
1478           xboard*soundMove: move.wav
1479           xboard*soundIcsWin: win.wav
1480           xboard*soundIcsLoss: lose.wav
1481           xboard*soundIcsDraw: draw.wav
1482           xboard*soundIcsUnfinished: unfinished.wav
1483           xboard*soundIcsAlarm: alarm.wav
1484
1485 3.4 Load and Save options
1486 =========================
1487
1488 -lgf or -loadGameFile file
1489 -lgi or -loadGameIndex index
1490      If the `loadGameFile' option is set, XBoard loads the specified
1491      game file at startup. The file name `-' specifies the standard
1492      input. If there is more than one game in the file, XBoard pops up
1493      a menu of the available games, with entries based on their PGN
1494      (Portable Game Notation) tags.  If the `loadGameIndex' option is
1495      set to `N', the menu is suppressed and the N th game found in the
1496      file is loaded immediately.  The menu is also suppressed if
1497      `matchMode' is enabled or if the game file is a pipe; in these
1498      cases the first game in the file is loaded immediately.  Use the
1499      `pxboard' shell script provided with XBoard if you want to pipe in
1500      files containing multiple games and still see the menu.  If the
1501      loadGameIndex specifies an index -1, this triggers auto-increment
1502      of the index in `matchMode', which means that after every game the
1503      index is incremented by one, causing each game of the match to be
1504      played from the next game in the file. Similarly, specifying an
1505      index value of -2 causes the index to be incremented every two
1506      games, so that each game in the file is used twice (with reversed
1507      colors).  The `rewindIndex' option causes the index to be reset to
1508      the first game of the file when it has reached a specified value.
1509
1510 -rewindIndex n
1511      Causes a position file or game file to be rewound to its beginning
1512      after n positions or games in auto-increment `matchMode'.  See
1513      `loadPositionIndex' and `loadGameIndex'.  default: 0 (no rewind).
1514
1515 -td or -timeDelay seconds
1516      Time delay between moves during `Load Game'. Fractional seconds
1517      are allowed; try `-td 0.4'. A time delay value of -1 tells XBoard
1518      not to step through game files automatically. Default: 1 second.
1519
1520 -sgf or -saveGameFile file
1521      If this option is set, XBoard appends a record of every game
1522      played to the specified file. The file name `-' specifies the
1523      standard output.
1524
1525 -autosave/-xautosave or -autoSaveGames true/false
1526      Sets the Auto Save menu option.  *Note Options Menu::.  Default:
1527      false.  Ignored if `saveGameFile' is set.
1528
1529 -lpf or -loadPositionFile file
1530 -lpi or -loadPositionIndex index
1531      If the `loadPositionFile' option is set, XBoard loads the
1532      specified position file at startup. The file name `-' specifies the
1533      standard input. If the `loadPositionIndex' option is set to N, the
1534      Nth position found in the file is loaded; otherwise the first
1535      position is loaded.  If the loadPositionIndex specifies an index
1536      -1, this triggers auto-increment of the index in `matchMode',
1537      which means that after every game the index is incremented by one,
1538      causing each game of the match to be played from the next position
1539      in the file. Similarly, specifying an index value of -2 causes the
1540      index to be incremented every two games, so that each position in
1541      the file is used twice (with the engines playing opposite colors).
1542      The `rewindIndex' option causes the index to be reset to the first
1543      position of the file when it has reached a specified value.
1544
1545 -spf or -savePositionFile file
1546      If this option is set, XBoard appends the final position reached
1547      in every game played to the specified file. The file name `-'
1548      specifies the standard output.
1549
1550 -pgnExtendedInfo true/false
1551      If this option is set, WinBoard saves depth, score and time used
1552      for each move that the engine found as a comment in the PGN file.
1553      Default: false.
1554
1555 -pgnEventHeader string
1556      Sets the name used in the PGN event tag to string.  Default:
1557      "Computer Chess Game".
1558
1559 -saveOutOfBookInfo true/false
1560      Include the information on how the engine(s) game out of its
1561      opening book in a special 'annotator' tag with the PGN file.
1562
1563 -oldsave/-xoldsave or -oldSaveStyle true/false
1564      Sets the Old Save Style menu option.  *Note Options Menu::.
1565      Default: false.
1566
1567 -gameListTags string
1568      The character string lists the PGN tags that should be printed in
1569      the Game List, and their order. The meaning of the codes is
1570      e=event, s=site, d=date, o=round, p=players, r=result, w=white
1571      Elo, b=black Elo, t=time control, v=variant, a=out-of-book info.
1572      Default: "eprd"
1573
1574 3.5 User interface options
1575 ==========================
1576
1577 -display
1578 -geometry
1579 -iconic
1580      These and most other standard Xt options are accepted.
1581
1582 -noGUI
1583      Suppresses all GUI functions of XBoard (to speed up automated
1584      ultra-fast engine-engine games, which you donÂ’t want to watch).
1585      There will be no board or clock updates, no printing of moves, and
1586      no update of the icon on the task bar in this mode.
1587
1588 -movesound/-xmovesound or -ringBellAfterMoves true/false
1589      Sets the Move Sound menu option.  *Note Options Menu::.  Default:
1590      false.  For compatibility with old XBoard versions, -bell/-xbell
1591      are also accepted as abbreviations for this option.
1592
1593 -exit/-xexit or -popupExitMessage true/false
1594      Sets the Popup Exit Message menu option.  *Note Options Menu::.
1595      Default: true.
1596
1597 -popup/-xpopup or -popupMoveErrors true/false
1598      Sets the Popup Move Errors menu option.  *Note Options Menu::.
1599      Default: false.
1600
1601 -queen/-xqueen or -alwaysPromoteToQueen true/false
1602      Sets the Always Queen menu option.  *Note Options Menu::.
1603      Default: false.
1604
1605 -legal/-xlegal or -testLegality true/false
1606      Sets the Test Legality menu option.  *Note Options Menu::.
1607      Default: true.
1608
1609 -size or -boardSize (sizeName | n1,n2,n3,n4,n5,n6,n7)
1610      Determines how large the board will be, by selecting the pixel size
1611      of the pieces and setting a few related parameters.  The sizeName
1612      can be one of: Titanic, giving 129x129 pixel pieces, Colossal
1613      116x116, Giant 108x108, Huge 95x95, Big 87x87, Large 80x80, Bulky
1614      72x72, Medium 64x64, Moderate 58x58, Average 54x54, Middling
1615      49x49, Mediocre 45x45, Small 40x40, Slim 37x37, Petite 33x33,
1616      Dinky 29x29, Teeny 25x25, or Tiny 21x21.  Pieces of all these
1617      sizes are built into XBoard.  Other sizes can be used if you have
1618      them; see the pixmapDirectory and bitmapDirectory options.  The
1619      default depends on the size of your screen; it is approximately the
1620      largest size that will fit without clipping.
1621
1622      You can select other sizes or vary other layout parameters by
1623      providing a list of comma-separated values (with no spaces) as the
1624      argument.  You do not need to provide all the values; for any you
1625      omit from the end of the list, defaults are taken from the nearest
1626      built-in size.  The value `n1' gives the piece size, `n2' the
1627      width of the black border between squares, `n3' the desired size
1628      for the clockFont, `n4' the desired size for the coordFont, `n5'
1629      the desired size for the default font, `n6' the smallLayout flag
1630      (0 or 1), and `n7' the tinyLayout flag (0 or 1).  All dimensions
1631      are in pixels.  If the border between squares is eliminated (0
1632      width), the various highlight options will not work, as there is
1633      nowhere to draw the highlight.  If smallLayout is 1 and
1634      `titleInWindow' is true, the window layout is rearranged to make
1635      more room for the title.  If tinyLayout is 1, the labels on the
1636      menu bar are abbreviated to one character each and the buttons in
1637      the button bar are made narrower.
1638
1639 -coords/-xcoords or -showCoords true/false
1640      Sets the Show Coords menu option.  *Note Options Menu::.  Default:
1641      false.  The `coordFont' option specifies what font to use.
1642
1643 -autoraise/-xautoraise or -autoRaiseBoard true/false
1644      Sets the Auto Raise Board menu option.  *Note Options Menu::.
1645      Default: true.
1646
1647 -autoflip/-xautoflip or -autoFlipView true/false
1648      Sets the Auto Flip View menu option.  *Note Options Menu::.
1649      Default: true.
1650
1651 -flip/-xflip or -flipView true/false
1652      If Auto Flip View is not set, or if you are observing but not
1653      participating in a game, then the positioning of the board at the
1654      start of each game depends on the flipView option.  If flipView is
1655      false (the default), the board is positioned so that the white
1656      pawns move from the bottom to the top; if true, the black pawns
1657      move from the bottom to the top.  In any case, the Flip menu
1658      option (see *note Options Menu::) can be used to flip the board
1659      after the game starts.
1660
1661 -title/-xtitle or -titleInWindow true/false
1662      If this option is true, XBoard displays player names (for ICS
1663      games) and game file names (for `Load Game') inside its main
1664      window. If the option is false (the default), this information is
1665      displayed only in the window banner. You probably won't want to
1666      set this option unless the information is not showing up in the
1667      banner, as happens with a few X window managers.
1668
1669 -buttons/-xbuttons or -showButtonBar True/False
1670      If this option is False, xboard omits the [<<] [<] [P] [>] [>>]
1671      button bar from the window, allowing the message line to be wider.
1672      You can still get the functions of these buttons using the menus
1673      or their keyboard shortcuts.  Default: true.
1674
1675 -mono/-xmono or -monoMode true/false
1676      Determines whether XBoard displays its pieces and squares with two
1677      colors (true) or four (false). You shouldn't have to specify
1678      `monoMode'; XBoard will determine if it is necessary.
1679
1680 -flashCount count
1681 -flashRate rate
1682 -flash/-xflash
1683      These options enable flashing of pieces when they land on their
1684      destination square.  `flashCount' tells XBoard how many times to
1685      flash a piece after it lands on its destination square.
1686      `flashRate' controls the rate of flashing (flashes/sec).
1687      Abbreviations: `flash' sets flashCount to 3.  `xflash' sets
1688      flashCount to 0.  Defaults:  flashCount=0 (no flashing),
1689      flashRate=5.
1690
1691 -highlight/-xhighlight or -highlightLastMove true/false
1692      Sets the Highlight Last Move menu option. *Note Options Menu::.
1693      Default: false.
1694
1695 -blind/-xblind or -blindfold true/false
1696      Sets the Blindfold menu option.  *Note Options Menu::.  Default:
1697      false.
1698
1699 -clockFont font
1700      The font used for the clocks. If the option value is a pattern
1701      that does not specify the font size, XBoard tries to choose an
1702      appropriate font for the board size being used.  Default:
1703      -*-helvetica-bold-r-normal-*-*-*-*-*-*-*-*.
1704
1705 -coordFont font
1706      The font used for rank and file coordinate labels if `showCoords'
1707      is true. If the option value is a pattern that does not specify
1708      the font size, XBoard tries to choose an appropriate font for the
1709      board size being used.  Default:
1710      -*-helvetica-bold-r-normal-*-*-*-*-*-*-*-*.
1711
1712 -font font
1713      The font used for popup dialogs, menus, comments, etc.  If the
1714      option value is a pattern that does not specify the font size,
1715      XBoard tries to choose an appropriate font for the board size
1716      being used.  Default: -*-helvetica-medium-r-normal-*-*-*-*-*-*-*-*.
1717
1718 -fontSizeTolerance tol
1719      In the font selection algorithm, a nonscalable font will be
1720      preferred over a scalable font if the nonscalable font's size
1721      differs by `tol' pixels or less from the desired size.  A value of
1722      -1 will force a scalable font to always be used if available; a
1723      value of 0 will use a nonscalable font only if it is exactly the
1724      right size; a large value (say 1000) will force a nonscalable font
1725      to always be used if available.  Default: 4.
1726
1727 -bm or -bitmapDirectory dir
1728 -pixmap or -pixmapDirectory dir
1729      These options control what piece images xboard uses.  The XBoard
1730      distribution includes one set of pixmap pieces in xpm format, in
1731      the directory `pixmaps', and one set of bitmap pieces in xbm
1732      format, in the directory `bitmaps'.  Pixmap pieces give a better
1733      appearance on the screen: the white pieces have dark borders, and
1734      the black pieces have opaque internal details.  With bitmaps,
1735      neither piece color has a border, and the internal details are
1736      transparent; you see the square color or other background color
1737      through them.
1738
1739      If XBoard is configured and compiled on a system that includes
1740      libXpm, the X pixmap library, the xpm pixmap pieces are compiled
1741      in as the default.  A different xpm piece set can be selected at
1742      runtime with the `pixmapDirectory' option, or a bitmap piece set
1743      can be selected with the `bitmapDirectory' option.
1744
1745      If XBoard is configured and compiled on a system that does not
1746      include libXpm (or the `--disable-xpm' option is given to the
1747      configure program), the bitmap pieces are compiled in as the
1748      default.  It is not possible to use xpm pieces in this case, but
1749      pixmap pieces in another format called "xim" can be used by giving
1750      the `pixmapDirectory' option.  Or again, a different bitmap piece
1751      set can be selected with the `bitmapDirectory' option.
1752
1753      Files in the `bitmapDirectory' must be named as follows: The first
1754      character of a piece bitmap name gives the piece it represents
1755      (`p', `n', `b', `r', `q', or `k'), the next characters give the
1756      size in pixels, the following character indicates whether the
1757      piece is solid or outline (`s' or `o'), and the extension is `.bm'.
1758      For example, a solid 80x80 knight would be named `n80s.bm'.  The
1759      outline bitmaps are used only in monochrome mode.  If bitmap
1760      pieces are compiled in and the bitmapDirectory is missing some
1761      files, the compiled in pieces are used instead.
1762
1763      If the bitmapDirectory option is given, it is also possible to
1764      replace xboard's icons and menu checkmark, by supplying files
1765      named `icon_white.bm', `icon_black.bm', and `checkmark.bm'.
1766
1767      For more information about pixmap pieces and how to get additional
1768      sets, see *note zic2xpm:: below.
1769
1770 -whitePieceColor color
1771 -blackPieceColor color
1772 -lightSquareColor color
1773 -darkSquareColor color
1774 -highlightSquareColor color
1775 -lowTimeWarningColor color
1776      Colors to use for the pieces, squares, and square highlights.
1777      Defaults:
1778
1779           -whitePieceColor       #FFFFCC
1780           -blackPieceColor       #202020
1781           -lightSquareColor      #C8C365
1782           -darkSquareColor       #77A26D
1783           -highlightSquareColor  #FFFF00
1784           -premoveHighlightColor #FF0000
1785           -lowTimeWarningColor   #FF0000
1786
1787      On a grayscale monitor you might prefer:
1788
1789           -whitePieceColor       gray100
1790           -blackPieceColor       gray0
1791           -lightSquareColor      gray80
1792           -darkSquareColor       gray60
1793           -highlightSquareColor  gray100
1794           -premoveHighlightColor gray70
1795           -lowTimeWarningColor   gray70
1796
1797 -drag/-xdrag or -animateDragging true/false
1798      Sets the Animate Dragging menu option. *Note Options Menu::.
1799      Default: true.
1800
1801 -animate/-xanimate or -animateMoving true/false
1802      Sets the Animate Moving menu option. *Note Options Menu::.
1803      Default: true.
1804
1805 -animateSpeed n
1806      Number of milliseconds delay between each animation frame when
1807      Animate Moves is on.
1808
1809 3.6 Adjudication Options
1810 ========================
1811
1812 -adjudicateLossThreshold n
1813      If the given value is non-zero, XBoard adjudicates the game as a
1814      loss if both engines agree for a duration of 6 consecutive ply
1815      that the score is below the given score threshold for that engine.
1816      Make sure the score is interpreted properly by XBoard, using
1817      `-firstScoreAbs' and `-secondScoreAbs' if needed.  Default: 0 (no
1818      adjudication)
1819
1820 -adjudicateDrawMoves n
1821      If the given value is non-zero, XBoard adjudicates the game as a
1822      draw if after the given number of moves it was not yet decided.
1823      Default: 0 (no adjudication)
1824
1825 -checkMates true/false
1826      If this option is set, XBoard detects all checkmates and
1827      stalemates, and ends the game as soon as they occur.
1828      Legality-testing must be switched on for this option to work.
1829      Default: true
1830
1831 -testClaims true/false
1832      If this option is set, XBoard verifies all result claims made by
1833      engines, and those who send false claims will forfeit the game
1834      because of it.  Legality-testing must be switched on for this
1835      option to work. Default: true
1836
1837 -materialDraws true/false
1838      If this option is set, XBoard adjudicates games as draws when
1839      there is no sufficient material left to inflict a checkmate.  This
1840      applies to KBKB with like bishops (any number, actually), and to
1841      KBK, KNK and KK.  Legality-testing must be switched on for this
1842      option to work. Default: true
1843
1844 -trivialDraws true/false
1845      If this option is set, XBoard adjudicates games as draws that
1846      cannot be usually won without opponent cooperation. This applies
1847      to KBKB with unlike bishops, and to KBKN, KNKN, KNNK, KRKR and
1848      KQKQ. The draw is called after 6 ply into these end-games, to
1849      allow quick mates that can occur in some exceptional positions to
1850      be found by the engines.  KQKQ does not really belong in this
1851      category, and might be taken out in the future.  (When
1852      bitbase-based adjudications are implemented.)  Legality-testing
1853      must be on for this option to work. Default: false
1854
1855 -ruleMoves n
1856      If the given value is non-zero, XBoard adjudicates the game as a
1857      draw after the given number of consecutive reversible moves.
1858      Engine draw claims are always accepted after 50 moves,
1859      irrespective of the given value of n.
1860
1861 -repeatsToDraw n
1862      If the given value is non-zero, xboard adjudicates the game as a
1863      draw if a position is repeated the given number of times. Engines
1864      draw claims are always accepted after 3 repeats, (on the 3rd
1865      occurrence, actually), irrespective of the value of n.  Beware
1866      that positions that have different castling or en-passant rights
1867      do not count as repeats, XBoard is fully e.p. and castling aware!
1868
1869 3.7 Other options
1870 =================
1871
1872 -ncp/-xncp or -noChessProgram true/false
1873      If this option is true, XBoard acts as a passive chessboard; it
1874      does not start a chess engine at all. Turning on this option also
1875      turns off clockMode. Default: false.
1876
1877 -mode or -initialMode modename
1878      If this option is given, XBoard selects the given modename from
1879      the Mode menu after starting and (if applicable) processing the
1880      loadGameFile or loadPositionFile option. Default: "" (no
1881      selection).  Other supported values are MachineWhite,
1882      MachineBlack, TwoMachines, Analysis, AnalyzeFile, EditGame,
1883      EditPosition, and Training.
1884
1885 -variant varname
1886      Activates preliminary, partial support for playing chess variants
1887      against a local engine or editing variant games.  This flag is not
1888      needed in ICS mode.  Recognized variant names are:
1889
1890           normal        Normal chess
1891           wildcastle    Shuffle chess, king can castle from d file
1892           nocastle      Shuffle chess, no castling allowed
1893           fischerandom  Fischer Random shuffle chess
1894           bughouse      Bughouse, ICC/FICS rules
1895           crazyhouse    Crazyhouse, ICC/FICS rules
1896           losers        Lose all pieces or get mated (ICC wild 17)
1897           suicide       Lose all pieces including king (FICS)
1898           giveaway      Try to have no legal moves (ICC wild 26)
1899           twokings      Weird ICC wild 9
1900           kriegspiel    Opponent's pieces are invisible
1901           atomic        Capturing piece explodes (ICC wild 27)
1902           3check        Win by giving check 3 times (ICC wild 25)
1903           shatranj      An ancient precursor of chess (ICC wild 28)
1904           xiangqi       Chinese Chess (on a 9x10 board)
1905           shogi         Japanese Chess (on a 9x9 board & piece drops)
1906           capablanca    Capablanca Chess (10x8 board, with Archbishop
1907                         and Chancellor pieces)
1908           gothic        similar, with a better initial position
1909           caparandom    An FRC-like version of Capablanca Chess (10x8)
1910           janus         A game with two Archbishops (10x8 board)
1911           courier       Medieval intermediate between shatranj and
1912                         modern Chess (on 12x8 board)
1913           falcon        Patented 10x8 variant with two Falcon pieces
1914           berolina      Pawns capture straight ahead, and move diagonal
1915           cylinder      Pieces wrap around the board edge
1916           knightmate    King moves as Knight, and vice versa
1917           super         Superchess (shuffle variant with 4 exo-pieces)
1918           fairy         A catchall variant in which all piece types
1919                         known to XBoard can participate (8x8)
1920           unknown       Catchall for other unknown variants
1921
1922      NOT ALL BOARDSIZES PROVIDE A COMPLETE SET OF BUILT-IN BITMAPS FOR
1923      ALL UN-ORTHODOX PIECES, though. Only in `boardSize' middling and
1924      bulky all 22 piece types are provided, while -boardSize petite has
1925      most of them. Archbishop, Chancellor and Amazon are supported in
1926      every size from petite to bulky. Kings or Amazons are substituted
1927      for missing bitmaps. You can still play variants needing
1928      un-orthodox pieces in other board sizes providing your own bitmaps
1929      through the `bitmapDirectory' or `pixmapDirectory' options.
1930
1931      In the shuffle variants, XBoard now does shuffle the pieces,
1932      although you can still do it by hand using Edit Position.  Some
1933      variants are supported only in ICS mode, including bughouse, and
1934      kriegspiel.  The winning/drawing conditions in crazyhouse
1935      (off-board interposition on mate) are not fully understood, but
1936      losers, suicide, giveaway, atomic, and 3check should be OK.
1937      Berolina and cylinder chess can only be played with legality
1938      testing off.  In crazyhouse, XBoard now does keep track of
1939      off-board pieces.  In shatranj it does implement the baring rule
1940      when mate detection is switched on.
1941
1942 -boardHeight N
1943      Allows you to set a non-standard number of board ranks in any
1944      variant.  If the height is given as -1, the default height for the
1945      variant is used.  Default: -1
1946
1947 -boardWidth N
1948      Allows you to set a non-standard number of board files in any
1949      variant.  If the width is given as -1, the default width for the
1950      variant is used.  With a non-standard width, the initial position
1951      will always be an empty board, as the usual opening array will not
1952      fit.  Default: -1
1953
1954 -holdingsSize N
1955      Allows you to set a non-standard size for the holdings in any
1956      variant.  If the size is given as -1, the default holdings size
1957      for the variant is used.  The first N piece types will go into the
1958      holdings on capture, and you will be able to drop them on the
1959      board in stead of making a normal move. If size equals 0, there
1960      will be no holdings.  Default: -1
1961
1962 -defaultFrcPosition N
1963      Specifies the number of the opening position in shuffle games like
1964      Chess960.  A value of -1 means the position is randomly generated
1965      by XBoard at the beginning of every game.  Default: -1
1966
1967 -pieceToSquareTable string
1968      The characters that are used to represent the piece types XBoard
1969      knows in FEN diagrams and SAN moves. The string argument has to
1970      have an even length (or it will be ignored), as white and black
1971      pieces have to be given separately (in that order). The last
1972      letter for each color will be the King.  The letters before that
1973      will be PNBRQ and then a whole host of fairy pieces in an order
1974      that has not fully crystallized yet (currently FEACWMOHIJGDVSLU,
1975      F=Ferz, Elephant, A=Archbishop, C=Chancellor, W=Wazir, M=Commoner,
1976      O=Cannon, H=Nightrider). You should list at least all pieces that
1977      occur in the variant you are playing. If you have less than 44
1978      characters in the string, the pieces not mentioned will get
1979      assigned a period, and you will not be able to distinguish them in
1980      FENs. You can also explicitly assign pieces a period, in which
1981      case they will not be counted in deciding which captured pieces
1982      can go into the holdings.  A tilde '~' as a piece name does mean
1983      this piece is used to represent a promoted Pawn in crazyhouse-like
1984      games, i.e. on capture it turns back onto a Pawn.  A '+' similarly
1985      indicates the piece is a shogi-style promoted piece, that should
1986      revert to its non-promoted version on capture (rather than to a
1987      Pawn).  Note that promoted pieces are represented by pieces 11
1988      further in the list.  You should not have to use this option
1989      often: each variant has its own default setting for the piece
1990      representation in FEN, which should be sufficient in normal use.
1991      Default: ""
1992
1993 -debug/-xdebug or -debugMode true/false
1994      Turns on debugging printout.
1995
1996 -debugFile filename or -nameOfDebugFile filename
1997      Sets the name of the file to which WinBoard saves debug information
1998      (including all communication to and from the engines).
1999
2000 -engineDebugOutput number
2001      Specifies how WinBoard should handle unsolicited output from the
2002      engine, with respect to saving it in the debug file.  The output
2003      is further (hopefully) ignored.  If number=0, WinBoard refrains
2004      from writing such spurious output to the debug file.  If number=1,
2005      all engine output is written faithfully to the debug file.  If
2006      number=2, any protocol-violating line is prefixed with a '#'
2007      character, as the engine itself should have done if it wanted to
2008      submit info for inclusion in the debug file.  This option is
2009      provided for the benefit of applications that use the debug file
2010      as a source of information, such as the broadcaster of live games
2011      TLCV / TLCS.  Such applications can be protected from spurious
2012      engine output that might otherwise confuse them.
2013
2014 -rsh or -remoteShell shell-name
2015      Name of the command used to run programs remotely. The default is
2016      `rsh' or `remsh', determined when XBoard is configured and
2017      compiled.
2018
2019 -ruser or -remoteUser user-name
2020      User name on the remote system when running programs with the
2021      `remoteShell'. The default is your local user name.
2022
2023 -userName username
2024      Name under which the Human player will be listed in the PGN file.
2025      Default is the login name on your local computer.
2026
2027 -delayBeforeQuit number
2028 -delayAfterQuit number
2029      These options specify how long WinBoard has to wait before sending
2030      a termination signal to rogue engine processes, that do not want
2031      to react to the 'quit' command. The second one determines the
2032      pause after killing the engine, to make sure it dies.
2033
2034
2035 4 Chess Servers
2036 ***************
2037
2038 An "Internet Chess Server", or "ICS", is a place on the Internet where
2039 people can get together to play chess, watch other people's games, or
2040 just chat.  You can use either `telnet' or a client program like XBoard
2041 to connect to the server.  There are thousands of registered users on
2042 the different ICS hosts, and it is not unusual to meet 200 on both
2043 chessclub.com and freechess.org.
2044
2045    Most people can just type `xboard -ics' to start XBoard as an ICS
2046 client.  Invoking XBoard in this way connects you to the Internet Chess
2047 Club (ICC), a commercial ICS.  You can log in there as a guest even if
2048 you do not have a paid account.  To connect to the largest Free ICS
2049 (FICS), use the command `xboard -ics -icshost freechess.org' instead,
2050 or substitute a different host name to connect to your favorite ICS.
2051 For a full description of command-line options that control the
2052 connection to ICS and change the default values of ICS options, see
2053 *note ICS options::.
2054
2055    While you are running XBoard as an ICS client, you use the terminal
2056 window that you started XBoard from as a place to type in commands and
2057 read information that is not available on the chessboard.
2058
2059    The first time you need to use the terminal is to enter your login
2060 name and password, if you are a registered player. (You don't need to do
2061 this manually; the `icsLogon' option can do it for you.  *note ICS
2062 options::.)  If you are not registered, enter `g' as your name, and the
2063 server will pick a unique guest name for you.
2064
2065    Some useful ICS commands include
2066 `help <topic>'
2067      to get help on the given <topic>. To get a list of possible topics
2068      type "help" without topic.  Try the help command before you ask
2069      other people on the server for help.
2070
2071      For example `help register' tells you how to become a registered
2072      ICS player.
2073
2074 `who <flags>'
2075      to see a list of people who are logged on.  Administrators (people
2076      you should talk to if you have a problem) are marked with the
2077      character `*', an asterisk. The <flags> allow you to display only
2078      selected players: For example, `who of' shows a list of players
2079      who are interested in playing but do not have an opponent.
2080
2081 `games'
2082      to see what games are being played
2083
2084 `match <player> [<mins>] [<inc>]'
2085      to challenge another player to a game. Both opponents get <mins>
2086      minutes for the game, and <inc> seconds will be added after each
2087      move.  If another player challenges you, the server asks if you
2088      want to accept the challenge; use the `accept' or `decline'
2089      commands to answer.
2090
2091 `accept'
2092 `decline'
2093      to accept or decline another player's offer.  The offer may be to
2094      start a new game, or to agree to a `draw', `adjourn' or `abort'
2095      the current game. *Note Action Menu::.
2096
2097      If you have more than one pending offer (for example, if more than
2098      one player is challenging you, or if your opponent offers both a
2099      draw and to adjourn the game), you have to supply additional
2100      information, by typing something like `accept <player>', `accept
2101      draw', or `draw'.
2102
2103 `draw'
2104 `adjourn'
2105 `abort'
2106      asks your opponent to terminate a game by mutual agreement.
2107      Adjourned games can be continued later.  Your opponent can either
2108      `decline' your offer or accept it (by typing the same command or
2109      typing `accept').  In some cases these commands work immediately,
2110      without asking your opponent to agree.  For example, you can abort
2111      the game unilaterally if your opponent is out of time, and you can
2112      claim a draw by repetition or the 50-move rule if available simply
2113      by typing `draw'.
2114
2115 `finger <player>'
2116      to get information about the given <player>. (Default: yourself.)
2117
2118 `vars'
2119      to get a list of personal settings
2120
2121 `set <var> <value>'
2122      to modify these settings
2123
2124 `observe <player>'
2125      to observe an ongoing game of the given <player>.
2126
2127 `examine'
2128 `oldmoves'
2129      to review a recently completed game
2130
2131    Some special XBoard features are activated when you are in examine
2132 mode on ICS.  See the descriptions of the menu commands `Forward',
2133 `Backward', `Pause', `ICS Client', and `Stop Examining' on the *note
2134 Step Menu::, *note Mode Menu::, and *note Options Menu::.
2135
2136 5 Firewalls
2137 ***********
2138
2139 By default, XBoard communicates with an Internet Chess Server by
2140 opening a TCP socket directly from the machine it is running on to the
2141 ICS. If there is a firewall between your machine and the ICS, this
2142 won't work. Here are some recipes for getting around common kinds of
2143 firewalls using special options to XBoard.  Important: See the
2144 paragraph in the below about extra echoes, in *note Limitations::.
2145
2146    Suppose that you can't telnet directly to ICS, but you can telnet to
2147 a firewall host, log in, and then telnet from there to ICS.  Let's say
2148 the firewall is called `firewall.example.com'. Set command-line options
2149 as follows:
2150
2151      xboard -ics -icshost firewall.example.com -icsport 23
2152    Or in your `.Xresources' file:
2153
2154      XBoard*internetChessServerHost: firewall.example.com
2155      XBoard*internetChessServerPort: 23
2156    Then when you run XBoard in ICS mode, you will be prompted to log in
2157 to the firewall host. This works because port 23 is the standard telnet
2158 login service. Do so, then telnet to ICS, using a command like `telnet
2159 chessclub.com 5000', or whatever command the firewall provides for
2160 telnetting to port 5000.
2161
2162    If your firewall lets you telnet (or rlogin) to remote hosts but
2163 doesn't let you telnet to port 5000, you may be able to connect to the
2164 chess server on port 23 instead, which is the port the telnet program
2165 uses by default.  Some chess servers support this (including
2166 chessclub.com and freechess.org), while some do not.
2167
2168    If your chess server does not allow connections on port 23 and your
2169 firewall does not allow you to connect to other ports, you may be able
2170 to connect by hopping through another host outside the firewall that
2171 you have an account on.  For instance, suppose you have a shell account
2172 at `foo.edu'. Follow the recipe above, but instead of typing `telnet
2173 chessclub.com 5000' to the firewall, type `telnet foo.edu' (or `rlogin
2174 foo.edu'), log in there, and then type `telnet chessclub.com 5000'.
2175
2176    Suppose that you can't telnet directly to ICS, but you can use rsh
2177 to run programs on a firewall host, and that host can telnet to ICS.
2178 Let's say the firewall is called `rsh.example.com'. Set command-line
2179 options as follows:
2180
2181      xboard -ics -gateway rsh.example.com -icshost chessclub.com
2182
2183 Or in your `.Xresources' file:
2184
2185      XBoard*gateway: rsh.example.com
2186      XBoard*internetChessServerHost: chessclub.com
2187
2188    Then when you run XBoard in ICS mode, it will connect to the ICS by
2189 using `rsh' to run the command `telnet chessclub.com 5000' on host
2190 `rsh.example.com'.
2191
2192    Suppose that you can telnet anywhere you want, but you have to run a
2193 special program called `ptelnet' to do so.
2194
2195    First, we'll consider the easy case, in which `ptelnet chessclub.com
2196 5000' gets you to the chess server.  In this case set command line
2197 options as follows:
2198
2199      xboard -ics -telnet -telnetProgram ptelnet
2200
2201 Or in your `.Xresources' file:
2202
2203      XBoard*useTelnet: true
2204      XBoard*telnetProgram: ptelnet
2205
2206 Then when you run XBoard in ICS mode, it will issue the command
2207 `ptelnet chessclub.com 5000' to connect to the ICS.
2208
2209    Next, suppose that `ptelnet chessclub.com 5000' doesn't work; that
2210 is, your `ptelnet' program doesn't let you connect to alternative
2211 ports. As noted above, your chess server may allow you to connect on
2212 port 23 instead.  In that case, just add the option `-icsport ""' to
2213 the above command, or add `XBoard*internetChessServerPort:' to your
2214 `.Xresources' file.  But if your chess server doesn't let you connect
2215 on port 23, you will have to find some other host outside the firewall
2216 and hop through it. For instance, suppose you have a shell account at
2217 `foo.edu'. Set command line options as follows:
2218
2219      xboard -ics -telnet -telnetProgram ptelnet -icshost foo.edu -icsport ""
2220
2221 Or in your `.Xresources' file:
2222
2223      XBoard*useTelnet: true
2224      XBoard*telnetProgram: ptelnet
2225      XBoard*internetChessServerHost: foo.edu
2226      XBoard*internetChessServerPort:
2227
2228 Then when you run XBoard in ICS mode, it will issue the command
2229 `ptelnet foo.edu' to connect to your account at `foo.edu'. Log in
2230 there, then type `telnet chessclub.com 5000'.
2231
2232    ICC timestamp and FICS timeseal do not work through some firewalls.
2233 You can use them only if your firewall gives a clean TCP connection
2234 with a full 8-bit wide path.  If your firewall allows you to get out
2235 only by running a special telnet program, you can't use timestamp or
2236 timeseal across it.  But if you have access to a computer just outside
2237 your firewall, and you have much lower netlag when talking to that
2238 computer than to the ICS, it might be worthwhile running timestamp
2239 there.  Follow the instructions above for hopping through a host
2240 outside the firewall (foo.edu in the example), but run timestamp or
2241 timeseal on that host instead of telnet.
2242
2243    Suppose that you have a SOCKS firewall that will give you a clean
2244 8-bit wide TCP connection to the chess server, but only after you
2245 authenticate yourself via the SOCKS protocol.  In that case, you could
2246 make a socksified version of XBoard and run that.  If you are using
2247 timestamp or timeseal, you will to socksify it, not XBoard; this may be
2248 difficult seeing that ICC and FICS do not provide source code for these
2249 programs.  Socksification is beyond the scope of this document, but see
2250 the SOCKS Web site at http://www.socks.permeo.com/.  If you are missing
2251 SOCKS, try http://www.funbureau.com/.
2252
2253 6 Environment variables
2254 ***********************
2255
2256 Game and position files are found in a directory named by the
2257 `CHESSDIR' environment variable. If this variable is not set, the
2258 current working directory is used. If `CHESSDIR' is set, XBoard
2259 actually changes its working directory to `$CHESSDIR', so any files
2260 written by the chess engine will be placed there too.
2261
2262 7 Limitations and known bugs
2263 ****************************
2264
2265 There is no way for two people running copies of XBoard to play each
2266 other without going through an Internet Chess Server.
2267
2268    Under some circumstances, your ICS password may be echoed when you
2269 log on.
2270
2271    If you are connecting to the ICS by running telnet on an Internet
2272 provider or firewall host, you may find that each line you type is
2273 echoed back an extra time after you hit <Enter>. If your Internet
2274 provider is a Unix system, you can probably turn its echo off by typing
2275 `stty -echo' after you log in, and/or typing <^E><Enter> (Ctrl+E
2276 followed by the Enter key) to the telnet program after you have logged
2277 into ICS.  It is a good idea to do this if you can, because the extra
2278 echo can occasionally confuse XBoard's parsing routines.
2279
2280    The game parser recognizes only algebraic notation.
2281
2282    Many of the following points used to be limitations in XBoard 4.2.7
2283 and earlier, but are now fixed: The internal move legality tester in
2284 XBoard 4.3.xx does look at the game history, and is fully aware of
2285 castling or en-passant-capture rights. It permits castling with the
2286 king on the d file because this is possible in some "wild 1" games on
2287 ICS.  The piece-drop menu does not check piece drops in bughouse to see
2288 if you actually hold the piece you are trying to drop. But this way of
2289 dropping pieces should be considered an obsolete feature, now that
2290 pieces can be dropped by dragging them from the holdings to the board.
2291 Anyway, if you would attempt an illegal move when using a chess engine
2292 or the ICS, WinBoard will accept the error message that comes back,
2293 undo the move, and let you try another.  FEN positions saved by XBoard
2294 do include correct information about whether castling or en passant are
2295 legal, and also handle the 50-move counter.  The mate detector does not
2296 understand that non-contact mate is not really mate in bughouse.  The
2297 only problem this causes while playing is minor: a "#" (mate indicator)
2298 character will show up after a non-contact mating move in the move
2299 list. XBoard will not assume the game is over at that point, not even
2300 when the option Detect Mates is on.  Edit Game mode always uses the
2301 rules of the selected variant, which can be a variant that uses piece
2302 drops.  You can load and edit games that contain piece drops.  The
2303 (obsolete) piece menus are not active, but you can perform piece drops
2304 by dragging pieces from the holdings.  Edit Position mode does not
2305 allow you to edit the crazyhouse holdings properly.  You cannot drag
2306 pieces to the holding, and using the popup menu to put pieces there
2307 does not adapt the holding counts and leads to an inconsistent state.
2308 Set up crazyhouse positions by loading / pasting a bFEN, from there you
2309 can set the holdings.  Fischer Random castling is fully understood.
2310 You can enter castlings by dragging the King on top of your Rook.  You
2311 can probably also play Fischer Random successfully on ICS by typing
2312 castling moves into the ICS Interaction window.
2313
2314    The menus may not work if your keyboard is in Caps Lock or Num Lock
2315 mode.  This seems to be a problem with the Athena menu widget, not an
2316 XBoard bug.
2317
2318    Also see the ToDo file included with the distribution for many other
2319 possible bugs, limitations, and ideas for improvement that have been
2320 suggested.
2321
2322 8 Reporting problems
2323 ********************
2324
2325 Report bugs and problems with XBoard to `<bug-xboard@gnu.org>'.
2326
2327    Please use the `script' program to start a typescript, run XBoard
2328 with the `-debug' option, and include the typescript output in your
2329 message.  Also tell us what kind of machine and what operating system
2330 version you are using.  The command `uname -a' will often tell you this.
2331 Here is a sample of approximately what you should type:
2332
2333      script
2334      uname -a
2335      ./configure
2336      make
2337      ./xboard -debug
2338      exit
2339      mail bug-xboard@gnu.org
2340      Subject: Your short description of the problem
2341      Your detailed description of the problem
2342      ~r typescript
2343      .
2344
2345    The WinBoard / XBoard 4.3 line is being developed by H.G. Muller
2346 independently of the GNU Savannah xboard project.  Bug reports on this
2347 version, and suggestions for improvements and additions, are best
2348 posted in the WinBoard forum, WinBoard-development section
2349 (http://www.open-aurec.com/wbforum).
2350
2351    If you improve XBoard, please send a message about your changes, and
2352 we will get in touch with you about merging them in to the main line of
2353 development.  Also see our Web site at
2354 http://savannah.gnu.org/projects/xboard/.
2355
2356 9 Authors and contributors
2357 **************************
2358
2359 Tim Mann has been responsible for XBoard versions 1.3 and beyond, and
2360 for WinBoard, a port of XBoard to Microsoft Win32 (Windows NT and
2361 Windows 95). H.G.Muller is responsible for version 4.3.
2362
2363    Mark Williams contributed the initial (WinBoard-only) implementation
2364 of many new features added to both XBoard and WinBoard in version
2365 4.1.0, including copy/paste, premove, icsAlarm, autoFlipView, training
2366 mode, auto raise, and blindfold.  Ben Nye contributed X copy/paste code
2367 for XBoard.
2368
2369    Hugh Fisher added animated piece movement to XBoard, and Henrik Gram
2370 (henrikg@funcom.com) added it to WinBoard.  Frank McIngvale added
2371 click/click moving, the Analysis modes, piece flashing, ZIICS import,
2372 and ICS text colorization to XBoard.  Jochen Wiedmann ported XBoard to
2373 the Amiga, creating AmyBoard, and converted the documentation to
2374 texinfo.  Elmar Bartel contributed the new piece bitmaps introduced in
2375 version 3.2.  John Chanak contributed the initial implementation of ICS
2376 mode.  The color scheme and the old 80x80 piece bitmaps were taken from
2377 Wayne Christopher's `XChess' program.
2378
2379    Chris Sears and Dan Sears wrote the original XBoard.  They were
2380 responsible for versions 1.0 through 1.2.
2381
2382    Evan Welsh wrote `CMail'.  Patrick Surry helped in designing,
2383 testing, and documenting CMail.
2384
2385    Alessandro Scotti added many elements to the user interface of
2386 WinBoard, including the board textures and font-based rendering, the
2387 evaluation-graph, move-history and engine-output window.  He was also
2388 responsible for adding the UCI support.
2389
2390    H.G. Muller made WinBoard castling- and e.p.-aware, added variant
2391 support with adjustable board sizes, the crazyhouse holdings, and the
2392 fairy pieces.  In addition he added most of the adjudication options,
2393 made WinBoard more robust in dealing with buggy and crashing engines,
2394 and extended time control with a time-odds and node-count-based modes.
2395 Most of the options that initially were WinBoard only have now been
2396 back-ported to XBoard.
2397
2398    Michel van den Bergh provided the code for reading Polyglot opening
2399 books.
2400
2401    Arun Persaud worked with H.G. Muller to combine all the features of
2402 the never-released WinBoard 4.2.8 of the Savannah project (mainly by
2403 Daniel Mehrmann), and the never-released 4.3.16 into a unified WinBoard
2404 4.4, which is now available both from the Savannah web site and the
2405 WinBoard forum.
2406
2407 10 CMail
2408 ********
2409
2410 The `cmail' program can help you play chess by email with opponents of
2411 your choice using XBoard as an interface.
2412
2413    You will usually run `cmail' without giving any options.
2414
2415 10.1 CMail options
2416 ==================
2417
2418 -h
2419      Displays `cmail' usage information.
2420
2421 -c
2422      Shows the conditions of the GNU General Public License.  *Note
2423      Copying::.
2424
2425 -w
2426      Shows the warranty notice of the GNU General Public License.
2427      *Note Copying::.
2428
2429 -v
2430 -xv
2431      Provides or inhibits verbose output from `cmail' and XBoard,
2432      useful for debugging. The `-xv' form also inhibits the cmail
2433      introduction message.
2434
2435 -mail
2436 -xmail
2437      Invokes or inhibits the sending of a mail message containing the
2438      move.
2439
2440 -xboard
2441 -xxboard
2442      Invokes or inhibits the running of XBoard on the game file.
2443
2444 -reuse
2445 -xreuse
2446      Invokes or inhibits the reuse of an existing XBoard to display the
2447      current game.
2448
2449 -remail
2450      Resends the last mail message for that game. This inhibits running
2451      XBoard.
2452
2453 -game <name>
2454      The name of the game to be processed.
2455
2456 -wgames <number>
2457 -bgames <number>
2458 -games <number>
2459      Number of games to start as White, as Black or in total. Default
2460      is 1 as white and none as black. If only one color is specified
2461      then none of the other color is assumed. If no color is specified
2462      then equal numbers of White and Black games are started, with the
2463      extra game being as White if an odd number of total games is
2464      specified.
2465
2466 -me <short name>
2467 -opp <short name>
2468      A one-word alias for yourself or your opponent.
2469
2470 -wname <full name>
2471 -bname <full name>
2472 -name <full name>
2473 -oppname <full name>
2474      The full name of White, Black, yourself or your opponent.
2475
2476 -wna <net address>
2477 -bna <net address>
2478 -na <net address>
2479 -oppna <net address>
2480      The email address of White, Black, yourself or your opponent.
2481
2482 -dir <directory>
2483      The directory in which `cmail' keeps its files. This defaults to
2484      the environment variable `$CMAIL_DIR' or failing that, `$CHESSDIR',
2485      `$HOME/Chess' or `~/Chess'. It will be created if it does not
2486      exist.
2487
2488 -arcdir <directory>
2489      The directory in which `cmail' archives completed games. Defaults
2490      to the environment variable `$CMAIL_ARCDIR' or, in its absence,
2491      the same directory as cmail keeps its working files (above).
2492
2493 -mailprog <mail program>
2494      The program used by cmail to send email messages. This defaults to
2495      the environment variable `$CMAIL_MAILPROG' or failing that
2496      `/usr/ucb/Mail', `/usr/ucb/mail' or `Mail'. You will need to set
2497      this variable if none of the above paths fit your system.
2498
2499 -gamesFile <file>
2500      A file containing a list of games with email addresses. This
2501      defaults to the environment variable `$CMAIL_GAMES' or failing that
2502      `.cmailgames'.
2503
2504 -aliasesFile <file>
2505      A file containing one or more aliases for a set of email
2506      addresses. This defaults to the environment variable
2507      `$CMAIL_ALIASES' or failing that `.cmailaliases'.
2508
2509 -logFile <file>
2510      A file in which to dump verbose debugging messages that are
2511      invoked with the `-v' option.
2512
2513 -event <event>
2514      The PGN Event tag (default `Email correspondence game').
2515
2516 -site <site>
2517      The PGN Site tag (default `NET').
2518
2519 -round <round>
2520      The PGN Round tag (default `-', not applicable).
2521
2522 -mode <mode>
2523      The PGN Mode tag (default `EM', Electronic Mail).
2524
2525 Other options
2526      Any option flags not listed above are passed through to XBoard.
2527      Invoking XBoard through CMail changes the default values of two
2528      XBoard options: The default value for `-noChessProgram' is changed
2529      to true; that is, by default no chess engine is started.  The
2530      default value for `-timeDelay' is changed to 0; that is, by default
2531      XBoard immediately goes to the end of the game as played so far,
2532      rather than stepping through the moves one by one.  You can still
2533      set these options to whatever values you prefer by supplying them
2534      on CMail's command line.  *Note Options::.
2535
2536 10.2 Starting a CMail Game
2537 ==========================
2538
2539 Type `cmail' from a shell to start a game as white. After an opening
2540 message, you will be prompted for a game name, which is optional--if you
2541 simply press <Enter>, the game name will take the form
2542 `you-VS-opponent'. You will next be prompted for the short name of your
2543 opponent. If you haven't played this person before, you will also be
2544 prompted for his/her email address. `cmail' will then invoke XBoard in
2545 the background. Make your first move and select `Mail Move' from the
2546 `File' menu. *Note File Menu::. If all is well, `cmail' will mail a
2547 copy of the move to your opponent. If you select `Exit' without having
2548 selected `Mail Move' then no move will be made.
2549
2550 10.3 Answering a Move
2551 =====================
2552
2553 When you receive a message from an opponent containing a move in one of
2554 your games, simply pipe the message through `cmail'. In some mailers
2555 this is as simple as typing `| cmail' when viewing the message, while in
2556 others you may have to save the message to a file and do `cmail < file'
2557 at the command line. In either case `cmail' will display the game using
2558 XBoard. If you didn't exit XBoard when you made your first move then
2559 `cmail' will do its best to use the existing XBoard instead of starting
2560 a new one. As before, simply make a move and select `Mail Move' from
2561 the `File' menu. *Note File Menu::. `cmail' will try to use the XBoard
2562 that was most recently used to display the current game. This means
2563 that many games can be in progress simultaneously, each with its own
2564 active XBoard.
2565
2566    If you want to look at the history or explore a variation, go ahead,
2567 but you must return to the current position before XBoard will allow you
2568 to mail a move. If you edit the game's history you must select `Reload
2569 Same Game' from the `File' menu to get back to the original position,
2570 then make the move you want and select `Mail Move'.  As before, if you
2571 decide you aren't ready to make a move just yet you can either select
2572 `Exit' without sending a move or just leave XBoard running until you
2573 are ready.
2574
2575 10.4 Multi-Game Messages
2576 ========================
2577
2578 It is possible to have a `cmail' message carry more than one game.
2579 This feature was implemented to handle IECG (International Email Chess
2580 Group) matches, where a match consists of one game as white and one as
2581 black, with moves transmitted simultaneously. In case there are more
2582 general uses, `cmail' itself places no limit on the number of
2583 black/white games contained in a message; however, XBoard does.
2584
2585 10.5 Completing a Game
2586 ======================
2587
2588 Because XBoard can detect checkmate and stalemate, `cmail' handles game
2589 termination sensibly. As well as resignation, the `Action' menu allows
2590 draws to be offered and accepted for `cmail' games.
2591
2592    For multi-game messages, only unfinished and just-finished games
2593 will be included in email messages. When all the games are finished,
2594 they are archived in the user's archive directory, and similarly in the
2595 opponent's when he or she pipes the final message through `cmail'. The
2596 archive file name includes the date the game was started.
2597
2598 10.6 Known CMail Problems
2599 =========================
2600
2601 It's possible that a strange conjunction of conditions may occasionally
2602 mean that `cmail' has trouble reactivating an existing XBoard. If this
2603 should happen, simply trying it again should work.  If not, remove the
2604 file that stores the XBoard's PID (`game.pid') or use the `-xreuse'
2605 option to force `cmail' to start a new XBoard.
2606
2607    Versions of `cmail' after 2.16 no longer understand the old file
2608 format that XBoard used to use and so cannot be used to correspond with
2609 anyone using an older version.
2610
2611    Versions of `cmail' older than 2.11 do not handle multi-game
2612 messages, so multi-game correspondence is not possible with opponents
2613 using an older version.
2614
2615 11 Other programs you can use with XBoard
2616 *****************************************
2617
2618 Here are some other programs you can use with XBoard
2619
2620 11.1 GNU Chess
2621 ==============
2622
2623 The GNU Chess engine is available from:
2624
2625    ftp://ftp.gnu.org/gnu/gnuchess/
2626
2627    You can use XBoard to play a game against GNU Chess, or to interface
2628 GNU Chess to an ICS.
2629
2630 11.2 Fairy-Max
2631 ==============
2632
2633 Fairy-Max is a derivative from the once World's smallest Chess program
2634 micro-Max, which measures only about 100 lines of source code.  The
2635 main difference with micro-Max is that Fairy-Max loads its
2636 move-generator tables from a file, so that the rules for piece movement
2637 can be easily configured to implement unorthodox pieces.  Fairy-Max can
2638 therefore play a large number of variants, normal Chess being one of
2639 those.  In addition it plays Knightmate, Capablanca and Gothic Chess,
2640 Shatranj, Courier Chess, Cylinder chess, Berolina Chess, while the user
2641 can easily define new variants.  It can be obtained from:
2642
2643    http://home.hccnet.nl/h.g.muller/dwnldpage.html
2644
2645 11.3 HoiChess
2646 =============
2647
2648 HoiChess is a not-so-very-strong Chess engine, which comes with a
2649 derivative HoiXiangqi, able to play Chinese Chess. It can be obtained
2650 from the standard Linux repositories through:
2651
2652    sudo apt-get install hoichess
2653
2654 11.4 Crafty
2655 ===========
2656
2657 Crafty is a chess engine written by Bob Hyatt.  You can use XBoard to
2658 play a game against Crafty, hook Crafty up to an ICS, or use Crafty to
2659 interactively analyze games and positions for you.
2660
2661    Crafty is a strong, rapidly evolving chess program. This rapid pace
2662 of development is good, because it means Crafty is always getting
2663 better.  This can sometimes cause problems with backwards
2664 compatibility, but usually the latest version of Crafty will work well
2665 with the latest version of XBoard.  Crafty can be obtained from its
2666 author's FTP site: ftp://ftp.cis.uab.edu/hyatt/.
2667
2668    To use Crafty with XBoard, give the -fcp and -fd options as follows,
2669 where <crafty's directory> is the directory in which you installed
2670 Crafty and placed its book and other support files.
2671
2672 11.5 zic2xpm
2673 ============
2674
2675 The "zic2xpm" program is used to import chess sets from the ZIICS(*)
2676 program into XBoard. "zic2xpm" is part of the XBoard distribution.
2677 ZIICS is available from:
2678
2679    ftp://ftp.freechess.org/pub/chess/DOS/ziics131.exe
2680
2681    To import ZIICS pieces, do this:
2682 1. Unzip ziics131.exe into a directory:
2683           unzip -L ziics131.exe -d ~/ziics
2684
2685 2. Use zic2xpm to convert a set of pieces to XBoard format.
2686      For example, let's say you want to use the FRITZ4 set. These files
2687      are named "fritz4.*" in the ZIICS distribution.
2688
2689           mkdir ~/fritz4
2690           cd ~/fritz4
2691           zic2xpm ~/ziics/fritz4.*
2692
2693 3. Give XBoard the "-pixmap" option when starting up, e.g.:
2694           xboard -pixmap ~/fritz4
2695
2696      Alternatively, you can add this line to your `.Xresources' file:
2697
2698           xboard*pixmapDirectory: ~/fritz4
2699
2700    (*) ZIICS is a separate copyrighted work of Andy McFarland.  The
2701 "ZIICS pieces" are copyrighted works of their respective creators.
2702 Files produced by "zic2xpm" are for PERSONAL USE ONLY and may NOT be
2703 redistributed without explicit permission from the original creator(s)
2704 of the pieces.
2705
2706 Copyright
2707 *********
2708
2709 Copyright (C) 1991 Digital Equipment Corporation, Maynard,
2710 Massachusetts.
2711
2712    All Rights Reserved.
2713
2714    Permission to use, copy, modify, and distribute this software and its
2715 documentation for any purpose and without fee is hereby granted,
2716 provided that the above copyright notice appear in all copies and that
2717 both that copyright notice and this permission notice appear in
2718 supporting documentation, and that the name of Digital not be used in
2719 advertising or publicity pertaining to distribution of the software
2720 without specific, written prior permission.
2721
2722    Digital disclaims all warranties with regard to this software,
2723 including all implied warranties of merchantability and fitness.  In no
2724 event shall Digital be liable for any special, indirect or
2725 consequential damages or any damages whatsoever resulting from loss of
2726 use, data or profits, whether in an action of contract, negligence or
2727 other tortious action, arising out of or in connection with the use or
2728 performance of this software.
2729
2730    Enhancements copyright (C) 1992-2003,2004,2005,2006,2007,2008,2009
2731 Free Software Foundation, Inc.
2732
2733 Published by the Free Software Foundation
2734 59 Temple Place - Suite 330
2735 Boston, MA 02111-1307 USA
2736
2737    Permission is granted to make and distribute verbatim copies of this
2738 manual provided the copyright notice and this permission notice are
2739 preserved on all copies.
2740
2741    Permission is granted to copy and distribute modified versions of
2742 this manual under the conditions for verbatim copying, provided also
2743 that the section entitled "GNU General Public License," is included
2744 exactly as in the original, and provided that the entire resulting
2745 derived work is distributed under the terms of a permission notice
2746 identical to this one.
2747
2748    Permission is granted to copy and distribute translations of this
2749 manual into another language, under the above conditions for modified
2750 versions, except that the section entitled "GNU General Public License,"
2751 and this permission notice, may be included in translations approved by
2752 the Free Software Foundation instead of in the original English.
2753
2754 GNU GENERAL PUBLIC LICENSE
2755 **************************
2756
2757                         Version 3, 29 June 2007
2758
2759      Copyright (C) 2007 Free Software Foundation, Inc. `http://fsf.org/'
2760
2761      Everyone is permitted to copy and distribute verbatim copies of this
2762      license document, but changing it is not allowed.
2763
2764 Preamble
2765 ========
2766
2767 The GNU General Public License is a free, copyleft license for software
2768 and other kinds of works.
2769
2770    The licenses for most software and other practical works are designed
2771 to take away your freedom to share and change the works.  By contrast,
2772 the GNU General Public License is intended to guarantee your freedom to
2773 share and change all versions of a program--to make sure it remains
2774 free software for all its users.  We, the Free Software Foundation, use
2775 the GNU General Public License for most of our software; it applies
2776 also to any other work released this way by its authors.  You can apply
2777 it to your programs, too.
2778
2779    When we speak of free software, we are referring to freedom, not
2780 price.  Our General Public Licenses are designed to make sure that you
2781 have the freedom to distribute copies of free software (and charge for
2782 them if you wish), that you receive source code or can get it if you
2783 want it, that you can change the software or use pieces of it in new
2784 free programs, and that you know you can do these things.
2785
2786    To protect your rights, we need to prevent others from denying you
2787 these rights or asking you to surrender the rights.  Therefore, you
2788 have certain responsibilities if you distribute copies of the software,
2789 or if you modify it: responsibilities to respect the freedom of others.
2790
2791    For example, if you distribute copies of such a program, whether
2792 gratis or for a fee, you must pass on to the recipients the same
2793 freedoms that you received.  You must make sure that they, too, receive
2794 or can get the source code.  And you must show them these terms so they
2795 know their rights.
2796
2797    Developers that use the GNU GPL protect your rights with two steps:
2798 (1) assert copyright on the software, and (2) offer you this License
2799 giving you legal permission to copy, distribute and/or modify it.
2800
2801    For the developers' and authors' protection, the GPL clearly explains
2802 that there is no warranty for this free software.  For both users' and
2803 authors' sake, the GPL requires that modified versions be marked as
2804 changed, so that their problems will not be attributed erroneously to
2805 authors of previous versions.
2806
2807    Some devices are designed to deny users access to install or run
2808 modified versions of the software inside them, although the
2809 manufacturer can do so.  This is fundamentally incompatible with the
2810 aim of protecting users' freedom to change the software.  The
2811 systematic pattern of such abuse occurs in the area of products for
2812 individuals to use, which is precisely where it is most unacceptable.
2813 Therefore, we have designed this version of the GPL to prohibit the
2814 practice for those products.  If such problems arise substantially in
2815 other domains, we stand ready to extend this provision to those domains
2816 in future versions of the GPL, as needed to protect the freedom of
2817 users.
2818
2819    Finally, every program is threatened constantly by software patents.
2820 States should not allow patents to restrict development and use of
2821 software on general-purpose computers, but in those that do, we wish to
2822 avoid the special danger that patents applied to a free program could
2823 make it effectively proprietary.  To prevent this, the GPL assures that
2824 patents cannot be used to render the program non-free.
2825
2826    The precise terms and conditions for copying, distribution and
2827 modification follow.
2828
2829 TERMS AND CONDITIONS
2830 ====================
2831
2832   0. Definitions.
2833
2834      "This License" refers to version 3 of the GNU General Public
2835      License.
2836
2837      "Copyright" also means copyright-like laws that apply to other
2838      kinds of works, such as semiconductor masks.
2839
2840      "The Program" refers to any copyrightable work licensed under this
2841      License.  Each licensee is addressed as "you".  "Licensees" and
2842      "recipients" may be individuals or organizations.
2843
2844      To "modify" a work means to copy from or adapt all or part of the
2845      work in a fashion requiring copyright permission, other than the
2846      making of an exact copy.  The resulting work is called a "modified
2847      version" of the earlier work or a work "based on" the earlier work.
2848
2849      A "covered work" means either the unmodified Program or a work
2850      based on the Program.
2851
2852      To "propagate" a work means to do anything with it that, without
2853      permission, would make you directly or secondarily liable for
2854      infringement under applicable copyright law, except executing it
2855      on a computer or modifying a private copy.  Propagation includes
2856      copying, distribution (with or without modification), making
2857      available to the public, and in some countries other activities as
2858      well.
2859
2860      To "convey" a work means any kind of propagation that enables other
2861      parties to make or receive copies.  Mere interaction with a user
2862      through a computer network, with no transfer of a copy, is not
2863      conveying.
2864
2865      An interactive user interface displays "Appropriate Legal Notices"
2866      to the extent that it includes a convenient and prominently visible
2867      feature that (1) displays an appropriate copyright notice, and (2)
2868      tells the user that there is no warranty for the work (except to
2869      the extent that warranties are provided), that licensees may
2870      convey the work under this License, and how to view a copy of this
2871      License.  If the interface presents a list of user commands or
2872      options, such as a menu, a prominent item in the list meets this
2873      criterion.
2874
2875   1. Source Code.
2876
2877      The "source code" for a work means the preferred form of the work
2878      for making modifications to it.  "Object code" means any
2879      non-source form of a work.
2880
2881      A "Standard Interface" means an interface that either is an
2882      official standard defined by a recognized standards body, or, in
2883      the case of interfaces specified for a particular programming
2884      language, one that is widely used among developers working in that
2885      language.
2886
2887      The "System Libraries" of an executable work include anything,
2888      other than the work as a whole, that (a) is included in the normal
2889      form of packaging a Major Component, but which is not part of that
2890      Major Component, and (b) serves only to enable use of the work
2891      with that Major Component, or to implement a Standard Interface
2892      for which an implementation is available to the public in source
2893      code form.  A "Major Component", in this context, means a major
2894      essential component (kernel, window system, and so on) of the
2895      specific operating system (if any) on which the executable work
2896      runs, or a compiler used to produce the work, or an object code
2897      interpreter used to run it.
2898
2899      The "Corresponding Source" for a work in object code form means all
2900      the source code needed to generate, install, and (for an executable
2901      work) run the object code and to modify the work, including
2902      scripts to control those activities.  However, it does not include
2903      the work's System Libraries, or general-purpose tools or generally
2904      available free programs which are used unmodified in performing
2905      those activities but which are not part of the work.  For example,
2906      Corresponding Source includes interface definition files
2907      associated with source files for the work, and the source code for
2908      shared libraries and dynamically linked subprograms that the work
2909      is specifically designed to require, such as by intimate data
2910      communication or control flow between those subprograms and other
2911      parts of the work.
2912
2913      The Corresponding Source need not include anything that users can
2914      regenerate automatically from other parts of the Corresponding
2915      Source.
2916
2917      The Corresponding Source for a work in source code form is that
2918      same work.
2919
2920   2. Basic Permissions.
2921
2922      All rights granted under this License are granted for the term of
2923      copyright on the Program, and are irrevocable provided the stated
2924      conditions are met.  This License explicitly affirms your unlimited
2925      permission to run the unmodified Program.  The output from running
2926      a covered work is covered by this License only if the output,
2927      given its content, constitutes a covered work.  This License
2928      acknowledges your rights of fair use or other equivalent, as
2929      provided by copyright law.
2930
2931      You may make, run and propagate covered works that you do not
2932      convey, without conditions so long as your license otherwise
2933      remains in force.  You may convey covered works to others for the
2934      sole purpose of having them make modifications exclusively for
2935      you, or provide you with facilities for running those works,
2936      provided that you comply with the terms of this License in
2937      conveying all material for which you do not control copyright.
2938      Those thus making or running the covered works for you must do so
2939      exclusively on your behalf, under your direction and control, on
2940      terms that prohibit them from making any copies of your
2941      copyrighted material outside their relationship with you.
2942
2943      Conveying under any other circumstances is permitted solely under
2944      the conditions stated below.  Sublicensing is not allowed; section
2945      10 makes it unnecessary.
2946
2947   3. Protecting Users' Legal Rights From Anti-Circumvention Law.
2948
2949      No covered work shall be deemed part of an effective technological
2950      measure under any applicable law fulfilling obligations under
2951      article 11 of the WIPO copyright treaty adopted on 20 December
2952      1996, or similar laws prohibiting or restricting circumvention of
2953      such measures.
2954
2955      When you convey a covered work, you waive any legal power to forbid
2956      circumvention of technological measures to the extent such
2957      circumvention is effected by exercising rights under this License
2958      with respect to the covered work, and you disclaim any intention
2959      to limit operation or modification of the work as a means of
2960      enforcing, against the work's users, your or third parties' legal
2961      rights to forbid circumvention of technological measures.
2962
2963   4. Conveying Verbatim Copies.
2964
2965      You may convey verbatim copies of the Program's source code as you
2966      receive it, in any medium, provided that you conspicuously and
2967      appropriately publish on each copy an appropriate copyright notice;
2968      keep intact all notices stating that this License and any
2969      non-permissive terms added in accord with section 7 apply to the
2970      code; keep intact all notices of the absence of any warranty; and
2971      give all recipients a copy of this License along with the Program.
2972
2973      You may charge any price or no price for each copy that you convey,
2974      and you may offer support or warranty protection for a fee.
2975
2976   5. Conveying Modified Source Versions.
2977
2978      You may convey a work based on the Program, or the modifications to
2979      produce it from the Program, in the form of source code under the
2980      terms of section 4, provided that you also meet all of these
2981      conditions:
2982
2983        a. The work must carry prominent notices stating that you
2984           modified it, and giving a relevant date.
2985
2986        b. The work must carry prominent notices stating that it is
2987           released under this License and any conditions added under
2988           section 7.  This requirement modifies the requirement in
2989           section 4 to "keep intact all notices".
2990
2991        c. You must license the entire work, as a whole, under this
2992           License to anyone who comes into possession of a copy.  This
2993           License will therefore apply, along with any applicable
2994           section 7 additional terms, to the whole of the work, and all
2995           its parts, regardless of how they are packaged.  This License
2996           gives no permission to license the work in any other way, but
2997           it does not invalidate such permission if you have separately
2998           received it.
2999
3000        d. If the work has interactive user interfaces, each must display
3001           Appropriate Legal Notices; however, if the Program has
3002           interactive interfaces that do not display Appropriate Legal
3003           Notices, your work need not make them do so.
3004
3005      A compilation of a covered work with other separate and independent
3006      works, which are not by their nature extensions of the covered
3007      work, and which are not combined with it such as to form a larger
3008      program, in or on a volume of a storage or distribution medium, is
3009      called an "aggregate" if the compilation and its resulting
3010      copyright are not used to limit the access or legal rights of the
3011      compilation's users beyond what the individual works permit.
3012      Inclusion of a covered work in an aggregate does not cause this
3013      License to apply to the other parts of the aggregate.
3014
3015   6. Conveying Non-Source Forms.
3016
3017      You may convey a covered work in object code form under the terms
3018      of sections 4 and 5, provided that you also convey the
3019      machine-readable Corresponding Source under the terms of this
3020      License, in one of these ways:
3021
3022        a. Convey the object code in, or embodied in, a physical product
3023           (including a physical distribution medium), accompanied by the
3024           Corresponding Source fixed on a durable physical medium
3025           customarily used for software interchange.
3026
3027        b. Convey the object code in, or embodied in, a physical product
3028           (including a physical distribution medium), accompanied by a
3029           written offer, valid for at least three years and valid for
3030           as long as you offer spare parts or customer support for that
3031           product model, to give anyone who possesses the object code
3032           either (1) a copy of the Corresponding Source for all the
3033           software in the product that is covered by this License, on a
3034           durable physical medium customarily used for software
3035           interchange, for a price no more than your reasonable cost of
3036           physically performing this conveying of source, or (2) access
3037           to copy the Corresponding Source from a network server at no
3038           charge.
3039
3040        c. Convey individual copies of the object code with a copy of
3041           the written offer to provide the Corresponding Source.  This
3042           alternative is allowed only occasionally and noncommercially,
3043           and only if you received the object code with such an offer,
3044           in accord with subsection 6b.
3045
3046        d. Convey the object code by offering access from a designated
3047           place (gratis or for a charge), and offer equivalent access
3048           to the Corresponding Source in the same way through the same
3049           place at no further charge.  You need not require recipients
3050           to copy the Corresponding Source along with the object code.
3051           If the place to copy the object code is a network server, the
3052           Corresponding Source may be on a different server (operated
3053           by you or a third party) that supports equivalent copying
3054           facilities, provided you maintain clear directions next to
3055           the object code saying where to find the Corresponding Source.
3056           Regardless of what server hosts the Corresponding Source, you
3057           remain obligated to ensure that it is available for as long
3058           as needed to satisfy these requirements.
3059
3060        e. Convey the object code using peer-to-peer transmission,
3061           provided you inform other peers where the object code and
3062           Corresponding Source of the work are being offered to the
3063           general public at no charge under subsection 6d.
3064
3065
3066      A separable portion of the object code, whose source code is
3067      excluded from the Corresponding Source as a System Library, need
3068      not be included in conveying the object code work.
3069
3070      A "User Product" is either (1) a "consumer product", which means
3071      any tangible personal property which is normally used for personal,
3072      family, or household purposes, or (2) anything designed or sold for
3073      incorporation into a dwelling.  In determining whether a product
3074      is a consumer product, doubtful cases shall be resolved in favor of
3075      coverage.  For a particular product received by a particular user,
3076      "normally used" refers to a typical or common use of that class of
3077      product, regardless of the status of the particular user or of the
3078      way in which the particular user actually uses, or expects or is
3079      expected to use, the product.  A product is a consumer product
3080      regardless of whether the product has substantial commercial,
3081      industrial or non-consumer uses, unless such uses represent the
3082      only significant mode of use of the product.
3083
3084      "Installation Information" for a User Product means any methods,
3085      procedures, authorization keys, or other information required to
3086      install and execute modified versions of a covered work in that
3087      User Product from a modified version of its Corresponding Source.
3088      The information must suffice to ensure that the continued
3089      functioning of the modified object code is in no case prevented or
3090      interfered with solely because modification has been made.
3091
3092      If you convey an object code work under this section in, or with,
3093      or specifically for use in, a User Product, and the conveying
3094      occurs as part of a transaction in which the right of possession
3095      and use of the User Product is transferred to the recipient in
3096      perpetuity or for a fixed term (regardless of how the transaction
3097      is characterized), the Corresponding Source conveyed under this
3098      section must be accompanied by the Installation Information.  But
3099      this requirement does not apply if neither you nor any third party
3100      retains the ability to install modified object code on the User
3101      Product (for example, the work has been installed in ROM).
3102
3103      The requirement to provide Installation Information does not
3104      include a requirement to continue to provide support service,
3105      warranty, or updates for a work that has been modified or
3106      installed by the recipient, or for the User Product in which it
3107      has been modified or installed.  Access to a network may be denied
3108      when the modification itself materially and adversely affects the
3109      operation of the network or violates the rules and protocols for
3110      communication across the network.
3111
3112      Corresponding Source conveyed, and Installation Information
3113      provided, in accord with this section must be in a format that is
3114      publicly documented (and with an implementation available to the
3115      public in source code form), and must require no special password
3116      or key for unpacking, reading or copying.
3117
3118   7. Additional Terms.
3119
3120      "Additional permissions" are terms that supplement the terms of
3121      this License by making exceptions from one or more of its
3122      conditions.  Additional permissions that are applicable to the
3123      entire Program shall be treated as though they were included in
3124      this License, to the extent that they are valid under applicable
3125      law.  If additional permissions apply only to part of the Program,
3126      that part may be used separately under those permissions, but the
3127      entire Program remains governed by this License without regard to
3128      the additional permissions.
3129
3130      When you convey a copy of a covered work, you may at your option
3131      remove any additional permissions from that copy, or from any part
3132      of it.  (Additional permissions may be written to require their own
3133      removal in certain cases when you modify the work.)  You may place
3134      additional permissions on material, added by you to a covered work,
3135      for which you have or can give appropriate copyright permission.
3136
3137      Notwithstanding any other provision of this License, for material
3138      you add to a covered work, you may (if authorized by the copyright
3139      holders of that material) supplement the terms of this License
3140      with terms:
3141
3142        a. Disclaiming warranty or limiting liability differently from
3143           the terms of sections 15 and 16 of this License; or
3144
3145        b. Requiring preservation of specified reasonable legal notices
3146           or author attributions in that material or in the Appropriate
3147           Legal Notices displayed by works containing it; or
3148
3149        c. Prohibiting misrepresentation of the origin of that material,
3150           or requiring that modified versions of such material be
3151           marked in reasonable ways as different from the original
3152           version; or
3153
3154        d. Limiting the use for publicity purposes of names of licensors
3155           or authors of the material; or
3156
3157        e. Declining to grant rights under trademark law for use of some
3158           trade names, trademarks, or service marks; or
3159
3160        f. Requiring indemnification of licensors and authors of that
3161           material by anyone who conveys the material (or modified
3162           versions of it) with contractual assumptions of liability to
3163           the recipient, for any liability that these contractual
3164           assumptions directly impose on those licensors and authors.
3165
3166      All other non-permissive additional terms are considered "further
3167      restrictions" within the meaning of section 10.  If the Program as
3168      you received it, or any part of it, contains a notice stating that
3169      it is governed by this License along with a term that is a further
3170      restriction, you may remove that term.  If a license document
3171      contains a further restriction but permits relicensing or
3172      conveying under this License, you may add to a covered work
3173      material governed by the terms of that license document, provided
3174      that the further restriction does not survive such relicensing or
3175      conveying.
3176
3177      If you add terms to a covered work in accord with this section, you
3178      must place, in the relevant source files, a statement of the
3179      additional terms that apply to those files, or a notice indicating
3180      where to find the applicable terms.
3181
3182      Additional terms, permissive or non-permissive, may be stated in
3183      the form of a separately written license, or stated as exceptions;
3184      the above requirements apply either way.
3185
3186   8. Termination.
3187
3188      You may not propagate or modify a covered work except as expressly
3189      provided under this License.  Any attempt otherwise to propagate or
3190      modify it is void, and will automatically terminate your rights
3191      under this License (including any patent licenses granted under
3192      the third paragraph of section 11).
3193
3194      However, if you cease all violation of this License, then your
3195      license from a particular copyright holder is reinstated (a)
3196      provisionally, unless and until the copyright holder explicitly
3197      and finally terminates your license, and (b) permanently, if the
3198      copyright holder fails to notify you of the violation by some
3199      reasonable means prior to 60 days after the cessation.
3200
3201      Moreover, your license from a particular copyright holder is
3202      reinstated permanently if the copyright holder notifies you of the
3203      violation by some reasonable means, this is the first time you have
3204      received notice of violation of this License (for any work) from
3205      that copyright holder, and you cure the violation prior to 30 days
3206      after your receipt of the notice.
3207
3208      Termination of your rights under this section does not terminate
3209      the licenses of parties who have received copies or rights from
3210      you under this License.  If your rights have been terminated and
3211      not permanently reinstated, you do not qualify to receive new
3212      licenses for the same material under section 10.
3213
3214   9. Acceptance Not Required for Having Copies.
3215
3216      You are not required to accept this License in order to receive or
3217      run a copy of the Program.  Ancillary propagation of a covered work
3218      occurring solely as a consequence of using peer-to-peer
3219      transmission to receive a copy likewise does not require
3220      acceptance.  However, nothing other than this License grants you
3221      permission to propagate or modify any covered work.  These actions
3222      infringe copyright if you do not accept this License.  Therefore,
3223      by modifying or propagating a covered work, you indicate your
3224      acceptance of this License to do so.
3225
3226  10. Automatic Licensing of Downstream Recipients.
3227
3228      Each time you convey a covered work, the recipient automatically
3229      receives a license from the original licensors, to run, modify and
3230      propagate that work, subject to this License.  You are not
3231      responsible for enforcing compliance by third parties with this
3232      License.
3233
3234      An "entity transaction" is a transaction transferring control of an
3235      organization, or substantially all assets of one, or subdividing an
3236      organization, or merging organizations.  If propagation of a
3237      covered work results from an entity transaction, each party to that
3238      transaction who receives a copy of the work also receives whatever
3239      licenses to the work the party's predecessor in interest had or
3240      could give under the previous paragraph, plus a right to
3241      possession of the Corresponding Source of the work from the
3242      predecessor in interest, if the predecessor has it or can get it
3243      with reasonable efforts.
3244
3245      You may not impose any further restrictions on the exercise of the
3246      rights granted or affirmed under this License.  For example, you
3247      may not impose a license fee, royalty, or other charge for
3248      exercise of rights granted under this License, and you may not
3249      initiate litigation (including a cross-claim or counterclaim in a
3250      lawsuit) alleging that any patent claim is infringed by making,
3251      using, selling, offering for sale, or importing the Program or any
3252      portion of it.
3253
3254  11. Patents.
3255
3256      A "contributor" is a copyright holder who authorizes use under this
3257      License of the Program or a work on which the Program is based.
3258      The work thus licensed is called the contributor's "contributor
3259      version".
3260
3261      A contributor's "essential patent claims" are all patent claims
3262      owned or controlled by the contributor, whether already acquired or
3263      hereafter acquired, that would be infringed by some manner,
3264      permitted by this License, of making, using, or selling its
3265      contributor version, but do not include claims that would be
3266      infringed only as a consequence of further modification of the
3267      contributor version.  For purposes of this definition, "control"
3268      includes the right to grant patent sublicenses in a manner
3269      consistent with the requirements of this License.
3270
3271      Each contributor grants you a non-exclusive, worldwide,
3272      royalty-free patent license under the contributor's essential
3273      patent claims, to make, use, sell, offer for sale, import and
3274      otherwise run, modify and propagate the contents of its
3275      contributor version.
3276
3277      In the following three paragraphs, a "patent license" is any
3278      express agreement or commitment, however denominated, not to
3279      enforce a patent (such as an express permission to practice a
3280      patent or covenant not to sue for patent infringement).  To
3281      "grant" such a patent license to a party means to make such an
3282      agreement or commitment not to enforce a patent against the party.
3283
3284      If you convey a covered work, knowingly relying on a patent
3285      license, and the Corresponding Source of the work is not available
3286      for anyone to copy, free of charge and under the terms of this
3287      License, through a publicly available network server or other
3288      readily accessible means, then you must either (1) cause the
3289      Corresponding Source to be so available, or (2) arrange to deprive
3290      yourself of the benefit of the patent license for this particular
3291      work, or (3) arrange, in a manner consistent with the requirements
3292      of this License, to extend the patent license to downstream
3293      recipients.  "Knowingly relying" means you have actual knowledge
3294      that, but for the patent license, your conveying the covered work
3295      in a country, or your recipient's use of the covered work in a
3296      country, would infringe one or more identifiable patents in that
3297      country that you have reason to believe are valid.
3298
3299      If, pursuant to or in connection with a single transaction or
3300      arrangement, you convey, or propagate by procuring conveyance of, a
3301      covered work, and grant a patent license to some of the parties
3302      receiving the covered work authorizing them to use, propagate,
3303      modify or convey a specific copy of the covered work, then the
3304      patent license you grant is automatically extended to all
3305      recipients of the covered work and works based on it.
3306
3307      A patent license is "discriminatory" if it does not include within
3308      the scope of its coverage, prohibits the exercise of, or is
3309      conditioned on the non-exercise of one or more of the rights that
3310      are specifically granted under this License.  You may not convey a
3311      covered work if you are a party to an arrangement with a third
3312      party that is in the business of distributing software, under
3313      which you make payment to the third party based on the extent of
3314      your activity of conveying the work, and under which the third
3315      party grants, to any of the parties who would receive the covered
3316      work from you, a discriminatory patent license (a) in connection
3317      with copies of the covered work conveyed by you (or copies made
3318      from those copies), or (b) primarily for and in connection with
3319      specific products or compilations that contain the covered work,
3320      unless you entered into that arrangement, or that patent license
3321      was granted, prior to 28 March 2007.
3322
3323      Nothing in this License shall be construed as excluding or limiting
3324      any implied license or other defenses to infringement that may
3325      otherwise be available to you under applicable patent law.
3326
3327  12. No Surrender of Others' Freedom.
3328
3329      If conditions are imposed on you (whether by court order,
3330      agreement or otherwise) that contradict the conditions of this
3331      License, they do not excuse you from the conditions of this
3332      License.  If you cannot convey a covered work so as to satisfy
3333      simultaneously your obligations under this License and any other
3334      pertinent obligations, then as a consequence you may not convey it
3335      at all.  For example, if you agree to terms that obligate you to
3336      collect a royalty for further conveying from those to whom you
3337      convey the Program, the only way you could satisfy both those
3338      terms and this License would be to refrain entirely from conveying
3339      the Program.
3340
3341  13. Use with the GNU Affero General Public License.
3342
3343      Notwithstanding any other provision of this License, you have
3344      permission to link or combine any covered work with a work licensed
3345      under version 3 of the GNU Affero General Public License into a
3346      single combined work, and to convey the resulting work.  The terms
3347      of this License will continue to apply to the part which is the
3348      covered work, but the special requirements of the GNU Affero
3349      General Public License, section 13, concerning interaction through
3350      a network will apply to the combination as such.
3351
3352  14. Revised Versions of this License.
3353
3354      The Free Software Foundation may publish revised and/or new
3355      versions of the GNU General Public License from time to time.
3356      Such new versions will be similar in spirit to the present
3357      version, but may differ in detail to address new problems or
3358      concerns.
3359
3360      Each version is given a distinguishing version number.  If the
3361      Program specifies that a certain numbered version of the GNU
3362      General Public License "or any later version" applies to it, you
3363      have the option of following the terms and conditions either of
3364      that numbered version or of any later version published by the
3365      Free Software Foundation.  If the Program does not specify a
3366      version number of the GNU General Public License, you may choose
3367      any version ever published by the Free Software Foundation.
3368
3369      If the Program specifies that a proxy can decide which future
3370      versions of the GNU General Public License can be used, that
3371      proxy's public statement of acceptance of a version permanently
3372      authorizes you to choose that version for the Program.
3373
3374      Later license versions may give you additional or different
3375      permissions.  However, no additional obligations are imposed on any
3376      author or copyright holder as a result of your choosing to follow a
3377      later version.
3378
3379  15. Disclaimer of Warranty.
3380
3381      THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
3382      APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE
3383      COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS"
3384      WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED,
3385      INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
3386      MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE
3387      RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.
3388      SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL
3389      NECESSARY SERVICING, REPAIR OR CORRECTION.
3390
3391  16. Limitation of Liability.
3392
3393      IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
3394      WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES
3395      AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU
3396      FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR
3397      CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE
3398      THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA
3399      BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
3400      PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
3401      PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF
3402      THE POSSIBILITY OF SUCH DAMAGES.
3403
3404  17. Interpretation of Sections 15 and 16.
3405
3406      If the disclaimer of warranty and limitation of liability provided
3407      above cannot be given local legal effect according to their terms,
3408      reviewing courts shall apply local law that most closely
3409      approximates an absolute waiver of all civil liability in
3410      connection with the Program, unless a warranty or assumption of
3411      liability accompanies a copy of the Program in return for a fee.
3412
3413
3414 END OF TERMS AND CONDITIONS
3415 ===========================
3416
3417 How to Apply These Terms to Your New Programs
3418 =============================================
3419
3420 If you develop a new program, and you want it to be of the greatest
3421 possible use to the public, the best way to achieve this is to make it
3422 free software which everyone can redistribute and change under these
3423 terms.
3424
3425    To do so, attach the following notices to the program.  It is safest
3426 to attach them to the start of each source file to most effectively
3427 state the exclusion of warranty; and each file should have at least the
3428 "copyright" line and a pointer to where the full notice is found.
3429
3430      ONE LINE TO GIVE THE PROGRAM'S NAME AND A BRIEF IDEA OF WHAT IT DOES.
3431      Copyright (C) YEAR NAME OF AUTHOR
3432
3433      This program is free software: you can redistribute it and/or modify
3434      it under the terms of the GNU General Public License as published by
3435      the Free Software Foundation, either version 3 of the License, or (at
3436      your option) any later version.
3437
3438      This program is distributed in the hope that it will be useful, but
3439      WITHOUT ANY WARRANTY; without even the implied warranty of
3440      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
3441      General Public License for more details.
3442
3443      You should have received a copy of the GNU General Public License
3444      along with this program.  If not, see `http://www.gnu.org/licenses/'.
3445
3446    Also add information on how to contact you by electronic and paper
3447 mail.
3448
3449    If the program does terminal interaction, make it output a short
3450 notice like this when it starts in an interactive mode:
3451
3452      PROGRAM Copyright (C) YEAR NAME OF AUTHOR
3453      This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
3454      This is free software, and you are welcome to redistribute it
3455      under certain conditions; type `show c' for details.
3456
3457    The hypothetical commands `show w' and `show c' should show the
3458 appropriate parts of the General Public License.  Of course, your
3459 program's commands might be different; for a GUI interface, you would
3460 use an "about box".
3461
3462    You should also get your employer (if you work as a programmer) or
3463 school, if any, to sign a "copyright disclaimer" for the program, if
3464 necessary.  For more information on this, and how to apply and follow
3465 the GNU GPL, see `http://www.gnu.org/licenses/'.
3466
3467    The GNU General Public License does not permit incorporating your
3468 program into proprietary programs.  If your program is a subroutine
3469 library, you may consider it more useful to permit linking proprietary
3470 applications with the library.  If this is what you want to do, use the
3471 GNU Lesser General Public License instead of this License.  But first,
3472 please read `http://www.gnu.org/philosophy/why-not-lgpl.html'.
3473
3474 Index
3475 *****
3476
3477 -animateSpeed, option:                         See 3.5.      (line 1806)
3478 .cmailaliases:                                 See 10.1.     (line 2505)
3479 .cmailgames:                                   See 10.1.     (line 2500)
3480 .icsrc:                                        See 3.3.      (line 1318)
3481 <, Button:                                     See 2.4.      (line  468)
3482 <<, Button:                                    See 2.4.      (line  501)
3483 >, Button:                                     See 2.4.      (line  488)
3484 >>, Button:                                    See 2.4.      (line  520)
3485 abort, ICS command:                            See 4.        (line 2106)
3486 Abort, Menu Item:                              See 2.3.      (line  440)
3487 About XBoard, Menu Item:                       See 2.6.      (line  842)
3488 accept, ICS command:                           See 4.        (line 2093)
3489 Accept, Menu Item:                             See 2.3.      (line  415)
3490 Action, Menu:                                  See 2.3.      (line  414)
3491 adjourn, ICS command:                          See 4.        (line 2106)
3492 Adjourn, Menu Item:                            See 2.3.      (line  436)
3493 Adjudicate Draw, Menu Item:                    See 2.3.      (line  459)
3494 Adjudicate to Black, Menu Item:                See 2.3.      (line  459)
3495 Adjudicate to White, Menu Item:                See 2.3.      (line  459)
3496 adjudicateDrawMoves, option:                   See 3.6.      (line 1821)
3497 adjudicateLossThreshold, option:               See 3.6.      (line 1813)
3498 Adjudications, Menu Item:                      See 2.5.      (line  560)
3499 alarm, option:                                 See 3.3.      (line 1361)
3500 Always Queen, Menu Item:                       See 2.5.      (line  606)
3501 alwaysPromoteToQueen, option:                  See 3.5.      (line 1602)
3502 Analysis Mode, Menu Item:                      See 2.2.      (line  239)
3503 Analyze File, Menu Item:                       See 2.2.      (line  260)
3504 Animate Dragging, Menu Item:                   See 2.5.      (line  612)
3505 Animate Moving, Menu Item:                     See 2.5.      (line  619)
3506 animate, option:                               See 3.5.      (line 1802)
3507 animateDragging, option:                       See 3.5.      (line 1798)
3508 animateMoving, option:                         See 3.5.      (line 1802)
3509 Authors:                                       See 9.        (line 2359)
3510 Auto Comment, Menu Item:                       See 2.5.      (line  627)
3511 Auto Flag, Menu Item:                          See 2.5.      (line  635)
3512 Auto Flip View, Menu Item:                     See 2.5.      (line  644)
3513 Auto Observe, Menu Item:                       See 2.5.      (line  649)
3514 Auto Raise Board, Menu Item:                   See 2.5.      (line  662)
3515 Auto Save, Menu Item:                          See 2.5.      (line  667)
3516 autobs, option:                                See 3.3.      (line 1345)
3517 autoCallFlag, option:                          See 3.3.      (line 1341)
3518 autocomm, option:                              See 3.3.      (line 1337)
3519 autoComment, option:                           See 3.3.      (line 1337)
3520 autoflag, option:                              See 3.3.      (line 1341)
3521 autoflip, option:                              See 3.5.      (line 1648)
3522 autoFlipView, option:                          See 3.5.      (line 1648)
3523 autoKibitz, option:                            See 3.3.      (line 1349)
3524 autoObserve, option:                           See 3.3.      (line 1345)
3525 autoraise, option:                             See 3.5.      (line 1644)
3526 autoRaiseBoard, option:                        See 3.5.      (line 1644)
3527 autosave, option:                              See 3.4.      (line 1526)
3528 autoSaveGames, option:                         See 3.4.      (line 1526)
3529 Back to Start, Menu Item:                      See 2.4.      (line  501)
3530 Backward, Menu Item:                           See 2.4.      (line  468)
3531 bell, option:                                  See 3.5.      (line 1589)
3532 bitmapDirectory, option:                       See 3.5.      (line 1729)
3533 blackPieceColor, option:                       See 3.5.      (line 1776)
3534 blind, option:                                 See 3.5.      (line 1696)
3535 Blindfold, Menu Item:                          See 2.5.      (line  674)
3536 blindfold, option:                             See 3.5.      (line 1696)
3537 bm, option:                                    See 3.5.      (line 1729)
3538 board size:                                    See 3.5.      (line 1610)
3539 boardHeight, option:                           See 3.7.      (line 1943)
3540 boardSize, option:                             See 3.5.      (line 1610)
3541 boardWidth, option:                            See 3.7.      (line 1948)
3542 Book, Menu Item:                               See 2.6.      (line  832)
3543 Bug reports:                                   See 8.        (line 2325)
3544 Bugs <1>:                                      See 8.        (line 2325)
3545 Bugs:                                          See 7.        (line 2265)
3546 buttons, option:                               See 3.5.      (line 1670)
3547 Call Flag, Menu Item:                          See 2.3.      (line  425)
3548 checkMates, option:                            See 3.6.      (line 1826)
3549 Chess engine options:                          See 3.1.      (line  919)
3550 CHESSDIR:                                      See 6.        (line 2256)
3551 clock, option:                                 See 3.1.      (line  936)
3552 clockFont, option:                             See 3.5.      (line 1700)
3553 clockMode, option:                             See 3.1.      (line  936)
3554 cmail:                                         See 10.       (line 2410)
3555 colorChallenge, option:                        See 3.3.      (line 1394)
3556 colorChannel, option:                          See 3.3.      (line 1394)
3557 colorChannel1, option:                         See 3.3.      (line 1394)
3558 colorize, option:                              See 3.3.      (line 1380)
3559 colorKibitz, option:                           See 3.3.      (line 1394)
3560 colorNormal, option:                           See 3.3.      (line 1394)
3561 colorRequest, option:                          See 3.3.      (line 1394)
3562 Colors <1>:                                    See 3.5.      (line 1776)
3563 Colors:                                        See 3.3.      (line 1380)
3564 colorSeek, option:                             See 3.3.      (line 1394)
3565 colorShout, option:                            See 3.3.      (line 1394)
3566 colorSShout, option:                           See 3.3.      (line 1394)
3567 colorTell, option:                             See 3.3.      (line 1394)
3568 Contributors:                                  See 9.        (line 2359)
3569 coordFont, option:                             See 3.5.      (line 1706)
3570 coords, option:                                See 3.5.      (line 1640)
3571 Copy Game, Menu Item:                          See 2.1.      (line  167)
3572 Copy Position, Menu Item:                      See 2.1.      (line  207)
3573 darkSquareColor, option:                       See 3.5.      (line 1776)
3574 debug, option:                                 See 3.7.      (line 1994)
3575 debugFile, option:                             See 3.7.      (line 1997)
3576 debugMode, option:                             See 3.7.      (line 1994)
3577 decline, ICS command:                          See 4.        (line 2093)
3578 Decline, Menu Item:                            See 2.3.      (line  420)
3579 defaultCacheSizeEGTB, option:                  See 3.2.      (line 1199)
3580 defaultFrcPosition, option:                    See 3.7.      (line 1963)
3581 defaultHashSize, option:                       See 3.2.      (line 1193)
3582 defaultPathEGTB, option:                       See 3.2.      (line 1205)
3583 delayAfterQuit, option:                        See 3.7.      (line 2029)
3584 delayBeforeQuit, option:                       See 3.7.      (line 2029)
3585 display, option:                               See 3.5.      (line 1580)
3586 drag, option:                                  See 3.5.      (line 1798)
3587 draw, ICS command:                             See 4.        (line 2106)
3588 Draw, Menu Item:                               See 2.3.      (line  431)
3589 Edit Comment, Menu Item:                       See 2.2.      (line  376)
3590 Edit Game, Menu Item:                          See 2.2.      (line  294)
3591 Edit Position, Menu Item:                      See 2.2.      (line  310)
3592 Edit Tags, Menu Item:                          See 2.2.      (line  352)
3593 egtFormats, option:                            See 3.2.      (line 1209)
3594 Engine Settings:                               See 3.2.      (line 1160)
3595 engineDebugOutput, option:                     See 3.7.      (line 2001)
3596 Environment variables:                         See 6.        (line 2256)
3597 examine, ICS command:                          See 4.        (line 2129)
3598 Exit, Menu Item:                               See 2.1.      (line  224)
3599 exit, option:                                  See 3.5.      (line 1594)
3600 fb, option:                                    See 3.1.      (line 1043)
3601 fcp, option:                                   See 3.1.      (line 1036)
3602 fd, option:                                    See 3.1.      (line 1058)
3603 fh, option:                                    See 3.1.      (line 1050)
3604 File Menu:                                     See 2.1.      (line   82)
3605 finger, ICS command:                           See 4.        (line 2116)
3606 firstChessProgram, option:                     See 3.1.      (line 1036)
3607 firstComputerString, option:                   See 3.1.      (line 1094)
3608 firstDirectory, option:                        See 3.1.      (line 1058)
3609 firstHasOwnBookUCI, option:                    See 3.2.      (line 1188)
3610 firstHost, option:                             See 3.1.      (line 1050)
3611 firstIsUCI, option:                            See 3.2.      (line 1162)
3612 firstNeedsNoncompliantFEN, option:             See 3.1.      (line 1144)
3613 firstNPS, option:                              See 3.1.      (line  959)
3614 firstOptions, option:                          See 3.1.      (line 1133)
3615 firstPlaysBlack, option:                       See 3.1.      (line 1043)
3616 firstProtocolVersion, option:                  See 3.1.      (line 1111)
3617 firstScoreAbs, option:                         See 3.1.      (line 1119)
3618 firstTimeOdds, option:                         See 3.1.      (line  977)
3619 firstXBook, option:                            See 3.2.      (line 1188)
3620 Flash Moves, Menu Item:                        See 2.5.      (line  680)
3621 flash, option:                                 See 3.5.      (line 1683)
3622 flashCount, option:                            See 3.5.      (line 1683)
3623 flashRate, option:                             See 3.5.      (line 1683)
3624 Flip View, Menu Item:                          See 2.5.      (line  555)
3625 flip, option:                                  See 3.5.      (line 1652)
3626 flipView, option:                              See 3.5.      (line 1652)
3627 fNoOwnBookUCI, option:                         See 3.2.      (line 1188)
3628 Font:                                          See 3.5.      (line 1713)
3629 Font, clock:                                   See 3.5.      (line 1700)
3630 Font, coordinates:                             See 3.5.      (line 1706)
3631 font, option:                                  See 3.5.      (line 1713)
3632 fontSizeTolerance, option:                     See 3.5.      (line 1719)
3633 Forward to End, Menu Item:                     See 2.4.      (line  520)
3634 Forward, Menu Item:                            See 2.4.      (line  488)
3635 fUCI, option:                                  See 3.2.      (line 1162)
3636 gameListTags, option:                          See 3.4.      (line 1568)
3637 games, ICS command:                            See 4.        (line 2082)
3638 gateway, option:                               See 3.3.      (line 1268)
3639 geometry, option:                              See 3.5.      (line 1580)
3640 Get Move List, Menu Item:                      See 2.5.      (line  694)
3641 getMoveList, option:                           See 3.3.      (line 1357)
3642 Help Menu:                                     See 2.6.      (line  814)
3643 help, ICS command:                             See 4.        (line 2067)
3644 Hide Thinking, Menu Item:                      See 2.5.      (line  791)
3645 Highlight Last Move, Menu Item:                See 2.5.      (line  706)
3646 highlight, option:                             See 3.5.      (line 1692)
3647 highlightLastMove, option:                     See 3.5.      (line 1692)
3648 highlightSquareColor, option:                  See 3.5.      (line 1776)
3649 Hint, Menu Item:                               See 2.6.      (line  829)
3650 holdingsSize, option:                          See 3.7.      (line 1955)
3651 iconic, option:                                See 3.5.      (line 1580)
3652 ICS:                                           See 4.        (line 2038)
3653 ICS Alarm, Menu Item:                          See 2.5.      (line  727)
3654 ICS Client, Menu Item:                         See 2.2.      (line  270)
3655 ICS Input Box, Menu Item:                      See 2.2.      (line  381)
3656 ICS options:                                   See 3.3.      (line 1223)
3657 ICS, addresses:                                See 4.        (line 2038)
3658 ics, option:                                   See 3.3.      (line 1224)
3659 icsAlarm, option:                              See 3.3.      (line 1361)
3660 icsAlarmTime, option:                          See 3.3.      (line 1365)
3661 icscomm, option:                               See 3.3.      (line 1276)
3662 icshelper, option:                             See 3.3.      (line 1242)
3663 icshost, option:                               See 3.3.      (line 1229)
3664 icsinput, option:                              See 3.3.      (line 1333)
3665 icslogon, option:                              See 3.3.      (line 1318)
3666 icsport, option:                               See 3.3.      (line 1238)
3667 inc, option:                                   See 3.1.      (line  929)
3668 Info XBoard, Menu Item:                        See 2.6.      (line  815)
3669 initalMode, option:                            See 3.7.      (line 1878)
3670 initString, option:                            See 3.1.      (line 1067)
3671 Internet Chess Server:                         See 4.        (line 2038)
3672 internetChessServerCommPort, option:           See 3.3.      (line 1276)
3673 internetChessServerHelper, option:             See 3.3.      (line 1242)
3674 internetChessServerHost, option:               See 3.3.      (line 1229)
3675 internetChessServerInputBox, option:           See 3.3.      (line 1333)
3676 internetChessServerLogonScript, option:        See 3.3.      (line 1318)
3677 internetChessServerMode, option:               See 3.3.      (line 1224)
3678 internetChessServerPort, option:               See 3.3.      (line 1238)
3679 introduction:
3680           See ``Introduction''.                              (line    9)
3681 Keys:                                          See 2.7.      (line  847)
3682 legal, option:                                 See 3.5.      (line 1606)
3683 lgf, option:                                   See 3.4.      (line 1490)
3684 lgi, option:                                   See 3.4.      (line 1490)
3685 lightSquareColor, option:                      See 3.5.      (line 1776)
3686 Limitations:                                   See 7.        (line 2265)
3687 Load and Save options:                         See 3.4.      (line 1488)
3688 Load Game, Menu Item:                          See 2.1.      (line  115)
3689 Load Next Game, Menu Item:                     See 2.1.      (line  142)
3690 Load Next Position, Menu Item:                 See 2.1.      (line  188)
3691 Load Position, Menu Item:                      See 2.1.      (line  180)
3692 Load Previous Game, Menu Item:                 See 2.1.      (line  146)
3693 Load Previous Position, Menu Item:             See 2.1.      (line  191)
3694 loadGameFile, option:                          See 3.4.      (line 1490)
3695 loadGameIndex, option:                         See 3.4.      (line 1490)
3696 loadPositionFile, option:                      See 3.4.      (line 1531)
3697 loadPositionIndex, option:                     See 3.4.      (line 1531)
3698 lowTimeWarning, option:                        See 3.3.      (line 1369)
3699 lowTimeWarningColor, option:                   See 3.5.      (line 1776)
3700 lpf, option:                                   See 3.4.      (line 1531)
3701 lpi, option:                                   See 3.4.      (line 1531)
3702 Machine Black, Menu Item:                      See 2.2.      (line  233)
3703 Machine White, Menu Item:                      See 2.2.      (line  230)
3704 Mail Move, Menu Item:                          See 2.1.      (line  221)
3705 Major modes:                                   See 1.        (line   19)
3706 Man XBoard, Menu Item:                         See 2.6.      (line  822)
3707 matchGames, option:                            See 3.1.      (line 1014)
3708 matchMode, option:                             See 3.1.      (line 1026)
3709 materialDraws, option:                         See 3.6.      (line 1838)
3710 Menu, Action:                                  See 2.3.      (line  414)
3711 Menu, File:                                    See 2.1.      (line   82)
3712 Menu, Help:                                    See 2.6.      (line  814)
3713 Menu, Mode:                                    See 2.2.      (line  229)
3714 Menu, Options:                                 See 2.5.      (line  554)
3715 Menu, Step:                                    See 2.4.      (line  467)
3716 Menus:                                         See 2.        (line   57)
3717 mg, option:                                    See 3.1.      (line 1014)
3718 mm, option:                                    See 3.1.      (line 1026)
3719 Mode Menu:                                     See 2.2.      (line  229)
3720 mode, option:                                  See 3.7.      (line 1878)
3721 mono, option:                                  See 3.5.      (line 1676)
3722 monoMode, option:                              See 3.5.      (line 1676)
3723 Move Now, Menu Item:                           See 2.4.      (line  541)
3724 Move Sound, Menu Item:                         See 2.5.      (line  712)
3725 moves, option:                                 See 3.3.      (line 1357)
3726 movesound, option:                             See 3.5.      (line 1589)
3727 movesPerSession, option:                       See 3.1.      (line  925)
3728 mps, option:                                   See 3.1.      (line  925)
3729 msLoginDelay, option:                          See 3.3.      (line 1327)
3730 nameOfDebugFile, option:                       See 3.7.      (line 1997)
3731 ncp, option:                                   See 3.7.      (line 1873)
3732 New Game, Menu Item:                           See 2.1.      (line   83)
3733 New Shuffle Game, Menu Item:                   See 2.1.      (line   92)
3734 New variant, Menu Item:                        See 2.1.      (line  105)
3735 niceEngines, option:                           See 3.1.      (line 1125)
3736 noChessProgram, option:                        See 3.7.      (line 1873)
3737 noGUI, option:                                 See 3.5.      (line 1583)
3738 observe, ICS command:                          See 4.        (line 2125)
3739 Old Save Style, Menu Item:                     See 2.5.      (line  736)
3740 oldmoves, ICS command:                         See 4.        (line 2129)
3741 oldsave, option:                               See 3.4.      (line 1564)
3742 oldSaveStyle, option:                          See 3.4.      (line 1564)
3743 Options:                                       See 3.        (line  893)
3744 Options Menu:                                  See 2.5.      (line  554)
3745 Options, adjudication:                         See 3.6.      (line 1812)
3746 options, Chess engine:                         See 3.1.      (line  919)
3747 Options, ICS:                                  See 3.3.      (line 1223)
3748 Options, Load and Save:                        See 3.4.      (line 1488)
3749 Options, miscellaneous:                        See 3.7.      (line 1872)
3750 Options, User interface:                       See 3.5.      (line 1577)
3751 Other programs:                                See 11.       (line 2618)
3752 Paste Game, Menu Item:                         See 2.1.      (line  176)
3753 Paste Position, Menu Item:                     See 2.1.      (line  216)
3754 Pause, Menu Item:                              See 2.2.      (line  388)
3755 Periodic Updates, Menu Item:                   See 2.5.      (line  744)
3756 pgnEventHeader, option`:                       See 3.4.      (line 1556)
3757 pgnExtendedInfo, option`:                      See 3.4.      (line 1551)
3758 pieceToSquareTable, option:                    See 3.7.      (line 1968)
3759 pixmap, option:                                See 3.5.      (line 1729)
3760 pixmapDirectory, option:                       See 3.5.      (line 1729)
3761 PolyglotBook, option:                          See 3.2.      (line 1177)
3762 PolyglotDir, option:                           See 3.2.      (line 1169)
3763 Ponder Next Move, Menu Item:                   See 2.5.      (line  750)
3764 ponder, option:                                See 3.1.      (line 1005)
3765 ponderNextMove, option:                        See 3.1.      (line 1005)
3766 Popup Exit Message, Menu Item:                 See 2.5.      (line  755)
3767 Popup Move Errors, Menu Item:                  See 2.5.      (line  761)
3768 popup, option:                                 See 3.5.      (line 1598)
3769 popupExitMessage, option:                      See 3.5.      (line 1594)
3770 popupMoveErrors, option:                       See 3.5.      (line 1598)
3771 pre, option:                                   See 3.3.      (line 1373)
3772 Premove, Menu Item:                            See 2.5.      (line  770)
3773 premove, option:                               See 3.3.      (line 1373)
3774 Problems:                                      See 8.        (line 2325)
3775 queen, option:                                 See 3.5.      (line 1602)
3776 Quiet Play, Menu Item:                         See 2.5.      (line  781)
3777 quiet, option:                                 See 3.3.      (line 1376)
3778 quietPlay, option:                             See 3.3.      (line 1376)
3779 Reload CMail Message, Menu Item:               See 2.1.      (line  221)
3780 Reload Same Game, Menu Item:                   See 2.1.      (line  151)
3781 Reload Same Position, Menu Item:               See 2.1.      (line  195)
3782 remoteShell, option:                           See 3.7.      (line 2015)
3783 remoteUser, option:                            See 3.7.      (line 2020)
3784 Reporting bugs:                                See 8.        (line 2325)
3785 Reporting problems:                            See 8.        (line 2325)
3786 Resign, Menu Item:                             See 2.3.      (line  445)
3787 Retract Move, Menu Item:                       See 2.4.      (line  545)
3788 reuse, option:                                 See 3.1.      (line 1102)
3789 reuse2, option:                                See 3.1.      (line 1102)
3790 reuseFirst, option:                            See 3.1.      (line 1102)
3791 reuseSecond, option:                           See 3.1.      (line 1102)
3792 Revert, Menu Item:                             See 2.4.      (line  532)
3793 ringBellAfterMoves, option:                    See 3.5.      (line 1589)
3794 rsh, option:                                   See 3.7.      (line 2015)
3795 ruleMoves, option:                             See 3.6.      (line 1856)
3796 ruser, option:                                 See 3.7.      (line 2020)
3797 sameColorGames, option:                        See 3.1.      (line 1030)
3798 Save Game, Menu Item:                          See 2.1.      (line  155)
3799 saveGameFile, option:                          See 3.4.      (line 1521)
3800 saveOutOfBookInfo, option`:                    See 3.4.      (line 1560)
3801 savePositionFile, option:                      See 3.4.      (line 1546)
3802 scp, option:                                   See 3.1.      (line 1039)
3803 sd, option:                                    See 3.1.      (line  950)
3804 searchDepth, option:                           See 3.1.      (line  950)
3805 searchTime, option:                            See 3.1.      (line  943)
3806 secondChessProgram, option:                    See 3.1.      (line 1039)
3807 secondComputerString, option:                  See 3.1.      (line 1094)
3808 secondDirectory, option:                       See 3.1.      (line 1058)
3809 secondHasOwnBookUCI, option:                   See 3.2.      (line 1188)
3810 secondHost, option:                            See 3.1.      (line 1050)
3811 secondInitString, option:                      See 3.1.      (line 1067)
3812 secondIsUCI, option:                           See 3.2.      (line 1162)
3813 secondNeedsNoncompliantFEN, option:            See 3.1.      (line 1144)
3814 secondNPS, option:                             See 3.1.      (line  959)
3815 secondOptions, option:                         See 3.1.      (line 1133)
3816 secondProtocolVersion, option:                 See 3.1.      (line 1111)
3817 secondScoreAbs, option:                        See 3.1.      (line 1119)
3818 secondTimeOdds, option:                        See 3.1.      (line  977)
3819 secondXBook, option:                           See 3.2.      (line 1188)
3820 set, ICS command:                              See 4.        (line 2122)
3821 Settings, Engine:                              See 3.2.      (line 1160)
3822 sgf, option:                                   See 3.4.      (line 1521)
3823 sh, option:                                    See 3.1.      (line 1050)
3824 Shortcut keys:                                 See 2.7.      (line  847)
3825 Show Coords, Menu Item:                        See 2.5.      (line  787)
3826 Show Engine Output, Menu Item:                 See 2.2.      (line  348)
3827 Show Game List, Menu Item:                     See 2.2.      (line  339)
3828 Show Move History, Menu Item:                  See 2.2.      (line  343)
3829 showButtonBar, option:                         See 3.5.      (line 1670)
3830 showCoords, option:                            See 3.5.      (line 1640)
3831 showThinking, option:                          See 3.1.      (line  995)
3832 size, option:                                  See 3.5.      (line 1610)
3833 sNoOwnBookUCI, option:                         See 3.2.      (line 1188)
3834 soundChallenge, option:                        See 3.3.      (line 1439)
3835 soundChannel, option:                          See 3.3.      (line 1439)
3836 soundIcsAlarm, option:                         See 3.3.      (line 1447)
3837 soundIcsDraw, option:                          See 3.3.      (line 1458)
3838 soundIcsLoss, option:                          See 3.3.      (line 1454)
3839 soundIcsUnfinished, option:                    See 3.3.      (line 1462)
3840 soundIcsWin, option:                           See 3.3.      (line 1450)
3841 soundKibitz, option:                           See 3.3.      (line 1439)
3842 soundMove, option:                             See 3.3.      (line 1444)
3843 soundProgram, option:                          See 3.3.      (line 1423)
3844 soundRequest, option:                          See 3.3.      (line 1439)
3845 Sounds:                                        See 3.3.      (line 1423)
3846 soundSeek, option:                             See 3.3.      (line 1439)
3847 soundShout, option:                            See 3.3.      (line 1439)
3848 soundSShout, option:                           See 3.3.      (line 1439)
3849 soundTell, option:                             See 3.3.      (line 1439)
3850 spf, option:                                   See 3.4.      (line 1546)
3851 st, option:                                    See 3.1.      (line  943)
3852 Step Menu:                                     See 2.4.      (line  467)
3853 Stop Examining, Menu Item:                     See 2.3.      (line  453)
3854 Stop Observing, Menu Item:                     See 2.3.      (line  449)
3855 sUCI, option:                                  See 3.2.      (line 1162)
3856 tc, option:                                    See 3.1.      (line  920)
3857 td, option:                                    See 3.4.      (line 1516)
3858 telnet, option:                                See 3.3.      (line 1250)
3859 telnetProgram, option:                         See 3.3.      (line 1259)
3860 Test Legality, Menu Item:                      See 2.5.      (line  800)
3861 testClaims, option:                            See 3.6.      (line 1832)
3862 testLegality, option:                          See 3.5.      (line 1606)
3863 thinking, option:                              See 3.1.      (line  995)
3864 Time Control, Menu Item:                       See 2.5.      (line  597)
3865 timeControl, option:                           See 3.1.      (line  920)
3866 timeDelay, option:                             See 3.4.      (line 1516)
3867 timeIncrement, option:                         See 3.1.      (line  929)
3868 timeOddsMode, option:                          See 3.1.      (line  983)
3869 title, option:                                 See 3.5.      (line 1662)
3870 titleInWindow, option:                         See 3.5.      (line 1662)
3871 Training, Menu Item:                           See 2.2.      (line  329)
3872 trivialDraws, option:                          See 3.6.      (line 1845)
3873 Truncate Game, Menu Item:                      See 2.4.      (line  536)
3874 Two Machines, Menu Item:                       See 2.2.      (line  236)
3875 usePolyglotBook, option:                       See 3.2.      (line 1174)
3876 User interface options:                        See 3.5.      (line 1577)
3877 userName, option:                              See 3.7.      (line 2024)
3878 useTelnet, option:                             See 3.3.      (line 1250)
3879 variant, option:                               See 3.7.      (line 1886)
3880 vars, ICS command:                             See 4.        (line 2119)
3881 whitePieceColor, option:                       See 3.5.      (line 1776)
3882 who, ICS command:                              See 4.        (line 2075)
3883 xflash, option:                                See 3.5.      (line 1683)
3884 Table of Contents
3885 *****************
3886
3887 Introduction
3888 1 Major modes
3889 2 Menus, buttons, and keys
3890   2.1 File Menu
3891   2.2 Mode Menu
3892   2.3 Action Menu
3893   2.4 Step Menu
3894   2.5 Options Menu
3895   2.6 Help Menu
3896   2.7 Other Shortcut Keys
3897 3 Options
3898   3.1 Chess Engine Options
3899   3.2 UCI + WB Engine Settings
3900   3.3 ICS options
3901   3.4 Load and Save options
3902   3.5 User interface options
3903   3.6 Adjudication Options
3904   3.7 Other options
3905 4 Chess Servers
3906 5 Firewalls
3907 6 Environment variables
3908 7 Limitations and known bugs
3909 8 Reporting problems
3910 9 Authors and contributors
3911 10 CMail
3912   10.1 CMail options
3913   10.2 Starting a CMail Game
3914   10.3 Answering a Move
3915   10.4 Multi-Game Messages
3916   10.5 Completing a Game
3917   10.6 Known CMail Problems
3918 11 Other programs you can use with XBoard
3919   11.1 GNU Chess
3920   11.2 Fairy-Max
3921   11.3 HoiChess
3922   11.4 Crafty
3923   11.5 zic2xpm
3924 Copyright
3925 GNU GENERAL PUBLIC LICENSE
3926 Index
3927
3928