SCons_experimental / doc / generated / functions.gen

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
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE sconsdoc [
    <!ENTITY % scons SYSTEM "../scons.mod">
    %scons;
    <!ENTITY % builders-mod SYSTEM "builders.mod">
    %builders-mod;
    <!ENTITY % functions-mod SYSTEM "functions.mod">
    %functions-mod;
    <!ENTITY % tools-mod SYSTEM "tools.mod">
    %tools-mod;
    <!ENTITY % variables-mod SYSTEM "variables.mod">
    %variables-mod;
]>

<variablelist xmlns="http://www.scons.org/dbxsd/v1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0/scons.xsd scons.xsd">
  <varlistentry id="f-Action">
    <term>
      <synopsis>Action(action, [cmd/str/fun, [var, ...]] [option=value, ...])</synopsis>
      <synopsis>env.Action(action, [cmd/str/fun, [var, ...]] [option=value, ...])</synopsis>
    </term>
    <listitem>
<para xmlns="http://www.scons.org/dbxsd/v1.0">
Creates an Action object for
the specified
<varname>action</varname>.
See the section "Action Objects,"
below, for a complete explanation of the arguments and behavior.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
Note that the
<function>env.Action</function>()
form of the invocation will expand
construction variables in any argument strings,
including the
<varname>action</varname>
argument, at the time it is called
using the construction variables in the
<varname>env</varname>
construction environment through which
<function>env.Action</function>()
was called.
The
<function>Action</function>()
form delays all variable expansion
until the Action object is actually used.
</para>
</listitem>
  </varlistentry>
  <varlistentry id="f-AddMethod">
    <term>
      <synopsis>AddMethod(object, function, [name])</synopsis>
      <synopsis>env.AddMethod(function, [name])</synopsis>
    </term>
    <listitem>
<para xmlns="http://www.scons.org/dbxsd/v1.0">
When called with the
<function>AddMethod</function>()
form,
adds the specified
<varname>function</varname>
to the specified
<varname>object</varname>
as the specified method
<varname>name</varname>.
When called with the
<function>env.AddMethod</function>()
form,
adds the specified
<varname>function</varname>
to the construction environment
<varname>env</varname>
as the specified method
<varname>name</varname>.
In both cases, if
<varname>name</varname>
is omitted or
<literal>None</literal>,
the name of the
specified
<varname>function</varname>
itself is used for the method name.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
Examples:
</para>

<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">
# 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')
</example_commands>
</listitem>
  </varlistentry>
  <varlistentry id="f-AddOption">
    <term>
      <synopsis>AddOption(arguments)</synopsis>
    </term>
    <listitem>
<para xmlns="http://www.scons.org/dbxsd/v1.0">
This function adds a new command-line option to be recognized.
The specified
<varname>arguments</varname>
are the same as supported by the standard Python
<function>optparse.add_option</function>()
method (with a few additional capabilities noted below);
see the documentation for
<literal>optparse</literal>
for a thorough discussion of its option-processing capabities.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
In addition to the arguments and values supported by the
<function>optparse.add_option</function>()
method,
the SCons
<function xmlns="http://www.scons.org/dbxsd/v1.0">AddOption</function>
function allows you to set the
<literal>nargs</literal>
keyword value to
<literal>'?'</literal>
(a string with just the question mark)
to indicate that the specified long option(s) take(s) an
<emphasis>optional</emphasis>
argument.
When
<literal>nargs = '?'</literal>
is passed to the
<function xmlns="http://www.scons.org/dbxsd/v1.0">AddOption</function>
function, the
<literal>const</literal>
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.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
If no
<literal>default=</literal>
keyword argument is supplied when calling
<function xmlns="http://www.scons.org/dbxsd/v1.0">AddOption</function>,
the option will have a default value of
<literal>None</literal>.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
Once a new command-line option has been added with
<function xmlns="http://www.scons.org/dbxsd/v1.0">AddOption</function>,
the option value may be accessed using
<function xmlns="http://www.scons.org/dbxsd/v1.0">GetOption</function>
or
<function>env.GetOption</function>().
The value may also be set, using
<function xmlns="http://www.scons.org/dbxsd/v1.0">SetOption</function>
or
<function>env.SetOption</function>(),
if conditions in a
<filename xmlns="http://www.scons.org/dbxsd/v1.0">SConscript</filename>
require overriding any default value.
Note, however, that a
value specified on the command line will
<emphasis>always</emphasis>
override a value set by any SConscript file.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
Any specified
<literal>help=</literal>
strings for the new option(s)
will be displayed by the
<option>-H</option>
or
<option>-h</option>
options
(the latter only if no other help text is
specified in the SConscript files).
The help text for the local options specified by
<function xmlns="http://www.scons.org/dbxsd/v1.0">AddOption</function>
will appear below the SCons options themselves,
under a separate
<literal>Local Options</literal>
heading.
The options will appear in the help text
in the order in which the
<function xmlns="http://www.scons.org/dbxsd/v1.0">AddOption</function>
calls occur.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
Example:
</para>

<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">
AddOption('--prefix',
          dest='prefix',
          nargs=1, type='string',
          action='store',
          metavar='DIR',
          help='installation prefix')
env = Environment(PREFIX = GetOption('prefix'))
</example_commands>
</listitem>
  </varlistentry>
  <varlistentry id="f-AddPostAction">
    <term>
      <synopsis>AddPostAction(target, action)</synopsis>
      <synopsis>env.AddPostAction(target, action)</synopsis>
    </term>
    <listitem>
<para xmlns="http://www.scons.org/dbxsd/v1.0">
Arranges for the specified
<varname>action</varname>
to be performed
after the specified
<varname>target</varname>
has been built.
The specified action(s) may be
an Action object, or anything that
can be converted into an Action object
(see below).
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
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.
</para>
</listitem>
  </varlistentry>
  <varlistentry id="f-AddPreAction">
    <term>
      <synopsis>AddPreAction(target, action)</synopsis>
      <synopsis>env.AddPreAction(target, action)</synopsis>
    </term>
    <listitem>
<para xmlns="http://www.scons.org/dbxsd/v1.0">
Arranges for the specified
<varname>action</varname>
to be performed
before the specified
<varname>target</varname>
is built.
The specified action(s) may be
an Action object, or anything that
can be converted into an Action object
(see below).
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
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.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
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
<filename>.c</filename>
file via an intermediate object file:
</para>

<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">
foo = Program('foo.c')
AddPreAction(foo, 'pre_action')
</example_commands>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
The specified
<literal>pre_action</literal>
would be executed before
<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename>
calls the link command that actually
generates the executable program binary
<filename>foo</filename>,
not before compiling the
<filename>foo.c</filename>
file into an object file.
</para>
</listitem>
  </varlistentry>
  <varlistentry id="f-Alias">
    <term>
      <synopsis>Alias(alias, [targets, [action]])</synopsis>
      <synopsis>env.Alias(alias, [targets, [action]])</synopsis>
    </term>
    <listitem>
