-@item -highlight/-xhighlight or -highlightLastMove True/False
-@cindex highlight, option
-@cindex highlightLastMove, option
-Sets the Highlight Last Move menu option. Default: false.
-
-@item -blind/-xblind or -blindfold True/False
-@cindex blind, option
-@cindex blindfold, option
-Sets the Blindfold menu option. Default: false.
-
-@item -clockFont font
-@cindex clockFont, option
-@cindex Font, clock
-The font used for the clocks. If the option value is a pattern
-that does not specify the font size, @value{NAME} tries to choose an
-appropriate font for the board size being used.
-Default: -*-helvetica-bold-r-normal--*-*-*-*-*-*-*-*.
-
-@item -coordFont font
-@cindex coordFont, option
-@cindex Font, coordinates
-The font used for rank and file coordinate labels if @code{showCoords}
-is true. If the option value is a pattern that does not specify
-the font size, @value{NAME} tries to choose an appropriate font for
-the board size being used.
-Default: -*-helvetica-bold-r-normal--*-*-*-*-*-*-*-*.
-
-@item -font font
-@cindex font, option
-@cindex Font
-The font used for popup dialogs, menus, comments, etc.
-If the option value is a pattern that does not specify
-the font size, @value{NAME} tries to choose an appropriate font for
-the board size being used.
-Default: -*-helvetica-medium-r-normal--*-*-*-*-*-*-*-*.
-
-@item -fontSizeTolerance tol
-@cindex fontSizeTolerance, option
-In the font selection algorithm, a nonscalable font will be preferred
-over a scalable font if the nonscalable font's size differs by tol pixels
-or less from the desired size. A value of -1 will force
-a scalable font to always be used if available; a value of 0 will
-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 @value{NAME}
-distribution includes one set of pixmap pieces in xpm format, in the
-directory @file{pixmaps}, and two sets of bitmap pieces in xbm format,
-in the directories @file{bitmaps} and @file{bitmaps.xchess}. 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 @value{NAME} 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 @value{NAME} 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}.
-
-@item -whitePieceColor color
-@itemx -blackPieceColor color
-@itemx -lightSquareColor color
-@itemx -darkSquareColor color
-@itemx -highlightSquareColor color
-@cindex Colors
-@cindex whitePieceColor, option
-@cindex blackPieceColor, option
-@cindex lightSquareColor, option
-@cindex darkSquareColor, option
-@cindex highlightSquareColor, option
-Colors to use for the pieces, squares, and square highlights.
-Defaults:
-@example
--whitePieceColor #FFFFCC
--blackPieceColor #202020
--lightSquareColor #C8C365
--darkSquareColor #77A26D
--highlightSquareColor #FFFF00
--premoveHighlightColor #FF0000
-@end example
-
-On a grayscale monitor you might prefer:
-@example
--whitePieceColor gray100
--blackPieceColor gray0
--lightSquareColor gray80
--darkSquareColor gray60
--highlightSquareColor gray100
--premoveHighlightColor gray70
-@end example
-
-@item -drag/-xdrag or -animateDragging True/False
-@cindex drag, option
-@cindex animateDragging, option
-Sets the Animate Dragging menu option. Default: True.
-
-@item -animate/-xanimate or -animateMoving True/False
-@cindex animate, option
-@cindex animateMoving, option
-Sets the Animate Moving menu option. Default: True.
-
-@item -animateSpeed n
-@cindex -animateSpeed, option
-Number of milliseconds delay between each animation frame when Animate
-Moves is on.
-@end table
-
-@node Other options
-@section Miscellaneous
-@cindex Options, miscellaneous
-@table @asis
-
-@item -ncp/-xncp or -noChessProgram True/False
-@cindex ncp, option
-@cindex noChessProgram, option
-If this option is true, @value{NAME} acts as a passive chessboard; it
-does not start a chess engine at all. Turning on this option
-also turns off clockMode. Default: false.
-
-@item -mode or -initialMode modename
-@cindex mode, option
-@cindex initalMode, option
-If this option is given, @value{NAME} selects the given modename
-from the Mode menu after starting and (if applicable) processing the
-loadGameFile or loadPositionFile option. Default: "" (no selection).
-Other supported values are
-MachineWhite, MachineBlack, TwoMachines, Analysis,
-AnalyzeFile, EditGame, EditPosition, and Training.
-
-@item -variant varname
-@cindex variant, option
-
-Activates preliminary, partial support for playing chess variants
-against a local engine or editing variant games. This flag is not
-needed in ICS mode. Recognized variant names are:
-
-@example
- normal Normal chess
- wildcastle Shuffle chess, king can castle from d file
- nocastle Shuffle chess, no castling allowed
- fischerandom Fischer Random shuffle chess
- bughouse Bughouse, ICC/FICS rules
- crazyhouse Crazyhouse, ICC/FICS rules
- losers Lose all pieces or get mated (ICC wild 17)
- suicide Lose all pieces including king (FICS)
- giveaway Try to have no legal moves (ICC wild 26)
- twokings Weird ICC wild 9
- kriegspiel Opponent's pieces are invisible
- atomic Capturing piece explodes (ICC wild 27)
- 3check Win by giving check 3 times (ICC wild 25)
- shatranj An ancient precursor of chess (ICC wild 28)
- unknown Catchall for other unknown variants
-@end example
-
-In the shuffle variants, xboard does not shuffle the pieces, but
-you can do it by hand using Edit Position. Some variants are
-supported only in ICS mode, including fischerandom, bughouse, and
-kriegspiel. The winning/drawing conditions in crazyhouse (offboard
-interposition on mate), losers, suicide, giveaway, atomic, and 3check
-are not fully understood. In crazyhouse, xboard does not yet keep
-track of offboard pieces. Shatranj is unsupported, but it may be
-usable if you turn off Test Legality.
-
-@item -debug/-xdebug or -debugMode True/False
-@cindex debug, option
-@cindex debugMode, option
-Turns on debugging printout.
-
-@item -rsh or -remoteShell shell-name
-@cindex rsh, option
-@cindex remoteShell, option
-Name of the command used to run programs remotely. The default
-is @file{rsh} or @file{remsh}, determined when @value{NAME} is
-configured and compiled.
-
-@item -ruser or -remoteUser user-name
-@cindex ruser, option
-@cindex remoteUser, option
-User name on the remote system when running programs with the
-@code{remoteShell}. The default is your local user name.
-@end table
-
-
-@node Menus
-@chapter Menus, buttons and keys
-@cindex Menus
-To move a piece, either drag it with the left mouse button,
-or click the left mouse button once on the piece, then once more on
-the destination square.
-To drop a new piece on a
-square (when applicable), press the
-middle or right mouse button over the square
-and select from the popup menu.
-
-All other @value{NAME} commands are available from the menu bar. The most
-frequently used commands also have shortcut keys or on-screen buttons.
-
-@menu
-* File Menu:: Accessing external games and positions.
-* Mode Menu:: Selecting @value{NAME}'s mode.
-* Action Menu:: Talking to the chess engine or ICS opponents.
-* Step Menu:: Controlling the game.
-* Options Menu:: User preferences.
-* Help Menu:: Getting help.
-* Keys:: Other shortcut keys.
-@end menu
-
-@node File Menu
-@section Accessing external games and positions
-@cindex File Menu
-@cindex Menu, File
-@table @asis
-@item Reset
-@cindex Reset, Menuitem
-Resets @value{NAME} and the chess engine to the beginning of a new chess
-game. The @samp{r} key is a keyboard equivalent. In Internet Chess
-Server mode, clears the current state of @value{NAME}, then
-resynchronizes with ICS by sending a refresh command. If you want to
-stop playing, observing, or examining a game on ICS, use an
-appropriate command from the Action menu, not @samp{Reset}. @xref{Action
-Menu}.
-
-@item Load Game
-@cindex Load Game, Menuitem
-Plays a game from a record file. The @samp{g} key is a keyboard equivalent.
-A popup dialog prompts you for the file name. If the file contains more
-than one game, a second popup dialog
-displays a list of games (with information drawn from their PGN tags, if
-any), and you can select the one you want. Alternatively, you can load the
-Nth game in the file directly, by typing the number @samp{N} after the
-file name, separated by a space.
-
-The game file parser will accept PGN (portable game notation),
-or in fact almost any file that contains moves in algebraic
-notation.
-Notation of the form @samp{P@@f7}
-is accepted for piece-drops in bughouse games;
-this is a nonstandard extension to PGN.
-If the file includes a PGN position (FEN tag), or an
-@value{NAME} position diagram bracketed by @samp{[--} and @samp{--]}
-before the first move, the game starts from that position. Text
-enclosed in parentheses, square brackets, or curly braces is assumed to
-be commentary and is displayed in a pop-up window. Any other
-text in the file is ignored. PGN variations (enclosed in
-parentheses) are treated as comments; @value{NAME} is not able to walk
-variation trees.
-The nonstandard PGN tag [Variant "varname"] functions similarly to
-the -variant command-line option (see below), allowing games in certain chess
-variants to be loaded. There is also a heuristic to
-recognize chess variants from the Event tag, by looking for the strings
-that the Internet Chess Servers put there when saving variant ("wild") games.
-
-@item Load Next Game
-@cindex Load Next Game, Menuitem
-Loads the next game from the last game record file you loaded.
-The shifted @samp{N} key is a keyboard equivalent.
-Not available if the last game was loaded from a pipe.
-
-@item Load Previous Game
-@cindex Load Previous Game, Menuitem
-Loads the previous game from the last game record file you
-loaded. The shifted @samp{P} key is a keyboard equivalent.
-Not available if the last game was loaded from a pipe.
-
-@item Reload Same Game
-@cindex Reload Same Game, Menuitem
-Reloads the last game you loaded.
-
-@item Save Game
-@cindex Save Game, Menuitem
-Appends a record of the current game to a file.
-A popup dialog
-prompts you for the file name. If the game did not begin with
-the standard starting position, the game file includes the
-starting position used. Games are saved in the PGN (portable
-game notation) format, unless the oldSaveStyle option is true,
-in which case they are saved in an older format that is specific
-to @value{NAME}. Both formats are human-readable, and both can be
-read back by the @samp{Load Game} command.
-Notation of the form @samp{P@@f7}
-is accepted for piece-drops in bughouse games;
-this is a nonstandard extension to PGN.
-
-@item Copy Game
-@cindex Copy Game, Menuitem
-Copies a record of the current game to an internal clipboard in PGN
-format and sets the X selection to the game text. The game can be
-pasted to another application (such as a text editor or another copy
-of @value{NAME}) using that application's paste command. In many X
-applications, such as xterm and emacs, the middle mouse button can be
-used for pasting; in @value{NAME}, you must use the Paste Game command.
-
-@item Paste Game
-@cindex Paste Game, Menuitem
-Interprets the current X selection as a game record and loads it, as
-with Load Game.
-
-@item Load Position
-@cindex Load Position, Menuitem
-Sets up a position from a position file. A popup dialog prompts
-you for the file name. If the file contains more than one saved
-position, and you want to load the Nth one, type the number N
-after the file name, separated by a space. Position files must
-be in FEN (Forsythe-Edwards notation), or in the format that the
-Save Position command writes when oldSaveStyle is turned on.
-
-@item Load Next Position
-@cindex Load Next Position, Menuitem
-Loads the next position from the last position file you loaded.
-Not available if the last position was loaded from a pipe.
-
-@item Load Previous Position
-@cindex Load Previous Position, Menuitem
-Loads the previous position from the last position file you
-loaded. Not available if the last position was loaded from a pipe.
-
-@item Reload Same Position
-@cindex Reload Same Position, Menuitem
-Reloads the last position you loaded.
-
-@item Save Position
-@cindex Save Game, Menuitem
-Appends a diagram of the current position to a file.
-A popup dialog
-prompts you for the file name. Positions are saved in
-FEN (Forsythe-Edwards notation) format unless the @code{oldSaveStyle}
-option is true, in which case they are saved in an older,
-human-readable format that is specific to @value{NAME}. Both formats
-can be read back by the @samp{Load Position} command.
-
-@item Copy Position
-@cindex Copy Position, Menuitem
-Copies the current position to an internal clipboard in FEN format and
-sets the X selection to the position text. The position can be pasted
-to another application (such as a text editor or another copy of
-@value{NAME}) using that application's paste command. In many X
-applications, such as xterm and emacs, the middle mouse button can be
-used for pasting; in @value{NAME}, you must use the Paste Position command.
-
-@item Paste Position
-@cindex Paste Position, Menuitem
-Interprets the current X selection as a FEN position and loads it, as
-with Load Position.
-
-@item Mail Move
-@itemx Reload CMail Message
-@cindex Mail Move, Menuitem
-@cindex Reload CMail Message, Menuitem
-See @ref{CMail}.
-
-@item Exit
-@cindex Exit, Menuitem
-Exits from @value{NAME}. The shifted @samp{Q} key is a keyboard equivalent.
-@end table
-
-
-@node Mode Menu
-@section Selecting @value{NAME}'s mode
-@cindex Menu, Mode
-@cindex Mode Menu
-@table @asis
-@item Machine White
-@cindex Machine White, Menuitem
-Forces the chess engine to play White.
-
-@item Machine Black
-@cindex Machine Black, Menuitem
-Forces the chess engine to play Black.
-
-@item Two Machines
-@cindex Two Machines, Menuitem
-Plays a game between two chess engines.
-
-@item Analysis Mode
-@cindex Analysis Mode, Menuitem
-XBoard with Crafty only.
-For information on getting Crafty, see @ref{Crafty}.
-
-XBoard tells Crafty to start analyzing the current game/position
-and shows you the analysis as you move pieces around.
-
-To setup a position to analyze, you do the following:
-
-1. Select Edit Position from the Mode Menu
-
-2. Setup the position (use the right and middle buttons to
-bring up the Black/White piece menus).
-
-3. When you are finished, click on either the Black or White
-clock to tell XBoard which side moves first.
-
-4. Select Analysis Mode from the Mode Menu to start the analysis.
-
-@item Analyze File
-@cindex Analyze File, Menuitem
-XBoard with Crafty only.
-For information on getting Crafty, see @ref{Crafty}.
-
-This option lets you load a game from a file (PGN, XBoard format, etc.)
-and analyze it. When you select this menu item, a popup window appears
-and asks for a filename to load.
-If the file contains multiple games, another popup appears that lets
-you select which game you wish to analyze.
-After a game is loaded, use the XBoard arrow buttons to step
-forwards/backwards through the game and watch Crafty's analysis.
-
-@item ICS Client
-@cindex ICS Client, Menuitem
-ICS mode only. Takes @value{NAME} out of the Edit Game or
-Edit Position state.
-
-While you are examining a game on the ICS, you can issue the ICS
-position-editing commands with the mouse. Do this with @samp{ICS
-Client} selected on the Mode menu, not @samp{Edit Position}; the latter
-edits only your local copy of the position.
-
-To drop a new piece on a square, press mouse button 2 or 3 over
-the square. This brings up a menu of white pieces (button 2) or
-black pieces (button 3).
-Additional menu choices let you empty the square or clear the board.
-You cannot set the side to play or drag pieces to arbitrary squares
-while examining on ICS, however; the ICS permits only legal moves
-in this mode.
-
-If you are playing a bughouse game on the ICS, you can drop an offboard piece
-by pressing mouse button 2 or 3 over an empty square to bring up a piece menu.
-It makes no difference which button you use.
-A list of the offboard pieces
-each player has available is shown in the window title after the player's name.
-
-@item Edit Game
-@cindex Edit Game, Menuitem
-Allows you to make moves for both Black and White, and to change
-moves after backing up with the @samp{Backward} command. The clocks do
-not run.
-
-In GNU Chess mode, the chess engine continues to check moves for legality
-but does not participate in the game. You can bring the chess engine
-into the game by selecting @samp{Machine White}, @samp{Machine Black},
-or @samp{Two Machines}.
-
-In ICS mode, the moves are not sent to the ICS: @samp{Edit Game} takes
-@value{NAME} out of ICS Client mode and lets you edit games locally.
-If you want to edit games on ICS in a way that other ICS users
-can see, use the ICS examine command or start an ICS match
-against yourself.
-
-@item Edit Position
-@cindex Edit Position, Menuitem
-Lets you set up an arbitrary board position.
-Use mouse button 1 to drag pieces to new squares, or to delete a piece
-by dragging it off the board or dragging an empty square on top of it.
-To drop a new piece on a square, press mouse button 2 or 3 over the
-square. This brings up a menu of white pieces (button 2) or
-black pieces (button 3). Additional menu choices let you empty the
-square or clear the board. You can set the side to play next by
-clicking on the White or Black indicator at the top of the screen.
-Selecting @samp{Edit Position} causes @value{NAME} to discard
-all remembered moves in the current game.
-
-In ICS mode, changes made to the position by @samp{Edit Position} are
-not sent to the ICS: @samp{Edit Position} takes @value{NAME} out of
-@samp{ICS Client} mode and lets you edit positions locally. If you want to
-edit positions on ICS in a way that other ICS users can see, use
-the @samp{ICS examine} command, or start an ICS match against yourself.
-(See also the ICS Client topic above.)
-
-@item Training
-@cindex Training, Menuitem
-Training mode lets you interactively guess the moves of a game for one
-of the players. You guess the next move of the game by playing the
-move on the board. If the move played matches the next move of the
-game, the move is accepted and the opponent's response is autoplayed.
-If the move played is incorrect, an error message is displayed. You
-can select this mode only while loading a game (that is, after
-selecting Load Game from the File menu). While @value{NAME} is in Training
-mode, the navigation buttons are disabled.
-
-@item Show Game List
-@cindex Show Game List, Menuitem
-Shows or hides the list of games generated by the last @samp{Load Game}
-command.
-
-@item Edit Tags
-@cindex Edit Tags, Menuitem
-Lets you edit the PGN (portable game notation)
-tags for the current game. After editing, the tags must still conform to
-the PGN tag syntax:
-
-@example
-<tag-section> ::= <tag-pair> <tag-section>
- <empty>
-<tag-pair> ::= [ <tag-name> <tag-value> ]
-<tag-name> ::= <identifier>
-<tag-value> ::= <string>
projects / xboard.git / blobdiff