in with your typing as it would in the main terminal window.
@item Board
@cindex Board, Menu Item
-Summons a dialog where you can customaize the look of the chess board.
+Summons a dialog where you can customize the look of the chess board.
Here you can specify the directory from which piece images should be taken,
when you don't want to use the built-in piece images
-(see @code{pixmapDirectory} and @code{bitmapDirectory} options),
-an external pixmap to be used for the board squares
+(see @code{pieceImageDirectory} option),
+external images to be used for the board squares
(@code{liteBackTextureFile} and @code{darkBackTextureFile} options),
-and square and piece colors for the built-ins.
+and square and piece colors for the default pieces.
@item Game List Tags
@cindex Game List Tags, Menu Item
a duplicate of the Game List dialog in the Options menu.
Note that you can also click on the clocks to set the opposite
side to move (adding a so-called @samp{null move} to the game).
+You can also tell the engine to exclude some moves from analysis.
+(Engines that do not support the exclude-moves feature will
+ignore this, however.)
+The general way to do this is to play the move you want to exclude
+starting with a double click on the piece.
+When you use drag-drop moving, the piece you grab with a double click
+will also remain on its square, to show you that you are not really
+making the move, but just forbid it from the current position.
+Playing a thus excluded move a second time will include it again.
+Excluded moves will be listed as text in a header line in the
+Engine Output window, and you can also re-include them by
+right-clicking them there.
+This header line will also contain the words 'best' and 'tail';
+right-clicking those will exclude the currently best move,
+or all moves not explicitly listed in the header line.
+Once you leave the current position all memory of excluded
+moves will be lost when you return there.
+
+
+Selecting this menu item while already in @samp{Analysis Mode} will
+toggle the participation of the second engine in the analysis.
+The output of this engine will then be shown in the lower pane
+of the Engine Output window.
The analysis function can also be used when observing games on an ICS
with an engine loaded (zippy mode); the engine then will analyse
the positions as they occur in the observed game.
+
@item Analyze Game
@cindex Analyze Game, Menu Item
This option subjects the currently loaded game to automatic
The game will be annotated with the results of these analyses.
In particlar, the score and depth will be added as a comment,
and the PV will be added as a variation.
+
+Normally the analysis would stop after reaching the end of the game.
+But when a game is loaded from a multi-game file
+while @samp{Analyze Game} was already switched on,
+the analysis will continue with the next game in the file
+until the end of the file is reached (or you switch to another mode).
+
The time the engine spends on analyzing each move can be controlled
-through the command-line option @samp{-timeDelay}.
+through the command-line option @samp{-timeDelay},
+which can also be set from the @samp{Load Game Options} menu dialog.
Note: Some chess engines do not support Analysis mode.
@item Edit Game
Duplicate of the item in the Edit menu.
but the second (even) games will select the same moves from the book as the previous game.
(Note this leads to the same opening only if both engines use the GUI book!)
Default: No game or position file will be used. The default index if such a file is used is 1.
+@itemx Disable own engine bools be default
+@cindex Disable own engine bools be default, Menu Item
+Setting this option reverses the default situation for use of the GUI opening book
+in tournaments from what it normally is, namely not using it.
+So unless the engine is installed with an option to explicitly specify it should
+not use the GUI book (i.e. @code{-firstHasOwnBookUCI true}),
+it will be made to use the GUI book.
@itemx Replace Engine
@itemx Upgrade Engine
@cindex Replace Engine, Menu Item
Such options would still be understood when they appear in the settings
file in case they were put there with the aid of a text editor, but they
would disappear from the file as soon as you save the settings.
+
+Note that XBoard no longer pays attention to options values specified
+in the .Xresources file.
+(Specifying key bindings there will still work, though.)
+To alter the default of volatile options, you can use the following method:
+Rename your ~/.xboardrc settings file (to ~/.yboardrc, say), and create
+a new file ~/.xboardrc, which only contains the options
+
+@example
+-settingsFile ~/.yboardrc
+-saveSettingsFile ~/.yboardrc
+@end example
+
+@noindent
+This will cause your settings to be saved on ~/.yboardrc in the future,
+so that ~/.xboardrc is no longer overwritten.
+You can then safely specify volatile options in ~/.xboardrc, either
+before or after the settingsFile options.
+Note that when you specify persistent options after the settingsFile options
+in ~/.xboardrc, you will essentially turn them into volatile options
+with the specified value as default, because that value will overrule
+the value loaded from the settings file (being read later).
@item Save Settings on Exit
@cindex Save Settings on Exit, Menu Item
Setting this option has no immediate effect, but causes the settings
@cindex Keys
@cindex Shortcut keys
@table @asis
-@item Show last move
+@item Show Last Move
+@cindex Show Last Move, Shortcut Key
By hitting @kbd{Enter} the last move will be re-animated.
@item Load Next Game
@cindex Load Next Game, Menu Item
Loads the next game from the last game record file you loaded.
-The @kbd{Alt+PgDn} key is a keyboard equivalent.
+The @kbd{Alt+PgDn} key triggers this action.
@item Load Previous Game
@cindex Load Previous Game, Menu Item
Loads the previous game from the last game record file you
-loaded. The @kbd{Alt+PgUp} key is a keyboard equivalent.
+loaded. The @kbd{Alt+PgUp} key triggers this action.
Not available if the last game was loaded from a pipe.
@item Reload Same Game
@cindex Reload Same Game, Menu Item
Reloads the last game you loaded.
Not available if the last game was loaded from a pipe.
+Currently no keystroke is assigned to this ReloadGameProc.
@item Reload Same Position
@cindex Reload Same Position, Menu Item
Reloads the last position you loaded.
Not available if the last position was loaded from a pipe.
+Currently no keystroke is assigned to this ReloadPositionProc.
@end table
You can add or remove shortcut keys using the X resources
Setting this option from the command line is tricky, because you must
type in real newline characters, including one at the very end.
In most shells you can do this by
-entering a @samp{\} character followed by a newline. It is easier to set
-the option from your @file{.Xresources} file; in that case you can
-include the character sequence @samp{\n} in the string, and it will
-be converted to a newline.
+entering a @samp{\} character followed by a newline.
+Using the character sequence @samp{\n} in the string should work too, though.
If you change this option, don't remove the @samp{new}
command; it is required by all chess engines to
your xterm. Bold can be 1 or 0. If background is omitted, ``default''
is assumed; if bold is omitted, 0 is assumed.
-Here is an example of how to set the colors in your @file{.Xresources} file.
-The colors shown here are the default values; you will get
-them if you turn @code{-colorize} on without specifying your own colors.
-CShout is synonymous with SShout.
-
-@example
-xboard*colorizeMessages: true
-xboard*colorShout: green
-xboard*colorSShout: green, black, 1
-xboard*colorChannel1: cyan
-xboard*colorChannel: cyan, black, 1
-xboard*colorKibitz: magenta, black, 1
-xboard*colorTell: yellow, black, 1
-xboard*colorChallenge: red, black, 1
-xboard*colorRequest: red
-xboard*colorSeek: blue
-xboard*colorNormal: default
-@end example
@item -soundProgram progname
@cindex soundProgram, option
@cindex Sounds
This sound is played when an ICS game that you are participating in is
aborted, adjourned, or otherwise ends inconclusively. Default: "" (no
sound).
-
-Here is an example of how to set the sounds in your @file{.Xresources} file:
-
-@example
-xboard*soundShout: shout.wav
-xboard*soundSShout: sshout.wav
-xboard*soundChannel1: channel1.wav
-xboard*soundChannel: channel.wav
-xboard*soundKibitz: kibitz.wav
-xboard*soundTell: tell.wav
-xboard*soundChallenge: challenge.wav
-xboard*soundRequest: request.wav
-xboard*soundSeek: seek.wav
-xboard*soundMove: move.wav
-xboard*soundIcsWin: win.wav
-xboard*soundIcsLoss: lose.wav
-xboard*soundIcsDraw: draw.wav
-xboard*soundIcsUnfinished: unfinished.wav
-xboard*soundIcsAlarm: alarm.wav
-@end example
@end table
@node Load and Save options
and the most recently used one will always be sorted to the top.
If the list after that is longer than the specified number,
the last one is discarded.
-hanges in the list will only become visible the next session,
+Changes in the list will only become visible the next session,
provided you saved the settings.
+Default: 6.
@item -oneClickMove true/false
@cindex oneClickMove, option
When set, this option allows you to enter moves by only clicking the to-
Medium 64x64, Moderate 58x58, Average 54x54, Middling 49x49, Mediocre
45x45, Small 40x40, Slim 37x37, Petite 33x33, Dinky 29x29, Teeny 25x25,
or Tiny 21x21.
-Orthodox pieces of all these sizes are built into XBoard.
-Other sizes can
-be used if you have them; see the pixmapDirectory and bitmapDirectory
-options.
-Complete sets of un-orthodox pieces are only provided in sizes
-Bulky, Middling and (to a lesser extent) Petite;
-Archbishop, Marshall and Amazon are also available in all sizes between
-Bulky and Petite.
-When no bitmap is available, the piece will be displayed as Amazon or King.
+Xboard installs with a set of scalable (svg) piece images,
+which it scales to any of the requested sizes.
+The square size can further be continuously scaled by sizing the board window,
+but this only adapts the size of the pieces,
+and has no effect on the width of the grid lines or the font choice
+(both of which would depend on he selected boardSize).
The default depends on the size of your screen; it is approximately the
largest size that will fit without clipping.
use a nonscalable font only if it is exactly the right size;
a large value (say 1000) will force a nonscalable font to always be
used if available. Default: 4.
-@item -bm or -bitmapDirectory dir
-@itemx -pixmap or -pixmapDirectory dir
-@cindex bm, option
-@cindex bitmapDirectory, option
-@cindex pixmap, option
-@cindex pixmapDirectory, option
-These options control what piece images xboard uses. The XBoard
-distribution includes one set of pixmap pieces in xpm format, in the
-directory @file{pixmaps}, and one set of bitmap pieces in xbm format,
-in the directory @file{bitmaps}. Pixmap
-pieces give a better appearance on the screen: the white pieces have
-dark borders, and the black pieces have opaque internal details. With
-bitmaps, neither piece color has a border, and the internal details
-are transparent; you see the square color or other background color
-through them.
-
-If XBoard is configured and compiled on a system that includes libXpm,
-the X pixmap library, the xpm pixmap pieces are compiled in as the
-default. A different xpm piece set can be selected at runtime with
-the @code{pixmapDirectory} option, or a bitmap piece set can be selected
-with the @code{bitmapDirectory} option.
-
-If XBoard is configured and compiled on a system that does not include
-libXpm (or the @code{--disable-xpm} option is given to the configure
-program), the bitmap pieces are compiled in as the default. It is not
-possible to use xpm pieces in this case, but pixmap pieces in another
-format called "xim" can be used by giving the @code{pixmapDirectory} option.
-Or again, a different bitmap piece set can be selected with the
-@code{bitmapDirectory} option.
-
-Files in the @code{bitmapDirectory} must be named as follows:
-The first character of a piece bitmap name gives the piece it
-represents (@samp{p}, @samp{n}, @samp{b}, @samp{r}, @samp{q}, or @samp{k}),
-the next characters give the size in pixels, the
-following character indicates whether the piece is
-solid or outline (@samp{s} or @samp{o}),
-and the extension is @samp{.bm}.
-For example, a solid 80x80 knight would be named @file{n80s.bm}.
-The outline bitmaps are used only in monochrome mode.
-If bitmap pieces are compiled in and the bitmapDirectory is missing
-some files, the compiled in pieces are used instead.
-
-If the bitmapDirectory option is given,
-it is also possible to replace xboard's icons and menu checkmark,
-by supplying files named @file{icon_white.bm}, @file{icon_black.bm}, and
-@file{checkmark.bm}.
-
-For more information about pixmap pieces and how to get additional
-sets, see @ref{zic2xpm} below.
+@item -pid or -pieceImageDirectory dir
+@cindex pid, option
+@cindex pieceImageDirectory, option
+This options control what piece images xboard uses.
+XBoard will look in the specified directory for an image in png
+or svg format for every piece type, with names like BlackQueen.svg,
+WhiteKnight.svg etc.
+When neither of these is found (or no valid directory is specified)
+XBoard will use the svg piece that was installed with it
+(from the source-tree directory @samp{svg}).
+Both svg and png images will be scaled by XBoard to the required size,
+but the png pieces lose much in quality when scaled too much.
+
@item -whitePieceColor color
@itemx -blackPieceColor color
@itemx -lightSquareColor color
-premoveHighlightColor gray70
-lowTimeWarningColor gray70
@end example
+
+The PieceColor options only work properly if the image files
+defining the pieces were pure black & white
+(possibly anti-aliased to produce gray scales
+and semi-transparancy),
+like the pieces images that come with the install.
+Their effect on colored pieces is undefined.
+The SquareColor option only have an effect
+when no board textures are used.
+@item -trueColors true/false
+@cindex trueColors, option
+When set, this option suppresses the effect of the
+PieceColor options mentioned above.
+This is recommended for images that are already colored.
@item -useBoardTexture true/false
@itemx -liteBackTextureFile filename
@itemx -darkBackTextureFile filename
@cindex useBoardTexture, option
@cindex liteBackTextureFile, option
@cindex darkBackTextureFile, option
-Indicate the pixmap files to be used for drawing the board squares,
+Indicate the png image files to be used for drawing the board squares,
and if they should be used rather than using simple colors.
The algorithm for cutting squares out of a given bitmap is such that
the picture is perfectly reproduced when a bitmap the size of
If this option is set to true, the Paste Position and Paste Game
options paste from the currently selected text. If false, they paste
from the clipboard. Default: false.
+@item -autoCopyPV true|false
+@cindex autoCopyPV, option
+When this option is set, the position displayed on the board when
+you terminate a PV walk
+(initiated by a right-click on board or engine-output window)
+will be automatically put on the clipboard as FEN.
+Default: false.
@item -dropMenu true|false
@cindex dropMenu, option
This option allows you to emulate old behavior,
xboard -ics -icshost firewall.example.com -icsport 23
@end example
@noindent
-Or in your @file{.Xresources} file:
-
-@example
-XBoard*internetChessServerHost: firewall.example.com
-XBoard*internetChessServerPort: 23
-@end example
-@noindent
Then when you run XBoard in ICS mode, you will be prompted
to log in to the firewall host. This works because port 23 is the
standard telnet login service. Do so, then telnet to ICS, using a
@end example
@noindent
-Or in your @file{.Xresources} file:
-
-@example
-XBoard*gateway: rsh.example.com
-XBoard*internetChessServerHost: chessclub.com
-@end example
-
Then when you run XBoard in ICS mode, it will connect to
the ICS by using @file{rsh} to run the command
@samp{telnet chessclub.com 5000} on host @samp{rsh.example.com}.
@end example
@noindent
-Or in your @file{.Xresources} file:
-
-@example
-XBoard*useTelnet: true
-XBoard*telnetProgram: ptelnet
-@end example
-
-@noindent
Then when you run XBoard in ICS mode, it will issue the
command @samp{ptelnet chessclub.com 5000} to connect to the ICS.
that is, your @file{ptelnet} program doesn't let you connect to
alternative ports. As noted above, your chess server may allow you to
connect on port 23 instead. In that case, just add the option
-@samp{-icsport ""} to the above command, or add
-@samp{XBoard*internetChessServerPort:} to your @file{.Xresources} file.
+@samp{-icsport ""} to the above command.
But if your chess server doesn't let you connect on port 23, you will have
to find some other host outside the firewall and hop through it. For
instance, suppose you have a shell account at @samp{foo.edu}. Set
@end example
@noindent
-Or in your @file{.Xresources} file:
-
-@example
-XBoard*useTelnet: true
-XBoard*telnetProgram: ptelnet
-XBoard*internetChessServerHost: foo.edu
-XBoard*internetChessServerPort:
-@end example
-
-@noindent
Then when you run XBoard in ICS mode, it will issue the
command @samp{ptelnet foo.edu} to connect to your account at
@samp{foo.edu}. Log in there, then type @samp{telnet chessclub.com 5000}.
@example
xboard -pixmap ~/fritz4
@end example
-
-Alternatively, you can add this line to your @file{.Xresources} file:
-
-@example
-xboard*pixmapDirectory: ~/fritz4
-@end example
@end table
(*) ZIICS is a separate copyrighted work of Andy McFarland.
projects / xboard.git / blobdiff