Put warning in HTML help
[xboard.git] / winboard / help / html / 15.htm
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">\r
2 <HTML>\r
3 <HEAD>\r
4 <META HTTP-EQUIV="Content-Type" Content="text/html; charset=Windows-1252">\r
5 <TITLE>Load and Save Options</TITLE>\r
6 </HEAD>\r
7 \r
8 <BODY BGCOLOR="#FFFFFF" TEXT="#000000">\r
9 \r
10 \r
11 \r
12 <P><B><A NAME="loadandsaveoptions"></A>Load and Save Options</B></P>\r
13 \r
14 \r
15 \r
16 <P><B><A NAME="lgf"></A>/lgf </B>or<B> <A NAME="loadgamefile"></A>/loadGameFile <I>filename</I><BR>\r
17 <A NAME="lgi"></A>/lgi </B>or<B> <A NAME="loadgameindex"></A>/loadGameIndex <I>N</I></B></P>\r
18 \r
19 <P>If loadGameFile is set, WinBoard reads the specified game file at startup. You can leave out the name of this option and give just the file name, which is handy if you want to configure WinBoard as a game viewer with a browser such as the Windows Explorer or Netscape. The filename is interpreted relative to WinBoard's initial working directory. The filename "-" specifies the standard input. If there is more than one game in the file, WinBoard pops up a menu of the available games, with entries based on their PGN tags. If loadGameIndex is set to <I>N, </I>the menu is suppressed and the <I>N</I>th game found in the file is loaded immediately. \r
20 <font color="#008000">A game index of \961 will load the first game, but step to the next game on each new game in <A HREF="12.htm#matchgames">Match Mode</A>. Similarly, an index of \962 will step to the next game every two games, so that all games are played by each player with both colors.</font></P>\r
21 \r
22 \r
23 \r
24 <P><B><A NAME="td"></A>/td </B>or<B> <A NAME="timedelay"></A>/timeDelay <I>seconds</I></B></P>\r
25 \r
26 <P>Time delay between moves during <A HREF="03.htm#loadgame">Load Game</A>. Fractional seconds are allowed; try 0.4. A time delay value of -1 tells WinBoard not to step through game files automatically. Default: 1 second.</P>\r
27 \r
28 \r
29 \r
30 <P><B><A NAME="sgf"></A>/sgf </B>or<B> <A NAME="savegamefile"></A>/saveGameFile <I>filename</I></B></P>\r
31 \r
32 <P>If this option is set, WinBoard appends a record of every game played to the specified file. The filename is interpreted relative to WinBoard's initial working directory. The filename "-" specifies the standard output.</P>\r
33 \r
34 \r
35 \r
36 <P><B><A NAME="autosave"></A>/autosave</B> or <B>/xautosave</B>,<B> </B>or<B> <A NAME="autosavegames"></A>/autoSaveGames<I> true|false</I></B></P>\r
37 \r
38 <P>If this option is True, at the end of every game WinBoard prompts you for a filename and appends a record of the game to the file you specify. Ignored if saveGameFile is set. Default: False.</P>\r
39 \r
40 \r
41 \r
42 <P><B><A NAME="lpf"></A>/lpf </B>or<B> <A NAME="loadpositionfile"></A>/loadPositionFile <I>filename</I><BR>\r
43 <A NAME="lpi"></A>/lpi </B>or<B> <A NAME="loadpositionindex"></A>/loadPositionIndex <I>N</I></B></P>\r
44 \r
45 <P>If loadPositionFile is set, WinBoard loads the specified position file at startup. The filename is interpreted relative to WinBoard's initial working directory. The filename "-" specifies the standard input. If loadPositionIndex is set to <I>N</I>, the <I>N</I>th position found in the file is loaded; otherwise the first is loaded.\r
46 <font color="#008000">A position index of \961 will load the first position, but step to the next position on each new game in <A HREF="12.htm#matchgames">Match Mode</A>. Similarly, an index of \962 will step to the next position every two games, so that all positions are played by each player with both colors.</font></P>\r
47 \r
48 \r
49 \r
50 <P><B><A NAME="rewindindex"></A><font color="#008000">/rewindIndex <I>number</I></font></B></P>\r
51 \r
52 <P><font color="#008000">When <I>number</I> is non-zero, resets the game or position index used in the /lgf or /lpf options back to 1 after it has reached the value <I>number</I>. Default: 0.</font></P>\r
53 \r
54 \r
55 \r
56 <P><B><A NAME="spf"></A>/spf </B>or<B> <A NAME="savepositionfile"></A>/savePositionFile <I>filename</I></B></P>\r
57 \r
58 <P>If this option is set, WinBoard appends the final position reached in every game played to the specified file. The filename is interpreted relative to WinBoard's initial working directory. The file name "-" specifies the standard output.</P>\r
59 \r
60 \r
61 \r
62 <P><B><A NAME="pgnextendedinfo"></A><font color="#ff0000">/pgnExtendedInfo <I>true|false</I></font></B></P>\r
63 \r
64 <P><font color="#ff0000">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.</font></P>\r
65 \r
66 \r
67 \r
68 <P><B><A NAME="pgneventheader"></A><font color="#ff0000">/pgnEventHeader <I>string</I></font></B></P>\r
69 \r
70 <P><font color="#ff0000">Sets the name used in the PGN event tag to <I>string</I>.</font></P>\r
71 \r
72 \r
73 \r
74 <P><B><A NAME="saveoutofbookinfo"></A><font color="#ff0000">/saveOutOfBookInfo <I>true|false</I></font></B></P>\r
75 \r
76 <P><font color="#ff0000">Include the information on how the engine(s) game out of its opening book in a special \91annotator\92 tag with the PGN file.</font></P>\r
77 \r
78 \r
79 \r
80 <P><B><A NAME="oldsave"></A>/oldsave </B>or <B>/xoldsave</B>, or<B> <A NAME="oldsavestyle"></A>/oldSaveStyle<I> true|false</I></B></P>\r
81 \r
82 <P>If this option is False (the default), WinBoard saves games in PGN (portable game notation) and positions in FEN (Forsythe-Edwards notation). If the option is True, a save style that is compatible with older versions of WinBoard (and of xboard) is used instead.</P>\r
83 \r
84 \r
85 \r
86 <P><B><A NAME="debug"></A>/debug</B> or <B>/xdebug</B>,<B> </B>or<B> <A NAME="debugmode"></A>/debugMode<I> true|false</I></B></P>\r
87 \r
88 <P>Writes debugging information to the file \93WinBoard.debug\94, including all commands sent to the chess engine, all output received from it, and all commands sent to ICS. You can press Ctrl+Alt+F12 to turn this option on or off while WinBoard is running. Each time you turn it on, any existing debug file is overwritten.</P>\r
89 \r
90 \r
91 \r
92 <P><B><A NAME="debugfile"></A><font color="#ff0000">/debugFile<SUP> </SUP> <I>filename</I> </B>or<B> <A NAME="nameofdebugfile"></A>/nameOfDebugFile<I> filename</I></B></font></P>\r
93 \r
94 <P><font color="#ff0000">Sets the name of the file to which WinBoard saves debug information (including all communication to and from the engines).</font></P>\r
95 \r
96 \r
97 \r
98 <P><B><A NAME="enginedebugoutput"></A><font color="#008000">/engineDebugOutput<SUP> </SUP> <I>number</I></font></B></P>\r
99 \r
100 <P><font color="#008000">Specifies how WinBoard should handle unsollicited output from the engine, with respect to saving it in the debug file. The output is further (hopefully) ignored. If <I>number</I>=0, WinBoard refrains from writing such spurious output to the debug file. If<I> number</I>=1, all engine output is written faithfully to the debug file. If <I> number</I>=2, any protocol-violating line is prefixed with a \91#\92 character, as the engine itself should have done if it wanted to submit info for inclusion in the debug file.</font></font></P>\r
101 \r
102 <P><font color="#008000">This option is provided for the benefit of applications that use the debug file as a source of information, such as the broadcaster of live games TLCV / TLCS. Such applications can be protected from spurious engine output that might otherwise confuse them.<font color="#FF00FF">The case <I>number</I>=3 is similar, but now marks non-compliant engine output with a more conspicuous prefix.</font></P>\r
103 \r
104 </BODY>\r
105 </HTML>\r