<para xmlns="http://www.scons.org/dbxsd/v1.0">
Creates one or more phony targets that
expand to one or more other targets.
An optional
<varname>action</varname>
(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.
<function xmlns="http://www.scons.org/dbxsd/v1.0">Alias</function>
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.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
Examples:
</para>

<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">
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")
</example_commands>
</listitem>
  </varlistentry>
  <varlistentry id="f-AllowSubstExceptions">
    <term>
      <synopsis>AllowSubstExceptions([exception, ...])</synopsis>
    </term>
    <listitem>
<para xmlns="http://www.scons.org/dbxsd/v1.0">
Specifies the exceptions that will be allowed
when expanding construction variables.
By default,
any construction variable expansions that generate a
<literal>NameError</literal>
or
<literal>IndexError</literal>
exception will expand to a
<literal>''</literal>
(a null string) and not cause scons to fail.
All exceptions not in the specified list
will generate an error message
and terminate processing.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
If
<function xmlns="http://www.scons.org/dbxsd/v1.0">AllowSubstExceptions</function>
is called multiple times,
each call completely overwrites the previous list
of allowed exceptions.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
Example:
</para>

<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">
# 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)
</example_commands>
</listitem>
  </varlistentry>
  <varlistentry id="f-AlwaysBuild">
    <term>
      <synopsis>AlwaysBuild(target, ...)</synopsis>
      <synopsis>env.AlwaysBuild(target, ...)</synopsis>
    </term>
    <listitem>
<para xmlns="http://www.scons.org/dbxsd/v1.0">
Marks each given
<varname>target</varname>
so that it is always assumed to be out of date,
and will always be rebuilt if needed.
Note, however, that
<function xmlns="http://www.scons.org/dbxsd/v1.0">AlwaysBuild</function>
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
<emphasis>always</emphasis>
be built if so specified.
Multiple targets can be passed in to a single call to
<function xmlns="http://www.scons.org/dbxsd/v1.0">AlwaysBuild</function>.
</para>
</listitem>
  </varlistentry>
  <varlistentry id="f-Append">
    <term>
      <synopsis>env.Append(key=val, [...])</synopsis>
    </term>
    <listitem>
<para xmlns="http://www.scons.org/dbxsd/v1.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 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.)
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
Example:
</para>

<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">
env.Append(CCFLAGS = ' -g', FOO = ['foo.yyy'])
</example_commands>
</listitem>
  </varlistentry>
  <varlistentry id="f-AppendENVPath">
    <term>
      <synopsis>env.AppendENVPath(name, newpath, [envname, sep, delete_existing])</synopsis>
    </term>
    <listitem>
<para xmlns="http://www.scons.org/dbxsd/v1.0">
This appends new path elements to the given path in the
specified external environment
(<literal>ENV</literal>
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
<function>os.path.normpath</function>
and
<function>os.path.normcase</function>).
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.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
If 
<varname>delete_existing</varname>
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.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
Example:
</para>

<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">
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
</example_commands>
</listitem>
  </varlistentry>
  <varlistentry id="f-AppendUnique">
    <term>
      <synopsis>env.AppendUnique(key=val, [...], delete_existing=0)</synopsis>
    </term>
    <listitem>
<para xmlns="http://www.scons.org/dbxsd/v1.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
<emphasis>not</emphasis>
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.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
Example:
</para>

<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">
env.AppendUnique(CCFLAGS = '-g', FOO = ['foo.yyy'])
</example_commands>
</listitem>
  </varlistentry>
  <varlistentry id="f-BitKeeper">
    <term>
      <synopsis>env.BitKeeper()</synopsis>
    </term>
    <listitem>
<para xmlns="http://www.scons.org/dbxsd/v1.0">
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
<function xmlns="http://www.scons.org/dbxsd/v1.0">SourceCode</function>
function.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
This function is deprecated.  For details, see the entry for the
<function xmlns="http://www.scons.org/dbxsd/v1.0">SourceCode</function>
function.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
Example:
</para>

<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">
env.SourceCode('.', env.BitKeeper())
</example_commands>
</listitem>
  </varlistentry>
  <varlistentry id="f-BuildDir">
    <term>
      <synopsis>BuildDir(build_dir, src_dir, [duplicate])</synopsis>
      <synopsis>env.BuildDir(build_dir, src_dir, [duplicate])</synopsis>
    </term>
    <listitem>
<para xmlns="http://www.scons.org/dbxsd/v1.0">
Deprecated synonyms for
<function xmlns="http://www.scons.org/dbxsd/v1.0">VariantDir</function>
and
<function>env.VariantDir</function>().
The
<varname>build_dir</varname>
argument becomes the
<varname>variant_dir</varname>
argument of
<function xmlns="http://www.scons.org/dbxsd/v1.0">VariantDir</function>
or
<function>env.VariantDir</function>().
</para>
</listitem>
  </varlistentry>
  <varlistentry id="f-Builder">
    <term>
      <synopsis>Builder(action, [arguments])</synopsis>
      <synopsis>env.Builder(action, [arguments])</synopsis>
    </term>
    <listitem>
<para xmlns="http://www.scons.org/dbxsd/v1.0">
Creates a Builder object for
the specified
<varname>action</varname>.
See the section "Builder Objects,"
below, for a complete explanation of the arguments and behavior.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
Note that the
<function>env.Builder</function>()
form of the invocation will expand
construction variables in any arguments strings,
including the
<varname>action</varname>
argument,
at the time it is called
using the construction variables in the
<varname>env</varname>
construction environment through which
<function>env.Builder</function>()
was called.
The
<function xmlns="http://www.scons.org/dbxsd/v1.0">Builder</function>
form delays all variable expansion
until after the Builder object is actually called.
</para>
</listitem>
  </varlistentry>
  <varlistentry id="f-CacheDir">
    <term>
      <synopsis>CacheDir(cache_dir)</synopsis>
      <synopsis>env.CacheDir(cache_dir)</synopsis>
    </term>
    <listitem>
<para xmlns="http://www.scons.org/dbxsd/v1.0">
Specifies that
<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename>
will maintain a cache of derived files in
<varname>cache_dir</varname>.
The derived files in the cache will be shared
among all the builds using the same
<function xmlns="http://www.scons.org/dbxsd/v1.0">CacheDir</function>
call.
Specifying a
<varname>cache_dir</varname>
of
<literal>None</literal>
disables derived file caching.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
Calling
<function>env.CacheDir</function>()
will only affect targets built
through the specified construction environment.
Calling
<function xmlns="http://www.scons.org/dbxsd/v1.0">CacheDir</function>
sets a global default
that will be used by all targets built
through construction environments
that do
<emphasis>not</emphasis>
have an
<function>env.CacheDir</function>()
specified.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
When a
<function>CacheDir</function>()
is being used and
<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename>
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,
<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename>
will retrieve the file from the cache.
If the derived file is not present in the cache,
<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename>
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.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
Use of a specified
<function xmlns="http://www.scons.org/dbxsd/v1.0">CacheDir</function>
may be disabled for any invocation
by using the
<option>--cache-disable</option>
option.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
If the
<option>--cache-force</option>
option is used,
<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename>
will place a copy of
<emphasis>all</emphasis>
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
<function xmlns="http://www.scons.org/dbxsd/v1.0">CacheDir</function>
is added to a build,
or after using the
<option>--cache-disable</option>
option.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
When using
<function xmlns="http://www.scons.org/dbxsd/v1.0">CacheDir</function>,
<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename>
will report,
"Retrieved `file' from cache,"
unless the
<option>--cache-show</option>
option is being used.
When the
<option>--cache-show</option>
option is used,
<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename>
will print the action that
<emphasis>would</emphasis>
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.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
The
<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="f-NoCache"><function>NoCache</function></link>
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.
</para>
</listitem>
  </varlistentry>
  <varlistentry id="f-Clean">
    <term>
      <synopsis>Clean(targets, files_or_dirs)</synopsis>
      <synopsis>env.Clean(targets, files_or_dirs)</synopsis>
    </term>
    <listitem>
<para xmlns="http://www.scons.org/dbxsd/v1.0">
This specifies a list of files or directories which should be removed
whenever the targets are specified with the
<option>-c</option>
command line option.
The specified targets may be a list
or an individual target.
Multiple calls to
<function xmlns="http://www.scons.org/dbxsd/v1.0">Clean</function>
are legal,
and create new targets or add files and directories to the
clean list for the specified targets.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
Multiple files or directories should be specified
either as separate arguments to the
<function xmlns="http://www.scons.org/dbxsd/v1.0">Clean</function>
method, or as a list.
<function xmlns="http://www.scons.org/dbxsd/v1.0">Clean</function>
will also accept the return value of any of the construction environment
Builder methods.
Examples:
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
The related
<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="f-NoClean"><function>NoClean</function></link>
function overrides calling
<function xmlns="http://www.scons.org/dbxsd/v1.0">Clean</function>
for the same target,
and any targets passed to both functions will
<emphasis>not</emphasis>
be removed by the
<option>-c</option>
option.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
Examples:
</para>

<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">
Clean('foo', ['bar', 'baz'])
Clean('dist', env.Program('hello', 'hello.c'))
Clean(['foo', 'bar'], 'something_else_to_clean')
</example_commands>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
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.
</para>
<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">
Clean(docdir, os.path.join(docdir, projectname))
</example_commands>
</listitem>
  </varlistentry>
  <varlistentry id="f-Clone">
    <term>
      <synopsis>env.Clone([key=val, ...])</synopsis>
    </term>
    <listitem>
<para xmlns="http://www.scons.org/dbxsd/v1.0">
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.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
Example:
</para>

<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">
env2 = env.Clone()
env3 = env.Clone(CCFLAGS = '-g')
</example_commands>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
Additionally, a list of tools and a toolpath may be specified, as in
the Environment constructor:
</para>

<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">
def MyTool(env): env['FOO'] = 'bar'
env4 = env.Clone(tools = ['msvc', MyTool])
</example_commands>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
The
<varname>parse_flags</varname>
keyword argument is also recognized:
</para>

<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">
# create an environment for compiling programs that use wxWidgets
wx_env = env.Clone(parse_flags = '!wx-config --cflags --cxxflags')
</example_commands>
</listitem>
  </varlistentry>
  <varlistentry id="f-Command">
    <term>
      <synopsis>Command(target, source, action, [key=val, ...])</synopsis>
      <synopsis>env.Command(target, source, action, [key=val, ...])</synopsis>
    </term>
    <listitem>
<para xmlns="http://www.scons.org/dbxsd/v1.0">
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.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
As a special case, the
<varname>source_scanner</varname>
keyword argument can
be used to specify
a Scanner object
that will be used to scan the sources.
(The global
<literal>DirScanner</literal>
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.)
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
Any other keyword arguments specified override any
same-named existing construction variables.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
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
<literal>@</literal>
(at-sign)
to suppress printing the command in question,
or by a
<literal>-</literal>
(hyphen)
to ignore the exit status of the external command.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
Examples:
</para>

<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">
env.Command('foo.out', 'foo.in',
            "$FOO_BUILD &lt; $SOURCES &gt; $TARGET")

env.Command('bar.out', 'bar.in',
            ["rm -f $TARGET",
             "$BAR_BUILD &lt; $SOURCES &gt; $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 &lt; $SOURCES &gt; .tmp",
	     rename ])
</example_commands>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
Note that the
<function xmlns="http://www.scons.org/dbxsd/v1.0">Command</function>
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
<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="f-Dir"><function>Dir</function></link>
or
<function>env.Dir</function>()
functions.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
Examples:
</para>

<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">
env.Command('ddd.list', Dir('ddd'), 'ls -l $SOURCE &gt; $TARGET')

env['DISTDIR'] = 'destination/directory'
env.Command(env.Dir('$DISTDIR')), None, make_distdir)
</example_commands>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
(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.)
</para>
</listitem>
  </varlistentry>
  <varlistentry id="f-Configure">
    <term>
      <synopsis>Configure(env, [custom_tests, conf_dir, log_file, config_h])</synopsis>
      <synopsis>env.Configure([custom_tests, conf_dir, log_file, config_h])</synopsis>
    </term>
    <listitem>
<para xmlns="http://www.scons.org/dbxsd/v1.0">
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.
</para>
</listitem>
  </varlistentry>
  <varlistentry id="f-Copy">
    <term>
      <synopsis>env.Copy([key=val, ...])</synopsis>
    </term>
    <listitem>
<para xmlns="http://www.scons.org/dbxsd/v1.0">
A now-deprecated synonym for
<function>env.Clone</function>().
</para>
</listitem>
  </varlistentry>
  <varlistentry id="f-CVS">
    <term>
      <synopsis>env.CVS(repository, module)</synopsis>
    </term>
    <listitem>
<para xmlns="http://www.scons.org/dbxsd/v1.0">
A factory function that
returns a Builder object
to be used to fetch source files
from the specified
CVS
<varname>repository</varname>.
The returned Builder
is intended to be passed to the
<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="f-SourceCode"><function>SourceCode</function></link>
function.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
This function is deprecated.  For details, see the entry for the
<function xmlns="http://www.scons.org/dbxsd/v1.0">SourceCode</function>
function.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
The optional specified
<varname>module</varname>
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.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
Examples:
</para>

<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">
# 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'))
</example_commands>
</listitem>
  </varlistentry>
  <varlistentry id="f-Decider">
    <term>
      <synopsis>Decider(function)</synopsis>
      <synopsis>env.Decider(function)</synopsis>
    </term>
    <listitem>
<para xmlns="http://www.scons.org/dbxsd/v1.0">
Specifies that all up-to-date decisions for
targets built through this construction environment
will be handled by the specified
<varname>function</varname>.
The
<varname>function</varname>
can be one of the following strings
that specify the type of decision function
to be performed:
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
<variablelist>
<varlistentry>
<term><literal>timestamp-newer</literal></term>
<listitem>
<para>
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
<literal>make</literal>
can be used a synonym for
<literal>timestamp-newer</literal>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>timestamp-match</literal></term>
<listitem>
<para>
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
<emphasis>earlier</emphasis>
timestamp, such as can happen when restoring files from backup archives.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>MD5</literal></term>
<listitem>
<para>
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.
<literal>content</literal>
can be used as a synonym for
<literal>MD5</literal>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>MD5-timestamp</literal></term>
<listitem>
<para>
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
<emphasis>not</emphasis>
rebuilt.
This provides behavior very similar
to the
<literal>MD5</literal>
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
<emphasis>not</emphasis>
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.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
Examples:
</para>

