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