X-Git-Url: https://git.quassel-irc.org/?p=quassel.git;a=blobdiff_plain;f=INSTALL;h=1ad90c363093862f6347ba0576c641dd1ad52e60;hp=21d7d4dc02f5c98d8176a81d5b4459d007773b04;hb=7d4dbdf00ab92e8c322656bd2d4d7034ef547001;hpb=11a1e4372551439769eafba3f3f5403adff763fb diff --git a/INSTALL b/INSTALL index 21d7d4dc..1ad90c36 100644 --- a/INSTALL +++ b/INSTALL @@ -72,36 +72,43 @@ summary of all that after its run, so we'll just mention the most important options here: -DWANT_(CORE|QTCLIENT|MONO)=(ON|OFF) - Allow to choose which Quassel binaries to build. + Choose which Quassel binaries to build. --DUSE_QT5=ON - Build against Qt5 instead of the default Qt4. Note that you should empty - your build directory when switching between Qt versions, otherwise weird - things may happen. +-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_OXYGEN=(ON|OFF) - Install the parts of the Oxygen icon set Quassel uses. Oxygen is the default - icon set for KDE4, and thus already available on systems where KDE4 is - installed. By default, WITH_OXYGEN is ON iff WITH_KDE is OFF. If you are - sure that you have the icon set already installed on your system regardless, - use this option to disable installing the bundled icons. - --DWITH_BREEZE=(ON|OFF) - Alternative icon set to Oxygen. - By default, WITH_BREEZE is OFF. - --DWITH_BREEZE_DARK=(ON|OFF) - Alternative icon set to Oxygen. - By default, WITH_BREEZE_DARK is OFF. +-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 also that Webkit frequently crashes - especially on Windows. + 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)