<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">
# 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')
</example_commands>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
In addition to the above already-available functions,
the
<varname>function</varname>
argument may be an actual Python function
that takes the following three arguments:
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
<variablelist>
<varlistentry>
<term><parameter>dependency</parameter></term>
<listitem>
<para>
The Node (file) which
should cause the
<varname>target</varname>
to be rebuilt
if it has "changed" since the last tme
<varname>target</varname>
was built.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>target</parameter></term>
<listitem>
<para>
The Node (file) being built.
In the normal case,
this is what should get rebuilt
if the
<varname>dependency</varname>
has "changed."
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>prev_ni</parameter></term>
<listitem>
<para>
Stored information about the state of the
<varname>dependency</varname>
the last time the
<varname>target</varname>
was built.
This can be consulted to match various
file characteristics
such as the timestamp,
size, or content signature.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
The
<varname>function</varname>
should return a
<literal>True</literal>
(non-zero)
value if the
<varname>dependency</varname>
has "changed" since the last time
the
<varname>target</varname>
was built
(indicating that the target
<emphasis>should</emphasis>
be rebuilt),
and
<literal>False</literal>
(zero)
otherwise
(indicating that the target should
<emphasis>not</emphasis>
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.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
Example:
</para>

<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">
def my_decider(dependency, target, prev_ni):
    return not os.path.exists(str(target))

env.Decider(my_decider)
</example_commands>
</listitem>
  </varlistentry>
  <varlistentry id="f-Default">
    <term>
      <synopsis>Default(targets)</synopsis>
      <synopsis>env.Default(targets)</synopsis>
    </term>
    <listitem>
<para xmlns="http://www.scons.org/dbxsd/v1.0">
This specifies a list of default targets,
which will be built by
<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename>
if no explicit targets are given on the command line.
Multiple calls to
<function xmlns="http://www.scons.org/dbxsd/v1.0">Default</function>
are legal,
and add to the list of default targets.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
Multiple targets should be specified as
separate arguments to the
<function xmlns="http://www.scons.org/dbxsd/v1.0">Default</function>
method, or as a list.
<function xmlns="http://www.scons.org/dbxsd/v1.0">Default</function>
will also accept the Node returned by any
of a construction environment's
builder methods.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
Examples:
</para>

<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">
Default('foo', 'bar', 'baz')
env.Default(['a', 'b', 'c'])
hello = env.Program('hello', 'hello.c')
env.Default(hello)
</example_commands>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
An argument to
<function xmlns="http://www.scons.org/dbxsd/v1.0">Default</function>
of
<literal>None</literal>
will clear all default targets.
Later calls to
<function xmlns="http://www.scons.org/dbxsd/v1.0">Default</function>
will add to the (now empty) default-target list
like normal.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
The current list of targets added using the
<function xmlns="http://www.scons.org/dbxsd/v1.0">Default</function>
function or method is available in the
<literal>DEFAULT_TARGETS</literal>
list;
see below.
</para>
</listitem>
  </varlistentry>
  <varlistentry id="f-DefaultEnvironment">
    <term>
      <synopsis>DefaultEnvironment([args])</synopsis>
    </term>
    <listitem>
<para xmlns="http://www.scons.org/dbxsd/v1.0">
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.
</para>
</listitem>
  </varlistentry>
  <varlistentry id="f-Depends">
    <term>
      <synopsis>Depends(target, dependency)</synopsis>
      <synopsis>env.Depends(target, dependency)</synopsis>
    </term>
    <listitem>
<para xmlns="http://www.scons.org/dbxsd/v1.0">
Specifies an explicit dependency;
the
<varname>target</varname>
will be rebuilt
whenever the
<varname>dependency</varname>
has changed.
Both the specified
<varname>target</varname>
and
<varname>dependency</varname>
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.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
Example:
</para>

<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">
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)
</example_commands>
</listitem>
  </varlistentry>
  <varlistentry id="f-Dictionary">
    <term>
      <synopsis>env.Dictionary([vars])</synopsis>
    </term>
    <listitem>
<para xmlns="http://www.scons.org/dbxsd/v1.0">
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.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
Example:
</para>

<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">
dict = env.Dictionary()
cc_dict = env.Dictionary('CC', 'CCFLAGS', 'CCCOM')
</example_commands>
</listitem>
  </varlistentry>
  <varlistentry id="f-Dir">
    <term>
      <synopsis>Dir(name, [directory])</synopsis>
      <synopsis>env.Dir(name, [directory])</synopsis>
    </term>
    <listitem>
<para xmlns="http://www.scons.org/dbxsd/v1.0">
This returns a Directory Node,
an object that represents the specified directory
<varname>name</varname>.
<varname>name</varname>
can be a relative or absolute path.
<varname>directory</varname>
is an optional directory that will be used as the parent directory.
If no
<varname>directory</varname>
is specified, the current script's directory is used as the parent.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
If
<varname>name</varname>
is a list, SCons returns a list of Dir nodes.
Construction variables are expanded in
<varname>name</varname>.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
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.
</para>
</listitem>
  </varlistentry>
  <varlistentry id="f-Dump">
    <term>
      <synopsis>env.Dump([key])</synopsis>
    </term>
    <listitem>
<para xmlns="http://www.scons.org/dbxsd/v1.0">
Returns a pretty printable representation of the environment.
<varname>key</varname>,
if not
<literal>None</literal>,
should be a string containing the name of the variable of interest.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
This SConstruct:
</para>

<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">
env=Environment()
print env.Dump('CCCOM')
</example_commands>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
will print:
</para>

<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">
'$CC -c -o $TARGET $CCFLAGS $CPPFLAGS $_CPPDEFFLAGS $_CPPINCFLAGS $SOURCES'
</example_commands>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
While this SConstruct:
</para>

<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">
env=Environment()
print env.Dump()
</example_commands>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
will print:
</para>
<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">
{ 'AR': 'ar',
  'ARCOM': '$AR $ARFLAGS $TARGET $SOURCES\n$RANLIB $RANLIBFLAGS $TARGET',
  'ARFLAGS': ['r'],
  'AS': 'as',
  'ASCOM': '$AS $ASFLAGS -o $TARGET $SOURCES',
  'ASFLAGS': [],
  ...
</example_commands>
</listitem>
  </varlistentry>
  <varlistentry id="f-EnsurePythonVersion">
    <term>
      <synopsis>EnsurePythonVersion(major, minor)</synopsis>
      <synopsis>env.EnsurePythonVersion(major, minor)</synopsis>
    </term>
    <listitem>
<para xmlns="http://www.scons.org/dbxsd/v1.0">
Ensure that the Python version is at least
<varname>major</varname>.<varname>minor</varname>.
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.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
Example:
</para>

<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">
EnsurePythonVersion(2,2)
</example_commands>
</listitem>
  </varlistentry>
  <varlistentry id="f-EnsureSConsVersion">
    <term>
      <synopsis>EnsureSConsVersion(major, minor, [revision])</synopsis>
      <synopsis>env.EnsureSConsVersion(major, minor, [revision])</synopsis>
    </term>
    <listitem>
<para xmlns="http://www.scons.org/dbxsd/v1.0">
Ensure that the SCons version is at least
<varname>major.minor</varname>,
or
<varname>major.minor.revision</varname>.
if
<varname>revision</varname>
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.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
Examples:
</para>

<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">
EnsureSConsVersion(0,14)

EnsureSConsVersion(0,96,90)
</example_commands>
</listitem>
  </varlistentry>
  <varlistentry id="f-Environment">
    <term>
      <synopsis>Environment([key=value, ...])</synopsis>
      <synopsis>env.Environment([key=value, ...])</synopsis>
    </term>
    <listitem>
<para xmlns="http://www.scons.org/dbxsd/v1.0">
Return a new construction environment
initialized with the specified
<varname>key</varname><literal>=</literal><varname>value</varname>
pairs.
</para>
</listitem>
  </varlistentry>
  <varlistentry id="f-Execute">
    <term>
      <synopsis>Execute(action, [strfunction, varlist])</synopsis>
      <synopsis>env.Execute(action, [strfunction, varlist])</synopsis>
    </term>
    <listitem>
<para xmlns="http://www.scons.org/dbxsd/v1.0">
Executes an Action object.
The specified
<varname>action</varname>
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.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
Note that
<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename>
will print an error message if the executed
<varname>action</varname>
fails--that is,
exits with or returns a non-zero value.
<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename>
will
<emphasis>not</emphasis>,
however,
automatically terminate the build
if the specified
<varname>action</varname>
fails.
If you want the build to stop in response to a failed
<function xmlns="http://www.scons.org/dbxsd/v1.0">Execute</function>
call,
you must explicitly check for a non-zero return value:
</para>

<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">
Execute(Copy('file.out', 'file.in'))

if Execute("mkdir sub/dir/ectory"):
    # The mkdir failed, don't try to build.
    Exit(1)
</example_commands>
</listitem>
  </varlistentry>
  <varlistentry id="f-Exit">
    <term>
      <synopsis>Exit([value])</synopsis>
      <synopsis>env.Exit([value])</synopsis>
    </term>
    <listitem>
<para xmlns="http://www.scons.org/dbxsd/v1.0">
This tells
<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename>
to exit immediately
with the specified
<varname>value</varname>.
A default exit value of
<literal>0</literal>
(zero)
is used if no value is specified.
</para>
</listitem>
  </varlistentry>
  <varlistentry id="f-Export">
    <term>
      <synopsis>Export(vars)</synopsis>
      <synopsis>env.Export(vars)</synopsis>
    </term>
    <listitem>
<para xmlns="http://www.scons.org/dbxsd/v1.0">
This tells
<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename>
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
<function xmlns="http://www.scons.org/dbxsd/v1.0">Export</function>
will over-write previous exports that have the same name.
Multiple variable names can be passed to
<function xmlns="http://www.scons.org/dbxsd/v1.0">Export</function>
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.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
Examples:
</para>

<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">
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})
</example_commands>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
Note that the
<function xmlns="http://www.scons.org/dbxsd/v1.0">SConscript</function>
function supports an
<varname>exports</varname>
argument that makes it easier to to export a variable or
set of variables to a single SConscript file.
See the description of the
<function xmlns="http://www.scons.org/dbxsd/v1.0">SConscript</function>
function, below.
</para>
</listitem>
  </varlistentry>
  <varlistentry id="f-File">
    <term>
      <synopsis>File(name, [directory])</synopsis>
      <synopsis>env.File(name, [directory])</synopsis>
    </term>
    <listitem>
<para xmlns="http://www.scons.org/dbxsd/v1.0">
This returns a
File Node,
an object that represents the specified file
<varname>name</varname>.
<varname>name</varname>
can be a relative or absolute path.
<varname>directory</varname>
is an optional directory that will be used as the parent directory.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
If
<varname>name</varname>
is a list, SCons returns a list of File nodes.
Construction variables are expanded in
<varname>name</varname>.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
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.
</para>
</listitem>
  </varlistentry>
  <varlistentry id="f-FindFile">
    <term>
      <synopsis>FindFile(file, dirs)</synopsis>
      <synopsis>env.FindFile(file, dirs)</synopsis>
    </term>
    <listitem>
<para xmlns="http://www.scons.org/dbxsd/v1.0">
Search for
<varname>file</varname>
in the path specified by
<varname>dirs</varname>.
<varname>dirs</varname>
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.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
Example:
</para>

<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">
foo = env.FindFile('foo', ['dir1', 'dir2'])
</example_commands>
</listitem>
  </varlistentry>
  <varlistentry id="f-FindInstalledFiles">
    <term>
      <synopsis>FindInstalledFiles()</synopsis>
      <synopsis>env.FindInstalledFiles()</synopsis>
    </term>
    <listitem>
<para xmlns="http://www.scons.org/dbxsd/v1.0">
Returns the list of targets set up by the
<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="b-Install"><function>Install</function></link>
or
<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="b-InstallAs"><function>InstallAs</function></link>
builders.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
This function serves as a convenient method to select the contents of
a binary package.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
Example:
</para>

<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">
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()
</example_commands>
</listitem>
  </varlistentry>
  <varlistentry id="f-FindPathDirs">
    <term>
      <synopsis>FindPathDirs(variable)</synopsis>
    </term>
    <listitem>
<para xmlns="http://www.scons.org/dbxsd/v1.0">
Returns a function
(actually a callable Python object)
intended to be used as the
<varname>path_function</varname>
of a Scanner object.
The returned object will look up the specified
<varname>variable</varname>
in a construction environment
and treat the construction variable's value as a list of
directory paths that should be searched
(like
<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-CPPPATH"><envar>$CPPPATH</envar></link>,
<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-LIBPATH"><envar>$LIBPATH</envar></link>,
etc.).
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
Note that use of
<function xmlns="http://www.scons.org/dbxsd/v1.0">FindPathDirs</function>
is generally preferable to
writing your own
<varname>path_function</varname>
for the following reasons:
1) The returned list will contain all appropriate directories
found in source trees
(when
<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="f-VariantDir"><function>VariantDir</function></link>
is used)
or in code repositories
(when
<function xmlns="http://www.scons.org/dbxsd/v1.0">Repository</function>
or the
<option>-Y</option>
option are used).
2) scons will identify expansions of
<varname>variable</varname>
that evaluate to the same list of directories as,
in fact, the same list,
and avoid re-scanning the directories for files,
when possible.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
Example:
</para>

