~ubuntu-branches/ubuntu/precise/krusader/precise

« back to all changes in this revision

Viewing changes to doc/basic-functions.docbook

  • Committer: Bazaar Package Importer
  • Author(s): Scott Kitterman
  • Date: 2010-05-05 22:26:37 UTC
  • mfrom: (3.1.4 squeeze)
  • Revision ID: james.westby@ubuntu.com-20100505222637-ydv3cwjwy365on2r
Tags: 1:2.1.0~beta1-1ubuntu1
* Merge from Debian Unstable.  Remaining changes:
  - Retain Kubuntu doc path

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<chapter id="basic-functions">
 
2
  <!-- **********************************************************************
 
3
                            using-krusader.docbook
 
4
                          +++++++++++++++++++++++++++
 
5
  copyright            : (C) 2000 - 2009
 
6
                          Rafi Yanai, Shie Erlich, Frank Schoolmeesters
 
7
                          & the Krusader Krew
 
8
  e-mail               : krusader@users.sourceforge.net
 
9
  web site             : http://www.krusader.org
 
10
  description          : a Krusader Documentation File
 
11
 
 
12
***************************************************************************
 
13
* Permission is granted to copy, distribute and/or modify this            *
 
14
* document under the terms of the GNU Free Documentation License,         *
 
15
* Version 1.1 or any later version published by the Free Software         *
 
16
* Foundation; with no Invariant Sections, no Front-Cover Texts and        *
 
17
* no Back-Cover Texts.  A copy of the license is available on the         *
 
18
* GNU site http://www.gnu.org/licenses/fdl.html or by writing to:         *
 
19
* Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,    *
 
20
* MA 02111-1307, USA.                                                     *
 
21
*********************************************************************** -->
 
22
  <title>Basic Functions</title>
 
23
  <sect1 id="controls">
 
24
    <title>Controls</title>
 
25
    <sect2 id="control-general">
 
26
      <title>General</title>
 
27
      <para>This is a rather short but important section that will
 
28
      go into the details of controlling &krusader;.
 
29
      This section does not try to cover all the various key
 
30
      combinations for two reasons: 
 
31
      <orderedlist numeration="arabic">
 
32
        <listitem>
 
33
          <para>there are just too many of them</para>
 
34
        </listitem>
 
35
        <listitem>
 
36
          <para>most of &krusader; actions are
 
37
          configurable in the
 
38
          <link linkend="konfig-looknfeel">Konfigurator Look &amp; Feel page</link></para>
 
39
        </listitem>
 
40
      </orderedlist>We will only mention the most important
 
41
      keyboard shortcuts with the default configuration, but keep
 
42
      in mind that most of the <link linkend="key_bindings">Key-Bindings</link> are
 
43
      configurable. If you find that you use a certain command a
 
44
      lot and want to know the shortcut for this command, or you
 
45
      want to change this command shortcut, then check out the
 
46
      <link linkend="key_bindings">Key-Bindings</link> tab at the
 
47
      <link linkend="konfig-looknfeel">Konfigurator Look &amp; Feel page</link>.</para>
 
48
    </sect2>
 
49
    <sect2 id="moving-around">
 
50
      <title>Moving Around</title>
 
51
      <para>By Moving Around we mean the transfer of the keyboard
 
52
      and mouse focus between the different parts of the
 
53
      &krusader; 
 
54
      <link linkend="mainwindow">main window</link>. The focus can
 
55
      be in one of five places: the Left or Right Panel, the Menu
 
56
      Bar, the Command Line or the Terminal Emulator. The panel
 
57
      that has the focus is called the Active Panel. An Active
 
58
      Panel will remain active until the other panel receives the
 
59
      focus (&ie;: if the Left Panel was active and you
 
60
      clicked on the Command Line - then the Left Panel remains the
 
61
      Active Panel). You must deliberately change which panel is
 
62
      active.</para>
 
63
      <para>The most common way to transfer the focus to a specific
 
64
      panel is to use the mouse to click on that panel. But you
 
65
      should be aware of the following: 
 
66
      <itemizedlist>
 
67
        <listitem>
 
68
          <para>Clicking on the Toolbar, the FN keys bar or the
 
69
          Status Bar does *not* change the focus.</para>
 
70
        </listitem>
 
71
        <!--
 
72
   Quick View Panel: old Krusader feature , removed since krusader-1.12-beta1      
 
73
   <listitem>
 
74
     <para>The display part of the Quick View Panel does not accept clicks so you should click on the
 
