Update texi file for position search
[xboard.git] / xboard.texi
index e8cfd3c..34353e0 100644 (file)
@@ -1410,8 +1410,54 @@ Summons a dialog where you can set the @code{autoDisplayComment} and
 @code{autoDisplayTags} options, (which control popups when viewing loaded games),
 and specify the rate at which loaded games are auto-played,
 in seconds per move (which can be a fractional number, like 1.6).
+You can also set search criteria for determining which games
+will be displayed in the Game List for a multi-game file, 
+and thus be eligible for loading:
+@itemx Elo of strongest player
+@itemx Elo of weakest player
+@itemx year
+@cindex Elo of strongest player, Menu Item
+@cindex Elo of weakest player, Menu Item
+@cindex year, Menu Item
+These numeric fields set thresholds (lower limits) on the Elo rating of the mentioned player,
+or the date the game was played.
+Defaults: 0
+@itemx Search mode
+@cindex Search mode, Menu Item
+@cindex find position, 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.
+You can search for an exact match, 
+a position that has all shown material in the same place, 
+but might contain additional material,
+a position that has all Pawns in the same place,
+but can have the shown material anywhere,
+a position that        can have all shown material anywhere,
+or a position that has material between certain limits anywhere.
+For the latter you have to place the material that must be present
+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.
+@itemx number of consecutive positions
+@cindex number of consecutive positions, Menu Item
+When you are searching by material, rather than for an exact match,
+this parameter indicates forhowmany consecutive game positions
+the same amount of material must be on the board before it is
+considered a match.
+@itemx Also match reversed colors
+@itemx Also match left-right flipped position
+@cindex Also match reversed colors, Menu Item
+@cindex Also match left-right flipped position, Menu Item
+When looking for matching positions rather than by material,
+these settings determine whether mirror images 
+(in case of a vertical flip in combination with color reversal)
+will be also considered a match.
+The left-right flipping is only useful after all castling rights
+have expired (or in Xiangqi).
+
 @item Save Game Options
-@cindex ave Game Options, Menu Item
+@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, 
 (the @code{saveGameFile} option), 
@@ -1580,8 +1626,9 @@ ToStartProc, TrainingProc, TruncateGameProc, and TwoMachinesProc.
 
 This section documents the command-line options to XBoard.  You can
 set these options in two ways: by typing them on the shell command
-line you use to start XBoard, or by setting them as X resources
-(typically in your @file{.Xresources} file).  Many of the options
+line you use to start XBoard, or by editing the settings file
+(usually ~/.xboardrc) to alter the value of the setting that was
+saved there.  Some of the options
 cannot be changed while XBoard is running; others set the initial
 state of items that can be changed with the @ref{Options} menu.
 
@@ -1594,15 +1641,6 @@ turn the option off (@samp{-xopt}). For options that take strings or
 numbers as values, you can use the long or short option names
 interchangeably.
 
-Each option corresponds to an X resource with the same name, so
-if you like, you can set options in your @file{.Xresources} file
-or in a file named @file{XBoard} in your home directory.
-For options that have two names, the longer one is the name of
-the corresponding X resource; the short name is not recognized.
-To turn a boolean option on or off as an
-X resource, give its long name followed by the value
-true or false (@samp{XBoard*longOptionName: true}).
-
 @menu
 * Chess engine options::        Controlling the chess engine.
 * UCI + WB Engine Settings::    Setting some very common engine parameters
@@ -2580,9 +2618,11 @@ home directory.
 @item -display
 @itemx -geometry
 @itemx -iconic
+@itemx -name
 @cindex display, option
 @cindex geometry, option
 @cindex iconic, option
+@cindex resource name, option
 These and most other standard Xt options are accepted.
 @item -noGUI
 @cindex noGUI, option
@@ -3150,6 +3190,22 @@ Default is the login name on your local computer.
 @cindex delayBeforeQuit, option
 @cindex delayAfterQuit, option
 These options specify how long XBoard has to wait before sending a termination signal to rogue engine processes, that do not want to react to the 'quit' command. The second one determines the pause after killing the engine, to make sure it dies.
+@item -searchMode n
+@cindex searchMode, option
+The integer n encodes the mode for the @samp{find position} function.
+Default: 1 (= Exact position match)
+@item -eloThresholdBoth elo
+@itemx -eloThresholdAny elo
+@cindex eloThresholdBoth, option
+@cindex eloThresholdAny, option
+Defines a lower limit for the Elo rating, which has to be surpassed
+before a game will be considered when searching for a board position.
+Default: 0
+@item -dateThreshold year
+@cindex dateThreshold, option
+Only games not played before the given year will be considered when
+searching for a board position
+
 
 @end table
 
@@ -3615,7 +3671,7 @@ odd number of total games is specified.
 A one-word alias for yourself or your opponent.
 @item -wname <full name>
 @itemx -bname <full name>
-@itemx -name <full name>
+@itemx -myname <full name>
 @itemx -oppname <full name>
 The full name of White, Black, yourself or your opponent.
 @item -wna <net address>