<h3 class="section">3.4 Load and Save options</h3>
-<p><a name="index-Options_002c-Load-and-Save-259"></a><a name="index-Load-and-Save-options-260"></a>
+<p><a name="index-Options_002c-Load-and-Save-286"></a><a name="index-Load-and-Save-options-287"></a>
<dl>
-<dt>-lgf or -loadGameFile file<dt>-lgi or -loadGameIndex index<dd><a name="index-lgf_002c-option-261"></a><a name="index-loadGameFile_002c-option-262"></a><a name="index-lgi_002c-option-263"></a><a name="index-loadGameIndex_002c-option-264"></a>If the <code>loadGameFile</code> option is set, XBoard loads the specified
+<dt>-lgf or -loadGameFile file<dt>-lgi or -loadGameIndex index<dd><a name="index-lgf_002c-option-288"></a><a name="index-loadGameFile_002c-option-289"></a><a name="index-lgi_002c-option-290"></a><a name="index-loadGameIndex_002c-option-291"></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
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-265"></a><a name="index-timeDelay_002c-option-266"></a>Time delay between moves during ‘<samp><span class="samp">Load Game</span></samp>’. Fractional seconds
-are allowed; try ‘<samp><span class="samp">-td 0.4</span></samp>’. 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-267"></a><a name="index-saveGameFile_002c-option-268"></a>If this option is set, XBoard appends a record of every game
+<br><dt>-td or -timeDelay seconds<dd><a name="index-td_002c-option-292"></a><a name="index-timeDelay_002c-option-293"></a>Time delay between moves during ‘<samp><span class="samp">Load Game</span></samp>’ or ‘<samp><span class="samp">Analyze File</span></samp>’.
+Fractional seconds are allowed; try ‘<samp><span class="samp">-td 0.4</span></samp>’.
+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-294"></a><a name="index-saveGameFile_002c-option-295"></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-269"></a><a name="index-autoSaveGames_002c-option-270"></a>Sets the Auto Save menu option. See <a href="Options-Menu.html#Options-Menu">Options Menu</a>. Default: false.
+<br><dt>-autosave/-xautosave or -autoSaveGames true/false<dd><a name="index-autosave_002c-option-296"></a><a name="index-autoSaveGames_002c-option-297"></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-271"></a><a name="index-loadPositionFile_002c-option-272"></a><a name="index-lpi_002c-option-273"></a><a name="index-loadPositionIndex_002c-option-274"></a>If the <code>loadPositionFile</code> option is set, XBoard loads the
+<br><dt>-lpf or -loadPositionFile file<dt>-lpi or -loadPositionIndex index<dd><a name="index-lpf_002c-option-298"></a><a name="index-loadPositionFile_002c-option-299"></a><a name="index-lpi_002c-option-300"></a><a name="index-loadPositionIndex_002c-option-301"></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
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-275"></a><a name="index-savePositionFile_002c-option-276"></a>If this option is set, XBoard appends the final position reached
+<br><dt>-spf or -savePositionFile file<dd><a name="index-spf_002c-option-302"></a><a name="index-savePositionFile_002c-option-303"></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-277"></a>If this option is set, XBoard saves depth, score and time used for each
+<br><dt>-pgnExtendedInfo true/false<dd><a name="index-pgnExtendedInfo_002c-option_0060-304"></a>If this option is set, XBoard 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-278"></a>Sets the name used in the PGN event tag to string.
+<br><dt>-pgnEventHeader string<dd><a name="index-pgnEventHeader_002c-option_0060-305"></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-279"></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-280"></a><a name="index-oldSaveStyle_002c-option-281"></a>Sets the Old Save Style menu option. See <a href="Options-Menu.html#Options-Menu">Options Menu</a>. Default: false.
-<br><dt>-gameListTags string<dd><a name="index-gameListTags_002c-option-282"></a>The character string lists the PGN tags that should be printed in the
+<br><dt>-saveOutOfBookInfo true/false<dd><a name="index-saveOutOfBookInfo_002c-option_0060-306"></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-307"></a><a name="index-oldSaveStyle_002c-option-308"></a>Sets the Old Save Style menu option. See <a href="Options-Menu.html#Options-Menu">Options Menu</a>. Default: false.
+<br><dt>-gameListTags string<dd><a name="index-gameListTags_002c-option-309"></a>The character string lists the PGN tags that should be printed in the
Game List, and their order. The meaning of the codes is e=event,
s=site, d=date, o=round, p=players, r=result, w=white Elo, b=black Elo,
-t=time control, v=variant, a=out-of-book info.
+t=time control, v=variant, a=out-of-book info, c=result comment.
Default: "eprd"
+<br><dt>-ini or -settingsFile filename<dt>-saveSettingsFile filename<dt>@filename<dd><a name="index-saveSettingsFile_002c-option-310"></a><a name="index-SettingsFile_002c-option-311"></a><a name="index-init_002c-option-312"></a><a name="index-at-sign_002c-option-313"></a>When XBoard encounters an option -settingsFile (or -ini for short),
+or @filename, it tries to read the mentioned file,
+and substitutes the contents of it (presumaby more command-line options)
+in place of the option.
+In the case of -ini or -settingsFile, the name of a successfully read
+settings file is also remembered as the file to use for saving settings
+(automatically on exit, or on user command).
+An option of the form @filename does not affect saving.
+The option -saveSettingsFile does specify a name of the file to use
+for saving, without reading any options from it, and is thus also effective
+when the file did not exist yet.
+So the settings will be saved to the file specified in the last
+-saveSettingsFile or succesfull -settingsFile / -ini command,
+if any, and in /etc/xboard/xboard.conf otherwise.
+Usualy the latter is only accessible for the system administrator, though,
+and will be used to contain system-wide default setings, amongst which
+a -saveSettingsFile and -settingsFile options to specify a settings file
+accessible to the individual user, such as ~/.xboardrc in the user's
+home directory.
</dl>
</body></html>
projects / xboard.git / blobdiff