75
           Location Toolbar of this panel if you want it to have focus.</para>
 
76
   </listitem>
 
77
-->
 
78
        <listitem>
 
79
          <para>Pushing the 
 
80
          <guibutton>"History"</guibutton> or the 
 
81
          <guibutton>"Run in Terminal"</guibutton> buttons in the
 
82
          Command Line will not transfer the focus, so you have to
 
83
          click inside the Input Line.</para>
 
84
        </listitem>
 
85
        <listitem>
 
86
          <para>When you choose a menu, the Menu Bar will become
 
87
          focused. It remains focused until you choose a command -
 
88
          the focus returns to the previous owner.</para>
 
89
        </listitem>
 
90
      </itemizedlist></para>
 
91
      <para>There are, of course, ways to use the keyboard to
 
92
      change the focus: 
 
93
      <itemizedlist>
 
94
        <listitem>
 
95
          <para>The &Tab; Key will switch panels, if one
 
96
          of the panels has the focus or rotate between all the
 
97
          commands in a menu, if the Menu Bar is active.</para>
 
98
        </listitem>
 
99
        <listitem>
 
100
          <para>The 
 
101
          <keycombo action="simul">&Ctrl;
 
102
          <keycap>Down Arrow</keycap></keycombo> will take you from
 
103
          the Active Panel to the Command Line or Terminal
 
104
          Emulator, and the 
 
105
          <keycombo action="simul">&Ctrl;
 
106
          <keycap>Up Arrow</keycap></keycombo> will take you back
 
107
          from the Command Line to the Active Panel.</para>
 
108
        </listitem>
 
109
        <listitem>
 
110
          <para>The &Esc; Key will make the Menu Bar
 
111
          return the focus, if it has it, to the previous Active
 
112
          Panel.</para>
 
113
        </listitem>
 
114
        <listitem>
 
115
          <para>If you happen to be inside the Terminal Emulator,
 
116
          you can use the &Tab; Key, or the mouse, to
 
117
          navigate to an Active Panel.</para>
 
118
        </listitem>
 
119
        <listitem>
 
120
          <para>Pressing 
 
121
          <keycombo action="simul">&Alt;
 
122
          <keycap>"Underlined Letter"</keycap></keycombo> from the
 
