|
|
| (119 intermediate revisions by 31 users not shown) |
| Line 1: |
Line 1: |
| {{Template:I18n/Language Navigation Bar|Getting_Started/Build/KDE4}}
| | #REDIRECT [[Getting_Started/Build|Building KDE]] |
| | |
| {{TutorialBrowser|
| |
| | |
| series=Getting Started|
| |
| | |
| name=Building KDE4 From Source|
| |
| | |
| pre=[[../../Sources/Anonymous_SVN|Anonymous SVN Quickstart Guide]]|
| |
| | |
| next=[[../../Set_up_KDE_4_for_development|Set up KDE 4 for development]]|
| |
| | |
| reading=[[../kdesvn-build|kdesvn-build: The KDE From Subversion Build Tool]]<br>[[../../Increased_Productivity_in_KDE4_with_Scripts|Increased Productivity in KDE4 with Scripts]]<br>[[Development/Tutorials/CMake |Introduction to CMake]]<br>[[../KDE4/FreeBSD|FreeBSD notes]]<br>[[../KDE4/Mac OS X|Instructions for Mac OS X]]<br>[[../KDE4/Windows|Instructions for MS Windows]]|
| |
| }}
| |
| | |
| == Abstract ==
| |
| | |
| This tutorial shows one way to get KDE from trunk running on Linux/BSD systems. There are also tutorials for [[Getting_Started/Build/KDE4/FreeBSD|FreeBSD]], [http://www.kdelibs.com/ Windows], [[Getting_Started/Build/KDE4/Mac OS X|Mac OS X]] and [http://solaris.kde.org/ Solaris]. Throughout the tutorial the bash shell is used.
| |
| | |
| {{warning|Expect a higher risk of build failure '''on Mondays''' when most kdelibs changes are committed. [http://developer.kde.org/~dirk/dashboard/ Dashboard] reports unexpected breakages. You are encouraged to fix failing modules.
| |
| }}
| |
| | |
| == Software Requirements ==
| |
| | |
| The following needs to be installed to successfully use this tutorial:
| |
| * gcc and g++, preferably version 4.2 or higher
| |
| * svn, the subversion revision control client
| |
| * pkg-config
| |
| * development libraries and headers for X11, OpenGL (mesa-common-dev and libglu1-mesa-dev), libjpeg, libpng, libungif, [http://clucene.sourceforge.net/index.php/Downloads libclucene], [http://download.librdf.org/source/ librdf], libxml2 and libxslt
| |
| * the <tt>makeobj</tt> script, which is included in kdesdk. You can install it from kdesdk (kdesdk-scripts on Debian) or similar packages, or download at [http://websvn.kde.org/*checkout*/trunk/KDE/kdesdk/scripts/makeobj WebSVN]
| |
| * the [http://freedesktop.org/wiki/Software/shared-mime-info shared-mime-info package], is the freedesktop MIME standard now used in KDE
| |
| * [http://boost.org/ boost], used by kdebase; after build and/or install, in order to make cmake aware about its location (FindBoost), add the boost directory (which contains the include subdirectory) to CMAKE_INCLUDE_PATH or set a environment variable called BOOST_ROOT that points to the boost directory.
| |
| | |
| | |
| == 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 ===
| |
| {{Note|
| |
| On some systems a new user is configured by default to use {{path|/bin/sh}}. Using {{path|/bin/sh}} can be very inconvenient to work with and you may want to change it to {{path|/bin/bash}} or another shell.
| |
| On Ark Linux and Fedora, you can skip the <tt>-s /bin/bash</tt> switch - {{path|/bin/sh}} is {{path|bash}}.
| |
| }}
| |
| <code bash>
| |
| useradd -m kde-devel -s /bin/bash
| |
| passwd kde-devel
| |
| </code>
| |
| | |
| | |
| {{Warning|
| |
| The new kde-devel user will not be added automatically to all the user groups, which will result in not having sound, not being able to sudo, etc. Edit your /etc/groups file to add the kde-devel user to all the groups that you need (probably the groups that your usual username is already assigned to).
| |
| }}
| |
| | |
| === Option 2: Using KControl ===
| |
| | |
| Instead of using the commands above, you can also use the User module in the KDE Control Center if you already have KDE3 installed.
| |
| | |
| === Setting up the environment ===
| |
| | |
| Copy the {{path|~/.bashrc}} from your normal user account to the new kde-devel account. Next, copy and paste the contents of the [[Getting Started/Increased Productivity in KDE4 with Scripts/.bashrc|example .bashrc]] into {{path|~kde-devel/.bashrc}}. Be sure to comment out the line <tt>alias make=makeobj</tt> if you do not have the <tt>[[Getting Started/Build/KDE4#Required Software|makeobj]]</tt> command available. You will probably also want to modify the path to make sure it doesn't include your kde3 paths. Also if you want to use KDevelop to develop KDE 4 applications you may pass the ''-GKDevelop3'' flag to the ''cmake'' command (to make CMake generate KDevelop project files, it will help to avoid rebuilding in the future, see [[Getting_Started/Set_up_KDE_4_for_development#Setting_up_the_environment|this]]).
| |
| To make it run, you have to open a new bash or to execute
| |
| <code bash>
| |
| source ~/.bashrc
| |
| </code>
| |
| | |
| This will provide access to commands such as <tt>cmakekde</tt> that are used in this tutorial as well as ensure that the proper paths are in place for Qt, KDE and CMake binaries.
| |
| | |
| For more information, please read the [[Getting Started/Increased Productivity in KDE4 with Scripts]] tutorial.
| |
| | |
| === Switching to the New User ===
| |
| Switch to the user kde-devel: (don't forget the dash)
| |
| <code bash>
| |
| ssh -X kde-devel@localhost
| |
| </code>
| |
| | |
| {{Note|
| |
| If the ssh command fails, check out the [[Getting_Started/Set_up_KDE_4_for_development#Launching_KDE_4_apps|Launching KDE 4 apps]] section of the [[Getting_Started/Set_up_KDE_4_for_development|KDE4 development guide]].
| |
| }}
| |
| | |
| == Required packages from your distribution ==
| |
| The requirements to build kde4 from source vary from distribution to distribution. Instructions for your distribution are provided below:
| |
| | |
| * [[/Ark Linux|Ark Linux]]
| |
| * [[/Arch Linux|Arch Linux]]
| |
| * [[/Fedora|Fedora]]
| |
| * [[/Kubuntu and Debian|Kubuntu and Debian]]
| |
| * [[/openSUSE|openSUSE]]
| |
| * [[/Gentoo|Gentoo]]
| |
| * [[/Mandriva|Mandriva]]
| |
| | |
| Your next compilation step depends on the packages supplied by your distro. Instructions for building all dependancies including HAL, Cmake, Qt4 and kde-support are available in [[/Prerequisites|the build prerequisites page]].
| |
| | |
| == kdelibs ==
| |
| | |
| We can now move on to building KDE's base libraries.
| |
| | |
| === The Recipe ===
| |
| cd
| |
| cs # [[Getting_Started/Increased_Productivity_in_KDE4_with_Scripts/.bashrc|'cs' is a bash function, click here to learn more]]
| |
| mkdir KDE && cd KDE
| |
| svn checkout svn://anonsvn.kde.org/home/kde/branches/KDE/4.0/kdelibs
| |
| cd kdelibs
| |
| cmakekde
| |
| | |
| === What's Happening ===
| |
| We change to the base source directory (line 1) then make and go into the KDE directory (line 2). We download the sources for kdelibs using subversion (line 3), go into the new {{path|~/kde/src/KDE/kdelibs}} directory (line 4), and commence the build (line 5). This will leave us in the <tt>kdelibs</tt> build directory after the build is completed.
| |
| | |
| {{tip|There might be missing dependencies on your system! They are easily overlooked in the output of <tt>cmakekde</tt>.
| |
| You might want to do a <tt>cmake $KDE_SRC/KDE/MODULE_NAME</tt> prior to compiling any kde modules (like kdelibs, kdepimlibs etc.)}}
| |
| | |
| === Additional KDE-specific CMake modules ===
| |
| There are additional CMake modules in {{path|kdelibs/cmake/modules/}} that are necessary for building KDE4 applications. These will be installed for you when kdelibs itself is installed.
| |
| | |
| === Troubleshooting ===
| |
| If you have problems compiling kdelibs, first make sure the software in the [[Getting_Started/Build/KDE4#Software_Requirements|Required Software]] section above is installed and works. Other possible hints include:
| |
| * If the <tt>cmakekde</tt> command fails stating that CMake requires an out of source build directory, remove {{path|~/kde/src/KDE/kdelibs/CMakeCache.txt}}, and try again.
| |
| | |
| If <tt>cmakekde</tt> still gives the same error then try this
| |
| cd
| |
| cmake -DCMAKE_INSTALL_PREFIX=$KDEDIR \
| |
| -DCMAKE_BUILD_TYPE=debugfull \
| |
| -DKDE4_BUILD_TESTS=ON \
| |
| ~/kde/src/KDE/kdelibs
| |
| make
| |
| make install
| |
| * If you received an error stating "Please create a separate build directory and run 'cmake path_to_kdelibs [options]' there.", then you need to change to your build directory before running cmakekde. (e.g <tt>cs KDE/kdelibs && cb && cmakekde</tt>) If the message stays, run 'svn status' in the kdelibs directory and remove all files labeled with '?'.
| |
| * If Qt wasn't found or the wrong version of Qt was found, make sure that the qmake from the Qt you need is the first qmake in the path.
| |
| * If qmake wasn't found and you are using Debian packages, /usr/bin/qmake probably points to a wrong qmake version. To fix this run as root:
| |
| update-alternatives --config qmake
| |
| * If the problems persist, try the CMake make-option <tt>--keep-going</tt>.
| |
| * Here you need the libungif library, otherwise you will get an error message like "<tt>Could NOT find GIF</tt>".
| |
| * Qt-4.3 upgrade: if you get a link error in kjsembed talking about QScriptEngine, edit CMakeCache.txt in kdelibs and remove the lines that talk about QT_QTUITOOLS_LIBRARY, then type make again (that static library has a new dependency, and the cmake code that adds it needs to run).
| |
| * if you get <code>CMake Error: KDE Requires Qt to be built with SSL support
| |
| </code>, install openssl-devel, remove CMakeCache.txt and re-compile QT.
| |
| * if you get <code>kdelibs/kimgio/ico.cpp:188: undefined reference to `QImage::jumpTable()'</code> it means you compiled QT without QT3 support(no, linking to a true QT3 install won't work)
| |
| * if none of the errors above match yours, you might just try a quick'n'dirty <code>make clean</code> in kdelibs.
| |
| * 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
| |
| | |
| == kdepimlibs ==
| |
| After <tt>kdelibs</tt>, but before ''kdebase'', you need to build and install ''kdepimlibs''.
| |
| | |
| === The Recipe ===
| |
| <!--'cs' and 'cb' are NOT typos!-->
| |
| cs KDE # [[Getting_Started/Increased_Productivity_in_KDE4_with_Scripts/.bashrc|'cs' is a bash function, click here to learn more]]
| |
| svn checkout svn://anonsvn.kde.org/home/kde/branches/KDE/4.0/kdepimlibs
| |
| cd kdepimlibs
| |
| cmakekde
| |
| | |
| === What's Happening ===
| |
| We go into the KDE source directory (line 1), download the source code for kdepimlibs using subversion (line 2) and then go into the new {{path|~/kde/src/KDE/kdepimlibs}} directory (line 3). We then commence the build (line 4). This will leave us in the <tt>kdepimlibs</tt> build directory after the build is completed.
| |
| | |
| === Troubleshooting ===
| |
| If you have trouble compiling kdepimlibs:
| |
| * the cmakekde command may require a later version of the gpgme library. This is available from the project's web site: http://www.gnupg.org/(en)/download/index.html - please note that the build of gpgme also requires libgpg-error, also available from the same location. Both libraries are installed by the "./configure", "make" and "sudo make install" sequence, with the gpgme library configured with the additional "--with-gpg-error-prefix" parameter. You may need to overwrite your existing "/usr/bin/gpgme-config" file with the newer version for the kdepimlibs to pick up the new install.
| |
| | |
| == kdebase ==
| |
| kdebase is divided into three parts:
| |
| * '''apps'''
| |
| :This contains applications like Dolphin or KWrite.
| |
| * '''runtime'''
| |
| :This contains things needed by every application at runtime, like icons. It is a required dependency for each KDE application, so you have to compile and install this.
| |
| * '''workspace'''
| |
| :This contains things specific to the KDE desktop, like Plasma or the window manager. Most stuff here depends on X11. You only need it if you want to build a full KDE desktop.
| |
| | |
| You can build all of kdebase at once, which is described in the recipe below. If you only want to build kdebase-runtime, which is the only requirement, you can replace <code bash>cd kdebase</code> with <code bash>cd kdebase/runtime</code> in the recipe below.
| |
| | |
| === The Recipe ===
| |
| <!--'cs' and 'cb' are NOT typos!-->
| |
| cs KDE # [[Getting_Started/Increased_Productivity_in_KDE4_with_Scripts/.bashrc|'cs' is a bash function, click here to learn more]]
| |
| svn checkout svn://anonsvn.kde.org/home/kde/branches/KDE/4.0/kdebase
| |
| cd kdebase
| |
| cmakekde
| |
| | |
| === Troubleshooting ===
| |
| 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 meinproc</tt> has to deliver {{path|/home/kde-devel/kde/bin/meinproc}}
| |
| * if cmakekde can not find the path of kdepimlibs, edit the file {{path|$KDE_BUILD/KDE/kdebase/CMakeCache.txt}} and manually set <tt>KDEPIMLIBS_INCLUDE_DIR:PATH=$KDE_BUILD/kdepimlibs</tt>
| |
| * if you get an error saying "Please set the following variables: X11_XTest_LIB (ADVANCED)", install the devel package of <tt>Xtst</tt>. On some systems, this is packaged separately from <tt>xext</tt> and called <tt>x11proto-xext-dev</tt> or <tt>libxtst-dev</tt>. You may also need to remove the CMakeCache.txt file in the build dir after installing the package.
| |
| * the same for "X11_Xinerama_LIB (ADVANCED)" where you will need the devel package for <tt>xinerama</tt>.
| |
| * if you get an error complaining about a missing variable X11_Xrandr_LIB, you need the devel package for libxrandr (libxrandr-devel on ubuntu-systems)
| |
| * if you get the error "Please set the following variables: FONTCONFIG_INCLUDE_DIR, FONTCONFIG_LIBRARIES (ADVANCED)", then you need to install the libfontconfig headers
| |
| * if you get the error "CMake Error: This project requires some variables to be set, and cmake can not find them. Please set the following variables: KMETADATA_LIBRARIES", you need to install soprano from kdesupport and to rebuild kdelibs
| |
| * if you get the error "‘XserverRegion’ does not name a type" make sure you have libxcomposite headers installed (<tt>libxcomposite-dev</tt> in ubuntu)
| |
| * if you get the error "CMake Error: This project requires some variables to be set, and cmake can not find them. Please set the following variables: QT_QTOPENGL_LIBRARY (ADVANCED) ", try editing CMakeCache.txt and setting QT_QTOPENGL_LIBRARY:FILEPATH=/home/kde-devel/qt-copy/lib/libQtOpenGL.so
| |
| | |
| * if you get messages as "KDE4_INSTALL_HANDBOOK() is deprecated. Remove it please. Now all is done in KDE4_CREATE_HANDBOOK." then, either find the files containing the offending line and comment it out manually, or run the following script in ~/kde/src/KDE/kdebase: [http://www.plamadeala.com/files/macros_corrector.sh macros_corrector.sh]. It will just REMOVE the line that has "kde4_create_handbook" in it from all the found files.
| |
| *If you get an error (in ubuntu) concerning libxtst.so install the libxtst-dev package
| |
| * If you get the message "kdebase/workspace/kcontrol/kxkb/x11helper.cpp:131: error: ‘KGlobal’ has not been declared", you might need to install libxklavier development packages.
| |
| * If you get "/home/kde-devel/kde/lib/libkio.so: undefined reference to `Strigi::AnalysisResult::AnalysisResult(std::basic_string<char, std::char_traits<char>, std::allocator<char> > const&, long, Strigi::IndexWriter&, Strigi::StreamAnalyzer&)'" you probably have an outdated version of strigi installed by your distro. By the way, after update the strigi, you must recompile kdelibs for a new libkio.so.
| |
| | |
| == 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' and 'cb' are NOT typos!-->
| |
| cs KDE/kdelibs # [[Getting_Started/Increased_Productivity_in_KDE4_with_Scripts/.bashrc|'cs' is a bash function, click here to learn more]]
| |
| $KDE_SRC/KDE/kdelibs/doc/api/doxygen.sh \
| |
| --doxdatadir=$KDE_SRC/KDE/kdelibs/doc/common .
| |
| | |
| Repeat for other modules as desired.<br>
| |
| cd <module home>
| |
| $KDE_SRC/KDE/kdelibs/doc/api/doxygen.sh \
| |
| --doxdatadir=$KDE_SRC/KDE/kdelibs/doc/common .
| |
| | |
| Another, even easier method involves downloading this [[Doxyfile]] to your local system. Then simply change directory to where you want to create the documentation and run
| |
| <code bash>
| |
| % doxygen /path/to/Doxyfile
| |
| </code>
| |
| Then review the file {{path|doxygen.log}} to see the doxygen errors and warnings. You'll find the actual documentation in the {{path|apidocs}} subdirectory.
| |
| | |
| == Staying up to date ==
| |
| | |
| In order to keep the kde4 installation up to date, each of the modules installed should be updated periodically. As Monday is the day for big changes in kdelibs, Tuesday may be the best day to do this. For each module checked out, run <tt>svn up</tt> and <tt>make</tt>.
| |
| | |
| For example:
| |
| <code bash>
| |
| cs kdesupport # cs is not a typo
| |
| svn up
| |
| cb # cb is not a typo
| |
| make install
| |
| </code>
| |
| | |
| Note: it is not necessary to run cmakekde for updates.
| |
| | |
| == Installing a subset of a module ==
| |
| | |
| Many modules in KDE contain a large number of programs which could take a long time to download and compile. In cases where you want to work only on a particular program or programs in a module, it is possible to download and compile particular folders. In some cases, certain folders are required for any build of the module. This is determined in the CMakeLists.txt file of the module. For example the [http://websvn.kde.org/branches/KDE/4.0/kdegames/CMakeLists.txt?view=markup kdegames CMakeLists.txt file] lists:
| |
| | |
| <code>
| |
| add_subdirectory(libkdegames)
| |
| add_subdirectory(libkmahjongg)
| |
| | |
| macro_optional_add_subdirectory(doc)
| |
| macro_optional_add_subdirectory(lskat)
| |
| macro_optional_add_subdirectory(katomic)
| |
| </code>
| |
| | |
| So, the libkdegames and libkmahjongg directories are required to build any of kdegames. The cmake directory will also usually be required. All the other directories (doc, katomic etc) are optional. They will be built if present on your machine. In this example, we build kmahjongg and kbattleship:
| |
| | |
| <code bash>
| |
| cs KDE
| |
| svn co -N kdegames # The -N switch performs a non-recursive checkout
| |
| cd kdegames
| |
| svn up libkdegames # Get required directories
| |
| svn up libkmahjongg
| |
| svn up cmake
| |
| svn up kbattleship # Get optional directories
| |
| svn up kmahjongg
| |
| cmakekde
| |
| </code>
| |
| | |
| == General troubleshooting ==
| |
| | |
| What can happen over time, after some <tt>svn up</tt> commands, is that some of the tools used in the KDE build chain change their output format. For example, <tt>kcfg</tt> files are read by <tt>kconfig_compiler</tt> to produce configuration dialogs. CMake cannot detect those changes, and the compilation might fail. A workaround is to always force a re-generation of all such files:
| |
| find $KDE_SRC/KDE/kdebase -name "*.kcfg" | xargs touch
| |
| The same applies to <tt>ui</tt> files as produced by Qt designer.
| |
| | |
| === Locked sessions ===
| |
| When installing KDE 4 as a user, one will not be able to unlock a locked session. To work around this issue you can either:
| |
| su chown root.root $KDEDIR/lib/kde4/libexec/kcheckpass
| |
| or
| |
| chmod 755 $KDEDIR/lib/kde4/libexec/kcheckpass
| |
| | |
| 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>
| |
| | |
| == 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]]
| |