<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">
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'))
</example_commands>
</listitem>
  </varlistentry>
  <varlistentry id="f-FindSourceFiles">
    <term>
      <synopsis>FindSourceFiles(node='"."')</synopsis>
      <synopsis>env.FindSourceFiles(node='"."')</synopsis>
    </term>
    <listitem>
<para xmlns="http://www.scons.org/dbxsd/v1.0">
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
<varname>node</varname>
which defaults to the '"."'-node. It will then return all leaves of
<varname>node</varname>.
These are all children which have no further children.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
This function is a convenient method to select the contents of a Source
Package.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
Example:
</para>

<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">
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' )
</example_commands>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
As you can see build support files (SConstruct in the above example)
will also be returned by this function.
</para>
</listitem>
  </varlistentry>
  <varlistentry id="f-Flatten">
    <term>
      <synopsis>Flatten(sequence)</synopsis>
      <synopsis>env.Flatten(sequence)</synopsis>
    </term>
    <listitem>
<para xmlns="http://www.scons.org/dbxsd/v1.0">
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.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
Examples:
</para>

<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">
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)
</example_commands>
</listitem>
  </varlistentry>
  <varlistentry id="f-GetBuildFailures">
    <term>
      <synopsis>GetBuildFailures()</synopsis>
    </term>
    <listitem>
<para xmlns="http://www.scons.org/dbxsd/v1.0">
Returns a list of exceptions for the
actions that failed while
attempting to build targets.
Each element in the returned list is a
<classname>BuildError</classname>
object
with the following attributes
that record various aspects
of the build failure:
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
<literal>.node</literal>
The node that was being built
when the build failure occurred.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
<literal>.status</literal>
The numeric exit status
returned by the command or Python function
that failed when trying to build the
specified Node.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
<literal>.errstr</literal>
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.)
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
<literal>.filename</literal>
The name of the file or
directory that actually caused the failure.
This may be different from the
<literal>.node</literal>
attribute.
For example,
if an attempt to build a target named
<filename>sub/dir/target</filename>
fails because the
<filename>sub/dir</filename>
directory could not be created,
then the
<literal>.node</literal>
attribute will be
<filename>sub/dir/target</filename>
but the
<literal>.filename</literal>
attribute will be
<filename>sub/dir</filename>.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
<literal>.executor</literal>
The SCons Executor object
for the target Node
being built.
This can be used to retrieve
the construction environment used
for the failed action.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
<literal>.action</literal>
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.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
<literal>.command</literal>
The actual expanded command that was executed and failed,
after expansion of
<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-TARGET"><envar>$TARGET</envar></link>,
<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-SOURCE"><envar>$SOURCE</envar></link>,
and other construction variables.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
Note that the
<function xmlns="http://www.scons.org/dbxsd/v1.0">GetBuildFailures</function>
function
will always return an empty list
until any build failure has occurred,
which means that
<function xmlns="http://www.scons.org/dbxsd/v1.0">GetBuildFailures</function>
will always return an empty list
while the
<filename xmlns="http://www.scons.org/dbxsd/v1.0">SConscript</filename>
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
<function>atexit.register</function>()
function.
Example:
</para>

<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">
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)
</example_commands>
</listitem>
  </varlistentry>
  <varlistentry id="f-GetBuildPath">
    <term>
      <synopsis>GetBuildPath(file, [...])</synopsis>
      <synopsis>env.GetBuildPath(file, [...])</synopsis>
    </term>
    <listitem>
<para xmlns="http://www.scons.org/dbxsd/v1.0">
Returns the
<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename>
path name (or names) for the specified
<varname>file</varname>
(or files).
The specified
<varname>file</varname>
or files
may be
<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename>
Nodes or strings representing path names.
</para>
</listitem>
  </varlistentry>
  <varlistentry id="f-GetLaunchDir">
    <term>
      <synopsis>GetLaunchDir()</synopsis>
      <synopsis>env.GetLaunchDir()</synopsis>
    </term>
    <listitem>
<para xmlns="http://www.scons.org/dbxsd/v1.0">
Returns the absolute path name of the directory from which
<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename>
was initially invoked.
This can be useful when using the
<option>-u</option>,
<option>-U</option>
or
<option>-D</option>
options, which internally
change to the directory in which the
<filename xmlns="http://www.scons.org/dbxsd/v1.0">SConstruct</filename>
file is found.
</para>
</listitem>
  </varlistentry>
  <varlistentry id="f-GetOption">
    <term>
      <synopsis>GetOption(name)</synopsis>
      <synopsis>env.GetOption(name)</synopsis>
    </term>
    <listitem>
<para xmlns="http://www.scons.org/dbxsd/v1.0">
This function provides a way to query the value of
SCons options set on scons command line
(or set using the
<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="f-SetOption"><function>SetOption</function></link>
function).
The options supported are:
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
<variablelist>
<varlistentry>
<term><literal>cache_debug</literal></term>
<listitem>
<para>
which corresponds to --cache-debug;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>cache_disable</literal></term>
<listitem>
<para>
which corresponds to --cache-disable;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>cache_force</literal></term>
<listitem>
<para>
which corresponds to --cache-force;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>cache_show</literal></term>
<listitem>
<para>
which corresponds to --cache-show;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>clean</literal></term>
<listitem>
<para>
which corresponds to -c, --clean and --remove;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>config</literal></term>
<listitem>
<para>
which corresponds to --config;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>directory</literal></term>
<listitem>
<para>
which corresponds to -C and --directory;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>diskcheck</literal></term>
<listitem>
<para>
which corresponds to --diskcheck
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>duplicate</literal></term>
<listitem>
<para>
which corresponds to --duplicate;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>file</literal></term>
<listitem>
<para>
which corresponds to -f, --file, --makefile and --sconstruct;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>help</literal></term>
<listitem>
<para>
which corresponds to -h and --help;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>ignore_errors</literal></term>
<listitem>
<para>
which corresponds to --ignore-errors;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>implicit_cache</literal></term>
<listitem>
<para>
which corresponds to --implicit-cache;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>implicit_deps_changed</literal></term>
<listitem>
<para>
which corresponds to --implicit-deps-changed;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>implicit_deps_unchanged</literal></term>
<listitem>
<para>
which corresponds to --implicit-deps-unchanged;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>interactive</literal></term>
<listitem>
<para>
which corresponds to --interact and --interactive;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>keep_going</literal></term>
<listitem>
<para>
which corresponds to -k and --keep-going;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>max_drift</literal></term>
<listitem>
<para>
which corresponds to --max-drift;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>no_exec</literal></term>
<listitem>
<para>
which corresponds to -n, --no-exec, --just-print, --dry-run and --recon;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>no_site_dir</literal></term>
<listitem>
<para>
which corresponds to --no-site-dir;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>num_jobs</literal></term>
<listitem>
<para>
which corresponds to -j and --jobs;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>profile_file</literal></term>
<listitem>
<para>
which corresponds to --profile;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>question</literal></term>
<listitem>
<para>
which corresponds to -q and --question;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>random</literal></term>
<listitem>
<para>
which corresponds to --random;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>repository</literal></term>
<listitem>
<para>
which corresponds to -Y, --repository and --srcdir;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>silent</literal></term>
<listitem>
<para>
which corresponds to -s, --silent and --quiet;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>site_dir</literal></term>
<listitem>
<para>
which corresponds to --site-dir;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>stack_size</literal></term>
<listitem>
<para>
which corresponds to --stack-size;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>taskmastertrace_file</literal></term>
<listitem>
<para>
which corresponds to --taskmastertrace; and
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>warn</literal></term>
<listitem>
<para>
which corresponds to --warn and --warning.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
See the documentation for the
corresponding command line object for information about each specific
option.
</para>
</listitem>
  </varlistentry>
  <varlistentry id="f-Glob">
    <term>
      <synopsis>Glob(pattern, [ondisk, source, strings])</synopsis>
      <synopsis>env.Glob(pattern, [ondisk, source, strings])</synopsis>
    </term>
    <listitem>
<para xmlns="http://www.scons.org/dbxsd/v1.0">
Returns Nodes (or strings) that match the specified
<varname>pattern</varname>,
relative to the directory of the current
<filename xmlns="http://www.scons.org/dbxsd/v1.0">SConscript</filename>
file.
The
<function>env.Glob</function>()
form performs string substition on
<varname>pattern</varname>
and returns whatever matches
the resulting expanded pattern.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
The specified
<varname>pattern</varname>
uses Unix shell style metacharacters for matching:
</para>

<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">
  *       matches everything
  ?       matches any single character
  [seq]   matches any character in seq
  [!seq]  matches any char not in seq
