Difference between revisions of "Archive:Getting Started/Build/Requirements"

Jump to: navigation, search
Line 1: Line 1:
 
{{warning|This page is yet to be reviewed for changes required by the migration to Git.  Information and commands on this page may no longer be valid and should be used with care. Please see the [[Development/Git|KDE Git hub page]] for more details. }}
 
{{warning|This page is yet to be reviewed for changes required by the migration to Git.  Information and commands on this page may no longer be valid and should be used with care. Please see the [[Development/Git|KDE Git hub page]] for more details. }}
  
{{Template:I18n/Language Navigation Bar|Getting_Started/Build/KDE4/Prerequisites}}
+
{{Template:I18n/Language Navigation Bar|Getting_Started/Build/Requirements}}
  
 
{{TutorialBrowser|
 
{{TutorialBrowser|
Line 7: Line 7:
 
series=Getting Started|
 
series=Getting Started|
  
name=Building KDE4 From Source/Prerequisites|
+
name=Building KDE4 From Source/Requirements|
  
pre=[[../|KDE SVN Quickstart Guide]]|
+
pre=[[Getting_Started|Getting Started]]|
  
next=[[../|KDE SVN Quickstart Guide]]|
+
next=[[Getting_Started/Build/Qt|Qt]]|
 
|
 
|
 
}}
 
}}
Line 183: Line 183:
 
* [[Getting_Started/Build/KDE4/LFS|Linux from Scratch]] or to build from source.
 
* [[Getting_Started/Build/KDE4/LFS|Linux from Scratch]] or to build from source.
 
* [[Getting_Started/Build/KDE4/Mandriva|Mandriva]]
 
* [[Getting_Started/Build/KDE4/Mandriva|Mandriva]]
 
== makeobj ==
 
Requirements as at 2011-03-02, Stable Branch currently KDE Release 4.6, Master currently targeting KDE Release 4.7.
 
 
{| border="1" cellpadding="5" cellspacing="0" align="center"
 
|-
 
! Requirement
 
! Stable
 
! Master
 
! Devel?
 
! Details
 
|-
 
| [http://websvn.kde.org/trunk/KDE/kdesdk/scripts/makeobj makeobj]
 
| r1215872
 
| r1215872
 
| No
 
|
 
|}
 
 
Makeobj is a script to assist make.  It is a part of the kdesdk module but is needed to build all KDE modules.  If you have kdesdk installed on your system then this version should be sufficient, but r1215872 is recommended when working with Git.
 
 
To install it [http://websvn.kde.org/*checkout*/trunk/KDE/kdesdk/scripts/makeobj download via WebSVN] and install into your path somewhere, preferably ~/.bin.  Once you have built kdesdk from source you should then remove this copy.
 
 
== Qt ==
 
 
Requirements as at 2011-03-02, Stable Branch currently KDE Release 4.6, Master currently targeting KDE Release 4.7.
 
 
{| border="1" cellpadding="5" cellspacing="0" align="center"
 
|-
 
! Requirement
 
! Stable
 
! Master
 
! Devel?
 
! Details
 
|-
 
| [http://qt.nokia.com/ Qt]
 
| >= 4.7.0
 
| >= 4.7.0
 
| Yes
 
|
 
|}
 
 
Qt is the toolkit that all KDE is built upon.  Most distributions package a recent enough Qt to build KDE, although you may need to add an extra repository to do so.  Building Qt can take a long time, so packages are preferred for a quick start.
 
 
At some stage, KDE master may switch to relying on a development version of Qt, or may require patches to Qt for bug-fixes that have not yet been released by Qt.  In this case you may need to build your own copy of Qt to build KDE against and it is recommended that you use the KDE clone qt-kde when this happens.  You can choose to overwrite your system Qt install when doing so but this is not recommended.  You are advised to set your build environment $QTDIR install directory to a local folder different to $KDEDIR to allow easy switching between Qt versions.
 
 
Please see the [https://projects.kde.org/projects/qt-kde qt-kde project page] for further details.  It is recommended to read [https://projects.kde.org/projects/qt-kde/repository/revisions/master/entry/README.kde-qt README.qt-kde file] for the necessary Qt configure options as well as currently known issues.
 
 
Note that you need to install Qt and Phonon from Qt and then later to install Phonon KDE from git at the same location. This will ensure you get sound in Qt-based applications as well as in KDE ones.
 
 
=== Easy Recipe ===
 
This recipe assumes you have set up the recommended KDE scripts, environment variables, and git configuration.
 
 
Ensure you setup your environment $QTDIR to point to somewhere suitable.
 
 
cd <your source directory>
 
git clone kde:qt-kde
 
./configure ''[configure options from README.kde-qt replacing <installdir> with $QTDIR]''
 
nice make -j2 # for faster compiles use -j(X+1)' where X is your number of processor cores
 
make install
 
 
=== Full Recipe ===
 
This recipe assumes you are not using the recommended scripts and have properly set up your own environment.
 
 
cd <your source directory>
 
git clone git://anongit.kde.org/qt-kde
 
cd qt-kde
 
./configure ''[configure options from README.kde-qt''
 
nice make -j2 # for faster compiles use -j(X+1)' where X is your number of processor cores
 
make install
 
 
=== Troubleshooting ===
 
 
If ./configure produces errors about missing headers, run the following command before trying again: <code>QTDIR=`pwd` bin/syncqt</code>
 
 
Make sure <tt>which qmake</tt> delivers something out of $QTDIR, e.g. /home/kde-devel/qt-kde/bin/qmake
 
 
If you get "error: X11/Xlib.h: No such file or directory", install the devel package of <tt>xorg</tt> (the actual name may vary between operating systems, for example it is <tt>xorg-dev</tt> on Ubuntu based systems such as Kubuntu).
 
 
If you get an error in the configure step about missing defines, check the value of <tt>$QMAKESPEC</tt>.  Some distributions set this to point directly to the system-installed Qt.  If <tt>unset QMAKESPEC</tt> solves the problem, you probably want to add it to the <tt>~/.bashrc</tt> script.
 
 
If you get an error ".pch/debug-shared/QtCore", this is because Qt-4.3 enables precompiled headers if your gcc supports it, but for some reason it doesn't work for you. If you use distcc, configure qt with -no-pch. If you use icecream, update to the latest icecream from svn trunk.
 
 
Try running any Qt program, like {{program|assistant}}.
 
 
=== Generating local API documentation ===
 
It's nice to have the Qt documentation locally for nice integration with [[Getting_Started/Set_up_KDE_4_for_development#KDevelop|KDevelop]], and doing this is really quite easy (also shown in {{path|README.kde-qt}}):
 
cd $KDE_SRC/qt-kde
 
make docs
 
./config.status
 
make install
 
Note that it is necessary to do this only once, even if you rebuild Qt later.
 
 
== DBusMenu-Qt ==
 
Requirements as at 2011-03-02, Stable Branch currently KDE Release 4.6, Master currently targeting KDE Release 4.7.
 
 
{| border="1" cellpadding="5" cellspacing="0" align="center"
 
|-
 
! Requirement
 
! Stable
 
! Master
 
! Devel?
 
! Details
 
|-
 
| [http://people.canonical.com/~agateau/dbusmenu/index.html DBusMenu-Qt]
 
|
 
|
 
| Yes
 
|
 
|}
 
 
DBusMenu-Qt is a library providing a Qt implementation of the DBusMenu spec.  Your distribution packages should be sufficient for this package.
 
 
Please see the [http://people.canonical.com/~agateau/dbusmenu/index.html DBusMenu-Qt home page] for more deatils.
 
 
You need json to build the tests.
 
 
=== Easy Recipe ===
 
This recipe assumes you have set up the recommended KDE scripts, environment variables, and git configuration.
 
 
cd <your source root directory>
 
git clone git://gitorious.org/dbusmenu/dbusmenu-qt.git
 
cd dbusmenu-qt
 
cmakekde
 
 
=== Full Recipe ===
 
This recipe assumes you are not using the recommended scripts and have properly set up your own environment.
 
 
cd <your source root directory>
 
git clone git://gitorious.org/dbusmenu/dbusmenu-qt.git
 
cd <your build root directory, or the module source dir>
 
mkdir <your module build dir>
 
cd <your module build dir>
 
cmake <path to your module source dir>
 
      \ -DCMAKE_INSTALL_PREFIX=$KDEDIR
 
      \ -DCMAKE_BUILD_TYPE=debugfull
 
nice make -j2 # for faster compiles use -j(X+1)' where X is your number of processor cores
 
make install
 
  
 
== Shared-Desktop-Ontologies ==
 
== Shared-Desktop-Ontologies ==
Line 363: Line 225:
 
  nice make -j2 # for faster compiles use -j(X+1)' where X is your number of processor cores
 
  nice make -j2 # for faster compiles use -j(X+1)' where X is your number of processor cores
 
  make install
 
  make install
 
== kdesupport ==
 
 
Requirements as at 2011-03-02, Stable Branch currently KDE Release 4.6, Master currently targeting KDE Release 4.7.
 
 
{| border="1" cellpadding="5" cellspacing="0" align="center"
 
|-
 
! Requirement
 
! Stable
 
! Master
 
! Devel?
 
! Details
 
|-
 
| [http://projects.kde.org/projects/kdesupport/automoc Automoc]
 
|
 
|
 
| No
 
|
 
|-
 
| [http://projects.kde.org/projects/kdesupport/attica Attica]
 
|
 
|
 
| Yes
 
|
 
|-
 
| [http://projects.kde.org/projects/kdesupport/polkit-qt-1 Polkit Qt]
 
|
 
|
 
| Yes
 
|
 
|-
 
| [https://projects.kde.org/projects/kdesupport/strigi Strigi]
 
|
 
|
 
| Yes
 
|
 
|-
 
| [http://projects.kde.org/projects/kdesupport/soprano Soprano]
 
|
 
|
 
| Yes
 
|
 
|-
 
| [http://projects.kde.org/projects/kdesupport/akonadi Akonadi]
 
|
 
|
 
| Yes
 
|
 
|-
 
| [http://projects.kde.org/projects/kdesupport/cagibi Cagibi]
 
|
 
|
 
| Yes
 
|
 
|-
 
| [https://projects.kde.org/projects/kdesupport/phonon Phonon]
 
|
 
|
 
| Yes
 
|
 
|-
 
| Oxygen Icons
 
|
 
|
 
| No
 
|
 
|-
 
| TagLib
 
|
 
|
 
| Yes
 
|
 
|-
 
| cpp2xml
 
|
 
|
 
| No
 
|
 
|}
 
 
The kdesupport module contains a number of KDE developed and supported packages that the main KDE modules depend upon.  Your distribution packages may be sufficient for these requirements when building a KDE stable branch, but master may sometimes require the latest versions of some of these to be built from source.
 
 
Most kdesupport packages have now migrated to Git as separate modules and must be built individually, although some are still left in svn and can be built as a single unit.  The modules are listed below in a rough dependency order.
 
 
All the Git modules can be built using one of the the following recipes, except where noted.
 
 
=== Easy Recipe ===
 
This recipe assumes you have set up the recommended KDE scripts, environment variables, and git configuration.
 
 
cd <your source root directory>
 
git clone kde:<module>.git
 
cd <module>
 
cmakekde
 
 
=== Full Recipe ===
 
This recipe assumes you are not using the recommended scripts and have properly set up your own environment.
 
 
cd <your source root directory>
 
git clone git://anongit.kde.org/<module>.git
 
cd <your build root directory, or the module source dir>
 
mkdir <your module build dir>
 
cd <your module build dir>
 
cmake <path to your module source dir>
 
      \ -DCMAKE_INSTALL_PREFIX=$KDEDIR
 
      \ -DCMAKE_BUILD_TYPE=debugfull
 
      \ -DKDE4_BUILD_TESTS=TRUE
 
nice make -j2 # for faster compiles use -j(X+1)' where X is your number of processor cores
 
make install
 
 
===Automoc ===
 
Automoc is a tool to automate Qt moc file creation. 
 
 
Please see the [http://projects.kde.org/projects/kdesupport/automoc Automoc project page] for details.
 
 
Automoc '''MUST''' be built first as other kdesupport modules depend on it.
 
 
Easy:  git clone kde:automoc.git
 
Full:  git clone git://anongit.kde.org/automoc.git
 
 
===Attica ===
 
Attica is a library for accessing the Open Collaboration Services.
 
 
Please see the [http://projects.kde.org/projects/kdesupport/attica Attica project page] for details.
 
 
Easy:  git clone kde:attica.git
 
Full:  git clone git://anongit.kde.org/attica.git
 
 
===Polkit Qt===
 
Polkit Qt is a library for accessing the PolKit authorization framework.
 
 
Please see the [http://projects.kde.org/projects/kdesupport/polkit-qt-1 Polkit Qt project page] for details.
 
 
It is recommended to have '''polkit >= 0.98''' installed on your system, however Polkit-Qt-1 will build with any polkit-1 version.
 
 
Easy:  git clone kde:polkit-qt-1.git
 
Full:  git clone git://anongit.kde.org/polkit-qt-1.git
 
 
=== Strigi ===
 
Strigi is a library for indexing files.
 
 
Please see the [https://projects.kde.org/projects/kdesupport/strigi Strigi project page] for details.
 
 
Strigi itself has a few dependencies as well: you will need the libraries and headers for libz, libbz2, openssl (libcrypto or libssl), libclucene (>=0.9.16a but watch out: version 0.9.17 does '''not''' work), and either libxml2 or libexpat.
 
 
Easy:
 
  git clone kde:libstreamanalyzer
 
  git clone kde:libstreams
 
  git clone kde:strigi
 
  git clone kde:strigiclient
 
  git clone kde:strigidaemon
 
  git clone kde:strigiutils
 
 
Full:
 
  git clone git://anongit.kde.org/libstreamanalyzer
 
  git clone git://anongit.kde.org/libstreams
 
  git clone git://anongit.kde.org/strigi
 
  git clone git://anongit.kde.org/strigiclient
 
  git clone git://anongit.kde.org/strigidaemon
 
  git clone git://anongit.kde.org/strigiutils
 
 
===Soprano===
 
Soprano is a library for storing RDF data for the Nepomuk semantic desktop.
 
 
Please see the [http://projects.kde.org/projects/kdesupport/soprano Soprano project page] for details.
 
 
Soprano must be built '''BEFORE''' Akonadi.
 
 
Easy:  git clone kde:soprano.git
 
Full:  git clone git://anongit.kde.org/soprano.git
 
 
=== Akonadi ===
 
Akonadi is a library for caching PIM data.
 
 
Please see the [http://projects.kde.org/projects/kdesupport/akonadi Akonadi project page] for details.
 
 
Akonadi must be built '''AFTER''' Soprano.
 
 
Easy:  git clone kde:akonadi.git
 
Full:  git clone git://anongit.kde.org/akonadi.git
 
 
===Cagibi===
 
Cagibi is a cache/proxy daemon for SSDP, the discovery part of UPnP.
 
 
Please see the [http://projects.kde.org/projects/kdesupport/cagibi Cagibi project page] for details.
 
 
Easy:  git clone kde:cagibi.git
 
Full:  git clone git://anongit.kde.org/cagibi.git
 
 
=== Phonon ===
 
Phonon is a sound system abstraction layer.  This is usually packaged with Qt,  but the Phonon version from Qt is not recent enough for KDE sound to work so you will need to build the required version yourself.
 
 
Please see the [https://projects.kde.org/projects/kdesupport/phonon Phonon project page] for details.
 
 
You need to install this Phonon in the same location as Phonon from Qt i.e. in $QTDIR and '''NOT''' in $KDEDIR.
 
 
==== Easy Recipe ====
 
This recipe assumes you have set up the recommended KDE scripts, environment variables, and git configuration.
 
 
cd <your source root directory>
 
git clone kde:phonon.git
 
cd phonon
 
cb
 
cmake $KDE_SRC/phonon
 
      \ -DCMAKE_INSTALL_PREFIX=$QTDIR
 
      \ -DCMAKE_BUILD_TYPE=debugfull
 
      \ -DKDE4_BUILD_TESTS=TRUE
 
make
 
make install
 
 
Note that make install may require root access.
 
 
==== Full Recipe ====
 
This recipe assumes you are not using the recommended scripts and have properly set up your own environment.
 
 
cd <your source root directory>
 
git clone git://anongit.kde.org/phonon.git
 
cd <your build root directory, or the module source dir>
 
mkdir <your module build dir>
 
cd <your module build dir>
 
cmake <path to your module source dir>
 
      \ -DCMAKE_INSTALL_PREFIX=$QTDIR
 
      \ -DCMAKE_BUILD_TYPE=debugfull
 
      \ -DKDE4_BUILD_TESTS=TRUE
 
make
 
make install
 
 
==== Backend ====
 
 
Building the main Phonon module is sufficient for building KDE.  If you also want to play sound then you need to build a backend.  Choose a suitable backend from those available below:
 
 
git clone git://anongit.kde.org/phonon-directshow.git
 
git clone git://anongit.kde.org/phonon-gstreamer.git
 
git clone git://anongit.kde.org/phonon-mmf.git
 
git clone git://anongit.kde.org/phonon-quicktime.git
 
git clone git://anongit.kde.org/phonon-waveout.git
 
git clone git://anongit.kde.org/phonon-xine.git
 
 
==== Troubleshooting ====
 
 
If you get an error like
 
 
designer: symbol lookup error: /path/to/kde/lib/kde4/plugins/phonon_backend/phonon_xine.so:
 
          undefined symbol: _ZN6Phonon12PulseSupport11getInstanceEv
 
 
while running Qt Designer you need to:
 
 
rm $QTDIR/lib/libphonon.so.4
 
 
=== kdesupport svn module ===
 
 
A number of kdesupport packages are still in svn:
 
 
* oxygen-icons
 
* taglib
 
* taglib-extras
 
* cpp2xml
 
* qimageblitz - no longer required?
 
* twine - for building kdebindings
 
* emerge - for building kde on windows
 
 
These packages can be checked out and built together with a single recipe.
 
 
Note that QCA lives in kdesupport svn but is not built by default.  It is recommended that you use your system QCA packages and only checkout the kdesupport svn version if you are going to develop QCA.
 
 
==== Easy Recipe ====
 
This recipe assumes you have set up the recommended KDE scripts, environment variables, and git configuration.
 
 
cd <your source root directory>
 
svn checkout svn://anonsvn.kde.org/home/kde/trunk/kdesupport/
 
cd kdesupport
 
cmakekde
 
 
==== Full Recipe ====
 
This recipe assumes you are not using the recommended scripts and have properly set up your own environment.
 
 
cd <your source root directory>
 
svn checkout svn://anonsvn.kde.org/home/kde/trunk/kdesupport/
 
cd <your build root directory, or the module source dir>
 
mkdir <your module build dir>
 
cd <your module build dir>
 
cmake <path to your module source dir>
 
      \ -DCMAKE_INSTALL_PREFIX=$KDEDIR
 
      \ -DCMAKE_BUILD_TYPE=debugfull
 
      \ -DKDE4_BUILD_TESTS=TRUE
 
make
 
make install
 
 
=== Troubleshooting ===
 
 
If you get a message related to
 
  target libQtTest.so not found
 
you may need to recompile qt-kde. This time you should take out
 
  -nomake demos -nomake examples
 
from the configure command, so that Qt generates library QtTest.
 
 
If you get
 
      CMake Error: Qt qmake not found!
 
Then:
 
      1) uncomment Qt section in .bashrc script (QTDIR, QT_PLUGINS_DIR,     
 
            PKG_CONFIG_PATH variable settings).
 
      2) source ~/.bashrc
 
      3) cd && cd qt-kde
 
      4) make confclean
 
      5) repeat steps for installing Qt (from ./configure line).
 
      6) retry building kdesupport
 
  
 
== Next Step ==
 
== Next Step ==
Once all requirements have been installed it is time to install [[../#kdelibs|kdelibs]]
+
Once all requirements have been installed it is time to install [[../Qt]]

Revision as of 10:04, 3 March 2011

noframe
 
Warning
This page is yet to be reviewed for changes required by the migration to Git. Information and commands on this page may no longer be valid and should be used with care. Please see the KDE Git hub page for more details.



Contents

Getting_Started/Build/Requirements


Building KDE4 From Source/Requirements
Tutorial Series   Getting Started
Previous   Getting Started
What's Next   Qt
Further Reading   n/a

Introduction

This page details the software requirements that need to be installed on your system before you can start building kdelibs and the KDE applications. For most of these requirements it is preferable to use your distribution supplied packages, however in some case you will need to build some requirements yourself and this page will also explain how to do so.

Build Recipes

Two different recipes are provided for building KDE and its prerequisites.

The Easy Recipe relies on you setting up your environment according to the KDE recommendations. This will give you many shortcuts to save on typing. See Setting Up The Environment section to do this.

The Full Recipe is provided for those who wish to control their build environment or to see the full steps required and who don't mind lots of typing.

System Prerequisites

NOTE: This section needs a major update! Update to include all dependencies and the correct version. In the Build KDE page include this table for each module but with just the module requirements listed. Perhaps make this list just for kdelibs/kdebase?

All of these packages should be installed from your distribution. If you cannot meet these requirements from your distribution, it is recommended to either update to a more recent distribution or to build KDE in a virtual machine.

The 'Stable' column shows the required version for the current Stable branch while the 'Master' column shows the required version for the current development version (aka 'trunk'). On most distributions you will also need to install the matching -devel packages for some of the software, this is indicated in the Devel column of the table.

Requirements as at 2011-03-02, Stable Branch currently KDE Release 4.6, Master currently targeting KDE Release 4.7.

Requirement Stable Master Devel? Details
GCC / G++ >= 4.2 >= 4.2 No
Git No
SVN No
pkg-config >= >= No
CMake >= 2.6.4 >= 2.6.4 No
DBus >= 1.4.0 >= 1.4.0 Yes Also dbus-glib
X11 >= >= Yes
Mesa >= >= Yes mesa-common-dev and libglu1-mesa-dev
libjpeg >= >= Yes
libpng >= >= Yes
libungif >= >= Yes
librdf >= >= Yes
libbz2 >= >= Yes
libxml2 >= >= Yes
libxslt >= >= Yes
Boost >= >= Yes
libmysqlclient >= >= Yes
shared-mime-info >= >= Yes
DocBook XML DTD's >= 4.2 >= 4.2 No Required for the KDE documentation and help
DocBook XSl Stylesheets >= 4.2 >= 4.2 No Required for the KDE documentation and help

Hardware Libraries

HAL (Hardware Abstraction Layer) is required by KDE 4.5 and earlier for interfacing with your hardware. Your distribution supplied packages should be sufficient for this.

From KDE 4.6 onwards HAL has been deprecated in favor of uDisk, uPower and related projects, but all but the most recent distributions will still require HAL.

Distributions

The following pages contain distribution specific information for installing the required packages, these may be out-of-date:

Shared-Desktop-Ontologies

Requirements as at 2011-03-02, Stable Branch currently KDE Release 4.6, Master currently targeting KDE Release 4.7.

Requirement Stable Master Devel? Details
Shared-Desktop-Ontologies >= >= No

The ontologies are a shared resource required for the semantic desktop. Your distribution packages should be sufficient for this package but some older distributions may not have them.

Easy Recipe

This recipe assumes you have set up the recommended KDE scripts, environment variables, and git configuration.

cd <your source root directory>
svn checkout https://oscaf.svn.sourceforge.net/svnroot/oscaf/trunk/ontologies
cd ontologies
cmakekde

Full Recipe

This recipe assumes you are not using the recommended scripts and have properly set up your own environment.

cd <your source root directory>
svn checkout https://oscaf.svn.sourceforge.net/svnroot/oscaf/trunk/ontologies
cd <your build root directory, or the module source dir>
mkdir <your module build dir>
cd <your module build dir>
cmake <path to your module source dir>
      \ -DCMAKE_INSTALL_PREFIX=$KDEDIR 
      \ -DCMAKE_BUILD_TYPE=debugfull
nice make -j2 # for faster compiles use -j(X+1)' where X is your number of processor cores
make install

Next Step

Once all requirements have been installed it is time to install Archive:Getting Started/Build/Qt


KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V.Legal