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.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="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 <a name="Other-options"></a>
  27 <p>
  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">4.8 Other options</h3>
  34
  35 <p><a name="index-Options_002c-miscellaneous-520"></a>
  36      <dl>
  37 <dt>-ncp/-xncp or -noChessProgram true/false<dd><a name="index-ncp_002c-option-521"></a><a name="index-noChessProgram_002c-option-522"></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-523"></a><a name="index-initalMode_002c-option-524"></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-525"></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           makruk        Thai Chess (shatranj-like, P promotes on 6th rank)
  79           spartan       Spartan Chess (black has unorthodox pieces)
  80           fairy         A catchall variant in which all piece types
  81                         known to XBoard can participate (8x8)
  82           unknown       Catchall for other unknown variants
  83 </pre>
  84      <p>NOT ALL BOARDSIZES PROVIDE A COMPLETE SET OF BUILT-IN BITMAPS FOR ALL
  85 UN-ORTHODOX PIECES, though. Only in <code>boardSize</code> middling and bulky
  86 all 22 piece types are provided, while -boardSize petite has most
  87 of them. Archbishop, Chancellor and Amazon are supported in every
  88 size from petite to bulky. Kings or Amazons are substituted for
  89 missing bitmaps. You can still play variants needing un-orthodox
  90 pieces in other board sizes providing your own bitmaps through the
  91 <code>bitmapDirectory</code> or <code>pixmapDirectory</code> options.
  92
  93      <p>In the shuffle variants, XBoard now does shuffle the pieces, although
  94 you can still do it by hand using Edit Position.  Some variants are
  95 supported only in ICS mode, including bughouse, and
  96 kriegspiel.  The winning/drawing conditions in crazyhouse (off-board
  97 interposition on mate) are not fully understood, but losers, suicide,
  98 giveaway, atomic, and 3check should be OK.
  99 Berolina and cylinder chess can only be played with legality testing off.
 100 In crazyhouse, XBoard now does keep
 101 track of off-board pieces.  In shatranj it does implement the baring
 102 rule when mate detection is switched on.
 103 <br><dt>-boardHeight N<dd><a name="index-boardHeight_002c-option-526"></a>Allows you to set a non-standard number of board ranks in any variant.
 104 If the height is given as -1, the default height for the variant is used.
 105 Default: -1
 106 <br><dt>-boardWidth N<dd><a name="index-boardWidth_002c-option-527"></a>Allows you to set a non-standard number of board files in any variant.
 107 If the width is given as -1, the default width for the variant is used.
 108 With a non-standard width, the initial position will always be an empty board,
 109 as the usual opening array will not fit.
 110 Default: -1
 111 <br><dt>-holdingsSize N<dd><a name="index-holdingsSize_002c-option-528"></a>Allows you to set a non-standard size for the holdings in any variant.
 112 If the size is given as -1, the default holdings size for the variant is used.
 113 The first N piece types will go into the holdings on capture, and you will be
 114 able to drop them on the board in stead of making a normal move. If size equals 0,
 115 there will be no holdings.
 116 Default: -1
 117 <br><dt>-defaultFrcPosition N<dd><a name="index-defaultFrcPosition_002c-option-529"></a>Specifies the number of the opening position in shuffle games like Chess960.
 118 A value of -1 means the position is randomly generated by XBoard
 119 at the beginning of every game.
 120 Default: -1
 121 <br><dt>-pieceToCharTable string<dd><a name="index-pieceToCharTable_002c-option-530"></a>The characters that are used to represent the piece types XBoard knows in FEN
 122 diagrams and SAN moves. The string argument has to have an even length
 123 (or it will be ignored), as white and black pieces have to be given separately
 124 (in that order). The last letter for each color will be the King.
 125 The letters before that will be PNBRQ and then a whole host of fairy pieces
 126 in an order that has not fully crystallized yet (currently FEACWMOHIJGDVSLU,
 127 F=Ferz, Elephant, A=Archbishop, C=Chancellor, W=Wazir, M=Commoner, O=Cannon,
 128 H=Nightrider). You should list at least all pieces that occur in the variant
 129 you are playing. If you have less than 44 characters in the string, the pieces
 130 not mentioned will get assigned a period, and you will not be able to distinguish
 131 them in FENs. You can also explicitly assign pieces a period, in which case they
 132 will not be counted in deciding which captured pieces can go into the holdings.
 133 A tilde '~' as a piece name does mean this piece is used to represent a promoted
 134 Pawn in crazyhouse-like games, i.e. on capture it turns back onto a Pawn.
 135 A '+' similarly indicates the piece is a shogi-style promoted piece, that should
 136 revert to its non-promoted version on capture (rather than to a Pawn).
 137 Note that promoted pieces are represented by pieces 11 further in the list.
 138 You should not have to use this option often: each variant has its own default
 139 setting for the piece representation in FEN, which should be sufficient in normal use.
 140 Default: ""
 141 <br><dt>-pieceNickNames string<dd><a name="index-pieceNickNames_002c-option-531"></a>The characters in the string are interpreted the same way as in the
 142 <code>pieceToCharTable</code> option. But on input, piece-ID letters are
 143 first looked up in the nicknames, and only if not defined there,
 144 in the normal pieceToCharTable. This allows you to have two letters
 145 designate the same piece, (e.g. N as an alternative to H for Horse
 146 in Xiangqi), to make reading of non-compliant notations easier.
 147 Default: ""
 148 <br><dt>-colorNickNames string<dd><a name="index-colorNickNames_002c-option-532"></a>The side-to-move field in a FEN will be first matched against the letters
 149 in the string (first character for white, second for black),
 150 before it is matched to the regular 'w' and 'b'.
 151 This makes it easier to read non-compliant FENs,
 152 which, say, use 'r' for white.
 153 Default: ""
 154 <br><dt>-debug/-xdebug or -debugMode true/false<dd><a name="index-debug_002c-option-533"></a><a name="index-debugMode_002c-option-534"></a>Turns on debugging printout.
 155 <br><dt>-debugFile filename or -nameOfDebugFile filename<dd><a name="index-debugFile_002c-option-535"></a><a name="index-nameOfDebugFile_002c-option-536"></a>Sets the name of the file to which XBoard saves debug information
 156 (including all communication to and from the engines).
 157 A <kbd>%d</kbd> in the given file name (e.g. game%d.debug) will be replaced
 158 by the unique sequence number of a tournament game,
 159 so that the debug output of each game will be written on a separate file.
 160 <br><dt>-engineDebugOutput number<dd><a name="index-engineDebugOutput_002c-option-537"></a>Specifies how XBoard should handle unsolicited output from the engine,
 161 with respect to saving it in the debug file.
 162 The output is further (hopefully) ignored.
 163 If number=0, XBoard refrains from writing such spurious output to the debug file.
 164 If number=1, all engine output is written faithfully to the debug file.
 165 If number=2, any protocol-violating line is prefixed with a '#' character,
 166 as the engine itself should have done if it wanted to submit info for inclusion in the debug file.
 167 This option is provided for the benefit of applications that use the debug file
 168 as a source of information, such as the broadcaster of live games TLCV / TLCS.
 169 Such applications can be protected from spurious engine output that might otherwise confuse them.
 170 <br><dt>-rsh or -remoteShell shell-name<dd><a name="index-rsh_002c-option-538"></a><a name="index-remoteShell_002c-option-539"></a>Name of the command used to run programs remotely. The default
 171 is <samp><span class="file">rsh</span></samp> or <samp><span class="file">remsh</span></samp>, determined when XBoard is
 172 configured and compiled.
 173 <br><dt>-ruser or -remoteUser user-name<dd><a name="index-ruser_002c-option-540"></a><a name="index-remoteUser_002c-option-541"></a>User name on the remote system when running programs with the
 174 <code>remoteShell</code>. The default is your local user name.
 175 <br><dt>-userName username<dd><a name="index-userName_002c-option-542"></a>Name under which the Human player will be listed in the PGN file.
 176 Default is the login name on your local computer.
 177 <br><dt>-delayBeforeQuit number<dt>-delayAfterQuit number<dd><a name="index-delayBeforeQuit_002c-option-543"></a><a name="index-delayAfterQuit_002c-option-544"></a>These options specify how long XBoard 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.
 178 <br><dt>-searchMode n<dd><a name="index-searchMode_002c-option-545"></a>The integer n encodes the mode for the &lsquo;<samp><span class="samp">find position</span></samp>&rsquo; function.
 179 Default: 1 (= Exact position match)
 180 <br><dt>-eloThresholdBoth elo<dt>-eloThresholdAny elo<dd><a name="index-eloThresholdBoth_002c-option-546"></a><a name="index-eloThresholdAny_002c-option-547"></a>Defines a lower limit for the Elo rating, which has to be surpassed
 181 before a game will be considered when searching for a board position.
 182 Default: 0
 183 <br><dt>-dateThreshold year<dd><a name="index-dateThreshold_002c-option-548"></a>Only games not played before the given year will be considered when
 184 searching for a board position
 185
 186    </dl>
 187
 188    </body></html>
 189