X-Git-Url: http://winboard.nl/cgi-bin?a=blobdiff_plain;f=manual%2Fxboard.html;h=47336192052fdcd33306d92d45bfa30748f47e14;hb=3e83b0fc8ace3c5857bc4a2e2f31a88c868b1514;hp=ffd362e2e064ff94af9ab9015d77a73efe95c967;hpb=6ef5a4594dc90cfd66cc24f806241eaaaa2eebe6;p=xboard.git diff --git a/manual/xboard.html b/manual/xboard.html index ffd362e..4733619 100644 --- a/manual/xboard.html +++ b/manual/xboard.html @@ -1082,13 +1082,23 @@ Important when XBoard uses the score for adjudications, or in PGN reporting. so that the generally insatiable hunger for CPU time of chess engines does not interfere so much with smooth operation of WinBoard (or the rest of your system). Negative values could increase the engine priority, which is not recommended. -
-firstOptions string
-secondOptions string
The given string is a comma-separated list of (option name, option value) pairs, +
-firstOptions string
-secondOptions string
The given string is a comma-separated list of (option name, option value) pairs, like the following example: “style=Karpov,blunder rate=0”. If the options announced by the engine at startup through the feature commands of WinBoard protocol matches one of the option names (i.e. “style” or “blunder rate”), it would be set to the given value (i.e. “Karpov” or 0) through a corresponding option command to the engine. This provided that the type of the value (text or numeric) matches as well. +
-firstNeedsNoncompliantFEN string
-secondNeedsNoncompliantFEN string
The castling rights and e.p. fields of the FEN sent to the mentioned engine +with the setboard command will be replaced by the given string. This can for +instance be used to run engines that do not understand Chess960 FENs in +variant fischerandom, to make them at least understand the opening position, +through setting the string to “KQkq -”. (Note you also have to give the e.p. field!) +Other possible applications are to provide work-arounds for engines that want to see +castling and e.p. fields in variants that do not have castling or e.p. +(shatranj, courier, xiangqi, shogi) so that WinBoard would normally omit them +(string = “- -“), or to add variant-specific fields that are not yet supported by WinBoard +(e.g. to indicate the number of checks in 3check).
@@ -1103,33 +1113,33 @@ Up: Options

3.2 UCI + WB Engine Settings

-

+

-
-fUCI or -firstIsUCI true/false
-sUCI or -secondIsUCI true/false
Indicates if the mentioned engine executable file is an UCI engine, +
-fUCI or -firstIsUCI true/false
-sUCI or -secondIsUCI true/false
Indicates if the mentioned engine executable file is an UCI engine, and should be run with the aid of the Polyglot adapter rather than directly. Xboard will then pass the other UCI options and engine name to Polyglot through a .ini temporary file ceated for the purpose. -
-PolyglotDir filename
Gives the name of the directory in which the Polyglot adapter for UCI engines expects its files. +
-PolyglotDir filename
Gives the name of the directory in which the Polyglot adapter for UCI engines expects its files. Default: "/usr/local/share/polyglot". -
-usePolyglotBook true/false
Specifies if the Polygot book should be used. -
-PolyglotBook filename
Gives the filename of the opening book that Polyglot should use. +
-usePolyglotBook true/false
Specifies if the Polygot book should be used. +
-PolyglotBook filename
Gives the filename of the opening book that Polyglot should use. From XBoard 4.3.15 on, native WinBoard engines will also use the opening book specified here, provided the usePolyglotBook option is set to true, and the option firstHasOwnBookUCI or secondHasOwnBookUCI applying to the engine is set to false. The engine will be kept in force mode as long as the current position is in book, and XBoard will select the book moves for it. Default "". -
-fNoOwnBookUCI or -firstXBook or -firstHasOwnBookUCI true/false
-sNoOwnBookUCI or -secondXBook or -secondHasOwnBookUCI true/false
Indicates if the mentioned engine has its own opening book it should play from, +
-fNoOwnBookUCI or -firstXBook or -firstHasOwnBookUCI true/false
-sNoOwnBookUCI or -secondXBook or -secondHasOwnBookUCI true/false
Indicates if the mentioned engine has its own opening book it should play from, rather than using the external book through XBoard. Default: false. -
-defaultHashSize n
Sets the size of the hash table to n MegaBytes. Together with the EGTB cache size +
-defaultHashSize n
Sets the size of the hash table to n MegaBytes. Together with the EGTB cache size this number is also used to calculate the memory setting of WinBoard engines, for those that support the memory feature of WinBoard protocol. Default: 64. -
-defaultCacheSizeEGTB n
Sets the size of the EGTB cache to n MegaBytes. Together with the hash-table size +
-defaultCacheSizeEGTB n
Sets the size of the EGTB cache to n MegaBytes. Together with the hash-table size this number is also used to calculate the memory setting of WinBoard engines, for those that support the memory feature of WinBoard protocol. Default: 4. -
-defaultPathEGTB filename
Gives the name of the directory where the end-game tablebases are installed, for UCI engines. +
-defaultPathEGTB filename
Gives the name of the directory where the end-game tablebases are installed, for UCI engines. Default: "/usr/local/share/egtb". -
-egtFormats string
Specifies which end-game tables are installed on the computer, and where. +
-egtFormats string
Specifies which end-game tables are installed on the computer, and where. The argument is a comma-separated list of format specifications, each specification consisting of a format name, a colon, and a directory path name, e.g. "nalimov:/usr/local/share/egtb". @@ -1151,12 +1161,12 @@ Up: Options

