manual/html_node/Load-and-Save-options.html

   1 <html lang="en">
   2 <head>
   3 <title>Load and Save 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="ICS-options.html#ICS-options" title="ICS options">
  10 <link rel="next" href="User-interface-options.html#User-interface-options" title="User interface options">
  11 <link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
  12 <meta http-equiv="Content-Style-Type" content="text/css">
  13 <style type="text/css"><!--
  14   pre.display { font-family:inherit }
  15   pre.format  { font-family:inherit }
  16   pre.smalldisplay { font-family:inherit; font-size:smaller }
  17   pre.smallformat  { font-family:inherit; font-size:smaller }
  18   pre.smallexample { font-size:smaller }
  19   pre.smalllisp    { font-size:smaller }
  20   span.sc    { font-variant:small-caps }
  21   span.roman { font-family:serif; font-weight:normal; }
  22   span.sansserif { font-family:sans-serif; font-weight:normal; }
  23 --></style>
  24 </head>
  25 <body>
  26 <div class="node">
  27 <a name="Load-and-Save-options"></a>
  28 <p>
  29 Next:&nbsp;<a rel="next" accesskey="n" href="User-interface-options.html#User-interface-options">User interface options</a>,
  30 Previous:&nbsp;<a rel="previous" accesskey="p" href="ICS-options.html#ICS-options">ICS options</a>,
  31 Up:&nbsp;<a rel="up" accesskey="u" href="Options.html#Options">Options</a>
  32 <hr>
  33 </div>
  34
  35 <h3 class="section">4.5 Load and Save options</h3>
  36
  37 <p><a name="index-Options_002c-Load-and-Save-398"></a><a name="index-Load-and-Save-options-399"></a>
  38      <dl>
  39 <dt>-lgf or -loadGameFile file<dt>-lgi or -loadGameIndex index<dd><a name="index-lgf_002c-option-400"></a><a name="index-loadGameFile_002c-option-401"></a><a name="index-lgi_002c-option-402"></a><a name="index-loadGameIndex_002c-option-403"></a>If the <code>loadGameFile</code> option is set, XBoard loads the specified
  40 game file at startup. The file name <samp><span class="file">-</span></samp> specifies the standard
  41 input. If there is more than one game in the file, XBoard
  42 pops up a menu of the available games, with entries based on their PGN
  43 (Portable Game Notation) tags.
  44 If the <code>loadGameIndex</code> option is set to &lsquo;<samp><span class="samp">N</span></samp>&rsquo;, the menu is suppressed
  45 and the N th game found in the file is loaded immediately.
  46 The menu is also suppressed if <code>matchMode</code> is enabled or if the game file
  47 is a pipe; in these cases the first game in the file is loaded immediately.
  48 Use the <samp><span class="file">pxboard</span></samp> shell script provided with XBoard if you
  49 want to pipe in files containing multiple games and still see the menu.
  50 If the loadGameIndex specifies an index -1, this triggers auto-increment
  51 of the index in <code>matchMode</code>, which means that after every game the
  52 index is incremented by one, causing each game of the match to be played
  53 from the next game in the file. Similarly, specifying an index value of -2
  54 causes the index to be incremented every two games, so that each game
  55 in the file is used twice (with reversed colors).
  56 The <code>rewindIndex</code> option causes the index to be reset to the
  57 first game of the file when it has reached a specified value.
  58 <br><dt>-rewindIndex n<dd>Causes a position file or game file to be rewound to its beginning after n
  59 positions or games in auto-increment <code>matchMode</code>.
  60 See <code>loadPositionIndex</code> and <code>loadGameIndex</code>.
  61 default: 0 (no rewind).
  62 <br><dt>-td or -timeDelay seconds<dd><a name="index-td_002c-option-404"></a><a name="index-timeDelay_002c-option-405"></a>Time delay between moves during &lsquo;<samp><span class="samp">Load Game</span></samp>&rsquo; or &lsquo;<samp><span class="samp">Analyze File</span></samp>&rsquo;.
  63 Fractional seconds are allowed; try &lsquo;<samp><span class="samp">-td 0.4</span></samp>&rsquo;.
  64 A time delay value of -1 tells
  65 XBoard not to step through game files automatically. Default: 1 second.
  66 <br><dt>-sgf or -saveGameFile file<dd><a name="index-sgf_002c-option-406"></a><a name="index-saveGameFile_002c-option-407"></a>If this option is set, XBoard appends a record of every game
  67 played to the specified file. The file name <samp><span class="file">-</span></samp> specifies the
  68 standard output.
  69 <br><dt>-autosave/-xautosave or -autoSaveGames true/false<dd><a name="index-autosave_002c-option-408"></a><a name="index-autoSaveGames_002c-option-409"></a>Sets the Auto Save menu option.  See <a href="Options-Menu.html#Options-Menu">Options Menu</a>.  Default: false.
  70 Ignored if <code>saveGameFile</code> is set.
  71 <br><dt>-onlyOwnGames true/false<dd><a name="index-onlyOwnGames_002c-option-410"></a>Suppresses auto-saving of ICS observed games. Default: false.
  72 <br><dt>-lpf or -loadPositionFile file<dt>-lpi or -loadPositionIndex index<dd><a name="index-lpf_002c-option-411"></a><a name="index-loadPositionFile_002c-option-412"></a><a name="index-lpi_002c-option-413"></a><a name="index-loadPositionIndex_002c-option-414"></a>If the <code>loadPositionFile</code> option is set, XBoard loads the
  73 specified position file at startup. The file name <samp><span class="file">-</span></samp> specifies the
  74 standard input. If the <code>loadPositionIndex</code> option is set to N,
  75 the Nth position found in the file is loaded; otherwise the
  76 first position is loaded.
  77 If the loadPositionIndex specifies an index -1, this triggers auto-increment
  78 of the index in <code>matchMode</code>, which means that after every game the
  79 index is incremented by one, causing each game of the match to be played
  80 from the next position in the file. Similarly, specifying an index value of -2
  81 causes the index to be incremented every two games, so that each position
  82 in the file is used twice (with the engines playing opposite colors).
  83 The <code>rewindIndex</code> option causes the index to be reset to the
  84 first position of the file when it has reached a specified value.
  85 <br><dt>-spf or -savePositionFile file<dd><a name="index-spf_002c-option-415"></a><a name="index-savePositionFile_002c-option-416"></a>If this option is set, XBoard appends the final position reached
  86 in every game played to the specified file. The file name <samp><span class="file">-</span></samp>
  87 specifies the standard output.
  88 <br><dt>-pgnExtendedInfo true/false<dd><a name="index-pgnExtendedInfo_002c-option-417"></a>If this option is set, XBoard saves depth, score and time used for each
  89 move that the engine found as a comment in the PGN file.
  90 Default: false.
  91 <br><dt>-pgnEventHeader string<dd><a name="index-pgnEventHeader_002c-option-418"></a>Sets the name used in the PGN event tag to string.
  92 Default: "Computer Chess Game".
  93 <br><dt>-pgnNumberTag true/false<dd><a name="index-pgnNumberTag_002c-option-419"></a>Include the (unique) sequence number of a tournament game into the saved
  94 PGN file as a 'number' tag.
  95 Default: false.
  96 <br><dt>-saveOutOfBookInfo true/false<dd><a name="index-saveOutOfBookInfo_002c-option-420"></a>Include the information on how the engine(s) game out of its opening book
  97 in a special 'annotator' tag with the PGN file.
  98 Default: true.
  99 <br><dt>-oldsave/-xoldsave or -oldSaveStyle true/false<dd><a name="index-oldsave_002c-option-421"></a><a name="index-oldSaveStyle_002c-option-422"></a>Sets the Old Save Style menu option.  See <a href="Options-Menu.html#Options-Menu">Options Menu</a>.  Default: false.
 100 <br><dt>-gameListTags string<dd><a name="index-gameListTags_002c-option-423"></a>The character string lists the PGN tags that should be printed in the
 101 Game List, and their order. The meaning of the codes is e=event,
 102 s=site, d=date, o=round, p=players, r=result, w=white Elo, b=black Elo,
 103 t=time control, v=variant, a=out-of-book info, c=result comment.
 104 Default: "eprd"
 105 <br><dt>-ini or -settingsFile filename<dt>-saveSettingsFile filename<dt>@filename<dd><a name="index-saveSettingsFile_002c-option-424"></a><a name="index-SettingsFile_002c-option-425"></a><a name="index-init_002c-option-426"></a><a name="index-at-sign_002c-option-427"></a>When XBoard encounters an option -settingsFile (or -ini for short),
 106 or @filename, it tries to read the mentioned file,
 107 and substitutes the contents of it (presumaby more command-line options)
 108 in place of the option.
 109 In the case of -ini or -settingsFile, the name of a successfully read
 110 settings file is also remembered as the file to use for saving settings
 111 (automatically on exit, or on user command).
 112 An option of the form @filename does not affect saving.
 113 The option -saveSettingsFile does specify a name of the file to use
 114 for saving, without reading any options from it, and is thus also effective
 115 when the file did not exist yet.
 116 So the settings will be saved to the file specified in the last
 117 -saveSettingsFile or succesfull -settingsFile / -ini command,
 118 if any, and in /etc/xboard/xboard.conf otherwise.
 119 Usualy the latter is only accessible for the system administrator, though,
 120 and will be used to contain system-wide default setings, amongst which
 121 a -saveSettingsFile and -settingsFile options to specify a settings file
 122 accessible to the individual user, such as ~/.xboardrc in the user's
 123 home directory.
 124 <br><dt>-saveSettingsOnExit true/false<dd><a name="index-saveSettingsOnExit_002c-option-428"></a>Controls saving of options on the settings file.  See <a href="Options-Menu.html#Options-Menu">Options Menu</a>.
 125 Default: true.
 126 </dl>
 127
 128    </body></html>
 129