summaryrefslogtreecommitdiff
path: root/scons.1
blob: 67f777d9bc19644834cd51322429d1ebdc4519a9 (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
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
5357
5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
5542
5543
5544
5545
5546
5547
5548
5549
5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
5560
5561
5562
5563
5564
5565
5566
5567
5568
5569
5570
5571
5572
5573
5574
5575
5576
5577
5578
5579
5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627
5628
5629
5630
5631
5632
5633
5634
5635
5636
5637
5638
5639
5640
5641
5642
5643
5644
5645
5646
5647
5648
5649
5650
5651
5652
5653
5654
5655
5656
5657
5658
5659
5660
5661
5662
5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
5673
5674
5675
5676
5677
5678
5679
5680
5681
5682
5683
5684
5685
5686
5687
5688
5689
5690
5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
5735
5736
5737
5738
5739
5740
5741
5742
5743
5744
5745
5746
5747
5748
5749
5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
5785
5786
5787
5788
5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
5814
5815
5816
5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
5827
5828
5829
5830
5831
5832
5833
5834
5835
5836
5837
5838
5839
5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
5885
5886
5887
5888
5889
5890
5891
5892
5893
5894
5895
5896
5897
5898
5899
5900
5901
5902
5903
5904
5905
5906
5907
5908
5909
5910
5911
5912
5913
5914
5915
5916
5917
5918
5919
5920
5921
5922
5923
5924
5925
5926
5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
5952
5953
5954
5955
5956
5957
5958
5959
5960
5961
5962
5963
5964
5965
5966
5967
5968
5969
5970
5971
5972
5973
5974
5975
5976
5977
5978
5979
5980
5981
5982
5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
6028
6029
6030
6031
6032
6033
6034
6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
6086
6087
6088
6089
6090
6091
6092
6093
6094
6095
6096
6097
6098
6099
6100
6101
6102
6103
6104
6105
6106
6107
6108
6109
6110
6111
6112
6113
6114
6115
6116
6117
6118
6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
6168
6169
6170
6171
6172
6173
6174
6175
6176
6177
6178
6179
6180
6181
6182
6183
6184
6185
6186
6187
6188
6189
6190
6191
6192
6193
6194
6195
6196
6197
6198
6199
6200
6201
6202
6203
6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
6222
6223
6224
6225
6226
6227
6228
6229
6230
6231
6232
6233
6234
6235
6236
6237
6238
6239
6240
6241
6242
6243
6244
6245
6246
6247
6248
6249
6250
6251
6252
6253
6254
6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
6283
6284
6285
6286
6287
6288
6289
6290
6291
6292
6293
6294
6295
6296
6297
6298
6299
6300
6301
6302
6303
6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
6420
6421
6422
6423
6424
6425
6426
6427
6428
6429
6430
6431
6432
6433
6434
6435
6436
6437
6438
6439
6440
6441
6442
6443
6444
6445
6446
6447
6448
6449
6450
6451
6452
6453
6454
6455
6456
6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
6469
6470
6471
6472
6473
6474
6475
6476
6477
6478
6479
6480
6481
6482
6483
6484
6485
6486
6487
6488
6489
6490
6491
6492
6493
6494
6495
6496
6497
6498
6499
6500
6501
6502
6503
6504
6505
6506
6507
6508
6509
6510
6511
6512
6513
6514
6515
6516
6517
6518
6519
6520
6521
6522
6523
6524
6525
6526
6527
6528
6529
6530
6531
6532
6533
6534
6535
6536
6537
6538
6539
6540
6541
6542
6543
6544
6545
6546
6547
6548
6549
6550
6551
6552
6553
6554
6555
6556
6557
6558
6559
6560
6561
6562
6563
6564
6565
6566
6567
6568
6569
6570
6571
6572
6573
6574
6575
6576
6577
6578
6579
6580
6581
6582
6583
6584
6585
6586
6587
6588
6589
6590
6591
6592
6593
6594
6595
6596
6597
6598
6599
6600
6601
6602
6603
6604
6605
6606
6607
6608
6609
6610
6611
6612
6613
6614
6615
6616
6617
6618
6619
6620
6621
6622
6623
6624
6625
6626
6627
6628
6629
6630
6631
6632
6633
6634
6635
6636
6637
6638
6639
6640
6641
6642
6643
6644
6645
6646
6647
6648
6649
6650
6651
6652
6653
6654
6655
6656
6657
6658
6659
6660
6661
6662
6663
6664
6665
6666
6667
6668
6669
6670
6671
6672
6673
6674
6675
6676
6677
6678
6679
6680
6681
6682
6683
6684
6685
6686
6687
6688
6689
6690
6691
6692
6693
6694
6695
6696
6697
6698
6699
6700
6701
6702
6703
6704
6705
6706
6707
6708
6709
6710
6711
6712
6713
6714
6715
6716
6717
6718
6719
6720
6721
6722
6723
6724
6725
6726
6727
6728
6729
6730
6731
6732
6733
6734
6735
6736
6737
6738
6739
6740
6741
6742
6743
6744
6745
6746
6747
6748
6749
6750
6751
6752
6753
6754
6755
6756
6757
6758
6759
6760
6761
6762
6763
6764
6765
6766
6767
6768
6769
6770
6771
6772
6773
6774
6775
6776
6777
6778
6779
6780
6781
6782
6783
6784
6785
6786
6787
6788
6789
6790
6791
6792
6793
6794
6795
6796
6797
6798
6799
6800
6801
6802
6803
6804
6805
6806
6807
6808
6809
6810
6811
6812
6813
6814
6815
6816
6817
6818
6819
6820
6821
6822
6823
6824
6825
6826
6827
6828
6829
6830
6831
6832
6833
6834
6835
6836
6837
6838
6839
6840
6841
6842
6843
6844
6845
6846
6847
6848
6849
6850
6851
6852
6853
6854
6855
6856
6857
6858
6859
6860
6861
6862
6863
6864
6865
6866
6867
6868
6869
6870
6871
6872
6873
6874
6875
6876
6877
6878
6879
6880
6881
6882
6883
6884
6885
6886
6887
6888
6889
6890
6891
6892
6893
6894
6895
6896
6897
6898
6899
6900
6901
6902
6903
6904
6905
6906
6907
6908
6909
6910
6911
6912
6913
6914
6915
6916
6917
6918
6919
6920
6921
6922
6923
6924
6925
6926
6927
6928
6929
6930
6931
6932
6933
6934
6935
6936
6937
6938
6939
6940
6941
6942
6943
6944
6945
6946
6947
6948
6949
6950
6951
6952
6953
6954
6955
6956
6957
6958
6959
6960
6961
6962
6963
6964
6965
6966
6967
6968
6969
6970
6971
6972
6973
6974
6975
6976
6977
6978
6979
6980
6981
6982
6983
6984
6985
6986
6987
6988
6989
6990
6991
6992
6993
6994
6995
6996
6997
6998
6999
7000
7001
7002
7003
7004
7005
7006
7007
7008
7009
7010
7011
7012
7013
7014
7015
7016
7017
7018
7019
7020
7021
7022
7023
7024
7025
7026
7027
7028
7029
7030
7031
7032
7033
7034
7035
7036
7037
7038
7039
7040
7041
7042
7043
7044
7045
7046
7047
7048
7049
7050
7051
7052
7053
7054
7055
7056
7057
7058
7059
7060
7061
7062
7063
7064
7065
7066
7067
7068
7069
7070
7071
7072
7073
7074
7075
7076
7077
7078
7079
7080
7081
7082
7083
7084
7085
7086
7087
7088
7089
7090
7091
7092
7093
7094
7095
7096
7097
7098
7099
7100
7101
7102
7103
7104
7105
7106
7107
7108
7109
7110
7111
7112
7113
7114
7115
7116
7117
7118
7119
7120
7121
7122
7123
7124
7125
7126
7127
7128
7129
7130
7131
7132
7133
7134
7135
7136
7137
7138
7139
7140
7141
7142
7143
7144
7145
7146
7147
7148
7149
7150
7151
7152
7153
7154
7155
7156
7157
7158
7159
7160
7161
7162
7163
7164
7165
7166
7167
7168
7169
7170
7171
7172
7173
7174
7175
7176
7177
7178
7179
7180
7181
7182
7183
7184
7185
7186
7187
7188
7189
7190
7191
7192
7193
7194
7195
7196
7197
7198
7199
7200
7201
7202
7203
7204
7205
7206
7207
7208
7209
7210
7211
7212
7213
7214
7215
7216
7217
7218
7219
7220
7221
7222
7223
7224
7225
7226
7227
7228
7229
7230
7231
7232
7233
7234
7235
7236
7237
7238
7239
7240
7241
7242
7243
7244
7245
7246
7247
7248
7249
7250
7251
7252
7253
7254
7255
7256
7257
7258
7259
7260
7261
7262
7263
7264
7265
7266
7267
7268
7269
7270
7271
7272
7273
7274
7275
7276
7277
7278
7279
7280
7281
7282
7283
7284
7285
7286
7287
7288
7289
7290
7291
7292
7293
7294
7295
7296
7297
7298
7299
7300
7301
7302
7303
7304
7305
7306
7307
7308
7309
7310
7311
7312
7313
7314
7315
7316
7317
7318
7319
7320
7321
7322
7323
7324
7325
7326
7327
7328
7329
7330
7331
7332
7333
7334
7335
7336
7337
7338
7339
7340
7341
7342
7343
7344
7345
7346
7347
7348
7349
7350
7351
7352
7353
7354
7355
7356
7357
7358
7359
7360
7361
7362
7363
7364
7365
7366
7367
7368
7369
7370
7371
7372
7373
7374
7375
7376
7377
7378
7379
7380
7381
7382
7383
7384
7385
7386
7387
7388
7389
7390
7391
7392
7393
7394
7395
7396
7397
7398
7399
7400
7401
7402
7403
7404
7405
7406
7407
7408
7409
7410
7411
7412
7413
7414
7415
7416
7417
7418
7419
7420
7421
7422
7423
7424
7425
7426
7427
7428
7429
7430
7431
7432
7433
7434
7435
7436
7437
7438
7439
7440
7441
7442
7443
7444
7445
7446
7447
7448
7449
7450
7451
7452
7453
7454
7455
7456
7457
7458
7459
7460
7461
7462
7463
7464
7465
7466
7467
7468
7469
7470
7471
7472
7473
7474
7475
7476
7477
7478
7479
7480
7481
7482
7483
7484
7485
7486
7487
7488
7489
7490
7491
7492
7493
7494
7495
7496
7497
7498
7499
7500
7501
7502
7503
7504
7505
7506
7507
7508
7509
7510
7511
7512
7513
7514
7515
7516
7517
7518
7519
7520
7521
7522
7523
7524
7525
7526
7527
7528
7529
7530
7531
7532
7533
7534
7535
7536
7537
7538
7539
7540
7541
7542
7543
7544
7545
7546
7547
7548
7549
7550
7551
7552
7553
7554
7555
7556
7557
7558
7559
7560
7561
7562
7563
7564
7565
7566
7567
7568
7569
7570
7571
7572
7573
7574
7575
7576
7577
7578
7579
7580
7581
7582
7583
7584
7585
7586
7587
7588
7589
7590
7591
7592
7593
7594
7595
7596
7597
7598
7599
7600
7601
7602
7603
7604
7605
7606
7607
7608
7609
7610
7611
7612
7613
7614
7615
7616
7617
7618
7619
7620
7621
7622
7623
7624
7625
7626
7627
7628
7629
7630
7631
7632
7633
7634
7635
7636
7637
7638
7639
7640
7641
7642
7643
7644
7645
7646
7647
7648
7649
7650
7651
7652
7653
7654
7655
7656
7657
7658
7659
7660
7661
7662
7663
7664
7665
7666
7667
7668
7669
7670
7671
7672
7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
7686
7687
7688
7689
7690
7691
7692
7693
7694
7695
7696
7697
7698
7699
7700
7701
7702
7703
7704
7705
7706
7707
7708
7709
7710
7711
7712
7713
7714
7715
7716
7717
7718
7719
7720
7721
7722
7723
7724
7725
7726
7727
7728
7729
7730
7731
7732
7733
7734
7735
7736
7737
7738
7739
7740
7741
7742
7743
7744
7745
7746
7747
7748
7749
7750
7751
7752
7753
7754
7755
7756
7757
7758
7759
7760
7761
7762
7763
7764
7765
7766
7767
7768
7769
7770
7771
7772
7773
7774
7775
7776
7777
7778
7779
7780
7781
7782
7783
7784
7785
7786
7787
7788
7789
7790
7791
7792
7793
7794
7795
7796
7797
7798
7799
7800
7801
7802
7803
7804
7805
7806
7807
7808
7809
7810
7811
7812
7813
7814
7815
7816
7817
7818
7819
7820
7821
7822
7823
7824
7825
7826
7827
7828
7829
7830
7831
7832
7833
7834
7835
7836
7837
7838
7839
7840
7841
7842
7843
7844
7845
7846
7847
7848
7849
7850
7851
7852
7853
7854
7855
7856
7857
7858
7859
7860
7861
7862
7863
7864
7865
7866
7867
7868
7869
7870
7871
7872
7873
7874
7875
7876
7877
7878
7879
7880
7881
7882
7883
7884
7885
7886
7887
7888
7889
7890
7891
7892
7893
7894
7895
7896
7897
7898
7899
7900
7901
7902
7903
7904
7905
7906
7907
7908
7909
7910
7911
7912
7913
7914
7915
7916
7917
7918
7919
7920
7921
7922
7923
7924
7925
7926
7927
7928
7929
7930
7931
7932
7933
7934
7935
7936
7937
7938
7939
7940
7941
7942
7943
7944
7945
7946
7947
7948
7949
7950
7951
7952
7953
7954
7955
7956
7957
7958
7959
7960
7961
7962
7963
7964
7965
7966
7967
7968
7969
7970
7971
7972
7973
7974
7975
7976
7977
7978
7979
7980
7981
7982
7983
7984
7985
7986
7987
7988
7989
7990
7991
7992
7993
7994
7995
7996
7997
7998
7999
8000
8001
8002
8003
8004
8005
8006
8007
8008
8009
8010
8011
8012
8013
8014
8015
8016
8017
8018
8019
8020
8021
8022
8023
8024
8025
8026
8027
8028
8029
8030
8031
8032
8033
8034
8035
8036
8037
8038
8039
8040
8041
8042
8043
8044
8045
8046
8047
8048
8049
8050
8051
8052
8053
8054
8055
8056
8057
8058
8059
8060
8061
8062
8063
8064
8065
8066
8067
8068
8069
8070
8071
8072
8073
8074
8075
8076
8077
8078
8079
8080
8081
8082
8083
8084
8085
8086
8087
8088
8089
8090
8091
8092
8093
8094
8095
8096
8097
8098
8099
8100
8101
8102
8103
8104
8105
8106
8107
8108
8109
8110
8111
8112
8113
8114
8115
8116
8117
8118
8119
8120
8121
8122
8123
8124
8125
8126
8127
8128
8129
8130
8131
8132
8133
8134
8135
8136
8137
8138
8139
8140
8141
8142
8143
8144
8145
8146
8147
8148
8149
8150
8151
8152
8153
8154
8155
8156
8157
8158
8159
8160
8161
8162
8163
8164
8165
8166
8167
8168
8169
8170
8171
8172
8173
8174
8175
8176
8177
8178
8179
8180
8181
8182
8183
8184
8185
8186
8187
8188
8189
8190
8191
8192
8193
8194
8195
8196
8197
8198
8199
8200
8201
8202
8203
8204
8205
8206
8207
8208
8209
8210
8211
8212
8213
8214
8215
8216
8217
8218
8219
8220
8221
8222
8223
8224
8225
8226
8227
8228
8229
8230
8231
8232
8233
8234
8235
8236
8237
8238
8239
8240
8241
8242
8243
8244
8245
8246
8247
8248
8249
8250
8251
8252
8253
8254
8255
8256
8257
8258
8259
8260
8261
8262
8263
8264
8265
8266
8267
8268
8269
8270
8271
8272
8273
8274
8275
8276
8277
8278
8279
8280
8281
8282
8283
8284
8285
8286
8287
8288
8289
8290
8291
8292
8293
8294
8295
8296
8297
8298
8299
8300
8301
8302
8303
8304
8305
8306
8307
8308
8309
8310
8311
8312
8313
8314
8315
8316
8317
8318
8319
8320
8321
8322
8323
8324
8325
8326
8327
8328
8329
8330
8331
8332
8333
8334
8335
8336
8337
8338
8339
8340
8341
8342
8343
8344
8345
8346
8347
8348
8349
8350
8351
8352
8353
8354
8355
8356
8357
8358
8359
8360
8361
8362
8363
8364
8365
8366
8367
8368
8369
8370
8371
8372
8373
8374
8375
8376
8377
8378
8379
8380
8381
8382
8383
8384
8385
8386
8387
8388
8389
8390
8391
8392
8393
8394
8395
8396
8397
8398
8399
8400
8401
8402
8403
8404
8405
8406
8407
8408
8409
8410
8411
8412
8413
8414
8415
8416
8417
8418
8419
8420
8421
8422
8423
8424
8425
8426
8427
8428
8429
8430
8431
8432
8433
8434
8435
8436
8437
8438
8439
8440
8441
8442
8443
8444
8445
8446
8447
8448
8449
8450
8451
8452
8453
8454
8455
8456
8457
8458
8459
8460
8461
8462
8463
8464
8465
8466
8467
8468
8469
8470
8471
8472
8473
8474
8475
8476
8477
8478
8479
8480
8481
8482
8483
8484
8485
8486
8487
8488
8489
8490
8491
8492
8493
8494
8495
8496
8497
8498
8499
8500
8501
8502
8503
8504
8505
8506
8507
8508
8509
8510
8511
8512
8513
8514
8515
8516
8517
8518
8519
8520
8521
8522
8523
8524
8525
8526
8527
8528
8529
8530
8531
8532
8533
8534
8535
8536
8537
8538
8539
8540
8541
8542
8543
8544
8545
8546
8547
8548
8549
8550
8551
8552
8553
8554
8555
8556
8557
8558
8559
8560
8561
8562
8563
8564
8565
8566
8567
8568
8569
8570
8571
8572
8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
8585
8586
8587
8588
8589
8590
8591
8592
8593
8594
8595
8596
8597
8598
8599
8600
8601
8602
8603
8604
8605
8606
8607
8608
8609
8610
8611
8612
8613
8614
8615
8616
8617
8618
8619
8620
8621
8622
8623
8624
8625
8626
8627
8628
8629
8630
8631
8632
8633
8634
8635
8636
8637
8638
8639
8640
8641
8642
8643
8644
8645
8646
8647
8648
8649
8650
8651
8652
8653
8654
8655
8656
8657
8658
8659
8660
8661
8662
8663
8664
8665
8666
8667
8668
8669
8670
8671
8672
8673
8674
8675
8676
8677
8678
8679
8680
8681
8682
8683
8684
8685
8686
8687
8688
8689
8690
8691
8692
8693
8694
8695
8696
8697
8698
8699
8700
8701
8702
8703
8704
8705
8706
8707
8708
8709
8710
8711
8712
8713
8714
8715
8716
8717
8718
8719
8720
8721
8722
8723
8724
8725
8726
8727
8728
8729
8730
8731
8732
8733
8734
8735
8736
8737
8738
8739
8740
8741
8742
8743
8744
8745
8746
8747
8748
8749
8750
8751
8752
8753
8754
8755
8756
8757
8758
8759
8760
8761
8762
8763
8764
8765
8766
8767
8768
8769
8770
8771
8772
8773
8774
8775
8776
8777
8778
8779
8780
8781
8782
8783
8784
8785
8786
8787
8788
8789
8790
8791
8792
8793
8794
8795
8796
8797
8798
8799
8800
8801
8802
8803
8804
8805
8806
8807
8808
8809
8810
8811
8812
8813
8814
8815
8816
8817
8818
8819
8820
8821
8822
8823
8824
8825
8826
8827
8828
8829
8830
8831
8832
8833
8834
8835
8836
8837
8838
8839
8840
8841
8842
8843
8844
8845
8846
8847
8848
8849
8850
8851
8852
8853
8854
8855
8856
8857
8858
8859
8860
8861
8862
8863
8864
8865
8866
8867
8868
8869
8870
8871
8872
8873
8874
8875
8876
8877
8878
8879
8880
8881
8882
8883
8884
8885
8886
8887
8888
8889
8890
8891
8892
8893
8894
8895
8896
8897
8898
8899
8900
8901
8902
8903
8904
8905
8906
8907
8908
8909
8910
8911
8912
8913
8914
8915
8916
8917
8918
8919
8920
8921
8922
8923
8924
8925
8926
8927
8928
8929
8930
8931
8932
8933
8934
8935
8936
8937
8938
8939
8940
8941
8942
8943
8944
8945
8946
8947
8948
8949
8950
8951
8952
8953
8954
8955
8956
8957
8958
8959
8960
8961
8962
8963
8964
8965
8966
8967
8968
8969
8970
8971
8972
8973
8974
8975
8976
8977
8978
8979
8980
8981
8982
8983
8984
8985
8986
8987
8988
8989
8990
8991
8992
8993
8994
8995
8996
8997
8998
8999
9000
9001
9002
9003
9004
9005
9006
9007
9008
9009
9010
9011
9012
9013
9014
9015
9016
9017
9018
9019
9020
9021
9022
9023
9024
9025
9026
9027
9028
9029
9030
9031
9032
9033
9034
9035
9036
9037
9038
9039
9040
9041
9042
9043
9044
9045
9046
9047
9048
9049
9050
9051
9052
9053
9054
9055
9056
9057
9058
9059
9060
9061
9062
9063
9064
9065
9066
9067
9068
9069
9070
9071
9072
9073
9074
9075
9076
9077
9078
9079
9080
9081
9082
9083
9084
9085
9086
9087
9088
9089
9090
9091
9092
9093
9094
9095
9096
9097
9098
9099
9100
9101
9102
9103
9104
9105
9106
9107
9108
9109
9110
9111
9112
9113
9114
9115
9116
9117
9118
9119
9120
9121
9122
9123
9124
9125
9126
9127
9128
9129
9130
9131
9132
9133
9134
9135
9136
9137
9138
9139
9140
9141
9142
9143
9144
9145
9146
9147
9148
9149
9150
9151
9152
9153
9154
9155
9156
9157
9158
9159
9160
9161
9162
9163
9164
9165
9166
9167
9168
9169
9170
9171
9172
9173
9174
9175
9176
9177
9178
9179
9180
9181
9182
9183
9184
9185
9186
9187
9188
9189
9190
9191
9192
9193
9194
9195
9196
9197
9198
9199
9200
9201
9202
9203
9204
9205
9206
9207
9208
9209
9210
9211
9212
9213
9214
9215
9216
9217
9218
9219
9220
9221
9222
9223
9224
9225
9226
9227
9228
9229
9230
9231
9232
9233
9234
9235
9236
9237
9238
9239
9240
9241
9242
9243
9244
9245
9246
9247
9248
9249
9250
9251
9252
9253
9254
9255
9256
9257
9258
9259
9260
9261
9262
9263
9264
9265
9266
9267
9268
9269
9270
9271
9272
9273
9274
9275
9276
9277
9278
9279
9280
9281
9282
9283
9284
9285
9286
9287
9288
9289
9290
9291
9292
9293
9294
9295
9296
9297
9298
9299
9300
9301
9302
9303
9304
9305
9306
9307
9308
9309
9310
9311
9312
9313
9314
9315
9316
9317
9318
9319
9320
9321
9322
9323
9324
9325
9326
9327
9328
9329
9330
9331
9332
9333
9334
9335
9336
9337
9338
9339
9340
9341
9342
9343
9344
9345
9346
9347
9348
9349
9350
9351
9352
9353
9354
9355
9356
9357
9358
9359
9360
9361
9362
9363
9364
9365
9366
9367
9368
9369
9370
9371
9372
9373
9374
9375
9376
9377
9378
9379
9380
9381
9382
9383
9384
9385
9386
9387
9388
9389
9390
9391
9392
9393
9394
9395
9396
9397
9398
9399
9400
9401
9402
9403
9404
9405
9406
9407
9408
9409
9410
9411
9412
9413
9414
9415
9416
9417
9418
9419
9420
9421
9422
9423
9424
9425
9426
9427
9428
9429
9430
9431
9432
9433
9434
9435
9436
9437
9438
9439
9440
9441
9442
9443
9444
9445
9446
9447
9448
9449
9450
9451
9452
9453
9454
9455
9456
9457
9458
9459
9460
9461
9462
9463
9464
9465
9466
9467
9468
9469
9470
9471
9472
9473
9474
9475
9476
9477
9478
9479
9480
9481
9482
9483
9484
9485
9486
9487
9488
9489
9490
9491
9492
9493
9494
9495
9496
9497
9498
9499
9500
9501
9502
9503
9504
9505
9506
9507
9508
9509
9510
9511
9512
9513
9514
9515
9516
9517
9518
9519
9520
9521
9522
9523
9524
9525
9526
9527
9528
9529
9530
9531
9532
9533
9534
9535
9536
9537
9538
9539
9540
9541
9542
9543
9544
9545
9546
9547
9548
9549
9550
9551
9552
9553
9554
9555
9556
9557
9558
9559
9560
9561
9562
9563
9564
9565
9566
9567
9568
9569
9570
9571
9572
9573
9574
9575
9576
9577
9578
9579
9580
9581
9582
9583
9584
9585
9586
9587
9588
9589
9590
9591
9592
9593
9594
9595
9596
9597
9598
9599
9600
9601
9602
9603
9604
9605
9606
9607
9608
9609
9610
9611
9612
9613
9614
9615
9616
9617
9618
9619
9620
9621
9622
9623
9624
9625
9626
9627
9628
9629
9630
9631
9632
9633
9634
9635
9636
9637
9638
9639
9640
9641
9642
9643
9644
9645
9646
9647
9648
9649
9650
9651
9652
9653
9654
9655
9656
9657
9658
9659
9660
9661
9662
9663
9664
9665
9666
9667
9668
9669
9670
9671
9672
9673
9674
9675
9676
9677
9678
9679
9680
9681
9682
9683
9684
9685
9686
9687
9688
9689
9690
9691
9692
9693
9694
9695
9696
9697
9698
9699
9700
9701
9702
9703
9704
9705
9706
9707
9708
9709
9710
9711
9712
9713
9714
9715
9716
9717
9718
9719
9720
9721
9722
9723
9724
9725
9726
9727
9728
9729
9730
9731
9732
9733
9734
9735
9736
9737
9738
9739
9740
9741
9742
9743
9744
9745
9746
9747
9748
9749
9750
9751
9752
9753
9754
9755
9756
9757
9758
9759
9760
9761
9762
9763
9764
9765
9766
9767
9768
9769
9770
9771
9772
9773
9774
9775
9776
9777
9778
9779
9780
9781
9782
9783
9784
9785
9786
9787
9788
9789
9790
9791
9792
9793
9794
9795
9796
9797
9798
9799
9800
9801
9802
9803
9804
9805
9806
9807
9808
9809
9810
9811
9812
9813
9814
9815
9816
9817
9818
9819
9820
9821
9822
9823
9824
9825
9826
9827
9828
9829
9830
9831
9832
9833
9834
9835
9836
9837
9838
9839
9840
9841
9842
9843
9844
9845
9846
9847
9848
9849
9850
9851
9852
9853
9854
9855
9856
9857
9858
9859
9860
9861
9862
9863
9864
9865
9866
9867
9868
9869
9870
9871
9872
9873
9874
9875
9876
9877
9878
9879
9880
9881
9882
9883
9884
9885
9886
9887
9888
9889
9890
9891
9892
9893
9894
9895
9896
9897
9898
9899
9900
9901
9902
9903
9904
9905
9906
9907
9908
9909
9910
9911
9912
9913
9914
9915
9916
9917
9918
9919
9920
9921
9922
9923
9924
9925
9926
9927
9928
9929
9930
9931
9932
9933
9934
9935
9936
9937
9938
9939
9940
9941
9942
9943
9944
9945
9946
9947
9948
9949
9950
9951
9952
9953
9954
9955
9956
9957
9958
9959
9960
9961
9962
9963
9964
9965
9966
9967
9968
9969
9970
9971
9972
9973
9974
9975
9976
9977
9978
9979
9980
9981
9982
9983
9984
9985
9986
9987
9988
9989
9990
9991
9992
9993
9994
9995
9996
9997
9998
9999
10000
10001
10002
10003
10004
10005
10006
10007
10008
10009
10010
10011
10012
10013
10014
10015
10016
10017
10018
10019
10020
10021
10022
10023
10024
10025
10026
10027
10028
10029
10030
10031
10032
10033
10034
10035
10036
10037
10038
10039
10040
10041
10042
10043
10044
10045
10046
10047
10048
10049
10050
10051
10052
10053
10054
10055
10056
10057
10058
10059
10060
10061
10062
10063
10064
10065
10066
10067
10068
10069
10070
10071
10072
10073
10074
10075
10076
10077
10078
10079
10080
10081
10082
10083
10084
10085
10086
10087
10088
10089
10090
10091
10092
10093
10094
10095
10096
10097
10098
10099
10100
10101
10102
10103
10104
10105
10106
10107
10108
10109
10110
10111
10112
10113
10114
10115
10116
10117
10118
10119
10120
10121
10122
10123
10124
10125
10126
10127
10128
10129
10130
10131
10132
10133
10134
10135
10136
10137
10138
10139
10140
10141
10142
10143
10144
10145
10146
10147
10148
10149
10150
10151
10152
10153
10154
10155
10156
10157
10158
10159
10160
10161
10162
10163
10164
10165
10166
10167
10168
10169
10170
10171
10172
10173
10174
10175
10176
10177
10178
10179
10180
10181
10182
10183
10184
10185
10186
10187
10188
10189
10190
10191
10192
10193
10194
10195
10196
10197
10198
10199
10200
10201
10202
10203
10204
10205
10206
10207
10208
10209
10210
10211
10212
10213
10214
10215
10216
10217
10218
10219
10220
10221
10222
10223
10224
10225
10226
10227
10228
10229
10230
10231
10232
10233
10234
10235
10236
10237
10238
10239
10240
10241
10242
10243
10244
10245
10246
10247
10248
10249
10250
10251
10252
10253
10254
10255
10256
10257
10258
10259
10260
10261
10262
10263
10264
10265
10266
10267
10268
10269
10270
10271
10272
10273
10274
10275
10276
10277
10278
10279
10280
10281
10282
10283
10284
10285
10286
10287
10288
10289
10290
10291
10292
10293
10294
10295
10296
10297
10298
10299
10300
10301
10302
10303
10304
10305
10306
10307
10308
10309
10310
10311
10312
10313
10314
10315
10316
10317
10318
10319
10320
10321
10322
10323
10324
10325
10326
10327
10328
10329
10330
10331
10332
10333
10334
10335
10336
10337
10338
10339
10340
10341
10342
10343
10344
10345
10346
10347
10348
10349
10350
10351
10352
10353
10354
10355
10356
10357
10358
10359
10360
10361
10362
10363
10364
10365
10366
10367
10368
10369
10370
10371
10372
10373
10374
10375
10376
10377
10378
10379
10380
10381
10382
10383
10384
10385
10386
10387
10388
10389
10390
10391
10392
10393
10394
10395
10396
10397
10398
10399
10400
10401
10402
10403
10404
10405
10406
10407
10408
10409
10410
10411
10412
10413
10414
10415
10416
10417
10418
10419
10420
10421
10422
10423
10424
10425
10426
10427
10428
10429
10430
10431
10432
10433
10434
10435
10436
10437
10438
10439
10440
10441
10442
10443
10444
10445
10446
10447
10448
10449
10450
10451
10452
10453
10454
10455
10456
10457
10458
10459
10460
10461
10462
10463
10464
10465
10466
10467
10468
10469
10470
10471
10472
10473
10474
10475
10476
10477
10478
10479
10480
10481
10482
10483
10484
10485
10486
10487
10488
10489
10490
10491
10492
10493
10494
10495
10496
10497
10498
10499
10500
10501
10502
10503
10504
10505
10506
10507
10508
10509
10510
10511
10512
10513
10514
10515
10516
10517
10518
10519
10520
10521
10522
10523
10524
10525
10526
10527
10528
10529
10530
10531
10532
10533
10534
10535
10536
10537
10538
10539
10540
10541
10542
10543
10544
10545
10546
10547
10548
10549
10550
10551
10552
10553
10554
10555
10556
10557
10558
10559
10560
10561
10562
10563
10564
10565
10566
10567
10568
10569
10570
10571
10572
10573
10574
10575
10576
10577
10578
10579
10580
10581
10582
10583
10584
10585
10586
10587
10588
10589
10590
10591
10592
10593
10594
10595
10596
10597
10598
10599
10600
10601
10602
10603
10604
10605
10606
10607
10608
10609
10610
10611
10612
10613
10614
10615
10616
10617
10618
10619
10620
10621
10622
10623
10624
10625
10626
10627
10628
10629
10630
10631
10632
10633
10634
10635
10636
10637
10638
10639
10640
10641
10642
10643
10644
10645
10646
10647
10648
10649
10650
10651
10652
10653
10654
10655
10656
10657
10658
10659
10660
10661
10662
10663
10664
10665
10666
10667
10668
10669
10670
10671
10672
10673
10674
10675
10676
10677
10678
10679
10680
10681
10682
10683
10684
10685
10686
10687
10688
10689
10690
10691
10692
10693
10694
10695
10696
10697
10698
10699
10700
10701
10702
10703
10704
10705
10706
10707
10708
10709
10710
10711
10712
10713
10714
10715
10716
10717
10718
10719
10720
10721
10722
10723
10724
10725
10726
10727
10728
10729
10730
10731
10732
10733
10734
10735
10736
10737
10738
10739
10740
10741
10742
10743
10744
10745
10746
10747
10748
10749
10750
10751
10752
10753
10754
10755
10756
10757
10758
10759
10760
10761
10762
10763
10764
10765
10766
10767
10768
10769
10770
10771
10772
10773
10774
10775
10776
10777
10778
10779
10780
10781
10782
10783
10784
10785
10786
10787
10788
10789
10790
10791
10792
10793
10794
10795
10796
10797
10798
10799
10800
10801
10802
10803
10804
10805
10806
10807
10808
10809
10810
10811
10812
10813
10814
10815
10816
10817
10818
10819
10820
10821
10822
10823
10824
10825
10826
10827
10828
10829
10830
10831
10832
10833
10834
10835
10836
10837
10838
10839
10840
10841
10842
10843
10844
10845
10846
10847
10848
10849
10850
10851
10852
10853
10854
10855
10856
10857
10858
10859
10860
10861
10862
10863
10864
10865
10866
10867
10868
10869
10870
10871
10872
10873
10874
10875
10876
10877
10878
10879
10880
10881
10882
10883
10884
10885
10886
10887
10888
10889
10890
10891
10892
10893
10894
10895
10896
10897
10898
10899
10900
10901
10902
10903
10904
10905
10906
10907
10908
10909
10910
10911
10912
10913
10914
10915
10916
10917
10918
10919
10920
10921
10922
10923
10924
10925
10926
10927
10928
10929
10930
10931
10932
10933
10934
10935
10936
10937
10938
10939
10940
10941
10942
10943
10944
10945
10946
10947
10948
10949
10950
10951
10952
10953
10954
10955
10956
10957
10958
10959
10960
10961
10962
10963
10964
10965
10966
10967
10968
10969
10970
10971
10972
10973
10974
10975
10976
10977
10978
10979
10980
10981
10982
10983
10984
10985
10986
10987
10988
10989
10990
10991
10992
10993
10994
10995
10996
10997
10998
10999
11000
11001
11002
11003
11004
11005
11006
11007
11008
11009
11010
11011
11012
11013
11014
11015
11016
11017
11018
11019
11020
11021
11022
11023
11024
11025
11026
11027
11028
11029
11030
11031
11032
11033
11034
11035
11036
11037
11038
11039
11040
11041
11042
11043
11044
11045
11046
11047
11048
11049
11050
11051
11052
11053
11054
11055
11056
11057
11058
11059
11060
11061
11062
11063
11064
11065
11066
11067
11068
11069
11070
11071
11072
11073
11074
11075
11076
11077
11078
11079
11080
11081
11082
11083
11084
11085
11086
11087
11088
11089
11090
11091
11092
11093
11094
11095
11096
11097
11098
11099
11100
11101
11102
11103
11104
11105
11106
11107
11108
11109
11110
11111
11112
11113
11114
11115
11116
11117
11118
11119
11120
11121
11122
11123
11124
11125
11126
11127
11128
11129
11130
11131
11132
11133
11134
11135
11136
11137
11138
11139
11140
11141
11142
11143
11144
11145
11146
11147
11148
11149
11150
11151
11152
11153
11154
11155
11156
11157
11158
11159
11160
11161
11162
11163
11164
11165
11166
11167
11168
11169
11170
11171
11172
11173
11174
11175
11176
11177
11178
11179
11180
11181
11182
11183
11184
11185
11186
11187
11188
11189
11190
11191
11192
11193
11194
11195
11196
11197
11198
11199
11200
11201
11202
11203
11204
11205
11206
11207
11208
11209
11210
11211
11212
11213
11214
11215
11216
11217
11218
11219
11220
11221
11222
11223
11224
11225
11226
11227
11228
11229
11230
11231
11232
11233
11234
11235
11236
11237
11238
11239
11240
11241
11242
11243
11244
11245
11246
11247
11248
11249
11250
11251
11252
11253
11254
11255
11256
11257
11258
11259
11260
11261
11262
11263
11264
11265
11266
11267
11268
11269
11270
11271
11272
11273
11274
11275
11276
11277
11278
11279
11280
11281
11282
11283
11284
11285
11286
11287
11288
11289
11290
11291
11292
11293
11294
11295
11296
11297
11298
11299
11300
11301
11302
11303
11304
11305
11306
11307
11308
11309
11310
11311
11312
11313
11314
11315
11316
11317
11318
11319
11320
11321
11322
11323
11324
11325
11326
11327
11328
11329
11330
11331
11332
11333
11334
11335
11336
11337
11338
11339
11340
11341
11342
11343
11344
11345
11346
11347
11348
11349
11350
11351
11352
11353
11354
11355
11356
11357
11358
11359
11360
11361
11362
11363
11364
11365
11366
11367
11368
11369
11370
11371
11372
11373
11374
11375
11376
11377
11378
11379
11380
11381
11382
11383
11384
11385
11386
11387
11388
11389
11390
11391
11392
11393
11394
11395
11396
11397
11398
11399
11400
11401
11402
11403
11404
11405
11406
11407
11408
11409
11410
11411
11412
11413
11414
11415
11416
11417
11418
11419
11420
11421
11422
11423
11424
11425
11426
11427
11428
11429
11430
11431
11432
11433
11434
11435
11436
11437
11438
11439
11440
11441
11442
11443
11444
11445
11446
11447
11448
11449
11450
11451
11452
11453
11454
11455
11456
11457
11458
11459
11460
11461
11462
11463
11464
11465
11466
11467
11468
11469
11470
11471
11472
11473
11474
11475
11476
11477
11478
11479
11480
11481
11482
11483
11484
11485
11486
11487
11488
11489
11490
11491
11492
11493
11494
11495
11496
11497
11498
11499
11500
11501
11502
11503
11504
11505
11506
11507
11508
11509
11510
11511
11512
11513
11514
11515
11516
11517
11518
11519
11520
11521
11522
11523
11524
11525
11526
11527
11528
11529
11530
11531
11532
11533
11534
11535
11536
11537
11538
11539
11540
11541
11542
11543
11544
11545
11546
11547
11548
11549
11550
11551
11552
11553
11554
11555
11556
11557
11558
11559
11560
11561
11562
11563
11564
11565
11566
11567
11568
11569
11570
11571
11572
11573
11574
11575
11576
11577
11578
11579
11580
11581
11582
11583
11584
11585
11586
11587
11588
11589
11590
11591
11592
11593
11594
11595
11596
11597
11598
11599
11600
11601
11602
11603
11604
11605
11606
11607
11608
11609
11610
11611
11612
11613
11614
11615
11616
11617
11618
11619
11620
11621
11622
11623
11624
11625
11626
11627
11628
11629
11630
11631
11632
11633
11634
11635
11636
11637
11638
11639
11640
11641
11642
11643
11644
11645
11646
11647
11648
11649
11650
11651
11652
11653
11654
11655
11656
11657
11658
11659
11660
11661
11662
11663
11664
11665
11666
11667
11668
11669
11670
11671
11672
11673
11674
11675
11676
11677
11678
11679
11680
11681
11682
11683
11684
11685
11686
11687
11688
11689
11690
11691
11692
11693
11694
11695
11696
11697
11698
11699
11700
11701
11702
11703
11704
11705
11706
11707
11708
11709
11710
11711
11712
11713
11714
11715
11716
11717
11718
11719
11720
11721
11722
11723
11724
11725
11726
11727
11728
11729
11730
11731
11732
11733
11734
11735
11736
11737
11738
11739
11740
11741
11742
11743
11744
11745
11746
11747
11748
11749
11750
11751
11752
11753
11754
11755
11756
11757
11758
11759
11760
11761
11762
11763
11764
11765
11766
11767
11768
11769
11770
11771
11772
11773
11774
11775
11776
11777
11778
11779
11780
11781
11782
11783
11784
11785
11786
11787
11788
11789
11790
11791
11792
11793
11794
11795
11796
11797
11798
11799
11800
11801
11802
11803
11804
11805
11806
11807
11808
11809
11810
11811
11812
11813
11814
11815
11816
11817
11818
11819
11820
11821
11822
11823
11824
11825
11826
11827
11828
11829
11830
11831
11832
11833
11834
11835
11836
11837
11838
11839
11840
11841
11842
11843
11844
11845
11846
11847
11848
11849
11850
11851
11852
11853
11854
11855
11856
11857
11858
11859
11860
11861
11862
11863
11864
11865
11866
11867
11868
11869
11870
11871
11872
11873
11874
11875
11876
11877
11878
11879
11880
11881
11882
11883
11884
11885
11886
11887
11888
11889
11890
11891
11892
11893
11894
11895
11896
11897
11898
11899
11900
11901
11902
11903
11904
11905
11906
11907
11908
11909
11910
11911
11912
11913
11914
11915
11916
11917
11918
11919
11920
11921
11922
11923
11924
11925
11926
11927
11928
11929
11930
11931
11932
11933
11934
11935
11936
11937
11938
11939
11940
11941
11942
11943
11944
11945
11946
11947
11948
11949
11950
11951
11952
11953
11954
11955
11956
11957
11958
11959
11960
11961
11962
11963
11964
11965
11966
11967
11968
11969
11970
11971
11972
11973
11974
11975
11976
11977
11978
11979
11980
11981
11982
11983
11984
11985
11986
11987
11988
11989
11990
11991
11992
11993
11994
11995
11996
11997
11998
11999
12000
12001
12002
12003
12004
12005
12006
12007
12008
12009
12010
12011
12012
12013
12014
12015
12016
12017
12018
12019
12020
12021
12022
12023
12024
12025
12026
12027
12028
12029
12030
12031
12032
12033
12034
12035
12036
12037
12038
12039
12040
12041
12042
12043
12044
12045
12046
12047
12048
12049
12050
12051
12052
12053
12054
12055
12056
12057
12058
12059
12060
12061
12062
12063
12064
12065
12066
12067
12068
12069
12070
12071
12072
12073
12074
12075
12076
12077
12078
12079
12080
12081
12082
12083
12084
12085
12086
12087
12088
12089
12090
12091
12092
12093
12094
12095
12096
12097
12098
12099
12100
12101
12102
12103
12104
12105
12106
12107
12108
12109
12110
12111
12112
12113
12114
12115
12116
12117
12118
12119
12120
12121
12122
12123
12124
12125
12126
12127
12128
12129
12130
12131
12132
12133
12134
12135
12136
12137
12138
12139
12140
12141
12142
12143
12144
12145
12146
12147
12148
12149
12150
12151
12152
12153
12154
12155
12156
12157
12158
12159
12160
12161
12162
12163
12164
12165
12166
12167
12168
12169
12170
12171
12172
12173
12174
12175
12176
12177
12178
12179
12180
12181
12182
12183
12184
12185
12186
12187
12188
12189
12190
12191
12192
12193
12194
12195
12196
12197
12198
12199
12200
12201
12202
12203
12204
12205
12206
12207
12208
12209
12210
12211
12212
12213
12214
12215
12216
12217
12218
12219
12220
12221
12222
12223
12224
12225
12226
12227
12228
12229
12230
12231
12232
12233
12234
12235
12236
12237
12238
12239
12240
12241
12242
12243
12244
12245
12246
12247
12248
12249
12250
12251
12252
12253
12254
12255
12256
12257
12258
12259
12260
12261
12262
12263
12264
12265
12266
12267
12268
12269
12270
12271
12272
12273
12274
12275
12276
12277
12278
12279
12280
12281
12282
12283
12284
12285
12286
12287
12288
12289
12290
12291
12292
12293
12294
12295
12296
12297
12298
12299
12300
12301
12302
12303
12304
12305
12306
12307
12308
12309
12310
12311
12312
12313
12314
12315
12316
12317
12318
12319
12320
12321
12322
12323
12324
12325
12326
12327
12328
12329
12330
12331
12332
12333
12334
12335
12336
12337
12338
12339
12340
12341
12342
12343
12344
12345
12346
12347
12348
12349
12350
12351
12352
12353
12354
12355
12356
12357
12358
12359
12360
12361
12362
12363
12364
12365
12366
12367
12368
12369
12370
12371
12372
12373
12374
12375
12376
12377
12378
12379
12380
12381
12382
12383
12384
12385
12386
12387
12388
12389
12390
12391
12392
12393
12394
12395
12396
12397
12398
12399
12400
12401
12402
12403
12404
12405
12406
12407
12408
12409
12410
12411
12412
12413
12414
12415
12416
12417
12418
12419
12420
12421
12422
12423
12424
12425
12426
12427
12428
12429
12430
12431
12432
12433
12434
12435
12436
12437
12438
12439
12440
12441
12442
12443
12444
12445
12446
12447
12448
12449
12450
12451
12452
12453
12454
12455
12456
12457
12458
12459
12460
12461
12462
12463
12464
12465
12466
12467
12468
12469
12470
12471
12472
12473
12474
12475
12476
12477
12478
12479
12480
12481
12482
12483
12484
12485
12486
12487
12488
12489
12490
12491
12492
12493
12494
12495
12496
12497
12498
12499
12500
12501
12502
12503
12504
12505
12506
12507
12508
12509
12510
12511
12512
12513
12514
12515
12516
12517
12518
12519
12520
12521
12522
12523
12524
12525
12526
12527
12528
12529
12530
12531
12532
12533
12534
12535
12536
12537
12538
12539
12540
12541
12542
12543
12544
12545
12546
12547
12548
12549
12550
12551
12552
12553
12554
12555
12556
12557
12558
12559
12560
12561
12562
12563
12564
12565
12566
12567
12568
12569
12570
12571
12572
12573
12574
12575
12576
12577
12578
12579
12580
12581
12582
12583
12584
12585
12586
12587
12588
12589
12590
12591
12592
12593
12594
12595
12596
12597
12598
12599
12600
12601
12602
12603
12604
12605
12606
12607
12608
12609
12610
12611
12612
12613
12614
12615
12616
12617
12618
12619
12620
12621
12622
12623
12624
12625
12626
12627
12628
12629
12630
12631
12632
12633
12634
12635
12636
12637
12638
12639
12640
12641
12642
12643
12644
12645
12646
12647
12648
12649
12650
12651
12652
12653
12654
12655
12656
12657
12658
12659
12660
12661
12662
12663
12664
12665
12666
12667
12668
12669
12670
12671
12672
12673
12674
12675
12676
12677
12678
12679
12680
12681
12682
12683
12684
12685
12686
12687
12688
12689
12690
12691
12692
12693
12694
12695
12696
12697
12698
12699
12700
12701
12702
12703
12704
12705
12706
12707
12708
12709
12710
12711
12712
12713
12714
12715
12716
12717
12718
12719
12720
12721
12722
12723
12724
12725
12726
12727
12728
12729
12730
12731
12732
12733
12734
12735
12736
12737
12738
12739
12740
12741
12742
12743
12744
12745
12746
12747
12748
12749
12750
12751
12752
12753
12754
12755
12756
12757
12758
12759
12760
12761
12762
12763
12764
12765
12766
12767
12768
12769
12770
12771
12772
12773
12774
12775
12776
12777
12778
12779
12780
12781
12782
12783
12784
12785
12786
12787
12788
12789
12790
12791
12792
12793
12794
12795
12796
12797
12798
12799
12800
12801
12802
12803
12804
12805
12806
12807
12808
12809
12810
12811
12812
12813
12814
12815
12816
12817
12818
12819
12820
12821
12822
12823
12824
12825
12826
12827
12828
12829
12830
12831
12832
12833
12834
12835
12836
12837
12838
12839
12840
12841
12842
12843
12844
12845
12846
12847
12848
12849
12850
12851
12852
12853
12854
12855
12856
12857
12858
12859
12860
12861
12862
12863
12864
12865
12866
12867
12868
12869
12870
12871
12872
12873
12874
12875
12876
12877
12878
12879
12880
12881
12882
12883
12884
12885
12886
12887
12888
12889
12890
12891
12892
12893
12894
12895
12896
12897
12898
12899
12900
12901
12902
12903
12904
12905
12906
12907
12908
12909
12910
12911
12912
12913
12914
12915
12916
12917
12918
12919
12920
12921
12922
12923
12924
12925
12926
12927
12928
12929
12930
12931
12932
12933
12934
12935
12936
12937
12938
12939
12940
12941
12942
12943
12944
12945
12946
12947
12948
12949
12950
12951
12952
12953
12954
12955
12956
12957
12958
12959
12960
12961
12962
12963
12964
12965
12966
12967
12968
12969
12970
12971
12972
12973
12974
12975
12976
12977
12978
12979
12980
12981
12982
12983
12984
12985
12986
12987
12988
12989
12990
12991
12992
12993
12994
12995
12996
12997
12998
12999
13000
13001
13002
13003
13004
13005
13006
13007
13008
13009
13010
13011
13012
13013
13014
13015
13016
13017
13018
13019
13020
13021
13022
13023
13024
13025
13026
13027
13028
13029
13030
13031
13032
13033
13034
13035
13036
13037
13038
13039
13040
13041
13042
13043
13044
13045
13046
13047
13048
13049
13050
13051
13052
13053
13054
13055
13056
13057
13058
13059
13060
13061
13062
13063
13064
13065
13066
13067
13068
13069
13070
13071
13072
13073
13074
13075
13076
13077
13078
13079
13080
13081
13082
13083
13084
13085
13086
13087
13088
13089
13090
13091
13092
13093
13094
13095
13096
13097
13098
13099
13100
13101
13102
13103
13104
13105
13106
13107
13108
13109
13110
13111
13112
13113
13114
13115
13116
13117
13118
13119
13120
13121
13122
13123
13124
13125
13126
13127
13128
13129
13130
13131
13132
13133
13134
13135
13136
13137
13138
13139
13140
13141
13142
13143
13144
13145
13146
13147
13148
13149
13150
13151
13152
13153
13154
13155
13156
13157
13158
13159
13160
13161
13162
13163
13164
13165
13166
13167
13168
13169
13170
13171
13172
13173
13174
13175
13176
13177
13178
13179
13180
13181
13182
13183
13184
13185
13186
13187
13188
13189
13190
13191
13192
13193
13194
13195
13196
13197
13198
13199
13200
13201
13202
13203
13204
13205
13206
13207
13208
13209
13210
13211
13212
13213
13214
13215
13216
13217
13218
13219
13220
13221
13222
13223
13224
13225
13226
13227
13228
13229
13230
13231
13232
13233
13234
13235
13236
13237
13238
13239
13240
13241
13242
13243
13244
13245
13246
13247
13248
13249
13250
13251
13252
13253
13254
13255
13256
13257
13258
13259
13260
13261
13262
13263
13264
13265
13266
13267
13268
13269
13270
13271
13272
13273
13274
13275
13276
13277
13278
13279
13280
13281
13282
13283
13284
13285
13286
13287
13288
13289
13290
13291
13292
13293
13294
13295
13296
13297
13298
13299
13300
13301
13302
13303
13304
13305
13306
13307
13308
13309
13310
13311
13312
13313
13314
13315
13316
13317
13318
13319
13320
13321
13322
13323
13324
13325
13326
13327
13328
13329
13330
13331
13332
13333
13334
13335
13336
13337
13338
13339
13340
13341
13342
13343
13344
13345
13346
13347
13348
13349
13350
13351
13352
13353
13354
13355
13356
13357
13358
13359
13360
13361
13362
13363
13364
13365
13366
13367
13368
13369
13370
13371
13372
13373
13374
13375
13376
13377
13378
13379
13380
13381
13382
13383
13384
13385
13386
13387
13388
13389
13390
13391
13392
13393
13394
13395
13396
13397
13398
13399
13400
13401
13402
13403
13404
13405
13406
13407
13408
13409
13410
13411
13412
13413
13414
13415
13416
13417
13418
13419
13420
13421
13422
13423
13424
13425
13426
13427
13428
13429
13430
13431
13432
13433
13434
13435
13436
13437
13438
13439
13440
13441
13442
13443
13444
13445
13446
13447
13448
13449
13450
13451
13452
13453
13454
13455
13456
13457
13458
13459
13460
13461
13462
13463
13464
13465
13466
13467
13468
13469
13470
13471
13472
13473
13474
13475
13476
13477
13478
13479
13480
13481
13482
13483
13484
13485
13486
13487
13488
13489
13490
13491
13492
13493
13494
13495
13496
13497
13498
13499
13500
13501
13502
13503
13504
13505
13506
13507
13508
13509
13510
13511
13512
13513
13514
13515
13516
13517
13518
13519
13520
13521
13522
13523
13524
13525
13526
13527
13528
13529
13530
13531
13532
13533
13534
13535
13536
13537
13538
13539
13540
13541
13542
13543
13544
13545
13546
13547
13548
13549
13550
13551
13552
13553
13554
13555
13556
13557
13558
13559
13560
13561
13562
13563
13564
13565
13566
13567
13568
13569
13570
13571
13572
13573
13574
13575
13576
13577
13578
13579
13580
13581
13582
13583
13584
13585
13586
13587
13588
13589
13590
13591
13592
13593
13594
13595
13596
13597
13598
13599
13600
13601
13602
13603
13604
13605
13606
13607
13608
13609
13610
13611
13612
13613
13614
13615
13616
13617
13618
13619
13620
13621
13622
13623
13624
13625
13626
13627
13628
13629
13630
13631
13632
13633
13634
13635
13636
13637
13638
13639
13640
13641
13642
13643
13644
13645
13646
13647
13648
13649
13650
13651
13652
13653
13654
13655
13656
13657
13658
13659
13660
13661
13662
13663
13664
13665
13666
13667
13668
13669
13670
13671
13672
13673
13674
13675
13676
13677
13678
13679
13680
13681
13682
13683
13684
13685
13686
13687
13688
13689
13690
13691
13692
13693
13694
13695
13696
13697
13698
13699
13700
13701
13702
13703
13704
13705
13706
13707
13708
13709
13710
13711
13712
13713
13714
13715
13716
13717
13718
13719
13720
13721
13722
13723
13724
13725
13726
13727
13728
13729
13730
13731
13732
13733
13734
13735
13736
13737
13738
13739
13740
13741
13742
13743
13744
13745
13746
13747
13748
13749
13750
13751
13752
13753
13754
13755
13756
13757
13758
13759
13760
13761
13762
13763
13764
13765
13766
13767
13768
13769
13770
13771
13772
13773
13774
13775
13776
13777
13778
13779
13780
13781
13782
13783
13784
13785
13786
13787
13788
13789
13790
13791
13792
13793
13794
13795
13796
13797
13798
13799
13800
13801
13802
13803
13804
13805
13806
13807
13808
13809
13810
13811
13812
13813
13814
13815
13816
13817
13818
13819
13820
13821
13822
13823
13824
13825
13826
13827
13828
13829
13830
13831
13832
13833
13834
13835
13836
13837
13838
13839
13840
13841
13842
13843
13844
13845
13846
13847
13848
13849
13850
13851
13852
13853
13854
13855
13856
13857
13858
13859
13860
13861
13862
13863
13864
13865
13866
13867
13868
13869
13870
13871
13872
13873
13874
13875
13876
13877
13878
13879
13880
13881
13882
13883
13884
13885
13886
13887
13888
13889
13890
13891
13892
13893
13894
13895
13896
13897
13898
13899
13900
13901
13902
13903
13904
13905
13906
13907
13908
13909
13910
13911
13912
13913
13914
13915
13916
13917
13918
13919
13920
13921
13922
13923
13924
13925
13926
13927
13928
13929
13930
13931
13932
13933
13934
13935
13936
13937
13938
13939
13940
13941
13942
13943
13944
13945
13946
13947
13948
13949
13950
13951
13952
13953
13954
13955
13956
13957
13958
13959
13960
13961
13962
13963
13964
13965
13966
13967
13968
13969
13970
13971
13972
13973
13974
13975
13976
13977
13978
13979
13980
13981
13982
13983
13984
13985
13986
13987
13988
13989
13990
13991
13992
13993
13994
13995
13996
13997
13998
13999
14000
14001
14002
14003
14004
14005
14006
14007
14008
14009
14010
14011
14012
14013
14014
14015
14016
14017
14018
14019
14020
14021
14022
14023
14024
14025
14026
14027
14028
14029
14030
14031
14032
14033
14034
14035
14036
14037
14038
14039
14040
14041
14042
14043
14044
14045
14046
14047
14048
14049
14050
14051
14052
14053
14054
14055
14056
14057
14058
14059
14060
14061
14062
14063
14064
14065
14066
14067
14068
14069
14070
14071
14072
14073
14074
14075
14076
14077
14078
14079
14080
14081
14082
14083
14084
14085
14086
14087
14088
14089
14090
14091
14092
14093
14094
14095
14096
14097
14098
14099
14100
14101
14102
14103
14104
14105
14106
14107
14108
14109
14110
14111
14112
14113
14114
14115
14116
14117
14118
14119
14120
14121
14122
14123
14124
14125
14126
14127
14128
14129
14130
14131
14132
14133
14134
14135
14136
14137
14138
14139
14140
14141
14142
14143
14144
14145
14146
14147
14148
14149
14150
14151
14152
14153
14154
14155
14156
14157
14158
14159
14160
14161
14162
14163
14164
14165
14166
14167
14168
14169
14170
14171
14172
14173
14174
14175
14176
14177
14178
14179
14180
14181
14182
14183
14184
14185
14186
14187
14188
14189
14190
14191
14192
14193
14194
14195
14196
14197
14198
14199
14200
14201
14202
14203
14204
14205
14206
14207
14208
14209
14210
14211
14212
14213
14214
14215
14216
14217
14218
14219
14220
14221
14222
14223
14224
14225
14226
14227
14228
14229
14230
14231
14232
14233
14234
14235
14236
14237
14238
14239
14240
14241
14242
14243
14244
14245
14246
14247
14248
14249
14250
14251
14252
14253
14254
14255
14256
14257
14258
14259
14260
14261
14262
14263
14264
14265
14266
14267
14268
14269
14270
14271
14272
14273
14274
14275
14276
14277
14278
14279
14280
14281
14282
14283
14284
14285
14286
14287
14288
14289
14290
14291
14292
14293
14294
14295
14296
14297
14298
14299
14300
14301
14302
14303
14304
14305
14306
14307
14308
14309
14310
14311
14312
14313
14314
14315
14316
14317
14318
14319
14320
14321
14322
14323
14324
14325
14326
14327
14328
14329
14330
14331
14332
14333
14334
14335
14336
14337
14338
14339
14340
14341
14342
14343
14344
14345
14346
14347
14348
14349
14350
14351
14352
14353
14354
14355
14356
14357
14358
14359
14360
14361
14362
14363
14364
14365
14366
14367
14368
14369
14370
14371
14372
14373
14374
14375
14376
14377
14378
14379
14380
14381
14382
14383
14384
14385
14386
14387
14388
14389
14390
14391
14392
14393
14394
14395
14396
14397
14398
14399
14400
14401
14402
14403
14404
14405
14406
14407
14408
14409
14410
14411
14412
14413
14414
14415
14416
14417
14418
14419
14420
14421
14422
14423
14424
14425
14426
14427
14428
14429
14430
14431
14432
14433
14434
14435
14436
14437
14438
14439
14440
14441
14442
14443
14444
14445
14446
14447
14448
14449
14450
14451
14452
14453
14454
14455
14456
14457
14458
14459
14460
14461
14462
14463
14464
14465
14466
14467
14468
14469
14470
14471
14472
14473
14474
14475
14476
14477
14478
14479
14480
14481
14482
14483
14484
14485
14486
14487
14488
14489
14490
14491
14492
14493
14494
14495
14496
14497
14498
14499
14500
14501
14502
14503
14504
14505
14506
14507
14508
14509
14510
14511
14512
14513
14514
14515
14516
14517
14518
14519
14520
14521
14522
14523
14524
14525
14526
14527
14528
14529
14530
14531
14532
14533
14534
14535
14536
14537
14538
14539
14540
14541
14542
14543
14544
14545
14546
14547
14548
14549
14550
14551
14552
14553
14554
14555
14556
14557
14558
14559
14560
14561
14562
14563
14564
14565
14566
14567
14568
14569
14570
14571
14572
14573
14574
14575
14576
14577
14578
14579
14580
14581
14582
14583
14584
14585
14586
14587
14588
14589
14590
14591
14592
14593
14594
14595
14596
14597
14598
14599
14600
14601
14602
14603
14604
14605
14606
14607
14608
14609
14610
14611
14612
14613
14614
14615
14616
14617
14618
14619
14620
14621
14622
14623
14624
14625
14626
14627
14628
14629
14630
14631
14632
14633
14634
14635
14636
14637
14638
14639
14640
14641
14642
14643
14644
14645
14646
14647
14648
14649
14650
14651
14652
14653
14654
14655
14656
14657
14658
14659
14660
14661
14662
14663
14664
14665
14666
14667
14668
14669
14670
14671
14672
14673
14674
14675
14676
14677
14678
14679
14680
14681
14682
14683
14684
14685
14686
14687
14688
14689
14690
14691
14692
14693
14694
14695
14696
14697
14698
14699
14700
14701
14702
14703
14704
14705
14706
14707
14708
14709
14710
14711
14712
14713
14714
14715
14716
14717
14718
14719
14720
14721
14722
14723
14724
14725
14726
14727
14728
14729
14730
14731
14732
14733
14734
14735
14736
14737
14738
14739
14740
14741
14742
14743
14744
14745
14746
14747
14748
14749
14750
14751
14752
14753
14754
14755
14756
14757
14758
14759
14760
14761
14762
14763
14764
14765
14766
14767
14768
14769
14770
14771
14772
14773
14774
14775
14776
14777
14778
14779
14780
14781
14782
14783
14784
14785
14786
14787
14788
14789
14790
14791
14792
14793
14794
14795
14796
14797
14798
14799
14800
14801
14802
14803
14804
14805
14806
14807
14808
14809
14810
14811
14812
14813
14814
14815
14816
14817
14818
14819
14820
14821
14822
14823
14824
14825
14826
14827
14828
14829
14830
14831
14832
14833
14834
14835
14836
14837
14838
14839
14840
14841
14842
14843
14844
14845
14846
14847
14848
14849
14850
14851
14852
14853
14854
14855
14856
14857
14858
14859
14860
14861
14862
14863
14864
14865
14866
14867
14868
14869
14870
14871
14872
14873
14874
14875
14876
14877
14878
14879
14880
14881
14882
14883
14884
14885
14886
14887
14888
14889
14890
14891
14892
14893
14894
14895
14896
14897
14898
14899
14900
14901
14902
14903
14904
14905
14906
14907
14908
14909
14910
14911
14912
14913
14914
14915
14916
14917
14918
14919
14920
14921
14922
14923
14924
14925
14926
14927
14928
14929
14930
14931
14932
14933
14934
14935
14936
14937
14938
14939
14940
14941
14942
14943
14944
14945
14946
14947
14948
14949
14950
14951
14952
14953
14954
14955
14956
14957
14958
14959
14960
14961
14962
14963
14964
14965
14966
14967
14968
14969
14970
14971
14972
14973
14974
14975
14976
14977
14978
14979
14980
14981
14982
14983
14984
14985
14986
14987
14988
14989
14990
14991
14992
14993
14994
14995
14996
14997
14998
14999
15000
15001
15002
15003
15004
15005
15006
15007
15008
15009
15010
15011
15012
15013
15014
15015
15016
15017
15018
15019
15020
15021
15022
15023
15024
15025
15026
15027
15028
15029
15030
15031
15032
15033
15034
15035
15036
15037
15038
15039
15040
15041
15042
15043
15044
15045
15046
15047
15048
15049
15050
15051
15052
15053
15054
15055
15056
15057
15058
15059
15060
15061
15062
15063
15064
15065
15066
15067
15068
15069
15070
15071
15072
15073
15074
15075
15076
15077
15078
15079
15080
15081
15082
15083
15084
15085
15086
15087
15088
15089
15090
15091
15092
15093
15094
15095
15096
15097
15098
15099
15100
15101
15102
15103
15104
15105
15106
15107
15108
15109
15110
15111
15112
15113
15114
15115
15116
15117
15118
15119
15120
15121
15122
15123
15124
15125
15126
15127
15128
15129
15130
15131
15132
15133
15134
15135
15136
15137
15138
15139
15140
15141
15142
15143
15144
15145
15146
15147
15148
15149
15150
15151
15152
15153
15154
15155
15156
15157
15158
15159
15160
15161
15162
15163
15164
15165
15166
15167
15168
15169
15170
15171
15172
15173
15174
15175
15176
15177
15178
15179
15180
15181
15182
15183
15184
15185
15186
15187
15188
15189
15190
15191
15192
15193
15194
15195
15196
15197
15198
15199
15200
15201
15202
15203
15204
15205
15206
15207
15208
15209
15210
15211
15212
15213
15214
15215
15216
15217
15218
15219
15220
15221
15222
15223
15224
15225
15226
15227
15228
15229
15230
15231
15232
15233
15234
15235
15236
15237
15238
15239
15240
15241
15242
15243
15244
15245
15246
15247
15248
15249
15250
15251
15252
15253
15254
15255
15256
15257
15258
15259
15260
15261
15262
15263
15264
15265
15266
15267
15268
15269
15270
15271
15272
15273
15274
15275
15276
15277
15278
15279
15280
15281
15282
15283
15284
15285
15286
15287
15288
15289
15290
15291
15292
15293
15294
15295
15296
15297
15298
15299
15300
15301
15302
15303
15304
15305
15306
15307
15308
15309
15310
15311
15312
15313
15314
15315
15316
15317
15318
15319
15320
15321
15322
15323
15324
15325
15326
15327
15328
15329
15330
15331
15332
15333
15334
15335
15336
15337
15338
15339
15340
15341
15342
15343
15344
15345
15346
15347
15348
15349
15350
15351
15352
15353
15354
15355
15356
15357
15358
15359
15360
15361
15362
15363
15364
15365
15366
15367
15368
15369
15370
15371
15372
15373
15374
15375
15376
15377
15378
15379
15380
15381
15382
15383
15384
15385
15386
15387
15388
15389
15390
15391
15392
15393
15394
15395
15396
15397
15398
15399
15400
15401
15402
15403
15404
15405
15406
15407
15408
15409
15410
15411
15412
15413
15414
15415
15416
15417
15418
15419
15420
15421
15422
15423
15424
15425
15426
15427
15428
15429
15430
15431
15432
15433
15434
15435
15436
15437
15438
15439
15440
15441
15442
15443
15444
15445
15446
15447
15448
15449
15450
15451
15452
15453
15454
15455
15456
15457
15458
15459
15460
15461
15462
15463
15464
15465
15466
15467
15468
15469
15470
15471
15472
15473
15474
15475
15476
15477
15478
15479
15480
15481
15482
15483
15484
15485
15486
15487
15488
15489
15490
15491
15492
15493
15494
15495
15496
15497
15498
15499
15500
15501
15502
15503
15504
15505
15506
15507
15508
15509
15510
15511
15512
15513
15514
15515
15516
15517
15518
15519
15520
15521
15522
15523
15524
15525
15526
15527
15528
15529
15530
15531
15532
15533
15534
15535
15536
15537
15538
15539
15540
15541
15542
15543
15544
15545
15546
15547
15548
15549
15550
15551
15552
15553
15554
15555
15556
15557
15558
15559
15560
15561
15562
15563
15564
15565
15566
15567
15568
15569
15570
15571
15572
15573
15574
15575
15576
15577
15578
15579
15580
15581
15582
15583
15584
15585
15586
15587
15588
15589
15590
15591
15592
15593
15594
15595
15596
15597
15598
15599
15600
15601
15602
15603
15604
15605
15606
15607
15608
15609
15610
15611
15612
15613
15614
15615
15616
15617
15618
15619
15620
15621
15622
15623
15624
15625
15626
15627
15628
15629
15630
15631
15632
15633
15634
15635
15636
15637
15638
15639
15640
15641
15642
15643
15644
15645
15646
15647
15648
15649
15650
15651
15652
15653
15654
15655
15656
15657
15658
15659
15660
15661
15662
15663
15664
15665
15666
15667
15668
15669
15670
15671
15672
15673
15674
15675
15676
15677
15678
15679
15680
15681
15682
15683
15684
15685
15686
15687
15688
15689
15690
15691
15692
15693
15694
15695
15696
15697
15698
15699
15700
15701
15702
15703
15704
15705
15706
15707
15708
15709
15710
15711
15712
15713
15714
15715
15716
15717
15718
15719
15720
15721
15722
15723
15724
15725
15726
15727
15728
15729
15730
15731
15732
15733
15734
15735
15736
15737
15738
15739
15740
15741
15742
15743
15744
15745
15746
15747
15748
15749
15750
15751
15752
15753
15754
15755
15756
15757
15758
15759
15760
15761
15762
15763
15764
15765
15766
15767
15768
15769
15770
15771
15772
15773
15774
15775
15776
15777
15778
15779
15780
15781
15782
15783
15784
15785
15786
15787
15788
15789
15790
15791
15792
15793
15794
15795
15796
15797
15798
15799
15800
15801
15802
15803
15804
15805
15806
15807
15808
15809
15810
15811
15812
15813
15814
15815
15816
15817
15818
15819
15820
15821
15822
15823
15824
15825
15826
15827
15828
15829
15830
15831
15832
15833
15834
15835
15836
15837
15838
15839
15840
15841
15842
15843
15844
15845
15846
15847
15848
15849
15850
15851
15852
15853
15854
15855
15856
15857
15858
15859
15860
15861
15862
15863
15864
15865
15866
15867
15868
15869
15870
15871
15872
15873
15874
15875
15876
15877
15878
15879
15880
15881
15882
15883
15884
15885
15886
15887
15888
15889
15890
15891
15892
15893
15894
15895
.\" Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013 The SCons Foundation
.\"
.\" 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.
.\"
.\" doc/man/scons.1  2013/03/03 09:48:35 garyo
.\"
.TH SCONS 1 "March 2013"
.\" ES - Example Start - indents and turns off line fill
.rm ES
.de ES
.RS
.nf
..
.\" EE - Example End - ends indent and turns line fill back on
.rm EE
.de EE
.fi
.RE
..
.SH NAME
scons \- a software construction tool
.SH SYNOPSIS
.B scons
[
.IR options ...
]
[
.IR name = val ...
]
[
.IR targets ...
]
.SH DESCRIPTION

The
.B scons
utility builds software (or other files) by determining which
component pieces must be rebuilt and executing the necessary commands to
rebuild them.

By default,
.B scons
searches for a file named
.IR SConstruct ,
.IR Sconstruct ,
or
.I sconstruct
(in that order) in the current directory and reads its
configuration from the first file found.
An alternate file name may be
specified via the
.B -f
option.

The
.I SConstruct
file can specify subsidiary
configuration files using the
.BR SConscript ()
function.
By convention,
these subsidiary files are named
.IR SConscript ,
although any name may be used.
(Because of this naming convention,
the term "SConscript files"
is sometimes used to refer
generically to all
.B scons
configuration files,
regardless of actual file name.)

The configuration files
specify the target files to be built, and
(optionally) the rules to build those targets.  Reasonable default
rules exist for building common software components (executable
programs, object files, libraries), so that for most software
projects, only the target and input files need be specified.

Before reading the
.I SConstruct
file,
.B scons
looks for a directory named
.I site_scons
in various system directories (see below) and the directory containing the
.I SConstruct
file; for each of those dirs which exists,
.I site_scons
is prepended to sys.path,
the file
.IR site_scons/site_init.py ,
is evaluated if it exists,
and the directory
.I site_scons/site_tools
is prepended to the default toolpath if it exists.
See the
.I --no-site-dir
and
.I --site-dir
options for more details.

.B scons
reads and executes the SConscript files as Python scripts,
so you may use normal Python scripting capabilities
(such as flow control, data manipulation, and imported Python libraries)
to handle complicated build situations.
.BR scons ,
however, reads and executes all of the SConscript files
.I before
it begins building any targets.
To make this obvious,
.B scons
prints the following messages about what it is doing:

.ES
$ scons foo.out
scons: Reading SConscript files ...
scons: done reading SConscript files.
scons: Building targets  ...
cp foo.in foo.out
scons: done building targets.
$
.EE

The status messages
(everything except the line that reads "cp foo.in foo.out")
may be suppressed using the
.B -Q
option.

.B scons
does not automatically propagate
the external environment used to execute
.B scons
to the commands used to build target files.
This is so that builds will be guaranteed
repeatable regardless of the environment
variables set at the time
.B scons
is invoked.
This also means that if the compiler or other commands
that you want to use to build your target files
are not in standard system locations,
.B scons
will not find them unless
you explicitly set the PATH
to include those locations.
Whenever you create an
.B scons
construction environment,
you can propagate the value of PATH
from your external environment as follows:

.ES
import os
env = Environment(ENV = {'PATH' : os.environ['PATH']})
.EE

Similarly, if the commands use external environment variables
like $PATH, $HOME, $JAVA_HOME, $LANG, $SHELL, $TERM, etc.,
these variables can also be explicitly propagated:

.ES
import os
env = Environment(ENV = {'PATH' : os.environ['PATH'],
                         'HOME' : os.environ['HOME']})
.EE

Or you may explicitly propagate the invoking user's
complete external environment:

.ES
import os
env = Environment(ENV = os.environ)
.EE

This comes at the expense of making your build
dependent on the user's environment being set correctly,
but it may be more convenient for many configurations.

.B scons
can scan known input files automatically for dependency
information (for example, #include statements
in C or C++ files) and will rebuild dependent files appropriately
whenever any "included" input file changes.
.B scons
supports the
ability to define new scanners for unknown input file types.

.B scons
knows how to fetch files automatically from
SCCS or RCS subdirectories
using SCCS, RCS or BitKeeper.

.B scons
is normally executed in a top-level directory containing a
.I SConstruct
file, optionally specifying
as command-line arguments
the target file or files to be built.

By default, the command

.ES
scons
.EE

will build all target files in or below the current directory.
Explicit default targets
(to be built when no targets are specified on the command line)
may be defined the SConscript file(s)
using the
.B Default()
function, described below.

Even when
.B Default()
targets are specified in the SConscript file(s),
all target files in or below the current directory
may be built by explicitly specifying
the current directory (.)
as a command-line target:

.ES
scons .
.EE

Building all target files,
including any files outside of the current directory,
may be specified by supplying a command-line target
of the root directory (on POSIX systems):

.ES
scons /
.EE

or the path name(s) of the volume(s) in which all the targets
should be built (on Windows systems):

.ES
scons C:\\ D:\\
.EE

To build only specific targets,
supply them as command-line arguments:

.ES
scons foo bar
.EE

in which case only the specified targets will be built
(along with any derived files on which they depend).

Specifying "cleanup" targets in SConscript files is not usually necessary.
The
.B -c
flag removes all files
necessary to build the specified target:

.ES
scons -c .
.EE

to remove all target files, or:

.ES
scons -c build export
.EE

to remove target files under build and export.
Additional files or directories to remove can be specified using the
.BR Clean()
function.
Conversely, targets that would normally be removed by the
.B -c
invocation
can be prevented from being removed by using the
.BR NoClean ()
function.

A subset of a hierarchical tree may be built by
remaining at the top-level directory (where the
.I SConstruct
file lives) and specifying the subdirectory as the target to be
built:

.ES
scons src/subdir
.EE

or by changing directory and invoking scons with the
.B -u
option, which traverses up the directory
hierarchy until it finds the
.I SConstruct
file, and then builds
targets relatively to the current subdirectory:

.ES
cd src/subdir
scons -u .
.EE

.B scons
supports building multiple targets in parallel via a
.B -j
option that takes, as its argument, the number
of simultaneous tasks that may be spawned:

.ES
scons -j 4
.EE

builds four targets in parallel, for example.

.B scons
can maintain a cache of target (derived) files that can
be shared between multiple builds.  When caching is enabled in a
SConscript file, any target files built by
.B scons
will be copied
to the cache.  If an up-to-date target file is found in the cache, it
will be retrieved from the cache instead of being rebuilt locally.
Caching behavior may be disabled and controlled in other ways by the
.BR --cache-force ,
.BR --cache-disable ,
and
.B --cache-show
command-line options.  The
.B --random
option is useful to prevent multiple builds
from trying to update the cache simultaneously.

Values of variables to be passed to the SConscript file(s)
may be specified on the command line:

.ES
scons debug=1 .
.EE

These variables are available in SConscript files
through the ARGUMENTS dictionary,
and can be used in the SConscript file(s) to modify
the build in any way:

.ES
if ARGUMENTS.get('debug', 0):
    env = Environment(CCFLAGS = '-g')
else:
    env = Environment()
.EE

The command-line variable arguments are also available
in the ARGLIST list,
indexed by their order on the command line.
This allows you to process them in order rather than by name,
if necessary.
ARGLIST[0] returns a tuple
containing (argname, argvalue).
A Python exception is thrown if you
try to access a list member that
does not exist.

.B scons
requires Python version 2.4 or later.
There should be no other dependencies or requirements to run
.B scons.

.\" The following paragraph reflects the default tool search orders
.\" currently in SCons/Tool/__init__.py.  If any of those search orders
.\" change, this documentation should change, too.
By default,
.B scons
knows how to search for available programming tools
on various systems.
On Windows systems,
.B scons
searches in order for the
Microsoft Visual C++ tools,
the MinGW tool chain,
the Intel compiler tools,
and the PharLap ETS compiler.
On OS/2 systems,
.B scons
searches in order for the
OS/2 compiler,
the GCC tool chain,
and the Microsoft Visual C++ tools,
On SGI IRIX, IBM AIX, Hewlett Packard HP-UX, and Sun Solaris systems,
.B scons
searches for the native compiler tools
(MIPSpro, Visual Age, aCC, and Forte tools respectively)
and the GCC tool chain.
On all other platforms,
including POSIX (Linux and UNIX) platforms,
.B scons
searches in order
for the GCC tool chain,
the Microsoft Visual C++ tools,
and the Intel compiler tools.
You may, of course, override these default values
by appropriate configuration of
Environment construction variables.

.SH OPTIONS
In general,
.B scons
supports the same command-line options as GNU
.BR make ,
and many of those supported by
.BR cons .

.TP
-b
Ignored for compatibility with non-GNU versions of
.BR make.

.TP
-c, --clean, --remove
Clean up by removing all target files for which a construction
command is specified.
Also remove any files or directories associated to the construction command
using the
.BR Clean ()
function.
Will not remove any targets specified by the
.BR NoClean ()
function.

.TP
.RI --cache-debug= file
Print debug information about the
.BR CacheDir ()
derived-file caching
to the specified
.IR file .
If
.I file
is
.B \-
(a hyphen),
the debug information are printed to the standard output.
The printed messages describe what signature file names are
being looked for in, retrieved from, or written to the
.BR CacheDir ()
directory tree.

.TP
--cache-disable, --no-cache
Disable the derived-file caching specified by
.BR CacheDir ().
.B scons
will neither retrieve files from the cache
nor copy files to the cache.

.TP
--cache-force, --cache-populate
When using
.BR CacheDir (),
populate a cache by copying any already-existing, up-to-date
derived files to the cache,
in addition to files built by this invocation.
This is useful to populate a new cache with
all the current derived files,
or to add to the cache any derived files
recently built with caching disabled via the
.B --cache-disable
option.

.TP
--cache-show
When using
.BR CacheDir ()
and retrieving a derived file from the cache,
show the command
that would have been executed to build the file,
instead of the usual report,
"Retrieved `file' from cache."
This will produce consistent output for build logs,
regardless of whether a target
file was rebuilt or retrieved from the cache.

.TP
.RI --config= mode
This specifies how the
.B Configure
call should use or generate the
results of configuration tests.
The option should be specified from
among the following choices:

.TP
--config=auto
scons will use its normal dependency mechanisms
to decide if a test must be rebuilt or not.
This saves time by not running the same configuration tests
every time you invoke scons,
but will overlook changes in system header files
or external commands (such as compilers)
if you don't specify those dependecies explicitly.
This is the default behavior.

.TP
--config=force
If this option is specified,
all configuration tests will be re-run
regardless of whether the
cached results are out of date.
This can be used to explicitly
force the configuration tests to be updated
in response to an otherwise unconfigured change
in a system header file or compiler.

.TP
--config=cache
If this option is specified,
no configuration tests will be rerun
and all results will be taken from cache.
Note that scons will still consider it an error
if --config=cache is specified
and a necessary test does not
yet have any results in the cache.

.TP
.RI "-C" " directory" ",  --directory=" directory
Change to the specified
.I directory
before searching for the
.IR SConstruct ,
.IR Sconstruct ,
or
.I sconstruct
file, or doing anything
else.  Multiple
.B -C
options are interpreted
relative to the previous one, and the right-most
.B -C
option wins. (This option is nearly
equivalent to
.BR "-f directory/SConstruct" ,
except that it will search for
.IR SConstruct ,
.IR Sconstruct ,
or
.I sconstruct
in the specified directory.)

.\" .TP
.\" -d
.\" Display dependencies while building target files.  Useful for
.\" figuring out why a specific file is being rebuilt, as well as
.\" general debugging of the build process.

.TP
-D
Works exactly the same way as the
.B -u
option except for the way default targets are handled.
When this option is used and no targets are specified on the command line,
all default targets are built, whether or not they are below the current
directory.

.TP
.RI --debug= type
Debug the build process.
.I type
specifies what type of debugging:

.TP
--debug=count
Print how many objects are created
of the various classes used internally by SCons
before and after reading the SConscript files
and before and after building targets.
This is not supported when SCons is executed with the Python
.B -O
(optimized) option
or when the SCons modules
have been compiled with optimization
(that is, when executing from
.B *.pyo
files).

.TP
--debug=duplicate
Print a line for each unlink/relink (or copy) of a variant file from
its source file.  Includes debugging info for unlinking stale variant
files, as well as unlinking old targets before building them.

.TP
--debug=dtree
A synonym for the newer
.B --tree=derived
option.
This will be deprecated in some future release
and ultimately removed.

.TP
--debug=explain
Print an explanation of precisely why
.B scons
is deciding to (re-)build any targets.
(Note:  this does not print anything
for targets that are
.I not
rebuilt.)

.TP
--debug=findlibs
Instruct the scanner that searches for libraries
to print a message about each potential library
name it is searching for,
and about the actual libraries it finds.

.TP
--debug=includes
Print the include tree after each top-level target is built.
This is generally used to find out what files are included by the sources
of a given derived file:

.ES
$ scons --debug=includes foo.o
.EE

.TP
--debug=memoizer
Prints a summary of hits and misses using the Memoizer,
an internal subsystem that counts
how often SCons uses cached values in memory
instead of recomputing them each time they're needed.

.TP
--debug=memory
Prints how much memory SCons uses
before and after reading the SConscript files
and before and after building targets.

.TP
--debug=nomemoizer
A deprecated option preserved for backwards compatibility.

.TP
--debug=objects
Prints a list of the various objects
of the various classes used internally by SCons.

.TP
--debug=pdb
Re-run SCons under the control of the
.RI pdb
Python debugger.

.TP
--debug=prepare
Print a line each time any target (internal or external)
is prepared for building.
.B scons
prints this for each target it considers, even if that
target is up to date (see also --debug=explain).
This can help debug problems with targets that aren't being
built; it shows whether
.B scons
is at least considering them or not.

.TP
--debug=presub
Print the raw command line used to build each target
before the construction environment variables are substituted.
Also shows which targets are being built by this command.
Output looks something like this:
.ES
$ scons --debug=presub
Building myprog.o with action(s):
  $SHCC $SHCFLAGS $SHCCFLAGS $CPPFLAGS $_CPPINCFLAGS -c -o $TARGET $SOURCES
\&...
.EE

.TP
--debug=stacktrace
Prints an internal Python stack trace
when encountering an otherwise unexplained error.

.TP
--debug=stree
A synonym for the newer
.B --tree=all,status
option.
This will be deprecated in some future release
and ultimately removed.

.TP
--debug=time
Prints various time profiling information:
the time spent executing each individual build command;
the total build time (time SCons ran from beginning to end);
the total time spent reading and executing SConscript files;
the total time spent SCons itself spend running
(that is, not counting reading and executing SConscript files);
and both the total time spent executing all build commands
and the elapsed wall-clock time spent executing those build commands.
(When
.B scons
is executed without the
.B -j
option,
the elapsed wall-clock time will typically
be slightly longer than the total time spent
executing all the build commands,
due to the SCons processing that takes place
in between executing each command.
When
.B scons
is executed
.I with
the
.B -j
option,
and your build configuration allows good parallelization,
the elapsed wall-clock time should
be significantly smaller than the
total time spent executing all the build commands,
since multiple build commands and
intervening SCons processing
should take place in parallel.)

.TP
--debug=tree
A synonym for the newer
.B --tree=all
option.
This will be deprecated in some future release
and ultimately removed.

.TP
.RI --diskcheck= types
Enable specific checks for
whether or not there is a file on disk
where the SCons configuration expects a directory
(or vice versa),
and whether or not RCS or SCCS sources exist
when searching for source and include files.
The
.I types
argument can be set to:
.BR all ,
to enable all checks explicitly
(the default behavior);
.BR none ,
to disable all such checks;
.BR match ,
to check that files and directories on disk
match SCons' expected configuration;
.BR rcs ,
to check for the existence of an RCS source
for any missing source or include files;
.BR sccs ,
to check for the existence of an SCCS source
for any missing source or include files.
Multiple checks can be specified separated by commas;
for example,
.B --diskcheck=sccs,rcs
would still check for SCCS and RCS sources,
but disable the check for on-disk matches of files and directories.
Disabling some or all of these checks
can provide a performance boost for large configurations,
or when the configuration will check for files and/or directories
across networked or shared file systems,
at the slight increased risk of an incorrect build
or of not handling errors gracefully
(if include files really should be
found in SCCS or RCS, for example,
or if a file really does exist
where the SCons configuration expects a directory).

.TP
.RI --duplicate= ORDER
There are three ways to duplicate files in a build tree: hard links,
soft (symbolic) links and copies. The default behaviour of SCons is to
prefer hard links to soft links to copies. You can specify different
behaviours with this option.
.IR ORDER
must be one of
.IR hard-soft-copy
(the default),
.IR soft-hard-copy ,
.IR hard-copy ,
.IR soft-copy
or
.IR copy .
SCons will attempt to duplicate files using
the mechanisms in the specified order.

.\" .TP
.\" -e, --environment-overrides
.\" Variables from the execution environment override construction
.\" variables from the SConscript files.

.TP
.RI -f " file" ", --file=" file ", --makefile=" file ", --sconstruct=" file
Use
.I file
as the initial SConscript file.
Multiple
.B -f
options may be specified,
in which case
.B scons
will read all of the specified files.

.TP
-h, --help
Print a local help message for this build, if one is defined in
the SConscript file(s), plus a line that describes the
.B -H
option for command-line option help.  If no local help message
is defined, prints the standard help message about command-line
options.  Exits after displaying the appropriate message.

.TP
-H, --help-options
Print the standard help message about command-line options and
exit.

.TP
-i, --ignore-errors
Ignore all errors from commands executed to rebuild files.

.TP
.RI -I " directory" ", --include-dir=" directory
Specifies a
.I directory
to search for
imported Python modules.  If several
.B -I
options
are used, the directories are searched in the order specified.

.TP
--implicit-cache
Cache implicit dependencies.
This causes
.B scons
to use the implicit (scanned) dependencies
from the last time it was run
instead of scanning the files for implicit dependencies.
This can significantly speed up SCons,
but with the following limitations:
.IP
.B scons
will not detect changes to implicit dependency search paths
(e.g.
.BR CPPPATH ", " LIBPATH )
that would ordinarily
cause different versions of same-named files to be used.
.IP
.B scons
will miss changes in the implicit dependencies
in cases where a new implicit
dependency is added earlier in the implicit dependency search path
(e.g.
.BR CPPPATH ", " LIBPATH )
than a current implicit dependency with the same name.

.TP
--implicit-deps-changed
Forces SCons to ignore the cached implicit dependencies. This causes the
implicit dependencies to be rescanned and recached. This implies
.BR --implicit-cache .

.TP
--implicit-deps-unchanged
Force SCons to ignore changes in the implicit dependencies.
This causes cached implicit dependencies to always be used.
This implies
.BR --implicit-cache .

.TP
--interactive
Starts SCons in interactive mode.
The SConscript files are read once and a
.B "scons>>>"
prompt is printed.
Targets may now be rebuilt by typing commands at interactive prompt
without having to re-read the SConscript files
and re-initialize the dependency graph from scratch.

SCons interactive mode supports the following commands:

.RS 10
.TP 6
.BI build "[OPTIONS] [TARGETS] ..."
Builds the specified
.I TARGETS
(and their dependencies)
with the specified
SCons command-line
.IR OPTIONS .
.B b
and
.B scons
are synonyms.

The following SCons command-line options affect the
.B build
command:

.ES
--cache-debug=FILE
--cache-disable, --no-cache
--cache-force, --cache-populate
--cache-show
--debug=TYPE
-i, --ignore-errors
-j N, --jobs=N
-k, --keep-going
-n, --no-exec, --just-print, --dry-run, --recon
-Q
-s, --silent, --quiet
--taskmastertrace=FILE
--tree=OPTIONS
.EE

.IP "" 6
Any other SCons command-line options that are specified
do not cause errors
but have no effect on the
.B build
command
(mainly because they affect how the SConscript files are read,
which only happens once at the beginning of interactive mode).

.TP 6
.BI clean "[OPTIONS] [TARGETS] ..."
Cleans the specified
.I TARGETS
(and their dependencies)
with the specified options.
.B c
is a synonym.
This command is itself a synonym for
.B "build --clean"

.TP 6
.BI exit
Exits SCons interactive mode.
You can also exit by terminating input
(CTRL+D on UNIX or Linux systems,
CTRL+Z on Windows systems).

.TP 6
.BI help "[COMMAND]"
Provides a help message about
the commands available in SCons interactive mode.
If
.I COMMAND
is specified,
.B h
and
.B ?
are synonyms.

.TP 6
.BI shell "[COMMANDLINE]"
Executes the specified
.I COMMANDLINE
in a subshell.
If no
.I COMMANDLINE
is specified,
executes the interactive command interpreter
specified in the
.B SHELL
environment variable
(on UNIX and Linux systems)
or the
.B COMSPEC
environment variable
(on Windows systems).
.B sh
and
.B !
are synonyms.

.TP 6
.B version
Prints SCons version information.
.RE

.IP
An empty line repeats the last typed command.
Command-line editing can be used if the
.B readline
module is available.

.ES
$ scons --interactive
scons: Reading SConscript files ...
scons: done reading SConscript files.
scons>>> build -n prog
scons>>> exit
.EE

.TP
.RI -j " N" ", --jobs=" N
Specifies the number of jobs (commands) to run simultaneously.
If there is more than one
.B -j
option, the last one is effective.
.\" ??? If the
.\" .B -j
.\" option
.\" is specified without an argument,
.\" .B scons
.\" will not limit the number of
.\" simultaneous jobs.

.TP
-k, --keep-going
Continue as much as possible after an error.  The target that
failed and those that depend on it will not be remade, but other
targets specified on the command line will still be processed.

.\" .TP
.\" .RI  -l " N" ", --load-average=" N ", --max-load=" N
.\" No new jobs (commands) will be started if
.\" there are other jobs running and the system load
.\" average is at least
.\" .I N
.\" (a floating-point number).

.\"
.\" .TP
.\" --list-derived
.\" List derived files (targets, dependencies) that would be built,
.\" but do not build them.
.\" [XXX This can probably go away with the right
.\" combination of other options.  Revisit this issue.]
.\"
.\" .TP
.\" --list-actions
.\" List derived files that would be built, with the actions
.\" (commands) that build them.  Does not build the files.
.\" [XXX This can probably go away with the right
.\" combination of other options.  Revisit this issue.]
.\"
.\" .TP
.\" --list-where
.\" List derived files that would be built, plus where the file is
.\" defined (file name and line number).  Does not build the files.
.\" [XXX This can probably go away with the right
.\" combination of other options.  Revisit this issue.]

.TP
-m
Ignored for compatibility with non-GNU versions of
.BR make .

.TP
.RI --max-drift= SECONDS
Set the maximum expected drift in the modification time of files to
.IR SECONDS .
This value determines how long a file must be unmodified
before its cached content signature
will be used instead of
calculating a new content signature (MD5 checksum)
of the file's contents.
The default value is 2 days, which means a file must have a
modification time of at least two days ago in order to have its
cached content signature used.
A negative value means to never cache the content
signature and to ignore the cached value if there already is one. A value
of 0 means to always use the cached signature,
no matter how old the file is.

.TP
.RI --md5-chunksize= KILOBYTES
Set the block size used to compute MD5 signatures to
.IR KILOBYTES . 
This value determines the size of the chunks which are read in at once when
computing MD5 signatures.  Files below that size are fully stored in memory
before performing the signature computation while bigger files are read in
block-by-block. A huge block-size leads to high memory consumption while a very
small block-size slows down the build considerably.

The default value is to use a chunk size of 64 kilobytes, which should
be appropriate for most uses.

.TP
-n, --just-print, --dry-run, --recon
No execute.  Print the commands that would be executed to build
any out-of-date target files, but do not execute the commands.

.TP
.RI --no-site-dir
Prevents the automatic addition of the standard
.I site_scons
dirs to
.IR sys.path .
Also prevents loading the
.I site_scons/site_init.py
modules if they exist, and prevents adding their
.I site_scons/site_tools
dirs to the toolpath.

.\" .TP
.\" .RI -o " file" ", --old-file=" file ", --assume-old=" file
.\" Do not rebuild
.\" .IR file ,
.\" and do
.\" not rebuild anything due to changes in the contents of
.\" .IR file .
.\" .TP
.\" .RI --override " file"
.\" Read values to override specific build environment variables
.\" from the specified
.\" .IR file .
.\" .TP
.\" -p
.\" Print the data base (construction environments,
.\" Builder and Scanner objects) that are defined
.\" after reading the SConscript files.
.\" After printing, a normal build is performed
.\" as usual, as specified by other command-line options.
.\" This also prints version information
.\" printed by the
.\" .B -v
.\" option.
.\"
.\" To print the database without performing a build do:
.\"
.\" .ES
.\" scons -p -q
.\" .EE

.TP
.RI --profile= file
Run SCons under the Python profiler
and save the results in the specified
.IR file .
The results may be analyzed using the Python
pstats module.

.TP
-q, --question
Do not run any commands, or print anything.  Just return an exit
status that is zero if the specified targets are already up to
date, non-zero otherwise.
.TP
-Q
Quiets SCons status messages about
reading SConscript files,
building targets
and entering directories.
Commands that are executed
to rebuild target files are still printed.

.\" .TP
.\" -r, -R, --no-builtin-rules, --no-builtin-variables
.\" Clear the default construction variables.  Construction
.\" environments that are created will be completely empty.

.TP
--random
Build dependencies in a random order.  This is useful when
building multiple trees simultaneously with caching enabled,
to prevent multiple builds from simultaneously trying to build
or retrieve the same target files.

.TP
-s, --silent, --quiet
Silent.  Do not print commands that are executed to rebuild
target files.
Also suppresses SCons status messages.

.TP
-S, --no-keep-going, --stop
Ignored for compatibility with GNU
.BR make .

.TP
.RI --site-dir= dir
Uses the named dir as the site dir rather than the default
.I site_scons
dirs.  This dir will get prepended to
.IR sys.path ,
the module
.IR dir /site_init.py
will get loaded if it exists, and
.IR dir /site_tools
will get added to the default toolpath.

The default set of
.I site_scons
dirs used when
.I --site-dir
is not specified depends on the system platform, as follows.  Note
that the directories are examined in the order given, from most
generic to most specific, so the last-executed site_init.py file is
the most specific one (which gives it the chance to override
everything else), and the dirs are prepended to the paths, again so
the last dir examined comes first in the resulting path.

.IP "Windows:"
.nf
    %ALLUSERSPROFILE/Application Data/scons/site_scons
    %USERPROFILE%/Local Settings/Application Data/scons/site_scons
    %APPDATA%/scons/site_scons
    %HOME%/.scons/site_scons
    ./site_scons
.fi
.IP "Mac OS X:"
.nf
    /Library/Application Support/SCons/site_scons
    /opt/local/share/scons/site_scons (for MacPorts)
    /sw/share/scons/site_scons (for Fink)
    $HOME/Library/Application Support/SCons/site_scons
    $HOME/.scons/site_scons
    ./site_scons
.fi
.IP "Solaris:"
.nf
    /opt/sfw/scons/site_scons
    /usr/share/scons/site_scons
    $HOME/.scons/site_scons
    ./site_scons
.fi
.IP "Linux, HPUX, and other Posix-like systems:"
.nf
    /usr/share/scons/site_scons
    $HOME/.scons/site_scons
    ./site_scons
.fi

.TP
.RI --stack-size= KILOBYTES
Set the size stack used to run threads to
.IR KILOBYTES .
This value determines the stack size of the threads used to run jobs.
These are the threads that execute the actions of the builders for the
nodes that are out-of-date.
Note that this option has no effect unless the
.B num_jobs
option, which corresponds to -j and --jobs, is larger than one.  Using
a stack size that is too small may cause stack overflow errors.  This
usually shows up as segmentation faults that cause scons to abort
before building anything.  Using a stack size that is too large will
cause scons to use more memory than required and may slow down the entire
build process.

The default value is to use a stack size of 256 kilobytes, which should
be appropriate for most uses.  You should not need to increase this value
unless you encounter stack overflow errors.

.TP
-t, --touch
Ignored for compatibility with GNU
.BR make .
(Touching a file to make it
appear up-to-date is unnecessary when using
.BR scons .)

.TP
.RI --taskmastertrace= file
Prints trace information to the specified
.I file
about how the internal Taskmaster object
evaluates and controls the order in which Nodes are built.
A file name of
.B -
may be used to specify the standard output.

.TP
.RI -tree= options
Prints a tree of the dependencies
after each top-level target is built.
This prints out some or all of the tree,
in various formats,
depending on the
.I options
specified:

.TP
--tree=all
Print the entire dependency tree
after each top-level target is built.
This prints out the complete dependency tree,
including implicit dependencies and ignored dependencies.

.TP
--tree=derived
Restricts the tree output to only derived (target) files,
not source files.

.TP
--tree=status
Prints status information for each displayed node.

.TP
--tree=prune
Prunes the tree to avoid repeating dependency information
for nodes that have already been displayed.
Any node that has already been displayed
will have its name printed in
.BR "[square brackets]" ,
as an indication that the dependencies
for that node can be found by searching
for the relevant output higher up in the tree.

.IP
Multiple options may be specified,
separated by commas:

.ES
# Prints only derived files, with status information:
scons --tree=derived,status

# Prints all dependencies of target, with status information
# and pruning dependencies of already-visited Nodes:
scons --tree=all,prune,status target
.EE

.TP
-u, --up, --search-up
Walks up the directory structure until an
.I SConstruct ,
.I Sconstruct
or
.I sconstruct
file is found, and uses that
as the top of the directory tree.
If no targets are specified on the command line,
only targets at or below the
current directory will be built.

.TP
-U
Works exactly the same way as the
.B -u
option except for the way default targets are handled.
When this option is used and no targets are specified on the command line,
all default targets that are defined in the SConscript(s) in the current
directory are built, regardless of what directory the resultant targets end
up in.

.TP
-v, --version
Print the
.B scons
version, copyright information,
list of authors, and any other relevant information.
Then exit.

.TP
-w, --print-directory
Print a message containing the working directory before and
after other processing.

.TP
--no-print-directory
Turn off -w, even if it was turned on implicitly.

.TP
.RI --warn= type ", --warn=no-" type
Enable or disable warnings.
.I type
specifies the type of warnings to be enabled or disabled:

.TP
--warn=all, --warn=no-all
Enables or disables all warnings.

.TP
--warn=cache-write-error, --warn=no-cache-write-error
Enables or disables warnings about errors trying to
write a copy of a built file to a specified
.BR CacheDir ().
These warnings are disabled by default.

.TP
--warn=corrupt-sconsign, --warn=no-corrupt-sconsign
Enables or disables warnings about unfamiliar signature data in
.B .sconsign
files.
These warnings are enabled by default.

.TP
--warn=dependency, --warn=no-dependency
Enables or disables warnings about dependencies.
These warnings are disabled by default.

.TP
--warn=deprecated, --warn=no-deprecated
Enables or disables all warnings about use of
currently deprecated features.
These warnings are enabled by default.
Note that the
.B --warn=no-deprecated
option does not disable warnings about absolutely all deprecated features.
Warnings for some deprecated features that have already been through
several releases with deprecation warnings
may be mandatory for a release or two
before they are officially no longer supported by SCons.
Warnings for some specific deprecated features
may be enabled or disabled individually;
see below.

.RS
.TP
--warn=deprecated-copy, --warn=no-deprecated-copy
Enables or disables warnings about use of the deprecated
.B env.Copy()
method.

.TP
--warn=deprecated-source-signatures, --warn=no-deprecated-source-signatures
Enables or disables warnings about use of the deprecated
.B SourceSignatures()
function or
.B env.SourceSignatures()
method.

.TP
--warn=deprecated-target-signatures, --warn=no-deprecated-target-signatures
Enables or disables warnings about use of the deprecated
.B TargetSignatures()
function or
.B env.TargetSignatures()
method.
.RE

.TP
--warn=duplicate-environment, --warn=no-duplicate-environment
Enables or disables warnings about attempts to specify a build
of a target with two different construction environments
that use the same action.
These warnings are enabled by default.

.TP
--warn=fortran-cxx-mix, --warn=no-fortran-cxx-mix
Enables or disables the specific warning about linking
Fortran and C++ object files in a single executable,
which can yield unpredictable behavior with some compilers.

.TP
--warn=future-deprecated, --warn=no-future-deprecated
Enables or disables warnings about features
that will be deprecated in the future.
These warnings are disabled by default.
Enabling this warning is especially
recommended for projects that redistribute
SCons configurations for other users to build,
so that the project can be warned as soon as possible
about to-be-deprecated features
that may require changes to the configuration.

.TP
--warn=link, --warn=no-link
Enables or disables warnings about link steps.

.TP
--warn=misleading-keywords, --warn=no-misleading-keywords
Enables or disables warnings about use of the misspelled keywords
.B targets
and
.B sources
when calling Builders.
(Note the last
.B s
characters, the correct spellings are
.B target
and
.B source.)
These warnings are enabled by default.

.TP
--warn=missing-sconscript, --warn=no-missing-sconscript
Enables or disables warnings about missing SConscript files.
These warnings are enabled by default.

.TP
--warn=no-md5-module, --warn=no-no-md5-module
Enables or disables warnings about the version of Python
not having an MD5 checksum module available.
These warnings are enabled by default.

.TP
--warn=no-metaclass-support, --warn=no-no-metaclass-support
Enables or disables warnings about the version of Python
not supporting metaclasses when the
.B --debug=memoizer
option is used.
These warnings are enabled by default.

.TP
--warn=no-object-count, --warn=no-no-object-count
Enables or disables warnings about the
.B --debug=object
feature not working when
.B scons
is run with the python
.B \-O
option or from optimized Python (.pyo) modules.

.TP
--warn=no-parallel-support, --warn=no-no-parallel-support
Enables or disables warnings about the version of Python
not being able to support parallel builds when the
.B -j
option is used.
These warnings are enabled by default.

.TP
--warn=python-version, --warn=no-python-version
Enables or disables the warning about running
SCons with a deprecated version of Python.
These warnings are enabled by default.

.TP
--warn=reserved-variable, --warn=no-reserved-variable
Enables or disables warnings about attempts to set the
reserved construction variable names
.BR CHANGED_SOURCES ,
.BR CHANGED_TARGETS ,
.BR TARGET ,
.BR TARGETS ,
.BR SOURCE ,
.BR SOURCES ,
.BR UNCHANGED_SOURCES
or
.BR UNCHANGED_TARGETS .
These warnings are disabled by default.

.TP
--warn=stack-size, --warn=no-stack-size
Enables or disables warnings about requests to set the stack size
that could not be honored.
These warnings are enabled by default.

.\" .TP
.\" .RI --write-filenames= file
.\" Write all filenames considered into
.\" .IR file .
.\"
.\" .TP
.\" .RI -W " file" ", --what-if=" file ", --new-file=" file ", --assume-new=" file
.\" Pretend that the target
.\" .I file
.\" has been
.\" modified.  When used with the
.\" .B -n
.\" option, this
.\" show you what would be rebuilt if you were to modify that file.
.\" Without
.\" .B -n
.\" ... what? XXX
.\"
.\" .TP
.\" --warn-undefined-variables
.\" Warn when an undefined variable is referenced.

.TP
.RI -Y " repository" ", --repository=" repository ", --srcdir=" repository
Search the specified repository for any input and target
files not found in the local directory hierarchy.  Multiple
.B -Y
options may be specified, in which case the
repositories are searched in the order specified.

.SH CONFIGURATION FILE REFERENCE
.\" .SS Python Basics
.\" XXX Adding this in the future would be a help.
.SS Construction Environments
A construction environment is the basic means by which the SConscript
files communicate build information to
.BR scons .
A new construction environment is created using the
.B Environment
function:

.ES
env = Environment()
.EE

Variables, called
.I construction
.IR variables ,
may be set in a construction environment
either by specifying them as keywords when the object is created
or by assigning them a value after the object is created:

.ES
env = Environment(FOO = 'foo')
env['BAR'] = 'bar'
.EE

As a convenience,
construction variables may also be set or modified by the
.I parse_flags
keyword argument, which applies the
.B ParseFlags
method (described below) to the argument value
after all other processing is completed.
This is useful either if the exact content of the flags is unknown
(for example, read from a control file)
or if the flags are distributed to a number of construction variables.

.ES
env = Environment(parse_flags = '-Iinclude -DEBUG -lm')
.EE

This example adds 'include' to
.BR CPPPATH ,
\&'EBUG' to
.BR CPPDEFINES ,
and 'm' to
.BR LIBS .

By default, a new construction environment is
initialized with a set of builder methods
and construction variables that are appropriate
for the current platform.
An optional platform keyword argument may be
used to specify that an environment should
be initialized for a different platform:

.ES
env = Environment(platform = 'cygwin')
env = Environment(platform = 'os2')
env = Environment(platform = 'posix')
env = Environment(platform = 'win32')
.EE

Specifying a platform initializes the appropriate
construction variables in the environment
to use and generate file names with prefixes
and suffixes appropriate for the platform.

Note that the
.B win32
platform adds the
.B SystemDrive
and
.B SystemRoot
variables from the user's external environment
to the construction environment's
.B ENV
dictionary.
This is so that any executed commands
that use sockets to connect with other systems
(such as fetching source files from
external CVS repository specifications like
.BR :pserver:anonymous@cvs.sourceforge.net:/cvsroot/scons )
will work on Windows systems.

The platform argument may be function or callable object,
in which case the Environment() method
will call the specified argument to update
the new construction environment:

.ES
def my_platform(env):
    env['VAR'] = 'xyzzy'

env = Environment(platform = my_platform)
.EE

Additionally, a specific set of tools
with which to initialize the environment
may be specified as an optional keyword argument:

.ES
env = Environment(tools = ['msvc', 'lex'])
.EE

Non-built-in tools may be specified using the toolpath argument:

.ES
env = Environment(tools = ['default', 'foo'], toolpath = ['tools'])
.EE

This looks for a tool specification in tools/foo.py (as well as
using the ordinary default tools for the platform).  foo.py should
have two functions: generate(env, **kw) and exists(env).
The
.B generate()
function
modifies the passed-in environment
to set up variables so that the tool
can be executed;
it may use any keyword arguments
that the user supplies (see below)
to vary its initialization.
The
.B exists()
function should return a true
value if the tool is available.
Tools in the toolpath are used before
any of the built-in ones.  For example, adding gcc.py to the toolpath
would override the built-in gcc tool.
Also note that the toolpath is
stored in the environment for use
by later calls to
.BR Clone ()
and
.BR Tool ()
methods:

.ES
base = Environment(toolpath=['custom_path'])
derived = base.Clone(tools=['custom_tool'])
derived.CustomBuilder()
.EE

The elements of the tools list may also
be functions or callable objects,
in which case the Environment() method
will call the specified elements
to update the new construction environment:

.ES
def my_tool(env):
    env['XYZZY'] = 'xyzzy'

env = Environment(tools = [my_tool])
.EE

The individual elements of the tools list
may also themselves be two-element lists of the form
.RI ( toolname ", " kw_dict ).
SCons searches for the
.I toolname
specification file as described above, and
passes
.IR kw_dict ,
which must be a dictionary, as keyword arguments to the tool's
.B generate
function.
The
.B generate
function can use the arguments to modify the tool's behavior
by setting up the environment in different ways
or otherwise changing its initialization.

.ES
# in tools/my_tool.py:
def generate(env, **kw):
  # Sets MY_TOOL to the value of keyword argument 'arg1' or 1.
  env['MY_TOOL'] = kw.get('arg1', '1')
def exists(env):
  return 1

# in SConstruct:
env = Environment(tools = ['default', ('my_tool', {'arg1': 'abc'})],
                  toolpath=['tools'])
.EE

The tool definition (i.e. my_tool()) can use the PLATFORM variable from
the environment it receives to customize the tool for different platforms.

If no tool list is specified, then SCons will auto-detect the installed
tools using the PATH variable in the ENV construction variable and the
platform name when the Environment is constructed. Changing the PATH
variable after the Environment is constructed will not cause the tools to
be redetected.

SCons supports the following tool specifications out of the box:

.ES
386asm
aixc++
aixcc
aixf77
aixlink
ar
as
bcc32
c++
cc
cvf
dmd
dvipdf
dvips
f77
f90
f95
fortran
g++
g77
gas
gcc
gfortran
gnulink
gs
hpc++
hpcc
hplink
icc
icl
ifl
ifort
ilink
ilink32
intelc
jar
javac
javah
latex
lex
link
linkloc
m4
masm
midl
mingw
mslib
mslink
mssdk
msvc
msvs
mwcc
mwld
nasm
pdflatex
pdftex
qt
rmic
rpcgen
sgiar
sgic++
sgicc
sgilink
sunar
sunc++
suncc
sunf77
sunf90
sunf95
sunlink
swig
tar
tex
textfile
tlib
yacc
zip
.EE

Additionally, there is a "tool" named
.B default
which configures the
environment with a default set of tools for the current platform.

On posix and cygwin platforms
the GNU tools (e.g. gcc) are preferred by SCons,
on Windows the Microsoft tools (e.g. msvc)
followed by MinGW are preferred by SCons,
and in OS/2 the IBM tools (e.g. icc) are preferred by SCons.

.SS Builder Methods

Build rules are specified by calling a construction
environment's builder methods.
The arguments to the builder methods are
.B target
(a list of targets to be built,
usually file names)
and
.B source
(a list of sources to be built,
usually file names).

Because long lists of file names
can lead to a lot of quoting,
.B scons
supplies a
.B Split()
global function
and a same-named environment method
that split a single string
into a list, separated on
strings of white-space characters.
(These are similar to the split() member function of Python strings
but work even if the input isn't a string.)

Like all Python arguments,
the target and source arguments to a builder method
can be specified either with or without
the "target" and "source" keywords.
When the keywords are omitted,
the target is first,
followed by the source.
The following are equivalent examples of calling the Program builder method:

.ES
env.Program('bar', ['bar.c', 'foo.c'])
env.Program('bar', Split('bar.c foo.c'))
env.Program('bar', env.Split('bar.c foo.c'))
env.Program(source =  ['bar.c', 'foo.c'], target = 'bar')
env.Program(target = 'bar', Split('bar.c foo.c'))
env.Program(target = 'bar', env.Split('bar.c foo.c'))
env.Program('bar', source = 'bar.c foo.c'.split())
.EE

Target and source file names
that are not absolute path names
(that is, do not begin with
.B /
on POSIX systems
or
.B \\
on Windows systems,
with or without
an optional drive letter)
are interpreted relative to the directory containing the
.B SConscript
file being read.
An initial
.B #
(hash mark)
on a path name means that the rest of the file name
is interpreted relative to
the directory containing
the top-level
.B SConstruct
file,
even if the
.B #
is followed by a directory separator character
(slash or backslash).

Examples:

.ES
# The comments describing the targets that will be built
# assume these calls are in a SConscript file in the
# a subdirectory named "subdir".

# Builds the program "subdir/foo" from "subdir/foo.c":
env.Program('foo', 'foo.c')

# Builds the program "/tmp/bar" from "subdir/bar.c":
env.Program('/tmp/bar', 'bar.c')

# An initial '#' or '#/' are equivalent; the following
# calls build the programs "foo" and "bar" (in the
# top-level SConstruct directory) from "subdir/foo.c" and
# "subdir/bar.c", respectively:
env.Program('#foo', 'foo.c')
env.Program('#/bar', 'bar.c')

# Builds the program "other/foo" (relative to the top-level
# SConstruct directory) from "subdir/foo.c":
env.Program('#other/foo', 'foo.c')
.EE

When the target shares the same base name
as the source and only the suffix varies,
and if the builder method has a suffix defined for the target file type,
then the target argument may be omitted completely,
and
.B scons
will deduce the target file name from
the source file name.
The following examples all build the
executable program
.B bar
(on POSIX systems)
or
.B bar.exe
(on Windows systems)
from the bar.c source file:

.ES
env.Program(target = 'bar', source = 'bar.c')
env.Program('bar', source = 'bar.c')
env.Program(source = 'bar.c')
env.Program('bar.c')
.EE

As a convenience, a
.B srcdir
keyword argument may be specified
when calling a Builder.
When specified,
all source file strings that are not absolute paths
will be interpreted relative to the specified
.BR srcdir .
The following example will build the
.B build/prog
(or
.B build/prog.exe
on Windows)
program from the files
.B src/f1.c
and
.BR src/f2.c :

.ES
env.Program('build/prog', ['f1.c', 'f2.c'], srcdir='src')
.EE

It is possible to override or add construction variables when calling a
builder method by passing additional keyword arguments.
These overridden or added
variables will only be in effect when building the target, so they will not
affect other parts of the build. For example, if you want to add additional
libraries for just one program:

.ES
env.Program('hello', 'hello.c', LIBS=['gl', 'glut'])
.EE

or generate a shared library with a non-standard suffix:

.ES
env.SharedLibrary('word', 'word.cpp',
                  SHLIBSUFFIX='.ocx',
                  LIBSUFFIXES=['.ocx'])
.EE

(Note that both the $SHLIBSUFFIX and $LIBSUFFIXES variables must be set
if you want SCons to search automatically
for dependencies on the non-standard library names;
see the descriptions of these variables, below, for more information.)

It is also possible to use the
.I parse_flags
keyword argument in an override:

.ES
env = Program('hello', 'hello.c', parse_flags = '-Iinclude -DEBUG -lm')
.EE

This example adds 'include' to
.BR CPPPATH ,
\&'EBUG' to
.BR CPPDEFINES ,
and 'm' to
.BR LIBS .

Although the builder methods defined by
.B scons
are, in fact,
methods of a construction environment object,
they may also be called without an explicit environment:

.ES
Program('hello', 'hello.c')
SharedLibrary('word', 'word.cpp')
.EE

In this case,
the methods are called internally using a default construction
environment that consists of the tools and values that
.B scons
has determined are appropriate for the local system.

Builder methods that can be called without an explicit
environment may be called from custom Python modules that you
import into an SConscript file by adding the following
to the Python module:

.ES
from SCons.Script import *
.EE

All builder methods return a list-like object
containing Nodes that
represent the target or targets that will be built.
A
.I Node
is an internal SCons object
which represents
build targets or sources.

The returned Node-list object
can be passed to other builder methods as source(s)
or passed to any SCons function or method
where a filename would normally be accepted.
For example, if it were necessary
to add a specific
.B -D
flag when compiling one specific object file:

.ES
bar_obj_list = env.StaticObject('bar.c', CPPDEFINES='-DBAR')
env.Program(source = ['foo.c', bar_obj_list, 'main.c'])
.EE

Using a Node in this way
makes for a more portable build
by avoiding having to specify
a platform-specific object suffix
when calling the Program() builder method.

Note that Builder calls will automatically "flatten"
the source and target file lists,
so it's all right to have the bar_obj list
return by the StaticObject() call
in the middle of the source file list.
If you need to manipulate a list of lists returned by Builders
directly using Python,
you can either build the list by hand:

.ES
foo = Object('foo.c')
bar = Object('bar.c')
objects = ['begin.o'] + foo + ['middle.o'] + bar + ['end.o']
for object in objects:
    print str(object)
.EE

Or you can use the
.BR Flatten ()
function supplied by scons
to create a list containing just the Nodes,
which may be more convenient:

.ES
foo = Object('foo.c')
bar = Object('bar.c')
objects = Flatten(['begin.o', foo, 'middle.o', bar, 'end.o'])
for object in objects:
    print str(object)
.EE

Note also that because Builder calls return
a list-like object, not an actual Python list,
you should
.I not
use the Python
.B +=
operator to append Builder results to a Python list.
Because the list and the object are different types,
Python will not update the original list in place,
but will instead create a new Node-list object
containing the concatenation of the list
elements and the Builder results.
This will cause problems for any other Python variables
in your SCons configuration
that still hold on to a reference to the original list.
Instead, use the Python
.B .extend()
method to make sure the list is updated in-place.
Example:

.ES
object_files = []

# Do NOT use += as follows:
#
#    object_files += Object('bar.c')
#
# It will not update the object_files list in place.
#
# Instead, use the .extend() method:
object_files.extend(Object('bar.c'))

.EE

The path name for a Node's file may be used
by passing the Node to the Python-builtin
.B str()
function:

.ES
bar_obj_list = env.StaticObject('bar.c', CPPDEFINES='-DBAR')
print "The path to bar_obj is:", str(bar_obj_list[0])
.EE

Note again that because the Builder call returns a list,
we have to access the first element in the list
.B (bar_obj_list[0])
to get at the Node that actually represents
the object file.

Builder calls support a
.B chdir
keyword argument that
specifies that the Builder's action(s)
should be executed
after changing directory.
If the
.B chdir
argument is
a string or a directory Node,
scons will change to the specified directory.
If the
.B chdir
is not a string or Node
and is non-zero,
then scons will change to the
target file's directory.

.ES
# scons will change to the "sub" subdirectory
# before executing the "cp" command.
env.Command('sub/dir/foo.out', 'sub/dir/foo.in',
            "cp dir/foo.in dir/foo.out",
            chdir='sub')

# Because chdir is not a string, scons will change to the
# target's directory ("sub/dir") before executing the
# "cp" command.
env.Command('sub/dir/foo.out', 'sub/dir/foo.in',
            "cp foo.in foo.out",
            chdir=1)
.EE

Note that scons will
.I not
automatically modify
its expansion of
construction variables like
.B $TARGET
and
.B $SOURCE
when using the chdir
keyword argument--that is,
the expanded file names
will still be relative to
the top-level SConstruct directory,
and consequently incorrect
relative to the chdir directory.
If you use the chdir keyword argument,
you will typically need to supply a different
command line using
expansions like
.B ${TARGET.file}
and
.B ${SOURCE.file}
to use just the filename portion of the
targets and source.

.B scons
provides the following builder methods:

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
'\" BEGIN GENERATED BUILDER DESCRIPTIONS
'\"
'\" The descriptions below of the various SCons Builders are generated
'\" from the .xml files that live next to the various Python modules in
'\" the build enginer library.  If you're reading this [gnt]roff file
'\" with an eye towards patching this man page, you can still submit
'\" a diff against this text, but it will have to be translated to a
'\" diff against the underlying .xml file before the patch is actually
'\" accepted.  If you do that yourself, it will make it easier to
'\" integrate the patch.
'\"
'\" BEGIN GENERATED BUILDER DESCRIPTIONS
'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.IP CFile()
.IP env.CFile()
Builds a C source file given a lex (\fB.l\fP)
or yacc (\fB.y\fP) input file.
The suffix specified by the \fB$CFILESUFFIX\fP construction variable
(\fB.c\fP by default)
is automatically added to the target
if it is not already present.
Example:

.ES
# builds foo.c
env.CFile(target = 'foo.c', source = 'foo.l')
# builds bar.c
env.CFile(target = 'bar', source = 'bar.y')
.EE

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.IP Command()
.IP env.Command()
The \fBCommand\fP() "Builder" is actually implemented
as a function that looks like a Builder,
but actually takes an additional argument of the action
from which the Builder should be made.
See the \fBCommand\fP() function description
for the calling syntax and details.

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.IP CXXFile()
.IP env.CXXFile()
Builds a C++ source file given a lex (\fB.ll\fP)
or yacc (\fB.yy\fP)
input file.
The suffix specified by the \fB$CXXFILESUFFIX\fP construction variable
(\fB.cc\fP by default)
is automatically added to the target
if it is not already present.
Example:

.ES
# builds foo.cc
env.CXXFile(target = 'foo.cc', source = 'foo.ll')
# builds bar.cc
env.CXXFile(target = 'bar', source = 'bar.yy')
.EE

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.IP DVI()
.IP env.DVI()
Builds a \fB.dvi\fP file
from a \fB.tex\fP,
\fB.ltx\fP or \fB.latex\fP input file.
If the source file suffix is \fB.tex\fP,
.B scons
will examine the contents of the file;
if the string
.B \\documentclass
or
.B \\documentstyle
is found, the file is assumed to be a LaTeX file and
the target is built by invoking the \fB$LATEXCOM\fP command line;
otherwise, the \fB$TEXCOM\fP command line is used.
If the file is a LaTeX file,
the
.BR DVI ()
builder method will also examine the contents
of the
.B .aux
file and invoke the \fB$BIBTEX\fP command line
if the string
.B bibdata
is found,
start \fB$MAKEINDEX\fP to generate an index if a
.B .ind
file is found
and will examine the contents
.B .log
file and re-run the \fB$LATEXCOM\fP command
if the log file says it is necessary.

The suffix \fB.dvi\fP
(hard-coded within TeX itself)
is automatically added to the target
if it is not already present.
Examples:

.ES
# builds from aaa.tex
env.DVI(target = 'aaa.dvi', source = 'aaa.tex')
# builds bbb.dvi
env.DVI(target = 'bbb', source = 'bbb.ltx')
# builds from ccc.latex
env.DVI(target = 'ccc.dvi', source = 'ccc.latex')
.EE

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.IP Install()
.IP env.Install()
Installs one or more source files or directories
in the specified target,
which must be a directory.
The names of the specified source files or directories
remain the same within the destination directory. The
sources may be given as a string or as a node returned by
a builder.

.ES
env.Install('/usr/local/bin', source = ['foo', 'bar'])
.EE

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.IP InstallAs()
.IP env.InstallAs()
Installs one or more source files or directories
to specific names,
allowing changing a file or directory name
as part of the installation.
It is an error if the
target
and
source
arguments list different numbers of files or directories.

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.IP InstallVersionedLib()
.IP env.InstallVersionedLib()
Installs a versioned shared library. The \fB$SHLIBVERSION\fP
construction variable should be defined in the environment
to confirm the version number in the library name.
The symlinks appropriate to the architecture will be generated.

.ES
env.InstallAs(target = '/usr/local/bin/foo',
              source = 'foo_debug')
env.InstallAs(target = ['../lib/libfoo.a', '../lib/libbar.a'],
              source = ['libFOO.a', 'libBAR.a'])
.EE

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.IP Jar()
.IP env.Jar()
Builds a Java archive (\fB.jar\fP) file
from the specified list of sources.
Any directories in the source list
will be searched for \fB.class\fP files).
Any \fB.java\fP files in the source list
will be compiled  to \fB.class\fP files
by calling the \fBJava\fP() Builder.

If the \fB$JARCHDIR\fP value is set, the
.B jar
command will change to the specified directory using the
.B \-C
option.
If \fB$JARCHDIR\fP is not set explicitly,
&SCons; will use the top of any subdirectory tree
in which Java \fB.class\fP
were built by the \fBJava\fP() Builder.

If the contents any of the source files begin with the string
.BR Manifest-Version ,
the file is assumed to be a manifest
and is passed to the
.B jar
command with the
.B m
option set.

.ES
env.Jar(target = 'foo.jar', source = 'classes')

env.Jar(target = 'bar.jar',
        source = ['bar1.java', 'bar2.java'])
.EE

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.IP Java()
.IP env.Java()
Builds one or more Java class files.
The sources may be any combination of explicit
\fB.java\fP files,
or directory trees which will be scanned
for \fB.java\fP files.

SCons will parse each source \fB.java\fP file
to find the classes
(including inner classes)
defined within that file,
and from that figure out the
target \fB.class\fP files that will be created.
The class files will be placed underneath
the specified target directory.

SCons will also search each Java file
for the Java package name,
which it assumes can be found on a line
beginning with the string
.B package
in the first column;
the resulting \fB.class\fP files
will be placed in a directory reflecting
the specified package name.
For example,
the file
.B Foo.java
defining a single public
.I Foo
class and
containing a package name of
.I sub.dir
will generate a corresponding
.B sub/dir/Foo.class
class file.

Examples:

.ES
env.Java(target = 'classes', source = 'src')
env.Java(target = 'classes', source = ['src1', 'src2'])
env.Java(target = 'classes', source = ['File1.java', 'File2.java'])
.EE
.IP
Java source files can use the native encoding for the underlying OS.
Since SCons compiles in simple ASCII mode by default,
the compiler will generate warnings about unmappable characters,
which may lead to errors as the file is processed further.
In this case, the user must specify the \fBLANG\fP
environment variable to tell the compiler what encoding is used.
For portibility, it's best if the encoding is hard-coded
so that the compile will work if it is done on a system
with a different encoding.

.ES
env = Environment()
env['ENV']['LANG'] = 'en_GB.UTF-8'
.EE

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.IP JavaH()
.IP env.JavaH()
Builds C header and source files for
implementing Java native methods.
The target can be either a directory
in which the header files will be written,
or a header file name which
will contain all of the definitions.
The source can be the names of \fB.class\fP files,
the names of \fB.java\fP files
to be compiled into \fB.class\fP files
by calling the \fBJava\fP() builder method,
or the objects returned from the
.BR Java ()
builder method.

If the construction variable
.B $JAVACLASSDIR
is set, either in the environment
or in the call to the
.BR JavaH ()
builder method itself,
then the value of the variable
will be stripped from the
beginning of any \fB.class\fP file names.

Examples:

.ES
# builds java_native.h
classes = env.Java(target = 'classdir', source = 'src')
env.JavaH(target = 'java_native.h', source = classes)

# builds include/package_foo.h and include/package_bar.h
env.JavaH(target = 'include',
          source = ['package/foo.class', 'package/bar.class'])

# builds export/foo.h and export/bar.h
env.JavaH(target = 'export',
          source = ['classes/foo.class', 'classes/bar.class'],
          JAVACLASSDIR = 'classes')
.EE

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.IP Library()
.IP env.Library()
A synonym for the
.BR StaticLibrary ()
builder method.

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.IP LoadableModule()
.IP env.LoadableModule()
On most systems,
this is the same as
.BR SharedLibrary ().
On Mac OS X (Darwin) platforms,
this creates a loadable module bundle.

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.IP M4()
.IP env.M4()
Builds an output file from an M4 input file.
This uses a default \fB$M4FLAGS\fP value of
.BR \-E ,
which considers all warnings to be fatal
and stops on the first warning
when using the GNU version of m4.
Example:

.ES
env.M4(target = 'foo.c', source = 'foo.c.m4')
.EE

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.IP Moc()
.IP env.Moc()
Builds an output file from a moc input file. Moc input files are either
header files or cxx files. This builder is only available after using the
tool 'qt'. See the \fB$QTDIR\fP variable for more information.
Example:

.ES
env.Moc('foo.h') # generates moc_foo.cc
env.Moc('foo.cpp') # generates foo.moc
.EE

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.IP MOFiles()
.IP env.MOFiles()
This builder belongs to &t-link-msgfmt; tool. The builder compiles
\fBPO\fP files to \fBMO\fP files.

.IR Example 1 .
Create \fBpl.mo\fP and \fBen.mo\fP by compiling
.BR pl.po\fP and \fBen.po :
.ES
  # ...
  env.MOFiles(['pl', 'en'])
.EE
.IP
.IR Example 2 .
Compile files for languages defined in \fBLINGUAS\fP file:
.ES
  # ...
  env.MOFiles(LINGUAS_FILE = 1)
.EE
.IP
.IR Example 3 .
Create \fBpl.mo\fP and \fBen.mo\fP by compiling
\fBpl.po\fP and \fBen.po\fP plus files for
languages defined in \fBLINGUAS\fP file:
.ES
  # ...
  env.MOFiles(['pl', 'en'], LINGUAS_FILE = 1)
.EE
.IP
.IR Example 4 .
Compile files for languages defined in \fBLINGUAS\fP file 
(another version):
.ES
  # ...
  env['LINGUAS_FILE'] = 1
  env.MOFiles()
.EE

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.IP MSVSProject()
.IP env.MSVSProject()
Builds a Microsoft Visual Studio project file,
and by default builds a solution file as well.

This builds a Visual Studio project file, based on the version of
Visual Studio that is configured (either the latest installed version,
or the version specified by
.B $MSVS_VERSION
in the Environment constructor).
For Visual Studio 6, it will generate a
.B .dsp
file.
For Visual Studio 7 (.NET) and later versions, it will generate a
.B .vcproj
file.

By default,
this also generates a solution file
for the specified project,
a
.B .dsw
file for Visual Studio 6
or a
.B .sln
file for Visual Studio 7 (.NET).
This behavior may be disabled by specifying
.B auto_build_solution=0
when you call
.BR MSVSProject (),
in which case you presumably want to
build the solution file(s)
by calling the
.BR MSVSSolution ()
Builder (see below).

The \fBMSVSProject\fP() builder
takes several lists of filenames
to be placed into the project file.
These are currently limited to
.BR srcs ,
.BR incs ,
.BR localincs ,
.BR resources ,
and
.BR misc .
These are pretty self-explanatory, but it should be noted that these
lists are added to the \fB$SOURCES\fP construction variable as strings,
NOT as SCons File Nodes.  This is because they represent file
names to be added to the project file, not the source files used to
build the project file.

The above filename lists are all optional,
although at least one must be specified
for the resulting project file to be non-empty.

In addition to the above lists of values,
the following values may be specified:

.BR target :
The name of the target
.B .dsp
or
.B .vcproj
file.
The correct
suffix for the version of Visual Studio must be used,
but the
.B $MSVSPROJECTSUFFIX
construction variable
will be defined to the correct value (see example below).

.BR variant :
The name of this particular variant.
For Visual Studio 7 projects,
this can also be a list of variant names.
These are typically things like "Debug" or "Release", but really
can be anything you want.
For Visual Studio 7 projects,
they may also specify a target platform
separated from the variant name by a
.B |
(vertical pipe)
character:
.BR Debug|Xbox .
The default target platform is Win32.
Multiple calls to
.BR MSVSProject ()
with different variants are allowed;
all variants will be added to the project file with their appropriate
build targets and sources.

.BR buildtarget :
An optional string, node, or list of strings or nodes
(one per build variant), to tell the Visual Studio debugger
what output target to use in what build variant.
The number of
.B buildtarget
entries must match the number of
.B variant
entries.

.BR runfile :
The name of the file that Visual Studio 7 and later
will run and debug.
This appears as the value of the
.B Output
field in the resutling Visual Studio project file.
If this is not specified,
the default is the same as the specified
.B buildtarget
value.

Note that because &SCons; always executes its build commands
from the directory in which the \fBSConstruct\fP file is located,
if you generate a project file in a different directory
than the \fBSConstruct\fP directory,
users will not be able to double-click
on the file name in compilation error messages
displayed in the Visual Studio console output window.
This can be remedied by adding the
Visual C/C++
.B /FC
compiler option to the \fB$CCFLAGS\fP  variable
so that the compiler will print
the full path name of any
files that cause compilation errors.

Example usage:

.ES
barsrcs = ['bar.cpp'],
barincs = ['bar.h'],
barlocalincs = ['StdAfx.h']
barresources = ['bar.rc','resource.h']
barmisc = ['bar_readme.txt']

dll = env.SharedLibrary(target = 'bar.dll',
                        source = barsrcs)

env.MSVSProject(target = 'Bar' + env['MSVSPROJECTSUFFIX'],
                srcs = barsrcs,
                incs = barincs,
                localincs = barlocalincs,
                resources = barresources,
                misc = barmisc,
                buildtarget = dll,
                variant = 'Release')
.EE

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.IP MSVSSolution()
.IP env.MSVSSolution()
Builds a Microsoft Visual Studio solution file.

This builds a Visual Studio solution file,
based on the version of Visual Studio that is configured
(either the latest installed version,
or the version specified by
.B $MSVS_VERSION
in the construction environment).
For Visual Studio 6, it will generate a
.B .dsw
file.
For Visual Studio 7 (.NET), it will
generate a
.B .sln
file.

The following values must be specified:

.BR target :
The name of the target .dsw or .sln file.  The correct
suffix for the version of Visual Studio must be used, but the value
.B $MSVSSOLUTIONSUFFIX
will be defined to the correct value (see example below).

.BR variant :
The name of this particular variant, or a list of variant
names (the latter is only supported for MSVS 7 solutions). These are
typically things like "Debug" or "Release", but really can be anything
you want. For MSVS 7 they may also specify target platform, like this
"Debug|Xbox". Default platform is Win32.

.BR projects :
A list of project file names, or Project nodes returned by calls to the
.BR MSVSProject ()
Builder,
to be placed into the solution file.
It should be noted that these file names are NOT added to the $SOURCES
environment variable in form of files, but rather as strings.   This
is because they represent file names to be added to the solution file,
not the source files used to build the solution file.

Example Usage:

.ES
env.MSVSSolution(target = 'Bar' + env['MSVSSOLUTIONSUFFIX'],
                 projects = ['bar' + env['MSVSPROJECTSUFFIX']],
                 variant = 'Release')
.EE

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.IP Object()
.IP env.Object()
A synonym for the
.BR StaticObject ()
builder method.

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.IP Package()
.IP env.Package()
Builds software distribution packages.
Packages consist of files to install and packaging information.
The former may be specified with the \fIsource\fP parameter and may be left out,
in which case the &FindInstalledFiles; function will collect
all files that have an \fBInstall\fP() or \fBInstallAs\fP() Builder attached.
If the \fItarget\fP is not specified
it will be deduced from additional information given to this Builder.

The packaging information is specified
with the help of construction variables documented below.
This information is called a tag to stress that
some of them can also be attached to files with the &Tag; function.
The mandatory ones will complain if they were not specified.
They vary depending on chosen target packager.

The target packager may be selected with the "PACKAGETYPE" command line
option or with the \fB$PACKAGETYPE\fP construction variable. Currently
the following packagers available:

 * msi - Microsoft Installer
 * rpm - Redhat Package Manger
 * ipkg - Itsy Package Management System
 * tarbz2 - compressed tar
 * targz - compressed tar
 * zip - zip file
 * src_tarbz2 - compressed tar source
 * src_targz - compressed tar source
 * src_zip - zip file source

An updated list is always available under the "package_type" option when
running "scons --help" on a project that has packaging activated.
.ES
env = Environment(tools=['default', 'packaging'])
env.Install('/bin/', 'my_program')
env.Package( NAME           = 'foo',
             VERSION        = '1.2.3',
             PACKAGEVERSION = 0,
             PACKAGETYPE    = 'rpm',
             LICENSE        = 'gpl',
             SUMMARY        = 'balalalalal',
             DESCRIPTION    = 'this should be really really long',
             X_RPM_GROUP    = 'Application/fu',
             SOURCE_URL     = 'http://foo.org/foo-1.2.3.tar.gz'
        )
.EE

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.IP PCH()
.IP env.PCH()
Builds a Microsoft Visual C++ precompiled header.
Calling this builder method
returns a list of two targets: the PCH as the first element, and the object
file as the second element. Normally the object file is ignored.
This builder method is only
provided when Microsoft Visual C++ is being used as the compiler.
The PCH builder method is generally used in
conjuction with the PCH construction variable to force object files to use
the precompiled header:

.ES
env['PCH'] = env.PCH('StdAfx.cpp')[0]
.EE

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.IP PDF()
.IP env.PDF()
Builds a \fB.pdf\fP file
from a \fB.dvi\fP input file
(or, by extension, a \fB.tex\fP,
.BR .ltx ,
or
\fB.latex\fP input file).
The suffix specified by the \fB$PDFSUFFIX\fP construction variable
(\fB.pdf\fP by default)
is added automatically to the target
if it is not already present.  Example:

.ES
# builds from aaa.tex
env.PDF(target = 'aaa.pdf', source = 'aaa.tex')
# builds bbb.pdf from bbb.dvi
env.PDF(target = 'bbb', source = 'bbb.dvi')
.EE

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.IP POInit()
.IP env.POInit()
This builder belongs to &t-link-msginit; tool. The builder initializes missing
\fBPO\fP file(s) if \fB$POAUTOINIT\fP is set.  If
\fB$POAUTOINIT\fP is not set (default), \fBPOInit\fP() prints instruction for
user (that is supposed to be a translator), telling how the
\fBPO\fP file should be initialized. In normal projects
.IR you should not use \fBPOInit\fP() and use \fBPOUpdate ()
instead\fP. \fBPOUpdate\fP() chooses intelligently between
.BR msgmerge(1)\fP and \fBmsginit(1)\fP. \fBPOInit ()
always uses \fBmsginit(1)\fP and should be regarded as builder for
special purposes or for temporary use (e.g. for quick, one time initialization
of a bunch of \fBPO\fP files) or for tests.

Target nodes defined through \fBPOInit\fP() are not built by default (they're
\fBIgnore\fPd from \fB'.'\fP node) but are added to
special \fBAlias\fP (\fB'po-create'\fP by default).
The alias name may be changed through the \fB$POCREATE_ALIAS\fP
construction variable. All \fBPO\fP files defined through
.BR POInit\fP() may be easily initialized by \fBscons po-create .

.IR Example 1 .
Initialize \fBen.po\fP and \fBpl.po\fP from
.BR messages.pot :
.ES
  # ...
  env.POInit(['en', 'pl']) # messages.pot --> [en.po, pl.po] 
.EE
.IP
.IR Example 2 .
Initialize \fBen.po\fP and \fBpl.po\fP from
.BR foo.pot :
.ES
  # ...
  env.POInit(['en', 'pl'], ['foo']) # foo.pot --> [en.po, pl.po] 
.EE
.IP
.IR Example 3 .
Initialize \fBen.po\fP and \fBpl.po\fP from
\fBfoo.pot\fP but using \fB$POTDOMAIN\fP construction
variable:
.ES
  # ...
  env.POInit(['en', 'pl'], POTDOMAIN='foo') # foo.pot --> [en.po, pl.po] 
.EE
.IP
.IR Example 4 .
Initialize \fBPO\fP files for languages defined in
\fBLINGUAS\fP file. The files will be initialized from template
.BR messages.pot :
.ES
  # ...
  env.POInit(LINGUAS_FILE = 1) # needs 'LINGUAS' file
.EE
.IP
.IR Example 5 .
Initialize \fBen.po\fP and \fBpl.pl\fP
\fBPO\fP files plus files for languages defined in
\fBLINGUAS\fP file. The files will be initialized from template
.BR messages.pot :
.ES
  # ...
  env.POInit(['en', 'pl'], LINGUAS_FILE = 1)
.EE
.IP
.IR Example 6 .
You may preconfigure your environment first, and then initialize
\fBPO\fP files:
.ES
  # ...
  env['POAUTOINIT'] = 1
  env['LINGUAS_FILE'] = 1
  env['POTDOMAIN'] = 'foo'
  env.POInit()
.EE
which has same efect as:
.ES
  # ...
  env.POInit(POAUTOINIT = 1, LINGUAS_FILE = 1, POTDOMAIN = 'foo')
.EE

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.IP PostScript()
.IP env.PostScript()
Builds a \fB.ps\fP file
from a \fB.dvi\fP input file
(or, by extension, a \fB.tex\fP,
.BR .ltx ,
or
\fB.latex\fP input file).
The suffix specified by the \fB$PSSUFFIX\fP construction variable
(\fB.ps\fP by default)
is added automatically to the target
if it is not already present.  Example:

.ES
# builds from aaa.tex
env.PostScript(target = 'aaa.ps', source = 'aaa.tex')
# builds bbb.ps from bbb.dvi
env.PostScript(target = 'bbb', source = 'bbb.dvi')
.EE

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.IP POTUpdate()
.IP env.POTUpdate()
The builder belongs to &t-link-xgettext; tool. The builder updates target
\fBPOT\fP file if exists or creates one if it doesn't. The node is
not built by default (i.e. it is \fBIgnore\fPd from
\fB'.'\fP), but only on demand (i.e.  when given
\fBPOT\fP file is required or when special alias is invoked). This
builder adds its targe node (\fBmessages.pot\fP, say) to a
special alias (\fBpot-update\fP by default, see
\fB$POTUPDATE_ALIAS\fP) so you can update/create them easily with
\fBscons pot-update\fP. The file is not written until there is no
real change in internationalized messages (or in comments that enter
\fBPOT\fP file). 

<note> 
You may see \fBxgettext(1)\fP being invoked by the
&t-link-xgettext; tool even if there is no real change in internationalized
messages (so the \fBPOT\fP file is not being updated).  This
happens every time  a source file has changed. In such case we invoke
\fBxgettext(1)\fP and compare its output with the content of
\fBPOT\fP file to decide whether the file should be updated or
not.</para></note>

.I "Example 1."
Let's create \fBpo/\fP directory and place following
\fBSConstruct\fP script there:
.ES
  # SConstruct in 'po/' subdir
  env = Environment( tools = ['default', 'xgettext'] )
  env.POTUpdate(['foo'], ['../a.cpp', '../b.cpp'])
  env.POTUpdate(['bar'], ['../c.cpp', '../d.cpp'])
.EE
.IP
      
Then invoke scons few times:
.ES
  user@host:$ scons             # Does not create foo.pot nor bar.pot
  user@host:$ scons foo.pot     # Updates or creates foo.pot
  user@host:$ scons pot-update  # Updates or creates foo.pot and bar.pot
  user@host:$ scons -c          # Does not clean foo.pot nor bar.pot.
.EE
the results shall be as the comments above say.

.I "Example 2."
The \fBPOTUpdate\fP() builder may be used with no target specified, in which
case default target \fBmessages.pot\fP will be used. The
default target may also be overriden by setting \fB$POTDOMAIN\fP construction
variable or providing it as an override to \fBPOTUpdate\fP() builder:
.ES    
  # SConstruct script
  env = Environment( tools = ['default', 'xgettext'] )
  env['POTDOMAIN'] = "foo"
  env.POTUpdate(source = ["a.cpp", "b.cpp"]) # Creates foo.pot ...
  env.POTUpdate(POTDOMAIN = "bar", source = ["c.cpp", "d.cpp"]) # and bar.pot
.EE
.IP
.I "Example 3."
The sources may be specified within separate file, for example
.BR POTFILES.in :
.ES      
  # POTFILES.in in 'po/' subdirectory
  ../a.cpp
  ../b.cpp
  # end of file
.EE
.IP
    
The name of the file (\fBPOTFILES.in\fP) containing the list of
sources is provided via \fB$XGETTEXTFROM\fP:
.ES      
  # SConstruct file in 'po/' subdirectory
  env = Environment( tools = ['default', 'xgettext'] )
  env.POTUpdate(XGETTEXTFROM = 'POTFILES.in')
.EE
.IP
    

.I "Example 4."
You may use \fB$XGETTEXTPATH\fP to define source search path. Assume, for
example, that you have files \fBa.cpp\fP,
.BR b.cpp\fP, \fBpo/SConstruct ,
.BR po/POTFILES.in\fP. Then your \fBPOT -related
files could look as below:
.ES
  # POTFILES.in in 'po/' subdirectory
  a.cpp
  b.cpp
  # end of file
.EE

.ES
  # SConstruct file in 'po/' subdirectory
  env = Environment( tools = ['default', 'xgettext'] )
  env.POTUpdate(XGETTEXTFROM = 'POTFILES.in', XGETTEXTPATH='../')
.EE
.IP
.I "Example 5."
Multiple search directories may be defined within a list, i.e.
\fBXGETTEXTPATH = ['dir1', 'dir2', ...]\fP. The order in the list
determines the search order of source files. The path to the first file found
is used.

Let's create \fB0/1/po/SConstruct\fP script:
.ES
  # SConstruct file in '0/1/po/' subdirectory
  env = Environment( tools = ['default', 'xgettext'] )
  env.POTUpdate(XGETTEXTFROM = 'POTFILES.in', XGETTEXTPATH=['../', '../../'])
.EE
and \fB0/1/po/POTFILES.in\fP:
.ES
  # POTFILES.in in '0/1/po/' subdirectory
  a.cpp
  # end of file
.EE
Write two \fB*.cpp\fP files, the first one is
.BR 0/a.cpp :
.ES
  /* 0/a.cpp */
  gettext("Hello from ../../a.cpp")
.EE
and the second is \fB0/1/a.cpp\fP:
.ES
  /* 0/1/a.cpp */
  gettext("Hello from ../a.cpp")
.EE
then run scons. You'll obtain \fB0/1/po/messages.pot\fP with the
message \fB"Hello from ../a.cpp"\fP. When you reverse order in
\fI$XGETTEXTFOM\fP, i.e. when you write SConscript as
.ES
  # SConstruct file in '0/1/po/' subdirectory
  env = Environment( tools = ['default', 'xgettext'] )
  env.POTUpdate(XGETTEXTFROM = 'POTFILES.in', XGETTEXTPATH=['../../', '../'])
.EE
.IP
 then the \fBmessages.pot\fP will contain
\fBmsgid "Hello from ../../a.cpp"\fP line and not 
.BR msgid "Hello from ../a.cpp" .


'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.IP POUpdate()
.IP env.POUpdate()
The builder belongs to &t-link-msgmerge; tool. The builder updates
\fBPO\fP files with \fBmsgmerge(1)\fP, or initializes
missing \fBPO\fP files as described in documentation of
&t-link-msginit; tool and \fBPOInit\fP() builder (see also
\fB$POAUTOINIT\fP). Note, that \fBPOUpdate\fP() \fIdoes not add its
targets to \fBpo-create\fP alias\fP as \fBPOInit\fP()
does.

Target nodes defined through \fBPOUpdate\fP() are not built by default
(they're \fBIgnore\fPd from \fB'.'\fP node). Instead,
they are added automatically to special \fBAlias\fP 
(\fB'po-update'\fP by default). The alias name may be changed
through the \fB$POUPDATE_ALIAS\fP construction variable.  You can easilly 
update \fBPO\fP files in your project by \fBscons
po-update\fP.

.I "Example 1."
Update \fBen.po\fP and \fBpl.po\fP from
.BR messages.pot\fP template (see also \fB$POTDOMAIN ),
assuming that the later one exists or there is rule to build it (see
.BR POTUpdate ()):
.ES
  # ...
  env.POUpdate(['en','pl']) # messages.pot --> [en.po, pl.po]
.EE
.IP
.I "Example 2."
Update \fBen.po\fP and \fBpl.po\fP from
\fBfoo.pot\fP template:
.ES
  # ...
  env.POUpdate(['en', 'pl'], ['foo']) # foo.pot -->  [en.po, pl.pl]
.EE
.IP
.I "Example 3."
Update \fBen.po\fP and \fBpl.po\fP from
\fBfoo.pot\fP (another version):
.ES
  # ...
  env.POUpdate(['en', 'pl'], POTDOMAIN='foo') # foo.pot -- > [en.po, pl.pl]
.EE
.IP
.I "Example 4."
Update files for languages defined in \fBLINGUAS\fP file. The
files are updated from \fBmessages.pot\fP template:
.ES
  # ...
  env.POUpdate(LINGUAS_FILE = 1) # needs 'LINGUAS' file
.EE
.IP
.I "Example 5."
Same as above, but update from \fBfoo.pot\fP template:
.ES
  # ...
  env.POUpdate(LINGUAS_FILE = 1, source = ['foo'])
.EE
.IP
.I "Example 6."
Update \fBen.po\fP and \fBpl.po\fP plus files for
languages defined in \fBLINGUAS\fP file. The files are updated
from \fBmessages.pot\fP template:
.ES
  # produce 'en.po', 'pl.po' + files defined in 'LINGUAS':
  env.POUpdate(['en', 'pl' ], LINGUAS_FILE = 1) 
.EE
.IP
.I "Example 7."
Use \fB$POAUTOINIT\fP to automatically initialize \fBPO\fP file
if it doesn't exist:
.ES
  # ...
  env.POUpdate(LINGUAS_FILE = 1, POAUTOINIT = 1)
.EE
.IP
.I "Example 8."
Update \fBPO\fP files for languages defined in
\fBLINGUAS\fP file. The files are updated from
\fBfoo.pot\fP template. All necessary settings are
pre-configured via environment.
.ES
  # ...
  env['POAUTOINIT'] = 1
  env['LINGUAS_FILE'] = 1
  env['POTDOMAIN'] = 'foo'
  env.POUpdate()
.EE

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.IP Program()
.IP env.Program()
Builds an executable given one or more object files
or C, C++, D, or Fortran source files.
If any C, C++, D or Fortran source files are specified,
then they will be automatically
compiled to object files using the
.BR Object ()
builder method;
see that builder method's description for
a list of legal source file suffixes
and how they are interpreted.
The target executable file prefix
(specified by the \fB$PROGPREFIX\fP construction variable; nothing by default)
and suffix
(specified by the \fB$PROGSUFFIX\fP construction variable;
by default, \fB.exe\fP on Windows systems,
nothing on POSIX systems)
are automatically added to the target if not already present.
Example:

.ES
env.Program(target = 'foo', source = ['foo.o', 'bar.c', 'baz.f'])
.EE

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.IP RES()
.IP env.RES()
Builds a Microsoft Visual C++ resource file.
This builder method is only provided
when Microsoft Visual C++ or MinGW is being used as the compiler. The
.B .res
(or
.B .o
for MinGW) suffix is added to the target name if no other suffix is given.
The source
file is scanned for implicit dependencies as though it were a C file.
Example:

.ES
env.RES('resource.rc')
.EE

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.IP RMIC()
.IP env.RMIC()
Builds stub and skeleton class files
for remote objects
from Java \fB.class\fP files.
The target is a directory
relative to which the stub
and skeleton class files will be written.
The source can be the names of \fB.class\fP files,
or the objects return from the
.BR Java ()
builder method.

If the construction variable
.B $JAVACLASSDIR
is set, either in the environment
or in the call to the
.BR RMIC ()
builder method itself,
then the value of the variable
will be stripped from the
beginning of any \fB.class \fP
file names.

.ES
classes = env.Java(target = 'classdir', source = 'src')
env.RMIC(target = 'outdir1', source = classes)

env.RMIC(target = 'outdir2',
         source = ['package/foo.class', 'package/bar.class'])

env.RMIC(target = 'outdir3',
         source = ['classes/foo.class', 'classes/bar.class'],
         JAVACLASSDIR = 'classes')
.EE

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.IP RPCGenClient()
.IP env.RPCGenClient()
Generates an RPC client stub (\fB_clnt.c\fP) file
from a specified RPC (\fB.x\fP) source file.
Because rpcgen only builds output files
in the local directory,
the command will be executed
in the source file's directory by default.

.ES
# Builds src/rpcif_clnt.c
env.RPCGenClient('src/rpcif.x')
.EE

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.IP RPCGenHeader()
.IP env.RPCGenHeader()
Generates an RPC header (\fB.h\fP) file
from a specified RPC (\fB.x\fP) source file.
Because rpcgen only builds output files
in the local directory,
the command will be executed
in the source file's directory by default.

.ES
# Builds src/rpcif.h
env.RPCGenHeader('src/rpcif.x')
.EE

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.IP RPCGenService()
.IP env.RPCGenService()
Generates an RPC server-skeleton (\fB_svc.c\fP) file
from a specified RPC (\fB.x\fP) source file.
Because rpcgen only builds output files
in the local directory,
the command will be executed
in the source file's directory by default.

.ES
# Builds src/rpcif_svc.c
env.RPCGenClient('src/rpcif.x')
.EE

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.IP RPCGenXDR()
.IP env.RPCGenXDR()
Generates an RPC XDR routine (\fB_xdr.c\fP) file
from a specified RPC (\fB.x\fP) source file.
Because rpcgen only builds output files
in the local directory,
the command will be executed
in the source file's directory by default.

.ES
# Builds src/rpcif_xdr.c
env.RPCGenClient('src/rpcif.x')
.EE

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.IP SharedLibrary()
.IP env.SharedLibrary()
Builds a shared library
(\fB.so\fP on a POSIX system,
\fB.dll\fP on Windows)
given one or more object files
or C, C++, D or Fortran source files.
If any source files are given,
then they will be automatically
compiled to object files.
The static library prefix and suffix (if any)
are automatically added to the target.
The target library file prefix
(specified by the \fB$SHLIBPREFIX\fP construction variable;
by default, \fBlib\fP on POSIX systems,
nothing on Windows systems)
and suffix
(specified by the \fB$SHLIBSUFFIX\fP construction variable;
by default, \fB.dll\fP on Windows systems,
\fB.so\fP on POSIX systems)
are automatically added to the target if not already present.
Example:

.ES
env.SharedLibrary(target = 'bar', source = ['bar.c', 'foo.o'])
.EE
.IP
On Windows systems, the
.BR SharedLibrary ()
builder method will always build an import
(\fB.lib\fP) library
in addition to the shared (\fB.dll\fP) library,
adding a \fB.lib\fP library with the same basename
if there is not already a \fB.lib\fP file explicitly
listed in the targets.

Any object files listed in the
.B source
must have been built for a shared library
(that is, using the
.BR SharedObject ()
builder method).
.B scons
will raise an error if there is any mismatch.

On some platforms, there is a distinction between a shared library
(loaded automatically by the system to resolve external references)
and a loadable module (explicitly loaded by user action).
For maximum portability, use the \fBLoadableModule\fP() builder for the latter.

When the \fB$SHLIBVERSION\fP construction variable is defined a versioned
shared library is created. This modifies the \fB$SHLINKFLAGS\fP as required,
adds the version number to the library name, and creates the symlinks that
are needed. \fB$SHLIBVERSION\fP needs to be of the form X.Y.Z, where X
and Y are numbers, and Z is a number but can also contain letters to designate
alpha, beta, or release candidate patch levels.

This builder may create multiple links to the library. On a POSIX system,
for the shared library libbar.so.2.3.1, the links created would be
libbar.so, libbar.so.2, and libbar.so.2.3; on a Darwin (OSX) system
the library would be libbar.2.3.1.dylib and the link would be
libbar.dylib.

On Windows systems, specifying
.B register=1
will cause the \fB.dll\fP to be
registered after it is built using REGSVR32.
The command that is run
("regsvr32" by default) is determined by \fB$REGSVR\fP construction
variable, and the flags passed are determined by \fB$REGSVRFLAGS\fP.  By
default, \fB$REGSVRFLAGS\fP includes the \fB/s\fP option,
to prevent dialogs from popping
up and requiring user attention when it is run.  If you change
\fB$REGSVRFLAGS\fP, be sure to include the \fB/s\fP option.
For example,

.ES
env.SharedLibrary(target = 'bar',
                  source = ['bar.cxx', 'foo.obj'],
                  register=1)
.EE
.IP
will register \fBbar.dll\fP as a COM object
when it is done linking it.

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.IP SharedObject()
.IP env.SharedObject()
Builds an object file for
inclusion in a shared library.
Source files must have one of the same set of extensions
specified above for the
.BR StaticObject ()
builder method.
On some platforms building a shared object requires additional
compiler option
(e.g. \fB\-fPIC\fP for gcc)
in addition to those needed to build a
normal (static) object, but on some platforms there is no difference between a
shared object and a normal (static) one. When there is a difference, SCons
will only allow shared objects to be linked into a shared library, and will
use a different suffix for shared objects. On platforms where there is no
difference, SCons will allow both normal (static)
and shared objects to be linked into a
shared library, and will use the same suffix for shared and normal
(static) objects.
The target object file prefix
(specified by the \fB$SHOBJPREFIX\fP construction variable;
by default, the same as \fB$OBJPREFIX\fP)
and suffix
(specified by the \fB$SHOBJSUFFIX\fP construction variable)
are automatically added to the target if not already present.
Examples:

.ES
env.SharedObject(target = 'ddd', source = 'ddd.c')
env.SharedObject(target = 'eee.o', source = 'eee.cpp')
env.SharedObject(target = 'fff.obj', source = 'fff.for')
.EE
.IP
Note that the source files will be scanned
according to the suffix mappings in the
.B SourceFileScanner
object.
See the section "Scanner Objects,"
below, for more information.

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.IP StaticLibrary()
.IP env.StaticLibrary()
Builds a static library given one or more object files
or C, C++, D or Fortran source files.
If any source files are given,
then they will be automatically
compiled to object files.
The static library prefix and suffix (if any)
are automatically added to the target.
The target library file prefix
(specified by the \fB$LIBPREFIX\fP construction variable;
by default, \fBlib\fP on POSIX systems,
nothing on Windows systems)
and suffix
(specified by the \fB$LIBSUFFIX\fP construction variable;
by default, \fB.lib\fP on Windows systems,
\fB.a\fP on POSIX systems)
are automatically added to the target if not already present.
Example:

.ES
env.StaticLibrary(target = 'bar', source = ['bar.c', 'foo.o'])
.EE
.IP
Any object files listed in the
.B source
must have been built for a static library
(that is, using the
.BR StaticObject ()
builder method).
.B scons
will raise an error if there is any mismatch.

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.IP StaticObject()
.IP env.StaticObject()
Builds a static object file
from one or more C, C++, D, or Fortran source files.
Source files must have one of the following extensions:

.ES
  .asm    assembly language file
  .ASM    assembly language file
  .c      C file
  .C      Windows:  C file
          POSIX:  C++ file
  .cc     C++ file
  .cpp    C++ file
  .cxx    C++ file
  .cxx    C++ file
  .c++    C++ file
  .C++    C++ file
  .d      D file
  .f      Fortran file
  .F      Windows:  Fortran file
          POSIX:  Fortran file + C pre-processor
  .for    Fortran file
  .FOR    Fortran file
  .fpp    Fortran file + C pre-processor
  .FPP    Fortran file + C pre-processor
  .m      Object C file
  .mm     Object C++ file
  .s      assembly language file
  .S      Windows:  assembly language file
          ARM: CodeSourcery Sourcery Lite
  .sx     assembly language file + C pre-processor
          POSIX:  assembly language file + C pre-processor
  .spp    assembly language file + C pre-processor
  .SPP    assembly language file + C pre-processor
.EE
.IP
The target object file prefix
(specified by the \fB$OBJPREFIX\fP construction variable; nothing by default)
and suffix
(specified by the \fB$OBJSUFFIX\fP construction variable;
\fB.obj\fP on Windows systems,
\fB.o\fP on POSIX systems)
are automatically added to the target if not already present.
Examples:

.ES
env.StaticObject(target = 'aaa', source = 'aaa.c')
env.StaticObject(target = 'bbb.o', source = 'bbb.c++')
env.StaticObject(target = 'ccc.obj', source = 'ccc.f')
.EE
.IP
Note that the source files will be scanned
according to the suffix mappings in
.B SourceFileScanner
object.
See the section "Scanner Objects,"
below, for more information.

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.IP Substfile()
.IP env.Substfile()
The \fBSubstfile\fP() builder generates a single text file
by concatenating the source files.
Nested lists of sources are flattened. 
\fB$LINESEPARATOR\fP is used to separate the source files;
see the description of \fBTextfile\fP() for details.

If a single source file is present with an \fB.in\fP suffix,
the suffix is stripped and the remainder is used as the default target name.

The prefix and suffix specified by the \fB$SUBSTFILEPREFIX\fP
and \fB$SUBSTFILESUFFIX\fP construction variables
(the null string by default in both cases)
are automatically added to the target if they are not already present.

If a construction variable named \fB$SUBST_DICT\fP is present,
it may be either a Python dictionary or a sequence of (key,value) tuples.
If the former,
the dictionary is converted into a list of tuples in an arbitrary order,
so if one key is a prefix of another key
or if one substitution could be further expanded by another subsitition,
it is unpredictible whether the expansion will occur.

Any occurences in the source of a key
are replaced by the corresponding value,
which may be a Python callable function or a string.
If a value is a function,
it is first called (with no arguments) to produce a string.
The string is \fIsubst\fP-expanded
and the result replaces the key.

.ES
env = Environment(tools = ['default', 'textfile'])

env['prefix'] = '/usr/bin'
script_dict = {'@prefix@': '/bin', @exec_prefix@: '$prefix'}
env.Substfile('script.in', SUBST_DICT = script_dict)

conf_dict = {'%VERSION%': '1.2.3', '%BASE%': 'MyProg'}
env.Substfile('config.h.in', conf_dict, SUBST_DICT = conf_dict)

# UNPREDICTABLE - one key is a prefix of another
bad_foo = {'$foo': '$foo', '$foobar': '$foobar'}
env.Substfile('foo.in', SUBST_DICT = bad_foo)

# PREDICTABLE - keys are applied longest first
good_foo = [('$foobar', '$foobar'), ('$foo', '$foo')]
env.Substfile('foo.in', SUBST_DICT = good_foo)

# UNPREDICTABLE - one substitution could be futher expanded
bad_bar = {'@bar@': '@soap@', '@soap@': 'lye'}
env.Substfile('bar.in', SUBST_DICT = bad_bar)

# PREDICTABLE - substitutions are expanded in order
good_bar = (('@bar@', '@soap@'), ('@soap@', 'lye'))
env.Substfile('bar.in', SUBST_DICT = good_bar)

# the SUBST_DICT may be in common (and not an override)
substutions = {}
subst = Environment(tools = ['textfile'], SUBST_DICT = substitutions)
substitutions['@foo@'] = 'foo'
subst['SUBST_DICT']['@bar@'] = 'bar'
subst.Substfile('pgm1.c', [Value('#include "@foo@.h"'),
                           Value('#include "@bar@.h"'),
                           "common.in",
                           "pgm1.in"
                          ])
subst.Substfile('pgm2.c', [Value('#include "@foo@.h"'),
                           Value('#include "@bar@.h"'),
                           "common.in",
                           "pgm2.in"
                          ])

.EE

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.IP Tar()
.IP env.Tar()
Builds a tar archive of the specified files
and/or directories.
Unlike most builder methods,
the
.BR Tar ()
builder method may be called multiple times
for a given target;
each additional call
adds to the list of entries
that will be built into the archive.
Any source directories will
be scanned for changes to
any on-disk files,
regardless of whether or not
.B scons
knows about them from other Builder or function calls.

.ES
env.Tar('src.tar', 'src')

# Create the stuff.tar file.
env.Tar('stuff', ['subdir1', 'subdir2'])
# Also add "another" to the stuff.tar file.
env.Tar('stuff', 'another')

# Set TARFLAGS to create a gzip-filtered archive.
env = Environment(TARFLAGS = '-c -z')
env.Tar('foo.tar.gz', 'foo')

# Also set the suffix to .tgz.
env = Environment(TARFLAGS = '-c -z',
                  TARSUFFIX = '.tgz')
env.Tar('foo')
.EE

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.IP Textfile()
.IP env.Textfile()
The \fBTextfile\fP() builder generates a single text file.
The source strings constitute the lines;
nested lists of sources are flattened. 
\fB$LINESEPARATOR\fP is used to separate the strings.

If present, the \fB$SUBST_DICT\fP construction variable
is used to modify the strings before they are written;
see the \fBSubstfile\fP() description for details.

The prefix and suffix specified by the \fB$TEXTFILEPREFIX\fP
and \fB$TEXTFILESUFFIX\fP construction variables
(the null string and \fB.txt\fP by default, respectively)
are automatically added to the target if they are not already present.
Examples:

.ES
# builds/writes foo.txt
env.Textfile(target = 'foo.txt', source = ['Goethe', 42, 'Schiller'])

# builds/writes bar.txt
env.Textfile(target = 'bar',
             source = ['lalala', 'tanteratei'],
             LINESEPARATOR='|*')

# nested lists are flattened automatically
env.Textfile(target = 'blob', 
             source = ['lalala', ['Goethe', 42 'Schiller'], 'tanteratei'])

# files may be used as input by wraping them in File()
env.Textfile(target = 'concat',  # concatenate files with a marker between
             source = [File('concat1'), File('concat2')],
             LINESEPARATOR = '====================\\n')

Results are:
foo.txt
  ....8<----
  Goethe
  42
  Schiller
  ....8<---- (no linefeed at the end)

bar.txt:
  ....8<----
  lalala|*tanteratei
  ....8<---- (no linefeed at the end)

blob.txt
  ....8<----
  lalala
  Goethe
  42
  Schiller
  tanteratei
  ....8<---- (no linefeed at the end)
.EE

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.IP Translate()
.IP env.Translate()
This pseudo-builder belongs to &t-link-gettext; toolset. The builder extracts
internationalized messages from source files, updates \fBPOT\fP
template (if necessary) and then updates \fBPO\fP translations (if
necessary). If \fB$POAUTOINIT\fP is set, missing \fBPO\fP files
will be automatically created (i.e. without translator person intervention).
The variables \fB$LINGUAS_FILE\fP and \fB$POTDOMAIN\fP are taken into
acount too. All other construction variables used by \fBPOTUpdate\fP(), and
\fBPOUpdate\fP() work here too.

.IR Example 1 .
The simplest way is to specify input files and output languages inline in
a SCons script when invoking \fBTranslate\fP()
.ES
# SConscript in 'po/' directory
env = Environment( tools = ["default", "gettext"] )
env['POAUTOINIT'] = 1
env.Translate(['en','pl'], ['../a.cpp','../b.cpp']) 
.EE
.IP
.IR Example 2 .
If you wish, you may also stick to conventional style known from
<productname>autotools</productname>, i.e. using
\fBPOTFILES.in\fP and \fBLINGUAS\fP files
.ES
# LINGUAS
en pl 
#end
.EE

.ES
# POTFILES.in
a.cpp
b.cpp
# end
.EE

.ES
# SConscript
env = Environment( tools = ["default", "gettext"] )
env['POAUTOINIT'] = 1
env['XGETTEXTPATH'] = ['../']
env.Translate(LINGUAS_FILE = 1, XGETTEXTFROM = 'POTFILES.in') 
.EE
.IP
The last approach is perhaps the recommended one. It allows easily split
internationalization/localization onto separate SCons scripts, where a script
in source tree is responsible for translations (from sources to
\fBPO\fP files) and script(s) under variant directories are
responsible for compilation of \fBPO\fP to \fBMO\fP
files to and for installation of \fBMO\fP files. The "gluing
factor" synchronizing these two scripts is then the content of
\fBLINGUAS\fP file.  Note, that the updated
\fBPOT\fP and \fBPO\fP files are usually going to be
committed back to the repository, so they must be updated within the source
directory (and not in variant directories). Additionaly, the file listing of
\fBpo/\fP directory contains \fBLINGUAS\fP file,
so the source tree looks familiar to translators, and they may work with the
project in their usual way.

.IR Example 3 .
Let's prepare a development tree as below
.ES
 project/
  + SConstruct
  + build/        
  + src/
      + po/
          + SConscript
          + SConscript.i18n
          + POTFILES.in
          + LINGUAS
.EE
with \fBbuild\fP being variant directory. Write the top-level
\fBSConstruct\fP script as follows
.ES
  # SConstruct
  env = Environment( tools = ["default", "gettext"] )
  VariantDir('build', 'src', duplicate = 0)
  env['POAUTOINIT'] = 1
  SConscript('src/po/SConscript.i18n', exports = 'env')
  SConscript('build/po/SConscript', exports = 'env')
.EE
the \fBsrc/po/SConscript.i18n\fP as
.ES
  # src/po/SConscript.i18n
  Import('env')
  env.Translate(LINGUAS_FILE=1, XGETTEXTFROM='POTFILES.in', XGETTEXTPATH=['../'])
.EE
and the \fBsrc/po/SConscript\fP
.ES
  # src/po/SConscript
  Import('env')
  env.MOFiles(LINGUAS_FILE = 1)
.EE
Such setup produces \fBPOT\fP and \fBPO\fP files
under source tree in \fBsrc/po/\fP and binary
\fBMO\fP files under variant tree in
\fBbuild/po/\fP. This way the \fBPOT\fP and
\fBPO\fP files are separated from other output files, which must
not be committed back to source repositories (e.g. \fBMO\fP
files).

<note>
In above example, the \fBPO\fP files are not updated,
nor created automatically when you issue \fBscons '.'\fP command.
The files must be updated (created) by hand via \fBscons
po-update\fP and then \fBMO\fP files can be compiled by
running \fBscons '.'\fP.</para></note>


'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.IP TypeLibrary()
.IP env.TypeLibrary()
Builds a Windows type library (\fB.tlb\fP)
file from an input IDL file (\fB.idl\fP).
In addition, it will build the associated inteface stub and
proxy source files,
naming them according to the base name of the \fB.idl\fP file.
For example,

.ES
env.TypeLibrary(source="foo.idl")
.EE
.IP
Will create \fBfoo.tlb\fP,
.BR foo.h ,
.BR foo_i.c ,
.B foo_p.c
and
.B foo_data.c
files.

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.IP Uic()
.IP env.Uic()
Builds a header file, an implementation file and a moc file from an ui file.
and returns the corresponding nodes in the above order.
This builder is only available after using the tool 'qt'. Note: you can
specify \fB.ui\fP files directly as source
files to the \fBProgram\fP(),
\fBLibrary\fP() and \fBSharedLibrary\fP() builders
without using this builder. Using this builder lets you override the standard
naming conventions (be careful: prefixes are always prepended to names of
built files; if you don't want prefixes, you may set them to ``).
See the \fB$QTDIR\fP variable for more information.
Example:

.ES
env.Uic('foo.ui') # -> ['foo.h', 'uic_foo.cc', 'moc_foo.cc']
env.Uic(target = Split('include/foo.h gen/uicfoo.cc gen/mocfoo.cc'),
        source = 'foo.ui') # -> ['include/foo.h', 'gen/uicfoo.cc', 'gen/mocfoo.cc']
.EE

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.IP Zip()
.IP env.Zip()
Builds a zip archive of the specified files
and/or directories.
Unlike most builder methods,
the
.BR Zip ()
builder method may be called multiple times
for a given target;
each additional call
adds to the list of entries
that will be built into the archive.
Any source directories will
be scanned for changes to
any on-disk files,
regardless of whether or not
.B scons
knows about them from other Builder or function calls.

.ES
env.Zip('src.zip', 'src')

# Create the stuff.zip file.
env.Zip('stuff', ['subdir1', 'subdir2'])
# Also add "another" to the stuff.tar file.
env.Zip('stuff', 'another')
.EE
'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
'\" END GENERATED BUILDER DESCRIPTIONS
'\"
'\" The descriptions above of the various SCons Builders are generated
'\" from the .xml files that live next to the various Python modules in
'\" the build enginer library.  If you're reading this [gnt]roff file
'\" with an eye towards patching this man page, you can still submit
'\" a diff against this text, but it will have to be translated to a
'\" diff against the underlying .xml file before the patch is actually
'\" accepted.  If you do that yourself, it will make it easier to
'\" integrate the patch.
'\"
'\" END GENERATED BUILDER DESCRIPTIONS
'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""

.P
All
targets of builder methods automatically depend on their sources.
An explicit dependency can
be specified using the
.B Depends
method of a construction environment (see below).

In addition,
.B scons
automatically scans
source files for various programming languages,
so the dependencies do not need to be specified explicitly.
By default, SCons can
C source files,
C++ source files,
Fortran source files with
.B .F
(POSIX systems only),
.B .fpp,
or
.B .FPP
file extensions,
and assembly language files with
.B .S
(POSIX systems only),
.B .spp,
or
.B .SPP
files extensions
for C preprocessor dependencies.
SCons also has default support
for scanning D source files,
You can also write your own Scanners
to add support for additional source file types.
These can be added to the default
Scanner object used by the
.BR Object (),
.BR StaticObject (),
and
.BR SharedObject ()
Builders by adding them
to the
.B SourceFileScanner
object.
See the section "Scanner Objects"
below, for more information about
defining your own Scanner objects
and using the
.B SourceFileScanner
object.

.SS Methods and Functions to Do Things
In addition to Builder methods,
.B scons
provides a number of other construction environment methods
and global functions to
manipulate the build configuration.

Usually, a construction environment method
and global function with the same name both exist
so that you don't have to remember whether
to a specific bit of functionality
must be called with or without a construction environment.
In the following list,
if you call something as a global function
it looks like:
.ES
.RI Function( arguments )
.EE
and if you call something through a construction
environment it looks like:
.ES
.RI env.Function( arguments )
.EE
If you can call the functionality in both ways,
then both forms are listed.

Global functions may be called from custom Python modules that you
import into an SConscript file by adding the following
to the Python module:

.ES
from SCons.Script import *
.EE

Except where otherwise noted,
the same-named
construction environment method
and global function
provide the exact same functionality.
The only difference is that,
where appropriate,
calling the functionality through a construction environment will
substitute construction variables into
any supplied strings.
For example:

.ES
env = Environment(FOO = 'foo')
Default('$FOO')
env.Default('$FOO')
.EE

In the above example,
the first call to the global
.B Default()
function will actually add a target named
.B $FOO
to the list of default targets,
while the second call to the
.B env.Default()
construction environment method
will expand the value
and add a target named
.B foo
to the list of default targets.
For more on construction variable expansion,
see the next section on
construction variables.

Construction environment methods
and global functions supported by
.B scons
include:

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
'\" BEGIN GENERATED FUNCTION DESCRIPTIONS
'\"
'\" The descriptions below of the various SCons functions are generated
'\" from the .xml files that live next to the various Python modules in
'\" the build enginer library.  If you're reading this [gnt]roff file
'\" with an eye towards patching this man page, you can still submit
'\" a diff against this text, but it will have to be translated to a
'\" diff against the underlying .xml file before the patch is actually
'\" accepted.  If you do that yourself, it will make it easier to
'\" integrate the patch.
'\"
'\" BEGIN GENERATED FUNCTION DESCRIPTIONS
'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.TP
.RI Action( action ", [" cmd/str/fun ", [" var ", ...]] [option=" value ", ...])"
.TP
.IR env .Action( action ", [" cmd/str/fun ", [" var ", ...]] [option=" value ", ...])"
Creates an Action object for
the specified
.IR action .
See the section "Action Objects,"
below, for a complete explanation of the arguments and behavior.

Note that the
.BR env.Action ()
form of the invocation will expand
construction variables in any argument strings,
including the
.I action
argument, at the time it is called
using the construction variables in the
.I env
construction environment through which
.BR env.Action ()
was called.
The
.BR Action ()
form delays all variable expansion
until the Action object is actually used.

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.TP
.RI AddMethod( object ", " function ", [" name ])
.TP
.IR env .AddMethod( function ", [" name ])
When called with the
.BR AddMethod ()
form,
adds the specified
.I function
to the specified
.I object
as the specified method
.IR name .
When called with the
.BR env.AddMethod ()
form,
adds the specified
.I function
to the construction environment
.I env
as the specified method
.IR name .
In both cases, if
.I name
is omitted or
.BR None ,
the name of the
specified
.I function
itself is used for the method name.

Examples:

.ES
# Note that the first argument to the function to
# be attached as a method must be the object through
# which the method will be called; the Python
# convention is to call it 'self'.
def my_method(self, arg):
    print "my_method() got", arg

# Use the global AddMethod() function to add a method
# to the Environment class.  This
AddMethod(Environment, my_method)
env = Environment()
env.my_method('arg')

# Add the function as a method, using the function
# name for the method call.
env = Environment()
env.AddMethod(my_method, 'other_method_name')
env.other_method_name('another arg')
.EE

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.TP
.RI AddOption( arguments )
This function adds a new command-line option to be recognized.
The specified
.I arguments
are the same as supported by the standard Python
.BR optparse.add_option ()
method (with a few additional capabilities noted below);
see the documentation for
.B optparse
for a thorough discussion of its option-processing capabities.

In addition to the arguments and values supported by the
.BR optparse.add_option ()
method,
the SCons
.BR AddOption ()
function allows you to set the
.B nargs
keyword value to
.B '?'
(a string with just the question mark)
to indicate that the specified long option(s) take(s) an
.I optional
argument.
When
.B "nargs = '?'"
is passed to the
.BR AddOption ()
function, the
.B const
keyword argument
may be used to supply the "default"
value that should be used when the
option is specified on the command line
without an explicit argument.

If no
.B default=
keyword argument is supplied when calling
.BR AddOption (),
the option will have a default value of
.BR None .

Once a new command-line option has been added with
.BR AddOption (),
the option value may be accessed using
.BR GetOption ()
or
.BR env.GetOption ().
The value may also be set, using
.BR SetOption ()
or
.BR env.SetOption (),
if conditions in a
.B SConscript
require overriding any default value.
Note, however, that a
value specified on the command line will
.I always
override a value set by any SConscript file.

Any specified
.B help=
strings for the new option(s)
will be displayed by the
.B \-H
or
.B \-h
options
(the latter only if no other help text is
specified in the SConscript files).
The help text for the local options specified by
.BR AddOption ()
will appear below the SCons options themselves,
under a separate
.B "Local Options"
heading.
The options will appear in the help text
in the order in which the
.BR AddOption ()
calls occur.

Example:

.ES
AddOption('--prefix',
          dest='prefix',
          nargs=1, type='string',
          action='store',
          metavar='DIR',
          help='installation prefix')
env = Environment(PREFIX = GetOption('prefix'))
.EE

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.TP
.RI AddPostAction( target ", " action )
.TP
.IR env .AddPostAction( target ", " action )
Arranges for the specified
.I action
to be performed
after the specified
.I target
has been built.
The specified action(s) may be
an Action object, or anything that
can be converted into an Action object
(see below).

When multiple targets are supplied,
the action may be called multiple times,
once after each action that generates
one or more targets in the list.

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.TP
.RI AddPreAction( target ", " action )
.TP
.IR env .AddPreAction( target ", " action )
Arranges for the specified
.I action
to be performed
before the specified
.I target
is built.
The specified action(s) may be
an Action object, or anything that
can be converted into an Action object
(see below).

When multiple targets are specified,
the action(s) may be called multiple times,
once before each action that generates
one or more targets in the list.

Note that if any of the targets are built in multiple steps,
the action will be invoked just
before the "final" action that specifically
generates the specified target(s).
For example, when building an executable program
from a specified source
.B .c
file via an intermediate object file:

.ES
foo = Program('foo.c')
AddPreAction(foo, 'pre_action')
.EE
.IP
The specified
.B pre_action
would be executed before
.B scons
calls the link command that actually
generates the executable program binary
.BR foo ,
not before compiling the
.B foo.c
file into an object file.

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.TP
.RI Alias( alias ", [" targets ", [" action ]])
.TP
.IR env .Alias( alias ", [" targets ", [" action ]])
Creates one or more phony targets that
expand to one or more other targets.
An optional
.I action
(command)
or list of actions
can be specified that will be executed
whenever the any of the alias targets are out-of-date.
Returns the Node object representing the alias,
which exists outside of any file system.
This Node object, or the alias name,
may be used as a dependency of any other target,
including another alias.
.BR Alias ()
can be called multiple times for the same
alias to add additional targets to the alias,
or additional actions to the list for this alias.

Examples:

.ES
Alias('install')
Alias('install', '/usr/bin')
Alias(['install', 'install-lib'], '/usr/local/lib')

env.Alias('install', ['/usr/local/bin', '/usr/local/lib'])
env.Alias('install', ['/usr/local/man'])

env.Alias('update', ['file1', 'file2'], "update_database $SOURCES")
.EE

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.TP
.RI AllowSubstExceptions([ exception ", ...])"
Specifies the exceptions that will be allowed
when expanding construction variables.
By default,
any construction variable expansions that generate a
.B NameError
or
.B IndexError
exception will expand to a
.B ''
(a null string) and not cause scons to fail.
All exceptions not in the specified list
will generate an error message
and terminate processing.

If
.BR AllowSubstExceptions ()
is called multiple times,
each call completely overwrites the previous list
of allowed exceptions.

Example:

.ES
# Requires that all construction variable names exist.
# (You may wish to do this if you want to enforce strictly
# that all construction variables must be defined before use.)
AllowSubstExceptions()

# Also allow a string containing a zero-division expansion
# like '${1 / 0}' to evalute to ''.
AllowSubstExceptions(IndexError, NameError, ZeroDivisionError)
.EE

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.TP
.RI AlwaysBuild( target ", ...)"
.TP
.IR env .AlwaysBuild( target ", ...)"
Marks each given
.I target
so that it is always assumed to be out of date,
and will always be rebuilt if needed.
Note, however, that
.BR AlwaysBuild ()
does not add its target(s) to the default target list,
so the targets will only be built
if they are specified on the command line,
or are a dependent of a target specified on the command line--but
they will
.I always
be built if so specified.
Multiple targets can be passed in to a single call to
.BR AlwaysBuild ().

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.TP
.IR env .Append(key= val ", [...])"
Appends the specified keyword arguments
to the end of construction variables in the environment.
If the Environment does not have
the specified construction variable,
it is simply added to the environment.
If the values of the construction variable
and the keyword argument are the same type,
then the two values will be simply added together.
Otherwise, the construction variable
and the value of the keyword argument
are both coerced to lists,
and the lists are added together.
(See also the Prepend method, below.)

Example:

.ES
env.Append(CCFLAGS = ' -g', FOO = ['foo.yyy'])
.EE

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.TP
.IR env .AppendENVPath( name ", " newpath ", [" envname ", " sep ", " delete_existing ])
This appends new path elements to the given path in the
specified external environment
.RB ( ENV
by default).
This will only add
any particular path once (leaving the last one it encounters and
ignoring the rest, to preserve path order),
and to help assure this,
will normalize all paths (using
.B os.path.normpath
and
.BR os.path.normcase ).
This can also handle the
case where the given old path variable is a list instead of a
string, in which case a list will be returned instead of a string.

If 
.I delete_existing
is 0, then adding a path that already exists
will not move it to the end; it will stay where it is in the list.

Example:

.ES
print 'before:',env['ENV']['INCLUDE']
include_path = '/foo/bar:/foo'
env.AppendENVPath('INCLUDE', include_path)
print 'after:',env['ENV']['INCLUDE']

yields:
before: /foo:/biz
after: /biz:/foo/bar:/foo
.EE

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.TP
.IR env .AppendUnique(key= val ", [...], delete_existing=" 0)
Appends the specified keyword arguments
to the end of construction variables in the environment.
If the Environment does not have
the specified construction variable,
it is simply added to the environment.
If the construction variable being appended to is a list,
then any value(s) that already exist in the
construction variable will
.I not
be added again to the list.
However, if delete_existing is 1, 
existing matching values are removed first, so
existing values in the arg list move to the end of the list.

Example:

.ES
env.AppendUnique(CCFLAGS = '-g', FOO = ['foo.yyy'])
.EE

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.TP
.IR env .BitKeeper()
A factory function that
returns a Builder object
to be used to fetch source files
using BitKeeper.
The returned Builder
is intended to be passed to the
.BR SourceCode ()
function.

This function is deprecated.  For details, see the entry for the
.BR SourceCode ()
function.

Example:

.ES
env.SourceCode('.', env.BitKeeper())
.EE

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.TP
.RI BuildDir( build_dir ", " src_dir ", [" duplicate ])
.TP
.IR env .BuildDir( build_dir ", " src_dir ", [" duplicate ])
Deprecated synonyms for
.BR VariantDir ()
and
.BR env.VariantDir ().
The
.I build_dir
argument becomes the
.I variant_dir
argument of
.BR VariantDir ()
or
.BR env.VariantDir ().

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.TP
.RI Builder( action ", [" arguments ])
.TP
.IR env .Builder( action ", [" arguments ])
Creates a Builder object for
the specified
.IR action .
See the section "Builder Objects,"
below, for a complete explanation of the arguments and behavior.

Note that the
.BR env.Builder ()
form of the invocation will expand
construction variables in any arguments strings,
including the
.I action
argument,
at the time it is called
using the construction variables in the
.I env
construction environment through which
.BR env.Builder ()
was called.
The
.BR Builder ()
form delays all variable expansion
until after the Builder object is actually called.

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.TP
.RI CacheDir( cache_dir )
.TP
.IR env .CacheDir( cache_dir )
Specifies that
.B scons
will maintain a cache of derived files in
.IR cache_dir .
The derived files in the cache will be shared
among all the builds using the same
.BR CacheDir ()
call.
Specifying a
.I cache_dir
of
.B None
disables derived file caching.

Calling
.BR env.CacheDir ()
will only affect targets built
through the specified construction environment.
Calling
.BR CacheDir ()
sets a global default
that will be used by all targets built
through construction environments
that do
.I not
have an
.BR env.CacheDir ()
specified.

When a
.BR CacheDir ()
is being used and
.B scons
finds a derived file that needs to be rebuilt,
it will first look in the cache to see if a
derived file has already been built
from identical input files and an identical build action
(as incorporated into the MD5 build signature).
If so,
.B scons
will retrieve the file from the cache.
If the derived file is not present in the cache,
.B scons
will rebuild it and
then place a copy of the built file in the cache
(identified by its MD5 build signature),
so that it may be retrieved by other
builds that need to build the same derived file
from identical inputs.

Use of a specified
.BR CacheDir ()
may be disabled for any invocation
by using the
.B \-\-cache-disable
option.

If the
.B \-\-cache-force
option is used,
.B scons
will place a copy of
.I all
derived files in the cache,
even if they already existed
and were not built by this invocation.
This is useful to populate a cache
the first time
.BR CacheDir ()
is added to a build,
or after using the
.B \-\-cache-disable
option.

When using
.BR CacheDir (),
.B scons
will report,
"Retrieved `file' from cache,"
unless the
.B \-\-cache-show
option is being used.
When the
.B \-\-cache-show
option is used,
.B scons
will print the action that
.I would
have been used to build the file,
without any indication that
the file was actually retrieved from the cache.
This is useful to generate build logs
that are equivalent regardless of whether
a given derived file has been built in-place
or retrieved from the cache.

The
.BR NoCache ()
method can be used to disable caching of specific files.  This can be
useful if inputs and/or outputs of some tool are impossible to
predict or prohibitively large.

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.TP
.RI Clean( targets ", " files_or_dirs )
.TP
.IR env .Clean( targets ", " files_or_dirs )
This specifies a list of files or directories which should be removed
whenever the targets are specified with the
.B \-c
command line option.
The specified targets may be a list
or an individual target.
Multiple calls to
.BR Clean ()
are legal,
and create new targets or add files and directories to the
clean list for the specified targets.

Multiple files or directories should be specified
either as separate arguments to the
.BR Clean ()
method, or as a list.
.BR Clean ()
will also accept the return value of any of the construction environment
Builder methods.
Examples:

The related
.BR NoClean ()
function overrides calling
.BR Clean ()
for the same target,
and any targets passed to both functions will
.I not
be removed by the
.B \-c
option.

Examples:

.ES
Clean('foo', ['bar', 'baz'])
Clean('dist', env.Program('hello', 'hello.c'))
Clean(['foo', 'bar'], 'something_else_to_clean')
.EE
.IP
In this example,
installing the project creates a subdirectory for the documentation.
This statement causes the subdirectory to be removed
if the project is deinstalled.
.ES
Clean(docdir, os.path.join(docdir, projectname))
.EE

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.TP
.IR env .Clone([key= val ", ...])"
Returns a separate copy of a construction environment.
If there are any keyword arguments specified,
they are added to the returned copy,
overwriting any existing values
for the keywords.

Example:

.ES
env2 = env.Clone()
env3 = env.Clone(CCFLAGS = '-g')
.EE
.IP
Additionally, a list of tools and a toolpath may be specified, as in
the Environment constructor:

.ES
def MyTool(env): env['FOO'] = 'bar'
env4 = env.Clone(tools = ['msvc', MyTool])
.EE
.IP
The
.I parse_flags
keyword argument is also recognized:

.ES
# create an environment for compiling programs that use wxWidgets
wx_env = env.Clone(parse_flags = '!wx-config --cflags --cxxflags')
.EE

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.TP
.RI Command( target ", " source ", " action ", [key=" val ", ...])"
.TP
.IR env .Command( target ", " source ", " action ", [key=" val ", ...])"
Executes a specific action
(or list of actions)
to build a target file or files.
This is more convenient
than defining a separate Builder object
for a single special-case build.

As a special case, the
.I source_scanner
keyword argument can
be used to specify
a Scanner object
that will be used to scan the sources.
(The global
.B DirScanner
object can be used
if any of the sources will be directories
that must be scanned on-disk for
changes to files that aren't
already specified in other Builder of function calls.)

Any other keyword arguments specified override any
same-named existing construction variables.

An action can be an external command,
specified as a string,
or a callable Python object;
see "Action Objects," below,
for more complete information.
Also note that a string specifying an external command
may be preceded by an
.B @
(at-sign)
to suppress printing the command in question,
or by a
.B \-
(hyphen)
to ignore the exit status of the external command.

Examples:

.ES
env.Command('foo.out', 'foo.in',
            "$FOO_BUILD < $SOURCES > $TARGET")

env.Command('bar.out', 'bar.in',
            ["rm -f $TARGET",
             "$BAR_BUILD < $SOURCES > $TARGET"],
            ENV = {'PATH' : '/usr/local/bin/'})

def rename(env, target, source):
    import os
    os.rename('.tmp', str(target[0]))

env.Command('baz.out', 'baz.in',
            ["$BAZ_BUILD < $SOURCES > .tmp",
	     rename ])
.EE
.IP
Note that the
.BR Command ()
function will usually assume, by default,
that the specified targets and/or sources are Files,
if no other part of the configuration
identifies what type of entry it is.
If necessary, you can explicitly specify
that targets or source nodes should
be treated as directoriese
by using the
.BR Dir ()
or
.BR env.Dir ()
functions.

Examples:

.ES
env.Command('ddd.list', Dir('ddd'), 'ls -l $SOURCE > $TARGET')

env['DISTDIR'] = 'destination/directory'
env.Command(env.Dir('$DISTDIR')), None, make_distdir)
.EE
.IP
(Also note that SCons will usually
automatically create any directory necessary to hold a target file,
so you normally don't need to create directories by hand.)

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.TP
.RI Configure( env ", [" custom_tests ", " conf_dir ", " log_file ", " config_h ])
.TP
.IR env .Configure([ custom_tests ", " conf_dir ", " log_file ", " config_h ])
Creates a Configure object for integrated
functionality similar to GNU autoconf.
See the section "Configure Contexts,"
below, for a complete explanation of the arguments and behavior.

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.TP
.IR env .Copy([key= val ", ...])"
A now-deprecated synonym for
.BR env.Clone ().

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.TP
.IR env .CVS( repository ", " module )
A factory function that
returns a Builder object
to be used to fetch source files
from the specified
CVS
.IR repository .
The returned Builder
is intended to be passed to the
.BR SourceCode ()
function.

This function is deprecated.  For details, see the entry for the
.BR SourceCode ()
function.

The optional specified
.I module
will be added to the beginning
of all repository path names;
this can be used, in essence,
to strip initial directory names
from the repository path names,
so that you only have to
replicate part of the repository
directory hierarchy in your
local build directory.

Examples:

.ES
# Will fetch foo/bar/src.c
# from /usr/local/CVSROOT/foo/bar/src.c.
env.SourceCode('.', env.CVS('/usr/local/CVSROOT'))

# Will fetch bar/src.c
# from /usr/local/CVSROOT/foo/bar/src.c.
env.SourceCode('.', env.CVS('/usr/local/CVSROOT', 'foo'))

# Will fetch src.c
# from /usr/local/CVSROOT/foo/bar/src.c.
env.SourceCode('.', env.CVS('/usr/local/CVSROOT', 'foo/bar'))
.EE

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.TP
.RI Decider( function )
.TP
.IR env .Decider( function )
Specifies that all up-to-date decisions for
targets built through this construction environment
will be handled by the specified
.IR function .
The
.I function
can be one of the following strings
that specify the type of decision function
to be performed:

.RS 10
.TP 6
.B timestamp-newer
Specifies that a target shall be considered out of date and rebuilt
if the dependency's timestamp is newer than the target file's timestamp.
This is the behavior of the classic Make utility,
and
.B make
can be used a synonym for
.BR timestamp-newer .
.TP 6
.B timestamp-match
Specifies that a target shall be considered out of date and rebuilt
if the dependency's timestamp is different than the
timestamp recorded the last time the target was built.
This provides behavior very similar to the classic Make utility
(in particular, files are not opened up so that their
contents can be checksummed)
except that the target will also be rebuilt if a
dependency file has been restored to a version with an
.I earlier
timestamp, such as can happen when restoring files from backup archives.
.TP 6
.B MD5
Specifies that a target shall be considered out of date and rebuilt
if the dependency's content has changed sine the last time
the target was built,
as determined be performing an MD5 checksum
on the dependency's contents
and comparing it to the checksum recorded the
last time the target was built.
.B content
can be used as a synonym for
.BR MD5 .
.TP 6
.B MD5-timestamp
Specifies that a target shall be considered out of date and rebuilt
if the dependency's content has changed sine the last time
the target was built,
except that dependencies with a timestamp that matches
the last time the target was rebuilt will be
assumed to be up-to-date and
.I not
rebuilt.
This provides behavior very similar
to the
.B MD5
behavior of always checksumming file contents,
with an optimization of not checking
the contents of files whose timestamps haven't changed.
The drawback is that SCons will
.I not
detect if a file's content has changed
but its timestamp is the same,
as might happen in an automated script
that runs a build,
updates a file,
and runs the build again,
all within a single second.
.RE

Examples:

.ES
# Use exact timestamp matches by default.
Decider('timestamp-match')

# Use MD5 content signatures for any targets built
# with the attached construction environment.
env.Decider('content')
.EE
.IP
In addition to the above already-available functions,
the
.I function
argument may be an actual Python function
that takes the following three arguments:

.RS 10
.IP dependency
The Node (file) which
should cause the
.I target
to be rebuilt
if it has "changed" since the last tme
.I target
was built.
.IP target
The Node (file) being built.
In the normal case,
this is what should get rebuilt
if the
.I dependency
has "changed."
.IP prev_ni
Stored information about the state of the
.I dependency
the last time the
.I target
was built.
This can be consulted to match various
file characteristics
such as the timestamp,
size, or content signature.
.RE

The
.I function
should return a
.B True
(non-zero)
value if the
.I dependency
has "changed" since the last time
the
.I target
was built
(indicating that the target
.I should
be rebuilt),
and
.B False
(zero)
otherwise
(indicating that the target should
.I not
be rebuilt).
Note that the decision can be made
using whatever criteria are appopriate.
Ignoring some or all of the function arguments
is perfectly normal.

Example:

.ES
def my_decider(dependency, target, prev_ni):
    return not os.path.exists(str(target))

env.Decider(my_decider)
.EE

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.TP
.RI Default( targets )
.TP
.IR env .Default( targets )
This specifies a list of default targets,
which will be built by
.B scons
if no explicit targets are given on the command line.
Multiple calls to
.BR Default ()
are legal,
and add to the list of default targets.

Multiple targets should be specified as
separate arguments to the
.BR Default ()
method, or as a list.
.BR Default ()
will also accept the Node returned by any
of a construction environment's
builder methods.

Examples:

.ES
Default('foo', 'bar', 'baz')
env.Default(['a', 'b', 'c'])
hello = env.Program('hello', 'hello.c')
env.Default(hello)
.EE
.IP
An argument to
.BR Default ()
of
.B None
will clear all default targets.
Later calls to
.BR Default ()
will add to the (now empty) default-target list
like normal.

The current list of targets added using the
.BR Default ()
function or method is available in the
.B DEFAULT_TARGETS
list;
see below.

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.TP
.RI DefaultEnvironment([ args ])
Creates and returns a default construction environment object.
This construction environment is used internally by SCons
in order to execute many of the global functions in this list,
and to fetch source files transparently
from source code management systems.

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.TP
.RI Depends( target ", " dependency )
.TP
.IR env .Depends( target ", " dependency )
Specifies an explicit dependency;
the
.I target
will be rebuilt
whenever the
.I dependency
has changed.
Both the specified
.I target
and
.I dependency
can be a string
(usually the path name of a file or directory)
or Node objects,
or a list of strings or Node objects
(such as returned by a Builder call).
This should only be necessary
for cases where the dependency
is not caught by a Scanner
for the file.

Example:

.ES
env.Depends('foo', 'other-input-file-for-foo')

mylib = env.Library('mylib.c')
installed_lib = env.Install('lib', mylib)
bar = env.Program('bar.c')

# Arrange for the library to be copied into the installation
# directory before trying to build the "bar" program.
# (Note that this is for example only.  A "real" library
# dependency would normally be configured through the $LIBS
# and $LIBPATH variables, not using an env.Depends() call.)

env.Depends(bar, installed_lib)
.EE

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.TP
.IR env .Dictionary([ vars ])
Returns a dictionary object
containing copies of all of the
construction variables in the environment.
If there are any variable names specified,
only the specified construction
variables are returned in the dictionary.

Example:

.ES
dict = env.Dictionary()
cc_dict = env.Dictionary('CC', 'CCFLAGS', 'CCCOM')
.EE

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.TP
.RI Dir( name ", [" directory ])
.TP
.IR env .Dir( name ", [" directory ])
This returns a Directory Node,
an object that represents the specified directory
.IR name .
.I name
can be a relative or absolute path.
.I directory
is an optional directory that will be used as the parent directory.
If no
.I directory
is specified, the current script's directory is used as the parent.

If
.I name
is a list, SCons returns a list of Dir nodes.
Construction variables are expanded in
.IR name .

Directory Nodes can be used anywhere you
would supply a string as a directory name
to a Builder method or function.
Directory Nodes have attributes and methods
that are useful in many situations;
see "File and Directory Nodes," below.

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.TP
.IR env .Dump([ key ])
Returns a pretty printable representation of the environment.
.IR key ,
if not
.BR None ,
should be a string containing the name of the variable of interest.

This SConstruct:

.ES
env=Environment()
print env.Dump('CCCOM')
.EE
.IP
will print:

.ES
'$CC -c -o $TARGET $CCFLAGS $CPPFLAGS $_CPPDEFFLAGS $_CPPINCFLAGS $SOURCES'
.EE
.IP
While this SConstruct:

.ES
env=Environment()
print env.Dump()
.EE
.IP
will print:
.ES
{ 'AR': 'ar',
  'ARCOM': '$AR $ARFLAGS $TARGET $SOURCES\\n$RANLIB $RANLIBFLAGS $TARGET',
  'ARFLAGS': ['r'],
  'AS': 'as',
  'ASCOM': '$AS $ASFLAGS -o $TARGET $SOURCES',
  'ASFLAGS': [],
  ...
.EE

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.TP
.RI EnsurePythonVersion( major ", " minor )
.TP
.IR env .EnsurePythonVersion( major ", " minor )
Ensure that the Python version is at least
.IR major\fP.\fIminor .
This function will
print out an error message and exit SCons with a non-zero exit code if the
actual Python version is not late enough.

Example:

.ES
EnsurePythonVersion(2,2)
.EE

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.TP
.RI EnsureSConsVersion( major ", " minor ", [" revision ])
.TP
.IR env .EnsureSConsVersion( major ", " minor ", [" revision ])
Ensure that the SCons version is at least
.IR major.minor ,
or
.IR major.minor.revision .
if
.I revision
is specified.
This function will
print out an error message and exit SCons with a non-zero exit code if the
actual SCons version is not late enough.

Examples:

.ES
EnsureSConsVersion(0,14)

EnsureSConsVersion(0,96,90)
.EE

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.TP
.RI Environment([key= value ", ...])"
.TP
.IR env .Environment([key= value ", ...])"
Return a new construction environment
initialized with the specified
.IR key = value
pairs.

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.TP
.RI Execute( action ", [" strfunction ", " varlist ])
.TP
.IR env .Execute( action ", [" strfunction ", " varlist ])
Executes an Action object.
The specified
.I action
may be an Action object
(see the section "Action Objects,"
below, for a complete explanation of the arguments and behavior),
or it may be a command-line string,
list of commands,
or executable Python function,
each of which will be converted
into an Action object
and then executed.
The exit value of the command
or return value of the Python function
will be returned.

Note that
.B scons
will print an error message if the executed
.I action
fails--that is,
exits with or returns a non-zero value.
.B scons
will
.IR not ,
however,
automatically terminate the build
if the specified
.I action
fails.
If you want the build to stop in response to a failed
.BR Execute ()
call,
you must explicitly check for a non-zero return value:

.ES
Execute(Copy('file.out', 'file.in'))

if Execute("mkdir sub/dir/ectory"):
    # The mkdir failed, don't try to build.
    Exit(1)
.EE

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.TP
.RI Exit([ value ])
.TP
.IR env .Exit([ value ])
This tells
.B scons
to exit immediately
with the specified
.IR value .
A default exit value of
.B 0
(zero)
is used if no value is specified.

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.TP
.RI Export( vars )
.TP
.IR env .Export( vars )
This tells
.B scons
to export a list of variables from the current
SConscript file to all other SConscript files.
The exported variables are kept in a global collection,
so subsequent calls to
.BR Export ()
will over-write previous exports that have the same name.
Multiple variable names can be passed to
.BR Export ()
as separate arguments or as a list.
Keyword arguments can be used to provide names and their values.
A dictionary can be used to map variables to a different name when exported.
Both local variables and global variables can be exported.

Examples:

.ES
env = Environment()
# Make env available for all SConscript files to Import().
Export("env")

package = 'my_name'
# Make env and package available for all SConscript files:.
Export("env", "package")

# Make env and package available for all SConscript files:
Export(["env", "package"])

# Make env available using the name debug:
Export(debug = env)

# Make env available using the name debug:
Export({"debug":env})
.EE
.IP
Note that the
.BR SConscript ()
function supports an
.I exports
argument that makes it easier to to export a variable or
set of variables to a single SConscript file.
See the description of the
.BR SConscript ()
function, below.

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.TP
.RI File( name ", [" directory ])
.TP
.IR env .File( name ", [" directory ])
This returns a
File Node,
an object that represents the specified file
.IR name .
.I name
can be a relative or absolute path.
.I directory
is an optional directory that will be used as the parent directory.

If
.I name
is a list, SCons returns a list of File nodes.
Construction variables are expanded in
.IR name .

File Nodes can be used anywhere you
would supply a string as a file name
to a Builder method or function.
File Nodes have attributes and methods
that are useful in many situations;
see "File and Directory Nodes," below.

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.TP
.RI FindFile( file ", " dirs )
.TP
.IR env .FindFile( file ", " dirs )
Search for
.I file
in the path specified by
.IR dirs .
.I dirs
may be a list of directory names or a single directory name.
In addition to searching for files that exist in the filesystem,
this function also searches for derived files
that have not yet been built.

Example:

.ES
foo = env.FindFile('foo', ['dir1', 'dir2'])
.EE

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.TP
.RI FindInstalledFiles()
.TP
.IR env .FindInstalledFiles()
Returns the list of targets set up by the
.BR Install ()
or
.BR InstallAs ()
builders.

This function serves as a convenient method to select the contents of
a binary package.

Example:

.ES
Install( '/bin', [ 'executable_a', 'executable_b' ] )

# will return the file node list
# [ '/bin/executable_a', '/bin/executable_b' ]
FindInstalledFiles()

Install( '/lib', [ 'some_library' ] )

# will return the file node list
# [ '/bin/executable_a', '/bin/executable_b', '/lib/some_library' ]
FindInstalledFiles()
.EE

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.TP
.RI FindPathDirs( variable )
Returns a function
(actually a callable Python object)
intended to be used as the
.I path_function
of a Scanner object.
The returned object will look up the specified
.I variable
in a construction environment
and treat the construction variable's value as a list of
directory paths that should be searched
(like
.BR $CPPPATH ,
.BR $LIBPATH ,
etc.).

Note that use of
.BR FindPathDirs ()
is generally preferable to
writing your own
.I path_function
for the following reasons:
1) The returned list will contain all appropriate directories
found in source trees
(when
.BR VariantDir ()
is used)
or in code repositories
(when
.BR Repository ()
or the
.B \-Y
option are used).
2) scons will identify expansions of
.I variable
that evaluate to the same list of directories as,
in fact, the same list,
and avoid re-scanning the directories for files,
when possible.

Example:

.ES
def my_scan(node, env, path, arg):
    # Code to scan file contents goes here...
    return include_files

scanner = Scanner(name = 'myscanner',
                  function = my_scan,
                  path_function = FindPathDirs('MYPATH'))
.EE

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.TP
.RI FindSourceFiles(node= '"."')
.TP
.IR env .FindSourceFiles(node= '"."')
Returns the list of nodes which serve as the source of the built files.
It does so by inspecting the dependency tree starting at the optional
argument
.I node
which defaults to the '"."'-node. It will then return all leaves of
.IR node .
These are all children which have no further children.

This function is a convenient method to select the contents of a Source
Package.

Example:

.ES
Program( 'src/main_a.c' )
Program( 'src/main_b.c' )
Program( 'main_c.c' )

# returns ['main_c.c', 'src/main_a.c', 'SConstruct', 'src/main_b.c']
FindSourceFiles()

# returns ['src/main_b.c', 'src/main_a.c' ]
FindSourceFiles( 'src' )
.EE
.IP
As you can see build support files (SConstruct in the above example)
will also be returned by this function.

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.TP
.RI Flatten( sequence )
.TP
.IR env .Flatten( sequence )
Takes a sequence (that is, a Python list or tuple)
that may contain nested sequences
and returns a flattened list containing
all of the individual elements in any sequence.
This can be helpful for collecting
the lists returned by calls to Builders;
other Builders will automatically
flatten lists specified as input,
but direct Python manipulation of
these lists does not.

Examples:

.ES
foo = Object('foo.c')
bar = Object('bar.c')

# Because `foo' and `bar' are lists returned by the Object() Builder,
# `objects' will be a list containing nested lists:
objects = ['f1.o', foo, 'f2.o', bar, 'f3.o']

# Passing such a list to another Builder is all right because
# the Builder will flatten the list automatically:
Program(source = objects)

# If you need to manipulate the list directly using Python, you need to
# call Flatten() yourself, or otherwise handle nested lists:
for object in Flatten(objects):
    print str(object)
.EE

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.TP
.RI GetBuildFailures()
Returns a list of exceptions for the
actions that failed while
attempting to build targets.
Each element in the returned list is a
.I BuildError
object
with the following attributes
that record various aspects
of the build failure:

.B .node
The node that was being built
when the build failure occurred.

.B .status
The numeric exit status
returned by the command or Python function
that failed when trying to build the
specified Node.

.B .errstr
The SCons error string
describing the build failure.
(This is often a generic
message like "Error 2"
to indicate that an executed
command exited with a status of 2.)

.B .filename
The name of the file or
directory that actually caused the failure.
This may be different from the
.B .node
attribute.
For example,
if an attempt to build a target named
.B sub/dir/target
fails because the
.B sub/dir
directory could not be created,
then the
.B .node
attribute will be
.B sub/dir/target
but the
.B .filename
attribute will be
.BR sub/dir .

.B .executor
The SCons Executor object
for the target Node
being built.
This can be used to retrieve
the construction environment used
for the failed action.

.B .action
The actual SCons Action object that failed.
This will be one specific action
out of the possible list of
actions that would have been
executed to build the target.

.B .command
The actual expanded command that was executed and failed,
after expansion of
.BR $TARGET ,
.BR $SOURCE ,
and other construction variables.

Note that the
.BR GetBuildFailures ()
function
will always return an empty list
until any build failure has occurred,
which means that
.BR GetBuildFailures ()
will always return an empty list
while the
.B SConscript
files are being read.
Its primary intended use is
for functions that will be
executed before SCons exits
by passing them to the
standard Python
.BR atexit.register ()
function.
Example:

.ES
import atexit

def print_build_failures():
    from SCons.Script import GetBuildFailures
    for bf in GetBuildFailures():
        print "%s failed: %s" % (bf.node, bf.errstr)

atexit.register(print_build_failures)
.EE

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.TP
.RI GetBuildPath( file ", [...])"
.TP
.IR env .GetBuildPath( file ", [...])"
Returns the
.B scons
path name (or names) for the specified
.I file
(or files).
The specified
.I file
or files
may be
.B scons
Nodes or strings representing path names.

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.TP
.RI GetLaunchDir()
.TP
.IR env .GetLaunchDir()
Returns the absolute path name of the directory from which
.B scons
was initially invoked.
This can be useful when using the
.BR \-u ,
.B \-U
or
.B \-D
options, which internally
change to the directory in which the
.B SConstruct
file is found.

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.TP
.RI GetOption( name )
.TP
.IR env .GetOption( name )
This function provides a way to query the value of
SCons options set on scons command line
(or set using the
.BR SetOption ()
function).
The options supported are:

.RS 10
.TP 6
.B cache_debug
which corresponds to --cache-debug;
.TP 6
.B cache_disable
which corresponds to --cache-disable;
.TP 6
.B cache_force
which corresponds to --cache-force;
.TP 6
.B cache_show
which corresponds to --cache-show;
.TP 6
.B clean
which corresponds to -c, --clean and --remove;
.TP 6
.B config
which corresponds to --config;
.TP 6
.B directory
which corresponds to -C and --directory;
.TP 6
.B diskcheck
which corresponds to --diskcheck
.TP 6
.B duplicate
which corresponds to --duplicate;
.TP 6
.B file
which corresponds to -f, --file, --makefile and --sconstruct;
.TP 6
.B help
which corresponds to -h and --help;
.TP 6
.B ignore_errors
which corresponds to --ignore-errors;
.TP 6
.B implicit_cache
which corresponds to --implicit-cache;
.TP 6
.B implicit_deps_changed
which corresponds to --implicit-deps-changed;
.TP 6
.B implicit_deps_unchanged
which corresponds to --implicit-deps-unchanged;
.TP 6
.B interactive
which corresponds to --interact and --interactive;
.TP 6
.B keep_going
which corresponds to -k and --keep-going;
.TP 6
.B max_drift
which corresponds to --max-drift;
.TP 6
.B no_exec
which corresponds to -n, --no-exec, --just-print, --dry-run and --recon;
.TP 6
.B no_site_dir
which corresponds to --no-site-dir;
.TP 6
.B num_jobs
which corresponds to -j and --jobs;
.TP 6
.B profile_file
which corresponds to --profile;
.TP 6
.B question
which corresponds to -q and --question;
.TP 6
.B random
which corresponds to --random;
.TP 6
.B repository
which corresponds to -Y, --repository and --srcdir;
.TP 6
.B silent
which corresponds to -s, --silent and --quiet;
.TP 6
.B site_dir
which corresponds to --site-dir;
.TP 6
.B stack_size
which corresponds to --stack-size;
.TP 6
.B taskmastertrace_file
which corresponds to --taskmastertrace; and
.TP 6
.B warn
which corresponds to --warn and --warning.
.RE

See the documentation for the
corresponding command line object for information about each specific
option.

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.TP
.RI Glob( pattern ", [" ondisk ", " source ", " strings ])
.TP
.IR env .Glob( pattern ", [" ondisk ", " source ", " strings ])
Returns Nodes (or strings) that match the specified
.IR pattern ,
relative to the directory of the current
.B SConscript
file.
The
.BR env.Glob ()
form performs string substition on
.I pattern
and returns whatever matches
the resulting expanded pattern.

The specified
.I pattern
uses Unix shell style metacharacters for matching:

.ES
  *       matches everything
  ?       matches any single character
  [seq]   matches any character in seq
  [!seq]  matches any char not in seq
.EE
.IP
If the first character of a filename is a dot,
it must be matched explicitly.
Character matches do
.I not
span directory separators.

The
.BR Glob ()
knows about
repositories
(see the
.BR Repository ()
function)
and source directories
(see the
.BR VariantDir ()
function)
and
returns a Node (or string, if so configured)
in the local (SConscript) directory
if matching Node is found
anywhere in a corresponding
repository or source directory.

The
.I ondisk
argument may be set to
.B False
(or any other non-true value)
to disable the search for matches on disk,
thereby only returning matches among
already-configured File or Dir Nodes.
The default behavior is to
return corresponding Nodes
for any on-disk matches found.

The
.I source
argument may be set to
.B True
(or any equivalent value)
to specify that,
when the local directory is a
.BR VariantDir (),
the returned Nodes should be from the
corresponding source directory,
not the local directory.

The
.I strings
argument may be set to
.B True
(or any equivalent value)
to have the
.BR Glob ()
function return strings, not Nodes,
that represent the matched files or directories.
The returned strings will be relative to
the local (SConscript) directory.
(Note that This may make it easier to perform
arbitrary manipulation of file names,
but if the returned strings are
passed to a different
.B SConscript
file,
any Node translation will be relative
to the other
.B SConscript
directory,
not the original
.B SConscript
directory.)

Examples:

.ES
Program('foo', Glob('*.c'))
Zip('/tmp/everything', Glob('.??*') + Glob('*'))
.EE

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.TP
.RI Help( text )
.TP
.IR env .Help( text )
This specifies help text to be printed if the
.B \-h
argument is given to
.BR scons .
If
.BR Help ()
is called multiple times, the text is appended together in the order
that
.BR Help ()
is called.

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.TP
.RI Ignore( target ", " dependency )
.TP
.IR env .Ignore( target ", " dependency )
The specified dependency file(s)
will be ignored when deciding if
the target file(s) need to be rebuilt.

You can also use
.BR Ignore ()
to remove a target from the default build.
In order to do this you must specify the directory the target will
be built in as the target, and the file you want to skip building
as the dependency.

Note that this will only remove the dependencies listed from 
the files built by default.  It will still be built if that 
dependency is needed by another object being built. 
See the third and forth examples below.

Examples:

.ES
env.Ignore('foo', 'foo.c')
env.Ignore('bar', ['bar1.h', 'bar2.h'])
env.Ignore('.','foobar.obj')
env.Ignore('bar','bar/foobar.obj')
.EE

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.TP
.RI Import( vars )
.TP
.IR env .Import( vars )
This tells
.B scons
to import a list of variables into the current SConscript file. This
will import variables that were exported with
.BR Export ()
or in the
.I exports
argument to
.BR SConscript ().
Variables exported by
.BR SConscript ()
have precedence.
Multiple variable names can be passed to
.BR Import ()
as separate arguments or as a list. The variable "*" can be used
to import all variables.

Examples:

.ES
Import("env")
Import("env", "variable")
Import(["env", "variable"])
Import("*")
.EE

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.TP
.RI Literal( string )
.TP
.IR env .Literal( string )
The specified
.I string
will be preserved as-is
and not have construction variables expanded.

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.TP
.RI Local( targets )
.TP
.IR env .Local( targets )
The specified
.I targets
will have copies made in the local tree,
even if an already up-to-date copy
exists in a repository.
Returns a list of the target Node or Nodes.

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.TP
.IR env .MergeFlags( arg ", [" unique ])
Merges the specified
.I arg
values to the construction environment's construction variables.
If the
.I arg
argument is not a dictionary,
it is converted to one by calling
.BR env.ParseFlags ()
on the argument
before the values are merged.
Note that
.I arg
must be a single value,
so multiple strings must
be passed in as a list,
not as separate arguments to
.BR env.MergeFlags ().

By default,
duplicate values are eliminated;
you can, however, specify
.B unique=0
to allow duplicate
values to be added.
When eliminating duplicate values,
any construction variables that end with
the string
.B PATH
keep the left-most unique value.
All other construction variables keep
the right-most unique value.

Examples:

.ES
# Add an optimization flag to $CCFLAGS.
env.MergeFlags('-O3')

# Combine the flags returned from running pkg-config with an optimization
# flag and merge the result into the construction variables.
env.MergeFlags(['!pkg-config gtk+-2.0 --cflags', '-O3'])

# Combine an optimization flag with the flags returned from running pkg-config
# twice and merge the result into the construction variables.
env.MergeFlags(['-O3',
               '!pkg-config gtk+-2.0 --cflags --libs',
               '!pkg-config libpng12 --cflags --libs'])
.EE

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.TP
.RI NoCache( target ", ...)"
.TP
.IR env .NoCache( target ", ...)"
Specifies a list of files which should
.I not
be cached whenever the
.BR CacheDir ()
method has been activated.
The specified targets may be a list
or an individual target.

Multiple files should be specified
either as separate arguments to the
.BR NoCache ()
method, or as a list.
.BR NoCache ()
will also accept the return value of any of the construction environment
Builder methods.

Calling
.BR NoCache ()
on directories and other non-File Node types has no effect because
only File Nodes are cached.

Examples:

.ES
NoCache('foo.elf')
NoCache(env.Program('hello', 'hello.c'))
.EE

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.TP
.RI NoClean( target ", ...)"
.TP
.IR env .NoClean( target ", ...)"
Specifies a list of files or directories which should
.I not
be removed whenever the targets (or their dependencies)
are specified with the
.B \-c
command line option.
The specified targets may be a list
or an individual target.
Multiple calls to
.BR NoClean ()
are legal,
and prevent each specified target
from being removed by calls to the
.B \-c
option.

Multiple files or directories should be specified
either as separate arguments to the
.BR NoClean ()
method, or as a list.
.BR NoClean ()
will also accept the return value of any of the construction environment
Builder methods.

Calling
.BR NoClean ()
for a target overrides calling
.BR Clean ()
for the same target,
and any targets passed to both functions will
.I not
be removed by the
.B \-c
option.

Examples:

.ES
NoClean('foo.elf')
NoClean(env.Program('hello', 'hello.c'))
.EE

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.TP
.IR env .ParseConfig( command ", [" function ", " unique ])
Calls the specified
.I function
to modify the environment as specified by the output of
.IR command .
The default
.I function
is
.BR env.MergeFlags (),
which expects the output of a typical
.B *-config
command
(for example,
.BR gtk-config )
and adds the options
to the appropriate construction variables.
By default,
duplicate values are not
added to any construction variables;
you can specify
.B unique=0
to allow duplicate
values to be added.

Interpreted options
and the construction variables they affect
are as specified for the
.BR env.ParseFlags ()
method (which this method calls).
See that method's description, below,
for a table of options and construction variables.

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.TP
.RI ParseDepends( filename ", [" must_exist ", " only_one ])
.TP
.IR env .ParseDepends( filename ", [" must_exist ", " only_one ])
Parses the contents of the specified
.I filename
as a list of dependencies in the style of
.B Make
or
.BR mkdep ,
and explicitly establishes all of the listed dependencies.

By default,
it is not an error
if the specified
.I filename
does not exist.
The optional
.I must_exist
argument may be set to a non-zero
value to have
scons
throw an exception and
generate an error if the file does not exist,
or is otherwise inaccessible.

The optional
.I only_one
argument may be set to a non-zero
value to have
scons
thrown an exception and
generate an error
if the file contains dependency
information for more than one target.
This can provide a small sanity check
for files intended to be generated
by, for example, the
.B "gcc -M"
flag,
which should typically only
write dependency information for
one output file into a corresponding
.B .d
file.

The
.I filename
and all of the files listed therein
will be interpreted relative to
the directory of the
.B SConscript
file which calls the
.BR ParseDepends ()
function.

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.TP
.IR env .ParseFlags( flags ", ...)"
Parses one or more strings containing
typical command-line flags for GCC tool chains
and returns a dictionary with the flag values
separated into the appropriate SCons construction variables.
This is intended as a companion to the
.BR env.MergeFlags ()
method, but allows for the values in the returned dictionary
to be modified, if necessary,
before merging them into the construction environment.
(Note that
.BR env.MergeFlags ()
will call this method if its argument is not a dictionary,
so it is usually not necessary to call
.BR env.ParseFlags ()
directly unless you want to manipulate the values.)

If the first character in any string is
an exclamation mark (!),
the rest of the string is executed as a command,
and the output from the command is
parsed as GCC tool chain command-line flags
and added to the resulting dictionary.

Flag values are translated accordig to the prefix found,
and added to the following construction variables:

.ES
-arch               CCFLAGS, LINKFLAGS
-D                  CPPDEFINES
-framework          FRAMEWORKS
-frameworkdir=      FRAMEWORKPATH
-include            CCFLAGS
-isysroot           CCFLAGS, LINKFLAGS
-I                  CPPPATH
-l                  LIBS
-L                  LIBPATH
-mno-cygwin         CCFLAGS, LINKFLAGS
-mwindows           LINKFLAGS
-pthread            CCFLAGS, LINKFLAGS
-std=               CFLAGS
-Wa,                ASFLAGS, CCFLAGS
-Wl,-rpath=         RPATH
-Wl,-R,             RPATH
-Wl,-R              RPATH
-Wl,                LINKFLAGS
-Wp,                CPPFLAGS
-                   CCFLAGS
+                   CCFLAGS, LINKFLAGS
.EE
.IP
Any other strings not associated with options
are assumed to be the names of libraries
and added to the
.B $LIBS
construction variable.

Examples (all of which produce the same result):

.ES
dict = env.ParseFlags('-O2 -Dfoo -Dbar=1')
dict = env.ParseFlags('-O2', '-Dfoo', '-Dbar=1')
dict = env.ParseFlags(['-O2', '-Dfoo -Dbar=1'])
dict = env.ParseFlags('-O2', '!echo -Dfoo -Dbar=1')
.EE

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.TP
.IR env .Perforce()
A factory function that
returns a Builder object
to be used to fetch source files
from the Perforce source code management system.
The returned Builder
is intended to be passed to the
.BR SourceCode ()
function.

This function is deprecated.  For details, see the entry for the
.BR SourceCode ()
function.

Example:

.ES
env.SourceCode('.', env.Perforce())
.EE
.IP
Perforce uses a number of external
environment variables for its operation.
Consequently, this function adds the
following variables from the user's external environment
to the construction environment's
ENV dictionary:
P4CHARSET,
P4CLIENT,
P4LANGUAGE,
P4PASSWD,
P4PORT,
P4USER,
SystemRoot,
USER,
and
USERNAME.

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.TP
.RI Platform( string )
The
.BR Platform ()
form returns a callable object
that can be used to initialize
a construction environment using the
platform keyword of the
.BR Environment ()
function.

Example:

.ES
env = Environment(platform = Platform('win32'))
.EE
.IP
The
.BR env.Platform ()
form applies the callable object for the specified platform
.I string
to the environment through which the method was called.

.ES
env.Platform('posix')
.EE
.IP
Note that the
.B win32
platform adds the
.B SystemDrive
and
.B SystemRoot
variables from the user's external environment
to the construction environment's
.B $ENV
dictionary.
This is so that any executed commands
that use sockets to connect with other systems
(such as fetching source files from
external CVS repository specifications like
.BR :pserver:anonymous@cvs.sourceforge.net:/cvsroot/scons )
will work on Windows systems.

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.TP
.RI Precious( target ", ...)"
.TP
.IR env .Precious( target ", ...)"
Marks each given
.I target
as precious so it is not deleted before it is rebuilt. Normally
.B scons
deletes a target before building it.
Multiple targets can be passed in to a single call to
.BR Precious ().

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.TP
.IR env .Prepend(key= val ", [...])"
Appends the specified keyword arguments
to the beginning of construction variables in the environment.
If the Environment does not have
the specified construction variable,
it is simply added to the environment.
If the values of the construction variable
and the keyword argument are the same type,
then the two values will be simply added together.
Otherwise, the construction variable
and the value of the keyword argument
are both coerced to lists,
and the lists are added together.
(See also the Append method, above.)

Example:

.ES
env.Prepend(CCFLAGS = '-g ', FOO = ['foo.yyy'])
.EE

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.TP
.IR env .PrependENVPath( name ", " newpath ", [" envname ", " sep ", " delete_existing ])
This appends new path elements to the given path in the
specified external environment
.RB ( $ENV
by default).
This will only add
any particular path once (leaving the first one it encounters and
ignoring the rest, to preserve path order),
and to help assure this,
will normalize all paths (using
.B os.path.normpath
and
.BR os.path.normcase ).
This can also handle the
case where the given old path variable is a list instead of a
string, in which case a list will be returned instead of a string.

If
.I delete_existing
is 0, then adding a path that already exists
will not move it to the beginning;
it will stay where it is in the list.

Example:

.ES
print 'before:',env['ENV']['INCLUDE']
include_path = '/foo/bar:/foo'
env.PrependENVPath('INCLUDE', include_path)
print 'after:',env['ENV']['INCLUDE']
.EE
.IP
The above example will print:

.ES
before: /biz:/foo
after: /foo/bar:/foo:/biz
.EE

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.TP
.IR env .PrependUnique(key= val ", delete_existing=" "0, [...])"
Appends the specified keyword arguments
to the beginning of construction variables in the environment.
If the Environment does not have
the specified construction variable,
it is simply added to the environment.
If the construction variable being appended to is a list,
then any value(s) that already exist in the
construction variable will
.I not
be added again to the list.
However, if delete_existing is 1, 
existing matching values are removed first, so
existing values in the arg list move to the front of the list.

Example:

.ES
env.PrependUnique(CCFLAGS = '-g', FOO = ['foo.yyy'])
.EE

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.TP
.RI Progress( callable ", [" interval ])
.TP
.RI Progress( string ", [" interval ", " file ", " overwrite ])
.TP
.RI Progress( list_of_strings ", [" interval ", " file ", " overwrite ])
Allows SCons to show progress made during the build
by displaying a string or calling a function while
evaluating Nodes (e.g. files).

If the first specified argument is a Python callable
(a function or an object that has a
.BR __call__ ()
method),
the function will be called
once every
.I interval
times a Node is evaluated.
The callable will be passed the evaluated Node
as its only argument.
(For future compatibility,
it's a good idea to also add
.B *args
and
.B **kw
as arguments to your function or method.
This will prevent the code from breaking
if SCons ever changes the interface
to call the function with additional arguments in the future.)

An example of a simple custom progress function
that prints a string containing the Node name
every 10 Nodes:

.ES
def my_progress_function(node, *args, **kw):
    print 'Evaluating node %s!' % node
Progress(my_progress_function, interval=10)
.EE
.IP
A more complicated example of a custom progress display object
that prints a string containing a count
every 100 evaluated Nodes.
Note the use of
.B \\r
(a carriage return)
at the end so that the string
will overwrite itself on a display:

.ES
import sys
class ProgressCounter(object):
    count = 0
    def __call__(self, node, *args, **kw):
        self.count += 100
        sys.stderr.write('Evaluated %s nodes\\r' % self.count)
Progress(ProgressCounter(), interval=100)
.EE
.IP
If the first argument
.BR Progress ()
is a string,
the string will be displayed
every
.I interval
evaluated Nodes.
The default is to print the string on standard output;
an alternate output stream
may be specified with the
.B file=
argument.
The following will print a series of dots
on the error output,
one dot for every 100 evaluated Nodes:

.ES
import sys
Progress('.', interval=100, file=sys.stderr)
.EE
.IP
If the string contains the verbatim substring
.BR $TARGET ,
it will be replaced with the Node.
Note that, for performance reasons, this is
.I not
a regular SCons variable substition,
so you can not use other variables
or use curly braces.
The following example will print the name of
every evaluated Node,
using a
.B \\r
(carriage return) to cause each line to overwritten by the next line,
and the
.B overwrite=
keyword argument to make sure the previously-printed
file name is overwritten with blank spaces:

.ES
import sys
Progress('$TARGET\\r', overwrite=True)
.EE
.IP
If the first argument to
.BR Progress ()
is a list of strings,
then each string in the list will be displayed
in rotating fashion every
.I interval
evaluated Nodes.
This can be used to implement a "spinner"
on the user's screen as follows:

.ES
Progress(['-\\r', '\\\\\\r', '|\\r', '/\\r'], interval=5)
.EE

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.TP
.IR env .RCS()
A factory function that
returns a Builder object
to be used to fetch source files
from RCS.
The returned Builder
is intended to be passed to the
.BR SourceCode ()
function:

This function is deprecated.  For details, see the entry for the
.BR SourceCode ()
function.

Examples:

.ES
env.SourceCode('.', env.RCS())
.EE
.IP
Note that
.B scons
will fetch source files
from RCS subdirectories automatically,
so configuring RCS
as demonstrated in the above example
should only be necessary if
you are fetching from
RCS,v
files in the same
directory as the source files,
or if you need to explicitly specify RCS
for a specific subdirectory.

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.TP
.IR env .Replace(key= val ", [...])"
Replaces construction variables in the Environment
with the specified keyword arguments.

Example:

.ES
env.Replace(CCFLAGS = '-g', FOO = 'foo.xxx')
.EE

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.TP
.RI Repository( directory )
.TP
.IR env .Repository( directory )
Specifies that
.I directory
is a repository to be searched for files.
Multiple calls to
.BR Repository ()
are legal,
and each one adds to the list of
repositories that will be searched.

To
.BR scons ,
a repository is a copy of the source tree,
from the top-level directory on down,
which may contain
both source files and derived files
that can be used to build targets in
the local source tree.
The canonical example would be an
official source tree maintained by an integrator.
If the repository contains derived files,
then the derived files should have been built using
.BR scons ,
so that the repository contains the necessary
signature information to allow
.B scons
to figure out when it is appropriate to
use the repository copy of a derived file,
instead of building one locally.

Note that if an up-to-date derived file
already exists in a repository,
.B scons
will
.I not
make a copy in the local directory tree.
In order to guarantee that a local copy
will be made,
use the
.BR Local ()
method.

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.TP
.RI Requires( target ", " prerequisite )
.TP
.IR env .Requires( target ", " prerequisite )
Specifies an order-only relationship
between the specified target file(s)
and the specified prerequisite file(s).
The prerequisite file(s)
will be (re)built, if necessary,
.I before
the target file(s),
but the target file(s) do not actually
depend on the prerequisites
and will not be rebuilt simply because
the prerequisite file(s) change.

Example:

.ES
env.Requires('foo', 'file-that-must-be-built-before-foo')
.EE

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.TP
.RI Return([ vars "..., stop=" ])
By default,
this stops processing the current SConscript
file and returns to the calling SConscript file
the values of the variables named in the
.I vars
string arguments.
Multiple strings contaning variable names may be passed to
.BR Return ().
Any strings that contain white space

The optional
.B stop=
keyword argument may be set to a false value
to continue processing the rest of the SConscript
file after the
.BR Return ()
call.
This was the default behavior prior to SCons 0.98.
However, the values returned
are still the values of the variables in the named
.I vars
at the point
.BR Return ()
is called.

Examples:

.ES
# Returns without returning a value.
Return()

# Returns the value of the 'foo' Python variable.
Return("foo")

# Returns the values of the Python variables 'foo' and 'bar'.
Return("foo", "bar")

# Returns the values of Python variables 'val1' and 'val2'.
Return('val1 val2')
.EE

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.TP
.RI Scanner( function ", [" argument ", " keys ", " path_function ", " node_class ", " node_factory ", " scan_check ", " recursive ])
.TP
.IR env .Scanner( function ", [" argument ", " keys ", " path_function ", " node_class ", " node_factory ", " scan_check ", " recursive ])
Creates a Scanner object for
the specified
.IR function .
See the section "Scanner Objects,"
below, for a complete explanation of the arguments and behavior.

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.TP
.IR env .SCCS()
A factory function that
returns a Builder object
to be used to fetch source files
from SCCS.
The returned Builder
is intended to be passed to the
.BR SourceCode ()
function.

Example:

.ES
env.SourceCode('.', env.SCCS())
.EE
.IP
Note that
.B scons
will fetch source files
from SCCS subdirectories automatically,
so configuring SCCS
as demonstrated in the above example
should only be necessary if
you are fetching from
.B s.SCCS
files in the same
directory as the source files,
or if you need to explicitly specify SCCS
for a specific subdirectory.

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.TP
.RI SConscript( scripts ", [" exports ", " variant_dir ", " duplicate ])
.TP
.IR env .SConscript( scripts ", [" exports ", " variant_dir ", " duplicate ])
.TP
.RI SConscript(dirs= subdirs ", [name=" script ", " exports ", " variant_dir ", " duplicate ])
.TP
.IR env .SConscript(dirs= subdirs ", [name=" script ", " exports ", " variant_dir ", " duplicate ])
This tells
.B scons
to execute
one or more subsidiary SConscript (configuration) files.
Any variables returned by a called script using
.BR Return ()
will be returned by the call to
.BR SConscript ().
There are two ways to call the
.BR SConscript ()
function.

The first way you can call
.BR SConscript ()
is to explicitly specify one or more
.I scripts
as the first argument.
A single script may be specified as a string;
multiple scripts must be specified as a list
(either explicitly or as created by
a function like
.BR Split ()).
Examples:
.ES
SConscript('SConscript')      # run SConscript in the current directory
SConscript('src/SConscript')  # run SConscript in the src directory
SConscript(['src/SConscript', 'doc/SConscript'])
config = SConscript('MyConfig.py')
.EE
.IP
The second way you can call
.BR SConscript ()
is to specify a list of (sub)directory names
as a
.BI dirs= subdirs
keyword argument.
In this case,
.B scons
will, by default,
execute a subsidiary configuration file named
.B SConscript
in each of the specified directories.
You may specify a name other than
.B SConscript
by supplying an optional
.BI name= script
keyword argument.
The first three examples below have the same effect
as the first three examples above:
.ES
SConscript(dirs='.')      # run SConscript in the current directory
SConscript(dirs='src')    # run SConscript in the src directory
SConscript(dirs=['src', 'doc'])
SConscript(dirs=['sub1', 'sub2'], name='MySConscript')
.EE
.IP
The optional
.I exports
argument provides a list of variable names or a dictionary of
named values to export to the
.IR script(s) .
These variables are locally exported only to the specified
.IR script(s) ,
and do not affect the global pool of variables used by the
.BR Export ()
function.
The subsidiary
.I script(s)
must use the
.BR Import ()
function to import the variables.
Examples:
.ES
foo = SConscript('sub/SConscript', exports='env')
SConscript('dir/SConscript', exports=['env', 'variable'])
SConscript(dirs='subdir', exports='env variable')
SConscript(dirs=['one', 'two', 'three'], exports='shared_info')
.EE
.IP
If the optional
.I variant_dir
argument is present, it causes an effect equivalent to the
.BR VariantDir ()
method described below.
(If
.I variant_dir
is not present, the
.I duplicate
argument is ignored.)
The
.I variant_dir
argument is interpreted relative to the directory of the calling
.B SConscript
file.
See the description of the
.BR VariantDir ()
function below for additional details and restrictions.

If
.I variant_dir
is present,
the source directory is the directory in which the
.B SConscript
file resides and the
.B SConscript
file is evaluated as if it were in the
.I variant_dir
directory:
.ES
SConscript('src/SConscript', variant_dir = 'build')
.EE
.IP
is equivalent to

.ES
VariantDir('build', 'src')
SConscript('build/SConscript')
.EE
.IP
This later paradigm is often used when the sources are
in the same directory as the
.BR SConstruct :

.ES
SConscript('SConscript', variant_dir = 'build')
.EE
.IP
is equivalent to

.ES
VariantDir('build', '.')
SConscript('build/SConscript')
.EE
.IP
Here are some composite examples:

.ES
# collect the configuration information and use it to build src and doc
shared_info = SConscript('MyConfig.py')
SConscript('src/SConscript', exports='shared_info')
SConscript('doc/SConscript', exports='shared_info')
.EE

.ES
# build debugging and production versions.  SConscript
# can use Dir('.').path to determine variant.
SConscript('SConscript', variant_dir='debug', duplicate=0)
SConscript('SConscript', variant_dir='prod', duplicate=0)
.EE

.ES
# build debugging and production versions.  SConscript
# is passed flags to use.
opts = { 'CPPDEFINES' : ['DEBUG'], 'CCFLAGS' : '-pgdb' }
SConscript('SConscript', variant_dir='debug', duplicate=0, exports=opts)
opts = { 'CPPDEFINES' : ['NODEBUG'], 'CCFLAGS' : '-O' }
SConscript('SConscript', variant_dir='prod', duplicate=0, exports=opts)
.EE

.ES
# build common documentation and compile for different architectures
SConscript('doc/SConscript', variant_dir='build/doc', duplicate=0)
SConscript('src/SConscript', variant_dir='build/x86', duplicate=0)
SConscript('src/SConscript', variant_dir='build/ppc', duplicate=0)
.EE

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.TP
.RI SConscriptChdir( value )
.TP
.IR env .SConscriptChdir( value )
By default,
.B scons
changes its working directory
to the directory in which each
subsidiary SConscript file lives.
This behavior may be disabled
by specifying either:

.ES
SConscriptChdir(0)
env.SConscriptChdir(0)
.EE
.IP
in which case
.B scons
will stay in the top-level directory
while reading all SConscript files.
(This may be necessary when building from repositories,
when all the directories in which SConscript files may be found
don't necessarily exist locally.)
You may enable and disable
this ability by calling
SConscriptChdir()
multiple times.

Example:

.ES
env = Environment()
SConscriptChdir(0)
SConscript('foo/SConscript')	# will not chdir to foo
env.SConscriptChdir(1)
SConscript('bar/SConscript')	# will chdir to bar
.EE

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.TP
.RI SConsignFile([ file ", " dbm_module ])
.TP
.IR env .SConsignFile([ file ", " dbm_module ])
This tells
.B scons
to store all file signatures
in the specified database
.IR file .
If the
.I file
name is omitted,
.B .sconsign
is used by default.
(The actual file name(s) stored on disk
may have an appropriated suffix appended
by the
.IR  dbm_module .)
If
.I file
is not an absolute path name,
the file is placed in the same directory as the top-level
.B SConstruct
file.

If
.I file
is
.BR None ,
then
.B scons
will store file signatures
in a separate
.B .sconsign
file in each directory,
not in one global database file.
(This was the default behavior
prior to SCons 0.96.91 and 0.97.)

The optional
.I dbm_module
argument can be used to specify
which Python database module
The default is to use a custom
.B SCons.dblite
module that uses pickled
Python data structures,
and which works on all Python versions.

Examples:

.ES
# Explicitly stores signatures in ".sconsign.dblite"
# in the top-level SConstruct directory (the
# default behavior).
SConsignFile()

# Stores signatures in the file "etc/scons-signatures"
# relative to the top-level SConstruct directory.
SConsignFile("etc/scons-signatures")

# Stores signatures in the specified absolute file name.
SConsignFile("/home/me/SCons/signatures")

# Stores signatures in a separate .sconsign file
# in each directory.
SConsignFile(None)
.EE

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.TP
.IR env .SetDefault(key= val ", [...])"
Sets construction variables to default values specified with the keyword
arguments if (and only if) the variables are not already set.
The following statements are equivalent:

.ES
env.SetDefault(FOO = 'foo')

if 'FOO' not in env: env['FOO'] = 'foo'
.EE

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.TP
.RI SetOption( name ", " value )
.TP
.IR env .SetOption( name ", " value )
This function provides a way to set a select subset of the scons command
line options from a SConscript file. The options supported are:

.RS 10
.TP 6
.B clean
which corresponds to -c, --clean and --remove;
.TP 6
.B duplicate
which corresponds to --duplicate;
.TP 6
.B help
which corresponds to -h and --help;
.TP 6
.B implicit_cache
which corresponds to --implicit-cache;
.TP 6
.B max_drift
which corresponds to --max-drift;
.TP 6
.B no_exec
which corresponds to -n, --no-exec, --just-print, --dry-run and --recon;
.TP 6
.B num_jobs
which corresponds to -j and --jobs;
.TP 6
.B random
which corresponds to --random; and
.TP 6
.B stack_size
which corresponds to --stack-size.
.RE

See the documentation for the
corresponding command line object for information about each specific
option.

Example:

.ES
SetOption('max_drift', 1)
.EE

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.TP
.RI SideEffect( side_effect ", " target )
.TP
.IR env .SideEffect( side_effect ", " target )
Declares
.I side_effect
as a side effect of building
.IR target .
Both
.I side_effect
and
.I target
can be a list, a file name, or a node.
A side effect is a target file that is created or updated
as a side effect of building other targets.
For example, a Windows PDB
file is created as a side effect of building the .obj
files for a static library,
and various log files are created updated
as side effects of various TeX commands.
If a target is a side effect of multiple build commands,
.B scons
will ensure that only one set of commands
is executed at a time.
Consequently, you only need to use this method
for side-effect targets that are built as a result of
multiple build commands.

Because multiple build commands may update
the same side effect file,
by default the
.I side_effect
target is
.I not
automatically removed
when the
.I target
is removed by the
.B \-c
option.
(Note, however, that the
.I side_effect
might be removed as part of
cleaning the directory in which it lives.)
If you want to make sure the
.I side_effect
is cleaned whenever a specific
.I target
is cleaned,
you must specify this explicitly
with the
.BR Clean ()
or
.BR env.Clean ()
function.

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.TP
.RI SourceCode( entries ", " builder )
.TP
.IR env .SourceCode( entries ", " builder )
This function and its associate factory functions are deprecated.
There is no replacement.
The intended use was to keep a local tree in sync with an archive,
but in actuality the function only causes the archive
to be fetched on the first run.
Synchronizing with the archive is best done external to &SCons;.

Arrange for non-existent source files to
be fetched from a source code management system
using the specified
.IR builder .
The specified
.I entries
may be a Node, string or list of both,
and may represent either individual
source files or directories in which
source files can be found.

For any non-existent source files,
.B scons
will search up the directory tree
and use the first
.BR SourceCode ()
builder it finds.
The specified
.I builder
may be
.BR None ,
in which case
.B scons
will not use a builder to fetch
source files for the specified
.IR entries ,
even if a
.BR SourceCode ()
builder has been specified
for a directory higher up the tree.

.B scons
will, by default,
fetch files from SCCS or RCS subdirectories
without explicit configuration.
This takes some extra processing time
to search for the necessary
source code management files on disk.
You can avoid these extra searches
and speed up your build a little
by disabling these searches as follows:

.ES
env.SourceCode('.', None)
.EE
.IP
Note that if the specified
.I builder
is one you create by hand,
it must have an associated
construction environment to use
when fetching a source file.

.B scons
provides a set of canned factory
functions that return appropriate
Builders for various popular
source code management systems.
Canonical examples of invocation include:

.ES
env.SourceCode('.', env.BitKeeper('/usr/local/BKsources'))
env.SourceCode('src', env.CVS('/usr/local/CVSROOT'))
env.SourceCode('/', env.RCS())
env.SourceCode(['f1.c', 'f2.c'], env.SCCS())
env.SourceCode('no_source.c', None)
.EE

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.TP
.RI SourceSignatures( type )
.TP
.IR env .SourceSignatures( type )
Note:  Although it is not yet officially deprecated,
use of this function is discouraged.
See the
.BR Decider ()
function for a more flexible and straightforward way
to configure SCons' decision-making.

The
.BR SourceSignatures ()
function tells
.B scons
how to decide if a source file
(a file that is not built from any other files)
has changed since the last time it
was used to build a particular target file.
Legal values are
.B MD5
or
.BR timestamp .

If the environment method is used,
the specified type of source signature
is only used when deciding whether targets
built with that environment are up-to-date or must be rebuilt.
If the global function is used,
the specified type of source signature becomes the default
used for all decisions
about whether targets are up-to-date.

.B MD5
means
.B scons
decides that a source file has changed
if the MD5 checksum of its contents has changed since
the last time it was used to rebuild a particular target file.

.B timestamp
means
.B scons
decides that a source file has changed
if its timestamp (modification time) has changed since
the last time it was used to rebuild a particular target file.
(Note that although this is similar to the behavior of Make,
by default it will also rebuild if the dependency is
.I older
than the last time it was used to rebuild the target file.)

There is no different between the two behaviors
for Python
.BR Value ()
node objects.

.B MD5
signatures take longer to compute,
but are more accurate than
.B timestamp
signatures.
The default value is
.BR MD5 .

Note that the default
.BR TargetSignatures ()
setting (see below)
is to use this
.BR SourceSignatures ()
setting for any target files that are used
to build other target files.
Consequently, changing the value of
.BR SourceSignatures ()
will, by default,
affect the up-to-date decision for all files in the build
(or all files built with a specific construction environment
when
.BR env.SourceSignatures ()
is used).

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.TP
.RI Split( arg )
.TP
.IR env .Split( arg )
Returns a list of file names or other objects.
If arg is a string,
it will be split on strings of white-space characters
within the string,
making it easier to write long lists of file names.
If arg is already a list,
the list will be returned untouched.
If arg is any other type of object,
it will be returned as a list
containing just the object.

Example:

.ES
files = Split("f1.c f2.c f3.c")
files = env.Split("f4.c f5.c f6.c")
files = Split("""
	f7.c
	f8.c
	f9.c
""")
.EE

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.TP
.IR env .subst( input ", [" raw ", " target ", " source ", " conv ])
Performs construction variable interpolation
on the specified string or sequence argument
.IR input .

By default,
leading or trailing white space will
be removed from the result.
and all sequences of white space
will be compressed to a single space character.
Additionally, any
.B $(
and
.B $)
character sequences will be stripped from the returned string,
The optional
.I raw
argument may be set to
.B 1
if you want to preserve white space and
.BR $( - $)
sequences.
The
.I raw
argument may be set to
.B 2
if you want to strip
all characters between
any
.B $(
and
.B $)
pairs
(as is done for signature calculation).

If the input is a sequence
(list or tuple),
the individual elements of
the sequence will be expanded,
and the results will be returned as a list.

The optional
.I target
and
.I source
keyword arguments
must be set to lists of
target and source nodes, respectively,
if you want the
.BR $TARGET ,
.BR $TARGETS ,
.B $SOURCE
and
.B $SOURCES
to be available for expansion.
This is usually necessary if you are
calling
.BR env.subst ()
from within a Python function used
as an SCons action.

Returned string values or sequence elements
are converted to their string representation by default.
The optional
.I conv
argument
may specify a conversion function
that will be used in place of
the default.
For example, if you want Python objects
(including SCons Nodes)
to be returned as Python objects,
you can use the Python
.B lambda
idiom to pass in an unnamed function
that simply returns its unconverted argument.

Example:

.ES
print env.subst("The C compiler is: $CC")

def compile(target, source, env):
    sourceDir = env.subst("${SOURCE.srcdir}",
                          target=target,
                          source=source)

source_nodes = env.subst('$EXPAND_TO_NODELIST',
                         conv=lambda x: x)
.EE

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.TP
.RI Tag( node ", " tags )
Annotates file or directory Nodes with
information about how the
.BR Package ()
Builder should package those files or directories.
All tags are optional.

Examples:

.ES
# makes sure the built library will be installed with 0644 file
# access mode
Tag( Library( 'lib.c' ), UNIX_ATTR="0644" )

# marks file2.txt to be a documentation file
Tag( 'file2.txt', DOC )
.EE

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.TP
.RI TargetSignatures( type )
.TP
.IR env .TargetSignatures( type )
Note:  Although it is not yet officially deprecated,
use of this function is discouraged.
See the
.BR Decider ()
function for a more flexible and straightforward way
to configure SCons' decision-making.

The
.BR TargetSignatures ()
function tells
.B scons
how to decide if a target file
(a file that
.I is
built from any other files)
has changed since the last time it
was used to build some other target file.
Legal values are
.BR "build" ;
.B "content"
(or its synonym
.BR "MD5" );
.BR "timestamp" ;
or
.BR "source" .

If the environment method is used,
the specified type of target signature is only used
for targets built with that environment.
If the global function is used,
the specified type of signature becomes the default
used for all target files that
don't have an explicit target signature type
specified for their environments.

.B "content"
(or its synonym
.BR "MD5" )
means
.B scons
decides that a target file has changed
if the MD5 checksum of its contents has changed since
the last time it was used to rebuild some other target file.
This means
.B scons
will open up
MD5 sum the contents
of target files after they're built,
and may decide that it does not need to rebuild
"downstream" target files if a file was
rebuilt with exactly the same contents as the last time.

.B "timestamp"
means
.B scons
decides that a target file has changed
if its timestamp (modification time) has changed since
the last time it was used to rebuild some other target file.
(Note that although this is similar to the behavior of Make,
by default it will also rebuild if the dependency is
.I older
than the last time it was used to rebuild the target file.)

.B "source"
means
.B scons
decides that a target file has changed
as specified by the corresponding
.BR SourceSignatures ()
setting
.RB ( "MD5"
or
.BR "timestamp" ).
This means that
.B scons
will treat all input files to a target the same way,
regardless of whether they are source files
or have been built from other files.

.B "build"
means
.B scons
decides that a target file has changed
if it has been rebuilt in this invocation
or if its content or timestamp have changed
as specified by the corresponding
.BR SourceSignatures ()
setting.
This "propagates" the status of a rebuilt file
so that other "downstream" target files
will always be rebuilt,
even if the contents or the timestamp
have not changed.

.B "build"
signatures are fastest because
.B "content"
(or
.BR "MD5" )
signatures take longer to compute,
but are more accurate than
.B "timestamp"
signatures,
and can prevent unnecessary "downstream" rebuilds
when a target file is rebuilt to the exact same contents
as the previous build.
The
.B "source"
setting provides the most consistent behavior
when other target files may be rebuilt from
both source and target input files.
The default value is
.BR "source" .

Because the default setting is
.BR "source" ,
using
.BR SourceSignatures ()
is generally preferable to
.BR TargetSignatures (),
so that the up-to-date decision
will be consistent for all files
(or all files built with a specific construction environment).
Use of
.BR TargetSignatures ()
provides specific control for how built target files
affect their "downstream" dependencies.

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.TP
.RI Tool( string ", [" toolpath ", **" kw ])
.TP
.IR env .Tool( string ", [" toolpath ", **" kw ])
The
.BR Tool ()
form of the function
returns a callable object
that can be used to initialize
a construction environment using the
tools keyword of the Environment() method.
The object may be called with a construction
environment as an argument,
in which case the object will
add the necessary variables
to the construction environment
and the name of the tool will be added to the
.B $TOOLS
construction variable.

Additional keyword arguments are passed to the tool's
.BR generate ()
method.

Examples:

.ES
env = Environment(tools = [ Tool('msvc') ])

env = Environment()
t = Tool('msvc')
t(env)  # adds 'msvc' to the TOOLS variable
u = Tool('opengl', toolpath = ['tools'])
u(env)  # adds 'opengl' to the TOOLS variable
.EE
.IP
The
.BR env.Tool ()
form of the function
applies the callable object for the specified tool
.I string
to the environment through which the method was called.

Additional keyword arguments are passed to the tool's
.BR generate ()
method.

.ES
env.Tool('gcc')
env.Tool('opengl', toolpath = ['build/tools'])
.EE

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.TP
.RI Value( value ", [" built_value ])
.TP
.IR env .Value( value ", [" built_value ])
Returns a Node object representing the specified Python value.  Value
Nodes can be used as dependencies of targets.  If the result of
calling
.BI str( value )
changes between SCons runs, any targets depending on
.BI Value( value )
will be rebuilt.
(This is true even when using timestamps to decide if
files are up-to-date.)
When using timestamp source signatures, Value Nodes'
timestamps are equal to the system time when the Node is created.

The returned Value Node object has a
.BR write ()
method that can be used to "build" a Value Node
by setting a new value.
The optional
.I built_value
argument can be specified
when the Value Node is created
to indicate the Node should already be considered
"built."
There is a corresponding
.BR read ()
method that will return the built value of the Node.

Examples:

.ES
env = Environment()

def create(target, source, env):
    # A function that will write a 'prefix=$SOURCE'
    # string into the file name specified as the
    # $TARGET.
    f = open(str(target[0]), 'wb')
    f.write('prefix=' + source[0].get_contents())

# Fetch the prefix= argument, if any, from the command
# line, and use /usr/local as the default.
prefix = ARGUMENTS.get('prefix', '/usr/local')

# Attach a .Config() builder for the above function action
# to the construction environment.
env['BUILDERS']['Config'] = Builder(action = create)
env.Config(target = 'package-config', source = Value(prefix))

def build_value(target, source, env):
    # A function that "builds" a Python Value by updating
    # the the Python value with the contents of the file
    # specified as the source of the Builder call ($SOURCE).
    target[0].write(source[0].get_contents())

output = env.Value('before')
input = env.Value('after')

# Attach a .UpdateValue() builder for the above function
# action to the construction environment.
env['BUILDERS']['UpdateValue'] = Builder(action = build_value)
env.UpdateValue(target = Value(output), source = Value(input))
.EE

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.TP
.RI VariantDir( variant_dir ", " src_dir ", [" duplicate ])
.TP
.IR env .VariantDir( variant_dir ", " src_dir ", [" duplicate ])
Use the
.BR VariantDir ()
function to create a copy of your sources in another location:
if a name under
.I variant_dir
is not found but exists under
.IR src_dir ,
the file or directory is copied to
.IR variant_dir .
Target files can be built in a different directory
than the original sources by simply refering to the sources (and targets)
within the variant tree.

.BR VariantDir ()
can be called multiple times with the same
.I src_dir
to set up multiple builds with different options
.RI ( variants ).
The
.I src_dir
location must be in or underneath the SConstruct file's directory, and
.I variant_dir
may not be underneath
.IR src_dir .

The default behavior is for
.B scons
to physically duplicate the source files in the variant tree.
Thus, a build performed in the variant tree is guaranteed to be identical
to a build performed in the source tree even if
intermediate source files are generated during the build,
or preprocessors or other scanners search for included files
relative to the source file,
or individual compilers or other invoked tools are hard-coded
to put derived files in the same directory as source files.

If possible on the platform,
the duplication is performed by linking rather than copying;
see also the
.B \-\-duplicate
command-line option.
Moreover, only the files needed for the build are duplicated;
files and directories that are not used are not present in
.IR variant_dir .

Duplicating the source tree may be disabled by setting the
.B duplicate
argument to
.B 0
(zero).
This will cause
.B scons
to invoke Builders using the path names of source files in
.I src_dir
and the path names of derived files within
.IR variant_dir .
This is always more efficient than
.BR duplicate=1 ,
and is usually safe for most builds
(but see above for cases that may cause problems).

Note that
.BR VariantDir ()
works most naturally with a subsidiary SConscript file.
However, you would then call the subsidiary SConscript file
not in the source directory, but in the
.IR variant_dir ,
regardless of the value of
.BR duplicate .
This is how you tell
.B scons
which variant of a source tree to build:

.ES
# run src/SConscript in two variant directories
VariantDir('build/variant1', 'src')
SConscript('build/variant1/SConscript')
VariantDir('build/variant2', 'src')
SConscript('build/variant2/SConscript')
.EE
.IP
See also the
.BR SConscript ()
function, described above,
for another way to specify a variant directory
in conjunction with calling a subsidiary SConscript file.

Examples:

.ES
# use names in the build directory, not the source directory
VariantDir('build', 'src', duplicate=0)
Program('build/prog', 'build/source.c')
.EE

.ES
# this builds both the source and docs in a separate subtree
VariantDir('build', '.', duplicate=0)
SConscript(dirs=['build/src','build/doc'])
.EE

.ES
# same as previous example, but only uses SConscript
SConscript(dirs='src', variant_dir='build/src', duplicate=0)
SConscript(dirs='doc', variant_dir='build/doc', duplicate=0)
.EE

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.TP
.RI WhereIs( program ", [" path ", " pathext ", " reject ])
.TP
.IR env .WhereIs( program ", [" path ", " pathext ", " reject ])
Searches for the specified executable
.IR program ,
returning the full path name to the program
if it is found,
and returning None if not.
Searches the specified
.IR path ,
the value of the calling environment's PATH
.RB ( env['ENV']['PATH'] ),
or the user's current external PATH
.RB ( os.environ['PATH'] )
by default.
On Windows systems, searches for executable
programs with any of the file extensions
listed in the specified
.IR pathext ,
the calling environment's PATHEXT
.RB ( env['ENV']['PATHEXT'] )
or the user's current PATHEXT
.RB ( os.environ['PATHEXT'] )
by default.
Will not select any
path name or names
in the specified
.I reject
list, if any.
'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
'\" END GENERATED FUNCTION DESCRIPTIONS
'\"
'\" The descriptions above of the various SCons functions are generated
'\" from the .xml files that live next to the various Python modules in
'\" the build enginer library.  If you're reading this [gnt]roff file
'\" with an eye towards patching this man page, you can still submit
'\" a diff against this text, but it will have to be translated to a
'\" diff against the underlying .xml file before the patch is actually
'\" accepted.  If you do that yourself, it will make it easier to
'\" integrate the patch.
'\"
'\" END GENERATED FUNCTION DESCRIPTIONS
'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""

.SS SConscript Variables
In addition to the global functions and methods,
.B scons
supports a number of Python variables
that can be used in SConscript files
to affect how you want the build to be performed.
These variables may be accessed from custom Python modules that you
import into an SConscript file by adding the following
to the Python module:

.ES
from SCons.Script import *
.EE

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.TP
ARGLIST
A list
.IR keyword = value
arguments specified on the command line.
Each element in the list is a tuple
containing the
.RI ( keyword , value )
of the argument.
The separate
.I keyword
and
.I value
elements of the tuple
can be accessed by
subscripting for element
.B [0]
and
.B [1]
of the tuple, respectively.

Example:

.ES
print "first keyword, value =", ARGLIST[0][0], ARGLIST[0][1]
print "second keyword, value =", ARGLIST[1][0], ARGLIST[1][1]
third_tuple = ARGLIST[2]
print "third keyword, value =", third_tuple[0], third_tuple[1]
for key, value in ARGLIST:
    # process key and value
.EE

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.TP
ARGUMENTS
A dictionary of all the
.IR keyword = value
arguments specified on the command line.
The dictionary is not in order,
and if a given keyword has
more than one value assigned to it
on the command line,
the last (right-most) value is
the one in the
.B ARGUMENTS
dictionary.

Example:

.ES
if ARGUMENTS.get('debug', 0):
    env = Environment(CCFLAGS = '-g')
else:
    env = Environment()
.EE

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.TP
BUILD_TARGETS
A list of the targets which
.B scons
will actually try to build,
regardless of whether they were specified on
the command line or via the
.BR Default ()
function or method.
The elements of this list may be strings
.I or
nodes, so you should run the list through the Python
.B str
function to make sure any Node path names
are converted to strings.

Because this list may be taken from the
list of targets specified using the
.BR Default ()
function or method,
the contents of the list may change
on each successive call to
.BR Default ().
See the
.B DEFAULT_TARGETS
list, below,
for additional information.

Example:

.ES
if 'foo' in BUILD_TARGETS:
    print "Don't forget to test the `foo' program!"
if 'special/program' in BUILD_TARGETS:
    SConscript('special')
.EE
.IP
Note that the
.B BUILD_TARGETS
list only contains targets expected listed
on the command line or via calls to the
.BR Default ()
function or method.
It does
.I not
contain all dependent targets that will be built as
a result of making the sure the explicitly-specified
targets are up to date.

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.TP
COMMAND_LINE_TARGETS
A list of the targets explicitly specified on
the command line.
If there are no targets specified on the command line,
the list is empty.
This can be used, for example,
to take specific actions only
when a certain target or targets
is explicitly being built.

Example:

.ES
if 'foo' in COMMAND_LINE_TARGETS:
    print "Don't forget to test the `foo' program!"
if 'special/program' in COMMAND_LINE_TARGETS:
    SConscript('special')
.EE

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.TP
DEFAULT_TARGETS
A list of the target
.I nodes
that have been specified using the
.BR Default ()
function or method.
The elements of the list are nodes,
so you need to run them through the Python
.B str
function to get at the path name for each Node.

Example:

.ES
print str(DEFAULT_TARGETS[0])
if 'foo' in map(str, DEFAULT_TARGETS):
    print "Don't forget to test the `foo' program!"
.EE
.IP
The contents of the
.B DEFAULT_TARGETS
list change on on each successive call to the
.BR Default ()
function:

.ES
print map(str, DEFAULT_TARGETS)   # originally []
Default('foo')
print map(str, DEFAULT_TARGETS)   # now a node ['foo']
Default('bar')
print map(str, DEFAULT_TARGETS)   # now a node ['foo', 'bar']
Default(None)
print map(str, DEFAULT_TARGETS)   # back to []
.EE
.IP
Consequently, be sure to use
.B DEFAULT_TARGETS
only after you've made all of your
.BR Default ()
calls,
or else simply be careful of the order
of these statements in your SConscript files
so that you don't look for a specific
default target before it's actually been added to the list.

.SS Construction Variables
.\" XXX From Gary Ruben, 23 April 2002:
.\" I think it would be good to have an example with each construction
.\" variable description in the documentation.
.\" eg.
.\" CC     The C compiler
.\"    Example: env["CC"] = "c68x"
.\"    Default: env["CC"] = "cc"
.\"
.\" CCCOM  The command line ...
.\"    Example:
.\"        To generate the compiler line c68x -ps -qq -mr -o $TARGET $SOURCES
.\"        env["CC"] = "c68x"
.\"        env["CFLAGS"] = "-ps -qq -mr"
.\"        env["CCCOM"] = "$CC $CFLAGS -o $TARGET $SOURCES
.\"    Default:
.\"        (I dunno what this is ;-)
A construction environment has an associated dictionary of
.I construction variables
that are used by built-in or user-supplied build rules.
Construction variables must follow the same rules for
Python identifiers:
the initial character must be an underscore or letter,
followed by any number of underscores, letters, or digits.

A number of useful construction variables are automatically defined by
scons for each supported platform, and additional construction variables
can be defined by the user. The following is a list of the automatically
defined construction variables:

'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
'\" BEGIN GENERATED CONSTRUCTION VARIABLE DESCRIPTIONS
'\"
'\" The descriptions below of the various SCons construction variables
'\" are generated from the .xml files that live next to the various
'\" Python modules in the build enginer library.  If you're reading
'\" this [gnt]roff file with an eye towards patching this man page,
'\" you can still submit a diff against this text, but it will have to
'\" be translated to a diff against the underlying .xml file before the
'\" patch is actually accepted.  If you do that yourself, it will make
'\" it easier to integrate the patch.
'\"
'\" BEGIN GENERATED CONSTRUCTION VARIABLE DESCRIPTIONS
'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""

.IP AR
The static library archiver.

.IP ARCHITECTURE
Specifies the system architecture for which
the package is being built.
The default is the system architecture
of the machine on which SCons is running.
This is used to fill in the
.B Architecture:
field in an Ipkg
\fBcontrol\fP file,
and as part of the name of a generated RPM file.

.IP ARCOM
The command line used to generate a static library from object files.

.IP ARCOMSTR
The string displayed when an object file
is generated from an assembly-language source file.
If this is not set, then \fB$ARCOM\fP (the command line) is displayed.

.ES
env = Environment(ARCOMSTR = "Archiving $TARGET")
.EE

.IP ARFLAGS
General options passed to the static library archiver.

.IP AS
The assembler.

.IP ASCOM
The command line used to generate an object file
from an assembly-language source file.

.IP ASCOMSTR
The string displayed when an object file
is generated from an assembly-language source file.
If this is not set, then \fB$ASCOM\fP (the command line) is displayed.

.ES
env = Environment(ASCOMSTR = "Assembling $TARGET")
.EE

.IP ASFLAGS
General options passed to the assembler.

.IP ASPPCOM
The command line used to assemble an assembly-language
source file into an object file
after first running the file through the C preprocessor.
Any options specified
in the \fB$ASFLAGS\fP and \fB$CPPFLAGS\fP construction variables
are included on this command line.

.IP ASPPCOMSTR
The string displayed when an object file
is generated from an assembly-language source file
after first running the file through the C preprocessor.
If this is not set, then \fB$ASPPCOM\fP (the command line) is displayed.

.ES
env = Environment(ASPPCOMSTR = "Assembling $TARGET")
.EE

.IP ASPPFLAGS
General options when an assembling an assembly-language
source file into an object file
after first running the file through the C preprocessor.
The default is to use the value of \fB$ASFLAGS\fP.

.IP BIBTEX
The bibliography generator for the TeX formatter and typesetter and the
LaTeX structured formatter and typesetter.

.IP BIBTEXCOM
The command line used to call the bibliography generator for the
TeX formatter and typesetter and the LaTeX structured formatter and
typesetter.

.IP BIBTEXCOMSTR
The string displayed when generating a bibliography
for TeX or LaTeX.
If this is not set, then \fB$BIBTEXCOM\fP (the command line) is displayed.

.ES
env = Environment(BIBTEXCOMSTR = "Generating bibliography $TARGET")
.EE

.IP BIBTEXFLAGS
General options passed to the bibliography generator for the TeX formatter
and typesetter and the LaTeX structured formatter and typesetter.

.IP BITKEEPER
The BitKeeper executable.

.IP BITKEEPERCOM
The command line for
fetching source files using BitKeeper.

.IP BITKEEPERCOMSTR
The string displayed when fetching
a source file using BitKeeper.
If this is not set, then \fB$BITKEEPERCOM\fP
(the command line) is displayed.

.IP BITKEEPERGET
The command (\fB$BITKEEPER\fP) and subcommand
for fetching source files using BitKeeper.

.IP BITKEEPERGETFLAGS
Options that are passed to the BitKeeper
.B get
subcommand.

.IP BUILDERS
A dictionary mapping the names of the builders
available through this environment
to underlying Builder objects.
Builders named
Alias, CFile, CXXFile, DVI, Library, Object, PDF, PostScript, and Program
are available by default.
If you initialize this variable when an
Environment is created:

.ES
env = Environment(BUILDERS = {'NewBuilder' : foo})
.EE
.IP
the default Builders will no longer be available.
To use a new Builder object in addition to the default Builders,
add your new Builder object like this:

.ES
env = Environment()
env.Append(BUILDERS = {'NewBuilder' : foo})
.EE
.IP
or this:

.ES
env = Environment()
env['BUILDERS]['NewBuilder'] = foo
.EE

.IP CC
The C compiler.

.IP CCCOM
The command line used to compile a C source file to a (static) object
file.  Any options specified in the \fB$CFLAGS\fP, \fB$CCFLAGS\fP and
\fB$CPPFLAGS\fP construction variables are included on this command
line.

.IP CCCOMSTR
The string displayed when a C source file
is compiled to a (static) object file.
If this is not set, then \fB$CCCOM\fP (the command line) is displayed.

.ES
env = Environment(CCCOMSTR = "Compiling static object $TARGET")
.EE

.IP CCFLAGS
General options that are passed to the C and C++ compilers.

.IP CCPCHFLAGS
Options added to the compiler command line
to support building with precompiled headers.
The default value expands expands to the appropriate
Microsoft Visual C++ command-line options
when the \fB$PCH\fP construction variable is set.

.IP CCPDBFLAGS
Options added to the compiler command line
to support storing debugging information in a
Microsoft Visual C++ PDB file.
The default value expands expands to appropriate
Microsoft Visual C++ command-line options
when the \fB$PDB\fP construction variable is set.

The Visual C++ compiler option that SCons uses by default
to generate PDB information is \fB/Z7\fP.
This works correctly with parallel (\fB\-j\fP) builds
because it embeds the debug information in the intermediate object files,
as opposed to sharing a single PDB file between multiple object files.
This is also the only way to get debug information
embedded into a static library.
Using the \fB/Zi\fP instead may yield improved
link-time performance,
although parallel builds will no longer work.

You can generate PDB files with the \fB/Zi\fP
switch by overriding the default \fB$CCPDBFLAGS\fP variable as follows:

.ES
env['CCPDBFLAGS'] = ['${(PDB and "/Zi /Fd%s" % File(PDB)) or ""}']
.EE
.IP
An alternative would be to use the \fB/Zi\fP
to put the debugging information in a separate \fB.pdb\fP
file for each object file by overriding
the \fB$CCPDBFLAGS\fP variable as follows:

.ES
env['CCPDBFLAGS'] = '/Zi /Fd${TARGET}.pdb'
.EE

.IP CCVERSION
The version number of the C compiler.
This may or may not be set,
depending on the specific C compiler being used.

.IP CFILESUFFIX
The suffix for C source files.
This is used by the internal CFile builder
when generating C files from Lex (.l) or YACC (.y) input files.
The default suffix, of course, is
.B .c
(lower case).
On case-insensitive systems (like Windows),
SCons also treats
.B .C
(upper case) files
as C files.

.IP CFLAGS
General options that are passed to the C compiler (C only; not C++).

.IP CHANGE_SPECFILE
A hook for modifying the file that controls the packaging build
(the \fB.spec\fP for RPM,
the \fBcontrol\fP for Ipkg,
the \fB.wxs\fP for MSI).
If set, the function will be called
after the SCons template for the file has been written.
XXX

.IP CHANGED_SOURCES
A reserved variable name
that may not be set or used in a construction environment.
(See "Variable Substitution," below.)

.IP CHANGED_TARGETS
A reserved variable name
that may not be set or used in a construction environment.
(See "Variable Substitution," below.)

.IP CHANGELOG
The name of a file containing the change log text
to be included in the package.
This is included as the
.B %changelog
section of the RPM
\fB.spec\fP file.

.IP _concat
A function used to produce variables like \fB$_CPPINCFLAGS\fP. It takes
four or five
arguments: a prefix to concatenate onto each element, a list of
elements, a suffix to concatenate onto each element, an environment
for variable interpolation, and an optional function that will be
called to transform the list before concatenation.

.ES
env['_CPPINCFLAGS'] = '$( ${_concat(INCPREFIX, CPPPATH, INCSUFFIX, __env__, RDirs)} $)',
.EE

.IP CONFIGUREDIR
The name of the directory in which
Configure context test files are written.
The default is
.B .sconf_temp
in the top-level directory
containing the
.B SConstruct
file.

.IP CONFIGURELOG
The name of the Configure context log file.
The default is
.B config.log
in the top-level directory
containing the
.B SConstruct
file.

.IP _CPPDEFFLAGS
An automatically-generated construction variable
containing the C preprocessor command-line options
to define values.
The value of \fB$_CPPDEFFLAGS\fP is created
by appending \fB$CPPDEFPREFIX\fP and \fB$CPPDEFSUFFIX\fP
to the beginning and end
of each definition in \fB$CPPDEFINES\fP.

.IP CPPDEFINES
A platform independent specification of C preprocessor definitions.
The definitions will be added to command lines
through the automatically-generated
\fB$_CPPDEFFLAGS\fP construction variable (see above),
which is constructed according to
the type of value of \fB$CPPDEFINES\fP:

If \fB$CPPDEFINES\fP is a string,
the values of the
.BR $CPPDEFPREFIX  and  $CPPDEFSUFFIX
construction variables
will be added to the beginning and end.

.ES
# Will add -Dxyz to POSIX compiler command lines,
# and /Dxyz to Microsoft Visual C++ command lines.
env = Environment(CPPDEFINES='xyz')
.EE
.IP
If \fB$CPPDEFINES\fP is a list,
the values of the
.BR $CPPDEFPREFIX  and  $CPPDEFSUFFIX
construction variables
will be appended to the beginning and end
of each element in the list.
If any element is a list or tuple,
then the first item is the name being
defined and the second item is its value:

.ES
# Will add -DB=2 -DA to POSIX compiler command lines,
# and /DB=2 /DA to Microsoft Visual C++ command lines.
env = Environment(CPPDEFINES=[('B', 2), 'A'])
.EE
.IP
If \fB$CPPDEFINES\fP is a dictionary,
the values of the
.BR $CPPDEFPREFIX  and  $CPPDEFSUFFIX
construction variables
will be appended to the beginning and end
of each item from the dictionary.
The key of each dictionary item
is a name being defined
to the dictionary item's corresponding value;
if the value is
.BR None ,
then the name is defined without an explicit value.
Note that the resulting flags are sorted by keyword
to ensure that the order of the options on the
command line is consistent each time
.B scons
is run.

.ES
# Will add -DA -DB=2 to POSIX compiler command lines,
# and /DA /DB=2 to Microsoft Visual C++ command lines.
env = Environment(CPPDEFINES={'B':2, 'A':None})
.EE

.IP CPPDEFPREFIX
The prefix used to specify preprocessor definitions
on the C compiler command line.
This will be appended to the beginning of each definition
in the \fB$CPPDEFINES\fP construction variable
when the \fB$_CPPDEFFLAGS\fP variable is automatically generated.

.IP CPPDEFSUFFIX
The suffix used to specify preprocessor definitions
on the C compiler command line.
This will be appended to the end of each definition
in the \fB$CPPDEFINES\fP construction variable
when the \fB$_CPPDEFFLAGS\fP variable is automatically generated.

.IP CPPFLAGS
User-specified C preprocessor options.
These will be included in any command that uses the C preprocessor,
including not just compilation of C and C++ source files
via the \fB$CCCOM\fP,
.BR $SHCCCOM ,
\fB$CXXCOM\fP and
\fB$SHCXXCOM\fP command lines,
but also the \fB$FORTRANPPCOM\fP,
.BR $SHFORTRANPPCOM ,
\fB$F77PPCOM\fP and
\fB$SHF77PPCOM\fP command lines
used to compile a Fortran source file,
and the \fB$ASPPCOM\fP command line
used to assemble an assembly language source file,
after first running each file through the C preprocessor.
Note that this variable does
.I not
contain
.B \-I
(or similar) include search path options
that scons generates automatically from \fB$CPPPATH\fP.
See \fB$_CPPINCFLAGS\fP, below,
for the variable that expands to those options.

.IP _CPPINCFLAGS
An automatically-generated construction variable
containing the C preprocessor command-line options
for specifying directories to be searched for include files.
The value of \fB$_CPPINCFLAGS\fP is created
by appending \fB$INCPREFIX\fP and \fB$INCSUFFIX\fP
to the beginning and end
of each directory in \fB$CPPPATH\fP.

.IP CPPPATH
The list of directories that the C preprocessor will search for include
directories. The C/C++ implicit dependency scanner will search these
directories for include files. Don't explicitly put include directory
arguments in CCFLAGS or CXXFLAGS because the result will be non-portable
and the directories will not be searched by the dependency scanner. Note:
directory names in CPPPATH will be looked-up relative to the SConscript
directory when they are used in a command. To force
.B scons
to look-up a directory relative to the root of the source tree use #:

.ES
env = Environment(CPPPATH='#/include')
.EE
.IP
The directory look-up can also be forced using the
.BR Dir ()
function:

.ES
include = Dir('include')
env = Environment(CPPPATH=include)
.EE
.IP
The directory list will be added to command lines
through the automatically-generated
.B $_CPPINCFLAGS
construction variable,
which is constructed by
appending the values of the
.BR $INCPREFIX  and  $INCSUFFIX
construction variables
to the beginning and end
of each directory in \fB$CPPPATH\fP.
Any command lines you define that need
the CPPPATH directory list should
include \fB$_CPPINCFLAGS\fP:

.ES
env = Environment(CCCOM="my_compiler $_CPPINCFLAGS -c -o $TARGET $SOURCE")
.EE

.IP CPPSUFFIXES
The list of suffixes of files that will be scanned
for C preprocessor implicit dependencies
(#include lines).
The default list is:

.ES
[".c", ".C", ".cxx", ".cpp", ".c++", ".cc",
 ".h", ".H", ".hxx", ".hpp", ".hh",
 ".F", ".fpp", ".FPP",
 ".m", ".mm",
 ".S", ".spp", ".SPP"]
.EE

.IP CVS
The CVS executable.

.IP CVSCOFLAGS
Options that are passed to the CVS checkout subcommand.

.IP CVSCOM
The command line used to
fetch source files from a CVS repository.

.IP CVSCOMSTR
The string displayed when fetching
a source file from a CVS repository.
If this is not set, then \fB$CVSCOM\fP
(the command line) is displayed.

.IP CVSFLAGS
General options that are passed to CVS.
By default, this is set to
.B "-d $CVSREPOSITORY"
to specify from where the files must be fetched.

.IP CVSREPOSITORY
The path to the CVS repository.
This is referenced in the default
\fB$CVSFLAGS\fP value.

.IP CXX
The C++ compiler.

.IP CXXCOM
The command line used to compile a C++ source file to an object file.
Any options specified in the \fB$CXXFLAGS\fP and
\fB$CPPFLAGS\fP construction variables
are included on this command line.

.IP CXXCOMSTR
The string displayed when a C++ source file
is compiled to a (static) object file.
If this is not set, then \fB$CXXCOM\fP (the command line) is displayed.

.ES
env = Environment(CXXCOMSTR = "Compiling static object $TARGET")
.EE

.IP CXXFILESUFFIX
The suffix for C++ source files.
This is used by the internal CXXFile builder
when generating C++ files from Lex (.ll) or YACC (.yy) input files.
The default suffix is
.BR .cc .
SCons also treats files with the suffixes
.BR .cpp ,
.BR .cxx ,
.BR .c++ ,
and
.B .C++
as C++ files,
and files with
.B .mm
suffixes as Objective C++ files.
On case-sensitive systems (Linux, UNIX, and other POSIX-alikes),
SCons also treats
.B .C
(upper case) files
as C++ files.

.IP CXXFLAGS
General options that are passed to the C++ compiler.
By default, this includes the value of \fB$CCFLAGS\fP,
so that setting \fB$CCFLAGS\fP affects both C and C++ compilation.
If you want to add C++-specific flags,
you must set or override the value of \fB$CXXFLAGS\fP.

.IP CXXVERSION
The version number of the C++ compiler.
This may or may not be set,
depending on the specific C++ compiler being used.

.IP DESCRIPTION
A long description of the project being packaged.
This is included in the relevant section
of the file that controls the packaging build.

.IP DESCRIPTION_lang
A language-specific long description for
the specified \fIlang\fP.
This is used to populate a
.B "%description -l"
section of an RPM
\fB.spec\fP file.

.IP Dir
A function that converts a string
into a Dir instance relative to the target being built.

.IP Dirs
A function that converts a list of strings
into a list of Dir instances relative to the target being built.

.IP DSUFFIXES
The list of suffixes of files that will be scanned
for imported D package files.
The default list is:

.ES
['.d']
.EE

.IP DVIPDF
The TeX DVI file to PDF file converter.

.IP DVIPDFCOM
The command line used to convert TeX DVI files into a PDF file.

.IP DVIPDFCOMSTR
The string displayed when a TeX DVI file
is converted into a PDF file.
If this is not set, then \fB$DVIPDFCOM\fP (the command line) is displayed.

.IP DVIPDFFLAGS
General options passed to the TeX DVI file to PDF file converter.

.IP DVIPS
The TeX DVI file to PostScript converter.

.IP DVIPSFLAGS
General options passed to the TeX DVI file to PostScript converter.

.IP ENV
A dictionary of environment variables
to use when invoking commands. When
\fB$ENV\fP is used in a command all list
values will be joined using the path separator and any other non-string
values will simply be coerced to a string.
Note that, by default,
.B scons
does
.I not
propagate the environment in force when you
execute
.B scons
to the commands used to build target files.
This is so that builds will be guaranteed
repeatable regardless of the environment
variables set at the time
.B scons
is invoked.

If you want to propagate your
environment variables
to the commands executed
to build target files,
you must do so explicitly:

.ES
import os
env = Environment(ENV = os.environ)
.EE
.IP
Note that you can choose only to propagate
certain environment variables.
A common example is
the system
.B PATH
environment variable,
so that
.B scons
uses the same utilities
as the invoking shell (or other process):

.ES
import os
env = Environment(ENV = {'PATH' : os.environ['PATH']})
.EE

.IP ESCAPE
A function that will be called to escape shell special characters in
command lines. The function should take one argument: the command line
string to escape; and should return the escaped command line.

.IP F77
The Fortran 77 compiler.
You should normally set the \fB$FORTRAN\fP variable,
which specifies the default Fortran compiler
for all Fortran versions.
You only need to set \fB$F77\fP if you need to use a specific compiler
or compiler version for Fortran 77 files.

.IP F77COM
The command line used to compile a Fortran 77 source file to an object file.
You only need to set \fB$F77COM\fP if you need to use a specific
command line for Fortran 77 files.
You should normally set the \fB$FORTRANCOM\fP variable,
which specifies the default command line
for all Fortran versions.

.IP F77COMSTR
The string displayed when a Fortran 77 source file
is compiled to an object file.
If this is not set, then \fB$F77COM\fP or \fB$FORTRANCOM\fP
(the command line) is displayed.

.IP F77FILESUFFIXES
The list of file extensions for which the F77 dialect will be used. By
default, this is ['.f77']

.IP F77FLAGS
General user-specified options that are passed to the Fortran 77 compiler.
Note that this variable does
.I not
contain
.B \-I
(or similar) include search path options
that scons generates automatically from \fB$F77PATH\fP.
See
.B $_F77INCFLAGS
below,
for the variable that expands to those options.
You only need to set \fB$F77FLAGS\fP if you need to define specific
user options for Fortran 77 files.
You should normally set the \fB$FORTRANFLAGS\fP variable,
which specifies the user-specified options
passed to the default Fortran compiler
for all Fortran versions.

.IP _F77INCFLAGS
An automatically-generated construction variable
containing the Fortran 77 compiler command-line options
for specifying directories to be searched for include files.
The value of \fB$_F77INCFLAGS\fP is created
by appending \fB$INCPREFIX\fP and \fB$INCSUFFIX\fP
to the beginning and end
of each directory in \fB$F77PATH\fP.

.IP F77PATH
The list of directories that the Fortran 77 compiler will search for include
directories. The implicit dependency scanner will search these
directories for include files. Don't explicitly put include directory
arguments in \fB$F77FLAGS\fP because the result will be non-portable
and the directories will not be searched by the dependency scanner. Note:
directory names in \fB$F77PATH\fP will be looked-up relative to the SConscript
directory when they are used in a command. To force
.B scons
to look-up a directory relative to the root of the source tree use #:
You only need to set \fB$F77PATH\fP if you need to define a specific
include path for Fortran 77 files.
You should normally set the \fB$FORTRANPATH\fP variable,
which specifies the include path
for the default Fortran compiler
for all Fortran versions.

.ES
env = Environment(F77PATH='#/include')
.EE
.IP
The directory look-up can also be forced using the
.BR Dir ()
function:

.ES
include = Dir('include')
env = Environment(F77PATH=include)
.EE
.IP
The directory list will be added to command lines
through the automatically-generated
.B $_F77INCFLAGS
construction variable,
which is constructed by
appending the values of the
.BR $INCPREFIX  and  $INCSUFFIX
construction variables
to the beginning and end
of each directory in \fB$F77PATH\fP.
Any command lines you define that need
the F77PATH directory list should
include \fB$_F77INCFLAGS\fP:

.ES
env = Environment(F77COM="my_compiler $_F77INCFLAGS -c -o $TARGET $SOURCE")
.EE

.IP F77PPCOM
The command line used to compile a Fortran 77 source file to an object file
after first running the file through the C preprocessor.
Any options specified in the \fB$F77FLAGS\fP and \fB$CPPFLAGS\fP construction variables
are included on this command line.
You only need to set \fB$F77PPCOM\fP if you need to use a specific
C-preprocessor command line for Fortran 77 files.
You should normally set the \fB$FORTRANPPCOM\fP variable,
which specifies the default C-preprocessor command line
for all Fortran versions.

.IP F77PPCOMSTR
The string displayed when a Fortran 77 source file
is compiled to an object file
after first running the file through the C preprocessor.
If this is not set, then \fB$F77PPCOM\fP or \fB$FORTRANPPCOM\fP
(the command line) is displayed.

.IP F77PPFILESUFFIXES
The list of file extensions for which the compilation + preprocessor pass for
F77 dialect will be used. By default, this is empty

.IP F90
The Fortran 90 compiler.
You should normally set the \fB$FORTRAN\fP variable,
which specifies the default Fortran compiler
for all Fortran versions.
You only need to set \fB$F90\fP if you need to use a specific compiler
or compiler version for Fortran 90 files.

.IP F90COM
The command line used to compile a Fortran 90 source file to an object file.
You only need to set \fB$F90COM\fP if you need to use a specific
command line for Fortran 90 files.
You should normally set the \fB$FORTRANCOM\fP variable,
which specifies the default command line
for all Fortran versions.

.IP F90COMSTR
The string displayed when a Fortran 90 source file
is compiled to an object file.
If this is not set, then \fB$F90COM\fP or \fB$FORTRANCOM\fP
(the command line) is displayed.

.IP F90FILESUFFIXES
The list of file extensions for which the F90 dialect will be used. By
default, this is ['.f90']

.IP F90FLAGS
General user-specified options that are passed to the Fortran 90 compiler.
Note that this variable does
.I not
contain
.B \-I
(or similar) include search path options
that scons generates automatically from \fB$F90PATH\fP.
See
.B $_F90INCFLAGS
below,
for the variable that expands to those options.
You only need to set \fB$F90FLAGS\fP if you need to define specific
user options for Fortran 90 files.
You should normally set the \fB$FORTRANFLAGS\fP variable,
which specifies the user-specified options
passed to the default Fortran compiler
for all Fortran versions.

.IP _F90INCFLAGS
An automatically-generated construction variable
containing the Fortran 90 compiler command-line options
for specifying directories to be searched for include files.
The value of \fB$_F90INCFLAGS\fP is created
by appending \fB$INCPREFIX\fP and \fB$INCSUFFIX\fP
to the beginning and end
of each directory in \fB$F90PATH\fP.

.IP F90PATH
The list of directories that the Fortran 90 compiler will search for include
directories. The implicit dependency scanner will search these
directories for include files. Don't explicitly put include directory
arguments in \fB$F90FLAGS\fP because the result will be non-portable
and the directories will not be searched by the dependency scanner. Note:
directory names in \fB$F90PATH\fP will be looked-up relative to the SConscript
directory when they are used in a command. To force
.B scons
to look-up a directory relative to the root of the source tree use #:
You only need to set \fB$F90PATH\fP if you need to define a specific
include path for Fortran 90 files.
You should normally set the \fB$FORTRANPATH\fP variable,
which specifies the include path
for the default Fortran compiler
for all Fortran versions.

.ES
env = Environment(F90PATH='#/include')
.EE
.IP
The directory look-up can also be forced using the
.BR Dir ()
function:

.ES
include = Dir('include')
env = Environment(F90PATH=include)
.EE
.IP
The directory list will be added to command lines
through the automatically-generated
.B $_F90INCFLAGS
construction variable,
which is constructed by
appending the values of the
.BR $INCPREFIX  and  $INCSUFFIX
construction variables
to the beginning and end
of each directory in \fB$F90PATH\fP.
Any command lines you define that need
the F90PATH directory list should
include \fB$_F90INCFLAGS\fP:

.ES
env = Environment(F90COM="my_compiler $_F90INCFLAGS -c -o $TARGET $SOURCE")
.EE

.IP F90PPCOM
The command line used to compile a Fortran 90 source file to an object file
after first running the file through the C preprocessor.
Any options specified in the \fB$F90FLAGS\fP and \fB$CPPFLAGS\fP construction variables
are included on this command line.
You only need to set \fB$F90PPCOM\fP if you need to use a specific
C-preprocessor command line for Fortran 90 files.
You should normally set the \fB$FORTRANPPCOM\fP variable,
which specifies the default C-preprocessor command line
for all Fortran versions.

.IP F90PPCOMSTR
The string displayed when a Fortran 90 source file
is compiled after first running the file through the C preprocessor.
If this is not set, then \fB$F90PPCOM\fP or \fB$FORTRANPPCOM\fP
(the command line) is displayed.

.IP F90PPFILESUFFIXES
The list of file extensions for which the compilation + preprocessor pass for
F90 dialect will be used. By default, this is empty

.IP F95
The Fortran 95 compiler.
You should normally set the \fB$FORTRAN\fP variable,
which specifies the default Fortran compiler
for all Fortran versions.
You only need to set \fB$F95\fP if you need to use a specific compiler
or compiler version for Fortran 95 files.

.IP F95COM
The command line used to compile a Fortran 95 source file to an object file.
You only need to set \fB$F95COM\fP if you need to use a specific
command line for Fortran 95 files.
You should normally set the \fB$FORTRANCOM\fP variable,
which specifies the default command line
for all Fortran versions.

.IP F95COMSTR
The string displayed when a Fortran 95 source file
is compiled to an object file.
If this is not set, then \fB$F95COM\fP or \fB$FORTRANCOM\fP
(the command line) is displayed.

.IP F95FILESUFFIXES
The list of file extensions for which the F95 dialect will be used. By
default, this is ['.f95']

.IP F95FLAGS
General user-specified options that are passed to the Fortran 95 compiler.
Note that this variable does
.I not
contain
.B \-I
(or similar) include search path options
that scons generates automatically from \fB$F95PATH\fP.
See
.B $_F95INCFLAGS
below,
for the variable that expands to those options.
You only need to set \fB$F95FLAGS\fP if you need to define specific
user options for Fortran 95 files.
You should normally set the \fB$FORTRANFLAGS\fP variable,
which specifies the user-specified options
passed to the default Fortran compiler
for all Fortran versions.

.IP _F95INCFLAGS
An automatically-generated construction variable
containing the Fortran 95 compiler command-line options
for specifying directories to be searched for include files.
The value of \fB$_F95INCFLAGS\fP is created
by appending \fB$INCPREFIX\fP and \fB$INCSUFFIX\fP
to the beginning and end
of each directory in \fB$F95PATH\fP.

.IP F95PATH
The list of directories that the Fortran 95 compiler will search for include
directories. The implicit dependency scanner will search these
directories for include files. Don't explicitly put include directory
arguments in \fB$F95FLAGS\fP because the result will be non-portable
and the directories will not be searched by the dependency scanner. Note:
directory names in \fB$F95PATH\fP will be looked-up relative to the SConscript
directory when they are used in a command. To force
.B scons
to look-up a directory relative to the root of the source tree use #:
You only need to set \fB$F95PATH\fP if you need to define a specific
include path for Fortran 95 files.
You should normally set the \fB$FORTRANPATH\fP variable,
which specifies the include path
for the default Fortran compiler
for all Fortran versions.

.ES
env = Environment(F95PATH='#/include')
.EE
.IP
The directory look-up can also be forced using the
.BR Dir ()
function:

.ES
include = Dir('include')
env = Environment(F95PATH=include)
.EE
.IP
The directory list will be added to command lines
through the automatically-generated
.B $_F95INCFLAGS
construction variable,
which is constructed by
appending the values of the
.BR $INCPREFIX  and  $INCSUFFIX
construction variables
to the beginning and end
of each directory in \fB$F95PATH\fP.
Any command lines you define that need
the F95PATH directory list should
include \fB$_F95INCFLAGS\fP:

.ES
env = Environment(F95COM="my_compiler $_F95INCFLAGS -c -o $TARGET $SOURCE")
.EE

.IP F95PPCOM
The command line used to compile a Fortran 95 source file to an object file
after first running the file through the C preprocessor.
Any options specified in the \fB$F95FLAGS\fP and \fB$CPPFLAGS\fP construction variables
are included on this command line.
You only need to set \fB$F95PPCOM\fP if you need to use a specific
C-preprocessor command line for Fortran 95 files.
You should normally set the \fB$FORTRANPPCOM\fP variable,
which specifies the default C-preprocessor command line
for all Fortran versions.

.IP F95PPCOMSTR
The string displayed when a Fortran 95 source file
is compiled to an object file
after first running the file through the C preprocessor.
If this is not set, then \fB$F95PPCOM\fP or \fB$FORTRANPPCOM\fP
(the command line) is displayed.

.IP F95PPFILESUFFIXES
The list of file extensions for which the compilation + preprocessor pass for
F95 dialect will be used. By default, this is empty

.IP File
A function that converts a string into a File instance relative to the
target being built.

.IP FORTRAN
The default Fortran compiler
for all versions of Fortran.

.IP FORTRANCOM
The command line used to compile a Fortran source file to an object file.
By default, any options specified
in the \fB$FORTRANFLAGS\fP,
.BR $CPPFLAGS ,
.BR $_CPPDEFFLAGS ,
\fB$_FORTRANMODFLAG\fP, and
\fB$_FORTRANINCFLAGS\fP construction variables
are included on this command line.

.IP FORTRANCOMSTR
The string displayed when a Fortran source file
is compiled to an object file.
If this is not set, then \fB$FORTRANCOM\fP
(the command line) is displayed.

.IP FORTRANFILESUFFIXES
The list of file extensions for which the FORTRAN dialect will be used. By
default, this is ['.f', '.for', '.ftn']

.IP FORTRANFLAGS
General user-specified options that are passed to the Fortran compiler.
Note that this variable does
.I not
contain
.B \-I
(or similar) include or module search path options
that scons generates automatically from \fB$FORTRANPATH\fP.
See
.BR $_FORTRANINCFLAGS\fP and \fB$_FORTRANMODFLAG ,
below,
for the variables that expand those options.

.IP _FORTRANINCFLAGS
An automatically-generated construction variable
containing the Fortran compiler command-line options
for specifying directories to be searched for include
files and module files.
The value of \fB$_FORTRANINCFLAGS\fP is created
by prepending/appending \fB$INCPREFIX\fP and \fB$INCSUFFIX\fP
to the beginning and end
of each directory in \fB$FORTRANPATH\fP.

.IP FORTRANMODDIR
Directory location where the Fortran compiler should place
any module files it generates.  This variable is empty, by default. Some
Fortran compilers will internally append this directory in the search path
for module files, as well.

.IP FORTRANMODDIRPREFIX
The prefix used to specify a module directory on the Fortran compiler command
line.
This will be appended to the beginning of the directory
in the \fB$FORTRANMODDIR\fP construction variables
when the \fB$_FORTRANMODFLAG\fP variables is automatically generated.

.IP FORTRANMODDIRSUFFIX
The suffix used to specify a module directory on the Fortran compiler command
line.
This will be appended to the beginning of the directory
in the \fB$FORTRANMODDIR\fP construction variables
when the \fB$_FORTRANMODFLAG\fP variables is automatically generated.

.IP _FORTRANMODFLAG
An automatically-generated construction variable
containing the Fortran compiler command-line option
for specifying the directory location where the Fortran
compiler should place any module files that happen to get
generated during compilation.
The value of \fB$_FORTRANMODFLAG\fP is created
by prepending/appending \fB$FORTRANMODDIRPREFIX\fP and
.B $FORTRANMODDIRSUFFIX
to the beginning and end of the directory in \fB$FORTRANMODDIR\fP.

.IP FORTRANMODPREFIX
The module file prefix used by the Fortran compiler.  SCons assumes that
the Fortran compiler follows the quasi-standard naming convention for
module files of
.BR module_name.mod .
As a result, this variable is left empty, by default.  For situations in
which the compiler does not necessarily follow the normal convention,
the user may use this variable.  Its value will be appended to every
module file name as scons attempts to resolve dependencies.

.IP FORTRANMODSUFFIX
The module file suffix used by the Fortran compiler.  SCons assumes that
the Fortran compiler follows the quasi-standard naming convention for
module files of
.BR module_name.mod .
As a result, this variable is set to ".mod", by default.  For situations
in which the compiler does not necessarily follow the normal convention,
the user may use this variable.  Its value will be appended to every
module file name as scons attempts to resolve dependencies.

.IP FORTRANPATH
The list of directories that the Fortran compiler will search for
include files and (for some compilers) module files. The Fortran implicit
dependency scanner will search these directories for include files (but
not module files since they are autogenerated and, as such, may not
actually exist at the time the scan takes place). Don't explicitly put
include directory arguments in FORTRANFLAGS because the result will be
non-portable and the directories will not be searched by the dependency
scanner. Note: directory names in FORTRANPATH will be looked-up relative
to the SConscript directory when they are used in a command. To force
.B scons
to look-up a directory relative to the root of the source tree use #:

.ES
env = Environment(FORTRANPATH='#/include')
.EE
.IP
The directory look-up can also be forced using the
.BR Dir ()
function:

.ES
include = Dir('include')
env = Environment(FORTRANPATH=include)
.EE
.IP
The directory list will be added to command lines
through the automatically-generated
.B $_FORTRANINCFLAGS
construction variable,
which is constructed by
appending the values of the
.BR $INCPREFIX  and  $INCSUFFIX
construction variables
to the beginning and end
of each directory in \fB$FORTRANPATH\fP.
Any command lines you define that need
the FORTRANPATH directory list should
include \fB$_FORTRANINCFLAGS\fP:

.ES
env = Environment(FORTRANCOM="my_compiler $_FORTRANINCFLAGS -c -o $TARGET $SOURCE")
.EE

.IP FORTRANPPCOM
The command line used to compile a Fortran source file to an object file
after first running the file through the C preprocessor.
By default, any options specified in the \fB$FORTRANFLAGS\fP,
.BR $CPPFLAGS ,
.BR $_CPPDEFFLAGS ,
\fB$_FORTRANMODFLAG\fP, and
.B $_FORTRANINCFLAGS
construction variables are included on this command line.

.IP FORTRANPPCOMSTR
The string displayed when a Fortran source file
is compiled to an object file
after first running the file through the C preprocessor.
If this is not set, then \fB$FORTRANPPCOM\fP
(the command line) is displayed.

.IP FORTRANPPFILESUFFIXES
The list of file extensions for which the compilation + preprocessor pass for
FORTRAN dialect will be used. By default, this is ['.fpp', '.FPP']

.IP FORTRANSUFFIXES
The list of suffixes of files that will be scanned
for Fortran implicit dependencies
(INCLUDE lines and USE statements).
The default list is:

.ES
[".f", ".F", ".for", ".FOR", ".ftn", ".FTN", ".fpp", ".FPP",
".f77", ".F77", ".f90", ".F90", ".f95", ".F95"]
.EE

.IP FRAMEWORKPATH
On Mac OS X with gcc,
a list containing the paths to search for frameworks.
Used by the compiler to find framework-style includes like
#include <Fmwk/Header.h>.
Used by the linker to find user-specified frameworks when linking (see
.BR $FRAMEWORKS ).
For example:

.ES
 env.AppendUnique(FRAMEWORKPATH='#myframeworkdir')
.EE
.IP
will add

.ES
  ... -Fmyframeworkdir
.EE
.IP
to the compiler and linker command lines.

.IP _FRAMEWORKPATH
On Mac OS X with gcc, an automatically-generated construction variable
containing the linker command-line options corresponding to
.BR $FRAMEWORKPATH .

.IP FRAMEWORKPATHPREFIX
On Mac OS X with gcc, the prefix to be used for the FRAMEWORKPATH entries.
(see \fB$FRAMEWORKPATH\fP).
The default value is
.BR \-F .

.IP FRAMEWORKPREFIX
On Mac OS X with gcc,
the prefix to be used for linking in frameworks
(see \fB$FRAMEWORKS\fP).
The default value is
.BR \-framework .

.IP _FRAMEWORKS
On Mac OS X with gcc,
an automatically-generated construction variable
containing the linker command-line options
for linking with FRAMEWORKS.

.IP FRAMEWORKS
On Mac OS X with gcc, a list of the framework names to be linked into a
program or shared library or bundle.
The default value is the empty list.
For example:

.ES
 env.AppendUnique(FRAMEWORKS=Split('System Cocoa SystemConfiguration'))
.EE
.IP

.IP FRAMEWORKSFLAGS
On Mac OS X with gcc,
general user-supplied frameworks options to be added at
the end of a command
line building a loadable module.
(This has been largely superseded by
the \fB$FRAMEWORKPATH\fP, \fB$FRAMEWORKPATHPREFIX\fP,
\fB$FRAMEWORKPREFIX\fP and \fB$FRAMEWORKS\fP variables
described above.)

.IP GS
The Ghostscript program used to convert PostScript to PDF files.

.IP GSCOM
The Ghostscript command line used to convert PostScript to PDF files.

.IP GSCOMSTR
The string displayed when
Ghostscript is used to convert
a PostScript file to a PDF file.
If this is not set, then \fB$GSCOM\fP (the command line) is displayed.

.IP GSFLAGS
General options passed to the Ghostscript program
when converting PostScript to PDF files.

.IP HOST_ARCH
Sets the host architecture for Visual Studio compiler. If not set,
default to the detected host architecture: note that this may depend
on the python you are using.
This variable must be passed as an argument to the Environment()
constructor; setting it later has no effect. 

Valid values are the same as for \fB$TARGET_ARCH\fP.

This is currently only used on Windows, but in the future it will be
used on other OSes as well.

.IP HOST_OS
        The name of the host operating system used to create the Environment.
        If a platform is specified when creating the Environment, then
        that Platform's logic will handle setting this value.
        This value is immutable, and should not be changed by the user after
        the Environment is initialized.
        Currently only set for Win32.
    
.IP IDLSUFFIXES
The list of suffixes of files that will be scanned
for IDL implicit dependencies
(#include or import lines).
The default list is:

.ES
[".idl", ".IDL"]
.EE

.IP IMPLICIT_COMMAND_DEPENDENCIES
Controls whether or not SCons will
add implicit dependencies for the commands
executed to build targets.

By default, SCons will add
to each target
an implicit dependency on the command
represented by the first argument on any
command line it executes.
The specific file for the dependency is
found by searching the
.I PATH
variable in the
.I ENV
environment used to execute the command.

If the construction variable
.B $IMPLICIT_COMMAND_DEPENDENCIES
is set to a false value
.RB ( None ,
.BR False ,
.BR 0 ,
etc.),
then the implicit dependency will
not be added to the targets
built with that construction environment.

.ES
env = Environment(IMPLICIT_COMMAND_DEPENDENCIES = 0)
.EE

.IP INCPREFIX
The prefix used to specify an include directory on the C compiler command
line.
This will be appended to the beginning of each directory
in the \fB$CPPPATH\fP and \fB$FORTRANPATH\fP construction variables
when the \fB$_CPPINCFLAGS\fP and \fB$_FORTRANINCFLAGS\fP
variables are automatically generated.

.IP INCSUFFIX
The suffix used to specify an include directory on the C compiler command
line.
This will be appended to the end of each directory
in the \fB$CPPPATH\fP and \fB$FORTRANPATH\fP construction variables
when the \fB$_CPPINCFLAGS\fP and \fB$_FORTRANINCFLAGS\fP
variables are automatically generated.

.IP INSTALL
A function to be called to install a file into a
destination file name.
The default function copies the file into the destination
(and sets the destination file's mode and permission bits
to match the source file's).
The function takes the following arguments:

.ES
def install(dest, source, env):
.EE
.IP
.I dest
is the path name of the destination file.
.I source
is the path name of the source file.
.I env
is the construction environment
(a dictionary of construction values)
in force for this file installation.

.IP INSTALLSTR
The string displayed when a file is
installed into a destination file name.
The default is:
.ES
Install file: "$SOURCE" as "$TARGET"
.EE

.IP INTEL_C_COMPILER_VERSION
Set by the "intelc" Tool
to the major version number of the Intel C compiler
selected for use.

.IP JAR
The Java archive tool.

.IP JARCHDIR
The directory to which the Java archive tool should change
(using the
.B \-C
option).

.IP JARCOM
The command line used to call the Java archive tool.

.IP JARCOMSTR
The string displayed when the Java archive tool
is called
If this is not set, then \fB$JARCOM\fP (the command line) is displayed.

.ES
env = Environment(JARCOMSTR = "JARchiving $SOURCES into $TARGET")
.EE

.IP JARFLAGS
General options passed to the Java archive tool.
By default this is set to
.B cf
to create the necessary
.B jar
file.

.IP JARSUFFIX
The suffix for Java archives:
.B .jar
by default.

.IP JAVABOOTCLASSPATH
Specifies the list of directories that
will be added to the
&javac; command line
via the \fB\-bootclasspath\fP option.
The individual directory names will be
separated by the operating system's path separate character
(\fB:\fP on UNIX/Linux/POSIX,
\fB;\fP on Windows).

.IP JAVAC
The Java compiler.

.IP JAVACCOM
The command line used to compile a directory tree containing
Java source files to
corresponding Java class files.
Any options specified in the \fB$JAVACFLAGS\fP construction variable
are included on this command line.

.IP JAVACCOMSTR
The string displayed when compiling
a directory tree of Java source files to
corresponding Java class files.
If this is not set, then \fB$JAVACCOM\fP (the command line) is displayed.

.ES
env = Environment(JAVACCOMSTR = "Compiling class files $TARGETS from $SOURCES")
.EE

.IP JAVACFLAGS
General options that are passed to the Java compiler.

.IP JAVACLASSDIR
The directory in which Java class files may be found.
This is stripped from the beginning of any Java .class
file names supplied to the
.B JavaH
builder.

.IP JAVACLASSPATH
Specifies the list of directories that
will be searched for Java
\fB.class\fP file.
The directories in this list will be added to the
&javac; and &javah; command lines
via the \fB\-classpath\fP option.
The individual directory names will be
separated by the operating system's path separate character
(\fB:\fP on UNIX/Linux/POSIX,
\fB;\fP on Windows).

Note that this currently just adds the specified
directory via the \fB\-classpath\fP option.
&SCons; does not currently search the
\fB$JAVACLASSPATH\fP directories for dependency
\fB.class\fP files.

.IP JAVACLASSSUFFIX
The suffix for Java class files;
.B .class
by default.

.IP JAVAH
The Java generator for C header and stub files.

.IP JAVAHCOM
The command line used to generate C header and stub files
from Java classes.
Any options specified in the \fB$JAVAHFLAGS\fP construction variable
are included on this command line.

.IP JAVAHCOMSTR
The string displayed when C header and stub files
are generated from Java classes.
If this is not set, then \fB$JAVAHCOM\fP (the command line) is displayed.

.ES
env = Environment(JAVAHCOMSTR = "Generating header/stub file(s) $TARGETS from $SOURCES")
.EE

.IP JAVAHFLAGS
General options passed to the C header and stub file generator
for Java classes.

.IP JAVASOURCEPATH
Specifies the list of directories that
will be searched for input
\fB.java\fP file.
The directories in this list will be added to the
&javac; command line
via the \fB\-sourcepath\fP option.
The individual directory names will be
separated by the operating system's path separate character
(\fB:\fP on UNIX/Linux/POSIX,
\fB;\fP on Windows).

Note that this currently just adds the specified
directory via the \fB\-sourcepath\fP option.
&SCons; does not currently search the
\fB$JAVASOURCEPATH\fP directories for dependency
\fB.java\fP files.

.IP JAVASUFFIX
The suffix for Java files;
.B .java
by default.

.IP JAVAVERSION
Specifies the Java version being used by the \fBJava\fP() builder.
This is \fInot\fP currently used to select one
version of the Java compiler vs. another.
Instead, you should set this to specify the version of Java
supported by your &javac; compiler.
The default is \fB1.4\fP.

This is sometimes necessary because
Java 1.5 changed the file names that are created
for nested anonymous inner classes,
which can cause a mismatch with the files
that &SCons; expects will be generated by the &javac; compiler.
Setting \fB$JAVAVERSION\fP to \fB1.5\fP
(or \fB1.6\fP, as appropriate)
can make &SCons; realize that a Java 1.5 or 1.6
build is actually up to date.

.IP LATEX
The LaTeX structured formatter and typesetter.

.IP LATEXCOM
The command line used to call the LaTeX structured formatter and typesetter.

.IP LATEXCOMSTR
The string displayed when calling
the LaTeX structured formatter and typesetter.
If this is not set, then \fB$LATEXCOM\fP (the command line) is displayed.

.ES
env = Environment(LATEXCOMSTR = "Building $TARGET from LaTeX input $SOURCES")
.EE

.IP LATEXFLAGS
General options passed to the LaTeX structured formatter and typesetter.

.IP LATEXRETRIES
The maximum number of times that LaTeX
will be re-run if the
.B .log
generated by the \fB$LATEXCOM\fP command
indicates that there are undefined references.
The default is to try to resolve undefined references
by re-running LaTeX up to three times.

.IP LATEXSUFFIXES
The list of suffixes of files that will be scanned
for LaTeX implicit dependencies
(\fB\\include\fP or \fB\\import\fP files).
The default list is:

.ES
[".tex", ".ltx", ".latex"]
.EE

.IP LDMODULE
The linker for building loadable modules.
By default, this is the same as \fB$SHLINK\fP.

.IP LDMODULECOM
The command line for building loadable modules.
On Mac OS X, this uses the \fB$LDMODULE\fP,
\fB$LDMODULEFLAGS\fP and
\fB$FRAMEWORKSFLAGS\fP variables.
On other systems, this is the same as \fB$SHLINK\fP.

.IP LDMODULECOMSTR
The string displayed when building loadable modules.
If this is not set, then \fB$LDMODULECOM\fP (the command line) is displayed.

.IP LDMODULEFLAGS
General user options passed to the linker for building loadable modules.

.IP LDMODULEPREFIX
The prefix used for loadable module file names.
On Mac OS X, this is null;
on other systems, this is
the same as \fB$SHLIBPREFIX\fP.

.IP LDMODULESUFFIX
The suffix used for loadable module file names.
On Mac OS X, this is null;
on other systems, this is
the same as $SHLIBSUFFIX.

.IP LEX
The lexical analyzer generator.

.IP LEXCOM
The command line used to call the lexical analyzer generator
to generate a source file.

.IP LEXCOMSTR
The string displayed when generating a source file
using the lexical analyzer generator.
If this is not set, then \fB$LEXCOM\fP (the command line) is displayed.

.ES
env = Environment(LEXCOMSTR = "Lex'ing $TARGET from $SOURCES")
.EE

.IP LEXFLAGS
General options passed to the lexical analyzer generator.

.IP _LIBDIRFLAGS
An automatically-generated construction variable
containing the linker command-line options
for specifying directories to be searched for library.
The value of \fB$_LIBDIRFLAGS\fP is created
by appending \fB$LIBDIRPREFIX\fP and \fB$LIBDIRSUFFIX\fP
to the beginning and end
of each directory in \fB$LIBPATH\fP.

.IP LIBDIRPREFIX
The prefix used to specify a library directory on the linker command line.
This will be appended to the beginning of each directory
in the \fB$LIBPATH\fP construction variable
when the \fB$_LIBDIRFLAGS\fP variable is automatically generated.

.IP LIBDIRSUFFIX
The suffix used to specify a library directory on the linker command line.
This will be appended to the end of each directory
in the \fB$LIBPATH\fP construction variable
when the \fB$_LIBDIRFLAGS\fP variable is automatically generated.

.IP LIBEMITTER
TODO

.IP _LIBFLAGS
An automatically-generated construction variable
containing the linker command-line options
for specifying libraries to be linked with the resulting target.
The value of \fB$_LIBFLAGS\fP is created
by appending \fB$LIBLINKPREFIX\fP and \fB$LIBLINKSUFFIX\fP
to the beginning and end
of each filename in \fB$LIBS\fP.

.IP LIBLINKPREFIX
The prefix used to specify a library to link on the linker command line.
This will be appended to the beginning of each library
in the \fB$LIBS\fP construction variable
when the \fB$_LIBFLAGS\fP variable is automatically generated.

.IP LIBLINKSUFFIX
The suffix used to specify a library to link on the linker command line.
This will be appended to the end of each library
in the \fB$LIBS\fP construction variable
when the \fB$_LIBFLAGS\fP variable is automatically generated.

.IP LIBPATH
The list of directories that will be searched for libraries.
The implicit dependency scanner will search these
directories for include files. Don't explicitly put include directory
arguments in \fB$LINKFLAGS\fP or \fB$SHLINKFLAGS\fP
because the result will be non-portable
and the directories will not be searched by the dependency scanner. Note:
directory names in LIBPATH will be looked-up relative to the SConscript
directory when they are used in a command. To force
.B scons
to look-up a directory relative to the root of the source tree use #:

.ES
env = Environment(LIBPATH='#/libs')
.EE
.IP
The directory look-up can also be forced using the
.BR Dir ()
function:

.ES
libs = Dir('libs')
env = Environment(LIBPATH=libs)
.EE
.IP
The directory list will be added to command lines
through the automatically-generated
.B $_LIBDIRFLAGS
construction variable,
which is constructed by
appending the values of the
.BR $LIBDIRPREFIX  and  $LIBDIRSUFFIX
construction variables
to the beginning and end
of each directory in \fB$LIBPATH\fP.
Any command lines you define that need
the LIBPATH directory list should
include \fB$_LIBDIRFLAGS\fP:

.ES
env = Environment(LINKCOM="my_linker $_LIBDIRFLAGS $_LIBFLAGS -o $TARGET $SOURCE")
.EE

.IP LIBPREFIX
The prefix used for (static) library file names.
A default value is set for each platform
(posix, win32, os2, etc.),
but the value is overridden by individual tools
(ar, mslib, sgiar, sunar, tlib, etc.)
to reflect the names of the libraries they create.

.IP LIBPREFIXES
A list of all legal prefixes for library file names.
When searching for library dependencies,
SCons will look for files with these prefixes,
the base library name,
and suffixes in the \fB$LIBSUFFIXES\fP list.

.IP LIBS
A list of one or more libraries
that will be linked with
any executable programs
created by this environment.

The library list will be added to command lines
through the automatically-generated
.B $_LIBFLAGS
construction variable,
which is constructed by
appending the values of the
.BR $LIBLINKPREFIX  and  $LIBLINKSUFFIX
construction variables
to the beginning and end
of each filename in \fB$LIBS\fP.
Any command lines you define that need
the LIBS library list should
include \fB$_LIBFLAGS\fP:

.ES
env = Environment(LINKCOM="my_linker $_LIBDIRFLAGS $_LIBFLAGS -o $TARGET $SOURCE")
.EE
.IP
If you add a
File
object to the
.B $LIBS
list, the name of that file will be added to
.BR $_LIBFLAGS ,
and thus the link line, as is, without
.B $LIBLINKPREFIX
or
.BR $LIBLINKSUFFIX .
For example:

.ES
env.Append(LIBS=File('/tmp/mylib.so'))
.EE
.IP
In all cases, scons will add dependencies from the executable program to
all the libraries in this list.

.IP LIBSUFFIX
The suffix used for (static) library file names.
A default value is set for each platform
(posix, win32, os2, etc.),
but the value is overridden by individual tools
(ar, mslib, sgiar, sunar, tlib, etc.)
to reflect the names of the libraries they create.

.IP LIBSUFFIXES
A list of all legal suffixes for library file names.
When searching for library dependencies,
SCons will look for files with prefixes, in the \fB$LIBPREFIXES\fP list,
the base library name,
and these suffixes.

.IP LICENSE
The abbreviated name of the license under which
this project is released (gpl, lpgl, bsd etc.).
See http://www.opensource.org/licenses/alphabetical
for a list of license names.

.IP LINESEPARATOR
The separator used by the \fBSubstfile\fP() and \fBTextfile\fP() builders.
This value is used between sources when constructing the target.
It defaults to the current system line separator.

.IP LINGUAS_FILE
The \fB$LINGUAS_FILE\fP defines file(s) containing list of additional linguas
to be processed by \fBPOInit\fP(), \fBPOUpdate\fP() or \fBMOFiles\fP()
builders. It also affects \fBTranslate\fP() builder. If the variable contains
a string, it defines name of the list file. The \fB$LINGUAS_FILE\fP may be a
list of file names as well. If \fB$LINGUAS_FILE\fP is set to
\fBTrue\fP (or non-zero numeric value), the list will be read from
default file named
.BR LINGUAS .


.IP LINK
The linker.

.IP LINKCOM
The command line used to link object files into an executable.

.IP LINKCOMSTR
The string displayed when object files
are linked into an executable.
If this is not set, then \fB$LINKCOM\fP (the command line) is displayed.

.ES
env = Environment(LINKCOMSTR = "Linking $TARGET")
.EE

.IP LINKFLAGS
General user options passed to the linker.
Note that this variable should
.I not
contain
.B \-l
(or similar) options for linking with the libraries listed in \fB$LIBS\fP,
nor
.B \-L
(or similar) library search path options
that scons generates automatically from \fB$LIBPATH\fP.
See
.B $_LIBFLAGS
above,
for the variable that expands to library-link options,
and
.B $_LIBDIRFLAGS
above,
for the variable that expands to library search path options.

.IP M4
The M4 macro preprocessor.

.IP M4COM
The command line used to pass files through the M4 macro preprocessor.

.IP M4COMSTR
The string displayed when
a file is passed through the M4 macro preprocessor.
If this is not set, then \fB$M4COM\fP (the command line) is displayed.

.IP M4FLAGS
General options passed to the M4 macro preprocessor.

.IP MAKEINDEX
The makeindex generator for the TeX formatter and typesetter and the
LaTeX structured formatter and typesetter.

.IP MAKEINDEXCOM
The command line used to call the makeindex generator for the
TeX formatter and typesetter and the LaTeX structured formatter and
typesetter.

.IP MAKEINDEXCOMSTR
The string displayed when calling the makeindex generator for the
TeX formatter and typesetter
and the LaTeX structured formatter and typesetter.
If this is not set, then \fB$MAKEINDEXCOM\fP (the command line) is displayed.

.IP MAKEINDEXFLAGS
General options passed to the makeindex generator for the TeX formatter
and typesetter and the LaTeX structured formatter and typesetter.

.IP MAXLINELENGTH
The maximum number of characters allowed on an external command line.
On Win32 systems,
link lines longer than this many characters
are linked via a temporary file name.

.IP MIDL
The Microsoft IDL compiler.

.IP MIDLCOM
The command line used to pass files to the Microsoft IDL compiler.

.IP MIDLCOMSTR
The string displayed when
the Microsoft IDL copmiler is called.
If this is not set, then \fB$MIDLCOM\fP (the command line) is displayed.

.IP MIDLFLAGS
General options passed to the Microsoft IDL compiler.

.IP MOSUFFIX
Suffix used for \fBMO\fP files (default: \fB'.mo'\fP).
See &t-link-msgfmt; tool and \fBMOFiles\fP() builder.

.IP MSGFMT
Absolute path to \fBmsgfmt(1)\fP binary, found by
.BR Detect() .
See &t-link-msgfmt; tool and \fBMOFiles\fP() builder.

.IP MSGFMTCOM
Complete command line to run \fBmsgfmt(1)\fP program.
See &t-link-msgfmt; tool and \fBMOFiles\fP() builder.

.IP MSGFMTCOMSTR
String to display when \fBmsgfmt(1)\fP is invoked 
(default: \fB''\fP, which means ``print \fB$MSGFMTCOM\fP'').
See &t-link-msgfmt; tool and \fBMOFiles\fP() builder.

.IP MSGFMTFLAGS
Additional flags to \fBmsgfmt(1)\fP.
See &t-link-msgfmt; tool and \fBMOFiles\fP() builder.

.IP MSGINIT
Path to \fBmsginit(1)\fP program (found via
.BR Detect() ).
See &t-link-msginit; tool and \fBPOInit\fP() builder.

.IP MSGINITCOM
Complete command line to run \fBmsginit(1)\fP program.
See &t-link-msginit; tool and \fBPOInit\fP() builder.

.IP MSGINITCOMSTR
String to display when \fBmsginit(1)\fP is invoked 
(default: \fB''\fP, which means ``print \fB$MSGINITCOM\fP'').
See &t-link-msginit; tool and \fBPOInit\fP() builder.

.IP MSGINITFLAGS
List of additional flags to \fBmsginit(1)\fP (default:
.BR [] ).
See &t-link-msginit; tool and \fBPOInit\fP() builder.

.IP _MSGINITLOCALE
Internal ``macro''. Computes locale (language) name based on target filename
(default: \fB'${TARGET.filebase}' \fP).

.IP MSGMERGE
Absolute path to \fBmsgmerge(1)\fP binary as found by
.BR Detect() .
See &t-link-msgmerge; tool and \fBPOUpdate\fP() builder.

.IP MSGMERGECOM
Complete command line to run \fBmsgmerge(1)\fP command.
See &t-link-msgmerge; tool and \fBPOUpdate\fP() builder.

.IP MSGMERGECOMSTR
String to be displayed when \fBmsgmerge(1)\fP is invoked
(default: \fB''\fP, which means ``print \fB$MSGMERGECOM\fP'').
See &t-link-msgmerge; tool and \fBPOUpdate\fP() builder.

.IP MSGMERGEFLAGS
Additional flags to \fBmsgmerge(1)\fP command.
See &t-link-msgmerge; tool and \fBPOUpdate\fP() builder.

.IP MSSDK_DIR
The directory containing the Microsoft SDK
(either Platform SDK or Windows SDK)
to be used for compilation.

.IP MSSDK_VERSION
The version string of the Microsoft SDK
(either Platform SDK or Windows SDK)
to be used for compilation.
Supported versions include
.BR 6.1 ,
.BR 6.0A ,
.BR 6.0 ,
.B 2003R2
and 
.BR 2003R1 .

.IP MSVC_BATCH
When set to any true value,
specifies that SCons should batch
compilation of object files
when calling the Microsoft Visual C/C++ compiler.
All compilations of source files from the same source directory
that generate target files in a same output directory
and were configured in SCons using the same construction environment
will be built in a single call to the compiler.
Only source files that have changed since their
object files were built will be passed to each compiler invocation
(via the \fB$CHANGED_SOURCES\fP construction variable).
Any compilations where the object (target) file base name
(minus the \fB.obj\fP)
does not match the source file base name
will be compiled separately.

.IP MSVC_USE_SCRIPT
Use a batch script to set up Microsoft Visual Studio compiler

.BR $MSVC_USE_SCRIPT\fP overrides \fB$MSVC_VERSION\fP and \fB$TARGET_ARCH .
If set to the name of a Visual Studio .bat file (e.g. vcvars.bat),
SCons will run that bat file and extract the relevant variables from
the result (typically %INCLUDE%, %LIB%, and %PATH%).  Setting
MSVC_USE_SCRIPT to None bypasses the Visual Studio autodetection
entirely; use this if you are running SCons in a Visual Studio cmd
window and importing the shell's environment variables.

.IP MSVC_VERSION
Sets the preferred  version of Microsoft Visual C/C++ to use.

If \fB$MSVC_VERSION\fP is not set, SCons will (by default) select the
latest version of Visual C/C++ installed on your system.  If the
specified version isn't installed, tool initialization will fail.
This variable must be passed as an argument to the Environment()
constructor; setting it later has no effect.  Set it to an unexpected
value (e.g. "XXX") to see the valid values on your system.

.IP MSVS
When the Microsoft Visual Studio tools are initialized, they set up
this dictionary with the following keys:

.BR VERSION :
the version of MSVS being used (can be set via
.BR $MSVS_VERSION )

.BR VERSIONS :
the available versions of MSVS installed

.BR VCINSTALLDIR :
installed directory of Visual C++

.BR VSINSTALLDIR :
installed directory of Visual Studio

.BR FRAMEWORKDIR :
installed directory of the .NET framework

.BR FRAMEWORKVERSIONS :
list of installed versions of the .NET framework, sorted latest to oldest.

.BR FRAMEWORKVERSION :
latest installed version of the .NET framework

.BR FRAMEWORKSDKDIR :
installed location of the .NET SDK.

.BR PLATFORMSDKDIR :
installed location of the Platform SDK.

.BR PLATFORMSDK_MODULES :
dictionary of installed Platform SDK modules,
where the dictionary keys are keywords for the various modules, and
the values are 2-tuples where the first is the release date, and the
second is the version number.

If a value isn't set, it wasn't available in the registry.

.IP MSVS_ARCH
Sets the architecture for which the generated project(s) should build.

The default value is \fBx86\fP.
\fBamd64\fP is also supported
by &SCons; for some Visual Studio versions.
Trying to set \fB$MSVS_ARCH\fP to an architecture that's not
supported for a given Visual Studio version
will generate an error.

.IP MSVS_PROJECT_GUID
The string
placed in a generated Microsoft Visual Studio project file
as the value of the
.B ProjectGUID
attribute.
There is no default value. If not defined, a new GUID is generated.

.IP MSVS_SCC_AUX_PATH
The path name
placed in a generated Microsoft Visual Studio project file
as the value of the
.B SccAuxPath
attribute
if the
.B MSVS_SCC_PROVIDER
construction variable is also set.
There is no default value.

.IP MSVS_SCC_CONNECTION_ROOT
The root path of projects in your SCC workspace, i.e the path under which
all project and solution files will be generated. It is used as a
reference path from which the relative paths of the generated
Microsoft Visual Studio project and solution files are computed.
The relative project file path is placed as the value of the
.B SccLocalPath
attribute
of the project file
and as the values of the
.B SccProjectFilePathRelativizedFromConnection[i]
(where [i] ranges from 0 to the number of projects in the solution)
attributes of the
.B GlobalSection(SourceCodeControl)
section of the Microsoft Visual Studio solution file.
Similarly the relative solution file path is placed as the values of the
.B SccLocalPath[i]
(where [i] ranges from 0 to the number of projects in the solution)
attributes of the
.B GlobalSection(SourceCodeControl)
section of the Microsoft Visual Studio solution file.
This is used only
if the
.B MSVS_SCC_PROVIDER
construction variable is also set.
The default value is the current working directory.

.IP MSVS_SCC_PROJECT_NAME
The project name
placed in a generated Microsoft Visual Studio project file
as the value of the
.B SccProjectName
attribute
if the
.B MSVS_SCC_PROVIDER
construction variable is also set.
In this case the string is also placed in the
.B SccProjectName0
attribute of the
.B GlobalSection(SourceCodeControl)
section of the Microsoft Visual Studio solution file.
There is no default value.

.IP MSVS_SCC_PROVIDER
The string
placed in a generated Microsoft Visual Studio project file
as the value of the
.B SccProvider
attribute.
The string is also placed in the
.B SccProvider0
attribute of the
.B GlobalSection(SourceCodeControl)
section of the Microsoft Visual Studio solution file.
There is no default value.

.IP MSVS_VERSION
Sets the preferred version of Microsoft Visual Studio to use.

If \fB$MSVS_VERSION\fP is not set,
&SCons; will (by default) select the latest version
of Visual Studio installed on your system.
So, if you have version 6 and version 7 (MSVS .NET) installed,
it will prefer version 7.
You can override this by
specifying the
.B MSVS_VERSION
variable in the Environment initialization, setting it to the
appropriate version ('6.0' or '7.0', for example).
If the specified version isn't installed,
tool initialization will fail.

This is obsolete: use \fB$MSVC_VERSION\fP instead. If \fB$MSVS_VERSION\fP is set and
.BR $MSVC_VERSION\fP is not, \fB$MSVC_VERSION\fP will be set automatically to \fB$MSVS_VERSION .
If both are set to different values, scons will raise an error.

.IP MSVSBUILDCOM
The build command line placed in
a generated Microsoft Visual Studio project file.
The default is to have Visual Studio invoke SCons with any specified
build targets.

.IP MSVSCLEANCOM
The clean command line placed in
a generated Microsoft Visual Studio project file.
The default is to have Visual Studio invoke SCons with the -c option
to remove any specified targets.

.IP MSVSENCODING
The encoding string placed in
a generated Microsoft Visual Studio project file.
The default is encoding
.BR Windows-1252 .

.IP MSVSPROJECTCOM
The action used to generate Microsoft Visual Studio project files.

.IP MSVSPROJECTSUFFIX
The suffix used for Microsoft Visual Studio project (DSP) files.
The default value is
.B .vcproj
when using Visual Studio version 7.x (.NET)
or later version,
and
.B .dsp
when using earlier versions of Visual Studio.

.IP MSVSREBUILDCOM
The rebuild command line placed in
a generated Microsoft Visual Studio project file.
The default is to have Visual Studio invoke SCons with any specified
rebuild targets.

.IP MSVSSCONS
The SCons used in generated Microsoft Visual Studio project files.
The default is the version of SCons being
used to generate the project file.

.IP MSVSSCONSCOM
The default SCons command used in generated Microsoft Visual Studio
project files.

.IP MSVSSCONSCRIPT
The sconscript file
(that is,
.B SConstruct
or
.B SConscript
file)
that will be invoked by Visual Studio
project files
(through the
.B $MSVSSCONSCOM
variable).
The default is the same sconscript file
that contains the call to
.BR MSVSProject ()
to build the project file.

.IP MSVSSCONSFLAGS
The SCons flags used in generated Microsoft Visual Studio
project files.

.IP MSVSSOLUTIONCOM
The action used to generate Microsoft Visual Studio solution files.

.IP MSVSSOLUTIONSUFFIX
The suffix used for Microsoft Visual Studio solution (DSW) files.
The default value is
.B .sln
when using Visual Studio version 7.x (.NET),
and
.B .dsw
when using earlier versions of Visual Studio.

.IP MT
The program used on Windows systems to embed manifests into DLLs and EXEs.
See also \fB$WINDOWS_EMBED_MANIFEST\fP.

.IP MTEXECOM
The Windows command line used to embed manifests into executables.
See also \fB$MTSHLIBCOM\fP.

.IP MTFLAGS
Flags passed to the \fB$MT\fP manifest embedding program (Windows only).

.IP MTSHLIBCOM
The Windows command line used to embed manifests into shared libraries (DLLs).
See also \fB$MTEXECOM\fP.

.IP MWCW_VERSION
The version number of the MetroWerks CodeWarrior C compiler
to be used.

.IP MWCW_VERSIONS
A list of installed versions of the MetroWerks CodeWarrior C compiler
on this system.

.IP NAME
Specfies the name of the project to package.

.IP no_import_lib
When set to non-zero,
suppresses creation of a corresponding Windows static import lib by the
.B SharedLibrary
builder when used with
MinGW, Microsoft Visual Studio or Metrowerks.
This also suppresses creation
of an export (.exp) file
when using Microsoft Visual Studio.

.IP OBJPREFIX
The prefix used for (static) object file names.

.IP OBJSUFFIX
The suffix used for (static) object file names.

.IP P4
The Perforce executable.

.IP P4COM
The command line used to
fetch source files from Perforce.

.IP P4COMSTR
The string displayed when
fetching a source file from Perforce.
If this is not set, then \fB$P4COM\fP (the command line) is displayed.

.IP P4FLAGS
General options that are passed to Perforce.

.IP PACKAGEROOT
Specifies the directory where all files in resulting archive will be
placed if applicable.  The default value is "$NAME-$VERSION".

.IP PACKAGETYPE
Selects the package type to build.  Currently these are available:

 * msi - Microsoft Installer
 * rpm - Redhat Package Manger
 * ipkg - Itsy Package Management System
 * tarbz2 - compressed tar
 * targz - compressed tar
 * zip - zip file
 * src_tarbz2 - compressed tar source
 * src_targz - compressed tar source
 * src_zip - zip file source

This may be overridden with the "package_type" command line option.

.IP PACKAGEVERSION
The version of the package (not the underlying project).
This is currently only used by the rpm packager
and should reflect changes in the packaging,
not the underlying project code itself.

.IP PCH
The Microsoft Visual C++ precompiled header that will be used when compiling
object files. This variable is ignored by tools other than Microsoft Visual C++.
When this variable is
defined SCons will add options to the compiler command line to
cause it to use the precompiled header, and will also set up the
dependencies for the PCH file.
Example:

.ES
env['PCH'] = 'StdAfx.pch'
.EE

.IP PCHCOM
The command line used by the
.BR PCH ()
builder to generated a precompiled header.

.IP PCHCOMSTR
The string displayed when generating a precompiled header.
If this is not set, then \fB$PCHCOM\fP (the command line) is displayed.

.IP PCHPDBFLAGS
A construction variable that, when expanded,
adds the \fB/yD\fP flag to the command line
only if the \fB$PDB\fP construction variable is set.

.IP PCHSTOP
This variable specifies how much of a source file is precompiled. This
variable is ignored by tools other than Microsoft Visual C++, or when
the PCH variable is not being used. When this variable is define it
must be a string that is the name of the header that
is included at the end of the precompiled portion of the source files, or
the empty string if the "#pragma hrdstop" construct is being used:

.ES
env['PCHSTOP'] = 'StdAfx.h'
.EE

.IP PDB
The Microsoft Visual C++ PDB file that will store debugging information for
object files, shared libraries, and programs. This variable is ignored by
tools other than Microsoft Visual C++.
When this variable is
defined SCons will add options to the compiler and linker command line to
cause them to generate external debugging information, and will also set up the
dependencies for the PDB file.
Example:

.ES
env['PDB'] = 'hello.pdb'
.EE
.IP
The Visual C++ compiler switch that SCons uses by default
to generate PDB information is \fB/Z7\fP.
This works correctly with parallel (\fB\-j\fP) builds
because it embeds the debug information in the intermediate object files,
as opposed to sharing a single PDB file between multiple object files.
This is also the only way to get debug information
embedded into a static library.
Using the \fB/Zi\fP instead may yield improved
link-time performance,
although parallel builds will no longer work.
You can generate PDB files with the \fB/Zi\fP
switch by overriding the default \fB$CCPDBFLAGS\fP variable;
see the entry for that variable for specific examples.

.IP PDFCOM
A deprecated synonym for \fB$DVIPDFCOM\fP.

.IP PDFLATEX
The &pdflatex; utility.

.IP PDFLATEXCOM
The command line used to call the &pdflatex; utility.

.IP PDFLATEXCOMSTR
The string displayed when calling the &pdflatex; utility.
If this is not set, then \fB$PDFLATEXCOM\fP (the command line) is displayed.

.ES
env = Environment(PDFLATEX;COMSTR = "Building $TARGET from LaTeX input $SOURCES")
.EE

.IP PDFLATEXFLAGS
General options passed to the &pdflatex; utility.

.IP PDFPREFIX
The prefix used for PDF file names.

.IP PDFSUFFIX
The suffix used for PDF file names.

.IP PDFTEX
The &pdftex; utility.

.IP PDFTEXCOM
The command line used to call the &pdftex; utility.

.IP PDFTEXCOMSTR
The string displayed when calling the &pdftex; utility.
If this is not set, then \fB$PDFTEXCOM\fP (the command line) is displayed.

.ES
env = Environment(PDFTEXCOMSTR = "Building $TARGET from TeX input $SOURCES")
.EE

.IP PDFTEXFLAGS
General options passed to the &pdftex; utility.

.IP PKGCHK
On Solaris systems,
the package-checking program that will
be used (along with \fB$PKGINFO\fP)
to look for installed versions of
the Sun PRO C++ compiler.
The default is
.BR /usr/sbin/pgkchk .

.IP PKGINFO
On Solaris systems,
the package information program that will
be used (along with \fB$PKGCHK\fP)
to look for installed versions of
the Sun PRO C++ compiler.
The default is
.BR pkginfo .

.IP PLATFORM
The name of the platform used to create the Environment.  If no platform is
specified when the Environment is created,
.B scons
autodetects the platform.

.ES
env = Environment(tools = [])
if env['PLATFORM'] == 'cygwin':
    Tool('mingw')(env)
else:
    Tool('msvc')(env)
.EE

.IP POAUTOINIT
The \fB$POAUTOINIT\fP variable, if set to \fBTrue\fP (on non-zero
numeric value), let the &t-link-msginit; tool to automatically initialize
\fImissing\fP \fBPO\fP files with
\fBmsginit(1)\fP.  This applies to both,
\fBPOInit\fP() and \fBPOUpdate\fP() builders (and others that use any of
them).

.IP POCREATE_ALIAS
Common alias for all \fBPO\fP files created with \fBPOInit\fP()
builder (default: \fB'po-create'\fP).
See &t-link-msginit; tool and \fBPOInit\fP() builder.

.IP POSUFFIX
Suffix used for \fBPO\fP files (default: \fB'.po'\fP)
See &t-link-msginit; tool and \fBPOInit\fP() builder.

.IP POTDOMAIN
The \fB$POTDOMAIN\fP defines default domain, used to generate
\fBPOT\fP filename as \fB\fB$POTDOMAIN\fP.pot\fP when
no \fBPOT\fP file name is provided by the user. This applies to
\fBPOTUpdate\fP(), \fBPOInit\fP() and \fBPOUpdate\fP() builders (and
builders, that use them, e.g. \fBTranslate\fP()). Normally (if \fB$POTDOMAIN\fP is
not defined), the builders use \fBmessages.pot\fP as default
\fBPOT\fP file name.

.IP POTSUFFIX
Suffix used for PO Template files (default: \fB'.pot'\fP).
See &t-link-xgettext; tool and \fBPOTUpdate\fP() builder.

.IP POTUPDATE_ALIAS
Name of the common phony target for all PO Templates created with
.BR POUpdate\fP() (default: \fB'pot-update' ).
See &t-link-xgettext; tool and \fBPOTUpdate\fP() builder.

.IP POUPDATE_ALIAS
Common alias for all \fBPO\fP files being defined with
.BR POUpdate\fP() builder (default: \fB'po-update' ).
See &t-link-msgmerge; tool and \fBPOUpdate\fP() builder.

.IP PRINT_CMD_LINE_FUNC
A Python function used to print the command lines as they are executed
(assuming command printing is not disabled by the
.B \-q
or
.B \-s
options or their equivalents).
The function should take four arguments:
.IR s ,
the command being executed (a string),
.IR target ,
the target being built (file node, list, or string name(s)),
.IR source ,
the source(s) used (file node, list, or string name(s)), and
.IR env ,
the environment being used.

The function must do the printing itself.  The default implementation,
used if this variable is not set or is None, is:
.ES
def print_cmd_line(s, target, source, env):
  sys.stdout.write(s + "\\n")
.EE
.IP
Here's an example of a more interesting function:

.ES
def print_cmd_line(s, target, source, env):
   sys.stdout.write("Building %s -> %s...\\n" %
    (' and '.join([str(x) for x in source]),
     ' and '.join([str(x) for x in target])))
env=Environment(PRINT_CMD_LINE_FUNC=print_cmd_line)
env.Program('foo', 'foo.c')
.EE
.IP
This just prints "Building \fItargetname\fP from \fIsourcename\fP..." instead
of the actual commands.
Such a function could also log the actual commands to a log file,
for example.

.IP PROGEMITTER
TODO

.IP PROGPREFIX
The prefix used for executable file names.

.IP PROGSUFFIX
The suffix used for executable file names.

.IP PSCOM
The command line used to convert TeX DVI files into a PostScript file.

.IP PSCOMSTR
The string displayed when a TeX DVI file
is converted into a PostScript file.
If this is not set, then \fB$PSCOM\fP (the command line) is displayed.

.IP PSPREFIX
The prefix used for PostScript file names.

.IP PSSUFFIX
The prefix used for PostScript file names.

.IP QT_AUTOSCAN
Turn off scanning for mocable files. Use the Moc Builder to explicitly
specify files to run moc on.

.IP QT_BINPATH
The path where the qt binaries are installed.
The default value is '\fB$QTDIR\fP/bin'.

.IP QT_CPPPATH
The path where the qt header files are installed.
The default value is '\fB$QTDIR\fP/include'.
Note: If you set this variable to None,
the tool won't change the \fB$CPPPATH\fP
construction variable.

.IP QT_DEBUG
Prints lots of debugging information while scanning for moc files.

.IP QT_LIB
Default value is 'qt'. You may want to set this to 'qt-mt'. Note: If you set
this variable to None, the tool won't change the \fB$LIBS\fP variable.

.IP QT_LIBPATH
The path where the qt libraries are installed.
The default value is '\fB$QTDIR\fP/lib'.
Note: If you set this variable to None,
the tool won't change the \fB$LIBPATH\fP
construction variable.

.IP QT_MOC
Default value is '\fB$QT_BINPATH\fP/moc'.

.IP QT_MOCCXXPREFIX
Default value is ''. Prefix for moc output files, when source is a cxx file.

.IP QT_MOCCXXSUFFIX
Default value is '.moc'. Suffix for moc output files, when source is a cxx
file.

.IP QT_MOCFROMCXXCOM
Command to generate a moc file from a cpp file.

.IP QT_MOCFROMCXXCOMSTR
The string displayed when generating a moc file from a cpp file.
If this is not set, then \fB$QT_MOCFROMCXXCOM\fP (the command line) is displayed.

.IP QT_MOCFROMCXXFLAGS
Default value is '-i'. These flags are passed to moc, when moccing a
C++ file.

.IP QT_MOCFROMHCOM
Command to generate a moc file from a header.

.IP QT_MOCFROMHCOMSTR
The string displayed when generating a moc file from a cpp file.
If this is not set, then \fB$QT_MOCFROMHCOM\fP (the command line) is displayed.

.IP QT_MOCFROMHFLAGS
Default value is ''. These flags are passed to moc, when moccing a header
file.

.IP QT_MOCHPREFIX
Default value is 'moc_'. Prefix for moc output files, when source is a header.

.IP QT_MOCHSUFFIX
Default value is '\fB$CXXFILESUFFIX\fP'. Suffix for moc output files, when source is
a header.

.IP QT_UIC
Default value is '\fB$QT_BINPATH\fP/uic'.

.IP QT_UICCOM
Command to generate header files from .ui files.

.IP QT_UICCOMSTR
The string displayed when generating header files from .ui files.
If this is not set, then \fB$QT_UICCOM\fP (the command line) is displayed.

.IP QT_UICDECLFLAGS
Default value is ''. These flags are passed to uic, when creating a a h
file from a .ui file.

.IP QT_UICDECLPREFIX
Default value is ''. Prefix for uic generated header files.

.IP QT_UICDECLSUFFIX
Default value is '.h'. Suffix for uic generated header files.

.IP QT_UICIMPLFLAGS
Default value is ''. These flags are passed to uic, when creating a cxx
file from a .ui file.

.IP QT_UICIMPLPREFIX
Default value is 'uic_'. Prefix for uic generated implementation files.

.IP QT_UICIMPLSUFFIX
Default value is '\fB$CXXFILESUFFIX\fP'. Suffix for uic generated implementation
files.

.IP QT_UISUFFIX
Default value is '.ui'. Suffix of designer input files.

.IP QTDIR
The qt tool tries to take this from os.environ.
It also initializes all QT_*
construction variables listed below.
(Note that all paths are constructed
with python's os.path.join() method,
but are listed here with the '/' separator
for easier reading.)
In addition, the construction environment
variables \fB$CPPPATH\fP,
\fB$LIBPATH\fP and
\fB$LIBS\fP may be modified
and the variables
.BR $PROGEMITTER\fP, \fB$SHLIBEMITTER  and  $LIBEMITTER
are modified. Because the build-performance is affected when using this tool,
you have to explicitly specify it at Environment creation:

.ES
Environment(tools=['default','qt'])
.EE
.IP
The qt tool supports the following operations:

.I "Automatic moc file generation from header files."
You do not have to specify moc files explicitly, the tool does it for you.
However, there are a few preconditions to do so: Your header file must have
the same filebase as your implementation file and must stay in the same
directory. It must have one of the suffixes .h, .hpp, .H, .hxx, .hh. You
can turn off automatic moc file generation by setting QT_AUTOSCAN to 0.
See also the corresponding
.BR Moc() ()
builder method.

.I "Automatic moc file generation from cxx files."
As stated in the qt documentation, include the moc file at the end of
the cxx file. Note that you have to include the file, which is generated
by the transformation ${QT_MOCCXXPREFIX}<basename>${QT_MOCCXXSUFFIX}, by default
<basename>.moc. A warning is generated after building the moc file, if you
do not include the correct file. If you are using VariantDir, you may
need to specify duplicate=1. You can turn off automatic moc file generation
by setting QT_AUTOSCAN to 0. See also the corresponding
.BR Moc ()
builder method.

.I "Automatic handling of .ui files."
The implementation files generated from .ui files are handled much the same
as yacc or lex files. Each .ui file given as a source of Program, Library or
SharedLibrary will generate three files, the declaration file, the
implementation file and a moc file. Because there are also generated headers,
you may need to specify duplicate=1 in calls to VariantDir.
See also the corresponding
.BR Uic ()
builder method.

.IP RANLIB
The archive indexer.

.IP RANLIBCOM
The command line used to index a static library archive.

.IP RANLIBCOMSTR
The string displayed when a static library archive is indexed.
If this is not set, then \fB$RANLIBCOM\fP (the command line) is displayed.

.ES
env = Environment(RANLIBCOMSTR = "Indexing $TARGET")
.EE

.IP RANLIBFLAGS
General options passed to the archive indexer.

.IP RC
The resource compiler used to build
a Microsoft Visual C++ resource file.

.IP RCCOM
The command line used to build
a Microsoft Visual C++ resource file.

.IP RCCOMSTR
The string displayed when invoking the resource compiler
to build a Microsoft Visual C++ resource file.
If this is not set, then \fB$RCCOM\fP (the command line) is displayed.

.IP RCFLAGS
The flags passed to the resource compiler by the RES builder.

.IP RCINCFLAGS
An automatically-generated construction variable
containing the command-line options
for specifying directories to be searched
by the resource compiler.
The value of \fB$RCINCFLAGS\fP is created
by appending \fB$RCINCPREFIX\fP and \fB$RCINCSUFFIX\fP
to the beginning and end
of each directory in \fB$CPPPATH\fP.

.IP RCINCPREFIX
The prefix (flag) used to specify an include directory
on the resource compiler command line.
This will be appended to the beginning of each directory
in the \fB$CPPPATH\fP construction variable
when the \fB$RCINCFLAGS\fP variable is expanded.

.IP RCINCSUFFIX
The suffix used to specify an include directory
on the resource compiler command line.
This will be appended to the end of each directory
in the \fB$CPPPATH\fP construction variable
when the \fB$RCINCFLAGS\fP variable is expanded.

.IP RCS
The RCS executable.
Note that this variable is not actually used
for the command to fetch source files from RCS;
see the
.B $RCS_CO
construction variable, below.

.IP RCS_CO
The RCS "checkout" executable,
used to fetch source files from RCS.

.IP RCS_COCOM
The command line used to
fetch (checkout) source files from RCS.

.IP RCS_COCOMSTR
The string displayed when fetching
a source file from RCS.
If this is not set, then \fB$RCS_COCOM\fP
(the command line) is displayed.

.IP RCS_COFLAGS
Options that are passed to the \fB$RCS_CO\fP command.

.IP RDirs
A function that converts a string into a list of Dir instances by
searching the repositories.

.IP REGSVR
The program used on Windows systems
to register a newly-built DLL library
whenever the \fBSharedLibrary\fP() builder
is passed a keyword argument of \fBregister=1\fP.

.IP REGSVRCOM
The command line used on Windows systems
to register a newly-built DLL library
whenever the \fBSharedLibrary\fP() builder
is passed a keyword argument of \fBregister=1\fP.

.IP REGSVRCOMSTR
The string displayed when registering a newly-built DLL file.
If this is not set, then \fB$REGSVRCOM\fP (the command line) is displayed.

.IP REGSVRFLAGS
Flags passed to the DLL registration program
on Windows systems when a newly-built DLL library is registered.
By default,
this includes the \fB/s\fP
that prevents dialog boxes from popping up
and requiring user attention.

.IP RMIC
The Java RMI stub compiler.

.IP RMICCOM
The command line used to compile stub
and skeleton class files
from Java classes that contain RMI implementations.
Any options specified in the \fB$RMICFLAGS\fP construction variable
are included on this command line.

.IP RMICCOMSTR
The string displayed when compiling
stub and skeleton class files
from Java classes that contain RMI implementations.
If this is not set, then \fB$RMICCOM\fP (the command line) is displayed.

.ES
env = Environment(RMICCOMSTR = "Generating stub/skeleton class files $TARGETS from $SOURCES")
.EE

.IP RMICFLAGS
General options passed to the Java RMI stub compiler.

.IP _RPATH
An automatically-generated construction variable
containing the rpath flags to be used when linking
a program with shared libraries.
The value of \fB$_RPATH\fP is created
by appending \fB$RPATHPREFIX\fP and \fB$RPATHSUFFIX\fP
to the beginning and end
of each directory in \fB$RPATH\fP.

.IP RPATH
A list of paths to search for shared libraries when running programs.
Currently only used in the GNU (gnulink),
IRIX (sgilink) and Sun (sunlink) linkers.
Ignored on platforms and toolchains that don't support it.
Note that the paths added to RPATH
are not transformed by
.B scons
in any way:  if you want an absolute
path, you must make it absolute yourself.

.IP RPATHPREFIX
The prefix used to specify a directory to be searched for
shared libraries when running programs.
This will be appended to the beginning of each directory
in the \fB$RPATH\fP construction variable
when the \fB$_RPATH\fP variable is automatically generated.

.IP RPATHSUFFIX
The suffix used to specify a directory to be searched for
shared libraries when running programs.
This will be appended to the end of each directory
in the \fB$RPATH\fP construction variable
when the \fB$_RPATH\fP variable is automatically generated.

.IP RPCGEN
The RPC protocol compiler.

.IP RPCGENCLIENTFLAGS
Options passed to the RPC protocol compiler
when generating client side stubs.
These are in addition to any flags specified in the
.B $RPCGENFLAGS
construction variable.

.IP RPCGENFLAGS
General options passed to the RPC protocol compiler.

.IP RPCGENHEADERFLAGS
Options passed to the RPC protocol compiler
when generating a header file.
These are in addition to any flags specified in the
.B $RPCGENFLAGS
construction variable.

.IP RPCGENSERVICEFLAGS
Options passed to the RPC protocol compiler
when generating server side stubs.
These are in addition to any flags specified in the
.B $RPCGENFLAGS
construction variable.

.IP RPCGENXDRFLAGS
Options passed to the RPC protocol compiler
when generating XDR routines.
These are in addition to any flags specified in the
.B $RPCGENFLAGS
construction variable.

.IP SCANNERS
A list of the available implicit dependency scanners.
New file scanners may be added by
appending to this list,
although the more flexible approach
is to associate scanners
with a specific Builder.
See the sections "Builder Objects"
and "Scanner Objects,"
below, for more information.

.IP SCCS
The SCCS executable.

.IP SCCSCOM
The command line used to
fetch source files from SCCS.

.IP SCCSCOMSTR
The string displayed when fetching
a source file from a CVS repository.
If this is not set, then \fB$SCCSCOM\fP
(the command line) is displayed.

.IP SCCSFLAGS
General options that are passed to SCCS.

.IP SCCSGETFLAGS
Options that are passed specifically to the SCCS "get" subcommand.
This can be set, for example, to
.B \-e
to check out editable files from SCCS.

.IP SCONS_HOME
The (optional) path to the SCons library directory,
initialized from the external environment.
If set, this is used to construct a shorter and more
efficient search path in the
.B $MSVSSCONS
command line executed
from Microsoft Visual Studio project files.

.IP SHCC
The C compiler used for generating shared-library objects.

.IP SHCCCOM
The command line used to compile a C source file
to a shared-library object file.
Any options specified in the \fB$SHCFLAGS\fP,
\fB$SHCCFLAGS\fP and
\fB$CPPFLAGS\fP construction variables
are included on this command line.

.IP SHCCCOMSTR
The string displayed when a C source file
is compiled to a shared object file.
If this is not set, then \fB$SHCCCOM\fP (the command line) is displayed.

.ES
env = Environment(SHCCCOMSTR = "Compiling shared object $TARGET")
.EE

.IP SHCCFLAGS
Options that are passed to the C and C++ compilers
to generate shared-library objects.

.IP SHCFLAGS
Options that are passed to the C compiler (only; not C++)
to generate shared-library objects.

.IP SHCXX
The C++ compiler used for generating shared-library objects.

.IP SHCXXCOM
The command line used to compile a C++ source file
to a shared-library object file.
Any options specified in the \fB$SHCXXFLAGS\fP and
\fB$CPPFLAGS\fP construction variables
are included on this command line.

.IP SHCXXCOMSTR
The string displayed when a C++ source file
is compiled to a shared object file.
If this is not set, then \fB$SHCXXCOM\fP (the command line) is displayed.

.ES
env = Environment(SHCXXCOMSTR = "Compiling shared object $TARGET")
.EE

.IP SHCXXFLAGS
Options that are passed to the C++ compiler
to generate shared-library objects.

.IP SHELL
A string naming the shell program that will be passed to the
.B $SPAWN
function.
See the
.B $SPAWN
construction variable for more information.

.IP SHF77
The Fortran 77 compiler used for generating shared-library objects.
You should normally set the \fB$SHFORTRAN\fP variable,
which specifies the default Fortran compiler
for all Fortran versions.
You only need to set \fB$SHF77\fP if you need to use a specific compiler
or compiler version for Fortran 77 files.

.IP SHF77COM
The command line used to compile a Fortran 77 source file
to a shared-library object file.
You only need to set \fB$SHF77COM\fP if you need to use a specific
command line for Fortran 77 files.
You should normally set the \fB$SHFORTRANCOM\fP variable,
which specifies the default command line
for all Fortran versions.

.IP SHF77COMSTR
The string displayed when a Fortran 77 source file
is compiled to a shared-library object file.
If this is not set, then \fB$SHF77COM\fP or \fB$SHFORTRANCOM\fP
(the command line) is displayed.

.IP SHF77FLAGS
Options that are passed to the Fortran 77 compiler
to generated shared-library objects.
You only need to set \fB$SHF77FLAGS\fP if you need to define specific
user options for Fortran 77 files.
You should normally set the \fB$SHFORTRANFLAGS\fP variable,
which specifies the user-specified options
passed to the default Fortran compiler
for all Fortran versions.

.IP SHF77PPCOM
The command line used to compile a Fortran 77 source file to a
shared-library object file
after first running the file through the C preprocessor.
Any options specified in the \fB$SHF77FLAGS\fP and \fB$CPPFLAGS\fP construction variables
are included on this command line.
You only need to set \fB$SHF77PPCOM\fP if you need to use a specific
C-preprocessor command line for Fortran 77 files.
You should normally set the \fB$SHFORTRANPPCOM\fP variable,
which specifies the default C-preprocessor command line
for all Fortran versions.

.IP SHF77PPCOMSTR
The string displayed when a Fortran 77 source file
is compiled to a shared-library object file
after first running the file through the C preprocessor.
If this is not set, then \fB$SHF77PPCOM\fP or \fB$SHFORTRANPPCOM\fP
(the command line) is displayed.

.IP SHF90
The Fortran 90 compiler used for generating shared-library objects.
You should normally set the \fB$SHFORTRAN\fP variable,
which specifies the default Fortran compiler
for all Fortran versions.
You only need to set \fB$SHF90\fP if you need to use a specific compiler
or compiler version for Fortran 90 files.

.IP SHF90COM
The command line used to compile a Fortran 90 source file
to a shared-library object file.
You only need to set \fB$SHF90COM\fP if you need to use a specific
command line for Fortran 90 files.
You should normally set the \fB$SHFORTRANCOM\fP variable,
which specifies the default command line
for all Fortran versions.

.IP SHF90COMSTR
The string displayed when a Fortran 90 source file
is compiled to a shared-library object file.
If this is not set, then \fB$SHF90COM\fP or \fB$SHFORTRANCOM\fP
(the command line) is displayed.

.IP SHF90FLAGS
Options that are passed to the Fortran 90 compiler
to generated shared-library objects.
You only need to set \fB$SHF90FLAGS\fP if you need to define specific
user options for Fortran 90 files.
You should normally set the \fB$SHFORTRANFLAGS\fP variable,
which specifies the user-specified options
passed to the default Fortran compiler
for all Fortran versions.

.IP SHF90PPCOM
The command line used to compile a Fortran 90 source file to a
shared-library object file
after first running the file through the C preprocessor.
Any options specified in the \fB$SHF90FLAGS\fP and \fB$CPPFLAGS\fP construction variables
are included on this command line.
You only need to set \fB$SHF90PPCOM\fP if you need to use a specific
C-preprocessor command line for Fortran 90 files.
You should normally set the \fB$SHFORTRANPPCOM\fP variable,
which specifies the default C-preprocessor command line
for all Fortran versions.

.IP SHF90PPCOMSTR
The string displayed when a Fortran 90 source file
is compiled to a shared-library object file
after first running the file through the C preprocessor.
If this is not set, then \fB$SHF90PPCOM\fP or \fB$SHFORTRANPPCOM\fP
(the command line) is displayed.

.IP SHF95
The Fortran 95 compiler used for generating shared-library objects.
You should normally set the \fB$SHFORTRAN\fP variable,
which specifies the default Fortran compiler
for all Fortran versions.
You only need to set \fB$SHF95\fP if you need to use a specific compiler
or compiler version for Fortran 95 files.

.IP SHF95COM
The command line used to compile a Fortran 95 source file
to a shared-library object file.
You only need to set \fB$SHF95COM\fP if you need to use a specific
command line for Fortran 95 files.
You should normally set the \fB$SHFORTRANCOM\fP variable,
which specifies the default command line
for all Fortran versions.

.IP SHF95COMSTR
The string displayed when a Fortran 95 source file
is compiled to a shared-library object file.
If this is not set, then \fB$SHF95COM\fP or \fB$SHFORTRANCOM\fP
(the command line) is displayed.

.IP SHF95FLAGS
Options that are passed to the Fortran 95 compiler
to generated shared-library objects.
You only need to set \fB$SHF95FLAGS\fP if you need to define specific
user options for Fortran 95 files.
You should normally set the \fB$SHFORTRANFLAGS\fP variable,
which specifies the user-specified options
passed to the default Fortran compiler
for all Fortran versions.

.IP SHF95PPCOM
The command line used to compile a Fortran 95 source file to a
shared-library object file
after first running the file through the C preprocessor.
Any options specified in the \fB$SHF95FLAGS\fP and \fB$CPPFLAGS\fP construction variables
are included on this command line.
You only need to set \fB$SHF95PPCOM\fP if you need to use a specific
C-preprocessor command line for Fortran 95 files.
You should normally set the \fB$SHFORTRANPPCOM\fP variable,
which specifies the default C-preprocessor command line
for all Fortran versions.

.IP SHF95PPCOMSTR
The string displayed when a Fortran 95 source file
is compiled to a shared-library object file
after first running the file through the C preprocessor.
If this is not set, then \fB$SHF95PPCOM\fP or \fB$SHFORTRANPPCOM\fP
(the command line) is displayed.

.IP SHFORTRAN
The default Fortran compiler used for generating shared-library objects.

.IP SHFORTRANCOM
The command line used to compile a Fortran source file
to a shared-library object file.

.IP SHFORTRANCOMSTR
The string displayed when a Fortran source file
is compiled to a shared-library object file.
If this is not set, then \fB$SHFORTRANCOM\fP
(the command line) is displayed.

.IP SHFORTRANFLAGS
Options that are passed to the Fortran compiler
to generate shared-library objects.

.IP SHFORTRANPPCOM
The command line used to compile a Fortran source file to a
shared-library object file
after first running the file through the C preprocessor.
Any options specified
in the \fB$SHFORTRANFLAGS\fP and
\fB$CPPFLAGS\fP construction variables
are included on this command line.

.IP SHFORTRANPPCOMSTR
The string displayed when a Fortran source file
is compiled to a shared-library object file
after first running the file through the C preprocessor.
If this is not set, then \fB$SHFORTRANPPCOM\fP
(the command line) is displayed.

.IP SHLIBEMITTER
TODO

.IP SHLIBPREFIX
The prefix used for shared library file names.

.IP SHLIBSUFFIX
The suffix used for shared library file names.

.IP SHLIBVERSION
When this construction variable is defined, a versioned shared library
is created. This modifies the \fB$SHLINKFLAGS\fP as required, adds
the version number to the library name, and creates the symlinks that
are needed. \fB$SHLIBVERSION\fP needs to be of the form X.Y.Z,
where X and Y are numbers, and Z is a number but can also contain
letters to designate alpha, beta, or release candidate patch levels.

.IP SHLINK
The linker for programs that use shared libraries.

.IP SHLINKCOM
The command line used to link programs using shared libraries.

.IP SHLINKCOMSTR
The string displayed when programs using shared libraries are linked.
If this is not set, then \fB$SHLINKCOM\fP (the command line) is displayed.

.ES
env = Environment(SHLINKCOMSTR = "Linking shared $TARGET")
.EE

.IP SHLINKFLAGS
General user options passed to the linker for programs using shared libraries.
Note that this variable should
.I not
contain
.B \-l
(or similar) options for linking with the libraries listed in \fB$LIBS\fP,
nor
.B \-L
(or similar) include search path options
that scons generates automatically from \fB$LIBPATH\fP.
See
.B $_LIBFLAGS
above,
for the variable that expands to library-link options,
and
.B $_LIBDIRFLAGS
above,
for the variable that expands to library search path options.

.IP SHOBJPREFIX
The prefix used for shared object file names.

.IP SHOBJSUFFIX
The suffix used for shared object file names.

.IP SOURCE
A reserved variable name
that may not be set or used in a construction environment.
(See "Variable Substitution," below.)

.IP SOURCE_URL
The URL
(web address)
of the location from which the project was retrieved.
This is used to fill in the
.B Source:
field in the controlling information for Ipkg and RPM packages.

.IP SOURCES
A reserved variable name
that may not be set or used in a construction environment.
(See "Variable Substitution," below.)

.IP SPAWN
A command interpreter function that will be called to execute command line
strings. The function must expect the following arguments:

.ES
def spawn(shell, escape, cmd, args, env):
.EE
.IP
.I sh
is a string naming the shell program to use.
.I escape
is a function that can be called to escape shell special characters in
the command line.
.I cmd
is the path to the command to be executed.
.I args
is the arguments to the command.
.I env
is a dictionary of the environment variables
in which the command should be executed.

.IP SUBST_DICT
The dictionary used by the \fBSubstfile\fP() or \fBTextfile\fP() builders
for substitution values.
It can be anything acceptable to the dict() constructor,
so in addition to a dictionary,
lists of tuples are also acceptable.

.IP SUBSTFILEPREFIX
The prefix used for \fBSubstfile\fP() file names,
the null string by default.

.IP SUBSTFILESUFFIX
The suffix used for \fBSubstfile\fP() file names,
the null string by default.

.IP SUMMARY
A short summary of what the project is about.
This is used to fill in the
.B Summary:
field in the controlling information for Ipkg and RPM packages,
and as the
.B Description:
field in MSI packages.

.IP SWIG
The scripting language wrapper and interface generator.

.IP SWIGCFILESUFFIX
The suffix that will be used for intermediate C
source files generated by
the scripting language wrapper and interface generator.
The default value is
.BR _wrap\fP\fB$CFILESUFFIX .
By default, this value is used whenever the
.B \-c++
option is
.I not
specified as part of the
.B $SWIGFLAGS
construction variable.

.IP SWIGCOM
The command line used to call
the scripting language wrapper and interface generator.

.IP SWIGCOMSTR
The string displayed when calling
the scripting language wrapper and interface generator.
If this is not set, then \fB$SWIGCOM\fP (the command line) is displayed.

.IP SWIGCXXFILESUFFIX
The suffix that will be used for intermediate C++
source files generated by
the scripting language wrapper and interface generator.
The default value is
.BR _wrap\fP\fB$CFILESUFFIX .
By default, this value is used whenever the
.B \-c++
option is specified as part of the
.B $SWIGFLAGS
construction variable.

.IP SWIGDIRECTORSUFFIX
The suffix that will be used for intermediate C++ header
files generated by the scripting language wrapper and interface generator.
These are only generated for C++ code when the SWIG 'directors' feature is
turned on.
The default value is
.BR _wrap.h .

.IP SWIGFLAGS
General options passed to
the scripting language wrapper and interface generator.
This is where you should set
.BR \-python ,
.BR \-perl5 ,
.BR \-tcl ,
or whatever other options you want to specify to SWIG.
If you set the
.B \-c++
option in this variable,
.B scons
will, by default,
generate a C++ intermediate source file
with the extension that is specified as the
.B $CXXFILESUFFIX
variable.

.IP _SWIGINCFLAGS
An automatically-generated construction variable
containing the SWIG command-line options
for specifying directories to be searched for included files.
The value of \fB$_SWIGINCFLAGS\fP is created
by appending \fB$SWIGINCPREFIX\fP and \fB$SWIGINCSUFFIX\fP
to the beginning and end
of each directory in \fB$SWIGPATH\fP.

.IP SWIGINCPREFIX
The prefix used to specify an include directory on the SWIG command line.
This will be appended to the beginning of each directory
in the \fB$SWIGPATH\fP construction variable
when the \fB$_SWIGINCFLAGS\fP variable is automatically generated.

.IP SWIGINCSUFFIX
The suffix used to specify an include directory on the SWIG command line.
This will be appended to the end of each directory
in the \fB$SWIGPATH\fP construction variable
when the \fB$_SWIGINCFLAGS\fP variable is automatically generated.

.IP SWIGOUTDIR
Specifies the output directory in which
the scripting language wrapper and interface generator
should place generated language-specific files.
This will be used by SCons to identify
the files that will be generated by the &swig; call,
and translated into the
\fBswig -outdir\fP option on the command line.

.IP SWIGPATH
The list of directories that the scripting language wrapper
and interface generate will search for included files.
The SWIG implicit dependency scanner will search these
directories for include files.
The default is to use the same path
specified as \fB$CPPPATH\fP.

Don't explicitly put include directory
arguments in SWIGFLAGS;
the result will be non-portable
and the directories will not be searched by the dependency scanner.
Note: directory names in SWIGPATH will be looked-up relative to the SConscript
directory when they are used in a command.
To force
.B scons
to look-up a directory relative to the root of the source tree use #:

.ES
env = Environment(SWIGPATH='#/include')
.EE
.IP
The directory look-up can also be forced using the
.BR Dir ()
function:

.ES
include = Dir('include')
env = Environment(SWIGPATH=include)
.EE
.IP
The directory list will be added to command lines
through the automatically-generated
.B $_SWIGINCFLAGS
construction variable,
which is constructed by
appending the values of the
.BR $SWIGINCPREFIX  and  $SWIGINCSUFFIX
construction variables
to the beginning and end
of each directory in \fB$SWIGPATH\fP.
Any command lines you define that need
the SWIGPATH directory list should
include \fB$_SWIGINCFLAGS\fP:

.ES
env = Environment(SWIGCOM="my_swig -o $TARGET $_SWIGINCFLAGS $SORUCES")
.EE

.IP SWIGVERSION
The version number of the SWIG tool.

.IP TAR
The tar archiver.

.IP TARCOM
The command line used to call the tar archiver.

.IP TARCOMSTR
The string displayed when archiving files
using the tar archiver.
If this is not set, then \fB$TARCOM\fP (the command line) is displayed.

.ES
env = Environment(TARCOMSTR = "Archiving $TARGET")
.EE

.IP TARFLAGS
General options passed to the tar archiver.

.IP TARGET
A reserved variable name
that may not be set or used in a construction environment.
(See "Variable Substitution," below.)

.IP TARGET_ARCH
Sets the target architecture for Visual Studio compiler (i.e. the arch
of the binaries generated by the compiler). If not set, default to
\fB$HOST_ARCH\fP, or, if that is unset, to the architecture of the
running machine's OS (note that the python build or architecture has no
effect).
This variable must be passed as an argument to the Environment()
constructor; setting it later has no effect.  
This is currently only used on Windows, but in the future it will be
used on other OSes as well.

Valid values for Windows are
.BR x86 ,
.B i386
(for 32 bits); 
.BR amd64 ,
.BR emt64 ,
.B x86_64
(for 64 bits);
and \fBia64\fP (Itanium).
For example, if you want to compile 64-bit binaries, you would set
\fBTARGET_ARCH='x86_64'\fP in your SCons environment.

.IP TARGET_OS
        The name of the target operating system for the compiled objects
        created by this Environment.
        This defaults to the value of HOST_OS, and the user can override it.
        Currently only set for Win32.
    
.IP TARGETS
A reserved variable name
that may not be set or used in a construction environment.
(See "Variable Substitution," below.)

.IP TARSUFFIX
The suffix used for tar file names.

.IP TEMPFILEPREFIX
The prefix for a temporary file used
to execute lines longer than $MAXLINELENGTH.
The default is '@'.
This may be set for toolchains that use other values,
such as '-@' for the diab compiler
or '-via' for ARM toolchain.

.IP TEX
The TeX formatter and typesetter.

.IP TEXCOM
The command line used to call the TeX formatter and typesetter.

.IP TEXCOMSTR
The string displayed when calling
the TeX formatter and typesetter.
If this is not set, then \fB$TEXCOM\fP (the command line) is displayed.

.ES
env = Environment(TEXCOMSTR = "Building $TARGET from TeX input $SOURCES")
.EE

.IP TEXFLAGS
General options passed to the TeX formatter and typesetter.

.IP TEXINPUTS
List of directories that the LaTeX program will search
for include directories.
The LaTeX implicit dependency scanner will search these
directories for \\include and \\import files.

.IP TEXTFILEPREFIX
The prefix used for \fBTextfile\fP() file names,
the null string by default.

.IP TEXTFILESUFFIX
The suffix used for \fBTextfile\fP() file names;
\fB.txt\fP by default.

.IP TOOLS
A list of the names of the Tool specifications
that are part of this construction environment.

.IP UNCHANGED_SOURCES
A reserved variable name
that may not be set or used in a construction environment.
(See "Variable Substitution," below.)

.IP UNCHANGED_TARGETS
A reserved variable name
that may not be set or used in a construction environment.
(See "Variable Substitution," below.)

.IP VENDOR
The person or organization who supply the packaged software.
This is used to fill in the
.B Vendor:
field in the controlling information for RPM packages,
and the
.B Manufacturer:
field in the controlling information for MSI packages.

.IP VERSION
The version of the project, specified as a string.

.IP WIN32_INSERT_DEF
A deprecated synonym for \fB$WINDOWS_INSERT_DEF\fP.

.IP WIN32DEFPREFIX
A deprecated synonym for \fB$WINDOWSDEFPREFIX\fP.

.IP WIN32DEFSUFFIX
A deprecated synonym for \fB$WINDOWSDEFSUFFIX\fP.

.IP WIN32EXPPREFIX
A deprecated synonym for \fB$WINDOWSEXPSUFFIX\fP.

.IP WIN32EXPSUFFIX
A deprecated synonym for \fB$WINDOWSEXPSUFFIX\fP.

.IP WINDOWS_EMBED_MANIFEST
Set this variable to True or 1 to embed the compiler-generated manifest
(normally \fB${TARGET}.manifest\fP)
into all Windows exes and DLLs built with this environment,
as a resource during their link step.
This is done using \fB$MT\fP and \fB$MTEXECOM\fP and \fB$MTSHLIBCOM\fP.

.IP WINDOWS_INSERT_DEF
When this is set to true,
a library build of a Windows shared library
(\fB.dll\fP file)
will also build a corresponding \fB.def\fP file
at the same time,
if a \fB.def\fP file
is not already listed as a build target.
The default is 0 (do not build a \fB.def\fP file).

.IP WINDOWS_INSERT_MANIFEST
When this is set to true,
.B scons
will be aware of the
.B .manifest
files generated by Microsoft Visua C/C++ 8.

.IP WINDOWSDEFPREFIX
The prefix used for Windows \fB.def\fP file names.

.IP WINDOWSDEFSUFFIX
The suffix used for Windows \fB.def\fP file names.

.IP WINDOWSEXPPREFIX
The prefix used for Windows \fB.exp\fP file names.

.IP WINDOWSEXPSUFFIX
The suffix used for Windows \fB.exp\fP file names.

.IP WINDOWSPROGMANIFESTPREFIX
The prefix used for executable program \fB.manifest\fP files
generated by Microsoft Visual C/C++.

.IP WINDOWSPROGMANIFESTSUFFIX
The suffix used for executable program \fB.manifest\fP files
generated by Microsoft Visual C/C++.

.IP WINDOWSSHLIBMANIFESTPREFIX
The prefix used for shared library \fB.manifest\fP files
generated by Microsoft Visual C/C++.

.IP WINDOWSSHLIBMANIFESTSUFFIX
The suffix used for shared library \fB.manifest\fP files
generated by Microsoft Visual C/C++.

.IP X_IPK_DEPENDS
This is used to fill in the
.B Depends:
field in the controlling information for Ipkg packages.

.IP X_IPK_DESCRIPTION
This is used to fill in the
.B Description:
field in the controlling information for Ipkg packages.
The default value is
.B "$SUMMARY\\n$DESCRIPTION"
.IP X_IPK_MAINTAINER
This is used to fill in the
.B Maintainer:
field in the controlling information for Ipkg packages.

.IP X_IPK_PRIORITY
This is used to fill in the
.B Priority:
field in the controlling information for Ipkg packages.

.IP X_IPK_SECTION
This is used to fill in the
.B Section:
field in the controlling information for Ipkg packages.

.IP X_MSI_LANGUAGE
This is used to fill in the
.B Language:
attribute in the controlling information for MSI packages.

.IP X_MSI_LICENSE_TEXT
The text of the software license in RTF format.
Carriage return characters will be
replaced with the RTF equivalent \\\\par.

.IP X_MSI_UPGRADE_CODE
TODO

.IP X_RPM_AUTOREQPROV
This is used to fill in the
.B AutoReqProv:
field in the RPM
\fB.spec\fP file.

.IP X_RPM_BUILD
internal, but overridable

.IP X_RPM_BUILDREQUIRES
This is used to fill in the
.B BuildRequires:
field in the RPM
\fB.spec\fP file.

.IP X_RPM_BUILDROOT
internal, but overridable

.IP X_RPM_CLEAN
internal, but overridable

.IP X_RPM_CONFLICTS
This is used to fill in the
.B Conflicts:
field in the RPM
\fB.spec\fP file.

.IP X_RPM_DEFATTR
This value is used as the default attributes
for the files in the RPM package.
The default value is
.BR (-,root,root) .

.IP X_RPM_DISTRIBUTION
This is used to fill in the
.B Distribution:
field in the RPM
\fB.spec\fP file.

.IP X_RPM_EPOCH
This is used to fill in the
.B Epoch:
field in the controlling information for RPM packages.

.IP X_RPM_EXCLUDEARCH
This is used to fill in the
.B ExcludeArch:
field in the RPM
\fB.spec\fP file.

.IP X_RPM_EXLUSIVEARCH
This is used to fill in the
.B ExclusiveArch:
field in the RPM
\fB.spec\fP file.

.IP X_RPM_GROUP
This is used to fill in the
.B Group:
field in the RPM
\fB.spec\fP file.

.IP X_RPM_GROUP_lang
This is used to fill in the
.B Group(lang):
field in the RPM
\fB.spec\fP file.
Note that
.I lang
is not literal
and should be replaced by
the appropriate language code.

.IP X_RPM_ICON
This is used to fill in the
.B Icon:
field in the RPM
\fB.spec\fP file.

.IP X_RPM_INSTALL
internal, but overridable

.IP X_RPM_PACKAGER
This is used to fill in the
.B Packager:
field in the RPM
\fB.spec\fP file.

.IP X_RPM_POSTINSTALL
This is used to fill in the
.B %post:
section in the RPM
\fB.spec\fP file.

.IP X_RPM_POSTUNINSTALL
This is used to fill in the
.B %postun:
section in the RPM
\fB.spec\fP file.

.IP X_RPM_PREFIX
This is used to fill in the
.B Prefix:
field in the RPM
\fB.spec\fP file.

.IP X_RPM_PREINSTALL
This is used to fill in the
.B %pre:
section in the RPM
\fB.spec\fP file.

.IP X_RPM_PREP
internal, but overridable

.IP X_RPM_PREUNINSTALL
This is used to fill in the
.B %preun:
section in the RPM
\fB.spec\fP file.

.IP X_RPM_PROVIDES
This is used to fill in the
.B Provides:
field in the RPM
\fB.spec\fP file.

.IP X_RPM_REQUIRES
This is used to fill in the
.B Requires:
field in the RPM
\fB.spec\fP file.

.IP X_RPM_SERIAL
This is used to fill in the
.B Serial:
field in the RPM
\fB.spec\fP file.

.IP X_RPM_URL
This is used to fill in the
.B Url:
field in the RPM
\fB.spec\fP file.

.IP XGETTEXT
Path to \fBxgettext(1)\fP program (found via
.BR Detect() ).
See &t-link-xgettext; tool and \fBPOTUpdate\fP() builder.

.IP XGETTEXTCOM
Complete xgettext command line.
See &t-link-xgettext; tool and \fBPOTUpdate\fP() builder.

.IP XGETTEXTCOMSTR
A string that is shown when \fBxgettext(1)\fP command is invoked
(default: \fB''\fP, which means "print \fB$XGETTEXTCOM\fP").
See &t-link-xgettext; tool and \fBPOTUpdate\fP() builder.

.IP _XGETTEXTDOMAIN
Internal "macro". Generates \fBxgettext\fP domain name
form source and target (default: \fB'${TARGET.filebase}'\fP).

.IP XGETTEXTFLAGS
Additional flags to \fBxgettext(1)\fP.
See &t-link-xgettext; tool and \fBPOTUpdate\fP() builder.

.IP XGETTEXTFROM
Name of file containing list of \fBxgettext(1)\fP's source
files. Autotools' users know this as \fBPOTFILES.in\fP so they
will in most cases set \fBXGETTEXTFROM="POTFILES.in"\fP here.
The \fB$XGETTEXTFROM\fP files have same syntax and semantics as the well known
GNU \fBPOTFILES.in\fP.
See &t-link-xgettext; tool and \fBPOTUpdate\fP() builder.

.IP _XGETTEXTFROMFLAGS
Internal "macro". Genrates list of \fB\-D<dir>\fP flags
from the \fB$XGETTEXTPATH\fP list.

.IP XGETTEXTFROMPREFIX
This flag is used to add single \fB$XGETTEXTFROM\fP file to
\fBxgettext(1)\fP's commandline (default:
.BR '-f' ).

.IP XGETTEXTFROMSUFFIX
(default: \fB''\fP)

.IP XGETTEXTPATH
List of directories, there \fBxgettext(1)\fP will look for
source files (default: \fB[]\fP).
<note>This variable works only together with \fB$XGETTEXTFROM\fP
</para></note>
See also &t-link-xgettext; tool and \fBPOTUpdate\fP() builder.

.IP _XGETTEXTPATHFLAGS
Internal "macro". Generates list of \fB\-f<file>\fP flags
from \fB$XGETTEXTFROM\fP.

.IP XGETTEXTPATHPREFIX
This flag is used to add single search path to
\fBxgettext(1)\fP's commandline (default:
.BR '-D' ).

.IP XGETTEXTPATHSUFFIX
(default: \fB''\fP)

.IP YACC
The parser generator.

.IP YACCCOM
The command line used to call the parser generator
to generate a source file.

.IP YACCCOMSTR
The string displayed when generating a source file
using the parser generator.
If this is not set, then \fB$YACCCOM\fP (the command line) is displayed.

.ES
env = Environment(YACCCOMSTR = "Yacc'ing $TARGET from $SOURCES")
.EE

.IP YACCFLAGS
General options passed to the parser generator.
If \fB$YACCFLAGS\fP contains a \fB\-d\fP option,
SCons assumes that the call will also create a .h file
(if the yacc source file ends in a .y suffix)
or a .hpp file
(if the yacc source file ends in a .yy suffix)

.IP YACCHFILESUFFIX
The suffix of the C
header file generated by the parser generator
when the
.B \-d
option is used.
Note that setting this variable does not cause
the parser generator to generate a header
file with the specified suffix,
it exists to allow you to specify
what suffix the parser generator will use of its own accord.
The default value is
.BR .h .

.IP YACCHXXFILESUFFIX
The suffix of the C++
header file generated by the parser generator
when the
.B \-d
option is used.
Note that setting this variable does not cause
the parser generator to generate a header
file with the specified suffix,
it exists to allow you to specify
what suffix the parser generator will use of its own accord.
The default value is
.BR .hpp ,
except on Mac OS X,
where the default is
.BR ${TARGET.suffix}.h .
because the default &bison; parser generator just
appends \fB.h\fP
to the name of the generated C++ file.

.IP YACCVCGFILESUFFIX
The suffix of the file
containing the VCG grammar automaton definition
when the
.B \-\-graph=
option is used.
Note that setting this variable does not cause
the parser generator to generate a VCG
file with the specified suffix,
it exists to allow you to specify
what suffix the parser generator will use of its own accord.
The default value is
.BR .vcg .

.IP ZIP
The zip compression and file packaging utility.

.IP ZIPCOM
The command line used to call the zip utility,
or the internal Python function used to create a
zip archive.

.IP ZIPCOMPRESSION
The
.I compression
flag
from the Python
.B zipfile
module used by the internal Python function
to control whether the zip archive
is compressed or not.
The default value is
.BR zipfile.ZIP_DEFLATED ,
which creates a compressed zip archive.
This value has no effect if the
.B zipfile
module is unavailable.

.IP ZIPCOMSTR
The string displayed when archiving files
using the zip utility.
If this is not set, then \fB$ZIPCOM\fP
(the command line or internal Python function) is displayed.

.ES
env = Environment(ZIPCOMSTR = "Zipping $TARGET")
.EE

.IP ZIPFLAGS
General options passed to the zip utility.

.IP ZIPSUFFIX
The suffix used for zip file names.
'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
'\" END GENERATED CONSTRUCTION VARIABLE DESCRIPTIONS
'\"
'\" The descriptions above of the various SCons construction variables
'\" are generated from the .xml files that live next to the various
'\" Python modules in the build enginer library.  If you're reading
'\" this [gnt]roff file with an eye towards patching this man page,
'\" you can still submit a diff against this text, but it will have to
'\" be translated to a diff against the underlying .xml file before the
'\" patch is actually accepted.  If you do that yourself, it will make
'\" it easier to integrate the patch.
'\"
'\" END GENERATED CONSTRUCTION VARIABLE DESCRIPTIONS
'\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""

.LP
Construction variables can be retrieved and set using the
.B Dictionary
method of the construction environment:

.ES
dict = env.Dictionary()
dict["CC"] = "cc"
.EE

or using the [] operator:

.ES
env["CC"] = "cc"
.EE

Construction variables can also be passed to the construction environment
constructor:

.ES
env = Environment(CC="cc")
.EE

or when copying a construction environment using the
.B Clone
method:

.ES
env2 = env.Clone(CC="cl.exe")
.EE

.SS Configure Contexts

.B scons
supports
.I configure contexts,
an integrated mechanism similar to the
various AC_CHECK macros in GNU autoconf
for testing for the existence of C header
files, libraries, etc.
In contrast to autoconf,
.B scons
does not maintain an explicit cache of the tested values,
but uses its normal dependency tracking to keep the checked values
up to date. However, users may override this behaviour with the
.B --config
command line option.

The following methods can be used to perform checks:

.TP
.RI Configure( env ", [" custom_tests ", " conf_dir ", " log_file ", " config_h ", " clean ", " help])
.TP
.RI env.Configure([ custom_tests ", " conf_dir ", " log_file ", " config_h ", " clean ", " help])
This creates a configure context, which can be used to perform checks.
.I env
specifies the environment for building the tests.
This environment may be modified when performing checks.
.I custom_tests
is a dictionary containing custom tests.
See also the section about custom tests below.
By default, no custom tests are added to the configure context.
.I conf_dir
specifies a directory where the test cases are built.
Note that this directory is not used for building
normal targets.
The default value is the directory
#/.sconf_temp.
.I log_file
specifies a file which collects the output from commands
that are executed to check for the existence of header files, libraries, etc.
The default is the file #/config.log.
If you are using the
.BR VariantDir ()
method,
you may want to specify a subdirectory under your variant directory.
.I config_h
specifies a C header file where the results of tests
will be written, e.g. #define HAVE_STDIO_H, #define HAVE_LIBM, etc.
The default is to not write a
.B config.h
file.
You can specify the same
.B config.h
file in multiple calls to Configure,
in which case
.B scons
will concatenate all results in the specified file.
Note that SCons
uses its normal dependency checking
to decide if it's necessary to rebuild
the specified
.I config_h
file.
This means that the file is not necessarily re-built each
time scons is run,
but is only rebuilt if its contents will have changed
and some target that depends on the
.I config_h
file is being built.

The optional
.B clean
and
.B help
arguments can be used to suppress execution of the configuration
tests when the
.B -c/--clean
or
.B -H/-h/--help
options are used, respectively.
The default behavior is always to execute
configure context tests,
since the results of the tests may
affect the list of targets to be cleaned
or the help text.
If the configure tests do not affect these,
then you may add the
.B clean=False
or
.B help=False
arguments
(or both)
to avoid unnecessary test execution.

.EE
A created
.B Configure
instance has the following associated methods:

.TP
.RI SConf.Finish( context )
.TP
.IR sconf .Finish()
This method should be called after configuration is done.
It returns the environment as modified
by the configuration checks performed.
After this method is called, no further checks can be performed
with this configuration context.
However, you can create a new
.RI Configure
context to perform additional checks.
Only one context should be active at a time.

The following Checks are predefined.
(This list will likely grow larger as time
goes by and developers contribute new useful tests.)

.TP
.RI SConf.CheckHeader( context ", " header ", [" include_quotes ", " language ])
.TP
.IR sconf .CheckHeader( header ", [" include_quotes ", " language ])
Checks if
.I header
is usable in the specified language.
.I header
may be a list,
in which case the last item in the list
is the header file to be checked,
and the previous list items are
header files whose
.B #include
lines should precede the
header line being checked for.
The optional argument
.I include_quotes
must be
a two character string, where the first character denotes the opening
quote and the second character denotes the closing quote.
By default, both characters  are " (double quote).
The optional argument
.I language
should be either
.B C
or
.B C++
and selects the compiler to be used for the check.
Returns 1 on success and 0 on failure.

.TP
.RI SConf.CheckCHeader( context ", " header ", [" include_quotes ])
.TP
.IR sconf .CheckCHeader( header ", [" include_quotes ])
This is a wrapper around
.B SConf.CheckHeader
which checks if
.I header
is usable in the C language.
.I header
may be a list,
in which case the last item in the list
is the header file to be checked,
and the previous list items are
header files whose
.B #include
lines should precede the
header line being checked for.
The optional argument
.I include_quotes
must be
a two character string, where the first character denotes the opening
quote and the second character denotes the closing quote (both default
to \N'34').
Returns 1 on success and 0 on failure.

.TP
.RI SConf.CheckCXXHeader( context ", " header ", [" include_quotes ])
.TP
.IR sconf .CheckCXXHeader( header ", [" include_quotes ])
This is a wrapper around
.B SConf.CheckHeader
which checks if
.I header
is usable in the C++ language.
.I header
may be a list,
in which case the last item in the list
is the header file to be checked,
and the previous list items are
header files whose
.B #include
lines should precede the
header line being checked for.
The optional argument
.I include_quotes
must be
a two character string, where the first character denotes the opening
quote and the second character denotes the closing quote (both default
to \N'34').
Returns 1 on success and 0 on failure.

.TP
.RI SConf.CheckFunc( context, ", " function_name ", [" header ", " language ])
.TP
.IR sconf .CheckFunc( function_name ", [" header ", " language ])
Checks if the specified
C or C++ function is available.
.I function_name
is the name of the function to check for.
The optional
.I header
argument is a string
that will be
placed at the top
of the test file
that will be compiled
to check if the function exists;
the default is:
.ES
#ifdef __cplusplus
extern "C"
#endif
char function_name();
.EE
The optional
.I language
argument should be
.B C
or
.B C++
and selects the compiler to be used for the check;
the default is "C".

.TP
.RI SConf.CheckLib( context ", [" library ", " symbol ", " header ", " language ", " autoadd=1 ])
.TP
.IR sconf .CheckLib([ library ", " symbol ", " header ", " language ", " autoadd=1 ])
Checks if
.I library
provides
.IR symbol .
If the value of
.I autoadd
is 1 and the library provides the specified
.IR symbol ,
appends the library to the LIBS construction environment variable.
.I library
may also be None (the default),
in which case
.I symbol
is checked with the current LIBS variable,
or a list of library names,
in which case each library in the list
will be checked for
.IR symbol .
If
.I symbol
is not set or is
.BR None ,
then
.BR SConf.CheckLib ()
just checks if
you can link against the specified
.IR library .
The optional
.I language
argument should be
.B C
or
.B C++
and selects the compiler to be used for the check;
the default is "C".
The default value for
.I autoadd
is 1.
This method returns 1 on success and 0 on error.

.TP
.RI SConf.CheckLibWithHeader( context ", " library ", " header ", " language ", [" call ", " autoadd ])
.TP
.IR sconf .CheckLibWithHeader( library ", " header ", " language ", [" call ", " autoadd ])

In contrast to the
.RI SConf.CheckLib
call, this call provides a more sophisticated way to check against libraries.
Again,
.I library
specifies the library or a list of libraries to check.
.I header
specifies a header to check for.
.I header
may be a list,
in which case the last item in the list
is the header file to be checked,
and the previous list items are
header files whose
.B #include
lines should precede the
header line being checked for.
.I language
may be one of 'C','c','CXX','cxx','C++' and 'c++'.
.I call
can be any valid expression (with a trailing ';').
If
.I call
is not set,
the default simply checks that you
can link against the specified
.IR library .
.I autoadd
specifies whether to add the library to the environment (only if the check
succeeds). This method returns 1 on success and 0 on error.

.TP
.RI SConf.CheckType( context ", " type_name ", [" includes ", " language ])
.TP
.IR sconf .CheckType( type_name ", [" includes ", " language ])
Checks for the existence of a type defined by
.BR typedef .
.I type_name
specifies the typedef name to check for.
.I includes
is a string containing one or more
.B #include
lines that will be inserted into the program
that will be run to test for the existence of the type.
The optional
.I language
argument should be
.B C
or
.B C++
and selects the compiler to be used for the check;
the default is "C".
Example:
.ES
sconf.CheckType('foo_type', '#include "my_types.h"', 'C++')
.EE

.TP
.RI Configure.CheckCC( self )
Checks whether the C compiler (as defined by the CC construction variable) works
by trying to compile a small source file.

By default, SCons only detects if there is a program with the correct name, not
if it is a functioning compiler.

This uses the exact same command than the one used by the object builder for C
source file, so it can be used to detect if a particular compiler flag works or
not.

.TP
.RI Configure.CheckCXX( self )
Checks whether the C++ compiler (as defined by the CXX construction variable)
works by trying to compile a small source file. By default, SCons only detects
if there is a program with the correct name, not if it is a functioning compiler.

This uses the exact same command than the one used by the object builder for
CXX source files, so it can be used to detect if a particular compiler flag
works or not.

.TP
.RI Configure.CheckSHCC( self )
Checks whether the C compiler (as defined by the SHCC construction variable) works
by trying to compile a small source file. By default, SCons only detects if
there is a program with the correct name, not if it is a functioning compiler.

This uses the exact same command than the one used by the object builder for C
source file, so it can be used to detect if a particular compiler flag works or
not. This does not check whether the object code can be used to build a shared
library, only that the compilation (not link) succeeds.

.TP
.RI Configure.CheckSHCXX( self )
Checks whether the C++ compiler (as defined by the SHCXX construction variable)
works by trying to compile a small source file. By default, SCons only detects
if there is a program with the correct name, not if it is a functioning compiler.

This uses the exact same command than the one used by the object builder for
CXX source files, so it can be used to detect if a particular compiler flag
works or not. This does not check whether the object code can be used to build
a shared library, only that the compilation (not link) succeeds.

.EE
Example of a typical Configure usage:

.ES
env = Environment()
conf = Configure( env )
if not conf.CheckCHeader( 'math.h' ):
    print 'We really need math.h!'
    Exit(1)
if conf.CheckLibWithHeader( 'qt', 'qapp.h', 'c++',
        'QApplication qapp(0,0);' ):
    # do stuff for qt - usage, e.g.
    conf.env.Append( CPPFLAGS = '-DWITH_QT' )
env = conf.Finish()
.EE

.TP
.RI SConf.CheckTypeSize( context ", " type_name ", [" header ", " language ", " expect ])
.TP
.IR sconf .CheckTypeSize( type_name ", [" header ", " language ", " expect ])
Checks for the size of a type defined by
.BR typedef .
.I type_name
specifies the typedef name to check for.
The optional
.I header
argument is a string
that will be
placed at the top
of the test file
that will be compiled
to check if the function exists;
the default is empty.
The optional
.I language
argument should be
.B C
or
.B C++
and selects the compiler to be used for the check;
the default is "C".
The optional
.I expect
argument should be an integer.
If this argument is used,
the function will only check whether the type
given in type_name has the expected size (in bytes).
For example,
.B "CheckTypeSize('short', expect = 2)"
will return success only if short is two bytes.

.ES
.EE

.TP
.RI SConf.CheckDeclaration( context ", " symbol ", [" includes ", " language ])
.TP
.IR sconf .CheckDeclaration( symbol ", [" includes ", " language ])
Checks if the specified
.I symbol
is declared.
.I includes
is a string containing one or more
.B #include
lines that will be inserted into the program
that will be run to test for the existence of the type.
The optional
.I language
argument should be
.B C
or
.B C++
and selects the compiler to be used for the check;
the default is "C".

.TP
.RI SConf.Define( context ", " symbol ", [" value ", " comment ])
.TP
.IR sconf .Define( symbol ", [" value ", " comment ])
This function does not check for anything, but defines a
preprocessor symbol that will be added to the configuration header file.
It is the equivalent of AC_DEFINE,
and defines the symbol
.I name
with the optional
.B value
and the optional comment
.BR comment .

.IP
Examples:

.ES
env = Environment()
conf = Configure( env )

# Puts the following line in the config header file:
#    #define A_SYMBOL
conf.Define('A_SYMBOL')

# Puts the following line in the config header file:
#    #define A_SYMBOL 1
conf.Define('A_SYMBOL', 1)
.EE

.IP
Be careful about quoting string values, though:

.ES
env = Environment()
conf = Configure( env )

# Puts the following line in the config header file:
#    #define A_SYMBOL YA
conf.Define('A_SYMBOL', "YA")

# Puts the following line in the config header file:
#    #define A_SYMBOL "YA"
conf.Define('A_SYMBOL', '"YA"')
.EE

.IP
For comment:

.ES
env = Environment()
conf = Configure( env )

# Puts the following lines in the config header file:
#    /* Set to 1 if you have a symbol */
#    #define A_SYMBOL 1
conf.Define('A_SYMBOL', 1, 'Set to 1 if you have a symbol')
.EE

.EE
You can define your own custom checks.
in addition to the predefined checks.
These are passed in a dictionary to the Configure function.
This dictionary maps the names of the checks
to user defined Python callables
(either Python functions or class instances implementing the
.I __call__
method).
The first argument of the call is always a
.I CheckContext
instance followed by the arguments,
which must be supplied by the user of the check.
These CheckContext instances define the following methods:

.TP
.RI CheckContext.Message( self ", " text )

Usually called before the check is started.
.I text
will be displayed to the user, e.g. 'Checking for library X...'

.TP
.RI CheckContext.Result( self, ", " res )

Usually called after the check is done.
.I res
can be either an integer or a string. In the former case, 'yes' (res != 0)
or 'no' (res == 0) is displayed to the user, in the latter case the
given string is displayed.

.TP
.RI CheckContext.TryCompile( self ", " text ", " extension )
Checks if a file with the specified
.I extension
(e.g. '.c') containing
.I text
can be compiled using the environment's
.B Object
builder. Returns 1 on success and 0 on failure.

.TP
.RI CheckContext.TryLink( self ", " text ", " extension )
Checks, if a file with the specified
.I extension
(e.g. '.c') containing
.I text
can be compiled using the environment's
.B Program
builder. Returns 1 on success and 0 on failure.

.TP
.RI CheckContext.TryRun( self ", " text ", " extension )
Checks, if a file with the specified
.I extension
(e.g. '.c') containing
.I text
can be compiled using the environment's
.B Program
builder. On success, the program is run. If the program
executes successfully
(that is, its return status is 0),
a tuple
.I (1, outputStr)
is returned, where
.I outputStr
is the standard output of the
program.
If the program fails execution
(its return status is non-zero),
then (0, '') is returned.

.TP
.RI CheckContext.TryAction( self ", " action ", [" text ", " extension ])
Checks if the specified
.I action
with an optional source file (contents
.I text
, extension
.I extension
= ''
) can be executed.
.I action
may be anything which can be converted to a
.B scons
.RI Action.
On success,
.I (1, outputStr)
is returned, where
.I outputStr
is the content of the target file.
On failure
.I (0, '')
is returned.

.TP
.RI CheckContext.TryBuild( self ", " builder ", [" text ", " extension ])
Low level implementation for testing specific builds;
the methods above are based on this method.
Given the Builder instance
.I builder
and the optional
.I text
of a source file with optional
.IR extension ,
this method returns 1 on success and 0 on failure. In addition,
.I self.lastTarget
is set to the build target node, if the build was successful.

.EE
Example for implementing and using custom tests:

.ES
def CheckQt(context, qtdir):
    context.Message( 'Checking for qt ...' )
    lastLIBS = context.env['LIBS']
    lastLIBPATH = context.env['LIBPATH']
    lastCPPPATH= context.env['CPPPATH']
    context.env.Append(LIBS = 'qt', LIBPATH = qtdir + '/lib', CPPPATH = qtdir + '/include' )
    ret = context.TryLink("""
#include <qapp.h>
int main(int argc, char **argv) {
  QApplication qapp(argc, argv);
  return 0;
}
""")
    if not ret:
        context.env.Replace(LIBS = lastLIBS, LIBPATH=lastLIBPATH, CPPPATH=lastCPPPATH)
    context.Result( ret )
    return ret

env = Environment()
conf = Configure( env, custom_tests = { 'CheckQt' : CheckQt } )
if not conf.CheckQt('/usr/lib/qt'):
    print 'We really need qt!'
    Exit(1)
env = conf.Finish()
.EE

.SS Command-Line Construction Variables

Often when building software,
some variables must be specified at build time.
For example, libraries needed for the build may be in non-standard
locations, or site-specific compiler options may need to be passed to the
compiler.
.B scons
provides a
.B Variables
object to support overriding construction variables
on the command line:
.ES
$ scons VARIABLE=foo
.EE
The variable values can also be specified in a text-based SConscript file.
To create a Variables object, call the Variables() function:

.TP
.RI Variables([ files "], [" args ])
This creates a Variables object that will read construction variables from
the file or list of filenames specified in
.IR files .
If no files are specified,
or the
.I files
argument is
.BR None ,
then no files will be read.
The optional argument
.I args
is a dictionary of
values that will override anything read from the specified files;
it is primarily intended to be passed the
.B ARGUMENTS
dictionary that holds variables
specified on the command line.
Example:

.ES
vars = Variables('custom.py')
vars = Variables('overrides.py', ARGUMENTS)
vars = Variables(None, {FOO:'expansion', BAR:7})
.EE

Variables objects have the following methods:

.TP
.RI Add( key ", [" help ", " default ", " validator ", " converter ])
This adds a customizable construction variable to the Variables object.
.I key
is the name of the variable.
.I help
is the help text for the variable.
.I default
is the default value of the variable;
if the default value is
.B None
and there is no explicit value specified,
the construction variable will
.I not
be added to the construction environment.
.I validator
is called to validate the value of the variable, and should take three
arguments: key, value, and environment.
The recommended way to handle an invalid value is
to raise an exception (see example below).
.I converter
is called to convert the value before putting it in the environment, and
should take either a value, or the value and environment, as parameters.
The
.I converter
must return a value,
which will be converted into a string
before being validated by the
.I validator
(if any)
and then added to the environment.

Examples:

.ES
vars.Add('CC', 'The C compiler')

def validate_color(key, val, env):
    if not val in ['red', 'blue', 'yellow']:
        raise Exception("Invalid color value '%s'" % val)
vars.Add('COLOR', validator=valid_color)
.EE

.TP
.RI AddVariables( list )
A wrapper script that adds
multiple customizable construction variables
to a Variables object.
.I list
is a list of tuple or list objects
that contain the arguments
for an individual call to the
.B Add
method.

.ES
opt.AddVariables(
       ('debug', '', 0),
       ('CC', 'The C compiler'),
       ('VALIDATE', 'An option for testing validation',
        'notset', validator, None),
    )
.EE

.TP
.RI Update( env ", [" args ])
This updates a construction environment
.I env
with the customized construction variables.
Any specified variables that are
.I not
configured for the Variables object
will be saved and may be
retrieved with the
.BR UnknownVariables ()
method, below.

Normally this method is not called directly,
but is called indirectly by passing the Variables object to
the Environment() function:

.ES
env = Environment(variables=vars)
.EE

.IP
The text file(s) that were specified
when the Variables object was created
are executed as Python scripts,
and the values of (global) Python variables set in the file
are added to the construction environment.

Example:

.ES
CC = 'my_cc'
.EE

.TP
.RI UnknownVariables( )
Returns a dictionary containing any
variables that were specified
either in the files or the dictionary
with which the Variables object was initialized,
but for which the Variables object was
not configured.

.ES
env = Environment(variables=vars)
for key, value in vars.UnknownVariables():
    print "unknown variable:  %s=%s" % (key, value)
.EE

.TP
.RI Save( filename ", " env )
This saves the currently set variables into a script file named
.I filename
that can be used on the next invocation to automatically load the current
settings.  This method combined with the Variables method can be used to
support caching of variables between runs.

.ES
env = Environment()
vars = Variables(['variables.cache', 'custom.py'])
vars.Add(...)
vars.Update(env)
vars.Save('variables.cache', env)
.EE

.TP
.RI GenerateHelpText( env ", [" sort ])
This generates help text documenting the customizable construction
variables suitable to passing in to the Help() function.
.I env
is the construction environment that will be used to get the actual values
of customizable variables. Calling with
an optional
.I sort
function
will cause the output to be sorted
by the specified argument.
The specific
.I sort
function
should take two arguments
and return
-1, 0 or 1
(like the standard Python
.I cmp
function).

.ES
Help(vars.GenerateHelpText(env))
Help(vars.GenerateHelpText(env, sort=cmp))
.EE

.TP
.RI FormatVariableHelpText( env ", " opt ", " help ", " default ", " actual )
This method returns a formatted string
containing the printable help text
for one option.
It is normally not called directly,
but is called by the
.IR GenerateHelpText ()
method to create the returned help text.
It may be overridden with your own
function that takes the arguments specified above
and returns a string of help text formatted to your liking.
Note that the
.IR GenerateHelpText ()
will not put any blank lines or extra
characters in between the entries,
so you must add those characters to the returned
string if you want the entries separated.

.ES
def my_format(env, opt, help, default, actual):
    fmt = "\n%s: default=%s actual=%s (%s)\n"
    return fmt % (opt, default. actual, help)
vars.FormatVariableHelpText = my_format
.EE

To make it more convenient to work with customizable Variables,
.B scons
provides a number of functions
that make it easy to set up
various types of Variables:

.TP
.RI BoolVariable( key ", " help ", " default )
Return a tuple of arguments
to set up a Boolean option.
The option will use
the specified name
.IR key ,
have a default value of
.IR default ,
and display the specified
.I help
text.
The option will interpret the values
.BR y ,
.BR yes ,
.BR t ,
.BR true ,
.BR 1 ,
.B on
and
.B all
as true,
and the values
.BR n ,
.BR no ,
.BR f ,
.BR false ,
.BR 0 ,
.B off
and
.B none
as false.

.TP
.RI EnumVariable( key ", " help ", " default ", " allowed_values ", [" map ", " ignorecase ])
Return a tuple of arguments
to set up an option
whose value may be one
of a specified list of legal enumerated values.
The option will use
the specified name
.IR key ,
have a default value of
.IR default ,
and display the specified
.I help
text.
The option will only support those
values in the
.I allowed_values
list.
The optional
.I map
argument is a dictionary
that can be used to convert
input values into specific legal values
in the
.I allowed_values
list.
If the value of
.I ignore_case
is
.B 0
(the default),
then the values are case-sensitive.
If the value of
.I ignore_case
is
.BR 1 ,
then values will be matched
case-insensitive.
If the value of
.I ignore_case
is
.BR 1 ,
then values will be matched
case-insensitive,
and all input values will be
converted to lower case.

.TP
.RI ListVariable( key ", " help ", " default ", " names ", [", map ])
Return a tuple of arguments
to set up an option
whose value may be one or more
of a specified list of legal enumerated values.
The option will use
the specified name
.IR key ,
have a default value of
.IR default ,
and display the specified
.I help
text.
The option will only support the values
.BR all ,
.BR none ,
or the values in the
.I names
list.
More than one value may be specified,
with all values separated by commas.
The default may be a string of
comma-separated default values,
or a list of the default values.
The optional
.I map
argument is a dictionary
that can be used to convert
input values into specific legal values
in the
.I names
list.

.TP
.RI PackageVariable( key ", " help ", " default )
Return a tuple of arguments
to set up an option
whose value is a path name
of a package that may be
enabled, disabled or
given an explicit path name.
The option will use
the specified name
.IR key ,
have a default value of
.IR default ,
and display the specified
.I help
text.
The option will support the values
.BR yes ,
.BR true ,
.BR on ,
.BR enable
or
.BR search ,
in which case the specified
.I default
will be used,
or the option may be set to an
arbitrary string
(typically the path name to a package
that is being enabled).
The option will also support the values
.BR no ,
.BR false ,
.BR off
or
.BR disable
to disable use of the specified option.

.TP
.RI PathVariable( key ", " help ", " default ", [" validator ])
Return a tuple of arguments
to set up an option
whose value is expected to be a path name.
The option will use
the specified name
.IR key ,
have a default value of
.IR default ,
and display the specified
.I help
text.
An additional
.I validator
may be specified
that will be called to
verify that the specified path
is acceptable.
SCons supplies the
following ready-made validators:
.BR PathVariable.PathExists
(the default),
which verifies that the specified path exists;
.BR PathVariable.PathIsFile ,
which verifies that the specified path is an existing file;
.BR PathVariable.PathIsDir ,
which verifies that the specified path is an existing directory;
.BR PathVariable.PathIsDirCreate ,
which verifies that the specified path is a directory
and will create the specified directory if the path does not exist;
and
.BR PathVariable.PathAccept ,
which simply accepts the specific path name argument without validation,
and which is suitable if you want your users
to be able to specify a directory path that will be
created as part of the build process, for example.
You may supply your own
.I validator
function,
which must take three arguments
.RI ( key ,
the name of the variable to be set;
.IR val ,
the specified value being checked;
and
.IR env ,
the construction environment)
and should raise an exception
if the specified value is not acceptable.

.RE
These functions make it
convenient to create a number
of variables with consistent behavior
in a single call to the
.B AddVariables
method:

.ES
vars.AddVariables(
    BoolVariable('warnings', 'compilation with -Wall and similiar', 1),
    EnumVariable('debug', 'debug output and symbols', 'no'
               allowed_values=('yes', 'no', 'full'),
               map={}, ignorecase=0),  # case sensitive
    ListVariable('shared',
               'libraries to build as shared libraries',
               'all',
               names = list_of_libs),
    PackageVariable('x11',
                  'use X11 installed here (yes = search some places)',
                  'yes'),
    PathVariable('qtdir', 'where the root of Qt is installed', qtdir),
    PathVariable('foopath', 'where the foo library is installed', foopath,
               PathVariable.PathIsDir),

)
.EE

.SS File and Directory Nodes

The
.IR File ()
and
.IR Dir ()
functions return
.I File
and
.I Dir
Nodes, respectively.
python objects, respectively.
Those objects have several user-visible attributes
and methods that are often useful:

.IP path
The build path
of the given
file or directory.
This path is relative to the top-level directory
(where the
.B SConstruct
file is found).
The build path is the same as the source path if
.I variant_dir
is not being used.

.IP abspath
The absolute build path of the given file or directory.

.IP srcnode()
The
.IR srcnode ()
method
returns another
.I File
or
.I Dir
object representing the
.I source
path of the given
.I File
or
.IR Dir .
The

.ES
# Get the current build dir's path, relative to top.
Dir('.').path
# Current dir's absolute path
Dir('.').abspath
# Next line is always '.', because it is the top dir's path relative to itself.
Dir('#.').path
File('foo.c').srcnode().path   # source path of the given source file.

# Builders also return File objects:
foo = env.Program('foo.c')
print "foo will be built in %s"%foo.path
.EE

A
.I Dir
Node or
.I File
Node can also be used to create
file and subdirectory Nodes relative to the generating Node.
A
.I Dir
Node will place the new Nodes within the directory it represents.
A
.I File
node will place the new Nodes within its parent directory
(that is, "beside" the file in question).
If
.I d
is a
.I Dir
(directory) Node and
.I f
is a
.I File
(file) Node,
then these methods are available:

.TP
.IR d .Dir( name )
Returns a directory Node for a subdirectory of
.I d
named
.IR name .

.TP
.IR d .File( name )
Returns a file Node for a file within
.I d
named
.IR name .

.TP
.IR d .Entry( name )
Returns an unresolved Node within
.I d
named
.IR name .

.TP
.IR f .Dir( name )
Returns a directory named
.I name
within the parent directory of
.IR f .

.TP
.IR f .File( name )
Returns a file named
.I name
within the parent directory of
.IR f .

.TP
.IR f .Entry( name )
Returns an unresolved Node named
.I name
within the parent directory of
.IR f .

.RE
For example:

.ES
# Get a Node for a file within a directory
incl = Dir('include')
f = incl.File('header.h')

# Get a Node for a subdirectory within a directory
dist = Dir('project-3.2.1)
src = dist.Dir('src')

# Get a Node for a file in the same directory
cfile = File('sample.c')
hfile = cfile.File('sample.h')

# Combined example
docs = Dir('docs')
html = docs.Dir('html')
index = html.File('index.html')
css = index.File('app.css')
.EE

.SH EXTENDING SCONS
.SS Builder Objects
.B scons
can be extended to build different types of targets
by adding new Builder objects
to a construction environment.
.IR "In general" ,
you should only need to add a new Builder object
when you want to build a new type of file or other external target.
If you just want to invoke a different compiler or other tool
to build a Program, Object, Library, or any other
type of output file for which
.B scons
already has an existing Builder,
it is generally much easier to
use those existing Builders
in a construction environment
that sets the appropriate construction variables
(CC, LINK, etc.).

Builder objects are created
using the
.B Builder
function.
The
.B Builder
function accepts the following arguments:

.IP action
The command line string used to build the target from the source.
.B action
can also be:
a list of strings representing the command
to be executed and its arguments
(suitable for enclosing white space in an argument),
a dictionary
mapping source file name suffixes to
any combination of command line strings
(if the builder should accept multiple source file extensions),
a Python function;
an Action object
(see the next section);
or a list of any of the above.

An action function
takes three arguments:
.I source
- a list of source nodes,
.I target
- a list of target nodes,
.I env
- the construction environment.

.IP prefix
The prefix that will be prepended to the target file name.
This may be specified as a:

.RS 10
.HP 6
*
.IR string ,

.HP 6
*
.I callable object
- a function or other callable that takes
two arguments (a construction environment and a list of sources)
and returns a prefix,

.HP 6
*
.I dictionary
- specifies a mapping from a specific source suffix (of the first
source specified) to a corresponding target prefix.  Both the source
suffix and target prefix specifications may use environment variable
substitution, and the target prefix (the 'value' entries in the
dictionary) may also be a callable object.  The default target prefix
may be indicated by a dictionary entry with a key value of None.
.RE
.P

.ES
b = Builder("build_it < $SOURCE > $TARGET",
            prefix = "file-")

def gen_prefix(env, sources):
    return "file-" + env['PLATFORM'] + '-'
b = Builder("build_it < $SOURCE > $TARGET",
            prefix = gen_prefix)

b = Builder("build_it < $SOURCE > $TARGET",
            suffix = { None: "file-",
                       "$SRC_SFX_A": gen_prefix })
.EE

.IP suffix
The suffix that will be appended to the target file name.
This may be specified in the same manner as the prefix above.
If the suffix is a string, then
.B scons
will append a '.' to the beginning of the suffix if it's not already
there.  The string returned by callable object (or obtained from the
dictionary) is untouched and must append its own '.'  to the beginning
if one is desired.

.ES
b = Builder("build_it < $SOURCE > $TARGET"
            suffix = "-file")

def gen_suffix(env, sources):
    return "." + env['PLATFORM'] + "-file"
b = Builder("build_it < $SOURCE > $TARGET",
            suffix = gen_suffix)

b = Builder("build_it < $SOURCE > $TARGET",
            suffix = { None: ".sfx1",
                       "$SRC_SFX_A": gen_suffix })
.EE

.IP ensure_suffix
When set to any true value, causes
.B scons
to add the target suffix specified by the
.I suffix
keyword to any target strings
that have a different suffix.
(The default behavior is to leave untouched
any target file name that looks like it already has any suffix.)

.ES
b1 = Builder("build_it < $SOURCE > $TARGET"
             suffix = ".out")
b2 = Builder("build_it < $SOURCE > $TARGET"
             suffix = ".out",
             ensure_suffix)
env = Environment()
env['BUILDERS']['B1'] = b1
env['BUILDERS']['B2'] = b2

# Builds "foo.txt" because ensure_suffix is not set.
env.B1('foo.txt', 'foo.in')

# Builds "bar.txt.out" because ensure_suffix is set.
env.B2('bar.txt', 'bar.in')
.EE

.IP src_suffix
The expected source file name suffix.  This may be a string or a list
of strings.

.IP target_scanner
A Scanner object that
will be invoked to find
implicit dependencies for this target file.
This keyword argument should be used
for Scanner objects that find
implicit dependencies
based only on the target file
and the construction environment,
.I not
for implicit dependencies based on source files.
(See the section "Scanner Objects" below,
for information about creating Scanner objects.)

.IP source_scanner
A Scanner object that
will be invoked to
find implicit dependencies in
any source files
used to build this target file.
This is where you would
specify a scanner to
find things like
.B #include
lines in source files.
The pre-built
.B DirScanner
Scanner object may be used to
indicate that this Builder
should scan directory trees
for on-disk changes to files
that
.B scons
does not know about from other Builder or function calls.
(See the section "Scanner Objects" below,
for information about creating your own Scanner objects.)

.IP target_factory
A factory function that the Builder will use
to turn any targets specified as strings into SCons Nodes.
By default,
SCons assumes that all targets are files.
Other useful target_factory
values include
.BR Dir ,
for when a Builder creates a directory target,
and
.BR Entry ,
for when a Builder can create either a file
or directory target.

Example:

.ES
MakeDirectoryBuilder = Builder(action=my_mkdir, target_factory=Dir)
env = Environment()
env.Append(BUILDERS = {'MakeDirectory':MakeDirectoryBuilder})
env.MakeDirectory('new_directory', [])
.EE

.IP
Note that the call to the MakeDirectory Builder
needs to specify an empty source list
to make the string represent the builder's target;
without that, it would assume the argument is the source,
and would try to deduce the target name from it,
which in the absence of an automatically-added prefix or suffix
would lead to a matching target and source name
and a circular dependency.

.IP source_factory
A factory function that the Builder will use
to turn any sources specified as strings into SCons Nodes.
By default,
SCons assumes that all source are files.
Other useful source_factory
values include
.BR Dir ,
for when a Builder uses a directory as a source,
and
.BR Entry ,
for when a Builder can use files
or directories (or both) as sources.

Example:

.ES
CollectBuilder = Builder(action=my_mkdir, source_factory=Entry)
env = Environment()
env.Append(BUILDERS = {'Collect':CollectBuilder})
env.Collect('archive', ['directory_name', 'file_name'])
.EE

.IP emitter
A function or list of functions to manipulate the target and source
lists before dependencies are established
and the target(s) are actually built.
.B emitter
can also be a string containing a construction variable to expand
to an emitter function or list of functions,
or a dictionary mapping source file suffixes
to emitter functions.
(Only the suffix of the first source file
is used to select the actual emitter function
from an emitter dictionary.)

An emitter function
takes three arguments:
.I source
- a list of source nodes,
.I target
- a list of target nodes,
.I env
- the construction environment.
An emitter must return a tuple containing two lists,
the list of targets to be built by this builder,
and the list of sources for this builder.

Example:

.ES
def e(target, source, env):
    return (target + ['foo.foo'], source + ['foo.src'])

# Simple association of an emitter function with a Builder.
b = Builder("my_build < $TARGET > $SOURCE",
            emitter = e)

def e2(target, source, env):
    return (target + ['bar.foo'], source + ['bar.src'])

# Simple association of a list of emitter functions with a Builder.
b = Builder("my_build < $TARGET > $SOURCE",
            emitter = [e, e2])

# Calling an emitter function through a construction variable.
env = Environment(MY_EMITTER = e)
b = Builder("my_build < $TARGET > $SOURCE",
            emitter = '$MY_EMITTER')

# Calling a list of emitter functions through a construction variable.
env = Environment(EMITTER_LIST = [e, e2])
b = Builder("my_build < $TARGET > $SOURCE",
            emitter = '$EMITTER_LIST')

# Associating multiple emitters with different file
# suffixes using a dictionary.
def e_suf1(target, source, env):
    return (target + ['another_target_file'], source)
def e_suf2(target, source, env):
    return (target, source + ['another_source_file'])
b = Builder("my_build < $TARGET > $SOURCE",
            emitter = {'.suf1' : e_suf1,
                       '.suf2' : e_suf2})
.EE

.IP multi
Specifies whether this builder is allowed to be called multiple times for
the same target file(s). The default is 0, which means the builder
can not be called multiple times for the same target file(s). Calling a
builder multiple times for the same target simply adds additional source
files to the target; it is not allowed to change the environment associated
with the target, specify addition environment overrides, or associate a different
builder with the target.

.IP env
A construction environment that can be used
to fetch source code using this Builder.
(Note that this environment is
.I not
used for normal builds of normal target files,
which use the environment that was
used to call the Builder for the target file.)

.IP generator
A function that returns a list of actions that will be executed to build
the target(s) from the source(s).
The returned action(s) may be
an Action object, or anything that
can be converted into an Action object
(see the next section).

The generator function
takes four arguments:
.I source
- a list of source nodes,
.I target
- a list of target nodes,
.I env
- the construction environment,
.I for_signature
- a Boolean value that specifies
whether the generator is being called
for generating a build signature
(as opposed to actually executing the command).
Example:

.ES
def g(source, target, env, for_signature):
    return [["gcc", "-c", "-o"] + target + source]

b = Builder(generator=g)
.EE

.IP
The
.I generator
and
.I action
arguments must not both be used for the same Builder.

.IP src_builder
Specifies a builder to use when a source file name suffix does not match
any of the suffixes of the builder. Using this argument produces a
multi-stage builder.

.IP single_source
Specifies that this builder expects exactly one source file per call. Giving
more than one source file without target files results in implicitely calling
the builder multiple times (once for each source given). Giving multiple
source files together with target files results in a UserError exception.

.RE
.IP
The
.I generator
and
.I action
arguments must not both be used for the same Builder.

.IP source_ext_match
When the specified
.I action
argument is a dictionary,
the default behavior when a builder is passed
multiple source files is to make sure that the
extensions of all the source files match.
If it is legal for this builder to be
called with a list of source files with different extensions,
this check can be suppressed by setting
.B source_ext_match
to
.B None
or some other non-true value.
When
.B source_ext_match
is disable,
.B scons
will use the suffix of the first specified
source file to select the appropriate action from the
.I action
dictionary.

In the following example,
the setting of
.B source_ext_match
prevents
.B scons
from exiting with an error
due to the mismatched suffixes of
.B foo.in
and
.BR foo.extra .

.ES
b = Builder(action={'.in' : 'build $SOURCES > $TARGET'},
            source_ext_match = None)

env = Environment(BUILDERS = {'MyBuild':b})
env.MyBuild('foo.out', ['foo.in', 'foo.extra'])
.EE

.IP env
A construction environment that can be used
to fetch source code using this Builder.
(Note that this environment is
.I not
used for normal builds of normal target files,
which use the environment that was
used to call the Builder for the target file.)

.ES
b = Builder(action="build < $SOURCE > $TARGET")
env = Environment(BUILDERS = {'MyBuild' : b})
env.MyBuild('foo.out', 'foo.in', my_arg = 'xyzzy')
.EE

.IP chdir
A directory from which scons
will execute the
action(s) specified
for this Builder.
If the
.B chdir
argument is
a string or a directory Node,
scons will change to the specified directory.
If the
.B chdir
is not a string or Node
and is non-zero,
then scons will change to the
target file's directory.

Note that scons will
.I not
automatically modify
its expansion of
construction variables like
.B $TARGET
and
.B $SOURCE
when using the chdir
keyword argument--that is,
the expanded file names
will still be relative to
the top-level SConstruct directory,
and consequently incorrect
relative to the chdir directory.
Builders created using chdir keyword argument,
will need to use construction variable
expansions like
.B ${TARGET.file}
and
.B ${SOURCE.file}
to use just the filename portion of the
targets and source.

.ES
b = Builder(action="build < ${SOURCE.file} > ${TARGET.file}",
            chdir=1)
env = Environment(BUILDERS = {'MyBuild' : b})
env.MyBuild('sub/dir/foo.out', 'sub/dir/foo.in')
.EE

.B WARNING:
Python only keeps one current directory
location for all of the threads.
This means that use of the
.B chdir
argument
will
.I not
work with the SCons
.B -j
option,
because individual worker threads spawned
by SCons interfere with each other
when they start changing directory.

.RE
Any additional keyword arguments supplied
when a Builder object is created
(that is, when the Builder() function is called)
will be set in the executing construction
environment when the Builder object is called.
The canonical example here would be
to set a construction variable to
the repository of a source code system.

Any additional keyword arguments supplied
when a Builder
.I object
is called
will only be associated with the target
created by that particular Builder call
(and any other files built as a
result of the call).

These extra keyword arguments are passed to the
following functions:
command generator functions,
function Actions,
and emitter functions.

.SS Action Objects

The
.BR Builder ()
function will turn its
.B action
keyword argument into an appropriate
internal Action object.
You can also explicity create Action objects
using the
.BR Action ()
global function,
which can then be passed to the
.BR Builder ()
function.
This can be used to configure
an Action object more flexibly,
or it may simply be more efficient
than letting each separate Builder object
create a separate Action
when multiple
Builder objects need to do the same thing.

The
.BR Action ()
global function
returns an appropriate object for the action
represented by the type of the first argument:

.IP Action
If the first argument is already an Action object,
the object is simply returned.

.IP String
If the first argument is a string,
a command-line Action is returned.
Note that the command-line string
may be preceded by an
.B @
(at-sign)
to suppress printing of the specified command line,
or by a
.B \-
(hyphen)
to ignore the exit status from the specified command:

.ES
Action('$CC -c -o $TARGET $SOURCES')

# Doesn't print the line being executed.
Action('@build $TARGET $SOURCES')

# Ignores return value
Action('-build $TARGET $SOURCES')
.EE
.\" XXX From Gary Ruben, 23 April 2002:
.\" What would be useful is a discussion of how you execute command
.\" shell commands ie. what is the process used to spawn the shell, pass
.\" environment variables to it etc., whether there is one shell per
.\" environment or one per command etc.  It might help to look at the Gnu
.\" make documentation to see what they think is important to discuss about
.\" a build system. I'm sure you can do a better job of organising the
.\" documentation than they have :-)

.IP List
If the first argument is a list,
then a list of Action objects is returned.
An Action object is created as necessary
for each element in the list.
If an element
.I within
the list is itself a list,
the internal list is the
command and arguments to be executed via
the command line.
This allows white space to be enclosed
in an argument by defining
a command in a list within a list:

.ES
Action([['cc', '-c', '-DWHITE SPACE', '-o', '$TARGET', '$SOURCES']])
.EE

.IP Function
If the first argument is a Python function,
a function Action is returned.
The Python function must take three keyword arguments,
.B target
(a Node object representing the target file),
.B source
(a Node object representing the source file)
and
.B env
(the construction environment
used for building the target file).
The
.B target
and
.B source
arguments may be lists of Node objects if there is
more than one target file or source file.
The actual target and source file name(s) may
be retrieved from their Node objects
via the built-in Python str() function:

.ES
target_file_name = str(target)
source_file_names = map(lambda x: str(x), source)
.EE
.IP
The function should return
.B 0
or
.B None
to indicate a successful build of the target file(s).
The function may raise an exception
or return a non-zero exit status
to indicate an unsuccessful build.

.ES
def build_it(target = None, source = None, env = None):
    # build the target from the source
    return 0

a = Action(build_it)
.EE

If the action argument is not one of the above,
None is returned.
.PP

The second argument is optional and is used to define the output
which is printed when the Action is actually performed.
In the absence of this parameter,
or if it's an empty string,
a default output depending on the type of the action is used.
For example, a command-line action will print the executed command.
The argument must be either a Python function or a string.

In the first case,
it's a function that returns a string to be printed
to describe the action being executed.
The function may also be specified by the
.IR strfunction =
keyword argument.
Like a function to build a file,
this function must take three keyword arguments:
.B target
(a Node object representing the target file),
.B source
(a Node object representing the source file)
and
.BR env
(a construction environment).
The
.B target
and
.B source
arguments may be lists of Node objects if there is
more than one target file or source file.

In the second case, you provide the string itself.
The string may also be specified by the
.IR cmdstr =
keyword argument.
The string typically contains variables, notably
$TARGET(S) and $SOURCE(S), or consists of just a single
variable, which is optionally defined somewhere else.
SCons itself heavily uses the latter variant.

Examples:

.ES
def build_it(target, source, env):
    # build the target from the source
    return 0

def string_it(target, source, env):
    return "building '%s' from '%s'" % (target[0], source[0])

# Use a positional argument.
f = Action(build_it, string_it)
s = Action(build_it, "building '$TARGET' from '$SOURCE'")

# Alternatively, use a keyword argument.
f = Action(build_it, strfunction=string_it)
s = Action(build_it, cmdstr="building '$TARGET' from '$SOURCE'")

# You can provide a configurable variable.
l = Action(build_it, '$STRINGIT')
.EE

The third and succeeding arguments, if present,
may either be a construction variable or a list of construction variables
whose values will be included in the signature of the Action
when deciding whether a target should be rebuilt because the action changed.
The variables may also be specified by a
.IR varlist =
keyword parameter;
if both are present, they are combined.
This is necessary whenever you want a target to be rebuilt
when a specific construction variable changes.
This is not often needed for a string action,
as the expanded variables will normally be part of the command line,
but may be needed if a Python function action uses
the value of a construction variable when generating the command line.

.ES
def build_it(target, source, env):
    # build the target from the 'XXX' construction variable
    open(target[0], 'w').write(env['XXX'])
    return 0

# Use positional arguments.
a = Action(build_it, '$STRINGIT', ['XXX'])

# Alternatively, use a keyword argument.
a = Action(build_it, varlist=['XXX'])
.EE

The
.BR Action ()
global function
can be passed the following
optional keyword arguments
to modify the Action object's behavior:

.IP
.B chdir
The
.B chdir
keyword argument specifies that
scons will execute the action
after changing to the specified directory.
If the
.B chdir
argument is
a string or a directory Node,
scons will change to the specified directory.
If the
.B chdir
argument
is not a string or Node
and is non-zero,
then scons will change to the
target file's directory.

Note that scons will
.I not
automatically modify
its expansion of
construction variables like
.B $TARGET
and
.B $SOURCE
when using the chdir
keyword argument--that is,
the expanded file names
will still be relative to
the top-level SConstruct directory,
and consequently incorrect
relative to the chdir directory.
Builders created using chdir keyword argument,
will need to use construction variable
expansions like
.B ${TARGET.file}
and
.B ${SOURCE.file}
to use just the filename portion of the
targets and source.

.ES
a = Action("build < ${SOURCE.file} > ${TARGET.file}",
           chdir=1)
.EE

.IP
.B exitstatfunc
The
.BR Action ()
global function
also takes an
.B exitstatfunc
keyword argument
which specifies a function
that is passed the exit status
(or return value)
from the specified action
and can return an arbitrary
or modified value.
This can be used, for example,
to specify that an Action object's
return value should be ignored
under special conditions
and SCons should, therefore,
consider that the action always suceeds:

.ES
def always_succeed(s):
    # Always return 0, which indicates success.
    return 0
a = Action("build < ${SOURCE.file} > ${TARGET.file}",
           exitstatfunc=always_succeed)
.EE

.IP
.B batch_key
The
.B batch_key
keyword argument can be used
to specify that the Action can create multiple target files
by processing multiple independent source files simultaneously.
(The canonical example is "batch compilation"
of multiple object files
by passing multiple source files
to a single invocation of a compiler
such as Microsoft's Visual C / C++ compiler.)
If the
.B batch_key
argument is any non-False, non-callable Python value,
the configured Action object will cause
.B scons
to collect all targets built with the Action object
and configured with the same construction environment
into single invocations of the Action object's
command line or function.
Command lines will typically want to use the
.BR CHANGED_SOURCES
construction variable
(and possibly
.BR CHANGED_TARGETS
as well)
to only pass to the command line those sources that
have actually changed since their targets were built.

Example:

.ES
a = Action('build $CHANGED_SOURCES', batch_key=True)
.EE

The
.B batch_key
argument may also be
a callable function
that returns a key that
will be used to identify different
"batches" of target files to be collected
for batch building.
A
.B batch_key
function must take the following arguments:

.IP action
The action object.

.IP env
The construction environment
configured for the target.

.IP target
The list of targets for a particular configured action.

.IP source
The list of source for a particular configured action.

The returned key should typically
be a tuple of values derived from the arguments,
using any appropriate logic to decide
how multiple invocations should be batched.
For example, a
.B batch_key
function may decide to return
the value of a specific construction
variable from the
.B env
argument
which will cause
.B scons
to batch-build targets
with matching values of that variable,
or perhaps return the
.BR id ()
of the entire construction environment,
in which case
.B scons
will batch-build
all targets configured with the same construction environment.
Returning
.B None
indicates that
the particular target should
.I not
be part of any batched build,
but instead will be built
by a separate invocation of action's
command or function.
Example:

.ES
def batch_key(action, env, target, source):
    tdir = target[0].dir
    if tdir.name == 'special':
        # Don't batch-build any target
        # in the special/ subdirectory.
        return None
    return (id(action), id(env), tdir)
a = Action('build $CHANGED_SOURCES', batch_key=batch_key)
.EE

.SS Miscellaneous Action Functions

.B scons
supplies a number of functions
that arrange for various common
file and directory manipulations
to be performed.
These are similar in concept to "tasks" in the
Ant build tool,
although the implementation is slightly different.
These functions do not actually
perform the specified action
at the time the function is called,
but instead return an Action object
that can be executed at the
appropriate time.
(In Object-Oriented terminology,
these are actually
Action
.I Factory
functions
that return Action objects.)

In practice,
there are two natural ways
that these
Action Functions
are intended to be used.

First,
if you need
to perform the action
at the time the SConscript
file is being read,
you can use the
.B Execute
global function to do so:
.ES
Execute(Touch('file'))
.EE

Second,
you can use these functions
to supply Actions in a list
for use by the
.B Command
method.
This can allow you to
perform more complicated
sequences of file manipulation
without relying
on platform-specific
external commands:
that
.ES
env = Environment(TMPBUILD = '/tmp/builddir')
env.Command('foo.out', 'foo.in',
            [Mkdir('$TMPBUILD'),
             Copy('$TMPBUILD', '${SOURCE.dir}'),
             "cd $TMPBUILD && make",
             Delete('$TMPBUILD')])
.EE

.TP
.RI Chmod( dest ", " mode )
Returns an Action object that
changes the permissions on the specified
.I dest
file or directory to the specified
.IR mode .
Examples:

.ES
Execute(Chmod('file', 0755))

env.Command('foo.out', 'foo.in',
            [Copy('$TARGET', '$SOURCE'),
             Chmod('$TARGET', 0755)])
.EE

.TP
.RI Copy( dest ", " src )
Returns an Action object
that will copy the
.I src
source file or directory to the
.I dest
destination file or directory.
Examples:

.ES
Execute(Copy('foo.output', 'foo.input'))

env.Command('bar.out', 'bar.in',
            Copy('$TARGET', '$SOURCE'))
.EE

.TP
.RI Delete( entry ", [" must_exist ])
Returns an Action that
deletes the specified
.IR entry ,
which may be a file or a directory tree.
If a directory is specified,
the entire directory tree
will be removed.
If the
.I must_exist
flag is set,
then a Python error will be thrown
if the specified entry does not exist;
the default is
.BR must_exist=0 ,
that is, the Action will silently do nothing
if the entry does not exist.
Examples:

.ES
Execute(Delete('/tmp/buildroot'))

env.Command('foo.out', 'foo.in',
            [Delete('${TARGET.dir}'),
             MyBuildAction])

Execute(Delete('file_that_must_exist', must_exist=1))
.EE

.TP
.RI Mkdir( dir )
Returns an Action
that creates the specified
directory
.I dir .
Examples:

.ES
Execute(Mkdir('/tmp/outputdir'))

env.Command('foo.out', 'foo.in',
            [Mkdir('/tmp/builddir'),
             Copy('/tmp/builddir/foo.in', '$SOURCE'),
             "cd /tmp/builddir && make",
             Copy('$TARGET', '/tmp/builddir/foo.out')])
.EE

.TP
.RI Move( dest ", " src )
Returns an Action
that moves the specified
.I src
file or directory to
the specified
.I dest
file or directory.
Examples:

.ES
Execute(Move('file.destination', 'file.source'))

env.Command('output_file', 'input_file',
            [MyBuildAction,
             Move('$TARGET', 'file_created_by_MyBuildAction')])
.EE

.TP
.RI Touch( file )
Returns an Action
that updates the modification time
on the specified
.IR file .
Examples:

.ES
Execute(Touch('file_to_be_touched'))

env.Command('marker', 'input_file',
            [MyBuildAction,
             Touch('$TARGET')])
.EE

.SS Variable Substitution

Before executing a command,
.B scons
performs construction variable interpolation on the strings that make up
the command line of builders.
Variables are introduced by a
.B $
prefix.
Besides construction variables, scons provides the following
variables for each command execution:

.IP CHANGED_SOURCES
The file names of all sources of the build command
that have changed since the target was last built.

.IP CHANGED_TARGETS
The file names of all targets that would be built
from sources that have changed since the target was last built.

.IP SOURCE
The file name of the source of the build command,
or the file name of the first source
if multiple sources are being built.

.IP SOURCES
The file names of the sources of the build command.

.IP TARGET
The file name of the target being built,
or the file name of the first target
if multiple targets are being built.

.IP TARGETS
The file names of all targets being built.

.IP UNCHANGED_SOURCES
The file names of all sources of the build command
that have
.I not
changed since the target was last built.

.IP UNCHANGED_TARGETS
The file names of all targets that would be built
from sources that have
.I not
changed since the target was last built.

(Note that the above variables are reserved
and may not be set in a construction environment.)

.LP
For example, given the construction variable CC='cc', targets=['foo'], and
sources=['foo.c', 'bar.c']:

.ES
action='$CC -c -o $TARGET $SOURCES'
.EE

would produce the command line:

.ES
cc -c -o foo foo.c bar.c
.EE

Variable names may be surrounded by curly braces ({})
to separate the name from the trailing characters.
Within the curly braces, a variable name may have
a Python slice subscript appended to select one
or more items from a list.
In the previous example, the string:

.ES
${SOURCES[1]}
.EE

would produce:

.ES
bar.c
.EE

Additionally, a variable name may
have the following special
modifiers appended within the enclosing curly braces
to modify the interpolated string:

.IP base
The base path of the file name,
including the directory path
but excluding any suffix.

.IP dir
The name of the directory in which the file exists.

.IP file
The file name,
minus any directory portion.

.IP filebase
Just the basename of the file,
minus any suffix
and minus the directory.

.IP suffix
Just the file suffix.

.IP abspath
The absolute path name of the file.

.IP posix
The POSIX form of the path,
with directories separated by
.B /
(forward slashes)
not backslashes.
This is sometimes necessary on Windows systems
when a path references a file on other (POSIX) systems.

.IP srcpath
The directory and file name to the source file linked to this file through
.BR VariantDir ().
If this file isn't linked,
it just returns the directory and filename unchanged.

.IP srcdir
The directory containing the source file linked to this file through
.BR VariantDir ().
If this file isn't linked,
it just returns the directory part of the filename.

.IP rsrcpath
The directory and file name to the source file linked to this file through
.BR VariantDir ().
If the file does not exist locally but exists in a Repository,
the path in the Repository is returned.
If this file isn't linked, it just returns the
directory and filename unchanged.

.IP rsrcdir
The Repository directory containing the source file linked to this file through
.BR VariantDir ().
If this file isn't linked,
it just returns the directory part of the filename.

.LP
For example, the specified target will
expand as follows for the corresponding modifiers:

.ES
$TARGET              => sub/dir/file.x
${TARGET.base}       => sub/dir/file
${TARGET.dir}        => sub/dir
${TARGET.file}       => file.x
${TARGET.filebase}   => file
${TARGET.suffix}     => .x
${TARGET.abspath}    => /top/dir/sub/dir/file.x

SConscript('src/SConscript', variant_dir='sub/dir')
$SOURCE              => sub/dir/file.x
${SOURCE.srcpath}    => src/file.x
${SOURCE.srcdir}     => src

Repository('/usr/repository')
$SOURCE              => sub/dir/file.x
${SOURCE.rsrcpath}   => /usr/repository/src/file.x
${SOURCE.rsrcdir}    => /usr/repository/src
.EE

Note that curly braces braces may also be used
to enclose arbitrary Python code to be evaluated.
(In fact, this is how the above modifiers are substituted,
they are simply attributes of the Python objects
that represent TARGET, SOURCES, etc.)
See the section "Python Code Substitution" below,
for more thorough examples of
how this can be used.

Lastly, a variable name
may be a callable Python function
associated with a
construction variable in the environment.
The function should
take four arguments:
.I target
- a list of target nodes,
.I source
- a list of source nodes,
.I env
- the construction environment,
.I for_signature
- a Boolean value that specifies
whether the function is being called
for generating a build signature.
SCons will insert whatever
the called function returns
into the expanded string:

.ES
def foo(target, source, env, for_signature):
    return "bar"

# Will expand $BAR to "bar baz"
env=Environment(FOO=foo, BAR="$FOO baz")
.EE

You can use this feature to pass arguments to a
Python function by creating a callable class
that stores one or more arguments in an object,
and then uses them when the
.B __call__()
method is called.
Note that in this case,
the entire variable expansion must
be enclosed by curly braces
so that the arguments will
be associated with the
instantiation of the class:

.ES
class foo(object):
    def __init__(self, arg):
        self.arg = arg

    def __call__(self, target, source, env, for_signature):
        return self.arg + " bar"

# Will expand $BAR to "my argument bar baz"
env=Environment(FOO=foo, BAR="${FOO('my argument')} baz")
.EE

.LP
The special pseudo-variables
.B "$("
and
.B "$)"
may be used to surround parts of a command line
that may change
.I without
causing a rebuild--that is,
which are not included in the signature
of target files built with this command.
All text between
.B "$("
and
.B "$)"
will be removed from the command line
before it is added to file signatures,
and the
.B "$("
and
.B "$)"
will be removed before the command is executed.
For example, the command line:

.ES
echo Last build occurred $( $TODAY $). > $TARGET
.EE

.LP
would execute the command:

.ES
echo Last build occurred $TODAY. > $TARGET
.EE

.LP
but the command signature added to any target files would be:

.ES
echo Last build occurred  . > $TARGET
.EE

.SS Python Code Substitution

Any python code within
.BR "${" - "}"
pairs gets evaluated by python 'eval', with the python globals set to
the current environment's set of construction variables.
So in the following case:
.ES
env['COND'] = 0
env.Command('foo.out', 'foo.in',
   '''echo ${COND==1 and 'FOO' or 'BAR'} > $TARGET''')
.EE
the command executed will be either
.ES
echo FOO > foo.out
.EE
or
.ES
echo BAR > foo.out
.EE
according to the current value of env['COND'] when the command is
executed.  The evaluation occurs when the target is being
built, not when the SConscript is being read.  So if env['COND'] is changed
later in the SConscript, the final value will be used.

Here's a more interesting example.  Note that all of COND, FOO, and
BAR are environment variables, and their values are substituted into
the final command.  FOO is a list, so its elements are interpolated
separated by spaces.

.ES
env=Environment()
env['COND'] = 0
env['FOO'] = ['foo1', 'foo2']
env['BAR'] = 'barbar'
env.Command('foo.out', 'foo.in',
    'echo ${COND==1 and FOO or BAR} > $TARGET')

# Will execute this:
#  echo foo1 foo2 > foo.out
.EE

SCons uses the following rules when converting construction variables into
command lines:

.IP String
When the value is a string it is interpreted as a space delimited list of
command line arguments.

.IP List
When the value is a list it is interpreted as a list of command line
arguments. Each element of the list is converted to a string.

.IP Other
Anything that is not a list or string is converted to a string and
interpreted as a single command line argument.

.IP Newline
Newline characters (\\n) delimit lines. The newline parsing is done after
all other parsing, so it is not possible for arguments (e.g. file names) to
contain embedded newline characters. This limitation will likely go away in
a future version of SCons.

.SS Scanner Objects

You can use the
.B Scanner
function to define
objects to scan
new file types for implicit dependencies.
The
.B Scanner
function accepts the following arguments:

.IP function
This can be either:
1) a Python function that will process
the Node (file)
and return a list of File Nodes
representing the implicit
dependencies (file names) found in the contents;
or:
2) a dictionary that maps keys
(typically the file suffix, but see below for more discussion)
to other Scanners that should be called.

If the argument is actually a Python function,
the function must take three or four arguments:

    def scanner_function(node, env, path):

    def scanner_function(node, env, path, arg=None):

The
.B node
argument is the internal
SCons node representing the file.
Use
.B str(node)
to fetch the name of the file, and
.B node.get_contents()
to fetch contents of the file.
Note that the file is
.I not
guaranteed to exist before the scanner is called,
so the scanner function should check that
if there's any chance that the scanned file
might not exist
(for example, if it's built from other files).

The
.B env
argument is the construction environment for the scan.
Fetch values from it using the
.B env.Dictionary()
method.

The
.B path
argument is a tuple (or list)
of directories that can be searched
for files.
This will usually be the tuple returned by the
.B path_function
argument (see below).

The
.B arg
argument is the argument supplied
when the scanner was created, if any.

.IP name
The name of the Scanner.
This is mainly used
to identify the Scanner internally.

.IP argument
An optional argument that, if specified,
will be passed to the scanner function
(described above)
and the path function
(specified below).

.IP skeys
An optional list that can be used to
determine which scanner should be used for
a given Node.
In the usual case of scanning for file names,
this argument will be a list of suffixes
for the different file types that this
Scanner knows how to scan.
If the argument is a string,
then it will be expanded
into a list by the current environment.

.IP path_function
A Python function that takes four or five arguments:
a construction environment,
a Node for the directory containing
the SConscript file in which
the first target was defined,
a list of target nodes,
a list of source nodes,
and an optional argument supplied
when the scanner was created.
The
.B path_function
returns a tuple of directories
that can be searched for files to be returned
by this Scanner object.
(Note that the
.BR FindPathDirs ()
function can be used to return a ready-made
.B path_function
for a given construction variable name,
instead of having to write your own function from scratch.)

.IP node_class
The class of Node that should be returned
by this Scanner object.
Any strings or other objects returned
by the scanner function
that are not of this class
will be run through the
.B node_factory
function.

.IP node_factory
A Python function that will take a string
or other object
and turn it into the appropriate class of Node
to be returned by this Scanner object.

.IP scan_check
An optional Python function that takes two arguments,
a Node (file) and a construction environment,
and returns whether the
Node should, in fact,
be scanned for dependencies.
This check can be used to eliminate unnecessary
calls to the scanner function when,
for example, the underlying file
represented by a Node does not yet exist.

.IP recursive
An optional flag that
specifies whether this scanner should be re-invoked
on the dependency files returned by the scanner.
When this flag is not set,
the Node subsystem will
only invoke the scanner on the file being scanned,
and not (for example) also on the files
specified by the #include lines
in the file being scanned.
.I recursive
may be a callable function,
in which case it will be called with a list of
Nodes found and
should return a list of Nodes
that should be scanned recursively;
this can be used to select a specific subset of
Nodes for additional scanning.

.RE
Note that
.B scons
has a global
.B SourceFileScanner
object that is used by
the
.BR Object (),
.BR SharedObject (),
and
.BR StaticObject ()
builders to decide
which scanner should be used
for different file extensions.
You can using the
.BR SourceFileScanner.add_scanner ()
method to add your own Scanner object
to the
.B scons
infrastructure
that builds target programs or
libraries from a list of
source files of different types:

.ES
def xyz_scan(node, env, path):
    contents = node.get_text_contents()
    # Scan the contents and return the included files.

XYZScanner = Scanner(xyz_scan)

SourceFileScanner.add_scanner('.xyz', XYZScanner)

env.Program('my_prog', ['file1.c', 'file2.f', 'file3.xyz'])
.EE

.SH SYSTEM-SPECIFIC BEHAVIOR
SCons and its configuration files are very portable,
due largely to its implementation in Python.
There are, however, a few portability
issues waiting to trap the unwary.
.SS .C file suffix
SCons handles the upper-case
.B .C
file suffix differently,
depending on the capabilities of
the underlying system.
On a case-sensitive system
such as Linux or UNIX,
SCons treats a file with a
.B .C
suffix as a C++ source file.
On a case-insensitive system
such as Windows,
SCons treats a file with a
.B .C
suffix as a C source file.
.SS .F file suffix
SCons handles the upper-case
.B .F
file suffix differently,
depending on the capabilities of
the underlying system.
On a case-sensitive system
such as Linux or UNIX,
SCons treats a file with a
.B .F
suffix as a Fortran source file
that is to be first run through
the standard C preprocessor.
On a case-insensitive system
such as Windows,
SCons treats a file with a
.B .F
suffix as a Fortran source file that should
.I not
be run through the C preprocessor.
.SS Windows:  Cygwin Tools and Cygwin Python vs. Windows Pythons
Cygwin supplies a set of tools and utilities
that let users work on a
Windows system using a more POSIX-like environment.
The Cygwin tools, including Cygwin Python,
do this, in part,
by sharing an ability to interpret UNIX-like path names.
For example, the Cygwin tools
will internally translate a Cygwin path name
like /cygdrive/c/mydir
to an equivalent Windows pathname
of C:/mydir (equivalent to C:\\mydir).

Versions of Python
that are built for native Windows execution,
such as the python.org and ActiveState versions,
do not have the Cygwin path name semantics.
This means that using a native Windows version of Python
to build compiled programs using Cygwin tools
(such as gcc, bison, and flex)
may yield unpredictable results.
"Mixing and matching" in this way
can be made to work,
but it requires careful attention to the use of path names
in your SConscript files.

In practice, users can sidestep
the issue by adopting the following rules:
When using gcc,
use the Cygwin-supplied Python interpreter
to run SCons;
when using Microsoft Visual C/C++
(or some other Windows compiler)
use the python.org or ActiveState version of Python
to run SCons.
.SS Windows:  scons.bat file
On Windows systems,
SCons is executed via a wrapper
.B scons.bat
file.
This has (at least) two ramifications:

First, Windows command-line users
that want to use variable assignment
on the command line
may have to put double quotes
around the assignments:

.ES
scons "FOO=BAR" "BAZ=BLEH"
.EE

Second, the Cygwin shell does not
recognize this file as being the same
as an
.B scons
command issued at the command-line prompt.
You can work around this either by
executing
.B scons.bat
from the Cygwin command line,
or by creating a wrapper shell
script named
.B scons .

.SS MinGW

The MinGW bin directory must be in your PATH environment variable or the
PATH variable under the ENV construction variable for SCons
to detect and use the MinGW tools. When running under the native Windows
Python interpreter, SCons will prefer the MinGW tools over the Cygwin
tools, if they are both installed, regardless of the order of the bin
directories in the PATH variable. If you have both MSVC and MinGW
installed and you want to use MinGW instead of MSVC,
then you must explictly tell SCons to use MinGW by passing

.ES
tools=['mingw']
.EE

to the Environment() function, because SCons will prefer the MSVC tools
over the MinGW tools.

.SH EXAMPLES

To help you get started using SCons,
this section contains a brief overview of some common tasks.

.SS Basic Compilation From a Single Source File

.ES
env = Environment()
env.Program(target = 'foo', source = 'foo.c')
.EE

Note:  Build the file by specifying
the target as an argument
("scons foo" or "scons foo.exe").
or by specifying a dot ("scons .").

.SS Basic Compilation From Multiple Source Files

.ES
env = Environment()
env.Program(target = 'foo', source = Split('f1.c f2.c f3.c'))
.EE

.SS Setting a Compilation Flag

.ES
env = Environment(CCFLAGS = '-g')
env.Program(target = 'foo', source = 'foo.c')
.EE

.SS Search The Local Directory For .h Files

Note:  You do
.I not
need to set CCFLAGS to specify -I options by hand.
SCons will construct the right -I options from CPPPATH.

.ES
env = Environment(CPPPATH = ['.'])
env.Program(target = 'foo', source = 'foo.c')
.EE

.SS Search Multiple Directories For .h Files

.ES
env = Environment(CPPPATH = ['include1', 'include2'])
env.Program(target = 'foo', source = 'foo.c')
.EE

.SS Building a Static Library

.ES
env = Environment()
env.StaticLibrary(target = 'foo', source = Split('l1.c l2.c'))
env.StaticLibrary(target = 'bar', source = ['l3.c', 'l4.c'])
.EE

.SS Building a Shared Library

.ES
env = Environment()
env.SharedLibrary(target = 'foo', source = ['l5.c', 'l6.c'])
env.SharedLibrary(target = 'bar', source = Split('l7.c l8.c'))
.EE

.SS Linking a Local Library Into a Program

.ES
env = Environment(LIBS = 'mylib', LIBPATH = ['.'])
env.Library(target = 'mylib', source = Split('l1.c l2.c'))
env.Program(target = 'prog', source = ['p1.c', 'p2.c'])
.EE

.SS Defining Your Own Builder Object

Notice that when you invoke the Builder,
you can leave off the target file suffix,
and SCons will add it automatically.

.ES
bld = Builder(action = 'pdftex < $SOURCES > $TARGET'
              suffix = '.pdf',
              src_suffix = '.tex')
env = Environment(BUILDERS = {'PDFBuilder' : bld})
env.PDFBuilder(target = 'foo.pdf', source = 'foo.tex')

# The following creates "bar.pdf" from "bar.tex"
env.PDFBuilder(target = 'bar', source = 'bar')
.EE

Note also that the above initialization
overwrites the default Builder objects,
so the Environment created above
can not be used call Builders like env.Program(),
env.Object(), env.StaticLibrary(), etc.

.SS Adding Your Own Builder Object to an Environment

.ES
bld = Builder(action = 'pdftex < $SOURCES > $TARGET'
              suffix = '.pdf',
              src_suffix = '.tex')
env = Environment()
env.Append(BUILDERS = {'PDFBuilder' : bld})
env.PDFBuilder(target = 'foo.pdf', source = 'foo.tex')
env.Program(target = 'bar', source = 'bar.c')
.EE

You also can use other Pythonic techniques to add
to the BUILDERS construction variable, such as:

.ES
env = Environment()
env['BUILDERS]['PDFBuilder'] = bld
.EE

.SS Defining Your Own Scanner Object

The following example shows an extremely simple scanner (the
.BR kfile_scan ()
function)
that doesn't use a search path at all
and simply returns the
file names present on any
.B include
lines in the scanned file.
This would implicitly assume that all included
files live in the top-level directory:

.ES
import re

'\" Note:  the \\ in the following are for the benefit of nroff/troff,
'\" not inappropriate doubled escape characters within the r'' raw string.
include_re = re.compile(r'^include\\s+(\\S+)$', re.M)

def kfile_scan(node, env, path, arg):
    contents = node.get_text_contents()
    includes = include_re.findall(contents)
    return env.File(includes)

kscan = Scanner(name = 'kfile',
                function = kfile_scan,
                argument = None,
                skeys = ['.k'])
scanners = Environment().Dictionary('SCANNERS')
env = Environment(SCANNERS = scanners + [kscan])

env.Command('foo', 'foo.k', 'kprocess < $SOURCES > $TARGET')

bar_in = File('bar.in')
env.Command('bar', bar_in, 'kprocess $SOURCES > $TARGET')
bar_in.target_scanner = kscan
.EE

It is important to note that you
have to return a list of File nodes from the scan function, simple
strings for the file names won't do. As in the examples we are showing here,
you can use the
.BR File()
function of your current Environment in order to create nodes on the fly from
a sequence of file names with relative paths.

Here is a similar but more complete example that searches
a path of directories
(specified as the
.B MYPATH
construction variable)
for files that actually exist:

.ES
import re
import os
include_re = re.compile(r'^include\\s+(\\S+)$', re.M)

def my_scan(node, env, path, arg):
    contents = node.get_text_contents()
    includes = include_re.findall(contents)
    if includes == []:
        return []
    results = []
    for inc in includes:
        for dir in path:
            file = str(dir) + os.sep + inc
            if os.path.exists(file):
                results.append(file)
                break
    return env.File(results)

scanner = Scanner(name = 'myscanner',
                 function = my_scan,
                 argument = None,
                 skeys = ['.x'],
                 path_function = FindPathDirs('MYPATH')
                 )
scanners = Environment().Dictionary('SCANNERS')
env = Environment(SCANNERS = scanners + [scanner],
                  MYPATH = ['incs'])

env.Command('foo', 'foo.x', 'xprocess < $SOURCES > $TARGET')
.EE

The
.BR FindPathDirs ()
function used in the previous example returns a function
(actually a callable Python object)
that will return a list of directories
specified in the
.B $MYPATH
construction variable. It lets SCons detect the file
.B incs/foo.inc
, even if 
.B foo.x 
contains the line
.B include foo.inc 
only.
If you need to customize how the search path is derived,
you would provide your own
.B path_function
argument when creating the Scanner object,
as follows:

.ES
# MYPATH is a list of directories to search for files in
def pf(env, dir, target, source, arg):
    top_dir = Dir('#').abspath
    results = []
    if 'MYPATH' in env:
        for p in env['MYPATH']:
            results.append(top_dir + os.sep + p)
    return results

scanner = Scanner(name = 'myscanner',
                 function = my_scan,
                 argument = None,
                 skeys = ['.x'],
                 path_function = pf
                 )
.EE

.SS Creating a Hierarchical Build

Notice that the file names specified in a subdirectory's
SConscript
file are relative to that subdirectory.

.ES
SConstruct:

    env = Environment()
    env.Program(target = 'foo', source = 'foo.c')

    SConscript('sub/SConscript')

sub/SConscript:

    env = Environment()
    # Builds sub/foo from sub/foo.c
    env.Program(target = 'foo', source = 'foo.c')

    SConscript('dir/SConscript')

sub/dir/SConscript:

    env = Environment()
    # Builds sub/dir/foo from sub/dir/foo.c
    env.Program(target = 'foo', source = 'foo.c')
.EE

.SS Sharing Variables Between SConscript Files

You must explicitly Export() and Import() variables that
you want to share between SConscript files.

.ES
SConstruct:

    env = Environment()
    env.Program(target = 'foo', source = 'foo.c')

    Export("env")
    SConscript('subdirectory/SConscript')

subdirectory/SConscript:

    Import("env")
    env.Program(target = 'foo', source = 'foo.c')
.EE

.SS Building Multiple Variants From the Same Source

Use the variant_dir keyword argument to
the SConscript function to establish
one or more separate variant build directory trees
for a given source directory:

.ES
SConstruct:

    cppdefines = ['FOO']
    Export("cppdefines")
    SConscript('src/SConscript', variant_dir='foo')

    cppdefines = ['BAR']
    Export("cppdefines")
    SConscript('src/SConscript', variant_dir='bar')

src/SConscript:

    Import("cppdefines")
    env = Environment(CPPDEFINES = cppdefines)
    env.Program(target = 'src', source = 'src.c')
.EE

Note the use of the Export() method
to set the "cppdefines" variable to a different
value each time we call the SConscript function.

.SS Hierarchical Build of Two Libraries Linked With a Program

.ES
SConstruct:

    env = Environment(LIBPATH = ['#libA', '#libB'])
    Export('env')
    SConscript('libA/SConscript')
    SConscript('libB/SConscript')
    SConscript('Main/SConscript')

libA/SConscript:

    Import('env')
    env.Library('a', Split('a1.c a2.c a3.c'))

libB/SConscript:

    Import('env')
    env.Library('b', Split('b1.c b2.c b3.c'))

Main/SConscript:

    Import('env')
    e = env.Copy(LIBS = ['a', 'b'])
    e.Program('foo', Split('m1.c m2.c m3.c'))
.EE

The '#' in the LIBPATH directories specify that they're relative to the
top-level directory, so they don't turn into "Main/libA" when they're
used in Main/SConscript.

Specifying only 'a' and 'b' for the library names
allows SCons to append the appropriate library
prefix and suffix for the current platform
(for example, 'liba.a' on POSIX systems,
\&'a.lib' on Windows).

.SS Customizing construction variables from the command line.

The following would allow the C compiler to be specified on the command
line or in the file custom.py.

.ES
vars = Variables('custom.py')
vars.Add('CC', 'The C compiler.')
env = Environment(variables=vars)
Help(vars.GenerateHelpText(env))
.EE

The user could specify the C compiler on the command line:

.ES
scons "CC=my_cc"
.EE

or in the custom.py file:

.ES
CC = 'my_cc'
.EE

or get documentation on the options:

.ES
$ scons -h

CC: The C compiler.
    default: None
    actual: cc

.EE

.SS Using Microsoft Visual C++ precompiled headers

Since windows.h includes everything and the kitchen sink, it can take quite
some time to compile it over and over again for a bunch of object files, so
Microsoft provides a mechanism to compile a set of headers once and then
include the previously compiled headers in any object file. This
technology is called precompiled headers. The general recipe is to create a
file named "StdAfx.cpp" that includes a single header named "StdAfx.h", and
then include every header you want to precompile in "StdAfx.h", and finally
include "StdAfx.h" as the first header in all the source files you are
compiling to object files. For example:

StdAfx.h:
.ES
#include <windows.h>
#include <my_big_header.h>
.EE

StdAfx.cpp:
.ES
#include <StdAfx.h>
.EE

Foo.cpp:
.ES
#include <StdAfx.h>

/* do some stuff */
.EE

Bar.cpp:
.ES
#include <StdAfx.h>

/* do some other stuff */
.EE

SConstruct:
.ES
env=Environment()
env['PCHSTOP'] = 'StdAfx.h'
env['PCH'] = env.PCH('StdAfx.cpp')[0]
env.Program('MyApp', ['Foo.cpp', 'Bar.cpp'])
.EE

For more information see the document for the PCH builder, and the PCH and
PCHSTOP construction variables. To learn about the details of precompiled
headers consult the MSDN documention for /Yc, /Yu, and /Yp.

.SS Using Microsoft Visual C++ external debugging information

Since including debugging information in programs and shared libraries can
cause their size to increase significantly, Microsoft provides a mechanism
for including the debugging information in an external file called a PDB
file. SCons supports PDB files through the PDB construction
variable.

SConstruct:
.ES
env=Environment()
env['PDB'] = 'MyApp.pdb'
env.Program('MyApp', ['Foo.cpp', 'Bar.cpp'])
.EE

For more information see the document for the PDB construction variable.

.SH ENVIRONMENT

.IP SCONS_LIB_DIR
Specifies the directory that contains the SCons Python module directory
(e.g. /home/aroach/scons-src-0.01/src/engine).

.IP SCONSFLAGS
A string of options that will be used by scons in addition to those passed
on the command line.

.SH "SEE ALSO"
.B scons
User Manual,
.B scons
Design Document,
.B scons
source code.

.SH AUTHORS
Steven Knight <knight@baldmt.com>
.br
Anthony Roach <aroach@electriceyeball.com>