3.3 ICS options

-

+

-
-ics/-xics or -internetChessServerMode true/false
Connect with an Internet Chess Server to play chess against its +
-ics/-xics or -internetChessServerMode true/false
Connect with an Internet Chess Server to play chess against its other users, observe games they are playing, or review games that have recently finished. Default: false. -
-icshost or -internetChessServerHost host
The Internet host name or address of the chess server to connect +
-icshost or -internetChessServerHost host
The Internet host name or address of the chess server to connect to when in ICS mode. Default: chessclub.com. Another popular chess server to try is freechess.org. If your site doesn't have a working Internet name server, try @@ -1164,15 +1174,15 @@ specifying the host address in numeric form. You may also need to specify the numeric address when using the icshelper option with timestamp or timeseal (see below). -
-icsport or -internetChessServerPort port-number
The port number to use when connecting to a chess server in ICS +
-icsport or -internetChessServerPort port-number
The port number to use when connecting to a chess server in ICS mode. Default: 5000. -
-icshelper or -internetChessServerHelper prog-name
An external helper program used to communicate with the chess server. +
-icshelper or -internetChessServerHelper prog-name
An external helper program used to communicate with the chess server. You would set it to "timestamp" for ICC (chessclub.com) or "timeseal" for FICS (freechess.org), after obtaining the correct version of timestamp or timeseal for your computer. See "help timestamp" on ICC and "help timeseal" on FICS. This option is shorthand for -useTelnet -telnetProgram program. -
-telnet/-xtelnet or -useTelnet true/false
This option is poorly named; it should be called useHelper. +
-telnet/-xtelnet or -useTelnet true/false
This option is poorly named; it should be called useHelper. If set to true, it instructs XBoard to run an external program to communicate with the Internet Chess Server. The program to use is given by the telnetProgram option. @@ -1180,21 +1190,21 @@ If the option is false (the default), XBoard opens a TCP socket and uses its own internal implementation of the telnet protocol to communicate with the ICS. See Firewalls. -
-telnetProgram prog-name
This option is poorly named; it should be called helperProgram. +
-telnetProgram prog-name
This option is poorly named; it should be called helperProgram. It gives the name of the telnet program to be used with the gateway and useTelnet options. The default is telnet. The telnet program is invoked with the value of internetChessServerHost as its first argument and the value of internetChessServerPort as its second argument. See Firewalls. -
-gateway host-name
If this option is set to a host name, XBoard communicates with the +
-gateway host-name
If this option is set to a host name, XBoard communicates with the Internet Chess Server by using rsh to run the telnetProgram on the given host, instead of using its own internal implementation of the telnet protocol. You can substitute a different remote shell program for rsh using the remoteShell option described below. See Firewalls. -
-internetChessServerCommPort or -icscomm dev-name
If this option is set, XBoard communicates with the ICS through +
-internetChessServerCommPort or -icscomm dev-name
If this option is set, XBoard communicates with the ICS through the given character I/O device instead of opening a TCP connection. Use this option if your system does not have any kind of Internet connection itself (not even a SLIP or PPP connection), @@ -1238,7 +1248,7 @@ Then telnet to ICS, using a command like telnet chessclub.com 5000. Important: See the paragraph below about extra echoes, in Limitations. -
-icslogon or -internetChessServerLogonScript file-name
Whenever XBoard connects to the Internet Chess Server, +
-icslogon or -internetChessServerLogonScript file-name
Whenever XBoard connects to the Internet Chess Server, if it finds a file with the name given in this option, it feeds the file's contents to the ICS as commands. The default file name is .icsrc. @@ -1246,32 +1256,32 @@ Usually the first two lines of the file should be your ICS user name and password. The file can be either in $CHESSDIR, in XBoard's working directory if CHESSDIR is not set, or in your home directory. -
-msLoginDelay delay
If you experience trouble logging on to an ICS when using the +
-msLoginDelay delay
If you experience trouble logging on to an ICS when using the -icslogon option, inserting some delay between characters of the logon script may help. This option adds delay milliseconds of delay between characters. Good values to try are 100 and 250. -
-icsinput/-xicsinput or -internetChessServerInputBox true/false
Sets the ICS Input Box menu option. See Mode Menu. Default: false. -
-autocomm/-xautocomm or -autoComment true/false
Sets the Auto Comment menu option. See Options Menu. Default: false. -
-autoflag/-xautoflag or -autoCallFlag true/false
Sets the Auto Flag menu option. See Options Menu. Default: false. -
-autobs/-xautobs or -autoObserve true/false
Sets the Auto Observe menu option. See Options Menu. Default: false. -
-autoKibitz
Enables kibitzing of the engines last thinking output (depth, score, time, speed, PV) +
-icsinput/-xicsinput or -internetChessServerInputBox true/false
Sets the ICS Input Box menu option. See Mode Menu. Default: false. +
-autocomm/-xautocomm or -autoComment true/false
Sets the Auto Comment menu option. See Options Menu. Default: false. +
-autoflag/-xautoflag or -autoCallFlag true/false
Sets the Auto Flag menu option. See Options Menu. Default: false. +
-autobs/-xautobs or -autoObserve true/false
Sets the Auto Observe menu option. See Options Menu. Default: false. +
-autoKibitz
Enables kibitzing of the engines last thinking output (depth, score, time, speed, PV) before it moved to the ICS, in zippy mode. The option showThinking must be switched on for this option to work. Also diverts similar kibitz information of an opponent engine that is playing you through the ICS to the engine-output window, as if the engine was playing locally. -
-moves/-xmoves or -getMoveList true/false
Sets the Get Move List menu option. See Options Menu. Default: true. -
-alarm/-xalarm or -icsAlarm true/false
Sets the ICS Alarm menu option. See Options Menu. Default: true. -
-icsAlarmTime ms
Sets the time in milliseconds for the ICS Alarm menu option. +
-moves/-xmoves or -getMoveList true/false
Sets the Get Move List menu option. See Options Menu. Default: true. +
-alarm/-xalarm or -icsAlarm true/false
Sets the ICS Alarm menu option. See Options Menu. Default: true. +
-icsAlarmTime ms
Sets the time in milliseconds for the ICS Alarm menu option. See Options Menu. Default: 5000. -
-pre/-xpre \fRor\fB -premove true/false
Sets the Premove menu option. See Options Menu. Default: true. -
-quiet/-xquiet or -quietPlay true/false
Sets the Quiet Play menu option. See Options Menu. Default: false. -
-colorizeMessages or -colorize
Setting colorizeMessages +
-pre/-xpre \fRor\fB -premove true/false
Sets the Premove menu option. See Options Menu. Default: true. +
-quiet/-xquiet or -quietPlay true/false
Sets the Quiet Play menu option. See Options Menu. Default: false. +
-colorizeMessages or -colorize
Setting colorizeMessages to true tells XBoard to colorize the messages received from the ICS. Colorization works only if your xterm supports ISO 6429 escape sequences for changing text colors. -
-colorShout foreground,background,bold
-colorSShout foreground,background,bold
-colorChannel1 foreground,background,bold
-colorChannel foreground,background,bold
-colorKibitz foreground,background,bold
-colorTell foreground,background,bold
-colorChallege foreground,background,bold
-colorRequest foreground,background,bold
-colorSeek foreground,background,bold
-colorNormal foreground,background,bold
These options set the colors used when colorizing ICS messages. +
-colorShout foreground,background,bold
-colorSShout foreground,background,bold
-colorChannel1 foreground,background,bold
-colorChannel foreground,background,bold
-colorKibitz foreground,background,bold
-colorTell foreground,background,bold
-colorChallege foreground,background,bold
-colorRequest foreground,background,bold
-colorSeek foreground,background,bold
-colorNormal foreground,background,bold
These options set the colors used when colorizing ICS messages. All ICS messages are grouped into one of these categories: shout, sshout, channel 1, other channel, kibitz, tell, challenge, request (including abort, adjourn, draw, pause, and takeback), or @@ -1299,22 +1309,22 @@ them if you turn -colorize on without specifying your own colors. xboard*colorSeek: blue xboard*colorNormal: default -
-soundProgram progname
If this option is set to a sound-playing program that is installed and +
-soundProgram progname
If this option is set to a sound-playing program that is installed and working on your system, XBoard can play sound files when certain events occur, listed below. The default program name is "play". If any of the sound options is set to "$", the event rings the terminal bell by sending a ^G character to standard output, instead of playing a sound file. If an option is set to the empty string "", no sound is played for that event. -
-soundShout filename
-soundSShout filename
-soundChannel filename
-soundKibitz filename
-soundTell filename
-soundChallenge filename
-soundRequest filename
-soundSeek filename
These sounds are triggered in the same way as the colorization events +
-soundShout filename
-soundSShout filename
-soundChannel filename
-soundKibitz filename
-soundTell filename
-soundChallenge filename
-soundRequest filename
-soundSeek filename
These sounds are triggered in the same way as the colorization events described above. They all default to "", no sound. They are played only if the colorizeMessages is on. -
-soundMove filename
This sound is used by the Move Sound menu option. Default: "$". -
-soundIcsAlarm filename
This sound is used by the ICS Alarm menu option. Default: "$". -
-soundIcsWin filename
This sound is played when you win an ICS game. Default: "" (no sound). -
-soundIcsLoss filename
This sound is played when you lose an ICS game. Default: "" (no sound). -
-soundIcsDraw filename
This sound is played when you draw an ICS game. Default: "" (no sound). -
-soundIcsUnfinished filename
This sound is played when an ICS game that you are participating in is +
-soundMove filename
This sound is used by the Move Sound menu option. Default: "$". +
-soundIcsAlarm filename
This sound is used by the ICS Alarm menu option. Default: "$". +
-soundIcsWin filename
This sound is played when you win an ICS game. Default: "" (no sound). +
-soundIcsLoss filename
This sound is played when you lose an ICS game. Default: "" (no sound). +
-soundIcsDraw filename
This sound is played when you draw an ICS game. Default: "" (no sound). +
-soundIcsUnfinished filename
This sound is played when an ICS game that you are participating in is aborted, adjourned, or otherwise ends inconclusively. Default: "" (no sound). @@ -1349,9 +1359,9 @@ Up: Options

