Implement -autoCopyPV
[xboard.git] / xboard.texi
index 022034f..b0e4e3a 100644 (file)
@@ -127,7 +127,7 @@ displayed next to the board.
 Old behavior, where right-clicking a square brings up a menu
 where you can select what piece to drop on it can still be 
 selected through the @samp{Drop Menu} option.
-But only in Edit Position mode right clicking a square is still used to
+Only in Edit Position mode right and middle clicking a square is still used to
 put a piece on it, and the piece to drop is selected by sweeping
 the mouse vertically with the button held down.
 
@@ -220,9 +220,12 @@ 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).
-The selected opening position will persistently be chosen on any following
-New Game command until you use this menu to select another. Selecting
-position number -1 will produce a newly randomized position on any new game.
+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,
@@ -685,7 +688,7 @@ 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 aoutomatic
+This option subjects the currently loaded game to automatic
 analysis by the loaded engine.
 The @kbd{Ctrl-G} key is a keyboard equivalent.
 XBoard will start auto-playing the game from the currently displayed position,
@@ -922,6 +925,16 @@ thinking, use @samp{Move Now} first. In ICS mode, @samp{Retract Move}
 issues the command @samp{takeback 1} or @samp{takeback 2}
 depending on whether it is your opponent's move or yours.
 The @kbd{Ctrl-X} key is a keyboard equivalent.
+@item Recently Used Engines
+@cindex Recently Used Engines, In Menu
+At the bottom of the engine menu there can be a list of names
+of engines that you recently loaded through the Load Engine menu dialog
+in previous sessions.
+Clicking on such a name will load that engine as first engine,
+so you won't have to search for it in your list of installed engines,
+if that is very long.
+The maximum number of displayed engine names is set by the
+@code{recentEngines}command-line option.
 @end table
 
 @node Options Menu
@@ -1183,7 +1196,7 @@ The following options occur in a dialog summoned by the
 ICS Options menu item.
 @itemx Auto Kibitz
 @cindex Auto Kibitz, Menu Item
-Setting this option when playingwith or aginst a chess program on an ICS
+Setting this option when playing with or aginst a chess program on an ICS
 will cause the last line of thinking output of the engine before its move
 to be sent to the ICS in a kibitz command.
 In addition, any kibitz message received through the ICS from
@@ -1269,7 +1282,7 @@ while idle and logged on to an ICS.
 @cindex Auto-Refresh Seek Graph, Menu Item
 In combination with the @samp{Seek Graph} option this
 will cause automatic update of the seek graph while it is up.
-This only works on FICS and ICS,
+This only works on FICS and ICC,
 and requires a lot of bandwidth on a busy server.
 @itemx Premove
 @itemx Premove White
@@ -1365,7 +1378,7 @@ XBoard’s intrinsic tournament manager support round-robins (type = 0),
 where each participant plays every other participant, and (multi-)gauntlets, 
 where one (or a few) so-called ‘gauntlet engines’ play an independent set of opponents. 
 In the latter case, you specify the number of gauntlet engines. 
-E.g. if you specified 10 engine, and tourney type = 2, 
+E.g. if you specified 10 engines, and tourney type = 2, 
 the first 2 engines each play the remaining 8. 
 A value of -1 instructs XBoard to play Swiss; for this to work an external
 pairing engine must be specified through the @code{pairingEngine} option.
@@ -1395,9 +1408,9 @@ File where the tournament games are saved
 @itemx Rewind Index after
 @cindex Game File with Opening Lines, Menu Item
 @cindex File with Start Positions, Menu Item
-@itemx Game Number, Menu Item
-@itemx Position Number, Menu Item
-@itemx Rewind Index after, Menu Item
+@cindex Game Number, Menu Item
+@cindex Position Number, Menu Item
+@cindex Rewind Index after, Menu Item
 These items optionally specify the file with move sequences or board positions the tourney 
 games should start from.
 The corresponding numbers specify the number of the game or position in the file.
