updated manual
[xboard.git] / manual / html_node / File-Menu.html
index 17747b1..425752f 100644 (file)
@@ -3,10 +3,10 @@
 <title>File Menu - XBoard</title>
 <meta http-equiv="Content-Type" content="text/html">
 <meta name="description" content="XBoard">
-<meta name="generator" content="makeinfo 4.12">
+<meta name="generator" content="makeinfo 4.13">
 <link title="Top" rel="start" href="index.html#Top">
 <link rel="up" href="Menus.html#Menus" title="Menus">
-<link rel="next" href="Mode-Menu.html#Mode-Menu" title="Mode Menu">
+<link rel="next" href="Edit-Menu.html#Edit-Menu" title="Edit Menu">
 <link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
 <meta http-equiv="Content-Style-Type" content="text/css">
 <style type="text/css"><!--
 </head>
 <body>
 <div class="node">
-<p>
 <a name="File-Menu"></a>
-Next:&nbsp;<a rel="next" accesskey="n" href="Mode-Menu.html#Mode-Menu">Mode Menu</a>,
+<p>
+Next:&nbsp;<a rel="next" accesskey="n" href="Edit-Menu.html#Edit-Menu">Edit Menu</a>,
 Up:&nbsp;<a rel="up" accesskey="u" href="Menus.html#Menus">Menus</a>
 <hr>
 </div>
 
-<h3 class="section">2.1 File Menu</h3>
+<h3 class="section">3.1 File Menu</h3>
 
-<p><a name="index-File-Menu-4"></a><a name="index-Menu_002c-File-5"></a>
+<p><a name="index-File-Menu-5"></a><a name="index-Menu_002c-File-6"></a>
      <dl>
