diff --git a/doc/configuration-files.docbook b/doc/configuration-files.docbook index 188e8a1f..a884e317 100644 --- a/doc/configuration-files.docbook +++ b/doc/configuration-files.docbook @@ -1,160 +1,158 @@ Configuration Files Configuration files This appendix gives an overview of the configuration files used by &krusader;. krusaderui.rc This file stores the users toolbar settings and the menu - structure. Tip: read also the - krusaderui.rc - &FAQ;. + structure. Location: /usr/share/kxmlgui5/krusader/krusaderui.rc, or ~/.local/share/kxmlgui5/krusader/krusaderui.rc, or kxmlgui5/krusader/krusaderui.rc in the directory which can be determined using the qtpaths --paths GenericDataLocation command krusaderrc This file stores the &krusader; configuration. Location: ~/.config/krusaderrc The following settings are ⪚ stored: Actions Toolbar Archives Colors Dependencies DiskUsage DiskUsageViewer General HTML Settings KFileDialog KFileDialog Speedbar KrDetailedViewLeft KrDetailedViewRight KrViewerWindow KrViewerWindow Toolbar extraToolBar Look & Feel Notification Messages Panel Profiles Private Protocols Search Startup Synchronize Locate SynchronizerProfile - 1 krbookmarks.xml This file stores the &krusader; bookmarks and uses the XBEL standard. Location: ~/.local/share/krusader/krbookmarks.xml or krusader/krbookmarks.xml in the directory which can be determined using the qtpaths --paths GenericDataLocation command useractions.xml This file stores the UserActions configuration. Location: ~/.local/share/krusader/useractions.xml or krusader/useractions.xml in the directory which can be determined using the qtpaths --paths GenericDataLocation command useraction-examples.xml This is the default UserActions provided by developers. Location: $KDEDIR/share/krusader/useraction-examples.xml foo.keymap This is a .ini file that holds a Key binding profile. Until &krusader;-1.70.0 this was a binary file. &krusader; is backwards compatible for importing this legacy binary format. Location: /usr/share/krusader/foo.keymap foo.color This is a binary file that holds the Color Scheme. Location: /usr/share/krusader/foo.color diff --git a/doc/editors-note.docbook b/doc/editors-note.docbook index 44a9a221..97bff907 100644 --- a/doc/editors-note.docbook +++ b/doc/editors-note.docbook @@ -1,73 +1,72 @@ Note from the Editors As you may notice, this handbook is written by various authors. The draft explanation of new features is done by the developers on the krusader-devel mailinglist, the editors add this information in this handbook. We have taken much care in ensuring technical and vocabulary consistency. The authors write in English even though it is not their native language; therefore, you may notice strange sentence constructions. Do not hesitate to let us know, if something is not clear to you. An open source project's greatest strength is derived from getting user feedback. That is why we would love to hear what you have to say. Documentation contributors are always welcome!, since this is a time consuming task. If you have ideas on how to improve the content, if you would like to write about an undocumented &krusader; feature, or if you have comments or suggestions about the &krusader; Handbook, please let us know. You can contact us even if you find typos! For information about the &krusader; documentation project, please contact the &krusader; documentation coordinator, Yuri Chornoivan yurchor@ukr.net. This handbook is available in several formats. via the Help Menu when using &krusader; the Online Handbook The most recent version of this handbook is available when using &krusader; from Git. - If you are using a development or - Git version, it is possible that the latest + If you are using a development or &git; version, it is possible that the latest new features are not yet in the "The &krusader; Handbook". Please read the Changelog file online or in the &krusader; sources to find out more about the new features. For a brief description, please read the NEWS file online or in the &krusader; sources. User feedback and Bug reports are always welcome! All mentioned Trademarks and Copyrights in this handbook belong to their respective owners. diff --git a/doc/faq.docbook b/doc/faq.docbook index c5c46ece..ffc11ffd 100644 --- a/doc/faq.docbook +++ b/doc/faq.docbook @@ -1,1416 +1,1037 @@ Frequently Asked Questions (&FAQ;) FAQ If you have problems with &krusader; please - check the Installation procedure, as your problem may be + check the + installation + procedure, as your problem may be caused by a bad installation. The &FAQ; is divided into three sections: Installation &FAQ; (this page) Usage &FAQ; (issues with running/using &krusader;) General &FAQ; (bug reports, forum, mailing list, ...) If you feel that a &FAQ; is missing or if something is not clear to you, please let us know. Installation &FAQ; Does &krusader; need &plasma; to run? No, &krusader; does not need the &plasma; window manager to run on your computer but &krusader;'s natural environment is &plasma;, because it relies on services provided by the &kf5-full; base libraries. Only some shared libraries are needed ⪚ &kf5; libraries, &Qt; libraries, &etc; This means that &krusader; runs on GNOME, AfterStep, XFce and other window managers provided the appropriate libraries are installed on your computer. All this is not a problem since the apt-get world can resolve these dependencies instantly. You do not need to switch to the &plasma; window manager to use &krusader;; you can still use GNOME, AfterStep, XFce or another window manager. However, the configuration of the &krusader; fonts and some behavior is done by running systemsettings. A lot depends on what you want to do with &krusader;. You should know that &krusader; uses the &kf5; KIO Slaves to access remote file systems, and support for only a limited number of file system types are shipped with &kf5; libraries, most of the KIO Slave are bundled with &kf5-full; (including fish, sftp and tar). To summarize, if you want a working &krusader; - install &kf5-full;. If you want a functional &krusader; then you need &kf5-full; and some additional &plasma; packages. For maximum functionality, &krusader; needs some &kde; Applications (&ark;, &kdiff3;, KRename), but the &plasma; window manager is optional. - - - Which libraries does &krusader; need to - run? - - - For running &krusader; (⪚ - when you have installed &krusader; with a - binary RPM) you need less libraries than if you compile - &krusader; from source. ⪚ you - only need the C-compiler &gcc; when you - compile &krusader; from source (see the next - question). - Take a look at the &krusader; dependencies paragraph of our install chapter. - - If you need more details please take a look - at the &krusader; requirements on Ubuntu. - The "depends" are required, the "suggests" make &krusader; more powerful. - - - - - - - I have followed all the steps but - make complains about missing libs - or headers. What do I need to do? - - - Install the missing packages. - Take a look at the Compilation requirements paragraph of our install chapter. - Most RPM-based distributions separate the headers - from the libs. The headers are needed to compile - &krusader;. Look for packages in the form - foo-devel-*.rpm (⪚ - kdelibs-devel-foo.i586.rpm) or - foo-dev-*.deb for Debian based - distributions. These are usually included with your - distribution. - - If you cannot find the needed package, use - rpmfind and click 'missing lib or - header' in the search line. Or use - apt-cache search - foo to find the - corresponding package for Debian based - distributions. - - - - - - - - How do I compile &krusader; when I am - using a 64 bit processor? - - - As far as we know, there are no issues. - &krusader; is also available on - - many other architectures. - - - - - - - I have downloaded the Source RPM - krusader-x.xx.dist.src.rpm, what to - do now? - - - - - - Check the ownership and the permissions on - - /usr/src/RPM/ and all recursive - directories that your normal user can - read-write-execute in these directories. - - - To produce the binary RPM for your computer, - do this: - $ rpm </path/to/rpmfile/> krusader-x.xx.dist.src.rpm - - - - If all - - dependencies are OK, a binary RPM - krusader-x.xx.dist.rpm will be - created at - - /usr/src/RPM/RPMS/i586 (replace i586 with - your architecture). - - - Test the binary RPM for errors before - installing: - $ rpm </path/to/rpmfile> krusader-x.xx.dist.rpm - If the prompt returns without any message, - then everything is OK. - - - Install the binary RPM as usual, for example: - $ su -c 'rpm </path/to/rpmfile> krusader-x.xx.dist.rpm' - You will be asked to enter your root - password. - - - Now you can - - start &krusader;. - - - - - - - For more information about RPM, visit - rpm.org and read the - RPM Guide - by Eric Foster-Johnson. - - - - - - - - I am trying to install binary foo (RPM or DEB - package), but it fails. What is wrong? - - - Since we only prepare (and use) the source, we have - no way of knowing this. Did you test the binary RPM - before installing? - $ rpm </path/to/rpmfile> krusader-x.xx.dist.rpm - If the prompt returns without any message, then - everything is OK. RPM's downloaded from our website are - usually provided by &krusader; users. Visit - your distro website and search for an updated RPM. - If the RPM is not OK, try to find another package - at &Linux; software archives such as - freshmeat.net or linux-apps.com. - If you still cannot find the appropriate package for your - &Linux; distribution, we recommend searching - for it with rpmfind or - rpmpbone. - In general, a package for an older version of your - distribution or even for another distribution might work - on your computer (⪚ FC RPM's often work on - Mdk and RH, and vice versa), but it is always the best - that you install only RPM's that exactly match your - distribution. If you cannot find a package that matches - your distribution version, architecture or distribution, - then use a source RPM. When you use a source RPM, the - Krusader sources will be built, on your computer, - guaranteeing a suitable binary RPM for your specific - distribution and architecture. In addition, this method - results in maximum system speed, since the resulting - binary is customized for your computer. Please read the - previous question, it explains how to install a source - RPM. The best solution is explained in the next - question. - - - - - I cannot find an RPM or DEB package for + I cannot find a package for &krusader;, what to do? Check if your distribution provides &krusader;, if it does not then contact your distribution creator and ask them to include &krusader;! - Did you take a look at the &URL;s on - the Installation procedure page? If you have and + Did you take a look at the + installation + procedure page? If you have and found nothing, you can always compile - &krusader; from source. Even if you feel you - have not got the necessary skills, you will probably - succeed in compiling &krusader;: we provide a - very detailed installation procedure. This HowTo enables - newcomers to compile &krusader; from source, - even if they have never done a compilation from source - before, just follow the instructions carefully. Feel free + &krusader; from source. Feel free to post a help request if you encounter problems. - - - Some new menu items are missing after updating - &krusader;, what is wrong? - - - The - krusaderui.rc file is stored in - - /usr/share/kxmlgui5/krusader/krusaderui.rc. - When you change the - Toolbar, &plasma; makes a - copy of that file in the home folder at - - ~/.local/share/kxmlgui5/krusader/krusaderui.rc. If - &krusader; was previously installed on your computer, and - you install a newer &krusader; version the - - ~/.local/share/kxmlgui5/krusader/krusaderui.rc file - must be replaced with the newer version. Note: this will - also reset all your changes on toolbars and - shortcuts! - The first line of - krusaderui.rc contains the version - number. After installing a newer &krusader; - version, &plasma; will automatically replace the - old - - ~/.local/share/kxmlgui5/krusader/krusaderui.rc with - the newer version when starting the new - &krusader; for the first time - (&plasma; will detect the newer version number in - the first line). - If you install a development or beta version and - &krusader; was already installed on your - computer then you should delete the - krusaderui.rc file from your home - directory to activate the new menu entries - $ - - rm - - - If the - - ~/.local/share/kxmlgui5/krusader/krusaderui.rc file - is older, then the new menu elements will not be shown. - Read the previous question for information on how to - update the - krusaderui.rc file. If - krusaderui.rc is missing or in a - wrong directory, only the - Help menu appears, please read the - previous question. - - - The default folder for the local configuration file kxmlgui5/krusaderui.rc is ~/.local/share. You can determine the needed folder in your system using the qtpaths --paths GenericDataLocation command in terminal. - - - - - - I am having trouble compiling and installing &krusader;, how do I send a help request? Please read our detailed - installation - procedure and the FAQ. If you + installation + procedure and the FAQ. If you cannot find a solution to your problem then feel free to post a help request at our &krusader; forum or use the &krusader;-users mailing list. But before posting a help request, please try the following: Use the search function on the &kde; Forum, your problem might be solved or discussed already. If you cannot find a solution, please make a note of the following issues: the &krusader; version used the &Linux; distribution + version used a good description of the problem Without this information, it is very difficult for us to help you. If you give us the error messages (⪚ make error messages) please start with the FIRST error message, all the error messages which follow the first error message are consequences and not the cause of your problem. Send out your help request. Thank you for your co-operation! - - - How can I build an RPM package for - &krusader;? - - - If you have experience with compiling from source, - you will probably be able to build a - &krusader; RPM too. Information about RPM can - be found at rpm.org and in the - RPM Guide - by Eric Foster-Johnson. The - following is the short procedure howto on building an - RPM. - - NEVER build RPMs when logged in as root. Mistakes - in building packages (⪚ a bad - krusader.spec file) can do serious - damage to your system when logged in as root. - - - - - Compile &krusader; from source to - check that the compilation works fine. - - - Check the ownership and the permissions on - - /usr/src/RPM/ and all recursive - directories that your normal user can - read-write-execute in these directories. - - - Copy - krusader-1.xx.tar.gz to - - /usr/scr/RPM/SOURCE - - - Copy - krusader.spec to - - /usr/scr/RPM/SPECS - - - Edit - krusader.spec and add your name, - your email address, the rpm name, ... Other - changes may be needed if - rpmbuild fails. - - - Build the binary and the source RPM with: - $ rpmbuild /usr/scr/RPM/SPECS/krusader.spec - If everything went OK you will have a - binary RPM in - - /usr/src/RPM/RPMS/i586 (depending on your - architecture) and a source RPM in - - /usr/src/RPM/SRPMS/ ⪚ - - krusader-1.70-beta1.suse10.i586.rpm and - - krusader-1.70-beta1.suse10.src.rpm - - - If the build is not OK you will receive an - error message during the rpmbuild process, try to - fix it and run - rpmbuild again. - - - And finally: - test the RPM - before sending it in. - - - - - - - Why does &krusader;-git show an old version number in the about box? Because we only change the version number just before we do a new release. &krusader;-git will show an older version number, so ignore the version number and check the download date. We simply have not yet decided what the next version number will be. - - - Why does &krusader; not start on &MacOS;? - - - Please read carefully the macports.org - installation instructions. Do not forget to start dbus. - ########################################################## -# Do not forget that dbus needs to be started as the local -# user (not with sudo) before any KDE programs will launch -# To start it run the following command: -# launchctl load /Library/LaunchAgents/org.freedesktop.dbus-session.plist -########################################################## - -###################################################### -# Programs will not start until you run the command -# 'sudo chown -R $USER ~/Library/Preferences/KDE' -# replacing $USER with your username. -###################################################### - - - - - Usage &FAQ; Why does &krusader; freeze or hang on a dead mountpoint? When &krusader; is ⪚ browsing an NFS share and the NFS server goes down, &krusader; will freeze. This &krusader; (and all other open internal viewers/editors) freeze is fatal, and can only be corrected with the kill -9. We have no solution for this. This is an issue not confined to file managers, or even the &Linux; OS! The problem is that you "hang" on the first access to the dead share - so there is no way around it, no check to avoid it, even ls will freeze. Just trying to read something - anything - is enough to get you stuck. The one and only way around this architectural problem is using a multi-threaded design - this way if we get stuck, we do not hang the entire application event loop, but we do not think that the time is right for adding threads, we are not sure that *all* the &kf5; systems out there are using &Qt;-mt (the multi threaded version of the &Qt; library), and the &krusader; Krew may not be the right people to address this major issue in any case; so currently this is just a bug we have to learn to live with. When I try to resize &krusader; to make it smaller, I discover that I cannot resize it below a certain size. Why? See the F1, F2 (&etc;) buttons? They are not allowing &krusader; to downsize as they have a minimum size. Just disable them Settings Show FN Keys Bar and you will be able to resize &krusader; to your liking. Since version 1.51 we have improved this greatly: when downsizing the buttons will look like 'F5 ..py'. When the button faces are too small to read a tooltip will give the complete text. The minimum width is 45 pixels for each button. Samba ISO 8859-x codepage / What to do if &krusader; does not read shared directories containing special international characters? &krusader; does not handle (yet) Samba ISO 8859-x codepages, if you use a codepage different than 8859-1 you will have to do a manual configuration. Create or modify the file: ~/.smb/smb.conf [global] workgroup = MyWorkGroup (ex. WORKGROUP) client code page = MyCodePage (ex. 852) character set = MyCharSet (ex. ISO8859-2) You can try to configure smb.conf with appropriate &systemsettings; module. &krusader; reports "krarc:... protocol not supported" error at opening an archive file, what to do? Install the krarc slave properly: Copy the kio_krarc.so, kio_krarc.la files into /usr/{lib or lib64}/qt5/plugins Copy the krarc.protocol file into /usr/share/services or the directory where the KIO slaves are placed in your &Linux; distribution. I get the error message "Protocol not supported by Krusader: "krarc:/path/to/foo-archive", when I try to open foo-Archive, what to do? The icons, kio_slaves and documentation must be installed in the correct places in the &kf5; directory tree. The kio_krarc.* files must be in the same directory with the other KIO slaves. Try this: locate kio_tar.* and copy/link the kio_krarc.* files to the same location. Do not forget to run # ldconfig on this directory when you are done. What to do if an external tool does not seem to work? &krusader; uses several programs as external tools, and sometimes they appear not to work. Open a terminal and check if tool foo is installed. $ foo Check if tool foo is properly configured in the Konfigurator Dependencies page. For Archiving tools: autodetect the archives again with the Auto Configure button in the Konfigurator archive page. Check the Konfigurator Protocol page If it does not work, backup your XDG_CONFIG_HOME/krusaderrc (default is $HOME/.config/krusaderc) configuration file and remove it from this location. Restart &krusader;, &krusader; will now start the first start configuration wizard, follow these guidelines. How to executing jar files (and not enter the jar archive)? Go to the Konfigurator Protocol page and remove application/x-jar from the krarc node, &krusader; should no longer enter the archive. Global file associations are handled by &plasma; and not by &krusader;. To associate the jar extension: Open &plasma; &systemsettings;: systemsettings Applications File Associations Enter jar as filename pattern Add java as application Why do I have trouble with my &FTP; connection? This problem often occurs when you are behind a firewall or proxy. Open System Settings Network Settings Connection Preferences , Enable Passive Mode (PASV) has to be turned on or off, depending on its current setting. Now try your &FTP; session again to see if it works. Also, make sure you have no other &FTP; sessions open (using web browsers, &etc;), they can cause complications. More information can be found in Active &FTP; vs. Passive &FTP;, a Definitive Explanation. I get FTP protocol not supported by &krusader; error when trying to open a remote &FTP; directory, what to do? The reason for this error is that '&FTP; via &HTTP; proxy' feature is not yet supported by &krusader;. This error may be caused by a misconfiguration of the proxy settings in &systemsettings;. Modify the proxy settings to not use &HTTP; proxy and &FTP; will work. How do not add .part suffix when copying files via &FTP;? When uploading files a .part suffix is added to the filename, once the upload is complete the filename is renamed automagically to remove the .part suffix. This works great but sometimes some &FTP; servers do not allow a rename operation. You can solve this by unchecking the checkbox Mark partially uploaded files in &plasma; &systemsettings;. The check box is located at Network Settings Connection Preferences . How can I close a remote connection (⪚ a &FTP; connection)? It is explained in the remote connections chapter. I am experiencing problems with the media:/ protocol, why? The media:/ protocol was removed since &kde; 4. Please use mtp:/ protocol instead. How can I disable the default sounds, ⪚ when I do a delete action? Those are the default &plasma; System sounds, and not related to &krusader;. If you want to disable them globally open your &plasma; &systemsettings; ( systemsettings): Personalization Notifications Manage Notifications , Event Source: "Plasma Workspace" and uncheck sound items you do not like. Where the remote connection manager? Use our Bookmark Manager. Use a remote &URL; and bookmark it. Why does not MIME type magic sometimes work inside archives? When you enter an archive and press F3 to view a file that has no known extension, ⪚ README, INSTALL &etc; And if the viewer opens in hex-mode instead of the usual mode, than you need to configure: KDE System Settings File Associations Application octet-stream , binary viewer needs to be removed. Where is Konfigurator, do i need to install the &plasma; to use it? Konfigurator is &krusader;s configuration module, if you have installed &krusader; then you have also Konfigurator. For some reason some people think it is an other &plasma; application, but it is not, so you do not need to install the full fledged &plasma; to use Konfigurator. When running &krusader;, use Settings Configure &krusader; , and it will start Konfigurator. Please read the manual, &krusader; has many many configuration options, a lot of things can be customized to your needs with Konfigurator. How can I set the look & feel of 2 different users to be the same? Presuming that the current setup is the good configuration, you can copy the configuration to the other user. # cp ~/.config/krusaderrc /home/foo_user/.config And when the other user is Root use: # cp ~/.config/krusaderrc /root/.config General &FAQ; How can I report a wish, a suggestion, or a comment? An open source project's greatest strength is derived from getting user feedback. That is why we love to hear what you have to say. Your "gripes" are our instructions. After about 6 months, programmers can no longer see their own mistakes. It is natural. We want the ideas, qritiques, and feedback because we all want to make &krusader; the best and most useful file manager available anywhere. The most convenient way to contact us is to use the krusader-users mailing list. For information on what remains to be done look at the &krusader;-devel mailing list. We review and discuss every submission. How can I send a patch? It is not easy to write patch guidelines, but here are some. Patches, new code or new features are always welcome! Focus only on one problem at a time, so the developers can easily understand you, and commit your patch it works. Preferably, you can start a discussion with the developers on the krusader-devel mailing lists or on the &krusader; Phabricator page. Unfortunately, we cannot apply a patch if the patch is in conflict with the "general design" of the &krusader; code (read for more instructions in this FAQ). Please send only one change request per mail, so that the discussion is easier to follow. The modifications should be committed step by step, checking each line. Submit your patch files into the &krusader; group on the Phabricator, so that all patch proposals stay organised and do not get lost, tar.gz archives or diffs are usually ok. Do not copy changes into a mail. Most mailers will change the white spaces, so that the diff will not apply or the code snipped does not diff. In the past, patch mails went lost or disorganized in many many mails, so please use the Phabricator, thanks! Use portable solutions, &krusader; should run on: All POSIX (&Linux;/BSD/&UNIX;-like OSes), &Solaris;. All BSD Platforms (FreeBSD/NetBSD/OpenBSD/&MacOS;). &kde; 3.3- &kde; 3.5 and even on GNOME with &kde;libs (for &krusader;-2.x) . GCC 2.95 - GCC 5.4 Architecture changes are made by the team only. A final note: always keep in mind a patch might be rejected. Either it has side effects, which we could not fix or it contradicts with the idea behind the patched module. In this sense, a software project differs from, let's say a wiki: a software project has to have someone to make all the final decisions. Otherwise the software will not work. Furthermore: keep in mind that the examination of patches might take time, as we all have private lives. How can I report a bug? Bugs?!?!? Well, ok.... We have an online Bug Tracking System. Using the online bug-tracker helps us have a clear and orderly way to know how many bugs are open, bug priority and follow-ups. It saves us from browsing through the entire &krusader; forum, searching for yesterdays bug. Please use this system. Before reporting a bug, please read the following: Check if the bug is already posted in the online bug list of the Bug Tracking System. If you cannot find this bug mentioned, please submit it into the bug tracker by clicking the Submit New button in the bug-tracker window. Please submit the following issues: the &krusader; version used, the &Linux; distribution + version used, processor type, and as good a description of the problem as you can manage. Thank you for your co-operation! If possible, try to do the same operation with &konqueror; or another &kde; application. If you encounter the same problem then it is possibly a KIO Slaves or &kf5-full; bug, and not a &krusader; bug. &krusader; uses the &kf5; libraries and the KIO Slave for many operations. In some cases you can encounter problems if your distribution is incorrectly configured, please test it first as explained above. How can i send good debug or crash reports? Usually binary packages that are been used by your distribution do not contain debug information. Since we usually only develop and fix &krusader;-git, compile &krusader;-git in debugmode and install it, than check if the bug still exist. $ cmake Install valgrind, a suite of tools for debugging and profiling &Linux; programs. Run Valgrind/&krusader; $ valgrind {foo_path}/krusader The valgrind tool will write to stdout, what really happens. If you could send these information before the crash, it is almost sure, that we may fix or tell you what to do. What to do if the KDEcrashhandler sends no useful backtrace information? Usually binary packages that are been used by your distribution do not contain debug information. Since we usually only develop and fix &krusader;-git, compile &krusader;-git in debugmode and install it, than check if the bug still exist. $ cmake If the KDEKrashhandler still does not provide useful backtrace information, than sometimes a coredump will give better information. Run Krusader, with disabled crashhandler. $ krusader On a crash you will get a .core file, usually in your home directory. Run gdb, the GNU Project Debugger $ gdb corefile krusader Now type bt to get the backtrace and type q to quit gdb. Often the best debug results will be given when using the valgrind tool. Does &krusader; have a mailing list? Yes, currently we have 5 mailing lists. No spam, no bother, just &krusader;. Feel free to subscribe and unsubscribe. Tip. our mailing lists can be browsed online or read with a newsreader, so that you do not even need to subscribe to follow the action on the mailing lists. &krusader;-devel is the developer mailing list (read-only). If you want to follow the development of &krusader; on the cutting edge, this is the list to follow. &krusader;-users is the &krusader; users mailing list. Here you can ask for help and talk with the &krusader; users and developers. Does &krusader; provide news feeds? Yes, we do. Several news feeds in various formats are available. krusader-devel feed, krusader-users feed. Does &krusader; have an IRC channel? Yes, we do. Feel free to talk to the &krusader; Krew and fellow-users via freenode.org servers. The server is irc.freenode.org, the channel is #krusader. Everyone is welcome. How does the &krusader; forum work? In the spirit of freedom of speech, everything that is &krusader; related can be discussed in our forum. It does not matter if you are a newcomer or an advanced user, everyone is welcome. An open source project's greatest strength is derived from getting user feedback. That is why we love to hear what you have to say. With your feedback we can make &krusader; better and better; otherwise, we are not aware of issues and ideas you may have. But please remember the following, so that we can maintain some order in the chaos. If the Documentation, FAQ and &krusader;-devel (please use the search function ) cannot help you, do not hesitate to post on our forum. The &krusader; Krew or the &krusader; community is always available to help you. Please use the search function of the &kde; Forum, your issue may have been previously discussed (this allows us to minimize the double/triple/... postings). If your issue has already been discussed in the past there is a great chance that you will have an instant solution to your problem. If the issue is currently being discussed, you can join in the discussion. Some questions are asked over and over again, that is why we have created this FAQ. This allows us to spend more time developing &krusader;. Thank you for your co-operation! How can I translate &krusader; into my native language? If you are interested in translating the &krusader; GUI or documentation, please contact the KDE translation team of your language. How can I support &krusader;? You can support &krusader; in many different ways. Please send us feedback, bug reports, patches, donations, translations, ... - - - Is there a &MacOS; X port? - - - Yes, there is a &MacOS;-X port - with the help of macports.org , the port is - maintained by Jonas Bähr, - all feedback is welcome. - A recommended native file manager for &MacOS; is - Disk Order (shareware). - - - - - - - Is there a &Windows; port? - - - - No, there was a port but it is unmaintained and unavailable now. A recommended native file manager for &Windows; is - Total Commander (shareware). - If you want to help with porting please join The KDE on Windows Initiative. - Some useful tips on porting can be found in the - INSTALL - file of the &krusader; sources, it contains all latest compilation instructions. - - - - Why is &konqueror; in "midnight commander style" not an OFM? The two panels and a commandline are available, all the other stuff like OFM features and the OFM interaction with the user is missing from this profile. Why should I use an OFM? An Orthodox File Manager (OFM) is much faster than a one panel filemanager and faster than the command line. If you would like to know how &krusader; feels, there is only one way to discover: install it on your computer and use it for a while. If you prefer to waste time and lose productivity, continue to use one panel filemanagers which are based on &Windows; Explorer. Matej Urbančič has written a blog on why OFM is better than a one panel filemanager. diff --git a/doc/features.docbook b/doc/features.docbook index cffa00e8..d91f1cec 100644 --- a/doc/features.docbook +++ b/doc/features.docbook @@ -1,519 +1,518 @@ Features Features The most important features and improvements are highlighted here, it would make this list too long if we were to include all the features and improvements. You will discover even more features in this documentation and in the ChangeLog and NEWS files. <ulink url="http://www.softpanorama.org/OFM/index.shtml">Orthodox File Manager (OFM)</ulink> features Two powerful and easy to use OFM panels. Command Line and optional Terminal emulator below. Strong keyboard orientation and the ability to perform all functions without the mouse. Context-dependent invocation of scripts and programs ⪚ mouse click/&Enter; (execute or open with the associated application), F3 (view) and F4 (edit). User Menu, create your own customized menu. History ⪚ Folder History, Popular &URL;s, &etc; Virtual file systems (VFS) ⪚ for Remote Connections, archives, search results, synchronizer. Powerful internal viewer and editor via kparts supporting almost every file format. Advanced Search module: searching in archives and search content on remote file systems. Several Panel view modes via the Sidebar. &krusader; tools Remote Connections: &FTP;/SAMBA with SFTP/SCP support via KIO Slaves Locate &GUI; frontend Synchronize Directories Mount-Manager Disk Usage Root mode &krusader; features Archive Handling: browsing, unpack, pack, testing. Supported archives: ace, arj, bzip2, deb, gzip, iso, lha, rar, rpm, tar, zip and 7-zip. Checksum Creation and Verification mechanism that supports md5, sha1, sha256, sha224, sha256, sha384, sha512, tiger, whirlpool, cfv, and crc. Calculate occupied space of files and folders, archives and remote filesystems. Directory comparison and filtering. Compare files by content via external diff programs like &kompare;, KDiff3 or xxdiff. Rename files and folders via KRename Completely supports drag'n'drop: drag from &konqueror; straight into a .tar.gz file, from &krusader;'s panel into the trash bin, the desktop or into &konqueror; Preserve date for local targets at copy/move operations. F9 opens a Terminal Window in the current directory. Easy editing of file permissions and ownership and Numeric Permissions. Selection filters used in ⪚ Synchronizer and KruSearcher. Jump-Back MIME type-aware. Tabbed panels and Tabbed Editor/Viewer. Quick search, select and filter File splitter Mouse Gestures Quick Navigation in the Location Toolbar. WhatsThis Help function in favour of tooltips where reasonable. Sync-browsing Customize &krusader; to your own needs Konfigurator &krusader;'s configuration center. Main Toolbar, Actions Toolbar for user actions and bookmarks. Key-bindings Colors Panel profiles Bookmark-Manager Selection Modes Many more features can be configured the way you like. &krusader; Extensions UserActions Color Profiles Key-binding Profiles Download and upload your favourite &krusader; extensions at store.kde.org. New features in the &krusader;-1.80.0 "Final 3rd Stone" release Archive improvements Password support for: arj, ace, rar and zip. Passwords can be stored in Kwallet 7-zip support, by external applications 7z and 7za. Auto-detection support, allowing you to open "hidden archives" (⪚ OpenOffice documents). Packing/unpacking is now in the background. Brief View Many improvements of the UserAction system. Countless usability enhancements, especially in Konfigurator and the heavily reordered menubar. Media button Copy/Move: preserve all attributes (time, owner, group). Dim the colors of the inactive panel. Renaming a filename without extension, single instance mode, start to system tray, check this out in Konfigurator Configurable Atomic extensions, so that extensions like .tar.gz are shown as one part in the Ext Column. Context menu for bookmarks and enable/disable special bookmarks. Restyled MenuBar Terminal emulator enhancements bringing new functions, new usages and new look. Synchronizer enhancements and parallel threads for slow &FTP; servers. Single instance mode, start to system tray Context menu for permanent bookmarks. Full support for ACL permissions, like properties, preserve attributes, synchronizer and other. Searcher-results, Locate-results, Synchronizer-results: support for dragging items and copy to clipboard (&Ctrl;C). Many bug fixes. New features in the &krusader;-1.90.0 "Power Stone" release Last release for &kde; 3.x with a big collection of Useractions. New features in the &krusader;-2.0.0 "Mars Pathfinder" release The first release for the &kde; 4.x series &krusader; works on &Windows;! (But not so useful and powerful yet as under &Linux;) Queue manager! Five methods in the panel! New features in the &krusader;-2.1.0-beta1 "Rusty Clutch" release Fast text/hex viewer for huge filesizes. Locked tabs. Queued packing / unpacking. Better trash integration. The quick search, select and filter bar supports regular expressions for matching files. New features in the &krusader;-2.5.0 "Clear Skies" release Ported to &kf5-full;. The new Quickfilter bar with three different modes to operate: select, search and filter. Reworked Queue Manager (JobMan) and the new Job Toolbar. New features in the &krusader;-2.7.0 "Peace of Mind" release Quick Search in Bookmark menu. Pinned tabs. Tooltip with file information when you hover a file name. Extended options for Tree Panel at the Side Bar. - If you are using a development or - Git version, it is possible that the latest + If you are using a development or &git; version, it is possible that the latest new features are not yet in the "The &krusader; Handbook". Please read the Changelog file online or in the &krusader; sources to find out more about the new features. For a brief description, please read the NEWS file online or in the &krusader; sources. User feedback and Bug reports are always welcome! diff --git a/doc/help.docbook b/doc/help.docbook index 88a52037..a308d3a4 100644 --- a/doc/help.docbook +++ b/doc/help.docbook @@ -1,119 +1,104 @@ Help &krusader; Help Here is your opportunity to contribute to the &krusader; project. There are things that need to be done, but cannot be done by us. If you feel you can help, do not hesitate to contact us; every OpenSource can use some help. Please also check the contribute donate &URL; page on our website for more recent information. Thanks! To get contributor account and commit changes to &krusader; by yourselves you should follow this tutorial. Some useful advices on using &kde; Git can be found here. It is a good practice to use review board for the non-trivial patches. Documentation Help is needed (we are looking for documentation writers) for keeping the &krusader; documentation up to date. The draft explanation of new features is done by the developers on the krusader-devel mailing list, but we need editors to add this information in the handbook. By playing with the new features these editors can give valuable information to the developers for making the new features even better! &krusader; Extensions Please upload your favourite extensions at store.kde.org, so that they become available for the &krusader; community. Maybe they will be shipped by default with &krusader; at the next release :-)). Spread the Word &krusader; If you like &krusader;, let people know! Write articles and reviews for internet or print publications. Encourage your friends to give &krusader; a try. Participate in forums to help others in the community. GUI Translations &krusader; is available in many languages, but sometimes translations do need an update or translations to new languages are always welcome. If you are interested in translating the &krusader; GUI, please contact the &kde; translation team of your language. Documentation Translations If you are interested in translating this &krusader; documentation, please contact the &kde; translation team of your language. Donations Actually, we had not considered donations, until users asked us for a way to Donate to the project. &krusader; is, and always will be free, in all the terms of the GNU Public License. Packagers We are always in need of packagers for different distro rpm's, deb's, etc. All help is welcome. - - Users' feedback for the - &krusader; &MacOS; X port - - There is a &MacOS;-X port - with the help of macports.org , the port was - maintained by Jonas Bähr, - all feedback is welcome. - FAQ If you have a question that is missing in the FAQ, we would like to hear it. Rate &krusader; On some websites like freshmeat.net or linux-apps.com you can give a rate, if you like &krusader; go to one of these sites and rate &krusader;, thanks. Others Feedback, Bug reports, patches, &etc; are always welcome! An open source project's greatest strength is derived from getting user feedback. diff --git a/doc/index.docbook b/doc/index.docbook index bc2a1713..7b665c62 100644 --- a/doc/index.docbook +++ b/doc/index.docbook @@ -1,371 +1,369 @@ - ]> The &krusader; Handbook Davide Gianforte Developer
davide@gengisdave.org
Toni Asensi Esteve Developer
toni.asensi@kdemail.net
Alexander Bikadorov Developer
alex.bikadorov@kdemail.net
Martin Kostolný Developer
clearmartin@gmail.com
Nikita Melnichenko Developer
nikita+kde@melnichenko.name
Yuri Chornoivan Documentation
yurchor@ukr.net
Shie Erlich Author and initial Handbook author (retired)
erlich@users.sourceforge.net
Rafi Yanai Author and initial Handbook author (retired)
yanai@users.sourceforge.net
Csaba Karai Developer (retired)
ckarai@users.sourceforge.net
Heiner Eichmann Developer (retired)
h.eichmann@gmx.de
Jonas Bähr Developer (retired)
jonas.baehr@web.de
Václav Jůza Developer (retired)
vaclavjuza@seznam.cz
Simon Persson Developer (retired)
simon.persson@mykolab.com
Jan Lepper Developer (retired)
jan_lepper@gmx.de
Andrey Matveyakin Developer (retired)
a.matveyakin@gmail.com
Dirk Eschler Webmaster (retired)
deschler@users.sourceforge.net
Frank Schoolmeesters Documentation and Marketing coordinator (retired)
frank_schoolmeesters@yahoo.com
Richard Holt Documentation and Proofing (retired)
richard.holt@gmail.com
Matej Urbančič Marketing and Product Research (retired)
matej.urban@gmail.com
2000 2001 2002 2003 Rafi Yanai Shie Erlich 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 Krusader Krew Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.1 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts, and with no Back-Cover Texts. A copy of the license is included in the &krusader; sources. 2018-08-12 2.7.1 &krusader; is an advanced, twin-panel (commander-style) file-manager for Plasma and other desktops in the *nix world KDE krusader commander filemanager twinpanel linux file manager dual pane linux-commander kde-commander &help; &editors-note; &introduction; &features; &user-interface; &basic-functions; &advanced-functions; &menu-commands; &keyboard-commands; &mouse-commands; &krusader-tools; &konfigurator; &faq; &credits-and-license; - &installation; &configuration-files; &useraction-xml; &release-overview; &glossary; &documentation.index; diff --git a/doc/installation.docbook b/doc/installation.docbook deleted file mode 100644 index b0aa9052..00000000 --- a/doc/installation.docbook +++ /dev/null @@ -1,727 +0,0 @@ - - - Installation of Krusader - - Installation - - - Requirements - In order to successfully use the most recent - &krusader;, you need &kf5; - >= 5.18 -Required &kde; version: - - - &krusader; v1.01: &kde; - 2 - - - &krusader; v1.02 - 1.40: &kde; - 3.0 - &kde; 3.2 - - - &krusader; 1.40: prefers &kde; - 3.2 (otherwise all features will not be available) - - - &krusader; v1.50 - v1.51: &kde; - 3.2 - &kde; 3.3 (Konfigurator crash on - &kde; 3.4) - - - &krusader; v1.60.0 - v1.70.0: - &kde; 3.3 - &kde; 3.5 - - - &krusader; 1.70.x: prefers - &kde; >= 3.4 (otherwise all - features will not be available) - - - &krusader; 1.80.0: &kde; 3.4 - - &kde; 3.5 - - - &krusader; 1.90.0: &kde; 3.2 - - &kde; 3.5 - - - &krusader; v2.4.x: &kde; 4.x - - - &krusader; v2.5.x: &kf5-full; - - - Platforms: - - - All POSIX - (&Linux;/BSD/&UNIX;-like OSes), - &Solaris; - - - All BSD Platforms - (FreeBSD/NetBSD/OpenBSD/&MacOS;) - - - - In order to handle archives, checksums and other utilities they must be configured in our - configuration tool. - When running &krusader; for the first time the available utilities will be autodetected, and - a report will be shown in the first lanch wizard. Afterwards additional utilities can be - added/removed/changed. - A package of popular (un)packers, &krusader; - itself and add-ons can be found on the - &krusader; download page. - For more requirements, see below. Have a look at the - FAQ section as well. - - - Obtaining &krusader; - The latest information about &krusader; can be - found on the Krusader website . - - &krusader; Downloads - It is recommended to use the &krusader; package - that is provided by your distribution. - Distrowatch.com is a great resource to check - the availability. If your distribution does not offer - &krusader;, please contact the creators of your - distribution and ask them to provide a &krusader; - package - The latest version, as well as the older versions, can - be found on the &krusader; download page (current version) and on the - Sourceforge mirrors (outdated versions). It contains the source tarballs, - RPM and DEB packages to whatever distro the - &krusader;-Krew is using and packages build by - &krusader; users and third parties. - Distributions who provide &krusader;: - - - &SuSE; - - - Fedora via - # dnf install krusader will do the job. - - - Debian, on our - &krusader; download page you might find more recent - DEB packages. Note: usually Debian packages - work also on distributions that are "based on - Debian", and some of these provide their own - (incompatible) packages. - Ubuntu/Kubuntu, - Knoppix - 4.x DVD, Kanotix, &etc; - - - Mageia via the contrib repository - # urpmi krusader will do the job. - - - Gentoo. - - - Arch Linux, - Frugalware Linux, - PCLinuxOS, - ALT Linux. - - - FreeBSD, the port was - maintained by - Heiner Eichmann. - - - NetBSD, - Lunar Linux - ,Ark Linux, OpenLX. - - - More distributions can be found with - Distrowatch.com. - - - Use the installation tools included in your - distro to install the &krusader; package. You - might need an internet connection if &krusader; is - not included on the &CD; or DVD. There are - probably other distributions which include - &krusader;. If you know of one, please send - feedback so that we can include it on the distrolist. - Others - - - Slackware txz binaries can usually be - found ion the Slackware package repositories. - - - There is a &MacOS;-X port. - - - - - Search engines - - - You can also find packages on &Linux; - software archives such as freshmeat.net. - - - If you can not find a package for your distribution, - we recommend searching for it with - rpmfind, rpmpbone or - rpmseek. - - If you enjoy using &krusader;, we - would appreciate it if you went to one of these sites and - rated it. - If you still can not find a package, follow the - installation procedure on how to compile - &krusader; from source. This very thorough HowTo - describes the process in such detail that even newcomers - should not have any problems. - - - Version Scheme - A new version scheme has been used since - &krusader;-1.60.0 - - - First digit - the major version - - - Second digit(s) - percentage of features completed - for this major version - - - Third digit(s) - bugfixes. - - In essence, releasing - &krusader;-1.60.0 means that we believe that - &krusader; is about 60% done with all the features - we had scheduled for the 1.x.x series. Series up to 2.4.x are - &kde; 4.x releases. 2.5.x series are the releases for &kf5-full;. Hopefully, it is easy to - understand. - - - Stable Version - - krusader-x.xx.tar.gz - - - &krusader; is released under the - &GNU; General Public License (GPL). This means that THE PROGRAM IS - PROVIDED "AS IS" WITH NO WARRANTY OF ANY KIND, even when it - is marked as a stable release. - - - - Development Version (beta release) - - krusader-x.xx-betax.tar.gz - - Before every stable release we release at least one - development version in order to hunt down the bugs. - - These releases are beta releases and will probably - contain some bugs. - - If you are using a development or - Git version, it is possible that the latest - new features are not yet in the "The Krusader Handbook". - Please read the - Changelog - file online or in the &krusader; - sources to find out more about the new features. - For a brief description, please read the - NEWS - file online - or in the &krusader; sources. - User feedback and - Bug reports are always welcome! - - The beta release has 3 goals: - - - Apply a feature-freeze until the stable is released, - only bugs will be fixed. New features have to wait until - the stable is released. - - - Obtain feedback from &krusader; users so - that we can fix the bugs. - - - Give translators time to update the translations for - the coming stable release. - - - - - Git - - Git is used for our sourcecode repository. - It is also possible to Browse the Git Repository. - To check out the latest development &krusader; 2.x - for &kf5-full; from Git: - $ git - - - - Older Releases - If you are looking for older releases we recommend the - Sourceforge mirrors, available from our project - page. - - - - - Krusader installation instructions - - Please read the - INSTALL - file of the Krusader sources, it contains all latest installation instructions. - - - - From version &krusader;-2.5.0 and higher is &kf5-full; only. - - - krusader_version.tar.gz is the supposed name of the krusader tarball (it will be probably a different one ;) - -You can download the latest available &krusader;-2.x from Git. - - - -Krusader dependencies -The next packages are needed to run the Krusader binary. - - - - c libraries - - - plasma-framework libraries (&kde; Frameworks core libraries and binaries for &kf5-full; applications) - - - libqt5dbus5 (&Qt; 5 D-Bus module) - - - libqt5xml5 (&Qt; 5 &XML; module) - - - libqt5core5 (&Qt; 5 core module) - - - libqt5gui5 (&Qt; 5 &GUI; module) - - - libqt5printsupport5 (&Qt; 5 print support module) - - - - - - - -Suggested packages -These packages are optional but they will make &krusader; much more powerful and useful. - -The next packages are the names that Debian/Ubuntu uses, other Linux -distros will probably use similar names. - - - - arj: archiver for .arj files - - - ark: graphical archiving tool by KDE - - - bzip2: high-quality block-sorting file compressor - utilities - - - cpio: GNU cpio -- a program to manage archives of files - - - kdiff3: compares and merges 2 or 3 files or directories - - - OR kompare: a KDE GUI for viewing differences between files - - - OR xxdiff: a graphical file and directories comparison and merge tool - - - kmail: KDE Email client - - - okteta: KDE hex editor - - - konsole: X terminal emulator by KDE - - - krename: Powerful batch renamer by KDE - - - lha: lzh archiver - - - md5deep: versatile file checksum creator and verifier - - - cfv: versatile file checksum creator and verifier - - - p7zip: 7zr file archiver with high compression ratio - - - rpm: Red Hat package manager - - - unace: extract, test and view .ace archives - - - unrar: Unarchiver for .rar files (non-free version) - - - OR unrar-free: Unarchiver for .rar files - - - OR rar: Archiver for .rar files - - - unzip: De-archiver for .zip files - - - zip: Archiver for .zip files - - - - - - - -Compilation requirements -The next packages are needed for compiling Krusader, -if you only run a Krusader binary you do not need these packages. - - - - gcc (The GNU C compiler) - - - g++ (The GNU C++ compiler) - - - cmake (A cross-platform, open-source make system) - - - zlib1g-dev: (library for implementing the deflate compression method found in gzip and PKZIP) - - - gettext (contains msgfmt) - - - plasma-framework-dev (installs many development libraries for &kf5;) - - - kio-dev - - - - libkf5archive-dev - - - libkf5parts-dev - - - libkf5wallet-dev - - - libkf5xmlgui-dev - - - kdoctools-dev - - - - - - - - - - - Installing on &Linux; and &BSD; platforms - - - Please read the - INSTALL - file of the Krusader sources, it contains all latest installation instructions. - - - --DQT_INCLUDES=/usr/share/qt5/include is the location of the &Qt; 5 includes - --DCMAKE_INSTALL_PREFIX=/usr/ is the location where Krusader will be - installed with the make command. - -Another example is: -DCMAKE_INSTALL_PRFIX=/opt/krusader - to install the compiled Krusader in an other directory to not overwrite - the Krusader version installed by your package manager. - - - Please use sudo instead of su -c if you are using Ubuntu-based systems. - - - - - $ tar -xzvf - $ cd - $ mkdir - $ cd - $ cmake - $ make - $ su - - - -Uninstall - - - $ su -c "make uninstall" - - - - - - Installing on the &MacOS;-X platform - - - Please read the - INSTALL - file of the Krusader sources, it contains all latest installation instructions. - - -With &kde;-4 Krusader runs natively on &MacOS;-X, using its Aqua user interface (No more X11 needed!). - -With the help of macports.org , &krusader; is ported to &MacOS;-X, - the port was maintained by Jonas Bähr. - A portfile is provided. - - - - $ sudo port install krusader - - - - - - - - - - Starting &krusader; - Type - - krusader - (lower case) at a command prompt. You can create - shortcut on your desktop or create an entry in the - menu. Read the previous page and the - FAQ if &krusader; does not - start. - When &krusader; is started from the - command line, various options can be specified to modify its - behavior. - - $ krusader - - - Do not worry about the messages you get in the - &konsole;. These messages are log messages that - can be used for debugging &krusader;. - - You can also use - &Alt; - F2 to open the Run Command dialog - box, type - - krusader - (lower case) and press &Enter; or click - on the - Run button. - If &krusader; is installed by an RPM or DEB - package then usually &krusader; can be started from - the &kmenu;. Click on the - application launcher button and choose - - - Applications - Utilities - &krusader; - - . - - Command-line options: - - - - - <path> - - - - start left panel at - <path> - - - - - - - - <path> - - - - start right panel at - <path> - - - - - - - - <path1>,<path2>,<path3> - - - - start left panel at - <path1>,<path2>,<path3>, - with tabs. - - - - - - - - <panel-profile> - - - - load a - panel-profile on - startup (this overrides the - default startup - profile). - - - - - Examples: - $ krusader --left=<path> --right=<path> - $ krusader --left=/mnt/cdrom --right=ftp://downloads@myserver.net - $ krusader --left=<path1>,<path2> --right=<path1>,<path2>,<path3> - $ krusader --profile <panel-profile> - $ krusader --profile ftp-managment - - The standard &Qt; and &kf5; command-line options are available. - - - Other command-line options: - - - - - - - Show the authors names - - - - - - - - - - Show license information - - - - - - - Configuring &krusader; - When you run &krusader; for the first time, - the &krusader; configuration module - Konfigurator will show up - and allow you to configure &krusader; as well as - detect installed packers and tools. You can always run - Konfigurator again from the - Settings menu. - - - Making &krusader; the default file - manager - To make &krusader; the default file manager in - Gnome, click here for more information. - - To make &krusader; the default file manager in - &plasma;, click here for more information. - - - - diff --git a/doc/keyboard-commands.docbook b/doc/keyboard-commands.docbook index 36b72f22..153d8b5a 100644 --- a/doc/keyboard-commands.docbook +++ b/doc/keyboard-commands.docbook @@ -1,2015 +1,2013 @@ Keyboard Commands Commands Keyboard Keyboard Usage In this chapter you will learn how to use the keyboard effectively, because most operations can be done more quickly by keyboard than with the mouse. It will take some time to learn the Key-Bindings, but mastering them saves you a lot of time. Please note that &krusader; can use Key-binding Profiles to swap easily to other Key-binding setups, ⪚ of other commanders, or you can create your own key-bindings. - After - - starting &krusader;, the keyboard action can + After starting &krusader;, the keyboard action can begin. Use &Ctrl;L to jump to the Location Toolbar where you can type the desired directory. After &Ctrl;Down arrow you are in the Terminal emulator and you can type any command you desire. Use &Ctrl;Up arrow to jump back to the active panel. If you want to jump to a file or directory that starts with f, then simply press f on the keyboard to use the search bar. Use the &Enter; key to execute the file or to open a directory that has the focus. Be sure to remember the Function Keys - F3 to View, F4 to Edit, F5 to Copy, &Alt;&Shift;U to Unpack, &etc; You can also perform several operations with the Folder tabs, including several selection operations. And at the end you can close &krusader; with F10. Key-Bindings Key-Bindings Commands Keyboard Most of the key-bindings (shortcuts) are configurable in the Settings Configure Shortcuts menu, if you like to use other key-bindings then the default ones. You can even configure more actions to a Key-Binding (for the actions that do not have a key-binding set by default). Please note that some key-bindings are not &krusader; key-bindings (⪚ &plasma; key-bindings). The key-bindings that &krusader; uses by default are listed below. Function (FN) Keys These are the Key-Bindings of the FN Keys Bar. These Key-Bindings are configurable since version 1.51. F1 Help F2 Rename files. F3 View files. F4 Edit files. F5 Copy files. F6 Move files F7 Create a new directory. F8 Delete (or move to Trash) files. F9 Terminal. F10 Quit &krusader; &Shift; keys &Shift; F1 What's this? &Shift; F2 Multi-rename (Krename). &Shift; F3 Enter an &URL; to view. &Shift; F4 Edit new file. &Shift; F5 Copy by queue. &Shift; F6 Move by queue. &Shift; F10 View all files. &Shift; F12 Custom view files. &Shift; Left Arrow Change to left folder tab. &Shift; Right Arrow Change to right folder tab. &Alt; keys &Alt; + Select All. &Alt; - Unselect All. &Alt; * Invert Selection. &Alt; . Show/Hide hidden (dot) files. &Alt; / MountMan. &Alt; ` User Menu &Alt; Home Home &Alt; &Enter; Properties. &Alt; Left Arrow Left bookmarks. &Alt; Right Arrow Right bookmarks. &Alt; Down Arrow Sidebar. &Alt; F1..F12 Standard (&plasma;) key-bindings. &Alt;+&Shift; keys &Alt;&Shift; B Brief View &Alt;&Shift; C Compare Directories &Alt;&Shift; D Detailed View &Alt;&Shift; E Test Archive. &Alt;&Shift; K Start Root mode &krusader;. &Alt;&Shift; L Panel profiles. &Alt;&Shift; O Sync panels aka "Equals Button (=)". &Alt;&Shift; P Pack files. &Alt;&Shift; Q Queue Manager &Alt;&Shift; S Disk Usage. &Alt;&Shift; U Unpack files. &Ctrl; keys &Ctrl; B Add bookmark for the current item. &Ctrl; D Open Bookmarksin the active panel. &Ctrl; E Edit file as root (Default Useraction). &Ctrl; F Open Quicksearch bar. &Ctrl; H Open History list in the active panel. &Ctrl; I Open QuickFilter bar. &Ctrl; J A Safari-like Jump-Back. &Ctrl; L Go to the Location Toolbar (origin) as in Firefox and &konqueror;. &Ctrl; M Open media list. &Ctrl; N New Network Connection dialog. &Ctrl; O Select directory dialog to open this directory in the panel. &Ctrl; P Split file. &Ctrl; Q Quit &krusader;. &Ctrl; R Reload (Refresh) panel. &Ctrl; S Search. &Ctrl; U Swap panels (do not swap all folder tabs). &Ctrl; W Close Current tab. &Ctrl; Y Synchronize Directories. &Ctrl; Z Popular URLs. &Ctrl; + Select group. &Ctrl; - Unselect group. &Ctrl; / Open command line history list. &Ctrl; Down arrow Go from the active panel to the command line/terminal emulator. &Ctrl; Up arrow Go from the command line/terminal emulator to the active panel. &Ctrl; Up arrow Go from the active panel to the Location Toolbar. &Ctrl; Home Jump to the Home directory. &Ctrl; Left or Right arrow Focus a file or directory on the left panel, press &Ctrl; Left arrow and the right panel changes: on a file: the right panel gets the same path as the left panel. on a directory: refreshes the right panel with the contents of the directory. For the right panel: press &Ctrl; Right arrow and the left panel will change. &Ctrl;&Backspace; Jump to the Root directory. &Ctrl; PageUp Up one directory. &Ctrl; = Go to the directory from other panel. &Ctrl; Return When media menu is open (un)mounts the highlighted device. &Ctrl;+&Shift; keys &Ctrl;&Shift; D Disconnect remote connection. &Ctrl;&Shift; F Activate search bar to find entries in the active tab. &Ctrl;&Shift; J Set jump back point. &Ctrl;&Shift; L Locate &GUI; frontend. &Ctrl;&Shift; O Move current tab to other side of the window. &Ctrl;&Shift; S Open Quickselect bar. &Ctrl;&Shift; U Swap Sides (also swap all folder tabs). &Ctrl;&Shift; Left arrow Open left media list. &Ctrl;&Shift; Right arrow Open right media list.. &Ctrl;&Shift; Up arrow Open terminal emulator, independently, whether the command line is shown or not. &Ctrl;&Shift; Down arrow Close terminal emulator, independently, whether the command line is shown or not. &Ctrl;+&Alt; keys &Ctrl;&Alt; M Mount (Default Useraction). &Ctrl;&Alt; N New tab. &Ctrl;&Alt; R Toggle the List Panel between horizontal and vertical mode. &Ctrl;&Alt; S Create a new symlink. &Ctrl;&Alt; T Show/hide the embedded terminal. &Ctrl;&Alt; Left Arrow Left History list. &Ctrl;&Alt; Right Arrow Right History list. &Ctrl;&Alt; = Equal Panel Size (Default Useraction). &Ctrl;&Alt;&Shift; N Duplicate a tab. &Ctrl;&Alt;&Enter; Open current folder in a new tab. General &Ctrl; keys &Ctrl; A Select all. &Ctrl; PageDown Move to the lower part in the current directory. &Ctrl; F1..F12 Standard (&plasma;) key-bindings. &Ctrl;&Shift; F1..F12 Standard (&plasma;) key-bindings. Other keys foo Quick search, quick select or quick filter. See this configuration page on how to configure the default mode. Switch between the panels &Enter; On a file: open/execute that file On an archive file: browse the archive as if it was a directory. &Esc; Will make the menu bar lose the focus if it has it. Delete Delete (or move to Trash). &Shift; Delete Delete permanently. Space On a file: toggle the selection of the file down one position without affecting the selection of other files/directories. &Backspace; One directory up. Insert Does the same as the Space key and goes down one position to toggle the next file. Menu Right-click menu. Home Cursor jumps to the top of the list. End Cursor jumps to the last file in the list. Command Line Command Line keybindings. Up arrow and Down arrow Scroll through previously typed commands. &Ctrl; / Open the command line history list. &Ctrl; Up arrow Jump from the command line to the active panel. &Ctrl; Down arrow Jump from the active panel to the command line. &Ctrl;&Enter; Insert current file / directory name without path to current command line position. &Ctrl;&Shift;&Enter; Insert current file / directory with full path name to current command line position. Terminal emulator Terminal emulator keybindings. &Ctrl; F Toggle between normal and full screen Terminal emulator. &Ctrl; V Insert from clipboard. &Ctrl; Up arrow Jump from the Terminal Emulator to the active panel if the Command line is hidden. &Ctrl; Down arrow Jump from the active panel to the Terminal Emulator if the Command line is hidden. &Ctrl;&Shift; Up/Down arrow Always focus/unfocus the Terminal Emulator independently whether the Command Line is shown or not. &Shift; Insert Insert from clipboard. Synchronizer Synchronizer keybindings. &Ctrl; W Reverse direction &Alt; Down arrow Exclude &Alt; Up arrow Restore original task &Alt; Left arrow Copy to left &Alt; Right arrow Copy to right &Alt; Delete Mark for delete Default Useractions Default UserActions keybindings provided by &krusader;. &Ctrl; E Edit a file as root. &Ctrl;&Alt; C Copy current item to clipboard. &Ctrl;&Alt; M Mount a new file system. &Ctrl;&Alt; = Equal panel-size. Meta A Enqueue in &amarok;. Meta 1 Sort by Name. Meta 2 Sort by extension. Meta 3 Sort the active panel by size. Meta 4 Sort by modified. Meta F5 Backup current file (Default Useraction). Other Key-bindings Selecting files KrViewer Disk Usage Locate &GUI; frontend &systemsettings; -> Common Appearance and Behavior -> Shortcuts and Gestures UserActions configurable key-bindings diff --git a/doc/profiles.docbook b/doc/profiles.docbook index 6defb547..4fd9c48f 100644 --- a/doc/profiles.docbook +++ b/doc/profiles.docbook @@ -1,72 +1,70 @@ Profiles Profiles With profiles you can save and restore your favorite settings. Several features support profiles, you can have ⪚ different panel profiles (work, home, remote connections, &etc;), search profiles, synchroniser profiles, &etc; Panel Profiles A panel profile contains the following: all the tab paths (left or right), the current tab (left or right) and the active panel (left or right). All this information is stored in the krusaderrc file. You can have several panel profiles, ⪚ file management, &FTP; management, home, work, &etc; The panel profile can be saved and restored in the Window menu. The default startup profile will be used when starting &krusader;, but you can - override it with a - command-line - option. + override it with a command-line option. Color Profiles Colormaps can be saved and restored with Color Profiles. Key-binding Profiles Keymaps can be saved and restored with Key-binding Profiles. Search Profiles If you regularly perform the same search operation, you can save the search settings (⪚ include files, exclude files, &etc;) in a Search Profile. Synchronizer Profiles If you regularly perform the same synchronize operation, you can save the synchronize settings in a Synchronizer Profile.