summaryrefslogtreecommitdiff
path: root/Build/source/doc/tlbuild.info
blob: 504a0fecd377157fe08d0732317bfd02a4cd41fd (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
5357
5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
5542
5543
5544
5545
5546
5547
5548
5549
5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
5560
5561
5562
5563
5564
5565
5566
5567
5568
5569
5570
5571
5572
5573
5574
5575
5576
5577
5578
5579
5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627
5628
5629
5630
5631
5632
5633
5634
5635
5636
5637
5638
5639
5640
5641
5642
5643
5644
5645
5646
5647
5648
5649
5650
5651
5652
5653
5654
5655
5656
5657
5658
5659
5660
5661
5662
5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
5673
5674
5675
5676
5677
5678
5679
5680
5681
5682
5683
5684
5685
5686
5687
5688
5689
5690
5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
5735
5736
5737
5738
5739
5740
5741
5742
5743
5744
5745
5746
5747
5748
5749
5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
5785
5786
5787
5788
5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
5814
5815
5816
5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
5827
5828
5829
5830
5831
5832
5833
5834
5835
5836
5837
5838
5839
5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
5885
5886
5887
5888
5889
5890
5891
5892
5893
5894
5895
5896
5897
5898
5899
5900
5901
5902
5903
5904
5905
5906
5907
5908
5909
5910
5911
5912
5913
5914
5915
5916
5917
5918
5919
5920
5921
5922
5923
5924
5925
5926
5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
5952
5953
5954
5955
5956
5957
5958
5959
This is tlbuild.info, produced by makeinfo version 6.5 from
tlbuild.texi.

This file documents the TeX Live build system and more.

Copyright (C) 2016-2019 Karl Berry.
Copyright (C) 2013-2015 Karl Berry & Peter Breitenlohner.

   Permission is granted to make and distribute verbatim copies of this
manual provided the copyright notice and this permission notice are
preserved on all copies.

   Permission is granted to copy and distribute modified versions of
this manual under the conditions for verbatim copying, provided that the
entire resulting derived work is distributed under the terms of a
permission notice identical to this one.

   Permission is granted to copy and distribute translations of this
manual into another language, under the above conditions for modified
versions, except that this permission notice may be stated in a
translation approved by the TeX Users Group.
INFO-DIR-SECTION TeX
START-INFO-DIR-ENTRY
* TLbuild: (tlbuild).           TeX Live configuration and development.
END-INFO-DIR-ENTRY

INFO-DIR-SECTION Individual utilities
START-INFO-DIR-ENTRY
* install-tl::                  Installing TeX Live.
* tlmgr::                       Managing TeX Live.
END-INFO-DIR-ENTRY


File: tlbuild.info,  Node: Top,  Next: Introduction,  Up: (dir)

Building TeX Live (2019)
************************

For an overview of this manual, *note Introduction::.

* Menu:

* Introduction::                About this manual.
* Overview of build system::    The TeX Live build system.
* Prerequisites::               Requirements for building TeX Live.
* Building::                    The overall build process.
* Installing::                  How and where installation happens (or not).
* Layout and infrastructure::   Autoconf macros, etc., in detail.
* Configure options::           List of all configure options.
* Coding conventions::          Conventions to follow.
* Continuous integration::      Automated build testing.
* install-tl::                  The TeX Live installer.
* tlmgr::                       The native TeX Live package manager.
* Index::                       General index.


File: tlbuild.info,  Node: Introduction,  Next: Overview of build system,  Prev: Top,  Up: Top

1 Introduction
**************

This manual (dated February 2019) corresponds to the TeX Live 2019
release.

   This manual is aimed at system installers and programmers, and
focuses on how to configure, build, and develop the TeX Live (TL)
sources.  It is also available as plain text files in the source tree:
'source/README.*'.

   The main 'source/README' file in the TL source tree provides
maximally-terse information for doing a build, and portability
information for different systems, along with
'source/doc/README.solaris'.

   For information on acquiring the TL sources, see
<https://tug.org/texlive/svn>.  The canonical source repository uses
Subversion, and we have no plans to change this.

   This manual does not duplicate the information found in other TL
documentation resources, such as:

   * The TeX Live web pages: <https://tug.org/texlive>.

   * The web page describing how to build the binaries which are
     distributed with TeX Live: <https://tug.org/texlive/build.html>.

   * The TeX Live user manual: <https://tug.org/texlive/doc.html>, or
     run 'texdoc texlive'.

   * Other TeX-related Texinfo manuals (*note (web2c)::, *note
     (kpathsea)::, etc.): <https://tug.org/texinfohtml/>, or check the
     'TeX' category in the GNU Info system.

   * Package documentation:
     <https://tug.org/texlive/Contents/live/doc.html>, or the 'doc.html'
     file at the top level of the installed TL.

   As an exception, the full documentation for 'install-tl' and 'tlmgr'
is included here as appendices, simply because it is easy to do so.  The
same text is available online (linked from
<https://tug.org/texlive/doc.html>, or by invoking the program with
'--help' (or look at the end of the source).


File: tlbuild.info,  Node: Overview of build system,  Next: Prerequisites,  Prev: Introduction,  Up: Top

2 Overview of build system
**************************

The TeX Live build system was redesigned in 2009 to consistently use
Autoconf, Automake, and Libtool.  Thus, running
   'configure && make && make check && make install'
or the essentially-equivalent top-level 'Build' script suffices to build
and install the TL programs.  The 'make check' clause performs various
tests of the generated programs--not strictly required but strongly
recommended.  Running 'configure --help' will display a comprehensive
list of all 'configure' options.

   The main components of the TL build system are:

'libs/LIB'
     Generic libraries.

'texk/LIB'
     TeX-specific libraries in subdirectories, notably LIB='kpathsea'.
     (The other one is 'texk/ptexenc'.)

'texk/PROG'
     TeX-specific programs (that use Kpathsea).

'utils/PROG'
     Other programs (that don't use Kpathsea).

   The primary design goal of the build system is modularity.  Each
program and library module (or package) specifies its own requirements
and properties, such as required libraries, whether an installed
(system) version of a library can be used, 'configure' options to be
seen at the top level, and more.  An explicit list of all available
modules is kept in a single central place: 'm4/kpse-pkgs.m4'.

   A second, related goal is to configure and build each library before
configuring any other (program or library) module which uses that
library.  This allows checking for properties and features of a library
built as part of the TL tree in much the same way as for a system
version of that library.

   All generic libraries and several programs are maintained
independently.  The corresponding modules use (most of) the distributed
source tree and document any modifications of that source.

   All this is for the sake of simplifying both upgrading of modules and
integrating new modules into the TL build system.  (Despite all efforts,
neither task is easy.)


File: tlbuild.info,  Node: Prerequisites,  Next: Building,  Prev: Overview of build system,  Up: Top

3 Prerequisites
***************

Overall, building the TeX Live programs, when using all libraries from
the TL source tree, requires C and C++11 compilers and GNU 'make'.  If
'make' from your 'PATH' is not GNU make, you can set the 'MAKE'
environment variable to whatever is necessary.

   GNU 'make' is required only because of some third-party libraries,
notably FreeType; all the TL-maintained directories (and
Automake/Autoconf output in general) work with any reasonable 'make'.

   A C++11 compiler is similarly required because of the third-party
libraries ICU and Poppler; the program 'dvisvgm' also requires C++11.
It is possible to build everything else with older compilers;
<https://tug.org/texlive/custom-bin.html> links to a build script for
doing this.

   However, a few programs in the tree have additional requirements:

'web2c'
     requires 'perl' for some tests run by 'make check'.

'xdvik'
'xpdfopen'
     require X11 headers and libraries, often in "development" packages
     that are not installed by default.

'xetex'
     requires 'fontconfig' (again both headers and library), or, for
     MacOSX only, the 'ApplicationServices' and 'Cocoa' frameworks.

'xindy'
     requires GNU 'clisp', 'libsigsegv', and 'libiconv'; additionally,
     to build the rules and/or documentation: 'perl', 'latex', and
     'pdflatex'

Lacking the required tools, building these programs must avoided, e.g.,
'configure --without-x --disable-xetex --disable-xindy'

   Modifying source files induces more requirements, as one might
expect:

   * Modification of any '.y' or '.l' source files requires 'bison' or
     'flex' to update the corresponding C sources.

   * Modification of the sources for '.info' files requires 'makeinfo'.

   * Modification of any part of the build system (M4 macros,
     'configure.ac', 'Makefile.am', or their fragments) requires GNU M4,
     GNU Autoconf, GNU Automake, and GNU Libtool to update the generated
     files.  Furthermore, to reliably reproduce the build files, the
     original GNU releases of these tools must be used, not any distro
     packaging of them.  *Note Build system tools::, for more
     discussion.

   If you haven't modified any source files, and infrastructure tools
such as 'autoconf' or 'makeinfo' are still being run, check your
timestamps--notably, 'use-commit-times' must be set to 'yes' in your
Subversion configuration (*note Build system tools::).  Barring buggy
commits, no infrastructure tools are needed to do a normal build.


File: tlbuild.info,  Node: Building,  Next: Installing,  Prev: Prerequisites,  Up: Top

4 Building
**********

The top-level 'Build' script is intended to simplify building the
binaries distributed with TeX Live itself--we call this the "native" TL
build.  It runs 'configure && make world', which builds everything in a
subdirectory of the main source tree (default 'Work/'), installs
everything in another subdirectory (default 'inst/'), and finally runs
'make check'.  The exact directory and command names can be specified
via environment variables and a few leading options.  All remaining
arguments (assignments or options) are passed to the 'configure' script.
Please take a look at the './Build' source file for more information; it
is a straightforward shell script.

   An alternative, and the one we will mainly discuss here, is to run
'configure' and 'make' in a suitable empty subdirectory.  Building in
the source directory itself is not supported (sorry).

* Menu:

* Build iteration::     What 'configure' and 'make' do in TL.
* Build problems::      If the build fails.
* Build in parallel::   Simultaneous 'make' processes.
* Build distribution::  Making a distribution tarball.
* Build one package::   Example of working on just one program.
* Build one engine::    Example of building just one TeX engine.
* Cross compilation::   Building on host X for target Y.


File: tlbuild.info,  Node: Build iteration,  Next: Build problems,  Up: Building

4.1 Build iteration
===================

Running the top-level 'configure' script configures the top level and
the subdirectories 'libs', 'utils', and 'texk'.  Running 'make' at the
top level first iterates over the TeX-specific libraries, and then runs
'make' in 'libs', 'utils', and 'texk' to iterate over the generic
libraries, utility programs, and TeX-specific programs, respectively.
These iterations consist of two steps:

  1. For each library or program module not yet configured, run
     'configure', adding the configure option '--disable-build' if the
     module need not be built, otherwise running 'make all'.

  2. For each library or program module that must be built, run 'make'
     for the selected target(s): 'default' or 'all' to (re-)build,
     'check' to run tests, 'install', etc.

   Running the top-level 'make' a second time iterates again over all
the library and program modules, and finds (should find) nothing to be
done.


File: tlbuild.info,  Node: Build problems,  Next: Build in parallel,  Prev: Build iteration,  Up: Building

4.2 Build problems
==================

If configuring or building a module fails, you should first try to find
and fix the problem.  Failing that, a possible workaround is to remove
the subdirectory for that module from the build tree (so 'configure'
won't try to run there, and finally rerun the top level 'make' (or
'./Build' '--no-clean').


File: tlbuild.info,  Node: Build in parallel,  Next: Build distribution,  Prev: Build problems,  Up: Building

4.3 Build in parallel
=====================

The TL build system carefully formulates dependencies as well as 'make'
rules when a tool (such as 'tangle', 'ctangle', and 'convert') creates
several output files.  This allows for parallel builds ('make -j N' with
N>1 or even 'make -j') that can considerably speed up the TL build.

   Incidentally, a noticeable speed-up can be independently gained by
using a configure cache file, i.e., specifying the 'configure' option
'-C' (recommended).


File: tlbuild.info,  Node: Build distribution,  Next: Build one package,  Prev: Build in parallel,  Up: Building

4.4 Build distribution
======================

Running 'make dist' at the top level creates a tarball
'tex-live-YYYY-MM-DD.tar.xz' from the TL source tree.  Running 'make
distcheck' also verifies that this tarball suffices to build and install
all of TL.

   This is useful for checking consistency of the source tree and
Makefiles, but the result is not a complete or even usable TeX system,
since all the support files are lacking; *note Installing::.  We do not
actually distribute any such tarball, and have no plans to do so.


File: tlbuild.info,  Node: Build one package,  Next: Build one engine,  Prev: Build distribution,  Up: Building

4.5 Build one package
=====================

To build one package, the basic idea is to use the 'configure' option
'--disable-all-pkgs' (*note --disable-all-pkgs::).  Then all program and
library modules are configured but none are made.  However, the
'Makefile's still contain all build rules and dependencies and can be
invoked to build an individual program or library, first building any
required libraries.

   This "build-on-demand" procedure is used, e.g., in the upstream
LuaTeX repository to build LuaTeX, from a subset of the complete
TeX Live source tree.  As another example, when building the original
e-TeX has been disabled (as it is by default), one can run 'make etex'
(or 'make etex.exe') in 'texk/web2c/' to build e-TeX (although there is
no comparably simple way to _install_ e-TeX).

   If you want to work on a single program within the TL sources, this
is the recommended way to do it.  Here is an example from start to
finish for working on 'dvipdfm-x'.

     mkdir mydir && cd mydir  # new working directory

     # Get sources (<https://tug.org/texlive/svn>), e.g.:
     rsync -a --delete --exclude=.svn --exclude=Work \
           tug.org::tldevsrc/Build/source/ .

     # Create build directory:
     mkdir Work && cd Work

     # Do the configure:
     ../configure --disable-all-pkgs --enable-dvipdfm-x \
       -C CFLAGS=-g CXXFLAGS=-g >&outc || echo fail

     # Do the make:
     make >&outm || echo fail

     # Test:
     cd texk/dvipdfm-x
     make check

   Then you can modify source files in 'mydir/texk/dvipdfm-x' and rerun
'make' in 'mydir/Work/texk/dvipdfm-x' to rebuild; that build directory
is where the binary ends up and where you can run a debugger, etc.

   The second line of the 'configure' invocation shows examples of extra
things you likely want to specify if you intend to hack the sources (and
not just build binaries): the '-C' speeds 'configure' by enabling a
cache file, and the 'CFLAGS' and 'CXXFLAGS' settings eliminate compiler
optimization for debugging purposes.

   Of course, you need to actually look at the output and check that
things are working.  There are many 'configure' options you can tweak as
desired; check the output from 'configure --help'.  It is also a good
idea to run 'make check' after making any changes, to ensure that
whatever tests have been written still pass.

   Finally, the above retrieves the entire TL source tree (several
hundred megabytes).  It is natural to ask if this is really necessary.
Strictly speaking, the answer is no, but it is vastly more convenient to
do so.  If you cut down the source tree, you must also give additional
'configure' flags to individually disable using system versions of
libraries, or the intricacies of the dependencies (such as 'teckit'
requiring 'zlib') will have undesired side effects.  For an example of
this approach, see the 'build-pdftex.sh' script in the 'pdftex'
development source (details at <http://pdftex.org>), which is indeed
such a cut-down TL source tree.

   Even with '--disable-all-pkgs', dependencies will be checked.  For
instance, if a (non-MacOSX) system does not have 'fontconfig', XeTeX
cannot be built (*note Prerequisites::) and 'configure' will terminate.
To proceed without such dependencies, specify '--enable-missing' also.

   By default, the 'gcc' compilers will be used if present; otherwise,
individual packages may use something different.  You can explicitly
specify the compilers to be used with the environment variables 'CC',
'CXX', and 'OBJCXX'.


File: tlbuild.info,  Node: Build one engine,  Next: Cross compilation,  Prev: Build one package,  Up: Building

4.6 Build one engine
====================

Unfortunately, there is one common case where the steps in the preceding
section to build one package (*note Build one package::) do not suffice:
wanting to build one, or a subset, of the TeX engines (or other Web2c
programs).

   The simplest way to do this is to disable everything and then
explicitly specify what to make.  For example, to build only LuaTeX:

     ./configure --disable-all-pkgs  # or ./Build
     cd Work/texk/web2c              # build directory
     make luatex                     # specify target

   This works because the 'make' automatically runs 'configure' as
necessary for the dependencies and target.  Furthermore, the source tree
can be cut down to just what is needed for the given engine (as the
separate pdfTeX and LuaTeX source repositories do).

   We hope to improve the situation in the future.  Patches are welcome.


File: tlbuild.info,  Node: Cross compilation,  Prev: Build one engine,  Up: Building

4.7 Cross compilation
=====================

In a cross compilation a "build" system is used to create binaries to be
executed on a "host" system with different hardware and/or operating
system.

   In simple cases, the build system can execute binaries for the host
system.  This typically occurs for bi-arch systems where, e.g.,
'i386-linux' binaries can run on 'x86_64-linux' systems and 'win32'
binaries can run on 'win64' systems.  Although sometimes called "native
cross", technically this is not cross compilation at all.  In most such
cases it suffices to specify suitable compiler flags.  It might be
useful to add the configure option '--build=HOST' to get the correct
canonical host name, but note that this should _not_ be '--host=HOST'
(*note (autoconf)Hosts and Cross-Compilation::).

   In order to build, e.g., 32-bit binaries with 'clang' on a 64-bit
MacOSX system one could use:

     TL_BUILD_ENV="CC='clang -arch i386' \
       CXX='clang++ -arch i386' \
       OBJCXX='clang++ -arch i386'" \
       ./Build --build=i386-apple-darwin

* Menu:

* Cross configuring::           Configuring for cross compilation.
* Cross problems::              Cross compilation problems.


File: tlbuild.info,  Node: Cross configuring,  Next: Cross problems,  Up: Cross compilation

4.7.1 Cross configuring
-----------------------

In a standard cross compilation, binaries for the host system cannot
execute on the build system and it is necessary to specify the configure
options '--host=HOST' and '--build=BUILD' with two different values.

   Building binaries requires suitable "cross" tools, e.g., compiler,
linker, and archiver, and perhaps a "cross" version of 'pkg-config' and
similar to locate host system libraries.  Autoconf expects that these
cross tools are given by their usual variables or found under their
usual name prefixed with 'HOST-'.  Here a list of such tools and
corresponding variables:

     ar                AR
     freetype-config   FT2_CONFIG
     g++               CXX
     gcc               CC
     icu-config        ICU_CONFIG
     objdump           OBJDUMP
     pkg-config        PKG_CONFIG
     ranlib            RANLIB
     strip             STRIP

In order to, e.g., build 'mingw32' binaries on 'x86_64-linux' with a
cross compiler found as 'i386-pc-mingw32-gcc' one would specify

     --host=i386-pc-mingw32 --build=x86_64-linux-gnu

or perhaps

     --host=mingw32 --build=x86_64-linux CC=i386-pc-mingw32-gcc

but this latter, especially, might require adding 'CXX' and others.

   Configure arguments such as 'CFLAGS=...' refer to the cross compiler.
If necessary, you can specify compilers and flags for the few auxiliary
C and C++ programs required for the build process as configure arguments

     BUILDCC=...
     BUILDCPPFLAGS=...
     BUILDCFLAGS=...
     BUILDCXX=...
     BUILDCXXFLAGS=...
     BUILDLDFLAGS=...


File: tlbuild.info,  Node: Cross problems,  Prev: Cross configuring,  Up: Cross compilation

4.7.2 Cross problems
--------------------

The fact that binaries for the host system cannot be executed on the
build system causes some problems.

   One problem is that configure tests using 'AC_RUN_IFELSE' can compile
and link the test program but cannot execute it.  Such tests should be
avoided if possible and otherwise must supply a pessimistic test result.

   Another problem arises if the build process must execute some
(auxiliary or installable) programs.  Auxiliary programs can be placed
into a subdirectory that is configured natively as is done for
'texk/web2c/web2c', 'texk/dvipsk/squeeze', and 'texk/xdvik/squeeze'.
The module 'libs/freetype2' uses the value of 'CC_BUILD', 'BUILD-gcc',
'gcc', or 'cc' as the compiler for the auxiliary program.

   The situation for installable programs needed by the build process is
somewhat different.  A rather expensive possibility, chosen for the ICU
libraries in module 'libs/icu', is to first compile natively for the
build system and in a second step to use these (uninstalled) programs
during the cross compilation.

   This approach would also be possible for the tools such as 'tangle'
used in the module 'texk/web2c' to build the WEB programs, but that
would require first building a native 'kpathsea' library.  To avoid this
complication, cross compilation of programs written in (C)WEB requires
sufficiently recent installed versions of 'tangle', 'ctangle',
'otangle', and 'tie'.

   Building 'xindy' requires running the host system 'clisp' binary,
thus cross compilation is painful, but possible.


File: tlbuild.info,  Node: Installing,  Next: Layout and infrastructure,  Prev: Building,  Up: Top

5 Installing
************

This section discusses the results of 'make install' in the source tree.

   The main consideration is that 'make install' is not enough to make a
usable TeX installation.  Beyond the compiled binaries, (thousands of)
support files are needed; just as a first example, 'plain.tex' is not in
the source tree.

   These support files are maintained completely independently and are
not present in the TL source tree.  The best basis for dealing with them
is the TeX Live (plain text) database in 'Master/tlpkg/texlive.tlpdb',
and/or the TeX Live installer, 'install-tl'.  More information is under
'Master/tlpkg' and at <https://tug.org/texlive/distro.html>.

* Menu:

* Installation directories::    The prefix, 'bindir', etc., directories.
* Linked scripts::              Scripts not maintained in the sources.
* Distro builds::               Configuring and building for OS distributions.


File: tlbuild.info,  Node: Installation directories,  Next: Linked scripts,  Up: Installing

5.1 Installation directories
============================

Running 'make install' (or 'make install-strip') installs executables in
'BINDIR', libraries in 'LIBDIR', headers in 'INCLUDEDIR', general data
(including "linked scripts", *note Linked scripts::) in
'DATAROOTDIR/texmf-dist', man pages in 'MANDIR', and Info files in
'INFODIR'.

   The values of these directories are determined by 'configure' and can
be specified explicitly as options such as '--prefix=PREFIX' or
'--bindir=BINDIR'; otherwise, they are given by their usual Autoconf
defaults:

     PREFIX                  /usr/local
     EXEC_PREFIX             PREFIX
     BINDIR                  EXEC_PREFIX/bin
     LIBDIR                  EXEC_PREFIX/lib
     INCLUDEDIR              PREFIX/include
     DATAROOTDIR             PREFIX/share
     MANDIR                  DATAROOTDIR/man
     INFODIR                 DATAROOTDIR/info

except possibly modified as follows:

   * If the option '--enable-multiplatform' is given, '/PLATFORM' (i.e.,
     the canonical platform name) is appended to 'BINDIR' and 'LIBDIR'.
     This is implied for a native TL build.

   * In a native TL build, 'DATAROOTDIR' is set to 'PREFIX', 'INFODIR'
     is set to 'PREFIX/texmf-dist/doc/info', and 'MANDIR' to
     'PREFIX/texmf-dist/doc/man', corresponding to the directories used
     in the TL distribution.

The top-level 'configure' script displays all these installation paths.

   For the native TL build, the 'Build' script leaves the binaries in
'./inst/bin/STD-SYSTEM-TRIPLET'.  The new binaries are not directly
usable from that location; they need to be copied to
'Master/bin/TL-PLATFORM'.  The other files and directories that end up
in './inst/' are ignored.


File: tlbuild.info,  Node: Linked scripts,  Next: Distro builds,  Prev: Installation directories,  Up: Installing

5.2 Linked scripts
==================

Quite a few executables are architecture-independent shell, Perl, or
other interpreted scripts, rather than compiled binaries.  A few are
maintained as part of the TL source tree, but most are maintained
elsewhere with copies under 'texk/texlive/linked_scripts'.

   These so-called "linked scripts" are installed under
'DATAROOTDIR/texmf-dist/scripts'; for Unix-like systems a symbolic link
is made in 'BINDIR'.  For example, a symlink points from 'BINDIR/ps2eps'
to 'DATAROOTDIR/texmf-dist/scripts/ps2eps/ps2eps.pl'.  For Windows, a
standard wrapper binary (copied to, e.g., 'BINDIR/ps2eps.exe') serves
the same purpose.  The source for the wrapper is in
'texk/texlive/w32_wrapper'.

   One reason for this is to avoid having many copies of the same
script; a more important reason is that it guarantees the scripts will
stay in sync across the different supported operating systems.

   Most important of all, we want the 'BINDIR' resulting from the build
to be as close as possible to what is in the TL distribution.  At
present, there are a few exceptions--Asymptote, Biber, Xindy--and each
one creates considerable extra work.  We don't want to add more.  (See
<https://tug.org/texlive/build.html> for information about building
those exceptions, as well as the 'xz' and 'wget' programs that are used
in the TL infrastructure.)


File: tlbuild.info,  Node: Distro builds,  Prev: Linked scripts,  Up: Installing

5.3 Distro builds
=================

Although they use the same code base, building for the native TL
distribution as shipped by the TeX user groups is typically quite
different from a "distro" build needed by, e.g., a full GNU/Linux or BSD
operating system distribution.

   The native TL distribution uses shared libraries only when absolutely
necessary ('libc', 'libm', X11 libraries, and 'libfontconfig').  In
contrast, a distro typically wants to use as many shared libraries as
possible from elsewhere on the system, including TeX-specific libraries
such as 'libkpathsea' (even though Kpathsea has never officially been
released as a shared library).  In addition, the installation paths
will, in general, be completely different.

   Here are the 'configure' options that distro builds are likely to
find most relevant:

'--disable-native-texlive-build'
     This must be specified to avoid interference from the many tweaks
     we do for the native TL build.

'--with-banner-add=/SOMEDISTRO'
     This isn't technically required, but is strongly recommended, so
     your build and your distro can be distinguished from others.

'--enable-shared'
     Build shared versions of the TeX-specific libraries (uses
     'libtool').

'--disable-static'
     Do not build the static versions of the TeX-specific libraries.

'--with-system-LIB'
     Look for and use a system version of the library LIB.  'configure
     --help' will give you the list of possibilities.

'--with-LIB-includes=DIR'
'--with-LIB-libdir=DIR'
     If needed, allows you to specify where the headers/code are for the
     given library LIB.

'--prefix=/usr'
'--prefix=/opt/TeXLive'
     Or whatever your convention is.  The default is '/usr/local' and
     you shouldn't install there for a distro.

'--libdir=\${exec_prefix}/lib64'
     May be needed for 64-bit bi-architecture (GNU/Linux) systems.

   You will need to take care of the support files mentioned above
(*note Installing::), and many other issues, such as font maps,
languages, and formats, independently of the build.  Norbert Preining
has written a detailed article on adapting TL for distros:
<https://tug.org/TUGboat/tb34-3/tb108preining-distro.pdf>.  (If the
article needs updating in the future, perhaps we will merge it into this
document.)


File: tlbuild.info,  Node: Layout and infrastructure,  Next: Configure options,  Prev: Installing,  Up: Top

6 Layout and infrastructure
***************************

The TeX Live source tree is the subtree rooted at 'Build/source' of the
complete TL distribution and contains the sources for all executables
distributed by TL, as well as 'configure' scripts and 'make' rules to
build and install them together with some of their support files.

* Menu:

* Build system tools::      Modifying infrastructure files.
* Top-level directories::   libs texk utils; am auxdir build-aux m4; doc extra.
* Autoconf macros::         TL-specific Autoconf macros.
* Library modules::         Handling libraries, with examples.
* Program modules::         Handling programs, with examples.
* Extending TeX Live::         Adding a new module.


File: tlbuild.info,  Node: Build system tools,  Next: Top-level directories,  Up: Layout and infrastructure

6.1 Build system tools
======================

As mentioned above (*note Prerequisites::), a normal build has few
requirements.  On the other hand, if you want to modify the TeX Live
infrastructure sources, such as 'configure.ac' or 'Makefile.am' files,
you will need to have several additional tools installed.

   In general, the TL build system uses the latest released versions of
the GNU build tools, installed directly from the original GNU releases
(e.g., by building them with 'configure --prefix=/usr/local/gnu' and
having 'PATH' start with '/usr/local/gnu/bin').  We have found that
trying to use the versions of these tools packaged for distros causes
many extra hassles, so don't do that, tempting as it may be.

   Currently the versions we use are:

     autoconf (GNU Autoconf) 2.69
     automake (GNU automake) 1.16.1
     bison (GNU Bison) 3.3.1
     flex 2.6.0
     ltmain.sh (GNU libtool) 2.4.6
     m4 (GNU M4) 1.4.18
     makeinfo (GNU texinfo) 6.5

   These versions should be used to update the generated files (e.g.,
'configure' or 'Makefile.in') in all or parts of the TL tree after their
dependencies have been changed.  This can be done explicitly with the
top-level 'reautoconf' script or implicitly by using the configure
option '--enable-maintainer-mode'.

   It has often turned out that the bison and flex versions are not
critical; however, the autotools versions are.  If you don't have the
given versions, get them before modifying the build infrastructure.

   The files in the Subversion repository (see
<https://tug.org/texlive/svn>) are all up to date (barring bugs).  For
this to be reflected by their timestamps in your checkout, be sure to
set 'use-commit-times=yes' in '~/.subversion/config' or the equivalent.

   If timestamps are wrong, you may also be able to avoid unnecessary
runs of 'bison', 'flex', or 'makeinfo' with 'touch' of the generated
('.c', '.h', or '.info') files.  With '--enable-maintainer-mode' it may
also be necessary to 'touch' first 'aclocal.m4', then 'configure' and
'config.h.in' (or 'c-auto.in'), and finally all 'Makefile.in' files.
Perhaps 'make -t' will help.


File: tlbuild.info,  Node: Top-level directories,  Next: Autoconf macros,  Prev: Build system tools,  Up: Layout and infrastructure

6.2 Top-level directories
=========================

Here is a brief description of the top-level directories in the TeX Live
source tree.

   As mentioned at the beginning of *note Overview of build system::,
the main source directories are 'texk/' (TeX-specific programs and
libraries), 'utils/' (additional programs), and 'libs/' (generic
libraries).

   In addition, the top-level directories 'am/' and 'm4/' contain
'Makefile.am' fragments and Autoconf macros, respectively, used in many
places.  Specifically, the file 'm4/kpse-pkgs.m4' contains lists of all
program and library modules; missing modules are silently ignored.
(This helps in creating cut-down source trees.)

   Each module contributes fragments (in separate files) defining its
capabilities and requirements to the 'configure.ac' scripts at the
top-level and in the subdirectories 'libs', 'utils', and 'texk'.  The
fragments from program modules supply 'configure' options to disable or
enable building them; those from library modules specify if an installed
(system) version of that library can be used.  This ultimately
determines which modules need to be built--although all modules must be
configured for the benefit of 'make' targets such as 'dist' or
'distcheck'.

   The top-level 'build-aux/' directory contains the common files
'compile', 'config.guess', 'config.sub', 'depcomp', etc. used by most
packages.  These are taken from the GNU Gnulib sources
(<https://www.gnu.org/software/gnulib>), which in turn synchronizes with
any ultimate upstream repository.  There are independent copies of some
of these in a few other places, e.g.,
'libs/freetype2/freetype-*/builds/unix/'.  The 'reautoconf' script does
not touch those, but a TL cron job keeps them in sync (nightly).

   When the top-level './Build' script is used to build TL, two more two
more top-level directories appear: 'Work/' for the build tree, and
'inst/' for the install tree (from 'make install').  These names (and
everything else about 'Build''s operation) can be changed by setting
environment variables before running it; see the script source.


File: tlbuild.info,  Node: Autoconf macros,  Next: Library modules,  Prev: Top-level directories,  Up: Layout and infrastructure

6.3 Autoconf macros
===================

Here we describe a few of the Autoconf macros used in several
modules--many more are defined in the sources; see the top-level 'm4/'
directory.  These general macros are supplemented by module-specific
macros in directories such as 'texk/dvipng/m4/'; some of those are
described in following sections (*note Library modules:: and *note
Program modules::).

* Menu:

* Setup:     General setup macros.
* Programs:  Macros for programs.
* Compilers: Macros for compilers.
* Libraries: Macros for libraries.
* Flags:     Macros for library and header flags.
* Windows:   Macros for Windows.


File: tlbuild.info,  Node: General setup macros,  Next: Macros for programs,  Up: Autoconf macros

6.3.1 General setup macros
--------------------------

The TL sources use two general setup macros:

 -- Macro: KPSE_BASIC (NAME, [MORE-OPTIONS])
     Initialize the basic TL infrastructure for module NAME:
        'AM_INIT_AUTOMAKE([foreign MORE-OPTIONS])'
        'AM_MAINTAINER_MODE'
        'KPSE_COMPILER_WARNINGS'
     and make sure the C compiler understands function prototypes.  This
     is used for all generic library and program modules.

 -- Macro: KPSE_COMMON (NAME, [MORE-OPTIONS])
     Like 'KPSE_BASIC' but add:
        'LT_PREREQ([2.2.6])'
        'LT_INIT([win32-dll])'
        'AC_SYS_LARGEFILE'
        'AC_FUNC_FSEEKO'
     along with checks for frequently used functions, headers, types,
     and structures.  This is used for TeX-specific modules.


File: tlbuild.info,  Node: Macros for programs,  Next: Macros for compilers,  Prev: General setup macros,  Up: Autoconf macros

6.3.2 Macros for programs
-------------------------

Macros for program checks:

 -- Macro: KPSE_CHECK_LATEX
     Set 'LATEX' to the first of 'latex', 'elatex', or 'lambda' which
     exists in 'PATH', or to 'no' if none of them exists.  Call
     'AC_SUBST' for 'LATEX'.  The result of this test can be overridden
     by setting the 'LATEX' environment variable or the cache variable
     'ac_cv_prog_LATEX'.

 -- Macro: KPSE_CHECK_PDFLATEX
     Check for 'pdflatex' in 'PATH' and set 'PDFLATEX'.

 -- Macro: KPSE_CHECK_PERL
     Check for 'perl' or 'perl5' in 'PATH' and set 'PERL'.

 -- Macro: KPSE_PROG_LEX
     Call 'AC_PROG_LEX' and add the flag '-l' for 'flex'.


File: tlbuild.info,  Node: Macros for compilers,  Next: Macros for libraries,  Prev: Macros for programs,  Up: Autoconf macros

6.3.3 Macros for compilers
--------------------------

Macros for compiler-related checks:

 -- Macro: KPSE_COMPILER_WARNINGS
     When using the (Objective) C/C++ compiler, set
     'WARNING_[OBJ]C[XX]FLAGS' to suitable warning flags (depending on
     the value given to or implied for '--enable-compiler-warnings').
     Call 'AC_SUBST' for them.  At present this assumes GNU compiler
     warning options, but could be extended to others if necessary.

     This macro caches its results in the 'kpse_cv_warning_cflags', ...
     variables.

 -- Macro: KPSE_COMPILER_VISIBILITY
     When using the C or C++ compiler, try to set
     'VISIBILITY_C[XX]FLAGS' to flags to hide external symbols.  Call
     'AC_SUBST' for this variable.  At present this only tests for the
     compiler option '-fvisibility=hidden', but could be extended if
     necessary.

     This macro caches its results in the 'kpse_cv_visibility_cflags' or
     'kpse_cv_visibility_cxxflags' variable.

 -- Macro: KPSE_CXX_HACK
     Provide the configure option '--enable-cxx-runtime-hack'.  If
     enabled and when using 'g++', try to statically link with
     'libstdc++', notably improving portability of the resulting binary.

     This macro caches its result in the 'kpse_cv_cxx_hack' variable.


File: tlbuild.info,  Node: Macros for libraries,  Next: Macros for library and header flags,  Prev: Macros for compilers,  Up: Autoconf macros

6.3.4 Macros for libraries
--------------------------

One macro for a library check:

 -- Macro: KPSE_LARGEFILE (VARIABLE, [EXTRA-DEFINE])
     Call 'AC_SYS_LARGEFILE' and 'AC_FUNC_FSEEKO' and append suitable
     '-D' flags (optionally including '-DEXTRA-DEFINE') to VARIABLE.


File: tlbuild.info,  Node: Macros for library and header flags,  Next: Macros for Windows,  Prev: Macros for libraries,  Up: Autoconf macros

6.3.5 Macros for library and header flags
-----------------------------------------

Each library module 'libs/LIB' or 'texk/LIB' is supplemented by a macro
'KPSE_LIB_FLAGS' (all uppercase) that provides make variables for that
library.  E.g., for 'libs/libpng':

 -- Macro: KPSE_LIBPNG_FLAGS
     Provide the configure option '--with-system-libpng'.  Set and
     'AC_SUBST' 'make' variables for modules using this library (either
     an installed version or from the TeX Live tree):

     'LIBPNG_INCLUDES'   for use in 'CPPFLAGS',
     'LIBPNG_LIBS'       for use in 'LDADD',
     'LIBPNG_DEPEND'     for use as a Makefile dependency,
     'LIBPNG_RULE'       for the 'make' rules to rebuild the library.

 -- Macro: KPSE_ADD_FLAGS (NAME)
     Temporarily extend 'CPPFLAGS' and 'LIBS' with the values required
     for the library module 'NAME'.

 -- Macro: KPSE_RESTORE_FLAGS
     Restore 'CPPFLAGS' and 'LIBS' to their original values.

   As an example, the 'configure.ac' file for a hypothetical program
'utils/foo' using 'libpng', and hence 'zlib', would contain
     KPSE_ZLIB_FLAGS
     KPSE_LIBPNG_FLAGS

and its 'Makefile.am' would be along these lines:
     bin_PROGRAMS = foo
     AM_CPPFLAGS = ${LIBPNG_INCLUDES} ${ZLIB_INCLUDES}
     foo_LDADD = ${LIBPNG_LIBS} ${ZLIB_LIBS}
     foo_DEPENDENCIES = ${ZLIB_DEPEND} ${LIBPNG_DEPEND}
     ## Rebuild libz
     @ZLIB_RULE@
     ## Rebuild libpng
     @LIBPNG_RULE@

   If it were necessary to examine whether certain 'zlib' or 'libpng'
features were available, 'configure.ac' should be continued this way:
     KPSE_ADD_FLAGS([zlib])
     ... # tests for 'zlib' features, if any
     KPSE_ADD_FLAGS([libpng])
     ... # tests for 'libpng' features
     KPSE_RESTORE_FLAGS # restore 'CPPFLAGS' and 'LIBS'


File: tlbuild.info,  Node: Macros for Windows,  Prev: Macros for library and header flags,  Up: Autoconf macros

6.3.6 Macros for Windows
------------------------

Windows differs in several aspects from Unix-like systems, many of them
due to the lack of symbolic links.

 -- Macro: KPSE_CHECK_WIN32
     Check if compiling for a Windows system.  The result is either 'no'
     for Unix-like systems (including Cygwin), 'mingw32' for Windows
     with GCC, or 'native' for Windows with MSVC. The result is cached
     in the 'kpse_cv_have_win32' variable.

 -- Macro: KPSE_COND_WIN32
     Call 'KPSE_CHECK_WIN32' and define the Automake conditional 'WIN32'
     ('true' if the value of 'kpse_cv_have_win32' is not 'no').

 -- Macro: KPSE_COND_MINGW32
     Call 'KPSE_COND_WIN32' and define the Automake conditional
     'MINGW32' ('true' if the value of 'kpse_cv_have_win32' is
     'mingw32').

 -- Macro: KPSE_COND_WIN32_WRAP
     Call 'KPSE_COND_WIN32' and define the Automake conditional
     'WIN32_WRAP' ('true' if the standard Windows wrapper
     ('texk/texlive/w32_wrapper/runscript.exe') exists.  This wrapper is
     used on Windows instead of symlinks for the "linked scripts" (*note
     Linked scripts::).

 -- Macro: KPSE_WIN32_CALL
     Call 'KPSE_COND_WIN32' and check if the file
     'texk/texlive/w32_wrapper/callexe.c' exists; if it does, create a
     symlink in the build tree.  Compiling 'callexe.c' with
     '-DEXEPROG='"FOO.exe"'' and installing 'callexe.exe' as 'BAR.exe'
     is used on Windows instead of a symlink 'BAR->FOO' for Unix-like
     systems.


File: tlbuild.info,  Node: Library modules,  Next: Program modules,  Prev: Autoconf macros,  Up: Layout and infrastructure

6.4 Library modules
===================

Here we discuss some specifics for a few of the libraries in TL, both
for the details themselves, and as a way of illuminating the general
structure and variation.

* Menu:

* png library::       'libs/libpng'
* zlib library::      'libs/zlib'
* freetype library::  'libs/freetype2'
* kpathsea library::  'texk/kpathsea'


File: tlbuild.info,  Node: png library,  Next: zlib library,  Up: Library modules

6.4.1 The 'png' library in 'libs/libpng'
----------------------------------------

The "generic" 'png' library uses the source tree in the subdirectory
'libpng-src/', with all modifications for TL recorded in 'TLpatches/*'.
The 'configure.ac' fragment 'ac/withenable.ac' contains

     KPSE_WITH_LIB([libpng], [zlib])

to specify the module name and indicate the dependency on 'zlib'.  A
third literal argument ''tree'' would specify that the library from the
TeX Live tree cannot be replaced by a system version.  That not being
the case here, a second fragment 'ac/libpng.ac' contains

     KPSE_TRY_LIB([libpng],
                  [#include <png.h>],
                  [png_structp png; png_voidp io; png_rw_ptr fn;
     png_set_read_fn(png, io, fn);])

thus providing the simple C code

     #include <png.h>
     int main ()
     { png_structp png; png_voidp io; png_rw_ptr fn;
       png_set_read_fn(png, io, fn);
       return 0; }

which Autoconf uses to verify the usability of a system version with C
code.  The analogous macro 'KPSE_TRY_LIBXX' would check using C++.
These fragments are included by the 'configure.ac' at the top level of
TL ('Build/source/configure.ac').

   For this library, like many other modules, a proxy build system for
TL is used, consisting of our own 'configure.ac', 'Makefile.am',
'include/Makefile.am'; the distributed build system is not used.
(Consequently, a few generated files and auxiliary scripts are removed
from the distributed source tree.)

   The public headers 'png.h', 'pngconf.h', and 'pnglibconf.h' are
"installed" (as symlinks) under 'include/' in the build tree exactly as
they are for a system version under, e.g., '/usr/include/'.

   The module is supplemented by the file 'm4/kpse-libpng-flags.m4' that
defines the M4 macro 'KPSE_LIBPNG_FLAGS' used by all modules depending
on this library in their 'configure.ac' to generate the 'make' variables
'LIBPNG_INCLUDES' for use in 'CPPFLAGS', 'LIBPNG_LIBS' for use in
'LDADD', 'LIBPNG_DEPEND' for use as dependencies, and 'LIBPNG_RULE' for
the 'make' rules to rebuild the library.

   'm4/kpse-libpng-flags.m4' also supplies the configure option
'--with-system-libpng', which then uses 'pkg-config' to determine the
flags required for the system library.


File: tlbuild.info,  Node: zlib library,  Next: freetype library,  Prev: png library,  Up: Library modules

6.4.2 The 'zlib' library in 'libs/zlib'
---------------------------------------

This generic library is very much analogous to 'libpng', but without the
dependency on any other library.  The file 'm4/kpse-zlib-flags.m4'
supplies the configure option '--with-system-zlib', as well as
'--with-zlib-includes' and '--with-zlib-libdir' to specify non-standard
locations of the 'zlib' headers and/or library.


File: tlbuild.info,  Node: freetype library,  Next: kpathsea library,  Prev: zlib library,  Up: Library modules

6.4.3 The 'freetype' library in 'libs/freetype2'
------------------------------------------------

This module uses a wrapper build system.  In contrast to the proxy build
described earlier, the wrapper build has an almost trivial
'configure.ac' and a 'Makefile.am' which invokes the 'configure' and
'make' in the distributed source, followed by 'make install' with the TL
build tree as destination.  In other words, this actually uses the build
system provided by upstream (possibly patched).

   The flags required for the system library are obtained through
'freetype-config'.


File: tlbuild.info,  Node: kpathsea library,  Prev: freetype library,  Up: Library modules

6.4.4 The 'kpathsea' library in 'texk/kpathsea'
-----------------------------------------------

This is one of the TeX-specific libraries that are maintained as part of
TeX Live (*note (kpathsea)::); the other is 'ptexenc'.  These TeX
libraries are Libtool libraries (static and/or shared) and are installed
by 'make install' together with the programs.  They are, however, not
part of the TL DVD as distributed by TeX user groups, and have never
been officially released for standalone use.

   It is possible, and probably useful for distro builds (*note Distro
builds::), to specify the configure option '--with-system-kpathsea' in
order to use a system version of the library.  Programs outside the TL
tree should use 'pkg-config' for the required flags.

   In addition to 'kpathsea/ac/withenable.ac' and
'kpathsea/ac/kpathsea.ac' here there is a third fragment
'kpathsea.ac/mktex.ac', included by both 'withenable.ac' and
'configure.ac', which supplies configure options such as
'--enable-mktextfm-default'.  These determine the compile time default
of whether or not to run 'mktextfm' (and similar) to generate a missing
'.tfm' (or whatever) file.  In any case, however, the command line
options '-mktex=tfm' or '-no-mktex=tfm' for the TeX-like engines
override this default.


File: tlbuild.info,  Node: Program modules,  Next: Extending TeX Live,  Prev: Library modules,  Up: Layout and infrastructure

6.5 Program modules
===================

As with libraries (*note Library modules::), here we discuss the details
for a few of the programs in TL.

* Menu:

* t1utils package:: 'utils/t1utils'
* xindy package::   'utils/xindy'
* xdvik package::   'texk/xdvik'
* asymptote::       'utils/asymptote'


File: tlbuild.info,  Node: t1utils package,  Next: xindy package,  Up: Program modules

6.5.1 The 't1utils' package in 'utils/t1utils'
----------------------------------------------

Here we use the distributed source tree 't1utils-src' with modifications
documented in 'TLpatches/*' and a proxy build system consisting of
'configure.ac' and 'Makefile.am'.  The fragment 'ac/withenable.ac'
contains

     KPSE_ENABLE_PROG([t1utils])

specifying the module name without any dependencies, and supplies the
configure option '--disable-t1utils'.


File: tlbuild.info,  Node: xindy package,  Next: xdvik package,  Prev: t1utils package,  Up: Program modules

6.5.2 The 'xindy' package in 'utils/xindy'
------------------------------------------

This module uses the distributed source tree 'xindy-src/' with
modifications documented in 'TLpatches/*', and a wrapper 'configure.ac'
and 'Makefile.am' that descends into 'xindy-src'.

   The 'xindy' build requires a 'make' that supports a 'VPATH' build,
can handle all targets, and do not refer to '${top_srcdir}' or
'${top_builddir}'.  The fragment 'xindy/ac/withenable.ac' contains

     KPSE_ENABLE_PROG([xindy], , [disable])
     m4_include(kpse_TL[utils/xindy/ac/xindy.ac])
     m4_include(kpse_TL[utils/xindy/ac/clisp.ac])

where 'disable' in the third argument indicates that 'xindy' is only
built if explicitly enabled by the user with 'configure --enable-xindy'
(the need for 'clisp' makes it too painful to enable by default).

   The additional fragments 'ac/xindy.ac' and 'ac/clisp.ac' specify more
'configure' options to be seen at the top level, with 'ac/xindy.ac' also
included by 'configure.ac'.


File: tlbuild.info,  Node: xdvik package,  Next: asymptote,  Prev: xindy package,  Up: Program modules

6.5.3 The 'xdvik' package in 'texk/xdvik'
-----------------------------------------

This package is maintained as part of the TeX Live tree with sources in
its own directory ('texk/xdvik/').  The fragment
'xdvik/ac/withenable.ac' contains

     dnl extra_dirs = texk/xdvik/squeeze
     KPSE_ENABLE_PROG([xdvik], [kpathsea freetype2], [x])
     m4_include(kpse_TL[texk/xdvik/ac/xdvik.ac])

thus specifying dependencies on the 'kpathsea', 'freetype', and X11
libraries.  The M4 comment (following 'dnl') signals the subsidiary
'squeeze/configure.ac'.  This is needed because the main executable
'xdvi-bin' (to be installed as, e.g., 'xdvi-xaw') is for the 'host'
system whereas the auxiliary program 'squeeze/squeeze' has to run on the
'build' system; in a cross compilation, these differ.

   The additional fragment 'ac/xdvik.ac' is also included by
'configure.ac' and supplies the configure option '--with-xdvi-x-toolkit'
also seen at the top level.


File: tlbuild.info,  Node: asymptote,  Prev: xdvik package,  Up: Program modules

6.5.4 The subdirectory 'utils/asymptote'
----------------------------------------

This subdirectory contains the sources for 'asy' and 'xasy' but due to
its complexity and prerequisites (e.g., OpenGL) it is not part of the TL
build system.  These programs must be built and installed independently,
but are included on the TL DVD together with their support files.  See
<https://tug.org/build.html#asymptote>.


File: tlbuild.info,  Node: Extending TeX Live,  Prev: Program modules,  Up: Layout and infrastructure

6.6 Extending TeX Live
======================

This section outlines the basic process for adding new packages to the
TL build system.

   In any case, a new package directory 'foo' should contain the
original sources, modified only with changes necessary for TL, in
'foo/foo-src'.  The changes should be documented in 'foo/TLpatches/*',
and also be submitted upstream whenever reasonable.  In addition, 'foo/'
will need the usual Automake build-related files ('configure.ac',
'Makefile.am', etc.  Please maintain 'foo/ChangeLog' for all TL changes.

* Menu:

* Adding a new program module::
* Adding a new generic library module::
* Adding a new TeX-specific library module::


File: tlbuild.info,  Node: Adding a new program module,  Next: Adding a new generic library module,  Up: Extending TeX Live

6.6.1 Adding a new program module
---------------------------------

A TeX-specific program module in a subdirectory 'texk/PROG' may use the
TeX-specific libraries and is included by adding its name 'PROG' to the
M4 list 'kpse_texk_pkgs' defined in 'm4/kpse-pkgs.m4'.

   A generic program module in a subdirectory 'utils/PROG' must not use
the TeX-specific libraries and is included by adding its name 'PROG' to
the M4 list 'kpse_utils_pkgs' in 'm4/kpse-pkgs.m4'.

   In either case, the subdirectory 'texk/PROG' or 'utils/PROG' must
provide a fragment 'ac/withenable.ac' that contains the M4 macro
'KPSE_ENABLE_PROG' defined in 'm4/kpse-setup.m4' with 'PROG' as the
mandatory first argument and three optional arguments:

  1. a list of required libraries from the TL tree;

  2. a list of options: 'disable' if this module is not to be built
     without the configure option '--enable-PROG', 'native' if cross
     compilation is not possible, 'x' if the program requires X11
     libraries;

  3. a comment added to the help text for the 'configure' option
     '--enable-PROG' or '--disable-PROG'.

   If the module requires specific 'configure' options to be seen at the
top level, they should be defined in an additional fragment 'ac/PROG.ac'
included from 'ac/withenable.ac' and 'configure.ac'.

   Usually, the new program is maintained somewhere outside of TeX Live.
In that case, as above, we put the upstream sources into a subdirectory
'PROG-src' (e.g., 'utils/newprog/newprog-src').  We do not typically run
'configure' in this original '...-src' directory, but only in our own
directory; but we do compile using the source files in '...-src'.

   So, to summarize the files that we must (usually) create:

'ac/withenable.ac'
     The 'KPSE_ENABLE_PROG' call just explained.

'configure.ac'
'Makefile.am'
     By merging the contents of the original 'configure.ac' (if
     provided) and a comparable program already in TL. There is no magic
     recipe, it's necessary to think about needs to be done in the
     original vs. in TeX Live.

'TLpatches/TL-Changes'
     Actions taken after getting the original source tree; typically
     removal of derived or unused common files.

'TLpatches/patch-...'
     If any changes are needed to the original sources, record the
     patches here so they can be applied next time.  And send them
     upstream so that perhaps they won't have to be.

'ChangeLog'
     Record all TL-specific changes, now and in the future.

   Then, run GNU 'autoreconf' in the new directory (*note Build system
tools::).  After that works, 'svn add' the necessary files, including
the generated 'Makefile.in aclocal.m4 configure', and 'svn:ignore' the
Automake cache 'autom4te.cache'.  (This is so people checking out the TL
source tree do not have to run any autotools, but can simply run
'configure'.)

   Then, run the TL tool 'reautoconf' in the top-level TL 'source/'
directory, to incorporate the new program into the build tree.

   Then, run (and rerun) a build until the program compiles and tests
successfully, probably involving rerunning autoreconf in the source
directory, 'make' in the build directory, etc.

   After final success, don't forget to commit.


File: tlbuild.info,  Node: Adding a new generic library module,  Next: Adding a new TeX-specific library module,  Prev: Adding a new program module,  Up: Extending TeX Live

6.6.2 Adding a new generic library module
-----------------------------------------

A generic library module in a subdirectory 'libs/LIB' must not depend on
TeX-specific libraries, by definition.  It is included by adding its
name 'LIB' to the M4 macro 'kpse_libs_pkgs' in 'm4/kpse-pkgs.m4'--before
any other libraries from the TeX Live tree on which it depends.

   As with program modules, the subdirectory 'libs/LIB' must contain the
sources and build system for the library (and any installable support
programs) and a fragment 'ac/withenable.ac' that contains the M4 macro
'KPSE_WITH_LIB' defined in 'm4/kpse-setup.m4' with 'LIB' as the
mandatory first argument and two optional arguments: a list of required
libraries from the TL tree, and a list of options: for libraries,
currently there is only one--specify 'tree' if this library cannot be
replaced by a system version.

   If a system version can be used, a second fragment 'ac/LIB.ac' is
needed, containing the M4 macro 'KPSE_TRY_LIB' (or 'KPSE_TRY_LIBXX')
with 'LIB' as the mandatory first argument and two additional arguments
for the Autoconf macro 'AC_LANG_PROGRAM' used to compile and link a
small C (or C++) program as sanity check for using the system library.

   In addition a file 'm4/kpse-LIB-flags' (at the top level) must define
the M4 macro 'KPSE_LIB_FLAGS' (all uppercase) setting up the 'make'
variables 'LIB_INCLUDES', 'LIB_LIBS', 'LIB_DEPEND', and 'LIB_RULE' with
the values required for 'CPPFLAGS', 'LDADD', dependencies, and a
(multi-line) 'make' rule to rebuild the library when necessary.  All of
that is needed for the library from the TL tree and, if supported, for a
system version.

   If a system library is allowed, 'KPSE_LIB_FLAGS' also provides the
configure option '--with-system-LIB' and uses the additional M4 macro
'KPSE_LIB_SYSTEM_FLAGS' to generate the 'make' variables for a system
library.  In addition, the definition of the M4 macro
'KPSE_ALL_SYSTEM_FLAGS' in 'm4/kpse-pkgs.m4' must be extended by the
line:
   'AC_REQUIRE([KPSE_LIB_SYSTEM_FLAGS])'


File: tlbuild.info,  Node: Adding a new TeX-specific library module,  Prev: Adding a new generic library module,  Up: Extending TeX Live

6.6.3 Adding a new TeX-specific library module
----------------------------------------------

A TeX-specific library module in a subdirectory 'texk/LIB' may depend on
other TeX-specific libraries but must not depend on any generic library
from the TL tree.  It is included in the same general ways as a generic
library (see the previous section), with these modifications:

   * The library name 'LIB' is added to the M4 macro
     'kpse_texlibs_pkgs', which is also in 'm4/kpse-pkgs.m4'.

   * The fragment 'ac/withenable.ac' must use 'KPSE_WITH_TEXLIB'.


File: tlbuild.info,  Node: Configure options,  Next: Coding conventions,  Prev: Layout and infrastructure,  Up: Top

7 Configure options
*******************

Corresponding to the large number of program and library modules there
are a large number 'configure' options, most of which are described
here.  The command
   'configure --help'
at the top level gives an exhaustive list of all global options and a
few important module-specific ones, whereas, e.g.,
   'texk/lcdf-typetools/configure --help'
also displays the 'lcdf-typetools' specific options, which are not shown
at the top level.

   The help text also mentions several influential environment
variables, but for TeX Live it is better to specify them as assignments
on the command line.

   The './Build' script used to make the binaries shipped with TeX Live
invokes the top-level 'configure' with a few additional options (*note
Building::).  The defaults discussed below are those for the actual
'configure' script; invoking 'configure' via './Build' yields different
results.

   Defaults for most options are set at the top level and propagated
explicitly to all subdirectories.  Options specified on the command line
are checked for consistency but never modified.

* Menu:

* Global configure options::
* Program-specific configure options::
* Library-specific configure options::
* Variables for configure::


File: tlbuild.info,  Node: Global configure options,  Next: Program-specific configure options,  Up: Configure options

7.1 Global configure options
============================

Here are the global configure options.

* Menu:

* --disable-native-texlive-build::
* --prefix --bindir ...::
* --disable-largefile::
* --disable-missing::
* --enable-compiler-warnings=LEVEL::
* --enable-cxx-runtime-hack::
* --enable-maintainer-mode::
* --enable-multiplatform::
* --enable-shared::
* --enable-silent-rules::
* --without-ln-s::
* --without-x::


File: tlbuild.info,  Node: --disable-native-texlive-build,  Next: --prefix --bindir ...,  Up: Global configure options

7.1.1 '--disable-native-texlive-build'
--------------------------------------

If enabled (the default), build for a TL binary distribution as shipped
by the TeX user groups.  This requires GNU 'make' and implies
'--enable-multiplatform' and '--enable-cxx-runtime-hack' (unless they
are explicitly disabled), and enforces '--disable-shared'.

   If building TL for a GNU/Linux or other distribution, this should be
disabled and system versions of most libraries should be used (*note
Distro builds::).

   A related option, '--enable-texlive-build', is automatically passed
to all subdirectories (and cannot be disabled).  Subdirectories that can
also be built independently from the TL tree (such as 'utils/xindy' and
'texk/dvipng') but cooperate with TL can use this option to enable
TL-specific adaptations, such as installation paths.


File: tlbuild.info,  Node: --prefix --bindir ...,  Next: --disable-largefile,  Prev: --disable-native-texlive-build,  Up: Global configure options

7.1.2 '--prefix', '--bindir', ...
---------------------------------

These standard Autoconf options specify various installation directories
as usual.  For the complete list, *note Installation directories::.

   Also as usual, all values are prefixed by the value of 'DESTDIR', if
set, on the 'make' command line (*note Installation in a temporary
location: (automake)Staged Installs.).


File: tlbuild.info,  Node: --disable-largefile,  Next: --disable-missing,  Prev: --prefix --bindir ...,  Up: Global configure options

7.1.3 '--disable-largefile'
---------------------------

Omit large file support (LFS), which is needed on most 32-bit Unix
systems for files with 2GB or more.  Regardless of this option, the size
of 'DVI' and 'GF' files must always be <2GB, due to the file format
specifications.

   With LFS, there is no fixed limit on the size of PDF files created by
'pdftex' or PostScript files created by 'dvips'.  The size of PDF images
included by 'pdftex' or 'luatex' must, however, be <2GB when using
'poppler' version 0.22 or before (even on 64-bit systems with LFS).


File: tlbuild.info,  Node: --disable-missing,  Next: --enable-compiler-warnings=LEVEL,  Prev: --disable-largefile,  Up: Global configure options

7.1.4 '--disable-missing'
-------------------------

Immediately terminate the build process if a requested program or
feature must be disabled, e.g., due to missing libraries.  This can help
when figuring out a specific (sub)set of modules to enable.


File: tlbuild.info,  Node: --enable-compiler-warnings=LEVEL,  Next: --enable-cxx-runtime-hack,  Prev: --disable-missing,  Up: Global configure options

7.1.5 '--enable-compiler-warnings='LEVEL
----------------------------------------

Enable various levels of compiler warnings for C, C++, and/or
Objective C: the LEVEL value can be one of: 'no min yes max all'.  The
default is 'yes' in 'maintainer-mode' (see below) and 'min' otherwise.
This option defines the variables 'WARNING_[OBJ]C[XX]FLAGS', but these
variables are not consistently used in all library and program modules.
At present, these warning flags assume options from the GNU compilers.


File: tlbuild.info,  Node: --enable-cxx-runtime-hack,  Next: --enable-maintainer-mode,  Prev: --enable-compiler-warnings=LEVEL,  Up: Global configure options

7.1.6 '--enable-cxx-runtime-hack'
---------------------------------

If enabled (as it is for the native TL build), when using 'g++', try to
statically link with 'libstdc++', thus improving portability of the
resulting binary.  *Note Macros for compilers::.


File: tlbuild.info,  Node: --enable-maintainer-mode,  Next: --enable-multiplatform,  Prev: --enable-cxx-runtime-hack,  Up: Global configure options

7.1.7 '--enable-maintainer-mode'
--------------------------------

Enable 'make' rules and dependencies not useful (and sometimes
confusing) to the casual user.  This requires current versions of the
GNU build tools (*note Build system tools::), as it automatically
rebuilds infrastructure files as needed.  *Note 'missing' and
'AM_MAINTAINER_MODE': (automake)maintainer-mode.


File: tlbuild.info,  Node: --enable-multiplatform,  Next: --enable-shared,  Prev: --enable-maintainer-mode,  Up: Global configure options

7.1.8 '--enable-multiplatform'
------------------------------

If enabled (as it is for the native TL build) and '--bindir=DIR' or
'--libdir=DIR' are not specified, install executables and libraries in
per-platform subdirectories of 'EPREFIX/bin' and 'EPREFIX/lib' where
EPREFIX is the value given or implied for 'exec_prefix'.  In any case,
the values for 'bindir' and 'libdir' are automatically propagated to all
subdirectories.


File: tlbuild.info,  Node: --enable-shared,  Next: --enable-silent-rules,  Prev: --enable-multiplatform,  Up: Global configure options

7.1.9 '--enable-shared'
-----------------------

Build shared versions of the TeX-specific libraries such as
'libkpathsea'.  This is not allowed for a native TL build (i.e.,
'--disable-native-texlive-build' must also be specified).


File: tlbuild.info,  Node: --enable-silent-rules,  Next: --without-ln-s,  Prev: --enable-shared,  Up: Global configure options

7.1.10 '--enable-silent-rules'
------------------------------

Enable the use of less verbose build rules.  When using GNU 'make' (or
any 'make' implementation supporting nested variable expansions), you
can specify 'V=1' on the 'make' command line to get more verbosity, or
'V=0' to get less, regardless of this option.


File: tlbuild.info,  Node: --without-ln-s,  Next: --without-x,  Prev: --enable-silent-rules,  Up: Global configure options

7.1.11 '--without-ln-s'
-----------------------

Required when using a system without a working 'ln -s' to build binaries
for a Unix-like system.  However, 'make install' will not create
anything useful, and might fail.


File: tlbuild.info,  Node: --without-x,  Prev: --without-ln-s,  Up: Global configure options

7.1.12 '--without-x'
--------------------

Disable all programs using the X Window System.


File: tlbuild.info,  Node: Program-specific configure options,  Next: Library-specific configure options,  Prev: Global configure options,  Up: Configure options

7.2 Program-specific configure options
======================================

Here are (some of) the program-specific 'configure' options.

* Menu:

* --enable-PROG --disable-PROG::
* --disable-all-pkgs::
* Configure options for texk/web2c::
* Configure options for texk/bibtex-x::
* Configure options for texk/dvipdfm-x::
* Configure options for texk/dvisvgm::
* Configure options for texk/texlive::
* Configure options for texk/xdvik::
* Configure options for utils/xindy::


File: tlbuild.info,  Node: --enable-PROG --disable-PROG,  Next: --disable-all-pkgs,  Up: Program-specific configure options

7.2.1 '--enable-PROG', '--disable-PROG'
---------------------------------------

Do or do not build and install the program(s) of module 'PROG'.


File: tlbuild.info,  Node: --disable-all-pkgs,  Next: Configure options for texk/web2c,  Prev: --enable-PROG --disable-PROG,  Up: Program-specific configure options

7.2.2 '--disable-all-pkgs'
--------------------------

Do not build any program modules by default--only those explicitly
enabled.  This is useful when one wants to work on only a single
program, which is specified with an additional '--enable' option, e.g.,
'--enable-dvipdfm-x'.  It's still simplest to check out and configure
the whole source tree, but at least only the program you are interested
in, and its dependencies, are built.  *Note Build one package::.

   Without this option, all modules are built except those that are
explicitly disabled or specify 'disable' in their 'ac/withenable.ac'
fragment.


File: tlbuild.info,  Node: Configure options for texk/web2c,  Next: Configure options for texk/bibtex-x,  Prev: --disable-all-pkgs,  Up: Program-specific configure options

7.2.3 Configure options for 'texk/web2c'
----------------------------------------

'--with-banner-add=STR'
Add 'STR' to the default version string (which is ''TeX Live YEAR'' or
''Web2C YEAR'') appended to banner lines.  This is ignored for a native
TL build, but distro builds should specify, e.g., '/SOMEDISTRO'.

'--with-editor=CMD'
Specify the command 'CMD' to invoke from the 'e' option of TeX and
friends, replacing the default 'vi +%d '%s'' for Unix or 'texworks
--position=%d "%s"' for Windows.

'--with-fontconfig-includes=DIR', '--with-fontconfig-libdir=DIR'
Building XeTeX on non-Mac systems requires the 'fontconfig' library
headers and code.  If one or both of these options are given, the
required flags are derived from them; otherwise, they are determined via
'pkg-config' (if present).

'--with-mf-x-toolkit'
Use the X toolkit ('libXt') for Metafont (the default is to use the
lowest-level 'Xlib' support; it seems this has the best chance of
working across X installations nowadays).

'--disable-dump-share'
Make the 'fmt'/'base' dump files architecture dependent (somewhat faster
on LittleEndian architectures).

'--disable-ipc'
Disable TeX's '--ipc' option.

'--disable-mf-nowin'
Do not build a separate non-graphically-capable Metafont ('mf-nowin').

'--disable-tex', '--enable-etex', ...
Do not or do build the various TeX, Metafont, and MetaPost engines
(defaults are defined in the fragment 'texk/web2c/ac/web2c.ac').

'--disable-web-progs'
Do not build the original WEB programs 'bibtex', ..., 'weave'.  Useful
if, e.g., you only want to (re)build some engines.

'--enable-auto-core'
This option causes TeX and Metafont to produce a core dump when a
particular hacky filename is encountered, for use in creating preloaded
binaries.  This is rarely done nowadays.

'--enable-libtool-hack'
If enabled (which is the default for all platforms), prevents 'libtool'
from linking explicitly with dependencies of 'libfontconfig' such as
'libexpat'.

'--enable-*win'
Include various types of non-X window support for Metafont (EPSF output,
'mftalk', old graphics terminals, ...).

'--enable-tex-synctex', '--disable-etex-synctex', ...
Build the TeX engines with or without 'SyncTeX' support; ignored for a
native TeX Live build.  Defaults are defined in
'texk/web2c/ac/web2c.ac'.

'--disable-synctex'
Do not build the 'SyncTeX' library and tool.


File: tlbuild.info,  Node: Configure options for texk/bibtex-x,  Next: Configure options for texk/dvipdfm-x,  Prev: Configure options for texk/web2c,  Up: Program-specific configure options

7.2.4 Configure options for 'texk/bibtex-x'
-------------------------------------------

The programs 'bibtex8' and 'bibtexu' have been merged into the module
'bibtex-x' (extended BibTeX).

'--disable-bibtex8'
Do not build the 'bibtex8' program.

'--disable-bibtexu'
Do not build the 'bibtexu' program (building 'bibtexu' requires 'ICU'
libraries).


File: tlbuild.info,  Node: Configure options for texk/dvipdfm-x,  Next: Configure options for texk/dvisvgm,  Prev: Configure options for texk/bibtex-x,  Up: Program-specific configure options

7.2.5 Configure options for 'texk/dvipdfm-x'
--------------------------------------------

The former modules 'dvipdfmx' (extended DVI to PDF converter) and
'xdvipdfmx' (the same, as used by XeTeX) have been merged into
'dvipdfm-x' at the source level.  Two separate binaries are still
created by default.  In addition, 'dvipdfm' is created as a symlink to
'dvipdfmx', with backward-compatible (very slightly different) behavior.

'--disable-dvipdfmx'
Do not build the 'dvipdfmx' program or make the 'dvipdfm' symlink.

'--disable-xdvipdfmx'
Do not build the 'xdvipdfmx' program.


File: tlbuild.info,  Node: Configure options for texk/dvisvgm,  Next: Configure options for texk/texlive,  Prev: Configure options for texk/dvipdfm-x,  Up: Program-specific configure options

7.2.6 Configure options for 'texk/dvisvgm'
------------------------------------------

'--with-system-libgs'
Build 'dvisvgm' using installed Ghostscript ('gs') headers and library
(not allowed for a native TL build).  The default is to load the 'gs'
library at runtime if possible, else to disable support for PostScript
specials.

'--without-libgs'
Build 'dvisvgm' without PostScript support at all.  Because the dynamic
loading just mentioned defeats all attempts at static linking, the
result can crash due to library incompatibilities, e.g., on CentOS 5.

'--with-libgs-includes=DIR', '--with-libgs-libdir=DIR'
Specify non-standard locations of the Ghostscript headers and library.


File: tlbuild.info,  Node: Configure options for texk/texlive,  Next: Configure options for texk/xdvik,  Prev: Configure options for texk/dvisvgm,  Up: Program-specific configure options

7.2.7 Configure options for 'texk/texlive'
------------------------------------------

'--disable-linked-scripts'
Do not install the "linked scripts" (*note Linked scripts::), except for
the TL scripts required to run 'texlinks'.


File: tlbuild.info,  Node: Configure options for texk/xdvik,  Next: Configure options for utils/xindy,  Prev: Configure options for texk/texlive,  Up: Program-specific configure options

7.2.8 Configure options for 'texk/xdvik'
----------------------------------------

'--with-gs=FILENAME'
Hardwire the location of Ghostscript ('gs') as called by Xdvik.

'--with-xdvi-x-toolkit=KIT'
Use toolkit 'KIT' for 'xdvik', one of: 'motif xaw xaw3d neXtaw'.  The
default is 'motif' if available, else 'xaw'.

'--enable-xi2-scrolling'
Use XInput 2.1 "smooth scrolling" if available (default: yes, except for
a native TL build).


File: tlbuild.info,  Node: Configure options for utils/xindy,  Prev: Configure options for texk/xdvik,  Up: Program-specific configure options

7.2.9 Configure options for 'utils/xindy'
-----------------------------------------

'--enable-xindy-rules'
Build and install 'xindy' rules (default: yes, except for a native TL
build).

'--enable-xindy-docs'
Build and install 'xindy' documentation (default: yes, except for a
native TL build).

'--with-clisp-runtime=FILENAME'
Specifies the full path for the Clisp runtime file ('lisp.run' or
'lisp.exe') to be installed.  When specified as 'default' (the default
for a native TL build) the path is determined by the Clisp executable;
the value 'system' (not allowed for a native TL build, but the default
otherwise) indicates that 'xindy' will use the installed version of
'clisp' (which must be identical to the one used to build 'xindy').


File: tlbuild.info,  Node: Library-specific configure options,  Next: Variables for configure,  Prev: Program-specific configure options,  Up: Configure options

7.3 Library-specific configure options
======================================

Here are (some of) the library-specific 'configure' options, starting
with this generic one:

'--with-system-LIB'

   Use an installed (system) version of the library 'LIB'; this option
exists for most libraries, but is not allowed for a native TL build.
Using a system version implies also using the system versions of all
libraries that LIB depends on.

   For many libraries '--with-LIB-includes=DIR' and
'--with-LIB-libdir=DIR' can specify non-standard search locations;
others use 'pkg-config' or similar to determine the required flags.

   The top-level 'configure' script performs a consistency check for all
required system libraries and bails out if tests fail.

* Menu:

* Configure options for kpathsea::
* Configure options for system poppler::


File: tlbuild.info,  Node: Configure options for kpathsea,  Next: Configure options for system poppler,  Up: Library-specific configure options

7.3.1 Configure options for 'kpathsea'
--------------------------------------

'--enable-CMD-default', '--disable-CMD-default'
Determine the compile time default for whether or not to run CMD, which
is one of:
'mkocp'
     (Omega compiled translation process file)
'mkofm'
     (Omega font metrics file)
'mktexfmt'
     (format/base dump file)
'mktexmf'
     (Metafont source)
'mktexpk'
     (PK bitmap font)
'mktextex'
     (TeX source)
'mktextfm'
     (TFM file)

to generate the specified type of file dynamically.  The default can be
overridden by the user in any case (*note kpathsea library::).


File: tlbuild.info,  Node: Configure options for system poppler,  Prev: Configure options for kpathsea,  Up: Library-specific configure options

7.3.2 Configure options for system 'poppler'
--------------------------------------------

Building XeTeX requires 'poppler', either from the TL tree or system
headers and library.  Building pdfTeX requires either 'xpdf' from the
TeX Live tree or system 'poppler' headers and library.

'--with-system-poppler'
Use a system version (0.18 or newer) of 'poppler' for LuaTeX (or
LuaJITTeX) and XeTeX, and use 'pkg-config' to obtain the required flags.

'--with-system-xpdf'
Use a system version (0.12 or newer) of 'poppler' (and 'pkg-config') for
pdfTeX instead of 'xpdf' from the TL tree.  *Note --disable-largefile::.


File: tlbuild.info,  Node: Variables for configure,  Prev: Library-specific configure options,  Up: Configure options

7.4 Variables for configure
===========================

The values for these variables can be specified as 'configure' arguments
of the form 'VAR=VALUE'.  They can also be defined in the environment,
but that might not work for cross compilations.

'CC'
'CXX'
'CPPFLAGS'
     And plenty more.  As usual with Autoconf, these variables specify
     the name (or full path) of compilers, preprocessor flags, and
     similar.  *Note (autoconf)Preset Output Variables::.

'CLISP'
     Name (or full path) of the 'clisp' executable, used to build
     'xindy'.

'FT2_CONFIG'
'ICU_CONFIG'
'PKG_CONFIG'
     These specify the name (or path) for the 'freetype-config',
     'icu-config', and 'pkg-config' commands used to determine the flags
     required for system versions of 'libfreetype', the ICU libraries,
     and other libraries, respectively.

'KPSEWHICH'
     Name (or path) of an installed 'kpsewhich' binary, used by 'make
     check' to determine the location of, e.g., 'cmbx10.tfm'.

'MAKE'
'SED'
     And more.  Name (or path) of the 'make', 'sed', and similar
     programs; used at the top level and propagated to all
     subdirectories.

'PERL'
'LATEX'
'PDFLATEX'
     Name (or full path) for the 'perl', 'latex', and 'pdflatex'
     commands used, e.g., to build the 'xindy' documentation.


File: tlbuild.info,  Node: Coding conventions,  Next: Continuous integration,  Prev: Configure options,  Up: Top

8 Coding conventions
********************

Ideally, building all of TeX Live with '--enable-compiler-warnings=max'
should produce no (GCC) compiler warnings at all.  In spite of
considerable efforts into that direction we are still far from that goal
and there are reasons that we may never fully reach it.  Below are some
rules about declarations of functions or variables and the use of
'const'.  These rules should be applied to the code maintained in the
TeX Live tree and for other packages whose maintainers are willing to
accept patches.

* Menu:

* Declarations and definitions::
* Const::


File: tlbuild.info,  Node: Declarations and definitions,  Next: Const,  Up: Coding conventions

8.1 Declarations and definitions
================================

C standards
...........

The TeX Live build system no longer supports pre-ANSI C compilers.  Thus
all function prototypes and definitions must conform to the ANSI C
standard (including 'void' in the declaration of C functions with no
parameters).  On the other hand, TL is built for a wide variety of
systems, not all of which support the C99 standard.  Therefore using C99
features should be avoided if that can easily be done.  In particular, C
code must not contain declarations after statements or C++-style
comments.

   If some C99 (or later) constructs must be used, the module should
verify that they are available and otherwise provide an alternative.
For example, the module 'texk/chktex' uses the C99 function 'stpcpy()'
that may or may not be available on a particular system.  It uses
'AC_CHECK_DECLS([stpcpy])' in 'configure.ac' to test this, and provides
a perhaps less efficient alternative (in the file 'Utility.h'):

     #if !(defined HAVE_DECL_STPCPY && HAVE_DECL_STPCPY)
     static inline char *stpcpy(char *dest, const char *src)
     {
       return strcpy(dest, src) + strlen(src);
     }
     #endif

Static functions
................

Functions used in only one file should be declared 'static'; they
require no prototype except in forward declarations.

Extern functions
................

Functions not declared 'static', usually because they are used in
several files, require an ('extern') prototype in exactly one header
file, which is included in the file defining the function and in all
files using that function--this is the only way to guarantee consistency
between definition and use.  There should be no 'extern' declarations
sprinkled throughout the C code (with or without comments as to where
that function is defined).

Variable declarations
.....................

The declaration of global variables follows analogous rules: they are
either declared 'static' if used in only one file or declared 'extern'
in exactly one header and instantiated in exactly one file.


File: tlbuild.info,  Node: Const,  Prev: Declarations and definitions,  Up: Coding conventions

8.2 Const
=========

The 'const' feature of C is valuable, but easy to mis-use.

Function parameters
...................

Ideally, a function parameter not modified by the function should be
declared as 'const'.  This is important in particular for strings
('char*') because the actual arguments are often string literals.  It is
perfectly legitimate and safe to use a type 'char*' value for a type
'const char*' variable (in an assignment, as initializer, as function
argument, or as return value).  It is equally safe to use a type
'char**' value for a type 'const char*const*' variable, but not for a
type 'const char**' variable since that might cause modification of a
quantity supposed to be constant.

   Getting all 'const' qualifiers right can get quite involved but can
almost always be done.  There are only a couple notable exceptions: the
X11 headers are full of declarations that ought to use 'const' but do
not; at one time, 'libfreetype' also did not fully specify 'const', but
this has not been checked recently.

What must be avoided with 'const'
.................................

The GCC compiler warnings "assignment discards qualifiers..." and
analogous warnings for "initialization", "passing arg", or "return" must
be strenuously avoided in our own code.  The only exception is when they
are caused by X11 declarations or other third party code.

What should be avoided with 'const'
...................................

A type cast, e.g., from 'const char*' to 'char*' does not solve any
problems; depending on warning options, it may only hide them.
Therefore such casts should be avoided whenever possible and otherwise
must be carefully analyzed to make sure that they cannot cause the
modification of quantities supposed to be constant.


File: tlbuild.info,  Node: Continuous integration,  Next: install-tl,  Prev: Coding conventions,  Up: Top

9 Continuous integration
************************

The TeX Live sources are subjected to continuous integration testing on
Travis-CI (<https://travis-ci.org/TeX-Live/texlive-source>) via a
git-svn mirror of the sources that is pushed to Github
(<https://github.com/TeX-Live/texlive-source>).  The git-svn mirror is
updated (currently) at 30 minute intervals, and only the last commit
pushed is tested on Travis-CI.

* Menu:

* Transfer from Subversion to Github::
* Automatic update of the Git mirror::
* CI testing on Travis-CI::


File: tlbuild.info,  Node: Transfer from Subversion to Github,  Next: Automatic update of the Git mirror,  Up: Continuous integration

9.1 Transfer from Subversion to Github
======================================

The git-svn program (<https://git-scm.com/docs/git-svn>) is used to
check out the subtree 'Build/source' of the canonical Subversion
repository.  The author index file used is not maintained in either Git
or Subversion but can be provided on request.

   The initial checkout was done by invoking
     git svn --authors-file usermap clone \
       svn://USER@tug.org/texlive/trunk/Build/source

where the 'usermap' file maps Subversion user names to name and emails
of the authors.  Anonymous checkout is also possible:
     git svn --authors-file usermap clone \
       svn://tug.org/texlive/trunk/Build/source

   In the following, we will use _admin_ to refer to a user who has
read/write access to the TeX Live subversion repository, and is also an
administrator of the ''TeX-Live'' team at Github.  The above initial
checkout has been carried out by _admin_ on the server 'texlive.info'.

   On Github, a new git repository named 'texlive-source' was created by
_admin_ within the 'TeX-Live' "organization"
(<https://github.com/TeX-Live>).  The remote was added to the checkout
with 'git remote add origin git@github.com:TeX-Live/texlive-source.git'.

   To automate the update on Github, a new ssh key was generated and
added to the 'texlive-source' repository on Github as deployment key.
Thus, pushes using this key can only go to the 'texlive-source'
repository and not anywhere else.

   The usage of 'git-svn' requires a strict discipline to keep a linear
history in the master branch.  Since we are aiming at a pure mirror
facility on Github, we have decided to further restrict the 'master'
branch of the 'texlive-source' repository on Github to changes by
_admin_.

   This setup allows other developers to branch off 'master' and push
their branches to the Github repository, but all updates need to come
from the local 'master' (not the one on Github) to Subversion, back to
'master' on 'texlive.info', and from there to Github.


File: tlbuild.info,  Node: Automatic update of the Git mirror,  Next: CI testing on Travis-CI,  Prev: Transfer from Subversion to Github,  Up: Continuous integration

9.2 Automatic update of the Git mirror
======================================

_admin_ has installed a cron job on 'texlive.info' running every 30
minute which essentially runs 'git svn rebase' and 'git push' in the
'master' branch of the checkout.  The first command fetches the changes
from the Subversion repository and updates the 'master' branch with
them, and the second pushes changes (if any) to Github.


File: tlbuild.info,  Node: CI testing on Travis-CI,  Prev: Automatic update of the Git mirror,  Up: Continuous integration

9.3 CI testing on Travis-CI
===========================

The 'source' tree of TeX Live contains a top-level file '.travis.yml'
which controls the automatic testing on Travis-CI. _admin_ has
registered with Travis-CI and allowed access to the Github's 'TeX-Live'
organization's 'texlive-source' repository.  The default settings are to
build the last commit of each push.  No further action is necessary on
Travis-CI.

   If changes have been pushed via the cron job above, Travis-CI will
automatically checkout the last pushed commit and try building it.


File: tlbuild.info,  Node: install-tl,  Next: tlmgr,  Prev: Continuous integration,  Up: Top

Appendix A install-tl
*********************

* Menu:

* install-tl NAME::
* install-tl SYNOPSIS::
* install-tl DESCRIPTION::
* install-tl REFERENCES::
* install-tl OPTIONS::
* install-tl PROFILES::
* install-tl ENVIRONMENT VARIABLES::
* install-tl AUTHORS AND COPYRIGHT::


File: tlbuild.info,  Node: install-tl NAME,  Next: install-tl SYNOPSIS,  Up: install-tl

A.1 NAME
========

install-tl - TeX Live cross-platform installer


File: tlbuild.info,  Node: install-tl SYNOPSIS,  Next: install-tl DESCRIPTION,  Prev: install-tl NAME,  Up: install-tl

A.2 SYNOPSIS
============

install-tl [_option_]...

   install-tl-windows.bat [_option_]...

   install-tl-advanced.bat [_option_]...


File: tlbuild.info,  Node: install-tl DESCRIPTION,  Next: install-tl REFERENCES,  Prev: install-tl SYNOPSIS,  Up: install-tl

A.3 DESCRIPTION
===============

This installer creates a runnable TeX Live installation from various
media, including over the network, from local hard disk, a DVD, etc.
The installer works across all platforms supported by TeX Live.  For
information on initially downloading the TeX Live, see
<http://tug.org/texlive/acquire.html>.

   The basic idea of TeX Live installation is for you to choose one of
the top-level _schemes_, each of which is defined as a different set of
_collections_ and _packages_, where a collection is a set of packages,
and a package is what contains actual files.

   Within the installer, you can choose a scheme, and further customize
the set of collections to install, but not the set of the packages.  To
work at the package level, use 'tlmgr' (reference just below) after the
initial installation is complete.

   The default is 'scheme-full', which installs everything, and this is
highly recommended.


File: tlbuild.info,  Node: install-tl REFERENCES,  Next: install-tl OPTIONS,  Prev: install-tl DESCRIPTION,  Up: install-tl

A.4 REFERENCES
==============

Post-installation configuration, package updates, and much more, are
handled through *tlmgr*(1), the TeX Live Manager
(<http://tug.org/texlive/tlmgr.html>).

   The most up-to-date version of this installer documentation is on the
Internet at <http://tug.org/texlive/doc/install-tl.html>.

   For the full documentation of TeX Live, see
<http://tug.org/texlive/doc>.


File: tlbuild.info,  Node: install-tl OPTIONS,  Next: install-tl PROFILES,  Prev: install-tl REFERENCES,  Up: install-tl

A.5 OPTIONS
===========

As usual, all options can be specified in any order, and with either a
leading '-' or '--'.  An argument value can be separated from its option
by either a space or '='.

*-gui* [[=]_module_]

     If no _module_ is given, starts the 'perltk' (see below) GUI
     installer.

     If _module_ is given loads the given installer module.  Currently
     the following modules are supported:

     'text'

          The text mode user interface (default on Unix systems).  Same
          as the '-no-gui' option.

     'wizard'

          The wizard mode user interface (default on Windows), asking
          only minimal questions before installing all of TeX Live.

     'perltk'

          The expert GUI installer, providing access to more options.
          Can also be invoked on Windows by running
          'install-tl-advanced.bat'.

     The 'perltk' and 'wizard' modules, and thus also when calling with
     bare '-gui' (with no _module_), require the Perl/Tk module
     (<http://tug.org/texlive/distro.html#perltk>); if Perl/Tk is not
     available, installation continues in text mode.

*-no-gui*

     Use the text mode installer (default except on Windows).

*-lang* _llcode_

     By default, the GUI tries to deduce your language from the
     environment (on Windows via the registry, on Unix via
     'LC_MESSAGES').  If that fails you can select a different language
     by giving this option with a language code (based on ISO 639-1).
     Currently supported (but not necessarily completely translated)
     are: English (en, default), Czech (cs), German (de), French (fr),
     Italian (it), Japanese (ja), Dutch (nl), Polish (pl), Brazilian
     Portuguese (pt_BR), Russian (ru), Slovak (sk), Slovenian (sl),
     Serbian (sr), Ukrainian (uk), Vietnamese (vi), simplified Chinese
     (zh_CN), and traditional Chinese (zh_TW).

*-repository* _url|path_

     Specify the package repository to be used as the source of the
     installation, either a local directory via '/path/to/directory' or
     a 'file:/' url, or a network location via a 'http://', 'https://',
     or 'ftp://' url.  (No other protocols are supported, and 'https://'
     may not work on all platforms.)

     The default is to pick a mirror automatically, using
     <http://mirror.ctan.org/systems/texlive/tlnet>; the chosen mirror
     is used for the entire download.  You can use the special argument
     'ctan' as an abbreviation for this.  See <http://ctan.org> for more
     about CTAN and its mirrors.

     If the repository is on the network, trailing '/' characters and/or
     trailing '/tlpkg' and '/archive' components are ignored.  For
     example, you could choose a particular CTAN mirror with something
     like this:

       -repository http://ctan.example.org/its/ctan/dir/systems/texlive/tlnet

     Of course a real hostname and its particular top-level CTAN
     directory have to be specified.  The list of CTAN mirrors is
     available at <http://ctan.org/mirrors>.

     If the repository is local, the installation type (compressed or
     live) is automatically determined, by checking for the presence of
     a 'archive' directory relative to the root.  Compressed is
     preferred if both are available, since it is faster.  Here's an
     example of using a local directory:

       -repository /local/TL/repository

     After installation is complete, you can use that installation as
     the repository for another installation.  If you chose to install
     less than the full scheme containing all packages, the list of
     available schemes will be adjusted accordingly.

     For backward compatibility and convenience, '--location' and
     '--repo' are accepted as aliases for this option.

*-select-repository*

     This option allows manual selection of a mirror from the current
     list of active CTAN mirrors.  This option is supported in all
     installer modes (text, wizard, perltk), and will also offer to
     install from local media if available, or from a repository
     specified on the command line (see above).  It's useful when the
     (default) automatic redirection does not choose a good host for
     you.

*-all-options*

     Normally options not relevant to the current platform are not shown
     (e.g., when running on Unix, Windows-specific options are omitted).
     Giving this command line option allows configuring such "foreign"
     settings.

*-custom-bin* _path_

     If you have built your own set of TeX Live binaries (perhaps
     because your platform was not supported by TeX Live out of the
     box), this option allows you to specify the _path_ to a directory
     where the binaries for the current system are present.  The
     installation will continue as usual, but at the end all files from
     _path_ are copied over to 'bin/custom/' under your installation
     directory and this 'bin/custom/' directory is what will be added to
     the path for the post-install actions.  To install multiple custom
     binary sets, manually rename 'custom' before doing each.

     For more information on custom binaries, see
     <http://tug.org/texlive/custom-bin.html>.  For general information
     on building TeX Live, see <http://tug.org/texlive/build.html>.

*-debug-translation*

     In GUI mode, this switch makes 'tlmgr' report any missing, or more
     likely untranslated, messages to standard error.  Helpful for
     translators to see what remains to be done.

*-force-platform* _platform_

     Instead of auto-detecting the current platform, use _platform_.
     Binaries for this platform must be present and they must actually
     be runnable, or installation will fail.  '-force-arch' is a
     synonym.

*-help*, *-help*, *-?*

     Display this help and exit.  (This help is on the web at
     <http://tug.org/texlive/doc/install-tl.html>).  Sometimes the
     'perldoc' and/or 'PAGER' programs on the system have problems,
     possibly resulting in control characters being literally output.
     This can't always be detected, but you can set the 'NOPERLDOC'
     environment variable and 'perldoc' will not be used.

*-in-place*

     This is a quick-and-dirty installation option in case you already
     have an rsync or svn checkout of TeX Live.  It will use the
     checkout as-is and will just do the necessary post-install.  Be
     warned that the file 'tlpkg/texlive.tlpdb' may be rewritten, that
     removal has to be done manually, and that the only realistic way to
     maintain this installation is to redo it from time to time.  This
     option is not available via the installer interfaces.  USE AT YOUR
     OWN RISK.

*-init-from-profile* _profile_file_

     Similar to *-profile* (see *note PROFILES: install-tl PROFILES.
     below), but only initializes the installation configuration from
     _profile_file_ and then starts the interactive session.

*-logfile* _file_

     Write both all messages (informational, debugging, warnings) to
     _file_, in addition to standard output or standard error.

     If this option is not given, the installer will create a log file
     in the root of the writable installation tree, for example,
     '/usr/local/texlive/YYYY/install-tl.log' for the _YYYY_ release.

*-no-cls*

     For the text mode installer only: do not clear the screen when
     entering a new menu (for debugging purposes).

*-non-admin*

     For Windows only: configure for the current user, not for all
     users.

*-persistent-downloads*

*-no-persistent-downloads*

     For network installs, activating this option makes the installer
     try to set up a persistent connection using the 'Net::LWP' Perl
     module.  This opens only one connection between your computer and
     the server per session and reuses it, instead of initiating a new
     download for each package, which typically yields a significant
     speed-up.

     This option is turned on by default, and the installation program
     will fall back to using 'wget' if this is not possible.  To disable
     usage of LWP and persistent connections, use
     '-no-persistent-downloads'.

*-no-verify-downloads*

     By default, if a GnuPG 'gpg' binary is found in PATH, downloads are
     verified against a cryptographic signature.  This option disables
     such verification.  The full description is in the Crytographic
     Verification section of the 'tlmgr' documentation, e.g.,
     <http://tug.org/texlive/doc/tlmgr.html#CRYPTOGRAPHIC-VERIFICATION>

*-portable*

     Install for portable use, e.g., on a USB stick.  Also selectable
     from within the perltk and text installers.

*-print-platform*

     Print the TeX Live identifier for the detected platform
     (hardware/operating system) combination to standard output, and
     exit.  '-print-arch' is a synonym.

*-profile* _profile_file_

     Load _profile_file_ and do the installation with no user
     interaction, that is, a batch (unattended) install.  See *note
     PROFILES: install-tl PROFILES. below.

*-q*

     Omit normal informational messages.

*-scheme* _scheme_

     Schemes are the highest level of package grouping in TeX Live; the
     default is to use the 'full' scheme, which includes everything.
     This option overrides that default.  You can change the scheme
     again before the actual installation with the usual menu.  The
     _scheme_ argument may optionally have a prefix 'scheme-'.  The list
     of supported scheme names depends on what your package repository
     provides; see the interactive menu list.

*-v*

     Include verbose debugging messages; repeat for maximum debugging:
     '-v -v'.  (Further repeats are accepted but ignored.)

*-version*, *-version*

     Output version information and exit.  If '-v' has also been given
     the revisions of the used modules are reported, too.


File: tlbuild.info,  Node: install-tl PROFILES,  Next: install-tl ENVIRONMENT VARIABLES,  Prev: install-tl OPTIONS,  Up: install-tl

A.6 PROFILES
============

A _profile_ file contains all the values needed to perform an
installation.  After a normal installation has finished, a profile for
that exact installation is written to the file 'tlpkg/texlive.profile'.
In addition, from the text menu one can select 'P' to save the current
setup as a profile at any time.  Such a profile file can be given as the
argument to '-profile', for example to redo the exact same installation
on a different system.  Alternatively, you can use a custom profile,
most easily created by starting from a generated one and changing
values, or an empty file, which will take all the defaults.

   Within a profile file, each line consists of

   _variable_ [_value_]

   except for comment lines starting with '#'.  The possible variable
names are listed below.  Values, when present, are either '0' or '1' for
booleans, or strings (which must be specified without any quote
characters).  Leading whitespace is ignored.

   If the variable 'selected_scheme' is defined and _no_ collection
variables at all are defined, then the collections required by the
specified scheme (which might change over time) are installed, without
explicitly listing them.  This eases maintenance of profile files.  If
any collections are specified in a profile, though, then all desired
collections must be given explicitly.

   For example, a line

  selected_scheme scheme-small

   along with definitions for the installation directories (given below
under "path options") suffices to install the "small" scheme with all
default options.  The schemes are described in the 'S' menu in the text
installer, or equivalent.

   Besides 'selected_scheme', here is the list of variable names
supported in a profile:

   *collection options* (prefix 'collection-')

   Collections are specified with a variable name with the prefix
'collection-' followed by a collection name; there is no value.  For
instance, 'collection-basic'.  The collections are described in the 'C'
menu.

   Schemes and collections (and packages) are ultimately defined by the
files in the 'tlpkg/tlpsrc/' source directory.

   *path options*

   It is best to define all of these, even though they may not be used
in the installation, so as to avoid unintentionally getting a default
value that could cause problems later.

  TEXDIR
  TEXMFCONFIG
  TEXMFVAR
  TEXMFHOME
  TEXMFLOCAL
  TEXMFSYSCONFIG
  TEXMFSYSVAR

   *installer options* (prefix 'instopt_')

'instopt_adjustpath' (default 0 on Unix, 1 on Windows)

     Adjust 'PATH' environment variable.

'instopt_adjustrepo' (default 1)

     Set remote repository to a multiplexed CTAN mirror after
     installation; see '-repository' above.

'instopt_letter' (default 0)

     Set letter size paper as the default, instead of a4.

'instopt_portable' (default 0)

     Install for portable use, e.g., on a USB stick.

'instopt_write18_restricted' (default 1)

     Enable '\write18' for a restricted set of programs.

   *tlpdb options* (prefix 'tlpdbopt_')

   The definitive list is given in 'tlpkg/TeXLive/TLConfig.pm', in
'%TeXLive::TLConfig::TLPDBOptions', together with explanations.  All
items given there _except_ for 'tlpdbopt_location' can be specified.
Here is the current list:

  tlpdbopt_autobackup
  tlpdbopt_backupdir
  tlpdbopt_create_formats
  tlpdbopt_desktop_integration
  tlpdbopt_file_assocs
  tlpdbopt_generate_updmap
  tlpdbopt_install_docfiles
  tlpdbopt_install_srcfiles
  tlpdbopt_post_code
  tlpdbopt_sys_bin
  tlpdbopt_sys_info
  tlpdbopt_sys_man
  tlpdbopt_w32_multi_user

   *platform options* (prefix 'binary_')

   For each supported platform in TeX Live (directories under 'bin/'),
the variable 'binary_'_PLATFORM_ can be set.  For example:

  binary_x86_64-linux

   If no 'binary_' variable is specified, the default is whatever the
current machine is running.

   In releases before 2017, many profile variables had different names
(not documented here; see the 'install-tl' source).  They are accepted
and transformed to the names given above.  When a profile is written,
the names above are always used.

   For more details on all of the above options, consult the TeX Live
installation manual, linked from <http://tug.org/texlive/doc>.


File: tlbuild.info,  Node: install-tl ENVIRONMENT VARIABLES,  Next: install-tl AUTHORS AND COPYRIGHT,  Prev: install-tl PROFILES,  Up: install-tl

A.7 ENVIRONMENT VARIABLES
=========================

For ease in scripting and debugging, 'install-tl' will look for the
following environment variables.  They are not of interest for normal
user installations.

'TEXLIVE_INSTALL_ENV_NOCHECK'

     Omit the check for environment variables containing the string
     'tex'.  People developing TeX-related software are likely to have
     many such variables.

'TEXLIVE_INSTALL_NO_CONTEXT_CACHE'

     Omit creating the ConTeXt cache.  This is useful for
     redistributors.

'TEXLIVE_INSTALL_NO_WELCOME'

     Omit printing the welcome message after successful installation,
     e.g., for testing.

'TEXLIVE_INSTALL_PREFIX'

'TEXLIVE_INSTALL_TEXDIR'

'TEXLIVE_INSTALL_TEXMFCONFIG'

'TEXLIVE_INSTALL_TEXMFVAR'

'TEXLIVE_INSTALL_TEXMFHOME'

'TEXLIVE_INSTALL_TEXMFLOCAL'

'TEXLIVE_INSTALL_TEXMFSYSCONFIG'

'TEXLIVE_INSTALL_TEXMFSYSVAR'

     Specify the respective directories.  'TEXLIVE_INSTALL_PREFIX'
     defaults to '/usr/local/texlive', while 'TEXLIVE_INSTALL_TEXDIR'
     defaults to the release directory within that prefix, e.g.,
     '/usr/local/texlive/2016'.  All the defaults can be seen by running
     the installer interactively and then typing 'D' for the directory
     menu.

'NOPERLDOC'

     Don't try to run the '--help' message through 'perldoc'.


File: tlbuild.info,  Node: install-tl AUTHORS AND COPYRIGHT,  Prev: install-tl ENVIRONMENT VARIABLES,  Up: install-tl

A.8 AUTHORS AND COPYRIGHT
=========================

This script and its documentation were written for the TeX Live
distribution (<http://tug.org/texlive>) and both are licensed under the
GNU General Public License Version 2 or later.

   $Id: install-tl 46908 2018-03-10 00:46:28Z preining $


File: tlbuild.info,  Node: tlmgr,  Next: Index,  Prev: install-tl,  Up: Top

Appendix B tlmgr
****************

* Menu:

* tlmgr NAME::
* tlmgr SYNOPSIS::
* tlmgr DESCRIPTION::
* tlmgr EXAMPLES::
* tlmgr OPTIONS::
* tlmgr ACTIONS::
* tlmgr CONFIGURATION FILE FOR TLMGR::
* tlmgr CRYPTOGRAPHIC VERIFICATION::
* tlmgr USER MODE::
* tlmgr MULTIPLE REPOSITORIES::
* tlmgr GUI FOR TLMGR::
* tlmgr MACHINE-READABLE OUTPUT::
* tlmgr AUTHORS AND COPYRIGHT::


File: tlbuild.info,  Node: tlmgr NAME,  Next: tlmgr SYNOPSIS,  Up: tlmgr

B.1 NAME
========

tlmgr - the native TeX Live Manager


File: tlbuild.info,  Node: tlmgr SYNOPSIS,  Next: tlmgr DESCRIPTION,  Prev: tlmgr NAME,  Up: tlmgr

B.2 SYNOPSIS
============

tlmgr [_option_...]  _action_ [_option_...]  [_operand_...]


File: tlbuild.info,  Node: tlmgr DESCRIPTION,  Next: tlmgr EXAMPLES,  Prev: tlmgr SYNOPSIS,  Up: tlmgr

B.3 DESCRIPTION
===============

*tlmgr* manages an existing TeX Live installation, both packages and
configuration options.  For information on initially downloading and
installing TeX Live, see <http://tug.org/texlive/acquire.html>.

   The most up-to-date version of this documentation (updated nightly
from the development sources) is available at
<http://tug.org/texlive/tlmgr.html>, along with procedures for updating
'tlmgr' itself and information about test versions.

   TeX Live is organized into a few top-level _schemes_, each of which
is specified as a different set of _collections_ and _packages_, where a
collection is a set of packages, and a package is what contains actual
files.  Schemes typically contain a mix of collections and packages, but
each package is included in exactly one collection, no more and no less.
A TeX Live installation can be customized and managed at any level.

   See <http://tug.org/texlive/doc> for all the TeX Live documentation
available.


File: tlbuild.info,  Node: tlmgr EXAMPLES,  Next: tlmgr OPTIONS,  Prev: tlmgr DESCRIPTION,  Up: tlmgr

B.4 EXAMPLES
============

After successfully installing TeX Live, here are a few common operations
with 'tlmgr':

'tlmgr option repository ctan'

'tlmgr option repository http://mirror.ctan.org/systems/texlive/tlnet'

     Tell 'tlmgr' to use a nearby CTAN mirror for future updates; useful
     if you installed TeX Live from the DVD image and want to have
     continuing updates.  The two commands are equivalent; 'ctan' is
     just an alias for the given url.  Caveat: 'mirror.ctan.org'
     resolves to many different hosts, and they are not perfectly
     synchronized; we recommend updating only daily (at most), and not
     more often.

'tlmgr update --list'

     Report what would be updated without actually updating anything.

'tlmgr update --all'

     Make your local TeX installation correspond to what is in the
     package repository (typically useful when updating from CTAN).

'tlmgr info' _what_

     Display detailed information about a package _what_, such as the
     installation status and description, of searches for _what_ in all
     packages.

   For all the capabilities and details of 'tlmgr', please read the
following voluminous information.


File: tlbuild.info,  Node: tlmgr OPTIONS,  Next: tlmgr ACTIONS,  Prev: tlmgr EXAMPLES,  Up: tlmgr

B.5 OPTIONS
===========

The following options to 'tlmgr' are global options, not specific to any
action.  All options, whether global or action-specific, can be given
anywhere on the command line, and in any order.  The first non-option
argument will be the main action.  In all cases, '--'_option_ and
'-'_option_ are equivalent, and an '=' is optional between an option
name and its value.

*-repository* _url|path_

     Specifies the package repository from which packages should be
     installed or updated, overriding the default package repository
     found in the installation's TeX Live Package Database (a.k.a.  the
     TLPDB, defined entirely in the file 'tlpkg/texlive.tlpdb').  The
     documentation for 'install-tl' has more details about this
     (<http://tug.org/texlive/doc/install-tl.html>).

     '--repository' changes the repository location only for the current
     run; to make a permanent change, use 'option repository' (see the
     *note option: tlmgr option. action).

     For backward compatibility and convenience, '--location' and
     '--repo' are accepted as aliases for this option.

*-gui* [_action_]

     'tlmgr' has a graphical interface as well as the command line
     interface.  You can give this option, '--gui', together with an
     action to be brought directly into the respective screen of the
     GUI. For example, running

       tlmgr --gui update

     starts you directly at the update screen.  If no action is given,
     the GUI will be started at the main screen.

*-gui-lang* _llcode_

     By default, the GUI tries to deduce your language from the
     environment (on Windows via the registry, on Unix via
     'LC_MESSAGES').  If that fails you can select a different language
     by giving this option with a language code (based on ISO 639-1).
     Currently supported (but not necessarily completely translated)
     are: English (en, default), Czech (cs), German (de), French (fr),
     Italian (it), Japanese (ja), Dutch (nl), Polish (pl), Brazilian
     Portuguese (pt_BR), Russian (ru), Slovak (sk), Slovenian (sl),
     Serbian (sr), Ukrainian (uk), Vietnamese (vi), simplified Chinese
     (zh_CN), and traditional Chinese (zh_TW).

*-debug-translation*

     In GUI mode, this switch tells 'tlmgr' to report any untranslated
     (or missing) messages to standard error.  This can help translators
     to see what remains to be done.

*-machine-readable*

     Instead of the normal output intended for human consumption, write
     (to standard output) a fixed format more suitable for machine
     parsing.  See the *note MACHINE-READABLE OUTPUT: tlmgr
     MACHINE-READABLE OUTPUT. section below.

*-no-execute-actions*

     Suppress the execution of the execute actions as defined in the
     tlpsrc files.  Documented only for completeness, as this is only
     useful in debugging.

*-package-logfile* _file_

     'tlmgr' logs all package actions (install, remove, update, failed
     updates, failed restores) to a separate log file, by default
     'TEXMFSYSVAR/web2c/tlmgr.log'.  This option allows you to specify a
     different file for the log.

*-pause*

     This option makes 'tlmgr' wait for user input before exiting.
     Useful on Windows to avoid disappearing command windows.

*-persistent-downloads*

*-no-persistent-downloads*

     For network-based installations, this option (on by default) makes
     'tlmgr' try to set up a persistent connection (using the 'LWP' Perl
     module).  The idea is to open and reuse only one connection per
     session between your computer and the server, instead of initiating
     a new download for each package.

     If this is not possible, 'tlmgr' will fall back to using 'wget'.
     To disable these persistent connections, use
     '--no-persistent-downloads'.

*-pin-file*

     Change the pinning file location from
     'TEXMFLOCAL/tlpkg/pinning.txt' (see *note Pinning: tlmgr Pinning.
     below).  Documented only for completeness, as this is only useful
     in debugging.

*-usermode*

     Activates user mode for this run of 'tlmgr'; see *note USER MODE:
     tlmgr USER MODE. below.

*-usertree* _dir_

     Uses _dir_ for the tree in user mode; see *note USER MODE: tlmgr
     USER MODE. below.

*-verify-repo=[none|main|all]*

     Defines the level of verification done: If 'none' is specified, no
     verification whatsoever is done.  If 'main' is given and a working
     GnuPG ('gpg') binary is available, all repositories are checked,
     but only the main repository is required to be signed.  If 'all' is
     given, then all repositories need to be signed.  See *note
     CRYPTOGRAPHIC VERIFICATION: tlmgr CRYPTOGRAPHIC VERIFICATION. below
     for details.

   The standard options for TeX Live programs are also accepted:
'--help/-h/-?', '--version', '-q' (no informational messages), '-v'
(debugging messages, can be repeated).  For the details about these, see
the 'TeXLive::TLUtils' documentation.

   The '--version' option shows version information about the TeX Live
release and about the 'tlmgr' script itself.  If '-v' is also given,
revision number for the loaded TeX Live Perl modules are shown, too.


File: tlbuild.info,  Node: tlmgr ACTIONS,  Next: tlmgr CONFIGURATION FILE FOR TLMGR,  Prev: tlmgr OPTIONS,  Up: tlmgr

B.6 ACTIONS
===========

* Menu:

* tlmgr help::
* tlmgr version::
* tlmgr backup::
* tlmgr candidates _pkg_::
* tlmgr check [_option_...] [files|depends|executes|runfiles|all]::
* tlmgr conf::
* tlmgr dump-tlpdb [_option_...] [--json]::
* tlmgr generate::
* tlmgr gui::
* tlmgr info::
* tlmgr init-usertree::
* tlmgr install [_option_...] _pkg_...::
* tlmgr key::
* tlmgr list::
* tlmgr option::
* tlmgr paper::
* tlmgr path::
* tlmgr pinning::
* tlmgr platform::
* tlmgr postaction::
* tlmgr print-platform::
* tlmgr print-platform-info::
* tlmgr remove [_option_...] _pkg_...::
* tlmgr repository::
* tlmgr restore::
* tlmgr search::
* tlmgr shell::
* tlmgr show::
* tlmgr uninstall::
* tlmgr update [_option_...] [_pkg_...]::


File: tlbuild.info,  Node: tlmgr help,  Next: tlmgr version,  Up: tlmgr ACTIONS

B.6.1 help
----------

Display this help information and exit (same as '--help', and on the web
at <http://tug.org/texlive/doc/tlmgr.html>).  Sometimes the 'perldoc'
and/or 'PAGER' programs on the system have problems, resulting in
control characters being literally output.  This can't always be
detected, but you can set the 'NOPERLDOC' environment variable and
'perldoc' will not be used.


File: tlbuild.info,  Node: tlmgr version,  Next: tlmgr backup,  Prev: tlmgr help,  Up: tlmgr ACTIONS

B.6.2 version
-------------

Gives version information (same as '--version').

   If '-v' has been given the revisions of the used modules are
reported, too.


File: tlbuild.info,  Node: tlmgr backup,  Next: tlmgr candidates _pkg_,  Prev: tlmgr version,  Up: tlmgr ACTIONS

B.6.3 backup
------------

*backup [_option_...] -all*

*backup [_option_...] _pkg_...*

     If the '--clean' option is not specified, this action makes a
     backup of the given packages, or all packages given '--all'.  These
     backups are saved to the value of the '--backupdir' option, if that
     is an existing and writable directory.  If '--backupdir' is not
     given, the 'backupdir' option setting in the TLPDB is used, if
     present.  If both are missing, no backups are made.

     If the '--clean' option is specified, backups are pruned (removed)
     instead of saved.  The optional integer value _N_ may be specified
     to set the number of backups that will be retained when cleaning.
     If 'N' is not given, the value of the 'autobackup' option is used.
     If both are missing, an error is issued.  For more details of
     backup pruning, see the 'option' action.

     Options:

     *-backupdir* _directory_

          Overrides the 'backupdir' option setting in the TLPDB. The
          _directory_ argument is required and must specify an existing,
          writable directory where backups are to be placed.

     *-all*

          If '--clean' is not specified, make a backup of all packages
          in the TeX Live installation; this will take quite a lot of
          space and time.  If '--clean' is specified, all packages are
          pruned.

     *-clean*[=_N_]

          Instead of making backups, prune the backup directory of old
          backups, as explained above.  The optional integer argument
          _N_ overrides the 'autobackup' option set in the TLPDB. You
          must use '--all' or a list of packages together with this
          option, as desired.

     *-dry-run*

          Nothing is actually backed up or removed; instead, the actions
          to be performed are written to the terminal.


File: tlbuild.info,  Node: tlmgr candidates _pkg_,  Next: tlmgr check [_option_...] [files|depends|executes|runfiles|all],  Prev: tlmgr backup,  Up: tlmgr ACTIONS

B.6.4 candidates _pkg_
----------------------

Shows the available candidate repositories for package _pkg_.  See *note
MULTIPLE REPOSITORIES: tlmgr MULTIPLE REPOSITORIES. below.


File: tlbuild.info,  Node: tlmgr check [_option_...] [files|depends|executes|runfiles|all],  Next: tlmgr conf,  Prev: tlmgr candidates _pkg_,  Up: tlmgr ACTIONS

B.6.5 check [_option_...] [files|depends|executes|runfiles|all]
---------------------------------------------------------------

Executes one (or all) check(s) on the consistency of the installation.

*files*

     Checks that all files listed in the local TLPDB ('texlive.tlpdb')
     are actually present, and lists those missing.

*depends*

     Lists those packages which occur as dependencies in an installed
     collection, but are themselves not installed, and those packages
     which are not contained in any collection.

     If you call 'tlmgr check collections' this test will be carried out
     instead since former versions for 'tlmgr' called it that way.

*executes*

     Check that the files referred to by 'execute' directives in the TeX
     Live Database are present.

*runfiles*

     List those filenames that are occurring more than one time in the
     runfiles sections.

   Options:

*-use-svn*

     Use the output of 'svn status' instead of listing the files; for
     checking the TL development repository.


File: tlbuild.info,  Node: tlmgr conf,  Next: tlmgr dump-tlpdb [_option_...] [--json],  Prev: tlmgr check [_option_...] [files|depends|executes|runfiles|all],  Up: tlmgr ACTIONS

B.6.6 conf
----------

*conf [texmf|tlmgr|updmap [-conffile _file_] [-delete] [_key_ [_value_]]]*

*conf auxtrees [-conffile _file_] [show|add|delete] [_value_]*

     With only 'conf', show general configuration information for TeX
     Live, including active configuration files, path settings, and
     more.  This is like running 'texconfig conf', but works on all
     supported platforms.

     With one of 'conf texmf', 'conf tlmgr', or 'conf updmap', shows all
     key/value pairs (i.e., all settings) as saved in 'ROOT/texmf.cnf',
     the user-specific 'tlmgr' configuration file (see below), or the
     first found (via 'kpsewhich') 'updmap.cfg' file, respectively.

     If _key_ is given in addition, shows the value of only that _key_
     in the respective file.  If option _-delete_ is also given, the
     value in the given configuration file is entirely removed (not just
     commented out).

     If _value_ is given in addition, _key_ is set to _value_ in the
     respective file.  _No error checking is done!_

     The 'PATH' value shown by 'conf' is as used by 'tlmgr'.  The
     directory in which the 'tlmgr' executable is found is automatically
     prepended to the PATH value inherited from the environment.

     Here is a practical example of changing configuration values.  If
     the execution of (some or all) system commands via '\write18' was
     left enabled during installation, you can disable it afterwards:

       tlmgr conf texmf shell_escape 0

     The subcommand 'auxtrees' allows adding and removing arbitrary
     additional texmf trees, completely under user control.  'auxtrees
     show' shows the list of additional trees, 'auxtrees add' _tree_
     adds a tree to the list, and 'auxtrees remove' _tree_ removes a
     tree from the list (if present).  The trees should not contain an
     'ls-R' file (or files might not be found if the 'ls-R' becomes
     stale).  This works by manipulating the Kpathsea variable
     'TEXMFAUXTREES', in 'ROOT/texmf.cnf'.  Example:

       tlmgr conf auxtrees add /quick/test/tree
       tlmgr conf auxtrees remove /quick/test/tree

     In all cases the configuration file can be explicitly specified via
     the option '--conffile' _file_, if desired.

     Warning: The general facility for changing configuration values is
     here, but tinkering with settings in this way is strongly
     discouraged.  Again, no error checking on either keys or values is
     done, so any sort of breakage is possible.


File: tlbuild.info,  Node: tlmgr dump-tlpdb [_option_...] [--json],  Next: tlmgr generate,  Prev: tlmgr conf,  Up: tlmgr ACTIONS

B.6.7 dump-tlpdb [_option_...] [-json]
--------------------------------------

Dump complete local or remote TLPDB to standard output, as-is.  The
output is analogous to the '--machine-readable' output; see *note
MACHINE-READABLE OUTPUT: tlmgr MACHINE-READABLE OUTPUT. section.

   Options:

*-local*

     Dump the local TLPDB.

*-remote*

     Dump the remote TLPDB.

*-json*

     Instead of dumping the actual content, the database is dumped as
     JSON. For the format of JSON output see
     'tlpkg/doc/JSON-formats.txt', format definition 'TLPDB'.

   Exactly one of '--local' and '--remote' must be given.

   In either case, the first line of the output specifies the repository
location, in this format:

  "location-url" "\t" location

   where 'location-url' is the literal field name, followed by a tab,
and _location_ is the file or url to the repository.

   Line endings may be either LF or CRLF depending on the current
platform.


File: tlbuild.info,  Node: tlmgr generate,  Next: tlmgr gui,  Prev: tlmgr dump-tlpdb [_option_...] [--json],  Up: tlmgr ACTIONS

B.6.8 generate
--------------

*generate [_option_...] language*

*generate [_option_...] language.dat*

*generate [_option_...] language.def*

*generate [_option_...] language.dat.lua*

   The 'generate' action overwrites any manual changes made in the
respective files: it recreates them from scratch based on the
information of the installed packages, plus local adaptions.  The TeX
Live installer and 'tlmgr' routinely call 'generate' for all of these
files.

   For managing your own fonts, please read the 'updmap --help'
information and/or <http://tug.org/fonts/fontinstall.html>.

   For managing your own formats, please read the 'fmtutil --help'
information.

   In more detail: 'generate' remakes any of the configuration files
'language.dat', 'language.def', and 'language.dat.lua' from the
information present in the local TLPDB, plus locally-maintained files.

   The locally-maintained files are 'language-local.dat',
'language-local.def', or 'language-local.dat.lua', searched for in
'TEXMFLOCAL' in the respective directories.  If local additions are
present, the final file is made by starting with the main file, omitting
any entries that the local file specifies to be disabled, and finally
appending the local file.

   (Historical note: The formerly supported 'updmap-local.cfg' and
'fmtutil-local.cnf' are no longer read, since 'updmap' and 'fmtutil' now
reads and supports multiple configuration files.  Thus, local additions
can and should be put into an 'updmap.cfg' of 'fmtutil.cnf' file in
'TEXMFLOCAL'.  The 'generate updmap' and 'generate fmtutil' actions no
longer exist.)

   Local files specify entries to be disabled with a comment line,
namely one of these:

  %!NAME
  --!NAME

   where 'language.dat' and 'language.def' use '%', and
'language.dat.lua' use '--'.  In all cases, the _name_ is the respective
format name or hyphenation pattern identifier.  Examples:

  %!german
  --!usenglishmax

   (Of course, you're not likely to actually want to disable those
particular items.  They're just examples.)

   After such a disabling line, the local file can include another entry
for the same item, if a different definition is desired.  In general,
except for the special disabling lines, the local files follow the same
syntax as the master files.

   The form 'generate language' recreates all three files
'language.dat', 'language.def', and 'language.dat.lua', while the forms
with an extension recreates only that given language file.

   Options:

*-dest* _output_file_

     specifies the output file (defaults to the respective location in
     'TEXMFSYSVAR').  If '--dest' is given to 'generate language', it
     serves as a basename onto which '.dat' will be appended for the
     name of the 'language.dat' output file, '.def' will be appended to
     the value for the name of the 'language.def' output file, and
     '.dat.lua' to the name of the 'language.dat.lua' file.  (This is
     just to avoid overwriting; if you want a specific name for each
     output file, we recommend invoking 'tlmgr' twice.)

*-localcfg* _local_conf_file_

     specifies the (optional) local additions (defaults to the
     respective location in 'TEXMFLOCAL').

*-rebuild-sys*

     tells 'tlmgr' to run necessary programs after config files have
     been regenerated.  These are: 'fmtutil-sys --all' after 'generate
     fmtutil', 'fmtutil-sys --byhyphen .../language.dat' after 'generate
     language.dat', and 'fmtutil-sys --byhyphen .../language.def' after
     'generate language.def'.

     These subsequent calls cause the newly-generated files to actually
     take effect.  This is not done by default since those calls are
     lengthy processes and one might want to made several related
     changes in succession before invoking these programs.

   The respective locations are as follows:

  tex/generic/config/language.dat (and language-local.dat)
  tex/generic/config/language.def (and language-local.def)
  tex/generic/config/language.dat.lua (and language-local.dat.lua)


File: tlbuild.info,  Node: tlmgr gui,  Next: tlmgr info,  Prev: tlmgr generate,  Up: tlmgr ACTIONS

B.6.9 gui
---------

Start the graphical user interface.  See *GUI* below.


File: tlbuild.info,  Node: tlmgr info,  Next: tlmgr init-usertree,  Prev: tlmgr gui,  Up: tlmgr ACTIONS

B.6.10 info
-----------

*info [_option_...] _pkg_...*

*info [_option_...] collections*

*info [_option_...] schemes*

     With no argument, lists all packages available at the package
     repository, prefixing those already installed with 'i'.

     With the single word 'collections' or 'schemes' as the argument,
     lists the request type instead of all packages.

     With any other arguments, display information about _pkg_: the
     name, category, short and long description, sizes, installation
     status, and TeX Live revision number.  If _pkg_ is not locally
     installed, searches in the remote installation source.

     For normal packages (not collections or schemes), the sizes of the
     four groups of files (run/src/doc/bin files) are shown separately.
     For collections, the cumulative size is shown, including all
     directly-dependent packages (but not dependent collections).  For
     schemes, the cumulative size is also shown, including all
     directly-dependent collections and packages.

     If _pkg_ is not found locally or remotely, the search action is
     used and lists matching packages and files.

     It also displays information taken from the TeX Catalogue, namely
     the package version, date, and license.  Consider these, especially
     the package version, as approximations only, due to timing skew of
     the updates of the different pieces.  By contrast, the 'revision'
     value comes directly from TL and is reliable.

     The former actions 'show' and 'list' are merged into this action,
     but are still supported for backward compatibility.

     Options:

     *-list*

          If the option '--list' is given with a package, the list of
          contained files is also shown, including those for
          platform-specific dependencies.  When given with schemes and
          collections, '--list' outputs their dependencies in a similar
          way.

     *-only-installed*

          If this option is given, the installation source will not be
          used; only locally installed packages, collections, or schemes
          are listed.

     *-data 'item1,item2,...'*

          If the option '--data' is given, its argument must be a comma
          separated list of field names from: 'name', 'category',
          'localrev', 'remoterev', 'shortdesc', 'longdesc', 'installed',
          'size', 'relocatable', 'depends', 'cat-version', 'cat-date',
          or 'cat-license'.  In this case the requested packages'
          information is listed in CSV format one package per line, and
          the column information is given by the 'itemN'.  The 'depends'
          column contains the name of all dependencies separated by ':'.

     *-json*

          In case '--json' is specified, the output is a JSON encoded
          array where each array element is the JSON representation of a
          single 'TLPOBJ' but with additional information.  For details
          see 'tlpkg/doc/JSON-formats.txt', format definition:
          'TLPOBJINFO'.  If both '--json' and '--data' are given,
          '--json' takes precedence.


File: tlbuild.info,  Node: tlmgr init-usertree,  Next: tlmgr install [_option_...] _pkg_...,  Prev: tlmgr info,  Up: tlmgr ACTIONS

B.6.11 init-usertree
--------------------

Sets up a texmf tree for so-called user mode management, either the
default user tree ('TEXMFHOME'), or one specified on the command line
with '--usertree'.  See *note USER MODE: tlmgr USER MODE. below.


File: tlbuild.info,  Node: tlmgr install [_option_...] _pkg_...,  Next: tlmgr key,  Prev: tlmgr init-usertree,  Up: tlmgr ACTIONS

B.6.12 install [_option_...] _pkg_...
-------------------------------------

Install each _pkg_ given on the command line, if it is not already
installed.  (It does not touch existing packages; see the 'update'
action for how to get the latest version of a package.)

   By default this also installs all packages on which the given _pkg_s
are dependent.  Options:

*-dry-run*

     Nothing is actually installed; instead, the actions to be performed
     are written to the terminal.

*-file*

     Instead of fetching a package from the installation repository, use
     the package files given on the command line.  These files must be
     standard TeX Live package files (with contained tlpobj file).

*-force*

     If updates to 'tlmgr' itself (or other parts of the basic
     infrastructure) are present, 'tlmgr' will bail out and not perform
     the installation unless this option is given.  Not recommended.

*-no-depends*

     Do not install dependencies.  (By default, installing a package
     ensures that all dependencies of this package are fulfilled.)

*-no-depends-at-all*

     Normally, when you install a package which ships binary files the
     respective binary package will also be installed.  That is, for a
     package 'foo', the package 'foo.i386-linux' will also be installed
     on an 'i386-linux' system.  This option suppresses this behavior,
     and also implies '--no-depends'.  Don't use it unless you are sure
     of what you are doing.

*-reinstall*

     Reinstall a package (including dependencies for collections) even
     if it already seems to be installed (i.e, is present in the TLPDB).
     This is useful to recover from accidental removal of files in the
     hierarchy.

     When re-installing, only dependencies on normal packages are
     followed (i.e., not those of category Scheme or Collection).

*-with-doc*

*-with-src*

     While not recommended, the 'install-tl' program provides an option
     to omit installation of all documentation and/or source files.  (By
     default, everything is installed.)  After such an installation, you
     may find that you want the documentation or source files for a
     given package after all.  You can get them by using these options
     in conjunction with '--reinstall', as in (using the 'fontspec'
     package as the example):

       tlmgr install --reinstall --with-doc --with-src fontspec


File: tlbuild.info,  Node: tlmgr key,  Next: tlmgr list,  Prev: tlmgr install [_option_...] _pkg_...,  Up: tlmgr ACTIONS

B.6.13 key
----------

*key list*

*key add _file_*

*key remove _keyid_*

     The action 'key' allows listing, adding and removing additional GPG
     keys to the set of trusted keys, that is, those that are used to
     verify the TeX Live databases.

     With the 'list' argument, 'key' lists all keys.

     The 'add' argument requires another argument, either a filename or
     '-' for stdin, from which the key is added.  The key is added to
     the local keyring 'GNUPGHOME/repository-keys.gpg', which is
     normally) 'tlpkg/gpg/repository-keys.gpg'.

     The 'remove' argument requires a key id and removes the requested
     id from the local keyring.


File: tlbuild.info,  Node: tlmgr list,  Next: tlmgr option,  Prev: tlmgr key,  Up: tlmgr ACTIONS

B.6.14 list
-----------

Synonym for *note info: tlmgr info.


File: tlbuild.info,  Node: tlmgr option,  Next: tlmgr paper,  Prev: tlmgr list,  Up: tlmgr ACTIONS

B.6.15 option
-------------

*option [-json] [show]*

*option [-json] showall*

*option _key_ [_value_]*

   The first form, 'show', shows the global TeX Live settings currently
saved in the TLPDB with a short description and the 'key' used for
changing it in parentheses.

   The second form, 'showall', is similar, but also shows options which
can be defined but are not currently set to any value.

   Both 'show...' forms take an option '--json', which dumps the option
information in JSON format.  In this case, both forms dump the same
data.  For the format of the JSON output see
'tlpkg/doc/JSON-formats.txt', format definition 'TLOPTION'.

   In the third form, with _key_, if _value_ is not given, the setting
for _key_ is displayed.  If _value_ is present, _key_ is set to _value_.

   Possible values for _key_ are (run 'tlmgr option showall' for the
definitive list):

 repository (default package repository),
 formats    (create formats at installation time),
 postcode   (run postinst code blobs)
 docfiles   (install documentation files),
 srcfiles   (install source files),
 backupdir  (default directory for backups),
 autobackup (number of backups to keep).
 sys_bin    (directory to which executables are linked by the path action)
 sys_man    (directory to which man pages are linked by the path action)
 sys_info   (directory to which Info files are linked by the path action)
 desktop_integration (Windows-only: create Start menu shortcuts)
 fileassocs (Windows-only: change file associations)
 multiuser  (Windows-only: install for all users)

   One common use of 'option' is to permanently change the installation
to get further updates from the Internet, after originally installing
from DVD. To do this, you can run

 tlmgr option repository http://mirror.ctan.org/systems/texlive/tlnet

   The 'install-tl' documentation has more information about the
possible values for 'repository'.  (For backward compatibility,
'location' can be used as a synonym for 'repository'.)

   If 'formats' is set (this is the default), then formats are
regenerated when either the engine or the format files have changed.
Disable this only when you know how and want to regenerate formats
yourself.

   The 'postcode' option controls execution of per-package
postinstallation action code.  It is set by default, and again disabling
is not likely to be of interest except to developers doing debugging.

   The 'docfiles' and 'srcfiles' options control the installation of
their respective file groups (documentation, sources; grouping is
approximate) per package.  By default both are enabled (1).  Either or
both can be disabled (set to 0) if disk space is limited or for minimal
testing installations, etc.  When disabled, the respective files are not
downloaded at all.

   The options 'autobackup' and 'backupdir' determine the defaults for
the actions 'update', 'backup' and 'restore'.  These three actions need
a directory in which to read or write the backups.  If '--backupdir' is
not specified on the command line, the 'backupdir' option value is used
(if set).

   The 'autobackup' option (de)activates automatic generation of
backups.  Its value is an integer.  If the 'autobackup' value is '-1',
no backups are removed.  If 'autobackup' is 0 or more, it specifies the
number of backups to keep.  Thus, backups are disabled if the value is
0.  In the '--clean' mode of the 'backup' action this option also
specifies the number to be kept.  The default value is 1, so that
backups are made, but only one backup is kept.

   To setup 'autobackup' to '-1' on the command line, use:

  tlmgr option -- autobackup -1

   The '--' avoids having the '-1' treated as an option.  (The '--'
stops parsing for options at the point where it appears; this is a
general feature across most Unix programs.)

   The 'sys_bin', 'sys_man', and 'sys_info' options are used on Unix
systems to control the generation of links for executables, Info files
and man pages.  See the 'path' action for details.

   The last three options affect behavior on Windows installations.  If
'desktop_integration' is set, then some packages will install items in a
sub-folder of the Start menu for 'tlmgr gui', documentation, etc.  If
'fileassocs' is set, Windows file associations are made (see also the
'postaction' action).  Finally, if 'multiuser' is set, then adaptions to
the registry and the menus are done for all users on the system instead
of only the current user.  All three options are on by default.


File: tlbuild.info,  Node: tlmgr paper,  Next: tlmgr path,  Prev: tlmgr option,  Up: tlmgr ACTIONS

B.6.16 paper
------------

*paper [a4|letter]*

*[xdvi|pdftex|dvips|dvipdfmx|context|psutils] paper [_papersize_|-list]*

*paper -json*

   With no arguments ('tlmgr paper'), shows the default paper size
setting for all known programs.

   With one argument (e.g., 'tlmgr paper a4'), sets the default for all
known programs to that paper size.

   With a program given as the first argument and no paper size
specified (e.g., 'tlmgr dvips paper'), shows the default paper size for
that program.

   With a program given as the first argument and a paper size as the
last argument (e.g., 'tlmgr dvips paper a4'), set the default for that
program to that paper size.

   With a program given as the first argument and '--list' given as the
last argument (e.g., 'tlmgr dvips paper --list'), shows all valid paper
sizes for that program.  The first size shown is the default.

   If '--json' is specified without other options, the paper setup is
dumped in JSON format.  For the format of JSON output see
'tlpkg/doc/JSON-formats.txt', format definition 'TLPAPER'.

   Incidentally, this syntax of having a specific program name before
the 'paper' keyword is unusual.  It is inherited from the longstanding
'texconfig' script, which supports other configuration settings for some
programs, notably 'dvips'.  'tlmgr' does not support those extra
settings.


File: tlbuild.info,  Node: tlmgr path,  Next: tlmgr pinning,  Prev: tlmgr paper,  Up: tlmgr ACTIONS

B.6.17 path
-----------

*path [-w32mode=user|admin] add*

*path [-w32mode=user|admin] remove*

     On Unix, merely adds or removes symlinks for binaries, man pages,
     and info pages in the system directories specified by the
     respective options (see the *note option: tlmgr option. description
     above).  Does not change any initialization files, either system or
     personal.

     On Windows, the registry part where the binary directory is added
     or removed is determined in the following way:

     If the user has admin rights, and the option '--w32mode' is not
     given, the setting _w32_multi_user_ determines the location (i.e.,
     if it is on then the system path, otherwise the user path is
     changed).

     If the user has admin rights, and the option '--w32mode' is given,
     this option determines the path to be adjusted.

     If the user does not have admin rights, and the option '--w32mode'
     is not given, and the setting _w32_multi_user_ is off, the user
     path is changed, while if the setting _w32_multi_user_ is on, a
     warning is issued that the caller does not have enough privileges.

     If the user does not have admin rights, and the option '--w32mode'
     is given, it must be 'user' and the user path will be adjusted.  If
     a user without admin rights uses the option '--w32mode admin' a
     warning is issued that the caller does not have enough privileges.


File: tlbuild.info,  Node: tlmgr pinning,  Next: tlmgr platform,  Prev: tlmgr path,  Up: tlmgr ACTIONS

B.6.18 pinning
--------------

The 'pinning' action manages the pinning file, see *note Pinning: tlmgr
Pinning. below.

'pinning show'

     Shows the current pinning data.

'pinning add' _repo_ _pkgglob_...

     Pins the packages matching the _pkgglob_(s) to the repository
     _repo_.

'pinning remove' _repo_ _pkgglob_...

     Any packages recorded in the pinning file matching the <pkgglob>s
     for the given repository _repo_ are removed.

'pinning remove _repo_ --all'

     Remove all pinning data for repository _repo_.


File: tlbuild.info,  Node: tlmgr platform,  Next: tlmgr postaction,  Prev: tlmgr pinning,  Up: tlmgr ACTIONS

B.6.19 platform
---------------

*platform list|add|remove _platform_...*

*platform set _platform_*

*platform set auto*

     'platform list' lists the TeX Live names of all the platforms
     (a.k.a.  architectures), ('i386-linux', ...)  available at the
     package repository.

     'platform add' _platform_...  adds the executables for each given
     platform _platform_ to the installation from the repository.

     'platform remove' _platform_...  removes the executables for each
     given platform _platform_ from the installation, but keeps the
     currently running platform in any case.

     'platform set' _platform_ switches TeX Live to always use the given
     platform instead of auto detection.

     'platform set auto' switches TeX Live to auto detection mode for
     platform.

     Platform detection is needed to select the proper 'xz', 'xzdec' and
     'wget' binaries that are shipped with TeX Live.

     'arch' is a synonym for 'platform'.

     Options:

     *-dry-run*

          Nothing is actually installed; instead, the actions to be
          performed are written to the terminal.


File: tlbuild.info,  Node: tlmgr postaction,  Next: tlmgr print-platform,  Prev: tlmgr platform,  Up: tlmgr ACTIONS

B.6.20 postaction
-----------------

*postaction [_option_...] install [shortcut|fileassoc|script] [_pkg_...]*

*postaction [_option_...] remove [shortcut|fileassoc|script] [_pkg_...]*

     Carry out the postaction 'shortcut', 'fileassoc', or 'script' given
     as the second required argument in install or remove mode (which is
     the first required argument), for either the packages given on the
     command line, or for all if '--all' is given.

     Options:

     *-w32mode=[user|admin]*

          If the option '--w32mode' is given the value 'user', all
          actions will only be carried out in the user-accessible parts
          of the registry/filesystem, while the value 'admin' selects
          the system-wide parts of the registry for the file
          associations.  If you do not have enough permissions, using
          '--w32mode=admin' will not succeed.

     *-fileassocmode=[1|2]*

          '--fileassocmode' specifies the action for file associations.
          If it is set to 1 (the default), only new associations are
          added; if it is set to 2, all associations are set to the TeX
          Live programs.  (See also 'option fileassocs'.)

     *-all*

          Carry out the postactions for all packages


File: tlbuild.info,  Node: tlmgr print-platform,  Next: tlmgr print-platform-info,  Prev: tlmgr postaction,  Up: tlmgr ACTIONS

B.6.21 print-platform
---------------------

Print the TeX Live identifier for the detected platform
(hardware/operating system) combination to standard output, and exit.
'--print-arch' is a synonym.


File: tlbuild.info,  Node: tlmgr print-platform-info,  Next: tlmgr remove [_option_...] _pkg_...,  Prev: tlmgr print-platform,  Up: tlmgr ACTIONS

B.6.22 print-platform-info
--------------------------

Print the TeX Live platform identifier, TL platform long name, and
original output from guess.


File: tlbuild.info,  Node: tlmgr remove [_option_...] _pkg_...,  Next: tlmgr repository,  Prev: tlmgr print-platform-info,  Up: tlmgr ACTIONS

B.6.23 remove [_option_...] _pkg_...
------------------------------------

Remove each _pkg_ specified.  Removing a collection removes all package
dependencies (unless '--no-depends' is specified), but not any
collection dependencies of that collection.  However, when removing a
package, dependencies are never removed.  Options:

*-all*

     Uninstalls all of TeX Live, asking for confirmation unless
     '--force' is also specified.

*-backup*

*-backupdir* _directory_

     These options behave just as with the *note update: (update)tlmgr
     update [_option_...] [...]. action (q.v.), except they apply to
     making backups of packages before they are removed.  The default is
     to make such a backup, that is, to save a copy of packages before
     removal.

     The *note restore: tlmgr restore. action explains how to restore
     from a backup.

*-no-depends*

     Do not remove dependent packages.

*-no-depends-at-all*

     See above under *note install: tlmgr install [_option_...] _pkg_...
     (and beware).

*-force*

     By default, removal of a package or collection that is a dependency
     of another collection or scheme is not allowed.  With this option,
     the package will be removed unconditionally.  Use with care.

     A package that has been removed using the '--force' option because
     it is still listed in an installed collection or scheme will not be
     updated, and will be mentioned as 'forcibly removed' in the output
     of 'tlmgr update --list'.

*-dry-run*

     Nothing is actually removed; instead, the actions to be performed
     are written to the terminal.


File: tlbuild.info,  Node: tlmgr repository,  Next: tlmgr restore,  Prev: tlmgr remove [_option_...] _pkg_...,  Up: tlmgr ACTIONS

B.6.24 repository
-----------------

*repository list*

*repository list _path|tag_*

*repository add _path_ [_tag_]*

*repository remove _path|tag_*

*repository set _path_[#_tag_] [_path_[#_tag_] ...]*

     This action manages the list of repositories.  See *note
     (MULTIPLE_REPOSITORIES):: below for detailed explanations.

     The first form ('list') lists all configured repositories and the
     respective tags if set.  If a path, url, or tag is given after the
     'list' keyword, it is interpreted as source from where to
     initialize a TeX Live Database and lists the contained packages.
     This can also be an up-to-now not used repository, both locally and
     remote.  If one pass in addition '--with-platforms', for each
     package the available platforms (if any) are listed, too.

     The third form ('add') adds a repository (optionally attaching a
     tag) to the list of repositories.  The forth form ('remove')
     removes a repository, either by full path/url, or by tag.  The last
     form ('set') sets the list of repositories to the items given on
     the command line, not keeping previous settings

     In all cases, one of the repositories must be tagged as 'main';
     otherwise, all operations will fail!


File: tlbuild.info,  Node: tlmgr restore,  Next: tlmgr search,  Prev: tlmgr repository,  Up: tlmgr ACTIONS

B.6.25 restore
--------------

*restore [_option_...] _pkg_ [_rev_]*

*restore [_option_...] -all*

     Restore a package from a previously-made backup.

     If '--all' is given, try to restore the latest revision of all
     package backups found in the backup directory.

     Otherwise, if neither _pkg_ nor _rev_ are given, list the available
     backup revisions for all packages.  With _pkg_ given but no _rev_,
     list all available backup revisions of _pkg_.

     When listing available packages, 'tlmgr' shows the revision, and in
     parenthesis the creation time if available (in format yyyy-mm-dd
     hh:mm).

     If (and only if) both _pkg_ and a valid revision number _rev_ are
     specified, try to restore the package from the specified backup.

     Options:

     *-all*

          Try to restore the latest revision of all package backups
          found in the backup directory.  Additional non-option
          arguments (like _pkg_) are not allowed.

     *-backupdir* _directory_

          Specify the directory where the backups are to be found.  If
          not given it will be taken from the configuration setting in
          the TLPDB.

     *-dry-run*

          Nothing is actually restored; instead, the actions to be
          performed are written to the terminal.

     *-force*

          Don't ask questions.

     *-json*

          When listing backups, the option '--json' turn on JSON output.
          The format is an array of JSON objects ('name', 'rev',
          'date').  For details see 'tlpkg/doc/JSON-formats.txt', format
          definition: 'TLBACKUPS'.  If both '--json' and '--data' are
          given, '--json' takes precedence.


File: tlbuild.info,  Node: tlmgr search,  Next: tlmgr shell,  Prev: tlmgr restore,  Up: tlmgr ACTIONS

B.6.26 search
-------------

*search [_option_...] _what_*

*search [_option_...] -file _what_*

*search [_option_...] -all _what_*

     By default, search the names, short descriptions, and long
     descriptions of all locally installed packages for the argument
     _what_, interpreted as a (Perl) regular expression.

     Options:

     *-file*

          List all filenames containing _what_.

     *-all*

          Search everything: package names, descriptions and filenames.

     *-global*

          Search the TeX Live Database of the installation medium,
          instead of the local installation.

     *-word*

          Restrict the search of package names and descriptions (but not
          filenames) to match only full words.  For example, searching
          for 'table' with this option will not output packages
          containing the word 'tables' (unless they also contain the
          word 'table' on its own).


File: tlbuild.info,  Node: tlmgr shell,  Next: tlmgr show,  Prev: tlmgr search,  Up: tlmgr ACTIONS

B.6.27 shell
------------

Starts an interactive mode, where tlmgr prompts for commands.  This can
be used directly, or for scripting.  The first line of output is
'protocol' _n_, where _n_ is an unsigned number identifying the protocol
version (currently 1).

   In general, tlmgr actions that can be given on the command line
translate to commands in this shell mode.  For example, you can say
'update --list' to see what would be updated.  The TLPDB is loaded the
first time it is needed (not at the beginning), and used for the rest of
the session.

   Besides these actions, a few commands are specific to shell mode:

protocol

     Print 'protocol _n_', the current protocol version.

help

     Print pointers to this documentation.

version

     Print tlmgr version information.

quit, end, bye, byebye, EOF

     Exit.

restart

     Restart 'tlmgr shell' with the original command line; most useful
     when developing 'tlmgr'.

load [local|remote]

     Explicitly load the local or remote, respectively, TLPDB.

save

     Save the local TLPDB, presumably after other operations have
     changed it.

get [_var_] =item set [_var_ [_val_]]

     Get the value of _var_, or set it to _val_.  Possible _var_ names:
     'debug-translation', 'machine-readable', 'no-execute-actions',
     'require-verification', 'verify-downloads', 'repository', and
     'prompt'.  All except 'repository' and 'prompt' are booleans,
     taking values 0 and 1, and behave like the corresponding command
     line option.  The 'repository' variable takes a string, and sets
     the remote repository location.  The 'prompt' variable takes a
     string, and sets the current default prompt.

     If _var_ or then _val_ is not specified, it is prompted for.


File: tlbuild.info,  Node: tlmgr show,  Next: tlmgr uninstall,  Prev: tlmgr shell,  Up: tlmgr ACTIONS

B.6.28 show
-----------

Synonym for *note info: tlmgr info.


File: tlbuild.info,  Node: tlmgr uninstall,  Next: tlmgr update [_option_...] [_pkg_...],  Prev: tlmgr show,  Up: tlmgr ACTIONS

B.6.29 uninstall
----------------

Synonym for *note remove: tlmgr remove [_option_...] _pkg_....


File: tlbuild.info,  Node: tlmgr update [_option_...] [_pkg_...],  Prev: tlmgr uninstall,  Up: tlmgr ACTIONS

B.6.30 update [_option_...] [_pkg_...]
--------------------------------------

Updates the packages given as arguments to the latest version available
at the installation source.  Either '--all' or at least one _pkg_ name
must be specified.  Options:

*-all*

     Update all installed packages except for 'tlmgr' itself.  Thus, if
     updates to 'tlmgr' itself are present, this will simply give an
     error, unless also the option '--force' or '--self' is given.  (See
     below.)

     In addition to updating the installed packages, during the update
     of a collection the local installation is (by default) synchronized
     to the status of the collection on the server, for both additions
     and removals.

     This means that if a package has been removed on the server (and
     thus has also been removed from the respective collection), 'tlmgr'
     will remove the package in the local installation.  This is called
     "auto-remove" and is announced as such when using the option
     '--list'.  This auto-removal can be suppressed using the option
     '--no-auto-remove' (not recommended, see option description).

     Analogously, if a package has been added to a collection on the
     server that is also installed locally, it will be added to the
     local installation.  This is called "auto-install" and is announced
     as such when using the option '--list'.  This auto-installation can
     be suppressed using the option '--no-auto-install'.

     An exception to the collection dependency checks (including the
     auto-installation of packages just mentioned) are those that have
     been "forcibly removed" by you, that is, you called 'tlmgr remove
     --force' on them.  (See the 'remove' action documentation.)  To
     reinstall any such forcibly removed packages use
     '--reinstall-forcibly-removed'.

     If you want to exclude some packages from the current update run
     (e.g., due to a slow link), see the '--exclude' option below.

*-self*

     Update 'tlmgr' itself (that is, the infrastructure packages) if
     updates to it are present.  On Windows this includes updates to the
     private Perl interpreter shipped inside TeX Live.

     If this option is given together with either '--all' or a list of
     packages, then 'tlmgr' will be updated first and, if this update
     succeeds, the new version will be restarted to complete the rest of
     the updates.

     In short:

       tlmgr update --self        # update infrastructure only
       tlmgr update --self --all  # update infrastructure and all packages
       tlmgr update --force --all # update all packages but *not* infrastructure
                                  # ... this last at your own risk, not recommended!

*-dry-run*

     Nothing is actually installed; instead, the actions to be performed
     are written to the terminal.  This is a more detailed report than
     '--list'.

*-list* [_pkg_]

     Concisely list the packages which would be updated, newly
     installed, or removed, without actually changing anything.  If
     '--all' is also given, all available updates are listed.  If
     '--self' is given, but not '--all', only updates to the critical
     packages (tlmgr, texlive infrastructure, perl on Windows, etc.)
     are listed.  If neither '--all' nor '--self' is given, and in
     addition no _pkg_ is given, then '--all' is assumed (thus, 'tlmgr
     update --list' is the same as 'tlmgr update --list --all').  If
     neither '--all' nor '--self' is given, but specific package names
     are given, those packages are checked for updates.

*-exclude* _pkg_

     Exclude _pkg_ from the update process.  If this option is given
     more than once, its arguments accumulate.

     An argument _pkg_ excludes both the package _pkg_ itself and all
     its related platform-specific packages _pkg.ARCH_. For example,

       tlmgr update --all --exclude a2ping

     will not update 'a2ping', 'a2ping.i386-linux', or any other
     'a2ping.'_ARCH_ package.

     If this option specifies a package that would otherwise be a
     candidate for auto-installation, auto-removal, or reinstallation of
     a forcibly removed package, 'tlmgr' quits with an error message.
     Excludes are not supported in these circumstances.

     This option can also be set permanently in the tlmgr config file
     with the key 'update-exclude'.

*-no-auto-remove* [_pkg_...]

     By default, 'tlmgr' tries to remove packages which have disappeared
     on the server, as described above under '--all'.  This option
     prevents such removals, either for all packages (with '--all'), or
     for just the given _pkg_ names.  This can lead to an inconsistent
     TeX installation, since packages are not infrequently renamed or
     replaced by their authors.  Therefore this is not recommend.

*-no-auto-install* [_pkg_...]

     Under normal circumstances 'tlmgr' will install packages which are
     new on the server, as described above under '--all'.  This option
     prevents any such automatic installation, either for all packages
     (with '--all'), or the given _pkg_ names.

     Furthermore, after the 'tlmgr' run using this has finished, the
     packages that would have been auto-installed _will be considered as
     forcibly removed_.  So, if 'foobar' is the only new package on the
     server, then

       tlmgr update --all --no-auto-install

     is equivalent to

       tlmgr update --all
       tlmgr remove --force foobar

*-reinstall-forcibly-removed*

     Under normal circumstances 'tlmgr' will not install packages that
     have been forcibly removed by the user; that is, removed with
     'remove --force', or whose installation was prohibited by
     '--no-auto-install' during an earlier update.

     This option makes 'tlmgr' ignore the forcible removals and
     re-install all such packages.  This can be used to completely
     synchronize an installation with the server's idea of what is
     available:

       tlmgr update --reinstall-forcibly-removed --all

*-backup*

*-backupdir* _directory_

     These two options control the creation of backups of packages
     _before_ updating; that is, backup of packages as currently
     installed.  If neither options is given, no backup will made.  If
     '--backupdir' is given and specifies a writable directory then a
     backup will be made in that location.  If only '--backup' is given,
     then a backup will be made to the directory previously set via the
     *note option: tlmgr option. action (see below).  If both are given
     then a backup will be made to the specified _directory_.

     You can also set options via the *note option: tlmgr option. action
     to automatically make backups for all packages, and/or keep only a
     certain number of backups.

     'tlmgr' always makes a temporary backup when updating packages, in
     case of download or other failure during an update.  In contrast,
     the purpose of this '--backup' option is to save a persistent
     backup in case the actual _content_ of the update causes problems,
     e.g., introduces an TeX incompatibility.

     The *note restore: tlmgr restore. action explains how to restore
     from a backup.

*-no-depends*

     If you call for updating a package normally all depending packages
     will also be checked for updates and updated if necessary.  This
     switch suppresses this behavior.

*-no-depends-at-all*

     See above under *note install: tlmgr install [_option_...] _pkg_...
     (and beware).

*-force*

     Force update of normal packages, without updating 'tlmgr' itself
     (unless the '--self' option is also given).  Not recommended.

     Also, 'update --list' is still performed regardless of this option.

   If the package on the server is older than the package already
installed (e.g., if the selected mirror is out of date), 'tlmgr' does
not downgrade.  Also, packages for uninstalled platforms are not
installed.

   'tlmgr' saves a copy of the 'texlive.tlpdb' file used for an update
with a suffix representing the repository url, as in
'tlpkg/texlive.tlpdb.'_long-hash-string_.  These can be useful for
fallback information, but if you don't like them accumulating (e.g.,
'mirror.ctan.org' resolves to many different hosts, each resulting in a
possibly different hash), it's harmless to delete them.


File: tlbuild.info,  Node: tlmgr CONFIGURATION FILE FOR TLMGR,  Next: tlmgr CRYPTOGRAPHIC VERIFICATION,  Prev: tlmgr ACTIONS,  Up: tlmgr

B.7 CONFIGURATION FILE FOR TLMGR
================================

There are two configuration files for 'tlmgr': One is system-wide in
'TEXMFSYSCONFIG/tlmgr/config', and the other is user-specific in
'TEXMFCONFIG/tlmgr/config'.  The user-specific one is the default for
the 'conf tlmgr' action.  (Run 'kpsewhich -var-value=TEXMFSYSCONFIG' or
'... TEXMFCONFIG ...' to see the actual directory names.)

   A few defaults corresponding to command-line options can be set in
these configuration files.  In addition, the system-wide file can
contain a directive to restrict the allowed actions.

   In these config files, empty lines and lines starting with # are
ignored.  All other lines must look like:

  key = value

   where the spaces are optional but the '=' is required.

   The allowed keys are:

'auto-remove', value 0 or 1 (default 1), same as command-line option.

'gui-expertmode', value 0 or 1 (default 1). This switches between the full GUI and a simplified GUI with only the most common settings.

'gui-lang' _llcode_, with a language code value as with the command-line option.

'no-checksums', value 0 or 1 (default 0, see below).

'persistent-downloads', value 0 or 1 (default 1), same as command-line option.

'require-verification', value 0 or 1 (default 0), same as command-line option.

'update-exclude', value: comma-separated list of packages (no space allowed). Same as the command line option '--exclude' for the action 'update'.

'verify-downloads', value 0 or 1 (default 1), same as command-line option.

   The system-wide config file can contain one additional key:

'allowed-actions' _action1_ [,_action_,...] The value is a comma-separated list of 'tlmgr' actions which are allowed to be executed when 'tlmgr' is invoked in system mode (that is, without '--usermode').

     This allows distributors to include the 'tlmgr' in their packaging,
     but allow only a restricted set of actions that do not interfere
     with their distro package manager.  For native TeX Live
     installations, it doesn't make sense to set this.

   The 'no-checksums' key needs more explanation.  By default, package
checksums computed and stored on the server (in the TLPDB) are compared
to checksums computed locally after downloading.  'no-checksums'
disables this process.

   The checksum algorithm is SHA-512.  Your system must have one of
(looked for in this order) the Perl 'Digest::SHA' module, the 'openssl'
program (<http://openssl.org>), the 'sha512sum' program (from GNU
Coreutils, <http://www.gnu.org/software/coreutils>), or finally the
'shasum' program (just to support old Macs).  If none of these are
available, a warning is issued and 'tlmgr' proceeds without checking
checksums.  (Incidentally, other SHA implementations, such as the pure
Perl and pure Lua modules, are much too slow to be usable in our
context.)  'no-checksums' avoids the warning.


File: tlbuild.info,  Node: tlmgr CRYPTOGRAPHIC VERIFICATION,  Next: tlmgr USER MODE,  Prev: tlmgr CONFIGURATION FILE FOR TLMGR,  Up: tlmgr

B.8 CRYPTOGRAPHIC VERIFICATION
==============================

'tlmgr' and 'install-tl' perform cryptographic verification if possible.
If verification is performed and successful, the programs report
'(verified)' after loading the TLPDB; otherwise, they report '(not
verified)'.  But either way, by default the installation and/or updates
proceed normally.

   If a program named 'gpg' is available (that is, found in 'PATH'), by
default cryptographic signatures will be checked: we require the main
repository be signed, but not any additional repositories.  If 'gpg' is
not available, by default signatures are not checked and no verification
is carried out, but 'tlmgr' still proceeds normally.

   The behavior of the verification can be controlled by the command
line and config file option 'verify-repo' which takes one of the
following values: 'none', 'main', or 'all'.  With 'none', no
verification whatsoever is attempted.  With 'main' (the default)
verification is required only for the main repository, and only if 'gpg'
is available; though attempted for all, missing signatures of subsidiary
repositories will not result in an error.  Finally, in the case of
'all', 'gpg' must be available and all repositories need to be signed.

   In all cases, if a signature is checked and fails to verify, an error
is raised.

   Cryptographic verification requires checksum checking (described just
above) to succeed, and a working GnuPG ('gpg') program (see below for
search method).  Then, unless cryptographic verification has been
disabled, a signature file ('texlive.tlpdb.*.asc') of the checksum file
is downloaded and the signature verified.  The signature is created by
the TeX Live Distribution GPG key 0x06BAB6BC, which in turn is signed by
Karl Berry's key 0x30D155AD and Norbert Preining's key 0x6CACA448.  All
of these keys are obtainable from the standard key servers.

   Additional trusted keys can be added using the 'key' action.

* Menu:

* tlmgr Configuration of GnuPG invocation::


File: tlbuild.info,  Node: tlmgr Configuration of GnuPG invocation,  Up: tlmgr CRYPTOGRAPHIC VERIFICATION

B.8.1 Configuration of GnuPG invocation
---------------------------------------

The executable used for GnuPG is searched as follows: If the environment
variable 'TL_GNUPG' is set, it is tested and used; otherwise 'gpg' is
checked; finally 'gpg2' is checked.

   Further adaptation of the 'gpg' invocation can be made using the two
environment variables 'TL_GNUPGHOME', which is passed to 'gpg' as the
value for '--homedir', and 'TL_GNUPGARGS', which replaces the default
options '--no-secmem-warning --no-permission-warning'.


File: tlbuild.info,  Node: tlmgr USER MODE,  Next: tlmgr MULTIPLE REPOSITORIES,  Prev: tlmgr CRYPTOGRAPHIC VERIFICATION,  Up: tlmgr

B.9 USER MODE
=============

'tlmgr' provides a restricted way, called "user mode", to manage
arbitrary texmf trees in the same way as the main installation.  For
example, this allows people without write permissions on the
installation location to update/install packages into a tree of their
own.

   'tlmgr' is switched into user mode with the command line option
'--usermode'.  It does not switch automatically, nor is there any
configuration file setting for it.  Thus, this option has to be
explicitly given every time user mode is to be activated.

   This mode of 'tlmgr' works on a user tree, by default the value of
the 'TEXMFHOME' variable.  This can be overridden with the command line
option '--usertree'.  In the following when we speak of the user tree we
mean either 'TEXMFHOME' or the one given on the command line.

   Not all actions are allowed in user mode; 'tlmgr' will warn you and
not carry out any problematic actions.  Currently not supported (and
probably will never be) is the 'platform' action.  The 'gui' action is
currently not supported, but may be in a future release.

   Some 'tlmgr' actions don't need any write permissions and thus work
the same in user mode and normal mode.  Currently these are: 'check',
'help', 'list', 'print-platform', 'print-platform-info', 'search',
'show', 'version'.

   On the other hand, most of the actions dealing with package
management do need write permissions, and thus behave differently in
user mode, as described below: 'install', 'update', 'remove', 'option',
'paper', 'generate', 'backup', 'restore', 'uninstall', 'symlinks'.

   Before using 'tlmgr' in user mode, you have to set up the user tree
with the 'init-usertree' action.  This creates _usertree_'/web2c' and
_usertree_'/tlpkg/tlpobj', and a minimal
_usertree_'/tlpkg/texlive.tlpdb'.  At that point, you can tell 'tlmgr'
to do the (supported) actions by adding the '--usermode' command line
option.

   In user mode the file _usertree_'/tlpkg/texlive.tlpdb' contains only
the packages that have been installed into the user tree using 'tlmgr',
plus additional options from the "virtual" package
'00texlive.installation' (similar to the main installation's
'texlive.tlpdb').

   All actions on packages in user mode can only be carried out on
packages that are known as 'relocatable'.  This excludes all packages
containing executables and a few other core packages.  Of the 2500 or so
packages currently in TeX Live the vast majority are relocatable and can
be installed into a user tree.

   Description of changes of actions in user mode:

* Menu:

* tlmgr User mode install::
* tlmgr User mode backup, restore, remove, update::
* tlmgr User mode generate, option, paper::


File: tlbuild.info,  Node: tlmgr User mode install,  Next: tlmgr User mode backup, restore, remove, update,  Up: tlmgr USER MODE

B.9.1 User mode install
-----------------------

In user mode, the 'install' action checks that the package and all
dependencies are all either relocated or already installed in the system
installation.  If this is the case, it unpacks all containers to be
installed into the user tree (to repeat, that's either 'TEXMFHOME' or
the value of '--usertree') and add the respective packages to the user
tree's 'texlive.tlpdb' (creating it if need be).

   Currently installing a collection in user mode installs all dependent
packages, but in contrast to normal mode, does _not_ install dependent
collections.  For example, in normal mode 'tlmgr install
collection-context' would install 'collection-basic' and other
collections, while in user mode, _only_ the packages mentioned in
'collection-context' are installed.

   If a package shipping map files is installed in user mode, a backup
of the user's 'updmap.cfg' in 'USERTREE/web2c/' is made, and then this
file regenerated from the list of installed packages.


File: tlbuild.info,  Node: tlmgr User mode backup, restore, remove, update,  Next: tlmgr User mode generate, option, paper,  Prev: tlmgr User mode install,  Up: tlmgr USER MODE

B.9.2 User mode backup, restore, remove, update
-----------------------------------------------

In user mode, these actions check that all packages to be acted on are
installed in the user tree before proceeding; otherwise, they behave
just as in normal mode.


File: tlbuild.info,  Node: tlmgr User mode generate, option, paper,  Prev: tlmgr User mode backup, restore, remove, update,  Up: tlmgr USER MODE

B.9.3 User mode generate, option, paper
---------------------------------------

In user mode, these actions operate only on the user tree's
configuration files and/or 'texlive.tlpdb'.  creates configuration files
in user tree


File: tlbuild.info,  Node: tlmgr MULTIPLE REPOSITORIES,  Next: tlmgr GUI FOR TLMGR,  Prev: tlmgr USER MODE,  Up: tlmgr

B.10 MULTIPLE REPOSITORIES
==========================

The main TeX Live repository contains a vast array of packages.
Nevertheless, additional local repositories can be useful to provide
locally-installed resources, such as proprietary fonts and house styles.
Also, alternative package repositories distribute packages that cannot
or should not be included in TeX Live, for whatever reason.

   The simplest and most reliable method is to temporarily set the
installation source to any repository (with the '-repository' or 'option
repository' command line options), and perform your operations.

   When you are using multiple repositories over a sustained length of
time, however, explicitly switching between them becomes inconvenient.
Thus, it's possible to tell 'tlmgr' about additional repositories you
want to use.  The basic command is 'tlmgr repository add'.  The rest of
this section explains further.

   When using multiple repositories, one of them has to be set as the
main repository, which distributes most of the installed packages.  When
you switch from a single repository installation to a multiple
repository installation, the previous sole repository will be set as the
main repository.

   By default, even if multiple repositories are configured, packages
are _still_ _only_ installed from the main repository.  Thus, simply
adding a second repository does not actually enable installation of
anything from there.  You also have to specify which packages should be
taken from the new repository, by specifying so-called "pinning" rules,
described next.

* Menu:

* tlmgr Pinning::


File: tlbuild.info,  Node: tlmgr Pinning,  Up: tlmgr MULTIPLE REPOSITORIES

B.10.1 Pinning
--------------

When a package 'foo' is pinned to a repository, a package 'foo' in any
other repository, even if it has a higher revision number, will not be
considered an installable candidate.

   As mentioned above, by default everything is pinned to the main
repository.  Let's now go through an example of setting up a second
repository and enabling updates of a package from it.

   First, check that we have support for multiple repositories, and have
only one enabled (as is the case by default):

 $ tlmgr repository list
 List of repositories (with tags if set):
   /var/www/norbert/tlnet

   Ok.  Let's add the 'tlcontrib' repository (this is a real repository,
hosted at <http://tlcontrib.metatex.org>, maintained by Taco Hoekwater
et al.), with the tag 'tlcontrib':

 $ tlmgr repository add http://tlcontrib.metatex.org/2012 tlcontrib

   Check the repository list again:

 $ tlmgr repository list
 List of repositories (with tags if set):
    http://tlcontrib.metatex.org/2012 (tlcontrib)
    /var/www/norbert/tlnet (main)

   Now we specify a pinning entry to get the package 'context' from
'tlcontrib':

 $ tlmgr pinning add tlcontrib context

   Check that we can find 'context':

 $ tlmgr show context
 tlmgr: package repositories:
 ...
 package:     context
 repository:  tlcontrib/26867
 ...

   - install 'context':

 $ tlmgr install context
 tlmgr: package repositories:
 ...
 [1/1,  ??:??/??:??] install: context @tlcontrib [

   In the output here you can see that the 'context' package has been
installed from the 'tlcontrib' repository ('@tlcontrib').

   Finally, 'tlmgr pinning' also supports removing certain or all
packages from a given repository:

  $ tlmgr pinning remove tlcontrib context  # remove just context
  $ tlmgr pinning remove tlcontrib --all    # take nothing from tlcontrib

   A summary of the 'tlmgr pinning' actions is given above.


File: tlbuild.info,  Node: tlmgr GUI FOR TLMGR,  Next: tlmgr MACHINE-READABLE OUTPUT,  Prev: tlmgr MULTIPLE REPOSITORIES,  Up: tlmgr

B.11 GUI FOR TLMGR
==================

The graphical user interface for 'tlmgr' requires Perl/Tk
<http://search.cpan.org/search?query=perl%2Ftk>.  For Windows the
necessary modules are shipped within TeX Live, for all other (i.e.,
Unix-based) systems Perl/Tk (as well as Perl of course) has to be
installed outside of TL. <http://tug.org/texlive/distro.html#perltk> has
a list of invocations for some distros.

   The GUI is started with the invocation 'tlmgr gui'; assuming Tk is
loadable, the graphical user interface will be shown.  The main window
contains a menu bar, the main display, and a status area where messages
normally shown on the console are displayed.

   Within the main display there are three main parts: the 'Display
configuration' area, the list of packages, and the action buttons.

   Also, at the top right the currently loaded repository is shown; this
also acts as a button and when clicked will try to load the default
repository.  To load a different repository, see the 'tlmgr' menu item.

   Finally, the status area at the bottom of the window gives additional
information about what is going on.

* Menu:

* tlmgr Main display::
* tlmgr Menu bar::
* tlmgr GUI options::


File: tlbuild.info,  Node: tlmgr Main display,  Next: tlmgr Menu bar,  Up: tlmgr GUI FOR TLMGR

B.11.1 Main display
-------------------

* Menu:

* tlmgr Display configuration area::
* tlmgr Package list area::
* tlmgr Main display action buttons::


File: tlbuild.info,  Node: tlmgr Display configuration area,  Next: tlmgr Package list area,  Up: tlmgr Main display

B.11.1.1 Display configuration area
...................................

The first part of the main display allows you to specify (filter) which
packages are shown.  By default, all are shown.  Changes here are
reflected right away.

Status

     Select whether to show all packages (the default), only those
     installed, only those _not_ installed, or only those with update
     available.

Category

     Select which categories are shown: packages, collections, and/or
     schemes.  These are briefly explained in the *note DESCRIPTION:
     tlmgr DESCRIPTION. section above.

Match

     Select packages matching for a specific pattern.  By default, this
     searches both descriptions and filenames.  You can also select a
     subset for searching.

Selection

     Select packages to those selected, those not selected, or all.
     Here, "selected" means that the checkbox in the beginning of the
     line of a package is ticked.

Display configuration buttons

     To the right there are three buttons: select all packages, select
     none (a.k.a.  deselect all), and reset all these filters to the
     defaults, i.e., show all available.


File: tlbuild.info,  Node: tlmgr Package list area,  Next: tlmgr Main display action buttons,  Prev: tlmgr Display configuration area,  Up: tlmgr Main display

B.11.1.2 Package list area
..........................

The second are of the main display lists all installed packages.  If a
repository is loaded, those that are available but not installed are
also listed.

   Double clicking on a package line pops up an informational window
with further details: the long description, included files, etc.

   Each line of the package list consists of the following items:

a checkbox

     Used to select particular packages; some of the action buttons (see
     below) work only on the selected packages.

package name

     The name (identifier) of the package as given in the database.

local revision (and version)

     If the package is installed the TeX Live revision number for the
     installed package will be shown.  If there is a catalogue version
     given in the database for this package, it will be shown in
     parentheses.  However, the catalogue version, unlike the TL
     revision, is not guaranteed to reflect what is actually installed.

remote revision (and version)

     If a repository has been loaded the revision of the package in the
     repository (if present) is shown.  As with the local column, if a
     catalogue version is provided it will be displayed.  And also as
     with the local column, the catalogue version may be stale.

short description

     The short description of the package.


File: tlbuild.info,  Node: tlmgr Main display action buttons,  Prev: tlmgr Package list area,  Up: tlmgr Main display

B.11.1.3 Main display action buttons
....................................

Below the list of packages are several buttons:

Update all installed

     This calls 'tlmgr update --all', i.e., tries to update all
     available packages.  Below this button is a toggle to allow
     reinstallation of previously removed packages as part of this
     action.

     The other four buttons only work on the selected packages, i.e.,
     those where the checkbox at the beginning of the package line is
     ticked.

Update

     Update only the selected packages.

Install

     Install the selected packages; acts like 'tlmgr install', i.e.,
     also installs dependencies.  Thus, installing a collection installs
     all its constituent packages.

Remove

     Removes the selected packages; acts like 'tlmgr remove', i.e., it
     will also remove dependencies of collections (but not dependencies
     of normal packages).

Backup

     Makes a backup of the selected packages; acts like 'tlmgr backup'.
     This action needs the option 'backupdir' set (see 'Options -'
     General>).


File: tlbuild.info,  Node: tlmgr Menu bar,  Next: tlmgr GUI options,  Prev: tlmgr Main display,  Up: tlmgr GUI FOR TLMGR

B.11.2 Menu bar
---------------

The following entries can be found in the menu bar:

'tlmgr' menu

     The items here load various repositories: the default as specified
     in the TeX Live database, the default network repository, the
     repository specified on the command line (if any), and an
     arbitrarily manually-entered one.  Also has the so-necessary 'quit'
     operation.

'Options menu'

     Provides access to several groups of options: 'Paper'
     (configuration of default paper sizes), 'Platforms' (only on Unix,
     configuration of the supported/installed platforms), 'GUI Language'
     (select language used in the GUI interface), and 'General'
     (everything else).

     Several toggles are also here.  The first is 'Expert options',
     which is set by default.  If you turn this off, the next time you
     start the GUI a simplified screen will be shown that display only
     the most important functionality.  This setting is saved in the
     configuration file of 'tlmgr'; see *note CONFIGURATION FILE FOR
     TLMGR: tlmgr CONFIGURATION FILE FOR TLMGR. for details.

     The other toggles are all off by default: for debugging output, to
     disable the automatic installation of new packages, and to disable
     the automatic removal of packages deleted from the server.  Playing
     with the choices of what is or isn't installed may lead to an
     inconsistent TeX Live installation; e.g., when a package is
     renamed.

'Actions menu'

     Provides access to several actions: update the filename database
     (aka 'ls-R', 'mktexlsr', 'texhash'), rebuild all formats
     ('fmtutil-sys --all'), update the font map database ('updmap-sys'),
     restore from a backup of a package, and use of symbolic links in
     system directories (not on Windows).

     The final action is to remove the entire TeX Live installation
     (also not on Windows).

'Help menu'

     Provides access to the TeX Live manual (also on the web at
     <http://tug.org/texlive/doc.html>) and the usual "About" box.


File: tlbuild.info,  Node: tlmgr GUI options,  Prev: tlmgr Menu bar,  Up: tlmgr GUI FOR TLMGR

B.11.3 GUI options
------------------

Some generic Perl/Tk options can be specified with 'tlmgr gui' to
control the display:

'-background' _color_

     Set background color.

'-font "' _fontname_ _fontsize_ '"'

     Set font, e.g., 'tlmgr gui -font "helvetica 18"'.  The argument to
     '-font' must be quoted, i.e., passed as a single string.

'-foreground' _color_

     Set foreground color.

'-geometry' _geomspec_

     Set the X geometry, e.g., 'tlmgr gui -geometry 1024x512-0+0'
     creates the window of (approximately) the given size in the
     upper-right corner of the display.

'-xrm' _xresource_

     Pass the arbitrary X resource string _xresource_.

   A few other obscure options are recognized but not mentioned here.
See the Perl/Tk documentation (<http://search.cpan.org/perldoc?Tk>) for
the complete list, and any X documentation for general information.


File: tlbuild.info,  Node: tlmgr MACHINE-READABLE OUTPUT,  Next: tlmgr AUTHORS AND COPYRIGHT,  Prev: tlmgr GUI FOR TLMGR,  Up: tlmgr

B.12 MACHINE-READABLE OUTPUT
============================

With the '--machine-readable' option, 'tlmgr' writes to stdout in the
fixed line-oriented format described here, and the usual informational
messages for human consumption are written to stderr (normally they are
written to stdout).  The idea is that a program can get all the
information it needs by reading stdout.

   Currently this option only applies to the *note update: tlmgr update
[_option_...] [_pkg_...], *note install: tlmgr install [_option_...]
_pkg_..., and *note option: tlmgr option. actions.

* Menu:

* tlmgr Machine-readable update and install output::
* tlmgr Machine-readable option output::


File: tlbuild.info,  Node: tlmgr Machine-readable update and install output,  Next: tlmgr Machine-readable option output,  Up: tlmgr MACHINE-READABLE OUTPUT

B.12.1 Machine-readable 'update' and 'install' output
-----------------------------------------------------

The output format is as follows:

  fieldname "\t" value
  ...
  "end-of-header"
  pkgname status localrev serverrev size runtime esttot
  ...
  "end-of-updates"
  other output from post actions, not in machine readable form

   The header section currently has two fields: 'location-url' (the
repository source from which updates are being drawn), and 'total-bytes'
(the total number of bytes to be downloaded).

   The _localrev_ and _serverrev_ fields for each package are the
revision numbers in the local installation and server repository,
respectively.  The _size_ field is the number of bytes to be downloaded,
i.e., the size of the compressed tar file for a network installation,
not the unpacked size.  The runtime and esttot fields are only present
for updated and auto-install packages, and contain the currently passed
time since start of installation/updates and the estimated total time.

   Line endings may be either LF or CRLF depending on the current
platform.

'location-url' _location_

     The _location_ may be a url (including 'file:///foo/bar/...'), or a
     directory name ('/foo/bar').  It is the package repository from
     which the new package information was drawn.

'total-bytes' _count_

     The _count_ is simply a decimal number, the sum of the sizes of all
     the packages that need updating or installing (which are listed
     subsequently).

   Then comes a line with only the literal string 'end-of-header'.

   Each following line until a line with literal string 'end-of-updates'
reports on one package.  The fields on each line are separated by a tab.
Here are the fields.

_pkgname_

     The TeX Live package identifier, with a possible platform suffix
     for executables.  For instance, 'pdftex' and 'pdftex.i386-linux'
     are given as two separate packages, one on each line.

_status_

     The status of the package update.  One character, as follows:

     'd'

          The package was removed on the server.

     'f'

          The package was removed in the local installation, even though
          a collection depended on it.  (E.g., the user ran 'tlmgr
          remove --force'.)

     'u'

          Normal update is needed.

     'r'

          Reversed non-update: the locally-installed version is newer
          than the version on the server.

     'a'

          Automatically-determined need for installation, the package is
          new on the server and is (most probably) part of an installed
          collection.

     'i'

          Package will be installed and isn't present in the local
          installation (action install).

     'I'

          Package is already present but will be reinstalled (action
          install).

_localrev_

     The revision number of the installed package, or '-' if it is not
     present locally.

_serverrev_

     The revision number of the package on the server, or '-' if it is
     not present on the server.

_size_

     The size in bytes of the package on the server.  The sum of all the
     package sizes is given in the 'total-bytes' header field mentioned
     above.

_runtime_

     The run time since start of installations or updates.

_esttot_

     The estimated total time.


File: tlbuild.info,  Node: tlmgr Machine-readable option output,  Prev: tlmgr Machine-readable update and install output,  Up: tlmgr MACHINE-READABLE OUTPUT

B.12.2 Machine-readable 'option' output
---------------------------------------

The output format is as follows:

  key "\t" value

   If a value is not saved in the database the string '(not set)' is
shown.

   If you are developing a program that uses this output, and find that
changes would be helpful, do not hesitate to write the mailing list.


File: tlbuild.info,  Node: tlmgr AUTHORS AND COPYRIGHT,  Prev: tlmgr MACHINE-READABLE OUTPUT,  Up: tlmgr

B.13 AUTHORS AND COPYRIGHT
==========================

This script and its documentation were written for the TeX Live
distribution (<http://tug.org/texlive>) and both are licensed under the
GNU General Public License Version 2 or later.

   $Id: tlmgr.pl 47303 2018-04-05 17:52:22Z karl $


File: tlbuild.info,  Node: Index,  Prev: tlmgr,  Up: Top

Index
*****