</example_commands>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
If the first character of a filename is a dot,
it must be matched explicitly.
Character matches do
<emphasis>not</emphasis>
span directory separators.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
The
<function xmlns="http://www.scons.org/dbxsd/v1.0">Glob</function>
knows about
repositories
(see the
<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="f-Repository"><function>Repository</function></link>
function)
and source directories
(see the
<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="f-VariantDir"><function>VariantDir</function></link>
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.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
The
<varname>ondisk</varname>
argument may be set to
<literal>False</literal>
(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.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
The
<varname>source</varname>
argument may be set to
<literal>True</literal>
(or any equivalent value)
to specify that,
when the local directory is a
<function xmlns="http://www.scons.org/dbxsd/v1.0">VariantDir</function>,
the returned Nodes should be from the
corresponding source directory,
not the local directory.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
The
<varname>strings</varname>
argument may be set to
<literal>True</literal>
(or any equivalent value)
to have the
<function xmlns="http://www.scons.org/dbxsd/v1.0">Glob</function>
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
<filename xmlns="http://www.scons.org/dbxsd/v1.0">SConscript</filename>
file,
any Node translation will be relative
to the other
<filename xmlns="http://www.scons.org/dbxsd/v1.0">SConscript</filename>
directory,
not the original
<filename xmlns="http://www.scons.org/dbxsd/v1.0">SConscript</filename>
directory.)
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
Examples:
</para>

<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">
Program('foo', Glob('*.c'))
Zip('/tmp/everything', Glob('.??*') + Glob('*'))
</example_commands>
</listitem>
  </varlistentry>
  <varlistentry id="f-Help">
    <term>
      <synopsis>Help(text)</synopsis>
      <synopsis>env.Help(text)</synopsis>
    </term>
    <listitem>
<para xmlns="http://www.scons.org/dbxsd/v1.0">
This specifies help text to be printed if the
<option>-h</option>
argument is given to
<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename>.
If
<function xmlns="http://www.scons.org/dbxsd/v1.0">Help</function>
is called multiple times, the text is appended together in the order
that
<function xmlns="http://www.scons.org/dbxsd/v1.0">Help</function>
is called.
</para>
</listitem>
  </varlistentry>
  <varlistentry id="f-Ignore">
    <term>
      <synopsis>Ignore(target, dependency)</synopsis>
      <synopsis>env.Ignore(target, dependency)</synopsis>
    </term>
    <listitem>
<para xmlns="http://www.scons.org/dbxsd/v1.0">
The specified dependency file(s)
will be ignored when deciding if
the target file(s) need to be rebuilt.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
You can also use
<function xmlns="http://www.scons.org/dbxsd/v1.0">Ignore</function>
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.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
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.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
Examples:
</para>

<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">
env.Ignore('foo', 'foo.c')
env.Ignore('bar', ['bar1.h', 'bar2.h'])
env.Ignore('.','foobar.obj')
env.Ignore('bar','bar/foobar.obj')
</example_commands>
</listitem>
  </varlistentry>
  <varlistentry id="f-Import">
    <term>
      <synopsis>Import(vars)</synopsis>
      <synopsis>env.Import(vars)</synopsis>
    </term>
    <listitem>
<para xmlns="http://www.scons.org/dbxsd/v1.0">
This tells
<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename>
to import a list of variables into the current SConscript file. This
will import variables that were exported with
<function xmlns="http://www.scons.org/dbxsd/v1.0">Export</function>
or in the
<varname>exports</varname>
argument to
<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="f-SConscript"><function>SConscript</function></link>.
Variables exported by
<function xmlns="http://www.scons.org/dbxsd/v1.0">SConscript</function>
have precedence.
Multiple variable names can be passed to
<function xmlns="http://www.scons.org/dbxsd/v1.0">Import</function>
as separate arguments or as a list. The variable "*" can be used
to import all variables.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
Examples:
</para>

<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">
Import("env")
Import("env", "variable")
Import(["env", "variable"])
Import("*")
</example_commands>
</listitem>
  </varlistentry>
  <varlistentry id="f-Literal">
    <term>
      <synopsis>Literal(string)</synopsis>
      <synopsis>env.Literal(string)</synopsis>
    </term>
    <listitem>
<para xmlns="http://www.scons.org/dbxsd/v1.0">
The specified
<varname>string</varname>
will be preserved as-is
and not have construction variables expanded.
</para>
</listitem>
  </varlistentry>
  <varlistentry id="f-Local">
    <term>
      <synopsis>Local(targets)</synopsis>
      <synopsis>env.Local(targets)</synopsis>
    </term>
    <listitem>
<para xmlns="http://www.scons.org/dbxsd/v1.0">
The specified
<varname>targets</varname>
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.
</para>
</listitem>
  </varlistentry>
  <varlistentry id="f-MergeFlags">
    <term>
      <synopsis>env.MergeFlags(arg, [unique])</synopsis>
    </term>
    <listitem>
<para xmlns="http://www.scons.org/dbxsd/v1.0">
Merges the specified
<varname>arg</varname>
values to the construction environment's construction variables.
If the
<varname>arg</varname>
argument is not a dictionary,
it is converted to one by calling
<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="f-ParseFlags"><function>env.ParseFlags</function></link>
on the argument
before the values are merged.
Note that
<varname>arg</varname>
must be a single value,
so multiple strings must
be passed in as a list,
not as separate arguments to
<function xmlns="http://www.scons.org/dbxsd/v1.0">env.MergeFlags</function>.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
By default,
duplicate values are eliminated;
you can, however, specify
<literal>unique=0</literal>
to allow duplicate
values to be added.
When eliminating duplicate values,
any construction variables that end with
the string
<literal>PATH</literal>
keep the left-most unique value.
All other construction variables keep
the right-most unique value.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
Examples:
</para>

<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">
# 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'])
</example_commands>
</listitem>
  </varlistentry>
  <varlistentry id="f-NoCache">
    <term>
      <synopsis>NoCache(target, ...)</synopsis>
      <synopsis>env.NoCache(target, ...)</synopsis>
    </term>
    <listitem>
<para xmlns="http://www.scons.org/dbxsd/v1.0">
Specifies a list of files which should
<emphasis>not</emphasis>
be cached whenever the
<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="f-CacheDir"><function>CacheDir</function></link>
method has been activated.
The specified targets may be a list
or an individual target.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
Multiple files should be specified
either as separate arguments to the
<function xmlns="http://www.scons.org/dbxsd/v1.0">NoCache</function>
method, or as a list.
<function xmlns="http://www.scons.org/dbxsd/v1.0">NoCache</function>
will also accept the return value of any of the construction environment
Builder methods.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
Calling
<function xmlns="http://www.scons.org/dbxsd/v1.0">NoCache</function>
on directories and other non-File Node types has no effect because
only File Nodes are cached.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
Examples:
</para>

<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">
NoCache('foo.elf')
NoCache(env.Program('hello', 'hello.c'))
</example_commands>
</listitem>
  </varlistentry>
  <varlistentry id="f-NoClean">
    <term>
      <synopsis>NoClean(target, ...)</synopsis>
      <synopsis>env.NoClean(target, ...)</synopsis>
    </term>
    <listitem>
<para xmlns="http://www.scons.org/dbxsd/v1.0">
Specifies a list of files or directories which should
<emphasis>not</emphasis>
be removed whenever the targets (or their dependencies)
are specified with the
<option>-c</option>
command line option.
The specified targets may be a list
or an individual target.
Multiple calls to
<function xmlns="http://www.scons.org/dbxsd/v1.0">NoClean</function>
are legal,
and prevent each specified target
from being removed by calls to the
<option>-c</option>
option.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
Multiple files or directories should be specified
either as separate arguments to the
<function xmlns="http://www.scons.org/dbxsd/v1.0">NoClean</function>
method, or as a list.
<function xmlns="http://www.scons.org/dbxsd/v1.0">NoClean</function>
will also accept the return value of any of the construction environment
Builder methods.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
Calling
<function xmlns="http://www.scons.org/dbxsd/v1.0">NoClean</function>
for a target overrides calling
<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="f-Clean"><function>Clean</function></link>
for the same target,
and any targets passed to both functions will
<emphasis>not</emphasis>
be removed by the
<option>-c</option>
option.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
Examples:
</para>

<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">
NoClean('foo.elf')
NoClean(env.Program('hello', 'hello.c'))
</example_commands>
</listitem>
  </varlistentry>
  <varlistentry id="f-ParseConfig">
    <term>
      <synopsis>env.ParseConfig(command, [function, unique])</synopsis>
    </term>
    <listitem>
<para xmlns="http://www.scons.org/dbxsd/v1.0">
Calls the specified
<varname>function</varname>
to modify the environment as specified by the output of
<varname>command</varname>.
The default
<varname>function</varname>
is
<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="f-MergeFlags"><function>env.MergeFlags</function></link>,
which expects the output of a typical
<application>*-config</application>
command
(for example,
<application>gtk-config</application>)
and adds the options
to the appropriate construction variables.
By default,
duplicate values are not
added to any construction variables;
you can specify
<literal>unique=0</literal>
to allow duplicate
values to be added.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
Interpreted options
and the construction variables they affect
are as specified for the
<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="f-ParseFlags"><function>env.ParseFlags</function></link>
method (which this method calls).
See that method's description, below,
for a table of options and construction variables.
</para>
</listitem>
  </varlistentry>
  <varlistentry id="f-ParseDepends">
    <term>
      <synopsis>ParseDepends(filename, [must_exist, only_one])</synopsis>
      <synopsis>env.ParseDepends(filename, [must_exist, only_one])</synopsis>
    </term>
    <listitem>
<para xmlns="http://www.scons.org/dbxsd/v1.0">
Parses the contents of the specified
<varname>filename</varname>
as a list of dependencies in the style of
<application xmlns="http://www.scons.org/dbxsd/v1.0">Make</application>
or
<application>mkdep</application>,
and explicitly establishes all of the listed dependencies.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
By default,
it is not an error
if the specified
<varname>filename</varname>
does not exist.
The optional
<varname>must_exist</varname>
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.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
The optional
<varname>only_one</varname>
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
<literal>gcc -M</literal>
flag,
which should typically only
write dependency information for
one output file into a corresponding
<filename>.d</filename>
file.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
The
<varname>filename</varname>
and all of the files listed therein
will be interpreted relative to
the directory of the
<filename xmlns="http://www.scons.org/dbxsd/v1.0">SConscript</filename>
file which calls the
<function xmlns="http://www.scons.org/dbxsd/v1.0">ParseDepends</function>
function.
</para>
</listitem>
  </varlistentry>
  <varlistentry id="f-ParseFlags">
    <term>
      <synopsis>env.ParseFlags(flags, ...)</synopsis>
    </term>
    <listitem>
<para xmlns="http://www.scons.org/dbxsd/v1.0">
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
<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="f-MergeFlags"><function>env.MergeFlags</function></link>
method, but allows for the values in the returned dictionary
to be modified, if necessary,
before merging them into the construction environment.
(Note that
<function xmlns="http://www.scons.org/dbxsd/v1.0">env.MergeFlags</function>
will call this method if its argument is not a dictionary,
so it is usually not necessary to call
<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="f-ParseFlags"><function>env.ParseFlags</function></link>
directly unless you want to manipulate the values.)
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
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.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
Flag values are translated accordig to the prefix found,
and added to the following construction variables:
</para>

<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">
-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
</example_commands>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
Any other strings not associated with options
are assumed to be the names of libraries
and added to the
<envar xmlns="http://www.scons.org/dbxsd/v1.0">$LIBS</envar>
construction variable.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
Examples (all of which produce the same result):
</para>

<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">
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')
</example_commands>
</listitem>
  </varlistentry>
  <varlistentry id="f-Perforce">
    <term>
      <synopsis>env.Perforce()</synopsis>
    </term>
    <listitem>
<para xmlns="http://www.scons.org/dbxsd/v1.0">
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
<function xmlns="http://www.scons.org/dbxsd/v1.0">SourceCode</function>
function.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
This function is deprecated.  For details, see the entry for the
<function xmlns="http://www.scons.org/dbxsd/v1.0">SourceCode</function>
function.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
Example:
</para>

<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">
env.SourceCode('.', env.Perforce())
</example_commands>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
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.
</para>
</listitem>
  </varlistentry>
  <varlistentry id="f-Platform">
    <term>
      <synopsis>Platform(string)</synopsis>
    </term>
    <listitem>
<para xmlns="http://www.scons.org/dbxsd/v1.0">
The
<function xmlns="http://www.scons.org/dbxsd/v1.0">Platform</function>
form returns a callable object
that can be used to initialize
a construction environment using the
platform keyword of the
<function xmlns="http://www.scons.org/dbxsd/v1.0">Environment</function>
function.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
Example:
</para>

<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">
env = Environment(platform = Platform('win32'))
</example_commands>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
The
<function xmlns="http://www.scons.org/dbxsd/v1.0">env.Platform</function>
form applies the callable object for the specified platform
<varname>string</varname>
to the environment through which the method was called.
</para>

<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">
env.Platform('posix')
</example_commands>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
Note that the
<literal>win32</literal>
platform adds the
<literal>SystemDrive</literal>
and
<literal>SystemRoot</literal>
variables from the user's external environment
to the construction environment's
<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-ENV"><envar>$ENV</envar></link>
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
<literal>:pserver:anonymous@cvs.sourceforge.net:/cvsroot/scons</literal>)
will work on Windows systems.
</para>
</listitem>
  </varlistentry>
  <varlistentry id="f-Precious">
    <term>
      <synopsis>Precious(target, ...)</synopsis>
      <synopsis>env.Precious(target, ...)</synopsis>
    </term>
    <listitem>
<para xmlns="http://www.scons.org/dbxsd/v1.0">
Marks each given
<varname>target</varname>
as precious so it is not deleted before it is rebuilt. Normally
<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename>
deletes a target before building it.
Multiple targets can be passed in to a single call to
<function xmlns="http://www.scons.org/dbxsd/v1.0">Precious</function>.
</para>
</listitem>
  </varlistentry>
  <varlistentry id="f-Prepend">
    <term>
      <synopsis>env.Prepend(key=val, [...])</synopsis>
    </term>
    <listitem>
<para xmlns="http://www.scons.org/dbxsd/v1.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 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.)
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
Example:
</para>

