# Installation of Krusader

## 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 clone git://anongit.kde.org/krusader

### 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 krusader-2.5.0.tar.gz
          $ cd krusader
          $ mkdir build
          $ cd build
          $ cmake -DCMAKE_INSTALL_PREFIX=/usr/ -DQT_INCLUDES=/usr/share/qt5/include ..
          $ make
          $ su -c "make install"

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:

`--left` <path>

  start left panel at <path>

`--right` <path>

  start right panel at <path>

`--left` <path1>,<path2>,<path3>

  start left panel at <path1>,<path2>,<path3>, with tabs.

`--profile` <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:

`--author`

  Show the authors names

`--license`

  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.