-<dt>New Game<dd><a name="index-New-Game_002c-Menu-Item-6"></a>Resets XBoard and the chess engine to the beginning of a new chess\r
-game. The <kbd>r</kbd> key is a keyboard equivalent. In Internet Chess\r
-Server mode, clears the current state of XBoard, then\r
-resynchronizes with the ICS by sending a refresh command. If you want to\r
-stop playing, observing, or examining an ICS game, use an\r
-appropriate command from the Action menu, not &lsquo;<samp><span class="samp">New Game</span></samp>&rsquo;.\r
-See <a href="Action-Menu.html#Action-Menu">Action Menu</a>.\r
-<br><dt>New Shuffle Game<dd><a name="index-New-Shuffle-Game_002c-Menu-Item-7"></a>Similar to &lsquo;<samp><span class="samp">New Game</span></samp>&rsquo;, but allows you to specify a particular initial position \r
-(according to a standardized numbering system)\r
-in chess variants which use randomized opening positions (e.g. Chess960).\r
-The selected opening position will persistently be chosen on any following\r
-New Game command until you use this menu to select another. Selecting\r
-position number -1 will produce a newly randomized position on any new game.\r
-Using this menu item in variants that normally do not shuffle their opening position\r
-does cause these variants to become shuffle variants until you use the\r
-&lsquo;<samp><span class="samp">New Shuffle Game</span></samp>&rsquo; menu to explicitly switch the randomization off,\r
-or select a new variant.\r
-<br><dt>New Variant<dd><a name="index-New-variant_002c-Menu-Item-8"></a>Allows you to select a new chess variant in non-ICS mode. \r
-(In ICS play, the ICS is responsible for deciding which variant will be played,\r
-and XBoard adapts autmatically.) If you play with an engine, the engine must\r
-be able to play the selected variant, or the command will be ignored.\r
-XBoard supports all major variants, such as xiangqi, shogi, chess, chess960,\r
-Capablanca Chess, shatranj, crazyhous, bughouse.\r
-<br><dt>Load Game<dd><a name="index-Load-Game_002c-Menu-Item-9"></a>Plays a game from a record file. The <kbd>g</kbd> key is a keyboard equivalent.\r
-A popup dialog prompts you for the file name. If the file contains more\r
-than one game, a second popup dialog\r
-displays a list of games (with information drawn from their PGN tags, if\r
-any), and you can select the one you want. Alternatively, you can load the\r
-Nth game in the file directly, by typing the number <kbd>N</kbd> after the\r
-file name, separated by a space.\r
-\r
-The game file parser will accept PGN (portable game notation),\r
-or in fact almost any file that contains moves in algebraic\r
-notation. \r
-Notation of the form &lsquo;<samp><span class="samp">P@f7</span></samp>&rsquo;\r
-is accepted for piece-drops in bughouse games;\r
-this is a nonstandard extension to PGN.\r
-If the file includes a PGN position (FEN tag), or an old-style\r
-XBoard position diagram bracketed by &lsquo;<samp><span class="samp">[--</span></samp>&rsquo; and &lsquo;<samp><span class="samp">--]</span></samp>&rsquo;\r
-before the first move, the game starts from that position. Text\r
-enclosed in parentheses, square brackets, or curly braces is assumed to\r
-be commentary and is displayed in a pop-up window. Any other\r
-text in the file is ignored. PGN variations (enclosed in\r
-parentheses) are treated as comments; XBoard is not able to walk\r
-variation trees.\r
-The nonstandard PGN tag [Variant "varname"] functions similarly to\r
-the -variant command-line option (see below), allowing games in certain chess\r
-variants to be loaded.  There is also a heuristic to \r
-recognize chess variants from the Event tag, by looking for the strings\r
-that the Internet Chess Servers put there when saving variant ("wild") games.\r
-<br><dt>Load Next Game<dd><a name="index-Load-Next-Game_002c-Menu-Item-10"></a>Loads the next game from the last game record file you loaded.\r
-The shifted <kbd>N</kbd> key is a keyboard equivalent.\r
-<br><dt>Load Previous Game<dd><a name="index-Load-Previous-Game_002c-Menu-Item-11"></a>Loads the previous game from the last game record file you\r
-loaded.  The shifted <kbd>P</kbd> key is a keyboard equivalent.\r
-Not available if the last game was loaded from a pipe.\r
-<br><dt>Reload Same Game<dd><a name="index-Reload-Same-Game_002c-Menu-Item-12"></a>Reloads the last game you loaded.\r
-Not available if the last game was loaded from a pipe.\r
-<br><dt>Save Game<dd><a name="index-Save-Game_002c-Menu-Item-13"></a>Appends a record of the current game to a file.\r
-A popup dialog\r
-prompts you for the file name. If the game did not begin with\r
-the standard starting position, the game file includes the\r
-starting position used. Games are saved in the PGN (portable\r
-game notation) format, unless the oldSaveStyle option is true,\r
-in which case they are saved in an older format that is specific\r
-to XBoard. Both formats are human-readable, and both can be\r
-read back by the &lsquo;<samp><span class="samp">Load Game</span></samp>&rsquo; command.\r
-Notation of the form &lsquo;<samp><span class="samp">P@f7</span></samp>&rsquo;\r
-is accepted for piece-drops in bughouse games;\r
-this is a nonstandard extension to PGN.\r
-<br><dt>Copy Game<dd><a name="index-Copy-Game_002c-Menu-Item-14"></a>Copies a record of the current game to an internal clipboard in PGN\r
-format and sets the X selection to the game text.  The game can be\r
-pasted to another application (such as a text editor or another copy\r
-of XBoard) using that application's paste command.  In many X\r
-applications, such as xterm and emacs, the middle mouse button can be\r
-used for pasting; in XBoard, you must use the Paste Game command.\r
-<br><dt>Paste Game<dd><a name="index-Paste-Game_002c-Menu-Item-15"></a>Interprets the current X selection as a game record and loads it, as\r
-with Load Game.\r
-<br><dt>Load Position<dd><a name="index-Load-Position_002c-Menu-Item-16"></a>Sets up a position from a position file.  A popup dialog prompts\r
-you for the file name. If the file contains more than one saved\r
-position, and you want to load the Nth one, type the number N\r
-after the file name, separated by a space. Position files must\r
-be in FEN (Forsythe-Edwards notation), or in the format that the\r
-Save Position command writes when oldSaveStyle is turned on.\r
-<br><dt>Load Next Position<dd><a name="index-Load-Next-Position_002c-Menu-Item-17"></a>Loads the next position from the last position file you loaded.\r
-<br><dt>Load Previous Position<dd><a name="index-Load-Previous-Position_002c-Menu-Item-18"></a>Loads the previous position from the last position file you\r
-loaded.  Not available if the last position was loaded from a pipe.\r
-<br><dt>Reload Same Position<dd><a name="index-Reload-Same-Position_002c-Menu-Item-19"></a>Reloads the last position you loaded.\r
-Not available if the last position was loaded from a pipe.\r
-<br><dt>Save Position<dd><a name="index-Save-Game_002c-Menu-Item-20"></a>Appends a diagram of the current position to a file.\r
-A popup dialog\r
-prompts you for the file name. Positions are saved in\r
-FEN (Forsythe-Edwards notation) format unless the <code>oldSaveStyle</code>\r
-option is true, in which case they are saved in an older,\r
-human-readable format that is specific to XBoard. Both formats\r
-can be read back by the &lsquo;<samp><span class="samp">Load Position</span></samp>&rsquo; command.\r
-<br><dt>Copy Position<dd><a name="index-Copy-Position_002c-Menu-Item-21"></a>Copies the current position to an internal clipboard in FEN format and\r
-sets the X selection to the position text.  The position can be pasted\r
-to another application (such as a text editor or another copy of\r
-XBoard) using that application's paste command.  In many X\r
-applications, such as xterm and emacs, the middle mouse button can be\r
-used for pasting; in XBoard, you must use the Paste Position command.\r
-<br><dt>Paste Position<dd><a name="index-Paste-Position_002c-Menu-Item-22"></a>Interprets the current X selection as a FEN position and loads it, as\r
-with Load Position.\r
-<br><dt>Mail Move<dt>Reload CMail Message<dd><a name="index-Mail-Move_002c-Menu-Item-23"></a><a name="index-Reload-CMail-Message_002c-Menu-Item-24"></a>See <a href="CMail.html#CMail">CMail</a>.\r
-<br><dt>Exit<dd><a name="index-Exit_002c-Menu-Item-25"></a>Exits from XBoard. The shifted <kbd>Q</kbd> key is a keyboard equivalent.\r
+<dt>New Game<dd><a name="index-New-Game_002c-Menu-Item-7"></a>Resets XBoard and the chess engine to the beginning of a new chess
+game. The <kbd>Ctrl-N</kbd> key is a keyboard equivalent. In Internet Chess
+Server mode, clears the current state of XBoard, then
+resynchronizes with the ICS by sending a refresh command. If you want to
+stop playing, observing, or examining an ICS game, use an
+appropriate command from the Action menu, not &lsquo;<samp><span class="samp">New Game</span></samp>&rsquo;. 
+See <a href="Action-Menu.html#Action-Menu">Action Menu</a>. 
+<br><dt>New Shuffle Game<dd><a name="index-New-Shuffle-Game_002c-Menu-Item-8"></a>Similar to &lsquo;<samp><span class="samp">New Game</span></samp>&rsquo;, but allows you to specify a particular initial position
+(according to a standardized numbering system)
+in chess variants which use randomized opening positions (e.g. Chess960). 
+You can also press the &lsquo;<samp><span class="samp">Pick Fixed</span></samp>&rsquo; button to let XBoard generate
+a random number for you. 
+The thus selected opening position will then persistently be chosen on any following
+New Game command until you use this menu to select another. 
+Selecting position number -1 (or pushing the &lsquo;<samp><span class="samp">Randomize</span></samp>&rsquo; button)
+will produce a newly randomized position on any new game. 
+Using this menu item in variants that normally do not shuffle their opening position
+does cause these variants to become shuffle variants until you use the
+&lsquo;<samp><span class="samp">New Shuffle Game</span></samp>&rsquo; menu to explicitly switch the randomization off,
+or select a new variant. 
+<br><dt>New Variant<dd><a name="index-New-variant_002c-Menu-Item-9"></a>Allows you to select a new chess variant in non-ICS mode. 
+(In ICS play, the ICS is responsible for deciding which variant will be played,
+and XBoard adapts automatically.)  The shifted <kbd>Alt+V</kbd> key is a
+keyboard equivalent. If you play with an engine, the engine must
+be able to play the selected variant, or the command will be ignored. 
+XBoard supports all major variants, such as xiangqi, shogi, chess, chess960,
+Capablanca Chess, shatranj, crazyhouse, bughouse. 
+But not every board size has built-in bitmaps for un-orthodox pieces! 
+Only sizes bulky (72) and middling (49) have all pieces,
+while size petite (33) has most. 
+These sizes would have to be set at startup through the <code>size</code>
+command-line option when you start up XBoard for such variants to be playable.
+
+     <p>You can overrule the default board format of the selected variant,
+(e.g. to play suicide chess on a 6 x 6 board),
+in this dialog, but normally you would not do that,
+and leave them at '-1', which means 'default'. 
+<br><dt>Load Game<dd><a name="index-Load-Game_002c-Menu-Item-10"></a>Plays a game from a record file. The <kbd>Ctrl-O</kbd> key is a keyboard equivalent. 
+A pop-up dialog prompts you for the file name. If the file contains more
+than one game, a second pop-up dialog
+displays a list of games (with information drawn from their PGN tags, if
+any), and you can select the one you want. Alternatively, you can load the
+Nth game in the file directly, by typing the number <kbd>N</kbd> after the
+file name, separated by a space.
+
+     <p>The game file parser will accept PGN (portable game notation),
+or in fact almost any file that contains moves in algebraic
+notation. 
+Notation of the form &lsquo;<samp><span class="samp">P@f7</span></samp>&rsquo;
+is accepted for piece-drops in bughouse games;
+this is a nonstandard extension to PGN. 
+If the file includes a PGN position (FEN tag), or an old-style
+XBoard position diagram bracketed by &lsquo;<samp><span class="samp">[--</span></samp>&rsquo; and &lsquo;<samp><span class="samp">--]</span></samp>&rsquo;
+before the first move, the game starts from that position. Text
+enclosed in parentheses, square brackets, or curly braces is assumed to
+be commentary and is displayed in a pop-up window. Any other
+text in the file is ignored. PGN variations (enclosed in
+parentheses) also are treated as comments;
+however, if you rights-click them in the comment window,
+XBoard will shelve the current line, and load the the selected variation,
+so you can step through it. 
+You can later revert to the previous line with the &lsquo;<samp><span class="samp">Revert</span></samp>&rsquo; command. 
+This way you can walk quite complex varation trees with XBoard. 
+The nonstandard PGN tag [Variant "varname"] functions similarly to
+the -variant command-line option (see below), allowing games in certain chess
+variants to be loaded. 
+Note that it must appear before any FEN tag for XBoard to recognize
+variant FENs appropriately. 
+There is also a heuristic to
+recognize chess variants from the Event tag, by looking for the strings
+that the Internet Chess Servers put there when saving variant ("wild") games. 
+<br><dt>Load Position<dd><a name="index-Load-Position_002c-Menu-Item-11"></a>Sets up a position from a position file.  A pop-up dialog prompts
+you for the file name.  The shifted <kbd>Ctrl-O</kbd> key is a keyboard
+equivalent. If the file contains more than one saved
+position, and you want to load the Nth one, type the number N
+after the file name, separated by a space. Position files must
+be in FEN (Forsythe-Edwards notation), or in the format that the
+Save Position command writes when oldSaveStyle is turned on. 
+<br><dt>Load Next Position<dd><a name="index-Load-Next-Position_002c-Menu-Item-12"></a>Loads the next position from the last position file you loaded. 
+The shifted <kbd>PgDn</kbd> key is a keyboard equivalent. 
+<br><dt>Load Previous Position<dd><a name="index-Load-Previous-Position_002c-Menu-Item-13"></a>Loads the previous position from the last position file you
+loaded. The shifted <kbd>PgUp</kbd> key is a keyboard equivalent. 
+Not available if the last position was loaded from a pipe. 
+<br><dt>Save Game<dd><a name="index-Save-Game_002c-Menu-Item-14"></a>Appends a record of the current game to a file. 
+The <kbd>Ctrl-S</kbd> key is a keyboard equivalent. 
+A pop-up dialog
+prompts you for the file name. If the game did not begin with
+the standard starting position, the game file includes the
+starting position used. Games are saved in the PGN (portable
+game notation) format, unless the oldSaveStyle option is true,
+in which case they are saved in an older format that is specific
+to XBoard. Both formats are human-readable, and both can be
+read back by the &lsquo;<samp><span class="samp">Load Game</span></samp>&rsquo; command. 
+Notation of the form &lsquo;<samp><span class="samp">P@f7</span></samp>&rsquo;
+is accepted for piece-drops in bughouse games;
+this is a nonstandard extension to PGN. 
+<br><dt>Save Position<dd><a name="index-Save-Position_002c-Menu-Item-15"></a>Appends a diagram of the current position to a file. 
+The shifted <kbd>Ctrl+S</kbd> key is a keyboard equivalent. 
+A pop-up dialog prompts you for the file name. Positions are saved in
+FEN (Forsythe-Edwards notation) format unless the <code>oldSaveStyle</code>
+option is true, in which case they are saved in an older,
+human-readable format that is specific to XBoard. Both formats
+can be read back by the &lsquo;<samp><span class="samp">Load Position</span></samp>&rsquo; command. 
+<br><dt>Save Selected Games<dd><a name="index-Save-Selected-Games-16"></a>Will cause all games selected for display in the current Game List
+to be appended to a file of the user's choice. 
+<br><dt>Save Games as Book<dd><a name="index-Save-Games-as-Book_002c-Menu-Item-17"></a>Creates an opening book from the currently loaded game file,
+incorporating only the games currently selected in the Game List. 
+The book will be saved on the file specified in the &lsquo;<samp><span class="samp">Common Engine</span></samp>&rsquo;
+options dialog. 
+The value of &lsquo;<samp><span class="samp">Book Depth</span></samp>&rsquo; specified in that same dialog will
+be used to determine how many moves of each game will be added to
+the internal book buffer. 
+This command can take a long time to process,
+and the size of the buffer is currently limited. 
+At the end the buffer will be saved as a Polyglot book,
+but the buffer will not be cleared,
+so that you can continue adding games from other game files. 
+<br><dt>Mail Move<dt>Reload CMail Message<dd><a name="index-Mail-Move_002c-Menu-Item-18"></a><a name="index-Reload-CMail-Message_002c-Menu-Item-19"></a>See <a href="CMail.html#CMail">CMail</a>. 
+<br><dt>Exit<dd><a name="index-Exit_002c-Menu-Item-20"></a>Exits from XBoard. The <kbd>Ctrl-Q</kbd> key is a keyboard equivalent. 
 </dl>
-   \r
 
    </body></html>