Use a unicode string instead of the escaped version.

[quassel.git] / INSTALL

diff --git a/INSTALL b/INSTALL
index 99ce60c..83ff62d 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -13,8 +13,8 @@ Note that quasselcore is no longer being built by default, since it tends to
 confuse users more than it helped. It will be back as soon as we have simple mode
 implemented.
 
-We now use CMake as our build system. CMake supports and encourages out-of-source 
-builds, which do not clutter the source directory. You can (and should) thus use 
+We now use CMake as our build system. CMake supports and encourages out-of-source
+builds, which do not clutter the source directory. You can (and should) thus use
 an arbitrary directory for building.
 
 There is no "make distclean"; "make clean" should usually be enough since CMake
@@ -37,23 +37,55 @@ NOTE: In order to reconfigure, you need to remove CMakeCache.txt (or empty
 
 Quassel recognizes the following options:
 
+LINGUAS="<languages">
+    Allow to choose which languages should be compiled into the binary.
+    <languages> is a space- or comma-separated list of language codes.
+    Note that this is not a cmake variable, but an environment variable.
+    Example: LINGUAS="de en_US"
+
 -DWANT_(CORE|QTCLIENT|MONO)=(ON|OFF)
     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"
+-DWITH_KDE=ON
+    Enable integration into KDE4
+
+-DWITH_OXYGEN=(ON|OFF|AUTO)
+    Whether to install Oxygen icons used by Quassel. By default (AUTO) we don't install them if
+    KDE integration is enabled and KDE > 4.3.0 is present, as all needed icons are part of the
+    system Oxygen iconset in this case. Using ON or OFF you can override automatic detection.
+
+-DWITH_OPENSSL=OFF
+    Disable OpenSSL support
+
+-DWITH_DBUS=OFF
+    Disable D-Bus support. This will disable support for notification-daemon.
+
+-DWITH_WEBKIT=OFF
+    Disable WebKit support. You will not have webpage previews on hovering URLs.
+
+-DWITH_PHONON=OFF
+    Disable support for audio notifications via Phonon.
+
+-DWITH_LIBINDICATE=OFF
+    Disable support for Ayatana notifications (libindicate-qt)
+
+-DWITH_CRYPT=OFF
+    Disable crypt support
+
+-DEMBED_DATA=ON
+    Embed all external data files (e.g. icons) into the binary. This will give you a
+    standalone binary that does not require installation. Will be ignored if KDE support
+    is enabled.
 
 -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
+-DSTATIC=ON
     Enable static building of Quassel. On Linux, 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! Be aware of the fact that some things we do in STATIC mode might not be portable
-    or require a particular setup; it's mainly meant for the devel team.
+    or require a particular setup; it's mainly meant for the devel team. See also doc/.
 
 BUILDING ON WINDOWS:
 --------------------