man-kdesrc-build.1.docbook 26.3 KB
Newer Older
1
2
3
4
5
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE refentry PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
<!ENTITY % English "INCLUDE">
]>

6
7
8
9
10
11
12
13
14
15
16
<!--
    Man page for kdesrc-build.
    Copyright (c) 2011 Michael Pyne <mpyne@kde.org>

    Permission is granted to copy, distribute and/or modify this document under
    the terms of the GNU Free Documentation License, Version 1.2 or any later
    version published by the Free Software Foundation; with no Invariant
    Sections, no Front-Cover Texts, and no Back-Cover Texts.  A copy of the
    license is included in COPYING.DOC.
 -->

17
18
19
20
21
22
23
<refentry lang="&language;">
<refentryinfo>
<title>&kde; User's Manual</title>
<author>
    <personname><firstname>Michael</firstname><surname>Pyne</surname></personname>
    <email>mpyne@kde.org</email>
</author>
Michael Pyne's avatar
Michael Pyne committed
24
<date>2012-05-21</date>
25
26
27
28
29
</refentryinfo>

<refmeta>
<refentrytitle><command>kdesrc-build</command></refentrytitle>
<manvolnum>1</manvolnum>
Michael Pyne's avatar
Michael Pyne committed
30
<refmiscinfo class="version">1.15.1</refmiscinfo>
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
</refmeta>

<refnamediv>
    <refname><command>kdesrc-build</command></refname>
    <refpurpose>Downloads, builds and installs &kde; software.</refpurpose>
</refnamediv>

<refsynopsisdiv id="_synopsis">
<cmdsynopsis>
<command>kdesrc-build</command>
<arg rep="repeat"><replaceable>OPTIONS</replaceable></arg>
<arg rep="repeat"><replaceable>Module name | Module set name</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>

<refsect1>
<title>DESCRIPTION</title>

<para>The <command>kdesrc-build</command> 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 <command>make</command>(1) and
<command>cmake</command>(1). The operation of <command>kdesrc-build</command>
is driven by a configuration file, typically
<filename>~/.kdesrc-buildrc</filename>.</para>

<para>The <replaceable>module name</replaceable> or <replaceable>module set
name</replaceable> as given on the command line should be as those names were
defined in the configuration file (either in a <symbol>module</symbol>
definition or <option>use-modules</option> declaration, or in a
<option>module-set</option> definition). In addition, it can be the name of a
&kde; module listed in the &kde; project database (and you can precede the
Yuri Chornoivan's avatar
Yuri Chornoivan committed
63
module name with <symbol>+</symbol> to force this).</para>
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86

<para><command>kdesrc-build</command> is designed to be able to be completely
headless (however, see <emphasis role="strong">ENVIRONMENT</emphasis>), and so
typically ignores its input completely. Command output is logged instead of
being shown on the kdesrc-build output.</para>

<para>Modules are built one after the other. If a module fails to update then
it is not built. <command>kdesrc-build</command> will not abort just because of
a module failure, instead it will keep trying to update and build subsequent
modules. By default, <command>kdesrc-build</command> will commence building a
module as soon as the source code update is complete for that module, even if
other updates are occurring concurrently.</para>

<para>At the end <command>kdesrc-build</command> will show which modules failed
to build, and where the logs were kept for that build run.</para> </refsect1>

<refsect1>
<title>OPTIONS</title>

<para><emphasis role="strong">NOTE</emphasis>: Some options have short forms,
but the <command>kdesrc-build</command> option parser does not support
combining short options into one at this point. (E.g. running
<option>kdesrc-build -pv</option> would not be the same as
Yuri Chornoivan's avatar
Yuri Chornoivan committed
87
<option>kdesrc-build --pretend --verbose</option>).</para>
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546

<variablelist>

<varlistentry>
<term>
<option>-h, --help</option>
</term>

<listitem>
<para>
    Shows a brief synopsis and frequently-used command line options.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<option>-p, --pretend</option>
</term>

