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
|
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="Docutils 0.21.2: https://docutils.sourceforge.io/" />
<title>Configuration Files</title>
<link rel="stylesheet" href="../style.css" type="text/css" />
</head>
<body>
<div class="document" id="configuration-files">
<span id="topic-config"></span>
<h1 class="title">Configuration Files</h1>
<div class="contents htmlonly topic" id="contents">
<p class="topic-title"><a class="reference internal" href="#top">Contents</a></p>
<ul class="simple">
<li><a class="reference internal" href="#troubleshooting" id="toc-entry-1">Troubleshooting</a></li>
<li><a class="reference internal" href="#structure" id="toc-entry-2">Structure</a></li>
<li><a class="reference internal" href="#files" id="toc-entry-3">Files</a></li>
<li><a class="reference internal" href="#syntax" id="toc-entry-4">Syntax</a></li>
<li><a class="reference internal" href="#sections" id="toc-entry-5">Sections</a><ul>
<li><a class="reference internal" href="#alias" id="toc-entry-6"><tt class="docutils literal">alias</tt></a></li>
<li><a class="reference internal" href="#annotate" id="toc-entry-7"><tt class="docutils literal">annotate</tt></a></li>
<li><a class="reference internal" href="#auth" id="toc-entry-8"><tt class="docutils literal">auth</tt></a></li>
<li><a class="reference internal" href="#censor" id="toc-entry-9"><tt class="docutils literal">censor</tt></a></li>
<li><a class="reference internal" href="#cmdserver" id="toc-entry-10"><tt class="docutils literal">cmdserver</tt></a></li>
<li><a class="reference internal" href="#color" id="toc-entry-11"><tt class="docutils literal">color</tt></a></li>
<li><a class="reference internal" href="#commands" id="toc-entry-12"><tt class="docutils literal">commands</tt></a></li>
<li><a class="reference internal" href="#committemplate" id="toc-entry-13"><tt class="docutils literal">committemplate</tt></a></li>
<li><a class="reference internal" href="#decode-encode" id="toc-entry-14"><tt class="docutils literal">decode/encode</tt></a></li>
<li><a class="reference internal" href="#defaults" id="toc-entry-15"><tt class="docutils literal">defaults</tt></a></li>
<li><a class="reference internal" href="#diff" id="toc-entry-16"><tt class="docutils literal">diff</tt></a></li>
<li><a class="reference internal" href="#email" id="toc-entry-17"><tt class="docutils literal">email</tt></a></li>
<li><a class="reference internal" href="#extensions" id="toc-entry-18"><tt class="docutils literal">extensions</tt></a></li>
<li><a class="reference internal" href="#format" id="toc-entry-19"><tt class="docutils literal">format</tt></a></li>
<li><a class="reference internal" href="#graph" id="toc-entry-20"><tt class="docutils literal">graph</tt></a></li>
<li><a class="reference internal" href="#hooks" id="toc-entry-21"><tt class="docutils literal">hooks</tt></a></li>
<li><a class="reference internal" href="#hostfingerprints" id="toc-entry-22"><tt class="docutils literal">hostfingerprints</tt></a></li>
<li><a class="reference internal" href="#hostsecurity" id="toc-entry-23"><tt class="docutils literal">hostsecurity</tt></a></li>
<li><a class="reference internal" href="#http-proxy" id="toc-entry-24"><tt class="docutils literal">http_proxy</tt></a></li>
<li><a class="reference internal" href="#http" id="toc-entry-25"><tt class="docutils literal">http</tt></a></li>
<li><a class="reference internal" href="#merge" id="toc-entry-26"><tt class="docutils literal">merge</tt></a></li>
<li><a class="reference internal" href="#merge-patterns" id="toc-entry-27"><tt class="docutils literal"><span class="pre">merge-patterns</span></tt></a></li>
<li><a class="reference internal" href="#merge-tools" id="toc-entry-28"><tt class="docutils literal"><span class="pre">merge-tools</span></tt></a></li>
<li><a class="reference internal" href="#pager" id="toc-entry-29"><tt class="docutils literal">pager</tt></a></li>
<li><a class="reference internal" href="#patch" id="toc-entry-30"><tt class="docutils literal">patch</tt></a></li>
<li><a class="reference internal" href="#paths" id="toc-entry-31"><tt class="docutils literal">paths</tt></a></li>
<li><a class="reference internal" href="#phases" id="toc-entry-32"><tt class="docutils literal">phases</tt></a></li>
<li><a class="reference internal" href="#profiling" id="toc-entry-33"><tt class="docutils literal">profiling</tt></a></li>
<li><a class="reference internal" href="#progress" id="toc-entry-34"><tt class="docutils literal">progress</tt></a></li>
<li><a class="reference internal" href="#rebase" id="toc-entry-35"><tt class="docutils literal">rebase</tt></a></li>
<li><a class="reference internal" href="#revsetalias" id="toc-entry-36"><tt class="docutils literal">revsetalias</tt></a></li>
<li><a class="reference internal" href="#rewrite" id="toc-entry-37"><tt class="docutils literal">rewrite</tt></a></li>
<li><a class="reference internal" href="#rhg" id="toc-entry-38"><tt class="docutils literal">rhg</tt></a></li>
<li><a class="reference internal" href="#share" id="toc-entry-39"><tt class="docutils literal">share</tt></a></li>
<li><a class="reference internal" href="#storage" id="toc-entry-40"><tt class="docutils literal">storage</tt></a></li>
<li><a class="reference internal" href="#server" id="toc-entry-41"><tt class="docutils literal">server</tt></a></li>
<li><a class="reference internal" href="#smtp" id="toc-entry-42"><tt class="docutils literal">smtp</tt></a></li>
<li><a class="reference internal" href="#subpaths" id="toc-entry-43"><tt class="docutils literal">subpaths</tt></a></li>
<li><a class="reference internal" href="#subrepos" id="toc-entry-44"><tt class="docutils literal">subrepos</tt></a></li>
<li><a class="reference internal" href="#templatealias" id="toc-entry-45"><tt class="docutils literal">templatealias</tt></a></li>
<li><a class="reference internal" href="#templates" id="toc-entry-46"><tt class="docutils literal">templates</tt></a></li>
<li><a class="reference internal" href="#trusted" id="toc-entry-47"><tt class="docutils literal">trusted</tt></a></li>
<li><a class="reference internal" href="#ui" id="toc-entry-48"><tt class="docutils literal">ui</tt></a></li>
<li><a class="reference internal" href="#usage" id="toc-entry-49"><tt class="docutils literal">usage</tt></a></li>
<li><a class="reference internal" href="#command-templates" id="toc-entry-50"><tt class="docutils literal"><span class="pre">command-templates</span></tt></a></li>
<li><a class="reference internal" href="#web" id="toc-entry-51"><tt class="docutils literal">web</tt></a></li>
<li><a class="reference internal" href="#websub" id="toc-entry-52"><tt class="docutils literal">websub</tt></a></li>
<li><a class="reference internal" href="#worker" id="toc-entry-53"><tt class="docutils literal">worker</tt></a></li>
</ul>
</li>
</ul>
</div>
<p id="hgrc"><span id="config"></span>The Mercurial system uses a set of configuration files to control
aspects of its behavior.</p>
<div class="section" id="troubleshooting">
<h1><a class="toc-backref" href="#contents">Troubleshooting</a></h1>
<p>If you're having problems with your configuration,
<a class="reference external" href="hg-config.html"><tt class="docutils literal">hg config <span class="pre">--source</span></tt></a> can help you understand what is introducing
a setting into your environment.</p>
<p>See <a class="reference external" href="hgrc.5.html#syntax"><tt class="docutils literal">hg help config.syntax</tt></a> and <a class="reference external" href="hgrc.5.html#files"><tt class="docutils literal">hg help config.files</tt></a>
for information about how and where to override things.</p>
</div>
<div class="section" id="structure">
<h1><a class="toc-backref" href="#contents">Structure</a></h1>
<p>The configuration files use a simple ini-file format. A configuration
file consists of sections, led by a <tt class="docutils literal">[section]</tt> header and followed
by <tt class="docutils literal">name = value</tt> entries:</p>
<pre class="literal-block">
[ui]
username = Firstname Lastname <firstname.lastname@example.net>
verbose = True
</pre>
<p>The above entries will be referred to as <tt class="docutils literal">ui.username</tt> and
<tt class="docutils literal">ui.verbose</tt>, respectively. See <a class="reference external" href="hgrc.5.html#syntax"><tt class="docutils literal">hg help config.syntax</tt></a>.</p>
</div>
<div class="section" id="files">
<h1><a class="toc-backref" href="#contents">Files</a></h1>
<p>Mercurial reads configuration data from several files, if they exist.
These files do not exist by default and you will have to create the
appropriate configuration files yourself:</p>
<p>Local configuration is put into the per-repository <tt class="docutils literal"><span class="pre"><repo>/.hg/hgrc</span></tt> file.</p>
<p>Global configuration like the username setting is typically put into:</p>
<div class="windows docutils container">
<ul class="simple">
<li><tt class="docutils literal"><span class="pre">%USERPROFILE%\mercurial.ini</span></tt> (on Windows)</li>
</ul>
</div>
<div class="unix-plan9 docutils container">
<ul class="simple">
<li><tt class="docutils literal"><span class="pre">$HOME/.hgrc</span></tt> (on Unix, Plan9)</li>
</ul>
</div>
<p>The names of these files depend on the system on which Mercurial is
installed. <tt class="docutils literal">*.rc</tt> files from a single directory are read in
alphabetical order, later ones overriding earlier ones. Where multiple
paths are given below, settings from earlier paths override later
ones.</p>
<div class="verbose-unix docutils container">
<p>On Unix, the following files are consulted:</p>
<ul class="simple">
<li><tt class="docutils literal"><span class="pre"><repo>/.hg/hgrc-not-shared</span></tt> (per-repository)</li>
<li><tt class="docutils literal"><span class="pre"><repo>/.hg/hgrc</span></tt> (per-repository)</li>
<li><tt class="docutils literal"><span class="pre">$HOME/.hgrc</span></tt> (per-user)</li>
<li><tt class="docutils literal"><span class="pre">${XDG_CONFIG_HOME:-$HOME/.config}/hg/hgrc</span></tt> (per-user)</li>
<li><tt class="docutils literal"><span class="pre"><install-root>/etc/mercurial/hgrc</span></tt> (per-installation)</li>
<li><tt class="docutils literal"><span class="pre"><install-root>/etc/mercurial/hgrc.d/*.rc</span></tt> (per-installation)</li>
<li><tt class="docutils literal">/etc/mercurial/hgrc</tt> (per-system)</li>
<li><tt class="docutils literal"><span class="pre">/etc/mercurial/hgrc.d/*.rc</span></tt> (per-system)</li>
<li><tt class="docutils literal"><span class="pre"><internal>/*.rc</span></tt> (defaults)</li>
</ul>
</div>
<div class="verbose-windows docutils container">
<p>On Windows, the following files are consulted:</p>
<ul class="simple">
<li><tt class="docutils literal"><span class="pre"><repo>/.hg/hgrc-not-shared</span></tt> (per-repository)</li>
<li><tt class="docutils literal"><span class="pre"><repo>/.hg/hgrc</span></tt> (per-repository)</li>
<li><tt class="docutils literal"><span class="pre">%USERPROFILE%\.hgrc</span></tt> (per-user)</li>
<li><tt class="docutils literal"><span class="pre">%USERPROFILE%\Mercurial.ini</span></tt> (per-user)</li>
<li><tt class="docutils literal"><span class="pre">%HOME%\.hgrc</span></tt> (per-user)</li>
<li><tt class="docutils literal"><span class="pre">%HOME%\Mercurial.ini</span></tt> (per-user)</li>
<li><tt class="docutils literal">HKEY_LOCAL_MACHINE\SOFTWARE\Mercurial</tt> (per-system)</li>
<li><tt class="docutils literal"><span class="pre"><install-dir>\hgrc.d\*.rc</span></tt> (per-installation)</li>
<li><tt class="docutils literal"><span class="pre"><install-dir>\Mercurial.ini</span></tt> (per-installation)</li>
<li><tt class="docutils literal"><span class="pre">%PROGRAMDATA%\Mercurial\hgrc</span></tt> (per-system)</li>
<li><tt class="docutils literal"><span class="pre">%PROGRAMDATA%\Mercurial\Mercurial.ini</span></tt> (per-system)</li>
<li><tt class="docutils literal"><span class="pre">%PROGRAMDATA%\Mercurial\hgrc.d\*.rc</span></tt> (per-system)</li>
<li><tt class="docutils literal"><span class="pre"><internal>/*.rc</span></tt> (defaults)</li>
</ul>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">The registry key <tt class="docutils literal">HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Mercurial</tt>
is used when running 32-bit Python on 64-bit Windows.</p>
</div>
</div>
<div class="verbose-plan9 docutils container">
<p>On Plan9, the following files are consulted:</p>
<ul class="simple">
<li><tt class="docutils literal"><span class="pre"><repo>/.hg/hgrc-not-shared</span></tt> (per-repository)</li>
<li><tt class="docutils literal"><span class="pre"><repo>/.hg/hgrc</span></tt> (per-repository)</li>
<li><tt class="docutils literal">$home/lib/hgrc</tt> (per-user)</li>
<li><tt class="docutils literal"><span class="pre"><install-root>/lib/mercurial/hgrc</span></tt> (per-installation)</li>
<li><tt class="docutils literal"><span class="pre"><install-root>/lib/mercurial/hgrc.d/*.rc</span></tt> (per-installation)</li>
<li><tt class="docutils literal">/lib/mercurial/hgrc</tt> (per-system)</li>
<li><tt class="docutils literal"><span class="pre">/lib/mercurial/hgrc.d/*.rc</span></tt> (per-system)</li>
<li><tt class="docutils literal"><span class="pre"><internal>/*.rc</span></tt> (defaults)</li>
</ul>
</div>
<p>Per-repository configuration options only apply in a
particular repository. This file is not version-controlled, and
will not get transferred during a "clone" operation. Options in
this file override options in all other configuration files.</p>
<div class="unix-plan9 docutils container">
On Plan 9 and Unix, most of this file will be ignored if it doesn't
belong to a trusted user or to a trusted group. See
<a class="reference external" href="hgrc.5.html#trusted"><tt class="docutils literal">hg help config.trusted</tt></a> for more details.</div>
<p>Per-user configuration file(s) are for the user running Mercurial. Options
in these files apply to all Mercurial commands executed by this user in any
directory. Options in these files override per-system and per-installation
options.</p>
<p>Per-installation configuration files are searched for in the
directory where Mercurial is installed. <tt class="docutils literal"><span class="pre"><install-root></span></tt> is the
parent directory of the <strong>hg</strong> executable (or symlink) being run.</p>
<div class="unix-plan9 docutils container">
For example, if installed in <tt class="docutils literal">/shared/tools/bin/hg</tt>, Mercurial
will look in <tt class="docutils literal">/shared/tools/etc/mercurial/hgrc</tt>. Options in these
files apply to all Mercurial commands executed by any user in any
directory.</div>
<p>Per-installation configuration files are for the system on
which Mercurial is running. Options in these files apply to all
Mercurial commands executed by any user in any directory. Registry
keys contain PATH-like strings, every part of which must reference
a <tt class="docutils literal">Mercurial.ini</tt> file or be a directory where <tt class="docutils literal">*.rc</tt> files will
be read. Mercurial checks each of these locations in the specified
order until one or more configuration files are detected.</p>
<p>Per-system configuration files are for the system on which Mercurial
is running. Options in these files apply to all Mercurial commands
executed by any user in any directory. Options in these files
override per-installation options.</p>
<p>Mercurial comes with some default configuration. The default configuration
files are installed with Mercurial and will be overwritten on upgrades. Default
configuration files should never be edited by users or administrators but can
be overridden in other configuration files. So far the directory only contains
merge tool configuration but packagers can also put other default configuration
there.</p>
<p>On versions 5.7 and later, if share-safe functionality is enabled,
shares will read config file of share source too.
<cite><share-source/.hg/hgrc></cite> is read before reading <cite><repo/.hg/hgrc></cite>.</p>
<p>For configs which should not be shared, <cite><repo/.hg/hgrc-not-shared></cite>
should be used.</p>
</div>
<div class="section" id="syntax">
<h1><a class="toc-backref" href="#contents">Syntax</a></h1>
<p>A configuration file consists of sections, led by a <tt class="docutils literal">[section]</tt> header
and followed by <tt class="docutils literal">name = value</tt> entries (sometimes called
<tt class="docutils literal">configuration keys</tt>):</p>
<pre class="literal-block">
[spam]
eggs=ham
green=
eggs
</pre>
<p>Each line contains one entry. If the lines that follow are indented,
they are treated as continuations of that entry. Leading whitespace is
removed from values. Empty lines are skipped. Lines beginning with
<tt class="docutils literal">#</tt> or <tt class="docutils literal">;</tt> are ignored and may be used to provide comments.</p>
<p>Configuration keys can be set multiple times, in which case Mercurial
will use the value that was configured last. As an example:</p>
<pre class="literal-block">
[spam]
eggs=large
ham=serrano
eggs=small
</pre>
<p>This would set the configuration key named <tt class="docutils literal">eggs</tt> to <tt class="docutils literal">small</tt>.</p>
<p>It is also possible to define a section multiple times. A section can
be redefined on the same and/or on different configuration files. For
example:</p>
<pre class="literal-block">
[foo]
eggs=large
ham=serrano
eggs=small
[bar]
eggs=ham
green=
eggs
[foo]
ham=prosciutto
eggs=medium
bread=toasted
</pre>
<p>This would set the <tt class="docutils literal">eggs</tt>, <tt class="docutils literal">ham</tt>, and <tt class="docutils literal">bread</tt> configuration keys
of the <tt class="docutils literal">foo</tt> section to <tt class="docutils literal">medium</tt>, <tt class="docutils literal">prosciutto</tt>, and <tt class="docutils literal">toasted</tt>,
respectively. As you can see there only thing that matters is the last
value that was set for each of the configuration keys.</p>
<p>If a configuration key is set multiple times in different
configuration files the final value will depend on the order in which
the different configuration files are read, with settings from earlier
paths overriding later ones as described on the <tt class="docutils literal">Files</tt> section
above.</p>
<p>A line of the form <tt class="docutils literal">%include file</tt> will include <tt class="docutils literal">file</tt> into the
current configuration file. The inclusion is recursive, which means
that included files can include other files. Filenames are relative to
the configuration file in which the <tt class="docutils literal">%include</tt> directive is found.
Environment variables and <tt class="docutils literal">~user</tt> constructs are expanded in
<tt class="docutils literal">file</tt>. This lets you do something like:</p>
<pre class="literal-block">
%include ~/.hgrc.d/$HOST.rc
</pre>
<p>to include a different configuration file on each computer you use.</p>
<p>A line with <tt class="docutils literal">%unset name</tt> will remove <tt class="docutils literal">name</tt> from the current
section, if it has been set previously.</p>
<p>The values are either free-form text strings, lists of text strings,
or Boolean values. Boolean values can be set to true using any of "1",
"yes", "true", or "on" and to false using "0", "no", "false", or "off"
(all case insensitive).</p>
<p>List values are separated by whitespace or comma, except when values are
placed in double quotation marks:</p>
<pre class="literal-block">
allow_read = "John Doe, PhD", brian, betty
</pre>
<p>Quotation marks can be escaped by prefixing them with a backslash. Only
quotation marks at the beginning of a word is counted as a quotation
(e.g., <tt class="docutils literal">foo"bar baz</tt> is the list of <tt class="docutils literal">foo"bar</tt> and <tt class="docutils literal">baz</tt>).</p>
</div>
<div class="section" id="sections">
<h1><a class="toc-backref" href="#contents">Sections</a></h1>
<p>This section describes the different sections that may appear in a
Mercurial configuration file, the purpose of each section, its possible
keys, and their possible values.</p>
<div class="section" id="alias">
<h2><a class="toc-backref" href="#contents"><tt class="docutils literal">alias</tt></a></h2>
<p>Defines command aliases.</p>
<p>Aliases allow you to define your own commands in terms of other
commands (or aliases), optionally including arguments. Positional
arguments in the form of <tt class="docutils literal">$1</tt>, <tt class="docutils literal">$2</tt>, etc. in the alias definition
are expanded by Mercurial before execution. Positional arguments not
already used by <tt class="docutils literal">$N</tt> in the definition are put at the end of the
command to be executed.</p>
<p>Alias definitions consist of lines of the form:</p>
<pre class="literal-block">
<alias> = <command> [<argument>]...
</pre>
<p>For example, this definition:</p>
<pre class="literal-block">
latest = log --limit 5
</pre>
<p>creates a new command <tt class="docutils literal">latest</tt> that shows only the five most recent
changesets. You can define subsequent aliases using earlier ones:</p>
<pre class="literal-block">
stable5 = latest -b stable
</pre>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">It is possible to create aliases with the same names as
existing commands, which will then override the original
definitions. This is almost always a bad idea!</p>
</div>
<p>An alias can start with an exclamation point (<tt class="docutils literal">!</tt>) to make it a
shell alias. A shell alias is executed with the shell and will let you
run arbitrary commands. As an example,</p>
<pre class="literal-block">
echo = !echo $@
</pre>
<p>will let you do <tt class="docutils literal">hg echo foo</tt> to have <tt class="docutils literal">foo</tt> printed in your
terminal. A better example might be:</p>
<pre class="literal-block">
purge = !$HG status --no-status --unknown -0 re: | xargs -0 rm -f
</pre>
<p>which will make <tt class="docutils literal">hg purge</tt> delete all unknown files in the
repository in the same manner as the purge extension.</p>
<p>Positional arguments like <tt class="docutils literal">$1</tt>, <tt class="docutils literal">$2</tt>, etc. in the alias definition
expand to the command arguments. Unmatched arguments are
removed. <tt class="docutils literal">$0</tt> expands to the alias name and <tt class="docutils literal">$@</tt> expands to all
arguments separated by a space. <tt class="docutils literal"><span class="pre">"$@"</span></tt> (with quotes) expands to all
arguments quoted individually and separated by a space. These expansions
happen before the command is passed to the shell.</p>
<p>Shell aliases are executed in an environment where <tt class="docutils literal">$HG</tt> expands to
the path of the Mercurial that was used to execute the alias. This is
useful when you want to call further Mercurial commands in a shell
alias, as was done above for the purge alias. In addition,
<tt class="docutils literal">$HG_ARGS</tt> expands to the arguments given to Mercurial. In the <tt class="docutils literal">hg
echo foo</tt> call above, <tt class="docutils literal">$HG_ARGS</tt> would expand to <tt class="docutils literal">echo foo</tt>.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">Some global configuration options such as <tt class="docutils literal"><span class="pre">-R</span></tt> are
processed before shell aliases and will thus not be passed to
aliases.</p>
</div>
</div>
<div class="section" id="annotate">
<h2><a class="toc-backref" href="#contents"><tt class="docutils literal">annotate</tt></a></h2>
<p>Settings used when displaying file annotations. All values are
Booleans and default to False. See <a class="reference external" href="hgrc.5.html#diff"><tt class="docutils literal">hg help config.diff</tt></a> for
related options for the diff command.</p>
<dl class="docutils">
<dt><tt class="docutils literal">ignorews</tt></dt>
<dd>Ignore white space when comparing lines.</dd>
<dt><tt class="docutils literal">ignorewseol</tt></dt>
<dd>Ignore white space at the end of a line when comparing lines.</dd>
<dt><tt class="docutils literal">ignorewsamount</tt></dt>
<dd>Ignore changes in the amount of white space.</dd>
<dt><tt class="docutils literal">ignoreblanklines</tt></dt>
<dd>Ignore changes whose lines are all blank.</dd>
</dl>
</div>
<div class="section" id="auth">
<h2><a class="toc-backref" href="#contents"><tt class="docutils literal">auth</tt></a></h2>
<p>Authentication credentials and other authentication-like configuration
for HTTP connections. This section allows you to store usernames and
passwords for use when logging <em>into</em> HTTP servers. See
<a class="reference external" href="hgrc.5.html#web"><tt class="docutils literal">hg help config.web</tt></a> if you want to configure <em>who</em> can login to
your HTTP server.</p>
<p>The following options apply to all hosts.</p>
<dl class="docutils">
<dt><tt class="docutils literal">cookiefile</tt></dt>
<dd><p class="first">Path to a file containing HTTP cookie lines. Cookies matching a
host will be sent automatically.</p>
<p>The file format uses the Mozilla cookies.txt format, which defines cookies
on their own lines. Each line contains 7 fields delimited by the tab
character (domain, is_domain_cookie, path, is_secure, expires, name,
value). For more info, do an Internet search for "Netscape cookies.txt
format."</p>
<p>Note: the cookies parser does not handle port numbers on domains. You
will need to remove ports from the domain for the cookie to be recognized.
This could result in a cookie being disclosed to an unwanted server.</p>
<p class="last">The cookies file is read-only.</p>
</dd>
</dl>
<p>Other options in this section are grouped by name and have the following
format:</p>
<pre class="literal-block">
<name>.<argument> = <value>
</pre>
<p>where <tt class="docutils literal"><name></tt> is used to group arguments into authentication
entries. Example:</p>
<pre class="literal-block">
foo.prefix = hg.intevation.de/mercurial
foo.username = foo
foo.password = bar
foo.schemes = http https
bar.prefix = secure.example.org
bar.key = path/to/file.key
bar.cert = path/to/file.cert
bar.schemes = https
</pre>
<p>Supported arguments:</p>
<dl class="docutils">
<dt><tt class="docutils literal">prefix</tt></dt>
<dd>Either <tt class="docutils literal">*</tt> or a URI prefix with or without the scheme part.
The authentication entry with the longest matching prefix is used
(where <tt class="docutils literal">*</tt> matches everything and counts as a match of length
1). If the prefix doesn't include a scheme, the match is performed
against the URI with its scheme stripped as well, and the schemes
argument, q.v., is then subsequently consulted.</dd>
<dt><tt class="docutils literal">username</tt></dt>
<dd>Optional. Username to authenticate with. If not given, and the
remote site requires basic or digest authentication, the user will
be prompted for it. Environment variables are expanded in the
username letting you do <tt class="docutils literal">foo.username = $USER</tt>. If the URI
includes a username, only <tt class="docutils literal">[auth]</tt> entries with a matching
username or without a username will be considered.</dd>
<dt><tt class="docutils literal">password</tt></dt>
<dd>Optional. Password to authenticate with. If not given, and the
remote site requires basic or digest authentication, the user
will be prompted for it.</dd>
<dt><tt class="docutils literal">key</tt></dt>
<dd>Optional. PEM encoded client certificate key file. Environment
variables are expanded in the filename.</dd>
<dt><tt class="docutils literal">cert</tt></dt>
<dd>Optional. PEM encoded client certificate chain file. Environment
variables are expanded in the filename.</dd>
<dt><tt class="docutils literal">schemes</tt></dt>
<dd>Optional. Space separated list of URI schemes to use this
authentication entry with. Only used if the prefix doesn't include
a scheme. Supported schemes are http and https. They will match
static-http and static-https respectively, as well.
(default: https)</dd>
</dl>
<p>If no suitable authentication entry is found, the user is prompted
for credentials as usual if required by the remote.</p>
</div>
<div class="section" id="censor">
<h2><a class="toc-backref" href="#contents"><tt class="docutils literal">censor</tt></a></h2>
<dl class="docutils">
<dt><tt class="docutils literal">policy</tt></dt>
<dd><p class="first">Control how to react when accessing censored content.
Accepted value: "abort", "ignore". Defaults to abort.</p>
<p class="last">A few informative commands such as <tt class="docutils literal">hg grep</tt> will unconditionally ignore
censored data and merely report that it was encountered.</p>
</dd>
</dl>
</div>
<div class="section" id="cmdserver">
<h2><a class="toc-backref" href="#contents"><tt class="docutils literal">cmdserver</tt></a></h2>
<p>Controls command server settings. (ADVANCED)</p>
<dl class="docutils">
<dt><tt class="docutils literal"><span class="pre">message-encodings</span></tt></dt>
<dd>List of encodings for the <tt class="docutils literal">m</tt> (message) channel. The first encoding
supported by the server will be selected and advertised in the hello
message. This is useful only when <tt class="docutils literal"><span class="pre">ui.message-output</span></tt> is set to
<tt class="docutils literal">channel</tt>. Supported encodings are <tt class="docutils literal">cbor</tt>.</dd>
<dt><tt class="docutils literal"><span class="pre">shutdown-on-interrupt</span></tt></dt>
<dd>If set to false, the server's main loop will continue running after
SIGINT received. <tt class="docutils literal">runcommand</tt> requests can still be interrupted by
SIGINT. Close the write end of the pipe to shut down the server
process gracefully.
(default: True)</dd>
</dl>
</div>
<div class="section" id="color">
<h2><a class="toc-backref" href="#contents"><tt class="docutils literal">color</tt></a></h2>
<p>Configure the Mercurial color mode. For details about how to define your custom
effect and style see <a class="reference external" href="topic-color.html"><tt class="docutils literal">hg help color</tt></a>.</p>
<dl class="docutils">
<dt><tt class="docutils literal">mode</tt></dt>
<dd>String: control the method used to output color. One of <tt class="docutils literal">auto</tt>, <tt class="docutils literal">ansi</tt>,
<tt class="docutils literal">win32</tt>, <tt class="docutils literal">terminfo</tt> or <tt class="docutils literal">debug</tt>. In auto mode, Mercurial will
use ANSI mode by default (or win32 mode prior to Windows 10) if it detects a
terminal. Any invalid value will disable color.</dd>
<dt><tt class="docutils literal">pagermode</tt></dt>
<dd><p class="first">String: optional override of <tt class="docutils literal">color.mode</tt> used with pager.</p>
<p>On some systems, terminfo mode may cause problems when using
color with <tt class="docutils literal">less <span class="pre">-R</span></tt> as a pager program. less with the -R option
will only display ECMA-48 color codes, and terminfo mode may sometimes
emit codes that less doesn't understand. You can work around this by
either using ansi mode (or auto mode), or by using less -r (which will
pass through all terminal control codes, not just color control
codes).</p>
<p class="last">On some systems (such as MSYS in Windows), the terminal may support
a different color mode than the pager program.</p>
</dd>
</dl>
</div>
<div class="section" id="commands">
<h2><a class="toc-backref" href="#contents"><tt class="docutils literal">commands</tt></a></h2>
<dl class="docutils">
<dt><tt class="docutils literal"><span class="pre">commit.post-status</span></tt></dt>
<dd>Show status of files in the working directory after successful commit.
(default: False)</dd>
<dt><tt class="docutils literal"><span class="pre">merge.require-rev</span></tt></dt>
<dd>Require that the revision to merge the current commit with be specified on
the command line. If this is enabled and a revision is not specified, the
command aborts.
(default: False)</dd>
<dt><tt class="docutils literal"><span class="pre">push.require-revs</span></tt></dt>
<dd>Require revisions to push be specified using one or more mechanisms such as
specifying them positionally on the command line, using <tt class="docutils literal"><span class="pre">-r</span></tt>, <tt class="docutils literal"><span class="pre">-b</span></tt>,
and/or <tt class="docutils literal"><span class="pre">-B</span></tt> on the command line, or using <tt class="docutils literal"><span class="pre">paths.<path>:pushrev</span></tt> in the
configuration. If this is enabled and revisions are not specified, the
command aborts.
(default: False)</dd>
<dt><tt class="docutils literal">resolve.confirm</tt></dt>
<dd>Confirm before performing action if no filename is passed.
(default: False)</dd>
<dt><tt class="docutils literal"><span class="pre">resolve.explicit-re-merge</span></tt></dt>
<dd>Require uses of <tt class="docutils literal">hg resolve</tt> to specify which action it should perform,
instead of re-merging files by default.
(default: False)</dd>
<dt><tt class="docutils literal"><span class="pre">resolve.mark-check</span></tt></dt>
<dd>Determines what level of checking <a class="reference external" href="hg-resolve.html"><tt class="docutils literal">hg resolve <span class="pre">--mark</span></tt></a> will perform before
marking files as resolved. Valid values are <tt class="docutils literal">none`, ``warn</tt>, and
<tt class="docutils literal">abort</tt>. <tt class="docutils literal">warn</tt> will output a warning listing the file(s) that still
have conflict markers in them, but will still mark everything resolved.
<tt class="docutils literal">abort</tt> will output the same warning but will not mark things as resolved.
If --all is passed and this is set to <tt class="docutils literal">abort</tt>, only a warning will be
shown (an error will not be raised).
(default: <tt class="docutils literal">none</tt>)</dd>
<dt><tt class="docutils literal">status.relative</tt></dt>
<dd>Make paths in <a class="reference external" href="hg-status.html"><tt class="docutils literal">hg status</tt></a> output relative to the current directory.
(default: False)</dd>
<dt><tt class="docutils literal">status.terse</tt></dt>
<dd>Default value for the --terse flag, which condenses status output.
(default: empty)</dd>
<dt><tt class="docutils literal">update.check</tt></dt>
<dd><p class="first">Determines what level of checking <a class="reference external" href="hg-update.html"><tt class="docutils literal">hg update</tt></a> will perform before moving
to a destination revision. Valid values are <tt class="docutils literal">abort</tt>, <tt class="docutils literal">none</tt>,
<tt class="docutils literal">linear</tt>, and <tt class="docutils literal">noconflict</tt>.</p>
<ul class="simple">
<li><tt class="docutils literal">abort</tt> always fails if the working directory has uncommitted changes.</li>
<li><tt class="docutils literal">none</tt> performs no checking, and may result in a merge with uncommitted changes.</li>
<li><tt class="docutils literal">linear</tt> allows any update as long as it follows a straight line in the
revision history, and may trigger a merge with uncommitted changes.</li>
<li><tt class="docutils literal">noconflict</tt> will allow any update which would not trigger a merge with
uncommitted changes, if any are present.</li>
</ul>
<p class="last">(default: <tt class="docutils literal">linear</tt>)</p>
</dd>
<dt><tt class="docutils literal">update.requiredest</tt></dt>
<dd>Require that the user pass a destination when running <a class="reference external" href="hg-update.html"><tt class="docutils literal">hg update</tt></a>.
For example, <a class="reference external" href="hg-update.html"><tt class="docutils literal">hg update .::</tt></a> will be allowed, but a plain <a class="reference external" href="hg-update.html"><tt class="docutils literal">hg update</tt></a>
will be disallowed.
(default: False)</dd>
</dl>
</div>
<div class="section" id="committemplate">
<h2><a class="toc-backref" href="#contents"><tt class="docutils literal">committemplate</tt></a></h2>
<dl class="docutils">
<dt><tt class="docutils literal">changeset</tt></dt>
<dd>String: configuration in this section is used as the template to
customize the text shown in the editor when committing.</dd>
</dl>
<p>In addition to pre-defined template keywords, commit log specific one
below can be used for customization:</p>
<dl class="docutils">
<dt><tt class="docutils literal">extramsg</tt></dt>
<dd>String: Extra message (typically 'Leave message empty to abort
commit.'). This may be changed by some commands or extensions.</dd>
</dl>
<p>For example, the template configuration below shows as same text as
one shown by default:</p>
<pre class="literal-block">
[committemplate]
changeset = {desc}\n\n
HG: Enter commit message. Lines beginning with 'HG:' are removed.
HG: {extramsg}
HG: --
HG: user: {author}\n{ifeq(p2rev, "-1", "",
"HG: branch merge\n")
}HG: branch '{branch}'\n{if(activebookmark,
"HG: bookmark '{activebookmark}'\n") }{subrepos %
"HG: subrepo {subrepo}\n" }{file_adds %
"HG: added {file}\n" }{file_mods %
"HG: changed {file}\n" }{file_dels %
"HG: removed {file}\n" }{if(files, "",
"HG: no files changed\n")}
</pre>
<dl class="docutils">
<dt><tt class="docutils literal">diff()</tt></dt>
<dd>String: show the diff (see <a class="reference external" href="hg.1.html#templates"><tt class="docutils literal">hg help templates</tt></a> for detail)</dd>
</dl>
<p>Sometimes it is helpful to show the diff of the changeset in the editor without
having to prefix 'HG: ' to each line so that highlighting works correctly. For
this, Mercurial provides a special string which will ignore everything below
it:</p>
<pre class="literal-block">
HG: ------------------------ >8 ------------------------
</pre>
<p>For example, the template configuration below will show the diff below the
extra message:</p>
<pre class="literal-block">
[committemplate]
changeset = {desc}\n\n
HG: Enter commit message. Lines beginning with 'HG:' are removed.
HG: {extramsg}
HG: ------------------------ >8 ------------------------
HG: Do not touch the line above.
HG: Everything below will be removed.
{diff()}
</pre>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p>For some problematic encodings (see <a class="reference external" href="ext-win32mbcs.html"><tt class="docutils literal">hg help win32mbcs</tt></a> for
detail), this customization should be configured carefully, to
avoid showing broken characters.</p>
<p class="last">For example, if a multibyte character ending with backslash (0x5c) is
followed by the ASCII character 'n' in the customized template,
the sequence of backslash and 'n' is treated as line-feed unexpectedly
(and the multibyte character is broken, too).</p>
</div>
<p>Customized template is used for commands below (<tt class="docutils literal"><span class="pre">--edit</span></tt> may be
required):</p>
<ul class="simple">
<li><a class="reference external" href="hg-backout.html"><tt class="docutils literal">hg backout</tt></a></li>
<li><a class="reference external" href="hg-commit.html"><tt class="docutils literal">hg commit</tt></a></li>
<li><a class="reference external" href="hg-fetch.html"><tt class="docutils literal">hg fetch</tt></a> (for merge commit only)</li>
<li><a class="reference external" href="hg-graft.html"><tt class="docutils literal">hg graft</tt></a></li>
<li><a class="reference external" href="hg-histedit.html"><tt class="docutils literal">hg histedit</tt></a></li>
<li><a class="reference external" href="hg-import.html"><tt class="docutils literal">hg import</tt></a></li>
<li><a class="reference external" href="hg-qfold.html"><tt class="docutils literal">hg qfold</tt></a>, <a class="reference external" href="hg-qnew.html"><tt class="docutils literal">hg qnew</tt></a> and <a class="reference external" href="hg-qrefresh.html"><tt class="docutils literal">hg qrefresh</tt></a></li>
<li><a class="reference external" href="hg-rebase.html"><tt class="docutils literal">hg rebase</tt></a></li>
<li><a class="reference external" href="hg-shelve.html"><tt class="docutils literal">hg shelve</tt></a></li>
<li><a class="reference external" href="hg-sign.html"><tt class="docutils literal">hg sign</tt></a></li>
<li><a class="reference external" href="hg-tag.html"><tt class="docutils literal">hg tag</tt></a></li>
<li><a class="reference external" href="hg-transplant.html"><tt class="docutils literal">hg transplant</tt></a></li>
</ul>
<p>Configuring items below instead of <tt class="docutils literal">changeset</tt> allows showing
customized message only for specific actions, or showing different
messages for each action.</p>
<ul class="simple">
<li><tt class="docutils literal">changeset.backout</tt> for <a class="reference external" href="hg-backout.html"><tt class="docutils literal">hg backout</tt></a></li>
<li><tt class="docutils literal">changeset.commit.amend.merge</tt> for <a class="reference external" href="hg-commit.html"><tt class="docutils literal">hg commit <span class="pre">--amend</span></tt></a> on merges</li>
<li><tt class="docutils literal">changeset.commit.amend.normal</tt> for <a class="reference external" href="hg-commit.html"><tt class="docutils literal">hg commit <span class="pre">--amend</span></tt></a> on other</li>
<li><tt class="docutils literal">changeset.commit.normal.merge</tt> for <a class="reference external" href="hg-commit.html"><tt class="docutils literal">hg commit</tt></a> on merges</li>
<li><tt class="docutils literal">changeset.commit.normal.normal</tt> for <a class="reference external" href="hg-commit.html"><tt class="docutils literal">hg commit</tt></a> on other</li>
<li><tt class="docutils literal">changeset.fetch</tt> for <a class="reference external" href="hg-fetch.html"><tt class="docutils literal">hg fetch</tt></a> (impling merge commit)</li>
<li><tt class="docutils literal">changeset.gpg.sign</tt> for <a class="reference external" href="hg-sign.html"><tt class="docutils literal">hg sign</tt></a></li>
<li><tt class="docutils literal">changeset.graft</tt> for <a class="reference external" href="hg-graft.html"><tt class="docutils literal">hg graft</tt></a></li>
<li><tt class="docutils literal">changeset.histedit.edit</tt> for <tt class="docutils literal">edit</tt> of <a class="reference external" href="hg-histedit.html"><tt class="docutils literal">hg histedit</tt></a></li>
<li><tt class="docutils literal">changeset.histedit.fold</tt> for <tt class="docutils literal">fold</tt> of <a class="reference external" href="hg-histedit.html"><tt class="docutils literal">hg histedit</tt></a></li>
<li><tt class="docutils literal">changeset.histedit.mess</tt> for <tt class="docutils literal">mess</tt> of <a class="reference external" href="hg-histedit.html"><tt class="docutils literal">hg histedit</tt></a></li>
<li><tt class="docutils literal">changeset.histedit.pick</tt> for <tt class="docutils literal">pick</tt> of <a class="reference external" href="hg-histedit.html"><tt class="docutils literal">hg histedit</tt></a></li>
<li><tt class="docutils literal">changeset.import.bypass</tt> for <a class="reference external" href="hg-import.html"><tt class="docutils literal">hg import <span class="pre">--bypass</span></tt></a></li>
<li><tt class="docutils literal">changeset.import.normal.merge</tt> for <a class="reference external" href="hg-import.html"><tt class="docutils literal">hg import</tt></a> on merges</li>
<li><tt class="docutils literal">changeset.import.normal.normal</tt> for <a class="reference external" href="hg-import.html"><tt class="docutils literal">hg import</tt></a> on other</li>
<li><tt class="docutils literal">changeset.mq.qnew</tt> for <a class="reference external" href="hg-qnew.html"><tt class="docutils literal">hg qnew</tt></a></li>
<li><tt class="docutils literal">changeset.mq.qfold</tt> for <a class="reference external" href="hg-qfold.html"><tt class="docutils literal">hg qfold</tt></a></li>
<li><tt class="docutils literal">changeset.mq.qrefresh</tt> for <a class="reference external" href="hg-qrefresh.html"><tt class="docutils literal">hg qrefresh</tt></a></li>
<li><tt class="docutils literal">changeset.rebase.collapse</tt> for <a class="reference external" href="hg-rebase.html"><tt class="docutils literal">hg rebase <span class="pre">--collapse</span></tt></a></li>
<li><tt class="docutils literal">changeset.rebase.merge</tt> for <a class="reference external" href="hg-rebase.html"><tt class="docutils literal">hg rebase</tt></a> on merges</li>
<li><tt class="docutils literal">changeset.rebase.normal</tt> for <a class="reference external" href="hg-rebase.html"><tt class="docutils literal">hg rebase</tt></a> on other</li>
<li><tt class="docutils literal">changeset.shelve.shelve</tt> for <a class="reference external" href="hg-shelve.html"><tt class="docutils literal">hg shelve</tt></a></li>
<li><tt class="docutils literal">changeset.tag.add</tt> for <a class="reference external" href="hg-tag.html"><tt class="docutils literal">hg tag</tt></a> without <tt class="docutils literal"><span class="pre">--remove</span></tt></li>
<li><tt class="docutils literal">changeset.tag.remove</tt> for <a class="reference external" href="hg-tag.html"><tt class="docutils literal">hg tag <span class="pre">--remove</span></tt></a></li>
<li><tt class="docutils literal">changeset.transplant.merge</tt> for <a class="reference external" href="hg-transplant.html"><tt class="docutils literal">hg transplant</tt></a> on merges</li>
<li><tt class="docutils literal">changeset.transplant.normal</tt> for <a class="reference external" href="hg-transplant.html"><tt class="docutils literal">hg transplant</tt></a> on other</li>
</ul>
<p>These dot-separated lists of names are treated as hierarchical ones.
For example, <tt class="docutils literal">changeset.tag.remove</tt> customizes the commit message
only for <a class="reference external" href="hg-tag.html"><tt class="docutils literal">hg tag <span class="pre">--remove</span></tt></a>, but <tt class="docutils literal">changeset.tag</tt> customizes the
commit message for <a class="reference external" href="hg-tag.html"><tt class="docutils literal">hg tag</tt></a> regardless of <tt class="docutils literal"><span class="pre">--remove</span></tt> option.</p>
<p>When the external editor is invoked for a commit, the corresponding
dot-separated list of names without the <tt class="docutils literal">changeset.</tt> prefix
(e.g. <tt class="docutils literal">commit.normal.normal</tt>) is in the <tt class="docutils literal">HGEDITFORM</tt> environment
variable.</p>
<p>In this section, items other than <tt class="docutils literal">changeset</tt> can be referred from
others. For example, the configuration to list committed files up
below can be referred as <tt class="docutils literal">{listupfiles}</tt>:</p>
<pre class="literal-block">
[committemplate]
listupfiles = {file_adds %
"HG: added {file}\n" }{file_mods %
"HG: changed {file}\n" }{file_dels %
"HG: removed {file}\n" }{if(files, "",
"HG: no files changed\n")}
</pre>
</div>
<div class="section" id="decode-encode">
<h2><a class="toc-backref" href="#contents"><tt class="docutils literal">decode/encode</tt></a></h2>
<p>Filters for transforming files on checkout/checkin. This would
typically be used for newline processing or other
localization/canonicalization of files.</p>
<p>Filters consist of a filter pattern followed by a filter command.
Filter patterns are globs by default, rooted at the repository root.
For example, to match any file ending in <tt class="docutils literal">.txt</tt> in the root
directory only, use the pattern <tt class="docutils literal">*.txt</tt>. To match any file ending
in <tt class="docutils literal">.c</tt> anywhere in the repository, use the pattern <tt class="docutils literal"><span class="pre">**.c</span></tt>.
For each file only the first matching filter applies.</p>
<p>The filter command can start with a specifier, either <tt class="docutils literal">pipe:</tt> or
<tt class="docutils literal">tempfile:</tt>. If no specifier is given, <tt class="docutils literal">pipe:</tt> is used by default.</p>
<p>A <tt class="docutils literal">pipe:</tt> command must accept data on stdin and return the transformed
data on stdout.</p>
<p>Pipe example:</p>
<pre class="literal-block">
[encode]
# uncompress gzip files on checkin to improve delta compression
# note: not necessarily a good idea, just an example
*.gz = pipe: gunzip
[decode]
# recompress gzip files when writing them to the working dir (we
# can safely omit "pipe:", because it's the default)
*.gz = gzip
</pre>
<p>A <tt class="docutils literal">tempfile:</tt> command is a template. The string <tt class="docutils literal">INFILE</tt> is replaced
with the name of a temporary file that contains the data to be
filtered by the command. The string <tt class="docutils literal">OUTFILE</tt> is replaced with the name
of an empty temporary file, where the filtered data must be written by
the command.</p>
<div class="windows docutils container">
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">The tempfile mechanism is recommended for Windows systems,
where the standard shell I/O redirection operators often have
strange effects and may corrupt the contents of your files.</p>
</div>
</div>
<p>This filter mechanism is used internally by the <tt class="docutils literal">eol</tt> extension to
translate line ending characters between Windows (CRLF) and Unix (LF)
format. We suggest you use the <tt class="docutils literal">eol</tt> extension for convenience.</p>
</div>
<div class="section" id="defaults">
<h2><a class="toc-backref" href="#contents"><tt class="docutils literal">defaults</tt></a></h2>
<p>(defaults are deprecated. Don't use them. Use aliases instead.)</p>
<p>Use the <tt class="docutils literal">[defaults]</tt> section to define command defaults, i.e. the
default options/arguments to pass to the specified commands.</p>
<p>The following example makes <a class="reference external" href="hg-log.html"><tt class="docutils literal">hg log</tt></a> run in verbose mode, and
<a class="reference external" href="hg-status.html"><tt class="docutils literal">hg status</tt></a> show only the modified files, by default:</p>
<pre class="literal-block">
[defaults]
log = -v
status = -m
</pre>
<p>The actual commands, instead of their aliases, must be used when
defining command defaults. The command defaults will also be applied
to the aliases of the commands defined.</p>
</div>
<div class="section" id="diff">
<h2><a class="toc-backref" href="#contents"><tt class="docutils literal">diff</tt></a></h2>
<p>Settings used when displaying diffs. Everything except for <tt class="docutils literal">unified</tt>
is a Boolean and defaults to False. See <a class="reference external" href="hgrc.5.html#annotate"><tt class="docutils literal">hg help config.annotate</tt></a>
for related options for the annotate command.</p>
<dl class="docutils">
<dt><tt class="docutils literal">git</tt></dt>
<dd>Use git extended diff format.</dd>
<dt><tt class="docutils literal">nobinary</tt></dt>
<dd>Omit git binary patches.</dd>
<dt><tt class="docutils literal">nodates</tt></dt>
<dd>Don't include dates in diff headers.</dd>
<dt><tt class="docutils literal">noprefix</tt></dt>
<dd>Omit 'a/' and 'b/' prefixes from filenames. Ignored in plain mode.</dd>
<dt><tt class="docutils literal">showfunc</tt></dt>
<dd>Show which function each change is in.</dd>
<dt><tt class="docutils literal">ignorews</tt></dt>
<dd>Ignore white space when comparing lines.</dd>
<dt><tt class="docutils literal">ignorewsamount</tt></dt>
<dd>Ignore changes in the amount of white space.</dd>
<dt><tt class="docutils literal">ignoreblanklines</tt></dt>
<dd>Ignore changes whose lines are all blank.</dd>
<dt><tt class="docutils literal">unified</tt></dt>
<dd>Number of lines of context to show.</dd>
<dt><tt class="docutils literal"><span class="pre">word-diff</span></tt></dt>
<dd>Highlight changed words.</dd>
</dl>
</div>
<div class="section" id="email">
<h2><a class="toc-backref" href="#contents"><tt class="docutils literal">email</tt></a></h2>
<p>Settings for extensions that send email messages.</p>
<dl class="docutils">
<dt><tt class="docutils literal">from</tt></dt>
<dd>Optional. Email address to use in "From" header and SMTP envelope
of outgoing messages.</dd>
<dt><tt class="docutils literal">to</tt></dt>
<dd>Optional. Comma-separated list of recipients' email addresses.</dd>
<dt><tt class="docutils literal">cc</tt></dt>
<dd>Optional. Comma-separated list of carbon copy recipients'
email addresses.</dd>
<dt><tt class="docutils literal">bcc</tt></dt>
<dd>Optional. Comma-separated list of blind carbon copy recipients'
email addresses.</dd>
<dt><tt class="docutils literal">method</tt></dt>
<dd>Optional. Method to use to send email messages. If value is <tt class="docutils literal">smtp</tt>
(default), use SMTP (see the <tt class="docutils literal">[smtp]</tt> section for configuration).
Otherwise, use as name of program to run that acts like sendmail
(takes <tt class="docutils literal"><span class="pre">-f</span></tt> option for sender, list of recipients on command line,
message on stdin). Normally, setting this to <tt class="docutils literal">sendmail</tt> or
<tt class="docutils literal">/usr/sbin/sendmail</tt> is enough to use sendmail to send messages.</dd>
<dt><tt class="docutils literal">charsets</tt></dt>
<dd><p class="first">Optional. Comma-separated list of character sets considered
convenient for recipients. Addresses, headers, and parts not
containing patches of outgoing messages will be encoded in the
first character set to which conversion from local encoding
(<tt class="docutils literal">$HGENCODING</tt>, <tt class="docutils literal">ui.fallbackencoding</tt>) succeeds. If correct
conversion fails, the text in question is sent as is.
(default: '')</p>
<p>Order of outgoing email character sets:</p>
<ol class="last arabic simple">
<li><tt class="docutils literal"><span class="pre">us-ascii</span></tt>: always first, regardless of settings</li>
<li><tt class="docutils literal">email.charsets</tt>: in order given by user</li>
<li><tt class="docutils literal">ui.fallbackencoding</tt>: if not in email.charsets</li>
<li><tt class="docutils literal">$HGENCODING</tt>: if not in email.charsets</li>
<li><tt class="docutils literal"><span class="pre">utf-8</span></tt>: always last, regardless of settings</li>
</ol>
</dd>
</dl>
<p>Email example:</p>
<pre class="literal-block">
[email]
from = Joseph User <joe.user@example.com>
method = /usr/sbin/sendmail
# charsets for western Europeans
# us-ascii, utf-8 omitted, as they are tried first and last
charsets = iso-8859-1, iso-8859-15, windows-1252
</pre>
</div>
<div class="section" id="extensions">
<h2><a class="toc-backref" href="#contents"><tt class="docutils literal">extensions</tt></a></h2>
<p>Mercurial has an extension mechanism for adding new features. To
enable an extension, create an entry for it in this section.</p>
<p>If you know that the extension is already in Python's search path,
you can give the name of the module, followed by <tt class="docutils literal">=</tt>, with nothing
after the <tt class="docutils literal">=</tt>.</p>
<p>Otherwise, give a name that you choose, followed by <tt class="docutils literal">=</tt>, followed by
the path to the <tt class="docutils literal">.py</tt> file (including the file name extension) that
defines the extension.</p>
<p>To explicitly disable an extension that is enabled in an hgrc of
broader scope, prepend its path with <tt class="docutils literal">!</tt>, as in <tt class="docutils literal">foo = !/ext/path</tt>
or <tt class="docutils literal">foo = !</tt> when path is not supplied.</p>
<p>Example for <tt class="docutils literal"><span class="pre">~/.hgrc</span></tt>:</p>
<pre class="literal-block">
[extensions]
# (the churn extension will get loaded from Mercurial's path)
churn =
# (this extension will get loaded from the file specified)
myfeature = ~/.hgext/myfeature.py
</pre>
<p>If an extension fails to load, a warning will be issued, and Mercurial will
proceed. To enforce that an extension must be loaded, one can set the <cite>required</cite>
suboption in the config:</p>
<pre class="literal-block">
[extensions]
myfeature = ~/.hgext/myfeature.py
myfeature:required = yes
</pre>
<p>To debug extension loading issue, one can add <cite>--traceback</cite> to their mercurial
invocation.</p>
<p>A default setting can we set using the special <cite>*</cite> extension key:</p>
<pre class="literal-block">
[extensions]
*:required = yes
myfeature = ~/.hgext/myfeature.py
rebase=
</pre>
</div>
<div class="section" id="format">
<h2><a class="toc-backref" href="#contents"><tt class="docutils literal">format</tt></a></h2>
<p>Configuration that controls the repository format. Newer format options are more
powerful, but incompatible with some older versions of Mercurial. Format options
are considered at repository initialization only. You need to make a new clone
for config changes to be taken into account.</p>
<p>For more details about repository format and version compatibility, see
<a class="reference external" href="https://www.mercurial-scm.org/wiki/MissingRequirement">https://www.mercurial-scm.org/wiki/MissingRequirement</a></p>
<dl class="docutils">
<dt><tt class="docutils literal">usegeneraldelta</tt></dt>
<dd><p class="first">Enable or disable the "generaldelta" repository format which improves
repository compression by allowing "revlog" to store deltas against
arbitrary revisions instead of the previously stored one. This provides
significant improvement for repositories with branches.</p>
<p>Repositories with this on-disk format require Mercurial version 1.9.</p>
<p class="last">Enabled by default. Implied by <cite>sparse-revlog</cite></p>
</dd>
<dt><tt class="docutils literal">dotencode</tt></dt>
<dd><p class="first">Enable or disable the "dotencode" repository format which enhances
the "fncache" repository format (which has to be enabled to use
dotencode) to avoid issues with filenames starting with "._" on
Mac OS X and spaces on Windows.</p>
<p>Repositories with this on-disk format require Mercurial version 1.7.</p>
<p class="last">Enabled by default.</p>
</dd>
<dt><tt class="docutils literal">usefncache</tt></dt>
<dd><p class="first">Enable or disable the "fncache" repository format which enhances
the "store" repository format (which has to be enabled to use
fncache) to allow longer filenames and avoids using Windows
reserved names, e.g. "nul".</p>
<p>Repositories with this on-disk format require Mercurial version 1.1.</p>
<p class="last">Enabled by default.</p>
</dd>
<dt><tt class="docutils literal"><span class="pre">use-dirstate-v2</span></tt></dt>
<dd><p class="first">Enable or disable the experimental "dirstate-v2" feature. The dirstate
functionality is shared by all commands interacting with the working copy.
The new version is more robust, faster and stores more information.</p>
<p>The performance-improving version of this feature is currently only
implemented in Rust (see <a class="reference external" href="topic-rust.html"><tt class="docutils literal">hg help rust</tt></a>), so people not using a version of
Mercurial compiled with the Rust parts might actually suffer some slowdown.
For this reason, such versions will by default refuse to access repositories
with "dirstate-v2" enabled.</p>
<p>This behavior can be adjusted via configuration: check
<a class="reference external" href="hgrc.5.html#storage"><tt class="docutils literal">hg help <span class="pre">config.storage.dirstate-v2.slow-path</span></tt></a> for details.</p>
<p>Repositories with this on-disk format require Mercurial 6.0 or above.</p>
<p>By default this format variant is disabled if the fast implementation is not
available, and enabled by default if the fast implementation is available.</p>
<p>To accomodate installations of Mercurial without the fast implementation,
you can downgrade your repository. To do so run the following command:</p>
<pre class="literal-block">
$ hg debugupgraderepo \
--run \
--config format.use-dirstate-v2=False \
--config storage.dirstate-v2.slow-path=allow
</pre>
<p class="last">For a more comprehensive guide, see <a class="reference external" href="hg.1.html#internals.dirstate-v2"><tt class="docutils literal">hg help <span class="pre">internals.dirstate-v2</span></tt></a>.</p>
</dd>
<dt><tt class="docutils literal"><span class="pre">use-dirstate-v2.automatic-upgrade-of-mismatching-repositories</span></tt></dt>
<dd><p class="first">When enabled, an automatic upgrade will be triggered when a repository format
does not match its <cite>use-dirstate-v2</cite> config.</p>
<p>This is an advanced behavior that most users will not need. We recommend you
don't use this unless you are a seasoned administrator of a Mercurial install
base.</p>
<p>Automatic upgrade means that any process accessing the repository will
upgrade the repository format to use <cite>dirstate-v2</cite>. This only triggers if a
change is needed. This also applies to operations that would have been
read-only (like hg status).</p>
<p>If the repository cannot be locked, the automatic-upgrade operation will be
skipped. The next operation will attempt it again.</p>
<p class="last">This configuration will apply for moves in any direction, either adding the
<cite>dirstate-v2</cite> format if <cite>format.use-dirstate-v2=yes</cite> or removing the
<cite>dirstate-v2</cite> requirement if <cite>format.use-dirstate-v2=no</cite>. So we recommend
setting both this value and <cite>format.use-dirstate-v2</cite> at the same time.</p>
</dd>
<dt><tt class="docutils literal"><span class="pre">use-dirstate-v2.automatic-upgrade-of-mismatching-repositories:quiet</span></tt></dt>
<dd>Hide message when performing such automatic upgrade.</dd>
<dt><tt class="docutils literal"><span class="pre">use-dirstate-tracked-hint</span></tt></dt>
<dd><p class="first">Enable or disable the writing of "tracked key" file alongside the dirstate.
(default to disabled)</p>
<p>That "tracked-hint" can help external automations to detect changes to the
set of tracked files. (i.e the result of <cite>hg files</cite> or <cite>hg status -macd</cite>)</p>
<p>The tracked-hint is written in a new <cite>.hg/dirstate-tracked-hint</cite>. That file
contains two lines:
- the first line is the file version (currently: 1),
- the second line contains the "tracked-hint".
That file is written right after the dirstate is written.</p>
<p>The tracked-hint changes whenever the set of file tracked in the dirstate
changes. The general idea is:
- if the hint is identical, the set of tracked file SHOULD be identical,
- if the hint is different, the set of tracked file MIGHT be different.</p>
<p>The "hint is identical" case uses <cite>SHOULD</cite> as the dirstate and the hint file
are two distinct files and therefore that cannot be read or written to in an
atomic way. If the key is identical, nothing garantees that the dirstate is
not updated right after the hint file. This is considered a negligible
limitation for the intended usecase. It is actually possible to prevent this
race by taking the repository lock during read operations.</p>
<p>They are two "ways" to use this feature:</p>
<p>1) monitoring changes to the <cite>.hg/dirstate-tracked-hint</cite>, if the file
changes, the tracked set might have changed.</p>
<ol class="last arabic simple" start="2">
<li>storing the value and comparing it to a later value.</li>
</ol>
</dd>
<dt><tt class="docutils literal"><span class="pre">use-dirstate-tracked-hint.automatic-upgrade-of-mismatching-repositories</span></tt></dt>
<dd><p class="first">When enabled, an automatic upgrade will be triggered when a repository format
does not match its <cite>use-dirstate-tracked-hint</cite> config.</p>
<p>This is an advanced behavior that most users will not need. We recommend you
don't use this unless you are a seasoned administrator of a Mercurial install
base.</p>
<p>Automatic upgrade means that any process accessing the repository will
upgrade the repository format to use <cite>dirstate-tracked-hint</cite>. This only
triggers if a change is needed. This also applies to operations that would
have been read-only (like hg status).</p>
<p>If the repository cannot be locked, the automatic-upgrade operation will be
skipped. The next operation will attempt it again.</p>
<p class="last">This configuration will apply for moves in any direction, either adding the
<cite>dirstate-tracked-hint</cite> format if <cite>format.use-dirstate-tracked-hint=yes</cite> or
removing the <cite>dirstate-tracked-hint</cite> requirement if
<cite>format.use-dirstate-tracked-hint=no</cite>. So we recommend setting both this
value and <cite>format.use-dirstate-tracked-hint</cite> at the same time.</p>
</dd>
<dt><tt class="docutils literal"><span class="pre">use-dirstate-tracked-hint.automatic-upgrade-of-mismatching-repositories:quiet</span></tt></dt>
<dd>Hide message when performing such automatic upgrade.</dd>
<dt><tt class="docutils literal"><span class="pre">use-persistent-nodemap</span></tt></dt>
<dd><p class="first">Enable or disable the "persistent-nodemap" feature which improves
performance if the Rust extensions are available.</p>
<p>The "persistent-nodemap" persist the "node -> rev" on disk removing the
need to dynamically build that mapping for each Mercurial invocation. This
significantly reduces the startup cost of various local and server-side
operation for larger repositories.</p>
<p>The performance-improving version of this feature is currently only
implemented in Rust (see <a class="reference external" href="topic-rust.html"><tt class="docutils literal">hg help rust</tt></a>), so people not using a version of
Mercurial compiled with the Rust parts might actually suffer some slowdown.
For this reason, such versions will by default refuse to access repositories
with "persistent-nodemap".</p>
<p>This behavior can be adjusted via configuration: check
<a class="reference external" href="hgrc.5.html#storage"><tt class="docutils literal">hg help <span class="pre">config.storage.revlog.persistent-nodemap.slow-path</span></tt></a> for details.</p>
<p>Repositories with this on-disk format require Mercurial 5.4 or above.</p>
<p>By default this format variant is disabled if the fast implementation is not
available, and enabled by default if the fast implementation is available.</p>
<p>To accomodate installations of Mercurial without the fast implementation,
you can downgrade your repository. To do so run the following command:</p>
<pre class="last literal-block">
$ hg debugupgraderepo \
--run \
--config format.use-persistent-nodemap=False \
--config storage.revlog.persistent-nodemap.slow-path=allow
</pre>
</dd>
<dt><tt class="docutils literal"><span class="pre">use-share-safe</span></tt></dt>
<dd><p class="first">Enforce "safe" behaviors for all "shares" that access this repository.</p>
<p>With this feature, "shares" using this repository as a source will:</p>
<ul class="simple">
<li>read the source repository's configuration (<cite><source>/.hg/hgrc</cite>).</li>
<li>read and use the source repository's "requirements"
(except the working copy specific one).</li>
</ul>
<p>Without this feature, "shares" using this repository as a source will:</p>
<ul class="simple">
<li>keep tracking the repository "requirements" in the share only, ignoring
the source "requirements", possibly diverging from them.</li>
<li>ignore source repository config. This can create problems, like silently
ignoring important hooks.</li>
</ul>
<p>Beware that existing shares will not be upgraded/downgraded, and by
default, Mercurial will refuse to interact with them until the mismatch
is resolved. See <a class="reference external" href="hgrc.5.html#share"><tt class="docutils literal">hg help <span class="pre">config.share.safe-mismatch.source-safe</span></tt></a> and
<a class="reference external" href="hgrc.5.html#share"><tt class="docutils literal">hg help <span class="pre">config.share.safe-mismatch.source-not-safe</span></tt></a> for details.</p>
<p>Introduced in Mercurial 5.7.</p>
<p class="last">Enabled by default in Mercurial 6.1.</p>
</dd>
<dt><tt class="docutils literal"><span class="pre">use-share-safe.automatic-upgrade-of-mismatching-repositories</span></tt></dt>
<dd><p class="first">When enabled, an automatic upgrade will be triggered when a repository format
does not match its <cite>use-share-safe</cite> config.</p>
<p>This is an advanced behavior that most users will not need. We recommend you
don't use this unless you are a seasoned administrator of a Mercurial install
base.</p>
<p>Automatic upgrade means that any process accessing the repository will
upgrade the repository format to use <cite>share-safe</cite>. This only triggers if a
change is needed. This also applies to operation that would have been
read-only (like hg status).</p>
<p>If the repository cannot be locked, the automatic-upgrade operation will be
skipped. The next operation will attempt it again.</p>
<p class="last">This configuration will apply for moves in any direction, either adding the
<cite>share-safe</cite> format if <cite>format.use-share-safe=yes</cite> or removing the
<cite>share-safe</cite> requirement if <cite>format.use-share-safe=no</cite>. So we recommend
setting both this value and <cite>format.use-share-safe</cite> at the same time.</p>
</dd>
<dt><tt class="docutils literal"><span class="pre">use-share-safe.automatic-upgrade-of-mismatching-repositories:quiet</span></tt></dt>
<dd>Hide message when performing such automatic upgrade.</dd>
<dt><tt class="docutils literal">usestore</tt></dt>
<dd><p class="first">Enable or disable the "store" repository format which improves
compatibility with systems that fold case or otherwise mangle
filenames. Disabling this option will allow you to store longer filenames
in some situations at the expense of compatibility.</p>
<p>Repositories with this on-disk format require Mercurial version 0.9.4.</p>
<p class="last">Enabled by default.</p>
</dd>
<dt><tt class="docutils literal"><span class="pre">sparse-revlog</span></tt></dt>
<dd><p class="first">Enable or disable the <tt class="docutils literal"><span class="pre">sparse-revlog</span></tt> delta strategy. This format improves
delta re-use inside revlog. For very branchy repositories, it results in a
smaller store. For repositories with many revisions, it also helps
performance (by using shortened delta chains.)</p>
<p>Repositories with this on-disk format require Mercurial version 4.7</p>
<p>Implies <cite>usegeneraldelta</cite>.</p>
<p class="last">Enabled by default.</p>
</dd>
<dt><tt class="docutils literal"><span class="pre">revlog-compression</span></tt></dt>
<dd><p class="first">Compression algorithm used by revlog. Supported values are <cite>zlib</cite> and
<cite>zstd</cite>. The <cite>zlib</cite> engine is the historical default of Mercurial. <cite>zstd</cite> is
a newer format that is usually a net win over <cite>zlib</cite>, operating faster at
better compression rates. Use <cite>zstd</cite> to reduce CPU usage. Multiple values
can be specified, the first available one will be used.</p>
<p>On some systems, the Mercurial installation may lack <cite>zstd</cite> support.</p>
<p class="last">Default is <cite>zstd</cite> if available, <cite>zlib</cite> otherwise.</p>
</dd>
<dt><tt class="docutils literal"><span class="pre">bookmarks-in-store</span></tt></dt>
<dd><p class="first">Store bookmarks in .hg/store/. This means that bookmarks are shared when
using <cite>hg share</cite> regardless of the <cite>-B</cite> option.</p>
<p>Repositories with this on-disk format require Mercurial version 5.1.</p>
<p class="last">Disabled by default.</p>
</dd>
</dl>
</div>
<div class="section" id="graph">
<h2><a class="toc-backref" href="#contents"><tt class="docutils literal">graph</tt></a></h2>
<p>Web graph view configuration. This section let you change graph
elements display properties by branches, for instance to make the
<tt class="docutils literal">default</tt> branch stand out.</p>
<p>Each line has the following format:</p>
<pre class="literal-block">
<branch>.<argument> = <value>
</pre>
<p>where <tt class="docutils literal"><branch></tt> is the name of the branch being
customized. Example:</p>
<pre class="literal-block">
[graph]
# 2px width
default.width = 2
# red color
default.color = FF0000
</pre>
<p>Supported arguments:</p>
<dl class="docutils">
<dt><tt class="docutils literal">width</tt></dt>
<dd>Set branch edges width in pixels.</dd>
<dt><tt class="docutils literal">color</tt></dt>
<dd>Set branch edges color in hexadecimal RGB notation.</dd>
</dl>
</div>
<div class="section" id="hooks">
<h2><a class="toc-backref" href="#contents"><tt class="docutils literal">hooks</tt></a></h2>
<p>Commands or Python functions that get automatically executed by
various actions such as starting or finishing a commit. Multiple
hooks can be run for the same action by appending a suffix to the
action. Overriding a site-wide hook can be done by changing its
value or setting it to an empty string. Hooks can be prioritized
by adding a prefix of <tt class="docutils literal">priority.</tt> to the hook name on a new line
and setting the priority. The default priority is 0.</p>
<p>Example <tt class="docutils literal">.hg/hgrc</tt>:</p>
<pre class="literal-block">
[hooks]
# update working directory after adding changesets
changegroup.update = hg update
# do not use the site-wide hook
incoming =
incoming.email = /my/email/hook
incoming.autobuild = /my/build/hook
# force autobuild hook to run before other incoming hooks
priority.incoming.autobuild = 1
### control HGPLAIN setting when running autobuild hook
# HGPLAIN always set (default from Mercurial 5.7)
incoming.autobuild:run-with-plain = yes
# HGPLAIN never set
incoming.autobuild:run-with-plain = no
# HGPLAIN inherited from environment (default before Mercurial 5.7)
incoming.autobuild:run-with-plain = auto
</pre>
<p>Most hooks are run with environment variables set that give useful
additional information. For each hook below, the environment variables
it is passed are listed with names in the form <tt class="docutils literal">$HG_foo</tt>. The
<tt class="docutils literal">$HG_HOOKTYPE</tt> and <tt class="docutils literal">$HG_HOOKNAME</tt> variables are set for all hooks.
They contain the type of hook which triggered the run and the full name
of the hook in the config, respectively. In the example above, this will
be <tt class="docutils literal">$HG_HOOKTYPE=incoming</tt> and <tt class="docutils literal">$HG_HOOKNAME=incoming.email</tt>.</p>
<div class="windows docutils container">
<p>Some basic Unix syntax can be enabled for portability, including <tt class="docutils literal">$VAR</tt>
and <tt class="docutils literal">${VAR}</tt> style variables. A <tt class="docutils literal">~</tt> followed by <tt class="docutils literal">\</tt> or <tt class="docutils literal">/</tt> will
be expanded to <tt class="docutils literal">%USERPROFILE%</tt> to simulate a subset of tilde expansion
on Unix. To use a literal <tt class="docutils literal">$</tt> or <tt class="docutils literal">~</tt>, it must be escaped with a back
slash or inside of a strong quote. Strong quotes will be replaced by
double quotes after processing.</p>
<p>This feature is enabled by adding a prefix of <tt class="docutils literal">tonative.</tt> to the hook
name on a new line, and setting it to <tt class="docutils literal">True</tt>. For example:</p>
<pre class="literal-block">
[hooks]
incoming.autobuild = /my/build/hook
# enable translation to cmd.exe syntax for autobuild hook
tonative.incoming.autobuild = True
</pre>
</div>
<dl class="docutils">
<dt><tt class="docutils literal">changegroup</tt></dt>
<dd>Run after a changegroup has been added via push, pull or unbundle. The ID of
the first new changeset is in <tt class="docutils literal">$HG_NODE</tt> and last is in <tt class="docutils literal">$HG_NODE_LAST</tt>.
The URL from which changes came is in <tt class="docutils literal">$HG_URL</tt>.</dd>
<dt><tt class="docutils literal">commit</tt></dt>
<dd>Run after a changeset has been created in the local repository. The ID
of the newly created changeset is in <tt class="docutils literal">$HG_NODE</tt>. Parent changeset
IDs are in <tt class="docutils literal">$HG_PARENT1</tt> and <tt class="docutils literal">$HG_PARENT2</tt>.</dd>
<dt><tt class="docutils literal">incoming</tt></dt>
<dd>Run after a changeset has been pulled, pushed, or unbundled into
the local repository. The ID of the newly arrived changeset is in
<tt class="docutils literal">$HG_NODE</tt>. The URL that was source of the changes is in <tt class="docutils literal">$HG_URL</tt>.</dd>
<dt><tt class="docutils literal">outgoing</tt></dt>
<dd>Run after sending changes from the local repository to another. The ID of
first changeset sent is in <tt class="docutils literal">$HG_NODE</tt>. The source of operation is in
<tt class="docutils literal">$HG_SOURCE</tt>. Also see <a class="reference external" href="hgrc.5.html#hooks"><tt class="docutils literal">hg help config.hooks.preoutgoing</tt></a>.</dd>
<dt><tt class="docutils literal"><span class="pre">post-<command></span></tt></dt>
<dd>Run after successful invocations of the associated command. The
contents of the command line are passed as <tt class="docutils literal">$HG_ARGS</tt> and the result
code in <tt class="docutils literal">$HG_RESULT</tt>. Parsed command line arguments are passed as
<tt class="docutils literal">$HG_PATS</tt> and <tt class="docutils literal">$HG_OPTS</tt>. These contain string representations of
the python data internally passed to <command>. <tt class="docutils literal">$HG_OPTS</tt> is a
dictionary of options (with unspecified options set to their defaults).
<tt class="docutils literal">$HG_PATS</tt> is a list of arguments. Hook failure is ignored.</dd>
<dt><tt class="docutils literal"><span class="pre">fail-<command></span></tt></dt>
<dd>Run after a failed invocation of an associated command. The contents
of the command line are passed as <tt class="docutils literal">$HG_ARGS</tt>. Parsed command line
arguments are passed as <tt class="docutils literal">$HG_PATS</tt> and <tt class="docutils literal">$HG_OPTS</tt>. These contain
string representations of the python data internally passed to
<command>. <tt class="docutils literal">$HG_OPTS</tt> is a dictionary of options (with unspecified
options set to their defaults). <tt class="docutils literal">$HG_PATS</tt> is a list of arguments.
Hook failure is ignored.</dd>
<dt><tt class="docutils literal"><span class="pre">pre-<command></span></tt></dt>
<dd>Run before executing the associated command. The contents of the
command line are passed as <tt class="docutils literal">$HG_ARGS</tt>. Parsed command line arguments
are passed as <tt class="docutils literal">$HG_PATS</tt> and <tt class="docutils literal">$HG_OPTS</tt>. These contain string
representations of the data internally passed to <command>. <tt class="docutils literal">$HG_OPTS</tt>
is a dictionary of options (with unspecified options set to their
defaults). <tt class="docutils literal">$HG_PATS</tt> is a list of arguments. If the hook returns
failure, the command doesn't execute and Mercurial returns the failure
code.</dd>
<dt><tt class="docutils literal">prechangegroup</tt></dt>
<dd>Run before a changegroup is added via push, pull or unbundle. Exit
status 0 allows the changegroup to proceed. A non-zero status will
cause the push, pull or unbundle to fail. The URL from which changes
will come is in <tt class="docutils literal">$HG_URL</tt>.</dd>
<dt><tt class="docutils literal">precommit</tt></dt>
<dd>Run before starting a local commit. Exit status 0 allows the
commit to proceed. A non-zero status will cause the commit to fail.
Parent changeset IDs are in <tt class="docutils literal">$HG_PARENT1</tt> and <tt class="docutils literal">$HG_PARENT2</tt>.</dd>
<dt><tt class="docutils literal">prelistkeys</tt></dt>
<dd>Run before listing pushkeys (like bookmarks) in the
repository. A non-zero status will cause failure. The key namespace is
in <tt class="docutils literal">$HG_NAMESPACE</tt>.</dd>
<dt><tt class="docutils literal">preoutgoing</tt></dt>
<dd>Run before collecting changes to send from the local repository to
another. A non-zero status will cause failure. This lets you prevent
pull over HTTP or SSH. It can also prevent propagating commits (via
local pull, push (outbound) or bundle commands), but not completely,
since you can just copy files instead. The source of operation is in
<tt class="docutils literal">$HG_SOURCE</tt>. If "serve", the operation is happening on behalf of a remote
SSH or HTTP repository. If "push", "pull" or "bundle", the operation
is happening on behalf of a repository on same system.</dd>
<dt><tt class="docutils literal">prepushkey</tt></dt>
<dd>Run before a pushkey (like a bookmark) is added to the
repository. A non-zero status will cause the key to be rejected. The
key namespace is in <tt class="docutils literal">$HG_NAMESPACE</tt>, the key is in <tt class="docutils literal">$HG_KEY</tt>,
the old value (if any) is in <tt class="docutils literal">$HG_OLD</tt>, and the new value is in
<tt class="docutils literal">$HG_NEW</tt>.</dd>
<dt><tt class="docutils literal">pretag</tt></dt>
<dd>Run before creating a tag. Exit status 0 allows the tag to be
created. A non-zero status will cause the tag to fail. The ID of the
changeset to tag is in <tt class="docutils literal">$HG_NODE</tt>. The name of tag is in <tt class="docutils literal">$HG_TAG</tt>. The
tag is local if <tt class="docutils literal">$HG_LOCAL=1</tt>, or in the repository if <tt class="docutils literal">$HG_LOCAL=0</tt>.</dd>
<dt><tt class="docutils literal"><span class="pre">pretransmit-inline-clone-bundle</span></tt></dt>
<dd>Run before transferring an inline clonebundle to the peer.
If the exit status is 0, the inline clonebundle will be allowed to be
transferred. A non-zero status will cause the transfer to fail.
The path of the inline clonebundle is in <tt class="docutils literal">$HG_CLONEBUNDLEPATH</tt>.</dd>
<dt><tt class="docutils literal">pretxnopen</tt></dt>
<dd>Run before any new repository transaction is open. The reason for the
transaction will be in <tt class="docutils literal">$HG_TXNNAME</tt>, and a unique identifier for the
transaction will be in <tt class="docutils literal">$HG_TXNID</tt>. A non-zero status will prevent the
transaction from being opened.</dd>
<dt><tt class="docutils literal">pretxnclose</tt></dt>
<dd>Run right before the transaction is actually finalized. Any repository change
will be visible to the hook program. This lets you validate the transaction
content or change it. Exit status 0 allows the commit to proceed. A non-zero
status will cause the transaction to be rolled back. The reason for the
transaction opening will be in <tt class="docutils literal">$HG_TXNNAME</tt>, and a unique identifier for
the transaction will be in <tt class="docutils literal">$HG_TXNID</tt>. The rest of the available data will
vary according the transaction type. Changes unbundled to the repository will
add <tt class="docutils literal">$HG_URL</tt> and <tt class="docutils literal">$HG_SOURCE</tt>. New changesets will add <tt class="docutils literal">$HG_NODE</tt> (the
ID of the first added changeset), <tt class="docutils literal">$HG_NODE_LAST</tt> (the ID of the last added
changeset). Bookmark and phase changes will set <tt class="docutils literal">$HG_BOOKMARK_MOVED</tt> and
<tt class="docutils literal">$HG_PHASES_MOVED</tt> to <tt class="docutils literal">1</tt> respectively. The number of new obsmarkers, if
any, will be in <tt class="docutils literal">$HG_NEW_OBSMARKERS</tt>, etc.</dd>
<dt><tt class="docutils literal"><span class="pre">pretxnclose-bookmark</span></tt></dt>
<dd>Run right before a bookmark change is actually finalized. Any repository
change will be visible to the hook program. This lets you validate the
transaction content or change it. Exit status 0 allows the commit to
proceed. A non-zero status will cause the transaction to be rolled back.
The name of the bookmark will be available in <tt class="docutils literal">$HG_BOOKMARK</tt>, the new
bookmark location will be available in <tt class="docutils literal">$HG_NODE</tt> while the previous
location will be available in <tt class="docutils literal">$HG_OLDNODE</tt>. In case of a bookmark
creation <tt class="docutils literal">$HG_OLDNODE</tt> will be empty. In case of deletion <tt class="docutils literal">$HG_NODE</tt>
will be empty.
In addition, the reason for the transaction opening will be in
<tt class="docutils literal">$HG_TXNNAME</tt>, and a unique identifier for the transaction will be in
<tt class="docutils literal">$HG_TXNID</tt>.</dd>
<dt><tt class="docutils literal"><span class="pre">pretxnclose-phase</span></tt></dt>
<dd>Run right before a phase change is actually finalized. Any repository change
will be visible to the hook program. This lets you validate the transaction
content or change it. Exit status 0 allows the commit to proceed. A non-zero
status will cause the transaction to be rolled back. The hook is called
multiple times, once for each revision affected by a phase change.
The affected node is available in <tt class="docutils literal">$HG_NODE</tt>, the phase in <tt class="docutils literal">$HG_PHASE</tt>
while the previous <tt class="docutils literal">$HG_OLDPHASE</tt>. In case of new node, <tt class="docutils literal">$HG_OLDPHASE</tt>
will be empty. In addition, the reason for the transaction opening will be in
<tt class="docutils literal">$HG_TXNNAME</tt>, and a unique identifier for the transaction will be in
<tt class="docutils literal">$HG_TXNID</tt>. The hook is also run for newly added revisions. In this case
the <tt class="docutils literal">$HG_OLDPHASE</tt> entry will be empty.</dd>
<dt><tt class="docutils literal">txnclose</tt></dt>
<dd>Run after any repository transaction has been committed. At this
point, the transaction can no longer be rolled back. The hook will run
after the lock is released. See <a class="reference external" href="hgrc.5.html#hooks"><tt class="docutils literal">hg help config.hooks.pretxnclose</tt></a> for
details about available variables.</dd>
<dt><tt class="docutils literal"><span class="pre">txnclose-bookmark</span></tt></dt>
<dd>Run after any bookmark change has been committed. At this point, the
transaction can no longer be rolled back. The hook will run after the lock
is released. See <a class="reference external" href="hgrc.5.html#hooks"><tt class="docutils literal">hg help <span class="pre">config.hooks.pretxnclose-bookmark</span></tt></a> for details
about available variables.</dd>
<dt><tt class="docutils literal"><span class="pre">txnclose-phase</span></tt></dt>
<dd>Run after any phase change has been committed. At this point, the
transaction can no longer be rolled back. The hook will run after the lock
is released. See <a class="reference external" href="hgrc.5.html#hooks"><tt class="docutils literal">hg help <span class="pre">config.hooks.pretxnclose-phase</span></tt></a> for details about
available variables.</dd>
<dt><tt class="docutils literal">txnabort</tt></dt>
<dd>Run when a transaction is aborted. See <a class="reference external" href="hgrc.5.html#hooks"><tt class="docutils literal">hg help config.hooks.pretxnclose</tt></a>
for details about available variables.</dd>
<dt><tt class="docutils literal">pretxnchangegroup</tt></dt>
<dd>Run after a changegroup has been added via push, pull or unbundle, but before
the transaction has been committed. The changegroup is visible to the hook
program. This allows validation of incoming changes before accepting them.
The ID of the first new changeset is in <tt class="docutils literal">$HG_NODE</tt> and last is in
<tt class="docutils literal">$HG_NODE_LAST</tt>. Exit status 0 allows the transaction to commit. A non-zero
status will cause the transaction to be rolled back, and the push, pull or
unbundle will fail. The URL that was the source of changes is in <tt class="docutils literal">$HG_URL</tt>.</dd>
<dt><tt class="docutils literal">pretxncommit</tt></dt>
<dd>Run after a changeset has been created, but before the transaction is
committed. The changeset is visible to the hook program. This allows
validation of the commit message and changes. Exit status 0 allows the
commit to proceed. A non-zero status will cause the transaction to
be rolled back. The ID of the new changeset is in <tt class="docutils literal">$HG_NODE</tt>. The parent
changeset IDs are in <tt class="docutils literal">$HG_PARENT1</tt> and <tt class="docutils literal">$HG_PARENT2</tt>.</dd>
<dt><tt class="docutils literal">preupdate</tt></dt>
<dd>Run before updating the working directory. Exit status 0 allows
the update to proceed. A non-zero status will prevent the update.
The changeset ID of first new parent is in <tt class="docutils literal">$HG_PARENT1</tt>. If updating to a
merge, the ID of second new parent is in <tt class="docutils literal">$HG_PARENT2</tt>.</dd>
<dt><tt class="docutils literal">listkeys</tt></dt>
<dd>Run after listing pushkeys (like bookmarks) in the repository. The
key namespace is in <tt class="docutils literal">$HG_NAMESPACE</tt>. <tt class="docutils literal">$HG_VALUES</tt> is a
dictionary containing the keys and values.</dd>
<dt><tt class="docutils literal">pushkey</tt></dt>
<dd>Run after a pushkey (like a bookmark) is added to the
repository. The key namespace is in <tt class="docutils literal">$HG_NAMESPACE</tt>, the key is in
<tt class="docutils literal">$HG_KEY</tt>, the old value (if any) is in <tt class="docutils literal">$HG_OLD</tt>, and the new
value is in <tt class="docutils literal">$HG_NEW</tt>.</dd>
<dt><tt class="docutils literal">tag</tt></dt>
<dd>Run after a tag is created. The ID of the tagged changeset is in <tt class="docutils literal">$HG_NODE</tt>.
The name of tag is in <tt class="docutils literal">$HG_TAG</tt>. The tag is local if <tt class="docutils literal">$HG_LOCAL=1</tt>, or in
the repository if <tt class="docutils literal">$HG_LOCAL=0</tt>.</dd>
<dt><tt class="docutils literal">update</tt></dt>
<dd>Run after updating the working directory. The changeset ID of first
new parent is in <tt class="docutils literal">$HG_PARENT1</tt>. If updating to a merge, the ID of second new
parent is in <tt class="docutils literal">$HG_PARENT2</tt>. If the update succeeded, <tt class="docutils literal">$HG_ERROR=0</tt>. If the
update failed (e.g. because conflicts were not resolved), <tt class="docutils literal">$HG_ERROR=1</tt>.</dd>
<dt><tt class="docutils literal">prelock</tt></dt>
<dd>run before the store lock is taken, mostly used for test and debug.</dd>
<dt><tt class="docutils literal">prewlock</tt></dt>
<dd>run before the working copy lock is taken, mostly used for test and debug.</dd>
</dl>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">It is generally better to use standard hooks rather than the
generic pre- and post- command hooks, as they are guaranteed to be
called in the appropriate contexts for influencing transactions.
Also, hooks like "commit" will be called in all contexts that
generate a commit (e.g. tag) and not just the commit command.</p>
</div>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">Environment variables with empty values may not be passed to
hooks on platforms such as Windows. As an example, <tt class="docutils literal">$HG_PARENT2</tt>
will have an empty value under Unix-like platforms for non-merge
changesets, while it will not be available at all under Windows.</p>
</div>
<p>The syntax for Python hooks is as follows:</p>
<pre class="literal-block">
hookname = python:modulename.submodule.callable
hookname = python:/path/to/python/module.py:callable
</pre>
<p>Python hooks are run within the Mercurial process. Each hook is
called with at least three keyword arguments: a ui object (keyword
<tt class="docutils literal">ui</tt>), a repository object (keyword <tt class="docutils literal">repo</tt>), and a <tt class="docutils literal">hooktype</tt>
keyword that tells what kind of hook is used. Arguments listed as
environment variables above are passed as keyword arguments, with no
<tt class="docutils literal">HG_</tt> prefix, and names in lower case.</p>
<p>If a Python hook returns a "true" value or raises an exception, this
is treated as a failure.</p>
</div>
<div class="section" id="hostfingerprints">
<h2><a class="toc-backref" href="#contents"><tt class="docutils literal">hostfingerprints</tt></a></h2>
<p>(Deprecated. Use <tt class="docutils literal">[hostsecurity]</tt>'s <tt class="docutils literal">fingerprints</tt> options instead.)</p>
<p>Fingerprints of the certificates of known HTTPS servers.</p>
<p>A HTTPS connection to a server with a fingerprint configured here will
only succeed if the servers certificate matches the fingerprint.
This is very similar to how ssh known hosts works.</p>
<p>The fingerprint is the SHA-1 hash value of the DER encoded certificate.
Multiple values can be specified (separated by spaces or commas). This can
be used to define both old and new fingerprints while a host transitions
to a new certificate.</p>
<p>The CA chain and web.cacerts is not used for servers with a fingerprint.</p>
<p>For example:</p>
<pre class="literal-block">
[hostfingerprints]
hg.intevation.de = fc:e2:8d:d9:51:cd:cb:c1:4d:18:6b:b7:44:8d:49:72:57:e6:cd:33
hg.intevation.org = fc:e2:8d:d9:51:cd:cb:c1:4d:18:6b:b7:44:8d:49:72:57:e6:cd:33
</pre>
</div>
<div class="section" id="hostsecurity">
<h2><a class="toc-backref" href="#contents"><tt class="docutils literal">hostsecurity</tt></a></h2>
<p>Used to specify global and per-host security settings for connecting to
other machines.</p>
<p>The following options control default behavior for all hosts.</p>
<dl class="docutils">
<dt><tt class="docutils literal">ciphers</tt></dt>
<dd><p class="first">Defines the cryptographic ciphers to use for connections.</p>
<p>Value must be a valid OpenSSL Cipher List Format as documented at
<a class="reference external" href="https://www.openssl.org/docs/manmaster/apps/ciphers.html#CIPHER-LIST-FORMAT">https://www.openssl.org/docs/manmaster/apps/ciphers.html#CIPHER-LIST-FORMAT</a>.</p>
<p>This setting is for advanced users only. Setting to incorrect values
can significantly lower connection security or decrease performance.
You have been warned.</p>
<p class="last">This option requires Python 2.7.</p>
</dd>
<dt><tt class="docutils literal">minimumprotocol</tt></dt>
<dd><p class="first">Defines the minimum channel encryption protocol to use in the client.</p>
<p>By default, the highest version of TLS supported by both client and server
is used.</p>
<p>Allowed values are: <tt class="docutils literal">tls1.0</tt>, <tt class="docutils literal">tls1.1</tt>, <tt class="docutils literal">tls1.2</tt>, <tt class="docutils literal">tls1.3</tt>.</p>
<p>Depending on the version of Python being used, not all of these values may
be available. See <tt class="docutils literal">hg debuginstall</tt> for the values supported by the
current installation.</p>
<p class="last">When running a Python that supports modern TLS versions, the default is
<tt class="docutils literal">tls1.2</tt>. <tt class="docutils literal">tls1.0</tt> and <tt class="docutils literal">tls1.1</tt> can still be used to allow TLS 1.0
or TLS 1.1 respectively, if supported by Python. However, this weakens
security and should only be used as a feature of last resort if a server
does not support TLS 1.2+.</p>
</dd>
</dl>
<p>Options in the <tt class="docutils literal">[hostsecurity]</tt> section can have the form
<tt class="docutils literal">hostname</tt>:<tt class="docutils literal">setting</tt>. This allows multiple settings to be defined on a
per-host basis.</p>
<p>The following per-host settings can be defined.</p>
<dl class="docutils">
<dt><tt class="docutils literal">ciphers</tt></dt>
<dd>This behaves like <tt class="docutils literal">ciphers</tt> as described above except it only applies
to the host on which it is defined.</dd>
<dt><tt class="docutils literal">fingerprints</tt></dt>
<dd><p class="first">A list of hashes of the DER encoded peer/remote certificate. Values have
the form <tt class="docutils literal">algorithm</tt>:<tt class="docutils literal">fingerprint</tt>. e.g.
<tt class="docutils literal">sha256:c3ab8ff13720e8ad9047dd39466b3c8974e592c2fa383d4a3960714caef0c4f2</tt>.
In addition, colons (<tt class="docutils literal">:</tt>) can appear in the fingerprint part.</p>
<p>The following algorithms/prefixes are supported: <tt class="docutils literal">sha1</tt>, <tt class="docutils literal">sha256</tt>,
<tt class="docutils literal">sha512</tt>.</p>
<p>Use of <tt class="docutils literal">sha256</tt> or <tt class="docutils literal">sha512</tt> is preferred.</p>
<p>If a fingerprint is specified, the CA chain is not validated for this
host and Mercurial will require the remote certificate to match one
of the fingerprints specified. This means if the server updates its
certificate, Mercurial will abort until a new fingerprint is defined.
This can provide stronger security than traditional CA-based validation
at the expense of convenience.</p>
<p class="last">This option takes precedence over <tt class="docutils literal">verifycertsfile</tt>.</p>
</dd>
<dt><tt class="docutils literal">minimumprotocol</tt></dt>
<dd>This behaves like <tt class="docutils literal">minimumprotocol</tt> as described above except it
only applies to the host on which it is defined.</dd>
<dt><tt class="docutils literal">verifycertsfile</tt></dt>
<dd><p class="first">Path to file a containing a list of PEM encoded certificates used to
verify the server certificate. Environment variables and <tt class="docutils literal">~user</tt>
constructs are expanded in the filename.</p>
<p>The server certificate or the certificate's certificate authority (CA)
must match a certificate from this file or certificate verification
will fail and connections to the server will be refused.</p>
<p>If defined, only certificates provided by this file will be used:
<tt class="docutils literal">web.cacerts</tt> and any system/default certificates will not be
used.</p>
<p>This option has no effect if the per-host <tt class="docutils literal">fingerprints</tt> option
is set.</p>
<p>The format of the file is as follows:</p>
<pre class="last literal-block">
-----BEGIN CERTIFICATE-----
... (certificate in base64 PEM encoding) ...
-----END CERTIFICATE-----
-----BEGIN CERTIFICATE-----
... (certificate in base64 PEM encoding) ...
-----END CERTIFICATE-----
</pre>
</dd>
</dl>
<p>For example:</p>
<pre class="literal-block">
[hostsecurity]
hg.example.com:fingerprints = sha256:c3ab8ff13720e8ad9047dd39466b3c8974e592c2fa383d4a3960714caef0c4f2
hg2.example.com:fingerprints = sha1:914f1aff87249c09b6859b88b1906d30756491ca, sha1:fc:e2:8d:d9:51:cd:cb:c1:4d:18:6b:b7:44:8d:49:72:57:e6:cd:33
hg3.example.com:fingerprints = sha256:9a:b0:dc:e2:75:ad:8a:b7:84:58:e5:1f:07:32:f1:87:e6:bd:24:22:af:b7:ce:8e:9c:b4:10:cf:b9:f4:0e:d2
foo.example.com:verifycertsfile = /etc/ssl/trusted-ca-certs.pem
</pre>
<p>To change the default minimum protocol version to TLS 1.2 but to allow TLS 1.1
when connecting to <tt class="docutils literal">hg.example.com</tt>:</p>
<pre class="literal-block">
[hostsecurity]
minimumprotocol = tls1.2
hg.example.com:minimumprotocol = tls1.1
</pre>
</div>
<div class="section" id="http-proxy">
<h2><a class="toc-backref" href="#contents"><tt class="docutils literal">http_proxy</tt></a></h2>
<p>Used to access web-based Mercurial repositories through a HTTP
proxy.</p>
<dl class="docutils">
<dt><tt class="docutils literal">host</tt></dt>
<dd>Host name and (optional) port of the proxy server, for example
"myproxy:8000".</dd>
<dt><tt class="docutils literal">no</tt></dt>
<dd>Optional. Comma-separated list of host names that should bypass
the proxy.</dd>
<dt><tt class="docutils literal">passwd</tt></dt>
<dd>Optional. Password to authenticate with at the proxy server.</dd>
<dt><tt class="docutils literal">user</tt></dt>
<dd>Optional. User name to authenticate with at the proxy server.</dd>
<dt><tt class="docutils literal">always</tt></dt>
<dd>Optional. Always use the proxy, even for localhost and any entries
in <tt class="docutils literal">http_proxy.no</tt>. (default: False)</dd>
</dl>
</div>
<div class="section" id="http">
<h2><a class="toc-backref" href="#contents"><tt class="docutils literal">http</tt></a></h2>
<p>Used to configure access to Mercurial repositories via HTTP.</p>
<dl class="docutils">
<dt><tt class="docutils literal">timeout</tt></dt>
<dd>If set, blocking operations will timeout after that many seconds.
(default: None)</dd>
</dl>
</div>
<div class="section" id="merge">
<h2><a class="toc-backref" href="#contents"><tt class="docutils literal">merge</tt></a></h2>
<p>This section specifies behavior during merges and updates.</p>
<dl class="docutils">
<dt><tt class="docutils literal">checkignored</tt></dt>
<dd>Controls behavior when an ignored file on disk has the same name as a tracked
file in the changeset being merged or updated to, and has different
contents. Options are <tt class="docutils literal">abort</tt>, <tt class="docutils literal">warn</tt> and <tt class="docutils literal">ignore</tt>. With <tt class="docutils literal">abort</tt>,
abort on such files. With <tt class="docutils literal">warn</tt>, warn on such files and back them up as
<tt class="docutils literal">.orig</tt>. With <tt class="docutils literal">ignore</tt>, don't print a warning and back them up as
<tt class="docutils literal">.orig</tt>. (default: <tt class="docutils literal">abort</tt>)</dd>
<dt><tt class="docutils literal">checkunknown</tt></dt>
<dd>Controls behavior when an unknown file that isn't ignored has the same name
as a tracked file in the changeset being merged or updated to, and has
different contents. Similar to <tt class="docutils literal">merge.checkignored</tt>, except for files that
are not ignored. (default: <tt class="docutils literal">abort</tt>)</dd>
<dt><tt class="docutils literal"><span class="pre">on-failure</span></tt></dt>
<dd>When set to <tt class="docutils literal">continue</tt> (the default), the merge process attempts to
merge all unresolved files using the merge chosen tool, regardless of
whether previous file merge attempts during the process succeeded or not.
Setting this to <tt class="docutils literal">prompt</tt> will prompt after any merge failure continue
or halt the merge process. Setting this to <tt class="docutils literal">halt</tt> will automatically
halt the merge process on any merge tool failure. The merge process
can be restarted by using the <tt class="docutils literal">resolve</tt> command. When a merge is
halted, the repository is left in a normal <tt class="docutils literal">unresolved</tt> merge state.
(default: <tt class="docutils literal">continue</tt>)</dd>
<dt><tt class="docutils literal"><span class="pre">strict-capability-check</span></tt></dt>
<dd>Whether capabilities of internal merge tools are checked strictly
or not, while examining rules to decide merge tool to be used.
(default: False)</dd>
</dl>
</div>
<div class="section" id="merge-patterns">
<h2><a class="toc-backref" href="#contents"><tt class="docutils literal"><span class="pre">merge-patterns</span></tt></a></h2>
<p>This section specifies merge tools to associate with particular file
patterns. Tools matched here will take precedence over the default
merge tool. Patterns are globs by default, rooted at the repository
root.</p>
<p>Example:</p>
<pre class="literal-block">
[merge-patterns]
**.c = kdiff3
**.jpg = myimgmerge
</pre>
</div>
<div class="section" id="merge-tools">
<h2><a class="toc-backref" href="#contents"><tt class="docutils literal"><span class="pre">merge-tools</span></tt></a></h2>
<p>This section configures external merge tools to use for file-level
merges. This section has likely been preconfigured at install time.
Use <a class="reference external" href="hg-config.html"><tt class="docutils literal">hg config <span class="pre">merge-tools</span></tt></a> to check the existing configuration.
Also see <a class="reference external" href="topic-merge-tools.html"><tt class="docutils literal">hg help <span class="pre">merge-tools</span></tt></a> for more details.</p>
<p>Example <tt class="docutils literal"><span class="pre">~/.hgrc</span></tt>:</p>
<pre class="literal-block">
[merge-tools]
# Override stock tool location
kdiff3.executable = ~/bin/kdiff3
# Specify command line
kdiff3.args = $base $local $other -o $output
# Give higher priority
kdiff3.priority = 1
# Changing the priority of preconfigured tool
meld.priority = 0
# Disable a preconfigured tool
vimdiff.disabled = yes
# Define new tool
myHtmlTool.args = -m $local $other $base $output
myHtmlTool.regkey = Software\FooSoftware\HtmlMerge
myHtmlTool.priority = 1
</pre>
<p>Supported arguments:</p>
<dl class="docutils">
<dt><tt class="docutils literal">priority</tt></dt>
<dd>The priority in which to evaluate this tool.
(default: 0)</dd>
<dt><tt class="docutils literal">executable</tt></dt>
<dd><p class="first">Either just the name of the executable or its pathname.</p>
<div class="windows docutils container">
On Windows, the path can use environment variables with ${ProgramFiles}
syntax.</div>
<p class="last">(default: the tool name)</p>
</dd>
<dt><tt class="docutils literal">args</tt></dt>
<dd><p class="first">The arguments to pass to the tool executable. You can refer to the
files being merged as well as the output file through these
variables: <tt class="docutils literal">$base</tt>, <tt class="docutils literal">$local</tt>, <tt class="docutils literal">$other</tt>, <tt class="docutils literal">$output</tt>.</p>
<p>The meaning of <tt class="docutils literal">$local</tt> and <tt class="docutils literal">$other</tt> can vary depending on which action is
being performed. During an update or merge, <tt class="docutils literal">$local</tt> represents the original
state of the file, while <tt class="docutils literal">$other</tt> represents the commit you are updating to or
the commit you are merging with. During a rebase, <tt class="docutils literal">$local</tt> represents the
destination of the rebase, and <tt class="docutils literal">$other</tt> represents the commit being rebased.</p>
<p class="last">Some operations define custom labels to assist with identifying the revisions,
accessible via <tt class="docutils literal">$labellocal</tt>, <tt class="docutils literal">$labelother</tt>, and <tt class="docutils literal">$labelbase</tt>. If custom
labels are not available, these will be <tt class="docutils literal">local</tt>, <tt class="docutils literal">other</tt>, and <tt class="docutils literal">base</tt>,
respectively.
(default: <tt class="docutils literal">$local $base $other</tt>)</p>
</dd>
<dt><tt class="docutils literal">premerge</tt></dt>
<dd>Attempt to run internal non-interactive 3-way merge tool before
launching external tool. Options are <tt class="docutils literal">true</tt>, <tt class="docutils literal">false</tt>, <tt class="docutils literal">keep</tt>,
<tt class="docutils literal"><span class="pre">keep-merge3</span></tt>, or <tt class="docutils literal"><span class="pre">keep-mergediff</span></tt> (experimental). The <tt class="docutils literal">keep</tt> option
will leave markers in the file if the premerge fails. The <tt class="docutils literal"><span class="pre">keep-merge3</span></tt>
will do the same but include information about the base of the merge in the
marker (see internal :merge3 in <a class="reference external" href="topic-merge-tools.html"><tt class="docutils literal">hg help <span class="pre">merge-tools</span></tt></a>). The
<tt class="docutils literal"><span class="pre">keep-mergediff</span></tt> option is similar but uses a different marker style
(see internal :merge3 in <a class="reference external" href="topic-merge-tools.html"><tt class="docutils literal">hg help <span class="pre">merge-tools</span></tt></a>). (default: True)</dd>
<dt><tt class="docutils literal">binary</tt></dt>
<dd>This tool can merge binary files. (default: False, unless tool
was selected by file pattern match)</dd>
<dt><tt class="docutils literal">symlink</tt></dt>
<dd>This tool can merge symlinks. (default: False)</dd>
<dt><tt class="docutils literal">check</tt></dt>
<dd><p class="first">A list of merge success-checking options:</p>
<dl class="last docutils">
<dt><tt class="docutils literal">changed</tt></dt>
<dd>Ask whether merge was successful when the merged file shows no changes.</dd>
<dt><tt class="docutils literal">conflicts</tt></dt>
<dd>Check whether there are conflicts even though the tool reported success.</dd>
<dt><tt class="docutils literal">prompt</tt></dt>
<dd>Always prompt for merge success, regardless of success reported by tool.</dd>
</dl>
</dd>
<dt><tt class="docutils literal">fixeol</tt></dt>
<dd>Attempt to fix up EOL changes caused by the merge tool.
(default: False)</dd>
<dt><tt class="docutils literal">gui</tt></dt>
<dd>This tool requires a graphical interface to run. (default: False)</dd>
<dt><tt class="docutils literal">mergemarkers</tt></dt>
<dd>Controls whether the labels passed via <tt class="docutils literal">$labellocal</tt>, <tt class="docutils literal">$labelother</tt>, and
<tt class="docutils literal">$labelbase</tt> are <tt class="docutils literal">detailed</tt> (respecting <tt class="docutils literal">mergemarkertemplate</tt>) or
<tt class="docutils literal">basic</tt>. If <tt class="docutils literal">premerge</tt> is <tt class="docutils literal">keep</tt> or <tt class="docutils literal"><span class="pre">keep-merge3</span></tt>, the conflict
markers generated during premerge will be <tt class="docutils literal">detailed</tt> if either this option or
the corresponding option in the <tt class="docutils literal">[ui]</tt> section is <tt class="docutils literal">detailed</tt>.
(default: <tt class="docutils literal">basic</tt>)</dd>
<dt><tt class="docutils literal">mergemarkertemplate</tt></dt>
<dd>This setting can be used to override <tt class="docutils literal">mergemarker</tt> from the
<tt class="docutils literal"><span class="pre">[command-templates]</span></tt> section on a per-tool basis; this applies to the
<tt class="docutils literal">$label</tt>-prefixed variables and to the conflict markers that are generated
if <tt class="docutils literal">premerge</tt> is <tt class="docutils literal">keep` or <span class="pre">``keep-merge3</span></tt>. See the corresponding variable
in <tt class="docutils literal">[ui]</tt> for more information.</dd>
</dl>
<div class="windows docutils container">
<dl class="docutils">
<dt><tt class="docutils literal">regkey</tt></dt>
<dd>Windows registry key which describes install location of this
tool. Mercurial will search for this key first under
<tt class="docutils literal">HKEY_CURRENT_USER</tt> and then under <tt class="docutils literal">HKEY_LOCAL_MACHINE</tt>.
(default: None)</dd>
<dt><tt class="docutils literal">regkeyalt</tt></dt>
<dd>An alternate Windows registry key to try if the first key is not
found. The alternate key uses the same <tt class="docutils literal">regname</tt> and <tt class="docutils literal">regappend</tt>
semantics of the primary key. The most common use for this key
is to search for 32bit applications on 64bit operating systems.
(default: None)</dd>
<dt><tt class="docutils literal">regname</tt></dt>
<dd>Name of value to read from specified registry key.
(default: the unnamed (default) value)</dd>
<dt><tt class="docutils literal">regappend</tt></dt>
<dd>String to append to the value read from the registry, typically
the executable name of the tool.
(default: None)</dd>
</dl>
</div>
</div>
<div class="section" id="pager">
<h2><a class="toc-backref" href="#contents"><tt class="docutils literal">pager</tt></a></h2>
<p>Setting used to control when to paginate and with what external tool. See
<a class="reference external" href="topic-pager.html"><tt class="docutils literal">hg help pager</tt></a> for details.</p>
<dl class="docutils">
<dt><tt class="docutils literal">pager</tt></dt>
<dd><p class="first">Define the external tool used as pager.</p>
<p>If no pager is set, Mercurial uses the environment variable $PAGER.
If neither pager.pager, nor $PAGER is set, a default pager will be
used, typically <cite>less</cite> on Unix and <cite>more</cite> on Windows. Example:</p>
<pre class="last literal-block">
[pager]
pager = less -FRX
</pre>
</dd>
<dt><tt class="docutils literal">ignore</tt></dt>
<dd><p class="first">List of commands to disable the pager for. Example:</p>
<pre class="last literal-block">
[pager]
ignore = version, help, update
</pre>
</dd>
</dl>
</div>
<div class="section" id="patch">
<h2><a class="toc-backref" href="#contents"><tt class="docutils literal">patch</tt></a></h2>
<p>Settings used when applying patches, for instance through the 'import'
command or with Mercurial Queues extension.</p>
<dl class="docutils">
<dt><tt class="docutils literal">eol</tt></dt>
<dd>When set to 'strict' patch content and patched files end of lines
are preserved. When set to <tt class="docutils literal">lf</tt> or <tt class="docutils literal">crlf</tt>, both files end of
lines are ignored when patching and the result line endings are
normalized to either LF (Unix) or CRLF (Windows). When set to
<tt class="docutils literal">auto</tt>, end of lines are again ignored while patching but line
endings in patched files are normalized to their original setting
on a per-file basis. If target file does not exist or has no end
of line, patch line endings are preserved.
(default: strict)</dd>
<dt><tt class="docutils literal">fuzz</tt></dt>
<dd>The number of lines of 'fuzz' to allow when applying patches. This
controls how much context the patcher is allowed to ignore when
trying to apply a patch.
(default: 2)</dd>
</dl>
</div>
<div class="section" id="paths">
<h2><a class="toc-backref" href="#contents"><tt class="docutils literal">paths</tt></a></h2>
<p>Assigns symbolic names and behavior to repositories.</p>
<p>Options are symbolic names defining the URL or directory that is the
location of the repository. Example:</p>
<pre class="literal-block">
[paths]
my_server = https://example.com/my_repo
local_path = /home/me/repo
</pre>
<p>These symbolic names can be used from the command line. To pull
from <tt class="docutils literal">my_server</tt>: <a class="reference external" href="hg-pull.html"><tt class="docutils literal">hg pull my_server</tt></a>. To push to <tt class="docutils literal">local_path</tt>:
<a class="reference external" href="hg-push.html"><tt class="docutils literal">hg push local_path</tt></a>. You can check <a class="reference external" href="topic-urls.html"><tt class="docutils literal">hg help urls</tt></a> for details about
valid URLs.</p>
<p>Options containing colons (<tt class="docutils literal">:</tt>) denote sub-options that can influence
behavior for that specific path. Example:</p>
<pre class="literal-block">
[paths]
my_server = https://example.com/my_path
my_server:pushurl = ssh://example.com/my_path
</pre>
<p>Paths using the <cite>path://otherpath</cite> scheme will inherit the sub-options value from
the path they point to.</p>
<p>The following sub-options can be defined:</p>
<dl class="docutils">
<dt><tt class="docutils literal"><span class="pre">multi-urls</span></tt></dt>
<dd>A boolean option. When enabled the value of the <cite>[paths]</cite> entry will be
parsed as a list and the alias will resolve to multiple destination. If some
of the list entry use the <cite>path://</cite> syntax, the suboption will be inherited
individually.</dd>
<dt><tt class="docutils literal">pushurl</tt></dt>
<dd>The URL to use for push operations. If not defined, the location
defined by the path's main entry is used.</dd>
<dt><tt class="docutils literal">pushrev</tt></dt>
<dd><p class="first">A revset defining which revisions to push by default.</p>
<p>When <a class="reference external" href="hg-push.html"><tt class="docutils literal">hg push</tt></a> is executed without a <tt class="docutils literal"><span class="pre">-r</span></tt> argument, the revset
defined by this sub-option is evaluated to determine what to push.</p>
<p>For example, a value of <tt class="docutils literal">.</tt> will push the working directory's
revision by default.</p>
<p class="last">Revsets specifying bookmarks will not result in the bookmark being
pushed.</p>
</dd>
<dt><tt class="docutils literal">bookmarks.mode</tt></dt>
<dd><p class="first">How bookmark will be dealt during the exchange. It support the following value</p>
<ul class="last simple">
<li><tt class="docutils literal">default</tt>: the default behavior, local and remote bookmarks are "merged"
on push/pull.</li>
<li><tt class="docutils literal">mirror</tt>: when pulling, replace local bookmarks by remote bookmarks. This
is useful to replicate a repository, or as an optimization.</li>
<li><tt class="docutils literal">ignore</tt>: ignore bookmarks during exchange.
(This currently only affect pulling)</li>
</ul>
</dd>
</dl>
<div class="verbose docutils container">
<p><tt class="docutils literal"><span class="pre">pulled-delta-reuse-policy</span></tt>
Control the policy regarding deltas sent by the remote during pulls.</p>
<p>This is an advanced option that non-admin users should not need to understand
or set. This option can be used to speed up pulls from trusted central
servers, or to fix-up deltas from older servers.</p>
<p>It supports the following values:</p>
<ul class="simple">
<li><tt class="docutils literal">default</tt>: use the policy defined by
<cite>storage.revlog.reuse-external-delta-parent</cite>,</li>
<li><tt class="docutils literal"><span class="pre">no-reuse</span></tt>: start a new optimal delta search for each new revision we add
to the repository. The deltas from the server will be reused when the base
it applies to is tested (this can be frequent if that base is the one and
unique parent of that revision). This can significantly slowdown pulls but
will result in an optimized storage space if the remote peer is sending poor
quality deltas.</li>
<li><tt class="docutils literal"><span class="pre">try-base</span></tt>: try to reuse the deltas from the remote peer as long as they
create a valid delta-chain in the local repository. This speeds up the
unbundling process, but can result in sub-optimal storage space if the
remote peer is sending poor quality deltas.</li>
<li><tt class="docutils literal">forced</tt>: the deltas from the peer will be reused in all cases, even if
the resulting delta-chain is "invalid". This setting will ensure the bundle
is applied at minimal CPU cost, but it can result in longer delta chains
being created on the client, making revisions potentially slower to access
in the future. If you think you need this option, you should make sure you
are also talking to the Mercurial developer community to get confirmation.</li>
</ul>
<p>See <cite>hg help config.storage.revlog.reuse-external-delta-parent</cite> for a similar
global option. That option defines the behavior of <cite>default</cite>.</p>
</div>
<p>The following special named paths exist:</p>
<dl class="docutils">
<dt><tt class="docutils literal">default</tt></dt>
<dd><p class="first">The URL or directory to use when no source or remote is specified.</p>
<p class="last"><a class="reference external" href="hg-clone.html"><tt class="docutils literal">hg clone</tt></a> will automatically define this path to the location the
repository was cloned from.</p>
</dd>
<dt><tt class="docutils literal"><span class="pre">default-push</span></tt></dt>
<dd>(deprecated) The URL or directory for the default <a class="reference external" href="hg-push.html"><tt class="docutils literal">hg push</tt></a> location.
<tt class="docutils literal">default:pushurl</tt> should be used instead.</dd>
</dl>
</div>
<div class="section" id="phases">
<h2><a class="toc-backref" href="#contents"><tt class="docutils literal">phases</tt></a></h2>
<p>Specifies default handling of phases. See <a class="reference external" href="topic-phases.html"><tt class="docutils literal">hg help phases</tt></a> for more
information about working with phases.</p>
<dl class="docutils">
<dt><tt class="docutils literal">publish</tt></dt>
<dd>Controls draft phase behavior when working as a server. When true,
pushed changesets are set to public in both client and server and
pulled or cloned changesets are set to public in the client.
(default: True)</dd>
<dt><tt class="docutils literal"><span class="pre">new-commit</span></tt></dt>
<dd>Phase of newly-created commits.
(default: draft)</dd>
<dt><tt class="docutils literal">checksubrepos</tt></dt>
<dd>Check the phase of the current revision of each subrepository. Allowed
values are "ignore", "follow" and "abort". For settings other than
"ignore", the phase of the current revision of each subrepository is
checked before committing the parent repository. If any of those phases is
greater than the phase of the parent repository (e.g. if a subrepo is in a
"secret" phase while the parent repo is in "draft" phase), the commit is
either aborted (if checksubrepos is set to "abort") or the higher phase is
used for the parent repository commit (if set to "follow").
(default: follow)</dd>
</dl>
</div>
<div class="section" id="profiling">
<h2><a class="toc-backref" href="#contents"><tt class="docutils literal">profiling</tt></a></h2>
<p>Specifies profiling type, format, and file output. Two profilers are
supported: an instrumenting profiler (named <tt class="docutils literal">ls</tt>), and a sampling
profiler (named <tt class="docutils literal">stat</tt>).</p>
<p>In this section description, 'profiling data' stands for the raw data
collected during profiling, while 'profiling report' stands for a
statistical text report generated from the profiling data.</p>
<dl class="docutils">
<dt><tt class="docutils literal">enabled</tt></dt>
<dd><p class="first">Enable the profiler.
(default: false)</p>
<p class="last">This is equivalent to passing <tt class="docutils literal"><span class="pre">--profile</span></tt> on the command line.</p>
</dd>
<dt><tt class="docutils literal">type</tt></dt>
<dd><p class="first">The type of profiler to use.
(default: stat)</p>
<dl class="last docutils">
<dt><tt class="docutils literal">ls</tt></dt>
<dd>Use Python's built-in instrumenting profiler. This profiler
works on all platforms, but each line number it reports is the
first line of a function. This restriction makes it difficult to
identify the expensive parts of a non-trivial function.</dd>
<dt><tt class="docutils literal">stat</tt></dt>
<dd>Use a statistical profiler, statprof. This profiler is most
useful for profiling commands that run for longer than about 0.1
seconds.</dd>
<dt><tt class="docutils literal"><span class="pre">py-spy</span></tt></dt>
<dd>use the py-spy profiler. A external py-spy executable must be available.
(Make sure to check <cite>profiling.output</cite> config to write the result.)</dd>
</dl>
</dd>
<dt><tt class="docutils literal">format</tt></dt>
<dd><p class="first">Profiling format. Specific to the <tt class="docutils literal">ls</tt> instrumenting profiler.
(default: text)</p>
<dl class="last docutils">
<dt><tt class="docutils literal">text</tt></dt>
<dd>Generate a profiling report. When saving to a file, it should be
noted that only the report is saved, and the profiling data is
not kept.</dd>
<dt><tt class="docutils literal">kcachegrind</tt></dt>
<dd>Format profiling data for kcachegrind use: when saving to a
file, the generated file can directly be loaded into
kcachegrind.</dd>
</dl>
</dd>
<dt><tt class="docutils literal">statformat</tt></dt>
<dd><p class="first">Profiling format for the <tt class="docutils literal">stat</tt> profiler.
(default: hotpath)</p>
<dl class="last docutils">
<dt><tt class="docutils literal">hotpath</tt></dt>
<dd>Show a tree-based display containing the hot path of execution (where
most time was spent).</dd>
<dt><tt class="docutils literal">bymethod</tt></dt>
<dd>Show a table of methods ordered by how frequently they are active.</dd>
<dt><tt class="docutils literal">byline</tt></dt>
<dd>Show a table of lines in files ordered by how frequently they are active.</dd>
<dt><tt class="docutils literal">json</tt></dt>
<dd>Render profiling data as JSON.</dd>
</dl>
</dd>
<dt><tt class="docutils literal">freq</tt></dt>
<dd>Sampling frequency. Specific to the <tt class="docutils literal">stat</tt> sampling profiler.
(default: 1000)</dd>
<dt><tt class="docutils literal">output</tt></dt>
<dd>File path where profiling data or report should be saved. If the
file exists, it is replaced. (default: None, data is printed on
stderr)</dd>
<dt><tt class="docutils literal"><span class="pre">output-dir</span></tt></dt>
<dd>Directory in which profiling data or report should be saved. The data will be written to a file with the naming scheme "hg-profile-{TIMESTAMP}-{PID}.prof". If both <tt class="docutils literal">output</tt> and <tt class="docutils literal"><span class="pre">output-dir</span></tt> are specified, <tt class="docutils literal">output</tt> will take precedence.</dd>
<dt><tt class="docutils literal"><span class="pre">output-dir:create</span></tt></dt>
<dd>Create output-dir if it doesn't already exist.</dd>
<dt><tt class="docutils literal">sort</tt></dt>
<dd>Sort field. Specific to the <tt class="docutils literal">ls</tt> instrumenting profiler.
One of <tt class="docutils literal">callcount</tt>, <tt class="docutils literal">reccallcount</tt>, <tt class="docutils literal">totaltime</tt> and
<tt class="docutils literal">inlinetime</tt>.
(default: inlinetime)</dd>
<dt><tt class="docutils literal"><span class="pre">time-track</span></tt></dt>
<dd>Control if the stat profiler track <tt class="docutils literal">cpu</tt> or <tt class="docutils literal">real</tt> time.
(default: <tt class="docutils literal">cpu</tt> on Windows, otherwise <tt class="docutils literal">real</tt>)</dd>
<dt><tt class="docutils literal">limit</tt></dt>
<dd>Number of lines to show. Specific to the <tt class="docutils literal">ls</tt> instrumenting profiler.
(default: 30)</dd>
<dt><tt class="docutils literal">nested</tt></dt>
<dd>Show at most this number of lines of drill-down info after each main entry.
This can help explain the difference between Total and Inline.
Specific to the <tt class="docutils literal">ls</tt> instrumenting profiler.
(default: 0)</dd>
<dt><tt class="docutils literal">showmin</tt></dt>
<dd><p class="first">Minimum fraction of samples an entry must have for it to be displayed.
Can be specified as a float between <tt class="docutils literal">0.0</tt> and <tt class="docutils literal">1.0</tt> or can have a
<tt class="docutils literal">%</tt> afterwards to allow values up to <tt class="docutils literal">100</tt>. e.g. <tt class="docutils literal">5%</tt>.</p>
<p>Only used by the <tt class="docutils literal">stat</tt> profiler.</p>
<p>For the <tt class="docutils literal">hotpath</tt> format, default is <tt class="docutils literal">0.05</tt>.
For the <tt class="docutils literal">chrome</tt> format, default is <tt class="docutils literal">0.005</tt>.</p>
<p class="last">The option is unused on other formats.</p>
</dd>
<dt><tt class="docutils literal">showmax</tt></dt>
<dd><p class="first">Maximum fraction of samples an entry can have before it is ignored in
display. Values format is the same as <tt class="docutils literal">showmin</tt>.</p>
<p>Only used by the <tt class="docutils literal">stat</tt> profiler.</p>
<p>For the <tt class="docutils literal">chrome</tt> format, default is <tt class="docutils literal">0.999</tt>.</p>
<p class="last">The option is unused on other formats.</p>
</dd>
<dt><tt class="docutils literal">showtime</tt></dt>
<dd>Show time taken as absolute durations, in addition to percentages.
Only used by the <tt class="docutils literal">hotpath</tt> format.
(default: true)</dd>
</dl>
</div>
<div class="section" id="progress">
<h2><a class="toc-backref" href="#contents"><tt class="docutils literal">progress</tt></a></h2>
<p>Mercurial commands can draw progress bars that are as informative as
possible. Some progress bars only offer indeterminate information, while others
have a definite end point.</p>
<dl class="docutils">
<dt><tt class="docutils literal">debug</tt></dt>
<dd>Whether to print debug info when updating the progress bar. (default: False)</dd>
<dt><tt class="docutils literal">delay</tt></dt>
<dd>Number of seconds (float) before showing the progress bar. (default: 3)</dd>
<dt><tt class="docutils literal">changedelay</tt></dt>
<dd>Minimum delay before showing a new topic. When set to less than 3 * refresh,
that value will be used instead. (default: 1)</dd>
<dt><tt class="docutils literal">estimateinterval</tt></dt>
<dd>Maximum sampling interval in seconds for speed and estimated time
calculation. (default: 60)</dd>
<dt><tt class="docutils literal">refresh</tt></dt>
<dd>Time in seconds between refreshes of the progress bar. (default: 0.1)</dd>
<dt><tt class="docutils literal">format</tt></dt>
<dd><p class="first">Format of the progress bar.</p>
<p>Valid entries for the format field are <tt class="docutils literal">topic</tt>, <tt class="docutils literal">bar</tt>, <tt class="docutils literal">number</tt>,
<tt class="docutils literal">unit</tt>, <tt class="docutils literal">estimate</tt>, <tt class="docutils literal">speed</tt>, and <tt class="docutils literal">item</tt>. <tt class="docutils literal">item</tt> defaults to the
last 20 characters of the item, but this can be changed by adding either
<tt class="docutils literal"><span class="pre">-<num></span></tt> which would take the last num characters, or <tt class="docutils literal">+<num></tt> for the
first num characters.</p>
<p class="last">(default: topic bar number estimate)</p>
</dd>
<dt><tt class="docutils literal">width</tt></dt>
<dd>If set, the maximum width of the progress information (that is, min(width,
term width) will be used).</dd>
<dt><tt class="docutils literal"><span class="pre">clear-complete</span></tt></dt>
<dd>Clear the progress bar after it's done. (default: True)</dd>
<dt><tt class="docutils literal">disable</tt></dt>
<dd>If true, don't show a progress bar.</dd>
<dt><tt class="docutils literal"><span class="pre">assume-tty</span></tt></dt>
<dd>If true, ALWAYS show a progress bar, unless disable is given.</dd>
</dl>
</div>
<div class="section" id="rebase">
<h2><a class="toc-backref" href="#contents"><tt class="docutils literal">rebase</tt></a></h2>
<dl class="docutils">
<dt><tt class="docutils literal">evolution.allowdivergence</tt></dt>
<dd>Default to False, when True allow creating divergence when performing
rebase of obsolete changesets.</dd>
</dl>
</div>
<div class="section" id="revsetalias">
<h2><a class="toc-backref" href="#contents"><tt class="docutils literal">revsetalias</tt></a></h2>
<p>Alias definitions for revsets. See <a class="reference external" href="hg.1.html#revsets"><tt class="docutils literal">hg help revsets</tt></a> for details.</p>
</div>
<div class="section" id="rewrite">
<h2><a class="toc-backref" href="#contents"><tt class="docutils literal">rewrite</tt></a></h2>
<dl class="docutils">
<dt><tt class="docutils literal"><span class="pre">backup-bundle</span></tt></dt>
<dd>Whether to save stripped changesets to a bundle file. (default: True)</dd>
<dt><tt class="docutils literal"><span class="pre">update-timestamp</span></tt></dt>
<dd>If true, updates the date and time of the changeset to current. It is only
applicable for <cite>hg amend</cite>, <cite>hg commit --amend</cite> and <cite>hg uncommit</cite> in the
current version.</dd>
</dl>
<p><tt class="docutils literal"><span class="pre">empty-successor</span></tt></p>
<blockquote>
<p>Control what happens with empty successors that are the result of rewrite
operations. If set to <tt class="docutils literal">skip</tt>, the successor is not created. If set to
<tt class="docutils literal">keep</tt>, the empty successor is created and kept.</p>
<p>Currently, only the rebase and absorb commands consider this configuration.
(EXPERIMENTAL)</p>
</blockquote>
</div>
<div class="section" id="rhg">
<h2><a class="toc-backref" href="#contents"><tt class="docutils literal">rhg</tt></a></h2>
<p>The pure Rust fast-path for Mercurial. See <cite>rust/README.md</cite> in the Mercurial repository.</p>
<dl class="docutils">
<dt><tt class="docutils literal"><span class="pre">fallback-executable</span></tt></dt>
<dd>Path to the executable to run in a sub-process when falling back to
another implementation of Mercurial.</dd>
<dt><tt class="docutils literal"><span class="pre">fallback-immediately</span></tt></dt>
<dd><p class="first">Fall back to <tt class="docutils literal"><span class="pre">fallback-executable</span></tt> as soon as possible, regardless of
the <cite>rhg.on-unsupported</cite> configuration. Useful for debugging, for example to
bypass <cite>rhg</cite> if the deault <cite>hg</cite> points to <cite>rhg</cite>.</p>
<p class="last">Note that because this requires loading the configuration, it is possible
that <cite>rhg</cite> error out before being able to fall back.</p>
</dd>
<dt><tt class="docutils literal"><span class="pre">ignored-extensions</span></tt></dt>
<dd><p class="first">Controls which extensions should be ignored by <cite>rhg</cite>. By default, <cite>rhg</cite>
triggers the <cite>rhg.on-unsupported</cite> behavior any unsupported extensions.
Users can disable that behavior when they know that a given extension
does not need support from <cite>rhg</cite>.</p>
<p>Expects a list of extension names, or <tt class="docutils literal">*</tt> to ignore all extensions.</p>
<p class="last">Note: <tt class="docutils literal"><span class="pre">*:<suboption></span></tt> is also a valid extension name for this
configuration option.
As of this writing, the only valid "global" suboption is <tt class="docutils literal">required</tt>.</p>
</dd>
<dt><tt class="docutils literal"><span class="pre">on-unsupported</span></tt></dt>
<dd><p class="first">Controls the behavior of <cite>rhg</cite> when detecting unsupported features.</p>
<p>Possible values are <cite>abort</cite> (default), <cite>abort-silent</cite> and <cite>fallback</cite>.</p>
<dl class="last docutils">
<dt><tt class="docutils literal">abort</tt></dt>
<dd>Print an error message describing what feature is not supported,
and exit with code 252</dd>
<dt><tt class="docutils literal"><span class="pre">abort-silent</span></tt></dt>
<dd>Silently exit with code 252</dd>
<dt><tt class="docutils literal">fallback</tt></dt>
<dd>Try running the fallback executable with the same parameters
(and trace the fallback reason, use <cite>RUST_LOG=trace</cite> to see).</dd>
</dl>
</dd>
</dl>
</div>
<div class="section" id="share">
<h2><a class="toc-backref" href="#contents"><tt class="docutils literal">share</tt></a></h2>
<dl class="docutils">
<dt><tt class="docutils literal"><span class="pre">safe-mismatch.source-safe</span></tt></dt>
<dd><p class="first">Controls what happens when the shared repository does not use the
share-safe mechanism but its source repository does.</p>
<p>Possible values are <cite>abort</cite> (default), <cite>allow</cite>, <cite>upgrade-abort</cite> and
<cite>upgrade-allow</cite>.</p>
<dl class="docutils">
<dt><tt class="docutils literal">abort</tt></dt>
<dd>Disallows running any command and aborts</dd>
<dt><tt class="docutils literal">allow</tt></dt>
<dd>Respects the feature presence in the share source</dd>
<dt><tt class="docutils literal"><span class="pre">upgrade-abort</span></tt></dt>
<dd>Tries to upgrade the share to use share-safe; if it fails, aborts</dd>
<dt><tt class="docutils literal"><span class="pre">upgrade-allow</span></tt></dt>
<dd>Tries to upgrade the share; if it fails, continue by
respecting the share source setting</dd>
</dl>
<p class="last">Check <a class="reference external" href="hgrc.5.html#format"><tt class="docutils literal">hg help <span class="pre">config.format.use-share-safe</span></tt></a> for details about the
share-safe feature.</p>
</dd>
<dt><tt class="docutils literal"><span class="pre">safe-mismatch.source-safe:verbose-upgrade</span></tt></dt>
<dd>Display a message when upgrading, (default: True)</dd>
<dt><tt class="docutils literal"><span class="pre">safe-mismatch.source-safe.warn</span></tt></dt>
<dd>Shows a warning on operations if the shared repository does not use
share-safe, but the source repository does.
(default: True)</dd>
<dt><tt class="docutils literal"><span class="pre">safe-mismatch.source-not-safe</span></tt></dt>
<dd><p class="first">Controls what happens when the shared repository uses the share-safe
mechanism but its source does not.</p>
<p>Possible values are <cite>abort</cite> (default), <cite>allow</cite>, <cite>downgrade-abort</cite> and
<cite>downgrade-allow</cite>.</p>
<dl class="docutils">
<dt><tt class="docutils literal">abort</tt></dt>
<dd>Disallows running any command and aborts</dd>
<dt><tt class="docutils literal">allow</tt></dt>
<dd>Respects the feature presence in the share source</dd>
<dt><tt class="docutils literal"><span class="pre">downgrade-abort</span></tt></dt>
<dd>Tries to downgrade the share to not use share-safe; if it fails, aborts</dd>
<dt><tt class="docutils literal"><span class="pre">downgrade-allow</span></tt></dt>
<dd>Tries to downgrade the share to not use share-safe;
if it fails, continue by respecting the shared source setting</dd>
</dl>
<p class="last">Check <a class="reference external" href="hgrc.5.html#format"><tt class="docutils literal">hg help <span class="pre">config.format.use-share-safe</span></tt></a> for details about the
share-safe feature.</p>
</dd>
<dt><tt class="docutils literal"><span class="pre">safe-mismatch.source-not-safe:verbose-upgrade</span></tt></dt>
<dd>Display a message when upgrading, (default: True)</dd>
<dt><tt class="docutils literal"><span class="pre">safe-mismatch.source-not-safe.warn</span></tt></dt>
<dd>Shows a warning on operations if the shared repository uses share-safe,
but the source repository does not.
(default: True)</dd>
</dl>
</div>
<div class="section" id="storage">
<h2><a class="toc-backref" href="#contents"><tt class="docutils literal">storage</tt></a></h2>
<p>Control the strategy Mercurial uses internally to store history. Options in this
category impact performance and repository size.</p>
<dl class="docutils">
<dt><tt class="docutils literal"><span class="pre">all-slow-path</span></tt></dt>
<dd><p class="first">Control the behavior of Mercurial when lacking performant code</p>
<p>Some format features might only have a fast implementation when a specific
flavor is installed (e.g. when the Rust extensions are available). A slow pure
Python implementation might be available to help with converting the repository
to another format or to perform a few accesses in an automation context.
Using such accesses might result in Mercurial becoming multiple time slower
than usual.</p>
<p>Acceptable values:</p>
<p><tt class="docutils literal">allow</tt>: Silently use the slower implementation to access the repository.
<tt class="docutils literal">warn</tt>: Warn, but use the slower implementation to access the repository.
<tt class="docutils literal">abort</tt>: Prevent access to such repositories. (This is the default)</p>
<p class="last">See the individual "storage.*.slow-path" configs for details. These options can
override the default.</p>
</dd>
<dt><tt class="docutils literal"><span class="pre">revlog.dirstate-v2.slow-path</span></tt></dt>
<dd><p class="first">Control the behavior of Mercurial when using a repository with the "dirstate-v2"
feature with an installation of Mercurial without a fast implementation for
the feature:</p>
<p><tt class="docutils literal">allow</tt>: Silently use the slower implementation to access the repository.
<tt class="docutils literal">warn</tt>: Warn, but use the slower implementation to access the repository.
<tt class="docutils literal">default</tt>: use value from the <cite>storage.all-slow-path</cite> value.
<tt class="docutils literal">abort</tt>: Prevent access to such repositories. (This is the default)</p>
<p class="last">For details on the "dirstate-v2" feature, see:
<a class="reference external" href="hgrc.5.html#format"><tt class="docutils literal">hg help <span class="pre">config.format.use-dirstate-v2</span></tt></a>.</p>
</dd>
<dt><tt class="docutils literal"><span class="pre">revlog.issue6528.fix-incoming</span></tt></dt>
<dd><p class="first">Version 5.8 of Mercurial had a bug leading to altering the parent of file
revision with copy information (or any other metadata) on exchange. This
leads to the copy metadata to be overlooked by various internal logic. The
issue was fixed in Mercurial 5.8.1.
(See <a class="reference external" href="https://bz.mercurial-scm.org/show_bug.cgi?id=6528">https://bz.mercurial-scm.org/show_bug.cgi?id=6528</a> for details)</p>
<p>As a result Mercurial is now checking and fixing incoming file revisions to
make sure there parents are in the right order. This behavior can be
disabled by setting this option to <cite>no</cite>. This apply to revisions added
through push, pull, clone and unbundle.</p>
<p class="last">To fix affected revisions that already exist within the repository, one can
use <a class="reference external" href="hg-debug-repair-issue-6528.html"><tt class="docutils literal">hg <span class="pre">debug-repair-issue-6528</span></tt></a>.</p>
</dd>
</dl>
<div class="verbose docutils container">
<dl class="docutils">
<dt><tt class="docutils literal"><span class="pre">revlog.delta-parent-search.candidate-group-chunk-size</span></tt></dt>
<dd><p class="first">Tune the number of delta bases the storage will consider in the
same "round" of search. In some very rare cases, using a smaller value
might result in faster processing at the possible expense of storage
space, while using larger values might result in slower processing at the
possible benefit of storage space. A value of "0" means no limitation.</p>
<p>default: no limitation</p>
<p class="last">This is unlikely that you'll have to tune this configuration. If you think
you do, consider talking with the mercurial developer community about your
repositories.</p>
</dd>
</dl>
</div>
<dl class="docutils">
<dt><tt class="docutils literal">revlog.mmap.index</tt></dt>
<dd>Whether to use the Operating System "memory mapping" feature (when
possible) to access the revlog index. This improves performance
and reduces memory pressure.</dd>
</dl>
<div class="verbose docutils container">
<p><tt class="docutils literal"><span class="pre">revlog.mmap.index:size-threshold</span></tt></p>
<blockquote>
The size of index above which to use the "memory mapping" feature.</blockquote>
</div>
<dl class="docutils">
<dt><tt class="docutils literal"><span class="pre">revlog.optimize-delta-parent-choice</span></tt></dt>
<dd><p class="first">When storing a merge revision, both parents will be equally considered as
a possible delta base. This results in better delta selection and improved
revlog compression. This option is enabled by default.</p>
<p class="last">Turning this option off can result in large increase of repository size for
repository with many merges.</p>
</dd>
<dt><tt class="docutils literal"><span class="pre">revlog.persistent-nodemap.mmap</span></tt></dt>
<dd><p class="first">Whether to use the Operating System "memory mapping" feature (when
possible) to access the persistent nodemap data. This improve performance
and reduce memory pressure.</p>
<p>Default to True.</p>
<p class="last">For details on the "persistent-nodemap" feature, see:
<a class="reference external" href="hgrc.5.html#format"><tt class="docutils literal">hg help <span class="pre">config.format.use-persistent-nodemap</span></tt></a>.</p>
</dd>
<dt><tt class="docutils literal"><span class="pre">revlog.persistent-nodemap.slow-path</span></tt></dt>
<dd><p class="first">Control the behavior of Mercurial when using a repository with a "persistent"
nodemap with an installation of Mercurial without a fast implementation for
the feature:</p>
<p><tt class="docutils literal">allow</tt>: Silently use the slower implementation to access the repository.
<tt class="docutils literal">warn</tt>: Warn, but use the slower implementation to access the repository.
<tt class="docutils literal">default</tt>: use the value from the <cite>storage.all-slow-path</cite> value.
<tt class="docutils literal">abort</tt>: Prevent access to such repositories. (This is the default)</p>
<p class="last">For details on the "persistent-nodemap" feature, see:
<a class="reference external" href="hgrc.5.html#format"><tt class="docutils literal">hg help <span class="pre">config.format.use-persistent-nodemap</span></tt></a>.</p>
</dd>
<dt><tt class="docutils literal"><span class="pre">revlog.reuse-external-delta-parent</span></tt></dt>
<dd><p class="first">Control the order in which delta parents are considered when adding new
revisions from an external source.
(typically: apply bundle from <cite>hg pull</cite> or <cite>hg push</cite>).</p>
<p>New revisions are usually provided as a delta against other revisions. By
default, Mercurial will try to reuse this delta first, therefore using the
same "delta parent" as the source. Directly using delta's from the source
reduces CPU usage and usually speeds up operation. However, in some case,
the source might have sub-optimal delta bases and forcing their reevaluation
is useful. For example, pushes from an old client could have sub-optimal
delta's parent that the server want to optimize. (lack of general delta, bad
parents, choice, lack of sparse-revlog, etc).</p>
<p>This option is enabled by default. Turning it off will ensure bad delta
parent choices from older client do not propagate to this repository, at
the cost of a small increase in CPU consumption.</p>
<p class="last">Note: this option only control the order in which delta parents are
considered. Even when disabled, the existing delta from the source will be
reused if the same delta parent is selected.</p>
</dd>
<dt><tt class="docutils literal"><span class="pre">revlog.reuse-external-delta</span></tt></dt>
<dd><p class="first">Control the reuse of delta from external source.
(typically: apply bundle from <cite>hg pull</cite> or <cite>hg push</cite>).</p>
<p>New revisions are usually provided as a delta against another revision. By
default, Mercurial will not recompute the same delta again, trusting
externally provided deltas. There have been rare cases of small adjustment
to the diffing algorithm in the past. So in some rare case, recomputing
delta provided by ancient clients can provides better results. Disabling
this option means going through a full delta recomputation for all incoming
revisions. It means a large increase in CPU usage and will slow operations
down.</p>
<p class="last">This option is enabled by default. When disabled, it also disables the
related <tt class="docutils literal"><span class="pre">storage.revlog.reuse-external-delta-parent</span></tt> option.</p>
</dd>
<dt><tt class="docutils literal">revlog.zlib.level</tt></dt>
<dd>Zlib compression level used when storing data into the repository. Accepted
Value range from 1 (lowest compression) to 9 (highest compression). Zlib
default value is 6.</dd>
<dt><tt class="docutils literal">revlog.zstd.level</tt></dt>
<dd>zstd compression level used when storing data into the repository. Accepted
Value range from 1 (lowest compression) to 22 (highest compression).
(default 3)</dd>
</dl>
</div>
<div class="section" id="server">
<h2><a class="toc-backref" href="#contents"><tt class="docutils literal">server</tt></a></h2>
<p>Controls generic server settings.</p>
<dl class="docutils">
<dt><tt class="docutils literal"><span class="pre">bookmarks-pushkey-compat</span></tt></dt>
<dd><p class="first">Trigger pushkey hook when being pushed bookmark updates. This config exist
for compatibility purpose (default to True)</p>
<p class="last">If you use <tt class="docutils literal">pushkey</tt> and <tt class="docutils literal"><span class="pre">pre-pushkey</span></tt> hooks to control bookmark
movement we recommend you migrate them to <tt class="docutils literal"><span class="pre">txnclose-bookmark</span></tt> and
<tt class="docutils literal"><span class="pre">pretxnclose-bookmark</span></tt>.</p>
</dd>
<dt><tt class="docutils literal">compressionengines</tt></dt>
<dd><p class="first">List of compression engines and their relative priority to advertise
to clients.</p>
<p>The order of compression engines determines their priority, the first
having the highest priority. If a compression engine is not listed
here, it won't be advertised to clients.</p>
<p>If not set (the default), built-in defaults are used. Run
<a class="reference external" href="hg-debuginstall.html"><tt class="docutils literal">hg debuginstall</tt></a> to list available compression engines and their
default wire protocol priority.</p>
<p class="last">Older Mercurial clients only support zlib compression and this setting
has no effect for legacy clients.</p>
</dd>
<dt><tt class="docutils literal">uncompressed</tt></dt>
<dd>Whether to allow clients to clone a repository using the
uncompressed streaming protocol. This transfers about 40% more
data than a regular clone, but uses less memory and CPU on both
server and client. Over a LAN (100 Mbps or better) or a very fast
WAN, an uncompressed streaming clone is a lot faster (~10x) than a
regular clone. Over most WAN connections (anything slower than
about 6 Mbps), uncompressed streaming is slower, because of the
extra data transfer overhead. This mode will also temporarily hold
the write lock while determining what data to transfer.
(default: True)</dd>
<dt><tt class="docutils literal">uncompressedallowsecret</tt></dt>
<dd>Whether to allow stream clones when the repository contains secret
changesets. (default: False)</dd>
<dt><tt class="docutils literal">preferuncompressed</tt></dt>
<dd>When set, clients will try to use the uncompressed streaming
protocol. (default: False)</dd>
<dt><tt class="docutils literal">disablefullbundle</tt></dt>
<dd>When set, servers will refuse attempts to do pull-based clones.
If this option is set, <tt class="docutils literal">preferuncompressed</tt> and/or clone bundles
are highly recommended. Partial clones will still be allowed.
(default: False)</dd>
<dt><tt class="docutils literal">streamunbundle</tt></dt>
<dd>When set, servers will apply data sent from the client directly,
otherwise it will be written to a temporary file first. This option
effectively prevents concurrent pushes.</dd>
<dt><tt class="docutils literal">pullbundle</tt></dt>
<dd><p class="first">When set, the server will check pullbundles.manifest for bundles
covering the requested heads and common nodes. The first matching
entry will be streamed to the client.</p>
<p class="last">For HTTP transport, the stream will still use zlib compression
for older clients.</p>
</dd>
<dt><tt class="docutils literal"><span class="pre">concurrent-push-mode</span></tt></dt>
<dd><p class="first">Level of allowed race condition between two pushing clients.</p>
<ul class="simple">
<li>'strict': push is abort if another client touched the repository
while the push was preparing.</li>
<li>'check-related': push is only aborted if it affects head that got also
affected while the push was preparing. (default since 5.4)</li>
</ul>
<p class="last">'check-related' only takes effect for compatible clients (version
4.3 and later). Older clients will use 'strict'.</p>
</dd>
<dt><tt class="docutils literal">validate</tt></dt>
<dd>Whether to validate the completeness of pushed changesets by
checking that all new file revisions specified in manifests are
present. (default: False)</dd>
<dt><tt class="docutils literal">maxhttpheaderlen</tt></dt>
<dd>Instruct HTTP clients not to send request headers longer than this
many bytes. (default: 1024)</dd>
<dt><tt class="docutils literal">bundle1</tt></dt>
<dd>Whether to allow clients to push and pull using the legacy bundle1
exchange format. (default: True)</dd>
<dt><tt class="docutils literal">bundle1gd</tt></dt>
<dd>Like <tt class="docutils literal">bundle1</tt> but only used if the repository is using the
<em>generaldelta</em> storage format. (default: True)</dd>
<dt><tt class="docutils literal">bundle1.push</tt></dt>
<dd>Whether to allow clients to push using the legacy bundle1 exchange
format. (default: True)</dd>
<dt><tt class="docutils literal">bundle1gd.push</tt></dt>
<dd>Like <tt class="docutils literal">bundle1.push</tt> but only used if the repository is using the
<em>generaldelta</em> storage format. (default: True)</dd>
<dt><tt class="docutils literal">bundle1.pull</tt></dt>
<dd>Whether to allow clients to pull using the legacy bundle1 exchange
format. (default: True)</dd>
<dt><tt class="docutils literal">bundle1gd.pull</tt></dt>
<dd><p class="first">Like <tt class="docutils literal">bundle1.pull</tt> but only used if the repository is using the
<em>generaldelta</em> storage format. (default: True)</p>
<p class="last">Large repositories using the <em>generaldelta</em> storage format should
consider setting this option because converting <em>generaldelta</em>
repositories to the exchange format required by the bundle1 data
format can consume a lot of CPU.</p>
</dd>
<dt><tt class="docutils literal">bundle2.stream</tt></dt>
<dd>Whether to allow clients to pull using the bundle2 streaming protocol.
(default: True)</dd>
<dt><tt class="docutils literal">zliblevel</tt></dt>
<dd><p class="first">Integer between <tt class="docutils literal"><span class="pre">-1</span></tt> and <tt class="docutils literal">9</tt> that controls the zlib compression level
for wire protocol commands that send zlib compressed output (notably the
commands that send repository history data).</p>
<p>The default (<tt class="docutils literal"><span class="pre">-1</span></tt>) uses the default zlib compression level, which is
likely equivalent to <tt class="docutils literal">6</tt>. <tt class="docutils literal">0</tt> means no compression. <tt class="docutils literal">9</tt> means
maximum compression.</p>
<p>Setting this option allows server operators to make trade-offs between
bandwidth and CPU used. Lowering the compression lowers CPU utilization
but sends more bytes to clients.</p>
<p class="last">This option only impacts the HTTP server.</p>
</dd>
<dt><tt class="docutils literal">zstdlevel</tt></dt>
<dd><p class="first">Integer between <tt class="docutils literal">1</tt> and <tt class="docutils literal">22</tt> that controls the zstd compression level
for wire protocol commands. <tt class="docutils literal">1</tt> is the minimal amount of compression and
<tt class="docutils literal">22</tt> is the highest amount of compression.</p>
<p>The default (<tt class="docutils literal">3</tt>) should be significantly faster than zlib while likely
delivering better compression ratios.</p>
<p>This option only impacts the HTTP server.</p>
<p class="last">See also <tt class="docutils literal">server.zliblevel</tt>.</p>
</dd>
<dt><tt class="docutils literal">view</tt></dt>
<dd><p class="first">Repository filter used when exchanging revisions with the peer.</p>
<p class="last">The default view (<tt class="docutils literal">served</tt>) excludes secret and hidden changesets.
Another useful value is <tt class="docutils literal">immutable</tt> (no draft, secret or hidden
changesets). (EXPERIMENTAL)</p>
</dd>
</dl>
</div>
<div class="section" id="smtp">
<h2><a class="toc-backref" href="#contents"><tt class="docutils literal">smtp</tt></a></h2>
<p>Configuration for extensions that need to send email messages.</p>
<dl class="docutils">
<dt><tt class="docutils literal">host</tt></dt>
<dd>Host name of mail server, e.g. "mail.example.com".</dd>
<dt><tt class="docutils literal">port</tt></dt>
<dd>Optional. Port to connect to on mail server. (default: 465 if
<tt class="docutils literal">tls</tt> is smtps; 25 otherwise)</dd>
<dt><tt class="docutils literal">tls</tt></dt>
<dd>Optional. Method to enable TLS when connecting to mail server: starttls,
smtps or none. (default: none)</dd>
<dt><tt class="docutils literal">username</tt></dt>
<dd>Optional. User name for authenticating with the SMTP server.
(default: None)</dd>
<dt><tt class="docutils literal">password</tt></dt>
<dd>Optional. Password for authenticating with the SMTP server. If not
specified, interactive sessions will prompt the user for a
password; non-interactive sessions will fail. (default: None)</dd>
<dt><tt class="docutils literal">local_hostname</tt></dt>
<dd>Optional. The hostname that the sender can use to identify
itself to the MTA.</dd>
</dl>
</div>
<div class="section" id="subpaths">
<h2><a class="toc-backref" href="#contents"><tt class="docutils literal">subpaths</tt></a></h2>
<p>Subrepository source URLs can go stale if a remote server changes name
or becomes temporarily unavailable. This section lets you define
rewrite rules of the form:</p>
<pre class="literal-block">
<pattern> = <replacement>
</pre>
<p>where <tt class="docutils literal">pattern</tt> is a regular expression matching a subrepository
source URL and <tt class="docutils literal">replacement</tt> is the replacement string used to
rewrite it. Groups can be matched in <tt class="docutils literal">pattern</tt> and referenced in
<tt class="docutils literal">replacements</tt>. For instance:</p>
<pre class="literal-block">
http://server/(.*)-hg/ = http://hg.server/\1/
</pre>
<p>rewrites <tt class="docutils literal"><span class="pre">http://server/foo-hg/</span></tt> into <tt class="docutils literal"><span class="pre">http://hg.server/foo/</span></tt>.</p>
<p>Relative subrepository paths are first made absolute, and the
rewrite rules are then applied on the full (absolute) path. If <tt class="docutils literal">pattern</tt>
doesn't match the full path, an attempt is made to apply it on the
relative path alone. The rules are applied in definition order.</p>
</div>
<div class="section" id="subrepos">
<h2><a class="toc-backref" href="#contents"><tt class="docutils literal">subrepos</tt></a></h2>
<p>This section contains options that control the behavior of the
subrepositories feature. See also <a class="reference external" href="topic-subrepos.html"><tt class="docutils literal">hg help subrepos</tt></a>.</p>
<p>Security note: auditing in Mercurial is known to be insufficient to
prevent clone-time code execution with carefully constructed Git
subrepos. It is unknown if a similar detect is present in Subversion
subrepos. Both Git and Subversion subrepos are disabled by default
out of security concerns. These subrepo types can be enabled using
the respective options below.</p>
<dl class="docutils">
<dt><tt class="docutils literal">allowed</tt></dt>
<dd><p class="first">Whether subrepositories are allowed in the working directory.</p>
<p class="last">When false, commands involving subrepositories (like <a class="reference external" href="hg-update.html"><tt class="docutils literal">hg update</tt></a>)
will fail for all subrepository types.
(default: true)</p>
</dd>
<dt><tt class="docutils literal">hg:allowed</tt></dt>
<dd>Whether Mercurial subrepositories are allowed in the working
directory. This option only has an effect if <tt class="docutils literal">subrepos.allowed</tt>
is true.
(default: true)</dd>
<dt><tt class="docutils literal">git:allowed</tt></dt>
<dd><p class="first">Whether Git subrepositories are allowed in the working directory.
This option only has an effect if <tt class="docutils literal">subrepos.allowed</tt> is true.</p>
<p class="last">See the security note above before enabling Git subrepos.
(default: false)</p>
</dd>
<dt><tt class="docutils literal">svn:allowed</tt></dt>
<dd><p class="first">Whether Subversion subrepositories are allowed in the working
directory. This option only has an effect if <tt class="docutils literal">subrepos.allowed</tt>
is true.</p>
<p class="last">See the security note above before enabling Subversion subrepos.
(default: false)</p>
</dd>
</dl>
</div>
<div class="section" id="templatealias">
<h2><a class="toc-backref" href="#contents"><tt class="docutils literal">templatealias</tt></a></h2>
<p>Alias definitions for templates. See <a class="reference external" href="hg.1.html#templates"><tt class="docutils literal">hg help templates</tt></a> for details.</p>
</div>
<div class="section" id="templates">
<h2><a class="toc-backref" href="#contents"><tt class="docutils literal">templates</tt></a></h2>
<p>Use the <tt class="docutils literal">[templates]</tt> section to define template strings.
See <a class="reference external" href="hg.1.html#templates"><tt class="docutils literal">hg help templates</tt></a> for details.</p>
</div>
<div class="section" id="trusted">
<h2><a class="toc-backref" href="#contents"><tt class="docutils literal">trusted</tt></a></h2>
<p>Mercurial will not use the settings in the
<tt class="docutils literal">.hg/hgrc</tt> file from a repository if it doesn't belong to a trusted
user or to a trusted group, as various hgrc features allow arbitrary
commands to be run. This issue is often encountered when configuring
hooks or extensions for shared repositories or servers. However,
the web interface will use some safe settings from the <tt class="docutils literal">[web]</tt>
section.</p>
<p>This section specifies what users and groups are trusted. The
current user is always trusted. To trust everybody, list a user or a
group with name <tt class="docutils literal">*</tt>. These settings must be placed in an
<em>already-trusted file</em> to take effect, such as <tt class="docutils literal"><span class="pre">$HOME/.hgrc</span></tt> of the
user or service running Mercurial.</p>
<dl class="docutils">
<dt><tt class="docutils literal">users</tt></dt>
<dd>Comma-separated list of trusted users.</dd>
<dt><tt class="docutils literal">groups</tt></dt>
<dd>Comma-separated list of trusted groups.</dd>
</dl>
</div>
<div class="section" id="ui">
<h2><a class="toc-backref" href="#contents"><tt class="docutils literal">ui</tt></a></h2>
<p>User interface controls.</p>
<dl class="docutils">
<dt><tt class="docutils literal">archivemeta</tt></dt>
<dd>Whether to include the .hg_archival.txt file containing meta data
(hashes for the repository base and for tip) in archives created
by the <a class="reference external" href="hg-archive.html"><tt class="docutils literal">hg archive</tt></a> command or downloaded via hgweb.
(default: True)</dd>
<dt><tt class="docutils literal">askusername</tt></dt>
<dd>Whether to prompt for a username when committing. If True, and
neither <tt class="docutils literal">$HGUSER</tt> nor <tt class="docutils literal">$EMAIL</tt> has been specified, then the user will
be prompted to enter a username. If no username is entered, the
default <tt class="docutils literal">USER@HOST</tt> is used instead.
(default: False)</dd>
<dt><tt class="docutils literal">clonebundles</tt></dt>
<dd><p class="first">Whether the "clone bundles" feature is enabled.</p>
<p>When enabled, <a class="reference external" href="hg-clone.html"><tt class="docutils literal">hg clone</tt></a> may download and apply a server-advertised
bundle file from a URL instead of using the normal exchange mechanism.</p>
<p>This can likely result in faster and more reliable clones.</p>
<p class="last">(default: True)</p>
</dd>
<dt><tt class="docutils literal">clonebundlefallback</tt></dt>
<dd><p class="first">Whether failure to apply an advertised "clone bundle" from a server
should result in fallback to a regular clone.</p>
<p>This is disabled by default because servers advertising "clone
bundles" often do so to reduce server load. If advertised bundles
start mass failing and clients automatically fall back to a regular
clone, this would add significant and unexpected load to the server
since the server is expecting clone operations to be offloaded to
pre-generated bundles. Failing fast (the default behavior) ensures
clients don't overwhelm the server when "clone bundle" application
fails.</p>
<p class="last">(default: False)</p>
</dd>
<dt><tt class="docutils literal">clonebundleprefers</tt></dt>
<dd><p class="first">Defines preferences for which "clone bundles" to use.</p>
<p>Servers advertising "clone bundles" may advertise multiple available
bundles. Each bundle may have different attributes, such as the bundle
type and compression format. This option is used to prefer a particular
bundle over another.</p>
<p>The following keys are defined by Mercurial:</p>
<dl class="docutils">
<dt>BUNDLESPEC</dt>
<dd>A bundle type specifier. These are strings passed to <a class="reference external" href="hg-bundle.html"><tt class="docutils literal">hg bundle <span class="pre">-t</span></tt></a>.
e.g. <tt class="docutils literal"><span class="pre">gzip-v2</span></tt> or <tt class="docutils literal"><span class="pre">bzip2-v1</span></tt>.</dd>
<dt>COMPRESSION</dt>
<dd>The compression format of the bundle. e.g. <tt class="docutils literal">gzip</tt> and <tt class="docutils literal">bzip2</tt>.</dd>
</dl>
<p>Server operators may define custom keys.</p>
<p>Example values: <tt class="docutils literal">COMPRESSION=bzip2</tt>,
<tt class="docutils literal"><span class="pre">BUNDLESPEC=gzip-v2,</span> COMPRESSION=gzip</tt>.</p>
<p class="last">By default, the first bundle advertised by the server is used.</p>
</dd>
<dt><tt class="docutils literal">color</tt></dt>
<dd>When to colorize output. Possible value are Boolean ("yes" or "no"), or
"debug", or "always". (default: "yes"). "yes" will use color whenever it
seems possible. See <a class="reference external" href="topic-color.html"><tt class="docutils literal">hg help color</tt></a> for details.</dd>
<dt><tt class="docutils literal">commitsubrepos</tt></dt>
<dd>Whether to commit modified subrepositories when committing the
parent repository. If False and one subrepository has uncommitted
changes, abort the commit.
(default: False)</dd>
<dt><tt class="docutils literal">debug</tt></dt>
<dd>Print debugging information. (default: False)</dd>
<dt><tt class="docutils literal">editor</tt></dt>
<dd>The editor to use during a commit. (default: <tt class="docutils literal">$EDITOR</tt> or <tt class="docutils literal">vi</tt>)</dd>
<dt><tt class="docutils literal">fallbackencoding</tt></dt>
<dd>Encoding to try if it's not possible to decode the changelog using
UTF-8. (default: ISO-8859-1)</dd>
<dt><tt class="docutils literal">graphnodetemplate</tt></dt>
<dd>(DEPRECATED) Use <tt class="docutils literal"><span class="pre">command-templates.graphnode</span></tt> instead.</dd>
<dt><tt class="docutils literal">ignore</tt></dt>
<dd>A file to read per-user ignore patterns from. This file should be
in the same format as a repository-wide .hgignore file. Filenames
are relative to the repository root. This option supports hook syntax,
so if you want to specify multiple ignore files, you can do so by
setting something like <tt class="docutils literal">ignore.other = <span class="pre">~/.hgignore2</span></tt>. For details
of the ignore file format, see the <tt class="docutils literal">hgignore(5)</tt> man page.</dd>
<dt><tt class="docutils literal">interactive</tt></dt>
<dd>Allow to prompt the user. (default: True)</dd>
<dt><tt class="docutils literal">interface</tt></dt>
<dd>Select the default interface for interactive features (default: text).
Possible values are 'text' and 'curses'.</dd>
<dt><tt class="docutils literal">interface.chunkselector</tt></dt>
<dd>Select the interface for change recording (e.g. <a class="reference external" href="hg-commit.html"><tt class="docutils literal">hg commit <span class="pre">-i</span></tt></a>).
Possible values are 'text' and 'curses'.
This config overrides the interface specified by ui.interface.</dd>
<dt><tt class="docutils literal"><span class="pre">large-file-limit</span></tt></dt>
<dd>Largest file size that gives no memory use warning.
Possible values are integers or 0 to disable the check.
Value is expressed in bytes by default, one can use standard units for
convenience (e.g. 10MB, 0.1GB, etc) (default: 10MB)</dd>
<dt><tt class="docutils literal">logtemplate</tt></dt>
<dd>(DEPRECATED) Use <tt class="docutils literal"><span class="pre">command-templates.log</span></tt> instead.</dd>
<dt><tt class="docutils literal">merge</tt></dt>
<dd>The conflict resolution program to use during a manual merge.
For more information on merge tools see <a class="reference external" href="topic-merge-tools.html"><tt class="docutils literal">hg help <span class="pre">merge-tools</span></tt></a>.
For configuring merge tools see the <tt class="docutils literal"><span class="pre">[merge-tools]</span></tt> section.</dd>
<dt><tt class="docutils literal">mergemarkers</tt></dt>
<dd>Sets the merge conflict marker label styling. The <tt class="docutils literal">detailed</tt> style
uses the <tt class="docutils literal"><span class="pre">command-templates.mergemarker</span></tt> setting to style the labels.
The <tt class="docutils literal">basic</tt> style just uses 'local' and 'other' as the marker label.
One of <tt class="docutils literal">basic</tt> or <tt class="docutils literal">detailed</tt>.
(default: <tt class="docutils literal">basic</tt>)</dd>
<dt><tt class="docutils literal">mergemarkertemplate</tt></dt>
<dd>(DEPRECATED) Use <tt class="docutils literal"><span class="pre">command-templates.mergemarker</span></tt> instead.</dd>
<dt><tt class="docutils literal"><span class="pre">message-output</span></tt></dt>
<dd><p class="first">Where to write status and error messages. (default: <tt class="docutils literal">stdio</tt>)</p>
<dl class="last docutils">
<dt><tt class="docutils literal">channel</tt></dt>
<dd>Use separate channel for structured output. (Command-server only)</dd>
<dt><tt class="docutils literal">stderr</tt></dt>
<dd>Everything to stderr.</dd>
<dt><tt class="docutils literal">stdio</tt></dt>
<dd>Status to stdout, and error to stderr.</dd>
</dl>
</dd>
<dt><tt class="docutils literal">origbackuppath</tt></dt>
<dd>The path to a directory used to store generated .orig files. If the path is
not a directory, one will be created. If set, files stored in this
directory have the same name as the original file and do not have a .orig
suffix.</dd>
<dt><tt class="docutils literal">paginate</tt></dt>
<dd>Control the pagination of command output (default: True). See <a class="reference external" href="topic-pager.html"><tt class="docutils literal">hg help pager</tt></a>
for details.</dd>
<dt><tt class="docutils literal">patch</tt></dt>
<dd><p class="first">An optional external tool that <tt class="docutils literal">hg import</tt> and some extensions
will use for applying patches. By default Mercurial uses an
internal patch utility. The external tool must work as the common
Unix <tt class="docutils literal">patch</tt> program. In particular, it must accept a <tt class="docutils literal"><span class="pre">-p</span></tt>
argument to strip patch headers, a <tt class="docutils literal"><span class="pre">-d</span></tt> argument to specify the
current directory, a file name to patch, and a patch file to take
from stdin.</p>
<p class="last">It is possible to specify a patch tool together with extra
arguments. For example, setting this option to <tt class="docutils literal">patch <span class="pre">--merge</span></tt>
will use the <tt class="docutils literal">patch</tt> program with its 2-way merge option.</p>
</dd>
<dt><tt class="docutils literal">portablefilenames</tt></dt>
<dd><p class="first">Check for portable filenames. Can be <tt class="docutils literal">warn</tt>, <tt class="docutils literal">ignore</tt> or <tt class="docutils literal">abort</tt>.
(default: <tt class="docutils literal">warn</tt>)</p>
<dl class="docutils">
<dt><tt class="docutils literal">warn</tt></dt>
<dd>Print a warning message on POSIX platforms, if a file with a non-portable
filename is added (e.g. a file with a name that can't be created on
Windows because it contains reserved parts like <tt class="docutils literal">AUX</tt>, reserved
characters like <tt class="docutils literal">:</tt>, or would cause a case collision with an existing
file).</dd>
<dt><tt class="docutils literal">ignore</tt></dt>
<dd>Don't print a warning.</dd>
<dt><tt class="docutils literal">abort</tt></dt>
<dd>The command is aborted.</dd>
<dt><tt class="docutils literal">true</tt></dt>
<dd>Alias for <tt class="docutils literal">warn</tt>.</dd>
<dt><tt class="docutils literal">false</tt></dt>
<dd>Alias for <tt class="docutils literal">ignore</tt>.</dd>
</dl>
<div class="windows last docutils container">
On Windows, this configuration option is ignored and the command aborted.</div>
</dd>
<dt><tt class="docutils literal"><span class="pre">pre-merge-tool-output-template</span></tt></dt>
<dd>(DEPRECATED) Use <tt class="docutils literal"><span class="pre">command-template.pre-merge-tool-output</span></tt> instead.</dd>
<dt><tt class="docutils literal">quiet</tt></dt>
<dd>Reduce the amount of output printed.
(default: False)</dd>
<dt><tt class="docutils literal"><span class="pre">relative-paths</span></tt></dt>
<dd>Prefer relative paths in the UI.</dd>
<dt><tt class="docutils literal">remotecmd</tt></dt>
<dd>Remote command to use for clone/push/pull operations.
(default: <tt class="docutils literal">hg</tt>)</dd>
<dt><tt class="docutils literal">report_untrusted</tt></dt>
<dd>Warn if a <tt class="docutils literal">.hg/hgrc</tt> file is ignored due to not being owned by a
trusted user or group.
(default: True)</dd>
<dt><tt class="docutils literal">slash</tt></dt>
<dd><p class="first">(Deprecated. Use <tt class="docutils literal">slashpath</tt> template filter instead.)</p>
<p class="last">Display paths using a slash (<tt class="docutils literal">/</tt>) as the path separator. This
only makes a difference on systems where the default path
separator is not the slash character (e.g. Windows uses the
backslash character (<tt class="docutils literal">\</tt>)).
(default: False)</p>
</dd>
<dt><tt class="docutils literal">statuscopies</tt></dt>
<dd>Display copies in the status command.</dd>
<dt><tt class="docutils literal">ssh</tt></dt>
<dd>Command to use for SSH connections. (default: <tt class="docutils literal">ssh</tt>)</dd>
<dt><tt class="docutils literal">ssherrorhint</tt></dt>
<dd>A hint shown to the user in the case of SSH error (e.g.
<tt class="docutils literal">Please see <span class="pre">http://company/internalwiki/ssh.html</span></tt>)</dd>
<dt><tt class="docutils literal">strict</tt></dt>
<dd>Require exact command names, instead of allowing unambiguous
abbreviations. (default: False)</dd>
<dt><tt class="docutils literal">style</tt></dt>
<dd>Name of style to use for command output.</dd>
<dt><tt class="docutils literal">supportcontact</tt></dt>
<dd>A URL where users should report a Mercurial traceback. Use this if you are a
large organisation with its own Mercurial deployment process and crash
reports should be addressed to your internal support.</dd>
<dt><tt class="docutils literal">textwidth</tt></dt>
<dd>Maximum width of help text. A longer line generated by <tt class="docutils literal">hg help</tt> or
<tt class="docutils literal">hg subcommand <span class="pre">--help</span></tt> will be broken after white space to get this
width or the terminal width, whichever comes first.
A non-positive value will disable this and the terminal width will be
used. (default: 78)</dd>
<dt><tt class="docutils literal">timeout</tt></dt>
<dd>The timeout used when a lock is held (in seconds), a negative value
means no timeout. (default: 600)</dd>
<dt><tt class="docutils literal">timeout.warn</tt></dt>
<dd>Time (in seconds) before a warning is printed about held lock. A negative
value means no warning. (default: 0)</dd>
<dt><tt class="docutils literal">traceback</tt></dt>
<dd>Mercurial always prints a traceback when an unknown exception
occurs. Setting this to True will make Mercurial print a traceback
on all exceptions, even those recognized by Mercurial (such as
IOError or MemoryError). (default: False)</dd>
</dl>
<p><tt class="docutils literal">tweakdefaults</tt></p>
<blockquote>
<p>By default Mercurial's behavior changes very little from release
to release, but over time the recommended config settings
shift. Enable this config to opt in to get automatic tweaks to
Mercurial's behavior over time. This config setting will have no
effect if <tt class="docutils literal">HGPLAIN</tt> is set or <tt class="docutils literal">HGPLAINEXCEPT</tt> is set and does
not include <tt class="docutils literal">tweakdefaults</tt>. (default: False)</p>
<p>It currently means:</p>
<pre class="literal-block">
[ui]
# The rollback command is dangerous. As a rule, don't use it.
rollback = False
# Make `hg status` report copy information
statuscopies = yes
# Prefer curses UIs when available. Revert to plain-text with `text`.
interface = curses
# Make compatible commands emit cwd-relative paths by default.
relative-paths = yes
[commands]
# Grep working directory by default.
grep.all-files = True
# Refuse to perform an `hg update` that would cause a file content merge
update.check = noconflict
# Show conflicts information in `hg status`
status.verbose = True
# Make `hg resolve` with no action (like `-m`) fail instead of re-merging.
resolve.explicit-re-merge = True
[diff]
git = 1
showfunc = 1
word-diff = 1
</pre>
</blockquote>
<dl class="docutils">
<dt><tt class="docutils literal">username</tt></dt>
<dd><p class="first">The committer of a changeset created when running "commit".
Typically a person's name and email address, e.g. <tt class="docutils literal">Fred Widget
<fred@example.com></tt>. Environment variables in the
username are expanded.</p>
<p class="last">(default: <tt class="docutils literal">$EMAIL</tt> or <tt class="docutils literal">username@hostname</tt>. If the username in
hgrc is empty, e.g. if the system admin set <tt class="docutils literal">username =</tt> in the
system hgrc, it has to be specified manually or in a different
hgrc file)</p>
</dd>
<dt><tt class="docutils literal">verbose</tt></dt>
<dd>Increase the amount of output printed. (default: False)</dd>
</dl>
</div>
<div class="section" id="usage">
<h2><a class="toc-backref" href="#contents"><tt class="docutils literal">usage</tt></a></h2>
<dl class="docutils">
<dt><tt class="docutils literal"><span class="pre">repository-role</span></tt></dt>
<dd><p class="first">What this repository is used for.</p>
<p>This is used to adjust behavior and performance to best fit the repository purpose.</p>
<p>Currently recognised values are:</p>
<ul class="last simple">
<li><tt class="docutils literal">default</tt>: an all purpose repository</li>
</ul>
</dd>
<dt><tt class="docutils literal">resources</tt></dt>
<dd><p class="first">How aggressive Mercurial can be with resource usage:</p>
<p>Currently recognised values are:</p>
<ul class="simple">
<li><tt class="docutils literal">default</tt>: the default value currently is equivalent to medium,</li>
<li><tt class="docutils literal">high</tt>: allows for higher cpu, memory and disk-space usage to improve
performance of some operations.</li>
<li><tt class="docutils literal">medium</tt>: aims at a moderate resource usage,</li>
<li><tt class="docutils literal">low</tt>: reduces resources usage when possible, decreasing overall
performance.</li>
</ul>
<p class="last">For finer configuration, see also <cite>usage.resources.cpu</cite>,
<cite>usage.resources.disk</cite> and <cite>usage.resources.memory</cite>.</p>
</dd>
<dt><tt class="docutils literal">resources.cpu</tt></dt>
<dd><p class="first">How aggressive Mercurial can be in terms of cpu usage:</p>
<p>Currently recognised values are:</p>
<ul class="last simple">
<li><tt class="docutils literal">default</tt>: the default value, inherits the value from <cite>usage.resources</cite>,</li>
<li><tt class="docutils literal">high</tt>: allows for more aggressive cpu usage, improving storage quality
and the performance of some operations at the expense of machine load</li>
<li><cite>medium</cite>: aims at a moderate cpu usage,</li>
<li><cite>low</cite>: reduces cpu usage when possible, potentially at the expense of
slower operations, increased storage and exchange payload.</li>
</ul>
</dd>
<dt><tt class="docutils literal">resources.disk</tt></dt>
<dd><p class="first">How aggressive Mercurial can be in terms of disk usage:</p>
<p>Currently recognised values are::
- <tt class="docutils literal">default</tt>: the default value, inherits the value from <cite>usage.resources</cite>,</p>
<ul class="last simple">
<li><tt class="docutils literal">high</tt>: allows for more disk space usage where it can improve performance,</li>
<li><tt class="docutils literal">medium</tt>: aims at a moderate disk usage,</li>
<li><tt class="docutils literal">low</tt>: reduces disk usage when possible, decreasing performance in some
occasion.</li>
</ul>
</dd>
<dt><tt class="docutils literal">resources.memory</tt></dt>
<dd><p class="first">How aggressive Mercurial can be in terms of memory usage:</p>
<p>Currently recognised values are:</p>
<pre class="literal-block">
- ``default``: the default value, inherits the value from `usage.resources`,
</pre>
<ul class="last simple">
<li><tt class="docutils literal">high</tt>: allows for more aggressive memory usage to improve overall
performance,</li>
<li><tt class="docutils literal">medium</tt>: aims at a moderate memory usage,</li>
<li><tt class="docutils literal">low</tt>: reduces memory usage when possible at the cost of overall
performance.</li>
</ul>
</dd>
</dl>
</div>
<div class="section" id="command-templates">
<h2><a class="toc-backref" href="#contents"><tt class="docutils literal"><span class="pre">command-templates</span></tt></a></h2>
<p>Templates used for customizing the output of commands.</p>
<dl class="docutils">
<dt><tt class="docutils literal">graphnode</tt></dt>
<dd>The template used to print changeset nodes in an ASCII revision graph.
(default: <tt class="docutils literal">{graphnode}</tt>)</dd>
<dt><tt class="docutils literal">log</tt></dt>
<dd>Template string for commands that print changesets.</dd>
<dt><tt class="docutils literal">mergemarker</tt></dt>
<dd><p class="first">The template used to print the commit description next to each conflict
marker during merge conflicts. See <a class="reference external" href="hg.1.html#templates"><tt class="docutils literal">hg help templates</tt></a> for the template
format.</p>
<p>Defaults to showing the hash, tags, branches, bookmarks, author, and
the first line of the commit description.</p>
<p>If you use non-ASCII characters in names for tags, branches, bookmarks,
authors, and/or commit descriptions, you must pay attention to encodings of
managed files. At template expansion, non-ASCII characters use the encoding
specified by the <tt class="docutils literal"><span class="pre">--encoding</span></tt> global option, <tt class="docutils literal">HGENCODING</tt> or other
environment variables that govern your locale. If the encoding of the merge
markers is different from the encoding of the merged files,
serious problems may occur.</p>
<p class="last">Can be overridden per-merge-tool, see the <tt class="docutils literal"><span class="pre">[merge-tools]</span></tt> section.</p>
</dd>
<dt><tt class="docutils literal"><span class="pre">oneline-summary</span></tt></dt>
<dd><p class="first">A template used by <cite>hg rebase</cite> and other commands for showing a one-line
summary of a commit. If the template configured here is longer than one
line, then only the first line is used.</p>
<p class="last">The template can be overridden per command by defining a template in
<cite>oneline-summary.<command></cite>, where <cite><command></cite> can be e.g. "rebase".</p>
</dd>
<dt><tt class="docutils literal"><span class="pre">pre-merge-tool-output</span></tt></dt>
<dd><p class="first">A template that is printed before executing an external merge tool. This can
be used to print out additional context that might be useful to have during
the conflict resolution, such as the description of the various commits
involved or bookmarks/tags.</p>
<p class="last">Additional information is available in the <tt class="docutils literal">local`, ``base</tt>, and <tt class="docutils literal">other</tt>
dicts. For example: <tt class="docutils literal">{local.label}</tt>, <tt class="docutils literal">{base.name}</tt>, or
<tt class="docutils literal">{other.islink}</tt>.</p>
</dd>
</dl>
</div>
<div class="section" id="web">
<h2><a class="toc-backref" href="#contents"><tt class="docutils literal">web</tt></a></h2>
<p>Web interface configuration. The settings in this section apply to
both the builtin webserver (started by <a class="reference external" href="hg-serve.html"><tt class="docutils literal">hg serve</tt></a>) and the script you
run through a webserver (<tt class="docutils literal">hgweb.cgi</tt> and the derivatives for FastCGI
and WSGI).</p>
<p>The Mercurial webserver does no authentication (it does not prompt for
usernames and passwords to validate <em>who</em> users are), but it does do
authorization (it grants or denies access for <em>authenticated users</em>
based on settings in this section). You must either configure your
webserver to do authentication for you, or disable the authorization
checks.</p>
<p>For a quick setup in a trusted environment, e.g., a private LAN, where
you want it to accept pushes from anybody, you can use the following
command line:</p>
<pre class="literal-block">
$ hg --config web.allow-push=* --config web.push_ssl=False serve
</pre>
<p>Note that this will allow anybody to push anything to the server and
that this should not be used for public servers.</p>
<p>The full set of options is:</p>
<dl class="docutils">
<dt><tt class="docutils literal">accesslog</tt></dt>
<dd>Where to output the access log. (default: stdout)</dd>
<dt><tt class="docutils literal">address</tt></dt>
<dd>Interface address to bind to. (default: all)</dd>
<dt><tt class="docutils literal"><span class="pre">allow-archive</span></tt></dt>
<dd>List of archive format (bz2, gz, zip) allowed for downloading.
(default: empty)</dd>
<dt><tt class="docutils literal">allowbz2</tt></dt>
<dd>(DEPRECATED) Whether to allow .tar.bz2 downloading of repository
revisions.
(default: False)</dd>
<dt><tt class="docutils literal">allowgz</tt></dt>
<dd>(DEPRECATED) Whether to allow .tar.gz downloading of repository
revisions.
(default: False)</dd>
<dt><tt class="docutils literal"><span class="pre">allow-pull</span></tt></dt>
<dd>Whether to allow pulling from the repository. (default: True)</dd>
<dt><tt class="docutils literal"><span class="pre">allow-push</span></tt></dt>
<dd>Whether to allow pushing to the repository. If empty or not set,
pushing is not allowed. If the special value <tt class="docutils literal">*</tt>, any remote
user can push, including unauthenticated users. Otherwise, the
remote user must have been authenticated, and the authenticated
user name must be present in this list. The contents of the
allow-push list are examined after the deny_push list.</dd>
<dt><tt class="docutils literal">allow_read</tt></dt>
<dd>If the user has not already been denied repository access due to
the contents of deny_read, this list determines whether to grant
repository access to the user. If this list is not empty, and the
user is unauthenticated or not present in the list, then access is
denied for the user. If the list is empty or not set, then access
is permitted to all users by default. Setting allow_read to the
special value <tt class="docutils literal">*</tt> is equivalent to it not being set (i.e. access
is permitted to all users). The contents of the allow_read list are
examined after the deny_read list.</dd>
<dt><tt class="docutils literal">allowzip</tt></dt>
<dd>(DEPRECATED) Whether to allow .zip downloading of repository
revisions. This feature creates temporary files.
(default: False)</dd>
<dt><tt class="docutils literal">archivesubrepos</tt></dt>
<dd>Whether to recurse into subrepositories when archiving.
(default: False)</dd>
<dt><tt class="docutils literal">baseurl</tt></dt>
<dd>Base URL to use when publishing URLs in other locations, so
third-party tools like email notification hooks can construct
URLs. Example: <tt class="docutils literal"><span class="pre">http://hgserver/repos/</span></tt>.</dd>
<dt><tt class="docutils literal">cacerts</tt></dt>
<dd><p class="first">Path to file containing a list of PEM encoded certificate
authority certificates. Environment variables and <tt class="docutils literal">~user</tt>
constructs are expanded in the filename. If specified on the
client, then it will verify the identity of remote HTTPS servers
with these certificates.</p>
<p>To disable SSL verification temporarily, specify <tt class="docutils literal"><span class="pre">--insecure</span></tt> from
command line.</p>
<p>You can use OpenSSL's CA certificate file if your platform has
one. On most Linux systems this will be
<tt class="docutils literal"><span class="pre">/etc/ssl/certs/ca-certificates.crt</span></tt>. Otherwise you will have to
generate this file manually. The form must be as follows:</p>
<pre class="last literal-block">
-----BEGIN CERTIFICATE-----
... (certificate in base64 PEM encoding) ...
-----END CERTIFICATE-----
-----BEGIN CERTIFICATE-----
... (certificate in base64 PEM encoding) ...
-----END CERTIFICATE-----
</pre>
</dd>
<dt><tt class="docutils literal">cache</tt></dt>
<dd>Whether to support caching in hgweb. (default: True)</dd>
<dt><tt class="docutils literal">certificate</tt></dt>
<dd>Certificate to use when running <a class="reference external" href="hg-serve.html"><tt class="docutils literal">hg serve</tt></a>.</dd>
<dt><tt class="docutils literal">collapse</tt></dt>
<dd>With <tt class="docutils literal">descend</tt> enabled, repositories in subdirectories are shown at
a single level alongside repositories in the current path. With
<tt class="docutils literal">collapse</tt> also enabled, repositories residing at a deeper level than
the current path are grouped behind navigable directory entries that
lead to the locations of these repositories. In effect, this setting
collapses each collection of repositories found within a subdirectory
into a single entry for that subdirectory. (default: False)</dd>
<dt><tt class="docutils literal">comparisoncontext</tt></dt>
<dd><p class="first">Number of lines of context to show in side-by-side file comparison. If
negative or the value <tt class="docutils literal">full</tt>, whole files are shown. (default: 5)</p>
<p class="last">This setting can be overridden by a <tt class="docutils literal">context</tt> request parameter to the
<tt class="docutils literal">comparison</tt> command, taking the same values.</p>
</dd>
<dt><tt class="docutils literal">contact</tt></dt>
<dd>Name or email address of the person in charge of the repository.
(default: ui.username or <tt class="docutils literal">$EMAIL</tt> or "unknown" if unset or empty)</dd>
<dt><tt class="docutils literal">csp</tt></dt>
<dd><p class="first">Send a <tt class="docutils literal"><span class="pre">Content-Security-Policy</span></tt> HTTP header with this value.</p>
<p>The value may contain a special string <tt class="docutils literal">%nonce%</tt>, which will be replaced
by a randomly-generated one-time use value. If the value contains
<tt class="docutils literal">%nonce%</tt>, <tt class="docutils literal">web.cache</tt> will be disabled, as caching undermines the
one-time property of the nonce. This nonce will also be inserted into
<tt class="docutils literal"><script></tt> elements containing inline JavaScript.</p>
<p class="last">Note: lots of HTML content sent by the server is derived from repository
data. Please consider the potential for malicious repository data to
"inject" itself into generated HTML content as part of your security
threat model.</p>
</dd>
<dt><tt class="docutils literal">deny_push</tt></dt>
<dd>Whether to deny pushing to the repository. If empty or not set,
push is not denied. If the special value <tt class="docutils literal">*</tt>, all remote users are
denied push. Otherwise, unauthenticated users are all denied, and
any authenticated user name present in this list is also denied. The
contents of the deny_push list are examined before the allow-push list.</dd>
<dt><tt class="docutils literal">deny_read</tt></dt>
<dd>Whether to deny reading/viewing of the repository. If this list is
not empty, unauthenticated users are all denied, and any
authenticated user name present in this list is also denied access to
the repository. If set to the special value <tt class="docutils literal">*</tt>, all remote users
are denied access (rarely needed ;). If deny_read is empty or not set,
the determination of repository access depends on the presence and
content of the allow_read list (see description). If both
deny_read and allow_read are empty or not set, then access is
permitted to all users by default. If the repository is being
served via hgwebdir, denied users will not be able to see it in
the list of repositories. The contents of the deny_read list have
priority over (are examined before) the contents of the allow_read
list.</dd>
<dt><tt class="docutils literal">descend</tt></dt>
<dd>hgwebdir indexes will not descend into subdirectories. Only repositories
directly in the current path will be shown (other repositories are still
available from the index corresponding to their containing path).</dd>
<dt><tt class="docutils literal">description</tt></dt>
<dd>Textual description of the repository's purpose or contents.
(default: "unknown")</dd>
<dt><tt class="docutils literal">encoding</tt></dt>
<dd>Character encoding name. (default: the current locale charset)
Example: "UTF-8".</dd>
<dt><tt class="docutils literal">errorlog</tt></dt>
<dd>Where to output the error log. (default: stderr)</dd>
<dt><tt class="docutils literal">guessmime</tt></dt>
<dd>Control MIME types for raw download of file content.
Set to True to let hgweb guess the content type from the file
extension. This will serve HTML files as <tt class="docutils literal">text/html</tt> and might
allow cross-site scripting attacks when serving untrusted
repositories. (default: False)</dd>
<dt><tt class="docutils literal">hidden</tt></dt>
<dd>Whether to hide the repository in the hgwebdir index.
(default: False)</dd>
<dt><tt class="docutils literal">ipv6</tt></dt>
<dd>Whether to use IPv6. (default: False)</dd>
<dt><tt class="docutils literal">labels</tt></dt>
<dd><p class="first">List of string <em>labels</em> associated with the repository.</p>
<p class="last">Labels are exposed as a template keyword and can be used to customize
output. e.g. the <tt class="docutils literal">index</tt> template can group or filter repositories
by labels and the <tt class="docutils literal">summary</tt> template can display additional content
if a specific label is present.</p>
</dd>
<dt><tt class="docutils literal">logoimg</tt></dt>
<dd>File name of the logo image that some templates display on each page.
The file name is relative to <tt class="docutils literal">staticurl</tt>. That is, the full path to
the logo image is "staticurl/logoimg".
If unset, <tt class="docutils literal">hglogo.png</tt> will be used.</dd>
<dt><tt class="docutils literal">logourl</tt></dt>
<dd>Base URL to use for logos. If unset, <tt class="docutils literal"><span class="pre">https://mercurial-scm.org/</span></tt>
will be used.</dd>
<dt><tt class="docutils literal">maxchanges</tt></dt>
<dd>Maximum number of changes to list on the changelog. (default: 10)</dd>
<dt><tt class="docutils literal">maxfiles</tt></dt>
<dd>Maximum number of files to list per changeset. (default: 10)</dd>
<dt><tt class="docutils literal">maxshortchanges</tt></dt>
<dd>Maximum number of changes to list on the shortlog, graph or filelog
pages. (default: 60)</dd>
<dt><tt class="docutils literal">name</tt></dt>
<dd>Repository name to use in the web interface.
(default: current working directory)</dd>
<dt><tt class="docutils literal">port</tt></dt>
<dd>Port to listen on. (default: 8000)</dd>
<dt><tt class="docutils literal">prefix</tt></dt>
<dd>Prefix path to serve from. (default: '' (server root))</dd>
<dt><tt class="docutils literal">push_ssl</tt></dt>
<dd>Whether to require that inbound pushes be transported over SSL to
prevent password sniffing. (default: True)</dd>
<dt><tt class="docutils literal">refreshinterval</tt></dt>
<dd><p class="first">How frequently directory listings re-scan the filesystem for new
repositories, in seconds. This is relevant when wildcards are used
to define paths. Depending on how much filesystem traversal is
required, refreshing may negatively impact performance.</p>
<p class="last">Values less than or equal to 0 always refresh.
(default: 20)</p>
</dd>
<dt><tt class="docutils literal"><span class="pre">server-header</span></tt></dt>
<dd>Value for HTTP <tt class="docutils literal">Server</tt> response header.</dd>
<dt><tt class="docutils literal">static</tt></dt>
<dd>Directory where static files are served from.</dd>
<dt><tt class="docutils literal">staticurl</tt></dt>
<dd>Base URL to use for static files. If unset, static files (e.g. the
hgicon.png favicon) will be served by the CGI script itself. Use
this setting to serve them directly with the HTTP server.
Example: <tt class="docutils literal"><span class="pre">http://hgserver/static/</span></tt>.</dd>
<dt><tt class="docutils literal">stripes</tt></dt>
<dd>How many lines a "zebra stripe" should span in multi-line output.
Set to 0 to disable. (default: 1)</dd>
<dt><tt class="docutils literal">style</tt></dt>
<dd>Which template map style to use. The available options are the names of
subdirectories in the HTML templates path. (default: <tt class="docutils literal">paper</tt>)
Example: <tt class="docutils literal">monoblue</tt>.</dd>
<dt><tt class="docutils literal">templates</tt></dt>
<dd>Where to find the HTML templates. The default path to the HTML templates
can be obtained from <tt class="docutils literal">hg debuginstall</tt>.</dd>
</dl>
</div>
<div class="section" id="websub">
<h2><a class="toc-backref" href="#contents"><tt class="docutils literal">websub</tt></a></h2>
<p>Web substitution filter definition. You can use this section to
define a set of regular expression substitution patterns which
let you automatically modify the hgweb server output.</p>
<p>The default hgweb templates only apply these substitution patterns
on the revision description fields. You can apply them anywhere
you want when you create your own templates by adding calls to the
"websub" filter (usually after calling the "escape" filter).</p>
<p>This can be used, for example, to convert issue references to links
to your issue tracker, or to convert "markdown-like" syntax into
HTML (see the examples below).</p>
<p>Each entry in this section names a substitution filter.
The value of each entry defines the substitution expression itself.
The websub expressions follow the old interhg extension syntax,
which in turn imitates the Unix sed replacement syntax:</p>
<pre class="literal-block">
patternname = s/SEARCH_REGEX/REPLACE_EXPRESSION/[i]
</pre>
<p>You can use any separator other than "/". The final "i" is optional
and indicates that the search must be case insensitive.</p>
<p>Examples:</p>
<pre class="literal-block">
[websub]
issues = s|issue(\d+)|<a href="http://bts.example.org/issue\1">issue\1</a>|i
italic = s/\b_(\S+)_\b/<i>\1<\/i>/
bold = s/\*\b(\S+)\b\*/<b>\1<\/b>/
</pre>
</div>
<div class="section" id="worker">
<h2><a class="toc-backref" href="#contents"><tt class="docutils literal">worker</tt></a></h2>
<p>Parallel master/worker configuration. We currently perform working
directory updates in parallel on Unix-like systems, which greatly
helps performance.</p>
<dl class="docutils">
<dt><tt class="docutils literal">enabled</tt></dt>
<dd>Whether to enable workers code to be used.
(default: true)</dd>
<dt><tt class="docutils literal">numcpus</tt></dt>
<dd>Number of CPUs to use for parallel operations. A zero or
negative value is treated as <tt class="docutils literal">use the default</tt>.
(default: 4 or the number of CPUs on the system, whichever is larger)</dd>
<dt><tt class="docutils literal">backgroundclose</tt></dt>
<dd>Whether to enable closing file handles on background threads during certain
operations. Some platforms aren't very efficient at closing file
handles that have been written or appended to. By performing file closing
on background threads, file write rate can increase substantially.
(default: true on Windows, false elsewhere)</dd>
<dt><tt class="docutils literal">backgroundcloseminfilecount</tt></dt>
<dd>Minimum number of files required to trigger background file closing.
Operations not writing this many files won't start background close
threads.
(default: 2048)</dd>
<dt><tt class="docutils literal">backgroundclosemaxqueue</tt></dt>
<dd>The maximum number of opened file handles waiting to be closed in the
background. This option only has an effect if <tt class="docutils literal">backgroundclose</tt> is
enabled.
(default: 384)</dd>
<dt><tt class="docutils literal">backgroundclosethreadcount</tt></dt>
<dd>Number of threads to process background file closes. Only relevant if
<tt class="docutils literal">backgroundclose</tt> is enabled.
(default: 4)</dd>
</dl>
</div>
</div>
</div>
</body>
</html>
|
