+\input texinfo @c -*-texinfo-*-
+@c %**start of header
@setfilename xboard.info
+@settitle XBoard
+@c %**end of header
+
+@include version.texi
@ifinfo
@format
the engine's scores. To faclitate the latter, you can inform xboard here if
the engines report scores from the viewpoint of white, or from that of their own color.
@item Engine Settings
-@citem Engine Settings, Menu Item
Pops up a sub-menu where you can set some engine parameters common to most engines,
such as hash-table size, tablebase cache size, maximum number of processors
that SMP engines can use, and where to find the Polyglot adapter needed
You can add or remove shortcut keys using the X resources
@code{form.translations}. Here is an example of what would go in your
-@file{.Xdefaults} file:
+@file{.Xresources} file:
@example
XBoard*form.translations: \
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{.Xdefaults} file). Many of the options
+(typically in your @file{.Xresources} 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 @ref{Options} menu.
interchangeably.
Each option corresponds to an X resource with the same name, so
-if you like, you can set options in your @file{.Xdefaults} file
+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.
@menu
* Chess engine options:: Controlling the chess engine.
-* WB + UCI Engine Settings:: Setting some very common engine parameters
+* UCI + WB Engine Settings:: Setting some very common engine parameters
* ICS options:: Connecting to and using ICS.
* Load and Save options:: Input/output options.
* User interface options:: Look and feel options.
-* Adjudication options:: Control adjudcation of engine-engine games.
+* Adjudication Options:: Control adjudcation of engine-engine games.
* Other options:: Miscellaneous.
@end menu
@cindex ponderNextMove, option
Sets the Ponder Next Move menu option. @xref{Options Menu}. Default: true.
@item -smpCores number
-@citem smpCores, option
Specifies the maxmum nmber of CPUs an SMP engine is allowed to use.
Only works for engines that support the WinBoard-protocol cores feature.
@item -mg or -matchGames n
Setting @code{matchMode} to true is equivalent to setting
@code{matchGames} to 1.
@item -sameColorGames n
-@cinex sameColorGames, option
+@cindex sameColorGames, option
Automatically runs an n-game match between two chess engines,
without alternating colors.
Otherwise the same applies as for the @samp{-matchGames} option,
type in real newline characters, including one at the very end.
In most shells you can do this by
entering a @samp{\} character followed by a newline. It is easier to set
-the option from your @file{.Xdefaults} file; in that case you can
+the option from your @file{.Xresources} file; in that case you can
include the character sequence @samp{\n} in the string, and it will
be converted to a newline.
Important when XBoard uses the score for adjudications, or in PGN reporting.
@end table
-
-
@node UCI + WB Engine Settings
+@section UCI + WB Engine Settings
@cindex Engine Settings
@cindex Settings, Engine
@table @asis
@end table
@node ICS options
-@section Internet Chess Server Options
+@section ICS options
@cindex ICS options
@cindex Options, ICS
@table @asis
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 @file{.Xdefaults} file.
+Here is an example of how to set the colors in your @file{.Xresources} file.
The colors shown here are the default values; you will get
them if you turn @code{-colorize} on without specifying your own colors.
aborted, adjourned, or otherwise ends inconclusively. Default: "" (no
sound).
-Here is an example of how to set the sounds in your .Xdefaults file:
+Here is an example of how to set the sounds in your @file{.Xresources} file:
@example
xboard*soundShout: shout.wav
@end table
@node Load and Save options
-@section Load and Save Options
+@section Load and Save options
@cindex Options, Load and Save
@cindex Load and Save options
@table @asis
The @code{rewindIndex} option causes the index to be reset to the
first game of the file when it has reached a specified value.
@item -rewindIndex n
-@citem rewindIndex, option
Causes a position file or game file to be rewound to its beginning after n
positions or games in auto-increment @code{matchMode}.
See @code{loadPositionIndex} and @code{loadGameIndex}.
@end table
@node User interface options
-@section User Interface Options
+@section User interface options
@cindex User interface options
@cindex Options, User interface
@table @asis
@end table
@node Other options
-@section Other Options
+@section Other options
@cindex Options, miscellaneous
@table @asis
@item -ncp/-xncp or -noChessProgram true/false
xboard -ics -icshost firewall.example.com -icsport 23
@end example
@noindent
-Or in your @file{.Xdefaults} file:
+Or in your @file{.Xresources} file:
@example
XBoard*internetChessServerHost: firewall.example.com
@end example
@noindent
-Or in your @file{.Xdefaults} file:
+Or in your @file{.Xresources} file:
@example
XBoard*gateway: rsh.example.com
@end example
@noindent
-Or in your @file{.Xdefaults} file:
+Or in your @file{.Xresources} file:
@example
XBoard*useTelnet: true
alternative ports. As noted above, your chess server may allow you to
connect on port 23 instead. In that case, just add the option
@samp{-icsport ""} to the above command, or add
-@samp{XBoard*internetChessServerPort:} to your @file{.Xdefaults} file.
+@samp{XBoard*internetChessServerPort:} to your @file{.Xresources} file.
But if your chess server doesn't let you connect on port 23, you will have
to find some other host outside the firewall and hop through it. For
instance, suppose you have a shell account at @samp{foo.edu}. Set
@end example
@noindent
-Or in your @file{.Xdefaults} file:
+Or in your @file{.Xresources} file:
@example
XBoard*useTelnet: true
@menu
* GNU Chess:: The GNU Chess engine.
+* Fairy-Max:: The Fairy-Max chess engine.
+* HoiChess:: The HoiChess chess engine.
* Crafty:: The Crafty chess engine.
* zic2xpm:: The program used to import chess sets from ZIICS.
@end menu
xboard -pixmap ~/fritz4
@end example
-Alternatively, you can add this line to your .Xdefaults file:
+Alternatively, you can add this line to your @file{.Xresources} file:
@example
xboard*pixmapDirectory: ~/fritz4
@printindex cp
@contents
@c end noman
+
+@bye
projects / xboard.git / blobdiff