manual.html

   1 <!DOCTYPE HTML>\r
   2 <html>\r
   3 \r
   4 <head>\r
   5 <title>WinBoard 4.3.15</title>\r
   6 </head>\r
   7 \r
   8 <body>\r
   9 <table><tr><td halign="top">\r
  10 <h1>WinBoard 4.3.15</h1>\r
  11 <h2>"For the ultimate WinBoard experience"</h2>\r
  12 <h3>Introduction</h3>\r
  13 <p>\r
  14 The WinBoard 4.3 series is a continuation of the WinBoard_x line by Allessandro Scotti.\r
  15 It is been further developed, and is maintained, by H.G. Muller.\r
  16 Most addtions and improvements that went into this since the last version produced\r
  17 by the GNU-Savannah xboard project team, WinBoard 4.2.7b,\r
  18 are unfortunately not parallelled in xboard.\r
  19 On the contrary, they have destroyed the compatibility of the back-end sources\r
  20 shared by WinBoard and xboard with the xboard front-end of version 4.2.7b.\r
  21 Since WinBoard 4.3.14, however, the releases again coms with a compatible xboard front-end.\r
  22 That does not mean that all the features added to WinBoard can already be used\r
  23 in this xboard version.\r
  24 But some can, an in 4.3.15 many more have been added.\r
  25 </p><p>\r
  26 The description below applies specifically to WinBoard, \r
  27 although we have tried to mark features that can also be used in xboard by (x) everywhere.\r
  28 This version of xboard does does have som new menus added to control such features.\r
  29 Other functionss, if they work at all, must be switched on from the command line.\r
  30 </p>\r
  31 </td><td width="20">\r
  32 </td><td width="600" halign="center" cellpdding="20">\r
  33 <img src="mini.gif">\r
  34 </td></tr></table>\r
  35 <h3>New features since 4.2.7b</h3>\r
  36 <p>\r
  37 Below follows a table that lists the new features, \r
  38 the command-line option needed to control them,\r
  39 and if there is a menu provided that can switch the option while WinBoard is running\r
  40 (command-line options exert their effect only at startup).\r
  41 Note that, unlike WinBoard 4.2.7, the WinBoard 4.3 series is fully castling and e.p. aware,\r
  42 and handles the castling, e.p. and 50-move field in FENs on input and output as should be expected.\r
  43 </p>\r
  44 <table cellpadding="3" border="1"><tr><td width="220">\r
  45       <h3>command-line option</h3>\r
  46     </td><td>\r
  47       <h3>description</h3>\r
  48     </td><td width="250">\r
  49       <h3>menu</h3>\r
  50   </td></tr><tr><td>\r
  51       \r
  52     </td><td bgcolor="lightblue">\r
  53       <strong>ENGINE-ENGINE ADJUDICATION OPTIONS<strong>\r
  54     </td><td>\r
  55       \r
  56   </td></tr><tr><td>\r
  57       -adjudicateLossThreshold 0 (*x)\r
  58     </td><td>\r
  59       adjudicates engine-engine game based on score\r
  60     </td><td>\r
  61       Options -> Engine... (x)\r
  62   </td></tr><tr><td>\r
  63       -checkMates false (*x)\r
  64     </td><td>\r
  65       detect and end game on checkmates and stalemates\r
  66     </td><td>\r
  67       Options -> Engine... (x)\r
  68   </td></tr><tr><td>\r
  69       -testClaims false (*x)\r
  70     </td><td>\r
  71       WinBoard corrects false RESULT claims\r
  72     </td><td>\r
  73       Options -> Engine.. (x)\r
  74   </td></tr><tr><td>\r
  75       -materialDraws false (*x)\r
  76     </td><td>\r
  77       adjudicate draw when no mating material present\r
  78     </td><td>\r
  79       Options -> Engine.. (x)\r
  80   </td></tr><tr><td>\r
  81       -trivialDraws false (*x)\r
  82     </td><td>\r
  83       adjudicate draw in endgames like KRKR and KNNK\r
  84     </td><td>\r
  85       Options -> Engine.. (x)\r
  86   </td></tr><tr><td>\r
  87       -adjudicateDrawMoves 0 (*)\r
  88     </td><td>\r
  89       adjudicate draw when game lasts too long\r
  90     </td><td>\r
  91       Options -> Engine.. (x)\r
  92   </td></tr><tr><td>\r
  93       -ruleMoves 51 (*x)\r
  94     </td><td>\r
  95       number of reversible moves after which to adjudicate draw\r
  96     </td><td>\r
  97       Options -> Engine.. (x)\r
  98   </td></tr><tr><td>\r
  99       -repeatsToDraw 6 (*x)\r
 100     </td><td>\r
 101       adjudicate draw when a position occurs this many times\r
 102     </td><td>\r
 103       Options -> Engine.. (x)\r
 104   </td></tr><tr><td>\r
 105       -firstScoreAbs false (x)\r
 106       <br>\r
 107       -secondScoreAbs false (x)\r
 108     </td><td>\r
 109       Engine indicates score for white, even when playing black\r
 110     </td><td>\r
 111       Options -> Adjudications.. (xboard-only)\r
 112   </td></tr><tr><td>\r
 113       -\r
 114     </td><td>\r
 115       Adjudicate the game in progress as win to white, win to black, or draw\r
 116     </td><td>\r
 117       Action -> Adjudicate to White\r
 118       <br>\r
 119       Action -> Adjudicate to Black\r
 120       <br>\r
 121       Action -> Adjudicate Draw\r
 122   </td></tr><tr><td>\r
 123       \r
 124     </td><td bgcolor="lightblue">\r
 125       <strong>TIME-CONTROL AND TIMING OPTIONS</strong>\r
 126     </td><td>\r
 127       \r
 128   </td></tr><tr><td>\r
 129       -firstTimeOdds 1 (x)\r
 130       <br>\r
 131       -secondTimeOdds 1 (x)\r
 132     </td><td>\r
 133       reduce the thinking time of the mentioned engine by the given factor\r
 134     </td><td>\r
 135       Options -> Engine Settings.. (xboard only)\r
 136   </td></tr><tr><td>\r
 137       -timeOddsMode 1 (*x)\r
 138     </td><td>\r
 139       determines what happens when both engine have time odds\r
 140     </td><td>\r
 141       Options -> Engine Settings.. (xboard only)\r
 142   </td></tr><tr><td>\r
 143       -firstNPS -1 (x)\r
 144       <br>\r
 145       -secondNPS -1 (x)\r
 146     </td><td>\r
 147       engine must use node count for its time control, as if running at specified rate\r
 148     </td><td>\r
 149       -\r
 150   </td></tr><tr><td>\r
 151       -matchPause 10000 (*x)\r
 152     </td><td>\r
 153       number of msec to wait between games in match mode\r
 154     </td><td>\r
 155       -\r
 156   </td></tr><tr><td>\r
 157       -delayBeforeQuit 0 (*)\r
 158       <br>\r
 159       -delayAfterQuit 0 (*)\r
 160     </td><td>\r
 161       timing parameter specifying how to terminate the engine processes\r
 162     </td><td>\r
 163       -\r
 164   </td></tr><tr><td>\r
 165       -\r
 166     </td><td>\r
 167       adjust the clocks by 1 minute (up or down)\r
 168     </td><td>\r
 169       left- or right-cick on clock in edit-game mode\r
 170   </td></tr><tr><td>\r
 171       \r
 172     </td><td bgcolor="lightblue">\r
 173       <strong>DISPLAY-LOOK OPTIONS</strong>\r
 174     </td><td>\r
 175       \r
 176   </td></tr><tr><td>\r
 177       -liteBackTextureFile "" (*)\r
 178       <br>\r
 179       -darkBackTextureFile "" (*)\r
 180       <br>\r
 181       -liteBackTextureMode 1 (*)\r
 182       <br>\r
 183       -darkBackTextureMode 1 (*)\r
 184     </td><td>\r
 185       Allows you to use any bitmap picture for displaying the board square\r
 186     </td><td>\r
 187       -\r
 188   </td></tr><tr><td>\r
 189       -renderPiecesWithFont "" (*)\r
 190     </td><td>\r
 191       specifies a true-type Chess font to be used for piece symbols\r
 192     </td><td>\r
 193       -\r
 194   </td></tr><tr><td>\r
 195       -fontPieceToCharTable "" (*)\r
 196     </td><td>\r
 197       specifies which font character to use for the various piece types\r
 198     </td><td>\r
 199       -\r
 200   </td></tr><tr><td>\r
 201       -overrideLineGap 1 (*)\r
 202     </td><td>\r
 203       controls the width of the black grid lines between squares\r
 204     </td><td>\r
 205       -\r
 206   </td></tr><tr><td>\r
 207       -fontPieceBackColorWhite #0 (*)\r
 208       <br>\r
 209       -fontPieceForeColorWhite #0 (*)\r
 210       <br>\r
 211       -fontPieceBackColorBlack #0 (*)\r
 212       <br>\r
 213       -fontPieceForeColorBlack #0 (*)\r
 214     </td><td>\r
 215       control piece colors in font-based rendering\r
 216     </td><td>\r
 217       -\r
 218   </td></tr><tr><td>\r
 219       -fontPieceSize 80 (*)\r
 220     </td><td>\r
 221       tunes the size of pieces in font-based rendering (% of square size)\r
 222     </td><td>\r
 223       -\r
 224   </td></tr><tr><td>\r
 225       -highlightMoveWithArrow false (*)\r
 226     </td><td>\r
 227       draws a big arrow to indicate the move last played\r
 228     </td><td>\r
 229       Options -> General...\r
 230   </td></tr><tr><td>\r
 231       -highlightArrowColor #FFFF80 (*)\r
 232     </td><td>\r
 233       controls the color of the highlight arrow\r
 234     </td><td>\r
 235       -\r
 236   </td></tr><tr><td>\r
 237       -\r
 238     </td><td>\r
 239       Swap white and black clock\r
 240     </td><td>\r
 241       Options -> Swap Clocks\r
 242   </td></tr><tr><td>\r
 243       \r
 244     </td><td bgcolor="lightblue">\r
 245       <strong>UCI ENGINE OPTIONS</strong>\r
 246     </td><td>\r
 247       \r
 248   </td></tr><tr><td>\r
 249       -polyglotDir "" (*)\r
 250     </td><td>\r
 251       tells WinBoard where you installed Polyglot, for automatic invocation with UCI engines\r
 252     </td><td>\r
 253       Options -> UCI... (x)\r
 254   </td></tr><tr><td>\r
 255       -polyglotBook "" (*)\r
 256     </td><td>\r
 257       tells WinBoard which opening book it should use, or should make Polyglot use.\r
 258     </td><td>\r
 259       Options -> UCI... (x)\r
 260   </td></tr><tr><td>\r
 261       -usePolyglotBook false (*)\r
 262     </td><td>\r
 263       turns the use of the Polygot book on or off\r
 264     </td><td>\r
 265       Options -> UCI... (x)\r
 266   </td></tr><tr><td>\r
 267       -defaultPathEGTB "c:\egtb" (*)\r
 268     </td><td>\r
 269       folder where to find end-game tables\r
 270     </td><td>\r
 271       Options -> UCI... (x)\r
 272   </td></tr><tr><td>\r
 273       -defaultCacheSizeEGTB 4 (*)\r
 274     </td><td>\r
 275       specifies the cache size for UCI engines\r
 276     </td><td>\r
 277       Options -> UCI... (x)\r
 278   </td></tr><tr><td>\r
 279       -defaultHashSize 64 (*)\r
 280     </td><td>\r
 281       Specifies the size of the main hash table for UCI engines\r
 282     </td><td>\r
 283       Options -> UCI... (x)\r
 284   </td></tr><tr><td>\r
 285       -firstIsUCI false\r
 286       <br>\r
 287       -secondIsUCI false\r
 288       <br>\r
 289       -fUCI\r
 290       <br>\r
 291       -sUCI\r
 292     </td><td>\r
 293       tells WinBoard the corresponding engine should be run through Polyglot\r
 294     </td><td>\r
 295       -\r
 296   </td></tr><tr><td>\r
 297       -firstHasOwnBookUCI true\r
 298       <br>\r
 299       -secondHasOwnBookUCI true\r
 300       <br>\r
 301       -fNoOwnBookUCI true\r
 302       <br>\r
 303       -sNoOwnBookUCI true\r
 304     </td><td>\r
 305       tells Polyglot if the engine should use its own opening book\r
 306     </td><td>\r
 307       Options -> Engine Settings... (xboard only)\r
 308   </td></tr><tr><td>\r
 309       -smpCores 1 (*x)\r
 310     </td><td>\r
 311       Sets the maximum number of CPUs an SMP engine can use.\r
 312       (only affects engines that support the <strong>cores</strong> command of WB protocol)\r
 313     </td><td>\r
 314       Options -> Engine Settings... (xboard only)\r
 315   </td></tr><tr><td>\r
 316       -egtFormats "" (*x)\r
 317     </td><td>\r
 318       Specifies which end-game tables are installed on the computer,\r
 319       and where they can be found\r
 320       (e.g. "nalimov:\chess\egtb,scorpio:\chess\bitbases")\r
 321     </td><td>\r
 322       -\r
 323   </td></tr><tr><td>\r
 324       \r
 325     </td><td bgcolor="lightblue">\r
 326       <strong>CHESS-VARIANT OPTIONS</strong>\r
 327     </td><td>\r
 328       \r
 329   </td></tr><tr><td>\r
 330       -boardHeight -1 (*x)\r
 331       <br>\r
 332       -boardWidth -1 (*x)\r
 333       <br>\r
 334       -holdingsSize -1 (*x)\r
 335     </td><td>\r
 336       specifies the board format and nr of piece types that can be dropped,\r
 337       when you want it to be different from what is usual in the chosen varint\r
 338     </td><td>\r
 339       File -> New Variant...\r
 340   </td></tr><tr><td>\r
 341       -variant normal (x)\r
 342     </td><td>\r
 343       supports many new variants: xiangqi, shogi, fischerandom, capabanca, gothic, caparandom, janus,\r
 344       shatranj, courier, knightmate, berolina, falcon, cylinder, fairy, super\r
 345     </td><td>\r
 346       File -> New Variant... (x)\r
 347   </td></tr><tr><td>\r
 348       -defaultFrcOpening -1 (x)\r
 349     </td><td>\r
 350       allows you to play from a specific opening shuffle, or make a new shuffle each game\r
 351     </td><td>\r
 352       File -> New Shuffle Game... (x)\r
 353   </td></tr><tr><td>\r
 354       -pieceToCharTable "" (x)\r
 355     </td><td>\r
 356       allows you to specify by which letters pieces are referred to in FEN and SAN,\r
 357       if you want to deviate from what is usual for the current variant\r
 358     </td><td>\r
 359       -\r
 360   </td></tr><tr><td>\r
 361       -flipBlack fase (*x)\r
 362     </td><td>\r
 363       displays opponent pieces uppside down (for Shogi)\r
 364     </td><td>\r
 365       Options -> Board...\r
 366   </td></tr><tr><td>\r
 367       -allWhite false (*x)\r
 368     </td><td>\r
 369       use white bitmaps (with black outline) also for display of black pieces (for Shogi)\r
 370     </td><td>\r
 371       Options -> Board...\r
 372   </td></tr><tr><td>\r
 373       \r
 374     </td><td bgcolor="lightblue">\r
 375       <strong>PGN FILE OPTIONS</strong>\r
 376     </td><td>\r
 377       \r
 378   </td></tr><tr><td>\r
 379       -pgnExtendedInfo false (*x)\r
 380     </td><td>\r
 381       save engine output (depth, score time) in PGN\r
 382     </td><td>\r
 383       Options->General...\r
 384   </td></tr><tr><td>\r
 385       -pgnEventHeader </br>"Computer Chess Game" (*x)\r
 386     </td><td>\r
 387       specify the event for the PGN event tag\r
 388     </td><td>\r
 389       -\r
 390   </td></tr><tr><td>\r
 391       -saveOutOfBookInfo true (*)\r
 392     </td><td>\r
 393       include an 'annotator' tag in the PGN file\r
 394     </td><td>\r
 395       \r
 396   </td></tr><tr><td>\r
 397       -hideThinkingFromHuman false (*x)\r
 398     </td><td>\r
 399       suppresses the engine thinking output in the display, without the need to switch it off\r
 400       (so it can still appear in the PGN file)\r
 401     </td><td>\r
 402       Options -> General... (x)\r
 403   </td></tr><tr><td>\r
 404       \r
 405     </td><td bgcolor="lightblue">\r
 406       <strong>USER-INTERFACE OPTIONS AND WINDOW CONTROL</strong>\r
 407     </td><td>\r
 408       \r
 409   </td></tr><tr><td>\r
 410       -moveHistoryUP true (*)\r
 411       <br>\r
 412       -moveHistoryX 0 (*)\r
 413       <br>\r
 414       -moveHistoryY 0 (*)\r
 415       <br>\r
 416       -moveHistoryW 0 (*)\r
 417       <br>\r
 418       -moveHistoryH 0 (*)\r
 419     </td><td>\r
 420       controls opening, placement and size of a window containing the moves of the current game\r
 421     </td><td>\r
 422       Mode -> Show Move History (x)\r
 423   </td></tr><tr><td>\r
 424       -evalGraphUp true (*)\r
 425       <br>\r
 426       -evalGraphX 0 (*)\r
 427       <br>\r
 428       -evalGraphY 0 (*)\r
 429       <br>\r
 430       -evalGraphW 0 (*)\r
 431       <br>\r
 432       -evalGraphH 0 (*)\r
 433     </td><td>\r
 434       controls opening, placement and size of a window containing a graph of the\r
 435       evaluation score of the engine(s) as a function of move number of the current game\r
 436     </td><td>\r
 437       Mode -> Show Evaluation Graph\r
 438   </td></tr><tr><td>\r
 439       -engineOutputUp true (*)\r
 440       <br>\r
 441       -engineOutputX 0 (*)\r
 442       <br>\r
 443       -engineOutputY 0 (*)\r
 444       <br>\r
 445       -engineOutputW 0 (*)\r
 446       <br>\r
 447       -engineOutputH 0 (*)\r
 448     </td><td>\r
 449       controls opening, placement and size of a window containing the thinking output of the engine(s)\r
 450     </td><td>\r
 451       Mode -> Show Engine Output (x)\r
 452   </td></tr><tr><td>\r
 453       -stickyWindows true (*)\r
 454     </td><td>\r
 455       make the various windows snap onto each other, and stick together\r
 456     </td><td>\r
 457       -\r
 458   </td></tr><tr><td>\r
 459       -showEvalInMoveHistory true (*)\r
 460     </td><td>\r
 461       depth/score info of the engine is included as comments in the move history window\r
 462     </td><td>\r
 463       Options -> General...\r
 464   </td></tr><tr><td>\r
 465       -evalHistColorWhite #FFFFB0 (*)\r
 466       <br>\r
 467       -evalHistColorBlack #AD5D3D (*)\r
 468     </td><td>\r
 469       determines the color of the eval-score comments in the move-history window\r
 470     </td><td>\r
 471       -\r
 472   </td></tr><tr><td>\r
 473       -autoDisplayComment true (*)\r
 474     </td><td>\r
 475       causes a window for displaying PGN comments to pop up automatically when such a comment is encountered\r
 476     </td><td>\r
 477       -\r
 478   </td></tr><tr><td>\r
 479       -autoDisplayTags true (*)\r
 480     </td><td>\r
 481       causes a window with PGN tags to be displayed as soon as a PGN file is loaded\r
 482     </td><td>\r
 483       -\r
 484   </td></tr><tr><td>\r
 485       -gameListTags "eprd" (*)\r
 486     </td><td>\r
 487       specifies the PGN tags that should be displayed in the game list\r
 488     </td><td>\r
 489       Options -> Game List...\r
 490   </td></tr><tr><td>\r
 491       \r
 492     </td><td bgcolor="lightblue">\r
 493       <strong>MISCELLANEOUS</strong>\r
 494     </td><td>\r
 495       \r
 496   </td></tr><tr><td>\r
 497       -debugFile "winboard.debug"\r
 498       <br>\r
 499       -nameOfDebugFile "winboard.debug"\r
 500     </td><td>\r
 501       allows you to specify an alternative name for saving the debug information\r
 502     </td><td>\r
 503       -\r
 504   </td></tr><tr><td>\r
 505       -\r
 506     </td><td>\r
 507       save chess-board display as diagram in bitmap file\r
 508       (only works for the smaller board formats!)\r
 509     </td><td>\r
 510       File -> Save Diagram...\r
 511   </td></tr><tr><td>\r
 512       -\r
 513     </td><td>\r
 514       display only those lines in the game list that contain a given string\r
 515     </td><td>\r
 516       in Game-List window\r
 517   </td></tr><tr><td>\r
 518       -rewindFile 0 (x)\r
 519     </td><td>\r
 520       A nonzero value for this option causes the loadGameIndex or loadPositionIndex\r
 521       to rewind to the beginning of the Games or Position file when it reaches\r
 522       the given value in auto-increment match mode. \r
 523       This mode is specified by a negative value as argument of the /lgi or /lpi options,\r
 524       where -1 increments the index after every game of the match,\r
 525       and -2 after every two games (so that each position is played with black and white).\r
 526     </td><td>\r
 527       -\r
 528 </td></tr></table>\r
 529 <p>\r
 530 The value with which the option is listed is the default value.\r
 531 If it is false or true, it is a Boolean option, a number implies an integer option.\r
 532 A value starting with # indicates an RGB color indication in hexadecimal notation.\r
 533 Options the settings of which are saved into the winboard.ini file are marked with (*).\r
 534 </p>\r
 535 </body>\r