diff --git a/doc/configuration-files.docbook b/doc/configuration-files.docbook --- a/doc/configuration-files.docbook +++ b/doc/configuration-files.docbook @@ -27,9 +27,7 @@ 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 diff --git a/doc/editors-note.docbook b/doc/editors-note.docbook --- a/doc/editors-note.docbook +++ b/doc/editors-note.docbook @@ -53,8 +53,7 @@ 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 diff --git a/doc/faq.docbook b/doc/faq.docbook --- a/doc/faq.docbook +++ b/doc/faq.docbook @@ -22,7 +22,9 @@ 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: @@ -103,267 +105,27 @@ - - - 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. - - - - - - @@ -373,8 +135,8 @@ 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 @@ -422,90 +184,6 @@ - - - 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 @@ -521,30 +199,6 @@ - - - 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. -###################################################### - - - - - @@ -1328,39 +982,6 @@ - - - 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 diff --git a/doc/features.docbook b/doc/features.docbook --- a/doc/features.docbook +++ b/doc/features.docbook @@ -504,8 +504,7 @@ - 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 diff --git a/doc/help.docbook b/doc/help.docbook --- a/doc/help.docbook +++ b/doc/help.docbook @@ -81,21 +81,6 @@ 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 diff --git a/doc/index.docbook b/doc/index.docbook --- a/doc/index.docbook +++ b/doc/index.docbook @@ -77,7 +77,6 @@ - @@ -356,7 +355,6 @@ &konfigurator; &faq; &credits-and-license; - &installation; &configuration-files; diff --git a/doc/installation.docbook b/doc/installation.docbook deleted file mode 100644 --- 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 --- a/doc/keyboard-commands.docbook +++ b/doc/keyboard-commands.docbook @@ -32,9 +32,7 @@ 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 diff --git a/doc/profiles.docbook b/doc/profiles.docbook --- a/doc/profiles.docbook +++ b/doc/profiles.docbook @@ -40,9 +40,7 @@ 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