Enables the asynchronous mode, which can perform the source code updates and module builds at the same time. This is the default, this option only needs specified if you have disabled it in the configuration.

Only display simple help on this script.

Display the program version.

Displays information about kdesrc-build and the operating system, that may prove useful in bug reports or when asking for help in forums or mailing lists.

Available since version 18.11.

Has kdesrc-build perform the one-time initial setup necessary to prepare the system for kdesrc-build to operate, and for the newly-installed KDE software to run.

This includes:

Available since version 18.11.

Display contact information for the author.

Enable colorful output. (This is the default for interactive terminals).

This value adjusts the computer CPU priority requested by kdesrc-build, and should be in the range of 0-20. 0 is highest priority (because it is the least “nice”), 20 is lowest priority. kdesrc-build defaults to 10.

Disables the asynchronous mode of updating. Instead the update will be performed in its entirety before the build starts. This option will slow down the overall process, but if you encounter IPC errors while running kdesrc-build try using this option, and submitting a bug report.

Disable colorful output.

kdesrc-build will run through the update and build process, but instead of performing any actions to update or build, will instead output what the script would have done (e.g. what commands to run, general steps being taken, etc.).

Do not be as noisy with the output. With this switch only the basics are output.

Only output warnings and errors.

Be very descriptive about what is going on, and what kdesrc-build is doing.

Only perform the source update. (The --svn-only is only supported for compatibility with older scripts).

Only perform the build process.

Only perform the install process.

Only perform the metadata download process. kdesrc-build normally handles this automatically, but you might manually use this to allow the --pretend command line option to work.

Use this option to build only those modules which failed to build on a previous kdesrc-build run. This is useful if a significant number of failures occurred mixed with successful builds. After fixing the issue causing the build failures you can then easily build only the modules that failed previously.

This option was added for kdesrc-build 15.09.

This option causes kdesrc-build to automatically include other KDE and Qt™ modules in the build, if required for the modules you have requested to build on the command line or in your configuration file.

The modules that are added are as recorded within the KDE source code management system. See the section called “The official KDE module database”.

The corresponding configure file option is include-dependencies.

You can also use --no-include-dependencies, which turns off automatic inclusion of additional dependency modules.

Do not include the modules passed on the rest of the command line in the update/build process (this is useful if you want to build most of the modules in your configuration file and just skip a few).

Skip contacting the Subversion server. (The --no-svn parameter is only supported for compatibility with older versions of the script).

Skip the build process.

Do not automatically download the extra metadata needed for KDE git modules. The source updates for the modules themselves will still occur unless you pass --no-src as well.

This can be useful if you are frequently re-running kdesrc-build since the metadata does not change very often. But note that many other features require the metadata to be available. You might want to consider running kdesrc-build with the --metadata-only option one time and then using this option for subsequent runs.

Do not automatically install packages after they are built.

This option explicitly disables skipping the build process (an optimization controlled by the build-when-unchanged option). This is useful for making kdesrc-build run the build when you have changed something that kdesrc-build cannot check.

--force-build performs the exact same function, and is perhaps easier to remember.

Enables debug mode for the script. Currently this means that all output will be dumped to the standard output in addition to being logged in the log directory like normal. Also, many functions are much more verbose about what they are doing in debugging mode.

This command causes kdesrc-build to query a parameter of the modules in the build list (either passed on the command line or read in from the configuration file), outputting the result to screen (one module per line).

This option must be provided with a “query mode”, which should be one of the following:

If a single module is passed on the command line, then the output is simply the value of the parameter being queried. If multiple (or no) modules are passed on the command line, then each line is prefixed by the name of the module. Either way, kdesrc-build stops running once each value is output.

This option was added with kdesrc-build 16.05.

kactivities: master
kdepim: master

Do not try to rebuild modules that have failed building from scratch. kdesrc-build will never try to do this to a module that already was tried to be built from scratch.

Recreate the build system and make from scratch.

Run cmake (for KDE modules) or configure (for Qt™) again, without cleaning the build directory. You should not normally have to specify this, as kdesrc-build will detect when you change the relevant options and automatically re-run the build setup. This option is implied if --refresh-build is used.

This option is used to resume the build starting from the given module, which should be the next option on the command line. You should not specify other module names on the command line.

See also: --resume-after and the section called “Resuming a failed or canceled build”. You would prefer to use this command line option if you have fixed the build error and want kdesrc-build to complete the build.

This option is used to resume the build starting after the given module, which should be the next option on the command line. You should not specify other module names on the command line.

See also: --resume-from and the section called “Resuming a failed or canceled build”. You would prefer to use this command line option if you have fixed the build error and have also built and installed the module yourself, and want kdesrc-build to start again with the next module.

This option can be used to run kdesrc-build after it has had a build failure.

