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
|
<sect1 id="reference">
<title>Reference</title>
<sect2 id="obtaining" xreflabel="Obtaining DejaGnu">
<title>Obtaining &dj;</title>
<para>You can obtain &dj; from the &dj; web site at the
<ulink url="http://www.gnu.org">Free Software Foundation</ulink>,
which is at <ulink
url="http://www.gnu.org/software/dejagnu/">www.gnu.org/software/dejagnu/
</ulink></para>
</sect2>
<sect2 id="installation" xreflabel="Installation">
<title>Installation</title>
<para>Once you have the &dj; source unpacked and available, you must
first configure the software to specify where it is to run (and the
associated defaults); then you can proceed to installing it.</para>
<sect3 id="configuring" xreflabel="Configuring DejaGnu">
<title>Configuring &dj;</title>
<para>It is usually best to configure in a directory separate from the
source tree, specifying where to find the source with the optional
<option>--srcdir</option> option to
<emphasis>configure</emphasis>. &dj; uses the GNU
<emphasis>autoconf</emphasis> to configure itself. For more info on using
autoconf, read the GNU autoconf manual. To configure, execute the
<filename>configure</filename> program, no other options are
required. For an example, to configure in a separate tree for objects,
execute the configure script from the source tree like this:</para>
<screen>
../dejagnu-&version;/configure
</screen>
<para>&dj; doesn't care at config time if it's for testing a native
system or a cross system. That is determined at runtime by using the
config files.</para>
<para>You may also want to use the <command>configure</command> option
<option>--prefix</option> to specify where you want &dj; and its
supporting code installed. By default, installation is in subdirectories
of <filename>/usr/local</filename>, but you can select any alternate
directory <symbol>altdir</symbol> by including
<option>--prefix</option>{altdir}} on the
<command>configure</command> command line. (This value is captured in
the Makefile variables <emphasis>prefix</emphasis> and
<emphasis>exec</emphasis>prefix}.)</para>
<para>Save for a small number of example tests, the &dj; distribution
itself does not include any testsuites; these are available
separately. Testsuites for the GNU development tools are included in
those releases. After configuring the top-level &dj; directory, unpack
and configure the test directories for the tools you want to test; then,
in each test directory, run <emphasis>make check</emphasis> to build
auxiliary programs required by some of the tests, and run the test
suites.</para>
</sect3>
<sect3 id="installing" xreflabel="Installing DejaGnu">
<title>Installing &dj;</title>
<para>To install &dj; in your filesystem (either in
<filename>/usr/local</filename>, or as specified by your
<option>--prefix</option> option to <emphasis>configure</emphasis>),
execute.</para>
<screen>
eg$ make install
</screen>
<para><emphasis>make install</emphasis>does these things for
&dj;:</para>
<itemizedlist mark="bullet">
<listitem><para>Look in the path specified for executables
<symbol>$exec_prefix</symbol>) for directories called
<filename>lib</filename> and <filename>bin</filename>. If these
directories do not exist, <emphasis>make install</emphasis> creates
them.</para></listitem>
<listitem><para>Create another directory in the
<filename>share</filename> directory, called
<filename>dejagnu</filename>, and copy all the library files into
it.</para></listitem>
<listitem><para>Create a directory in the
<filename>dejagnu/share</filename> directory, called
<filename>config</filename>, and copy all the configuration files into
it.</para></listitem>
<listitem><para>Copy the <emphasis>runtest</emphasis> shell script into
<filename>$exec_prefix/bin</filename>.</para></listitem>
<listitem><para>Copy <filename>runtest.exp</filename> into
<filename>$exec_prefix/lib/dejagnu</filename>. This is the main Tcl
code implementing &dj;.</para></listitem>
</itemizedlist>
</sect3>
</sect2>
<sect2 id="builtins" xreflabel="Builtin Procedures">
<title>Builtin Procedures</title>
<para>&dj; provides these Tcl procedures.</para>
<sect3 id="coreprocs" xreflabel="Core Internal Procedures">
<title>Core Internal Procedures</title>
<sect4 id="mailfile" xreflabel="mail_file procedure">
<title>Mail_file Procedure</title>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>mail_file</function></funcdef>
<paramdef><parameter>file to
subject</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter></parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="openlogs" xreflabel="open_logs procedure">
<title>Open_logs Procedure</title>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>open_logs</function></funcdef>
<paramdef><parameter></parameter></paramdef>
</funcprototype>
</funcsynopsis>
</sect4>
<sect4 id="closelogs" xreflabel="close_logs procedure">
<title>Close_logs Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>close_logs</function></funcdef>
<paramdef><parameter></parameter></paramdef>
</funcprototype>
</funcsynopsis>
</sect4>
<sect4 id="isbuild" xreflabel="isbuild procedure">
<title>Isbuild Procedure</title>
<para>Tests for a particular build host environment. If the
currently configured host matches the argument string, the result is
<emphasis>1</emphasis>; otherwise the result is
<emphasis>0</emphasis>. <emphasis>host</emphasis> must be a full
three-part configure host name; in particular, you may not use the
shorter nicknames supported by configure (but you can use wildcard
characters, using shell syntax, to specify sets of names). If it is
passed a NULL string, then it returns the name of the build canonical
configuration.</para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>isbuild</function></funcdef>
<paramdef><parameter>pattern</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>pattern</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="isremote" xreflabel="is_remote procedure">
<title>Is_remote Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>is_remote</function></funcdef>
<paramdef><parameter>board</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter></parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="is3way" xreflabel="is3way procedure">
<title>is3way Procedure</title>
<para>Tests for a canadian cross. This is when the tests will be run
on a remotely hosted cross compiler. If it is a canadian cross, then
the result is <emphasis>1</emphasis>; otherwise the result is
<emphasis>0</emphasis>.</para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>is3way</function></funcdef>
<paramdef><parameter></parameter></paramdef>
</funcprototype>
</funcsynopsis>
</sect4>
<sect4 id="ishost" xreflabel="ishost procedure">
<title>Ishost Procedure</title>
<para>Tests for a particular host environment. If the currently
configured host matches the argument string, the result is
<emphasis>1</emphasis>; otherwise the result is
<emphasis>0</emphasis>. <emphasis>host</emphasis> must be a full
three-part configure host name; in particular, you may not use the
shorter nicknames supported by configure (but you can use wildcard
characters, using shell syntax, to specify sets of names).</para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>ishost</function></funcdef>
<paramdef><parameter>pattern</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter></parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="istarget" xreflabel="istarget procedure">
<title>Istarget Procedure</title>
<para>Tests for a particular target environment. If the currently
configured target matches the argument string, the result is
<emphasis>1</emphasis> ; otherwise the result is
<emphasis>0</emphasis>. target must be a full three-part configure
target name; in particular, you may not use the shorter nicknames
supported by configure (but you can use wildcard characters, using
shell syntax, to specify sets of names). If it is passed a
<emphasis>NULL</emphasis> string, then it returns the name of the
build canonical configuration.</para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>istarget</function></funcdef>
<paramdef><parameter>args</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter></parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="isnative" xreflabel="isnative procedure">
<title>Isnative Procedure</title>
<para>Tests whether the current configuration has the same host and
target. When it runs in a native configuration this procedure returns
a <emphasis>1</emphasis>; otherwise it returns a
<emphasis>0</emphasis>.</para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>isnative</function></funcdef>
<paramdef><parameter></parameter></paramdef>
</funcprototype>
</funcsynopsis>
</sect4>
<sect4 id="unknown" xreflabel="unknown procedure">
<title>Unknown Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>unknown</function></funcdef>
<paramdef><parameter>args</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>args</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="cloneoutput" xreflabel="clone_output procedure">
<title>Clone_output Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>clone_output</function></funcdef>
<paramdef><parameter>message</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>message</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="resetvars" xreflabel="reset_vars procedure">
<title>Reset_vars Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>reset_vars</function></funcdef>
<paramdef><parameter></parameter></paramdef>
</funcprototype>
</funcsynopsis>
</sect4>
<sect4 id="logandexit" xreflabel="log_and_exit procedure">
<title>Log_and_exit Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>log_and_exit</function></funcdef>
<paramdef><parameter></parameter></paramdef>
</funcprototype>
</funcsynopsis>
</sect4>
<sect4 id="logsummary" xreflabel="log_summary procedure">
<title>Log_summary Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>log_summary</function></funcdef>
<paramdef><parameter>args</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>args</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="cleanup" xreflabel="cleanup procedure">
<title>Cleanup Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>cleanup</function></funcdef>
<paramdef><parameter></parameter></paramdef>
</funcprototype>
</funcsynopsis>
</sect4>
<sect4 id="setupxfail" xreflabel="setup_xfail procedure">
<title>Setup_xfail Procedure</title>
<para>Declares that the test is expected to fail on a particular set
of configurations. The config argument must be a list of full
three-part configure target name; in particular, you may not use the
shorter nicknames supported by configure (but you can use the common
shell wildcard characters to specify sets of names). The
<emphasis>bugid</emphasis> argument is optional, and used only in the
logging file output; use it as a link to a bug-tracking system such
as <productname>GNATS</productname>.</para>
<para>Once you use <function>setup_xfail</function>, the
<function>fail</function> and <function>pass</function> procedures
produce the messages <emphasis>XFAIL</emphasis> and
<emphasis>XPASS</emphasis> respectively, allowing you to distinguish
expected failures (and unexpected success!) from other test
outcomes.</para>
<warning><para>Warning you must clear the expected failure after
using setup_xfail in a test case. Any call to <function>pass
</function>or <function>fail</function> clears the expected failure
implicitly; if the test has some other outcome, e.g. an error, you
can call <function>clear_xfail</function> to clear the expected
failure explicitly. Otherwise, the expected-failure declaration
applies to whatever test runs next, leading to surprising
results.</para></warning>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>setup_xfail</function></funcdef>
<paramdef><parameter>config</parameter>
<parameter>bugid</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>config</parameter></term>
<listitem><para>The config triplet to trigger whether this is an
unexpected or expect failure.</para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>bugid</parameter></term>
<listitem><para>The optional bugid, used to tie this test case
to a bug tracking system.</para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="recordtest" xreflabel="record_test procedure">
<title>Record_test Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>record_test</function></funcdef>
<paramdef><parameter>type</parameter>
<parameter>message</parameter>
<parameter>args</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>type</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>message</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>args</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="pass" xreflabel="pass procedure">
<title>Pass Procedure</title>
<para>Declares a test to have passed. <function>pass</function>
writes in the log files a message beginning with
<emphasis>PASS</emphasis> (or <emphasis>XPASS</emphasis>, if failure
was expected), appending the argument
<parameter>string</parameter>.</para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>pass</function></funcdef>
<paramdef><parameter>string</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>string</parameter></term>
<listitem><para>The string to use for this PASS
message.</para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="fail" xreflabel="fail procedure">
<title>Fail Procedure</title>
<para>Declares a test to have failed. <function>fail</function>
writes in the log files a message beginning with
<emphasis>FAIL</emphasis> (or <emphasis>XFAIL</emphasis>, if failure
was expected), appending the argument
<parameter>string</parameter>.</para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>fail</function></funcdef>
<paramdef><parameter>string</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>string</parameter></term>
<listitem><para>The string to use for this FAIL
message.</para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="xpass" xreflabel="xpass procedure">
<title>Xpass Procedure</title>
<para>Declares a test to have unexpectably passed, when it was
expected to be a failure. <function>xpass</function>
writes in the log files a message beginning with
<emphasis>XPASS</emphasis> (or <emphasis>XFAIL</emphasis>, if failure
was expected), appending the argument
<parameter>string</parameter>.</para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>xpass</function></funcdef>
<paramdef><parameter>string</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>string</parameter></term>
<listitem><para>The string to use for this output
state.</para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="xfail" xreflabel="xfail procedure">
<title>Xfail Procedure</title>
<para>Declares a test to have expectably
failed. <function>xfail</function>
writes in the log files a message beginning with
<emphasis>XFAIL</emphasis> (or <emphasis>PASS</emphasis>, if success
was expected), appending the argument
<parameter>string</parameter>.</para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>xpass</function></funcdef>
<paramdef><parameter>string</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>string</parameter></term>
<listitem><para>The string to use for this output
state.</para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="setwarningthreshold" xreflabel="set_warning_threshold procedure">
<title>Set_warning_threshold Procedure</title>
<para>Sets the value of <symbol>warning_threshold</symbol>. A value
of <emphasis>0</emphasis> disables it: calls to
<function>warning</function> will not turn a
<emphasis>PASS</emphasis> or <emphasis>FAIL</emphasis> into an
<emphasis>UNRESOLVED</emphasis>.</para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>set_warning_threshold</function></funcdef>
<paramdef><parameter>threshold</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>threshold</parameter></term>
<listitem><para>This is the value of the new warning
threshold.</para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="getwarningthreshold" xreflabel="get_warning_threshold procedure">
<title>Get_warning_threshold Procedure</title>
<para>Returns the current value of
<symbol>{warning_threshold</symbol>. The default value is 3. This
value controls how many <function>warning</function> procedures can
be called before becoming <emphasis>UNRESOLVED</emphasis>.</para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>get_warning_threshold</function></funcdef>
<paramdef><parameter></parameter></paramdef>
</funcprototype>
</funcsynopsis>
</sect4>
<sect4 id="warning" xreflabel="warning procedure">
<title>Warning Procedure</title>
<para>Declares detection of a minor error in the test case
itself. <function>warning</function> writes in the log files a message
beginning with <emphasis>WARNING</emphasis>, appending the argument
<parameter>string</parameter>. Use <function>warning</function> rather
than <function>perror</function> for cases (such as communication
failure to be followed by a retry) where the test case can recover from
the error. If the optional <parameter>number</parameter> is supplied,
then this is used to set the internal count of warnings to that
value.</para>
<para>As a side effect, <symbol>warning_threshold</symbol> or more
calls to warning in a single test case also changes the effect of the
next <function>pass</function> or <function>fail</function> command:
the test outcome becomes <emphasis>UNRESOLVED</emphasis> since an
automatic <emphasis>PASS</emphasis> or <emphasis>FAIL</emphasis> may
not be trustworthy after many warnings. If the optional numeric value
is <emphasis>0</emphasis>, then there are no further side effects to
calling this function, and the following test outcome doesn't become
<emphasis>UNRESOLVED</emphasis>. This can be used for errors with no
known side effects.</para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>warning</function></funcdef>
<paramdef><parameter>string</parameter>
<parameter>number</parameter>
</paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>string</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>number</parameter></term>
<listitem><para>The optional number to set the error counter. This
is only used to fake out the counter when using the
<function>xfail</function> procedure to control when it flips the
output over to <emphasis>UNRESOLVED</emphasis>
state.</para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="perror" xreflabel="perror procedure">
<title>Perror Procedure</title>
<para>Declares a severe error in the testing framework
itself. <function>perror</function> writes in the log files a message
beginning with <emphasis>ERROR</emphasis>, appending the argument
<parameter>string</parameter>.</para>
<para>As a side effect, perror also changes the effect of the next
<function>pass</function> or <function>fail</function> command: the
test outcome becomes <emphasis>UNRESOLVED</emphasis>, since an
automatic <emphasis>PASS</emphasis> or <emphasis>FAIL</emphasis> cannot
be trusted after a severe error in the test framework. If the optional
numeric value is <emphasis>0</emphasis>, then there are no further side
effects to calling this function, and the following test outcome
doesn't become <emphasis>UNRESOLVED</emphasis>. This can be used for
errors with no known side effects.</para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>perror</function></funcdef>
<paramdef><parameter>string</parameter>
<parameter>number</parameter>
</paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>string</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>number</parameter></term>
<listitem><para>The optional number to set the error counter. This
is only used to fake out the counter when using the
<function>xfail</function> procedure to control when it flips the
output over to <emphasis>UNRESOLVED</emphasis>
state.</para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="note" xreflabel="note procedure">
<title>Note Procedure</title>
<para>Appends an informational message to the log
file. <function>note</function> writes in the log files a message
beginning with <emphasis>NOTE</emphasis>, appending the argument
<parameter>string</parameter>. Use <function>note</function>
sparingly. The <function>verbose</function> should be used for most
such messages, but in cases where a message is needed in the log file
regardless of the verbosity level use <function>note</function>.</para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>note</function></funcdef>
<paramdef><parameter>string</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>string</parameter></term>
<listitem><para>The string to use for this note.</para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="untested" xreflabel="untested procedure">
<title>Untested Procedure</title>
<para>Declares a test was not run. <function>untested</function> writes
in the log file a message beginning with <emphasis>UNTESTED</emphasis>,
appending the argument <emphasis>string</emphasis>. For example, you
might use this in a dummy test whose only role is to record that a test
does not yet exist for some feature.</para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>untested</function></funcdef>
<paramdef><parameter>string</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>string</parameter></term>
<listitem><para>The string to use for this output
state.</para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="unresolved" xreflabel="unresolved procedure">
<title>Unresolved Procedure</title>
<para>Declares a test to have an unresolved
outcome. <function>unresolved</function> writes in the log file a
message beginning with <emphasis>UNRESOLVED</emphasis>, appending the
argument <emphasis>string</emphasis>. This usually means the test did
not execute as expected, and a human being must go over results to
determine if it passed or failed (and to improve the test case).</para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>unresolved</function></funcdef>
<paramdef><parameter>string</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>string</parameter></term>
<listitem><para>The string to use for this output
state.</para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="unsupported" xreflabel="unsupported procedure">
<title>Unsupported Procedure</title>
<para>Declares that a test case depends on some facility that does not
exist in the testing environment. <function>unsupported</function>
writes in the log file a message beginning with
<emphasis>UNSUPPORTED</emphasis>, appending the argument string.</para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>unsupported</function></funcdef>
<paramdef><parameter>string</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>string</parameter></term>
<listitem><para>The string to use for this output
state.</para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="inittestcounts" xreflabel="init_testcounts procedure">
<title>Init_testcounts Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>init_testcounts</function></funcdef>
<paramdef><parameter></parameter></paramdef>
</funcprototype>
</funcsynopsis>
</sect4>
<sect4 id="incrcount" xreflabel="incr_count procedure">
<title>Incr_count Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>incr_count</function></funcdef>
<paramdef><parameter>name</parameter>
<parameter>args</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>name</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>args</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="transform" xreflabel="transform procedure">
<title>transform Procedure</title>
<para>Generates a string for the name of a tool as it was configured
and installed, given its native name (as the argument
<parameter>toolname</parameter>). This makes the assumption that all
tools are installed using the same naming conventions: For example,
for a cross compiler supporting the <emphasis>m68k-vxworks</emphasis>
configuration, the result of transform <command>gcc</command> is
<command>m68k-vxworks-gcc</command>.</para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>transform</function></funcdef>
<paramdef><parameter>toolname</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>toolname</parameter></term>
<listitem><para>The name of the cross-development program to
transform.</para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="checkconditionalxfail" xreflabel="check_conditional_xfail procedure">
<title>Check_conditional_xfail Procedure</title>
<para>This procedure adds a conditional xfail, based on compiler
options used to create a test case executable. If an include options
is found in the compiler flags, and it's the right architecture,
it'll trigger an <emphasis>XFAIL</emphasis>. Otherwise it'll produce
an ordinary <emphasis>FAIL</emphasis>. You can also specify flags to
exclude. This makes a result be a <emphasis>FAIL</emphasis>, even if
the included options are found. To set the conditional, set
the variable <symbol>compiler_conditional_xfail_data</symbol> to the
fields <programlisting>"[message string] [targets list] [includes
list] [excludes list]"</programlisting> (descriptions below). This is
the checked at pass/fail decision time, so there is no need to call
the procedure yourself, unless you wish to know if it gets
triggered. After a pass/fail, the variable is reset, so it doesn't
effect other tests. It returns <emphasis>1</emphasis> if the
conditional is true, or <emphasis>0</emphasis> if the conditional is
false.</para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>check_conditional_xfail</function></funcdef>
<paramdef><parameter>message</parameter>
<parameter>targets</parameter>
<parameter>includes</parameter>
<parameter>excludes</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>message</parameter></term>
<listitem><para>This is the message to print with the normal test
result.</para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>targets</parameter></term>
<listitem><para>This is a string with the list targets to activate
this conditional on.</para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>includes</parameter></term>
<listitem><para>This is a list of sets of options to search for in
the compiler options to activate this conditional. If the list of
sets of options is empty or if any set of the options matches,
then this conditional is true. (It may be useful to specify an
empty list of include sets if the conditional is always true
unless one of the exclude sets matches.)</para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>excludes</parameter></term>
<listitem><para>This is a list of sets of options to search for in
the compiler options to activate this conditional. If any set of
the options matches, (regardless of whether any of the include sets
match) then this conditional is de-activated.</para></listitem>
</varlistentry>
</variablelist>
<example>
<title>Specifying the conditional xfail data</title>
<programlisting>
set compiler_conditional_xfail_data { \
"I sure wish I knew why this was hosed" \
"sparc*-sun*-* *-pc-*-*" \
{"-Wall -v" "-O3"} \
{"-O1" "-Map"} \
}
</programlisting>
</example>
<para>What this does is it matches only for these two targets if
"-Wall -v" or "-O3" is set, but neither "-O1" or "-Map" is set. For
a set to match, the options specified are searched for independently
of each other, so a "-Wall -v" matches either "-Wall -v" or "-v
-Wall". A space separates the options in the string. Glob-style
regular expressions are also permitted.</para>
</sect4>
<sect4 id="clearxfail" xreflabel="clear_xfail procedure">
<title>Clear_xfail Procedure</title>
<para>Cancel an expected failure (previously declared with
<command>setup_xfail</command>) for a particular set of
configurations. The <parameter>config</parameter> argument is a list
of configuration target names. It is only necessary to call
<command>clear_xfail</command> if a test case ends without calling
either <command>pass</command> or <command>fail</command>, after
calling <command>setup_xfail</command>.</para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>clear_xfail</function></funcdef>
<paramdef><parameter>config</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>config</parameter></term>
<listitem><para>The configuration triplets to
clear.</para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="verbose" xreflabel="verbose procedure">
<title>Verbose Procedure</title>
<para>Test cases can use this function to issue helpful messages
depending on the number of <option>--verbose</option> options on the
runtest command line. It prints string if the value of the variable
<symbol>verbose</symbol> is higher than or equal to the optional
number. The default value for number is <emphasis>1</emphasis>. Use
the optional <option>-log</option> argument to cause string to always
be added to the log file, even if it won't be printed. Use the
optional <option>-x</option> argument to log the test results into
a parsable XML file. Use the optional <option>-n</option> argument
to print string without a trailing newline. Use the optional
<option>--</option> argument if string begins with "-".</para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>verbose</function></funcdef>
<paramdef><parameter>-log</parameter>
<parameter>-x</parameter>
<parameter>-n</parameter>
<parameter>-r</parameter>
<parameter>string</parameter>
<parameter>number</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>-x</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>-log</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>-n</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>--</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>string</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>number</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="loadlib" xreflabel="load_lib procedure">
<title>Load_lib Procedure</title>
<para>Loads a &dj; library file by searching a fixed path built
into &dj;. If &dj; has been installed, it looks in a path
starting with the installed library directory. If you are running
&dj; directly from a source directory, without first running
<command>make install</command>, this path defaults to the current
directory. In either case, it then looks in the current directory
for a directory called <filename>lib</filename>. If there are
duplicate definitions, the last one loaded takes precedence over the
earlier ones.</para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>load_lib</function></funcdef>
<paramdef><parameter>filespec</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>filespec</parameter></term>
<listitem><para>The name of the &dj; library file to
load.</para></listitem>
</varlistentry>
</variablelist>
</sect4>
</sect3>
<sect3 id="remoteprocs">
<title>Procedures For Remote Communication</title>
<para><filename>lib/remote.exp</filename> defines these
functions, for establishing and managing communications. Each
of these procedures tries to establish the connection up to
three times before returning. Warnings (if retries will
continue) or errors (if the attempt is abandoned) report on
communication failures. The result for any of these
procedures is either <emphasis>-1</emphasis>, when the
connection cannot be established, or the spawn ID returned by
the <productname>Expect</productname> command
<command>spawn</command>.</para>
<para>It use the value of the <symbol>connect</symbol> field
in the <symbol>target_info</symbol> array (was
<symbol>connectmode</symbol> as the type of connection to
make. Current supported connection types are tip, kermit,
telnet, rsh, rlogin, and netdata. If the <option>--reboot</option>
option was used on the runtest command line, then the target
is rebooted before the connection is made.</para>
<sect4 id="callremote" xreflabel="call_remote procedure">
<title>Call_remote Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>call_remote</function></funcdef>
<paramdef><parameter>type</parameter>
<parameter>proc</parameter>
<parameter>dest</parameter>
<parameter>args</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>proc</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>dest</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>args</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="checkforboardstatus" xreflabel="check_for_board_status
procedure">
<title>Check_for_board_status Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>check_for_board_status</function></funcdef>
<paramdef><parameter>variable</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>variable</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="fileonbuild" xreflabel="file_on_build procedure">
<title>File_on_build Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>file_on_build</function></funcdef>
<paramdef><parameter>op</parameter>
<parameter>file</parameter>
<parameter>args</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>op</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>file</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>args</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="fileonhost" xreflabel="file_on_host procedure">
<title>File_on_host Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>file_on_host</function></funcdef>
<paramdef><parameter>op</parameter>
<parameter>file</parameter>
<parameter>args</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>op</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>file</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>args</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="localexec" xreflabel="local_exec procedure">
<title>Local_exec Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>local_exec</function></funcdef>
<paramdef><parameter>commandline</parameter>
<parameter>inp</parameter>
<parameter>outp</parameter>
<parameter>timeout</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>inp</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>outp</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>timeout</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="remotebinary" xreflabel="remote_binary procedure">
<title>Remote_binary Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>remote_binary</function></funcdef>
<paramdef><parameter>host</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>host</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="remoteclose" xreflabel="remote_close procedure">
<title>Remote_close Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>remote_close</function></funcdef>
<paramdef><parameter>shellid</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>shellid</parameter></term>
<listitem><para>This is the value returned by a call
to <function>remote_open</function>. This closes the
connection to the target so resources can be used by
others. This parameter can be left off if the
<symbol>fileid</symbol> field in the
<symbol>target_info</symbol> array is set.</para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="remotedownload" xreflabel="remote_download procedure">
<title>Remote_download Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>remote_download</function></funcdef>
<paramdef><parameter>dest</parameter>
<parameter>file</parameter>
<parameter>args</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>dest</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>file</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>args</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="remoteexec" xreflabel="remote_exec procedure">
<title>Remote_exec Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>remote_exec</function></funcdef>
<paramdef><parameter>hostname</parameter>
<parameter>program</parameter>
<parameter>args</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>hostname</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>program</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>args</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="remoteexpect" xreflabel="remote_expect procedure">
<title>Remote_expect Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>remote_expect</function></funcdef>
<paramdef><parameter>board</parameter>
<parameter>timeout</parameter>
<parameter>args</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>board</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>timeout</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>args</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="remotefile" xreflabel="remote_file procedure">
<title>Remote_file Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>remote_file</function></funcdef>
<paramdef><parameter>dest</parameter>
<parameter>args</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>dest</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>args</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="remoteld" xreflabel="remote_ld procedure">
<title>Remote_ld Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>remote_ld</function></funcdef>
<paramdef><parameter>dest</parameter>
<parameter>prog</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>dest</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>prog</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="remoteload" xreflabel="remote_load procedure">
<title>Remote_load Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>remote_load</function></funcdef>
<paramdef><parameter>dest</parameter>
<parameter>prog</parameter>
<parameter>args</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>dest</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>prog</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>args</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="remoteopen" xreflabel="remote_open procedure">
<title>Remote_open Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>remote_open</function></funcdef>
<paramdef><parameter>type</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>type</parameter></term>
<listitem><para>This is passed <option>host</option> or
<option>target</option>. Host or target refers to
whether it is a connection to a remote target, or a
remote host. This opens the connection to the desired
target or host using the default values in the
configuration system. It returns that
<symbol>spawn_id</symbol> of the process that manages
the connection. This value can be used in
<productname>Expect</productname> or
<command>exp_send</command> statements, or passed to
other procedures that need the connection process's
id. This also sets the <symbol>fileid</symbol> field in
the <symbol>target_info</symbol> array.</para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="remotepopconn" xreflabel="remote_pop_conn procedure">
<title>Remote_pop_conn Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>remote_pop_conn</function></funcdef>
<paramdef><parameter>host</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>host</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="remotepushconn" xreflabel="remote_push_conn procedure">
<title>Remote_push_conn Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>remote_push_conn</function></funcdef>
<paramdef><parameter>host</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>host</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="remoterawbinary" xreflabel="remote_raw_binary procedure">
<title>Remote_raw_binary Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>remote_raw_binary</function></funcdef>
<paramdef><parameter>host</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>host</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="remoterawclose" xreflabel="remote_raw_close procedure">
<title>Remote_raw_close Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>remote_raw_close</function></funcdef>
<paramdef><parameter>host</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>host</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="remoterawfile" xreflabel="remote_raw_file procedure">
<title>Remote_raw_file Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>remote_raw_file</function></funcdef>
<paramdef><parameter>dest</parameter>
<parameter>args</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>dest</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>args</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="remoterawld" xreflabel="remote_raw_ld procedure">
<title>remote_raw_ld Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>remote_raw_ld</function></funcdef>
<paramdef><parameter>dest</parameter>
<parameter>prog</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>dest</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>prog</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="remoterawload" xreflabel="remote_raw_load procedure">
<title>Remote_raw_load Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>remote_raw_load</function></funcdef>
<paramdef><parameter>dest</parameter>
<parameter>prog</parameter>
<parameter>args</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>dest</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>prog</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>args</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="remoterawopen" xreflabel="remote_raw_open procedure">
<title>Remote_raw_open Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>remote_raw_open</function></funcdef>
<paramdef><parameter>args</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>args</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="remoterawsend" xreflabel="remote_raw_send procedure">
<title>Remote_raw_send Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>remote_raw_send</function></funcdef>
<paramdef><parameter>dest</parameter>
<parameter>string</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>dest</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>string</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="remoterawspawn" xreflabel="remote_raw_spawn procedure">
<title>Remote_raw_spawn Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>remote_raw_spawn</function></funcdef>
<paramdef><parameter>dest</parameter>
<parameter>commandline</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>dest</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>commandline</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="remoterawtransmit" xreflabel="remote_raw_transmit
procedure">
<title>Remote_raw_transmit Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>remote_raw_transmit</function></funcdef>
<paramdef><parameter>dest</parameter>
<parameter>file</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>dest</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>file</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="remoterawwait" xreflabel="remote_raw_wait procedure">
<title>Remote_raw_wait Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>remote_raw_wait</function></funcdef>
<paramdef><parameter>dest</parameter>
<parameter>timeout</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>dest</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>timeout</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="remotereboot" xreflabel="remote_reboot procedure">
<title>Remote_reboot Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>remote_reboot</function></funcdef>
<paramdef><parameter>host</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>host</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="remotesend" xreflabel="remote_send procedure">
<title>Remote_send Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>remote_send</function></funcdef>
<paramdef><parameter>dest</parameter>
<parameter>string</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>dest</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>string</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="remotespawn" xreflabel="remote_spawn procedure">
<title>Remote_spawn Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>remote_spawn</function></funcdef>
<paramdef><parameter>dest</parameter>
<parameter>commandline</parameter>
<parameter>args</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>dest</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>commandline</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>args</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="remoteswapconn" xreflabel="remote_swap_conn procedure">
<title>Remote_swap_conn Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>remote_swap_conn</function></funcdef>
<paramdef><parameter>host</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter></parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="remotetransmit" xreflabel="remote_transmit procedure">
<title>Remote_transmit Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>remote_transmit</function></funcdef>
<paramdef><parameter>dest</parameter>
<parameter>file</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>dest</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>file</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="remoteupload" xreflabel="remote_upload procedure">
<title>Remote_upload Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>remote_upload</function></funcdef>
<paramdef><parameter>dest</parameter>
<parameter>srcfile</parameter>
<parameter>arg</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>dest</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>srcfile</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>arg</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="remotewait" xreflabel="remote_wait procedure">
<title>Remote_wait Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>remote_wait</function></funcdef>
<paramdef><parameter>dest</parameter>
<parameter>timeout</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>dest</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>timeout</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="standardclose" xreflabel="standard_close procedure">
<title>Standard_close Procedure</title>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>standard_close</function></funcdef>
<paramdef><parameter>host</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>host</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="standarddownload" xreflabel="standard_download procedure">
<title>Standard_download Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>standard_download</function></funcdef>
<paramdef><parameter>dest</parameter>
<parameter>file</parameter>
<parameter>destfile</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>dest</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>file</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>destfile</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="standardexec" xreflabel="standard_exec procedure">
<title>Standard_exec Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>standard_exec</function></funcdef>
<paramdef><parameter>hostname</parameter>
<parameter>args</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>hostname</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>args</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="standardfile" xreflabel="standard_file procedure">
<title>Standard_file Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>standard_file</function></funcdef>
<paramdef><parameter>dest</parameter>
<parameter>op</parameter>
<parameter>args</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter></parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="standardload" xreflabel="standard_load procedure">
<title>Standard_load Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>standard_load</function></funcdef>
<paramdef><parameter>dest</parameter>
<parameter>prog</parameter>
<parameter>args</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>dest</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>prog</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>args</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="standardreboot" xreflabel="standard_reboot procedure">
<title>Standard_reboot Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>standard_reboot</function></funcdef>
<paramdef><parameter>host</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>host</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="standardsend" xreflabel="standard_send procedure">
<title>Standard_send Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>standard_send</function></funcdef>
<paramdef><parameter>dest</parameter>
<parameter>string</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>dest</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>string</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="standardspawn" xreflabel="standard_spawn procedure">
<title>Standard_spawn Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>standard_spawn</function></funcdef>
<paramdef><parameter>dest</parameter>
<parameter>commandline</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>dest</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>commandline</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="standardtransmit" xreflabel="standard_transmit procedure">
<title>Standard_transmit Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>standard_transmit</function></funcdef>
<paramdef><parameter>dest</parameter>
<parameter>file</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>dest</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>file</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="standardupload" xreflabel="standard_upload procedure">
<title>Standard_upload Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>standard_upload</function></funcdef>
<paramdef><parameter>dest srcfile destfile</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>dest</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>srcfile</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>destfile</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="standardwait" xreflabel="standard_wait procedure">
<title>Standard_wait Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>standard_wait</function></funcdef>
<paramdef><parameter>dest</parameter>
<parameter>timeout</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>dest</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>timeout</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="unixcleanfilename" xreflabel="unix_clean_filename
procedure">
<title>Unix_clean_filename Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>unix_clean_filename</function></funcdef>
<paramdef><parameter>dest</parameter>
<parameter>file</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>dest</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>file</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<!-- FIXME: this doesn't seem to exist anymore
<sect4 id="exitremoteshell" xreflabel="exit_remote_shell procedure">
<title>exit_remote_shell Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>exit_remote_shell</function></funcdef>
<paramdef><parameter>spawnid</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>spawnid</parameter></term>
<listitem><para>Exits a remote process started by any
of the connection procedures. <symbol>spawnid</symbol>
is the result of the connection procedure that started
the remote process.</para></listitem>
</varlistentry>
</variablelist>
</sect4>
-->
</sect3>
<sect3 id="connprocs" xreflabel="connprocs">
<title>Procedures For Using Utilities to Connect</title>
<para>telnet, rsh, tip, kermit</para>
<sect4 id="telnet" xreflabel="telnet procedure">
<title>telnet Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>telnet</function></funcdef>
<paramdef><parameter>hostname</parameter>
<parameter>port</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>rlogin</function></funcdef>
<paramdef><parameter>hostname</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</sect4>
<sect4 id="rsh" xreflabel="rsh procedure">
<title>rsh Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>rsh</function></funcdef>
<paramdef><parameter>hostname</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>hostname</parameter></term>
<listitem><para>This refers to the IP address or name
(for example, an entry in
<filename>/etc/hosts</filename>) for this target. The
procedure names reflect the Unix utility used to
establish a connection. The optional
<parameter>port</parameter> is used to specify the IP
port number. The value of the
<parameter>netport</parameter> field in the
<symbol>target_info</symbol> array is used. (was
<symbol>$netport</symbol>) This value has two parts,
the hostname and the port number, separated by a
<emphasis>:</emphasis>. If host or target is used in
the <symbol>hostname</symbol> field, than the
config array is used for all information.</para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="tip" xreflabel="tip procedure">
<title>Tip Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>tip</function></funcdef>
<paramdef><parameter>port</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>port</parameter></term>
<listitem><para>Connect using the Unix utility
<command>tip</command>. <parameter>Port</parameter>must
be a name from the <productname>tip</productname>
configuration file
<filename>/etc/remote</filename>. Often, this is called
<symbol>hardwire</symbol>, or something like
<symbol>ttya</symbol>. This file holds all the
configuration data for the serial port. The value of
the <symbol>serial</symbol> field in the
<symbol>target_info</symbol> array is used. (was
<symbol>$serialport</symbol>) If <option>host</option>
or <option>target</option> is used in the
<parameter>port</parameter> field, than the config
array is used for all information. the
config array is used for all information.</para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="kermit" xreflabel="kermit procedure">
<title>Kermit Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>kermit</function></funcdef>
<paramdef><parameter>port</parameter>
<parameter>bps</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>port</parameter></term>
<listitem><para>Connect using the program
<command>kermit</command>. <parameter>Port</parameter>
is the device name,
e.g. <filename>/dev/ttyb</filename>.
</para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>bps</parameter></term>
<listitem><para><parameter>bps</parameter> is the line
speed to use (in its per second) for the
connection. The value of the <symbol>serial</symbol>
field in the <symbol>target_info</symbol> array is
used. (was <symbol>$serialport</symbol>) If
<option>host</option> or <option>target</option> is
used in the <parameter>port</parameter> field, than the
config array is used for all information. the
config array is used for all information.</para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="kermitopen" xreflabel="kermit_open procedure">
<title>kermit_open Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>kermit_open</function></funcdef>
<paramdef><parameter>dest</parameter>
<parameter>args</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>dest</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>args</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="kermitcommand" xreflabel="kermit_command procedure">
<title>Kermit_command Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>kermit_command</function></funcdef>
<paramdef><parameter>dest</parameter>
<parameter>args</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>dest</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>args</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="kermitsend" xreflabel="kermit_send procedure">
<title>Kermit_send Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>kermit_send</function></funcdef>
<paramdef><parameter>dest string args</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>dest</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>string</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>args</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="kermittransmit" xreflabel="kermit_transmit procedure">
<title>Kermit_transmit Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>kermit_transmit</function></funcdef>
<paramdef><parameter>dest</parameter>
<parameter>file</parameter>
<parameter>args</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>dest</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>file</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>args</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="telnetopen" xreflabel="telnet_open procedure">
<title>Telnet_open Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>telnet_open</function></funcdef>
<paramdef><parameter>hostname</parameter>
<parameter>args</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>hostname</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>args</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="telnetbinary" xreflabel="telnet_binary procedure">
<title>Telnet_binary Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>telnet_binary</function></funcdef>
<paramdef><parameter>hostname</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>hostname</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="telnettransmit" xreflabel="telnet_transmit procedure">
<title>Telnet_transmit Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>telnet_transmit</function></funcdef>
<paramdef><parameter>dest</parameter>
<parameter>file</parameter>
<parameter>args</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>dest</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>file</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>args</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="tipopen" xreflabel="tip_open procedure">
<title>Tip_open Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>tip_open</function></funcdef>
<paramdef><parameter>hostname</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>hostname</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="rloginopen" xreflabel="rlogin_open procedure">
<title>Rlogin_open Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>rlogin_open</function></funcdef>
<paramdef><parameter>arg</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>arg</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="rloginspawn" xreflabel="rlogin_spawn procedure">
<title>Rlogin_spawn Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>rlogin_spawn</function></funcdef>
<paramdef><parameter>dest</parameter>
<parameter>cmdline</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>dest</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>cmdline</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="rshopen" xreflabel="rsh_open procedure">
<title>Rsh_open Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>rsh_open</function></funcdef>
<paramdef><parameter>hostname</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>hostname</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="rshdownload" xreflabel="rsh_download procedure">
<title>Rsh_download Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>rsh_download</function></funcdef>
<paramdef><parameter>desthost</parameter>
<parameter>srcfile</parameter>
<parameter>destfile</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>desthost</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>srcfile</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>destfile</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="rshupload" xreflabel="rsh_upload procedure">
<title>Rsh_upload Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>rsh_upload</function></funcdef>
<paramdef><parameter>desthost</parameter>
<parameter>srcfile</parameter>
<parameter>destfile</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>desthost</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>srcfile</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>destfile</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="rshexec" xreflabel="rsh_exec procedure">
<title>Rsh_exec Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>rsh_exec</function></funcdef>
<paramdef><parameter>boardname</parameter>
<parameter>cmd</parameter>
<parameter>args</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>boardname</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>cmd</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>args</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="ftpopen" xreflabel="ftp_open procedure">
<title>Ftp_open Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>ftp_open</function></funcdef>
<paramdef><parameter>host</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>host</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="ftpupload" xreflabel="ftp_upload procedure">
<title>Ftp_upload Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>ftp_upload</function></funcdef>
<paramdef><parameter>host</parameter>
<parameter>remotefile</parameter>
<parameter>localfile</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>host</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>remotefile</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>localfile</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="ftpdownload" xreflabel="ftp_download procedure">
<title>Ftp_download Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>ftp_download</function></funcdef>
<paramdef><parameter>host</parameter>
<parameter>localfile</parameter>
<parameter>remotefile</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>host</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>localfile</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>remotefile</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="ftpclose" xreflabel="ftp_close procedure">
<title>Ftp_close Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>ftp_close</function></funcdef>
<paramdef><parameter>host</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>host</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="tipdownload" xreflabel="tip_download procedure">
<title>Tip_download Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>tip_download</function></funcdef>
<paramdef><parameter>spawnid</parameter>
<parameter>file</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>spawnid</parameter></term>
<listitem><para>Download <option>file</option> to the
process <symbol>spawnid</symbol> (the value returned
when the connection was established), using the
<command>~put</command> command under
<productname>tip</productname>. Most often used for
single board computers that require downloading
programs in ASCII S-records. Returns
<emphasis>1</emphasis> if an error occurs,
<emphasis>0</emphasis> otherwise.</para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>file</parameter></term>
<listitem><para>This is the filename to
download.</para></listitem>
</varlistentry>
</variablelist>
</sect4>
</sect3>
<sect3 id="targetprocs">
<title>Procedures For Target Boards</title>
<para></para>
<sect4 id="defaultlink" xreflabel="default_link procedure">
<title>Default_link Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>default_link</function></funcdef>
<paramdef><parameter>board</parameter>
<parameter>objects</parameter>
<parameter>destfile</parameter>
<parameter>flags</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>board</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>objects</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>destfile</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>flags</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="defaulttargetassemble" xreflabel="default_target_assemble
procedure">
<title>Default_target_assemble Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>default_target_assemble</function></funcdef>
<paramdef><parameter>source</parameter>
<parameter>destfile</parameter>
<parameter>flags</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>source</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>destfile</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>flags</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="defaulttargetcompile" xreflabel="default_target_compile
procedure">
<title>default_target_compile Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>default_target_compile</function></funcdef>
<paramdef><parameter>source</parameter>
<parameter>destfile</parameter>
<parameter>type</parameter>
<parameter>options</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>source</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>destfile</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>type</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>options</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="popconfig" xreflabel="pop_config procedure">
<title>Pop_config Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>pop_config</function></funcdef>
<paramdef><parameter>type</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>type</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="prunewarnings" xreflabel="prune_warnings procedure">
<title>Prune_warnings Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>prune_warnings</function></funcdef>
<paramdef><parameter>text</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>text</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="pushbuild" xreflabel="push_build procedure">
<title>Push_build Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>push_build</function></funcdef>
<paramdef><parameter>name</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>name</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="pushconfig" xreflabel="push_config procedure">
<title>push_config Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>push_config</function></funcdef>
<paramdef><parameter>type</parameter>
<parameter>name</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>type</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>name</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="reboottarget" xreflabel="reboot_target procedure">
<title>Reboot_target Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>reboot_target</function></funcdef>
<paramdef><parameter></parameter></paramdef>
</funcprototype>
</funcsynopsis>
</sect4>
<sect4 id="targetassemble" xreflabel="target_assemble procedure">
<title>Target_assemble Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>target_assemble</function></funcdef>
<paramdef><parameter>source destfile flags</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>source</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>destfile</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>flags</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="targetcompile" xreflabel="target_compile procedure">
<title>Target_compile Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>target_compile</function></funcdef>
<paramdef><parameter>source</parameter>
<parameter>destfile</parameter>
<parameter>type</parameter>
<parameter>options</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>source</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>destfile</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>type</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>options</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
</sect3>
<sect3 id="targetdb" xreflabel="target database library file ">
<title>Target Database Procedures</title>
<sect4 id="boardinfo" xreflabel="board_info procedure">
<title>Board_info Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>board_info</function></funcdef>
<paramdef><parameter>machine</parameter>
<parameter>op</parameter>
<parameter>args</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>machine</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>op</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>args</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="hostinfo" xreflabel="host_info procedure">
<title>Host_info Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>host_info</function></funcdef>
<paramdef><parameter>op</parameter>
<parameter>args</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>op</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>args</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="setboardinfo" xreflabel="set_board_info procedure">
<title>Set_board_info Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>set_board_info</function></funcdef>
<paramdef><parameter>entry</parameter>
<parameter>value</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>entry</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>value</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="setcurrtargetinfo" xreflabel="set_currtarget_info
procedure">
<title>Set_currtarget_info Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>set_currtarget_info</function></funcdef>
<paramdef><parameter>entry</parameter>
<parameter>value</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>entry</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>value</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="targetinfo" xreflabel="target_info procedure">
<title>Target_info Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>target_info</function></funcdef>
<paramdef><parameter>op</parameter>
<parameter>args</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>op</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>args</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="unsetboardinfo" xreflabel="unset_board_info procedure">
<title>Unset_board_info Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>unset_board_info</function></funcdef>
<paramdef><parameter>entry</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>entry</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="unsetcurrtargetinfo" xreflabel="unset_currtarget_info
procedure">
<title>Unset_currtarget_info Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>unset_currtarget_info</function></funcdef>
<paramdef><parameter>entry</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>entry</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="pushtarget" xreflabel="push_target procedure">
<title>Push_target Procedure</title>
<para>This makes the target named <emphasis>name</emphasis> be the
current target connection. The value of <emphasis>name</emphasis> is
an index into the <symbol>target_info</symbol> array and is set in
the global config file.</para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>push_target</function></funcdef>
<paramdef><parameter>name</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>name</parameter></term>
<listitem><para>The name of the target to make current
connection.</para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="poptarget" xreflabel="poptarget procedure">
<title>Pop_target Procedure</title>
<para>This unsets the current target connection.</para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>pop_target</function></funcdef>
<paramdef><parameter></parameter></paramdef>
</funcprototype>
</funcsynopsis>
</sect4>
<sect4 id="listtargets" xreflabel="list_targets procedure">
<title>List_targets Procedure</title>
<para>This lists all the supported targets for this
architecture.</para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>list_targets</function></funcdef>
<paramdef><parameter></parameter></paramdef>
</funcprototype>
</funcsynopsis>
</sect4>
<sect4 id="pushhost" xreflabel="push_host procedure">
<title>Push_host Procedure</title>
<para>This makes the host named <emphasis>name</emphasis> be the
current remote host connection. The value of
<emphasis>name</emphasis> is an index into the
<symbol>target_info</symbol> array and is set in the global config
file.</para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>push_host</function></funcdef>
<paramdef><parameter>name</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>name</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="pophost" xreflabel="pop_host procedure">
<title>Pop_host Procedure</title>
<para>This unsets the current host connection.</para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>pop_host</function></funcdef>
<paramdef><parameter></parameter></paramdef>
</funcprototype>
</funcsynopsis>
</sect4>
<sect4 id="compile" xreflabel="compile procedure">
<title>Compile Procedure</title>
<para>This invokes the compiler as set by CC to compile the
file <filename>file</filename>. The default options for many cross
compilation targets are <emphasis>guessed</emphasis> by &dj;, and
these options can be added to by passing in more parameters as
arguments to <command>compile</command>. Optionally, this will also
use the value of the <emphasis>cflags</emphasis> field in the target
config array. If the host is not the same as the build machines, then
then compiler is run on the remote host using
<command>execute_anywhere</command>.</para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>compile</function></funcdef>
<paramdef><parameter>file</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>file</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="archive" xreflabel="archive procedure">
<title>Archive Procedure</title>
<para>This produces an archive file. Any parameters passed to
<command>archive</command> are used in addition to the default
flags. Optionally, this will also use the value of the
<emphasis>arflags</emphasis> field in the target config array. If the
host is not the same as the build machines, then then archiver is run
on the remote host using <command>execute_anywhere</command>.</para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>archive</function></funcdef>
<paramdef><parameter>file</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>file</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="ranlib" xreflabel="ranlib procedure">
<title>Ranlib Procedure</title>
<para>This generates an index for the archive file for systems that
aren't POSIX yet. Any parameters passed to <command>ranlib</command>
are used in for the flags.</para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>ranlib</function></funcdef>
<paramdef><parameter>file</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>file</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="executeanywhere" xreflabel="execute_anywhere procedure">
<title>Execute_anywhere Procedure</title>
<para>This executes the <emphasis>cmdline</emphasis> on the proper
host. This should be used as a replacement for the Tcl command
<command>exec</command> as this version utilizes the target config
info to execute this command on the build machine or a remote
host. All config information for the remote host must be setup to
have this command work. If this is a canadian cross, (where we test a
cross compiler that runs on a different host then where &dj; is
running) then a connection is made to the remote host and the command
is executed there. It returns either REMOTERROR (for an error) or the
output produced when the command was executed. This is used for
running the tool to be tested, not a test case.</para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>execute_anywhere</function></funcdef>
<paramdef><parameter>cmdline</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>cmdline</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
</sect3>
<sect3 id="platformprocs" xreflabel="platform dependent procedures">
<title>Platform Dependent Procedures</title>
<para>Each combination of target and tool requires some
target-dependent procedures. The names of these procedures have
a common form: the tool name, followed by an underbar
<emphasis>_</emphasis>, and finally a suffix describing the
procedure's purpose. For example, a procedure to extract the
version from <productname>GDB</productname> is called
<symbol>gdb_version</symbol>.</para>
<para><command>runtest</command> itself calls only two of these
procedures, <symbol>${tool}_exit</symbol> and
<symbol>${tool}_version</symbol>; these procedures use no
arguments.</para>
<para>The other two procedures, <symbol>${tool}_start</symbol>
and <symbol>${tool}_load</symbol>}, are only called by the test
suites themselves (or by testsuite-specific initialization
code); they may take arguments or not, depending on the
conventions used within each testsuite.</para>
<para>The usual convention for return codes from any of these
procedures (although it is not required by
<command>runtest</command>) is to return <emphasis>0</emphasis>
if the procedure succeeded, <emphasis>1</emphasis> if it failed,
and <emphasis>-1</emphasis> if there was a communication error.</para>
<sect4 id="toolstart" xreflabel="${tool}_start procedure">
<title>${tool}_start Procedure</title>
<para>Starts a particular tool. For an interactive tool,
<function>${tool}_start</function> starts and initializes the
tool, leaving the tool up and running for the test cases; an
example is <function>gdb_start</function>, the start function
for GDB. For a batch oriented tool,
<function>${tool}_start</function> is optional; the recommended
convention is to let <function>${tool}_start</function> run the
tool, leaving the output in a variable called
<function>comp_output</function>. Test scripts can then analyze
<function>$comp_output</function> to determine the test results.
An example of this second kind of start function is
<function>gcc_start</function>, the start function for GCC.</para>
<para>&dj; itself does not call
<function>${tool}_start</function>. The initialization
module <function>${tool}_init.exp</function> must call
<function>${tool}_start</function> for interactive tools;
for batch-oriented tools, each individual test script calls
<function>${tool}_start</function> (or makes other
arrangements to run the tool).</para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>${tool}_start</function></funcdef>
<paramdef><parameter></parameter></paramdef>
</funcprototype>
</funcsynopsis>
</sect4>
<sect4 id="toolload" xreflabel="${tool}_load procedure">
<title>${tool}_load Procedure</title>
<para>Loads something into a tool. For an interactive tool,
this conditions the tool for a particular test case; for
example, <function>gdb_load</function> loads a new
executable file into the debugger. For batch oriented tools,
<function>${tool}_load</function> may do nothing---though,
for example, the GCC support uses
<function>gcc_load</function> to load and run a binary on
the target environment. Conventionally,
<function>${tool}_load</function> leaves the output of any
program it runs in a variable called
<symbol>$exec_output</symbol>. Writing
<function>${tool}_load</function> can be the most complex
part of extending &dj; to a new tool or a new target, if
it requires much communication coding or file
downloading. Test scripts call
<function>${tool}_load</function>.</para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>${tool}_load</function></funcdef>
<paramdef><parameter></parameter></paramdef>
</funcprototype>
</funcsynopsis>
</sect4>
<sect4 id="toolexit" xreflabel="${tool}_exit procedure">
<title>${tool}_exit Procedure</title>
<para>Cleans up (if necessary) before &dj; exits. For
interactive tools, this usually ends the interactive
session. You can also use <function>${tool}_exit</function>
to remove any temporary files left over from the
tests. <command>runtest</command> calls
<function>${tool}_exit</function>.</para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>${tool}_exit</function></funcdef>
<paramdef><parameter></parameter></paramdef>
</funcprototype>
</funcsynopsis>
</sect4>
<sect4 id="toolversion" xreflabel="${tool}_version procedure">
<title>${tool}_version Procedure</title>
<para>Prints the version label and number for
<symbol>${tool}</symbol>. This is called by the &dj;
procedure that prints the final summary report. The output
should consist of the full path name used for the tested
tool, and its version number.</para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>${tool}_version</function></funcdef>
<paramdef><parameter></parameter></paramdef>
</funcprototype>
</funcsynopsis>
</sect4>
</sect3>
<sect3 id="utilprocs">
<title>Utility Procedures</title>
<sect4 id="getdirs" xreflabel="getdirs procedure">
<title>Getdirs Procedure</title>
<para>Returns a list of all the directories in the single
directory a single directory that match an optional
pattern. </para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>getdirs</function></funcdef>
<paramdef><parameter>rootdir</parameter>
<parameter>pattern</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>args</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>pattern</parameter></term>
<listitem><para>If you do not specify
<parameter>pattern</parameter>,
<function>Getdirs</function> assumes a default pattern of
<emphasis>*</emphasis>. You may use the common shell
wildcard characters in the pattern. If no directories
match the pattern, then a NULL string is
returned.</para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="find" xreflabel="find procedure">
<title>Find Procedure</title>
<para>Search for files whose names match <emphasis>pattern</emphasis>
(using shell wildcard characters for filename expansion). Search
subdirectories recursively, starting at
<emphasis>rootdir</emphasis>. The result is the list of files whose
names match; if no files match, the result is empty. Filenames in the
result include all intervening subdirectory names. If no files match
the pattern, then a NULL string is returned.</para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>find</function></funcdef>
<paramdef><parameter>rootdir</parameter>
<parameter>pattern</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>rootdir</parameter></term>
<listitem><para>The top level directory to search the search
from.</para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>pattern</parameter></term>
<listitem><para>A csh "glob" style regular expression representing
the files to find.</para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="which" xreflabel="which procedure">
<title>Which Procedure</title>
<para>Searches the execution path for an executable file
<emphasis>binary</emphasis>, like the BSD <command>which</command>
utility. This procedure uses the shell environment variable
<emphasis>PATH</emphasis>. It returns <emphasis>0</emphasis> if the
binary is not in the path, or if there is no <emphasis>PATH</emphasis>
environment variable. If <command>binary</command> is in the path, it
returns the full path to <command>binary</command>.</para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>which</function></funcdef>
<paramdef><parameter>file</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>binary</parameter></term>
<listitem><para>The executable program or shell script to look
for.</para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="grep" xreflabel="grep procedure">
<title>Grep Procedure</title>
<para>Search the file called <filename>filename</filename> (a fully
specified path) for lines that contain a match for regular expression
<emphasis>regexp</emphasis>. The result is a list of all the lines that
match. If no lines match, the result is an empty string. Specify
<emphasis>regexp</emphasis> using the standard regular expression style
used by the Unix utility program grep.</para>
<para>Use the optional third argument <emphasis>line</emphasis> to
start lines in the result with the line number in
<filename>filename</filename>. (This argument is simply an option
flag; type it just as shown <option>--line</option>.)</para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>grep</function></funcdef>
<paramdef><parameter>filename</parameter>
<parameter>regexp</parameter>
<parameter>--line</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>filename</parameter></term>
<listitem><para>The file to search.</para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>regexp</parameter></term>
<listitem><para>The Unix style regular expression (as used by the
<command>grep</command> Unix utility) to search
for.</para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>--line</parameter></term>
<listitem><para>Prefix the line number to each line where the
regexp matches.</para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="prune" xreflabel="prune procedure">
<title>Prune Procedure</title>
<para>This procedure is deprecated and will be removed in
the next release of &dj;. If a testsuite uses this
procedure, a copy of the procedure should be made and placed
in the lib directory of the testsuite.</para>
</sect4>
<sect4 id="slay" xreflabel="slay procedure">
<title>Slay Procedure</title>
<para>This procedure is deprecated and will be removed in
the next release of &dj;. If a testsuite uses this
procedure, a copy of the procedure should be made and placed
in the lib directory of the testsuite.</para>
</sect4>
<sect4 id="absolute" xreflabel="absolute procedure">
<title>Absolute Procedure</title>
<para>This procedure is deprecated and will be removed in
the next release of &dj;. If a testsuite uses this
procedure, a copy of the procedure should be made and placed
in the lib directory of the testsuite.</para>
</sect4>
<sect4 id="psource" xreflabel="psource procedure">
<title>Psource Procedure</title>
<para>This procedure is deprecated and will be removed in
the next release of &dj;. If a testsuite uses this
procedure, a copy of the procedure should be made and placed
in the lib directory of the testsuite.</para>
</sect4>
<sect4 id="runtestfilep" xreflabel="runtest_file_p procedure">
<title>Runtest_file_p Procedure</title>
<para>Search <emphasis>runtest</emphasis>s for
<emphasis>testcase</emphasis> and return <emphasis>1</emphasis> if
found, <emphasis>0</emphasis> if not. <emphasis>runtests</emphasis>
is a list of two elements. The first is a copy of what was on
the right side of the <emphasis>=</emphasis> if
<programlisting>foo.exp="..."</programlisting>" was specified, or
an empty string if no such argument is present. The second is the
pathname of the current testcase under consideration. This is used
by tools like compilers where each testcase is a file.</para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>runtest_file_p</function></funcdef>
<paramdef><parameter>runtests</parameter>
<parameter>testcase</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>runtests</parameter></term>
<listitem><para>The list of patterns to compare against.
</para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>testcase</parameter></term>
<listitem><para>The test case filename.</para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="diff" xreflabel="diff procedure">
<title>Diff Procedure</title>
<para>Compares the two files and returns a <emphasis>1</emphasis> if
they match, or a <emphasis>0</emphasis> if they don't. If
<symbol>verbose</symbol> is set, then it'll print the differences to
the screen.</para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>diff</function></funcdef>
<paramdef><parameter>file_1</parameter>
<parameter>file_2</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>file_1</parameter></term>
<listitem><para>The first file to compare.</para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>file_2</parameter></term>
<listitem><para>The second file to compare.</para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="setenv" xreflabel="setenv procedure">
<title>Setenv Procedure</title>
<para>Sets the environment variable <emphasis>var</emphasis> to the
value <emphasis>val</emphasis>.</para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>setenv</function></funcdef>
<paramdef><parameter>var</parameter>
<parameter>val</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>var</parameter></term>
<listitem><para>The environment variable to set.</para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>val</parameter></term>
<listitem><para>The value to set the variable to.</para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="unsetenv" xreflabel="unsetenv procedure">
<title>unsetenv Procedure</title>
<para>Unsets the environment variable
<emphasis>var</emphasis>.</para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>unsetenv</function></funcdef>
<paramdef><parameter>var</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>var</parameter></term>
<listitem><para>The environment variable to
unset.</para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="getenv" xreflabel="getenv procedure">
<title>Getenv Procedure</title>
<para>Returns the value of <emphasis>var</emphasis> in the
environment if it exists, otherwise it returns NULL.</para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>getenv</function></funcdef>
<paramdef><parameter>var</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>var</parameter></term>
<listitem><para>The environment variable to get the value
of.</para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="prunesystemcrud" xreflabel="prune_system_crud procedure">
<title>Prune_system_crud Procedure</title>
<para>For system <emphasis>system</emphasis>, delete text the host or
target operating system might issue that will interfere with pattern
matching of program output in <emphasis>text</emphasis>. An example
is the message that is printed if a shared library is out of
date.</para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>prune_system_crud</function></funcdef>
<paramdef><parameter>system</parameter>
<parameter>test</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>system</parameter></term>
<listitem><para>The system error messages to look for to screen out
.</para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>text</parameter></term>
<listitem><para>The Tcl variable containing the
text.</para></listitem>
</varlistentry>
</variablelist>
</sect4>
</sect3>
<sect3 id="libgloss" xreflabel="Libgloss">
<title>Libgloss, A Free BSP</title>
<para>Libgloss is a free <firstterm>BSP</firstterm> (Board Support
Package) commonly used with GCC and G++ to produce a fully linked
executable image for an embedded systems.</para>
<sect4 id="libglosslinkflags" xreflabel="libgloss_link_flags procedure">
<title>Libgloss_link_flags Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>libgloss_link_flags</function></funcdef>
<paramdef><parameter>args</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>args</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="libglossincludeflags" xreflabel="libgloss_include_flags
procedure">
<title>Libgloss_include_flags Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>libgloss_include_flags</function></funcdef>
<paramdef><parameter>args</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>args</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="newliblinkflags" xreflabel="newlib_link_flags procedure">
<title>Newlib_link_flags Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>newlib_link_flags</function></funcdef>
<paramdef><parameter>args</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>args</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="newlibincludeflags" xreflabel="newlib_include_flags
procedure">
<title>Newlib_include_flags Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>newlib_include_flags</function></funcdef>
<paramdef><parameter>args</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>args</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="libioincludeflags" xreflabel="libio_include_flags
procedure">
<title>Libio_include_flags Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>libio_include_flags</function></funcdef>
<paramdef><parameter>args</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>args</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="libiolinkflags" xreflabel="libio_link_flags procedure">
<title>Libio_link_flags Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>libio_link_flags</function></funcdef>
<paramdef><parameter>args</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>args</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="gxxincludeflags" xreflabel="g++_include_flags procedure">
<title>G++_include_flags Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>g++_include_flags</function></funcdef>
<paramdef><parameter>args</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>args</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="gxxlinkflags" xreflabel="g++_link_flags procedure">
<title>G++_link_flags Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>g++_link_flags</function></funcdef>
<paramdef><parameter>args</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>args</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="libstdcxxincludeflags" xreflabel="libstdc++_include_flags
procedure">
<title>Libstdc++_include_flags Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>libstdc++_include_flags</function></funcdef>
<paramdef><parameter>args</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>args</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="libstdcxxlinkflags" xreflabel="libstdc++_link_flags
procedure">
<title>Libstdc++_link_flags Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>libstdc++_link_flags</function></funcdef>
<paramdef><parameter>args</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>args</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="getmultilibs" xreflabel="get_multilibs procedure">
<title>Get_multilibs Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>get_multilibs</function></funcdef>
<paramdef><parameter>args</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>args</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="findbinutilsprog" xreflabel="find_binutils_prog procedure">
<title>Find_binutils_prog Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>find_binutils_prog</function></funcdef>
<paramdef><parameter>name</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>name</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="findgcc" xreflabel="find_gcc procedure">
<title>Find_gcc Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>find_gcc</function></funcdef>
<paramdef><parameter></parameter></paramdef>
</funcprototype>
</funcsynopsis>
</sect4>
<sect4 id="findgcj" xreflabel="find_gcj procedure">
<title>Find_gcj Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>find_gcj</function></funcdef>
<paramdef><parameter></parameter></paramdef>
</funcprototype>
</funcsynopsis>
</sect4>
<sect4 id="findgxx" xreflabel="find_g++ procedure">
<title>Find_g++ Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>find_g++</function></funcdef>
<paramdef><parameter></parameter></paramdef>
</funcprototype>
</funcsynopsis>
</sect4>
<sect4 id="findg77" xreflabel="find_g77 procedure">
<title>Find_g77 Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>find_g77</function></funcdef>
<paramdef><parameter></parameter></paramdef>
</funcprototype>
</funcsynopsis>
</sect4>
<sect4 id="processmultiliboptions" xreflabel="process_multilib_options
procedure">
<title>Process_multilib_options Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>process_multilib_options</function></funcdef>
<paramdef><parameter>args</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>args</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="addmultiliboption" xreflabel="add_multilib_option
procedure">
<title>Add_multilib_option Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>add_multilib_option</function></funcdef>
<paramdef><parameter>args</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>args</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="findgas" xreflabel="find_gas procedure">
<title>Find_gas Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>find_gas</function></funcdef>
<paramdef><parameter></parameter></paramdef>
</funcprototype>
</funcsynopsis>
</sect4>
<sect4 id="findld" xreflabel="find_ld procedure">
<title>Find_ld Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>find_ld</function></funcdef>
<paramdef><parameter></parameter></paramdef>
</funcprototype>
</funcsynopsis>
</sect4>
<sect4 id="buildwrapper" xreflabel="build_wrapper procedure">
<title>Build_wrapper Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>build_wrapper</function></funcdef>
<paramdef><parameter>gluefile</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>gluefile</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="winsupincludeflags" xreflabel="winsup_include_flags
procedure">
<title>Winsup_include_flags Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>winsup_include_flags</function></funcdef>
<paramdef><parameter>args</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>args</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="winsuplinkflags" xreflabel="winsup_link_flags procedure">
<title>Winsup_link_flags Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>winsup_link_flags</function></funcdef>
<paramdef><parameter>args</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>args</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
</sect3>
<sect3 id="debugprocs" xreflabel="Debugging Procedures">
<title>Procedures for debugging your Tcl code.</title>
<para><filename>lib/debugger.exp</filename>defines these utility
procedures:</para>
<sect4 id="dumpvars" xreflabel="dumpvars procedure">
<title>Dumpvars Procedure</title>
<para>This takes a csh style regular expression (glob rules) and prints
the values of the global variable names that match. It is abbreviated
as <emphasis>dv</emphasis>.</para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>dumpvars</function></funcdef>
<paramdef><parameter>vars</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>vars</parameter></term>
<listitem><para>The variables to dump.</para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="dumplocals" xreflabel="dumplocals procedure">
<title>Dumplocals Procedure</title>
<para>This takes a csh style regular expression (glob rules) and
prints the values of the local variable names that match. It is
abbreviated as <emphasis>dl</emphasis>.</para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>dumplocals</function></funcdef>
<paramdef><parameter>args</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>args</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="dumprocs" xreflabel="dumprocs procedure">
<title>Dumprocs Procedure</title>
<para>This takes a csh style regular expression (glob rules) and
prints the body of all procs that match. It is abbreviated as
<emphasis>dp</emphasis>.</para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>dumprocs</function></funcdef>
<paramdef><parameter>pattern</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>pattern</parameter></term>
<listitem><para>The csh "glob" style pattern to look
for.</para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="dumpwatch" xreflabel="dumpwatch procedure">
<title>Dumpwatch Procedure</title>
<para>This takes a csh style regular expression (glob rules) and
prints all the watchpoints. It is abbreviated as
<emphasis>dw</emphasis>.</para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>dumpwatch</function></funcdef>
<paramdef><parameter>pattern</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>pattern</parameter></term>
<listitem><para>The csh "glob" style pattern to look
for.</para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="watcharray" xreflabel="watcharray procedure">
<title>Watcharray Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>watcharray</function></funcdef>
<paramdef><parameter>element</parameter>
<parameter>type</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>type</parameter></term>
<listitem><para>The csh "glob" style pattern to look
for.</para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="watchvar" xreflabel="watchvar procedure">
<title>Watchvar Procedure</title>
<para></para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>watchvar</function></funcdef>
<paramdef><parameter>var</parameter>
<parameter>type</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter></parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="watchunset" xreflabel="watchunset procedure">
<title>Watchunset Procedure</title>
<para>This breaks program execution when the variable
<symbol>var</symbol> is unset. It is abbreviated as
<emphasis>wu</emphasis>.</para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>watchunset</function></funcdef>
<paramdef><parameter>arg</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>args</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="watchwrite" xreflabel="watchwrite procedure">
<title>Watchwrite Procedure</title>
<para>This breaks program execution when the variable
<symbol>var</symbol> is written. It is abbreviated as
<emphasis>ww</emphasis>.</para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>watchwrite</function></funcdef>
<paramdef><parameter>var</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>var</parameter></term>
<listitem><para>The variable to watch.</para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="watchread" xreflabel="watchread procedure">
<title>Watchread Procedure</title>
<para>This breaks program execution when the variable
<symbol>var</symbol> is read. It is abbreviated as
<emphasis>wr</emphasis>.</para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>watchread</function></funcdef>
<paramdef><parameter>var</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>var</parameter></term>
<listitem><para>The variable to watch.</para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="watchdel" xreflabel="watchdel procedure">
<title>Watchdel Procedure</title>
<para>This deletes a watchpoint from the watch list. It is
abbreviated as <emphasis>wd</emphasis>.</para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>watchdel</function></funcdef>
<paramdef><parameter>args</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>args</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="print" xreflabel="print procedure">
<title>Print Procedure</title>
<para>This prints the value of the variable
<parameter>var</parameter>. It is abbreviated as
<emphasis>p</emphasis>.</para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>print</function></funcdef>
<paramdef><parameter>var</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter>var</parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
<sect4 id="quit" xreflabel="quit procedure">
<title>Quit Procedure</title>
<para>This makes runtest exit. It is abbreviated as
<emphasis>q</emphasis>.</para>
<funcsynopsis role="tcl">
<funcprototype>
<funcdef><function>quit</function></funcdef>
<paramdef><parameter></parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term><parameter></parameter></term>
<listitem><para></para></listitem>
</varlistentry>
</variablelist>
</sect4>
</sect3>
</sect2>
<sect2 id="filemap">
<title>File Map</title>
<para>This is a map of the files in &dj;.</para>
<itemizedlist>
<listitem><para>runtest</para></listitem>
<listitem><para>runtest.exp</para></listitem>
<listitem><para>stub-loader.c</para></listitem>
<listitem><para>testglue.c</para></listitem>
<listitem><para>config</para></listitem>
<listitem><para>baseboards</para></listitem>
<listitem><para>lib/debugger.exp</para></listitem>
<listitem><para>lib/dg.exp</para></listitem>
<listitem><para>lib/framework.exp</para></listitem>
<listitem><para>lib/ftp.exp</para></listitem>
<listitem><para>lib/kermit.exp</para></listitem>
<listitem><para>lib/libgloss.exp</para></listitem>
<listitem><para>lib/mondfe.exp</para></listitem>
<listitem><para>lib/remote.exp</para></listitem>
<listitem><para>lib/rlogin.exp</para></listitem>
<listitem><para>lib/rsh.exp</para></listitem>
<listitem><para>lib/standard.exp</para></listitem>
<listitem><para>lib/target.exp</para></listitem>
<listitem><para>lib/targetdb.exp</para></listitem>
<listitem><para>lib/telnet.exp</para></listitem>
<listitem><para>lib/tip.exp</para></listitem>
<listitem><para>lib/util-defs.exp</para></listitem>
<listitem><para>lib/utils.exp</para></listitem>
<listitem><para>lib/xsh.exp</para></listitem>
<listitem><para>lib/dejagnu.exp</para></listitem>
</itemizedlist>
</sect2>
</sect1>
<sect1 id="unittestapi" xreflabel="Unit Testing API">
<title>Unit Testing API</title>
<sect2 id="cunit" xreflabel="C Unit Testing API">
<title>C Unit Testing API</title>
<para>All of the functions that take a
<parameter>msg</parameter> parameter use a C char * that is
the message to be displayed. There currently is no support for
variable length arguments.</para>
<sect3 id="passfunc" xreflabel="pass function">
<title>Pass Function</title>
<para>This prints a message for a successful test
completion.</para>
<funcsynopsis role="C">
<funcprototype>
<funcdef><function>pass</function></funcdef>
<paramdef><parameter>msg</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</sect3>
<sect3 id="failfunc" xreflabel="fail function">
<title>Fail Function</title>
<para>This prints a message for an unsuccessful test
completion.</para>
<funcsynopsis role="C">
<funcprototype>
<funcdef><function>fail</function></funcdef>
<paramdef><parameter>msg</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</sect3>
<sect3 id="untestedfunc" xreflabel="untested function">
<title>Untested Function</title>
<para>This prints a message for an test case that isn't run
for some technical reason.</para>
<funcsynopsis role="C">
<funcprototype>
<funcdef><function>untested</function></funcdef>
<paramdef><parameter>msg</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</sect3>
<sect3 id="unresolvedfunc" xreflabel="unresolved function">
<title>Unresolved Function</title>
<para>This prints a message for an test case that is run,
but there is no clear result. These output states require a
human to look over the results to determine what happened.
</para>
<funcsynopsis role="C">
<funcprototype>
<funcdef><function>unresolved</function></funcdef>
<paramdef><parameter>msg</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</sect3>
<sect3 id="totalsfunc" xreflabel="totals function">
<title>Totals Function</title>
<para>This prints out the total numbers of all the test
state outputs.</para>
<funcsynopsis role="C">
<funcprototype>
<funcdef><function>totals</function></funcdef>
<paramdef><parameter></parameter></paramdef>
</funcprototype>
</funcsynopsis>
</sect3>
</sect2>
<sect2 id="cppunit" xreflabel="C++ Unit Testing API">
<title>C++ Unit Testing API</title>
<para>All of the methods that take a
<parameter>msg</parameter> parameter use a C char *
or STL string, that is the message to be
displayed. There currently is no support for variable
length arguments.</para>
<sect3 id="passmeth" xreflabel="pass method">
<title>Pass Method</title>
<para>This prints a message for a successful test
completion.</para>
<funcsynopsis role="C++">
<funcprototype>
<funcdef><function>TestState::pass</function></funcdef>
<paramdef><parameter>msg</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</sect3>
<sect3 id="failmeth" xreflabel="fail method">
<title>Fail Method</title>
<para>This prints a message for an unsuccessful test
completion.</para>
<funcsynopsis role="C++">
<funcprototype>
<funcdef><function>TestState::fail</function></funcdef>
<paramdef><parameter>msg</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</sect3>
<sect3 id="untestedmeth" xreflabel="untested method">
<title>Untested Method</title>
<para>This prints a message for an test case that isn't run
for some technical reason.</para>
<funcsynopsis role="C++">
<funcprototype>
<funcdef><function>TestState::untested</function></funcdef>
<paramdef><parameter>msg</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</sect3>
<sect3 id="unresolvedmeth" xreflabel="unresolved method">
<title>Unresolved Method</title>
<para>This prints a message for an test case that is run,
but there is no clear result. These output states require a
human to look over the results to determine what happened.
</para>
<funcsynopsis role="C++">
<funcprototype>
<funcdef><function>TestState::unresolved</function></funcdef>
<paramdef><parameter>msg</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</sect3>
<sect3 id="totalsmeth" xreflabel="totals method">
<title>Totals Method</title>
<para>This prints out the total numbers of all the test
state outputs.</para>
<funcsynopsis role="C++">
<funcprototype>
<funcdef><function>TestState::totals</function></funcdef>
<paramdef><parameter></parameter></paramdef>
</funcprototype>
</funcsynopsis>
</sect3>
</sect2>
</sect1>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-namecase-general:t
sgml-general-insert-case:lower
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:nil
sgml-parent-document:nil
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->
|