KDE TechBase - User contributions [en]

User talk:Logixoul

2011-02-22T02:13:14Z

Logixoul: Reverted edits by Koko351152 (Talk) to last version by Logixoul

err... did you move/delete [[debugging]] ? I just wanted to write more about this. And there were some things there that were important because I cannot remember them. [[User:Tstaerk|Tstaerk]]
:I didn't, [[User:dhaumann]] did. See [http://developernew.kde.org/index.php?title=Special:Log/delete&page=Debugging]. I undeleted it. Now, if you think the contents of [[Debugging]] are important only for you, move them to your userpage and I'll take care of [[Debugging]]. ;) [[User:Logixoul|Logixoul]] 00:58, 14 September 2006 (CEST)

Getting Started/Build/Troubleshooting

2008-06-20T10:41:55Z

Logixoul: same here.. change the order of kdebase and kdepimlibs to emphasize nondependency

{{Template:I18n/Language Navigation Bar|Getting_Started/Build/KDE4/Troubleshooting}}

{{TutorialBrowser|

series=Getting Started|

name=Building KDE4 From Source/Troubleshooting|

pre=[[../|KDE SVN Quickstart Guide]]|

next=[[../|KDE SVN Quickstart Guide]]|
|
}}

This page contains some troubleshooting tips for issues you may encounter while building kde4 from source.

Many of the issues listed here may be out of date.

== Issues building kdelibs ==
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. If you install additional software, it may be necessary to remove {{path|~/kde/src/KDE/kdelibs/CMakeCache.txt}} before trying the build again.

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.
* if you get "The PCRE regular expression library has not been found >=4.5 " then watch out the http://techbase.kde.org/index.php?title=Getting_Started/Build/KDE4/Kubuntu_and_Debian (Getting Started/Build/KDE4/Kubuntu and Debian-> kdelibs dependancies ->Recommended packages ) or
remove ../.. build/kdelibs
cs KDE/kdelibs
cmakekde

* [stub] What to do if you have a problem like kde-config.cpp:56: undefined reference to `KLocalizedString::~KLocalizedString()' and
/Depot/Temp/kdelibs-4.0.2/kdecore/kde-config.cpp:197: undefined reference to `KConfigGroup::readPathEntry(char const*, QString const&) const' and kde-config.cpp:66: undefined reference to `ki18n(char const*)'?
Seems to happen with some localization stuff

== Issues building kdebase ==
If you have troubles compiling kdebase:
* XINE is needed to compile kdebase-runtime
* 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 meinproc4</tt> has to deliver {{path|/home/kde-devel/kde/bin/meinproc4}}
* 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. By the way, after update the strigi, you must recompile kdelibs for a new libkio.so.
* If you get the issue "can't find REQUIRED package Blitz", install qimageblitz4 and qimageblitz-dev
* If you get an error "class QWebFrame' has no member named 'contentsSize'" you need to upgrade your Qt
* If you have troubles building networkmanager-0.6, check if you have networkmanager-dev and libnm-util-dev installed
* If you get during cmake
Please set the following variables:
CLUCENE_LIBRARY_DIR (ADVANCED)
Make sure you have clucene installed and clucene-devel. If necessary, get the source from sourceforge and compile it. If you have SUSE and an x64 installation, you need to make cmake aware your library path is /usr/lib64, not /usr/lib. Do this with
cmake -DLIB_SUFFIX=64 .
* If you get an error saying your soprano libraries are too old, but you've installed them under kdesupport, check to see if your build is using your system libraries instead. If so, then set:
CMAKE_LIBRARY_PATH=/home/kde-devel/kde/lib:$CMAKE_LIBRARY_PATH
CMAKE_INCLUDE_PATH=/home/kde-devel/kde/include:$CMAKE_INCLUDE_PATH

and delete the CMakeCache.txt in your build directory.
== Issues building kdepimlibs ==
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/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.
* if cmake complains about missing akonadi headers, (CMake Error: Could not find Akonadi includes. or something similiar), then you lack the akonadi package which can be found in the kdesupport module. Since the kdesupport as a whole is quite large it is recommended that you selectively download the packages you need instead of fetching the entire kdesupport module.Akonadi relies on automoc, so we have to install it prior to building akonadi. The Automoc module can also be found in kdesupport.

=== The Recipe for Automoc ===
cd
cs
mkdir kdesupport && cd kdesupport
svn checkout svn://anonsvn.kde.org/home/kde/trunk/kdesupport/automoc
cd automoc
cmakekde

=== The Recipe for Akonadi ===
cd
cs
cd kdesupport
svn checkout svn://anonsvn.kde.org/home/kde/trunk/kdesupport/akonadi
cd akonadi
cmakekde

== Running programs ==

* If you get
KUniqueApplication: Cannot find the D-Bus session server
make sure you can access the display, e.g. type
xclock
then a clock must appear on the screen. If it does and the error persists, start your shell using
dbus-launch xterm
and start your program in there.

* 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.

== 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

Also you have to add a "kde" service in /etc/pam.d/ folder

For example for RH/Fedora based distros:
<code>
#%PAM-1.0
auth include system-auth
account include system-auth
password include system-auth
session include system-auth
</code>

while for debian/Kubuntu (requires having libpam-dev installed while building kdebase):
<code>
# Standard Un*x authentication.
@include common-auth
@include common-account
@include common-session
@include common-password
</code>

Getting Started/Build/KDE4

2008-06-20T10:38:49Z

Logixoul: changing the order of kdepimlibs and kdebase as discussed in #kde-devel

Contribute/Bugsquad/BugDays/flashplugin

2008-05-08T09:06:56Z

Logixoul:

=Flash support in Konqueror=
Please list kde version, flash version, 32/64bit here.

about:plugins in the urlbar will tell you what flash version you have

Reproducibility is what we are looking for here, backtraces aren't as useful, apparently. Eventually we can perhaps just link to this webpage from bugreports, as we'll have a nice matrix of what versions work, right?

[[User:Blauzahl|Blauzahl]] WORKSFORME flash 9.0.115 on a 32bit compiled system, 4.0.3ish branch. Note: should test with latest svn up...

I ([[User:mutlu_inek|mutlu_inek]]) can use flash. It works with a few errors (see test cases below) <s>and reliable crashes of nspluginviewer, not Konqui, every time I browse away from a site using flash. The Nspluginviewer does automatically restart, though, so no grave problem.</s> I am using self-compiled trunk, rev. <s>798847</s> <s>799237</s> <s>800877</s> 804277, and adobe's flashplugin 9.0.124 on Arch Linux, 32 bit.

The nsplugin crashes have been fixed in trunk, I am running rev. 804277 (mutlu_inek).

Flash Player 9.0.48 works perfectly in my Konq r803177 (trunk). IIRC 9.0.115 hung randomly, crashed, and continuously spiked the CPU. System is 32bit. [[User:Logixoul|Logixoul]] 11:00, 8 May 2008 (CEST)

=Test site #1: pathological goodness=

http://www.canal13.cl

What happens?

Sahaqiel -If I close the tab after hovering the second ad counting from the right, nspluginviewer will crash. <s>And besides, the ad will expand leaving a blank spot with the size the ad occupied</s>.

[[User:Blauzahl|Blauzahl]] - Sad. It doesn't all display. I get gray boxes. I swear this site worked fine for me the last time we did BugDay. I also get the ad expansion blanking the underlying text. [http://pobox.com/~zahl/kde/canal.pathalogical.png screenshot]

if you have multiple tabs open, and then hover over the dog ad, then close that tab, does it crash?
uga says: uhm... tried but, as soon as I tried opening a new tab, my (google) konqui got locked

[[User:mutlu_inek|mutlu_inek]] - The site looks and works exactly like in Firefox: [http://img185.imageshack.us/img185/5559/snapshot3kw1.png screenshot]
*<s>Flash boxes that resize themselves are not displayed correctly, they claim the space they use when they are full-sized by displaying a white box over the other flash content.</s> The same issue with Firefox. Appears to have nothing to do with Konqui.
*<s>The video player flash box has a black background that is larger than the video player box.</s> The same issue with Firefox. Appears to have nothing to do with Konqui.
*<s>Nspluginviewer crashes when browsing away from the site.</s>

=Test site #2: youtube=

http://youtube.com
[http://youtube.com/watch?v=wCF3ywukQYA nice shoes.]

[[User:mutlu_inek|mutlu_inek]] - The site looks and works exactly like in Firefox: [http://img262.imageshack.us/img262/4219/snapshot6og5.png screenshot]
*<s>Nspluginviewer crashes when browsing away from the site.</s>
[[User:Blauzahl|Blauzahl]] - worked for me, will retest if someone gives me a hockey video

=Test site #3: Google streetview=

http://maps.google.com ---> streetview
Does it work?

[[User:mutlu_inek|mutlu_inek]] - The site looks exactly like in Firefox.
 Issues:
*Full-Screen View does not work. The view is enlarged only within the regular google map box (it does not take over the search results space on the left as in Firefox). Also, the street scene becomes gray and nothing will get the functionality back (not even returning from full-screen view). To be able to use street view again, the street view window has to be closed and a new one opened.
*Moving the map that underlies the street view moves the street view popup since it is fixed to the location on the map that was searched for [This is correct behavior]. When the street view popup leaves the frame of the regular map view in Firefox, it is _below_ the search results and address bar parts of the website. In Konqueror, however, the street view (without the popup's frame) overlays the rest of the website. See: [http://img376.imageshack.us/my.php?image=snapshot8jv4.png screenshot]
*<s>Nspluginviewer crashes when browsing away from the site and when closing a street view popup.</s>

{{Bug|161137}} probably ought to just be closed, but we'll see if the guy does so first

=Test site #4: Music site: jamendo.com=
http://jamendo.com

[[User:Blauzahl|Blauzahl]] says: Newest site on my shitlist.
*Super slow.
*I can't change languages. (works under iceweasel 2.0.0.18)
*I can't play music. It gives a popup box saying there's a problem with the flash audio backend. In Iceweasel it says it wants Flash 6+ to run jamPlayerWeb. So maybe it just isn't finding it?
*btw: Lots of commentary on irc about how they just look for ff or ie and refuse everyone else. Probably are screwed here. Don't remember if cloaking made it work.

[[User:mutlu_inek|mutlu_inek]] finds that the site works reasonably fast and simply browsing it has not yet triggered any errors. However, ...
*Playing music (whether through the embedded player in the upper right or through the popup player does not work. In both cases, Konqueror simply freezes. In the latter case, the popup does not even show. No hints at what is wrong on the command line. No crash report.
*Downloading songs in not possible, either. Clicking the "download" button equally freezes Konqueror.

=Keep an eye on:=
*http://bugs.kde.org/show_bug.cgi?id=161383
*<s>http://lists.kde.org/?t=120903182100001&r=1&w=2</s>

Contribute/Bugsquad/BugDays/flashplugin

2008-05-08T09:00:36Z

Logixoul:

=Flash support in Konqueror=
Please list kde version, flash version, 32/64bit here.
about:plugins in the urlbar will tell you what flash version you have

[[User:Blauzahl|Blauzahl]] WORKSFORME flash 9.0.115 on a 32bit compiled system, 4.0.3ish branch. Note: should test with latest svn up...

I ([[User:mutlu_inek|mutlu_inek]]) can use flash. It works with a few errors (see test cases below) <s>and reliable crashes of nspluginviewer, not Konqui, every time I browse away from a site using flash. The Nspluginviewer does automatically restart, though, so no grave problem.</s> I am using self-compiled trunk, rev. <s>798847</s> <s>799237</s> <s>800877</s> 804277, and adobe's flashplugin 9.0.124 on Arch Linux, 32 bit.

The nsplugin crashes have been fixed in trunk, I am running rev. 804277 (mutlu_inek).

Flash Player 9.0.48 works perfectly in my Konq r803177 (trunk). IIRC 9.0.115 hung randomly, crashed, and continuously spiked the CPU. [[User:Logixoul|Logixoul]] 11:00, 8 May 2008 (CEST)

=Test site #1: pathological goodness=

http://www.canal13.cl

What happens?

Sahaqiel -If I close the tab after hovering the second ad counting from the right, nspluginviewer will crash. <s>And besides, the ad will expand leaving a blank spot with the size the ad occupied</s>.

[[User:Blauzahl|Blauzahl]] - Sad. It doesn't all display. I get gray boxes. I swear this site worked fine for me the last time we did BugDay. I also get the ad expansion blanking the underlying text. [http://pobox.com/~zahl/kde/canal.pathalogical.png screenshot]

if you have multiple tabs open, and then hover over the dog ad, then close that tab, does it crash?
uga says: uhm... tried but, as soon as I tried opening a new tab, my (google) konqui got locked

[[User:mutlu_inek|mutlu_inek]] - The site looks and works exactly like in Firefox: [http://img185.imageshack.us/img185/5559/snapshot3kw1.png screenshot]
*<s>Flash boxes that resize themselves are not displayed correctly, they claim the space they use when they are full-sized by displaying a white box over the other flash content.</s> The same issue with Firefox. Appears to have nothing to do with Konqui.
*<s>The video player flash box has a black background that is larger than the video player box.</s> The same issue with Firefox. Appears to have nothing to do with Konqui.
*<s>Nspluginviewer crashes when browsing away from the site.</s>

=Test site #2: youtube=

http://youtube.com
[http://youtube.com/watch?v=wCF3ywukQYA nice shoes.]

[[User:mutlu_inek|mutlu_inek]] - The site looks and works exactly like in Firefox: [http://img262.imageshack.us/img262/4219/snapshot6og5.png screenshot]
*<s>Nspluginviewer crashes when browsing away from the site.</s>
[[User:Blauzahl|Blauzahl]] - worked for me, will retest if someone gives me a hockey video

=Test site #3: Google streetview=

http://maps.google.com ---> streetview
Does it work?

[[User:mutlu_inek|mutlu_inek]] - The site looks exactly like in Firefox.
 Issues:
*Full-Screen View does not work. The view is enlarged only within the regular google map box (it does not take over the search results space on the left as in Firefox). Also, the street scene becomes gray and nothing will get the functionality back (not even returning from full-screen view). To be able to use street view again, the street view window has to be closed and a new one opened.
*Moving the map that underlies the street view moves the street view popup since it is fixed to the location on the map that was searched for [This is correct behavior]. When the street view popup leaves the frame of the regular map view in Firefox, it is _below_ the search results and address bar parts of the website. In Konqueror, however, the street view (without the popup's frame) overlays the rest of the website. See: [http://img376.imageshack.us/my.php?image=snapshot8jv4.png screenshot]
*<s>Nspluginviewer crashes when browsing away from the site and when closing a street view popup.</s>

{{Bug|161137}} probably ought to just be closed, but we'll see if the guy does so first

=Test site #4: Music site: jamendo.com=
http://jamendo.com

[[User:Blauzahl|Blauzahl]] says: Newest site on my shitlist.
*Super slow.
*I can't change languages. (works under iceweasel 2.0.0.18)
*I can't play music. It gives a popup box saying there's a problem with the flash audio backend. In Iceweasel it says it wants Flash 6+ to run jamPlayerWeb. So maybe it just isn't finding it?
*btw: Lots of commentary on irc about how they just look for ff or ie and refuse everyone else. Probably are screwed here. Don't remember if cloaking made it work.

[[User:mutlu_inek|mutlu_inek]] finds that the site works reasonably fast and simply browsing it has not yet triggered any errors. However, ...
*Playing music (whether through the embedded player in the upper right or through the popup player does not work. In both cases, Konqueror simply freezes. In the latter case, the popup does not even show. No hints at what is wrong on the command line. No crash report.
*Downloading songs in not possible, either. Clicking the "download" button equally freezes Konqueror.

=Keep an eye on:=
*http://bugs.kde.org/show_bug.cgi?id=161383
*<s>http://lists.kde.org/?t=120903182100001&r=1&w=2</s>

Projects/Oxygen/StyleWinDec

2008-04-30T08:19:55Z

Logixoul: old warning, the page is protected now

The current Oxygen style and window decoration for KDE4 can be found in SVN under http://websvn.kde.org/trunk/KDE/kdebase/runtime/kstyles/oxygen and http://websvn.kde.org/trunk/KDE/kdebase/workspace/kwin/clients/oxygen

== Visitors ==
We no longer accept bugs here.

Please use bugs.kde.org under Oxygen

We strongly suggest that you come to #oxygen on irc first to discuss the bug.

== Rejected Bugs ==
* In (double) spinboxes the font is positioned one pixel too high. Lowering it one makes it baseline-aligned with labels in front. Unfortunately not possible. We want them to be the same size as editable comboboxes and lineedits and buttons so those line up. The 1px wrong placement of text is a qt weirdness that gives visual bugs when we try to work around it 
* Centered group titles pose several problems. Left align group titles instead. See Discussion for more details.
* KMenu::addTitle() adds a widget action to display a title in a popup menu. This is not specific to Oxygen, but the widget it creates could use some polishing. (to see this, right click any icon in the system tray)not a style bug report to kmenu maintainer - and don't ever add things to "accepted bugs" below again - this went unnoticed because of that 
* "flat" buttons drawn same as regular buttons we may not want flat buttons - considering

== Things we'd like to do ==
* progress bars still not like the artist wants priority
* should repaint on globalChange signal (how?) releasable
** this seems to only be a problem for the colors kcm, may not even be a style bug
*headers in tables
**not really done - but the plain color look is acceptable for now releasable
* Rounded corners of floatables (windows,menus dockers) should be done with alpha
* Windeco should use alpha for corners (need kwin improvements?)
* groupboxes
** make flat more homogeneous in look with normal (very short regular?)
* docked dockers might need a nicer frame

== QA ==
This is helpful checklist to use when looking for bugs in a style:
* reverse layout
* high-contrast color schemes (i.e. all fg/bg black or white)
* reverse-light/dark color schemes (e.g. light-on-dark buttons with dark-on-light views, etc.)
* [http://pastebin.ca/803298 QA color scheme]
* sliders, scrollbars, progress - in all orientations and good cross section of values
* content padding works for all controls, does not break sizeToContents functionality
* controls align nicely and controls that should be the same size, are
* no obvious glitches in uidemo

[[Category:Artwork]][[Category:Oxygen]]

Projects/Oxygen/StyleWinDec

2008-04-30T08:18:48Z

Logixoul: removing fixed item

The current Oxygen style and window decoration for KDE4 can be found in SVN under http://websvn.kde.org/trunk/KDE/kdebase/runtime/kstyles/oxygen and http://websvn.kde.org/trunk/KDE/kdebase/workspace/kwin/clients/oxygen

== Visitors ==
We no long accept bugs here.

Please use bugs.kde.org under Oxygen

We strongly suggest that you come to #oxygen on irc first to discuss the bug.

DO NOT EDIT SECTIONS WITHOUT PERMISSION.

== Rejected Bugs ==
* In (double) spinboxes the font is positioned one pixel too high. Lowering it one makes it baseline-aligned with labels in front. Unfortunately not possible. We want them to be the same size as editable comboboxes and lineedits and buttons so those line up. The 1px wrong placement of text is a qt weirdness that gives visual bugs when we try to work around it 
* Centered group titles pose several problems. Left align group titles instead. See Discussion for more details.
* KMenu::addTitle() adds a widget action to display a title in a popup menu. This is not specific to Oxygen, but the widget it creates could use some polishing. (to see this, right click any icon in the system tray)not a style bug report to kmenu maintainer - and don't ever add things to "accepted bugs" below again - this went unnoticed because of that 
* "flat" buttons drawn same as regular buttons we may not want flat buttons - considering

== Things we'd like to do ==
* progress bars still not like the artist wants priority
* should repaint on globalChange signal (how?) releasable
** this seems to only be a problem for the colors kcm, may not even be a style bug
*headers in tables
**not really done - but the plain color look is acceptable for now releasable
* Rounded corners of floatables (windows,menus dockers) should be done with alpha
* Windeco should use alpha for corners (need kwin improvements?)
* groupboxes
** make flat more homogeneous in look with normal (very short regular?)
* docked dockers might need a nicer frame

== QA ==
This is helpful checklist to use when looking for bugs in a style:
* reverse layout
* high-contrast color schemes (i.e. all fg/bg black or white)
* reverse-light/dark color schemes (e.g. light-on-dark buttons with dark-on-light views, etc.)
* [http://pastebin.ca/803298 QA color scheme]
* sliders, scrollbars, progress - in all orientations and good cross section of values
* content padding works for all controls, does not break sizeToContents functionality
* controls align nicely and controls that should be the same size, are
* no obvious glitches in uidemo

[[Category:Artwork]][[Category:Oxygen]]

User talk:JRT

2008-04-05T18:18:06Z

Logixoul: KDE4-both

== KDE4-both ==

Hey, I removed your link to "KDE4-both", because no one has written that page yet ;) also I find it of questionable usefulness. --[[User:Logixoul|Logixoul]] 20:18, 5 April 2008 (CEST)

Getting Started

2008-04-05T18:17:27Z

Logixoul: no such page yet ;)

{{Template:I18n/Language Navigation Bar|Getting_Started}}
{{Box|Getting the Source|
[[Image:Action_down.svg|right|32px]]
* [[Getting_Started/Sources/Anonymous SVN|Anonymous SVN Quickstart Guide]]
* [[Getting_Started/Sources/Using Subversion with KDE|Using Subversion with KDE]] ''A more in depth look at accessing KDE source code with subversion, including the repository layout and working with revisions and patches.''
* [[Getting_Started/Sources/Snapshots|Daily Snapshots]]
* [http://websvn.kde.org/ Browse Code Online]
|100%}}

{{Box|Building KDE|
[[Image:Action_tool.svg|right|32px]]
There are different KDE branches. For production use, we recommend using a stable version of KDE.
* [[Getting_Started/Build/KDE4|KDE 4 (Development version, TRUNK)]]
* [[Getting_Started/Build/KDE4.0|KDE 4 (Current Release or BRANCH)]]
* [[Getting_Started/Build/Stable Version|KDE 3.5 (Stable version)]]
* [[Getting_Started/Build|Other versions and FAQ]] ''Including information for building on non-linux systems''
|100%}}

{{Box|Setting up the Environment|
[[Image:Action_pen.svg|right|32px]]
After KDE has been built, you'll want a good way to launch apps and perform your regular development tasks:
* [[Getting_Started/Increased Productivity in KDE4 with Scripts|Increased Productivity in KDE4 with Scripts]]
* [[Getting_Started/Set up KDE 4 for development|Set up KDE 4 for development]]
|100%}}
[[Category:Build KDE]]

Getting Started/Sources/Anonymous SVN

2008-03-08T09:40:17Z

Logixoul: /* Abstract */

{{Template:I18n/Language Navigation Bar|Getting Started/Sources/Anonymous SVN}}
{{TutorialBrowser|

series=Getting Started|

name=Getting KDE Sources Using Anonymous Subversion (SVN)|

next=[[../../Build/KDE4|Building KDE4]]|

reading=[http://svnbook.red-bean.com/ Version Control with Subversion]|
}}

== Abstract ==

For those of us that like to stay on the "bleeding edge" there's an easy way to keep a local copy of the KDE sources up-to-date - anonymous SVN.

Alternatively, install [[Getting_Started/Distribution_Packages|KDE SVN packages from your distribution]].

== Anonymous SVN ==

=== Setup Subversion ===

First, install the subversion (svn) binary if it isn't already on your computer. Your operating system should have a package for it. Alternatively you can download and compile it yourself via the [http://subversion.tigris.org/project_packages.html svn project download page]. Please read the [[Getting_Started/Sources/Using_Subversion_with_KDE|KDE Subversion tutorial]] if you are interested in how to use Subversion.

=== Checkout KDE ===

'''/trunk/''' is where the Qt4-based KDE 4 is being developed. The following is the minimal set of modules you will need to check out to build KDE and KDE software:

svn co svn://anonsvn.kde.org/home/kde/trunk/KDE/kdelibs
svn co svn://anonsvn.kde.org/home/kde/trunk/KDE/kdebase

{{tip|If your firewall doesn't allow access to arbitrary ports, substitute '''svn://anonsvn.kde.org/''' with '''svn://websvn.kde.org:443/''' above.}}

{{tip|The kdebase module has an external dependency, using svn:externals. The problem is, at this time, the externals property is set with an absolute path, pointing to anonsvn. For those using behind a firewall, this is a problem. You can change the property for your workspace, using two commands:
cs KDE
svn propset svn:externals "lib svn://websvn.kde.org:443/home/kde/trunk/KDE/kdebase/runtime/kstyles/oxygen/lib" kdebase/workspace/kwin/clients/oxygen
This way the external property will look for the aditional files in the websvn repository.}}

'''qt-copy''' is a copy of the latest stable [http://www.trolltech.com Qt] release which works with KDE, put into SVN for convenience. It also contains patches by KDE developers that haven't found their way to Qt yet. They are recommended for those working with KDE from '''trunk'''. Instructions on how to get and configure it can be found [[Getting_Started/Build/KDE4/Prerequisites#Qt |here]].

If you wish to have a complete copy of the KDE distribution, you can simply check out the entire source tree with one command:

svn co svn://anonsvn.kde.org/home/kde/trunk/KDE

{{note|It is smarter to first use [http://websvn.kde.org/trunk/KDE The KDE Source Repository Web Viewer]. Use it to choose which modules to download. This way KDE will be quicker to install and try out.}}

If you want additional software packages you can check out the following modules within '''trunk/''' as well:

koffice
extragear
playground
kdereview

So, for example, if you want to check out koffice trunk, you can use

svn co svn://anonsvn.kde.org/home/kde/trunk/koffice

=== Checking out trunk using snapshots ===

If you are checking out modules from '''trunk/''' you may be able to save time by using snapshots. Using Subversion trunk snapshots is described at [[../Snapshots|the Subversion snapshots tutorial page]].

=== Checking out KDE 3 instead ===

If you want to track KDE 3 rather than the bleeding edge, you may retrieve the KDE 3.5 sources using:

svn co svn://anonsvn.kde.org/home/kde/branches/arts/1.5/arts
svn co svn://anonsvn.kde.org/home/kde/branches/KDE/3.5/

And if you want the matching qt-copy:
svn co svn://anonsvn.kde.org/home/kde/branches/qt/3.3/qt-copy

=== Checking out specific releases ===

KDE modules are also tagged at each release so that it is possible to get a specific release of KDE. Most KDE modules have a tag name in the format '''tags/KDE/X.Y.Z''' (where X, Y and Z represent the exact version). The arts module (only needed for KDE 2 and KDE 3) has a different format of tag name, '''tags/arts/X.Y.Z'''. For instance to get kdelibs as it was shipped in KDE 3.5.0, do:

svn co svn://anonsvn.kde.org/home/kde/tags/KDE/3.5.0/kdelibs/

If you then want to update this checkout to KDE 3.5.5, use this command:

svn switch svn://anonsvn.kde.org/home/kde/tags/KDE/3.5.5/kdelibs

{{tip|If you used a '''/branch/''' or '''/trunk/''' path, then there is no need to switch, just run '''svn update'''.}}

=== Checking out translations ===
If you are looking for translations and other localizations, check out the appropriate language from the [http://websvn.kde.org/trunk/l10n l10n] module.

{{Warning|The l10n module is ''extremely'' large. Be sure you have lots of time and disk space on hand before checking out the entire l10n module. Most people only check out specific language subdirectories rather than the entire l10n module.}}

You are now ready to start building KDE! Visit [[Getting_Started/Build/KDE4|this page]] for instructions on building trunk or [[Getting_Started/Build/Stable_Version|this page]] for instruction on compiling the last stable release.

== Also of interest ==
* anonsvn.kde.org is located in Tuebingen, Germany, maintained by [mailto:dirk@kde.org Dirk Mueller] However, a more local mirror could be faster for you than anonsvn.kde.org itself. Current mirrors are, sorted by performance:
** kde.mneisen.org is located near Nuernberg, Germany, maintained by [mailto:martin.eisenhardt@mneisen.org Martin Eisenhardt]
** www.englishbreakfastnetwork.org also hosts an anonymous SVN mirror, at the University of Nijmegen, Netherlands. Maintained by [mailto:groot@kde.org Adriaan de Groot]
** svn://azkaban.caltech.edu is located near Los Angeles, USA and is maintained by [mailto:eugen.plamadeala@gmail.com Eugeniu Plamadeala]. It has the same folder hierarchy as anonsvn.kde.org.
: Be careful when switching between mirrors. SVN remembers the server in the working copy, so to switch you have to run
svn switch --relocate svn://anonsvn.kde.org/ svn://kde.mneisen.org/
: in all your checkouts.
If you're interested in setting up a svn mirror, please contact [mailto:mueller@kde.org Dirk Mueller].

[[Category:Build KDE]]

Getting Started/Sources/Anonymous SVN

2008-03-08T09:38:41Z

Logixoul:

{{Template:I18n/Language Navigation Bar|Getting Started/Sources/Anonymous SVN}}
{{TutorialBrowser|

series=Getting Started|

name=Getting KDE Sources Using Anonymous Subversion (SVN)|

next=[[../../Build/KDE4|Building KDE4]]|

reading=[http://svnbook.red-bean.com/ Version Control with Subversion]|
}}

== Abstract ==

For those of us that like to stay on the "bleeding edge" there's an easy way to keep a local copy of the KDE sources up-to-date - anonymous SVN.

Please note that several Linux distributions now already provide KDE SVN packages, so '''building Qt and KDE from source may well not be necessary for you at all! '''See [[Getting_Started/Distribution_Packages]] for instructions and information.

== Anonymous SVN ==

=== Setup Subversion ===

First, install the subversion (svn) binary if it isn't already on your computer. Your operating system should have a package for it. Alternatively you can download and compile it yourself via the [http://subversion.tigris.org/project_packages.html svn project download page]. Please read the [[Getting_Started/Sources/Using_Subversion_with_KDE|KDE Subversion tutorial]] if you are interested in how to use Subversion.

=== Checkout KDE ===

'''/trunk/''' is where the Qt4-based KDE 4 is being developed. The following is the minimal set of modules you will need to check out to build KDE and KDE software:

svn co svn://anonsvn.kde.org/home/kde/trunk/KDE/kdelibs
svn co svn://anonsvn.kde.org/home/kde/trunk/KDE/kdebase

{{tip|If your firewall doesn't allow access to arbitrary ports, substitute '''svn://anonsvn.kde.org/''' with '''svn://websvn.kde.org:443/''' above.}}

{{tip|The kdebase module has an external dependency, using svn:externals. The problem is, at this time, the externals property is set with an absolute path, pointing to anonsvn. For those using behind a firewall, this is a problem. You can change the property for your workspace, using two commands:
cs KDE
svn propset svn:externals "lib svn://websvn.kde.org:443/home/kde/trunk/KDE/kdebase/runtime/kstyles/oxygen/lib" kdebase/workspace/kwin/clients/oxygen
This way the external property will look for the aditional files in the websvn repository.}}

'''qt-copy''' is a copy of the latest stable [http://www.trolltech.com Qt] release which works with KDE, put into SVN for convenience. It also contains patches by KDE developers that haven't found their way to Qt yet. They are recommended for those working with KDE from '''trunk'''. Instructions on how to get and configure it can be found [[Getting_Started/Build/KDE4/Prerequisites#Qt |here]].

If you wish to have a complete copy of the KDE distribution, you can simply check out the entire source tree with one command:

svn co svn://anonsvn.kde.org/home/kde/trunk/KDE

{{note|It is smarter to first use [http://websvn.kde.org/trunk/KDE The KDE Source Repository Web Viewer]. Use it to choose which modules to download. This way KDE will be quicker to install and try out.}}

If you want additional software packages you can check out the following modules within '''trunk/''' as well:

koffice
extragear
playground
kdereview

So, for example, if you want to check out koffice trunk, you can use

svn co svn://anonsvn.kde.org/home/kde/trunk/koffice

=== Checking out trunk using snapshots ===

If you are checking out modules from '''trunk/''' you may be able to save time by using snapshots. Using Subversion trunk snapshots is described at [[../Snapshots|the Subversion snapshots tutorial page]].

=== Checking out KDE 3 instead ===

If you want to track KDE 3 rather than the bleeding edge, you may retrieve the KDE 3.5 sources using:

svn co svn://anonsvn.kde.org/home/kde/branches/arts/1.5/arts
svn co svn://anonsvn.kde.org/home/kde/branches/KDE/3.5/

And if you want the matching qt-copy:
svn co svn://anonsvn.kde.org/home/kde/branches/qt/3.3/qt-copy

=== Checking out specific releases ===

KDE modules are also tagged at each release so that it is possible to get a specific release of KDE. Most KDE modules have a tag name in the format '''tags/KDE/X.Y.Z''' (where X, Y and Z represent the exact version). The arts module (only needed for KDE 2 and KDE 3) has a different format of tag name, '''tags/arts/X.Y.Z'''. For instance to get kdelibs as it was shipped in KDE 3.5.0, do:

svn co svn://anonsvn.kde.org/home/kde/tags/KDE/3.5.0/kdelibs/

If you then want to update this checkout to KDE 3.5.5, use this command:

svn switch svn://anonsvn.kde.org/home/kde/tags/KDE/3.5.5/kdelibs

{{tip|If you used a '''/branch/''' or '''/trunk/''' path, then there is no need to switch, just run '''svn update'''.}}

=== Checking out translations ===
If you are looking for translations and other localizations, check out the appropriate language from the [http://websvn.kde.org/trunk/l10n l10n] module.

{{Warning|The l10n module is ''extremely'' large. Be sure you have lots of time and disk space on hand before checking out the entire l10n module. Most people only check out specific language subdirectories rather than the entire l10n module.}}

You are now ready to start building KDE! Visit [[Getting_Started/Build/KDE4|this page]] for instructions on building trunk or [[Getting_Started/Build/Stable_Version|this page]] for instruction on compiling the last stable release.

== Also of interest ==
* anonsvn.kde.org is located in Tuebingen, Germany, maintained by [mailto:dirk@kde.org Dirk Mueller] However, a more local mirror could be faster for you than anonsvn.kde.org itself. Current mirrors are, sorted by performance:
** kde.mneisen.org is located near Nuernberg, Germany, maintained by [mailto:martin.eisenhardt@mneisen.org Martin Eisenhardt]
** www.englishbreakfastnetwork.org also hosts an anonymous SVN mirror, at the University of Nijmegen, Netherlands. Maintained by [mailto:groot@kde.org Adriaan de Groot]
** svn://azkaban.caltech.edu is located near Los Angeles, USA and is maintained by [mailto:eugen.plamadeala@gmail.com Eugeniu Plamadeala]. It has the same folder hierarchy as anonsvn.kde.org.
: Be careful when switching between mirrors. SVN remembers the server in the working copy, so to switch you have to run
svn switch --relocate svn://anonsvn.kde.org/ svn://kde.mneisen.org/
: in all your checkouts.
If you're interested in setting up a svn mirror, please contact [mailto:mueller@kde.org Dirk Mueller].

[[Category:Build KDE]]

Getting Started/Sources/Anonymous SVN

2008-03-08T09:36:47Z

Logixoul: this page should go eventually... start consolidating

{{Template:I18n/Language Navigation Bar|Getting Started/Sources/Anonymous SVN}}
{{TutorialBrowser|

series=Getting Started|

name=Getting KDE Sources Using Anonymous Subversion (SVN)|

next=[[../../Build/KDE4|Building KDE4]]|

reading=[http://svnbook.red-bean.com/ Version Control with Subversion]|
}}

== Abstract ==

For those of us that like to stay on the "bleeding edge" there's an easy way to keep a local copy of the KDE sources up-to-date - anonymous SVN.

Please note that several Linux distributions now already provide KDE SVN packages, so '''building Qt and KDE from source may well not be necessary for you at all! '''See [[Getting_Started/Distribution_Packages]] for instructions and information.

== Anonymous SVN ==

=== Setup Subversion ===

First, install the subversion (svn) binary if it isn't already on your computer. Your operating system should have a package for it. Alternatively you can download and compile it yourself via the [http://subversion.tigris.org/project_packages.html svn project download page]. Please read the [[Getting_Started/Sources/Using_Subversion_with_KDE|KDE Subversion tutorial]] if you are interested in how to use Subversion.

=== Checkout KDE ===

'''/trunk/''' is where the Qt4-based KDE 4 is being developed. The following is the minimal set of modules you will need to check out to build KDE and KDE software:

svn co svn://anonsvn.kde.org/home/kde/trunk/KDE/kdelibs
svn co svn://anonsvn.kde.org/home/kde/trunk/KDE/kdebase

{{tip|If your firewall doesn't allow access to arbitrary ports, substitute '''svn://anonsvn.kde.org/''' with '''svn://websvn.kde.org:443/''' above.}}

{{tip|The kdebase module has an external dependency, using svn:externals. The problem is, at this time, the externals property is set with an absolute path, pointing to anonsvn. For those using behind a firewall, this is a problem. You can change the property for your workspace, using two commands:
cs KDE
svn propset svn:externals "lib svn://websvn.kde.org:443/home/kde/trunk/KDE/kdebase/runtime/kstyles/oxygen/lib" kdebase/workspace/kwin/clients/oxygen
This way the external property will look for the aditional files in the websvn repository.}}

'''qt-copy''' is a copy of the latest stable [http://www.trolltech.com Qt] release which works with KDE, put into SVN for convenience. It also contains patches by KDE developers that haven't found their way to Qt yet. They are recommended for those working with KDE from '''trunk'''. Instructions on how to get and configure it can be found [[Getting_Started/Build/KDE4/Prerequisites#Qt |here]].

If you wish to have a complete copy of the KDE distribution, you can simply check out the entire source tree with one command:

svn co svn://anonsvn.kde.org/home/kde/trunk/KDE

{{note|It is smarter to first use [http://websvn.kde.org/trunk/KDE The KDE Source Repository Web Viewer]. Use it to choose which modules to download. This way KDE will be quicker to install and try out.}}

If you want additional software packages you can check out the following modules within '''trunk/''' as well:

koffice
extragear
playground
kdereview

So, for example, if you want to check out koffice trunk, you can use

svn co svn://anonsvn.kde.org/home/kde/trunk/koffice

=== Checking out trunk using snapshots ===

If you are checking out modules from '''trunk/''' you may be able to save time by using snapshots. Using Subversion trunk snapshots is described at [[../Snapshots|the Subversion snapshots tutorial page]].

=== Checking out KDE 3 instead ===

If you want to track KDE 3 rather than the bleeding edge, you may retrieve the KDE 3.5 sources using:

svn co svn://anonsvn.kde.org/home/kde/branches/arts/1.5/arts
svn co svn://anonsvn.kde.org/home/kde/branches/KDE/3.5/

And if you want the matching qt-copy:
svn co svn://anonsvn.kde.org/home/kde/branches/qt/3.3/qt-copy

=== Checking out specific releases ===

KDE modules are also tagged at each release so that it is possible to get a specific release of KDE. Most KDE modules have a tag name in the format '''tags/KDE/X.Y.Z''' (where X, Y and Z represent the exact version). The arts module (only needed for KDE 2 and KDE 3) has a different format of tag name, '''tags/arts/X.Y.Z'''. For instance to get kdelibs as it was shipped in KDE 3.5.0, do:

svn co svn://anonsvn.kde.org/home/kde/tags/KDE/3.5.0/kdelibs/

If you then want to update this checkout to KDE 3.5.5, use this command:

svn switch svn://anonsvn.kde.org/home/kde/tags/KDE/3.5.5/kdelibs

{{tip|If you used a '''/branch/''' or '''/trunk/''' path, then there is no need to switch, just run '''svn update'''.}}

{{tip|[http://websvn.kde.org/tags/ WebSVN] is a convenient way to check for a tag name.}}

=== Checking out translations ===
If you are looking for translations and other localizations, check out the appropriate language from the [http://websvn.kde.org/trunk/l10n l10n] module.

{{Warning|The l10n module is ''extremely'' large. Be sure you have lots of time and disk space on hand before checking out the entire l10n module. Most people only check out specific language subdirectories rather than the entire l10n module.}}

You are now ready to start building KDE! Visit [[Getting_Started/Build/KDE4|this page]] for instructions on building trunk or [[Getting_Started/Build/Stable_Version|this page]] for instruction on compiling the last stable release.

== Also of interest ==
* anonsvn.kde.org is located in Tuebingen, Germany, maintained by [mailto:dirk@kde.org Dirk Mueller] However, a more local mirror could be faster for you than anonsvn.kde.org itself. Current mirrors are, sorted by performance:
** kde.mneisen.org is located near Nuernberg, Germany, maintained by [mailto:martin.eisenhardt@mneisen.org Martin Eisenhardt]
** www.englishbreakfastnetwork.org also hosts an anonymous SVN mirror, at the University of Nijmegen, Netherlands. Maintained by [mailto:groot@kde.org Adriaan de Groot]
** svn://azkaban.caltech.edu is located near Los Angeles, USA and is maintained by [mailto:eugen.plamadeala@gmail.com Eugeniu Plamadeala]. It has the same folder hierarchy as anonsvn.kde.org.
: Be careful when switching between mirrors. SVN remembers the server in the working copy, so to switch you have to run
svn switch --relocate svn://anonsvn.kde.org/ svn://kde.mneisen.org/
: in all your checkouts.
If you're interested in setting up a svn mirror, please contact [mailto:mueller@kde.org Dirk Mueller].

[[Category:Build KDE]]

User:Logixoul

2008-03-08T09:33:54Z

Logixoul: Removing all content from page

Getting Started/Build/KDE4

2008-03-08T09:33:11Z

Logixoul: /* Success!! */

Contribute/Bugsquad/KrushDays

2007-11-07T12:31:47Z

Logixoul:

{{Box|KDE4 Krush Days|Join us Saturdays on irc in the #kde4-krush channel to work out release critical issues for KDE 4.0. Testers, artists, documenters and programmers are all welcome and encouraged to join in on the fun. Issues that are identified and being worked on will be added to this community scratchpad page.}}{{Box|Note|
* Please attach you nickname in irc when you add a bug to this page.
*In order to mark a bug as fixed please use <nowiki><s></s></nowiki>-tags and mention the revision number(s) of this fix.}}

{{Box|Crash Backtraces|
Do not use [http://rafb.net/paste/ http://rafb.net/paste/] for your crash backtraces, because those paste URLs there will expire after 24 hours.

Please use [http://pastebin.ca/ http://pastebin.ca/] for crash backtraces and add a link to your paste when you add the crash to the list below.

A backtrace is generally very helpful for developers to identify the reason for the crash. To get good backtraces, read [[Development/Tutorials/Debugging/How_to_create_useful_crash_reports|this article]].
}}

==== Screen Locker (krunner_lock) ====
* unlocking the session is impossible as I get "wrong password" (logixoul) (confirmed by goliath23)
** prolly installed as user - kcheckpass requires setuid root
* enabling and disabling capslock in the "unlock session" dialog doesn't hide the red "Warning: capslock enabled" label (logixoul) (works fine for TunaTom [rev 731731])

==== Packaging ====
* share/icons/oxygen/22x22/actions/kscd-dock.png is installed by both kdebase and kdemultimedia (jstubbs)

==== Konsole ====
* Try opening tab in konsole, closing it, and opening a new one (for me, it freezes for a minute and then displays "QProcess: Destroyed while process is still running.") (tagx)
** Note: I [goliath23] cannot confirm this. file->new tab, then rightclick->close tab, and then file->new tab works fine here [rev 732226] (TunaTom: Ctrl-Shift-n -> Ctrl-D -> Ctrl-Shift-n works as well [rev r732048])
** Note2: (tagx:) Someone on else on irc confirmed it (name begins with t...) he was using gentoo too (I am using gentoo). (jstubbs:) Also confirmed and also with Gentoo.
** I also have this issue. The system is CentOS 4.4. /yess
* Selecting text in the default color scheme gives black-on-black selections (jstubbs)(confirmed by annma)(not reproducible by TunaTom)
* None of the Alt+<letter> menu shortcuts work when the terminal has focus (apaku) (confirmed by TunaTom)
* Wish: Could the links be not clickable as an option? it really goes on the way as it makes copy/paste too difficult when a link is present in the copied text (annma)
* Wish: could we have the Start New Session little icon back pleaaaaase? (annma)
** If you mean the icon that was to the left of the tabs in KDE 3 then no, I do not plan to reintroduce this. It has been replaced by a better set of keyboard shortcuts out of the box. The default shortcut to create a new session is Ctrl+Shift+N (robertknight)
*** Well, too bad you don't even considere it as a config option. I'll start a "New Tab icon" fan club then.
* crashes when clicking on a link, but konqueror opens successfully ([C]167
*Changes made with "Edit Current Profile::Appearance" are not
saved. <JRT>
*"Edit Font" isn't restricted to only monospace fonts. <JRT>

==== Dolphin ====
* <s>Restoring a deleted item from the trash crashes dolphin/konqueror (mbiebl)</s>
** Fixed by Sergej Melderis and David Faure (Peter Penz)
* The "Desktop" and "Root" icons in dolphin have a completely different style than the usual folder icon. (mbiebl)
* <s>Dolphin has no proper icon in taskbar/window decoration. (mbiebl)</s>
** fixed. (logixoul)
* Select icon in folder/file properties doesn't show the icons of the selected categories at first. Only after changing the combobox the icons are loaded. (bbroeksema)(I can confirmed that [TunaTom r732119])
* <s>Edit Locations (F6) doesn't work as expected. Currently it only switches to edit mode and focuses the location bar if it's in navigation mode, otherwise it doesn't do anything. (Mogger)</s>
** For me, it switches from navigation to edit mode and focuses as well [TunaTom r732119]
*** Yeah same for me, sorry for being unclear. Edited now. (Mogger)
**** Thanks for the report, this issue is fixed now :-) (Peter Penz)
* no option for 'select on hover' (emilsedgh)
* cannot show thumbnails (it was showing the thumbnails when konqueror was unable to show them, so seems a different bug with konqueror's "cannot show preview" bug, also file properties->preview hasnt the preview anyymore) (emilsedgh)
** fixed by mlaurent (logixoul)
* "Empty Trash" does not show up in the file menu when viewing the trash (yuriy)
** Application menus should never be changed dynamically. So an option would be showing "Empty Trash" always. From my point of view using the context menu is enough (at least I'm not aware about any file manager that has "Empty Trash" as part of the file-menu). For further discussions please mail me directly (peter.penz@gmx.at) or just use the kfm-devel mailing list. Thanks! (Peter Penz)
* Several of the F1-F11 do not show up in the "Configure Shortcuts" dialog (e.g. F4) (gissi)
* Inconsistency (IMHO): F4 in dolphin behaves different than in Konqueror (terminal panel vs. terminal in new window) (gissi)
* It can only configure mimetype associations individually via properties on a file, and later clicking on a small settings button. To configure mimetypes globally, and not file related, it has to be done with Konqueror settings, as there is no such entry in SystemSettings. IMHO Dolphin or SystemSettings should also get the Konqueror's File association settings panel. (q3xr2).
* <s>When moving a hidden file to trash this file is not shown in trash. However, it is in ~/.local/share/Trash, so it's not lost. The problem is probably that kiotrash ignores hidden files. (gissi, confirmed by JustinNoel, luca_b and logixoul)</s>
** Fixed by Sergejs Melderis and David Faure (Peter Penz)
* When you delete Trash from sidebar, you can't get it back. (amp)

==== Phonon ====
* Can't get any sound to work. Chosen backend is xine. Tried to play an mp3 in juk. juk says its playing, but I get no sound. (mbiebl)

==== Juk ====
* Too much colums in default setting. Not a bug but a bad looking thing. (frank95com)

==== Oxygen ====
* Missing icons for "Appearance" and "Desktop" in systemsettings. (mbiebl)
* Visual glitches in Oxygen: tabs in konqui, progressbar in dolphin. (mbiebl)
* konsole, Oxygen: the arrows of the right scrollbar are not visible (black on black). (mbiebl)
* Chanel icons in KMix could use some Oxygenification (JLP)
* Too little contrast in the window-list from alt-tab shortcut, people with only slight visual problems won't be able to see the difference between selected/not selected (apaku)
* Buttons inside konqueror are not drawn properly, text labels are off and often are missing completely. This doesn't happen with plain Qt style, but also with Plastik (apaku)

==== Plasma ====
* Unable to resize the kickoff menu. (mbiebl)
* The taskbar doesn't remember the position of the clock plasmoid. (mbiebl)
* Kickoff opens konqueror when clicking on an entry under "My Computer". (mbiebl)
* The network plasmoid does not automatically selet the active network connection (It uses eth0 by default, but I use wlan0 mostly) (mbiebl)
* In kickoff, clicking the utilities menu and then clicking back again shows the top menu scrolled to the top rather than where it was before clicking utilities. (jstubbs)
** Confirmed. Additional strange bahaviour: When opened by clicking on a link in "Storage" for example, Konqueror shows the contents of "/" in an unnamed tab. Right of that tab is another one showing the correct location. If you click that tab, konqeuror crashes. (goliath23)
* systemtray: starting one juk instance shows two identical icons in the systray.
* with the plasma toolbox, clicking "add widgets" but releasing the mouse button elsewhere still activates it. (jstubbs)
* hovering the plasma toolbox for the first time after cleaning config makes buttons slide in from TOP-LEFT rather than TOP-RIGHT. Every subsequent hovering works correctly. (logixoul)
* can't move panel plasmoids. (logixoul)
* can't put pager or systray on panel. (logixoul)
* systray on desktop has no border. (logixoul)
* MinimizeAnimation doesn't animates correctly to the taskbar, with Kicker it works fine (Plasma should tell KWin where the taskbar-entry is) (boom1992)
* The dictionary plasmoid doesn't show the results. (Mogger)
** Looks like fixed in r732655, shows the result, but first changes the box with animation, then changes the result text, also its a bit slow (emilsedgh)
* krunner hangs on each and every letter typed in after some time working in a kde4 desktop. May be related to manual killing the strigidaemon which goes nuts on CPU usage. Output from console: http://www.apaku.de/vardata/krunner_output_hang (apaku)
* notes applet should be resized when the text is bigger that current size (emilsedgh)
* Kickoff: Clicking the applications tab, when the tab is open should return it to top-level.Current catalog-memory is a good feature however, so keep that aswell. (eirik_)
* Colorpicker and Kickoff plasmoid don't have context menu, so they can't be removed. (TunaTom)
** context menus are going to be replaced by hover-action-icons (ivan)
** Lancelot now has context menu and is (re)movable (emilsedgh)
* Running plasma with QT_FLUSH_PAINT I can see lots of extra repainting. For example the panel is very bad. (rich)
* Plasma is shown in the Alt+Tab windowlist, this should not happen (especially since switching to this app then does nothing visually except lose focus from the toplevel window) (BCoppens)
* Analog Clock: add text & seconds indicator. Change size to 400. Is so SLOW that it easily skips 3 seconds per redraw! (Core2 Duo 2.20GHz, Quadro FX 570M, nvidia binary drivers, Thinkpad T61p) (BCoppens)
* Digital clock is useless by its inconfigurability: I'm not interested in a disorganized list of timezones, no, I want a) the date underneath, b) a less fancy digital font instead of the current one with the distracting 'line' in the middle. (BCoppens)
**The date format is not affected by the settings in KControl.<JRT>
** Time Zone list should be redundant in configuration since the TZ should be set in KControl. All that is needed is an option to display it. Note, I think that this is the standard timezone list. If what is wanted is an option to display a TZ other than the user's TZ, this should be a separate context menu item. <JRT>
* Kickoff does not start firefox. It loads the .desktop file in kwrite (amp)
* The Lock/Logout Widget has rectangular buttons -- should have square? IAC, icons should be centered on buttons. <JRT>
*System Tray Widget doesn't work correctly: The Widget doesn't size itself to hold the contents. The contents seem to have the wrong X display priority (they are always on top). It (the contents, not the widget) interacts with windows (snap). The contents are only displayed on Desktop #1. When something triggers a refresh of something, then the SystemTray widget resizes and looks correct but the icons are still not working correctly. They are only on DeskTop #1 and always on top. <JRT>
*The Application Launcher Widget seems to be stuck in the middle of the screen; I can't drag it. In this position with 1024x768 the menu window does not open correctly. It extends beyond the top of the screen and is cut off. <JRT>
*The Clock on the Panel slides over and winds up on top of the TaskBar on the Panel.<JRT>

==== System Settings ====
* systemsettings has no menu entry. Typing it into kickoffs search entry doesn't find/list it either. (mbiebl)
* When clicking on "Appearance", it seems to delete a file. http://rafb.net/p/zzS2fM55.html (Mogger)
**When I select "Appearance" in "System Settings", three "Progress Dialog" boxes pop up.<JRT>
* Missing "get root rights" button on pages like Date/Time, thus its impossible to change such settings (apaku)
* Searching something doesn't seem to limit the displayed modules or highlight any of the search results.
* no settings to be changed for keyboard shortcuts - everything is empty (nixternal)
**This is probably a function of your system configuration. IIUC,It reads an X11 file. <JRT>
* When clicking e.g. "Appearance", the System Settings window doesn't get resized. This causes very ugly (horizontal and vertical) scrollbars (gissi)
* Default size for the text beneath the icons is too small. I see stuff like 'ppearanc' instead of 'Appearance' and 'ccesibilit'. Some other texts are wide enough, like 'Splash Screen'. (BCoppens)
* Changing the style to Oxygen changes all windows, EXCEPT the System Settings (BCoppens)
*Regional & Language::Time & Dates (should that be "Time & Date"?) doesn't have USA style date formats in "Short date format": MM.DD.YYYY & mM.dD.YYYY and should also have formats with only 2 digits for year: YY.

==== KMix ====
* <s>m_qcb->blockSignals( true ); where m_qcb is null from MDWSlider::updateInternal during kmix startup http://pastebin.ca/759601 (jstubbs)</s> Fixed by SVN commit [http://websvn.kde.org/?view=rev&revision=732246 732246]
* <s>Right click on KMix icon in system tray, select master channel, dialog comes up empty, when you close it KMix icon disappears from the tray (JLP)</s> Fixed by SVN commit [http://websvn.kde.org/?view=rev&revision=732367 732367]

==== KWin ====
* Windows are not fully redrawn when minimizing and then restoring with OpenGL compositing in use (jstubbs)
* the compositing KCM should provide an easy way to enable the COMPOSITE extension (logixoul)
* <s>Menu shadows are being left on the desktop (but not on windows, it seems) (Mogger)</s> Fixed by SVN commit [http://websvn.kde.org/?view=rev&revision=732268 732268]
* Sometimes (tested with Konsole, X.org 7.3, latest nvidia drivers and a Geforce 5900XT), the clicked menus are not displayed and KWin crashes. Backtrace : [http://rafb.net/p/zmYj1980.html] (idem)
* After a while the alt-tab window list is completely missing though I can still switch between windows with alt+tab (apaku)
* alt+tab only allows to switch between windows on the same screen in a multihead setup, its impossible to activate a window on another screen (though its on the same virtual X11 desktop) (apaku)
* alt+tab (without compositing) shows a list of windows but no indication which window in this list is selected when cycling through them. (goliath23)
* KWin does not detect compositing ability on my pc with a GeForce 7600 GS (driver version 100.14.19) (goliath23)
* The Composite Effect 'Demo Liquid' crashes KWin (BCoppens)
* 'Scale In' effect also scales in Menus and Dropdown boxes from the 'middle' of their target area, this is ugly. Either don't do that for such windows, or let them scale in from their topleft corner (BCoppens)
* Alt+Shift+Tab for backwards scrolling through Alt+Tab shortcut is not assigned, but I can't remember if this was the case in KDE3 as well or not... (BCoppens)
*Moving windows with "Display Content" turned off does not display an empty frame. (using an OpenSource driver)<JRT>

==== KNS ====
* KNS uses 100% CPU when 550 is enabled in kdebugdialog (jstubbs)
* Sometimes KNS dialog is under Settings dialog (Kanagram and KStars) modal/non-modal issue when KNS is invoked from a Config dialog (jstubbs)

==== KHangMan ====
* <s>"Already Guessed" tooltip timer does not work.</s> FIXED annma r732068
* <s>When changing the "Already Guessed" tim in Config, the current word should stay (KHangMan jumps to a new word).</s> FIXED annma r732068
* After typing an already typed letter, the focus is left on the guess "button", which means I have to press tab to get back to the letter entry field. If we enable the focus back before tooltip is hidden, it means the tooltip has to be hidden when a new letter is entered. (jstubbs)
** annma: intented behaviour is that the input is impossible why popup is shown. To leave the kid the time to understand what he is doing. Messing with the tooltip now seems bad to me. It's a WON'T FIX until we have it tested with kids ;) sorry jstubbs!
* <s>See if the font progressbar can disappear after first run (jstubbs)</s>
** annma: Removing your ~/.fonts/d dustismo_roman.ttf will make the bug go away. The font will reinstall and then it'll be found. Not sure why it happened...
* Test what happens for the fonts when no internet connection (jstubbs)
* Wish: when using the Special chars toolbar, letters should go immediatly in the word or in Missed. Annma is not sure this would work with kids, they maybe won't understand what happens. (jstubbs)
** annma: maybe a config option for KDE 4.1 as we are in feature freeze now.
* Language combo in toolbar does not resize correctly when changing language. (jstubbs)
* <s>Right-clicking "Type accented letters" does not offer the context sensitive help when the option is disabled. (jstubbs)</s>
** annma: this is from Qt, it's default behaviour for QWhatsThis help.

==== Kiten ====
* Searching for "one" takes a long time to process, during which the application blocks without any feedback. (jstubbs)
* From the Search menu, selecting Search {with Beginning of Word, Anywhere}, Grade or Strokes does not seem to have any affect (jstubbs)
* Selecting Verb or Noun from the grammatical element dropdown does not seem to have any affect (jstubbs)

==== KBruch ====
* In fraction tasks, the denominators used sometimes exceed the max denominator that is set. (jstubbs) r732343 attempted to fixe it but not totally

==== KPercentage ====
* <s>When starting a new set of tests, and on various other actions, the window unnecessarily moves to the centre of the screen (jstubbs)</s> Fixed r732700

==== KGeography ====
* <s>Intermittent crash after a placing state on a map (jstubbs)</s> Fixed r732331 (tsdgeos)
* <s>Selecting zoom when placing state on a map leaves the cursor as the state to be placed - perhaps the cursor should change back to a pointer while in zoom mode? (jstubbs)</s> Fixed r732314 (tsdgeos)
* With KWin's dimming of inactive windows, it is difficult to relate the colors signfying right/wrong answers back to the map (jstubbs)

==== KmPlot ====
* Editing function does not work as if Enter is not doing anything (rivo, gissi and idem-kde4) Annma cannot reproduce.
**Note by gissi: For me, only editing a cartesian plot doesn't work, the others work as expected. Don't know wether that's the same for rivo and idem.

==== KMail ====
* Creating a new Imap Account and press "Check what the Server Supports" in Security crashes KMail. Stacktrace / ConsoleLog at http://pastebin.ca/759562 (voltaire)
:: This is probably a KSSL problem, which will be fixed when the new KSSL arrives in kdelibs --[[User:TMG|TMG]] 00:03, 4 November 2007 (CET)
* <s>If I open a link from an email it opens it but then it crashes - Backtrace http://pastebin.ca/759997 (frank95com)</s>
:: <s>This is a kdelibs (krun) bug, it happens in other apps, like Konsole, as well</s> --[[User:TMG|TMG]] 00:03, 4 November 2007 (CET)
:: Fixed in kdelibs --[[User:TMG|TMG]] 21:27, 6 November 2007 (CET)
*When an IMAP server stops responding KMail popups up the "IMAP Disconnected" dialog with an "Ok" button. Clicking "Ok" crashes KMail. Stack Trace: http://www.pastebin.ca/759969 (JustinNoel)
* KMail initial account wizard. A process related to the KMail initial setup wizard crashes when "Check for supported security capabilites on..." appears. Console spew suggests something crashed. KMail starts with an IMAP account with an incorrect security configuration. Description/Reproduction Steps/Console Spew: http://www.pastebin.ca/760052 Needs verification as I only have one IMAP server to try. (Justin Noel)
:: Seems like the same bug above, the one reported by voltaire. --[[User:TMG|TMG]] 00:03, 4 November 2007 (CET)
* KMail with disconnected IMAP: after customizing options and restart, it crashes on startup http://pastebin.ca/764484 ([[User:Lure|Lure]] 09:07, 7 November 2007 (CET))

==== Build issue ====
* in kdebase when OpenGL is not found, cmake stops with "CMake Error: This project requires some variables to be set, and cmake can not find them. Please set the following variables: OPENGL_gl_LIBRARY (ADVANCED)" so there is a bad check somewhere in kdebase (annma, issue of frank95com, http://pastebin.ca/759575). Possible patch: http://pastebin.ca/759603 (annma). Other possible patch by ThomasZ: http://pastebin.ca/759605
* In kdebase on OS X 10.5 the build WITH_XKB = OFF variable is not respected resulting in failure of the build. (build process info found at http://techbase.kde.org/Getting_Started/Build/KDE4/Mac_OS_X_10.5_issues) Sorry it's so wordy, but I initially wrote it up for personal use.

==== Kolf ====
* The direction and velocity marker flickers and often cannot be seen. Using opengl compositing. (jstubbs)

==== KDElibs ====
* <s>The tab order of the configure shortcuts dialog is incorrect. (Mogger)</s> Fixed by SVN commit [http://websvn.kde.org/?view=rev&revision=732404 732404]''
* Drag and drop doesn't work in the configure toolbars dialog. (Mogger)
* Applications crash when downloading something. Traceback from Konsole when clicking on a link: http://rafb.net/p/1aiHyn63.html (Mogger)
* cannot write Right-To-Left...in kde3 when you start a line with a character of an rtl language, the line goes rtl automatically (emilsedgh)
* Configure shortcuts dialog is too small at start: I cannot see the action name at all (it says stuff like 'C...' instead of 'Close'). Furthermore, and much worse: I cannot change the width of the columns at all to try to make the action names readable! (BCoppens)

==== Konqueror ====
* Website http://kriptopolis.org it is really bad rendered, however it is fine with Konqueror 3.5.7. (q3xr2)
* often doesn't load pages properly, for example clicking the login link on a techbase page almost always gets me an empty page (apaku) (frank95com too, gruf too)
* Cannot show thumbnails (emilsedgh)
** fixed by mlaurent (logixoul)
* Up Button loads a different view, while back button doesn't, when walking through the filesystem. The up button loads a similar view to what you get in dolhpin, while the default view when typing in a local path is a plain iconview (apaku)
* When entering already visited directories, the animated logo doesn't stop. (Plain iconview instead of dolphin part?) (Mogger)
* Nothing in View -> Sort By, Additional Information, Panels, Navigation Bar submenus (yuriy)
* Nothing except "home folder" in home folder sidebar (yuriy)
* Some favicons do not appear in Konqueror's nav bar to titlebar. google.com and kubuntu.org works. kde.org, cnn.com and slashdot.org do not work. (JustinNoel)
* pressing ctrl+a when focus is on addressbar selects whole webpage instead of the text that is written in the addressbar (only on webpages: khtmlpart?) (emilsedgh)
* have to keep refreshing pages in order for them to display (nixternal)
* have quite a few problems trying to edit this page alone (nixternal)
* In file management mode it can't show hidden files, it doesn't have this option in the View menu, neither there is a shorcut available. (q3xr2)
* In HTML forms (such as the textbox to edit this wikipage with, or the username box), the initial fontsize is small. Once I click on the form, the font suddenly enlargens. Especially annoying with this editbox, since the place where you think you clicked changes after fontsize change (BCoppens)
* Asks nicely if it has to store my form data (such as password and username in the Wallet, but does not actually do so (BCoppens)
* Clicking on a link to an in-page 'tag' (the a href=#tag thing, like there are lots of in the index of this wiki page), results in konqueror showing the 'Drag link' mouse cursor (BCoppens)
* Not only do I get blank pages, but I get the following on trying to edit this wiki with Konqueror of KDE4: after sending in the changes, it shows a blank page. I press F5, and Konq asks me to resubmit form data. Wiki then shows an almost-empty edit page, with 'Sorry! We could not process your edit due to a loss of session data' (BCoppens)
* Start Konq. Press 'Next: An Introduction to Konqueror'. The page goes blank, and 'Previous page' also shows up blank. (BCoppens)
* With Konqui becoming webbrowser as primary task, it would make sense to redesign the start page altogether and remove stuff like Storage media, Trash etc. Show something like "Search the web" which points to a search engine, like Google, yahoo,...
* Start Konq. Enter '~'. Make a new tab (CtrlShift+N). Type something. Note how the cursor goes OVER the map icon, instead of starting next to it (BCoppens)
* (Different from the one above) Start Konq. Enter '~'. Make a new tab (CtrlShift+N). Enter '/'. Switch back to the first tab. It's caption suddenly changes from '/home/kde4/' to 'kde4'! Switching to the second tab, removes the '/' and makes that tab nameless) (BCoppens)

==== IO-slaves ====
* Browsing with IO-slaves that require autenthication is broken: SMB, FTP, SSH do not display anything after authentication is entered (luca_b, nixternal, yuriy).
* When adding RSA keys using fish:/, the buttons to accept/refuse are blank. (luca_b, yuriy)
* smb:/ ioslave causes crash (nixternal)
* smb:/ ioslave does not work with shares that need authentication. Console output: http://pastebin.ca/760196 (luca_b)
* kio_file: After a while I have 100% of CPU usage when running KDE4. top says, the process is kio_file, which is sometimes up to 4 times running (amp)
* The settings:/ ioslave (accessible through Settings on the welcome screen of Konq) does not work at all. For example, try Appearanc&Themes -> Fonts: it tries to open this with KWrite! (BCoppens)

==== Color KCM ====
* Changing the checkbox "Apply colors to non-KDE4 apps" doesn't trigger the changed signal and thus the apply button in systemsettings stays grayed out (apaku)
* the same as above applies to the whole Effects tab (apaku)

==== Kate ====
* Crash when going down page-wise with PageDn beyond the end of the file. Backtrace: http://www.apaku.de/vardata/kate_crash_pagedn (apaku)

==== Marble ====
* Navigate to Minneapolis (search is quick) and then zoom in until "saint paul" appears. Rotating up and down will now cause the text "saint paul" to jump around. (jstubbs)
* In full screen mode, clicking in the right half of the globe doesn't work. It seems that plasma is getting the events? (jstubbs)

==== Kinfocenter ====
* Most of the Items are empty (emilsedgh)

==== Kopete ====
* Adding an account a second time (same protocol, same user id as an existing) makes kopete crash (moi1392, idem-kde4). http://pastebin.ca/759660. More verbose fix in the works (Earthwings). http://lists.kde.org/?l=kopete-devel&m=119411618226111&w=2
* I can't get my Google Talk account to finish it's authentication process, however I can login without any troubles with my jabber.org account. I don't know if the trouble it's related to the SSL login or qca-tls which I have installed (q3xr2).
** Google Talk did not work before for me, but it works now (with today's SVN version), maybe you should retest with current SVN version.
* Configure->Plugins results in consistent crash here http://pastebin.ca/764575 ([[User:Lure|Lure]] 12:34, 7 November 2007 (CET))

==== kfind ====
* kfind crashes when the find is stopped (by pressing "stop" button) during the find process (shaga)
* the stop button has to be pressed twice, the first click is lost (shaga)

==== Gwenview ====
* Random crashes when navigating to directories, or when editing the path manually. Backtrace http://pastebin.ca/760077 (luca_b)

==== Login Manager KCM ====
* There are numbers on the tabs (yuriy)
** yes - the kcm is too big to have non-clashing letter shortcuts.

==== kscd ====
* crashes when inserting a CD. Problem is an assert thats hit (apaku):
kscd(31228)/kdecore (KConfigSkeleton) KConfigSkeleton::readConfig: KConfigSkeleton::readConfig()
kscd(31228)/libkcddb KCDDB::Cache::lookup: Looking up "ae0cdb0e" in CDDB cache
kscd(31228)/libkcddb KCDDB::CDInfo::load: Loaded CDInfo for "ae0cdb0e"
kscd(31228)/libkcddb KCDDB::Client::lookup: Found 1 hit(s)
ASSERT: "info.numberOfTracks() == cddbInfo.numberOfTracks()" in file /home/andreas/KDE-work/4.0/kdemultimedia/kscd/kscd.cpp, line 753
* crashes when starting up (but not if the user does not have permissions to acces the cdrom) backtrace: http://pastebin.ca/760172 (yuriy)
==== KFontChooser ====
*It doesn't work correctly for the bit mapped fonts Fixed[Misc] & Fixed[Sony] which come with X11 are the best example of this since they might be used in Konsole. This is mainly a Konsole issue. <JRT>
**There should be only 2 sizes of Fixed[Sony] which works correctly in KDE3 it displays only two sizes. I'm not 100% clear on how this works if you have a screen resolution other than 75 or 100, but xfontsel lists two point sizes for 100 dpi: 12 & 17 and this agrees with the KFontSel dialog. But in KDE4 it lists the usual list of sizes from 4 to 64.
**There are several sizes of Fixed[Misc], according to xfonsel they are: 5, 6, 7, 8, 10, 11, 12, & 14. KDE has this fairly close to correct -- close enough that it works OK. It also lists 4 which may be a 75 dpi font and it lists 9 but not 12. Could these be rounding errors? IAC, KDE4 is the same as with Fixed[Sony], it has the standard list of 4 to 64.
*We need to first ask if this is a Qt bug/error as are other font issues.
**The Fixed{Misc} fonts are not a uniform set of fonts and I don't think that there is any way that Qt can deal with this issue.

==== Akregator ====
*Crashes while trying to delete a feed.
==== Kontact ====
*Crashes starting the application.
::We need a backtrace, otherwise we can't do anything. It doesn't crash for us. --[[User:TMG|TMG]] 21:24, 6 November 2007 (CET)

==== KDEPrint ====
*Printing a html file from konqueror. The "HTML Settings" tab has an odd layout. It seems to miss a proper border. (mbiebl)

Contribute/Bugsquad/KrushDays

2007-11-03T13:22:00Z

Logixoul:

Contribute/Bugsquad/KrushDays

2007-11-03T11:13:27Z

Logixoul:

Contribute/Bugsquad/KrushDays

2007-11-03T11:01:32Z

Logixoul:

Contribute/Bugsquad/KrushDays

2007-11-03T10:49:55Z

Logixoul:

Contribute/Bugsquad/KrushDays

2007-11-03T10:41:05Z

Logixoul:

KDE System Administration/KDE Filesystem Hierarchy

2007-09-09T21:55:27Z

Logixoul: KDE System Administration/Filesystem Hierarchy moved to KDE System Administration/KDE Filesystem Hierarchy over redirect: name conflicts with "XDG Filesystem Hierarchy" so...

== Introduction ==
KDE defines a filesystem hierarchy that is used by the KDE environment
itself as well as all KDE applications. In general, KDE stores all its
files in a fixed directory tree.

By default, there are two such directory trees: one at the system
level and one at the user level in the user's home directory. However,
as a system administrator you can create additional trees.

KDE and KDE applications look up files by scanning the directory trees
in order of precedence. When a file is
present in multiple directory trees, the file from the first-listed
tree takes precedence.
Normally, the tree located in the user's home directory has the highest
precedence. This is also the directory tree that changes are
written to.

For configuration files, the story is slightly
different. If multiple configuration files with the same name are found in the directory
trees, their content is combined. The precedence order
of the directory trees plays a role here: when two files define the same
configuration key, the file with the highest precedence determines which
value is used for the key.

== Location of the Directory Trees ==

The location of the KDE Directory Trees is determined by a number of
environment variables, each of which is covered below.

=== KDEHOME ===
The <tt>KDEHOME</tt> environment variable determines the location of the user-level
directory tree and is used by KDE applications for creating and saving
files. This directory tree has the highest precedence; files or settings
found in this directory tree will take precedence over any files or settings
found in other directory trees.

This directory tree is, as the name suggests, normally located in the user's home directory. If this environment variable is not defined, the default location <tt>$HOME/.kde</tt> is used.

If the environment variable has a value that starts with a tilde (~), the tilde is replaced with the user's home directory at runtime. In order to use this, care must be taken to add proper quoting, otherwise the shell might do the expansion, resulting in undesired behavior in combination with <tt>su</tt>.

=== KDEROOTHOME ===
In order to prevent problems with applications that run as root saving
files with root access permissions in the user's home directory, the <tt>KDEROOTHOME</tt>
environment variable has been introduced in the KDE 3.x series. Applications
that run with uid 0 (root) will use this variable to determine the location of
the user level directory and where to save their files. If this variable is
not defined, the root user's home directory is looked up in the password
file and .kde is appended. Usually that results in <tt>/root/.kde</tt> .

=== KDEDIRS ===
It is possible to specify multiple system-level directory trees. This allows groups of users to each dedicate a directory to their group. Such an additional directory tree can contain additional applications, specialized application resources or a specific set of default configurations suitable for the group. Specifying default configurations this way instead of using a /etc/skel construction has the advantage that changes in the default configuration can be made after the user's account has been created.

The directories in $KDEDIRS should be separated with a colon (:). The directories are listed in order of precedence: the first directory has the highest precedence, the last one has the lowest precedence.

Since a group-level directory tree should normally override any settings present at the system level, one should list the group-level directory tree before the system level directory tree.

In general communication, references to the directory trees are made in
terms of $KDEHOME to indicate the applicable user-level directory tree,
and in terms of $KDEDIRS to indicate any of the system-level directory trees.

==== Example ====

A staff member at a university could have the following settings:

<code>
KDEHOME='~/.kde3'
KDEROOTHOME='/root/.kde3'
KDEDIRS='/opt/kde_staff:/opt/kde3'
</code>

In this example the user settings are saved under the .kde3 directory
in the user's home directory. Applications that run as root will save their
settings to /root/.kde3 . KDE 3 has been installed to /opt/kde3 but there is
also an additional directory tree located at /opt/kde_staff . Configuration
files under that directory will take precedence over the ones in the /opt/kde3
system directories. /opt/kde-staff could contain additional applications that
should only be available to staff members.

== Directory Tree ==

Each directory tree used by KDE has a fixed directory structure. However, directories
that are not relevant for a certain tree can be left out. For example,
directories used for temporary files are usually only found under $KDEHOME but
not in any other directory tree.

The KDE runtime environment combines the subdirectories found under the
various directory trees and refers to them as a single KDE resource. The
KDE resource name is listed in the tables below.

There are three broad categories: files that are
CPU/architecture-specific, files that are host-specific and files that are not specific with
regard to host, CPU or architecture.

CPU/architecture-specific directories:

{|
|-
! Directory !! KDE resource !! Description
|-
| {{path|bin/}} || exe || Used for KDE executables.
|-
| {{path|cgi-bin/}} || cgi || CGI scipts that can be used by the KDE Help Center.
|-
| {{path|lib/}} || lib || Used for KDE libraries.
|-
| {{path|lib/kde3/}} || module || This directory contains components, plugins and other runtime loadable objects for use by KDE 3.x applications.
|}

The following are host-specific directories. They are only available under
$KDEHOME and are normally symlinked to locations outside the $KDEHOME
directory tree.

{|
! Directory !! KDE resource !! Description
|-
| {{path|socket-<HOSTNAME>}} || socket || This directory contains communication sockets. The filesystem used by $KDEHOME may not be suitable for communication sockets. For that reason this directory is symlinked to another location by default.
|-
| {{path|tmp-<HOSTNAME>}} || tmp || This directory is used for temporary files. The filesystem used by $KDEHOME may be on a network. For performance reasons, this directory is therefore symlinked by default to another location which is more likely to be on a local filesystem.
|-
| {{path|cache-<HOSTNAME>}} || cache || New in KDE 3.2. This directory is used for cached information such as HTTP objects, formatted help pages and the system configuration cache (ksycoca).

Since this is non-essential information, this directory is
symlinked to a location outside $KDEHOME by default, to make it easier
to make backups of other information and to reclaim diskspace.
|}

The majority of directories involves data that is not CPU-, architecture- or
host-specific. All these directories are prefixed with {{path|share/}}:

{|
! Directory !! KDE resource !! Description
|-
| {{path|share/applnk/}} || apps || Contains .desktop files describing the KDE menu.
|-
| {{path|share/apps/}} || data || Contains application-specific data files. Each application has a subdirectory here for storing its files.
|-
| {{path|share/config/}} || config || Contains configuration files. Configuration files are normally named after the application they belong to followed by "rc". There are also files that are specific to a component and as such referenced by all applications that use that component. A special case is "kdeglobals": this file is read by all KDE applications.
|-
| {{path|share/config/session/}} || - || This directory is used by session management and is normally only available under $KDEHOME. At the end of a session KDE applications store their state here. The file names start with the name of the application followed by a number. The session manager "ksmserver" stores references to these numbers when saving a session in "ksmserverrc".
|-
| {{path|share/doc/HTML/}} || html || Documentation of KDE applications is stored here. Documentation is categorized by language and the application it belongs to.

Normally at least two files can be found in a directory: "index.docbook" which contains the documentation in the unformatted docbook format and "index.cache.bz2" which contains the same documentation formatted as bzip2 compressed html. The html version is used by khelpcenter; if the html version is missing, it will regenerate it from the docbook version, but this is a time-consuming process.
|-
| {{path|share/icons/}} || icon || Icons are stored under this directory, categorized by theme, dimension and usage category.
|-
| {{path|share/mimelnk/}} || mime || Up until KDE4, .desktop files that describe MIME types were stored in this directory.
|-
| {{path|share/mime/}} || mime || Starting with KDE4, desktop files that describe MIME types are stored in this directory. This data is shared by other software as well and is part of a freedesktop.org specification.
|-
| {{path|share/services/}} {{path|share/kde4/services/}} || services || This directory contains .desktop files that describe services. Services and Applications are very similar; the major difference is that a Service is usually used by other Services or Applications while an Application is in general started by the user. Services do not appear in the KDE menu.
|-
| {{path|share/servicetypes/}} {{path|share/kde4/servicetypes/}} || servicetypes || This directory contains .desktop files that describe service types. A service type usually represents a certain programming interface. Applications and Services include the servicetypes that they provide in their .desktop files.
|-
| {{path|share/sounds/}} || sound || This directory contains sound files.
|-
| {{path|share/templates/}} || templates || This directory contains templates for creating files of various types. A template consists of a .desktop file that describes the file and that includes a reference to a file in the .source subdirectory. The templates in this directory appear in the "Create New" menu available on the desktop and in the file browser. When a user selects a template from the menu, its source file is copied.
|-
| {{path|share/wallpapers/}} || wallpaper || This directory contains images that can be used as background pictures.
|}

== Outside the Directory Tree ==

As mentioned in the description of the directory tree, there are three host-specific directories that are usually symlinked to other locations. If the directories do not already exist, the following symlinks and directories will be created using the <tt>lnusertemp</tt> utility. Since both <tt>/tmp</tt> and <tt>/var/tmp</tt> are world writable, there is a possibility that one of the mentioned directories already exists but is owned by another user. In that case the <tt>lnusertemp</tt> utility will create a new directory with an alternative name and link to that instead.

=== Sockets ===
Symlink: {{path|$KDEHOME/socket-<HOSTNAME>}}

Default destination: {{path|/tmp/ksocket-<USER>/}}

<tt>lnusertemp socket</tt> creates a directory for local communication sockets and point a symlink to it. The combined length of the directory name and the name of any communication socket should not exceed 106 characters. By default this directory is created under <tt>/tmp</tt>, other locations can be used by setting the KDETMP environment variable.

=== Temporary Files ===
Symlink: {{path|$KDEHOME/tmp-<HOSTNAME>}}

Default destination: {{path|/tmp/kde-<USER>/}}

<tt>lnusertemp tmp</tt> creates a directory for temporary files and points a symlink to it. For performance reasons it is recommended to have this directory on a local filesystem but this is not strictly necessary.

=== Cache Files ===
Symlink: {{path|$KDEHOME/cache-<HOSTNAME>}}

Default destination: {{path|/var/tmp/kdecache-<USER>/}}</code>

<tt>lnusertemp cache</tt> creates a directory for cache files and points a symlink to it. For performance reasons it is recommended to have this directory on a local filesystem but this is not strictly necessary.

The system configuration cache (ksycoca and ksycocastamp) is located in here. It is recommended NOT to delete these files during boot since that will slow down the startup of KDE.

By default this directory is created under <tt>/var/tmp</tt>, other locations
can be used by setting the KDEVARTMP environment variable.

== Adding Lookup Locations ==

KDE applications look up data files using the resource names listed in the
[#dir_structure Directory Tree] section. The KDE runtime
environment translates these names to actual directories
by combining the locations of the directory trees with the directories
listed in the tables.

==== Defining Search Paths ====

A user has the following directory tree settings:

<code>
KDEHOME='~/.kde3'
KDEDIRS='/opt/kde_staff:/opt/kde3'
</code>

When an application now looks for a "wallpaper" file, the directory "share/wallpapers/" is added to each of the
directory trees. All of the
resulting directories are then searched for the file:

<code>
~/.kde3/share/wallpapers/
/opt/kde_staff/share/wallpapers/
/opt/kde3/share/wallpapers/
</code>

By adding more directory tree to the KDEDIRS environment variable
it is possible to expand the number of directories that are being searched.
Sometimes it is desirable to include only a single directory in a search
but not a whole directory tree. Additional directories can be configured
in the kdeglobals configuration file in the "Directories" section.
To do so assign one or more directories to the key "dir_" followed by the
name of the resource. Multiple directories are separated by commas (,).

==== Adding a Resource Directory ====

To add the directory /data/photos to the wallpaper resource, put the
following two lines in kdeglobals:

<code ini>
[Directories]
dir_wallpaper=/data/photos
</code>

When the application now looks for wallpaper files, it will look in the
following locations:

<code>
/data/photos
~/.kde3/share/wallpapers/
/opt/kde_staff/share/wallpapers/
/opt/kde3/share/wallpapers/
</code>

KDE System Administration/KDE Filesystem Hierarchy

2007-09-09T21:49:52Z

Logixoul: KDE System Administration/KDE Filesystem Hierarchy moved to KDE System Administration/Filesystem Hierarchy: tautology

MediaWiki:Oxygen.css

2007-09-09T21:16:20Z

Logixoul:

#body {border-left: 1px solid #bcbcbc;}

#footer {
border-top: 1px solid #bcbcbc;
border-bottom: 1px solid #bcbcbc;
}

.navlist {float: left;}
.navlist li {list-style-type: none;}
.navlist li img {vertical-align: middle;}
.allpagesredirect a {font-size: .5em; color: grey !important;}

MediaWiki:Oxygen.css

2007-09-09T21:16:00Z

Logixoul:

MediaWiki:Oxygen.css

2007-09-09T21:15:49Z

Logixoul:

MediaWiki:Oxygen.css

2007-09-09T21:15:03Z

Logixoul:

Development/Tutorials/CMake

2007-09-09T19:43:54Z

Logixoul: /* Using CMake for a KDE Project */ rm superfluous space

{{Template:I18n/Language Navigation Bar|Development/Tutorials/CMake}}

== Introduction ==
CMake reads script files and produces input files for the native buildsystem of the platform where it runs on. It can create GNU Makefiles, KDevelop project files, XCode project files, and Visual Studio project files.

CMake is free software and released under a BSD-style license. It is developed by [http://www.kitware.com Kitware Inc.]

Here are some good places to learn about CMake in general:
* [http://www.cmake.org/HTML/Documentation.html CMake Manual]
* [http://www.cmake.org/Wiki/CMake CMake Wiki]
* [http://www.cmake.org/Wiki/CMake_HowToDoPlatformChecks CMake System Checks ]
* [http://www.cmake.org/Wiki/CMake_HowToFindInstalledSoftware Finding Optional Packages ]
* [http://www.cmake.org/Wiki/HowToBuildKDE4Software KDE 4 Tutorial at the CMake Wiki ]
* [http://www.cmake.org/Wiki/CMake_FAQ CMake FAQ]
* [http://mail.kde.org/pipermail/kde-buildsystem/ The kde-buildsystem Mailing List Archive]

Also, consider joining the [http://www.cmake.org/mailman/listinfo/cmake CMake mailing list].

== Why use CMake ? ==
CMake is the official tool of KDE 4 release, decided in March 2006, primarily due to technical merits as compared to the older KDE tools automake and unsermake:
* CMake is developed independently of KDE, it can be used by other projects as well
* Compilation time is much faster, mainly due to not using libtool anymore
* The build files are easier to write

== How to compile KDE using CMake==

=== Get and install CMake ===
==== Linux, BSD, and other Unix Systems ====
Retrieve the latest stable version of CMake from [http://www.cmake.org/HTML/Download.html].

Once downloaded, unpack and compile it:
<code>
$ mkdir cmake-build
$ cd cmake-build
$ ../bootstrap
$ make
$ make install
</code>

By default, this will install CMake in /usr/local, so make sure to have /usr/local/bin in your execute path. To change the installation prefix (e.g. to /usr in debian), add the '--prefix=PATH' option to the bootstrap command.

Please follow the instructions located [http://cmake.org/HTML/Download.html#cvs here] if you would like to use the current development version.

==== Windows ====
Retrieve the latest stable version of CMake from [http://www.cmake.org/HTML/Download.html].

Once downloaded, run the cmake installer.

By default, this will install CMake in C:\Program Files\CMake 2.4, so make sure to have <installpath>\bin in your execute path.

Please follow the instructions at [http://cmake.org/HTML/Download.html#cvs here] if you would like to use the current development version.

=== Run CMake ===

==== Linux, BSD, and other Unix Systems ====
You have to run CMake so that it generates the build files for your system. Both in-source and out-of-source builds are supported by CMake, but currently in-source builds are prevented by the KDE implementation.

So, let's say you have kdelibs/ in ~/src/kdelibs/, then do the following:
<code>
$ ls
kdelibs/
$ mkdir kdelibs-build
$ cd kdelibs-build
$ cmake ../kdelibs
</code>
This will generate the Makefiles for building kdelibs/ in kdelibs-build/.

==== Windows ====
You have to run CMake so that it generates the build files for your system. Both in-source and out-of-source builds are supported by CMake, but currently in-source builds are prevented by the KDE implementation.

So, let's say you have kdelibs\ in c:\daten\kde4, then do the following:
<code>
c:\daten\kde4> cd kdelibs\win
c:\daten\kde4> cmake
c:\daten\kde4> make
c:\daten\kde4> make install
c:\daten\kde4> cd ..
c:\daten\kde4> mkdir kdelibs-build
c:\daten\kde4> cd kdelibs-build
c:\daten\kde4\kdelibs-build> cmake ..\kdelibs
</code>

This will generated the Makefiles for building kdelibs\ in kdelibs-build\. See [[KDE On Windows]] for more informations about compiling KDE on Windows.

==== KDevelop Project Files ====
If you prefer project files for KDevelop (which will basically be Makefiles accompanied by some extra files for KDevelop), run it like this:
<code>
$ cmake ../kdelibs -GKDevelop3
</code>
Use 'cmake -h' to find out which generators CMake supports and the other options.

==== CMake and Qt4 ====
To locate Qt 4, CMake searches for qmake in your execute path. CMake does ''not'' use the QTDIR environment variable. So make sure that the first qmake found in the execution path is the one you like to use.

==== More Details ====
When CMake has finished, it will have created a file called "CMakeCache.txt". This file contains all the settings CMake has detected on your system. If you want to run CMake with another generator or you want CMake to detect everything again, delete this file.

If CMake didn't find something, but you know it is somewere on your box, you can tell CMake manually where to find it. CMake uses variables to store this information. These variables are cached in the already mentioned file CMakeCache.txt. You have three options to adjust these variables manually:
* tell CMake the correct value via the command line: cmake ../kdelibs -DNAME_OF_THE_VARIABLE=value
* use ccmake, which provides a curses based GUI to adjust the CMake variables (run: ccmake ../kdelibs)
* edit the file CMakeCache.txt directly (not recommended)

You should run "ccmake ../kdelibs" at least once so that you get an impression which variables CMake uses. Press "T" to see also the "advanced" variables. So, if CMake didn't find something, start ccmake and adjust it manually.

Some variables you probably will want to set:
* '''CMAKE_INSTALL_PREFIX''': cmake ../kdelibs -DCMAKE_INSTALL_PREFIX=/opt/kde4 is the equivalent to ./configure --prefix=/opt/kde4
* '''CMAKE_BUILD_TYPE''': decide which type of build you want. You can chose between "debugfull", "debug", "profile", "relwithdebinfo" and "release". The default is "relwithdebinfo" (-O2 -g). See FindKDE4Internal.cmake for details.
* '''RPATH_STYLE''': This is not available anymore. By default everything will be built with RPATH set correctly. If you don't want RPATH at all, set CMAKE_SKIP_RPATH to TRUE.
* '''WITH_FOO''': there are several options, e.g. WITH_CUPS or WITH_Jasper. If you disable them, cmake will not even try to find this package. If it is enabled, cmake will try to find it. If it fails with this, you can still adjust it manually as described above.

=== Environment Variables ===
If you have headers and libraries installed in non-standard locations that cmake cannot find (e.g., fink on Mac OSX installs to /sw), then set the following as environment variables. Despite the similar naming convention, these will not work as arguments on the cmake command line:
* '''CMAKE_INCLUDE_PATH''', eg. export CMAKE_INCLUDE_PATH=/sw/include
* '''CMAKE_LIBRARY_PATH''', eg. export CMAKE_LIBRARY_PATH=/sw/lib

For more information on variables, see [http://www.cmake.org/Wiki/CMake_Useful_Variables this cmake.org wiki page]

=== Going Further ===
If cmake finishes with "Generating done" then there was no errors, but if it finishes with "Configuring done" then there was errors that you have to fix. Once cmake finishes successfully, run your buildtool (i.e. make, KDevelop, XCode or MSVC) and build and wait until it has finished. Then "make install".

If you got a failure that says something like
<code>
CMake Error: This project requires some variables to be set,
and cmake can not find them.
Please set the following variables:
X11_XTest_LIB (ADVANCED)
</code>
then you may have a missing library (or other dependency). To find
out which library, search in the cmake/modules directory for
the variable that cmake can't find. In the example above, it is
<code>
FIND_LIBRARY(X11_XTest_LIB Xtst ${X11_LIB_SEARCH_PATH})
</code>
So the missing library is Xtst. You then need to find it (perhaps installing a libXtst-devel library) and re-run cmake.

== Using CMake for a Simple Application ==

Here's the most simple CMakeLists.txt:
<code>
add_executable(hello main.cpp)
</code>
This will create an executable named "hello" (or "hello.exe" under Windows) from the source file main.cpp. You can mix C and C++ files as you want. You can have multiple executables and libraries in one CMakeLists.txt. The same source file can be used in multiple targets, it will be compiled for each target independently from the other targets. Probably the most important part of the cmake language are the variables:
<code>
SET( MY_SOURCES main.cpp widget.cpp)
MESSAGE(STATUS "my sources: ${MY_SOURCES}")
</code>
So, use the SET() command to set the value of a variable. If you list more than one string, the variable will be a list. A list is a list of strings separated by semicolons. If you set it to only one item, it will have just that value. To get the value of a variable, use ${VAR}.
You can iterate over a list using FOREACH():
<code>
FOREACH(next_ITEM ${MY_SOURCES})
MESSAGE(STATUS "next item: ${next_ITEM}")
ENDFOREACH(next_ITEM ${MY_SOURCES})
</code>
The commands in CMake are case-insensitive. Names of variables and names of parameter are case-sensitive.

You can also test for various things:
<code>
IF (UNIX)
MESSAGE(STATUS "This is UNIX (including OS X and CygWin)")
ENDIF (UNIX)

IF (MSVC)
SET(MY_SRCS ${MY_SRCS} winextra.cpp)
ENDIF (MSVC)
</code>
In this second example you can see also how to append items to a list.

In the cmake Wiki there is also a [http://www.cmake.org/Wiki/HowToBuildKDE4Software tutorial] on using cmake to build KDE 4 software. It is recommended reading.

== Using CMake for a KDE Project ==

Here's a basic CMakeList file that builds a small KDE 4 project:
<code>
PROJECT(kde4project)
FIND_PACKAGE(KDE4 REQUIRED)
INCLUDE_DIRECTORIES( ${KDE4_INCLUDES} )

SET(KDE4ProjectSources kde4mainapp.cpp someclass.cpp someotherclass.cpp)

KDE4_ADD_EXECUTABLE(kde4project ${KDE4ProjectSources} )

TARGET_LINK_LIBRARIES(kde4project ${KDE4_KDEUI_LIBS} ${KDE4_KPARTS_LIBS} )
</code>

== Extending CMake ==
CMake can be extended using cmake scripts. CMake comes with a number of scripts; under UNIX they are by default installed to /usr/local/share/CMake/Modules/. The KDE libraries install also a set of cmake modules into share/apps/cmake/modules/. The files located there will be preferred over the ones in the system global cmake module path.
For detecting software packages there are FindFOO.cmake files, see [http://www.cmake.org/Wiki/CMake_HowToFindInstalledSoftware here] for more information.
You can also write macros in CMake. They are powerful enough to do most things you will need to build software, but they are not intended to be used as a general purpose programming language.

== Converting autotools-based KDE software to CMake ==
In kdesdk/cmake/ you can find a script am2cmake . This is a ruby script, so you need to have ruby installed. Run am2cmake in the toplevel directory of your sources:
<code>
$ cd src/mykooltool/
$ am2cmake --kde4
</code>
Don't forget the switch "--kde4", otherwise it won't generate files suitable for KDE 4 software. The converted files 'may' work as they are, but complicated projects will require some additional editing.

You may have to:
* add more include direcories, using INCLUDE_DIRECTORIES()
* add more link libraries, using TARGET_LINK_LIBRARIES()
* add some compile switches, using ADD_DEFINITIONS()
* add some "configure" checks, see [http://www.cmake.org/Wiki/CMake_HowToDoPlatformChecks How To Do Platform Checks] and [http://www.cmake.org/Wiki/CMake_HowToFindInstalledSoftware How To Find Installed Software]
* take special care of former libtool convenience libraries. They are not supported by cmake, instead there will be a file ConvenienceLibs.cmake created. In this file you will find for every convenience lib a variable, which contains all source files of this convenience lib. For the targets which linked to this convenience lib, just add the variable to the sources.
* a file AdditionalInfo.txt will be created. There you will see all *.in and *.in.in files of your project. The stuff done in these files will have to be converted manually to cmake.

== Frequently Asked Questions ==

=== How can I teach my favorite editor about CMake syntax and indentation ? ===
Read the CMake Wiki section [http://www.cmake.org/Wiki/CMake_Editors_Support CMake Editors Support]. It describes how to setup Emacs (XEmacs works too), VIM, Kate, KWrite, and KDevelop.

=== I need to generate some files during the build. How do I do this ? ===
Use ADD_CUSTOM_COMMAND(). It's explained here in the CMake wiki: [http://www.cmake.org/Wiki/CMake_FAQ#How_can_I_generate_a_source_file_during_the_build.3F How can I generate a source file during the build]

=== I need to build an executable which is used later on during the build to generate files. How do I do this ? ===
Let's say the executable is called genembed. Then use KDE4_ADD_EXECUTABLE(foo RUN_UNINSTALLED ${fooSources})to create the executable. The RUN_UNINSTALLED option is important, because the executable has to run from the build dir and has to link to the libraries in the builddir. To achieve this, the executable is compiled with RPATH set accordingly and a wrapper shell script, named just like the executable but with the suffix ".sh" is created. This shell scripts sets up LD_LIBRARY_PATH and the calls the actual executable.
Use this wrapper shell script in the ADD_CUSTOM_COMMAND() as described above.
You can find out the name and exact location by querying the property WRAPPER_SCRIPT. Here's a full example taken from kdelibs/kstyles/keramik/ :
<code>
# build the executable
KDE4_ADD_EXECUTABLE(genembed RUN_UNINSTALLED ${genembed_SRCS})

# get the name of the generated wrapper script (which sets up LD_LIBRARY_PATH)
GET_TARGET_PROPERTY(GENEMBED_EXECUTABLE genembed WRAPPER_SCRIPT)

# and the custom command
ADD_CUSTOM_COMMAND(OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/keramikrc.h
COMMAND ${GENEMBED_EXECUTABLE} --file ${CMAKE_CURRENT_BINARY_DIR}/keramikPics.txt > \
${CMAKE_CURRENT_BINARY_DIR}/pixmaps.keramik
DEPENDS genembed ${keramikPics}
)
</code>

As you can see genembed is also listed as a dependency, this means cmake knows that it has to build the executable genembed before executing this rule.

=== I don't want to set the -DCMAKE_INSTALL_PREFIX command line option. Does cmake support the KDEDIR environment variable? ===
No. $KDEDIR is deprecated in KDE 4.

=== Why do i get compile errors like /usr/lib/qt4/include/QtCore/qstring.h:536: undefined reference to `QString::fromLatin1_helper(char const*, int)'? ===
A: If you have an old Qt4 version in your qt/lib directory you must delete the old (4.0.1) files.

=== How do I tell cmake to create noisy makefiles? I want to see the exact commands that are run during the make process. ===
Pass the VERBOSE variable to make, i.e.
<code>
% make VERBOSE=1
</code>
or
<code>
% VERBOSE=1 make
</code>

For more details see the CMake wiki: [http://www.cmake.org/Wiki/CMake_FAQ#Is_there_an_option_to_produce_more_.27verbose.27_compiling.3F Is there an option to produce more 'verbose' compiling?]

=== There is no 'make distclean' target in the generated Makefiles. How do I clean up everything, including the cache files? ===
Simply remove the build directory, or just the contents of the build directory.

[[Category:Programming]]
[[Category:Tutorial]]
[[Category:FAQs]]

Getting Started/Build

2007-09-09T19:04:27Z

Logixoul: rm redundant link

{{Template:I18n/Language Navigation Bar|Getting Started/Build}}
Here you will find instructions for compiling and installing KDE from source and suggestions for when compilation doesn't go so smoothly.

== Building The Source ==

; KDE 4 (Development version, trunk)
:Instructions for installing the latest and greatest KDE development source code on:
* [[/KDE4|Linux]]
* [[/KDE4/FreeBSD|FreeBSD]]
* [[/KDE4/Windows/GCC_And_MinGW|Microsoft Windows with GCC and MinGW]]
* [[/KDE4/Windows/MS_Visual_Studio|Microsoft Windows with Microsoft Visual Studio]]
* [[/KDE4/Mac_OS_X|Mac OS X]]

; [[/Stable Version|KDE 3.5 (Stable version)]]: Instructions for installing the latest stable KDE 3.5 release.

; [[/Older KDE Versions|Old Versions]]: Instructions for building older KDE versions.

; [[/Coexisting Versions|Coexisting Versions]]: Directions to build multiple KDE versions on the same machine simultaneously.

; [[/FAQ|FAQ]]: Help with errors and other questions you might have.

[[Category:Build KDE]]

Getting Started

2007-09-09T19:03:32Z

Logixoul: moving websvn last

{{Template:I18n/Language Navigation Bar|Getting_Started}}
{{Box|Getting the Source|
[[Image:Action_down.svg|right|32px]]
* [[/Sources/Anonymous SVN|Anonymous SVN Quickstart Guide]]
* [[/Sources/Using Subversion with KDE|Using Subversion with KDE]] ''A more in depth look at accessing KDE source code with subversion, including the repository layout and working with revisions and patches.''
* [[/Sources/Snapshots|Daily Snapshots]]
* [http://websvn.kde.org/ Browse Code Online]
|100%}}

{{Box|Building KDE|
[[Image:Action_tool.svg|right|32px]]
There are different KDE branches. For production use, a stable version of KDE is recommended.
* [[/Build/KDE4|KDE 4 (Development version, trunk)]]
* [[/Build/Stable Version|KDE 3.5 (Stable version)]]
* [[/Build|Other versions and FAQ]] ''Including information for building on non-linux systems''
|100%}}

{{Box|Setting up the Environment|
[[Image:Action_pen.svg|right|32px]]
After KDE has been built, you'll want a good way to launch apps and perform your regular development tasks:
* [[/Increased Productivity in KDE4 with Scripts|Increased Productivity in KDE4 with Scripts]]
* [[/Set up KDE 4 for development|Set up KDE 4 for development]]
|100%}}
[[Category:Build KDE]]

Getting Started/Build (fr)

2007-09-09T19:01:10Z

Logixoul: rm obsolete alpha

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

Vous trouverez ici toutes les informations nécessaire à la compilation et à l'installation de KDE depuis sont code source ainsi que des suggestions régler les problèmes de compilation.
== Construire KDE à partir du code source ==

; [[Getting Started/Build/Stable Version|KDE 3.5 (Version stable)]]: Instructions permettant d'installer la dernière version stable de KDE 3.5.

; [[Getting Started/Build/KDE4 (fr)|KDE 4 (Version instable, tronc)]]: Instructions pour installer la dernière et la meilleure version de développement du code source de KDE.

; [[Getting Started/Build/Older KDE Versions|Versions anciennes]]: Instructions ppour compiler d'anciennes versions de KDE.

; [[Getting Started/Build/Coexisting Versions|Versions Coexistantes]]: Indications permettant de compiler et installer différentes versions de KDE sur la même machine simultanément.

; [[Getting Started/Build/FAQ|FAQ]]: Aide a propos des erreurs et d'autres questions que vous pouriez vous poser.

== Liens supplémentaires ==
* Construire [http://solaris.kde.org/ KDE sur Solaris]
* Construire [http://www.kdelibs.com/ KDE sur Windows]
* Construire [[Getting Started/Build/KDE4/Mac_OS_X|KDE sur Mac OS X]]
* Construire [[Getting Started/Build/KDE4/FreeBSD|KDE sur FreeBSD]]

[[Category:Build KDE]]

Getting Started/Build (da)

2007-09-09T19:00:44Z

Logixoul: rm obsolete alpha

{{Template:I18n/Language Navigation Bar|Getting Started/Build}}
Her kan du finde instruktioner til at kompilere og installere KDE fra kildekoden og forslag til hvad man skal gøre når kompileringen ikke går så glat.

== Bygning fra kildekode ==

; [[Getting Started/Build/Stable Version|KDE 3.5 (Stabil version)]]: Instruktioner til at installere den seneste stabile KDE 3.5 udgivelse.

; [[Getting Started/Build/KDE4|KDE 4 (Ustabil version, trunk)]]: Instruktioner til at installere den seneste KDE udviklings kildekode.

; [[Getting Started/Build/Older KDE Versions|Gamle versioner]]: Instruktioner til at bygge ældre versioner af KDE.

; [[Getting Started/Build/Coexisting Versions|Sameksisterende versioner]]: Vejledning til at bygge flere KDE versioner på den samme maskine samtidigt.

; [[Getting Started/Build/FAQ|FAQ]]: Hjælp til fejl og andre spørgsmål du måtte have.

== Yderligere links ==
* Byg [http://solaris.kde.org/ KDE på Solaris]
* Byg [http://www.kdelibs.com/ KDE på Windows]
* Byg [[Getting Started/Build/KDE4/Mac_OS_X|KDE på Mac OS X]]
* Byg [[Getting Started/Build/KDE4/FreeBSD|KDE å FreeBSD]]
[[Category:Build KDE]]

Getting Started/Build/Historic

2007-09-09T18:56:20Z

Logixoul: rm stuff from the olden times

; [[../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]]

User:Dhaumann

2007-09-09T18:49:46Z

Logixoul: typo :)

todo: integrate (+ validate for kde4) those pages into sane locations ;)
* Common Programming Mistakes
: hey, the first one we have not ported yet. should be moved for kde4 into [[Development/Tutorials]] (TODO)
:: Thinking more about it, it could be an extension of [[Policies/Library_Code_Policy]], i.e. as subpage like [[Policies/Library_Code_Policy/Common Mistakes]] (although it's not only about libraries...)
* KDE Developer's Checklist
: looks very old. if migrated, please fix it for kde3 or even kde4 (TODO)
* What is Scripty?
: indeed a TODO :)

see: http://developer.kde.org/documentation/other/index.html

Getting Started/Build

2007-09-09T18:48:50Z

Logixoul: rm obsolete alpha instructions

Getting Started

2007-09-09T18:43:38Z

Logixoul: rm superfluous introduction that's also inaccurate

{{Template:I18n/Language Navigation Bar|Getting_Started}}
{{Box|Getting the Source|
[[Image:Action_down.svg|right|32px]]
* [[/Sources/Anonymous SVN|Anonymous SVN Quickstart Guide]]
* [[/Sources/Using Subversion with KDE|Using Subversion with KDE]] ''A more in depth look at accessing KDE source code with subversion, including the repository layout and working with revisions and patches.''
* [http://websvn.kde.org/ Browse Code Online]
* [[/Sources/Snapshots|Daily Snapshots]]
|100%}}

{{Box|Building KDE|
[[Image:Action_tool.svg|right|32px]]
There are different KDE branches. For production use, a stable version of KDE is recommended.
* [[/Build/KDE4|KDE 4 (Development version, trunk)]]
* [[/Build/Stable Version|KDE 3.5 (Stable version)]]
* [[/Build|Other versions and FAQ]] ''Including information for building on non-linux systems''
|100%}}

{{Box|Setting up the Environment|
[[Image:Action_pen.svg|right|32px]]
After KDE has been built, you'll want a good way to launch apps and perform your regular development tasks:
* [[/Increased Productivity in KDE4 with Scripts|Increased Productivity in KDE4 with Scripts]]
* [[/Set up KDE 4 for development|Set up KDE 4 for development]]
|100%}}
[[Category:Build KDE]]

Welcome to KDE TechBase

2007-09-09T18:41:50Z

Logixoul: "KDE and its applications" is a tautology - part of KDE's definition is its applications

{{Template:I18n/Language Navigation Bar|Welcome to KDE TechBase}}
{| style="margin: 1em 2.5% 0 2.5%; padding: 0 5px;" cellpadding="5"
|-
|colspan=2|[[Image:Discover.png|noframe]]
|-
| style="padding-left: 50px;" |[[Image:Action_launch.svg|noframe|left|40px]] ||
;[[Getting Started|Setting up a KDE development environment]]
:Learn how to get, build and run KDE.
|-
| style="padding-left: 50px;"|[[Image:Action_configure.svg|noframe|left|40px]] ||
;[[Development|Developing with KDE]]
:[[Development/Tutorials|Tutorials]] | [http://api.kde.org API Documentation] | [[Development/FAQs|FAQs]] and more.
:''Related'': [[Schedules|Release Schedules and Feature Plans]]
|-
| style="padding-left: 50px;"|[[Image:Devices_system.svg|noframe|left|40px]] ||
;[[KDE System Administration]]
:Information for system administrators managing KDE deployments.
|-
|colspan=2|[[Image:Interact.png|noframe]]
|-
| style="padding-left: 50px;"|[[Image:Action_favorites.svg|noframe|left|40px]] ||
;[[Contribute|Join the KDE Team and Contribute]]
:Contribute patches, keep in touch with and join our community.
:''Related:'' [[Policies|KDE Project Policies]] | [http://www.kde.org/support/support.php Donate Money]
|-
| style="padding-left: 50px;"|[[Image:Action_contents.svg|noframe|left|40px]] ||
;[[ISV|ISV Information]]
:Developer information for Independent Software Vendors.
|-
|colspan=2|[[Image:Develop.png|noframe]]
|-
| style="padding-left: 50px;" |[[Image:Action_wizard.svg|noframe|left|40px]] ||
;[[Projects|KDE projects]]
:Links to development wikis, task lists, etc. for various KDE Projects.

|}

User:Logixoul

2007-09-09T18:38:14Z

Logixoul: New page: If you disagree with my edits (I'm not too careful :p), try and hunt me down on IRC - I'm online most of the time.

If you disagree with my edits (I'm not too careful :p), try and hunt me down on IRC - I'm online most of the time.

Getting Started/Sources/Anonymous SVN

2007-09-09T18:36:48Z

Logixoul: trim

{{Template:I18n/Language Navigation Bar|Getting Started/Sources/Anonymous SVN}}
{{TutorialBrowser|

series=Getting Started|

name=Getting KDE Sources Using Anonymous Subversion (SVN)|

next=[[../../Build/KDE4|Building KDE4]]|

reading=[http://svnbook.red-bean.com/ Version Control with Subversion]|
}}

== Abstract ==

For those of us that like to stay on the "bleeding edge" there's an easy way to keep a local copy of the KDE sources up-to-date - anonymous SVN.

Please note that several Linux distributions now already provide KDE SVN packages, so '''building Qt and KDE from source may well not be necessary for you at all! '''See [[Getting_Started/Distribution_Packages]] for instructions and information.

== Anonymous SVN ==

=== Setup Subversion ===

First, install the subversion (svn) binary if it isn't already on your computer. Your operating system should have a package for it. Alternatively you can download and compile it yourself via the [http://subversion.tigris.org/project_packages.html svn project download page]. Please read the [[Getting_Started/Sources/Using_Subversion_with_KDE|KDE Subversion tutorial]] if you are interested in how to use Subversion.

=== Checkout KDE ===

'''/trunk/''' is where the Qt4-based KDE 4 is being developed. The following is the minimal set of modules you will need to check out to build KDE and KDE software:

svn co svn://anonsvn.kde.org/home/kde/trunk/KDE/kdelibs
svn co svn://anonsvn.kde.org/home/kde/trunk/KDE/kdebase

{{tip|Only use "'''svn co'''" for the initial checkout, you will update your local sources afterwards by using "'''svn up''' ''modulename''" or "'''svn update''' ''modulename''".}}

{{tip|If your firewall doesn't allow access to arbitrary ports, substitute '''svn://anonsvn.kde.org/''' with '''svn://websvn.kde.org:443/''' above.}}

'''qt-copy''' is a copy of the latest stable [http://www.trolltech.com Qt] release which works with KDE, put into SVN for convenience. It also contains patches by KDE developers that haven't found their way to Qt yet. They are recommended for those working with KDE from '''trunk'''. You can obtain '''qt-copy''' by doing:

svn co svn://anonsvn.kde.org/home/kde/trunk/qt-copy

If you wish to have a complete copy of the KDE distribution, you can simply check out the entire source tree with one command:

svn co svn://anonsvn.kde.org/home/kde/trunk/KDE

{{note|It is smarter to first use [http://websvn.kde.org/trunk/KDE The KDE Source Repository Web Viewer]. Use it to choose which modules to download. This way KDE will be quicker to install and try out.}}

If you want additional software packages you can check out the following modules within '''trunk/''' as well:

koffice
extragear
playground
kdereview

So, for example, if you want to check out koffice trunk, you can use

svn co svn://anonsvn.kde.org/home/kde/trunk/koffice

=== Checking out trunk using snapshots ===

If you are checking out modules from '''trunk/''' you may be able to save time by using snapshots. Using Subversion trunk snapshots is described at [[../Snapshots|the Subversion snapshots tutorial page]].

=== Checking out KDE 3 instead ===

If you want to track KDE 3 rather than the bleeding edge, you may retrieve the KDE 3.5 sources using:

svn co svn://anonsvn.kde.org/home/kde/branches/arts/1.5/arts
svn co svn://anonsvn.kde.org/home/kde/branches/KDE/3.5/

And if you want the matching qt-copy:
svn co svn://anonsvn.kde.org/home/kde/branches/qt/3.3/qt-copy

=== Checking out specific releases ===

KDE modules are also tagged at each release so that it is possible to get a specific release of KDE. Most KDE modules have a tag name in the format '''tags/KDE/X.Y.Z''' (where X, Y and Z represent the exact version). The arts module (only needed for KDE 2 and KDE 3) has a different format of tag name, '''tags/arts/X.Y.Z'''. For instance to get kdelibs as it was shipped in KDE 3.5.0, do:

svn co svn://anonsvn.kde.org/home/kde/tags/KDE/3.5.0/kdelibs/

If you then want to update this checkout to KDE 3.5.5, use this command:

svn switch svn://anonsvn.kde.org/home/kde/tags/KDE/3.5.5/kdelibs

{{tip|If you used a '''/branch/''' or '''/trunk/''' path, then there is no need to switch, just run '''svn update'''.}}

{{tip|[http://websvn.kde.org/tags/ WebSVN] is a convenient way to check for a tag name.}}

=== Checking out translations ===
If you are looking for translations and other localizations, check out the appropriate language from the [http://websvn.kde.org/trunk/l10n l10n] module.

{{Warning|The l10n module is ''extremely'' large. Be sure you have lots of time and disk space on hand before checking out the entire l10n module. Most people only check out specific language subdirectories rather than the entire l10n module.}}

You are now ready to start building KDE! Visit [[Getting_Started/Build/KDE4|this page]] for instructions on building trunk or [[Getting_Started/Build/Stable_Version|this page]] for instruction on compiling the last stable release.

== Also of interest ==
* anonsvn.kde.org is located in Tuebingen, Germany, maintained by [mailto:dirk@kde.org Dirk Mueller] However, a more local mirror could be faster for you than anonsvn.kde.org itself. Current mirrors are, sorted by performance:
** kde.mneisen.org is located near Nuernberg, Germany, maintained by [mailto:martin.eisenhardt@mneisen.org Martin Eisenhardt]
** www.englishbreakfastnetwork.org also hosts an anonymous SVN mirror, at the University of Nijmegen, Netherlands. Maintained by [mailto:groot@kde.org Adriaan de Groot]
** svn://azkaban.caltech.edu is located near Los Angeles, USA and is maintained by [mailto:eugen.plamadeala@gmail.com Eugeniu Plamadeala]. It has the same folder hierarchy as anonsvn.kde.org.
: Be careful when switching between mirrors. SVN remembers the server in the working copy, so to switch you have to run
svn switch --relocate svn://anonsvn.kde.org/ svn://kde.mneisen.org/
: in all your checkouts.
If you're interested in setting up a svn mirror, please contact [mailto:mueller@kde.org Dirk Mueller].

[[Category:Build KDE]]

Getting Started/Build/KDE4

2007-09-09T18:35:07Z

Logixoul: /* Required Software */ brevity

{{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=[http://kdesvn-build.kde.org/ kdesvn-build: The KDE From Subversion Build Tool] [[../../Increased_Productivity_in_KDE4_with_Scripts|Increased Productivity in KDE4 with Scripts]] [[Development/Tutorials/CMake |Introduction to CMake]] [[../KDE4/FreeBSD|FreeBSD notes]] [[../KDE4/Mac OS X|Instructions for Mac OS X]] [[../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 [[/FreeBSD|FreeBSD]], [http://www.kdelibs.com/ Windows], [[/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.
}}

== Required Software ==

The following must be installed first before you can successfully complete this tutorial:
* gcc and g++, preferably version 4.1 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 part of kdesdk. You can install it as part of kdesdk (kdesdk-scripts on Debian) or similar package, or just download it itself from [http://websvn.kde.org/*checkout*/trunk/KDE/kdesdk/scripts/makeobj WebSVN]
* the [http://freedesktop.org/wiki/Software/shared-mime-info shared-mime-info package], which is the freedesktop MIME standard KDE is using now
* [http://boost.org/ boost], needed by kdebase; after compiling and/or installing boost, in order to make cmake aware about its location (FindBoost), add boost directory (the one containing include subdirectory) to CMAKE_INCLUDE_PATH or set an environment variable called BOOST_ROOT pointing to 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-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.

=== Kubuntu and Debian ===

In Kubuntu 7.04 (Feisty) and Debian (Testing/Unstable) the build dependencies you need are installed with:
<code bash>
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 libpng-dev subversion libsm-dev libxinerama-dev \
libxrender-dev libfontconfig-dev libboost-dev libxcursor-dev doxygen \
libungif4-dev libdbus-1-dev libgpgme11-dev libssl-dev libgpgme11-dev \
libasound2-dev kdesdk-scripts libpth-dev libjasper-dev ssh
</code>

In Kubuntu 7.10 (Gutsy) you have to add:
<code bash>
sudo aptitude install dbus-x11
</code>

For a fully functional API documentation framework you also need:
<code bash>
sudo aptitude install graphviz
</code>

=== 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)
strigi-devel (needed to build kdelibs)
gpgme-devel (needed to build kdepimlibs)
</code>

'''Optional Packages'''

You can skip the manual installation of Qt 4.3, CMake 2.4.6 and DBus by installing the adding the openSUSE Build Service KDE4 Repository 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 (and their dependencies):
<code>
cmake
dbus-1-devel
libqt4-devel
libqca2-devel (needed for building kdesupport)
</code>

And for fully functional apidox framework you also need:
<code>
graphviz
</code>

CMake binary packages for openSUSE are available from [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>

Optional:

If you decide not to use the KDE qt-copy, you need to keyword unmask Qt.

<code bash>
echo 'x11-libs/qt' >> /etc/portage/package.keywords
</code>

And now need to mask any Clucene versions above 0.9.16a.

<code bash>
echo '>dev-cpp/clucene-0.9.16a' >> /etc/portage/package.mask
</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
</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'
</code>

You will also need to emerge either 'kde-base/kdesdk' or kde-base/kdesdk-scripts'.

Optional:

If you decided to use Gentoo's version of Qt4, you can emerge it using the following command.

<code bash>
emerge -avu 'x11-libs/qt'
</code>

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 thread [http://forums.gentoo.org/viewtopic-t-530111-postdays-0-postorder-asc-start-0.html KDE 4 monolithic ebuilds].

== 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>

=== 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>

== 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, you can skip this step - {{path|/bin/sh}} is {{path|bash}} on Ark Linux.

=== 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

=== 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.

== 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 the Qt4 that is in KDE's source repository. KDE is guaranteed to build against any Qt 4.3. Qt 4.2 and earlier are not supported and will not work. You should use the copy in the KDE Subversion servers. (note: some distros, like Debian, tend to supply Qt with patches from KDE svn applied, so you may want to cheat and use precompiled Qt from your distro)

=== The Recipe ===
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 -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.16; version 0.9.17 does '''not''' work), and either libxml2 or libexpat.

=== The Recipe ===

cs # [[Getting_Started/Increased_Productivity_in_KDE4_with_Scripts/.bashrc|cs is not a typo]]
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 manualy into the kdesupport directory in ~ and execute the command cmakekde. if this still doesnt 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? 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 you 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>").

== 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 not a typo]]
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#Required_Software|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 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)

== 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 not a typo]]
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.
* if you get the error "cannot find -lpth" from /usr/bin/ld, then make sure you have The GNU Portable Threads (libpth-dev for Debian).

== 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 not a typo]]
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.

== 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 not a typo]]
$KDE_SRC/KDE/kdelibs/doc/api/doxygen.sh \
--doxdatadir=$KDE_SRC/KDE/kdelibs/doc/common .

Repeat for other modules as desired. 
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>

== 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.

== 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]]

Development/Tutorials/CMake

2007-09-09T18:33:34Z

Logixoul: we don't want empty "please fill me" sections, do we

{{Template:I18n/Language Navigation Bar|Development/Tutorials/CMake}}

== Introduction ==
CMake reads script files and produces input files for the native buildsystem of the platform where it runs on. It can create GNU Makefiles, KDevelop project files, XCode project files, and Visual Studio project files.

CMake is free software and released under a BSD-style license. It is developed by [http://www.kitware.com Kitware Inc.]

Here are some good places to learn about CMake in general:
* [http://www.cmake.org/HTML/Documentation.html CMake Manual]
* [http://www.cmake.org/Wiki/CMake CMake Wiki]
* [http://www.cmake.org/Wiki/CMake_HowToDoPlatformChecks CMake System Checks ]
* [http://www.cmake.org/Wiki/CMake_HowToFindInstalledSoftware Finding Optional Packages ]
* [http://www.cmake.org/Wiki/HowToBuildKDE4Software KDE 4 Tutorial at the CMake Wiki ]
* [http://www.cmake.org/Wiki/CMake_FAQ CMake FAQ]
* [http://mail.kde.org/pipermail/kde-buildsystem/ The kde-buildsystem Mailing List Archive]

Also, consider joining the [http://www.cmake.org/mailman/listinfo/cmake CMake mailing list].

== Why use CMake ? ==
CMake is the official tool of KDE 4 release, decided in March 2006, primarily due to technical merits as compared to the older KDE tools automake and unsermake:
* CMake is developed independently of KDE, it can be used by other projects as well
* Compilation time is much faster, mainly due to not using libtool anymore
* The build files are easier to write

== How to compile KDE using CMake==

=== Get and install CMake ===
==== Linux, BSD, and other Unix Systems ====
Retrieve the latest stable version of CMake from [http://www.cmake.org/HTML/Download.html].

Once downloaded, unpack and compile it:
<code>
$ mkdir cmake-build
$ cd cmake-build
$ ../bootstrap
$ make
$ make install
</code>

By default, this will install CMake in /usr/local, so make sure to have /usr/local/bin in your execute path. To change the installation prefix (e.g. to /usr in debian), add the '--prefix=PATH' option to the bootstrap command.

Please follow the instructions located [http://cmake.org/HTML/Download.html#cvs here] if you would like to use the current development version.

==== Windows ====
Retrieve the latest stable version of CMake from [http://www.cmake.org/HTML/Download.html].

Once downloaded, run the cmake installer.

By default, this will install CMake in C:\Program Files\CMake 2.4, so make sure to have <installpath>\bin in your execute path.

Please follow the instructions at [http://cmake.org/HTML/Download.html#cvs here] if you would like to use the current development version.

=== Run CMake ===

==== Linux, BSD, and other Unix Systems ====
You have to run CMake so that it generates the build files for your system. Both in-source and out-of-source builds are supported by CMake, but currently in-source builds are prevented by the KDE implementation.

So, let's say you have kdelibs/ in ~/src/kdelibs/, then do the following:
<code>
$ ls
kdelibs/
$ mkdir kdelibs-build
$ cd kdelibs-build
$ cmake ../kdelibs
</code>
This will generate the Makefiles for building kdelibs/ in kdelibs-build/.

==== Windows ====
You have to run CMake so that it generates the build files for your system. Both in-source and out-of-source builds are supported by CMake, but currently in-source builds are prevented by the KDE implementation.

So, let's say you have kdelibs\ in c:\daten\kde4, then do the following:
<code>
c:\daten\kde4> cd kdelibs\win
c:\daten\kde4> cmake
c:\daten\kde4> make
c:\daten\kde4> make install
c:\daten\kde4> cd ..
c:\daten\kde4> mkdir kdelibs-build
c:\daten\kde4> cd kdelibs-build
c:\daten\kde4\kdelibs-build> cmake ..\kdelibs
</code>

This will generated the Makefiles for building kdelibs\ in kdelibs-build\. See [[KDE On Windows]] for more informations about compiling KDE on Windows.

==== KDevelop Project Files ====
If you prefer project files for KDevelop (which will basically be Makefiles accompanied by some extra files for KDevelop), run it like this:
<code>
$ cmake ../kdelibs -GKDevelop3
</code>
Use 'cmake -h' to find out which generators CMake supports and the other options.

==== CMake and Qt4 ====
To locate Qt 4, CMake searches for qmake in your execute path. CMake does ''not'' use the QTDIR environment variable. So make sure that the first qmake found in the execution path is the one you like to use.

==== More Details ====
When CMake has finished, it will have created a file called "CMakeCache.txt". This file contains all the settings CMake has detected on your system. If you want to run CMake with another generator or you want CMake to detect everything again, delete this file.

If CMake didn't find something, but you know it is somewere on your box, you can tell CMake manually where to find it. CMake uses variables to store this information. These variables are cached in the already mentioned file CMakeCache.txt. You have three options to adjust these variables manually:
* tell CMake the correct value via the command line: cmake ../kdelibs -DNAME_OF_THE_VARIABLE=value
* use ccmake, which provides a curses based GUI to adjust the CMake variables (run: ccmake ../kdelibs)
* edit the file CMakeCache.txt directly (not recommended)

You should run "ccmake ../kdelibs" at least once so that you get an impression which variables CMake uses. Press "T" to see also the "advanced" variables. So, if CMake didn't find something, start ccmake and adjust it manually.

Some variables you probably will want to set:
* '''CMAKE_INSTALL_PREFIX''': cmake ../kdelibs -DCMAKE_INSTALL_PREFIX=/opt/kde4 is the equivalent to ./configure --prefix=/opt/kde4
* '''CMAKE_BUILD_TYPE''': decide which type of build you want. You can chose between "debugfull", "debug", "profile", "relwithdebinfo" and "release". The default is "relwithdebinfo" (-O2 -g). See FindKDE4Internal.cmake for details.
* '''RPATH_STYLE''': This is not available anymore. By default everything will be built with RPATH set correctly. If you don't want RPATH at all, set CMAKE_SKIP_RPATH to TRUE.
* '''WITH_FOO''': there are several options, e.g. WITH_CUPS or WITH_Jasper. If you disable them, cmake will not even try to find this package. If it is enabled, cmake will try to find it. If it fails with this, you can still adjust it manually as described above.

=== Environment Variables ===
If you have headers and libraries installed in non-standard locations that cmake cannot find (e.g., fink on Mac OSX installs to /sw), then set the following as environment variables. Despite the similar naming convention, these will not work as arguments on the cmake command line:
* '''CMAKE_INCLUDE_PATH''', eg. export CMAKE_INCLUDE_PATH=/sw/include
* '''CMAKE_LIBRARY_PATH''', eg. export CMAKE_LIBRARY_PATH=/sw/lib

For more information on variables, see [http://www.cmake.org/Wiki/CMake_Useful_Variables this cmake.org wiki page]

=== Going Further ===
If cmake finishes with "Generating done" then there was no errors, but if it finishes with "Configuring done" then there was errors that you have to fix. Once cmake finishes successfully, run your buildtool (i.e. make, KDevelop, XCode or MSVC) and build and wait until it has finished. Then "make install".

If you got a failure that says something like
<code>
CMake Error: This project requires some variables to be set,
and cmake can not find them.
Please set the following variables:
X11_XTest_LIB (ADVANCED)
</code>
then you may have a missing library (or other dependency). To find
out which library, search in the cmake/modules directory for
the variable that cmake can't find. In the example above, it is
<code>
FIND_LIBRARY(X11_XTest_LIB Xtst ${X11_LIB_SEARCH_PATH})
</code>
So the missing library is Xtst. You then need to find it (perhaps installing a libXtst-devel library) and re-run cmake.

== Using CMake for a Simple Application ==

Here's the most simple CMakeLists.txt:
<code>
add_executable(hello main.cpp)
</code>
This will create an executable named "hello" (or "hello.exe" under Windows) from the source file main.cpp. You can mix C and C++ files as you want. You can have multiple executables and libraries in one CMakeLists.txt. The same source file can be used in multiple targets, it will be compiled for each target independently from the other targets. Probably the most important part of the cmake language are the variables:
<code>
SET( MY_SOURCES main.cpp widget.cpp)
MESSAGE(STATUS "my sources: ${MY_SOURCES}")
</code>
So, use the SET() command to set the value of a variable. If you list more than one string, the variable will be a list. A list is a list of strings separated by semicolons. If you set it to only one item, it will have just that value. To get the value of a variable, use ${VAR}.
You can iterate over a list using FOREACH():
<code>
FOREACH(next_ITEM ${MY_SOURCES})
MESSAGE(STATUS "next item: ${next_ITEM}")
ENDFOREACH(next_ITEM ${MY_SOURCES})
</code>
The commands in CMake are case-insensitive. Names of variables and names of parameter are case-sensitive.

You can also test for various things:
<code>
IF (UNIX)
MESSAGE(STATUS "This is UNIX (including OS X and CygWin)")
ENDIF (UNIX)

IF (MSVC)
SET(MY_SRCS ${MY_SRCS} winextra.cpp)
ENDIF (MSVC)
</code>
In this second example you can see also how to append items to a list.

In the cmake Wiki there is also a [http://www.cmake.org/Wiki/HowToBuildKDE4Software tutorial] on using cmake to build KDE 4 software. It is recommended reading.

== Using CMake for a KDE Project ==

Here's a basic CMakeList file that builds a small KDE 4 project:
<code>
PROJECT( kde4project)
FIND_PACKAGE(KDE4 REQUIRED)
INCLUDE_DIRECTORIES( ${KDE4_INCLUDES} )

SET(KDE4ProjectSources kde4mainapp.cpp someclass.cpp someotherclass.cpp)

KDE4_ADD_EXECUTABLE(kde4project ${KDE4ProjectSources} )

TARGET_LINK_LIBRARIES(kde4project ${KDE4_KDEUI_LIBS} ${KDE4_KPARTS_LIBS} )
</code>

== Extending CMake ==
CMake can be extended using cmake scripts. CMake comes with a number of scripts; under UNIX they are by default installed to /usr/local/share/CMake/Modules/. The KDE libraries install also a set of cmake modules into share/apps/cmake/modules/. The files located there will be preferred over the ones in the system global cmake module path.
For detecting software packages there are FindFOO.cmake files, see [http://www.cmake.org/Wiki/CMake_HowToFindInstalledSoftware here] for more information.
You can also write macros in CMake. They are powerful enough to do most things you will need to build software, but they are not intended to be used as a general purpose programming language.

== Converting autotools-based KDE software to CMake ==
In kdesdk/cmake/ you can find a script am2cmake . This is a ruby script, so you need to have ruby installed. Run am2cmake in the toplevel directory of your sources:
<code>
$ cd src/mykooltool/
$ am2cmake --kde4
</code>
Don't forget the switch "--kde4", otherwise it won't generate files suitable for KDE 4 software. The converted files 'may' work as they are, but complicated projects will require some additional editing.

You may have to:
* add more include direcories, using INCLUDE_DIRECTORIES()
* add more link libraries, using TARGET_LINK_LIBRARIES()
* add some compile switches, using ADD_DEFINITIONS()
* add some "configure" checks, see [http://www.cmake.org/Wiki/CMake_HowToDoPlatformChecks How To Do Platform Checks] and [http://www.cmake.org/Wiki/CMake_HowToFindInstalledSoftware How To Find Installed Software]
* take special care of former libtool convenience libraries. They are not supported by cmake, instead there will be a file ConvenienceLibs.cmake created. In this file you will find for every convenience lib a variable, which contains all source files of this convenience lib. For the targets which linked to this convenience lib, just add the variable to the sources.
* a file AdditionalInfo.txt will be created. There you will see all *.in and *.in.in files of your project. The stuff done in these files will have to be converted manually to cmake.

== Frequently Asked Questions ==

=== How can I teach my favorite editor about CMake syntax and indentation ? ===
Read the CMake Wiki section [http://www.cmake.org/Wiki/CMake_Editors_Support CMake Editors Support]. It describes how to setup Emacs (XEmacs works too), VIM, Kate, KWrite, and KDevelop.

=== I need to generate some files during the build. How do I do this ? ===
Use ADD_CUSTOM_COMMAND(). It's explained here in the CMake wiki: [http://www.cmake.org/Wiki/CMake_FAQ#How_can_I_generate_a_source_file_during_the_build.3F How can I generate a source file during the build]

=== I need to build an executable which is used later on during the build to generate files. How do I do this ? ===
Let's say the executable is called genembed. Then use KDE4_ADD_EXECUTABLE(foo RUN_UNINSTALLED ${fooSources})to create the executable. The RUN_UNINSTALLED option is important, because the executable has to run from the build dir and has to link to the libraries in the builddir. To achieve this, the executable is compiled with RPATH set accordingly and a wrapper shell script, named just like the executable but with the suffix ".sh" is created. This shell scripts sets up LD_LIBRARY_PATH and the calls the actual executable.
Use this wrapper shell script in the ADD_CUSTOM_COMMAND() as described above.
You can find out the name and exact location by querying the property WRAPPER_SCRIPT. Here's a full example taken from kdelibs/kstyles/keramik/ :
<code>
# build the executable
KDE4_ADD_EXECUTABLE(genembed RUN_UNINSTALLED ${genembed_SRCS})

# get the name of the generated wrapper script (which sets up LD_LIBRARY_PATH)
GET_TARGET_PROPERTY(GENEMBED_EXECUTABLE genembed WRAPPER_SCRIPT)

# and the custom command
ADD_CUSTOM_COMMAND(OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/keramikrc.h
COMMAND ${GENEMBED_EXECUTABLE} --file ${CMAKE_CURRENT_BINARY_DIR}/keramikPics.txt > \
${CMAKE_CURRENT_BINARY_DIR}/pixmaps.keramik
DEPENDS genembed ${keramikPics}
)
</code>

As you can see genembed is also listed as a dependency, this means cmake knows that it has to build the executable genembed before executing this rule.

=== I don't want to set the -DCMAKE_INSTALL_PREFIX command line option. Does cmake support the KDEDIR environment variable? ===
No. $KDEDIR is deprecated in KDE 4.

=== Why do i get compile errors like /usr/lib/qt4/include/QtCore/qstring.h:536: undefined reference to `QString::fromLatin1_helper(char const*, int)'? ===
A: If you have an old Qt4 version in your qt/lib directory you must delete the old (4.0.1) files.

=== How do I tell cmake to create noisy makefiles? I want to see the exact commands that are run during the make process. ===
Pass the VERBOSE variable to make, i.e.
<code>
% make VERBOSE=1
</code>
or
<code>
% VERBOSE=1 make
</code>

For more details see the CMake wiki: [http://www.cmake.org/Wiki/CMake_FAQ#Is_there_an_option_to_produce_more_.27verbose.27_compiling.3F Is there an option to produce more 'verbose' compiling?]

=== There is no 'make distclean' target in the generated Makefiles. How do I clean up everything, including the cache files? ===
Simply remove the build directory, or just the contents of the build directory.

[[Category:Programming]]
[[Category:Tutorial]]
[[Category:FAQs]]

Getting Started/Build/KDE4

2007-09-09T18:31:30Z

Logixoul: /* kdesupport */ cmon. don't insult the reader's intelligence.

{{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=[http://kdesvn-build.kde.org/ kdesvn-build: The KDE From Subversion Build Tool] [[../../Increased_Productivity_in_KDE4_with_Scripts|Increased Productivity in KDE4 with Scripts]] [[Development/Tutorials/CMake |Introduction to CMake]] [[../KDE4/FreeBSD|FreeBSD notes]] [[../KDE4/Mac OS X|Instructions for Mac OS X]] [[../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 [[/FreeBSD|FreeBSD]], [http://www.kdelibs.com/ Windows], [[/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.
}}

== 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, 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 part of kdesdk. You can install it as part of kdesdk (kdesdk-scripts on Debian) or similar package, or just download it itself from [http://websvn.kde.org/*checkout*/trunk/KDE/kdesdk/scripts/makeobj WebSVN]
* the [http://freedesktop.org/wiki/Software/shared-mime-info shared-mime-info package], which is the freedesktop MIME standard KDE is using now
* [http://boost.org/ boost], needed by kdebase; after compiling and/or installing boost, in order to make cmake aware about its location (FindBoost), add boost directory (the one containing include subdirectory) to CMAKE_INCLUDE_PATH or set an environment variable called BOOST_ROOT pointing to 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-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.

=== Kubuntu and Debian ===

In Kubuntu 7.04 (Feisty) and Debian (Testing/Unstable) the build dependencies you need are installed with:
<code bash>
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 libpng-dev subversion libsm-dev libxinerama-dev \
libxrender-dev libfontconfig-dev libboost-dev libxcursor-dev doxygen \
libungif4-dev libdbus-1-dev libgpgme11-dev libssl-dev libgpgme11-dev \
libasound2-dev kdesdk-scripts libpth-dev libjasper-dev ssh
</code>

In Kubuntu 7.10 (Gutsy) you have to add:
<code bash>
sudo aptitude install dbus-x11
</code>

For a fully functional API documentation framework you also need:
<code bash>
sudo aptitude install graphviz
</code>

=== 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)
strigi-devel (needed to build kdelibs)
gpgme-devel (needed to build kdepimlibs)
</code>

'''Optional Packages'''

You can skip the manual installation of Qt 4.3, CMake 2.4.6 and DBus by installing the adding the openSUSE Build Service KDE4 Repository 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 (and their dependencies):
<code>
cmake
dbus-1-devel
libqt4-devel
libqca2-devel (needed for building kdesupport)
</code>

And for fully functional apidox framework you also need:
<code>
graphviz
</code>

CMake binary packages for openSUSE are available from [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>

Optional:

If you decide not to use the KDE qt-copy, you need to keyword unmask Qt.

<code bash>
echo 'x11-libs/qt' >> /etc/portage/package.keywords
</code>

And now need to mask any Clucene versions above 0.9.16a.

<code bash>
echo '>dev-cpp/clucene-0.9.16a' >> /etc/portage/package.mask
</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
</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'
</code>

You will also need to emerge either 'kde-base/kdesdk' or kde-base/kdesdk-scripts'.

Optional:

If you decided to use Gentoo's version of Qt4, you can emerge it using the following command.

<code bash>
emerge -avu 'x11-libs/qt'
</code>

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 thread [http://forums.gentoo.org/viewtopic-t-530111-postdays-0-postorder-asc-start-0.html KDE 4 monolithic ebuilds].

== 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>

=== 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>

== 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, you can skip this step - {{path|/bin/sh}} is {{path|bash}} on Ark Linux.

=== 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

=== 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.

== 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 the Qt4 that is in KDE's source repository. KDE is guaranteed to build against any Qt 4.3. Qt 4.2 and earlier are not supported and will not work. You should use the copy in the KDE Subversion servers. (note: some distros, like Debian, tend to supply Qt with patches from KDE svn applied, so you may want to cheat and use precompiled Qt from your distro)

=== The Recipe ===
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 -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.16; version 0.9.17 does '''not''' work), and either libxml2 or libexpat.

=== The Recipe ===

cs # [[Getting_Started/Increased_Productivity_in_KDE4_with_Scripts/.bashrc|cs is not a typo]]
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 manualy into the kdesupport directory in ~ and execute the command cmakekde. if this still doesnt 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? 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 you 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>").

== 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 not a typo]]
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#Required_Software|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 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)

== 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 not a typo]]
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.
* if you get the error "cannot find -lpth" from /usr/bin/ld, then make sure you have The GNU Portable Threads (libpth-dev for Debian).

== 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 not a typo]]
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.

== 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 not a typo]]
$KDE_SRC/KDE/kdelibs/doc/api/doxygen.sh \
--doxdatadir=$KDE_SRC/KDE/kdelibs/doc/common .

Repeat for other modules as desired. 
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>

== 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.

== 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-09-09T18:29:47Z

Logixoul: /* TroubleShooting */

{{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=[http://kdesvn-build.kde.org/ kdesvn-build: The KDE From Subversion Build Tool] [[../../Increased_Productivity_in_KDE4_with_Scripts|Increased Productivity in KDE4 with Scripts]] [[Development/Tutorials/CMake |Introduction to CMake]] [[../KDE4/FreeBSD|FreeBSD notes]] [[../KDE4/Mac OS X|Instructions for Mac OS X]] [[../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 [[/FreeBSD|FreeBSD]], [http://www.kdelibs.com/ Windows], [[/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.
}}

== 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, 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 part of kdesdk. You can install it as part of kdesdk (kdesdk-scripts on Debian) or similar package, or just download it itself from [http://websvn.kde.org/*checkout*/trunk/KDE/kdesdk/scripts/makeobj WebSVN]
* the [http://freedesktop.org/wiki/Software/shared-mime-info shared-mime-info package], which is the freedesktop MIME standard KDE is using now
* [http://boost.org/ boost], needed by kdebase; after compiling and/or installing boost, in order to make cmake aware about its location (FindBoost), add boost directory (the one containing include subdirectory) to CMAKE_INCLUDE_PATH or set an environment variable called BOOST_ROOT pointing to 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-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.

=== Kubuntu and Debian ===

In Kubuntu 7.04 (Feisty) and Debian (Testing/Unstable) the build dependencies you need are installed with:
<code bash>
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 libpng-dev subversion libsm-dev libxinerama-dev \
libxrender-dev libfontconfig-dev libboost-dev libxcursor-dev doxygen \
libungif4-dev libdbus-1-dev libgpgme11-dev libssl-dev libgpgme11-dev \
libasound2-dev kdesdk-scripts libpth-dev libjasper-dev ssh
</code>

In Kubuntu 7.10 (Gutsy) you have to add:
<code bash>
sudo aptitude install dbus-x11
</code>

For a fully functional API documentation framework you also need:
<code bash>
sudo aptitude install graphviz
</code>

=== 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)
strigi-devel (needed to build kdelibs)
gpgme-devel (needed to build kdepimlibs)
</code>

'''Optional Packages'''

You can skip the manual installation of Qt 4.3, CMake 2.4.6 and DBus by installing the adding the openSUSE Build Service KDE4 Repository 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 (and their dependencies):
<code>
cmake
dbus-1-devel
libqt4-devel
libqca2-devel (needed for building kdesupport)
</code>

And for fully functional apidox framework you also need:
<code>
graphviz
</code>

CMake binary packages for openSUSE are available from [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>

Optional:

If you decide not to use the KDE qt-copy, you need to keyword unmask Qt.

<code bash>
echo 'x11-libs/qt' >> /etc/portage/package.keywords
</code>

And now need to mask any Clucene versions above 0.9.16a.

<code bash>
echo '>dev-cpp/clucene-0.9.16a' >> /etc/portage/package.mask
</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
</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'
</code>

You will also need to emerge either 'kde-base/kdesdk' or kde-base/kdesdk-scripts'.

Optional:

If you decided to use Gentoo's version of Qt4, you can emerge it using the following command.

<code bash>
emerge -avu 'x11-libs/qt'
</code>

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 thread [http://forums.gentoo.org/viewtopic-t-530111-postdays-0-postorder-asc-start-0.html KDE 4 monolithic ebuilds].

== 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>

=== 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>

== 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, you can skip this step - {{path|/bin/sh}} is {{path|bash}} on Ark Linux.

=== 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

=== 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.

== 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 the Qt4 that is in KDE's source repository. KDE is guaranteed to build against any Qt 4.3. Qt 4.2 and earlier are not supported and will not work. You should use the copy in the KDE Subversion servers. (note: some distros, like Debian, tend to supply Qt with patches from KDE svn applied, so you may want to cheat and use precompiled Qt from your distro)

=== The Recipe ===
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 -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|If you have jumped to this section without reading [[Getting_Started/Build/KDE4#Setting_up_the_environment|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. Your environment '''needs''' to be set up correctly for these instructions to work for you.}}

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.16; version 0.9.17 does '''not''' work), and either libxml2 or libexpat.

=== The Recipe ===

cs # [[Getting_Started/Increased_Productivity_in_KDE4_with_Scripts/.bashrc|cs is not a typo]]
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 manualy into the kdesupport directory in ~ and execute the command cmakekde. if this still doesnt 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? 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 you 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>").

== 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 not a typo]]
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#Required_Software|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 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)

== 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 not a typo]]
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.
* if you get the error "cannot find -lpth" from /usr/bin/ld, then make sure you have The GNU Portable Threads (libpth-dev for Debian).

== 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 not a typo]]
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.

== 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 not a typo]]
$KDE_SRC/KDE/kdelibs/doc/api/doxygen.sh \
--doxdatadir=$KDE_SRC/KDE/kdelibs/doc/common .

Repeat for other modules as desired. 
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>

== 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.

== 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]]

Development/Architecture (gl)

2007-09-09T18:28:19Z

Logixoul: fix double redirect

{{Template:I18n/Language Navigation Bar|Development/Architecture}}

As seguintes páxinas conteñen documentación sobre o deseño e os detalles da arquitectura de KDE en detalle. Isto non remplaza outra documentación como [http://api.kde.org a documentación do API], [[../Tutorials_(gl)|tutoriais/PUFs]] e [[../Guidelines_(gl)|standards]], mira o [[Development_(gl)|portal de desenvolvemento]] para máis información.

Para mellor comprensión, poderia axudar que lle botaras unha ollada, na web de Trolltech, á excelente documentación de [http://doc.trolltech.com/3.3/index.html Qt 3.3] ou [http://doc.trolltech.com/4.3/index.html Qt 4.3] (ambalas dúas en inglés) e ás súas [http://www.trolltech.com/developer/ páxinas para desenvolvedores].

Máis información sobre a instalación de KDE está disponíbel na sección dedicada a [[KDE System Administration|administradores de sistemas]].

== Documentos de deseño ==
; [[../Architecture/KDE4_(gl)|Descrición da arquitectura de KDE 4]]
: Unha descripción da arquitectura de KDE 4, incluíndo discusións sobre técnicas habituais, librerias de clases e problemas xerais do desenrrolo. Isto é para ''KDE 4.0''.

; [[../Architecture/KDE3|Descripción da arquitectura de KDE 3]] [http://developer.kde.org/documentation/library/kdeqt/kde3arch/ (Orixinal)]
: Unha descripción da arquitectura de KDE 3, incluíndo discusións sobre técnicas habituais, librerias de clases e problemas xerais do desenrrolo. Isto é para ''KDE 3.0''..

; [http://developer.kde.org/documentation/library/kdeqt/kde2arch/ Descripción da arquitectura de KDE 2]
: Unha descrición da arquitectura de KDE 2, similar ás de enriba. Isto é para ''KDE 2.2''

; [[../Architecture/DCOP|DCOP]]
: Documentos de deseño de 1999-2000.

[[Category:Architecture]]

Welcome to KDE TechBase (gl)

2007-09-09T18:28:07Z

Logixoul: fix double redirect

{{Template:I18n/Language Navigation Bar|Welcome to KDE TechBase}}
{| style="margin: 1em 2.5% 0 2.5%; padding: 0 5px;" cellpadding="5"
|-
|colspan=2|[[Image:Discover.png|noframe]]
|-
| style="padding-left: 50px;" |[[Image:Action_launch.svg|noframe|left|40px]] ||
;[[Getting Started_(gl)|Configurando un entorno de desenvolvimento KDE]]
:Aprende como obter, compilar e executar KDE e as súas aplicacións.
|-
| style="padding-left: 50px;"|[[Image:Action_configure.svg|noframe|left|40px]] ||
;[[Development_(gl)|Desenvolvimento con KDE]]
:[[Development/Tutorials|Tutoriais]] | [http://api.kde.org Documentación da API] | [[Development/FAQs|PUFs]] e máis.
:''Related'': [[Schedules|Calendario de lanzamentos e plans futuros]]
|-
| style="padding-left: 50px;"|[[Image:Devices_system.svg|noframe|left|40px]] ||
;[[KDE System Administration|Administración do sistema con KDE]]
:Información para administradores de sistemas sobre o manexo de KDE.
|-
|colspan=2|[[Image:Interact.png|noframe]]
|-
| style="padding-left: 50px;"|[[Image:Action_favorites.svg|noframe|left|40px]] ||
;[[Contribute|Súmate ao equipo de KDE e contribue.]]
:Axuda con parches, mantente en contato e participa cunha das mellores comunidades de software libre.
:''Related:'' [[Policies|Políticas do proxecto KDE]] | [http://www.kde.org/support/support.php Contribue financieiramente]
|-
| style="padding-left: 50px;"|[[Image:Action_contents.svg|noframe|left|40px]] ||
;[[ISV|Información para VIS]]
:Información para desenvolvidores de Vendedores Independentes de Software.
|-
|colspan=2|[[Image:Develop.png|noframe]]
|-
| style="padding-left: 50px;" |[[Image:Action_wizard.svg|noframe|left|40px]] ||
;[[Projects|Proxectos de KDE]]
:Ligazóns a wikis de desenvolvimento, listas de tarefas, etc... de varios proxectos de KDE.

|}

Welcome to KDE TechBase (sl)

2007-09-09T18:27:47Z

Logixoul: fix double redirect

{{DISPLAYTITLE:Dobrodošli na KDE TechBase}}

{{Template:I18n/Language Navigation Bar|Welcome to KDE TechBase}}

'''Pomnite:''' Prevajanje teh Wiki strani je še v teku. Nekatere strani so trenutno na voljo samo v angleščini. Potrudili se bomo, da jih čimprej in čimveč prevedemo v slovenščino. Že v naprej hvala za razumevanje. Vsaka pomoč je dobrodošla.

{| style="margin: 1em 2.5% 0 2.5%; padding: 0 5px;" cellpadding="5"
|-
|colspan=2|[[Image:Discover.png|noframe]]
|-
| style="padding-left: 50px;" |[[Image:Action_launch.svg|noframe|left|40px]] ||
;[[Getting Started (sl)|Postavitev okolja za razvoj KDE-ja]]
:Naučite se kako dobiti, zgraditi in poganjati KDE in programe zanj.
|-
| style="padding-left: 50px;"|[[Image:Action_configure.svg|noframe|left|40px]] ||
;[[Development|Razvoj s KDE]]
:[[Development/Tutorials|Vodiči]] | [http://api.kde.org Dokumentacija API-ja] | [[Development/FAQs|PZV]] in več.
:''Sorodno'': [[Schedules|Urniki izdaj in načrtovane značilnosti]]
|-
| style="padding-left: 50px;"|[[Image:Devices_system.svg|noframe|left|40px]] ||
;[[KDE System Administration|Sistemska administracija KDE-ja]]
:Informacije za sistemske administratorje, ki upravljajo z namestitvami KDE-ja.
|-
|colspan=2|[[Image:Interact.png|noframe]]
|-
| style="padding-left: 50px;"|[[Image:Action_favorites.svg|noframe|left|40px]] ||
;[[Contribute|Pridružite se ekipi KDE-ja in prispevajte]]
:Prispevajte popravke, ostanite v stiku in se pridružite eni izmed najboljših odprtokodnih skupnosti.
:''Sorodno:'' [[Policies|Pravila projekta KDE]] | [http://www.kde.org/support/support.php Kako prispevati finančno]
|-
| style="padding-left: 50px;"|[[Image:Action_contents.svg|noframe|left|40px]] ||
;[[ISV|Informacije za ISV-je]]
:Razvijalske informacije za neodvisne prodajalce programske opreme.
|-
|colspan=2|[[Image:Develop.png|noframe]]
|-
| style="padding-left: 50px;" |[[Image:Action_wizard.svg|noframe|left|40px]] ||
;[[Projects|Projekti znotraj KDE-ja]]
:Povezave do razvijalskih Wiki strani, seznamov opravil, itd. za razne projekte znotraj KDE-ja.
|}

KDE System Administration (de)

2007-09-09T18:26:16Z

Logixoul:

{{Template:I18n/Language Navigation Bar|KDE System Administration}}

Dieser Abschnitt bietet Systemadministratoren, welche KDE neu aufsetzen oder vorhandene Einsätze verwalten die Informationen, die sie benötigen um dies effektiv zu tun.

== Dateisystem ==
;[[SysAdmin/Configuration Files|Syntax der Konfigurations Dateien]]
:''KDEs Konfigurations Dateien sind textbasiert. Sie enthalten Gruppen aus Schlüssel-Wert Paaren. Dieser Abschnitt erläutert deren Syntax und behandelt folgende Bereiche:''
* Lokalisation,
* Shell Variablen,
* komplettes oder teilweises Sperren der Konfigurationsdateien
* Editier Hilfsprogramme
* andere fortgeschrittene Eigenschaften.

;[[SysAdmin/KDE Filesystem Hierarchy|KDE Hierarchie]]
:''Dieser Artikel beschreibt wie KDE das Dateisystem benutzt, wo nach Dateien gesucht wird und wo sie abgespeichert werden. Er erklärt wie man diese Orte wechselt. Er beinhaltet auch eine kurz gefasste Übersicht der von den größten OS Anbietern benutzten Standard-Einstellungen.''

;[[SysAdmin/XDG Filesystem Hierarchy|XDG Hierarchie]]
:''In Ergänzung zu [[SysAdmin/KDE Filesystem Hierarchy|KDEs Datei Hierarchie]], benutzt KDE auch verschiedene Verzeichnisse, die in der XDG Spezifikation auf [http://freedesktop.org freedesktop.org] definiert sind. Dieser Artikel dokumentiert die benutzten Pfade und deren Funktionen.''

== Desktop-Sitzungen ==

;[[SysAdmin/Environment Variables|Umgebungsvariablen]]
:''Eine Vielfalt an Umgebungs Variablen, die in diesem Artikel dokumentiert sind, ist vorhanden, um verschiedene Aspekte sowie das Laufzeitverhalten von KDE zu beeinflussen.''

;[[SysAdmin/Startup|Startvorgang]]
:''Während des Startvorganges werden die sichtbaren sowie die im hintergrund bleibenden Desktop-Komponenten gestartet. Dieser Artikel beschreibt die Startreihenfolge, liefert einen Überblick über einige der gestarteten Dienste und erklärt wie man Veränderungen macht.''

;[http://docs.kde.org/development/en/kdebase/kdm/ Anmeldungsmanager]
:''Der KDE Display Manager (KDM) bietet die Dienste, die üblicherweise mit einem Anmeldungsmanager assoziiert werden. Der erste Kontakt, den Ihre Benutzer mit einem KDE System haben, ist üblicherweise der KDM Bildschirm. Dieser Abschnitt behandelt die Grundlagen wie man einen KDM aufsetzt, sowie fortgeschrittene Themen wie Fernanmeldung, automatische Anmeldung, und mehr.''

== Benutzer- und Gruppenprofile ==

;[[SysAdmin/Kiosk/Introduction|Kiosk-Einführung]]
:''Das Kiosk Rahmenwerk bietet eine Menge an Optionen, welche es erlauben einfach und mächtig die Fähigkeiten einer KDE Umgebung, basierend auf Benutzer- und Gruppenlegitimationen, zu definieren und einzuschränken. Zusätzlich zu dem einführenden Überblick umfasst dieser Artikel das Sperren der Konfigurationsdateien, Einschränkungen der Handlungsfreiheiten und Ressourcen, die Zuweisung von Benutzer- und Gruppenprofilen, und mehr.''

;[[SysAdmin/Kiosk/Keys|Kiosk-Schlüssel]]
:''Dieses Dokument detailliert bekannte globale und anwendungsspezifische Schlüssel für Aktionen, Ressourcen und URL Beschränkungen und macht es zu einer handlichen Referenzanleitung um Kiosk-Profile zu erstellen''

;[[SysAdmin/Kiosk/Resources|Weitere Ressourcen]]
:''KDEs Benutzer- und Gruppenprofile betreffe Links zu Werkzeugen, Mailinglisten, und zusätzlicher Dokumentation.''

== Werkzeuge ==

;[http://extragear.kde.org/apps/kiosktool/ KioskTool]
:''Eine graphische Anwendung, die einem beim Verwalten von Benutzer- und Gruppenprofilen behilflich ist.''

;[http://docs.kde.org/development/en/kdenetwork/krfb/ Gemeinsame Nutzung des Desktops]
:''Die Fähigkeit zur gemeinsame Nutzung des Desktops macht auch eine Nutzung auf Distanz möglich. Neben zahlreichen anderen Verwendungsmöglichkeiten, ist diese Fähigkeit eine große Hilfe für das Betreuungspersonal, welches eine telefonische Unterstützung bietet.''

;[[Development/Tutorials/Shell_Scripting_with_KDE_Dialogs_(de)|Benutzung von KDE Dialogen in Shell-Scripten]]
:''Um verschiedene Dialoge anzuzeigen, können Sie KDialog Shell Scripte benutzen. Diese erlauben Ihnen eine nahtlose Eingliederung Ihrer eigenen GUI Erweiterungen.''

;[[SysAdmin/Controlling_Access_To_Get_New_Stuff|Kontrollierter Zugang zu Get New Stuff Inhalten]]
:''Dieser Abschnitt bietet Informationen, wie Sie die vom Internet durch die Get New Stuff Option herunterladbaren Inhalte kontrollieren können.''

KDE System Administration (zh CN)

2007-09-09T18:25:24Z

Logixoul: SysAdmin (zh CN) moved to KDE System Administration (zh CN)

{{Template:I18n/Language Navigation Bar|KDE System Administration}}

本节为正在启动一个新的KDE开发项目或正在组织管理一个已有项目的系统管理员提供他们需要的有效信息。

== 文件系统 ==
;[[SysAdmin/Configuration_Files_%28zh_CN%29|配置文件的语法]]
:''KDE的配置文件是基于文本的，其中包含了多组由关键字（即配置选项或称为键）与其值（即赋值给配置选项的参数值或称为键值）所组成的条目。这节解释了它们的语法，包括：''
* 本地化，
* 环境变量，
* 完整地或部分地提供配置文件，
* 编辑器工具，
* 其他高级特性。


;[[SysAdmin/KDE Filesystem Hierarchy|KDE的文件系统层次]]
:''这篇文章描述了KDE是如何使用用于查找和存储文件的文件系统的，解释了它是如何搜索、处理以及变更路径的。同时这篇文章也提供了一些主要操作系统供应商所使用的默认设置的概况。''

;[[SysAdmin/XDG Filesystem Hierarchy|XDG的文件系统层次]]
:''为了补充[[SysAdmin/KDE Filesystem Hierarchy|KDE所使用的文件系统层次]]，KDE同样也使用了一些由[http://freedesktop.org freedesktop.org]的XDG规范所定义的目录。这篇文章归档了这些被使用的路径以及它们的用途。''

== 桌面的会话 ==

;[[SysAdmin/Environment Variables|环境变量]]
:''许多归档于这篇文章的环境变量能够作用于KDE的很多方面，以及KDE应用程序运行时的行为。''

;[[SysAdmin/Startup|桌面启动序列]]
:''当启动KDE时，可视的桌面组件伴随这运行于后台的许多服务一起启动。这篇文章描述了启动的序列，为一些服务的启动以及如何改变启动序列提供了一个概览。''

;[http://docs.kde.org/development/en/kdebase/kdm/ 登录管理器]
:''KDE显示管理器（KDM）提供了登录管理器的一般功能。你的用户与KDE系统的第一次接触通常是KDE登录屏幕。本节涵盖了如何设置KDM的基本内容，以及其他高级内容例如远程登录、自动登录等。''

== 个人用户与组的配置文件 ==

;[[SysAdmin/Kiosk/Introduction|Kiosk的介绍]]
:''Kiosk框架提供了一组特性使得其能够很容易又很有效地定义和限制一个基于用户与组的凭证的KDE环境。除了介绍性的概览，这篇文章涵盖了配置实例、软件行为与可使用资源的约束，以及为用户与组指定配置文件。''

;[[SysAdmin/Kiosk/Keys|Kiosk的键值]]
:''这份文档详细罗列了那些用以对软件行为、可使用资源与URL进行约束的Kiosk键值。这些键值有影响整个KDE系统的，也有应用程序专用的。由于它们是如此详细，以致于当你建立一份Kiosk配置文件时，完全可以将此文档作为一份便利的参考指南。''

;[[SysAdmin/Kiosk/Resources|额外的资源]]
:''链接到有关用户与组的KDE配置文件的工具、邮件列表和附加文档。''

== 工具 ==

;[http://extragear.kde.org/apps/kiosktool/ KioskTool]
:''一个图形化的应用程序，用于帮助管理KDE Kiosk用户与组配置文件。''

;[http://docs.kde.org/development/en/kdenetwork/krfb/ Desktop Sharing]
:''KDE Desktop Sharing能够使你可以与其他人远程地共享你的桌面。除去对多用户地支持外，该特性在某用户呼叫其他用户以寻找帮助时更显强大。多个用户可以同时对呼叫者施以更直接的帮助。''

;[[Development/Tutorials/Shell_Scripting_with_KDE_Dialogs|在Shell脚本中使用KDE对话框]]
:''你可以使用KDialog shell脚本来呈现许多KDE对话框。这为你能够将脚本功能无缝地集成到你定制的GUI以增强其功能提供了可能。''

;[[SysAdmin/Controlling_Access_To_Get_New_Stuff|使用新要素来控制接入的内容]]
:''提供了关于如何通过KDE的新特性来控制从Internet上下载的内容的相关信息。''

SysAdmin (zh CN)

2007-09-09T18:25:24Z

Logixoul: SysAdmin (zh CN) moved to KDE System Administration (zh CN)

#REDIRECT [[KDE System Administration (zh CN)]]

KDE System Administration (zh CN)

2007-09-09T18:25:16Z

Logixoul:

KDE System Administration (de)

2007-09-09T18:23:39Z

Logixoul: SysAdmin (de) moved to KDE System Administration (de)

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

Dieser Abschnitt bietet Systemadministratoren, welche KDE neu aufsetzen oder vorhandene Einsätze verwalten die Informationen, die sie benötigen um dies effektiv zu tun.

== Dateisystem ==
;[[SysAdmin/Configuration Files|Syntax der Konfigurations Dateien]]
:''KDEs Konfigurations Dateien sind textbasiert. Sie enthalten Gruppen aus Schlüssel-Wert Paaren. Dieser Abschnitt erläutert deren Syntax und behandelt folgende Bereiche:''
* Lokalisation,
* Shell Variablen,
* komplettes oder teilweises Sperren der Konfigurationsdateien
* Editier Hilfsprogramme
* andere fortgeschrittene Eigenschaften.

;[[SysAdmin/KDE Filesystem Hierarchy|KDE Hierarchie]]
:''Dieser Artikel beschreibt wie KDE das Dateisystem benutzt, wo nach Dateien gesucht wird und wo sie abgespeichert werden. Er erklärt wie man diese Orte wechselt. Er beinhaltet auch eine kurz gefasste Übersicht der von den größten OS Anbietern benutzten Standard-Einstellungen.''

;[[SysAdmin/XDG Filesystem Hierarchy|XDG Hierarchie]]
:''In Ergänzung zu [[SysAdmin/KDE Filesystem Hierarchy|KDEs Datei Hierarchie]], benutzt KDE auch verschiedene Verzeichnisse, die in der XDG Spezifikation auf [http://freedesktop.org freedesktop.org] definiert sind. Dieser Artikel dokumentiert die benutzten Pfade und deren Funktionen.''

== Desktop-Sitzungen ==

;[[SysAdmin/Environment Variables|Umgebungsvariablen]]
:''Eine Vielfalt an Umgebungs Variablen, die in diesem Artikel dokumentiert sind, ist vorhanden, um verschiedene Aspekte sowie das Laufzeitverhalten von KDE zu beeinflussen.''

;[[SysAdmin/Startup|Startvorgang]]
:''Während des Startvorganges werden die sichtbaren sowie die im hintergrund bleibenden Desktop-Komponenten gestartet. Dieser Artikel beschreibt die Startreihenfolge, liefert einen Überblick über einige der gestarteten Dienste und erklärt wie man Veränderungen macht.''

;[http://docs.kde.org/development/en/kdebase/kdm/ Anmeldungsmanager]
:''Der KDE Display Manager (KDM) bietet die Dienste, die üblicherweise mit einem Anmeldungsmanager assoziiert werden. Der erste Kontakt, den Ihre Benutzer mit einem KDE System haben, ist üblicherweise der KDM Bildschirm. Dieser Abschnitt behandelt die Grundlagen wie man einen KDM aufsetzt, sowie fortgeschrittene Themen wie Fernanmeldung, automatische Anmeldung, und mehr.''

== Benutzer- und Gruppenprofile ==

;[[SysAdmin/Kiosk/Introduction|Kiosk-Einführung]]
:''Das Kiosk Rahmenwerk bietet eine Menge an Optionen, welche es erlauben einfach und mächtig die Fähigkeiten einer KDE Umgebung, basierend auf Benutzer- und Gruppenlegitimationen, zu definieren und einzuschränken. Zusätzlich zu dem einführenden Überblick umfasst dieser Artikel das Sperren der Konfigurationsdateien, Einschränkungen der Handlungsfreiheiten und Ressourcen, die Zuweisung von Benutzer- und Gruppenprofilen, und mehr.''

;[[SysAdmin/Kiosk/Keys|Kiosk-Schlüssel]]
:''Dieses Dokument detailliert bekannte globale und anwendungsspezifische Schlüssel für Aktionen, Ressourcen und URL Beschränkungen und macht es zu einer handlichen Referenzanleitung um Kiosk-Profile zu erstellen''

;[[SysAdmin/Kiosk/Resources|Weitere Ressourcen]]
:''KDEs Benutzer- und Gruppenprofile betreffe Links zu Werkzeugen, Mailinglisten, und zusätzlicher Dokumentation.''

== Werkzeuge ==

;[http://extragear.kde.org/apps/kiosktool/ KioskTool]
:''Eine graphische Anwendung, die einem beim Verwalten von Benutzer- und Gruppenprofilen behilflich ist.''

;[http://docs.kde.org/development/en/kdenetwork/krfb/ Gemeinsame Nutzung des Desktops]
:''Die Fähigkeit zur gemeinsame Nutzung des Desktops macht auch eine Nutzung auf Distanz möglich. Neben zahlreichen anderen Verwendungsmöglichkeiten, ist diese Fähigkeit eine große Hilfe für das Betreuungspersonal, welches eine telefonische Unterstützung bietet.''

;[[Development/Tutorials/Shell_Scripting_with_KDE_Dialogs_(de)|Benutzung von KDE Dialogen in Shell-Scripten]]
:''Um verschiedene Dialoge anzuzeigen, können Sie KDialog Shell Scripte benutzen. Diese erlauben Ihnen eine nahtlose Eingliederung Ihrer eigenen GUI Erweiterungen.''

;[[SysAdmin/Controlling_Access_To_Get_New_Stuff|Kontrollierter Zugang zu Get New Stuff Inhalten]]
:''Dieser Abschnitt bietet Informationen, wie Sie die vom Internet durch die Get New Stuff Option herunterladbaren Inhalte kontrollieren können.''

SysAdmin (de)

2007-09-09T18:23:39Z

Logixoul: SysAdmin (de) moved to KDE System Administration (de)

#REDIRECT [[KDE System Administration (de)]]

KDE System Administration

2007-09-09T18:21:17Z

Logixoul:

{{Template:I18n/Language Navigation Bar|KDE System Administration}}

This section provides system administrators who are rolling out new or managing existing KDE deployments in their organization with the information they need to do so effectively.

== File System ==
;[[/Configuration Files|Configuration File Syntax]]
:''KDE configuration files are text-based. They contain groups of key-value pairs. This section explains their syntax. It covers:''
* localisation,
* shell-variables,
* complete or partial lock-down of configuration files,
* editor utilities,
* other advanced features.


;[[/KDE Filesystem Hierarchy|KDE Hierarchy]]
:''This article describes how KDE uses the filesystem, where it looks for files and where it stores them. It explains how to change these locations. There is also a brief overview of the default settings used by major OS vendors.''

;[[/XDG Filesystem Hierarchy|XDG Hierarchy]]
:''Supplementing the [[/KDE Filesystem Hierarchy|KDE filesystem hierarchy]], KDE also uses various directories, as defined by XDG specifications on [http://freedesktop.org freedesktop.org]. This article documents the paths used and their purposes.''

== Desktop Sessions ==

;[[/Environment Variables|Environment Variables]]
:''A variety of environment variables documented in this article are available to influence aspects of KDE and the runtime behavior of KDE applications.''

;[[/Startup|Desktop Startup Sequence]]
:''During startup KDE starts the visible desktop components as well as several services that run in the background. This article describes the startup sequence, gives an overview of some of the services started and explains how to make changes.''

;[http://docs.kde.org/development/en/kdebase/kdm/ Login Manager]
:''The KDE Display Manager (KDM) provides the services commonly associated with a login manager. The first contact your users have with a KDE system is usually the KDM login screen. This section covers the basics of how setting up KDM, plus advanced topics such as remote login, automatic login, and more.''

== User & Group Profiles ==

;[[/Kiosk/Introduction|Introduction to Kiosk]]
:''The Kiosk framework provides a set of features that makes it possible to easily and powerfully define and restrict the capabilities of a KDE environment based on user and group credentials. In addition to an introductory overview, this article covers configuration setting lock down, action and resource restrictions, assigning profiles to users and groups and more.''

;[[/Kiosk/Keys|Kiosk Keys]]
:''This document details known global and application specific kiosk keys for action, resource and url restrictions making it a handy reference guide when setting up a Kiosk profile.''

;[[/Kiosk/Resources|Additional Resources]]
:''Links to tools, mailing lists and additional documentation relevant to user and group profiles in KDE.''

== Tools ==

;[http://extragear.kde.org/apps/kiosktool/ KioskTool]
:''A graphical application that helps manage KDE Kiosk user and group profiles.''

;[http://docs.kde.org/development/en/kdenetwork/krfb/ Desktop Sharing]
:''The KDE Desktop Sharing capabilities make it possible to share your desktop remotely with others. Alongside numerous other uses, this feature is a great enabler for support staff who give direct assistance to users calling them.''

;[[Development/Tutorials/Shell_Scripting_with_KDE_Dialogs|Using KDE Dialogs in Shell Scripts]]
:''You can use KDialog shell scripts to show various KDE dialogs. This gives you seamless integration of your own custom GUI enhancements.''

;[[SysAdmin/Controlling_Access_To_Get_New_Stuff|Controlling Access to Content Provided By Get New Stuff]]
:''Give information on how to control content downloaded from the Internet by the Get New Stuff feature of KDE.''

Help:Contribute

2007-09-09T18:19:23Z

Logixoul: fix double redirect

You are welcome to contribute to the KDE TechBase wiki. In order to keep a high quality of the articles there are some guidelines you should follow. This is a brief overview of the editing and contributing process.

== What Content belongs into KDE TechBase ==

The KDE TechBase wiki is meant to contain technical information all around KDE, for instance
* Developer Information (e.g. [[Development/Tutorials|tutorials]])
* [[KDE System Administration]]
* policies and schedules
* etc.

More details can be found in the article [[Help:Wiki Structure]]. [http://docs.kde.org End-user documentation] or [http://api.kde.org API documentation] should ''not'' be added here. For non-technical use cases use the [http://wiki.kde.org KDE wiki].

=== Where to put new Articles ===

The KDE TechBase wiki uses subpages. Take a quick look at the article about the [[Help:Wiki Structure]]. In short: Do not randomly add toplevel pages.

It is possible to translate KDE TechBase articles into other languages. Read the article about [[Help:Wiki Translation]] for further details.

=== The Procedure ===

You want to add new content. To keep high quality, please create the article in your userpage first (e.g. User:foo/My Acticle). Once it is ready, discuss the article with other developers and proof-read it. Finally, if a location is found, move the page.

After moving the page please '''add yourself to the watch list''' by clicking the ''Watch'' register. You will get a notice by mail whenever the page changes.

== Editing Basics ==

In the KDE TechBase wiki all readers are allowed to edit content and structure.

=== Review Policy and Conventions ===

Make sure that you submit information which is relevant to the specific purpose of the wiki, or your content might be deleted. You can always use the [[Help:Talk page|''Discussion'' or ''talk'' pages]] to ask questions or check to see if your idea will be accepted. Please make sure your contributions are not violating licenses.

=== Start Editing ===

To start editing a [[Main Page|KDE TechBase]] page, click the '''Edit''' link at the tab on the top. This brings you to the edit page: a page with a text box containing the ''wikitext'' - the editable code from which the server produces the finished page. ''If you just want to experiment, please do so in the [[Sandbox|sandbox]], not here''.

=== Type your Changes ===

You can just type your text. However, also using basic wiki markup to make links and do simple formatting adds to the value of your contribution. Please follow the style used in other wiki articles. If you follow this, your contributions will be more valuable as they won't need to be cleaned up later.

=== Summarize your Changes ===

Write a short edit summary in the small field below the edit-box.

Example: "Fixed a typo"

=== Preview before Saving ===

When you have finished, click '''Show preview''' to see how your changes will look '''before''' you make them permanent. Repeat the edit/preview process until you are satisfied, then click '''Save page''' and your changes will be immediately applied to the article.

== Wiki Markup Reference ==

The wikipedia provides a quick introduction about the most important mediawiki syntax. Please read the [http://en.wikipedia.org/wiki/Wikipedia:How_to_edit_a_page Page editing help].

KDE System Administration (fr)

2007-09-09T18:17:03Z

Logixoul: SysAdmin (fr) moved to KDE System Administration (fr)

{{Template:I18n/Language Navigation Bar|KDE System Administration}}
Cette section fournit aux administrateurs système l'information nécessaire au bon déroulement du déploiement de KDE au sein de leur organisation.

== Système de Fichier ==
;[[KDE System Administration/Configuration Files|Syntaxe des fichier de configuration]]
:''Les fichiers de configuration de KDE sont au format texte brut. Ils contiennent des groupes de paires clé-valeur. Cette section explique leur syntaxe. Cela couvre :''
* la gestion des langues
* les variables shell
* le vérouillage complet ou partiel des fichiers de configuration
* les utilitaires d'édition
* d'autres fonctionalités avancées

;[[KDE System Administration/KDE Filesystem Hierarchy|Arborescence de KDE]]
:''Cet article décrit la façon dont KDE utilise le système de fichier, où il recherche les fichiers et où il les stocke. L'article explique comment changer ces endroits. On trouvera aussi une brève vue d'ensemble des réglages par défaut utilisé par les grands distributeurs de systèmes d'exploitation.''

== Lancement du Bureau ==

;[[KDE System Administration/Environment Variables|Environment Variables]]
:''Un ensemble de variables d'environnement décrites dans cet article sont disponibles pour régler certains aspects de KDE et le comportement pendant leur lancement des applications KDE.''

;[[KDE System Administration/Startup|Séquence de démarrage du bureau KDE]]
:''Pendant son démarrage KDE lance les composants visibles du bureau ainsi que différents services tournant en tache de fond. Cet article décrit la séquence de démarrage, donne une vue générale des services démarrés et explique comment modifier ceci.''

;[http://docs.kde.org/development/en/kdebase/kdm/ Gestionnaire de Connexion]
:''Le Gestionnaire Graphique de KDE (KDE Display Manager - KDM) fournit les services classiquement associés à un gestionnaire de connexion. Le premier contact que les utilisateurs auront avec KDE est typiquement l'écran de login de KDE. Cette section couvre les bases pour mettre en place KDM, plus certains sujets avancés comme la connexion à distance, la connexion automatique entre autres choses.''

== Profils de groupes et d'utilisateurs ==

;[[KDE System Administration/Kiosk/Introduction|Introduction à Kiosk]]
:''L'infrastructure Kiosk fournit un ensemble de fonctionnalités pour définir et restreindre facilement les caractéristiques d'un environnement KDE basé sur les droits d'accès de groupes et d'utilisateurs. En plus d'une introduction générale, cet article couvre l'ensemble des paramètres de configuration vérouillables, les restrictions d'action et de ressource, l'association de profils utilisateurs et de groupes, parmi d'autres choses.''

;[[KDE System Administration/Kiosk/Keys|Liste des clés applicables pour l'utilisation de Kiosk]]
:''Ce document détaille l'ensemble clés globales et spécifiques prédéfinies applicables à certaines applications pour les restrictions d'actions, de ressources et de liens internet faisant de ce guide une référence pour paramètrer des profils Kiosk.''

;[[KDE System Administration/Kiosk/Resources|Ressources supplémentaires]]
:''Liens vers des outils, listes de diffusion et documentation supplémentaire à propos les profils d'utilisateurs et de groupes dans KDE.''

== Outils ==

;[http://extragear.kde.org/apps/kiosktool/ KioskTool]
:''Une application graphique pour gérer les profils d'utilisateurs et de groupes de KDE Kiosk.''

;[http://docs.kde.org/development/en/kdenetwork/krfb/ Le bureau partagé]

:''La fonctionnalité de bureau partagé permet de partager votre hureau à distance avec d'autres utilisateurs. Parmi de nombreuses autres applications, cette fonctionnalité est une grande avancée pour les équipes de support qui donnent une assistance téléphonique aux utilisateurs.''

;[[Development/Tutorials/Shell_Scripting_with_KDE_Dialogs|Utiliser les boites de dialogue KDE dans des scripts shell]]
:''Il est possible d'utiliser des scripts shell utilisant KDialog pour afficher diverses boites de dialogue KDE. Cela offre une intégration sans précédent de vos propres améliorations de l'interface graphique.''

SysAdmin (fr)

2007-09-09T18:17:03Z

Logixoul: SysAdmin (fr) moved to KDE System Administration (fr)

#REDIRECT [[KDE System Administration (fr)]]

KDE System Administration (fr)

2007-09-09T18:16:52Z

Logixoul:

KDE System Administration/Kiosk/Resources

2007-09-09T18:11:15Z

Logixoul: SysAdmin/Kiosk/Resources moved to KDE System Administration/Kiosk/Resources

== Articles ==
* [http://enterprise.kde.org/articles/kiosk-lp.php http://enterprise.kde.org/articles/kiosk-lp.php]
* [http://developer.kde.org/documentation/tutorials/kiosk/index.html KDE Kiosk Mode]
* [http://www.linux-mag.com/id/1205 KDE: The Korporate Desktop Environment]

== Files ==
* [http://websvn.kde.org/trunk/KDE/kdelibs/kdecore/README.kiosk?view=markup README.kiosk] found in the KDE source under {{path|/kdelibs/kdecore}}

== IRC Channels ==
* Advice and answers to questions can be found on #kde and #kde-devel on irc.freenode.net

== Mailing Lists ==
* [https://mail.kde.org/mailman/listinfo/kde-kiosk Kiosk mailing list and archives]

== Web Sites ==
* [http://extragear.kde.org/apps/kiosktool/ The Kiosk homepage]
* [http://www.kde-forum.org/board.php?boardid=31 KDE Administration Board]

SysAdmin/Kiosk/Resources

2007-09-09T18:11:15Z

Logixoul: SysAdmin/Kiosk/Resources moved to KDE System Administration/Kiosk/Resources

#REDIRECT [[KDE System Administration/Kiosk/Resources]]

KDE System Administration/Kiosk/Keys

2007-09-09T18:11:03Z

Logixoul: SysAdmin/Kiosk/Keys moved to KDE System Administration/Kiosk/Keys

This article contains a listing of known keys that can be used with Kiosk and what they do. How to actually use these keys and other capabilities of Kiosk such as URL restrictions, creating assigning profiles, etc. is covered in the [[../Introduction|Introduction to Kiosk]] article.

Which configuration file to put these entries in depends on whether you wish to make them global to all applications or specific to one application. To make the restrictions valid for all applications, put them in {{path|kdeglobals}}. To enable a restriction for a specific applications place them in the application-specific configuration, e.g. {{path|konqererorrc}} for Konqueror.

== Application Action Restrictions ==

These keys disable actions that are commonly found in KDE applications. To use these actions, create a section in {{path|kdeglobals}} that looks like this:

<code ini>
[KDE Action Restrictions][$i]
action/<key>=false
</code>

{|
|-
! Key !! Menu !! Action
|-
|action/file_new || File || New
|-
|action/file_open || File || Open
|-
|action/file_open_recent || File || Open Recent File
|-
|action/file_save || File || Save
|-
|action/file_save_as || File || Save As
|-
|action/file_revert || File || Revert
|-
|action/file_close || File || Close
|-
|action/file_print || File || Print
|-
|action/file_print_preview || File || Print Preview
|-
|action/file_mail || File || Email File
|-
|action/file_quit || File || Quit
|-
|action/edit_undo || Edit || Undo
|-
|action/edit_redo || Edit || Redo
|-
|action/edit_cut || Edit || Cut
|-
|action/edit_copy || Edit || Copy
|-
|action/edit_paste || Edit || Paste
|-
|action/edit_select_all || Edit || Select All
|-
|action/edit_deselect || Edit || Deselect
|-
|action/edit_find || Edit || Find
|-
|action/edit_find_next || Edit || Find Next
|-
|action/edit_find_last || Edit || Find last
|-
|action/edit_replace || Edit || Replace
|-
|action/view_actual_size || View || 100% Zoom
|-
|action/view_fit_to_page || View || Fit To Page (zooming)
|-
|action/view_fit_to_width || View || Fit To Width (zooming)
|-
|action/view_fit_to_height || View || Fit To Height (zooming)
|-
|action/view_zoom_in || View || Zoom In
|-
|action/view_zoom_out || View || Zoom Out
|-
|action/view_zoom || View || Zoom
|-
|action/view_redisplay || View || Refresh
|-
|action/go_up || Go || Up
|-
|action/go_back || Go || Back
|-
|action/go_forward || Go || Forward
|-
|action/go_home || Go || Home
|-
|action/go_previous || Go || Previous
|-
|action/go_next || Go || Next
|-
|action/go_goto || Go || Go To...
|-
|action/go_goto_page || Go || Go To Page...
|-
|action/go_goto_line || Go || Go To Line...
|-
|action/go_first || Go || Go To Start
|-
|action/go_last || Go || Go To End
|-
|action/bookmarks || Bookmarks || Also disables action/bookmark_add and action/bookmark_edit
|-
|action/bookmark_add || Bookmarks || Add Bookmark
|-
|action/bookmark_edit || Bookmarks || Edit Bookmarks
|-
|action/tools_spelling || Tools || Check Spelling
|-
|action/options_show_menubar || Settings || Show/hide Menubar
|-
|action/options_show_toolbar || Settings || Show/hide Toolbar, will also disable the "Toolbars" submenu if present
|-
|action/options_show_statusbar || Settings || Show/hide statusbar
|-
|action/options_save_Settings || Settings || Save Settings
|-
|action/options_configure || Settings || Configure application
|-
|action/options_configure_keybinding || Settings || Configure Shortcuts
|-
|action/options_configure_toolbars || Settings || Configure Toolbars
|-
|action/options_configure_notifications || Settings || Configure Notifications
|-
|action/fullscreen || Settings || Enter full screen mode
|-
|action/help || Help || Not yet fully implemented
|-
|action/help_contents || Help || Application handbook
|-
|action/help_whats_this || Help || Go into "what's this" mode
|-
|action/help_report_bug || Help || Report a bug
|-
|action/help_about_app || Help || Show about application dialog
|-
|action/help_about_kde || Help || Show about KDE dialog
|}

=== KCalc ===

By marking the kcalcrc config file as immutable, the "Configure" button
will not be shown.

=== File Manager ===

{|
|-
! Key !! Action
|-
|action/editfiletype || Edit associated applications
|-
|action/properties || File properties
|-
|action/openwith || Open file with action
|-
|action/openintab || Open link in a new tab
|-
|action/kdesktop_rmb || RMB menu, see note below
|-
|action/iconview_preview || Show preview thumbnails in icons, though it leaves the actual setting untouched. To disable previews (as opposed to simply disabling the user to change the setting) you also need to add the following lines to konqiconviewrc:
<code ini>
[Settings]
PreviewsEnabled[$i]=false
</code>
|-
|action/sharefile || Disables file sharing from the UI, but you may also want to disable filesharing altogether.
|-
|action/sendURL || Send Link Address
|-
|action/sendPage || Send File
|-
|action/devnew || Create New -> Device
|-
|action/incIconSize || Increase icon size
|-
|action/decIconSize || Decrease icon size
|-
|action/go || Entire go menu
|-
|action/configdesktop || Configure desktop in RMB menu, see also Control Module Restrictions
|-
|action/executeshellcommand || In Konqueror Tools menu, see also <tt>shell_access</tt>
|-
|action/show_dot || Disables the option to toggle showing hidden files, the actual setting remains unaffected. To disable showing hidden files, add the following lines to konqiconviewrc:
<code ini>
[Settings]
ShowDotFiles[$i]=false
</code>
|}

=== Konsole ===

These keys can appear in {{path|kdeglobals}}, {{path|konsolepartrc}} or {{path|konsolerc}}.

{|
|-
! Key !! Action
|-
|action/konsole_rmb || Context menus
|-
|action/settings || Disable the entire settings menu
|-
|action/show_menubar || Show/hide the menubar
|-
|action/show_toolbar || Show/hide the toolbar
|-
|action/scrollbar || Show/hide the scrollbar
|-
|action/bell || Configure bell actions
|-
|action/font || Configure font
|-
|action/keyboard || Set keyboard type
|-
|action/schema || Select the schema to use
|-
|action/size || Set the terminal size
|-
|action/history || Configure history
|-
|action/save_default || Save settings as defaults
|-
|action/save_sessions_profile || Save sessions profile
|-
|action/send_signal || Send a signal to the current terminal
|-
|action/bookmarks || Bookmarks menu
|-
|action/add_bookmark || Add a bookmark
|-
|action/edit_bookmarks || Edit bookmarks
|-
|action/clear_terminal || Clear the current terminal
|-
|action/reset_clear_terminal || Clear and reset the current terminal
|-
|action/find_history || Find in history
|-
|action/find_next || Find next item in history
|-
|action/find_previous || Find previous item in history
|-
|action/save_history || Save history to disk
|-
|action/clear_history || Clear history of current terminal
|-
|action/clear_all_histories || Clear histories of all terminals
|-
|action/detach_session || Detach current tab
|-
|action/rename_session || Rename current session
|-
|action/zmodem_upload || ZModem uploading
|-
|action/monitor_activity || Monitor current terminal for activity
|-
|action/monitor_silence || Monitor current terminal for silence
|-
|action/send_input_to_all_sessions || Replicate input to all sessions
|-
|action/close_session || Close current terminal session
|-
|action/new_session || Create a new terminal session
|-
|action/activate_menu || Activate menubar
|-
|action/list_sessions || Session list menu
|-
|action/move_session_left || Shift tab to the left
|-
|action/move_session_right || Shift tab to the right
|-
|action/previous_session || Go to tab to the left
|-
|action/next_session || Go to tab to the right
|-
|action/switch_to_session_# || Go to tab numbered #, where # is a number between 1 and 12 inclusive.
|-
|action/bigger_font || Increase font size
|-
|action/smaller_font || Decrease font size
|-
|action/toggle_bidi || Turn bidirectional text support on or off
|}

=== KWin ===

{|
|-
! Key !! Action
|-
|-
| action/kwin_rmb || Context menus on window titlebar and frame
|}

=== Panels ===

{{improve|revisit this when plasma is providing the panels}}

=== Using D-Bus To Find More Actions ===

== Authorizing {{path|.desktop}} Files ==

Application {{path|.desktop}} files can have an additional field <tt>X-KDE-AuthorizeAction</tt>.

If this field is present the {{path|.desktop}} file is only considered valid if the action(s) mentioned in this field has been authorized. If multiple actions are listed they should be separated by commas (',').

If the {{path|.desktop}} file of an application lists one or more actions this way and the user has no authorization for even one of these actions then the application will not appear in the KDE menu, will not allow execution via that {{path|.desktop}} file and will not be used by KDE for opening files of associated mimetypes.

== File Dialog ==

These keys disable actions that are found in the KDE file dialog. To use them, create a section in {{path|kdeglobals}} that looks like this:

<code ini>
[KDE Action Restrictions][$i]
action/<key>=false
</code>

{|
|-
! Key !! Action
|-
|-
| action/home || Go to home directory
|-
| action/up || Go to parent directory
|-
| action/back || Go to previous directory
|-
| action/forward || Go to next directory
|-
| action/reload || Reload directory
|-
| action/mkdir || Create new directory
|-
| action/toggleSpeedbar || Show/hide sidebar
|-
| action/sorting menu || Sorting options
|-
| action/short view || Select short view
|-
| action/detailed view || Select detailed view
|-
| action/show hidden || Show/hide hidden files
|-
| action/preview || Show/hide preview
|-
| action/separate dirs || Show/hide separate directories
|}

== Printing ==

There are several keys that restrict various aspects of the KDE print dialog and printing system. To use them, create a configuration section like this:

<code ini>
[KDE Resource Restrictions][$i]
print/<resource key>=false
</code>

Note how each of the printing keys start with <tt>print/<tt> in the configuration file.

;print/copies
:Disables the panel that allows users to make more than one copy.

;print/dialog
:Disables the complete print dialog. Selecting the print option will immediately print the selected document using default settings. Make sure that a system wide default printer has been selected. No application specific settings are honored when this restriction is activated.

;print/options
:Disables the button to select additional print options.

;print/properties
:Disables the button to change printer properties or to add a new printer.

;print/selection
:Disables the options that allows selecting a (pseudo) printer or change any of the printer properties. Make sure that a proper default printer has been selected before disabling this option. Disabling this option also disables <tt>print/system</tt>, <tt>print/options</tt> and <tt>print/properties</tt>.

;print/system
:Disables the option to select the printing system backend, e.g. CUPS. It is recommended to disable this option once the correct printing system has been configured.

== Resource Restrictions ==

KDE applications can take advantage of many types of resources such as configuration data, caches, plugin registries, etc. These are loaded from both system-wide as well as from per-user locations on disk. It is possible to restrict use of the per-user resources directories, preventing users from adding to or altering existing shared resources.

This is accomplished by creating a section like this in a configuration file:

<code ini>
[KDE Resource Restrictions][$i]
<resource key>=false
</code>

The following resources can be used as keys and controlled in this manner:

{|
|-
! Key !! Directory !! Provides
|-
|all || n/a || All resources listed in this table
|-
|autostart || {{path|share/autostart}} || Apps to start on login
|-
|data || {{path|share/apps}} || Application data
|-
|data_<appname> || {{path|share/apps}} || Application data for the application named <appname>
|-
|html || {{path|share/doc/HTML}} || HTML files
|-
|icon || {{path|share/icon}} || Icons
|-
|config || {{path|share/config}} || Application configurations
|-
|pixmap || {{path|share/pixmaps}} || Images
|-
|xdgdata-apps || {{path|share/applications}} || Application .desktop files
|-
|sound || {{path|share/sounds}} || Sound files
|-
|locale || {{path|share/locale}} || Localization data
|-
|services || {{path|share/services}} || Protocols, plugins, kparts, control panels, etc. registry
|-
|servicetypes || {{path|share/servicetypes}} || Plugin definitions, referenced in services registry entries
|-
|mime || {{path|share/mimelnk}} || Mimetype definitions
|-
|wallpaper || {{path|share/wallpapers}} || Desktop wallpaper images
|-
|templates || {{path|share/templates}} || Document templates
|-
|exe || {{path|bin}} || Executable files
|-
|lib || {{path|lib}} || Libraries
|}

== Screensavers ==
In {{path|kdeglobals}} in the <tt>[KDE Action Restrictions]</tt> group:

;opengl_screensavers
:defines whether OpenGL screensavers are allowed to be used.

;manipulatescreen_screensavers
:defines whether screensavers that manipulate an image of the screen (e.g. moving chunks of the screen around) are allowed to be used.

=== Automatic Log-out ===
In {{path|kscreensaverrc}}:

<code ini>
[ScreenSaver]
AutoLogout=true
AutoLogoutTimeout=600
</code>

The timeout is the time in seconds that the user must be idle for before the logout process is automatically started. Be careful with this capability as it can lead to data loss if the user has unsaved files open.

== Session Capability Restrictions ==

These keys apply to various capabilities associated with a desktop session and are not application specific. To use them, create a section in {{path|kdeglobals}} that looks like this:

<code ini>
[KDE Action Restrictions][$i]
<key>=false
</code>

;custom_config
:Whether the <tt>--config</tt> command line option should be honored. The <tt>--config</tt> command line option can be used to circumvent locked-down configuration files.

;editable_desktop_icons
:define whether icons on the desktop can be moved, renamed, deleted or added. You might want to set the path for the desktop to some read-only directory as well instead of {{path|$HOME/Desktop}}.

;lineedit_text_completion
:Defines whether input lines should have the potential to remember any previously entered data and make suggestions based on this when typing. When a single account is shared by multiple people you may wish to disable this out of privacy concerns.

;lock_screen
:whether the user will be able to lock the screen.

;logout
:whether the user will be able to logout from KDE.

;movable_toolbars
:define whether toolbars may be moved around by the user. See also <tt>action/options_show_toolbar</tt>.

;run_command
:whether the "Run Command" (Alt-F2) option is available.

;run_desktop_files
:defines whether users may execute desktop files that are not part of the default desktop, KDE menu, registered services and autostarting services.
* The default desktop includes the files under {{path|$KDEDIR/share/kdesktop/Desktop}} but '''not''' the files under {{path|$HOME/Desktop}}.
* The KDE menu includes all files under {{path|$KDEDIR/share/applnk}} and {{path|$XDGDIR/applications}}
* Registered services includes all files under {{path|$KDEDIR/share/services}}
* Autostarting services include all files under {{path|$KDEDIR/share/autostart}} but '''not''' the files under {{path|$KDEHOME/Autostart}}

;shell_access
:Whether a shell suitable for entering random commands may be started. This also determines whether the "Run Command" option (Alt-F2) can be used to run shell-commands and arbitrary executables. Likewise, executables placed in the user's Autostart folder will no longer be executed. Applications can still be autostarted by placing <tt>.desktop</tt> files in the {{path|$KDEHOME/Autostart}} or {{path|$KDEDIR/share/autostart}} directory. See also <tt>run_desktop_files</tt>.

:You probably also want to activate the following resource restictions:
*"appdata_kdesktop" - To restrict the default desktop.
*"apps" - To restrict the KDE menu.
*"xdgdata-apps" - To restrict the KDE menu.
*"services" - To restrict registered services.
*"autostart" - To restrict autostarting services.
:Otherwise users can still execute .desktop files by placing them in e.g. {{path|$KDEHOME/share/kdesktop/Desktop}}

;skip_drm
:defines if the user may omit DRM checking.

;start_new_session
:defines whether the user may start a second X session. See also the documentation on [http://docs.kde.org/en/HEAD/kdebase/kdm/ kdm configuration].

;switch_user
:defines whether user switching via kdm is allowed. See also the documentation on [http://docs.kde.org/en/HEAD/kdebase/kdm/ kdm configuration].

SysAdmin/Kiosk/Keys

2007-09-09T18:11:03Z

Logixoul: SysAdmin/Kiosk/Keys moved to KDE System Administration/Kiosk/Keys

#REDIRECT [[KDE System Administration/Kiosk/Keys]]

KDE System Administration/Kiosk/Introduction

2007-09-09T18:10:32Z

Logixoul: SysAdmin/Kiosk/Introduction moved to KDE System Administration/Kiosk/Introduction

== Introduction ==

The KDE Kiosk is a framework that has been built into KDE since version 3. It allows administrators to create a controlled environment for their users by customizing and locking almost any aspect of the desktop which includes the benign such as setting and fixing the background wallpaper, the functional such as disabling user log outs and access to the print system and the more security conscientious such as disabling access to a command shell.

This kind of framework is vital to maintain and increase KDE's propagation into areas such as business and enterprise environments and school and university laboratories. Other obvious areas of interest where a restricted desktop environment is required or desired would be the likes of Internet cafés, public access terminals and kiosks.

KDE's Kiosk framework is controlled by entries in various configuration files or through a GUI application, the Kiosk Admin Tool. In this article I will discuss the layout of KDE's configuration files and how to edit them to enable Kiosk's features. I will also discuss the various aspects of the desktop environment that can be customized and/or locked using the Kiosk framework. Once the reader understands how the Kiosk framework actually works through KDE's configuration files, we will discuss the Kiosk Admin Tool for those that prefer a GUI interface. This tool also allows administrators to more easily set-up Kiosk profiles and assign them system wide, per-user or per-group.

== KDE's Configuration File Structure and Hierarchy ==

All KDE applications use the same API to create, access and alter their configuration files. As such, all configuration files are stored in predetermined directories and they share the same syntax and structure. They are organised into groupings of key-value pairs. For example, let us examine some of the settings for the KDE desktop background stored in {{path|~/.kde/share/config/kdesktoprc}}:

<code ini>
[Desktop0]
Wallpaper=/usr/kde/share/wallpapers/KDE34.jpg
WallpaperMode=Scaled
</code>

The <tt>Desktop0</tt> group as shown contains two key-value pairs to indicate the image to be used as the wallpaper and how it should be displayed. The beginning of a group is indicated by placing its name in square brackets and that group ends when the next one begins or when the end of the configuration file is reached. Both the key and its value may contain spaces but all whitespace immediately before and after the equals sign and at the end of the line are ignored.

KDE configuration files can be stored in a number of possible directories and configuration files with the same name may exist in the different directories. There is a predetermined order in which these locations are checked for configuration files and KDE combines configuration files of the same name on a key-by-key basis; this is known as "cascading configuration". If the same key is defined in more than one of the configuration files then the key value read from the directory tree with the highest precedence will be used.

Two [[SysAdmin/Environment_Variables|environment variables]] are used to indicate which directories should be searched for configuration files: <tt>$KDEDIRS</tt> and <tt>$KDEHOME</tt>. <tt>$KDEDIRS</tt> is a list of "system level" directory trees for KDE system files including icons, wallpapers, fonts and configuration files. <tt>$KDEHOME</tt> determines the current users local KDE directory tree. Paths specified in <tt>$KDEDIRS</tt> should be separated with a colon (:) and the order of precedence for searching is from right to left. <tt>$KDEHOME</tt> has the highest precedence and is therefore searched last. If <tt>$KDEHOME</tt> is not set then {{path|$HOME/.kde}} is used. If <tt>$KDEDIRS</tt> is also not set then KDE3 reverts to KDE2 behaviour and uses the single path specified in <tt>$KDEDIR</tt>. The location of the configuration files in the KDE directory trees is <tt>/share/config</tt>.

The cascading nature of KDE's configuration files allows system administrators to set system wide defaults while ensuring that the user's custom configuration settings will always override these system defaults. It is also the basis of the Kiosk framework as configuration entries may be marked as "immutable" - entries in a user's configuration file in <tt>$KDEHOME</tt> that have been marked as immutable in a system level directory will not be read and will therefore have no effect.

Let us continue with the desktop background example and, as the system administrators of an Internet café, we want to ensure that our logo or our sponsor's logo is always the desktop background and that it cannot be changed by our customers. In one of the system level directory trees (<tt>$KDEDIRS</tt>), we would edit the file {{path|/share/config/kdesktoprc}} so that it contained:

<code ini>
[Background Common]
CommonDesktop[$i]=true

[Desktop0]
Wallpaper[$i]=/usr/kde/share/wallpapers/our_logo.jpg
WallpaperMode[$i]=Scaled
</code>

Appending '<tt>[$i]</tt>' to the configuration key marks it as immutable. As configuration files from <tt>$KDEDIRS</tt> are read before <tt>$KDEHOME</tt>, the background is now "locked down" and and any custom settings made by a user in {{path|$KDEHOME/share/config/kdesktoprc}}, either directly or though a configuration dialog, will not be read by the configuration system.

Configuration options can also be marked immutable by group and by file. To mark a group as immutable, we append '<tt>[$i]</tt>' to the group name:

<code ini>
[Desktop0][$i]
Wallpaper=/usr/kde/share/wallpapers/KDE34.jpg
WallpaperMode=Scaled
</code>

Similarly, we can mark an entire configuration file as immutable by placing '<tt>[$i]</tt>' on a line of its own at the beginning of the file; KDE will now ignore a configuration file of the same name in the user's KDE configuration directory.

Setting default configuration options for KDE applications is just as easy as fixing the desktop background. We could lock Konqueror's homepage setting to our Internet café's homepage by setting the following in a file called <tt>konquerorrc</tt> in one of the system directory trees:

<code ini>
[FMSettings]
HomeURL[$i]=http://www.myinternetcafe.com/
</code>

Any setting that can be changed or customized in an application is one that can be locked down using the Kiosk framework. Examine the contents of the various configuration files that can be found under {{path|$KDEHOME/share/config/}} to get a feeling for KDE application configuration settings.

You should also bear in mind that most applications will need to be restarted for configuration settings to take effect. For changes to configuration files such as <tt>kdesktoprc</tt> and <tt>kdeglobals</tt> (introduced in the next section) you will need to log out and back into KDE for changes to be applied.

The information presented in this section will allow you to set system defaults and lock them if necessary for any KDE application. However, this is only the proverbial tip of the iceberg of the KDE Kiosk system and in the following sections we will cover many more of its capabilities.

== KDE Action Restrictions ==

One of KDE's strongest features is the fact that it is "an integrated desktop environment". This means that all of its applications share the same 'look-and-feel' so that once you have learned how to use one KDE application, learning the next is even easier. This common functionality - standardised menus and toolbars, integrated help system, etc â is built around the concept of "actions".

For example, one can open a file by selecting the 'File->Open...' menu option, by clicking on the 'File Open' toolbar icon or by pressing 'CTRL+O'. Whichever way you choose, each option simply activates the <tt>file_open</tt> action.

All KDE actions can be restricted through the Kiosk system by placing appropriate entries in the {{path|/share/config/kdeglobals}} file in a system level directory. We could disable the file open action by adding the following entry:

<code ini>
[KDE Action Restrictions][$i]
action/file_open=false
</code>

This change can be visibly seen in Kate's 'File' menu and toolbar which are shown in Figs. 2 and 3.

<table border="0">
<tr>
<td align="center">
<img src="kiosk-lp/unrestricted.jpg" width="250" border="0" height="286" alt="Image of an unrestricted menu and toolbar" />
</td>
<td>               </td>
<td align="center">
<img src="kiosk-lp/restricted.jpg" width="250" border="0" height="287" alt="Image of a restricted menu and toolbar" />
</td>
</tr>
<tr>
<td align="center">
Figure 2. <code>file_open</code> unrestricted.
</td>
<td></td>
<td align="center">
Figure 3. <code>file_open</code> restricted.
</td>
</tr>
</table>

There are currently over 120 actions that can be restricted in KDE 3.4 and these include all standard file options, editing options, Internet and file browsing actions, the use of bookmarks and access to the help system. A full list can be found in the [http://websvn.kde.org/trunk/KDE/kdelibs/kdecore/doc/README.kiosk?view=markup kdecore/doc/README.kiosk] file of the kdelibs package source code for your current KDE version (available from [http://developer.kde.org/source/ http://developer.kde.org/source/]).

Some KDE applications, such as system configuration front ends like KUser, need to be run as the root user. These applications would be unnecessary in an Internet café and they can be disabled with:

<code ini>
[KDE Action Restrictions][$i]
user/root=false
</code>

The ability to print documents can be blocked via the action <tt>file_print</tt> and access to the printing system/backend can be blocked by setting the <tt>print/system</tt> to <tt>false</tt>. One can also disable access to the printing properties dialogue, the ability to print more than one copy, etc. These are all referenced in the [http://websvn.kde.org/trunk/KDE/kdelibs/kdecore/doc/README.kiosk?view=markup kdecore/doc/README.kiosk] file.

A few other actions that are worthy of individual mention in the context of Internet cafés and similar environments are:

;<tt>shell_access</tt>
:Defines whether the user can start a shell for entering commands, whether the "Run Command" option (Alt-F2) can be used to run shell-commands and arbitrary executables and whether executables placed in the user's Autostart folder will be executed.

;<tt>logout</tt>
:Defines whether a user will be able to end the KDE session.

;<tt>lock_screen</tt>
:Defines whether a user will be able to lock the screen.

;<tt>run_command</tt>
:Controls access to the "Run Command" option.

;<tt>movable_toolbars</tt>
:Whether or not toolbars may be moved around by the user.

Users of public access terminals and Internet cafés will undoubtedly want to keep their browsing history to themselves. You should carefully consider settings such as the history sidebar, how cookies are handled and whether or not to use a cache. Once you have made your choices, set these options in <tt>konquerorrc</tt> and mark them as immutable. Also, if you are a regular user of Konqueror then you know that it has a very useful feature in that it remembers the URLs you enter in the "Location" bar. In a public environment, set the action <tt>lineedit_text_completion</tt> to false so that text boxes do not remember previously entered information.

One may also wish to set the action <tt>editable_desktop_icons</tt> to false as it defines whether icons on the desktop can be moved, renamed, deleted or added by users. Be sure to either move the desktop directory and/or to make it read-only (usually {{path|$HOME/Desktop}}).

== KDE URL Restrictions ==

The KDE Kiosk system allows system administrators to control access to specific URLs based on the referrer, the protocol, the host and the path through entries in the {{path|kdeglobals}} file. Although some of these tasks may be more appropriate for a proxy server or a firewall, this functionality becomes incredibly useful when you consider the fact that KDE treats all locations as URLs. For blocking access to websites, one might use the following example:

<code ini>
[KDE URL Restrictions][$i]
rule_count=2
rule_1=open,,,,http,*.hotmail.msn.com,,false
rule_2=open,,,,http!,webmail.college.com,,false
</code>

The first rule blocks all http and https access to any URL that contains <tt>.hotmail.msn.com</tt> in the host part. Specifying one protocol will also match similar protocols that start with the same name; so specifying http will also include https. Rule 2 above blocks only http and thus forces the user to use https (assuming it is supported). The above rules could be used as a basis, for example, to block all access to third part web-based e-mail clients and force users to use a company or college provided virus-scanned e-mail account over https. If, for example, an Internet café took sponsorship from a search engine then its system administrators could use similar rules to block access to that search engine's competitors.

The format for URL restrictions is:

<code ini>
rule_N=<action>,<referrer protocol>,<referrer host>,<referrer path>,
<protocol>,<host>,<path>,<enabled>
</code>

Any option that is left blank will match all by default. As we saw in the example above, wild cards may be used for host names. Specifying a path will match all URLs that begin with that path unless an exclamation mark is placed at the end of the path.


As I mentioned, KDE treats all locations as URLs: for example Internet addresses are URLs with the http or https protocol whereas local files on the hard drive are URLs using the file protocol (for a full list of supported protocols, execute the command '<tt>kcmshell ioslaveinfo</tt>'). Access to the local filesystem can be restricted using rules such as the following:

<code ini>
[KDE URL Restrictions][$i]
rule_count=6
rule_1=open,,,,file,,,false
rule_2=list,,,,file,,,false
rule_3=open,,,,file,,$HOME,true
rule_4=list,,,,file,,$HOME,true
rule_5=open,,,,file,,$TMP,true
rule_6=list,,,,file,,$TMP,true
</code>


These rules will only allow the user to browse and access files stored in their home directory. We also allow access to the temporary directory used by KDE to ensure normal operation. If you are implementing a security policy then these rules should be used in conjunction with other rules such as restricted shell access.

== KDE Control Module Restrictions ==

Almost all aspects of the K Desktop Environment can be configured and customized through the "Control Centre". Each "group" of settings, such as "Background", "Colours", "Fonts", etc as shown in Fig. 4, correspond to a control centre module and each of these modules can be locked down through the Kiosk framework.

As an example, a better way of preventing users from customizing their desktop backgrounds than that shown in section 1 would be to lock down that control module:

<code ini>
[KDE Control Module Restrictions][$i]
kde-background.desktop=false
</code>

In fact, the users will not even see an option to configure the background in either the Control Centre or by right-clicking on the desktop. Run the command '<tt>kcmshell --list</tt>' for a list of available modules and use the format kde-<module-name>.desktop in the configuration file. In most public access/café environments, one will probably want to lock down almost all control centre modules.

<img src="kiosk-lp/control_centre.jpg" width="211" border="0" height="456" alt="Image of Control Centre Modules" />

Figure 4. The Control Centre application interface.

== KDE Resource Restrictions ==

There are many other resources located under the {{path|/share}} directory that are used by KDE applications such as icons, sounds, wallpapers, etc. Users can override these resources by placing files in the same location under <tt>$KDEHOME</tt>. The KDE Kiosk system can prevent users from overriding the default resources and the necessary configuration options can be found in the [http://websvn.kde.org/trunk/KDE/kdelibs/kdecore/README.kiosk?view=markup README.kiosk] file that was mentioned in section 2.

== The KDE Kiosk Tool ==

The KDE Kiosk Admin tool, see Fig. 5, is a graphical front end to the KDE Kiosk framework and was originally written by Waldo Bastian, a core KDE developer, for Novell's Linux Desktop. As well as provided an interface to the Kiosk framework, it also allows KDE administrators to create default profiles for different groups of users (that is "groups" in the Unix file system sense) far easier than could be accomplished through the configuration files.

[kiosk-lp/kiosktool.jpg" title="Click for a larger image
<img src="kiosk-lp/kiosktool-small.jpg" border="0" width="388" height="256" alt="The Kiosk Tool" />
]

Figure 5. The KDE Kiosk Admin Tool.

The Kiosk Admin tool is not part of the official KDE distribution as it is under active development and keeping it free from KDE's release schedules allow its developers to incorporate feedback faster. It is, however, included with many Linux distributions. More information and downloads can be found on [http://extragear.kde.org/apps/kiosktool/ http://extragear.kde.org/apps/kiosktool/].

As I mentioned, one of Kiosk Tool's strongest assets is the ease at which one can create multiple Kiosk profiles and assign them per Unix group. For example, in an Internet café one might create two groups: customers and admins. It would then be logical to have an increased set of restrictions (such as file system access, shell access, etc) assigned to the customers' account(s) while leaving the administrators' accounts with little or no restrictions.

The Kiosk Admin tool also allows system administrators to maintain all profiles on their local machine and then upload them to another server when profiles are added, deleted or modified.

== Closing Remarks ==

KDE's Kiosk framework is an essential tool for any system administrator who is maintaining or deploying the K Desktop Environment in a multi-desktop/multi-user scenario and/or in an environment where users cannot be trusted. By preventing users from changing default settings and locking down settings that may pose a security risk, a system administrator can significantly reduce the amount of time that will be spent "maintaining and repairing" each desktop as well as ensuring that each user has a common and familiar desktop environment every time they sit down to the computer.

{{CC-BY-SA}} © 2005 Barry O'Donovan

SysAdmin/Kiosk/Introduction

2007-09-09T18:10:32Z

Logixoul: SysAdmin/Kiosk/Introduction moved to KDE System Administration/Kiosk/Introduction

#REDIRECT [[KDE System Administration/Kiosk/Introduction]]

KDE System Administration/Startup

2007-09-09T18:10:00Z

Logixoul: SysAdmin/Startup moved to KDE System Administration/Startup

== Startkde Script ==

The KDE startup sequence starts with the '''startkde''' script. In most cases this
script gets called from the display manager (KDM) once the user has been authenticated.
There are two very important lines in the startkde script:
<code>
LD_BIND_NOW=true kdeinit +kcminit +knotify
</code>
and
<code>
kwrapper ksmserver $KDEWM
</code>
The first line starts the kdeinit master process. This process is used to start all other
KDE processes. The arguments behind kdeinit are the names of additional services to be started.
The '''+''' indicates that kdeinit needs to wait till the service has finished.

The second line asks kdeinit to start the ksmserver session manager process.
The session manager determines the lifetime of the session. When this process exits, the user is logged out.

== Background Services ==
All KDE background services are user specific, unlike system daemons they are not shared between users.
Apart from being unique per user they are unique per X-server display as well.

=== kdeinit: Kicking Everything Off ===
kdeinit is used to start all other KDE programs. kdeinit can start normal binary program files as well
as kdeinit loadable modules (KLMs). KLMs work just like binary program files but can be started
more efficiently. The drawback is that programs started this way appear as ''kdeinit'' in the output
of <tt>top</tt> and <tt>ps</tt>. Use <tt>top -c</tt> or <tt>ps aux</tt> to see the actual program name.
For example:
<code>
> ps aux
waba 23184 0.2 2.1 23428 11124 ? S 21:41 0:00 kdeinit: Running...
waba 23187 0.1 2.1 23200 11124 ? S 21:41 0:00 kdeinit: dcopserver --nosid
waba 23189 0.2 2.4 25136 12496 ? S 21:41 0:00 kdeinit: klauncher
waba 23192 0.7 2.8 25596 14772 ? S 21:41 0:00 kdeinit: kded
waba 23203 0.8 3.4 31516 17892 ? S 21:41 0:00 kdeinit: knotify
</code>
<tt>kdeinit: Running...</tt> indicates the master kdeinit process. The other processes listed
are programs started as KLMs.

When kdeinit starts for the first time it will launch klauncher and kded, as well as any additional
programs specified on its command line in the startkde script. Normally that is kcminit and knotify.

=== dbus-daemon: Inter-process Communication ===
dbus-daemon is a background process (daemon) which provides inter-process communication (IPC) facilities to all KDE
applications as well as several other system components, such as HAL, network manager, power manager and various non-KDE desktop applications. It is a cross-desktop, portable IPC project which is hosted at freedesktop.org.

D-Bus facilities are accessible from the command shell via the qdcop command line tool and can be explored using the graphical dcop-viewer application. D-Bus is essential for all KDE applications and should autostart when requested.

=== klauncher: Service Activation ===
klauncher is a deamon which is responsible for service activation within KDE. It operates in close connection with the kdeinit master process to start new processes. KDE applications communicate with klauncher over the D-Bus in order to start new applications or services.

=== kded: Background Services ===
kded is a generic KDE daemon. It has the ability to load various service modules and run these in the background. Each kded service module is described by a .desktop file installed under {{path|$KDEDIR/share/services/kded/}} The '''Service Manager''' in the Control Center can be used to
monitor the status of the service modules and to disable certain services.

=== kcminit: Initialization Services ===
kcminit executes initialization services during startup. Initialization services are specified in the .desktop files of applications or services via the X-KDE-Init line. Initialization services are typically used for initializing hardware based on user specified settings.

<tt>kcminit --list</tt> can be used to show all initialization services and <tt>kcminit <service></tt> can be used to execute a single service explicitly. This can be useful when investigating start-up problems.

=== knotify: Notification Services ===
The primary task of <tt>knotify</tt> is to relay notifications to appropriate sub-systems. For instance, sound alerts are sent to the sound system, visual alerts are showed on-screen using passive popups or dialogs, logged messages are written out to disk, etc. The actions are user configurable and support user interaction.

=== ksmserver: Session Management and Autostart ===

{{improve|When the fd.o autostart spec is finalized and implemented in KDE4, update this section}}

<tt>ksmserver</tt> is KDE's session manager. On startup the session manager starts auto-start applications and it restores applications from the previous session.

The applications to auto-start are indicated by .desktop files in the {{path|$KDEDIR/share/autostart}} directory. Auto-start of an application can be made conditional upon the '''X-KDE-autostart-condition''' entry in the .desktop file. The {{path|ktip.desktop}} file for example contains:

<code>
X-KDE-autostart-condition=ktiprc:TipOfDay:RunOnStart:true
</code>

This means that the '''ktiprc''' configuration file is checked for a '''RunOnStart''' entry in the '''[TipOfDay]''' section. If no such entry is found, '''true''' is assumed, which means that ktip is one of the applications that is auto-started by default.

{{improve|This may change in KDE4. Check back closer to release.}}

There is an additional auto-start directory, {{path|$KDEHOME/Autostart}} that is sourced later. Note that this autostart path differs from the {{path|$KDEDIR/share/autostart}} directory used by the session manager. While {{path|$KDEDIR/share/autostart}} must contain .desktop files, $KDEHOME/Autostart may contain all kinds of files. The files will be opened as if they were clicked upon by the user.

The KDE session manager also restores one of the previous sessions. A session contains of a collection of applications as well as application specific information that reflects the state of the applications at the time the session was saved. Sessions are stored in the {{path|ksmserverrc}} configuration file and contains references to application specific state information. The application specific state infomation is saved in {{path|$KDEHOME/share/config/session}}.

For example if ksmserverrc contains:
<code>
restartCommand1=kwin,-session,110a0a0002000106760689100000019360000_1083342151_608625
restartCommand2=konsole,-session,10378ac070000108334204700000277690000_1083342151_552722
</code>
Then the application specific state information for <tt>kwin</tt> and <tt>konsole</tt> can be found in
<code>
$KDEHOME/share/config/session/kwin_110a0a0002000106760689100000019360000_1083342151_608625
</code>
and
<code>
$KDEHOME/share/config/session/konsole_10378ac070000108334204700000277690000_1083342151_552722
</code>
respectively.

The state information of kwin contains the location of the application windows of all the other applications in the session.

== Desktop Components ==
The three major components of the desktop are the window manager, command executer and workspace (desktop and panels).

=== kwin: Window Manager ===
The window manager is always started by the session manager as part of the session restoration.
The window manager is responsible for managing all the windows across the virtual desktops,
including initial placement, minimizing, maximizing, raising, lowering of the windows and
focus switching between windows.

By default, KWin is started as the window manager in a KDE session. This can be overriden by defining the <tt>KDEWM</tt> environment variable to be name of an alternate window manager.

=== krunner: Run Dialog, Task List, Screensaver ===

<tt>krunner</tt> is auto-started by the session manager by means of {{path|$KDEDIR/share/autostart/krunner.desktop}}. It is responsible for activating the screensaver, application start feedback, the Run Command (Alt-F2) dialog, and the task list window and is meant to run for the lifetime of the session.

=== Plasma ===

{{improve|when plasma enters the start up sequence document it here.}}

KDesktop is auto-started by the session manager by means of {{path|$KDEDIR/share/autostart/plasma.desktop}}

SysAdmin/Startup

2007-09-09T18:10:00Z

Logixoul: SysAdmin/Startup moved to KDE System Administration/Startup

#REDIRECT [[KDE System Administration/Startup]]

KDE System Administration/Environment Variables

2007-09-09T18:09:20Z

Logixoul: SysAdmin/Environment Variables moved to KDE System Administration/Environment Variables

== Introduction ==
There are numerous environment variables that are useful when managing and controlling a KDE environment. Supported environment variables are listed below.

== Automatically Set Variables ==

=== KDE_FULL_SESSION ===
Set to true by KDE startup, it is used by e.g. Konqueror to know if it should consider remaining in memory for future re-use when being closed. If not set, konqueror will exit after being closed (e.g. kdesu does that, it's also useful for debugging).

If you plan on using this variable to detect a running KDE session, it is safest to check if the value is not empty (i.e. test -n "$KDE_FULL_SESSION") instead of seeing if it equals true. This allows for changing the value of the variable to include KDE version info or other uses.

=== KDE_SESSION_VERSION ===
Introduced in KDE4, this environment variable is set to the major version number of the KDE desktop being run on startup. This allows one to know which <tt>kde?-config</tt> to run: <tt>kde${KDE_SESSION_VERSION}-config</tt>. For KDE3 this will resolve to <tt>kde-config</tt> and for KDE4 this will result in <tt>kde4-config</tt>. One can then use this knowledge to query more details as to the minor version, prefixes, etc.

== Display and Window Management ==

=== KDEWM ===
If the KDEWM environment variable has been set, then it will be used as KDE's window manager within the startkde script instead of kwin.

=== KDE_DISPLAY ===
An old(?) way to set DISPLAY for multihead.

=== KDE_MULTIHEAD ===
Set this variable to "true" to indicate that KDE is running on a multi-head system.

== File System ==

=== KDEDIRS ===
Overrides KDEDIR and allows you to specify multiple directories where KDE searches for its data. Useful if you want or have to install some programs to a different prefix than the rest of your KDE.

Please note, that at least the startkde script expects the KDE install directory to be listed as first.

=== KDEHOME ===
If not set, KDE uses ~/.kde as directory where your personal data is stored.

=== KDE_HOME_READONLY ===
Set this variable to indicate that your home directory is mounted as read-only.

=== KDEROOTHOME ===
If not set, KDE uses ~root/.kde as directory for root's personal data. Was introduced to prevent KDE from accidently overwriting user data with root permission when user run a KDE program after switching with "su" to root.

=== KDESYCOCA ===
Allows to specify the path and the name of the generated KDE system configuration cache file.

=== KDETMP ===
Allows to specify another path than /tmp where KDE stores its temporary files.

=== KDEVARTMP ===
Allows to specify another path than /var/tmp where KDE stores its variable files.

== Localization ==

=== KDE_LANG ===
Overrides the KDE language configuration, e.g. "KDE_LANG=fr kprogram &" starts a program with french translation if the necessary files are installed.

=== KDE_UTF8_FILENAMES ===
If this environment variable is set, KDE assumes all filenames are in UTF-8 encoding regardless of the current C locale.

== Networking ==

=== KDE_NO_IPV6 ===
Set this variable to disable IPv6 support / IPv6 DNS lookups.

=== KDE_USE_IDN ===
The content of this variable defines for which top level domains the usage of IDN is enabled. If not set, "at:ch:cn:de:dk:kr:jp:li:no:se:tw" will be used.

== Performance Related ==

=== KDE_IS_PRELINKED ===
Set this variable to indicate that you have prelinked your KDE binaries and libraries.

=== KDE_MALLOC ===
If set to "1" the fast malloc routine provided in kdecore is used if KDE was compiled with --enable-fast-malloc, otherwise the libc's routine is used.

=== KDE_NOUNLOAD ===
If this variable is set then KLibLoader is told to never unload dynamically opened libraries.

=== KDE_DOUNLOAD ===
If this variable is set then KLibLoader is told to always try to unload dynamically opened libraries. Warning, this will most probably lead to crashes!

== Troubleshooting and Debugging ==

=== KDE_DEBUG ===
Set this variable to disable the KDE crash handler (same as --nocrashhandler command line option).

=== KDE_COLOR_DEBUG ===
Starting from KDE 4, set this variable to get colourful debug output which will look nicely in Konsole.

=== KDE_FORK_SLAVES ===
Set this variable to spawn KIO-slaves directly from the application process itself, by default KIO-slaves are spawned using klauncher/kdeinit. This option is useful if the KIO-slave should run in the same environment as the application, this can be the case with Clearcase.

== freedesktop.org Compliance ==

The following environment variables are defined in the [http://freedesktop.org/wiki/Standards/basedir-spec freedesktop.org base directory specification] and are supported by all XDG compliant environments and applications.

=== XDG_DATA_HOME ===
Defines the base directory relative to which user specific data files should be stored. If <tt>$XDG_DATA_HOME</tt> is either not set or empty, a default equal to {{path|$HOME/.local/share is used}}.

=== XDG_CONFIG_HOME ===
Defines the base directory relative to which user specific configuration files should be stored. If <tt>$XDG_CONFIG_HOME</tt> is either not set or empty, a default equal to {{path|$HOME/.config}} is used.

=== XDG_DATA_DIRS ===
Defines the preference-ordered set of base directories to search for data files in addition to the <tt>$XDG_DATA_HOME</tt> base directory. The directories in <tt>$XDG_DATA_DIRS</tt> should be separated with a colon ':'. If $XDG_DATA_DIRS is either not set or empty, a value equal to {{path|/usr/local/share/:/usr/share/}} is used.

=== XDG_CONFIG_DIRS ===
Defines the preference-ordered set of base directories to search for configuration files in addition to the <tt>$XDG_CONFIG_HOME</tt> base directory. The directories in <tt>$XDG_CONFIG_DIRS</tt> should be separated with a colon ':'. If $XDG_CONFIG_DIRS is either not set or empty, a value equal to {{path|/etc/xdg}} is used.

SysAdmin/Environment Variables

2007-09-09T18:09:20Z

Logixoul: SysAdmin/Environment Variables moved to KDE System Administration/Environment Variables

#REDIRECT [[KDE System Administration/Environment Variables]]

KDE System Administration/XDG Filesystem Hierarchy

2007-09-09T18:08:45Z

Logixoul: SysAdmin/XDG Filesystem Hierarchy moved to KDE System Administration/XDG Filesystem Hierarchy

== Freedesktop.org and Standard Directories ==

Many of the free and open source software projects that focus on desktop technology collaborate on shared specifications and software within the [http://freedesktop.org freedesktop.org] project.

One of these shared specifications is the [http://standards.freedesktop.org/basedir-spec/latest/ base directory specification] which defines a set of locations in the filesystem that can be used for portable desktop technology implementations.

KDE supports the base directory specification and the various [[../Environment_Variables|environment variables]] it prescribes in addition to the [[../KDE_Filesystem_Hierarchy|KDE filesystem hierarchy]]. A summary of KDE's implementation follows below, while the full specification can be read [[http://standards.freedesktop.org/basedir-spec/latest/ here on freedesktop.org]].

== Application Data ==

Data that applications store which are specific to a given user are to be stored in the <tt>XDG_DATA_HOME</tt> directory. If the <tt>XDG_DATA_HOME</tt> environment variable isn't set, it defaults to {{path|$HOME/.local/share}} for local storage and {{path|/usr/local/share;/usr/share}} for system wide files.

Some items that may be stored in <tt>XDG_DATA_HOME</tt> are files the user has put in the trash, mimetype definitions and associations and application .desktop files.

The search path for system wide directories can be defined setting the <tt>XDG_DATA_DIRS</tt> environment variable to contain a list of paths.

== Configuration ==

Configuration information should be stored in the <tt>XDG_CONFIG_HOME</tt> directory. If the <tt>XDG_CONFIG_HOME</tt> environment variable isn't set, it defaults to {{path|$HOME/.config}} for local storage and {{path|/etc/xdg}} for system wide files.

Some items that may be stored in <tt>XDG_CONFIG_HOME</tt> are application configuration files and application menu structure.

The search path for system wide directories can be defined setting the <tt>XDG_CONFIG_DIRS</tt> environment variable to contain a list of paths.

== Cache Files ==

Temporary data caches can be stored in the <tt>XDG_CACHE_HOME</tt> location, which defaults to {{path|$HOME/.cache}}. There is no system wide cache location as such caches are always user specific.

== Thumbnails ==

Thumbnails representing the contents of files for use in icons and other representations of files are to be stored in {{path|$HOME/.thumbnails}}. The structure and content of the thumbnails directory is defined in the [http://jens.triq.net/thumbnail-spec/index.html thumbnail specification].

SysAdmin/XDG Filesystem Hierarchy

2007-09-09T18:08:45Z

Logixoul: SysAdmin/XDG Filesystem Hierarchy moved to KDE System Administration/XDG Filesystem Hierarchy

#REDIRECT [[KDE System Administration/XDG Filesystem Hierarchy]]

KDE System Administration/KDE Filesystem Hierarchy

2007-09-09T18:07:08Z

Logixoul: SysAdmin/KDE Filesystem Hierarchy moved to KDE System Administration/KDE Filesystem Hierarchy

SysAdmin/KDE Filesystem Hierarchy

2007-09-09T18:07:08Z

Logixoul: SysAdmin/KDE Filesystem Hierarchy moved to KDE System Administration/KDE Filesystem Hierarchy

#REDIRECT [[KDE System Administration/KDE Filesystem Hierarchy]]

User:Danimo/KIOSK/new

2007-09-09T18:02:13Z

Logixoul: fix double redirect

== Overview ==

KIOSK Admin Tool is a KDE administration tool that offers system administrators an easy way to predefine desktop configurations for single and/or groups of users, lock down settings or otherwise restrict features of the KDE desktop environment.

The default Desktop delivers many powerful features an possibilities. However, in business environment for example it is neccesary to reduce the number of programs, features and possibilities according to the tasks that need to be done.

KIOSK Admin Tool takes advantage of KDE's KIOSK restrictions framework. It is centered around profiles.A profile is a collection of default settings and restrictions that can be applied to either individual users or groups of users.

KDE's Kiosk framework makes it possible for a system administrator to turn off certain KDE features.

Typical usage of KIOSK Admin Tool is to create a new profile, then to set up the profilewith the desired default settings and restrictions, and finally to activate the profile by assigning the profile to one or more users.

== Profiles ==

A profile is a collection of default settings and restrictions that can be applied to either individual users or groups of users.

The KDE desktop environment as well as all KDE applications use a specific directory structure to lookup configuration settings and various other information. KDE knows about several locations for these directory structures. All the information and configuration settings found in the various locations are combined before they are used. Lock down features control whether settings in the user's home folder ($KDEHOME or ~/.kde) are taken into account or not.

A profile consists of a standard KDE directory structure in a custom location with settings and information chosen by you.

KIOSK Admin Tool lets you chose in which location a profile should be stored. Information about available profiles is stored in the file /etc/kderc.

It is recommended to store all profiles under a single directory. In this case the /etc/kderc file only needs to contain a reference to this single directory and KDE and KIOSK Admin Tool will automatically pick up all profiles stored under this directory. See the Chapter 4chapter for more information.

== Install KIOSK Admin Tool and KDE Basics ==

The KIOSK Admin Tool works since KDE 3. When using KIOSK Admin Tool in combination with older versions of KDE (KDE 3.2 or older) some additional steps need to be taken in order to properly activate the profiles.

The newly introduced, common KDE 3.2 menu format is documented at [http://freedesktop.org/Standards/menu-spec/ freedesktop.org]
The new menu format defines structure in a single .menu file, is based on categories, is shared between Gnome and KDE and supports applnk style menus as well.

For this tutorial, it is preferred to use KDE 3.2.2 or newer.

The Distribution of SuSE 9.1 contains KIOSK Admin Tool that should be replaced by a newer version.

Downloads from: http://extragear.kde.org/apps/kiosktool

For SuSE you can get a rpm-package. Install command :

rpm -i kiosktool-version.i568.rpm

The installation procedure in SuSE 9.2 may be done directly by YAST, but you have to select KIOSK Admin Tool manually. Additional informations to next part of documentation (filesystem hierarchie, configuration files) you find in the [[KDE System Administration|TechBase SysAdmin area]].

KDE defines a filesystem hierarchy which is used by the KDE environment itself as well as all KDE applications (and KIOSK Admin Tool).

<code>
/opt kde3/bin/kiosktool
/opt/kde3/bin/kiosktool-kdedirs
/opt/kde3/share/apps/kiosktool/...
/opt/kde3/share/config/kiosktoolrc
/opt/kde3/share/icons/...
/opt/kde3/share/locale/... (language packages)
...
</code>

check this: kiosktool-kdedirs check

=== KDE Directory Layout (SuSE Linux for example) ===

$HOME/.kde user level, personal KDE directory
/opt/kde3 system level, SuSE specific,
sometimes /usr or /usr/kde3
/etc/opt/kde3 Added by SuSE

=== Environment Variables ===

$KDEHOME ~/.kde normally located in user's home directory
$KDEROOTHOME /root/.kde
$KDEDIR /opt/kde3, /usr, /usr/kde3 depends from distribution, used by KDE2
$KDEDIRS /opt/kde3, /usr, /usr/kde3 new in KDE3 : multiple locations possible

The default values most times don't need to be changed (the default is OK).
Normally $KDEHOME, the tree located in the user's home directory, has the highest precedence. This is the directory tree where the user sets up his own changes.

Normally $KDEHOME, the tree located in the user's home directory, has the highest precedence. This is the directory tree where the user sets up his own changes.
A system administrator can create additional directory trees which can be used for profiles.
Special KDE configuration directories for special user profiles (or group profiles) will be specified within /etc/kderc (SuSE: /etc/kde3rc).

=== Additional (shared) KDE Sub-Directories ===

share/applications/ .desktop files for the KDE Menu (since KDE3.2)
share/apps contains applications specific data files; Each application has a sub-directory here for storing additional data files
share/config configuration files for KDE applications (normally named after the the application they belong to plus rc, i.e. kiosktoolrc). A special case is kdeglobals as a file that is readed by all KDE applications.
share/config/session/ used by KDE session manager ksmserver (normally only available under $KDEHOME/... At the end of a session KDE applications store their state here. The file names start with the name of the application followed by a number. ksmserver stores references to these numbers when saving a session in share/config/ksmserverrc .
share/doc/HTML/ contains documentation of KDE and KDE applications (khelpcenter)
share/icons icons for KDE applications
share/mimelnk KDE uses .desktop files that describe MIME types to identificate the type of a file
share/services contains .desktop files that describe services. Services are like applications but are usually launched by other applications instead of the user . Services do not appear in the KDE menu.
share/servicetypes servicetypes usually represents a certain programming interface
share/sounds contains sound files
share/templates contains templates for creating files of various types including a reference to a file in the .source sub-directory
share/wallpapers contains images that can be used as background picture

=== Additional (OS- and CPU-depended) KDE Sub-Directories ===

bin/ used for KDE executables
cgi-bin/ CGI scripts that can be used by the KDE Help Center
lib/ used for KDE libraries
lib/kde3 contains components, plugins and other runtime loadable objects for use by KDE 3.x applications

=== Additional (Host Specific) KDE Sub-Directories ===

three host-specific directories that are usually symlinked to other locations:
$KDEHOME/socket-$HOSTNAME --> /tmp/ksocket-$USER/
$KDEHOME/tmp-$HOSTNAME --> /tmp/kde-$USER/
$KDEHOME/cache-$HOSTNAME --> /tmp/kdecache-$USER/
/tmp and /var/tmp as systemwide (maybe world) writable directories
opt/kde3/bin/./lnusertemp tmp lnusertemp utility will create a new directory with an alternative name and links to that instead. That's why there is a possibility, that one of the mentioned directories already exists but is owned by another user.

=== KDE Configuration Files ===

simple text files, UTF-8 encoding for text outside the ASCII range
Groups indicated by a groupname placed in square brackets at the top of a group followed by key-value-pairs. Key and value are separated by an equal sign. The key can contain spaces and may be followed by options placed in square brackets, sometimes with optional backslash codes for special output formats. All the key-values entries that follow belong to the group.

[groupname]
keyname=value [option]

Entries at the top of the file that are not preceded by a group name belong to the default group.

=== Configuration Files Cascading ===

There can be multiple configuration files with the same name in the share/config sub-directory of the various KDE directory trees.
A configuration file can contain only few selected groups with few selected keys.

The final value of a key depends from the the priority of the directory the configuration file is placed and the precedence of the key in it.
The configuration files under $KDEHOME have always the highest priority. The precedence order of KDE directories is listed in $KDEDIRS, available since KDE 3.x.

If $KDEDIRS is undefined , the single location of $KDEDIR is used instead.
If a key in a certain group is defined multiple times in a single file, the value of the last entry is used.

Starting with KDE 3, configuration entries can be marked immutable, and once such a value has been read its value cannot be changed any more via KConfig or user entries in $KDEHOME . Entries can be marked immutable on an entry-by-entry, group, or file basis by adding a [$i] at the right places.

Keyword[$i]=value prevents overwriting the default setting and marks this key immutable.

Group[$i] sets all key entries of this group immutable.
To lock down the entire file, start the file with [$i] in a single line.

[$e] and [$ie] are so called Shell Expansions and can be used to provide more dynamic default values.

Normally the expanded form is written into the users configuration file after first use. To prevent this, it is recommended to lock the configuration entry down by using [$ie].

=== KDE Startup Sequence -- what happens during startup ===

Login Manager: kdm
Startkde script: startkde starts kdeinit (which application?) and ksmserver (session manager) during the users login.
Kdeinit is used to start all other KDE programs.
Inititialised Background Services:
dcopserver (deamon for Desktop Communication Process/Protocol)
kded (generic KDE service daemon for background processes)
kcminit (Initialisation service for hardware)
klauncher (Program launch without interface, not the ALT-F2 dialog)
knotify (User notifications)
ksmserver (Session management, startup desktop components)
Desktop Components:
Kwin (Taskmanager)
KDesktop (Icons)
Kicker (Panel)
Klipper (Dienstprogramm für Zwischenablage)

=== DCOP, Desktop interprocess communication ===

can be used for all kinds of KDE desktop automatisation and scripting (also as command line tool)
based on Inter Client Exchange (ICE) Protocol and uses UNIX sockets instead of remote calls
can also be used to run KDE applications in GNOME desktop

== KIOSK Admin Tool Settings ==
...

Getting Started/Build/KDE4

2007-09-09T18:00:22Z

Logixoul: /* kdebase */ typo

{{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=[http://kdesvn-build.kde.org/ kdesvn-build: The KDE From Subversion Build Tool] [[../../Increased_Productivity_in_KDE4_with_Scripts|Increased Productivity in KDE4 with Scripts]] [[Development/Tutorials/CMake |Introduction to CMake]] [[../KDE4/FreeBSD|FreeBSD notes]] [[../KDE4/Mac OS X|Instructions for Mac OS X]] [[../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 [[/FreeBSD|FreeBSD]], [http://www.kdelibs.com/ Windows], [[/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.
}}

== 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, 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 part of kdesdk. You can install it as part of kdesdk (kdesdk-scripts on Debian) or similar package, or just download it itself from [http://websvn.kde.org/*checkout*/trunk/KDE/kdesdk/scripts/makeobj WebSVN]
* the [http://freedesktop.org/wiki/Software/shared-mime-info shared-mime-info package], which is the freedesktop MIME standard KDE is using now
* [http://boost.org/ boost], needed by kdebase; after compiling and/or installing boost, in order to make cmake aware about its location (FindBoost), add boost directory (the one containing include subdirectory) to CMAKE_INCLUDE_PATH or set an environment variable called BOOST_ROOT pointing to 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-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.

=== Kubuntu and Debian ===

In Kubuntu 7.04 (Feisty) and Debian (Testing/Unstable) the build dependencies you need are installed with:
<code bash>
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 libpng-dev subversion libsm-dev libxinerama-dev \
libxrender-dev libfontconfig-dev libboost-dev libxcursor-dev doxygen \
libungif4-dev libdbus-1-dev libgpgme11-dev libssl-dev libgpgme11-dev \
libasound2-dev kdesdk-scripts libpth-dev libjasper-dev ssh
</code>

In Kubuntu 7.10 (Gutsy) you have to add:
<code bash>
sudo aptitude install dbus-x11
</code>

For a fully functional API documentation framework you also need:
<code bash>
sudo aptitude install graphviz
</code>

=== 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)
strigi-devel (needed to build kdelibs)
gpgme-devel (needed to build kdepimlibs)
</code>

'''Optional Packages'''

You can skip the manual installation of Qt 4.3, CMake 2.4.6 and DBus by installing the adding the openSUSE Build Service KDE4 Repository 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 (and their dependencies):
<code>
cmake
dbus-1-devel
libqt4-devel
libqca2-devel (needed for building kdesupport)
</code>

And for fully functional apidox framework you also need:
<code>
graphviz
</code>

CMake binary packages for openSUSE are available from [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>

Optional:

If you decide not to use the KDE qt-copy, you need to keyword unmask Qt.

<code bash>
echo 'x11-libs/qt' >> /etc/portage/package.keywords
</code>

And now need to mask any Clucene versions above 0.9.16a.

<code bash>
echo '>dev-cpp/clucene-0.9.16a' >> /etc/portage/package.mask
</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
</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'
</code>

You will also need to emerge either 'kde-base/kdesdk' or kde-base/kdesdk-scripts'.

Optional:

If you decided to use Gentoo's version of Qt4, you can emerge it using the following command.

<code bash>
emerge -avu 'x11-libs/qt'
</code>

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 thread [http://forums.gentoo.org/viewtopic-t-530111-postdays-0-postorder-asc-start-0.html KDE 4 monolithic ebuilds].

== 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>

=== 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>

== 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, you can skip this step - {{path|/bin/sh}} is {{path|bash}} on Ark Linux.

=== 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

=== 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.

== 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 the Qt4 that is in KDE's source repository. KDE is guaranteed to build against any Qt 4.3. Qt 4.2 and earlier are not supported and will not work. You should use the copy in the KDE Subversion servers. (note: some distros, like Debian, tend to supply Qt with patches from KDE svn applied, so you may want to cheat and use precompiled Qt from your distro)

=== The Recipe ===
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 -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|If you have jumped to this section without reading [[Getting_Started/Build/KDE4#Setting_up_the_environment|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. Your environment '''needs''' to be set up correctly for these instructions to work for you.}}

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.16; version 0.9.17 does '''not''' work), and either libxml2 or libexpat.

=== The Recipe ===

cs # [[Getting_Started/Increased_Productivity_in_KDE4_with_Scripts/.bashrc|cs is not a typo]]
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 manualy into the kdesupport directory in ~ and execute the command cmakekde. if this still doesnt 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? 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 you 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>").

== 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 not a typo]]
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#Required_Software|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 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)

== 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 not a typo]]
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.
* if you get the error "cannot find -lpth" from /usr/bin/ld, then make sure you have The GNU Portable Threads (libpth-dev for Debian).

== 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 not a typo]]
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.

== 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 watch 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 not a typo]]
$KDE_SRC/KDE/kdelibs/doc/api/doxygen.sh \
--doxdatadir=$KDE_SRC/KDE/kdelibs/doc/common .

Repeat for other modules as desired. 
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>

== 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.

== 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]]

KDE System Administration/Configuration Files

2007-09-09T17:59:25Z

Logixoul: SysAdmin/Configuration Files moved to KDE System Administration/Configuration Files

{{Template:I18n/Language Navigation Bar|SysAdmin/Configuration Files}}
== File Format ==
KDE uses a simple text based file format for all its configuration files.
It consists of key-value pairs that are placed in groups. All KDE
configuration files use UTF-8 encoding for text outside the ASCII range.

The start of a group is indicated by a group name that is placed in
square brackets. All the key-value entries that follow belong to the group.
The group ends when either another group starts or when the end of the file
is reached.

Entries at the top of the file that are not preceded by a group name belong
to the default group.

==== Example: A Simple Config File ====
The following example shows a configuration file that consists of two groups.
The first group contains the keys "<tt>LargeCursor</tt>" and
"<tt>SingleClick</tt>", the second group contains the keys
"<tt>Show hidden files</tt>" and "<tt>Sort by</tt>".
<code ini>
[KDE]
LargeCursor=false
SingleClick=true

[KFileDialog Settings]
Show hidden files=false
Sort by=Name
</code>

Entries in a group consists of a key and value separated by an equal sign.
The key can contain spaces and may be followed by options placed in
square brackets.

The part after the equal sign is the value of the entry. Any white space
surrounding the equal sign is ignored, as is any trailing white space.

If a value is supposed to include a space at the begin or end then this can be achieved
by using a backslash followed by an 's'.

There are several other backslash codes, here is the complete list:

* "<tt>\s</tt>" can be used as space
* "<tt>\t</tt>" can be used to include a tab
* "<tt>\r</tt>" for a carriage return character
* "<tt>\n</tt>" for a linefeed character (new line)
* "<tt>\\</tt>" to include the backslash itself

==== Example: Whitespace ====
The following config file fragment is equivalent to the one in the
previous example. Whitespace surrounding the key and value is ignored.
<code ini>
[KDE]
LargeCursor= false
SingleClick = true

[KFileDialog Settings]
Show hidden files = false
Sort by =Name
</code>

==== Example: Preserving Whitespace ====
In the following example the value of the "<tt>Caption</tt>" entry starts
with two spaces while the "<tt>Description</tt>" entry contains three lines
of text. Linefeeds in backslash notation are used to seperate the different lines.
<code ini>
[Preview Image]
Caption=\s My Caption
Description=This is\na very long\ndescription.
</code>

Empty lines in configuration files are ignored, just as lines that
start with a hash mark '#'. The hash mark can be used to add comments to
configuration files but it should be noted that when a KDE application
updates a configuration file the comments are not
preserved.

== Configuration ==
There can be multiple configuration files with the same name in the
share/config sub-directory of the various
[[../KDE Filesystem Hierarchy#Location_of_the_Directory_Trees|KDE Directory Trees]].
In that case the information of all these configuration files is combined
on a key by key basis. If the same key within a certain group is defined
in more than one place, the key value read from the directory tree with
the highest precedence will be used.
Configuration files under $KDEHOME always have the highest precedence.
If a key in a certain group is defined multiple times in a single file, the
value of the last entry is used.

KDE's cascading configuration scheme can be used to provide users with
system or organisation wide default settings while still allowing the users
to make individual changes to these settings. KDE will not write entries to
the users configuration file under $KDEHOME that match any default settings
provided this way. This way changes made to the default settings will
immediately be propagated to the user. Note that differs from the traditional
way of providing default settings for users through the use of {{path|/etc/skel}},
changes to {{path|/etc/skel}} will only be propagated when creating a new user account.

When it is undesirable that individual users can make changes to default
settings, the default setting can be locked down.

== Shell Expansion ==

So called ''Shell Expansion'' can be used to provide more dynamic default
values. With shell expansion the value of a configuration key can be
constructed from the value of an environment variable or from the output of
a shell command.

To enable shell expansion for a configuration entry, the key must be followed
by <tt>[$e]</tt>. Normally the expanded form is written into the users
configuration file after first use. To prevent that, it is recommend to lock
the configuration entry down by using <tt>[$ie]</tt>.

==== Example: Dynamic Entries ====
In the following example the value for the "<tt>Host</tt>" entry
is determined by the output of the ''hostname'' program. This setting is
also locked down to ensure that the value is always determined dynamically.

The value for the "<tt>Email</tt>" entry is determined by filling in
the values of the $USER and $HOST environment variables. When ''joe''
is logged in on ''joes_host'' this will result in a value equal to
"<tt>joe@joes_host</tt>". The setting is not locked down.

<code ini>
[Mail Settings]
Host[$ie]=$(hostname)
Email[$e]=${USER}@${HOST}
</code>

== Localization ==

All configuration entries can be indexed with a language code. In this case,
the language that the user has selected for use on the desktop is used to
look up the key value. If the default language (American English) has been
selected or if there is no index that corresponds to the selected language,
the key entry without index is used.

==== Example: UTF8 In Keys ====
In the following example the value of the "<tt>Caption</tt>" entry
depends on the language. If the user has selected french as language (language
code <tt>fr</tt>) the value of the entry will be "<tt>Ma LÃ©gende</tt>".
In all other cases the value "<tt>My Caption</tt>" will be used.
<code ini>
[Preview Image]
Caption=My Caption
Caption[fr]=Ma LÃ©gende
</code>

== Lock Down ==

To prevent users from overriding default settings, you can lock
these settings down in the system-wide config files. Settings can be locked down individually, per group,
or per file. An individual entry can be locked down by adding <tt>[$i]</tt>
behind the key. A group of entries can be locked down by placing
<tt>[$i]</tt> behind the group name. To lock down the entire file, start
the file with <tt>[$i]</tt> on a single line.

==== Example: Using [$i] ====
In the following example the "<tt>Caption</tt>" entry has been locked
down. All entries in the "<tt>Mail Settings</tt>" group have been
locked down as well.
<code>
[Preview Image]
Caption[$i]=My Caption

[Mail Settings][$i]
Host[$e]=$(hostname)
Email=waldo@kde.org
</code>

If an entry has been locked down, entries that would otherwise take
precedence over the default setting will now be ignored.

Any changes that applications make to settings that have been locked
down will be silently dropped. Applications may respond differently to locked down settings. Some applications
recognize when a setting has been locked down, and will remove the
elements from its user interface that would otherwise allow the user
to make changes to these settings. Other applications will continue
to offer these options in their user interface even though the option
does not have any effect any more. It is also possible that it is actually
still possible to change the setting in the running program. In that case the
changed setting will be effective for the time the program remains running.
When the program is restarted it will then return to the locked down default
settings.

== Editors ==
If you do not want to use a text editor then
[http://extragear.kde.org/apps/kconfigeditor/ KConfigEditor]
offers a convenient way to edit KDE configuration files.

For scripts or modifying files from the command line, the command line app <tt>kwriteconfig</tt> is very useful. <tt>kwriteconfig</tt> expects a configuration file name, a group, a key, an optional type and a value, such as:

<code>kwriteconfig --file kickerrc \
--group General \
--key AutoHidePanel \
--type bool \
true</code>

Talk:KDE System Administration/Configuration Files

2007-09-09T17:59:25Z

Logixoul: Talk:SysAdmin/Configuration Files moved to Talk:KDE System Administration/Configuration Files

I believe the example for localization doesn't actually use UTF-8. The French translation of "My Caption" shows up garbled; 'LÃ©gende'. I'm not sure what to fix it to however. --[[User:Mpyne|Mpyne]] 02:57, 27 February 2007 (CET)

SysAdmin/Configuration Files

2007-09-09T17:59:25Z

Logixoul: SysAdmin/Configuration Files moved to KDE System Administration/Configuration Files

#REDIRECT [[KDE System Administration/Configuration Files]]

Talk:SysAdmin/Configuration Files

2007-09-09T17:59:25Z

Logixoul: Talk:SysAdmin/Configuration Files moved to Talk:KDE System Administration/Configuration Files

#REDIRECT [[Talk:KDE System Administration/Configuration Files]]

KDE System Administration (fr)

2007-09-09T17:58:04Z

Logixoul: fix double redirect

{{Template:I18n/Language Navigation Bar|SysAdmin}}
Cette section fournit aux administrateurs système l'information nécessaire au bon déroulement du déploiement de KDE au sein de leur organisation.

== Système de Fichier ==
;[[KDE System Administration/Configuration Files|Syntaxe des fichier de configuration]]
:''Les fichiers de configuration de KDE sont au format texte brut. Ils contiennent des groupes de paires clé-valeur. Cette section explique leur syntaxe. Cela couvre :''
* la gestion des langues
* les variables shell
* le vérouillage complet ou partiel des fichiers de configuration
* les utilitaires d'édition
* d'autres fonctionalités avancées

;[[KDE System Administration/KDE Filesystem Hierarchy|Arborescence de KDE]]
:''Cet article décrit la façon dont KDE utilise le système de fichier, où il recherche les fichiers et où il les stocke. L'article explique comment changer ces endroits. On trouvera aussi une brève vue d'ensemble des réglages par défaut utilisé par les grands distributeurs de systèmes d'exploitation.''

== Lancement du Bureau ==

;[[KDE System Administration/Environment Variables|Environment Variables]]
:''Un ensemble de variables d'environnement décrites dans cet article sont disponibles pour régler certains aspects de KDE et le comportement pendant leur lancement des applications KDE.''

;[[KDE System Administration/Startup|Séquence de démarrage du bureau KDE]]
:''Pendant son démarrage KDE lance les composants visibles du bureau ainsi que différents services tournant en tache de fond. Cet article décrit la séquence de démarrage, donne une vue générale des services démarrés et explique comment modifier ceci.''

;[http://docs.kde.org/development/en/kdebase/kdm/ Gestionnaire de Connexion]
:''Le Gestionnaire Graphique de KDE (KDE Display Manager - KDM) fournit les services classiquement associés à un gestionnaire de connexion. Le premier contact que les utilisateurs auront avec KDE est typiquement l'écran de login de KDE. Cette section couvre les bases pour mettre en place KDM, plus certains sujets avancés comme la connexion à distance, la connexion automatique entre autres choses.''

== Profils de groupes et d'utilisateurs ==

;[[KDE System Administration/Kiosk/Introduction|Introduction à Kiosk]]
:''L'infrastructure Kiosk fournit un ensemble de fonctionnalités pour définir et restreindre facilement les caractéristiques d'un environnement KDE basé sur les droits d'accès de groupes et d'utilisateurs. En plus d'une introduction générale, cet article couvre l'ensemble des paramètres de configuration vérouillables, les restrictions d'action et de ressource, l'association de profils utilisateurs et de groupes, parmi d'autres choses.''

;[[KDE System Administration/Kiosk/Keys|Liste des clés applicables pour l'utilisation de Kiosk]]
:''Ce document détaille l'ensemble clés globales et spécifiques prédéfinies applicables à certaines applications pour les restrictions d'actions, de ressources et de liens internet faisant de ce guide une référence pour paramètrer des profils Kiosk.''

;[[KDE System Administration/Kiosk/Resources|Ressources supplémentaires]]
:''Liens vers des outils, listes de diffusion et documentation supplémentaire à propos les profils d'utilisateurs et de groupes dans KDE.''

== Outils ==

;[http://extragear.kde.org/apps/kiosktool/ KioskTool]
:''Une application graphique pour gérer les profils d'utilisateurs et de groupes de KDE Kiosk.''

;[http://docs.kde.org/development/en/kdenetwork/krfb/ Le bureau partagé]

:''La fonctionnalité de bureau partagé permet de partager votre hureau à distance avec d'autres utilisateurs. Parmi de nombreuses autres applications, cette fonctionnalité est une grande avancée pour les équipes de support qui donnent une assistance téléphonique aux utilisateurs.''

;[[Development/Tutorials/Shell_Scripting_with_KDE_Dialogs|Utiliser les boites de dialogue KDE dans des scripts shell]]
:''Il est possible d'utiliser des scripts shell utilisant KDialog pour afficher diverses boites de dialogue KDE. Cela offre une intégration sans précédent de vos propres améliorations de l'interface graphique.''

Welcome to KDE TechBase

2007-09-09T17:56:26Z

Logixoul: fix double redirect

{{Template:I18n/Language Navigation Bar|Welcome to KDE TechBase}}
{| style="margin: 1em 2.5% 0 2.5%; padding: 0 5px;" cellpadding="5"
|-
|colspan=2|[[Image:Discover.png|noframe]]
|-
| style="padding-left: 50px;" |[[Image:Action_launch.svg|noframe|left|40px]] ||
;[[Getting Started|Setting up a KDE development environment]]
:Learn how to get, build and run KDE and its applications.
|-
| style="padding-left: 50px;"|[[Image:Action_configure.svg|noframe|left|40px]] ||
;[[Development|Developing with KDE]]
:[[Development/Tutorials|Tutorials]] | [http://api.kde.org API Documentation] | [[Development/FAQs|FAQs]] and more.
:''Related'': [[Schedules|Release Schedules and Feature Plans]]
|-
| style="padding-left: 50px;"|[[Image:Devices_system.svg|noframe|left|40px]] ||
;[[KDE System Administration]]
:Information for system administrators managing KDE deployments.
|-
|colspan=2|[[Image:Interact.png|noframe]]
|-
| style="padding-left: 50px;"|[[Image:Action_favorites.svg|noframe|left|40px]] ||
;[[Contribute|Join the KDE Team and Contribute]]
:Contribute patches, keep in touch with and join our community.
:''Related:'' [[Policies|KDE Project Policies]] | [http://www.kde.org/support/support.php Donate Money]
|-
| style="padding-left: 50px;"|[[Image:Action_contents.svg|noframe|left|40px]] ||
;[[ISV|ISV Information]]
:Developer information for Independent Software Vendors.
|-
|colspan=2|[[Image:Develop.png|noframe]]
|-
| style="padding-left: 50px;" |[[Image:Action_wizard.svg|noframe|left|40px]] ||
;[[Projects|KDE projects]]
:Links to development wikis, task lists, etc. for various KDE Projects.

|}

Talk:Welcome to KDE TechBase

2007-09-09T17:55:44Z

Logixoul: fix double redirect

==Sys Admin Area==
I've created the start of a basic Sys Admin area, which is essentially taken from the existing [http://www.kde.org/areas/sysadmin/ KDE sysadmin] pages. Everyone seems to agree that the current location is a poor choice. I spent some time today doing up a mind map of the information there and broke out the new [[KDE System Administration|sys admin]] page on this wiki along those lines.

However, before I get too far along the trail, I'd like to confirm with others that this is a desired development. I'm also interested in feedback on the entries I made on the new [[KDE System Administration|sys admin]] page. --[[User:Aseigo|Aseigo]] 00:44, 30 January 2007 (CET)

:I do like it, but granted, I'm only the sysadmin of my own installations :) --[[User:Dhaumann|Dhaumann]] 09:10, 30 January 2007 (CET)

::I indeed like it. We should put all the pages into a SysAdmin category or something similar.
::Btw, I even think we should tag all articles with KDE3 and/or KDE4. For example all tutorials which right now are implicit for KDE4 should still be tagged as such. Then, they also consequently appear in "Allpages > KDE4". --[[User:Dhaumann|Dhaumann]] 01:50, 3 February 2007 (CET)

==License==
I suggest we move to [http://creativecommons.org/licenses/by-sa/2.5/ cc-by-sa] right from the beginning. Please see the [http://people.debian.org/~srivasta/Position_Statement.xhtml Draft Debian Position Statement About The GNU Free Documentation License(GFDL)]. [[User:Logixoul|Logixoul]] 14:10, 8 September 2006 (CEST)

:Or dual license, keep GFDL and use CC. (There was some discussion about this on Wikipedia iirc) [[User:CuCullin|CuCullin]] 19:31, 9 January 2007 (CET)

:Dual license seems sanest to me as well. I'd also suggest just cc-sa. I'm not sure what we would expect/hope to win with attribution requirements? Especially since the authorship will be large... --[[User:Aseigo|Aseigo]] 00:44, 30 January 2007 (CET)

::Maybe we should display the license(s) in the footer, something like "... | Legal | <here comes the license>" --[[User:Dhaumann|Dhaumann]] 01:50, 3 February 2007 (CET)

== Oxygen theme ==

I really like the Oxygen theme on this wiki, but might we reconsider the fixed width bit? It makes some of the pages (e.g. recent changes) not work as well, wrapping lines and making them difficult to read. --[[User:Axiom|Axiom]] 20:50, 14 January 2007 (CET)

: We have had this discussion over and over again but at the same time we got very positive feedback (e.g. on the kde-www mailing list). Changing the layout is very unlikely. I agree that due to our use of subpages the urls get long and a bit unreadable, but that's hardly a reason to change the layout of all *kde.org pages. --[[User:Dhaumann|Dhaumann]] 23:49, 14 January 2007 (CET)

:: You can configure which skin is used in your preferences. A "Full width Oxygen" skin would be nice. --[[User:Argonel|Argonel]] 04:44, 18 January 2007 (CET)

== Something wrong with the CAPTCHAs ==

Every time I make an edit, it says I am trying to add a url, even when I am not. Perhaps I will get better a simple math, but they are slightly annoying. --[[User:Axiom|Axiom]] 19:51, 21 January 2007 (CET)

:Ping danimo about this issue. I had the same problem even after I registered. He had to nudge my account properly to make it work. --[[User:Aseigo|Aseigo]] 00:44, 30 January 2007 (CET)

Development/Architecture

2007-09-09T17:54:23Z

Logixoul: fix double redirect

{{Template:I18n/Language Navigation Bar|Development/Architecture}}
The following pages contain documentation about KDE's design and architecture in detail. They do not replace other documentation like [http://api.kde.org API documentation], [[../Tutorials|tutorials/howtos]] and [[../Guidelines|standards]], see the [[Development|development portal]] for further information.

For a better understanding it might help to be familiar with Trolltech's™ excellent [http://doc.trolltech.com/3.3/index.html Qt 3.3] or [http://doc.trolltech.com/4.3/index.html Qt 4.3] documentation and their [http://www.trolltech.com/developer/ Developer Pages].

More information about a KDE installation itself is available in the dedicated section for [[KDE System Administration|system administrators]].

== Design Documents ==
; [[/KDE4|KDE 4 Architecture Overview]]
: An overview of the KDE 4 architecture, including discussions of common techniques, library classes, and general development issues. This is for ''KDE 4.0''.

; [[/KDE3|KDE 3 Architecture Overview]] [http://developer.kde.org/documentation/library/kdeqt/kde3arch/ (Original)]
: An overview of the KDE 3 architecture, including discussions of common techniques, library classes, and general development issues. This is for ''KDE 3.0''.

; [http://developer.kde.org/documentation/library/kdeqt/kde2arch/ KDE 2 Architecture Overview]
: An overview of the KDE 2 architecture, similar to the above. This is for ''KDE 2.2''.

; [[/DCOP|DCOP]]
: Design documents from 1999-2000.

[[Category:Architecture]]

Help:Wiki Structure

2007-09-09T17:49:04Z

Logixoul: fix double redirect

This page explains the methods used to maintain KDE's developer wiki.

== Top pages ==
The most important pages on this wiki are the top or root pages (in alphabetical order):

;[[Contribute]]
;[[Development]]
:[[Development/Architecture]]
:[[Development/FAQs]]
:[[Development/Further Information]]
:[[Development/Guidelines]]
:[[Development/Languages]]
:[[Development/Tools]]
:[[Development/Tutorials]]
;[[Getting Started]]
;[[ISV]]
;[[Policies]]
;[[Projects]]
;[[Schedules]]
;[[KDE System Administration]]

All other pages/articles belong to one of those pages (or their sub-pages) which means we heavily use sub-pages to maintain the structure and a hierarchy to not loose the overview.

=== Sub-pages ===
A sub-page is a parent-child relation. In the following example '''Development''' is the ''parent'' of '''Tutorials''', or the other way round: The page '''Tutorials''' is a sub-page (or a child) of '''Development'''

[[Development/Tutorials]]

Using sub-pages has several advantages
* they automatically provide us with a '''hierarchy''' which is reflected in the URL itself
* automatically generated ''backlinks'' provide easy navigation

As an example, look at the page
[[Development/Architecture/KDE3/Library Structure]]
you can see following the links on the very top of the page:
< [[Development]] | [[Development/Architecture|Architecture]] | [[Development/Architecture/KDE3|KDE3]]

== Categories ==
In short, a [http://meta.wikimedia.org/wiki/Help:Category category] is a '''tag''' which appears at the very bottom of an article. As such, categories provide automatic indexes that are useful as tables of contents. Together with links and templates they help to structure a project.

* [[Special:Categories|List of categories]]
* [[Special:Unusedcategories|List of unused categories]] - Feel free to use them

Be sure to read the category page (e.g. [[:Category:Documentation]]) before tagging a page with it to make sure you're using it correctly.

== Important special pages ==
There are several special pages which help us to maintain a clean wiki:

; Issues which should be fixed as soon as possible
:[[Special:Lonelypages]]
:[[Special:BrokenRedirects]]
:[[Special:DoubleRedirects]]

; Issues which should be fixed in time
:[[Special:Wantedpages]]
:[[Special:Wantedcategories]]

[[Category:Policies]]

KDE System Administration

2007-09-09T17:47:51Z

Logixoul: SysAdmin moved to KDE System Administration: sync name, un-lame-ifying it

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

This section provides system administrators who are rolling out new or managing existing KDE deployments in their organization with the information they need to do so effectively.

== File System ==
;[[/Configuration Files|Configuration File Syntax]]
:''KDE configuration files are text-based. They contain groups of key-value pairs. This section explains their syntax. It covers:''
* localisation,
* shell-variables,
* complete or partial lock-down of configuration files,
* editor utilities,
* other advanced features.


;[[/KDE Filesystem Hierarchy|KDE Hierarchy]]
:''This article describes how KDE uses the filesystem, where it looks for files and where it stores them. It explains how to change these locations. There is also a brief overview of the default settings used by major OS vendors.''

;[[/XDG Filesystem Hierarchy|XDG Hierarchy]]
:''Supplementing the [[/KDE Filesystem Hierarchy|KDE filesystem hierarchy]], KDE also uses various directories, as defined by XDG specifications on [http://freedesktop.org freedesktop.org]. This article documents the paths used and their purposes.''

== Desktop Sessions ==

;[[/Environment Variables|Environment Variables]]
:''A variety of environment variables documented in this article are available to influence aspects of KDE and the runtime behavior of KDE applications.''

;[[/Startup|Desktop Startup Sequence]]
:''During startup KDE starts the visible desktop components as well as several services that run in the background. This article describes the startup sequence, gives an overview of some of the services started and explains how to make changes.''

;[http://docs.kde.org/development/en/kdebase/kdm/ Login Manager]
:''The KDE Display Manager (KDM) provides the services commonly associated with a login manager. The first contact your users have with a KDE system is usually the KDM login screen. This section covers the basics of how setting up KDM, plus advanced topics such as remote login, automatic login, and more.''

== User & Group Profiles ==

;[[/Kiosk/Introduction|Introduction to Kiosk]]
:''The Kiosk framework provides a set of features that makes it possible to easily and powerfully define and restrict the capabilities of a KDE environment based on user and group credentials. In addition to an introductory overview, this article covers configuration setting lock down, action and resource restrictions, assigning profiles to users and groups and more.''

;[[/Kiosk/Keys|Kiosk Keys]]
:''This document details known global and application specific kiosk keys for action, resource and url restrictions making it a handy reference guide when setting up a Kiosk profile.''

;[[/Kiosk/Resources|Additional Resources]]
:''Links to tools, mailing lists and additional documentation relevant to user and group profiles in KDE.''

== Tools ==

;[http://extragear.kde.org/apps/kiosktool/ KioskTool]
:''A graphical application that helps manage KDE Kiosk user and group profiles.''

;[http://docs.kde.org/development/en/kdenetwork/krfb/ Desktop Sharing]
:''The KDE Desktop Sharing capabilities make it possible to share your desktop remotely with others. Alongside numerous other uses, this feature is a great enabler for support staff who give direct assistance to users calling them.''

;[[Development/Tutorials/Shell_Scripting_with_KDE_Dialogs|Using KDE Dialogs in Shell Scripts]]
:''You can use KDialog shell scripts to show various KDE dialogs. This gives you seamless integration of your own custom GUI enhancements.''

;[[SysAdmin/Controlling_Access_To_Get_New_Stuff|Controlling Access to Content Provided By Get New Stuff]]
:''Give information on how to control content downloaded from the Internet by the Get New Stuff feature of KDE.''

SysAdmin

2007-09-09T17:47:51Z

Logixoul: SysAdmin moved to KDE System Administration: sync name, un-lame-ifying it

#REDIRECT [[KDE System Administration]]

Welcome to KDE TechBase

2007-09-09T17:38:32Z

Logixoul: self aggrandizing much?

{{Template:I18n/Language Navigation Bar|Welcome to KDE TechBase}}
{| style="margin: 1em 2.5% 0 2.5%; padding: 0 5px;" cellpadding="5"
|-
|colspan=2|[[Image:Discover.png|noframe]]
|-
| style="padding-left: 50px;" |[[Image:Action_launch.svg|noframe|left|40px]] ||
;[[Getting Started|Setting up a KDE development environment]]
:Learn how to get, build and run KDE and its applications.
|-
| style="padding-left: 50px;"|[[Image:Action_configure.svg|noframe|left|40px]] ||
;[[Development|Developing with KDE]]
:[[Development/Tutorials|Tutorials]] | [http://api.kde.org API Documentation] | [[Development/FAQs|FAQs]] and more.
:''Related'': [[Schedules|Release Schedules and Feature Plans]]
|-
| style="padding-left: 50px;"|[[Image:Devices_system.svg|noframe|left|40px]] ||
;[[SysAdmin|KDE System Administration]]
:Information for system administrators managing KDE deployments.
|-
|colspan=2|[[Image:Interact.png|noframe]]
|-
| style="padding-left: 50px;"|[[Image:Action_favorites.svg|noframe|left|40px]] ||
;[[Contribute|Join the KDE Team and Contribute]]
:Contribute patches, keep in touch with and join our community.
:''Related:'' [[Policies|KDE Project Policies]] | [http://www.kde.org/support/support.php Donate Money]
|-
| style="padding-left: 50px;"|[[Image:Action_contents.svg|noframe|left|40px]] ||
;[[ISV|ISV Information]]
:Developer information for Independent Software Vendors.
|-
|colspan=2|[[Image:Develop.png|noframe]]
|-
| style="padding-left: 50px;" |[[Image:Action_wizard.svg|noframe|left|40px]] ||
;[[Projects|KDE projects]]
:Links to development wikis, task lists, etc. for various KDE Projects.

|}

Welcome to KDE TechBase

2007-09-09T17:30:54Z

Logixoul: typo

{{Template:I18n/Language Navigation Bar|Welcome to KDE TechBase}}
{| style="margin: 1em 2.5% 0 2.5%; padding: 0 5px;" cellpadding="5"
|-
|colspan=2|[[Image:Discover.png|noframe]]
|-
| style="padding-left: 50px;" |[[Image:Action_launch.svg|noframe|left|40px]] ||
;[[Getting Started|Setting up a KDE development environment]]
:Learn how to get, build and run KDE and its applications.
|-
| style="padding-left: 50px;"|[[Image:Action_configure.svg|noframe|left|40px]] ||
;[[Development|Developing with KDE]]
:[[Development/Tutorials|Tutorials]] | [http://api.kde.org API Documentation] | [[Development/FAQs|FAQs]] and more.
:''Related'': [[Schedules|Release Schedules and Feature Plans]]
|-
| style="padding-left: 50px;"|[[Image:Devices_system.svg|noframe|left|40px]] ||
;[[SysAdmin|KDE System Administration]]
:Information for system administrators managing KDE deployments.
|-
|colspan=2|[[Image:Interact.png|noframe]]
|-
| style="padding-left: 50px;"|[[Image:Action_favorites.svg|noframe|left|40px]] ||
;[[Contribute|Join the KDE Team and Contribute]]
:Contribute patches, keep in touch with and join one of the best open source communities around.
:''Related:'' [[Policies|KDE Project Policies]] | [http://www.kde.org/support/support.php Donate Money]
|-
| style="padding-left: 50px;"|[[Image:Action_contents.svg|noframe|left|40px]] ||
;[[ISV|ISV Information]]
:Developer information for Independent Software Vendors.
|-
|colspan=2|[[Image:Develop.png|noframe]]
|-
| style="padding-left: 50px;" |[[Image:Action_wizard.svg|noframe|left|40px]] ||
;[[Projects|KDE projects]]
:Links to development wikis, task lists, etc. for various KDE Projects.

|}

Welcome to KDE TechBase

2007-09-09T17:30:40Z

Logixoul: sync name and make it less pretentious at the same time

{{Template:I18n/Language Navigation Bar|Welcome to KDE TechBase}}
{| style="margin: 1em 2.5% 0 2.5%; padding: 0 5px;" cellpadding="5"
|-
|colspan=2|[[Image:Discover.png|noframe]]
|-
| style="padding-left: 50px;" |[[Image:Action_launch.svg|noframe|left|40px]] ||
;[[Getting Started|Setting up a KDE development environment]]
:Learn how to get, build and run KDE and its applications.
|-
| style="padding-left: 50px;"|[[Image:Action_configure.svg|noframe|left|40px]] ||
;[[Development|Developing with KDE]]
:[[Development/Tutorials|Tutorials]] | [http://api.kde.org API Documentation] | [[Development/FAQs|FAQs]] and more.
:''Related'': [[Schedules|Release Schedules and Feature Plans]]
|-
| style="padding-left: 50px;"|[[Image:Devices_system.svg|noframe|left|40px]] ||
;[[SysAdmin|KDE System Administration]]
:Information for system administrators managing KDE deployments.
|-
|colspan=2|[[Image:Interact.png|noframe]]
|-
| style="padding-left: 50px;"|[[Image:Action_favorites.svg|noframe|left|40px]] ||
;[[Contribute|Join the KDE Team and Contribute]]
:Contribute patches, keep in touch with and join one of the best open source communities around.
:''Related:'' [[Policies|KDE Project Policies]] | [http://www.kde.org/support/support.php WDonate Money]
|-
| style="padding-left: 50px;"|[[Image:Action_contents.svg|noframe|left|40px]] ||
;[[ISV|ISV Information]]
:Developer information for Independent Software Vendors.
|-
|colspan=2|[[Image:Develop.png|noframe]]
|-
| style="padding-left: 50px;" |[[Image:Action_wizard.svg|noframe|left|40px]] ||
;[[Projects|KDE projects]]
:Links to development wikis, task lists, etc. for various KDE Projects.

|}

Getting Started/Sources/Anonymous SVN

2007-09-09T17:20:50Z

Logixoul: trim and clarify

{{Template:I18n/Language Navigation Bar|Getting Started/Sources/Anonymous SVN}}
{{TutorialBrowser|

series=Getting Started|

name=Getting KDE Sources Using Anonymous Subversion (SVN)|

next=[[../../Build/KDE4|Building KDE4]]|

reading=[http://svnbook.red-bean.com/ Version Control with Subversion]|
}}

== Abstract ==

For those of us that like to stay on the "bleeding edge" there's an easy way to keep a local copy of the KDE sources up-to-date. No more trying to log on to ftp.kde.org to get the latest snapshot. No more wandering aimlessly through mirrors looking for one that's up to date. Just a simple command line operation to get up-to-the-minute source updates: anonymous SVN.

Please note that several Linux distributions now already provide KDE SVN packages, so '''building Qt and KDE from source may well not be necessary for you at all! '''See [[Getting_Started/Distribution_Packages]] for instructions and information.

== Anonymous SVN ==

=== Setup Subversion ===

First, install the subversion (svn) binary if it isn't already on your computer. Your operating system should have a package for it. Alternatively you can download and compile it yourself via the [http://subversion.tigris.org/project_packages.html svn project download page]. Please read the [[Getting_Started/Sources/Using_Subversion_with_KDE|KDE Subversion tutorial]] if you are interested in how to use Subversion.

=== Checkout KDE ===

'''/trunk/''' is where the Qt4-based KDE 4 is being developed. The following is the minimal set of modules you will need to check out to build KDE and KDE software:

svn co svn://anonsvn.kde.org/home/kde/trunk/KDE/kdelibs
svn co svn://anonsvn.kde.org/home/kde/trunk/KDE/kdebase

{{tip|Only use "'''svn co'''" for the initial checkout, you will update your local sources afterwards by using "'''svn up''' ''modulename''" or "'''svn update''' ''modulename''".}}

{{tip|If your firewall doesn't allow access to arbitrary ports, substitute '''svn://anonsvn.kde.org/''' with '''svn://websvn.kde.org:443/''' above.}}

'''qt-copy''' is a copy of the latest stable [http://www.trolltech.com Qt] release which works with KDE, put into SVN for convenience. It also contains patches by KDE developers that haven't found their way to Qt yet. They are recommended for those working with KDE from '''trunk'''. You can obtain '''qt-copy''' by doing:

svn co svn://anonsvn.kde.org/home/kde/trunk/qt-copy

If you wish to have a complete copy of the KDE distribution, you can simply check out the entire source tree with one command:

svn co svn://anonsvn.kde.org/home/kde/trunk/KDE

{{note|It is smarter to first use [http://websvn.kde.org/trunk/KDE The KDE Source Repository Web Viewer]. Use it to choose which modules to download. This way KDE will be quicker to install and try out.}}

If you want additional software packages you can check out the following modules within '''trunk/''' as well:

koffice
extragear
playground
kdereview

So, for example, if you want to check out koffice trunk, you can use

svn co svn://anonsvn.kde.org/home/kde/trunk/koffice

=== Checking out trunk using snapshots ===

If you are checking out modules from '''trunk/''' you may be able to save time by using snapshots. Using Subversion trunk snapshots is described at [[../Snapshots|the Subversion snapshots tutorial page]].

=== Checking out KDE 3 instead ===

If you want to track KDE 3 rather than the bleeding edge, you may retrieve the KDE 3.5 sources using:

svn co svn://anonsvn.kde.org/home/kde/branches/arts/1.5/arts
svn co svn://anonsvn.kde.org/home/kde/branches/KDE/3.5/

And if you want the matching qt-copy:
svn co svn://anonsvn.kde.org/home/kde/branches/qt/3.3/qt-copy

=== Checking out specific releases ===

KDE modules are also tagged at each release so that it is possible to get a specific release of KDE. Most KDE modules have a tag name in the format '''tags/KDE/X.Y.Z''' (where X, Y and Z represent the exact version). The arts module (only needed for KDE 2 and KDE 3) has a different format of tag name, '''tags/arts/X.Y.Z'''. For instance to get kdelibs as it was shipped in KDE 3.5.0, do:

svn co svn://anonsvn.kde.org/home/kde/tags/KDE/3.5.0/kdelibs/

If you then want to update this checkout to KDE 3.5.5, use this command:

svn switch svn://anonsvn.kde.org/home/kde/tags/KDE/3.5.5/kdelibs

{{tip|If you used a '''/branch/''' or '''/trunk/''' path, then there is no need to switch, just run '''svn update'''.}}

{{tip|[http://websvn.kde.org/tags/ WebSVN] is a convenient way to check for a tag name.}}

=== Checking out translations ===
If you are looking for translations and other localizations, check out the appropriate language from the [http://websvn.kde.org/trunk/l10n l10n] module.

{{Warning|The l10n module is ''extremely'' large. Be sure you have lots of time and disk space on hand before checking out the entire l10n module. Most people only check out specific language subdirectories rather than the entire l10n module.}}

You are now ready to start building KDE! Visit [[Getting_Started/Build/KDE4|this page]] for instructions on building trunk or [[Getting_Started/Build/Stable_Version|this page]] for instruction on compiling the last stable release.

== Also of interest ==
* anonsvn.kde.org is located in Tuebingen, Germany, maintained by [mailto:dirk@kde.org Dirk Mueller] However, a more local mirror could be faster for you than anonsvn.kde.org itself. Current mirrors are, sorted by performance:
** kde.mneisen.org is located near Nuernberg, Germany, maintained by [mailto:martin.eisenhardt@mneisen.org Martin Eisenhardt]
** www.englishbreakfastnetwork.org also hosts an anonymous SVN mirror, at the University of Nijmegen, Netherlands. Maintained by [mailto:groot@kde.org Adriaan de Groot]
** svn://azkaban.caltech.edu is located near Los Angeles, USA and is maintained by [mailto:eugen.plamadeala@gmail.com Eugeniu Plamadeala]. It has the same folder hierarchy as anonsvn.kde.org.
: Be careful when switching between mirrors. SVN remembers the server in the working copy, so to switch you have to run
svn switch --relocate svn://anonsvn.kde.org/ svn://kde.mneisen.org/
: in all your checkouts.
If you're interested in setting up a svn mirror, please contact [mailto:mueller@kde.org Dirk Mueller].

[[Category:Build KDE]]

Getting Started/Sources/Anonymous SVN

2007-09-09T17:05:12Z

Logixoul: kdesvn-build is already mentioned on the Build KDE4 page

{{Template:I18n/Language Navigation Bar|Getting Started/Sources/Anonymous SVN}}
{{TutorialBrowser|

series=Getting Started|

name=Getting KDE Sources Using Anonymous Subversion (SVN)|

next=[[../../Build/KDE4|Building KDE4]]|

reading=[http://svnbook.red-bean.com/ Version Control with Subversion]|
}}

== Abstract ==

For those of us that like to stay on the "bleeding edge" there's an easy way to keep a local copy of the KDE sources up-to-date. No more trying to log on to ftp.kde.org to get the latest snapshot. No more wandering aimlessly through mirrors looking for one that's up to date. Just a simple command line operation to get up-to-the-minute source updates: anonymous SVN.

Please note that several Linux distributions now already provide KDE SVN packages, so '''building Qt and KDE from source may well not be necessary for you at all! '''See [[Getting_Started/Distribution_Packages]] for instructions and information.

== Anonymous SVN ==

Using anonymous SVN is simple:

=== Setup Subversion ===

First, install the subversion (svn) binary if it isn't already on your computer. Your operating system should have a package for it. Alternatively you can download and compile it yourself via the [http://subversion.tigris.org/project_packages.html svn project download page]. Please read the [[Getting_Started/Sources/Using_Subversion_with_KDE|KDE Subversion tutorial]] if you are interested in how to use Subversion.

=== Checkout KDE ===

'''/home/kde/trunk/''' (often refered to as '''trunk''', for short) is where the Qt4-based KDE 4 is being developed. The following is the minimal set of modules you will need to check out to build KDE and KDE software:

svn co svn://anonsvn.kde.org/home/kde/trunk/KDE/kdelibs
svn co svn://anonsvn.kde.org/home/kde/trunk/KDE/kdebase

{{tip|Only use "'''svn co'''" or "'''svn checkout'''" for the initial checkout, you will update your local sources afterwards by using "'''svn up''' ''modulename''" or "'''svn update''' ''modulename''".}}

{{tip|If your firewall doesn't allow access to arbitrary ports, substitute '''svn://anonsvn.kde.org/''' with '''svn://websvn.kde.org:443/''' above.}}

'''qt-copy''' is a copy of the latest stable [http://www.trolltech.com Qt] release which works with KDE, put into SVN for convenience. It also contains additional patches that fix bugs or add enhancements KDE makes use of and is therefore recommended for those working with KDE from '''trunk'''. You can obtain '''qt-copy''' by doing:

svn co svn://anonsvn.kde.org/home/kde/trunk/qt-copy

If you wish to have a complete copy of the KDE distribution, you can simply check out the entire source tree with one command:

svn co svn://anonsvn.kde.org/home/kde/trunk/KDE

'''Be aware this is a lot of source code to download'''. The server may demote priority for such large svn requests. Depending on server load, checkout of the entire source tree could grind to a virtual halt part-way through the job.

{{note|It is smarter to first use [http://websvn.kde.org/trunk/KDE The KDE Source Repository Web Viewer]. Use it to choose which modules to download. This way KDE will be quicker to install and try out.}}

If you want additional software packages you can check out the following modules within '''trunk/''' as well:

koffice
extragear
playground
kdereview

So, for example, if you want to check out koffice trunk, you can use

svn co svn://anonsvn.kde.org/home/kde/trunk/koffice

=== Checking out trunk using snapshots ===

If you are checking out modules from '''trunk/''' you may be able to save time by using snapshots. Using Subversion trunk snapshots is described at [[../Snapshots|the Subversion snapshots tutorial page]].

=== Checking out KDE 3 instead ===

If you want to track KDE 3 rather than the bleeding edge, you may retrieve the KDE 3.5 sources using:

svn co svn://anonsvn.kde.org/home/kde/branches/arts/1.5/arts
svn co svn://anonsvn.kde.org/home/kde/branches/KDE/3.5/

And if you want the matching qt-copy:
svn co svn://anonsvn.kde.org/home/kde/branches/qt/3.3/qt-copy

=== Checking out specific releases ===

KDE modules are also tagged at each release so that it is possible to get a specific release of KDE. Most KDE modules have a tag name in the format '''tags/KDE/X.Y.Z''' (where X, Y and Z represent the exact version). The arts module (only needed for KDE 2 and KDE 3) has a different format of tag name, '''tags/arts/X.Y.Z'''. For instance to get kdelibs as it was shipped in KDE 3.5.0, do:

svn co svn://anonsvn.kde.org/home/kde/tags/KDE/3.5.0/kdelibs/

If you then want to update this checkout to KDE 3.5.5, use this command:

svn switch svn://anonsvn.kde.org/home/kde/tags/KDE/3.5.5/kdelibs

{{tip|If you used a '''/branch/''' or '''/trunk/''' path, then there is no need to switch, just run '''svn update'''.}}

{{tip|[http://websvn.kde.org/tags/ WebSVN] is a convenient way to check for a tag name.}}

=== Checking out translations ===
If you are looking for translations and other localizations, check out the appropriate language from the [http://websvn.kde.org/trunk/l10n l10n] module.

{{Warning|The l10n module is ''extremely'' large. Be sure you have lots of time and disk space on hand before checking out the entire l10n module. Most people only check out specific language subdirectories rather than the entire l10n module.}}

You are now ready to start building KDE! Visit [[Getting_Started/Build/KDE4|this page]] for instructions on building trunk or [[Getting_Started/Build/Stable_Version|this page]] for instruction on compiling the last stable release.

== Also of interest ==
* anonsvn.kde.org is located in Tuebingen, Germany, maintained by [mailto:dirk@kde.org Dirk Mueller] However, a more local mirror could be faster for you than anonsvn.kde.org itself. Current mirrors are, sorted by performance:
** kde.mneisen.org is located near Nuernberg, Germany, maintained by [mailto:martin.eisenhardt@mneisen.org Martin Eisenhardt]
** www.englishbreakfastnetwork.org also hosts an anonymous SVN mirror, at the University of Nijmegen, Netherlands. Maintained by [mailto:groot@kde.org Adriaan de Groot]
** svn://azkaban.caltech.edu is located near Los Angeles, USA and is maintained by [mailto:eugen.plamadeala@gmail.com Eugeniu Plamadeala]. It has the same folder hierarchy as anonsvn.kde.org.
: Be careful when switching between mirrors. SVN remembers the server in the working copy, so to switch you have to run
svn switch --relocate svn://anonsvn.kde.org/ svn://kde.mneisen.org/
: in all your checkouts.
If you're interested in setting up a svn mirror, please contact [mailto:mueller@kde.org Dirk Mueller].

[[Category:Build KDE]]

Getting Started/Sources/Anonymous SVN

2007-09-09T17:01:01Z

Logixoul: /* Checkout KDE */ trim sentence; rm redundant info that's also on the Build KDE4 page

{{Template:I18n/Language Navigation Bar|Getting Started/Sources/Anonymous SVN}}
{{TutorialBrowser|

series=Getting Started|

name=Getting KDE Sources Using Anonymous Subversion (SVN)|

next=[[../../Build/KDE4|Building KDE4]]|

reading=[http://svnbook.red-bean.com/ Version Control with Subversion]|
}}

== Abstract ==

For those of us that like to stay on the "bleeding edge" there's an easy way to keep a local copy of the KDE sources up-to-date. No more trying to log on to ftp.kde.org to get the latest snapshot. No more wandering aimlessly through mirrors looking for one that's up to date. Just a simple command line operation to get up-to-the-minute source updates: anonymous SVN.

Please note that several Linux distributions now already provide KDE SVN packages, so '''building Qt and KDE from source may well not be necessary for you at all! '''See [[Getting_Started/Distribution_Packages]] for instructions and information.

== Anonymous SVN ==

Using anonymous SVN is simple:

=== Setup Subversion ===

First, install the subversion (svn) binary if it isn't already on your computer. Your operating system should have a package for it. Alternatively you can download and compile it yourself via the [http://subversion.tigris.org/project_packages.html svn project download page]. Please read the [[Getting_Started/Sources/Using_Subversion_with_KDE|KDE Subversion tutorial]] if you are interested in how to use Subversion.

=== Checkout KDE ===

'''/home/kde/trunk/''' (often refered to as '''trunk''', for short) is where the Qt4-based KDE 4 is being developed. The following is the minimal set of modules you will need to check out to build KDE and KDE software:

svn co svn://anonsvn.kde.org/home/kde/trunk/KDE/kdelibs
svn co svn://anonsvn.kde.org/home/kde/trunk/KDE/kdebase

{{tip|Only use "'''svn co'''" or "'''svn checkout'''" for the initial checkout, you will update your local sources afterwards by using "'''svn up''' ''modulename''" or "'''svn update''' ''modulename''".}}

{{tip|If your firewall doesn't allow access to arbitrary ports, substitute '''svn://anonsvn.kde.org/''' with '''svn://websvn.kde.org:443/''' above.}}

'''qt-copy''' is a copy of the latest stable [http://www.trolltech.com Qt] release which works with KDE, put into SVN for convenience. It also contains additional patches that fix bugs or add enhancements KDE makes use of and is therefore recommended for those working with KDE from '''trunk'''. You can obtain '''qt-copy''' by doing:

svn co svn://anonsvn.kde.org/home/kde/trunk/qt-copy

If you wish to have a complete copy of the KDE distribution, you can simply check out the entire source tree with one command:

svn co svn://anonsvn.kde.org/home/kde/trunk/KDE

'''Be aware this is a lot of source code to download'''. The server may demote priority for such large svn requests. Depending on server load, checkout of the entire source tree could grind to a virtual halt part-way through the job.

{{note|It is smarter to first use [http://websvn.kde.org/trunk/KDE The KDE Source Repository Web Viewer]. Use it to choose which modules to download. This way KDE will be quicker to install and try out.}}

If you want additional software packages you can check out the following modules within '''trunk/''' as well:

koffice
extragear
playground
kdereview

So, for example, if you want to check out koffice trunk, you can use

svn co svn://anonsvn.kde.org/home/kde/trunk/koffice

=== Checking out trunk using snapshots ===

If you are checking out modules from '''trunk/''' you may be able to save time by using snapshots. Using Subversion trunk snapshots is described at [[../Snapshots|the Subversion snapshots tutorial page]].

=== Checking out KDE 3 instead ===

If you want to track KDE 3 rather than the bleeding edge, you may retrieve the KDE 3.5 sources using:

svn co svn://anonsvn.kde.org/home/kde/branches/arts/1.5/arts
svn co svn://anonsvn.kde.org/home/kde/branches/KDE/3.5/

And if you want the matching qt-copy:
svn co svn://anonsvn.kde.org/home/kde/branches/qt/3.3/qt-copy

=== Checking out specific releases ===

KDE modules are also tagged at each release so that it is possible to get a specific release of KDE. Most KDE modules have a tag name in the format '''tags/KDE/X.Y.Z''' (where X, Y and Z represent the exact version). The arts module (only needed for KDE 2 and KDE 3) has a different format of tag name, '''tags/arts/X.Y.Z'''. For instance to get kdelibs as it was shipped in KDE 3.5.0, do:

svn co svn://anonsvn.kde.org/home/kde/tags/KDE/3.5.0/kdelibs/

If you then want to update this checkout to KDE 3.5.5, use this command:

svn switch svn://anonsvn.kde.org/home/kde/tags/KDE/3.5.5/kdelibs

{{tip|If you used a '''/branch/''' or '''/trunk/''' path, then there is no need to switch, just run '''svn update'''.}}

{{tip|[http://websvn.kde.org/tags/ WebSVN] is a convenient way to check for a tag name.}}

=== Checking out translations ===
If you are looking for translations and other localizations, check out the appropriate language from the [http://websvn.kde.org/trunk/l10n l10n] module.

{{Warning|The l10n module is ''extremely'' large. Be sure you have lots of time and disk space on hand before checking out the entire l10n module. Most people only check out specific language subdirectories rather than the entire l10n module.}}

You are now ready to start building KDE! Visit [[Getting_Started/Build/KDE4|this page]] for instructions on building trunk or [[Getting_Started/Build/Stable_Version|this page]] for instruction on compiling the last stable release.

== Also of interest ==
* anonsvn.kde.org is located in Tuebingen, Germany, maintained by [mailto:dirk@kde.org Dirk Mueller] However, a more local mirror could be faster for you than anonsvn.kde.org itself. Current mirrors are, sorted by performance:
** kde.mneisen.org is located near Nuernberg, Germany, maintained by [mailto:martin.eisenhardt@mneisen.org Martin Eisenhardt]
** www.englishbreakfastnetwork.org also hosts an anonymous SVN mirror, at the University of Nijmegen, Netherlands. Maintained by [mailto:groot@kde.org Adriaan de Groot]
** svn://azkaban.caltech.edu is located near Los Angeles, USA and is maintained by [mailto:eugen.plamadeala@gmail.com Eugeniu Plamadeala]. It has the same folder hierarchy as anonsvn.kde.org.
: Be careful when switching between mirrors. SVN remembers the server in the working copy, so to switch you have to run
svn switch --relocate svn://anonsvn.kde.org/ svn://kde.mneisen.org/
: in all your checkouts.
* For a script that updates via SVN and compiles KDE automatically, see [http://kdesvn-build.kde.org/ kdesvn-build].

If you're interested in setting up a svn mirror, please contact [mailto:mueller@kde.org Dirk Mueller].

[[Category:Build KDE]]

Talk:Installing third party softwares in terminal/Build/KDE4

2007-07-05T16:12:08Z

Logixoul: /* Amount of space needed? */

==== 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 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)

Talk:Installing third party softwares in terminal/Build/KDE4

2007-07-05T16:03:01Z

Logixoul: /* Qt Flags */ fixed

==== 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 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)

== 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)

Getting Started/Build/KDE4

2007-07-05T16:00:40Z

Logixoul: /* The Recipe */ qdbus and pch are default as mentioned on talk; same for openssl

{{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=[http://kdesvn-build.kde.org/ kdesvn-build: The KDE From Subversion Build Tool] [[../../Increased_Productivity_in_KDE4_with_Scripts|Increased Productivity in KDE4 with Scripts]] [[Development/Tutorials/CMake |Introduction to CMake]] [[../KDE4/FreeBSD|FreeBSD notes]] [[../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. There are also tutorials for [[/FreeBSD|FreeBSD]], [http://www.kdelibs.com/ Windows], [[/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.
}}

== 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, 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 part of kdesdk. You can install it as part of kdesdk (kdesdk-scripts on Debian) or similar package, or just download it itself from [http://websvn.kde.org/*checkout*/trunk/KDE/kdesdk/scripts/makeobj WebSVN]
* the [http://freedesktop.org/wiki/Software/shared-mime-info shared-mime-info package], which is the freedesktop MIME standard KDE is using now
* [http://boost.org/ boost], needed by kdebase; after compiling and/or installing boost, in order to make cmake aware about its location (FindBoost), add boost directory (the one containing include subdirectory) to CMAKE_INCLUDE_PATH or set an environment variable called BOOST_ROOT pointing to boost directory.

=== Kubuntu ===

In Kubuntu 7.04 (Feisty) the build dependencies you need are installed with:
<code bash>
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 libpng-dev subversion libsm-dev libxinerama-dev \
libxrender-dev libfontconfig-dev libboost-dev libxcursor-dev doxygen \
libungif4-dev libdbus-1-dev libgpgme11-dev libssl-dev
</code>

You can skip the manual installation of CMake 2.4.6 and DBus with:
<code bash>
sudo aptitude install libdbus-1-dev cmake
</code>

For a fully functional API documentation framework you also need:
<code bash>
sudo aptitude install graphviz
</code>

=== 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++
</code>

'''Optional Packages'''

You can skip the manual installation of Qt 4.3, CMake 2.4.6 and DBus by installing the adding the openSUSE Build Service KDE4 Repository 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 (and their dependencies):
<code>
cmake
dbus-1-devel
libqt4-devel
</code>

And for fully functional apidox frame work you also need:
<code>
graphviz
</code>

CMake binary packages for openSUSE are available from [http://software.opensuse.org/download/devel:/tools:/building/ openSUSE build service].

=== Gentoo ===

==== Install by hand ====

You can use most stable ebuilds just remember to sync your portage before you begin.

We need to be unmasked and/or kept at a lower version to continue.

<code bash>
# echo 'x11-libs/qt' >> /etc/portage/package.keywords
# echo 'dev-util/cmake' >> /etc/portage/package.keywords
# echo 'dev-cpp/clucene' >> /etc/portage/package.keywords
# echo '>dev-cpp/clucene-0.9.16a' >> /etc/portage/package.mask
</code>

These are the packages you will need to install, some may already be installed so you may skip those by adding the update flag to emerge.

<code bash>
$ emerge -avu ebuild/name
</code>

sys-devel/gcc
dev-util/subversion
dev-util/pkgconfig
x11-base/xorg-x11
media-libs/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
kde-base/kdesdk-scripts
dev-libs/boost
x11-libs/qt
dev-util/cmake
sys-apps/dbus
dev-libs/redland

Provided you have emerged these ebuilds, you can skip compiling them by hand and proceed to [[Getting_Started/Build/KDE4#kdesupport|kdesupport section]].

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 thread [http://forums.gentoo.org/viewtopic-t-530111-postdays-0-postorder-asc-start-0.html KDE 4 monolithic ebuilds].

== 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>

=== 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. 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>
su - kde-devel
</code>

== 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 {{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.

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

=== 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>.

== 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 the Qt4 that is in KDE's source repository. KDE is guaranteed to build against any Qt 4.3. Qt 4.2 and earlier are not supported and will not work. You should use the copy in the KDE Subversion servers.

=== The Recipe ===
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 -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' -exec rm {} \; ; \
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-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 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.

== kdesupport ==

{{warning|If you have jumped to this section without reading [[Getting_Started/Build/KDE4#Setting_up_the_environment|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. Your environment '''needs''' to be set up correctly for these instructions to work for you.}}

There are several libraries that KDE applications rely on in the kdesupport module. This includes Strigi and Soprano for file metadata and search, 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.16; version 0.9.17 does '''not''' work), and either libxml2 or libexpat.

=== The Recipe ===

cs # [[Getting_Started/Increased_Productivity_in_KDE4_with_Scripts/.bashrc|cs is not a typo]]
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|~/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
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?

== kdelibs ==

We can now move on to building KDE's base libraries.

=== The Recipe ===
cs # bash function
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|~/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#Required_Software|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|~/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 \
~/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 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, 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)

== 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 not a typo]]
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|~/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 ==
You may need kdebase for some kioslaves.

cs KDE # [[Getting_Started/Increased_Productivity_in_KDE4_with_Scripts/.bashrc|cs is not a typo]]
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)

== 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 not a typo]]
$KDE_SRC/KDE/kdelibs/doc/api/doxygen.sh \
--doxdatadir=$KDE_SRC/KDE/kdelibs/doc/common .

Repeat for other modules as desired. 
cd <module home>
$KDE_SRC/KDE/kdelibs/doc/api/doxygen.sh \
--doxdatadir=$KDE_SRC/KDE/kdelibs/doc/common .

== 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>

== 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.

== 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-07-04T04:04:03Z

Logixoul: /* kdelibs */ blah blah blah

{{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=[http://kdesvn-build.kde.org/ kdesvn-build: The KDE From Subversion Build Tool] [[../../Increased_Productivity_in_KDE4_with_Scripts|Increased Productivity in KDE4 with Scripts]] [[Development/Tutorials/CMake |Introduction to CMake]] [[../KDE4/FreeBSD|FreeBSD notes]] [[../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. There are also tutorials for [[/FreeBSD|FreeBSD]], [http://www.kdelibs.com/ Windows], [[/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.
}}

== 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, 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 part of kdesdk. You can install it as part of kdesdk (kdesdk-scripts on Debian) or similar package, or just download it itself from [http://websvn.kde.org/*checkout*/trunk/KDE/kdesdk/scripts/makeobj WebSVN]
* the [http://freedesktop.org/wiki/Software/shared-mime-info shared-mime-info package], which is the freedesktop MIME standard KDE is using now
* [http://boost.org/ boost], needed by kdebase; after compiling and/or installing boost, in order to make cmake aware about its location (FindBoost), add boost directory (the one containing include subdirectory) to CMAKE_INCLUDE_PATH or set an environment variable called BOOST_ROOT pointing to boost directory.

=== Kubuntu ===

In Kubuntu 7.04 (Feisty) the build dependencies you need are installed with:
<code bash>
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 libpng-dev subversion libsm-dev libxinerama-dev \
libxrender-dev libfontconfig-dev libboost-dev libxcursor-dev doxygen \
libungif4-dev libdbus-1-dev libgpgme11-dev libssl-dev
</code>

You can skip the manual installation of CMake 2.4.6 and DBus with:
<code bash>
sudo aptitude install libdbus-1-dev cmake
</code>

For a fully functional API documentation framework you also need:
<code bash>
sudo aptitude install graphviz
</code>

=== 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++
</code>

'''Optional Packages'''

You can skip the manual installation of Qt 4.3, CMake 2.4.6 and DBus by installing the adding the openSUSE Build Service KDE4 Repository 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 (and their dependencies):
<code>
cmake
dbus-1-devel
libqt4-devel
</code>

And for fully functional apidox frame work you also need:
<code>
graphviz
</code>

CMake binary packages for openSUSE are available from [http://software.opensuse.org/download/devel:/tools:/building/ openSUSE build service].

=== Gentoo ===

You can use most stable ebuilds just remember to sync your portage before you begin.

We need to be unmasked and/or kept at a lower version to continue.

<code bash>
# echo 'x11-libs/qt' >> /etc/portage/package.keywords
# echo 'dev-util/cmake' >> /etc/portage/package.keywords
# echo 'dev-cpp/clucene' >> /etc/portage/package.keywords
# echo '>dev-cpp/clucene-0.9.16a' >> /etc/portage/package.mask
</code>

These are the packages you will need to install, some may already be installed so you may skip those by adding the update flag to emerge.

<code bash>
$ emerge -avu ebuild/name
</code>

sys-devel/gcc
dev-util/subversion
dev-util/pkgconfig
x11-base/xorg-x11
media-libs/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
kde-base/kdesdk-scripts
dev-libs/boost
x11-libs/qt
dev-util/cmake
sys-apps/dbus
dev-libs/redland

Provided you have emerged these ebuilds, you can skip compiling them by hand and proceed to [[Getting_Started/Build/KDE4#kdesupport|kdesupport section]].

Good luck!

== 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>

=== 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. 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>
su - kde-devel
</code>

== 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 {{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.

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

=== 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>.

== 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 the Qt4 that is in KDE's source repository. KDE is guaranteed to build against any Qt 4.3. Qt 4.2 and earlier are not supported and will not work. You should use the copy in the KDE Subversion servers.

=== The Recipe ===
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 -openssl -nomake examples \
-nomake demos
make -j2

# do copy files if the target doesnt match current dir,
# clear obj files to save disk space otherwise
if [ $QTDIR = `pwd` ]; then \
find . -name '*.o' -exec rm {} \; ; \
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-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 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.

== kdesupport ==

{{warning|If you have jumped to this section without reading [[Getting_Started/Build/KDE4#Setting_up_the_environment|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. Your environment '''needs''' to be set up correctly for these instructions to work for you.}}

There are several libraries that KDE applications rely on in the kdesupport module. This includes Strigi and Soprano for file metadata and search, 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.16; version 0.9.17 does '''not''' work), and either libxml2 or libexpat.

=== The Recipe ===

cs # [[Getting_Started/Increased_Productivity_in_KDE4_with_Scripts/.bashrc|cs is not a typo]]
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|~/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
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?

== kdelibs ==

We can now move on to building KDE's base libraries.

=== The Recipe ===
cs # bash function
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|~/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#Required_Software|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|~/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 \
~/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 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, 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)

== 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 not a typo]]
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|~/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 ==
You may need kdebase for some kioslaves.

cs KDE # [[Getting_Started/Increased_Productivity_in_KDE4_with_Scripts/.bashrc|cs is not a typo]]
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)

== 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 not a typo]]
$KDE_SRC/KDE/kdelibs/doc/api/doxygen.sh \
--doxdatadir=$KDE_SRC/KDE/kdelibs/doc/common .

Repeat for other modules as desired. 
cd <module home>
$KDE_SRC/KDE/kdelibs/doc/api/doxygen.sh \
--doxdatadir=$KDE_SRC/KDE/kdelibs/doc/common .

== 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>

== 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.

== 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-07-04T03:57:33Z

Logixoul: /* Switching to the New User */ don't repeat ourselves

{{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=[http://kdesvn-build.kde.org/ kdesvn-build: The KDE From Subversion Build Tool] [[../../Increased_Productivity_in_KDE4_with_Scripts|Increased Productivity in KDE4 with Scripts]] [[Development/Tutorials/CMake |Introduction to CMake]] [[../KDE4/FreeBSD|FreeBSD notes]] [[../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. There are also tutorials for [[/FreeBSD|FreeBSD]], [http://www.kdelibs.com/ Windows], [[/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.
}}

== 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, 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 part of kdesdk. You can install it as part of kdesdk (kdesdk-scripts on Debian) or similar package, or just download it itself from [http://websvn.kde.org/*checkout*/trunk/KDE/kdesdk/scripts/makeobj WebSVN]
* the [http://freedesktop.org/wiki/Software/shared-mime-info shared-mime-info package], which is the freedesktop MIME standard KDE is using now
* [http://boost.org/ boost], needed by kdebase; after compiling and/or installing boost, in order to make cmake aware about its location (FindBoost), add boost directory (the one containing include subdirectory) to CMAKE_INCLUDE_PATH or set an environment variable called BOOST_ROOT pointing to boost directory.

=== Kubuntu ===

In Kubuntu 7.04 (Feisty) the build dependencies you need are installed with:
<code bash>
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 libpng-dev subversion libsm-dev libxinerama-dev \
libxrender-dev libfontconfig-dev libboost-dev libxcursor-dev doxygen \
libungif4-dev libdbus-1-dev libgpgme11-dev libssl-dev
</code>

You can skip the manual installation of CMake 2.4.6 and DBus with:
<code bash>
sudo aptitude install libdbus-1-dev cmake
</code>

For a fully functional API documentation framework you also need:
<code bash>
sudo aptitude install graphviz
</code>

=== 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++
</code>

'''Optional Packages'''

You can skip the manual installation of Qt 4.3, CMake 2.4.6 and DBus by installing the adding the openSUSE Build Service KDE4 Repository 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 (and their dependencies):
<code>
cmake
dbus-1-devel
libqt4-devel
</code>

And for fully functional apidox frame work you also need:
<code>
graphviz
</code>

CMake binary packages for openSUSE are available from [http://software.opensuse.org/download/devel:/tools:/building/ openSUSE build service].

=== Gentoo ===

You can use most stable ebuilds just remember to sync your portage before you begin.

We need to be unmasked and/or kept at a lower version to continue.

<code bash>
# echo 'x11-libs/qt' >> /etc/portage/package.keywords
# echo 'dev-util/cmake' >> /etc/portage/package.keywords
# echo 'dev-cpp/clucene' >> /etc/portage/package.keywords
# echo '>dev-cpp/clucene-0.9.16a' >> /etc/portage/package.mask
</code>

These are the packages you will need to install, some may already be installed so you may skip those by adding the update flag to emerge.

<code bash>
$ emerge -avu ebuild/name
</code>

sys-devel/gcc
dev-util/subversion
dev-util/pkgconfig
x11-base/xorg-x11
media-libs/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
kde-base/kdesdk-scripts
dev-libs/boost
x11-libs/qt
dev-util/cmake
sys-apps/dbus
dev-libs/redland

Provided you have emerged these ebuilds, you can skip compiling them by hand and proceed to [[Getting_Started/Build/KDE4#kdesupport|kdesupport section]].

Good luck!

== 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>

=== 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. 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>
su - kde-devel
</code>

== 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 {{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.

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

=== 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>.

== 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 the Qt4 that is in KDE's source repository. KDE is guaranteed to build against any Qt 4.3. Qt 4.2 and earlier are not supported and will not work. You should use the copy in the KDE Subversion servers.

=== The Recipe ===
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 -openssl -nomake examples \
-nomake demos
make -j2

# do copy files if the target doesnt match current dir,
# clear obj files to save disk space otherwise
if [ $QTDIR = `pwd` ]; then \
find . -name '*.o' -exec rm {} \; ; \
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-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 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.

== kdesupport ==

{{warning|If you have jumped to this section without reading [[Getting_Started/Build/KDE4#Setting_up_the_environment|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. Your environment '''needs''' to be set up correctly for these instructions to work for you.}}

There are several libraries that KDE applications rely on in the kdesupport module. This includes Strigi and Soprano for file metadata and search, 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.16; version 0.9.17 does '''not''' work), and either libxml2 or libexpat.

=== The Recipe ===

cs # [[Getting_Started/Increased_Productivity_in_KDE4_with_Scripts/.bashrc|cs is not a typo]]
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|~/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
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?

== kdelibs ==

With Qt4, Strigi, and Soprano 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.

=== The Recipe ===

cs # bash function
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|~/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#Required_Software|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|~/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 \
~/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 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, 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)

== 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 not a typo]]
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|~/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 ==
You may need kdebase for some kioslaves.

cs KDE # [[Getting_Started/Increased_Productivity_in_KDE4_with_Scripts/.bashrc|cs is not a typo]]
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)

== 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 not a typo]]
$KDE_SRC/KDE/kdelibs/doc/api/doxygen.sh \
--doxdatadir=$KDE_SRC/KDE/kdelibs/doc/common .

Repeat for other modules as desired. 
cd <module home>
$KDE_SRC/KDE/kdelibs/doc/api/doxygen.sh \
--doxdatadir=$KDE_SRC/KDE/kdelibs/doc/common .

== 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>

== 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.

== 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-07-04T03:52:48Z

Logixoul: /* Kubuntu */

{{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=[http://kdesvn-build.kde.org/ kdesvn-build: The KDE From Subversion Build Tool] [[../../Increased_Productivity_in_KDE4_with_Scripts|Increased Productivity in KDE4 with Scripts]] [[Development/Tutorials/CMake |Introduction to CMake]] [[../KDE4/FreeBSD|FreeBSD notes]] [[../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. There are also tutorials for [[/FreeBSD|FreeBSD]], [http://www.kdelibs.com/ Windows], [[/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.
}}

== 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, 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 part of kdesdk. You can install it as part of kdesdk (kdesdk-scripts on Debian) or similar package, or just download it itself from [http://websvn.kde.org/*checkout*/trunk/KDE/kdesdk/scripts/makeobj WebSVN]
* the [http://freedesktop.org/wiki/Software/shared-mime-info shared-mime-info package], which is the freedesktop MIME standard KDE is using now
* [http://boost.org/ boost], needed by kdebase; after compiling and/or installing boost, in order to make cmake aware about its location (FindBoost), add boost directory (the one containing include subdirectory) to CMAKE_INCLUDE_PATH or set an environment variable called BOOST_ROOT pointing to boost directory.

=== Kubuntu ===

In Kubuntu 7.04 (Feisty) the build dependencies you need are installed with:
<code bash>
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 libpng-dev subversion libsm-dev libxinerama-dev \
libxrender-dev libfontconfig-dev libboost-dev libxcursor-dev doxygen \
libungif4-dev libdbus-1-dev libgpgme11-dev libssl-dev
</code>

You can skip the manual installation of CMake 2.4.6 and DBus with:
<code bash>
sudo aptitude install libdbus-1-dev cmake
</code>

For a fully functional API documentation framework you also need:
<code bash>
sudo aptitude install graphviz
</code>

=== 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++
</code>

'''Optional Packages'''

You can skip the manual installation of Qt 4.3, CMake 2.4.6 and DBus by installing the adding the openSUSE Build Service KDE4 Repository 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 (and their dependencies):
<code>
cmake
dbus-1-devel
libqt4-devel
</code>

And for fully functional apidox frame work you also need:
<code>
graphviz
</code>

CMake binary packages for openSUSE are available from [http://software.opensuse.org/download/devel:/tools:/building/ openSUSE build service].

=== Gentoo ===

You can use most stable ebuilds just remember to sync your portage before you begin.

We need to be unmasked and/or kept at a lower version to continue.

<code bash>
# echo 'x11-libs/qt' >> /etc/portage/package.keywords
# echo 'dev-util/cmake' >> /etc/portage/package.keywords
# echo 'dev-cpp/clucene' >> /etc/portage/package.keywords
# echo '>dev-cpp/clucene-0.9.16a' >> /etc/portage/package.mask
</code>

These are the packages you will need to install, some may already be installed so you may skip those by adding the update flag to emerge.

<code bash>
$ emerge -avu ebuild/name
</code>

sys-devel/gcc
dev-util/subversion
dev-util/pkgconfig
x11-base/xorg-x11
media-libs/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
kde-base/kdesdk-scripts
dev-libs/boost
x11-libs/qt
dev-util/cmake
sys-apps/dbus
dev-libs/redland

Provided you have emerged these ebuilds, you can skip compiling them by hand and proceed to [[Getting_Started/Build/KDE4#kdesupport|kdesupport section]].

Good luck!

== 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>

=== 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. 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>
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 {{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.

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

=== 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>.

== 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 the Qt4 that is in KDE's source repository. KDE is guaranteed to build against any Qt 4.3. Qt 4.2 and earlier are not supported and will not work. You should use the copy in the KDE Subversion servers.

=== The Recipe ===
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 -openssl -nomake examples \
-nomake demos
make -j2

# do copy files if the target doesnt match current dir,
# clear obj files to save disk space otherwise
if [ $QTDIR = `pwd` ]; then \
find . -name '*.o' -exec rm {} \; ; \
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-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 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.

== kdesupport ==

{{warning|If you have jumped to this section without reading [[Getting_Started/Build/KDE4#Setting_up_the_environment|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. Your environment '''needs''' to be set up correctly for these instructions to work for you.}}

There are several libraries that KDE applications rely on in the kdesupport module. This includes Strigi and Soprano for file metadata and search, 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.16; version 0.9.17 does '''not''' work), and either libxml2 or libexpat.

=== The Recipe ===

cs # [[Getting_Started/Increased_Productivity_in_KDE4_with_Scripts/.bashrc|cs is not a typo]]
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|~/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
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?

== kdelibs ==

With Qt4, Strigi, and Soprano 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.

=== The Recipe ===

cs # bash function
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|~/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#Required_Software|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|~/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 \
~/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 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, 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)

== 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 not a typo]]
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|~/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 ==
You may need kdebase for some kioslaves.

cs KDE # [[Getting_Started/Increased_Productivity_in_KDE4_with_Scripts/.bashrc|cs is not a typo]]
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)

== 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 not a typo]]
$KDE_SRC/KDE/kdelibs/doc/api/doxygen.sh \
--doxdatadir=$KDE_SRC/KDE/kdelibs/doc/common .

Repeat for other modules as desired. 
cd <module home>
$KDE_SRC/KDE/kdelibs/doc/api/doxygen.sh \
--doxdatadir=$KDE_SRC/KDE/kdelibs/doc/common .

== 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>

== 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.

== 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-07-04T03:47:17Z

Logixoul: /* TroubleShooting */

{{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=[http://kdesvn-build.kde.org/ kdesvn-build: The KDE From Subversion Build Tool] [[../../Increased_Productivity_in_KDE4_with_Scripts|Increased Productivity in KDE4 with Scripts]] [[Development/Tutorials/CMake |Introduction to CMake]] [[../KDE4/FreeBSD|FreeBSD notes]] [[../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. There are also tutorials for [[/FreeBSD|FreeBSD]], [http://www.kdelibs.com/ Windows], [[/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.
}}

== 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, 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 part of kdesdk. You can install it as part of kdesdk (kdesdk-scripts on Debian) or similar package, or just download it itself from [http://websvn.kde.org/*checkout*/trunk/KDE/kdesdk/scripts/makeobj WebSVN]
* the [http://freedesktop.org/wiki/Software/shared-mime-info shared-mime-info package], which is the freedesktop MIME standard KDE is using now
* [http://boost.org/ boost], needed by kdebase; after compiling and/or installing boost, in order to make cmake aware about its location (FindBoost), add boost directory (the one containing include subdirectory) to CMAKE_INCLUDE_PATH or set an environment variable called BOOST_ROOT pointing to boost directory.

=== Kubuntu ===

In Kubuntu 7.04 (Feisty) the build dependencies you need are installed with:
<code bash>
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 libpng-dev subversion libsm-dev libxinerama-dev \
libxrender-dev libfontconfig-dev libboost-dev libxcursor-dev doxygen \
libungif4-dev libdbus-1-dev libgpgme11-dev libssl-dev
</code>

You can skip the manual installation of CMake 2.4.6 and DBus with:
<code bash>
sudo aptitude install libdbus-1-dev cmake
</code>

And for fully functional [[apidox]] frame work you also need:
<code bash>
sudo aptitude install graphviz
</code>

=== 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++
</code>

'''Optional Packages'''

You can skip the manual installation of Qt 4.3, CMake 2.4.6 and DBus by installing the adding the openSUSE Build Service KDE4 Repository 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 (and their dependencies):
<code>
cmake
dbus-1-devel
libqt4-devel
</code>

And for fully functional apidox frame work you also need:
<code>
graphviz
</code>

CMake binary packages for openSUSE are available from [http://software.opensuse.org/download/devel:/tools:/building/ openSUSE build service].

=== Gentoo ===

You can use most stable ebuilds just remember to sync your portage before you begin.

We need to be unmasked and/or kept at a lower version to continue.

<code bash>
# echo 'x11-libs/qt' >> /etc/portage/package.keywords
# echo 'dev-util/cmake' >> /etc/portage/package.keywords
# echo 'dev-cpp/clucene' >> /etc/portage/package.keywords
# echo '>dev-cpp/clucene-0.9.16a' >> /etc/portage/package.mask
</code>

These are the packages you will need to install, some may already be installed so you may skip those by adding the update flag to emerge.

<code bash>
$ emerge -avu ebuild/name
</code>

sys-devel/gcc
dev-util/subversion
dev-util/pkgconfig
x11-base/xorg-x11
media-libs/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
kde-base/kdesdk-scripts
dev-libs/boost
x11-libs/qt
dev-util/cmake
sys-apps/dbus
dev-libs/redland

Provided you have emerged these ebuilds, you can skip compiling them by hand and proceed to [[Getting_Started/Build/KDE4#kdesupport|kdesupport section]].

Good luck!

== 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>

=== 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. 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>
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 {{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.

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

=== 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>.

== 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 the Qt4 that is in KDE's source repository. KDE is guaranteed to build against any Qt 4.3. Qt 4.2 and earlier are not supported and will not work. You should use the copy in the KDE Subversion servers.

=== The Recipe ===
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 -openssl -nomake examples \
-nomake demos
make -j2

# do copy files if the target doesnt match current dir,
# clear obj files to save disk space otherwise
if [ $QTDIR = `pwd` ]; then \
find . -name '*.o' -exec rm {} \; ; \
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-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 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.

== kdesupport ==

{{warning|If you have jumped to this section without reading [[Getting_Started/Build/KDE4#Setting_up_the_environment|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. Your environment '''needs''' to be set up correctly for these instructions to work for you.}}

There are several libraries that KDE applications rely on in the kdesupport module. This includes Strigi and Soprano for file metadata and search, 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.16; version 0.9.17 does '''not''' work), and either libxml2 or libexpat.

=== The Recipe ===

cs # [[Getting_Started/Increased_Productivity_in_KDE4_with_Scripts/.bashrc|cs is not a typo]]
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|~/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
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?

== kdelibs ==

With Qt4, Strigi, and Soprano 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.

=== The Recipe ===

cs # bash function
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|~/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#Required_Software|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|~/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 \
~/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 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, 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)

== 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 not a typo]]
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|~/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 ==
You may need kdebase for some kioslaves.

cs KDE # [[Getting_Started/Increased_Productivity_in_KDE4_with_Scripts/.bashrc|cs is not a typo]]
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)

== 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 not a typo]]
$KDE_SRC/KDE/kdelibs/doc/api/doxygen.sh \
--doxdatadir=$KDE_SRC/KDE/kdelibs/doc/common .

Repeat for other modules as desired. 
cd <module home>
$KDE_SRC/KDE/kdelibs/doc/api/doxygen.sh \
--doxdatadir=$KDE_SRC/KDE/kdelibs/doc/common .

== 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>

== 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.

== 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-07-04T03:43:17Z

Logixoul: /* Abstract */ a bit more clear hopefully

{{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=[http://kdesvn-build.kde.org/ kdesvn-build: The KDE From Subversion Build Tool] [[../../Increased_Productivity_in_KDE4_with_Scripts|Increased Productivity in KDE4 with Scripts]] [[Development/Tutorials/CMake |Introduction to CMake]] [[../KDE4/FreeBSD|FreeBSD notes]] [[../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. There are also tutorials for [[/FreeBSD|FreeBSD]], [http://www.kdelibs.com/ Windows], [[/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.
}}

== 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, 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 part of kdesdk. You can install it as part of kdesdk (kdesdk-scripts on Debian) or similar package, or just download it itself from [http://websvn.kde.org/*checkout*/trunk/KDE/kdesdk/scripts/makeobj WebSVN]
* the [http://freedesktop.org/wiki/Software/shared-mime-info shared-mime-info package], which is the freedesktop MIME standard KDE is using now
* [http://boost.org/ boost], needed by kdebase; after compiling and/or installing boost, in order to make cmake aware about its location (FindBoost), add boost directory (the one containing include subdirectory) to CMAKE_INCLUDE_PATH or set an environment variable called BOOST_ROOT pointing to boost directory.

=== Kubuntu ===

In Kubuntu 7.04 (Feisty) the build dependencies you need are installed with:
<code bash>
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 libpng-dev subversion libsm-dev libxinerama-dev \
libxrender-dev libfontconfig-dev libboost-dev libxcursor-dev doxygen \
libungif4-dev libdbus-1-dev libgpgme11-dev libssl-dev
</code>

You can skip the manual installation of CMake 2.4.6 and DBus with:
<code bash>
sudo aptitude install libdbus-1-dev cmake
</code>

And for fully functional [[apidox]] frame work you also need:
<code bash>
sudo aptitude install graphviz
</code>

=== 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++
</code>

'''Optional Packages'''

You can skip the manual installation of Qt 4.3, CMake 2.4.6 and DBus by installing the adding the openSUSE Build Service KDE4 Repository 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 (and their dependencies):
<code>
cmake
dbus-1-devel
libqt4-devel
</code>

And for fully functional apidox frame work you also need:
<code>
graphviz
</code>

CMake binary packages for openSUSE are available from [http://software.opensuse.org/download/devel:/tools:/building/ openSUSE build service].

=== Gentoo ===

You can use most stable ebuilds just remember to sync your portage before you begin.

We need to be unmasked and/or kept at a lower version to continue.

<code bash>
# echo 'x11-libs/qt' >> /etc/portage/package.keywords
# echo 'dev-util/cmake' >> /etc/portage/package.keywords
# echo 'dev-cpp/clucene' >> /etc/portage/package.keywords
# echo '>dev-cpp/clucene-0.9.16a' >> /etc/portage/package.mask
</code>

These are the packages you will need to install, some may already be installed so you may skip those by adding the update flag to emerge.

<code bash>
$ emerge -avu ebuild/name
</code>

sys-devel/gcc
dev-util/subversion
dev-util/pkgconfig
x11-base/xorg-x11
media-libs/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
kde-base/kdesdk-scripts
dev-libs/boost
x11-libs/qt
dev-util/cmake
sys-apps/dbus
dev-libs/redland

Provided you have emerged these ebuilds, you can skip compiling them by hand and proceed to [[Getting_Started/Build/KDE4#kdesupport|kdesupport section]].

Good luck!

== 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>

=== 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. 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>
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 {{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.

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

=== 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>.

== 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 the Qt4 that is in KDE's source repository. KDE is guaranteed to build against any Qt 4.3. Qt 4.2 and earlier are not supported and will not work. You should use the copy in the KDE Subversion servers.

=== The Recipe ===
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 -openssl -nomake examples \
-nomake demos
make -j2

# do copy files if the target doesnt match current dir,
# clear obj files to save disk space otherwise
if [ $QTDIR = `pwd` ]; then \
find . -name '*.o' -exec rm {} \; ; \
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-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 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.

== kdesupport ==

{{warning|If you have jumped to this section without reading [[Getting_Started/Build/KDE4#Setting_up_the_environment|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. Your environment '''needs''' to be set up correctly for these instructions to work for you.}}

There are several libraries that KDE applications rely on in the kdesupport module. This includes Strigi and Soprano for file metadata and search, 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.16; version 0.9.17 does '''not''' work), and either libxml2 or libexpat.

=== The Recipe ===

cs # [[Getting_Started/Increased_Productivity_in_KDE4_with_Scripts/.bashrc|cs is not a typo]]
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|~/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
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?

== kdelibs ==

With Qt4, Strigi, and Soprano 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.

=== The Recipe ===

cs # bash function
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|~/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#Required_Software|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|~/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 \
~/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 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, 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)

== 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 not a typo]]
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|~/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 ==
You may need kdebase for some kioslaves.

cs KDE # [[Getting_Started/Increased_Productivity_in_KDE4_with_Scripts/.bashrc|cs is not a typo]]
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)

== 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 not a typo]]
$KDE_SRC/KDE/kdelibs/doc/api/doxygen.sh \
--doxdatadir=$KDE_SRC/KDE/kdelibs/doc/common .

Repeat for other modules as desired. 
cd <module home>
$KDE_SRC/KDE/kdelibs/doc/api/doxygen.sh \
--doxdatadir=$KDE_SRC/KDE/kdelibs/doc/common .

== 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>

== 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.

== 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-07-04T03:33:34Z

Logixoul: /* Required Software */ don't repeat ourselves

{{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=[http://kdesvn-build.kde.org/ kdesvn-build: The KDE From Subversion Build Tool] [[../../Increased_Productivity_in_KDE4_with_Scripts|Increased Productivity in KDE4 with Scripts]] [[Development/Tutorials/CMake |Introduction to CMake]] [[../KDE4/FreeBSD|FreeBSD notes]] [[../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. There are also tutorials for [[/FreeBSD|FreeBSD]], [http://www.kdelibs.com/ Windows], [[/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 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, 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 part of kdesdk. You can install it as part of kdesdk (kdesdk-scripts on Debian) or similar package, or just download it itself from [http://websvn.kde.org/*checkout*/trunk/KDE/kdesdk/scripts/makeobj WebSVN]
* the [http://freedesktop.org/wiki/Software/shared-mime-info shared-mime-info package], which is the freedesktop MIME standard KDE is using now
* [http://boost.org/ boost], needed by kdebase; after compiling and/or installing boost, in order to make cmake aware about its location (FindBoost), add boost directory (the one containing include subdirectory) to CMAKE_INCLUDE_PATH or set an environment variable called BOOST_ROOT pointing to boost directory.

=== Kubuntu ===

In Kubuntu 7.04 (Feisty) the build dependencies you need are installed with:
<code bash>
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 libpng-dev subversion libsm-dev libxinerama-dev \
libxrender-dev libfontconfig-dev libboost-dev libxcursor-dev doxygen \
libungif4-dev libdbus-1-dev libgpgme11-dev libssl-dev
</code>

You can skip the manual installation of CMake 2.4.6 and DBus with:
<code bash>
sudo aptitude install libdbus-1-dev cmake
</code>

And for fully functional [[apidox]] frame work you also need:
<code bash>
sudo aptitude install graphviz
</code>

=== 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++
</code>

'''Optional Packages'''

You can skip the manual installation of Qt 4.3, CMake 2.4.6 and DBus by installing the adding the openSUSE Build Service KDE4 Repository 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 (and their dependencies):
<code>
cmake
dbus-1-devel
libqt4-devel
</code>

And for fully functional apidox frame work you also need:
<code>
graphviz
</code>

CMake binary packages for openSUSE are available from [http://software.opensuse.org/download/devel:/tools:/building/ openSUSE build service].

=== Gentoo ===

You can use most stable ebuilds just remember to sync your portage before you begin.

We need to be unmasked and/or kept at a lower version to continue.

<code bash>
# echo 'x11-libs/qt' >> /etc/portage/package.keywords
# echo 'dev-util/cmake' >> /etc/portage/package.keywords
# echo 'dev-cpp/clucene' >> /etc/portage/package.keywords
# echo '>dev-cpp/clucene-0.9.16a' >> /etc/portage/package.mask
</code>

These are the packages you will need to install, some may already be installed so you may skip those by adding the update flag to emerge.

<code bash>
$ emerge -avu ebuild/name
</code>

sys-devel/gcc
dev-util/subversion
dev-util/pkgconfig
x11-base/xorg-x11
media-libs/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
kde-base/kdesdk-scripts
dev-libs/boost
x11-libs/qt
dev-util/cmake
sys-apps/dbus
dev-libs/redland

Provided you have emerged these ebuilds, you can skip compiling them by hand and proceed to [[Getting_Started/Build/KDE4#kdesupport|kdesupport section]].

Good luck!

== 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>

=== 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. 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>
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 {{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.

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

=== 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>.

== 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 the Qt4 that is in KDE's source repository. KDE is guaranteed to build against any Qt 4.3. Qt 4.2 and earlier are not supported and will not work. You should use the copy in the KDE Subversion servers.

=== The Recipe ===
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 -openssl -nomake examples \
-nomake demos
make -j2

# do copy files if the target doesnt match current dir,
# clear obj files to save disk space otherwise
if [ $QTDIR = `pwd` ]; then \
find . -name '*.o' -exec rm {} \; ; \
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-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 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.

== kdesupport ==

{{warning|If you have jumped to this section without reading [[Getting_Started/Build/KDE4#Setting_up_the_environment|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. Your environment '''needs''' to be set up correctly for these instructions to work for you.}}

There are several libraries that KDE applications rely on in the kdesupport module. This includes Strigi and Soprano for file metadata and search, 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.16; version 0.9.17 does '''not''' work), and either libxml2 or libexpat.

=== The Recipe ===

cs # [[Getting_Started/Increased_Productivity_in_KDE4_with_Scripts/.bashrc|cs is not a typo]]
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|~/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
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?

== kdelibs ==

With Qt4, Strigi, and Soprano 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.

=== The Recipe ===

cs # bash function
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|~/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#Required_Software|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|~/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 \
~/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 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, 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)

== 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 not a typo]]
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|~/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 ==
You may need kdebase for some kioslaves.

cs KDE # [[Getting_Started/Increased_Productivity_in_KDE4_with_Scripts/.bashrc|cs is not a typo]]
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)

== 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 not a typo]]
$KDE_SRC/KDE/kdelibs/doc/api/doxygen.sh \
--doxdatadir=$KDE_SRC/KDE/kdelibs/doc/common .

Repeat for other modules as desired. 
cd <module home>
$KDE_SRC/KDE/kdelibs/doc/api/doxygen.sh \
--doxdatadir=$KDE_SRC/KDE/kdelibs/doc/common .

== 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>

== 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.

== 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-07-04T03:08:17Z

Logixoul: /* Abstract */ brevity

{{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=[http://kdesvn-build.kde.org/ kdesvn-build: The KDE From Subversion Build Tool] [[../../Increased_Productivity_in_KDE4_with_Scripts|Increased Productivity in KDE4 with Scripts]] [[Development/Tutorials/CMake |Introduction to CMake]] [[../KDE4/FreeBSD|FreeBSD notes]] [[../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. There are also tutorials for [[/FreeBSD|FreeBSD]], [http://www.kdelibs.com/ Windows], [[/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 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, 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 part of kdesdk. You can install it as part of kdesdk (kdesdk-scripts on Debian) or similar package, or just download it itself from [http://websvn.kde.org/*checkout*/trunk/KDE/kdesdk/scripts/makeobj WebSVN]
* the [http://freedesktop.org/wiki/Software/shared-mime-info shared-mime-info package], which is the freedesktop MIME standard KDE is using now
* [http://boost.org/ boost], needed by kdebase; after compiling and/or installing boost, in order to make cmake aware about its location (FindBoost), add boost directory (the one containing include subdirectory) to CMAKE_INCLUDE_PATH or set an environment variable called BOOST_ROOT pointing to boost directory.

You may also want to have the following installed:
* bash

=== Kubuntu ===

In Kubuntu 7.04 (Feisty) the build dependencies you need are installed with:
<code bash>
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 libpng-dev subversion libsm-dev libxinerama-dev \
libxrender-dev libfontconfig-dev libboost-dev libxcursor-dev doxygen \
libungif4-dev libdbus-1-dev libgpgme11-dev libssl-dev
</code>

You can skip the manual installation of CMake 2.4.6 and DBus with:
<code bash>
sudo aptitude install libdbus-1-dev cmake
</code>

And for fully functional [[apidox]] frame work you also need:
<code bash>
sudo aptitude install graphviz
</code>

=== 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++
</code>

'''Optional Packages'''

You can skip the manual installation of Qt 4.3, CMake 2.4.6 and DBus by installing the adding the openSUSE Build Service KDE4 Repository 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 (and their dependencies):
<code>
cmake
dbus-1-devel
libqt4-devel
</code>

And for fully functional apidox frame work you also need:
<code>
graphviz
</code>

CMake binary packages for openSUSE are available from [http://software.opensuse.org/download/devel:/tools:/building/ openSUSE build service].

=== Gentoo ===

You can use most stable ebuilds just remember to sync your portage before you begin.

We need to be unmasked and/or kept at a lower version to continue.

<code bash>
# echo 'x11-libs/qt' >> /etc/portage/package.keywords
# echo 'dev-util/cmake' >> /etc/portage/package.keywords
# echo 'dev-cpp/clucene' >> /etc/portage/package.keywords
# echo '>dev-cpp/clucene-0.9.16a' >> /etc/portage/package.mask
</code>

These are the packages you will need to install, some may already be installed so you may skip those by adding the update flag to emerge.

<code bash>
$ emerge -avu ebuild/name
</code>

sys-devel/gcc
dev-util/subversion
dev-util/pkgconfig
x11-base/xorg-x11
media-libs/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
kde-base/kdesdk-scripts
dev-libs/boost
x11-libs/qt
dev-util/cmake
sys-apps/dbus
dev-libs/redland

Provided you have emerged these ebuilds, you can skip compiling them by hand and proceed to [[Getting_Started/Build/KDE4#kdesupport|kdesupport section]].

Good luck!

== 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>

=== 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. 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>
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 {{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.

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

=== 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>.

== 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 the Qt4 that is in KDE's source repository. KDE is guaranteed to build against any Qt 4.3. Qt 4.2 and earlier are not supported and will not work. You should use the copy in the KDE Subversion servers.

=== The Recipe ===
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 -openssl -nomake examples \
-nomake demos
make -j2

# do copy files if the target doesnt match current dir,
# clear obj files to save disk space otherwise
if [ $QTDIR = `pwd` ]; then \
find . -name '*.o' -exec rm {} \; ; \
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-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 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.

== kdesupport ==

{{warning|If you have jumped to this section without reading [[Getting_Started/Build/KDE4#Setting_up_the_environment|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. Your environment '''needs''' to be set up correctly for these instructions to work for you.}}

There are several libraries that KDE applications rely on in the kdesupport module. This includes Strigi and Soprano for file metadata and search, 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.16; version 0.9.17 does '''not''' work), and either libxml2 or libexpat.

=== The Recipe ===

cs # [[Getting_Started/Increased_Productivity_in_KDE4_with_Scripts/.bashrc|cs is not a typo]]
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|~/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
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?

== kdelibs ==

With Qt4, Strigi, and Soprano 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.

=== The Recipe ===

cs # bash function
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|~/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#Required_Software|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|~/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 \
~/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 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, 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)

== 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 not a typo]]
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|~/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 ==
You may need kdebase for some kioslaves.

cs KDE # [[Getting_Started/Increased_Productivity_in_KDE4_with_Scripts/.bashrc|cs is not a typo]]
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)

== 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 not a typo]]
$KDE_SRC/KDE/kdelibs/doc/api/doxygen.sh \
--doxdatadir=$KDE_SRC/KDE/kdelibs/doc/common .

Repeat for other modules as desired. 
cd <module home>
$KDE_SRC/KDE/kdelibs/doc/api/doxygen.sh \
--doxdatadir=$KDE_SRC/KDE/kdelibs/doc/common .

== 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>

== 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.

== 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-07-04T02:58:27Z

Logixoul: /* D-Bus */ duh

{{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=[http://kdesvn-build.kde.org/ kdesvn-build: The KDE From Subversion Build Tool] [[../../Increased_Productivity_in_KDE4_with_Scripts|Increased Productivity in KDE4 with Scripts]] [[Development/Tutorials/CMake |Introduction to CMake]] [[../KDE4/FreeBSD|FreeBSD notes]] [[../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.

{{warning|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, 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 part of kdesdk. You can install it as part of kdesdk (kdesdk-scripts on Debian) or similar package, or just download it itself from [http://websvn.kde.org/*checkout*/trunk/KDE/kdesdk/scripts/makeobj WebSVN]
* the [http://freedesktop.org/wiki/Software/shared-mime-info shared-mime-info package], which is the freedesktop MIME standard KDE is using now
* [http://boost.org/ boost], needed by kdebase; after compiling and/or installing boost, in order to make cmake aware about its location (FindBoost), add boost directory (the one containing include subdirectory) to CMAKE_INCLUDE_PATH or set an environment variable called BOOST_ROOT pointing to boost directory.

You may also want to have the following installed:
* bash

=== Kubuntu ===

In Kubuntu 7.04 (Feisty) the build dependencies you need are installed with:
<code bash>
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 libpng-dev subversion libsm-dev libxinerama-dev \
libxrender-dev libfontconfig-dev libboost-dev libxcursor-dev doxygen \
libungif4-dev libdbus-1-dev libgpgme11-dev libssl-dev
</code>

You can skip the manual installation of CMake 2.4.6 and DBus with:
<code bash>
sudo aptitude install libdbus-1-dev cmake
</code>

And for fully functional [[apidox]] frame work you also need:
<code bash>
sudo aptitude install graphviz
</code>

=== 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++
</code>

'''Optional Packages'''

You can skip the manual installation of Qt 4.3, CMake 2.4.6 and DBus by installing the adding the openSUSE Build Service KDE4 Repository 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 (and their dependencies):
<code>
cmake
dbus-1-devel
libqt4-devel
</code>

And for fully functional apidox frame work you also need:
<code>
graphviz
</code>

CMake binary packages for openSUSE are available from [http://software.opensuse.org/download/devel:/tools:/building/ openSUSE build service].

=== Gentoo ===

You can use most stable ebuilds just remember to sync your portage before you begin.

We need to be unmasked and/or kept at a lower version to continue.

<code bash>
# echo 'x11-libs/qt' >> /etc/portage/package.keywords
# echo 'dev-util/cmake' >> /etc/portage/package.keywords
# echo 'dev-cpp/clucene' >> /etc/portage/package.keywords
# echo '>dev-cpp/clucene-0.9.16a' >> /etc/portage/package.mask
</code>

These are the packages you will need to install, some may already be installed so you may skip those by adding the update flag to emerge.

<code bash>
$ emerge -avu ebuild/name
</code>

sys-devel/gcc
dev-util/subversion
dev-util/pkgconfig
x11-base/xorg-x11
media-libs/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
kde-base/kdesdk-scripts
dev-libs/boost
x11-libs/qt
dev-util/cmake
sys-apps/dbus
dev-libs/redland

Provided you have emerged these ebuilds, you can skip compiling them by hand and proceed to [[Getting_Started/Build/KDE4#kdesupport|kdesupport section]].

Good luck!

== 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>

=== 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. 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>
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 {{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.

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

=== 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>.

== 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 the Qt4 that is in KDE's source repository. KDE is guaranteed to build against any Qt 4.3. Qt 4.2 and earlier are not supported and will not work. You should use the copy in the KDE Subversion servers.

=== The Recipe ===
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 -openssl -nomake examples \
-nomake demos
make -j2

# do copy files if the target doesnt match current dir,
# clear obj files to save disk space otherwise
if [ $QTDIR = `pwd` ]; then \
find . -name '*.o' -exec rm {} \; ; \
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-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 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.

== kdesupport ==

{{warning|If you have jumped to this section without reading [[Getting_Started/Build/KDE4#Setting_up_the_environment|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. Your environment '''needs''' to be set up correctly for these instructions to work for you.}}

There are several libraries that KDE applications rely on in the kdesupport module. This includes Strigi and Soprano for file metadata and search, 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.16; version 0.9.17 does '''not''' work), and either libxml2 or libexpat.

=== The Recipe ===

cs # [[Getting_Started/Increased_Productivity_in_KDE4_with_Scripts/.bashrc|cs is not a typo]]
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|~/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
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?

== kdelibs ==

With Qt4, Strigi, and Soprano 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.

=== The Recipe ===

cs # bash function
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|~/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#Required_Software|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|~/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 \
~/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 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, 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)

== 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 not a typo]]
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|~/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 ==
You may need kdebase for some kioslaves.

cs KDE # [[Getting_Started/Increased_Productivity_in_KDE4_with_Scripts/.bashrc|cs is not a typo]]
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)

== 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 not a typo]]
$KDE_SRC/KDE/kdelibs/doc/api/doxygen.sh \
--doxdatadir=$KDE_SRC/KDE/kdelibs/doc/common .

Repeat for other modules as desired. 
cd <module home>
$KDE_SRC/KDE/kdelibs/doc/api/doxygen.sh \
--doxdatadir=$KDE_SRC/KDE/kdelibs/doc/common .

== 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>

== 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.

== 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]]