123
          Menu Bar will open that menu (unless this key combination
 
124
          is a "Reserved Key", used by one of
 
125
          &krusader;'s actions).</para>
 
126
        </listitem>
 
127
      </itemizedlist></para>
 
128
    </sect2>
 
129
    <sect2 id="selecting-files">
 
130
      <title>Selecting</title>
 
131
      <note>
 
132
        <para>&krusader; offers 4
 
133
        <link linkend="mouse_selection_modes">Mouse Selection Modes</link>, only
 
134
        &krusader;'s Mouse Selection Mode is explained
 
135
        here.</para>
 
136
      </note>
 
137
      <para>Selecting is a skill you need to master in order to get
 
138
      the most out of &krusader;. Since you can not select
 
139
      files in the Quick View Panel, and the Tree Panel only lets
 
140
      you select one directory at a time, this paragraph mainly
 
141
      explains how to select files in the List Panel
 
142
      filelist.</para>
 
143
      <para>Moving the cursor is easy. Left-clicking on a file or
 
144
      directory (referred to herein as "elements" meaning files AND
 
145
      directories) will select it. Here are some useful pointers
 
146
      that will make &krusader; even easier to use (assuming you are
 
147
      using &krusader;'s Mouse Selection Mode): 
 
148
      <itemizedlist>
 
149
        <listitem>
 
150
          <para>The 
 
151
          <keycap>SPACE</keycap> and 
 
152
          <keycap>Insert</keycap> key will toggle the selection of
 
153
          the file under the cursor without affecting the selection
 
154
          of other files/directories, the cursor will go one
 
155
          position down.</para>
 
156
        </listitem>
 
157
        <listitem>
 
158
          <para>Pressing the 
 
159
          <keycap>SPACE</keycap> on a Directory under the cursor
 
160
          will 
 
161
          <link linkend="calculate">calculate occupied
 
162
          space</link> without affecting the selection of other
 
163
          files/directories.</para>
 
164
        </listitem>
 
165
        <listitem>
 
166
          <para>
 
167
          <keycap>Left Clicking</keycap> on a file will select, or
 
168
          unselect, all previously selected files.</para>
 
169
        </listitem>
 
170
        <listitem>
 
171
          <para>
 
172
          <keycombo action="simul">&Ctrl;
 
173
          <keycap>Left Clicking</keycap></keycombo> will toggle the
 
174
          selection of the file under the cursor without affecting
 
175
          the selection of other files/directories.</para>
 
176
        </listitem>
 
177
        <listitem>
 
178
          <para>
 
179
          <keycombo action="simul">&Shift;
 
180
          <keycap>Left Clicking</keycap></keycombo> will select all
 
181
          the elements between the previous cursor location and the
 
182
          new one.</para>
 
183
        </listitem>
 
184
        <listitem>
 
185
          <para>
 
186
          <keycombo action="simul">&Shift;
 
187
          <keycap>Home</keycap></keycombo> selects everything above
 
188
          the cursor (and deselects everything below the cursor, if
 
189
          selected).</para>
 
190
        </listitem>
 
191
        <listitem>
 
192
          <para>
 
193
          <keycombo action="simul">&Shift;
 
194
          <keycap>End</keycap></keycombo> selects everything below
 
195
          the cursor (and unselects everything above the cursor, if
 
196
          selected).</para>
 
197
        </listitem>
 
198
        <listitem>
 
199
          <para>The ".." entry is not selectable.</para>
 
200
        </listitem>
 
201
        <listitem>
 
202
          <para>The <link linkend="edit-menu">Edit menu</link> can offer more ways
 
203
          to select your files.</para>
 
204
        </listitem>
 
205
      </itemizedlist></para>
 
206
    </sect2>
 
207
    <sect2 id="executing_commands">
 
208
      <title>Executing Commands</title>
 
209
      <para>There is not a lot to say here, all you need to do is
 
210
      select some files (if you do not, &krusader; will
 
211
      operate on the file(s) or directory(s) that have the focus),
 
212
      choose a 
 
213
      <link linkend="menu-commands">Command</link> from the Menu Bar
 
214
      or use a Keyboard Shortcut (or the Right Click Menu) and the
 
215
      selected Command executes. See also 
 
216
      <link linkend="executing_files">Executing
 
217
      Files</link>.</para>
 
218
    </sect2>
 
219
    <sect2 id="quicksearch">
 
220
      <title>Quicksearch</title>
 
221
      <!-- Thanks to Heiner Eichmann -->
 
222
      <para>This feature will do a quick search for the file name
 
223
      in the Active List Panel.</para>
 
224
      <para>Type 
 
225
      <keycap>foo</keycap>(one character) to do a quick search in
 
226
      the Active List Panel for a file beginning with "foo". A
 
227
      small quick search dialog box will open below the Active List
 
228
      Panel. Type the first few characters of the desired file name
 
229
      (more than one character allowed), the cursor will jump to
 
230
      that filename (if it exists), e.g. type "ab" to
 
231
      search for a file which begins with "ab". The 
 
232
      <keycap>Up/Down Arrow</keycap> will jump to the next or
 
233
      previous match. &Esc; will close the quick search
 
234
      line. The cursor will stay on the last file
 
235
      found. The Quicksearch supports <ulink url="http://en.wikipedia.org/wiki/Regular_expression">regular expressions</ulink> for searching files.</para>
 
236
      <note>
 
237
        <para>If you press 
 
238
        <keycombo action="simul">&Alt;
 
239
        <keycap>foo</keycap></keycombo>, the key binding shortcut
 
240
        will be executed. If there is no configured key binding,
 
241
        the remaining letter 
 
242
        <keycap>foo</keycap> will be used for the quick
 
243
        search.</para>
 
244
      </note>
 
245
      <para>Use <link linkend="konfig-looknfeel">Konfigurator Look &amp; Feel page</link> to change from
 
246
      the default configuration.</para>
 
247
    </sect2>
 
248
    <sect2 id="context-menu">
 
249
      <title>Context Menu</title>
 
250
      <para>&krusader; has many Context menus that allow
 
251
      you to do fast operations with the mouse, usually a
 
252
      right-click will open the Context menu (depending on your
 
253
      <link linkend="mouse_selection_modes">Mouse Selection Modes</link> settings). This list
 
254
      gives an overview of the most important context menus. Use
 
255
      them to discover the available commands. 
 
256
      <itemizedlist>
 
257
        <listitem>
 
258
          <para><link linkend="mainwindow">Main Toolbar</link> (orientation, text
 
259
          position, icon size)</para>
 
260
        </listitem>
 
261
        <listitem>
 
262
          <para><link linkend="list_panel">List Panel</link> on a file or
 
263
          directory</para>
 
264
        </listitem>
 
265
        <listitem>
 
266
          <para><link linkend="cmdline">Command Line</link> (undo, paste, text
 
267
          completion...)</para>
 
268
        </listitem>
 
269
        <listitem>
 
270
          <para><link linkend="termemu">Terminal emulator</link> (send signal, font,
 
271
          history...)</para>
 
272
        </listitem>
 
273
        <listitem>
 
274
          <para><link linkend="folder-tabs">Folder tabs</link> (new, duplicate,
 
275
          close)</para>
 
276
        </listitem>
 
277
        <listitem>
 
278
          <para>
 
279
          <link linkend="krusearcher">KruSearcher</link> Search
 
280
          results file list (F3 View, F4 Edit)</para>
 
281
        </listitem>
 
282
        <listitem>
 
283
          <para><link linkend="mount-man">MountMan</link> (unmount,
 
284
          format...)</para>
 
285
        </listitem>
 
286
        <listitem>
 
287
          <para><link linkend="synchronizer">Synchronize Directories</link> File List</para>
 
288
        </listitem>
 
289
        <listitem>
 
290
          <para><link linkend="useractions">UserActions</link></para>
 
291
        </listitem>
 
292
        <listitem>
 
293
          <para>&konqueror; Right-Click actions are
 
294
          shown in &krusader;</para>
 
295
        </listitem>
 
296
        <listitem>
 
297
          <para>Show/hide 
 
298
          <link linkend="list_panel">Column Headers</link></para>
 
299
        </listitem>
 
300
        <listitem>
 
301
          <para><link linkend="bookman">Bookmarks</link> enable/disable permanent
 
302
          bookmarks</para>
 
303
        </listitem>
 
304
        <listitem>
 
305
          <para>...</para>
 
306
        </listitem>
 
307
      </itemizedlist></para>
 
308
    </sect2>
 
309
  </sect1>
 
310
  <sect1 id="basic">
 
311
    <title>Basic File Management</title>
 
312
    <sect2 id="executing_files">
 
313
      <title>Executing Files</title>
 
314
      <para>You can only execute files in the Active List Panel. To
 
315
      <keycap>execute</keycap> a file just 
 
316
      <keycap>(double-)click on it or press Enter</keycap> when it
 
317
      is under the list cursor. &krusader; will open it
 
318
      in the default application for this file type (picture,
 
319
      text file...) or the file will be executed (script,
 
320
      binary...). If you want to use 
 
321
      <keycap>another application</keycap> to open the file, 
 
322
      <keycap>Right-Click</keycap> on the file and go to the "open
 
323
      with" sub-menu which will offer more options.
 
324
      &krusader; is compatible with &kde;
 
325
      default file manager for all file types except archives that
 
326
      are opened inside the &krusader; panel and not in
 
327
      an external application. See 
 
328
      <link linkend="konfig-archives">the archives page in
 
329
      Konfigurator</link> for details.</para>
 
330
    </sect2>
 
331
    <sect2 id="copying">
 
332
      <title>Copying and Moving</title>
 
333
      <para>To copy or move files/directories just select them and
 
334
      press 
 
335
      <keycap>F5</keycap> to 
 
336
      <keycap>copy</keycap> or 
 
337
      <keycap>F6</keycap> to 
 
338
      <keycap>move</keycap> them. If the 
 
339
      <guimenuitem> Preserve attributes (only on local
 
340
      targets)</guimenuitem> option is checked,
 
341
      &krusader; will try to preserve all attributes
 
342
      (time, owner, group) of the local files according to the
 
343
      source depending on your permissions: 
 
344
      <itemizedlist>
 
345
        <listitem>
 
346
          <para>User preserving if you are root</para>
 
347
        </listitem>
 
348
        <listitem>
 
349
          <para>Group preserving if you are root or member of the
 
350
          group</para>
 
351
        </listitem>
 
352
        <listitem>
 
353
          <para>Preserving the timestamp</para>
 
354
        </listitem>
 
355
      </itemizedlist>Using this option may slow down the copy/move
 
356
      process. A dialog will appear and allow you to choose the
 
357
      operation destination. The default destination is the
 
358
      other-panel browsed directory. If you enter a partial
 
359
      &URL;, &krusader; will use the current
 
360
      panel directory as the &URL; base.</para>
 
361
    </sect2>
 
362
    <sect2 id="queue">
 
363
      <title>Queue manager</title> 
 
364
      <para>
 
365
      The copy, move, pack and unpack operations can be queued.
 
366
      After selecting copy or move, hit <keycap>F2</keycap> to use it.
 
367
      After selecting pack or unpack, hit <keycap>F2</keycap> to use it. 
 
368
      Or the direct shortcuts: copy by queue <keycombo action="simul">&Shift;<keycap>F5</keycap></keycombo> , 
 
369
      move by queue <keycombo action="simul">&Shift;<keycap>F6</keycap></keycombo> .
 
370
      Queueing is used for one-by-one copying.
 
371
      E.g. if you have a pen drive (which is slow), and you want to copy 40 files onto it, 
 
372
      it's much better copying them one-by-one instead of starting to copy 40 files in parallel.
 
373
      That's why enqueuing is important.
 
374
      If you pack/unpack 40 files parallelly, you overload your computer,
 
375
      but adding them to a queue, is much more useful.
 
376
      </para>
 
377
    </sect2>
 
378
    <sect2 id="deleting">
 
379
      <title>Deleting - move to KDE's Trash</title>
 
380
      <para>Deleting files/directories is done by selecting them and pressing <keycap>F8</keycap> or <keycap>Delete</keycap>.
 
381
      By <link linkend="konfig-general">default</link> it will be moved to &kde;'s Trash.
 
382
      You can open the KDE Trash with the Trash icon in the <link linkend="main_toolbar">Main Toolbar</link> or with 
 
383
      the <filename>trash:/</filename> KIO slave.
 
384
      Physically KDE Trash is located in <filename>~/.local/share/Trash/</filename> .  
 
385
      <keycombo action="simul">&Shift;
 
386
      <keycap>Delete</keycap></keycombo> will delete the file
 
387
      permanently. A dialog will ask for your confirmation and will
 
388
      warn you when deleting non-empty directories. Of course only
 
389
      operations that are permitted to do by the Operating
 
390
      System will be performed - you will be notified otherwise. If
 
391
      you do not wish to see the confirmation dialogs, you can
 
392
      disable them in the 
 
393
      <link linkend="konfig-advanced">Konfigurator advanced
 
394
      tab</link>.</para>
 
395
    </sect2>
 
396
    <sect2 id="shred">
 
397
      <title>Shred Files</title>
 
398
      <para>Shred was removed from KDE4 (and as consequence Krusader-2 for KDE4).
 
399
           The main reason is probably that shredding is filesystem dependent and even if you overwrite the file 100 times, it's not sure, that it'll be deleted from the disk finally.
 
400
           Quote from the kgpg posts: "The shred feature has been removed from the KDE library. Kgpg will not support this feature anymore. Moderns file systems use journalisation. So the shred feature should be implemented in the file system. Not in kgpg."
 
401
           But you might use a proper shred <link linkend="useractions">UserAction</link> for your filesystem.
 
402
           But keep in mind that if you want to be 100% sure that it's impossible that someone can read a deleted file, you need to destroy your harddrive hardware ...
 
403
           </para>
 
404
    </sect2>
 
405
    <sect2 id="renaming">
 
406
      <title>Renaming Files, Creating Directories and Link
 
407
      Handling</title>
 
408
      <para>
 
409
      <keycap>Rename</keycap> the file under the cursor with the 
 
410
      <keycap>F9</keycap> key or with two single mouse clicks. If
 
411
      only the file name needs to be renamed and not the extension,
 
412
      you can configure this in the
 
413
      <link linkend="konfig-looknfeel">Konfigurator Look &amp; Feel page</link>. 
 
414
      <keycap>Create a new directory</keycap> with the 
 
415
      <keycap>F7</keycap> key. 
 
416
      <keycap>Right-clicking on a regular file</keycap> will give
 
417
      you the 
 
418
      <keycap>option "New Symlink"</keycap>. A dialog will prompt
 
419
      you to enter a symlink name. That name will point to the
 
420
      file/directory you Right-Clicked on. If the file you
 
421
      Right-Clicked on is a symlink, you will also be presented
 
422
      with the "redirect link" option that will allow you to change
 
423
      the link target.</para>
 
424
    </sect2>
 
425
    <sect2 id="viewing">
 
426
      <title>Viewing and Editing files</title>
 
427
      <para>
 
428
      <link linkend="krviewer">KrViewer</link> has a chapter of its
 
429
      own.</para>
 
430
    </sect2>
 
431
  </sect1>
 
432
 
 
433
<!-- call the archives sect1 section -->
 
434
&archives;
 
435
 
 
436
</chapter>