<listitem>
<para>
    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 <emphasis>important exception</emphasis> is that if you try to
    build a module that comes from the &kde; project database, and the
    database hasn't been downloaded yet, the database will be downloaded
    since the pretend-mode output may change significantly based on the
    database results.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<option>--install</option>
</term>

<listitem>
<para>
    Skips the update and build phase and immediately attempts to install the
    modules given.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<option>--uninstall</option>
</term>

<listitem>
<para>
    Skips the update and build phase and immediately attempts to uninstall the
    modules given. <emphasis role="strong">NOTE</emphasis>: This is only
    supported for buildsystems that supports the <command>make
    uninstall</command> command (e.g. &kde; CMake-based).
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<option>--no-src</option>
</term>

<listitem>
<para>
    Skips the source update phase. Other phases are included as normal.
    <option>--no-svn</option> is a deprecated alias for this option and will be
    removed in a future release.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<option>--no-install</option>
</term>

<listitem>
<para>
    Skips the install phase from the build. Other phases are included as
    normal.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<option>--no-build</option>
</term>

<listitem>
<para>
    Skips the build phase for the build. Internally the install phase depends
    on the build phase completing so this is effectively equivalent to
    <option>--src-only</option>, but the semantics may change in the future
    (e.g. when test suites are moved into their own phase).
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<option>--no-tests</option>
</term>

<listitem>
<para>
    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
    <option>--reconfigure</option> or <option>--refresh-build</option> options.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<option>--src-only</option>
</term>

<listitem>
<para>
    Only performs the source update phase, does not build or install.
    <option>--svn-only</option> is a deprecated alias for this option and will
    be removed in a future release.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<option>--build-only</option>
</term>

<listitem>
<para>
    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)
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<option>--refresh-build</option>
</term>

<listitem>
<para>
    Removes the build directory for a module before the build phase starts.
    This has the desired side effect of forcing <command>kdesrc-build</command> 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 <command>kdesrc-build</command> run.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<option>--reconfigure</option>
</term>

<listitem>
<para>
    Force CMake to be re-run, but without deleting the build directory.
    Usually you actually want <option>--refresh-build</option>, but if you are
    100% sure your change to <option>cmake-options</option> will not
    invalidate your current intermediate output then this can save some time.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<option>--build-system-only</option>
</term>

<listitem>
<para>
    Interrupts the build process for each module built: The build process
    consists of normal setup up to and including running
    <command>cmake</command> or <command>configure</command> (as appropriate),
    but <command>make</command> is not run and no installation
    is attempted. This is mostly only useful to get things like
    <command>configure --help</command> and <command>cmake-gui</command> to
    work. Normally you want <option>--reconfigure</option> or
    <option>--refresh-build</option>.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<option>--resume-from=<replaceable>foo</replaceable></option>
</term>

<listitem>
<para>
    Use this option to skip module processing until the module
    <replaceable>foo</replaceable> is encountered.
    <replaceable>foo</replaceable> 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
    <option>--no-src</option> in addition to skip the resultant source update
    phase.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<option>--resume-after=<replaceable>foo</replaceable></option>
</term>

<listitem>
<para>
    This is just like <option>--resume-from</option>, except that the module
    <replaceable>foo</replaceable> is <emphasis>not</emphasis> included in the
    list of modules to consider. You might use this if you've manually
    built/installed foo after fixing the build and just want to resume from
    there.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<option>--ignore-modules</option>
</term>

<listitem>
<para>
    Forces <emphasis role="strong">ALL</emphasis> modules that follow this
    option to be excluded from consideration by
    <command>kdesrc-build</command>. This might be useful if you know you want
    to process all modules except for specific exceptions.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<option>--rc-file=<replaceable>foo</replaceable></option>
</term>

<listitem>
<para>
    Use the given file, <replaceable>foo</replaceable>, for the configuration
    instead of <filename>~/.kdesrc-buildrc</filename> or
    <filename>./kdesrc-buildrc</filename>. The file can be empty, but must
    exist.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<option>--prefix=<replaceable>foo</replaceable></option>
</term>

