c0286904a386a1872d75f17b57f44c260c1b9ef9
[xboard.git] / manual / html_node / Edit-Menu.html
1 <html lang="en">
2 <head>
3 <title>Edit Menu - 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="Menus.html#Menus" title="Menus">
9 <link rel="prev" href="File-Menu.html#File-Menu" title="File Menu">
10 <link rel="next" href="View-Menu.html#View-Menu" title="View Menu">
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="Edit-Menu"></a>
28 <p>
29 Next:&nbsp;<a rel="next" accesskey="n" href="View-Menu.html#View-Menu">View Menu</a>,
30 Previous:&nbsp;<a rel="previous" accesskey="p" href="File-Menu.html#File-Menu">File Menu</a>,
31 Up:&nbsp;<a rel="up" accesskey="u" href="Menus.html#Menus">Menus</a>
32 <hr>
33 </div>
34
35 <h3 class="section">3.2 Edit Menu</h3>
36
37 <p><a name="index-Menu_002c-Edit-19"></a><a name="index-Edit-Menu-20"></a>
38      <dl>
39 <dt>Copy Game<dd><a name="index-Copy-Game_002c-Menu-Item-21"></a>Copies a record of the current game to an internal clipboard in PGN
40 format and sets the X selection to the game text. The <kbd>Ctrl-C</kbd>
41 key is a keyboard equivalent. The game can be
42 pasted to another application (such as a text editor or another copy
43 of XBoard) using that application's paste command.  In many X
44 applications, such as xterm and emacs, the middle mouse button can be
45 used for pasting; in XBoard, you must use the Paste Game command. 
46 <br><dt>Copy Position<dd><a name="index-Copy-Position_002c-Menu-Item-22"></a>Copies the current position to an internal clipboard in FEN format and
47 sets the X selection to the position text. The shifted <kbd>Ctrl-C</kbd> key
48 is a keyboard equivalent.  The position can be pasted
49 to another application (such as a text editor or another copy of
50 XBoard) using that application's paste command.  In many X
51 applications, such as xterm and emacs, the middle mouse button can be
52 used for pasting; in XBoard, you must use the Paste Position command. 
53 <br><dt>Copy Game List<dd><a name="index-Copy-Game-List_002c-Menu-Item-23"></a>Copies the current game list to the clipboard,
54 and sets the X selection to this text. 
55 A format of comma-separated double-quoted strings is used,
56 including all tags,
57 so it can be easily imported into spread-sheet programs. 
58 <br><dt>Paste Game<dd><a name="index-Paste-Game_002c-Menu-Item-24"></a>Interprets the current X selection as a game record and loads it, as
59 with Load Game. The <kbd>Ctrl-V</kbd> key is a keyboard equivalent. 
60 <br><dt>Paste Position<dd><a name="index-Paste-Position_002c-Menu-Item-25"></a>Interprets the current X selection as a FEN position and loads it, as
61 with Load Position. The shifted <kbd>Ctrl-V</kbd> key is a keyboard equivalent. 
62 <br><dt>Edit Game<dd><a name="index-Edit-Game_002c-Menu-Item-26"></a>Allows you to make moves for both Black and White, and to change
63 moves after backing up with the &lsquo;<samp><span class="samp">Backward</span></samp>&rsquo; command. The clocks do
64 not run. The <kbd>Ctrl-E</kbd> key is a keyboard equivalent.
65
66      <p>In chess engine mode, the chess engine continues to check moves for legality
67 but does not participate in the game. You can bring the chess engine
68 into the game by selecting &lsquo;<samp><span class="samp">Machine White</span></samp>&rsquo;, &lsquo;<samp><span class="samp">Machine Black</span></samp>&rsquo;,
69 or &lsquo;<samp><span class="samp">Two Machines</span></samp>&rsquo;.
70
71      <p>In ICS mode, the moves are not sent to the ICS: &lsquo;<samp><span class="samp">Edit Game</span></samp>&rsquo; takes
72 XBoard out of ICS Client mode and lets you edit games locally. 
73 If you want to edit games on ICS in a way that other ICS users
74 can see, use the ICS <kbd>examine</kbd> command or start an ICS match
75 against yourself. 
76 <br><dt>Edit Position<dd><a name="index-Edit-Position_002c-Menu-Item-27"></a>Lets you set up an arbitrary board position. 
77 The shifted <kbd>Ctrl-E</kbd> key is a keyboard equivalent. 
78 Use mouse button 1 to drag pieces to new squares, or to delete a piece
79 by dragging it off the board or dragging an empty square on top of it. 
80 To drop a new piece on a square, press mouse button 2 or 3 over the
81 square. 
82 This puts a white or black pawn in the square, respectively,
83 but you can change that to any other piece type by dragging the
84 mouse down before you release the button. 
85 You will then see the piece on the originally clicked square
86 cycle through the available pieces
87 (including those of opposite color),
88 and can release the button when you see the piece you want. 
89 To alter the side to move, you can click the clock
90 (the words White and Black above the board)
91 of the side you want to give the move to. 
92 To clear the board you can click the clock of the side that
93 alread has the move (which is highlighted in black). 
94 The old behavior with a piece menu can still be configured
95 with the aid of the <code>pieceMenu</code> option. 
96 Selecting &lsquo;<samp><span class="samp">Edit Position</span></samp>&rsquo; causes XBoard to discard
97 all remembered moves in the current game.
98
99      <p>In ICS mode, changes made to the position by &lsquo;<samp><span class="samp">Edit Position</span></samp>&rsquo; are
100 not sent to the ICS: &lsquo;<samp><span class="samp">Edit Position</span></samp>&rsquo; takes XBoard out of
101 &lsquo;<samp><span class="samp">ICS Client</span></samp>&rsquo; mode and lets you edit positions locally. If you want to
102 edit positions on ICS in a way that other ICS users can see, use
103 the ICS <kbd>examine</kbd> command, or start an ICS match against yourself. 
104 (See also the ICS Client topic above.) 
105 <br><dt>Edit Tags<dd><a name="index-Edit-Tags_002c-Menu-Item-28"></a>Lets you edit the PGN (portable game notation)
106 tags for the current game. After editing, the tags must still conform to
107 the PGN tag syntax:
108
109      <pre class="example">          &lt;tag-section&gt; ::= &lt;tag-pair&gt; &lt;tag-section&gt;
110                                   &lt;empty&gt;
111           &lt;tag-pair&gt; ::= [ &lt;tag-name&gt; &lt;tag-value&gt; ]
112           &lt;tag-name&gt; ::= &lt;identifier&gt;
113           &lt;tag-value&gt; ::= &lt;string&gt;
114 </pre>
115      <p class="noindent">See the PGN Standard for full details. Here is an example:
116
117      <pre class="example">          [Event "Portoroz Interzonal"]
118           [Site "Portoroz, Yugoslavia"]
119           [Date "1958.08.16"]
120           [Round "8"]
121           [White "Robert J. Fischer"]
122           [Black "Bent Larsen"]
123           [Result "1-0"]
124 </pre>
125      <p class="noindent">Any characters that do not match this syntax are silently ignored. Note that
126 the PGN standard requires all games to have at least the seven tags shown
127 above. Any that you omit will be filled in by XBoard
128 with &lsquo;<samp><span class="samp">?</span></samp>&rsquo; (unknown value), or &lsquo;<samp><span class="samp">-</span></samp>&rsquo; (inapplicable value). 
129 <br><dt>Edit Comment<dd><a name="index-Edit-Comment_002c-Menu-Item-29"></a>Adds or modifies a comment on the current position. Comments are
130 saved by &lsquo;<samp><span class="samp">Save Game</span></samp>&rsquo; and are displayed by &lsquo;<samp><span class="samp">Load Game</span></samp>&rsquo;,
131 &lsquo;<samp><span class="samp">Forward</span></samp>&rsquo;, and &lsquo;<samp><span class="samp">Backward</span></samp>&rsquo;. 
132 <br><dt>Edit Book<dd><a name="index-Edit-Book_002c-Menu-Item-30"></a>Pops up a window listing the moves available in the GUI book
133 (specified in the &lsquo;<samp><span class="samp">Common Engine Settings</span></samp>&rsquo; dialog)
134 from the currently displayed position,
135 together with their weights and (optionally in braces) learn info. 
136 You can then edit this list, and the new list will be stored
137 back into the book when you press OK. 
138 Note that the listed percentages are neither used, nor updated when
139 you change the weights; they are just there as an optical aid. 
140 <br><dt>Revert<dt>Annotate<dd><a name="index-Revert_002c-Menu-Item-31"></a><a name="index-Annotate_002c-Menu-Item-32"></a>If you are examining an ICS game and Pause mode is off,
141 Revert issues the ICS command &lsquo;<samp><span class="samp">revert</span></samp>&rsquo;. 
142 In local mode, when you were editing or analyzing a game,
143 and the <code>-variations</code> command-line option is switched on,
144 you can start a new variation by holding the Shift key down while
145 entering a move not at the end of the game. 
146 Variations can also become the currently displayed line by
147 clicking a PGN variation displayed in the Comment window. 
148 This can be applied recursively,
149 so that you can analyze variations on variations;
150 each time you create a new variation by entering an alternative move
151 with Shift pressed, or select a new one from the Comment window,
152 the current variation will be shelved. 
153 &lsquo;<samp><span class="samp">Revert</span></samp>&rsquo; allows you to return to the most recently shelved variation. 
154 The difference between &lsquo;<samp><span class="samp">Revert</span></samp>&rsquo; and &lsquo;<samp><span class="samp">Annotate</span></samp>&rsquo;
155 is that with the latter,
156 the variation you are now abandoning will be added as a comment
157 (in PGN variation syntax, i.e. between parentheses)
158 to the original move where you deviated, for later recalling. 
159 The <kbd>Home</kbd> key is a keyboard equivalent to &lsquo;<samp><span class="samp">Revert</span></samp>&rsquo;. 
160 <br><dt>Truncate Game<dd><a name="index-Truncate-Game_002c-Menu-Item-33"></a>Discards all remembered moves of the game beyond the current
161 position. Puts XBoard into &lsquo;<samp><span class="samp">Edit Game</span></samp>&rsquo; mode if it was not there
162 already. 
163 The <kbd>End</kbd> key is a keyboard equivalent. 
164 <br><dt>Backward<dd><a name="index-Backward_002c-Menu-Item-34"></a><a name="index-g_t_003c_002c-Button-35"></a>Steps backward through a series of remembered moves. 
165 The &lsquo;<samp><span class="samp">[&lt;]</span></samp>&rsquo; button and the <kbd>Alt+LeftArrow</kbd> key are equivalents,
166 as is turning the mouse wheel towards you. 
167 In addition, pressing the Control key steps back one move, and releasing
168 it steps forward again.
169
170      <p>In most modes, &lsquo;<samp><span class="samp">Backward</span></samp>&rsquo; only lets you look back at old positions;
171 it does not retract moves. This is the case if you are playing against
172 a chess engine, playing or observing a game on an ICS, or loading a game. 
173 If you select &lsquo;<samp><span class="samp">Backward</span></samp>&rsquo; in any of these situations, you will not
174 be allowed to make a different move. Use &lsquo;<samp><span class="samp">Retract Move</span></samp>&rsquo; or
175 &lsquo;<samp><span class="samp">Edit Game</span></samp>&rsquo; if you want to change past moves.
176
177      <p>If you are examining an ICS game, the behavior of &lsquo;<samp><span class="samp">Backward</span></samp>&rsquo;
178 depends on whether XBoard is in Pause mode. If Pause mode is
179 off, &lsquo;<samp><span class="samp">Backward</span></samp>&rsquo; issues the ICS backward command, which backs up
180 everyone's view of the game and allows you to make a different
181 move. If Pause mode is on, &lsquo;<samp><span class="samp">Backward</span></samp>&rsquo; only backs up your local
182 view. 
183 <br><dt>Forward<dd><a name="index-Forward_002c-Menu-Item-36"></a><a name="index-g_t_003e_002c-Button-37"></a>Steps forward through a series of remembered moves (undoing the
184 effect of &lsquo;<samp><span class="samp">Backward</span></samp>&rsquo;) or forward through a game file. The
185 &lsquo;<samp><span class="samp">[&gt;]</span></samp>&rsquo; button and the <kbd>Alt+RightArrow</kbd> key are equivalents,
186 as is turning the mouse wheel away from you.
187
188      <p>If you are examining an ICS game, the behavior of Forward
189 depends on whether XBoard is in Pause mode. If Pause mode is
190 off, &lsquo;<samp><span class="samp">Forward</span></samp>&rsquo; issues the ICS forward command, which moves
191 everyone's view of the game forward along the current line. If
192 Pause mode is on, &lsquo;<samp><span class="samp">Forward</span></samp>&rsquo; only moves your local view forward,
193 and it will not go past the position that the game was in when
194 you paused. 
195 <br><dt>Back to Start<dd><a name="index-Back-to-Start_002c-Menu-Item-38"></a><a name="index-g_t_003c_003c_002c-Button-39"></a>Jumps backward to the first remembered position in the game. 
196 The &lsquo;<samp><span class="samp">[&lt;&lt;]</span></samp>&rsquo; button and the <kbd>Alt+Home</kbd> key are equivalents.
197
198      <p>In most modes, Back to Start only lets you look back at old
199 positions; it does not retract moves. This is the case if you
200 are playing against a local chess engine, playing or observing a game on
201 a chess server, or loading a game. If you select &lsquo;<samp><span class="samp">Back to Start</span></samp>&rsquo; in any
202 of these situations, you will not be allowed to make different
203 moves. Use &lsquo;<samp><span class="samp">Retract Move</span></samp>&rsquo; or &lsquo;<samp><span class="samp">Edit Game</span></samp>&rsquo; if you want to change past
204 moves; or use Reset to start a new game.
205
206      <p>If you are examining an ICS game, the behavior of &lsquo;<samp><span class="samp">Back to
207 Start</span></samp>&rsquo; depends on whether XBoard is in Pause mode. If Pause mode
208 is off, &lsquo;<samp><span class="samp">Back to Start</span></samp>&rsquo; issues the ICS &lsquo;<samp><span class="samp">backward 999999</span></samp>&rsquo;
209 command, which backs up everyone's view of the game to the start and
210 allows you to make different moves. If Pause mode is on, &lsquo;<samp><span class="samp">Back
211 to Start</span></samp>&rsquo; only backs up your local view. 
212 <br><dt>Forward to End<dd><a name="index-Forward-to-End_002c-Menu-Item-40"></a><a name="index-g_t_003e_003e_002c-Button-41"></a>Jumps forward to the last remembered position in the game. The
213 &lsquo;<samp><span class="samp">[&gt;&gt;]</span></samp>&rsquo; button and the <kbd>Alt+End</kbd> key are equivalents.
214
215      <p>If you are examining an ICS game, the behavior of &lsquo;<samp><span class="samp">Forward to
216 End</span></samp>&rsquo; depends on whether XBoard is in Pause mode. If Pause mode
217 is off, &lsquo;<samp><span class="samp">Forward to End</span></samp>&rsquo; issues the ICS &lsquo;<samp><span class="samp">forward 999999</span></samp>&rsquo;
218 command, which moves everyone's view of the game forward to the end of
219 the current line. If Pause mode is on, &lsquo;<samp><span class="samp">Forward to End</span></samp>&rsquo; only moves
220 your local view forward, and it will not go past the position
221 that the game was in when you paused. 
222 </dl>
223
224    </body></html>
225