summaryrefslogtreecommitdiffstats
path: root/doc/user/command-line.sgml
blob: 78c94e1ca55c3b908886a19e66e9b41606f2d93e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
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
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
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
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
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
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
<!--

  Copyright (c) 2001, 2002, 2003 Steven Knight

  Permission is hereby granted, free of charge, to any person obtaining
  a copy of this software and associated documentation files (the
  "Software"), to deal in the Software without restriction, including
  without limitation the rights to use, copy, modify, merge, publish,
  distribute, sublicense, and/or sell copies of the Software, and to
  permit persons to whom the Software is furnished to do so, subject to
  the following conditions:

  The above copyright notice and this permission notice shall be included
  in all copies or substantial portions of the Software.

  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
  KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
  WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

-->

  <para>

  &SCons; provides a number of ways that
  allow the writer of the &SConscript; files
  to give users a great deal of control over how to run the builds.

  </para>

  <section>
  <title>Not Having to Specify Command-Line Options Each Time:  the &SCONSFLAGS; Environment Variable</title>

    <para>

    Users may find themselves supplying
    the same command-line options every time
    they run &SCons;.
    For example, a user might find that it saves time
    to specify a value of <literal>-j 2</literal>
    to run the builds in parallel.
    To avoid having to type <literal>-j 2</literal> by hand
    every time,
    you can set the external environment variable
    &SCONSFLAGS; to a string containing
    command-line options that you want &SCons; to use.

    </para>

    <para>

    If, for example,
    and you're using a POSIX shell that's
    compatible with the Bourne shell,
    and you always want &SCons; to use the
    <literal>-Q</literal> option,
    you can set the &SCONSFLAGS;
    environment as follows:

    </para>

    

    <literallayout>
      % <userinput>scons</userinput>
      scons: Reading SConscript files ...
      scons: done reading SConscript files.
      scons: Building targets ...
          ... [build output] ...
      scons: done building targets.
      % <userinput>export SCONSFLAGS="-Q"</userinput>
      % <userinput>scons</userinput>
          ... [build output] ...
    </literallayout>

    <para>

    Users of &csh;-style shells on POSIX systems
    can set the &SCONSFLAGS; environment as follows:

    </para>

    <literallayout>
      $ setenv SCONSFLAGS "-Q"
    </literallayout>

    <para>

    Windows users may typically want to set this
    &SCONSFLAGS; in the appropriate tab of the
    <literal>System Properties</literal> window.

    </para>

  </section>

  <section>
  <title>Getting at Command-Line Targets</title>

    <para>

    &SCons; supports a &COMMAND_LINE_TARGETS; variable
    that lets you get at the list of targets that the
    user specified on the command line.
    You can use the targets to manipulate the
    build in any way you wish.
    As a simple example,
    suppose that you want to print a reminder
    to the user whenever a specific program is built.
    You can do this by checking for the
    target in the &COMMAND_LINE_TARGETS; list:

    </para>

    <programlisting>
      if 'bar' in COMMAND_LINE_TARGETS:
          print "Don't forget to copy `bar' to the archive!"
      Default(Program('foo.c'))
      Program('bar.c')
    </programlisting>

    <para>

    Then, running &SCons; with the default target
    works as it always does,
    but explicity specifying the &bar; target
    on the command line generates the warning message:

    </para>

    <literallayout>
      % <userinput>scons -Q</userinput>
      cc -c -o foo.o foo.c
      cc -o foo foo.o
      % <userinput>scons -Q bar</userinput>
      Don't forget to copy `bar' to the archive!
      cc -c -o bar.o bar.c
      cc -o bar bar.o
    </literallayout>

    <para>

    Another practical use for the &COMMAND_LINE_TARGETS; variable
    might be to speed up a build
    by only reading certain subsidiary &SConscript;
    files if a specific target is requested.

    </para>

  </section>

  <section>
  <title>Controlling the Default Targets</title>

    <para>

    One of the most basic things you can control
    is which targets &SCons; will build by default--that is,
    when there are no targets specified on the command line.
    As mentioned previously,
    &SCons; will normally build every target
    in or below the current directory
    by default--that is, when you don't
    explicitly specify one or more targets
    on the command line.
    Sometimes, however, you may want
    to specify explicitly that only
    certain programs, or programs in certain directories,
    should be built by default.
    You do this with the &Default; function:

    </para>

    <programlisting>
       env = Environment()
       hello = env.Program('hello.c')
       env.Program('goodbye.c')
       Default(hello)
    </programlisting>

    <para>

    This &SConstruct; file knows how to build two programs,
    &hello; and &goodbye;,
    but only builds the
    &hello; program by default:

    </para>

    <literallayout>
       % <userinput>scons -Q</userinput>
       cc -c -o hello.o hello.c
       cc -o hello hello.o
       % <userinput>scons -Q</userinput>
       scons: `hello' is up to date.
       % <userinput>scons -Q goodbye</userinput>
       cc -c -o goodbye.o goodbye.c
       cc -o goodbye goodbye.o
    </literallayout>

    <para>

    Note that, even when you use the &Default;
    function in your &SConstruct; file,
    you can still explicitly specify the current directory
    (<literal>.</literal>) on the command line
    to tell &SCons; to build
    everything in (or below) the current directory:

    </para>

    <literallayout>
       % <userinput>scons -Q .</userinput>
       cc -c -o goodbye.o goodbye.c
       cc -o goodbye goodbye.o
       cc -c -o hello.o hello.c
       cc -o hello hello.o
    </literallayout>

    <para>

    You can also call the &Default;
    function more than once,
    in which case each call
    adds to the list of targets to be built by default:

    </para>

    <programlisting>
       env = Environment()
       prog1 = env.Program('prog1.c')
       Default(prog1)
       prog2 = env.Program('prog2.c')
       prog3 = env.Program('prog3.c')
       Default(prog3)
    </programlisting>

    <para>

    Or you can specify more than one target
    in a single call to the &Default; function:

    </para>

    <programlisting>
       env = Environment()
       prog1 = env.Program('prog1.c')
       prog2 = env.Program('prog2.c')
       prog3 = env.Program('prog3.c')
       Default(prog1, prog3)
    </programlisting>

    <para>

    Either of these last two examples
    will build only the
    <application>prog1</application>
    and
    <application>prog3</application>
    programs by default:

    </para>

    <literallayout>
       % <userinput>scons -Q</userinput>
       cc -c -o prog1.o prog1.c
       cc -o prog1 prog1.o
       cc -c -o prog3.o prog3.c
       cc -o prog3 prog3.o
       % <userinput>scons -Q .</userinput>
       cc -c -o prog2.o prog2.c
       cc -o prog2 prog2.o
    </literallayout>

    <para>

    You can list a directory as
    an argument to &Default;:

    </para>

    <programlisting>
       env = Environment()
       env.Program(['prog1/main.c', 'prog1/foo.c'])
       env.Program(['prog2/main.c', 'prog2/bar.c'])
       Default('prog1')
    </programlisting>

    <para>

    In which case only the target(s) in that
    directory will be built by default:

    </para>

    <literallayout>
       % <userinput>scons -Q</userinput>
       cc -c -o prog1/foo.o prog1/foo.c
       cc -c -o prog1/main.o prog1/main.c
       cc -o prog1/main prog1/main.o prog1/foo.o
       % <userinput>scons -Q</userinput>
       scons: `prog1' is up to date.
       % <userinput>scons -Q .</userinput>
       cc -c -o prog2/bar.o prog2/bar.c
       cc -c -o prog2/main.o prog2/main.c
       cc -o prog2/main prog2/main.o prog2/bar.o
    </literallayout>

    <para>

    Lastly, if for some reason you don't want
    any targets built by default,
    you can use the Python <literal>None</literal>
    variable:

    </para>

    <programlisting>
       env = Environment()
       prog1 = env.Program('prog1.c')
       prog2 = env.Program('prog2.c')
       Default(None)
    </programlisting>

    <para>

    Which would produce build output like:

    </para>

    <literallayout>
       % <userinput>scons -Q</userinput>
       scons: *** No targets specified and no Default() targets found.  Stop.
       % <userinput>scons -Q .</userinput>
       cc -c -o prog1.o prog1.c
       cc -o prog1 prog1.o
       cc -c -o prog2.o prog2.c
       cc -o prog2 prog2.o
    </literallayout>

    <section>
    <title>Getting at the List of Default Targets</title>

      <para>

      &SCons; supports a &DEFAULT_TARGETS; variable
      that lets you get at the current list of default targets.
      The &DEFAULT_TARGETS variable has
      two important differences from the &COMMAND_LINE_TARGETS; variable.
      First, the &DEFAULT_TARGETS; variable is a list of
      internal &SCons; nodes,
      so you need to convert the list elements to strings
      if you want to print them or look for a specific target name.
      Fortunately, you can do this easily
      by using the Python <function>map</function> function
      to run the list through <function>str</function>:

      </para>

      <programlisting>
         prog1 = Program('prog1.c')
         Default(prog1)
         print "DEFAULT_TARGETS is", map(str, DEFAULT_TARGETS)
      </programlisting>

      <para>

      (Keep in mind that all of the manipulation of the
      &DEFAULT_TARGETS; list takes place during the
      first phase when &SCons; is reading up the &SConscript; files,
      which is obvious if 
      we leave off the <literal>-Q</literal> flag when we run &SCons;:)

      </para>

      <literallayout>
         % <userinput>scons</userinput>
         scons: Reading SConscript files ...
         DEFAULT_TARGETS is ['prog1']
         scons: done reading SConscript files.
         scons: Building targets ...
         cc -c -o prog1.o prog1.c
         cc -o prog1 prog1.o
         scons: done building targets.
      </literallayout>

      <para>

      Second,
      the contents of the &DEFAULT_TARGETS; list change
      in response to calls to the &Default;: function,
      as you can see from the following &SConstruct; file:

      </para>

      <programlisting>
         prog1 = Program('prog1.c')
         Default(prog1)
         print "DEFAULT_TARGETS is now", map(str, DEFAULT_TARGETS)
         prog2 = Program('prog2.c')
         Default(prog2)
         print "DEFAULT_TARGETS is now", map(str, DEFAULT_TARGETS)
      </programlisting>

      <para>

      Which yields the output:

      </para>

      <literallayout>
         % <userinput>scons</userinput>
         scons: Reading SConscript files ...
         DEFAULT_TARGETS is now ['prog1']
         DEFAULT_TARGETS is now ['prog1', 'prog2']
         scons: done reading SConscript files.
         scons: Building targets ...
         cc -c -o prog1.o prog1.c
         cc -o prog1 prog1.o
         cc -c -o prog2.o prog2.c
         cc -o prog2 prog2.o
         scons: done building targets.
      </literallayout>

      <para>

      In practice, this simply means that you
      need to pay attention to the order in
      which you call the &Default; function
      and refer to the &DEFAULT_TARGETS; list,
      to make sure that you don't examine the
      list before you've added the default targets
      you expect to find in it.

      </para>

    </section>

  </section>

  <section>
  <title>Getting at the List of Build Targets, Regardless of Origin</title>

    <para>

    We've already been introduced to the
    &COMMAND_LINE_TARGETS; variable,
    which contains a list of targets specified on the command line,
    and the &DEFAULT_TARGETS; variable,
    which contains a list of targets specified
    via calls to the &Default; method or function.
    Sometimes, however,
    you want a list of whatever targets
    &SCons; will try to build,
    regardless of whether the targets came from the
    command line or a &Default; call.
    You could code this up by hand, as follows:

    </para>

    <programlisting>
      if COMMAND_LINE_TARGETS:
          targets = COMMAND_LINE_TARGETS
      else:
          targets = DEFAULT_TARGETS
    </programlisting>

    <para>

    &SCons;, however, provides a convenient
    &BUILD_TARGETS; variable
    that eliminates the need for this by-hand manipulation.
    Essentially, the &BUILD_TARGETS; variable
    contains a list of the command-line targets,
    if any were specified,
    and if no command-line targets were specified,
    it contains a list of the targets specified
    via the &Default; method or function.

    </para>

    <para>

    Because &BUILD_TARGETS; may contain a list of &SCons; nodes,
    you must convert the list elements to strings
    if you want to print them or look for a specific target name,
    just like the &DEFAULT_TARGETS; list:

    </para>

    <programlisting>
      prog1 = Program('prog1.c')
      Program('prog2.c')
      Default(prog1)
      print "BUILD_TARGETS is", map(str, BUILD_TARGETS)
    </programlisting>

    <para>

    Notice how the value of &BUILD_TARGETS;
    changes depending on whether a target is
    specified on the command line:

    </para>

    <literallayout>
      % <userinput>scons -Q</userinput>
      BUILD_TARGETS is ['prog1']
      cc -c -o prog1.o prog1.c
      cc -o prog1 prog1.o
      % <userinput>scons -Q prog2</userinput>
      BUILD_TARGETS is ['prog2']
      cc -c -o prog2.o prog2.c
      cc -o prog2 prog2.o
      % <userinput>scons -Q -c .</userinput>
      BUILD_TARGETS is ['.']
      Removed prog1.o
      Removed prog1
      Removed prog2.o
      Removed prog2
    </literallayout>

  </section>

  <section>
  <title>Command-Line <varname>variable</varname>=<varname>value</varname> Build Options</title>

    <para>

    You may want to control various aspects
    of your build by allowing the user
    to specify <varname>variable</varname>=<varname>value</varname>
    values on the command line.
    For example, suppose you
    want users to be able to
    build a debug version of a program
    by running &SCons; as follows:

    </para>

    <literallayout>
      % scons -Q debug=1
    </literallayout>

    <para>

    &SCons; provides an &ARGUMENTS; dictionary
    that stores all of the
    <varname>variable</varname>=<varname>value</varname>
    assignments from the command line.
    This allows you to modify
    aspects of your build in response
    to specifications on the command line.
    (Note that unless you want to require
    that users <emphasis>always</emphasis>
    specify an option,
    you probably want to use
    the Python
    <literal>ARGUMENTS.get()</literal> function,
    which allows you to specify a default value
    to be used if there is no specification
    on the command line.)

    </para>

    <para>

    The following code sets the &CCFLAGS; construction
    variable in response to the <varname>debug</varname>
    flag being set in the &ARGUMENTS; dictionary:

    </para>

    <programlisting>
       env = Environment()
       debug = ARGUMENTS.get('debug', 0)
       if int(debug):
           env.Append(CCFLAGS = '-g')
       env.Program('prog.c')
    </programlisting>

    <para>

    This results in the <varname>-g</varname>
    compiler option being used when
    <literal>debug=1</literal>
    is used on the command line:

    </para>

    <literallayout>
       % <userinput>scons -Q debug=0</userinput>
       cc -c -o prog.o prog.c
       cc -o prog prog.o
       % <userinput>scons -Q debug=0</userinput>
       scons: `.' is up to date.
       % <userinput>scons -Q debug=1</userinput>
       cc -g -c -o prog.o prog.c
       cc -o prog prog.o
       % <userinput>scons -Q debug=1</userinput>
       scons: `.' is up to date.
    </literallayout>

    <para>

    Notice that &SCons; keeps track of
    the last values used to build the object files,
    and as a result correctly rebuilds
    the object and executable files
    only when the value of the <literal>debug</literal>
    argument has changed.

    </para>

  </section>

  <section>
  <title>Controlling Command-Line Build Options</title>

    <para>

    Being able to use a command-line build option like
    <literal>debug=1</literal> is handy,
    but it can be a chore to write specific Python code
    to recognize each such option
    and apply the values to a construction variable.
    To help with this,
    &SCons; supports a class to
    define such build options easily,
    and a mechanism to apply the
    build options to a construction environment.
    This allows you to control how the build options affect
    construction environments.

    </para>

    <para>

    For example, suppose that you want users to set
    a &RELEASE; construction variable on the
    command line whenever the time comes to build
    a program for release,
    and that the value of this variable
    should be added to the command line
    with the appropriate <literal>-D</literal> option
    (or other command line option)
    to pass the value to the C compiler.
    Here's how you might do that by setting
    the appropriate value in a dictionary for the
    &CPPDEFINES; construction variable:

    </para>

    <programlisting>
         opts = Options()
         opts.Add('RELEASE', 'Set to 1 to build for release', 0)
         env = Environment(options = opts,
                           CPPDEFINES={'RELEASE_BUILD' : '${RELEASE}'})
         env.Program(['foo.c', 'bar.c'])
    </programlisting>

    <para>

    This &SConstruct; file first creates an
    &Options; object
    (the <literal>opts = Options()</literal> call),
    and then uses the object's &Add;
    method to indicate that the &RELEASE;
    option can be set on the command line,
    and that it's default value will be <literal>0</literal>
    (the third argument to the &Add; method).
    The second argument is a line of help text;
    we'll learn how to use it in the next section.

    </para>

    <para>

    We then pass the created &Options;
    object as an &options; keyword argument
    to the &Environment; call
    used to create the construction environment.
    This then allows a user to set the
    &RELEASE; build option on the command line
    and have the variable show up in
    the command line used to build each object from
    a C source file:

    </para>

    <literallayout>
      % <userinput>scons -Q RELEASE=1</userinput>
      cc -DRELEASE_BUILD=1 -c -o bar.o bar.c
      cc -DRELEASE_BUILD=1 -c -o foo.o foo.c
      cc -o foo foo.o bar.o
    </literallayout>

  </section>

  <section>
  <title>Providing Help for Command-Line Build Options</title>

    <para>

    To make command-line build options most useful,
    you ideally want to provide
    some help text that will describe
    the available options
    when the user runs <literal>scons -h</literal>.
    You could write this text by hand,
    but &SCons; provides an easier way.
    &Options; objects support a
    &GenerateHelpText; method
    that will, as its name indicates,
    generate text that describes
    the various options that
    have been added to it.
    You then pass the output from this method to
    the &Help; function:

    </para>

    <programlisting>
         opts = Options('custom.py')
         opts.Add('RELEASE', 'Set to 1 to build for release', 0)
         env = Environment(options = opts)
         Help(opts.GenerateHelpText(env))
    </programlisting>

    <para>

    &SCons; will now display some useful text
    when the <literal>-h</literal> option is used:

    </para>

    <literallayout>
      % <userinput>scons -Q -h</userinput>
      
      RELEASE: Set to 1 to build for release
          default: 0
          actual: 0
      
      Use scons -H for help about command-line options.
    </literallayout>

    <para>

    Notice that the help output shows the default value,
    and the current actual value of the build option.

    </para>

  </section>

  <section>
  <title>Reading Build Options From a File</title>

    <para>

    Being able to use a command-line build option like
    <literal>debug=1</literal> is handy,
    but it can be a chore to write specific Python code
    to recognize each such option
    and apply the values to a construction variable.
    To help with this,
    &SCons; supports a class to
    define such build options easily
    and to read build option values from a file.
    This allows you to control how the build options affect
    construction environments.
    The way you do this is by specifying
    a file name when you call &Options;,
    like &custom_py; in the following example:

    </para>

    <programlisting>
         opts = Options('custom.py')
         opts.Add('RELEASE', 'Set to 1 to build for release', 0)
         env = Environment(options = opts,
                           CPPDEFINES={'RELEASE_BUILD' : '${RELEASE}'})
         env.Program(['foo.c', 'bar.c'])
         Help(opts.GenerateHelpText(env))
    </programlisting>

    <para>

    This then allows us to control the &RELEASE;
    variable by setting it in the &custom_py; file:

    </para>

    <programlisting>
      RELEASE = 1
      </programlisting>

    <para>

    Note that this file is actually executed
    like a Python script.
    Now when we run &SCons;:

    </para>

    <literallayout>
      % <userinput>scons -Q</userinput>
      cc -DRELEASE_BUILD=1 -c -o bar.o bar.c
      cc -DRELEASE_BUILD=1 -c -o foo.o foo.c
      cc -o foo foo.o bar.o
    </literallayout>

    <para>

    And if we change the contents of &custom_py; to:

    </para>

    <programlisting>
      RELEASE = 0
    </programlisting>

    <para>

    The object files are rebuilt appropriately
    with the new option:

    </para>

    <literallayout>
      % <userinput>scons -Q</userinput>
      cc -DRELEASE_BUILD=0 -c -o bar.o bar.c
      cc -DRELEASE_BUILD=0 -c -o foo.o foo.c
      cc -o foo foo.o bar.o
    </literallayout>

  </section>

  <section>
  <title>Canned Build Options</title>

    <para>

    &SCons; provides a number of functions
    that provide ready-made behaviors
    for various types of command-line build options.

    </para>

    <section>
    <title>True/False Values:  the &BoolOption; Build Option</title>

      <para>

      It's often handy to be able to specify an
      option that controls a simple Boolean variable
      with a &true; or &false; value.
      It would be even more handy to accomodate
      users who have different preferences for how to represent
      &true; or &false; values.
      The &BoolOption; function
      makes it easy to accomodate a variety of
      common values that represent
      &true; or &false;.

      </para>

      <para>

      The &BoolOption; function takes three arguments:
      the name of the build option,
      the default value of the build option,
      and the help string for the option.
      It then returns appropriate information for
      passing to the &Add; method of an &Options; object, like so:

      </para>

      <programlisting>
           opts = Options('custom.py')
           opts.Add(BoolOption('RELEASE', 0, 'Set to build for release'))
           env = Environment(options = opts,
                             CPPDEFINES={'RELEASE_BUILD' : '${RELEASE}'})
           env.Program('foo.c')
      </programlisting>

      <para>

      With this build option,
      the &RELEASE; variable can now be enabled by
      setting it to the value <literal>yes</literal>
      or <literal>t</literal>:

      </para>

      <literallayout>
        % <userinput>scons -Q RELEASE=yes foo.o</userinput>
        cc -DRELEASE_BUILD=1 -c -o foo.o foo.c
      </literallayout>

      <literallayout>
        % <userinput>scons -Q RELEASE=t foo.o</userinput>
        cc -DRELEASE_BUILD=1 -c -o foo.o foo.c
      </literallayout>

      <para>

      Other values that equate to &true; include
      <literal>y</literal>,
      <literal>1</literal>,
      <literal>on</literal>
      and
      <literal>all</literal>.

      </para>

      <para>

      Conversely, &RELEASE; may now be given a &false;
      value by setting it to
      <literal>no</literal>
      or
      <literal>f</literal>:

      </para>

      <literallayout>
        % <userinput>scons -Q RELEASE=no foo.o</userinput>
        cc -DRELEASE_BUILD=0 -c -o foo.o foo.c
      </literallayout>

      <literallayout>
        % <userinput>scons -Q RELEASE=f foo.o</userinput>
        cc -DRELEASE_BUILD=0 -c -o foo.o foo.c
      </literallayout>

      <para>

      Other values that equate to &true; include
      <literal>n</literal>,
      <literal>0</literal>,
      <literal>off</literal>
      and
      <literal>none</literal>.

      </para>

      <para>

      Lastly, if a user tries to specify
      any other value,
      &SCons; supplies an appropriate error message:

      </para>

      <literallayout>
        % <userinput>scons -Q RELEASE=bad_value foo.o</userinput>
        
        scons: *** Error converting option: RELEASE
        Invalid value for boolean option: bad_value
        File "SConstruct", line 4, in ?
      </literallayout>

    </section>

    <section>
    <title>Single Value From a List:  the &EnumOption; Build Option</title>

      <para>

      Suppose that we want a user to be able to
      set a &COLOR; option
      that selects a background color to be
      displayed by an application,
      but that we want to restrict the
      choices to a specific set of allowed colors.
      This can be set up quite easily
      using the &EnumOption;,
      which takes a list of &allowed_values
      in addition to the variable name,
      default value,
      and help text arguments:

      </para>

      <programlisting>
           opts = Options('custom.py')
           opts.Add(EnumOption('COLOR', 'red', 'Set background color',
                               allowed_values=('red', 'green', 'blue')))
           env = Environment(options = opts,
                             CPPDEFINES={'COLOR' : '"${COLOR}"'})
           env.Program('foo.c')
      </programlisting>

      <para>

      The user can now explicity set the &COLOR; build option
      to any of the specified allowed values:

      </para>

      <literallayout>
        % <userinput>scons -Q COLOR=red foo.o</userinput>
        cc -DCOLOR="red" -c -o foo.o foo.c
        % <userinput>scons -Q COLOR=blue foo.o</userinput>
        cc -DCOLOR="blue" -c -o foo.o foo.c
        % <userinput>scons -Q COLOR=green foo.o</userinput>
        cc -DCOLOR="green" -c -o foo.o foo.c
      </literallayout>

      <para>

      But, almost more importantly,
      an attempt to set &COLOR;
      to a value that's not in the list
      generates an error message:

      </para>

      <literallayout>
        % <userinput>scons -Q COLOR=magenta foo.o</userinput>
        
        scons: *** Invalid value for option COLOR: magenta
        File "SConstruct", line 5, in ?
      </literallayout>

      <para>

      The &EnumOption; function also supports a way
      to map alternate names to allowed values.
      Suppose, for example,
      that we want to allow the user
      to use the word <literal>navy</literal> as a synonym for
      <literal>blue</literal>.
      We do this by adding a &map; dictionary
      that will map its key values
      to the desired legal value:

      </para>

      <programlisting>
           opts = Options('custom.py')
           opts.Add(EnumOption('COLOR', 'red', 'Set background color',
                               allowed_values=('red', 'green', 'blue'),
                               map={'navy':'blue'}))
           env = Environment(options = opts,
                             CPPDEFINES={'COLOR' : '"${COLOR}"'})
           env.Program('foo.c')
      </programlisting>

      <para>

      As desired, the user can then use
      <literal>navy</literal> on the command line,
      and &SCons; will translate it into <literal>blue</literal>
      when it comes time to use the &COLOR;
      option to build a target:

      </para>

      <literallayout>
        % <userinput>scons -Q COLOR=navy foo.o</userinput>
        cc -DCOLOR="blue" -c -o foo.o foo.c
      </literallayout>

      <para>

      By default, when using the &EnumOption; function,
      arguments that differ
      from the legal values
      only in case
      are treated as illegal values:

      </para>

      <literallayout>
        % <userinput>scons -Q COLOR=Red foo.o</userinput>
        
        scons: *** Invalid value for option COLOR: Red
        File "SConstruct", line 5, in ?
        % <userinput>scons -Q COLOR=BLUE foo.o</userinput>
        
        scons: *** Invalid value for option COLOR: BLUE
        File "SConstruct", line 5, in ?
        % <userinput>scons -Q COLOR=nAvY foo.o</userinput>
        
        scons: *** Invalid value for option COLOR: nAvY
        File "SConstruct", line 5, in ?
      </literallayout>

      <para>

      The &EnumOption; function can take an additional
      &ignorecase; keyword argument that,
      when set to <literal>1</literal>,
      tells &SCons; to allow case differences
      when the values are specified:

      </para>

      <programlisting>
           opts = Options('custom.py')
           opts.Add(EnumOption('COLOR', 'red', 'Set background color',
                               allowed_values=('red', 'green', 'blue'),
                               map={'navy':'blue'},
                               ignorecase=1))
           env = Environment(options = opts,
                             CPPDEFINES={'COLOR' : '"${COLOR}"'})
           env.Program('foo.c')
      </programlisting>

      <para>

      Which yields the output:

      </para>

      <literallayout>
        % <userinput>scons -Q COLOR=Red foo.o</userinput>
        cc -DCOLOR="Red" -c -o foo.o foo.c
        % <userinput>scons -Q COLOR=BLUE foo.o</userinput>
        cc -DCOLOR="BLUE" -c -o foo.o foo.c
        % <userinput>scons -Q COLOR=nAvY foo.o</userinput>
        cc -DCOLOR="blue" -c -o foo.o foo.c
        % <userinput>scons -Q COLOR=green foo.o</userinput>
        cc -DCOLOR="green" -c -o foo.o foo.c
      </literallayout>

      <para>

      Notice that an &ignorecase; value of <literal>1</literal>
      preserves the case-spelling that the user supplied.
      If you want &SCons; to translate the names
      into lower-case,
      regardless of the case used by the user,
      specify an &ignorecase; value of <literal>2</literal>:

      </para>

      <programlisting>
           opts = Options('custom.py')
           opts.Add(EnumOption('COLOR', 'red', 'Set background color',
                               allowed_values=('red', 'green', 'blue'),
                               map={'navy':'blue'},
                               ignorecase=2))
           env = Environment(options = opts,
                             CPPDEFINES={'COLOR' : '"${COLOR}"'})
           env.Program('foo.c')
      </programlisting>

      <para>

      Now &SCons; will use values of
      <literal>red</literal>,
      <literal>green</literal> or
      <literal>blue</literal>
      regardless of how the user spells
      those values on the command line:

      </para>

      <literallayout>
        % <userinput>scons -Q COLOR=Red foo.o</userinput>
        cc -DCOLOR="red" -c -o foo.o foo.c
        % <userinput>scons -Q COLOR=nAvY foo.o</userinput>
        cc -DCOLOR="blue" -c -o foo.o foo.c
        % <userinput>scons -Q COLOR=GREEN foo.o</userinput>
        cc -DCOLOR="green" -c -o foo.o foo.c
      </literallayout>

    </section>

    <section>
    <title>Multiple Values From a List:  the &ListOption; Build Option</title>

      <para>

      Another way in which you might want to allow users
      to control build option is to
      specify a list of one or more legal values.
      &SCons; supports this through the &ListOption; function.
      If, for example, we want a user to be able to set a
      &COLORS; option to one or more of the legal list of values:

      </para>

      <programlisting>
           opts = Options('custom.py')
           opts.Add(ListOption('COLORS', 0, 'List of colors',
                               ['red', 'green', 'blue']))
           env = Environment(options = opts,
                             CPPDEFINES={'COLORS' : '"${COLORS}"'})
           env.Program('foo.c')
      </programlisting>

      <para>

      A user can now specify a comma-separated list
      of legal values,
      which will get translated into a space-separated
      list for passing to the any build commands:

      </para>

      <literallayout>
        % <userinput>scons -Q COLORS=red,blue foo.o</userinput>
        TypeError: sequence item 0: expected string, int found:
        % <userinput>scons -Q COLORS=blue,green,red foo.o</userinput>
        TypeError: sequence item 0: expected string, int found:
      </literallayout>

      <para>

      In addition, the &ListOption; function
      allows the user to specify explicit keywords of
      &all; or &none;
      to select all of the legal values,
      or none of them, respectively:

      </para>

      <literallayout>
        % <userinput>scons -Q COLORS=all foo.o</userinput>
        TypeError: sequence item 0: expected string, int found:
        % <userinput>scons -Q COLORS=none foo.o</userinput>
        TypeError: sequence item 0: expected string, int found:
      </literallayout>

      <para>

      And, of course, an illegal value
      still generates an error message:

      </para>

      <literallayout>
        % <userinput>scons -Q COLORS=magenta foo.o</userinput>
        TypeError: sequence item 0: expected string, int found:
      </literallayout>

    </section>

    <section>
    <title>Path Names:  the &PathOption; Build Option</title>

      <para>

      &SCons; supports a &PathOption; function
      to make it easy to create a build option
      to control an expected path name.
      If, for example, you need to
      define a variable in the preprocessor
      that control the location of a
      configuration file:

      </para>

      <programlisting>
           opts = Options('custom.py')
           opts.Add(PathOption('CONFIG', '/etc/my_config', 'Path to configuration file'))
           env = Environment(options = opts,
                             CPPDEFINES={'CONFIG_FILE' : '"$CONFIG"'})
           env.Program('foo.c')
      </programlisting>

      <para>

      This then allows the user to
      override the &CONFIG; build option
      on the command line as necessary:

      </para>

      <literallayout>
        % <userinput>scons -Q foo.o</userinput>
        
        scons: *** Path does not exist for option CONFIG: Path to configuration file
        File "SConstruct", line 4, in ?
        % <userinput>scons -Q CONFIG=/usr/local/etc/other_config foo.o</userinput>
        cc -DCONFIG_FILE="/usr/local/etc/other_config" -c -o foo.o foo.c
      </literallayout>

    </section>

    <section>
    <title>Enabled/Disabled Path Names: the &PackageOption; Build Option</title>

      <para>

      Sometimes you want to give users
      even more control over a path name variable,
      allowing them to explicitly enable or
      disable the path name
      by using <literal>yes</literal> or <literal>no</literal> keywords,
      in addition to allow them
      to supply an explicit path name.
      &SCons; supports the &PackageOption;
      function to support this:

      </para>

      <programlisting>
           opts = Options('custom.py')
           opts.Add(PackageOption('PACKAGE', '/opt/location', 'Location package'))
           env = Environment(options = opts,
                             CPPDEFINES={'PACKAGE' : '"$PACKAGE"'})
           env.Program('foo.c')
      </programlisting>

      <para>

      When the &SConscript; file uses the &PackageOption; funciton,
      user can now still use the default
      or supply an overriding path name,
      but can now explicitly set the
      specified variable to a value
      that indicates the package should be enabled
      (in which case the default should be used)
      or disabled:

      </para>

      <literallayout>
        % <userinput>scons -Q foo.o</userinput>
        
        scons: *** Path does not exist for option PACKAGE: Location package
        File "SConstruct", line 4, in ?
        % <userinput>scons -Q PACKAGE=/usr/local/location foo.o</userinput>
        cc -DPACKAGE="/usr/local/location" -c -o foo.o foo.c
        % <userinput>scons -Q PACKAGE=yes foo.o</userinput>
        cc -DPACKAGE="1" -c -o foo.o foo.c
        % <userinput>scons -Q PACKAGE=no foo.o</userinput>
        cc -DPACKAGE="0" -c -o foo.o foo.c
      </literallayout>

    </section>

  </section>

  <section>
  <title>Adding Multiple Command-Line Build Options at Once</title>

    <para>

    Lastly, &SCons; provides a way to add
    multiple build options to an &Options; object at once.
    Instead of having to call the &Add; method
    multiple times,
    you can call the &AddOptions;
    method with a list of build options
    to be added to the object.
    Each build option is specified
    as either a tuple of arguments,
    just like you'd pass to the &Add; method itself,
    or as a call to one of the canned
    functions for pre-packaged command-line build options.
    in any order:

    </para>

    <programlisting>
        opts = Options()
        opts.AddOptions(
            ('RELEASE', 'Set to 1 to build for release', 0),
            ('CONFIG', 'Configuration file', '/etc/my_config'),
            BoolOption('warnings', 'compilation with -Wall and similiar', 1),
            EnumOption('debug', 'debug output and symbols', 'no',
                       allowed_values=('yes', 'no', 'full'),
                       map={}, ignorecase=0),  # case sensitive
            ListOption('shared',
                       'libraries to build as shared libraries',
                       'all',
                       names = list_of_libs),
            PackageOption('x11',
                          'use X11 installed here (yes = search some places)',
                          'yes'),
            PathOption('qtdir', 'where the root of Qt is installed', qtdir),
        )
    </programlisting>

    <para>
    </para>

  </section>