INSTALL

   1 Quassel IRC - Installation Notes
   2 ================================
   3
   4 These should help you to install Quassel IRC from source. Note that this focuses
   5 mostly on building on Linux; please feel free to send patches for build
   6 instructions on other platforms. We are not familiar with them.
   7
   8 There are three versions of Quassel that can be built:
   9
  10 * quasselcore   - The server daemon. Typically runs on a headless server and
  11                   is permanently online. The core connects to IRC and stores
  12                   both settings and backlog.
  13 * quasselclient - The GUI client. Requires a running quasselcore to connect to.
  14                   Upon connection, the client will fetch all session data and
  15                   a certain amount of backlog from the core and restore its
  16                   session almost as if you were never gone.
  17 * quassel       - This standalone version, often called "monolithic" or
  18                   "mono client", contains both a client and a core and can be
  19                   used like a "normal" IRC client, without having to setup
  20                   a server daemon.
  21
  22 Prerequisites
  23 -------------
  24
  25 Of course, for building Quassel you need the usual set of build tools, for
  26 example a compiler. As we use a subset of the C++11 standard, we require a
  27 fairly recent compiler:
  28
  29 - gcc 4.8+ (available for most platforms), or
  30 - Clang 3.3+ (available for most platforms), or
  31 - XCode 5.0+ (available for Max OS X and based on Clang), or
  32 - Visual C++ 2015 (available for Windows™), or
  33 - any other compiler with decent C++11 support
  34
  35 Furthermore, CMake 2.8.9 or later is required (2.8.12 for KDE Frameworks).
  36
  37 As Quassel is a Qt application, you need the Qt SDK, either Qt 4.8+ or Qt 5.2+.
  38
  39 There are several optional dependencies; we will talk about that later.
  40
  41 Compiling Quassel - short version
  42 ---------------------------------
  43
  44 Quassel uses CMake as its build system. The canonical way to build any CMake-
  45 based project is as follows:
  46
  47 cd /path/to/source
  48 mkdir build
  49 cd build
  50 cmake ..
  51 make
  52 make install
  53
  54 Compiling Quassel - long version
  55 --------------------------------
  56
  57 First of all, it is highly recommended for any CMake-based project to be built
  58 in a separate build directory rather than in-source. That way, your source
  59 checkout remains pristine, and you can easily remove any build artifacts by just
  60 deleting the build directory. This directory can be located anywhere; in the
  61 short example above, we've just created a directory called "build" inside the
  62 source checkout.
  63
  64 From inside the build directory, you can then run the "cmake" command, followed
  65 by the path to the source. Additionally, you can append various options. Note
  66 that CMake caches the options you provide on the command line, so if you rerun
  67 it later in the same build directory, you don't need to specify them again.
  68
  69 Quassel supports several options to enable or disable features, and can make
  70 use of several optional dependencies if installed. CMake will give a nice
  71 summary of all that after its run, so we'll just mention the most important
  72 options here:
  73
  74 -DWANT_(CORE|QTCLIENT|MONO)=(ON|OFF)
  75     Choose which Quassel binaries to build.
  76
  77 -DUSE_QT4=ON
  78     Build against the deprecated Qt4 instead of the default Qt5. Note that you
  79     should empty your build directory when switching between Qt versions,
  80     otherwise weird things may happen.
  81
  82 -DWITH_KDE=ON
  83     Enable integration into KDE4 (with Qt4) or KDE Frameworks (with Qt5).
  84
  85 -DWITH_BUNDLED_ICONS=ON
  86     Quassel requires a number of icons that are part of the KDE/Plasma icon themes
  87     Breeze and Oxygen, but are generally not supported by other themes. In order
  88     to avoid missing icons, Quassel bundles the subset of icons it uses from the
  89     afforementioned themes, and uses that as a fallback if the system theme does
  90     not provide a required icon.
  91     If it is ensured that Breeze and/or Oxygen are installed on your system (e.g.
  92     through package dependencies), this option can be turned off to save less
  93     than 2 MB of disk space.
  94
  95 -DWITH_OXYGEN_ICONS=(ON|OFF)
  96     Support the Oxygen icon theme. Oxygen was the default theme in KDE 4, and
  97     also the bundled icon theme in Quassel before version 0.13. Since the move
  98     to Qt5, the more modern Breeze icon theme is preferred, and thus Oxygen
  99     is disabled by default when building against Qt5.
 100
 101 -DWITH_WEBENGINE=ON
 102     Use WebEngine for showing previews of webpages linked in the chat. Requires
 103     the QtWebEngine module to be available, and increases the client's RAM usage
 104     by *a lot* if enabled at runtime. Only available for Qt5. The default is ON.
 105
 106 -DWITH_WEBKIT=OFF
 107     Use WebKit for showing previews of webpages linked in the chat. Requires
 108     the QtWebKit module to be available, and increases the client's RAM usage
 109     by *a lot* if enabled at runtime.
 110     Note that WebKit support is deprecated and mostly unmaintained in Qt, and
 111     should no longer be used for security reasons. The default is OFF.
 112
 113 -DEMBED_DATA=(ON|OFF)
 114     Specifies whether Quassel's data files (icons, translations and so on)
 115     should be installed normally, or embedded into the binaries. The latter is
 116     useful if you want to run Quassel from the build directory, or don't want
 117     to use a standard installation. In particular, EMBED_DATA defaults to ON
 118     on Windows and OS X, and to OFF on Linux.
 119
 120 You can find the list of optional packages for additional features in CMake's
 121 feature summary; install missing packages for enabling the functionality listed
 122 in the explanation. If you want to forcefully disable an optional feature, use
 123 -DCMAKE_DISABLE_FIND_PACKAGE_Foo=TRUE, where "Foo" is the package name listed.
 124
 125 Quassel also supports the usual CMake options, most importantly
 126
 127 -DCMAKE_INSTALL_PREFIX=/prefix/path - specify the installation prefix
 128 -DCMAKE_BUILD_TYPE=(Debug|Release|RelWithDebug) - specify the build type
 129
 130 If you want to narrow down the languages to be installed, you can set the
 131 LINGUAS environment variable with a space-separated list of language codes,
 132 for example LINGUAS="de en_US".
 133
 134 After running CMake, you can just run "make" in the build directory, and
 135 "make install" for installing the result into the installation prefix.