Use GTK color picker instead of R, G, B and D buttons
[xboard.git] / xboard.texi
index 41c7fa1..768b060 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).
 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.
+@itemx 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.
+@itemx 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.
+@itemx 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. 
 @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
 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.
 @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
 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
 @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
 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.
 @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
 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
 @cindex Forward to End, Menu Item
 @cindex >>, Button
 Jumps forward to the last remembered position in the game. The
@@ -777,6 +792,95 @@ or prepare for sending him a message through a 'tell' commands.
 @item Board
 @cindex Board, Menu Item
 Summons a dialog where you can customize the look of the chess board.
 @item Board
 @cindex Board, Menu Item
 Summons a dialog where you can customize the look of the chess board.
+@item White Piece Color
+@itemx Black Piece Color
+@itemx Light Square Color
+@itemx Dark Square Color
+@itemx Highlight Color
+@itemx Premove Highlight Color
+@cindex Piece Color, Menu Item
+@cindex Square Color, Menu Item
+@cindex Highlight Color, Menu Item
+These items set the color of pieces, board squares and move highlights
+(borders or arrow).
+Square colors are only used when the @samp{Use Board Textures} option is off,
+the piece colors only when @samp{Use piece bitmaps with their own colors} is off.
+You can type the color as hexadecimally encoded RGB value preceded by '#',
+or adjust it through the R, G, B and D buttons to make it redder, greener, bluer
+or darker.
+A sample of the adjusted color will be displayed behind its text description;
+pressing this colored button restores the default value for the color.
+@item Flip Pieces Shogi Style
+@cindex Flip Pieces Shogi Style, Menu Item
+With this option on XBoard will swap white and black pieces,
+when you flip the view of the board to make white play downward.
+This should be used with piece themes that do not distinguish sides by color,
+but by orientation.
+@item Mono Mode
+@cindex Mono Mode, Menu Item
+This option sets XBoard to pure black-and-white display
+(no grey scales, and thus no anti-aliasing).
+@item Logo Size
+@cindex Logo Size, Menu Item
+Specifies the width of the engine logos displayed next to the clocks, in pixels.
+Setting it to 0 suppresses the display of such logos.
+The height of the logo will be half its width.
+In the GTK build of XBoard any non-zero value is equivalent,
+and the logos are always sized to 1/4 of the board width.
+@item Line Gap
+@cindex Line Gap, Menu Item
+This option specifies the width of the grid lines that separate the squares,
+which change color on highlighting the move.
+Setting it to 0 suppresses these lines, which in general looks better,
+but hides the square-border highlights,
+so that you would have to rely on other forms of highlighting.
+Setting the value to -1 makes XBoard choose a width by itself,
+depending on the square size.
+@item Use Board Textures
+@itemx Light-Squares Texture File
+@itemx Dark-Squares Texture File
+@cindex Use Board Texture, Menu Item
+@cindex Texture Files, Menu Item
+When the option @samp{Use Board Textures} is set,
+the squares will not be drawn as evenly colored surfaces,
+but will be cut from a texture image, as specified by the
+@samp{Texture Files}.
+Separate images can be used for light and dark squares.
+XBoard will try to cut the squares out of the texture image
+with as little overlap as possible, so they all look different.
+The name of the texture file can contain a size hint,
+e.g. @code{xqboard-9x10.png}, alerting XBoard to the fact that
+it contains a whole-board image, out of which squares have to
+be cut in register with the nominal sub-division.
+@item Use external piece bitmaps with their own color
+@cindex Draw pieces with their own colors, Menu Item
+When this option is on XBoard will ignore the piece-color settings,
+and draw the piece images in their original colors.
+The piece-color settings would only work well for evenly colored
+pieces, such as the default theme.
+@item Directory with Pieces Images
+@cindex Piece-Image Directory, Menu Item
+When a directory is specified here, XBoard will first look for
+piece images (SVG or PNG files) in that directory,
+and fall back on the image from the default theme only for
+images it cannot find there.
+An image file called White/BlackTile in the directory will be prefered
+as fall-back for missing pieces over the default image, however.
+@item Selectable themes
+@itemx New name for current theme
+@cindex Board Themes, Menu Item
+@cindex Theme name, Menu Item
+When a theme name is specified while pressing 'OK',
+the combination of settings specified in the dialog
+will be stored in XBoard's list of themes,
+which will be saved with the other options in the settings file
+(as the @code{themeNames} option).
+This name will then appear in the selection listbox next time
+you open the dialog,
+so that you can recall the entire combination of settings
+by double-clicking it.
+
+
 Here you can specify the directory from which piece images should be taken,
 when you don't want to use the built-in piece images
 (see @code{pieceImageDirectory} option),
 Here you can specify the directory from which piece images should be taken,
 when you don't want to use the built-in piece images
 (see @code{pieceImageDirectory} option),
@@ -788,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.
 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.
 @item Game List Tags
 @cindex Game List Tags, Menu Item
 a duplicate of the Game List dialog in the Options menu.
@@ -1476,6 +1586,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.
 @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.
 @item Moves per session
 @cindex Moves per session, Menu Item
 Sets the duration of a session for classical time control.
@@ -2101,11 +2217,12 @@ This allows you to judge the sounds.
 @section Save Settings Now
 @cindex Save Settings Now, Menu Item
 Selecting this menu item causes the current XBoard settings to be
 @section Save Settings Now
 @cindex Save Settings Now, Menu Item
 Selecting this menu item causes the current XBoard settings to be
-written to the settings file, so they will also apply in future sessions.
+written to the settings file, (.xboardrc in your home directory),
+so they will also apply in future sessions.
 Note that some settings are 'volatile', and are not saved,
 because XBoard considers it too unlikely that you want those to apply
 next time.
 Note that some settings are 'volatile', and are not saved,
 because XBoard considers it too unlikely that you want those to apply
 next time.
-In particular this applies to the Chess program names, and all options
+In particular this applies to the Chess program, and all options
 giving information on those Chess programs (such as their directory,
 if they have their own opening book, if they are UCI or native XBoard),
 or the variant you are playing.
 giving information on those Chess programs (such as their directory,
 if they have their own opening book, if they are UCI or native XBoard),
 or the variant you are playing.
@@ -2131,7 +2248,7 @@ so that ~/.xboardrc is no longer overwritten.
 You can then safely specify volatile options in ~/.xboardrc, either
 before or after the settingsFile options.
 Note that when you specify persistent options after the settingsFile options
 You can then safely specify volatile options in ~/.xboardrc, either
 before or after the settingsFile options.
 Note that when you specify persistent options after the settingsFile options
-in ~/.xboardrc, you will essentially turn them into volatile options
+in this ~/.xboardrc, you will essentially turn them into volatile options
 with the specified value as default, because that value will overrule
 the value loaded from the settings file (being read later).
 
 with the specified value as default, because that value will overrule
 the value loaded from the settings file (being read later).
 
@@ -2382,6 +2499,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).
 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
 @item -fcp or -firstChessProgram program
 @itemx -scp or -secondChessProgram program
 @cindex fcp, option
@@ -3369,6 +3502,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.
 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
 @item -exit/-xexit or -popupExitMessage true/false
 @cindex exit, option
 @cindex popupExitMessage, option