As the display of the PV in that case starts after the first move
a simple right-click will play the move the engine indicates.
+In Analysis mode you can also make a move by grabbing the piece
+with a double-click of the left mouse button
+(or while keeping the Ctrl key pressed).
+In this case the move you enter will not be played,
+but will be excluded from the analysis of the current position.
+(Or included if it was already excluded; it is a toggle.)
+This only works for engines that support this feature.
+
When connected to an ICS, it is possible to call up a graphical
representation of players seeking a game in stead of the chess board,
when the latter is not in use
option is true, in which case they are saved in an older,
human-readable format that is specific to XBoard. Both formats
can be read back by the @samp{Load Position} command.
+@item Save Games as Book
+@cindex Save Games as Book, Menu Item
+Creates an opening book from the currently loaded game file.
+The book will be saved on the file specified in the @samp{Common Engine}
+options dialog.
+The value of @samp{Book Depth} specified in that same dialog will
+be used to determine how many moves of each game will be added to
+the internal book buffer.
+This command can take a long time to process,
+and the size of the buffer is currently limited.
+At the end the buffer will be saved as a Polyglot book,
+but the buffer will ot be cleared,
+so that you can continue adding games from other game files.
@item Mail Move
@itemx Reload CMail Message
@cindex Mail Move, Menu Item
@cindex Edit Comment, Menu Item
Adds or modifies a comment on the current position. Comments are
saved by @samp{Save Game} and are displayed by @samp{Load Game},
+PGN variations will also be printed in this window,
+and can be promoted to main line by right-clicking them.
@samp{Forward}, and @samp{Backward}.
@item Edit Book
@cindex Edit Book, Menu Item
and it is more convenient for someone analyzing games to see the moves sorted by score.
The order in which the engine found them is only of interest to the engine author,
and can still be deduced from the time or node count printed with the line.
+Right-clicking a line in this window, and then moving the mouse vertically with the
+right button kept down, will make XBoard play through the PV listed there.
+The use of the board window as 'variation board' will normally end when
+you release the right button,
+or when the opponent plays a move.
+But beware: in Analysis mode, moves thus played out will be added to the game.
+The Engine-Output pane for each engine will contain a header displaying the
+multi-PV status and a list of excluded moves in Analysis mode,
+which are also responsive to right-clicking.
@item Show Move History
@cindex Show Move History, Menu Item
Shows or hides a list of moves of the current game.
The input box is especially useful if you want to type in something long or do
some editing on your input, because output from ICS doesn't get mixed
in with your typing as it would in the main terminal window.
+@item Open Chat Window
+@cindex Open Chat Window, Menu Item
+This menu item opens a window in which you can conduct upto 5 chats
+with other ICS users (or channels).
+To use the window, write the name of your chat partner, the channel number,
+or the words 'shouts', 'whispers', 'cshouts' in the upper field
+(closing with <Enter>).
+Everything you type in the lowest field will then automatically be sent to
+the mentioned party, while everything that party sends to you will
+appear in the central text box, rather than appear in the ICS console.
+The row of buttons allow you to choose between chat;
+to start a new chat, just select an empty button,
+and complete the @samp{Chat partner} field.
@item Board
@cindex Board, Menu Item
Summons a dialog where you can customize the look of the chess board.
(old, deprecated behavior)
or allow you to step through an engine PV
(new, recommended behavior).
+@itemx Enable Variation Trees
+@cindex Enable Variation Trees, Menu Item
+If this option is on, playing a move in Edit Game or Analyze mode
+while keeping the Shift key pressed will start a new variation.
+You can then recall the previous line through the @samp{Revert} menu item.
+When off, playing a move will truncate the game and append the move
+irreversibly.
@itemx Hide Thinking
@cindex Hide Thinking, Menu Item
If this option is off, the chess engine's notion of the score and best
the analysis window
will only be updated when the analysis changes. If this option is
on, the Analysis Window will be updated every two seconds.
+@itemx Play Move(s) of Clicked PV
+@cindex Play Move(s) of Clicked PV, Menu Item
+If this option is on, right-clicking a PV in the Engine Output window
+during Analyze mode will cause the first move of that PV to be played.
+You could also play more than one (or no) PV move by moving the mouse
+to engage in the PV walk such a right-click will start,
+to seek out another position along the PV where you want to continue
+the analysis, before releasing the mouse button.
@itemx Ponder Next Move
@cindex Ponder Next Move, Menu Item
If this option is off, the chess engine will think only when it is on
@itemx Search mode
@cindex Search mode, Menu Item
@cindex find position, Menu Item
+@cindex narrow, Menu Item
This setting determines which positions in a game will be considered a match
to the position currently displayed in the board window
when you press the @samp{find position} button in the Game List.
in the four lowest ranks of the board,
and optional additional material in the four highest ranks of the board.
You can request the optional material to be balanced.
+The @samp{narrow} button is similar in fuction to the @samp{find position} button,
+but only searches in the already selected games,
+rather than the complete game file,
+and can thus be used to refine a search based on multiple criteria.
@itemx number of consecutive positions
@cindex number of consecutive positions, Menu Item
When you are searching by material, rather than for an exact match,
@item Save Game Options
@cindex Save Game Options, Menu Item
Summons a dialog where you can specify the files on which XBoard should
-automtically save any played or entered games,
+automatically save any played or entered games,
(the @code{saveGameFile} option),
or the final position of such games (the @code{savePositionfile} option).
You can also select 'auto-save' without a file name,
in which case XBoard will prompt the user for a file name after each game.
+In ICS mode you can limit the auto-saving to your own games
+(i.e. suppress saving of observed games).
You can also set the default value for the PGN Event tag that will
be used for each new game you start.
Various options for the format of the game can be specified as well,
Name of second chess engine, if needed.
A second chess engine is started only in Two Machines (match) mode.
Default: @file{Fairy-Max}.
+@item -fe or -firstEngine nickname
+@cindex fe, option
+@cindex firstEngine, option
+This is an alternative to the @code{fcp} option for specifying the first engine,
+for engines that were already configured (using the @samp{Load Engine} dialog)
+in XBoard's settings file.
+It will not only retrieve the real name of the engine,
+but also all options configured with it.
+(E.g. if it is UCI, whether it should use book.)
+@item -se or -secondEngine nickname
+@cindex se, option
+@cindex secondEngine, option
+As @code{fe}, but for the second engine.
@item -fb/-xfb or -firstPlaysBlack true/false
@cindex fb, option
@cindex firstPlaysBlack, option
@cindex bookVariation, option
A value n from 0 to 100 tunes the choice of moves from the GUI books
from totally random to best-only. Default: 50
+@item -mcBookMode
+@cindex mcBookMode, option
+When this volatile option is specified, the probing algorithm of the
+GUI book is altered to always select the move that is most under-represented
+based on its performance.
+When all moves are played in approximately the right proportion,
+a book miss will be reported, to give the engine opportunity to
+explore a new move.
+In addition score of the moves will be kept track of during the session
+in a book buffer.
+By playing an match in this mode, a book will be built from scratch.
+The only output are the saved games, which can be converted to an
+actual book later, with the @samp{Save Games as Book} command.
+This command can also be used to pre-fill the book buffer
+before adding new games based on the probing algorithm.
@item -fn string or -firstPgnName string
@itemx -sn string or -secondPgnName string
@cindex firstPgnName, option
@cindex autoSaveGames, option
Sets the Auto Save menu option. @xref{Options Menu}. Default: false.
Ignored if @code{saveGameFile} is set.
+@item -onlyOwnGames true/false
+@cindex onlyOwnGames, option
+Suppresses auto-saving of ICS observed games. Default: false.
@item -lpf or -loadPositionFile file
@itemx -lpi or -loadPositionIndex index
@cindex lpf, option
(to speed up automated ultra-fast engine-engine games, which you don't want to watch).
There will be no board or clock updates, no printing of moves,
and no update of the icon on the task bar in this mode.
+@item -logoSize N
+@cindex logoSize, option
+This option controls the drawing of player logos next to the clocks.
+The integer N specifies the width of the logo in pixels;
+the logo height will always be half the width.
+When N = 0, no logos will be diplayed.
+Default: 0.
+@item -firstLogo imagefile
+@itemx -secondLogo imagefile
+@cindex firstLogo, option
+@cindex secondLogo, option
+Specify the images to be used as player logos when @code{logoSize}
+is non-zero, next to the white and black clocks, respectively.
+@item -autoLogo true/false
+@item -logoDir filename
+@cindex autoLogo, option
+@cindex logoDir, option
+When @code{autoLogo} is set, XBoard will search for a PNG image file
+with the name of the engine or ICS in the directory specified
+by @code{logoDir}.
@item -recentEngines number
@itemx -recentEngineList list
@cindex recentEngines, option
Analyze mode by holding the Shift key down while entering a move.
When it is off, the Shift key will be ignored.
Default: False.
+@item -appendPV true|false
+@cindex appendPV, option
+When this option is on, right-clicking a PV in the Engine Output window
+will play the first move of that PV in Analyze mode,
+or as many moves as you walk through by moving the mouse.
+Default: False.
@item -absoluteAnalysisScores true|false
@cindex absoluteAnalysisScores, option
When true, scores on the Engine Output window during analysis
If this option is true, XBoard 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 -viewer
+@itemx -viewerOptions string
+@cindex viewer, option
+@cindex viewerOptions, option
+Presence of the volatile option @code{viewer} on the command line
+will cause the value of the persistent option @code{viewerOptions}
+as stored in the settings file to be appended to the command line.
+The @code{view} option will be used by desktop associations with
+game or position file types, so that @code{viewerOptions} can be
+used to configure the exact mode XBoard will start in when it
+should act on such a file (e.g. in -ncp mode, or analyzing
+with your favorite engine). The options are also automatically
+appended when Board is invoked with a single argument not being
+an option name, which is then assumed to be the name of a
+@code{loadGameFile} or (when the name ends in .fen) a
+@code{loadPositionFile}.
+Default: "-ncp -engineOutputUp false -saveSettingsOnExit false".
+@item -tourneyOptions string
+@cindex tourneyOptions, option
+When XBoard is invoked with a single argument that is a file
+with .trn extension, it will assume this argument to be the value
+of a @code{tourneyFile} option,
+and apped the value of the persistent option @code{tourneyOptions}
+as stored in the settings file to the command line.
+Thus the value of @code{tourneyOptions} can be
+used to configure XBoard to automatically start running a
+tournament when it should act on such a file.
+Default: "-ncp -mm -saveSettingsOnExit false".
@item -mode or -initialMode modename
@cindex mode, option
@cindex initalMode, option
projects / xboard.git / blobdiff