KDE TechBase - User contributions [en]

Getting Started

2010-12-16T02:14:28Z

Fulldecent: Reformat, see also http://techbase.kde.org/User:AaronPeterson and http://techbase.kde.org/index.php?title=User:Fulldecent

{{Template:I18n/Language Navigation Bar|Getting_Started}}

==Installing KDE SC and its Prerequesites==
There are several ways to install KDE SC so that you can use and develop KDE software. Below are complete instructions for installing KDE4 on a Linux system based on whether you want an Official Release, a Nightly Build, Stable 4.x Release, or Trunk.

<table border="1" width="100%" cellpadding="5">
<tr>
<td width="25%" style="background: #FFEFD3">'''Official Release'''
<td width="25%" style="background: #FFFEE4">'''Nightly Build'''
<td width="25%" style="background: #D0ECEA">'''Stable from Source'''
<td width="25%" style="background: #9FD6D2">'''Trunk'''
<tr>
<td>''For the casual user, or a developer who is working on applications outside of KDE SC''
<td>''For application developers or package managers who are not modifying the core of KDE SC''
<td>''For KDE SC and applications developers that want to spend less time setting up a build system''
<td>''For developers working on core KDE SC functionality''
<tr>
<td rowspan=4>1. Use a [[Distributions with KDE|Distribution with KDE]] to set up a fully functional KDE system in one step. Also install the "developer packages" if you want to compile KDE software
<td>1. Install [[build requirements]] from your distribution
<td>1. Install [[build requirements]] from your distribution
<td>1. Install [[build requirements]] from your distribution
<tr>
<td rowspan=3>2. Download and setup KDE SC easily using [[Getting_Started/Using Project Neon to contribute to KDE|Project Neon]]
<td>2. Download KDE source from [[Getting_Started/Sources/Anonymous_SVN|SVN]]
<td>2. Download KDE source from [[Getting_Started/Sources/Anonymous_SVN|SVN]]
<tr>
<td>3. [[Getting_Started/Build/KDE4.x|Build a stable 4.x release]]
<td>3. [[Getting_Started/Build/KDE4|Build KDE SC from trunk]]
<tr>
<td>4. [[Getting_Started/Set_up_KDE_4_for_development|Set up scripts]] to ease KDE development
<td>4. [[Getting_Started/Set_up_KDE_4_for_development|Set up scripts]] to ease KDE development
</table>
For instructions on installing KDE SC on Windows, BSD, or Mac OS X, or instructions for installing KDE3, please see the [[Getting_Started/Build|other supported platforms]] page. There are also [[Getting_Started/Build/KDE4.x_Upgrade|upgrade instructions from a branch to trunk]].

Below is additional information you may be interested in before installing KDE.

==Build Notes for Special Users==

* '''Distribution managers''' may be interested in [[Getting_Started/Build/KDE4/on_virtual_machines|installing KDE SC using a virtual machine]].
* '''Core developers''' may want to use a [[Developer_Setups|common KDE developer setup]] (this page is not complete).

==QT==

''In each installation scenario above, QT in installed in the most appropriate way.'' For you reference, there are three ways to install:

; System Qt
: Often the easiest way to go, because most people have it already, you may have to install the QCA plugin as root though.

; KDE-Qt
:Previously known as qt-copy -- This is the minimum version of Qt any of your users are expected to have. Some bugs may be fixed in new Qt, so you may have to work-around bugs in lower versions, including this one.

; Main Qt
: Get it straight from Nokia, experience the latest cool features, but note that many people will be using older distributions with older Qt.

==Source Repository==

Currently, KDE SC source code is [[Getting_Started/Sources/Anonymous_SVN|accessed using svn]], but in the future, we are migrating to Git. [[Getting_Started/Sources/Amarok_Git_Tutorial|Amarok has already migrated to Git]].

== Troubleshooting the build ==
See [[Getting_Started/Build/KDE4/Troubleshooting|Troubleshooting]]

Compile and Linking errors are frequent sources of discouragement. Make careful note of the first occurrence of an error in your build process. It could be as simple as a bad environment variable, an unexpected version of a library or missing prerequisite.

Please review your logs and do searches for fixes. If you cannot find a solution, try [[Build/KDE4/Errors]], the IRC channel, and the mailing lists. You can post your detailed issue from [[Build/Stories]].

If you are building from trunk and following the instructions linked from here or from [[Build_KDE4.6_on_Kubuntu|Build KDE 4.5 on Kubuntu]] and would like free support, please contact:
: Aaron Peterson
: 206-334-5925 (lives in GMT -8 hours)
: Or leave a message at http://techbase.kde.org/User:AaronPeterson

==Extra Tools==
You will likely want to use a stable package from your distribution instead of the ones of the KDE version you are working on.

For most development topics, and documentation, see [[Development]]

; Opening and creating KDE project files
* [[eclipse]]
* [[kdevelop]]
* [[Development/Tutorials/Using_Qt_Designer|qtdesigner]]

==Contribution==
You may not need the latest bleeding-edge version of KDE with which to develop. Much of the code will be similar between versions and your patch might work. However, Trunk is where major changes are introduced, and branches are mostly for maintenance/bug fixes.

[[Image:Action_tool.svg|right|32px]]
* [[Contribute|Contribute]]
* [[Contribute/Send_Patches|Send Patches]]
* [[Contribute/Bugsquad|Bugsquad]]
* [[Getting_Started/Using Project Neon to contribute to KDE|Using Project Neon to contribute to KDE]]
* [[Getting_Started/EasyStartDevelopmentOnDebian | Build, change and run packaged KDE applications on Debian]]

[[Category:Build_KDE]]

User:Fulldecent

2010-12-16T02:11:25Z

Fulldecent:

I am interested in compiling KDE SC on a stock ubuntu-server distribution in under 7 days, and then updating the documentation so that a new contributor to KDE can do this in under 6 days. I think the huge up-front commitment to build from trunk is a barrier to entry for new contributors.

Here is a list of documentation that I am consulting and working on. They are listed in order from http://kde.org/community/getinvolved/, a place where new contributors can start, and is hierarchal based on hyper links. Action that is required is also included on this list. Ultimately, this should result in a runnable system.

== Going with kdesrc-build ==
* Create Parallels virtual machine
* Install ubuntu-server
* sudo apt-get update
* sudo apt-get upgrade
* http://kde.org/community/getinvolved/
** http://kde.org/community/getinvolved/development/
*** http://techbase.kde.org/Getting_Started/Build/Unstable_Version
**** http://kdesrc-build.kde.org/
***** http://techbase.kde.org/Getting_Started/Build/kdesvn-build
****** http://techbase.kde.org/Getting_Started/Build/KDE4#Required_packages_from_your_distribution
******* Run commands on this page
****** http://kdesrc-build.kde.org/
******* http://kdesrc-build.kde.org/releases/kdesrc-build-1.12.php
******** Download http://kdesrc-build.kde.org/releases/kdesrc-build-1.12.tar.bz2
****** Run commands at [http://techbase.kde.org/Getting_Started/Build/kdesvn-build#Download_and_install_kdesrc-build #Download_and_install_kdesrc-build]
****** Run commands at [http://techbase.kde.org/Getting_Started/Build/kdesvn-build#Setup_the_configuration #Setup_the_configuration]
****** cd ~/kdesrc && ./kdesrc-build qt-copy

== Latest problem with kdesrc-build method ==
Kernel panic during git update on qt-copy

== Testimonial ==
I also read that you wanted to know how long the build process takes
for new comers. In that regard, I had a very hard and long time at
first understanding the process of building trunk besides my stable
KDE. I tried building it several times, but every time it gave some
compilation errors in different pieces of codes. This was may be
because of wrong bashrc that I used for settings the env variables for
KDE_SRC and KDE_BUILD.

But after I got that clear (a friend helped me through), the cmakekde
on kdesupport+kdelibs+phonon+kdebase took about an hour and a half,
excluding the source-code download time (it took really long due to my
slow internet connection).

Glad I could help! Considering the ENTIRE time, it took me about a
month (I know its too long but I gave up every time it gave errors,
and did not try again till a week or so) to setup KDE from trunk. And
of course, I don't mind my response being put on the wiki if it helps.
Actually, I just posted a small and simple walkthrough on my blog for
building KDE from trunk beside the stable distro-provided KDE. Take a
look, if it helps either,
http://31shebang.wordpress.com/2010/09/23/kde-from-the-trunk/

-- Viranch

==Installing KDE SC and its Prerequesites==
There are several ways to install KDE SC so that you can use and develop KDE software. Below are complete instructions for installing KDE4 on a Linux system based on whether you want an Official Release, a Nightly Build, Stable 4.x Release, or Trunk.

<table border="1" width="100%" cellpadding="5">
<tr>
<td width="25%" style="background: #FFEFD3">'''Official Release'''
<td width="25%" style="background: #FFFEE4">'''Nightly Build'''
<td width="25%" style="background: #D0ECEA">'''Stable from Source'''
<td width="25%" style="background: #9FD6D2">'''Trunk'''
<tr>
<td>''For the casual user, or a developer who is working on applications outside of KDE SC''
<td>''For application developers or package managers who are not modifying the core of KDE SC''
<td>''For KDE SC and applications developers that want to spend less time setting up a build system''
<td>''For developers working on core KDE SC functionality''
<tr>
<td rowspan=4>1. Use a [[Distributions with KDE|Distribution with KDE]] to set up a fully functional KDE system in one step. Also install the "developer packages" if you want to compile KDE software
<td>1. Install [[build requirements]] from your distribution
<td>1. Install [[build requirements]] from your distribution
<td>1. Install [[build requirements]] from your distribution
<tr>
<td rowspan=3>2. Download and setup KDE SC easily using [[Getting_Started/Using Project Neon to contribute to KDE|Project Neon]]
<td>2. Download KDE source from [[Getting_Started/Sources/Anonymous_SVN|SVN]]
<td>2. Download KDE source from [[Getting_Started/Sources/Anonymous_SVN|SVN]]
<tr>
<td>3. [[Getting_Started/Build/KDE4.x|Build a stable 4.x release]]
<td>3. [[Getting_Started/Build/KDE4|Build KDE SC from trunk]]
<tr>
<td>4. [[Getting_Started/Set_up_KDE_4_for_development|Set up scripts]] to ease KDE development
<td>4. [[Getting_Started/Set_up_KDE_4_for_development|Set up scripts]] to ease KDE development
</table>
For instructions on installing KDE SC on Windows, BSD, or Mac OS X, or instructions for installing KDE3, please see the [[Getting_Started/Build|other supported platforms]] page. There are also [[Getting_Started/Build/KDE4.x_Upgrade|upgrade instructions from a branch to trunk]].

Below is additional information you may be interested in before installing KDE.

==Build Notes for Special Users==

* '''Distribution managers''' may be interested in [[Getting_Started/Build/KDE4/on_virtual_machines|installing KDE SC using a virtual machine]].
* '''Core developers''' may want to use a [[Developer_Setups|common KDE developer setup]] (this page in not complete).

==QT==

''In each installation scenario above, QT in installed in the most appropriate way.'' For you reference, there are three ways to install:

; System Qt
: Often the easiest way to go, because most people have it already, you may have to install the QCA plugin as root though.

; KDE-Qt
:Previously known as qt-copy -- This is the minimum version of Qt any of your users are expected to have. Some bugs may be fixed in new Qt, so you may have to work-around bugs in lower versions, including this one.

; Main Qt
: Get it straight from Nokia, experience the latest cool features, but note that many people will be using older distributions with older Qt.

==Source Repository==

Currently, KDE SC source code is [[Getting_Started/Sources/Anonymous_SVN|accessed using svn]], but in the future, we are migrating to Git. [[Getting_Started/Sources/Amarok_Git_Tutorial|Amarok has already migrated to Git]].

== Troubleshooting the build ==
See [[Getting_Started/Build/KDE4/Troubleshooting|Troubleshooting]]

Compile and Linking errors are frequent sources of discouragement. Make careful note of the first occurrence of an error in your build process. It could be as simple as a bad environment variable, an unexpected version of a library or missing prerequisite.

Please review your logs and do searches for fixes. If you cannot find a solution, try [[Build/KDE4/Errors]], the IRC channel, and the mailing lists. You can post your detailed issue from [[Build/Stories]].

If you are building from trunk and following the instructions linked from here or from [[Build_KDE4.6_on_Kubuntu|Build KDE 4.5 on Kubuntu]] and would like free support, please contact:
: Aaron Peterson
: 206-334-5925 (lives in GMT -8 hours)
: Or leave a message at http://techbase.kde.org/User:AaronPeterson

==Extra Tools==
You will likely want to use a stable package from your distribution instead of the ones of the KDE version you are working on.

For most development topics, and documentation, see [[Development]]

; Opening and creating KDE project files
* [[eclipse]]
* [[kdevelop]]
* [[Development/Tutorials/Using_Qt_Designer|qtdesigner]]

==Contribution==
You may not need the latest bleeding-edge version of KDE with which to develop. Much of the code will be similar between versions and your patch might work. However, Trunk is where major changes are introduced, and branches are mostly for maintenance/bug fixes.

[[Image:Action_tool.svg|right|32px]]
* [[Contribute|Contribute]]
* [[Contribute/Send_Patches|Send Patches]]
* [[Contribute/Bugsquad|Bugsquad]]
* [[Getting_Started/Using Project Neon to contribute to KDE|Using Project Neon to contribute to KDE]]
* [[Getting_Started/EasyStartDevelopmentOnDebian | Build, change and run packaged KDE applications on Debian]]

[[Category:Build_KDE]]

User:Fulldecent

2010-12-16T01:41:09Z

Fulldecent: /* Choosing the Right KDE Setup */

User:AaronPeterson

2010-12-16T01:26:28Z

Fulldecent: /* Concerns with your contributions at Getting Started */

Aaron Peterson lives in Washington State USA. and has contriubted to various wikis including openwiki.org one of the gentoo wikis and wikipedias metawiki. as of 2010.07 Aaron is a novice programmer, who has done a bit of WMI, Javascript, C, and has followed a few C++ and QT tutorials, so he is very much learning and new to the process.

==Request for HELP==
None currently, Aaron helped wean me from my psychological dependence on kdesrc-build

== Wiki ==
===style===
Aaron generally organizes then polishes, Some users may be offended by misspellings or hanging links to pages that do not exist, and making placeholders for content that he thinks should go there.

He likes using categories whenever possible.
==== Style II ====
I find that wiki's especially, mediawiki, get misused when in techbase role. It is important to use Categories, and NOT subdirectories so that wiki linking becomes easy. Filing something under [[Getting Started]] is a horrible way to do it, because the item will also be related to the <nowiki>[[Topic]]</nowiki> In general, sub pages should be used only if the topic page is too large, and the additional content is exclusive to the topic. I hope to re-arrange the wiki to make it easier to navigate.

===ethics===
Aaron will move content about and adjust sentence structure to get right to the point. He rarely deletes content, rather, prefers to move it to new pages.

=== frequency Noise===
I talk a lot, I am learning about projects that i interact with, and hope that I am actually contributing. I want to give a high signal to noise, and I have a lot of time right now (July 2010) and am running with high enthusiasm.

== Person ==
=== Contact Info ===
Aaron generally cares a great deal about the projects he works on and would very much enjoy talking with what they are working on, and requests help learning this stuff.

Telephone: 206 334 5925

=== Creativity ===
Part of my creativity comes from experimentation. I try a lot of things, and I believe i have a talent for testing software, and creating user interfaces.

== Bugs ==
I file a lot of bugs and wishlist items. Often the fix is not trivial, and does not fit exactly in the category I put the item... because I have no idea where it should go. For example, I don't think we should program based on click, double click, drag, I think we need more abstract concepts .

I have filed bugs for bugzilla at mozilla regarding micropayment integration, and I tend to prefer Mantis as a bug/feature tracker. I also very much think that searching for existing bugs should go thru closed bugs and not just open bugs.

== KDE ==

Aaron has enjoyed using applications made in KDE and QT for quite some time, and has posted bugs. He would like to be considered a usability contributer and is attempting to set up a build environment to actually fix some of the behavior he cares deeply about.

=== Learning ===
[[/tutorials that are good]]
[[/tutorials that do not work]]

=== Specific bugs and enhancements ===
* selecting items in dolphin and konqueror / dialogs are over-engineered and while simplify some very basic selection capability, complicates general use of the program.
* Single vs double click -- Aaron cares very deeply about accidental clicks activating programs, and would like to seporate desired appliacation behavior vs application use by creating a concept to make user interfaces easier.
** Reversable-Safe-to-activate -- no-data-loss -- a button, single click, even moving a cursor over can trigger an event and this triggers no possiblity of data loss.
** known-common-use - reversable - arranging content, a single button can trigger.
** known-non-reversable
an example would be a slide-lock on an iphone, a double click, or similar
** known-dangerous
a confirmation dialog/interuption of user is required.
** unknown
a confirmation dialog may be requried.
==== plasma ====
* [[\gridplasmoid]] for icons Seen in KDE3

*show contents of directory--within a panel, not an icon to start a new window..
*application plasmoids, task-bar like objects that organize application windows and documents, that stay persistant.. AND also provide taskbar like control ((all other implementations seen either are just like taskbars or completely hide content)
* Note taking / journal plasmoid, that actually prepends to a simple text file. Saves like an instant messanger log, perhaps just instant message self in a note., (from anywhere) and have it save on the server.
* [[/In panel run command]] There is a run plasmoid, it just manifests as an icon, and I don't want to click on an icon, then click again and type what I want to run.

-- The active user interface field is IN the plasmoid, so one less click. (first seen with IE4beta but then removed.. also seen in KDE3)
* Make applets have a choice weather to behave like a popupapplet or an applet
(wishlist/bug filed: https://bugs.kde.org/show_bug.cgi?id=245124 ) Spent many many hours reading api / source code etc trying to figure this out ;) still

<notmart> MrDarkUser: you reimplement void Applet::createConfigurationInterface(KConfigDialog *parent)

==== KDE settings ====
[[/kdesettingsFixes]]
* wants to make kde settings behave as expected with single click, because they are all buttons/hyperlinks Not fileRepresentation.

==== Dolphin ====
* adding more columns [[/MoreMetaDataInDolphin]]
* Adding a view that allows grouping based on metadata
* Making Details be accessible in Icon view
* Make an Icon view that can be rearranged, not snapped to a grid.
* Make Thumbnails be in their own column/ make filetype icon still show up even in iconview
* Make DetailedIcon view, where metadata gets shown in same tile as icon.

== Knotify ==
. Need to have a filter on incoming messages, and present a log view. Would like to implement a time and check condition capability, conditions to check would be file is filesize, window has gotten focus, other things to help knotify if it should pop up that annyoing dialog. Also the application can send information like how many it expects to send.

Would like all kinds of things to get logged. Deletion of files, trash cleared..... tons of stuff would be great to keep track of. sorting it would be a pain tho.

==social networking ==
kreactor
overheard a conversation and started thinking about using it to make a social networking portal
alternative -- standards based websites that people put up themselves (already a project)
(facebook afterall, is just a glorified, centralized log analyzer that can trigger alarms) We could eventually string all of our instant messages thru our log analyzer, have it show us what we want, and retransmit based on rules if certain conditions are met.

* (social networking use is probably best in a sub page [[/NotificationLogAnalyzerAsSocialNetworking]]

* http://lists.kde.org/?l=kde-core-devel&m=127935490806410&w=2
* http://bugs.kde.org/show_bug.cgi?id=215229
* Telepathy

== Development ==
http://forums.gentoo.org/viewtopic-p-6368828.html#6368828

I still don't kknow how
{{help|building}}
[[/kdesrc-build-stories]]

== Build it ==
[[/build]]

== This Wiki ==
[[Welcome_to_KDE_TechBase/20100805/]]

== Concerns with your contributions at Getting Started ==
While it is great that you are editing this wiki, I really do not feel the edits you have made to this article aid new contributors.

Looking at the after/before edits (respectively):
http://techbase.kde.org/Getting_Started
http://techbase.kde.org/index.php?title=Getting_Started&oldid=43418

The latter definitely seems more cleanly organized and easier for a beginning contributor to disect. Keep in mind that the people we are attempting to target, will almost *definitely* be unsure of their abilities, unsure of whether working on KDE is easy, or even possible. It is best to not throw a ton of information their way all at once. It needs to be easy for them to digest...Not only that, there are a ton of dead links everywhere..so the visitor really gets the impression that we are..lacking, I suppose.

Personally, I like the old-style one that I listed, more. While it wasn't perfect, it was simple and somewhat concise. And the banner-like objects helped break it down, and looked attractive while doing so. Then from there, the user was led to a series of more technical articles(although I think it was pretty much one big one after that..the separation is still very important. although, even in the older versions, there is of course still room for improvement).

I am planning on reverting your changes, either by a full revert, or by a manual bit-by-bit one...depending on how much information was gained/lost between the versions. This is if I don't hear a response from you in some random amount of time...

I really do not want new-comers to see the page like this, which is why I am being semi-expedient with this. contact me at shaun.reich@kdemail.net so we can discuss this. Or just reply to this. (I couldn't find your e-mail, so I just posted this thing here).

[[User:Fulldecent|Fulldecent]] 01:26, 16 December 2010 (UTC) I agree that this is less appealing. I currently maintain kde.org/getinvolved and hear about people that are having trouble getting KDE set up. I will attempt to edit this page in the following way: I will add a graphic up front that describes the different choices a user has. Then, I will attempt to move some of the detailed links on this page (eg setting up with git) down into another related page (eg setting up with svn) so that this is focused on getting a user to quickly make a decision on the path they want and get started. Will Entriken 484-843-1313, kde.org@phor.net

User:Fulldecent

2010-12-15T01:29:41Z

Fulldecent: /* Choosing the Right KDE Setup */

User:Fulldecent

2010-12-15T01:08:08Z

Fulldecent:

Getting Started/Build/Distributions/Debian

2010-12-14T02:48:18Z

Fulldecent: /* kdelibs dependencies */

{{Template:I18n/Language Navigation Bar|Getting_Started/Build/KDE4/Kubuntu and Debian}}
This page details installation of KDE SC 4 build requirements on any recent Kubuntu or Debian system. That is, if you want to build KDE SC 4 Platform, the required (and some strongly recommended) packages are installed with the commands on this page.

'''If Kubuntu doesn't have QT4.6 yet, you can get it adding this repository ppa:mapopa/qt4.6 istead compile kde-qt'''

== KDE 4.x ==
Install these for any KDE 4.x release, then add specific packages for point releases as below. Then add any optional packages you like, as described below.
<code bash>
sudo aptitude install build-essential kde-devel xorg-dev cdbs debhelper cmake \
kdesdk-scripts subversion ssh xserver-xephyr doxygen dbus-x11 \
libxml2-dev libxslt1-dev shared-mime-info libical-dev libgif-dev libssl-dev \
libboost-dev libboost-program-options-dev libboost-graph-dev libgpgme11-dev libxine-dev \
libqimageblitz-dev libbz2-dev libdbus-1-dev libpam0g-dev libpcre3-dev \
libkrb5-dev libsm-dev libclucene0ldbl libclucene-dev libjpeg62-dev \
libxtst-dev xsltproc libxrender-dev libfontconfig1-dev automoc librdf0-dev \
libdbusmenu-qt-dev docbook-xsl docbook-xml libattica-dev libqt4-webkit-dev \
shared-desktop-ontologies libphonon-dev

sudo aptitude install libqt4-dev dbus-x11 \
libstreamanalyzer-dev libstrigiqtdbusclient-dev \
libxml2-dev libxslt1-dev shared-mime-info libgif-dev libpcre3-dev \
libjpeg62-dev librdf0-dev libdbusmenu-qt-dev docbook-xsl docbook-xml \
libjasper-dev libopenexr-dev libacl1-dev

sudo aptitude install libgpgme11-dev libsasl2-dev

sudo aptitude install libxine-dev
sudo aptitude install libqimageblitz-dev
</code>

=== 4.6 ===
(Also known as trunk)
This (along with the command for 4.x above) installs all compilation requirements for kde4 (with the exception of qt4) and some strongly recommended packages such as libssl-dev for https support. Further recommended and optional packages are listed below.
<code bash>
sudo aptitude install graphviz libxml2-utils libopenexr-dev libjasper-dev libenchant-dev \
libavahi-common-dev libaspell-dev libasound2-dev libldap2-dev libsasl2-dev \
libsmbclient-dev libxkbfile-dev libxcb1-dev libxklavier-dev libxdamage-dev \
libxcomposite-dev libbluetooth-dev libusb-dev network-manager-dev libsmbclient-dev \
libsensors-dev libnm-util-dev libusb-dev libcfitsio3-dev libnova-dev libeigen2-dev \
libopenbabel-dev libfacile-ocaml-dev libboost-python-dev libsvn-dev libsvncpp-dev \
libqt4-dev libqca2-dev libstreamanalyzer-dev libstrigiqtdbusclient-dev \
libcommoncpp2-dev libidn11 libidn11-dev libpci-dev libxss-dev libxft-dev \
libpolkit-dbus-dev libpolkit-grant-dev libpolkit-dev git libpoppler-qt4-dev \
libspectre-dev
</code>

=== 4.5 ===
<code bash>
sudo aptitude install libv4l-dev # for kdenetworks
sudo aptitude install liblcms1-dev # for kdegraphics
</code>

=== 4.4 ===
(Nothing extra needed)

== kdelibs dependencies ==

=== Optional packages ===
* libasound2-dev - The Alsa sound system
* libaspell-dev - spell checking support (in kwrite etc)
* libavahi-common-dev - avahi/zeroconf service discovery
* libenchant-dev - spell checking wrapper library
* libjasper-dev - image processing library
* libopenexr-dev - image processing library
* libxml2-utils - used to validate generate doc files
<code bash>
sudo aptitude install libasound2-dev libaspell-dev \
libavahi-common-dev libenchant-dev libjasper-dev libopenexr-dev \
libxml2-utils
</code>

== kdepimlibs dependencies ==
There are no additional optional dependencies

== kdebase dependencies ==

=== kdebase-apps optional ===
* libxcb1-dev - X C binding - Used for video widget support in xine
* libxkbfile-dev - keyboard configuration package
* libsmbclient-dev - for samba support in kde4

<code bash>
sudo aptitude install libsmbclient-dev libxkbfile-dev libxcb1-dev
</code>

=== kdebase-workspace optional ===
* libsmbclient-dev - for samba support in kde4
* network-manager-dev - Can be used by solid for network management
* libusb-dev - for usb support in solid
* libbluetooth-dev - for bluetooth support in solid
* libxcomposite-dev - for compositing support in kwin
* libxdamage-dev - for compositing support in kwin
* libxklavier-dev - virtual keyboard
* libsensors-dev - Support for hardware sensors (eg, temperature, fans)
* libpam0g-dev - Authentication module
* libnm-util-dev - needed to build solid with network manager
<code bash>
sudo aptitude install libxklavier-dev libxdamage-dev libxcomposite-dev \
libbluetooth-dev libusb-dev libcaptury-dev network-manager-dev \
libsmbclient-dev libsensors-dev libpam0g-dev libnm-util-dev
</code>

== kdegraphics ==
* libpoppler-qt4-dev - PDF support in Okular
* libspectre-dev - postscript support in Okular
* liblcms1-dev
* libexiv2-dev - to build Gwenview

== kdeedu ==
The following packages are recommended if you intend to use kstars:

* libfacile-ocaml-dev - used by kalzuim.
* libboost-python-dev - optional for kig.
* libreadline-dev - Gives kalgebra a console interface.
* libopenbabel-dev - used by kalzium.
* libeigen2-dev - used by kalzium.
* libusb-dev - Provides KStars INDI support.
* libcfitsio3-dev - Gives KStars support for FITS images.
* libnova-dev - A general purpose, double precision, Celestial Mechanics, Astrometry and Astrodynamics library for KStars.

<code bash>
sudo aptitude install libusb-dev libcfitsio3-dev libnova-dev libeigen2-dev \
libopenbabel-dev libfacile-ocaml-dev libboost-python-dev
</code>

== koffice ==
* libqca2-dev - qt cryptographic support.

== kdepim ==
* libqca2-dev - qt cryptographic support.

== kdenetwork ==
* libqca2-dev - qt cryptographic support. Used for jabber protocol.

== kdevplatform ==
* libsvn-dev
* libboost-serialization-dev

== kdevelop ==
* kdevplatform-dev
* kdebase-workspace-dev

== Other ==
To enable XMMS support for the 'Now Playing' plasma data engine in kdebase, you will need to either compile XMMS from source, or install the package from a [http://www.pvv.ntnu.no/~knuta/xmms/ third-party XMMS package repository].

Return to [[Getting_Started/Build/KDE4#kdelibs|building KDE 4]].

Getting Started/Build/Distributions/Debian

2010-12-14T02:45:17Z

Fulldecent: remove duplicate entries

{{Template:I18n/Language Navigation Bar|Getting_Started/Build/KDE4/Kubuntu and Debian}}
This page details installation of KDE SC 4 build requirements on any recent Kubuntu or Debian system. That is, if you want to build KDE SC 4 Platform, the required (and some strongly recommended) packages are installed with the commands on this page.

'''If Kubuntu doesn't have QT4.6 yet, you can get it adding this repository ppa:mapopa/qt4.6 istead compile kde-qt'''

== KDE 4.x ==
Install these for any KDE 4.x release, then add specific packages for point releases as below. Then add any optional packages you like, as described below.
<code bash>
sudo aptitude install build-essential kde-devel xorg-dev cdbs debhelper cmake \
kdesdk-scripts subversion ssh xserver-xephyr doxygen dbus-x11 \
libxml2-dev libxslt1-dev shared-mime-info libical-dev libgif-dev libssl-dev \
libboost-dev libboost-program-options-dev libboost-graph-dev libgpgme11-dev libxine-dev \
libqimageblitz-dev libbz2-dev libdbus-1-dev libpam0g-dev libpcre3-dev \
libkrb5-dev libsm-dev libclucene0ldbl libclucene-dev libjpeg62-dev \
libxtst-dev xsltproc libxrender-dev libfontconfig1-dev automoc librdf0-dev \
libdbusmenu-qt-dev docbook-xsl docbook-xml libattica-dev libqt4-webkit-dev \
shared-desktop-ontologies libphonon-dev

sudo aptitude install libqt4-dev dbus-x11 \
libstreamanalyzer-dev libstrigiqtdbusclient-dev \
libxml2-dev libxslt1-dev shared-mime-info libgif-dev libpcre3-dev \
libjpeg62-dev librdf0-dev libdbusmenu-qt-dev docbook-xsl docbook-xml \
libjasper-dev libopenexr-dev libacl1-dev

sudo aptitude install libgpgme11-dev libsasl2-dev

sudo aptitude install libxine-dev
sudo aptitude install libqimageblitz-dev
</code>

=== 4.6 ===
(Also known as trunk)
This (along with the command for 4.x above) installs all compilation requirements for kde4 (with the exception of qt4) and some strongly recommended packages such as libssl-dev for https support. Further recommended and optional packages are listed below.
<code bash>
sudo aptitude install graphviz libxml2-utils libopenexr-dev libjasper-dev libenchant-dev \
libavahi-common-dev libaspell-dev libasound2-dev libldap2-dev libsasl2-dev \
libsmbclient-dev libxkbfile-dev libxcb1-dev libxklavier-dev libxdamage-dev \
libxcomposite-dev libbluetooth-dev libusb-dev network-manager-dev libsmbclient-dev \
libsensors-dev libnm-util-dev libusb-dev libcfitsio3-dev libnova-dev libeigen2-dev \
libopenbabel-dev libfacile-ocaml-dev libboost-python-dev libsvn-dev libsvncpp-dev \
libqt4-dev libqca2-dev libstreamanalyzer-dev libstrigiqtdbusclient-dev \
libcommoncpp2-dev libidn11 libidn11-dev libpci-dev libxss-dev libxft-dev \
libpolkit-dbus-dev libpolkit-grant-dev libpolkit-dev git libpoppler-qt4-dev \
libspectre-dev
</code>

=== 4.5 ===
<code bash>
sudo aptitude install libv4l-dev # for kdenetworks
sudo aptitude install liblcms1-dev # for kdegraphics
</code>

=== 4.4 ===
(Nothing extra needed)

== kdelibs dependencies ==

You may also need the automoc and libphonon-dev packages when compiling on *buntu:
<code bash>sudo aptitude install automoc libphonon-dev</code>

=== Optional packages ===
* libasound2-dev - The Alsa sound system
* libaspell-dev - spell checking support (in kwrite etc)
* libavahi-common-dev - avahi/zeroconf service discovery
* libenchant-dev - spell checking wrapper library
* libjasper-dev - image processing library
* libopenexr-dev - image processing library
* libxml2-utils - used to validate generate doc files
<code bash>
sudo aptitude install libasound2-dev libaspell-dev \
libavahi-common-dev libenchant-dev libjasper-dev libopenexr-dev \
libxml2-utils
</code>

== kdepimlibs dependencies ==
There are no additional optional dependencies

== kdebase dependencies ==

=== kdebase-apps optional ===
* libxcb1-dev - X C binding - Used for video widget support in xine
* libxkbfile-dev - keyboard configuration package
* libsmbclient-dev - for samba support in kde4

<code bash>
sudo aptitude install libsmbclient-dev libxkbfile-dev libxcb1-dev
</code>

=== kdebase-workspace optional ===
* libsmbclient-dev - for samba support in kde4
* network-manager-dev - Can be used by solid for network management
* libusb-dev - for usb support in solid
* libbluetooth-dev - for bluetooth support in solid
* libxcomposite-dev - for compositing support in kwin
* libxdamage-dev - for compositing support in kwin
* libxklavier-dev - virtual keyboard
* libsensors-dev - Support for hardware sensors (eg, temperature, fans)
* libpam0g-dev - Authentication module
* libnm-util-dev - needed to build solid with network manager
<code bash>
sudo aptitude install libxklavier-dev libxdamage-dev libxcomposite-dev \
libbluetooth-dev libusb-dev libcaptury-dev network-manager-dev \
libsmbclient-dev libsensors-dev libpam0g-dev libnm-util-dev
</code>

== kdegraphics ==
* libpoppler-qt4-dev - PDF support in Okular
* libspectre-dev - postscript support in Okular
* liblcms1-dev
* libexiv2-dev - to build Gwenview

== kdeedu ==
The following packages are recommended if you intend to use kstars:

* libfacile-ocaml-dev - used by kalzuim.
* libboost-python-dev - optional for kig.
* libreadline-dev - Gives kalgebra a console interface.
* libopenbabel-dev - used by kalzium.
* libeigen2-dev - used by kalzium.
* libusb-dev - Provides KStars INDI support.
* libcfitsio3-dev - Gives KStars support for FITS images.
* libnova-dev - A general purpose, double precision, Celestial Mechanics, Astrometry and Astrodynamics library for KStars.

<code bash>
sudo aptitude install libusb-dev libcfitsio3-dev libnova-dev libeigen2-dev \
libopenbabel-dev libfacile-ocaml-dev libboost-python-dev
</code>

== koffice ==
* libqca2-dev - qt cryptographic support.

== kdepim ==
* libqca2-dev - qt cryptographic support.

== kdenetwork ==
* libqca2-dev - qt cryptographic support. Used for jabber protocol.

== kdevplatform ==
* libsvn-dev
* libboost-serialization-dev

== kdevelop ==
* kdevplatform-dev
* kdebase-workspace-dev

== Other ==
To enable XMMS support for the 'Now Playing' plasma data engine in kdebase, you will need to either compile XMMS from source, or install the package from a [http://www.pvv.ntnu.no/~knuta/xmms/ third-party XMMS package repository].

Return to [[Getting_Started/Build/KDE4#kdelibs|building KDE 4]].

Getting Started/Build/Combile KDE 3.5

2010-12-14T02:08:17Z

Fulldecent: moved Getting Started/Build/Combile KDE 3.5 to Getting Started/Build/Compile KDE 3.5

#REDIRECT [[Getting Started/Build/Compile KDE 3.5]]

Getting Started/Build/Historic/KDE 3.5

2010-12-14T02:08:17Z

Fulldecent: moved Getting Started/Build/Combile KDE 3.5 to Getting Started/Build/Compile KDE 3.5

{{Template:I18n/Language Navigation Bar|Getting Started/Build/Stable Version}}{{TutorialBrowser|

series=Getting Started|

name=Building KDE3 From Source|

reading=[http://kdesvn-build.kde.org/ The KDE From Subversion Build Tool]
}}

===Status===
This page is accurate as of 2008-07-19 for building KDE stable 3.5.9 (please report problems to [mailto:kde-devel@kde.org kde-devel] if they do not work for the latest stable 3.5.x). Other pages containing similar information are being consolidated to here. Similar pages include:
* http://quality.kde.org/develop/cvsguide/buildstep.php

===KDE Stable===
The old stable version of KDE stable is 3.5.10 (current stable version is a 3.4 branch as of 2009/11/20). You will want to build KDE stable if you are a maintainer for an OS distribution. Otherwise, you may want to install KDE stable using the tools provided by your OS distribution or vendor.

The recommended way to install KDE stable used to be [[Getting Started/Build/Konstruct|Konstruct]], a build system which helped you to install KDE releases and applications on your system. It downloads defined source tarballs, checks their integrity, decompresses, patches, configures, builds and installs them. A complete KDE installation should be as easy as "cd meta/kde;make install".

By default [[Getting Started/Build/Konstruct|Konstruct]] installs to your home directory, which means you don't have to possess root privileges or risk to damage your system or affect another KDE.

'''Currently it does not work and is not maintained any more.'''

===Compiling Yourself===

The following instructions describe how to build KDE 3.5.x yourself, i.e. without using [[Getting Started/Build/Konstruct|Konstruct]] or [http://kdesvn-build.kde.org/ kdesvn-build].

==Requirements==
To compile KDE you need:

* Qt 3.3.2 or newer
* a C++ compiler which supports exceptions, preferably a recent gcc 3.x release. gcc 2.95.x is still working.
* <tt>bunzip2</tt> to decompress .bz2 files. You can find it here. Get libbz2 while you're at it, it enables reading of .tar.bz2 files in konqueror, and one day, will give access to .bz2 files to all KDE applications.
* If you want SSL support (for instance for secure web sites in konqueror), make sure you install <tt>openssl</tt>, version 0.9.6 or later (versions 0.9.5x are not supported).
* For a better regular-expressions support in Javascript, install <tt>libpcre</tt>.
* For the KDE help system, you'll need to install <tt>libxml2</tt>, version 2.3.13 or newer.
* pkg-config, to help find installed software.
* There are additional modules that are compiled if the required library is present, but they aren't critical to run KDE. For instance, libldap for the LDAP kioslave, and cdparanoia for the audiocd kioslave. A more detailed list of requirements is available in the KDE 3.5 Requirements List

==Download==
In order to run KDE applications, you need the Qt, arts, and kdelibs packages. For a simple desktop (with a window manager, panel, etc), you will also need kdebase. The other packages contain many other applications by topic: networking, graphics, multimedia, games, utilities, toys, software development, etc.

You can find the Qt library (qt-x11-free-3.3.8) from ftp://ftp.trolltech.com/qt/source/

KDE 3.5.x is available from ftp://download.kde.org/pub/kde/stable/

==Installation==
Unlike most compiled software, Qt is compiled in the place where it will stay instead of using a <tt>make install</tt>. Please read the INSTALL instructions in the Qt package. You need to set the environment variables <tt>$QTDIR</tt> and <tt>$KDEDIR</tt> to the locations where Qt and KDE will be installed, respectively. Also, append $QTDIR/bin and $KDEDIR/bin to your <tt>$PATH</tt> and $QTDIR/lib and $KDEDIR/lib to <tt>$LD_LIBRARY_PATH</tt>. Alternatively, instead of using <tt>$LD_LIBRARY_PATH</tt>, you may add your Qt and KDE library paths to {{path|/etc/ld.so.conf}}, but don't forget to run <tt>ldconfig</tt> as root after installing Qt and kdelibs, otherwise configure scripts will fail to find the newly installed libraries!

If your distribution sets <tt>$XDG_DATA_DIRS</tt> and/or <tt>$XDG_CONFIG_DIRS</tt> you will want to update them to include the correct $KDEDIR/share/ resp. $KDEDIR/etc/xdg/

bunzip2 qt-x11-3.3.8.tar.bz2
tar xvf qt-x11-3.3.8.tar
cd qt-x11-3.3.8
less INSTALL
# Set up QTDIR, KDEDIR, PATH, LD_LIBRARY_PATH,
# XDG_DATA_DIRS and XDG_CONFIG_DIRS
cd $QTDIR
./configure -system-zlib -qt-gif -system-libpng \
-system-libjpeg -plugin-imgfmt-mng -thread -no-stl \
-no-xinerama -no-g++-exceptions
make

Note that <tt>-thread</tt> is required (KDE will not run or even compile if you omit it), that <tt>-no-xinerama</tt> is only if you're not using xinerama, and <tt>-no-g++-exceptions</tt> is strongly recommended if you're using gcc.

Make sure to compile and install '''arts''' first, and afterwards '''kdelibs''' and then '''kdebase''' before any other packages. Also, if you want to use kdeaddons, it should be compiled last as it requires kdebase, kdemultimedia, etc.

For each KDE package:
bunzip2 <package>.tar.bz2
tar xvf <package>.tar
cd <package>
./configure
make
make install

=== TroubleShooting ===

* If you get an error like
uic: File generated with too old version of Qt Designer
try
which uic
and
uic -v
to find out with which version of the UI compiler you are working. For KDE 3.5 and koffice 1.6 you will need a 3.x version.

==Notes==

* If compiling on a system where GNU make is not the default make (that is, most systems other than Linux), please run <tt>gmake && gmake install</tt> instead of <tt>make && make install</tt>.
* All packages mentioned here have to be compiled with the same compiler!
* See the [http://www.kde.org/info/3.5.9.php KDE 3.5.9 Info Page] for some common encountered problems when running KDE 3.5.9.

[[Category:Build KDE]]
[[Category:KDE3]]

Getting Started/Build/Historic

2010-12-14T02:06:21Z

Fulldecent:

{{Template:I18n/Language Navigation Bar|Getting Started/Build/Older KDE Versions}}

; [[../Compile KDE 3.5|Compiling KDE 3.5.x]]
: Instructions for installing KDE 3.5.x from source code.

; [[../Compile KDE 3.4|Compiling KDE 3.4.x]]
: Instructions for installing KDE 3.4.x from source code.

; [[../Compile KDE 3.3|Compiling KDE 3.3.x]]
: Instructions for installing KDE 3.3.x from source code.

; [[../Compile KDE 3.2|Compiling KDE 3.2.x]]
: Instructions for installing KDE 3.2.x from source code.

; [[../Compile KDE 3.1|Compiling KDE 3.1.x]]
: Instructions for installing KDE 3.1.x from source code.

; [[../Compile KDE 3.0|Compiling KDE 3.0.x]]
: Instructions for installing KDE 3.0.x from source code.

; [[../Compile KDE 2.2.2|Compiling KDE 2.2.2]]
: Instructions for installing KDE 2.2.2 from source code.

[[Category:Build KDE]]

Getting Started/Build/Historic

2010-12-14T02:06:06Z

Fulldecent:

{{Template:I18n/Language Navigation Bar|Getting Started/Build/Older KDE Versions}}

; [[../Compile KDE 3.4|Compiling KDE 3.5.x]]
: Instructions for installing KDE 3.5.x from source code.

; [[../Compile KDE 3.4|Compiling KDE 3.4.x]]
: Instructions for installing KDE 3.4.x from source code.

; [[../Compile KDE 3.3|Compiling KDE 3.3.x]]
: Instructions for installing KDE 3.3.x from source code.

; [[../Compile KDE 3.2|Compiling KDE 3.2.x]]
: Instructions for installing KDE 3.2.x from source code.

; [[../Compile KDE 3.1|Compiling KDE 3.1.x]]
: Instructions for installing KDE 3.1.x from source code.

; [[../Compile KDE 3.0|Compiling KDE 3.0.x]]
: Instructions for installing KDE 3.0.x from source code.

; [[../Compile KDE 2.2.2|Compiling KDE 2.2.2]]
: Instructions for installing KDE 2.2.2 from source code.

[[Category:Build KDE]]

Getting Started/Build/Historic

2010-12-14T02:05:17Z

Fulldecent:

{{Template:I18n/Language Navigation Bar|Getting Started/Build/Older KDE Versions}}
; [[Getting Started/Build/Stable Version|Compiling KDE 3.5]]
: Instructions for installing KDE 3.5.x from source code.

; [[../Compile KDE 3.4|Compiling KDE 3.4.x]]
: Instructions for installing KDE 3.4.x from source code.

; [[../Compile KDE 3.3|Compiling KDE 3.3.x]]
: Instructions for installing KDE 3.3.x from source code.

; [[../Compile KDE 3.2|Compiling KDE 3.2.x]]
: Instructions for installing KDE 3.2.x from source code.

; [[../Compile KDE 3.1|Compiling KDE 3.1.x]]
: Instructions for installing KDE 3.1.x from source code.

; [[../Compile KDE 3.0|Compiling KDE 3.0.x]]
: Instructions for installing KDE 3.0.x from source code.

; [[../Compile KDE 2.2.2|Compiling KDE 2.2.2]]
: Instructions for installing KDE 2.2.2 from source code.

[[Category:Build KDE]]

Getting Started/Build/Historic/KDE 3.5

2010-12-14T02:04:46Z

Fulldecent: moved Getting Started/Build/Stable Version to Getting Started/Build/Combile KDE 3.5: 3.5 is no longer the latest stable

Getting Started/Build/Stable Version

2010-12-14T02:04:46Z

Fulldecent: moved Getting Started/Build/Stable Version to Getting Started/Build/Combile KDE 3.5: 3.5 is no longer the latest stable

#REDIRECT [[Getting Started/Build/Combile KDE 3.5]]

User:Fulldecent

2010-10-05T01:37:08Z

Fulldecent: add testimonial

User:Fulldecent

2010-08-30T20:53:23Z

Fulldecent: /* Going with kdesrc-build */

User:Fulldecent

2010-08-30T20:33:00Z

Fulldecent: /* Latest problem with kdesrc-build method */

User:Fulldecent

2010-08-30T19:50:14Z

Fulldecent: /* Latest problem with kdesrc-build method */

User:Fulldecent

2010-08-30T19:48:45Z

Fulldecent:

User:Fulldecent

2010-08-30T18:56:52Z

Fulldecent: /* Going with kdesrc-build */

User:Fulldecent

2010-08-30T18:54:28Z

Fulldecent:

Getting Started/Build/kdesrc-build

2010-08-30T18:35:17Z

Fulldecent:

{{Template:I18n/Language Navigation Bar|Getting_Started/Build/kdesrc-build}}

{{note|It is possible to build KDE 3 using older versions of kdesrc-build, but this is not described here.}}

== Building KDE using the kdesrc-build tool ==

=== Introduction to kdesrc-build ===

[http://kdesrc-build.kde.org/ kdesrc-build] (formerly kdesvn-build) is a tool to allow users and developers to easily download and build the latest versions of the KDE Software Compilation (KDE SC) from the KDE source code repositories. It automates the following tasks and more:

* Performing the initial checkout.
* Handling updates for modules that are already checked out.
* Setting up the build system for the module.
* Performing the build and install.
* Specifying your CMake options or configure flags (so you don't have to remember them every time).
* Logging build errors so you can review them easier for troubleshooting.

It is not the end-all for your troubles building KDE, [[troubleshooting]] still applies. Many errors that occur using other methods occur here too, you read the log files that are stored for you.

=== Why use kdesrc-build? ===

So why use kdesrc-build? There are several reasons you may like to use it:

# Less manual editing of commands. Instead of having to remember to add the correct options to the cmake command line or configure command, you can setup the options once and then kdesrc-build will use your settings from then on, saving you from wasting time because you forgot to enable a setting.
# Command logging to help debug build failures. kdesrc-build logs all command outputs to a file. This has several advantages:
## When a module fails to build, you already have the error output saved to disk, ready to be viewed and compared with other error messages to aid debugging.
## Quieter output. Even with CMake, the output of Qt or a KDE SC module build can be extensive. kdesrc-build does not show the details of a module build (but will show the progress), instead an overview of the build process is displayed.
# It's just easier. Instead of having to learn how to use the Subversion and git tools, and how to setup a KDE build system, you can specify what modules you want build, where to install them to, and any other options you want and then have kdesrc-build actually do it, even while you're away from the computer or busy doing other things.
# It's easy to step in yourself. kdesrc-build uses a standard source and build directory layout, and calls the same commands you would. So kdesrc-build will not interfere with you performing the build or editing the source yourself if you so choose.

=== Setting up ===

==== Useful Links ====
When using kdesrc-build you may find it beneficial to have a way of searching the source repository so that you know what modules to look for.

* To browse the KDE Subversion repository, use [http://websvn.kde.org/trunk/KDE WebSVN].
* To browse any of the various KDE projects using git, you can go to [http://gitorious.org/ Gitorious].
* The Nokia Qt toolkit used by KDE can be browsed at [http://gitorious.org/+kde-developers/qt/kde-qt the Gitorious kde-qt homepage].

==== Prerequisites ====
kdesrc-build is fairly easy to install and setup, but you also need to have the right software installed to build KDE SC. The requirements to build KDE SC are available as follows:

* KDE SC 4: [[../KDE4#Required_packages_from_your_distribution|KDE 4 Requirements]]

kdesrc-build requires Perl 5.8 or higher. It is installed by default with most distributions, and is included in the link above. Check your version of Perl with:
<code>perl -v</code>

{{note|kdesrc-build is developed on a Linux system, but it should work on the various BSD distributions as well (although GNU tools may be required).}}

==== Download and install kdesrc-build ====
Once your system is setup to be able to compile the KDE SC, you can download kdesrc-build from its website, [http://kdesrc-build.kde.org/ kdesrc-build.kde.org]. The file you download will contain (at least) the kdesrc-build script and a sample configuration file. Installing kdesrc-build is as simple as saving the file and making it executable. If you'd like, you can move it to a directory in your PATH, however for this example we'll put it into the KDE source directory that we use (~/kdesrc)

<code bash>
mkdir -p ~/kdesrc
cd ~/kdesrc
tar xjvf ~/path/to/kdesrc-build-1.12.tar.bz2
cp kdesrc-build-1.12/kdesrc-build .
</code>

Alternatively, the newest kdesrc-build script (and sample config file) can be pulled directly from svn:
<code bash>
mkdir -p ~/kdesrc
cd ~/kdesrc
export SVN_ROOT=svn://anonsvn.kde.org/home/kde
svn cat $SVN_ROOT/trunk/KDE/kdesdk/scripts/kdesrc-build > kdesrc-build
svn cat $SVN_ROOT/trunk/KDE/kdesdk/scripts/kdesrc-buildrc-sample > ~/.kdesrc-buildrc
chmod +x kdesrc-build
</code>

==== Setup the configuration ====
Now you should [[Getting Started/Build/kdesrc-buildrc|setup your configuration]]. For the most part the defaults in the included kdesrc-buildrc-sample should be sufficient.

<code bash>
cp ~/kdesrc/kdesrc-build-1.12/kdesrc-buildrc-sample ~/.kdesrc-buildrc
# Now edit the ~/.kdesrc-buildrc
</code>

{{tip|Note that the config file's name begins with a leading ., making it a hidden file. You may need to show hidden files in Dolphin or Konqueror to find the configuration file to edit it. Or, you can edit the sample before copying it to ~/.kdesrc-buildrc.}}

Also, make sure that the modules you'll want to build are included. You'll want the following at the least:

* qt-copy, kdesupport, kdelibs, kdepimlibs, kdebase

Modules are built in the order they appear in your ~/.kdesrc-buildrc, so the first module should be qt-copy, kdelibs should be before any other KDE SC module, and so on.

{{note|The sample configuration file does include these modules by default, you won't need to make many changes unless you'd like to add some modules to the build by uncommenting them.}}

You may want to enable the make-install-prefix option if you are installing KDE SC or Qt to a directory that is not in your home directory. make-install-prefix allows you to run su or sudo during the make install process so you can install files as root, or set certain programs to execute with higher permissions (This is required for certain programs to execute properly).

<pre>module kdelibs
make-install-prefix sudo -S # sudo with no stdin
end module

module kdebase
make-install-prefix sudo -S
end module</pre>

If a module you'd like to build isn't already present, simply add

<pre>module <module-name>
end module</pre> at the end of the ~/.kdesrc-buildrc. <module-name> would be whatever the module is called in the software repository (for instance, kdemultimedia).

===== Git-based modules =====

Some KDE projects use the "git" source-control software instead of Subversion (as part of an eventual planned migration to git). This includes software like Amarok and Konversation.

To build these modules in kdesrc-build, you just need to add a couple of lines to the module configuration. For example, konversation is developed in the git://gitorious.org/konversation/konversation.git repository at [http://gitorious.org/]. So you would just add a module (you can pick whatever name for the module you like, as long as it's not already used):

<pre>module konversation
repository git://gitorious.org/konversation/konversation.git
branch master
end module</pre>

In this case I selected the "master" branch since that is the default git branch.

Now whenever you build konversation, kdesrc-build will use git instead of Subversion.

==== Useful kdesrc-build commands ====
kdesrc-build is driven from the command line, so here's a guide to some of the more useful command line options:

<table cellpadding="2">
<tr>
<th>Option</th><th>Effect</th>
</tr>
<tr>
<td><tt><span style="white-space:nowrap;">[http://kdesrc-build.kde.org/documentation/cmdline.html#cmdline-pretend --pretend]</span></tt> (Short form <tt><span style="white-space:nowrap;">-p</span></tt>)</td>
<td>This option is like a dry run. kdesrc-build will process the options and its configuration like normal, and run through the build as normal, but instead of downloading or running the build will instead output what kdesrc-build would have done. You should always run with -p before running kdesrc-build to make sure it is doing what you expect.</td>
</tr>
<tr>
<td><tt>[http://kdesrc-build.kde.org/documentation/cmdline.html#cmdline-no-svn --no-svn]</tt> (Alt. form <tt>--no-src</tt>)</td><td>This option skips the source code update step. This is useful if you're running kdesrc-build again soon after the last update and don't want to wait to find out there were no changes.</td>
</tr>
<tr>
<td><tt>[http://kdesrc-build.kde.org/documentation/cmdline.html#cmdline-refresh-build --refresh-build]</tt></td><td>This option causes kdesrc-build to delete the current build information for the given modules and start building them again from scratch. This option takes a lot of time but gives the best chance of a successful build.</td>
</tr>
</table>

Any other non-option arguments on the command line are assumed to be modules to build (and are built in the order provided on the command line). If no modules are specified, all of the modules listed in the ~/.kdesrc-buildrc are built in the order listed in the file.

== Build ==
We're almost there. If you're happy with your settings then it's time to test out kdesrc-build. In theory things are as simple as running kdesrc-build and then coming back later. ;)

<code bash>
cd ~/kdesrc
./kdesrc-build
</code>

You may want to test by building qt-copy first however.

<code bash>
cd ~/kdesrc
./kdesrc-build qt-copy
</code>

{{tip|If you have the [http://www.gnu.org/software/screen/ GNU screen] program available then you should definitely use it to run kdesrc-build, as you can detach your kdesrc-build session and logout while kdesrc-build is still running.}}

If the build failed (kdesrc-build will error out with a nice bright red error message) then there are several possibilities:

# You are missing a key piece of required software (such as a development library)
# The KDE SC code being compiled is broken in some fashion to where it won't build. This is commonly due to newly committed code that worked on the developer's machine, or occasionally on Mondays (when incompatible changes are permitted to kdelibs).
# kdesrc-build is not setup properly. You may be trying to install to a directory that you have no permissions to access for instance, or you may have specified a system qtdir that does not exist.
# The module may depend on a newer version of qt-copy or kdelibs (or other module). In this case you'll have to run kdesrc-build to update the out-of-date module first.

How do you find out what the error was? The output of the failing command will be in the log directory. By default, all log output is in the {{path|log}} subdirectory of the KDE SC source directory. The log directory is laid out like this: {{path|log/date-run/module/output-file.log}}. To simplify finding the appropriate file, there are a couple of symlinks created:

{{path|log/latest}} always has the debugging output for the last time kdesrc-build was run (--pretend doesn't count toward this)
{{path|log/latest/<module>/error.log}} has the debugging output for the command that caused a module build to fail.

For instance if qt-copy just failed to build you could read the output like this:

<code bash>
cd ~/kderc
kwrite log/latest/qt-copy/error.log
</code>

Replace kwrite with your preferred editor. Hopefully the output can guide you to resolving the problem. For instance, if the failure is a cmake output saying you're missing a library, install that library and try again. ;) For link errors you can try running a --refresh-build on the module (or if that doesn't work, required libraries like qt-copy and kdelibs).

If you're stumped by the error you may want to wait a day and try updating again, and hope that the reason for the error has been fixed. You can also try mailing the [http://www.kde.org/mailinglists/ kde-devel] mailing list to see if others know about the problem or have had similar issues.

== Running KDE ==

Assuming you got enough of the modules to build and install to have a working KDE installation, you'll still need to setup your environment correctly to run it. kdesrc-build doesn't help you out here (yet), but the instructions at [[../../Increased_Productivity_in_KDE4_with_Scripts/.bashrc|the .bashrc wiki page]] apply just as well, except that you'll need to set the environment variables to the settings that are in your ~/.kdesrc-buildrc.

For the KDEDIRS and KDEDIR variable use the setting of the "prefix" option (in the global section).
For the QTDIR variable use the setting of the "qtdir" option.

{{tip|When copying settings over to the .bashrc, change any ~'s in the paths to $HOME, as the ~ character is not expanded correctly in the .bashrc.}}

Once your .bashrc is setup logout and log back in again and then you should be able to run your new KDE installation.

== Keeping KDE up to date ==

Keeping your KDE installation up to date is as simple as running kdesrc-build again. Every kdesrc-build has these phases:

# Update the source code for all modules being built.
# Build and then install all the modules.

Old build directories are not deleted by default, so the build after a small update will not normally take as long as the initial build of a module. This is called "incremental make". However it may be necessary at times to perform a full rebuild due to inconsistencies between the build directory configuation and changes to the source directory. You can use the --refresh-build option to force a full rebuild.

For more information on how to take advantage of kdesrc-build, see the [http://kdesrc-build.kde.org/documentation online documentation] for kdesrc-build, which describes all of the module options and command line options available for kdesrc-build and gives tips on how to perform various useful tasks.

If you have any questions that are not answered please feel free to add them under the Discussion entry for this page and hopefully someone will be able to get the answer.

[[Category:Build_KDE]]
[[Category:Tutorial]]

User:Fulldecent

2010-08-30T18:33:01Z

Fulldecent:

Getting Started/Build/kdesrc-build

2010-08-30T18:14:12Z

Fulldecent: revert

{{Template:I18n/Language Navigation Bar|Getting_Started/Build/kdesrc-build}}

{{note|It is possible to build KDE 3 using older versions of kdesrc-build, but this is not described here.}}

== Building KDE using the kdesrc-build tool ==

=== Introduction to kdesvn-build ===

[http://kdesrc-build.kde.org/ kdesrc-build] (formerly kdesvn-build) is a tool to allow users and developers to easily download and build the latest versions of the KDE Software Compilation (KDE SC) from the KDE source code repositories. It automates the following tasks and more:

* Performing the initial checkout.
* Handling updates for modules that are already checked out.
* Setting up the build system for the module.
* Performing the build and install.
* Specifying your CMake options or configure flags (so you don't have to remember them every time).
* Logging build errors so you can review them easier for troubleshooting.

It is not the end-all for your troubles building KDE, [[troubleshooting]] still applies. Many errors that occur using other methods occur here too, you read the log files that are stored for you.

=== Why use kdesrc-build? ===

So why use kdesrc-build? There are several reasons you may like to use it:

# Less manual editing of commands. Instead of having to remember to add the correct options to the cmake command line or configure command, you can setup the options once and then kdesrc-build will use your settings from then on, saving you from wasting time because you forgot to enable a setting.
# Command logging to help debug build failures. kdesrc-build logs all command outputs to a file. This has several advantages:
## When a module fails to build, you already have the error output saved to disk, ready to be viewed and compared with other error messages to aid debugging.
## Quieter output. Even with CMake, the output of Qt or a KDE SC module build can be extensive. kdesrc-build does not show the details of a module build (but will show the progress), instead an overview of the build process is displayed.
# It's just easier. Instead of having to learn how to use the Subversion and git tools, and how to setup a KDE build system, you can specify what modules you want build, where to install them to, and any other options you want and then have kdesrc-build actually do it, even while you're away from the computer or busy doing other things.
# It's easy to step in yourself. kdesrc-build uses a standard source and build directory layout, and calls the same commands you would. So kdesrc-build will not interfere with you performing the build or editing the source yourself if you so choose.

=== Setting up ===

==== Useful Links ====
When using kdesrc-build you may find it beneficial to have a way of searching the source repository so that you know what modules to look for.

* To browse the KDE Subversion repository, use [http://websvn.kde.org/trunk/KDE WebSVN].
* To browse any of the various KDE projects using git, you can go to [http://gitorious.org/ Gitorious].
* The Nokia Qt toolkit used by KDE can be browsed at [http://gitorious.org/+kde-developers/qt/kde-qt the Gitorious kde-qt homepage].

==== Prerequisites ====
kdesrc-build is fairly easy to install and setup, but you also need to have the right software installed to build KDE SC. The requirements to build KDE SC are available as follows:

* KDE SC 4: [[../KDE4#Required_packages_from_your_distribution|KDE 4 Requirements]]

kdesrc-build requires Perl 5.8 or higher. It is installed by default with most distributions, and is included in the link above. Check your version of Perl with:
<code>perl -v</code>

{{note|kdesrc-build is developed on a Linux system, but it should work on the various BSD distributions as well (although GNU tools may be required).}}

==== Download and install kdesrc-build ====
Once your system is setup to be able to compile the KDE SC, you can download kdesrc-build from its website, [http://kdesrc-build.kde.org/ kdesrc-build.kde.org]. The file you download will contain (at least) the kdesrc-build script and a sample configuration file. Installing kdesrc-build is as simple as saving the file and making it executable. If you'd like, you can move it to a directory in your PATH, however for this example we'll put it into the KDE source directory that we use (~/kdesrc)

<code bash>
mkdir -p ~/kdesrc
cd ~/kdesrc
tar xjvf ~/path/to/kdesrc-build-1.12.tar.bz2
cp kdesrc-build-1.12/kdesrc-build .
</code>

Alternatively, the newest kdesrc-build script (and sample config file) can be pulled directly from svn:
<code bash>
mkdir -p ~/kdesrc
cd ~/kdesrc
export SVN_ROOT=svn://anonsvn.kde.org/home/kde
svn cat $SVN_ROOT/trunk/KDE/kdesdk/scripts/kdesrc-build > kdesrc-build
svn cat $SVN_ROOT/trunk/KDE/kdesdk/scripts/kdesrc-buildrc-sample > ~/.kdesrc-buildrc
chmod +x kdesrc-build
</code>

==== Setup the configuration ====
Now you should [[Getting Started/Build/kdesrc-buildrc|setup your configuration]]. For the most part the defaults in the included kdesrc-buildrc-sample should be sufficient.

<code bash>
cp ~/kdesrc/kdesrc-build-1.12/kdesrc-buildrc-sample ~/.kdesrc-buildrc
# Now edit the ~/.kdesrc-buildrc
</code>

{{tip|Note that the config file's name begins with a leading ., making it a hidden file. You may need to show hidden files in Dolphin or Konqueror to find the configuration file to edit it. Or, you can edit the sample before copying it to ~/.kdesrc-buildrc.}}

Also, make sure that the modules you'll want to build are included. You'll want the following at the least:

* qt-copy, kdesupport, kdelibs, kdepimlibs, kdebase

Modules are built in the order they appear in your ~/.kdesrc-buildrc, so the first module should be qt-copy, kdelibs should be before any other KDE SC module, and so on.

{{note|The sample configuration file does include these modules by default, you won't need to make many changes unless you'd like to add some modules to the build by uncommenting them.}}

You may want to enable the make-install-prefix option if you are installing KDE SC or Qt to a directory that is not in your home directory. make-install-prefix allows you to run su or sudo during the make install process so you can install files as root, or set certain programs to execute with higher permissions (This is required for certain programs to execute properly).

<pre>module kdelibs
make-install-prefix sudo -S # sudo with no stdin
end module

module kdebase
make-install-prefix sudo -S
end module</pre>

If a module you'd like to build isn't already present, simply add

<pre>module <module-name>
end module</pre> at the end of the ~/.kdesrc-buildrc. <module-name> would be whatever the module is called in the software repository (for instance, kdemultimedia).

===== Git-based modules =====

Some KDE projects use the "git" source-control software instead of Subversion (as part of an eventual planned migration to git). This includes software like Amarok and Konversation.

To build these modules in kdesrc-build, you just need to add a couple of lines to the module configuration. For example, konversation is developed in the git://gitorious.org/konversation/konversation.git repository at [http://gitorious.org/]. So you would just add a module (you can pick whatever name for the module you like, as long as it's not already used):

<pre>module konversation
repository git://gitorious.org/konversation/konversation.git
branch master
end module</pre>

In this case I selected the "master" branch since that is the default git branch.

Now whenever you build konversation, kdesrc-build will use git instead of Subversion.

==== Useful kdesrc-build commands ====
kdesrc-build is driven from the command line, so here's a guide to some of the more useful command line options:

<table cellpadding="2">
<tr>
<th>Option</th><th>Effect</th>
</tr>
<tr>
<td><tt><span style="white-space:nowrap;">[http://kdesrc-build.kde.org/documentation/cmdline.html#cmdline-pretend --pretend]</span></tt> (Short form <tt><span style="white-space:nowrap;">-p</span></tt>)</td>
<td>This option is like a dry run. kdesrc-build will process the options and its configuration like normal, and run through the build as normal, but instead of downloading or running the build will instead output what kdesrc-build would have done. You should always run with -p before running kdesrc-build to make sure it is doing what you expect.</td>
</tr>
<tr>
<td><tt>[http://kdesrc-build.kde.org/documentation/cmdline.html#cmdline-no-svn --no-svn]</tt> (Alt. form <tt>--no-src</tt>)</td><td>This option skips the source code update step. This is useful if you're running kdesrc-build again soon after the last update and don't want to wait to find out there were no changes.</td>
</tr>
<tr>
<td><tt>[http://kdesrc-build.kde.org/documentation/cmdline.html#cmdline-refresh-build --refresh-build]</tt></td><td>This option causes kdesrc-build to delete the current build information for the given modules and start building them again from scratch. This option takes a lot of time but gives the best chance of a successful build.</td>
</tr>
</table>

Any other non-option arguments on the command line are assumed to be modules to build (and are built in the order provided on the command line). If no modules are specified, all of the modules listed in the ~/.kdesrc-buildrc are built in the order listed in the file.

== Build ==
We're almost there. If you're happy with your settings then it's time to test out kdesrc-build. In theory things are as simple as running kdesrc-build and then coming back later. ;)

<code bash>
cd ~/kdesrc
./kdesrc-build
</code>

You may want to test by building qt-copy first however.

<code bash>
cd ~/kdesrc
./kdesrc-build qt-copy
</code>

{{tip|If you have the [http://www.gnu.org/software/screen/ GNU screen] program available then you should definitely use it to run kdesrc-build, as you can detach your kdesrc-build session and logout while kdesrc-build is still running.}}

If the build failed (kdesrc-build will error out with a nice bright red error message) then there are several possibilities:

# You are missing a key piece of required software (such as a development library)
# The KDE SC code being compiled is broken in some fashion to where it won't build. This is commonly due to newly committed code that worked on the developer's machine, or occasionally on Mondays (when incompatible changes are permitted to kdelibs).
# kdesrc-build is not setup properly. You may be trying to install to a directory that you have no permissions to access for instance, or you may have specified a system qtdir that does not exist.
# The module may depend on a newer version of qt-copy or kdelibs (or other module). In this case you'll have to run kdesrc-build to update the out-of-date module first.

How do you find out what the error was? The output of the failing command will be in the log directory. By default, all log output is in the {{path|log}} subdirectory of the KDE SC source directory. The log directory is laid out like this: {{path|log/date-run/module/output-file.log}}. To simplify finding the appropriate file, there are a couple of symlinks created:

{{path|log/latest}} always has the debugging output for the last time kdesrc-build was run (--pretend doesn't count toward this)
{{path|log/latest/<module>/error.log}} has the debugging output for the command that caused a module build to fail.

For instance if qt-copy just failed to build you could read the output like this:

<code bash>
cd ~/kderc
kwrite log/latest/qt-copy/error.log
</code>

Replace kwrite with your preferred editor. Hopefully the output can guide you to resolving the problem. For instance, if the failure is a cmake output saying you're missing a library, install that library and try again. ;) For link errors you can try running a --refresh-build on the module (or if that doesn't work, required libraries like qt-copy and kdelibs).

If you're stumped by the error you may want to wait a day and try updating again, and hope that the reason for the error has been fixed. You can also try mailing the [http://www.kde.org/mailinglists/ kde-devel] mailing list to see if others know about the problem or have had similar issues.

== Running KDE ==

Assuming you got enough of the modules to build and install to have a working KDE installation, you'll still need to setup your environment correctly to run it. kdesrc-build doesn't help you out here (yet), but the instructions at [[../../Increased_Productivity_in_KDE4_with_Scripts/.bashrc|the .bashrc wiki page]] apply just as well, except that you'll need to set the environment variables to the settings that are in your ~/.kdesrc-buildrc.

For the KDEDIRS and KDEDIR variable use the setting of the "prefix" option (in the global section).
For the QTDIR variable use the setting of the "qtdir" option.

{{tip|When copying settings over to the .bashrc, change any ~'s in the paths to $HOME, as the ~ character is not expanded correctly in the .bashrc.}}

Once your .bashrc is setup logout and log back in again and then you should be able to run your new KDE installation.

== Keeping KDE up to date ==

Keeping your KDE installation up to date is as simple as running kdesrc-build again. Every kdesrc-build has these phases:

# Update the source code for all modules being built.
# Build and then install all the modules.

Old build directories are not deleted by default, so the build after a small update will not normally take as long as the initial build of a module. This is called "incremental make". However it may be necessary at times to perform a full rebuild due to inconsistencies between the build directory configuation and changes to the source directory. You can use the --refresh-build option to force a full rebuild.

For more information on how to take advantage of kdesrc-build, see the [http://kdesrc-build.kde.org/documentation online documentation] for kdesrc-build, which describes all of the module options and command line options available for kdesrc-build and gives tips on how to perform various useful tasks.

If you have any questions that are not answered please feel free to add them under the Discussion entry for this page and hopefully someone will be able to get the answer.

[[Category:Build_KDE]]
[[Category:Tutorial]]

Getting Started/Build/kdesrc-build

2010-08-30T18:11:16Z

Fulldecent: /* Setup the configuration */

{{Template:I18n/Language Navigation Bar|Getting_Started/Build/kdesrc-build}}

{{note|It is possible to build KDE 3 using older versions of kdesrc-build, but this is not described here.}}

== Building KDE using the kdesrc-build tool ==

=== Introduction to kdesvn-build ===

[http://kdesrc-build.kde.org/ kdesrc-build] (formerly kdesvn-build) is a tool to allow users and developers to easily download and build the latest versions of the KDE Software Compilation (KDE SC) from the KDE source code repositories. It automates the following tasks and more:

* Performing the initial checkout.
* Handling updates for modules that are already checked out.
* Setting up the build system for the module.
* Performing the build and install.
* Specifying your CMake options or configure flags (so you don't have to remember them every time).
* Logging build errors so you can review them easier for troubleshooting.

It is not the end-all for your troubles building KDE, [[troubleshooting]] still applies. Many errors that occur using other methods occur here too, you read the log files that are stored for you.

=== Why use kdesrc-build? ===

So why use kdesrc-build? There are several reasons you may like to use it:

# Less manual editing of commands. Instead of having to remember to add the correct options to the cmake command line or configure command, you can setup the options once and then kdesrc-build will use your settings from then on, saving you from wasting time because you forgot to enable a setting.
# Command logging to help debug build failures. kdesrc-build logs all command outputs to a file. This has several advantages:
## When a module fails to build, you already have the error output saved to disk, ready to be viewed and compared with other error messages to aid debugging.
## Quieter output. Even with CMake, the output of Qt or a KDE SC module build can be extensive. kdesrc-build does not show the details of a module build (but will show the progress), instead an overview of the build process is displayed.
# It's just easier. Instead of having to learn how to use the Subversion and git tools, and how to setup a KDE build system, you can specify what modules you want build, where to install them to, and any other options you want and then have kdesrc-build actually do it, even while you're away from the computer or busy doing other things.
# It's easy to step in yourself. kdesrc-build uses a standard source and build directory layout, and calls the same commands you would. So kdesrc-build will not interfere with you performing the build or editing the source yourself if you so choose.

=== Setting up ===

==== Useful Links ====
When using kdesrc-build you may find it beneficial to have a way of searching the source repository so that you know what modules to look for.

* To browse the KDE Subversion repository, use [http://websvn.kde.org/trunk/KDE WebSVN].
* To browse any of the various KDE projects using git, you can go to [http://gitorious.org/ Gitorious].
* The Nokia Qt toolkit used by KDE can be browsed at [http://gitorious.org/+kde-developers/qt/kde-qt the Gitorious kde-qt homepage].

==== Prerequisites ====
kdesrc-build is fairly easy to install and setup, but you also need to have the right software installed to build KDE SC. The requirements to build KDE SC are available as follows:

* KDE SC 4: [[../KDE4#Required_packages_from_your_distribution|KDE 4 Requirements]]

kdesrc-build requires Perl 5.8 or higher. It is installed by default with most distributions, and is included in the link above. Check your version of Perl with:
<code>perl -v</code>

{{note|kdesrc-build is developed on a Linux system, but it should work on the various BSD distributions as well (although GNU tools may be required).}}

==== Download and install kdesrc-build ====
Once your system is setup to be able to compile the KDE SC, you can download kdesrc-build from its website, [http://kdesrc-build.kde.org/ kdesrc-build.kde.org]. The file you download will contain (at least) the kdesrc-build script and a sample configuration file. Installing kdesrc-build is as simple as saving the file and making it executable. If you'd like, you can move it to a directory in your PATH, however for this example we'll put it into the KDE source directory that we use (~/kdesrc)

<code bash>
mkdir -p ~/kdesrc
cd ~/kdesrc
tar xjvf ~/path/to/kdesrc-build-1.12.tar.bz2
cp kdesrc-build-1.12/kdesrc-build .
</code>

Alternatively, the newest kdesrc-build script (and sample config file) can be pulled directly from svn:
<code bash>
mkdir -p ~/kdesrc
cd ~/kdesrc
export SVN_ROOT=svn://anonsvn.kde.org/home/kde
svn cat $SVN_ROOT/trunk/KDE/kdesdk/scripts/kdesrc-build > kdesrc-build
svn cat $SVN_ROOT/trunk/KDE/kdesdk/scripts/kdesrc-buildrc-sample > ~/.kdesrc-buildrc
chmod +x kdesrc-build
</code>

==== Setup the configuration ====
Now you should [[Getting Started/Build/kdesrc-buildrc|setup your configuration]]. For the most part the defaults in the included kdesrc-buildrc-sample should be sufficient.

<code bash>
cp ~/kdesrc/kdesrc-build-1.12/kdesrc-buildrc-sample ~/kdesrc-buildrc
# Now edit the ~/kdesrc-buildrc
</code>

Also, make sure that the modules you'll want to build are included. You'll want the following at the least:

* qt-copy, kdesupport, kdelibs, kdepimlibs, kdebase

Modules are built in the order they appear in your ~/kdesrc-buildrc, so the first module should be qt-copy, kdelibs should be before any other KDE SC module, and so on.

{{note|The sample configuration file does include these modules by default, you won't need to make many changes unless you'd like to add some modules to the build by uncommenting them.}}

You may want to enable the make-install-prefix option if you are installing KDE SC or Qt to a directory that is not in your home directory. make-install-prefix allows you to run su or sudo during the make install process so you can install files as root, or set certain programs to execute with higher permissions (This is required for certain programs to execute properly).

<pre>module kdelibs
make-install-prefix sudo -S # sudo with no stdin
end module

module kdebase
make-install-prefix sudo -S
end module</pre>

If a module you'd like to build isn't already present, simply add

<pre>module <module-name>
end module</pre> at the end of the ~/kdesrc-buildrc. <module-name> would be whatever the module is called in the software repository (for instance, kdemultimedia).

===== Git-based modules =====

Some KDE projects use the "git" source-control software instead of Subversion (as part of an eventual planned migration to git). This includes software like Amarok and Konversation.

To build these modules in kdesrc-build, you just need to add a couple of lines to the module configuration. For example, konversation is developed in the git://gitorious.org/konversation/konversation.git repository at [http://gitorious.org/]. So you would just add a module (you can pick whatever name for the module you like, as long as it's not already used):

<pre>module konversation
repository git://gitorious.org/konversation/konversation.git
branch master
end module</pre>

In this case I selected the "master" branch since that is the default git branch.

Now whenever you build konversation, kdesrc-build will use git instead of Subversion.

==== Useful kdesrc-build commands ====
kdesrc-build is driven from the command line, so here's a guide to some of the more useful command line options:

<table cellpadding="2">
<tr>
<th>Option</th><th>Effect</th>
</tr>
<tr>
<td><tt><span style="white-space:nowrap;">[http://kdesrc-build.kde.org/documentation/cmdline.html#cmdline-pretend --pretend]</span></tt> (Short form <tt><span style="white-space:nowrap;">-p</span></tt>)</td>
<td>This option is like a dry run. kdesrc-build will process the options and its configuration like normal, and run through the build as normal, but instead of downloading or running the build will instead output what kdesrc-build would have done. You should always run with -p before running kdesrc-build to make sure it is doing what you expect.</td>
</tr>
<tr>
<td><tt>[http://kdesrc-build.kde.org/documentation/cmdline.html#cmdline-no-svn --no-svn]</tt> (Alt. form <tt>--no-src</tt>)</td><td>This option skips the source code update step. This is useful if you're running kdesrc-build again soon after the last update and don't want to wait to find out there were no changes.</td>
</tr>
<tr>
<td><tt>[http://kdesrc-build.kde.org/documentation/cmdline.html#cmdline-refresh-build --refresh-build]</tt></td><td>This option causes kdesrc-build to delete the current build information for the given modules and start building them again from scratch. This option takes a lot of time but gives the best chance of a successful build.</td>
</tr>
</table>

Any other non-option arguments on the command line are assumed to be modules to build (and are built in the order provided on the command line). If no modules are specified, all of the modules listed in the ~/.kdesrc-buildrc are built in the order listed in the file.

== Build ==
We're almost there. If you're happy with your settings then it's time to test out kdesrc-build. In theory things are as simple as running kdesrc-build and then coming back later. ;)

<code bash>
cd ~/kdesrc
./kdesrc-build
</code>

You may want to test by building qt-copy first however.

<code bash>
cd ~/kdesrc
./kdesrc-build qt-copy
</code>

{{tip|If you have the [http://www.gnu.org/software/screen/ GNU screen] program available then you should definitely use it to run kdesrc-build, as you can detach your kdesrc-build session and logout while kdesrc-build is still running.}}

If the build failed (kdesrc-build will error out with a nice bright red error message) then there are several possibilities:

# You are missing a key piece of required software (such as a development library)
# The KDE SC code being compiled is broken in some fashion to where it won't build. This is commonly due to newly committed code that worked on the developer's machine, or occasionally on Mondays (when incompatible changes are permitted to kdelibs).
# kdesrc-build is not setup properly. You may be trying to install to a directory that you have no permissions to access for instance, or you may have specified a system qtdir that does not exist.
# The module may depend on a newer version of qt-copy or kdelibs (or other module). In this case you'll have to run kdesrc-build to update the out-of-date module first.

How do you find out what the error was? The output of the failing command will be in the log directory. By default, all log output is in the {{path|log}} subdirectory of the KDE SC source directory. The log directory is laid out like this: {{path|log/date-run/module/output-file.log}}. To simplify finding the appropriate file, there are a couple of symlinks created:

{{path|log/latest}} always has the debugging output for the last time kdesrc-build was run (--pretend doesn't count toward this)
{{path|log/latest/<module>/error.log}} has the debugging output for the command that caused a module build to fail.

For instance if qt-copy just failed to build you could read the output like this:

<code bash>
cd ~/kderc
kwrite log/latest/qt-copy/error.log
</code>

Replace kwrite with your preferred editor. Hopefully the output can guide you to resolving the problem. For instance, if the failure is a cmake output saying you're missing a library, install that library and try again. ;) For link errors you can try running a --refresh-build on the module (or if that doesn't work, required libraries like qt-copy and kdelibs).

If you're stumped by the error you may want to wait a day and try updating again, and hope that the reason for the error has been fixed. You can also try mailing the [http://www.kde.org/mailinglists/ kde-devel] mailing list to see if others know about the problem or have had similar issues.

== Running KDE ==

Assuming you got enough of the modules to build and install to have a working KDE installation, you'll still need to setup your environment correctly to run it. kdesrc-build doesn't help you out here (yet), but the instructions at [[../../Increased_Productivity_in_KDE4_with_Scripts/.bashrc|the .bashrc wiki page]] apply just as well, except that you'll need to set the environment variables to the settings that are in your ~/.kdesrc-buildrc.

For the KDEDIRS and KDEDIR variable use the setting of the "prefix" option (in the global section).
For the QTDIR variable use the setting of the "qtdir" option.

{{tip|When copying settings over to the .bashrc, change any ~'s in the paths to $HOME, as the ~ character is not expanded correctly in the .bashrc.}}

Once your .bashrc is setup logout and log back in again and then you should be able to run your new KDE installation.

== Keeping KDE up to date ==

Keeping your KDE installation up to date is as simple as running kdesrc-build again. Every kdesrc-build has these phases:

# Update the source code for all modules being built.
# Build and then install all the modules.

Old build directories are not deleted by default, so the build after a small update will not normally take as long as the initial build of a module. This is called "incremental make". However it may be necessary at times to perform a full rebuild due to inconsistencies between the build directory configuation and changes to the source directory. You can use the --refresh-build option to force a full rebuild.

For more information on how to take advantage of kdesrc-build, see the [http://kdesrc-build.kde.org/documentation online documentation] for kdesrc-build, which describes all of the module options and command line options available for kdesrc-build and gives tips on how to perform various useful tasks.

If you have any questions that are not answered please feel free to add them under the Discussion entry for this page and hopefully someone will be able to get the answer.

[[Category:Build_KDE]]
[[Category:Tutorial]]

Getting Started/Build/kdesrc-build

2010-08-30T18:10:43Z

Fulldecent: /* Setup the configuration */

{{Template:I18n/Language Navigation Bar|Getting_Started/Build/kdesrc-build}}

{{note|It is possible to build KDE 3 using older versions of kdesrc-build, but this is not described here.}}

== Building KDE using the kdesrc-build tool ==

=== Introduction to kdesvn-build ===

[http://kdesrc-build.kde.org/ kdesrc-build] (formerly kdesvn-build) is a tool to allow users and developers to easily download and build the latest versions of the KDE Software Compilation (KDE SC) from the KDE source code repositories. It automates the following tasks and more:

* Performing the initial checkout.
* Handling updates for modules that are already checked out.
* Setting up the build system for the module.
* Performing the build and install.
* Specifying your CMake options or configure flags (so you don't have to remember them every time).
* Logging build errors so you can review them easier for troubleshooting.

It is not the end-all for your troubles building KDE, [[troubleshooting]] still applies. Many errors that occur using other methods occur here too, you read the log files that are stored for you.

=== Why use kdesrc-build? ===

So why use kdesrc-build? There are several reasons you may like to use it:

# Less manual editing of commands. Instead of having to remember to add the correct options to the cmake command line or configure command, you can setup the options once and then kdesrc-build will use your settings from then on, saving you from wasting time because you forgot to enable a setting.
# Command logging to help debug build failures. kdesrc-build logs all command outputs to a file. This has several advantages:
## When a module fails to build, you already have the error output saved to disk, ready to be viewed and compared with other error messages to aid debugging.
## Quieter output. Even with CMake, the output of Qt or a KDE SC module build can be extensive. kdesrc-build does not show the details of a module build (but will show the progress), instead an overview of the build process is displayed.
# It's just easier. Instead of having to learn how to use the Subversion and git tools, and how to setup a KDE build system, you can specify what modules you want build, where to install them to, and any other options you want and then have kdesrc-build actually do it, even while you're away from the computer or busy doing other things.
# It's easy to step in yourself. kdesrc-build uses a standard source and build directory layout, and calls the same commands you would. So kdesrc-build will not interfere with you performing the build or editing the source yourself if you so choose.

=== Setting up ===

==== Useful Links ====
When using kdesrc-build you may find it beneficial to have a way of searching the source repository so that you know what modules to look for.

* To browse the KDE Subversion repository, use [http://websvn.kde.org/trunk/KDE WebSVN].
* To browse any of the various KDE projects using git, you can go to [http://gitorious.org/ Gitorious].
* The Nokia Qt toolkit used by KDE can be browsed at [http://gitorious.org/+kde-developers/qt/kde-qt the Gitorious kde-qt homepage].

==== Prerequisites ====
kdesrc-build is fairly easy to install and setup, but you also need to have the right software installed to build KDE SC. The requirements to build KDE SC are available as follows:

* KDE SC 4: [[../KDE4#Required_packages_from_your_distribution|KDE 4 Requirements]]

kdesrc-build requires Perl 5.8 or higher. It is installed by default with most distributions, and is included in the link above. Check your version of Perl with:
<code>perl -v</code>

{{note|kdesrc-build is developed on a Linux system, but it should work on the various BSD distributions as well (although GNU tools may be required).}}

==== Download and install kdesrc-build ====
Once your system is setup to be able to compile the KDE SC, you can download kdesrc-build from its website, [http://kdesrc-build.kde.org/ kdesrc-build.kde.org]. The file you download will contain (at least) the kdesrc-build script and a sample configuration file. Installing kdesrc-build is as simple as saving the file and making it executable. If you'd like, you can move it to a directory in your PATH, however for this example we'll put it into the KDE source directory that we use (~/kdesrc)

<code bash>
mkdir -p ~/kdesrc
cd ~/kdesrc
tar xjvf ~/path/to/kdesrc-build-1.12.tar.bz2
cp kdesrc-build-1.12/kdesrc-build .
</code>

Alternatively, the newest kdesrc-build script (and sample config file) can be pulled directly from svn:
<code bash>
mkdir -p ~/kdesrc
cd ~/kdesrc
export SVN_ROOT=svn://anonsvn.kde.org/home/kde
svn cat $SVN_ROOT/trunk/KDE/kdesdk/scripts/kdesrc-build > kdesrc-build
svn cat $SVN_ROOT/trunk/KDE/kdesdk/scripts/kdesrc-buildrc-sample > ~/.kdesrc-buildrc
chmod +x kdesrc-build
</code>

==== Setup the configuration ====
Now you should [[Getting Started/Build/kdesrc-buildrc|setup your configuration]]. For the most part the defaults in the included kdesrc-buildrc-sample should be sufficient.

<code bash>
cp ~/kdesrc/kdesrc-build-1.12/kdesrc-buildrc-sample ~/kdesrc-buildrc
# Now edit the ~/kdesrc-buildrc
</code>

Also, make sure that the modules you'll want to build are included. You'll want the following at the least:

* qt-copy, kdesupport, kdelibs, kdepimlibs, kdebase

Modules are built in the order they appear in your ~/.kdesrc-buildrc, so the first module should be qt-copy, kdelibs should be before any other KDE SC module, and so on.

{{note|The sample configuration file does include these modules by default, you won't need to make many changes unless you'd like to add some modules to the build by uncommenting them.}}

You may want to enable the make-install-prefix option if you are installing KDE SC or Qt to a directory that is not in your home directory. make-install-prefix allows you to run su or sudo during the make install process so you can install files as root, or set certain programs to execute with higher permissions (This is required for certain programs to execute properly).

<pre>module kdelibs
make-install-prefix sudo -S # sudo with no stdin
end module

module kdebase
make-install-prefix sudo -S
end module</pre>

If a module you'd like to build isn't already present, simply add

<pre>module <module-name>
end module</pre> at the end of the ~/.kdesrc-buildrc. <module-name> would be whatever the module is called in the software repository (for instance, kdemultimedia).

===== Git-based modules =====

Some KDE projects use the "git" source-control software instead of Subversion (as part of an eventual planned migration to git). This includes software like Amarok and Konversation.

To build these modules in kdesrc-build, you just need to add a couple of lines to the module configuration. For example, konversation is developed in the git://gitorious.org/konversation/konversation.git repository at [http://gitorious.org/]. So you would just add a module (you can pick whatever name for the module you like, as long as it's not already used):

<pre>module konversation
repository git://gitorious.org/konversation/konversation.git
branch master
end module</pre>

In this case I selected the "master" branch since that is the default git branch.

Now whenever you build konversation, kdesrc-build will use git instead of Subversion.

==== Useful kdesrc-build commands ====
kdesrc-build is driven from the command line, so here's a guide to some of the more useful command line options:

<table cellpadding="2">
<tr>
<th>Option</th><th>Effect</th>
</tr>
<tr>
<td><tt><span style="white-space:nowrap;">[http://kdesrc-build.kde.org/documentation/cmdline.html#cmdline-pretend --pretend]</span></tt> (Short form <tt><span style="white-space:nowrap;">-p</span></tt>)</td>
<td>This option is like a dry run. kdesrc-build will process the options and its configuration like normal, and run through the build as normal, but instead of downloading or running the build will instead output what kdesrc-build would have done. You should always run with -p before running kdesrc-build to make sure it is doing what you expect.</td>
</tr>
<tr>
<td><tt>[http://kdesrc-build.kde.org/documentation/cmdline.html#cmdline-no-svn --no-svn]</tt> (Alt. form <tt>--no-src</tt>)</td><td>This option skips the source code update step. This is useful if you're running kdesrc-build again soon after the last update and don't want to wait to find out there were no changes.</td>
</tr>
<tr>
<td><tt>[http://kdesrc-build.kde.org/documentation/cmdline.html#cmdline-refresh-build --refresh-build]</tt></td><td>This option causes kdesrc-build to delete the current build information for the given modules and start building them again from scratch. This option takes a lot of time but gives the best chance of a successful build.</td>
</tr>
</table>

Any other non-option arguments on the command line are assumed to be modules to build (and are built in the order provided on the command line). If no modules are specified, all of the modules listed in the ~/.kdesrc-buildrc are built in the order listed in the file.

== Build ==
We're almost there. If you're happy with your settings then it's time to test out kdesrc-build. In theory things are as simple as running kdesrc-build and then coming back later. ;)

<code bash>
cd ~/kdesrc
./kdesrc-build
</code>

You may want to test by building qt-copy first however.

<code bash>
cd ~/kdesrc
./kdesrc-build qt-copy
</code>

{{tip|If you have the [http://www.gnu.org/software/screen/ GNU screen] program available then you should definitely use it to run kdesrc-build, as you can detach your kdesrc-build session and logout while kdesrc-build is still running.}}

If the build failed (kdesrc-build will error out with a nice bright red error message) then there are several possibilities:

# You are missing a key piece of required software (such as a development library)
# The KDE SC code being compiled is broken in some fashion to where it won't build. This is commonly due to newly committed code that worked on the developer's machine, or occasionally on Mondays (when incompatible changes are permitted to kdelibs).
# kdesrc-build is not setup properly. You may be trying to install to a directory that you have no permissions to access for instance, or you may have specified a system qtdir that does not exist.
# The module may depend on a newer version of qt-copy or kdelibs (or other module). In this case you'll have to run kdesrc-build to update the out-of-date module first.

How do you find out what the error was? The output of the failing command will be in the log directory. By default, all log output is in the {{path|log}} subdirectory of the KDE SC source directory. The log directory is laid out like this: {{path|log/date-run/module/output-file.log}}. To simplify finding the appropriate file, there are a couple of symlinks created:

{{path|log/latest}} always has the debugging output for the last time kdesrc-build was run (--pretend doesn't count toward this)
{{path|log/latest/<module>/error.log}} has the debugging output for the command that caused a module build to fail.

For instance if qt-copy just failed to build you could read the output like this:

<code bash>
cd ~/kderc
kwrite log/latest/qt-copy/error.log
</code>

Replace kwrite with your preferred editor. Hopefully the output can guide you to resolving the problem. For instance, if the failure is a cmake output saying you're missing a library, install that library and try again. ;) For link errors you can try running a --refresh-build on the module (or if that doesn't work, required libraries like qt-copy and kdelibs).

If you're stumped by the error you may want to wait a day and try updating again, and hope that the reason for the error has been fixed. You can also try mailing the [http://www.kde.org/mailinglists/ kde-devel] mailing list to see if others know about the problem or have had similar issues.

== Running KDE ==

Assuming you got enough of the modules to build and install to have a working KDE installation, you'll still need to setup your environment correctly to run it. kdesrc-build doesn't help you out here (yet), but the instructions at [[../../Increased_Productivity_in_KDE4_with_Scripts/.bashrc|the .bashrc wiki page]] apply just as well, except that you'll need to set the environment variables to the settings that are in your ~/.kdesrc-buildrc.

For the KDEDIRS and KDEDIR variable use the setting of the "prefix" option (in the global section).
For the QTDIR variable use the setting of the "qtdir" option.

{{tip|When copying settings over to the .bashrc, change any ~'s in the paths to $HOME, as the ~ character is not expanded correctly in the .bashrc.}}

Once your .bashrc is setup logout and log back in again and then you should be able to run your new KDE installation.

== Keeping KDE up to date ==

Keeping your KDE installation up to date is as simple as running kdesrc-build again. Every kdesrc-build has these phases:

# Update the source code for all modules being built.
# Build and then install all the modules.

Old build directories are not deleted by default, so the build after a small update will not normally take as long as the initial build of a module. This is called "incremental make". However it may be necessary at times to perform a full rebuild due to inconsistencies between the build directory configuation and changes to the source directory. You can use the --refresh-build option to force a full rebuild.

For more information on how to take advantage of kdesrc-build, see the [http://kdesrc-build.kde.org/documentation online documentation] for kdesrc-build, which describes all of the module options and command line options available for kdesrc-build and gives tips on how to perform various useful tasks.

If you have any questions that are not answered please feel free to add them under the Discussion entry for this page and hopefully someone will be able to get the answer.

[[Category:Build_KDE]]
[[Category:Tutorial]]

Getting Started/Build/kdesrc-build

2010-08-30T18:09:53Z

Fulldecent: /* Setup the configuration */

{{Template:I18n/Language Navigation Bar|Getting_Started/Build/kdesrc-build}}

{{note|It is possible to build KDE 3 using older versions of kdesrc-build, but this is not described here.}}

== Building KDE using the kdesrc-build tool ==

=== Introduction to kdesvn-build ===

[http://kdesrc-build.kde.org/ kdesrc-build] (formerly kdesvn-build) is a tool to allow users and developers to easily download and build the latest versions of the KDE Software Compilation (KDE SC) from the KDE source code repositories. It automates the following tasks and more:

* Performing the initial checkout.
* Handling updates for modules that are already checked out.
* Setting up the build system for the module.
* Performing the build and install.
* Specifying your CMake options or configure flags (so you don't have to remember them every time).
* Logging build errors so you can review them easier for troubleshooting.

It is not the end-all for your troubles building KDE, [[troubleshooting]] still applies. Many errors that occur using other methods occur here too, you read the log files that are stored for you.

=== Why use kdesrc-build? ===

So why use kdesrc-build? There are several reasons you may like to use it:

# Less manual editing of commands. Instead of having to remember to add the correct options to the cmake command line or configure command, you can setup the options once and then kdesrc-build will use your settings from then on, saving you from wasting time because you forgot to enable a setting.
# Command logging to help debug build failures. kdesrc-build logs all command outputs to a file. This has several advantages:
## When a module fails to build, you already have the error output saved to disk, ready to be viewed and compared with other error messages to aid debugging.
## Quieter output. Even with CMake, the output of Qt or a KDE SC module build can be extensive. kdesrc-build does not show the details of a module build (but will show the progress), instead an overview of the build process is displayed.
# It's just easier. Instead of having to learn how to use the Subversion and git tools, and how to setup a KDE build system, you can specify what modules you want build, where to install them to, and any other options you want and then have kdesrc-build actually do it, even while you're away from the computer or busy doing other things.
# It's easy to step in yourself. kdesrc-build uses a standard source and build directory layout, and calls the same commands you would. So kdesrc-build will not interfere with you performing the build or editing the source yourself if you so choose.

=== Setting up ===

==== Useful Links ====
When using kdesrc-build you may find it beneficial to have a way of searching the source repository so that you know what modules to look for.

* To browse the KDE Subversion repository, use [http://websvn.kde.org/trunk/KDE WebSVN].
* To browse any of the various KDE projects using git, you can go to [http://gitorious.org/ Gitorious].
* The Nokia Qt toolkit used by KDE can be browsed at [http://gitorious.org/+kde-developers/qt/kde-qt the Gitorious kde-qt homepage].

==== Prerequisites ====
kdesrc-build is fairly easy to install and setup, but you also need to have the right software installed to build KDE SC. The requirements to build KDE SC are available as follows:

* KDE SC 4: [[../KDE4#Required_packages_from_your_distribution|KDE 4 Requirements]]

kdesrc-build requires Perl 5.8 or higher. It is installed by default with most distributions, and is included in the link above. Check your version of Perl with:
<code>perl -v</code>

{{note|kdesrc-build is developed on a Linux system, but it should work on the various BSD distributions as well (although GNU tools may be required).}}

==== Download and install kdesrc-build ====
Once your system is setup to be able to compile the KDE SC, you can download kdesrc-build from its website, [http://kdesrc-build.kde.org/ kdesrc-build.kde.org]. The file you download will contain (at least) the kdesrc-build script and a sample configuration file. Installing kdesrc-build is as simple as saving the file and making it executable. If you'd like, you can move it to a directory in your PATH, however for this example we'll put it into the KDE source directory that we use (~/kdesrc)

<code bash>
mkdir -p ~/kdesrc
cd ~/kdesrc
tar xjvf ~/path/to/kdesrc-build-1.12.tar.bz2
cp kdesrc-build-1.12/kdesrc-build .
</code>

Alternatively, the newest kdesrc-build script (and sample config file) can be pulled directly from svn:
<code bash>
mkdir -p ~/kdesrc
cd ~/kdesrc
export SVN_ROOT=svn://anonsvn.kde.org/home/kde
svn cat $SVN_ROOT/trunk/KDE/kdesdk/scripts/kdesrc-build > kdesrc-build
svn cat $SVN_ROOT/trunk/KDE/kdesdk/scripts/kdesrc-buildrc-sample > ~/.kdesrc-buildrc
chmod +x kdesrc-build
</code>

==== Setup the configuration ====
Now you should [[Getting Started/Build/kdesrc-buildrc|setup your configuration]]. For the most part the defaults in the included kdesrc-buildrc-sample should be sufficient.

<code bash>
cp ~/kdesrc/kdesrc-build-1.12/kdesrc-buildrc-sample ~/.kdesrc-buildrc
# Now edit the ~/.kdesrc-buildrc
</code>

{{tip|Note that the config file's name begins with a leading ., making it a hidden file. You may need to show hidden files in Dolphin or Konqueror to find the configuration file to edit it. Or, you can edit the sample before copying it to ~/.kdesrc-buildrc.}}

Also, make sure that the modules you'll want to build are included. You'll want the following at the least:

* qt-copy, kdesupport, kdelibs, kdepimlibs, kdebase

Modules are built in the order they appear in your ~/.kdesrc-buildrc, so the first module should be qt-copy, kdelibs should be before any other KDE SC module, and so on.

{{note|The sample configuration file does include these modules by default, you won't need to make many changes unless you'd like to add some modules to the build by uncommenting them.}}

You may want to enable the make-install-prefix option if you are installing KDE SC or Qt to a directory that is not in your home directory. make-install-prefix allows you to run su or sudo during the make install process so you can install files as root, or set certain programs to execute with higher permissions (This is required for certain programs to execute properly).

<pre>module kdelibs
make-install-prefix sudo -S # sudo with no stdin
end module

module kdebase
make-install-prefix sudo -S
end module</pre>

If a module you'd like to build isn't already present, simply add

<pre>module <module-name>
end module</pre> at the end of the ~/.kdesrc-buildrc. <module-name> would be whatever the module is called in the software repository (for instance, kdemultimedia).

===== Git-based modules =====

Some KDE projects use the "git" source-control software instead of Subversion (as part of an eventual planned migration to git). This includes software like Amarok and Konversation.

To build these modules in kdesrc-build, you just need to add a couple of lines to the module configuration. For example, konversation is developed in the git://gitorious.org/konversation/konversation.git repository at [http://gitorious.org/]. So you would just add a module (you can pick whatever name for the module you like, as long as it's not already used):

<pre>module konversation
repository git://gitorious.org/konversation/konversation.git
branch master
end module</pre>

In this case I selected the "master" branch since that is the default git branch.

Now whenever you build konversation, kdesrc-build will use git instead of Subversion.

==== Useful kdesrc-build commands ====
kdesrc-build is driven from the command line, so here's a guide to some of the more useful command line options:

<table cellpadding="2">
<tr>
<th>Option</th><th>Effect</th>
</tr>
<tr>
<td><tt><span style="white-space:nowrap;">[http://kdesrc-build.kde.org/documentation/cmdline.html#cmdline-pretend --pretend]</span></tt> (Short form <tt><span style="white-space:nowrap;">-p</span></tt>)</td>
<td>This option is like a dry run. kdesrc-build will process the options and its configuration like normal, and run through the build as normal, but instead of downloading or running the build will instead output what kdesrc-build would have done. You should always run with -p before running kdesrc-build to make sure it is doing what you expect.</td>
</tr>
<tr>
<td><tt>[http://kdesrc-build.kde.org/documentation/cmdline.html#cmdline-no-svn --no-svn]</tt> (Alt. form <tt>--no-src</tt>)</td><td>This option skips the source code update step. This is useful if you're running kdesrc-build again soon after the last update and don't want to wait to find out there were no changes.</td>
</tr>
<tr>
<td><tt>[http://kdesrc-build.kde.org/documentation/cmdline.html#cmdline-refresh-build --refresh-build]</tt></td><td>This option causes kdesrc-build to delete the current build information for the given modules and start building them again from scratch. This option takes a lot of time but gives the best chance of a successful build.</td>
</tr>
</table>

Any other non-option arguments on the command line are assumed to be modules to build (and are built in the order provided on the command line). If no modules are specified, all of the modules listed in the ~/.kdesrc-buildrc are built in the order listed in the file.

== Build ==
We're almost there. If you're happy with your settings then it's time to test out kdesrc-build. In theory things are as simple as running kdesrc-build and then coming back later. ;)

<code bash>
cd ~/kdesrc
./kdesrc-build
</code>

You may want to test by building qt-copy first however.

<code bash>
cd ~/kdesrc
./kdesrc-build qt-copy
</code>

{{tip|If you have the [http://www.gnu.org/software/screen/ GNU screen] program available then you should definitely use it to run kdesrc-build, as you can detach your kdesrc-build session and logout while kdesrc-build is still running.}}

If the build failed (kdesrc-build will error out with a nice bright red error message) then there are several possibilities:

# You are missing a key piece of required software (such as a development library)
# The KDE SC code being compiled is broken in some fashion to where it won't build. This is commonly due to newly committed code that worked on the developer's machine, or occasionally on Mondays (when incompatible changes are permitted to kdelibs).
# kdesrc-build is not setup properly. You may be trying to install to a directory that you have no permissions to access for instance, or you may have specified a system qtdir that does not exist.
# The module may depend on a newer version of qt-copy or kdelibs (or other module). In this case you'll have to run kdesrc-build to update the out-of-date module first.

How do you find out what the error was? The output of the failing command will be in the log directory. By default, all log output is in the {{path|log}} subdirectory of the KDE SC source directory. The log directory is laid out like this: {{path|log/date-run/module/output-file.log}}. To simplify finding the appropriate file, there are a couple of symlinks created:

{{path|log/latest}} always has the debugging output for the last time kdesrc-build was run (--pretend doesn't count toward this)
{{path|log/latest/<module>/error.log}} has the debugging output for the command that caused a module build to fail.

For instance if qt-copy just failed to build you could read the output like this:

<code bash>
cd ~/kderc
kwrite log/latest/qt-copy/error.log
</code>

Replace kwrite with your preferred editor. Hopefully the output can guide you to resolving the problem. For instance, if the failure is a cmake output saying you're missing a library, install that library and try again. ;) For link errors you can try running a --refresh-build on the module (or if that doesn't work, required libraries like qt-copy and kdelibs).

If you're stumped by the error you may want to wait a day and try updating again, and hope that the reason for the error has been fixed. You can also try mailing the [http://www.kde.org/mailinglists/ kde-devel] mailing list to see if others know about the problem or have had similar issues.

== Running KDE ==

Assuming you got enough of the modules to build and install to have a working KDE installation, you'll still need to setup your environment correctly to run it. kdesrc-build doesn't help you out here (yet), but the instructions at [[../../Increased_Productivity_in_KDE4_with_Scripts/.bashrc|the .bashrc wiki page]] apply just as well, except that you'll need to set the environment variables to the settings that are in your ~/.kdesrc-buildrc.

For the KDEDIRS and KDEDIR variable use the setting of the "prefix" option (in the global section).
For the QTDIR variable use the setting of the "qtdir" option.

{{tip|When copying settings over to the .bashrc, change any ~'s in the paths to $HOME, as the ~ character is not expanded correctly in the .bashrc.}}

Once your .bashrc is setup logout and log back in again and then you should be able to run your new KDE installation.

== Keeping KDE up to date ==

Keeping your KDE installation up to date is as simple as running kdesrc-build again. Every kdesrc-build has these phases:

# Update the source code for all modules being built.
# Build and then install all the modules.

Old build directories are not deleted by default, so the build after a small update will not normally take as long as the initial build of a module. This is called "incremental make". However it may be necessary at times to perform a full rebuild due to inconsistencies between the build directory configuation and changes to the source directory. You can use the --refresh-build option to force a full rebuild.

For more information on how to take advantage of kdesrc-build, see the [http://kdesrc-build.kde.org/documentation online documentation] for kdesrc-build, which describes all of the module options and command line options available for kdesrc-build and gives tips on how to perform various useful tasks.

If you have any questions that are not answered please feel free to add them under the Discussion entry for this page and hopefully someone will be able to get the answer.

[[Category:Build_KDE]]
[[Category:Tutorial]]

Getting Started/Build/kdesrc-build

2010-08-30T17:58:43Z

Fulldecent: /* Prerequisites */

{{Template:I18n/Language Navigation Bar|Getting_Started/Build/kdesrc-build}}

{{note|It is possible to build KDE 3 using older versions of kdesrc-build, but this is not described here.}}

== Building KDE using the kdesrc-build tool ==

=== Introduction to kdesvn-build ===

[http://kdesrc-build.kde.org/ kdesrc-build] (formerly kdesvn-build) is a tool to allow users and developers to easily download and build the latest versions of the KDE Software Compilation (KDE SC) from the KDE source code repositories. It automates the following tasks and more:

* Performing the initial checkout.
* Handling updates for modules that are already checked out.
* Setting up the build system for the module.
* Performing the build and install.
* Specifying your CMake options or configure flags (so you don't have to remember them every time).
* Logging build errors so you can review them easier for troubleshooting.

It is not the end-all for your troubles building KDE, [[troubleshooting]] still applies. Many errors that occur using other methods occur here too, you read the log files that are stored for you.

=== Why use kdesrc-build? ===

So why use kdesrc-build? There are several reasons you may like to use it:

# Less manual editing of commands. Instead of having to remember to add the correct options to the cmake command line or configure command, you can setup the options once and then kdesrc-build will use your settings from then on, saving you from wasting time because you forgot to enable a setting.
# Command logging to help debug build failures. kdesrc-build logs all command outputs to a file. This has several advantages:
## When a module fails to build, you already have the error output saved to disk, ready to be viewed and compared with other error messages to aid debugging.
## Quieter output. Even with CMake, the output of Qt or a KDE SC module build can be extensive. kdesrc-build does not show the details of a module build (but will show the progress), instead an overview of the build process is displayed.
# It's just easier. Instead of having to learn how to use the Subversion and git tools, and how to setup a KDE build system, you can specify what modules you want build, where to install them to, and any other options you want and then have kdesrc-build actually do it, even while you're away from the computer or busy doing other things.
# It's easy to step in yourself. kdesrc-build uses a standard source and build directory layout, and calls the same commands you would. So kdesrc-build will not interfere with you performing the build or editing the source yourself if you so choose.

=== Setting up ===

==== Useful Links ====
When using kdesrc-build you may find it beneficial to have a way of searching the source repository so that you know what modules to look for.

* To browse the KDE Subversion repository, use [http://websvn.kde.org/trunk/KDE WebSVN].
* To browse any of the various KDE projects using git, you can go to [http://gitorious.org/ Gitorious].
* The Nokia Qt toolkit used by KDE can be browsed at [http://gitorious.org/+kde-developers/qt/kde-qt the Gitorious kde-qt homepage].

==== Prerequisites ====
kdesrc-build is fairly easy to install and setup, but you also need to have the right software installed to build KDE SC. The requirements to build KDE SC are available as follows:

* KDE SC 4: [[../KDE4#Required_packages_from_your_distribution|KDE 4 Requirements]]

kdesrc-build requires Perl 5.8 or higher. It is installed by default with most distributions, and is included in the link above. Check your version of Perl with:
<code>perl -v</code>

{{note|kdesrc-build is developed on a Linux system, but it should work on the various BSD distributions as well (although GNU tools may be required).}}

==== Download and install kdesrc-build ====
Once your system is setup to be able to compile the KDE SC, you can download kdesrc-build from its website, [http://kdesrc-build.kde.org/ kdesrc-build.kde.org]. The file you download will contain (at least) the kdesrc-build script and a sample configuration file. Installing kdesrc-build is as simple as saving the file and making it executable. If you'd like, you can move it to a directory in your PATH, however for this example we'll put it into the KDE source directory that we use (~/kdesrc)

<code bash>
mkdir -p ~/kdesrc
cd ~/kdesrc
tar xjvf ~/path/to/kdesrc-build-1.12.tar.bz2
cp kdesrc-build-1.12/kdesrc-build .
</code>

Alternatively, the newest kdesrc-build script (and sample config file) can be pulled directly from svn:
<code bash>
mkdir -p ~/kdesrc
cd ~/kdesrc
export SVN_ROOT=svn://anonsvn.kde.org/home/kde
svn cat $SVN_ROOT/trunk/KDE/kdesdk/scripts/kdesrc-build > kdesrc-build
svn cat $SVN_ROOT/trunk/KDE/kdesdk/scripts/kdesrc-buildrc-sample > ~/.kdesrc-buildrc
chmod +x kdesrc-build
</code>

==== Setup the configuration ====
Now you should [[Getting Started/Build/kdesrc-buildrc|setup your configuration]]. For the most part the defaults in the included kdesrc-buildrc-sample should be sufficient.

Older:
<code bash>
cp ~/kdesvn/kdesvn-build-1.10/kdesvn-buildrc-sample ~/.kdesvn-buildrc
# Now edit the ~/.kdesvn-buildrc
</code>
Newer:
<code bash>
cp ~/kdesrc/kdesrc-build-1.12/kdesrc-buildrc-sample ~/.kdesrc-buildrc
# Now edit the ~/.kdesrc-buildrc
</code>

{{tip|Note that the config file's name begins with a leading ., making it a hidden file. You may need to show hidden files in Dolphin or Konqueror to find the configuration file to edit it. Or, you can edit the sample before copying it to ~/.kdesrc-buildrc.}}

Also, make sure that the modules you'll want to build are included. You'll want the following at the least:

* qt-copy, kdesupport, kdelibs, kdepimlibs, kdebase

Modules are built in the order they appear in your ~/.kdesrc-buildrc, so the first module should be qt-copy, kdelibs should be before any other KDE SC module, and so on.

{{note|The sample configuration file does include these modules by default, you won't need to make many changes unless you'd like to add some modules to the build by uncommenting them.}}

You may want to enable the make-install-prefix option if you are installing KDE SC or Qt to a directory that is not in your home directory. make-install-prefix allows you to run su or sudo during the make install process so you can install files as root, or set certain programs to execute with higher permissions (This is required for certain programs to execute properly).

<pre>module kdelibs
make-install-prefix sudo -S # sudo with no stdin
end module

module kdebase
make-install-prefix sudo -S
end module</pre>

If a module you'd like to build isn't already present, simply add

<pre>module <module-name>
end module</pre> at the end of the ~/.kdesrc-buildrc. <module-name> would be whatever the module is called in the software repository (for instance, kdemultimedia).

===== Git-based modules =====

Some KDE projects use the "git" source-control software instead of Subversion (as part of an eventual planned migration to git). This includes software like Amarok and Konversation.

To build these modules in kdesrc-build, you just need to add a couple of lines to the module configuration. For example, konversation is developed in the git://gitorious.org/konversation/konversation.git repository at [http://gitorious.org/]. So you would just add a module (you can pick whatever name for the module you like, as long as it's not already used):

<pre>module konversation
repository git://gitorious.org/konversation/konversation.git
branch master
end module</pre>

In this case I selected the "master" branch since that is the default git branch.

Now whenever you build konversation, kdesrc-build will use git instead of Subversion.

==== Useful kdesrc-build commands ====
kdesrc-build is driven from the command line, so here's a guide to some of the more useful command line options:

<table cellpadding="2">
<tr>
<th>Option</th><th>Effect</th>
</tr>
<tr>
<td><tt><span style="white-space:nowrap;">[http://kdesrc-build.kde.org/documentation/cmdline.html#cmdline-pretend --pretend]</span></tt> (Short form <tt><span style="white-space:nowrap;">-p</span></tt>)</td>
<td>This option is like a dry run. kdesrc-build will process the options and its configuration like normal, and run through the build as normal, but instead of downloading or running the build will instead output what kdesrc-build would have done. You should always run with -p before running kdesrc-build to make sure it is doing what you expect.</td>
</tr>
<tr>
<td><tt>[http://kdesrc-build.kde.org/documentation/cmdline.html#cmdline-no-svn --no-svn]</tt> (Alt. form <tt>--no-src</tt>)</td><td>This option skips the source code update step. This is useful if you're running kdesrc-build again soon after the last update and don't want to wait to find out there were no changes.</td>
</tr>
<tr>
<td><tt>[http://kdesrc-build.kde.org/documentation/cmdline.html#cmdline-refresh-build --refresh-build]</tt></td><td>This option causes kdesrc-build to delete the current build information for the given modules and start building them again from scratch. This option takes a lot of time but gives the best chance of a successful build.</td>
</tr>
</table>

Any other non-option arguments on the command line are assumed to be modules to build (and are built in the order provided on the command line). If no modules are specified, all of the modules listed in the ~/.kdesrc-buildrc are built in the order listed in the file.

== Build ==
We're almost there. If you're happy with your settings then it's time to test out kdesrc-build. In theory things are as simple as running kdesrc-build and then coming back later. ;)

<code bash>
cd ~/kdesrc
./kdesrc-build
</code>

You may want to test by building qt-copy first however.

<code bash>
cd ~/kdesrc
./kdesrc-build qt-copy
</code>

{{tip|If you have the [http://www.gnu.org/software/screen/ GNU screen] program available then you should definitely use it to run kdesrc-build, as you can detach your kdesrc-build session and logout while kdesrc-build is still running.}}

If the build failed (kdesrc-build will error out with a nice bright red error message) then there are several possibilities:

# You are missing a key piece of required software (such as a development library)
# The KDE SC code being compiled is broken in some fashion to where it won't build. This is commonly due to newly committed code that worked on the developer's machine, or occasionally on Mondays (when incompatible changes are permitted to kdelibs).
# kdesrc-build is not setup properly. You may be trying to install to a directory that you have no permissions to access for instance, or you may have specified a system qtdir that does not exist.
# The module may depend on a newer version of qt-copy or kdelibs (or other module). In this case you'll have to run kdesrc-build to update the out-of-date module first.

How do you find out what the error was? The output of the failing command will be in the log directory. By default, all log output is in the {{path|log}} subdirectory of the KDE SC source directory. The log directory is laid out like this: {{path|log/date-run/module/output-file.log}}. To simplify finding the appropriate file, there are a couple of symlinks created:

{{path|log/latest}} always has the debugging output for the last time kdesrc-build was run (--pretend doesn't count toward this)
{{path|log/latest/<module>/error.log}} has the debugging output for the command that caused a module build to fail.

For instance if qt-copy just failed to build you could read the output like this:

<code bash>
cd ~/kderc
kwrite log/latest/qt-copy/error.log
</code>

Replace kwrite with your preferred editor. Hopefully the output can guide you to resolving the problem. For instance, if the failure is a cmake output saying you're missing a library, install that library and try again. ;) For link errors you can try running a --refresh-build on the module (or if that doesn't work, required libraries like qt-copy and kdelibs).

If you're stumped by the error you may want to wait a day and try updating again, and hope that the reason for the error has been fixed. You can also try mailing the [http://www.kde.org/mailinglists/ kde-devel] mailing list to see if others know about the problem or have had similar issues.

== Running KDE ==

Assuming you got enough of the modules to build and install to have a working KDE installation, you'll still need to setup your environment correctly to run it. kdesrc-build doesn't help you out here (yet), but the instructions at [[../../Increased_Productivity_in_KDE4_with_Scripts/.bashrc|the .bashrc wiki page]] apply just as well, except that you'll need to set the environment variables to the settings that are in your ~/.kdesrc-buildrc.

For the KDEDIRS and KDEDIR variable use the setting of the "prefix" option (in the global section).
For the QTDIR variable use the setting of the "qtdir" option.

{{tip|When copying settings over to the .bashrc, change any ~'s in the paths to $HOME, as the ~ character is not expanded correctly in the .bashrc.}}

Once your .bashrc is setup logout and log back in again and then you should be able to run your new KDE installation.

== Keeping KDE up to date ==

Keeping your KDE installation up to date is as simple as running kdesrc-build again. Every kdesrc-build has these phases:

# Update the source code for all modules being built.
# Build and then install all the modules.

Old build directories are not deleted by default, so the build after a small update will not normally take as long as the initial build of a module. This is called "incremental make". However it may be necessary at times to perform a full rebuild due to inconsistencies between the build directory configuation and changes to the source directory. You can use the --refresh-build option to force a full rebuild.

For more information on how to take advantage of kdesrc-build, see the [http://kdesrc-build.kde.org/documentation online documentation] for kdesrc-build, which describes all of the module options and command line options available for kdesrc-build and gives tips on how to perform various useful tasks.

If you have any questions that are not answered please feel free to add them under the Discussion entry for this page and hopefully someone will be able to get the answer.

[[Category:Build_KDE]]
[[Category:Tutorial]]

Getting Started/Build/kdesrc-build

2010-08-30T17:54:30Z

Fulldecent:

{{Template:I18n/Language Navigation Bar|Getting_Started/Build/kdesrc-build}}

{{note|It is possible to build KDE 3 using older versions of kdesrc-build, but this is not described here.}}

== Building KDE using the kdesrc-build tool ==

=== Introduction to kdesvn-build ===

[http://kdesrc-build.kde.org/ kdesrc-build] (formerly kdesvn-build) is a tool to allow users and developers to easily download and build the latest versions of the KDE Software Compilation (KDE SC) from the KDE source code repositories. It automates the following tasks and more:

* Performing the initial checkout.
* Handling updates for modules that are already checked out.
* Setting up the build system for the module.
* Performing the build and install.
* Specifying your CMake options or configure flags (so you don't have to remember them every time).
* Logging build errors so you can review them easier for troubleshooting.

It is not the end-all for your troubles building KDE, [[troubleshooting]] still applies. Many errors that occur using other methods occur here too, you read the log files that are stored for you.

=== Why use kdesrc-build? ===

So why use kdesrc-build? There are several reasons you may like to use it:

# Less manual editing of commands. Instead of having to remember to add the correct options to the cmake command line or configure command, you can setup the options once and then kdesrc-build will use your settings from then on, saving you from wasting time because you forgot to enable a setting.
# Command logging to help debug build failures. kdesrc-build logs all command outputs to a file. This has several advantages:
## When a module fails to build, you already have the error output saved to disk, ready to be viewed and compared with other error messages to aid debugging.
## Quieter output. Even with CMake, the output of Qt or a KDE SC module build can be extensive. kdesrc-build does not show the details of a module build (but will show the progress), instead an overview of the build process is displayed.
# It's just easier. Instead of having to learn how to use the Subversion and git tools, and how to setup a KDE build system, you can specify what modules you want build, where to install them to, and any other options you want and then have kdesrc-build actually do it, even while you're away from the computer or busy doing other things.
# It's easy to step in yourself. kdesrc-build uses a standard source and build directory layout, and calls the same commands you would. So kdesrc-build will not interfere with you performing the build or editing the source yourself if you so choose.

=== Setting up ===

==== Useful Links ====
When using kdesrc-build you may find it beneficial to have a way of searching the source repository so that you know what modules to look for.

* To browse the KDE Subversion repository, use [http://websvn.kde.org/trunk/KDE WebSVN].
* To browse any of the various KDE projects using git, you can go to [http://gitorious.org/ Gitorious].
* The Nokia Qt toolkit used by KDE can be browsed at [http://gitorious.org/+kde-developers/qt/kde-qt the Gitorious kde-qt homepage].

==== Prerequisites ====
kdesrc-build is fairly easy to install and setup, but you also need to have the right software installed to build KDE SC. The requirements to build KDE SC are available as follows:

* KDE SC 4: [[../KDE4#Required_packages_from_your_distribution|KDE 4 Requirements]]

In addition to those listed requirements, kdesrc-build requires the Perl scripting platform to be installed. It is installed by default with most distributions, and is required to build KDE SC anyways. kdesrc-build requires Perl 5.8 or higher.

{{note|kdesrc-build is developed on a Linux system, but it should work on the various BSD distributions as well (although GNU tools may be required).}}

==== Download and install kdesrc-build ====
Once your system is setup to be able to compile the KDE SC, you can download kdesrc-build from its website, [http://kdesrc-build.kde.org/ kdesrc-build.kde.org]. The file you download will contain (at least) the kdesrc-build script and a sample configuration file. Installing kdesrc-build is as simple as saving the file and making it executable. If you'd like, you can move it to a directory in your PATH, however for this example we'll put it into the KDE source directory that we use (~/kdesrc)

<code bash>
mkdir -p ~/kdesrc
cd ~/kdesrc
tar xjvf ~/path/to/kdesrc-build-1.12.tar.bz2
cp kdesrc-build-1.12/kdesrc-build .
</code>

Alternatively, the newest kdesrc-build script (and sample config file) can be pulled directly from svn:
<code bash>
mkdir -p ~/kdesrc
cd ~/kdesrc
export SVN_ROOT=svn://anonsvn.kde.org/home/kde
svn cat $SVN_ROOT/trunk/KDE/kdesdk/scripts/kdesrc-build > kdesrc-build
svn cat $SVN_ROOT/trunk/KDE/kdesdk/scripts/kdesrc-buildrc-sample > ~/.kdesrc-buildrc
chmod +x kdesrc-build
</code>

==== Setup the configuration ====
Now you should [[Getting Started/Build/kdesrc-buildrc|setup your configuration]]. For the most part the defaults in the included kdesrc-buildrc-sample should be sufficient.

Older:
<code bash>
cp ~/kdesvn/kdesvn-build-1.10/kdesvn-buildrc-sample ~/.kdesvn-buildrc
# Now edit the ~/.kdesvn-buildrc
</code>
Newer:
<code bash>
cp ~/kdesrc/kdesrc-build-1.12/kdesrc-buildrc-sample ~/.kdesrc-buildrc
# Now edit the ~/.kdesrc-buildrc
</code>

{{tip|Note that the config file's name begins with a leading ., making it a hidden file. You may need to show hidden files in Dolphin or Konqueror to find the configuration file to edit it. Or, you can edit the sample before copying it to ~/.kdesrc-buildrc.}}

Also, make sure that the modules you'll want to build are included. You'll want the following at the least:

* qt-copy, kdesupport, kdelibs, kdepimlibs, kdebase

Modules are built in the order they appear in your ~/.kdesrc-buildrc, so the first module should be qt-copy, kdelibs should be before any other KDE SC module, and so on.

{{note|The sample configuration file does include these modules by default, you won't need to make many changes unless you'd like to add some modules to the build by uncommenting them.}}

You may want to enable the make-install-prefix option if you are installing KDE SC or Qt to a directory that is not in your home directory. make-install-prefix allows you to run su or sudo during the make install process so you can install files as root, or set certain programs to execute with higher permissions (This is required for certain programs to execute properly).

<pre>module kdelibs
make-install-prefix sudo -S # sudo with no stdin
end module

module kdebase
make-install-prefix sudo -S
end module</pre>

If a module you'd like to build isn't already present, simply add

<pre>module <module-name>
end module</pre> at the end of the ~/.kdesrc-buildrc. <module-name> would be whatever the module is called in the software repository (for instance, kdemultimedia).

===== Git-based modules =====

Some KDE projects use the "git" source-control software instead of Subversion (as part of an eventual planned migration to git). This includes software like Amarok and Konversation.

To build these modules in kdesrc-build, you just need to add a couple of lines to the module configuration. For example, konversation is developed in the git://gitorious.org/konversation/konversation.git repository at [http://gitorious.org/]. So you would just add a module (you can pick whatever name for the module you like, as long as it's not already used):

<pre>module konversation
repository git://gitorious.org/konversation/konversation.git
branch master
end module</pre>

In this case I selected the "master" branch since that is the default git branch.

Now whenever you build konversation, kdesrc-build will use git instead of Subversion.

==== Useful kdesrc-build commands ====
kdesrc-build is driven from the command line, so here's a guide to some of the more useful command line options:

<table cellpadding="2">
<tr>
<th>Option</th><th>Effect</th>
</tr>
<tr>
<td><tt><span style="white-space:nowrap;">[http://kdesrc-build.kde.org/documentation/cmdline.html#cmdline-pretend --pretend]</span></tt> (Short form <tt><span style="white-space:nowrap;">-p</span></tt>)</td>
<td>This option is like a dry run. kdesrc-build will process the options and its configuration like normal, and run through the build as normal, but instead of downloading or running the build will instead output what kdesrc-build would have done. You should always run with -p before running kdesrc-build to make sure it is doing what you expect.</td>
</tr>
<tr>
<td><tt>[http://kdesrc-build.kde.org/documentation/cmdline.html#cmdline-no-svn --no-svn]</tt> (Alt. form <tt>--no-src</tt>)</td><td>This option skips the source code update step. This is useful if you're running kdesrc-build again soon after the last update and don't want to wait to find out there were no changes.</td>
</tr>
<tr>
<td><tt>[http://kdesrc-build.kde.org/documentation/cmdline.html#cmdline-refresh-build --refresh-build]</tt></td><td>This option causes kdesrc-build to delete the current build information for the given modules and start building them again from scratch. This option takes a lot of time but gives the best chance of a successful build.</td>
</tr>
</table>

Any other non-option arguments on the command line are assumed to be modules to build (and are built in the order provided on the command line). If no modules are specified, all of the modules listed in the ~/.kdesrc-buildrc are built in the order listed in the file.

== Build ==
We're almost there. If you're happy with your settings then it's time to test out kdesrc-build. In theory things are as simple as running kdesrc-build and then coming back later. ;)

<code bash>
cd ~/kdesrc
./kdesrc-build
</code>

You may want to test by building qt-copy first however.

<code bash>
cd ~/kdesrc
./kdesrc-build qt-copy
</code>

{{tip|If you have the [http://www.gnu.org/software/screen/ GNU screen] program available then you should definitely use it to run kdesrc-build, as you can detach your kdesrc-build session and logout while kdesrc-build is still running.}}

If the build failed (kdesrc-build will error out with a nice bright red error message) then there are several possibilities:

# You are missing a key piece of required software (such as a development library)
# The KDE SC code being compiled is broken in some fashion to where it won't build. This is commonly due to newly committed code that worked on the developer's machine, or occasionally on Mondays (when incompatible changes are permitted to kdelibs).
# kdesrc-build is not setup properly. You may be trying to install to a directory that you have no permissions to access for instance, or you may have specified a system qtdir that does not exist.
# The module may depend on a newer version of qt-copy or kdelibs (or other module). In this case you'll have to run kdesrc-build to update the out-of-date module first.

How do you find out what the error was? The output of the failing command will be in the log directory. By default, all log output is in the {{path|log}} subdirectory of the KDE SC source directory. The log directory is laid out like this: {{path|log/date-run/module/output-file.log}}. To simplify finding the appropriate file, there are a couple of symlinks created:

{{path|log/latest}} always has the debugging output for the last time kdesrc-build was run (--pretend doesn't count toward this)
{{path|log/latest/<module>/error.log}} has the debugging output for the command that caused a module build to fail.

For instance if qt-copy just failed to build you could read the output like this:

<code bash>
cd ~/kderc
kwrite log/latest/qt-copy/error.log
</code>

Replace kwrite with your preferred editor. Hopefully the output can guide you to resolving the problem. For instance, if the failure is a cmake output saying you're missing a library, install that library and try again. ;) For link errors you can try running a --refresh-build on the module (or if that doesn't work, required libraries like qt-copy and kdelibs).

If you're stumped by the error you may want to wait a day and try updating again, and hope that the reason for the error has been fixed. You can also try mailing the [http://www.kde.org/mailinglists/ kde-devel] mailing list to see if others know about the problem or have had similar issues.

== Running KDE ==

Assuming you got enough of the modules to build and install to have a working KDE installation, you'll still need to setup your environment correctly to run it. kdesrc-build doesn't help you out here (yet), but the instructions at [[../../Increased_Productivity_in_KDE4_with_Scripts/.bashrc|the .bashrc wiki page]] apply just as well, except that you'll need to set the environment variables to the settings that are in your ~/.kdesrc-buildrc.

For the KDEDIRS and KDEDIR variable use the setting of the "prefix" option (in the global section).
For the QTDIR variable use the setting of the "qtdir" option.

{{tip|When copying settings over to the .bashrc, change any ~'s in the paths to $HOME, as the ~ character is not expanded correctly in the .bashrc.}}

Once your .bashrc is setup logout and log back in again and then you should be able to run your new KDE installation.

== Keeping KDE up to date ==

Keeping your KDE installation up to date is as simple as running kdesrc-build again. Every kdesrc-build has these phases:

# Update the source code for all modules being built.
# Build and then install all the modules.

Old build directories are not deleted by default, so the build after a small update will not normally take as long as the initial build of a module. This is called "incremental make". However it may be necessary at times to perform a full rebuild due to inconsistencies between the build directory configuation and changes to the source directory. You can use the --refresh-build option to force a full rebuild.

For more information on how to take advantage of kdesrc-build, see the [http://kdesrc-build.kde.org/documentation online documentation] for kdesrc-build, which describes all of the module options and command line options available for kdesrc-build and gives tips on how to perform various useful tasks.

If you have any questions that are not answered please feel free to add them under the Discussion entry for this page and hopefully someone will be able to get the answer.

[[Category:Build_KDE]]
[[Category:Tutorial]]

User:Fulldecent

2010-08-30T17:52:46Z

Fulldecent: Created page with 'I am interested in compiling KDE SC on a stock ubuntu-server distribution in under 7 days, and then updating the documentation so that a new contributor to KDE can do this in und...'

Getting Started/Build/Distributions/Debian

2010-08-30T17:38:46Z

Fulldecent:

{{Template:I18n/Language Navigation Bar|Getting_Started/Build/KDE4/Kubuntu and Debian}}
This page details installation of KDE SC 4 build requirements on any recent Kubuntu or Debian. That is, if you want to build a basic functioning desktop, the recommended packages are installed with the commands on this page.

'''If Kubuntu doesn't have QT4.6 yet, you can get it adding this repository ppa:mapopa/qt4.6 istead compile kde-qt'''

== KDE 4.x ==
Install these for any KDE 4.x release, then add specific packages for point releases as below.
<code bash>
sudo aptitude install build-essential kde-devel xorg-dev cdbs debhelper cmake \
kdesdk-scripts subversion ssh xserver-xephyr doxygen dbus-x11 \
libxml2-dev libxslt1-dev shared-mime-info libical-dev libgif-dev libssl-dev \
libboost-dev libboost-program-options-dev libboost-graph-dev libgpgme11-dev libxine-dev \
libqimageblitz-dev libbz2-dev libdbus-1-dev libpam0g-dev libpcre3-dev \
libkrb5-dev libsm-dev libclucene0ldbl libclucene-dev libjpeg62-dev \
libxtst-dev xsltproc libxrender-dev libfontconfig1-dev automoc librdf0-dev \
libdbusmenu-qt-dev docbook-xsl docbook-xml libattica-dev libqt4-webkit-dev \
shared-desktop-ontologies libphonon-dev
</code>

Also, to enable XMMS support for the 'Now Playing' plasma data engine in kdebase, you will need to either compile XMMS from source, or install the package from a [http://www.pvv.ntnu.no/~knuta/xmms/ third-party XMMS package repository].

=== 4.6 ===
(Also known as trunk)
This (along with the command for 4.x above) install almost all compilation requirements for kde4 (with the exception of qt4) and some recommended packages such as libssl-dev for https support. Further recommended and optional packages are listed below.
<code bash>
sudo aptitude install graphviz libqt4-dev libstreamanalyzer-dev \
libstrigiqtdbusclient-dev libxml2-utils libopenexr-dev libjasper-dev libenchant-dev \
libavahi-common-dev libaspell-dev libasound2-dev libldap2-dev libsasl2-dev \
libsmbclient-dev libxkbfile-dev libxcb1-dev libxklavier-dev libxdamage-dev \
libxcomposite-dev libbluetooth-dev libusb-dev network-manager-dev libsmbclient-dev \
libsensors-dev libnm-util-dev libusb-dev libcfitsio3-dev libnova-dev libeigen2-dev \
libopenbabel-dev libfacile-ocaml-dev libboost-python-dev libsvn-dev libsvncpp-dev \
libqt4-dev libqca2-dev libstreamanalyzer-dev libstrigiqtdbusclient-dev \
libcommoncpp2-dev libidn11 libidn11-dev libpci-dev libxss-dev libxft-dev \
libpolkit-dbus-dev libpolkit-grant-dev libpolkit-dev git libpoppler-qt4-dev \
libspectre-dev
</code>

=== 4.5 ===
<code bash>
sudo aptitude install libv4l-dev # for kdenetworks
sudo aptitude install liblcms1-dev # for kdegraphics
</code>

=== 4.4 ===
(Nothing extra needed)

== kdelibs dependencies ==

Kdelibs dependencies can be installed with:
<code bash>
sudo aptitude install libqt4-dev dbus-x11 \
libstreamanalyzer-dev libstrigiqtdbusclient-dev \
libxml2-dev libxslt1-dev shared-mime-info libgif-dev libpcre3-dev \
libjpeg62-dev librdf0-dev libdbusmenu-qt-dev docbook-xsl docbook-xml \
libjasper-dev libopenexr-dev libacl1-dev
</code>

You may also need the automoc and libphonon-dev packages when compiling on *buntu:
<code bash>sudo aptitude install automoc libphonon-dev</code>

=== Recommended packages ===
* libssl-dev - Needed for https support etc.
* libbz2-dev - Needed for bzip support in kio_archive and GHNS packages.
* libpcre3-dev - regular expression library. Recommended for Javascript support.

<code bash>
sudo aptitude install libssl-dev libbz2-dev libpcre3-dev
</code>

=== Optional packages ===
* libasound2-dev - The Alsa sound system
* libaspell-dev - spell checking support (in kwrite etc)
* libavahi-common-dev - avahi/zeroconf service discovery
* libenchant-dev - spell checking wrapper library
* libjasper-dev - image processing library
* libopenexr-dev - image processing library
* libxml2-utils - used to validate generate doc files
<code bash>
sudo aptitude install libasound2-dev libaspell-dev \
libavahi-common-dev libenchant-dev libjasper-dev libopenexr-dev \
libxml2-utils
</code>

== kdepimlibs dependencies ==
kdepimlibs dependencies can be installed with:
<code bash>
sudo aptitude install libboost-dev libboost-program-options-dev libboost-graph-dev \
libgpgme11-dev libsasl2-dev
</code>

* libsasl2-dev - Required for imap and sieve kioslaves

If compiling on *buntu you may need libical-dev:
<code bash>
sudo aptitude install libical-dev
</code>

=== kdepimlibs recommended ===
* libldap2-dev - For ldap support in kde4.

<code bash>
sudo aptitude install libldap2-dev
</code>

== kdebase dependencies ==
kdebase-runtime dependencies can be installed with:
<code bash>
sudo aptitude install libxine-dev
</code>

kdebase-apps dependencies can be installed with:
<code bash>
sudo aptitude install libqimageblitz-dev
</code>

=== kdebase-apps optional ===
* libxcb1-dev - X C binding - Used for video widget support in xine
* libxkbfile-dev - keyboard configuration package
* libsmbclient-dev - for samba support in kde4

<code bash>
sudo aptitude install libsmbclient-dev libxkbfile-dev libxcb1-dev
</code>

=== kdebase-workspace optional ===
* libsmbclient-dev - for samba support in kde4
* network-manager-dev - Can be used by solid for network management
* libusb-dev - for usb support in solid
* libbluetooth-dev - for bluetooth support in solid
* libxcomposite-dev - for compositing support in kwin
* libxdamage-dev - for compositing support in kwin
* libxklavier-dev - virtual keyboard
* libsensors-dev - Support for hardware sensors (eg, temperature, fans)
* libpam0g-dev - Authentication module
* libnm-util-dev - needed to build solid with network manager
<code bash>
sudo aptitude install libxklavier-dev libxdamage-dev libxcomposite-dev \
libbluetooth-dev libusb-dev libcaptury-dev network-manager-dev \
libsmbclient-dev libsensors-dev libpam0g-dev libnm-util-dev
</code>

== kdegraphics ==
* libpoppler-qt4-dev - PDF support in Okular
* libspectre-dev - postscript support in Okular
* liblcms1-dev
* libexiv2-dev - to build Gwenview

== kdeedu ==
The following packages are recommended if you intend to use kstars:

* libfacile-ocaml-dev - used by kalzuim.
* libboost-python-dev - optional for kig.
* libreadline-dev - Gives kalgebra a console interface.
* libopenbabel-dev - used by kalzium.
* libeigen2-dev - used by kalzium.
* libusb-dev - Provides KStars INDI support.
* libcfitsio3-dev - Gives KStars support for FITS images.
* libnova-dev - A general purpose, double precision, Celestial Mechanics, Astrometry and Astrodynamics library for KStars.

<code bash>
sudo aptitude install libusb-dev libcfitsio3-dev libnova-dev libeigen2-dev \
libopenbabel-dev libfacile-ocaml-dev libboost-python-dev
</code>

== koffice ==
* libqca2-dev - qt cryptographic support.

== kdepim ==
* libqca2-dev - qt cryptographic support.

== kdenetwork ==
* libqca2-dev - qt cryptographic support. Used for jabber protocol.

== kdevplatform ==
* libsvn-dev
* libboost-serialization-dev

== kdevelop ==
* kdevplatform-dev
* kdebase-workspace-dev

Return to [[Getting_Started/Build/KDE4#kdelibs|building KDE 4]].

Getting Started/Build/Distributions/Debian

2010-08-30T17:36:18Z

Fulldecent: /* kdebase dependencies */

{{Template:I18n/Language Navigation Bar|Getting_Started/Build/KDE4/Kubuntu and Debian}}
This page details installation of kde4 requirements on any recent Kubuntu or Debian.

'''If Kubuntu doesn't have QT4.6 yet, you can get it adding this repository ppa:mapopa/qt4.6 istead compile kde-qt'''

To build a basic functioning desktop, the recommended packages are installed with the commands on this page.
== KDE 4.x ==
Install these for any KDE 4.x release, then add specific packages for point releases as below.
<code bash>
sudo aptitude install build-essential kde-devel xorg-dev cdbs debhelper cmake \
kdesdk-scripts subversion ssh xserver-xephyr doxygen dbus-x11 \
libxml2-dev libxslt1-dev shared-mime-info libical-dev libgif-dev libssl-dev \
libboost-dev libboost-program-options-dev libboost-graph-dev libgpgme11-dev libxine-dev \
libqimageblitz-dev libbz2-dev libdbus-1-dev libpam0g-dev libpcre3-dev \
libkrb5-dev libsm-dev libclucene0ldbl libclucene-dev libjpeg62-dev \
libxtst-dev xsltproc libxrender-dev libfontconfig1-dev automoc librdf0-dev \
libdbusmenu-qt-dev docbook-xsl docbook-xml libattica-dev libqt4-webkit-dev \
shared-desktop-ontologies libphonon-dev
</code>

Also, to enable XMMS support for the 'Now Playing' plasma data engine in kdebase, you will need to either compile XMMS from source, or install the package from a [http://www.pvv.ntnu.no/~knuta/xmms/ third-party XMMS package repository].

=== 4.6 ===
(Also known as trunk)
This (along with the command for 4.x above) install almost all compilation requirements for kde4 (with the exception of qt4) and some recommended packages such as libssl-dev for https support. Further recommended and optional packages are listed below.
<code bash>
sudo aptitude install graphviz libqt4-dev libstreamanalyzer-dev \
libstrigiqtdbusclient-dev libxml2-utils libopenexr-dev libjasper-dev libenchant-dev \
libavahi-common-dev libaspell-dev libasound2-dev libldap2-dev libsasl2-dev \
libsmbclient-dev libxkbfile-dev libxcb1-dev libxklavier-dev libxdamage-dev \
libxcomposite-dev libbluetooth-dev libusb-dev network-manager-dev libsmbclient-dev \
libsensors-dev libnm-util-dev libusb-dev libcfitsio3-dev libnova-dev libeigen2-dev \
libopenbabel-dev libfacile-ocaml-dev libboost-python-dev libsvn-dev libsvncpp-dev \
libqt4-dev libqca2-dev libstreamanalyzer-dev libstrigiqtdbusclient-dev \
libcommoncpp2-dev libidn11 libidn11-dev libpci-dev libxss-dev libxft-dev \
libpolkit-dbus-dev libpolkit-grant-dev libpolkit-dev git libpoppler-qt4-dev \
libspectre-dev
</code>

=== 4.5 ===
<code bash>
sudo aptitude install libv4l-dev # for kdenetworks
sudo aptitude install liblcms1-dev # for kdegraphics
</code>

=== 4.4 ===
(Nothing extra needed)

== kdelibs dependencies ==

Kdelibs dependencies can be installed with:
<code bash>
sudo aptitude install libqt4-dev dbus-x11 \
libstreamanalyzer-dev libstrigiqtdbusclient-dev \
libxml2-dev libxslt1-dev shared-mime-info libgif-dev libpcre3-dev \
libjpeg62-dev librdf0-dev libdbusmenu-qt-dev docbook-xsl docbook-xml \
libjasper-dev libopenexr-dev libacl1-dev
</code>

You may also need the automoc and libphonon-dev packages when compiling on *buntu:
<code bash>sudo aptitude install automoc libphonon-dev</code>

=== Recommended packages ===
* libssl-dev - Needed for https support etc.
* libbz2-dev - Needed for bzip support in kio_archive and GHNS packages.
* libpcre3-dev - regular expression library. Recommended for Javascript support.

<code bash>
sudo aptitude install libssl-dev libbz2-dev libpcre3-dev
</code>

=== Optional packages ===
* libasound2-dev - The Alsa sound system
* libaspell-dev - spell checking support (in kwrite etc)
* libavahi-common-dev - avahi/zeroconf service discovery
* libenchant-dev - spell checking wrapper library
* libjasper-dev - image processing library
* libopenexr-dev - image processing library
* libxml2-utils - used to validate generate doc files
<code bash>
sudo aptitude install libasound2-dev libaspell-dev \
libavahi-common-dev libenchant-dev libjasper-dev libopenexr-dev \
libxml2-utils
</code>

== kdepimlibs dependencies ==
kdepimlibs dependencies can be installed with:
<code bash>
sudo aptitude install libboost-dev libboost-program-options-dev libboost-graph-dev \
libgpgme11-dev libsasl2-dev
</code>

* libsasl2-dev - Required for imap and sieve kioslaves

If compiling on *buntu you may need libical-dev:
<code bash>
sudo aptitude install libical-dev
</code>

=== kdepimlibs recommended ===
* libldap2-dev - For ldap support in kde4.

<code bash>
sudo aptitude install libldap2-dev
</code>

== kdebase dependencies ==
kdebase-runtime dependencies can be installed with:
<code bash>
sudo aptitude install libxine-dev
</code>

kdebase-apps dependencies can be installed with:
<code bash>
sudo aptitude install libqimageblitz-dev
</code>

=== kdebase-apps optional ===
* libxcb1-dev - X C binding - Used for video widget support in xine
* libxkbfile-dev - keyboard configuration package
* libsmbclient-dev - for samba support in kde4

<code bash>
sudo aptitude install libsmbclient-dev libxkbfile-dev libxcb1-dev
</code>

=== kdebase-workspace optional ===
* libsmbclient-dev - for samba support in kde4
* network-manager-dev - Can be used by solid for network management
* libusb-dev - for usb support in solid
* libbluetooth-dev - for bluetooth support in solid
* libxcomposite-dev - for compositing support in kwin
* libxdamage-dev - for compositing support in kwin
* libxklavier-dev - virtual keyboard
* libsensors-dev - Support for hardware sensors (eg, temperature, fans)
* libpam0g-dev - Authentication module
* libnm-util-dev - needed to build solid with network manager
<code bash>
sudo aptitude install libxklavier-dev libxdamage-dev libxcomposite-dev \
libbluetooth-dev libusb-dev libcaptury-dev network-manager-dev \
libsmbclient-dev libsensors-dev libpam0g-dev libnm-util-dev
</code>

== kdegraphics ==
* libpoppler-qt4-dev - PDF support in Okular
* libspectre-dev - postscript support in Okular
* liblcms1-dev
* libexiv2-dev - to build Gwenview

== kdeedu ==
The following packages are recommended if you intend to use kstars:

* libfacile-ocaml-dev - used by kalzuim.
* libboost-python-dev - optional for kig.
* libreadline-dev - Gives kalgebra a console interface.
* libopenbabel-dev - used by kalzium.
* libeigen2-dev - used by kalzium.
* libusb-dev - Provides KStars INDI support.
* libcfitsio3-dev - Gives KStars support for FITS images.
* libnova-dev - A general purpose, double precision, Celestial Mechanics, Astrometry and Astrodynamics library for KStars.

<code bash>
sudo aptitude install libusb-dev libcfitsio3-dev libnova-dev libeigen2-dev \
libopenbabel-dev libfacile-ocaml-dev libboost-python-dev
</code>

== koffice ==
* libqca2-dev - qt cryptographic support.

== kdepim ==
* libqca2-dev - qt cryptographic support.

== kdenetwork ==
* libqca2-dev - qt cryptographic support. Used for jabber protocol.

== kdevplatform ==
* libsvn-dev
* libboost-serialization-dev

== kdevelop ==
* kdevplatform-dev
* kdebase-workspace-dev

Return to [[Getting_Started/Build/KDE4#kdelibs|building KDE 4]].

Getting Started/Build/Distributions/Debian

2010-08-30T17:34:46Z

Fulldecent:

{{Template:I18n/Language Navigation Bar|Getting_Started/Build/KDE4/Kubuntu and Debian}}
This page details installation of kde4 requirements on any recent Kubuntu or Debian.

'''If Kubuntu doesn't have QT4.6 yet, you can get it adding this repository ppa:mapopa/qt4.6 istead compile kde-qt'''

To build a basic functioning desktop, the recommended packages are installed with the commands on this page.
== KDE 4.x ==
Install these for any KDE 4.x release, then add specific packages for point releases as below.
<code bash>
sudo aptitude install build-essential kde-devel xorg-dev cdbs debhelper cmake \
kdesdk-scripts subversion ssh xserver-xephyr doxygen dbus-x11 \
libxml2-dev libxslt1-dev shared-mime-info libical-dev libgif-dev libssl-dev \
libboost-dev libboost-program-options-dev libboost-graph-dev libgpgme11-dev libxine-dev \
libqimageblitz-dev libbz2-dev libdbus-1-dev libpam0g-dev libpcre3-dev \
libkrb5-dev libsm-dev libclucene0ldbl libclucene-dev libjpeg62-dev \
libxtst-dev xsltproc libxrender-dev libfontconfig1-dev automoc librdf0-dev \
libdbusmenu-qt-dev docbook-xsl docbook-xml libattica-dev libqt4-webkit-dev \
shared-desktop-ontologies libphonon-dev
</code>

Also, to enable XMMS support for the 'Now Playing' plasma data engine in kdebase, you will need to either compile XMMS from source, or install the package from a [http://www.pvv.ntnu.no/~knuta/xmms/ third-party XMMS package repository].

=== 4.6 ===
(Also known as trunk)
This (along with the command for 4.x above) install almost all compilation requirements for kde4 (with the exception of qt4) and some recommended packages such as libssl-dev for https support. Further recommended and optional packages are listed below.
<code bash>
sudo aptitude install graphviz libqt4-dev libstreamanalyzer-dev \
libstrigiqtdbusclient-dev libxml2-utils libopenexr-dev libjasper-dev libenchant-dev \
libavahi-common-dev libaspell-dev libasound2-dev libldap2-dev libsasl2-dev \
libsmbclient-dev libxkbfile-dev libxcb1-dev libxklavier-dev libxdamage-dev \
libxcomposite-dev libbluetooth-dev libusb-dev network-manager-dev libsmbclient-dev \
libsensors-dev libnm-util-dev libusb-dev libcfitsio3-dev libnova-dev libeigen2-dev \
libopenbabel-dev libfacile-ocaml-dev libboost-python-dev libsvn-dev libsvncpp-dev \
libqt4-dev libqca2-dev libstreamanalyzer-dev libstrigiqtdbusclient-dev \
libcommoncpp2-dev libidn11 libidn11-dev libpci-dev libxss-dev libxft-dev \
libpolkit-dbus-dev libpolkit-grant-dev libpolkit-dev git libpoppler-qt4-dev \
libspectre-dev
</code>

=== 4.5 ===
<code bash>
sudo aptitude install libv4l-dev # for kdenetworks
sudo aptitude install liblcms1-dev # for kdegraphics
</code>

=== 4.4 ===
(Nothing extra needed)

== kdelibs dependencies ==

Kdelibs dependencies can be installed with:
<code bash>
sudo aptitude install libqt4-dev dbus-x11 \
libstreamanalyzer-dev libstrigiqtdbusclient-dev \
libxml2-dev libxslt1-dev shared-mime-info libgif-dev libpcre3-dev \
libjpeg62-dev librdf0-dev libdbusmenu-qt-dev docbook-xsl docbook-xml \
libjasper-dev libopenexr-dev libacl1-dev
</code>

You may also need the automoc and libphonon-dev packages when compiling on *buntu:
<code bash>sudo aptitude install automoc libphonon-dev</code>

=== Recommended packages ===
* libssl-dev - Needed for https support etc.
* libbz2-dev - Needed for bzip support in kio_archive and GHNS packages.
* libpcre3-dev - regular expression library. Recommended for Javascript support.

<code bash>
sudo aptitude install libssl-dev libbz2-dev libpcre3-dev
</code>

=== Optional packages ===
* libasound2-dev - The Alsa sound system
* libaspell-dev - spell checking support (in kwrite etc)
* libavahi-common-dev - avahi/zeroconf service discovery
* libenchant-dev - spell checking wrapper library
* libjasper-dev - image processing library
* libopenexr-dev - image processing library
* libxml2-utils - used to validate generate doc files
<code bash>
sudo aptitude install libasound2-dev libaspell-dev \
libavahi-common-dev libenchant-dev libjasper-dev libopenexr-dev \
libxml2-utils
</code>

== kdepimlibs dependencies ==
kdepimlibs dependencies can be installed with:
<code bash>
sudo aptitude install libboost-dev libboost-program-options-dev libboost-graph-dev \
libgpgme11-dev libsasl2-dev
</code>

* libsasl2-dev - Required for imap and sieve kioslaves

If compiling on *buntu you may need libical-dev:
<code bash>
sudo aptitude install libical-dev
</code>

=== kdepimlibs recommended ===
* libldap2-dev - For ldap support in kde4.

<code bash>
sudo aptitude install libldap2-dev
</code>

== kdebase dependencies ==
kdebase-runtime dependencies can be installed with:
<code bash>
sudo aptitude install libxine-dev
</code>

{{Note|Note that libxine1-dev depends on gnome packages due to a kubuntu gutsy packaging bug (fixed in hardy). Also kubuntu packages xinelib version 1.1.8, which has trouble playing short sounds (fixed in xinelib 1.1.9).
}}

kdebase-apps dependencies can be installed with:
<code bash>
sudo aptitude install libqimageblitz-dev
</code>

=== kdebase-apps optional ===
* libxcb1-dev - X C binding - Used for video widget support in xine
* libxkbfile-dev - keyboard configuration package
* libsmbclient-dev - for samba support in kde4

<code bash>
sudo aptitude install libsmbclient-dev libxkbfile-dev libxcb1-dev
</code>

=== kdebase-workspace optional ===
* libsmbclient-dev - for samba support in kde4
* network-manager-dev - Can be used by solid for network management
* libusb-dev - for usb support in solid
* libbluetooth-dev - for bluetooth support in solid
* libxcomposite-dev - for compositing support in kwin
* libxdamage-dev - for compositing support in kwin
* libxklavier-dev - virtual keyboard
* libsensors-dev - Support for hardware sensors (eg, temperature, fans)
* libpam0g-dev - Authentication module
* libnm-util-dev - needed to build solid with network manager
<code bash>
sudo aptitude install libxklavier-dev libxdamage-dev libxcomposite-dev \
libbluetooth-dev libusb-dev libcaptury-dev network-manager-dev \
libsmbclient-dev libsensors-dev libpam0g-dev libnm-util-dev
</code>

== kdegraphics ==
* libpoppler-qt4-dev - PDF support in Okular
* libspectre-dev - postscript support in Okular
* liblcms1-dev
* libexiv2-dev - to build Gwenview

== kdeedu ==
The following packages are recommended if you intend to use kstars:

* libfacile-ocaml-dev - used by kalzuim.
* libboost-python-dev - optional for kig.
* libreadline-dev - Gives kalgebra a console interface.
* libopenbabel-dev - used by kalzium.
* libeigen2-dev - used by kalzium.
* libusb-dev - Provides KStars INDI support.
* libcfitsio3-dev - Gives KStars support for FITS images.
* libnova-dev - A general purpose, double precision, Celestial Mechanics, Astrometry and Astrodynamics library for KStars.

<code bash>
sudo aptitude install libusb-dev libcfitsio3-dev libnova-dev libeigen2-dev \
libopenbabel-dev libfacile-ocaml-dev libboost-python-dev
</code>

== koffice ==
* libqca2-dev - qt cryptographic support.

== kdepim ==
* libqca2-dev - qt cryptographic support.

== kdenetwork ==
* libqca2-dev - qt cryptographic support. Used for jabber protocol.

== kdevplatform ==
* libsvn-dev
* libboost-serialization-dev

== kdevelop ==
* kdevplatform-dev
* kdebase-workspace-dev

Return to [[Getting_Started/Build/KDE4#kdelibs|building KDE 4]].

Getting Started/Build/Distributions/Debian

2010-08-30T17:33:35Z

Fulldecent:

{{Template:I18n/Language Navigation Bar|Getting_Started/Build/KDE4/Kubuntu and Debian}}
This page details installation of kde4 requirements on any recent Kubuntu or Debian.

'''If Kubuntu doesn't have QT4.6 yet, you can get it adding this repository ppa:mapopa/qt4.6 istead compile kde-qt'''

To build a basic functioning desktop, the recommended packages are installed with the commands on this page.
== KDE 4.x ==
Install these for any KDE 4.x release, then add specific packages for point releases as below.
<code bash>
sudo aptitude install build-essential kde-devel xorg-dev cdbs debhelper cmake \
kdesdk-scripts subversion ssh xserver-xephyr doxygen dbus-x11 \
libxml2-dev libxslt1-dev shared-mime-info libical-dev libgif-dev libssl-dev \
libboost-dev libboost-program-options-dev libboost-graph-dev libgpgme11-dev libxine-dev \
libqimageblitz-dev libbz2-dev libdbus-1-dev libpam0g-dev libpcre3-dev \
libkrb5-dev libsm-dev libclucene0ldbl libclucene-dev libjpeg62-dev \
libxtst-dev xsltproc libxrender-dev libfontconfig1-dev automoc librdf0-dev \
libdbusmenu-qt-dev docbook-xsl docbook-xml libattica-dev libqt4-webkit-dev \
shared-desktop-ontologies libphonon-dev
</code>

Also, to enable XMMS support for the 'Now Playing' plasma data engine in kdebase, you will need to either compile XMMS from source, or install the package from a [http://www.pvv.ntnu.no/~knuta/xmms/ third-party XMMS package repository].

=== 4.6 ===
(Also known as trunk)
This (along with the command for 4.x above) install almost all compilation requirements for kde4 (with the exception of qt4) and some recommended packages such as libssl-dev for https support. Further recommended and optional packages are listed below.
<code bash>
sudo aptitude install graphviz libqt4-dev libstreamanalyzer-dev \
libstrigiqtdbusclient-dev libxml2-utils libopenexr-dev libjasper-dev libenchant-dev \
libavahi-common-dev libaspell-dev libasound2-dev libldap2-dev libsasl2-dev \
libsmbclient-dev libxkbfile-dev libxcb1-dev libxklavier-dev libxdamage-dev \
libxcomposite-dev libbluetooth-dev libusb-dev network-manager-dev libsmbclient-dev \
libsensors-dev libnm-util-dev libusb-dev libcfitsio3-dev libnova-dev libeigen2-dev \
libopenbabel-dev libfacile-ocaml-dev libboost-python-dev libsvn-dev libsvncpp-dev \
libqt4-dev libqca2-dev libstreamanalyzer-dev libstrigiqtdbusclient-dev \
libcommoncpp2-dev libidn11 libidn11-dev libpci-dev libxss-dev libxft-dev \
libpolkit-dbus-dev libpolkit-grant-dev libpolkit-dev git libpoppler-qt4-dev \
libspectre-dev
</code>

=== 4.5 ===
<code bash>
sudo aptitude install libv4l-dev # for kdenetworks
sudo aptitude install liblcms1-dev # for kdegraphics
</code>

=== 4.4 ===
(Nothing extra needed)

== Build prerequisites ==
In Kubuntu and Debian (Testing/Unstable) the build prerequisites are installed with:

<code bash>
sudo aptitude install build-essential cdbs debhelper cmake \
kdesdk-scripts subversion ssh xserver-xephyr
</code>

Optional packages for API documentation generation:
<code bash>
sudo aptitude install doxygen graphviz
</code>

== kdelibs dependencies ==

Kdelibs dependencies can be installed with:
<code bash>
sudo aptitude install libqt4-dev dbus-x11 \
libstreamanalyzer-dev libstrigiqtdbusclient-dev \
libxml2-dev libxslt1-dev shared-mime-info libgif-dev libpcre3-dev \
libjpeg62-dev librdf0-dev libdbusmenu-qt-dev docbook-xsl docbook-xml \
libjasper-dev libopenexr-dev libacl1-dev
</code>

You may also need the automoc and libphonon-dev packages when compiling on *buntu:
<code bash>sudo aptitude install automoc libphonon-dev</code>

=== Recommended packages ===
* libssl-dev - Needed for https support etc.
* libbz2-dev - Needed for bzip support in kio_archive and GHNS packages.
* libpcre3-dev - regular expression library. Recommended for Javascript support.

<code bash>
sudo aptitude install libssl-dev libbz2-dev libpcre3-dev
</code>

=== Optional packages ===
* libasound2-dev - The Alsa sound system
* libaspell-dev - spell checking support (in kwrite etc)
* libavahi-common-dev - avahi/zeroconf service discovery
* libenchant-dev - spell checking wrapper library
* libjasper-dev - image processing library
* libopenexr-dev - image processing library
* libxml2-utils - used to validate generate doc files
<code bash>
sudo aptitude install libasound2-dev libaspell-dev \
libavahi-common-dev libenchant-dev libjasper-dev libopenexr-dev \
libxml2-utils
</code>

== kdepimlibs dependencies ==
kdepimlibs dependencies can be installed with:
<code bash>
sudo aptitude install libboost-dev libboost-program-options-dev libboost-graph-dev \
libgpgme11-dev libsasl2-dev
</code>

* libsasl2-dev - Required for imap and sieve kioslaves

If compiling on *buntu you may need libical-dev:
<code bash>
sudo aptitude install libical-dev
</code>

=== kdepimlibs recommended ===
* libldap2-dev - For ldap support in kde4.

<code bash>
sudo aptitude install libldap2-dev
</code>

== kdebase dependencies ==
kdebase-runtime dependencies can be installed with:
<code bash>
sudo aptitude install libxine-dev
</code>

{{Note|Note that libxine1-dev depends on gnome packages due to a kubuntu gutsy packaging bug (fixed in hardy). Also kubuntu packages xinelib version 1.1.8, which has trouble playing short sounds (fixed in xinelib 1.1.9).
}}

kdebase-apps dependencies can be installed with:
<code bash>
sudo aptitude install libqimageblitz-dev
</code>

=== kdebase-apps optional ===
* libxcb1-dev - X C binding - Used for video widget support in xine
* libxkbfile-dev - keyboard configuration package
* libsmbclient-dev - for samba support in kde4

<code bash>
sudo aptitude install libsmbclient-dev libxkbfile-dev libxcb1-dev
</code>

=== kdebase-workspace optional ===
* libsmbclient-dev - for samba support in kde4
* network-manager-dev - Can be used by solid for network management
* libusb-dev - for usb support in solid
* libbluetooth-dev - for bluetooth support in solid
* libxcomposite-dev - for compositing support in kwin
* libxdamage-dev - for compositing support in kwin
* libxklavier-dev - virtual keyboard
* libsensors-dev - Support for hardware sensors (eg, temperature, fans)
* libpam0g-dev - Authentication module
* libnm-util-dev - needed to build solid with network manager
<code bash>
sudo aptitude install libxklavier-dev libxdamage-dev libxcomposite-dev \
libbluetooth-dev libusb-dev libcaptury-dev network-manager-dev \
libsmbclient-dev libsensors-dev libpam0g-dev libnm-util-dev
</code>

== kdegraphics ==
* libpoppler-qt4-dev - PDF support in Okular
* libspectre-dev - postscript support in Okular
* liblcms1-dev
* libexiv2-dev - to build Gwenview

== kdeedu ==
The following packages are recommended if you intend to use kstars:

* libfacile-ocaml-dev - used by kalzuim.
* libboost-python-dev - optional for kig.
* libreadline-dev - Gives kalgebra a console interface.
* libopenbabel-dev - used by kalzium.
* libeigen2-dev - used by kalzium.
* libusb-dev - Provides KStars INDI support.
* libcfitsio3-dev - Gives KStars support for FITS images.
* libnova-dev - A general purpose, double precision, Celestial Mechanics, Astrometry and Astrodynamics library for KStars.

<code bash>
sudo aptitude install libusb-dev libcfitsio3-dev libnova-dev libeigen2-dev \
libopenbabel-dev libfacile-ocaml-dev libboost-python-dev
</code>

== koffice ==
* libqca2-dev - qt cryptographic support.

== kdepim ==
* libqca2-dev - qt cryptographic support.

== kdenetwork ==
* libqca2-dev - qt cryptographic support. Used for jabber protocol.

== kdevplatform ==
* libsvn-dev
* libboost-serialization-dev

== kdevelop ==
* kdevplatform-dev
* kdebase-workspace-dev

Return to [[Getting_Started/Build/KDE4#kdelibs|building KDE 4]].

Getting Started/Build/Distributions/Debian

2010-08-30T17:31:53Z

Fulldecent: /* 4.6 */

{{Template:I18n/Language Navigation Bar|Getting_Started/Build/KDE4/Kubuntu and Debian}}
This page details installation of kde4 requirements on any recent Kubuntu or Debian.

'''If Kubuntu doesn't have QT4.6 yet, you can get it adding this repository ppa:mapopa/qt4.6 istead compile kde-qt'''

To build a basic functioning desktop, the recommended packages are installed with the commands on this page.
== KDE 4.x ==
Install these for any KDE 4.x release, then add specific packages for point releases as below.
<code bash>
sudo aptitude install build-essential kde-devel xorg-dev cdbs debhelper cmake \
kdesdk-scripts subversion ssh xserver-xephyr doxygen dbus-x11 \
libxml2-dev libxslt1-dev shared-mime-info libical-dev libgif-dev libssl-dev \
libboost-dev libboost-program-options-dev libboost-graph-dev libgpgme11-dev libxine-dev \
libqimageblitz-dev libbz2-dev libdbus-1-dev libpam0g-dev libpcre3-dev \
libkrb5-dev libsm-dev libclucene0ldbl libclucene-dev libjpeg62-dev \
libxtst-dev xsltproc libxrender-dev libfontconfig1-dev automoc librdf0-dev \
libdbusmenu-qt-dev docbook-xsl docbook-xml libattica-dev libqt4-webkit-dev \
shared-desktop-ontologies libphonon-dev
</code>

=== 4.6 ===
(Also known as trunk)
This (along with the command for 4.x above) install almost all compilation requirements for kde4 (with the exception of qt4) and some recommended packages such as libssl-dev for https support. Further recommended and optional packages are listed below.
<code bash>
sudo aptitude install graphviz libqt4-dev libstreamanalyzer-dev \
libstrigiqtdbusclient-dev libxml2-utils libopenexr-dev libjasper-dev libenchant-dev \
libavahi-common-dev libaspell-dev libasound2-dev libldap2-dev libsasl2-dev \
libsmbclient-dev libxkbfile-dev libxcb1-dev libxklavier-dev libxdamage-dev \
libxcomposite-dev libbluetooth-dev libusb-dev network-manager-dev libsmbclient-dev \
libsensors-dev libnm-util-dev libusb-dev libcfitsio3-dev libnova-dev libeigen2-dev \
libopenbabel-dev libfacile-ocaml-dev libboost-python-dev libsvn-dev libsvncpp-dev \
libqt4-dev libqca2-dev libstreamanalyzer-dev libstrigiqtdbusclient-dev \
libcommoncpp2-dev libidn11 libidn11-dev libpci-dev libxss-dev libxft-dev \
libpolkit-dbus-dev libpolkit-grant-dev libpolkit-dev git libpoppler-qt4-dev \
libspectre-dev
</code>

=== 4.5 ===
<code bash>
sudo aptitude install libv4l-dev # for kdenetworks
sudo aptitude install liblcms1-dev # for kdegraphics
</code>

=== 4.4 ===
(Nothing extra needed)

== More Trunk and unsorted ==
****I moved libstreamanalyzer-dev libstrigiqtdbusclient-dev to the section below since that pulls in qt4.

This installs build prerequisites such as build essential, almost all compilation requirements for kde4 (with the exception of qt4) and some recommended packages such as libssl-dev for https support. Further recommended and optional packages are listed below.

To install all the optional packages:

<code bash>
sudo aptitude install build-essential kde-devel xorg-dev cdbs debhelper cmake \
kdesdk-scripts subversion ssh xserver-xephyr doxygen graphviz libqt4-dev \
dbus-x11 libdbus-1-dev libstreamanalyzer-dev libstrigiqtdbusclient-dev \
libxml2-dev libxslt1-dev shared-mime-info libgif-dev libpcre3-dev \
libclucene0ldbl libclucene-dev libjpeg62-dev libkrb5-dev libsm-dev \
libssl-dev libbz2-dev libical-dev libxml2-utils libopenexr-dev \
libjasper-dev libenchant-dev libavahi-common-dev libaspell-dev \
libasound2-dev libboost-dev libboost-program-options-dev libboost-graph-dev libgpgme11-dev \
libldap2-dev libsasl2-dev libxine-dev libqimageblitz-dev libsmbclient-dev \
libxkbfile-dev libxcb1-dev libxklavier-dev libxdamage-dev \
libxcomposite-dev libbluetooth-dev libusb-dev \
network-manager-dev libsmbclient-dev libsensors-dev \
libpam0g-dev libnm-util-dev libusb-dev libcfitsio3-dev libnova-dev \
libeigen2-dev libopenbabel-dev libfacile-ocaml-dev libboost-python-dev \
libsvn-dev libsvncpp-dev libqt4-dev libqca2-dev \
libstreamanalyzer-dev libstrigiqtdbusclient-dev \
libcommoncpp2-dev libidn11 libidn11-dev libxtst-dev librdf0-dev xsltproc \
libxrender-dev libfontconfig1-dev libpci-dev libxss-dev libxft-dev \
libpolkit-dbus-dev libpolkit-grant-dev libpolkit-dev git \
libpoppler-qt4-dev libspectre-dev libdbusmenu-qt-dev docbook-xsl docbook-xml \
libqt4-webkit-dev shared-desktop-ontologies</code>

Also, to enable XMMS support for the 'Now Playing' plasma data engine in kdebase, you will need to either compile XMMS from source, or install the package from a [http://www.pvv.ntnu.no/~knuta/xmms/ third-party XMMS package repository].

== Build prerequisites ==
In Kubuntu and Debian (Testing/Unstable) the build prerequisites are installed with:

<code bash>
sudo aptitude install build-essential cdbs debhelper cmake \
kdesdk-scripts subversion ssh xserver-xephyr
</code>

Optional packages for API documentation generation:
<code bash>
sudo aptitude install doxygen graphviz
</code>

== kdelibs dependencies ==

Kdelibs dependencies can be installed with:
<code bash>
sudo aptitude install libqt4-dev dbus-x11 \
libstreamanalyzer-dev libstrigiqtdbusclient-dev \
libxml2-dev libxslt1-dev shared-mime-info libgif-dev libpcre3-dev \
libjpeg62-dev librdf0-dev libdbusmenu-qt-dev docbook-xsl docbook-xml \
libjasper-dev libopenexr-dev libacl1-dev
</code>

You may also need the automoc and libphonon-dev packages when compiling on *buntu:
<code bash>sudo aptitude install automoc libphonon-dev</code>

=== Recommended packages ===
* libssl-dev - Needed for https support etc.
* libbz2-dev - Needed for bzip support in kio_archive and GHNS packages.
* libpcre3-dev - regular expression library. Recommended for Javascript support.

<code bash>
sudo aptitude install libssl-dev libbz2-dev libpcre3-dev
</code>

=== Optional packages ===
* libasound2-dev - The Alsa sound system
* libaspell-dev - spell checking support (in kwrite etc)
* libavahi-common-dev - avahi/zeroconf service discovery
* libenchant-dev - spell checking wrapper library
* libjasper-dev - image processing library
* libopenexr-dev - image processing library
* libxml2-utils - used to validate generate doc files
<code bash>
sudo aptitude install libasound2-dev libaspell-dev \
libavahi-common-dev libenchant-dev libjasper-dev libopenexr-dev \
libxml2-utils
</code>

== kdepimlibs dependencies ==
kdepimlibs dependencies can be installed with:
<code bash>
sudo aptitude install libboost-dev libboost-program-options-dev libboost-graph-dev \
libgpgme11-dev libsasl2-dev
</code>

* libsasl2-dev - Required for imap and sieve kioslaves

If compiling on *buntu you may need libical-dev:
<code bash>
sudo aptitude install libical-dev
</code>

=== kdepimlibs recommended ===
* libldap2-dev - For ldap support in kde4.

<code bash>
sudo aptitude install libldap2-dev
</code>

== kdebase dependencies ==
kdebase-runtime dependencies can be installed with:
<code bash>
sudo aptitude install libxine-dev
</code>

{{Note|Note that libxine1-dev depends on gnome packages due to a kubuntu gutsy packaging bug (fixed in hardy). Also kubuntu packages xinelib version 1.1.8, which has trouble playing short sounds (fixed in xinelib 1.1.9).
}}

kdebase-apps dependencies can be installed with:
<code bash>
sudo aptitude install libqimageblitz-dev
</code>

=== kdebase-apps optional ===
* libxcb1-dev - X C binding - Used for video widget support in xine
* libxkbfile-dev - keyboard configuration package
* libsmbclient-dev - for samba support in kde4

<code bash>
sudo aptitude install libsmbclient-dev libxkbfile-dev libxcb1-dev
</code>

=== kdebase-workspace optional ===
* libsmbclient-dev - for samba support in kde4
* network-manager-dev - Can be used by solid for network management
* libusb-dev - for usb support in solid
* libbluetooth-dev - for bluetooth support in solid
* libxcomposite-dev - for compositing support in kwin
* libxdamage-dev - for compositing support in kwin
* libxklavier-dev - virtual keyboard
* libsensors-dev - Support for hardware sensors (eg, temperature, fans)
* libpam0g-dev - Authentication module
* libnm-util-dev - needed to build solid with network manager
<code bash>
sudo aptitude install libxklavier-dev libxdamage-dev libxcomposite-dev \
libbluetooth-dev libusb-dev libcaptury-dev network-manager-dev \
libsmbclient-dev libsensors-dev libpam0g-dev libnm-util-dev
</code>

== kdegraphics ==
* libpoppler-qt4-dev - PDF support in Okular
* libspectre-dev - postscript support in Okular
* liblcms1-dev
* libexiv2-dev - to build Gwenview

== kdeedu ==
The following packages are recommended if you intend to use kstars:

* libfacile-ocaml-dev - used by kalzuim.
* libboost-python-dev - optional for kig.
* libreadline-dev - Gives kalgebra a console interface.
* libopenbabel-dev - used by kalzium.
* libeigen2-dev - used by kalzium.
* libusb-dev - Provides KStars INDI support.
* libcfitsio3-dev - Gives KStars support for FITS images.
* libnova-dev - A general purpose, double precision, Celestial Mechanics, Astrometry and Astrodynamics library for KStars.

<code bash>
sudo aptitude install libusb-dev libcfitsio3-dev libnova-dev libeigen2-dev \
libopenbabel-dev libfacile-ocaml-dev libboost-python-dev
</code>

== koffice ==
* libqca2-dev - qt cryptographic support.

== kdepim ==
* libqca2-dev - qt cryptographic support.

== kdenetwork ==
* libqca2-dev - qt cryptographic support. Used for jabber protocol.

== kdevplatform ==
* libsvn-dev
* libboost-serialization-dev

== kdevelop ==
* kdevplatform-dev
* kdebase-workspace-dev

Return to [[Getting_Started/Build/KDE4#kdelibs|building KDE 4]].

Getting Started/Build/Distributions/Debian

2010-08-30T17:23:32Z

Fulldecent:

{{Template:I18n/Language Navigation Bar|Getting_Started/Build/KDE4/Kubuntu and Debian}}
This page details installation of kde4 requirements on any recent Kubuntu or Debian.

'''If Kubuntu doesn't have QT4.6 yet, you can get it adding this repository ppa:mapopa/qt4.6 istead compile kde-qt'''

To build a basic functioning desktop, the recommended packages are installed with the commands on this page.
== KDE 4.x ==
Install these for any KDE 4.x release, then add specific packages for point releases as below.
<code bash>
sudo aptitude install build-essential kde-devel xorg-dev cdbs debhelper cmake \
kdesdk-scripts subversion ssh xserver-xephyr doxygen dbus-x11 \
libxml2-dev libxslt1-dev shared-mime-info libical-dev libgif-dev libssl-dev \
libboost-dev libboost-program-options-dev libboost-graph-dev libgpgme11-dev libxine-dev \
libqimageblitz-dev libbz2-dev libdbus-1-dev libpam0g-dev libpcre3-dev \
libkrb5-dev libsm-dev libclucene0ldbl libclucene-dev libjpeg62-dev \
libxtst-dev xsltproc libxrender-dev libfontconfig1-dev automoc librdf0-dev \
libdbusmenu-qt-dev docbook-xsl docbook-xml libattica-dev libqt4-webkit-dev \
shared-desktop-ontologies libphonon-dev
</code>

=== 4.6 ===
(Also known as trunk)
No extra packages for trunk at this time

=== 4.5 ===
<code bash>
sudo aptitude install libv4l-dev # for kdenetworks
sudo aptitude install liblcms1-dev # for kdegraphics
</code>

=== 4.4 ===
(Nothing extra needed)

== More Trunk and unsorted ==
****I moved libstreamanalyzer-dev libstrigiqtdbusclient-dev to the section below since that pulls in qt4.

This installs build prerequisites such as build essential, almost all compilation requirements for kde4 (with the exception of qt4) and some recommended packages such as libssl-dev for https support. Further recommended and optional packages are listed below.

To install all the optional packages:

<code bash>
sudo aptitude install build-essential kde-devel xorg-dev cdbs debhelper cmake \
kdesdk-scripts subversion ssh xserver-xephyr doxygen graphviz libqt4-dev \
dbus-x11 libdbus-1-dev libstreamanalyzer-dev libstrigiqtdbusclient-dev \
libxml2-dev libxslt1-dev shared-mime-info libgif-dev libpcre3-dev \
libclucene0ldbl libclucene-dev libjpeg62-dev libkrb5-dev libsm-dev \
libssl-dev libbz2-dev libical-dev libxml2-utils libopenexr-dev \
libjasper-dev libenchant-dev libavahi-common-dev libaspell-dev \
libasound2-dev libboost-dev libboost-program-options-dev libboost-graph-dev libgpgme11-dev \
libldap2-dev libsasl2-dev libxine-dev libqimageblitz-dev libsmbclient-dev \
libxkbfile-dev libxcb1-dev libxklavier-dev libxdamage-dev \
libxcomposite-dev libbluetooth-dev libusb-dev \
network-manager-dev libsmbclient-dev libsensors-dev \
libpam0g-dev libnm-util-dev libusb-dev libcfitsio3-dev libnova-dev \
libeigen2-dev libopenbabel-dev libfacile-ocaml-dev libboost-python-dev \
libsvn-dev libsvncpp-dev libqt4-dev libqca2-dev \
libstreamanalyzer-dev libstrigiqtdbusclient-dev \
libcommoncpp2-dev libidn11 libidn11-dev libxtst-dev librdf0-dev xsltproc \
libxrender-dev libfontconfig1-dev libpci-dev libxss-dev libxft-dev \
libpolkit-dbus-dev libpolkit-grant-dev libpolkit-dev git \
libpoppler-qt4-dev libspectre-dev libdbusmenu-qt-dev docbook-xsl docbook-xml \
libqt4-webkit-dev shared-desktop-ontologies</code>

Also, to enable XMMS support for the 'Now Playing' plasma data engine in kdebase, you will need to either compile XMMS from source, or install the package from a [http://www.pvv.ntnu.no/~knuta/xmms/ third-party XMMS package repository].

== Build prerequisites ==
In Kubuntu and Debian (Testing/Unstable) the build prerequisites are installed with:

<code bash>
sudo aptitude install build-essential cdbs debhelper cmake \
kdesdk-scripts subversion ssh xserver-xephyr
</code>

Optional packages for API documentation generation:
<code bash>
sudo aptitude install doxygen graphviz
</code>

== kdelibs dependencies ==

Kdelibs dependencies can be installed with:
<code bash>
sudo aptitude install libqt4-dev dbus-x11 \
libstreamanalyzer-dev libstrigiqtdbusclient-dev \
libxml2-dev libxslt1-dev shared-mime-info libgif-dev libpcre3-dev \
libjpeg62-dev librdf0-dev libdbusmenu-qt-dev docbook-xsl docbook-xml \
libjasper-dev libopenexr-dev libacl1-dev
</code>

You may also need the automoc and libphonon-dev packages when compiling on *buntu:
<code bash>sudo aptitude install automoc libphonon-dev</code>

=== Recommended packages ===
* libssl-dev - Needed for https support etc.
* libbz2-dev - Needed for bzip support in kio_archive and GHNS packages.
* libpcre3-dev - regular expression library. Recommended for Javascript support.

<code bash>
sudo aptitude install libssl-dev libbz2-dev libpcre3-dev
</code>

=== Optional packages ===
* libasound2-dev - The Alsa sound system
* libaspell-dev - spell checking support (in kwrite etc)
* libavahi-common-dev - avahi/zeroconf service discovery
* libenchant-dev - spell checking wrapper library
* libjasper-dev - image processing library
* libopenexr-dev - image processing library
* libxml2-utils - used to validate generate doc files
<code bash>
sudo aptitude install libasound2-dev libaspell-dev \
libavahi-common-dev libenchant-dev libjasper-dev libopenexr-dev \
libxml2-utils
</code>

== kdepimlibs dependencies ==
kdepimlibs dependencies can be installed with:
<code bash>
sudo aptitude install libboost-dev libboost-program-options-dev libboost-graph-dev \
libgpgme11-dev libsasl2-dev
</code>

* libsasl2-dev - Required for imap and sieve kioslaves

If compiling on *buntu you may need libical-dev:
<code bash>
sudo aptitude install libical-dev
</code>

=== kdepimlibs recommended ===
* libldap2-dev - For ldap support in kde4.

<code bash>
sudo aptitude install libldap2-dev
</code>

== kdebase dependencies ==
kdebase-runtime dependencies can be installed with:
<code bash>
sudo aptitude install libxine-dev
</code>

{{Note|Note that libxine1-dev depends on gnome packages due to a kubuntu gutsy packaging bug (fixed in hardy). Also kubuntu packages xinelib version 1.1.8, which has trouble playing short sounds (fixed in xinelib 1.1.9).
}}

kdebase-apps dependencies can be installed with:
<code bash>
sudo aptitude install libqimageblitz-dev
</code>

=== kdebase-apps optional ===
* libxcb1-dev - X C binding - Used for video widget support in xine
* libxkbfile-dev - keyboard configuration package
* libsmbclient-dev - for samba support in kde4

<code bash>
sudo aptitude install libsmbclient-dev libxkbfile-dev libxcb1-dev
</code>

=== kdebase-workspace optional ===
* libsmbclient-dev - for samba support in kde4
* network-manager-dev - Can be used by solid for network management
* libusb-dev - for usb support in solid
* libbluetooth-dev - for bluetooth support in solid
* libxcomposite-dev - for compositing support in kwin
* libxdamage-dev - for compositing support in kwin
* libxklavier-dev - virtual keyboard
* libsensors-dev - Support for hardware sensors (eg, temperature, fans)
* libpam0g-dev - Authentication module
* libnm-util-dev - needed to build solid with network manager
<code bash>
sudo aptitude install libxklavier-dev libxdamage-dev libxcomposite-dev \
libbluetooth-dev libusb-dev libcaptury-dev network-manager-dev \
libsmbclient-dev libsensors-dev libpam0g-dev libnm-util-dev
</code>

== kdegraphics ==
* libpoppler-qt4-dev - PDF support in Okular
* libspectre-dev - postscript support in Okular
* liblcms1-dev
* libexiv2-dev - to build Gwenview

== kdeedu ==
The following packages are recommended if you intend to use kstars:

* libfacile-ocaml-dev - used by kalzuim.
* libboost-python-dev - optional for kig.
* libreadline-dev - Gives kalgebra a console interface.
* libopenbabel-dev - used by kalzium.
* libeigen2-dev - used by kalzium.
* libusb-dev - Provides KStars INDI support.
* libcfitsio3-dev - Gives KStars support for FITS images.
* libnova-dev - A general purpose, double precision, Celestial Mechanics, Astrometry and Astrodynamics library for KStars.

<code bash>
sudo aptitude install libusb-dev libcfitsio3-dev libnova-dev libeigen2-dev \
libopenbabel-dev libfacile-ocaml-dev libboost-python-dev
</code>

== koffice ==
* libqca2-dev - qt cryptographic support.

== kdepim ==
* libqca2-dev - qt cryptographic support.

== kdenetwork ==
* libqca2-dev - qt cryptographic support. Used for jabber protocol.

== kdevplatform ==
* libsvn-dev
* libboost-serialization-dev

== kdevelop ==
* kdevplatform-dev
* kdebase-workspace-dev

Return to [[Getting_Started/Build/KDE4#kdelibs|building KDE 4]].

Getting Started/Build/Distributions/Debian

2010-08-30T17:19:55Z

Fulldecent: /* 4.6 */

{{Template:I18n/Language Navigation Bar|Getting_Started/Build/KDE4/Kubuntu and Debian}}
This page details installation of kde4 requirements on any recent Kubuntu or Debian.

'''If Kubuntu doesn't have QT4.6 yet, you can get it adding this repository ppa:mapopa/qt4.6 istead compile kde-qt'''

To build a basic functioning desktop, the recommended packages are installed with the commands on this page.
== KDE 4.x ==
<code bash>
sudo aptitude install build-essential kde-devel xorg-dev cdbs debhelper cmake \
kdesdk-scripts subversion ssh xserver-xephyr doxygen dbus-x11 \
libxml2-dev libxslt1-dev shared-mime-info libical-dev libgif-dev libssl-dev \
libboost-dev libboost-program-options-dev libboost-graph-dev libgpgme11-dev libxine-dev \
libqimageblitz-dev libbz2-dev libdbus-1-dev libpam0g-dev libpcre3-dev \
libkrb5-dev libsm-dev libclucene0ldbl libclucene-dev libjpeg62-dev \
libxtst-dev xsltproc libxrender-dev libfontconfig1-dev automoc librdf0-dev \
libdbusmenu-qt-dev docbook-xsl docbook-xml libattica-dev libqt4-webkit-dev \
shared-desktop-ontologies libphonon-dev
</code>

== 4.6 ==
No extra packages for trunk at this time

== 4.5 ==

=== kdenetworks ===
<code bash>
sudo aptitude install libv4l-dev
</code>
=== kdegraphics ===
<code bash>
sudo aptitude install liblcms1-dev
</code>

== 4.4 ==

== More Trunk and unsorted ==
****I moved libstreamanalyzer-dev libstrigiqtdbusclient-dev to the section below since that pulls in qt4.

This installs build prerequisites such as build essential, almost all compilation requirements for kde4 (with the exception of qt4) and some recommended packages such as libssl-dev for https support. Further recommended and optional packages are listed below.

To install all the optional packages:

<code bash>
sudo aptitude install build-essential kde-devel xorg-dev cdbs debhelper cmake \
kdesdk-scripts subversion ssh xserver-xephyr doxygen graphviz libqt4-dev \
dbus-x11 libdbus-1-dev libstreamanalyzer-dev libstrigiqtdbusclient-dev \
libxml2-dev libxslt1-dev shared-mime-info libgif-dev libpcre3-dev \
libclucene0ldbl libclucene-dev libjpeg62-dev libkrb5-dev libsm-dev \
libssl-dev libbz2-dev libical-dev libxml2-utils libopenexr-dev \
libjasper-dev libenchant-dev libavahi-common-dev libaspell-dev \
libasound2-dev libboost-dev libboost-program-options-dev libboost-graph-dev libgpgme11-dev \
libldap2-dev libsasl2-dev libxine-dev libqimageblitz-dev libsmbclient-dev \
libxkbfile-dev libxcb1-dev libxklavier-dev libxdamage-dev \
libxcomposite-dev libbluetooth-dev libusb-dev \
network-manager-dev libsmbclient-dev libsensors-dev \
libpam0g-dev libnm-util-dev libusb-dev libcfitsio3-dev libnova-dev \
libeigen2-dev libopenbabel-dev libfacile-ocaml-dev libboost-python-dev \
libsvn-dev libsvncpp-dev libqt4-dev libqca2-dev \
libstreamanalyzer-dev libstrigiqtdbusclient-dev \
libcommoncpp2-dev libidn11 libidn11-dev libxtst-dev librdf0-dev xsltproc \
libxrender-dev libfontconfig1-dev libpci-dev libxss-dev libxft-dev \
libpolkit-dbus-dev libpolkit-grant-dev libpolkit-dev git \
libpoppler-qt4-dev libspectre-dev libdbusmenu-qt-dev docbook-xsl docbook-xml \
libqt4-webkit-dev shared-desktop-ontologies</code>

Also, to enable XMMS support for the 'Now Playing' plasma data engine in kdebase, you will need to either compile XMMS from source, or install the package from a [http://www.pvv.ntnu.no/~knuta/xmms/ third-party XMMS package repository].

== Build prerequisites ==
In Kubuntu and Debian (Testing/Unstable) the build prerequisites are installed with:

<code bash>
sudo aptitude install build-essential cdbs debhelper cmake \
kdesdk-scripts subversion ssh xserver-xephyr
</code>

Optional packages for API documentation generation:
<code bash>
sudo aptitude install doxygen graphviz
</code>

== kdelibs dependencies ==

Kdelibs dependencies can be installed with:
<code bash>
sudo aptitude install libqt4-dev dbus-x11 \
libstreamanalyzer-dev libstrigiqtdbusclient-dev \
libxml2-dev libxslt1-dev shared-mime-info libgif-dev libpcre3-dev \
libjpeg62-dev librdf0-dev libdbusmenu-qt-dev docbook-xsl docbook-xml \
libjasper-dev libopenexr-dev libacl1-dev
</code>

You may also need the automoc and libphonon-dev packages when compiling on *buntu:
<code bash>sudo aptitude install automoc libphonon-dev</code>

=== Recommended packages ===
* libssl-dev - Needed for https support etc.
* libbz2-dev - Needed for bzip support in kio_archive and GHNS packages.
* libpcre3-dev - regular expression library. Recommended for Javascript support.

<code bash>
sudo aptitude install libssl-dev libbz2-dev libpcre3-dev
</code>

=== Optional packages ===
* libasound2-dev - The Alsa sound system
* libaspell-dev - spell checking support (in kwrite etc)
* libavahi-common-dev - avahi/zeroconf service discovery
* libenchant-dev - spell checking wrapper library
* libjasper-dev - image processing library
* libopenexr-dev - image processing library
* libxml2-utils - used to validate generate doc files
<code bash>
sudo aptitude install libasound2-dev libaspell-dev \
libavahi-common-dev libenchant-dev libjasper-dev libopenexr-dev \
libxml2-utils
</code>

== kdepimlibs dependencies ==
kdepimlibs dependencies can be installed with:
<code bash>
sudo aptitude install libboost-dev libboost-program-options-dev libboost-graph-dev \
libgpgme11-dev libsasl2-dev
</code>

* libsasl2-dev - Required for imap and sieve kioslaves

If compiling on *buntu you may need libical-dev:
<code bash>
sudo aptitude install libical-dev
</code>

=== kdepimlibs recommended ===
* libldap2-dev - For ldap support in kde4.

<code bash>
sudo aptitude install libldap2-dev
</code>

== kdebase dependencies ==
kdebase-runtime dependencies can be installed with:
<code bash>
sudo aptitude install libxine-dev
</code>

{{Note|Note that libxine1-dev depends on gnome packages due to a kubuntu gutsy packaging bug (fixed in hardy). Also kubuntu packages xinelib version 1.1.8, which has trouble playing short sounds (fixed in xinelib 1.1.9).
}}

kdebase-apps dependencies can be installed with:
<code bash>
sudo aptitude install libqimageblitz-dev
</code>

=== kdebase-apps optional ===
* libxcb1-dev - X C binding - Used for video widget support in xine
* libxkbfile-dev - keyboard configuration package
* libsmbclient-dev - for samba support in kde4

<code bash>
sudo aptitude install libsmbclient-dev libxkbfile-dev libxcb1-dev
</code>

=== kdebase-workspace optional ===
* libsmbclient-dev - for samba support in kde4
* network-manager-dev - Can be used by solid for network management
* libusb-dev - for usb support in solid
* libbluetooth-dev - for bluetooth support in solid
* libxcomposite-dev - for compositing support in kwin
* libxdamage-dev - for compositing support in kwin
* libxklavier-dev - virtual keyboard
* libsensors-dev - Support for hardware sensors (eg, temperature, fans)
* libpam0g-dev - Authentication module
* libnm-util-dev - needed to build solid with network manager
<code bash>
sudo aptitude install libxklavier-dev libxdamage-dev libxcomposite-dev \
libbluetooth-dev libusb-dev libcaptury-dev network-manager-dev \
libsmbclient-dev libsensors-dev libpam0g-dev libnm-util-dev
</code>

== kdegraphics ==
* libpoppler-qt4-dev - PDF support in Okular
* libspectre-dev - postscript support in Okular
* liblcms1-dev
* libexiv2-dev - to build Gwenview

== kdeedu ==
The following packages are recommended if you intend to use kstars:

* libfacile-ocaml-dev - used by kalzuim.
* libboost-python-dev - optional for kig.
* libreadline-dev - Gives kalgebra a console interface.
* libopenbabel-dev - used by kalzium.
* libeigen2-dev - used by kalzium.
* libusb-dev - Provides KStars INDI support.
* libcfitsio3-dev - Gives KStars support for FITS images.
* libnova-dev - A general purpose, double precision, Celestial Mechanics, Astrometry and Astrodynamics library for KStars.

<code bash>
sudo aptitude install libusb-dev libcfitsio3-dev libnova-dev libeigen2-dev \
libopenbabel-dev libfacile-ocaml-dev libboost-python-dev
</code>

== koffice ==
* libqca2-dev - qt cryptographic support.

== kdepim ==
* libqca2-dev - qt cryptographic support.

== kdenetwork ==
* libqca2-dev - qt cryptographic support. Used for jabber protocol.

== kdevplatform ==
* libsvn-dev
* libboost-serialization-dev

== kdevelop ==
* kdevplatform-dev
* kdebase-workspace-dev

Return to [[Getting_Started/Build/KDE4#kdelibs|building KDE 4]].

Getting Started/Build/Distributions/Debian

2010-08-30T17:17:38Z

Fulldecent:

{{Template:I18n/Language Navigation Bar|Getting_Started/Build/KDE4/Kubuntu and Debian}}
This page details installation of kde4 requirements on any recent Kubuntu or Debian.

'''If Kubuntu doesn't have QT4.6 yet, you can get it adding this repository ppa:mapopa/qt4.6 istead compile kde-qt'''

To build a basic functioning desktop, the recommended packages are installed with the commands on this page.
== KDE 4.x ==
<code bash>
sudo aptitude install build-essential kde-devel xorg-dev cdbs debhelper cmake \
kdesdk-scripts subversion ssh xserver-xephyr doxygen dbus-x11 \
libxml2-dev libxslt1-dev shared-mime-info libical-dev libgif-dev libssl-dev \
libboost-dev libboost-program-options-dev libboost-graph-dev libgpgme11-dev libxine-dev \
libqimageblitz-dev libbz2-dev libdbus-1-dev libpam0g-dev libpcre3-dev \
libkrb5-dev libsm-dev libclucene0ldbl libclucene-dev libjpeg62-dev \
libxtst-dev xsltproc libxrender-dev libfontconfig1-dev automoc librdf0-dev \
libdbusmenu-qt-dev docbook-xsl docbook-xml libattica-dev libqt4-webkit-dev \
shared-desktop-ontologies libphonon-dev
</code>

== 4.6 ==
Trunk at this time

== 4.5 ==

=== kdenetworks ===
<code bash>
sudo aptitude install libv4l-dev
</code>
=== kdegraphics ===
<code bash>
sudo aptitude install liblcms1-dev
</code>

== 4.4 ==

== More Trunk and unsorted ==
****I moved libstreamanalyzer-dev libstrigiqtdbusclient-dev to the section below since that pulls in qt4.

This installs build prerequisites such as build essential, almost all compilation requirements for kde4 (with the exception of qt4) and some recommended packages such as libssl-dev for https support. Further recommended and optional packages are listed below.

To install all the optional packages:

<code bash>
sudo aptitude install build-essential kde-devel xorg-dev cdbs debhelper cmake \
kdesdk-scripts subversion ssh xserver-xephyr doxygen graphviz libqt4-dev \
dbus-x11 libdbus-1-dev libstreamanalyzer-dev libstrigiqtdbusclient-dev \
libxml2-dev libxslt1-dev shared-mime-info libgif-dev libpcre3-dev \
libclucene0ldbl libclucene-dev libjpeg62-dev libkrb5-dev libsm-dev \
libssl-dev libbz2-dev libical-dev libxml2-utils libopenexr-dev \
libjasper-dev libenchant-dev libavahi-common-dev libaspell-dev \
libasound2-dev libboost-dev libboost-program-options-dev libboost-graph-dev libgpgme11-dev \
libldap2-dev libsasl2-dev libxine-dev libqimageblitz-dev libsmbclient-dev \
libxkbfile-dev libxcb1-dev libxklavier-dev libxdamage-dev \
libxcomposite-dev libbluetooth-dev libusb-dev \
network-manager-dev libsmbclient-dev libsensors-dev \
libpam0g-dev libnm-util-dev libusb-dev libcfitsio3-dev libnova-dev \
libeigen2-dev libopenbabel-dev libfacile-ocaml-dev libboost-python-dev \
libsvn-dev libsvncpp-dev libqt4-dev libqca2-dev \
libstreamanalyzer-dev libstrigiqtdbusclient-dev \
libcommoncpp2-dev libidn11 libidn11-dev libxtst-dev librdf0-dev xsltproc \
libxrender-dev libfontconfig1-dev libpci-dev libxss-dev libxft-dev \
libpolkit-dbus-dev libpolkit-grant-dev libpolkit-dev git \
libpoppler-qt4-dev libspectre-dev libdbusmenu-qt-dev docbook-xsl docbook-xml \
libqt4-webkit-dev shared-desktop-ontologies</code>

Also, to enable XMMS support for the 'Now Playing' plasma data engine in kdebase, you will need to either compile XMMS from source, or install the package from a [http://www.pvv.ntnu.no/~knuta/xmms/ third-party XMMS package repository].

== Build prerequisites ==
In Kubuntu and Debian (Testing/Unstable) the build prerequisites are installed with:

<code bash>
sudo aptitude install build-essential cdbs debhelper cmake \
kdesdk-scripts subversion ssh xserver-xephyr
</code>

Optional packages for API documentation generation:
<code bash>
sudo aptitude install doxygen graphviz
</code>

== kdelibs dependencies ==

Kdelibs dependencies can be installed with:
<code bash>
sudo aptitude install libqt4-dev dbus-x11 \
libstreamanalyzer-dev libstrigiqtdbusclient-dev \
libxml2-dev libxslt1-dev shared-mime-info libgif-dev libpcre3-dev \
libjpeg62-dev librdf0-dev libdbusmenu-qt-dev docbook-xsl docbook-xml \
libjasper-dev libopenexr-dev libacl1-dev
</code>

You may also need the automoc and libphonon-dev packages when compiling on *buntu:
<code bash>sudo aptitude install automoc libphonon-dev</code>

=== Recommended packages ===
* libssl-dev - Needed for https support etc.
* libbz2-dev - Needed for bzip support in kio_archive and GHNS packages.
* libpcre3-dev - regular expression library. Recommended for Javascript support.

<code bash>
sudo aptitude install libssl-dev libbz2-dev libpcre3-dev
</code>

=== Optional packages ===
* libasound2-dev - The Alsa sound system
* libaspell-dev - spell checking support (in kwrite etc)
* libavahi-common-dev - avahi/zeroconf service discovery
* libenchant-dev - spell checking wrapper library
* libjasper-dev - image processing library
* libopenexr-dev - image processing library
* libxml2-utils - used to validate generate doc files
<code bash>
sudo aptitude install libasound2-dev libaspell-dev \
libavahi-common-dev libenchant-dev libjasper-dev libopenexr-dev \
libxml2-utils
</code>

== kdepimlibs dependencies ==
kdepimlibs dependencies can be installed with:
<code bash>
sudo aptitude install libboost-dev libboost-program-options-dev libboost-graph-dev \
libgpgme11-dev libsasl2-dev
</code>

* libsasl2-dev - Required for imap and sieve kioslaves

If compiling on *buntu you may need libical-dev:
<code bash>
sudo aptitude install libical-dev
</code>

=== kdepimlibs recommended ===
* libldap2-dev - For ldap support in kde4.

<code bash>
sudo aptitude install libldap2-dev
</code>

== kdebase dependencies ==
kdebase-runtime dependencies can be installed with:
<code bash>
sudo aptitude install libxine-dev
</code>

{{Note|Note that libxine1-dev depends on gnome packages due to a kubuntu gutsy packaging bug (fixed in hardy). Also kubuntu packages xinelib version 1.1.8, which has trouble playing short sounds (fixed in xinelib 1.1.9).
}}

kdebase-apps dependencies can be installed with:
<code bash>
sudo aptitude install libqimageblitz-dev
</code>

=== kdebase-apps optional ===
* libxcb1-dev - X C binding - Used for video widget support in xine
* libxkbfile-dev - keyboard configuration package
* libsmbclient-dev - for samba support in kde4

<code bash>
sudo aptitude install libsmbclient-dev libxkbfile-dev libxcb1-dev
</code>

=== kdebase-workspace optional ===
* libsmbclient-dev - for samba support in kde4
* network-manager-dev - Can be used by solid for network management
* libusb-dev - for usb support in solid
* libbluetooth-dev - for bluetooth support in solid
* libxcomposite-dev - for compositing support in kwin
* libxdamage-dev - for compositing support in kwin
* libxklavier-dev - virtual keyboard
* libsensors-dev - Support for hardware sensors (eg, temperature, fans)
* libpam0g-dev - Authentication module
* libnm-util-dev - needed to build solid with network manager
<code bash>
sudo aptitude install libxklavier-dev libxdamage-dev libxcomposite-dev \
libbluetooth-dev libusb-dev libcaptury-dev network-manager-dev \
libsmbclient-dev libsensors-dev libpam0g-dev libnm-util-dev
</code>

== kdegraphics ==
* libpoppler-qt4-dev - PDF support in Okular
* libspectre-dev - postscript support in Okular
* liblcms1-dev
* libexiv2-dev - to build Gwenview

== kdeedu ==
The following packages are recommended if you intend to use kstars:

* libfacile-ocaml-dev - used by kalzuim.
* libboost-python-dev - optional for kig.
* libreadline-dev - Gives kalgebra a console interface.
* libopenbabel-dev - used by kalzium.
* libeigen2-dev - used by kalzium.
* libusb-dev - Provides KStars INDI support.
* libcfitsio3-dev - Gives KStars support for FITS images.
* libnova-dev - A general purpose, double precision, Celestial Mechanics, Astrometry and Astrodynamics library for KStars.

<code bash>
sudo aptitude install libusb-dev libcfitsio3-dev libnova-dev libeigen2-dev \
libopenbabel-dev libfacile-ocaml-dev libboost-python-dev
</code>

== koffice ==
* libqca2-dev - qt cryptographic support.

== kdepim ==
* libqca2-dev - qt cryptographic support.

== kdenetwork ==
* libqca2-dev - qt cryptographic support. Used for jabber protocol.

== kdevplatform ==
* libsvn-dev
* libboost-serialization-dev

== kdevelop ==
* kdevplatform-dev
* kdebase-workspace-dev

Return to [[Getting_Started/Build/KDE4#kdelibs|building KDE 4]].

Getting Started/Build/Distributions/Debian

2010-08-30T17:14:25Z

Fulldecent: /* 4.5 */

{{Template:I18n/Language Navigation Bar|Getting_Started/Build/KDE4/Kubuntu and Debian}}
This page details installation of kde4 Trunk requirements on any recent Kubuntu or Debian. See [[/4.4]] [[/4.5]]

'''If Kubuntu doesn't have QT4.6 yet, you can get it adding this repository ppa:mapopa/qt4.6 istead compile kde-qt'''

For a basic functioning desktop, the recommended packages are installed with the command:
== KDE 4.x ==
<code bash>
sudo aptitude install build-essential kde-devel xorg-dev cdbs debhelper cmake \
kdesdk-scripts subversion ssh xserver-xephyr doxygen dbus-x11 \
libxml2-dev libxslt1-dev shared-mime-info libical-dev libgif-dev libssl-dev \
libboost-dev libboost-program-options-dev libboost-graph-dev libgpgme11-dev libxine-dev \
libqimageblitz-dev libbz2-dev libdbus-1-dev libpam0g-dev libpcre3-dev \
libkrb5-dev libsm-dev libclucene0ldbl libclucene-dev libjpeg62-dev \
libxtst-dev xsltproc libxrender-dev libfontconfig1-dev automoc librdf0-dev \
libdbusmenu-qt-dev docbook-xsl docbook-xml libattica-dev libqt4-webkit-dev \
shared-desktop-ontologies libphonon-dev
</code>

== 4.6 ==
Trunk at this time

== 4.5 ==

=== kdenetworks ===
<code bash>
sudo aptitude install libv4l-dev
</code>
=== kdegraphics ===
<code bash>
sudo aptitude install liblcms1-dev
</code>

== 4.4 ==

== More Trunk and unsorted ==
****I moved libstreamanalyzer-dev libstrigiqtdbusclient-dev to the section below since that pulls in qt4.

This installs build prerequisites such as build essential, almost all compilation requirements for kde4 (with the exception of qt4) and some recommended packages such as libssl-dev for https support. Further recommended and optional packages are listed below.

To install all the optional packages:

<code bash>
sudo aptitude install build-essential kde-devel xorg-dev cdbs debhelper cmake \
kdesdk-scripts subversion ssh xserver-xephyr doxygen graphviz libqt4-dev \
dbus-x11 libdbus-1-dev libstreamanalyzer-dev libstrigiqtdbusclient-dev \
libxml2-dev libxslt1-dev shared-mime-info libgif-dev libpcre3-dev \
libclucene0ldbl libclucene-dev libjpeg62-dev libkrb5-dev libsm-dev \
libssl-dev libbz2-dev libical-dev libxml2-utils libopenexr-dev \
libjasper-dev libenchant-dev libavahi-common-dev libaspell-dev \
libasound2-dev libboost-dev libboost-program-options-dev libboost-graph-dev libgpgme11-dev \
libldap2-dev libsasl2-dev libxine-dev libqimageblitz-dev libsmbclient-dev \
libxkbfile-dev libxcb1-dev libxklavier-dev libxdamage-dev \
libxcomposite-dev libbluetooth-dev libusb-dev \
network-manager-dev libsmbclient-dev libsensors-dev \
libpam0g-dev libnm-util-dev libusb-dev libcfitsio3-dev libnova-dev \
libeigen2-dev libopenbabel-dev libfacile-ocaml-dev libboost-python-dev \
libsvn-dev libsvncpp-dev libqt4-dev libqca2-dev \
libstreamanalyzer-dev libstrigiqtdbusclient-dev \
libcommoncpp2-dev libidn11 libidn11-dev libxtst-dev librdf0-dev xsltproc \
libxrender-dev libfontconfig1-dev libpci-dev libxss-dev libxft-dev \
libpolkit-dbus-dev libpolkit-grant-dev libpolkit-dev git \
libpoppler-qt4-dev libspectre-dev libdbusmenu-qt-dev docbook-xsl docbook-xml \
libqt4-webkit-dev shared-desktop-ontologies</code>

Also, to enable XMMS support for the 'Now Playing' plasma data engine in kdebase, you will need to either compile XMMS from source, or install the package from a [http://www.pvv.ntnu.no/~knuta/xmms/ third-party XMMS package repository].

== Build prerequisites ==
In Kubuntu and Debian (Testing/Unstable) the build prerequisites are installed with:

<code bash>
sudo aptitude install build-essential cdbs debhelper cmake \
kdesdk-scripts subversion ssh xserver-xephyr
</code>

Optional packages for API documentation generation:
<code bash>
sudo aptitude install doxygen graphviz
</code>

== kdelibs dependencies ==

Kdelibs dependencies can be installed with:
<code bash>
sudo aptitude install libqt4-dev dbus-x11 \
libstreamanalyzer-dev libstrigiqtdbusclient-dev \
libxml2-dev libxslt1-dev shared-mime-info libgif-dev libpcre3-dev \
libjpeg62-dev librdf0-dev libdbusmenu-qt-dev docbook-xsl docbook-xml \
libjasper-dev libopenexr-dev libacl1-dev
</code>

You may also need the automoc and libphonon-dev packages when compiling on *buntu:
<code bash>sudo aptitude install automoc libphonon-dev</code>

=== Recommended packages ===
* libssl-dev - Needed for https support etc.
* libbz2-dev - Needed for bzip support in kio_archive and GHNS packages.
* libpcre3-dev - regular expression library. Recommended for Javascript support.

<code bash>
sudo aptitude install libssl-dev libbz2-dev libpcre3-dev
</code>

=== Optional packages ===
* libasound2-dev - The Alsa sound system
* libaspell-dev - spell checking support (in kwrite etc)
* libavahi-common-dev - avahi/zeroconf service discovery
* libenchant-dev - spell checking wrapper library
* libjasper-dev - image processing library
* libopenexr-dev - image processing library
* libxml2-utils - used to validate generate doc files
<code bash>
sudo aptitude install libasound2-dev libaspell-dev \
libavahi-common-dev libenchant-dev libjasper-dev libopenexr-dev \
libxml2-utils
</code>

== kdepimlibs dependencies ==
kdepimlibs dependencies can be installed with:
<code bash>
sudo aptitude install libboost-dev libboost-program-options-dev libboost-graph-dev \
libgpgme11-dev libsasl2-dev
</code>

* libsasl2-dev - Required for imap and sieve kioslaves

If compiling on *buntu you may need libical-dev:
<code bash>
sudo aptitude install libical-dev
</code>

=== kdepimlibs recommended ===
* libldap2-dev - For ldap support in kde4.

<code bash>
sudo aptitude install libldap2-dev
</code>

== kdebase dependencies ==
kdebase-runtime dependencies can be installed with:
<code bash>
sudo aptitude install libxine-dev
</code>

{{Note|Note that libxine1-dev depends on gnome packages due to a kubuntu gutsy packaging bug (fixed in hardy). Also kubuntu packages xinelib version 1.1.8, which has trouble playing short sounds (fixed in xinelib 1.1.9).
}}

kdebase-apps dependencies can be installed with:
<code bash>
sudo aptitude install libqimageblitz-dev
</code>

=== kdebase-apps optional ===
* libxcb1-dev - X C binding - Used for video widget support in xine
* libxkbfile-dev - keyboard configuration package
* libsmbclient-dev - for samba support in kde4

<code bash>
sudo aptitude install libsmbclient-dev libxkbfile-dev libxcb1-dev
</code>

=== kdebase-workspace optional ===
* libsmbclient-dev - for samba support in kde4
* network-manager-dev - Can be used by solid for network management
* libusb-dev - for usb support in solid
* libbluetooth-dev - for bluetooth support in solid
* libxcomposite-dev - for compositing support in kwin
* libxdamage-dev - for compositing support in kwin
* libxklavier-dev - virtual keyboard
* libsensors-dev - Support for hardware sensors (eg, temperature, fans)
* libpam0g-dev - Authentication module
* libnm-util-dev - needed to build solid with network manager
<code bash>
sudo aptitude install libxklavier-dev libxdamage-dev libxcomposite-dev \
libbluetooth-dev libusb-dev libcaptury-dev network-manager-dev \
libsmbclient-dev libsensors-dev libpam0g-dev libnm-util-dev
</code>

== kdegraphics ==
* libpoppler-qt4-dev - PDF support in Okular
* libspectre-dev - postscript support in Okular
* liblcms1-dev
* libexiv2-dev - to build Gwenview

== kdeedu ==
The following packages are recommended if you intend to use kstars:

* libfacile-ocaml-dev - used by kalzuim.
* libboost-python-dev - optional for kig.
* libreadline-dev - Gives kalgebra a console interface.
* libopenbabel-dev - used by kalzium.
* libeigen2-dev - used by kalzium.
* libusb-dev - Provides KStars INDI support.
* libcfitsio3-dev - Gives KStars support for FITS images.
* libnova-dev - A general purpose, double precision, Celestial Mechanics, Astrometry and Astrodynamics library for KStars.

<code bash>
sudo aptitude install libusb-dev libcfitsio3-dev libnova-dev libeigen2-dev \
libopenbabel-dev libfacile-ocaml-dev libboost-python-dev
</code>

== koffice ==
* libqca2-dev - qt cryptographic support.

== kdepim ==
* libqca2-dev - qt cryptographic support.

== kdenetwork ==
* libqca2-dev - qt cryptographic support. Used for jabber protocol.

== kdevplatform ==
* libsvn-dev
* libboost-serialization-dev

== kdevelop ==
* kdevplatform-dev
* kdebase-workspace-dev

Return to [[Getting_Started/Build/KDE4#kdelibs|building KDE 4]].

Getting Started/Build/KDE4

2010-08-30T17:10:19Z

Fulldecent: /* Required packages from your distribution */

{{Template:I18n/Language Navigation Bar|Getting_Started/Build/KDE4}}

{{TutorialBrowser|

series=Getting Started|

name=Building KDE4 (Development version, TRUNK) From Source|

pre=[[../../Sources/Anonymous_SVN|Anonymous SVN Quickstart Guide]]|

next=[[../../Set_up_KDE_4_for_development|Set up KDE 4 for development]]|

reading=[[../kdesrc-build|kdesrc-build: The KDE From Source Build Tool]]<br>[[Contribute/Send Patches|Sending Patches]]<br>[[../../Increased_Productivity_in_KDE4_with_Scripts|Increased Productivity in KDE4 with Scripts]]<br>[[Development/Tutorials/CMake |Introduction to CMake]]<br>[[../KDE4/FreeBSD|FreeBSD notes]]<br>[[../KDE4/Mac OS X|Instructions for Mac OS X]]<br>[[../KDE4/Windows|Instructions for MS Windows]]|
}}
{| class="collapsible collapsed" style="border: 1px #aaa solid; background: #efefef;"
! style="font-size: 1.25em; "| Table of contents
|-
| __TOC__
|}
{{warning|The commands below are used to build the latest UNSTABLE version of KDE from TRUNK.

This should not be used in a production environment -- not recommended for daily use.

To build a stable KDE-4 version, go to:

::[[Getting_Started/Build/KDE4.x|upgrading to KDE-4.x from KDE-3.x]]

Or

::[[Getting_Started/Build/KDE4.4 Upgrade|Upgrade KDE-4.4.x release version or KDE-4.4 SVN BRANCH)]]

which is currently under construction.
}}

== Abstract ==

This tutorial shows a labor intensive way to get KDE from trunk running on Linux/BSD systems.

{{Note|
kdesrc-build http://kdesrc-build.kde.org/ is an easy alternative. (Previously called kdesvn-build)
}}

There are also tutorials for [[Getting_Started/Build/KDE4/FreeBSD|FreeBSD]], [[/Windows|Windows]], [[/Mac OS X|Mac OS X]] and [http://solaris.kde.org/ Solaris]. This tutorial creates a special user, kde-devel, that will run KDE trunk. On the one hand, this allows other users to continue with another KDE version. On the other hand, testing special system-wide code like the KDE display manager is not possible. There is a tutorial to
[[Getting_Started/Build/KDE4/onVmWare|set up KDE 4 trunk on a virtual machine]].

Throughout the tutorial the bash shell is used.

{{warning|Expect a higher risk of build failure '''on Mondays''' when most kdelibs changes are committed. [http://developer.kde.org/~dirk/dashboard/ Dashboard] reports unexpected breakages. You are encouraged to fix failing modules.}}

== Create a user account for KDE4 development ==

It is important to keep the development version from interfering with the rest of your computer, The method covered here is creating a dedicated kde-devel user.

We will need to:
#Add the user
#Set the shell to bash
#and may have to use sudoedit if we want to be able to sudo
#Create a .bashrc file with environment variables for the build system

A graphical tool is avalable from most distributions, if you have KDE you can get to this tool via: K->Computer->System Settings->User Management

{{Note|
Less Safe Alternative:
One can do everything under your normal user account

See [[Getting_Started/Increased_Productivity_in_KDE4_with_Scripts|Increased Productivity in KDE4 with Scripts]]
for more details.

The environment variables determinate what version you use. Proceed same as here except put the environment variables in a file. In your <tt>.bashrc</tt> file add the line <tt>source .kde_devel_env</tt>. renaming the .kde_devel_env file would make them not be loaded, so you wouldn't use the devel version.
}}

===Commandline useradd===
Some systems are configured to use {{path|/bin/sh}}. Many users prefer Bash{{path|/bin/bash}}

{{Note|
On Ark Linux and Fedora, you can skip the <tt>-s /bin/bash</tt> switch - {{path|/bin/sh}} is {{path|bash}}.
}}
<code bash>
sudo useradd -m kde-devel -s /bin/bash
sudo passwd kde-devel
</code>

==== commandline permissions and groups ====
Edit your /etc/groups file to add the kde-devel user to all the groups that you need (probably the groups that your usual username is already assigned to).

You may need to add user to sudoers file. (beyond scope of this tutorial)

=== Setting up the environment ===

Copy the {{path|~/.bashrc}} from your normal user account to the new kde-devel account.

Next, copy and paste the contents of the [[Getting Started/Increased Productivity in KDE4 with Scripts/.bashrc|example .bashrc]] into {{path|~kde-devel/.bashrc}}. Be sure to comment out the line <tt>alias make=makeobj</tt> if you do not have the <tt>[[Getting Started/Build/KDE4/Prerequisites#Abstract|makeobj]]</tt> command available. (What is this, how do we know???)

Alternatively, you can download the kde-sdk a.k.a kdesdk package (or perform a subversion checkout) and include the kde-sdk/scripts/ directory in your path. (What is this???)

You will probably also want to modify the path to make sure it doesn't include your kde3 paths.

Also if you want to use KDevelop to develop KDE 4 applications you may pass the ''-GKDevelop3'' flag to the ''cmake'' command (to make CMake generate KDevelop project files, it will help to avoid rebuilding in the future, see [[Getting_Started/Set_up_KDE_4_for_development#Setting_up_the_environment|this]]).
To make it run, you have to open a new bash or to execute
<code bash>
source ~/.bashrc
</code>

This will provide access to commands such as <tt>cmakekde</tt> that are used in this tutorial as well as ensure that the proper paths are in place for Qt, KDE and CMake binaries.

For more information, please read the [[Getting Started/Increased Productivity in KDE4 with Scripts]] tutorial.

=== Using the kde-devel User ===
To get a text-only command prompt, say from konsole
su - kde-devel
'(need hyphen otherwise your environment will be the same as your regular user)

To Log in Text-only from a virtual terminal:
CTRL-F1 ( CTRL-F7 is normally graphical )

To use a shell that can pop up applications when your normal user is logged in:
<code bash>
ssh -X kde-devel@localhost
</code>

{{Note|
If the ssh command fails, check out the [[Getting_Started/Set_up_KDE_4_for_development#Launching_KDE_4_apps|Launching KDE 4 apps]] section of the [[Getting_Started/Set_up_KDE_4_for_development|KDE4 development guide]].
}}

== Required packages from your distribution ==
The requirements to build kde4 from source vary from distribution to distribution. Instructions for your distribution are provided below:
See [[build requirements]] for more complete list.

[[Getting_Started/Build/KDE4/Ark Linux|Ark Linux]],
[[Getting_Started/Build/KDE4/Arch Linux|Arch Linux]], [[Getting_Started/Build/KDE4/Fedora|Fedora]],
[[Getting_Started/Build/KDE4/Kubuntu and Debian|Kubuntu and Debian]] (or check out [[Getting_Started/Using_Project_Neon_to_contribute_to_KDE|Project Neon]]), [[Getting_Started/Build/KDE4/openSUSE|openSUSE]] ([http://en.opensuse.org/openSUSE:KDE_developers_guide specific guide for openSUSE]. However be careful because it updates a huge number of your stable packages.),
[[Getting_Started/Build/KDE4/Gentoo|Gentoo]],
[[Getting_Started/Build/KDE4/LFS|Linux from Scratch]] or to build from source.
[[Getting_Started/Build/KDE4/Mandriva|Mandriva]]
[[Getting_Started/Build/KDE4/Generic|any other distro]]

=== Optional Documentation Dependencies ===
For trunk you also now need docbook-dtd42-xml for the docs. Depending on your distribution please get the docbook related packages and the 4.2 DTD.

Your next compilation step depends on the packages supplied by your distro.

== Compiling kde-qt, etc. ==
If you do not want to use the packages provided by your distro you can compile things like Qt yourself. Instructions for building all dependencies including CMake, Qt4 (kde-qt) and kdesupport are available in [[Getting_Started/Build/KDE4/Prerequisites|the build prerequisites page]]. Note that automoc, strigi, soprano, and a few other things are part of kdesupport, so if you have errors about these missing, you'll need to get kdesupport.

=== Useful subversion tweaks ===

{{Warning|Do not use this method when you don't know what you are doing or just want to test some trunk feature, seriously!
You can create a very costly load when you accidentially checkout all of trunk or for example all of "trunk/KDE" just to build single modules. This would generate immense useless load on the svn server.}}

If you check out large parts of svn trunk regularly or if you want to create patches which touch several modules at once, you should try to checkout an empty tree of trunk first and then update only the relevant modules, for example:

==== Example ====
cd
cs # [[Getting_Started/Increased_Productivity_in_KDE4_with_Scripts/.bashrc|'cs' is a bash function, click here to learn more]]
svn checkout --depth empty svn://anonsvn.kde.org/home/kde/trunk
cd trunk
svn up kdesupport && cd kdesupport
cmakekde
cs trunk
svn up --depth empty KDE
svn up KDE/kdelibs && cd KDE/kdelibs
cmakekde
cs trunk
svn up KDE/kdepimlibs
...

==== Why do I want to do that? ====
That way you can move stuff around all over the trunk repository, e.g. from playground to kdereview or to KDE/*. The following examples assume that you only want to test or work on single and few modules of trunk.

This way updating the whole repository to a (hopefully) consitent state, the same revision, is really easy:

cs trunk # [[Getting_Started/Increased_Productivity_in_KDE4_with_Scripts/.bashrc|'cs' is a bash function, click here to learn more]]
svn up

== Download and Compile ==
In this section we go over acquiring and building the product.
{{Note|
check out http://kdesvn-build.kde.org/ you may not need to do all of this stuff.
}}

=== Troubleshooting ===
Please note, that requirements and dependancies frequently change.
You are running an UNSTABLE version, and simply compiling is not guaranteed. You will need to review errors and locate packages, (see acquire dependencies above) and [[Getting_Started/Build/KDE4/Troubleshooting|Troubleshooting]] information.

We can now move on to building KDE's most essential libraries.

=== kdelibs ===
Very important for lots of things, you may need to see troubleshooting and install some things from kdesupport first.

==== The Recipe ====
cd
cs # [[Getting_Started/Increased_Productivity_in_KDE4_with_Scripts/.bashrc|'cs' is a bash function, click here to learn more]]
mkdir KDE && cd KDE
svn checkout svn://anonsvn.kde.org/home/kde/trunk/KDE/kdelibs
cd kdelibs
mkdir build
cd build
cmakekde ..

==== What's Happening ====
We change to the base source directory (line 1) then make and go into the KDE directory (line 3). We download the sources for kdelibs using subversion (line 4), go into the new {{path|~/kde/src/KDE/kdelibs}} directory (line 5), and commence the build (line 6). This will leave us in the <tt>kdelibs</tt> build directory after the build is completed.

{{tip|There might be missing dependencies on your system! They are easily overlooked in the output of <tt>cmakekde</tt>.
You might want to do a <tt>cmake $KDE_SRC/KDE/MODULE_NAME</tt> prior to compiling any kde modules (like kdelibs, kdepimlibs etc.)}}

==== Additional KDE-specific CMake know-how ====

There are additional CMake modules in {{path|kdelibs/cmake/modules/}} that are necessary for building KDE4 applications. These will be installed for you when kdelibs itself is installed.

To make a non-debug-release (e.g. suppressing all kDebug() messages), use e.g.
cmake -DCMAKE_BUILD_TYPE=Release . && make && make install

==== Troubleshooting ====

For troubleshooting information, see the [[Getting_Started/Build/KDE4/Troubleshooting#Issues_building_kdelibs|kdelibs troubleshooting section]].

=== kdepimlibs ===
Currently kdebase depends on kdepimlibs so it is required to install it first. These libraries are also shared by other packages such as those within kdepim, kdeutils and kdenetwork.

==== libical ====
Download libical from http://sourceforge.net/project/showfiles.php?group_id=16077, compile, link and install it.
tar xvzf libical-0.41.tar.gz
cd libical-0.41
./configure && make && make install

==== The Recipe ====
cs KDE # [[Getting_Started/Increased_Productivity_in_KDE4_with_Scripts/.bashrc|'cs' is a bash function, click here to learn more]]
svn checkout svn://anonsvn.kde.org/home/kde/trunk/KDE/kdepimlibs
cd kdepimlibs
cmakekde

==== What's Happening ====
We go into the KDE source directory (line 1), download the source code for kdepimlibs using subversion (line 2) and then go into the new {{path|~/kde/src/KDE/kdepimlibs}} directory (line 3). We then commence the build (line 4). This will leave us in the <tt>kdepimlibs</tt> build directory after the build is completed.

==== Troubleshooting ====

For troubleshooting information, see the [[Getting_Started/Build/KDE4/Troubleshooting#Issues_building_kdepimlibs|kdepimlibs troubleshooting section]].

=== kdebase ===
kdebase is divided into three parts:
* '''apps'''
:This contains applications like Dolphin or KWrite.
* '''runtime'''
:This contains things needed by every application at runtime, like icons. It is a required dependency for each KDE application, so you have to compile and install this.
* '''workspace'''
:This contains things specific to the KDE desktop, like Plasma or the window manager. Most stuff here depends on X11. You only need it if you want to build a full KDE desktop.

You can build all of kdebase at once, which is described in the recipe below. If you only want to build kdebase-runtime, which is the only requirement, you can replace <code bash>cd kdebase</code> with <code bash>cd kdebase/runtime</code> in the recipe below.

==== The Recipe ====
cs KDE # [[Getting_Started/Increased_Productivity_in_KDE4_with_Scripts/.bashrc|'cs' is a bash function, click here to learn more]]
svn checkout svn://anonsvn.kde.org/home/kde/trunk/KDE/kdebase
cd kdebase
cmakekde

==== Troubleshooting ====
For troubleshooting information, see the [[Getting_Started/Build/KDE4/Troubleshooting#Issues_building_kdebase|kdebase troubleshooting section]].

== Translations ==

Most KDE users are going to install translations before being able to use their desktop properly. Full information is given in the [[Development/Tutorials/Localization/Building_KDE's_l10n_Module|Localisation tutorial]].
For a single language, the following receipe installs messages and translated documentation:

=== The Recipe ===
cs KDE # [[Getting_Started/Increased_Productivity_in_KDE4_with_Scripts/.bashrc|'cs' is a bash function, click here to learn more]]
svn checkout -N svn://anonsvn.kde.org/home/kde/trunk/l10n-kde4
cd l10n-kde4
svn up scripts <language>
./scripts/autogen.sh <language>
cd <language>
cmakekde

== Running KDE 4 programs ==

You can now run KDE 4 programs (e.g. kwrite) by typing:
ssh -X kde-devel@localhost
kwrite

=== Troubleshooting ===

For troubleshooting issues see [[Getting_Started/Build/KDE4/Troubleshooting#Running_programs|troubleshooting running programs]].

== Generating local API documentation ==

See the [[Development/Tools/apidox|generating apidox]] page.

== Staying up to date ==

In order to keep the kde4 installation up to date, each of the modules installed should be updated periodically. As Monday is the day for big changes in kdelibs, Tuesday may be the best day to do this. For each module checked out, run <tt>svn up</tt> and <tt>make</tt>.

For example:
<code bash>
cs kdesupport # cs is not a typo
svn up
cb # cb is not a typo
make install
</code>

Note: it is not necessary to run cmakekde for updates.

== Installing a subset of a module ==

Many modules in KDE contain a large number of programs which could take a long time to download and compile. In cases where you want to work only on a particular program or programs in a module, it is possible to download and compile particular folders. In some cases, certain folders are required for any build of the module. This is determined in the CMakeLists.txt file of the module. For example the [http://websvn.kde.org/branches/KDE/4.0/kdegames/CMakeLists.txt?view=markup kdegames CMakeLists.txt file] lists:

<code>
add_subdirectory(libkdegames)
add_subdirectory(libkmahjongg)

macro_optional_add_subdirectory(doc)
macro_optional_add_subdirectory(lskat)
macro_optional_add_subdirectory(katomic)
</code>

So, the libkdegames and libkmahjongg directories are required to build any of kdegames. The cmake directory will also usually be required. All the other directories (doc, katomic etc) are optional. They will be built if present on your machine. In this example, we build kmahjongg and kbattleship:

<code bash>
cs KDE
svn co -N svn://anonsvn.kde.org/home/kde/trunk/KDE/kdegames # The -N switch performs a non-recursive checkout
cd kdegames
svn co svn://anonsvn.kde.org/home/kde/trunk/KDE/kdegames/libkdegames # Get required directories
svn co svn://anonsvn.kde.org/home/kde/trunk/KDE/kdegames/libkmahjongg
svn co svn://anonsvn.kde.org/home/kde/trunk/KDE/kdegames/cmake
svn co svn://anonsvn.kde.org/home/kde/trunk/KDE/kdegames/kbattleship # Get optional directories
svn co svn://anonsvn.kde.org/home/kde/trunk/KDE/kdegames/kmahjongg
cmakekde
</code>

== Success! ==

You are now ready to start building other svn modules in the same fashion as you built kdebase, running and testing KDE4 or writing your own patches and applications.

For further isolation of your development environment change symbolic links, which you will see after executing ls -lh $(kde4-config --localprefix), assuming newly installed kde4-config is called.

See the [[Getting Started/Set up KDE 4 for development|Set up KDE 4 for development]] tutorial for how to start KDE 4 applications and how to use KDevelop to work on them.

For most of what you need to know on patches see: [[Contribute/Send Patches|Sending Patches]]

[[Category:Build KDE]]
[[Category:KDE4]]
{{Build KDE}}{{Getting Started}}

Getting Started/Build/kdesrc-build

2010-08-30T17:09:27Z

Fulldecent: /* Prerequisites */

{{Template:I18n/Language Navigation Bar|Getting_Started/Build/kdesrc-build}}
== Building KDE using the kdesrc-build tool ==

=== Introduction to kdesvn-build ===

[http://kdesrc-build.kde.org/ kdesrc-build] (formerly kdesvn-build) is a tool to allow users and developers to easily download and build the latest versions of the KDE Software Compilation (KDE SC) from the KDE source code repositories. It automates the following tasks and more:

* Performing the initial checkout.
* Handling updates for modules that are already checked out.
* Setting up the build system for the module.
* Performing the build and install.
* Specifying your CMake options or configure flags (so you don't have to remember them every time).
* Logging build errors so you can review them easier for troubleshooting.

It is not the end-all for your troubles building KDE, [[troubleshooting]] still applies. Many errors that occur using other methods occur here too, you read the log files that are stored for you.

=== Why use kdesrc-build? ===

So why use kdesrc-build? There are several reasons you may like to use it:

# Less manual editing of commands. Instead of having to remember to add the correct options to the cmake command line or configure command, you can setup the options once and then kdesrc-build will use your settings from then on, saving you from wasting time because you forgot to enable a setting.
# Command logging to help debug build failures. kdesrc-build logs all command outputs to a file. This has several advantages:
## When a module fails to build, you already have the error output saved to disk, ready to be viewed and compared with other error messages to aid debugging.
## Quieter output. Even with CMake, the output of Qt or a KDE SC module build can be extensive. kdesrc-build does not show the details of a module build (but will show the progress), instead an overview of the build process is displayed.
# It's just easier. Instead of having to learn how to use the Subversion and git tools, and how to setup a KDE build system, you can specify what modules you want build, where to install them to, and any other options you want and then have kdesrc-build actually do it, even while you're away from the computer or busy doing other things.
# It's easy to step in yourself. kdesrc-build uses a standard source and build directory layout, and calls the same commands you would. So kdesrc-build will not interfere with you performing the build or editing the source yourself if you so choose.

=== Setting up ===

==== Useful Links ====
When using kdesrc-build you may find it beneficial to have a way of searching the source repository so that you know what modules to look for.

* To browse the KDE Subversion repository, use [http://websvn.kde.org/trunk/KDE WebSVN].
* To browse any of the various KDE projects using git, you can go to [http://gitorious.org/ Gitorious].
* The Nokia Qt toolkit used by KDE can be browsed at [http://gitorious.org/+kde-developers/qt/kde-qt the Gitorious kde-qt homepage].

==== Prerequisites ====
kdesrc-build is fairly easy to install and setup, but you also need to have the right software installed to build KDE SC. The requirements to build KDE SC are available as follows:

* KDE SC 4: [[../KDE4#Required_packages_from_your_distribution|KDE 4 Requirements]]

{{note|It is possible to build KDE 3 using older versions of kdesrc-build, but this is not described here.}}

In addition to those listed requirements, kdesrc-build requires the Perl scripting platform to be installed. It is installed by default with most distributions, and is required to build KDE SC anyways. kdesrc-build requires Perl 5.8 or higher.

{{note|kdesrc-build is developed on a Linux system, but it should work on the various BSD distributions as well (although GNU tools may be required).}}

==== Download and install kdesrc-build ====
Once your system is setup to be able to compile the KDE SC, you can download kdesrc-build from its website, [http://kdesrc-build.kde.org/ kdesrc-build.kde.org]. The file you download will contain (at least) the kdesrc-build script and a sample configuration file. Installing kdesrc-build is as simple as saving the file and making it executable. If you'd like, you can move it to a directory in your PATH, however for this example we'll put it into the KDE source directory that we use (~/kdesrc)

<code bash>
mkdir -p ~/kdesrc
cd ~/kdesrc
tar xjvf ~/path/to/kdesrc-build-1.12.tar.bz2
cp kdesrc-build-1.12/kdesrc-build .
</code>

Alternatively, the newest kdesrc-build script (and sample config file) can be pulled directly from svn:
<code bash>
mkdir -p ~/kdesrc
cd ~/kdesrc
export SVN_ROOT=svn://anonsvn.kde.org/home/kde
svn cat $SVN_ROOT/trunk/KDE/kdesdk/scripts/kdesrc-build > kdesrc-build
svn cat $SVN_ROOT/trunk/KDE/kdesdk/scripts/kdesrc-buildrc-sample > ~/.kdesrc-buildrc
chmod +x kdesrc-build
</code>

==== Setup the configuration ====
Now you should [[Getting Started/Build/kdesrc-buildrc|setup your configuration]]. For the most part the defaults in the included kdesrc-buildrc-sample should be sufficient.

Older:
<code bash>
cp ~/kdesvn/kdesvn-build-1.10/kdesvn-buildrc-sample ~/.kdesvn-buildrc
# Now edit the ~/.kdesvn-buildrc
</code>
Newer:
<code bash>
cp ~/kdesrc/kdesrc-build-1.12/kdesrc-buildrc-sample ~/.kdesrc-buildrc
# Now edit the ~/.kdesrc-buildrc
</code>

{{tip|Note that the config file's name begins with a leading ., making it a hidden file. You may need to show hidden files in Dolphin or Konqueror to find the configuration file to edit it. Or, you can edit the sample before copying it to ~/.kdesrc-buildrc.}}

Also, make sure that the modules you'll want to build are included. You'll want the following at the least:

* qt-copy, kdesupport, kdelibs, kdepimlibs, kdebase

Modules are built in the order they appear in your ~/.kdesrc-buildrc, so the first module should be qt-copy, kdelibs should be before any other KDE SC module, and so on.

{{note|The sample configuration file does include these modules by default, you won't need to make many changes unless you'd like to add some modules to the build by uncommenting them.}}

You may want to enable the make-install-prefix option if you are installing KDE SC or Qt to a directory that is not in your home directory. make-install-prefix allows you to run su or sudo during the make install process so you can install files as root, or set certain programs to execute with higher permissions (This is required for certain programs to execute properly).

<pre>module kdelibs
make-install-prefix sudo -S # sudo with no stdin
end module

module kdebase
make-install-prefix sudo -S
end module</pre>

If a module you'd like to build isn't already present, simply add

<pre>module <module-name>
end module</pre> at the end of the ~/.kdesrc-buildrc. <module-name> would be whatever the module is called in the software repository (for instance, kdemultimedia).

===== Git-based modules =====

Some KDE projects use the "git" source-control software instead of Subversion (as part of an eventual planned migration to git). This includes software like Amarok and Konversation.

To build these modules in kdesrc-build, you just need to add a couple of lines to the module configuration. For example, konversation is developed in the git://gitorious.org/konversation/konversation.git repository at [http://gitorious.org/]. So you would just add a module (you can pick whatever name for the module you like, as long as it's not already used):

<pre>module konversation
repository git://gitorious.org/konversation/konversation.git
branch master
end module</pre>

In this case I selected the "master" branch since that is the default git branch.

Now whenever you build konversation, kdesrc-build will use git instead of Subversion.

==== Useful kdesrc-build commands ====
kdesrc-build is driven from the command line, so here's a guide to some of the more useful command line options:

<table cellpadding="2">
<tr>
<th>Option</th><th>Effect</th>
</tr>
<tr>
<td><tt><span style="white-space:nowrap;">[http://kdesrc-build.kde.org/documentation/cmdline.html#cmdline-pretend --pretend]</span></tt> (Short form <tt><span style="white-space:nowrap;">-p</span></tt>)</td>
<td>This option is like a dry run. kdesrc-build will process the options and its configuration like normal, and run through the build as normal, but instead of downloading or running the build will instead output what kdesrc-build would have done. You should always run with -p before running kdesrc-build to make sure it is doing what you expect.</td>
</tr>
<tr>
<td><tt>[http://kdesrc-build.kde.org/documentation/cmdline.html#cmdline-no-svn --no-svn]</tt> (Alt. form <tt>--no-src</tt>)</td><td>This option skips the source code update step. This is useful if you're running kdesrc-build again soon after the last update and don't want to wait to find out there were no changes.</td>
</tr>
<tr>
<td><tt>[http://kdesrc-build.kde.org/documentation/cmdline.html#cmdline-refresh-build --refresh-build]</tt></td><td>This option causes kdesrc-build to delete the current build information for the given modules and start building them again from scratch. This option takes a lot of time but gives the best chance of a successful build.</td>
</tr>
</table>

Any other non-option arguments on the command line are assumed to be modules to build (and are built in the order provided on the command line). If no modules are specified, all of the modules listed in the ~/.kdesrc-buildrc are built in the order listed in the file.

== Build ==
We're almost there. If you're happy with your settings then it's time to test out kdesrc-build. In theory things are as simple as running kdesrc-build and then coming back later. ;)

<code bash>
cd ~/kdesrc
./kdesrc-build
</code>

You may want to test by building qt-copy first however.

<code bash>
cd ~/kdesrc
./kdesrc-build qt-copy
</code>

{{tip|If you have the [http://www.gnu.org/software/screen/ GNU screen] program available then you should definitely use it to run kdesrc-build, as you can detach your kdesrc-build session and logout while kdesrc-build is still running.}}

If the build failed (kdesrc-build will error out with a nice bright red error message) then there are several possibilities:

# You are missing a key piece of required software (such as a development library)
# The KDE SC code being compiled is broken in some fashion to where it won't build. This is commonly due to newly committed code that worked on the developer's machine, or occasionally on Mondays (when incompatible changes are permitted to kdelibs).
# kdesrc-build is not setup properly. You may be trying to install to a directory that you have no permissions to access for instance, or you may have specified a system qtdir that does not exist.
# The module may depend on a newer version of qt-copy or kdelibs (or other module). In this case you'll have to run kdesrc-build to update the out-of-date module first.

How do you find out what the error was? The output of the failing command will be in the log directory. By default, all log output is in the {{path|log}} subdirectory of the KDE SC source directory. The log directory is laid out like this: {{path|log/date-run/module/output-file.log}}. To simplify finding the appropriate file, there are a couple of symlinks created:

{{path|log/latest}} always has the debugging output for the last time kdesrc-build was run (--pretend doesn't count toward this)
{{path|log/latest/<module>/error.log}} has the debugging output for the command that caused a module build to fail.

For instance if qt-copy just failed to build you could read the output like this:

<code bash>
cd ~/kderc
kwrite log/latest/qt-copy/error.log
</code>

Replace kwrite with your preferred editor. Hopefully the output can guide you to resolving the problem. For instance, if the failure is a cmake output saying you're missing a library, install that library and try again. ;) For link errors you can try running a --refresh-build on the module (or if that doesn't work, required libraries like qt-copy and kdelibs).

If you're stumped by the error you may want to wait a day and try updating again, and hope that the reason for the error has been fixed. You can also try mailing the [http://www.kde.org/mailinglists/ kde-devel] mailing list to see if others know about the problem or have had similar issues.

== Running KDE ==

Assuming you got enough of the modules to build and install to have a working KDE installation, you'll still need to setup your environment correctly to run it. kdesrc-build doesn't help you out here (yet), but the instructions at [[../../Increased_Productivity_in_KDE4_with_Scripts/.bashrc|the .bashrc wiki page]] apply just as well, except that you'll need to set the environment variables to the settings that are in your ~/.kdesrc-buildrc.

For the KDEDIRS and KDEDIR variable use the setting of the "prefix" option (in the global section).
For the QTDIR variable use the setting of the "qtdir" option.

{{tip|When copying settings over to the .bashrc, change any ~'s in the paths to $HOME, as the ~ character is not expanded correctly in the .bashrc.}}

Once your .bashrc is setup logout and log back in again and then you should be able to run your new KDE installation.

== Keeping KDE up to date ==

Keeping your KDE installation up to date is as simple as running kdesrc-build again. Every kdesrc-build has these phases:

# Update the source code for all modules being built.
# Build and then install all the modules.

Old build directories are not deleted by default, so the build after a small update will not normally take as long as the initial build of a module. This is called "incremental make". However it may be necessary at times to perform a full rebuild due to inconsistencies between the build directory configuation and changes to the source directory. You can use the --refresh-build option to force a full rebuild.

For more information on how to take advantage of kdesrc-build, see the [http://kdesrc-build.kde.org/documentation online documentation] for kdesrc-build, which describes all of the module options and command line options available for kdesrc-build and gives tips on how to perform various useful tasks.

If you have any questions that are not answered please feel free to add them under the Discussion entry for this page and hopefully someone will be able to get the answer.

[[Category:Build_KDE]]
[[Category:Tutorial]]

Getting Started/Build/kdesrc-build

2010-08-30T17:06:53Z

Fulldecent: /* Setting up */

{{Template:I18n/Language Navigation Bar|Getting_Started/Build/kdesrc-build}}
== Building KDE using the kdesrc-build tool ==

=== Introduction to kdesvn-build ===

[http://kdesrc-build.kde.org/ kdesrc-build] (formerly kdesvn-build) is a tool to allow users and developers to easily download and build the latest versions of the KDE Software Compilation (KDE SC) from the KDE source code repositories. It automates the following tasks and more:

* Performing the initial checkout.
* Handling updates for modules that are already checked out.
* Setting up the build system for the module.
* Performing the build and install.
* Specifying your CMake options or configure flags (so you don't have to remember them every time).
* Logging build errors so you can review them easier for troubleshooting.

It is not the end-all for your troubles building KDE, [[troubleshooting]] still applies. Many errors that occur using other methods occur here too, you read the log files that are stored for you.

=== Why use kdesrc-build? ===

So why use kdesrc-build? There are several reasons you may like to use it:

# Less manual editing of commands. Instead of having to remember to add the correct options to the cmake command line or configure command, you can setup the options once and then kdesrc-build will use your settings from then on, saving you from wasting time because you forgot to enable a setting.
# Command logging to help debug build failures. kdesrc-build logs all command outputs to a file. This has several advantages:
## When a module fails to build, you already have the error output saved to disk, ready to be viewed and compared with other error messages to aid debugging.
## Quieter output. Even with CMake, the output of Qt or a KDE SC module build can be extensive. kdesrc-build does not show the details of a module build (but will show the progress), instead an overview of the build process is displayed.
# It's just easier. Instead of having to learn how to use the Subversion and git tools, and how to setup a KDE build system, you can specify what modules you want build, where to install them to, and any other options you want and then have kdesrc-build actually do it, even while you're away from the computer or busy doing other things.
# It's easy to step in yourself. kdesrc-build uses a standard source and build directory layout, and calls the same commands you would. So kdesrc-build will not interfere with you performing the build or editing the source yourself if you so choose.

=== Setting up ===

==== Useful Links ====
When using kdesrc-build you may find it beneficial to have a way of searching the source repository so that you know what modules to look for.

* To browse the KDE Subversion repository, use [http://websvn.kde.org/trunk/KDE WebSVN].
* To browse any of the various KDE projects using git, you can go to [http://gitorious.org/ Gitorious].
* The Nokia Qt toolkit used by KDE can be browsed at [http://gitorious.org/+kde-developers/qt/kde-qt the Gitorious kde-qt homepage].

==== Prerequisites ====
kdesrc-build is fairly easy to install and setup, but you also need to have the right software installed to build KDE SC. The requirements to build KDE SC are available as follows:

* KDE SC 4: [[../KDE4#Required Software|KDE 4 Requirements]]

{{note|It is possible to build KDE 3 using older versions of kdesrc-build, but this is not described here.}}

In addition to those listed requirements, kdesrc-build requires the Perl scripting platform to be installed. It is installed by default with most distributions, and is required to build KDE SC anyways. kdesrc-build requires Perl 5.8 or higher.

{{note|kdesrc-build is developed on a Linux system, but it should work on the various BSD distributions as well (although GNU tools may be required).}}

==== Download and install kdesrc-build ====
Once your system is setup to be able to compile the KDE SC, you can download kdesrc-build from its website, [http://kdesrc-build.kde.org/ kdesrc-build.kde.org]. The file you download will contain (at least) the kdesrc-build script and a sample configuration file. Installing kdesrc-build is as simple as saving the file and making it executable. If you'd like, you can move it to a directory in your PATH, however for this example we'll put it into the KDE source directory that we use (~/kdesrc)

<code bash>
mkdir -p ~/kdesrc
cd ~/kdesrc
tar xjvf ~/path/to/kdesrc-build-1.12.tar.bz2
cp kdesrc-build-1.12/kdesrc-build .
</code>

Alternatively, the newest kdesrc-build script (and sample config file) can be pulled directly from svn:
<code bash>
mkdir -p ~/kdesrc
cd ~/kdesrc
export SVN_ROOT=svn://anonsvn.kde.org/home/kde
svn cat $SVN_ROOT/trunk/KDE/kdesdk/scripts/kdesrc-build > kdesrc-build
svn cat $SVN_ROOT/trunk/KDE/kdesdk/scripts/kdesrc-buildrc-sample > ~/.kdesrc-buildrc
chmod +x kdesrc-build
</code>

==== Setup the configuration ====
Now you should [[Getting Started/Build/kdesrc-buildrc|setup your configuration]]. For the most part the defaults in the included kdesrc-buildrc-sample should be sufficient.

Older:
<code bash>
cp ~/kdesvn/kdesvn-build-1.10/kdesvn-buildrc-sample ~/.kdesvn-buildrc
# Now edit the ~/.kdesvn-buildrc
</code>
Newer:
<code bash>
cp ~/kdesrc/kdesrc-build-1.12/kdesrc-buildrc-sample ~/.kdesrc-buildrc
# Now edit the ~/.kdesrc-buildrc
</code>

{{tip|Note that the config file's name begins with a leading ., making it a hidden file. You may need to show hidden files in Dolphin or Konqueror to find the configuration file to edit it. Or, you can edit the sample before copying it to ~/.kdesrc-buildrc.}}

Also, make sure that the modules you'll want to build are included. You'll want the following at the least:

* qt-copy, kdesupport, kdelibs, kdepimlibs, kdebase

Modules are built in the order they appear in your ~/.kdesrc-buildrc, so the first module should be qt-copy, kdelibs should be before any other KDE SC module, and so on.

{{note|The sample configuration file does include these modules by default, you won't need to make many changes unless you'd like to add some modules to the build by uncommenting them.}}

You may want to enable the make-install-prefix option if you are installing KDE SC or Qt to a directory that is not in your home directory. make-install-prefix allows you to run su or sudo during the make install process so you can install files as root, or set certain programs to execute with higher permissions (This is required for certain programs to execute properly).

<pre>module kdelibs
make-install-prefix sudo -S # sudo with no stdin
end module

module kdebase
make-install-prefix sudo -S
end module</pre>

If a module you'd like to build isn't already present, simply add

<pre>module <module-name>
end module</pre> at the end of the ~/.kdesrc-buildrc. <module-name> would be whatever the module is called in the software repository (for instance, kdemultimedia).

===== Git-based modules =====

Some KDE projects use the "git" source-control software instead of Subversion (as part of an eventual planned migration to git). This includes software like Amarok and Konversation.

To build these modules in kdesrc-build, you just need to add a couple of lines to the module configuration. For example, konversation is developed in the git://gitorious.org/konversation/konversation.git repository at [http://gitorious.org/]. So you would just add a module (you can pick whatever name for the module you like, as long as it's not already used):

<pre>module konversation
repository git://gitorious.org/konversation/konversation.git
branch master
end module</pre>

In this case I selected the "master" branch since that is the default git branch.

Now whenever you build konversation, kdesrc-build will use git instead of Subversion.

==== Useful kdesrc-build commands ====
kdesrc-build is driven from the command line, so here's a guide to some of the more useful command line options:

<table cellpadding="2">
<tr>
<th>Option</th><th>Effect</th>
</tr>
<tr>
<td><tt><span style="white-space:nowrap;">[http://kdesrc-build.kde.org/documentation/cmdline.html#cmdline-pretend --pretend]</span></tt> (Short form <tt><span style="white-space:nowrap;">-p</span></tt>)</td>
<td>This option is like a dry run. kdesrc-build will process the options and its configuration like normal, and run through the build as normal, but instead of downloading or running the build will instead output what kdesrc-build would have done. You should always run with -p before running kdesrc-build to make sure it is doing what you expect.</td>
</tr>
<tr>
<td><tt>[http://kdesrc-build.kde.org/documentation/cmdline.html#cmdline-no-svn --no-svn]</tt> (Alt. form <tt>--no-src</tt>)</td><td>This option skips the source code update step. This is useful if you're running kdesrc-build again soon after the last update and don't want to wait to find out there were no changes.</td>
</tr>
<tr>
<td><tt>[http://kdesrc-build.kde.org/documentation/cmdline.html#cmdline-refresh-build --refresh-build]</tt></td><td>This option causes kdesrc-build to delete the current build information for the given modules and start building them again from scratch. This option takes a lot of time but gives the best chance of a successful build.</td>
</tr>
</table>

Any other non-option arguments on the command line are assumed to be modules to build (and are built in the order provided on the command line). If no modules are specified, all of the modules listed in the ~/.kdesrc-buildrc are built in the order listed in the file.

== Build ==
We're almost there. If you're happy with your settings then it's time to test out kdesrc-build. In theory things are as simple as running kdesrc-build and then coming back later. ;)

<code bash>
cd ~/kdesrc
./kdesrc-build
</code>

You may want to test by building qt-copy first however.

<code bash>
cd ~/kdesrc
./kdesrc-build qt-copy
</code>

{{tip|If you have the [http://www.gnu.org/software/screen/ GNU screen] program available then you should definitely use it to run kdesrc-build, as you can detach your kdesrc-build session and logout while kdesrc-build is still running.}}

If the build failed (kdesrc-build will error out with a nice bright red error message) then there are several possibilities:

# You are missing a key piece of required software (such as a development library)
# The KDE SC code being compiled is broken in some fashion to where it won't build. This is commonly due to newly committed code that worked on the developer's machine, or occasionally on Mondays (when incompatible changes are permitted to kdelibs).
# kdesrc-build is not setup properly. You may be trying to install to a directory that you have no permissions to access for instance, or you may have specified a system qtdir that does not exist.
# The module may depend on a newer version of qt-copy or kdelibs (or other module). In this case you'll have to run kdesrc-build to update the out-of-date module first.

How do you find out what the error was? The output of the failing command will be in the log directory. By default, all log output is in the {{path|log}} subdirectory of the KDE SC source directory. The log directory is laid out like this: {{path|log/date-run/module/output-file.log}}. To simplify finding the appropriate file, there are a couple of symlinks created:

{{path|log/latest}} always has the debugging output for the last time kdesrc-build was run (--pretend doesn't count toward this)
{{path|log/latest/<module>/error.log}} has the debugging output for the command that caused a module build to fail.

For instance if qt-copy just failed to build you could read the output like this:

<code bash>
cd ~/kderc
kwrite log/latest/qt-copy/error.log
</code>

Replace kwrite with your preferred editor. Hopefully the output can guide you to resolving the problem. For instance, if the failure is a cmake output saying you're missing a library, install that library and try again. ;) For link errors you can try running a --refresh-build on the module (or if that doesn't work, required libraries like qt-copy and kdelibs).

If you're stumped by the error you may want to wait a day and try updating again, and hope that the reason for the error has been fixed. You can also try mailing the [http://www.kde.org/mailinglists/ kde-devel] mailing list to see if others know about the problem or have had similar issues.

== Running KDE ==

Assuming you got enough of the modules to build and install to have a working KDE installation, you'll still need to setup your environment correctly to run it. kdesrc-build doesn't help you out here (yet), but the instructions at [[../../Increased_Productivity_in_KDE4_with_Scripts/.bashrc|the .bashrc wiki page]] apply just as well, except that you'll need to set the environment variables to the settings that are in your ~/.kdesrc-buildrc.

For the KDEDIRS and KDEDIR variable use the setting of the "prefix" option (in the global section).
For the QTDIR variable use the setting of the "qtdir" option.

{{tip|When copying settings over to the .bashrc, change any ~'s in the paths to $HOME, as the ~ character is not expanded correctly in the .bashrc.}}

Once your .bashrc is setup logout and log back in again and then you should be able to run your new KDE installation.

== Keeping KDE up to date ==

Keeping your KDE installation up to date is as simple as running kdesrc-build again. Every kdesrc-build has these phases:

# Update the source code for all modules being built.
# Build and then install all the modules.

Old build directories are not deleted by default, so the build after a small update will not normally take as long as the initial build of a module. This is called "incremental make". However it may be necessary at times to perform a full rebuild due to inconsistencies between the build directory configuation and changes to the source directory. You can use the --refresh-build option to force a full rebuild.

For more information on how to take advantage of kdesrc-build, see the [http://kdesrc-build.kde.org/documentation online documentation] for kdesrc-build, which describes all of the module options and command line options available for kdesrc-build and gives tips on how to perform various useful tasks.

If you have any questions that are not answered please feel free to add them under the Discussion entry for this page and hopefully someone will be able to get the answer.

[[Category:Build_KDE]]
[[Category:Tutorial]]

Getting Started/Build/kdesrc-build

2010-08-30T17:05:52Z

Fulldecent: /* Introduction to kdesvn-build */

{{Template:I18n/Language Navigation Bar|Getting_Started/Build/kdesrc-build}}
== Building KDE using the kdesrc-build tool ==

=== Introduction to kdesvn-build ===

[http://kdesrc-build.kde.org/ kdesrc-build] (formerly kdesvn-build) is a tool to allow users and developers to easily download and build the latest versions of the KDE Software Compilation (KDE SC) from the KDE source code repositories. It automates the following tasks and more:

* Performing the initial checkout.
* Handling updates for modules that are already checked out.
* Setting up the build system for the module.
* Performing the build and install.
* Specifying your CMake options or configure flags (so you don't have to remember them every time).
* Logging build errors so you can review them easier for troubleshooting.

It is not the end-all for your troubles building KDE, [[troubleshooting]] still applies. Many errors that occur using other methods occur here too, you read the log files that are stored for you.

=== Why use kdesrc-build? ===

So why use kdesrc-build? There are several reasons you may like to use it:

# Less manual editing of commands. Instead of having to remember to add the correct options to the cmake command line or configure command, you can setup the options once and then kdesrc-build will use your settings from then on, saving you from wasting time because you forgot to enable a setting.
# Command logging to help debug build failures. kdesrc-build logs all command outputs to a file. This has several advantages:
## When a module fails to build, you already have the error output saved to disk, ready to be viewed and compared with other error messages to aid debugging.
## Quieter output. Even with CMake, the output of Qt or a KDE SC module build can be extensive. kdesrc-build does not show the details of a module build (but will show the progress), instead an overview of the build process is displayed.
# It's just easier. Instead of having to learn how to use the Subversion and git tools, and how to setup a KDE build system, you can specify what modules you want build, where to install them to, and any other options you want and then have kdesrc-build actually do it, even while you're away from the computer or busy doing other things.
# It's easy to step in yourself. kdesrc-build uses a standard source and build directory layout, and calls the same commands you would. So kdesrc-build will not interfere with you performing the build or editing the source yourself if you so choose.

=== Setting up ===

==== Useful Links ====
When using kdesrc-build you may find it beneficial to have a way of searching the source repository so that you know what modules to look for.

* To browse the KDE Subversion repository, use
[http://websvn.kde.org/trunk/KDE WebSVN].
* To browse any of the various KDE projects using git, you can go to [http://gitorious.org/ Gitorious].
* The Nokia Qt toolkit used by KDE can be browsed at [http://gitorious.org/+kde-developers/qt/kde-qt the Gitorious kde-qt homepage].

==== Prerequisites ====
kdesrc-build is fairly easy to install and setup, but you also need to have the right software installed to build KDE SC. The requirements to build KDE SC are available as follows:

* KDE SC 4: [[../KDE4#Required Software|KDE 4 Requirements]]

{{note|It is possible to build KDE 3 using older versions of kdesrc-build, but this is not described here.}}

In addition to those listed requirements, kdesrc-build requires the Perl scripting platform to be installed. It is installed by default with most distributions, and is required to build KDE SC anyways. kdesrc-build requires Perl 5.8 or higher.

{{note|kdesrc-build is developed on a Linux system, but it should work on the various BSD distributions as well (although GNU tools may be required).}}

==== Download and install kdesrc-build ====
Once your system is setup to be able to compile the KDE SC, you can download kdesrc-build from its website, [http://kdesrc-build.kde.org/ kdesrc-build.kde.org]. The file you download will contain (at least) the kdesrc-build script and a sample configuration file. Installing kdesrc-build is as simple as saving the file and making it executable. If you'd like, you can move it to a directory in your PATH, however for this example we'll put it into the KDE source directory that we use (~/kdesrc)

<code bash>
mkdir -p ~/kdesrc
cd ~/kdesrc
tar xjvf ~/path/to/kdesrc-build-1.12.tar.bz2
cp kdesrc-build-1.12/kdesrc-build .
</code>

Alternatively, the newest kdesrc-build script (and sample config file) can be pulled directly from svn:
<code bash>
mkdir -p ~/kdesrc
cd ~/kdesrc
export SVN_ROOT=svn://anonsvn.kde.org/home/kde
svn cat $SVN_ROOT/trunk/KDE/kdesdk/scripts/kdesrc-build > kdesrc-build
svn cat $SVN_ROOT/trunk/KDE/kdesdk/scripts/kdesrc-buildrc-sample > ~/.kdesrc-buildrc
chmod +x kdesrc-build
</code>

==== Setup the configuration ====
Now you should [[Getting Started/Build/kdesrc-buildrc|setup your configuration]]. For the most part the defaults in the included kdesrc-buildrc-sample should be sufficient.

Older:
<code bash>
cp ~/kdesvn/kdesvn-build-1.10/kdesvn-buildrc-sample ~/.kdesvn-buildrc
# Now edit the ~/.kdesvn-buildrc
</code>
Newer:
<code bash>
cp ~/kdesrc/kdesrc-build-1.12/kdesrc-buildrc-sample ~/.kdesrc-buildrc
# Now edit the ~/.kdesrc-buildrc
</code>

{{tip|Note that the config file's name begins with a leading ., making it a hidden file. You may need to show hidden files in Dolphin or Konqueror to find the configuration file to edit it. Or, you can edit the sample before copying it to ~/.kdesrc-buildrc.}}

Also, make sure that the modules you'll want to build are included. You'll want the following at the least:

* qt-copy, kdesupport, kdelibs, kdepimlibs, kdebase

Modules are built in the order they appear in your ~/.kdesrc-buildrc, so the first module should be qt-copy, kdelibs should be before any other KDE SC module, and so on.

{{note|The sample configuration file does include these modules by default, you won't need to make many changes unless you'd like to add some modules to the build by uncommenting them.}}

You may want to enable the make-install-prefix option if you are installing KDE SC or Qt to a directory that is not in your home directory. make-install-prefix allows you to run su or sudo during the make install process so you can install files as root, or set certain programs to execute with higher permissions (This is required for certain programs to execute properly).

<pre>module kdelibs
make-install-prefix sudo -S # sudo with no stdin
end module

module kdebase
make-install-prefix sudo -S
end module</pre>

If a module you'd like to build isn't already present, simply add

<pre>module <module-name>
end module</pre> at the end of the ~/.kdesrc-buildrc. <module-name> would be whatever the module is called in the software repository (for instance, kdemultimedia).

===== Git-based modules =====

Some KDE projects use the "git" source-control software instead of Subversion (as part of an eventual planned migration to git). This includes software like Amarok and Konversation.

To build these modules in kdesrc-build, you just need to add a couple of lines to the module configuration. For example, konversation is developed in the git://gitorious.org/konversation/konversation.git repository at [http://gitorious.org/]. So you would just add a module (you can pick whatever name for the module you like, as long as it's not already used):

<pre>module konversation
repository git://gitorious.org/konversation/konversation.git
branch master
end module</pre>

In this case I selected the "master" branch since that is the default git branch.

Now whenever you build konversation, kdesrc-build will use git instead of Subversion.

==== Useful kdesrc-build commands ====
kdesrc-build is driven from the command line, so here's a guide to some of the more useful command line options:

<table cellpadding="2">
<tr>
<th>Option</th><th>Effect</th>
</tr>
<tr>
<td><tt><span style="white-space:nowrap;">[http://kdesrc-build.kde.org/documentation/cmdline.html#cmdline-pretend --pretend]</span></tt> (Short form <tt><span style="white-space:nowrap;">-p</span></tt>)</td>
<td>This option is like a dry run. kdesrc-build will process the options and its configuration like normal, and run through the build as normal, but instead of downloading or running the build will instead output what kdesrc-build would have done. You should always run with -p before running kdesrc-build to make sure it is doing what you expect.</td>
</tr>
<tr>
<td><tt>[http://kdesrc-build.kde.org/documentation/cmdline.html#cmdline-no-svn --no-svn]</tt> (Alt. form <tt>--no-src</tt>)</td><td>This option skips the source code update step. This is useful if you're running kdesrc-build again soon after the last update and don't want to wait to find out there were no changes.</td>
</tr>
<tr>
<td><tt>[http://kdesrc-build.kde.org/documentation/cmdline.html#cmdline-refresh-build --refresh-build]</tt></td><td>This option causes kdesrc-build to delete the current build information for the given modules and start building them again from scratch. This option takes a lot of time but gives the best chance of a successful build.</td>
</tr>
</table>

Any other non-option arguments on the command line are assumed to be modules to build (and are built in the order provided on the command line). If no modules are specified, all of the modules listed in the ~/.kdesrc-buildrc are built in the order listed in the file.

== Build ==
We're almost there. If you're happy with your settings then it's time to test out kdesrc-build. In theory things are as simple as running kdesrc-build and then coming back later. ;)

<code bash>
cd ~/kdesrc
./kdesrc-build
</code>

You may want to test by building qt-copy first however.

<code bash>
cd ~/kdesrc
./kdesrc-build qt-copy
</code>

{{tip|If you have the [http://www.gnu.org/software/screen/ GNU screen] program available then you should definitely use it to run kdesrc-build, as you can detach your kdesrc-build session and logout while kdesrc-build is still running.}}

If the build failed (kdesrc-build will error out with a nice bright red error message) then there are several possibilities:

# You are missing a key piece of required software (such as a development library)
# The KDE SC code being compiled is broken in some fashion to where it won't build. This is commonly due to newly committed code that worked on the developer's machine, or occasionally on Mondays (when incompatible changes are permitted to kdelibs).
# kdesrc-build is not setup properly. You may be trying to install to a directory that you have no permissions to access for instance, or you may have specified a system qtdir that does not exist.
# The module may depend on a newer version of qt-copy or kdelibs (or other module). In this case you'll have to run kdesrc-build to update the out-of-date module first.

How do you find out what the error was? The output of the failing command will be in the log directory. By default, all log output is in the {{path|log}} subdirectory of the KDE SC source directory. The log directory is laid out like this: {{path|log/date-run/module/output-file.log}}. To simplify finding the appropriate file, there are a couple of symlinks created:

{{path|log/latest}} always has the debugging output for the last time kdesrc-build was run (--pretend doesn't count toward this)
{{path|log/latest/<module>/error.log}} has the debugging output for the command that caused a module build to fail.

For instance if qt-copy just failed to build you could read the output like this:

<code bash>
cd ~/kderc
kwrite log/latest/qt-copy/error.log
</code>

Replace kwrite with your preferred editor. Hopefully the output can guide you to resolving the problem. For instance, if the failure is a cmake output saying you're missing a library, install that library and try again. ;) For link errors you can try running a --refresh-build on the module (or if that doesn't work, required libraries like qt-copy and kdelibs).

If you're stumped by the error you may want to wait a day and try updating again, and hope that the reason for the error has been fixed. You can also try mailing the [http://www.kde.org/mailinglists/ kde-devel] mailing list to see if others know about the problem or have had similar issues.

== Running KDE ==

Assuming you got enough of the modules to build and install to have a working KDE installation, you'll still need to setup your environment correctly to run it. kdesrc-build doesn't help you out here (yet), but the instructions at [[../../Increased_Productivity_in_KDE4_with_Scripts/.bashrc|the .bashrc wiki page]] apply just as well, except that you'll need to set the environment variables to the settings that are in your ~/.kdesrc-buildrc.

For the KDEDIRS and KDEDIR variable use the setting of the "prefix" option (in the global section).
For the QTDIR variable use the setting of the "qtdir" option.

{{tip|When copying settings over to the .bashrc, change any ~'s in the paths to $HOME, as the ~ character is not expanded correctly in the .bashrc.}}

Once your .bashrc is setup logout and log back in again and then you should be able to run your new KDE installation.

== Keeping KDE up to date ==

Keeping your KDE installation up to date is as simple as running kdesrc-build again. Every kdesrc-build has these phases:

# Update the source code for all modules being built.
# Build and then install all the modules.

Old build directories are not deleted by default, so the build after a small update will not normally take as long as the initial build of a module. This is called "incremental make". However it may be necessary at times to perform a full rebuild due to inconsistencies between the build directory configuation and changes to the source directory. You can use the --refresh-build option to force a full rebuild.

For more information on how to take advantage of kdesrc-build, see the [http://kdesrc-build.kde.org/documentation online documentation] for kdesrc-build, which describes all of the module options and command line options available for kdesrc-build and gives tips on how to perform various useful tasks.

If you have any questions that are not answered please feel free to add them under the Discussion entry for this page and hopefully someone will be able to get the answer.

[[Category:Build_KDE]]
[[Category:Tutorial]]

Getting Started/Build/kdesrc-build

2010-08-30T17:04:27Z

Fulldecent: /* Introduction to kdesvn-build */

{{Template:I18n/Language Navigation Bar|Getting_Started/Build/kdesrc-build}}
== Building KDE using the kdesrc-build tool ==

=== Introduction to kdesvn-build ===

[http://kdesrc-build.kde.org/ kdesrc-build] (formerly kdesvn-build) is a tool to allow users and developers to easily download and build the latest versions of the KDE Software Compilation (KDE SC) from the KDE source code repositories. It automates the following tasks and more:

* Performing the initial checkout.
* Handling updates for modules that are already checked out.
* Setting up the build system for the module.
* Performing the build and install.
* Specifying your CMake options or configure flags (so you don't have to remember them every time).
* Logging build errors so you can review them easier for troubleshooting.

It is not the end-all for your troubles building KDE, [[troubleshooting]] still applies. Many errors that occur using other methods occur here too, you read the log files that are stored for you.

=== Why use kdesrc-build? ===

So why use kdesrc-build? There are several reasons you may like to use it:

# Less manual editing of commands. Instead of having to remember to add the correct options to the cmake command line or configure command, you can setup the options once and then kdesrc-build will use your settings from then on, saving you from wasting time because you forgot to enable a setting.
# Command logging to help debug build failures. kdesrc-build logs all command outputs to a file. This has several advantages:
## When a module fails to build, you already have the error output saved to disk, ready to be viewed and compared with other error messages to aid debugging.
## Quieter output. Even with CMake, the output of Qt or a KDE SC module build can be extensive. kdesrc-build does not show the details of a module build (but will show the progress), instead an overview of the build process is displayed.
# It's just easier. Instead of having to learn how to use the Subversion and git tools, and how to setup a KDE build system, you can specify what modules you want build, where to install them to, and any other options you want and then have kdesrc-build actually do it, even while you're away from the computer or busy doing other things.
# It's easy to step in yourself. kdesrc-build uses a standard source and build directory layout, and calls the same commands you would. So kdesrc-build will not interfere with you performing the build or editing the source yourself if you so choose.

=== Setting up ===

==== Useful Links ====
When using kdesrc-build you may find it beneficial to have a way of searching the source repository so that you know what modules to look for.

* To browse the KDE Subversion repository, use
[http://websvn.kde.org/trunk/KDE WebSVN].
* To browse any of the various KDE projects using git, you can go to [http://gitorious.org/ Gitorious].
* The Nokia Qt toolkit used by KDE can be browsed at [http://gitorious.org/+kde-developers/qt/kde-qt the Gitorious kde-qt homepage].

==== Prerequisites ====
kdesrc-build is fairly easy to install and setup, but you also need to have the right software installed to build KDE SC. The requirements to build KDE SC are available as follows:

* KDE SC 4: [[../KDE4#Required Software|KDE 4 Requirements]]

{{note|It is possible to build KDE 3 using older versions of kdesrc-build, but this is not described here.}}

In addition to those listed requirements, kdesrc-build requires the Perl scripting platform to be installed. It is installed by default with most distributions, and is required to build KDE SC anyways. kdesrc-build requires Perl 5.8 or higher.

{{note|kdesrc-build is developed on a Linux system, but it should work on the various BSD distributions as well (although GNU tools may be required).}}

==== Download and install kdesrc-build ====
Once your system is setup to be able to compile the KDE SC, you can download kdesrc-build from its website, [http://kdesrc-build.kde.org/ kdesrc-build.kde.org]. The file you download will contain (at least) the kdesrc-build script and a sample configuration file. Installing kdesrc-build is as simple as saving the file and making it executable. If you'd like, you can move it to a directory in your PATH, however for this example we'll put it into the KDE source directory that we use (~/kdesrc)

<code bash>
mkdir -p ~/kdesrc
cd ~/kdesrc
tar xjvf ~/path/to/kdesrc-build-1.12.tar.bz2
cp kdesrc-build-1.12/kdesrc-build .
</code>

Alternatively, the newest kdesrc-build script (and sample config file) can be pulled directly from svn:
<code bash>
mkdir -p ~/kdesrc
cd ~/kdesrc
export SVN_ROOT=svn://anonsvn.kde.org/home/kde
svn cat $SVN_ROOT/trunk/KDE/kdesdk/scripts/kdesrc-build > kdesrc-build
svn cat $SVN_ROOT/trunk/KDE/kdesdk/scripts/kdesrc-buildrc-sample > ~/.kdesrc-buildrc
chmod +x kdesrc-build
</code>

==== Setup the configuration ====
Now you should [[Getting Started/Build/kdesrc-buildrc|setup your configuration]]. For the most part the defaults in the included kdesrc-buildrc-sample should be sufficient.

Older:
<code bash>
cp ~/kdesvn/kdesvn-build-1.10/kdesvn-buildrc-sample ~/.kdesvn-buildrc
# Now edit the ~/.kdesvn-buildrc
</code>
Newer:
<code bash>
cp ~/kdesrc/kdesrc-build-1.12/kdesrc-buildrc-sample ~/.kdesrc-buildrc
# Now edit the ~/.kdesrc-buildrc
</code>

{{tip|Note that the config file's name begins with a leading ., making it a hidden file. You may need to show hidden files in Dolphin or Konqueror to find the configuration file to edit it. Or, you can edit the sample before copying it to ~/.kdesrc-buildrc.}}

Also, make sure that the modules you'll want to build are included. You'll want the following at the least:

* qt-copy, kdesupport, kdelibs, kdepimlibs, kdebase

Modules are built in the order they appear in your ~/.kdesrc-buildrc, so the first module should be qt-copy, kdelibs should be before any other KDE SC module, and so on.

{{note|The sample configuration file does include these modules by default, you won't need to make many changes unless you'd like to add some modules to the build by uncommenting them.}}

You may want to enable the make-install-prefix option if you are installing KDE SC or Qt to a directory that is not in your home directory. make-install-prefix allows you to run su or sudo during the make install process so you can install files as root, or set certain programs to execute with higher permissions (This is required for certain programs to execute properly).

<pre>module kdelibs
make-install-prefix sudo -S # sudo with no stdin
end module

module kdebase
make-install-prefix sudo -S
end module</pre>

If a module you'd like to build isn't already present, simply add

<pre>module <module-name>
end module</pre> at the end of the ~/.kdesrc-buildrc. <module-name> would be whatever the module is called in the software repository (for instance, kdemultimedia).

===== Git-based modules =====

Some KDE projects use the "git" source-control software instead of Subversion (as part of an eventual planned migration to git). This includes software like Amarok and Konversation.

To build these modules in kdesrc-build, you just need to add a couple of lines to the module configuration. For example, konversation is developed in the git://gitorious.org/konversation/konversation.git repository at [http://gitorious.org/]. So you would just add a module (you can pick whatever name for the module you like, as long as it's not already used):

<pre>module konversation
repository git://gitorious.org/konversation/konversation.git
branch master
end module</pre>

In this case I selected the "master" branch since that is the default git branch.

Now whenever you build konversation, kdesrc-build will use git instead of Subversion.

==== Useful kdesrc-build commands ====
kdesrc-build is driven from the command line, so here's a guide to some of the more useful command line options:

<table cellpadding="2">
<tr>
<th>Option</th><th>Effect</th>
</tr>
<tr>
<td><tt><span style="white-space:nowrap;">[http://kdesrc-build.kde.org/documentation/cmdline.html#cmdline-pretend --pretend]</span></tt> (Short form <tt><span style="white-space:nowrap;">-p</span></tt>)</td>
<td>This option is like a dry run. kdesrc-build will process the options and its configuration like normal, and run through the build as normal, but instead of downloading or running the build will instead output what kdesrc-build would have done. You should always run with -p before running kdesrc-build to make sure it is doing what you expect.</td>
</tr>
<tr>
<td><tt>[http://kdesrc-build.kde.org/documentation/cmdline.html#cmdline-no-svn --no-svn]</tt> (Alt. form <tt>--no-src</tt>)</td><td>This option skips the source code update step. This is useful if you're running kdesrc-build again soon after the last update and don't want to wait to find out there were no changes.</td>
</tr>
<tr>
<td><tt>[http://kdesrc-build.kde.org/documentation/cmdline.html#cmdline-refresh-build --refresh-build]</tt></td><td>This option causes kdesrc-build to delete the current build information for the given modules and start building them again from scratch. This option takes a lot of time but gives the best chance of a successful build.</td>
</tr>
</table>

Any other non-option arguments on the command line are assumed to be modules to build (and are built in the order provided on the command line). If no modules are specified, all of the modules listed in the ~/.kdesrc-buildrc are built in the order listed in the file.

== Build ==
We're almost there. If you're happy with your settings then it's time to test out kdesrc-build. In theory things are as simple as running kdesrc-build and then coming back later. ;)

<code bash>
cd ~/kdesrc
./kdesrc-build
</code>

You may want to test by building qt-copy first however.

<code bash>
cd ~/kdesrc
./kdesrc-build qt-copy
</code>

{{tip|If you have the [http://www.gnu.org/software/screen/ GNU screen] program available then you should definitely use it to run kdesrc-build, as you can detach your kdesrc-build session and logout while kdesrc-build is still running.}}

If the build failed (kdesrc-build will error out with a nice bright red error message) then there are several possibilities:

# You are missing a key piece of required software (such as a development library)
# The KDE SC code being compiled is broken in some fashion to where it won't build. This is commonly due to newly committed code that worked on the developer's machine, or occasionally on Mondays (when incompatible changes are permitted to kdelibs).
# kdesrc-build is not setup properly. You may be trying to install to a directory that you have no permissions to access for instance, or you may have specified a system qtdir that does not exist.
# The module may depend on a newer version of qt-copy or kdelibs (or other module). In this case you'll have to run kdesrc-build to update the out-of-date module first.

How do you find out what the error was? The output of the failing command will be in the log directory. By default, all log output is in the {{path|log}} subdirectory of the KDE SC source directory. The log directory is laid out like this: {{path|log/date-run/module/output-file.log}}. To simplify finding the appropriate file, there are a couple of symlinks created:

{{path|log/latest}} always has the debugging output for the last time kdesrc-build was run (--pretend doesn't count toward this)
{{path|log/latest/<module>/error.log}} has the debugging output for the command that caused a module build to fail.

For instance if qt-copy just failed to build you could read the output like this:

<code bash>
cd ~/kderc
kwrite log/latest/qt-copy/error.log
</code>

Replace kwrite with your preferred editor. Hopefully the output can guide you to resolving the problem. For instance, if the failure is a cmake output saying you're missing a library, install that library and try again. ;) For link errors you can try running a --refresh-build on the module (or if that doesn't work, required libraries like qt-copy and kdelibs).

If you're stumped by the error you may want to wait a day and try updating again, and hope that the reason for the error has been fixed. You can also try mailing the [http://www.kde.org/mailinglists/ kde-devel] mailing list to see if others know about the problem or have had similar issues.

== Running KDE ==

Assuming you got enough of the modules to build and install to have a working KDE installation, you'll still need to setup your environment correctly to run it. kdesrc-build doesn't help you out here (yet), but the instructions at [[../../Increased_Productivity_in_KDE4_with_Scripts/.bashrc|the .bashrc wiki page]] apply just as well, except that you'll need to set the environment variables to the settings that are in your ~/.kdesrc-buildrc.

For the KDEDIRS and KDEDIR variable use the setting of the "prefix" option (in the global section).
For the QTDIR variable use the setting of the "qtdir" option.

{{tip|When copying settings over to the .bashrc, change any ~'s in the paths to $HOME, as the ~ character is not expanded correctly in the .bashrc.}}

Once your .bashrc is setup logout and log back in again and then you should be able to run your new KDE installation.

== Keeping KDE up to date ==

Keeping your KDE installation up to date is as simple as running kdesrc-build again. Every kdesrc-build has these phases:

# Update the source code for all modules being built.
# Build and then install all the modules.

Old build directories are not deleted by default, so the build after a small update will not normally take as long as the initial build of a module. This is called "incremental make". However it may be necessary at times to perform a full rebuild due to inconsistencies between the build directory configuation and changes to the source directory. You can use the --refresh-build option to force a full rebuild.

For more information on how to take advantage of kdesrc-build, see the [http://kdesrc-build.kde.org/documentation online documentation] for kdesrc-build, which describes all of the module options and command line options available for kdesrc-build and gives tips on how to perform various useful tasks.

If you have any questions that are not answered please feel free to add them under the Discussion entry for this page and hopefully someone will be able to get the answer.

[[Category:Build_KDE]]
[[Category:Tutorial]]

Getting Started/Build/kdesrc-build

2010-08-30T17:03:13Z

Fulldecent: /* Introduction to kdesvn-build */

{{Template:I18n/Language Navigation Bar|Getting_Started/Build/kdesrc-build}}
== Building KDE using the kdesrc-build tool ==

=== Introduction to kdesvn-build ===

[http://kdesrc-build.kde.org/ kdesrc-build] (formerly kdesvn-build) is a tool to allow users and developers to easily download and build the latest versions of the KDE Software Compilation (KDE SC) from the KDE source code repositories. It automates the following tasks and more:

Many errors that occur using other methods occur here too, you read the log files that are stored for you.

* Performing the initial checkout.
* Handling updates for modules that are already checked out.
* Setting up the build system for the module.
* Performing the build and install.
* Specifying your CMake options or configure flags (so you don't have to remember them every time).
* Logging build errors so you can review them easier for troubleshooting.

It is not the end-all for your troubles building KDE, [[troubleshooting]] still applies

=== Why use kdesrc-build? ===

So why use kdesrc-build? There are several reasons you may like to use it:

# Less manual editing of commands. Instead of having to remember to add the correct options to the cmake command line or configure command, you can setup the options once and then kdesrc-build will use your settings from then on, saving you from wasting time because you forgot to enable a setting.
# Command logging to help debug build failures. kdesrc-build logs all command outputs to a file. This has several advantages:
## When a module fails to build, you already have the error output saved to disk, ready to be viewed and compared with other error messages to aid debugging.
## Quieter output. Even with CMake, the output of Qt or a KDE SC module build can be extensive. kdesrc-build does not show the details of a module build (but will show the progress), instead an overview of the build process is displayed.
# It's just easier. Instead of having to learn how to use the Subversion and git tools, and how to setup a KDE build system, you can specify what modules you want build, where to install them to, and any other options you want and then have kdesrc-build actually do it, even while you're away from the computer or busy doing other things.
# It's easy to step in yourself. kdesrc-build uses a standard source and build directory layout, and calls the same commands you would. So kdesrc-build will not interfere with you performing the build or editing the source yourself if you so choose.

=== Setting up ===

==== Useful Links ====
When using kdesrc-build you may find it beneficial to have a way of searching the source repository so that you know what modules to look for.

* To browse the KDE Subversion repository, use
[http://websvn.kde.org/trunk/KDE WebSVN].
* To browse any of the various KDE projects using git, you can go to [http://gitorious.org/ Gitorious].
* The Nokia Qt toolkit used by KDE can be browsed at [http://gitorious.org/+kde-developers/qt/kde-qt the Gitorious kde-qt homepage].

==== Prerequisites ====
kdesrc-build is fairly easy to install and setup, but you also need to have the right software installed to build KDE SC. The requirements to build KDE SC are available as follows:

* KDE SC 4: [[../KDE4#Required Software|KDE 4 Requirements]]

{{note|It is possible to build KDE 3 using older versions of kdesrc-build, but this is not described here.}}

In addition to those listed requirements, kdesrc-build requires the Perl scripting platform to be installed. It is installed by default with most distributions, and is required to build KDE SC anyways. kdesrc-build requires Perl 5.8 or higher.

{{note|kdesrc-build is developed on a Linux system, but it should work on the various BSD distributions as well (although GNU tools may be required).}}

==== Download and install kdesrc-build ====
Once your system is setup to be able to compile the KDE SC, you can download kdesrc-build from its website, [http://kdesrc-build.kde.org/ kdesrc-build.kde.org]. The file you download will contain (at least) the kdesrc-build script and a sample configuration file. Installing kdesrc-build is as simple as saving the file and making it executable. If you'd like, you can move it to a directory in your PATH, however for this example we'll put it into the KDE source directory that we use (~/kdesrc)

<code bash>
mkdir -p ~/kdesrc
cd ~/kdesrc
tar xjvf ~/path/to/kdesrc-build-1.12.tar.bz2
cp kdesrc-build-1.12/kdesrc-build .
</code>

Alternatively, the newest kdesrc-build script (and sample config file) can be pulled directly from svn:
<code bash>
mkdir -p ~/kdesrc
cd ~/kdesrc
export SVN_ROOT=svn://anonsvn.kde.org/home/kde
svn cat $SVN_ROOT/trunk/KDE/kdesdk/scripts/kdesrc-build > kdesrc-build
svn cat $SVN_ROOT/trunk/KDE/kdesdk/scripts/kdesrc-buildrc-sample > ~/.kdesrc-buildrc
chmod +x kdesrc-build
</code>

==== Setup the configuration ====
Now you should [[Getting Started/Build/kdesrc-buildrc|setup your configuration]]. For the most part the defaults in the included kdesrc-buildrc-sample should be sufficient.

Older:
<code bash>
cp ~/kdesvn/kdesvn-build-1.10/kdesvn-buildrc-sample ~/.kdesvn-buildrc
# Now edit the ~/.kdesvn-buildrc
</code>
Newer:
<code bash>
cp ~/kdesrc/kdesrc-build-1.12/kdesrc-buildrc-sample ~/.kdesrc-buildrc
# Now edit the ~/.kdesrc-buildrc
</code>

{{tip|Note that the config file's name begins with a leading ., making it a hidden file. You may need to show hidden files in Dolphin or Konqueror to find the configuration file to edit it. Or, you can edit the sample before copying it to ~/.kdesrc-buildrc.}}

Also, make sure that the modules you'll want to build are included. You'll want the following at the least:

* qt-copy, kdesupport, kdelibs, kdepimlibs, kdebase

Modules are built in the order they appear in your ~/.kdesrc-buildrc, so the first module should be qt-copy, kdelibs should be before any other KDE SC module, and so on.

{{note|The sample configuration file does include these modules by default, you won't need to make many changes unless you'd like to add some modules to the build by uncommenting them.}}

You may want to enable the make-install-prefix option if you are installing KDE SC or Qt to a directory that is not in your home directory. make-install-prefix allows you to run su or sudo during the make install process so you can install files as root, or set certain programs to execute with higher permissions (This is required for certain programs to execute properly).

<pre>module kdelibs
make-install-prefix sudo -S # sudo with no stdin
end module

module kdebase
make-install-prefix sudo -S
end module</pre>

If a module you'd like to build isn't already present, simply add

<pre>module <module-name>
end module</pre> at the end of the ~/.kdesrc-buildrc. <module-name> would be whatever the module is called in the software repository (for instance, kdemultimedia).

===== Git-based modules =====

Some KDE projects use the "git" source-control software instead of Subversion (as part of an eventual planned migration to git). This includes software like Amarok and Konversation.

To build these modules in kdesrc-build, you just need to add a couple of lines to the module configuration. For example, konversation is developed in the git://gitorious.org/konversation/konversation.git repository at [http://gitorious.org/]. So you would just add a module (you can pick whatever name for the module you like, as long as it's not already used):

<pre>module konversation
repository git://gitorious.org/konversation/konversation.git
branch master
end module</pre>

In this case I selected the "master" branch since that is the default git branch.

Now whenever you build konversation, kdesrc-build will use git instead of Subversion.

==== Useful kdesrc-build commands ====
kdesrc-build is driven from the command line, so here's a guide to some of the more useful command line options:

<table cellpadding="2">
<tr>
<th>Option</th><th>Effect</th>
</tr>
<tr>
<td><tt><span style="white-space:nowrap;">[http://kdesrc-build.kde.org/documentation/cmdline.html#cmdline-pretend --pretend]</span></tt> (Short form <tt><span style="white-space:nowrap;">-p</span></tt>)</td>
<td>This option is like a dry run. kdesrc-build will process the options and its configuration like normal, and run through the build as normal, but instead of downloading or running the build will instead output what kdesrc-build would have done. You should always run with -p before running kdesrc-build to make sure it is doing what you expect.</td>
</tr>
<tr>
<td><tt>[http://kdesrc-build.kde.org/documentation/cmdline.html#cmdline-no-svn --no-svn]</tt> (Alt. form <tt>--no-src</tt>)</td><td>This option skips the source code update step. This is useful if you're running kdesrc-build again soon after the last update and don't want to wait to find out there were no changes.</td>
</tr>
<tr>
<td><tt>[http://kdesrc-build.kde.org/documentation/cmdline.html#cmdline-refresh-build --refresh-build]</tt></td><td>This option causes kdesrc-build to delete the current build information for the given modules and start building them again from scratch. This option takes a lot of time but gives the best chance of a successful build.</td>
</tr>
</table>

Any other non-option arguments on the command line are assumed to be modules to build (and are built in the order provided on the command line). If no modules are specified, all of the modules listed in the ~/.kdesrc-buildrc are built in the order listed in the file.

== Build ==
We're almost there. If you're happy with your settings then it's time to test out kdesrc-build. In theory things are as simple as running kdesrc-build and then coming back later. ;)

<code bash>
cd ~/kdesrc
./kdesrc-build
</code>

You may want to test by building qt-copy first however.

<code bash>
cd ~/kdesrc
./kdesrc-build qt-copy
</code>

{{tip|If you have the [http://www.gnu.org/software/screen/ GNU screen] program available then you should definitely use it to run kdesrc-build, as you can detach your kdesrc-build session and logout while kdesrc-build is still running.}}

If the build failed (kdesrc-build will error out with a nice bright red error message) then there are several possibilities:

# You are missing a key piece of required software (such as a development library)
# The KDE SC code being compiled is broken in some fashion to where it won't build. This is commonly due to newly committed code that worked on the developer's machine, or occasionally on Mondays (when incompatible changes are permitted to kdelibs).
# kdesrc-build is not setup properly. You may be trying to install to a directory that you have no permissions to access for instance, or you may have specified a system qtdir that does not exist.
# The module may depend on a newer version of qt-copy or kdelibs (or other module). In this case you'll have to run kdesrc-build to update the out-of-date module first.

How do you find out what the error was? The output of the failing command will be in the log directory. By default, all log output is in the {{path|log}} subdirectory of the KDE SC source directory. The log directory is laid out like this: {{path|log/date-run/module/output-file.log}}. To simplify finding the appropriate file, there are a couple of symlinks created:

{{path|log/latest}} always has the debugging output for the last time kdesrc-build was run (--pretend doesn't count toward this)
{{path|log/latest/<module>/error.log}} has the debugging output for the command that caused a module build to fail.

For instance if qt-copy just failed to build you could read the output like this:

<code bash>
cd ~/kderc
kwrite log/latest/qt-copy/error.log
</code>

Replace kwrite with your preferred editor. Hopefully the output can guide you to resolving the problem. For instance, if the failure is a cmake output saying you're missing a library, install that library and try again. ;) For link errors you can try running a --refresh-build on the module (or if that doesn't work, required libraries like qt-copy and kdelibs).

If you're stumped by the error you may want to wait a day and try updating again, and hope that the reason for the error has been fixed. You can also try mailing the [http://www.kde.org/mailinglists/ kde-devel] mailing list to see if others know about the problem or have had similar issues.

== Running KDE ==

Assuming you got enough of the modules to build and install to have a working KDE installation, you'll still need to setup your environment correctly to run it. kdesrc-build doesn't help you out here (yet), but the instructions at [[../../Increased_Productivity_in_KDE4_with_Scripts/.bashrc|the .bashrc wiki page]] apply just as well, except that you'll need to set the environment variables to the settings that are in your ~/.kdesrc-buildrc.

For the KDEDIRS and KDEDIR variable use the setting of the "prefix" option (in the global section).
For the QTDIR variable use the setting of the "qtdir" option.

{{tip|When copying settings over to the .bashrc, change any ~'s in the paths to $HOME, as the ~ character is not expanded correctly in the .bashrc.}}

Once your .bashrc is setup logout and log back in again and then you should be able to run your new KDE installation.

== Keeping KDE up to date ==

Keeping your KDE installation up to date is as simple as running kdesrc-build again. Every kdesrc-build has these phases:

# Update the source code for all modules being built.
# Build and then install all the modules.

Old build directories are not deleted by default, so the build after a small update will not normally take as long as the initial build of a module. This is called "incremental make". However it may be necessary at times to perform a full rebuild due to inconsistencies between the build directory configuation and changes to the source directory. You can use the --refresh-build option to force a full rebuild.

For more information on how to take advantage of kdesrc-build, see the [http://kdesrc-build.kde.org/documentation online documentation] for kdesrc-build, which describes all of the module options and command line options available for kdesrc-build and gives tips on how to perform various useful tasks.

If you have any questions that are not answered please feel free to add them under the Discussion entry for this page and hopefully someone will be able to get the answer.

[[Category:Build_KDE]]
[[Category:Tutorial]]

Contribute/Bugsquad/Howto

2010-08-24T23:15:21Z

Fulldecent: initial checkin

The main communication tool between developers and users, and the main quality tool is the KDE bugs and wishes database. The database is implemented using the [http://www.bugzilla.org/about.html Bugzilla] tool for tracking bugs and wishes, developed initially for the Mozilla web browser. [http://bugs.kde.org/] is the the web front end implementation of KDE's Bugzilla, and the main place to go when managing bugs, but there are other front ends: the KBugBuster, from the kdesdk module and the e-mail interface, used to add comments, change bugs status, etc...

<p>Many bug reports are filed daily, especially after releases. There are too many to be handled by the developers, so the amount of open reports increases over time. Additionally old bug reports have to be revisited regularly to see if they still apply to the current version. Reviewing the bugs database also give you insight about the most needed features and most pernicious bugs, allowing you to point them, and the developers to actually fix bugs or spend time to add new features to KDE, instead of managing bugs.</p>

<p>Always direct users to the KDE bug tracker system to discuss bugs and wishes, because this way issues will not be forgotten. If the point is a bit more polemic, it is sensible to start a discussion in the [http://www.kde.org/mailinglists/ application mailing list] or in [http://mail.kde.org/mailman/listinfo/kde-usability KDE usability mailing list], but instruct them to start by [http://bugs.kde.org/wizard.cgi filing the bug], because by [http://bugs.kde.org/quicksearch.html searching for similar bugs or wishes] they may find answers or insight.</p>

<h3>Before Starting</h3>

<p>To start, [http://bugs.kde.org/createaccount.cgi open an account on bugs.kde.org] if you don't have one. The database records not only the bugs and wishes status, but also related discussions, screenshots, patches, etc.. turning it to a very complete source of information. Please try the following pages at [http://bugs.kde.org/ bugs.kde.org], to get used to KDE bugzilla capabilities. The KBugBugster is also useful, but less flexible.</p>

* [http://bugs.kde.org/quicksearch.html Simple search form]
* [http://bugs.kde.org/query.cgi Advanced search form]
* [http://bugs.kde.org/wizard.cgi New wishes/bugs wizard]

<p>At the beginning, you will only be able to comment on bug reports which are not your own. Only after acquiring more knowledge on the application and on KDE Bugzilla system, you may ask for rights to confirm bug reports and close non verifiable ones.</p>

<p>You need a current KDE installation in order to be able to test if a bug is still uptodate. This means you should either test with 'trunk', that is the latest development-version of KDE, or the latest branch of KDE. See http://techbase.kde.org/Getting_Started/Build/KDE4
</p>

<p>Also it is important to have a KDE version compiled with debug information. KDE binaries compiled with debug information are bigger and run slower, but provide invaluable information to the developers when applications crash, as they are able to locate where in the source code it crashed, and sometimes even why. Whenever an application crashes, the KDE crash handler appears. You can now retrieve the backtrace information to add to a bugreport.</p>

<h3>Managing Reports</h3>

<p>The main tool for bug triage is knowledge of your application. You will learn that you don't need to be a developer to have a good understanding of it: reading bug reports and comments about them, writing documentation or working with the application's user interface will do the trick.</p>

<p>You should always start by stating your opinion in the bug reports and letting the developers take the appropriate action. If you feel you are ready to manage bugs effectively, know well the application and have a bit experience with bugzilla, it is time to ask for permissions. The [mailto:quality@kde.org Quality Team mailinglist], the [https://bugs.kde.org/enter_sysadmin_request.cgi KDE system administrator], or the mailinglist of the application you are working with, are the right places to ask for it. The developers will probably be happy to have someone working with them, and in the end of the day it is your own reputation as a good contributor that is in the line, as developers will still watch what you are doing. Some of the task below require these permissions.</p>

<p>A good way to start is checking if bugs are still valid:</p>

* Believe the reporter: if you cannot reproduce a new bug, first ask for more context information, then think about closing it or asking to close it.
* The bug may be triggered by a combination of factors, or the bug may be fixed in the main branch, but not in the stable branch (if so, ask in the bug report for a backport. If it is not doable, the developers will say so).
* Add any additional information you can give, e.g. backtrace, additional observations, how to (better) reproduce the faulty behavior or simply add with which day's version the bug still appears.
* If you can reproduce an UNCONFIRMED bug, please write that in the bugreport and change its status to NEW.
* If a program hangs, you can "kill -SIGSEGV Processid" the process to get a backtrace.
* Check if the report is filed into the correct product and component category too. KDE is a very modular, and massively reuse code, and sometimes is hard even for the developers to detect in which component the bug is, so be careful. If the report is not already assigned to some other developer than the current component owner, <strong>make sure to select the "Reassign bug to owner of selected component" when moving a report</strong>. If a report is filed into a category where there is no single maintainer/active developer and you know which developer is responsible or works on the code (a look into the source or reading kde-cvs mailing list can help), you may assign a bug report to him/her directly.
* Check if a report describes an error already described in another closed or open report: Resolve it as DUPLICATE with reference to the prior report.
* Check if the same report was submitted more than one time. Please close the identical bug (the one with the highest number) as INVALID and not as DUPLICATE because otherwise they show up wrongly in the most frequently reported bugs statistics.

<p>Browser (Konqueror) bugs are usually very easy to check and there are lots of them:</p>

* Add "(regression)" to the title if the page was correctly rendered in a previous stable release.
* It's a good idea to put the site into the title where an error was encountered to ease duplicate spotting.
* A parallel installation of a Gecko-based browser and Opera can give you an idea how a web page probably should look like.
* Try to generate a stripped down testcase of a faulty rendered webpage. Add "(testcase)" to the title if a testcase is attached to the bug report.
* If a webpage doesn't exist any longer or was obviously rewritten and there was no testcase provided, close the report as WONTFIX.
* If the reporter or a comment mentions that a page works fine in Safari, it can help the developers to note that in the title too.

<p>Check if the severity is appropriate, but if you don't agree, state so in the bugreport. Let the maintainer change the severity, as it is used by them to remind to fix crucial issues.</p>

<p>Check if the title contains a good summary, e.g. feature requests titled "Feature wanted" don't help when glancing over the report list. If a patch is provided add "(patch)" to the title.</p>

<p>Note: Don't use the "Change Several Bugs at Once" feature for moving reports. There is a bug in Bugzilla which confirms every reports which gets moved.</p>

<p>The <strong>KDE Bugsquad</strong> coordinates bug triage efforts as well as organising regular bug-days where many people work together to clearup all the bugs for a particular program. Bug-days are an excellent oppurtunity for making your first steps in contributing to KDE, and there are always plenty of experienced bug-busters on hand to help you with any difficulties you may have. For more information, see the [http://techbase.kde.org/index.php?title=Contribute/Bugsquad Bugsquad Techbase pages]</p>

This article originally from Carlos Leonhard Woelz -- http://websvn.kde.org/trunk/www/sites/quality/develop/howto/howtobugs.php?revision=1044461&view=markup&pathrev=1100000

Getting Started/Using Project Neon to contribute to KDE

2010-08-21T12:28:41Z

Fulldecent:

{{Template:I18n/Language Navigation Bar|Getting_Started/Using_Project_Neon_to_contribute_to_KDE}}

{{Note | Project Neon can help you with builds current as of 2009-12-10}}

[https://edge.launchpad.net/project-neon Project Neon] is a nightly build of the latest KDE trunk. It is an easy way for new contributors to KDE to get started without having to build the entire KDE-SVN tree and maintain the checkout. Additionally, dependencies are automatically handled and updated. This is suitable for new developers, translators, usability designers, documenters, promoters, bug triagers etc. This process makes the steps detailed on [[Getting_Started/Build/KDE4|this page]], including changes to your [[Getting_Started/Increased_Productivity_in_KDE4_with_Scripts/.bashrc|.bashrc]] unnecessary.

However, for developers, it may at some point become necessary to build more components from SVN as you become more involved in the project. The [[Getting_Started/Build/kdesvn-build|kdesvn-build]] script is an easy way to build all or parts of KDE SVN.

== Requirements ==

Project neon always requires the latest stable Kubuntu release. As of January 2009, that is version 8.10. Previous versions of Kubuntu are not supported. It is possible to port Project Neon to other distributions, though there are currently no maintainers for other distributions working on the project. OpenSuse provides their own weekly build of KDE trunk. Find instructions on how to use it [[Getting Started/Using OpenSuse KDE unstable packages for development|here]].

== Installing Project Neon ==

To use Project Neon, add the following PPA (Personal Package Archive) to your <tt>sources.list</tt> using your preferred method:

<code bash>
# Project neon nightly KDE4 build
deb http://ppa.launchpad.net/project-neon/ubuntu jaunty main

#above repository is PGP signed, refer to below link for getting PGP key
https://launchpad.net/~project-neon/+archive/ppa
</code>

After that, you can simply install the nightly package of whichever modules you want to work on. The following packages are available:

kde-nightly-kdebase
kde-nightly-kdeplasma-addons
kde-nightly-kdepim
kde-nightly-kdeedu
kde-nightly-kdenetwork
kde-nightly-kdeutils
kde-nightly-kdegraphics
kde-nightly-kdemultimedia

You can install all of the packages or just the ones you are interested in, depending on what you want to use them for. For example if you want to install the latest KDE Workspace (plasma, kwin etc), install the <tt>kde-nightly-kdebase</tt> package and <tt>kde-nightly-kdeplasma-addons</tt> package for extra plasmoids.

<code bash>
sudo aptitude install kde-nightly-kdebase kde-nightly-kdeplasma-addons
</code>

If you are only interested in application development in another module, you can install just the module package.

<code bash>
sudo aptitude install kde-nightly-kdepim
</code>

That command will also install the <tt>kdelibs</tt>, <tt>kdepimlibs</tt> and other dependencies too. In your regular (stable) KDE session you can then run the nightly version of your chosen application by using the full path from the command line.

<code bash>
/opt/kde-nightly/bin/kmail
</code>

This will correctly use the nightly version of libraries instead of using the stable versions, so no other changes are necessary to your library path etc.

Alternatively, instead of using the full path to the executable, you could add the following to your <tt>.bashrc</tt>

<code bash>
_STABLE_PATH=$PATH
function switchtonightly {
export PATH=/opt/kde-nightly/bin:$_STABLE_PATH
}

function switchtostable {
export PATH=$_STABLE_PATH
}
</code>

This will allow you to optionally run unstable applications when you choose to in your session.

<code bash>
# Runs the stable version of kmail
kmail
switchtonightly
# runs the nightly version of kmail
kmail
# runs the nightly version of knode
knode
switchtostable
# runs the stable version of kmail
kmail
</code>

Note that settings for applications that you run from project neon do not conflict with your regular application settings and data. <tt>.kde-neon/</tt> is used instead of <tt>.kde/</tt>

== Using Project Neon for development ==

If you are joining one of the development teams in KDE, you will need a real SVN checkout in order to contribute your code back to the project and create patches easily.

Some extra tools (<tt>neonmake</tt>) are provided for this purpose in the package <tt>amarok-nightly-tools</tt>. The packages come with development headers and debugging symbols built in.

<code bash>
sudo aptitude install amarok-nightly-tools
</code>

If you are already using a nightly package of the module you want to develop for, you should remove that, and checkout the development version. For example:

<code bash>
# Remove the packaged nightly version
sudo aptitude purge kde-nightly-kdepim

# Add below Project Neon source code repository to sources.list
deb-src http://ppa.launchpad.net/project-neon/ppa/ubuntu jaunty main

# Get the dependencies for building kdepim
sudo apt-get build-dep kde-nightly-kdepim
cd ~
# You may choose to do your development in a different folder.
cd Development
# Gets the latest version of the kdepim module.
svn co svn://anonsvn.kde.org/home/kde/trunk/KDE/kdepim
cd kdepim
# Shortcut provided by Project Neon to make the module
# and install it to the prefix /opt/kde-nightly/
sudo neonmake
</code>

Note that you should usually checkout a module from KDE, not an application. Most modules contain libraries shared within the module and which are necessary to build the applications in the module.

Also of note is the <tt>neonmake</tt> command. This is a shortcut which temporarily sets some environment variables like the <tt>LD_LIBRARY_PATH</tt>, the install prefix etc, then runs the equivalent of <tt>cmake && make && make install</tt>. It also runs rpath to configure the executable file to use the nightly libraries.

== Using Project Neon for translation ==

The Project Neon nightly packages include English language strings only. Translated packages are not available. However, if you are translating KDE applications, you can install the translations from KDE SVN in your normal workflow.

<code bash>
cd ~
cd Translations
# The -N switch checks out only the top level directory from svn.
svn co -N svn://anonsvn.kde.org/home/kde/trunk/l10n-kde4
cd l10n-kde4
# scripts necessary to build translations.
svn up scripts
# Get the German translations
svn up de
# Generate the build files for the German language pack
./scripts/autogen.sh de
cd de
neonmake
</code>

After building the translations it is possible to either change the language in system settings, or run applications in another language using the environment variable <tt>KDE_LANG</tt>.

<code bash>
switchtonightly
KDE_LANG=de kmail
switchtostable
</code>

== Using Project Neon for documentation ==

The Project Neon nightly source packages include the official KDE User Documentation in English.

TODO: How to build user docs from SVN.

== Using Project Neon for promotion ==

If you are creating screenshots or screencasts of the latest version of KDE, project Neon is a simple and fast way of getting a default KDE4 session.

The KDE Promotion team recommends using the default background, theme, icons etc when preparing official promotional materials (unless the feature you are showing is related to configuring KDE artwork). Project Neon uses the default artwork that comes with KDE4, so it is useful for creating promo materials.

Here is a shortcut to get all available modules from the PPA:

<code bash>
sudo aptitude install kde-nightly-kdebase kde-nightly-kdeplasma-addons \
kde-nightly-kdepim kde-nightly-kdeedu kde-nightly-kdenetwork \
kde-nightly-kdeutils kde-nightly-kdegraphics kde-nightly-kdemultimedia
</code>

The application [http://ariya.blogspot.com/2008/06/creating-fancy-screenshots-with.html screenie] is provided in Kubuntu 8.10 as <tt>screenie-qt</tt>.

<code bash>
sudo aptitude install screenie-qt
</code>

Archive:Getting Started/Build/Mac OS X

2010-08-21T03:05:47Z

Fulldecent: /* Required Third Party Tools */

{{improve}}
{{Note|
If you're interested in just checking things out, binaries for kdelibs and parts of KDE in general are available at http://kde.mac.org and are generated semi-regularly.
}}

*Note: You may wish to do all of this inside a directory name that ends in ''.noindex'' or ''.build'' to keep spotlight from indexing all of your temporary build-files as you build them.

<code>mkdir ~/kde4.build
cd ~/kde4.build</code>

== Setting Up Your Build Environment ==
Variables must be set to build KDE successfully, and are noted below
*Note: Replace /opt/kde4-deps with the location of your 3rd-party tools, and add your cmake location if you compiled from source
<code>export PATH="/opt/qt4/bin:/opt/kde4/bin:/opt/kde4-deps/bin:~/.local/bin/:$PATH"
export CMAKE_LIBRARY_PATH="/opt/kde4-deps/lib"
export CMAKE_INCLUDE_PATH="/opt/kde4-deps/include"
export PKG_CONFIG_PATH="/opt/qt4/lib/:/opt/kde4-deps/lib/pkgconfig/"
</code>

You might want to put those in your ~/.bash_profile

* For Fink users: If your ''Distribution'' line in ''/sw/etc/fink.conf'' is 10.4-transitional, instead of 10.4, make sure you run ''sudo gcc_select 3.3'' before proceeding with any compiling, or you will end up with binary-incompatible c++ code!
* For others: run ''sudo gcc_select 4.0'' if you want to be compatible with the pre-made installers.

== Required Third Party Tools ==
The following third party tools are required for successfully building KDE on OSX. Also, here are some [[Getting_Started/Build/KDE4/LFS| good tips for installing from source]]. I assume you have OS X 10.5 or 10.6 installed, otherwise you would have some more dependencies.
* [http://developer.apple.com/technologies/xcode.html XCode]
* [http://www.gnu.org/software/libtool/libtool.html libtool]
<code>cd ~/kde4.build
curl http://ftp.gnu.org/gnu/libtool/libtool-2.2.tar.gz -O
tar xfz libtool-2.2.tar.gz
cd libtool-2.2
ls
./configure --prefix=/opt/kde4-deps
make
sudo make install</code>
* [http://www.xmlsoft.org/downloads.html libxml2 and libxslt]
<code>cd ~/kde4.build
curl ftp://xmlsoft.org/libxml2/libxml2-sources-2.7.7.tar.gz -O
tar xfz libxml2-sources-*.tar.gz
cd libxml2-2.7.7
./configure --prefix=/opt/kde4-deps/
make
sudo make install

cd ~/kde4.build
curl ftp://xmlsoft.org/libxml2/libxslt-1.1.26.tar.gz -O
tar xfz libxslt-*.tar.gz
cd libxslt-1.1.26
./configure --prefix=/opt/kde4-deps/
make
sudo make install
</code>
* [http://www.linuxfromscratch.org/blfs/view/svn/pst/DocBook.html DocBook XML DTD-4.5 and DocBook XSL Stylesheets-1.75.2]
<code>cd ~/kde4.build
mkdir docbook
cd docbooj
curl http://www.docbook.org/xml/4.5/docbook-xml-4.5.zip -O
unzip docbook-xml-4.5.zip
# RUN ALL THE COMMANDS AT http://www.linuxfromscratch.org/blfs/view/svn/pst/DocBook.html AS ROOT
# DOWNLOAD THE FILE AT http://www.linuxfromscratch.org/blfs/view/svn/pst/docbook-xsl.html
sudo tar xfj docbook-xsl-1.75.2.tar.bz2
cd docbook-xsl-1.75.2
# RUN ALL THE COMMANDS THERE AS ROOT</code>
* [http://www.gtk.org/gtk-doc/download.html gtk-doc]
<code>cd ~/kde4.build
curl http://ftp.gnome.org/pub/GNOME/sources/gtk-doc/1.15/gtk-doc-1.15.tar.gz -O -L
tar xfz gtk-doc-*.tar.gz
cd gtk-doc-1.15
./configure --prefix=/opt/kde4-deps/</code>
* [http://www.gtk.org/download.html glib2]
<code>git clone git://git.gnome.org/glib
cd glib/
./autogen.sh --prefix=/opt/kde4-deps/ ## THIS IS WHERE I GET STUCK (entriken 2010-08-20)</code>
* shared-mime-info
* AGG
* giflib or libungif
* libart_lgpl
* libidn
* libjpeg
* libmng
* libpng
* libusb
* OpenEXR
* PCRE
* Strigi
* pkgconfig
* dbus

== Qt/Mac Open Source Edition ==
Get the Qt/Mac source code from http://qt.nokia.com/downloads/sdk-mac-os-cpp

The latest version has QtDBus and should work with KDE for Mac. Get it here: http://download.qt.nokia.com/qtsdk/qt-sdk-mac-opensource-2010.04.dmg

(statement make by entriken and unverified 2010-08-20)

== CMake ==
Get the latest CMake from http://www.cmake.org/cmake/resources/software.html#latest and install:

<code>cd ~/kde4.build
curl http://www.cmake.org/files/v2.8/cmake-2.8.2.tar.gz -O
tar xfz cmake-*.tar.gz
cd cmake-*
./configure --prefix=/opt/kde4-deps
make all
sudo make install</code>

== Building kdelibs ==
kdelibs must be checked out of svn locally to be built:
<code>cd ~/kde4.build
svn co svn://anonsvn.kde.org/home/kde/trunk/KDE/kdelibs</code>
And then compiled by performing the following:
<code>mkdir kdelibs.build
cd kdelibs.build
cmake ../kdelibs -DCMAKE_INSTALL_PREFIX=/opt/kde4
make all install</code>

== Troubleshooting ==
If kdelibs fails to compile successfully, check the build status for the latest Nightly Builds and Continuous Builds at http://public.kitware.com/dashboard.php?name=kde

Information about getting and compiling the dependencies can be found at [[Getting_Started/Build/KDE4]] and [[Getting_Started/Build/KDE4/Prerequisites]] (pages are Linux focused, but can be useful)

== Further Reading ==
For more general information on using CMake, see the [[Development/Tutorials/CMake|CMake Tutorial]].

[[Category:Mac OSX]]

Archive:Getting Started/Build/Mac OS X

2010-08-21T01:04:47Z

Fulldecent: /* Required Third Party Tools */

{{improve}}
{{Note|
If you're interested in just checking things out, binaries for kdelibs and parts of KDE in general are available at http://kde.mac.org and are generated semi-regularly.
}}

*Note: You may wish to do all of this inside a directory name that ends in ''.noindex'' or ''.build'' to keep spotlight from indexing all of your temporary build-files as you build them.

<code>mkdir ~/kde4.build
cd ~/kde4.build</code>

== Setting Up Your Build Environment ==
Variables must be set to build KDE successfully, and are noted below
*Note: Replace /opt/kde4-deps with the location of your 3rd-party tools, and add your cmake location if you compiled from source
<code>export PATH="/opt/qt4/bin:/opt/kde4/bin:/opt/kde4-deps/bin:~/.local/bin/:$PATH"
export CMAKE_LIBRARY_PATH="/opt/kde4-deps/lib"
export CMAKE_INCLUDE_PATH="/opt/kde4-deps/include"
export PKG_CONFIG_PATH="/opt/qt4/lib/:/opt/kde4-deps/lib/pkgconfig/"
</code>

You might want to put those in your ~/.bash_profile

* For Fink users: If your ''Distribution'' line in ''/sw/etc/fink.conf'' is 10.4-transitional, instead of 10.4, make sure you run ''sudo gcc_select 3.3'' before proceeding with any compiling, or you will end up with binary-incompatible c++ code!
* For others: run ''sudo gcc_select 4.0'' if you want to be compatible with the pre-made installers.

== Required Third Party Tools ==
The following third party tools are required for successfully building KDE on OSX. Also, here are some [[Getting_Started/Build/KDE4/LFS| good tips for installing from source]]. I assume you have OS X 10.5 or 10.6 installed, otherwise you would have some more dependencies.
* [http://developer.apple.com/technologies/xcode.html XCode]
* [http://www.gnu.org/software/libtool/libtool.html libtool]
<code>cd ~/kde4.build
curl http://ftp.gnu.org/gnu/libtool/libtool-2.2.tar.gz -O
tar xfz libtool-2.2.tar.gz
cd libtool-2.2
ls
./configure --prefix=/opt/kde4-deps
make
sudo make install</code>
* [http://www.xmlsoft.org/downloads.html libxml2 and libxslt]
<code>cd ~/kde4.build
curl ftp://xmlsoft.org/libxml2/libxml2-sources-2.7.7.tar.gz -O
tar xfz libxml2-sources-*.tar.gz
cd libxml2-2.7.7
./configure --prefix=/opt/kde4-deps/
make
sudo make install

cd ~/kde4.build
curl ftp://xmlsoft.org/libxml2/libxslt-1.1.26.tar.gz -O
tar xfz libxslt-*.tar.gz
cd libxslt-1.1.26
./configure --prefix=/opt/kde4-deps/
make
sudo make install
</code>
* [http://www.gtk.org/download.html glib2]
<code>Go to that link and download gtk-osx-build-setup.sh
sh gtk-osx-build-setup.sh
jhbuild bootstrap # THIS IS WHERE I GET STUCK (entriken, 2010-08-20)
jhbuild build meta-gtk-osx-bootstrap
jhbuild build</code>
* shared-mime-info
* AGG
* giflib or libungif
* libart_lgpl
* libidn
* libjpeg
* libmng
* libpng
* libusb
* OpenEXR
* PCRE
* Strigi
* pkgconfig
* dbus

== Qt/Mac Open Source Edition ==
Get the Qt/Mac source code from http://qt.nokia.com/downloads/sdk-mac-os-cpp

The latest version has QtDBus and should work with KDE for Mac. Get it here: http://download.qt.nokia.com/qtsdk/qt-sdk-mac-opensource-2010.04.dmg

(statement make by entriken and unverified 2010-08-20)

== CMake ==
Get the latest CMake from http://www.cmake.org/cmake/resources/software.html#latest and install:

<code>cd ~/kde4.build
curl http://www.cmake.org/files/v2.8/cmake-2.8.2.tar.gz -O
tar xfz cmake-*.tar.gz
cd cmake-*
./configure --prefix=/opt/kde4-deps
make all
sudo make install</code>

== Building kdelibs ==
kdelibs must be checked out of svn locally to be built:
<code>cd ~/kde4.build
svn co svn://anonsvn.kde.org/home/kde/trunk/KDE/kdelibs</code>
And then compiled by performing the following:
<code>mkdir kdelibs.build
cd kdelibs.build
cmake ../kdelibs -DCMAKE_INSTALL_PREFIX=/opt/kde4
make all install</code>

== Troubleshooting ==
If kdelibs fails to compile successfully, check the build status for the latest Nightly Builds and Continuous Builds at http://public.kitware.com/dashboard.php?name=kde

Information about getting and compiling the dependencies can be found at [[Getting_Started/Build/KDE4]] and [[Getting_Started/Build/KDE4/Prerequisites]] (pages are Linux focused, but can be useful)

== Further Reading ==
For more general information on using CMake, see the [[Development/Tutorials/CMake|CMake Tutorial]].

[[Category:Mac OSX]]

Archive:Getting Started/Build/Mac OS X

2010-08-21T00:49:13Z

Fulldecent: /* Required Third Party Tools */

{{improve}}
{{Note|
If you're interested in just checking things out, binaries for kdelibs and parts of KDE in general are available at http://kde.mac.org and are generated semi-regularly.
}}

*Note: You may wish to do all of this inside a directory name that ends in ''.noindex'' or ''.build'' to keep spotlight from indexing all of your temporary build-files as you build them.

<code>mkdir ~/kde4.build
cd ~/kde4.build</code>

== Setting Up Your Build Environment ==
Variables must be set to build KDE successfully, and are noted below
*Note: Replace /opt/kde4-deps with the location of your 3rd-party tools, and add your cmake location if you compiled from source
<code>export PATH="/opt/qt4/bin:/opt/kde4/bin:/opt/kde4-deps/bin:~/.local/bin/:$PATH"
export CMAKE_LIBRARY_PATH="/opt/kde4-deps/lib"
export CMAKE_INCLUDE_PATH="/opt/kde4-deps/include"
export PKG_CONFIG_PATH="/opt/qt4/lib/:/opt/kde4-deps/lib/pkgconfig/"
</code>

You might want to put those in your ~/.bash_profile

* For Fink users: If your ''Distribution'' line in ''/sw/etc/fink.conf'' is 10.4-transitional, instead of 10.4, make sure you run ''sudo gcc_select 3.3'' before proceeding with any compiling, or you will end up with binary-incompatible c++ code!
* For others: run ''sudo gcc_select 4.0'' if you want to be compatible with the pre-made installers.

== Required Third Party Tools ==
The following third party tools are required for successfully building KDE on OSX. Also, here are some [[Getting_Started/Build/KDE4/LFS| good tips for installing from source]]. I assume you have OS X 10.5 or 10.6 installed, otherwise you would have some more dependencies.
* [http://developer.apple.com/technologies/xcode.html XCode]
* [http://www.gnu.org/software/libtool/libtool.html libtool]
<code>cd ~/kde4.build
curl http://ftp.gnu.org/gnu/libtool/libtool-2.2.tar.gz -O
tar xfz libtool-2.2.tar.gz
cd libtool-2.2
ls
./configure --prefix=/opt/kde4-deps
make
sudo make install</code>
* [http://www.xmlsoft.org/downloads.html libxml2 and libxslt]
<code>cd ~/kde4.build
curl ftp://xmlsoft.org/libxml2/libxml2-sources-2.7.7.tar.gz -O
tar xfz libxml2-sources-*.tar.gz
cd libxml2-2.7.7
./configure --prefix=/opt/kde4-deps/
make
sudo make install

cd ~/kde4.build
curl ftp://xmlsoft.org/libxml2/libxslt-1.1.26.tar.gz -O
tar xfz libxslt-*.tar.gz
cd libxslt-1.1.26
./configure --prefix=/opt/kde4-deps/
make
sudo make install
</code>
* [http://www.gtk.org/download.html glib2]
<code>Go to that link and download/run gtk-osx-build-setup.sh</code>
* shared-mime-info
* AGG
* giflib or libungif
* libart_lgpl
* libidn
* libjpeg
* libmng
* libpng
* libusb
* OpenEXR
* PCRE
* Strigi
* pkgconfig
* dbus

== Qt/Mac Open Source Edition ==
Get the Qt/Mac source code from http://qt.nokia.com/downloads/sdk-mac-os-cpp

The latest version has QtDBus and should work with KDE for Mac. Get it here: http://download.qt.nokia.com/qtsdk/qt-sdk-mac-opensource-2010.04.dmg

(statement make by entriken and unverified 2010-08-20)

== CMake ==
Get the latest CMake from http://www.cmake.org/cmake/resources/software.html#latest and install:

<code>cd ~/kde4.build
curl http://www.cmake.org/files/v2.8/cmake-2.8.2.tar.gz -O
tar xfz cmake-*.tar.gz
cd cmake-*
./configure --prefix=/opt/kde4-deps
make all
sudo make install</code>

== Building kdelibs ==
kdelibs must be checked out of svn locally to be built:
<code>cd ~/kde4.build
svn co svn://anonsvn.kde.org/home/kde/trunk/KDE/kdelibs</code>
And then compiled by performing the following:
<code>mkdir kdelibs.build
cd kdelibs.build
cmake ../kdelibs -DCMAKE_INSTALL_PREFIX=/opt/kde4
make all install</code>

== Troubleshooting ==
If kdelibs fails to compile successfully, check the build status for the latest Nightly Builds and Continuous Builds at http://public.kitware.com/dashboard.php?name=kde

Information about getting and compiling the dependencies can be found at [[Getting_Started/Build/KDE4]] and [[Getting_Started/Build/KDE4/Prerequisites]] (pages are Linux focused, but can be useful)

== Further Reading ==
For more general information on using CMake, see the [[Development/Tutorials/CMake|CMake Tutorial]].

[[Category:Mac OSX]]

Archive:Getting Started/Build/Mac OS X

2010-08-21T00:44:58Z

Fulldecent: /* Required Third Party Tools */

{{improve}}
{{Note|
If you're interested in just checking things out, binaries for kdelibs and parts of KDE in general are available at http://kde.mac.org and are generated semi-regularly.
}}

*Note: You may wish to do all of this inside a directory name that ends in ''.noindex'' or ''.build'' to keep spotlight from indexing all of your temporary build-files as you build them.

<code>mkdir ~/kde4.build
cd ~/kde4.build</code>

== Setting Up Your Build Environment ==
Variables must be set to build KDE successfully, and are noted below
*Note: Replace /opt/kde4-deps with the location of your 3rd-party tools, and add your cmake location if you compiled from source
<code>export PATH="/opt/qt4/bin:/opt/kde4/bin:/opt/kde4-deps/bin:~/.local/bin/:$PATH"
export CMAKE_LIBRARY_PATH="/opt/kde4-deps/lib"
export CMAKE_INCLUDE_PATH="/opt/kde4-deps/include"
export PKG_CONFIG_PATH="/opt/qt4/lib/:/opt/kde4-deps/lib/pkgconfig/"
</code>

You might want to put those in your ~/.bash_profile

* For Fink users: If your ''Distribution'' line in ''/sw/etc/fink.conf'' is 10.4-transitional, instead of 10.4, make sure you run ''sudo gcc_select 3.3'' before proceeding with any compiling, or you will end up with binary-incompatible c++ code!
* For others: run ''sudo gcc_select 4.0'' if you want to be compatible with the pre-made installers.

== Required Third Party Tools ==
The following third party tools are required for successfully building KDE on OSX. Also, here are some [[Getting_Started/Build/KDE4/LFS| good tips for installing from source]].
* [http://developer.apple.com/technologies/xcode.html XCode]
* [http://www.gnu.org/software/libtool/libtool.html libtool]
<code>cd ~/kde4.build
curl http://ftp.gnu.org/gnu/libtool/libtool-2.2.tar.gz -O
tar xfz libtool-2.2.tar.gz
cd libtool-2.2
ls
./configure --prefix=/opt/kde4-deps
make
sudo make install</code>
* [http://www.xmlsoft.org/downloads.html libxml2 and libxslt]
<code>cd ~/kde4.build
curl ftp://xmlsoft.org/libxml2/libxml2-sources-2.7.7.tar.gz -O
tar xfz libxml2-sources-*.tar.gz
cd libxml2-2.7.7
./configure --prefix=/opt/kde4-deps/
make
sudo make install

cd ~/kde4.build
curl ftp://xmlsoft.org/libxml2/libxslt-1.1.26.tar.gz -O
tar xfz libxslt-*.tar.gz
cd libxslt-1.1.26
./configure --prefix=/opt/kde4-deps/
make
sudo make install
</code>
* [http://www.gtk.org/download.html glib2]
<code>Go to that link and download/run gtk-osx-build-setup.sh</code>
* shared-mime-info
* AGG
* giflib or libungif
* libart_lgpl
* libidn
* libjpeg
* libmng
* libpng
* libusb
* OpenEXR
* PCRE
* Strigi
* pkgconfig
* subversion (to check out the kde sources)
* dbus

== Qt/Mac Open Source Edition ==
Get the Qt/Mac source code from http://qt.nokia.com/downloads/sdk-mac-os-cpp

The latest version has QtDBus and should work with KDE for Mac. Get it here: http://download.qt.nokia.com/qtsdk/qt-sdk-mac-opensource-2010.04.dmg

(statement make by entriken and unverified 2010-08-20)

== CMake ==
Get the latest CMake from http://www.cmake.org/cmake/resources/software.html#latest and install:

<code>cd ~/kde4.build
curl http://www.cmake.org/files/v2.8/cmake-2.8.2.tar.gz -O
tar xfz cmake-*.tar.gz
cd cmake-*
./configure --prefix=/opt/kde4-deps
make all
sudo make install</code>

== Building kdelibs ==
kdelibs must be checked out of svn locally to be built:
<code>cd ~/kde4.build
svn co svn://anonsvn.kde.org/home/kde/trunk/KDE/kdelibs</code>
And then compiled by performing the following:
<code>mkdir kdelibs.build
cd kdelibs.build
cmake ../kdelibs -DCMAKE_INSTALL_PREFIX=/opt/kde4
make all install</code>

== Troubleshooting ==
If kdelibs fails to compile successfully, check the build status for the latest Nightly Builds and Continuous Builds at http://public.kitware.com/dashboard.php?name=kde

Information about getting and compiling the dependencies can be found at [[Getting_Started/Build/KDE4]] and [[Getting_Started/Build/KDE4/Prerequisites]] (pages are Linux focused, but can be useful)

== Further Reading ==
For more general information on using CMake, see the [[Development/Tutorials/CMake|CMake Tutorial]].

[[Category:Mac OSX]]

Archive:Getting Started/Build/Mac OS X

2010-08-21T00:43:47Z

Fulldecent: /* Setting Up Your Build Environment */

{{improve}}
{{Note|
If you're interested in just checking things out, binaries for kdelibs and parts of KDE in general are available at http://kde.mac.org and are generated semi-regularly.
}}

*Note: You may wish to do all of this inside a directory name that ends in ''.noindex'' or ''.build'' to keep spotlight from indexing all of your temporary build-files as you build them.

<code>mkdir ~/kde4.build
cd ~/kde4.build</code>

== Setting Up Your Build Environment ==
Variables must be set to build KDE successfully, and are noted below
*Note: Replace /opt/kde4-deps with the location of your 3rd-party tools, and add your cmake location if you compiled from source
<code>export PATH="/opt/qt4/bin:/opt/kde4/bin:/opt/kde4-deps/bin:~/.local/bin/:$PATH"
export CMAKE_LIBRARY_PATH="/opt/kde4-deps/lib"
export CMAKE_INCLUDE_PATH="/opt/kde4-deps/include"
export PKG_CONFIG_PATH="/opt/qt4/lib/:/opt/kde4-deps/lib/pkgconfig/"
</code>

You might want to put those in your ~/.bash_profile

* For Fink users: If your ''Distribution'' line in ''/sw/etc/fink.conf'' is 10.4-transitional, instead of 10.4, make sure you run ''sudo gcc_select 3.3'' before proceeding with any compiling, or you will end up with binary-incompatible c++ code!
* For others: run ''sudo gcc_select 4.0'' if you want to be compatible with the pre-made installers.

== Required Third Party Tools ==
The following third party tools are required for successfully building KDE on OSX. Also, here are some [[Getting_Started/Build/KDE4/LFS| good tips for installing from source]].
* [http://developer.apple.com/technologies/xcode.html XCode]
* [http://www.gnu.org/software/libtool/libtool.html libtool]
<code>cd ~/kde4.build
curl http://ftp.gnu.org/gnu/libtool/libtool-2.2.tar.gz -O
tar xfz libtool-2.2.tar.gz
cd libtool-2.2
ls
./configure --prefix=/opt/kde4-deps
make
sudo make install</code>
* [http://www.xmlsoft.org/downloads.html libxml2 and libxslt]
<code>cd ~/kde4.build
curl ftp://xmlsoft.org/libxml2/libxml2-sources-2.7.7.tar.gz -O
tar xfz libxml2-sources-*.tar.gz
cd libxml2-2.7.7
./configure --prefix=/opt/kde4-deps/
make
sudo make install

cd ~/kde4.build
curl ftp://xmlsoft.org/libxml2/libxslt-1.1.26.tar.gz -O
tar xfz libxslt-*.tar.gz
cd libxslt-1.1.26
./configure --prefix=/opt/kde4-deps/
make
sudo make install
</code>
* [http://www.gtk.org/download.html glib2]
<code>I'M STUCK HERE</code>
* shared-mime-info
* AGG
* giflib or libungif
* libart_lgpl
* libidn
* libjpeg
* libmng
* libpng
* libusb
* OpenEXR
* PCRE
* Strigi
* pkgconfig
* subversion (to check out the kde sources)
* dbus

== Qt/Mac Open Source Edition ==
Get the Qt/Mac source code from http://qt.nokia.com/downloads/sdk-mac-os-cpp

The latest version has QtDBus and should work with KDE for Mac. Get it here: http://download.qt.nokia.com/qtsdk/qt-sdk-mac-opensource-2010.04.dmg

(statement make by entriken and unverified 2010-08-20)

== CMake ==
Get the latest CMake from http://www.cmake.org/cmake/resources/software.html#latest and install:

<code>cd ~/kde4.build
curl http://www.cmake.org/files/v2.8/cmake-2.8.2.tar.gz -O
tar xfz cmake-*.tar.gz
cd cmake-*
./configure --prefix=/opt/kde4-deps
make all
sudo make install</code>

== Building kdelibs ==
kdelibs must be checked out of svn locally to be built:
<code>cd ~/kde4.build
svn co svn://anonsvn.kde.org/home/kde/trunk/KDE/kdelibs</code>
And then compiled by performing the following:
<code>mkdir kdelibs.build
cd kdelibs.build
cmake ../kdelibs -DCMAKE_INSTALL_PREFIX=/opt/kde4
make all install</code>

== Troubleshooting ==
If kdelibs fails to compile successfully, check the build status for the latest Nightly Builds and Continuous Builds at http://public.kitware.com/dashboard.php?name=kde

Information about getting and compiling the dependencies can be found at [[Getting_Started/Build/KDE4]] and [[Getting_Started/Build/KDE4/Prerequisites]] (pages are Linux focused, but can be useful)

== Further Reading ==
For more general information on using CMake, see the [[Development/Tutorials/CMake|CMake Tutorial]].

[[Category:Mac OSX]]

Archive:Getting Started/Build/Mac OS X

2010-08-21T00:36:36Z

Fulldecent: /* CMake */

{{improve}}
{{Note|
If you're interested in just checking things out, binaries for kdelibs and parts of KDE in general are available at http://kde.mac.org and are generated semi-regularly.
}}

*Note: You may wish to do all of this inside a directory name that ends in ''.noindex'' or ''.build'' to keep spotlight from indexing all of your temporary build-files as you build them.

<code>mkdir ~/kde4.build
cd ~/kde4.build</code>

== Setting Up Your Build Environment ==
Variables must be set to build KDE successfully, and are noted below
*Note: Replace /opt/kde4-deps with the location of your 3rd-party tools, and add your cmake location if you compiled from source
<code>export PATH="/opt/qt4/bin:/opt/kde4/bin:/opt/kde4-deps/bin:$PATH"
export CMAKE_LIBRARY_PATH="/opt/kde4-deps/lib"
export CMAKE_INCLUDE_PATH="/opt/kde4-deps/include"
export PKG_CONFIG_PATH="/opt/qt4/lib/:/opt/kde4-deps/lib/pkgconfig/"
</code>

You might want to put those in your ~/.bash_profile

* For Fink users: If your ''Distribution'' line in ''/sw/etc/fink.conf'' is 10.4-transitional, instead of 10.4, make sure you run ''sudo gcc_select 3.3'' before proceeding with any compiling, or you will end up with binary-incompatible c++ code!
* For others: run ''sudo gcc_select 4.0'' if you want to be compatible with the pre-made installers.

== Required Third Party Tools ==
The following third party tools are required for successfully building KDE on OSX. Also, here are some [[Getting_Started/Build/KDE4/LFS| good tips for installing from source]].
* [http://developer.apple.com/technologies/xcode.html XCode]
* [http://www.gnu.org/software/libtool/libtool.html libtool]
<code>cd ~/kde4.build
curl http://ftp.gnu.org/gnu/libtool/libtool-2.2.tar.gz -O
tar xfz libtool-2.2.tar.gz
cd libtool-2.2
ls
./configure --prefix=/opt/kde4-deps
make
sudo make install</code>
* [http://www.xmlsoft.org/downloads.html libxml2 and libxslt]
<code>cd ~/kde4.build
curl ftp://xmlsoft.org/libxml2/libxml2-sources-2.7.7.tar.gz -O
tar xfz libxml2-sources-*.tar.gz
cd libxml2-2.7.7
./configure --prefix=/opt/kde4-deps/
make
sudo make install

cd ~/kde4.build
curl ftp://xmlsoft.org/libxml2/libxslt-1.1.26.tar.gz -O
tar xfz libxslt-*.tar.gz
cd libxslt-1.1.26
./configure --prefix=/opt/kde4-deps/
make
sudo make install
</code>
* [http://www.gtk.org/download.html glib2]
<code>I'M STUCK HERE</code>
* shared-mime-info
* AGG
* giflib or libungif
* libart_lgpl
* libidn
* libjpeg
* libmng
* libpng
* libusb
* OpenEXR
* PCRE
* Strigi
* pkgconfig
* subversion (to check out the kde sources)
* dbus

== Qt/Mac Open Source Edition ==
Get the Qt/Mac source code from http://qt.nokia.com/downloads/sdk-mac-os-cpp

The latest version has QtDBus and should work with KDE for Mac. Get it here: http://download.qt.nokia.com/qtsdk/qt-sdk-mac-opensource-2010.04.dmg

(statement make by entriken and unverified 2010-08-20)

== CMake ==
Get the latest CMake from http://www.cmake.org/cmake/resources/software.html#latest and install:

<code>cd ~/kde4.build
curl http://www.cmake.org/files/v2.8/cmake-2.8.2.tar.gz -O
tar xfz cmake-*.tar.gz
cd cmake-*
./configure --prefix=/opt/kde4-deps
make all
sudo make install</code>

== Building kdelibs ==
kdelibs must be checked out of svn locally to be built:
<code>cd ~/kde4.build
svn co svn://anonsvn.kde.org/home/kde/trunk/KDE/kdelibs</code>
And then compiled by performing the following:
<code>mkdir kdelibs.build
cd kdelibs.build
cmake ../kdelibs -DCMAKE_INSTALL_PREFIX=/opt/kde4
make all install</code>

== Troubleshooting ==
If kdelibs fails to compile successfully, check the build status for the latest Nightly Builds and Continuous Builds at http://public.kitware.com/dashboard.php?name=kde

Information about getting and compiling the dependencies can be found at [[Getting_Started/Build/KDE4]] and [[Getting_Started/Build/KDE4/Prerequisites]] (pages are Linux focused, but can be useful)

== Further Reading ==
For more general information on using CMake, see the [[Development/Tutorials/CMake|CMake Tutorial]].

[[Category:Mac OSX]]

Archive:Getting Started/Build/Mac OS X

2010-08-20T23:29:08Z

Fulldecent: /* Required Third Party Tools */

{{improve}}
{{Note|
If you're interested in just checking things out, binaries for kdelibs and parts of KDE in general are available at http://kde.mac.org and are generated semi-regularly.
}}

*Note: You may wish to do all of this inside a directory name that ends in ''.noindex'' or ''.build'' to keep spotlight from indexing all of your temporary build-files as you build them.

<code>mkdir ~/kde4.build
cd ~/kde4.build</code>

== Setting Up Your Build Environment ==
Variables must be set to build KDE successfully, and are noted below
*Note: Replace /opt/kde4-deps with the location of your 3rd-party tools, and add your cmake location if you compiled from source
<code>export PATH="/opt/qt4/bin:/opt/kde4/bin:/opt/kde4-deps/bin:$PATH"
export CMAKE_LIBRARY_PATH="/opt/kde4-deps/lib"
export CMAKE_INCLUDE_PATH="/opt/kde4-deps/include"
export PKG_CONFIG_PATH="/opt/qt4/lib/:/opt/kde4-deps/lib/pkgconfig/"
</code>

You might want to put those in your ~/.bash_profile

* For Fink users: If your ''Distribution'' line in ''/sw/etc/fink.conf'' is 10.4-transitional, instead of 10.4, make sure you run ''sudo gcc_select 3.3'' before proceeding with any compiling, or you will end up with binary-incompatible c++ code!
* For others: run ''sudo gcc_select 4.0'' if you want to be compatible with the pre-made installers.

== Required Third Party Tools ==
The following third party tools are required for successfully building KDE on OSX. Also, here are some [[Getting_Started/Build/KDE4/LFS| good tips for installing from source]].
* [http://developer.apple.com/technologies/xcode.html XCode]
* [http://www.gnu.org/software/libtool/libtool.html libtool]
<code>cd ~/kde4.build
curl http://ftp.gnu.org/gnu/libtool/libtool-2.2.tar.gz -O
tar xfz libtool-2.2.tar.gz
cd libtool-2.2
ls
./configure --prefix=/opt/kde4-deps
make
sudo make install</code>
* [http://www.xmlsoft.org/downloads.html libxml2 and libxslt]
<code>cd ~/kde4.build
curl ftp://xmlsoft.org/libxml2/libxml2-sources-2.7.7.tar.gz -O
tar xfz libxml2-sources-*.tar.gz
cd libxml2-2.7.7
./configure --prefix=/opt/kde4-deps/
make
sudo make install

cd ~/kde4.build
curl ftp://xmlsoft.org/libxml2/libxslt-1.1.26.tar.gz -O
tar xfz libxslt-*.tar.gz
cd libxslt-1.1.26
./configure --prefix=/opt/kde4-deps/
make
sudo make install
</code>
* [http://www.gtk.org/download.html glib2]
<code>I'M STUCK HERE</code>
* shared-mime-info
* AGG
* giflib or libungif
* libart_lgpl
* libidn
* libjpeg
* libmng
* libpng
* libusb
* OpenEXR
* PCRE
* Strigi
* pkgconfig
* subversion (to check out the kde sources)
* dbus

== Qt/Mac Open Source Edition ==
Get the Qt/Mac source code from http://qt.nokia.com/downloads/sdk-mac-os-cpp

The latest version has QtDBus and should work with KDE for Mac. Get it here: http://download.qt.nokia.com/qtsdk/qt-sdk-mac-opensource-2010.04.dmg

(statement make by entriken and unverified 2010-08-20)

== CMake ==
Get the latest CMake from http://www.cmake.org/cmake/resources/software.html#latest and install:

<code>curl http://www.cmake.org/files/v2.8/cmake-2.8.2.tar.gz -O
tar xfz cmake-*.tar.gz
cd cmake-*
./configure --prefix=/opt/kde4-deps
make all
sudo make install</code>

== Building kdelibs ==
kdelibs must be checked out of svn locally to be built:
<code>cd ~/kde4.build
svn co svn://anonsvn.kde.org/home/kde/trunk/KDE/kdelibs</code>
And then compiled by performing the following:
<code>mkdir kdelibs.build
cd kdelibs.build
cmake ../kdelibs -DCMAKE_INSTALL_PREFIX=/opt/kde4
make all install</code>

== Troubleshooting ==
If kdelibs fails to compile successfully, check the build status for the latest Nightly Builds and Continuous Builds at http://public.kitware.com/dashboard.php?name=kde

Information about getting and compiling the dependencies can be found at [[Getting_Started/Build/KDE4]] and [[Getting_Started/Build/KDE4/Prerequisites]] (pages are Linux focused, but can be useful)

== Further Reading ==
For more general information on using CMake, see the [[Development/Tutorials/CMake|CMake Tutorial]].

[[Category:Mac OSX]]

Archive:Getting Started/Build/Mac OS X

2010-08-20T23:27:56Z

Fulldecent: /* Qt/Mac Open Source Edition */

{{improve}}
{{Note|
If you're interested in just checking things out, binaries for kdelibs and parts of KDE in general are available at http://kde.mac.org and are generated semi-regularly.
}}

*Note: You may wish to do all of this inside a directory name that ends in ''.noindex'' or ''.build'' to keep spotlight from indexing all of your temporary build-files as you build them.

<code>mkdir ~/kde4.build
cd ~/kde4.build</code>

== Setting Up Your Build Environment ==
Variables must be set to build KDE successfully, and are noted below
*Note: Replace /opt/kde4-deps with the location of your 3rd-party tools, and add your cmake location if you compiled from source
<code>export PATH="/opt/qt4/bin:/opt/kde4/bin:/opt/kde4-deps/bin:$PATH"
export CMAKE_LIBRARY_PATH="/opt/kde4-deps/lib"
export CMAKE_INCLUDE_PATH="/opt/kde4-deps/include"
export PKG_CONFIG_PATH="/opt/qt4/lib/:/opt/kde4-deps/lib/pkgconfig/"
</code>

You might want to put those in your ~/.bash_profile

* For Fink users: If your ''Distribution'' line in ''/sw/etc/fink.conf'' is 10.4-transitional, instead of 10.4, make sure you run ''sudo gcc_select 3.3'' before proceeding with any compiling, or you will end up with binary-incompatible c++ code!
* For others: run ''sudo gcc_select 4.0'' if you want to be compatible with the pre-made installers.

== Required Third Party Tools ==
The following third party tools are required for successfully building KDE on OSX. Also, here are some [[Getting_Started/Build/KDE4/LFS| good tips for installing from source]].
* [http://developer.apple.com/technologies/xcode.html XCode]
* [http://www.gnu.org/software/libtool/libtool.html libtool]
<code>cd ~/kde4.build
curl http://ftp.gnu.org/gnu/libtool/libtool-2.2.tar.gz -O
tar xfz libtool-2.2.tar.gz
cd libtool-2.2
ls
./configure --prefix=/opt/kde4-deps
make
sudo make install</code>
* [http://www.xmlsoft.org/downloads.html libxml2 and libxslt]
<code>cd ~/kde4.build
curl ftp://xmlsoft.org/libxml2/libxml2-sources-2.7.7.tar.gz -O
tar xfz libxml2-sources-*.tar.gz
cd libxml2-2.7.7
./configure --prefix=/opt/kde4-deps/
make
sudo make install

cd ~/kde4.build
curl ftp://xmlsoft.org/libxml2/libxslt-1.1.26.tar.gz -O
tar xfz libxslt-*.tar.gz
cd libxslt-1.1.26
./configure --prefix=/opt/kde4-deps/
make
sudo make install
</code>
* [http://www.gtk.org/download.html glib2]
<code></code>
* AGG
* giflib or libungif
* libart_lgpl
* libidn
* libjpeg
* libmng
* libpng
* libusb
* OpenEXR
* PCRE
* Strigi
* shared-mime-info
* pkgconfig
* subversion (to check out the kde sources)
* dbus

== Qt/Mac Open Source Edition ==
Get the Qt/Mac source code from http://qt.nokia.com/downloads/sdk-mac-os-cpp

The latest version has QtDBus and should work with KDE for Mac. Get it here: http://download.qt.nokia.com/qtsdk/qt-sdk-mac-opensource-2010.04.dmg

(statement make by entriken and unverified 2010-08-20)

== CMake ==
Get the latest CMake from http://www.cmake.org/cmake/resources/software.html#latest and install:

<code>curl http://www.cmake.org/files/v2.8/cmake-2.8.2.tar.gz -O
tar xfz cmake-*.tar.gz
cd cmake-*
./configure --prefix=/opt/kde4-deps
make all
sudo make install</code>

== Building kdelibs ==
kdelibs must be checked out of svn locally to be built:
<code>cd ~/kde4.build
svn co svn://anonsvn.kde.org/home/kde/trunk/KDE/kdelibs</code>
And then compiled by performing the following:
<code>mkdir kdelibs.build
cd kdelibs.build
cmake ../kdelibs -DCMAKE_INSTALL_PREFIX=/opt/kde4
make all install</code>

== Troubleshooting ==
If kdelibs fails to compile successfully, check the build status for the latest Nightly Builds and Continuous Builds at http://public.kitware.com/dashboard.php?name=kde

Information about getting and compiling the dependencies can be found at [[Getting_Started/Build/KDE4]] and [[Getting_Started/Build/KDE4/Prerequisites]] (pages are Linux focused, but can be useful)

== Further Reading ==
For more general information on using CMake, see the [[Development/Tutorials/CMake|CMake Tutorial]].

[[Category:Mac OSX]]

Archive:Getting Started/Build/Mac OS X

2010-08-20T23:12:04Z

Fulldecent: /* Setting Up Your Build Environment */

{{improve}}
{{Note|
If you're interested in just checking things out, binaries for kdelibs and parts of KDE in general are available at http://kde.mac.org and are generated semi-regularly.
}}

*Note: You may wish to do all of this inside a directory name that ends in ''.noindex'' or ''.build'' to keep spotlight from indexing all of your temporary build-files as you build them.

<code>mkdir ~/kde4.build
cd ~/kde4.build</code>

== Setting Up Your Build Environment ==
Variables must be set to build KDE successfully, and are noted below
*Note: Replace /opt/kde4-deps with the location of your 3rd-party tools, and add your cmake location if you compiled from source
<code>export PATH="/opt/qt4/bin:/opt/kde4/bin:/opt/kde4-deps/bin:$PATH"
export CMAKE_LIBRARY_PATH="/opt/kde4-deps/lib"
export CMAKE_INCLUDE_PATH="/opt/kde4-deps/include"
export PKG_CONFIG_PATH="/opt/qt4/lib/:/opt/kde4-deps/lib/pkgconfig/"
</code>

You might want to put those in your ~/.bash_profile

* For Fink users: If your ''Distribution'' line in ''/sw/etc/fink.conf'' is 10.4-transitional, instead of 10.4, make sure you run ''sudo gcc_select 3.3'' before proceeding with any compiling, or you will end up with binary-incompatible c++ code!
* For others: run ''sudo gcc_select 4.0'' if you want to be compatible with the pre-made installers.

== Required Third Party Tools ==
The following third party tools are required for successfully building KDE on OSX. Also, here are some [[Getting_Started/Build/KDE4/LFS| good tips for installing from source]].
* [http://developer.apple.com/technologies/xcode.html XCode]
* [http://www.gnu.org/software/libtool/libtool.html libtool]
<code>cd ~/kde4.build
curl http://ftp.gnu.org/gnu/libtool/libtool-2.2.tar.gz -O
tar xfz libtool-2.2.tar.gz
cd libtool-2.2
ls
./configure --prefix=/opt/kde4-deps
make
sudo make install</code>
* [http://www.xmlsoft.org/downloads.html libxml2 and libxslt]
<code>cd ~/kde4.build
curl ftp://xmlsoft.org/libxml2/libxml2-sources-2.7.7.tar.gz -O
tar xfz libxml2-sources-*.tar.gz
cd libxml2-2.7.7
./configure --prefix=/opt/kde4-deps/
make
sudo make install

cd ~/kde4.build
curl ftp://xmlsoft.org/libxml2/libxslt-1.1.26.tar.gz -O
tar xfz libxslt-*.tar.gz
cd libxslt-1.1.26
./configure --prefix=/opt/kde4-deps/
make
sudo make install
</code>
* [http://www.gtk.org/download.html glib2]
<code></code>
* AGG
* giflib or libungif
* libart_lgpl
* libidn
* libjpeg
* libmng
* libpng
* libusb
* OpenEXR
* PCRE
* Strigi
* shared-mime-info
* pkgconfig
* subversion (to check out the kde sources)
* dbus

== Qt/Mac Open Source Edition ==
Get the Qt/Mac source code from http://qt.nokia.com/downloads/qt-for-open-source-cpp-development-on-mac-os-x

<code>curl http://get.qt.nokia.com/qt/source/qt-everywhere-opensource-src-4.6.3.tar.gz -O
tar xfz qt-everywhere-opensource-src-*.tar.gz</code>

Patches are required for a successful build. Download the qt-copy patches through KDE's svn:
<code>svn co svn://anonsvn.kde.org/home/kde/trunk/qt-copy/patches/</code>
and apply the patches:
<code>cd qt-mac-opensource-4*
for patch in /path/to/patches/*.diff; do patch -p0 < $patch; done
</code>
Note: when applying patches you will get errors when processing x11 specific files (i.e. files that match the pattern *_x11.{h,cpp}), simply skip those patches.

And finally, compile qt-mac:
<code>./configure -prefix /opt/qt4 -qt-gif
make all install</code>

Please note: The Qt/Mac binary edition available from ftp.trolltech.com will '''not''' work,
because it does not contain the QtDBus module! (tested with 4.3.2)

== CMake ==
Get the latest CMake from http://www.cmake.org/cmake/resources/software.html#latest and install:

<code>curl http://www.cmake.org/files/v2.8/cmake-2.8.2.tar.gz -O
tar xfz cmake-*.tar.gz
cd cmake-*
./configure --prefix=/opt/kde4-deps
make all
sudo make install</code>

== Building kdelibs ==
kdelibs must be checked out of svn locally to be built:
<code>cd ~/kde4.build
svn co svn://anonsvn.kde.org/home/kde/trunk/KDE/kdelibs</code>
And then compiled by performing the following:
<code>mkdir kdelibs.build
cd kdelibs.build
cmake ../kdelibs -DCMAKE_INSTALL_PREFIX=/opt/kde4
make all install</code>

== Troubleshooting ==
If kdelibs fails to compile successfully, check the build status for the latest Nightly Builds and Continuous Builds at http://public.kitware.com/dashboard.php?name=kde

Information about getting and compiling the dependencies can be found at [[Getting_Started/Build/KDE4]] and [[Getting_Started/Build/KDE4/Prerequisites]] (pages are Linux focused, but can be useful)

== Further Reading ==
For more general information on using CMake, see the [[Development/Tutorials/CMake|CMake Tutorial]].

[[Category:Mac OSX]]

Archive:Getting Started/Build/Mac OS X

2010-08-20T23:06:28Z

Fulldecent: /* Required Third Party Tools */

{{improve}}
{{Note|
If you're interested in just checking things out, binaries for kdelibs and parts of KDE in general are available at http://kde.mac.org and are generated semi-regularly.
}}

*Note: You may wish to do all of this inside a directory name that ends in ''.noindex'' or ''.build'' to keep spotlight from indexing all of your temporary build-files as you build them.

<code>mkdir ~/kde4.build
cd ~/kde4.build</code>

== Setting Up Your Build Environment ==
Variables must be set to build KDE successfully, and are noted below
*Note: Replace /opt/kde4-deps with the location of your 3rd-party tools, and add your cmake location if you compiled from source
<code>export PATH="/opt/qt4/bin:/opt/kde4/bin:/opt/kde4-deps/bin:$PATH"
export CMAKE_LIBRARY_PATH="/opt/kde4-deps/lib"
export CMAKE_INCLUDE_PATH="/opt/kde4-deps/include"
export PKG_CONFIG_PATH="/opt/qt4/lib/"</code>

You might want to put those in your ~/.bash_profile

* For Fink users: If your ''Distribution'' line in ''/sw/etc/fink.conf'' is 10.4-transitional, instead of 10.4, make sure you run ''sudo gcc_select 3.3'' before proceeding with any compiling, or you will end up with binary-incompatible c++ code!
* For others: run ''sudo gcc_select 4.0'' if you want to be compatible with the pre-made installers.

== Required Third Party Tools ==
The following third party tools are required for successfully building KDE on OSX. Also, here are some [[Getting_Started/Build/KDE4/LFS| good tips for installing from source]].
* [http://developer.apple.com/technologies/xcode.html XCode]
* [http://www.gnu.org/software/libtool/libtool.html libtool]
<code>cd ~/kde4.build
curl http://ftp.gnu.org/gnu/libtool/libtool-2.2.tar.gz -O
tar xfz libtool-2.2.tar.gz
cd libtool-2.2
ls
./configure --prefix=/opt/kde4-deps
make
sudo make install</code>
* [http://www.xmlsoft.org/downloads.html libxml2 and libxslt]
<code>cd ~/kde4.build
curl ftp://xmlsoft.org/libxml2/libxml2-sources-2.7.7.tar.gz -O
tar xfz libxml2-sources-*.tar.gz
cd libxml2-2.7.7
./configure --prefix=/opt/kde4-deps/
make
sudo make install

cd ~/kde4.build
curl ftp://xmlsoft.org/libxml2/libxslt-1.1.26.tar.gz -O
tar xfz libxslt-*.tar.gz
cd libxslt-1.1.26
./configure --prefix=/opt/kde4-deps/
make
sudo make install
</code>
* [http://www.gtk.org/download.html glib2]
<code></code>
* AGG
* giflib or libungif
* libart_lgpl
* libidn
* libjpeg
* libmng
* libpng
* libusb
* OpenEXR
* PCRE
* Strigi
* shared-mime-info
* pkgconfig
* subversion (to check out the kde sources)
* dbus

== Qt/Mac Open Source Edition ==
Get the Qt/Mac source code from http://qt.nokia.com/downloads/qt-for-open-source-cpp-development-on-mac-os-x

<code>curl http://get.qt.nokia.com/qt/source/qt-everywhere-opensource-src-4.6.3.tar.gz -O
tar xfz qt-everywhere-opensource-src-*.tar.gz</code>

Patches are required for a successful build. Download the qt-copy patches through KDE's svn:
<code>svn co svn://anonsvn.kde.org/home/kde/trunk/qt-copy/patches/</code>
and apply the patches:
<code>cd qt-mac-opensource-4*
for patch in /path/to/patches/*.diff; do patch -p0 < $patch; done
</code>
Note: when applying patches you will get errors when processing x11 specific files (i.e. files that match the pattern *_x11.{h,cpp}), simply skip those patches.

And finally, compile qt-mac:
<code>./configure -prefix /opt/qt4 -qt-gif
make all install</code>

Please note: The Qt/Mac binary edition available from ftp.trolltech.com will '''not''' work,
because it does not contain the QtDBus module! (tested with 4.3.2)

== CMake ==
Get the latest CMake from http://www.cmake.org/cmake/resources/software.html#latest and install:

<code>curl http://www.cmake.org/files/v2.8/cmake-2.8.2.tar.gz -O
tar xfz cmake-*.tar.gz
cd cmake-*
./configure --prefix=/opt/kde4-deps
make all
sudo make install</code>

== Building kdelibs ==
kdelibs must be checked out of svn locally to be built:
<code>cd ~/kde4.build
svn co svn://anonsvn.kde.org/home/kde/trunk/KDE/kdelibs</code>
And then compiled by performing the following:
<code>mkdir kdelibs.build
cd kdelibs.build
cmake ../kdelibs -DCMAKE_INSTALL_PREFIX=/opt/kde4
make all install</code>

== Troubleshooting ==
If kdelibs fails to compile successfully, check the build status for the latest Nightly Builds and Continuous Builds at http://public.kitware.com/dashboard.php?name=kde

Information about getting and compiling the dependencies can be found at [[Getting_Started/Build/KDE4]] and [[Getting_Started/Build/KDE4/Prerequisites]] (pages are Linux focused, but can be useful)

== Further Reading ==
For more general information on using CMake, see the [[Development/Tutorials/CMake|CMake Tutorial]].

[[Category:Mac OSX]]

Archive:Getting Started/Build/Mac OS X

2010-08-20T22:48:29Z

Fulldecent: /* Required Third Party Tools */

{{improve}}
{{Note|
If you're interested in just checking things out, binaries for kdelibs and parts of KDE in general are available at http://kde.mac.org and are generated semi-regularly.
}}

*Note: You may wish to do all of this inside a directory name that ends in ''.noindex'' or ''.build'' to keep spotlight from indexing all of your temporary build-files as you build them.

<code>mkdir ~/kde4.build
cd ~/kde4.build</code>

== Setting Up Your Build Environment ==
Variables must be set to build KDE successfully, and are noted below
*Note: Replace /opt/kde4-deps with the location of your 3rd-party tools, and add your cmake location if you compiled from source
<code>export PATH="/opt/qt4/bin:/opt/kde4/bin:/opt/kde4-deps/bin:$PATH"
export CMAKE_LIBRARY_PATH="/opt/kde4-deps/lib"
export CMAKE_INCLUDE_PATH="/opt/kde4-deps/include"
export PKG_CONFIG_PATH="/opt/qt4/lib/"</code>

You might want to put those in your ~/.bash_profile

* For Fink users: If your ''Distribution'' line in ''/sw/etc/fink.conf'' is 10.4-transitional, instead of 10.4, make sure you run ''sudo gcc_select 3.3'' before proceeding with any compiling, or you will end up with binary-incompatible c++ code!
* For others: run ''sudo gcc_select 4.0'' if you want to be compatible with the pre-made installers.

== Required Third Party Tools ==
The following third party tools are required for successfully building KDE on OSX. Also, here are some [[Getting_Started/Build/KDE4/LFS| good tips for installing from source]].
* [http://developer.apple.com/technologies/xcode.html XCode]
* [http://www.gnu.org/software/libtool/libtool.html libtool]
<code>cd ~/kde4.build
curl http://ftp.gnu.org/gnu/libtool/libtool-2.2.tar.gz -O
tar xfz libtool-2.2.tar.gz
cd libtool-2.2
ls
./configure --prefix=/opt/kde4-deps
make
sudo make install</code>
* [http://www.xmlsoft.org/downloads.html libxml2 and libxslt]
<code>curl -O http://www.explain.com.au/download/combo-2007-10-07.dmg.gz
gunzip combo-2007-10-07.dmg.gz
open combo-2007-10-07.dmg
cp /Volumes/gnome-combo-2007-10-07-rw/x* /opt/kde4-deps/
sudo cp /Volumes/gnome-combo-2007-10-07-rw/x* /opt/kde4-deps/</code>
* [http://www.gtk.org/download.html glib2]
<code></code>
* AGG
* giflib or libungif
* libart_lgpl
* libidn
* libjpeg
* libmng
* libpng
* libusb
* OpenEXR
* PCRE
* Strigi
* shared-mime-info
* pkgconfig
* subversion (to check out the kde sources)
* dbus

== Qt/Mac Open Source Edition ==
Get the Qt/Mac source code from http://qt.nokia.com/downloads/qt-for-open-source-cpp-development-on-mac-os-x

<code>curl http://get.qt.nokia.com/qt/source/qt-everywhere-opensource-src-4.6.3.tar.gz -O
tar xfz qt-everywhere-opensource-src-*.tar.gz</code>

Patches are required for a successful build. Download the qt-copy patches through KDE's svn:
<code>svn co svn://anonsvn.kde.org/home/kde/trunk/qt-copy/patches/</code>
and apply the patches:
<code>cd qt-mac-opensource-4*
for patch in /path/to/patches/*.diff; do patch -p0 < $patch; done
</code>
Note: when applying patches you will get errors when processing x11 specific files (i.e. files that match the pattern *_x11.{h,cpp}), simply skip those patches.

And finally, compile qt-mac:
<code>./configure -prefix /opt/qt4 -qt-gif
make all install</code>

Please note: The Qt/Mac binary edition available from ftp.trolltech.com will '''not''' work,
because it does not contain the QtDBus module! (tested with 4.3.2)

== CMake ==
Get the latest CMake from http://www.cmake.org/cmake/resources/software.html#latest and install:

<code>curl http://www.cmake.org/files/v2.8/cmake-2.8.2.tar.gz -O
tar xfz cmake-*.tar.gz
cd cmake-*
./configure --prefix=/opt/kde4-deps
make all
sudo make install</code>

== Building kdelibs ==
kdelibs must be checked out of svn locally to be built:
<code>cd ~/kde4.build
svn co svn://anonsvn.kde.org/home/kde/trunk/KDE/kdelibs</code>
And then compiled by performing the following:
<code>mkdir kdelibs.build
cd kdelibs.build
cmake ../kdelibs -DCMAKE_INSTALL_PREFIX=/opt/kde4
make all install</code>

== Troubleshooting ==
If kdelibs fails to compile successfully, check the build status for the latest Nightly Builds and Continuous Builds at http://public.kitware.com/dashboard.php?name=kde

Information about getting and compiling the dependencies can be found at [[Getting_Started/Build/KDE4]] and [[Getting_Started/Build/KDE4/Prerequisites]] (pages are Linux focused, but can be useful)

== Further Reading ==
For more general information on using CMake, see the [[Development/Tutorials/CMake|CMake Tutorial]].

[[Category:Mac OSX]]

Archive:Getting Started/Build/Mac OS X

2010-08-20T22:44:05Z

Fulldecent: /* Required Third Party Tools */

{{improve}}
{{Note|
If you're interested in just checking things out, binaries for kdelibs and parts of KDE in general are available at http://kde.mac.org and are generated semi-regularly.
}}

*Note: You may wish to do all of this inside a directory name that ends in ''.noindex'' or ''.build'' to keep spotlight from indexing all of your temporary build-files as you build them.

<code>mkdir ~/kde4.build
cd ~/kde4.build</code>

== Setting Up Your Build Environment ==
Variables must be set to build KDE successfully, and are noted below
*Note: Replace /opt/kde4-deps with the location of your 3rd-party tools, and add your cmake location if you compiled from source
<code>export PATH="/opt/qt4/bin:/opt/kde4/bin:/opt/kde4-deps/bin:$PATH"
export CMAKE_LIBRARY_PATH="/opt/kde4-deps/lib"
export CMAKE_INCLUDE_PATH="/opt/kde4-deps/include"
export PKG_CONFIG_PATH="/opt/qt4/lib/"</code>

You might want to put those in your ~/.bash_profile

* For Fink users: If your ''Distribution'' line in ''/sw/etc/fink.conf'' is 10.4-transitional, instead of 10.4, make sure you run ''sudo gcc_select 3.3'' before proceeding with any compiling, or you will end up with binary-incompatible c++ code!
* For others: run ''sudo gcc_select 4.0'' if you want to be compatible with the pre-made installers.

== Required Third Party Tools ==
The following third party tools are required for successfully building KDE on OSX. Also, here are some [[Getting_Started/Build/KDE4/LFS| good tips for installing from source]].
* [http://developer.apple.com/technologies/xcode.html XCode]
* [http://www.gnu.org/software/libtool/libtool.html libtool]
<code>cd ~/kde4.build
curl http://ftp.gnu.org/gnu/libtool/libtool-2.2.tar.gz -O
tar xfz libtool-2.2.tar.gz
cd libtool-2.2
ls
./configure --prefix=/opt/kde4-deps
make
sudo make install</code>
* [http://www.xmlsoft.org/downloads.html libxml2 and libxslt]
* Get binaries from http://www.explain.com.au/download/combo-2007-10-07.dmg.gz
* [http://www.gtk.org/download.html glib2]
<code></code>
* AGG
* giflib or libungif
* libart_lgpl
* libidn
* libjpeg
* libmng
* libpng
* libusb
* OpenEXR
* PCRE
* Strigi
* shared-mime-info
* pkgconfig
* subversion (to check out the kde sources)
* dbus

== Qt/Mac Open Source Edition ==
Get the Qt/Mac source code from http://qt.nokia.com/downloads/qt-for-open-source-cpp-development-on-mac-os-x

<code>curl http://get.qt.nokia.com/qt/source/qt-everywhere-opensource-src-4.6.3.tar.gz -O
tar xfz qt-everywhere-opensource-src-*.tar.gz</code>

Patches are required for a successful build. Download the qt-copy patches through KDE's svn:
<code>svn co svn://anonsvn.kde.org/home/kde/trunk/qt-copy/patches/</code>
and apply the patches:
<code>cd qt-mac-opensource-4*
for patch in /path/to/patches/*.diff; do patch -p0 < $patch; done
</code>
Note: when applying patches you will get errors when processing x11 specific files (i.e. files that match the pattern *_x11.{h,cpp}), simply skip those patches.

And finally, compile qt-mac:
<code>./configure -prefix /opt/qt4 -qt-gif
make all install</code>

Please note: The Qt/Mac binary edition available from ftp.trolltech.com will '''not''' work,
because it does not contain the QtDBus module! (tested with 4.3.2)

== CMake ==
Get the latest CMake from http://www.cmake.org/cmake/resources/software.html#latest and install:

<code>curl http://www.cmake.org/files/v2.8/cmake-2.8.2.tar.gz -O
tar xfz cmake-*.tar.gz
cd cmake-*
./configure --prefix=/opt/kde4-deps
make all
sudo make install</code>

== Building kdelibs ==
kdelibs must be checked out of svn locally to be built:
<code>cd ~/kde4.build
svn co svn://anonsvn.kde.org/home/kde/trunk/KDE/kdelibs</code>
And then compiled by performing the following:
<code>mkdir kdelibs.build
cd kdelibs.build
cmake ../kdelibs -DCMAKE_INSTALL_PREFIX=/opt/kde4
make all install</code>

== Troubleshooting ==
If kdelibs fails to compile successfully, check the build status for the latest Nightly Builds and Continuous Builds at http://public.kitware.com/dashboard.php?name=kde

Information about getting and compiling the dependencies can be found at [[Getting_Started/Build/KDE4]] and [[Getting_Started/Build/KDE4/Prerequisites]] (pages are Linux focused, but can be useful)

== Further Reading ==
For more general information on using CMake, see the [[Development/Tutorials/CMake|CMake Tutorial]].

[[Category:Mac OSX]]

Archive:Getting Started/Build/Mac OS X

2010-08-20T22:41:45Z

Fulldecent: /* Required Third Party Tools */

{{improve}}
{{Note|
If you're interested in just checking things out, binaries for kdelibs and parts of KDE in general are available at http://kde.mac.org and are generated semi-regularly.
}}

*Note: You may wish to do all of this inside a directory name that ends in ''.noindex'' or ''.build'' to keep spotlight from indexing all of your temporary build-files as you build them.

<code>mkdir ~/kde4.build
cd ~/kde4.build</code>

== Setting Up Your Build Environment ==
Variables must be set to build KDE successfully, and are noted below
*Note: Replace /opt/kde4-deps with the location of your 3rd-party tools, and add your cmake location if you compiled from source
<code>export PATH="/opt/qt4/bin:/opt/kde4/bin:/opt/kde4-deps/bin:$PATH"
export CMAKE_LIBRARY_PATH="/opt/kde4-deps/lib"
export CMAKE_INCLUDE_PATH="/opt/kde4-deps/include"
export PKG_CONFIG_PATH="/opt/qt4/lib/"</code>

You might want to put those in your ~/.bash_profile

* For Fink users: If your ''Distribution'' line in ''/sw/etc/fink.conf'' is 10.4-transitional, instead of 10.4, make sure you run ''sudo gcc_select 3.3'' before proceeding with any compiling, or you will end up with binary-incompatible c++ code!
* For others: run ''sudo gcc_select 4.0'' if you want to be compatible with the pre-made installers.

== Required Third Party Tools ==
The following third party tools are required for successfully building KDE on OSX. Also, here are some [[Getting_Started/Build/KDE4/LFS| good tips for installing from source]].
* [http://developer.apple.com/technologies/xcode.html XCode]
* [http://www.gnu.org/software/libtool/libtool.html libtool]
<code>cd ~/kde4.build
curl http://ftp.gnu.org/gnu/libtool/libtool-2.2.tar.gz -O
tar xfz libtool-2.2.tar.gz
cd libtool-2.2
ls
./configure --prefix=/opt/kde4-deps
make
sudo make install</code>
* [http://www.xmlsoft.org/downloads.html libxml2]
<code>cd ~/kde4.build
git clone git://git.gnome.org/libxml2
cd libxml2
I DONT KNOW WHAT TO DO HERE</code>
* [http://www.gtk.org/download.html glib2]
<code></code>
* AGG
* giflib or libungif
* libart_lgpl
* libidn
* libjpeg
* libmng
* libpng
* libxslt
* libusb
* OpenEXR
* PCRE
* Strigi
* shared-mime-info
* pkgconfig
* subversion (to check out the kde sources)
* dbus

== Qt/Mac Open Source Edition ==
Get the Qt/Mac source code from http://qt.nokia.com/downloads/qt-for-open-source-cpp-development-on-mac-os-x

<code>curl http://get.qt.nokia.com/qt/source/qt-everywhere-opensource-src-4.6.3.tar.gz -O
tar xfz qt-everywhere-opensource-src-*.tar.gz</code>

Patches are required for a successful build. Download the qt-copy patches through KDE's svn:
<code>svn co svn://anonsvn.kde.org/home/kde/trunk/qt-copy/patches/</code>
and apply the patches:
<code>cd qt-mac-opensource-4*
for patch in /path/to/patches/*.diff; do patch -p0 < $patch; done
</code>
Note: when applying patches you will get errors when processing x11 specific files (i.e. files that match the pattern *_x11.{h,cpp}), simply skip those patches.

And finally, compile qt-mac:
<code>./configure -prefix /opt/qt4 -qt-gif
make all install</code>

Please note: The Qt/Mac binary edition available from ftp.trolltech.com will '''not''' work,
because it does not contain the QtDBus module! (tested with 4.3.2)

== CMake ==
Get the latest CMake from http://www.cmake.org/cmake/resources/software.html#latest and install:

<code>curl http://www.cmake.org/files/v2.8/cmake-2.8.2.tar.gz -O
tar xfz cmake-*.tar.gz
cd cmake-*
./configure --prefix=/opt/kde4-deps
make all
sudo make install</code>

== Building kdelibs ==
kdelibs must be checked out of svn locally to be built:
<code>cd ~/kde4.build
svn co svn://anonsvn.kde.org/home/kde/trunk/KDE/kdelibs</code>
And then compiled by performing the following:
<code>mkdir kdelibs.build
cd kdelibs.build
cmake ../kdelibs -DCMAKE_INSTALL_PREFIX=/opt/kde4
make all install</code>

== Troubleshooting ==
If kdelibs fails to compile successfully, check the build status for the latest Nightly Builds and Continuous Builds at http://public.kitware.com/dashboard.php?name=kde

Information about getting and compiling the dependencies can be found at [[Getting_Started/Build/KDE4]] and [[Getting_Started/Build/KDE4/Prerequisites]] (pages are Linux focused, but can be useful)

== Further Reading ==
For more general information on using CMake, see the [[Development/Tutorials/CMake|CMake Tutorial]].

[[Category:Mac OSX]]

Archive:Getting Started/Build/Mac OS X

2010-08-20T22:41:04Z

Fulldecent:

{{improve}}
{{Note|
If you're interested in just checking things out, binaries for kdelibs and parts of KDE in general are available at http://kde.mac.org and are generated semi-regularly.
}}

*Note: You may wish to do all of this inside a directory name that ends in ''.noindex'' or ''.build'' to keep spotlight from indexing all of your temporary build-files as you build them.

<code>mkdir ~/kde4.build
cd ~/kde4.build</code>

== Setting Up Your Build Environment ==
Variables must be set to build KDE successfully, and are noted below
*Note: Replace /opt/kde4-deps with the location of your 3rd-party tools, and add your cmake location if you compiled from source
<code>export PATH="/opt/qt4/bin:/opt/kde4/bin:/opt/kde4-deps/bin:$PATH"
export CMAKE_LIBRARY_PATH="/opt/kde4-deps/lib"
export CMAKE_INCLUDE_PATH="/opt/kde4-deps/include"
export PKG_CONFIG_PATH="/opt/qt4/lib/"</code>

You might want to put those in your ~/.bash_profile

* For Fink users: If your ''Distribution'' line in ''/sw/etc/fink.conf'' is 10.4-transitional, instead of 10.4, make sure you run ''sudo gcc_select 3.3'' before proceeding with any compiling, or you will end up with binary-incompatible c++ code!
* For others: run ''sudo gcc_select 4.0'' if you want to be compatible with the pre-made installers.

== Required Third Party Tools ==
The following third party tools are required for successfully building KDE on OSX. Also, here are some [[Getting_Started/Build/KDE4/LFS| good tips for installing from source]].
* [http://developer.apple.com/technologies/xcode.html XCode]
* [http://www.gnu.org/software/libtool/libtool.html libtool]
<code>curl http://ftp.gnu.org/gnu/libtool/libtool-2.2.tar.gz -O
tar xfz libtool-2.2.tar.gz
cd libtool-2.2
ls
./configure --prefix=/opt/kde4-deps
make
sudo make install</code>
* [http://www.xmlsoft.org/downloads.html libxml2]
<code>cd ~/kde4.build
git clone git://git.gnome.org/libxml2
cd libxml2
I DONT KNOW WHAT TO DO HERE</code>
* [http://www.gtk.org/download.html glib2]
<code></code>
* AGG
* giflib or libungif
* libart_lgpl
* libidn
* libjpeg
* libmng
* libpng
* libxslt
* libusb
* OpenEXR
* PCRE
* Strigi
* shared-mime-info
* pkgconfig
* subversion (to check out the kde sources)
* dbus

== Qt/Mac Open Source Edition ==
Get the Qt/Mac source code from http://qt.nokia.com/downloads/qt-for-open-source-cpp-development-on-mac-os-x

<code>curl http://get.qt.nokia.com/qt/source/qt-everywhere-opensource-src-4.6.3.tar.gz -O
tar xfz qt-everywhere-opensource-src-*.tar.gz</code>

Patches are required for a successful build. Download the qt-copy patches through KDE's svn:
<code>svn co svn://anonsvn.kde.org/home/kde/trunk/qt-copy/patches/</code>
and apply the patches:
<code>cd qt-mac-opensource-4*
for patch in /path/to/patches/*.diff; do patch -p0 < $patch; done
</code>
Note: when applying patches you will get errors when processing x11 specific files (i.e. files that match the pattern *_x11.{h,cpp}), simply skip those patches.

And finally, compile qt-mac:
<code>./configure -prefix /opt/qt4 -qt-gif
make all install</code>

Please note: The Qt/Mac binary edition available from ftp.trolltech.com will '''not''' work,
because it does not contain the QtDBus module! (tested with 4.3.2)

== CMake ==
Get the latest CMake from http://www.cmake.org/cmake/resources/software.html#latest and install:

<code>curl http://www.cmake.org/files/v2.8/cmake-2.8.2.tar.gz -O
tar xfz cmake-*.tar.gz
cd cmake-*
./configure --prefix=/opt/kde4-deps
make all
sudo make install</code>

== Building kdelibs ==
kdelibs must be checked out of svn locally to be built:
<code>cd ~/kde4.build
svn co svn://anonsvn.kde.org/home/kde/trunk/KDE/kdelibs</code>
And then compiled by performing the following:
<code>mkdir kdelibs.build
cd kdelibs.build
cmake ../kdelibs -DCMAKE_INSTALL_PREFIX=/opt/kde4
make all install</code>

== Troubleshooting ==
If kdelibs fails to compile successfully, check the build status for the latest Nightly Builds and Continuous Builds at http://public.kitware.com/dashboard.php?name=kde

Information about getting and compiling the dependencies can be found at [[Getting_Started/Build/KDE4]] and [[Getting_Started/Build/KDE4/Prerequisites]] (pages are Linux focused, but can be useful)

== Further Reading ==
For more general information on using CMake, see the [[Development/Tutorials/CMake|CMake Tutorial]].

[[Category:Mac OSX]]

Archive:Getting Started/Build/Mac OS X

2010-08-20T22:38:37Z

Fulldecent: /* Required Third Party Tools */

{{improve}}
{{Note|
If you're interested in just checking things out, binaries for kdelibs and parts of KDE in general are available at http://kde.mac.org and are generated semi-regularly.
}}

*Note: You may wish to do all of this inside a directory name that ends in ''.noindex'' or ''.build'' to keep spotlight from indexing all of your temporary build-files as you build them.

<code>mkdir ~/kde4.build
cd ~/kde4.build</code>

== Required Third Party Tools ==
The following third party tools are required for successfully building KDE on OSX. Also, here are some [[Getting_Started/Build/KDE4/LFS| good tips for installing from source]].
* [http://developer.apple.com/technologies/xcode.html XCode]
* [http://www.gnu.org/software/libtool/libtool.html libtool]
<code>curl http://ftp.gnu.org/gnu/libtool/libtool-2.2.tar.gz -O
tar xfz libtool-2.2.tar.gz
cd libtool-2.2
ls
./configure --prefix=/opt/kde4-deps
make
sudo make install</code>
* [http://www.xmlsoft.org/downloads.html libxml2]
<code>cd ~/kde4.build
git clone git://git.gnome.org/libxml2
cd libxml2
I DONT KNOW WHAT TO DO HERE</code>
* [http://www.gtk.org/download.html glib2]
<code></code>
* AGG
* giflib or libungif
* libart_lgpl
* libidn
* libjpeg
* libmng
* libpng
* libxslt
* libusb
* OpenEXR
* PCRE
* Strigi
* shared-mime-info
* pkgconfig
* subversion (to check out the kde sources)
* dbus

== Verify Compiler Version ==
* Fink: If your ''Distribution'' line in ''/sw/etc/fink.conf'' is 10.4-transitional, instead of 10.4, make sure you run ''sudo gcc_select 3.3'' before proceeding with any compiling, or you will end up with binary-incompatible c++ code!
* Manual: run ''sudo gcc_select 4.0'' if you want to be compatible with the pre-made installers.
== Qt/Mac Open Source Edition ==
Get the Qt/Mac source code from http://qt.nokia.com/downloads/qt-for-open-source-cpp-development-on-mac-os-x

<code>curl http://get.qt.nokia.com/qt/source/qt-everywhere-opensource-src-4.6.3.tar.gz -O
tar xfz qt-everywhere-opensource-src-*.tar.gz</code>

Patches are required for a successful build. Download the qt-copy patches through KDE's svn:
<code>svn co svn://anonsvn.kde.org/home/kde/trunk/qt-copy/patches/</code>
and apply the patches:
<code>cd qt-mac-opensource-4*
for patch in /path/to/patches/*.diff; do patch -p0 < $patch; done
</code>
Note: when applying patches you will get errors when processing x11 specific files (i.e. files that match the pattern *_x11.{h,cpp}), simply skip those patches.

And finally, compile qt-mac:
<code>./configure -prefix /opt/qt4 -qt-gif
make all install</code>

Please note: The Qt/Mac binary edition available from ftp.trolltech.com will '''not''' work,
because it does not contain the QtDBus module! (tested with 4.3.2)

== CMake ==
Get the latest CMake from http://www.cmake.org/cmake/resources/software.html#latest and install:

<code>curl http://www.cmake.org/files/v2.8/cmake-2.8.2.tar.gz -O
tar xfz cmake-*.tar.gz
cd cmake-*
./configure --prefix=/opt/kde4-deps
make all
sudo make install</code>

== Setting Up Your Build Environment ==
Variable must be set to build KDE successfully, and are noted below
*Note: Replace /opt/kde4-deps with the location of your 3rd-party tools, and add your cmake location if you compiled from source
<code>export PATH="/opt/qt4/bin:/opt/kde4/bin:/opt/kde4-deps/bin:$PATH"
export CMAKE_LIBRARY_PATH="/opt/kde4-deps/lib"
export CMAKE_INCLUDE_PATH="/opt/kde4-deps/include"
export PKG_CONFIG_PATH="/opt/qt4/lib/"</code>
== Building kdelibs ==
kdelibs must be checked out of svn locally to be built:
<code>cd ~/kde4.build
svn co svn://anonsvn.kde.org/home/kde/trunk/KDE/kdelibs</code>
And then compiled by performing the following:
<code>mkdir kdelibs.build
cd kdelibs.build
cmake ../kdelibs -DCMAKE_INSTALL_PREFIX=/opt/kde4
make all install</code>

== Troubleshooting ==
If kdelibs fails to compile successfully, check the build status for the latest Nightly Builds and Continuous Builds at http://public.kitware.com/dashboard.php?name=kde

Information about getting and compiling the dependencies can be found at [[Getting_Started/Build/KDE4]] and [[Getting_Started/Build/KDE4/Prerequisites]] (pages are Linux focused, but can be useful)

== Further Reading ==
For more general information on using CMake, see the [[Development/Tutorials/CMake|CMake Tutorial]].

[[Category:Mac OSX]]

Archive:Getting Started/Build/Mac OS X

2010-08-20T22:04:33Z

Fulldecent:

{{improve}}
{{Note|
If you're interested in just checking things out, binaries for kdelibs and parts of KDE in general are available at http://kde.mac.org and are generated semi-regularly.
}}

*Note: You may wish to do all of this inside a directory name that ends in ''.noindex'' or ''.build'' to keep spotlight from indexing all of your temporary build-files as you build them.

<code>mkdir ~/kde4.build
cd ~/kde4.build</code>

== Required Third Party Tools ==
The following third party tools are required for successfully building KDE on OSX. Also, here are some [[Getting_Started/Build/KDE4/LFS| good tips for installing from source]].
* [http://developer.apple.com/technologies/xcode.html XCode]
* AGG
* giflib or libungif
* libart_lgpl
* libidn
* libjpeg
* libmng
* libpng
* libxml2
* libxslt
* libusb
* OpenEXR
* PCRE
* Strigi
* shared-mime-info
* pkgconfig
* subversion (to check out the kde sources)
* dbus

== Verify Compiler Version ==
* Fink: If your ''Distribution'' line in ''/sw/etc/fink.conf'' is 10.4-transitional, instead of 10.4, make sure you run ''sudo gcc_select 3.3'' before proceeding with any compiling, or you will end up with binary-incompatible c++ code!
* Manual: run ''sudo gcc_select 4.0'' if you want to be compatible with the pre-made installers.
== Qt/Mac Open Source Edition ==
Get the Qt/Mac source code from http://qt.nokia.com/downloads/qt-for-open-source-cpp-development-on-mac-os-x

<code>curl http://get.qt.nokia.com/qt/source/qt-everywhere-opensource-src-4.6.3.tar.gz -O
tar xfz qt-everywhere-opensource-src-*.tar.gz</code>

Patches are required for a successful build. Download the qt-copy patches through KDE's svn:
<code>svn co svn://anonsvn.kde.org/home/kde/trunk/qt-copy/patches/</code>
and apply the patches:
<code>cd qt-mac-opensource-4*
for patch in /path/to/patches/*.diff; do patch -p0 < $patch; done
</code>
Note: when applying patches you will get errors when processing x11 specific files (i.e. files that match the pattern *_x11.{h,cpp}), simply skip those patches.

And finally, compile qt-mac:
<code>./configure -prefix /opt/qt4 -qt-gif
make all install</code>

Please note: The Qt/Mac binary edition available from ftp.trolltech.com will '''not''' work,
because it does not contain the QtDBus module! (tested with 4.3.2)

== CMake ==
Get the latest CMake from http://www.cmake.org/cmake/resources/software.html#latest and install:

<code>curl http://www.cmake.org/files/v2.8/cmake-2.8.2.tar.gz -O
tar xfz cmake-*.tar.gz
cd cmake-*
./configure --prefix=/opt/kde4-deps
make all
sudo make install</code>

== Setting Up Your Build Environment ==
Variable must be set to build KDE successfully, and are noted below
*Note: Replace /opt/kde4-deps with the location of your 3rd-party tools, and add your cmake location if you compiled from source
<code>export PATH="/opt/qt4/bin:/opt/kde4/bin:/opt/kde4-deps/bin:$PATH"
export CMAKE_LIBRARY_PATH="/opt/kde4-deps/lib"
export CMAKE_INCLUDE_PATH="/opt/kde4-deps/include"
export PKG_CONFIG_PATH="/opt/qt4/lib/"</code>
== Building kdelibs ==
kdelibs must be checked out of svn locally to be built:
<code>cd ~/kde4.build
svn co svn://anonsvn.kde.org/home/kde/trunk/KDE/kdelibs</code>
And then compiled by performing the following:
<code>mkdir kdelibs.build
cd kdelibs.build
cmake ../kdelibs -DCMAKE_INSTALL_PREFIX=/opt/kde4
make all install</code>

== Troubleshooting ==
If kdelibs fails to compile successfully, check the build status for the latest Nightly Builds and Continuous Builds at http://public.kitware.com/dashboard.php?name=kde

Information about getting and compiling the dependencies can be found at [[Getting_Started/Build/KDE4]] and [[Getting_Started/Build/KDE4/Prerequisites]] (pages are Linux focused, but can be useful)

== Further Reading ==
For more general information on using CMake, see the [[Development/Tutorials/CMake|CMake Tutorial]].

[[Category:Mac OSX]]

Archive:Getting Started/Build/Mac OS X

2010-08-20T22:02:41Z

Fulldecent:

{{improve}}

*Note: You may wish to do all of this inside a directory name that ends in ''.noindex'' or ''.build'' to keep spotlight from indexing all of your temporary build-files as you build them.

<code>mkdir ~/kde4.build
cd ~/kde4.build</code>

== Required Third Party Tools ==
The following third party tools are required for successfully building KDE on OSX. Also, here are some [[Getting_Started/Build/KDE4/LFS| good tips for installing from source]].
* [http://developer.apple.com/technologies/xcode.html XCode]
* AGG
* giflib or libungif
* libart_lgpl
* libidn
* libjpeg
* libmng
* libpng
* libxml2
* libxslt
* libusb
* OpenEXR
* PCRE
* Strigi
* shared-mime-info
* pkgconfig
* subversion (to check out the kde sources)
* dbus

== Verify Compiler Version ==
* Fink: If your ''Distribution'' line in ''/sw/etc/fink.conf'' is 10.4-transitional, instead of 10.4, make sure you run ''sudo gcc_select 3.3'' before proceeding with any compiling, or you will end up with binary-incompatible c++ code!
* Manual: run ''sudo gcc_select 4.0'' if you want to be compatible with the pre-made installers.
== Qt/Mac Open Source Edition ==
Get the Qt/Mac source code from http://qt.nokia.com/downloads/qt-for-open-source-cpp-development-on-mac-os-x

<code>curl http://get.qt.nokia.com/qt/source/qt-everywhere-opensource-src-4.6.3.tar.gz -O
tar xfz qt-everywhere-opensource-src-*.tar.gz</code>

Patches are required for a successful build. Download the qt-copy patches through KDE's svn:
<code>svn co svn://anonsvn.kde.org/home/kde/trunk/qt-copy/patches/</code>
and apply the patches:
<code>cd qt-mac-opensource-4*
for patch in /path/to/patches/*.diff; do patch -p0 < $patch; done
</code>
Note: when applying patches you will get errors when processing x11 specific files (i.e. files that match the pattern *_x11.{h,cpp}), simply skip those patches.

And finally, compile qt-mac:
<code>./configure -prefix /opt/qt4 -qt-gif
make all install</code>

Please note: The Qt/Mac binary edition available from ftp.trolltech.com will '''not''' work,
because it does not contain the QtDBus module! (tested with 4.3.2)

== CMake ==
Get the latest CMake from http://www.cmake.org/cmake/resources/software.html#latest and install:

<code>curl http://www.cmake.org/files/v2.8/cmake-2.8.2.tar.gz -O
tar xfz cmake-*.tar.gz
cd cmake-*
./configure --prefix=/opt/kde4-deps
make all
sudo make install</code>

== Setting Up Your Build Environment ==
Variable must be set to build KDE successfully, and are noted below
*Note: Replace /opt/kde4-deps with the location of your 3rd-party tools, and add your cmake location if you compiled from source
<code>export PATH="/opt/qt4/bin:/opt/kde4/bin:/opt/kde4-deps/bin:$PATH"
export CMAKE_LIBRARY_PATH="/opt/kde4-deps/lib"
export CMAKE_INCLUDE_PATH="/opt/kde4-deps/include"
export PKG_CONFIG_PATH="/opt/qt4/lib/"</code>
== Building kdelibs ==
kdelibs must be checked out of svn locally to be built:
<code>cd ~/kde4.build
svn co svn://anonsvn.kde.org/home/kde/trunk/KDE/kdelibs</code>
And then compiled by performing the following:
<code>mkdir kdelibs.build
cd kdelibs.build
cmake ../kdelibs -DCMAKE_INSTALL_PREFIX=/opt/kde4
make all install</code>

== Troubleshooting ==
If kdelibs fails to compile successfully, check the build status for the latest Nightly Builds and Continuous Builds at http://public.kitware.com/dashboard.php?name=kde

Information about getting and compiling the dependencies can be found at [[Getting_Started/Build/KDE4]] and [[Getting_Started/Build/KDE4/Prerequisites]] (pages are Linux focused, but can be useful)

== Using Binaries ==
If you're interested in just checking things out, binaries for kdelibs and parts of KDE in general are available at [[Projects/KDE on Mac OS X]] and are generated semi-regularly.

== Further Reading ==
For more general information on using CMake, see the [[Development/Tutorials/CMake|CMake Tutorial]].

[[Category:Mac OSX]]

Archive:Getting Started/Build/Mac OS X

2010-08-20T21:33:48Z

Fulldecent:

{{KDE4}}
{{improve}}

*Note: You may wish to do all of this inside a directory name that ends in ''.noindex'' or ''.build'' to keep spotlight from indexing all of your temporary build-files as you build them.

<code>mkdir ~/kde4.build
cd ~/kde4.build</code>

== Required Third Party Tools ==
The following third party tools are required for successfully building KDE on OSX. Also, here are some [[Getting_Started/Build/KDE4/LFS| good tips for installing from source]].
* [http://developer.apple.com/technologies/xcode.html XCode]
* AGG
* giflib or libungif
* libart_lgpl
* libidn
* libjpeg
* libmng
* libpng
* libxml2
* libxslt
* libusb
* OpenEXR
* PCRE
* Strigi
* shared-mime-info
* pkgconfig
* subversion (to check out the kde sources)
* dbus

== Verify Compiler Version ==
* Fink: If your ''Distribution'' line in ''/sw/etc/fink.conf'' is 10.4-transitional, instead of 10.4, make sure you run ''sudo gcc_select 3.3'' before proceeding with any compiling, or you will end up with binary-incompatible c++ code!
* Manual: run ''sudo gcc_select 4.0'' if you want to be compatible with the pre-made installers.
== Qt/Mac Open Source Edition ==
Get the Qt/Mac source code from http://qt.nokia.com/downloads/qt-for-open-source-cpp-development-on-mac-os-x

<code>curl http://get.qt.nokia.com/qt/source/qt-everywhere-opensource-src-4.6.3.tar.gz -O
tar xfz qt-everywhere-opensource-src-*.tar.gz</code>

Patches are required for a successful build. Download the qt-copy patches through KDE's svn:
<code>svn co svn://anonsvn.kde.org/home/kde/trunk/qt-copy/patches/</code>
and apply the patches:
<code>cd qt-mac-opensource-4*
for patch in /path/to/patches/*.diff; do patch -p0 < $patch; done
</code>
Note: when applying patches you will get errors when processing x11 specific files (i.e. files that match the pattern *_x11.{h,cpp}), simply skip those patches.

And finally, compile qt-mac:
<code>./configure -prefix /opt/qt4 -qt-gif
make all install</code>

Please note: The Qt/Mac binary edition available from ftp.trolltech.com will '''not''' work,
because it does not contain the QtDBus module! (tested with 4.3.2)

== CMake ==
Get the latest CMake from http://www.cmake.org/cmake/resources/software.html#latest and install:

<code>curl http://www.cmake.org/files/v2.8/cmake-2.8.2.tar.gz -O
tar xfz cmake-*.tar.gz
cd cmake-*
./configure --prefix=/opt/kde4-deps
make all
sudo make install</code>

== Setting Up Your Build Environment ==
Variable must be set to build KDE successfully, and are noted below
*Note: Replace /opt/kde4-deps with the location of your 3rd-party tools, and add your cmake location if you compiled from source
<code>export PATH="/opt/qt4/bin:/opt/kde4/bin:/opt/kde4-deps/bin:$PATH"
export CMAKE_LIBRARY_PATH="/opt/kde4-deps/lib"
export CMAKE_INCLUDE_PATH="/opt/kde4-deps/include"
export PKG_CONFIG_PATH="/opt/qt4/lib/"</code>
== Building kdelibs ==
kdelibs must be checked out of svn locally to be built:
<code>cd ~/kde4.build
svn co svn://anonsvn.kde.org/home/kde/trunk/KDE/kdelibs</code>
And then compiled by performing the following:
<code>mkdir kdelibs.build
cd kdelibs.build
cmake ../kdelibs -DCMAKE_INSTALL_PREFIX=/opt/kde4
make all install</code>

== Troubleshooting ==
If kdelibs fails to compile successfully, check the build status for the latest Nightly Builds and Continuous Builds at http://public.kitware.com/dashboard.php?name=kde

Information about getting and compiling the dependencies can be found at [[Getting_Started/Build/KDE4]] and [[Getting_Started/Build/KDE4/Prerequisites]] (pages are Linux focused, but can be useful)

== Using Binaries ==
If you're interested in just checking things out, binaries for kdelibs and parts of KDE in general are available at [[Projects/KDE on Mac OS X]] and are generated semi-regularly.

== Further Reading ==
For more general information on using CMake, see the [[Development/Tutorials/CMake|CMake Tutorial]].

[[Category:Mac OSX]]

Archive:Getting Started/Build/Mac OS X

2010-08-20T21:33:13Z

Fulldecent: /* Building kdelibs */

{{KDE4}}
{{improve}}

*Note: You may wish to do all of this inside a directory name that ends in ''.noindex'' or ''.build'' to keep spotlight from indexing all of your temporary build-files as you build them.

<code>mkdir ~/kde.build
cd ~/kde.build</code>

== Required Third Party Tools ==
The following third party tools are required for successfully building KDE on OSX. Also, here are some [[Getting_Started/Build/KDE4/LFS| good tips for installing from source]].
* [http://developer.apple.com/technologies/xcode.html XCode]
* AGG
* giflib or libungif
* libart_lgpl
* libidn
* libjpeg
* libmng
* libpng
* libxml2
* libxslt
* libusb
* OpenEXR
* PCRE
* Strigi
* shared-mime-info
* pkgconfig
* subversion (to check out the kde sources)
* dbus

== Verify Compiler Version ==
* Fink: If your ''Distribution'' line in ''/sw/etc/fink.conf'' is 10.4-transitional, instead of 10.4, make sure you run ''sudo gcc_select 3.3'' before proceeding with any compiling, or you will end up with binary-incompatible c++ code!
* Manual: run ''sudo gcc_select 4.0'' if you want to be compatible with the pre-made installers.
== Qt/Mac Open Source Edition ==
Get the Qt/Mac source code from http://qt.nokia.com/downloads/qt-for-open-source-cpp-development-on-mac-os-x

<code>curl http://get.qt.nokia.com/qt/source/qt-everywhere-opensource-src-4.6.3.tar.gz -O
tar xfz qt-everywhere-opensource-src-*.tar.gz</code>

Patches are required for a successful build. Download the qt-copy patches through KDE's svn:
<code>svn co svn://anonsvn.kde.org/home/kde/trunk/qt-copy/patches/</code>
and apply the patches:
<code>cd qt-mac-opensource-4*
for patch in /path/to/patches/*.diff; do patch -p0 < $patch; done
</code>
Note: when applying patches you will get errors when processing x11 specific files (i.e. files that match the pattern *_x11.{h,cpp}), simply skip those patches.

And finally, compile qt-mac:
<code>./configure -prefix /opt/qt4 -qt-gif
make all install</code>

Please note: The Qt/Mac binary edition available from ftp.trolltech.com will '''not''' work,
because it does not contain the QtDBus module! (tested with 4.3.2)

== CMake ==
Get the latest CMake from http://www.cmake.org/cmake/resources/software.html#latest and install:

<code>curl http://www.cmake.org/files/v2.8/cmake-2.8.2.tar.gz -O
tar xfz cmake-*.tar.gz
cd cmake-*
./configure --prefix=/opt/kde4-deps
make all
sudo make install</code>

== Setting Up Your Build Environment ==
Variable must be set to build KDE successfully, and are noted below
*Note: Replace /opt/kde4-deps with the location of your 3rd-party tools, and add your cmake location if you compiled from source
<code>export PATH="/opt/qt4/bin:/opt/kde4/bin:/opt/kde4-deps/bin:$PATH"
export CMAKE_LIBRARY_PATH="/opt/kde4-deps/lib"
export CMAKE_INCLUDE_PATH="/opt/kde4-deps/include"
export PKG_CONFIG_PATH="/opt/qt4/lib/"</code>
== Building kdelibs ==
kdelibs must be checked out of svn locally to be built:
<code>cd ~/kde.build
svn co svn://anonsvn.kde.org/home/kde/trunk/KDE/kdelibs</code>
And then compiled by performing the following:
<code>mkdir kdelibs.build
cd kdelibs.build
cmake ../kdelibs -DCMAKE_INSTALL_PREFIX=/opt/kde4
make all install</code>

== Troubleshooting ==
If kdelibs fails to compile successfully, check the build status for the latest Nightly Builds and Continuous Builds at http://public.kitware.com/dashboard.php?name=kde

Information about getting and compiling the dependencies can be found at [[Getting_Started/Build/KDE4]] and [[Getting_Started/Build/KDE4/Prerequisites]] (pages are Linux focused, but can be useful)

== Using Binaries ==
If you're interested in just checking things out, binaries for kdelibs and parts of KDE in general are available at [[Projects/KDE on Mac OS X]] and are generated semi-regularly.

== Further Reading ==
For more general information on using CMake, see the [[Development/Tutorials/CMake|CMake Tutorial]].

[[Category:Mac OSX]]

Archive:Getting Started/Build/Mac OS X

2010-08-20T21:32:08Z

Fulldecent: /* CMake */

{{KDE4}}
{{improve}}

*Note: You may wish to do all of this inside a directory name that ends in ''.noindex'' or ''.build'' to keep spotlight from indexing all of your temporary build-files as you build them.

<code>mkdir ~/kde.build
cd ~/kde.build</code>

== Required Third Party Tools ==
The following third party tools are required for successfully building KDE on OSX. Also, here are some [[Getting_Started/Build/KDE4/LFS| good tips for installing from source]].
* [http://developer.apple.com/technologies/xcode.html XCode]
* AGG
* giflib or libungif
* libart_lgpl
* libidn
* libjpeg
* libmng
* libpng
* libxml2
* libxslt
* libusb
* OpenEXR
* PCRE
* Strigi
* shared-mime-info
* pkgconfig
* subversion (to check out the kde sources)
* dbus

== Verify Compiler Version ==
* Fink: If your ''Distribution'' line in ''/sw/etc/fink.conf'' is 10.4-transitional, instead of 10.4, make sure you run ''sudo gcc_select 3.3'' before proceeding with any compiling, or you will end up with binary-incompatible c++ code!
* Manual: run ''sudo gcc_select 4.0'' if you want to be compatible with the pre-made installers.
== Qt/Mac Open Source Edition ==
Get the Qt/Mac source code from http://qt.nokia.com/downloads/qt-for-open-source-cpp-development-on-mac-os-x

<code>curl http://get.qt.nokia.com/qt/source/qt-everywhere-opensource-src-4.6.3.tar.gz -O
tar xfz qt-everywhere-opensource-src-*.tar.gz</code>

Patches are required for a successful build. Download the qt-copy patches through KDE's svn:
<code>svn co svn://anonsvn.kde.org/home/kde/trunk/qt-copy/patches/</code>
and apply the patches:
<code>cd qt-mac-opensource-4*
for patch in /path/to/patches/*.diff; do patch -p0 < $patch; done
</code>
Note: when applying patches you will get errors when processing x11 specific files (i.e. files that match the pattern *_x11.{h,cpp}), simply skip those patches.

And finally, compile qt-mac:
<code>./configure -prefix /opt/qt4 -qt-gif
make all install</code>

Please note: The Qt/Mac binary edition available from ftp.trolltech.com will '''not''' work,
because it does not contain the QtDBus module! (tested with 4.3.2)

== CMake ==
Get the latest CMake from http://www.cmake.org/cmake/resources/software.html#latest and install:

<code>curl http://www.cmake.org/files/v2.8/cmake-2.8.2.tar.gz -O
tar xfz cmake-*.tar.gz
cd cmake-*
./configure --prefix=/opt/kde4-deps
make all
sudo make install</code>

== Setting Up Your Build Environment ==
Variable must be set to build KDE successfully, and are noted below
*Note: Replace /opt/kde4-deps with the location of your 3rd-party tools, and add your cmake location if you compiled from source
<code>export PATH="/opt/qt4/bin:/opt/kde4/bin:/opt/kde4-deps/bin:$PATH"
export CMAKE_LIBRARY_PATH="/opt/kde4-deps/lib"
export CMAKE_INCLUDE_PATH="/opt/kde4-deps/include"
export PKG_CONFIG_PATH="/opt/qt4/lib/"</code>
== Building kdelibs ==
kdelibs must be checked out of svn locally to be built:
<code>svn co svn://anonsvn.kde.org/home/kde/trunk/KDE/kdelibs</code>
And then compiled by performing the following:
<code>mkdir kdelibs.build
cd kdelibs.build
cmake ../kdelibs -DCMAKE_INSTALL_PREFIX=/opt/kde4
make all install</code>

== Troubleshooting ==
If kdelibs fails to compile successfully, check the build status for the latest Nightly Builds and Continuous Builds at http://public.kitware.com/dashboard.php?name=kde

Information about getting and compiling the dependencies can be found at [[Getting_Started/Build/KDE4]] and [[Getting_Started/Build/KDE4/Prerequisites]] (pages are Linux focused, but can be useful)

== Using Binaries ==
If you're interested in just checking things out, binaries for kdelibs and parts of KDE in general are available at [[Projects/KDE on Mac OS X]] and are generated semi-regularly.

== Further Reading ==
For more general information on using CMake, see the [[Development/Tutorials/CMake|CMake Tutorial]].

[[Category:Mac OSX]]

Archive:Getting Started/Build/Mac OS X

2010-08-20T20:05:15Z

Fulldecent: /* Required Third Party Tools */

{{KDE4}}
{{improve}}

*Note: You may wish to do all of this inside a directory name that ends in ''.noindex'' or ''.build'' to keep spotlight from indexing all of your temporary build-files as you build them.

<code>mkdir ~/kde.build
cd ~/kde.build</code>

== Required Third Party Tools ==
The following third party tools are required for successfully building KDE on OSX. Also, here are some [[Getting_Started/Build/KDE4/LFS| good tips for installing from source]].
* [http://developer.apple.com/technologies/xcode.html XCode]
* AGG
* giflib or libungif
* libart_lgpl
* libidn
* libjpeg
* libmng
* libpng
* libxml2
* libxslt
* libusb
* OpenEXR
* PCRE
* Strigi
* shared-mime-info
* pkgconfig
* subversion (to check out the kde sources)
* dbus

== Verify Compiler Version ==
* Fink: If your ''Distribution'' line in ''/sw/etc/fink.conf'' is 10.4-transitional, instead of 10.4, make sure you run ''sudo gcc_select 3.3'' before proceeding with any compiling, or you will end up with binary-incompatible c++ code!
* Manual: run ''sudo gcc_select 4.0'' if you want to be compatible with the pre-made installers.
== Qt/Mac Open Source Edition ==
Get the Qt/Mac source code from http://qt.nokia.com/downloads/qt-for-open-source-cpp-development-on-mac-os-x

<code>curl http://get.qt.nokia.com/qt/source/qt-everywhere-opensource-src-4.6.3.tar.gz -O
tar xfz qt-everywhere-opensource-src-*.tar.gz</code>

Patches are required for a successful build. Download the qt-copy patches through KDE's svn:
<code>svn co svn://anonsvn.kde.org/home/kde/trunk/qt-copy/patches/</code>
and apply the patches:
<code>cd qt-mac-opensource-4*
for patch in /path/to/patches/*.diff; do patch -p0 < $patch; done
</code>
Note: when applying patches you will get errors when processing x11 specific files (i.e. files that match the pattern *_x11.{h,cpp}), simply skip those patches.

And finally, compile qt-mac:
<code>./configure -prefix /opt/qt4 -qt-gif
make all install</code>

Please note: The Qt/Mac binary edition available from ftp.trolltech.com will '''not''' work,
because it does not contain the QtDBus module! (tested with 4.3.2)

== CMake ==
CMake may be downloaded from CVS:
<code>cvs -d :pserver:anonymous@www.cmake.org:/cvsroot/CMake login</code>
Note: password is "cmake"
<code>cvs -d :pserver:anonymous@www.cmake.org:/cvsroot/CMake co CMake</code>
And then compiled and installed:
<code>cd CMake
./configure --prefix=/opt/kde4-deps
make all install</code>

== Setting Up Your Build Environment ==
Variable must be set to build KDE successfully, and are noted below
*Note: Replace /opt/kde4-deps with the location of your 3rd-party tools, and add your cmake location if you compiled from source
<code>export PATH="/opt/qt4/bin:/opt/kde4/bin:/opt/kde4-deps/bin:$PATH"
export CMAKE_LIBRARY_PATH="/opt/kde4-deps/lib"
export CMAKE_INCLUDE_PATH="/opt/kde4-deps/include"
export PKG_CONFIG_PATH="/opt/qt4/lib/"</code>
== Building kdelibs ==
kdelibs must be checked out of svn locally to be built:
<code>svn co svn://anonsvn.kde.org/home/kde/trunk/KDE/kdelibs</code>
And then compiled by performing the following:
<code>mkdir kdelibs.build
cd kdelibs.build
cmake ../kdelibs -DCMAKE_INSTALL_PREFIX=/opt/kde4
make all install</code>

== Troubleshooting ==
If kdelibs fails to compile successfully, check the build status for the latest Nightly Builds and Continuous Builds at http://public.kitware.com/dashboard.php?name=kde

Information about getting and compiling the dependencies can be found at [[Getting_Started/Build/KDE4]] and [[Getting_Started/Build/KDE4/Prerequisites]] (pages are Linux focused, but can be useful)

== Using Binaries ==
If you're interested in just checking things out, binaries for kdelibs and parts of KDE in general are available at [[Projects/KDE on Mac OS X]] and are generated semi-regularly.

== Further Reading ==
For more general information on using CMake, see the [[Development/Tutorials/CMake|CMake Tutorial]].

[[Category:Mac OSX]]

Archive:Getting Started/Build/Mac OS X

2010-08-20T19:16:21Z

Fulldecent: /* Qt/Mac Open Source Edition */

{{KDE4}}
{{improve}}

*Note: You may wish to do all of this inside a directory name that ends in ''.noindex'' or ''.build'' to keep spotlight from indexing all of your temporary build-files as you build them.

<code>mkdir ~/kde.build
cd ~/kde.build</code>

== Required Third Party Tools ==
The following third party tools are required for successfully building KDE on OSX. Also, here are some [[Getting_Started/Build/KDE4/LFS| good tips for installing from source]].
* [http://developer.apple.com/technologies/xcode.html XCode]
* AGG
* bzip2
* giflib or libungif
* libart_lgpl
* libidn
* libjpeg
* libmng
* libpng
* libxml2
* libxslt
* libusb
* OpenEXR
* PCRE
* Strigi
* shared-mime-info
* pkgconfig
* subversion (to check out the kde sources)
* dbus

== Verify Compiler Version ==
* Fink: If your ''Distribution'' line in ''/sw/etc/fink.conf'' is 10.4-transitional, instead of 10.4, make sure you run ''sudo gcc_select 3.3'' before proceeding with any compiling, or you will end up with binary-incompatible c++ code!
* Manual: run ''sudo gcc_select 4.0'' if you want to be compatible with the pre-made installers.
== Qt/Mac Open Source Edition ==
Get the Qt/Mac source code from http://qt.nokia.com/downloads/qt-for-open-source-cpp-development-on-mac-os-x

<code>curl http://get.qt.nokia.com/qt/source/qt-everywhere-opensource-src-4.6.3.tar.gz -O
tar xfz qt-everywhere-opensource-src-*.tar.gz</code>

Patches are required for a successful build. Download the qt-copy patches through KDE's svn:
<code>svn co svn://anonsvn.kde.org/home/kde/trunk/qt-copy/patches/</code>
and apply the patches:
<code>cd qt-mac-opensource-4*
for patch in /path/to/patches/*.diff; do patch -p0 < $patch; done
</code>
Note: when applying patches you will get errors when processing x11 specific files (i.e. files that match the pattern *_x11.{h,cpp}), simply skip those patches.

And finally, compile qt-mac:
<code>./configure -prefix /opt/qt4 -qt-gif
make all install</code>

Please note: The Qt/Mac binary edition available from ftp.trolltech.com will '''not''' work,
because it does not contain the QtDBus module! (tested with 4.3.2)

== CMake ==
CMake may be downloaded from CVS:
<code>cvs -d :pserver:anonymous@www.cmake.org:/cvsroot/CMake login</code>
Note: password is "cmake"
<code>cvs -d :pserver:anonymous@www.cmake.org:/cvsroot/CMake co CMake</code>
And then compiled and installed:
<code>cd CMake
./configure --prefix=/opt/kde4-deps
make all install</code>

== Setting Up Your Build Environment ==
Variable must be set to build KDE successfully, and are noted below
*Note: Replace /opt/kde4-deps with the location of your 3rd-party tools, and add your cmake location if you compiled from source
<code>export PATH="/opt/qt4/bin:/opt/kde4/bin:/opt/kde4-deps/bin:$PATH"
export CMAKE_LIBRARY_PATH="/opt/kde4-deps/lib"
export CMAKE_INCLUDE_PATH="/opt/kde4-deps/include"
export PKG_CONFIG_PATH="/opt/qt4/lib/"</code>
== Building kdelibs ==
kdelibs must be checked out of svn locally to be built:
<code>svn co svn://anonsvn.kde.org/home/kde/trunk/KDE/kdelibs</code>
And then compiled by performing the following:
<code>mkdir kdelibs.build
cd kdelibs.build
cmake ../kdelibs -DCMAKE_INSTALL_PREFIX=/opt/kde4
make all install</code>

== Troubleshooting ==
If kdelibs fails to compile successfully, check the build status for the latest Nightly Builds and Continuous Builds at http://public.kitware.com/dashboard.php?name=kde

Information about getting and compiling the dependencies can be found at [[Getting_Started/Build/KDE4]] and [[Getting_Started/Build/KDE4/Prerequisites]] (pages are Linux focused, but can be useful)

== Using Binaries ==
If you're interested in just checking things out, binaries for kdelibs and parts of KDE in general are available at [[Projects/KDE on Mac OS X]] and are generated semi-regularly.

== Further Reading ==
For more general information on using CMake, see the [[Development/Tutorials/CMake|CMake Tutorial]].

[[Category:Mac OSX]]

Archive:Getting Started/Build/Mac OS X

2010-08-20T19:09:08Z

Fulldecent:

{{KDE4}}
{{improve}}

*Note: You may wish to do all of this inside a directory name that ends in ''.noindex'' or ''.build'' to keep spotlight from indexing all of your temporary build-files as you build them.

<code>mkdir ~/kde.build
cd ~/kde.build</code>

== Required Third Party Tools ==
The following third party tools are required for successfully building KDE on OSX. Also, here are some [[Getting_Started/Build/KDE4/LFS| good tips for installing from source]].
* [http://developer.apple.com/technologies/xcode.html XCode]
* AGG
* bzip2
* giflib or libungif
* libart_lgpl
* libidn
* libjpeg
* libmng
* libpng
* libxml2
* libxslt
* libusb
* OpenEXR
* PCRE
* Strigi
* shared-mime-info
* pkgconfig
* subversion (to check out the kde sources)
* dbus

== Verify Compiler Version ==
* Fink: If your ''Distribution'' line in ''/sw/etc/fink.conf'' is 10.4-transitional, instead of 10.4, make sure you run ''sudo gcc_select 3.3'' before proceeding with any compiling, or you will end up with binary-incompatible c++ code!
* Manual: run ''sudo gcc_select 4.0'' if you want to be compatible with the pre-made installers.
== Qt/Mac Open Source Edition ==
Click "Source code available on this link:" at http://qt.nokia.com/downloads/qt-for-open-source-cpp-development-on-mac-os-x

Patches are required for a successful build. Download the qt-copy patches through KDE's svn:
<code>svn co svn://anonsvn.kde.org/home/kde/trunk/qt-copy/patches/</code>
and apply the patches:
<code>cd qt-mac-opensource-4*
for patch in /path/to/patches/*.diff; do patch -p0 < $patch; done
</code>
Note: when applying patches you will get errors when processing x11 specific files (i.e. files that match the pattern *_x11.{h,cpp}), simply skip those patches.

And finally, compile qt-mac:
<code>./configure -prefix /opt/qt4 -qt-gif
make all install</code>

Please note: The Qt/Mac binary edition available from ftp.trolltech.com will '''not''' work,
because it does not contain the QtDBus module! (tested with 4.3.2)

== CMake ==
CMake may be downloaded from CVS:
<code>cvs -d :pserver:anonymous@www.cmake.org:/cvsroot/CMake login</code>
Note: password is "cmake"
<code>cvs -d :pserver:anonymous@www.cmake.org:/cvsroot/CMake co CMake</code>
And then compiled and installed:
<code>cd CMake
./configure --prefix=/opt/kde4-deps
make all install</code>

== Setting Up Your Build Environment ==
Variable must be set to build KDE successfully, and are noted below
*Note: Replace /opt/kde4-deps with the location of your 3rd-party tools, and add your cmake location if you compiled from source
<code>export PATH="/opt/qt4/bin:/opt/kde4/bin:/opt/kde4-deps/bin:$PATH"
export CMAKE_LIBRARY_PATH="/opt/kde4-deps/lib"
export CMAKE_INCLUDE_PATH="/opt/kde4-deps/include"
export PKG_CONFIG_PATH="/opt/qt4/lib/"</code>
== Building kdelibs ==
kdelibs must be checked out of svn locally to be built:
<code>svn co svn://anonsvn.kde.org/home/kde/trunk/KDE/kdelibs</code>
And then compiled by performing the following:
<code>mkdir kdelibs.build
cd kdelibs.build
cmake ../kdelibs -DCMAKE_INSTALL_PREFIX=/opt/kde4
make all install</code>

== Troubleshooting ==
If kdelibs fails to compile successfully, check the build status for the latest Nightly Builds and Continuous Builds at http://public.kitware.com/dashboard.php?name=kde

Information about getting and compiling the dependencies can be found at [[Getting_Started/Build/KDE4]] and [[Getting_Started/Build/KDE4/Prerequisites]] (pages are Linux focused, but can be useful)

== Using Binaries ==
If you're interested in just checking things out, binaries for kdelibs and parts of KDE in general are available at [[Projects/KDE on Mac OS X]] and are generated semi-regularly.

== Further Reading ==
For more general information on using CMake, see the [[Development/Tutorials/CMake|CMake Tutorial]].

[[Category:Mac OSX]]

Archive:Getting Started/Build/Mac OS X

2010-08-20T19:05:41Z

Fulldecent: /* Qt/Mac Open Source Edition */

{{KDE4}}
{{improve}}

*Note: You may wish to do all of this inside a directory name that ends in ''.noindex'' or ''.build'' to keep spotlight from indexing all of your temporary build-files as you build them.

== Required Third Party Tools ==
The following third party tools are required for successfully building KDE on OSX. Also, here are some [[Getting_Started/Build/KDE4/LFS| good tips for installing from source]].
* [http://developer.apple.com/technologies/xcode.html XCode]
* AGG
* bzip2
* giflib or libungif
* libart_lgpl
* libidn
* libjpeg
* libmng
* libpng
* libxml2
* libxslt
* libusb
* OpenEXR
* PCRE
* Strigi
* shared-mime-info
* pkgconfig
* subversion (to check out the kde sources)
* dbus

== Verify Compiler Version ==
* Fink: If your ''Distribution'' line in ''/sw/etc/fink.conf'' is 10.4-transitional, instead of 10.4, make sure you run ''sudo gcc_select 3.3'' before proceeding with any compiling, or you will end up with binary-incompatible c++ code!
* Manual: run ''sudo gcc_select 4.0'' if you want to be compatible with the pre-made installers.
== Qt/Mac Open Source Edition ==
Click "Source code available on this link:" at http://qt.nokia.com/downloads/qt-for-open-source-cpp-development-on-mac-os-x

Patches are required for a successful build. Download the qt-copy patches through KDE's svn:
<code>svn co svn://anonsvn.kde.org/home/kde/trunk/qt-copy/patches/</code>
and apply the patches:
<code>cd qt-mac-opensource-4*
for patch in /path/to/patches/*.diff; do patch -p0 < $patch; done
</code>
Note: when applying patches you will get errors when processing x11 specific files (i.e. files that match the pattern *_x11.{h,cpp}), simply skip those patches.

And finally, compile qt-mac:
<code>./configure -prefix /opt/qt4 -qt-gif
make all install</code>

Please note: The Qt/Mac binary edition available from ftp.trolltech.com will '''not''' work,
because it does not contain the QtDBus module! (tested with 4.3.2)

== CMake ==
CMake may be downloaded from CVS:
<code>cvs -d :pserver:anonymous@www.cmake.org:/cvsroot/CMake login</code>
Note: password is "cmake"
<code>cvs -d :pserver:anonymous@www.cmake.org:/cvsroot/CMake co CMake</code>
And then compiled and installed:
<code>cd CMake
./configure --prefix=/opt/kde4-deps
make all install</code>

== Setting Up Your Build Environment ==
Variable must be set to build KDE successfully, and are noted below
*Note: Replace /opt/kde4-deps with the location of your 3rd-party tools, and add your cmake location if you compiled from source
<code>export PATH="/opt/qt4/bin:/opt/kde4/bin:/opt/kde4-deps/bin:$PATH"
export CMAKE_LIBRARY_PATH="/opt/kde4-deps/lib"
export CMAKE_INCLUDE_PATH="/opt/kde4-deps/include"
export PKG_CONFIG_PATH="/opt/qt4/lib/"</code>
== Building kdelibs ==
kdelibs must be checked out of svn locally to be built:
<code>svn co svn://anonsvn.kde.org/home/kde/trunk/KDE/kdelibs</code>
And then compiled by performing the following:
<code>mkdir kdelibs.build
cd kdelibs.build
cmake ../kdelibs -DCMAKE_INSTALL_PREFIX=/opt/kde4
make all install</code>

== Troubleshooting ==
If kdelibs fails to compile successfully, check the build status for the latest Nightly Builds and Continuous Builds at http://public.kitware.com/dashboard.php?name=kde

Information about getting and compiling the dependencies can be found at [[Getting_Started/Build/KDE4]] and [[Getting_Started/Build/KDE4/Prerequisites]] (pages are Linux focused, but can be useful)

== Using Binaries ==
If you're interested in just checking things out, binaries for kdelibs and parts of KDE in general are available at [[Projects/KDE on Mac OS X]] and are generated semi-regularly.

== Further Reading ==
For more general information on using CMake, see the [[Development/Tutorials/CMake|CMake Tutorial]].

[[Category:Mac OSX]]

Archive:Getting Started/Build/Mac OS X

2010-08-20T19:00:17Z

Fulldecent: /* Required Third Party Tools */

{{KDE4}}
{{improve}}

*Note: You may wish to do all of this inside a directory name that ends in ''.noindex'' or ''.build'' to keep spotlight from indexing all of your temporary build-files as you build them.

== Required Third Party Tools ==
The following third party tools are required for successfully building KDE on OSX. Also, here are some [[Getting_Started/Build/KDE4/LFS| good tips for installing from source]].
* [http://developer.apple.com/technologies/xcode.html XCode]
* AGG
* bzip2
* giflib or libungif
* libart_lgpl
* libidn
* libjpeg
* libmng
* libpng
* libxml2
* libxslt
* libusb
* OpenEXR
* PCRE
* Strigi
* shared-mime-info
* pkgconfig
* subversion (to check out the kde sources)
* dbus

== Verify Compiler Version ==
* Fink: If your ''Distribution'' line in ''/sw/etc/fink.conf'' is 10.4-transitional, instead of 10.4, make sure you run ''sudo gcc_select 3.3'' before proceeding with any compiling, or you will end up with binary-incompatible c++ code!
* Manual: run ''sudo gcc_select 4.0'' if you want to be compatible with the pre-made installers.
== Qt/Mac Open Source Edition ==
Download qt-mac-opensource from http://qt.nokia.com/downloads/qt-for-open-source-cpp-development-on-mac-os-x

Patches are required for a successful build. Download the qt-copy patches through KDE's svn:
<code>svn co svn://anonsvn.kde.org/home/kde/trunk/qt-copy/patches/</code>
and apply the patches:
<code>cd qt-mac-opensource-4*
for patch in /path/to/patches/*.diff; do patch -p0 < $patch; done
</code>
Note: when applying patches you will get errors when processing x11 specific files (i.e. files that match the pattern *_x11.{h,cpp}), simply skip those patches.

And finally, compile qt-mac:
<code>./configure -prefix /opt/qt4 -qt-gif
make all install</code>

Please note: The Qt/Mac binary edition available from ftp.trolltech.com will '''not''' work,
because it does not contain the QtDBus module! (tested with 4.3.2)

== CMake ==
CMake may be downloaded from CVS:
<code>cvs -d :pserver:anonymous@www.cmake.org:/cvsroot/CMake login</code>
Note: password is "cmake"
<code>cvs -d :pserver:anonymous@www.cmake.org:/cvsroot/CMake co CMake</code>
And then compiled and installed:
<code>cd CMake
./configure --prefix=/opt/kde4-deps
make all install</code>

== Setting Up Your Build Environment ==
Variable must be set to build KDE successfully, and are noted below
*Note: Replace /opt/kde4-deps with the location of your 3rd-party tools, and add your cmake location if you compiled from source
<code>export PATH="/opt/qt4/bin:/opt/kde4/bin:/opt/kde4-deps/bin:$PATH"
export CMAKE_LIBRARY_PATH="/opt/kde4-deps/lib"
export CMAKE_INCLUDE_PATH="/opt/kde4-deps/include"
export PKG_CONFIG_PATH="/opt/qt4/lib/"</code>
== Building kdelibs ==
kdelibs must be checked out of svn locally to be built:
<code>svn co svn://anonsvn.kde.org/home/kde/trunk/KDE/kdelibs</code>
And then compiled by performing the following:
<code>mkdir kdelibs.build
cd kdelibs.build
cmake ../kdelibs -DCMAKE_INSTALL_PREFIX=/opt/kde4
make all install</code>

== Troubleshooting ==
If kdelibs fails to compile successfully, check the build status for the latest Nightly Builds and Continuous Builds at http://public.kitware.com/dashboard.php?name=kde

Information about getting and compiling the dependencies can be found at [[Getting_Started/Build/KDE4]] and [[Getting_Started/Build/KDE4/Prerequisites]] (pages are Linux focused, but can be useful)

== Using Binaries ==
If you're interested in just checking things out, binaries for kdelibs and parts of KDE in general are available at [[Projects/KDE on Mac OS X]] and are generated semi-regularly.

== Further Reading ==
For more general information on using CMake, see the [[Development/Tutorials/CMake|CMake Tutorial]].

[[Category:Mac OSX]]

Archive:Getting Started/Build/Mac OS X

2010-08-20T19:00:02Z

Fulldecent: /* Required Third Party Tools */

{{KDE4}}
{{improve}}

*Note: You may wish to do all of this inside a directory name that ends in ''.noindex'' or ''.build'' to keep spotlight from indexing all of your temporary build-files as you build them.

== Required Third Party Tools ==
The following third party tools are required for successfully building KDE on OSX. Also, here are some [[Getting_Started/Build/KDE4/LFS| good tips for installing from source]].
* [[http://developer.apple.com/technologies/xcode.html XCode]]
* AGG
* bzip2
* giflib or libungif
* libart_lgpl
* libidn
* libjpeg
* libmng
* libpng
* libxml2
* libxslt
* libusb
* OpenEXR
* PCRE
* Strigi
* shared-mime-info
* pkgconfig
* subversion (to check out the kde sources)
* dbus

== Verify Compiler Version ==
* Fink: If your ''Distribution'' line in ''/sw/etc/fink.conf'' is 10.4-transitional, instead of 10.4, make sure you run ''sudo gcc_select 3.3'' before proceeding with any compiling, or you will end up with binary-incompatible c++ code!
* Manual: run ''sudo gcc_select 4.0'' if you want to be compatible with the pre-made installers.
== Qt/Mac Open Source Edition ==
Download qt-mac-opensource from http://qt.nokia.com/downloads/qt-for-open-source-cpp-development-on-mac-os-x

Patches are required for a successful build. Download the qt-copy patches through KDE's svn:
<code>svn co svn://anonsvn.kde.org/home/kde/trunk/qt-copy/patches/</code>
and apply the patches:
<code>cd qt-mac-opensource-4*
for patch in /path/to/patches/*.diff; do patch -p0 < $patch; done
</code>
Note: when applying patches you will get errors when processing x11 specific files (i.e. files that match the pattern *_x11.{h,cpp}), simply skip those patches.

And finally, compile qt-mac:
<code>./configure -prefix /opt/qt4 -qt-gif
make all install</code>

Please note: The Qt/Mac binary edition available from ftp.trolltech.com will '''not''' work,
because it does not contain the QtDBus module! (tested with 4.3.2)

== CMake ==
CMake may be downloaded from CVS:
<code>cvs -d :pserver:anonymous@www.cmake.org:/cvsroot/CMake login</code>
Note: password is "cmake"
<code>cvs -d :pserver:anonymous@www.cmake.org:/cvsroot/CMake co CMake</code>
And then compiled and installed:
<code>cd CMake
./configure --prefix=/opt/kde4-deps
make all install</code>

== Setting Up Your Build Environment ==
Variable must be set to build KDE successfully, and are noted below
*Note: Replace /opt/kde4-deps with the location of your 3rd-party tools, and add your cmake location if you compiled from source
<code>export PATH="/opt/qt4/bin:/opt/kde4/bin:/opt/kde4-deps/bin:$PATH"
export CMAKE_LIBRARY_PATH="/opt/kde4-deps/lib"
export CMAKE_INCLUDE_PATH="/opt/kde4-deps/include"
export PKG_CONFIG_PATH="/opt/qt4/lib/"</code>
== Building kdelibs ==
kdelibs must be checked out of svn locally to be built:
<code>svn co svn://anonsvn.kde.org/home/kde/trunk/KDE/kdelibs</code>
And then compiled by performing the following:
<code>mkdir kdelibs.build
cd kdelibs.build
cmake ../kdelibs -DCMAKE_INSTALL_PREFIX=/opt/kde4
make all install</code>

== Troubleshooting ==
If kdelibs fails to compile successfully, check the build status for the latest Nightly Builds and Continuous Builds at http://public.kitware.com/dashboard.php?name=kde

Information about getting and compiling the dependencies can be found at [[Getting_Started/Build/KDE4]] and [[Getting_Started/Build/KDE4/Prerequisites]] (pages are Linux focused, but can be useful)

== Using Binaries ==
If you're interested in just checking things out, binaries for kdelibs and parts of KDE in general are available at [[Projects/KDE on Mac OS X]] and are generated semi-regularly.

== Further Reading ==
For more general information on using CMake, see the [[Development/Tutorials/CMake|CMake Tutorial]].

[[Category:Mac OSX]]

Getting Started/Build/KDE4

2010-08-20T18:30:25Z

Fulldecent: /* Commandline useradd */

{{Template:I18n/Language Navigation Bar|Getting_Started/Build/KDE4}}

{{TutorialBrowser|

series=Getting Started|

name=Building KDE4 (Development version, TRUNK) From Source|

pre=[[../../Sources/Anonymous_SVN|Anonymous SVN Quickstart Guide]]|

next=[[../../Set_up_KDE_4_for_development|Set up KDE 4 for development]]|

reading=[[../kdesrc-build|kdesrc-build: The KDE From Source Build Tool]]<br>[[Contribute/Send Patches|Sending Patches]]<br>[[../../Increased_Productivity_in_KDE4_with_Scripts|Increased Productivity in KDE4 with Scripts]]<br>[[Development/Tutorials/CMake |Introduction to CMake]]<br>[[../KDE4/FreeBSD|FreeBSD notes]]<br>[[../KDE4/Mac OS X|Instructions for Mac OS X]]<br>[[../KDE4/Windows|Instructions for MS Windows]]|
}}
{| class="collapsible collapsed" style="border: 1px #aaa solid; background: #efefef;"
! style="font-size: 1.25em; "| Table of contents
|-
| __TOC__
|}
{{warning|The commands below are used to build the latest UNSTABLE version of KDE from TRUNK.

This should not be used in a production environment -- not recommended for daily use.

To build a stable KDE-4 version, go to:

::[[Getting_Started/Build/KDE4.x|upgrading to KDE-4.x from KDE-3.x]]

Or

::[[Getting_Started/Build/KDE4.4 Upgrade|Upgrade KDE-4.4.x release version or KDE-4.4 SVN BRANCH)]]

which is currently under construction.
}}

== Abstract ==

This tutorial shows a labor intensive way to get KDE from trunk running on Linux/BSD systems.

{{Note|
kdesrc-build http://kdesrc-build.kde.org/ is an easy alternative. (Previously called kdesvn-build)
}}

There are also tutorials for [[Getting_Started/Build/KDE4/FreeBSD|FreeBSD]], [[/Windows|Windows]], [[/Mac OS X|Mac OS X]] and [http://solaris.kde.org/ Solaris]. This tutorial creates a special user, kde-devel, that will run KDE trunk. On the one hand, this allows other users to continue with another KDE version. On the other hand, testing special system-wide code like the KDE display manager is not possible. There is a tutorial to
[[Getting_Started/Build/KDE4/onVmWare|set up KDE 4 trunk on a virtual machine]].

Throughout the tutorial the bash shell is used.

{{warning|Expect a higher risk of build failure '''on Mondays''' when most kdelibs changes are committed. [http://developer.kde.org/~dirk/dashboard/ Dashboard] reports unexpected breakages. You are encouraged to fix failing modules.}}

== Create a user account for KDE4 development ==

It is important to keep the development version from interfering with the rest of your computer, The method covered here is creating a dedicated kde-devel user.

We will need to:
#Add the user
#Set the shell to bash
#and may have to use sudoedit if we want to be able to sudo
#Create a .bashrc file with environment variables for the build system

A graphical tool is avalable from most distributions, if you have KDE you can get to this tool via: K->Computer->System Settings->User Management

{{Note|
Less Safe Alternative:
One can do everything under your normal user account

See [[Getting_Started/Increased_Productivity_in_KDE4_with_Scripts|Increased Productivity in KDE4 with Scripts]]
for more details.

The environment variables determinate what version you use. Proceed same as here except put the environment variables in a file. In your <tt>.bashrc</tt> file add the line <tt>source .kde_devel_env</tt>. renaming the .kde_devel_env file would make them not be loaded, so you wouldn't use the devel version.
}}

===Commandline useradd===
Some systems are configured to use {{path|/bin/sh}}. Many users prefer Bash{{path|/bin/bash}}

{{Note|
On Ark Linux and Fedora, you can skip the <tt>-s /bin/bash</tt> switch - {{path|/bin/sh}} is {{path|bash}}.
}}
<code bash>
sudo useradd -m kde-devel -s /bin/bash
sudo passwd kde-devel
</code>

==== commandline permissions and groups ====
Edit your /etc/groups file to add the kde-devel user to all the groups that you need (probably the groups that your usual username is already assigned to).

You may need to add user to sudoers file. (beyond scope of this tutorial)

=== Setting up the environment ===

Copy the {{path|~/.bashrc}} from your normal user account to the new kde-devel account.

Next, copy and paste the contents of the [[Getting Started/Increased Productivity in KDE4 with Scripts/.bashrc|example .bashrc]] into {{path|~kde-devel/.bashrc}}. Be sure to comment out the line <tt>alias make=makeobj</tt> if you do not have the <tt>[[Getting Started/Build/KDE4/Prerequisites#Abstract|makeobj]]</tt> command available. (What is this, how do we know???)

Alternatively, you can download the kde-sdk a.k.a kdesdk package (or perform a subversion checkout) and include the kde-sdk/scripts/ directory in your path. (What is this???)

You will probably also want to modify the path to make sure it doesn't include your kde3 paths.

Also if you want to use KDevelop to develop KDE 4 applications you may pass the ''-GKDevelop3'' flag to the ''cmake'' command (to make CMake generate KDevelop project files, it will help to avoid rebuilding in the future, see [[Getting_Started/Set_up_KDE_4_for_development#Setting_up_the_environment|this]]).
To make it run, you have to open a new bash or to execute
<code bash>
source ~/.bashrc
</code>

This will provide access to commands such as <tt>cmakekde</tt> that are used in this tutorial as well as ensure that the proper paths are in place for Qt, KDE and CMake binaries.

For more information, please read the [[Getting Started/Increased Productivity in KDE4 with Scripts]] tutorial.

=== Using the kde-devel User ===
To get a text-only command prompt, say from konsole
su - kde-devel
'(need hyphen otherwise your environment will be the same as your regular user)

To Log in Text-only from a virtual terminal:
CTRL-F1 ( CTRL-F7 is normally graphical )

To use a shell that can pop up applications when your normal user is logged in:
<code bash>
ssh -X kde-devel@localhost
</code>

{{Note|
If the ssh command fails, check out the [[Getting_Started/Set_up_KDE_4_for_development#Launching_KDE_4_apps|Launching KDE 4 apps]] section of the [[Getting_Started/Set_up_KDE_4_for_development|KDE4 development guide]].
}}

== Required packages from your distribution ==
The requirements to build kde4 from source vary from distribution to distribution. Instructions for your distribution are provided below:
See [[build requirements]] for more complete list.

[[Getting_Started/Build/KDE4/Ark Linux|Ark Linux]],
[[Getting_Started/Build/KDE4/Arch Linux|Arch Linux]], [[Getting_Started/Build/KDE4/Fedora|Fedora]],
[[Getting_Started/Build/KDE4/Kubuntu and Debian|Kubuntu and Debian]]( or check out [[Getting_Started/Using_Project_Neon_to_contribute_to_KDE|Project Neon]])
, [[Getting_Started/Build/KDE4/openSUSE|openSUSE]]( [http://en.opensuse.org/openSUSE:KDE_developers_guide specific guide for openSUSE]. However be careful because it updates a huge number of your stable packages.),
[[Getting_Started/Build/KDE4/Gentoo|Gentoo]],
[[Getting_Started/Build/KDE4/LFS|Linux from Scratch]] or to build from source.
[[Getting_Started/Build/KDE4/Mandriva|Mandriva]]
[[Getting_Started/Build/KDE4/Generic|any other distro]]

=== Optional Documentation Dependencies ===
For trunk you also now need docbook-dtd42-xml for the docs. Depending on your distribution please get the docbook related packages and the 4.2 DTD.

Your next compilation step depends on the packages supplied by your distro.

== Compiling kde-qt, etc. ==
If you do not want to use the packages provided by your distro you can compile things like Qt yourself. Instructions for building all dependencies including CMake, Qt4 (kde-qt) and kdesupport are available in [[Getting_Started/Build/KDE4/Prerequisites|the build prerequisites page]]. Note that automoc, strigi, soprano, and a few other things are part of kdesupport, so if you have errors about these missing, you'll need to get kdesupport.

=== Useful subversion tweaks ===

{{Warning|Do not use this method when you don't know what you are doing or just want to test some trunk feature, seriously!
You can create a very costly load when you accidentially checkout all of trunk or for example all of "trunk/KDE" just to build single modules. This would generate immense useless load on the svn server.}}

If you check out large parts of svn trunk regularly or if you want to create patches which touch several modules at once, you should try to checkout an empty tree of trunk first and then update only the relevant modules, for example:

==== Example ====
cd
cs # [[Getting_Started/Increased_Productivity_in_KDE4_with_Scripts/.bashrc|'cs' is a bash function, click here to learn more]]
svn checkout --depth empty svn://anonsvn.kde.org/home/kde/trunk
cd trunk
svn up kdesupport && cd kdesupport
cmakekde
cs trunk
svn up --depth empty KDE
svn up KDE/kdelibs && cd KDE/kdelibs
cmakekde
cs trunk
svn up KDE/kdepimlibs
...

==== Why do I want to do that? ====
That way you can move stuff around all over the trunk repository, e.g. from playground to kdereview or to KDE/*. The following examples assume that you only want to test or work on single and few modules of trunk.

This way updating the whole repository to a (hopefully) consitent state, the same revision, is really easy:

cs trunk # [[Getting_Started/Increased_Productivity_in_KDE4_with_Scripts/.bashrc|'cs' is a bash function, click here to learn more]]
svn up

== Download and Compile ==
In this section we go over acquiring and building the product.
{{Note|
check out http://kdesvn-build.kde.org/ you may not need to do all of this stuff.
}}

=== Troubleshooting ===
Please note, that requirements and dependancies frequently change.
You are running an UNSTABLE version, and simply compiling is not guaranteed. You will need to review errors and locate packages, (see acquire dependencies above) and [[Getting_Started/Build/KDE4/Troubleshooting|Troubleshooting]] information.

We can now move on to building KDE's most essential libraries.

=== kdelibs ===
Very important for lots of things, you may need to see troubleshooting and install some things from kdesupport first.

==== The Recipe ====
cd
cs # [[Getting_Started/Increased_Productivity_in_KDE4_with_Scripts/.bashrc|'cs' is a bash function, click here to learn more]]
mkdir KDE && cd KDE
svn checkout svn://anonsvn.kde.org/home/kde/trunk/KDE/kdelibs
cd kdelibs
mkdir build
cd build
cmakekde ..

==== What's Happening ====
We change to the base source directory (line 1) then make and go into the KDE directory (line 3). We download the sources for kdelibs using subversion (line 4), go into the new {{path|~/kde/src/KDE/kdelibs}} directory (line 5), and commence the build (line 6). This will leave us in the <tt>kdelibs</tt> build directory after the build is completed.

{{tip|There might be missing dependencies on your system! They are easily overlooked in the output of <tt>cmakekde</tt>.
You might want to do a <tt>cmake $KDE_SRC/KDE/MODULE_NAME</tt> prior to compiling any kde modules (like kdelibs, kdepimlibs etc.)}}

==== Additional KDE-specific CMake know-how ====

There are additional CMake modules in {{path|kdelibs/cmake/modules/}} that are necessary for building KDE4 applications. These will be installed for you when kdelibs itself is installed.

To make a non-debug-release (e.g. suppressing all kDebug() messages), use e.g.
cmake -DCMAKE_BUILD_TYPE=Release . && make && make install

==== Troubleshooting ====

For troubleshooting information, see the [[Getting_Started/Build/KDE4/Troubleshooting#Issues_building_kdelibs|kdelibs troubleshooting section]].

=== kdepimlibs ===
Currently kdebase depends on kdepimlibs so it is required to install it first. These libraries are also shared by other packages such as those within kdepim, kdeutils and kdenetwork.

==== libical ====
Download libical from http://sourceforge.net/project/showfiles.php?group_id=16077, compile, link and install it.
tar xvzf libical-0.41.tar.gz
cd libical-0.41
./configure && make && make install

==== The Recipe ====
cs KDE # [[Getting_Started/Increased_Productivity_in_KDE4_with_Scripts/.bashrc|'cs' is a bash function, click here to learn more]]
svn checkout svn://anonsvn.kde.org/home/kde/trunk/KDE/kdepimlibs
cd kdepimlibs
cmakekde

==== What's Happening ====
We go into the KDE source directory (line 1), download the source code for kdepimlibs using subversion (line 2) and then go into the new {{path|~/kde/src/KDE/kdepimlibs}} directory (line 3). We then commence the build (line 4). This will leave us in the <tt>kdepimlibs</tt> build directory after the build is completed.

==== Troubleshooting ====

For troubleshooting information, see the [[Getting_Started/Build/KDE4/Troubleshooting#Issues_building_kdepimlibs|kdepimlibs troubleshooting section]].

=== kdebase ===
kdebase is divided into three parts:
* '''apps'''
:This contains applications like Dolphin or KWrite.
* '''runtime'''
:This contains things needed by every application at runtime, like icons. It is a required dependency for each KDE application, so you have to compile and install this.
* '''workspace'''
:This contains things specific to the KDE desktop, like Plasma or the window manager. Most stuff here depends on X11. You only need it if you want to build a full KDE desktop.

You can build all of kdebase at once, which is described in the recipe below. If you only want to build kdebase-runtime, which is the only requirement, you can replace <code bash>cd kdebase</code> with <code bash>cd kdebase/runtime</code> in the recipe below.

==== The Recipe ====
cs KDE # [[Getting_Started/Increased_Productivity_in_KDE4_with_Scripts/.bashrc|'cs' is a bash function, click here to learn more]]
svn checkout svn://anonsvn.kde.org/home/kde/trunk/KDE/kdebase
cd kdebase
cmakekde

==== Troubleshooting ====
For troubleshooting information, see the [[Getting_Started/Build/KDE4/Troubleshooting#Issues_building_kdebase|kdebase troubleshooting section]].

== Translations ==

Most KDE users are going to install translations before being able to use their desktop properly. Full information is given in the [[Development/Tutorials/Localization/Building_KDE's_l10n_Module|Localisation tutorial]].
For a single language, the following receipe installs messages and translated documentation:

=== The Recipe ===
cs KDE # [[Getting_Started/Increased_Productivity_in_KDE4_with_Scripts/.bashrc|'cs' is a bash function, click here to learn more]]
svn checkout -N svn://anonsvn.kde.org/home/kde/trunk/l10n-kde4
cd l10n-kde4
svn up scripts <language>
./scripts/autogen.sh <language>
cd <language>
cmakekde

== Running KDE 4 programs ==

You can now run KDE 4 programs (e.g. kwrite) by typing:
ssh -X kde-devel@localhost
kwrite

=== Troubleshooting ===

For troubleshooting issues see [[Getting_Started/Build/KDE4/Troubleshooting#Running_programs|troubleshooting running programs]].

== Generating local API documentation ==

See the [[Development/Tools/apidox|generating apidox]] page.

== Staying up to date ==

In order to keep the kde4 installation up to date, each of the modules installed should be updated periodically. As Monday is the day for big changes in kdelibs, Tuesday may be the best day to do this. For each module checked out, run <tt>svn up</tt> and <tt>make</tt>.

For example:
<code bash>
cs kdesupport # cs is not a typo
svn up
cb # cb is not a typo
make install
</code>

Note: it is not necessary to run cmakekde for updates.

== Installing a subset of a module ==

Many modules in KDE contain a large number of programs which could take a long time to download and compile. In cases where you want to work only on a particular program or programs in a module, it is possible to download and compile particular folders. In some cases, certain folders are required for any build of the module. This is determined in the CMakeLists.txt file of the module. For example the [http://websvn.kde.org/branches/KDE/4.0/kdegames/CMakeLists.txt?view=markup kdegames CMakeLists.txt file] lists:

<code>
add_subdirectory(libkdegames)
add_subdirectory(libkmahjongg)

macro_optional_add_subdirectory(doc)
macro_optional_add_subdirectory(lskat)
macro_optional_add_subdirectory(katomic)
</code>

So, the libkdegames and libkmahjongg directories are required to build any of kdegames. The cmake directory will also usually be required. All the other directories (doc, katomic etc) are optional. They will be built if present on your machine. In this example, we build kmahjongg and kbattleship:

<code bash>
cs KDE
svn co -N svn://anonsvn.kde.org/home/kde/trunk/KDE/kdegames # The -N switch performs a non-recursive checkout
cd kdegames
svn co svn://anonsvn.kde.org/home/kde/trunk/KDE/kdegames/libkdegames # Get required directories
svn co svn://anonsvn.kde.org/home/kde/trunk/KDE/kdegames/libkmahjongg
svn co svn://anonsvn.kde.org/home/kde/trunk/KDE/kdegames/cmake
svn co svn://anonsvn.kde.org/home/kde/trunk/KDE/kdegames/kbattleship # Get optional directories
svn co svn://anonsvn.kde.org/home/kde/trunk/KDE/kdegames/kmahjongg
cmakekde
</code>

== Success! ==

You are now ready to start building other svn modules in the same fashion as you built kdebase, running and testing KDE4 or writing your own patches and applications.

For further isolation of your development environment change symbolic links, which you will see after executing ls -lh $(kde4-config --localprefix), assuming newly installed kde4-config is called.

See the [[Getting Started/Set up KDE 4 for development|Set up KDE 4 for development]] tutorial for how to start KDE 4 applications and how to use KDevelop to work on them.

For most of what you need to know on patches see: [[Contribute/Send Patches|Sending Patches]]

[[Category:Build KDE]]
[[Category:KDE4]]
{{Build KDE}}{{Getting Started}}

Archive:Getting Started/Build/Mac OS X

2010-08-20T18:24:56Z

Fulldecent: new link for Qt/Mac

{{KDE4}}
{{improve}}

*Note: You may wish to do all of this inside a directory name that ends in ''.noindex'' or ''.build'' to keep spotlight from indexing all of your temporary build-files as you build them.

== Required Third Party Tools ==
The following third party tools are required for successfully building KDE on OSX. Also, here are some [[Getting_Started/Build/KDE4/LFS| good tips for installing from source]].
* AGG
* bzip2
* giflib or libungif
* libart_lgpl
* libidn
* libjpeg
* libmng
* libpng
* libxml2
* libxslt
* libusb
* OpenEXR
* PCRE
* Strigi
* shared-mime-info
* pkgconfig
* subversion (to check out the kde sources)
* dbus

== Verify Compiler Version ==
* Fink: If your ''Distribution'' line in ''/sw/etc/fink.conf'' is 10.4-transitional, instead of 10.4, make sure you run ''sudo gcc_select 3.3'' before proceeding with any compiling, or you will end up with binary-incompatible c++ code!
* Manual: run ''sudo gcc_select 4.0'' if you want to be compatible with the pre-made installers.
== Qt/Mac Open Source Edition ==
Download qt-mac-opensource from http://qt.nokia.com/downloads/qt-for-open-source-cpp-development-on-mac-os-x

Patches are required for a successful build. Download the qt-copy patches through KDE's svn:
<code>svn co svn://anonsvn.kde.org/home/kde/trunk/qt-copy/patches/</code>
and apply the patches:
<code>cd qt-mac-opensource-4*
for patch in /path/to/patches/*.diff; do patch -p0 < $patch; done
</code>
Note: when applying patches you will get errors when processing x11 specific files (i.e. files that match the pattern *_x11.{h,cpp}), simply skip those patches.

And finally, compile qt-mac:
<code>./configure -prefix /opt/qt4 -qt-gif
make all install</code>

Please note: The Qt/Mac binary edition available from ftp.trolltech.com will '''not''' work,
because it does not contain the QtDBus module! (tested with 4.3.2)

== CMake ==
CMake may be downloaded from CVS:
<code>cvs -d :pserver:anonymous@www.cmake.org:/cvsroot/CMake login</code>
Note: password is "cmake"
<code>cvs -d :pserver:anonymous@www.cmake.org:/cvsroot/CMake co CMake</code>
And then compiled and installed:
<code>cd CMake
./configure --prefix=/opt/kde4-deps
make all install</code>

== Setting Up Your Build Environment ==
Variable must be set to build KDE successfully, and are noted below
*Note: Replace /opt/kde4-deps with the location of your 3rd-party tools, and add your cmake location if you compiled from source
<code>export PATH="/opt/qt4/bin:/opt/kde4/bin:/opt/kde4-deps/bin:$PATH"
export CMAKE_LIBRARY_PATH="/opt/kde4-deps/lib"
export CMAKE_INCLUDE_PATH="/opt/kde4-deps/include"
export PKG_CONFIG_PATH="/opt/qt4/lib/"</code>
== Building kdelibs ==
kdelibs must be checked out of svn locally to be built:
<code>svn co svn://anonsvn.kde.org/home/kde/trunk/KDE/kdelibs</code>
And then compiled by performing the following:
<code>mkdir kdelibs.build
cd kdelibs.build
cmake ../kdelibs -DCMAKE_INSTALL_PREFIX=/opt/kde4
make all install</code>

== Troubleshooting ==
If kdelibs fails to compile successfully, check the build status for the latest Nightly Builds and Continuous Builds at http://public.kitware.com/dashboard.php?name=kde

Information about getting and compiling the dependencies can be found at [[Getting_Started/Build/KDE4]] and [[Getting_Started/Build/KDE4/Prerequisites]] (pages are Linux focused, but can be useful)

== Using Binaries ==
If you're interested in just checking things out, binaries for kdelibs and parts of KDE in general are available at [[Projects/KDE on Mac OS X]] and are generated semi-regularly.

== Further Reading ==
For more general information on using CMake, see the [[Development/Tutorials/CMake|CMake Tutorial]].

[[Category:Mac OSX]]

Archive:Getting Started/Build/Mac OS X

2010-08-20T18:19:43Z

Fulldecent: remove link to dead content

{{KDE4}}
{{improve}}

*Note: You may wish to do all of this inside a directory name that ends in ''.noindex'' or ''.build'' to keep spotlight from indexing all of your temporary build-files as you build them.

== Required Third Party Tools ==
The following third party tools are required for successfully building KDE on OSX. Also, here are some [[Getting_Started/Build/KDE4/LFS| good tips for installing from source]].
* AGG
* bzip2
* giflib or libungif
* libart_lgpl
* libidn
* libjpeg
* libmng
* libpng
* libxml2
* libxslt
* libusb
* OpenEXR
* PCRE
* Strigi
* shared-mime-info
* pkgconfig
* subversion (to check out the kde sources)
* dbus

== Verify Compiler Version ==
* Fink: If your ''Distribution'' line in ''/sw/etc/fink.conf'' is 10.4-transitional, instead of 10.4, make sure you run ''sudo gcc_select 3.3'' before proceeding with any compiling, or you will end up with binary-incompatible c++ code!
* Manual: run ''sudo gcc_select 4.0'' if you want to be compatible with the pre-made installers.
== Qt/Mac Open Source Edition ==
Download qt-mac-opensource from http://www.trolltech.com/download/qt/mac

Patches are required for a successful build. Download the qt-copy patches through KDE's svn:
<code>svn co svn://anonsvn.kde.org/home/kde/trunk/qt-copy/patches/</code>
and apply the patches:
<code>cd qt-mac-opensource-4*
for patch in /path/to/patches/*.diff; do patch -p0 < $patch; done
</code>
Note: when applying patches you will get errors when processing x11 specific files (i.e. files that match the pattern *_x11.{h,cpp}), simply skip those patches.

And finally, compile qt-mac:
<code>./configure -prefix /opt/qt4 -qt-gif
make all install</code>

Please note: The Qt/Mac binary edition available from ftp.trolltech.com will '''not''' work,
because it does not contain the QtDBus module! (tested with 4.3.2)

== CMake ==
CMake may be downloaded from CVS:
<code>cvs -d :pserver:anonymous@www.cmake.org:/cvsroot/CMake login</code>
Note: password is "cmake"
<code>cvs -d :pserver:anonymous@www.cmake.org:/cvsroot/CMake co CMake</code>
And then compiled and installed:
<code>cd CMake
./configure --prefix=/opt/kde4-deps
make all install</code>

== Setting Up Your Build Environment ==
Variable must be set to build KDE successfully, and are noted below
*Note: Replace /opt/kde4-deps with the location of your 3rd-party tools, and add your cmake location if you compiled from source
<code>export PATH="/opt/qt4/bin:/opt/kde4/bin:/opt/kde4-deps/bin:$PATH"
export CMAKE_LIBRARY_PATH="/opt/kde4-deps/lib"
export CMAKE_INCLUDE_PATH="/opt/kde4-deps/include"
export PKG_CONFIG_PATH="/opt/qt4/lib/"</code>
== Building kdelibs ==
kdelibs must be checked out of svn locally to be built:
<code>svn co svn://anonsvn.kde.org/home/kde/trunk/KDE/kdelibs</code>
And then compiled by performing the following:
<code>mkdir kdelibs.build
cd kdelibs.build
cmake ../kdelibs -DCMAKE_INSTALL_PREFIX=/opt/kde4
make all install</code>

== Troubleshooting ==
If kdelibs fails to compile successfully, check the build status for the latest Nightly Builds and Continuous Builds at http://public.kitware.com/dashboard.php?name=kde

Information about getting and compiling the dependencies can be found at [[Getting_Started/Build/KDE4]] and [[Getting_Started/Build/KDE4/Prerequisites]] (pages are Linux focused, but can be useful)

== Using Binaries ==
If you're interested in just checking things out, binaries for kdelibs and parts of KDE in general are available at [[Projects/KDE on Mac OS X]] and are generated semi-regularly.

== Further Reading ==
For more general information on using CMake, see the [[Development/Tutorials/CMake|CMake Tutorial]].

[[Category:Mac OSX]]

Policies/Draft/The Power Of The Doer

2010-08-16T13:39:55Z

Fulldecent: add attribution

THIS IS NOT CURRENTLY AN OFFICIAL KDE POLICY

Most of KDE contributors are volunteers, either programmers, artists, writers or translators. A traditional organization of hierarchy in this case is difficult to maintain and inefficient. But there are some rules and principles that help coordinating the efforts, and it is fundamental to know them.

=The Power Of The Doer=

In a volunteer project, the way to make something happen is present a concrete
solution, better yet if followed with an implementation. For example, pointing
out that KDE context help for dialogs is incomplete will not be useful, people
already know that. Writing context help for dialogs and sending it to the
maintainer is the only practical way to change this reality. There is also a lot
of room for different approaches in the implementation, as the maintainer is
likely to accept something he does not consider the best possible solution if he
judges it is an improvement. Programming issues are decided by programmers,
documentation issues are solved by documentation writers and so on.

==The Maintainer Role And The Decision Process==

The maintainer is the guy who formally takes responsibility for an
application or library. But it does not mean that he takes all decisions. For
controversial issues, the general decision is made by voting. To have a voice
in the voting process, it is necessary to be a current contributor, with
relevant past contributions. Anyone can try to influence the decision process
by presenting thoughtful arguments and evidence. And even when something is
decided to be the right path, it does not mean it will be implemented: someone
must have the time and will to implement it.

(This content originally by Carlos Woelz from http://websvn.kde.org/trunk/www/areas/quality/develop/policies/index.php?annotate=286645&pathrev=286645)

Policies/Draft/The Power Of The Doer

2010-08-15T19:58:33Z

Fulldecent:

Policies/Draft/The Power Of The Doer

2010-08-15T18:51:31Z

Fulldecent: copied content from http://quality.kde.org/develop/policies/

Most of KDE contributors are volunteers, either programmers, artists, writers or translators. A traditional organization of hierarchy in this case is difficult to maintain and inefficient. But there are some rules and principles that help coordinating the efforts, and it is fundamental to know them.

=The Power Of The Doer=

In a volunteer project, the way to make something happen is present a concrete
solution, better yet if followed with an implementation. For example, pointing
out that KDE context help for dialogs is incomplete will not be useful, people
already know that. Writing context help for dialogs and sending it to the
maintainer is the only practical way to change this reality. There is also a lot
of room for different approaches in the implementation, as the maintainer is
likely to accept something he does not consider the best possible solution if he
judges it is an improvement. Programming issues are decided by programmers,
documentation issues are solved by documentation writers and so on.

==The Maintainer Role And The Decision Process==

The maintainer is the guy who formally takes responsibility for an
application or library. But it does not mean that he takes all decisions. For
controversial issues, the general decision is made by voting. To have a voice
in the voting process, it is necessary to be a current contributor, with
relevant past contributions. Anyone can try to influence the decision process
by presenting thoughtful arguments and evidence. And even when something is
decided to be the right path, it does not mean it will be implemented: someone
must have the time and will to implement it.

Archive:Getting Started/Build/Requirements

2008-08-12T22:14:44Z

Fulldecent: update due to 4.1 release

{{Template:I18n/Language Navigation Bar|Getting_Started/Build/KDE4/Prerequisites}}

{{TutorialBrowser|

series=Getting Started|

name=Building KDE4 From Source/Prerequisites|

pre=[[../|KDE SVN Quickstart Guide]]|

next=[[../|KDE SVN Quickstart Guide]]|
|
}}

== Abstract ==

Some or all of these packages should be available for installation from your distribution. For ease of installation and upgrading it is a good idea to install distribution packages if a recent enough version is provided. Software required to build KDE4 includes:

* gcc and g++, preferably version 4.2 or higher
* svn, the subversion revision control client
* pkg-config
* development libraries and headers for X11, OpenGL (mesa-common-dev and libglu1-mesa-dev), libjpeg, libpng, libungif, [http://clucene.sourceforge.net/index.php/Downloads libclucene], [http://download.librdf.org/source/ librdf], libxml2 and libxslt
* the <tt>makeobj</tt> script, which is included in kdesdk. You can install it from kdesdk (kdesdk-scripts on Debian) or similar packages, or download at [http://websvn.kde.org/*checkout*/trunk/KDE/kdesdk/scripts/makeobj WebSVN]
* the [http://freedesktop.org/wiki/Software/shared-mime-info shared-mime-info package], is the freedesktop MIME standard now used in KDE
* [http://boost.org/ boost], used by kdebase; after build and/or install, in order to make cmake aware about its location (FindBoost), add the boost directory (which contains the include subdirectory) to CMAKE_INCLUDE_PATH or set a environment variable called BOOST_ROOT that points to the boost directory.

== D-Bus ==
QtDBus and KDE are known to work with D-Bus versions 0.62, as well as 0.92 and upwards. Versions 0.60 and 0.61 may work too but are not tested. Versions 0.90 and 0.91 are known not to work. We recommend using post-1.0 release versions (at least 0.94), so consider upgrading if you haven't done so.

You may skip this section if you have a recent D-Bus version or if you don't want to upgrade. You probably want to skip building the bindings until/unless you know you will be building HAL (see below).

Before running these steps in the recipe, make sure your X11 headers and libraries are available. The configure script run on line 5 of the following instructions should output:
Building X11 code: yes

=== The Recipe ===

{{tip|Make sure you did set up your environment correctly as described [[Getting_Started/Build/KDE4#Setting_up_the_environment|above]]. This is necessary for the <tt>cs</tt> and <tt>cb</tt> functions to work.}}

cs # [[Getting_Started/Increased_Productivity_in_KDE4_with_Scripts/.bashrc|'cs' is a bash function, click here to learn more]]
wget http://dbus.freedesktop.org/releases/dbus/dbus-1.0.2.tar.gz
tar -xvzf dbus-1.0.2.tar.gz
cd dbus-1.0.2/
./configure --prefix=$DBUSDIR --localstatedir=/var
make
sudo make install
sudo dbus-uuidgen --ensure

cs # see above
wget http://dbus.freedesktop.org/releases/dbus-glib/dbus-glib-0.74.tar.gz
tar -xvzf dbus-glib-0.74.tar.gz
cd dbus-glib-0.74/
./configure --prefix=$DBUSDIR
make
sudo make install
cd
sudo chown -R kde-devel:kde-devel *

=== What's Happening ===
After changing into the source directory (line 1), D-Bus source code is downloaded from freedesktop.org (line 2) and unpacked (line 3). After going into the newly created D-Bus directory (line 4), the build is set up using the supplied {{path|configure}} script (line 5). After building (line 6) and installing (line 7) D-Bus, we use the <tt>dbus-uuidgen</tt> tool to install a machine identification file that allows the bus to start automatically when the desktop session starts (line 8).

Note that you need write access to {{path|/var}} for the last two steps. If your system does not have the sudo command, you can use the <tt>su</tt> command instead, e.g. <tt>su -c "make install"</tt>.

The steps for building the glib bindings are similar to the above.

When these two packages are done building, we must fix the file ownership because 'sudo make install' has created root owned files and directories in ~kde-devel/kde.

=== Troubleshooting ===
If you get the error:
"configure: error: DBus development libraries not found"
do this:
export PKG_CONFIG_PATH=/lib/pkgconfig/

== CMake ==
Skip this if you have [http://cmake.org/ CMake] >=2.6 installed.
You should be able to directly use the binary packages available on the [http://cmake.org/HTML/index.html CMake site]. There are also distribution specific packages available.

=== The Recipe ===


cs # [[Getting_Started/Increased_Productivity_in_KDE4_with_Scripts/.bashrc|'cs' is a bash function, click Here to learn more]]
wget http://www.cmake.org/files/v2.6/cmake-2.6.1.tar.gz
tar -zxf cmake-2.6.1.tar.gz
mkdir cmake-build
cd cmake-build
../cmake-2.6.1/bootstrap
make
sudo make install

=== What's Happening ===
First, we go back to the <tt>kde-devel</tt> user's source directory (line 1), get the CMake sources (line 2) and unpack them (line 3). We create a directory to build CMake in (line 4) and go into it (line 5). We then run the CMake bootstrap script to set up the CMake build (line 6), then make (line 7) and install it (line 8) using the root user.

If your system does not have the <tt>sudo</tt> command, you can instead do <tt>su -c "make install"</tt>.

== Qt ==
Next we need to get Qt4. KDE 4.0 builds against Qt 4.3, however KDE 4.1 and trunk require the Qt 4.4. A recent snapshot of Qt 4.4 is available in the qt-copy module. KDE 4 will not build against Qt 4.2 or earlier.

Most distributions have packages of Qt 4.3. Some have packaged either the Qt 4.4 beta, or qt-copy as well. If the distribution you use has done this, using it is a viable option. If the distribution you use does not provide packages of the necessary version of Qt, it will be necessary to use the recipe below. More information can be found in the sections of the tutorial specific to each distribution.

Building qt4.4 with the -no-qt3support option will cause things to break.

Please read the README.qt-copy file for the necessary Qt configure options as well as currently known issues.

=== The Recipe ===
cs # Note: cs is not a typo. See [[Getting_Started/Increased_Productivity_in_KDE4_with_Scripts/.bashrc|<font color=red>.bashrc</font>]]
svn checkout svn://anonsvn.kde.org/home/kde/trunk/qt-copy
cd qt-copy
./apply_patches
./configure [copy/paste configure line from README.qt-copy replacing <installdir> with $QTDIR]
make -j2 # use 'make -j(X+1)' where X is your number of processors, to compile faster
# if we don't install, we'll just clear obj files to
# save disk space
if [ "$QTDIR" = "`pwd`" ]; then \
find . -name '*.o' -delete ; \
else make install; fi;

'''Make sure <tt>which qmake</tt> delivers something out of $QTDIR, e.g.:'''
/home/kde-devel/qt-copy/bin/qmake

=== What's Happening ===
We switch back to the <tt>kde-devel</tt> user's home directory (line 1) and download the source code using subversion (svn) from KDE's repository (line 2). After changing into the resulting {{path|qt-copy}} directory (line 3), we run a script that manages the patches that come with <tt>qt-copy</tt> (line 4).

Once the patches have been applied, we then set up the build using the <tt>configure</tt> script (line 5-6). The various command line options used are explained in the {{path|qt-copy/README.qt-copy}} file. Finally, we build the minimal requirements for KDE (line 7) and install (line 10) Qt. If install dir is the same as the current dir (line 8), then we just free some space (line 9) instead. If you want all the example and demo applications, you can either build them individually or simply do a <tt>make</tt> from the {{path|qt-copy}} directory.

Note that the installation does not require root as it installs Qt locally into {{path|$QTDIR}}. Installation is necessary if {{path|$QTDIR}} differs from the source directory.
In the end, we make sure the cmake macro to find the Qt directory will work. It must be able to find qmake in $QTDIR.

=== Troubleshooting ===
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}}. '''Note:''' You may need to run <tt>xhost +local:kde-devel</tt> as your regular kde3 user to run this application. If it crashes in QSpanData::adjustSpanMethods, then your problem is the oxygen style. Try removing {{path|lib/kde4/plugins/styles/kstyle-oxygen.so}} and {{path|lib/kde4/plugins/styles/oxygen.so}} if they exist in the KDE install prefix.

=== 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.qt-copy}}):
cd $KDE_SRC/qt-copy
make docs
./config.status
make install
Note that it is necessary to do this only once, even if you rebuild Qt later.

== HAL ==

{{tip|You can use qdbusviewer to see if you have org.freedesktop.hal. If not, you might need a newer version of hal. If you have org.freedesktop.hal, you probably don't need to, and don't ''want'' to, roll your own HAL.}}

If your system requires you to build a newer version of HAL, there's a decent chance you'll need to build other stuff as well, some of which may not be straight forward. This, however, should only be required for older distros.

== kdesupport ==

{{warning|Don't forget to read the [[Getting_Started/Build/KDE4#Setting_up_the_environment|Setting Up The Environment]] section first.}}

There are several libraries that KDE applications rely on in the kdesupport module. This includes Phonon, Strigi and Soprano for file metadata and search, QImageBlitz for image manipulation needed in kdebase, eigen for visual effects in applications such as Kalzium, taglib for music players and qca for some cryptographic needs.

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.

Please remember that if you use openSUSE, you can install the needed packages from the KDE:KDE4 buildservice repository and do not have to bother with fiddling the details below. Skip to the kdelibs section.

=== The Recipe ===

cs # [[Getting_Started/Increased_Productivity_in_KDE4_with_Scripts/.bashrc|'cs' is a bash function, click here to learn more]]
svn checkout svn://anonsvn.kde.org/home/kde/trunk/kdesupport/
cd kdesupport
cmakekde

=== What's Happening ===
We change to the base source directory (line 1). We download the sources in kdesupport using subversion (line 2), go into the new {{path|~/kde/src/kdesupport}} directory (line 3), and commence the build (line 4). This will leave us in the kdesupport build directory after the build is completed.

=== Troubleshooting ===
If you get
cmakekde: command not found
then you have to go manually into the kdesupport directory in ~ and execute the command cmakekde. if this still doesn't work, then something is wrong with your bashrc.

If you get
CMake Error: This project requires some variables to be set,
and cmake can not find them.
Please set the following variables:
LIBXML2_INCLUDE_DIR (ADVANCED)
you should install the development package for libxml2.

If you get
CMake Error: Could NOT find REDLAND
then you need librdf from the Redland.
If your distribution does not provide the librdf package, you can download the source there: [http://download.librdf.org/source/ http://download.librdf.org/source/] and build it.
(Gentoo users: The ebuild for librdf is named dev-libs/redland)

If you get
Fetching external item into 'kdesupport/admin'
Error validating server certificate for 'https://...'
see [[Getting_Started/Sources/Using_Subversion_with_KDE|Using Subversion with KDE]]

If you get
FILE cannot create directory: /usr/lib[64]/qt4/plugins/crypto. Maybe need administrative privileges.

make: *** [install] Error 255
take a second look in the .bashrc file described above, are paths correct? ($QTDIR and $PATH are used to get the QT installation path)
Alternatively, you may see this error if you decided to use a distribution installed version of qt4 and skipped the Qt install above. Either install qt-copy as describe above, or "sudo make install". If you use "sudo make install", make sure that you change the ownership back to your user for some of the ~/kde subdirectories that were effected by using sudo (ie. "<tt>sudo chown -R kde-devel:kde-devel ~/kde</tt>").

If you get a message related to
target libQtTest.so not found
you may need to recompile qt-copy. 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-copy
4) make confclean
5) repeat steps for installing Qt (from ./configure line).
6) retry building kdesupport

If you get
"CMake Error: Could NOT find BZip2"
then
sudo apt-get install libbz2-dev

== Next Step ==
Once all requirements have been installed it is time to install [[../#kdelibs|kdelibs]]

Getting Started/Build/KDE4

2007-12-29T21:20:23Z

Fulldecent: /* Staying up to date */

{{Template:I18n/Language Navigation Bar|Getting_Started/Build/KDE4}}

{{TutorialBrowser|

series=Getting Started|

name=Building KDE4 From Source|

pre=[[../../Sources/Anonymous_SVN|Anonymous SVN Quickstart Guide]]|

next=[[../../Set_up_KDE_4_for_development|Set up KDE 4 for development]]|

reading=[[../kdesvn-build|kdesvn-build: The KDE From Subversion Build Tool]]<br>[[../../Increased_Productivity_in_KDE4_with_Scripts|Increased Productivity in KDE4 with Scripts]]<br>[[Development/Tutorials/CMake |Introduction to CMake]]<br>[[../KDE4/FreeBSD|FreeBSD notes]]<br>[[../KDE4/Mac OS X|Instructions for Mac OS X]]<br>[[../KDE4/Windows|Instructions for MS Windows]]|
}}

== Abstract ==

This tutorial shows one way to get KDE from trunk running on Linux/BSD systems. There are also tutorials for [[Getting_Started/Build/KDE4/FreeBSD|FreeBSD]], [http://www.kdelibs.com/ Windows], [[Getting_Started/Build/KDE4/Mac OS X|Mac OS X]] and [http://solaris.kde.org/ Solaris]. Throughout the tutorial the bash shell is used.

{{warning|Expect a higher risk of build failure '''on Mondays''' when most kdelibs changes are committed. [http://developer.kde.org/~dirk/dashboard/ Dashboard] reports unexpected breakages. You are encouraged to fix failing modules.
}}

== Software Requirements ==

The following needs to be installed to successfully use this tutorial:
* gcc and g++, preferably version 4.2 or higher
* svn, the subversion revision control client
* pkg-config
* development libraries and headers for X11, OpenGL (mesa-common-dev and libglu1-mesa-dev), libjpeg, libpng, libungif, [http://clucene.sourceforge.net/index.php/Downloads libclucene], [http://download.librdf.org/source/ librdf], libxml2 and libxslt
* the <tt>makeobj</tt> script, which is included in kdesdk. You can install it from kdesdk (kdesdk-scripts on Debian) or similar packages, or download at [http://websvn.kde.org/*checkout*/trunk/KDE/kdesdk/scripts/makeobj WebSVN]
* the [http://freedesktop.org/wiki/Software/shared-mime-info shared-mime-info package], is the freedesktop MIME standard now used in KDE
* [http://boost.org/ boost], used by kdebase; after build and/or install, in order to make cmake aware about its location (FindBoost), add the boost directory (which contains the include subdirectory) to CMAKE_INCLUDE_PATH or set a environment variable called BOOST_ROOT that points to the boost directory.

=== Ark Linux ===
In Ark Linux, the build dependencies you need are installed with:

<code bash>
apt-get install devel-core libxml-devel libxslt-devel bzip2-devel \
clucene-core-devel librdf-devel shared-mime-info xorg-Mesa-libGL-devel \
subversion boost-devel doxygen giflib-devel dbus-devel openssl-devel \
alsa-lib-devel kdesdk-scripts qt4-devel
</code>

If you prefer a graphical interface, select the packages listed above in the "Install Software" tool in Mission Control.

This includes installation of CMake, DBus and Qt - you can skip steps 5, 6 and 7.

=== Arch Linux ===
In Arch Linux you need to install the following packages:

<code bash>
pacman -Sy subversion bzip2 libxslt libxml2 \
shared-mime-info mesa boost dbus openssl \
pkgconfig xine-lib clucene
</code>

If you want to use qt4 from the Arch Linux repository you can install it with:
<code bash>
pacman -Sy qt4
</code>

<s>For clucene libraries you need the [http://aur.archlinux.org/packages.php?do_Details=1&ID=5968 PKGBUILD] from AUR.</s>
(No longer needed since clucene has been put into the extra-repo.)

=== Fedora ===

Some of the required packages for building KDE4 on Fedora 7 or higher:

<code bash>
yum install clucene-core-devel libxml-devel libxslt-devel \
dbus-devel boost-devel bzip2-devel openssl-devel alsa-lib-devel \
redland-devel rasqal-devel raptor-devel hspell-devel aspell-devel \
cups-devel xine-lib-devel avahi-devel gamin-devel OpenEXR-devel \
enchant-devel jasper-devel ilmbase-devel pcre-devel gpgme-devel \
libxklavier-devel glib-devel libusb-devel libsmbclient-devel \
libxcb-devel NetworkManager-devel lm_sensors-devel libraw1394-devel \
bluez-libs-devel gcc-c++ libXext-devel cmake subversion giflib-devel \
libpng-devel libXdamage-devel libXcomposite-devel libXrender-devel \
fontconfig-devel libXft-devel libXcursor-devel libXfixes-devel \
ruby-devel libXScrnSaver-devel libkdcraw-devel exiv2-devel \
lcms-devel libtiff-devel sqlite-devel libxkbfile-devel \
imlib2-devel patch gstreamer-plugins-base-devel
</code>

Some optional packages for koffice support:
<code bash>
yum install qca2-devel gsl-devel freeglut-devel \
GraphicsMagick-c++-devel GraphicsMagick-devel
</code>

This includes installation of D-Bus and CMake -- you can skip steps 5 and 6.

DCH-10/15/07: Note - It may be simpler to spin RPMs. Note that you can edit the variables in /etc/rpm/macros.kde4 (which is provided by Rawhide kde-filesystem).

The build stage then looks like:
(but in what directory?)
%build

mkdir -p %{_target_platform}

pushd %{_target_platform}

%{cmake_kde4} ..

popd

make %{?_smp_mflags} -C %{_target_platform}

I have had better results with creating a kdesupport rpm which means that you should not install the soprano and strigi rpms. YMMV

telsh: On a Fedora 8 System I had to install "qt4-devel" too to have qmake.

=== Kubuntu and Debian ===

In Kubuntu 7.04 (Feisty) and Debian (Testing/Unstable) the build dependencies you need are installed with:
<code>
sudo aptitude install build-essential cdbs debhelper cmake \
libxml2-dev libxslt1-dev libbz2-dev libclucene-dev librdf-dev \
shared-mime-info libgl1-mesa-dev libglu1-mesa-dev mesa-common-dev \
libxext-dev libjpeg-dev libpng12-dev subversion libsm-dev libxinerama-dev \
libxrender-dev libfontconfig-dev libboost-dev libxcursor-dev doxygen \
libungif4-dev libdbus-1-dev libssl-dev libgpgme11-dev \
libasound2-dev kdesdk-scripts libpth-dev libjasper-dev \
ssh libxine-dev libqimageblitz-dev libqimageblitz4 libglib2.0-dev \
libxkbfile-dev libenchant-dev libbluetooth-dev network-manager-dev \
libsmbclient-dev libxcb1-dev libcaptury-dev libxcomposite-dev \
libxdamage-dev libusb-dev libgpgme11-dev libldap2-dev
</code>

In Kubuntu 7.10 (Gutsy) and Debian unstable you also have to add:
<code>
sudo aptitude install dbus-x11 libqt4-dev libqca2-dev libeigen-dev \
libstreamanalyzer-dev libsoprano-dev libstrigiqtdbusclient-dev \
libxklavier11-dev libxml2-utils libdbus-1-dev libxslt1-dev cmake libbz2-dev \
libungif4-dev libgpgme11-dev libboost-dev libxine-dev libxkbfile-dev
</code>

For a fully functional API documentation framework you also need:
<code>
sudo aptitude install graphviz
</code>

There is no need to compile qt or kdesupport on kubuntu gutsy. All required packages are provided by installing the above. Setup the kde4 user etc as explained in the next section, but skip over compiling qt, hal and kdesupport.

{{Note|
If you get something trouble on compile KDE4
Beta4 or above in Kubuntu 7.10, such as :

Soprano version is too low

strigi xxx.h not found...

You may need to checkout, and compile the relevant part of
kdesupport source code in the SVN server of KDE4. (svn://anonsvn.kde.org/home/kde/trunk/kdesupport/soprano/)

This is covered when you get to the section on compiling kdesupport.

You might also have to remove any installed soprano package : sudo apt-get remove libsoprano4 libsoprano-dev

If you still get an error in the kdelibs section about soprano like:
CMake Error: Error in cmake code at
$src/KDE/kdelibs/cmake/modules/FindSoprano.cmake:78:
FILE Internal CMake error when trying to open file: /usr/include/soprano/version.h for reading.

then delete kdelibs/CMakeCache.txt
}}

=== openSUSE ===

In openSUSE 10.2 and newer, you can install packages using [http://en.opensuse.org/Zypper Zypper]:
<code bash>
sudo zypper install <package-name>
</code>

In older releases of SUSE, you can use YaST:
<code bash>
su
yast -i <packagename>
</code>

'''Required Packages'''

The packages you will need to install are:
<code>
xorg-x11-devel
libxml2-devel
kdesdk3
clucene-core-devel
boost-devel
libjpeg-devel
liblrdf-devel
libpng-devel
libxslt-devel
libredland-devel
Mesa-devel
giflib-devel
subversion
gcc
gcc-c++
gmp-devel (needed to build kdesupport)
gpgme-devel (needed to build kdepimlibs)
libxine1-devel
</code>

'''Optional Packages'''

You can skip the manual and painful installation kdesupport and its dependencies ( Qt 4.3, CMake 2.4.6, DBus, Hal, clucene-core, Strigi,
Soprano and other Nepomuk dependencies) by adding the KDE:KDE4 repository from
the [http://download.opensuse.org/repositories/KDE:/KDE4/ openSUSE Build Service] to your installation sources.

For openSUSE 10.2 and newer do:
<code>
sudo zypper service-add http://software.opensuse.org/download/KDE:/KDE4/openSUSE_10.2 KDE4-102
</code>

For older versions of SUSE Linux do:
<code>
su
installation_sources -a http://software.opensuse.org/download/KDE:/KDE4/[YOUR SUSE LINUX VERSION]
</code>

Now install the following packages:
<code>
cmake
dbus-1-devel
libqt4-devel
libqca2-devel
libsoprano-devel
libqimageblitz-devel
strigi
strigi-ui
</code>

There are a lot more packages that are needed to satisfy the config-check, such as libusb-devel, bison etc., so look out for the config notifications and install accordingly. Please remember to skip any instructions that refer to kdesupport below. Start to compile with kdelibs.

And for fully functional apidox framework you also need:
<code>
graphviz
</code>

CMake binary packages for openSUSE are available from the KDE:KDE4 repository as well as from the [http://software.opensuse.org/download/devel:/tools:/building/ openSUSE build service].

=== Gentoo ===

==== Install by hand ====

You can use stable ebuilds just remember to sync your portage before you begin.

Remember: All commands are executed as root.

Required:

We need to allow the following keyword masked ebuilds.

<code bash>
echo 'dev-util/cmake' >> /etc/portage/package.keywords
echo 'dev-cpp/clucene' >> /etc/portage/package.keywords
</code>

Make sure you have set the berkdb USE flag for redland, otherwise nepomuk won't work.

<code bash>
echo 'dev-libs/redland berkdb' >> /etc/portage/package.use
echo 'x11-libs/qt accessibility' >> /etc/portage/package.use
</code>

These are the packages you will need to emerge, I included the update option into the emerge command so you will not re-emerge anything that you might already have installed.

<code bash>
emerge -avu 'sys-devel/gcc' \
'dev-util/subversion' \
'dev-util/pkgconfig' \
'x11-base/xorg-x11' \
'virtual/glut' \
'media-libs/mesa' \
'media-libs/jpeg' \
'media-libs/libpng' \
'media-libs/giflib' \
'dev-cpp/clucene' \
'dev-util/cppunit' \
'media-libs/liblrdf' \
'dev-libs/libxml2' \
'dev-libs/libxslt' \
'x11-misc/shared-mime-info' \
'dev-libs/boost' \
'dev-util/cmake' \
'dev-libs/redland' \
'sys-apps/dbus' \
'sys-apps/hal' \
'x11-libs/qt'
</code>

You will also need to emerge either 'kde-base/kdesdk' or kde-base/kdesdk-scripts'.

If you emerged DBUS, CMAKE, QT or HAL you may skip those sections respectively.
Good luck!

==== Install via portage ====

Also you can install the KDE 4 packages directly via
<code bash>
emerge -a <packagename>
</code>

To get the things you need, [http://gentoo-wiki.com/TIP_Overlays#Layman install layman] and then pull in the "kde" overlay (which contains experimental KDE ebuilds):
<code bash>
layman -a kde
</code>
After this you need to adjust some USE-flags for KDE 4 and tell portage to use the testing KDE 4 ebuilds instead of the stable KDE 3 ones.

That way portage will do the dependency tracking for you.

Detailed instructions on building KDE 4 in Gentoo via portage can be found in the [http://overlays.gentoo.org/proj/kde/wiki KDE overlay wiki]. They are discussed in the forum thread [http://forums.gentoo.org/viewtopic-t-530111-postdays-0-postorder-asc-start-0.html KDE 4 monolithic ebuilds], which is continued [http://forums.gentoo.org/viewtopic-p-4359581.html#4359581 here]

=== Mandriva ===
In Mandriva the build dependencies you need are installed with:

<code bash>
urpmi gcc-c++ cmake libxml2-devel libbzip2_1-devel \
libclucene0-devel liblrdf2-devel libmesagl1-devel \
subversion doxygen libdbus-1_3-devel libopenssl0.9.8-devel \
libalsa2-devel libgpgme-devel libboost1-devel libxine-devel
</code>

If you're running 64-bit environment you should replace all packages starting with "lib..." to "lib64...".

If you prefer a graphical interface, select the packages listed above in the "Install Software" tool in Mandriva Linux Control Center.

This includes installation of CMake, DBus - you can skip steps 5 and 6.

== Create a user account for KDE4 development ==

{{Note|
Some people like to have a separate user account for KDE 4 (for instance an old bug deleted files by mistake), and the instructions below were written with that approach.

However it is much more efficient to do everything with a single user account, see [[Getting_Started/Increased_Productivity_in_KDE4_with_Scripts|Increased Productivity in KDE4 with Scripts]]
for more details.

You can still follow the instructions below, but don't put the environment variables in your <tt>.bashrc</tt>, put them in a separate file that you source to switch to the KDE 4 environment.
}}

=== Option 1: Command Line ===
<code bash>
useradd -m kde-devel
passwd kde-devel
</code>

{{Warning|
The new kde-devel user will not be added automatically to all the user groups, which will result in not having sound, not being able to sudo, etc. Edit your /etc/groups file to add the kde-devel user to all the groups that you need (probably the groups that your usual username is already assigned to).
}}

=== Option 2: Using KControl ===

Instead of using the commands above, you can also use the User module in the KDE Control Center if you already have KDE3 installed.

=== Setting up the environment ===

Copy the {{path|~/.bashrc}} from your normal user account to the new kde-devel account. Next, copy and paste the contents of the [[Getting Started/Increased Productivity in KDE4 with Scripts/.bashrc|example .bashrc]] into {{path|~kde-devel/.bashrc}}. Be sure to comment out the line <tt>alias make=makeobj</tt> if you do not have the <tt>[[Getting Started/Build/KDE4#Required Software|makeobj]]</tt> command available. You will probably also want to modify the path to make sure it doesn't include your kde3 paths. Also if you want to use KDevelop to develop KDE 4 applications you may pass the ''-GKDevelop3'' flag to the ''cmake'' command (to make CMake generate KDevelop project files, it will help to avoid rebuilding in the future, see [[Getting_Started/Set_up_KDE_4_for_development#Setting_up_the_environment|this]]).
To make it run, you have to open a new bash or to execute
<code bash>
source ~/.bashrc
</code>

This will provide access to commands such as <tt>cmakekde</tt> that are used in this tutorial as well as ensure that the proper paths are in place for Qt, KDE and CMake binaries.

For more information, please read the [[Getting Started/Increased Productivity in KDE4 with Scripts]] tutorial.

=== Switching to the New User ===
Switch to the user kde-devel: (don't forget the dash)
<code bash>
ssh -X kde-devel@localhost
</code>

{{Note|
If the ssh command fails, check out the [[Getting_Started/Set_up_KDE_4_for_development#Launching_KDE_4_apps|Launching KDE 4 apps]] section of the [[Getting_Started/Set_up_KDE_4_for_development|KDE4 development guide]].
}}

== The development user's shell ==

On some systems a new user is configured by default to use {{path|/bin/sh}}. If this is not the case on your system, you can skip this section. Using {{path|/bin/sh}} can be very inconvenient to work with and you may want to change it to {{path|/bin/bash}} or another shell.
On Ark Linux and Fedora, you can skip this step - {{path|/bin/sh}} is {{path|bash}}.

=== Option 1: As the kde-devel user ===

If you don't have root privileges and your system supports the changing of your own shell with the <tt>chsh</tt> application, then you could try to change your shell to {{path|/bin/bash}} by using:
<code bash>
chsh -s /bin/bash kde-devel
</code>

=== Option 2: As the root user ===

If your system comes with the <tt>usermod</tt> application you can run the following command as root: <tt>usermod -s /bin/bash</tt>.

Another option is to use the <tt>vipw</tt> application as root to safely edit your {{path|/etc/passwd}}. Locate 'kde-devel' in the the file. Change '{{path|/bin/sh}}' at the end of the line to read '{{path|/bin/bash}}', save your changes and exit.

The new shell will be started automatically when you log in as the kde-devel user again.

== D-Bus ==
QtDBus and KDE are known to work with D-Bus versions 0.62, as well as 0.92 and upwards. Versions 0.60 and 0.61 may work too but are not tested. Versions 0.90 and 0.91 are known not to work. We recommend using post-1.0 release versions (at least 0.94), so consider upgrading if you haven't done so.

You may skip this section if you have a recent D-Bus version or if you don't want to upgrade. You probably want to skip building the bindings until/unless you know you will be building HAL (see below).

Before running these steps in the recipe, make sure your X11 headers and libraries are available. The configure script run on line 5 of the following instructions should output:
Building X11 code: yes

=== The Recipe ===

{{tip|Make sure you did set up your environment correctly as described [[Getting_Started/Build/KDE4#Setting_up_the_environment|above]]. This is necessary for the <tt>cs</tt> and <tt>cb</tt> functions to work.}}

cs # [[Getting_Started/Increased_Productivity_in_KDE4_with_Scripts/.bashrc|'cs' is a bash function, click here to learn more]]
wget http://dbus.freedesktop.org/releases/dbus/dbus-1.0.2.tar.gz
tar -xvzf dbus-1.0.2.tar.gz
cd dbus-1.0.2/
./configure --prefix=$DBUSDIR --localstatedir=/var
make
sudo make install
sudo dbus-uuidgen --ensure

cs # see above
wget http://dbus.freedesktop.org/releases/dbus-glib/dbus-glib-0.74.tar.gz
tar -xvzf dbus-glib-0.74.tar.gz
cd dbus-glib-0.74/
./configure --prefix=$DBUSDIR
make
sudo make install
cd
sudo chown -R kde-devel:kde-devel *

=== What's Happening ===
After changing into the source directory (line 1), D-Bus source code is downloaded from freedesktop.org (line 2) and unpacked (line 3). After going into the newly created D-Bus directory (line 4), the build is set up using the supplied {{path|configure}} script (line 5). After building (line 6) and installing (line 7) D-Bus, we use the <tt>dbus-uuidgen</tt> tool to install a machine identification file that allows the bus to start automatically when the desktop session starts (line 8).

Note that you need write access to {{path|/var}} for the last two steps. If your system does not have the sudo command, you can use the <tt>su</tt> command instead, e.g. <tt>su -c "make install"</tt>.

The steps for building the glib bindings are similar to the above.

When these two packages are done building, we must fix the file ownership because 'sudo make install' has created root owned files and directories in ~kde-devel/kde.

== CMake ==
Skip this if you have [http://cmake.org/ CMake] >=2.4.5 installed.
You should be able to directly use the binary packages available on the [http://www.cmake.org/HTML/Download.html CMake site]. There are also distribution specific packages available.

=== The Recipe ===


cs # [[Getting_Started/Increased_Productivity_in_KDE4_with_Scripts/.bashrc|'cs' is a bash function, click Here to learn more]]
wget http://www.cmake.org/files/v2.4/cmake-2.4.6.tar.gz
tar -zxf cmake-2.4.6.tar.gz
mkdir cmake-build
cd cmake-build
../cmake-2.4.6/bootstrap
make
sudo make install

=== What's Happening ===
First, we go back to the <tt>kde-devel</tt> user's source directory (line 1), get the CMake sources (line 2) and unpack them (line 3). We create a directory to build CMake in (line 4) and go into it (line 5). We then run the CMake bootstrap script to set up the CMake build (line 6), then make (line 7) and install it (line 8) using the root user.

If your system does not have the <tt>sudo</tt> command, you can instead do <tt>su -c "make install"</tt>.

== Qt ==
Next we need to get Qt4. KDE is guaranteed to build against any Qt 4.3. Qt 4.2 and earlier are not supported and will not work.

If your distribution has a recent version of Qt4, that should work. Most distros backport bugfixes, and some distros, like Debian or openSUSE, even use the patches from KDE svn. In other cases, using the recipe below will give you a more stable Qt than your distro. Refer to the distribution specific sections above for more information.

As for now Qt3 compatibility layer in Qt 4 is mandatory, so please <b>avoid</b> using "-no-qt3support" option when building Qt4 from sources.

=== The Recipe ===
cd # Note: qt-copy lives in $HOME/qt-copy. See $QTDIR in [[Getting_Started/Increased_Productivity_in_KDE4_with_Scripts/.bashrc|<font color=red>.bashrc</font>]]
svn checkout svn://anonsvn.kde.org/home/kde/trunk/qt-copy
cd qt-copy
./apply_patches
./configure -qt-gif -no-exceptions -debug -fast \
-prefix $QTDIR -nomake examples -nomake demos
make -j2

# if we don't install, we'll just clear obj files to
# save disk space
if [ $QTDIR = `pwd` ]; then \
find . -name '*.o' -delete ; \
else make install; fi;

=== What's Happening ===
We switch back to the <tt>kde-devel</tt> user's home directory (line 1) and download the source code using subversion (svn) from KDE's repository (line 2). After changing into the resulting {{path|qt-copy}} directory (line 3), we run a script that manages the patches that come with <tt>qt-copy</tt> (line 4).

Once the patches have been applied, we then set up the build using the <tt>configure</tt> script (line 5-6). The various command line options used are explained in the {{path|qt-copy/README.qt-copy}} file. Finally, we build the minimal requirements for KDE (line 7) and install (line 10) Qt. If install dir is the same as the current dir (line 8), then we just free some space (line 9) instead. If you want all the example and demo applications, you can either build them individually or simply do a <tt>make</tt> from the {{path|qt-copy}} directory.

Note that the installation does not require root as it installs Qt locally into {{path|$QTDIR}}. Anyway, installation is only needed if {{path|$QTDIR}} differs from {{path|$HOME/qt-copy}}, which is not the case if you have exactly followed the instructions.

=== Troubleshooting ===
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}}. '''Note:''' You may need to run <tt>xhost +local:kde-devel</tt> as your regular kde3 user to run this application. If it crashes in QSpanData::adjustSpanMethods, then your problem is the oxygen style. Try removing {{path|lib/kde4/plugins/styles/kstyle-oxygen.so}} and {{path|lib/kde4/plugins/styles/oxygen.so}} if they exist in the KDE install prefix.

== HAL ==

{{tip|You can use qdbusviewer to see if you have org.freedesktop.hal. If not, you might need a newer version of hal. If you have org.freedesktop.hal, you probably don't need to, and don't ''want'' to, roll your own HAL.}}

If your system requires you to build a newer version of HAL, there's a decent chance you'll need to build other stuff as well, some of which may not be straight forward. Since this should only be required for older distros, instructions are on [[Getting_Started/Build/HAL| a separate page]].

== kdesupport ==

{{warning|Don't forget to read the [[Getting_Started/Build/KDE4#Setting_up_the_environment|Setting Up The Environment]] section first.}}

There are several libraries that KDE applications rely on in the kdesupport module. This includes Strigi and Soprano for file metadata and search, QImageBlitz for image manipulation needed in kdebase, eigen for visual effects in applications such as Kalzium, taglib for music players and qca for some cryptographic needs.

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.

Please remember that if you use openSUSE, you can install the needed packages from the KDE:KDE4 buildservice repository and do not have to bother with fiddling the details below. Skip to the kdelibs section.

=== The Recipe ===

cs # [[Getting_Started/Increased_Productivity_in_KDE4_with_Scripts/.bashrc|'cs' is a bash function, click here to learn more]]
svn checkout svn://anonsvn.kde.org/home/kde/trunk/kdesupport/
cd kdesupport
cmakekde

=== What's Happening ===
We change to the base source directory (line 1). We download the sources in kdesupport using subversion (line 2), go into the new {{path|~/kde/src/kdesupport}} directory (line 3), and commence the build (line 4). This will leave us in the kdesupport build directory after the build is completed.

=== Troubleshooting ===
If you get
cmakekde: command not found
then you have to go manually into the kdesupport directory in ~ and execute the command cmakekde. if this still doesn't work, then something is wrong with your bashrc.

If you get
CMake Error: This project requires some variables to be set,
and cmake can not find them.
Please set the following variables:
LIBXML2_INCLUDE_DIR (ADVANCED)
you should install the development package for libxml2.

If you get
CMake Error: Could NOT find REDLAND
then you need librdf from the Redland.
If your distribution does not provide the librdf package, you can download the source there: [http://download.librdf.org/source/ http://download.librdf.org/source/] and build it.
(Gentoo users: The ebuild for librdf is named dev-libs/redland)

If you get
Fetching external item into 'kdesupport/admin'
Error validating server certificate for 'https://...'
see [http://techbase.kde.org/Getting_Started/Sources/Using_Subversion_with_KDE Using Subversion with KDE]

If you get
FILE cannot create directory: /usr/lib[64]/qt4/plugins/crypto. Maybe need administrative privileges.

make: *** [install] Error 255
take a second look in the .bashrc file described above, are paths correct? ($QTDIR and $PATH are used to get the QT installation path)
Alternatively, you may see this error if you decided to use a distribution installed version of qt4 and skipped the Qt install above. Either install qt-copy as describe above, or "sudo make install". If you use "sudo make install", make sure that you change the ownership back to your user for some of the ~/kde subdirectories that were effected by using sudo (ie. "<tt>sudo chown -R kde-devel:kde-devel ~/kde</tt>").

If you get a message related to
target libQtTest.so not found
you may need to recompile qt-copy. This time you should take out
-nomake demos -nomake examples
from the configure command, so that Qt generates library QtTest.

== kdelibs ==

We can now move on to building KDE's base libraries.

=== The Recipe ===
cd
cs # [[Getting_Started/Increased_Productivity_in_KDE4_with_Scripts/.bashrc|'cs' is a bash function, click here to learn more]]
mkdir KDE && cd KDE
svn checkout svn://anonsvn.kde.org/home/kde/trunk/KDE/kdelibs
cd kdelibs
cmakekde

=== What's Happening ===
We change to the base source directory (line 1) then make and go into the KDE directory (line 2). We download the sources for kdelibs using subversion (line 3), go into the new {{path|~/kde/src/KDE/kdelibs}} directory (line 4), and commence the build (line 5). This will leave us in the <tt>kdelibs</tt> build directory after the build is completed.

{{tip|There might be missing dependencies on your system! They are easily overlooked in the output of <tt>cmakekde</tt>.
You might want to do a <tt>cmake $KDE_SRC/KDE/MODULE_NAME</tt> prior to compiling any kde modules (like kdelibs, kdepimlibs etc.)}}

=== Additional KDE-specific CMake modules ===
There are additional CMake modules in {{path|kdelibs/cmake/modules/}} that are necessary for building KDE4 applications. These will be installed for you when kdelibs itself is installed.

=== Troubleshooting ===
If you have problems compiling kdelibs, first make sure the software in the [[Getting_Started/Build/KDE4#Software_Requirements|Required Software]] section above is installed and works. Other possible hints include:
* If the <tt>cmakekde</tt> command fails stating that CMake requires an out of source build directory, remove {{path|~/kde/src/KDE/kdelibs/CMakeCache.txt}}, and try again.

If <tt>cmakekde</tt> still gives the same error then try this
cd
cmake -DCMAKE_INSTALL_PREFIX=$KDEDIR \
-DCMAKE_BUILD_TYPE=debugfull \
-DKDE4_BUILD_TESTS=ON \
~/kde/src/KDE/kdelibs
make
make install
* If you received an error stating "Please create a separate build directory and run 'cmake path_to_kdelibs [options]' there.", then you need to change to your build directory before running cmakekde. (e.g <tt>cs KDE/kdelibs && cb && cmakekde</tt>) If the message stays, run 'svn status' in the kdelibs directory and remove all files labeled with '?'.
* If Qt wasn't found or the wrong version of Qt was found, make sure that the qmake from the Qt you need is the first qmake in the path.
* If qmake wasn't found and you are using Debian packages, /usr/bin/qmake probably points to a wrong qmake version. To fix this run as root:
update-alternatives --config qmake
* If the problems persist, try the CMake make-option <tt>--keep-going</tt>.
* Here you need the libungif library, otherwise you will get an error message like "<tt>Could NOT find GIF</tt>".
* Qt-4.3 upgrade: if you get a link error in kjsembed talking about QScriptEngine, edit CMakeCache.txt in kdelibs and remove the lines that talk about QT_QTUITOOLS_LIBRARY, then type make again (that static library has a new dependency, and the cmake code that adds it needs to run).
* if you get <code>CMake Error: KDE Requires Qt to be built with SSL support
</code>, install openssl-devel, remove CMakeCache.txt and re-compile QT.
* if you get <code>kdelibs/kimgio/ico.cpp:188: undefined reference to `QImage::jumpTable()'</code> it means you compiled QT without QT3 support(no, linking to a true QT3 install won't work)
* if none of the errors above match yours, you might just try a quick'n'dirty <code>make clean</code> in kdelibs.

== kdepimlibs ==
After <tt>kdelibs</tt>, but before ''kdebase'', you need to build and install ''kdepimlibs''.

=== The Recipe ===

cs KDE # [[Getting_Started/Increased_Productivity_in_KDE4_with_Scripts/.bashrc|'cs' is a bash function, click here to learn more]]
svn checkout svn://anonsvn.kde.org/home/kde/trunk/KDE/kdepimlibs
cd kdepimlibs
cmakekde

=== What's Happening ===
We go into the KDE source directory (line 1), download the source code for kdepimlibs using subversion (line 2) and then go into the new {{path|~/kde/src/KDE/kdepimlibs}} directory (line 3). We then commence the build (line 4). This will leave us in the <tt>kdepimlibs</tt> build directory after the build is completed.

=== Troubleshooting ===
If you have trouble compiling kdepimlibs:
* the cmakekde command may require a later version of the gpgme library. This is available from the project's web site: http://www.gnupg.org/(en)/download/index.html - please note that the build of gpgme also requires libgpg-error, also available from the same location. Both libraries are installed by the "./configure", "make" and "sudo make install" sequence, with the gpgme library configured with the additional "--with-gpg-error-prefix" parameter. You may need to overwrite your existing "/usr/bin/gpgme-config" file with the newer version for the kdepimlibs to pick up the new install.

== kdebase ==
kdebase is divided into three parts:
* '''apps'''
:This contains applications like Dolphin or KWrite.
* '''runtime'''
:This contains things needed by every application at runtime, like icons. It is a required dependency for each KDE application, so you have to compile and install this.
* '''workspace'''
:This contains things specific to the KDE desktop, like Plasma or the window manager. Most stuff here depends on X11. You only need it if you want to build a full KDE desktop.

You can build all of kdebase at once, which is described in the recipe below. If you only want to build kdebase-runtime, which is the only requirement, you can replace <code bash>cd kdebase</code> with <code bash>cd kdebase/runtime</code> in the recipe below.

=== The Recipe ===

cs KDE # [[Getting_Started/Increased_Productivity_in_KDE4_with_Scripts/.bashrc|'cs' is a bash function, click here to learn more]]
svn checkout svn://anonsvn.kde.org/home/kde/trunk/KDE/kdebase
cd kdebase
cmakekde

=== Troubleshooting ===
If you have troubles compiling kdebase:
* Make sure you have the <tt>libxss headers</tt> installed. (Usually you got undefined references on xscreensaver objects if you do not have those headers)
* <tt>which meinproc</tt> has to deliver {{path|/home/kde-devel/kde/bin/meinproc}}
* if cmakekde can not find the path of kdepimlibs, edit the file {{path|$KDE_BUILD/KDE/kdebase/CMakeCache.txt}} and manually set <tt>KDEPIMLIBS_INCLUDE_DIR:PATH=$KDE_BUILD/kdepimlibs</tt>
* if you get an error saying "Please set the following variables: X11_XTest_LIB (ADVANCED)", install the devel package of <tt>Xtst</tt>. On some systems, this is packaged separately from <tt>xext</tt> and called <tt>x11proto-xext-dev</tt> or <tt>libxtst-dev</tt>. You may also need to remove the CMakeCache.txt file in the build dir after installing the package.
* the same for "X11_Xinerama_LIB (ADVANCED)" where you will need the devel package for <tt>xinerama</tt>.
* if you get an error complaining about a missing variable X11_Xrandr_LIB, you need the devel package for libxrandr (libxrandr-devel on ubuntu-systems)
* if you get the error "Please set the following variables: FONTCONFIG_INCLUDE_DIR, FONTCONFIG_LIBRARIES (ADVANCED)", then you need to install the libfontconfig headers
* if you get the error "CMake Error: This project requires some variables to be set, and cmake can not find them. Please set the following variables: KMETADATA_LIBRARIES", you need to install soprano from kdesupport and to rebuild kdelibs
* if you get the error "‘XserverRegion’ does not name a type" make sure you have libxcomposite headers installed (<tt>libxcomposite-dev</tt> in ubuntu)
* if you get the error "CMake Error: This project requires some variables to be set, and cmake can not find them. Please set the following variables: QT_QTOPENGL_LIBRARY (ADVANCED) ", try editing CMakeCache.txt and setting QT_QTOPENGL_LIBRARY:FILEPATH=/home/kde-devel/qt-copy/lib/libQtOpenGL.so

* if you get messages as "KDE4_INSTALL_HANDBOOK() is deprecated. Remove it please. Now all is done in KDE4_CREATE_HANDBOOK." then, either find the files containing the offending line and comment it out manually, or run the following script in ~/kde/src/KDE/kdebase: [http://www.plamadeala.com/files/macros_corrector.sh macros_corrector.sh]. It will just REMOVE the line that has "kde4_create_handbook" in it from all the found files.
*If you get an error (in ubuntu) concerning libxtst.so install the libxtst-dev package
* If you get the message "kdebase/workspace/kcontrol/kxkb/x11helper.cpp:131: error: ‘KGlobal’ has not been declared", you might need to install libxklavier development packages.
* If you get "/home/kde-devel/kde/lib/libkio.so: undefined reference to `Strigi::AnalysisResult::AnalysisResult(std::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, long, Strigi::IndexWriter&, Strigi::StreamAnalyzer&)'" you probably have an outdated version of strigi installed by your distro.

== Running KDE 4 programs ==

You can now run KDE 4 programs (e.g. kwrite) by typing:
ssh -X kde-devel@localhost
kwrite

=== Troubleshooting ===

* If you get
KUniqueApplication: Cannot find the D-Bus session server
check if you can access the display, e.g. type
xclock
and see if a clock appears on the screen.

* If you get something like
Error: standard icon theme "oxygen" not found!

ASSERT: "!isEmpty()" in file /home/kde-devel/qt-copy/include/QtCore/../../src/corelib/tools/qlist.h, line 245
Aborted (core dumped)
You need to install kdebase - see above. It is enough to install the "runtime" directory from kdebase.

== Generating local API documentation ==
Although the API documentation for KDE is available online at [http://api.kde.org api.kde.org], it is sometimes useful to have it on your own disk, for example when you want to use [[Getting_Started/Set_up_KDE_4_for_development#KDevelop|KDevelop]] for browsing the documentation or when you are not able to be online all the time.

Be aware that generating the API documentation can take several hours and takes almost half a gigabyte of diskspace.
The generation is handled by a script in {{path|kdelibs/doc/api}}, you need <tt>doxygen</tt> to be able to run it.

To build the API documentation for kdelibs, type the following:

cs KDE/kdelibs # [[Getting_Started/Increased_Productivity_in_KDE4_with_Scripts/.bashrc|'cs' is a bash function, click here to learn more]]
$KDE_SRC/KDE/kdelibs/doc/api/doxygen.sh \
--doxdatadir=$KDE_SRC/KDE/kdelibs/doc/common .

Repeat for other modules as desired.<br>
cd <module home>
$KDE_SRC/KDE/kdelibs/doc/api/doxygen.sh \
--doxdatadir=$KDE_SRC/KDE/kdelibs/doc/common .

Another, even easier method involves downloading this [[Doxyfile]] to your local system. Then simply change directory to where you want to create the documentation and run
<code bash>
% doxygen /path/to/Doxyfile
</code>
Then review the file {{path|doxygen.log}} to see the doxygen errors and warnings. You'll find the actual documentation in the {{path|apidocs}} subdirectory.

== Staying up to date ==

In order to keep the kde4 installation up to date, each of the modules installed should be updated periodically. As Monday is the day for big changes in kdelibs, Tuesday may be the best day to do this. For each module checked out, run <tt>svn up</tt> and <tt>make</tt>.

For example:
<code bash>
cs kdesupport # cs is not a typo
svn up
cb # cb is not a typo
make -j2 VERBOSE=1 && make install
</code>

Note: it is not necessary to run cmakekde for updates.

== Installing a subset of a module ==

Many modules in KDE contain a large number of programs which could take a long time to download and compile. In cases where you want to work only on a particular program or programs in a module, it is possible to download and compile particular folders. In some cases, certain folders are required for any build of the module. This is determined in the CMakeLists.txt file of the module. For example the [http://websvn.kde.org/trunk/KDE/kdegames/CMakeLists.txt?view=markup kdegames CMakeLists.txt file] lists:

<code>
add_subdirectory(libkdegames)
add_subdirectory(libkmahjongg)

macro_optional_add_subdirectory(doc)
macro_optional_add_subdirectory(lskat)
macro_optional_add_subdirectory(katomic)
</code>

So, the libkdegames and libkmahjongg directories are required to build any of kdegames. The cmake directory will also usually be required. All the other directories (doc, katomic etc) are optional. They will be built if present on your machine. In this example, we build kmahjongg and kbattleship:

<code bash>
cs KDE
svn co -N kdegames # The -N switch performs a non-recursive checkout
cd kdegames
svn up libkdegames # Get required directories
svn up libkmahjongg
svn up cmake
svn up kbattleship # Get optional directories
svn up kmahjongg
cmakekde
</code>

== General troubleshooting ==

What can happen over time, after some <tt>svn up</tt> commands, is that some of the tools used in the KDE build chain change their output format. For example, <tt>kcfg</tt> files are read by <tt>kconfig_compiler</tt> to produce configuration dialogs. CMake cannot detect those changes, and the compilation might fail. A workaround is to always force a re-generation of all such files:
find $KDE_SRC/KDE/kdebase -name "*.kcfg" | xargs touch
The same applies to <tt>ui</tt> files as produced by Qt designer.

=== Locked sessions ===
When installing KDE 4 as a user, one will not be able to unlock a locked session. To work around this issue you can either:
su
chown root.root $KDEDIR/lib/kde4/libexec/kcheckpass
or
chmod 755 $KDEDIR/lib/kde4/libexec/kcheckpass

== Success! ==

You are now ready to start building other svn modules in the same fashion as you built kdebase, running and testing KDE4 or writing your own patches and applications.

See the [[Getting Started/Set up KDE 4 for development|Set up KDE 4 for development]] tutorial for how to start KDE 4 applications and how to use KDevelop to work on them.

[[Category:Build KDE]]
[[Category:KDE4]]

Getting Started/Build/KDE4

2007-12-27T16:04:50Z

Fulldecent: /* Qt */ clean up wording

{{Template:I18n/Language Navigation Bar|Getting_Started/Build/KDE4}}

{{TutorialBrowser|

series=Getting Started|

name=Building KDE4 From Source|

pre=[[../../Sources/Anonymous_SVN|Anonymous SVN Quickstart Guide]]|

next=[[../../Set_up_KDE_4_for_development|Set up KDE 4 for development]]|

reading=[[../kdesvn-build|kdesvn-build: The KDE From Subversion Build Tool]]<br>[[../../Increased_Productivity_in_KDE4_with_Scripts|Increased Productivity in KDE4 with Scripts]]<br>[[Development/Tutorials/CMake |Introduction to CMake]]<br>[[../KDE4/FreeBSD|FreeBSD notes]]<br>[[../KDE4/Mac OS X|Instructions for Mac OS X]]<br>[[../KDE4/Windows|Instructions for MS Windows]]|
}}

== Abstract ==

This tutorial shows one way to get KDE from trunk running on Linux/BSD systems. There are also tutorials for [[Getting_Started/Build/KDE4/FreeBSD|FreeBSD]], [http://www.kdelibs.com/ Windows], [[Getting_Started/Build/KDE4/Mac OS X|Mac OS X]] and [http://solaris.kde.org/ Solaris]. Throughout the tutorial the bash shell is used.

{{warning|Expect a higher risk of build failure '''on Mondays''' when most kdelibs changes are committed. [http://developer.kde.org/~dirk/dashboard/ Dashboard] reports unexpected breakages. You are encouraged to fix failing modules.
}}

== Software Requirements ==

The following needs to be installed to successfully use this tutorial:
* gcc and g++, preferably version 4.2 or higher
* svn, the subversion revision control client
* pkg-config
* development libraries and headers for X11, OpenGL (mesa-common-dev and libglu1-mesa-dev), libjpeg, libpng, libungif, [http://clucene.sourceforge.net/index.php/Downloads libclucene], [http://download.librdf.org/source/ librdf], libxml2 and libxslt
* the <tt>makeobj</tt> script, which is included in kdesdk. You can install it from kdesdk (kdesdk-scripts on Debian) or similar packages, or download at [http://websvn.kde.org/*checkout*/trunk/KDE/kdesdk/scripts/makeobj WebSVN]
* the [http://freedesktop.org/wiki/Software/shared-mime-info shared-mime-info package], is the freedesktop MIME standard now used in KDE
* [http://boost.org/ boost], used by kdebase; after build and/or install, in order to make cmake aware about its location (FindBoost), add the boost directory (which contains the include subdirectory) to CMAKE_INCLUDE_PATH or set a environment variable called BOOST_ROOT that points to the boost directory.

=== Ark Linux ===
In Ark Linux, the build dependencies you need are installed with:

<code bash>
apt-get install devel-core libxml-devel libxslt-devel bzip2-devel \
clucene-core-devel librdf-devel shared-mime-info xorg-Mesa-libGL-devel \
subversion boost-devel doxygen giflib-devel dbus-devel openssl-devel \
alsa-lib-devel kdesdk-scripts qt4-devel
</code>

If you prefer a graphical interface, select the packages listed above in the "Install Software" tool in Mission Control.

This includes installation of CMake, DBus and Qt - you can skip steps 5, 6 and 7.

=== Arch Linux ===
In Arch Linux you need to install the following packages:

<code bash>
pacman -Sy subversion bzip2 libxslt libxml2 \
shared-mime-info mesa boost dbus openssl \
pkgconfig xine-lib clucene
</code>

If you want to use qt4 from the Arch Linux repository you can install it with:
<code bash>
pacman -Sy qt4
</code>

<s>For clucene libraries you need the [http://aur.archlinux.org/packages.php?do_Details=1&ID=5968 PKGBUILD] from AUR.</s>
(No longer needed since clucene has been put into the extra-repo.)

=== Fedora ===

Some of the required packages for building KDE4 on Fedora 7 or higher:

<code bash>
yum install clucene-core-devel libxml-devel libxslt-devel \
dbus-devel boost-devel bzip2-devel openssl-devel alsa-lib-devel \
redland-devel rasqal-devel raptor-devel hspell-devel aspell-devel \
cups-devel xine-lib-devel avahi-devel gamin-devel OpenEXR-devel \
enchant-devel jasper-devel ilmbase-devel pcre-devel gpgme-devel \
libxklavier-devel glib-devel libusb-devel libsmbclient-devel \
libxcb-devel NetworkManager-devel lm_sensors-devel libraw1394-devel \
bluez-libs-devel gcc-c++ libXext-devel cmake subversion giflib-devel \
libpng-devel libXdamage-devel libXcomposite-devel libXrender-devel \
fontconfig-devel libXft-devel libXcursor-devel libXfixes-devel \
ruby-devel libXScrnSaver-devel libkdcraw-devel exiv2-devel \
lcms-devel libtiff-devel sqlite-devel libxkbfile-devel \
imlib2-devel patch gstreamer-plugins-base-devel
</code>

Some optional packages for koffice support:
<code bash>
yum install qca2-devel gsl-devel freeglut-devel \
GraphicsMagick-c++-devel GraphicsMagick-devel
</code>

This includes installation of D-Bus and CMake -- you can skip steps 5 and 6.

DCH-10/15/07: Note - It may be simpler to spin RPMs. Note that you can edit the variables in /etc/rpm/macros.kde4 (which is provided by Rawhide kde-filesystem).

The build stage then looks like:
(but in what directory?)
%build

mkdir -p %{_target_platform}

pushd %{_target_platform}

%{cmake_kde4} ..

popd

make %{?_smp_mflags} -C %{_target_platform}

I have had better results with creating a kdesupport rpm which means that you should not install the soprano and strigi rpms. YMMV

telsh: On a Fedora 8 System I had to install "qt4-devel" too to have qmake.

=== Kubuntu and Debian ===

In Kubuntu 7.04 (Feisty) and Debian (Testing/Unstable) the build dependencies you need are installed with:
<code>
sudo aptitude install build-essential cdbs debhelper cmake \
libxml2-dev libxslt1-dev libbz2-dev libclucene-dev librdf-dev \
shared-mime-info libgl1-mesa-dev libglu1-mesa-dev mesa-common-dev \
libxext-dev libjpeg-dev libpng12-dev subversion libsm-dev libxinerama-dev \
libxrender-dev libfontconfig-dev libboost-dev libxcursor-dev doxygen \
libungif4-dev libdbus-1-dev libssl-dev libgpgme11-dev \
libasound2-dev kdesdk-scripts libpth-dev libjasper-dev \
ssh libxine-dev libqimageblitz-dev libqimageblitz4 libglib2.0-dev \
libxkbfile-dev libenchant-dev libbluetooth-dev network-manager-dev \
libsmbclient-dev libxcb1-dev libcaptury-dev libxcomposite-dev \
libxdamage-dev libusb-dev libgpgme11-dev libldap2-dev
</code>

In Kubuntu 7.10 (Gutsy) and Debian unstable you also have to add:
<code>
sudo aptitude install dbus-x11 libqt4-dev libqca2-dev libeigen-dev \
libstreamanalyzer-dev libsoprano-dev libstrigiqtdbusclient-dev \
libxklavier11-dev libxml2-utils libdbus-1-dev libxslt1-dev cmake libbz2-dev \
libungif4-dev libgpgme11-dev libboost-dev libxine-dev libxkbfile-dev
</code>

For a fully functional API documentation framework you also need:
<code>
sudo aptitude install graphviz
</code>

There is no need to compile qt or kdesupport on kubuntu gutsy. All required packages are provided by installing the above. Setup the kde4 user etc as explained in the next section, but skip over compiling qt, hal and kdesupport.

{{Note|
If you get something trouble on compile KDE4
Beta4 or above in Kubuntu 7.10, such as :

Soprano version is too low

strigi xxx.h not found...

You may need to checkout, and compile the relevant part of
kdesupport source code in the SVN server of KDE4. (svn://anonsvn.kde.org/home/kde/trunk/kdesupport/soprano/)

This is covered when you get to the section on compiling kdesupport.

You might also have to remove any installed soprano package : sudo apt-get remove libsoprano4 libsoprano-dev

If you still get an error in the kdelibs section about soprano like:
CMake Error: Error in cmake code at
$src/KDE/kdelibs/cmake/modules/FindSoprano.cmake:78:
FILE Internal CMake error when trying to open file: /usr/include/soprano/version.h for reading.

then delete kdelibs/CMakeCache.txt
}}

=== openSUSE ===

In openSUSE 10.2 and newer, you can install packages using [http://en.opensuse.org/Zypper Zypper]:
<code bash>
sudo zypper install <package-name>
</code>

In older releases of SUSE, you can use YaST:
<code bash>
su
yast -i <packagename>
</code>

'''Required Packages'''

The packages you will need to install are:
<code>
xorg-x11-devel
libxml2-devel
kdesdk3
clucene-core-devel
boost-devel
libjpeg-devel
liblrdf-devel
libpng-devel
libxslt-devel
libredland-devel
Mesa-devel
giflib-devel
subversion
gcc
gcc-c++
gmp-devel (needed to build kdesupport)
gpgme-devel (needed to build kdepimlibs)
libxine1-devel
</code>

'''Optional Packages'''

You can skip the manual and painful installation kdesupport and its dependencies ( Qt 4.3, CMake 2.4.6, DBus, Hal, clucene-core, Strigi,
Soprano and other Nepomuk dependencies) by adding the KDE:KDE4 repository from
the [http://download.opensuse.org/repositories/KDE:/KDE4/ openSUSE Build Service] to your installation sources.

For openSUSE 10.2 and newer do:
<code>
sudo zypper service-add http://software.opensuse.org/download/KDE:/KDE4/openSUSE_10.2 KDE4-102
</code>

For older versions of SUSE Linux do:
<code>
su
installation_sources -a http://software.opensuse.org/download/KDE:/KDE4/[YOUR SUSE LINUX VERSION]
</code>

Now install the following packages:
<code>
cmake
dbus-1-devel
libqt4-devel
libqca2-devel
libsoprano-devel
libqimageblitz-devel
strigi
strigi-ui
</code>

There are a lot more packages that are needed to satisfy the config-check, such as libusb-devel, bison etc., so look out for the config notifications and install accordingly. Please remember to skip any instructions that refer to kdesupport below. Start to compile with kdelibs.

And for fully functional apidox framework you also need:
<code>
graphviz
</code>

CMake binary packages for openSUSE are available from the KDE:KDE4 repository as well as from the [http://software.opensuse.org/download/devel:/tools:/building/ openSUSE build service].

=== Gentoo ===

==== Install by hand ====

You can use stable ebuilds just remember to sync your portage before you begin.

Remember: All commands are executed as root.

Required:

We need to allow the following keyword masked ebuilds.

<code bash>
echo 'dev-util/cmake' >> /etc/portage/package.keywords
echo 'dev-cpp/clucene' >> /etc/portage/package.keywords
</code>

Make sure you have set the berkdb USE flag for redland, otherwise nepomuk won't work.

<code bash>
echo 'dev-libs/redland berkdb' >> /etc/portage/package.use
echo 'x11-libs/qt accessibility' >> /etc/portage/package.use
</code>

These are the packages you will need to emerge, I included the update option into the emerge command so you will not re-emerge anything that you might already have installed.

<code bash>
emerge -avu 'sys-devel/gcc' \
'dev-util/subversion' \
'dev-util/pkgconfig' \
'x11-base/xorg-x11' \
'virtual/glut' \
'media-libs/mesa' \
'media-libs/jpeg' \
'media-libs/libpng' \
'media-libs/giflib' \
'dev-cpp/clucene' \
'dev-util/cppunit' \
'media-libs/liblrdf' \
'dev-libs/libxml2' \
'dev-libs/libxslt' \
'x11-misc/shared-mime-info' \
'dev-libs/boost' \
'dev-util/cmake' \
'dev-libs/redland' \
'sys-apps/dbus' \
'sys-apps/hal' \
'x11-libs/qt'
</code>

You will also need to emerge either 'kde-base/kdesdk' or kde-base/kdesdk-scripts'.

If you emerged DBUS, CMAKE, QT or HAL you may skip those sections respectively.
Good luck!

==== Install via portage ====

Also you can install the KDE 4 packages directly via
<code bash>
emerge -a <packagename>
</code>

To get the things you need, [http://gentoo-wiki.com/TIP_Overlays#Layman install layman] and then pull in the "kde" overlay (which contains experimental KDE ebuilds):
<code bash>
layman -a kde
</code>
After this you need to adjust some USE-flags for KDE 4 and tell portage to use the testing KDE 4 ebuilds instead of the stable KDE 3 ones.

That way portage will do the dependency tracking for you.

Detailed instructions on building KDE 4 in Gentoo via portage can be found in the [http://overlays.gentoo.org/proj/kde/wiki KDE overlay wiki]. They are discussed in the forum thread [http://forums.gentoo.org/viewtopic-t-530111-postdays-0-postorder-asc-start-0.html KDE 4 monolithic ebuilds], which is continued [http://forums.gentoo.org/viewtopic-p-4359581.html#4359581 here]

=== Mandriva ===
In Mandriva the build dependencies you need are installed with:

<code bash>
urpmi gcc-c++ cmake libxml2-devel libbzip2_1-devel \
libclucene0-devel liblrdf2-devel libmesagl1-devel \
subversion doxygen libdbus-1_3-devel libopenssl0.9.8-devel \
libalsa2-devel libgpgme-devel libboost1-devel libxine-devel
</code>

If you're running 64-bit environment you should replace all packages starting with "lib..." to "lib64...".

If you prefer a graphical interface, select the packages listed above in the "Install Software" tool in Mandriva Linux Control Center.

This includes installation of CMake, DBus - you can skip steps 5 and 6.

== Create a user account for KDE4 development ==

{{Note|
Some people like to have a separate user account for KDE 4 (for instance an old bug deleted files by mistake), and the instructions below were written with that approach.

However it is much more efficient to do everything with a single user account, see [[Getting_Started/Increased_Productivity_in_KDE4_with_Scripts|Increased Productivity in KDE4 with Scripts]]
for more details.

You can still follow the instructions below, but don't put the environment variables in your <tt>.bashrc</tt>, put them in a separate file that you source to switch to the KDE 4 environment.
}}

=== Option 1: Command Line ===
<code bash>
useradd -m kde-devel
passwd kde-devel
</code>

{{Warning|
The new kde-devel user will not be added automatically to all the user groups, which will result in not having sound, not being able to sudo, etc. Edit your /etc/groups file to add the kde-devel user to all the groups that you need (probably the groups that your usual username is already assigned to).
}}

=== Option 2: Using KControl ===

Instead of using the commands above, you can also use the User module in the KDE Control Center if you already have KDE3 installed.

=== Setting up the environment ===

Copy the {{path|~/.bashrc}} from your normal user account to the new kde-devel account. Next, copy and paste the contents of the [[Getting Started/Increased Productivity in KDE4 with Scripts/.bashrc|example .bashrc]] into {{path|~kde-devel/.bashrc}}. Be sure to comment out the line <tt>alias make=makeobj</tt> if you do not have the <tt>[[Getting Started/Build/KDE4#Required Software|makeobj]]</tt> command available. You will probably also want to modify the path to make sure it doesn't include your kde3 paths. Also if you want to use KDevelop to develop KDE 4 applications you may pass the ''-GKDevelop3'' flag to the ''cmake'' command (to make CMake generate KDevelop project files, it will help to avoid rebuilding in the future, see [[Getting_Started/Set_up_KDE_4_for_development#Setting_up_the_environment|this]]).
To make it run, you have to open a new bash or to execute
<code bash>
source ~/.bashrc
</code>

This will provide access to commands such as <tt>cmakekde</tt> that are used in this tutorial as well as ensure that the proper paths are in place for Qt, KDE and CMake binaries.

For more information, please read the [[Getting Started/Increased Productivity in KDE4 with Scripts]] tutorial.

=== Switching to the New User ===
Switch to the user kde-devel: (don't forget the dash)
<code bash>
ssh -X kde-devel@localhost
</code>

{{Note|
If the ssh command fails, check out the [[Getting_Started/Set_up_KDE_4_for_development#Launching_KDE_4_apps|Launching KDE 4 apps]] section of the [[Getting_Started/Set_up_KDE_4_for_development|KDE4 development guide]].
}}

== The development user's shell ==

On some systems a new user is configured by default to use {{path|/bin/sh}}. If this is not the case on your system, you can skip this section. Using {{path|/bin/sh}} can be very inconvenient to work with and you may want to change it to {{path|/bin/bash}} or another shell.
On Ark Linux and Fedora, you can skip this step - {{path|/bin/sh}} is {{path|bash}}.

=== Option 1: As the kde-devel user ===

If you don't have root privileges and your system supports the changing of your own shell with the <tt>chsh</tt> application, then you could try to change your shell to {{path|/bin/bash}} by using:
<code bash>
chsh -s /bin/bash kde-devel
</code>

=== Option 2: As the root user ===

If your system comes with the <tt>usermod</tt> application you can run the following command as root: <tt>usermod -s /bin/bash</tt>.

Another option is to use the <tt>vipw</tt> application as root to safely edit your {{path|/etc/passwd}}. Locate 'kde-devel' in the the file. Change '{{path|/bin/sh}}' at the end of the line to read '{{path|/bin/bash}}', save your changes and exit.

The new shell will be started automatically when you log in as the kde-devel user again.

== D-Bus ==
QtDBus and KDE are known to work with D-Bus versions 0.62, as well as 0.92 and upwards. Versions 0.60 and 0.61 may work too but are not tested. Versions 0.90 and 0.91 are known not to work. We recommend using post-1.0 release versions (at least 0.94), so consider upgrading if you haven't done so.

You may skip this section if you have a recent D-Bus version or if you don't want to upgrade. You probably want to skip building the bindings until/unless you know you will be building HAL (see below).

Before running these steps in the recipe, make sure your X11 headers and libraries are available. The configure script run on line 5 of the following instructions should output:
Building X11 code: yes

=== The Recipe ===

{{tip|Make sure you did set up your environment correctly as described [[Getting_Started/Build/KDE4#Setting_up_the_environment|above]]. This is necessary for the <tt>cs</tt> and <tt>cb</tt> functions to work.}}

cs # [[Getting_Started/Increased_Productivity_in_KDE4_with_Scripts/.bashrc|'cs' is a bash function, click here to learn more]]
wget http://dbus.freedesktop.org/releases/dbus/dbus-1.0.2.tar.gz
tar -xvzf dbus-1.0.2.tar.gz
cd dbus-1.0.2/
./configure --prefix=$DBUSDIR --localstatedir=/var
make
sudo make install
sudo dbus-uuidgen --ensure

cs # see above
wget http://dbus.freedesktop.org/releases/dbus-glib/dbus-glib-0.74.tar.gz
tar -xvzf dbus-glib-0.74.tar.gz
cd dbus-glib-0.74/
./configure --prefix=$DBUSDIR
make
sudo make install
cd
sudo chown -R kde-devel:kde-devel *

=== What's Happening ===
After changing into the source directory (line 1), D-Bus source code is downloaded from freedesktop.org (line 2) and unpacked (line 3). After going into the newly created D-Bus directory (line 4), the build is set up using the supplied {{path|configure}} script (line 5). After building (line 6) and installing (line 7) D-Bus, we use the <tt>dbus-uuidgen</tt> tool to install a machine identification file that allows the bus to start automatically when the desktop session starts (line 8).

Note that you need write access to {{path|/var}} for the last two steps. If your system does not have the sudo command, you can use the <tt>su</tt> command instead, e.g. <tt>su -c "make install"</tt>.

The steps for building the glib bindings are similar to the above.

When these two packages are done building, we must fix the file ownership because 'sudo make install' has created root owned files and directories in ~kde-devel/kde.

== CMake ==
Skip this if you have [http://cmake.org/ CMake] >=2.4.5 installed.
You should be able to directly use the binary packages available on the [http://www.cmake.org/HTML/Download.html CMake site]. There are also distribution specific packages available.

=== The Recipe ===


cs # [[Getting_Started/Increased_Productivity_in_KDE4_with_Scripts/.bashrc|'cs' is a bash function, click Here to learn more]]
wget http://www.cmake.org/files/v2.4/cmake-2.4.6.tar.gz
tar -zxf cmake-2.4.6.tar.gz
mkdir cmake-build
cd cmake-build
../cmake-2.4.6/bootstrap
make
sudo make install

=== What's Happening ===
First, we go back to the <tt>kde-devel</tt> user's source directory (line 1), get the CMake sources (line 2) and unpack them (line 3). We create a directory to build CMake in (line 4) and go into it (line 5). We then run the CMake bootstrap script to set up the CMake build (line 6), then make (line 7) and install it (line 8) using the root user.

If your system does not have the <tt>sudo</tt> command, you can instead do <tt>su -c "make install"</tt>.

== Qt ==
Next we need to get Qt4. KDE is guaranteed to build against any Qt 4.3. Qt 4.2 and earlier are not supported and will not work.

If your distribution has a recent version of Qt4, that should work. Most distros backport bugfixes, and some distros, like Debian or openSUSE, even use the patches from KDE svn. In other cases, using the recipe below will give you a more stable Qt than your distro. Refer to the distribution specific sections above for more information.

As for now Qt3 compatibility layer in Qt 4 is mandatory, so please <b>avoid</b> using "-no-qt3support" option when building Qt4 from sources.

=== The Recipe ===
cd # Note: qt-copy lives in $HOME/qt-copy. See $QTDIR in [[Getting_Started/Increased_Productivity_in_KDE4_with_Scripts/.bashrc|<font color=red>.bashrc</font>]]
svn checkout svn://anonsvn.kde.org/home/kde/trunk/qt-copy
cd qt-copy
./apply_patches
./configure -qt-gif -no-exceptions -debug -fast \
-prefix $QTDIR -nomake examples -nomake demos
make -j2

# if we don't install, we'll just clear obj files to
# save disk space
if [ $QTDIR = `pwd` ]; then \
find . -name '*.o' -delete ; \
else make install; fi;

=== What's Happening ===
We switch back to the <tt>kde-devel</tt> user's home directory (line 1) and download the source code using subversion (svn) from KDE's repository (line 2). After changing into the resulting {{path|qt-copy}} directory (line 3), we run a script that manages the patches that come with <tt>qt-copy</tt> (line 4).

Once the patches have been applied, we then set up the build using the <tt>configure</tt> script (line 5-6). The various command line options used are explained in the {{path|qt-copy/README.qt-copy}} file. Finally, we build the minimal requirements for KDE (line 7) and install (line 10) Qt. If install dir is the same as the current dir (line 8), then we just free some space (line 9) instead. If you want all the example and demo applications, you can either build them individually or simply do a <tt>make</tt> from the {{path|qt-copy}} directory.

Note that the installation does not require root as it installs Qt locally into {{path|$QTDIR}}. Anyway, installation is only needed if {{path|$QTDIR}} differs from {{path|$HOME/qt-copy}}, which is not the case if you have exactly followed the instructions.

=== Troubleshooting ===
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}}. '''Note:''' You may need to run <tt>xhost +local:kde-devel</tt> as your regular kde3 user to run this application. If it crashes in QSpanData::adjustSpanMethods, then your problem is the oxygen style. Try removing {{path|lib/kde4/plugins/styles/kstyle-oxygen.so}} and {{path|lib/kde4/plugins/styles/oxygen.so}} if they exist in the KDE install prefix.

== HAL ==

{{tip|You can use qdbusviewer to see if you have org.freedesktop.hal. If not, you might need a newer version of hal. If you have org.freedesktop.hal, you probably don't need to, and don't ''want'' to, roll your own HAL.}}

If your system requires you to build a newer version of HAL, there's a decent chance you'll need to build other stuff as well, some of which may not be straight forward. Since this should only be required for older distros, instructions are on [[Getting_Started/Build/HAL| a separate page]].

== kdesupport ==

{{warning|Don't forget to read the [[Getting_Started/Build/KDE4#Setting_up_the_environment|Setting Up The Environment]] section first.}}

There are several libraries that KDE applications rely on in the kdesupport module. This includes Strigi and Soprano for file metadata and search, QImageBlitz for image manipulation needed in kdebase, eigen for visual effects in applications such as Kalzium, taglib for music players and qca for some cryptographic needs.

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.

Please remember that if you use openSUSE, you can install the needed packages from the KDE:KDE4 buildservice repository and do not have to bother with fiddling the details below. Skip to the kdelibs section.

=== The Recipe ===

cs # [[Getting_Started/Increased_Productivity_in_KDE4_with_Scripts/.bashrc|'cs' is a bash function, click here to learn more]]
svn checkout svn://anonsvn.kde.org/home/kde/trunk/kdesupport/
cd kdesupport
cmakekde

=== What's Happening ===
We change to the base source directory (line 1). We download the sources in kdesupport using subversion (line 2), go into the new {{path|~/kde/src/kdesupport}} directory (line 3), and commence the build (line 4). This will leave us in the kdesupport build directory after the build is completed.

=== Troubleshooting ===
If you get
cmakekde: command not found
then you have to go manually into the kdesupport directory in ~ and execute the command cmakekde. if this still doesn't work, then something is wrong with your bashrc.

If you get
CMake Error: This project requires some variables to be set,
and cmake can not find them.
Please set the following variables:
LIBXML2_INCLUDE_DIR (ADVANCED)
you should install the development package for libxml2.

If you get
CMake Error: Could NOT find REDLAND
then you need librdf from the Redland.
If your distribution does not provide the librdf package, you can download the source there: [http://download.librdf.org/source/ http://download.librdf.org/source/] and build it.
(Gentoo users: The ebuild for librdf is named dev-libs/redland)

If you get
Fetching external item into 'kdesupport/admin'
Error validating server certificate for 'https://...'
see [http://techbase.kde.org/Getting_Started/Sources/Using_Subversion_with_KDE Using Subversion with KDE]

If you get
FILE cannot create directory: /usr/lib[64]/qt4/plugins/crypto. Maybe need administrative privileges.

make: *** [install] Error 255
take a second look in the .bashrc file described above, are paths correct? ($QTDIR and $PATH are used to get the QT installation path)
Alternatively, you may see this error if you decided to use a distribution installed version of qt4 and skipped the Qt install above. Either install qt-copy as describe above, or "sudo make install". If you use "sudo make install", make sure that you change the ownership back to your user for some of the ~/kde subdirectories that were effected by using sudo (ie. "<tt>sudo chown -R kde-devel:kde-devel ~/kde</tt>").

If you get a message related to
target libQtTest.so not found
you may need to recompile qt-copy. This time you should take out
-nomake demos -nomake examples
from the configure command, so that Qt generates library QtTest.

== kdelibs ==

We can now move on to building KDE's base libraries.

=== The Recipe ===
cd
cs # [[Getting_Started/Increased_Productivity_in_KDE4_with_Scripts/.bashrc|'cs' is a bash function, click here to learn more]]
mkdir KDE && cd KDE
svn checkout svn://anonsvn.kde.org/home/kde/trunk/KDE/kdelibs
cd kdelibs
cmakekde

=== What's Happening ===
We change to the base source directory (line 1) then make and go into the KDE directory (line 2). We download the sources for kdelibs using subversion (line 3), go into the new {{path|~/kde/src/KDE/kdelibs}} directory (line 4), and commence the build (line 5). This will leave us in the <tt>kdelibs</tt> build directory after the build is completed.

{{tip|There might be missing dependencies on your system! They are easily overlooked in the output of <tt>cmakekde</tt>.
You might want to do a <tt>cmake $KDE_SRC/KDE/MODULE_NAME</tt> prior to compiling any kde modules (like kdelibs, kdepimlibs etc.)}}

=== Additional KDE-specific CMake modules ===
There are additional CMake modules in {{path|kdelibs/cmake/modules/}} that are necessary for building KDE4 applications. These will be installed for you when kdelibs itself is installed.

=== Troubleshooting ===
If you have problems compiling kdelibs, first make sure the software in the [[Getting_Started/Build/KDE4#Software_Requirements|Required Software]] section above is installed and works. Other possible hints include:
* If the <tt>cmakekde</tt> command fails stating that CMake requires an out of source build directory, remove {{path|~/kde/src/KDE/kdelibs/CMakeCache.txt}}, and try again.

If <tt>cmakekde</tt> still gives the same error then try this
cd
cmake -DCMAKE_INSTALL_PREFIX=$KDEDIR \
-DCMAKE_BUILD_TYPE=debugfull \
-DKDE4_BUILD_TESTS=ON \
~/kde/src/KDE/kdelibs
make
make install
* If you received an error stating "Please create a separate build directory and run 'cmake path_to_kdelibs [options]' there.", then you need to change to your build directory before running cmakekde. (e.g <tt>cs KDE/kdelibs && cb && cmakekde</tt>) If the message stays, run 'svn status' in the kdelibs directory and remove all files labeled with '?'.
* If Qt wasn't found or the wrong version of Qt was found, make sure that the qmake from the Qt you need is the first qmake in the path.
* If qmake wasn't found and you are using Debian packages, /usr/bin/qmake probably points to a wrong qmake version. To fix this run as root:
update-alternatives --config qmake
* If the problems persist, try the CMake make-option <tt>--keep-going</tt>.
* Here you need the libungif library, otherwise you will get an error message like "<tt>Could NOT find GIF</tt>".
* Qt-4.3 upgrade: if you get a link error in kjsembed talking about QScriptEngine, edit CMakeCache.txt in kdelibs and remove the lines that talk about QT_QTUITOOLS_LIBRARY, then type make again (that static library has a new dependency, and the cmake code that adds it needs to run).
* if you get <code>CMake Error: KDE Requires Qt to be built with SSL support
</code>, install openssl-devel, remove CMakeCache.txt and re-compile QT.
* if you get <code>kdelibs/kimgio/ico.cpp:188: undefined reference to `QImage::jumpTable()'</code> it means you compiled QT without QT3 support(no, linking to a true QT3 install won't work)
* if none of the errors above match yours, you might just try a quick'n'dirty <code>make clean</code> in kdelibs.

== kdepimlibs ==
After <tt>kdelibs</tt>, but before ''kdebase'', you need to build and install ''kdepimlibs''.

=== The Recipe ===

cs KDE # [[Getting_Started/Increased_Productivity_in_KDE4_with_Scripts/.bashrc|'cs' is a bash function, click here to learn more]]
svn checkout svn://anonsvn.kde.org/home/kde/trunk/KDE/kdepimlibs
cd kdepimlibs
cmakekde

=== What's Happening ===
We go into the KDE source directory (line 1), download the source code for kdepimlibs using subversion (line 2) and then go into the new {{path|~/kde/src/KDE/kdepimlibs}} directory (line 3). We then commence the build (line 4). This will leave us in the <tt>kdepimlibs</tt> build directory after the build is completed.

=== Troubleshooting ===
If you have trouble compiling kdepimlibs:
* the cmakekde command may require a later version of the gpgme library. This is available from the project's web site: http://www.gnupg.org/(en)/download/index.html - please note that the build of gpgme also requires libgpg-error, also available from the same location. Both libraries are installed by the "./configure", "make" and "sudo make install" sequence, with the gpgme library configured with the additional "--with-gpg-error-prefix" parameter. You may need to overwrite your existing "/usr/bin/gpgme-config" file with the newer version for the kdepimlibs to pick up the new install.

== kdebase ==
kdebase is divided into three parts:
* '''apps'''
:This contains applications like Dolphin or KWrite.
* '''runtime'''
:This contains things needed by every application at runtime, like icons. It is a required dependency for each KDE application, so you have to compile and install this.
* '''workspace'''
:This contains things specific to the KDE desktop, like Plasma or the window manager. Most stuff here depends on X11. You only need it if you want to build a full KDE desktop.

You can build all of kdebase at once, which is described in the recipe below. If you only want to build kdebase-runtime, which is the only requirement, you can replace <code bash>cd kdebase</code> with <code bash>cd kdebase/runtime</code> in the recipe below.

=== The Recipe ===

cs KDE # [[Getting_Started/Increased_Productivity_in_KDE4_with_Scripts/.bashrc|'cs' is a bash function, click here to learn more]]
svn checkout svn://anonsvn.kde.org/home/kde/trunk/KDE/kdebase
cd kdebase
cmakekde

=== Troubleshooting ===
If you have troubles compiling kdebase:
* Make sure you have the <tt>libxss headers</tt> installed. (Usually you got undefined references on xscreensaver objects if you do not have those headers)
* <tt>which meinproc</tt> has to deliver {{path|/home/kde-devel/kde/bin/meinproc}}
* if cmakekde can not find the path of kdepimlibs, edit the file {{path|$KDE_BUILD/KDE/kdebase/CMakeCache.txt}} and manually set <tt>KDEPIMLIBS_INCLUDE_DIR:PATH=$KDE_BUILD/kdepimlibs</tt>
* if you get an error saying "Please set the following variables: X11_XTest_LIB (ADVANCED)", install the devel package of <tt>Xtst</tt>. On some systems, this is packaged separately from <tt>xext</tt> and called <tt>x11proto-xext-dev</tt> or <tt>libxtst-dev</tt>. You may also need to remove the CMakeCache.txt file in the build dir after installing the package.
* the same for "X11_Xinerama_LIB (ADVANCED)" where you will need the devel package for <tt>xinerama</tt>.
* if you get an error complaining about a missing variable X11_Xrandr_LIB, you need the devel package for libxrandr (libxrandr-devel on ubuntu-systems)
* if you get the error "Please set the following variables: FONTCONFIG_INCLUDE_DIR, FONTCONFIG_LIBRARIES (ADVANCED)", then you need to install the libfontconfig headers
* if you get the error "CMake Error: This project requires some variables to be set, and cmake can not find them. Please set the following variables: KMETADATA_LIBRARIES", you need to install soprano from kdesupport and to rebuild kdelibs
* if you get the error "‘XserverRegion’ does not name a type" make sure you have libxcomposite headers installed (<tt>libxcomposite-dev</tt> in ubuntu)
* if you get the error "CMake Error: This project requires some variables to be set, and cmake can not find them. Please set the following variables: QT_QTOPENGL_LIBRARY (ADVANCED) ", try editing CMakeCache.txt and setting QT_QTOPENGL_LIBRARY:FILEPATH=/home/kde-devel/qt-copy/lib/libQtOpenGL.so

* if you get messages as "KDE4_INSTALL_HANDBOOK() is deprecated. Remove it please. Now all is done in KDE4_CREATE_HANDBOOK." then, either find the files containing the offending line and comment it out manually, or run the following script in ~/kde/src/KDE/kdebase: [http://www.plamadeala.com/files/macros_corrector.sh macros_corrector.sh]. It will just REMOVE the line that has "kde4_create_handbook" in it from all the found files.
*If you get an error (in ubuntu) concerning libxtst.so install the libxtst-dev package
* If you get the message "kdebase/workspace/kcontrol/kxkb/x11helper.cpp:131: error: ‘KGlobal’ has not been declared", you might need to install libxklavier development packages.
* If you get "/home/kde-devel/kde/lib/libkio.so: undefined reference to `Strigi::AnalysisResult::AnalysisResult(std::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, long, Strigi::IndexWriter&, Strigi::StreamAnalyzer&)'" you probably have an outdated version of strigi installed by your distro.

== Running KDE 4 programs ==

You can now run KDE 4 programs (e.g. kwrite) by typing:
ssh -X kde-devel@localhost
kwrite

=== Troubleshooting ===

* If you get
KUniqueApplication: Cannot find the D-Bus session server
check if you can access the display, e.g. type
xclock
and see if a clock appears on the screen.

* If you get something like
Error: standard icon theme "oxygen" not found!

ASSERT: "!isEmpty()" in file /home/kde-devel/qt-copy/include/QtCore/../../src/corelib/tools/qlist.h, line 245
Aborted (core dumped)
You need to install kdebase - see above. It is enough to install the "runtime" directory from kdebase.

== Generating local API documentation ==
Although the API documentation for KDE is available online at [http://api.kde.org api.kde.org], it is sometimes useful to have it on your own disk, for example when you want to use [[Getting_Started/Set_up_KDE_4_for_development#KDevelop|KDevelop]] for browsing the documentation or when you are not able to be online all the time.

Be aware that generating the API documentation can take several hours and takes almost half a gigabyte of diskspace.
The generation is handled by a script in {{path|kdelibs/doc/api}}, you need <tt>doxygen</tt> to be able to run it.

To build the API documentation for kdelibs, type the following:

cs KDE/kdelibs # [[Getting_Started/Increased_Productivity_in_KDE4_with_Scripts/.bashrc|'cs' is a bash function, click here to learn more]]
$KDE_SRC/KDE/kdelibs/doc/api/doxygen.sh \
--doxdatadir=$KDE_SRC/KDE/kdelibs/doc/common .

Repeat for other modules as desired.<br>
cd <module home>
$KDE_SRC/KDE/kdelibs/doc/api/doxygen.sh \
--doxdatadir=$KDE_SRC/KDE/kdelibs/doc/common .

Another, even easier method involves downloading this [[Doxyfile]] to your local system. Then simply change directory to where you want to create the documentation and run
<code bash>
% doxygen /path/to/Doxyfile
</code>
Then review the file {{path|doxygen.log}} to see the doxygen errors and warnings. You'll find the actual documentation in the {{path|apidocs}} subdirectory.

== Staying up to date ==

In order to keep the kde4 installation up to date, each of the modules installed should be updated periodically. As Monday is the day for big changes in kdelibs, Tuesday may be the best day to do this. For each module checked out, run <tt>svn up</tt> and <tt>make</tt>.

For example:
<code bash>
cs kdesupport # cs is not a typo
svn up
cb # cb is not a typo
make -j2 VERBOSE=1 && make install
</code>

== Installing a subset of a module ==

Many modules in KDE contain a large number of programs which could take a long time to download and compile. In cases where you want to work only on a particular program or programs in a module, it is possible to download and compile particular folders. In some cases, certain folders are required for any build of the module. This is determined in the CMakeLists.txt file of the module. For example the [http://websvn.kde.org/trunk/KDE/kdegames/CMakeLists.txt?view=markup kdegames CMakeLists.txt file] lists:

<code>
add_subdirectory(libkdegames)
add_subdirectory(libkmahjongg)

macro_optional_add_subdirectory(doc)
macro_optional_add_subdirectory(lskat)
macro_optional_add_subdirectory(katomic)
</code>

So, the libkdegames and libkmahjongg directories are required to build any of kdegames. The cmake directory will also usually be required. All the other directories (doc, katomic etc) are optional. They will be built if present on your machine. In this example, we build kmahjongg and kbattleship:

<code bash>
cs KDE
svn co -N kdegames # The -N switch performs a non-recursive checkout
cd kdegames
svn up libkdegames # Get required directories
svn up libkmahjongg
svn up cmake
svn up kbattleship # Get optional directories
svn up kmahjongg
cmakekde
</code>

== General troubleshooting ==

What can happen over time, after some <tt>svn up</tt> commands, is that some of the tools used in the KDE build chain change their output format. For example, <tt>kcfg</tt> files are read by <tt>kconfig_compiler</tt> to produce configuration dialogs. CMake cannot detect those changes, and the compilation might fail. A workaround is to always force a re-generation of all such files:
find $KDE_SRC/KDE/kdebase -name "*.kcfg" | xargs touch
The same applies to <tt>ui</tt> files as produced by Qt designer.

=== Locked sessions ===
When installing KDE 4 as a user, one will not be able to unlock a locked session. To work around this issue you can either:
su
chown root.root $KDEDIR/lib/kde4/libexec/kcheckpass
or
chmod 755 $KDEDIR/lib/kde4/libexec/kcheckpass

== Success! ==

You are now ready to start building other svn modules in the same fashion as you built kdebase, running and testing KDE4 or writing your own patches and applications.

See the [[Getting Started/Set up KDE 4 for development|Set up KDE 4 for development]] tutorial for how to start KDE 4 applications and how to use KDevelop to work on them.

[[Category:Build KDE]]
[[Category:KDE4]]

Talk:Installing third party softwares in terminal/Build/KDE4

2007-12-27T14:27:17Z

Fulldecent: /* Notes: ~/install */

==== This article is fat ====

When I first wrote this article, it was lean and mean and simple to understand. And it was good for all distributions. Now I have the impression of a fat pig when I read this article. I pledge for removing the usual sources of error, e.g. the many subdirectories. Why do we need a directory KDE, for example ?
If a tutorial is not simple, it is not done.

--[[User:Tstaerk|Tstaerk]] 14:23, 9 September 2007 (CEST)

:+1. A cleanup would be nice, especially before the official 4.0.0 release! Volunteers needed who do this. --[[User:Dhaumann|Dhaumann]] 22:52, 9 September 2007 (CEST)

:This tutorial is fine by me. Okay, that's not for newbies, but someone who wants to compile KDE4 RC1 needs to know how to follow this tutorial at least. --[[User:Chackal_sjc|Chackal_sjc]] 06:56, 27 November 2007 (CEST)

==== This article is full of errors ====

For example it *is* nessecary to install qt-copy, even if you keep it in the source directory (which leads to 394583069845 error messages on the console during the install). And kdelibs won't build unless something unknown is done with strigi - if it is installed into KDEDIR, it isn't just found.

the heading says pre-requirments are to read "Anonymous SVN Quickstart Guide" first. but the things it does are mostly done in this guide(but a little differently). for example the "Anonymous SVN Quickstart Guide" has you just svn a bunch of stuff.... but that all ended up in the wrong place cause in this guide the svn'd stuff needed to go to "kde-devl"-user's dir not the normal user dir..

:This tutorial clearly states: "The rest of this tutorial assumes you are running as the kde-devel user." -[[User:TMG|TMG]] 14:16, 25 June 2007 (CEST)

==== This article is complicated ====
when I wrote this article, it was lean and simple. It has been improved somewhere, but on most places worsened. An example is the directory structure (to get to qt-copy: cd && cd qt-copy; to get to kdelibs: cs && cd kdelibs; to get to kdepim: cs && cd KDE && cd kdepim - no one understands this!!!).
Another example is cs and cb which is quite unnecessary as my initial article shows. But of course, with the complexity as the article has NOW, it IS necessary.

Why do you spoil a simple article so that even I no longer find my own subdirs ?
--[[User:Tstaerk|Tstaerk]] 10:25, 28 May 2007 (CEST)

: Where do you see "cs && cd KDE && cd kdepim"? Because I don't see that anywhere. In any case it would just be "cs kdepim". Perhaps that's the bit need explaining a bit better? --[[User:Aseigo|Aseigo]] 02:48, 29 May 2007 (CEST)

:To whom are you talking to? ;) There are many contributors and as it's a wiki an article probably "degenerates" automatically if noone has an eye on it. The article certainly has valuable information and simply needs a cleanup. In other words: Fix it! :) --[[User:Dhaumann|Dhaumann]] 12:20, 28 May 2007 (CEST)

::IMHO all of this cs/cb/cmakekde and such is only confusing, users just do copy&paste with no really knowledge of what's going on when they type those commands. This way troubleshooting is quite difficult, and they learn nothing about the '''real''' compiling way. The concept of source/build dirs is barely noted. The ''old'' http://developer.kde.org/build/trunk.html has some more commands to type, but it was quite more understandable and clear about the '''real''' steps to do. --[[user:Pino|pino]] 12:54, 28 May 2007 (CEST)

::: Yes, this article could go back to being more verbose. I suppose what is missing is an explanation of ''why'' the shortcuts are used. They are there for a reason. I also don't get the differentiation between real and not real steps; unless we now consider using the shell for what it was designed for as not real. --[[User:Aseigo|Aseigo]] 02:48, 29 May 2007 (CEST)

:::: What's wrong in explicitely telling:
<pre>
svn co .../kdelibs
mkdir build-kdelibs
cd build-kdelibs
cmake <options> ../kdelibs
make install
</pre>
:::: After all, we did that with the <tt>./configure && make && make install</tt> sequence in KDE 3 times, and that worked quite fine. I still fail why we have to make our things more complicated. Moreover, these macros force fixed paths -- [[user:Pino|pino]] 23:43, 29 May 2007 (CEST)

:I am also for removing cb and cs, somebody should just do it. They are indeed confusing and sometimes don't work as expected (that is why cd $KDE_SRC is needed in one place). cmakekde on the other hand could stay IMHO. -[[User:TMG|TMG]] 14:16, 25 June 2007 (CEST)

==== Q: What is cs and cb? ====

A: '''This is not a typo'''. Read the [http://techbase.kde.org/index.php?title=Getting_Started/Increased_Productivity_in_KDE4_with_Scripts/.bashrc article about setting up your .bashrc]. Both '''cs''' and '''cb''' are bash functions, used to change to the KDE source directory and KDE build directory respectively.

==== Q: Are there build instructions for other OS? ====

A: Actually '''yes''', for [[Getting Started/Build/KDE4/Mac OS X|Mac OS X]]. There also is [http://www.kdelibs.com kdelibs.com] (see also [[User_talk:Jstaniek#KDElibs.com_and_developernew.kde.org_coexistence|here]]) which will be merged into this wiki in the future.

==== Q: Isn't the install prefix, make and make install missing for modules like kdelibs and kdebase? ====
A: No. The shell function ''cmakekde'' handles this, have a look at the file [[Getting_Started/Increased_Productivity_in_KDE4_with_Scripts/.bashrc|.bashrc]].

==== Q: I changed the first command of the "Set up QT - Recipe" from cd to cs because I think this was a typo. Am I right?? ====
A: Right --[[User:Dhaumann|Dhaumann]]

:: no, it was perfectly intentional. see the [[Getting_Started/Increased_Productivity_in_KDE4_with_Scripts/.bashrc|bashrc in the productivity with KDE4 scripts tutorial]]. it has QTDIR set to ~/qt-copy. this makes sense, actually, since building Qt is done rather differently from the rest of KDE and one may not get Qt from KDE's svn in any case. so yes, it is supposed to be cd, not cs.

::: *blush* ;) i should read more carefully. --[[User:Dhaumann|Dhaumann]]

==== Notes: ~/install ====

When installing KDE4, I strongly recommend installing all tools (like dbus and cmake) and kde packages into the same place, e.g. ~/install. Qt is the only exception.

The reason for this is because if you install some packages to ~/kde and some to /usr/local and maybe one in /usr then cmake will generate errors like:

-- It is impossible to order the include directories.

This is not a fatal error, so you will still be able to compile, but you will possibly be using the wrong versions of libraries and this will product problems that are very hard to diagnose.

You may not experience any problems when installed like I advise not to, however I have and you might too in some typical situations.

==== Install CMake modules local ====

The CMake modules should be installed local into ~/install/cmake/modules or similar.
When following the current instructions [[ Getting_Started/Build/KDE4#Install_additional_CMake_modules|6.1: Install additional CMake modules]], it's impossible to do a non-root installation, because "kdelibs/cmake/modules/cmake_install.cmake" wants to install the modules to "/cmake/modules". (I didn't install CMake local, because my system already provided CMake > 2.4.3).

I've already tried to do this, fiddling around with CMAKE_MODULE_PATH and DATA_INSTALL_DIR but couldn't get it working.

Does anybody know how to do this properly?

--[[User:Eliasp|Eliasp]] 15:44, 4 January 2007 (CET)

==== Fixes needed ====
* qt-copy: Should we pass the -debug flag? Doesn't Qt install debug information separately by default anyways? Or is that just in the snapshot? --[[User:Mpyne|Mpyne]]

: according to ./configure --help, the default is -release in snapshot. --[[User:Aseigo|Aseigo]] 04:33, 14 March 2007 (CET)

* In the part of the tutorial that describes how to create a new users, shoudn't to have an edit /etc/sudoers to add permitions for kde-devel call sudo? --[[User:SilveiraNeto|SilveiraNeto]] 03:01, 14 March 2007 (CET)

: no. why would you want them to have sudo access?

==== libungif/giflib ====
Since the patents expired, why not use giflib?

==== Old gcc and -pch flag ====
In Qt part I had problems with error like this: [http://www.qtforum.org/thread.php?threadid=19998 QtForum thread]. I had GCC 3.3.X installed. Using -pch flag (as in recipe) get me errors. Someone friendly gave me tip on #kde-devel not to use this flag, although I didn't test it. Instead I've just updated gcc and g++ from debian repositories. Newer version works fine as "Precompiled headers are supported in GCC (3.4 and newer)" [http://en.wikipedia.org/wiki/Precompiled_header Wikipedia pch].

==== Build status ====

You might want to include the [http://developer.kde.org/~dirk/dashboard/ dashboard link] to show which modules currently build and which don't. --[[User:141.35.8.106|141.35.8.106]] 13:28, 20 March 2007 (CET)

== Extra optional software ==

- openldap
- cyrus

If there was a line at the top like:

sudo apt-get install libaaa-dev libbbb-dev ...-dev ...

This would be very useful and save hours. Is this something we should do?

== su - kde4 didn't set the variables ==

after running 'su - kde4' and 'export' i saw that no variables in .bashrc were set, instead the old one (of the system) where set. I tried 'su kde4' and it worked fine. Why is that?

I'm running gentoo 2006.1 amd64

== Qt Flags ==

Are "-pch" and "-qdbus" really needed? The configure script shows that they're enabled by default. --[[User:McEnroe|McEnroe]] 16:49, 19 April 2007 (CEST)
:Fixed. Also got rid of openssl for the same reason [[User:Logixoul|Logixoul]] 18:03, 5 July 2007 (CEST)

== Amount of space needed? ==

It would be nice to know how much space (roughly, in GB) you need for a setup to build and run the basic things and packages. --[[User:Liquidat|Liquidat]] 03:08, 7 June 2007 (CEST)
: 4.5 GB --[[User:Logixoul|Logixoul]] 18:12, 5 July 2007 (CEST)

== Install error? ==

With the kdesupport package I have an install error:
<code>
CMake Error: Error in cmake code at
/media/local/kde-devel/kde/build/kdesupport/qca/plugins/qca-logger/cmake_install .cmake:35:
FILE cannot create directory: /usr/lib/qt4/plugins/crypto. Maybe need administrative privileges.
Current CMake stack: /media/local/kde-devel/kde/build/kdesupport/cmake_install.c make;/media/local/kde-devel/kde/build/kdesupport/qca/cmake_install.cmake;/media/ local/kde-devel/kde/build/kdesupport/qca/plugins/cmake_install.cmake;/media/loca l/kde-devel/kde/build/kdesupport/qca/plugins/qca-logger/cmake_install.cmake
make: *** [install] Error 255
</code>

Why is it trying to install that system wide?

:Have you installed local copy of qt4 as described in this tutorial? I had the same error while trying to skip installation of local qt4 copy and use system-wide installed one. The error is gone with local copy of qt4.

::I checked back, and the problem is that the script tries to install "libqca-logger.so" to $QTDIR - any idea how to change that?

:::Did you set $QTDIR to the correct value? Make sure you use the .bashrc so that all environment variables are correct. -[[User:TMG|TMG]] 14:25, 25 June 2007 (CEST)
::::The entire point is that $QTDIR has to be set to /usr/lib/qt4/ - because I use the system wide installed copy of Qt 4.3!
::::So the problem is not that $QTDIR is set wrong but that the script tries to install something to $QTDIR. --[[User:141.35.185.149|141.35.185.149]] 23:38, 3 July 2007 (CEST)
:::::Well, then you probably need to install with sudo to get the file installed. I guess it needs to be in the Qt directory because otherwise, Qt doesn't find the files. -[[User:TMG|TMG]] 17:31, 4 July 2007 (CEST)

== Wrong line numbers (and explanation) in the "What's Happening" section for Qt part. ==

Line numbers:
----
Once the patches have been applied, we then set up the build using the configure script (line 5-7). Finally, we build the minimal requirements for KDE (line 8)...
----
It should be 5-6 for configure and 7 for make.

Explanation is wrong because there is no make install command. And this directory will be used directly. But in the article: "...we build the minimal requirements for KDE (line 8) and install (line 9-10) Qt".
But in lines 9-10:
----
# if we don't install, we'll just clear obj files to
# save disk space
----
Best regards, powerfox.

== Wrong directories? ==

Why does the recipe for kdesupport only say "cs" before getting the source and building while the "cmakekdeall" function in the example .bashrc says "cs KDE/kdesupport && svn up && cmakekde"?

It should either use the KDE subfolder or it shouldn't but now I'm confused as to which of the two is right.

== Problem with required soprano version (Kubuntu Gutsy Gibbon) ==

(sorry for grammar errors if they occur)
So,

I,m using Kubuntu Gutsy Gibbon and I had problems with soprano library at installing kdelibs.

cmakekde requires to install kdelibs the version of soprano library, which does not exist in ubuntu repositories. The needed version you can find e.g.
here: http://ubuntu2.cica.es/ubuntu/ubuntu/pool/universe/s/soprano/

From this website you have to download libsoprano-dev and libsoprano4 having the same suffix (e.g. ubuntu1~gutsy1_all.deb if you are using Kubuntu Gutsy Gibbon).

Go to directory where you downloaded packages and install each package using dpkg ( I have forgotten the order, so try and when something goes wrong, dpkg shows an information and proposes a solution).

After this remove ~/kde/build/KDE/kdelibs/CMakeCache.txt and try again to install kdelibs.

Good luck :)

* It was damned hard to find, but libsoprano-dev in Gutsy is 1.96.0, and kdelibs requires >=1.97.1. The article says "in this case you need to download and build the relevant part of kdesupport", but as long as the package is installed, cmakekde prefers the files in /usr/include to those under ~/kde/include. Only after removing the package, I was able to move forward.
* I think the real fix should be to make cmakekde prefer the local versions of include files and libraries, but until then, we should at least fix the procedure for Gutsy - please remove libsoprano-dev from the list of packages to install.
* Thanks, Shai. 19:53, 28 November 2007 (CET)
* kdelibs requires Soprano >=1.99 --> Build kdesupport and remove package libsoprano-dev and libsoprano4 : make all folks - chatmoa - 11Dec2007

== Possible errors about required packages in openSUSE? ==

I've been trying to set up a KDE4 development environment today on a openSUSE 10.3 system and encountered the following (possible) errors in this article:

Missing packages:

kdevelop3 - David Faure's cmakekde bash function uses Kdevelop3 as makefile generator. Without the kdevelop3 package cmake fails to start on my install.

strigi-devel - Building kdelibs fails if strigi-devel is not installed

Questionable packages:

Following a gut feeling I'd like to ask why the following packages are required for setting up a KDE4 development environment:

strigi
strigi-ui
kdesdk3

Talk:Installing third party softwares in terminal/Build/KDE4

2007-12-27T14:25:08Z

Fulldecent: /* Q: Isn't the install prefix, make and make install missing for modules like kdelibs and kdebase? */

==== This article is fat ====

When I first wrote this article, it was lean and mean and simple to understand. And it was good for all distributions. Now I have the impression of a fat pig when I read this article. I pledge for removing the usual sources of error, e.g. the many subdirectories. Why do we need a directory KDE, for example ?
If a tutorial is not simple, it is not done.

--[[User:Tstaerk|Tstaerk]] 14:23, 9 September 2007 (CEST)

:+1. A cleanup would be nice, especially before the official 4.0.0 release! Volunteers needed who do this. --[[User:Dhaumann|Dhaumann]] 22:52, 9 September 2007 (CEST)

:This tutorial is fine by me. Okay, that's not for newbies, but someone who wants to compile KDE4 RC1 needs to know how to follow this tutorial at least. --[[User:Chackal_sjc|Chackal_sjc]] 06:56, 27 November 2007 (CEST)

==== This article is full of errors ====

For example it *is* nessecary to install qt-copy, even if you keep it in the source directory (which leads to 394583069845 error messages on the console during the install). And kdelibs won't build unless something unknown is done with strigi - if it is installed into KDEDIR, it isn't just found.

the heading says pre-requirments are to read "Anonymous SVN Quickstart Guide" first. but the things it does are mostly done in this guide(but a little differently). for example the "Anonymous SVN Quickstart Guide" has you just svn a bunch of stuff.... but that all ended up in the wrong place cause in this guide the svn'd stuff needed to go to "kde-devl"-user's dir not the normal user dir..

:This tutorial clearly states: "The rest of this tutorial assumes you are running as the kde-devel user." -[[User:TMG|TMG]] 14:16, 25 June 2007 (CEST)

==== This article is complicated ====
when I wrote this article, it was lean and simple. It has been improved somewhere, but on most places worsened. An example is the directory structure (to get to qt-copy: cd && cd qt-copy; to get to kdelibs: cs && cd kdelibs; to get to kdepim: cs && cd KDE && cd kdepim - no one understands this!!!).
Another example is cs and cb which is quite unnecessary as my initial article shows. But of course, with the complexity as the article has NOW, it IS necessary.

Why do you spoil a simple article so that even I no longer find my own subdirs ?
--[[User:Tstaerk|Tstaerk]] 10:25, 28 May 2007 (CEST)

: Where do you see "cs && cd KDE && cd kdepim"? Because I don't see that anywhere. In any case it would just be "cs kdepim". Perhaps that's the bit need explaining a bit better? --[[User:Aseigo|Aseigo]] 02:48, 29 May 2007 (CEST)

:To whom are you talking to? ;) There are many contributors and as it's a wiki an article probably "degenerates" automatically if noone has an eye on it. The article certainly has valuable information and simply needs a cleanup. In other words: Fix it! :) --[[User:Dhaumann|Dhaumann]] 12:20, 28 May 2007 (CEST)

::IMHO all of this cs/cb/cmakekde and such is only confusing, users just do copy&paste with no really knowledge of what's going on when they type those commands. This way troubleshooting is quite difficult, and they learn nothing about the '''real''' compiling way. The concept of source/build dirs is barely noted. The ''old'' http://developer.kde.org/build/trunk.html has some more commands to type, but it was quite more understandable and clear about the '''real''' steps to do. --[[user:Pino|pino]] 12:54, 28 May 2007 (CEST)

::: Yes, this article could go back to being more verbose. I suppose what is missing is an explanation of ''why'' the shortcuts are used. They are there for a reason. I also don't get the differentiation between real and not real steps; unless we now consider using the shell for what it was designed for as not real. --[[User:Aseigo|Aseigo]] 02:48, 29 May 2007 (CEST)

:::: What's wrong in explicitely telling:
<pre>
svn co .../kdelibs
mkdir build-kdelibs
cd build-kdelibs
cmake <options> ../kdelibs
make install
</pre>
:::: After all, we did that with the <tt>./configure && make && make install</tt> sequence in KDE 3 times, and that worked quite fine. I still fail why we have to make our things more complicated. Moreover, these macros force fixed paths -- [[user:Pino|pino]] 23:43, 29 May 2007 (CEST)

:I am also for removing cb and cs, somebody should just do it. They are indeed confusing and sometimes don't work as expected (that is why cd $KDE_SRC is needed in one place). cmakekde on the other hand could stay IMHO. -[[User:TMG|TMG]] 14:16, 25 June 2007 (CEST)

==== Q: What is cs and cb? ====

A: '''This is not a typo'''. Read the [http://techbase.kde.org/index.php?title=Getting_Started/Increased_Productivity_in_KDE4_with_Scripts/.bashrc article about setting up your .bashrc]. Both '''cs''' and '''cb''' are bash functions, used to change to the KDE source directory and KDE build directory respectively.

==== Q: Are there build instructions for other OS? ====

A: Actually '''yes''', for [[Getting Started/Build/KDE4/Mac OS X|Mac OS X]]. There also is [http://www.kdelibs.com kdelibs.com] (see also [[User_talk:Jstaniek#KDElibs.com_and_developernew.kde.org_coexistence|here]]) which will be merged into this wiki in the future.

==== Q: Isn't the install prefix, make and make install missing for modules like kdelibs and kdebase? ====
A: No. The shell function ''cmakekde'' handles this, have a look at the file [[Getting_Started/Increased_Productivity_in_KDE4_with_Scripts/.bashrc|.bashrc]].

==== Q: I changed the first command of the "Set up QT - Recipe" from cd to cs because I think this was a typo. Am I right?? ====
A: Right --[[User:Dhaumann|Dhaumann]]

:: no, it was perfectly intentional. see the [[Getting_Started/Increased_Productivity_in_KDE4_with_Scripts/.bashrc|bashrc in the productivity with KDE4 scripts tutorial]]. it has QTDIR set to ~/qt-copy. this makes sense, actually, since building Qt is done rather differently from the rest of KDE and one may not get Qt from KDE's svn in any case. so yes, it is supposed to be cd, not cs.

::: *blush* ;) i should read more carefully. --[[User:Dhaumann|Dhaumann]]

==== Notes: ~/install ====

When installing KDE4, I strongly recommend installing all tools (like dbus and cmake) and kde packages into the same place, e.g. ~/install. Qt is the only exception.

The reason for this is because if you install some packages to ~/kde and some to /usr/local and maybe one in /usr then cmake will generate errors like:

-- It is impossible to order the include directories.

This is not a fatal error, so you will still be able to compile, but you will possibly be using the wrong versions of libraries and this will product problems that are very hard to diagnose.

You may not experience any problems when installed like I advise not to, however I have and you might too in some typical situations.

Please see:

http://developer.kde.org/build/trunk.html

==== Install CMake modules local ====

The CMake modules should be installed local into ~/install/cmake/modules or similar.
When following the current instructions [[ Getting_Started/Build/KDE4#Install_additional_CMake_modules|6.1: Install additional CMake modules]], it's impossible to do a non-root installation, because "kdelibs/cmake/modules/cmake_install.cmake" wants to install the modules to "/cmake/modules". (I didn't install CMake local, because my system already provided CMake > 2.4.3).

I've already tried to do this, fiddling around with CMAKE_MODULE_PATH and DATA_INSTALL_DIR but couldn't get it working.

Does anybody know how to do this properly?

--[[User:Eliasp|Eliasp]] 15:44, 4 January 2007 (CET)

==== Fixes needed ====
* qt-copy: Should we pass the -debug flag? Doesn't Qt install debug information separately by default anyways? Or is that just in the snapshot? --[[User:Mpyne|Mpyne]]

: according to ./configure --help, the default is -release in snapshot. --[[User:Aseigo|Aseigo]] 04:33, 14 March 2007 (CET)

* In the part of the tutorial that describes how to create a new users, shoudn't to have an edit /etc/sudoers to add permitions for kde-devel call sudo? --[[User:SilveiraNeto|SilveiraNeto]] 03:01, 14 March 2007 (CET)

: no. why would you want them to have sudo access?

==== libungif/giflib ====
Since the patents expired, why not use giflib?

==== Old gcc and -pch flag ====
In Qt part I had problems with error like this: [http://www.qtforum.org/thread.php?threadid=19998 QtForum thread]. I had GCC 3.3.X installed. Using -pch flag (as in recipe) get me errors. Someone friendly gave me tip on #kde-devel not to use this flag, although I didn't test it. Instead I've just updated gcc and g++ from debian repositories. Newer version works fine as "Precompiled headers are supported in GCC (3.4 and newer)" [http://en.wikipedia.org/wiki/Precompiled_header Wikipedia pch].

==== Build status ====

You might want to include the [http://developer.kde.org/~dirk/dashboard/ dashboard link] to show which modules currently build and which don't. --[[User:141.35.8.106|141.35.8.106]] 13:28, 20 March 2007 (CET)

== Extra optional software ==

- openldap
- cyrus

If there was a line at the top like:

sudo apt-get install libaaa-dev libbbb-dev ...-dev ...

This would be very useful and save hours. Is this something we should do?

== su - kde4 didn't set the variables ==

after running 'su - kde4' and 'export' i saw that no variables in .bashrc were set, instead the old one (of the system) where set. I tried 'su kde4' and it worked fine. Why is that?

I'm running gentoo 2006.1 amd64

== Qt Flags ==

Are "-pch" and "-qdbus" really needed? The configure script shows that they're enabled by default. --[[User:McEnroe|McEnroe]] 16:49, 19 April 2007 (CEST)
:Fixed. Also got rid of openssl for the same reason [[User:Logixoul|Logixoul]] 18:03, 5 July 2007 (CEST)

== Amount of space needed? ==

It would be nice to know how much space (roughly, in GB) you need for a setup to build and run the basic things and packages. --[[User:Liquidat|Liquidat]] 03:08, 7 June 2007 (CEST)
: 4.5 GB --[[User:Logixoul|Logixoul]] 18:12, 5 July 2007 (CEST)

== Install error? ==

With the kdesupport package I have an install error:
<code>
CMake Error: Error in cmake code at
/media/local/kde-devel/kde/build/kdesupport/qca/plugins/qca-logger/cmake_install .cmake:35:
FILE cannot create directory: /usr/lib/qt4/plugins/crypto. Maybe need administrative privileges.
Current CMake stack: /media/local/kde-devel/kde/build/kdesupport/cmake_install.c make;/media/local/kde-devel/kde/build/kdesupport/qca/cmake_install.cmake;/media/ local/kde-devel/kde/build/kdesupport/qca/plugins/cmake_install.cmake;/media/loca l/kde-devel/kde/build/kdesupport/qca/plugins/qca-logger/cmake_install.cmake
make: *** [install] Error 255
</code>

Why is it trying to install that system wide?

:Have you installed local copy of qt4 as described in this tutorial? I had the same error while trying to skip installation of local qt4 copy and use system-wide installed one. The error is gone with local copy of qt4.

::I checked back, and the problem is that the script tries to install "libqca-logger.so" to $QTDIR - any idea how to change that?

:::Did you set $QTDIR to the correct value? Make sure you use the .bashrc so that all environment variables are correct. -[[User:TMG|TMG]] 14:25, 25 June 2007 (CEST)
::::The entire point is that $QTDIR has to be set to /usr/lib/qt4/ - because I use the system wide installed copy of Qt 4.3!
::::So the problem is not that $QTDIR is set wrong but that the script tries to install something to $QTDIR. --[[User:141.35.185.149|141.35.185.149]] 23:38, 3 July 2007 (CEST)
:::::Well, then you probably need to install with sudo to get the file installed. I guess it needs to be in the Qt directory because otherwise, Qt doesn't find the files. -[[User:TMG|TMG]] 17:31, 4 July 2007 (CEST)

== Wrong line numbers (and explanation) in the "What's Happening" section for Qt part. ==

Line numbers:
----
Once the patches have been applied, we then set up the build using the configure script (line 5-7). Finally, we build the minimal requirements for KDE (line 8)...
----
It should be 5-6 for configure and 7 for make.

Explanation is wrong because there is no make install command. And this directory will be used directly. But in the article: "...we build the minimal requirements for KDE (line 8) and install (line 9-10) Qt".
But in lines 9-10:
----
# if we don't install, we'll just clear obj files to
# save disk space
----
Best regards, powerfox.

== Wrong directories? ==

Why does the recipe for kdesupport only say "cs" before getting the source and building while the "cmakekdeall" function in the example .bashrc says "cs KDE/kdesupport && svn up && cmakekde"?

It should either use the KDE subfolder or it shouldn't but now I'm confused as to which of the two is right.

== Problem with required soprano version (Kubuntu Gutsy Gibbon) ==

(sorry for grammar errors if they occur)
So,

I,m using Kubuntu Gutsy Gibbon and I had problems with soprano library at installing kdelibs.

cmakekde requires to install kdelibs the version of soprano library, which does not exist in ubuntu repositories. The needed version you can find e.g.
here: http://ubuntu2.cica.es/ubuntu/ubuntu/pool/universe/s/soprano/

From this website you have to download libsoprano-dev and libsoprano4 having the same suffix (e.g. ubuntu1~gutsy1_all.deb if you are using Kubuntu Gutsy Gibbon).

Go to directory where you downloaded packages and install each package using dpkg ( I have forgotten the order, so try and when something goes wrong, dpkg shows an information and proposes a solution).

After this remove ~/kde/build/KDE/kdelibs/CMakeCache.txt and try again to install kdelibs.

Good luck :)

* It was damned hard to find, but libsoprano-dev in Gutsy is 1.96.0, and kdelibs requires >=1.97.1. The article says "in this case you need to download and build the relevant part of kdesupport", but as long as the package is installed, cmakekde prefers the files in /usr/include to those under ~/kde/include. Only after removing the package, I was able to move forward.
* I think the real fix should be to make cmakekde prefer the local versions of include files and libraries, but until then, we should at least fix the procedure for Gutsy - please remove libsoprano-dev from the list of packages to install.
* Thanks, Shai. 19:53, 28 November 2007 (CET)
* kdelibs requires Soprano >=1.99 --> Build kdesupport and remove package libsoprano-dev and libsoprano4 : make all folks - chatmoa - 11Dec2007

== Possible errors about required packages in openSUSE? ==

I've been trying to set up a KDE4 development environment today on a openSUSE 10.3 system and encountered the following (possible) errors in this article:

Missing packages:

kdevelop3 - David Faure's cmakekde bash function uses Kdevelop3 as makefile generator. Without the kdevelop3 package cmake fails to start on my install.

strigi-devel - Building kdelibs fails if strigi-devel is not installed

Questionable packages:

Following a gut feeling I'd like to ask why the following packages are required for setting up a KDE4 development environment:

strigi
strigi-ui
kdesdk3

Talk:Installing third party softwares in terminal/Build/KDE4

2007-12-27T14:20:11Z

Fulldecent: /* Q: What is cs and cb? */

==== This article is fat ====

When I first wrote this article, it was lean and mean and simple to understand. And it was good for all distributions. Now I have the impression of a fat pig when I read this article. I pledge for removing the usual sources of error, e.g. the many subdirectories. Why do we need a directory KDE, for example ?
If a tutorial is not simple, it is not done.

--[[User:Tstaerk|Tstaerk]] 14:23, 9 September 2007 (CEST)

:+1. A cleanup would be nice, especially before the official 4.0.0 release! Volunteers needed who do this. --[[User:Dhaumann|Dhaumann]] 22:52, 9 September 2007 (CEST)

:This tutorial is fine by me. Okay, that's not for newbies, but someone who wants to compile KDE4 RC1 needs to know how to follow this tutorial at least. --[[User:Chackal_sjc|Chackal_sjc]] 06:56, 27 November 2007 (CEST)

==== This article is full of errors ====

For example it *is* nessecary to install qt-copy, even if you keep it in the source directory (which leads to 394583069845 error messages on the console during the install). And kdelibs won't build unless something unknown is done with strigi - if it is installed into KDEDIR, it isn't just found.

the heading says pre-requirments are to read "Anonymous SVN Quickstart Guide" first. but the things it does are mostly done in this guide(but a little differently). for example the "Anonymous SVN Quickstart Guide" has you just svn a bunch of stuff.... but that all ended up in the wrong place cause in this guide the svn'd stuff needed to go to "kde-devl"-user's dir not the normal user dir..

:This tutorial clearly states: "The rest of this tutorial assumes you are running as the kde-devel user." -[[User:TMG|TMG]] 14:16, 25 June 2007 (CEST)

==== This article is complicated ====
when I wrote this article, it was lean and simple. It has been improved somewhere, but on most places worsened. An example is the directory structure (to get to qt-copy: cd && cd qt-copy; to get to kdelibs: cs && cd kdelibs; to get to kdepim: cs && cd KDE && cd kdepim - no one understands this!!!).
Another example is cs and cb which is quite unnecessary as my initial article shows. But of course, with the complexity as the article has NOW, it IS necessary.

Why do you spoil a simple article so that even I no longer find my own subdirs ?
--[[User:Tstaerk|Tstaerk]] 10:25, 28 May 2007 (CEST)

: Where do you see "cs && cd KDE && cd kdepim"? Because I don't see that anywhere. In any case it would just be "cs kdepim". Perhaps that's the bit need explaining a bit better? --[[User:Aseigo|Aseigo]] 02:48, 29 May 2007 (CEST)

:To whom are you talking to? ;) There are many contributors and as it's a wiki an article probably "degenerates" automatically if noone has an eye on it. The article certainly has valuable information and simply needs a cleanup. In other words: Fix it! :) --[[User:Dhaumann|Dhaumann]] 12:20, 28 May 2007 (CEST)

::IMHO all of this cs/cb/cmakekde and such is only confusing, users just do copy&paste with no really knowledge of what's going on when they type those commands. This way troubleshooting is quite difficult, and they learn nothing about the '''real''' compiling way. The concept of source/build dirs is barely noted. The ''old'' http://developer.kde.org/build/trunk.html has some more commands to type, but it was quite more understandable and clear about the '''real''' steps to do. --[[user:Pino|pino]] 12:54, 28 May 2007 (CEST)

::: Yes, this article could go back to being more verbose. I suppose what is missing is an explanation of ''why'' the shortcuts are used. They are there for a reason. I also don't get the differentiation between real and not real steps; unless we now consider using the shell for what it was designed for as not real. --[[User:Aseigo|Aseigo]] 02:48, 29 May 2007 (CEST)

:::: What's wrong in explicitely telling:
<pre>
svn co .../kdelibs
mkdir build-kdelibs
cd build-kdelibs
cmake <options> ../kdelibs
make install
</pre>
:::: After all, we did that with the <tt>./configure && make && make install</tt> sequence in KDE 3 times, and that worked quite fine. I still fail why we have to make our things more complicated. Moreover, these macros force fixed paths -- [[user:Pino|pino]] 23:43, 29 May 2007 (CEST)

:I am also for removing cb and cs, somebody should just do it. They are indeed confusing and sometimes don't work as expected (that is why cd $KDE_SRC is needed in one place). cmakekde on the other hand could stay IMHO. -[[User:TMG|TMG]] 14:16, 25 June 2007 (CEST)

==== Q: What is cs and cb? ====

A: '''This is not a typo'''. Read the [http://techbase.kde.org/index.php?title=Getting_Started/Increased_Productivity_in_KDE4_with_Scripts/.bashrc article about setting up your .bashrc]. Both '''cs''' and '''cb''' are bash functions, used to change to the KDE source directory and KDE build directory respectively.

==== Q: Are there build instructions for other OS? ====

A: Actually '''yes''', for [[Getting Started/Build/KDE4/Mac OS X|Mac OS X]]. There also is [http://www.kdelibs.com kdelibs.com] (see also [[User_talk:Jstaniek#KDElibs.com_and_developernew.kde.org_coexistence|here]]) which will be merged into this wiki in the future.

==== Q: Isn't the install prefix, make and make install missing for modules like kdelibs and kdebase? ====
A: No. The shell function ''cmakekde'' handels this, have a look at the file [[Getting_Started/Increased_Productivity_in_KDE4_with_Scripts/.bashrc|.bashrc]].

==== Q: I changed the first command of the "Set up QT - Recipe" from cd to cs because I think this was a typo. Am I right?? ====
A: Right --[[User:Dhaumann|Dhaumann]]

:: no, it was perfectly intentional. see the [[Getting_Started/Increased_Productivity_in_KDE4_with_Scripts/.bashrc|bashrc in the productivity with KDE4 scripts tutorial]]. it has QTDIR set to ~/qt-copy. this makes sense, actually, since building Qt is done rather differently from the rest of KDE and one may not get Qt from KDE's svn in any case. so yes, it is supposed to be cd, not cs.

::: *blush* ;) i should read more carefully. --[[User:Dhaumann|Dhaumann]]

==== Notes: ~/install ====

When installing KDE4, I strongly recommend installing all tools (like dbus and cmake) and kde packages into the same place, e.g. ~/install. Qt is the only exception.

The reason for this is because if you install some packages to ~/kde and some to /usr/local and maybe one in /usr then cmake will generate errors like:

-- It is impossible to order the include directories.

This is not a fatal error, so you will still be able to compile, but you will possibly be using the wrong versions of libraries and this will product problems that are very hard to diagnose.

You may not experience any problems when installed like I advise not to, however I have and you might too in some typical situations.

Please see:

http://developer.kde.org/build/trunk.html

==== Install CMake modules local ====

The CMake modules should be installed local into ~/install/cmake/modules or similar.
When following the current instructions [[ Getting_Started/Build/KDE4#Install_additional_CMake_modules|6.1: Install additional CMake modules]], it's impossible to do a non-root installation, because "kdelibs/cmake/modules/cmake_install.cmake" wants to install the modules to "/cmake/modules". (I didn't install CMake local, because my system already provided CMake > 2.4.3).

I've already tried to do this, fiddling around with CMAKE_MODULE_PATH and DATA_INSTALL_DIR but couldn't get it working.

Does anybody know how to do this properly?

--[[User:Eliasp|Eliasp]] 15:44, 4 January 2007 (CET)

==== Fixes needed ====
* qt-copy: Should we pass the -debug flag? Doesn't Qt install debug information separately by default anyways? Or is that just in the snapshot? --[[User:Mpyne|Mpyne]]

: according to ./configure --help, the default is -release in snapshot. --[[User:Aseigo|Aseigo]] 04:33, 14 March 2007 (CET)

* In the part of the tutorial that describes how to create a new users, shoudn't to have an edit /etc/sudoers to add permitions for kde-devel call sudo? --[[User:SilveiraNeto|SilveiraNeto]] 03:01, 14 March 2007 (CET)

: no. why would you want them to have sudo access?

==== libungif/giflib ====
Since the patents expired, why not use giflib?

==== Old gcc and -pch flag ====
In Qt part I had problems with error like this: [http://www.qtforum.org/thread.php?threadid=19998 QtForum thread]. I had GCC 3.3.X installed. Using -pch flag (as in recipe) get me errors. Someone friendly gave me tip on #kde-devel not to use this flag, although I didn't test it. Instead I've just updated gcc and g++ from debian repositories. Newer version works fine as "Precompiled headers are supported in GCC (3.4 and newer)" [http://en.wikipedia.org/wiki/Precompiled_header Wikipedia pch].

==== Build status ====

You might want to include the [http://developer.kde.org/~dirk/dashboard/ dashboard link] to show which modules currently build and which don't. --[[User:141.35.8.106|141.35.8.106]] 13:28, 20 March 2007 (CET)

== Extra optional software ==

- openldap
- cyrus

If there was a line at the top like:

sudo apt-get install libaaa-dev libbbb-dev ...-dev ...

This would be very useful and save hours. Is this something we should do?

== su - kde4 didn't set the variables ==

after running 'su - kde4' and 'export' i saw that no variables in .bashrc were set, instead the old one (of the system) where set. I tried 'su kde4' and it worked fine. Why is that?

I'm running gentoo 2006.1 amd64

== Qt Flags ==

Are "-pch" and "-qdbus" really needed? The configure script shows that they're enabled by default. --[[User:McEnroe|McEnroe]] 16:49, 19 April 2007 (CEST)
:Fixed. Also got rid of openssl for the same reason [[User:Logixoul|Logixoul]] 18:03, 5 July 2007 (CEST)

== Amount of space needed? ==

It would be nice to know how much space (roughly, in GB) you need for a setup to build and run the basic things and packages. --[[User:Liquidat|Liquidat]] 03:08, 7 June 2007 (CEST)
: 4.5 GB --[[User:Logixoul|Logixoul]] 18:12, 5 July 2007 (CEST)

== Install error? ==

With the kdesupport package I have an install error:
<code>
CMake Error: Error in cmake code at
/media/local/kde-devel/kde/build/kdesupport/qca/plugins/qca-logger/cmake_install .cmake:35:
FILE cannot create directory: /usr/lib/qt4/plugins/crypto. Maybe need administrative privileges.
Current CMake stack: /media/local/kde-devel/kde/build/kdesupport/cmake_install.c make;/media/local/kde-devel/kde/build/kdesupport/qca/cmake_install.cmake;/media/ local/kde-devel/kde/build/kdesupport/qca/plugins/cmake_install.cmake;/media/loca l/kde-devel/kde/build/kdesupport/qca/plugins/qca-logger/cmake_install.cmake
make: *** [install] Error 255
</code>

Why is it trying to install that system wide?

:Have you installed local copy of qt4 as described in this tutorial? I had the same error while trying to skip installation of local qt4 copy and use system-wide installed one. The error is gone with local copy of qt4.

::I checked back, and the problem is that the script tries to install "libqca-logger.so" to $QTDIR - any idea how to change that?

:::Did you set $QTDIR to the correct value? Make sure you use the .bashrc so that all environment variables are correct. -[[User:TMG|TMG]] 14:25, 25 June 2007 (CEST)
::::The entire point is that $QTDIR has to be set to /usr/lib/qt4/ - because I use the system wide installed copy of Qt 4.3!
::::So the problem is not that $QTDIR is set wrong but that the script tries to install something to $QTDIR. --[[User:141.35.185.149|141.35.185.149]] 23:38, 3 July 2007 (CEST)
:::::Well, then you probably need to install with sudo to get the file installed. I guess it needs to be in the Qt directory because otherwise, Qt doesn't find the files. -[[User:TMG|TMG]] 17:31, 4 July 2007 (CEST)

== Wrong line numbers (and explanation) in the "What's Happening" section for Qt part. ==

Line numbers:
----
Once the patches have been applied, we then set up the build using the configure script (line 5-7). Finally, we build the minimal requirements for KDE (line 8)...
----
It should be 5-6 for configure and 7 for make.

Explanation is wrong because there is no make install command. And this directory will be used directly. But in the article: "...we build the minimal requirements for KDE (line 8) and install (line 9-10) Qt".
But in lines 9-10:
----
# if we don't install, we'll just clear obj files to
# save disk space
----
Best regards, powerfox.

== Wrong directories? ==

Why does the recipe for kdesupport only say "cs" before getting the source and building while the "cmakekdeall" function in the example .bashrc says "cs KDE/kdesupport && svn up && cmakekde"?

It should either use the KDE subfolder or it shouldn't but now I'm confused as to which of the two is right.

== Problem with required soprano version (Kubuntu Gutsy Gibbon) ==

(sorry for grammar errors if they occur)
So,

I,m using Kubuntu Gutsy Gibbon and I had problems with soprano library at installing kdelibs.

cmakekde requires to install kdelibs the version of soprano library, which does not exist in ubuntu repositories. The needed version you can find e.g.
here: http://ubuntu2.cica.es/ubuntu/ubuntu/pool/universe/s/soprano/

From this website you have to download libsoprano-dev and libsoprano4 having the same suffix (e.g. ubuntu1~gutsy1_all.deb if you are using Kubuntu Gutsy Gibbon).

Go to directory where you downloaded packages and install each package using dpkg ( I have forgotten the order, so try and when something goes wrong, dpkg shows an information and proposes a solution).

After this remove ~/kde/build/KDE/kdelibs/CMakeCache.txt and try again to install kdelibs.

Good luck :)

* It was damned hard to find, but libsoprano-dev in Gutsy is 1.96.0, and kdelibs requires >=1.97.1. The article says "in this case you need to download and build the relevant part of kdesupport", but as long as the package is installed, cmakekde prefers the files in /usr/include to those under ~/kde/include. Only after removing the package, I was able to move forward.
* I think the real fix should be to make cmakekde prefer the local versions of include files and libraries, but until then, we should at least fix the procedure for Gutsy - please remove libsoprano-dev from the list of packages to install.
* Thanks, Shai. 19:53, 28 November 2007 (CET)
* kdelibs requires Soprano >=1.99 --> Build kdesupport and remove package libsoprano-dev and libsoprano4 : make all folks - chatmoa - 11Dec2007

== Possible errors about required packages in openSUSE? ==

I've been trying to set up a KDE4 development environment today on a openSUSE 10.3 system and encountered the following (possible) errors in this article:

Missing packages:

kdevelop3 - David Faure's cmakekde bash function uses Kdevelop3 as makefile generator. Without the kdevelop3 package cmake fails to start on my install.

strigi-devel - Building kdelibs fails if strigi-devel is not installed

Questionable packages:

Following a gut feeling I'd like to ask why the following packages are required for setting up a KDE4 development environment:

strigi
strigi-ui
kdesdk3

Getting Started/Build/KDE4

2007-03-31T22:57:45Z

Fulldecent: /* Success! */

{{TutorialBrowser|

series=Getting Started|

name=Building KDE4 From Source|

pre=[[../../Sources/Anonymous_SVN|Anonymous SVN Quickstart Guide]]|

next=[[../../Set_up_KDE_4_for_development|Starting a KDE4 Environment and Applications]]|

reading=[http://kdesvn-build.kde.org/ kdesvn-build: The KDE From Subversion Build Tool]<br>[[../../Increased_Productivity_in_KDE4_with_Scripts|Increased Productivity in KDE4 with Scripts]]<br>[[Development/Tutorials/CMake |Introduction to CMake]]<br>[[../KDE4/FreeBSD|FreeBSD notes]]<br>[[../KDE4/Mac OS X|Instructions for Mac OS X]]|
}}

== Abstract ==

This tutorial shows one way to get KDE from trunk running on Linux/BSD systems. Throughout the tutorial the bash shell is used. If you are interested in building KDE on other systems such as Solaris, MacOS or Microsoft Windows, please visit the [[../|Build]] page and see the links at the bottom for the respective operating systems.

{{note|Expect a higher risk of build failure on Mondays when critical changes are implemented. [http://developer.kde.org/~dirk/dashboard/ Dashboard] reports unexpected breakages. You are encouraged to fix failing modules.
}}

== Required Software ==

The following must be installed first before you can successfully complete this tutorial:
* gcc and g++ from the gcc project, preferably version 4.1 or higher
* svn, the subversion revision control client
* pkg-config
* development libraries and headers for X11 and OpenGL
* development libraries and headers for libjpeg, libpng, libungif, libclucene, libxml2 and libxslt
* the makeobj script. You can install it as part of a kdesdk-scripts (debian) or similar package, or just download it itself from [http://websvn.kde.org/trunk/KDE/kdesdk/scripts/makeobj?revision=600932&view=markup WebSVN]
* the shared-mime-info package, which is the freedesktop MIME standard KDE is using now

You may also want to have the following installed:
* bash

== Create a user account for KDE4 development ==

Some people like to have a separate user account for kde (for instance an old bug deleted files by mistake), and the instructions below were written with that approach.

However it is much more efficient to do everything with a single user account, see http://techbase.kde.org/Getting_Started/Increased_Productivity_in_KDE4_with_Scripts
for more details. You can still follow the instructions below, but don't put the environment variables in your .bashrc, put them in a separate file that you source to switch to the kde4 environment.

=== Option 1: Command Line ===
<code bash>
useradd -m kde-devel
</code>
or:
<code bash>
useradd kde-devel
mkdir /home/kde-devel
passwd kde-devel
chown kde-devel:kde-devel /home/kde-devel 2>/dev/null || \
chown kde-devel:users /home/kde-devel
</code>

=== Option 2: Using KControl ===

Instead of using the commands above, you can also use the User module in the KDE Control Center if you already have KDE3 installed.

=== Setting up the environment ===

Copy the {{path|~/.bashrc}} from your normal user account to the new kde-devel account. Next, copy and paste the contents of the [[Getting Started/Increased Productivity in KDE4 with Scripts/.bashrc|example .bashrc]] into {{path|~kde-devel/.bashrc}}. Be sure to comment out the line <tt>alias make=makeobj</tt> if you do not have the <tt>makeobj</tt> command available, this command comes with the KDE SDK scripts.

This will provide access to commands such as <tt>cmakekde</tt> that are used in this tutorial as well as ensure that the proper paths are in place for Qt, KDE and CMake binaries.

For more information, please read the [[Getting Started/Increased Productivity in KDE4 with Scripts]] tutorial.

=== Switching to the New User ===
Switch to the user kde-devel: (don't forget the dash)
<code bash>
su - kde-devel
</code>

The rest of this tutorial assumes you are running as the <tt>kde-devel</tt> user.

== The development user's shell ==

On some systems a new user is configured by default to use {{path|/bin/sh}}. If this is not the case on your system, you can skip this section. Using {{path|/bin/sh}} can be very inconvenient to work with and you may want to change it to {{path|/bin/bash}} or another shell.

=== Option 1: As the kde-devel user ===

If you don't have root privileges and your system supports the changing of your own shell with the <tt>chsh</tt> application, then you could try to change your shell to /bin/bash by using:
<code bash>
chsh -s /bin/bash kde-devel
</code>

=== Option 2: As the root user ===

If your system comes with the <tt>usermod</tt> application you can run the following command as root: <tt>usermod -s /bin/bash</tt>.
s
Another option is to use the <tt>vipw</tt> application as root to safely edit your {{path|/etc/passwd}}. Locate 'kde-devel' in the the file. Change '{{path|/bin/sh}}' at the end of the line to read '{{path|/bin/bash}}', save your changes and exit.

The new shell will be started automatically when you log in as the kde-devel user again.

== D-Bus ==
QtDBus and KDE are known to work with D-Bus versions 0.62, as well as 0.92 and upwards. Versions 0.60 and 0.61 may work too but are not tested. Versions 0.90 and 0.91 are known not to work. We recommend using post-1.0 release versions (at least 0.94), so consider upgrading if you haven't done so.

You may skip this section if you have a recent D-Bus version or if you don't want to upgrade.

Before running these steps in the recipe, make sure your X11 headers and libraries are available. The configure script run on line 5 should output:
Building X11 code: yes

=== The Recipe ===

{{tip|Check [[Getting Started/Increased Productivity in KDE4 with Scripts]] for some aliases that help with KDE development. These include aliases to switch from the build into the source directory (cs) and back (cb).}}


<code bash>
cs
wget http://dbus.freedesktop.org/releases/dbus/dbus-1.0.2.tar.gz
tar -xvzf dbus-1.0.2.tar.gz
cd dbus-1.0.2/
./configure --prefix=$DBUSDIR --localstatedir=$KDEDIR/var
make
make install
dbus-uuidgen --ensure
</code>

=== What's Happening ===
After changing into the source directory (line 1), D-Bus source code is downloaded from freedesktop.org (line 2) and unpacked (line 3). After going into the newly created D-Bus directory (line 3), the build is set up using the supplied {{path|configure}} script (line 5). After building (line 6) and installing (line 7) D-Bus, we use the <tt>dbus-uuidgen</tt> tool to install a machine identification file that allows the bus to start automatically when the desktop session starts (line 8).

Note that you need write access to {{path|/var}} for the last two steps. If your system does not have the sudo command, you can use the <tt>su</tt> command instead, e.g. <tt>su -c "make install"</tt>.

== CMake ==
Skip this if you have [http://cmake.org/ CMake] >=2.4.5 installed.
You should be able to directly use the binary packages available on the [http://www.cmake.org/HTML/Download.html CMake site]. There are also distribution specific packages available.
CMake binary packages for openSUSE are available from [http://software.opensuse.org/download/devel:/tools:/building/ openSUSE build service].

=== The Recipe ===

<code bash>
cs
wget http://www.cmake.org/files/v2.4/cmake-2.4.6.tar.gz
tar zxf cmake-2.4.6.tar.gz
mkdir cmake-build
cd cmake-build
../cmake-2.4.6/bootstrap
make
sudo make install
</code>

=== What's Happening ===
First, we go back to the <tt>kde-devel</tt> user's source directory (line 1), get the CMake sources (line 2) and unpack them (line 3). We create a directory to build CMake in (line 4) and go into it (line 5). We then run the CMake boostrap script to set up the CMake build (line 6), then make (line 7) and install it (line 8) using the root user.

If your system does not have the <tt>sudo</tt> command, you can instead do <tt>su -c "make install"</tt>.

== Qt ==
Next we need to get the Qt4 that is in KDE's source repository. KDE is guaranteed to build against any Qt 4.3. That is still an unreleased version, so your distribution probably doesn't have packages for it. You should use the copy in the KDE Subversion servers.

KDE is no longer supported on Qt 4.2 and earlier versions.

Hint: This part may take some time depending on what kind of hardware your computer is running.

=== The Recipe ===
<code bash>
cd
svn checkout svn://anonsvn.kde.org/home/kde/trunk/qt-copy
cd qt-copy
./apply_patches
./configure -qt-gif -no-exceptions -debug -fast \
-prefix $QTDIR -qdbus -pch -nomake examples \
-nomake demos
make sub-src sub-tools
# make install: only if QTDIR is not the current directory!
make install
</code>

=== What's Happening ===
We switch back to the <tt>kde-devel</tt> user's home directory (line 1) and download the source code using subversion (svn) from KDE's repository (line 2). After changing into the resulting {{path|qt-copy}} directory (line 3), we run a script that manages the patches that come with <tt>qt-copy</tt> (line 4).

Once the patches have been applied, we then set up the build using the <tt>configure</tt> script (line 5-7). The various command line options used are explained in the {{path|qt-copy/README.qt-copy}} file. Finally, we build the minimal requirements for KDE (line 8) and install (line 9-10) Qt. If you want all the example and demo applications, you can either build them individually or simply do a <tt>make</tt> from the {{path|qt-copy}} directory. Note that the installation does not require root as it installs it locally into {{path|qt-copy}} itself.

=== Troubleshooting ===
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}}. If it crashes in QSpanData::adjustSpanMethods, then your problem is the oxygen style. Try removing {{path|/lib/kde4/plugins/styles/kstyle-oxygen.so}} and {{path|/lib/kde4/plugins/styles/oxygen.so}} if they exist.

== Strigi ==

{{warning|If you have jumped to this section without reading section 3.3 Setting Up The Environment '''the recipes provided will not work'''. The recipes are not in error; <tt>cs</tt> and <tt>cb</tt> are not typos. You '''must''' follow the instructions in section 3.3 for this tutorial to work for you.}}

The code for getting at file metadata now relies on Strigi. To install Strigi you need the libraries and headers for libz, libbz2, openssl (libcrypto or libssl), libclucene (>=0.9.16), and either libxml2 or libexpat.

=== The Recipe ===

<code bash>
cs
svn checkout svn://anonsvn.kde.org/home/kde/trunk/kdesupport/strigi
cd strigi
cmakekde
</code>

=== What's Happening ===
We change to the base source directory (line 1). We download the sources for strigi using subversion (line 2), go into the new ~/src/strigi directory (line 3), and commence the build (line 4). This will leave us in the strigi build directory after the build is completed.

== kdelibs ==

With Qt4 and Strigi built, we can now move on to building KDE's base libraries. If you use the aforementioned [[Getting Started/Increased Productivity in KDE4 with Scripts/.bashrc|.bashrc]] this is where those new functions come in handy.

Hint: This part may take some time depending on what kind of hardware your computer is running.

=== The Recipe ===

<code bash>
cd $KDE_SRC
mkdir KDE && cd KDE
svn checkout svn://anonsvn.kde.org/home/kde/trunk/KDE/kdelibs
cd kdelibs
cmakekde
</code>

{{tip|If this command fails stating that CMake requires an out of source build directory, remove ~/src/KDE/kdelibs/CMakeCache.txt, and try again.}}

{{tip|If <tt>cmakekde</tt> still gives the same error then try this
<code bash>
cd
cmake -DCMAKE_INSTALL_PREFIX=$KDEDIR \
-DCMAKE_BUILD_TYPE=debugfull DKDE4_BUILD_TESTS=ON \
~/src/KDE/kdelibs
make
make install
</code>}}

=== What's Happening ===
We change to the base source directory (line 1) then make and go into the KDE directory (line 2). We download the sources for kdelibs using subversion (line 3), go into the new {{path|~/src/KDE/kdelibs}} directory (line 4), and commence the build (line 5). This will leave us in the <tt>kdelibs</tt> build directory after the build is completed.

{{tip|There might be missing dependencies on your system! They are easily overlooked in the output of <tt>cmakekde</tt>.
You might want to do a <tt>cmake ~/src/KDE/MODULE_NAME</tt> prior to compiling any kde modules (like kdelibs, kdepimlibs etc.)}}

=== Additional KDE-specific CMake modules ===
There are additional CMake modules in {{path|kdelibs/cmake/modules/}} that are necessary for building KDE4 applications. These will be installed for you when kdelibs itself is installed.

=== Troubleshooting ===
If you have problems compiling kdelibs, first make sure the software in the "Required Software" section above is installed and works. Other possible hints include:
* If you received an error stating "Please create a separate build directory and run 'cmake path_to_kdelibs [options]' there." then you need to change to your build directory before running cmakekde. (e.g <tt>cs KDE/kdelibs && cb && cmakekde</tt>)
* If Qt wasn't found or the wrong version of Qt was found, make sure that the qmake from the Qt you need is the first qmake in the path.
* If the problems persist, try the CMake make-option <tt>--keep-going</tt>.
* Here you need the libungif library, otherwise you will get an error message like "<tt>Could NOT find GIF</tt>".
* Qt-4.3 upgrade: if you get a link error in kjsembed talking about QScriptEngine, edit CMakeCache.txt in kdelibs and remove the lines that talk about QT_QTUITOOLS_LIBRARY, then type make again (that static library has a new dependency, and the cmake code that adds it, needs to run).

== kdepimlibs ==
After <tt>kdelibs</tt>, but before ''kdebase'', you need to build and install ''kdepimlibs''.

=== The Recipe ===

<code bash>
cs KDE
svn checkout svn://anonsvn.kde.org/home/kde/trunk/KDE/kdepimlibs
cd kdepimlibs
cmakekde
</code>

=== What's Happening ===
We go into the KDE source directory (line 1), download the source code for kdepimlibs using subversion (line 2) and then go into the new {{path|~/src/KDE/kdepimlibs}} directory (line 3). We then commence the build (line 4). This will leave us in the <tt>kdepimlibs</tt> build directory after the build is completed.

== kdebase ==
You may need kdebase for some kioslaves.

<code bash>
cs KDE
svn checkout svn://anonsvn.kde.org/home/kde/trunk/KDE/kdebase
cd kdebase
cmakekde
</code>
=== Troubleshooting ===
If you have troubles compiling kdebase:
* Make sure you have the <tt>libxss headers</tt> installed. (Usually you got undefined references on xscreensaver objects if you haven't those headers)
* <tt>which meinproc</tt> has to deliver {{path|/home/kde-devel/kde/bin/meinproc}}
* if cmakekde cannot find the path of kdepimlibs, edit the file /home/kde-devel/kdebase-build/CMakeCache.txt and manually set KDEPIMLIBS_INCLUDE_DIR:PATH=/home/kde-devel/kdepimlibs-build
* if you get an error saying "Please set the following variables: X11_XTest_LIB (ADVANCED)", install the devel package of <tt>Xtst</tt>. On some systems, this is packaged separately from <tt>xext</tt> and called <tt>x11proto-xext-dev</tt> or <tt>libxtst-dev</tt>. You may also need to remove the CMakeCache.txt file in the build dir after installing the package.
* the same for "X11_Xinerama_LIB (ADVANCED)" where you will need the devel package for <tt>xinerama</tt>.
* if you get the error "Please set the following variables: FONTCONFIG_INCLUDE_DIR, FONTCONFIG_LIBRARIES (ADVANCED)", then you need to install libfontconfig

== Generating local API documentation ==
Although the API documentation for KDE is available online at [http://api.kde.org api.kde.org], it is sometimes useful to have it on your own disk, for example when you want to use KDevelop for browsing the documentation or when you are not able to be online all the time.

Be aware that generating the API documentation can take several hours and takes almost half a gigabyte of diskspace.
The generation is handled by a script in kdelibs/doc/api, you need ''doxygen'' to be able to run it.

To build the API documentation for kdelibs, type the following:

<code bash>
cs KDE
mkdir apidox
cd apidox
../kdelibs/doc/api/doxygen.sh ../kdelibs/
</code>

== Success! ==

You are now ready to start building other svn modules in the same fashion as you built kdebase, running and testing KDE4 or writing your own patches and applications.

See the [[Getting Started/Set up KDE 4 for development#Nested_KDE_4_session|Starting a KDE4 Environment and Applications]] tutorial for how to start working on your new KDE4 installation.

==References==
<references />

[[Category:Build KDE]]
[[Category:KDE4]]

File:Solitary.png

2007-03-31T20:42:31Z

Fulldecent: Solitary KDE4

Solitary KDE4

File:Snapshot1.png

2007-03-31T20:26:16Z

Fulldecent: Nested KDE 4 session

Nested KDE 4 session

Projects

2007-03-31T18:51:11Z

Fulldecent:

{| style="margin: 1em 2.5% 0 2.5%; padding: 0 5px;" cellpadding="5"
|-
|[[Image:Klogo-official-crystal.svg|noframe|left|40px]] ||
;[http://www.kde.org/getinvolved Get Involved with KDE]
:General information for getting involved with KDE projects. Includes a mentor directory for many projects.
|-
|[[Image:Action_book.svg|noframe|left|40px]] ||
;[[/Edu|KDE Education Project]]
:Developing educational software for KDE.
|-
|[[Image:Klogo-official-crystal.svg|noframe|left|40px]] ||
;[[/Games|KDE Games Project]]
:Developing desktop's games for KDE.
|-
|[[Image:Action_kontact_mail.svg|noframe|left|40px]] ||
;[[/kdepim|KDE PIM Project]]
:KDE Personal Information Management.
|-
|[[Image:Klogo-official-crystal.svg|noframe|left|40px]] ||
;[[/kde.org|kde.org]]
:Information around the *.kde.org websites.
|-
|[[Image:Action_fileprint.svg|noframe|left|40px]] ||
;[[/KDEPrint|KDEPrint]]
:Printing related information for KDE.
|-
|[[Image:Action_pencil.svg|noframe|left|40px]] ||
;[http://wiki.koffice.org KOffice.org]
:Developing an Office suite based on KDE.
|-
|[[Image:logo_oxygen.png|noframe|left|40px]] ||
;[[/Oxygen|The Oxygen Project]]
:Artwork for KDE4.
|-
|[[Image:Action_world.svg|noframe|left|40px]] ||
;[[/Partners|Partner Program]]
:KDE partner program targetting ISVs.
|-
| ||
;[[/Plasma|Plasma]]
:Plasma project. A new way to desktop. (Yes, it's now a verb)
|-
| ||
;[[/KNS2|KNewStuff2]]
:The new cool version of the most famous way to get fresh stuff directly into your desktop
|-
| ||
;[[/Summer_of_Code|Summer of Code Projects]]
:Information on Summer of Code projects and prospects related to KDE
|-
|[[Image:Kopete.svg|noframe|left|40px]] ||
;[[/Kopete|Kopete]]
:Kopete, the KDE Instant Messaging program.
|}

__NOTOC__

Talk:Installing third party softwares in terminal/Build/KDE4

2007-03-30T04:01:21Z

Fulldecent: Extra optional software

==== Q: What is cs and cb? ====

A: '''This is not a typo'''. Read the article about setting up your .bashrc. Both '''cs''' and '''cb''' are bash functions, used to change to the KDE source directory and KDE build directory respectively.

==== Q: Are there build instructions for other OS? ====

A: Actually yes, for [[Getting Started/Build/KDE4/Mac OS X|Mac OS X]]. There also is [http://www.kdelibs.com kdelibs.com] (see also [[User_talk:Jstaniek#KDElibs.com_and_developernew.kde.org_coexistence|here]]) which will be merged into this wiki in the future.

==== Q: Isn't the install prefix, make and make install missing for modules like kdelibs and kdebase? ====
A: No. The shell function ''cmakekde'' handels this, have a look at the file [[Getting_Started/Increased_Productivity_in_KDE4_with_Scripts/.bashrc|.bashrc]].

==== Q: How can I generate API Documentation for other modules? ====
A: Try the following code, replacing <modulename> with your desired module:
cs
mkdir -p apidox
cs apidox
../kdelibs/doc/api/doxygen.sh ../<modulename>/

I tried that and got the following:
<code bash>
kdedev@PC1:~/src/KDE/apidox$ ../kdelibs/doc/api/doxygen.sh ../kdepimlibs/
*** doxygen.sh
* $DOXDATA does not name a directory ( or is unset ), tried "/media/kdedev/home/src/KDE/kdepimlibs/doc/common"
</code>
What is wrong here? -[[User:TMG|TMG]] 23:55, 28 March 2007 (CEST)

==== Q: I changed the first command of the "Set up QT - Recipe" from cd to cs because I think this was a typo. Am I right?? ====
A: Right --[[User:Dhaumann|Dhaumann]]

:: no, it was perfectly intentional. see the [[/Getting_Started/Increased_Productivity_in_KDE4_with_Scripts/.bashrc bashrc in the productivity with KDE4 scripts tutorial]]. it has QTDIR set to ~/qt-copy. this makes sense, actually, since building Qt is done rather differently from the rest of KDE and one may not get Qt from KDE's svn in any case. so yes, it is supposed to be cd, not cs.

::: *blush* ;) i should read more carefully. --[[User:Dhaumann|Dhaumann]]

==== Notes: ~/install ====

When installing KDE4, I strongly recommend installing all tools (like dbus and cmake) and kde packages into the same place, e.g. ~/install. Qt is the only exception.

The reason for this is because if you install some packages to ~/kde and some to /usr/local and maybe one in /usr then cmake will generate errors like:

-- It is impossible to order the include directories.

This is not a fatal error, so you will still be able to compile, but you will possibly be using the wrong versions of libraries and this will product problems that are very hard to diagnose.

You may not experience any problems when installed like I advise not to, however I have and you might too in some typical situations.

Please see:

http://developer.kde.org/build/trunk.html

==== Install CMake modules local ====

The CMake modules should be installed local into ~/install/cmake/modules or similar.
When following the current instructions [[ Getting_Started/Build/KDE4#Install_additional_CMake_modules|6.1: Install additional CMake modules]], it's impossible to do a non-root installation, because "kdelibs/cmake/modules/cmake_install.cmake" wants to install the modules to "/cmake/modules". (I didn't install CMake local, because my system already provided CMake > 2.4.3).

I've already tried to do this, fiddling around with CMAKE_MODULE_PATH and DATA_INSTALL_DIR but couldn't get it working.

Does anybody know how to do this properly?

--[[User:Eliasp|Eliasp]] 15:44, 4 January 2007 (CET)

==== Fixes needed ====
* qt-copy: Should we pass the -debug flag? Doesn't Qt install debug information separately by default anyways? Or is that just in the snapshot? --[[User:Mpyne|Mpyne]]

: according to ./configure --help, the default is -release in snapshot. --[[User:Aseigo|Aseigo]] 04:33, 14 March 2007 (CET)

* In the part of the tutorial that describes how to create a new users, shoudn't to have an edit /etc/sudoers to add permitions for kde-devel call sudo? --[[User:SilveiraNeto|SilveiraNeto]] 03:01, 14 March 2007 (CET)

: no. why would you want them to have sudo access?

==== libungif/giflib ====
Since the patents expired, why not use giflib?

==== Old gcc and -pch flag ====
In Qt part I had problems with error like this: [http://www.qtforum.org/thread.php?threadid=19998 QtForum thread]. I had GCC 3.3.X installed. Using -pch flag (as in recipe) get me errors. Someone friendly gave me tip on #kde-devel not to use this flag, although I didn't test it. Instead I've just updated gcc and g++ from debian repositories. Newer version works fine as "Precompiled headers are supported in GCC (3.4 and newer)" [http://en.wikipedia.org/wiki/Precompiled_header Wikipedia pch].

==== Build status ====

You might want to include the [http://developer.kde.org/~dirk/dashboard/ dashboard link] to show which modules currently build and which don't. --[[User:141.35.8.106|141.35.8.106]] 13:28, 20 March 2007 (CET)

== Extra optional software ==

- openldap
- cyrus

If there was a line at the top like:

sudo apt-get install libaaa-dev libbbb-dev ...-dev ...

This would be very useful and save hours. Is this something we should do?

Getting Started/Build/KDE4

2007-03-29T14:46:58Z

Fulldecent: /* Strigi */

{{TutorialBrowser|

series=Getting Started|

name=Building KDE4 From Source|

pre=[[../../Sources/Anonymous_SVN|Anonymous SVN Quickstart Guide]]|

next=[[../../Set_up_KDE_4_for_development|Starting a KDE4 Environment and Applications]]|

reading=[http://kdesvn-build.kde.org/ kdesvn-build: The KDE From Subversion Build Tool]<br>[[../../Increased_Productivity_in_KDE4_with_Scripts|Increased Productivity in KDE4 with Scripts]]<br>[[Development/Tutorials/CMake |Introduction to CMake]]<br>[[../KDE4/FreeBSD|FreeBSD notes]]<br>[[../KDE4/Mac OS X|Instructions for Mac OS X]]|
}}

== Abstract ==

This tutorial shows one way to get KDE from trunk running on Linux/BSD systems. Throughout the tutorial the bash shell is used. If you are interested in building KDE on other systems such as Solaris, MacOS or Microsoft Windows, please visit the [[../|Build]] page and see the links at the bottom for the respective operating systems.

{{note|Expect a higher risk of build failure Monday when critical changes are implemented. [http://developer.kde.org/~dirk/dashboard/ Dashboard] reports unexpected breakages. You are encouraged to fix failing modules.
}}

== Required Software ==

The following must be installed first before you can successfully complete this tutorial:
* gcc and g++ from the gcc project, preferably version 4.1 or higher
* svn, the subversion revision control client
* pkg-config
* development libraries and headers for X11 and OpenGL
* development libraries and headers for libjpeg, libpng, libungif, libxml2 and libxslt
* the makeobj script. You can install it as part of a kdesdk-scripts (debian) or similar package, or just download it itself from [http://websvn.kde.org/trunk/KDE/kdesdk/scripts/makeobj?revision=600932&view=markup WebSVN]
* the shared-mime-info package, which is the freedesktop MIME standard KDE is using now

You may also want to have the following installed:
* bash

== Create a user account for KDE4 development ==

Some people like to have a separate user account for kde (for instance an old bug deleted files by mistake), and the instructions below were written with that approach.

However it is much more efficient to do everything with a single user account, see http://techbase.kde.org/Getting_Started/Increased_Productivity_in_KDE4_with_Scripts
for more details. You can still follow the instructions below, but don't put the environment variables in your .bashrc, put them in a separate file that you source to switch to the kde4 environment.

=== Option 1: Command Line ===
<code bash>
useradd -m kde-devel
</code>
or:
<code bash>
useradd kde-devel
mkdir /home/kde-devel
passwd kde-devel
chown kde-devel:kde-devel /home/kde-devel 2>/dev/null || \
chown kde-devel:users /home/kde-devel
</code>

=== Option 2: Using KControl ===

Instead of using the commands above, you can also use the User module in the KDE Control Center if you already have KDE3 installed.

=== Setting up the environment ===

Copy the {{path|~/.bashrc}} from your normal user account to the new kde-devel account. Next, copy and paste the contents of the [[Getting Started/Increased Productivity in KDE4 with Scripts/.bashrc|example .bashrc]] into {{path|~kde-devel/.bashrc}}. Be sure to comment out the line <tt>alias make=makeobj</tt> if you do not have the <tt>makeobj</tt> command available, this command comes with the KDE SDK scripts.

This will provide access to commands such as <tt>cmakekde</tt> that are used in this tutorial as well as ensure that the proper paths are in place for Qt, KDE and CMake binaries.

For more information, please read the [[Getting Started/Increased Productivity in KDE4 with Scripts]] tutorial.

=== Switching to the New User ===
Switch to the user kde-devel: (don't forget the dash)
<code bash>
su - kde-devel
</code>

The rest of this tutorial assumes you are running as the <tt>kde-devel</tt> user.

== The development user's shell ==

On some systems a new user is configured by default to use {{path|/bin/sh}}. If this is not the case on your system, you can skip this section. Using {{path|/bin/sh}} can be very inconvenient to work with and you may want to change it to {{path|/bin/bash}} or another shell.

=== Option 1: As the kde-devel user ===

If you don't have root privileges and your system supports the changing of your own shell with the <tt>chsh</tt> application, then you could try to change your shell to /bin/bash by using:
<code bash>
chsh -s /bin/bash kde-devel
</code>

=== Option 2: As the root user ===

If your system comes with the <tt>usermod</tt> application you can run the following command as root: <tt>usermod -s /bin/bash</tt>.
s
Another option is to use the <tt>vipw</tt> application as root to safely edit your {{path|/etc/passwd}}. Locate 'kde-devel' in the the file. Change '{{path|/bin/sh}}' at the end of the line to read '{{path|/bin/bash}}', save your changes and exit.

The new shell will be started automatically when you log in as the kde-devel user again.

== D-Bus ==
QtDBus and KDE are known to work with D-Bus versions 0.62, as well as 0.92 and upwards. Versions 0.60 and 0.61 may work too but are not tested. Versions 0.90 and 0.91 are known not to work. We recommend using post-1.0 release versions (at least 0.94), so consider upgrading if you haven't done so.

You may skip this section if you have a recent D-Bus version or if you don't want to upgrade.

Before running these steps in the recipe, make sure your X11 headers and libraries are available. The configure script run on line 5 should output:
Building X11 code: yes

=== The Recipe ===

{{tip|Check [[Getting Started/Increased Productivity in KDE4 with Scripts]] for some aliases that help with KDE development. These include aliases to switch from the build into the source directory (cs) and back (cb).}}


<code bash>
cs
wget http://dbus.freedesktop.org/releases/dbus/dbus-1.0.2.tar.gz
tar -xvzf dbus-1.0.2.tar.gz
cd dbus-1.0.2/
./configure --prefix=$DBUSDIR --localstatedir=$KDEDIR/var
make
make install
dbus-uuidgen --ensure
</code>

=== What's Happening ===
After changing into the source directory (line 1), D-Bus source code is downloaded from freedesktop.org (line 2) and unpacked (line 3). After going into the newly created D-Bus directory (line 3), the build is set up using the supplied {{path|configure}} script (line 5). After building (line 6) and installing (line 7) D-Bus, we use the <tt>dbus-uuidgen</tt> tool to install a machine identification file that allows the bus to start automatically when the desktop session starts (line 8).

Note that you need write access to {{path|/var}} for the last two steps. If your system does not have the sudo command, you can use the <tt>su</tt> command instead, e.g. <tt>su -c "make install"</tt>.

== CMake ==
Skip this if you have [http://cmake.org/ CMake] >=2.4.5 installed.
You should be able to directly use the binary packages available on the [http://www.cmake.org/HTML/Download.html CMake site]. There are also distribution specific packages available.
CMake binary packages for openSUSE are available from [http://software.opensuse.org/download/devel:/tools:/building/ openSUSE build service].

=== The Recipe ===

<code bash>
cs
wget http://www.cmake.org/files/v2.4/cmake-2.4.6.tar.gz
tar zxf cmake-2.4.6.tar.gz
mkdir cmake-build
cd cmake-build
../cmake-2.4.6/bootstrap
make
sudo make install
</code>

=== What's Happening ===
First, we go back to the <tt>kde-devel</tt> user's source directory (line 1), get the CMake sources (line 2) and unpack them (line 3). We create a directory to build CMake in (line 4) and go into it (line 5). We then run the CMake boostrap script to set up the CMake build (line 6), then make (line 7) and install it (line 8) using the root user.

If your system does not have the <tt>sudo</tt> command, you can instead do <tt>su -c "make install"</tt>.

== Qt ==
Next we need to get the Qt4 that is in KDE's source repository. KDE is guaranteed to build against any Qt 4.3. That is still an unreleased version, so your distribution probably doesn't have packages for it. You should use the copy in the KDE Subversion servers.

KDE is no longer supported on Qt 4.2 and earlier versions.

Hint: This part may take some time depending on what kind of hardware your computer is running.

=== The Recipe ===
<code bash>
cd
svn checkout svn://anonsvn.kde.org/home/kde/trunk/qt-copy
cd qt-copy
./apply_patches
./configure -qt-gif -no-exceptions -debug -fast \
-prefix $QTDIR -qdbus -pch -nomake examples \
-nomake demos
make sub-src sub-tools
# make install: only if QTDIR is not the current directory!
make install
</code>

=== What's Happening ===
We switch back to the <tt>kde-devel</tt> user's home directory (line 1) and download the source code using subversion (svn) from KDE's repository (line 2). After changing into the resulting {{path|qt-copy}} directory (line 3), we run a script that manages the patches that come with <tt>qt-copy</tt> (line 4).

Once the patches have been applied, we then set up the build using the <tt>configure</tt> script (line 5-6). The various command line options used are explained in the {{path|qt-copy/README.qt-copy}} file. Finally, we build the minimal requirements for KDE (line 7) and install (line 8) Qt. If you want all the example and demo applications, you can either build them individually or simply do a <tt>make</tt> from the {{path|qt-copy}} directory. Note that the installation does not require root as it installs it locally into {{path|qt-copy}} itself.

=== Troubleshooting ===
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}}. If it crashes in QSpanData::adjustSpanMethods, then your problem is the oxygen style. Try removing {{path|/lib/kde4/plugins/styles/kstyle-oxygen.so}} and {{path|/lib/kde4/plugins/styles/oxygen.so}} if they exist.

== Strigi ==

{{warning|If you have jumped to this section without reading section 3.3 Setting Up The Environment '''the recipes provided will not work'''. The recipes are not in error; <tt>cs</tt> and <tt>cb</tt> are not typos. You '''must''' follow the instructions in section 3.3 for this tutorial to work for you.}}

The code for getting at file metadata now relies on Strigi. To install Strigi you need the libraries and headers for libz, libbz2, openssl (libcrypto or libssl), libclucene (>=0.9.16), and either libxml2 or libexpat.

=== The Recipe ===

<code bash>
cs
svn checkout svn://anonsvn.kde.org/home/kde/trunk/kdesupport/strigi
cd strigi
cmakekde
</code>

=== What's Happening ===
We change to the base source directory (line 1). We download the sources for strigi using subversion (line 2), go into the new ~/src/strigi directory (line 3), and commence the build (line 4). This will leave us in the strigi build directory after the build is completed.

== kdelibs ==

With Qt4 and Strigi built, we can now move on to building KDE's base libraries. If you use the aforementioned [[Getting Started/Increased Productivity in KDE4 with Scripts/.bashrc|.bashrc]] this is where those new functions come in handy.

Hint: This part may take some time depending on what kind of hardware your computer is running.

=== The Recipe ===

<code bash>
cd $KDE_SRC
mkdir KDE && cd KDE
svn checkout svn://anonsvn.kde.org/home/kde/trunk/KDE/kdelibs
cd kdelibs
cmakekde
</code>

{{tip|If this command fails stating that CMake requires an out of source build directory, remove ~/src/KDE/kdelibs/CMakeCache.txt, and try again.}}

{{tip|If <tt>cmakekde</tt> still gives the same error then try this
<code bash>
cd
cmake -DCMAKE_INSTALL_PREFIX=$KDEDIR \
-DCMAKE_BUILD_TYPE=debugfull DKDE4_BUILD_TESTS=ON \
~/src/KDE/kdelibs
make
make install
</code>}}

=== What's Happening ===
We change to the base source directory (line 1) then make and go into the KDE directory (line 2). We download the sources for kdelibs using subversion (line 3), go into the new {{path|~/src/KDE/kdelibs}} directory (line 4), and commence the build (line 5). This will leave us in the <tt>kdelibs</tt> build directory after the build is completed.

{{tip|There might be missing dependencies on your system! They are easily overlooked in the output of <tt>cmakekde</tt>.
You might want to do a <tt>cmake ~/src/KDE/MODULE_NAME</tt> prior to compiling any kde modules (like kdelibs, kdepimlibs etc.)}}

=== Additional KDE-specific CMake modules ===
There are additional CMake modules in {{path|kdelibs/cmake/modules/}} that are necessary for building KDE4 applications. These will be installed for you when kdelibs itself is installed.

=== Troubleshooting ===
If you have problems compiling kdelibs, first make sure the software in the "Required Software" section above is installed and works. Other possible hints include:
* If you received an error stating "Please create a separate build directory and run 'cmake path_to_kdelibs [options]' there." then you need to change to your build directory before running cmakekde. (e.g <tt>cs KDE/kdelibs && cb && cmakekde</tt>)
* If Qt wasn't found or the wrong version of Qt was found, make sure that the qmake from the Qt you need is the first qmake in the path.
* If the problems persist, try the CMake make-option <tt>--keep-going</tt>.
* Here you need the libungif library, otherwise you will get an error message like "<tt>Could NOT find GIF</tt>".
* Qt-4.3 upgrade: if you get a link error in kjsembed talking about QScriptEngine, edit CMakeCache.txt in kdelibs and remove the lines that talk about QT_QTUITOOLS_LIBRARY, then type make again (that static library has a new dependency, and the cmake code that adds it, needs to run).

== kdepimlibs ==
After <tt>kdelibs</tt>, but before ''kdebase'', you need to build and install ''kdepimlibs''.

=== The Recipe ===

<code bash>
cs KDE
svn checkout svn://anonsvn.kde.org/home/kde/trunk/KDE/kdepimlibs
cd kdepimlibs
cmakekde
</code>

=== What's Happening ===
We go into the KDE source directory (line 1), download the source code for kdepimlibs using subversion (line 2) and then go into the new {{path|~/src/KDE/kdepimlibs}} directory (line 3). We then commence the build (line 4). This will leave us in the <tt>kdepimlibs</tt> build directory after the build is completed.

== kdebase ==
You may need kdebase for some kioslaves.

<code bash>
cs KDE
svn checkout svn://anonsvn.kde.org/home/kde/trunk/KDE/kdebase
cd kdebase
cmakekde
</code>
=== Troubleshooting ===
If you have troubles compiling kdebase:
* Make sure you have the <tt>libxss headers</tt> installed. (Usually you got undefined references on xscreensaver objects if you haven't those headers)
* <tt>which meinproc</tt> has to deliver {{path|/home/kde-devel/kde/bin/meinproc}}
* if cmakekde cannot find the path of kdepimlibs, edit the file /home/kde-devel/kdebase-build/CMakeCache.txt and manually set KDEPIMLIBS_INCLUDE_DIR:PATH=/home/kde-devel/kdepimlibs-build
* if you get an error saying "Please set the following variables: X11_XTest_LIB (ADVANCED)", install the devel package of <tt>Xtst</tt>. On some systems, this is packaged separately from <tt>xext</tt> and called <tt>x11proto-xext-dev</tt> or <tt>libxtst-dev</tt>. You may also need to remove the CMakeCache.txt file in the build dir after installing the package.
* the same for "X11_Xinerama_LIB (ADVANCED)" where you will need the devel package for <tt>xinerama</tt>.
* if you get the error "Please set the following variables: FONTCONFIG_INCLUDE_DIR, FONTCONFIG_LIBRARIES (ADVANCED)", then you need to install libfontconfig

== Generating local API documentation ==
Although the API documentation for KDE is available online at [http://api.kde.org api.kde.org], it is sometimes useful to have it on your own disk, for example when you want to use KDevelop for browsing the documentation or when you are not able to be online all the time.

Be aware that generating the API documentation can take several hours and takes almost half a gigabyte of diskspace.
The generation is handled by a script in kdelibs/doc/api, you need ''doxygen'' to be able to run it.

To build the API documentation for kdelibs, type the following:

<code bash>
cs KDE
mkdir apidox
cd apidox
../kdelibs/doc/api/doxygen.sh ../kdelibs/
</code>

== Success! ==

You are now ready to start building other svn modules in the same fashion as you built kdebase, running and testing KDE4 or writing your own patches and applications.

See the [[Getting Started/Set up KDE 4 for development|Starting a KDE4 Environment and Applications]] tutorial for how to start working on your new KDE4 installation.

==References==
<references />

[[Category:Build KDE]]
[[Category:KDE4]]

Getting Started/Build/KDE4

2007-03-29T00:00:41Z

Fulldecent: update command chsh to be consistent

{{TutorialBrowser|

series=Getting Started|

name=Building KDE4 From Source|

pre=[[../../Sources/Anonymous_SVN|Anonymous SVN Quickstart Guide]]|

next=[[../../Set_up_KDE_4_for_development|Starting a KDE4 Environment and Applications]]|

reading=[http://kdesvn-build.kde.org/ kdesvn-build: The KDE From Subversion Build Tool]<br>[[../../Increased_Productivity_in_KDE4_with_Scripts|Increased Productivity in KDE4 with Scripts]]<br>[[Development/Tutorials/CMake |Introduction to CMake]]<br>[[../KDE4/FreeBSD|FreeBSD notes]]<br>[[../KDE4/Mac OS X|Instructions for Mac OS X]]|
}}

== Abstract ==

This tutorial shows one way to get KDE from trunk running on Linux/BSD systems. Throughout the tutorial the bash shell is used. If you are interested in building KDE on other systems such as Solaris, MacOS or Microsoft Windows, please visit the [[../|Build]] page and see the links at the bottom for the respective operating systems.

{{note|Expect a higher risk of build failure Monday when critical changes are implemented. [http://developer.kde.org/~dirk/dashboard/ Dashboard] reports unexpected breakages. You are encouraged to fix failing modules.
}}

== Required Software ==

The following must be installed first before you can successfully complete this tutorial:
* gcc and g++ from the gcc project, preferably version 4.1 or higher
* svn, the subversion revision control client
* pkg-config
* development libraries and headers for X11 and OpenGL
* development libraries and headers for libjpeg, libpng, libungif, libxml2 and libxslt
* the makeobj script. You can install it as part of a kdesdk-scripts (debian) or similar package, or just download it itself from [http://websvn.kde.org/trunk/KDE/kdesdk/scripts/makeobj?revision=600932&view=markup WebSVN]
* the shared-mime-info package, which is the freedesktop MIME standard KDE is using now

You may also want to have the following installed:
* bash

== Create a user account for KDE4 development ==

=== Option 1: Command Line ===
<code bash>
useradd -m kde-devel
</code>
or:
<code bash>
useradd kde-devel
mkdir /home/kde-devel
passwd kde-devel
chown kde-devel:kde-devel /home/kde-devel 2>/dev/null || \
chown kde-devel:users /home/kde-devel
</code>

=== Option 2: Using KControl ===

Instead of using the commands above, you can also use the User module in the KDE Control Center if you already have KDE3 installed.

=== Setting up the environment ===

Copy the {{path|~/.bashrc}} from your normal user account to the new kde-devel account. Next, copy and paste the contents of the [[Getting Started/Increased Productivity in KDE4 with Scripts/.bashrc|example .bashrc]] into {{path|~kde-devel/.bashrc}}. Be sure to comment out the line <tt>alias make=makeobj</tt> if you do not have the <tt>makeobj</tt> command available, this command comes with the KDE SDK scripts.

This will provide access to commands such as <tt>cmakekde</tt> that are used in this tutorial as well as ensure that the proper paths are in place for Qt, KDE and CMake binaries.

For more information, please read the [[Getting Started/Increased Productivity in KDE4 with Scripts]] tutorial.

=== Switching to the New User ===
Switch to the user kde-devel: (don't forget the dash)
<code bash>
su - kde-devel
</code>

The rest of this tutorial assumes you are running as the <tt>kde-devel</tt> user.

== The development user's shell ==

On some systems a new user is configured by default to use {{path|/bin/sh}}. If this is not the case on your system, you can skip this section. Using {{path|/bin/sh}} can be very inconvenient to work with and you may want to change it to {{path|/bin/bash}} or another shell.

=== Option 1: As the kde-devel user ===

If you don't have root privileges and your system supports the changing of your own shell with the <tt>chsh</tt> application, then you could try to change your shell to /bin/bash by using:
<code bash>
chsh -s /bin/bash kde-devel
</code>

=== Option 2: As the root user ===

If your system comes with the <tt>usermod</tt> application you can run the following command as root: <tt>usermod -s /bin/bash</tt>.
s
Another option is to use the <tt>vipw</tt> application as root to safely edit your {{path|/etc/passwd}}. Locate 'kde-devel' in the the file. Change '{{path|/bin/sh}}' at the end of the line to read '{{path|/bin/bash}}', save your changes and exit.

The new shell will be started automatically when you log in as the kde-devel user again.

== D-Bus ==
QtDBus and KDE are known to work with D-Bus versions 0.62, as well as 0.92 and upwards. Versions 0.60 and 0.61 may work too but are not tested. Versions 0.90 and 0.91 are known not to work. We recommend using post-1.0 release versions (at least 0.94), so consider upgrading if you haven't done so.

You may skip this section if you have a recent D-Bus version or if you don't want to upgrade.

Before running these steps in the recipe, make sure your X11 headers and libraries are available. The configure script run on line 5 should output:
Building X11 code: yes

=== The Recipe ===

{{tip|Check [[Getting Started/Increased Productivity in KDE4 with Scripts]] for some aliases that help with KDE development. These include aliases to switch from the build into the source directory (cs) and back (cb).}}


<code bash>
cs
wget http://dbus.freedesktop.org/releases/dbus/dbus-1.0.2.tar.gz
tar -xvzf dbus-1.0.2.tar.gz
cd dbus-1.0.2/
./configure --prefix=$DBUSDIR --localstatedir=$KDEDIR/var
make
make install
dbus-uuidgen --ensure
</code>

=== What's Happening ===
After changing into the source directory (line 1), D-Bus source code is downloaded from freedesktop.org (line 2) and unpacked (line 3). After going into the newly created D-Bus directory (line 3), the build is set up using the supplied {{path|configure}} script (line 5). After building (line 6) and installing (line 7) D-Bus, we use the <tt>dbus-uuidgen</tt> tool to install a machine identification file that allows the bus to start automatically when the desktop session starts (line 8).

Note that you need write access to {{path|/var}} for the last two steps. If your system does not have the sudo command, you can use the <tt>su</tt> command instead, e.g. <tt>su -c "make install"</tt>.

== CMake ==
Skip this if you have [http://cmake.org/ CMake] >=2.4.5 installed.
You should be able to directly use the binary packages available on the [http://www.cmake.org/HTML/Download.html CMake site]. There are also distribution specific packages available.
CMake binary packages for openSUSE are available from [http://software.opensuse.org/download/devel:/tools:/building/ openSUSE build service].

=== The Recipe ===

<code bash>
cs
wget http://www.cmake.org/files/v2.4/cmake-2.4.6.tar.gz
tar zxf cmake-2.4.6.tar.gz
mkdir cmake-build
cd cmake-build
../cmake-2.4.6/bootstrap
make
sudo make install
</code>

=== What's Happening ===
First, we go back to the <tt>kde-devel</tt> user's source directory (line 1), get the CMake sources (line 2) and unpack them (line 3). We create a directory to build CMake in (line 4) and go into it (line 5). We then run the CMake boostrap script to set up the CMake build (line 6), then make (line 7) and install it (line 8) using the root user.

If your system does not have the <tt>sudo</tt> command, you can instead do <tt>su -c "make install"</tt>.

== Qt ==
Next we need to get the Qt4 that is in KDE's source repository. KDE is guaranteed to build against any Qt 4.3. That is still an unreleased version, so your distribution probably doesn't have packages for it. You should use the copy in the KDE Subversion servers.

KDE is no longer supported on Qt 4.2 and earlier versions.

Hint: This part may take some time depending on what kind of hardware your computer is running.

=== The Recipe ===
<code bash>
cd
svn checkout svn://anonsvn.kde.org/home/kde/trunk/qt-copy
cd qt-copy
./apply_patches
./configure -qt-gif -no-exceptions -debug -fast \
-prefix $QTDIR -qdbus -pch -nomake examples \
-nomake demos
make sub-src sub-tools
# make install: only if QTDIR is not the current directory!
make install
</code>

=== What's Happening ===
We switch back to the <tt>kde-devel</tt> user's home directory (line 1) and download the source code using subversion (svn) from KDE's repository (line 2). After changing into the resulting {{path|qt-copy}} directory (line 3), we run a script that manages the patches that come with <tt>qt-copy</tt> (line 4).

Once the patches have been applied, we then set up the build using the <tt>configure</tt> script (line 5-6). The various command line options used are explained in the {{path|qt-copy/README.qt-copy}} file. Finally, we build the minimal requirements for KDE (line 7) and install (line 8) Qt. If you want all the example and demo applications, you can either build them individually or simply do a <tt>make</tt> from the {{path|qt-copy}} directory. Note that the installation does not require root as it installs it locally into {{path|qt-copy}} itself.

=== Troubleshooting ===
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}}. If it crashes in QSpanData::adjustSpanMethods, then your problem is the oxygen style. Try removing {{path|/lib/kde4/plugins/styles/kstyle-oxygen.so}} and {{path|/lib/kde4/plugins/styles/oxygen.so}} if they exist.

== Strigi ==

{{warning|If you have jumped to this section without reading section 3.3 Setting Up The Environment '''the recipes provided will not work'''. The recipes are not in error; <tt>cs</tt> and <tt>cb</tt> are not typos. You '''must''' follow the instructions in section 3.3 for this tutorial to work for you.}}

The code for getting at file metadata now relies on Strigi. To install Strigi you need the libraries and headers for libz, libbz2, openssl (libcrypto), libclucene (>=0.9.16), and either libxml2 or libexpat.

=== The Recipe ===

<code bash>
cs
svn checkout svn://anonsvn.kde.org/home/kde/trunk/kdesupport/strigi
cd strigi
cmakekde
</code>

=== What's Happening ===
We change to the base source directory (line 1). We download the sources for strigi using subversion (line 2), go into the new ~/src/strigi directory (line 3), and commence the build (line 4). This will leave us in the strigi build directory after the build is completed.

== kdelibs ==

With Qt4 and Strigi built, we can now move on to building KDE's base libraries. If you use the aforementioned [[Getting Started/Increased Productivity in KDE4 with Scripts/.bashrc|.bashrc]] this is where those new functions come in handy.

Hint: This part may take some time depending on what kind of hardware your computer is running.

=== The Recipe ===

<code bash>
cd $KDE_SRC
mkdir KDE && cd KDE
svn checkout svn://anonsvn.kde.org/home/kde/trunk/KDE/kdelibs
cd kdelibs
cmakekde
</code>

{{tip|If this command fails stating that CMake requires an out of source build directory, remove ~/src/KDE/kdelibs/CMakeCache.txt, and try again.}}

{{tip|If <tt>cmakekde</tt> still gives the same error then try this
<code bash>
cd
cmake -DCMAKE_INSTALL_PREFIX=$KDEDIR \
-DCMAKE_BUILD_TYPE=debugfull DKDE4_BUILD_TESTS=ON \
~/src/KDE/kdelibs
make
make install
</code>}}

=== What's Happening ===
We change to the base source directory (line 1) then make and go into the KDE directory (line 2). We download the sources for kdelibs using subversion (line 3), go into the new {{path|~/src/KDE/kdelibs}} directory (line 4), and commence the build (line 5). This will leave us in the <tt>kdelibs</tt> build directory after the build is completed.

{{tip|There might be missing dependencies on your system! They are easily overlooked in the output of <tt>cmakekde</tt>.
You might want to do a <tt>cmake ~/src/KDE/MODULE_NAME</tt> prior to compiling any kde modules (like kdelibs, kdepimlibs etc.)}}

=== Additional KDE-specific CMake modules ===
There are additional CMake modules in {{path|kdelibs/cmake/modules/}} that are necessary for building KDE4 applications. These will be installed for you when kdelibs itself is installed.

=== Troubleshooting ===
If you have problems compiling kdelibs, first make sure the software in the "Required Software" section above is installed and works. Other possible hints include:
* If you received an error stating "Please create a separate build directory and run 'cmake path_to_kdelibs [options]' there." then you need to change to your build directory before running cmakekde. (e.g <tt>cs KDE/kdelibs && cb && cmakekde</tt>)
* If Qt wasn't found or the wrong version of Qt was found, make sure that the qmake from the Qt you need is the first qmake in the path.
* If the problems persist, try the CMake make-option <tt>--keep-going</tt>.
* Here you need the libungif library, otherwise you will get an error message like "<tt>Could NOT find GIF</tt>".
* Qt-4.3 upgrade: if you get a link error in kjsembed talking about QScriptEngine, edit CMakeCache.txt in kdelibs and remove the lines that talk about QT_QTUITOOLS_LIBRARY, then type make again (that static library has a new dependency, and the cmake code that adds it, needs to run).

== kdepimlibs ==
After <tt>kdelibs</tt>, but before ''kdebase'', you need to build and install ''kdepimlibs''.

=== The Recipe ===

<code bash>
cs KDE
svn checkout svn://anonsvn.kde.org/home/kde/trunk/KDE/kdepimlibs
cd kdepimlibs
cmakekde
</code>

=== What's Happening ===
We go into the KDE source directory (line 1), download the source code for kdepimlibs using subversion (line 2) and then go into the new {{path|~/src/KDE/kdepimlibs}} directory (line 3). We then commence the build (line 4). This will leave us in the <tt>kdepimlibs</tt> build directory after the build is completed.

== kdebase ==
You may need kdebase for some kioslaves.

<code bash>
cs KDE
svn checkout svn://anonsvn.kde.org/home/kde/trunk/KDE/kdebase
cd kdebase
cmakekde
</code>
=== Troubleshooting ===
If you have troubles compiling kdebase:
* Make sure you have the <tt>libxss headers</tt> installed. (Usually you got undefined references on xscreensaver objects if you haven't those headers)
* <tt>which meinproc</tt> has to deliver {{path|/home/kde-devel/kde/bin/meinproc}}
* if cmakekde cannot find the path of kdepimlibs, edit the file /home/kde-devel/kdebase-build/CMakeCache.txt and manually set KDEPIMLIBS_INCLUDE_DIR:PATH=/home/kde-devel/kdepimlibs-build
* if you get an error saying "Please set the following variables: X11_XTest_LIB (ADVANCED)", install the devel package of <tt>Xtst</tt>. On some systems, this is packaged separately from <tt>xext</tt> and called <tt>x11proto-xext-dev</tt> or <tt>libxtst-dev</tt>. You may also need to remove the CMakeCache.txt file in the build dir after installing the package.
* the same for "X11_Xinerama_LIB (ADVANCED)" where you will need the devel package for <tt>xinerama</tt>.
* if you get the error "Please set the following variables: FONTCONFIG_INCLUDE_DIR, FONTCONFIG_LIBRARIES (ADVANCED)", then you need to install libfontconfig

== Generating local API documentation ==
Although the API documentation for KDE is available online at [http://api.kde.org api.kde.org], it is sometimes useful to have it on your own disk, for example when you want to use KDevelop for browsing the documentation or when you are not able to be online all the time.

Be aware that generating the API documentation can take several hours and takes almost half a gigabyte of diskspace.
The generation is handled by a script in kdelibs/doc/api, you need ''doxygen'' to be able to run it.

To build the API documentation for kdelibs, type the following:

<code bash>
cs KDE
mkdir apidox
cd apidox
../kdelibs/doc/api/doxygen.sh ../kdelibs/
</code>

== Success! ==

You are now ready to start building other svn modules in the same fashion as you built kdebase, running and testing KDE4 or writing your own patches and applications.

See the [[Getting Started/Set up KDE 4 for development|Starting a KDE4 Environment and Applications]] tutorial for how to start working on your new KDE4 installation.

==References==
<references />

[[Category:Build KDE]]
[[Category:KDE4]]

Getting Started/Build/KDE4

2006-11-04T18:10:24Z

Fulldecent:

This article shows how to download, build, install and start KDE 4 from subversion. It consolidates howtos from various sites, e.g.
http://developer.kde.org/build/compile_cvs.html.
This topic shows one way that works. It does not intend to explain the obvious background behind it.

You may be interested in: http://kdesvn-build.kde.org/

To reduce complexity, we use the bash-shell (standard) throughout the tutorial.

== Become the user kde-devel ==
useradd kde-devel
mkdir /home/kde-devel
passwd kde-devel
chown kde-devel:kde-devel /home/kde-devel 2>/dev/null || \
chown kde-devel:users /home/kde-devel

Switch to the user kde-devel: (the dash also changes to the new home directory)
su - kde-devel

== Set Environment Variables ==
You have to add some environment variables - add these lines to {{path|~/.bashrc}}.
export YACC='byacc -d'
export QTDIR=$HOME/qt-unstable
export KDEDIR=$HOME/kde
export KDEDIRS=$KDEDIR
export DBUSDIR=$KDEDIR
export PKG_CONFIG_PATH=$DBUSDIR/lib/pkgconfig:$PKG_CONFIG_PATH
export PATH=$QTDIR/bin:$KDEDIR/bin:$PATH
export LD_LIBRARY_PATH=$QTDIR/lib:$KDEDIR/lib:$LD_LIBRARY_PATH
## Uncomment if dbus doesn't work
#alias dbusstart="eval `PATH=$DBUSDIR/bin \
#$DBUSDIR/bin/dbus-launch --auto-syntax`"
function cmakekde { cmake -DCMAKE_INSTALL_PREFIX=$HOME/kde \
-DCMAKE_BUILD_TYPE=debugfull $@ && make VERBOSE=1 && make install; }

== Check out the software ==
svn co svn://anonsvn.kde.org/home/kde/trunk/qt-copy
svn co svn://anonsvn.kde.org/home/kde/trunk/KDE/kdelibs
wget http://www.cmake.org/files/v2.4/cmake-2.4.3.tar.gz
wget http://dbus.freedesktop.org/releases/dbus/dbus-0.94.tar.gz

== Build D-Bus ==
tar xvfz dbus-0.94.tar.gz
cd dbus-0.94/
./configure --disable-qt --disable-qt3 --prefix=$DBUSDIR \
--localstatedir=/var && make && make install

== Build Qt ==
cd ~/qt-copy && \
./configure -qt-gif -no-exceptions -debug -fast \
-prefix $QTDIR -qdbus && make && make install

== Build and Install CMake ==

The default prefix is <code>/usr/local</code>, make sure {{path|/usr/local/bin}} is in your <code>$PATH</code>.

tar zxf cmake-2.4.3.tar.gz
mkdir cmake-build
cd cmake-build
../cmake-2.4.3/bootstrap
make
sudo make install

== Build kdelibs ==
cd ~/
mkdir kdelibs-build
cd kdelibs-build
cmakekde ../kdelibs

=== Troubleshooting ===
If you have problems compiling this, first make sure the following commands can be executed: aclocal, autoconf, autoheader, gcc, g++, pkg-config.

; Note: If you get "Could NOT find GIF", install the devel package of <code>libungif</code> (the actual name may vary on distribution).

If the problems persist, try the make-option <code>--keep-going</code>

== Build kdepimlibs ==
Before ''kdebase'' you need to install ''kdepimlibs''

cd
svn co svn://anonsvn.kde.org/home/kde/trunk/KDE/kdepimlibs
mkdir kdepimlibs-build
cd kdepimlibs-build
cmakekde ../kdepimlibs

=== Troubleshooting ===
To compile against kdelibs (not the snapshot) add
set(KDE4_IGNORE_DONTPORT TRUE)
to the {{path|CMakeLists.txt}} before <code>find_package(KDE4 REQUIRED)</code>

== Build kdebase ==
You may need kdebase for some kioslaves.
cd
svn co svn://anonsvn.kde.org/home/kde/trunk/KDE/kdebase
mkdir kdebase-build
cd kdebase-build
cmakekde ../kdebase

=== Troubleshooting ===
If you have troubles compiling this:
* Make sure you have the <code>libxss headers</code> installed. (Usually you got undefined references on xscreensaver objects if you haven't those headers)
* <code>which meinproc</code> has to deliver {{path|/home/kde-devel/kde/bin/meinproc}}

== Start KDE 4 Programs ==
To start the desktop environment itself, do:
X :1 & export DISPLAY=:1
startkde
Maybe you are logged in as your normal user (not kde-devel), want to stay in your current environment (KDE 3.5, gnome, whatever) and start a KDE 4 program. To start only kwrite from KDE 4, do:
ssh -X kde-devel@localhost
kwrite

== Additional notes: ==
http://wiki.kde.org/tiki-index.php?page=KDECMakeIntro

[[Category:Build KDE]]
[[Category:KDE4]]

Getting Started/Build/KDE4

2006-10-31T07:30:40Z

Fulldecent:

This article shows how to download, build, install and start KDE 4 from subversion. It consolidates howtos from various sites, e.g.
http://developer.kde.org/build/compile_cvs.html.
This topic shows one way that works. It does not intend to explain the obvious background behind it.

You may be interested in: http://kdesvn-build.kde.org/

To reduce complexity, we use the bash-shell (standard) throughout the tutorial.

== Become the user kde-devel ==
useradd kde-devel
mkdir /home/kde-devel
passwd kde-devel
chown kde-devel:kde-devel /home/kde-devel 2>/dev/null || \
chown kde-devel:users /home/kde-devel

Switch to the user kde-devel: (the dash also changes to the new home directory)
su - kde-devel

== Set Environment Variables ==
You have to add some environment variables - add these lines to {{path|~/.bashrc}}.
export YACC='byacc -d'
export QTDIR=$HOME/qt-unstable
export KDEDIR=$HOME/kde
export KDEDIRS=$KDEDIR
export DBUSDIR=$KDEDIR
export PKG_CONFIG_PATH=$DBUSDIR/lib/pkgconfig:$PKG_CONFIG_PATH
export PATH=$QTDIR/bin:$KDEDIR/bin:$PATH
export LD_LIBRARY_PATH=$QTDIR/lib:$KDEDIR/lib:$LD_LIBRARY_PATH
alias dbusstart="eval `PATH=$DBUSDIR/bin \
$DBUSDIR/bin/dbus-launch --auto-syntax`"
function cmakekde { cmake -DCMAKE_INSTALL_PREFIX=$HOME/kde \
-DCMAKE_BUILD_TYPE=debugfull $@ && make VERBOSE=1 && make install; }

== Check out the software ==
svn co svn://anonsvn.kde.org/home/kde/trunk/qt-copy
svn co svn://anonsvn.kde.org/home/kde/trunk/KDE/kdelibs
wget http://www.cmake.org/files/v2.4/cmake-2.4.3.tar.gz
wget http://dbus.freedesktop.org/releases/dbus-0.91.tar.gz

== Build D-Bus ==
tar xvfz dbus-0.91.tar.gz
cd dbus-0.91/
./configure --disable-qt --disable-qt3 --prefix=$DBUSDIR \
--localstatedir=/var && make && su -c "make install"

'''Make sure the dbus session is running'''. Otherwise some parts of the build will fail, e.g. <code>kxml_compiler</code> based file processing in kdepim:
dbusstart

== Build Qt ==
cd ~/qt-copy && \
./configure -qt-gif -no-exceptions -debug -fast \
-prefix $QTDIR -qdbus && make && make install

== Build and Install CMake ==

The default prefix is <code>/usr/local</code>, make sure {{path|/usr/local/bin}} is in your <code>$PATH</code>.

tar zxf cmake-2.4.3.tar.gz
mkdir cmake-build
cd cmake-build
../cmake-2.4.3/bootstrap
make
sudo make install

== Build kdelibs ==
cd ~/
mkdir kdelibs-build
cd kdelibs-build
cmakekde ../kdelibs

=== Troubleshooting ===
If you have problems compiling this, first make sure the following commands can be executed: aclocal, autoconf, autoheader, gcc, g++, pkg-config.

; Note: If you get "Could NOT find GIF", install the devel package of <code>libungif</code> (the actual name may vary on distribution).

If the problems persist, try the make-option <code>--keep-going</code>

== Build kdepimlibs ==
Before ''kdebase'' you need to install ''kdepimlibs''

cd
svn co svn://anonsvn.kde.org/home/kde/trunk/KDE/kdepimlibs
mkdir kdepimlibs-build
cd kdepimlibs-build
cmakekde ../kdepimlibs

=== Troubleshooting ===
To compile against kdelibs (not the snapshot) add
set(KDE4_IGNORE_DONTPORT TRUE)
to the {{path|CMakeLists.txt}} before <code>find_package(KDE4 REQUIRED)</code>

== Build kdebase ==
You may need kdebase for some kioslaves.
cd
svn co svn://anonsvn.kde.org/home/kde/trunk/KDE/kdebase
mkdir kdebase-build
cd kdebase-build
cmakekde ../kdebase

=== Troubleshooting ===
If you have troubles compiling this:
* Make sure you have the <code>libxss headers</code> installed. (Usually you got undefined references on xscreensaver objects if you haven't those headers)
* <code>which meinproc</code> has to deliver {{path|/home/kde-devel/kde/bin/meinproc}}

== Start KDE 4 Programs ==
To start the desktop environment itself, do:
X :1 & export DISPLAY=:1
startkde
Maybe you are logged in as your normal user (not kde-devel), want to stay in your current environment (KDE 3.5, gnome, whatever) and start a KDE 4 program. To start only kwrite from KDE 4, do:
ssh -X kde-devel@localhost
kwrite

[[Category:Build KDE]]
[[Category:KDE4]]

Getting Started

2006-10-02T04:45:58Z

Fulldecent:

Welcome to the Compile KDE portal.

<div style="margin: 0; border: 1px solid #1e90ff; padding: 0 1em 1em 1em; background-color:#F8F8FF; align:right;">
<div style="float:right; margin-top:0.8em; margin-left:0.8em">[[Image:Action_down.svg|left|32px]]</div>
== Getting the Source ==

KDE's source code is available in several ways:
* [[/Sources/Anonymous SVN|Anonymous SVN]]
* [http://websvn.kde.org/ Browse Code Online]
* [ftp://ftp.kde.org/pub/kde/unstable/snapshots/ Daily Snapshots]
</div>
<br/>
<div style="margin: 0; border: 1px solid #1e90ff; padding: 0 1em 1em 1em; background-color:#F8F8FF; align:right;">
<div style="float:right; margin-top:0.8em; margin-left:0.8em">[[Image:Action_build.png|left|32px]]</div>

== Build KDE ==

There are different KDE branches. For production use, a stable version of KDE is recommended.
* [[/Build/Stable Version|Stable version (branch)]]
* [[/Build/Unstable Version|Unstable version (trunk)]]
* [[/Build|Other versions and FAQ]]
</div>
[[Category:Build KDE]]

Getting Started

2006-10-02T04:43:25Z

Fulldecent: /* Getting the Source */

Welcome to the Compile KDE portal.

<div style="margin: 0; border: 1px solid #1e90ff; padding: 0 1em 1em 1em; background-color:#F8F8FF; align:right;">
<div style="float:right; margin-top:0.8em; margin-left:0.8em">[[Image:Action_down.svg|left|32px]]</div>
== Getting the Source ==

KDE's source code is available in several ways:
* [[/Sources/Anonymous SVN|Anonymous SVN]]
* [http://websvn.kde.org/ Browse Code Online]
* [ftp://ftp.kde.org/pub/kde/unstable/snapshots/ Daily Snapshots]
</div>
<br/>
<div style="margin: 0; border: 1px solid #1e90ff; padding: 0 1em 1em 1em; background-color:#F8F8FF; align:right;">

== Build KDE ==

There are different KDE branches. For production use, a stable version of KDE is recommended.
* [[/Build/Stable Version|Stable version (branch)]]
* [[/Build/Unstable Version|Unstable version (trunk)]]
* [[/Build|Other versions and FAQ]]
</div>
[[Category:Build KDE]]

Getting Started

2006-10-02T04:42:14Z

Fulldecent: /* Build KDE */

Welcome to the Compile KDE portal.

<div style="margin: 0; border: 1px solid #1e90ff; padding: 0 1em 1em 1em; background-color:#F8F8FF; align:right;">
<div style="float:right; margin-top:0.8em; margin-left:0.8em">[[Image:Action_down.svg|left|32px]]</div>
== Getting the Source ==

KDE's source code is available over several ways:
* [[/Sources/Anonymous SVN|Anonymous SVN]]
* [http://websvn.kde.org/ Browse Code Online]
* [ftp://ftp.kde.org/pub/kde/unstable/snapshots/ Daily Snapshots]
</div>
<br/>
<div style="margin: 0; border: 1px solid #1e90ff; padding: 0 1em 1em 1em; background-color:#F8F8FF; align:right;">
== Build KDE ==

There are different KDE branches. For production use, a stable version of KDE is recommended.
* [[/Build/Stable Version|Stable version (branch)]]
* [[/Build/Unstable Version|Unstable version (trunk)]]
* [[/Build|Other versions and FAQ]]
</div>
[[Category:Build KDE]]

Talk:Installing third party softwares in terminal/Build/KDE4

2006-09-15T19:47:21Z

Fulldecent: ~/install

== ~/install ==

When installing KDE4, I strongly recommend installing all tools (like dbus and cmake) and kde packages into the same place, e.g. ~/install. Qt is the only exception.

The reason for this is because if you install some packages to ~/kde and some to /usr/local and maybe one in /usr then cmake will generate errors like:

-- It is impossible to order the include directories.

This is not a fatal error, so you will still be able to compile, but you will possibly be using the wrong versions of libraries and this will product problems that are very hard to diagnose.

You may not experience any problems when installed like I advise not to, however I have and you might too in some typical situations.

Please see:

http://developer.kde.org/build/trunk.html

Getting Started/Build/Historic

2006-09-15T18:29:08Z

Fulldecent:

This page is accurate as of 2006-08-07 for building older KDE stable versions. Other pages containing similar information are being consolidated to here.
Please help me find any similar pages so I can consolidate them. This page is being actively updated, contact Will Entriken (kde.org AT phor DOTT net) with any questions or hints.

== Old Stable Versions of KDE ==
'''Note''': I don't know why you'd want to install older versions. Nonetheless, you've come to this page for that very reason. Please let me know what your motivation is so I can edit this page accordingly.

; [[Build/Compile KDE 3.4|Compiling KDE 3.4.x]]
: Instructions for installing KDE 3.4.x from source code.

; [[Build/Compile KDE 3.3|Compiling KDE 3.3.x]]
: Instructions for installing KDE 3.3.x from source code.

; [[Build/Compile KDE 3.2|Compiling KDE 3.2.x]]
: Instructions for installing KDE 3.2.x from source code.

; [[Build/Compile KDE 3.1|Compiling KDE 3.1.x]]
: Instructions for installing KDE 3.1.x from source code.

; [[Build/Compile KDE 3.0|Compiling KDE 3.0.x]]
: Instructions for installing KDE 3.0.x from source code.

; [[Build/Compile KDE 2.2.2|Compiling KDE 2.2.2]]
: Instructions for installing KDE 2.2.2 from source code.

[[Category:Build KDE]]

Getting Started/Build/Historic/KDE 3.5

2006-08-22T14:27:19Z

Fulldecent:

===Status===
This page is accurate as of 2006-08-08 for building KDE stable 3.5.4. Other pages contain similar information are are being consolidated to here. Similar pages include:
* [http://quality.kde.org/develop/cvsguide/buildstep.php]

===KDE Stable===
The current version of KDE stable is 3.5.4. You will want to build KDE stable if you are a maintainer for an OS distribution. Otherwise, you may want to install KDE stable using the tools provided by your OS distribution or vendor.

The current recommended way to install KDE stable is Konstruct, a build system which helps you to install KDE releases and applications on your system. It downloads defined source tarballs, checks their integrity, decompresses, patches, configures, builds and installs them. A complete KDE installation should be as easy as "cd meta/kde;make install".

By default "Konstruct" installs to your home directory which means you don't have to possess root privileges or risk to damage your system or affect another KDE.

Currently it gives a complete KDE 3.5.4 installation. Optionally you can install additional applications like KOffice 1.5.2 or KDevelop 3.3.4.

===Compiling Yourself===

The following instructions describe how to build KDE 3.5.x yourself, e.g. without using Konstruct or kdesvn-build.

==Requirements==
To compile KDE you need:

* Qt 3.3.2 or newer
* a C++ compiler which supports exceptions, preferably a recent gcc 3.x release. gcc 2.95.x is still working.
* bunzip2 to decompress .bz2 files. You can find it here. Get libbz2 while you're at it, it enables reading of .tar.bz2 files in konqueror, and one day, will give access to .bz2 files to all KDE applications.
* If you want SSL support (for instance for secure web sites in konqueror), make sure you install openssl, version 0.9.6 or later (versions 0.9.5x are not supported).
* For a better regular-expressions support in Javascript, install libpcre.
* For the KDE help system, you'll need to install libxml2, version 2.3.13 or newer.
* There are additional modules that are compiled if the required library is present, but they aren't critical to run KDE. For instance, libldap for the LDAP kioslave, and cdparanoia for the audiocd kioslave. A more detailed list of requirements is available in the KDE 3.5 Requirements List

==Download==
In order to run KDE applications, you need the Qt, arts, and kdelibs packages. For a simple desktop (with a window manager, panel, etc), you will also need kdebase. The other packages contain many other applications by topic: networking, graphics, multimedia, games, utilities, toys, software development, etc.

You can find the Qt library (version 3.3.6) at ftp://ftp.trolltech.com/qt/source/

KDE 3.5.x is available from ftp://download.kde.org/pub/kde/stable/

==Installation==
Unlike most compiled software, Qt is compiled in the place where it will stay instead of using a 'make install'. Please read the INSTALL instructions in the Qt package. You need to set the QTDIR and KDEDIR to the locations where Qt and KDE will be installed, respectively. Also, append $QTDIR/bin and $KDEDIR/bin to your $PATH and $LD_LIBRARY_PATH. Alternatively, instead of using $LD_LIBRARY_PATH, you may add your Qt and KDE library paths to /etc/ld.so.conf, but don't forget to run ldconfig as root after installing Qt and kdelibs, otherwise configure scripts will fail to find the newly installed libraries!

If your distribution sets $XDG_DATA_DIRS and/or $XDG_CONFIG_DIRS you will want to update them to include the correct $KDEDIR/share/ resp. $KDEDIR/etc/xdg/

bunzip2 qt-x11-3.3.6.tar.bz2
tar xvf qt-x11-3.3.6.tar
cd qt-x11-3.3.6
less INSTALL
(Set up QTDIR, KDEDIR, PATH, LD_LIBRARY_PATH, XDG_DATA_DIRS and XDG_CONFIG_DIRS)
cd $QTDIR
./configure -system-zlib -qt-gif -system-libpng \
-system-libjpeg -plugin-imgfmt-mng -thread -no-stl \
-no-xinerama -no-g++-exceptions
make

Note that -thread is required (KDE will not run or even compile if you omit it), that -no-xinerama is only if you're not using xinerama, and -no-g++-exceptions is strongly recommended if you're using gcc.

Make sure to compile and install first arts, and afterwards kdelibs before any other packages. Also, if you want to use kdeaddons, it should be compiled last as it requires kdebase, kdemultimedia, etc.

For each KDE package:

bunzip2 <package>.tar.bz2
tar xvf <package>.tar
cd <package>
./configure
make
make install

==Notes==

* If compiling on a system where GNU make is not the default make (that is, most systems other than Linux), please run 'gmake && gmake install' instead of 'make && make install'.
* All packages mentioned here have to be compiled with the same compiler!
* See the [http://www.kde.org/info/3.5.4.php|KDE 3.5 Info Page] for some common encountered problems when running KDE 3.5.