<listitem>
<para>
    Overrides the <option>kdedir</option> setting to be
    <replaceable>foo</replaceable> for this run. In addition, implies
    <option>--reconfigure</option>. It <emphasis>does not</emphasis> actually
    perform the action you would think it does (overriding the
    <option>prefix</option> option to change where modules are installed),
    although by default modules are installed to the <option>kdedir</option>
    setting if <option>prefix</option> is not set.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<option>--nice=<replaceable>foo</replaceable></option>
</term>

<listitem>
<para>
    Changes the CPU priority given to <command>kdesrc-build</command> (and all
    processes used by <command>kdesrc-build</command> e.g.
    <command>make</command>(1)). <replaceable>foo</replaceable> should be an
    integer number between -20 and 19. Positive values are "nicer" to the rest
    of the system (i.e.  lower priority).
</para>

<para>
    Note that the possible priorities available on your system may be different
    than listed here, see <command>nice</command>(2) for more information. Note
    also that this only changes <emphasis>CPU</emphasis> priority, often you
    want to change <emphasis>I/O</emphasis> 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: <option>use-idle-io-priority</option>
    (although like all options, there is a generic way to set this from the
    command line).
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<option>--run=<replaceable>foo</replaceable></option>
</term>

<listitem>
<para>
    Runs the program named by <replaceable>foo</replaceable> using
    <command>kdesrc-build</command>'s normal build environment. All command
    line arguments present after this option are passed to
    <replaceable>foo</replaceable> as it is run.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<option>--color</option>
</term>

<listitem>
<para>
    Enables "colorful output". (Enabled by default).
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<option>--no-color</option>
</term>

<listitem>
<para>
    Disables "colorful output". This can be made permanent by setting the
    <option>colorful-output</option> option to false (or 0) in your
    configuration file.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<option>--async</option>
</term>

<listitem>
<para>
    Have <command>kdesrc-build</command> start the build process for a module
    as soon as the source code has finished downloading. Without this option
    <command>kdesrc-build</command> performs all source updates at once and
    only then starts with the build process. This option is enabled by default.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<option>--no-async</option>
</term>

<listitem>
<para>
    Disables asynchronous building of modules. See <option>--async</option> for
    a more detailed description. Note that <command>kdesrc-build</command>'s
    output will be slightly different in this mode.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<option>-v, --verbose</option>
</term>

<listitem>
<para>
    Increases the level of verbosity of <command>kdesrc-build</command> output
    (which is already fairly verbose!)
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<option>-q, --quiet</option>
</term>

<listitem>
<para>
    Makes <command>kdesrc-build</command> less noisy. Only important messages
    are shown.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<option>--really-quiet</option>
</term>

<listitem>
<para>
    Makes <command>kdesrc-build</command> even less noisy. Only warnings/errors
    are shown.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<option>--debug</option>
</term>

<listitem>
<para>
    This will fill your terminal with descriptions and debugging output,
    usually unintelligible, describing what <command>kdesrc-build</command> is
    doing (and thinks it should be doing). The flag is included since the
    output may sometimes prove useful for debugging.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<option>--force-build</option>
</term>

<listitem>
<para>
    Normally when <command>kdesrc-build</command> 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 <command>make</command>.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<option>--no-snapshots</option>
</term>

<listitem>
<para>
    Normally <command>kdesrc-build</command> 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.
</para>
</listitem>
</varlistentry>

Michael Pyne's avatar
Michael Pyne committed
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
<varlistentry>
<term>
<option>--delete-my-patches</option>
</term>

<listitem>
<para>
    This option must be passed to allow <command>kdesrc-build</command> 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
    <command>kdesrc-build</command>, and only if you don't mind the source
    directories that are referenced being deleted and re-cloned.
</para>
</listitem>
</varlistentry>

564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
<varlistentry>
<term>
<option>--<replaceable>foo</replaceable>=<replaceable>bar</replaceable></option>
</term>

<listitem>
<para>
    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
    <option>foo</option> is temporarily set to <option>bar</option> for the
    duration of this run.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<option>--<replaceable>module</replaceable>,<replaceable>foo</replaceable>=<replaceable>bar</replaceable></option>
