diff --git a/INSTALL b/INSTALL index b1a1f772..2354ac58 100644 --- a/INSTALL +++ b/INSTALL @@ -1,320 +1,321 @@ --------------------------------------------------- Krusader installation instructions for KDE Plasma 5 --------------------------------------------------- --- Note Krusader-2.5.0 versions and higher are for KDE Plasma 5 only and will not work anymore on KDE Plasma 4 or 3. --- Supported Platforms * All POSIX (Linux®/BSD/UNIX®-like OSes), Solaris™ At the moment, there are no KDE Plasma 5 ports for Windows or Mac® OS X, which means these platforms are not supported. ======================================== Installation on Linux® and BSD platforms ======================================== --- Krusader dependencies The next packages are needed when running the Krusader binary. This is a list of the package names that Kubuntu/Ubuntu 16.04 use, other Linux distros will probably use similar names: - plasma-framework Plasma Runtime components - libc6 GNU C Library: Shared libraries - libgcc1 GCC support library - 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 - libstdc++6 The GNU Standard C++ Library v3 - zlib1g compression library - runtime --- Suggested packages The next packages are optional but they will make Krusader much more powerful and useful. This is a list of the package names that Debian/Ubuntu/Kubuntu 16.04 use, other Linux distros will probably use similar names: - arj archiver for .arj files - ark archive utility for KDE - bzip2 high-quality block-sorting file compressor - utilities - cpio GNU cpio -- a program to manage archives of files - kate Powerful Text Editor - kmail KDE Email client - kdiff3 compares and merges 2 or 3 files or directories (at moment of writing: no version available) or kompare file difference viewer or xxdiff a graphical file and directories comparison and merge tool - konsole X terminal emulator - krename Powerful batch renamer for KDE (at moment of writing: still based on KDE4) - lhasa lzh archiver - md5deep enhanced message digest calculator or 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 the Krusader sourcecode, if you only run the Krusader binary you don't need to install these packages. - build-essential a group of packages needed to compile source code - cmake a cross-platform, open-source make system - extra-cmake-modules extra cmake modules for compiling KDE Frameworks - qt5-default development files for the Qt5 libraries +- gettext GNU Internationalization utilities - plasma-framework-dev development files for plasma-framework The following packages should install (through dependencies) all the packages you need to compile a KDE 5 software - kio-dev resource and network access abstraction - libkf5archive-dev development files for karchive - libkf5parts-dev development files for kparts - libkf5wallet-dev development files for kwallet-framework - libkf5xmlgui-dev user configurable main windows - kdoctools-dev development files for kdoctools5 --- Krusader development download Krusader is developed in KDE Extragear. If someone wants to download and use the latest available Krusader sourcecode with git: $ git clone http://anongit.kde.org/krusader Otherwise, if someone wants to use a .tar.gz version: $ tar xvf krusader-xx.xx.tar.gz --- Some CMake options. Cmake execution -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. -DCMAKE_CXX_FLAGS="-O2 -fPIC" this flag is required if you have a 64 bit system -DQT_PLUGIN_INSTALL_DIR= many system force this path to keep kde4 plugins separated from the kde5 ones -DENABLE_SYNCHRONIZER=OFF disables building the Synchronizer module. This module caused data loss, now it is fixed, but we treat it as the thin ice. CMake may be executed this way: $ mkdir krusader-build $ cd krusader-build $ cmake ../krusader -DCMAKE_INSTALL_PREFIX=/usr/ -DCMAKE_C_FLAGS="-O2 -fPIC" -DCMAKE_CXX_FLAGS="-O2 -fPIC" Note: In this document there's an appendix 1 that may help. --- Compilation and installation Compilation will take about 5 to 10 minutes depending on your CPU speed. Execute: $ make # At the beginning of the following command: `sudo` must be added if Kubuntu, Ubuntu, Debian, or similar is being used $ su -c "make install" Note: In this document there's an appendix 2 that may help. --- To achieve that Krusader uses another language There is a list of translation files in the [10n.kde.org Krusader page](https://l10n.kde.org/stats/gui/trunk-kf5/po/krusader.po/index.html). In that list anyone can look for his desired translation file, hover the mouse cursor over its link, see its tooltip to look up the appropriate LANGUAGE_CODE (which is shown between parentheses, e.g. if on the tooltip it's seen "German (de)" that means that LANGUAGE_CODE is: de), click on the link (in order to download the proper krusader.po file), and execute: # Transform the downloaded file msgfmt krusader.po -o krusader.mo # At the beginning of the following command: `sudo` must be added if Kubuntu, Ubuntu, Debian, or similar is being used. # In the following command, the text XXXXXXX must be replaced by the LANGUAGE_CODE that was previously found su -c "cp -a krusader.mo /usr/share/locale/XXXXXXX/LC_MESSAGES/" --- Execution Finally, Krusader can be executed this way: $ krusader --- Uninstall # At the beginning of the following command: `sudo` must be added if Kubuntu, Ubuntu, Debian, or similar is being used $ su -c "make uninstall" --- Appendix 1 If it can be useful, this is the output of cmake on Kubuntu 15.04: ubuntu@ubuntu-VirtualBox:~/src/krusader/build$ cmake -DCMAKE_INSTALL_PREFIX=/usr .. -- The C compiler identification is GNU 4.9.2 -- The CXX compiler identification is GNU 4.9.2 -- Check for working C compiler: /usr/bin/cc -- Check for working C compiler: /usr/bin/cc -- works -- Detecting C compiler ABI info -- Detecting C compiler ABI info - done -- Check for working CXX compiler: /usr/bin/c++ -- Check for working CXX compiler: /usr/bin/c++ -- works -- Detecting CXX compiler ABI info -- Detecting CXX compiler ABI info - done -- Looking for __GLIBC__ -- Looking for __GLIBC__ - found -- Performing Test _OFFT_IS_64BIT -- Performing Test _OFFT_IS_64BIT - Success -- Found KF5Archive: /usr/lib/x86_64-linux-gnu/cmake/KF5Archive/KF5ArchiveConfig.cmake (found version "5.9.0") -- Found KF5Bookmarks: /usr/lib/x86_64-linux-gnu/cmake/KF5Bookmarks/KF5BookmarksConfig.cmake (found version "5.9.0") -- Found KF5Codecs: /usr/lib/x86_64-linux-gnu/cmake/KF5Codecs/KF5CodecsConfig.cmake (found version "5.9.0") -- Found KF5Completion: /usr/lib/x86_64-linux-gnu/cmake/KF5Completion/KF5CompletionConfig.cmake (found version "5.9.0") -- Found KF5CoreAddons: /usr/lib/x86_64-linux-gnu/cmake/KF5CoreAddons/KF5CoreAddonsConfig.cmake (found version "5.9.0") -- Found KF5Config: /usr/lib/x86_64-linux-gnu/cmake/KF5Config/KF5ConfigConfig.cmake (found version "5.9.0") -- Found KF5DocTools: /usr/lib/x86_64-linux-gnu/cmake/KF5DocTools/KF5DocToolsConfig.cmake (found version "5.9.0") -- Found Gettext: /usr/bin/msgmerge (found version "0.19.2") -- Found PythonInterp: /usr/bin/python (found version "2.7.9") -- Found KF5I18n: /usr/lib/x86_64-linux-gnu/cmake/KF5I18n/KF5I18nConfig.cmake (found version "5.9.0") -- Found KF5IconThemes: /usr/lib/x86_64-linux-gnu/cmake/KF5IconThemes/KF5IconThemesConfig.cmake (found version "5.9.0") -- Found KF5ItemViews: /usr/lib/x86_64-linux-gnu/cmake/KF5ItemViews/KF5ItemViewsConfig.cmake (found version "5.9.0") -- Found KF5KIO: /usr/lib/x86_64-linux-gnu/cmake/KF5KIO/KF5KIOConfig.cmake (found version "5.9.0") -- Found KF5Notifications: /usr/lib/x86_64-linux-gnu/cmake/KF5Notifications/KF5NotificationsConfig.cmake (found version "5.9.0") -- Found KF5Parts: /usr/lib/x86_64-linux-gnu/cmake/KF5Parts/KF5PartsConfig.cmake (found version "5.9.0") -- Found KF5Solid: /usr/lib/x86_64-linux-gnu/cmake/KF5Solid/KF5SolidConfig.cmake (found version "5.9.0") -- Found KF5TextWidgets: /usr/lib/x86_64-linux-gnu/cmake/KF5TextWidgets/KF5TextWidgetsConfig.cmake (found version "5.9.0") -- Found KF5Wallet: /usr/lib/x86_64-linux-gnu/cmake/KF5Wallet/KF5WalletConfig.cmake (found version "5.9.0") -- Found KF5WidgetsAddons: /usr/lib/x86_64-linux-gnu/cmake/KF5WidgetsAddons/KF5WidgetsAddonsConfig.cmake (found version "5.9.0") -- Found KF5WindowSystem: /usr/lib/x86_64-linux-gnu/cmake/KF5WindowSystem/KF5WindowSystemConfig.cmake (found version "5.9.0") -- Found KF5XmlGui: /usr/lib/x86_64-linux-gnu/cmake/KF5XmlGui/KF5XmlGuiConfig.cmake (found version "5.9.0") -- Found KF5: success (found version "5.9.0") found components: Archive Bookmarks Codecs Completion CoreAddons Config DocTools I18n IconThemes ItemViews KIO Notifications Parts Solid TextWidgets Wallet WidgetsAddons WindowSystem XmlGui -- Looking for include file attr/libattr.h -- Looking for include file attr/libattr.h - found -- Looking for include file sys/xattr.h -- Looking for include file sys/xattr.h - found -- Looking for include file sys/acl.h -- Looking for include file sys/acl.h - found -- Looking for include file acl/libacl.h -- Looking for include file acl/libacl.h - found -- Found ACL support: /usr/lib/libacl.so;/lib/x86_64-linux-gnu/libattr.so -- libkonq library not found -- /home/ubuntu/src/krusader/krusader: skipped subdir $(KRJSDIR) -- Found ZLIB: /usr/lib/x86_64-linux-gnu/libz.so (found version "1.2.8") -- -- The following REQUIRED packages have been found: * ECM (required version >= 1.1.0) * Qt5Core * Qt5Gui * Qt5DBus * Qt5Widgets * Qt5PrintSupport * Qt5Xml * Qt5 * KF5Archive * KF5Bookmarks * KF5Codecs * KF5Completion * KF5CoreAddons * KF5Config * KF5DocTools * Gettext * PythonInterp * KF5I18n * KF5IconThemes * KF5ItemViews * KF5KIO * KF5Notifications * KF5Parts * KF5Solid * KF5TextWidgets * KF5Wallet * KF5WidgetsAddons * KF5WindowSystem * KF5XmlGui * KF5 -- Configuring done -- Generating done -- Build files have been written to: /home/ubuntu/src/krusader/build --- Appendix 2 If it can be useful, this is a (partial) output of make on Kubuntu 15.04: ubuntu@ubuntu-VirtualBox:~/src/krusader/build$ make [ 1%] Automatic moc for target krusader Generating moc_actionsbase.cpp Generating moc_kractions.cpp Generating moc_krslots.cpp Generating moc_krtrashhandler.cpp Generating moc_krusader.cpp Generating moc_krusaderview.cpp Generating moc_panelmanager.cpp Generating moc_paneltabbar.cpp Generating moc_tabactions.cpp [ 1%] Built target krusader_automoc [ 1%] Automatic moc for target ActionMan Generating moc_actionman.cpp Generating moc_actionproperty.cpp Generating moc_addplaceholderpopup.cpp Generating moc_useractionlistview.cpp Generating moc_useractionpage.cpp [ 1%] Built target ActionMan_automoc [ 1%] Generating ui_actionproperty.h Scanning dependencies of target ActionMan [ 1%] Building CXX object krusader/ActionMan/CMakeFiles/ActionMan.dir/actionman.cpp.o [ 2%] Building CXX object krusader/ActionMan/CMakeFiles/ActionMan.dir/actionproperty.cpp.o ... ... ... [ 95%] Built target kio_krarc Scanning dependencies of target kio_iso_automoc [ 95%] Automatic moc for target kio_iso [ 95%] Built target kio_iso_automoc Scanning dependencies of target kio_iso [ 96%] Building CXX object iso/CMakeFiles/kio_iso.dir/kisodirectory.cpp.o [ 96%] Building CXX object iso/CMakeFiles/kio_iso.dir/kisofile.cpp.o [ 97%] Building CXX object iso/CMakeFiles/kio_iso.dir/qfilehack.cpp.o [ 97%] Building CXX object iso/CMakeFiles/kio_iso.dir/kiso.cpp.o [ 98%] Building CXX object iso/CMakeFiles/kio_iso.dir/iso.cpp.o [ 98%] Building C object iso/CMakeFiles/kio_iso.dir/libisofs/isofs.c.o [ 99%] Building CXX object iso/CMakeFiles/kio_iso.dir/kio_iso_automoc.cpp.o Linking CXX shared library libkio_iso.so [ 99%] Built target kio_iso Scanning dependencies of target doc-index-cache-bz2 [100%] Generating index.cache.bz2 [100%] Built target doc-index-cache-bz2 Scanning dependencies of target doc-krusader-1 [100%] Generating krusader.1 Note: Writing krusader.1 [100%] Built target doc-krusader-1 diff --git a/doc/installation.docbook b/doc/installation.docbook index f2b15a18..8e4fe5c3 100644 --- a/doc/installation.docbook +++ b/doc/installation.docbook @@ -1,729 +1,729 @@ 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 SVNNEWS 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 for 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 for KDE krename: Powerful batch renamer for 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 <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.