Put warning in HTML help
[xboard.git] / winboard / help / html / 14.htm
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">\r
2 <HTML>\r
3 <HEAD>\r
4 <META HTTP-EQUIV="Content-Type" Content="text/html; charset=Windows-1252">\r
5 <TITLE>Internet Chess Server Options</TITLE>\r
6 </HEAD>\r
7 \r
8 <BODY BGCOLOR="#FFFFFF" TEXT="#000000">\r
9 \r
10 \r
11 \r
12 <P><B><A NAME="internetchessserveroptions"></A>Internet Chess Server Options</B></P>\r
13 \r
14 \r
15 \r
16 <P><B><A NAME="ics"></A>/ics </B>or <B>/xics</B>, or<B> <A NAME="internetchessservermode"></A>/internetChessServerMode<I> true|false</I></B></P>\r
17 \r
18 <P>Connect with an Internet Chess Server to play chess against its other users, observe games they are playing, or review games that have recently finished. See <A HREF="04.htm#icsclient">ICS Client</A> Default: False.</P>\r
19 \r
20 <P>You can create a script file containing ICS commands that WinBoard will type in for you whenever you connect to the ICS. See <A HREF="#icslogon">ICS Logon</A>.</P>\r
21 \r
22 \r
23 \r
24 <P><B><A NAME="icshost"></A>/icshost </B>or<B> <A NAME="internetchessserverhost"></A>/internetChessServerHost <I>hostname</I></B></P>\r
25 \r
26 <P>The host name or numeric address of the Internet Chess Server to connect to when in ICS mode. The default is the empty string, which causes WinBoard to pop up a menu of known ICS sites. The file ics-addresses.txt in the WinBoard distribution gives slightly more information on these sites. It includes their numeric addresses, which you can use if your site does not have a working name server.</P>\r
27 \r
28 \r
29 \r
30 <P><B><A NAME="icsport"></A>/icsport </B>or<B> <A NAME="internetchessserverport"></A>/internetChessServerPort <I>portnumber</I></B></P>\r
31 \r
32 <P>The port number to use when connecting to a chess server in ICS mode. Default: 5000.</P>\r
33 \r
34 \r
35 \r
36 <P><B><A NAME="via"></A>/icshelper <I>program</I></B></P>\r
37 \r
38 \r
39 \r
40 <P>An external helper program used to communicate with the chess server. Typically <I>timestamp</I> for the ICC (chessclub.com) or <I>timeseal</I> for FICS (freechess.org, eics.daimi.aau.dk, etc.). This option is shorthand for \93/useTelnet /telnetProgram <I>program</I>\94<B>.</B></P>\r
41 \r
42 \r
43 \r
44 <P><B><A NAME="telnet"></A>/telnet</B> or <B>/xtelnet</B>,<B> </B>or<B> <A NAME="usetelnet"></A>/useTelnet<I> true|false</I></B></P>\r
45 \r
46 <P>This option is poorly named; it should be called <B>/useHelper</B>. If set to True, it instructs WinBoard to use an external helper program to communicate with the ICS, as specified by the telnetProgram option. The external program must be a pure console application that can communicate with WinBoard through pipes; the Windows telnet application is not suitable. If the option is False (the default), WinBoard communicates with the ICS by opening a Winsock TCP socket and using its own internal implementation of the telnet protocol.</P>\r
47 \r
48 \r
49 \r
50 <P><B><A NAME="gateway"></A>/gateway <I>hostname</I></B></P>\r
51 \r
52 <P>If this option is set to a host name, WinBoard uses <A HREF="18.htm#rsh">rsh</A> to run the telnetProgram remotely on the given host to communicate with the Internet Chess Server instead of using its own internal implementation of the telnet protocol. See the <A HREF="21.htm">FIREWALLS</A> section below for an explanation of when this option is useful.</P>\r
53 \r
54 \r
55 \r
56 <P><B><A NAME="telnetprogram"></A>/telnetProgram <I>program</I></B></P>\r
57 \r
58 <P>This option is poorly named; it should be called <B>/helperProgram</B>. It gives the name of the remote or external helper program to be used with the gateway or useTelnet option. The default is "telnet". The telnet program is invoked with the value of internetChessServer as the first argument and the value of internetChessServerPort as the second argument on its command line.</P>\r
59 \r
60 \r
61 \r
62 <P><B><A NAME="icscom"></A>/icscom </B>or<B> <A NAME="internetchessservercomport"></A>/internetChessServerComPort <I>name</I></B></P>\r
63 \r
64 <P>If this option is set, WinBoard communicates with the Internet Chess Server using a serial communication port instead of a network connection. Use this option if your machine is not connected to a network (not even via SLIP or PPP), but you do have Internet access through another machine by dialing in using a modem or by connecting directly to a serial terminal port. Example:</P>\r
65 \r
66 <PRE><CODE>WinBoard /ics /icscom:com1</CODE></PRE>\r
67 \r
68 <P>After you start WinBoard in this way, type whatever modem commands are necessary to dial out to your Internet provider and log in. You may need to turn off <A HREF="07.htm#locallineediting">Local Line Editing</A> on the Options menu while typing commands to the modem, but turn it on again afterwards. Then telnet to the ICS, using a command like "telnet chessclub.com 5000". Important: See the paragraph in the <A HREF="22.htm">LIMITATIONS</A> section below about extra echoes.</P>\r
69 \r
70 \r
71 \r
72 <P><B><A NAME="comportsettings"></A>/comPortSettings</B> <B><I>\93dataRate,dataBits,parity,stopBits,flow\94</I></B></P>\r
73 \r
74 <P>This option allows serial port parameters to be set from the command line or a settings file. The values are simply filled in to the <A HREF="07.htm#communications">Communications</A> dialog.</P>\r
75 \r
76 \r
77 \r
78 <P><B><A NAME="icslogon"></A>/icslogon </B>or<B> <A NAME="internetchessserverlogonscript"></A>/internetChessServerLogonScript <I>filename</I></B></P>\r
79 \r
80 <P>This option lets you change the name used for the <A HREF="#icslogon">ICS Logon</A> file. Default: "ICS.ini". The filename is interpreted relative to WinBoard's installation directory (the directory containing WinBoard.exe).</P>\r
81 \r
82 \r
83 \r
84 <P><B><A NAME="autocomm"></A>/autocomm </B>or <B>/xautocomm</B>, or<B> <A NAME="autocomment"></A>/autoComment<I> true|false</I></B></P>\r
85 \r
86 <P>Sets the <A HREF="07.htm#autocommentcmd">Auto Comment</A> option. Default: False.</P>\r
87 \r
88 \r
89 \r
90 <P><B><A NAME="autoflag"></A>/autoflag</B> or <B>/xautoflag</B>,<B> </B>or<B> <A NAME="autocallflag"></A>/autoCallFlag<I> true|false</I></B></P>\r
91 \r
92 <P>Sets the <A HREF="#autoflag">Auto Flag</A> option. Default: False.</P>\r
93 \r
94 \r
95 \r
96 <P><B><A NAME="autobs"></A>/autobs</B> or <B>/xautobs</B>,<B> </B>or<B> <A NAME="autoobservecmd"></A>/autoObserve<I> true|false</I></B></P>\r
97 \r
98 <P>Sets the <A HREF="#autoobservecmd">Auto Observe</A> option. Default: False.</P>\r
99 \r
100 \r
101 \r
102 <P><B><A NAME="autokibitz"></A><font color="#008000">/autoKibitz</font></B></P>\r
103 \r
104 <P><font color="#008000">Kibitzes the engines last thinking output (depth, score, time, speed, PV) to the ICS in zippy mode. Show Thinking must be on for this option to work.</font> <font color="#3333ff">Also diverts similar kibitz information of an opponent engine that is playing you through the ICS to the engine-output window, as if the engine was playing locally.</font></P>\r
105 \r
106 \r
107 \r
108 <P><B><A NAME="moves"></A>/moves</B> or <B>/xmoves</B>,<B> </B>or<B> <A NAME="getmovelist"></A>/getMoveList<I> true|false</I></B></P>\r
109 \r
110 <P>Sets the <A HREF="07.htm#getmovelistcmd">Get Move List</A> option. Default: True.</P>\r
111 \r
112 \r
113 \r
114 <P><B><A NAME="edit"></A>/edit<SUP> </SUP></B> or <B>/xedit</B>,<B> </B>or<B> <A NAME="locallineeditingoption"></A>/localLineEditing<I> true|false</I></B></P>\r
115 \r
116 <P>Sets the <A HREF="07.htm#locallineediting">Local Line Editing</A> option. Default: True.</P>\r
117 \r
118 \r
119 \r
120 <P><B><A NAME="quiet"></A>/quiet </B>or <B>/xquiet</B>, or<B> <A NAME="quietplay"></A>/quietPlay<I> true|false</I></B></P>\r
121 \r
122 <P>Sets the <A HREF="07.htm#quietplaycmd">Quiet Play</A> option. Default: False</P>\r
123 \r
124 \r
125 \r
126 <P><B><A NAME="opt_blindfold"></A>/blindfold <I>true|false</I></B></P>\r
127 \r
128 <P>Sets the <A HREF="07.htm#blindfoldcmd">Blindfold</A> option. Default: False</P>\r
129 \r
130 \r
131 \r
132 <P><font color="#FF00FF"><A NAME="seekgraph"></A><B>/seekGraph <I>true|false</I></B>, or <A NAME="sg"></A><B>/sg</B></font></P>\r
133 \r
134 <P><font color="#FF00FF">Enables summoning up of the <A HREF="07.htm#seekgraphcmd">Seek Graph</A>  by left-clicking the board. Default: False</font></P>\r
135 \r
136 \r
137 \r
138 <P><B><font color="#FF00FF"><A NAME="autorefresh"></A>/autoRefresh <I>true|false</I></font></B></P>\r
139 \r
140 <P><font color="#FF00FF">Sets the <A HREF="07.htm#autorefreshcmd">Auto Refresh</A> option of the <A HREF="07.htm#seekgraphcmd">Seek Graph</A>. Default: False</font></P>\r
141 \r
142 \r
143 \r
144 <P><B><font color="#FF00FF"><A NAME="backgroundobserve"></A>/backgroundObserve <I>true|false</I></font></B></P>\r
145 \r
146 <P><font color="#FF00FF">Sets the <A HREF="07.htm#backgroundobservecmd">Background Observe</A> option for observing other games during play. Default: False</font></P>\r
147 \r
148 \r
149 \r
150 <P><B><font color="#FF00FF"><A NAME="dualboard"></A>/dualBoard <I>true|false</I></font></B></P>\r
151 \r
152 <P><font color="#FF00FF">Sets the <A HREF="07.htm#dualboardcmd">Dual Board</A> option for observing your partner's bughouse game. Default: False</font></P>\r
153 \r
154 \r
155 \r
156 <P><B><A NAME="pre"></A>/pre </B>or<B> <A NAME="xpre"></A>/xpre</B>, or<B> <A NAME="premove"></A>/premove<I> true|false</I></B></P>\r
157 \r
158 <P>Sets the <A HREF="07.htm#premovecmd">Premove</A> option. If set to True, the premove feature is enabled. If set to False, premove is disabled and the other <A HREF="07.htm#premovecmd">Premove</A> settings are ignored. Default: False.</P>\r
159 \r
160 \r
161 \r
162 <P><B><A NAME="prewhite"></A>/prewhite </B>or<B> <A NAME="xprewhite"></A>/xprewhite</B>, or <B><A NAME="premovewhite"></A>/premoveWhite<I> true|false</I></B></P>\r
163 \r
164 \r
165 \r
166 <P><B><A NAME="premovewhitetext"></A>/premoveWhiteText<I> movetext</I></B></P>\r
167 \r
168 <P>If <B>premoveWhite</B> is set to True and you are playing white in an ICS game, the text specified by the <B>premoveWhiteText</B> option is sent to the ICS as soon as the game starts.  These options can be set from the <A HREF="07.htm#premovecmd">Premove</A> section of the <A HREF="07.htm#icsoptions">ICS Options</A> dialog box. The default for <B>premoveWhite</B> is False.</P>\r
169 \r
170 \r
171 \r
172 <P><B><A NAME="preblack"></A>/preblack </B>or<B> <A NAME="xpreblack"></A>/xpreblack</B>, or <B><A NAME="premoveblack"></A>/premoveBlack<I> true|false</I></B></P>\r
173 \r
174 \r
175 \r
176 <P><B><A NAME="premoveblacktext"></A>/premoveBlackText<I> movetext</I></B></P>\r
177 \r
178 <P>If <B>premoveBlack</B> is set to True and you are playing black in an ICS game, the text specified by the <B>premoveBlackText</B> option is sent to the ICS as soon as the first move is received from your opponent, even if you make a different premove on the board before the first white move is received. These options can be set from the <A HREF="07.htm#premovecmd">Premove</A> section of the <A HREF="07.htm#icsoptions">ICS Options</A> dialog box. The default for <B>premoveBlack</B> is False.</P>\r
179 \r
180 \r
181 \r
182 <P><B><font color="#FF00FF"><A NAME="oneclickmove"></A>/oneClickMove <I>true|false</I></font></B></P>\r
183 \r
184 <P><font color="#FF00FF">Sets the <A HREF="07.htm#oneclickmovecmd">One-Click Move</A> option. Default: False</font></P>\r
185 \r
186 \r
187 \r
188 <P><B><A NAME="alarm"></A>/alarm </B>or<B> <A NAME="xalarm"></A>/xalarm</B>, or <B><A NAME="icsalarm"></A>/icsAlarm <I>true|false</I></B></P>\r
189 \r
190 \r
191 \r
192 <P><B><A NAME="icsalarmtime"></A>/icsAlarmTime <I>milliseconds</I></B></P>\r
193 \r
194 <P>When <B>icsAlarm</B> is set to True, the <A HREF="16.htm#soundicsalarm">alarm sound</A> is played when your clock counts down to <B>icsAlarmTime</B> seconds.  For ICS games with time controls that include an increment, the alarm will sound each time the clock counts down to the <B>icsAlarmTime</B>.  The <B>icsAlarmTime</B> can be set by selecting <A HREF="07.htm#icsalarm">ICS Alarm</A> from the <A HREF="07.htm#icsoptions">ICS options</A> dialog. The default is 5 seconds.</P>\r
195 \r
196 \r
197 <P><B><font color="#3333FF"><A NAME="keepalive"></A>/keepAlive <I>time</I></font></B></P>\r
198 \r
199 <P><font color="#3333FF">When <I>time</I> is non-zero, send a \93date\94 command every <I>time</I> minutes after your last move to the ICS, to prevent it from logging you off. (Do not use frivolously! The ICS operator might ban you.) Default: 0.</font></P>\r
200 \r
201 \r
202 <P><B><font color="#FF00FF"><A NAME="chatboxes"></A>/chatBoxes <I>handles</I></font></B></P>\r
203 \r
204 <P><font color="#FF00FF">Sets the list of <A HREF="04.htm#openchatwindow">Chat Boxes</A> to be opened at startup. The given string handles should be a semicolon-separated list, like \93shouts;53;Johnny\94 to open 3 chat boxes, to capture all shouts (including c-shouts and \91it\92 messages), the traffic on channel 53, and for a player named Johnny. Default: no chat windows.</font></P>\r
205 \r
206 \r
207 \r
208 </BODY>\r
209 </HTML>\r