<h3 class="section">3.3 ICS options</h3>
-<p><a name="index-ICS-options-189"></a><a name="index-Options_002c-ICS-190"></a>
+<p><a name="index-ICS-options-191"></a><a name="index-Options_002c-ICS-192"></a>
<dl>
-<dt>-ics/-xics or -internetChessServerMode true/false<dd><a name="index-ics_002c-option-191"></a><a name="index-internetChessServerMode_002c-option-192"></a>Connect with an Internet Chess Server to play chess against its\r
+<dt>-ics/-xics or -internetChessServerMode true/false<dd><a name="index-ics_002c-option-193"></a><a name="index-internetChessServerMode_002c-option-194"></a>Connect with an Internet Chess Server to play chess against its\r
other users, observe games they are playing, or review games\r
that have recently finished. Default: false.\r
-<br><dt>-icshost or -internetChessServerHost host<dd><a name="index-icshost_002c-option-193"></a><a name="index-internetChessServerHost_002c-option-194"></a>The Internet host name or address of the chess server to connect\r
+<br><dt>-icshost or -internetChessServerHost host<dd><a name="index-icshost_002c-option-195"></a><a name="index-internetChessServerHost_002c-option-196"></a>The Internet host name or address of the chess server to connect\r
to when in ICS mode. Default: <code>chessclub.com</code>.\r
Another popular chess server to try is <code>freechess.org</code>.\r
If your site doesn't have a working Internet name server, try\r
You may also need\r
to specify the numeric address when using the icshelper option\r
with timestamp or timeseal (see below).\r
-<br><dt>-icsport or -internetChessServerPort port-number<dd><a name="index-icsport_002c-option-195"></a><a name="index-internetChessServerPort_002c-option-196"></a>The port number to use when connecting to a chess server in ICS\r
+<br><dt>-icsport or -internetChessServerPort port-number<dd><a name="index-icsport_002c-option-197"></a><a name="index-internetChessServerPort_002c-option-198"></a>The port number to use when connecting to a chess server in ICS\r
mode. Default: 5000.\r
-<br><dt>-icshelper or -internetChessServerHelper prog-name<dd><a name="index-icshelper_002c-option-197"></a><a name="index-internetChessServerHelper_002c-option-198"></a>An external helper program used to communicate with the chess server.\r
+<br><dt>-icshelper or -internetChessServerHelper prog-name<dd><a name="index-icshelper_002c-option-199"></a><a name="index-internetChessServerHelper_002c-option-200"></a>An external helper program used to communicate with the chess server.\r
You would set it to "timestamp" for ICC (chessclub.com) or\r
"timeseal" for FICS (freechess.org), after\r
obtaining the correct version of timestamp or timeseal for your\r
computer. See "help timestamp" on ICC and "help timeseal" on FICS.\r
This option is shorthand for <code>-useTelnet -telnetProgram program</code>.\r
-<br><dt>-telnet/-xtelnet or -useTelnet true/false<dd><a name="index-telnet_002c-option-199"></a><a name="index-useTelnet_002c-option-200"></a>This option is poorly named; it should be called useHelper.\r
+<br><dt>-telnet/-xtelnet or -useTelnet true/false<dd><a name="index-telnet_002c-option-201"></a><a name="index-useTelnet_002c-option-202"></a>This option is poorly named; it should be called useHelper.\r
If set to true, it instructs XBoard to run an external\r
program to communicate with the Internet Chess Server. \r
The program to use is given by the telnetProgram option.\r
false (the default), XBoard opens a TCP socket and uses its own\r
internal implementation of the telnet protocol to communicate with the\r
ICS. See <a href="Firewalls.html#Firewalls">Firewalls</a>.\r
-<br><dt>-telnetProgram prog-name<dd><a name="index-telnetProgram_002c-option-201"></a>This option is poorly named; it should be called helperProgram.\r
+<br><dt>-telnetProgram prog-name<dd><a name="index-telnetProgram_002c-option-203"></a>This option is poorly named; it should be called helperProgram.\r
It gives the name of the telnet program to be used with\r
the <code>gateway</code> and <code>useTelnet</code> options. The default is\r
<samp><span class="file">telnet</span></samp>. The telnet program is invoked with the value of\r
<code>internetChessServerHost</code> as its first argument and the value\r
of <code>internetChessServerPort</code> as its second argument.\r
See <a href="Firewalls.html#Firewalls">Firewalls</a>.\r
-<br><dt>-gateway host-name<dd><a name="index-gateway_002c-option-202"></a>If this option is set to a host name, XBoard communicates with the\r
+<br><dt>-gateway host-name<dd><a name="index-gateway_002c-option-204"></a>If this option is set to a host name, XBoard communicates with the\r
Internet Chess Server by using <samp><span class="file">rsh</span></samp> to run\r
the <code>telnetProgram</code> on the given host,\r
instead of using its own internal implementation\r
of the telnet protocol. You can substitute a different remote shell\r
program for <samp><span class="file">rsh</span></samp> using the <code>remoteShell</code> option described below.\r
See <a href="Firewalls.html#Firewalls">Firewalls</a>.\r
-<br><dt>-internetChessServerCommPort or -icscomm dev-name<dd><a name="index-internetChessServerCommPort_002c-option-203"></a><a name="index-icscomm_002c-option-204"></a>If this option is set, XBoard communicates with the ICS through\r
+<br><dt>-internetChessServerCommPort or -icscomm dev-name<dd><a name="index-internetChessServerCommPort_002c-option-205"></a><a name="index-icscomm_002c-option-206"></a>If this option is set, XBoard communicates with the ICS through\r
the given character I/O device instead of opening a TCP connection.\r
Use this option if your system does not have any kind of\r
Internet connection itself (not even a SLIP or PPP connection),\r
<kbd>telnet chessclub.com 5000</kbd>.\r
Important: See the paragraph below about extra echoes, \r
in <a href="Limitations.html#Limitations">Limitations</a>.\r
-<br><dt>-icslogon or -internetChessServerLogonScript file-name<dd><a name="index-icslogon_002c-option-205"></a><a name="index-internetChessServerLogonScript_002c-option-206"></a><a name="index-g_t_002eicsrc-207"></a>Whenever XBoard connects to the Internet Chess Server,\r
+<br><dt>-icslogon or -internetChessServerLogonScript file-name<dd><a name="index-icslogon_002c-option-207"></a><a name="index-internetChessServerLogonScript_002c-option-208"></a><a name="index-g_t_002eicsrc-209"></a>Whenever XBoard connects to the Internet Chess Server,\r
if it finds a file with the name given in this option, it feeds the\r
file's contents to the ICS as commands. The default file name\r
is <samp><span class="file">.icsrc</span></samp>.\r
your ICS user name and password.\r
The file can be either in $CHESSDIR, in XBoard's working\r
directory if CHESSDIR is not set, or in your home directory.\r
-<br><dt>-msLoginDelay delay<dd><a name="index-msLoginDelay_002c-option-208"></a>If you experience trouble logging on to an ICS when using the\r
+<br><dt>-msLoginDelay delay<dd><a name="index-msLoginDelay_002c-option-210"></a>If you experience trouble logging on to an ICS when using the\r
<code>-icslogon</code> option, inserting some delay between characters\r
of the logon script may help. This option adds <code>delay</code>\r
milliseconds of delay between characters. Good values to try\r
are 100 and 250.\r
-<br><dt>-icsinput/-xicsinput or -internetChessServerInputBox true/false<dd><a name="index-icsinput_002c-option-209"></a><a name="index-internetChessServerInputBox_002c-option-210"></a>Sets the ICS Input Box menu option. See <a href="Mode-Menu.html#Mode-Menu">Mode Menu</a>. Default: false.\r
-<br><dt>-autocomm/-xautocomm or -autoComment true/false<dd><a name="index-autocomm_002c-option-211"></a><a name="index-autoComment_002c-option-212"></a>Sets the Auto Comment menu option. See <a href="Options-Menu.html#Options-Menu">Options Menu</a>. Default: false.\r
-<br><dt>-autoflag/-xautoflag or -autoCallFlag true/false<dd><a name="index-autoflag_002c-option-213"></a><a name="index-autoCallFlag_002c-option-214"></a>Sets the Auto Flag menu option. See <a href="Options-Menu.html#Options-Menu">Options Menu</a>. Default: false.\r
-<br><dt>-autobs/-xautobs or -autoObserve true/false<dd><a name="index-autobs_002c-option-215"></a><a name="index-autoObserve_002c-option-216"></a>Sets the Auto Observe menu option. See <a href="Options-Menu.html#Options-Menu">Options Menu</a>. Default: false.\r
-<br><dt>-autoKibitz<dd><a name="index-autoKibitz_002c-option-217"></a>Enables kibitzing of the engines last thinking output (depth, score, time, speed, PV) \r
+<br><dt>-icsinput/-xicsinput or -internetChessServerInputBox true/false<dd><a name="index-icsinput_002c-option-211"></a><a name="index-internetChessServerInputBox_002c-option-212"></a>Sets the ICS Input Box menu option. See <a href="Mode-Menu.html#Mode-Menu">Mode Menu</a>. Default: false.\r
+<br><dt>-autocomm/-xautocomm or -autoComment true/false<dd><a name="index-autocomm_002c-option-213"></a><a name="index-autoComment_002c-option-214"></a>Sets the Auto Comment menu option. See <a href="Options-Menu.html#Options-Menu">Options Menu</a>. Default: false.\r
+<br><dt>-autoflag/-xautoflag or -autoCallFlag true/false<dd><a name="index-autoflag_002c-option-215"></a><a name="index-autoCallFlag_002c-option-216"></a>Sets the Auto Flag menu option. See <a href="Options-Menu.html#Options-Menu">Options Menu</a>. Default: false.\r
+<br><dt>-autobs/-xautobs or -autoObserve true/false<dd><a name="index-autobs_002c-option-217"></a><a name="index-autoObserve_002c-option-218"></a>Sets the Auto Observe menu option. See <a href="Options-Menu.html#Options-Menu">Options Menu</a>. Default: false.\r
+<br><dt>-autoKibitz<dd><a name="index-autoKibitz_002c-option-219"></a>Enables kibitzing of the engines last thinking output (depth, score, time, speed, PV) \r
before it moved\r
to the ICS, in zippy mode. The option <code>showThinking</code> must be switched on for \r
this option to work.\r
Also diverts similar kibitz information of an opponent engine that is playing you \r
through the ICS to the engine-output window, as if the engine was playing locally.\r
-<br><dt>-moves/-xmoves or -getMoveList true/false<dd><a name="index-moves_002c-option-218"></a><a name="index-getMoveList_002c-option-219"></a>Sets the Get Move List menu option. See <a href="Options-Menu.html#Options-Menu">Options Menu</a>. Default: true.\r
-<br><dt>-alarm/-xalarm or -icsAlarm true/false<dd><a name="index-alarm_002c-option-220"></a><a name="index-icsAlarm_002c-option-221"></a>Sets the ICS Alarm menu option. See <a href="Options-Menu.html#Options-Menu">Options Menu</a>. Default: true.\r
-<br><dt>-icsAlarmTime ms<dd><a name="index-icsAlarmTime_002c-option-222"></a>Sets the time in milliseconds for the ICS Alarm menu option. \r
+<br><dt>-moves/-xmoves or -getMoveList true/false<dd><a name="index-moves_002c-option-220"></a><a name="index-getMoveList_002c-option-221"></a>Sets the Get Move List menu option. See <a href="Options-Menu.html#Options-Menu">Options Menu</a>. Default: true.\r
+<br><dt>-alarm/-xalarm or -icsAlarm true/false<dd><a name="index-alarm_002c-option-222"></a><a name="index-icsAlarm_002c-option-223"></a>Sets the ICS Alarm menu option. See <a href="Options-Menu.html#Options-Menu">Options Menu</a>. Default: true.\r
+<br><dt>-icsAlarmTime ms<dd><a name="index-icsAlarmTime_002c-option-224"></a>Sets the time in milliseconds for the ICS Alarm menu option. \r
See <a href="Options-Menu.html#Options-Menu">Options Menu</a>. Default: 5000.\r
-<br><dt>-pre/-xpre \fRor\fB -premove true/false<dd><a name="index-pre_002c-option-223"></a><a name="index-premove_002c-option-224"></a>Sets the Premove menu option. See <a href="Options-Menu.html#Options-Menu">Options Menu</a>. Default: true.\r
-<br><dt>-quiet/-xquiet or -quietPlay true/false<dd><a name="index-quiet_002c-option-225"></a><a name="index-quietPlay_002c-option-226"></a>Sets the Quiet Play menu option. See <a href="Options-Menu.html#Options-Menu">Options Menu</a>. Default: false.\r
-<br><dt>-colorizeMessages or -colorize<dd><a name="index-Colors-227"></a><a name="index-colorize_002c-option-228"></a>Setting colorizeMessages\r
+<br><dt>-pre/-xpre \fRor\fB -premove true/false<dd><a name="index-pre_002c-option-225"></a><a name="index-premove_002c-option-226"></a>Sets the Premove menu option. See <a href="Options-Menu.html#Options-Menu">Options Menu</a>. Default: true.\r
+<br><dt>-quiet/-xquiet or -quietPlay true/false<dd><a name="index-quiet_002c-option-227"></a><a name="index-quietPlay_002c-option-228"></a>Sets the Quiet Play menu option. See <a href="Options-Menu.html#Options-Menu">Options Menu</a>. Default: false.\r
+<br><dt>-colorizeMessages or -colorize<dd><a name="index-Colors-229"></a><a name="index-colorize_002c-option-230"></a>Setting colorizeMessages\r
to true tells XBoard to colorize the messages received from\r
the ICS. Colorization works only if your xterm \r
supports ISO 6429 escape sequences for changing text colors.\r
-<br><dt>-colorShout foreground,background,bold<dt>-colorSShout foreground,background,bold<dt>-colorChannel1 foreground,background,bold<dt>-colorChannel foreground,background,bold<dt>-colorKibitz foreground,background,bold<dt>-colorTell foreground,background,bold<dt>-colorChallege foreground,background,bold<dt>-colorRequest foreground,background,bold<dt>-colorSeek foreground,background,bold<dt>-colorNormal foreground,background,bold<dd><a name="index-Colors-229"></a><a name="index-colorShout_002c-option-230"></a><a name="index-colorSShout_002c-option-231"></a><a name="index-colorChannel1_002c-option-232"></a><a name="index-colorChannel_002c-option-233"></a><a name="index-colorKibitz_002c-option-234"></a><a name="index-colorTell_002c-option-235"></a><a name="index-colorChallenge_002c-option-236"></a><a name="index-colorRequest_002c-option-237"></a><a name="index-colorSeek_002c-option-238"></a><a name="index-colorNormal_002c-option-239"></a>These options set the colors used when colorizing ICS messages.\r
+<br><dt>-colorShout foreground,background,bold<dt>-colorSShout foreground,background,bold<dt>-colorChannel1 foreground,background,bold<dt>-colorChannel foreground,background,bold<dt>-colorKibitz foreground,background,bold<dt>-colorTell foreground,background,bold<dt>-colorChallege foreground,background,bold<dt>-colorRequest foreground,background,bold<dt>-colorSeek foreground,background,bold<dt>-colorNormal foreground,background,bold<dd><a name="index-Colors-231"></a><a name="index-colorShout_002c-option-232"></a><a name="index-colorSShout_002c-option-233"></a><a name="index-colorChannel1_002c-option-234"></a><a name="index-colorChannel_002c-option-235"></a><a name="index-colorKibitz_002c-option-236"></a><a name="index-colorTell_002c-option-237"></a><a name="index-colorChallenge_002c-option-238"></a><a name="index-colorRequest_002c-option-239"></a><a name="index-colorSeek_002c-option-240"></a><a name="index-colorNormal_002c-option-241"></a>These options set the colors used when colorizing ICS messages.\r
All ICS messages are grouped into one of these categories:\r
shout, sshout, channel 1, other channel, kibitz, tell, challenge, \r
request (including abort, adjourn, draw, pause, and takeback), or\r
xboard*colorSeek: blue\r
xboard*colorNormal: default\r
</pre>
- <br><dt>-soundProgram progname<dd><a name="index-soundProgram_002c-option-240"></a><a name="index-Sounds-241"></a>If this option is set to a sound-playing program that is installed and\r
+ <br><dt>-soundProgram progname<dd><a name="index-soundProgram_002c-option-242"></a><a name="index-Sounds-243"></a>If this option is set to a sound-playing program that is installed and\r
working on your system, XBoard can play sound files when certain\r
events occur, listed below. The default program name is "play". If\r
any of the sound options is set to "$", the event rings the terminal\r
bell by sending a ^G character to standard output, instead of playing\r
a sound file. If an option is set to the empty string "", no sound is\r
played for that event.\r
-<br><dt>-soundShout filename<dt>-soundSShout filename<dt>-soundChannel filename<dt>-soundKibitz filename<dt>-soundTell filename<dt>-soundChallenge filename<dt>-soundRequest filename<dt>-soundSeek filename<dd><a name="index-soundShout_002c-option-242"></a><a name="index-soundSShout_002c-option-243"></a><a name="index-soundChannel_002c-option-244"></a><a name="index-soundKibitz_002c-option-245"></a><a name="index-soundTell_002c-option-246"></a><a name="index-soundChallenge_002c-option-247"></a><a name="index-soundRequest_002c-option-248"></a><a name="index-soundSeek_002c-option-249"></a>These sounds are triggered in the same way as the colorization events\r
+<br><dt>-soundShout filename<dt>-soundSShout filename<dt>-soundChannel filename<dt>-soundKibitz filename<dt>-soundTell filename<dt>-soundChallenge filename<dt>-soundRequest filename<dt>-soundSeek filename<dd><a name="index-soundShout_002c-option-244"></a><a name="index-soundSShout_002c-option-245"></a><a name="index-soundChannel_002c-option-246"></a><a name="index-soundKibitz_002c-option-247"></a><a name="index-soundTell_002c-option-248"></a><a name="index-soundChallenge_002c-option-249"></a><a name="index-soundRequest_002c-option-250"></a><a name="index-soundSeek_002c-option-251"></a>These sounds are triggered in the same way as the colorization events\r
described above. They all default to "", no sound. They are played\r
only if the colorizeMessages is on.\r
-<br><dt>-soundMove filename<dd><a name="index-soundMove_002c-option-250"></a>This sound is used by the Move Sound menu option. Default: "$".\r
-<br><dt>-soundIcsAlarm filename<dd><a name="index-soundIcsAlarm_002c-option-251"></a>This sound is used by the ICS Alarm menu option. Default: "$".\r
-<br><dt>-soundIcsWin filename<dd><a name="index-soundIcsWin_002c-option-252"></a>This sound is played when you win an ICS game. Default: "" (no sound).\r
-<br><dt>-soundIcsLoss filename<dd><a name="index-soundIcsLoss_002c-option-253"></a>This sound is played when you lose an ICS game. Default: "" (no sound).\r
-<br><dt>-soundIcsDraw filename<dd><a name="index-soundIcsDraw_002c-option-254"></a>This sound is played when you draw an ICS game. Default: "" (no sound).\r
-<br><dt>-soundIcsUnfinished filename<dd><a name="index-soundIcsUnfinished_002c-option-255"></a>This sound is played when an ICS game that you are participating in is\r
+<br><dt>-soundMove filename<dd><a name="index-soundMove_002c-option-252"></a>This sound is used by the Move Sound menu option. Default: "$".\r
+<br><dt>-soundIcsAlarm filename<dd><a name="index-soundIcsAlarm_002c-option-253"></a>This sound is used by the ICS Alarm menu option. Default: "$".\r
+<br><dt>-soundIcsWin filename<dd><a name="index-soundIcsWin_002c-option-254"></a>This sound is played when you win an ICS game. Default: "" (no sound).\r
+<br><dt>-soundIcsLoss filename<dd><a name="index-soundIcsLoss_002c-option-255"></a>This sound is played when you lose an ICS game. Default: "" (no sound).\r
+<br><dt>-soundIcsDraw filename<dd><a name="index-soundIcsDraw_002c-option-256"></a>This sound is played when you draw an ICS game. Default: "" (no sound).\r
+<br><dt>-soundIcsUnfinished filename<dd><a name="index-soundIcsUnfinished_002c-option-257"></a>This sound is played when an ICS game that you are participating in is\r
aborted, adjourned, or otherwise ends inconclusively. Default: "" (no\r
sound).\r
\r
projects / xboard.git / blobdiff