It resumes the build from the module that failed, using the list of modules that were waiting to be built before, and disables source and metadata updates as well. The use case is when a simple mistake or missing dependency causes the build failure. Once you correct the error you can quickly get back into building the modules you were building before, without fiddling with --resume-from and --stop-before.

This is even handier with the --stop-on-failure command line argument, especially if you're initially setting up your development environment.

This option was added with kdesrc-build 1.16.

This command line option is used to stop the normal build process just before a module would ordinarily be built.

For example, if the normal build list was moduleA, moduleB, moduleC, then --stop-before=moduleB would cause kdesrc-build to only build moduleA.

This command line option was added with kdesrc-build 1.16.

This command line option is used to stop the normal build process just after a module would ordinarily be built.

For example, if the normal build list was moduleA, moduleB, moduleC, then --stop-after=moduleB would cause kdesrc-build to build moduleA and moduleB.

This command line option was added with kdesrc-build 1.16.

This option causes the build to abort as soon as a failure occurs. Useful when you're setting up your initial development environment. Without this flag, kdesrc-build will try to press on with the rest of the modules in the build to avoid wasting time in case the problem is with a single module.

This option was added with kdesrc-build 1.16. See also the stop-on-failure option.

This interprets the next command line parameter as the file to read the configuration options from. The default value for this parameter is kdesrc-buildrc (checked in the current working directory). If this file doesn't exist, ~/.config/kdesrc-buildrc ($XDG_CONFIG_HOME/kdesrc-buildrc, if $XDG_CONFIG_HOME is set) will be used instead. See also Chapter 4, Configuring kdesrc-build.

Takes all actions up to and including dependency reordering of the modules specified on the command line (or configuration file), prints the modules that would be processed one per line, and then exits without further action.

The kde-project metadata is downloaded first (though, see --pretend or --no-src).

The output is not fully compatible with usage by scripts as other output messages may be generated until the module list is shown.

This is mostly just useful for quickly determining what kdesrc-build understands a module's dependencies to be, which means it's only useful for kde-projects modules. This option is also compatible with --resume-from, --resume-after, --stop-before, --stop-after.

Lists the modules that would be built, in the order in which they would be built. If applicable, the output listing also mentions which commit/branch/tag would be selected for checkout.

This option is similar to --print-modules. For more detailed information on how modules relate to each other, see also: --dependency-tree.

Prints out dependency information on the modules that would be built using a tree format (recursive). Listed information also includes which specific commit/branch/tag is depended on and whether or not the dependency would be built. Note: the generated output may become quite large for applications with many dependencies.

This option interprets the next item on the command line as a program to run, and kdesrc-build will then finish reading the configuration file, update the environment as normal, and then execute the given program.

This will not work to start a shell with the kdesrc-build environment in most cases however, since interactive shells typically reset at least part of the environment variables (such as PATH and KDEDIRS) in the startup sequence.

$ kdesrc-build --run printenv
KDE_SESSION_VERSION=4
SDL_AUDIODRIVER=alsa
LANGUAGE=
XCURSOR_THEME=Oxygen_Blue
LESS=-R -M --shift 5
QMAIL_CONTROLDIR=/var/qmail/control
... etc.

This allows you to change the directory that KDE will be installed to from the command line. This option implies --reconfigure, but using --refresh-build may still be required.

This option causes kdesrc-build to checkout a specific numbered revision for each Subversion module, overriding any branch, tag, or revision options already set for these modules.

This option is likely not a good idea, and is only supported for compatibility with older scripts.

This option causes kdesrc-build to abort building a module just before the make command would have been run. This is supported for compatibility with older versions only, this effect is not helpful for the current KDE build system.

If this is the only command-line option, it tries to install all of the modules contained in log/latest/build-status. If command-line options are specified after --install, they are all assumed to be modules to install (even if they did not successfully build on the last run).

Supplying this option causes kdesrc-build to always perform a normal initial checkout of a module instead of using a quick-start snapshot (only available for Git modules from the kde-projects repository). Note that this option should only be used if there is a failure using snapshots, as the quick-start snapshot reduces load on the KDE source repositories.

This option is used to let kdesrc-build delete source directories that may contain user data, so that the module can be re-downloaded. This would normally only be useful for KDE developers (who might have local changes that would be deleted).

This is currently only used to checkout modules that have been converted from Subversion to Git. You should not use this option normally, kdesrc-build will prompt to be re-run with it if it is needed.

This option is used to let kdesrc-build overwrite existing files which may contain user data.

This is currently only used for xsession setup for the login manager. You should not use this option normally, kdesrc-build will prompt to be re-run with it if it is needed.

You can use this option to override an option in your configuration file for every module. For instance, to override the log-dir option, you would do: --log-dir=/path/to/dir.

You can use this option to override an option in your configuration file for a specific module.