manual/html_node/ICS-options.html

   1 <html lang="en">
   2 <head>
   3 <title>ICS options - XBoard</title>
   4 <meta http-equiv="Content-Type" content="text/html">
   5 <meta name="description" content="XBoard">
   6 <meta name="generator" content="makeinfo 4.12">
   7 <link title="Top" rel="start" href="index.html#Top">
   8 <link rel="up" href="Options.html#Options" title="Options">
   9 <link rel="prev" href="UCI-_002b-WB-Engine-Settings.html#UCI-_002b-WB-Engine-Settings" title="UCI + WB Engine Settings">
  10 <link rel="next" href="Load-and-Save-options.html#Load-and-Save-options" title="Load and Save options">
  11 <link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
  12 <meta http-equiv="Content-Style-Type" content="text/css">
  13 <style type="text/css"><!--
  14   pre.display { font-family:inherit }
  15   pre.format  { font-family:inherit }
  16   pre.smalldisplay { font-family:inherit; font-size:smaller }
  17   pre.smallformat  { font-family:inherit; font-size:smaller }
  18   pre.smallexample { font-size:smaller }
  19   pre.smalllisp    { font-size:smaller }
  20   span.sc    { font-variant:small-caps }
  21   span.roman { font-family:serif; font-weight:normal; }
  22   span.sansserif { font-family:sans-serif; font-weight:normal; }
  23 --></style>
  24 </head>
  25 <body>
  26 <div class="node">
  27 <p>
  28 <a name="ICS-options"></a>
  29 Next:&nbsp;<a rel="next" accesskey="n" href="Load-and-Save-options.html#Load-and-Save-options">Load and Save options</a>,
  30 Previous:&nbsp;<a rel="previous" accesskey="p" href="UCI-_002b-WB-Engine-Settings.html#UCI-_002b-WB-Engine-Settings">UCI + WB Engine Settings</a>,
  31 Up:&nbsp;<a rel="up" accesskey="u" href="Options.html#Options">Options</a>
  32 <hr>
  33 </div>
  34
  35 <h3 class="section">3.3 ICS options</h3>
  36
  37 <p><a name="index-ICS-options-191"></a><a name="index-Options_002c-ICS-192"></a>
  38      <dl>
  39 <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
  40 other users, observe games they are playing, or review games
  41 that have recently finished. Default: false.
  42 <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
  43 to when in ICS mode. Default: <code>chessclub.com</code>.
  44 Another popular chess server to try is <code>freechess.org</code>.
  45 If your site doesn't have a working Internet name server, try
  46 specifying the host address in numeric form.
  47 You may also need
  48 to specify the numeric address when using the icshelper option
  49 with timestamp or timeseal (see below).
  50 <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
  51 mode. Default: 5000.
  52 <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.
  53 You would set it to "timestamp" for ICC (chessclub.com) or
  54 "timeseal" for FICS (freechess.org), after
  55 obtaining the correct version of timestamp or timeseal for your
  56 computer.  See "help timestamp" on ICC and "help timeseal" on FICS.
  57 This option is shorthand for <code>-useTelnet -telnetProgram program</code>.
  58 <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.
  59 If set to true, it instructs XBoard to run an external
  60 program to communicate with the Internet Chess Server.
  61 The program to use is given by the telnetProgram option.
  62 If the option is
  63 false (the default), XBoard opens a TCP socket and uses its own
  64 internal implementation of the telnet protocol to communicate with the
  65 ICS. See <a href="Firewalls.html#Firewalls">Firewalls</a>.
  66 <br><dt>-telnetProgram prog-name<dd><a name="index-telnetProgram_002c-option-203"></a>This option is poorly named; it should be called helperProgram.
  67 It gives the name of the telnet program to be used with
  68 the <code>gateway</code> and <code>useTelnet</code> options.  The default is
  69 <samp><span class="file">telnet</span></samp>. The telnet program is invoked with the value of
  70 <code>internetChessServerHost</code> as its first argument and the value
  71 of <code>internetChessServerPort</code> as its second argument.
  72 See <a href="Firewalls.html#Firewalls">Firewalls</a>.
  73 <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
  74 Internet Chess Server by using <samp><span class="file">rsh</span></samp> to run
  75 the <code>telnetProgram</code> on the given host,
  76 instead of using its own internal implementation
  77 of the telnet protocol. You can substitute a different remote shell
  78 program for <samp><span class="file">rsh</span></samp> using the <code>remoteShell</code> option described below.
  79 See <a href="Firewalls.html#Firewalls">Firewalls</a>.
  80 <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
  81 the given character I/O device instead of opening a TCP connection.
  82 Use this option if your system does not have any kind of
  83 Internet connection itself (not even a SLIP or PPP connection),
  84 but you do have dial-up access (or a hardwired terminal line) to
  85 an Internet service provider from which you can telnet to the ICS.
  86
  87      <p>The support for this option in XBoard is minimal. You need to
  88 set all communication parameters and tty modes before you enter
  89 XBoard.
  90
  91      <p>Use a script something like this:
  92
  93      <pre class="example">          stty raw -echo 9600 &gt; /dev/tty00
  94           xboard -ics -icscomm /dev/tty00
  95 </pre>
  96      <p>Here replace &lsquo;<samp><span class="samp">/dev/tty00</span></samp>&rsquo; with the name of the device that your
  97 modem is connected to. You might have to add several more
  98 options to these stty commands. See the man pages for <samp><span class="file">stty</span></samp>
  99 and <code>tty</code> if you run into problems. Also, on many systems stty
 100 works on its standard input instead of standard output, so you
 101 have to use &lsquo;<samp><span class="samp">&lt;</span></samp>&rsquo; instead of &lsquo;<samp><span class="samp">&gt;</span></samp>&rsquo;.
 102
 103      <p>If you are using linux, try starting with the script below.
 104 Change it as necessary for your installation.
 105
 106      <pre class="example">          #!/bin/sh -f
 107           # configure modem and fire up XBoard
 108
 109           # configure modem
 110           (
 111             stty 2400 ; stty raw ; stty hupcl ; stty -clocal
 112             stty ignbrk ; stty ignpar ; stty ixon ; stty ixoff
 113             stty -iexten ; stty -echo
 114           ) &lt; /dev/modem
 115           xboard -ics -icscomm /dev/modem
 116 </pre>
 117      <p class="noindent">After you start XBoard in this way, type whatever commands are
 118 necessary to dial out to your Internet provider and log in.
 119 Then telnet to ICS, using a command like
 120 <kbd>telnet chessclub.com 5000</kbd>.
 121 Important: See the paragraph below about extra echoes,
 122 in <a href="Limitations.html#Limitations">Limitations</a>.
 123 <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,
 124 if it finds a file with the name given in this option, it feeds the
 125 file's contents to the ICS as commands. The default file name
 126 is <samp><span class="file">.icsrc</span></samp>.
 127 Usually the first two lines of the file should be
 128 your ICS user name and password.
 129 The file can be either in $CHESSDIR, in XBoard's working
 130 directory if CHESSDIR is not set, or in your home directory.
 131 <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
 132 <code>-icslogon</code> option, inserting some delay between characters
 133 of the logon script may help. This option adds <code>delay</code>
 134 milliseconds of delay between characters. Good values to try
 135 are 100 and 250.
 136 <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.
 137 <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.
 138 <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.
 139 <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.
 140 <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)
 141 before it moved
 142 to the ICS, in zippy mode. The option <code>showThinking</code> must be switched on for
 143 this option to work.
 144 Also diverts similar kibitz information of an opponent engine that is playing you
 145 through the ICS to the engine-output window, as if the engine was playing locally.
 146 <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.
 147 <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.
 148 <br><dt>-icsAlarmTime ms<dd><a name="index-icsAlarmTime_002c-option-224"></a>Sets the time in milliseconds for the ICS Alarm menu option.
 149 See <a href="Options-Menu.html#Options-Menu">Options Menu</a>. Default: 5000.
 150 <br><dt>lowTimeWarning true/false<dd><a name="index-lowTimeWarning_002c-option-225"></a>Controls a color change of the board as a warning your time is running out.
 151 See <a href="Options-Menu.html#Options-Menu">Options Menu</a>. Default: false.
 152 <br><dt>-pre/-xpre \fRor\fB -premove true/false<dd><a name="index-pre_002c-option-226"></a><a name="index-premove_002c-option-227"></a>Sets the Premove menu option. See <a href="Options-Menu.html#Options-Menu">Options Menu</a>. Default: true.
 153 <br><dt>-quiet/-xquiet or -quietPlay true/false<dd><a name="index-quiet_002c-option-228"></a><a name="index-quietPlay_002c-option-229"></a>Sets the Quiet Play menu option.  See <a href="Options-Menu.html#Options-Menu">Options Menu</a>.  Default: false.
 154 <br><dt>-colorizeMessages or -colorize<dd><a name="index-Colors-230"></a><a name="index-colorize_002c-option-231"></a>Setting colorizeMessages
 155 to true tells XBoard to colorize the messages received from
 156 the ICS.  Colorization works only if your xterm
 157 supports ISO 6429 escape sequences for changing text colors.
 158 <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-232"></a><a name="index-colorShout_002c-option-233"></a><a name="index-colorSShout_002c-option-234"></a><a name="index-colorChannel1_002c-option-235"></a><a name="index-colorChannel_002c-option-236"></a><a name="index-colorKibitz_002c-option-237"></a><a name="index-colorTell_002c-option-238"></a><a name="index-colorChallenge_002c-option-239"></a><a name="index-colorRequest_002c-option-240"></a><a name="index-colorSeek_002c-option-241"></a><a name="index-colorNormal_002c-option-242"></a>These options set the colors used when colorizing ICS messages.
 159 All ICS messages are grouped into one of these categories:
 160 shout, sshout, channel 1, other channel, kibitz, tell, challenge,
 161 request (including abort, adjourn, draw, pause, and takeback), or
 162 normal (all other messages).
 163
 164      <p>Each foreground or background argument can be one of the following:
 165 black, red, green, yellow, blue, magenta, cyan, white, or default.
 166 Here &ldquo;default&rdquo; means the default foreground or background color of
 167 your xterm.  Bold can be 1 or 0.  If background is omitted, &ldquo;default&rdquo;
 168 is assumed; if bold is omitted, 0 is assumed.
 169
 170      <p>Here is an example of how to set the colors in your <samp><span class="file">.Xresources</span></samp> file.
 171 The colors shown here are the default values; you will get
 172 them if you turn <code>-colorize</code> on without specifying your own colors.
 173
 174      <pre class="example">          xboard*colorizeMessages: true
 175           xboard*colorShout: green
 176           xboard*colorSShout: green, black, 1
 177           xboard*colorChannel1: cyan
 178           xboard*colorChannel: cyan, black, 1
 179           xboard*colorKibitz: magenta, black, 1
 180           xboard*colorTell: yellow, black, 1
 181           xboard*colorChallenge: red, black, 1
 182           xboard*colorRequest: red
 183           xboard*colorSeek: blue
 184           xboard*colorNormal: default
 185 </pre>
 186      <br><dt>-soundProgram progname<dd><a name="index-soundProgram_002c-option-243"></a><a name="index-Sounds-244"></a>If this option is set to a sound-playing program that is installed and
 187 working on your system, XBoard can play sound files when certain
 188 events occur, listed below.  The default program name is "play".  If
 189 any of the sound options is set to "$", the event rings the terminal
 190 bell by sending a ^G character to standard output, instead of playing
 191 a sound file.  If an option is set to the empty string "", no sound is
 192 played for that event.
 193 <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-245"></a><a name="index-soundSShout_002c-option-246"></a><a name="index-soundChannel_002c-option-247"></a><a name="index-soundKibitz_002c-option-248"></a><a name="index-soundTell_002c-option-249"></a><a name="index-soundChallenge_002c-option-250"></a><a name="index-soundRequest_002c-option-251"></a><a name="index-soundSeek_002c-option-252"></a>These sounds are triggered in the same way as the colorization events
 194 described above.  They all default to "", no sound.  They are played
 195 only if the colorizeMessages is on.
 196 <br><dt>-soundMove filename<dd><a name="index-soundMove_002c-option-253"></a>This sound is used by the Move Sound menu option.  Default: "$".
 197 <br><dt>-soundIcsAlarm filename<dd><a name="index-soundIcsAlarm_002c-option-254"></a>This sound is used by the ICS Alarm menu option.  Default: "$".
 198 <br><dt>-soundIcsWin filename<dd><a name="index-soundIcsWin_002c-option-255"></a>This sound is played when you win an ICS game.  Default: "" (no sound).
 199 <br><dt>-soundIcsLoss filename<dd><a name="index-soundIcsLoss_002c-option-256"></a>This sound is played when you lose an ICS game.  Default: "" (no sound).
 200 <br><dt>-soundIcsDraw filename<dd><a name="index-soundIcsDraw_002c-option-257"></a>This sound is played when you draw an ICS game.  Default: "" (no sound).
 201 <br><dt>-soundIcsUnfinished filename<dd><a name="index-soundIcsUnfinished_002c-option-258"></a>This sound is played when an ICS game that you are participating in is
 202 aborted, adjourned, or otherwise ends inconclusively.  Default: "" (no
 203 sound).
 204
 205      <p>Here is an example of how to set the sounds in your <samp><span class="file">.Xresources</span></samp> file:
 206
 207      <pre class="example">          xboard*soundShout: shout.wav
 208           xboard*soundSShout: sshout.wav
 209           xboard*soundChannel1: channel1.wav
 210           xboard*soundChannel: channel.wav
 211           xboard*soundKibitz: kibitz.wav
 212           xboard*soundTell: tell.wav
 213           xboard*soundChallenge: challenge.wav
 214           xboard*soundRequest: request.wav
 215           xboard*soundSeek: seek.wav
 216           xboard*soundMove: move.wav
 217           xboard*soundIcsWin: win.wav
 218           xboard*soundIcsLoss: lose.wav
 219           xboard*soundIcsDraw: draw.wav
 220           xboard*soundIcsUnfinished: unfinished.wav
 221           xboard*soundIcsAlarm: alarm.wav
 222 </pre>
 223      </dl>
 224
 225    </body></html>
 226