-
Notifications
You must be signed in to change notification settings - Fork 0
Installation
This page contains compile notes and installation of the 4.x.x binaries of K+. In this page you can find all basic information from grabbing the source code from GitHub, to the dependencies required in order to compile binaries and install them.
This page is an updated version of INSTALL.txt.
Note: It isn't practical to cover all Linux distributions in this document.
Additional distro specific documentation in similar format is welcome.
1. Introduction
2. Hacker Installation - Advanced or power users
3. Dependencies and requirements
4. Configuring the environment
5. Getting and updating the source code
6. Configuring KVIrc
7. Interactive CMake KVIrc configuration
8. Compiling KVIrc
9. Compiling on macOS
10. Compiling on Windows
11. Creating a KVIrc package
If you have found this document in a binary distribution then KVIrc has been probably already installed by your distros package manager and maybe something is not working as expected. In this case this document and the accompanying F.A.Q. can help you determining the issue.
This doc provides fully working instructions for Ubuntu or variants. Compiling KVIrc in your preferred Linux distributions is possible, provided the minimum required dependencies and their versions are met.
From here on in this doc refers to "Ubuntu or variants", where variants are distributions classed as Ubuntu derivatives.
Note: lines prefixed with
$or0.or1.:
$ Is a representation of the command prompt on your shell.
0. Prefix is the default command variation.
1. Prefix is a possible variation of the command.
Note: If anyone could find the time to test KVIrc with ICC please let us know!
First of all, if you often compile applications from source on Linux and you know how to solve dependency problems then well, KVIrc is not very different. It uses a build system based on CMake and follows its standard procedures.
If you feel brave try:
$ cd <k-plus_source_directory> // (usually k-plus)
$ mkdir build
$ cd build
$ ccmake ..
$ make
$ sudo make installIf something goes wrong with the above procedure then you should read the step-by-step instructions below.
KVIrc compilation process depends on a set of tools and development libraries. Some of them are strictly required (the process will fail without them) and some are optional. The ones marked as "preferred" are optional but without them KVIrc may lack some fundamental features.
Note: Where OpenSSL is concerned, you should check it is legal to use cryptographic libraries in your Country.
In order to compile KVIrc you will need:
| Library | Dependence | Version |
|---|---|---|
| C++ compiler | Required | |
| CMake | Required | >= 3.1.0 |
| CMake GUI | Optional | >= 3.1.0 |
| Doxygen | Optional | |
| pkg-config | Required | |
| git-core | Preferred | |
| Pthreads | Required | |
| ZLib | Required | >= 1.2.8 |
| X Rendering Extension | Required | |
| X11 client-side library | Required | |
| Qt GUI Toolkit | Required | >= 5.5.x |
| KDE | Optional | |
| Enchant | Optional | |
| Phonon framework (Audio) | preferred | |
| Qt Multimedia (Audio) | Optional | |
| OpenSSL | Optional | |
| GSM speech compressor | Optional | |
| GNU gettext | Optional | |
| Python | Optional | |
| Perl | Preferred | >= 5.004 but 5.10 recommended |
Note: For further information on these libraries read 4. Configuring the environment
For CMake >= 3.1.0 run:
Note: PPA for CMake for Ubuntu and variants <= 14.04 LTS:
$ sudo add-apt-repository ppa:kvirc/kvirc -y
$ sudo apt-get updateFor Ubuntu or variant distributions the complete list of dependencies
and installation command is:
$ sudo apt-get install build-essential cmake cmake-curses-gui doxygen git-core \
libenchant-dev libgettextpo-dev libgsm1-dev libperl-dev libpthread-stubs0-dev \
libssl-dev libx11-dev libxrender-dev pkg-config python-dev zlib1g-devNote: KVIrc is complied by default against Qt5.x, those libraries are:
$ sudo apt-get install libqt5webkit5-dev libqt5svg5-dev \
libqt5x11extras5-dev qtbase5-devNote: An audio support backend is required for audio the choices are as follows:
Compiling KVIrc with qtmultimedia5 audio support:
$ sudo apt-get install qtmultimedia5-devCompiling KVIrc with phonon audio support:
$ sudo apt-get install libphonon4qt5-dev libphonon4qt5experimental-devNote: When using Phonon, a working phonon-backend should be installed, else you may not get any audio coming out your speakers at runtime.
If your distribution is sane, installing the development packages should set up your environment variables correctly. You will know that something is wrong when you run CMake, the configuration output will complain if paths are not found.
If the CMake configuration terminates successfully you can skip directly to step 5.
However when this is not the case you may need to export the path variables manually. e.g. $QTDIR.
Note: Where x is the KVIrc's currently supported Qt version. Current only Qt supported version is 5.x.x
For x86 e.g.
$ export QTDIR=/usr/lib/qtxFor x86_64 e.g.
$ export QTDIR=/usr/lib/x86_64-linux-gnu/qtxNote: If you have multiple distinct versions of the same Qt5.x installed and want to use a specific version, exporting QTDIR won't suffice, since the CMake module searching for Qt5.x uses qmake itself to determine the Qt5.x library dir.
You can set your $PATH variable to have CMake using your specified Qtx.x version:
$ PATH=/opt/qtx.x/bin/:$PATH cmake ..Note: See step 6. Configuring KVIrc for supported CMake configuration flags. The trailing dots are required when you build out-of-source or CMake will likely fail.
If you want to compile the KDE integration support, you obviously need KDE. The kdelibs package should suffice.
This is usually included in your distribution and is probably already installed. In Ubuntu or variants the library is libpthread-stubs0-dev. The library is called libpthread.so. You can search for it using the "find" or, at your option, "locate" command.
0. $ find / -name libpthread*
1. $ locate -i "libpthread*"If you use KVIrc in a language other than English, then you need the GNU gettext package. In particular KVIrc uses msgfmt.
This is usually included in your distribution and is probably already installed. In Ubuntu or variants this library is libgettextpo-dev. If your distro is not Ubuntu or variant you can check it by running:
$ msgfmt --versionKVIrc will not complain if the command above is missing. It will just skip the creation of the translation files. See the CMake configuration output.
If you want to generate the on-line documentation you'll also need Perl.
Note: The way external software can embed Perl has changed between Perl version 5.8 and 5.10. KVIrc should play nice with Perl as of version 5.004 and higher, but 5.10 is strongly recommended, since future updates can break backwards compatibility.
If you want Perl scripting support to be compiled, you need a working Perl installation. Your libperl.so MUST be compiled with the multiplicity option. You can check it with:
$ perl -VIf you want the secure socket layer (SSL) support to be compiled, you need the OpenSSL development library, in Ubuntu or variants its libssl-dev
If you want DCC VOICE to support the gsm codec, you need a recent copy of libgsm. This is not strictly required at compile time since KVIrc will look for the library at run-time and only if the DCC VOICE with the gsm codec is requested. You can check for libgsm using the 'find' or 'locate' command.
0. $ find / -name libgsm*
1. $ locate -i "libgsm*"This library is included in most distributions.
Some distros ship only the static version of the library libgsm.a.
If the previous find or locate command returned something similar
to /usr/lib/libgsm.a, you might create the shared library manually
by running:
$ cd /usr/lib
$ ld --whole-archive -shared -o libgsm.so.1 libgsm.a
$ ln -s libgsm.so.1 libgsm.so
$ ldconfigNotes:
- This won't work if the library was compiled without
-fPIE.- Files in
/usr/libshould really be managed by package manager of the distro. Whenever package containing libgsm.a upgrades, the manually created libgsm.so stays old.- The distribution can provide a better way to install libgsm.so. e.g. in Gentoo many packages have static-libs USE -flag which tells the package manager to install not only
*.sofiles, but also*.a(which is kind of the reverse, but the point still stands)
If you want the /snd plugin to play various audio formats,
you either need the phonon framework, a running ESounD daemon,
or a reasonably recent audiofile library. Without these KVIrc will be only able to play *.au files.
You will need the dynamic linker interface library libdl.so.
This is usually installed on your system, so don't care until configure
complains about it. Some system have the interface builtin in libc. The
configure script can detect this.
The K+ development code is located at https://github.com/bivious/k-plus
There are several ways to get K+'s source code, if you compile often, the best way is to clone the repository as this allows for the most flexibility.
$ mkdir /home/setup && cd /home/setup
$ git clone https://github.com/bivious/k-plus.gitKeeping the git clone up-to-date is simple.
$ git pull --rebase origin masterClean the Git directory of all files or directories generated by you or by CMake or Make. If you don't have anything you want to keep in the source directory, this is recommended previous to configuring or compiling any updated Git clones.
Benefits are reduced the chances of errors during the reconfiguration / compilation, If you experience any compile breakages or issues make sure this command is executed.
$ git clean -xfdAlternatively if you prefer. you can download a tarball of the most recent
sources.
$ mkdir /home/setup && cd /home/setup
$ wget https://github.com/bivious/k-plus/archive/master.tar.gz -O k-plus.git.tar.gz
$ tar -zxvf k-plus.git.tar.gzNote: To avoid loses of any ongoing development work when using this clean method, you can commit those changes. Another alternative is compile on another branch and pull any patches you wish to test to the compile branch.
Since KVIrc 4.2 uses CMake as build system, we have to use it to create the Makefile's rules for make program.
To do it, we encourage the "out-of-source" building: build all files
without dirtying the sources directory.
$ cd /home/setup && cd KVIrc
$ mkdir buildIn this way you have just created an out-of-source environment which is clean at the beginning and can be changed afterwards, as well as a clean source directory.
$ cd build
$ cmake [your options] ..Note: The two trailing dots are required when you build out-of-source.
The CMake rules support some flags. If you don't specify them, CMake will try to guess a good environment for you.
To use these flags, you have to pass a bool value or a string.
e.g. To install KVIrc in /usr instead of /usr/local and to disable
Phonon support, the command looks like:
$ cmake -DCMAKE_INSTALL_PREFIX=/usr -DWANT_PHONON=0 ..When using the configuration flags below.
When enabled, compiles the executable with debug symbols. Useful for reporting bugs and grabbing stacktraces where you experience a crash.
Note: An alternative better method is defining the build type by using:
Available only if debug is disabled, this flag disables objects stripping before installation. (Object stripping discards symbols from object files, lowering their size on disk, at the expense of more complicated or rather impossible debugging.)
Generate verbose output when compiling.
Note: with gmake this will be deactivated when using a job setting higher than 1. i.e.,
make -j2will not show verbose compilation output.
This will install all stuff under PATH directory.
This will install libkvilib and KVIrc modules to ${CMAKE_INSTALL_PREFIX}/lib${LIB_SUFFIX}
directory. It defaults to an empty suffix.
Mainly used for x86_64 architectures.
This will install man pages to DIRECTORY.
If enabled, appends version information to KVIrc and libkvilib, so that different KVIrc versions can co-exist on the same system.
When enabled, KVIrc install rules won't try to figure out and set
CMAKE_C(XX)_FLAGS. Instead, it will let CMake use the ones taken
from environment variables.
Activating this flag will override the value of -DWANT_DEBUG.
This will re-initialize the installation path to a good default. Following compilations should use the correct path value cached by CMake. This flag is useful to solve macOS install problems.
Note:
-DWANT_UNIVERSAL_BINARY=support was removed.
Enables or disables Phonon audio backend support.
Enables or disables OpenSoundSystem audio backend support. If disabled, audiofile support will be disabled as well.
Enables or disables audiofile audio backend support.
Enables or disables ESounD audio backend support.
Enables or disables Qt D-Bus support.
Enables or disables Qt WebKit support.
Enables or disables KDE support. The KDE version used depends on the Qt version used. Qt5 implies KDE5.
Enables or disables the cryptographic functions support using OpenSSL.
Enables or disables the cryptographic engines and the whole cryptography / text transformation support. Produces a slightly smaller executable. You will lack features, though.
Enables or disables the IPv6 support. Even if you have a plain IPv4-only connection, you might want to keep the IPv6 support. This way you will be able to resolve IPv6 hostnames.
This option enables or disables pseudo and real transparency support. The pseudo-transparency support makes the KVIrc windows look like semi-transparent (this is NOT real transparency, it is just a neat-looking hack). Transparency uses compositing and needs proper hardware support to work.
If KDE support is enabled, KVIrc will have an option that makes all windows use a faded KDE desktop background image as background. Without KDE support you will be able to choose a fake background image and use it as background. (You can still choose your desktop wallpaper, this will (more-or-less) work with all window managers).
It is cool-looking but usually eats some memory and makes the executable slightly bigger, when enabled. Especially when moving objects around, CPU consumption may get high as well. You can thus disable transparency here.
QGtkStyle is a Qt backend that uses native GTK widgets. By default we disable QGtkStyle since it interferes with KVIrc's internal theme engine and there maybe some unwanted styling that you may consider broken. Some users want to use it anyway. Please don't report any theme-related bug if you enabled this option: we already know it's limitations and issues. For further information / discussion see: https://github.com/kvirc/KVIrc/issues/2117
Enables or disables Perl support. You will not be able to use Perl scripts inside of KVIrc. You still can execute Perl scripts outside of KVIrc, i.e. with the exec() command. Note: Perl support will be checked anyway, and used to generate the documentation if present.
Enables or disables python support. You will not be able to use Python scripts inside of KVIrc.
Enables or disables support for inter-process communication. You will not be able to send remote commands to running KVIrc sessions. This basically means that every time you run the KVIrc executable, a new session will be started. If you don't use this switch, a new session will be started only if no session is running on the same display or "new session" has been forced by a command-line switch. If a session is already running, the command-line will be passed to that session via IPC (X-event-based communication). This option saves the KVIrc executable some KByte in size, so if you're really, really short in memory, you might use it, otherwise, IPC is a nice feature.
Enables or disables the use of GetText to generate translation files.
Enables or disables developers docs generation through Doxygen.
Enables or disables the usage of the GSM library. This will disable the DCC VOICE GSM codec but might help when the compilation stops complaining of something related to GSM. :)
Under Solaris, both usleep() and threads implementation are based on
SIGALARM. KVIrc uses both, and this could lead to some spontaneous
application quits. This option enables a workaround for this problem.
Enables or disables the DCC VOICE sound support. This might help
if you have problems in compilation of src/modules/dcc/voice.cpp.
It will disable the sound support (and thus render DCC VOICE unusable).
Enables or disables EXPERIMENTAL DCC VIDEO support.
Enables or disables EXPERIMENTAL Ogg / Theora Support for DCC video.
Enables or disables the Obsolete DCC CANVAS support.
Compile Spell-Checker Support.
Note: If libenchant development package is installed, this option is automatically enabled during configuration.
Enables or disables memory allocation profiling. Don't set it, unless you are a developer and know what you are doing. It will have high impact on executable size and most notably speed. Please do not use this.
Enables or disables malloc() memory checks. This will print a nice
message if your system goes out of memory.
It can't save you from buying new RAM, but at least you will know that
your system went out of memory and it is not a proper KVIrc fault.
Most systems do actually already notice you when you are out of RAM
(i.e. Linux and the OOM killer.)
Most probably you will not need to enable this flag.
Manually set a revision number if subversion is not found on your system. This is useful mostly on windows. Please do not specify useless information here, as it will make debugging harder and you won't profit from it.
Add some pizza for dinner. :)
Add some beers to chat. :)
The CMake build system provide also an interactive mode to configure the environment before compiling. Again, we encourage the "out-of-source" building: build all files without dirtying the sources directory.
$ mkdir build
$ cd build
$ ccmake ..Now you're in interactive mode, just follow the instructions on screen to configure your compilation environment.
This step is easy: Cross your fingers and run:
0. $ makeIf you have a multiprocessor or multicore machine then you can use -jN to speed up the compilation.
1. $ make -j4If your make is not a GNU make (this happens on FreeBSD for example) you
should use gmake instead.
The compilation process will take from 2-3 minutes to several hours
depending on the machine capabilities and load.
If you have a slow old CPU but have a couple of computers in a LAN you might
consider using distcc to distribute the compilation.
Once the compilation has finished successfully, run:
$ sudo make installSame as above: use gmake install if your make is not GNU make.
This will install the executable in /usr/local/bin (if you haven't
specified a different -DCMAKE_INSTALL_PREFIX= option in the CMake rules),
the libraries in /usr/local/lib (if you don't have specified a different
-DLIB_SUFFIX option in the CMake rules) and the shared data in
/usr/local/share/kvirc.
Make sure that /usr/local/lib is in your /etc/ld.so.conf. If it isn't,
put it in there and run:
$ sudo ldconfigIf you have decided to use the KDE support the installation might have
placed all these files in your $KDEDIR tree instead of /usr/local.
In this case you should be OK since KDE requires its library dir to be
in /etc/ld.so.conf.
- See the detailed compilation and installation HOW-TO for macOS systems in source doc directory INSTALL-macOS.txt.
- See the detailed compilation and installation HOW-TO for macOS systems in the K+ Wiki
There is a detailed compilation and installation HOW-TO for Win32 and Win64 systems located in the doc directory. They're named INSTALL-Win32.txt and INSTALL-Win64.txt.
CMake supports DESTDIR argument.
So, if you want to make a package for your distribution, you simply have to pass
it at "make install" stage: your install files will go to the chosen path.
$ make install DESTDIR=/tmp/kvirc-4.9After this step, just follow your distribution's rules to make a good
package for the distro you're running.
Alternatively, you can try the experimental CPack support included in
CMakelist.txt to build a package. In this case, please refer to the CPack
documentation.
K+ Wiki - 2017 - GNU-FDL v1.3