| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
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 `.Xdefaults' file). Many of the options cannot be changed while XBoard is running; others set the initial state of items that can be changed with the 3. Options menu.
Most of the options have both a long name and a short name. To turn a boolean option on or off from the command line, either give its long name followed by the value true or false (`-longOptionName true'), or give just the short name to turn the option on (`-opt'), or the short name preceded by `x' to turn the option off (`-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 `.Xdefaults' file or in a file named `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 (`XBoard*longOptionName: true').
3.1 Chess Engine Options Controlling the chess engine. 3.2 Internet Chess Server Options Connecting to and using ICS. 3.3 Load and Save Options Input/output options. 3.4 User Interface Options Look and feel options. 3.5 Other Options Miscellaneous.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
timeControl period.
Default: 5 minutes.
The additional options movesPerSession and timeIncrement
are mutually exclusive.
movesPerSession moves, a
new timeControl period is added to both clocks. Default: 40 moves.
movesPerSession is ignored.
Instead, after each player's move, timeIncrement seconds are
added to his clock.
Use `-inc 0' if you want to require the entire
game to be played in one timeControl period, with no increment.
Default: -1, which specifies movesPerSession mode.
searchTime
is set, the chess engine still keeps track of the clock time and uses it to
determine how fast to make its moves.
loadGameFile or loadPositionFile option is set,
XBoard
starts each game with the given opening moves or the given position;
otherwise, the games start with the standard initial chess position.
If the saveGameFile option is set, a move record for the
match is appended to the specified file. If the savePositionFile
option is set, the final position reached in each game of the match is appended
to the specified file. When the match is over, XBoard
displays the match score and exits. Default: 0 (do not run a match).
matchMode to true is equivalent to setting
matchGames to 1.
remoteShell
option described below.)
new random |
If you change this option, don't remove the `new' command; it is required by all chess engines to start a new game.
You can remove the `random' command if you like; including it causes GNU Chess 4 to randomize its move selection slightly so that it doesn't play the same moves in every game. Even without `random', GNU Chess 4 randomizes its choice of moves from its opening book. Many other chess engines ignore this command entirely and always (or never) randomize.
You can also try adding other commands to the initString; see the documentation of the chess engine you are using for details.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
chessclub.com.
Another popular chess server to try is freechess.org.
If your site doesn't have a working Internet name server, try
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).
-useTelnet -telnetProgram program.
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 section 5. Firewalls.
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 section 5. Firewalls.
The support for this option in XBoard is minimal. You need to set all communication parameters and tty modes before you enter XBoard.
Use a script something like this:
stty raw -echo 9600 > /dev/tty00 xboard -ics -icscomm /dev/tty00 |
Here replace `/dev/tty00' with the name of the device that your
modem is connected to. You might have to add several more
options to these stty commands. See the man pages for `stty'
and tty if you run into problems. Also, on many systems stty
works on its standard input instead of standard output, so you
have to use `<' instead of `>'.
If you are using linux, try starting with the script below. Change it as necessary for your installation.
#!/bin/sh -f # configure modem and fire up XBoard # configure modem ( stty 2400 ; stty raw ; stty hupcl ; stty -clocal stty ignbrk ; stty ignpar ; stty ixon ; stty ixoff stty -iexten ; stty -echo ) < /dev/modem xboard -ics -icscomm /dev/modem |
-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.
Each foreground or background argument can be one of the following: black, red, green, yellow, blue, magenta, cyan, white, or default. Here "default" means the default foreground or background color of your xterm. Bold can be 1 or 0. If background is omitted, "default" is assumed; if bold is omitted, 0 is assumed.
Here is an example of how to set the colors in your `.Xdefaults' file.
The colors shown here are the default values; you will get
them if you turn -colorize on without specifying your own colors.
xboard*colorizeMessages: true xboard*colorShout: green xboard*colorSShout: green, black, 1 xboard*colorChannel1: cyan xboard*colorChannel: cyan, black, 1 xboard*colorKibitz: magenta, black, 1 xboard*colorTell: yellow, black, 1 xboard*colorChallenge: red, black, 1 xboard*colorRequest: red xboard*colorSeek: blue xboard*colorNormal: default |
Here is an example of how to set the sounds in your .Xdefaults file:
xboard*soundShout: shout.wav xboard*soundSShout: sshout.wav xboard*soundChannel1: channel1.wav xboard*soundChannel: channel.wav xboard*soundKibitz: kibitz.wav xboard*soundTell: tell.wav xboard*soundChallenge: challenge.wav xboard*soundRequest: request.wav xboard*soundSeek: seek.wav xboard*soundMove: move.wav xboard*soundIcsWin: win.wav xboard*soundIcsLoss: lose.wav xboard*soundIcsDraw: draw.wav xboard*soundIcsUnfinished: unfinished.wav xboard*soundIcsAlarm: alarm.wav |
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
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
(Portable Game Notation) tags.
If the loadGameIndex option is set to `N', the menu is suppressed
and the N th game found in the file is loaded immediately.
The menu is also suppressed if matchMode is enabled or if the game file
is a pipe; in these cases the first game in the file is loaded immediately.
Use the `pxboard' shell script provided with XBoard if you
want to pipe in files containing multiple games and still see the menu.
saveGameFile is set.
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
first position is loaded.
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
You can select other sizes or vary other layout parameters by providing
a list of comma-separated values (with no spaces) as the argument.
You do not need to provide all the values; for any you omit from the
end of the list, defaults are taken from the nearest built-in size.
The value n1 gives the piece size, n2 the width of the
black border
between squares, n3 the desired size for the
clockFont, n4 the desired size for the coordFont,
n5 the desired size for the default font,
n6 the smallLayout flag (0 or 1),
and n7 the tinyLayout flag (0 or 1).
All dimensions are in pixels.
If the border between squares is eliminated (0 width), the various
highlight options will not work, as there is nowhere to draw the highlight.
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.
coordFont option specifies what font to use.
monoMode; XBoard will determine if it is necessary.
flashCount
tells XBoard how many times to flash a piece after it
lands on its destination square.
flashRate
controls the rate of flashing (flashes/sec).
Abbreviations:
flash
sets flashCount to 3.
xflash
sets flashCount to 0.
Defaults: flashCount=0 (no flashing), flashRate=5.
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--*-*-*-*-*-*-*-*.
tol pixels
or less from the desired size. A value of -1 will force
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.
If XBoard is configured and compiled on a system that includes libXpm,
the X pixmap library, the xpm pixmap pieces are compiled in as the
default. A different xpm piece set can be selected at runtime with
the pixmapDirectory option, or a bitmap piece set can be selected
with the bitmapDirectory option.
If XBoard is configured and compiled on a system that does not include
libXpm (or the --disable-xpm option is given to the configure
program), the bitmap pieces are compiled in as the default. It is not
possible to use xpm pieces in this case, but pixmap pieces in another
format called "xim" can be used by giving the pixmapDirectory option.
Or again, a different bitmap piece set can be selected with the
bitmapDirectory option.
Files in the bitmapDirectory must be named as follows:
The first character of a piece bitmap name gives the piece it
represents (`p', `n', `b', `r', `q', or `k'),
the next characters give the size in pixels, the
following character indicates whether the piece is
solid or outline (`s' or `o'),
and the extension is `.bm'.
For example, a solid 80x80 knight would be named `n80s.bm'.
The outline bitmaps are used only in monochrome mode.
If bitmap pieces are compiled in and the bitmapDirectory is missing
some files, the compiled in pieces are used instead.
If the bitmapDirectory option is given, it is also possible to replace xboard's icons and menu checkmark, by supplying files named `icon_white.bm', `icon_black.bm', and `checkmark.bm'.
For more information about pixmap pieces and how to get additional sets, see 11.3 zic2xpm below.
-whitePieceColor #FFFFCC -blackPieceColor #202020 -lightSquareColor #C8C365 -darkSquareColor #77A26D -highlightSquareColor #FFFF00 -premoveHighlightColor #FF0000 |
On a grayscale monitor you might prefer:
-whitePieceColor gray100 -blackPieceColor gray0 -lightSquareColor gray80 -darkSquareColor gray60 -highlightSquareColor gray100 -premoveHighlightColor gray70 |
| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
normal Normal chess wildcastle Shuffle chess, king can castle from d file nocastle Shuffle chess, no castling allowed fischerandom Fischer Random shuffle chess bughouse Bughouse, ICC/FICS rules crazyhouse Crazyhouse, ICC/FICS rules losers Lose all pieces or get mated (ICC wild 17) suicide Lose all pieces including king (FICS) giveaway Try to have no legal moves (ICC wild 26) twokings Weird ICC wild 9 kriegspiel Opponent's pieces are invisible atomic Capturing piece explodes (ICC wild 27) 3check Win by giving check 3 times (ICC wild 25) shatranj An ancient precursor of chess (ICC wild 28) unknown Catchall for other unknown variants |
In the shuffle variants, xboard does not shuffle the pieces, but you can do it by hand using Edit Position. Some variants are supported only in ICS mode, including fischerandom, bughouse, and kriegspiel. The winning/drawing conditions in crazyhouse (offboard interposition on mate), losers, suicide, giveaway, atomic, and 3check are not fully understood. In crazyhouse, xboard does not yet keep track of offboard pieces. Shatranj is unsupported, but it may be usable if you turn off Test Legality.
remoteShell. The default is your local user name.
| [ << ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |