Difference between revisions of "Getting Started/Build/KDE Support"

Jump to: navigation, search
(Requirements)
m (Qt Zeitgeist: libqtzeitgeist → libqzeitgeist)
(40 intermediate revisions by 3 users not shown)
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/KdeSupport}}
+
 
  
 
{{TutorialBrowser|
 
{{TutorialBrowser|
 
 
series=Getting Started|
 
series=Getting Started|
 
+
name=Building KDE4 From Source/KDE Support|
name=Building KDE4 From Source/KdeSupport|
+
pre=[[../Qt|Qt]]|
 
+
next=[[../KDE_Development_Platform|KDE Development Platform]]|
pre=[[../|Requirements]]|
+
 
+
next=[[../|KDE]]|
+
 
|
 
|
 
}}
 
}}
Line 17: Line 13:
 
== Introduction ==
 
== Introduction ==
  
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.
+
The KDE Support 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 Unstable may sometimes require the latest versions 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.
+
Most KDE Support packages have now migrated to Git as separate modules and must be built individually, although some are still left in Subversion and can be built as a single unit.  The modules are listed below in a rough dependency order.
 +
 
 +
=== Required Steps ===
 +
 
 +
You need to have completed the following steps:
 +
* Set up your [[../Environment|Build Environment]]
 +
* Selected your [[../Recipes|Build Recipes]]
 +
* Installed the [[../Requirements|System Requirements]]
 +
* Installed or Built [[../Qt|Qt and related requirements]]
 +