</term>

<listitem>
<para>
    Like above, but option <option>foo</option> is only set to
    <option>bar</option> for the module <option>module</option>.  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...)
</para>
</listitem>
</varlistentry>

</variablelist>
</refsect1>

<refsect1>
<title>EXIT STATUS</title>

<variablelist>

<varlistentry>
<term>
<emphasis role="strong">0</emphasis>
</term>

<listitem>
<para>
    Success
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<emphasis role="strong">1</emphasis>
</term>

<listitem>
<para>
    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.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<emphasis role="strong">5</emphasis>
</term>

<listitem>
<para>
    A signal was received that killed <command>kdesrc-build</command>, but it
    attempted to perform normal closedown.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<emphasis role="strong">8</emphasis>
</term>

<listitem>
<para>
    Unknown option was passed on the command line.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<emphasis role="strong">99</emphasis>
</term>

<listitem>
<para>
    An exception was raised that forced <command>kdesrc-build</command> to
    abort early.
</para>
</listitem>
</varlistentry>

</variablelist>
</refsect1>

<refsect1>
<title>ENVIRONMENT</title>

<variablelist>

<varlistentry>
<term>
<envar>HOME</envar>
</term>

<listitem>
<para>
    Used for tilde-expansion of file names, and is the default base for the
    source, build, and installation directories.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<envar>PATH</envar>
</term>

<listitem>
<para>
    This environment variable controls the default search path for executables.
    You can use the <option>binpath</option> configuration file option to add
    to this variable (e.g. for running from <command>cron</command>(8)).
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<envar>LC_</envar>*
</term>

<listitem>
<para>
    Environment variables starting with LC_ control the locale used by
    <command>kdesrc-build</command>. Although <command>kdesrc-build</command>
    is still not localizable at this point, many of the commands it uses are.
    <command>kdesrc-build</command> normally sets <envar>LC_ALL</envar>=C for
    commands that its must examine the output of but you can manually do this
    as well. If setting <envar>LC_ALL</envar>=C fixes a
    <command>kdesrc-build</command> problem please submit a bug report.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<envar>SSH_AGENT_PID</envar>
</term>

<listitem>
<para>
    This environment variable is checked to see if
    <command>ssh-agent</command>(1) is running, but only if
    <command>kdesrc-build</command> 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).
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<envar>KDESRC_BUILD_USE_TTY</envar>
</term>

<listitem>
<para>
    If set, this variable forces <command>kdesrc-build</command> not to close
    its input while executing system processes. Normally
    <command>kdesrc-build</command> closes <symbol>stdin</symbol> since the
    <symbol>stdout</symbol> and <symbol>stderr</symbol> for its child processes
    are redirected and therefore the user would never see an input prompt
    anyways.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<envar>KDESRC_BUILD_DUMP_CONTEXT</envar>
</term>

<listitem>
<para>
    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.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
others
</term>

<listitem>
<para>
    Many programs are used by <command>kdesrc-build</command> in the course of
    its execution, including <command>svn</command>(1),
    <command>git</command>(1), <command>make</command>(1), and
    <command>cmake</command>(1). Each of these programs may have their own
    response to environment variables being set.
    <command>kdesrc-build</command> will pass environment variables that are
    set when it is run onto these processes. You can ensure certain environment
    variables (e.g.  <envar>CC</envar> or <envar>CXX</envar>) are set by using
    the <option>set-env</option> configuration file option.
</para>
</listitem>
</varlistentry>

</variablelist>
</refsect1>

<refsect1>
<title>FILES</title>

<para><filename>~/.kdesrc-buildrc</filename> - Default global configuration
file.</para>

<para><filename>./kdesrc-buildrc</filename> - If this file (note there is no
leading period (.) this time) is found in the <emphasis role="strong">current
directory</emphasis> when kdesrc-build is run, this file will be used for the
configuration instead of <filename>~/.kdesrc-buildrc</filename>.</para>