3.4 Load and Save options

-

+

-
-lgf or -loadGameFile file
-lgi or -loadGameIndex index
If the loadGameFile option is set, XBoard loads the specified +
-lgf or -loadGameFile file
-lgi or -loadGameIndex index
If the loadGameFile option is set, XBoard loads the specified game file at startup. The file name - specifies the standard input. If there is more than one game in the file, XBoard pops up a menu of the available games, with entries based on their PGN @@ -1374,16 +1384,16 @@ first game of the file when it has reached a specified value. positions or games in auto-increment matchMode. See loadPositionIndex and loadGameIndex. default: 0 (no rewind). -
-td or -timeDelay seconds
Time delay between moves during ‘Load Game’. Fractional seconds +
-td or -timeDelay seconds
Time delay between moves during ‘Load Game’. Fractional seconds are allowed; try ‘-td 0.4’. A time delay value of -1 tells XBoard not to step through game files automatically. Default: 1 second. -
-sgf or -saveGameFile file
If this option is set, XBoard appends a record of every game +
-sgf or -saveGameFile file
If this option is set, XBoard appends a record of every game played to the specified file. The file name - specifies the standard output. -
-autosave/-xautosave or -autoSaveGames true/false
Sets the Auto Save menu option. See Options Menu. Default: false. +
-autosave/-xautosave or -autoSaveGames true/false
Sets the Auto Save menu option. See Options Menu. Default: false. Ignored if saveGameFile is set. -
-lpf or -loadPositionFile file
-lpi or -loadPositionIndex index
If the loadPositionFile option is set, XBoard loads the +
-lpf or -loadPositionFile file
-lpi or -loadPositionIndex index
If the loadPositionFile option is set, XBoard loads the specified position file at startup. The file name - specifies the standard input. If the loadPositionIndex option is set to N, the Nth position found in the file is loaded; otherwise the @@ -1396,17 +1406,17 @@ causes the index to be incremented every two games, so that each position in the file is used twice (with the engines playing opposite colors). The rewindIndex option causes the index to be reset to the first position of the file when it has reached a specified value. -
-spf or -savePositionFile file
If this option is set, XBoard appends the final position reached +
-spf or -savePositionFile file
If this option is set, XBoard appends the final position reached in every game played to the specified file. The file name - specifies the standard output. -
-pgnExtendedInfo true/false
If this option is set, WinBoard saves depth, score and time used for each +
-pgnExtendedInfo true/false
If this option is set, WinBoard saves depth, score and time used for each move that the engine found as a comment in the PGN file. Default: false. -
-pgnEventHeader string
Sets the name used in the PGN event tag to string. +
-pgnEventHeader string
Sets the name used in the PGN event tag to string. Default: "Computer Chess Game". -
-saveOutOfBookInfo true/false
Include the information on how the engine(s) game out of its opening book in a special 'annotator' tag with the PGN file. -
-oldsave/-xoldsave or -oldSaveStyle true/false
Sets the Old Save Style menu option. See Options Menu. Default: false. -
-gameListTags string
The character string lists the PGN tags that should be printed in the +
-saveOutOfBookInfo true/false
Include the information on how the engine(s) game out of its opening book in a special 'annotator' tag with the PGN file. +
-oldsave/-xoldsave or -oldSaveStyle true/false
Sets the Old Save Style menu option. See Options Menu. Default: false. +
-gameListTags string
The character string lists the PGN tags that should be printed in the Game List, and their order. The meaning of the codes is e=event, s=site, d=date, o=round, p=players, r=result, w=white Elo, b=black Elo, t=time control, v=variant, a=out-of-book info. @@ -1424,21 +1434,21 @@ Up: Options