* Understand the [[../Requirements#Definitions|Requirements Table format]]
  
 
== Requirements ==
 
== Requirements ==
  
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.
+
The following table summarizes all the Projects contained in KDE Support and the versions required for building KDE SoftwareThe optional/mandatory coloring is based on the requirements of the KDE Development Platform, the requirements for building other KDE Modules or Applications may vary.
 
+
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"
+
{| border="1" cellpadding="5" cellspacing="0"
 +
|+ '''Build Requirements'''
 
|-
 
|-
! Requirement
+
! width="20%" style="background-color:#EFEFEF;" | Requirement
! Stable
+
! width="15%" style="background-color:#EFEFEF;" | Stable Requires
! Master
+
! width="15%" style="background-color:#EFEFEF;" | Unstable Requires
! Devel?
+
! width="10%" style="background-color:#EFEFEF;" | Devel Pkgs?
! Details
+
! width="40%" style="background-color:#EFEFEF;" | Details
 
|-
 
|-
 
| [http://projects.kde.org/projects/kdesupport/automoc Automoc]
 
| [http://projects.kde.org/projects/kdesupport/automoc Automoc]
Line 82: Line 86:
 
| Yes
 
| Yes
 
|  
 
|  
 +
|-
 +
| [http://projects.kde.org/projects/kdesupport/prison Prison]
 +
|
 +
| style="background-color:#66FF66" | Any
 +
| Yes
 +
| A Qt based barcode library
 
|-
 
|-
 
| Oxygen Icons
 
| Oxygen Icons
Line 92: Line 102:
 
|  
 
|  
 
|  
 
|  
| No
+
| Yes
 
|  
 
|  
 
|-
 
|-
Line 108: Line 118:
 
|}
 
|}
  
 +
== Template ==
  
 +
Project is a
  
=== Build Recipes ===
+
{| border="1" cellpadding="5" cellspacing="0"
Two different recipes are provided for building kdesupport. All the Git modules can be built using one of the the following recipes, except where noted.
+
|-
 +
| width="25%" style="background-color:#EFEFEF;" | '''Project Page'''
 +
| width="75%" | [http://projects.kde.org/projects/kdesupport/project http://projects.kde.org/projects/kdesupport/project]
 +
|-
 +
| style="background-color:#EFEFEF;" | '''Stable Version'''
 +
|
 +
|-
 +
| style="background-color:#EFEFEF;" | '''Required By'''
 +
|
 +
|-
 +
| style="background-color:#EFEFEF;" | '''Easy Repository'''
 +
| git clone kde:project.git
 +
|-
 +
| style="background-color:#EFEFEF;" | '''Full Repository'''
 +
| git clone git://anongit.kde.org/project.git
 +
|}
  
=== Easy Recipe ===
 
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 [[Getting_Started/Build/KDE4#Setting_up_the_environment|Setting Up The Environment]] section to do this.
 
  
cd <your source root directory>
+
{| border="1" cellpadding="5" cellspacing="0"
git clone kde:<module>.git
+
|+ '''KDE Software Build Requirements'''
cd <module>
+
|-
cmakekde
+
! width="20%" style="background-color:#EFEFEF;" | Requirement
 +
! width="15%" style="background-color:#EFEFEF;" | Stable Requires
 +
! width="15%" style="background-color:#EFEFEF;" | Unstable Requires
 +
! width="10%" style="background-color:#EFEFEF;" | Devel Pkgs?
 +
! width="40%" style="background-color:#EFEFEF;" | Details
 +
|-
 +
| [http://projects.kde.org/projects/kdesupport/project Project]
 +
| style="background-color:#66FF66;" |
 +
| style="background-color:#66FF66;" |
 +
| Yes
 +
| A library
 +
|}
  
=== Full Recipe ===
 
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.
 
  
cd <your source root directory>
+
{| border="1" cellpadding="5" cellspacing="0"
git clone git://anongit.kde.org/<module>.git
+
|+ '''Project Build Requirements'''
cd <your build root directory, or the module source dir>
+
|-
mkdir <your module build dir>
+
! width="20%" style="background-color:#EFEFEF;" | Requirement
cd <your module build dir>
+
! width="15%" style="background-color:#EFEFEF;" | Stable Requires
cmake <path to your module source dir>
+
! width="15%" style="background-color:#EFEFEF;" | Unstable Requires
      \ -DCMAKE_INSTALL_PREFIX=$KDEDIR
+
! width="10%" style="background-color:#EFEFEF;" | Devel Pkgs?
      \ -DCMAKE_BUILD_TYPE=debugfull
+
! width="40%" style="background-color:#EFEFEF;" | Details
      \ -DKDE4_BUILD_TESTS=TRUE
+
|-
nice make -j2 # for faster compiles use -j(X+1)' where X is your number of processor cores
+
| [http:// Project]
make install
+
| style="background-color:#FF6666" |
 +
| style="background-color:#FF6666" |
 +
| Yes
 +
| A library for  
 +
|}
  
 
== Automoc ==
 
== 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 is a tool to automate Qt moc file creation. Automoc '''MUST''' be built first as other KDE Support Modules depend on it.
  
Automoc '''MUST''' be built first as other kdesupport modules depend on it.
+
{| border="1" cellpadding="5" cellspacing="0"
 +
|-
 +
| width="25%" style="background-color:#EFEFEF;" | '''Project Page'''
 +
| width="75%" | [http://projects.kde.org/projects/kdesupport/automoc http://projects.kde.org/projects/kdesupport/automoc]
 +
|-
 +
| style="background-color:#EFEFEF;" | '''Stable Version'''
 +
| 0.9.88
 +
|-
 +
| style="background-color:#EFEFEF;" | '''Required By'''
 +
| All KDE Modules and Projects using moc
 +
|-
 +
| style="background-color:#EFEFEF;" | '''Easy Repository'''
 +
| git clone kde:automoc.git
 +
|-
 +
| style="background-color:#EFEFEF;" | '''Full Repository'''
 +
| git clone git://anongit.kde.org/automoc.git
 +
|}
  
Easy: git clone kde:automoc.git
+
 
Full: git clone git://anongit.kde.org/automoc.git
+
{| border="1" cellpadding="5" cellspacing="0"
 +
|+ '''KDE Software Build Requirements'''
 +
|-
 +
! width="20%" style="background-color:#EFEFEF;" | Requirement
 +
! width="15%" style="background-color:#EFEFEF;" | Stable Requires
 +
! width="15%" style="background-color:#EFEFEF;" | Unstable Requires
 +
! width="10%" style="background-color:#EFEFEF;" | Devel Pkgs?
 +
! width="40%" style="background-color:#EFEFEF;" | Details
 +
|-
 +
| [http://projects.kde.org/projects/kdesupport/automoc Automoc]
 +
| style="background-color:#FF6666;" |
 +
| style="background-color:#FF6666;" |
 +
| No
 +
| A tool to automate Qt moc file creation.
 +
|}
  
 
== Attica ==
 
== Attica ==
 +
 
Attica is a library for accessing the Open Collaboration Services.  
 
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.
+
{| border="1" cellpadding="5" cellspacing="0"
 +
|-
 +
| width="25%" style="background-color:#EFEFEF;" | '''Project Page'''
 +
| width="75%" | [http://projects.kde.org/projects/kdesupport/attica http://projects.kde.org/projects/kdesupport/attica]
 +
|-
 +
| style="background-color:#EFEFEF;" | '''Stable Version'''
 +
| 0.2.0
 +
|-
 +
| style="background-color:#EFEFEF;" | '''Required By'''
 +
|
 +
|-
 +
| style="background-color:#EFEFEF;" | '''Easy Repository'''
 +
| git clone kde:attica.git
 +
|-
 +
| style="background-color:#EFEFEF;" | '''Full Repository'''
 +
| git clone git://anongit.kde.org/attica.git
 +
|}
  
Easy: git clone kde:attica.git
+
 
Full: git clone git://anongit.kde.org/attica.git
+
{| border="1" cellpadding="5" cellspacing="0"
 +
|+ '''KDE Software Build Requirements'''
 +
|-
 +
! width="20%" style="background-color:#EFEFEF;" | Requirement
 +
! width="15%" style="background-color:#EFEFEF;" | Stable Requires
 +
! width="15%" style="background-color:#EFEFEF;" | Unstable Requires
 +
! width="10%" style="background-color:#EFEFEF;" | Devel Pkgs?
 +
! width="40%" style="background-color:#EFEFEF;" | Details
 +
|-
 +
| [http://projects.kde.org/projects/kdesupport/attica Attica]
 +
| style="background-color:#66FF66;" |
 +
| style="background-color:#66FF66;" |
 +
| Yes
 +
| A library for accessing the Open Collaboration Services.
 +
|}
  
 
== Polkit Qt==
 
== 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.
+
Polkit Qt is a library for accessing the PolicyKit authorization framework.  
  
It is recommended to have '''polkit >= 0.98''' installed on your system, however Polkit-Qt-1 will build with any polkit-1 version.
+
{| border="1" cellpadding="5" cellspacing="0"
 +
|-
 +
| width="25%" style="background-color:#EFEFEF;" | '''Project Page'''
 +
| width="75%" | [http://projects.kde.org/projects/kdesupport/polkit-qt-1 http://projects.kde.org/projects/kdesupport/polkit-qt-1]
 +
|-
 +
| style="background-color:#EFEFEF;" | '''Stable Version'''
 +
| 0.99
 +
|-
 +
| style="background-color:#EFEFEF;" | '''Required By'''
 +
|
 +
|-
 +
| style="background-color:#EFEFEF;" | '''Easy Repository'''
 +
| git clone kde:polkit-qt-1.git
 +
|-
 +
| style="background-color:#EFEFEF;" | '''Full Repository'''
 +
| git clone git://anongit.kde.org/polkit-qt-1.git
 +
|}
  
Easy: git clone kde:polkit-qt-1.git
+
 
Full: git clone git://anongit.kde.org/polkit-qt-1.git
+
{| border="1" cellpadding="5" cellspacing="0"
 +
|+ '''KDE Software Build Requirements'''
 +
|-
 +
! width="20%" style="background-color:#EFEFEF;" | Requirement
 +
! width="15%" style="background-color:#EFEFEF;" | Stable Requires
 +
! width="15%" style="background-color:#EFEFEF;" | Unstable Requires
 +
! width="10%" style="background-color:#EFEFEF;" | Devel Pkgs?
 +
! width="40%" style="background-color:#EFEFEF;" | Details
 +
|-
 +
| [http://projects.kde.org/projects/kdesupport/polkit-qt-1 PolKit Qt]
 +
| style="background-color:#66FF66;" |
 +
| style="background-color:#66FF66;" |
 +
| Yes
 +
| A library for accessing the PolicyKit authorization framework.
 +
|}
 +
 
 +
 
 +
{| border="1" cellpadding="5" cellspacing="0"
 +
|+ '''Polkit Qt Build Requirements'''
 +
|-
 +
! width="20%" style="background-color:#EFEFEF;" | Requirement
 +
! width="15%" style="background-color:#EFEFEF;" | Stable Requires
 +
! width="15%" style="background-color:#EFEFEF;" | Unstable Requires
 +
! width="10%" style="background-color:#EFEFEF;" | Devel Pkgs?
 +
! width="40%" style="background-color:#EFEFEF;" | Details
 +
|-
 +
| [http://www.freedesktop.org/wiki/Software/PolicyKit PolicyKit]
 +
| style="background-color:#FF6666" | >= 0.98
 +
| style="background-color:#FF6666" | >= 0.98
 +
| Yes
 +
| The PolicyKit authorization framework.  PolicyKit 0.98 is recommended, but Polkit Qt will build with any version.
 +
|}
  
 
== Strigi ==
 
== Strigi ==
Strigi is a library for indexing files.
 
  
Please see the [https://projects.kde.org/projects/kdesupport/strigi Strigi project page] for details.
+
Strigi is a library for indexing files. Note that Strigi has now been split into a number of separate Git sub-projects, but these can still be cloned and built as a single entity using the Strigi parent project.
  
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.
+
{| border="1" cellpadding="5" cellspacing="0"
 +
|-
 +
| width="25%" style="background-color:#EFEFEF;" | '''Project Page'''
 +
| width="75%" | [http://projects.kde.org/projects/kdesupport/strigi http://projects.kde.org/projects/kdesupport/strigi]
 +
|-
 +
| style="background-color:#EFEFEF;" | '''Stable Version'''
 +
| 0.7.2
 +
|-
 +
| style="background-color:#EFEFEF;" | '''Required By'''
 +
|
 +
|-
 +
| style="background-color:#EFEFEF;" | '''Easy Repository'''
 +
| git clone kde:strigi
 +
|-
 +
| style="background-color:#EFEFEF;" | '''Full Repository'''
 +
| git clone git://anongit.kde.org/strigi
 +
|}
  
Easy:
+
{{ warning|As of 2011-03-21: After cloning the Strigi parent project, you will have to run the ''change_to_development_git.sh'' script to pull in all sub projects.}}
  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:
+
{| border="1" cellpadding="5" cellspacing="0"
  git clone git://anongit.kde.org/libstreamanalyzer
+
|+ '''KDE Software Build Requirements'''
  git clone git://anongit.kde.org/libstreams
+
|-
  git clone git://anongit.kde.org/strigi
+
! width="20%" style="background-color:#EFEFEF;" | Requirement
  git clone git://anongit.kde.org/strigiclient
+
! width="15%" style="background-color:#EFEFEF;" | Stable Requires
  git clone git://anongit.kde.org/strigidaemon
+
! width="15%" style="background-color:#EFEFEF;" | Unstable Requires
  git clone git://anongit.kde.org/strigiutils
+
! width="10%" style="background-color:#EFEFEF;" | Devel Pkgs?
 +
! width="40%" style="background-color:#EFEFEF;" | Details
 +
|-
 +
| [http://projects.kde.org/projects/kdesupport/strigi Strigi]
 +
| style="background-color:#66FF66;" |
 +
| style="background-color:#66FF66;" |
 +
| Yes
 +
| A library for indexing files.
 +
|}
 +
 
 +
 
 +
{| border="1" cellpadding="5" cellspacing="0"
 +
|+ '''Project Build Requirements'''
 +
|-
 +
! width="20%" style="background-color:#EFEFEF;" | Requirement
 +
! width="15%" style="background-color:#EFEFEF;" | Stable Requires
 +
! width="15%" style="background-color:#EFEFEF;" | Unstable Requires
 +
! width="10%" style="background-color:#EFEFEF;" | Devel Pkgs?
 +
! width="40%" style="background-color:#EFEFEF;" | Details
 +
|-
 +
| [http://qt.nokia.com/ Qt]
 +
| style="background-color:#FF6666" | >= 4.3.0
 +
| style="background-color:#FF6666" | >= 4.3.0
 +
| Yes
 +
| The Qt development framework.
 +
|-
 +
| [http://www.zlib.net/ libz]
 +
| style="background-color:#FF6666" |
 +
| style="background-color:#FF6666" |
 +
| Yes
 +
| A library for zip file compression
 +
|-
 +
| [http://bzip.org/ libbz2]
 +
| style="background-color:#FF6666" |
 +
| style="background-color:#FF6666" |
 +
| Yes
 +
| A library for bzip2 file compression.
 +
|-
 +
| [http://xmlsoft.org/ libxml2]
 +
| style="background-color:#FF6666" |
 +
| style="background-color:#FF6666" |
 +
| Yes
 +
| A library for parsing XML
 +
|-
 +
| [http://clucene.sourceforge.net/ Clucene]
 +
| style="background-color:#66FF66" | >=0.9.16a
 +
| style="background-color:#66FF66" | >=0.9.16a
 +
| Yes
 +
| A high-performance indexing and searching API.  Version 0.9.17 does '''not''' work.
 +
|-
 +
| [http://www.exiv2.org/ Exiv2]
 +
| style="background-color:#66FF66" |
 +
| style="background-color:#66FF66" |
 +
| Yes
 +
| A library to manage image metadata.
 +
|-
 +
| [http://www.ffmpeg.org/ FFMPEG]
 +
| style="background-color:#66FF66" |
 +
| style="background-color:#66FF66" |
 +
| Yes
 +
| A library for reading audio and video files.
 +
|-
 +
| [http://www.freedesktop.org/wiki/Software/dbus DBus]
 +
| style="background-color:#66FF66" |
 +
| style="background-color:#66FF66" |
 +
| Yes
 +
| A message bus system.
 +
|-
 +
| [http://oss.sgi.com/projects/fam/ FAM]
 +
| style="background-color:#66FF66" |
 +
| style="background-color:#66FF66" |
 +
| Yes
 +
| A tool for file system monitoring.
 +
|-
 +
| [http://logging.apache.org/log4cxx/index.html Log4cxx]
 +
| style="background-color:#66FF66" |
 +
| style="background-color:#66FF66" |
 +
| Yes
 +
| A logging framework for C++
 +
|-
 +
| [http://sourceforge.net/projects/cppunit/ CppUnit]
 +
| style="background-color:#66FF66" |
 +
| style="background-color:#66FF66" |
 +
| Yes
 +
| A C++ Unit Testing framework
 +
|}
  
 
== Soprano ==
 
== Soprano ==
 +
 
Soprano is a library for storing RDF data for the Nepomuk semantic desktop.  
 
Soprano is a library for storing RDF data for the Nepomuk semantic desktop.  
  
Line 198: Line 437:
  
 
== Akonadi ==
 
== Akonadi ==
 +
 
Akonadi is a library for caching PIM data.  
 
Akonadi is a library for caching PIM data.  
  
Line 208: Line 448:
  
 
== Cagibi ==
 
== Cagibi ==
 +
 
Cagibi is a cache/proxy daemon for SSDP, the discovery part of UPnP.
 
Cagibi is a cache/proxy daemon for SSDP, the discovery part of UPnP.
  
Line 214: Line 455:
 
  Easy:  git clone kde:cagibi.git
 
  Easy:  git clone kde:cagibi.git
 
  Full:  git clone git://anongit.kde.org/cagibi.git
 
  Full:  git clone git://anongit.kde.org/cagibi.git
 +
 +
== Qt Zeitgeist ==
 +
 +
Qt Zeitgeist is a QT wrapper for the Zeitgeist logging program.
 +
 +
Please see the [http://projects.kde.org/projects/kdesupport/libqtzeitgeist Qt Zeitgeist project page] for details.
 +
 +
Easy:  git clone kde:libqzeitgeist.git
 +
Full:  git clone git://anongit.kde.org/libqzeitgeist.git
  
 
== Phonon ==
 
== 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.
 
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.
  
Line 223: Line 474:
  
 
=== Easy Recipe ===
 
=== Easy Recipe ===
 +
 
This recipe assumes you have set up the recommended KDE scripts, environment variables, and git configuration.
 
This recipe assumes you have set up the recommended KDE scripts, environment variables, and git configuration.
  
Line 229: Line 481:
 
  cd phonon
 
  cd phonon
 
  cb
 
  cb
  cmake $KDE_SRC/phonon
+
  cmake <path to your module source dir>
 
       \ -DCMAKE_INSTALL_PREFIX=$QTDIR  
 
       \ -DCMAKE_INSTALL_PREFIX=$QTDIR  
 
       \ -DCMAKE_BUILD_TYPE=debugfull
 
       \ -DCMAKE_BUILD_TYPE=debugfull
Line 239: Line 491:
  
 
=== Full Recipe ===
 
=== Full Recipe ===
 +
 
This recipe assumes you are not using the recommended scripts and have properly set up your own environment.
 
This recipe assumes you are not using the recommended scripts and have properly set up your own environment.
  
Line 249: Line 502:
 
       \ -DCMAKE_INSTALL_PREFIX=$QTDIR  
 
       \ -DCMAKE_INSTALL_PREFIX=$QTDIR  
 
       \ -DCMAKE_BUILD_TYPE=debugfull
 
       \ -DCMAKE_BUILD_TYPE=debugfull
      \ -DKDE4_BUILD_TESTS=TRUE
 
 
  make
 
  make
 
  make install
 
  make install
Line 257: Line 509:
 
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:
 
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-gstreamer.git
 +
git clone git://anongit.kde.org/phonon-xine.git
 +
git clone git://anongit.kde.org/phonon-directshow.git
 
  git clone git://anongit.kde.org/phonon-mmf.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-quicktime.git
 
  git clone git://anongit.kde.org/phonon-waveout.git
 
  git clone git://anongit.kde.org/phonon-waveout.git
git clone git://anongit.kde.org/phonon-xine.git
+
 
 +
Note that DirectShow is for Windows only.
  
 
=== Troubleshooting ===
 
=== Troubleshooting ===
Line 274: Line 528:
  
 
  rm $QTDIR/lib/libphonon.so.4
 
  rm $QTDIR/lib/libphonon.so.4
 +
 +
== Prison ==
 +
 +
Prison is a barcode library to enable optional barcode support in KDE Software.  It was introduced in the KDE 4.7 Release Cycle.
 +
 +
{| border="1" cellpadding="5" cellspacing="0"
 +
|-
 +
| width="25%" | '''Project Page'''
 +
| width="75%" | [http://projects.kde.org/projects/kdesupport/prison http://projects.kde.org/projects/kdesupport/prison]
 +
|-
 +
| '''Stable Version'''
 +
| Unreleased
 +
|-
 +
| '''Required By'''
 +
| No KDE Modules as yet
 +
|-
 +
| '''Easy Repository'''
 +
| git clone kde:prison.git
 +
|-
 +
| '''Full Repository'''
 +
| git clone git://anongit.kde.org/prison.git
 +
|}
 +
 +
 +
{| border="1" cellpadding="5" cellspacing="0"
 +
|+ '''KDE Software Build Requirements'''
 +
|-
 +
! width="20%" | Requirement
 +
! width="15%" | Stable Requires
 +
! width="15%" | Unstable Requires
 +
! width="10%" | Devel Pkgs?
 +
! width="40%" | Details
 +
|-
 +
| [http://projects.kde.org/projects/kdesupport/prison Prison]
 +
|
 +
| style="background-color:#6ECFFF;" | Any
 +
| Yes
 +
| A Qt based barcode library
 +
|}
 +
 +
 +
{| border="1" cellpadding="5" cellspacing="0"
 +
|+ '''Prison Build Requirements'''
 +
|-
 +
! width="20%" | Requirement
 +
! width="15%" | Stable Requires
 +
! width="15%" | Unstable Requires
 +
! width="10%" | Devel Pkgs?
 +
! width="40%" | Details
 +
|-
 +
| [http://fukuchi.org/works/qrencode/index.en.html QRencode]
 +
|
 +
| style="background-color:#FF6E6E;" | Any
 +
| Yes
 +
| A library for reading and writing QR Code barcodes
 +
|-
 +
| [http://www.libdmtx.org/ Dmtx]
 +
|
 +
| style="background-color:#FF6E6E;" | Any
 +
| Yes
 +
| A library for reading and writing Data Matrix 2D barcodes
 +
|}
  
 
== kdesupport svn module ==
 
== kdesupport svn module ==
Line 292: Line 608:
  
 
=== Easy Recipe ===
 
=== Easy Recipe ===
 +
 
This recipe assumes you have set up the recommended KDE scripts, environment variables, and git configuration.
 
This recipe assumes you have set up the recommended KDE scripts, environment variables, and git configuration.
  
Line 297: Line 614:
 
  svn checkout svn://anonsvn.kde.org/home/kde/trunk/kdesupport/
 
  svn checkout svn://anonsvn.kde.org/home/kde/trunk/kdesupport/
 
  cd kdesupport
 
  cd kdesupport
  cmakekde
+
  kdebuild
  
 
=== Full Recipe ===
 
=== Full Recipe ===
 +
 
This recipe assumes you are not using the recommended scripts and have properly set up your own environment.
 
This recipe assumes you are not using the recommended scripts and have properly set up your own environment.
  
Line 334: Line 652:
  
 
= Next Step =
 
= Next Step =
Once all the kdesupport requirements have been installed it is time to install [[../#kdelibs|kdelibs]]
+
 
 +
Once all the KDE Support requirements have been installed it is time to install the [[../KDE_Development_Platform|KDE Development Platform]]

Revision as of 22:33, 3 November 2012

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.



Building KDE4 From Source/KDE Support
Tutorial Series   Getting Started
Previous   Qt
What's Next   KDE Development Platform
Further Reading   n/a

Contents

Introduction

The KDE Support 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 Unstable may sometimes require the latest versions to be built from source.

Most KDE Support packages have now migrated to Git as separate modules and must be built individually, although some are still left in Subversion and can be built as a single unit. The modules are listed below in a rough dependency order.

Required Steps

You need to have completed the following steps:

Requirements

The following table summarizes all the Projects contained in KDE Support and the versions required for building KDE Software. The optional/mandatory coloring is based on the requirements of the KDE Development Platform, the requirements for building other KDE Modules or Applications may vary.

Build Requirements
Requirement Stable Requires Unstable Requires Devel Pkgs? Details
Automoc No
Attica Yes
Polkit Qt Yes
Strigi Yes
Soprano Yes
Akonadi Yes
Cagibi Yes
Phonon Yes
Prison Any Yes A Qt based barcode library
Oxygen Icons No
QImageBlitz Yes
TagLib Yes
cpp2xml No

Template

Project is a

Project Page http://projects.kde.org/projects/kdesupport/project
Stable Version
Required By
Easy Repository git clone kde:project.git
Full Repository git clone git://anongit.kde.org/project.git


KDE Software Build Requirements
Requirement Stable Requires Unstable Requires Devel Pkgs? Details
Project Yes A library


Project Build Requirements
Requirement Stable Requires Unstable Requires Devel Pkgs? Details
[http:// Project] Yes A library for

Automoc

Automoc is a tool to automate Qt moc file creation. Automoc MUST be built first as other KDE Support Modules depend on it.

Project Page http://projects.kde.org/projects/kdesupport/automoc
Stable Version 0.9.88
Required By All KDE Modules and Projects using moc
Easy Repository git clone kde:automoc.git
Full Repository git clone git://anongit.kde.org/automoc.git


KDE Software Build Requirements
Requirement Stable Requires Unstable Requires Devel Pkgs? Details
Automoc No A tool to automate Qt moc file creation.

Attica

Attica is a library for accessing the Open Collaboration Services.

Project Page http://projects.kde.org/projects/kdesupport/attica
Stable Version 0.2.0
Required By
Easy Repository git clone kde:attica.git
Full Repository git clone git://anongit.kde.org/attica.git


KDE Software Build Requirements
Requirement Stable Requires Unstable Requires Devel Pkgs? Details
Attica Yes A library for accessing the Open Collaboration Services.

Polkit Qt

Polkit Qt is a library for accessing the PolicyKit authorization framework.

Project Page http://projects.kde.org/projects/kdesupport/polkit-qt-1
Stable Version 0.99
Required By
Easy Repository git clone kde:polkit-qt-1.git
Full Repository git clone git://anongit.kde.org/polkit-qt-1.git


KDE Software Build Requirements
Requirement Stable Requires Unstable Requires Devel Pkgs? Details
PolKit Qt Yes A library for accessing the PolicyKit authorization framework.


Polkit Qt Build Requirements
Requirement Stable Requires Unstable Requires Devel Pkgs? Details
PolicyKit >= 0.98 >= 0.98 Yes The PolicyKit authorization framework. PolicyKit 0.98 is recommended, but Polkit Qt will build with any version.

Strigi

Strigi is a library for indexing files. Note that Strigi has now been split into a number of separate Git sub-projects, but these can still be cloned and built as a single entity using the Strigi parent project.

Project Page http://projects.kde.org/projects/kdesupport/strigi
Stable Version 0.7.2
Required By
Easy Repository git clone kde:strigi
Full Repository git clone git://anongit.kde.org/strigi
noframe
 
Warning
As of 2011-03-21: After cloning the Strigi parent project, you will have to run the change_to_development_git.sh script to pull in all sub projects.


KDE Software Build Requirements
Requirement Stable Requires Unstable Requires Devel Pkgs? Details
Strigi Yes A library for indexing files.


Project Build Requirements
Requirement Stable Requires Unstable Requires Devel Pkgs? Details
Qt >= 4.3.0 >= 4.3.0 Yes The Qt development framework.
libz Yes A library for zip file compression
libbz2 Yes A library for bzip2 file compression.
libxml2 Yes A library for parsing XML
Clucene >=0.9.16a >=0.9.16a Yes A high-performance indexing and searching API. Version 0.9.17 does not work.
Exiv2 Yes A library to manage image metadata.
FFMPEG Yes A library for reading audio and video files.
DBus Yes A message bus system.
FAM Yes A tool for file system monitoring.
Log4cxx Yes A logging framework for C++
CppUnit Yes A C++ Unit Testing framework

Soprano

Soprano is a library for storing RDF data for the Nepomuk semantic desktop.

Please see the 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 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 Cagibi project page for details.

Easy:  git clone kde:cagibi.git
Full:  git clone git://anongit.kde.org/cagibi.git

Qt Zeitgeist

Qt Zeitgeist is a QT wrapper for the Zeitgeist logging program.

Please see the Qt Zeitgeist project page for details.

Easy:  git clone kde:libqzeitgeist.git
Full:  git clone git://anongit.kde.org/libqzeitgeist.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 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 <path to your module source dir>
      \ -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
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-gstreamer.git
git clone git://anongit.kde.org/phonon-xine.git
git clone git://anongit.kde.org/phonon-directshow.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

Note that DirectShow is for Windows only.

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

Prison

Prison is a barcode library to enable optional barcode support in KDE Software. It was introduced in the KDE 4.7 Release Cycle.

Project Page http://projects.kde.org/projects/kdesupport/prison
Stable Version Unreleased
Required By No KDE Modules as yet
Easy Repository git clone kde:prison.git
Full Repository git clone git://anongit.kde.org/prison.git


KDE Software Build Requirements
Requirement Stable Requires Unstable Requires Devel Pkgs? Details
Prison Any Yes A Qt based barcode library


Prison Build Requirements
Requirement Stable Requires Unstable Requires Devel Pkgs? Details
QRencode Any Yes A library for reading and writing QR Code barcodes
Dmtx Any Yes A library for reading and writing Data Matrix 2D barcodes

kdesupport svn module

A number of kdesupport packages are still in svn:

  • oxygen-icons
  • qimageblitz - for building kde-workspace
  • taglib
  • taglib-extras
  • cpp2xml
  • 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
kdebuild

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

Once all the KDE Support requirements have been installed it is time to install the KDE Development Platform


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