[doc] misc. fix & improvements
[scilab.git] / scilab / modules / console / help / en_US / console.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!--
3  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
4  * Copyright (C) 2008 - DIGITEO - Allan CORNET
5  * Copyright (C) 2012 - 2016 - Scilab Enterprises
6  * Copyright (C) 2018 - Samuel GOUGEON
7  *
8  * This file is hereby licensed under the terms of the GNU GPL v2.0,
9  * pursuant to article 5.3.4 of the CeCILL v.2.1.
10  * This file was originally licensed under the terms of the CeCILL v2.1,
11  * and continues to be available under such terms.
12  * For more information, see the COPYING file which you should have received
13  * along with this program.
14  *
15  -->
16 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"
17           xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns4="http://www.w3.org/1999/xhtml"
18           xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook"
19           xmlns:scilab="http://www.scilab.org"
20           xml:id="console" xml:lang="en">
21     <refnamediv xml:id="shortcuts"></refnamediv>
22     <refnamediv>
23         <refname>console</refname>
24         <refpurpose>Keyboard shortcuts predefined in the console window</refpurpose>
25     </refnamediv>
26     <refsection>
27         <title>Description</title>
28         For the three <literal>STD</literal>, <literal>NW</literal> and <literal>NWNI</literal>
29         Scilab running modes, some keyboard shortcuts are available when the console has the focus.
30         The predefined default ones are listed in the following table. They can be redefined
31         through the Scilab <link linkend="preferences">preferences</link> (General/shortcuts).
32         <para/>
33         <warning>
34             <para>
35             A given key combination may have distinct actions according to the component having the
36             focus: The console, a graphic figure, the history browser, etc.
37             Herebelow, only shortcuts defined for the console's panel are considered.
38             </para>
39         </warning>
40         <para>
41         <informaltable border="1">
42             <tr>
43                 <td><emphasis role="bold">Shortcut</emphasis></td>
44                 <th>STD</th>
45                 <th>NW</th>
46                 <th>NWNI</th>
47                 <td><emphasis role="bold">Action</emphasis></td>
48             </tr>
49             <!-- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -->
50             <tr>
51                 <td colspan="5"><refsect3><title>Main actions</title></refsect3></td>
52             </tr>
53             <tr>
54                 <td>ALT</td>
55                 <td align="center">x</td>
56                 <td align="center"></td>
57                 <td align="center"></td>
58                 <td>Sets / unsets the focus to the console menus. Then arrows or/and underlined
59                 activation keys of menus items allow to browse the menus.
60                 </td>
61             </tr>
62             <tr>
63                 <td>Ctrl+space or TAB</td>
64                 <td align="center">x</td>
65                 <td align="center">x</td>
66                 <td align="center">x</td>
67                 <td>completion : Scilab displays a list of all names that start with
68                     somes characters.
69                     <para/>
70                     <inlinemediaobject>
71                         <imageobject>
72                             <imagedata fileref="../images/completion_listbox.png" />
73                         </imageobject>
74                     </inlinemediaobject>
75                 </td>
76             </tr>
77             <tr>
78                 <td>F1</td>
79                 <td align="center">x</td>
80                 <td align="center">x</td>
81                 <td></td>
82                 <td>opens the help browser or brings it to the foreground</td>
83             </tr>
84             <tr>
85                 <td>F12</td>
86                 <td align="center">x</td>
87                 <td></td>
88                 <td></td>
89                 <td>opens the console box terminal (Windows only)</td>
90             </tr>
91             <tr>
92                 <td>F3 or Ctrl + F</td>
93                 <td align="center">x</td>
94                 <td></td>
95                 <td></td>
96                 <td>Opens the search/Find dialog for the console's content</td>
97             </tr>
98             <tr>
99                 <td>Ctrl + C</td>
100                 <td align="center">x</td>
101                 <td></td>
102                 <td></td>
103                 <td>Copies the selection to the clipboard</td>
104             </tr>
105             <tr>
106                 <td>Ctrl + C</td>
107                 <td align="center">x</td>
108                 <td align="center">x</td>
109                 <td align="center">x</td>
110                 <td>Interrupts a running execution</td>
111             </tr>
112             <tr>
113                 <td>Ctrl + V</td>
114                 <td align="center">x</td>
115                 <td></td>
116                 <td></td>
117                 <td>Inserts the clipboard's content</td>
118             </tr>
119             <tr>
120                 <td>Ctrl + V</td>
121                 <td></td>
122                 <td align="center">x</td>
123                 <td align="center">x</td>
124                 <td>Replaces the line's tail with the clipboard's content</td>
125             </tr>
126             <tr>
127                 <td>Ctrl + X</td>
128                 <td align="center">x</td>
129                 <td align="center">x</td>
130                 <td align="center">x</td>
131                 <td>(Interrupts Scilab)</td>
132             </tr>
133 <!--
134                 <td>Ctrl + F</td><td>Opens the search/Find dialog for the Console content</td>
135                 <td>Ctrl + U</td><td>kills command line from cursor to beginning.</td>
136 -->
137             <!-- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -->
138             <tr>
139                 <td colspan="5"><refsect3><title>History</title></refsect3></td>
140             </tr>
141             <tr>
142                 <td>UP</td>
143                 <td align="center">x</td>
144                 <td align="center">x</td>
145                 <td align="center">x</td>
146                 <td>recalls the previous command line</td>
147             </tr>
148             <tr>
149                 <td>Ctrl + P</td>
150                 <td></td>
151                 <td align="center">x</td>
152                 <td align="center">x</td>
153                 <td>recalls the Previous command line</td>
154             </tr>
155             <tr>
156                 <td>DOWN</td>
157                 <td align="center">x</td>
158                 <td align="center">x</td>
159                 <td align="center">x</td>
160                 <td>recalls the next command line</td>
161             </tr>
162             <tr>
163                 <td>Ctrl + N</td>
164                 <td></td>
165                 <td align="center">x</td>
166                 <td align="center">x</td>
167                 <td>recalls the Next command line</td>
168             </tr>
169             <tr>
170                 <td valign='top'>!abc&lt;enter></td>
171                 <td align="center">x</td>
172                 <td></td>
173                 <td></td>
174                 <td>
175                     recalls the last command line starting with 'abc' ('!' must be the very first
176                     character of the line)
177                 </td>
178             </tr>
179             <!-- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -->
180             <tr>
181                 <td colspan="5"><refsect3><title>Selection</title></refsect3></td>
182             </tr>
183             <tr>
184                 <td>Ctrl + S</td>
185                 <td align="center">x</td>
186                 <td></td>
187                 <td></td>
188                 <td>Selects all the console's content</td>
189             </tr>
190             <tr>
191                 <td>Shift + HOME</td>
192                 <td align="center">x</td>
193                 <td></td>
194                 <td></td>
195                 <td>selects from cursor to the line's head</td>
196             </tr>
197             <tr>
198                 <td>Shift + END</td>
199                 <td align="center">x</td>
200                 <td></td>
201                 <td></td>
202                 <td>selects from cursor to the line's end</td>
203             </tr>
204             <tr>
205                 <td>Double-click</td>
206                 <td align="center">x</td>
207                 <td></td>
208                 <td align="center">x</td>
209                 <td>selects the current word</td>
210             </tr>
211             <!-- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -->
212             <tr>
213                 <td colspan="5"><refsect3><title>Deletion</title></refsect3></td>
214             </tr>
215             <tr>
216                 <td>F2</td>
217                 <td align="center">x</td>
218                 <td align="center">x</td>
219                 <td align="center">x</td>
220                 <td>clears the console, like <link linkend="clc">clc</link></td>
221             </tr>
222             <tr>
223                 <td>Ctrl + D or DELETE</td>
224                 <td align="center">x</td>
225                 <td align="center">x</td>
226                 <td align="center">x</td>
227                 <td>Deletes the current character (or on the right)</td>
228             </tr>
229             <tr>
230                 <td>Ctrl + H or BACKSPACE</td>
231                 <td align="center">x</td>
232                 <td align="center">x</td>
233                 <td align="center">x</td>
234                 <td>deletes the previous character.</td>
235             </tr>
236             <tr>
237                 <td>Ctrl + K</td>
238                 <td align="center">x</td>
239                 <td align="center">x</td>
240                 <td align="center">x</td>
241                 <td>Kills the line's tail, from cursor to the end</td>
242             </tr>
243             <tr>
244                 <td>Ctrl + U</td>
245                 <td align="center">x</td>
246                 <td align="center">x</td>
247                 <td align="center">x</td>
248                 <td>deletes the whole command line</td>
249             </tr>
250             <tr>
251                 <td>Ctrl + W</td>
252                 <td align="center">x</td>
253                 <td></td>
254                 <td></td>
255                 <td>deletes the last space-separated Word of the line.</td>
256             </tr>
257             <tr>
258                 <td>Ctrl + W</td>
259                 <td></td>
260                 <td align="center">x</td>
261                 <td align="center">x</td>
262                 <td>deletes the Word the cursor is on, and the line's tail</td>
263             </tr>
264             <!-- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -->
265             <tr>
266                 <td colspan="5"><refsect3><title>Cursor movements</title></refsect3></td>
267             </tr>
268             <tr>
269                 <td>Ctrl + A or HOME</td>
270                 <td align="center">x</td>
271                 <td align="center">x</td>
272                 <td align="center">x</td>
273                 <td>moves the cursor to the head of current line</td>
274             </tr>
275             <tr>
276                 <td>Ctrl + B or LEFT</td>
277                 <td align="center">x</td>
278                 <td align="center">x</td>
279                 <td align="center">x</td>
280                 <td>moves the cursor one character Backward, to the left</td>
281             </tr>
282             <tr>
283                 <td>Ctrl + LEFT</td>
284                 <td></td>
285                 <td align="center">x</td>
286                 <td align="center">x</td>
287                 <td>moves the cursor to the beginning of the current or previous word</td>
288             </tr>
289             <!--
290             <tr>
291                 <td>Alt+B</td>
292                 <td>move left one word.</td>
293             </tr>
294             -->
295             <tr>
296                 <td>Ctrl + E or END</td>
297                 <td align="center">x</td>
298                 <td align="center">x</td>
299                 <td align="center">x</td>
300                 <td>moves the cursor to the End of command line</td>
301             </tr>
302             <tr>
303                 <td>Ctrl + F</td>
304                 <td></td>
305                 <td align="center">x</td>
306                 <td align="center">x</td>
307                 <td>moves the cursor one character Forward, to the right</td>
308             </tr>
309             <tr>
310                 <td>RIGHT</td>
311                 <td align="center">x</td>
312                 <td align="center">x</td>
313                 <td align="center">x</td>
314                 <td>moves the cursor one character to the right</td>
315             </tr>
316             <tr>
317                 <td>Ctrl + RIGHT</td> <!-- or alt+F: not on Windows, in none mode -->
318                 <td></td>
319                 <td align="center">x</td>
320                 <td align="center">x</td>
321                 <td>moves the cursor to the next word on the right.</td>
322             </tr>
323         </informaltable>
324         </para>
325     </refsection>
326     <refsection>
327         <title>Examples</title>
328         <programlisting role="example"><![CDATA[
329 jdeff org.scilab.modules.preferences.XConfigManager openPreferences prefs;
330 prefs general/shortcuts;
331    ]]></programlisting>
332         <para>
333             <inlinemediaobject>
334                 <imageobject>
335                     <imagedata fileref="../images/preferences_shortcuts.png" />
336                 </imageobject>
337             </inlinemediaobject>
338         </para>
339     </refsection>
340     <refsection role="see also">
341         <title>See Also</title>
342         <simplelist type="inline">
343             <member>
344                 <link linkend="scinotes_menus_shortcuts">editor shortcuts</link>
345             </member>
346             <member>
347                 <link linkend="preferences">preferences</link>
348             </member>
349             <member>
350                 <link linkend="consolebox">consolebox</link>
351             </member>
352             <member>
353                 <link linkend="completion">completion</link>
354             </member>
355             <member>
356                 <link linkend="browsehistory">history</link>
357             </member>
358             <member>
359                 <link linkend="getscilabmode">getscilabmode</link>
360             </member>
361             <member>
362                 <link linkend="scilab">scilab</link>
363             </member>
364         </simplelist>
365     </refsection>
366 </refentry>