- Allow to choose which Quassel binaries to build.
-
--DLINGUAS="<languages">
- Allow to choose which languages should be compiled into the binary.
- <languages> is a space-separated list of language codes.
- Example: -DLINGUAS="de en_US"
-
--DQT=/path/to/qt
- Use a non-system Qt installation. This is for example useful if you have a static
- Qt installed in some local dir.
-
--DSTATIC=1
- Enable static building of Quassel. You should link the static versions of some libs
- (in particular libstdc++.a) into /path/to/build/dir/staticlibs in oder to create
- a portable binary!
-
-BUILDING ON WINDOWS:
---------------------
-We have tested building on Windows with a statically built Qt (with its /bin directory in %PATH%)
-and MSVC 2005/2008. Make sure that you use a "shell" that has all needed env variables setup,
-such as the "Visual Studio Command Prompt". You will also need the /bin of the Microsoft SDK in
-your %PATH% at least for VS 2008, otherwise rc.exe is not found.
-Currently, only building in the shell using nmake seems to work; CMake can also create MSVC project
-files, but they seem to be problematic. However, YMMV. Software development on Windows is a real
-PITA.
-
-After you have everything setup:
-
-cd C:\path\to\quassel-build
-cmake -G"NMake Makefiles" C:\path\to\quassel\source -DSTATIC=1
-nmake
+ Choose which Quassel binaries to build.
+
+-DUSE_CCACHE=ON
+ Enable ccache if the ccache binary is available. This avoids the need for
+ hacks using PATH or the CXX variable to make ccache work.
+ Distributors may want to disable automatic detection if they have their
+ own caching mechanism set up.
+
+-DUSE_QT4=ON
+ Build against the deprecated Qt4 instead of the default Qt5. Note that you
+ should empty your build directory when switching between Qt versions,
+ otherwise weird things may happen.
+
+-DWITH_KDE=ON
+ Enable integration into KDE4 (with Qt4) or KDE Frameworks (with Qt5).
+
+-DWITH_BUNDLED_ICONS=ON
+ Quassel requires a number of icons that are part of the KDE/Plasma icon themes
+ Breeze and Oxygen, but are generally not supported by other themes. In order
+ to avoid missing icons, Quassel bundles the subset of icons it uses from the
+ afforementioned themes, and uses that as a fallback if the system theme does
+ not provide a required icon.
+ If it is ensured that Breeze and/or Oxygen are installed on your system (e.g.
+ through package dependencies), this option can be turned off to save less
+ than 2 MB of disk space.
+
+-DWITH_OXYGEN_ICONS=(ON|OFF)
+ Support the Oxygen icon theme. Oxygen was the default theme in KDE 4, and
+ also the bundled icon theme in Quassel before version 0.13. Since the move
+ to Qt5, the more modern Breeze icon theme is preferred, and thus Oxygen
+ is disabled by default when building against Qt5.
+
+-DWITH_WEBENGINE=ON
+ Use WebEngine for showing previews of webpages linked in the chat. Requires
+ the QtWebEngine module to be available, and increases the client's RAM usage
+ by *a lot* if enabled at runtime. Only available for Qt5. The default is ON.
+
+-DWITH_WEBKIT=OFF
+ Use WebKit for showing previews of webpages linked in the chat. Requires
+ the QtWebKit module to be available, and increases the client's RAM usage
+ by *a lot* if enabled at runtime.
+ Note that WebKit support is deprecated and mostly unmaintained in Qt, and
+ should no longer be used for security reasons. The default is OFF.
+
+-DEMBED_DATA=(ON|OFF)
+ Specifies whether Quassel's data files (icons, translations and so on)
+ should be installed normally, or embedded into the binaries. The latter is
+ useful if you want to run Quassel from the build directory, or don't want
+ to use a standard installation. In particular, EMBED_DATA defaults to ON
+ on Windows and OS X, and to OFF on Linux.
+
+You can find the list of optional packages for additional features in CMake's
+feature summary; install missing packages for enabling the functionality listed
+in the explanation. If you want to forcefully disable an optional feature, use
+-DCMAKE_DISABLE_FIND_PACKAGE_Foo=TRUE, where "Foo" is the package name listed.
+
+Quassel also supports the usual CMake options, most importantly
+
+-DCMAKE_INSTALL_PREFIX=/prefix/path - specify the installation prefix
+-DCMAKE_BUILD_TYPE=(Debug|Release|RelWithDebug) - specify the build type
+
+If you want to narrow down the languages to be installed, you can set the
+LINGUAS environment variable with a space-separated list of language codes,
+for example LINGUAS="de en_US".
+
+After running CMake, you can just run "make" in the build directory, and
+"make install" for installing the result into the installation prefix.