<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">
env.Prepend(CCFLAGS = '-g ', FOO = ['foo.yyy'])
</example_commands>
</listitem>
  </varlistentry>
  <varlistentry id="f-PrependENVPath">
    <term>
      <synopsis>env.PrependENVPath(name, newpath, [envname, sep, delete_existing])</synopsis>
    </term>
    <listitem>
<para xmlns="http://www.scons.org/dbxsd/v1.0">
This appends new path elements to the given path in the
specified external environment
(<envar xmlns="http://www.scons.org/dbxsd/v1.0">$ENV</envar>
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
<literal>os.path.normpath</literal>
and
<literal>os.path.normcase</literal>).
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.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
If
<varname>delete_existing</varname>
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.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
Example:
</para>

<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">
print 'before:',env['ENV']['INCLUDE']
include_path = '/foo/bar:/foo'
env.PrependENVPath('INCLUDE', include_path)
print 'after:',env['ENV']['INCLUDE']
</example_commands>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
The above example will print:
</para>

<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">
before: /biz:/foo
after: /foo/bar:/foo:/biz
</example_commands>
</listitem>
  </varlistentry>
  <varlistentry id="f-PrependUnique">
    <term>
      <synopsis>env.PrependUnique(key=val, delete_existing=0, [...])</synopsis>
    </term>
    <listitem>
<para xmlns="http://www.scons.org/dbxsd/v1.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
<emphasis>not</emphasis>
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.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
Example:
</para>

<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">
env.PrependUnique(CCFLAGS = '-g', FOO = ['foo.yyy'])
</example_commands>
</listitem>
  </varlistentry>
  <varlistentry id="f-Progress">
    <term>
      <synopsis>Progress(callable, [interval])</synopsis>
      <synopsis>Progress(string, [interval, file, overwrite])</synopsis>
      <synopsis>Progress(list_of_strings, [interval, file, overwrite])</synopsis>
    </term>
    <listitem>
<para xmlns="http://www.scons.org/dbxsd/v1.0">
Allows SCons to show progress made during the build
by displaying a string or calling a function while
evaluating Nodes (e.g. files).
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
If the first specified argument is a Python callable
(a function or an object that has a
<function>__call__</function>()
method),
the function will be called
once every
<varname>interval</varname>
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
<literal>*args</literal>
and
<literal>**kw</literal>
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.)
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
An example of a simple custom progress function
that prints a string containing the Node name
every 10 Nodes:
</para>

<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">
def my_progress_function(node, *args, **kw):
    print 'Evaluating node %s!' % node
Progress(my_progress_function, interval=10)
</example_commands>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
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
<literal>\r</literal>
(a carriage return)
at the end so that the string
will overwrite itself on a display:
</para>

<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">
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)
</example_commands>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
If the first argument
<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="f-Progress"><function>Progress</function></link>
is a string,
the string will be displayed
every
<varname>interval</varname>
evaluated Nodes.
The default is to print the string on standard output;
an alternate output stream
may be specified with the
<literal>file=</literal>
argument.
The following will print a series of dots
on the error output,
one dot for every 100 evaluated Nodes:
</para>

<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">
import sys
Progress('.', interval=100, file=sys.stderr)
</example_commands>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
If the string contains the verbatim substring
<envar xmlns="http://www.scons.org/dbxsd/v1.0">$TARGET</envar>,
it will be replaced with the Node.
Note that, for performance reasons, this is
<emphasis>not</emphasis>
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
<literal>\r</literal>
(carriage return) to cause each line to overwritten by the next line,
and the
<literal>overwrite=</literal>
keyword argument to make sure the previously-printed
file name is overwritten with blank spaces:
</para>

<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">
import sys
Progress('$TARGET\r', overwrite=True)
</example_commands>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
If the first argument to
<function xmlns="http://www.scons.org/dbxsd/v1.0">Progress</function>
is a list of strings,
then each string in the list will be displayed
in rotating fashion every
<varname>interval</varname>
evaluated Nodes.
This can be used to implement a "spinner"
on the user's screen as follows:
</para>

<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">
Progress(['-\r', '\\\r', '|\r', '/\r'], interval=5)
</example_commands>
</listitem>
  </varlistentry>
  <varlistentry id="f-RCS">
    <term>
      <synopsis>env.RCS()</synopsis>
    </term>
    <listitem>
<para xmlns="http://www.scons.org/dbxsd/v1.0">
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
<function xmlns="http://www.scons.org/dbxsd/v1.0">SourceCode</function>
function:
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
This function is deprecated.  For details, see the entry for the
<function xmlns="http://www.scons.org/dbxsd/v1.0">SourceCode</function>
function.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
Examples:
</para>

<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">
env.SourceCode('.', env.RCS())
</example_commands>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
Note that
<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename>
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.
</para>
</listitem>
  </varlistentry>
  <varlistentry id="f-Replace">
    <term>
      <synopsis>env.Replace(key=val, [...])</synopsis>
    </term>
    <listitem>
<para xmlns="http://www.scons.org/dbxsd/v1.0">
Replaces construction variables in the Environment
with the specified keyword arguments.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
Example:
</para>

<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">
env.Replace(CCFLAGS = '-g', FOO = 'foo.xxx')
</example_commands>
</listitem>
  </varlistentry>
  <varlistentry id="f-Repository">
    <term>
      <synopsis>Repository(directory)</synopsis>
      <synopsis>env.Repository(directory)</synopsis>
    </term>
    <listitem>
<para xmlns="http://www.scons.org/dbxsd/v1.0">
Specifies that
<varname>directory</varname>
is a repository to be searched for files.
Multiple calls to
<function xmlns="http://www.scons.org/dbxsd/v1.0">Repository</function>
are legal,
and each one adds to the list of
repositories that will be searched.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
To
<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename>,
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
<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename>,
so that the repository contains the necessary
signature information to allow
<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename>
to figure out when it is appropriate to
use the repository copy of a derived file,
instead of building one locally.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
Note that if an up-to-date derived file
already exists in a repository,
<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename>
will
<emphasis>not</emphasis>
make a copy in the local directory tree.
In order to guarantee that a local copy
will be made,
use the
<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="f-Local"><function>Local</function></link>
method.
</para>
</listitem>
  </varlistentry>
  <varlistentry id="f-Requires">
    <term>
      <synopsis>Requires(target, prerequisite)</synopsis>
      <synopsis>env.Requires(target, prerequisite)</synopsis>
    </term>
    <listitem>
<para xmlns="http://www.scons.org/dbxsd/v1.0">
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,
<emphasis>before</emphasis>
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.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
Example:
</para>

<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">
env.Requires('foo', 'file-that-must-be-built-before-foo')
</example_commands>
</listitem>
  </varlistentry>
  <varlistentry id="f-Return">
    <term>
      <synopsis>Return([vars..., stop=])</synopsis>
    </term>
    <listitem>
<para xmlns="http://www.scons.org/dbxsd/v1.0">
By default,
this stops processing the current SConscript
file and returns to the calling SConscript file
the values of the variables named in the
<varname>vars</varname>
string arguments.
Multiple strings contaning variable names may be passed to
<function xmlns="http://www.scons.org/dbxsd/v1.0">Return</function>.
Any strings that contain white space
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
The optional
<literal>stop=</literal>
keyword argument may be set to a false value
to continue processing the rest of the SConscript
file after the
<function xmlns="http://www.scons.org/dbxsd/v1.0">Return</function>
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
<varname>vars</varname>
at the point
<function xmlns="http://www.scons.org/dbxsd/v1.0">Return</function>
is called.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
Examples:
</para>

<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">
# 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')
</example_commands>
</listitem>
  </varlistentry>
  <varlistentry id="f-Scanner">
    <term>
      <synopsis>Scanner(function, [argument, keys, path_function, node_class, node_factory, scan_check, recursive])</synopsis>
      <synopsis>env.Scanner(function, [argument, keys, path_function, node_class, node_factory, scan_check, recursive])</synopsis>
    </term>
    <listitem>
<para xmlns="http://www.scons.org/dbxsd/v1.0">
Creates a Scanner object for
the specified
<varname>function</varname>.
See the section "Scanner Objects,"
below, for a complete explanation of the arguments and behavior.
</para>
</listitem>
  </varlistentry>
  <varlistentry id="f-SCCS">
    <term>
      <synopsis>env.SCCS()</synopsis>
    </term>
    <listitem>
<para xmlns="http://www.scons.org/dbxsd/v1.0">
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
<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="f-SourceCode"><function>SourceCode</function></link>
function.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
Example:
</para>

<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">
env.SourceCode('.', env.SCCS())
</example_commands>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
Note that
<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename>
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
<filename>s.SCCS</filename>
files in the same
directory as the source files,
or if you need to explicitly specify SCCS
for a specific subdirectory.
</para>
</listitem>
  </varlistentry>
  <varlistentry id="f-SConscript">
    <term>
      <synopsis>SConscript(scripts, [exports, variant_dir, duplicate])</synopsis>
      <synopsis>env.SConscript(scripts, [exports, variant_dir, duplicate])</synopsis>
      <synopsis>SConscript(dirs=subdirs, [name=script, exports, variant_dir, duplicate])</synopsis>
      <synopsis>env.SConscript(dirs=subdirs, [name=script, exports, variant_dir, duplicate])</synopsis>
    </term>
    <listitem>
<para xmlns="http://www.scons.org/dbxsd/v1.0">
This tells
<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename>
to execute
one or more subsidiary SConscript (configuration) files.
Any variables returned by a called script using
<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="f-Return"><function>Return</function></link>
will be returned by the call to
<function xmlns="http://www.scons.org/dbxsd/v1.0">SConscript</function>.
There are two ways to call the
<function xmlns="http://www.scons.org/dbxsd/v1.0">SConscript</function>
function.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
The first way you can call
<function xmlns="http://www.scons.org/dbxsd/v1.0">SConscript</function>
is to explicitly specify one or more
<varname>scripts</varname>
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
<function xmlns="http://www.scons.org/dbxsd/v1.0">Split</function>).
Examples:
</para>
<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">
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')
</example_commands>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
The second way you can call
<function xmlns="http://www.scons.org/dbxsd/v1.0">SConscript</function>
is to specify a list of (sub)directory names
as a
<literal>dirs=</literal><varname>subdirs</varname>
keyword argument.
In this case,
<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename>
will, by default,
execute a subsidiary configuration file named
<filename xmlns="http://www.scons.org/dbxsd/v1.0">SConscript</filename>
in each of the specified directories.
You may specify a name other than
<filename xmlns="http://www.scons.org/dbxsd/v1.0">SConscript</filename>
by supplying an optional
<literal>name=</literal><varname>script</varname>
keyword argument.
The first three examples below have the same effect
as the first three examples above:
</para>
<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">
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')
</example_commands>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
The optional
<varname>exports</varname>
argument provides a list of variable names or a dictionary of
named values to export to the
<varname>script(s)</varname>.
These variables are locally exported only to the specified
<varname>script(s)</varname>,
and do not affect the global pool of variables used by the
<function xmlns="http://www.scons.org/dbxsd/v1.0">Export</function>
function.
<!-- If multiple dirs are provided, each script gets a fresh export. -->
The subsidiary
<varname>script(s)</varname>
must use the
<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="f-Import"><function>Import</function></link>
function to import the variables.
Examples:
</para>
<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">
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')
</example_commands>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
If the optional
<varname>variant_dir</varname>
argument is present, it causes an effect equivalent to the
<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="f-VariantDir"><function>VariantDir</function></link>
method described below.
(If
<varname>variant_dir</varname>
is not present, the
<!-- <varname>src_dir</varname> and -->
<varname>duplicate</varname>
<!-- arguments are ignored.) -->
argument is ignored.)
The
<varname>variant_dir</varname>
<!--
and
<varname>src_dir</varname>
arguments are interpreted relative to the directory of the calling
-->
argument is interpreted relative to the directory of the calling
<filename xmlns="http://www.scons.org/dbxsd/v1.0">SConscript</filename>
file.
See the description of the
<function xmlns="http://www.scons.org/dbxsd/v1.0">VariantDir</function>
function below for additional details and restrictions.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
If
<varname>variant_dir</varname>
is present,
<!--
but
<varname>src_dir</varname>
is not,
-->
the source directory is the directory in which the
<filename xmlns="http://www.scons.org/dbxsd/v1.0">SConscript</filename>
file resides and the
<filename xmlns="http://www.scons.org/dbxsd/v1.0">SConscript</filename>
file is evaluated as if it were in the
<varname>variant_dir</varname>
directory:
</para>
<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">
SConscript('src/SConscript', variant_dir = 'build')
</example_commands>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
is equivalent to
</para>

