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-189"></a><a name="index-Options_002c-ICS-190"></a>
  38      <dl>
  39 <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
  40 other users, observe games they are playing, or review games\r
  41 that have recently finished. Default: false.\r
  42 <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
  43 to when in ICS mode. Default: <code>chessclub.com</code>.\r
  44 Another popular chess server to try is <code>freechess.org</code>.\r
  45 If your site doesn't have a working Internet name server, try\r
  46 specifying the host address in numeric form. \r
  47 You may also need\r
  48 to specify the numeric address when using the icshelper option\r
  49 with timestamp or timeseal (see below).\r
  50 <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
  51 mode. Default: 5000.\r
  52 <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
  53 You would set it to "timestamp" for ICC (chessclub.com) or\r
  54 "timeseal" for FICS (freechess.org), after\r
  55 obtaining the correct version of timestamp or timeseal for your\r
  56 computer.  See "help timestamp" on ICC and "help timeseal" on FICS.\r
  57 This option is shorthand for <code>-useTelnet -telnetProgram program</code>.\r
  58 <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
  59 If set to true, it instructs XBoard to run an external\r
  60 program to communicate with the Internet Chess Server. \r
  61 The program to use is given by the telnetProgram option.\r
  62 If the option is\r
  63 false (the default), XBoard opens a TCP socket and uses its own\r
  64 internal implementation of the telnet protocol to communicate with the\r
  65 ICS. See <a href="Firewalls.html#Firewalls">Firewalls</a>.\r
  66 <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
  67 It gives the name of the telnet program to be used with\r
  68 the <code>gateway</code> and <code>useTelnet</code> options.  The default is\r
  69 <samp><span class="file">telnet</span></samp>. The telnet program is invoked with the value of\r
  70 <code>internetChessServerHost</code> as its first argument and the value\r
  71 of <code>internetChessServerPort</code> as its second argument.\r
  72 See <a href="Firewalls.html#Firewalls">Firewalls</a>.\r
  73 <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
  74 Internet Chess Server by using <samp><span class="file">rsh</span></samp> to run\r
  75 the <code>telnetProgram</code> on the given host,\r
  76 instead of using its own internal implementation\r
  77 of the telnet protocol. You can substitute a different remote shell\r
  78 program for <samp><span class="file">rsh</span></samp> using the <code>remoteShell</code> option described below.\r
  79 See <a href="Firewalls.html#Firewalls">Firewalls</a>.\r
  80 <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
  81 the given character I/O device instead of opening a TCP connection.\r
  82 Use this option if your system does not have any kind of\r
  83 Internet connection itself (not even a SLIP or PPP connection),\r
  84 but you do have dialup access (or a hardwired terminal line) to\r
  85 an Internet service provider from which you can telnet to the ICS.\r
  86 \r
  87 The support for this option in XBoard is minimal. You need to\r
  88 set all communication parameters and tty modes before you enter\r
  89 XBoard.\r
  90 \r
  91 Use a script something like this:\r
  92 \r
  93      <pre class="example">          stty raw -echo 9600 &gt; /dev/tty00\r
  94           xboard -ics -icscomm /dev/tty00\r
  95 </pre>
  96      <p>\r
  97 Here replace &lsquo;<samp><span class="samp">/dev/tty00</span></samp>&rsquo; with the name of the device that your\r
  98 modem is connected to. You might have to add several more\r
  99 options to these stty commands. See the man pages for <samp><span class="file">stty</span></samp>\r
 100 and <code>tty</code> if you run into problems. Also, on many systems stty\r
 101 works on its standard input instead of standard output, so you\r
 102 have to use &lsquo;<samp><span class="samp">&lt;</span></samp>&rsquo; instead of &lsquo;<samp><span class="samp">&gt;</span></samp>&rsquo;.\r
 103 \r
 104 If you are using linux, try starting with the script below.\r
 105 Change it as necessary for your installation.\r
 106 \r
 107      <pre class="example">          #!/bin/sh -f\r
 108           # configure modem and fire up XBoard\r
 109           \r
 110           # configure modem\r
 111           (\r
 112             stty 2400 ; stty raw ; stty hupcl ; stty -clocal\r
 113             stty ignbrk ; stty ignpar ; stty ixon ; stty ixoff\r
 114             stty -iexten ; stty -echo\r
 115           ) &lt; /dev/modem\r
 116           xboard -ics -icscomm /dev/modem\r
 117 </pre>
 118      <p class="noindent">After you start XBoard in this way, type whatever commands are\r
 119 necessary to dial out to your Internet provider and log in.\r
 120 Then telnet to ICS, using a command like\r
 121 <kbd>telnet chessclub.com 5000</kbd>.\r
 122 Important: See the paragraph below about extra echoes, \r
 123 in <a href="Limitations.html#Limitations">Limitations</a>.\r
 124 <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
 125 if it finds a file with the name given in this option, it feeds the\r
 126 file's contents to the ICS as commands. The default file name\r
 127 is <samp><span class="file">.icsrc</span></samp>.\r
 128 Usually the first two lines of the file should be\r
 129 your ICS user name and password.\r
 130 The file can be either in $CHESSDIR, in XBoard's working\r
 131 directory if CHESSDIR is not set, or in your home directory.\r
 132 <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
 133 <code>-icslogon</code> option, inserting some delay between characters\r
 134 of the logon script may help. This option adds <code>delay</code>\r
 135 milliseconds of delay between characters. Good values to try\r
 136 are 100 and 250.\r
 137 <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
 138 <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
 139 <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
 140 <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
 141 <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
 142 before it moved\r
 143 to the ICS, in zippy mode. The option <code>showThinking</code> must be switched on for \r
 144 this option to work.\r
 145 Also diverts similar kibitz information of an opponent engine that is playing you \r
 146 through the ICS to the engine-output window, as if the engine was playing locally.\r
 147 <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
 148 <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
 149 <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
 150 See <a href="Options-Menu.html#Options-Menu">Options Menu</a>. Default: 5000.\r
 151 <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
 152 <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
 153 <br><dt>-colorizeMessages or -colorize<dd><a name="index-Colors-227"></a><a name="index-colorize_002c-option-228"></a>Setting colorizeMessages\r
 154 to true tells XBoard to colorize the messages received from\r
 155 the ICS.  Colorization works only if your xterm \r
 156 supports ISO 6429 escape sequences for changing text colors.\r
 157 <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
 158 All ICS messages are grouped into one of these categories:\r
 159 shout, sshout, channel 1, other channel, kibitz, tell, challenge, \r
 160 request (including abort, adjourn, draw, pause, and takeback), or\r
 161 normal (all other messages).  \r
 162 \r
 163 Each foreground or background argument can be one of the following:\r
 164 black, red, green, yellow, blue, magenta, cyan, white, or default.\r
 165 Here &ldquo;default&rdquo; means the default foreground or background color of\r
 166 your xterm.  Bold can be 1 or 0.  If background is omitted, &ldquo;default&rdquo;\r
 167 is assumed; if bold is omitted, 0 is assumed.\r
 168 \r
 169 Here is an example of how to set the colors in your <samp><span class="file">.Xresources</span></samp> file.\r
 170 The colors shown here are the default values; you will get\r
 171 them if you turn <code>-colorize</code> on without specifying your own colors.\r
 172 \r
 173      <pre class="example">          xboard*colorizeMessages: true       \r
 174           xboard*colorShout: green\r
 175           xboard*colorSShout: green, black, 1\r
 176           xboard*colorChannel1: cyan\r
 177           xboard*colorChannel: cyan, black, 1\r
 178           xboard*colorKibitz: magenta, black, 1\r
 179           xboard*colorTell: yellow, black, 1\r
 180           xboard*colorChallenge: red, black, 1\r
 181           xboard*colorRequest: red\r
 182           xboard*colorSeek: blue\r
 183           xboard*colorNormal: default\r
 184 </pre>
 185      <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
 186 working on your system, XBoard can play sound files when certain\r
 187 events occur, listed below.  The default program name is "play".  If\r
 188 any of the sound options is set to "$", the event rings the terminal\r
 189 bell by sending a ^G character to standard output, instead of playing\r
 190 a sound file.  If an option is set to the empty string "", no sound is\r
 191 played for that event.\r
 192 <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
 193 described above.  They all default to "", no sound.  They are played\r
 194 only if the colorizeMessages is on.\r
 195 <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
 196 <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
 197 <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
 198 <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
 199 <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
 200 <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
 201 aborted, adjourned, or otherwise ends inconclusively.  Default: "" (no\r
 202 sound).\r
 203 \r
 204 Here is an example of how to set the sounds in your <samp><span class="file">.Xresources</span></samp> file:\r
 205 \r
 206      <pre class="example">          xboard*soundShout: shout.wav\r
 207           xboard*soundSShout: sshout.wav\r
 208           xboard*soundChannel1: channel1.wav\r
 209           xboard*soundChannel: channel.wav\r
 210           xboard*soundKibitz: kibitz.wav\r
 211           xboard*soundTell: tell.wav\r
 212           xboard*soundChallenge: challenge.wav\r
 213           xboard*soundRequest: request.wav\r
 214           xboard*soundSeek: seek.wav\r
 215           xboard*soundMove: move.wav\r
 216           xboard*soundIcsWin: win.wav\r
 217           xboard*soundIcsLoss: lose.wav\r
 218           xboard*soundIcsDraw: draw.wav\r
 219           xboard*soundIcsUnfinished: unfinished.wav\r
 220           xboard*soundIcsAlarm: alarm.wav\r
 221 </pre>
 222      </dl>
 223    \r
 224
 225    </body></html>
 226