Put warning in HTML help
[xboard.git] / winboard / help / html / 18.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>Other 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="otheroptions"></A>Other Options</B></P>\r
13 \r
14 \r
15 \r
16 <P><B><A NAME="ncp"></A>/ncp</B> or <B>/xncp</B>,<B> </B>or<B> <A NAME="nochessprogram"></A>/noChessProgram<I> true|false</I></B></P>\r
17 \r
18 <P>If this option is True, WinBoard acts as a passive chessboard; it does not start a chess program or connect to ICS. This option also sets clockMode to False. Default: False.</P>\r
19 \r
20 \r
21 \r
22 <P><B><A NAME="mode"></A>/mode</B> or <B><A NAME="initialmode"></A>/initialMode <I>modename</I></B></P>\r
23 \r
24 <P>If this option is given, WinBoard selects the given <I>modename</I> from the <A HREF="04.htm">Mode menu</A> after starting and (if applicable) processing the <A HREF="15.htm#loadgamefile">loadGameFile</A> or <A HREF="15.htm#loadpositionfile">loadPositionFile</A> option. Default: "". Other supported values are TwoMachines, AnalyzeFile, Analysis, MachineWhite, MachineBlack, EditGame, EditPosition, and Training.</P>\r
25 \r
26 \r
27 \r
28 <P><B><A NAME="variant"></A>/variant</B> <B><I> varname</I></B></P>\r
29 \r
30 <P>Activates preliminary, partial support for playing chess variants against a local engine or editing variant games. This flag is not needed in ICS mode. Recognized variant names are:</P>\r
31 \r
32 <table><tr><td>\r
33 normal</td><td>Normal chess\r
34 </td></tr><tr><td>\r
35 wildcastle</td><td>Shuffle chess, king can castle from d file\r
36 </td></tr><tr><td>\r
37 nocastle</td><td>Shuffle chess, no castling allowed\r
38 </td></tr><tr><td>\r
39 fischerandom</td><td>Fischer Random shuffle chess\r
40 </td></tr><tr><td>\r
41 bughouse</td><td>Bughouse, ICC/FICS rules\r
42 </td></tr><tr><td>\r
43 crazyhouse</td><td>Crazyhouse, ICC/FICS rules\r
44 </td></tr><tr><td>\r
45 losers</td><td>Lose all pieces or get mated (ICC wild 17)\r
46 </td></tr><tr><td>\r
47 suicide</td><td>Lose all pieces including king (FICS)\r
48 </td></tr><tr><td>\r
49 giveaway</td><td>Try to have no legal moves (ICC wild 26)\r
50 </td></tr><tr><td>\r
51 twokings</td><td>Weird ICC wild 9\r
52 </td></tr><tr><td>\r
53 kriegspiel</td><td>Opponent's pieces are invisible\r
54 </td></tr><tr><td>\r
55 atomic</td><td>Capturing piece explodes (ICC wild 27)\r
56 </td></tr><tr><td>\r
57 3check</td><td>Win by giving check 3 times (ICC wild 25)\r
58 </td></tr><tr><td>\r
59 <font color="#008000">xiangqi</font></td><td><font color="#008000">Chinese Chess (on a 9x10 board)</font>\r
60 </td></tr><tr><td>\r
61 <font color="#008000">shogi</font></td><td><font color="#008000">Japanese Chess (on a 9x9 board, with piece drops)</font>\r
62 </td></tr><tr><td>\r
63 <font color="#008000">capablanca</font></td><td><font color="#008000">Capablanca Chess (10x8 board, with Archbishop and Chancellor pieces)</font>\r
64 </td></tr><tr><td>\r
65 <font color="#008000">gothic</font></td><td><font color="#008000">similar, with a better initial position</font>\r
66 </td></tr><tr><td>\r
67 <font color="#008000">caparandom</font></td><td><font color="#008000">An FRC-like version of Capablanca Chess (10x8 board)</font>\r
68 </td></tr><tr><td>\r
69 <font color="#008000">janus</font></td><td><font color="#008000">A game with two Archbishops (10x8 board)</font>\r
70 </td></tr><tr><td>\r
71 <font color="#008000">shatranj</font></td><td><font color="#008000">Ancient Arabic Chess, with Elephants and General replacing B and Q.</font>\r
72 </td></tr><tr><td>\r
73 <font color="#008000">courier</font></td><td><font color="#008000">Medieval intermedite between shatranj and modern Chess (on 12x8 board)</font>\r
74 </td></tr><tr><td>\r
75 <font color="#008000">falcon</font></td><td><font color="#008000">A patented Chess variant with two Falcon pieces (10x8) board</font>\r
76 </td></tr><tr><td>\r
77 <font color="#008000">berolina</font></td><td><font color="#008000">Pawns capture straight ahead, and move diagonal (legality testing off!)</font>\r
78 </td></tr><tr><td>\r
79 <font color="#008000">cylinder</font></td><td><font color="#008000">Pieces wrap around the board, as if it were a cylinder (legality testing off!)</font> \r
80 </td></tr><tr><td>\r
81 <font color="#008000">fairy</font></td><td><font color="#008000">A variant in which all pieces known to WinBoard can participate</font>\r
82 </td></tr><tr><td>\r
83 <font color="#008000">knightmate</font></td><td><font color="#008000">King moves a Knight, and vice versa</font>\r
84 </td></tr><tr><td>\r
85 <font color="#3333ff">makruk</font></td><td><font color="#3333ff">Thai Chess (shatranj-like, pawns promote on 6th rank)</font>\r
86 </td></tr><tr><td>\r
87 <font color="#3333ff">super</font></td><td><font color="#3333ff">Superchess, a shuffle variant with B+N, R+N, K+N and Q+N compound</font>\r
88 </td></tr><tr><td>\r
89 <font color="#3333ff">great</font></td><td><font color="#3333ff">Great Shatranj, whithout sliders, on 10x8 board (legality testing off!)</font>\r
90 </td></tr></table>\r
91 \r
92 <P><font color="#008000">In the shuffle variants, WinBoard does now shuffle the pieces, although you can still do it by hand using Edit Position.</font> \r
93 Some variants are supported only in ICS mode, including bughouse, and kriegspiel. \r
94 The winning/drawing conditions in crazyhouse (off-board interposition on mate) is not fully understood, \r
95 <font color="#3333ff">but losers, suicide, giveaway, atomic, and 3check should be OK.</font> \r
96 In crazyhouse, <font color="#3333ff">WinBoard now does keep track of off-board pieces.\r
97 In shatranj it does implement the baring rule when mate detection is switched on.\r
98 In xiangqi it does implement the rules for perpetual checking and chasing (in Two-Machines mode).</font></P>\r
99 \r
100 \r
101 \r
102 <P><font color="#FF00FF"><B><A NAME="shuffleopenings"></A>/shuffleOpenings</B></font></P>\r
103 \r
104 <P><font color="#FF00FF">This volatile option will cause shuffling of all pieces on the back rank, even in variants that normally have a fixed opening setup, according to the setting of the /defaultFrcPosition. It will remain in effect untill you select a new variant. In variants with normal castling, corner Rooks and King will be exempted from shuffling. Color-bound pieces such as Bishops will be kept on differently colored squares.</font></P>\r
105 \r
106 \r
107 \r
108 <P><font color="#008000"><B><A NAME="boardheight"></A>/boardHeight <I>height</I></B></font></P>\r
109 \r
110 <P><font color="#008000">Allows you to set a non-standard number of board ranks in any variant. If the height is given as \91-1\92, the default height for the variant is used.</font></P>\r
111 \r
112 \r
113 \r
114 <P><font color="#008000"><B><A NAME="boardwidth"></A>/boardWidth <I>width</I></B></font></P>\r
115 \r
116 <P><font color="#008000">Allows you to set a non-standard number of board files in any variant. If the width is given as \91-1\92, the default width for the variant is used. Width a non-standard width, the initial position will always be an empty board, as the usual opening array will not fit.</font></P>\r
117 \r
118 \r
119 \r
120 <P><font color="#008000"><B><A NAME="holdingssize"></A>/holdingsSize <I>size</I></B></font></P>\r
121 \r
122 <P><font color="#008000">Allows you to set a non-standard size for the holdings in any variant. If the size is given as \91-1\92, the default holdings size for the variant is used. The first <I>size</I> piece types will go into the holdings on capture, and you will be able to drop them on the board in stead of making a normal move. If <I>size</I> equals 0, there will be no holdings.</font></P>\r
123 \r
124 \r
125 \r
126 <P><font color="#ff0000"><B><A NAME="defaultfrcposition"></A>/defaultFrcPosition <I>number</I></B></font></P>\r
127 \r
128 <P><font color="#ff0000">Specifies the number of the opening position in shuffle games like FRC. A value of \91-1\92 means the position is randomly generated by WinBoard.</font></P>\r
129 \r
130 \r
131 \r
132 <P><font color="#008000"><B><A NAME="piecetochartable"></A>/pieceToCharTable <I>characterstring</I></B></font></P>\r
133 \r
134 <P><font color="#008000">The characters that are used to represent the piece types WinBoard knows in FEN diagrams and SAN moves. The string argument has to have an even length (or it will be ignored), as white and black pieces have to be given separately (in that order). The last letter for each color will be the King. The letters before that will be PNBRQ and then a whole host of fairy pieces in an order that has not fully crystallized yet (currently FEACWMOHIJGDVSLU, F=Ferz, Elephant, A=Archbishop, C=Chancellor, W=Wazir, M=Commoner, O=Cannon, H=Nightrider). You should list at least all pieces that occur in the variant you are playing. If you have less than 44 characters in the string, the pieces not mentioned will get assigned a period, and you will not be able to distinguish them in FENs. You can also explicitly assign pieces a period, in which case they will not be counted in deciding which captured pieces can go into the holdings.</font></P>\r
135 \r
136 <P><font color="#008000">A tilde as a piece name does mean this piece is used to represent a promoted Pawn in Crazyhouse-like games, i.e. on capture it turns back onto a Pawn. A + similarly indicate the piece is a Shogi-style promoted piece, that should revert to its non-promoted version on capture (rather than to a Pawn).</font></P>\r
137 \r
138 <P><font color="#008000">Note that promoted pieces are represented by pieces 11 further in the list.</font></P>\r
139 \r
140 <P><font color="#008000">You should not have to use this option often: each variant has its own default setting for the piece representation in FEN, which should be sufficient in normal use.</font></P>\r
141 \r
142 \r
143 \r
144 <P><B><A NAME="rsh"></A>/rsh </B>or<B> <A NAME="remoteshell"></A>/remoteShell <I>shellname</I></B></P>\r
145 \r
146 <P>Name of the command used to run programs remotely. If this option is not given, WinBoard<I> </I>uses its own built-in implementation of the Unix <I>rcmd</I> protocol (the protocol used by <I>rsh</I>).</P>\r
147 \r
148 \r
149 \r
150 <P><B><A NAME="ruser"></A>/ruser </B>or<B> <A NAME="remoteuser"></A>/remoteUser <I>username</I></B></P>\r
151 \r
152 <P>User name on the remote system when running programs with the remoteShell. The default is your local user name.</P>\r
153 \r
154 \r
155 \r
156 <P><font color="#008000"><B><A NAME="username"></A>/userName <I>username</I></B></font></P>\r
157 \r
158 <P><font color="#008000">Name under which the Human player will be listed in the PGN file. (Default is the login name on your local computer.)</font></P>\r
159 \r
160 \r
161 \r
162 <P><font color="#ff0000"><B><A NAME="delaybeforequit"></A>/delayBeforeQuit <I>number</I></B></font></P>\r
163 \r
164 \r
165 \r
166 <P><font color="#ff0000"><B><A NAME="delayafterquit"></A>/delayAfterQuit <I>number</I></B></font></P>\r
167 \r
168 <P><font color="#ff0000">These options specify how long WinBoard has to wait before sending a termination signal to rogue engine processes, that do not want to react to the \91quit\92 command. The second one determines the pause after killing the engine, to make sure it dies.</font></P>\r
169 \r
170 \r
171 \r
172 <P><B><A NAME="ini"></A>/ini </B>or<B> <A NAME="settingsfile"></A>/settingsFile <I>filename<BR>\r
173 </I><A NAME="atsign"></A>@ <I>file-name</I></B></P>\r
174 \r
175 <P>See <A HREF="19.htm#settings">Settings</A>.</P>\r
176 \r
177 </BODY>\r
178 </HTML>\r