3.5 User interface options

-

+

-
-display
-geometry
-iconic
These and most other standard Xt options are accepted. -
-noGUI
Suppresses all GUI functions of XBoard +
-display
-geometry
-iconic
These and most other standard Xt options are accepted. +
-noGUI
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. -
-movesound/-xmovesound or -ringBellAfterMoves true/false
Sets the Move Sound menu option. See Options Menu. Default: false. +
-movesound/-xmovesound or -ringBellAfterMoves true/false
Sets the Move Sound menu option. See Options Menu. Default: false. For compatibility with old XBoard versions, -bell/-xbell are also accepted as abbreviations for this option. -
-exit/-xexit or -popupExitMessage true/false
Sets the Popup Exit Message menu option. See Options Menu. Default: true. -
-popup/-xpopup or -popupMoveErrors true/false
Sets the Popup Move Errors menu option. See Options Menu. Default: false. -
-queen/-xqueen or -alwaysPromoteToQueen true/false
Sets the Always Queen menu option. See Options Menu. Default: false. -
-legal/-xlegal or -testLegality true/false
Sets the Test Legality menu option. See Options Menu. Default: true. -
-size or -boardSize (sizeName | n1,n2,n3,n4,n5,n6,n7)
Determines how large the board will be, by selecting the pixel size +
-exit/-xexit or -popupExitMessage true/false
Sets the Popup Exit Message menu option. See Options Menu. Default: true. +
-popup/-xpopup or -popupMoveErrors true/false
Sets the Popup Move Errors menu option. See Options Menu. Default: false. +
-queen/-xqueen or -alwaysPromoteToQueen true/false
Sets the Always Queen menu option. See Options Menu. Default: false. +
-legal/-xlegal or -testLegality true/false
Sets the Test Legality menu option. See Options Menu. Default: true. +
-size or -boardSize (sizeName | n1,n2,n3,n4,n5,n6,n7)
Determines how large the board will be, by selecting the pixel size of the pieces and setting a few related parameters. The sizeName can be one of: Titanic, giving 129x129 pixel pieces, Colossal 116x116, Giant 108x108, Huge 95x95, Big 87x87, Large 80x80, Bulky 72x72, @@ -1470,11 +1480,11 @@ If smallLayout is 1 and titleInWindow is true, the window layout is rearranged to make more room for the title. If tinyLayout is 1, the labels on the menu bar are abbreviated to one character each and the buttons in the button bar are made narrower. -
-coords/-xcoords or -showCoords true/false
Sets the Show Coords menu option. See Options Menu. Default: false. +
-coords/-xcoords or -showCoords true/false
Sets the Show Coords menu option. See Options Menu. Default: false. The coordFont option specifies what font to use. -
-autoraise/-xautoraise or -autoRaiseBoard true/false
Sets the Auto Raise Board menu option. See Options Menu. Default: true. -
-autoflip/-xautoflip or -autoFlipView true/false
Sets the Auto Flip View menu option. See Options Menu. Default: true. -
-flip/-xflip or -flipView true/false
If Auto Flip View is not set, or if you are observing but not participating +
-autoraise/-xautoraise or -autoRaiseBoard true/false
Sets the Auto Raise Board menu option. See Options Menu. Default: true. +
-autoflip/-xautoflip or -autoFlipView true/false
Sets the Auto Flip View menu option. See Options Menu. Default: true. +
-flip/-xflip or -flipView true/false
If Auto Flip View is not set, or if you are observing but not participating in a game, then the positioning of the board at the start of each game depends on the flipView option. If flipView is false (the default), the board is positioned so that the white pawns move from the bottom to the @@ -1482,20 +1492,20 @@ top; if true, the black pawns move from the bottom to the top. In any case, the Flip menu option (see Options Menu) can be used to flip the board after the game starts. -
-title/-xtitle or -titleInWindow true/false
If this option is true, XBoard displays player names (for ICS +
-title/-xtitle or -titleInWindow true/false
If this option is true, XBoard displays player names (for ICS games) and game file names (for ‘Load Game’) inside its main window. If the option is false (the default), this information is displayed only in the window banner. You probably won't want to set this option unless the information is not showing up in the banner, as happens with a few X window managers. -
-buttons/-xbuttons or -showButtonBar True/False
If this option is False, xboard omits the [<<] [<] [P] [>] [>>] button +
-buttons/-xbuttons or -showButtonBar True/False
If this option is False, xboard omits the [<<] [<] [P] [>] [>>] button bar from the window, allowing the message line to be wider. You can still get the functions of these buttons using the menus or their keyboard shortcuts. Default: true. -
-mono/-xmono or -monoMode true/false
Determines whether XBoard displays its pieces and squares with +
-mono/-xmono or -monoMode true/false
Determines whether XBoard displays its pieces and squares with two colors (true) or four (false). You shouldn't have to specify monoMode; XBoard will determine if it is necessary. -
-flashCount count
-flashRate rate
-flash/-xflash
These options enable flashing of pieces when they +
-flashCount count
-flashRate rate
-flash/-xflash
These options enable flashing of pieces when they land on their destination square. flashCount tells XBoard how many times to flash a piece after it @@ -1508,23 +1518,23 @@ sets flashCount to 3. xflash sets flashCount to 0. Defaults: flashCount=0 (no flashing), flashRate=5. -
-highlight/-xhighlight or -highlightLastMove true/false
Sets the Highlight Last Move menu option. See Options Menu. Default: false. -
-blind/-xblind or -blindfold true/false
Sets the Blindfold menu option. See Options Menu. Default: false. -
-clockFont font
The font used for the clocks. If the option value is a pattern +
-highlight/-xhighlight or -highlightLastMove true/false
Sets the Highlight Last Move menu option. See Options Menu. Default: false. +
-blind/-xblind or -blindfold true/false
Sets the Blindfold menu option. See Options Menu. Default: false. +
-clockFont font
The font used for the clocks. If the option value is a pattern that does not specify the font size, XBoard tries to choose an appropriate font for the board size being used. Default: -*-helvetica-bold-r-normal–*-*-*-*-*-*-*-*. -
-coordFont font
The font used for rank and file coordinate labels if showCoords +
-coordFont font
The font used for rank and file coordinate labels if showCoords is true. If the option value is a pattern that does not specify the font size, XBoard tries to choose an appropriate font for the board size being used. Default: -*-helvetica-bold-r-normal–*-*-*-*-*-*-*-*. -
-font font
The font used for popup dialogs, menus, comments, etc. +
-font font
The font used for popup dialogs, menus, comments, etc. If the option value is a pattern that does not specify the font size, XBoard tries to choose an appropriate font for the board size being used. Default: -*-helvetica-medium-r-normal–*-*-*-*-*-*-*-*. -
-fontSizeTolerance tol
In the font selection algorithm, a nonscalable font will be preferred +
-fontSizeTolerance tol
In the font selection algorithm, a nonscalable font will be preferred over a scalable font if the nonscalable font's size differs by tol pixels or less from the desired size. A value of -1 will force @@ -1532,7 +1542,7 @@ a scalable font to always be used if available; a value of 0 will use a nonscalable font only if it is exactly the right size; a large value (say 1000) will force a nonscalable font to always be used if available. Default: 4. -
-bm or -bitmapDirectory dir
-pixmap or -pixmapDirectory dir
These options control what piece images xboard uses. The XBoard +
-bm or -bitmapDirectory dir
-pixmap or -pixmapDirectory dir
These options control what piece images xboard uses. The XBoard distribution includes one set of pixmap pieces in xpm format, in the directory pixmaps, and one set of bitmap pieces in xbm format, in the directory bitmaps. Pixmap @@ -1575,7 +1585,7 @@ by supplying files named icon_white.bm, < For more information about pixmap pieces and how to get additional sets, see zic2xpm below. -
-whitePieceColor color
-blackPieceColor color
-lightSquareColor color
-darkSquareColor color
-highlightSquareColor color
Colors to use for the pieces, squares, and square highlights. +
-whitePieceColor color
-blackPieceColor color
-lightSquareColor color
-darkSquareColor color
-highlightSquareColor color
Colors to use for the pieces, squares, and square highlights. Defaults: 
          -whitePieceColor       #FFFFCC
@@ -1595,9 +1605,9 @@ On a grayscale monitor you might prefer:
           -highlightSquareColor  gray100
           -premoveHighlightColor gray70
-
-drag/-xdrag or -animateDragging true/false
Sets the Animate Dragging menu option. See Options Menu. Default: true. -
-animate/-xanimate or -animateMoving true/false
Sets the Animate Moving menu option. See Options Menu. Default: true. -
-animateSpeed n
Number of milliseconds delay between each animation frame when Animate +
-drag/-xdrag or -animateDragging true/false
Sets the Animate Dragging menu option. See Options Menu. Default: true. +
-animate/-xanimate or -animateMoving true/false
Sets the Animate Moving menu option. See Options Menu. Default: true. +
-animateSpeed n
Number of milliseconds delay between each animation frame when Animate Moves is on.
@@ -1612,35 +1622,35 @@ Up: Options

3.6 Adjudication Options

-

+

-
-adjudicateLossThreshold n
If the given value is non-zero, XBoard adjudicates the game as a loss +
-adjudicateLossThreshold n
If the given value is non-zero, XBoard adjudicates the game as a loss if both engines agree for a duration of 6 consecutive ply that the score is below the given score threshold for that engine. Make sure the score is interpreted properly by XBoard, using -firstScoreAbs and -secondScoreAbs if needed. Default: 0 (no adjudiction) -
-adjudicateDrawMoves n
If the given value is non-zero, XBoard adjudicates the game as a draw +
-adjudicateDrawMoves n
If the given value is non-zero, XBoard adjudicates the game as a draw if after the given number of moves it was not yet decided. Defaut: 0 (no adjudication) -
-checkMates true/false
If this option is set, XBoard detects all checkmates and stalemates, +
-checkMates true/false
If this option is set, XBoard detects all checkmates and stalemates, and ends the game as soon as they occur. Legality-testing must be switched on for this option to work. Default: true -
-testClaims true/false
If this option is set, XBoard verifies all result claims made by engines, +
-testClaims true/false
If this option is set, XBoard verifies all result claims made by engines, and those who send false claims will forfeit the game because of it. Legality-testing must be switched on for this option to work. Default: true -
-materialDraws true/false
If this option is set, XBoard adjudicates games as draws when there is +
-materialDraws true/false
If this option is set, XBoard adjudicates games as draws when there is no sufficient material left to inflict a checkmate. This applies to KBKB with like bishops (any number, actually), and to KBK, KNK and KK. Legality-testing must be switched on for this option to work. Default: true -
-trivialDraws true/false
If this option is set, XBoard adjudicates games as draws that cannot be +
-trivialDraws true/false
If this option is set, XBoard adjudicates games as draws that cannot be usually won without opponent cooperation. This applies to KBKB with unlike bishops, and to KBKN, KNKN, KNNK, KRKR and KQKQ. The draw is called after 6 ply into these end-games, to allow quick mates that can occur in some exceptional positions to be found by the engines. KQKQ does not really belong in this category, and might be taken out in the future. (When bitbase-based adjudications are implemented.) Legality-testing must be on for this option to work. Default: false -
-ruleMoves n
If the given value is non-zero, XBoard adjudicates the game as a draw after the given +
-ruleMoves n
If the given value is non-zero, XBoard adjudicates the game as a draw after the given number of consecutive reversible moves. Engine draw claims are always accepted after 50 moves, irrespective of the given value of n.
-repeatsToDraw n
If the given value is non-zero, xboard adjudicates the game as a draw if a position @@ -1660,18 +1670,18 @@ Up: Options

3.7 Other options

-

+

-
-ncp/-xncp or -noChessProgram true/false
If this option is true, XBoard acts as a passive chessboard; it +
-ncp/-xncp or -noChessProgram true/false
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. -
-mode or -initialMode modename
If this option is given, XBoard selects the given modename +
-mode or -initialMode modename
If this option is given, XBoard selects the given modename from the Mode menu after starting and (if applicable) processing the loadGameFile or loadPositionFile option. Default: "" (no selection). Other supported values are MachineWhite, MachineBlack, TwoMachines, Analysis, AnalyzeFile, EditGame, EditPosition, and Training. -
-variant varname
Activates preliminary, partial support for playing chess variants +
-variant varname
Activates preliminary, partial support for playing chess variants against a local engine or editing variant games. This flag is not needed in ICS mode. Recognized variant names are: @@ -1718,25 +1728,25 @@ Berolina and cylinder chess can only be played with legality testing off. In crazyhouse, XBoard now does keep track of offboard pieces. In shatranj it does implement the baring rule when mate detection is switched on. -
-boardHeight N
Allows you to set a non-standard number of board ranks in any variant. +
-boardHeight N
Allows you to set a non-standard number of board ranks in any variant. If the height is given as -1, the default height for the variant is used. Default: -1 -
-boardWidth N
Allows you to set a non-standard number of board files in any variant. +
-boardWidth N
Allows you to set a non-standard number of board files in any variant. If the width is given as -1, the default width for the variant is used. With a non-standard width, the initial position will always be an empty board, as the usual opening array will not fit. Default: -1 -
-holdingsSize N
Allows you to set a non-standard size for the holdings in any variant. +
-holdingsSize N
Allows you to set a non-standard size for the holdings in any variant. If the size is given as -1, the default holdings size for the variant is used. The first N piece types will go into the holdings on capture, and you will be able to drop them on the board in stead of making a normal move. If size equals 0, there will be no holdings. Default: -1 -
-defaultFrcPosition N
Specifies the number of the opening position in shuffle games like Chess960. +
-defaultFrcPosition N
Specifies the number of the opening position in shuffle games like Chess960. A value of -1 means the position is randomly generated by XBoard at the beginning of every game. Default: -1 -
-pieceToSquareTable string
The characters that are used to represent the piece types XBoard knows in FEN +
-pieceToSquareTable string
The characters that are used to represent the piece types XBoard knows in FEN diagrams and SAN moves. The string argument has to have an even length (or it will be ignored), as white and black pieces have to be given separately (in that order). The last letter for each color will be the King. @@ -1756,10 +1766,10 @@ Note that promoted pieces are represented by pieces 11 further in the list. You should not have to use this option often: each variant has its own default setting for the piece representation in FEN, which should be sufficient in normal use. Default: "" -
-debug/-xdebug or -debugMode true/false
Turns on debugging printout. -
-debugFile filename or -nameOfDebugFile filename
Sets the name of the file to which WinBoard saves debug information +
-debug/-xdebug or -debugMode true/false
Turns on debugging printout. +
-debugFile filename or -nameOfDebugFile filename
Sets the name of the file to which WinBoard saves debug information (including all communication to and from the engines). -
-engineDebugOutput number
Specifies how WinBoard should handle unsolicited output from the engine, +
-engineDebugOutput number
Specifies how WinBoard should handle unsolicited output from the engine, with respect to saving it in the debug file. The output is further (hopefully) ignored. If number=0, WinBoard refrains from writing such spurious output to the debug file. @@ -1769,14 +1779,14 @@ as the engine itself should have done if it wanted to submit info for inclusion This option is provided for the benefit of applications that use the debug file as a source of information, such as the broadcaster of live games TLCV / TLCS. Such applications can be protected from spurious engine output that might otherwise confuse them. -
-rsh or -remoteShell shell-name
Name of the command used to run programs remotely. The default +
-rsh or -remoteShell shell-name
Name of the command used to run programs remotely. The default is rsh or remsh, determined when XBoard is configured and compiled. -
-ruser or -remoteUser user-name
User name on the remote system when running programs with the +
-ruser or -remoteUser user-name
User name on the remote system when running programs with the remoteShell. The default is your local user name. -
-userName username
Name under which the Human player will be listed in the PGN file. +
-userName username
Name under which the Human player will be listed in the PGN file. Default is the login name on your local computer. -
-delayBeforeQuit number
-delayAfterQuit number
These options specify how long WinBoard 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. +
-delayBeforeQuit number
-delayAfterQuit number
These options specify how long WinBoard 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.
@@ -1791,7 +1801,7 @@ Up: Top

4 Chess Servers

-

An Internet Chess Server, or ICS, is a place on the +

An Internet Chess Server, or ICS, is a place on the Internet where people can get together to play chess, watch other people's games, or just chat. You can use either telnet or a client program like XBoard to connect to the server. There are @@ -1824,25 +1834,25 @@ unique guest name for you. Some useful ICS commands include

-
help <topic>
to get help on the given <topic>. To get a list of possible topics type +
help <topic>
to get help on the given <topic>. To get a list of possible topics type help without topic. Try the help command before you ask other people on the server for help. For example help register tells you how to become a registered ICS player. -
who <flags>
to see a list of people who are logged on. Administrators +
who <flags>
to see a list of people who are logged on. Administrators (people you should talk to if you have a problem) are marked with the character ‘*’, an asterisk. The <flags> allow you to display only selected players: For example, who of shows a list of players who are interested in playing but do not have an opponent. -
games
to see what games are being played +
games
to see what games are being played
match <player> [<mins>] [<inc>]
to challenge another player to a game. Both opponents get <mins> minutes for the game, and <inc> seconds will be added after each move. If another player challenges you, the server asks if you want to accept the challenge; use the accept or decline commands to answer. -
accept
decline
to accept or decline another player's offer. +
accept
decline
to accept or decline another player's offer. The offer may be to start a new game, or to agree to a draw, adjourn or abort the current game. See Action Menu. @@ -1850,7 +1860,7 @@ If you have more than one pending offer (for example, if more than one player is challenging you, or if your opponent offers both a draw and to adjourn the game), you have to supply additional information, by typing something like accept <player>, accept draw, or draw. -
draw
adjourn
abort
asks your opponent to terminate a game by mutual agreement. Adjourned +
draw
adjourn
abort
asks your opponent to terminate a game by mutual agreement. Adjourned games can be continued later. Your opponent can either decline your offer or accept it (by typing the same command or typing accept). In some cases these commands work @@ -1858,11 +1868,11 @@ immediately, without asking your opponent to agree. For example, you can abort the game unilaterally if your opponent is out of time, and you can claim a draw by repetition or the 50-move rule if available simply by typing draw. -
finger <player>
to get information about the given <player>. (Default: yourself.) -
vars
to get a list of personal settings -
set <var> <value>
to modify these settings -
observe <player>
to observe an ongoing game of the given <player>. -
examine
oldmoves
to review a recently completed game +
finger <player>
to get information about the given <player>. (Default: yourself.) +
vars
to get a list of personal settings +
set <var> <value>
to modify these settings +
observe <player>
to observe an ongoing game of the given <player>. +
examine
oldmoves
to review a recently completed game
Some special XBoard features are activated when you are @@ -2018,7 +2028,7 @@ Up: Top

6 Environment variables

-

Game and position files are found in a directory named by the +

Game and position files are found in a directory named by the CHESSDIR environment variable. If this variable is not set, the current working directory is used. If CHESSDIR is set, XBoard actually changes its working directory to @@ -2036,7 +2046,7 @@ Up: Top

7 Limitations and known bugs

-

There is no way for two people running copies of XBoard to play +

There is no way for two people running copies of XBoard to play each other without going through an Internet Chess Server. Under some circumstances, your ICS password may be echoed when you log on. @@ -2101,7 +2111,7 @@ Up: Top

8 Reporting problems

-

+

Report bugs and problems with XBoard to <bug-xboard@gnu.org>. Please use the script program to start a typescript, run @@ -2146,7 +2156,7 @@ Up: Top

9 Authors and contributors

-

+

Tim Mann has been responsible for XBoard versions 1.3 and beyond, and for WinBoard, a port of XBoard to Microsoft Win32 (Windows NT and Windows 95). H.G.Muller is responsible for version 4.3. @@ -2203,7 +2213,7 @@ Up: Top

10 CMail

-

The cmail program can help you play chess by email with opponents of +

The cmail program can help you play chess by email with opponents of your choice using XBoard as an interface. You will usually run cmail without giving any options. @@ -2263,10 +2273,10 @@ directory as cmail keeps its working files (above). environment variable $CMAIL_MAILPROG or failing that /usr/ucb/Mail, /usr/ucb/mail or Mail. You will need to set this variable if none of the above paths fit your system. -

-gamesFile <file>
A file containing a list of games with email addresses. This defaults to +
-gamesFile <file>
A file containing a list of games with email addresses. This defaults to the environment variable $CMAIL_GAMES or failing that .cmailgames. -
-aliasesFile <file>
A file containing one or more aliases for a set of email addresses. This +
-aliasesFile <file>
A file containing one or more aliases for a set of email addresses. This defaults to the environment variable $CMAIL_ALIASES or failing that .cmailaliases.
-logFile <file>
A file in which to dump verbose debugging messages that are invoked with @@ -2421,7 +2431,7 @@ Up: Top

11 Other programs you can use with XBoard

-

+

Here are some other programs you can use with XBoard @@ -3345,227 +3355,228 @@ Up: Top

Table of Contents