Warning, /utilities/krusader/doc/handbook/basic-functions.docbook is written in an unsupported language. File is not indexed.

0001 <!--
0002     SPDX-FileCopyrightText: 2000-2003 Shie Erlich <erlich@users.sourceforge.net>
0003     SPDX-FileCopyrightText: 2000-2003 Rafi Yanai <yanai@users.sourceforge.net>
0004     SPDX-FileCopyrightText: 2004-2010 Frank Schoolmeesters <codeknight@users.sourceforge.net>
0005     SPDX-FileCopyrightText: 2000-2022 Krusader Krew <https://krusader.org>
0006 -->
0007 <chapter id="basic-functions">
0008   <title>Basic Functions</title>
0009   <sect1 id="controls">
0010     <title>Controls</title>
0011     <sect2 id="control-general">
0012       <title>General</title>
0013       <para>This is a rather short but important section that will
0014       go into the details of controlling &krusader;.
0015       This section does not try to cover all the various key
0016       combinations for two reasons: 
0017       <orderedlist numeration="arabic">
0018         <listitem>
0019           <para>there are just too many of them</para>
0020         </listitem>
0021         <listitem>
0022           <para>most of &krusader; actions are
0023           configurable in the
0024           <link linkend="konfig-panel">Konfigurator Panel page</link></para>
0025         </listitem>
0026       </orderedlist>We will only mention the most important
0027       keyboard shortcuts with the default configuration, but keep
0028       in mind that most of the <link linkend="key_bindings">Key-Bindings</link> are
0029       configurable. If you find that you use a certain command a
0030       lot and want to know the shortcut for this command, or you
0031       want to change this command shortcut, then check out the
0032       <link linkend="key_bindings">Configure Shortcuts</link> window (<menuchoice><guimenu>Settings</guimenu> 
0033       <guimenuitem>Configure Shortcuts...</guimenuitem></menuchoice>).</para>
0034     </sect2>
0035     <sect2 id="moving-around">
0036       <title>Moving Around</title>
0037       <para>By Moving Around we mean the transfer of the keyboard
0038       and mouse focus between the different parts of the
0039       &krusader; 
0040       <link linkend="mainwindow">main window</link>. The focus can
0041       be in one of five places: the Left or Right Panel, the Menu
0042       Bar, the Command Line or the Terminal Emulator. The panel
0043       that has the focus is called the Active Panel. An Active
0044       Panel will remain active until the other panel receives the
0045       focus (&ie;: if the Left Panel was active and you
0046       clicked on the Command Line - then the Left Panel remains the
0047       Active Panel). You must deliberately change which panel is
0048       active.</para>
0049       <para>The most common way to transfer the focus to a specific
0050       panel is to use the mouse to click on that panel. But you
0051       should be aware of the following: 
0052       <itemizedlist>
0053         <listitem>
0054           <para>Clicking on the Toolbar, the FN keys bar or the
0055           Status Bar does <emphasis>not</emphasis> change the focus.</para>
0056         </listitem>
0057         <!--
0058    Quick View Panel: old Krusader feature , removed since krusader-1.12-beta1      
0059    <listitem>
0060      <para>The display part of the Quick View Panel does not accept clicks so you should click on the
0061            Location Toolbar of this panel if you want it to have focus.</para>
0062    </listitem>
0063 -->
0064         <listitem>
0065           <para>Pushing the 
0066           <guibutton>Run in Terminal Mode</guibutton> button in the
0067           Command Line will not transfer the focus, so you have to
0068           click inside the Input Line.</para>
0069         </listitem>
0070         <listitem>
0071           <para>When you choose a menu, the Menu Bar will become
0072           focused. It remains focused until you choose a command -
0073           the focus returns to the previous owner.</para>
0074         </listitem>
0075       </itemizedlist></para>
0076       <para>There are, of course, ways to use the keyboard to
0077       change the focus: 
0078       <itemizedlist>
0079         <listitem>
0080           <para>The &Tab; Key will switch panels, if one
0081           of the panels has the focus or rotate between all the
0082           commands in a menu, if the Menu Bar is active.</para>
0083         </listitem>
0084         <listitem>
0085           <para>The 
0086           <keycombo action="simul">&Ctrl;
0087           &Down;</keycombo> will take you from
0088           the Active Panel to the Command Line or Terminal
0089           Emulator, and the 
0090           <keycombo action="simul">&Ctrl;
0091           &Up;</keycombo> will take you back
0092           from the Command Line to the Active Panel.</para>
0093         </listitem>
0094         <listitem>
0095           <para>The &Esc; Key will make the Menu Bar
0096           return the focus, if it has it, to the previous Active
0097           Panel.</para>
0098         </listitem>
0099         <listitem>
0100           <para>If you happen to be inside the Terminal Emulator,
0101           you can use the &Tab; Key, or the mouse, to
0102           navigate to an Active Panel.</para>
0103         </listitem>
0104         <listitem>
0105           <para>Pressing 
0106           <keycombo action="simul">&Alt;
0107           <keycap>Underlined Letter</keycap></keycombo> from the
0108           Menu Bar will open that menu (unless this key combination
0109           is a <quote>Reserved Key</quote>, used by one of
0110           &krusader;'s actions).</para>
0111         </listitem>
0112       </itemizedlist></para>
0113     </sect2>
0114     <sect2 id="selecting-files">
0115       <title>Selecting</title>
0116       <note>
0117         <para>&krusader; offers 4
0118             <link linkend="selection_modes">Selection Modes</link>, to say nothing about the <link linkend="quickselect">Quickselect bar</link>, only
0119         &krusader;'s Selection Mode is explained
0120         here.</para>
0121       </note>
0122       <para>Selecting is a skill you need to master in order to get
0123       the most out of &krusader;. Since the Tree Panel allows select 
0124       only one folder at a time, this paragraph mainly explains how
0125       to select files in the List Panel.</para>
0126       <para>Moving the cursor is easy. Left-clicking on a file or
0127       folder (referred to herein as <quote>elements</quote> meaning files and
0128       folders) will select it. Here are some useful pointers
0129       that will make &krusader; even easier to use (assuming you are
0130       using &krusader;'s Mouse Selection Mode): 
0131       <itemizedlist>
0132         <listitem>
0133           <para>The 
0134           &Space; and &Ins; keys will toggle the selection of
0135           the file under the cursor without affecting the selection
0136           of other files/folders, the cursor will go one
0137           position down.</para>
0138         </listitem>
0139         <listitem>
0140           <para>
0141           <keycap>Left Clicking</keycap> on a file will select, or
0142           unselect, all previously selected files.</para>
0143         </listitem>
0144         <listitem>
0145           <para>
0146           <keycombo action="simul">&Ctrl;
0147           <keycap>Left Clicking</keycap></keycombo> will toggle the
0148           selection of the file under the cursor without affecting
0149           the selection of other files/folders.</para>
0150         </listitem>
0151         <listitem>
0152           <para>
0153           <keycombo action="simul">&Shift;
0154           <keycap>Left Clicking</keycap></keycombo> will select all
0155           the elements between the previous cursor location and the
0156           new one.</para>
0157         </listitem>
0158         <listitem>
0159           <para>
0160           <keycombo action="simul">&Shift;&Home;</keycombo> selects
0161           everything above the cursor (and deselects everything
0162           below the cursor, if selected).</para>
0163         </listitem>
0164         <listitem>
0165           <para>
0166           <keycombo action="simul">&Shift;&End;</keycombo> selects
0167           everything below the cursor (and unselects everything
0168           above the cursor, if selected).</para>
0169         </listitem>
0170         <listitem>
0171           <para>The <quote>..</quote> entry is not selectable.</para>
0172         </listitem>
0173         <listitem>
0174           <para>The <link linkend="edit-menu">Edit menu</link> can offer more ways
0175           to select your files.</para>
0176         </listitem>
0177       </itemizedlist></para>
0178     </sect2>
0179     <sect2 id="executing_commands">
0180       <title>Executing Commands</title>
0181       <para>There is not a lot to say here, all you need to do is
0182       select some files (if you do not, &krusader; will
0183       operate on the file(s) or folder(s) that have the focus),
0184       choose a 
0185       <link linkend="menu-commands">Command</link> from the Menu Bar
0186       or use a Keyboard Shortcut (or the Right Click Menu) and the
0187       selected Command executes. See also 
0188       <link linkend="executing_files">Executing
0189       Files</link>.</para>
0190     </sect2>
0191     <sect2 id="quicksearch">
0192       <title>Quick search</title>
0193       <!-- Thanks to Heiner Eichmann -->
0194       <para>This feature will do a quick search for the file name
0195       in the Active List Panel.</para>
0196       <para>Type 
0197       <keycap>foo</keycap>(one character) to do a quick search in
0198       the Active List Panel for a file beginning with <quote>foo</quote>. A
0199       small quick search dialog box will open below the Active List
0200       Panel. Type the first few characters of the desired file name
0201       (more than one character allowed), the cursor will jump to
0202       that filename (if it exists), &eg; type <quote>ab</quote> to
0203       search for a file which begins with <quote>ab</quote>. The
0204       &Up;/&Down; keys will jump to the next or
0205       previous match. &Esc; will close the quick search
0206       line. The cursor will stay on the last file
0207       found. The Quicksearch supports <ulink url="https://en.wikipedia.org/wiki/Regular_expression">regular expressions</ulink> for searching files.</para>
0208       <note>
0209         <para>If you press 
0210         <keycombo action="simul">&Alt;
0211         <keycap>foo</keycap></keycombo>, the key binding shortcut
0212         will be executed. If there is no configured key binding,
0213         the remaining letter 
0214         <keycap>foo</keycap> will be used for the quick
0215         search.</para>
0216       </note>
0217       <para>Use <link linkend="key_bindings">Configure Shortcuts</link> window (<menuchoice><guimenu>Settings</guimenu> 
0218       <guimenuitem>Configure Shortcuts...</guimenuitem></menuchoice>).</para>
0219     </sect2>
0220     <sect2 id="quickfilter">
0221       <title>Quick filter</title>
0222       <para>This feature will do a quick filter for the file list
0223       in the Active Panel.</para>
0224       <para>Press <keycombo>&Ctrl;<keycap>I</keycap></keycombo> to open Quickfilter bar.
0225       Type <keycap>foo</keycap> (one character) to filter out from the Active Panel all the files
0226       that do not have <quote>foo</quote> in names. You can use wildcards for the filtering. &eg; use <quote>a*b</quote> to
0227       filter files which have <quote>a</quote> and <quote>b</quote> in their names. The Quickfilter follows the
0228       <link linkend="konfig-panel-general">case-sensitivity setting</link> of Quicksearch.</para>
0229       <para>Pressing &Enter; in Quickfilter mode sets focus to panel, when panel or Quickfilter is focused, &Esc; closes Quickfilter.
0230       </para>
0231       <para>To change the default shortcut of Quickfilter use <link linkend="key_bindings">Configure Shortcuts</link> window (<menuchoice><guimenu>Settings</guimenu> 
0232       <guimenuitem>Configure Shortcuts...</guimenuitem></menuchoice>).</para>
0233     </sect2>
0234     <sect2 id="quickselect">
0235       <title>Quick select</title>
0236       <para>This feature will do a quick select for the file list
0237       in the Active Panel.</para>
0238       <para>Press <keycombo>&Ctrl;&Shift;<keycap>S</keycap></keycombo> to open Quickselect bar.
0239       Type <keycap>foo</keycap> (one character) to filter out from the Active Panel all the files
0240       that do not have <quote>foo</quote> in names. You can use wildcards for the filtering. &eg; use <quote>a*b</quote> to
0241       filter files which have <quote>a</quote> and <quote>b</quote> in their names. The Quickselect follows the
0242       <link linkend="konfig-panel-general">case-sensitivity setting</link> of Quicksearch.</para>
0243       <para>Pressing &Enter; in Quickselect mode sets focus to panel, when panel or Quickselect is focused, &Esc; closes Quickselect.
0244       </para>
0245       <para>To change the default shortcut of Quickselect use <link linkend="key_bindings">Configure Shortcuts</link> window (<menuchoice><guimenu>Settings</guimenu> 
0246       <guimenuitem>Configure Shortcuts...</guimenuitem></menuchoice>).</para>
0247     </sect2>
0248     <sect2 id="context-menu">
0249       <title>Context Menu</title>
0250       <para>&krusader; has many Context menus that allow
0251       you to do fast operations with the mouse, usually a
0252       right-click will open the Context menu (depending on your
0253       <link linkend="selection_modes">Selection Modes</link> settings). This list
0254       gives an overview of the most important context menus. Use
0255       them to discover the available commands. 
0256       <itemizedlist>
0257         <listitem>
0258           <para><link linkend="mainwindow">Main Toolbar</link> (orientation, text
0259           position, icon size)</para>
0260         </listitem>
0261         <listitem>
0262           <para><link linkend="list_panel">List Panel</link> on a file or
0263           folder</para>
0264         </listitem>
0265         <listitem>
0266           <para><link linkend="cmdline">Command Line</link> (undo, paste, text
0267           completion...)</para>
0268         </listitem>
0269         <listitem>
0270           <para><link linkend="termemu">Terminal emulator</link> (send signal, font,
0271           history...)</para>
0272         </listitem>
0273         <listitem>
0274           <para><link linkend="folder-tabs">Folder tabs</link> (new, duplicate,
0275           close)</para>
0276         </listitem>
0277         <listitem>
0278           <para>
0279           <link linkend="krusearcher">KruSearcher</link> Search
0280           results file list (<keycap>F3</keycap> View, <keycap>F4</keycap> Edit)</para>
0281         </listitem>
0282         <listitem>
0283           <para><link linkend="mount-man">MountMan</link> (unmount,
0284           format...)</para>
0285         </listitem>
0286         <listitem>
0287           <para><link linkend="synchronizer">Synchronize Folders</link> File List</para>
0288         </listitem>
0289         <listitem>
0290           <para><link linkend="useractions">UserActions</link></para>
0291         </listitem>
0292         <listitem>
0293           <para>&konqueror; Right-Click actions are
0294           shown in &krusader;</para>
0295         </listitem>
0296         <listitem>
0297           <para>Show/hide 
0298           <link linkend="list_panel">Column Headers</link></para>
0299         </listitem>
0300         <listitem>
0301           <para><link linkend="bookman">Bookmarks</link> enable/disable permanent
0302           bookmarks</para>
0303         </listitem>
0304         <listitem>
0305           <para>...</para>
0306         </listitem>
0307       </itemizedlist></para>
0308     </sect2>
0309   </sect1>
0310   <sect1 id="basic">
0311     <title>Basic File Management</title>
0312     <sect2 id="executing_files">
0313       <title>Executing Files</title>
0314       <para>You can only execute files in the Active List Panel. To
0315       execute a file just 
0316       (double-)click on it or press &Enter; when it
0317       is under the list cursor. &krusader; will open it
0318       in the default application for this file type (picture,
0319       text file...) or the file will be executed (script,
0320       binary...). If you want to use 
0321       another application to open the file, 
0322       click with the &RMB; on the file and go to the <guisubmenu>Open
0323       with</guisubmenu> sub-menu which will offer more options.
0324       &krusader; is compatible with the &plasma;
0325       default file manager for all file types except archives that
0326       are opened inside the &krusader; panel and not in
0327       an external application. See 
0328       <link linkend="konfig-archives">the archives page in
0329       Konfigurator</link> for details.</para>
0330     </sect2>
0331     <sect2 id="copying">
0332       <title>Copying and Moving</title>
0333       <figure id="screenshot-copyjob" float="1">
0334         <title>Copy dialog</title>
0335         <mediaobject>
0336           <imageobject>
0337             <imagedata fileref="copyjob.png"></imagedata>
0338           </imageobject>
0339           <textobject>
0340             <phrase>Copy dialog</phrase>
0341           </textobject>
0342         </mediaobject>
0343       </figure>
0344       <para>To copy or move files/folders just select them and
0345       press 
0346       <keycap>F5</keycap> to 
0347       copy or
0348       <keycap>F6</keycap> to 
0349       move them. &krusader; tries to preserve the time of
0350       modification. When copying a folder owner is changed to the user which
0351       copies the folder, group is changed to the default group of the user.
0352       When copying a file owner is changed to the user which copies the file,
0353       group is changed to default group of the user, and permissions are
0354       preserved. The owner, the group and the permissions are preserved when
0355       moving file or folder. When copying or moving files/folders a dialog
0356       appears and allows you to choose the operation destination.
0357       The default destination is the other-panel browsed folder. If you enter
0358       a partial &URL;, &krusader; will use the current
0359       panel folder as the &URL; base.</para>
0360     </sect2>
0361     <sect2 id="queue">
0362       <title>Queue manager</title> 
0363       <para>
0364       The copy, move, pack and unpack operations can be queued.
0365       After selecting copy or move, hit <keycap>F2</keycap> to use it.
0366       After selecting pack or unpack, hit <keycap>F2</keycap> to use it. 
0367       Or the direct shortcuts: copy by queue <keycombo action="simul">&Shift;<keycap>F5</keycap></keycombo> , 
0368       move by queue <keycombo action="simul">&Shift;<keycap>F6</keycap></keycombo> .
0369       Queue manager performs actions one-by-one.
0370       For example, if you have a pen drive (which is slow), and you want to copy 40 files onto it, 
0371       it is much better copying them one-by-one instead of starting to copy 40 files in parallel.
0372       That is why enqueuing is important.
0373       If you pack/unpack 40 files in parallel, you overload your computer,
0374       but adding them to a queue, is much more useful.
0375       </para>
0376       <para>It is possible to switch the <link linkend="job-queue-mode">Queue Manager mode</link> by the <menuchoice><guimenu>Settings</guimenu> <guimenuitem>Job Queue Mode</guimenuitem></menuchoice> menu item.
0377       </para>
0378     </sect2>
0379     <sect2 id="deleting">
0380       <title>Deleting - move to &plasma; Trash</title>
0381       <para>Deleting files/folders is done by selecting them and pressing <keycap>F8</keycap> or <keycap>Delete</keycap>.
0382       By <link linkend="konfig-general">default</link> it will be moved to &plasma; Trash.
0383       You can open the &plasma; Trash with the Trash icon in the <link linkend="main_toolbar">Main Toolbar</link> or with 
0384       the <filename>trash:/</filename> KIO slave.
0385       Physically &plasma; Trash is located in <filename>~/.local/share/Trash/</filename> or <filename>Trash</filename> in the subfolder in user home folder which can be determined using the <userinput>qtpaths --paths GenericDataLocation</userinput> command.
0386       <keycombo action="simul">&Ctrl;
0387       <keycap>Delete</keycap></keycombo> will delete the file
0388       permanently. A dialog will ask for your confirmation and will
0389       warn you when deleting non-empty folders. Of course only
0390       operations that are permitted to do by the Operating
0391       System will be performed - you will be notified otherwise. If
0392       you do not wish to see the confirmation dialogs, you can
0393       disable them in the 
0394       <link linkend="konfig-advanced">Konfigurator advanced
0395       page</link>. If you set to delete permanently files in the <link linkend="konfig-general">Konfigurator general
0396       page</link>, <keycap>F8</keycap> or <keycap>Delete</keycap> will permanently delete files,
0397       while <keycombo action="simul">&Ctrl; <keycap>Delete</keycap></keycombo> will move them to &plasma; Trash.</para>
0398     </sect2>
0399     <sect2 id="shred">
0400       <title>Shred Files</title>
0401       <para>Shred was removed from &kde; 4 (and as consequence &krusader;-2 for &kde; 4).
0402            The main reason is probably that shredding is filesystem dependent and even if you overwrite the file 100 times, it is not sure, that it will be deleted from the disk finally.
0403            Quote from the &kgpg; posts: <quote>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;.</quote>
0404            But you might use a proper shred <link linkend="useractions">UserAction</link> for your filesystem.
0405            But keep in mind that if you want to be 100% sure that it is impossible that someone can read a deleted file, you need to destroy your harddrive hardware...
0406            </para>
0407     </sect2>
0408     <sect2 id="renaming">
0409       <title>Renaming Files, Creating Directories and Link
0410       Handling</title>
0411       <para>
0412       Rename the file under the cursor with the 
0413       <keycap>F2</keycap> key or with two single mouse clicks. If
0414       only the file name needs to be renamed and not the extension,
0415       you can configure this in the
0416       <link linkend="konfig-general-atomic">Konfigurator General page</link>. 
0417       <guilabel>Create a new folder</guilabel> with the
0418       <keycap>F7</keycap> key. 
0419       Right-clicking on a regular file will give
0420         you the option <menuchoice><guisubmenu>Link Handling</guisubmenu> <guimenuitem>New Symlink...</guimenuitem></menuchoice>. A dialog will prompt
0421       you to enter a symlink name. That symlink will point to the
0422       file/folder you right-clicked on. If the file you
0423       right-clicked on is a symlink, you will also be presented
0424       with the <menuchoice><guisubmenu>Link Handling</guisubmenu> <guimenuitem>Redirect Link</guimenuitem></menuchoice> option that will allow you to change
0425       the link target.</para>
0426     </sect2>
0427     <sect2 id="viewing">
0428       <title>Viewing and Editing files</title>
0429       <para>
0430       <link linkend="krviewer">KrViewer</link> has a chapter of its
0431       own.</para>
0432     </sect2>
0433   </sect1>
0434 
0435 <!-- call the archives sect1 section -->
0436 &archives;
0437 
0438 </chapter>