<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">
VariantDir('build', 'src')
SConscript('build/SConscript')
</example_commands>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
This later paradigm is often used when the sources are
in the same directory as the
<filename xmlns="http://www.scons.org/dbxsd/v1.0">SConstruct</filename>:
</para>

<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">
SConscript('SConscript', variant_dir = 'build')
</example_commands>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
is equivalent to
</para>

<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">
VariantDir('build', '.')
SConscript('build/SConscript')
</example_commands>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
<!--
If
<varname>variant_dir</varname>
and"
<varname>src_dir</varname>
are both present,
xxxxx everything is in a state of confusion.
</para>
<example_commands>
SConscript(dirs = 'src', variant_dir = 'build', src_dir = '.')
runs src/SConscript in build/src, but
SConscript(dirs = 'lib', variant_dir = 'build', src_dir = 'src')
runs lib/SConscript (in lib!).  However,
SConscript(dirs = 'src', variant_dir = 'build', src_dir = 'src')
runs src/SConscript in build.  Moreover,
SConscript(dirs = 'src/lib', variant_dir = 'build', src_dir = 'src')
runs src/lib/SConscript in build/lib.  Moreover,
SConscript(dirs = 'build/src/lib', variant_dir = 'build', src_dir = 'src')
can't find build/src/lib/SConscript, even though it ought to exist.
</example_commands>
<para>
is equivalent to
</para>
<example_commands>
????????????????
</example_commands>
<para>
and what about this alternative?
TODO??? SConscript('build/SConscript', src_dir='src')
-->
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
Here are some composite examples:
</para>

<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">
# 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')
</example_commands>

<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">
# 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)
</example_commands>

<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">
# 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)
</example_commands>

<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">
# 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)
</example_commands>
</listitem>
  </varlistentry>
  <varlistentry id="f-SConscriptChdir">
    <term>
      <synopsis>SConscriptChdir(value)</synopsis>
      <synopsis>env.SConscriptChdir(value)</synopsis>
    </term>
    <listitem>
<para xmlns="http://www.scons.org/dbxsd/v1.0">
By default,
<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename>
changes its working directory
to the directory in which each
subsidiary SConscript file lives.
This behavior may be disabled
by specifying either:
</para>

<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">
SConscriptChdir(0)
env.SConscriptChdir(0)
</example_commands>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
in which case
<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename>
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.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
Example:
</para>

<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">
env = Environment()
SConscriptChdir(0)
SConscript('foo/SConscript')	# will not chdir to foo
env.SConscriptChdir(1)
SConscript('bar/SConscript')	# will chdir to bar
</example_commands>
</listitem>
  </varlistentry>
  <varlistentry id="f-SConsignFile">
    <term>
      <synopsis>SConsignFile([file, dbm_module])</synopsis>
      <synopsis>env.SConsignFile([file, dbm_module])</synopsis>
    </term>
    <listitem>
<para xmlns="http://www.scons.org/dbxsd/v1.0">
This tells
<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename>
to store all file signatures
in the specified database
<varname>file</varname>.
If the
<varname>file</varname>
name is omitted,
<filename>.sconsign</filename>
is used by default.
(The actual file name(s) stored on disk
may have an appropriated suffix appended
by the
<varname> dbm_module</varname>.)
If
<varname>file</varname>
is not an absolute path name,
the file is placed in the same directory as the top-level
<filename xmlns="http://www.scons.org/dbxsd/v1.0">SConstruct</filename>
file.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
If
<varname>file</varname>
is
<literal>None</literal>,
then
<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename>
will store file signatures
in a separate
<filename>.sconsign</filename>
file in each directory,
not in one global database file.
(This was the default behavior
prior to SCons 0.96.91 and 0.97.)
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
The optional
<varname>dbm_module</varname>
argument can be used to specify
which Python database module
The default is to use a custom
<filename>SCons.dblite</filename>
module that uses pickled
Python data structures,
and which works on all Python versions.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
Examples:
</para>

<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">
# 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)
</example_commands>
</listitem>
  </varlistentry>
  <varlistentry id="f-SetDefault">
    <term>
      <synopsis>env.SetDefault(key=val, [...])</synopsis>
    </term>
    <listitem>
<para xmlns="http://www.scons.org/dbxsd/v1.0">
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:
</para>

<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">
env.SetDefault(FOO = 'foo')

if 'FOO' not in env: env['FOO'] = 'foo'
</example_commands>
</listitem>
  </varlistentry>
  <varlistentry id="f-SetOption">
    <term>
      <synopsis>SetOption(name, value)</synopsis>
      <synopsis>env.SetOption(name, value)</synopsis>
    </term>
    <listitem>
<para xmlns="http://www.scons.org/dbxsd/v1.0">
This function provides a way to set a select subset of the scons command
line options from a SConscript file. The options supported are:
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
<variablelist>
<varlistentry>
<term><literal>clean</literal></term>
<listitem>
<para>
which corresponds to -c, --clean and --remove;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>duplicate</literal></term>
<listitem>
<para>
which corresponds to --duplicate;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>help</literal></term>
<listitem>
<para>
which corresponds to -h and --help;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>implicit_cache</literal></term>
<listitem>
<para>
which corresponds to --implicit-cache;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>max_drift</literal></term>
<listitem>
<para>
which corresponds to --max-drift;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>no_exec</literal></term>
<listitem>
<para>
which corresponds to -n, --no-exec, --just-print, --dry-run and --recon;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>num_jobs</literal></term>
<listitem>
<para>
which corresponds to -j and --jobs;
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>random</literal></term>
<listitem>
<para>
which corresponds to --random; and
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>stack_size</literal></term>
<listitem>
<para>
which corresponds to --stack-size.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
See the documentation for the
corresponding command line object for information about each specific
option.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
Example:
</para>

<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">
SetOption('max_drift', 1)
</example_commands>
</listitem>
  </varlistentry>
  <varlistentry id="f-SideEffect">
    <term>
      <synopsis>SideEffect(side_effect, target)</synopsis>
      <synopsis>env.SideEffect(side_effect, target)</synopsis>
    </term>
    <listitem>
<para xmlns="http://www.scons.org/dbxsd/v1.0">
Declares
<varname>side_effect</varname>
as a side effect of building
<varname>target</varname>.
Both
<varname>side_effect</varname>
and
<varname>target</varname>
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,
<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename>
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.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
Because multiple build commands may update
the same side effect file,
by default the
<varname>side_effect</varname>
target is
<emphasis>not</emphasis>
automatically removed
when the
<varname>target</varname>
is removed by the
<option>-c</option>
option.
(Note, however, that the
<varname>side_effect</varname>
might be removed as part of
cleaning the directory in which it lives.)
If you want to make sure the
<varname>side_effect</varname>
is cleaned whenever a specific
<varname>target</varname>
is cleaned,
you must specify this explicitly
with the
<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="f-Clean"><function>Clean</function></link>
or
<function xmlns="http://www.scons.org/dbxsd/v1.0">env.Clean</function>
function.
</para>
</listitem>
  </varlistentry>
  <varlistentry id="f-SourceCode">
    <term>
      <synopsis>SourceCode(entries, builder)</synopsis>
      <synopsis>env.SourceCode(entries, builder)</synopsis>
    </term>
    <listitem>
<para xmlns="http://www.scons.org/dbxsd/v1.0">
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 <application xmlns="http://www.scons.org/dbxsd/v1.0">SCons</application>.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
Arrange for non-existent source files to
be fetched from a source code management system
using the specified
<varname>builder</varname>.
The specified
<varname>entries</varname>
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.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
For any non-existent source files,
<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename>
will search up the directory tree
and use the first
<function xmlns="http://www.scons.org/dbxsd/v1.0">SourceCode</function>
builder it finds.
The specified
<varname>builder</varname>
may be
<literal>None</literal>,
in which case
<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename>
will not use a builder to fetch
source files for the specified
<varname>entries</varname>,
even if a
<function xmlns="http://www.scons.org/dbxsd/v1.0">SourceCode</function>
builder has been specified
for a directory higher up the tree.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename>
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:
</para>

<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">
env.SourceCode('.', None)
</example_commands>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
Note that if the specified
<varname>builder</varname>
is one you create by hand,
it must have an associated
construction environment to use
when fetching a source file.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename>
provides a set of canned factory
functions that return appropriate
Builders for various popular
source code management systems.
Canonical examples of invocation include:
</para>

<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">
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)
</example_commands>
<para xmlns="http://www.scons.org/dbxsd/v1.0">
<!-- env.SourceCode('.', env.Subversion('file:///usr/local/Subversion')) -->
</para>
</listitem>
  </varlistentry>
  <varlistentry id="f-SourceSignatures">
    <term>
      <synopsis>SourceSignatures(type)</synopsis>
      <synopsis>env.SourceSignatures(type)</synopsis>
    </term>
    <listitem>
<para xmlns="http://www.scons.org/dbxsd/v1.0">
Note:  Although it is not yet officially deprecated,
use of this function is discouraged.
See the
<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="f-Decider"><function>Decider</function></link>
function for a more flexible and straightforward way
to configure SCons' decision-making.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
The
<function xmlns="http://www.scons.org/dbxsd/v1.0">SourceSignatures</function>
function tells
<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename>
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
<literal>MD5</literal>
or
<literal>timestamp</literal>.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
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.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
<literal>MD5</literal>
means
<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename>
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.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
<literal>timestamp</literal>
means
<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename>
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
<emphasis>older</emphasis>
than the last time it was used to rebuild the target file.)
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
There is no different between the two behaviors
for Python
<function xmlns="http://www.scons.org/dbxsd/v1.0">Value</function>
node objects.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
<literal>MD5</literal>
signatures take longer to compute,
but are more accurate than
<literal>timestamp</literal>
signatures.
The default value is
<literal>MD5</literal>.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
Note that the default
<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="f-TargetSignatures"><function>TargetSignatures</function></link>
setting (see below)
is to use this
<function xmlns="http://www.scons.org/dbxsd/v1.0">SourceSignatures</function>
setting for any target files that are used
to build other target files.
Consequently, changing the value of
<function xmlns="http://www.scons.org/dbxsd/v1.0">SourceSignatures</function>
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
<function xmlns="http://www.scons.org/dbxsd/v1.0">env.SourceSignatures</function>
is used).
</para>
</listitem>
  </varlistentry>
  <varlistentry id="f-Split">
    <term>
      <synopsis>Split(arg)</synopsis>
      <synopsis>env.Split(arg)</synopsis>
    </term>
    <listitem>
