manual/html_node/Other-options.html

   1 <html lang="en">
   2 <head>
   3 <title>Other 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="Adjudication-Options.html#Adjudication-Options" title="Adjudication Options">
  10 <link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
  11 <meta http-equiv="Content-Style-Type" content="text/css">
  12 <style type="text/css"><!--
  13   pre.display { font-family:inherit }
  14   pre.format  { font-family:inherit }
  15   pre.smalldisplay { font-family:inherit; font-size:smaller }
  16   pre.smallformat  { font-family:inherit; font-size:smaller }
  17   pre.smallexample { font-size:smaller }
  18   pre.smalllisp    { font-size:smaller }
  19   span.sc    { font-variant:small-caps }
  20   span.roman { font-family:serif; font-weight:normal; }
  21   span.sansserif { font-family:sans-serif; font-weight:normal; }
  22 --></style>
  23 </head>
  24 <body>
  25 <div class="node">
  26 <p>
  27 <a name="Other-options"></a>
  28 Previous:&nbsp;<a rel="previous" accesskey="p" href="Adjudication-Options.html#Adjudication-Options">Adjudication Options</a>,
  29 Up:&nbsp;<a rel="up" accesskey="u" href="Options.html#Options">Options</a>
  30 <hr>
  31 </div>
  32
  33 <h3 class="section">3.7 Other options</h3>
  34
  35 <p><a name="index-Options_002c-miscellaneous-352"></a>
  36      <dl>
  37 <dt>-ncp/-xncp or -noChessProgram true/false<dd><a name="index-ncp_002c-option-353"></a><a name="index-noChessProgram_002c-option-354"></a>If this option is true, XBoard acts as a passive chessboard; it\r
  38 does not start a chess engine at all. Turning on this option\r
  39 also turns off clockMode. Default: false.\r
  40 <br><dt>-mode or -initialMode modename<dd><a name="index-mode_002c-option-355"></a><a name="index-initalMode_002c-option-356"></a>If this option is given, XBoard selects the given modename\r
  41 from the Mode menu after starting and (if applicable) processing the\r
  42 loadGameFile or loadPositionFile option. Default: "" (no selection). \r
  43 Other supported values are \r
  44 MachineWhite, MachineBlack, TwoMachines, Analysis, \r
  45 AnalyzeFile, EditGame, EditPosition, and Training.\r
  46 <br><dt>-variant varname<dd><a name="index-variant_002c-option-357"></a>Activates preliminary, partial support for playing chess variants\r
  47 against a local engine or editing variant games.  This flag is not\r
  48 needed in ICS mode.  Recognized variant names are:\r
  49 \r
  50      <pre class="example">          normal        Normal chess\r
  51           wildcastle    Shuffle chess, king can castle from d file\r
  52           nocastle      Shuffle chess, no castling allowed\r
  53           fischerandom  Fischer Random shuffle chess\r
  54           bughouse      Bughouse, ICC/FICS rules\r
  55           crazyhouse    Crazyhouse, ICC/FICS rules\r
  56           losers        Lose all pieces or get mated (ICC wild 17)\r
  57           suicide       Lose all pieces including king (FICS)\r
  58           giveaway      Try to have no legal moves (ICC wild 26)\r
  59           twokings      Weird ICC wild 9\r
  60           kriegspiel    Opponent's pieces are invisible\r
  61           atomic        Capturing piece explodes (ICC wild 27)\r
  62           3check        Win by giving check 3 times (ICC wild 25)\r
  63           shatranj      An ancient precursor of chess (ICC wild 28)\r
  64           xiangqi       Chinese Chess (on a 9x10 board)\r
  65           shogi         Japanese Chess (on a 9x9 board &amp; piece drops) \r
  66           capablanca    Capablanca Chess (10x8 board, with Archbishop \r
  67                         and Chancellor pieces)\r
  68           gothic        similar, with a better initial position\r
  69           caparandom    An FRC-like version of Capablanca Chess (10x8) \r
  70           janus         A game with two Archbishops (10x8 board)\r
  71           courier       Medieval intermedite between shatranj and \r
  72                         modern Chess (on 12x8 board) \r
  73           falcon        Patented 10x8 variant with two Falcon pieces\r
  74           berolina      Pawns capture straight ahead, and move diagonal \r
  75           cylinder      Pieces wrap around the board edge\r
  76           knightmate    King moves as Knight, and vice versa \r
  77           super         Superchess (shuffle variant with 4 exo-pieces)\r
  78           fairy         A catchall variant in which all piece types \r
  79                         known to XBoard can participate (8x8)\r
  80           unknown       Catchall for other unknown variants\r
  81 </pre>
  82      <p>\r
  83 In the shuffle variants, XBoard now does shuffle the pieces, although\r
  84 you can still do it by hand using Edit Position.  Some variants are\r
  85 supported only in ICS mode, including bughouse, and\r
  86 kriegspiel.  The winning/drawing conditions in crazyhouse (offboard\r
  87 interposition on mate), losers, suicide, giveaway, atomic, and 3check\r
  88 are not fully understood.  \r
  89 Berolina and cylinder chess can only be played with legality testing off.\r
  90 In crazyhouse, XBoard now does keep\r
  91 track of offboard pieces.  In shatranj it does implement the baring\r
  92 rule when mate detection is switched on.\r
  93 <br><dt>-boardHeight N<dd><a name="index-boardHeight_002c-option-358"></a>Allows you to set a non-standard number of board ranks in any variant. \r
  94 If the height is given as -1, the default height for the variant is used.\r
  95 Default: -1\r
  96 <br><dt>-boardWidth N<dd><a name="index-boardWidth_002c-option-359"></a>Allows you to set a non-standard number of board files in any variant. \r
  97 If the width is given as -1, the default width for the variant is used. \r
  98 With a non-standard width, the initial position will always be an empty board, \r
  99 as the usual opening array will not fit.\r
 100 Default: -1\r
 101 <br><dt>-holdingsSize N<dd><a name="index-holdingsSize_002c-option-360"></a>Allows you to set a non-standard size for the holdings in any variant. \r
 102 If the size is given as -1, the default holdings size for the variant is used. \r
 103 The first N piece types will go into the holdings on capture, and you will be \r
 104 able to drop them on the board in stead of making a normal move. If size equals 0, \r
 105 there will be no holdings.\r
 106 Default: -1\r
 107 <br><dt>-defaultFrcPosition N<dd><a name="index-defaultFrcPosition_002c-option-361"></a>Specifies the number of the opening position in shuffle games like Chess960. \r
 108 A value of -1 means the position is randomly generated by XBoard\r
 109 at the beginning of every game.\r
 110 Default: -1\r
 111 <br><dt>-pieceToSquareTable string<dd><a name="index-pieceToSquareTable_002c-option-362"></a>The characters that are used to represent the piece types XBoard knows in FEN \r
 112 diagrams and SAN moves. The string argument has to have an even length \r
 113 (or it will be ignored), as white and black pieces have to be given separately \r
 114 (in that order). The last letter for each color will be the King. \r
 115 The letters before that will be PNBRQ and then a whole host of fairy pieces \r
 116 in an order that has not fully crystallized yet (currently FEACWMOHIJGDVSLU, \r
 117 F=Ferz, Elephant, A=Archbishop, C=Chancellor, W=Wazir, M=Commoner, O=Cannon, \r
 118 H=Nightrider). You should list at least all pieces that occur in the variant \r
 119 you are playing. If you have less than 44 characters in the string, the pieces \r
 120 not mentioned will get assigned a period, and you will not be able to distinguish \r
 121 them in FENs. You can also explicitly assign pieces a period, in which case they \r
 122 will not be counted in deciding which captured pieces can go into the holdings.\r
 123 A tilde '~' as a piece name does mean this piece is used to represent a promoted \r
 124 Pawn in crazyhouse-like games, i.e. on capture it turns back onto a Pawn. \r
 125 A '+' similarly indicates the piece is a shogi-style promoted piece, that should \r
 126 revert to its non-promoted version on capture (rather than to a Pawn).\r
 127 Note that promoted pieces are represented by pieces 11 further in the list.\r
 128 You should not have to use this option often: each variant has its own default \r
 129 setting for the piece representation in FEN, which should be sufficient in normal use.\r
 130 Default: ""\r
 131 <br><dt>-debug/-xdebug or -debugMode true/false<dd><a name="index-debug_002c-option-363"></a><a name="index-debugMode_002c-option-364"></a>Turns on debugging printout.\r
 132 <br><dt>-debugFile filename or -nameOfDebugFile filename<dd><a name="index-debugFile_002c-option-365"></a><a name="index-nameOfDebugFile_002c-option-366"></a>Sets the name of the file to which WinBoard saves debug information \r
 133 (including all communication to and from the engines).\r
 134 <br><dt>-engineDebugOutput number<dd><a name="index-engineDebugOutput_002c-option-367"></a>Specifies how WinBoard should handle unsolicited output from the engine, \r
 135 with respect to saving it in the debug file. \r
 136 The output is further (hopefully) ignored. \r
 137 If number=0, WinBoard refrains from writing such spurious output to the debug file. \r
 138 If number=1, all engine output is written faithfully to the debug file. \r
 139 If number=2, any protocol-violating line is prefixed with a # character, \r
 140 as the engine itself should have done if it wanted to submit info for inclusion in the debug file.\r
 141 This option is provided for the benefit of applications that use the debug file \r
 142 as a source of information, such as the broadcaster of live games TLCV / TLCS. \r
 143 Such applications can be protected from spurious engine output that might otherwise confuse them.\r
 144 <br><dt>-rsh or -remoteShell shell-name<dd><a name="index-rsh_002c-option-368"></a><a name="index-remoteShell_002c-option-369"></a>Name of the command used to run programs remotely. The default\r
 145 is <samp><span class="file">rsh</span></samp> or <samp><span class="file">remsh</span></samp>, determined when XBoard is\r
 146 configured and compiled.\r
 147 <br><dt>-ruser or -remoteUser user-name<dd><a name="index-ruser_002c-option-370"></a><a name="index-remoteUser_002c-option-371"></a>User name on the remote system when running programs with the\r
 148 <code>remoteShell</code>. The default is your local user name.\r
 149 <br><dt>-userName username<dd><a name="index-userName_002c-option-372"></a>Name under which the Human player will be listed in the PGN file. \r
 150 Default is the login name on your local computer.\r
 151 <br><dt>-delayBeforeQuit number<dt>-delayAfterQuit number<dd><a name="index-delayBeforeQuit_002c-option-373"></a><a name="index-delayAfterQuit_002c-option-374"></a>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 quit command. The second one determines the pause after killing the engine, to make sure it dies.\r
 152 \r
 153 </dl>
 154    \r
 155
 156    </body></html>
 157