Provide help clicks on recently-used-engines menu items
[xboard.git] / xboard.texi
index 2f7f3f4..58d46d8 100644 (file)
@@ -243,16 +243,27 @@ appropriate command from the Action menu, not @samp{New Game}.
 Similar to @samp{New Game}, but allows you to specify a particular initial position 
 (according to a standardized numbering system)
 in chess variants which use randomized opening positions (e.g. Chess960).
-You can also press the @samp{Pick Fixed} button to let XBoard generate
-a random number for you.
-The thus selected opening position will then persistently be chosen on any following
-New Game command until you use this menu to select another. 
-Selecting position number -1 (or pushing the @samp{Randomize} button)
-will produce a newly randomized position on any new game.
-Using this menu item in variants that normally do not shuffle their opening position
-does cause these variants to become shuffle variants until you use the
-@samp{New Shuffle Game} menu to explicitly switch the randomization off,
-or select a new variant.
+@item shuffle
+@cindex shuffle, Menu Item
+Ticking @samp{shuffle} will cause the current variant to be played
+with shuffled initial position.
+Shuffling will preserve the possibility to castle in the way allowed by the variant.
+@item Fischer castling
+@cindex Fischer castling, menu item
+Ticking @samp{Fischer castling} will allow castling with Kings and Rooks
+that did not start in their normal place, as in Chess960.
+@item Start-position number
+@itemx randomize
+@itemx pick fixed
+@cindex randomize, Menu Item
+@cindex pick fixed, Menu Item
+@cindex Start-position number, Menu Item
+The @samp{Start-position number} selects a particular start position
+from all allowed shufflings, which will then be used for every new game.
+Setting this to -1 (which can be done by pressing the @samp{randomize} button)
+will cause a fresh random position to be picked for every new game.
+Pressing the @samp{pick fixed} button causes @samp{Start-position number}
+to be set to a random value, to be used for all subsequent games. 
 @item New Variant
 @cindex New variant, Menu Item
 Allows you to select a new chess variant in non-ICS mode. 
@@ -558,6 +569,7 @@ position. Puts XBoard into @samp{Edit Game} mode if it was not there
 already.
 The @kbd{End} key is a keyboard equivalent.
 @item Backward
+@itemx <
 @cindex Backward, Menu Item
 @cindex <, Button
 Steps backward through a series of remembered moves.
@@ -580,6 +592,7 @@ everyone's view of the game and allows you to make a different
 move. If Pause mode is on, @samp{Backward} only backs up your local
 view.
 @item Forward
