'\" t
.\"     Title: \fBkdesrc-build\fR
.\"    Author: Michael Pyne <mpyne@kde.org>
.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
.\"      Date: 2012-05-21
.\"    Manual: KDE User's Manual
.\"    Source: 1.15.1
.\"  Language: English
.\"
.TH "\FBKDESRC\-BUILD\FR" "1" "2012\-05\-21" "1\&.15\&.1" "KDE User's Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
kdesrc-build \- Downloads, builds and installs KDE software\&.
.SH "SYNOPSIS"
.HP \w'\fBkdesrc\-build\fR\ 'u
\fBkdesrc\-build\fR [\fIOPTIONS\fR...] [\fIModule\ name\ |\ Module\ set\ name\fR...]
.SH "DESCRIPTION"
.PP
The
\fBkdesrc\-build\fR
command is used in order to build
KDE
software directly from its source repositories\&. It can download from Subversion or Git repositories, interfaces with the
KDE
project database, and supports controlling which options are passed to
\fBmake\fR(1) and
\fBcmake\fR(1)\&. The operation of
\fBkdesrc\-build\fR
is driven by a configuration file, typically
~/\&.kdesrc\-buildrc\&.
.PP
The
\fImodule name\fR
or
\fImodule set name\fR
as given on the command line should be as those names were defined in the configuration file (either in a
module
definition or
\fBuse\-modules\fR
declaration, or in a
\fBmodule\-set\fR
definition)\&. In addition, it can be the name of a
KDE
module listed in the
KDE
project database (and you can precede the module name with
+
to force this)\&.
.PP
\fBkdesrc\-build\fR
is designed to be able to be completely headless (however, see
\fBENVIRONMENT\fR), and so typically ignores its input completely\&. Command output is logged instead of being shown on the kdesrc\-build output\&.
.PP
Modules are built one after the other\&. If a module fails to update then it is not built\&.
\fBkdesrc\-build\fR
will not abort just because of a module failure, instead it will keep trying to update and build subsequent modules\&. By default,
\fBkdesrc\-build\fR
will commence building a module as soon as the source code update is complete for that module, even if other updates are occurring concurrently\&.
.PP
At the end
\fBkdesrc\-build\fR
will show which modules failed to build, and where the logs were kept for that build run\&.
.SH "OPTIONS"
.PP
\fBNOTE\fR: Some options have short forms, but the
\fBkdesrc\-build\fR
option parser does not support combining short options into one at this point\&. (E\&.g\&. running
\fBkdesrc\-build \-pv\fR
would not be the same as
\fBkdesrc\-build \-\-pretend \-\-verbose\fR)\&.
.PP
\fB\-h, \-\-help\fR
.RS 4
Shows a brief synopsis and frequently\-used command line options\&.
.RE
.PP
\fB\-p, \-\-pretend\fR
.RS 4
Operate in a "dry run" mode\&. No network accesses are made, no log files are created, no modules are built, and no other permanent changes to disk are made\&. One
\fIimportant exception\fR
is that if you try to build a module that comes from the
KDE
project database, and the database hasn\*(Aqt been downloaded yet, the database will be downloaded since the pretend\-mode output may change significantly based on the database results\&.
.RE
.PP
\fB\-\-install\fR
.RS 4
Skips the update and build phase and immediately attempts to install the modules given\&.
.RE
.PP
\fB\-\-uninstall\fR
.RS 4
Skips the update and build phase and immediately attempts to uninstall the modules given\&.
\fBNOTE\fR: This is only supported for buildsystems that supports the
\fBmake uninstall\fR
command (e\&.g\&.
KDE
CMake\-based)\&.
.RE
.PP
\fB\-\-no\-src\fR
.RS 4
Skips the source update phase\&. Other phases are included as normal\&.
\fB\-\-no\-svn\fR
is a deprecated alias for this option and will be removed in a future release\&.
.RE
.PP
\fB\-\-no\-install\fR
.RS 4
Skips the install phase from the build\&. Other phases are included as normal\&.
.RE
.PP
\fB\-\-no\-build\fR
.RS 4
Skips the build phase for the build\&. Internally the install phase depends on the build phase completing so this is effectively equivalent to
\fB\-\-src\-only\fR, but the semantics may change in the future (e\&.g\&. when test suites are moved into their own phase)\&.
.RE
.PP
\fB\-\-no\-tests\fR
.RS 4
Disables running the test suite for CMake\-based modules\&. To be fully effective this requires re\-running CMake, which can be forced by using the
\fB\-\-reconfigure\fR
or
\fB\-\-refresh\-build\fR
options\&.
.RE
.PP
\fB\-\-src\-only\fR
.RS 4
Only performs the source update phase, does not build or install\&.
\fB\-\-svn\-only\fR
is a deprecated alias for this option and will be removed in a future release\&.
.RE
.PP
\fB\-\-build\-only\fR
.RS 4
Forces the build process to be performed without updating source code first\&. In addition, installation is not performed\&. (Testing is still performed if applicable, but this will change in a future release)
.RE
.PP
\fB\-\-refresh\-build\fR
.RS 4
Removes the build directory for a module before the build phase starts\&. This has the desired side effect of forcing
\fBkdesrc\-build\fR
to re\-configure the module and build it from a "pristine" state with no existing temporary or intermediate output files\&. Use this option if you have problems getting a module to build but realize it will take longer (possibly much longer) for the build to complete as a result\&. When in doubt use this option for the entire
\fBkdesrc\-build\fR
run\&.
.RE
.PP
\fB\-\-reconfigure\fR
.RS 4
Force CMake to be re\-run, but without deleting the build directory\&. Usually you actually want
\fB\-\-refresh\-build\fR, but if you are 100% sure your change to
\fBcmake\-options\fR
will not invalidate your current intermediate output then this can save some time\&.
.RE
.PP
\fB\-\-build\-system\-only\fR
.RS 4
Interrupts the build process for each module built: The build process consists of normal setup up to and including running
\fBcmake\fR
or
\fBconfigure\fR
(as appropriate), but
\fBmake\fR
is not run and no installation is attempted\&. This is mostly only useful to get things like
\fBconfigure \-\-help\fR
and
\fBcmake\-gui\fR
to work\&. Normally you want
\fB\-\-reconfigure\fR
or
\fB\-\-refresh\-build\fR\&.
.RE
.PP
\fB\-\-resume\-from=\fR\fB\fIfoo\fR\fR
.RS 4
Use this option to skip module processing until the module
\fIfoo\fR
is encountered\&.
\fIfoo\fR
and all subsequent modules will be processed normally as if they had been specified on the command line\&. If you use this option because of a build failure you may want to consider using
\fB\-\-no\-src\fR
in addition to skip the resultant source update phase\&.
.RE
.PP
\fB\-\-resume\-after=\fR\fB\fIfoo\fR\fR
.RS 4
This is just like
\fB\-\-resume\-from\fR, except that the module
\fIfoo\fR
is
\fInot\fR
included in the list of modules to consider\&. You might use this if you\*(Aqve manually built/installed foo after fixing the build and just want to resume from there\&.
.RE
.PP
\fB\-\-ignore\-modules\fR
.RS 4
Forces
\fBALL\fR
modules that follow this option to be excluded from consideration by
\fBkdesrc\-build\fR\&. This might be useful if you know you want to process all modules except for specific exceptions\&.
.RE
.PP
\fB\-\-rc\-file=\fR\fB\fIfoo\fR\fR
.RS 4
Use the given file,
\fIfoo\fR, for the configuration instead of
~/\&.kdesrc\-buildrc
or
\&./kdesrc\-buildrc\&. The file can be empty, but must exist\&.
.RE
.PP
\fB\-\-prefix=\fR\fB\fIfoo\fR\fR
.RS 4
Overrides the
\fBkdedir\fR
setting to be
\fIfoo\fR
for this run\&. In addition, implies
\fB\-\-reconfigure\fR\&. It
\fIdoes not\fR
actually perform the action you would think it does (overriding the
\fBprefix\fR
option to change where modules are installed), although by default modules are installed to the
\fBkdedir\fR
setting if
\fBprefix\fR
is not set\&.
.RE
.PP
\fB\-\-nice=\fR\fB\fIfoo\fR\fR
.RS 4
Changes the CPU priority given to
\fBkdesrc\-build\fR
(and all processes used by
\fBkdesrc\-build\fR
e\&.g\&.
\fBmake\fR(1))\&.
\fIfoo\fR
should be an integer number between \-20 and 19\&. Positive values are "nicer" to the rest of the system (i\&.e\&. lower priority)\&.
.sp
Note that the possible priorities available on your system may be different than listed here, see
\fBnice\fR(2) for more information\&. Note also that this only changes
\fICPU\fR
priority, often you want to change
\fII/O\fR
priority on systems where that is supported\&. There is no command\-line option for I/O priority adjustment, but there is a configuration file option:
\fBuse\-idle\-io\-priority\fR
(although like all options, there is a generic way to set this from the command line)\&.
.RE
.PP
\fB\-\-run=\fR\fB\fIfoo\fR\fR
.RS 4
Runs the program named by
\fIfoo\fR
using
\fBkdesrc\-build\fR\*(Aqs normal build environment\&. All command line arguments present after this option are passed to
\fIfoo\fR
as it is run\&.
.RE
.PP
\fB\-\-color\fR
.RS 4
Enables "colorful output"\&. (Enabled by default)\&.
.RE
.PP
\fB\-\-no\-color\fR
.RS 4
Disables "colorful output"\&. This can be made permanent by setting the
\fBcolorful\-output\fR
option to false (or 0) in your configuration file\&.
.RE
.PP
\fB\-\-async\fR
.RS 4
Have
\fBkdesrc\-build\fR
start the build process for a module as soon as the source code has finished downloading\&. Without this option
\fBkdesrc\-build\fR
performs all source updates at once and only then starts with the build process\&. This option is enabled by default\&.
.RE
.PP
\fB\-\-no\-async\fR
.RS 4
Disables asynchronous building of modules\&. See
\fB\-\-async\fR
for a more detailed description\&. Note that
\fBkdesrc\-build\fR\*(Aqs output will be slightly different in this mode\&.
.RE
.PP
\fB\-v, \-\-verbose\fR
.RS 4
Increases the level of verbosity of
\fBkdesrc\-build\fR
output (which is already fairly verbose!)
.RE
.PP
\fB\-q, \-\-quiet\fR
.RS 4
Makes
\fBkdesrc\-build\fR
less noisy\&. Only important messages are shown\&.
.RE
.PP
\fB\-\-really\-quiet\fR
.RS 4
Makes
\fBkdesrc\-build\fR
even less noisy\&. Only warnings/errors are shown\&.
.RE
.PP
\fB\-\-debug\fR
.RS 4
This will fill your terminal with descriptions and debugging output, usually unintelligible, describing what
\fBkdesrc\-build\fR
is doing (and thinks it should be doing)\&. The flag is included since the output may sometimes prove useful for debugging\&.
.RE
.PP
\fB\-\-force\-build\fR
.RS 4
Normally when
\fBkdesrc\-build\fR
notices that there is no source update on a module which was previously successfully installed, it does not attempt to build or install that module\&. You can pass this flag to disable that behavior and always run
\fBmake\fR\&.
.RE
.PP
\fB\-\-no\-snapshots\fR
.RS 4
Normally
\fBkdesrc\-build\fR
supports using source repository tarball snapshots to reduce load on
KDE
infrastructure for git clones for some
KDE
modules\&. Passing this option disables this feature\&.
.RE
.PP
\fB\-\-delete\-my\-patches\fR
.RS 4
This option must be passed to allow
\fBkdesrc\-build\fR
to remove conflicting source directories\&. Currently even this only happens when trying to clone a git\-based module if an existing source directory is present\&. Never specify this option unless it is suggested by
\fBkdesrc\-build\fR, and only if you don\*(Aqt mind the source directories that are referenced being deleted and re\-cloned\&.
.RE
.PP
\fB\-\-\fR\fB\fIfoo\fR\fR\fB=\fR\fB\fIbar\fR\fR
.RS 4
Any option not listed above is checked to see if it matches the list of possible configuration file options\&. If so, the configuration file option
\fBfoo\fR
is temporarily set to
\fBbar\fR
for the duration of this run\&.
.RE
.PP
\fB\-\-\fR\fB\fImodule\fR\fR\fB,\fR\fB\fIfoo\fR\fR\fB=\fR\fB\fIbar\fR\fR
.RS 4
Like above, but option
\fBfoo\fR
is only set to
\fBbar\fR
for the module
\fBmodule\fR\&. This does not work for module sets yet, you must repeat this for each module you want to be affected\&. (Of course, you could simply edit your configuration file\&.\&.\&.)
.RE
.SH "EXIT STATUS"
.PP
\fB0\fR
.RS 4
Success
.RE
.PP
\fB1\fR
.RS 4
Normally this means some part of the update, build or install process failed, but is also used for any abnormal program end not otherwise covered below\&.
.RE
.PP
\fB5\fR
.RS 4
A signal was received that killed
\fBkdesrc\-build\fR, but it attempted to perform normal closedown\&.
.RE
.PP
\fB8\fR
.RS 4
Unknown option was passed on the command line\&.
.RE
.PP
\fB99\fR
.RS 4
An exception was raised that forced
\fBkdesrc\-build\fR
to abort early\&.
.RE
.SH "ENVIRONMENT"
.PP
\fBHOME\fR
.RS 4
Used for tilde\-expansion of file names, and is the default base for the source, build, and installation directories\&.
.RE
.PP
\fBPATH\fR
.RS 4
This environment variable controls the default search path for executables\&. You can use the
\fBbinpath\fR
configuration file option to add to this variable (e\&.g\&. for running from
\fBcron\fR(8))\&.
.RE
.PP
\fBLC_\fR*
.RS 4
Environment variables starting with LC_ control the locale used by
\fBkdesrc\-build\fR\&. Although
\fBkdesrc\-build\fR
is still not localizable at this point, many of the commands it uses are\&.
\fBkdesrc\-build\fR
normally sets
\fBLC_ALL\fR=C for commands that its must examine the output of but you can manually do this as well\&. If setting
\fBLC_ALL\fR=C fixes a
\fBkdesrc\-build\fR
problem please submit a bug report\&.
.RE
.PP
\fBSSH_AGENT_PID\fR
.RS 4
This environment variable is checked to see if
\fBssh\-agent\fR(1) is running, but only if
\fBkdesrc\-build\fR
determines that you are checking out a module that requires an SSH login (but you should know this as no module requires this by default)\&.
.RE
.PP
\fBKDESRC_BUILD_USE_TTY\fR
.RS 4
If set, this variable forces
\fBkdesrc\-build\fR
not to close its input while executing system processes\&. Normally
\fBkdesrc\-build\fR
closes
stdin
since the
stdout
and
stderr
for its child processes are redirected and therefore the user would never see an input prompt anyways\&.
.RE
.PP
\fBKDESRC_BUILD_DUMP_CONTEXT\fR
.RS 4
If set, this variable prints out a description of its "build context" just after reading options and command line arguments and determining which modules to build\&. You pretty much never want to set this\&.
.RE
.PP
others
.RS 4
Many programs are used by
\fBkdesrc\-build\fR
in the course of its execution, including
\fBsvn\fR(1),
\fBgit\fR(1),
\fBmake\fR(1), and
\fBcmake\fR(1)\&. Each of these programs may have their own response to environment variables being set\&.
\fBkdesrc\-build\fR
will pass environment variables that are set when it is run onto these processes\&. You can ensure certain environment variables (e\&.g\&.
\fBCC\fR
or
\fBCXX\fR) are set by using the
\fBset\-env\fR
configuration file option\&.
.RE
.SH "FILES"
.PP
~/\&.kdesrc\-buildrc
\- Default global configuration file\&.
.PP
\&./kdesrc\-buildrc
\- If this file (note there is no leading period (\&.) this time) is found in the
\fBcurrent directory\fR
when kdesrc\-build is run, this file will be used for the configuration instead of
~/\&.kdesrc\-buildrc\&.
.PP
~/\&.kdesrc\-build\-data
\-
\fBkdesrc\-build\fR
uses this file to store persistent data (such as last CMake options used, last revision successfully installed, etc\&.)\&. It can be safely deleted\&.
.SH "BUGS"
.PP
See
\m[blue]\fBhttp://bugs\&.kde\&.org/\fR\m[]\&. Be sure to search against the
\fBkdesrc\-build\fR
product\&.
.SH "EXAMPLE"
.PP
$ \fB\fBkdesrc\-build\fR\fR
.RS 4
Downloads, builds and installs all modules listed in the configuration file, in the order defined therein\&.
.RE
.PP
$ \fB\fBkdesrc\-build\fR\fR\fB \fR\fB\fB\-\-pretend\fR\fR
.RS 4
Same as above, except no permanent actions are taken (specifically no log files are created, downloads performed, build processes run, etc\&.)\&.
\fBEXCEPTION\fR: If you are trying to build a module defined in the
KDE
project database, and the database has not been downloaded yet,
\fBkdesrc\-build\fR
will download the database since this can significantly affect the final build order\&.
.RE
.PP
$ \fB\fBkdesrc\-build\fR\fR\fB \fR\fB\fB\-\-no\-src\fR\fR\fB \fR\fB\fB\-\-refresh\-build\fR\fR\fB \fR\fBkdebase\fR
.RS 4
Deletes the build directory for the
\fIkdebase\fR
module set (\fB\-\-refresh\-build\fR) and then starts the build process again without updating the source code in\-between\&.
.RE
.PP
$ \fB\fBkdesrc\-build\fR\fR\fB \fR\fB\fB\-\-rc\-file\fR\fR\fB \fR\fB/dev/null\fR\fB \fR\fB\fB\-\-pretend\fR\fR
.RS 4
Forces
\fBkdesrc\-build\fR
to read an empty configuration file and simulate the resultant build process\&. This shows what would happen by default with no configuration file, without an error message about a missing configuration file\&.
.RE
.PP
$ \fB\fBkdesrc\-build\fR\fR\fB \fR\fB+kdebase/kde\-baseapps\fR
.RS 4
Downloads, builds and installs the
kde\-baseapps
module from the
KDE
project database\&. Since the module name is preceded by a
+
it is assumed to defined in the
KDE
project database even if this hasn\*(Aqt been specifically configured in the configuration file\&.
.sp
The
kdebase/
portion forces
\fBkdesrc\-build\fR
to ignore any
kde\-baseapps
modules that are not children of the
kdebase
supermodule in the project database (although it is contrived for this example)\&.
.RE
.PP
$ \fB\fBkdesrc\-build\fR\fR\fB \fR\fB\fB\-\-refresh\-build\fR\fR\fB \fR\fB\fB\-\-cmake\-options=\fR\fB\fI"\-DCMAKE_BUILD_TYPE=Debug"\fR\fR\fR
.RS 4
Downloads, builds and installs all modules defined in the configuration file but overrides the
cmake\-options
option to have the value given on the command line for this run only\&. Any further
\fBkdesrc\-build\fR
runs will use the
cmake\-options
given in the configuration file\&.
.RE
.SH "SEE ALSO"
.PP
build\-tool \- A program by Michael Jansen which can build
KDE
software based on included recipes\&.
.SH "RESOURCES"
.PP
Main web site:
\m[blue]\fBhttp://kdesrc\-build\&.kde\&.org/\fR\m[]
.PP
Documentation:
\m[blue]\fBhttp://kdesrc\-build\&.kde\&.org/documentation/\fR\m[]
.PP
Setup script:
\fBkdesrc\-build\-setup\fR
.SH "COPYING"
.PP
Copyright (C) 2003\-2011 Michael Pyne\&.
.PP
This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version\&.
.PP
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE\&. See the GNU General Public License for more details\&.
.PP
You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc\&., 51 Franklin Street, Fifth Floor, Boston, MA 02110\-1301 USA
.SH "AUTHOR"
.PP
\fBMichael Pyne\fR <\&mpyne@kde\&.org\&>
.RS 4
Author.
.RE