updated documentation
[xboard.git] / manual / html_node / Load-and-Save-options.html
index 28b5095..e3f1abd 100644 (file)
@@ -36,61 +36,68 @@ Up:&nbsp;<a rel="up" accesskey="u" href="Options.html#Options">Options</a>
 
 <p><a name="index-Options_002c-Load-and-Save-256"></a><a name="index-Load-and-Save-options-257"></a>
      <dl>
-<dt>-lgf or -loadGameFile file<dt>-lgi or -loadGameIndex index<dd><a name="index-lgf_002c-option-258"></a><a name="index-loadGameFile_002c-option-259"></a><a name="index-lgi_002c-option-260"></a><a name="index-loadGameIndex_002c-option-261"></a>If the <code>loadGameFile</code> option is set, XBoard loads the specified
-game file at startup. The file name <samp><span class="file">-</span></samp> specifies the standard
-input. If there is more than one game in the file, XBoard
-pops up a menu of the available games, with entries based on their PGN
-(Portable Game Notation) tags. 
-If the <code>loadGameIndex</code> option is set to &lsquo;<samp><span class="samp">N</span></samp>&rsquo;, the menu is suppressed
-and the N th game found in the file is loaded immediately. 
-The menu is also suppressed if <code>matchMode</code> is enabled or if the game file
-is a pipe; in these cases the first game in the file is loaded immediately. 
-Use the <samp><span class="file">pxboard</span></samp> shell script provided with XBoard if you
-want to pipe in files containing multiple games and still see the menu. 
-If the loadGameIndex specifies an index -1, this triggers auto-increment
-of the index in <code>matchMode</code>, which means that after every game the
-index is incremented by one, causing each game of the match to be played
-from the next game in the file. Similarly, specifying an index value of -2
-causes the index to be incremented every two games, so that each game
-in the file is used twice (with reversed colors). 
-The <code>rewindIndex</code> option causes the index to be reset to the
-first game of the file when it has reached a specified value. 
-<br><dt>-rewindIndex n<dd>Causes a position file or game file to be rewound to its beginning after n
-positions or games in auto-increment <code>matchMode</code>. 
-See <code>loadPositionIndex</code> and <code>loadGameIndex</code>. 
-default: 0 (no rewind). 
-<br><dt>-td or -timeDelay seconds<dd><a name="index-td_002c-option-262"></a><a name="index-timeDelay_002c-option-263"></a>Time delay between moves during &lsquo;<samp><span class="samp">Load Game</span></samp>&rsquo;. Fractional seconds
-are allowed; try &lsquo;<samp><span class="samp">-td 0.4</span></samp>&rsquo;. A time delay value of -1 tells
-XBoard not to step through game files automatically. Default: 1
-second. 
-<br><dt>-sgf or -saveGameFile file<dd><a name="index-sgf_002c-option-264"></a><a name="index-saveGameFile_002c-option-265"></a>If this option is set, XBoard appends a record of every game
-played to the specified file. The file name <samp><span class="file">-</span></samp> specifies the
-standard output. 
-<br><dt>-autosave/-xautosave or -autoSaveGames true/false<dd><a name="index-autosave_002c-option-266"></a><a name="index-autoSaveGames_002c-option-267"></a>Sets the Auto Save menu option.  See <a href="Options-Menu.html#Options-Menu">Options Menu</a>.  Default: false. 
-Ignored if <code>saveGameFile</code> is set. 
-<br><dt>-lpf or -loadPositionFile file<dt>-lpi or -loadPositionIndex index<dd><a name="index-lpf_002c-option-268"></a><a name="index-loadPositionFile_002c-option-269"></a><a name="index-lpi_002c-option-270"></a><a name="index-loadPositionIndex_002c-option-271"></a>If the <code>loadPositionFile</code> option is set, XBoard loads the
-specified position file at startup. The file name <samp><span class="file">-</span></samp> specifies the
-standard input. If the <code>loadPositionIndex</code> option is set to N,
-the Nth position found in the file is loaded; otherwise the
-first position is loaded. 
-If the loadPositionIndex specifies an index -1, this triggers auto-increment
-of the index in <code>matchMode</code>, which means that after every game the
-index is incremented by one, causing each game of the match to be played
-from the next position in the file. Similarly, specifying an index value of -2
-causes the index to be incremented every two games, so that each position
-in the file is used twice (with the engines playing opposite colors). 
-The <code>rewindIndex</code> option causes the index to be reset to the
-first position of the file when it has reached a specified value. 
-<br><dt>-spf or -savePositionFile file<dd><a name="index-spf_002c-option-272"></a><a name="index-savePositionFile_002c-option-273"></a>If this option is set, XBoard appends the final position reached
-in every game played to the specified file. The file name <samp><span class="file">-</span></samp>
-specifies the standard output. 
-<br><dt>-pgnExtendedInfo true/false<dd><a name="index-pgnExtendedInfo_002c-option_0060-274"></a>If this option is set, WinBoard saves depth, score and time used for each
-move that the engine found as a comment in the PGN file. 
-Default: false. 
-<br><dt>-pgnEventHeader string<dd><a name="index-pgnEventHeader_002c-option_0060-275"></a>Sets the name used in the PGN event tag to string. 
-Default: "Computer Chess Game". 
-<br><dt>-saveOutOfBookInfo true/false<dd><a name="index-saveOutOfBookInfo_002c-option_0060-276"></a>Include the information on how the engine(s) game out of its opening book in a special 'annotator' tag with the PGN file.<br><dt>-oldsave/-xoldsave or -oldSaveStyle true/false<dd><a name="index-oldsave_002c-option-277"></a><a name="index-oldSaveStyle_002c-option-278"></a>Sets the Old Save Style menu option.  See <a href="Options-Menu.html#Options-Menu">Options Menu</a>.  Default: false. 
+<dt>-lgf or -loadGameFile file<dt>-lgi or -loadGameIndex index<dd><a name="index-lgf_002c-option-258"></a><a name="index-loadGameFile_002c-option-259"></a><a name="index-lgi_002c-option-260"></a><a name="index-loadGameIndex_002c-option-261"></a>If the <code>loadGameFile</code> option is set, XBoard loads the specified\r
+game file at startup. The file name <samp><span class="file">-</span></samp> specifies the standard\r
+input. If there is more than one game in the file, XBoard\r
+pops up a menu of the available games, with entries based on their PGN \r
+(Portable Game Notation) tags.\r
+If the <code>loadGameIndex</code> option is set to &lsquo;<samp><span class="samp">N</span></samp>&rsquo;, the menu is suppressed\r
+and the N th game found in the file is loaded immediately.\r
+The menu is also suppressed if <code>matchMode</code> is enabled or if the game file\r
+is a pipe; in these cases the first game in the file is loaded immediately.\r
+Use the <samp><span class="file">pxboard</span></samp> shell script provided with XBoard if you\r
+want to pipe in files containing multiple games and still see the menu.\r
+If the loadGameIndex specifies an index -1, this triggers auto-increment\r
+of the index in <code>matchMode</code>, which means that after every game the\r
+index is incremented by one, causing each game of the match to be played\r
+from the next game in the file. Similarly, specifying an index value of -2\r
+causes the index to be incremented every two games, so that each game\r
+in the file is used twice (with reversed colors).\r
+The <code>rewindIndex</code> option causes the index to be reset to the\r
+first game of the file when it has reached a specified value.\r
+<br><dt>-rewindIndex n<dd>Causes a position file or game file to be rewound to its beginning after n\r
+positions or games in auto-increment <code>matchMode</code>. \r
+See <code>loadPositionIndex</code> and <code>loadGameIndex</code>.\r
+default: 0 (no rewind).\r
+<br><dt>-td or -timeDelay seconds<dd><a name="index-td_002c-option-262"></a><a name="index-timeDelay_002c-option-263"></a>Time delay between moves during &lsquo;<samp><span class="samp">Load Game</span></samp>&rsquo;. Fractional seconds\r
+are allowed; try &lsquo;<samp><span class="samp">-td 0.4</span></samp>&rsquo;. A time delay value of -1 tells\r
+XBoard not to step through game files automatically. Default: 1\r
+second.\r
+<br><dt>-sgf or -saveGameFile file<dd><a name="index-sgf_002c-option-264"></a><a name="index-saveGameFile_002c-option-265"></a>If this option is set, XBoard appends a record of every game\r
+played to the specified file. The file name <samp><span class="file">-</span></samp> specifies the\r
+standard output.\r
+<br><dt>-autosave/-xautosave or -autoSaveGames true/false<dd><a name="index-autosave_002c-option-266"></a><a name="index-autoSaveGames_002c-option-267"></a>Sets the Auto Save menu option.  See <a href="Options-Menu.html#Options-Menu">Options Menu</a>.  Default: false.\r
+Ignored if <code>saveGameFile</code> is set.\r
+<br><dt>-lpf or -loadPositionFile file<dt>-lpi or -loadPositionIndex index<dd><a name="index-lpf_002c-option-268"></a><a name="index-loadPositionFile_002c-option-269"></a><a name="index-lpi_002c-option-270"></a><a name="index-loadPositionIndex_002c-option-271"></a>If the <code>loadPositionFile</code> option is set, XBoard loads the\r
+specified position file at startup. The file name <samp><span class="file">-</span></samp> specifies the\r
+standard input. If the <code>loadPositionIndex</code> option is set to N,\r
+the Nth position found in the file is loaded; otherwise the\r
+first position is loaded.\r
+If the loadPositionIndex specifies an index -1, this triggers auto-increment\r
+of the index in <code>matchMode</code>, which means that after every game the\r
+index is incremented by one, causing each game of the match to be played\r
+from the next position in the file. Similarly, specifying an index value of -2\r
+causes the index to be incremented every two games, so that each position\r
+in the file is used twice (with the engines playing opposite colors).\r
+The <code>rewindIndex</code> option causes the index to be reset to the\r
+first position of the file when it has reached a specified value.\r
+<br><dt>-spf or -savePositionFile file<dd><a name="index-spf_002c-option-272"></a><a name="index-savePositionFile_002c-option-273"></a>If this option is set, XBoard appends the final position reached\r
+in every game played to the specified file. The file name <samp><span class="file">-</span></samp>\r
+specifies the standard output.\r
+<br><dt>-pgnExtendedInfo true/false<dd><a name="index-pgnExtendedInfo_002c-option_0060-274"></a>If this option is set, WinBoard saves depth, score and time used for each \r
+move that the engine found as a comment in the PGN file.\r
+Default: false.\r
+<br><dt>-pgnEventHeader string<dd><a name="index-pgnEventHeader_002c-option_0060-275"></a>Sets the name used in the PGN event tag to string. \r
+Default: "Computer Chess Game".\r
+<br><dt>-saveOutOfBookInfo true/false<dd><a name="index-saveOutOfBookInfo_002c-option_0060-276"></a>Include the information on how the engine(s) game out of its opening book in a special 'annotator' tag with the PGN file.\r
+<br><dt>-oldsave/-xoldsave or -oldSaveStyle true/false<dd><a name="index-oldsave_002c-option-277"></a><a name="index-oldSaveStyle_002c-option-278"></a>Sets the Old Save Style menu option.  See <a href="Options-Menu.html#Options-Menu">Options Menu</a>.  Default: false.\r
+<br><dt>-gameListTags string<dd><a name="index-gameListTags_002c-option-279"></a>The character string lists the PGN tags that should be printed in the\r
+Game List, and their order. The meaning of the codes is e=event,\r
+s=site, d=date, o=round, p=players, r=result, w=white Elo, b=black Elo,\r
+t=time control, v=variant, a=out-of-book info.\r
+Default: "eprd"\r
 </dl>
+   \r
 
    </body></html>