+@itemx >
 @cindex Forward, Menu Item
 @cindex >, Button
 Steps forward through a series of remembered moves (undoing the
@@ -595,6 +608,7 @@ Pause mode is on, @samp{Forward} only moves your local view forward,
 and it will not go past the position that the game was in when
 you paused.
 @item Back to Start
+@itemx <<
 @cindex Back to Start, Menu Item
 @cindex <<, Button
 Jumps backward to the first remembered position in the game.
@@ -615,6 +629,7 @@ command, which backs up everyone's view of the game to the start and
 allows you to make different moves. If Pause mode is on, @samp{Back
 to Start} only backs up your local view.
 @item Forward to End
+@itemx >>
 @cindex Forward to End, Menu Item
 @cindex >>, Button
 Jumps forward to the last remembered position in the game. The
@@ -877,6 +892,12 @@ by typing one in the text entry in the lower-left of the dialog,
 and closing the latter with OK.
 It will then appear in the themes listbox next time you open the dialog,
 where you can recall the complete settings combination with a double-click.
+@item Fonts
+@cindex Fonts, Menu Item
+Pops up a dialog where you can set the fonts used in the main elements of various windows.
+Pango font names can be typed for each window type,
+and behind each text entry there are buttons to adjust the point size,
+and toggle the 'bold' or 'italic' attributes of the font.
 @item Game List Tags
 @cindex Game List Tags, Menu Item
 a duplicate of the Game List dialog in the Options menu.
@@ -1265,25 +1286,72 @@ that SMP engines can use.
 The shifted @kbd{Alt+U} key is a keyboard equivalent.
 Older XBoard/WinBoard engines might not respond to these settings,
 but UCI engines always should.
-The @samp{EGT path} field corresponds to the setting of the
-@code{egtFormats} option to specify where to find tablebases
-of various flavors. See the description of this option for the required syntax.
-
-It is also possible to specify a GUI opening book here, i.e. an opening
-book that XBoard consults for any position a playing engine gets in.
-It then forces the engine to play the book move, rather than to think up its own,
-if that position is found in the book.
-The book can switched on and off independently for either engine.
-The way book moves are chosen can be influenced through the settings of
-book depth and variety.
-After both sides have played more moves than the specified depth,
-the book will no longer be consulted.
+@item Maximum Number of CPUs per Engine
+@cindex Max. Number of CPUs, Menu Item
+Specifies the number of search threads any engine can maximally use.
+Do not set it to a number larger than the number of cores your computer has.
+(Or half of it when you want two engines to run simultaneously,
+as in a Two-Machines game with @samp{Ponder Next Move} on.)
+@item Polyglot Directory
+@item Hash-Table Size
+@cindex Hash-Table Size
+Specifies the maximum amount of memory (RAM) each engine is allowed to use
+for storing info on positions it already searched,
+so it would not have to search them again.
+Do not set it so that it is more than half
+(or if you use two engines, more than a quarter)
+of the memory your computer has,
+or it would slow the engines down by an extreme amount.
+@item EGTB Path
+@cindex EGTB Path, Menu Item
+Sets the value of the @code{egtFormats} option, which specifies
+where on your computer the files for End-Game Tables are stored.
+It must be a comma-separated list of path names,
+the path for each EGT flavor prefixed with the name of the latter
+and a colon. E.g. "nalimov:/home/egt/dtm,syzygy:/home/egt/dtz50".
+The path names after the colon will be sent to the engines
+that say they can use the corresponding EGT flavor.
+@item EGTB Cache Size
+@cindex EGTB Cache Size, Menu Item
+Specifies the amount of memory the engine should use to
+buffer end-game information.
+Together with the @samp{Hash-Table Size} this determines how
+much memory the engine is allowed to use in total.
+@item Use GUI Book
+@itemx Opening-Book Filename
+@cindex Use GUI Book, Menu Item
+@cindex Opening-Book Filename, Menu Item
+The @samp{Opening-Book Filename} specifies an opening book
+in Polyglot format (usually a .bin file),
+from which XBoard can play moves on behalf of the engine.
+This is also the book file on which the @samp{Edit Book}
+and @samp{Save Games as Book} menu items operate.
+A checkbox @samp{Use GUI Book} can be used to temporarily
+disable the book without losing the setting.
+(This does not prevent editing or saving games on it!)
+@item Book Depth
+@itemx Book Variety
+@cindex Book Depth, Menu Item
+@cindex Book Variety, Menu Item
+The way moves are selected from the book can be controlled by two options.
+@samp{Book Depth} controls for how deep into the game the book
+will be consulted (measured in full moves).
+@samp{Book Variety} controls the likelihood of playing weaker moves.
 When the variety is set to 50, moves will be played with the probability
 specified in the book.
 When set to 0, only the move(s) with the highest probability will be played.
 When set to 100, all listed moves will be played with equal pobability.
 Other settings interpolate between that.
-
+@item Engine #1 Has Own Book
+@itemx Engine #2 Has Own Book
+@cindex Engine Has Own Book
+These checkboxes control on a per-engine basis
+whether XBoard will consult the opening book for them.
+If ticked, XBoard will never play moves from its GUI book,
+giving the engine the opportunity to use its own.
+These options are automatically set whenever you load an engine,
+based on the setting of @samp{Must not use GUI book}
+when you installed that through the @samp{Load Engine} menu dialog.
 @item Hint
 @cindex Hint, Menu Item
 Displays a move hint from the chess engine.
@@ -1565,6 +1633,12 @@ and after every move an 'increment' will be added to it.
 @cindex fixed max, Menu Item
 Selects a TC mode where you have to make each move within a given time,
 and any left-over time is not carried over to the next move.
+@item Divide entered times by 60
+@cindex Divide entered times by 60, Menu Item
+To allow entering of sub-minute initial time or sub-second increment,
+you can tick this checkbox.
+The initial time can then be entered in seconds,
+and the increment in units of 1/60 second.
 @item Moves per session
 @cindex Moves per session, Menu Item
 Sets the duration of a session for classical time control.
@@ -2472,6 +2546,22 @@ without alternating colors.
 Otherwise the same applies as for the @samp{-matchGames} option,
 over which it takes precedence if both are specified. (See there.)
 Default: 0 (do not run a match).
+@item -epd
+@cindex epd, option
+This option puts XBoard in a special mode for solving EPD test-suites,
+for the entire duration of the session.
+In this mode games are aborted after a single move,
+and that move will be compared with the best-move or avoid-move
+from the EPD position description from which the 'game' was started.
+Playing a best move counts as a win, playing an avoid move as a loss,
+and playing any other move counts as a draw.
+This option should be used in combination with match mode,
+and an EPD file of starting positions with an auto-incrementing index.
+Color assignment will be such that the first engine plays all moves,
+and the second engine will be never involved.
+The results for individual positions,
+as well as the time used for solving them,
+will be reported in the lower pane of the Engine Output window.
 @item -fcp or -firstChessProgram program
 @itemx -scp or -secondChessProgram program
 @cindex fcp, option
@@ -3459,6 +3549,11 @@ Default: false.
 Sets the Move Sound menu option.  @xref{Options Menu}.  Default: false.
 For compatibility with old XBoard versions, -bell/-xbell are also 
 accepted as abbreviations for this option.
+@item -analysisBell N
+@cindex analysisBell, option
+When N is non-zero, the Move Sound will be played whenever a new
+PV arrives in analysis mode after more than N seconds of analysis.
+Default: 0.
 @item -exit/-xexit or -popupExitMessage true/false
 @cindex exit, option
 @cindex popupExitMessage, option