Warning, /utilities/krusader/INSTALL is written in an unsupported language. File is not indexed.

0001             ----------------------------------
0002             Krusader installation instructions
0003             ----------------------------------
0004 
0005 
0006 --- Note
0007 
0008 Krusader-2.5.0 versions and higher use libraries like Qt5 and KF5, and will not
0009 work anymore on KDE Plasma 4 or older.
0010 
0011 --- Supported Platforms
0012 
0013 * All POSIX (Linux®/BSD/UNIX®-like OSes), Solaris™
0014 
0015 At the moment, for some libraries like KF5, there are no full ports for Windows
0016 or Mac® OS X, which means these platforms are not supported.
0017 
0018 
0019 ========================================
0020 Installation on Linux® and BSD platforms
0021 ========================================
0022 
0023 
0024 --- Preliminary steps if Krusader was already installed
0025 
0026 If Krusader was already installed: it's better to backup its settings before
0027 uninstalling Krusader and installing a new version. Those folders can be
0028 backed up (just in case):
0029         ~/.local
0030         ~/.kde
0031         ~/.config
0032 
0033 
0034 --- Krusader dependencies
0035 
0036 The next packages are needed when running the Krusader binary.
0037 
0038 This is a list of the package names that Kubuntu/Ubuntu 20.04 (LTS) use, other
0039 Linux distros will probably use similar names:
0040 
0041 - plasma-framework      Plasma Runtime components
0042 - libc6                 GNU C Library: Shared libraries
0043 - libgcc1               GCC support library
0044 - libqt5dbus5           Qt 5 D-Bus module
0045 - libqt5xml5            Qt 5 XML module
0046 - libqt5core5           Qt 5 core module
0047 - libqt5gui5            Qt 5 GUI module
0048 - libqt5printsupport5   Qt 5 print support module
0049 - libstdc++6            The GNU Standard C++ Library v3
0050 - zlib1g                compression library - runtime
0051 
0052 
0053 --- Suggested packages
0054 
0055 The next packages are optional but they will make Krusader much more powerful and useful.
0056 
0057 This is a list of the package names that Debian and Ubuntu/Kubuntu 22.04 (LTS) use, other Linux
0058 distros will probably use similar names:
0059 
0060 - ark                   archive utility by KDE
0061 
0062 - breeze-icon-theme     Breeze icons
0063 
0064 - bzip2                 high-quality block-sorting file compressor - utilities
0065 - cpio                  GNU cpio -- a program to manage archives of files
0066 
0067 - kate                  Powerful Text Editor
0068 or ktexteditor-katepart Provides text editing services
0069 
0070 - kde-cli-tools         tools required to edit file types from Properties dialog
0071                         or run Krusader in root mode
0072 
0073 - keditbookmarks        Bookmark manager used for editing bookmarks
0074 
0075 - khelpcenter           KDE help viewer
0076 
0077 - kio-extras            Enables transparent handling of various archive types
0078                         such as .tar and network protocols like SFTP
0079 
0080 - kdiff3                compares and merges 2 or 3 files or directories
0081 or kompare              file difference viewer
0082 or xxdiff               a graphical file and directories comparison and merge tool
0083 
0084 - konsole               X terminal emulator
0085 - krename               Powerful batch renamer by KDE
0086 
0087 - hashdeep              enhanced message digest calculator
0088 or cfv                  versatile file checksum creator and verifier
0089 
0090 - p7zip                 7zr file archiver with high compression ratio
0091 - rpm                   Red Hat package manager
0092 
0093 - unrar                 Unarchiver for .rar files (non-free version)
0094 or unrar-free           Unarchiver for .rar files
0095 or rar                  Archiver for .rar files
0096 
0097 - unzip                 De-archiver for .zip files
0098 - zip                   Archiver for .zip files
0099 
0100 
0101 --- Compilation requirements
0102 
0103 The next packages are needed for compiling the Krusader sourcecode, if you only
0104 run the Krusader binary you don't need to install these packages.
0105 
0106 - build-essential        a group of packages needed to compile source code
0107 - cmake                  a cross-platform, open-source make system
0108 - extra-cmake-modules    extra cmake modules for compiling KDE Frameworks
0109 - git                    a revision control system 
0110 - gettext                GNU Internationalization utilities
0111 - zlib1g-dev             in order to make building easier (https://stackoverflow.com/a/49072832)
0112 
0113 The following packages should install (through dependencies) all the packages
0114 you need to compile KF5 software:
0115 - libkf5archive-dev      development files for karchive
0116 - libkf5doctools-dev     development files for kdoctools5
0117 - libkf5kio-dev          resource and network access abstraction
0118 - libkf5notifications-dev   framework for desktop notifications
0119 - libkf5parts-dev        development files for kparts
0120 - libkf5wallet-dev       development files for kwallet-framework
0121 - libkf5xmlgui-dev       user configurable main windows
0122 
0123 
0124 --- Krusader source code download
0125 
0126 Krusader is developed on Invent KDE hub at https://invent.kde.org/utilities/krusader.
0127 
0128 To download the latest source code, clone the repository with git:
0129 $ git clone https://invent.kde.org/utilities/krusader
0130 $ cd krusader
0131 
0132 You'll land on the 'master' branch that has the latest development updates and features but potentially could have regressions.
0133 If you'd like switch to the 'stable' branch, which contains backported bug fixes on top of the latest release, run
0134 $ git checkout -b stable origin/stable
0135 
0136 You can also use one of the released snapshots available at https://download.kde.org/stable/krusader/.
0137 Besides the source code, the snapshots contain translations.
0138 Unpack the archive with:
0139 $ tar -xvf krusader-x.y.z.tar.xz
0140 $ mv krusader-x.y.z krusader
0141 $ cd krusader
0142 
0143 
0144 --- Build configuration
0145 
0146 These are some CMake options that can be used, it's not necessary to use
0147 them all (later there's an example):
0148 
0149 -DCMAKE_INSTALL_PREFIX=/usr
0150   is the location where Krusader will be installed with the make command.
0151   Another example is: -DCMAKE_INSTALL_PRFIX=/opt/krusader
0152   to install the compiled Krusader in an other directory to not overwrite
0153   the Krusader version installed by your package manager.
0154 
0155 -DCMAKE_CXX_FLAGS="-O2 -fPIC"
0156   this flag is required if you have a 64 bit system
0157 
0158 -DQT_PLUGIN_INSTALL_DIR=
0159   many system force this path to keep kde4 plugins separated from the kde5 ones
0160 
0161 -DKDESU_PATH=/foo/bar/kdesu
0162   this needs to be set on distributions that override default kdesu installation
0163   path (libexec/kf5/kdesu) or if your install prefix doesn't match KDE's.
0164 
0165 -DENABLE_SYNCHRONIZER=OFF
0166   disables building the Synchronizer module. This module caused data loss, now
0167   it is fixed, but we treat it as the thin ice.
0168 
0169 Example steps to configure the build:
0170 $ cd ..
0171 $ ls krusader/app/main.cpp || echo "Incorrect starting dir"
0172 $ mkdir krusader-build
0173 $ cd krusader-build
0174 $ cmake ../krusader -DCMAKE_INSTALL_PREFIX=/usr/ -DCMAKE_C_FLAGS="-O2 -fPIC" -DCMAKE_CXX_FLAGS="-O2 -fPIC"
0175 
0176 Note: An example of an output of cmake can be seen in https://invent.kde.org/utilities/krusader/snippets/1024
0177 
0178 Note: If Krusader is going to be built under the 16.04 LTS version of Ubuntu (or Kubuntu, etc.) then
0179 installing Qt 5.9 (or newer) is needed (it could be downloaded from https://www.qt.io/offline-installers) and
0180 the aforementioned cmake command would need (at its end) an additional argument like:
0181     -DCMAKE_PREFIX_PATH=/opt/Qt/5.9/gcc_64/
0182 if e.g. Qt 5.9 was installed inside /opt
0183 
0184 
0185 --- Compilation and installation
0186 
0187 Execute:
0188 # Note: On a multi cpu/core system you might want to speed up the compile process by increasing the number of jobs (e.g. `make -j4`)
0189 $ make
0190 
0191 # At the beginning of the following command: `sudo` must be added if Kubuntu, Ubuntu, Debian, or similar is being used
0192 $ su -c "make install"
0193 
0194 Note: An example of an output of make can be seen in https://invent.kde.org/utilities/krusader/snippets/1025
0195 
0196 
0197 --- Execution
0198 
0199 Finally, Krusader can be executed this way:
0200 $ krusader
0201 
0202 
0203 --- Uninstall
0204 
0205 # At the beginning of the following command: `sudo` must be added if Kubuntu, Ubuntu, Debian, or similar is being used
0206 $ su -c "make uninstall"