cleanup: got rid of a lot of files that are not needed for a new release
[xboard.git] / manual.html
diff --git a/manual.html b/manual.html
deleted file mode 100644 (file)
index 1d89a86..0000000
+++ /dev/null
@@ -1,535 +0,0 @@
-<!DOCTYPE HTML>\r
-<html>\r
-\r
-<head>\r
-<title>WinBoard 4.3.15</title>\r
-</head>\r
-\r
-<body>\r
-<table><tr><td halign="top">\r
-<h1>WinBoard 4.3.15</h1>\r
-<h2>"For the ultimate WinBoard experience"</h2>\r
-<h3>Introduction</h3>\r
-<p>\r
-The WinBoard 4.3 series is a continuation of the WinBoard_x line by Allessandro Scotti.\r
-It is been further developed, and is maintained, by H.G. Muller.\r
-Most addtions and improvements that went into this since the last version produced\r
-by the GNU-Savannah xboard project team, WinBoard 4.2.7b,\r
-are unfortunately not parallelled in xboard.\r
-On the contrary, they have destroyed the compatibility of the back-end sources\r
-shared by WinBoard and xboard with the xboard front-end of version 4.2.7b.\r
-Since WinBoard 4.3.14, however, the releases again coms with a compatible xboard front-end.\r
-That does not mean that all the features added to WinBoard can already be used\r
-in this xboard version.\r
-But some can, an in 4.3.15 many more have been added.\r
-</p><p>\r
-The description below applies specifically to WinBoard, \r
-although we have tried to mark features that can also be used in xboard by (x) everywhere.\r
-This version of xboard does does have som new menus added to control such features.\r
-Other functionss, if they work at all, must be switched on from the command line.\r
-</p>\r
-</td><td width="20">\r
-</td><td width="600" halign="center" cellpdding="20">\r
-<img src="mini.gif">\r
-</td></tr></table>\r
-<h3>New features since 4.2.7b</h3>\r
-<p>\r
-Below follows a table that lists the new features, \r
-the command-line option needed to control them,\r
-and if there is a menu provided that can switch the option while WinBoard is running\r
-(command-line options exert their effect only at startup).\r
-Note that, unlike WinBoard 4.2.7, the WinBoard 4.3 series is fully castling and e.p. aware,\r
-and handles the castling, e.p. and 50-move field in FENs on input and output as should be expected.\r
-</p>\r
-<table cellpadding="3" border="1"><tr><td width="220">\r
-      <h3>command-line option</h3>\r
-    </td><td>\r
-      <h3>description</h3>\r
-    </td><td width="250">\r
-      <h3>menu</h3>\r
-  </td></tr><tr><td>\r
-      \r
-    </td><td bgcolor="lightblue">\r
-      <strong>ENGINE-ENGINE ADJUDICATION OPTIONS<strong>\r
-    </td><td>\r
-      \r
-  </td></tr><tr><td>\r
-      -adjudicateLossThreshold 0 (*x)\r
-    </td><td>\r
-      adjudicates engine-engine game based on score\r
-    </td><td>\r
-      Options -> Engine... (x)\r
-  </td></tr><tr><td>\r
-      -checkMates false (*x)\r
-    </td><td>\r
-      detect and end game on checkmates and stalemates\r
-    </td><td>\r
-      Options -> Engine... (x)\r
-  </td></tr><tr><td>\r
-      -testClaims false (*x)\r
-    </td><td>\r
-      WinBoard corrects false RESULT claims\r
-    </td><td>\r
-      Options -> Engine.. (x)\r
-  </td></tr><tr><td>\r
-      -materialDraws false (*x)\r
-    </td><td>\r
-      adjudicate draw when no mating material present\r
-    </td><td>\r
-      Options -> Engine.. (x)\r
-  </td></tr><tr><td>\r
-      -trivialDraws false (*x)\r
-    </td><td>\r
-      adjudicate draw in endgames like KRKR and KNNK\r
-    </td><td>\r
-      Options -> Engine.. (x)\r
-  </td></tr><tr><td>\r
-      -adjudicateDrawMoves 0 (*)\r
-    </td><td>\r
-      adjudicate draw when game lasts too long\r
-    </td><td>\r
-      Options -> Engine.. (x)\r
-  </td></tr><tr><td>\r
-      -ruleMoves 51 (*x)\r
-    </td><td>\r
-      number of reversible moves after which to adjudicate draw\r
-    </td><td>\r
-      Options -> Engine.. (x)\r
-  </td></tr><tr><td>\r
-      -repeatsToDraw 6 (*x)\r
-    </td><td>\r
-      adjudicate draw when a position occurs this many times\r
-    </td><td>\r
-      Options -> Engine.. (x)\r
-  </td></tr><tr><td>\r
-      -firstScoreAbs false (x)\r
-      <br>\r
-      -secondScoreAbs false (x)\r
-    </td><td>\r
-      Engine indicates score for white, even when playing black\r
-    </td><td>\r
-      Options -> Adjudications.. (xboard-only)\r
-  </td></tr><tr><td>\r
-      -\r
-    </td><td>\r
-      Adjudicate the game in progress as win to white, win to black, or draw\r
-    </td><td>\r
-      Action -> Adjudicate to White\r
-      <br>\r
-      Action -> Adjudicate to Black\r
-      <br>\r
-      Action -> Adjudicate Draw\r
-  </td></tr><tr><td>\r
-      \r
-    </td><td bgcolor="lightblue">\r
-      <strong>TIME-CONTROL AND TIMING OPTIONS</strong>\r
-    </td><td>\r
-      \r
-  </td></tr><tr><td>\r
-      -firstTimeOdds 1 (x)\r
-      <br>\r
-      -secondTimeOdds 1 (x)\r
-    </td><td>\r
-      reduce the thinking time of the mentioned engine by the given factor\r
-    </td><td>\r
-      Options -> Engine Settings.. (xboard only)\r
-  </td></tr><tr><td>\r
-      -timeOddsMode 1 (*x)\r
-    </td><td>\r
-      determines what happens when both engine have time odds\r
-    </td><td>\r
-      Options -> Engine Settings.. (xboard only)\r
-  </td></tr><tr><td>\r
-      -firstNPS -1 (x)\r
-      <br>\r
-      -secondNPS -1 (x)\r
-    </td><td>\r
-      engine must use node count for its time control, as if running at specified rate\r
-    </td><td>\r
-      -\r
-  </td></tr><tr><td>\r
-      -matchPause 10000 (*x)\r
-    </td><td>\r
-      number of msec to wait between games in match mode\r
-    </td><td>\r
-      -\r
-  </td></tr><tr><td>\r
-      -delayBeforeQuit 0 (*)\r
-      <br>\r
-      -delayAfterQuit 0 (*)\r
-    </td><td>\r
-      timing parameter specifying how to terminate the engine processes\r
-    </td><td>\r
-      -\r
-  </td></tr><tr><td>\r
-      -\r
-    </td><td>\r
-      adjust the clocks by 1 minute (up or down)\r
-    </td><td>\r
-      left- or right-cick on clock in edit-game mode\r
-  </td></tr><tr><td>\r
-      \r
-    </td><td bgcolor="lightblue">\r
-      <strong>DISPLAY-LOOK OPTIONS</strong>\r
-    </td><td>\r
-      \r
-  </td></tr><tr><td>\r
-      -liteBackTextureFile "" (*)\r
-      <br>\r
-      -darkBackTextureFile "" (*)\r
-      <br>\r
-      -liteBackTextureMode 1 (*)\r
-      <br>\r
-      -darkBackTextureMode 1 (*)\r
-    </td><td>\r
-      Allows you to use any bitmap picture for displaying the board square\r
-    </td><td>\r
-      -\r
-  </td></tr><tr><td>\r
-      -renderPiecesWithFont "" (*)\r
-    </td><td>\r
-      specifies a true-type Chess font to be used for piece symbols\r
-    </td><td>\r
-      -\r
-  </td></tr><tr><td>\r
-      -fontPieceToCharTable "" (*)\r
-    </td><td>\r
-      specifies which font character to use for the various piece types\r
-    </td><td>\r
-      -\r
-  </td></tr><tr><td>\r
-      -overrideLineGap 1 (*)\r
-    </td><td>\r
-      controls the width of the black grid lines between squares\r
-    </td><td>\r
-      -\r
-  </td></tr><tr><td>\r
-      -fontPieceBackColorWhite #0 (*)\r
-      <br>\r
-      -fontPieceForeColorWhite #0 (*)\r
-      <br>\r
-      -fontPieceBackColorBlack #0 (*)\r
-      <br>\r
-      -fontPieceForeColorBlack #0 (*)\r
-    </td><td>\r
-      control piece colors in font-based rendering\r
-    </td><td>\r
-      -\r
-  </td></tr><tr><td>\r
-      -fontPieceSize 80 (*)\r
-    </td><td>\r
-      tunes the size of pieces in font-based rendering (% of square size)\r
-    </td><td>\r
-      -\r
-  </td></tr><tr><td>\r
-      -highlightMoveWithArrow false (*)\r
-    </td><td>\r
-      draws a big arrow to indicate the move last played\r
-    </td><td>\r
-      Options -> General...\r
-  </td></tr><tr><td>\r
-      -highlightArrowColor #FFFF80 (*)\r
-    </td><td>\r
-      controls the color of the highlight arrow\r
-    </td><td>\r
-      -\r
-  </td></tr><tr><td>\r
-      -\r
-    </td><td>\r
-      Swap white and black clock\r
-    </td><td>\r
-      Options -> Swap Clocks\r
-  </td></tr><tr><td>\r
-      \r
-    </td><td bgcolor="lightblue">\r
-      <strong>UCI ENGINE OPTIONS</strong>\r
-    </td><td>\r
-      \r
-  </td></tr><tr><td>\r
-      -polyglotDir "" (*)\r
-    </td><td>\r
-      tells WinBoard where you installed Polyglot, for automatic invocation with UCI engines\r
-    </td><td>\r
-      Options -> UCI... (x)\r
-  </td></tr><tr><td>\r
-      -polyglotBook "" (*)\r
-    </td><td>\r
-      tells WinBoard which opening book it should use, or should make Polyglot use.\r
-    </td><td>\r
-      Options -> UCI... (x)\r
-  </td></tr><tr><td>\r
-      -usePolyglotBook false (*)\r
-    </td><td>\r
-      turns the use of the Polygot book on or off\r
-    </td><td>\r
-      Options -> UCI... (x)\r
-  </td></tr><tr><td>\r
-      -defaultPathEGTB "c:\egtb" (*)\r
-    </td><td>\r
-      folder where to find end-game tables\r
-    </td><td>\r
-      Options -> UCI... (x)\r
-  </td></tr><tr><td>\r
-      -defaultCacheSizeEGTB 4 (*)\r
-    </td><td>\r
-      specifies the cache size for UCI engines\r
-    </td><td>\r
-      Options -> UCI... (x)\r
-  </td></tr><tr><td>\r
-      -defaultHashSize 64 (*)\r
-    </td><td>\r
-      Specifies the size of the main hash table for UCI engines\r
-    </td><td>\r
-      Options -> UCI... (x)\r
-  </td></tr><tr><td>\r
-      -firstIsUCI false\r
-      <br>\r
-      -secondIsUCI false\r
-      <br>\r
-      -fUCI\r
-      <br>\r
-      -sUCI\r
-    </td><td>\r
-      tells WinBoard the corresponding engine should be run through Polyglot\r
-    </td><td>\r
-      -\r
-  </td></tr><tr><td>\r
-      -firstHasOwnBookUCI true\r
-      <br>\r
-      -secondHasOwnBookUCI true\r
-      <br>\r
-      -fNoOwnBookUCI true\r
-      <br>\r
-      -sNoOwnBookUCI true\r
-    </td><td>\r
-      tells Polyglot if the engine should use its own opening book\r
-    </td><td>\r
-      Options -> Engine Settings... (xboard only)\r
-  </td></tr><tr><td>\r
-      -smpCores 1 (*x)\r
-    </td><td>\r
-      Sets the maximum number of CPUs an SMP engine can use.\r
-      (only affects engines that support the <strong>cores</strong> command of WB protocol)\r
-    </td><td>\r
-      Options -> Engine Settings... (xboard only)\r
-  </td></tr><tr><td>\r
-      -egtFormats "" (*x)\r
-    </td><td>\r
-      Specifies which end-game tables are installed on the computer,\r
-      and where they can be found\r
-      (e.g. "nalimov:\chess\egtb,scorpio:\chess\bitbases")\r
-    </td><td>\r
-      -\r
-  </td></tr><tr><td>\r
-      \r
-    </td><td bgcolor="lightblue">\r
-      <strong>CHESS-VARIANT OPTIONS</strong>\r
-    </td><td>\r
-      \r
-  </td></tr><tr><td>\r
-      -boardHeight -1 (*x)\r
-      <br>\r
-      -boardWidth -1 (*x)\r
-      <br>\r
-      -holdingsSize -1 (*x)\r
-    </td><td>\r
-      specifies the board format and nr of piece types that can be dropped,\r
-      when you want it to be different from what is usual in the chosen varint\r
-    </td><td>\r
-      File -> New Variant...\r
-  </td></tr><tr><td>\r
-      -variant normal (x)\r
-    </td><td>\r
-      supports many new variants: xiangqi, shogi, fischerandom, capabanca, gothic, caparandom, janus,\r
-      shatranj, courier, knightmate, berolina, falcon, cylinder, fairy, super\r
-    </td><td>\r
-      File -> New Variant... (x)\r
-  </td></tr><tr><td>\r
-      -defaultFrcOpening -1 (x)\r
-    </td><td>\r
-      allows you to play from a specific opening shuffle, or make a new shuffle each game\r
-    </td><td>\r
-      File -> New Shuffle Game... (x)\r
-  </td></tr><tr><td>\r
-      -pieceToCharTable "" (x)\r
-    </td><td>\r
-      allows you to specify by which letters pieces are referred to in FEN and SAN,\r
-      if you want to deviate from what is usual for the current variant\r
-    </td><td>\r
-      -\r
-  </td></tr><tr><td>\r
-      -flipBlack fase (*x)\r
-    </td><td>\r
-      displays opponent pieces uppside down (for Shogi)\r
-    </td><td>\r
-      Options -> Board...\r
-  </td></tr><tr><td>\r
-      -allWhite false (*x)\r
-    </td><td>\r
-      use white bitmaps (with black outline) also for display of black pieces (for Shogi)\r
-    </td><td>\r
-      Options -> Board...\r
-  </td></tr><tr><td>\r
-      \r
-    </td><td bgcolor="lightblue">\r
-      <strong>PGN FILE OPTIONS</strong>\r
-    </td><td>\r
-      \r
-  </td></tr><tr><td>\r
-      -pgnExtendedInfo false (*x)\r
-    </td><td>\r
-      save engine output (depth, score time) in PGN\r
-    </td><td>\r
-      Options->General...\r
-  </td></tr><tr><td>\r
-      -pgnEventHeader </br>"Computer Chess Game" (*x)\r
-    </td><td>\r
-      specify the event for the PGN event tag\r
-    </td><td>\r
-      -\r
-  </td></tr><tr><td>\r
-      -saveOutOfBookInfo true (*)\r
-    </td><td>\r
-      include an 'annotator' tag in the PGN file\r
-    </td><td>\r
-      \r
-  </td></tr><tr><td>\r
-      -hideThinkingFromHuman false (*x)\r
-    </td><td>\r
-      suppresses the engine thinking output in the display, without the need to switch it off\r
-      (so it can still appear in the PGN file)\r
-    </td><td>\r
-      Options -> General... (x)\r
-  </td></tr><tr><td>\r
-      \r
-    </td><td bgcolor="lightblue">\r
-      <strong>USER-INTERFACE OPTIONS AND WINDOW CONTROL</strong>\r
-    </td><td>\r
-      \r
-  </td></tr><tr><td>\r
-      -moveHistoryUP true (*)\r
-      <br>\r
-      -moveHistoryX 0 (*)\r
-      <br>\r
-      -moveHistoryY 0 (*)\r
-      <br>\r
-      -moveHistoryW 0 (*)\r
-      <br>\r
-      -moveHistoryH 0 (*)\r
-    </td><td>\r
-      controls opening, placement and size of a window containing the moves of the current game\r
-    </td><td>\r
-      Mode -> Show Move History (x)\r
-  </td></tr><tr><td>\r
-      -evalGraphUp true (*)\r
-      <br>\r
-      -evalGraphX 0 (*)\r
-      <br>\r
-      -evalGraphY 0 (*)\r
-      <br>\r
-      -evalGraphW 0 (*)\r
-      <br>\r
-      -evalGraphH 0 (*)\r
-    </td><td>\r
-      controls opening, placement and size of a window containing a graph of the\r
-      evaluation score of the engine(s) as a function of move number of the current game\r
-    </td><td>\r
-      Mode -> Show Evaluation Graph\r
-  </td></tr><tr><td>\r
-      -engineOutputUp true (*)\r
-      <br>\r
-      -engineOutputX 0 (*)\r
-      <br>\r
-      -engineOutputY 0 (*)\r
-      <br>\r
-      -engineOutputW 0 (*)\r
-      <br>\r
-      -engineOutputH 0 (*)\r
-    </td><td>\r
-      controls opening, placement and size of a window containing the thinking output of the engine(s)\r
-    </td><td>\r
-      Mode -> Show Engine Output (x)\r
-  </td></tr><tr><td>\r
-      -stickyWindows true (*)\r
-    </td><td>\r
-      make the various windows snap onto each other, and stick together\r
-    </td><td>\r
-      -\r
-  </td></tr><tr><td>\r
-      -showEvalInMoveHistory true (*)\r
-    </td><td>\r
-      depth/score info of the engine is included as comments in the move history window\r
-    </td><td>\r
-      Options -> General...\r
-  </td></tr><tr><td>\r
-      -evalHistColorWhite #FFFFB0 (*)\r
-      <br>\r
-      -evalHistColorBlack #AD5D3D (*)\r
-    </td><td>\r
-      determines the color of the eval-score comments in the move-history window\r
-    </td><td>\r
-      -\r
-  </td></tr><tr><td>\r
-      -autoDisplayComment true (*)\r
-    </td><td>\r
-      causes a window for displaying PGN comments to pop up automatically when such a comment is encountered\r
-    </td><td>\r
-      -\r
-  </td></tr><tr><td>\r
-      -autoDisplayTags true (*)\r
-    </td><td>\r
-      causes a window with PGN tags to be displayed as soon as a PGN file is loaded\r
-    </td><td>\r
-      -\r
-  </td></tr><tr><td>\r
-      -gameListTags "eprd" (*)\r
-    </td><td>\r
-      specifies the PGN tags that should be displayed in the game list\r
-    </td><td>\r
-      Options -> Game List...\r
-  </td></tr><tr><td>\r
-      \r
-    </td><td bgcolor="lightblue">\r
-      <strong>MISCELLANEOUS</strong>\r
-    </td><td>\r
-      \r
-  </td></tr><tr><td>\r
-      -debugFile "winboard.debug"\r
-      <br>\r
-      -nameOfDebugFile "winboard.debug"\r
-    </td><td>\r
-      allows you to specify an alternative name for saving the debug information\r
-    </td><td>\r
-      -\r
-  </td></tr><tr><td>\r
-      -\r
-    </td><td>\r
-      save chess-board display as diagram in bitmap file\r
-      (only works for the smaller board formats!)\r
-    </td><td>\r
-      File -> Save Diagram...\r
-  </td></tr><tr><td>\r
-      -\r
-    </td><td>\r
-      display only those lines in the game list that contain a given string\r
-    </td><td>\r
-      in Game-List window\r
-  </td></tr><tr><td>\r
-      -rewindFile 0 (x)\r
-    </td><td>\r
-      A nonzero value for this option causes the loadGameIndex or loadPositionIndex\r
-      to rewind to the beginning of the Games or Position file when it reaches\r
-      the given value in auto-increment match mode. \r
-      This mode is specified by a negative value as argument of the /lgi or /lpi options,\r
-      where -1 increments the index after every game of the match,\r
-      and -2 after every two games (so that each position is played with black and white).\r
-    </td><td>\r
-      -\r
-</td></tr></table>\r
-<p>\r
-The value with which the option is listed is the default value.\r
-If it is false or true, it is a Boolean option, a number implies an integer option.\r
-A value starting with # indicates an RGB color indication in hexadecimal notation.\r
-Options the settings of which are saved into the winboard.ini file are marked with (*).\r
-</p>\r
-</body>\r