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.13">
   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="Tournament-options.html#Tournament-options" title="Tournament options">
  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 <a name="ICS-options"></a>
  28 <p>
  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="Tournament-options.html#Tournament-options">Tournament options</a>,
  31 Up:&nbsp;<a rel="up" accesskey="u" href="Options.html#Options">Options</a>
  32 <hr>
  33 </div>
  34
  35 <h3 class="section">4.4 ICS options</h3>
  36
  37 <p><a name="index-ICS-options-302"></a><a name="index-Options_002c-ICS-303"></a>
  38      <dl>
  39 <dt>-ics/-xics or -internetChessServerMode true/false<dd><a name="index-ics_002c-option-304"></a><a name="index-internetChessServerMode_002c-option-305"></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-306"></a><a name="index-internetChessServerHost_002c-option-307"></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-308"></a><a name="index-internetChessServerPort_002c-option-309"></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-310"></a><a name="index-internetChessServerHelper_002c-option-311"></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-312"></a><a name="index-useTelnet_002c-option-313"></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-314"></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-315"></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-316"></a><a name="index-icscomm_002c-option-317"></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-318"></a><a name="index-internetChessServerLogonScript_002c-option-319"></a><a name="index-g_t_002eicsrc-320"></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-321"></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-322"></a><a name="index-internetChessServerInputBox_002c-option-323"></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-324"></a><a name="index-autoComment_002c-option-325"></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-326"></a><a name="index-autoCallFlag_002c-option-327"></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-328"></a><a name="index-autoObserve_002c-option-329"></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-330"></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>-seekGraph true/false or -sg<dd><a name="index-seekGraph_002c-option-331"></a><a name="index-sg_002c-option-332"></a>Enables displaying of the seek graph by left-clicking the board when
 147 you are logged on to an ICS and currently idle.
 148 The seek graph show all players currently seeking games on the ICS,
 149 plotted according to their rating and the time control of the game they seek,
 150 in three different colors (for rated, unrated and wild games).
 151 Computer ads are displayed as squares, human ads are dots.
 152 Default: false.
 153 <br><dt>-autoRefresh true/false<dd><a name="index-autoRefresh_002c-option-333"></a>Enables automatic updating of the seek graph,
 154 by having the ICS send a running update of all newly placed
 155 and removed seek ads.
 156 This consumes a substantial amount of communication bandwidth,
 157 and is only supported for FICS and ICC.
 158 Default: false.
 159 <br><dt>-backgroundObserve true/false<dd><a name="index-backgroundObserve_002c-option-334"></a>When true, boards sent to you by the ICS from other games while you are playing
 160 (e.g. because you are observing them)
 161 will not be automatically displayed.
 162 Only a summary of time left and material of both players will appear
 163 in the message field above the board.
 164 XBoard will remember the last board it has received this way,
 165 and will display it in stead of the position in your own game
 166 when you press the right mouse button.
 167 No other information is stored on such games observed in the background;
 168 you cannot save such a game later, or step through its moves.
 169 This feature is provided solely for the benefit of bughouse players,
 170 to enable them to peek at their partner's game without the need
 171 to logon twice.
 172 Default: false.
 173 <br><dt>-dualBoard true/false<dd><a name="index-dualBoard_002c-option-335"></a>In combination with -backgroundObserve true, this option will display
 174 the board of the background game side by side with that of your own game,
 175 so you can have it in view permanently.
 176 Any board or holdings info coming in will be displayed on the secondary
 177 board immediately.
 178 This feature is still experimental and largely unfinished.
 179 There is no animation or highlighting of moves on the secondary board.
 180 Default: false.
 181 <br><dt>-disguisePromotedPieces true/false<dd><a name="index-disguisePromotedPieces_002c-option-336"></a>When set promoted Pawns in crazyhouse/bughouse are displayed identical
 182 to primordial pieces of the same type, rather than distinguishable.
 183 Default: true.
 184 <br><dt>-moves/-xmoves or -getMoveList true/false<dd><a name="index-moves_002c-option-337"></a><a name="index-getMoveList_002c-option-338"></a>Sets the Get Move List menu option.  See <a href="Options-Menu.html#Options-Menu">Options Menu</a>.  Default: true.
 185 <br><dt>-alarm/-xalarm or -icsAlarm true/false<dd><a name="index-alarm_002c-option-339"></a><a name="index-icsAlarm_002c-option-340"></a>Sets the ICS Alarm menu option.  See <a href="Options-Menu.html#Options-Menu">Options Menu</a>. Default: true.
 186 <br><dt>-icsAlarmTime ms<dd><a name="index-icsAlarmTime_002c-option-341"></a>Sets the time in milliseconds for the ICS Alarm menu option.
 187 See <a href="Options-Menu.html#Options-Menu">Options Menu</a>. Default: 5000.
 188 <br><dt>lowTimeWarning true/false<dd><a name="index-lowTimeWarning_002c-option-342"></a>Controls a color change of the board as a warning your time is running out.
 189 See <a href="Options-Menu.html#Options-Menu">Options Menu</a>. Default: false.
 190 <br><dt>-pre/-xpre \fRor\fB -premove true/false<dd><a name="index-pre_002c-option-343"></a><a name="index-premove_002c-option-344"></a>Sets the Premove menu option. See <a href="Options-Menu.html#Options-Menu">Options Menu</a>. Default: true.
 191 <br><dt>-prewhite/-xprewhite or -premoveWhite<dt>-preblack/-xpreblack or -premoveBlack<dt>-premoveWhiteText string<dt>-premoveBlackText string<dd><a name="index-prewhite_002c-option-345"></a><a name="index-premoveWhite_002c-option-346"></a><a name="index-preblack_002c-option-347"></a><a name="index-premoveBlack_002c-option-348"></a><a name="index-premoveWhiteText_002c-option-349"></a><a name="index-premoveBlackText_002c-option-350"></a>Set the menu options for specifying the first move for either color.
 192 See <a href="Options-Menu.html#Options-Menu">Options Menu</a>. Defaults: false and empty strings, so no pre-moves.
 193 <br><dt>-quiet/-xquiet or -quietPlay true/false<dd><a name="index-quiet_002c-option-351"></a><a name="index-quietPlay_002c-option-352"></a>Sets the Quiet Play menu option.  See <a href="Options-Menu.html#Options-Menu">Options Menu</a>.  Default: false.
 194 <br><dt>-colorizeMessages or -colorize/-xcolorize<dd><a name="index-Colors-353"></a><a name="index-colorize_002c-option-354"></a><a name="index-colorizeMessages_002c-option-355"></a>Setting colorizeMessages
 195 to true tells XBoard to colorize the messages received from
 196 the ICS.  Colorization works only if your xterm
 197 supports ISO 6429 escape sequences for changing text colors.
 198 Default: true.
 199 <br><dt>-colorShout foreground,background,bold<dt>-colorSShout foreground,background,bold<dt>-colorCShout 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-356"></a><a name="index-colorShout_002c-option-357"></a><a name="index-colorSShout_002c-option-358"></a><a name="index-colorCShout_002c-option-359"></a><a name="index-colorChannel1_002c-option-360"></a><a name="index-colorChannel_002c-option-361"></a><a name="index-colorKibitz_002c-option-362"></a><a name="index-colorTell_002c-option-363"></a><a name="index-colorChallenge_002c-option-364"></a><a name="index-colorRequest_002c-option-365"></a><a name="index-colorSeek_002c-option-366"></a><a name="index-colorNormal_002c-option-367"></a>These options set the colors used when colorizing ICS messages.
 200 All ICS messages are grouped into one of these categories:
 201 shout, sshout, channel 1, other channel, kibitz, tell, challenge,
 202 request (including abort, adjourn, draw, pause, and takeback), or
 203 normal (all other messages).
 204
 205      <p>Each foreground or background argument can be one of the following:
 206 black, red, green, yellow, blue, magenta, cyan, white, or default.
 207 Here &ldquo;default&rdquo; means the default foreground or background color of
 208 your xterm.  Bold can be 1 or 0.  If background is omitted, &ldquo;default&rdquo;
 209 is assumed; if bold is omitted, 0 is assumed.
 210
 211      <p>Here is an example of how to set the colors in your <samp><span class="file">.Xresources</span></samp> file.
 212 The colors shown here are the default values; you will get
 213 them if you turn <code>-colorize</code> on without specifying your own colors.
 214 CShout is synonymous with SShout.
 215
 216      <pre class="example">          xboard*colorizeMessages: true
 217           xboard*colorShout: green
 218           xboard*colorSShout: green, black, 1
 219           xboard*colorChannel1: cyan
 220           xboard*colorChannel: cyan, black, 1
 221           xboard*colorKibitz: magenta, black, 1
 222           xboard*colorTell: yellow, black, 1
 223           xboard*colorChallenge: red, black, 1
 224           xboard*colorRequest: red
 225           xboard*colorSeek: blue
 226           xboard*colorNormal: default
 227 </pre>
 228      <br><dt>-soundProgram progname<dd><a name="index-soundProgram_002c-option-368"></a><a name="index-Sounds-369"></a>If this option is set to a sound-playing program that is installed and
 229 working on your system, XBoard can play sound files when certain
 230 events occur, listed below.  The default program name is "play".  If
 231 any of the sound options is set to "$", the event rings the terminal
 232 bell by sending a ^G character to standard output, instead of playing
 233 a sound file.  If an option is set to the empty string "", no sound is
 234 played for that event.
 235 <br><dt>-soundDirectory directoryname<dd><a name="index-soundDirectory_002c-option-370"></a><a name="index-Sounds-371"></a>This option specifies where XBoard will look for sound files,
 236 when these are not given as an absolute path name.
 237 <br><dt>-soundShout filename<dt>-soundSShout filename<dt>-soundCShout filename<dt>-soundChannel filename<dt>-soundChannel1 filename<dt>-soundKibitz filename<dt>-soundTell filename<dt>-soundChallenge filename<dt>-soundRequest filename<dt>-soundSeek filename<dd><a name="index-soundShout_002c-option-372"></a><a name="index-soundSShout_002c-option-373"></a><a name="index-soundCShout_002c-option-374"></a><a name="index-soundChannel_002c-option-375"></a><a name="index-soundChannel1_002c-option-376"></a><a name="index-soundKibitz_002c-option-377"></a><a name="index-soundTell_002c-option-378"></a><a name="index-soundChallenge_002c-option-379"></a><a name="index-soundRequest_002c-option-380"></a><a name="index-soundSeek_002c-option-381"></a>These sounds are triggered in the same way as the colorization events
 238 described above.  They all default to "", no sound.  They are played
 239 only if the colorizeMessages is on.
 240 CShout is synonymous with SShout.
 241 <br><dt>-soundMove filename<dd><a name="index-soundMove_002c-option-382"></a>This sound is used by the Move Sound menu option.  Default: "$".
 242 <br><dt>-soundIcsAlarm filename<dd><a name="index-soundIcsAlarm_002c-option-383"></a>This sound is used by the ICS Alarm menu option.  Default: "$".
 243 <br><dt>-soundIcsWin filename<dd><a name="index-soundIcsWin_002c-option-384"></a>This sound is played when you win an ICS game.  Default: "" (no sound).
 244 <br><dt>-soundIcsLoss filename<dd><a name="index-soundIcsLoss_002c-option-385"></a>This sound is played when you lose an ICS game.  Default: "" (no sound).
 245 <br><dt>-soundIcsDraw filename<dd><a name="index-soundIcsDraw_002c-option-386"></a>This sound is played when you draw an ICS game.  Default: "" (no sound).
 246 <br><dt>-soundIcsUnfinished filename<dd><a name="index-soundIcsUnfinished_002c-option-387"></a>This sound is played when an ICS game that you are participating in is
 247 aborted, adjourned, or otherwise ends inconclusively.  Default: "" (no
 248 sound).
 249
 250      <p>Here is an example of how to set the sounds in your <samp><span class="file">.Xresources</span></samp> file:
 251
 252      <pre class="example">          xboard*soundShout: shout.wav
 253           xboard*soundSShout: sshout.wav
 254           xboard*soundChannel1: channel1.wav
 255           xboard*soundChannel: channel.wav
 256           xboard*soundKibitz: kibitz.wav
 257           xboard*soundTell: tell.wav
 258           xboard*soundChallenge: challenge.wav
 259           xboard*soundRequest: request.wav
 260           xboard*soundSeek: seek.wav
 261           xboard*soundMove: move.wav
 262           xboard*soundIcsWin: win.wav
 263           xboard*soundIcsLoss: lose.wav
 264           xboard*soundIcsDraw: draw.wav
 265           xboard*soundIcsUnfinished: unfinished.wav
 266           xboard*soundIcsAlarm: alarm.wav
 267 </pre>
 268      </dl>
 269
 270    </body></html>
 271