<para xmlns="http://www.scons.org/dbxsd/v1.0">
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.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
Example:
</para>

<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">
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
""")
</example_commands>
</listitem>
  </varlistentry>
  <varlistentry id="f-subst">
    <term>
      <synopsis>env.subst(input, [raw, target, source, conv])</synopsis>
    </term>
    <listitem>
<para xmlns="http://www.scons.org/dbxsd/v1.0">
Performs construction variable interpolation
on the specified string or sequence argument
<varname>input</varname>.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
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
<literal>$(</literal>
and
<literal>$)</literal>
character sequences will be stripped from the returned string,
The optional
<varname>raw</varname>
argument may be set to
<literal>1</literal>
if you want to preserve white space and
<literal>$(</literal>-<literal>$)</literal>
sequences.
The
<varname>raw</varname>
argument may be set to
<literal>2</literal>
if you want to strip
all characters between
any
<literal>$(</literal>
and
<literal>$)</literal>
pairs
(as is done for signature calculation).
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
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.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
The optional
<varname>target</varname>
and
<varname>source</varname>
keyword arguments
must be set to lists of
target and source nodes, respectively,
if you want the
<envar xmlns="http://www.scons.org/dbxsd/v1.0">$TARGET</envar>,
<envar xmlns="http://www.scons.org/dbxsd/v1.0">$TARGETS</envar>,
<envar xmlns="http://www.scons.org/dbxsd/v1.0">$SOURCE</envar>
and
<envar xmlns="http://www.scons.org/dbxsd/v1.0">$SOURCES</envar>
to be available for expansion.
This is usually necessary if you are
calling
<function xmlns="http://www.scons.org/dbxsd/v1.0">env.subst</function>
from within a Python function used
as an SCons action.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
Returned string values or sequence elements
are converted to their string representation by default.
The optional
<varname>conv</varname>
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
Λ
idiom to pass in an unnamed function
that simply returns its unconverted argument.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
Example:
</para>

<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">
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)
</example_commands>
</listitem>
  </varlistentry>
  <varlistentry id="f-Tag">
    <term>
      <synopsis>Tag(node, tags)</synopsis>
    </term>
    <listitem>
<para xmlns="http://www.scons.org/dbxsd/v1.0">
Annotates file or directory Nodes with
information about how the
<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="b-Package"><function>Package</function></link>
Builder should package those files or directories.
All tags are optional.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
Examples:
</para>

<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">
# 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 )
</example_commands>
</listitem>
  </varlistentry>
  <varlistentry id="f-TargetSignatures">
    <term>
      <synopsis>TargetSignatures(type)</synopsis>
      <synopsis>env.TargetSignatures(type)</synopsis>
    </term>
    <listitem>
<para xmlns="http://www.scons.org/dbxsd/v1.0">
Note:  Although it is not yet officially deprecated,
use of this function is discouraged.
See the
<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="f-Decider"><function>Decider</function></link>
function for a more flexible and straightforward way
to configure SCons' decision-making.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
The
<function xmlns="http://www.scons.org/dbxsd/v1.0">TargetSignatures</function>
function tells
<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename>
how to decide if a target file
(a file that
<emphasis>is</emphasis>
built from any other files)
has changed since the last time it
was used to build some other target file.
Legal values are
<literal>"build"</literal>;
<literal>"content"</literal>
(or its synonym
<literal>"MD5"</literal>);
<literal>"timestamp"</literal>;
or
<literal>"source"</literal>.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
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.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
<literal>"content"</literal>
(or its synonym
<literal>"MD5"</literal>)
means
<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename>
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
<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename>
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.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
<literal>"timestamp"</literal>
means
<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename>
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
<emphasis>older</emphasis>
than the last time it was used to rebuild the target file.)
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
<literal>"source"</literal>
means
<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename>
decides that a target file has changed
as specified by the corresponding
<function xmlns="http://www.scons.org/dbxsd/v1.0">SourceSignatures</function>
setting
(<literal>"MD5"</literal>
or
<literal>"timestamp"</literal>).
This means that
<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename>
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.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
<literal>"build"</literal>
means
<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename>
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
<function xmlns="http://www.scons.org/dbxsd/v1.0">SourceSignatures</function>
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.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
<literal>"build"</literal>
signatures are fastest because
<literal>"content"</literal>
(or
<literal>"MD5"</literal>)
signatures take longer to compute,
but are more accurate than
<literal>"timestamp"</literal>
signatures,
and can prevent unnecessary "downstream" rebuilds
when a target file is rebuilt to the exact same contents
as the previous build.
The
<literal>"source"</literal>
setting provides the most consistent behavior
when other target files may be rebuilt from
both source and target input files.
The default value is
<literal>"source"</literal>.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
Because the default setting is
<literal>"source"</literal>,
using
<function xmlns="http://www.scons.org/dbxsd/v1.0">SourceSignatures</function>
is generally preferable to
<function xmlns="http://www.scons.org/dbxsd/v1.0">TargetSignatures</function>,
so that the up-to-date decision
will be consistent for all files
(or all files built with a specific construction environment).
Use of
<function xmlns="http://www.scons.org/dbxsd/v1.0">TargetSignatures</function>
provides specific control for how built target files
affect their "downstream" dependencies.
</para>
</listitem>
  </varlistentry>
  <varlistentry id="f-Tool">
    <term>
      <synopsis>Tool(string, [toolpath, **kw])</synopsis>
      <synopsis>env.Tool(string, [toolpath, **kw])</synopsis>
    </term>
    <listitem>
<para xmlns="http://www.scons.org/dbxsd/v1.0">
The
<function xmlns="http://www.scons.org/dbxsd/v1.0">Tool</function>
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
<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="cv-TOOLS"><envar>$TOOLS</envar></link>
construction variable.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
Additional keyword arguments are passed to the tool's
<function>generate</function>()
method.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
Examples:
</para>

<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">
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
</example_commands>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
The
<function xmlns="http://www.scons.org/dbxsd/v1.0">env.Tool</function>
form of the function
applies the callable object for the specified tool
<varname>string</varname>
to the environment through which the method was called.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
Additional keyword arguments are passed to the tool's
<function>generate</function>()
method.
</para>

<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">
env.Tool('gcc')
env.Tool('opengl', toolpath = ['build/tools'])
</example_commands>
</listitem>
  </varlistentry>
  <varlistentry id="f-Value">
    <term>
      <synopsis>Value(value, [built_value])</synopsis>
      <synopsis>env.Value(value, [built_value])</synopsis>
    </term>
    <listitem>
<para xmlns="http://www.scons.org/dbxsd/v1.0">
Returns a Node object representing the specified Python value.  Value
Nodes can be used as dependencies of targets.  If the result of
calling
<function>str</function>(<varname>value</varname>)
changes between SCons runs, any targets depending on
<function>Value</function>(<varname>value</varname>)
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.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
The returned Value Node object has a
<function>write</function>()
method that can be used to "build" a Value Node
by setting a new value.
The optional
<varname>built_value</varname>
argument can be specified
when the Value Node is created
to indicate the Node should already be considered
"built."
There is a corresponding
<function>read</function>()
method that will return the built value of the Node.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
Examples:
</para>

<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">
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))
</example_commands>
</listitem>
  </varlistentry>
  <varlistentry id="f-VariantDir">
    <term>
      <synopsis>VariantDir(variant_dir, src_dir, [duplicate])</synopsis>
      <synopsis>env.VariantDir(variant_dir, src_dir, [duplicate])</synopsis>
    </term>
    <listitem>
<para xmlns="http://www.scons.org/dbxsd/v1.0">
Use the
<function xmlns="http://www.scons.org/dbxsd/v1.0">VariantDir</function>
function to create a copy of your sources in another location:
if a name under
<varname>variant_dir</varname>
is not found but exists under
<varname>src_dir</varname>,
the file or directory is copied to
<varname>variant_dir</varname>.
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.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
<function xmlns="http://www.scons.org/dbxsd/v1.0">VariantDir</function>
can be called multiple times with the same
<varname>src_dir</varname>
to set up multiple builds with different options
(<varname>variants</varname>).
The
<varname>src_dir</varname>
location must be in or underneath the SConstruct file's directory, and
<varname>variant_dir</varname>
may not be underneath
<varname>src_dir</varname>.
<!--
TODO: Can the above restrictions be clarified or relaxed?
TODO: The latter restriction is clearly not completely right;
TODO: src_dir = '.' works fine with a build dir under it.
-->
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
The default behavior is for
<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename>
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.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
If possible on the platform,
the duplication is performed by linking rather than copying;
see also the
<option>--duplicate</option>
command-line option.
Moreover, only the files needed for the build are duplicated;
files and directories that are not used are not present in
<varname>variant_dir</varname>.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
Duplicating the source tree may be disabled by setting the
<literal>duplicate</literal>
argument to
<literal>0</literal>
(zero).
This will cause
<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename>
to invoke Builders using the path names of source files in
<varname>src_dir</varname>
and the path names of derived files within
<varname>variant_dir</varname>.
This is always more efficient than
<literal>duplicate=1</literal>,
and is usually safe for most builds
(but see above for cases that may cause problems).
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
Note that
<function xmlns="http://www.scons.org/dbxsd/v1.0">VariantDir</function>
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
<varname>variant_dir</varname>,
regardless of the value of
<literal>duplicate</literal>.
This is how you tell
<filename xmlns="http://www.scons.org/dbxsd/v1.0">scons</filename>
which variant of a source tree to build:
</para>

<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">
# run src/SConscript in two variant directories
VariantDir('build/variant1', 'src')
SConscript('build/variant1/SConscript')
VariantDir('build/variant2', 'src')
SConscript('build/variant2/SConscript')
</example_commands>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
See also the
<link xmlns="http://www.scons.org/dbxsd/v1.0" linkend="f-SConscript"><function>SConscript</function></link>
function, described above,
for another way to specify a variant directory
in conjunction with calling a subsidiary SConscript file.
</para>

<para xmlns="http://www.scons.org/dbxsd/v1.0">
Examples:
</para>

<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">
# use names in the build directory, not the source directory
VariantDir('build', 'src', duplicate=0)
Program('build/prog', 'build/source.c')
</example_commands>

<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">
# this builds both the source and docs in a separate subtree
VariantDir('build', '.', duplicate=0)
SConscript(dirs=['build/src','build/doc'])
</example_commands>

<example_commands xmlns="http://www.scons.org/dbxsd/v1.0">
# 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)
</example_commands>
</listitem>
  </varlistentry>
  <varlistentry id="f-WhereIs">
    <term>
      <synopsis>WhereIs(program, [path, pathext, reject])</synopsis>
      <synopsis>env.WhereIs(program, [path, pathext, reject])</synopsis>
    </term>
    <listitem>
<para xmlns="http://www.scons.org/dbxsd/v1.0">
Searches for the specified executable
<varname>program</varname>,
returning the full path name to the program
if it is found,
and returning None if not.
Searches the specified
<varname>path</varname>,
the value of the calling environment's PATH
(<literal>env['ENV']['PATH']</literal>),
or the user's current external PATH
(<literal>os.environ['PATH']</literal>)
by default.
On Windows systems, searches for executable
programs with any of the file extensions
listed in the specified
<varname>pathext</varname>,
the calling environment's PATHEXT
(<literal>env['ENV']['PATHEXT']</literal>)
or the user's current PATHEXT
(<literal>os.environ['PATHEXT']</literal>)
by default.
Will not select any
path name or names
in the specified
<varname>reject</varname>
list, if any.
</para>
</listitem>
  </varlistentry>
</variablelist>
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.