@@ -1411,12 +1424,19 @@ In this case the first (odd) games will randomly select from the book,
 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
 @cindex Upgrade Engine, Menu Item
 With these two buttons you can alter the participants of an already running tournament.
-After opening the Match Options dialog on an XBoard that iw playing fo the tourney,
+After opening the Match Options dialog on an XBoard that is playing for the tourney,
 you will see all the tourney parameters in the dialog fields.
 You can then replace the name of one engine by that of another
 by editing the @samp{participants} field.
@@ -1428,6 +1448,14 @@ be invalidated, and they will be replayed with the substitute engine.
 In this latter case the engine must not be playing when you do this,
 but otherwise there is no need to pause the tournament play
 for making a substitution.
+@itemx Clone Tourney
+@cindex CloneTourney, Menu Item
+Pressing this button after you have specified an existing tournament file
+will copy the contents of the latter to the dialog,
+and then puts the originally proposed name for the tourney file back.
+You can then run a tourney with the same parameters
+(possibly after changing the proposed name of the tourney file for the new tourney)
+by pressing 'OK'.
 
 @item Load Game Options
 @cindex Load Game Options, Menu Item
@@ -1577,25 +1605,28 @@ Shows the current XBoard version number.
 @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
@@ -2649,18 +2680,24 @@ If this option is set, XBoard appends the final position reached
 in every game played to the specified file. The file name @file{-}
 specifies the standard output.
 @item -pgnExtendedInfo true/false
-@cindex pgnExtendedInfo, option`
+@cindex pgnExtendedInfo, option
 If this option is set, XBoard saves depth, score and time used for each 
 move that the engine found as a comment in the PGN file.
 Default: false.
 @item -pgnEventHeader string
-@cindex pgnEventHeader, option`
+@cindex pgnEventHeader, option
 Sets the name used in the PGN event tag to string. 
 Default: "Computer Chess Game".
+@item -pgnNumberTag true/false
+@cindex pgnNumberTag, option
+Include the (unique) sequence number of a tournament game into the saved
+PGN file as a 'number' tag.
+Default: false.
 @item -saveOutOfBookInfo true/false
-@cindex saveOutOfBookInfo, option`
+@cindex saveOutOfBookInfo, option
 Include the information on how the engine(s) game out of its opening book 
 in a special 'annotator' tag with the PGN file.
+Default: true.
 @item -oldsave/-xoldsave or -oldSaveStyle true/false
 @cindex oldsave, option
 @cindex oldSaveStyle, option
@@ -2724,6 +2761,20 @@ Suppresses all GUI functions of XBoard
 (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 -recentEngines number
+@itemx -recentEngineList list
+@cindex recentEngines, option
+@cindex recentEngineList, option
+When the number is larger than zero, it determines how many recently
+used engines will be appended at the bottom of the @samp{Engines} menu.
+The engines will be saved in your settings file as the option
+@code{recentEngineList}, by their nicknames,
+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.
+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-
@@ -2903,8 +2954,8 @@ Sets the Blindfold menu option.  @xref{Options Menu}.  Default: false.
 @cindex periodic, option
 @cindex periodicUpdates, option
 Controls updating of current move andnode counts in analysis mode. Default: true.
-@item fSAN
-@itemx sSAN
+@item -fSAN
+@itemx -sSAN
 @cindex fSAN, option
 @cindex sSAN, option
 Causes the PV in thinking output of the mentioned engine to be converted 
@@ -3075,6 +3126,13 @@ loaded game.  Default: true.
 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, 
@@ -3320,6 +3378,9 @@ Turns on debugging printout.
 @cindex nameOfDebugFile, option
 Sets the name of the file to which XBoard saves debug information 
 (including all communication to and from the engines).
+A @kbd{%d} in the given file name (e.g. game%d.debug) will be replaced
+by the unique sequence number of a tournament game,
+so that the debug output of each game will be written on a separate file.
 @item -engineDebugOutput number
 @cindex engineDebugOutput, option
 Specifies how XBoard should handle unsolicited output from the engine,