Set this option to true in order to have Kdesvn-build automatically build and install the API documentation for the module after the normal build/install process. This only works for modules where make apidox does something, including kdelibs, kdebase and koffice, among others.

This option does not work for modules using Unsermake support, due to deficiencies in the Unsermake build system. This option does not work for KDE 4 modules because the required build system support has been migrated to a different program which Kdesvn-build has not been corrected to use yet.

This option enables the asynchronous mode of operation, where the source code update and the build process will be performed in parallel, instead of waiting for all of the source code updates before starting the build process. This option defaults to enabling asynchronous mode. To disable, set this option to false

This option is available since the 1.7 release.

Set this option to set the environment variable PATH while building. You cannot override this setting in a module option. The default value is /bin:/usr/bin:/usr/local/bin:/usr/X11R6/bin. This environment variable should include the colon-separated paths of your development toolchain. The paths $KDEDIR/bin and $QTDIR/bin are automatically added. You may use the tilde (~) for any paths you add using this option.

Set this option to checkout from a branch of KDE instead of the default of trunk, where KDE development occurs. For instance, to checkout KDE 3.4 branch, you would set this option to 3.4.

Note that some modules use a different branch name. Notably, the required arts module does not go by KDE version numbers. The arts that accompanied KDE 3.4 was version 1.4.

If Kdesvn-build fails to properly download a branch with this option, you may have to manually specify the URL to download from using the override-url option.

Use this option to specify what flags to pass to CMake when creating the build system for the module. When this is used as a global option, it is applied to all modules that this script builds. When used as a module option, it is added to the end of the global options. This allows you to specify common CMake options in the global section.

This option replaces configure-flags for all KDE 4 modules, since they use CMake to build.

Since these options are passed directly to the CMake command line, they should be given as they would be typed into CMake. For example:

  cmake-options -DRPATH_STYLE=default

Since this is a hassle, Kdesvn-build takes pains to ensure that as long as the rest of the options are set correctly, you should be able to leave this option blank.

Use this option to specify what flags to pass to ./configure when creating the build system for the module. When this is used as a global-option, it is applied to all modules that this script builds. qt-copy uses a much different set of configure options than the rest of KDE, so this option overrides the global settings when applied to qt-copy.

This option applies to qt-copy and all KDE 3 modules. KDE 4 modules use CMake, which is controlled using the cmake-options option.

Use this option to set the DO_NOT_COMPILE environment variable prior to running the configure script. According to the KDE Developer FAQ, this should cause any top-level directory you pass to not be built. The directories should be space-separated.

Note that the sources to the programs will still be downloaded. You can use the checkout-only directive to choose directories that you want to check out.

Set this option to the e-mail address Kdesvn-build should send from should it ever need to send e-mail. You do not need to worry about this if you do not use any feature which send e-mail. (They are all disabled by default).

Currently only email-on-compile-error needs this option.

You can set this option to the email address to send a report to when a module fails to build. Kdesvn-build will wait until all the modules are done and collate all of the results in the report. The report is only sent if a module fails to build.

Please see the email-address option to set the address Kdesvn-build should send from, since the default is usually not what you want.

This is the opposite of the do-not-compile option. This option makes it so that only the given top-level directories are built. The directories should be space-separated.

Any changes do not take effect until the next time make -f Makefile.cvs is run, either automatically by the script, or manually by the --refresh-build or --recreate-configure options.

Note that the sources to the programs will still be downloaded. You can use the checkout-only directive to choose directories that you want to check out.

This option allows you to choose to download and install localization packages along with KDE. You might do this if you do not live in the United States and would like to KDE translated into your native language.

To use this option, set it to a space-separated list of languages to install. Each language has a language code associated with it, which you can look up at this page: http://i18n.kde.org/teams/.

It is alright to choose only one language. By default, none are downloaded, which means KDE will display in American English.

For instance, to choose to install French, you would set the option to something like: kde-languages fr. You would still need to use KControl in order to choose the French language, however.

Set this option to override Kdesvn-build's default directory path to the module in question. This can be used, for example, to pull specific branches or tagged versions of libraries. The KDE Source Viewer is invaluable in helping to pick the right path.

Note that Kdesvn-build constructs the final path according to the following template: $svn-server/home/kde/$module-base-path/$module-name.

The default value is either “trunk” or “trunk/KDE”, depending on the module name.

If you are low on hard disk space, you may want to use this option in order to automatically delete the build directory (or both the source and build directories for one-time installs) after the module is successfully installed.

Possible values for this option are:

Note that using this option can have a significant detrimental impact on both your bandwidth usage (if you use all) and the time taken to compile KDE, since Kdesvn-build will be unable to perform incremental builds.

This option accepts a space-separated set of values, where the first value is the environment variable to set, and the rest of the values is what you want the variable set to. For example, to set the variable RONALD to McDonald, you would put in the appropriate section this command:

set-env RONALD McDonald

This option is special in that it can be repeated without overriding earlier set-env settings in the same section of the configuration file. This way you can set more than one environment variable per module (or globally).

Use this option to download a specific release of a module.

Note: The odds are very good that you do not want to use this option. KDE releases are available in tarball form from The KDE FTP site or one of its mirrors.

If you are using Kdesvn-build because you have having trouble getting a KDE release to build on your distribution, consider using the Konstruct build tool instead, which works from the release tarballs.

Since Kdesvn-build has support for building KDE 3 and 4, there needs to be some way to tell which version to build. By default, Kdesvn-build will build the main line of KDE development (called /trunk). But, this is for KDE 4, which is not yet ready for wide release.

You can use the branch option globally or for a module in order to download for KDE 3.5 (or 3.4, etc.). However, this is not convenient as some modules (such as kdesupport) are shared by 3.5 and 4. In addition, it is a lot of branch options that must be added to the configuration file.

So, if you set this global option to true, Kdesvn-build will automatically download the KDE 3.5 version of modules such as kdelibs and qt-copy, instead of downloading the KDE 4 version. You can still use the branch or tag options for a module to override the setting that Kdesvn-build picks. This way you can easily choose to download KDE 3.5 instead of the pre-release KDE 4.

Set this option to true in order to use the experimental Unsermake program instead of Automake when running the configure script. This can lead to some serious decreases in build time, especially for distributed building systems. This option defaults to true (for most modules).

Normally if you use this option Kdesvn-build will automatically keep Unsermake up-to-date. This may start to get annoying, especially if you are managing Unsermake yourself. If this is the case, you can set this option to “self”, and Kdesvn-build will still use Unsermake, but will not do anything special to keep it updated.