<para><filename>~/.kdesrc-build-data</filename> -
<command>kdesrc-build</command> uses this file to store persistent data (such
as last CMake options used, last revision successfully installed, etc.). It can
be safely deleted.</para>

</refsect1>

<refsect1>
<title>BUGS</title>

<para>See <ulink url="http://bugs.kde.org/">http://bugs.kde.org/</ulink>. Be
sure to search against the <command>kdesrc-build</command> product.</para>

</refsect1>

<refsect1>
<title>EXAMPLE</title>

<variablelist>

<varlistentry>
<term>
$ <userinput><command>kdesrc-build</command></userinput>
</term>

<listitem>
<para>
    Downloads, builds and installs all modules listed in the configuration
    file, in the order defined therein.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
$ <userinput><command>kdesrc-build</command> <option>--pretend</option></userinput>
</term>

<listitem>
<para>
    Same as above, except no permanent actions are taken (specifically no log
    files are created, downloads performed, build processes run, etc.).
    <emphasis role="strong">EXCEPTION</emphasis>: If you are trying to build a
    module defined in the &kde; project database, and the database has not been
    downloaded yet, <command>kdesrc-build</command> will download the database
    since this can significantly affect the final build order.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
$ <userinput><command>kdesrc-build</command> <option>--no-src</option> <option>--refresh-build</option> <symbol>kdebase</symbol></userinput>
</term>

<listitem>
<para>
    Deletes the build directory for the <emphasis>kdebase</emphasis> module set
    (<option>--refresh-build</option>) and then starts the build process again
    without updating the source code in-between.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
$ <userinput><command>kdesrc-build</command> <option>--rc-file</option> <filename>/dev/null</filename> <option>--pretend</option></userinput>
</term>

<listitem>
<para>
    Forces <command>kdesrc-build</command> 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.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
$ <userinput><command>kdesrc-build</command> <symbol>+kdebase/kde-baseapps</symbol></userinput>
</term>

<listitem>
<para>
    Downloads, builds and installs the <symbol>kde-baseapps</symbol> module
    from the &kde; project database. Since the module name is preceded by a
    <symbol>+</symbol> it is assumed to defined in the &kde; project
    database even if this hasn't been specifically configured in the
    configuration file.
</para>
<para>
    The <symbol>kdebase/</symbol> portion forces
    <command>kdesrc-build</command> to ignore any <symbol>kde-baseapps</symbol>
    modules that are not children of the <symbol>kdebase</symbol> supermodule
    in the project database (although it is contrived for this example).
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
$ <userinput><command>kdesrc-build</command> <option>--refresh-build</option> <option>--cmake-options=<replaceable>"-DCMAKE_BUILD_TYPE=Debug"</replaceable></option></userinput>
</term>

<listitem>
<para>
    Downloads, builds and installs all modules defined in the configuration
    file but overrides the <symbol>cmake-options</symbol> option to have
    the value given on the command line for this run only. Any further
    <command>kdesrc-build</command> runs will use the
    <symbol>cmake-options</symbol> given in the configuration file.
</para>
</listitem>
</varlistentry>

</variablelist>
</refsect1>

<refsect1>
<title>SEE ALSO</title>

<para>build-tool - A program by Michael Jansen which can build &kde; software
based on included recipes.</para>

</refsect1>

<refsect1>
<title>RESOURCES</title>

<para>Main web site: <ulink
url="http://kdesrc-build.kde.org/">http://kdesrc-build.kde.org/</ulink></para>

<para>Documentation: <ulink
url="http://kdesrc-build.kde.org/documentation/">http://kdesrc-build.kde.org/documentation/</ulink></para>

<para>Setup script: <command>kdesrc-build-setup</command></para>

</refsect1>

<refsect1>
<title>COPYING</title>

<para>Copyright (C) 2003-2011 Michael Pyne.</para>

<para>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
Yuri Chornoivan's avatar
Yuri Chornoivan committed
948
Software Foundation; either version 2 of the License, or (at your option) any
949
950
951
952
953
954
955
956
957
958
959
960
961
962
later version.</para>

<para>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.</para>

<para>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</para>

</refsect1>

</refentry>